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_name[DATA_MAX_NAME_LEN];
64 struct timespec rf_interval;
65 struct timespec rf_effective_interval;
66 struct timespec rf_next_read;
68 typedef struct read_func_s read_func_t;
73 static llist_t *list_init;
74 static llist_t *list_write;
75 static llist_t *list_flush;
76 static llist_t *list_shutdown;
77 static llist_t *list_log;
78 static llist_t *list_notification;
80 static fc_chain_t *pre_cache_chain = NULL;
81 static fc_chain_t *post_cache_chain = NULL;
83 static c_avl_tree_t *data_sets;
85 static char *plugindir = NULL;
87 static c_heap_t *read_heap = NULL;
88 static llist_t *read_list;
89 static int read_loop = 1;
90 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
91 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
92 static pthread_t *read_threads = NULL;
93 static int read_threads_num = 0;
98 static const char *plugin_get_dir (void)
100 if (plugindir == NULL)
106 static void destroy_callback (callback_func_t *cf) /* {{{ */
111 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
113 cf->cf_udata.free_func (cf->cf_udata.data);
114 cf->cf_udata.data = NULL;
115 cf->cf_udata.free_func = NULL;
118 } /* }}} void destroy_callback */
120 static void destroy_all_callbacks (llist_t **list) /* {{{ */
127 le = llist_head (*list);
135 destroy_callback (le->value);
141 llist_destroy (*list);
143 } /* }}} void destroy_all_callbacks */
145 static void destroy_read_heap (void) /* {{{ */
147 if (read_heap == NULL)
154 cf = c_head_get_root (read_heap);
158 destroy_callback (cf);
161 c_heap_destroy (read_heap);
163 } /* }}} void destroy_read_heap */
165 static int register_callback (llist_t **list, /* {{{ */
166 const char *name, callback_func_t *cf)
173 *list = llist_create ();
176 ERROR ("plugin: create_register_callback: "
177 "llist_create failed.");
178 destroy_callback (cf);
186 ERROR ("plugin: create_register_callback: strdup failed.");
187 destroy_callback (cf);
191 le = llist_search (*list, name);
194 le = llentry_create (key, cf);
197 ERROR ("plugin: create_register_callback: "
198 "llentry_create failed.");
200 destroy_callback (cf);
204 llist_append (*list, le);
208 callback_func_t *old_cf;
213 destroy_callback (old_cf);
218 } /* }}} int register_callback */
220 static int create_register_callback (llist_t **list, /* {{{ */
221 const char *name, void *callback, user_data_t *ud)
225 cf = (callback_func_t *) malloc (sizeof (*cf));
228 ERROR ("plugin: create_register_callback: malloc failed.");
231 memset (cf, 0, sizeof (*cf));
233 cf->cf_callback = callback;
236 cf->cf_udata.data = NULL;
237 cf->cf_udata.free_func = NULL;
244 return (register_callback (list, name, cf));
245 } /* }}} int create_register_callback */
247 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
254 e = llist_search (list, name);
258 llist_remove (list, e);
261 destroy_callback (e->value);
266 } /* }}} int plugin_unregister */
269 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
270 * object, but it will bitch about a shared object not having a
271 * ``module_register'' symbol..
273 static int plugin_load_file (char *file, uint32_t flags)
276 void (*reg_handle) (void);
278 DEBUG ("file = %s", file);
281 lt_dlerror (); /* clear errors */
283 if (flags & PLUGIN_FLAGS_GLOBAL) {
285 lt_dladvise_init(&advise);
286 lt_dladvise_global(&advise);
287 dlh = lt_dlopenadvise(file, advise);
288 lt_dladvise_destroy(&advise);
290 dlh = lt_dlopen (file);
294 const char *error = lt_dlerror ();
296 ERROR ("lt_dlopen (%s) failed: %s", file, error);
297 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
301 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
303 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
304 file, lt_dlerror ());
314 static void *plugin_read_thread (void __attribute__((unused)) *args)
316 while (read_loop != 0)
323 /* Get the read function that needs to be read next. */
324 rf = c_head_get_root (read_heap);
327 struct timespec abstime;
329 gettimeofday (&now, /* timezone = */ NULL);
331 abstime.tv_sec = now.tv_sec + interval_g;
332 abstime.tv_nsec = 1000 * now.tv_usec;
334 pthread_mutex_lock (&read_lock);
335 pthread_cond_timedwait (&read_cond, &read_lock,
337 pthread_mutex_unlock (&read_lock);
341 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
343 gettimeofday (&now, /* timezone = */ NULL);
345 rf->rf_interval.tv_sec = interval_g;
346 rf->rf_interval.tv_nsec = 0;
348 rf->rf_effective_interval = rf->rf_interval;
350 rf->rf_next_read.tv_sec = now.tv_sec;
351 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
354 /* sleep until this entry is due,
355 * using pthread_cond_timedwait */
356 pthread_mutex_lock (&read_lock);
357 pthread_cond_timedwait (&read_cond, &read_lock,
359 /* Must hold `real_lock' when accessing `rf->rf_type'. */
360 rf_type = rf->rf_type;
361 pthread_mutex_unlock (&read_lock);
363 /* Check if we're supposed to stop.. This may have interrupted
367 /* Insert `rf' again, so it can be free'd correctly */
368 c_heap_insert (read_heap, rf);
372 /* The entry has been marked for deletion. The linked list
373 * entry has already been removed by `plugin_unregister_read'.
374 * All we have to do here is free the `read_func_t' and
376 if (rf_type == RF_REMOVE)
378 DEBUG ("plugin_read_thread: Destroying the `%s' "
379 "callback.", rf->rf_name);
380 destroy_callback ((callback_func_t *) rf);
385 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
387 if (rf_type == RF_SIMPLE)
389 int (*callback) (void);
391 callback = rf->rf_callback;
392 status = (*callback) ();
396 plugin_read_cb callback;
398 assert (rf_type == RF_COMPLEX);
400 callback = rf->rf_callback;
401 status = (*callback) (&rf->rf_udata);
404 /* If the function signals failure, we will increase the
405 * intervals in which it will be called. */
408 rf->rf_effective_interval.tv_sec *= 2;
409 rf->rf_effective_interval.tv_nsec *= 2;
410 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
412 if (rf->rf_effective_interval.tv_sec >= 86400)
414 rf->rf_effective_interval.tv_sec = 86400;
415 rf->rf_effective_interval.tv_nsec = 0;
418 NOTICE ("read-function of plugin `%s' failed. "
419 "Will suspend it for %i seconds.",
421 (int) rf->rf_effective_interval.tv_sec);
425 /* Success: Restore the interval, if it was changed. */
426 rf->rf_effective_interval = rf->rf_interval;
429 /* update the ``next read due'' field */
430 gettimeofday (&now, /* timezone = */ NULL);
432 DEBUG ("plugin_read_thread: Effective interval of the "
433 "%s plugin is %i.%09i.",
435 (int) rf->rf_effective_interval.tv_sec,
436 (int) rf->rf_effective_interval.tv_nsec);
438 /* Calculate the next (absolute) time at which this function
439 * should be called. */
440 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
441 + rf->rf_effective_interval.tv_sec;
442 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
443 + rf->rf_effective_interval.tv_nsec;
444 NORMALIZE_TIMESPEC (rf->rf_next_read);
446 /* Check, if `rf_next_read' is in the past. */
447 if ((rf->rf_next_read.tv_sec < now.tv_sec)
448 || ((rf->rf_next_read.tv_sec == now.tv_sec)
449 && (rf->rf_next_read.tv_nsec < (1000 * now.tv_usec))))
451 /* `rf_next_read' is in the past. Insert `now'
452 * so this value doesn't trail off into the
454 rf->rf_next_read.tv_sec = now.tv_sec;
455 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
458 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
460 (int) rf->rf_next_read.tv_sec,
461 (int) rf->rf_next_read.tv_nsec);
463 /* Re-insert this read function into the heap again. */
464 c_heap_insert (read_heap, rf);
465 } /* while (read_loop) */
469 } /* void *plugin_read_thread */
471 static void start_read_threads (int num)
475 if (read_threads != NULL)
478 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
479 if (read_threads == NULL)
481 ERROR ("plugin: start_read_threads: calloc failed.");
485 read_threads_num = 0;
486 for (i = 0; i < num; i++)
488 if (pthread_create (read_threads + read_threads_num, NULL,
489 plugin_read_thread, NULL) == 0)
495 ERROR ("plugin: start_read_threads: pthread_create failed.");
499 } /* void start_read_threads */
501 static void stop_read_threads (void)
505 if (read_threads == NULL)
508 INFO ("collectd: Stopping %i read threads.", read_threads_num);
510 pthread_mutex_lock (&read_lock);
512 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
513 pthread_cond_broadcast (&read_cond);
514 pthread_mutex_unlock (&read_lock);
516 for (i = 0; i < read_threads_num; i++)
518 if (pthread_join (read_threads[i], NULL) != 0)
520 ERROR ("plugin: stop_read_threads: pthread_join failed.");
522 read_threads[i] = (pthread_t) 0;
524 sfree (read_threads);
525 read_threads_num = 0;
526 } /* void stop_read_threads */
531 void plugin_set_dir (const char *dir)
533 if (plugindir != NULL)
538 else if ((plugindir = strdup (dir)) == NULL)
541 ERROR ("strdup failed: %s",
542 sstrerror (errno, errbuf, sizeof (errbuf)));
547 int plugin_load (const char *type, uint32_t flags)
551 char filename[BUFSIZE] = "";
552 char typename[BUFSIZE];
559 DEBUG ("type = %s", type);
561 dir = plugin_get_dir ();
564 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
565 * type when matching the filename */
566 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
567 if ((status < 0) || ((size_t) status >= sizeof (typename)))
569 WARNING ("snprintf: truncated: `%s.so'", type);
572 typename_len = strlen (typename);
574 if ((dh = opendir (dir)) == NULL)
577 ERROR ("opendir (%s): %s", dir,
578 sstrerror (errno, errbuf, sizeof (errbuf)));
582 while ((de = readdir (dh)) != NULL)
584 if (strncasecmp (de->d_name, typename, typename_len))
587 status = ssnprintf (filename, sizeof (filename),
588 "%s/%s", dir, de->d_name);
589 if ((status < 0) || ((size_t) status >= sizeof (filename)))
591 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
595 if (lstat (filename, &statbuf) == -1)
598 WARNING ("stat %s: %s", filename,
599 sstrerror (errno, errbuf, sizeof (errbuf)));
602 else if (!S_ISREG (statbuf.st_mode))
604 /* don't follow symlinks */
605 WARNING ("stat %s: not a regular file", filename);
609 if (plugin_load_file (filename, flags) == 0)
617 fprintf (stderr, "Unable to load plugin %s.\n", type);
623 if (filename[0] == '\0')
624 fprintf (stderr, "Could not find plugin %s.\n", type);
630 * The `register_*' functions follow
632 int plugin_register_config (const char *name,
633 int (*callback) (const char *key, const char *val),
634 const char **keys, int keys_num)
636 cf_register (name, callback, keys, keys_num);
638 } /* int plugin_register_config */
640 int plugin_register_complex_config (const char *type,
641 int (*callback) (oconfig_item_t *))
643 return (cf_register_complex (type, callback));
644 } /* int plugin_register_complex_config */
646 int plugin_register_init (const char *name,
647 int (*callback) (void))
649 return (create_register_callback (&list_init, name, (void *) callback,
650 /* user_data = */ NULL));
651 } /* plugin_register_init */
653 static int plugin_compare_read_func (const void *arg0, const void *arg1)
655 const read_func_t *rf0;
656 const read_func_t *rf1;
661 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
663 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
665 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
667 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
671 } /* int plugin_compare_read_func */
673 /* Add a read function to both, the heap and a linked list. The linked list if
674 * used to look-up read functions, especially for the remove function. The heap
675 * is used to determine which plugin to read next. */
676 static int plugin_insert_read (read_func_t *rf)
681 pthread_mutex_lock (&read_lock);
683 if (read_list == NULL)
685 read_list = llist_create ();
686 if (read_list == NULL)
688 pthread_mutex_unlock (&read_lock);
689 ERROR ("plugin_insert_read: read_list failed.");
694 if (read_heap == NULL)
696 read_heap = c_heap_create (plugin_compare_read_func);
697 if (read_heap == NULL)
699 pthread_mutex_unlock (&read_lock);
700 ERROR ("plugin_insert_read: c_heap_create failed.");
705 le = llentry_create (rf->rf_name, rf);
708 pthread_mutex_unlock (&read_lock);
709 ERROR ("plugin_insert_read: llentry_create failed.");
713 status = c_heap_insert (read_heap, rf);
716 pthread_mutex_unlock (&read_lock);
717 ERROR ("plugin_insert_read: c_heap_insert failed.");
718 llentry_destroy (le);
722 /* This does not fail. */
723 llist_append (read_list, le);
725 pthread_mutex_unlock (&read_lock);
727 } /* int plugin_insert_read */
729 int plugin_register_read (const char *name,
730 int (*callback) (void))
734 rf = (read_func_t *) malloc (sizeof (read_func_t));
738 ERROR ("plugin_register_read: malloc failed: %s",
739 sstrerror (errno, errbuf, sizeof (errbuf)));
743 memset (rf, 0, sizeof (read_func_t));
744 rf->rf_callback = (void *) callback;
745 rf->rf_udata.data = NULL;
746 rf->rf_udata.free_func = NULL;
747 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
748 rf->rf_type = RF_SIMPLE;
749 rf->rf_interval.tv_sec = 0;
750 rf->rf_interval.tv_nsec = 0;
751 rf->rf_effective_interval = rf->rf_interval;
753 return (plugin_insert_read (rf));
754 } /* int plugin_register_read */
756 int plugin_register_complex_read (const char *name,
757 plugin_read_cb callback,
758 const struct timespec *interval,
759 user_data_t *user_data)
763 rf = (read_func_t *) malloc (sizeof (read_func_t));
766 ERROR ("plugin_register_complex_read: malloc failed.");
770 memset (rf, 0, sizeof (read_func_t));
771 rf->rf_callback = (void *) callback;
772 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
773 rf->rf_type = RF_COMPLEX;
774 if (interval != NULL)
776 rf->rf_interval = *interval;
778 rf->rf_effective_interval = rf->rf_interval;
781 if (user_data == NULL)
783 rf->rf_udata.data = NULL;
784 rf->rf_udata.free_func = NULL;
788 rf->rf_udata = *user_data;
791 return (plugin_insert_read (rf));
792 } /* int plugin_register_complex_read */
794 int plugin_register_write (const char *name,
795 plugin_write_cb callback, user_data_t *ud)
797 return (create_register_callback (&list_write, name,
798 (void *) callback, ud));
799 } /* int plugin_register_write */
801 int plugin_register_flush (const char *name,
802 plugin_flush_cb callback, user_data_t *ud)
804 return (create_register_callback (&list_flush, name,
805 (void *) callback, ud));
806 } /* int plugin_register_flush */
808 int plugin_register_shutdown (char *name,
809 int (*callback) (void))
811 return (create_register_callback (&list_shutdown, name,
812 (void *) callback, /* user_data = */ NULL));
813 } /* int plugin_register_shutdown */
815 int plugin_register_data_set (const data_set_t *ds)
820 if ((data_sets != NULL)
821 && (c_avl_get (data_sets, ds->type, NULL) == 0))
823 NOTICE ("Replacing DS `%s' with another version.", ds->type);
824 plugin_unregister_data_set (ds->type);
826 else if (data_sets == NULL)
828 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
829 if (data_sets == NULL)
833 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
836 memcpy(ds_copy, ds, sizeof (data_set_t));
838 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
840 if (ds_copy->ds == NULL)
846 for (i = 0; i < ds->ds_num; i++)
847 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
849 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
850 } /* int plugin_register_data_set */
852 int plugin_register_log (const char *name,
853 plugin_log_cb callback, user_data_t *ud)
855 return (create_register_callback (&list_log, name,
856 (void *) callback, ud));
857 } /* int plugin_register_log */
859 int plugin_register_notification (const char *name,
860 plugin_notification_cb callback, user_data_t *ud)
862 return (create_register_callback (&list_notification, name,
863 (void *) callback, ud));
864 } /* int plugin_register_log */
866 int plugin_unregister_config (const char *name)
868 cf_unregister (name);
870 } /* int plugin_unregister_config */
872 int plugin_unregister_complex_config (const char *name)
874 cf_unregister_complex (name);
876 } /* int plugin_unregister_complex_config */
878 int plugin_unregister_init (const char *name)
880 return (plugin_unregister (list_init, name));
883 int plugin_unregister_read (const char *name) /* {{{ */
891 pthread_mutex_lock (&read_lock);
893 if (read_list == NULL)
895 pthread_mutex_unlock (&read_lock);
899 le = llist_search (read_list, name);
902 pthread_mutex_unlock (&read_lock);
903 WARNING ("plugin_unregister_read: No such read function: %s",
908 llist_remove (read_list, le);
912 rf->rf_type = RF_REMOVE;
914 pthread_mutex_unlock (&read_lock);
916 llentry_destroy (le);
918 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
921 } /* }}} int plugin_unregister_read */
923 int plugin_unregister_write (const char *name)
925 return (plugin_unregister (list_write, name));
928 int plugin_unregister_flush (const char *name)
930 return (plugin_unregister (list_flush, name));
933 int plugin_unregister_shutdown (const char *name)
935 return (plugin_unregister (list_shutdown, name));
938 int plugin_unregister_data_set (const char *name)
942 if (data_sets == NULL)
945 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
952 } /* int plugin_unregister_data_set */
954 int plugin_unregister_log (const char *name)
956 return (plugin_unregister (list_log, name));
959 int plugin_unregister_notification (const char *name)
961 return (plugin_unregister (list_notification, name));
964 void plugin_init_all (void)
966 const char *chain_name;
970 /* Init the value cache */
973 chain_name = global_option_get ("PreCacheChain");
974 pre_cache_chain = fc_chain_get_by_name (chain_name);
976 chain_name = global_option_get ("PostCacheChain");
977 post_cache_chain = fc_chain_get_by_name (chain_name);
980 if ((list_init == NULL) && (read_heap == NULL))
983 /* Calling all init callbacks before checking if read callbacks
984 * are available allows the init callbacks to register the read
986 le = llist_head (list_init);
990 plugin_init_cb callback;
993 callback = cf->cf_callback;
994 status = (*callback) ();
998 ERROR ("Initialization of plugin `%s' "
999 "failed with status %i. "
1000 "Plugin will be unloaded.",
1002 /* Plugins that register read callbacks from the init
1003 * callback should take care of appropriate error
1004 * handling themselves. */
1005 /* FIXME: Unload _all_ functions */
1006 plugin_unregister_read (le->key);
1012 /* Start read-threads */
1013 if (read_heap != NULL)
1017 rt = global_option_get ("ReadThreads");
1020 start_read_threads ((num > 0) ? num : 5);
1022 } /* void plugin_init_all */
1024 /* TODO: Rename this function. */
1025 void plugin_read_all (void)
1027 uc_check_timeout ();
1030 } /* void plugin_read_all */
1032 /* Read function called when the `-T' command line argument is given. */
1033 int plugin_read_all_once (void)
1036 int return_status = 0;
1038 if (read_heap == NULL)
1040 NOTICE ("No read-functions are registered.");
1048 rf = c_head_get_root (read_heap);
1052 if (rf->rf_type == RF_SIMPLE)
1054 int (*callback) (void);
1056 callback = rf->rf_callback;
1057 status = (*callback) ();
1061 plugin_read_cb callback;
1063 callback = rf->rf_callback;
1064 status = (*callback) (&rf->rf_udata);
1069 NOTICE ("read-function of plugin `%s' failed.",
1074 destroy_callback ((void *) rf);
1077 return (return_status);
1078 } /* int plugin_read_all_once */
1080 int plugin_write (const char *plugin, /* {{{ */
1081 const data_set_t *ds, const value_list_t *vl)
1089 if (list_write == NULL)
1094 ds = plugin_get_ds (vl->type);
1097 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1107 le = llist_head (list_write);
1110 callback_func_t *cf = le->value;
1111 plugin_write_cb callback;
1113 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1114 callback = cf->cf_callback;
1115 status = (*callback) (ds, vl, &cf->cf_udata);
1124 if ((success == 0) && (failure != 0))
1129 else /* plugin != NULL */
1131 callback_func_t *cf;
1132 plugin_write_cb callback;
1134 le = llist_head (list_write);
1137 if (strcasecmp (plugin, le->key) == 0)
1148 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1149 callback = cf->cf_callback;
1150 status = (*callback) (ds, vl, &cf->cf_udata);
1154 } /* }}} int plugin_write */
1156 int plugin_flush (const char *plugin, int timeout, const char *identifier)
1160 if (list_flush == NULL)
1163 le = llist_head (list_flush);
1166 callback_func_t *cf;
1167 plugin_flush_cb callback;
1169 if ((plugin != NULL)
1170 && (strcmp (plugin, le->key) != 0))
1177 callback = cf->cf_callback;
1179 (*callback) (timeout, identifier, &cf->cf_udata);
1184 } /* int plugin_flush */
1186 void plugin_shutdown_all (void)
1190 stop_read_threads ();
1192 destroy_all_callbacks (&list_init);
1194 pthread_mutex_lock (&read_lock);
1195 llist_destroy (read_list);
1197 pthread_mutex_unlock (&read_lock);
1199 destroy_read_heap ();
1201 plugin_flush (/* plugin = */ NULL, /* timeout = */ -1,
1202 /* identifier = */ NULL);
1205 if (list_shutdown != NULL)
1206 le = llist_head (list_shutdown);
1210 callback_func_t *cf;
1211 plugin_shutdown_cb callback;
1214 callback = cf->cf_callback;
1216 /* Advance the pointer before calling the callback allows
1217 * shutdown functions to unregister themselves. If done the
1218 * other way around the memory `le' points to will be freed
1219 * after callback returns. */
1225 /* Write plugins which use the `user_data' pointer usually need the
1226 * same data available to the flush callback. If this is the case, set
1227 * the free_function to NULL when registering the flush callback and to
1228 * the real free function when registering the write callback. This way
1229 * the data isn't freed twice. */
1230 destroy_all_callbacks (&list_flush);
1231 destroy_all_callbacks (&list_write);
1233 destroy_all_callbacks (&list_notification);
1234 destroy_all_callbacks (&list_shutdown);
1235 destroy_all_callbacks (&list_log);
1236 } /* void plugin_shutdown_all */
1238 int plugin_dispatch_values (value_list_t *vl)
1241 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1243 value_t *saved_values;
1244 int saved_values_len;
1248 int free_meta_data = 0;
1250 if ((vl == NULL) || (vl->type[0] == 0)
1251 || (vl->values == NULL) || (vl->values_len < 1))
1253 ERROR ("plugin_dispatch_values: Invalid value list.");
1257 /* Free meta data only if the calling function didn't specify any. In
1258 * this case matches and targets may add some and the calling function
1259 * may not expect (and therefore free) that data. */
1260 if (vl->meta == NULL)
1263 if (list_write == NULL)
1264 c_complain_once (LOG_WARNING, &no_write_complaint,
1265 "plugin_dispatch_values: No write callback has been "
1266 "registered. Please load at least one output plugin, "
1267 "if you want the collected data to be stored.");
1269 if (data_sets == NULL)
1271 ERROR ("plugin_dispatch_values: No data sets registered. "
1272 "Could the types database be read? Check "
1273 "your `TypesDB' setting!");
1277 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1279 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
1284 vl->time = time (NULL);
1286 if (vl->interval <= 0)
1287 vl->interval = interval_g;
1289 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
1291 "plugin = %s; plugin_instance = %s; "
1292 "type = %s; type_instance = %s;",
1293 (unsigned int) vl->time, vl->interval,
1295 vl->plugin, vl->plugin_instance,
1296 vl->type, vl->type_instance);
1299 assert (0 == strcmp (ds->type, vl->type));
1301 if (0 != strcmp (ds->type, vl->type))
1302 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1303 ds->type, vl->type);
1307 assert (ds->ds_num == vl->values_len);
1309 if (ds->ds_num != vl->values_len)
1311 ERROR ("plugin_dispatch_values: ds->type = %s: "
1312 "(ds->ds_num = %i) != "
1313 "(vl->values_len = %i)",
1314 ds->type, ds->ds_num, vl->values_len);
1319 escape_slashes (vl->host, sizeof (vl->host));
1320 escape_slashes (vl->plugin, sizeof (vl->plugin));
1321 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1322 escape_slashes (vl->type, sizeof (vl->type));
1323 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1325 /* Copy the values. This way, we can assure `targets' that they get
1326 * dynamically allocated values, which they can free and replace if
1328 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1330 saved_values = vl->values;
1331 saved_values_len = vl->values_len;
1333 vl->values = (value_t *) calloc (vl->values_len,
1334 sizeof (*vl->values));
1335 if (vl->values == NULL)
1337 ERROR ("plugin_dispatch_values: calloc failed.");
1338 vl->values = saved_values;
1341 memcpy (vl->values, saved_values,
1342 vl->values_len * sizeof (*vl->values));
1344 else /* if ((pre == NULL) && (post == NULL)) */
1346 saved_values = NULL;
1347 saved_values_len = 0;
1350 if (pre_cache_chain != NULL)
1352 status = fc_process_chain (ds, vl, pre_cache_chain);
1355 WARNING ("plugin_dispatch_values: Running the "
1356 "pre-cache chain failed with "
1360 else if (status == FC_TARGET_STOP)
1362 /* Restore the state of the value_list so that plugins
1363 * don't get confused.. */
1364 if (saved_values != NULL)
1367 vl->values = saved_values;
1368 vl->values_len = saved_values_len;
1374 /* Update the value cache */
1377 /* Initiate threshold checking */
1378 ut_check_threshold (ds, vl);
1380 if (post_cache_chain != NULL)
1382 status = fc_process_chain (ds, vl, post_cache_chain);
1385 WARNING ("plugin_dispatch_values: Running the "
1386 "post-cache chain failed with "
1392 fc_default_action (ds, vl);
1394 /* Restore the state of the value_list so that plugins don't get
1396 if (saved_values != NULL)
1399 vl->values = saved_values;
1400 vl->values_len = saved_values_len;
1403 if ((free_meta_data != 0) && (vl->meta != NULL))
1405 meta_data_destroy (vl->meta);
1410 } /* int plugin_dispatch_values */
1412 int plugin_dispatch_notification (const notification_t *notif)
1415 /* Possible TODO: Add flap detection here */
1417 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1418 "time = %u; host = %s;",
1419 notif->severity, notif->message,
1420 (unsigned int) notif->time, notif->host);
1422 /* Nobody cares for notifications */
1423 if (list_notification == NULL)
1426 le = llist_head (list_notification);
1429 callback_func_t *cf;
1430 plugin_notification_cb callback;
1434 callback = cf->cf_callback;
1435 status = (*callback) (notif, &cf->cf_udata);
1438 WARNING ("plugin_dispatch_notification: Notification "
1439 "callback %s returned %i.",
1447 } /* int plugin_dispatch_notification */
1449 void plugin_log (int level, const char *format, ...)
1455 if (list_log == NULL)
1459 if (level >= LOG_DEBUG)
1463 va_start (ap, format);
1464 vsnprintf (msg, sizeof (msg), format, ap);
1465 msg[sizeof (msg) - 1] = '\0';
1468 le = llist_head (list_log);
1471 callback_func_t *cf;
1472 plugin_log_cb callback;
1475 callback = cf->cf_callback;
1477 (*callback) (level, msg, &cf->cf_udata);
1481 } /* void plugin_log */
1483 const data_set_t *plugin_get_ds (const char *name)
1487 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1489 DEBUG ("No such dataset registered: %s", name);
1494 } /* data_set_t *plugin_get_ds */
1496 static int plugin_notification_meta_add (notification_t *n,
1498 enum notification_meta_type_e type,
1501 notification_meta_t *meta;
1502 notification_meta_t *tail;
1504 if ((n == NULL) || (name == NULL) || (value == NULL))
1506 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1510 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1513 ERROR ("plugin_notification_meta_add: malloc failed.");
1516 memset (meta, 0, sizeof (notification_meta_t));
1518 sstrncpy (meta->name, name, sizeof (meta->name));
1523 case NM_TYPE_STRING:
1525 meta->nm_value.nm_string = strdup ((const char *) value);
1526 if (meta->nm_value.nm_string == NULL)
1528 ERROR ("plugin_notification_meta_add: strdup failed.");
1534 case NM_TYPE_SIGNED_INT:
1536 meta->nm_value.nm_signed_int = *((int64_t *) value);
1539 case NM_TYPE_UNSIGNED_INT:
1541 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1544 case NM_TYPE_DOUBLE:
1546 meta->nm_value.nm_double = *((double *) value);
1549 case NM_TYPE_BOOLEAN:
1551 meta->nm_value.nm_boolean = *((bool *) value);
1556 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1560 } /* switch (type) */
1564 while ((tail != NULL) && (tail->next != NULL))
1573 } /* int plugin_notification_meta_add */
1575 int plugin_notification_meta_add_string (notification_t *n,
1579 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1582 int plugin_notification_meta_add_signed_int (notification_t *n,
1586 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1589 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1593 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1596 int plugin_notification_meta_add_double (notification_t *n,
1600 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1603 int plugin_notification_meta_add_boolean (notification_t *n,
1607 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1610 int plugin_notification_meta_copy (notification_t *dst,
1611 const notification_t *src)
1613 notification_meta_t *meta;
1615 assert (dst != NULL);
1616 assert (src != NULL);
1617 assert (dst != src);
1618 assert ((src->meta == NULL) || (src->meta != dst->meta));
1620 for (meta = src->meta; meta != NULL; meta = meta->next)
1622 if (meta->type == NM_TYPE_STRING)
1623 plugin_notification_meta_add_string (dst, meta->name,
1624 meta->nm_value.nm_string);
1625 else if (meta->type == NM_TYPE_SIGNED_INT)
1626 plugin_notification_meta_add_signed_int (dst, meta->name,
1627 meta->nm_value.nm_signed_int);
1628 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1629 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1630 meta->nm_value.nm_unsigned_int);
1631 else if (meta->type == NM_TYPE_DOUBLE)
1632 plugin_notification_meta_add_double (dst, meta->name,
1633 meta->nm_value.nm_double);
1634 else if (meta->type == NM_TYPE_BOOLEAN)
1635 plugin_notification_meta_add_boolean (dst, meta->name,
1636 meta->nm_value.nm_boolean);
1640 } /* int plugin_notification_meta_copy */
1642 int plugin_notification_meta_free (notification_meta_t *n)
1644 notification_meta_t *this;
1645 notification_meta_t *next;
1649 ERROR ("plugin_notification_meta_free: n == NULL!");
1654 while (this != NULL)
1658 if (this->type == NM_TYPE_STRING)
1660 free ((char *)this->nm_value.nm_string);
1661 this->nm_value.nm_string = NULL;
1669 } /* int plugin_notification_meta_free */
1671 /* vim: set sw=8 ts=8 noet fdm=marker : */