2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
20 * Sebastian Harl <sh at tokkee.org>
24 #include "utils_complain.h"
34 #include "configfile.h"
35 #include "utils_avltree.h"
36 #include "utils_llist.h"
37 #include "utils_cache.h"
38 #include "utils_threshold.h"
39 #include "filter_chain.h"
48 int (*callback) (void);
49 enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
51 typedef struct read_func_s read_func_t;
56 static llist_t *list_init;
57 static llist_t *list_read;
58 static llist_t *list_write;
59 static llist_t *list_flush;
60 static llist_t *list_shutdown;
61 static llist_t *list_log;
62 static llist_t *list_notification;
64 static fc_chain_t *pre_cache_chain = NULL;
65 static fc_chain_t *post_cache_chain = NULL;
67 static c_avl_tree_t *data_sets;
69 static char *plugindir = NULL;
71 static int read_loop = 1;
72 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
73 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
74 static pthread_t *read_threads = NULL;
75 static int read_threads_num = 0;
80 static const char *plugin_get_dir (void)
82 if (plugindir == NULL)
88 static int register_callback (llist_t **list, const char *name, void *callback)
94 && ((*list = llist_create ()) == NULL))
97 le = llist_search (*list, name);
104 le = llentry_create (key, callback);
111 llist_append (*list, le);
115 le->value = callback;
119 } /* int register_callback */
121 static int plugin_unregister (llist_t *list, const char *name)
125 e = llist_search (list, name);
130 llist_remove (list, e);
135 } /* int plugin_unregister */
138 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
139 * object, but it will bitch about a shared object not having a
140 * ``module_register'' symbol..
142 static int plugin_load_file (char *file)
145 void (*reg_handle) (void);
147 DEBUG ("file = %s", file);
150 lt_dlerror (); /* clear errors */
152 if ((dlh = lt_dlopen (file)) == NULL)
154 const char *error = lt_dlerror ();
156 ERROR ("lt_dlopen (%s) failed: %s", file, error);
157 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
161 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
163 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
164 file, lt_dlerror ());
174 static void *plugin_read_thread (void __attribute__((unused)) *args)
181 pthread_mutex_lock (&read_lock);
183 while (read_loop != 0)
185 le = llist_head (list_read);
188 while ((read_loop != 0) && (le != NULL))
190 rf = (read_func_t *) le->value;
192 if (rf->needs_read != TODO)
198 /* We will do this read function */
199 rf->needs_read = ACTIVE;
201 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
202 (unsigned long int) pthread_self (), le->key);
203 pthread_mutex_unlock (&read_lock);
205 status = rf->callback ();
210 if (rf->wait_time < interval_g)
211 rf->wait_time = interval_g;
212 rf->wait_left = rf->wait_time;
213 rf->wait_time = rf->wait_time * 2;
214 if (rf->wait_time > 86400)
215 rf->wait_time = 86400;
217 NOTICE ("read-function of plugin `%s' "
218 "failed. Will suspend it for %i "
219 "seconds.", le->key, rf->wait_left);
224 rf->wait_time = interval_g;
227 pthread_mutex_lock (&read_lock);
229 rf->needs_read = DONE;
231 } /* while (le != NULL) */
233 if ((read_loop != 0) && (done == 0))
235 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
236 (unsigned long int) pthread_self ());
237 pthread_cond_wait (&read_cond, &read_lock);
239 } /* while (read_loop) */
241 pthread_mutex_unlock (&read_lock);
245 } /* void *plugin_read_thread */
247 static void start_threads (int num)
251 if (read_threads != NULL)
254 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
255 if (read_threads == NULL)
257 ERROR ("plugin: start_threads: calloc failed.");
261 read_threads_num = 0;
262 for (i = 0; i < num; i++)
264 if (pthread_create (read_threads + read_threads_num, NULL,
265 plugin_read_thread, NULL) == 0)
271 ERROR ("plugin: start_threads: pthread_create failed.");
275 } /* void start_threads */
277 static void stop_threads (void)
281 if (read_threads == NULL)
284 pthread_mutex_lock (&read_lock);
286 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
287 pthread_cond_broadcast (&read_cond);
288 pthread_mutex_unlock (&read_lock);
290 for (i = 0; i < read_threads_num; i++)
292 if (pthread_join (read_threads[i], NULL) != 0)
294 ERROR ("plugin: stop_threads: pthread_join failed.");
296 read_threads[i] = (pthread_t) 0;
298 sfree (read_threads);
299 read_threads_num = 0;
300 } /* void stop_threads */
305 void plugin_set_dir (const char *dir)
307 if (plugindir != NULL)
312 else if ((plugindir = strdup (dir)) == NULL)
315 ERROR ("strdup failed: %s",
316 sstrerror (errno, errbuf, sizeof (errbuf)));
321 int plugin_load (const char *type)
325 char filename[BUFSIZE] = "";
326 char typename[BUFSIZE];
333 DEBUG ("type = %s", type);
335 dir = plugin_get_dir ();
338 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
339 * type when matching the filename */
340 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
341 if ((status < 0) || ((size_t) status >= sizeof (typename)))
343 WARNING ("snprintf: truncated: `%s.so'", type);
346 typename_len = strlen (typename);
348 if ((dh = opendir (dir)) == NULL)
351 ERROR ("opendir (%s): %s", dir,
352 sstrerror (errno, errbuf, sizeof (errbuf)));
356 while ((de = readdir (dh)) != NULL)
358 if (strncasecmp (de->d_name, typename, typename_len))
361 status = ssnprintf (filename, sizeof (filename),
362 "%s/%s", dir, de->d_name);
363 if ((status < 0) || ((size_t) status >= sizeof (filename)))
365 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
369 if (lstat (filename, &statbuf) == -1)
372 WARNING ("stat %s: %s", filename,
373 sstrerror (errno, errbuf, sizeof (errbuf)));
376 else if (!S_ISREG (statbuf.st_mode))
378 /* don't follow symlinks */
382 if (plugin_load_file (filename) == 0)
390 fprintf (stderr, "Unable to load plugin %s.\n", type);
396 if (filename[0] == '\0')
397 fprintf (stderr, "Could not find plugin %s.\n", type);
403 * The `register_*' functions follow
405 int plugin_register_config (const char *name,
406 int (*callback) (const char *key, const char *val),
407 const char **keys, int keys_num)
409 cf_register (name, callback, keys, keys_num);
411 } /* int plugin_register_config */
413 int plugin_register_complex_config (const char *type,
414 int (*callback) (oconfig_item_t *))
416 return (cf_register_complex (type, callback));
417 } /* int plugin_register_complex_config */
419 int plugin_register_init (const char *name,
420 int (*callback) (void))
422 return (register_callback (&list_init, name, (void *) callback));
423 } /* plugin_register_init */
425 int plugin_register_read (const char *name,
426 int (*callback) (void))
430 rf = (read_func_t *) malloc (sizeof (read_func_t));
434 ERROR ("plugin_register_read: malloc failed: %s",
435 sstrerror (errno, errbuf, sizeof (errbuf)));
439 memset (rf, '\0', sizeof (read_func_t));
440 rf->wait_time = interval_g;
442 rf->callback = callback;
443 rf->needs_read = DONE;
445 return (register_callback (&list_read, name, (void *) rf));
446 } /* int plugin_register_read */
448 int plugin_register_write (const char *name,
449 int (*callback) (const data_set_t *ds, const value_list_t *vl))
451 return (register_callback (&list_write, name, (void *) callback));
452 } /* int plugin_register_write */
454 int plugin_register_flush (const char *name,
455 int (*callback) (const int timeout, const char *identifier))
457 return (register_callback (&list_flush, name, (void *) callback));
458 } /* int plugin_register_flush */
460 int plugin_register_shutdown (char *name,
461 int (*callback) (void))
463 return (register_callback (&list_shutdown, name, (void *) callback));
464 } /* int plugin_register_shutdown */
466 int plugin_register_data_set (const data_set_t *ds)
471 if ((data_sets != NULL)
472 && (c_avl_get (data_sets, ds->type, NULL) == 0))
474 NOTICE ("Replacing DS `%s' with another version.", ds->type);
475 plugin_unregister_data_set (ds->type);
477 else if (data_sets == NULL)
479 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
480 if (data_sets == NULL)
484 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
487 memcpy(ds_copy, ds, sizeof (data_set_t));
489 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
491 if (ds_copy->ds == NULL)
497 for (i = 0; i < ds->ds_num; i++)
498 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
500 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
501 } /* int plugin_register_data_set */
503 int plugin_register_log (char *name,
504 void (*callback) (int priority, const char *msg))
506 return (register_callback (&list_log, name, (void *) callback));
507 } /* int plugin_register_log */
509 int plugin_register_notification (const char *name,
510 int (*callback) (const notification_t *notif))
512 return (register_callback (&list_notification, name, (void *) callback));
513 } /* int plugin_register_log */
515 int plugin_unregister_config (const char *name)
517 cf_unregister (name);
519 } /* int plugin_unregister_config */
521 int plugin_unregister_complex_config (const char *name)
523 cf_unregister_complex (name);
525 } /* int plugin_unregister_complex_config */
527 int plugin_unregister_init (const char *name)
529 return (plugin_unregister (list_init, name));
532 int plugin_unregister_read (const char *name)
536 e = llist_search (list_read, name);
541 llist_remove (list_read, e);
549 int plugin_unregister_write (const char *name)
551 return (plugin_unregister (list_write, name));
554 int plugin_unregister_flush (const char *name)
556 return (plugin_unregister (list_flush, name));
559 int plugin_unregister_shutdown (const char *name)
561 return (plugin_unregister (list_shutdown, name));
564 int plugin_unregister_data_set (const char *name)
568 if (data_sets == NULL)
571 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
578 } /* int plugin_unregister_data_set */
580 int plugin_unregister_log (const char *name)
582 return (plugin_unregister (list_log, name));
585 int plugin_unregister_notification (const char *name)
587 return (plugin_unregister (list_notification, name));
590 void plugin_init_all (void)
592 const char *chain_name;
593 int (*callback) (void);
597 /* Init the value cache */
600 chain_name = global_option_get ("PreCacheChain");
601 pre_cache_chain = fc_chain_get_by_name (chain_name);
603 chain_name = global_option_get ("PostCacheChain");
604 post_cache_chain = fc_chain_get_by_name (chain_name);
607 if ((list_init == NULL) && (list_read == NULL))
610 /* Calling all init callbacks before checking if read callbacks
611 * are available allows the init callbacks to register the read
613 le = llist_head (list_init);
616 callback = (int (*) (void)) le->value;
617 status = (*callback) ();
621 ERROR ("Initialization of plugin `%s' "
622 "failed with status %i. "
623 "Plugin will be unloaded.",
625 /* Plugins that register read callbacks from the init
626 * callback should take care of appropriate error
627 * handling themselves. */
628 /* FIXME: Unload _all_ functions */
629 plugin_unregister_read (le->key);
635 /* Start read-threads */
636 if (list_read != NULL)
640 rt = global_option_get ("ReadThreads");
643 start_threads ((num > 0) ? num : 5);
645 } /* void plugin_init_all */
647 void plugin_read_all (void)
654 if (list_read == NULL)
657 pthread_mutex_lock (&read_lock);
659 le = llist_head (list_read);
662 rf = (read_func_t *) le->value;
664 if (rf->needs_read != DONE)
670 if (rf->wait_left > 0)
671 rf->wait_left -= interval_g;
673 if (rf->wait_left <= 0)
675 rf->needs_read = TODO;
681 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
682 pthread_cond_broadcast (&read_cond);
683 pthread_mutex_unlock (&read_lock);
684 } /* void plugin_read_all */
686 /* Read function called when the `-T' command line argument is given. */
687 int plugin_read_all_once (void)
692 int return_status = 0;
694 if (list_read == NULL)
696 NOTICE ("No read-functions are registered.");
700 for (le = llist_head (list_read);
704 rf = (read_func_t *) le->value;
705 status = rf->callback ();
708 NOTICE ("read-function of plugin `%s' failed.",
714 return (return_status);
715 } /* int plugin_read_all_once */
717 int plugin_write (const char *plugin, /* {{{ */
718 const data_set_t *ds, const value_list_t *vl)
720 int (*callback) (const data_set_t *ds, const value_list_t *vl);
727 if (list_write == NULL)
732 ds = plugin_get_ds (vl->type);
735 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
745 le = llist_head (list_write);
748 callback = le->value;
749 status = (*callback) (ds, vl);
758 if ((success == 0) && (failure != 0))
763 else /* plugin != NULL */
765 le = llist_head (list_write);
768 if (strcasecmp (plugin, le->key) == 0)
777 callback = le->value;
778 status = (*callback) (ds, vl);
782 } /* }}} int plugin_write */
784 int plugin_flush (const char *plugin, int timeout, const char *identifier)
786 int (*callback) (int timeout, const char *identifier);
789 if (list_flush == NULL)
792 le = llist_head (list_flush);
796 && (strcmp (plugin, le->key) != 0))
802 callback = (int (*) (int, const char *)) le->value;
803 (*callback) (timeout, identifier);
808 } /* int plugin_flush */
810 void plugin_shutdown_all (void)
812 int (*callback) (void);
817 if (list_shutdown == NULL)
820 le = llist_head (list_shutdown);
823 callback = (int (*) (void)) le->value;
825 /* Advance the pointer before calling the callback allows
826 * shutdown functions to unregister themselves. If done the
827 * other way around the memory `le' points to will be freed
828 * after callback returns. */
833 } /* void plugin_shutdown_all */
835 int plugin_dispatch_values (value_list_t *vl)
838 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
842 if ((vl == NULL) || (*vl->type == '\0')) {
843 ERROR ("plugin_dispatch_values: Invalid value list.");
847 if (list_write == NULL)
848 c_complain_once (LOG_WARNING, &no_write_complaint,
849 "plugin_dispatch_values: No write callback has been "
850 "registered. Please load at least one output plugin, "
851 "if you want the collected data to be stored.");
853 if (data_sets == NULL)
855 ERROR ("plugin_dispatch_values: No data sets registered. "
856 "Could the types database be read? Check "
857 "your `TypesDB' setting!");
861 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
863 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
868 vl->time = time (NULL);
870 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
872 "plugin = %s; plugin_instance = %s; "
873 "type = %s; type_instance = %s;",
874 (unsigned int) vl->time, vl->interval,
876 vl->plugin, vl->plugin_instance,
877 vl->type, vl->type_instance);
880 assert (0 == strcmp (ds->type, vl->type));
882 if (0 != strcmp (ds->type, vl->type))
883 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
888 assert (ds->ds_num == vl->values_len);
890 if (ds->ds_num != vl->values_len)
892 ERROR ("plugin_dispatch_values: ds->type = %s: "
893 "(ds->ds_num = %i) != "
894 "(vl->values_len = %i)",
895 ds->type, ds->ds_num, vl->values_len);
900 escape_slashes (vl->host, sizeof (vl->host));
901 escape_slashes (vl->plugin, sizeof (vl->plugin));
902 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
903 escape_slashes (vl->type, sizeof (vl->type));
904 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
906 if (pre_cache_chain != NULL)
908 status = fc_process_chain (ds, vl, pre_cache_chain);
911 WARNING ("plugin_dispatch_values: Running the "
912 "pre-cache chain failed with "
916 else if (status == FC_TARGET_STOP)
920 /* Update the value cache */
923 if (post_cache_chain != NULL)
925 status = fc_process_chain (ds, vl, post_cache_chain);
928 WARNING ("plugin_dispatch_values: Running the "
929 "post-cache chain failed with "
935 fc_default_action (ds, vl);
938 } /* int plugin_dispatch_values */
940 int plugin_dispatch_notification (const notification_t *notif)
942 int (*callback) (const notification_t *);
944 /* Possible TODO: Add flap detection here */
946 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
947 "time = %u; host = %s;",
948 notif->severity, notif->message,
949 (unsigned int) notif->time, notif->host);
951 /* Nobody cares for notifications */
952 if (list_notification == NULL)
955 le = llist_head (list_notification);
958 callback = (int (*) (const notification_t *)) le->value;
965 } /* int plugin_dispatch_notification */
967 void plugin_log (int level, const char *format, ...)
972 void (*callback) (int, const char *);
975 if (list_log == NULL)
979 if (level >= LOG_DEBUG)
983 va_start (ap, format);
984 vsnprintf (msg, sizeof (msg), format, ap);
985 msg[sizeof (msg) - 1] = '\0';
988 le = llist_head (list_log);
991 callback = (void (*) (int, const char *)) le->value;
992 (*callback) (level, msg);
996 } /* void plugin_log */
998 const data_set_t *plugin_get_ds (const char *name)
1002 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1004 DEBUG ("No such dataset registered: %s", name);
1009 } /* data_set_t *plugin_get_ds */
1011 static int plugin_notification_meta_add (notification_t *n,
1013 enum notification_meta_type_e type,
1016 notification_meta_t *meta;
1017 notification_meta_t *tail;
1019 if ((n == NULL) || (name == NULL) || (value == NULL))
1021 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1025 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1028 ERROR ("plugin_notification_meta_add: malloc failed.");
1031 memset (meta, 0, sizeof (notification_meta_t));
1033 sstrncpy (meta->name, name, sizeof (meta->name));
1038 case NM_TYPE_STRING:
1040 meta->nm_value.nm_string = strdup ((const char *) value);
1041 if (meta->nm_value.nm_string == NULL)
1043 ERROR ("plugin_notification_meta_add: strdup failed.");
1049 case NM_TYPE_SIGNED_INT:
1051 meta->nm_value.nm_signed_int = *((int64_t *) value);
1054 case NM_TYPE_UNSIGNED_INT:
1056 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1059 case NM_TYPE_DOUBLE:
1061 meta->nm_value.nm_double = *((double *) value);
1064 case NM_TYPE_BOOLEAN:
1066 meta->nm_value.nm_boolean = *((bool *) value);
1071 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1075 } /* switch (type) */
1079 while ((tail != NULL) && (tail->next != NULL))
1088 } /* int plugin_notification_meta_add */
1090 int plugin_notification_meta_add_string (notification_t *n,
1094 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1097 int plugin_notification_meta_add_signed_int (notification_t *n,
1101 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1104 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1108 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1111 int plugin_notification_meta_add_double (notification_t *n,
1115 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1118 int plugin_notification_meta_add_boolean (notification_t *n,
1122 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1125 int plugin_notification_meta_copy (notification_t *dst,
1126 const notification_t *src)
1128 notification_meta_t *meta;
1130 assert (dst != NULL);
1131 assert (src != NULL);
1132 assert (dst != src);
1133 assert ((src->meta == NULL) || (src->meta != dst->meta));
1135 for (meta = src->meta; meta != NULL; meta = meta->next)
1137 if (meta->type == NM_TYPE_STRING)
1138 plugin_notification_meta_add_string (dst, meta->name,
1139 meta->nm_value.nm_string);
1140 else if (meta->type == NM_TYPE_SIGNED_INT)
1141 plugin_notification_meta_add_signed_int (dst, meta->name,
1142 meta->nm_value.nm_signed_int);
1143 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1144 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1145 meta->nm_value.nm_unsigned_int);
1146 else if (meta->type == NM_TYPE_DOUBLE)
1147 plugin_notification_meta_add_double (dst, meta->name,
1148 meta->nm_value.nm_double);
1149 else if (meta->type == NM_TYPE_BOOLEAN)
1150 plugin_notification_meta_add_boolean (dst, meta->name,
1151 meta->nm_value.nm_boolean);
1155 } /* int plugin_notification_meta_copy */
1157 int plugin_notification_meta_free (notification_meta_t *n)
1159 notification_meta_t *this;
1160 notification_meta_t *next;
1164 ERROR ("plugin_notification_meta_free: n == NULL!");
1169 while (this != NULL)
1173 if (this->type == NM_TYPE_STRING)
1175 free ((char *)this->nm_value.nm_string);
1176 this->nm_value.nm_string = NULL;
1184 } /* int plugin_notification_meta_free */