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
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 #define rf_ctx rf_super.cf_ctx
62 callback_func_t rf_super;
63 char rf_group[DATA_MAX_NAME_LEN];
64 char rf_name[DATA_MAX_NAME_LEN];
66 struct timespec rf_interval;
67 struct timespec rf_effective_interval;
68 struct timespec rf_next_read;
70 typedef struct read_func_s read_func_t;
75 static llist_t *list_init;
76 static llist_t *list_write;
77 static llist_t *list_flush;
78 static llist_t *list_missing;
79 static llist_t *list_shutdown;
80 static llist_t *list_log;
81 static llist_t *list_notification;
83 static fc_chain_t *pre_cache_chain = NULL;
84 static fc_chain_t *post_cache_chain = NULL;
86 static c_avl_tree_t *data_sets;
88 static char *plugindir = NULL;
90 static c_heap_t *read_heap = NULL;
91 static llist_t *read_list;
92 static int read_loop = 1;
93 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
94 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
95 static pthread_t *read_threads = NULL;
96 static int read_threads_num = 0;
98 static pthread_key_t plugin_ctx_key;
99 static _Bool plugin_ctx_key_initialized = 0;
104 static const char *plugin_get_dir (void)
106 if (plugindir == NULL)
112 static void destroy_callback (callback_func_t *cf) /* {{{ */
117 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
119 cf->cf_udata.free_func (cf->cf_udata.data);
120 cf->cf_udata.data = NULL;
121 cf->cf_udata.free_func = NULL;
124 } /* }}} void destroy_callback */
126 static void destroy_all_callbacks (llist_t **list) /* {{{ */
133 le = llist_head (*list);
141 destroy_callback (le->value);
147 llist_destroy (*list);
149 } /* }}} void destroy_all_callbacks */
151 static void destroy_read_heap (void) /* {{{ */
153 if (read_heap == NULL)
160 cf = c_heap_get_root (read_heap);
164 destroy_callback (cf);
167 c_heap_destroy (read_heap);
169 } /* }}} void destroy_read_heap */
171 static int register_callback (llist_t **list, /* {{{ */
172 const char *name, callback_func_t *cf)
179 *list = llist_create ();
182 ERROR ("plugin: register_callback: "
183 "llist_create failed.");
184 destroy_callback (cf);
192 ERROR ("plugin: register_callback: strdup failed.");
193 destroy_callback (cf);
197 le = llist_search (*list, name);
200 le = llentry_create (key, cf);
203 ERROR ("plugin: register_callback: "
204 "llentry_create failed.");
206 destroy_callback (cf);
210 llist_append (*list, le);
214 callback_func_t *old_cf;
219 WARNING ("plugin: register_callback: "
220 "a callback named `%s' already exists - "
221 "overwriting the old entry!", name);
223 destroy_callback (old_cf);
228 } /* }}} int register_callback */
230 static int create_register_callback (llist_t **list, /* {{{ */
231 const char *name, void *callback, user_data_t *ud)
235 cf = (callback_func_t *) malloc (sizeof (*cf));
238 ERROR ("plugin: create_register_callback: malloc failed.");
241 memset (cf, 0, sizeof (*cf));
243 cf->cf_callback = callback;
246 cf->cf_udata.data = NULL;
247 cf->cf_udata.free_func = NULL;
254 cf->cf_ctx = plugin_get_ctx ();
256 return (register_callback (list, name, cf));
257 } /* }}} int create_register_callback */
259 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
266 e = llist_search (list, name);
270 llist_remove (list, e);
273 destroy_callback (e->value);
278 } /* }}} int plugin_unregister */
281 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
282 * object, but it will bitch about a shared object not having a
283 * ``module_register'' symbol..
285 static int plugin_load_file (char *file, uint32_t flags)
288 void (*reg_handle) (void);
291 lt_dlerror (); /* clear errors */
293 #if LIBTOOL_VERSION == 2
294 if (flags & PLUGIN_FLAGS_GLOBAL) {
296 lt_dladvise_init(&advise);
297 lt_dladvise_global(&advise);
298 dlh = lt_dlopenadvise(file, advise);
299 lt_dladvise_destroy(&advise);
301 dlh = lt_dlopen (file);
303 #else /* if LIBTOOL_VERSION == 1 */
304 if (flags & PLUGIN_FLAGS_GLOBAL)
305 WARNING ("plugin_load_file: The global flag is not supported, "
306 "libtool 2 is required for this.");
307 dlh = lt_dlopen (file);
312 char errbuf[1024] = "";
314 ssnprintf (errbuf, sizeof (errbuf),
315 "lt_dlopen (\"%s\") failed: %s. "
316 "The most common cause for this problem are "
317 "missing dependencies. Use ldd(1) to check "
318 "the dependencies of the plugin "
320 file, lt_dlerror ());
322 ERROR ("%s", errbuf);
323 /* Make sure this is printed to STDERR in any case, but also
324 * make sure it's printed only once. */
325 if (list_log != NULL)
326 fprintf (stderr, "ERROR: %s\n", errbuf);
331 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
333 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
334 file, lt_dlerror ());
344 static _Bool timeout_reached(struct timespec timeout)
347 gettimeofday(&now, NULL);
348 return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
351 static void *plugin_read_thread (void __attribute__((unused)) *args)
353 while (read_loop != 0)
356 plugin_ctx_t old_ctx;
362 /* Get the read function that needs to be read next. */
363 rf = c_heap_get_root (read_heap);
366 struct timespec abstime;
370 CDTIME_T_TO_TIMESPEC (now + interval_g, &abstime);
372 pthread_mutex_lock (&read_lock);
373 pthread_cond_timedwait (&read_cond, &read_lock,
375 pthread_mutex_unlock (&read_lock);
379 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
381 /* this should not happen, because the interval is set
382 * for each plugin when loading it
383 * XXX: issue a warning? */
386 CDTIME_T_TO_TIMESPEC (plugin_get_interval (), &rf->rf_interval);
388 rf->rf_effective_interval = rf->rf_interval;
390 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
393 /* sleep until this entry is due,
394 * using pthread_cond_timedwait */
395 pthread_mutex_lock (&read_lock);
396 /* In pthread_cond_timedwait, spurious wakeups are possible
397 * (and really happen, at least on NetBSD with > 1 CPU), thus
398 * we need to re-evaluate the condition every time
399 * pthread_cond_timedwait returns. */
401 while ((read_loop != 0)
402 && !timeout_reached(rf->rf_next_read)
405 rc = pthread_cond_timedwait (&read_cond, &read_lock,
409 /* Must hold `read_lock' when accessing `rf->rf_type'. */
410 rf_type = rf->rf_type;
411 pthread_mutex_unlock (&read_lock);
413 /* Check if we're supposed to stop.. This may have interrupted
417 /* Insert `rf' again, so it can be free'd correctly */
418 c_heap_insert (read_heap, rf);
422 /* The entry has been marked for deletion. The linked list
423 * entry has already been removed by `plugin_unregister_read'.
424 * All we have to do here is free the `read_func_t' and
426 if (rf_type == RF_REMOVE)
428 DEBUG ("plugin_read_thread: Destroying the `%s' "
429 "callback.", rf->rf_name);
430 destroy_callback ((callback_func_t *) rf);
435 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
437 old_ctx = plugin_set_ctx (rf->rf_ctx);
439 if (rf_type == RF_SIMPLE)
441 int (*callback) (void);
443 callback = rf->rf_callback;
444 status = (*callback) ();
448 plugin_read_cb callback;
450 assert (rf_type == RF_COMPLEX);
452 callback = rf->rf_callback;
453 status = (*callback) (&rf->rf_udata);
456 plugin_set_ctx (old_ctx);
458 /* If the function signals failure, we will increase the
459 * intervals in which it will be called. */
462 rf->rf_effective_interval.tv_sec *= 2;
463 rf->rf_effective_interval.tv_nsec *= 2;
464 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
466 if (rf->rf_effective_interval.tv_sec >= 86400)
468 rf->rf_effective_interval.tv_sec = 86400;
469 rf->rf_effective_interval.tv_nsec = 0;
472 NOTICE ("read-function of plugin `%s' failed. "
473 "Will suspend it for %i seconds.",
475 (int) rf->rf_effective_interval.tv_sec);
479 /* Success: Restore the interval, if it was changed. */
480 rf->rf_effective_interval = rf->rf_interval;
483 /* update the ``next read due'' field */
486 DEBUG ("plugin_read_thread: Effective interval of the "
487 "%s plugin is %i.%09i.",
489 (int) rf->rf_effective_interval.tv_sec,
490 (int) rf->rf_effective_interval.tv_nsec);
492 /* Calculate the next (absolute) time at which this function
493 * should be called. */
494 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
495 + rf->rf_effective_interval.tv_sec;
496 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
497 + rf->rf_effective_interval.tv_nsec;
498 NORMALIZE_TIMESPEC (rf->rf_next_read);
500 /* Check, if `rf_next_read' is in the past. */
501 if (TIMESPEC_TO_CDTIME_T (&rf->rf_next_read) < now)
503 /* `rf_next_read' is in the past. Insert `now'
504 * so this value doesn't trail off into the
506 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
509 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
511 (int) rf->rf_next_read.tv_sec,
512 (int) rf->rf_next_read.tv_nsec);
514 /* Re-insert this read function into the heap again. */
515 c_heap_insert (read_heap, rf);
516 } /* while (read_loop) */
520 } /* void *plugin_read_thread */
522 static void start_read_threads (int num)
526 if (read_threads != NULL)
529 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
530 if (read_threads == NULL)
532 ERROR ("plugin: start_read_threads: calloc failed.");
536 read_threads_num = 0;
537 for (i = 0; i < num; i++)
539 if (pthread_create (read_threads + read_threads_num, NULL,
540 plugin_read_thread, NULL) == 0)
546 ERROR ("plugin: start_read_threads: pthread_create failed.");
550 } /* void start_read_threads */
552 static void stop_read_threads (void)
556 if (read_threads == NULL)
559 INFO ("collectd: Stopping %i read threads.", read_threads_num);
561 pthread_mutex_lock (&read_lock);
563 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
564 pthread_cond_broadcast (&read_cond);
565 pthread_mutex_unlock (&read_lock);
567 for (i = 0; i < read_threads_num; i++)
569 if (pthread_join (read_threads[i], NULL) != 0)
571 ERROR ("plugin: stop_read_threads: pthread_join failed.");
573 read_threads[i] = (pthread_t) 0;
575 sfree (read_threads);
576 read_threads_num = 0;
577 } /* void stop_read_threads */
582 void plugin_set_dir (const char *dir)
584 if (plugindir != NULL)
589 else if ((plugindir = strdup (dir)) == NULL)
592 ERROR ("strdup failed: %s",
593 sstrerror (errno, errbuf, sizeof (errbuf)));
598 int plugin_load (const char *type, uint32_t flags)
602 char filename[BUFSIZE] = "";
603 char typename[BUFSIZE];
610 DEBUG ("type = %s", type);
612 dir = plugin_get_dir ();
615 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
616 * type when matching the filename */
617 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
618 if ((status < 0) || ((size_t) status >= sizeof (typename)))
620 WARNING ("snprintf: truncated: `%s.so'", type);
623 typename_len = strlen (typename);
625 if ((dh = opendir (dir)) == NULL)
628 ERROR ("opendir (%s): %s", dir,
629 sstrerror (errno, errbuf, sizeof (errbuf)));
633 while ((de = readdir (dh)) != NULL)
635 if (strncasecmp (de->d_name, typename, typename_len))
638 status = ssnprintf (filename, sizeof (filename),
639 "%s/%s", dir, de->d_name);
640 if ((status < 0) || ((size_t) status >= sizeof (filename)))
642 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
646 if (lstat (filename, &statbuf) == -1)
649 WARNING ("stat %s: %s", filename,
650 sstrerror (errno, errbuf, sizeof (errbuf)));
653 else if (!S_ISREG (statbuf.st_mode))
655 /* don't follow symlinks */
656 WARNING ("stat %s: not a regular file", filename);
660 if (plugin_load_file (filename, flags) == 0)
668 fprintf (stderr, "Unable to load plugin %s.\n", type);
674 if (filename[0] == '\0')
675 fprintf (stderr, "Could not find plugin %s.\n", type);
681 * The `register_*' functions follow
683 int plugin_register_config (const char *name,
684 int (*callback) (const char *key, const char *val),
685 const char **keys, int keys_num)
687 cf_register (name, callback, keys, keys_num);
689 } /* int plugin_register_config */
691 int plugin_register_complex_config (const char *type,
692 int (*callback) (oconfig_item_t *))
694 return (cf_register_complex (type, callback));
695 } /* int plugin_register_complex_config */
697 int plugin_register_init (const char *name,
698 int (*callback) (void))
700 return (create_register_callback (&list_init, name, (void *) callback,
701 /* user_data = */ NULL));
702 } /* plugin_register_init */
704 static int plugin_compare_read_func (const void *arg0, const void *arg1)
706 const read_func_t *rf0;
707 const read_func_t *rf1;
712 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
714 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
716 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
718 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
722 } /* int plugin_compare_read_func */
724 /* Add a read function to both, the heap and a linked list. The linked list if
725 * used to look-up read functions, especially for the remove function. The heap
726 * is used to determine which plugin to read next. */
727 static int plugin_insert_read (read_func_t *rf)
732 pthread_mutex_lock (&read_lock);
734 if (read_list == NULL)
736 read_list = llist_create ();
737 if (read_list == NULL)
739 pthread_mutex_unlock (&read_lock);
740 ERROR ("plugin_insert_read: read_list failed.");
745 if (read_heap == NULL)
747 read_heap = c_heap_create (plugin_compare_read_func);
748 if (read_heap == NULL)
750 pthread_mutex_unlock (&read_lock);
751 ERROR ("plugin_insert_read: c_heap_create failed.");
756 le = llist_search (read_list, rf->rf_name);
759 pthread_mutex_unlock (&read_lock);
760 WARNING ("The read function \"%s\" is already registered. "
761 "Check for duplicate \"LoadPlugin\" lines "
762 "in your configuration!",
767 le = llentry_create (rf->rf_name, rf);
770 pthread_mutex_unlock (&read_lock);
771 ERROR ("plugin_insert_read: llentry_create failed.");
775 status = c_heap_insert (read_heap, rf);
778 pthread_mutex_unlock (&read_lock);
779 ERROR ("plugin_insert_read: c_heap_insert failed.");
780 llentry_destroy (le);
784 /* This does not fail. */
785 llist_append (read_list, le);
787 pthread_mutex_unlock (&read_lock);
789 } /* int plugin_insert_read */
791 static int read_cb_wrapper (user_data_t *ud)
793 int (*callback) (void);
800 } /* int read_cb_wrapper */
802 int plugin_register_read (const char *name,
803 int (*callback) (void))
806 plugin_ctx_t ctx = plugin_get_ctx ();
809 if (ctx.interval != 0) {
810 /* If ctx.interval is not zero (== use the plugin or global
811 * interval), we need to use the "complex" read callback,
812 * because only that allows to specify a different interval.
813 * Wrap the callback using read_cb_wrapper(). */
814 struct timespec interval;
815 user_data_t user_data;
817 user_data.data = callback;
818 user_data.free_func = NULL;
820 CDTIME_T_TO_TIMESPEC (ctx.interval, &interval);
821 return plugin_register_complex_read (/* group = */ NULL,
822 name, read_cb_wrapper, &interval, &user_data);
825 DEBUG ("plugin_register_read: default_interval = %.3f",
826 CDTIME_T_TO_DOUBLE(plugin_get_interval ()));
828 rf = malloc (sizeof (*rf));
831 ERROR ("plugin_register_read: malloc failed.");
835 memset (rf, 0, sizeof (read_func_t));
836 rf->rf_callback = (void *) callback;
837 rf->rf_udata.data = NULL;
838 rf->rf_udata.free_func = NULL;
840 rf->rf_group[0] = '\0';
841 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
842 rf->rf_type = RF_SIMPLE;
843 rf->rf_interval.tv_sec = 0;
844 rf->rf_interval.tv_nsec = 0;
845 rf->rf_effective_interval = rf->rf_interval;
847 status = plugin_insert_read (rf);
852 } /* int plugin_register_read */
854 int plugin_register_complex_read (const char *group, const char *name,
855 plugin_read_cb callback,
856 const struct timespec *interval,
857 user_data_t *user_data)
860 plugin_ctx_t ctx = plugin_get_ctx ();
863 rf = malloc (sizeof (*rf));
866 ERROR ("plugin_register_complex_read: malloc failed.");
870 memset (rf, 0, sizeof (read_func_t));
871 rf->rf_callback = (void *) callback;
873 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
875 rf->rf_group[0] = '\0';
876 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
877 rf->rf_type = RF_COMPLEX;
878 if (interval != NULL)
880 rf->rf_interval = *interval;
882 else if (ctx.interval != 0)
884 CDTIME_T_TO_TIMESPEC (ctx.interval, &rf->rf_interval);
886 rf->rf_effective_interval = rf->rf_interval;
888 DEBUG ("plugin_register_read: interval = %i.%09i",
889 (int) rf->rf_interval.tv_sec,
890 (int) rf->rf_interval.tv_nsec);
893 if (user_data == NULL)
895 rf->rf_udata.data = NULL;
896 rf->rf_udata.free_func = NULL;
900 rf->rf_udata = *user_data;
905 status = plugin_insert_read (rf);
910 } /* int plugin_register_complex_read */
912 int plugin_register_write (const char *name,
913 plugin_write_cb callback, user_data_t *ud)
915 return (create_register_callback (&list_write, name,
916 (void *) callback, ud));
917 } /* int plugin_register_write */
919 int plugin_register_flush (const char *name,
920 plugin_flush_cb callback, user_data_t *ud)
922 return (create_register_callback (&list_flush, name,
923 (void *) callback, ud));
924 } /* int plugin_register_flush */
926 int plugin_register_missing (const char *name,
927 plugin_missing_cb callback, user_data_t *ud)
929 return (create_register_callback (&list_missing, name,
930 (void *) callback, ud));
931 } /* int plugin_register_missing */
933 int plugin_register_shutdown (const char *name,
934 int (*callback) (void))
936 return (create_register_callback (&list_shutdown, name,
937 (void *) callback, /* user_data = */ NULL));
938 } /* int plugin_register_shutdown */
940 int plugin_register_data_set (const data_set_t *ds)
945 if ((data_sets != NULL)
946 && (c_avl_get (data_sets, ds->type, NULL) == 0))
948 NOTICE ("Replacing DS `%s' with another version.", ds->type);
949 plugin_unregister_data_set (ds->type);
951 else if (data_sets == NULL)
953 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
954 if (data_sets == NULL)
958 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
961 memcpy(ds_copy, ds, sizeof (data_set_t));
963 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
965 if (ds_copy->ds == NULL)
971 for (i = 0; i < ds->ds_num; i++)
972 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
974 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
975 } /* int plugin_register_data_set */
977 int plugin_register_log (const char *name,
978 plugin_log_cb callback, user_data_t *ud)
980 return (create_register_callback (&list_log, name,
981 (void *) callback, ud));
982 } /* int plugin_register_log */
984 int plugin_register_notification (const char *name,
985 plugin_notification_cb callback, user_data_t *ud)
987 return (create_register_callback (&list_notification, name,
988 (void *) callback, ud));
989 } /* int plugin_register_log */
991 int plugin_unregister_config (const char *name)
993 cf_unregister (name);
995 } /* int plugin_unregister_config */
997 int plugin_unregister_complex_config (const char *name)
999 cf_unregister_complex (name);
1001 } /* int plugin_unregister_complex_config */
1003 int plugin_unregister_init (const char *name)
1005 return (plugin_unregister (list_init, name));
1008 int plugin_unregister_read (const char *name) /* {{{ */
1016 pthread_mutex_lock (&read_lock);
1018 if (read_list == NULL)
1020 pthread_mutex_unlock (&read_lock);
1024 le = llist_search (read_list, name);
1027 pthread_mutex_unlock (&read_lock);
1028 WARNING ("plugin_unregister_read: No such read function: %s",
1033 llist_remove (read_list, le);
1036 assert (rf != NULL);
1037 rf->rf_type = RF_REMOVE;
1039 pthread_mutex_unlock (&read_lock);
1041 llentry_destroy (le);
1043 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1046 } /* }}} int plugin_unregister_read */
1048 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1050 read_func_t *rf = e->value;
1053 return strcmp (rf->rf_group, (const char *)group);
1054 } /* }}} int compare_read_func_group */
1056 int plugin_unregister_read_group (const char *group) /* {{{ */
1066 pthread_mutex_lock (&read_lock);
1068 if (read_list == NULL)
1070 pthread_mutex_unlock (&read_lock);
1076 le = llist_search_custom (read_list,
1077 compare_read_func_group, (void *)group);
1084 llist_remove (read_list, le);
1087 assert (rf != NULL);
1088 rf->rf_type = RF_REMOVE;
1090 llentry_destroy (le);
1092 DEBUG ("plugin_unregister_read_group: "
1093 "Marked `%s' (group `%s') for removal.",
1094 rf->rf_name, group);
1097 pthread_mutex_unlock (&read_lock);
1101 WARNING ("plugin_unregister_read_group: No such "
1102 "group of read function: %s", group);
1107 } /* }}} int plugin_unregister_read_group */
1109 int plugin_unregister_write (const char *name)
1111 return (plugin_unregister (list_write, name));
1114 int plugin_unregister_flush (const char *name)
1116 return (plugin_unregister (list_flush, name));
1119 int plugin_unregister_missing (const char *name)
1121 return (plugin_unregister (list_missing, name));
1124 int plugin_unregister_shutdown (const char *name)
1126 return (plugin_unregister (list_shutdown, name));
1129 int plugin_unregister_data_set (const char *name)
1133 if (data_sets == NULL)
1136 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1143 } /* int plugin_unregister_data_set */
1145 int plugin_unregister_log (const char *name)
1147 return (plugin_unregister (list_log, name));
1150 int plugin_unregister_notification (const char *name)
1152 return (plugin_unregister (list_notification, name));
1155 void plugin_init_all (void)
1157 const char *chain_name;
1161 /* Init the value cache */
1164 chain_name = global_option_get ("PreCacheChain");
1165 pre_cache_chain = fc_chain_get_by_name (chain_name);
1167 chain_name = global_option_get ("PostCacheChain");
1168 post_cache_chain = fc_chain_get_by_name (chain_name);
1171 if ((list_init == NULL) && (read_heap == NULL))
1174 /* Calling all init callbacks before checking if read callbacks
1175 * are available allows the init callbacks to register the read
1177 le = llist_head (list_init);
1180 callback_func_t *cf;
1181 plugin_init_cb callback;
1182 plugin_ctx_t old_ctx;
1185 old_ctx = plugin_set_ctx (cf->cf_ctx);
1186 callback = cf->cf_callback;
1187 status = (*callback) ();
1188 plugin_set_ctx (old_ctx);
1192 ERROR ("Initialization of plugin `%s' "
1193 "failed with status %i. "
1194 "Plugin will be unloaded.",
1196 /* Plugins that register read callbacks from the init
1197 * callback should take care of appropriate error
1198 * handling themselves. */
1199 /* FIXME: Unload _all_ functions */
1200 plugin_unregister_read (le->key);
1206 /* Start read-threads */
1207 if (read_heap != NULL)
1211 rt = global_option_get ("ReadThreads");
1214 start_read_threads ((num > 0) ? num : 5);
1216 } /* void plugin_init_all */
1218 /* TODO: Rename this function. */
1219 void plugin_read_all (void)
1221 uc_check_timeout ();
1224 } /* void plugin_read_all */
1226 /* Read function called when the `-T' command line argument is given. */
1227 int plugin_read_all_once (void)
1230 int return_status = 0;
1232 if (read_heap == NULL)
1234 NOTICE ("No read-functions are registered.");
1241 plugin_ctx_t old_ctx;
1243 rf = c_heap_get_root (read_heap);
1247 old_ctx = plugin_set_ctx (rf->rf_ctx);
1249 if (rf->rf_type == RF_SIMPLE)
1251 int (*callback) (void);
1253 callback = rf->rf_callback;
1254 status = (*callback) ();
1258 plugin_read_cb callback;
1260 callback = rf->rf_callback;
1261 status = (*callback) (&rf->rf_udata);
1264 plugin_set_ctx (old_ctx);
1268 NOTICE ("read-function of plugin `%s' failed.",
1273 destroy_callback ((void *) rf);
1276 return (return_status);
1277 } /* int plugin_read_all_once */
1279 int plugin_write (const char *plugin, /* {{{ */
1280 const data_set_t *ds, const value_list_t *vl)
1288 if (list_write == NULL)
1293 ds = plugin_get_ds (vl->type);
1296 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1306 le = llist_head (list_write);
1309 callback_func_t *cf = le->value;
1310 plugin_write_cb callback;
1312 /* do not switch plugin context; rather keep the context (interval)
1313 * information of the calling read plugin */
1315 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1316 callback = cf->cf_callback;
1317 status = (*callback) (ds, vl, &cf->cf_udata);
1326 if ((success == 0) && (failure != 0))
1331 else /* plugin != NULL */
1333 callback_func_t *cf;
1334 plugin_write_cb callback;
1336 le = llist_head (list_write);
1339 if (strcasecmp (plugin, le->key) == 0)
1350 /* do not switch plugin context; rather keep the context (interval)
1351 * information of the calling read plugin */
1353 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1354 callback = cf->cf_callback;
1355 status = (*callback) (ds, vl, &cf->cf_udata);
1359 } /* }}} int plugin_write */
1361 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1365 if (list_flush == NULL)
1368 le = llist_head (list_flush);
1371 callback_func_t *cf;
1372 plugin_flush_cb callback;
1373 plugin_ctx_t old_ctx;
1375 if ((plugin != NULL)
1376 && (strcmp (plugin, le->key) != 0))
1383 old_ctx = plugin_set_ctx (cf->cf_ctx);
1384 callback = cf->cf_callback;
1386 (*callback) (timeout, identifier, &cf->cf_udata);
1388 plugin_set_ctx (old_ctx);
1393 } /* int plugin_flush */
1395 void plugin_shutdown_all (void)
1399 stop_read_threads ();
1401 destroy_all_callbacks (&list_init);
1403 pthread_mutex_lock (&read_lock);
1404 llist_destroy (read_list);
1406 pthread_mutex_unlock (&read_lock);
1408 destroy_read_heap ();
1410 plugin_flush (/* plugin = */ NULL,
1412 /* identifier = */ NULL);
1415 if (list_shutdown != NULL)
1416 le = llist_head (list_shutdown);
1420 callback_func_t *cf;
1421 plugin_shutdown_cb callback;
1422 plugin_ctx_t old_ctx;
1425 old_ctx = plugin_set_ctx (cf->cf_ctx);
1426 callback = cf->cf_callback;
1428 /* Advance the pointer before calling the callback allows
1429 * shutdown functions to unregister themselves. If done the
1430 * other way around the memory `le' points to will be freed
1431 * after callback returns. */
1436 plugin_set_ctx (old_ctx);
1439 /* Write plugins which use the `user_data' pointer usually need the
1440 * same data available to the flush callback. If this is the case, set
1441 * the free_function to NULL when registering the flush callback and to
1442 * the real free function when registering the write callback. This way
1443 * the data isn't freed twice. */
1444 destroy_all_callbacks (&list_flush);
1445 destroy_all_callbacks (&list_missing);
1446 destroy_all_callbacks (&list_write);
1448 destroy_all_callbacks (&list_notification);
1449 destroy_all_callbacks (&list_shutdown);
1450 destroy_all_callbacks (&list_log);
1451 } /* void plugin_shutdown_all */
1453 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1457 if (list_missing == NULL)
1460 le = llist_head (list_missing);
1463 callback_func_t *cf;
1464 plugin_missing_cb callback;
1465 plugin_ctx_t old_ctx;
1469 old_ctx = plugin_set_ctx (cf->cf_ctx);
1470 callback = cf->cf_callback;
1472 status = (*callback) (vl, &cf->cf_udata);
1473 plugin_set_ctx (old_ctx);
1478 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1479 "failed with status %i.",
1492 } /* int }}} plugin_dispatch_missing */
1494 int plugin_dispatch_values (value_list_t *vl)
1497 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1499 value_t *saved_values;
1500 int saved_values_len;
1504 int free_meta_data = 0;
1506 if ((vl == NULL) || (vl->type[0] == 0)
1507 || (vl->values == NULL) || (vl->values_len < 1))
1509 ERROR ("plugin_dispatch_values: Invalid value list "
1510 "from plugin %s.", vl->plugin);
1514 /* Free meta data only if the calling function didn't specify any. In
1515 * this case matches and targets may add some and the calling function
1516 * may not expect (and therefore free) that data. */
1517 if (vl->meta == NULL)
1520 if (list_write == NULL)
1521 c_complain_once (LOG_WARNING, &no_write_complaint,
1522 "plugin_dispatch_values: No write callback has been "
1523 "registered. Please load at least one output plugin, "
1524 "if you want the collected data to be stored.");
1526 if (data_sets == NULL)
1528 ERROR ("plugin_dispatch_values: No data sets registered. "
1529 "Could the types database be read? Check "
1530 "your `TypesDB' setting!");
1534 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1536 char ident[6 * DATA_MAX_NAME_LEN];
1538 FORMAT_VL (ident, sizeof (ident), vl);
1539 INFO ("plugin_dispatch_values: Dataset not found: %s "
1540 "(from \"%s\"), check your types.db!",
1546 vl->time = cdtime ();
1548 if (vl->interval <= 0) {
1549 plugin_ctx_t ctx = plugin_get_ctx ();
1551 if (ctx.interval != 0)
1552 vl->interval = ctx.interval;
1554 vl->interval = interval_g;
1557 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1559 "plugin = %s; plugin_instance = %s; "
1560 "type = %s; type_instance = %s;",
1561 CDTIME_T_TO_DOUBLE (vl->time),
1562 CDTIME_T_TO_DOUBLE (vl->interval),
1564 vl->plugin, vl->plugin_instance,
1565 vl->type, vl->type_instance);
1568 assert (0 == strcmp (ds->type, vl->type));
1570 if (0 != strcmp (ds->type, vl->type))
1571 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1572 ds->type, vl->type);
1576 assert (ds->ds_num == vl->values_len);
1578 if (ds->ds_num != vl->values_len)
1580 ERROR ("plugin_dispatch_values: ds->type = %s: "
1581 "(ds->ds_num = %i) != "
1582 "(vl->values_len = %i)",
1583 ds->type, ds->ds_num, vl->values_len);
1588 escape_slashes (vl->host, sizeof (vl->host));
1589 escape_slashes (vl->plugin, sizeof (vl->plugin));
1590 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1591 escape_slashes (vl->type, sizeof (vl->type));
1592 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1594 /* Copy the values. This way, we can assure `targets' that they get
1595 * dynamically allocated values, which they can free and replace if
1597 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1599 saved_values = vl->values;
1600 saved_values_len = vl->values_len;
1602 vl->values = (value_t *) calloc (vl->values_len,
1603 sizeof (*vl->values));
1604 if (vl->values == NULL)
1606 ERROR ("plugin_dispatch_values: calloc failed.");
1607 vl->values = saved_values;
1610 memcpy (vl->values, saved_values,
1611 vl->values_len * sizeof (*vl->values));
1613 else /* if ((pre == NULL) && (post == NULL)) */
1615 saved_values = NULL;
1616 saved_values_len = 0;
1619 if (pre_cache_chain != NULL)
1621 status = fc_process_chain (ds, vl, pre_cache_chain);
1624 WARNING ("plugin_dispatch_values: Running the "
1625 "pre-cache chain failed with "
1629 else if (status == FC_TARGET_STOP)
1631 /* Restore the state of the value_list so that plugins
1632 * don't get confused.. */
1633 if (saved_values != NULL)
1636 vl->values = saved_values;
1637 vl->values_len = saved_values_len;
1643 /* Update the value cache */
1646 if (post_cache_chain != NULL)
1648 status = fc_process_chain (ds, vl, post_cache_chain);
1651 WARNING ("plugin_dispatch_values: Running the "
1652 "post-cache chain failed with "
1658 fc_default_action (ds, vl);
1660 /* Restore the state of the value_list so that plugins don't get
1662 if (saved_values != NULL)
1665 vl->values = saved_values;
1666 vl->values_len = saved_values_len;
1669 if ((free_meta_data != 0) && (vl->meta != NULL))
1671 meta_data_destroy (vl->meta);
1676 } /* int plugin_dispatch_values */
1678 int plugin_dispatch_values_secure (const value_list_t *vl)
1680 value_list_t vl_copy;
1686 memcpy (&vl_copy, vl, sizeof (vl_copy));
1688 /* Write callbacks must not change the values and meta pointers, so we can
1689 * savely skip copying those and make this more efficient. */
1690 if ((pre_cache_chain == NULL) && (post_cache_chain == NULL))
1691 return (plugin_dispatch_values (&vl_copy));
1693 /* Set pointers to NULL, just to be on the save side. */
1694 vl_copy.values = NULL;
1695 vl_copy.meta = NULL;
1697 vl_copy.values = malloc (sizeof (*vl_copy.values) * vl->values_len);
1698 if (vl_copy.values == NULL)
1700 ERROR ("plugin_dispatch_values_secure: malloc failed.");
1703 memcpy (vl_copy.values, vl->values, sizeof (*vl_copy.values) * vl->values_len);
1705 if (vl->meta != NULL)
1707 vl_copy.meta = meta_data_clone (vl->meta);
1708 if (vl_copy.meta == NULL)
1710 ERROR ("plugin_dispatch_values_secure: meta_data_clone failed.");
1711 free (vl_copy.values);
1714 } /* if (vl->meta) */
1716 status = plugin_dispatch_values (&vl_copy);
1718 meta_data_destroy (vl_copy.meta);
1719 free (vl_copy.values);
1722 } /* int plugin_dispatch_values_secure */
1724 int plugin_dispatch_notification (const notification_t *notif)
1727 /* Possible TODO: Add flap detection here */
1729 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1730 "time = %.3f; host = %s;",
1731 notif->severity, notif->message,
1732 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1734 /* Nobody cares for notifications */
1735 if (list_notification == NULL)
1738 le = llist_head (list_notification);
1741 callback_func_t *cf;
1742 plugin_notification_cb callback;
1745 /* do not switch plugin context; rather keep the context
1746 * (interval) information of the calling plugin */
1749 callback = cf->cf_callback;
1750 status = (*callback) (notif, &cf->cf_udata);
1753 WARNING ("plugin_dispatch_notification: Notification "
1754 "callback %s returned %i.",
1762 } /* int plugin_dispatch_notification */
1764 void plugin_log (int level, const char *format, ...)
1771 if (level >= LOG_DEBUG)
1775 va_start (ap, format);
1776 vsnprintf (msg, sizeof (msg), format, ap);
1777 msg[sizeof (msg) - 1] = '\0';
1780 if (list_log == NULL)
1782 fprintf (stderr, "%s\n", msg);
1786 le = llist_head (list_log);
1789 callback_func_t *cf;
1790 plugin_log_cb callback;
1793 callback = cf->cf_callback;
1795 /* do not switch plugin context; rather keep the context
1796 * (interval) information of the calling plugin */
1798 (*callback) (level, msg, &cf->cf_udata);
1802 } /* void plugin_log */
1804 const data_set_t *plugin_get_ds (const char *name)
1808 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1810 DEBUG ("No such dataset registered: %s", name);
1815 } /* data_set_t *plugin_get_ds */
1817 static int plugin_notification_meta_add (notification_t *n,
1819 enum notification_meta_type_e type,
1822 notification_meta_t *meta;
1823 notification_meta_t *tail;
1825 if ((n == NULL) || (name == NULL) || (value == NULL))
1827 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1831 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1834 ERROR ("plugin_notification_meta_add: malloc failed.");
1837 memset (meta, 0, sizeof (notification_meta_t));
1839 sstrncpy (meta->name, name, sizeof (meta->name));
1844 case NM_TYPE_STRING:
1846 meta->nm_value.nm_string = strdup ((const char *) value);
1847 if (meta->nm_value.nm_string == NULL)
1849 ERROR ("plugin_notification_meta_add: strdup failed.");
1855 case NM_TYPE_SIGNED_INT:
1857 meta->nm_value.nm_signed_int = *((int64_t *) value);
1860 case NM_TYPE_UNSIGNED_INT:
1862 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1865 case NM_TYPE_DOUBLE:
1867 meta->nm_value.nm_double = *((double *) value);
1870 case NM_TYPE_BOOLEAN:
1872 meta->nm_value.nm_boolean = *((_Bool *) value);
1877 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1881 } /* switch (type) */
1885 while ((tail != NULL) && (tail->next != NULL))
1894 } /* int plugin_notification_meta_add */
1896 int plugin_notification_meta_add_string (notification_t *n,
1900 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1903 int plugin_notification_meta_add_signed_int (notification_t *n,
1907 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1910 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1914 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1917 int plugin_notification_meta_add_double (notification_t *n,
1921 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1924 int plugin_notification_meta_add_boolean (notification_t *n,
1928 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1931 int plugin_notification_meta_copy (notification_t *dst,
1932 const notification_t *src)
1934 notification_meta_t *meta;
1936 assert (dst != NULL);
1937 assert (src != NULL);
1938 assert (dst != src);
1939 assert ((src->meta == NULL) || (src->meta != dst->meta));
1941 for (meta = src->meta; meta != NULL; meta = meta->next)
1943 if (meta->type == NM_TYPE_STRING)
1944 plugin_notification_meta_add_string (dst, meta->name,
1945 meta->nm_value.nm_string);
1946 else if (meta->type == NM_TYPE_SIGNED_INT)
1947 plugin_notification_meta_add_signed_int (dst, meta->name,
1948 meta->nm_value.nm_signed_int);
1949 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1950 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1951 meta->nm_value.nm_unsigned_int);
1952 else if (meta->type == NM_TYPE_DOUBLE)
1953 plugin_notification_meta_add_double (dst, meta->name,
1954 meta->nm_value.nm_double);
1955 else if (meta->type == NM_TYPE_BOOLEAN)
1956 plugin_notification_meta_add_boolean (dst, meta->name,
1957 meta->nm_value.nm_boolean);
1961 } /* int plugin_notification_meta_copy */
1963 int plugin_notification_meta_free (notification_meta_t *n)
1965 notification_meta_t *this;
1966 notification_meta_t *next;
1970 ERROR ("plugin_notification_meta_free: n == NULL!");
1975 while (this != NULL)
1979 if (this->type == NM_TYPE_STRING)
1981 free ((char *)this->nm_value.nm_string);
1982 this->nm_value.nm_string = NULL;
1990 } /* int plugin_notification_meta_free */
1992 static void plugin_ctx_destructor (void *ctx)
1995 } /* void plugin_ctx_destructor */
1997 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
1999 static plugin_ctx_t *plugin_ctx_create (void)
2003 ctx = malloc (sizeof (*ctx));
2006 ERROR ("Failed to allocate plugin context: %s",
2007 sstrerror (errno, errbuf, sizeof (errbuf)));
2012 assert (plugin_ctx_key_initialized);
2013 pthread_setspecific (plugin_ctx_key, ctx);
2014 DEBUG("Created new plugin context.");
2016 } /* int plugin_ctx_create */
2018 void plugin_init_ctx (void)
2020 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2021 plugin_ctx_key_initialized = 1;
2022 } /* void plugin_init_ctx */
2024 plugin_ctx_t plugin_get_ctx (void)
2028 assert (plugin_ctx_key_initialized);
2029 ctx = pthread_getspecific (plugin_ctx_key);
2032 ctx = plugin_ctx_create ();
2033 /* this must no happen -- exit() instead? */
2039 } /* plugin_ctx_t plugin_get_ctx */
2041 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2046 assert (plugin_ctx_key_initialized);
2047 c = pthread_getspecific (plugin_ctx_key);
2050 c = plugin_ctx_create ();
2051 /* this must no happen -- exit() instead? */
2060 } /* void plugin_set_ctx */
2062 cdtime_t plugin_get_interval (void)
2066 const char *interval_str;
2067 double interval_dbl;
2069 interval = plugin_get_ctx().interval;
2073 /* this should happen during initialization only */
2074 interval_str = global_option_get ("Interval");
2075 if (interval_str != NULL)
2077 interval_dbl = atof (interval_str);
2078 if (interval_dbl > 0.0)
2079 interval = DOUBLE_TO_CDTIME_T (interval_dbl);
2084 return TIME_T_TO_CDTIME_T (10);
2085 } /* cdtime_t plugin_get_interval */
2089 void *(*start_routine) (void *);
2093 static void *plugin_thread_start (void *arg)
2095 plugin_thread_t *plugin_thread = arg;
2097 void *(*start_routine) (void *) = plugin_thread->start_routine;
2098 void *plugin_arg = plugin_thread->arg;
2100 plugin_set_ctx (plugin_thread->ctx);
2102 free (plugin_thread);
2104 return start_routine (plugin_arg);
2105 } /* void *plugin_thread_start */
2107 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2108 void *(*start_routine) (void *), void *arg)
2110 plugin_thread_t *plugin_thread;
2112 plugin_thread = malloc (sizeof (*plugin_thread));
2113 if (plugin_thread == NULL)
2116 plugin_thread->ctx = plugin_get_ctx ();
2117 plugin_thread->start_routine = start_routine;
2118 plugin_thread->arg = arg;
2120 return pthread_create (thread, attr,
2121 plugin_thread_start, plugin_thread);
2122 } /* int plugin_thread_create */
2124 /* vim: set sw=8 ts=8 noet fdm=marker : */