/**
* collectd - src/plugin.c
- * Copyright (C) 2005,2006 Florian octo Forster
+ * Copyright (C) 2005-2008 Florian octo Forster
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
- * Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version.
+ * Free Software Foundation; only version 2 of the License is applicable.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
*
* Authors:
* Florian octo Forster <octo at verplant.org>
+ * Sebastian Harl <sh at tokkee.org>
**/
#include "collectd.h"
#include <ltdl.h>
+#if HAVE_PTHREAD_H
+# include <pthread.h>
+#endif
+
+#include "common.h"
#include "plugin.h"
#include "configfile.h"
+#include "utils_avltree.h"
#include "utils_llist.h"
-#include "utils_debug.h"
+#include "utils_cache.h"
+#include "utils_threshold.h"
+
+/*
+ * Private structures
+ */
+struct read_func_s
+{
+ int wait_time;
+ int wait_left;
+ int (*callback) (void);
+ enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
+};
+typedef struct read_func_s read_func_t;
/*
* Private variables
static llist_t *list_init;
static llist_t *list_read;
static llist_t *list_write;
+static llist_t *list_flush;
static llist_t *list_shutdown;
-static llist_t *list_data_set;
+static llist_t *list_log;
+static llist_t *list_notification;
+
+static c_avl_tree_t *data_sets;
static char *plugindir = NULL;
+static int read_loop = 1;
+static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
+static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
+static pthread_t *read_threads = NULL;
+static int read_threads_num = 0;
+
/*
* Static functions
*/
static int register_callback (llist_t **list, const char *name, void *callback)
{
llentry_t *le;
+ char *key;
if ((*list == NULL)
&& ((*list = llist_create ()) == NULL))
le = llist_search (*list, name);
if (le == NULL)
{
- le = llentry_create (name, callback);
+ key = strdup (name);
+ if (key == NULL)
+ return (-1);
+
+ le = llentry_create (key, callback);
if (le == NULL)
+ {
+ free (key);
return (-1);
+ }
llist_append (*list, le);
}
return (0);
} /* int register_callback */
+static int plugin_unregister (llist_t *list, const char *name)
+{
+ llentry_t *e;
+
+ e = llist_search (list, name);
+
+ if (e == NULL)
+ return (-1);
+
+ llist_remove (list, e);
+ free (e->key);
+ llentry_destroy (e);
+
+ return (0);
+} /* int plugin_unregister */
+
/*
* (Try to) load the shared object `file'. Won't complain if it isn't a shared
* object, but it will bitch about a shared object not having a
lt_dlhandle dlh;
void (*reg_handle) (void);
- DBG ("file = %s", file);
+ DEBUG ("file = %s", file);
lt_dlinit ();
lt_dlerror (); /* clear errors */
{
const char *error = lt_dlerror ();
- syslog (LOG_ERR, "lt_dlopen failed: %s", error);
- DBG ("lt_dlopen failed: %s", error);
+ ERROR ("lt_dlopen (%s) failed: %s", file, error);
+ fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
return (1);
}
if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
{
- syslog (LOG_WARNING, "Couldn't find symbol ``module_register'' in ``%s'': %s\n",
+ WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
file, lt_dlerror ());
lt_dlclose (dlh);
return (-1);
return (0);
}
+static void *plugin_read_thread (void *args)
+{
+ llentry_t *le;
+ read_func_t *rf;
+ int status;
+ int done;
+
+ pthread_mutex_lock (&read_lock);
+
+ while (read_loop != 0)
+ {
+ le = llist_head (list_read);
+ done = 0;
+
+ while ((read_loop != 0) && (le != NULL))
+ {
+ rf = (read_func_t *) le->value;
+
+ if (rf->needs_read != TODO)
+ {
+ le = le->next;
+ continue;
+ }
+
+ /* We will do this read function */
+ rf->needs_read = ACTIVE;
+
+ DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
+ (unsigned long int) pthread_self (), le->key);
+ pthread_mutex_unlock (&read_lock);
+
+ status = rf->callback ();
+ done++;
+
+ if (status != 0)
+ {
+ if (rf->wait_time < interval_g)
+ rf->wait_time = interval_g;
+ rf->wait_left = rf->wait_time;
+ rf->wait_time = rf->wait_time * 2;
+ if (rf->wait_time > 86400)
+ rf->wait_time = 86400;
+
+ NOTICE ("read-function of plugin `%s' "
+ "failed. Will suspend it for %i "
+ "seconds.", le->key, rf->wait_left);
+ }
+ else
+ {
+ rf->wait_left = 0;
+ rf->wait_time = interval_g;
+ }
+
+ pthread_mutex_lock (&read_lock);
+
+ rf->needs_read = DONE;
+ le = le->next;
+ } /* while (le != NULL) */
+
+ if ((read_loop != 0) && (done == 0))
+ {
+ DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
+ (unsigned long int) pthread_self ());
+ pthread_cond_wait (&read_cond, &read_lock);
+ }
+ } /* while (read_loop) */
+
+ pthread_mutex_unlock (&read_lock);
+
+ pthread_exit (NULL);
+ return ((void *) 0);
+} /* void *plugin_read_thread */
+
+static void start_threads (int num)
+{
+ int i;
+
+ if (read_threads != NULL)
+ return;
+
+ read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
+ if (read_threads == NULL)
+ {
+ ERROR ("plugin: start_threads: calloc failed.");
+ return;
+ }
+
+ read_threads_num = 0;
+ for (i = 0; i < num; i++)
+ {
+ if (pthread_create (read_threads + read_threads_num, NULL,
+ plugin_read_thread, NULL) == 0)
+ {
+ read_threads_num++;
+ }
+ else
+ {
+ ERROR ("plugin: start_threads: pthread_create failed.");
+ return;
+ }
+ } /* for (i) */
+} /* void start_threads */
+
+static void stop_threads (void)
+{
+ int i;
+
+ pthread_mutex_lock (&read_lock);
+ read_loop = 0;
+ DEBUG ("plugin: stop_threads: Signalling `read_cond'");
+ pthread_cond_broadcast (&read_cond);
+ pthread_mutex_unlock (&read_lock);
+
+ for (i = 0; i < read_threads_num; i++)
+ {
+ if (pthread_join (read_threads[i], NULL) != 0)
+ {
+ ERROR ("plugin: stop_threads: pthread_join failed.");
+ }
+ read_threads[i] = (pthread_t) 0;
+ }
+ sfree (read_threads);
+ read_threads_num = 0;
+} /* void stop_threads */
+
/*
* Public functions
*/
if (dir == NULL)
plugindir = NULL;
else if ((plugindir = strdup (dir)) == NULL)
- syslog (LOG_ERR, "strdup failed: %s", strerror (errno));
+ {
+ char errbuf[1024];
+ ERROR ("strdup failed: %s",
+ sstrerror (errno, errbuf, sizeof (errbuf)));
+ }
}
#define BUFSIZE 512
{
DIR *dh;
const char *dir;
- char filename[BUFSIZE];
+ char filename[BUFSIZE] = "";
char typename[BUFSIZE];
int typename_len;
int ret;
struct stat statbuf;
struct dirent *de;
- DBG ("type = %s", type);
+ DEBUG ("type = %s", type);
dir = plugin_get_dir ();
ret = 1;
* type when matching the filename */
if (snprintf (typename, BUFSIZE, "%s.so", type) >= BUFSIZE)
{
- syslog (LOG_WARNING, "snprintf: truncated: `%s.so'", type);
+ WARNING ("snprintf: truncated: `%s.so'", type);
return (-1);
}
typename_len = strlen (typename);
if ((dh = opendir (dir)) == NULL)
{
- syslog (LOG_ERR, "opendir (%s): %s", dir, strerror (errno));
+ char errbuf[1024];
+ ERROR ("opendir (%s): %s", dir,
+ sstrerror (errno, errbuf, sizeof (errbuf)));
return (-1);
}
if (snprintf (filename, BUFSIZE, "%s/%s", dir, de->d_name) >= BUFSIZE)
{
- syslog (LOG_WARNING, "snprintf: truncated: `%s/%s'", dir, de->d_name);
+ WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
continue;
}
if (lstat (filename, &statbuf) == -1)
{
- syslog (LOG_WARNING, "stat %s: %s", filename, strerror (errno));
+ char errbuf[1024];
+ WARNING ("stat %s: %s", filename,
+ sstrerror (errno, errbuf, sizeof (errbuf)));
continue;
}
else if (!S_ISREG (statbuf.st_mode))
ret = 0;
break;
}
+ else
+ {
+ fprintf (stderr, "Unable to load plugin %s.\n", type);
+ }
}
closedir (dh);
+ if (filename[0] == '\0')
+ fprintf (stderr, "Could not find plugin %s.\n", type);
+
return (ret);
}
return (0);
} /* int plugin_register_config */
+int plugin_register_complex_config (const char *type,
+ int (*callback) (oconfig_item_t *))
+{
+ return (cf_register_complex (type, callback));
+} /* int plugin_register_complex_config */
+
int plugin_register_init (const char *name,
int (*callback) (void))
{
int plugin_register_read (const char *name,
int (*callback) (void))
{
- return (register_callback (&list_read, name, (void *) callback));
+ read_func_t *rf;
+
+ rf = (read_func_t *) malloc (sizeof (read_func_t));
+ if (rf == NULL)
+ {
+ char errbuf[1024];
+ ERROR ("plugin_register_read: malloc failed: %s",
+ sstrerror (errno, errbuf, sizeof (errbuf)));
+ return (-1);
+ }
+
+ memset (rf, '\0', sizeof (read_func_t));
+ rf->wait_time = interval_g;
+ rf->wait_left = 0;
+ rf->callback = callback;
+ rf->needs_read = DONE;
+
+ return (register_callback (&list_read, name, (void *) rf));
} /* int plugin_register_read */
int plugin_register_write (const char *name,
return (register_callback (&list_write, name, (void *) callback));
} /* int plugin_register_write */
+int plugin_register_flush (const char *name, int (*callback) (const int))
+{
+ return (register_callback (&list_flush, name, (void *) callback));
+} /* int plugin_register_flush */
+
int plugin_register_shutdown (char *name,
int (*callback) (void))
{
int plugin_register_data_set (const data_set_t *ds)
{
- return (register_callback (&list_data_set, ds->type, (void *) ds));
+ data_set_t *ds_copy;
+ int i;
+
+ if ((data_sets != NULL)
+ && (c_avl_get (data_sets, ds->type, NULL) == 0))
+ {
+ NOTICE ("Replacing DS `%s' with another version.", ds->type);
+ plugin_unregister_data_set (ds->type);
+ }
+ else if (data_sets == NULL)
+ {
+ data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
+ if (data_sets == NULL)
+ return (-1);
+ }
+
+ ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
+ if (ds_copy == NULL)
+ return (-1);
+ memcpy(ds_copy, ds, sizeof (data_set_t));
+
+ ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
+ * ds->ds_num);
+ if (ds_copy->ds == NULL)
+ {
+ free (ds_copy);
+ return (-1);
+ }
+
+ for (i = 0; i < ds->ds_num; i++)
+ memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
+
+ return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
} /* int plugin_register_data_set */
+int plugin_register_log (char *name,
+ void (*callback) (int priority, const char *msg))
+{
+ return (register_callback (&list_log, name, (void *) callback));
+} /* int plugin_register_log */
+
+int plugin_register_notification (const char *name,
+ int (*callback) (const notification_t *notif))
+{
+ return (register_callback (&list_notification, name, (void *) callback));
+} /* int plugin_register_log */
+
+int plugin_unregister_config (const char *name)
+{
+ cf_unregister (name);
+ return (0);
+} /* int plugin_unregister_config */
+
+int plugin_unregister_complex_config (const char *name)
+{
+ cf_unregister_complex (name);
+ return (0);
+} /* int plugin_unregister_complex_config */
+
+int plugin_unregister_init (const char *name)
+{
+ return (plugin_unregister (list_init, name));
+}
+
+int plugin_unregister_read (const char *name)
+{
+ llentry_t *e;
+
+ e = llist_search (list_read, name);
+
+ if (e == NULL)
+ return (-1);
+
+ llist_remove (list_read, e);
+ free (e->value);
+ free (e->key);
+ llentry_destroy (e);
+
+ return (0);
+}
+
+int plugin_unregister_write (const char *name)
+{
+ return (plugin_unregister (list_write, name));
+}
+
+int plugin_unregister_flush (const char *name)
+{
+ return (plugin_unregister (list_flush, name));
+}
+
+int plugin_unregister_shutdown (const char *name)
+{
+ return (plugin_unregister (list_shutdown, name));
+}
+
+int plugin_unregister_data_set (const char *name)
+{
+ data_set_t *ds;
+
+ if (data_sets == NULL)
+ return (-1);
+
+ if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
+ return (-1);
+
+ sfree (ds->ds);
+ sfree (ds);
+
+ return (0);
+} /* int plugin_unregister_data_set */
+
+int plugin_unregister_log (const char *name)
+{
+ return (plugin_unregister (list_log, name));
+}
+
+int plugin_unregister_notification (const char *name)
+{
+ return (plugin_unregister (list_notification, name));
+}
+
void plugin_init_all (void)
{
int (*callback) (void);
llentry_t *le;
+ int status;
- if (list_init == NULL)
+ /* Init the value cache */
+ uc_init ();
+
+ if ((list_init == NULL) && (list_read == NULL))
return;
+ /* Calling all init callbacks before checking if read callbacks
+ * are available allows the init callbacks to register the read
+ * callback. */
le = llist_head (list_init);
while (le != NULL)
{
- callback = le->value;
- (*callback) ();
+ callback = (int (*) (void)) le->value;
+ status = (*callback) ();
+
+ if (status != 0)
+ {
+ ERROR ("Initialization of plugin `%s' "
+ "failed with status %i. "
+ "Plugin will be unloaded.",
+ le->key, status);
+ /* Plugins that register read callbacks from the init
+ * callback should take care of appropriate error
+ * handling themselves. */
+ /* FIXME: Unload _all_ functions */
+ plugin_unregister_read (le->key);
+ }
le = le->next;
}
+
+ /* Start read-threads */
+ if (list_read != NULL)
+ {
+ const char *rt;
+ int num;
+ rt = global_option_get ("ReadThreads");
+ num = atoi (rt);
+ start_threads ((num > 0) ? num : 5);
+ }
} /* void plugin_init_all */
-void plugin_read_all (const int *loop)
+void plugin_read_all (void)
{
- int (*callback) (void);
- llentry_t *le;
+ llentry_t *le;
+ read_func_t *rf;
+
+ uc_check_timeout ();
if (list_read == NULL)
return;
+ pthread_mutex_lock (&read_lock);
+
le = llist_head (list_read);
- while ((*loop == 0) && (le != NULL))
+ while (le != NULL)
{
- callback = le->value;
- (*callback) ();
+ rf = (read_func_t *) le->value;
+
+ if (rf->needs_read != DONE)
+ {
+ le = le->next;
+ continue;
+ }
+
+ if (rf->wait_left > 0)
+ rf->wait_left -= interval_g;
+
+ if (rf->wait_left <= 0)
+ {
+ rf->needs_read = TODO;
+ }
le = le->next;
}
+
+ DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
+ pthread_cond_broadcast (&read_cond);
+ pthread_mutex_unlock (&read_lock);
} /* void plugin_read_all */
+int plugin_flush_one (int timeout, const char *name)
+{
+ int (*callback) (int);
+ llentry_t *le;
+ int status;
+
+ if (list_flush == NULL)
+ return (-1);
+
+ le = llist_search (list_flush, name);
+ if (le == NULL)
+ return (-1);
+ callback = (int (*) (int)) le->value;
+
+ status = (*callback) (timeout);
+
+ return (status);
+} /* int plugin_flush_ont */
+
+void plugin_flush_all (int timeout)
+{
+ int (*callback) (int);
+ llentry_t *le;
+
+ if (list_flush == NULL)
+ return;
+
+ le = llist_head (list_flush);
+ while (le != NULL)
+ {
+ callback = (int (*) (int)) le->value;
+ le = le->next;
+
+ (*callback) (timeout);
+ }
+} /* void plugin_flush_all */
+
void plugin_shutdown_all (void)
{
int (*callback) (void);
llentry_t *le;
+ stop_threads ();
+
if (list_shutdown == NULL)
return;
le = llist_head (list_shutdown);
while (le != NULL)
{
- callback = le->value;
- (*callback) ();
+ callback = (int (*) (void)) le->value;
+ /* Advance the pointer before calling the callback allows
+ * shutdown functions to unregister themselves. If done the
+ * other way around the memory `le' points to will be freed
+ * after callback returns. */
le = le->next;
+
+ (*callback) ();
}
} /* void plugin_shutdown_all */
-int plugin_dispatch_values (const char *name, const value_list_t *vl)
+int plugin_dispatch_values (const char *name, value_list_t *vl)
{
int (*callback) (const data_set_t *, const value_list_t *);
data_set_t *ds;
llentry_t *le;
if (list_write == NULL)
+ {
+ ERROR ("plugin_dispatch_values: No write callback has been "
+ "registered. Please load at least one plugin "
+ "that provides a write function.");
return (-1);
+ }
- le = llist_search (list_data_set, name);
- if (le == NULL)
+ if (data_sets == NULL)
+ {
+ ERROR ("plugin_dispatch_values: No data sets registered. "
+ "Could the types database be read? Check "
+ "your `TypesDB' setting!");
+ return (-1);
+ }
+
+ if (c_avl_get (data_sets, name, (void *) &ds) != 0)
+ {
+ INFO ("plugin_dispatch_values: Dataset not found: %s", name);
return (-1);
+ }
+
+ DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
+ "host = %s; "
+ "plugin = %s; plugin_instance = %s; "
+ "type = %s; type_instance = %s;",
+ (unsigned int) vl->time, vl->interval,
+ vl->host,
+ vl->plugin, vl->plugin_instance,
+ ds->type, vl->type_instance);
+
+#if COLLECT_DEBUG
+ assert (ds->ds_num == vl->values_len);
+#else
+ if (ds->ds_num != vl->values_len)
+ {
+ ERROR ("plugin_dispatch_values: ds->type = %s: "
+ "(ds->ds_num = %i) != "
+ "(vl->values_len = %i)",
+ ds->type, ds->ds_num, vl->values_len);
+ return (-1);
+ }
+#endif
- ds = (data_set_t *) le->value;
+ escape_slashes (vl->host, sizeof (vl->host));
+ escape_slashes (vl->plugin, sizeof (vl->plugin));
+ escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
+ escape_slashes (vl->type_instance, sizeof (vl->type_instance));
+
+ /* Update the value cache */
+ uc_update (ds, vl);
+ ut_check_threshold (ds, vl);
le = llist_head (list_write);
while (le != NULL)
{
- callback = le->value;
+ callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
(*callback) (ds, vl);
le = le->next;
}
return (0);
-}
+} /* int plugin_dispatch_values */
-void plugin_complain (int level, complain_t *c, const char *format, ...)
+int plugin_dispatch_notification (const notification_t *notif)
{
- char message[512];
- va_list ap;
- int step;
-
- if (c->delay > 0)
- {
- c->delay--;
- return;
- }
-
- step = atoi (COLLECTD_STEP);
- assert (step > 0);
+ int (*callback) (const notification_t *);
+ llentry_t *le;
+ /* Possible TODO: Add flap detection here */
- if (c->interval < step)
- c->interval = step;
- else
- c->interval *= 2;
+ DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
+ "time = %u; host = %s;",
+ notif->severity, notif->message,
+ (unsigned int) notif->time, notif->host);
- if (c->interval > 86400)
- c->interval = 86400;
+ /* Nobody cares for notifications */
+ if (list_notification == NULL)
+ return (-1);
- c->delay = c->interval / step;
+ le = llist_head (list_notification);
+ while (le != NULL)
+ {
+ callback = (int (*) (const notification_t *)) le->value;
+ (*callback) (notif);
- va_start (ap, format);
- vsnprintf (message, 512, format, ap);
- message[511] = '\0';
- va_end (ap);
+ le = le->next;
+ }
- syslog (level, message);
-}
+ return (0);
+} /* int plugin_dispatch_notification */
-void plugin_relief (int level, complain_t *c, const char *format, ...)
+void plugin_log (int level, const char *format, ...)
{
- char message[512];
+ char msg[512];
va_list ap;
- if (c->interval == 0)
+ void (*callback) (int, const char *);
+ llentry_t *le;
+
+ if (list_log == NULL)
return;
- c->interval = 0;
+#if !COLLECT_DEBUG
+ if (level >= LOG_DEBUG)
+ return;
+#endif
va_start (ap, format);
- vsnprintf (message, 512, format, ap);
- message[511] = '\0';
+ vsnprintf (msg, 512, format, ap);
+ msg[511] = '\0';
va_end (ap);
- syslog (level, message);
-}
+ le = llist_head (list_log);
+ while (le != NULL)
+ {
+ callback = (void (*) (int, const char *)) le->value;
+ (*callback) (level, msg);
+
+ le = le->next;
+ }
+} /* void plugin_log */
+
+const data_set_t *plugin_get_ds (const char *name)
+{
+ data_set_t *ds;
+
+ if (c_avl_get (data_sets, name, (void *) &ds) != 0)
+ {
+ DEBUG ("No such dataset registered: %s", name);
+ return (NULL);
+ }
+
+ return (ds);
+} /* data_set_t *plugin_get_ds */
projects / collectd.git / blobdiff