2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2011 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 collectd.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 "filter_chain.h"
44 struct callback_func_s
49 typedef struct callback_func_s callback_func_t;
53 #define RF_REMOVE 65535
56 /* `read_func_t' "inherits" from `callback_func_t'.
57 * The `rf_super' member MUST be the first one in this structure! */
58 #define rf_callback rf_super.cf_callback
59 #define rf_udata rf_super.cf_udata
60 callback_func_t rf_super;
61 char rf_group[DATA_MAX_NAME_LEN];
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_missing;
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;
352 CDTIME_T_TO_TIMESPEC (now + interval_g, &abstime);
354 pthread_mutex_lock (&read_lock);
355 pthread_cond_timedwait (&read_cond, &read_lock,
357 pthread_mutex_unlock (&read_lock);
361 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
365 CDTIME_T_TO_TIMESPEC (interval_g, &rf->rf_interval);
367 rf->rf_effective_interval = rf->rf_interval;
369 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
372 /* sleep until this entry is due,
373 * using pthread_cond_timedwait */
374 pthread_mutex_lock (&read_lock);
375 /* In pthread_cond_timedwait, spurious wakeups are possible
376 * (and really happen, at least on NetBSD with > 1 CPU), thus
377 * we need to re-evaluate the condition every time
378 * pthread_cond_timedwait returns. */
380 while ((read_loop != 0)
381 && !timeout_reached(rf->rf_next_read)
384 rc = pthread_cond_timedwait (&read_cond, &read_lock,
388 /* Must hold `read_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 */
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 (TIMESPEC_TO_CDTIME_T (&rf->rf_next_read) < now)
478 /* `rf_next_read' is in the past. Insert `now'
479 * so this value doesn't trail off into the
481 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
484 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
486 (int) rf->rf_next_read.tv_sec,
487 (int) rf->rf_next_read.tv_nsec);
489 /* Re-insert this read function into the heap again. */
490 c_heap_insert (read_heap, rf);
491 } /* while (read_loop) */
495 } /* void *plugin_read_thread */
497 static void start_read_threads (int num)
501 if (read_threads != NULL)
504 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
505 if (read_threads == NULL)
507 ERROR ("plugin: start_read_threads: calloc failed.");
511 read_threads_num = 0;
512 for (i = 0; i < num; i++)
514 if (pthread_create (read_threads + read_threads_num, NULL,
515 plugin_read_thread, NULL) == 0)
521 ERROR ("plugin: start_read_threads: pthread_create failed.");
525 } /* void start_read_threads */
527 static void stop_read_threads (void)
531 if (read_threads == NULL)
534 INFO ("collectd: Stopping %i read threads.", read_threads_num);
536 pthread_mutex_lock (&read_lock);
538 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
539 pthread_cond_broadcast (&read_cond);
540 pthread_mutex_unlock (&read_lock);
542 for (i = 0; i < read_threads_num; i++)
544 if (pthread_join (read_threads[i], NULL) != 0)
546 ERROR ("plugin: stop_read_threads: pthread_join failed.");
548 read_threads[i] = (pthread_t) 0;
550 sfree (read_threads);
551 read_threads_num = 0;
552 } /* void stop_read_threads */
557 void plugin_set_dir (const char *dir)
559 if (plugindir != NULL)
564 else if ((plugindir = strdup (dir)) == NULL)
567 ERROR ("strdup failed: %s",
568 sstrerror (errno, errbuf, sizeof (errbuf)));
573 int plugin_load (const char *type, uint32_t flags)
577 char filename[BUFSIZE] = "";
578 char typename[BUFSIZE];
585 DEBUG ("type = %s", type);
587 dir = plugin_get_dir ();
590 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
591 * type when matching the filename */
592 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
593 if ((status < 0) || ((size_t) status >= sizeof (typename)))
595 WARNING ("snprintf: truncated: `%s.so'", type);
598 typename_len = strlen (typename);
600 if ((dh = opendir (dir)) == NULL)
603 ERROR ("opendir (%s): %s", dir,
604 sstrerror (errno, errbuf, sizeof (errbuf)));
608 while ((de = readdir (dh)) != NULL)
610 if (strncasecmp (de->d_name, typename, typename_len))
613 status = ssnprintf (filename, sizeof (filename),
614 "%s/%s", dir, de->d_name);
615 if ((status < 0) || ((size_t) status >= sizeof (filename)))
617 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
621 if (lstat (filename, &statbuf) == -1)
624 WARNING ("stat %s: %s", filename,
625 sstrerror (errno, errbuf, sizeof (errbuf)));
628 else if (!S_ISREG (statbuf.st_mode))
630 /* don't follow symlinks */
631 WARNING ("stat %s: not a regular file", filename);
635 if (plugin_load_file (filename, flags) == 0)
643 fprintf (stderr, "Unable to load plugin %s.\n", type);
649 if (filename[0] == '\0')
650 fprintf (stderr, "Could not find plugin %s.\n", type);
656 * The `register_*' functions follow
658 int plugin_register_config (const char *name,
659 int (*callback) (const char *key, const char *val),
660 const char **keys, int keys_num)
662 cf_register (name, callback, keys, keys_num);
664 } /* int plugin_register_config */
666 int plugin_register_complex_config (const char *type,
667 int (*callback) (oconfig_item_t *))
669 return (cf_register_complex (type, callback));
670 } /* int plugin_register_complex_config */
672 int plugin_register_init (const char *name,
673 int (*callback) (void))
675 return (create_register_callback (&list_init, name, (void *) callback,
676 /* user_data = */ NULL));
677 } /* plugin_register_init */
679 static int plugin_compare_read_func (const void *arg0, const void *arg1)
681 const read_func_t *rf0;
682 const read_func_t *rf1;
687 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
689 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
691 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
693 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
697 } /* int plugin_compare_read_func */
699 /* Add a read function to both, the heap and a linked list. The linked list if
700 * used to look-up read functions, especially for the remove function. The heap
701 * is used to determine which plugin to read next. */
702 static int plugin_insert_read (read_func_t *rf)
707 pthread_mutex_lock (&read_lock);
709 if (read_list == NULL)
711 read_list = llist_create ();
712 if (read_list == NULL)
714 pthread_mutex_unlock (&read_lock);
715 ERROR ("plugin_insert_read: read_list failed.");
720 if (read_heap == NULL)
722 read_heap = c_heap_create (plugin_compare_read_func);
723 if (read_heap == NULL)
725 pthread_mutex_unlock (&read_lock);
726 ERROR ("plugin_insert_read: c_heap_create failed.");
731 le = llist_search (read_list, rf->rf_name);
734 pthread_mutex_unlock (&read_lock);
735 WARNING ("The read function \"%s\" is already registered. "
736 "Check for duplicate \"LoadPlugin\" lines "
737 "in your configuration!",
742 le = llentry_create (rf->rf_name, rf);
745 pthread_mutex_unlock (&read_lock);
746 ERROR ("plugin_insert_read: llentry_create failed.");
750 status = c_heap_insert (read_heap, rf);
753 pthread_mutex_unlock (&read_lock);
754 ERROR ("plugin_insert_read: c_heap_insert failed.");
755 llentry_destroy (le);
759 /* This does not fail. */
760 llist_append (read_list, le);
762 pthread_mutex_unlock (&read_lock);
764 } /* int plugin_insert_read */
766 int plugin_register_read (const char *name,
767 int (*callback) (void))
772 rf = malloc (sizeof (*rf));
775 ERROR ("plugin_register_read: malloc failed.");
779 memset (rf, 0, sizeof (read_func_t));
780 rf->rf_callback = (void *) callback;
781 rf->rf_udata.data = NULL;
782 rf->rf_udata.free_func = NULL;
783 rf->rf_group[0] = '\0';
784 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
785 rf->rf_type = RF_SIMPLE;
786 rf->rf_interval.tv_sec = 0;
787 rf->rf_interval.tv_nsec = 0;
788 rf->rf_effective_interval = rf->rf_interval;
790 status = plugin_insert_read (rf);
795 } /* int plugin_register_read */
797 int plugin_register_complex_read (const char *group, const char *name,
798 plugin_read_cb callback,
799 const struct timespec *interval,
800 user_data_t *user_data)
805 rf = malloc (sizeof (*rf));
808 ERROR ("plugin_register_complex_read: malloc failed.");
812 memset (rf, 0, sizeof (read_func_t));
813 rf->rf_callback = (void *) callback;
815 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
817 rf->rf_group[0] = '\0';
818 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
819 rf->rf_type = RF_COMPLEX;
820 if (interval != NULL)
822 rf->rf_interval = *interval;
824 rf->rf_effective_interval = rf->rf_interval;
827 if (user_data == NULL)
829 rf->rf_udata.data = NULL;
830 rf->rf_udata.free_func = NULL;
834 rf->rf_udata = *user_data;
837 status = plugin_insert_read (rf);
842 } /* int plugin_register_complex_read */
844 int plugin_register_write (const char *name,
845 plugin_write_cb callback, user_data_t *ud)
847 return (create_register_callback (&list_write, name,
848 (void *) callback, ud));
849 } /* int plugin_register_write */
851 int plugin_register_flush (const char *name,
852 plugin_flush_cb callback, user_data_t *ud)
854 return (create_register_callback (&list_flush, name,
855 (void *) callback, ud));
856 } /* int plugin_register_flush */
858 int plugin_register_missing (const char *name,
859 plugin_missing_cb callback, user_data_t *ud)
861 return (create_register_callback (&list_missing, name,
862 (void *) callback, ud));
863 } /* int plugin_register_missing */
865 int plugin_register_shutdown (char *name,
866 int (*callback) (void))
868 return (create_register_callback (&list_shutdown, name,
869 (void *) callback, /* user_data = */ NULL));
870 } /* int plugin_register_shutdown */
872 int plugin_register_data_set (const data_set_t *ds)
877 if ((data_sets != NULL)
878 && (c_avl_get (data_sets, ds->type, NULL) == 0))
880 NOTICE ("Replacing DS `%s' with another version.", ds->type);
881 plugin_unregister_data_set (ds->type);
883 else if (data_sets == NULL)
885 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
886 if (data_sets == NULL)
890 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
893 memcpy(ds_copy, ds, sizeof (data_set_t));
895 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
897 if (ds_copy->ds == NULL)
903 for (i = 0; i < ds->ds_num; i++)
904 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
906 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
907 } /* int plugin_register_data_set */
909 int plugin_register_log (const char *name,
910 plugin_log_cb callback, user_data_t *ud)
912 return (create_register_callback (&list_log, name,
913 (void *) callback, ud));
914 } /* int plugin_register_log */
916 int plugin_register_notification (const char *name,
917 plugin_notification_cb callback, user_data_t *ud)
919 return (create_register_callback (&list_notification, name,
920 (void *) callback, ud));
921 } /* int plugin_register_log */
923 int plugin_unregister_config (const char *name)
925 cf_unregister (name);
927 } /* int plugin_unregister_config */
929 int plugin_unregister_complex_config (const char *name)
931 cf_unregister_complex (name);
933 } /* int plugin_unregister_complex_config */
935 int plugin_unregister_init (const char *name)
937 return (plugin_unregister (list_init, name));
940 int plugin_unregister_read (const char *name) /* {{{ */
948 pthread_mutex_lock (&read_lock);
950 if (read_list == NULL)
952 pthread_mutex_unlock (&read_lock);
956 le = llist_search (read_list, name);
959 pthread_mutex_unlock (&read_lock);
960 WARNING ("plugin_unregister_read: No such read function: %s",
965 llist_remove (read_list, le);
969 rf->rf_type = RF_REMOVE;
971 pthread_mutex_unlock (&read_lock);
973 llentry_destroy (le);
975 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
978 } /* }}} int plugin_unregister_read */
980 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
982 read_func_t *rf = e->value;
985 return strcmp (rf->rf_group, (const char *)group);
986 } /* }}} int compare_read_func_group */
988 int plugin_unregister_read_group (const char *group) /* {{{ */
998 pthread_mutex_lock (&read_lock);
1000 if (read_list == NULL)
1002 pthread_mutex_unlock (&read_lock);
1008 le = llist_search_custom (read_list,
1009 compare_read_func_group, (void *)group);
1016 llist_remove (read_list, le);
1019 assert (rf != NULL);
1020 rf->rf_type = RF_REMOVE;
1022 llentry_destroy (le);
1024 DEBUG ("plugin_unregister_read_group: "
1025 "Marked `%s' (group `%s') for removal.",
1026 rf->rf_name, group);
1029 pthread_mutex_unlock (&read_lock);
1033 WARNING ("plugin_unregister_read_group: No such "
1034 "group of read function: %s", group);
1039 } /* }}} int plugin_unregister_read_group */
1041 int plugin_unregister_write (const char *name)
1043 return (plugin_unregister (list_write, name));
1046 int plugin_unregister_flush (const char *name)
1048 return (plugin_unregister (list_flush, name));
1051 int plugin_unregister_missing (const char *name)
1053 return (plugin_unregister (list_missing, name));
1056 int plugin_unregister_shutdown (const char *name)
1058 return (plugin_unregister (list_shutdown, name));
1061 int plugin_unregister_data_set (const char *name)
1065 if (data_sets == NULL)
1068 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1075 } /* int plugin_unregister_data_set */
1077 int plugin_unregister_log (const char *name)
1079 return (plugin_unregister (list_log, name));
1082 int plugin_unregister_notification (const char *name)
1084 return (plugin_unregister (list_notification, name));
1087 void plugin_init_all (void)
1089 const char *chain_name;
1093 /* Init the value cache */
1096 chain_name = global_option_get ("PreCacheChain");
1097 pre_cache_chain = fc_chain_get_by_name (chain_name);
1099 chain_name = global_option_get ("PostCacheChain");
1100 post_cache_chain = fc_chain_get_by_name (chain_name);
1103 if ((list_init == NULL) && (read_heap == NULL))
1106 /* Calling all init callbacks before checking if read callbacks
1107 * are available allows the init callbacks to register the read
1109 le = llist_head (list_init);
1112 callback_func_t *cf;
1113 plugin_init_cb callback;
1116 callback = cf->cf_callback;
1117 status = (*callback) ();
1121 ERROR ("Initialization of plugin `%s' "
1122 "failed with status %i. "
1123 "Plugin will be unloaded.",
1125 /* Plugins that register read callbacks from the init
1126 * callback should take care of appropriate error
1127 * handling themselves. */
1128 /* FIXME: Unload _all_ functions */
1129 plugin_unregister_read (le->key);
1135 /* Start read-threads */
1136 if (read_heap != NULL)
1140 rt = global_option_get ("ReadThreads");
1143 start_read_threads ((num > 0) ? num : 5);
1145 } /* void plugin_init_all */
1147 /* TODO: Rename this function. */
1148 void plugin_read_all (void)
1150 uc_check_timeout ();
1153 } /* void plugin_read_all */
1155 /* Read function called when the `-T' command line argument is given. */
1156 int plugin_read_all_once (void)
1159 int return_status = 0;
1161 if (read_heap == NULL)
1163 NOTICE ("No read-functions are registered.");
1171 rf = c_heap_get_root (read_heap);
1175 if (rf->rf_type == RF_SIMPLE)
1177 int (*callback) (void);
1179 callback = rf->rf_callback;
1180 status = (*callback) ();
1184 plugin_read_cb callback;
1186 callback = rf->rf_callback;
1187 status = (*callback) (&rf->rf_udata);
1192 NOTICE ("read-function of plugin `%s' failed.",
1197 destroy_callback ((void *) rf);
1200 return (return_status);
1201 } /* int plugin_read_all_once */
1203 int plugin_write (const char *plugin, /* {{{ */
1204 const data_set_t *ds, const value_list_t *vl)
1212 if (list_write == NULL)
1217 ds = plugin_get_ds (vl->type);
1220 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1230 le = llist_head (list_write);
1233 callback_func_t *cf = le->value;
1234 plugin_write_cb callback;
1236 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1237 callback = cf->cf_callback;
1238 status = (*callback) (ds, vl, &cf->cf_udata);
1247 if ((success == 0) && (failure != 0))
1252 else /* plugin != NULL */
1254 callback_func_t *cf;
1255 plugin_write_cb callback;
1257 le = llist_head (list_write);
1260 if (strcasecmp (plugin, le->key) == 0)
1271 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1272 callback = cf->cf_callback;
1273 status = (*callback) (ds, vl, &cf->cf_udata);
1277 } /* }}} int plugin_write */
1279 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1283 if (list_flush == NULL)
1286 le = llist_head (list_flush);
1289 callback_func_t *cf;
1290 plugin_flush_cb callback;
1292 if ((plugin != NULL)
1293 && (strcmp (plugin, le->key) != 0))
1300 callback = cf->cf_callback;
1302 (*callback) (timeout, identifier, &cf->cf_udata);
1307 } /* int plugin_flush */
1309 void plugin_shutdown_all (void)
1313 stop_read_threads ();
1315 destroy_all_callbacks (&list_init);
1317 pthread_mutex_lock (&read_lock);
1318 llist_destroy (read_list);
1320 pthread_mutex_unlock (&read_lock);
1322 destroy_read_heap ();
1324 plugin_flush (/* plugin = */ NULL,
1326 /* identifier = */ NULL);
1329 if (list_shutdown != NULL)
1330 le = llist_head (list_shutdown);
1334 callback_func_t *cf;
1335 plugin_shutdown_cb callback;
1338 callback = cf->cf_callback;
1340 /* Advance the pointer before calling the callback allows
1341 * shutdown functions to unregister themselves. If done the
1342 * other way around the memory `le' points to will be freed
1343 * after callback returns. */
1349 /* Write plugins which use the `user_data' pointer usually need the
1350 * same data available to the flush callback. If this is the case, set
1351 * the free_function to NULL when registering the flush callback and to
1352 * the real free function when registering the write callback. This way
1353 * the data isn't freed twice. */
1354 destroy_all_callbacks (&list_flush);
1355 destroy_all_callbacks (&list_missing);
1356 destroy_all_callbacks (&list_write);
1358 destroy_all_callbacks (&list_notification);
1359 destroy_all_callbacks (&list_shutdown);
1360 destroy_all_callbacks (&list_log);
1361 } /* void plugin_shutdown_all */
1363 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1367 if (list_missing == NULL)
1370 le = llist_head (list_missing);
1373 callback_func_t *cf;
1374 plugin_missing_cb callback;
1378 callback = cf->cf_callback;
1380 status = (*callback) (vl, &cf->cf_udata);
1385 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1386 "failed with status %i.",
1399 } /* int }}} plugin_dispatch_missing */
1401 int plugin_dispatch_values (value_list_t *vl)
1404 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1406 value_t *saved_values;
1407 int saved_values_len;
1411 int free_meta_data = 0;
1413 if ((vl == NULL) || (vl->type[0] == 0)
1414 || (vl->values == NULL) || (vl->values_len < 1))
1416 ERROR ("plugin_dispatch_values: Invalid value list.");
1420 /* Free meta data only if the calling function didn't specify any. In
1421 * this case matches and targets may add some and the calling function
1422 * may not expect (and therefore free) that data. */
1423 if (vl->meta == NULL)
1426 if (list_write == NULL)
1427 c_complain_once (LOG_WARNING, &no_write_complaint,
1428 "plugin_dispatch_values: No write callback has been "
1429 "registered. Please load at least one output plugin, "
1430 "if you want the collected data to be stored.");
1432 if (data_sets == NULL)
1434 ERROR ("plugin_dispatch_values: No data sets registered. "
1435 "Could the types database be read? Check "
1436 "your `TypesDB' setting!");
1440 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1442 char ident[6 * DATA_MAX_NAME_LEN];
1444 FORMAT_VL (ident, sizeof (ident), vl);
1445 INFO ("plugin_dispatch_values: Dataset not found: %s "
1446 "(from \"%s\"), check your types.db!",
1452 vl->time = cdtime ();
1454 if (vl->interval <= 0)
1455 vl->interval = interval_g;
1457 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1459 "plugin = %s; plugin_instance = %s; "
1460 "type = %s; type_instance = %s;",
1461 CDTIME_T_TO_DOUBLE (vl->time),
1462 CDTIME_T_TO_DOUBLE (vl->interval),
1464 vl->plugin, vl->plugin_instance,
1465 vl->type, vl->type_instance);
1468 assert (0 == strcmp (ds->type, vl->type));
1470 if (0 != strcmp (ds->type, vl->type))
1471 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1472 ds->type, vl->type);
1476 assert (ds->ds_num == vl->values_len);
1478 if (ds->ds_num != vl->values_len)
1480 ERROR ("plugin_dispatch_values: ds->type = %s: "
1481 "(ds->ds_num = %i) != "
1482 "(vl->values_len = %i)",
1483 ds->type, ds->ds_num, vl->values_len);
1488 escape_slashes (vl->host, sizeof (vl->host));
1489 escape_slashes (vl->plugin, sizeof (vl->plugin));
1490 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1491 escape_slashes (vl->type, sizeof (vl->type));
1492 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1494 /* Copy the values. This way, we can assure `targets' that they get
1495 * dynamically allocated values, which they can free and replace if
1497 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1499 saved_values = vl->values;
1500 saved_values_len = vl->values_len;
1502 vl->values = (value_t *) calloc (vl->values_len,
1503 sizeof (*vl->values));
1504 if (vl->values == NULL)
1506 ERROR ("plugin_dispatch_values: calloc failed.");
1507 vl->values = saved_values;
1510 memcpy (vl->values, saved_values,
1511 vl->values_len * sizeof (*vl->values));
1513 else /* if ((pre == NULL) && (post == NULL)) */
1515 saved_values = NULL;
1516 saved_values_len = 0;
1519 if (pre_cache_chain != NULL)
1521 status = fc_process_chain (ds, vl, pre_cache_chain);
1524 WARNING ("plugin_dispatch_values: Running the "
1525 "pre-cache chain failed with "
1529 else if (status == FC_TARGET_STOP)
1531 /* Restore the state of the value_list so that plugins
1532 * don't get confused.. */
1533 if (saved_values != NULL)
1536 vl->values = saved_values;
1537 vl->values_len = saved_values_len;
1543 /* Update the value cache */
1546 if (post_cache_chain != NULL)
1548 status = fc_process_chain (ds, vl, post_cache_chain);
1551 WARNING ("plugin_dispatch_values: Running the "
1552 "post-cache chain failed with "
1558 fc_default_action (ds, vl);
1560 /* Restore the state of the value_list so that plugins don't get
1562 if (saved_values != NULL)
1565 vl->values = saved_values;
1566 vl->values_len = saved_values_len;
1569 if ((free_meta_data != 0) && (vl->meta != NULL))
1571 meta_data_destroy (vl->meta);
1576 } /* int plugin_dispatch_values */
1578 int plugin_dispatch_notification (const notification_t *notif)
1581 /* Possible TODO: Add flap detection here */
1583 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1584 "time = %.3f; host = %s;",
1585 notif->severity, notif->message,
1586 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1588 /* Nobody cares for notifications */
1589 if (list_notification == NULL)
1592 le = llist_head (list_notification);
1595 callback_func_t *cf;
1596 plugin_notification_cb callback;
1600 callback = cf->cf_callback;
1601 status = (*callback) (notif, &cf->cf_udata);
1604 WARNING ("plugin_dispatch_notification: Notification "
1605 "callback %s returned %i.",
1613 } /* int plugin_dispatch_notification */
1615 void plugin_log (int level, const char *format, ...)
1622 if (level >= LOG_DEBUG)
1626 va_start (ap, format);
1627 vsnprintf (msg, sizeof (msg), format, ap);
1628 msg[sizeof (msg) - 1] = '\0';
1631 if (list_log == NULL)
1633 fprintf (stderr, "%s\n", msg);
1637 le = llist_head (list_log);
1640 callback_func_t *cf;
1641 plugin_log_cb callback;
1644 callback = cf->cf_callback;
1646 (*callback) (level, msg, &cf->cf_udata);
1650 } /* void plugin_log */
1652 const data_set_t *plugin_get_ds (const char *name)
1656 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1658 DEBUG ("No such dataset registered: %s", name);
1663 } /* data_set_t *plugin_get_ds */
1665 static int plugin_notification_meta_add (notification_t *n,
1667 enum notification_meta_type_e type,
1670 notification_meta_t *meta;
1671 notification_meta_t *tail;
1673 if ((n == NULL) || (name == NULL) || (value == NULL))
1675 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1679 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1682 ERROR ("plugin_notification_meta_add: malloc failed.");
1685 memset (meta, 0, sizeof (notification_meta_t));
1687 sstrncpy (meta->name, name, sizeof (meta->name));
1692 case NM_TYPE_STRING:
1694 meta->nm_value.nm_string = strdup ((const char *) value);
1695 if (meta->nm_value.nm_string == NULL)
1697 ERROR ("plugin_notification_meta_add: strdup failed.");
1703 case NM_TYPE_SIGNED_INT:
1705 meta->nm_value.nm_signed_int = *((int64_t *) value);
1708 case NM_TYPE_UNSIGNED_INT:
1710 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1713 case NM_TYPE_DOUBLE:
1715 meta->nm_value.nm_double = *((double *) value);
1718 case NM_TYPE_BOOLEAN:
1720 meta->nm_value.nm_boolean = *((_Bool *) value);
1725 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1729 } /* switch (type) */
1733 while ((tail != NULL) && (tail->next != NULL))
1742 } /* int plugin_notification_meta_add */
1744 int plugin_notification_meta_add_string (notification_t *n,
1748 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1751 int plugin_notification_meta_add_signed_int (notification_t *n,
1755 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1758 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1762 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1765 int plugin_notification_meta_add_double (notification_t *n,
1769 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1772 int plugin_notification_meta_add_boolean (notification_t *n,
1776 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1779 int plugin_notification_meta_copy (notification_t *dst,
1780 const notification_t *src)
1782 notification_meta_t *meta;
1784 assert (dst != NULL);
1785 assert (src != NULL);
1786 assert (dst != src);
1787 assert ((src->meta == NULL) || (src->meta != dst->meta));
1789 for (meta = src->meta; meta != NULL; meta = meta->next)
1791 if (meta->type == NM_TYPE_STRING)
1792 plugin_notification_meta_add_string (dst, meta->name,
1793 meta->nm_value.nm_string);
1794 else if (meta->type == NM_TYPE_SIGNED_INT)
1795 plugin_notification_meta_add_signed_int (dst, meta->name,
1796 meta->nm_value.nm_signed_int);
1797 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1798 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1799 meta->nm_value.nm_unsigned_int);
1800 else if (meta->type == NM_TYPE_DOUBLE)
1801 plugin_notification_meta_add_double (dst, meta->name,
1802 meta->nm_value.nm_double);
1803 else if (meta->type == NM_TYPE_BOOLEAN)
1804 plugin_notification_meta_add_boolean (dst, meta->name,
1805 meta->nm_value.nm_boolean);
1809 } /* int plugin_notification_meta_copy */
1811 int plugin_notification_meta_free (notification_meta_t *n)
1813 notification_meta_t *this;
1814 notification_meta_t *next;
1818 ERROR ("plugin_notification_meta_free: n == NULL!");
1823 while (this != NULL)
1827 if (this->type == NM_TYPE_STRING)
1829 free ((char *)this->nm_value.nm_string);
1830 this->nm_value.nm_string = NULL;
1838 } /* int plugin_notification_meta_free */
1840 /* vim: set sw=8 ts=8 noet fdm=marker : */