X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fplugin.c;h=1aad97c1d7f073931de749bb9676874de3d2b59c;hb=bc7992ed0693313a2b1fe282a5bf23f1cc9f8e42;hp=23ea9017cce27aa71370c32b41d7496b0944c837;hpb=7e4b7b46592718cafa5f21ce03bd10dcf919a26d;p=collectd.git diff --git a/src/plugin.c b/src/plugin.c index 23ea9017..cd7b1083 100644 --- a/src/plugin.c +++ b/src/plugin.c @@ -1,6 +1,6 @@ /** * collectd - src/plugin.c - * Copyright (C) 2005,2006 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 @@ -17,9 +17,11 @@ * * Authors: * Florian octo Forster + * Sebastian Harl **/ #include "collectd.h" +#include "utils_complain.h" #include @@ -30,7 +32,11 @@ #include "common.h" #include "plugin.h" #include "configfile.h" +#include "utils_avltree.h" #include "utils_llist.h" +#include "utils_cache.h" +#include "utils_threshold.h" +#include "filter_chain.h" /* * Private structures @@ -50,9 +56,16 @@ typedef struct read_func_s read_func_t; static llist_t *list_init; static llist_t *list_read; static llist_t *list_write; +static llist_t *list_filter; +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 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; @@ -76,6 +89,7 @@ static const char *plugin_get_dir (void) static int register_callback (llist_t **list, const char *name, void *callback) { llentry_t *le; + char *key; if ((*list == NULL) && ((*list = llist_create ()) == NULL)) @@ -84,9 +98,16 @@ static int register_callback (llist_t **list, const char *name, void *callback) 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); } @@ -108,6 +129,7 @@ static int plugin_unregister (llist_t *list, const char *name) return (-1); llist_remove (list, e); + free (e->key); llentry_destroy (e); return (0); @@ -132,14 +154,14 @@ static int plugin_load_file (char *file) { 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); @@ -220,6 +242,7 @@ static void *plugin_read_thread (void *args) pthread_mutex_unlock (&read_lock); pthread_exit (NULL); + return ((void *) 0); } /* void *plugin_read_thread */ static void start_threads (int num) @@ -256,6 +279,9 @@ static void stop_threads (void) { int i; + if (read_threads == NULL) + return; + pthread_mutex_lock (&read_lock); read_loop = 0; DEBUG ("plugin: stop_threads: Signalling `read_cond'"); @@ -297,7 +323,7 @@ int plugin_load (const char *type) { DIR *dh; const char *dir; - char filename[BUFSIZE]; + char filename[BUFSIZE] = ""; char typename[BUFSIZE]; int typename_len; int ret; @@ -311,7 +337,8 @@ int plugin_load (const char *type) /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the * type when matching the filename */ - if (snprintf (typename, BUFSIZE, "%s.so", type) >= BUFSIZE) + if (ssnprintf (typename, sizeof (typename), + "%s.so", type) >= sizeof (typename)) { WARNING ("snprintf: truncated: `%s.so'", type); return (-1); @@ -331,7 +358,8 @@ int plugin_load (const char *type) if (strncasecmp (de->d_name, typename, typename_len)) continue; - if (snprintf (filename, BUFSIZE, "%s/%s", dir, de->d_name) >= BUFSIZE) + if (ssnprintf (filename, sizeof (filename), + "%s/%s", dir, de->d_name) >= sizeof (filename)) { WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name); continue; @@ -364,6 +392,9 @@ int plugin_load (const char *type) closedir (dh); + if (filename[0] == '\0') + fprintf (stderr, "Could not find plugin %s.\n", type); + return (ret); } @@ -419,6 +450,18 @@ int plugin_register_write (const char *name, return (register_callback (&list_write, name, (void *) callback)); } /* int plugin_register_write */ +int plugin_register_filter (const char *name, + int (*callback) (const data_set_t *ds, value_list_t *vl)) +{ + return (register_callback (&list_filter, name, (void *) callback)); +} /* int plugin_register_filter */ + +int plugin_register_flush (const char *name, + int (*callback) (const int timeout, const char *identifier)) +{ + return (register_callback (&list_flush, name, (void *) callback)); +} /* int plugin_register_flush */ + int plugin_register_shutdown (char *name, int (*callback) (void)) { @@ -430,12 +473,18 @@ int plugin_register_data_set (const data_set_t *ds) data_set_t *ds_copy; int i; - if ((list_data_set != NULL) - && (llist_search (list_data_set, ds->type) != NULL)) + 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) @@ -453,7 +502,7 @@ int plugin_register_data_set (const data_set_t *ds) for (i = 0; i < ds->ds_num; i++) memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t)); - return (register_callback (&list_data_set, ds->type, (void *) ds_copy)); + return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy)); } /* int plugin_register_data_set */ int plugin_register_log (char *name, @@ -462,6 +511,12 @@ int plugin_register_log (char *name, 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); @@ -490,6 +545,7 @@ int plugin_unregister_read (const char *name) llist_remove (list_read, e); free (e->value); + free (e->key); llentry_destroy (e); return (0); @@ -500,6 +556,16 @@ int plugin_unregister_write (const char *name) return (plugin_unregister (list_write, name)); } +int plugin_unregister_filter (const char *name) +{ + return (plugin_unregister (list_filter, 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)); @@ -507,21 +573,14 @@ int plugin_unregister_shutdown (const char *name) int plugin_unregister_data_set (const char *name) { - llentry_t *e; data_set_t *ds; - if (list_data_set == NULL) + if (data_sets == NULL) return (-1); - e = llist_search (list_data_set, name); - - if (e == NULL) + if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0) return (-1); - llist_remove (list_data_set, e); - ds = (data_set_t *) e->value; - llentry_destroy (e); - sfree (ds->ds); sfree (ds); @@ -533,25 +592,34 @@ 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) { + 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 (); + + 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) + + 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) { @@ -564,19 +632,35 @@ void plugin_init_all (void) "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_threads ((num > 0) ? num : 5); + } } /* void plugin_init_all */ -void plugin_read_all (const int *loop) +void plugin_read_all (void) { llentry_t *le; read_func_t *rf; + uc_check_timeout (); + if (list_read == NULL) return; @@ -609,6 +693,130 @@ void plugin_read_all (const int *loop) pthread_mutex_unlock (&read_lock); } /* void plugin_read_all */ +/* Read function called when the `-T' command line argument is given. */ +int plugin_read_all_once (void) +{ + llentry_t *le; + read_func_t *rf; + int status; + int return_status = 0; + + if (list_read == NULL) + { + NOTICE ("No read-functions are registered."); + return (0); + } + + for (le = llist_head (list_read); + le != NULL; + le = le->next) + { + rf = (read_func_t *) le->value; + status = rf->callback (); + if (status != 0) + { + NOTICE ("read-function of plugin `%s' failed.", + le->key); + return_status = -1; + } + } + + 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) (const data_set_t *ds, const value_list_t *vl); + llentry_t *le; + int status; + + if (vl == NULL) + return (EINVAL); + + if (list_write == NULL) + return (ENOENT); + + 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) + { + callback = le->value; + status = (*callback) (ds, vl); + if (status != 0) + failure++; + else + success++; + + le = le->next; + } + + if ((success == 0) && (failure != 0)) + status = -1; + else + status = 0; + } + else /* plugin != NULL */ + { + le = llist_head (list_write); + while (le != NULL) + { + if (strcasecmp (plugin, le->key) == 0) + break; + + le = le->next; + } + + if (le == NULL) + return (ENOENT); + + callback = le->value; + status = (*callback) (ds, vl); + } + + 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) + return (0); + + le = llist_head (list_flush); + while (le != NULL) + { + if ((plugin != NULL) + && (strcmp (plugin, le->key) != 0)) + { + le = le->next; + continue; + } + + callback = (int (*) (int, const char *)) le->value; + (*callback) (timeout, identifier); + + le = le->next; + } + return (0); +} /* int plugin_flush */ + void plugin_shutdown_all (void) { int (*callback) (void); @@ -634,39 +842,65 @@ void plugin_shutdown_all (void) } } /* void plugin_shutdown_all */ -int plugin_dispatch_values (const char *name, value_list_t *vl) +int plugin_dispatch_values (value_list_t *vl) { - int (*callback) (const data_set_t *, const value_list_t *); + int status; + static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC; + data_set_t *ds; - llentry_t *le; - if ((list_write == NULL) || (list_data_set == NULL)) + if ((vl == NULL) || (*vl->type == '\0')) { + ERROR ("plugin_dispatch_values: Invalid value list."); return (-1); + } - le = llist_search (list_data_set, name); - if (le == NULL) + if (list_write == NULL) + c_complain_once (LOG_WARNING, &no_write_complaint, + "plugin_dispatch_values: No write callback has been " + "registered. Please load at least one output plugin, " + "if you want the collected data to be stored."); + + if (data_sets == NULL) { - DEBUG ("No such dataset registered: %s", name); + ERROR ("plugin_dispatch_values: No data sets registered. " + "Could the types database be read? Check " + "your `TypesDB' setting!"); return (-1); } - ds = (data_set_t *) le->value; + if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0) + { + INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type); + return (-1); + } - DEBUG ("plugin: plugin_dispatch_values: time = %u; interval = %i; " + if (vl->time == 0) + vl->time = time (NULL); + + 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); + vl->type, vl->type_instance); + +#if COLLECT_DEBUG + assert (0 == strcmp (ds->type, vl->type)); +#else + if (0 != strcmp (ds->type, vl->type)) + WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)", + ds->type, vl->type); +#endif #if COLLECT_DEBUG assert (ds->ds_num == vl->values_len); #else if (ds->ds_num != vl->values_len) { - ERROR ("plugin: ds->type = %s: (ds->ds_num = %i) != " + 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); @@ -676,23 +910,73 @@ int plugin_dispatch_values (const char *name, value_list_t *vl) 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, sizeof (vl->type)); escape_slashes (vl->type_instance, sizeof (vl->type_instance)); - le = llist_head (list_write); + 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); + + if (post_cache_chain != NULL) + { + 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 */ + +int plugin_dispatch_notification (const notification_t *notif) +{ + int (*callback) (const notification_t *); + llentry_t *le; + /* Possible TODO: Add flap detection here */ + + DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; " + "time = %u; host = %s;", + notif->severity, notif->message, + (unsigned int) notif->time, notif->host); + + /* Nobody cares for notifications */ + if (list_notification == NULL) + return (-1); + + le = llist_head (list_notification); while (le != NULL) { - callback = (int (*) (const data_set_t *, const value_list_t *)) le->value; - (*callback) (ds, vl); + callback = (int (*) (const notification_t *)) le->value; + (*callback) (notif); le = le->next; } return (0); -} /* int plugin_dispatch_values */ +} /* int plugin_dispatch_notification */ void plugin_log (int level, const char *format, ...) { - char msg[512]; + char msg[1024]; va_list ap; void (*callback) (int, const char *); @@ -707,8 +991,8 @@ void plugin_log (int level, const char *format, ...) #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); @@ -721,66 +1005,191 @@ void plugin_log (int level, const char *format, ...) } } /* void plugin_log */ -void plugin_complain (int level, complain_t *c, const char *format, ...) +const data_set_t *plugin_get_ds (const char *name) { - char message[512]; - va_list ap; + data_set_t *ds; - if (c->delay > 0) + if (c_avl_get (data_sets, name, (void *) &ds) != 0) { - c->delay--; - return; + DEBUG ("No such dataset registered: %s", name); + return (NULL); } - if (c->interval < interval_g) - c->interval = interval_g; - else - c->interval *= 2; - - if (c->interval > 86400) - c->interval = 86400; - - c->delay = c->interval / interval_g; - - va_start (ap, format); - vsnprintf (message, 512, format, ap); - message[511] = '\0'; - va_end (ap); + return (ds); +} /* data_set_t *plugin_get_ds */ - plugin_log (level, message); +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)); } -void plugin_relief (int level, complain_t *c, const char *format, ...) +int plugin_notification_meta_add_signed_int (notification_t *n, + const char *name, + int64_t value) { - char message[512]; - va_list ap; - - if (c->interval == 0) - return; - - c->interval = 0; - - va_start (ap, format); - vsnprintf (message, 512, format, ap); - message[511] = '\0'; - va_end (ap); - - plugin_log (level, message); + return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value)); } -const data_set_t *plugin_get_ds (const char *name) +int plugin_notification_meta_add_unsigned_int (notification_t *n, + const char *name, + uint64_t value) { - data_set_t *ds; - llentry_t *le; + return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value)); +} - le = llist_search (list_data_set, name); - if (le == NULL) - { - DEBUG ("No such dataset registered: %s", name); - return (NULL); - } +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)); +} - ds = (data_set_t *) le->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)); +} - return (ds); -} /* data_set_t *plugin_get_ds */ +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_t *n) +{ + notification_meta_t *this; + notification_meta_t *next; + + if (n == NULL) + { + ERROR ("plugin_notification_meta_free: n == NULL!"); + return (-1); + } + + this = n->meta; + n->meta = NULL; + 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 */