/**
* collectd - src/plugin.c
- * Copyright (C) 2005-2008 Florian octo Forster
+ * Copyright (C) 2005-2009 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
#include "utils_llist.h"
#include "utils_cache.h"
#include "utils_threshold.h"
+#include "filter_chain.h"
/*
* Private structures
*/
+#define RF_SIMPLE 0
+#define RF_COMPLEX 1
struct read_func_s
{
int wait_time;
int wait_left;
- int (*callback) (void);
+ int type;
+ union
+ {
+ int (*cb_simple) (void);
+ plugin_read_cb cb_complex;
+ } callback;
enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
+ user_data_t udata;
};
typedef struct read_func_s read_func_t;
+struct write_func_s
+{
+ plugin_write_cb callback;
+ user_data_t udata;
+};
+typedef struct write_func_s write_func_t;
+
+struct flush_func_s
+{
+ plugin_flush_cb callback;
+ user_data_t udata;
+};
+typedef struct flush_func_s flush_func_t;
+
/*
* Private variables
*/
static llist_t *list_log;
static llist_t *list_notification;
+static fc_chain_t *pre_cache_chain = NULL;
+static fc_chain_t *post_cache_chain = NULL;
+
static c_avl_tree_t *data_sets;
static char *plugindir = NULL;
return (0);
} /* int register_callback */
+static void plugin_user_data_destroy (user_data_t *ud)
+{
+ if ((ud != NULL) && (ud->data != NULL) && (ud->free_func != NULL))
+ {
+ ud->free_func (ud->data);
+ ud->data = NULL;
+ ud->free_func = NULL;
+ }
+} /* void plugin_user_data_destroy */
+
static int plugin_unregister (llist_t *list, const char *name)
{
llentry_t *e;
{
const char *error = lt_dlerror ();
- ERROR ("lt_dlopen failed: %s", error);
- fprintf (stderr, "lt_dlopen failed: %s\n", 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)
{
- 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)
+static void *plugin_read_thread (void __attribute__((unused)) *args)
{
llentry_t *le;
read_func_t *rf;
(unsigned long int) pthread_self (), le->key);
pthread_mutex_unlock (&read_lock);
- status = rf->callback ();
+ if (rf->type == RF_SIMPLE)
+ {
+ status = rf->callback.cb_simple ();
+ }
+ else
+ {
+ assert (rf->type == RF_COMPLEX);
+ status = rf->callback.cb_complex (&rf->udata);
+ }
done++;
if (status != 0)
return ((void *) 0);
} /* void *plugin_read_thread */
-static void start_threads (int num)
+static void start_read_threads (int num)
{
int i;
read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
if (read_threads == NULL)
{
- ERROR ("plugin: start_threads: calloc failed.");
+ ERROR ("plugin: start_read_threads: calloc failed.");
return;
}
}
else
{
- ERROR ("plugin: start_threads: pthread_create failed.");
+ ERROR ("plugin: start_read_threads: pthread_create failed.");
return;
}
} /* for (i) */
-} /* void start_threads */
+} /* void start_read_threads */
-static void stop_threads (void)
+static void stop_read_threads (void)
{
int i;
+ if (read_threads == NULL)
+ return;
+
pthread_mutex_lock (&read_lock);
read_loop = 0;
- DEBUG ("plugin: stop_threads: Signalling `read_cond'");
+ DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
pthread_cond_broadcast (&read_cond);
pthread_mutex_unlock (&read_lock);
{
if (pthread_join (read_threads[i], NULL) != 0)
{
- ERROR ("plugin: stop_threads: pthread_join failed.");
+ ERROR ("plugin: stop_read_threads: pthread_join failed.");
}
read_threads[i] = (pthread_t) 0;
}
sfree (read_threads);
read_threads_num = 0;
-} /* void stop_threads */
+} /* void stop_read_threads */
+
+static int remove_read_functions (void)
+{
+ llentry_t *this;
+
+ if (list_read == NULL)
+ return (0);
+
+ this = llist_head (list_read);
+ while (this != NULL)
+ {
+ llentry_t *next;
+ read_func_t *rf;
+
+ next = this->next;
+ rf = (read_func_t *) this->value;
+
+ free (this->key);
+
+ plugin_user_data_destroy (&rf->udata);
+ free (rf);
+
+ this = next;
+ }
+
+ llist_destroy (list_read);
+ list_read = NULL;
+
+ return (0);
+} /* }}} int remove_read_functions */
/*
* Public functions
int ret;
struct stat statbuf;
struct dirent *de;
+ int status;
DEBUG ("type = %s", type);
/* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
* type when matching the filename */
- if (ssnprintf (typename, sizeof (typename),
- "%s.so", type) >= sizeof (typename))
+ status = ssnprintf (typename, sizeof (typename), "%s.so", type);
+ if ((status < 0) || ((size_t) status >= sizeof (typename)))
{
WARNING ("snprintf: truncated: `%s.so'", type);
return (-1);
if (strncasecmp (de->d_name, typename, typename_len))
continue;
- if (ssnprintf (filename, sizeof (filename),
- "%s/%s", dir, de->d_name) >= sizeof (filename))
+ status = ssnprintf (filename, sizeof (filename),
+ "%s/%s", dir, de->d_name);
+ if ((status < 0) || ((size_t) status >= sizeof (filename)))
{
WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
continue;
return (-1);
}
- memset (rf, '\0', sizeof (read_func_t));
+ memset (rf, 0, sizeof (read_func_t));
rf->wait_time = interval_g;
rf->wait_left = 0;
- rf->callback = callback;
+ rf->type = RF_SIMPLE;
+ rf->callback.cb_simple = callback;
rf->needs_read = DONE;
+ rf->udata.data = NULL;
+ rf->udata.free_func = NULL;
return (register_callback (&list_read, name, (void *) rf));
} /* int plugin_register_read */
+int plugin_register_complex_read (const char *name,
+ plugin_read_cb callback, user_data_t *user_data)
+{
+ read_func_t *rf;
+
+ rf = (read_func_t *) malloc (sizeof (read_func_t));
+ if (rf == NULL)
+ {
+ ERROR ("plugin_register_complex_read: malloc failed.");
+ return (-1);
+ }
+
+ memset (rf, 0, sizeof (read_func_t));
+ rf->wait_time = interval_g;
+ rf->wait_left = 0;
+ rf->type = RF_COMPLEX;
+ rf->callback.cb_complex = callback;
+ rf->needs_read = DONE;
+
+ /* Set user data */
+ if (user_data == NULL)
+ {
+ rf->udata.data = NULL;
+ rf->udata.free_func = NULL;
+ }
+ else
+ {
+ rf->udata = *user_data;
+ }
+
+ return (register_callback (&list_read, name, (void *) rf));
+} /* int plugin_register_complex_read */
+
int plugin_register_write (const char *name,
- int (*callback) (const data_set_t *ds, const value_list_t *vl))
+ plugin_write_cb callback, user_data_t *user_data)
{
- return (register_callback (&list_write, name, (void *) callback));
+ write_func_t *wf;
+
+ wf = (write_func_t *) malloc (sizeof (*wf));
+ if (wf == NULL)
+ {
+ ERROR ("plugin_register_write: malloc failed.");
+ return (-1);
+ }
+ memset (wf, 0, sizeof (*wf));
+
+ wf->callback = callback;
+ if (user_data == NULL)
+ {
+ wf->udata.data = NULL;
+ wf->udata.free_func = NULL;
+ }
+ else
+ {
+ wf->udata = *user_data;
+ }
+
+ return (register_callback (&list_write, name, (void *) wf));
} /* int plugin_register_write */
int plugin_register_flush (const char *name,
- int (*callback) (const int timeout, const char *identifier))
+ plugin_flush_cb callback, user_data_t *user_data)
{
- return (register_callback (&list_flush, name, (void *) callback));
+ flush_func_t *ff;
+
+ ff = (flush_func_t *) malloc (sizeof (*ff));
+ if (ff == NULL)
+ {
+ ERROR ("plugin_register_flush: malloc failed.");
+ return (-1);
+ }
+ memset (ff, 0, sizeof (*ff));
+
+ ff->callback = callback;
+ if (user_data == NULL)
+ {
+ ff->udata.data = NULL;
+ ff->udata.free_func = NULL;
+ }
+ else
+ {
+ ff->udata = *user_data;
+ }
+
+ return (register_callback (&list_flush, name, (void *) ff));
} /* int plugin_register_flush */
int plugin_register_shutdown (char *name,
int plugin_unregister_read (const char *name)
{
llentry_t *e;
+ read_func_t *rf;
e = llist_search (list_read, name);
return (-1);
llist_remove (list_read, e);
- free (e->value);
+
+ rf = (read_func_t *) e->value;
+ plugin_user_data_destroy (&rf->udata);
+ free (rf);
free (e->key);
+
llentry_destroy (e);
return (0);
int plugin_unregister_write (const char *name)
{
- return (plugin_unregister (list_write, name));
+ llentry_t *e;
+ write_func_t *wf;
+
+ e = llist_search (list_write, name);
+
+ if (e == NULL)
+ return (-1);
+
+ llist_remove (list_write, e);
+
+ wf = (write_func_t *) e->value;
+ plugin_user_data_destroy (&wf->udata);
+ free (wf);
+ free (e->key);
+
+ llentry_destroy (e);
+
+ return (0);
}
int plugin_unregister_flush (const char *name)
{
- return (plugin_unregister (list_flush, name));
+ llentry_t *e;
+ flush_func_t *ff;
+
+ e = llist_search (list_flush, name);
+
+ if (e == NULL)
+ return (-1);
+
+ llist_remove (list_flush, e);
+
+ ff = (flush_func_t *) e->value;
+ plugin_user_data_destroy (&ff->udata);
+ free (ff);
+ free (e->key);
+
+ llentry_destroy (e);
+
+ return (0);
}
int plugin_unregister_shutdown (const char *name)
void plugin_init_all (void)
{
+ const char *chain_name;
int (*callback) (void);
llentry_t *le;
int status;
- /* 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);
- }
-
/* Init the value cache */
uc_init ();
- if (list_init == NULL)
+ chain_name = global_option_get ("PreCacheChain");
+ pre_cache_chain = fc_chain_get_by_name (chain_name);
+
+ chain_name = global_option_get ("PostCacheChain");
+ post_cache_chain = fc_chain_get_by_name (chain_name);
+
+
+ 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)
{
"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);
+ if (num != -1)
+ start_read_threads ((num > 0) ? num : 5);
+ }
} /* void plugin_init_all */
void plugin_read_all (void)
pthread_mutex_unlock (&read_lock);
} /* void plugin_read_all */
-int plugin_flush_one (int timeout, const char *name)
+/* Read function called when the `-T' command line argument is given. */
+int plugin_read_all_once (void)
{
- int (*callback) (int);
- llentry_t *le;
+ llentry_t *le;
+ read_func_t *rf;
int status;
+ int return_status = 0;
- if (list_flush == NULL)
- return (-1);
+ if (list_read == NULL)
+ {
+ NOTICE ("No read-functions are registered.");
+ return (0);
+ }
- le = llist_search (list_flush, name);
- if (le == NULL)
- return (-1);
- callback = (int (*) (int)) le->value;
+ for (le = llist_head (list_read);
+ le != NULL;
+ le = le->next)
+ {
+ rf = (read_func_t *) le->value;
- status = (*callback) (timeout);
+ if (rf->type == RF_SIMPLE)
+ {
+ status = rf->callback.cb_simple ();
+ }
+ else
+ {
+ assert (rf->type == RF_COMPLEX);
+ status = rf->callback.cb_complex (&rf->udata);
+ }
- return (status);
-} /* int plugin_flush_ont */
+ if (status != 0)
+ {
+ NOTICE ("read-function of plugin `%s' failed.",
+ le->key);
+ return_status = -1;
+ }
+ }
-void plugin_flush_all (int timeout)
+ return (return_status);
+} /* int plugin_read_all_once */
+
+int plugin_write (const char *plugin, /* {{{ */
+ const data_set_t *ds, const value_list_t *vl)
{
- int (*callback) (int);
- llentry_t *le;
+ llentry_t *le;
+ int status;
- if (list_flush == NULL)
- return;
+ if (vl == NULL)
+ return (EINVAL);
- le = llist_head (list_flush);
- while (le != NULL)
- {
- callback = (int (*) (int)) le->value;
- le = le->next;
+ if (list_write == NULL)
+ return (ENOENT);
- (*callback) (timeout);
- }
-} /* void plugin_flush_all */
+ if (ds == NULL)
+ {
+ ds = plugin_get_ds (vl->type);
+ if (ds == NULL)
+ {
+ ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
+ return (ENOENT);
+ }
+ }
+
+ if (plugin == NULL)
+ {
+ int success = 0;
+ int failure = 0;
+
+ le = llist_head (list_write);
+ while (le != NULL)
+ {
+ write_func_t *wf = le->value;
+
+ DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
+ status = wf->callback (ds, vl, &wf->udata);
+ if (status != 0)
+ failure++;
+ else
+ success++;
+
+ le = le->next;
+ }
+
+ if ((success == 0) && (failure != 0))
+ status = -1;
+ else
+ status = 0;
+ }
+ else /* plugin != NULL */
+ {
+ write_func_t *wf;
+ le = llist_head (list_write);
+ while (le != NULL)
+ {
+ if (strcasecmp (plugin, le->key) == 0)
+ break;
+
+ le = le->next;
+ }
+
+ if (le == NULL)
+ return (ENOENT);
+
+ wf = le->value;
+
+ DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
+ status = wf->callback (ds, vl, &wf->udata);
+ }
+
+ return (status);
+} /* }}} int plugin_write */
int plugin_flush (const char *plugin, int timeout, const char *identifier)
{
- int (*callback) (int timeout, const char *identifier);
llentry_t *le;
if (list_flush == NULL)
le = llist_head (list_flush);
while (le != NULL)
{
+ flush_func_t *ff;
+
if ((plugin != NULL)
- && (strcmp (plugin, le->key) != 0))
+ && (strcmp (plugin, le->key) != 0))
+ {
+ le = le->next;
continue;
+ }
- callback = (int (*) (int, const char *)) le->value;
- le = le->next;
+ ff = (flush_func_t *) le->value;
+
+ ff->callback (timeout, identifier, &ff->udata);
- (*callback) (timeout, identifier);
+ le = le->next;
}
+ return (0);
} /* int plugin_flush */
void plugin_shutdown_all (void)
int (*callback) (void);
llentry_t *le;
- stop_threads ();
+ stop_read_threads ();
+ remove_read_functions ();
if (list_shutdown == NULL)
return;
int plugin_dispatch_values (value_list_t *vl)
{
- static c_complain_t no_write_complaint = C_COMPLAIN_INIT;
+ int status;
+ static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
- int (*callback) (const data_set_t *, const value_list_t *);
data_set_t *ds;
- llentry_t *le;
if ((vl == NULL) || (*vl->type == '\0')) {
ERROR ("plugin_dispatch_values: Invalid value list.");
return (-1);
}
+ if (vl->time == 0)
+ vl->time = time (NULL);
+
DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
"host = %s; "
"plugin = %s; plugin_instance = %s; "
escape_slashes (vl->type, sizeof (vl->type));
escape_slashes (vl->type_instance, sizeof (vl->type_instance));
+ if (pre_cache_chain != NULL)
+ {
+ status = fc_process_chain (ds, vl, pre_cache_chain);
+ if (status < 0)
+ {
+ WARNING ("plugin_dispatch_values: Running the "
+ "pre-cache chain failed with "
+ "status %i (%#x).",
+ status, status);
+ }
+ else if (status == FC_TARGET_STOP)
+ return (0);
+ }
+
/* Update the value cache */
uc_update (ds, vl);
- ut_check_threshold (ds, vl);
- le = llist_head (list_write);
- while (le != NULL)
+ if (post_cache_chain != NULL)
{
- callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
- (*callback) (ds, vl);
-
- le = le->next;
+ status = fc_process_chain (ds, vl, post_cache_chain);
+ if (status < 0)
+ {
+ WARNING ("plugin_dispatch_values: Running the "
+ "post-cache chain failed with "
+ "status %i (%#x).",
+ status, status);
+ }
}
+ else
+ fc_default_action (ds, vl);
return (0);
} /* int plugin_dispatch_values */
void plugin_log (int level, const char *format, ...)
{
- char msg[512];
+ char msg[1024];
va_list ap;
void (*callback) (int, const char *);
#endif
va_start (ap, format);
- vsnprintf (msg, 512, format, ap);
- msg[511] = '\0';
+ vsnprintf (msg, sizeof (msg), format, ap);
+ msg[sizeof (msg) - 1] = '\0';
va_end (ap);
le = llist_head (list_log);
return (ds);
} /* data_set_t *plugin_get_ds */
+
+static int plugin_notification_meta_add (notification_t *n,
+ const char *name,
+ enum notification_meta_type_e type,
+ const void *value)
+{
+ notification_meta_t *meta;
+ notification_meta_t *tail;
+
+ if ((n == NULL) || (name == NULL) || (value == NULL))
+ {
+ ERROR ("plugin_notification_meta_add: A pointer is NULL!");
+ return (-1);
+ }
+
+ meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
+ if (meta == NULL)
+ {
+ ERROR ("plugin_notification_meta_add: malloc failed.");
+ return (-1);
+ }
+ memset (meta, 0, sizeof (notification_meta_t));
+
+ sstrncpy (meta->name, name, sizeof (meta->name));
+ meta->type = type;
+
+ switch (type)
+ {
+ case NM_TYPE_STRING:
+ {
+ meta->nm_value.nm_string = strdup ((const char *) value);
+ if (meta->nm_value.nm_string == NULL)
+ {
+ ERROR ("plugin_notification_meta_add: strdup failed.");
+ sfree (meta);
+ return (-1);
+ }
+ break;
+ }
+ case NM_TYPE_SIGNED_INT:
+ {
+ meta->nm_value.nm_signed_int = *((int64_t *) value);
+ break;
+ }
+ case NM_TYPE_UNSIGNED_INT:
+ {
+ meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
+ break;
+ }
+ case NM_TYPE_DOUBLE:
+ {
+ meta->nm_value.nm_double = *((double *) value);
+ break;
+ }
+ case NM_TYPE_BOOLEAN:
+ {
+ meta->nm_value.nm_boolean = *((bool *) value);
+ break;
+ }
+ default:
+ {
+ ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
+ sfree (meta);
+ return (-1);
+ }
+ } /* switch (type) */
+
+ meta->next = NULL;
+ tail = n->meta;
+ while ((tail != NULL) && (tail->next != NULL))
+ tail = tail->next;
+
+ if (tail == NULL)
+ n->meta = meta;
+ else
+ tail->next = meta;
+
+ return (0);
+} /* int plugin_notification_meta_add */
+
+int plugin_notification_meta_add_string (notification_t *n,
+ const char *name,
+ const char *value)
+{
+ return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
+}
+
+int plugin_notification_meta_add_signed_int (notification_t *n,
+ const char *name,
+ int64_t value)
+{
+ return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
+}
+
+int plugin_notification_meta_add_unsigned_int (notification_t *n,
+ const char *name,
+ uint64_t value)
+{
+ return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
+}
+
+int plugin_notification_meta_add_double (notification_t *n,
+ const char *name,
+ double value)
+{
+ return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
+}
+
+int plugin_notification_meta_add_boolean (notification_t *n,
+ const char *name,
+ bool value)
+{
+ return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
+}
+
+int plugin_notification_meta_copy (notification_t *dst,
+ const notification_t *src)
+{
+ notification_meta_t *meta;
+
+ assert (dst != NULL);
+ assert (src != NULL);
+ assert (dst != src);
+ assert ((src->meta == NULL) || (src->meta != dst->meta));
+
+ for (meta = src->meta; meta != NULL; meta = meta->next)
+ {
+ if (meta->type == NM_TYPE_STRING)
+ plugin_notification_meta_add_string (dst, meta->name,
+ meta->nm_value.nm_string);
+ else if (meta->type == NM_TYPE_SIGNED_INT)
+ plugin_notification_meta_add_signed_int (dst, meta->name,
+ meta->nm_value.nm_signed_int);
+ else if (meta->type == NM_TYPE_UNSIGNED_INT)
+ plugin_notification_meta_add_unsigned_int (dst, meta->name,
+ meta->nm_value.nm_unsigned_int);
+ else if (meta->type == NM_TYPE_DOUBLE)
+ plugin_notification_meta_add_double (dst, meta->name,
+ meta->nm_value.nm_double);
+ else if (meta->type == NM_TYPE_BOOLEAN)
+ plugin_notification_meta_add_boolean (dst, meta->name,
+ meta->nm_value.nm_boolean);
+ }
+
+ return (0);
+} /* int plugin_notification_meta_copy */
+
+int plugin_notification_meta_free (notification_meta_t *n)
+{
+ notification_meta_t *this;
+ notification_meta_t *next;
+
+ if (n == NULL)
+ {
+ ERROR ("plugin_notification_meta_free: n == NULL!");
+ return (-1);
+ }
+
+ this = n;
+ while (this != NULL)
+ {
+ next = this->next;
+
+ if (this->type == NM_TYPE_STRING)
+ {
+ free ((char *)this->nm_value.nm_string);
+ this->nm_value.nm_string = NULL;
+ }
+ sfree (this);
+
+ this = next;
+ }
+
+ return (0);
+} /* int plugin_notification_meta_free */
projects / collectd.git / blobdiff