2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2009 Florian octo Forster
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Florian octo Forster <octo at verplant.org>
20 * Sebastian Harl <sh at tokkee.org>
24 #include "utils_complain.h"
34 #include "configfile.h"
35 #include "utils_avltree.h"
36 #include "utils_llist.h"
37 #include "utils_heap.h"
38 #include "utils_cache.h"
39 #include "utils_threshold.h"
40 #include "filter_chain.h"
45 struct callback_func_s
50 typedef struct callback_func_s callback_func_t;
54 #define RF_REMOVE 65535
57 /* `read_func_t' "inherits" from `callback_func_t'.
58 * The `rf_super' member MUST be the first one in this structure! */
59 #define rf_callback rf_super.cf_callback
60 #define rf_udata rf_super.cf_udata
61 callback_func_t rf_super;
62 char rf_group[DATA_MAX_NAME_LEN];
63 char rf_name[DATA_MAX_NAME_LEN];
65 struct timespec rf_interval;
66 struct timespec rf_effective_interval;
67 struct timespec rf_next_read;
69 typedef struct read_func_s read_func_t;
74 static llist_t *list_init;
75 static llist_t *list_write;
76 static llist_t *list_flush;
77 static llist_t *list_shutdown;
78 static llist_t *list_log;
79 static llist_t *list_notification;
81 static fc_chain_t *pre_cache_chain = NULL;
82 static fc_chain_t *post_cache_chain = NULL;
84 static c_avl_tree_t *data_sets;
86 static char *plugindir = NULL;
88 static c_heap_t *read_heap = NULL;
89 static llist_t *read_list;
90 static int read_loop = 1;
91 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
92 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
93 static pthread_t *read_threads = NULL;
94 static int read_threads_num = 0;
99 static const char *plugin_get_dir (void)
101 if (plugindir == NULL)
107 static void destroy_callback (callback_func_t *cf) /* {{{ */
112 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
114 cf->cf_udata.free_func (cf->cf_udata.data);
115 cf->cf_udata.data = NULL;
116 cf->cf_udata.free_func = NULL;
119 } /* }}} void destroy_callback */
121 static void destroy_all_callbacks (llist_t **list) /* {{{ */
128 le = llist_head (*list);
136 destroy_callback (le->value);
142 llist_destroy (*list);
144 } /* }}} void destroy_all_callbacks */
146 static void destroy_read_heap (void) /* {{{ */
148 if (read_heap == NULL)
155 cf = c_heap_get_root (read_heap);
159 destroy_callback (cf);
162 c_heap_destroy (read_heap);
164 } /* }}} void destroy_read_heap */
166 static int register_callback (llist_t **list, /* {{{ */
167 const char *name, callback_func_t *cf)
174 *list = llist_create ();
177 ERROR ("plugin: register_callback: "
178 "llist_create failed.");
179 destroy_callback (cf);
187 ERROR ("plugin: register_callback: strdup failed.");
188 destroy_callback (cf);
192 le = llist_search (*list, name);
195 le = llentry_create (key, cf);
198 ERROR ("plugin: register_callback: "
199 "llentry_create failed.");
201 destroy_callback (cf);
205 llist_append (*list, le);
209 callback_func_t *old_cf;
214 WARNING ("plugin: register_callback: "
215 "a callback named `%s' already exists - "
216 "overwriting the old entry!", name);
218 destroy_callback (old_cf);
223 } /* }}} int register_callback */
225 static int create_register_callback (llist_t **list, /* {{{ */
226 const char *name, void *callback, user_data_t *ud)
230 cf = (callback_func_t *) malloc (sizeof (*cf));
233 ERROR ("plugin: create_register_callback: malloc failed.");
236 memset (cf, 0, sizeof (*cf));
238 cf->cf_callback = callback;
241 cf->cf_udata.data = NULL;
242 cf->cf_udata.free_func = NULL;
249 return (register_callback (list, name, cf));
250 } /* }}} int create_register_callback */
252 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
259 e = llist_search (list, name);
263 llist_remove (list, e);
266 destroy_callback (e->value);
271 } /* }}} int plugin_unregister */
274 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
275 * object, but it will bitch about a shared object not having a
276 * ``module_register'' symbol..
278 static int plugin_load_file (char *file, uint32_t flags)
281 void (*reg_handle) (void);
283 DEBUG ("file = %s", file);
286 lt_dlerror (); /* clear errors */
288 #if LIBTOOL_VERSION == 2
289 if (flags & PLUGIN_FLAGS_GLOBAL) {
291 lt_dladvise_init(&advise);
292 lt_dladvise_global(&advise);
293 dlh = lt_dlopenadvise(file, advise);
294 lt_dladvise_destroy(&advise);
296 dlh = lt_dlopen (file);
298 #else /* if LIBTOOL_VERSION == 1 */
299 if (flags & PLUGIN_FLAGS_GLOBAL)
300 ERROR ("plugin_load_file: The global flag is not supported, "
301 "libtool 2 is required for this.");
302 dlh = lt_dlopen (file);
307 const char *error = lt_dlerror ();
309 ERROR ("lt_dlopen (%s) failed: %s", file, error);
310 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
314 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
316 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
317 file, lt_dlerror ());
327 static _Bool timeout_reached(struct timespec timeout)
330 gettimeofday(&now, NULL);
331 return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
334 static void *plugin_read_thread (void __attribute__((unused)) *args)
336 while (read_loop != 0)
344 /* Get the read function that needs to be read next. */
345 rf = c_heap_get_root (read_heap);
348 struct timespec abstime;
350 gettimeofday (&now, /* timezone = */ NULL);
352 abstime.tv_sec = now.tv_sec + interval_g;
353 abstime.tv_nsec = 1000 * now.tv_usec;
355 pthread_mutex_lock (&read_lock);
356 pthread_cond_timedwait (&read_cond, &read_lock,
358 pthread_mutex_unlock (&read_lock);
362 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
364 gettimeofday (&now, /* timezone = */ NULL);
366 rf->rf_interval.tv_sec = interval_g;
367 rf->rf_interval.tv_nsec = 0;
369 rf->rf_effective_interval = rf->rf_interval;
371 rf->rf_next_read.tv_sec = now.tv_sec;
372 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
375 /* sleep until this entry is due,
376 * using pthread_cond_timedwait */
377 pthread_mutex_lock (&read_lock);
378 /* In pthread_cond_timedwait, spurious wakeups are possible
379 * (and really happen, at least on NetBSD with > 1 CPU), thus
380 * we need to re-evaluate the condition every time
381 * pthread_cond_timedwait returns. */
383 while ((read_loop != 0)
384 && !timeout_reached(rf->rf_next_read)
387 rc = pthread_cond_timedwait (&read_cond, &read_lock,
391 /* Must hold `read_lock' when accessing `rf->rf_type'. */
392 rf_type = rf->rf_type;
393 pthread_mutex_unlock (&read_lock);
395 /* Check if we're supposed to stop.. This may have interrupted
399 /* Insert `rf' again, so it can be free'd correctly */
400 c_heap_insert (read_heap, rf);
404 /* The entry has been marked for deletion. The linked list
405 * entry has already been removed by `plugin_unregister_read'.
406 * All we have to do here is free the `read_func_t' and
408 if (rf_type == RF_REMOVE)
410 DEBUG ("plugin_read_thread: Destroying the `%s' "
411 "callback.", rf->rf_name);
412 destroy_callback ((callback_func_t *) rf);
417 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
419 if (rf_type == RF_SIMPLE)
421 int (*callback) (void);
423 callback = rf->rf_callback;
424 status = (*callback) ();
428 plugin_read_cb callback;
430 assert (rf_type == RF_COMPLEX);
432 callback = rf->rf_callback;
433 status = (*callback) (&rf->rf_udata);
436 /* If the function signals failure, we will increase the
437 * intervals in which it will be called. */
440 rf->rf_effective_interval.tv_sec *= 2;
441 rf->rf_effective_interval.tv_nsec *= 2;
442 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
444 if (rf->rf_effective_interval.tv_sec >= 86400)
446 rf->rf_effective_interval.tv_sec = 86400;
447 rf->rf_effective_interval.tv_nsec = 0;
450 NOTICE ("read-function of plugin `%s' failed. "
451 "Will suspend it for %i seconds.",
453 (int) rf->rf_effective_interval.tv_sec);
457 /* Success: Restore the interval, if it was changed. */
458 rf->rf_effective_interval = rf->rf_interval;
461 /* update the ``next read due'' field */
462 gettimeofday (&now, /* timezone = */ NULL);
464 DEBUG ("plugin_read_thread: Effective interval of the "
465 "%s plugin is %i.%09i.",
467 (int) rf->rf_effective_interval.tv_sec,
468 (int) rf->rf_effective_interval.tv_nsec);
470 /* Calculate the next (absolute) time at which this function
471 * should be called. */
472 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
473 + rf->rf_effective_interval.tv_sec;
474 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
475 + rf->rf_effective_interval.tv_nsec;
476 NORMALIZE_TIMESPEC (rf->rf_next_read);
478 /* Check, if `rf_next_read' is in the past. */
479 if ((rf->rf_next_read.tv_sec < now.tv_sec)
480 || ((rf->rf_next_read.tv_sec == now.tv_sec)
481 && (rf->rf_next_read.tv_nsec < (1000 * now.tv_usec))))
483 /* `rf_next_read' is in the past. Insert `now'
484 * so this value doesn't trail off into the
486 rf->rf_next_read.tv_sec = now.tv_sec;
487 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
490 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
492 (int) rf->rf_next_read.tv_sec,
493 (int) rf->rf_next_read.tv_nsec);
495 /* Re-insert this read function into the heap again. */
496 c_heap_insert (read_heap, rf);
497 } /* while (read_loop) */
501 } /* void *plugin_read_thread */
503 static void start_read_threads (int num)
507 if (read_threads != NULL)
510 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
511 if (read_threads == NULL)
513 ERROR ("plugin: start_read_threads: calloc failed.");
517 read_threads_num = 0;
518 for (i = 0; i < num; i++)
520 if (pthread_create (read_threads + read_threads_num, NULL,
521 plugin_read_thread, NULL) == 0)
527 ERROR ("plugin: start_read_threads: pthread_create failed.");
531 } /* void start_read_threads */
533 static void stop_read_threads (void)
537 if (read_threads == NULL)
540 INFO ("collectd: Stopping %i read threads.", read_threads_num);
542 pthread_mutex_lock (&read_lock);
544 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
545 pthread_cond_broadcast (&read_cond);
546 pthread_mutex_unlock (&read_lock);
548 for (i = 0; i < read_threads_num; i++)
550 if (pthread_join (read_threads[i], NULL) != 0)
552 ERROR ("plugin: stop_read_threads: pthread_join failed.");
554 read_threads[i] = (pthread_t) 0;
556 sfree (read_threads);
557 read_threads_num = 0;
558 } /* void stop_read_threads */
563 void plugin_set_dir (const char *dir)
565 if (plugindir != NULL)
570 else if ((plugindir = strdup (dir)) == NULL)
573 ERROR ("strdup failed: %s",
574 sstrerror (errno, errbuf, sizeof (errbuf)));
579 int plugin_load (const char *type, uint32_t flags)
583 char filename[BUFSIZE] = "";
584 char typename[BUFSIZE];
591 DEBUG ("type = %s", type);
593 dir = plugin_get_dir ();
596 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
597 * type when matching the filename */
598 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
599 if ((status < 0) || ((size_t) status >= sizeof (typename)))
601 WARNING ("snprintf: truncated: `%s.so'", type);
604 typename_len = strlen (typename);
606 if ((dh = opendir (dir)) == NULL)
609 ERROR ("opendir (%s): %s", dir,
610 sstrerror (errno, errbuf, sizeof (errbuf)));
614 while ((de = readdir (dh)) != NULL)
616 if (strncasecmp (de->d_name, typename, typename_len))
619 status = ssnprintf (filename, sizeof (filename),
620 "%s/%s", dir, de->d_name);
621 if ((status < 0) || ((size_t) status >= sizeof (filename)))
623 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
627 if (lstat (filename, &statbuf) == -1)
630 WARNING ("stat %s: %s", filename,
631 sstrerror (errno, errbuf, sizeof (errbuf)));
634 else if (!S_ISREG (statbuf.st_mode))
636 /* don't follow symlinks */
637 WARNING ("stat %s: not a regular file", filename);
641 if (plugin_load_file (filename, flags) == 0)
649 fprintf (stderr, "Unable to load plugin %s.\n", type);
655 if (filename[0] == '\0')
656 fprintf (stderr, "Could not find plugin %s.\n", type);
662 * The `register_*' functions follow
664 int plugin_register_config (const char *name,
665 int (*callback) (const char *key, const char *val),
666 const char **keys, int keys_num)
668 cf_register (name, callback, keys, keys_num);
670 } /* int plugin_register_config */
672 int plugin_register_complex_config (const char *type,
673 int (*callback) (oconfig_item_t *))
675 return (cf_register_complex (type, callback));
676 } /* int plugin_register_complex_config */
678 int plugin_register_init (const char *name,
679 int (*callback) (void))
681 return (create_register_callback (&list_init, name, (void *) callback,
682 /* user_data = */ NULL));
683 } /* plugin_register_init */
685 static int plugin_compare_read_func (const void *arg0, const void *arg1)
687 const read_func_t *rf0;
688 const read_func_t *rf1;
693 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
695 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
697 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
699 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
703 } /* int plugin_compare_read_func */
705 /* Add a read function to both, the heap and a linked list. The linked list if
706 * used to look-up read functions, especially for the remove function. The heap
707 * is used to determine which plugin to read next. */
708 static int plugin_insert_read (read_func_t *rf)
713 pthread_mutex_lock (&read_lock);
715 if (read_list == NULL)
717 read_list = llist_create ();
718 if (read_list == NULL)
720 pthread_mutex_unlock (&read_lock);
721 ERROR ("plugin_insert_read: read_list failed.");
726 if (read_heap == NULL)
728 read_heap = c_heap_create (plugin_compare_read_func);
729 if (read_heap == NULL)
731 pthread_mutex_unlock (&read_lock);
732 ERROR ("plugin_insert_read: c_heap_create failed.");
737 le = llentry_create (rf->rf_name, rf);
740 pthread_mutex_unlock (&read_lock);
741 ERROR ("plugin_insert_read: llentry_create failed.");
745 status = c_heap_insert (read_heap, rf);
748 pthread_mutex_unlock (&read_lock);
749 ERROR ("plugin_insert_read: c_heap_insert failed.");
750 llentry_destroy (le);
754 /* This does not fail. */
755 llist_append (read_list, le);
757 pthread_mutex_unlock (&read_lock);
759 } /* int plugin_insert_read */
761 int plugin_register_read (const char *name,
762 int (*callback) (void))
766 rf = (read_func_t *) malloc (sizeof (read_func_t));
770 ERROR ("plugin_register_read: malloc failed: %s",
771 sstrerror (errno, errbuf, sizeof (errbuf)));
775 memset (rf, 0, sizeof (read_func_t));
776 rf->rf_callback = (void *) callback;
777 rf->rf_udata.data = NULL;
778 rf->rf_udata.free_func = NULL;
779 rf->rf_group[0] = '\0';
780 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
781 rf->rf_type = RF_SIMPLE;
782 rf->rf_interval.tv_sec = 0;
783 rf->rf_interval.tv_nsec = 0;
784 rf->rf_effective_interval = rf->rf_interval;
786 return (plugin_insert_read (rf));
787 } /* int plugin_register_read */
789 int plugin_register_complex_read (const char *group, const char *name,
790 plugin_read_cb callback,
791 const struct timespec *interval,
792 user_data_t *user_data)
796 rf = (read_func_t *) malloc (sizeof (read_func_t));
799 ERROR ("plugin_register_complex_read: malloc failed.");
803 memset (rf, 0, sizeof (read_func_t));
804 rf->rf_callback = (void *) callback;
806 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
808 rf->rf_group[0] = '\0';
809 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
810 rf->rf_type = RF_COMPLEX;
811 if (interval != NULL)
813 rf->rf_interval = *interval;
815 rf->rf_effective_interval = rf->rf_interval;
818 if (user_data == NULL)
820 rf->rf_udata.data = NULL;
821 rf->rf_udata.free_func = NULL;
825 rf->rf_udata = *user_data;
828 return (plugin_insert_read (rf));
829 } /* int plugin_register_complex_read */
831 int plugin_register_write (const char *name,
832 plugin_write_cb callback, user_data_t *ud)
834 return (create_register_callback (&list_write, name,
835 (void *) callback, ud));
836 } /* int plugin_register_write */
838 int plugin_register_flush (const char *name,
839 plugin_flush_cb callback, user_data_t *ud)
841 return (create_register_callback (&list_flush, name,
842 (void *) callback, ud));
843 } /* int plugin_register_flush */
845 int plugin_register_shutdown (char *name,
846 int (*callback) (void))
848 return (create_register_callback (&list_shutdown, name,
849 (void *) callback, /* user_data = */ NULL));
850 } /* int plugin_register_shutdown */
852 int plugin_register_data_set (const data_set_t *ds)
857 if ((data_sets != NULL)
858 && (c_avl_get (data_sets, ds->type, NULL) == 0))
860 NOTICE ("Replacing DS `%s' with another version.", ds->type);
861 plugin_unregister_data_set (ds->type);
863 else if (data_sets == NULL)
865 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
866 if (data_sets == NULL)
870 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
873 memcpy(ds_copy, ds, sizeof (data_set_t));
875 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
877 if (ds_copy->ds == NULL)
883 for (i = 0; i < ds->ds_num; i++)
884 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
886 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
887 } /* int plugin_register_data_set */
889 int plugin_register_log (const char *name,
890 plugin_log_cb callback, user_data_t *ud)
892 return (create_register_callback (&list_log, name,
893 (void *) callback, ud));
894 } /* int plugin_register_log */
896 int plugin_register_notification (const char *name,
897 plugin_notification_cb callback, user_data_t *ud)
899 return (create_register_callback (&list_notification, name,
900 (void *) callback, ud));
901 } /* int plugin_register_log */
903 int plugin_unregister_config (const char *name)
905 cf_unregister (name);
907 } /* int plugin_unregister_config */
909 int plugin_unregister_complex_config (const char *name)
911 cf_unregister_complex (name);
913 } /* int plugin_unregister_complex_config */
915 int plugin_unregister_init (const char *name)
917 return (plugin_unregister (list_init, name));
920 int plugin_unregister_read (const char *name) /* {{{ */
928 pthread_mutex_lock (&read_lock);
930 if (read_list == NULL)
932 pthread_mutex_unlock (&read_lock);
936 le = llist_search (read_list, name);
939 pthread_mutex_unlock (&read_lock);
940 WARNING ("plugin_unregister_read: No such read function: %s",
945 llist_remove (read_list, le);
949 rf->rf_type = RF_REMOVE;
951 pthread_mutex_unlock (&read_lock);
953 llentry_destroy (le);
955 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
958 } /* }}} int plugin_unregister_read */
960 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
962 read_func_t *rf = e->value;
965 return strcmp (rf->rf_group, (const char *)group);
966 } /* }}} int compare_read_func_group */
968 int plugin_unregister_read_group (const char *group) /* {{{ */
978 pthread_mutex_lock (&read_lock);
980 if (read_list == NULL)
982 pthread_mutex_unlock (&read_lock);
988 le = llist_search_custom (read_list,
989 compare_read_func_group, (void *)group);
996 llist_remove (read_list, le);
1000 rf->rf_type = RF_REMOVE;
1002 llentry_destroy (le);
1004 DEBUG ("plugin_unregister_read_group: "
1005 "Marked `%s' (group `%s') for removal.",
1006 rf->rf_name, group);
1009 pthread_mutex_unlock (&read_lock);
1013 WARNING ("plugin_unregister_read_group: No such "
1014 "group of read function: %s", group);
1019 } /* }}} int plugin_unregister_read_group */
1021 int plugin_unregister_write (const char *name)
1023 return (plugin_unregister (list_write, name));
1026 int plugin_unregister_flush (const char *name)
1028 return (plugin_unregister (list_flush, name));
1031 int plugin_unregister_shutdown (const char *name)
1033 return (plugin_unregister (list_shutdown, name));
1036 int plugin_unregister_data_set (const char *name)
1040 if (data_sets == NULL)
1043 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1050 } /* int plugin_unregister_data_set */
1052 int plugin_unregister_log (const char *name)
1054 return (plugin_unregister (list_log, name));
1057 int plugin_unregister_notification (const char *name)
1059 return (plugin_unregister (list_notification, name));
1062 void plugin_init_all (void)
1064 const char *chain_name;
1068 /* Init the value cache */
1071 chain_name = global_option_get ("PreCacheChain");
1072 pre_cache_chain = fc_chain_get_by_name (chain_name);
1074 chain_name = global_option_get ("PostCacheChain");
1075 post_cache_chain = fc_chain_get_by_name (chain_name);
1078 if ((list_init == NULL) && (read_heap == NULL))
1081 /* Calling all init callbacks before checking if read callbacks
1082 * are available allows the init callbacks to register the read
1084 le = llist_head (list_init);
1087 callback_func_t *cf;
1088 plugin_init_cb callback;
1091 callback = cf->cf_callback;
1092 status = (*callback) ();
1096 ERROR ("Initialization of plugin `%s' "
1097 "failed with status %i. "
1098 "Plugin will be unloaded.",
1100 /* Plugins that register read callbacks from the init
1101 * callback should take care of appropriate error
1102 * handling themselves. */
1103 /* FIXME: Unload _all_ functions */
1104 plugin_unregister_read (le->key);
1110 /* Start read-threads */
1111 if (read_heap != NULL)
1115 rt = global_option_get ("ReadThreads");
1118 start_read_threads ((num > 0) ? num : 5);
1120 } /* void plugin_init_all */
1122 /* TODO: Rename this function. */
1123 void plugin_read_all (void)
1125 uc_check_timeout ();
1128 } /* void plugin_read_all */
1130 /* Read function called when the `-T' command line argument is given. */
1131 int plugin_read_all_once (void)
1134 int return_status = 0;
1136 if (read_heap == NULL)
1138 NOTICE ("No read-functions are registered.");
1146 rf = c_heap_get_root (read_heap);
1150 if (rf->rf_type == RF_SIMPLE)
1152 int (*callback) (void);
1154 callback = rf->rf_callback;
1155 status = (*callback) ();
1159 plugin_read_cb callback;
1161 callback = rf->rf_callback;
1162 status = (*callback) (&rf->rf_udata);
1167 NOTICE ("read-function of plugin `%s' failed.",
1172 destroy_callback ((void *) rf);
1175 return (return_status);
1176 } /* int plugin_read_all_once */
1178 int plugin_write (const char *plugin, /* {{{ */
1179 const data_set_t *ds, const value_list_t *vl)
1187 if (list_write == NULL)
1192 ds = plugin_get_ds (vl->type);
1195 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1205 le = llist_head (list_write);
1208 callback_func_t *cf = le->value;
1209 plugin_write_cb callback;
1211 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1212 callback = cf->cf_callback;
1213 status = (*callback) (ds, vl, &cf->cf_udata);
1222 if ((success == 0) && (failure != 0))
1227 else /* plugin != NULL */
1229 callback_func_t *cf;
1230 plugin_write_cb callback;
1232 le = llist_head (list_write);
1235 if (strcasecmp (plugin, le->key) == 0)
1246 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1247 callback = cf->cf_callback;
1248 status = (*callback) (ds, vl, &cf->cf_udata);
1252 } /* }}} int plugin_write */
1254 int plugin_flush (const char *plugin, int timeout, const char *identifier)
1258 if (list_flush == NULL)
1261 le = llist_head (list_flush);
1264 callback_func_t *cf;
1265 plugin_flush_cb callback;
1267 if ((plugin != NULL)
1268 && (strcmp (plugin, le->key) != 0))
1275 callback = cf->cf_callback;
1277 (*callback) (timeout, identifier, &cf->cf_udata);
1282 } /* int plugin_flush */
1284 void plugin_shutdown_all (void)
1288 stop_read_threads ();
1290 destroy_all_callbacks (&list_init);
1292 pthread_mutex_lock (&read_lock);
1293 llist_destroy (read_list);
1295 pthread_mutex_unlock (&read_lock);
1297 destroy_read_heap ();
1299 plugin_flush (/* plugin = */ NULL, /* timeout = */ -1,
1300 /* identifier = */ NULL);
1303 if (list_shutdown != NULL)
1304 le = llist_head (list_shutdown);
1308 callback_func_t *cf;
1309 plugin_shutdown_cb callback;
1312 callback = cf->cf_callback;
1314 /* Advance the pointer before calling the callback allows
1315 * shutdown functions to unregister themselves. If done the
1316 * other way around the memory `le' points to will be freed
1317 * after callback returns. */
1323 /* Write plugins which use the `user_data' pointer usually need the
1324 * same data available to the flush callback. If this is the case, set
1325 * the free_function to NULL when registering the flush callback and to
1326 * the real free function when registering the write callback. This way
1327 * the data isn't freed twice. */
1328 destroy_all_callbacks (&list_flush);
1329 destroy_all_callbacks (&list_write);
1331 destroy_all_callbacks (&list_notification);
1332 destroy_all_callbacks (&list_shutdown);
1333 destroy_all_callbacks (&list_log);
1334 } /* void plugin_shutdown_all */
1336 int plugin_dispatch_values (value_list_t *vl)
1339 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1341 value_t *saved_values;
1342 int saved_values_len;
1346 int free_meta_data = 0;
1348 if ((vl == NULL) || (vl->type[0] == 0)
1349 || (vl->values == NULL) || (vl->values_len < 1))
1351 ERROR ("plugin_dispatch_values: Invalid value list.");
1355 /* Free meta data only if the calling function didn't specify any. In
1356 * this case matches and targets may add some and the calling function
1357 * may not expect (and therefore free) that data. */
1358 if (vl->meta == NULL)
1361 if (list_write == NULL)
1362 c_complain_once (LOG_WARNING, &no_write_complaint,
1363 "plugin_dispatch_values: No write callback has been "
1364 "registered. Please load at least one output plugin, "
1365 "if you want the collected data to be stored.");
1367 if (data_sets == NULL)
1369 ERROR ("plugin_dispatch_values: No data sets registered. "
1370 "Could the types database be read? Check "
1371 "your `TypesDB' setting!");
1375 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1377 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
1382 vl->time = time (NULL);
1384 if (vl->interval <= 0)
1385 vl->interval = interval_g;
1387 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
1389 "plugin = %s; plugin_instance = %s; "
1390 "type = %s; type_instance = %s;",
1391 (unsigned int) vl->time, vl->interval,
1393 vl->plugin, vl->plugin_instance,
1394 vl->type, vl->type_instance);
1397 assert (0 == strcmp (ds->type, vl->type));
1399 if (0 != strcmp (ds->type, vl->type))
1400 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1401 ds->type, vl->type);
1405 assert (ds->ds_num == vl->values_len);
1407 if (ds->ds_num != vl->values_len)
1409 ERROR ("plugin_dispatch_values: ds->type = %s: "
1410 "(ds->ds_num = %i) != "
1411 "(vl->values_len = %i)",
1412 ds->type, ds->ds_num, vl->values_len);
1417 escape_slashes (vl->host, sizeof (vl->host));
1418 escape_slashes (vl->plugin, sizeof (vl->plugin));
1419 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1420 escape_slashes (vl->type, sizeof (vl->type));
1421 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1423 /* Copy the values. This way, we can assure `targets' that they get
1424 * dynamically allocated values, which they can free and replace if
1426 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1428 saved_values = vl->values;
1429 saved_values_len = vl->values_len;
1431 vl->values = (value_t *) calloc (vl->values_len,
1432 sizeof (*vl->values));
1433 if (vl->values == NULL)
1435 ERROR ("plugin_dispatch_values: calloc failed.");
1436 vl->values = saved_values;
1439 memcpy (vl->values, saved_values,
1440 vl->values_len * sizeof (*vl->values));
1442 else /* if ((pre == NULL) && (post == NULL)) */
1444 saved_values = NULL;
1445 saved_values_len = 0;
1448 if (pre_cache_chain != NULL)
1450 status = fc_process_chain (ds, vl, pre_cache_chain);
1453 WARNING ("plugin_dispatch_values: Running the "
1454 "pre-cache chain failed with "
1458 else if (status == FC_TARGET_STOP)
1460 /* Restore the state of the value_list so that plugins
1461 * don't get confused.. */
1462 if (saved_values != NULL)
1465 vl->values = saved_values;
1466 vl->values_len = saved_values_len;
1472 /* Update the value cache */
1475 /* Initiate threshold checking */
1476 ut_check_threshold (ds, vl);
1478 if (post_cache_chain != NULL)
1480 status = fc_process_chain (ds, vl, post_cache_chain);
1483 WARNING ("plugin_dispatch_values: Running the "
1484 "post-cache chain failed with "
1490 fc_default_action (ds, vl);
1492 /* Restore the state of the value_list so that plugins don't get
1494 if (saved_values != NULL)
1497 vl->values = saved_values;
1498 vl->values_len = saved_values_len;
1501 if ((free_meta_data != 0) && (vl->meta != NULL))
1503 meta_data_destroy (vl->meta);
1508 } /* int plugin_dispatch_values */
1510 int plugin_dispatch_notification (const notification_t *notif)
1513 /* Possible TODO: Add flap detection here */
1515 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1516 "time = %u; host = %s;",
1517 notif->severity, notif->message,
1518 (unsigned int) notif->time, notif->host);
1520 /* Nobody cares for notifications */
1521 if (list_notification == NULL)
1524 le = llist_head (list_notification);
1527 callback_func_t *cf;
1528 plugin_notification_cb callback;
1532 callback = cf->cf_callback;
1533 status = (*callback) (notif, &cf->cf_udata);
1536 WARNING ("plugin_dispatch_notification: Notification "
1537 "callback %s returned %i.",
1545 } /* int plugin_dispatch_notification */
1547 void plugin_log (int level, const char *format, ...)
1554 if (level >= LOG_DEBUG)
1558 va_start (ap, format);
1559 vsnprintf (msg, sizeof (msg), format, ap);
1560 msg[sizeof (msg) - 1] = '\0';
1563 if (list_log == NULL)
1565 fprintf (stderr, "%s\n", msg);
1569 le = llist_head (list_log);
1572 callback_func_t *cf;
1573 plugin_log_cb callback;
1576 callback = cf->cf_callback;
1578 (*callback) (level, msg, &cf->cf_udata);
1582 } /* void plugin_log */
1584 const data_set_t *plugin_get_ds (const char *name)
1588 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1590 DEBUG ("No such dataset registered: %s", name);
1595 } /* data_set_t *plugin_get_ds */
1597 static int plugin_notification_meta_add (notification_t *n,
1599 enum notification_meta_type_e type,
1602 notification_meta_t *meta;
1603 notification_meta_t *tail;
1605 if ((n == NULL) || (name == NULL) || (value == NULL))
1607 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1611 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1614 ERROR ("plugin_notification_meta_add: malloc failed.");
1617 memset (meta, 0, sizeof (notification_meta_t));
1619 sstrncpy (meta->name, name, sizeof (meta->name));
1624 case NM_TYPE_STRING:
1626 meta->nm_value.nm_string = strdup ((const char *) value);
1627 if (meta->nm_value.nm_string == NULL)
1629 ERROR ("plugin_notification_meta_add: strdup failed.");
1635 case NM_TYPE_SIGNED_INT:
1637 meta->nm_value.nm_signed_int = *((int64_t *) value);
1640 case NM_TYPE_UNSIGNED_INT:
1642 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1645 case NM_TYPE_DOUBLE:
1647 meta->nm_value.nm_double = *((double *) value);
1650 case NM_TYPE_BOOLEAN:
1652 meta->nm_value.nm_boolean = *((bool *) value);
1657 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1661 } /* switch (type) */
1665 while ((tail != NULL) && (tail->next != NULL))
1674 } /* int plugin_notification_meta_add */
1676 int plugin_notification_meta_add_string (notification_t *n,
1680 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1683 int plugin_notification_meta_add_signed_int (notification_t *n,
1687 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1690 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1694 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1697 int plugin_notification_meta_add_double (notification_t *n,
1701 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1704 int plugin_notification_meta_add_boolean (notification_t *n,
1708 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1711 int plugin_notification_meta_copy (notification_t *dst,
1712 const notification_t *src)
1714 notification_meta_t *meta;
1716 assert (dst != NULL);
1717 assert (src != NULL);
1718 assert (dst != src);
1719 assert ((src->meta == NULL) || (src->meta != dst->meta));
1721 for (meta = src->meta; meta != NULL; meta = meta->next)
1723 if (meta->type == NM_TYPE_STRING)
1724 plugin_notification_meta_add_string (dst, meta->name,
1725 meta->nm_value.nm_string);
1726 else if (meta->type == NM_TYPE_SIGNED_INT)
1727 plugin_notification_meta_add_signed_int (dst, meta->name,
1728 meta->nm_value.nm_signed_int);
1729 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1730 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1731 meta->nm_value.nm_unsigned_int);
1732 else if (meta->type == NM_TYPE_DOUBLE)
1733 plugin_notification_meta_add_double (dst, meta->name,
1734 meta->nm_value.nm_double);
1735 else if (meta->type == NM_TYPE_BOOLEAN)
1736 plugin_notification_meta_add_boolean (dst, meta->name,
1737 meta->nm_value.nm_boolean);
1741 } /* int plugin_notification_meta_copy */
1743 int plugin_notification_meta_free (notification_meta_t *n)
1745 notification_meta_t *this;
1746 notification_meta_t *next;
1750 ERROR ("plugin_notification_meta_free: n == NULL!");
1755 while (this != NULL)
1759 if (this->type == NM_TYPE_STRING)
1761 free ((char *)this->nm_value.nm_string);
1762 this->nm_value.nm_string = NULL;
1770 } /* int plugin_notification_meta_free */
1772 /* vim: set sw=8 ts=8 noet fdm=marker : */