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;
56 /* `read_func_t' "inherits" from `callback_func_t'.
57 * The `rf_super' member MUST be the first one in this structure! */
58 #define rf_callback rf_super.cf_callback
59 #define rf_udata rf_super.cf_udata
60 callback_func_t rf_super;
61 char rf_name[DATA_MAX_NAME_LEN];
63 struct timespec rf_interval;
64 struct timespec rf_effective_interval;
65 struct timespec rf_next_read;
67 typedef struct read_func_s read_func_t;
72 static llist_t *list_init;
73 static llist_t *list_write;
74 static llist_t *list_flush;
75 static llist_t *list_shutdown;
76 static llist_t *list_log;
77 static llist_t *list_notification;
79 static fc_chain_t *pre_cache_chain = NULL;
80 static fc_chain_t *post_cache_chain = NULL;
82 static c_avl_tree_t *data_sets;
84 static char *plugindir = NULL;
86 static c_heap_t *read_heap = NULL;
87 static int read_loop = 1;
88 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
89 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
90 static pthread_t *read_threads = NULL;
91 static int read_threads_num = 0;
96 static const char *plugin_get_dir (void)
98 if (plugindir == NULL)
104 static void destroy_callback (callback_func_t *cf) /* {{{ */
109 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
111 cf->cf_udata.free_func (cf->cf_udata.data);
112 cf->cf_udata.data = NULL;
113 cf->cf_udata.free_func = NULL;
116 } /* }}} void destroy_callback */
118 static void destroy_all_callbacks (llist_t **list) /* {{{ */
125 le = llist_head (*list);
133 destroy_callback (le->value);
139 llist_destroy (*list);
141 } /* }}} void destroy_all_callbacks */
143 static void destroy_read_heap (void) /* {{{ */
145 if (read_heap == NULL)
152 cf = c_head_get_root (read_heap);
156 destroy_callback (cf);
159 c_heap_destroy (read_heap);
161 } /* }}} void destroy_read_heap */
163 static int register_callback (llist_t **list, /* {{{ */
164 const char *name, callback_func_t *cf)
171 *list = llist_create ();
174 ERROR ("plugin: create_register_callback: "
175 "llist_create failed.");
176 destroy_callback (cf);
184 ERROR ("plugin: create_register_callback: strdup failed.");
185 destroy_callback (cf);
189 le = llist_search (*list, name);
192 le = llentry_create (key, cf);
195 ERROR ("plugin: create_register_callback: "
196 "llentry_create failed.");
198 destroy_callback (cf);
202 llist_append (*list, le);
206 callback_func_t *old_cf;
211 destroy_callback (old_cf);
216 } /* }}} int register_callback */
218 static int create_register_callback (llist_t **list, /* {{{ */
219 const char *name, void *callback, user_data_t *ud)
223 cf = (callback_func_t *) malloc (sizeof (*cf));
226 ERROR ("plugin: create_register_callback: malloc failed.");
229 memset (cf, 0, sizeof (*cf));
231 cf->cf_callback = callback;
234 cf->cf_udata.data = NULL;
235 cf->cf_udata.free_func = NULL;
242 return (register_callback (list, name, cf));
243 } /* }}} int create_register_callback */
245 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
252 e = llist_search (list, name);
256 llist_remove (list, e);
259 destroy_callback (e->value);
264 } /* }}} int plugin_unregister */
267 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
268 * object, but it will bitch about a shared object not having a
269 * ``module_register'' symbol..
271 static int plugin_load_file (char *file)
274 void (*reg_handle) (void);
276 DEBUG ("file = %s", file);
279 lt_dlerror (); /* clear errors */
281 if ((dlh = lt_dlopen (file)) == NULL)
283 const char *error = lt_dlerror ();
285 ERROR ("lt_dlopen (%s) failed: %s", file, error);
286 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
290 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
292 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
293 file, lt_dlerror ());
303 static void *plugin_read_thread (void __attribute__((unused)) *args)
305 while (read_loop != 0)
311 /* Get the read function that needs to be read next. */
312 rf = c_head_get_root (read_heap);
315 struct timespec abstime;
317 gettimeofday (&now, /* timezone = */ NULL);
319 abstime.tv_sec = now.tv_sec + interval_g;
320 abstime.tv_nsec = 1000 * now.tv_usec;
322 pthread_mutex_lock (&read_lock);
323 pthread_cond_timedwait (&read_cond, &read_lock,
325 pthread_mutex_unlock (&read_lock);
329 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
331 gettimeofday (&now, /* timezone = */ NULL);
333 rf->rf_interval.tv_sec = interval_g;
334 rf->rf_interval.tv_nsec = 0;
336 rf->rf_effective_interval = rf->rf_interval;
338 rf->rf_next_read.tv_sec = now.tv_sec;
339 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
342 /* sleep until this entry is due,
343 * using pthread_cond_timedwait */
344 pthread_mutex_lock (&read_lock);
345 pthread_cond_timedwait (&read_cond, &read_lock,
347 pthread_mutex_unlock (&read_lock);
349 /* Check if we're supposed to stop.. This may have interrupted
353 /* Insert `rf' again, so it can be free'd correctly */
354 c_heap_insert (read_heap, rf);
358 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
360 if (rf->rf_type == RF_SIMPLE)
362 int (*callback) (void);
364 callback = rf->rf_callback;
365 status = (*callback) ();
369 plugin_read_cb callback;
371 callback = rf->rf_callback;
372 status = (*callback) (&rf->rf_udata);
375 /* If the function signals failure, we will increase the
376 * intervals in which it will be called. */
379 rf->rf_effective_interval.tv_sec *= 2;
380 rf->rf_effective_interval.tv_nsec *= 2;
381 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
383 if (rf->rf_effective_interval.tv_sec >= 86400)
385 rf->rf_effective_interval.tv_sec = 86400;
386 rf->rf_effective_interval.tv_nsec = 0;
389 NOTICE ("read-function of plugin `%s' failed. "
390 "Will suspend it for %i seconds.",
392 (int) rf->rf_effective_interval.tv_sec);
396 /* Success: Restore the interval, if it was changed. */
397 rf->rf_effective_interval = rf->rf_interval;
400 /* update the ``next read due'' field */
401 gettimeofday (&now, /* timezone = */ NULL);
403 DEBUG ("plugin_read_thread: Effective interval of the "
404 "%s plugin is %i.%09i.",
406 (int) rf->rf_effective_interval.tv_sec,
407 (int) rf->rf_effective_interval.tv_nsec);
409 /* Calculate the next (absolute) time at which this function
410 * should be called. */
411 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
412 + rf->rf_effective_interval.tv_sec;
413 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
414 + rf->rf_effective_interval.tv_nsec;
415 NORMALIZE_TIMESPEC (rf->rf_next_read);
417 /* Check, if `rf_next_read' is in the past. */
418 if ((rf->rf_next_read.tv_sec < now.tv_sec)
419 || ((rf->rf_next_read.tv_sec == now.tv_sec)
420 && (rf->rf_next_read.tv_nsec < (1000 * now.tv_usec))))
422 /* `rf_next_read' is in the past. Insert `now'
423 * so this value doesn't trail off into the
425 rf->rf_next_read.tv_sec = now.tv_sec;
426 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
429 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
431 (int) rf->rf_next_read.tv_sec,
432 (int) rf->rf_next_read.tv_nsec);
434 /* Re-insert this read function into the heap again. */
435 c_heap_insert (read_heap, rf);
436 } /* while (read_loop) */
440 } /* void *plugin_read_thread */
442 static void start_read_threads (int num)
446 if (read_threads != NULL)
449 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
450 if (read_threads == NULL)
452 ERROR ("plugin: start_read_threads: calloc failed.");
456 read_threads_num = 0;
457 for (i = 0; i < num; i++)
459 if (pthread_create (read_threads + read_threads_num, NULL,
460 plugin_read_thread, NULL) == 0)
466 ERROR ("plugin: start_read_threads: pthread_create failed.");
470 } /* void start_read_threads */
472 static void stop_read_threads (void)
476 if (read_threads == NULL)
479 INFO ("collectd: Stopping %i read threads.", read_threads_num);
481 pthread_mutex_lock (&read_lock);
483 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
484 pthread_cond_broadcast (&read_cond);
485 pthread_mutex_unlock (&read_lock);
487 for (i = 0; i < read_threads_num; i++)
489 if (pthread_join (read_threads[i], NULL) != 0)
491 ERROR ("plugin: stop_read_threads: pthread_join failed.");
493 read_threads[i] = (pthread_t) 0;
495 sfree (read_threads);
496 read_threads_num = 0;
497 } /* void stop_read_threads */
502 void plugin_set_dir (const char *dir)
504 if (plugindir != NULL)
509 else if ((plugindir = strdup (dir)) == NULL)
512 ERROR ("strdup failed: %s",
513 sstrerror (errno, errbuf, sizeof (errbuf)));
518 int plugin_load (const char *type)
522 char filename[BUFSIZE] = "";
523 char typename[BUFSIZE];
530 DEBUG ("type = %s", type);
532 dir = plugin_get_dir ();
535 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
536 * type when matching the filename */
537 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
538 if ((status < 0) || ((size_t) status >= sizeof (typename)))
540 WARNING ("snprintf: truncated: `%s.so'", type);
543 typename_len = strlen (typename);
545 if ((dh = opendir (dir)) == NULL)
548 ERROR ("opendir (%s): %s", dir,
549 sstrerror (errno, errbuf, sizeof (errbuf)));
553 while ((de = readdir (dh)) != NULL)
555 if (strncasecmp (de->d_name, typename, typename_len))
558 status = ssnprintf (filename, sizeof (filename),
559 "%s/%s", dir, de->d_name);
560 if ((status < 0) || ((size_t) status >= sizeof (filename)))
562 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
566 if (lstat (filename, &statbuf) == -1)
569 WARNING ("stat %s: %s", filename,
570 sstrerror (errno, errbuf, sizeof (errbuf)));
573 else if (!S_ISREG (statbuf.st_mode))
575 /* don't follow symlinks */
576 WARNING ("stat %s: not a regular file", filename);
580 if (plugin_load_file (filename) == 0)
588 fprintf (stderr, "Unable to load plugin %s.\n", type);
594 if (filename[0] == '\0')
595 fprintf (stderr, "Could not find plugin %s.\n", type);
601 * The `register_*' functions follow
603 int plugin_register_config (const char *name,
604 int (*callback) (const char *key, const char *val),
605 const char **keys, int keys_num)
607 cf_register (name, callback, keys, keys_num);
609 } /* int plugin_register_config */
611 int plugin_register_complex_config (const char *type,
612 int (*callback) (oconfig_item_t *))
614 return (cf_register_complex (type, callback));
615 } /* int plugin_register_complex_config */
617 int plugin_register_init (const char *name,
618 int (*callback) (void))
620 return (create_register_callback (&list_init, name, (void *) callback,
621 /* user_data = */ NULL));
622 } /* plugin_register_init */
624 static int plugin_compare_read_func (const void *arg0, const void *arg1)
626 const read_func_t *rf0;
627 const read_func_t *rf1;
632 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
634 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
636 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
638 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
642 } /* int plugin_compare_read_func */
644 int plugin_register_read (const char *name,
645 int (*callback) (void))
649 if (read_heap == NULL)
651 read_heap = c_heap_create (plugin_compare_read_func);
652 if (read_heap == NULL)
654 ERROR ("plugin_register_read: "
655 "c_heap_create failed.");
660 rf = (read_func_t *) malloc (sizeof (read_func_t));
664 ERROR ("plugin_register_read: malloc failed: %s",
665 sstrerror (errno, errbuf, sizeof (errbuf)));
669 memset (rf, 0, sizeof (read_func_t));
670 rf->rf_callback = (void *) callback;
671 rf->rf_udata.data = NULL;
672 rf->rf_udata.free_func = NULL;
673 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
674 rf->rf_type = RF_SIMPLE;
675 rf->rf_interval.tv_sec = 0;
676 rf->rf_interval.tv_nsec = 0;
677 rf->rf_effective_interval = rf->rf_interval;
679 return (c_heap_insert (read_heap, rf));
680 } /* int plugin_register_read */
682 int plugin_register_complex_read (const char *name,
683 plugin_read_cb callback,
684 const struct timespec *interval,
685 user_data_t *user_data)
689 if (read_heap == NULL)
691 read_heap = c_heap_create (plugin_compare_read_func);
692 if (read_heap == NULL)
694 ERROR ("plugin_register_read: c_heap_create failed.");
699 rf = (read_func_t *) malloc (sizeof (read_func_t));
702 ERROR ("plugin_register_complex_read: malloc failed.");
706 memset (rf, 0, sizeof (read_func_t));
707 rf->rf_callback = (void *) callback;
708 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
709 rf->rf_type = RF_COMPLEX;
710 if (interval != NULL)
712 rf->rf_interval = *interval;
714 rf->rf_effective_interval = rf->rf_interval;
717 if (user_data == NULL)
719 rf->rf_udata.data = NULL;
720 rf->rf_udata.free_func = NULL;
724 rf->rf_udata = *user_data;
727 return (c_heap_insert (read_heap, rf));
728 } /* int plugin_register_complex_read */
730 int plugin_register_write (const char *name,
731 plugin_write_cb callback, user_data_t *ud)
733 return (create_register_callback (&list_write, name,
734 (void *) callback, ud));
735 } /* int plugin_register_write */
737 int plugin_register_flush (const char *name,
738 plugin_flush_cb callback, user_data_t *ud)
740 return (create_register_callback (&list_flush, name,
741 (void *) callback, ud));
742 } /* int plugin_register_flush */
744 int plugin_register_shutdown (char *name,
745 int (*callback) (void))
747 return (create_register_callback (&list_shutdown, name,
748 (void *) callback, /* user_data = */ NULL));
749 } /* int plugin_register_shutdown */
751 int plugin_register_data_set (const data_set_t *ds)
756 if ((data_sets != NULL)
757 && (c_avl_get (data_sets, ds->type, NULL) == 0))
759 NOTICE ("Replacing DS `%s' with another version.", ds->type);
760 plugin_unregister_data_set (ds->type);
762 else if (data_sets == NULL)
764 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
765 if (data_sets == NULL)
769 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
772 memcpy(ds_copy, ds, sizeof (data_set_t));
774 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
776 if (ds_copy->ds == NULL)
782 for (i = 0; i < ds->ds_num; i++)
783 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
785 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
786 } /* int plugin_register_data_set */
788 int plugin_register_log (const char *name,
789 plugin_log_cb callback, user_data_t *ud)
791 return (create_register_callback (&list_log, name,
792 (void *) callback, ud));
793 } /* int plugin_register_log */
795 int plugin_register_notification (const char *name,
796 plugin_notification_cb callback, user_data_t *ud)
798 return (create_register_callback (&list_notification, name,
799 (void *) callback, ud));
800 } /* int plugin_register_log */
802 int plugin_unregister_config (const char *name)
804 cf_unregister (name);
806 } /* int plugin_unregister_config */
808 int plugin_unregister_complex_config (const char *name)
810 cf_unregister_complex (name);
812 } /* int plugin_unregister_complex_config */
814 int plugin_unregister_init (const char *name)
816 return (plugin_unregister (list_init, name));
819 int plugin_unregister_read (const char *name)
821 /* TODO: Implement removal of a specific key from the heap. */
826 int plugin_unregister_write (const char *name)
828 return (plugin_unregister (list_write, name));
831 int plugin_unregister_flush (const char *name)
833 return (plugin_unregister (list_flush, name));
836 int plugin_unregister_shutdown (const char *name)
838 return (plugin_unregister (list_shutdown, name));
841 int plugin_unregister_data_set (const char *name)
845 if (data_sets == NULL)
848 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
855 } /* int plugin_unregister_data_set */
857 int plugin_unregister_log (const char *name)
859 return (plugin_unregister (list_log, name));
862 int plugin_unregister_notification (const char *name)
864 return (plugin_unregister (list_notification, name));
867 void plugin_init_all (void)
869 const char *chain_name;
873 /* Init the value cache */
876 chain_name = global_option_get ("PreCacheChain");
877 pre_cache_chain = fc_chain_get_by_name (chain_name);
879 chain_name = global_option_get ("PostCacheChain");
880 post_cache_chain = fc_chain_get_by_name (chain_name);
883 if ((list_init == NULL) && (read_heap == NULL))
886 /* Calling all init callbacks before checking if read callbacks
887 * are available allows the init callbacks to register the read
889 le = llist_head (list_init);
893 plugin_init_cb callback;
896 callback = cf->cf_callback;
897 status = (*callback) ();
901 ERROR ("Initialization of plugin `%s' "
902 "failed with status %i. "
903 "Plugin will be unloaded.",
905 /* Plugins that register read callbacks from the init
906 * callback should take care of appropriate error
907 * handling themselves. */
908 /* FIXME: Unload _all_ functions */
909 plugin_unregister_read (le->key);
915 /* Start read-threads */
916 if (read_heap != NULL)
920 rt = global_option_get ("ReadThreads");
923 start_read_threads ((num > 0) ? num : 5);
925 } /* void plugin_init_all */
927 /* TODO: Rename this function. */
928 void plugin_read_all (void)
933 } /* void plugin_read_all */
935 /* Read function called when the `-T' command line argument is given. */
936 int plugin_read_all_once (void)
939 int return_status = 0;
941 if (read_heap == NULL)
943 NOTICE ("No read-functions are registered.");
951 rf = c_head_get_root (read_heap);
955 if (rf->rf_type == RF_SIMPLE)
957 int (*callback) (void);
959 callback = rf->rf_callback;
960 status = (*callback) ();
964 plugin_read_cb callback;
966 callback = rf->rf_callback;
967 status = (*callback) (&rf->rf_udata);
972 NOTICE ("read-function of plugin `%s' failed.",
977 destroy_callback ((void *) rf);
980 return (return_status);
981 } /* int plugin_read_all_once */
983 int plugin_write (const char *plugin, /* {{{ */
984 const data_set_t *ds, const value_list_t *vl)
992 if (list_write == NULL)
997 ds = plugin_get_ds (vl->type);
1000 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1010 le = llist_head (list_write);
1013 callback_func_t *cf = le->value;
1014 plugin_write_cb callback;
1016 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1017 callback = cf->cf_callback;
1018 status = (*callback) (ds, vl, &cf->cf_udata);
1027 if ((success == 0) && (failure != 0))
1032 else /* plugin != NULL */
1034 callback_func_t *cf;
1035 plugin_write_cb callback;
1037 le = llist_head (list_write);
1040 if (strcasecmp (plugin, le->key) == 0)
1051 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1052 callback = cf->cf_callback;
1053 status = (*callback) (ds, vl, &cf->cf_udata);
1057 } /* }}} int plugin_write */
1059 int plugin_flush (const char *plugin, int timeout, const char *identifier)
1063 if (list_flush == NULL)
1066 le = llist_head (list_flush);
1069 callback_func_t *cf;
1070 plugin_flush_cb callback;
1072 if ((plugin != NULL)
1073 && (strcmp (plugin, le->key) != 0))
1080 callback = cf->cf_callback;
1082 (*callback) (timeout, identifier, &cf->cf_udata);
1087 } /* int plugin_flush */
1089 void plugin_shutdown_all (void)
1093 stop_read_threads ();
1095 destroy_all_callbacks (&list_init);
1096 destroy_read_heap ();
1098 plugin_flush (/* plugin = */ NULL, /* timeout = */ -1,
1099 /* identifier = */ NULL);
1102 if (list_shutdown != NULL)
1103 le = llist_head (list_shutdown);
1107 callback_func_t *cf;
1108 plugin_shutdown_cb callback;
1111 callback = cf->cf_callback;
1113 /* Advance the pointer before calling the callback allows
1114 * shutdown functions to unregister themselves. If done the
1115 * other way around the memory `le' points to will be freed
1116 * after callback returns. */
1122 destroy_all_callbacks (&list_write);
1123 destroy_all_callbacks (&list_flush);
1124 destroy_all_callbacks (&list_notification);
1125 destroy_all_callbacks (&list_shutdown);
1126 destroy_all_callbacks (&list_log);
1127 } /* void plugin_shutdown_all */
1129 int plugin_dispatch_values (value_list_t *vl)
1132 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1134 value_t *saved_values;
1135 int saved_values_len;
1139 int free_meta_data = 0;
1141 if ((vl == NULL) || (vl->type[0] == 0)
1142 || (vl->values == NULL) || (vl->values_len < 1))
1144 ERROR ("plugin_dispatch_values: Invalid value list.");
1148 /* Free meta data only if the calling function didn't specify any. In
1149 * this case matches and targets may add some and the calling function
1150 * may not expect (and therefore free) that data. */
1151 if (vl->meta == NULL)
1154 if (list_write == NULL)
1155 c_complain_once (LOG_WARNING, &no_write_complaint,
1156 "plugin_dispatch_values: No write callback has been "
1157 "registered. Please load at least one output plugin, "
1158 "if you want the collected data to be stored.");
1160 if (data_sets == NULL)
1162 ERROR ("plugin_dispatch_values: No data sets registered. "
1163 "Could the types database be read? Check "
1164 "your `TypesDB' setting!");
1168 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1170 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
1175 vl->time = time (NULL);
1177 if (vl->interval <= 0)
1178 vl->interval = interval_g;
1180 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
1182 "plugin = %s; plugin_instance = %s; "
1183 "type = %s; type_instance = %s;",
1184 (unsigned int) vl->time, vl->interval,
1186 vl->plugin, vl->plugin_instance,
1187 vl->type, vl->type_instance);
1190 assert (0 == strcmp (ds->type, vl->type));
1192 if (0 != strcmp (ds->type, vl->type))
1193 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1194 ds->type, vl->type);
1198 assert (ds->ds_num == vl->values_len);
1200 if (ds->ds_num != vl->values_len)
1202 ERROR ("plugin_dispatch_values: ds->type = %s: "
1203 "(ds->ds_num = %i) != "
1204 "(vl->values_len = %i)",
1205 ds->type, ds->ds_num, vl->values_len);
1210 escape_slashes (vl->host, sizeof (vl->host));
1211 escape_slashes (vl->plugin, sizeof (vl->plugin));
1212 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1213 escape_slashes (vl->type, sizeof (vl->type));
1214 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1216 /* Copy the values. This way, we can assure `targets' that they get
1217 * dynamically allocated values, which they can free and replace if
1219 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1221 saved_values = vl->values;
1222 saved_values_len = vl->values_len;
1224 vl->values = (value_t *) calloc (vl->values_len,
1225 sizeof (*vl->values));
1226 if (vl->values == NULL)
1228 ERROR ("plugin_dispatch_values: calloc failed.");
1229 vl->values = saved_values;
1232 memcpy (vl->values, saved_values,
1233 vl->values_len * sizeof (*vl->values));
1235 else /* if ((pre == NULL) && (post == NULL)) */
1237 saved_values = NULL;
1238 saved_values_len = 0;
1241 if (pre_cache_chain != NULL)
1243 status = fc_process_chain (ds, vl, pre_cache_chain);
1246 WARNING ("plugin_dispatch_values: Running the "
1247 "pre-cache chain failed with "
1251 else if (status == FC_TARGET_STOP)
1253 /* Restore the state of the value_list so that plugins
1254 * don't get confused.. */
1255 if (saved_values != NULL)
1258 vl->values = saved_values;
1259 vl->values_len = saved_values_len;
1265 /* Update the value cache */
1268 /* Initiate threshold checking */
1269 ut_check_threshold (ds, vl);
1271 if (post_cache_chain != NULL)
1273 status = fc_process_chain (ds, vl, post_cache_chain);
1276 WARNING ("plugin_dispatch_values: Running the "
1277 "post-cache chain failed with "
1283 fc_default_action (ds, vl);
1285 /* Restore the state of the value_list so that plugins don't get
1287 if (saved_values != NULL)
1290 vl->values = saved_values;
1291 vl->values_len = saved_values_len;
1294 if ((free_meta_data != 0) && (vl->meta != NULL))
1296 meta_data_destroy (vl->meta);
1301 } /* int plugin_dispatch_values */
1303 int plugin_dispatch_notification (const notification_t *notif)
1306 /* Possible TODO: Add flap detection here */
1308 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1309 "time = %u; host = %s;",
1310 notif->severity, notif->message,
1311 (unsigned int) notif->time, notif->host);
1313 /* Nobody cares for notifications */
1314 if (list_notification == NULL)
1317 le = llist_head (list_notification);
1320 callback_func_t *cf;
1321 plugin_notification_cb callback;
1325 callback = cf->cf_callback;
1326 status = (*callback) (notif, &cf->cf_udata);
1329 WARNING ("plugin_dispatch_notification: Notification "
1330 "callback %s returned %i.",
1338 } /* int plugin_dispatch_notification */
1340 void plugin_log (int level, const char *format, ...)
1346 if (list_log == NULL)
1350 if (level >= LOG_DEBUG)
1354 va_start (ap, format);
1355 vsnprintf (msg, sizeof (msg), format, ap);
1356 msg[sizeof (msg) - 1] = '\0';
1359 le = llist_head (list_log);
1362 callback_func_t *cf;
1363 plugin_log_cb callback;
1366 callback = cf->cf_callback;
1368 (*callback) (level, msg, &cf->cf_udata);
1372 } /* void plugin_log */
1374 const data_set_t *plugin_get_ds (const char *name)
1378 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1380 DEBUG ("No such dataset registered: %s", name);
1385 } /* data_set_t *plugin_get_ds */
1387 static int plugin_notification_meta_add (notification_t *n,
1389 enum notification_meta_type_e type,
1392 notification_meta_t *meta;
1393 notification_meta_t *tail;
1395 if ((n == NULL) || (name == NULL) || (value == NULL))
1397 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1401 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1404 ERROR ("plugin_notification_meta_add: malloc failed.");
1407 memset (meta, 0, sizeof (notification_meta_t));
1409 sstrncpy (meta->name, name, sizeof (meta->name));
1414 case NM_TYPE_STRING:
1416 meta->nm_value.nm_string = strdup ((const char *) value);
1417 if (meta->nm_value.nm_string == NULL)
1419 ERROR ("plugin_notification_meta_add: strdup failed.");
1425 case NM_TYPE_SIGNED_INT:
1427 meta->nm_value.nm_signed_int = *((int64_t *) value);
1430 case NM_TYPE_UNSIGNED_INT:
1432 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1435 case NM_TYPE_DOUBLE:
1437 meta->nm_value.nm_double = *((double *) value);
1440 case NM_TYPE_BOOLEAN:
1442 meta->nm_value.nm_boolean = *((bool *) value);
1447 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1451 } /* switch (type) */
1455 while ((tail != NULL) && (tail->next != NULL))
1464 } /* int plugin_notification_meta_add */
1466 int plugin_notification_meta_add_string (notification_t *n,
1470 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1473 int plugin_notification_meta_add_signed_int (notification_t *n,
1477 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1480 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1484 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1487 int plugin_notification_meta_add_double (notification_t *n,
1491 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1494 int plugin_notification_meta_add_boolean (notification_t *n,
1498 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1501 int plugin_notification_meta_copy (notification_t *dst,
1502 const notification_t *src)
1504 notification_meta_t *meta;
1506 assert (dst != NULL);
1507 assert (src != NULL);
1508 assert (dst != src);
1509 assert ((src->meta == NULL) || (src->meta != dst->meta));
1511 for (meta = src->meta; meta != NULL; meta = meta->next)
1513 if (meta->type == NM_TYPE_STRING)
1514 plugin_notification_meta_add_string (dst, meta->name,
1515 meta->nm_value.nm_string);
1516 else if (meta->type == NM_TYPE_SIGNED_INT)
1517 plugin_notification_meta_add_signed_int (dst, meta->name,
1518 meta->nm_value.nm_signed_int);
1519 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1520 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1521 meta->nm_value.nm_unsigned_int);
1522 else if (meta->type == NM_TYPE_DOUBLE)
1523 plugin_notification_meta_add_double (dst, meta->name,
1524 meta->nm_value.nm_double);
1525 else if (meta->type == NM_TYPE_BOOLEAN)
1526 plugin_notification_meta_add_boolean (dst, meta->name,
1527 meta->nm_value.nm_boolean);
1531 } /* int plugin_notification_meta_copy */
1533 int plugin_notification_meta_free (notification_meta_t *n)
1535 notification_meta_t *this;
1536 notification_meta_t *next;
1540 ERROR ("plugin_notification_meta_free: n == NULL!");
1545 while (this != NULL)
1549 if (this->type == NM_TYPE_STRING)
1551 free ((char *)this->nm_value.nm_string);
1552 this->nm_value.nm_string = NULL;
1560 } /* int plugin_notification_meta_free */
1562 /* vim: set sw=8 ts=8 noet fdm=marker : */