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);
284 lt_dlerror (); /* clear errors */
286 #if LIBTOOL_VERSION == 2
287 if (flags & PLUGIN_FLAGS_GLOBAL) {
289 lt_dladvise_init(&advise);
290 lt_dladvise_global(&advise);
291 dlh = lt_dlopenadvise(file, advise);
292 lt_dladvise_destroy(&advise);
294 dlh = lt_dlopen (file);
296 #else /* if LIBTOOL_VERSION == 1 */
297 if (flags & PLUGIN_FLAGS_GLOBAL)
298 WARNING ("plugin_load_file: The global flag is not supported, "
299 "libtool 2 is required for this.");
300 dlh = lt_dlopen (file);
305 char errbuf[1024] = "";
307 ssnprintf (errbuf, sizeof (errbuf),
308 "lt_dlopen (\"%s\") failed: %s. "
309 "The most common cause for this problem is "
310 "missing dependencies. Use ldd(1) to check "
311 "the dependencies of the plugin "
313 file, lt_dlerror ());
315 ERROR ("%s", errbuf);
316 /* Make sure this is printed to STDERR in any case, but also
317 * make sure it's printed only once. */
318 if (list_log != NULL)
319 fprintf (stderr, "ERROR: %s\n", errbuf);
324 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
326 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
327 file, lt_dlerror ());
337 static _Bool timeout_reached(struct timespec timeout)
340 gettimeofday(&now, NULL);
341 return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
344 static void *plugin_read_thread (void __attribute__((unused)) *args)
346 while (read_loop != 0)
354 /* Get the read function that needs to be read next. */
355 rf = c_heap_get_root (read_heap);
358 struct timespec abstime;
360 gettimeofday (&now, /* timezone = */ NULL);
362 abstime.tv_sec = now.tv_sec + interval_g;
363 abstime.tv_nsec = 1000 * now.tv_usec;
365 pthread_mutex_lock (&read_lock);
366 pthread_cond_timedwait (&read_cond, &read_lock,
368 pthread_mutex_unlock (&read_lock);
372 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
374 gettimeofday (&now, /* timezone = */ NULL);
376 rf->rf_interval.tv_sec = interval_g;
377 rf->rf_interval.tv_nsec = 0;
379 rf->rf_effective_interval = rf->rf_interval;
381 rf->rf_next_read.tv_sec = now.tv_sec;
382 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
385 /* sleep until this entry is due,
386 * using pthread_cond_timedwait */
387 pthread_mutex_lock (&read_lock);
388 /* In pthread_cond_timedwait, spurious wakeups are possible
389 * (and really happen, at least on NetBSD with > 1 CPU), thus
390 * we need to re-evaluate the condition every time
391 * pthread_cond_timedwait returns. */
393 while ((read_loop != 0)
394 && !timeout_reached(rf->rf_next_read)
397 rc = pthread_cond_timedwait (&read_cond, &read_lock,
401 /* Must hold `read_lock' when accessing `rf->rf_type'. */
402 rf_type = rf->rf_type;
403 pthread_mutex_unlock (&read_lock);
405 /* Check if we're supposed to stop.. This may have interrupted
409 /* Insert `rf' again, so it can be free'd correctly */
410 c_heap_insert (read_heap, rf);
414 /* The entry has been marked for deletion. The linked list
415 * entry has already been removed by `plugin_unregister_read'.
416 * All we have to do here is free the `read_func_t' and
418 if (rf_type == RF_REMOVE)
420 DEBUG ("plugin_read_thread: Destroying the `%s' "
421 "callback.", rf->rf_name);
422 destroy_callback ((callback_func_t *) rf);
427 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
429 if (rf_type == RF_SIMPLE)
431 int (*callback) (void);
433 callback = rf->rf_callback;
434 status = (*callback) ();
438 plugin_read_cb callback;
440 assert (rf_type == RF_COMPLEX);
442 callback = rf->rf_callback;
443 status = (*callback) (&rf->rf_udata);
446 /* If the function signals failure, we will increase the
447 * intervals in which it will be called. */
450 rf->rf_effective_interval.tv_sec *= 2;
451 rf->rf_effective_interval.tv_nsec *= 2;
452 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
454 if (rf->rf_effective_interval.tv_sec >= 86400)
456 rf->rf_effective_interval.tv_sec = 86400;
457 rf->rf_effective_interval.tv_nsec = 0;
460 NOTICE ("read-function of plugin `%s' failed. "
461 "Will suspend it for %i seconds.",
463 (int) rf->rf_effective_interval.tv_sec);
467 /* Success: Restore the interval, if it was changed. */
468 rf->rf_effective_interval = rf->rf_interval;
471 /* update the ``next read due'' field */
472 gettimeofday (&now, /* timezone = */ NULL);
474 DEBUG ("plugin_read_thread: Effective interval of the "
475 "%s plugin is %i.%09i.",
477 (int) rf->rf_effective_interval.tv_sec,
478 (int) rf->rf_effective_interval.tv_nsec);
480 /* Calculate the next (absolute) time at which this function
481 * should be called. */
482 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
483 + rf->rf_effective_interval.tv_sec;
484 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
485 + rf->rf_effective_interval.tv_nsec;
486 NORMALIZE_TIMESPEC (rf->rf_next_read);
488 /* Check, if `rf_next_read' is in the past. */
489 if ((rf->rf_next_read.tv_sec < now.tv_sec)
490 || ((rf->rf_next_read.tv_sec == now.tv_sec)
491 && (rf->rf_next_read.tv_nsec < (1000 * now.tv_usec))))
493 /* `rf_next_read' is in the past. Insert `now'
494 * so this value doesn't trail off into the
496 rf->rf_next_read.tv_sec = now.tv_sec;
497 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
500 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
502 (int) rf->rf_next_read.tv_sec,
503 (int) rf->rf_next_read.tv_nsec);
505 /* Re-insert this read function into the heap again. */
506 c_heap_insert (read_heap, rf);
507 } /* while (read_loop) */
511 } /* void *plugin_read_thread */
513 static void start_read_threads (int num)
517 if (read_threads != NULL)
520 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
521 if (read_threads == NULL)
523 ERROR ("plugin: start_read_threads: calloc failed.");
527 read_threads_num = 0;
528 for (i = 0; i < num; i++)
530 if (pthread_create (read_threads + read_threads_num, NULL,
531 plugin_read_thread, NULL) == 0)
537 ERROR ("plugin: start_read_threads: pthread_create failed.");
541 } /* void start_read_threads */
543 static void stop_read_threads (void)
547 if (read_threads == NULL)
550 INFO ("collectd: Stopping %i read threads.", read_threads_num);
552 pthread_mutex_lock (&read_lock);
554 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
555 pthread_cond_broadcast (&read_cond);
556 pthread_mutex_unlock (&read_lock);
558 for (i = 0; i < read_threads_num; i++)
560 if (pthread_join (read_threads[i], NULL) != 0)
562 ERROR ("plugin: stop_read_threads: pthread_join failed.");
564 read_threads[i] = (pthread_t) 0;
566 sfree (read_threads);
567 read_threads_num = 0;
568 } /* void stop_read_threads */
573 void plugin_set_dir (const char *dir)
575 if (plugindir != NULL)
580 else if ((plugindir = strdup (dir)) == NULL)
583 ERROR ("strdup failed: %s",
584 sstrerror (errno, errbuf, sizeof (errbuf)));
589 int plugin_load (const char *type, uint32_t flags)
593 char filename[BUFSIZE] = "";
594 char typename[BUFSIZE];
601 DEBUG ("type = %s", type);
603 dir = plugin_get_dir ();
606 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
607 * type when matching the filename */
608 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
609 if ((status < 0) || ((size_t) status >= sizeof (typename)))
611 WARNING ("snprintf: truncated: `%s.so'", type);
614 typename_len = strlen (typename);
616 if ((dh = opendir (dir)) == NULL)
619 ERROR ("opendir (%s): %s", dir,
620 sstrerror (errno, errbuf, sizeof (errbuf)));
624 while ((de = readdir (dh)) != NULL)
626 if (strncasecmp (de->d_name, typename, typename_len))
629 status = ssnprintf (filename, sizeof (filename),
630 "%s/%s", dir, de->d_name);
631 if ((status < 0) || ((size_t) status >= sizeof (filename)))
633 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
637 if (lstat (filename, &statbuf) == -1)
640 WARNING ("stat %s: %s", filename,
641 sstrerror (errno, errbuf, sizeof (errbuf)));
644 else if (!S_ISREG (statbuf.st_mode))
646 /* don't follow symlinks */
647 WARNING ("stat %s: not a regular file", filename);
651 if (plugin_load_file (filename, flags) == 0)
659 fprintf (stderr, "Unable to load plugin %s.\n", type);
665 if (filename[0] == '\0')
666 fprintf (stderr, "Could not find plugin %s.\n", type);
672 * The `register_*' functions follow
674 int plugin_register_config (const char *name,
675 int (*callback) (const char *key, const char *val),
676 const char **keys, int keys_num)
678 cf_register (name, callback, keys, keys_num);
680 } /* int plugin_register_config */
682 int plugin_register_complex_config (const char *type,
683 int (*callback) (oconfig_item_t *))
685 return (cf_register_complex (type, callback));
686 } /* int plugin_register_complex_config */
688 int plugin_register_init (const char *name,
689 int (*callback) (void))
691 return (create_register_callback (&list_init, name, (void *) callback,
692 /* user_data = */ NULL));
693 } /* plugin_register_init */
695 static int plugin_compare_read_func (const void *arg0, const void *arg1)
697 const read_func_t *rf0;
698 const read_func_t *rf1;
703 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
705 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
707 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
709 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
713 } /* int plugin_compare_read_func */
715 /* Add a read function to both, the heap and a linked list. The linked list if
716 * used to look-up read functions, especially for the remove function. The heap
717 * is used to determine which plugin to read next. */
718 static int plugin_insert_read (read_func_t *rf)
723 pthread_mutex_lock (&read_lock);
725 if (read_list == NULL)
727 read_list = llist_create ();
728 if (read_list == NULL)
730 pthread_mutex_unlock (&read_lock);
731 ERROR ("plugin_insert_read: read_list failed.");
736 if (read_heap == NULL)
738 read_heap = c_heap_create (plugin_compare_read_func);
739 if (read_heap == NULL)
741 pthread_mutex_unlock (&read_lock);
742 ERROR ("plugin_insert_read: c_heap_create failed.");
747 le = llentry_create (rf->rf_name, rf);
750 pthread_mutex_unlock (&read_lock);
751 ERROR ("plugin_insert_read: llentry_create failed.");
755 status = c_heap_insert (read_heap, rf);
758 pthread_mutex_unlock (&read_lock);
759 ERROR ("plugin_insert_read: c_heap_insert failed.");
760 llentry_destroy (le);
764 /* This does not fail. */
765 llist_append (read_list, le);
767 pthread_mutex_unlock (&read_lock);
769 } /* int plugin_insert_read */
771 int plugin_register_read (const char *name,
772 int (*callback) (void))
776 rf = (read_func_t *) malloc (sizeof (read_func_t));
780 ERROR ("plugin_register_read: malloc failed: %s",
781 sstrerror (errno, errbuf, sizeof (errbuf)));
785 memset (rf, 0, sizeof (read_func_t));
786 rf->rf_callback = (void *) callback;
787 rf->rf_udata.data = NULL;
788 rf->rf_udata.free_func = NULL;
789 rf->rf_group[0] = '\0';
790 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
791 rf->rf_type = RF_SIMPLE;
792 rf->rf_interval.tv_sec = 0;
793 rf->rf_interval.tv_nsec = 0;
794 rf->rf_effective_interval = rf->rf_interval;
796 return (plugin_insert_read (rf));
797 } /* int plugin_register_read */
799 int plugin_register_complex_read (const char *group, const char *name,
800 plugin_read_cb callback,
801 const struct timespec *interval,
802 user_data_t *user_data)
806 rf = (read_func_t *) malloc (sizeof (read_func_t));
809 ERROR ("plugin_register_complex_read: malloc failed.");
813 memset (rf, 0, sizeof (read_func_t));
814 rf->rf_callback = (void *) callback;
816 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
818 rf->rf_group[0] = '\0';
819 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
820 rf->rf_type = RF_COMPLEX;
821 if (interval != NULL)
823 rf->rf_interval = *interval;
825 rf->rf_effective_interval = rf->rf_interval;
828 if (user_data == NULL)
830 rf->rf_udata.data = NULL;
831 rf->rf_udata.free_func = NULL;
835 rf->rf_udata = *user_data;
838 return (plugin_insert_read (rf));
839 } /* int plugin_register_complex_read */
841 int plugin_register_write (const char *name,
842 plugin_write_cb callback, user_data_t *ud)
844 return (create_register_callback (&list_write, name,
845 (void *) callback, ud));
846 } /* int plugin_register_write */
848 int plugin_register_flush (const char *name,
849 plugin_flush_cb callback, user_data_t *ud)
851 return (create_register_callback (&list_flush, name,
852 (void *) callback, ud));
853 } /* int plugin_register_flush */
855 int plugin_register_shutdown (const char *name,
856 int (*callback) (void))
858 return (create_register_callback (&list_shutdown, name,
859 (void *) callback, /* user_data = */ NULL));
860 } /* int plugin_register_shutdown */
862 int plugin_register_data_set (const data_set_t *ds)
867 if ((data_sets != NULL)
868 && (c_avl_get (data_sets, ds->type, NULL) == 0))
870 NOTICE ("Replacing DS `%s' with another version.", ds->type);
871 plugin_unregister_data_set (ds->type);
873 else if (data_sets == NULL)
875 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
876 if (data_sets == NULL)
880 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
883 memcpy(ds_copy, ds, sizeof (data_set_t));
885 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
887 if (ds_copy->ds == NULL)
893 for (i = 0; i < ds->ds_num; i++)
894 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
896 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
897 } /* int plugin_register_data_set */
899 int plugin_register_log (const char *name,
900 plugin_log_cb callback, user_data_t *ud)
902 return (create_register_callback (&list_log, name,
903 (void *) callback, ud));
904 } /* int plugin_register_log */
906 int plugin_register_notification (const char *name,
907 plugin_notification_cb callback, user_data_t *ud)
909 return (create_register_callback (&list_notification, name,
910 (void *) callback, ud));
911 } /* int plugin_register_log */
913 int plugin_unregister_config (const char *name)
915 cf_unregister (name);
917 } /* int plugin_unregister_config */
919 int plugin_unregister_complex_config (const char *name)
921 cf_unregister_complex (name);
923 } /* int plugin_unregister_complex_config */
925 int plugin_unregister_init (const char *name)
927 return (plugin_unregister (list_init, name));
930 int plugin_unregister_read (const char *name) /* {{{ */
938 pthread_mutex_lock (&read_lock);
940 if (read_list == NULL)
942 pthread_mutex_unlock (&read_lock);
946 le = llist_search (read_list, name);
949 pthread_mutex_unlock (&read_lock);
950 WARNING ("plugin_unregister_read: No such read function: %s",
955 llist_remove (read_list, le);
959 rf->rf_type = RF_REMOVE;
961 pthread_mutex_unlock (&read_lock);
963 llentry_destroy (le);
965 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
968 } /* }}} int plugin_unregister_read */
970 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
972 read_func_t *rf = e->value;
975 return strcmp (rf->rf_group, (const char *)group);
976 } /* }}} int compare_read_func_group */
978 int plugin_unregister_read_group (const char *group) /* {{{ */
988 pthread_mutex_lock (&read_lock);
990 if (read_list == NULL)
992 pthread_mutex_unlock (&read_lock);
998 le = llist_search_custom (read_list,
999 compare_read_func_group, (void *)group);
1006 llist_remove (read_list, le);
1009 assert (rf != NULL);
1010 rf->rf_type = RF_REMOVE;
1012 llentry_destroy (le);
1014 DEBUG ("plugin_unregister_read_group: "
1015 "Marked `%s' (group `%s') for removal.",
1016 rf->rf_name, group);
1019 pthread_mutex_unlock (&read_lock);
1023 WARNING ("plugin_unregister_read_group: No such "
1024 "group of read function: %s", group);
1029 } /* }}} int plugin_unregister_read_group */
1031 int plugin_unregister_write (const char *name)
1033 return (plugin_unregister (list_write, name));
1036 int plugin_unregister_flush (const char *name)
1038 return (plugin_unregister (list_flush, name));
1041 int plugin_unregister_shutdown (const char *name)
1043 return (plugin_unregister (list_shutdown, name));
1046 int plugin_unregister_data_set (const char *name)
1050 if (data_sets == NULL)
1053 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1060 } /* int plugin_unregister_data_set */
1062 int plugin_unregister_log (const char *name)
1064 return (plugin_unregister (list_log, name));
1067 int plugin_unregister_notification (const char *name)
1069 return (plugin_unregister (list_notification, name));
1072 void plugin_init_all (void)
1074 const char *chain_name;
1078 /* Init the value cache */
1081 chain_name = global_option_get ("PreCacheChain");
1082 pre_cache_chain = fc_chain_get_by_name (chain_name);
1084 chain_name = global_option_get ("PostCacheChain");
1085 post_cache_chain = fc_chain_get_by_name (chain_name);
1088 if ((list_init == NULL) && (read_heap == NULL))
1091 /* Calling all init callbacks before checking if read callbacks
1092 * are available allows the init callbacks to register the read
1094 le = llist_head (list_init);
1097 callback_func_t *cf;
1098 plugin_init_cb callback;
1101 callback = cf->cf_callback;
1102 status = (*callback) ();
1106 ERROR ("Initialization of plugin `%s' "
1107 "failed with status %i. "
1108 "Plugin will be unloaded.",
1110 /* Plugins that register read callbacks from the init
1111 * callback should take care of appropriate error
1112 * handling themselves. */
1113 /* FIXME: Unload _all_ functions */
1114 plugin_unregister_read (le->key);
1120 /* Start read-threads */
1121 if (read_heap != NULL)
1125 rt = global_option_get ("ReadThreads");
1128 start_read_threads ((num > 0) ? num : 5);
1130 } /* void plugin_init_all */
1132 /* TODO: Rename this function. */
1133 void plugin_read_all (void)
1135 uc_check_timeout ();
1138 } /* void plugin_read_all */
1140 /* Read function called when the `-T' command line argument is given. */
1141 int plugin_read_all_once (void)
1144 int return_status = 0;
1146 if (read_heap == NULL)
1148 NOTICE ("No read-functions are registered.");
1156 rf = c_heap_get_root (read_heap);
1160 if (rf->rf_type == RF_SIMPLE)
1162 int (*callback) (void);
1164 callback = rf->rf_callback;
1165 status = (*callback) ();
1169 plugin_read_cb callback;
1171 callback = rf->rf_callback;
1172 status = (*callback) (&rf->rf_udata);
1177 NOTICE ("read-function of plugin `%s' failed.",
1182 destroy_callback ((void *) rf);
1185 return (return_status);
1186 } /* int plugin_read_all_once */
1188 int plugin_write (const char *plugin, /* {{{ */
1189 const data_set_t *ds, const value_list_t *vl)
1197 if (list_write == NULL)
1202 ds = plugin_get_ds (vl->type);
1205 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1215 le = llist_head (list_write);
1218 callback_func_t *cf = le->value;
1219 plugin_write_cb callback;
1221 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1222 callback = cf->cf_callback;
1223 status = (*callback) (ds, vl, &cf->cf_udata);
1232 if ((success == 0) && (failure != 0))
1237 else /* plugin != NULL */
1239 callback_func_t *cf;
1240 plugin_write_cb callback;
1242 le = llist_head (list_write);
1245 if (strcasecmp (plugin, le->key) == 0)
1256 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1257 callback = cf->cf_callback;
1258 status = (*callback) (ds, vl, &cf->cf_udata);
1262 } /* }}} int plugin_write */
1264 int plugin_flush (const char *plugin, int timeout, const char *identifier)
1268 if (list_flush == NULL)
1271 le = llist_head (list_flush);
1274 callback_func_t *cf;
1275 plugin_flush_cb callback;
1277 if ((plugin != NULL)
1278 && (strcmp (plugin, le->key) != 0))
1285 callback = cf->cf_callback;
1287 (*callback) (timeout, identifier, &cf->cf_udata);
1292 } /* int plugin_flush */
1294 void plugin_shutdown_all (void)
1298 stop_read_threads ();
1300 destroy_all_callbacks (&list_init);
1302 pthread_mutex_lock (&read_lock);
1303 llist_destroy (read_list);
1305 pthread_mutex_unlock (&read_lock);
1307 destroy_read_heap ();
1309 plugin_flush (/* plugin = */ NULL, /* timeout = */ -1,
1310 /* identifier = */ NULL);
1313 if (list_shutdown != NULL)
1314 le = llist_head (list_shutdown);
1318 callback_func_t *cf;
1319 plugin_shutdown_cb callback;
1322 callback = cf->cf_callback;
1324 /* Advance the pointer before calling the callback allows
1325 * shutdown functions to unregister themselves. If done the
1326 * other way around the memory `le' points to will be freed
1327 * after callback returns. */
1333 /* Write plugins which use the `user_data' pointer usually need the
1334 * same data available to the flush callback. If this is the case, set
1335 * the free_function to NULL when registering the flush callback and to
1336 * the real free function when registering the write callback. This way
1337 * the data isn't freed twice. */
1338 destroy_all_callbacks (&list_flush);
1339 destroy_all_callbacks (&list_write);
1341 destroy_all_callbacks (&list_notification);
1342 destroy_all_callbacks (&list_shutdown);
1343 destroy_all_callbacks (&list_log);
1344 } /* void plugin_shutdown_all */
1346 int plugin_dispatch_values (value_list_t *vl)
1349 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1351 value_t *saved_values;
1352 int saved_values_len;
1356 int free_meta_data = 0;
1358 if ((vl == NULL) || (vl->type[0] == 0)
1359 || (vl->values == NULL) || (vl->values_len < 1))
1361 ERROR ("plugin_dispatch_values: Invalid value list "
1362 "from plugin %s.", vl->plugin);
1366 /* Free meta data only if the calling function didn't specify any. In
1367 * this case matches and targets may add some and the calling function
1368 * may not expect (and therefore free) that data. */
1369 if (vl->meta == NULL)
1372 if (list_write == NULL)
1373 c_complain_once (LOG_WARNING, &no_write_complaint,
1374 "plugin_dispatch_values: No write callback has been "
1375 "registered. Please load at least one output plugin, "
1376 "if you want the collected data to be stored.");
1378 if (data_sets == NULL)
1380 ERROR ("plugin_dispatch_values: No data sets registered. "
1381 "Could the types database be read? Check "
1382 "your `TypesDB' setting!");
1386 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1388 char ident[6 * DATA_MAX_NAME_LEN];
1390 FORMAT_VL (ident, sizeof (ident), vl);
1391 INFO ("plugin_dispatch_values: Dataset not found: %s "
1392 "(from \"%s\"), check your types.db!",
1398 vl->time = time (NULL);
1400 if (vl->interval <= 0)
1401 vl->interval = interval_g;
1403 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
1405 "plugin = %s; plugin_instance = %s; "
1406 "type = %s; type_instance = %s;",
1407 (unsigned int) vl->time, vl->interval,
1409 vl->plugin, vl->plugin_instance,
1410 vl->type, vl->type_instance);
1413 assert (0 == strcmp (ds->type, vl->type));
1415 if (0 != strcmp (ds->type, vl->type))
1416 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1417 ds->type, vl->type);
1421 assert (ds->ds_num == vl->values_len);
1423 if (ds->ds_num != vl->values_len)
1425 ERROR ("plugin_dispatch_values: ds->type = %s: "
1426 "(ds->ds_num = %i) != "
1427 "(vl->values_len = %i)",
1428 ds->type, ds->ds_num, vl->values_len);
1433 escape_slashes (vl->host, sizeof (vl->host));
1434 escape_slashes (vl->plugin, sizeof (vl->plugin));
1435 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1436 escape_slashes (vl->type, sizeof (vl->type));
1437 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1439 /* Copy the values. This way, we can assure `targets' that they get
1440 * dynamically allocated values, which they can free and replace if
1442 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1444 saved_values = vl->values;
1445 saved_values_len = vl->values_len;
1447 vl->values = (value_t *) calloc (vl->values_len,
1448 sizeof (*vl->values));
1449 if (vl->values == NULL)
1451 ERROR ("plugin_dispatch_values: calloc failed.");
1452 vl->values = saved_values;
1455 memcpy (vl->values, saved_values,
1456 vl->values_len * sizeof (*vl->values));
1458 else /* if ((pre == NULL) && (post == NULL)) */
1460 saved_values = NULL;
1461 saved_values_len = 0;
1464 if (pre_cache_chain != NULL)
1466 status = fc_process_chain (ds, vl, pre_cache_chain);
1469 WARNING ("plugin_dispatch_values: Running the "
1470 "pre-cache chain failed with "
1474 else if (status == FC_TARGET_STOP)
1476 /* Restore the state of the value_list so that plugins
1477 * don't get confused.. */
1478 if (saved_values != NULL)
1481 vl->values = saved_values;
1482 vl->values_len = saved_values_len;
1488 /* Update the value cache */
1491 /* Initiate threshold checking */
1492 ut_check_threshold (ds, vl);
1494 if (post_cache_chain != NULL)
1496 status = fc_process_chain (ds, vl, post_cache_chain);
1499 WARNING ("plugin_dispatch_values: Running the "
1500 "post-cache chain failed with "
1506 fc_default_action (ds, vl);
1508 /* Restore the state of the value_list so that plugins don't get
1510 if (saved_values != NULL)
1513 vl->values = saved_values;
1514 vl->values_len = saved_values_len;
1517 if ((free_meta_data != 0) && (vl->meta != NULL))
1519 meta_data_destroy (vl->meta);
1524 } /* int plugin_dispatch_values */
1526 int plugin_dispatch_values_secure (const value_list_t *vl)
1528 value_list_t vl_copy;
1534 memcpy (&vl_copy, vl, sizeof (vl_copy));
1536 /* Write callbacks must not change the values and meta pointers, so we can
1537 * savely skip copying those and make this more efficient. */
1538 if ((pre_cache_chain == NULL) && (post_cache_chain == NULL))
1539 return (plugin_dispatch_values (&vl_copy));
1541 /* Set pointers to NULL, just to be on the save side. */
1542 vl_copy.values = NULL;
1543 vl_copy.meta = NULL;
1545 vl_copy.values = malloc (sizeof (*vl_copy.values) * vl->values_len);
1546 if (vl_copy.values == NULL)
1548 ERROR ("plugin_dispatch_values_secure: malloc failed.");
1551 memcpy (vl_copy.values, vl->values, sizeof (*vl_copy.values) * vl->values_len);
1553 if (vl->meta != NULL)
1555 vl_copy.meta = meta_data_clone (vl->meta);
1556 if (vl_copy.meta == NULL)
1558 ERROR ("plugin_dispatch_values_secure: meta_data_clone failed.");
1559 free (vl_copy.values);
1562 } /* if (vl->meta) */
1564 status = plugin_dispatch_values (&vl_copy);
1566 meta_data_destroy (vl_copy.meta);
1567 free (vl_copy.values);
1570 } /* int plugin_dispatch_values_secure */
1572 int plugin_dispatch_notification (const notification_t *notif)
1575 /* Possible TODO: Add flap detection here */
1577 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1578 "time = %u; host = %s;",
1579 notif->severity, notif->message,
1580 (unsigned int) notif->time, notif->host);
1582 /* Nobody cares for notifications */
1583 if (list_notification == NULL)
1586 le = llist_head (list_notification);
1589 callback_func_t *cf;
1590 plugin_notification_cb callback;
1594 callback = cf->cf_callback;
1595 status = (*callback) (notif, &cf->cf_udata);
1598 WARNING ("plugin_dispatch_notification: Notification "
1599 "callback %s returned %i.",
1607 } /* int plugin_dispatch_notification */
1609 void plugin_log (int level, const char *format, ...)
1616 if (level >= LOG_DEBUG)
1620 va_start (ap, format);
1621 vsnprintf (msg, sizeof (msg), format, ap);
1622 msg[sizeof (msg) - 1] = '\0';
1625 if (list_log == NULL)
1627 fprintf (stderr, "%s\n", msg);
1631 le = llist_head (list_log);
1634 callback_func_t *cf;
1635 plugin_log_cb callback;
1638 callback = cf->cf_callback;
1640 (*callback) (level, msg, &cf->cf_udata);
1644 } /* void plugin_log */
1646 const data_set_t *plugin_get_ds (const char *name)
1650 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1652 DEBUG ("No such dataset registered: %s", name);
1657 } /* data_set_t *plugin_get_ds */
1659 static int plugin_notification_meta_add (notification_t *n,
1661 enum notification_meta_type_e type,
1664 notification_meta_t *meta;
1665 notification_meta_t *tail;
1667 if ((n == NULL) || (name == NULL) || (value == NULL))
1669 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1673 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1676 ERROR ("plugin_notification_meta_add: malloc failed.");
1679 memset (meta, 0, sizeof (notification_meta_t));
1681 sstrncpy (meta->name, name, sizeof (meta->name));
1686 case NM_TYPE_STRING:
1688 meta->nm_value.nm_string = strdup ((const char *) value);
1689 if (meta->nm_value.nm_string == NULL)
1691 ERROR ("plugin_notification_meta_add: strdup failed.");
1697 case NM_TYPE_SIGNED_INT:
1699 meta->nm_value.nm_signed_int = *((int64_t *) value);
1702 case NM_TYPE_UNSIGNED_INT:
1704 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1707 case NM_TYPE_DOUBLE:
1709 meta->nm_value.nm_double = *((double *) value);
1712 case NM_TYPE_BOOLEAN:
1714 meta->nm_value.nm_boolean = *((bool *) value);
1719 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1723 } /* switch (type) */
1727 while ((tail != NULL) && (tail->next != NULL))
1736 } /* int plugin_notification_meta_add */
1738 int plugin_notification_meta_add_string (notification_t *n,
1742 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1745 int plugin_notification_meta_add_signed_int (notification_t *n,
1749 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1752 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1756 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1759 int plugin_notification_meta_add_double (notification_t *n,
1763 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1766 int plugin_notification_meta_add_boolean (notification_t *n,
1770 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1773 int plugin_notification_meta_copy (notification_t *dst,
1774 const notification_t *src)
1776 notification_meta_t *meta;
1778 assert (dst != NULL);
1779 assert (src != NULL);
1780 assert (dst != src);
1781 assert ((src->meta == NULL) || (src->meta != dst->meta));
1783 for (meta = src->meta; meta != NULL; meta = meta->next)
1785 if (meta->type == NM_TYPE_STRING)
1786 plugin_notification_meta_add_string (dst, meta->name,
1787 meta->nm_value.nm_string);
1788 else if (meta->type == NM_TYPE_SIGNED_INT)
1789 plugin_notification_meta_add_signed_int (dst, meta->name,
1790 meta->nm_value.nm_signed_int);
1791 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1792 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1793 meta->nm_value.nm_unsigned_int);
1794 else if (meta->type == NM_TYPE_DOUBLE)
1795 plugin_notification_meta_add_double (dst, meta->name,
1796 meta->nm_value.nm_double);
1797 else if (meta->type == NM_TYPE_BOOLEAN)
1798 plugin_notification_meta_add_boolean (dst, meta->name,
1799 meta->nm_value.nm_boolean);
1803 } /* int plugin_notification_meta_copy */
1805 int plugin_notification_meta_free (notification_meta_t *n)
1807 notification_meta_t *this;
1808 notification_meta_t *next;
1812 ERROR ("plugin_notification_meta_free: n == NULL!");
1817 while (this != NULL)
1821 if (this->type == NM_TYPE_STRING)
1823 free ((char *)this->nm_value.nm_string);
1824 this->nm_value.nm_string = NULL;
1832 } /* int plugin_notification_meta_free */
1834 /* vim: set sw=8 ts=8 noet fdm=marker : */