2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2013 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>
26 #include "configfile.h"
27 #include "filter_chain.h"
28 #include "utils_avltree.h"
29 #include "utils_cache.h"
30 #include "utils_complain.h"
31 #include "utils_llist.h"
32 #include "utils_heap.h"
33 #include "utils_time.h"
34 #include "utils_random.h"
45 struct callback_func_s
51 typedef struct callback_func_s callback_func_t;
55 #define RF_REMOVE 65535
58 /* `read_func_t' "inherits" from `callback_func_t'.
59 * The `rf_super' member MUST be the first one in this structure! */
60 #define rf_callback rf_super.cf_callback
61 #define rf_udata rf_super.cf_udata
62 #define rf_ctx rf_super.cf_ctx
63 callback_func_t rf_super;
64 char rf_group[DATA_MAX_NAME_LEN];
68 cdtime_t rf_effective_interval;
69 cdtime_t rf_next_read;
71 typedef struct read_func_s read_func_t;
74 typedef struct write_queue_s write_queue_t;
85 static c_avl_tree_t *plugins_loaded = NULL;
87 static llist_t *list_init;
88 static llist_t *list_write;
89 static llist_t *list_flush;
90 static llist_t *list_missing;
91 static llist_t *list_shutdown;
92 static llist_t *list_log;
93 static llist_t *list_notification;
95 static fc_chain_t *pre_cache_chain = NULL;
96 static fc_chain_t *post_cache_chain = NULL;
98 static c_avl_tree_t *data_sets;
100 static char *plugindir = NULL;
102 static c_heap_t *read_heap = NULL;
103 static llist_t *read_list;
104 static int read_loop = 1;
105 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
106 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
107 static pthread_t *read_threads = NULL;
108 static int read_threads_num = 0;
110 static write_queue_t *write_queue_head;
111 static write_queue_t *write_queue_tail;
112 static long write_queue_length = 0;
113 static _Bool write_loop = 1;
114 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
115 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
116 static pthread_t *write_threads = NULL;
117 static size_t write_threads_num = 0;
119 static pthread_key_t plugin_ctx_key;
120 static _Bool plugin_ctx_key_initialized = 0;
122 static long write_limit_high = 0;
123 static long write_limit_low = 0;
128 static int plugin_dispatch_values_internal (value_list_t *vl);
130 static const char *plugin_get_dir (void)
132 if (plugindir == NULL)
138 static void destroy_callback (callback_func_t *cf) /* {{{ */
143 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
145 cf->cf_udata.free_func (cf->cf_udata.data);
146 cf->cf_udata.data = NULL;
147 cf->cf_udata.free_func = NULL;
150 } /* }}} void destroy_callback */
152 static void destroy_all_callbacks (llist_t **list) /* {{{ */
159 le = llist_head (*list);
167 destroy_callback (le->value);
173 llist_destroy (*list);
175 } /* }}} void destroy_all_callbacks */
177 static void destroy_read_heap (void) /* {{{ */
179 if (read_heap == NULL)
186 cf = c_heap_get_root (read_heap);
190 destroy_callback (cf);
193 c_heap_destroy (read_heap);
195 } /* }}} void destroy_read_heap */
197 static int register_callback (llist_t **list, /* {{{ */
198 const char *name, callback_func_t *cf)
205 *list = llist_create ();
208 ERROR ("plugin: register_callback: "
209 "llist_create failed.");
210 destroy_callback (cf);
218 ERROR ("plugin: register_callback: strdup failed.");
219 destroy_callback (cf);
223 le = llist_search (*list, name);
226 le = llentry_create (key, cf);
229 ERROR ("plugin: register_callback: "
230 "llentry_create failed.");
232 destroy_callback (cf);
236 llist_append (*list, le);
240 callback_func_t *old_cf;
245 WARNING ("plugin: register_callback: "
246 "a callback named `%s' already exists - "
247 "overwriting the old entry!", name);
249 destroy_callback (old_cf);
254 } /* }}} int register_callback */
256 static int create_register_callback (llist_t **list, /* {{{ */
257 const char *name, void *callback, user_data_t *ud)
261 cf = (callback_func_t *) malloc (sizeof (*cf));
264 ERROR ("plugin: create_register_callback: malloc failed.");
267 memset (cf, 0, sizeof (*cf));
269 cf->cf_callback = callback;
272 cf->cf_udata.data = NULL;
273 cf->cf_udata.free_func = NULL;
280 cf->cf_ctx = plugin_get_ctx ();
282 return (register_callback (list, name, cf));
283 } /* }}} int create_register_callback */
285 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
292 e = llist_search (list, name);
296 llist_remove (list, e);
299 destroy_callback (e->value);
304 } /* }}} int plugin_unregister */
307 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
308 * object, but it will bitch about a shared object not having a
309 * ``module_register'' symbol..
311 static int plugin_load_file (char *file, uint32_t flags)
314 void (*reg_handle) (void);
317 lt_dlerror (); /* clear errors */
319 #if LIBTOOL_VERSION == 2
320 if (flags & PLUGIN_FLAGS_GLOBAL) {
322 lt_dladvise_init(&advise);
323 lt_dladvise_global(&advise);
324 dlh = lt_dlopenadvise(file, advise);
325 lt_dladvise_destroy(&advise);
327 dlh = lt_dlopen (file);
329 #else /* if LIBTOOL_VERSION == 1 */
330 if (flags & PLUGIN_FLAGS_GLOBAL)
331 WARNING ("plugin_load_file: The global flag is not supported, "
332 "libtool 2 is required for this.");
333 dlh = lt_dlopen (file);
338 char errbuf[1024] = "";
340 ssnprintf (errbuf, sizeof (errbuf),
341 "lt_dlopen (\"%s\") failed: %s. "
342 "The most common cause for this problem is "
343 "missing dependencies. Use ldd(1) to check "
344 "the dependencies of the plugin "
346 file, lt_dlerror ());
348 ERROR ("%s", errbuf);
349 /* Make sure this is printed to STDERR in any case, but also
350 * make sure it's printed only once. */
351 if (list_log != NULL)
352 fprintf (stderr, "ERROR: %s\n", errbuf);
357 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
359 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
360 file, lt_dlerror ());
370 static void *plugin_read_thread (void __attribute__((unused)) *args)
372 while (read_loop != 0)
375 plugin_ctx_t old_ctx;
381 /* Get the read function that needs to be read next.
382 * We don't need to hold "read_lock" for the heap, but we need
383 * to call c_heap_get_root() and pthread_cond_wait() in the
384 * same protected block. */
385 pthread_mutex_lock (&read_lock);
386 rf = c_heap_get_root (read_heap);
389 pthread_cond_wait (&read_cond, &read_lock);
390 pthread_mutex_unlock (&read_lock);
393 pthread_mutex_unlock (&read_lock);
395 if (rf->rf_interval == 0)
397 /* this should not happen, because the interval is set
398 * for each plugin when loading it
399 * XXX: issue a warning? */
400 rf->rf_interval = plugin_get_interval ();
401 rf->rf_effective_interval = rf->rf_interval;
403 rf->rf_next_read = cdtime ();
406 /* sleep until this entry is due,
407 * using pthread_cond_timedwait */
408 pthread_mutex_lock (&read_lock);
409 /* In pthread_cond_timedwait, spurious wakeups are possible
410 * (and really happen, at least on NetBSD with > 1 CPU), thus
411 * we need to re-evaluate the condition every time
412 * pthread_cond_timedwait returns. */
414 while ((read_loop != 0)
415 && (cdtime () < rf->rf_next_read)
418 struct timespec ts = { 0 };
420 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
422 rc = pthread_cond_timedwait (&read_cond, &read_lock,
426 /* Must hold `read_lock' when accessing `rf->rf_type'. */
427 rf_type = rf->rf_type;
428 pthread_mutex_unlock (&read_lock);
430 /* Check if we're supposed to stop.. This may have interrupted
434 /* Insert `rf' again, so it can be free'd correctly */
435 c_heap_insert (read_heap, rf);
439 /* The entry has been marked for deletion. The linked list
440 * entry has already been removed by `plugin_unregister_read'.
441 * All we have to do here is free the `read_func_t' and
443 if (rf_type == RF_REMOVE)
445 DEBUG ("plugin_read_thread: Destroying the `%s' "
446 "callback.", rf->rf_name);
448 destroy_callback ((callback_func_t *) rf);
453 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
455 old_ctx = plugin_set_ctx (rf->rf_ctx);
457 if (rf_type == RF_SIMPLE)
459 int (*callback) (void);
461 callback = rf->rf_callback;
462 status = (*callback) ();
466 plugin_read_cb callback;
468 assert (rf_type == RF_COMPLEX);
470 callback = rf->rf_callback;
471 status = (*callback) (&rf->rf_udata);
474 plugin_set_ctx (old_ctx);
476 /* If the function signals failure, we will increase the
477 * intervals in which it will be called. */
480 rf->rf_effective_interval *= 2;
481 if (rf->rf_effective_interval > TIME_T_TO_CDTIME_T (86400))
482 rf->rf_effective_interval = TIME_T_TO_CDTIME_T (86400);
484 NOTICE ("read-function of plugin `%s' failed. "
485 "Will suspend it for %.3f seconds.",
487 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
491 /* Success: Restore the interval, if it was changed. */
492 rf->rf_effective_interval = rf->rf_interval;
495 /* update the ``next read due'' field */
498 DEBUG ("plugin_read_thread: Effective interval of the "
499 "%s plugin is %.3f seconds.",
501 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
503 /* Calculate the next (absolute) time at which this function
504 * should be called. */
505 rf->rf_next_read += rf->rf_effective_interval;
507 /* Check, if `rf_next_read' is in the past. */
508 if (rf->rf_next_read < now)
510 /* `rf_next_read' is in the past. Insert `now'
511 * so this value doesn't trail off into the
513 rf->rf_next_read = now;
516 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
518 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
520 /* Re-insert this read function into the heap again. */
521 c_heap_insert (read_heap, rf);
522 } /* while (read_loop) */
526 } /* void *plugin_read_thread */
528 static void start_read_threads (int num)
532 if (read_threads != NULL)
535 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
536 if (read_threads == NULL)
538 ERROR ("plugin: start_read_threads: calloc failed.");
542 read_threads_num = 0;
543 for (i = 0; i < num; i++)
545 if (pthread_create (read_threads + read_threads_num, NULL,
546 plugin_read_thread, NULL) == 0)
552 ERROR ("plugin: start_read_threads: pthread_create failed.");
556 } /* void start_read_threads */
558 static void stop_read_threads (void)
562 if (read_threads == NULL)
565 INFO ("collectd: Stopping %i read threads.", read_threads_num);
567 pthread_mutex_lock (&read_lock);
569 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
570 pthread_cond_broadcast (&read_cond);
571 pthread_mutex_unlock (&read_lock);
573 for (i = 0; i < read_threads_num; i++)
575 if (pthread_join (read_threads[i], NULL) != 0)
577 ERROR ("plugin: stop_read_threads: pthread_join failed.");
579 read_threads[i] = (pthread_t) 0;
581 sfree (read_threads);
582 read_threads_num = 0;
583 } /* void stop_read_threads */
585 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
590 meta_data_destroy (vl->meta);
593 } /* }}} void plugin_value_list_free */
595 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
602 vl = malloc (sizeof (*vl));
605 memcpy (vl, vl_orig, sizeof (*vl));
607 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
608 if (vl->values == NULL)
610 plugin_value_list_free (vl);
613 memcpy (vl->values, vl_orig->values,
614 vl_orig->values_len * sizeof (*vl->values));
616 vl->meta = meta_data_clone (vl->meta);
617 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
619 plugin_value_list_free (vl);
624 vl->time = cdtime ();
626 /* Fill in the interval from the thread context, if it is zero. */
627 if (vl->interval == 0)
629 plugin_ctx_t ctx = plugin_get_ctx ();
631 if (ctx.interval != 0)
632 vl->interval = ctx.interval;
635 char name[6 * DATA_MAX_NAME_LEN];
636 FORMAT_VL (name, sizeof (name), vl);
637 ERROR ("plugin_value_list_clone: Unable to determine "
638 "interval from context for "
639 "value list \"%s\". "
640 "This indicates a broken plugin. "
641 "Please report this problem to the "
642 "collectd mailing list or at "
643 "<http://collectd.org/bugs/>.", name);
644 vl->interval = cf_get_default_interval ();
649 } /* }}} value_list_t *plugin_value_list_clone */
651 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
655 q = malloc (sizeof (*q));
660 q->vl = plugin_value_list_clone (vl);
667 /* Store context of caller (read plugin); otherwise, it would not be
668 * available to the write plugins when actually dispatching the
669 * value-list later on. */
670 q->ctx = plugin_get_ctx ();
672 pthread_mutex_lock (&write_lock);
674 if (write_queue_tail == NULL)
676 write_queue_head = q;
677 write_queue_tail = q;
678 write_queue_length = 1;
682 write_queue_tail->next = q;
683 write_queue_tail = q;
684 write_queue_length += 1;
687 pthread_cond_signal (&write_cond);
688 pthread_mutex_unlock (&write_lock);
691 } /* }}} int plugin_write_enqueue */
693 static value_list_t *plugin_write_dequeue (void) /* {{{ */
698 pthread_mutex_lock (&write_lock);
700 while (write_loop && (write_queue_head == NULL))
701 pthread_cond_wait (&write_cond, &write_lock);
703 if (write_queue_head == NULL)
705 pthread_mutex_unlock (&write_lock);
709 q = write_queue_head;
710 write_queue_head = q->next;
711 write_queue_length -= 1;
712 if (write_queue_head == NULL) {
713 write_queue_tail = NULL;
714 assert(0 == write_queue_length);
717 pthread_mutex_unlock (&write_lock);
719 (void) plugin_set_ctx (q->ctx);
724 } /* }}} value_list_t *plugin_write_dequeue */
726 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
730 value_list_t *vl = plugin_write_dequeue ();
734 plugin_dispatch_values_internal (vl);
736 plugin_value_list_free (vl);
741 } /* }}} void *plugin_write_thread */
743 static void start_write_threads (size_t num) /* {{{ */
747 if (write_threads != NULL)
750 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
751 if (write_threads == NULL)
753 ERROR ("plugin: start_write_threads: calloc failed.");
757 write_threads_num = 0;
758 for (i = 0; i < num; i++)
762 status = pthread_create (write_threads + write_threads_num,
769 ERROR ("plugin: start_write_threads: pthread_create failed "
770 "with status %i (%s).", status,
771 sstrerror (status, errbuf, sizeof (errbuf)));
777 } /* }}} void start_write_threads */
779 static void stop_write_threads (void) /* {{{ */
784 if (write_threads == NULL)
787 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
789 pthread_mutex_lock (&write_lock);
791 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
792 pthread_cond_broadcast (&write_cond);
793 pthread_mutex_unlock (&write_lock);
795 for (i = 0; i < write_threads_num; i++)
797 if (pthread_join (write_threads[i], NULL) != 0)
799 ERROR ("plugin: stop_write_threads: pthread_join failed.");
801 write_threads[i] = (pthread_t) 0;
803 sfree (write_threads);
804 write_threads_num = 0;
806 pthread_mutex_lock (&write_lock);
808 for (q = write_queue_head; q != NULL; )
810 write_queue_t *q1 = q;
811 plugin_value_list_free (q->vl);
816 write_queue_head = NULL;
817 write_queue_tail = NULL;
818 write_queue_length = 0;
819 pthread_mutex_unlock (&write_lock);
823 WARNING ("plugin: %i value list%s left after shutting down "
824 "the write threads.",
825 i, (i == 1) ? " was" : "s were");
827 } /* }}} void stop_write_threads */
832 void plugin_set_dir (const char *dir)
834 if (plugindir != NULL)
839 else if ((plugindir = strdup (dir)) == NULL)
842 ERROR ("strdup failed: %s",
843 sstrerror (errno, errbuf, sizeof (errbuf)));
847 static _Bool plugin_is_loaded (char const *name)
851 if (plugins_loaded == NULL)
852 plugins_loaded = c_avl_create ((void *) strcasecmp);
853 assert (plugins_loaded != NULL);
855 status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
856 return (status == 0);
859 static int plugin_mark_loaded (char const *name)
864 name_copy = strdup (name);
865 if (name_copy == NULL)
868 status = c_avl_insert (plugins_loaded,
869 /* key = */ name_copy, /* value = */ NULL);
873 static void plugin_free_loaded ()
878 if (plugins_loaded == NULL)
881 while (c_avl_pick (plugins_loaded, &key, &value) == 0)
884 assert (value == NULL);
887 c_avl_destroy (plugins_loaded);
888 plugins_loaded = NULL;
892 int plugin_load (char const *plugin_name, uint32_t flags)
896 char filename[BUFSIZE] = "";
897 char typename[BUFSIZE];
903 if (plugin_name == NULL)
906 /* Check if plugin is already loaded and don't do anything in this
908 if (plugin_is_loaded (plugin_name))
911 dir = plugin_get_dir ();
915 * XXX: Magic at work:
917 * Some of the language bindings, for example the Python and Perl
918 * plugins, need to be able to export symbols to the scripts they run.
919 * For this to happen, the "Globals" flag needs to be set.
920 * Unfortunately, this technical detail is hard to explain to the
921 * average user and she shouldn't have to worry about this, ideally.
922 * So in order to save everyone's sanity use a different default for a
923 * handful of special plugins. --octo
925 if ((strcasecmp ("perl", plugin_name) == 0)
926 || (strcasecmp ("python", plugin_name) == 0))
927 flags |= PLUGIN_FLAGS_GLOBAL;
929 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
930 * type when matching the filename */
931 status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
932 if ((status < 0) || ((size_t) status >= sizeof (typename)))
934 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
938 if ((dh = opendir (dir)) == NULL)
941 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
942 sstrerror (errno, errbuf, sizeof (errbuf)));
946 while ((de = readdir (dh)) != NULL)
948 if (strcasecmp (de->d_name, typename))
951 status = ssnprintf (filename, sizeof (filename),
952 "%s/%s", dir, de->d_name);
953 if ((status < 0) || ((size_t) status >= sizeof (filename)))
955 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
960 if (lstat (filename, &statbuf) == -1)
963 WARNING ("plugin_load: stat (\"%s\") failed: %s",
965 sstrerror (errno, errbuf, sizeof (errbuf)));
968 else if (!S_ISREG (statbuf.st_mode))
970 /* don't follow symlinks */
971 WARNING ("plugin_load: %s is not a regular file.",
976 status = plugin_load_file (filename, flags);
980 plugin_mark_loaded (plugin_name);
986 ERROR ("plugin_load: Load plugin \"%s\" failed with "
987 "status %i.", plugin_name, status);
993 if (filename[0] == 0)
994 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
1001 * The `register_*' functions follow
1003 int plugin_register_config (const char *name,
1004 int (*callback) (const char *key, const char *val),
1005 const char **keys, int keys_num)
1007 cf_register (name, callback, keys, keys_num);
1009 } /* int plugin_register_config */
1011 int plugin_register_complex_config (const char *type,
1012 int (*callback) (oconfig_item_t *))
1014 return (cf_register_complex (type, callback));
1015 } /* int plugin_register_complex_config */
1017 int plugin_register_init (const char *name,
1018 int (*callback) (void))
1020 return (create_register_callback (&list_init, name, (void *) callback,
1021 /* user_data = */ NULL));
1022 } /* plugin_register_init */
1024 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1026 const read_func_t *rf0;
1027 const read_func_t *rf1;
1032 if (rf0->rf_next_read < rf1->rf_next_read)
1034 else if (rf0->rf_next_read > rf1->rf_next_read)
1038 } /* int plugin_compare_read_func */
1040 /* Add a read function to both, the heap and a linked list. The linked list if
1041 * used to look-up read functions, especially for the remove function. The heap
1042 * is used to determine which plugin to read next. */
1043 static int plugin_insert_read (read_func_t *rf)
1048 rf->rf_next_read = cdtime ();
1049 rf->rf_effective_interval = rf->rf_interval;
1051 pthread_mutex_lock (&read_lock);
1053 if (read_list == NULL)
1055 read_list = llist_create ();
1056 if (read_list == NULL)
1058 pthread_mutex_unlock (&read_lock);
1059 ERROR ("plugin_insert_read: read_list failed.");
1064 if (read_heap == NULL)
1066 read_heap = c_heap_create (plugin_compare_read_func);
1067 if (read_heap == NULL)
1069 pthread_mutex_unlock (&read_lock);
1070 ERROR ("plugin_insert_read: c_heap_create failed.");
1075 le = llist_search (read_list, rf->rf_name);
1078 pthread_mutex_unlock (&read_lock);
1079 WARNING ("The read function \"%s\" is already registered. "
1080 "Check for duplicate \"LoadPlugin\" lines "
1081 "in your configuration!",
1086 le = llentry_create (rf->rf_name, rf);
1089 pthread_mutex_unlock (&read_lock);
1090 ERROR ("plugin_insert_read: llentry_create failed.");
1094 status = c_heap_insert (read_heap, rf);
1097 pthread_mutex_unlock (&read_lock);
1098 ERROR ("plugin_insert_read: c_heap_insert failed.");
1099 llentry_destroy (le);
1103 /* This does not fail. */
1104 llist_append (read_list, le);
1106 /* Wake up all the read threads. */
1107 pthread_cond_broadcast (&read_cond);
1108 pthread_mutex_unlock (&read_lock);
1110 } /* int plugin_insert_read */
1112 int plugin_register_read (const char *name,
1113 int (*callback) (void))
1118 rf = malloc (sizeof (*rf));
1121 ERROR ("plugin_register_read: malloc failed.");
1125 memset (rf, 0, sizeof (read_func_t));
1126 rf->rf_callback = (void *) callback;
1127 rf->rf_udata.data = NULL;
1128 rf->rf_udata.free_func = NULL;
1129 rf->rf_ctx = plugin_get_ctx ();
1130 rf->rf_group[0] = '\0';
1131 rf->rf_name = strdup (name);
1132 rf->rf_type = RF_SIMPLE;
1133 rf->rf_interval = plugin_get_interval ();
1135 status = plugin_insert_read (rf);
1140 } /* int plugin_register_read */
1142 int plugin_register_complex_read (const char *group, const char *name,
1143 plugin_read_cb callback,
1144 const struct timespec *interval,
1145 user_data_t *user_data)
1150 rf = malloc (sizeof (*rf));
1153 ERROR ("plugin_register_complex_read: malloc failed.");
1157 memset (rf, 0, sizeof (read_func_t));
1158 rf->rf_callback = (void *) callback;
1160 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1162 rf->rf_group[0] = '\0';
1163 rf->rf_name = strdup (name);
1164 rf->rf_type = RF_COMPLEX;
1165 if (interval != NULL)
1166 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1168 rf->rf_interval = plugin_get_interval ();
1171 if (user_data == NULL)
1173 rf->rf_udata.data = NULL;
1174 rf->rf_udata.free_func = NULL;
1178 rf->rf_udata = *user_data;
1181 rf->rf_ctx = plugin_get_ctx ();
1183 status = plugin_insert_read (rf);
1188 } /* int plugin_register_complex_read */
1190 int plugin_register_write (const char *name,
1191 plugin_write_cb callback, user_data_t *ud)
1193 return (create_register_callback (&list_write, name,
1194 (void *) callback, ud));
1195 } /* int plugin_register_write */
1197 int plugin_register_flush (const char *name,
1198 plugin_flush_cb callback, user_data_t *ud)
1200 return (create_register_callback (&list_flush, name,
1201 (void *) callback, ud));
1202 } /* int plugin_register_flush */
1204 int plugin_register_missing (const char *name,
1205 plugin_missing_cb callback, user_data_t *ud)
1207 return (create_register_callback (&list_missing, name,
1208 (void *) callback, ud));
1209 } /* int plugin_register_missing */
1211 int plugin_register_shutdown (const char *name,
1212 int (*callback) (void))
1214 return (create_register_callback (&list_shutdown, name,
1215 (void *) callback, /* user_data = */ NULL));
1216 } /* int plugin_register_shutdown */
1218 static void plugin_free_data_sets (void)
1223 if (data_sets == NULL)
1226 while (c_avl_pick (data_sets, &key, &value) == 0)
1228 data_set_t *ds = value;
1229 /* key is a pointer to ds->type */
1235 c_avl_destroy (data_sets);
1237 } /* void plugin_free_data_sets */
1239 int plugin_register_data_set (const data_set_t *ds)
1241 data_set_t *ds_copy;
1244 if ((data_sets != NULL)
1245 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1247 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1248 plugin_unregister_data_set (ds->type);
1250 else if (data_sets == NULL)
1252 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1253 if (data_sets == NULL)
1257 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1258 if (ds_copy == NULL)
1260 memcpy(ds_copy, ds, sizeof (data_set_t));
1262 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1264 if (ds_copy->ds == NULL)
1270 for (i = 0; i < ds->ds_num; i++)
1271 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1273 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1274 } /* int plugin_register_data_set */
1276 int plugin_register_log (const char *name,
1277 plugin_log_cb callback, user_data_t *ud)
1279 return (create_register_callback (&list_log, name,
1280 (void *) callback, ud));
1281 } /* int plugin_register_log */
1283 int plugin_register_notification (const char *name,
1284 plugin_notification_cb callback, user_data_t *ud)
1286 return (create_register_callback (&list_notification, name,
1287 (void *) callback, ud));
1288 } /* int plugin_register_log */
1290 int plugin_unregister_config (const char *name)
1292 cf_unregister (name);
1294 } /* int plugin_unregister_config */
1296 int plugin_unregister_complex_config (const char *name)
1298 cf_unregister_complex (name);
1300 } /* int plugin_unregister_complex_config */
1302 int plugin_unregister_init (const char *name)
1304 return (plugin_unregister (list_init, name));
1307 int plugin_unregister_read (const char *name) /* {{{ */
1315 pthread_mutex_lock (&read_lock);
1317 if (read_list == NULL)
1319 pthread_mutex_unlock (&read_lock);
1323 le = llist_search (read_list, name);
1326 pthread_mutex_unlock (&read_lock);
1327 WARNING ("plugin_unregister_read: No such read function: %s",
1332 llist_remove (read_list, le);
1335 assert (rf != NULL);
1336 rf->rf_type = RF_REMOVE;
1338 pthread_mutex_unlock (&read_lock);
1340 llentry_destroy (le);
1342 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1345 } /* }}} int plugin_unregister_read */
1347 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1349 read_func_t *rf = e->value;
1352 return strcmp (rf->rf_group, (const char *)group);
1353 } /* }}} int compare_read_func_group */
1355 int plugin_unregister_read_group (const char *group) /* {{{ */
1365 pthread_mutex_lock (&read_lock);
1367 if (read_list == NULL)
1369 pthread_mutex_unlock (&read_lock);
1375 le = llist_search_custom (read_list,
1376 compare_read_func_group, (void *)group);
1383 llist_remove (read_list, le);
1386 assert (rf != NULL);
1387 rf->rf_type = RF_REMOVE;
1389 llentry_destroy (le);
1391 DEBUG ("plugin_unregister_read_group: "
1392 "Marked `%s' (group `%s') for removal.",
1393 rf->rf_name, group);
1396 pthread_mutex_unlock (&read_lock);
1400 WARNING ("plugin_unregister_read_group: No such "
1401 "group of read function: %s", group);
1406 } /* }}} int plugin_unregister_read_group */
1408 int plugin_unregister_write (const char *name)
1410 return (plugin_unregister (list_write, name));
1413 int plugin_unregister_flush (const char *name)
1415 return (plugin_unregister (list_flush, name));
1418 int plugin_unregister_missing (const char *name)
1420 return (plugin_unregister (list_missing, name));
1423 int plugin_unregister_shutdown (const char *name)
1425 return (plugin_unregister (list_shutdown, name));
1428 int plugin_unregister_data_set (const char *name)
1432 if (data_sets == NULL)
1435 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1442 } /* int plugin_unregister_data_set */
1444 int plugin_unregister_log (const char *name)
1446 return (plugin_unregister (list_log, name));
1449 int plugin_unregister_notification (const char *name)
1451 return (plugin_unregister (list_notification, name));
1454 void plugin_init_all (void)
1456 char const *chain_name;
1457 long write_threads_num;
1461 /* Init the value cache */
1464 chain_name = global_option_get ("PreCacheChain");
1465 pre_cache_chain = fc_chain_get_by_name (chain_name);
1467 chain_name = global_option_get ("PostCacheChain");
1468 post_cache_chain = fc_chain_get_by_name (chain_name);
1470 write_limit_high = global_option_get_long ("WriteQueueLimitHigh",
1472 if (write_limit_high < 0)
1474 ERROR ("WriteQueueLimitHigh must be positive or zero.");
1475 write_limit_high = 0;
1478 write_limit_low = global_option_get_long ("WriteQueueLimitLow",
1479 /* default = */ write_limit_high / 2);
1480 if (write_limit_low < 0)
1482 ERROR ("WriteQueueLimitLow must be positive or zero.");
1483 write_limit_low = write_limit_high / 2;
1485 else if (write_limit_low > write_limit_high)
1487 ERROR ("WriteQueueLimitLow must not be larger than "
1488 "WriteQueueLimitHigh.");
1489 write_limit_low = write_limit_high;
1492 write_threads_num = global_option_get_long ("WriteThreads",
1494 if (write_threads_num < 1)
1496 ERROR ("WriteThreads must be positive.");
1497 write_threads_num = 5;
1500 start_write_threads ((size_t) write_threads_num);
1502 if ((list_init == NULL) && (read_heap == NULL))
1505 /* Calling all init callbacks before checking if read callbacks
1506 * are available allows the init callbacks to register the read
1508 le = llist_head (list_init);
1511 callback_func_t *cf;
1512 plugin_init_cb callback;
1513 plugin_ctx_t old_ctx;
1516 old_ctx = plugin_set_ctx (cf->cf_ctx);
1517 callback = cf->cf_callback;
1518 status = (*callback) ();
1519 plugin_set_ctx (old_ctx);
1523 ERROR ("Initialization of plugin `%s' "
1524 "failed with status %i. "
1525 "Plugin will be unloaded.",
1527 /* Plugins that register read callbacks from the init
1528 * callback should take care of appropriate error
1529 * handling themselves. */
1530 /* FIXME: Unload _all_ functions */
1531 plugin_unregister_read (le->key);
1537 /* Start read-threads */
1538 if (read_heap != NULL)
1542 rt = global_option_get ("ReadThreads");
1545 start_read_threads ((num > 0) ? num : 5);
1547 } /* void plugin_init_all */
1549 /* TODO: Rename this function. */
1550 void plugin_read_all (void)
1552 uc_check_timeout ();
1555 } /* void plugin_read_all */
1557 /* Read function called when the `-T' command line argument is given. */
1558 int plugin_read_all_once (void)
1561 int return_status = 0;
1563 if (read_heap == NULL)
1565 NOTICE ("No read-functions are registered.");
1572 plugin_ctx_t old_ctx;
1574 rf = c_heap_get_root (read_heap);
1578 old_ctx = plugin_set_ctx (rf->rf_ctx);
1580 if (rf->rf_type == RF_SIMPLE)
1582 int (*callback) (void);
1584 callback = rf->rf_callback;
1585 status = (*callback) ();
1589 plugin_read_cb callback;
1591 callback = rf->rf_callback;
1592 status = (*callback) (&rf->rf_udata);
1595 plugin_set_ctx (old_ctx);
1599 NOTICE ("read-function of plugin `%s' failed.",
1604 destroy_callback ((void *) rf);
1607 return (return_status);
1608 } /* int plugin_read_all_once */
1610 int plugin_write (const char *plugin, /* {{{ */
1611 const data_set_t *ds, const value_list_t *vl)
1619 if (list_write == NULL)
1624 ds = plugin_get_ds (vl->type);
1627 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1637 le = llist_head (list_write);
1640 callback_func_t *cf = le->value;
1641 plugin_write_cb callback;
1643 /* do not switch plugin context; rather keep the context (interval)
1644 * information of the calling read plugin */
1646 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1647 callback = cf->cf_callback;
1648 status = (*callback) (ds, vl, &cf->cf_udata);
1657 if ((success == 0) && (failure != 0))
1662 else /* plugin != NULL */
1664 callback_func_t *cf;
1665 plugin_write_cb callback;
1667 le = llist_head (list_write);
1670 if (strcasecmp (plugin, le->key) == 0)
1681 /* do not switch plugin context; rather keep the context (interval)
1682 * information of the calling read plugin */
1684 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1685 callback = cf->cf_callback;
1686 status = (*callback) (ds, vl, &cf->cf_udata);
1690 } /* }}} int plugin_write */
1692 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1696 if (list_flush == NULL)
1699 le = llist_head (list_flush);
1702 callback_func_t *cf;
1703 plugin_flush_cb callback;
1704 plugin_ctx_t old_ctx;
1706 if ((plugin != NULL)
1707 && (strcmp (plugin, le->key) != 0))
1714 old_ctx = plugin_set_ctx (cf->cf_ctx);
1715 callback = cf->cf_callback;
1717 (*callback) (timeout, identifier, &cf->cf_udata);
1719 plugin_set_ctx (old_ctx);
1724 } /* int plugin_flush */
1726 void plugin_shutdown_all (void)
1730 stop_read_threads ();
1732 destroy_all_callbacks (&list_init);
1734 pthread_mutex_lock (&read_lock);
1735 llist_destroy (read_list);
1737 pthread_mutex_unlock (&read_lock);
1739 destroy_read_heap ();
1741 plugin_flush (/* plugin = */ NULL,
1743 /* identifier = */ NULL);
1746 if (list_shutdown != NULL)
1747 le = llist_head (list_shutdown);
1751 callback_func_t *cf;
1752 plugin_shutdown_cb callback;
1753 plugin_ctx_t old_ctx;
1756 old_ctx = plugin_set_ctx (cf->cf_ctx);
1757 callback = cf->cf_callback;
1759 /* Advance the pointer before calling the callback allows
1760 * shutdown functions to unregister themselves. If done the
1761 * other way around the memory `le' points to will be freed
1762 * after callback returns. */
1767 plugin_set_ctx (old_ctx);
1770 stop_write_threads ();
1772 /* Write plugins which use the `user_data' pointer usually need the
1773 * same data available to the flush callback. If this is the case, set
1774 * the free_function to NULL when registering the flush callback and to
1775 * the real free function when registering the write callback. This way
1776 * the data isn't freed twice. */
1777 destroy_all_callbacks (&list_flush);
1778 destroy_all_callbacks (&list_missing);
1779 destroy_all_callbacks (&list_write);
1781 destroy_all_callbacks (&list_notification);
1782 destroy_all_callbacks (&list_shutdown);
1783 destroy_all_callbacks (&list_log);
1785 plugin_free_loaded ();
1786 plugin_free_data_sets ();
1787 } /* void plugin_shutdown_all */
1789 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1793 if (list_missing == NULL)
1796 le = llist_head (list_missing);
1799 callback_func_t *cf;
1800 plugin_missing_cb callback;
1801 plugin_ctx_t old_ctx;
1805 old_ctx = plugin_set_ctx (cf->cf_ctx);
1806 callback = cf->cf_callback;
1808 status = (*callback) (vl, &cf->cf_udata);
1809 plugin_set_ctx (old_ctx);
1814 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1815 "failed with status %i.",
1828 } /* int }}} plugin_dispatch_missing */
1830 static int plugin_dispatch_values_internal (value_list_t *vl)
1833 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1835 value_t *saved_values;
1836 int saved_values_len;
1840 int free_meta_data = 0;
1842 if ((vl == NULL) || (vl->type[0] == 0)
1843 || (vl->values == NULL) || (vl->values_len < 1))
1845 ERROR ("plugin_dispatch_values: Invalid value list "
1846 "from plugin %s.", vl->plugin);
1850 /* Free meta data only if the calling function didn't specify any. In
1851 * this case matches and targets may add some and the calling function
1852 * may not expect (and therefore free) that data. */
1853 if (vl->meta == NULL)
1856 if (list_write == NULL)
1857 c_complain_once (LOG_WARNING, &no_write_complaint,
1858 "plugin_dispatch_values: No write callback has been "
1859 "registered. Please load at least one output plugin, "
1860 "if you want the collected data to be stored.");
1862 if (data_sets == NULL)
1864 ERROR ("plugin_dispatch_values: No data sets registered. "
1865 "Could the types database be read? Check "
1866 "your `TypesDB' setting!");
1870 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1872 char ident[6 * DATA_MAX_NAME_LEN];
1874 FORMAT_VL (ident, sizeof (ident), vl);
1875 INFO ("plugin_dispatch_values: Dataset not found: %s "
1876 "(from \"%s\"), check your types.db!",
1881 /* Assured by plugin_value_list_clone(). The time is determined at
1882 * _enqueue_ time. */
1883 assert (vl->time != 0);
1884 assert (vl->interval != 0);
1886 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1888 "plugin = %s; plugin_instance = %s; "
1889 "type = %s; type_instance = %s;",
1890 CDTIME_T_TO_DOUBLE (vl->time),
1891 CDTIME_T_TO_DOUBLE (vl->interval),
1893 vl->plugin, vl->plugin_instance,
1894 vl->type, vl->type_instance);
1897 assert (0 == strcmp (ds->type, vl->type));
1899 if (0 != strcmp (ds->type, vl->type))
1900 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1901 ds->type, vl->type);
1905 assert (ds->ds_num == vl->values_len);
1907 if (ds->ds_num != vl->values_len)
1909 ERROR ("plugin_dispatch_values: ds->type = %s: "
1910 "(ds->ds_num = %i) != "
1911 "(vl->values_len = %i)",
1912 ds->type, ds->ds_num, vl->values_len);
1917 escape_slashes (vl->host, sizeof (vl->host));
1918 escape_slashes (vl->plugin, sizeof (vl->plugin));
1919 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1920 escape_slashes (vl->type, sizeof (vl->type));
1921 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1923 /* Copy the values. This way, we can assure `targets' that they get
1924 * dynamically allocated values, which they can free and replace if
1926 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1928 saved_values = vl->values;
1929 saved_values_len = vl->values_len;
1931 vl->values = (value_t *) calloc (vl->values_len,
1932 sizeof (*vl->values));
1933 if (vl->values == NULL)
1935 ERROR ("plugin_dispatch_values: calloc failed.");
1936 vl->values = saved_values;
1939 memcpy (vl->values, saved_values,
1940 vl->values_len * sizeof (*vl->values));
1942 else /* if ((pre == NULL) && (post == NULL)) */
1944 saved_values = NULL;
1945 saved_values_len = 0;
1948 if (pre_cache_chain != NULL)
1950 status = fc_process_chain (ds, vl, pre_cache_chain);
1953 WARNING ("plugin_dispatch_values: Running the "
1954 "pre-cache chain failed with "
1958 else if (status == FC_TARGET_STOP)
1960 /* Restore the state of the value_list so that plugins
1961 * don't get confused.. */
1962 if (saved_values != NULL)
1965 vl->values = saved_values;
1966 vl->values_len = saved_values_len;
1972 /* Update the value cache */
1975 if (post_cache_chain != NULL)
1977 status = fc_process_chain (ds, vl, post_cache_chain);
1980 WARNING ("plugin_dispatch_values: Running the "
1981 "post-cache chain failed with "
1987 fc_default_action (ds, vl);
1989 /* Restore the state of the value_list so that plugins don't get
1991 if (saved_values != NULL)
1994 vl->values = saved_values;
1995 vl->values_len = saved_values_len;
1998 if ((free_meta_data != 0) && (vl->meta != NULL))
2000 meta_data_destroy (vl->meta);
2005 } /* int plugin_dispatch_values_internal */
2007 static double get_drop_probability (void) /* {{{ */
2013 pthread_mutex_lock (&write_lock);
2014 wql = write_queue_length;
2015 pthread_mutex_unlock (&write_lock);
2017 if (wql < write_limit_low)
2019 if (wql >= write_limit_high)
2022 pos = 1 + wql - write_limit_low;
2023 size = 1 + write_limit_high - write_limit_low;
2025 return (((double) pos) / ((double) size));
2026 } /* }}} double get_drop_probability */
2028 static _Bool check_drop_value (void) /* {{{ */
2030 static cdtime_t last_message_time = 0;
2031 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2037 if (write_limit_high == 0)
2040 p = get_drop_probability ();
2044 status = pthread_mutex_trylock (&last_message_lock);
2050 if ((now - last_message_time) > TIME_T_TO_CDTIME_T (1))
2052 last_message_time = now;
2053 ERROR ("plugin_dispatch_values: Low water mark "
2054 "reached. Dropping %.0f%% of metrics.",
2057 pthread_mutex_unlock (&last_message_lock);
2068 } /* }}} _Bool check_drop_value */
2070 int plugin_dispatch_values (value_list_t const *vl)
2074 if (check_drop_value ())
2077 status = plugin_write_enqueue (vl);
2081 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
2082 "with status %i (%s).", status,
2083 sstrerror (status, errbuf, sizeof (errbuf)));
2090 int plugin_dispatch_notification (const notification_t *notif)
2093 /* Possible TODO: Add flap detection here */
2095 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
2096 "time = %.3f; host = %s;",
2097 notif->severity, notif->message,
2098 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
2100 /* Nobody cares for notifications */
2101 if (list_notification == NULL)
2104 le = llist_head (list_notification);
2107 callback_func_t *cf;
2108 plugin_notification_cb callback;
2111 /* do not switch plugin context; rather keep the context
2112 * (interval) information of the calling plugin */
2115 callback = cf->cf_callback;
2116 status = (*callback) (notif, &cf->cf_udata);
2119 WARNING ("plugin_dispatch_notification: Notification "
2120 "callback %s returned %i.",
2128 } /* int plugin_dispatch_notification */
2130 void plugin_log (int level, const char *format, ...)
2137 if (level >= LOG_DEBUG)
2141 va_start (ap, format);
2142 vsnprintf (msg, sizeof (msg), format, ap);
2143 msg[sizeof (msg) - 1] = '\0';
2146 if (list_log == NULL)
2148 fprintf (stderr, "%s\n", msg);
2152 le = llist_head (list_log);
2155 callback_func_t *cf;
2156 plugin_log_cb callback;
2159 callback = cf->cf_callback;
2161 /* do not switch plugin context; rather keep the context
2162 * (interval) information of the calling plugin */
2164 (*callback) (level, msg, &cf->cf_udata);
2168 } /* void plugin_log */
2170 int parse_log_severity (const char *severity)
2174 if ((0 == strcasecmp (severity, "emerg"))
2175 || (0 == strcasecmp (severity, "alert"))
2176 || (0 == strcasecmp (severity, "crit"))
2177 || (0 == strcasecmp (severity, "err")))
2178 log_level = LOG_ERR;
2179 else if (0 == strcasecmp (severity, "warning"))
2180 log_level = LOG_WARNING;
2181 else if (0 == strcasecmp (severity, "notice"))
2182 log_level = LOG_NOTICE;
2183 else if (0 == strcasecmp (severity, "info"))
2184 log_level = LOG_INFO;
2186 else if (0 == strcasecmp (severity, "debug"))
2187 log_level = LOG_DEBUG;
2188 #endif /* COLLECT_DEBUG */
2191 } /* int parse_log_severity */
2193 int parse_notif_severity (const char *severity)
2195 int notif_severity = -1;
2197 if (strcasecmp (severity, "FAILURE") == 0)
2198 notif_severity = NOTIF_FAILURE;
2199 else if (strcmp (severity, "OKAY") == 0)
2200 notif_severity = NOTIF_OKAY;
2201 else if ((strcmp (severity, "WARNING") == 0)
2202 || (strcmp (severity, "WARN") == 0))
2203 notif_severity = NOTIF_WARNING;
2205 return (notif_severity);
2206 } /* int parse_notif_severity */
2208 const data_set_t *plugin_get_ds (const char *name)
2212 if (data_sets == NULL)
2214 ERROR ("plugin_get_ds: No data sets are defined yet.");
2218 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2220 DEBUG ("No such dataset registered: %s", name);
2225 } /* data_set_t *plugin_get_ds */
2227 static int plugin_notification_meta_add (notification_t *n,
2229 enum notification_meta_type_e type,
2232 notification_meta_t *meta;
2233 notification_meta_t *tail;
2235 if ((n == NULL) || (name == NULL) || (value == NULL))
2237 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2241 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2244 ERROR ("plugin_notification_meta_add: malloc failed.");
2247 memset (meta, 0, sizeof (notification_meta_t));
2249 sstrncpy (meta->name, name, sizeof (meta->name));
2254 case NM_TYPE_STRING:
2256 meta->nm_value.nm_string = strdup ((const char *) value);
2257 if (meta->nm_value.nm_string == NULL)
2259 ERROR ("plugin_notification_meta_add: strdup failed.");
2265 case NM_TYPE_SIGNED_INT:
2267 meta->nm_value.nm_signed_int = *((int64_t *) value);
2270 case NM_TYPE_UNSIGNED_INT:
2272 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2275 case NM_TYPE_DOUBLE:
2277 meta->nm_value.nm_double = *((double *) value);
2280 case NM_TYPE_BOOLEAN:
2282 meta->nm_value.nm_boolean = *((_Bool *) value);
2287 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2291 } /* switch (type) */
2295 while ((tail != NULL) && (tail->next != NULL))
2304 } /* int plugin_notification_meta_add */
2306 int plugin_notification_meta_add_string (notification_t *n,
2310 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2313 int plugin_notification_meta_add_signed_int (notification_t *n,
2317 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2320 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2324 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2327 int plugin_notification_meta_add_double (notification_t *n,
2331 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2334 int plugin_notification_meta_add_boolean (notification_t *n,
2338 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2341 int plugin_notification_meta_copy (notification_t *dst,
2342 const notification_t *src)
2344 notification_meta_t *meta;
2346 assert (dst != NULL);
2347 assert (src != NULL);
2348 assert (dst != src);
2349 assert ((src->meta == NULL) || (src->meta != dst->meta));
2351 for (meta = src->meta; meta != NULL; meta = meta->next)
2353 if (meta->type == NM_TYPE_STRING)
2354 plugin_notification_meta_add_string (dst, meta->name,
2355 meta->nm_value.nm_string);
2356 else if (meta->type == NM_TYPE_SIGNED_INT)
2357 plugin_notification_meta_add_signed_int (dst, meta->name,
2358 meta->nm_value.nm_signed_int);
2359 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2360 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2361 meta->nm_value.nm_unsigned_int);
2362 else if (meta->type == NM_TYPE_DOUBLE)
2363 plugin_notification_meta_add_double (dst, meta->name,
2364 meta->nm_value.nm_double);
2365 else if (meta->type == NM_TYPE_BOOLEAN)
2366 plugin_notification_meta_add_boolean (dst, meta->name,
2367 meta->nm_value.nm_boolean);
2371 } /* int plugin_notification_meta_copy */
2373 int plugin_notification_meta_free (notification_meta_t *n)
2375 notification_meta_t *this;
2376 notification_meta_t *next;
2380 ERROR ("plugin_notification_meta_free: n == NULL!");
2385 while (this != NULL)
2389 if (this->type == NM_TYPE_STRING)
2391 free ((char *)this->nm_value.nm_string);
2392 this->nm_value.nm_string = NULL;
2400 } /* int plugin_notification_meta_free */
2402 static void plugin_ctx_destructor (void *ctx)
2405 } /* void plugin_ctx_destructor */
2407 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2409 static plugin_ctx_t *plugin_ctx_create (void)
2413 ctx = malloc (sizeof (*ctx));
2416 ERROR ("Failed to allocate plugin context: %s",
2417 sstrerror (errno, errbuf, sizeof (errbuf)));
2422 assert (plugin_ctx_key_initialized);
2423 pthread_setspecific (plugin_ctx_key, ctx);
2424 DEBUG("Created new plugin context.");
2426 } /* int plugin_ctx_create */
2428 void plugin_init_ctx (void)
2430 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2431 plugin_ctx_key_initialized = 1;
2432 } /* void plugin_init_ctx */
2434 plugin_ctx_t plugin_get_ctx (void)
2438 assert (plugin_ctx_key_initialized);
2439 ctx = pthread_getspecific (plugin_ctx_key);
2442 ctx = plugin_ctx_create ();
2443 /* this must no happen -- exit() instead? */
2449 } /* plugin_ctx_t plugin_get_ctx */
2451 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2456 assert (plugin_ctx_key_initialized);
2457 c = pthread_getspecific (plugin_ctx_key);
2460 c = plugin_ctx_create ();
2461 /* this must no happen -- exit() instead? */
2470 } /* void plugin_set_ctx */
2472 cdtime_t plugin_get_interval (void)
2476 interval = plugin_get_ctx().interval;
2480 return cf_get_default_interval ();
2481 } /* cdtime_t plugin_get_interval */
2485 void *(*start_routine) (void *);
2489 static void *plugin_thread_start (void *arg)
2491 plugin_thread_t *plugin_thread = arg;
2493 void *(*start_routine) (void *) = plugin_thread->start_routine;
2494 void *plugin_arg = plugin_thread->arg;
2496 plugin_set_ctx (plugin_thread->ctx);
2498 free (plugin_thread);
2500 return start_routine (plugin_arg);
2501 } /* void *plugin_thread_start */
2503 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2504 void *(*start_routine) (void *), void *arg)
2506 plugin_thread_t *plugin_thread;
2508 plugin_thread = malloc (sizeof (*plugin_thread));
2509 if (plugin_thread == NULL)
2512 plugin_thread->ctx = plugin_get_ctx ();
2513 plugin_thread->start_routine = start_routine;
2514 plugin_thread->arg = arg;
2516 return pthread_create (thread, attr,
2517 plugin_thread_start, plugin_thread);
2518 } /* int plugin_thread_create */
2520 /* vim: set sw=8 ts=8 noet fdm=marker : */