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_heap.h"
38 #include "utils_cache.h"
39 #include "utils_threshold.h"
40 #include "filter_chain.h"
45 struct callback_func_s
50 typedef struct callback_func_s callback_func_t;
54 #define RF_REMOVE 65535
57 /* `read_func_t' "inherits" from `callback_func_t'.
58 * The `rf_super' member MUST be the first one in this structure! */
59 #define rf_callback rf_super.cf_callback
60 #define rf_udata rf_super.cf_udata
61 callback_func_t rf_super;
62 char rf_group[DATA_MAX_NAME_LEN];
63 char rf_name[DATA_MAX_NAME_LEN];
65 struct timespec rf_interval;
66 struct timespec rf_effective_interval;
67 struct timespec rf_next_read;
69 typedef struct read_func_s read_func_t;
74 static llist_t *list_init;
75 static llist_t *list_write;
76 static llist_t *list_flush;
77 static llist_t *list_shutdown;
78 static llist_t *list_log;
79 static llist_t *list_notification;
81 static fc_chain_t *pre_cache_chain = NULL;
82 static fc_chain_t *post_cache_chain = NULL;
84 static c_avl_tree_t *data_sets;
86 static char *plugindir = NULL;
88 static c_heap_t *read_heap = NULL;
89 static llist_t *read_list;
90 static int read_loop = 1;
91 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
92 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
93 static pthread_t *read_threads = NULL;
94 static int read_threads_num = 0;
99 static const char *plugin_get_dir (void)
101 if (plugindir == NULL)
107 static void destroy_callback (callback_func_t *cf) /* {{{ */
112 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
114 cf->cf_udata.free_func (cf->cf_udata.data);
115 cf->cf_udata.data = NULL;
116 cf->cf_udata.free_func = NULL;
119 } /* }}} void destroy_callback */
121 static void destroy_all_callbacks (llist_t **list) /* {{{ */
128 le = llist_head (*list);
136 destroy_callback (le->value);
142 llist_destroy (*list);
144 } /* }}} void destroy_all_callbacks */
146 static void destroy_read_heap (void) /* {{{ */
148 if (read_heap == NULL)
155 cf = c_heap_get_root (read_heap);
159 destroy_callback (cf);
162 c_heap_destroy (read_heap);
164 } /* }}} void destroy_read_heap */
166 static int register_callback (llist_t **list, /* {{{ */
167 const char *name, callback_func_t *cf)
174 *list = llist_create ();
177 ERROR ("plugin: register_callback: "
178 "llist_create failed.");
179 destroy_callback (cf);
187 ERROR ("plugin: register_callback: strdup failed.");
188 destroy_callback (cf);
192 le = llist_search (*list, name);
195 le = llentry_create (key, cf);
198 ERROR ("plugin: register_callback: "
199 "llentry_create failed.");
201 destroy_callback (cf);
205 llist_append (*list, le);
209 callback_func_t *old_cf;
214 WARNING ("plugin: register_callback: "
215 "a callback named `%s' already exists - "
216 "overwriting the old entry!", name);
218 destroy_callback (old_cf);
223 } /* }}} int register_callback */
225 static int create_register_callback (llist_t **list, /* {{{ */
226 const char *name, void *callback, user_data_t *ud)
230 cf = (callback_func_t *) malloc (sizeof (*cf));
233 ERROR ("plugin: create_register_callback: malloc failed.");
236 memset (cf, 0, sizeof (*cf));
238 cf->cf_callback = callback;
241 cf->cf_udata.data = NULL;
242 cf->cf_udata.free_func = NULL;
249 return (register_callback (list, name, cf));
250 } /* }}} int create_register_callback */
252 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
259 e = llist_search (list, name);
263 llist_remove (list, e);
266 destroy_callback (e->value);
271 } /* }}} int plugin_unregister */
274 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
275 * object, but it will bitch about a shared object not having a
276 * ``module_register'' symbol..
278 static int plugin_load_file (char *file, uint32_t flags)
281 void (*reg_handle) (void);
283 DEBUG ("file = %s", file);
286 lt_dlerror (); /* clear errors */
288 #if LIBTOOL_VERSION == 2
289 if (flags & PLUGIN_FLAGS_GLOBAL) {
291 lt_dladvise_init(&advise);
292 lt_dladvise_global(&advise);
293 dlh = lt_dlopenadvise(file, advise);
294 lt_dladvise_destroy(&advise);
296 dlh = lt_dlopen (file);
298 #else /* if LIBTOOL_VERSION == 1 */
299 if (flags & PLUGIN_FLAGS_GLOBAL)
300 ERROR ("plugin_load_file: The global flag is not supported, "
301 "libtool 2 is required for this.");
302 dlh = lt_dlopen (file);
307 const char *error = lt_dlerror ();
309 ERROR ("lt_dlopen (%s) failed: %s", file, error);
310 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
314 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
316 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
317 file, lt_dlerror ());
327 static _Bool timeout_reached(struct timespec timeout)
330 gettimeofday(&now, NULL);
331 return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
334 static void *plugin_read_thread (void __attribute__((unused)) *args)
336 while (read_loop != 0)
344 /* Get the read function that needs to be read next. */
345 rf = c_heap_get_root (read_heap);
348 struct timespec abstime;
350 gettimeofday (&now, /* timezone = */ NULL);
352 abstime.tv_sec = now.tv_sec + interval_g;
353 abstime.tv_nsec = 1000 * now.tv_usec;
355 pthread_mutex_lock (&read_lock);
356 pthread_cond_timedwait (&read_cond, &read_lock,
358 pthread_mutex_unlock (&read_lock);
362 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
364 gettimeofday (&now, /* timezone = */ NULL);
366 rf->rf_interval.tv_sec = interval_g;
367 rf->rf_interval.tv_nsec = 0;
369 rf->rf_effective_interval = rf->rf_interval;
371 rf->rf_next_read.tv_sec = now.tv_sec;
372 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
375 /* sleep until this entry is due,
376 * using pthread_cond_timedwait */
377 pthread_mutex_lock (&read_lock);
378 /* In pthread_cond_timedwait, spurious wakeups are possible
379 * (and really happen, at least on NetBSD with > 1 CPU), thus
380 * we need to re-evaluate the condition every time
381 * pthread_cond_timedwait returns. */
383 while (!timeout_reached(rf->rf_next_read) && rc == 0) {
384 rc = pthread_cond_timedwait (&read_cond, &read_lock,
388 /* Must hold `real_lock' when accessing `rf->rf_type'. */
389 rf_type = rf->rf_type;
390 pthread_mutex_unlock (&read_lock);
392 /* Check if we're supposed to stop.. This may have interrupted
396 /* Insert `rf' again, so it can be free'd correctly */
397 c_heap_insert (read_heap, rf);
401 /* The entry has been marked for deletion. The linked list
402 * entry has already been removed by `plugin_unregister_read'.
403 * All we have to do here is free the `read_func_t' and
405 if (rf_type == RF_REMOVE)
407 DEBUG ("plugin_read_thread: Destroying the `%s' "
408 "callback.", rf->rf_name);
409 destroy_callback ((callback_func_t *) rf);
414 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
416 if (rf_type == RF_SIMPLE)
418 int (*callback) (void);
420 callback = rf->rf_callback;
421 status = (*callback) ();
425 plugin_read_cb callback;
427 assert (rf_type == RF_COMPLEX);
429 callback = rf->rf_callback;
430 status = (*callback) (&rf->rf_udata);
433 /* If the function signals failure, we will increase the
434 * intervals in which it will be called. */
437 rf->rf_effective_interval.tv_sec *= 2;
438 rf->rf_effective_interval.tv_nsec *= 2;
439 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
441 if (rf->rf_effective_interval.tv_sec >= 86400)
443 rf->rf_effective_interval.tv_sec = 86400;
444 rf->rf_effective_interval.tv_nsec = 0;
447 NOTICE ("read-function of plugin `%s' failed. "
448 "Will suspend it for %i seconds.",
450 (int) rf->rf_effective_interval.tv_sec);
454 /* Success: Restore the interval, if it was changed. */
455 rf->rf_effective_interval = rf->rf_interval;
458 /* update the ``next read due'' field */
459 gettimeofday (&now, /* timezone = */ NULL);
461 DEBUG ("plugin_read_thread: Effective interval of the "
462 "%s plugin is %i.%09i.",
464 (int) rf->rf_effective_interval.tv_sec,
465 (int) rf->rf_effective_interval.tv_nsec);
467 /* Calculate the next (absolute) time at which this function
468 * should be called. */
469 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
470 + rf->rf_effective_interval.tv_sec;
471 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
472 + rf->rf_effective_interval.tv_nsec;
473 NORMALIZE_TIMESPEC (rf->rf_next_read);
475 /* Check, if `rf_next_read' is in the past. */
476 if ((rf->rf_next_read.tv_sec < now.tv_sec)
477 || ((rf->rf_next_read.tv_sec == now.tv_sec)
478 && (rf->rf_next_read.tv_nsec < (1000 * now.tv_usec))))
480 /* `rf_next_read' is in the past. Insert `now'
481 * so this value doesn't trail off into the
483 rf->rf_next_read.tv_sec = now.tv_sec;
484 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
487 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
489 (int) rf->rf_next_read.tv_sec,
490 (int) rf->rf_next_read.tv_nsec);
492 /* Re-insert this read function into the heap again. */
493 c_heap_insert (read_heap, rf);
494 } /* while (read_loop) */
498 } /* void *plugin_read_thread */
500 static void start_read_threads (int num)
504 if (read_threads != NULL)
507 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
508 if (read_threads == NULL)
510 ERROR ("plugin: start_read_threads: calloc failed.");
514 read_threads_num = 0;
515 for (i = 0; i < num; i++)
517 if (pthread_create (read_threads + read_threads_num, NULL,
518 plugin_read_thread, NULL) == 0)
524 ERROR ("plugin: start_read_threads: pthread_create failed.");
528 } /* void start_read_threads */
530 static void stop_read_threads (void)
534 if (read_threads == NULL)
537 INFO ("collectd: Stopping %i read threads.", read_threads_num);
539 pthread_mutex_lock (&read_lock);
541 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
542 pthread_cond_broadcast (&read_cond);
543 pthread_mutex_unlock (&read_lock);
545 for (i = 0; i < read_threads_num; i++)
547 if (pthread_join (read_threads[i], NULL) != 0)
549 ERROR ("plugin: stop_read_threads: pthread_join failed.");
551 read_threads[i] = (pthread_t) 0;
553 sfree (read_threads);
554 read_threads_num = 0;
555 } /* void stop_read_threads */
560 void plugin_set_dir (const char *dir)
562 if (plugindir != NULL)
567 else if ((plugindir = strdup (dir)) == NULL)
570 ERROR ("strdup failed: %s",
571 sstrerror (errno, errbuf, sizeof (errbuf)));
576 int plugin_load (const char *type, uint32_t flags)
580 char filename[BUFSIZE] = "";
581 char typename[BUFSIZE];
588 DEBUG ("type = %s", type);
590 dir = plugin_get_dir ();
593 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
594 * type when matching the filename */
595 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
596 if ((status < 0) || ((size_t) status >= sizeof (typename)))
598 WARNING ("snprintf: truncated: `%s.so'", type);
601 typename_len = strlen (typename);
603 if ((dh = opendir (dir)) == NULL)
606 ERROR ("opendir (%s): %s", dir,
607 sstrerror (errno, errbuf, sizeof (errbuf)));
611 while ((de = readdir (dh)) != NULL)
613 if (strncasecmp (de->d_name, typename, typename_len))
616 status = ssnprintf (filename, sizeof (filename),
617 "%s/%s", dir, de->d_name);
618 if ((status < 0) || ((size_t) status >= sizeof (filename)))
620 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
624 if (lstat (filename, &statbuf) == -1)
627 WARNING ("stat %s: %s", filename,
628 sstrerror (errno, errbuf, sizeof (errbuf)));
631 else if (!S_ISREG (statbuf.st_mode))
633 /* don't follow symlinks */
634 WARNING ("stat %s: not a regular file", filename);
638 if (plugin_load_file (filename, flags) == 0)
646 fprintf (stderr, "Unable to load plugin %s.\n", type);
652 if (filename[0] == '\0')
653 fprintf (stderr, "Could not find plugin %s.\n", type);
659 * The `register_*' functions follow
661 int plugin_register_config (const char *name,
662 int (*callback) (const char *key, const char *val),
663 const char **keys, int keys_num)
665 cf_register (name, callback, keys, keys_num);
667 } /* int plugin_register_config */
669 int plugin_register_complex_config (const char *type,
670 int (*callback) (oconfig_item_t *))
672 return (cf_register_complex (type, callback));
673 } /* int plugin_register_complex_config */
675 int plugin_register_init (const char *name,
676 int (*callback) (void))
678 return (create_register_callback (&list_init, name, (void *) callback,
679 /* user_data = */ NULL));
680 } /* plugin_register_init */
682 static int plugin_compare_read_func (const void *arg0, const void *arg1)
684 const read_func_t *rf0;
685 const read_func_t *rf1;
690 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
692 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
694 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
696 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
700 } /* int plugin_compare_read_func */
702 /* Add a read function to both, the heap and a linked list. The linked list if
703 * used to look-up read functions, especially for the remove function. The heap
704 * is used to determine which plugin to read next. */
705 static int plugin_insert_read (read_func_t *rf)
710 pthread_mutex_lock (&read_lock);
712 if (read_list == NULL)
714 read_list = llist_create ();
715 if (read_list == NULL)
717 pthread_mutex_unlock (&read_lock);
718 ERROR ("plugin_insert_read: read_list failed.");
723 if (read_heap == NULL)
725 read_heap = c_heap_create (plugin_compare_read_func);
726 if (read_heap == NULL)
728 pthread_mutex_unlock (&read_lock);
729 ERROR ("plugin_insert_read: c_heap_create failed.");
734 le = llentry_create (rf->rf_name, rf);
737 pthread_mutex_unlock (&read_lock);
738 ERROR ("plugin_insert_read: llentry_create failed.");
742 status = c_heap_insert (read_heap, rf);
745 pthread_mutex_unlock (&read_lock);
746 ERROR ("plugin_insert_read: c_heap_insert failed.");
747 llentry_destroy (le);
751 /* This does not fail. */
752 llist_append (read_list, le);
754 pthread_mutex_unlock (&read_lock);
756 } /* int plugin_insert_read */
758 int plugin_register_read (const char *name,
759 int (*callback) (void))
763 rf = (read_func_t *) malloc (sizeof (read_func_t));
767 ERROR ("plugin_register_read: malloc failed: %s",
768 sstrerror (errno, errbuf, sizeof (errbuf)));
772 memset (rf, 0, sizeof (read_func_t));
773 rf->rf_callback = (void *) callback;
774 rf->rf_udata.data = NULL;
775 rf->rf_udata.free_func = NULL;
776 rf->rf_group[0] = '\0';
777 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
778 rf->rf_type = RF_SIMPLE;
779 rf->rf_interval.tv_sec = 0;
780 rf->rf_interval.tv_nsec = 0;
781 rf->rf_effective_interval = rf->rf_interval;
783 return (plugin_insert_read (rf));
784 } /* int plugin_register_read */
786 int plugin_register_complex_read (const char *group, const char *name,
787 plugin_read_cb callback,
788 const struct timespec *interval,
789 user_data_t *user_data)
793 rf = (read_func_t *) malloc (sizeof (read_func_t));
796 ERROR ("plugin_register_complex_read: malloc failed.");
800 memset (rf, 0, sizeof (read_func_t));
801 rf->rf_callback = (void *) callback;
803 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
805 rf->rf_group[0] = '\0';
806 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
807 rf->rf_type = RF_COMPLEX;
808 if (interval != NULL)
810 rf->rf_interval = *interval;
812 rf->rf_effective_interval = rf->rf_interval;
815 if (user_data == NULL)
817 rf->rf_udata.data = NULL;
818 rf->rf_udata.free_func = NULL;
822 rf->rf_udata = *user_data;
825 return (plugin_insert_read (rf));
826 } /* int plugin_register_complex_read */
828 int plugin_register_write (const char *name,
829 plugin_write_cb callback, user_data_t *ud)
831 return (create_register_callback (&list_write, name,
832 (void *) callback, ud));
833 } /* int plugin_register_write */
835 int plugin_register_flush (const char *name,
836 plugin_flush_cb callback, user_data_t *ud)
838 return (create_register_callback (&list_flush, name,
839 (void *) callback, ud));
840 } /* int plugin_register_flush */
842 int plugin_register_shutdown (char *name,
843 int (*callback) (void))
845 return (create_register_callback (&list_shutdown, name,
846 (void *) callback, /* user_data = */ NULL));
847 } /* int plugin_register_shutdown */
849 int plugin_register_data_set (const data_set_t *ds)
854 if ((data_sets != NULL)
855 && (c_avl_get (data_sets, ds->type, NULL) == 0))
857 NOTICE ("Replacing DS `%s' with another version.", ds->type);
858 plugin_unregister_data_set (ds->type);
860 else if (data_sets == NULL)
862 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
863 if (data_sets == NULL)
867 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
870 memcpy(ds_copy, ds, sizeof (data_set_t));
872 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
874 if (ds_copy->ds == NULL)
880 for (i = 0; i < ds->ds_num; i++)
881 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
883 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
884 } /* int plugin_register_data_set */
886 int plugin_register_log (const char *name,
887 plugin_log_cb callback, user_data_t *ud)
889 return (create_register_callback (&list_log, name,
890 (void *) callback, ud));
891 } /* int plugin_register_log */
893 int plugin_register_notification (const char *name,
894 plugin_notification_cb callback, user_data_t *ud)
896 return (create_register_callback (&list_notification, name,
897 (void *) callback, ud));
898 } /* int plugin_register_log */
900 int plugin_unregister_config (const char *name)
902 cf_unregister (name);
904 } /* int plugin_unregister_config */
906 int plugin_unregister_complex_config (const char *name)
908 cf_unregister_complex (name);
910 } /* int plugin_unregister_complex_config */
912 int plugin_unregister_init (const char *name)
914 return (plugin_unregister (list_init, name));
917 int plugin_unregister_read (const char *name) /* {{{ */
925 pthread_mutex_lock (&read_lock);
927 if (read_list == NULL)
929 pthread_mutex_unlock (&read_lock);
933 le = llist_search (read_list, name);
936 pthread_mutex_unlock (&read_lock);
937 WARNING ("plugin_unregister_read: No such read function: %s",
942 llist_remove (read_list, le);
946 rf->rf_type = RF_REMOVE;
948 pthread_mutex_unlock (&read_lock);
950 llentry_destroy (le);
952 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
955 } /* }}} int plugin_unregister_read */
957 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
959 read_func_t *rf = e->value;
962 return strcmp (rf->rf_group, (const char *)group);
963 } /* }}} int compare_read_func_group */
965 int plugin_unregister_read_group (const char *group) /* {{{ */
975 pthread_mutex_lock (&read_lock);
977 if (read_list == NULL)
979 pthread_mutex_unlock (&read_lock);
985 le = llist_search_custom (read_list,
986 compare_read_func_group, (void *)group);
993 llist_remove (read_list, le);
997 rf->rf_type = RF_REMOVE;
999 llentry_destroy (le);
1001 DEBUG ("plugin_unregister_read_group: "
1002 "Marked `%s' (group `%s') for removal.",
1003 rf->rf_name, group);
1006 pthread_mutex_unlock (&read_lock);
1010 WARNING ("plugin_unregister_read_group: No such "
1011 "group of read function: %s", group);
1016 } /* }}} int plugin_unregister_read_group */
1018 int plugin_unregister_write (const char *name)
1020 return (plugin_unregister (list_write, name));
1023 int plugin_unregister_flush (const char *name)
1025 return (plugin_unregister (list_flush, name));
1028 int plugin_unregister_shutdown (const char *name)
1030 return (plugin_unregister (list_shutdown, name));
1033 int plugin_unregister_data_set (const char *name)
1037 if (data_sets == NULL)
1040 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1047 } /* int plugin_unregister_data_set */
1049 int plugin_unregister_log (const char *name)
1051 return (plugin_unregister (list_log, name));
1054 int plugin_unregister_notification (const char *name)
1056 return (plugin_unregister (list_notification, name));
1059 void plugin_init_all (void)
1061 const char *chain_name;
1065 /* Init the value cache */
1068 chain_name = global_option_get ("PreCacheChain");
1069 pre_cache_chain = fc_chain_get_by_name (chain_name);
1071 chain_name = global_option_get ("PostCacheChain");
1072 post_cache_chain = fc_chain_get_by_name (chain_name);
1075 if ((list_init == NULL) && (read_heap == NULL))
1078 /* Calling all init callbacks before checking if read callbacks
1079 * are available allows the init callbacks to register the read
1081 le = llist_head (list_init);
1084 callback_func_t *cf;
1085 plugin_init_cb callback;
1088 callback = cf->cf_callback;
1089 status = (*callback) ();
1093 ERROR ("Initialization of plugin `%s' "
1094 "failed with status %i. "
1095 "Plugin will be unloaded.",
1097 /* Plugins that register read callbacks from the init
1098 * callback should take care of appropriate error
1099 * handling themselves. */
1100 /* FIXME: Unload _all_ functions */
1101 plugin_unregister_read (le->key);
1107 /* Start read-threads */
1108 if (read_heap != NULL)
1112 rt = global_option_get ("ReadThreads");
1115 start_read_threads ((num > 0) ? num : 5);
1117 } /* void plugin_init_all */
1119 /* TODO: Rename this function. */
1120 void plugin_read_all (void)
1122 uc_check_timeout ();
1125 } /* void plugin_read_all */
1127 /* Read function called when the `-T' command line argument is given. */
1128 int plugin_read_all_once (void)
1131 int return_status = 0;
1133 if (read_heap == NULL)
1135 NOTICE ("No read-functions are registered.");
1143 rf = c_heap_get_root (read_heap);
1147 if (rf->rf_type == RF_SIMPLE)
1149 int (*callback) (void);
1151 callback = rf->rf_callback;
1152 status = (*callback) ();
1156 plugin_read_cb callback;
1158 callback = rf->rf_callback;
1159 status = (*callback) (&rf->rf_udata);
1164 NOTICE ("read-function of plugin `%s' failed.",
1169 destroy_callback ((void *) rf);
1172 return (return_status);
1173 } /* int plugin_read_all_once */
1175 int plugin_write (const char *plugin, /* {{{ */
1176 const data_set_t *ds, const value_list_t *vl)
1184 if (list_write == NULL)
1189 ds = plugin_get_ds (vl->type);
1192 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1202 le = llist_head (list_write);
1205 callback_func_t *cf = le->value;
1206 plugin_write_cb callback;
1208 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1209 callback = cf->cf_callback;
1210 status = (*callback) (ds, vl, &cf->cf_udata);
1219 if ((success == 0) && (failure != 0))
1224 else /* plugin != NULL */
1226 callback_func_t *cf;
1227 plugin_write_cb callback;
1229 le = llist_head (list_write);
1232 if (strcasecmp (plugin, le->key) == 0)
1243 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1244 callback = cf->cf_callback;
1245 status = (*callback) (ds, vl, &cf->cf_udata);
1249 } /* }}} int plugin_write */
1251 int plugin_flush (const char *plugin, int timeout, const char *identifier)
1255 if (list_flush == NULL)
1258 le = llist_head (list_flush);
1261 callback_func_t *cf;
1262 plugin_flush_cb callback;
1264 if ((plugin != NULL)
1265 && (strcmp (plugin, le->key) != 0))
1272 callback = cf->cf_callback;
1274 (*callback) (timeout, identifier, &cf->cf_udata);
1279 } /* int plugin_flush */
1281 void plugin_shutdown_all (void)
1285 stop_read_threads ();
1287 destroy_all_callbacks (&list_init);
1289 pthread_mutex_lock (&read_lock);
1290 llist_destroy (read_list);
1292 pthread_mutex_unlock (&read_lock);
1294 destroy_read_heap ();
1296 plugin_flush (/* plugin = */ NULL, /* timeout = */ -1,
1297 /* identifier = */ NULL);
1300 if (list_shutdown != NULL)
1301 le = llist_head (list_shutdown);
1305 callback_func_t *cf;
1306 plugin_shutdown_cb callback;
1309 callback = cf->cf_callback;
1311 /* Advance the pointer before calling the callback allows
1312 * shutdown functions to unregister themselves. If done the
1313 * other way around the memory `le' points to will be freed
1314 * after callback returns. */
1320 /* Write plugins which use the `user_data' pointer usually need the
1321 * same data available to the flush callback. If this is the case, set
1322 * the free_function to NULL when registering the flush callback and to
1323 * the real free function when registering the write callback. This way
1324 * the data isn't freed twice. */
1325 destroy_all_callbacks (&list_flush);
1326 destroy_all_callbacks (&list_write);
1328 destroy_all_callbacks (&list_notification);
1329 destroy_all_callbacks (&list_shutdown);
1330 destroy_all_callbacks (&list_log);
1331 } /* void plugin_shutdown_all */
1333 int plugin_dispatch_values (value_list_t *vl)
1336 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1338 value_t *saved_values;
1339 int saved_values_len;
1343 int free_meta_data = 0;
1345 if ((vl == NULL) || (vl->type[0] == 0)
1346 || (vl->values == NULL) || (vl->values_len < 1))
1348 ERROR ("plugin_dispatch_values: Invalid value list.");
1352 /* Free meta data only if the calling function didn't specify any. In
1353 * this case matches and targets may add some and the calling function
1354 * may not expect (and therefore free) that data. */
1355 if (vl->meta == NULL)
1358 if (list_write == NULL)
1359 c_complain_once (LOG_WARNING, &no_write_complaint,
1360 "plugin_dispatch_values: No write callback has been "
1361 "registered. Please load at least one output plugin, "
1362 "if you want the collected data to be stored.");
1364 if (data_sets == NULL)
1366 ERROR ("plugin_dispatch_values: No data sets registered. "
1367 "Could the types database be read? Check "
1368 "your `TypesDB' setting!");
1372 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1374 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
1379 vl->time = time (NULL);
1381 if (vl->interval <= 0)
1382 vl->interval = interval_g;
1384 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
1386 "plugin = %s; plugin_instance = %s; "
1387 "type = %s; type_instance = %s;",
1388 (unsigned int) vl->time, vl->interval,
1390 vl->plugin, vl->plugin_instance,
1391 vl->type, vl->type_instance);
1394 assert (0 == strcmp (ds->type, vl->type));
1396 if (0 != strcmp (ds->type, vl->type))
1397 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1398 ds->type, vl->type);
1402 assert (ds->ds_num == vl->values_len);
1404 if (ds->ds_num != vl->values_len)
1406 ERROR ("plugin_dispatch_values: ds->type = %s: "
1407 "(ds->ds_num = %i) != "
1408 "(vl->values_len = %i)",
1409 ds->type, ds->ds_num, vl->values_len);
1414 escape_slashes (vl->host, sizeof (vl->host));
1415 escape_slashes (vl->plugin, sizeof (vl->plugin));
1416 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1417 escape_slashes (vl->type, sizeof (vl->type));
1418 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1420 /* Copy the values. This way, we can assure `targets' that they get
1421 * dynamically allocated values, which they can free and replace if
1423 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1425 saved_values = vl->values;
1426 saved_values_len = vl->values_len;
1428 vl->values = (value_t *) calloc (vl->values_len,
1429 sizeof (*vl->values));
1430 if (vl->values == NULL)
1432 ERROR ("plugin_dispatch_values: calloc failed.");
1433 vl->values = saved_values;
1436 memcpy (vl->values, saved_values,
1437 vl->values_len * sizeof (*vl->values));
1439 else /* if ((pre == NULL) && (post == NULL)) */
1441 saved_values = NULL;
1442 saved_values_len = 0;
1445 if (pre_cache_chain != NULL)
1447 status = fc_process_chain (ds, vl, pre_cache_chain);
1450 WARNING ("plugin_dispatch_values: Running the "
1451 "pre-cache chain failed with "
1455 else if (status == FC_TARGET_STOP)
1457 /* Restore the state of the value_list so that plugins
1458 * don't get confused.. */
1459 if (saved_values != NULL)
1462 vl->values = saved_values;
1463 vl->values_len = saved_values_len;
1469 /* Update the value cache */
1472 /* Initiate threshold checking */
1473 ut_check_threshold (ds, vl);
1475 if (post_cache_chain != NULL)
1477 status = fc_process_chain (ds, vl, post_cache_chain);
1480 WARNING ("plugin_dispatch_values: Running the "
1481 "post-cache chain failed with "
1487 fc_default_action (ds, vl);
1489 /* Restore the state of the value_list so that plugins don't get
1491 if (saved_values != NULL)
1494 vl->values = saved_values;
1495 vl->values_len = saved_values_len;
1498 if ((free_meta_data != 0) && (vl->meta != NULL))
1500 meta_data_destroy (vl->meta);
1505 } /* int plugin_dispatch_values */
1507 int plugin_dispatch_notification (const notification_t *notif)
1510 /* Possible TODO: Add flap detection here */
1512 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1513 "time = %u; host = %s;",
1514 notif->severity, notif->message,
1515 (unsigned int) notif->time, notif->host);
1517 /* Nobody cares for notifications */
1518 if (list_notification == NULL)
1521 le = llist_head (list_notification);
1524 callback_func_t *cf;
1525 plugin_notification_cb callback;
1529 callback = cf->cf_callback;
1530 status = (*callback) (notif, &cf->cf_udata);
1533 WARNING ("plugin_dispatch_notification: Notification "
1534 "callback %s returned %i.",
1542 } /* int plugin_dispatch_notification */
1544 void plugin_log (int level, const char *format, ...)
1551 if (level >= LOG_DEBUG)
1555 va_start (ap, format);
1556 vsnprintf (msg, sizeof (msg), format, ap);
1557 msg[sizeof (msg) - 1] = '\0';
1560 if (list_log == NULL)
1562 fprintf (stderr, "%s\n", msg);
1566 le = llist_head (list_log);
1569 callback_func_t *cf;
1570 plugin_log_cb callback;
1573 callback = cf->cf_callback;
1575 (*callback) (level, msg, &cf->cf_udata);
1579 } /* void plugin_log */
1581 const data_set_t *plugin_get_ds (const char *name)
1585 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1587 DEBUG ("No such dataset registered: %s", name);
1592 } /* data_set_t *plugin_get_ds */
1594 static int plugin_notification_meta_add (notification_t *n,
1596 enum notification_meta_type_e type,
1599 notification_meta_t *meta;
1600 notification_meta_t *tail;
1602 if ((n == NULL) || (name == NULL) || (value == NULL))
1604 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1608 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1611 ERROR ("plugin_notification_meta_add: malloc failed.");
1614 memset (meta, 0, sizeof (notification_meta_t));
1616 sstrncpy (meta->name, name, sizeof (meta->name));
1621 case NM_TYPE_STRING:
1623 meta->nm_value.nm_string = strdup ((const char *) value);
1624 if (meta->nm_value.nm_string == NULL)
1626 ERROR ("plugin_notification_meta_add: strdup failed.");
1632 case NM_TYPE_SIGNED_INT:
1634 meta->nm_value.nm_signed_int = *((int64_t *) value);
1637 case NM_TYPE_UNSIGNED_INT:
1639 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1642 case NM_TYPE_DOUBLE:
1644 meta->nm_value.nm_double = *((double *) value);
1647 case NM_TYPE_BOOLEAN:
1649 meta->nm_value.nm_boolean = *((bool *) value);
1654 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1658 } /* switch (type) */
1662 while ((tail != NULL) && (tail->next != NULL))
1671 } /* int plugin_notification_meta_add */
1673 int plugin_notification_meta_add_string (notification_t *n,
1677 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1680 int plugin_notification_meta_add_signed_int (notification_t *n,
1684 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1687 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1691 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1694 int plugin_notification_meta_add_double (notification_t *n,
1698 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1701 int plugin_notification_meta_add_boolean (notification_t *n,
1705 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1708 int plugin_notification_meta_copy (notification_t *dst,
1709 const notification_t *src)
1711 notification_meta_t *meta;
1713 assert (dst != NULL);
1714 assert (src != NULL);
1715 assert (dst != src);
1716 assert ((src->meta == NULL) || (src->meta != dst->meta));
1718 for (meta = src->meta; meta != NULL; meta = meta->next)
1720 if (meta->type == NM_TYPE_STRING)
1721 plugin_notification_meta_add_string (dst, meta->name,
1722 meta->nm_value.nm_string);
1723 else if (meta->type == NM_TYPE_SIGNED_INT)
1724 plugin_notification_meta_add_signed_int (dst, meta->name,
1725 meta->nm_value.nm_signed_int);
1726 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1727 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1728 meta->nm_value.nm_unsigned_int);
1729 else if (meta->type == NM_TYPE_DOUBLE)
1730 plugin_notification_meta_add_double (dst, meta->name,
1731 meta->nm_value.nm_double);
1732 else if (meta->type == NM_TYPE_BOOLEAN)
1733 plugin_notification_meta_add_boolean (dst, meta->name,
1734 meta->nm_value.nm_boolean);
1738 } /* int plugin_notification_meta_copy */
1740 int plugin_notification_meta_free (notification_meta_t *n)
1742 notification_meta_t *this;
1743 notification_meta_t *next;
1747 ERROR ("plugin_notification_meta_free: n == NULL!");
1752 while (this != NULL)
1756 if (this->type == NM_TYPE_STRING)
1758 free ((char *)this->nm_value.nm_string);
1759 this->nm_value.nm_string = NULL;
1767 } /* int plugin_notification_meta_free */
1769 /* vim: set sw=8 ts=8 noet fdm=marker : */