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"
44 struct callback_func_s
50 typedef struct callback_func_s callback_func_t;
54 #define RF_REMOVE 65535
57 /* `read_func_t' "inherits" from `callback_func_t'.
58 * The `rf_super' member MUST be the first one in this structure! */
59 #define rf_callback rf_super.cf_callback
60 #define rf_udata rf_super.cf_udata
61 #define rf_ctx rf_super.cf_ctx
62 callback_func_t rf_super;
63 char rf_group[DATA_MAX_NAME_LEN];
67 cdtime_t rf_effective_interval;
68 cdtime_t rf_next_read;
70 typedef struct read_func_s read_func_t;
73 typedef struct write_queue_s write_queue_t;
84 static c_avl_tree_t *plugins_loaded = NULL;
86 static llist_t *list_init;
87 static llist_t *list_write;
88 static llist_t *list_flush;
89 static llist_t *list_missing;
90 static llist_t *list_shutdown;
91 static llist_t *list_log;
92 static llist_t *list_notification;
94 static fc_chain_t *pre_cache_chain = NULL;
95 static fc_chain_t *post_cache_chain = NULL;
97 static c_avl_tree_t *data_sets;
99 static char *plugindir = NULL;
101 static c_heap_t *read_heap = NULL;
102 static llist_t *read_list;
103 static int read_loop = 1;
104 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
105 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
106 static pthread_t *read_threads = NULL;
107 static int read_threads_num = 0;
109 static write_queue_t *write_queue_head;
110 static write_queue_t *write_queue_tail;
111 static _Bool write_loop = 1;
112 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
113 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
114 static pthread_t *write_threads = NULL;
115 static size_t write_threads_num = 0;
117 static pthread_key_t plugin_ctx_key;
118 static _Bool plugin_ctx_key_initialized = 0;
123 static int plugin_dispatch_values_internal (value_list_t *vl);
125 static const char *plugin_get_dir (void)
127 if (plugindir == NULL)
133 static void destroy_callback (callback_func_t *cf) /* {{{ */
138 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
140 cf->cf_udata.free_func (cf->cf_udata.data);
141 cf->cf_udata.data = NULL;
142 cf->cf_udata.free_func = NULL;
145 } /* }}} void destroy_callback */
147 static void destroy_all_callbacks (llist_t **list) /* {{{ */
154 le = llist_head (*list);
162 destroy_callback (le->value);
168 llist_destroy (*list);
170 } /* }}} void destroy_all_callbacks */
172 static void destroy_read_heap (void) /* {{{ */
174 if (read_heap == NULL)
181 cf = c_heap_get_root (read_heap);
185 destroy_callback (cf);
188 c_heap_destroy (read_heap);
190 } /* }}} void destroy_read_heap */
192 static int register_callback (llist_t **list, /* {{{ */
193 const char *name, callback_func_t *cf)
200 *list = llist_create ();
203 ERROR ("plugin: register_callback: "
204 "llist_create failed.");
205 destroy_callback (cf);
213 ERROR ("plugin: register_callback: strdup failed.");
214 destroy_callback (cf);
218 le = llist_search (*list, name);
221 le = llentry_create (key, cf);
224 ERROR ("plugin: register_callback: "
225 "llentry_create failed.");
227 destroy_callback (cf);
231 llist_append (*list, le);
235 callback_func_t *old_cf;
240 WARNING ("plugin: register_callback: "
241 "a callback named `%s' already exists - "
242 "overwriting the old entry!", name);
244 destroy_callback (old_cf);
249 } /* }}} int register_callback */
251 static int create_register_callback (llist_t **list, /* {{{ */
252 const char *name, void *callback, user_data_t *ud)
256 cf = (callback_func_t *) malloc (sizeof (*cf));
259 ERROR ("plugin: create_register_callback: malloc failed.");
262 memset (cf, 0, sizeof (*cf));
264 cf->cf_callback = callback;
267 cf->cf_udata.data = NULL;
268 cf->cf_udata.free_func = NULL;
275 cf->cf_ctx = plugin_get_ctx ();
277 return (register_callback (list, name, cf));
278 } /* }}} int create_register_callback */
280 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
287 e = llist_search (list, name);
291 llist_remove (list, e);
294 destroy_callback (e->value);
299 } /* }}} int plugin_unregister */
302 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
303 * object, but it will bitch about a shared object not having a
304 * ``module_register'' symbol..
306 static int plugin_load_file (char *file, uint32_t flags)
309 void (*reg_handle) (void);
312 lt_dlerror (); /* clear errors */
314 #if LIBTOOL_VERSION == 2
315 if (flags & PLUGIN_FLAGS_GLOBAL) {
317 lt_dladvise_init(&advise);
318 lt_dladvise_global(&advise);
319 dlh = lt_dlopenadvise(file, advise);
320 lt_dladvise_destroy(&advise);
322 dlh = lt_dlopen (file);
324 #else /* if LIBTOOL_VERSION == 1 */
325 if (flags & PLUGIN_FLAGS_GLOBAL)
326 WARNING ("plugin_load_file: The global flag is not supported, "
327 "libtool 2 is required for this.");
328 dlh = lt_dlopen (file);
333 char errbuf[1024] = "";
335 ssnprintf (errbuf, sizeof (errbuf),
336 "lt_dlopen (\"%s\") failed: %s. "
337 "The most common cause for this problem are "
338 "missing dependencies. Use ldd(1) to check "
339 "the dependencies of the plugin "
341 file, lt_dlerror ());
343 ERROR ("%s", errbuf);
344 /* Make sure this is printed to STDERR in any case, but also
345 * make sure it's printed only once. */
346 if (list_log != NULL)
347 fprintf (stderr, "ERROR: %s\n", errbuf);
352 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
354 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
355 file, lt_dlerror ());
365 static void *plugin_read_thread (void __attribute__((unused)) *args)
367 while (read_loop != 0)
370 plugin_ctx_t old_ctx;
376 /* Get the read function that needs to be read next.
377 * We don't need to hold "read_lock" for the heap, but we need
378 * to call c_heap_get_root() and pthread_cond_wait() in the
379 * same protected block. */
380 pthread_mutex_lock (&read_lock);
381 rf = c_heap_get_root (read_heap);
384 pthread_cond_wait (&read_cond, &read_lock);
385 pthread_mutex_unlock (&read_lock);
388 pthread_mutex_unlock (&read_lock);
390 if (rf->rf_interval == 0)
392 /* this should not happen, because the interval is set
393 * for each plugin when loading it
394 * XXX: issue a warning? */
395 rf->rf_interval = plugin_get_interval ();
396 rf->rf_effective_interval = rf->rf_interval;
398 rf->rf_next_read = cdtime ();
401 /* sleep until this entry is due,
402 * using pthread_cond_timedwait */
403 pthread_mutex_lock (&read_lock);
404 /* In pthread_cond_timedwait, spurious wakeups are possible
405 * (and really happen, at least on NetBSD with > 1 CPU), thus
406 * we need to re-evaluate the condition every time
407 * pthread_cond_timedwait returns. */
409 while ((read_loop != 0)
410 && (cdtime () < rf->rf_next_read)
413 struct timespec ts = { 0 };
415 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
417 rc = pthread_cond_timedwait (&read_cond, &read_lock,
421 /* Must hold `read_lock' when accessing `rf->rf_type'. */
422 rf_type = rf->rf_type;
423 pthread_mutex_unlock (&read_lock);
425 /* Check if we're supposed to stop.. This may have interrupted
429 /* Insert `rf' again, so it can be free'd correctly */
430 c_heap_insert (read_heap, rf);
434 /* The entry has been marked for deletion. The linked list
435 * entry has already been removed by `plugin_unregister_read'.
436 * All we have to do here is free the `read_func_t' and
438 if (rf_type == RF_REMOVE)
440 DEBUG ("plugin_read_thread: Destroying the `%s' "
441 "callback.", rf->rf_name);
443 destroy_callback ((callback_func_t *) rf);
448 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
450 old_ctx = plugin_set_ctx (rf->rf_ctx);
452 if (rf_type == RF_SIMPLE)
454 int (*callback) (void);
456 callback = rf->rf_callback;
457 status = (*callback) ();
461 plugin_read_cb callback;
463 assert (rf_type == RF_COMPLEX);
465 callback = rf->rf_callback;
466 status = (*callback) (&rf->rf_udata);
469 plugin_set_ctx (old_ctx);
471 /* If the function signals failure, we will increase the
472 * intervals in which it will be called. */
475 rf->rf_effective_interval *= 2;
476 if (rf->rf_effective_interval > TIME_T_TO_CDTIME_T (86400))
477 rf->rf_effective_interval = TIME_T_TO_CDTIME_T (86400);
479 NOTICE ("read-function of plugin `%s' failed. "
480 "Will suspend it for %.3f seconds.",
482 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
486 /* Success: Restore the interval, if it was changed. */
487 rf->rf_effective_interval = rf->rf_interval;
490 /* update the ``next read due'' field */
493 DEBUG ("plugin_read_thread: Effective interval of the "
494 "%s plugin is %.3f seconds.",
496 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
498 /* Calculate the next (absolute) time at which this function
499 * should be called. */
500 rf->rf_next_read += rf->rf_effective_interval;
502 /* Check, if `rf_next_read' is in the past. */
503 if (rf->rf_next_read < now)
505 /* `rf_next_read' is in the past. Insert `now'
506 * so this value doesn't trail off into the
508 rf->rf_next_read = now;
511 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
513 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
515 /* Re-insert this read function into the heap again. */
516 c_heap_insert (read_heap, rf);
517 } /* while (read_loop) */
521 } /* void *plugin_read_thread */
523 static void start_read_threads (int num)
527 if (read_threads != NULL)
530 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
531 if (read_threads == NULL)
533 ERROR ("plugin: start_read_threads: calloc failed.");
537 read_threads_num = 0;
538 for (i = 0; i < num; i++)
540 if (pthread_create (read_threads + read_threads_num, NULL,
541 plugin_read_thread, NULL) == 0)
547 ERROR ("plugin: start_read_threads: pthread_create failed.");
551 } /* void start_read_threads */
553 static void stop_read_threads (void)
557 if (read_threads == NULL)
560 INFO ("collectd: Stopping %i read threads.", read_threads_num);
562 pthread_mutex_lock (&read_lock);
564 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
565 pthread_cond_broadcast (&read_cond);
566 pthread_mutex_unlock (&read_lock);
568 for (i = 0; i < read_threads_num; i++)
570 if (pthread_join (read_threads[i], NULL) != 0)
572 ERROR ("plugin: stop_read_threads: pthread_join failed.");
574 read_threads[i] = (pthread_t) 0;
576 sfree (read_threads);
577 read_threads_num = 0;
578 } /* void stop_read_threads */
580 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
585 meta_data_destroy (vl->meta);
588 } /* }}} void plugin_value_list_free */
590 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
597 vl = malloc (sizeof (*vl));
600 memcpy (vl, vl_orig, sizeof (*vl));
602 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
603 if (vl->values == NULL)
605 plugin_value_list_free (vl);
608 memcpy (vl->values, vl_orig->values,
609 vl_orig->values_len * sizeof (*vl->values));
611 vl->meta = meta_data_clone (vl->meta);
612 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
614 plugin_value_list_free (vl);
619 vl->time = cdtime ();
621 /* Fill in the interval from the thread context, if it is zero. */
622 if (vl->interval == 0)
624 plugin_ctx_t ctx = plugin_get_ctx ();
626 if (ctx.interval != 0)
627 vl->interval = ctx.interval;
630 char name[6 * DATA_MAX_NAME_LEN];
631 FORMAT_VL (name, sizeof (name), vl);
632 ERROR ("plugin_value_list_clone: Unable to determine "
633 "interval from context for "
634 "value list \"%s\". "
635 "This indicates a broken plugin. "
636 "Please report this problem to the "
637 "collectd mailing list or at "
638 "<http://collectd.org/bugs/>.", name);
639 vl->interval = cf_get_default_interval ();
644 } /* }}} value_list_t *plugin_value_list_clone */
646 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
650 q = malloc (sizeof (*q));
655 q->vl = plugin_value_list_clone (vl);
662 /* Store context of caller (read plugin); otherwise, it would not be
663 * available to the write plugins when actually dispatching the
664 * value-list later on. */
665 q->ctx = plugin_get_ctx ();
667 pthread_mutex_lock (&write_lock);
669 if (write_queue_tail == NULL)
671 write_queue_head = q;
672 write_queue_tail = q;
676 write_queue_tail->next = q;
677 write_queue_tail = q;
680 pthread_cond_signal (&write_cond);
681 pthread_mutex_unlock (&write_lock);
684 } /* }}} int plugin_write_enqueue */
686 static value_list_t *plugin_write_dequeue (void) /* {{{ */
691 pthread_mutex_lock (&write_lock);
693 while (write_loop && (write_queue_head == NULL))
694 pthread_cond_wait (&write_cond, &write_lock);
696 if (write_queue_head == NULL)
698 pthread_mutex_unlock (&write_lock);
702 q = write_queue_head;
703 write_queue_head = q->next;
704 if (write_queue_head == NULL)
705 write_queue_tail = NULL;
707 pthread_mutex_unlock (&write_lock);
709 (void) plugin_set_ctx (q->ctx);
714 } /* }}} value_list_t *plugin_write_dequeue */
716 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
720 value_list_t *vl = plugin_write_dequeue ();
724 plugin_dispatch_values_internal (vl);
726 plugin_value_list_free (vl);
731 } /* }}} void *plugin_write_thread */
733 static void start_write_threads (size_t num) /* {{{ */
737 if (write_threads != NULL)
740 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
741 if (write_threads == NULL)
743 ERROR ("plugin: start_write_threads: calloc failed.");
747 write_threads_num = 0;
748 for (i = 0; i < num; i++)
752 status = pthread_create (write_threads + write_threads_num,
759 ERROR ("plugin: start_write_threads: pthread_create failed "
760 "with status %i (%s).", status,
761 sstrerror (status, errbuf, sizeof (errbuf)));
767 } /* }}} void start_write_threads */
769 static void stop_write_threads (void) /* {{{ */
774 if (write_threads == NULL)
777 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
779 pthread_mutex_lock (&write_lock);
781 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
782 pthread_cond_broadcast (&write_cond);
783 pthread_mutex_unlock (&write_lock);
785 for (i = 0; i < write_threads_num; i++)
787 if (pthread_join (write_threads[i], NULL) != 0)
789 ERROR ("plugin: stop_write_threads: pthread_join failed.");
791 write_threads[i] = (pthread_t) 0;
793 sfree (write_threads);
794 write_threads_num = 0;
796 pthread_mutex_lock (&write_lock);
798 for (q = write_queue_head; q != NULL; )
800 write_queue_t *q1 = q;
801 plugin_value_list_free (q->vl);
806 write_queue_head = NULL;
807 write_queue_tail = NULL;
808 pthread_mutex_unlock (&write_lock);
812 WARNING ("plugin: %i value list%s left after shutting down "
813 "the write threads.",
814 i, (i == 1) ? " was" : "s were");
816 } /* }}} void stop_write_threads */
821 void plugin_set_dir (const char *dir)
823 if (plugindir != NULL)
828 else if ((plugindir = strdup (dir)) == NULL)
831 ERROR ("strdup failed: %s",
832 sstrerror (errno, errbuf, sizeof (errbuf)));
836 static _Bool plugin_is_loaded (char const *name)
840 if (plugins_loaded == NULL)
841 plugins_loaded = c_avl_create ((void *) strcasecmp);
842 assert (plugins_loaded != NULL);
844 status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
845 return (status == 0);
848 static int plugin_mark_loaded (char const *name)
853 name_copy = strdup (name);
854 if (name_copy == NULL)
857 status = c_avl_insert (plugins_loaded,
858 /* key = */ name_copy, /* value = */ NULL);
862 static void plugin_free_loaded ()
867 if (plugins_loaded == NULL)
870 while (c_avl_pick (plugins_loaded, &key, &value) == 0)
873 assert (value == NULL);
876 c_avl_destroy (plugins_loaded);
877 plugins_loaded = NULL;
881 int plugin_load (char const *plugin_name, uint32_t flags)
885 char filename[BUFSIZE] = "";
886 char typename[BUFSIZE];
893 if (plugin_name == NULL)
896 /* Check if plugin is already loaded and don't do anything in this
898 if (plugin_is_loaded (plugin_name))
901 dir = plugin_get_dir ();
904 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
905 * type when matching the filename */
906 status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
907 if ((status < 0) || ((size_t) status >= sizeof (typename)))
909 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
912 typename_len = strlen (typename);
914 if ((dh = opendir (dir)) == NULL)
917 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
918 sstrerror (errno, errbuf, sizeof (errbuf)));
922 while ((de = readdir (dh)) != NULL)
924 if (strncasecmp (de->d_name, typename, typename_len))
927 status = ssnprintf (filename, sizeof (filename),
928 "%s/%s", dir, de->d_name);
929 if ((status < 0) || ((size_t) status >= sizeof (filename)))
931 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
936 if (lstat (filename, &statbuf) == -1)
939 WARNING ("plugin_load: stat (\"%s\") failed: %s",
941 sstrerror (errno, errbuf, sizeof (errbuf)));
944 else if (!S_ISREG (statbuf.st_mode))
946 /* don't follow symlinks */
947 WARNING ("plugin_load: %s is not a regular file.",
952 status = plugin_load_file (filename, flags);
956 plugin_mark_loaded (plugin_name);
962 ERROR ("plugin_load: Load plugin \"%s\" failed with "
963 "status %i.", plugin_name, status);
969 if (filename[0] == 0)
970 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
977 * The `register_*' functions follow
979 int plugin_register_config (const char *name,
980 int (*callback) (const char *key, const char *val),
981 const char **keys, int keys_num)
983 cf_register (name, callback, keys, keys_num);
985 } /* int plugin_register_config */
987 int plugin_register_complex_config (const char *type,
988 int (*callback) (oconfig_item_t *))
990 return (cf_register_complex (type, callback));
991 } /* int plugin_register_complex_config */
993 int plugin_register_init (const char *name,
994 int (*callback) (void))
996 return (create_register_callback (&list_init, name, (void *) callback,
997 /* user_data = */ NULL));
998 } /* plugin_register_init */
1000 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1002 const read_func_t *rf0;
1003 const read_func_t *rf1;
1008 if (rf0->rf_next_read < rf1->rf_next_read)
1010 else if (rf0->rf_next_read > rf1->rf_next_read)
1014 } /* int plugin_compare_read_func */
1016 /* Add a read function to both, the heap and a linked list. The linked list if
1017 * used to look-up read functions, especially for the remove function. The heap
1018 * is used to determine which plugin to read next. */
1019 static int plugin_insert_read (read_func_t *rf)
1024 rf->rf_next_read = cdtime ();
1025 rf->rf_effective_interval = rf->rf_interval;
1027 pthread_mutex_lock (&read_lock);
1029 if (read_list == NULL)
1031 read_list = llist_create ();
1032 if (read_list == NULL)
1034 pthread_mutex_unlock (&read_lock);
1035 ERROR ("plugin_insert_read: read_list failed.");
1040 if (read_heap == NULL)
1042 read_heap = c_heap_create (plugin_compare_read_func);
1043 if (read_heap == NULL)
1045 pthread_mutex_unlock (&read_lock);
1046 ERROR ("plugin_insert_read: c_heap_create failed.");
1051 le = llist_search (read_list, rf->rf_name);
1054 pthread_mutex_unlock (&read_lock);
1055 WARNING ("The read function \"%s\" is already registered. "
1056 "Check for duplicate \"LoadPlugin\" lines "
1057 "in your configuration!",
1062 le = llentry_create (rf->rf_name, rf);
1065 pthread_mutex_unlock (&read_lock);
1066 ERROR ("plugin_insert_read: llentry_create failed.");
1070 status = c_heap_insert (read_heap, rf);
1073 pthread_mutex_unlock (&read_lock);
1074 ERROR ("plugin_insert_read: c_heap_insert failed.");
1075 llentry_destroy (le);
1079 /* This does not fail. */
1080 llist_append (read_list, le);
1082 /* Wake up all the read threads. */
1083 pthread_cond_broadcast (&read_cond);
1084 pthread_mutex_unlock (&read_lock);
1086 } /* int plugin_insert_read */
1088 int plugin_register_read (const char *name,
1089 int (*callback) (void))
1094 rf = malloc (sizeof (*rf));
1097 ERROR ("plugin_register_read: malloc failed.");
1101 memset (rf, 0, sizeof (read_func_t));
1102 rf->rf_callback = (void *) callback;
1103 rf->rf_udata.data = NULL;
1104 rf->rf_udata.free_func = NULL;
1105 rf->rf_ctx = plugin_get_ctx ();
1106 rf->rf_group[0] = '\0';
1107 rf->rf_name = strdup (name);
1108 rf->rf_type = RF_SIMPLE;
1109 rf->rf_interval = plugin_get_interval ();
1111 status = plugin_insert_read (rf);
1116 } /* int plugin_register_read */
1118 int plugin_register_complex_read (const char *group, const char *name,
1119 plugin_read_cb callback,
1120 const struct timespec *interval,
1121 user_data_t *user_data)
1126 rf = malloc (sizeof (*rf));
1129 ERROR ("plugin_register_complex_read: malloc failed.");
1133 memset (rf, 0, sizeof (read_func_t));
1134 rf->rf_callback = (void *) callback;
1136 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1138 rf->rf_group[0] = '\0';
1139 rf->rf_name = strdup (name);
1140 rf->rf_type = RF_COMPLEX;
1141 if (interval != NULL)
1142 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1144 rf->rf_interval = plugin_get_interval ();
1147 if (user_data == NULL)
1149 rf->rf_udata.data = NULL;
1150 rf->rf_udata.free_func = NULL;
1154 rf->rf_udata = *user_data;
1157 rf->rf_ctx = plugin_get_ctx ();
1159 status = plugin_insert_read (rf);
1164 } /* int plugin_register_complex_read */
1166 int plugin_register_write (const char *name,
1167 plugin_write_cb callback, user_data_t *ud)
1169 return (create_register_callback (&list_write, name,
1170 (void *) callback, ud));
1171 } /* int plugin_register_write */
1173 int plugin_register_flush (const char *name,
1174 plugin_flush_cb callback, user_data_t *ud)
1176 return (create_register_callback (&list_flush, name,
1177 (void *) callback, ud));
1178 } /* int plugin_register_flush */
1180 int plugin_register_missing (const char *name,
1181 plugin_missing_cb callback, user_data_t *ud)
1183 return (create_register_callback (&list_missing, name,
1184 (void *) callback, ud));
1185 } /* int plugin_register_missing */
1187 int plugin_register_shutdown (const char *name,
1188 int (*callback) (void))
1190 return (create_register_callback (&list_shutdown, name,
1191 (void *) callback, /* user_data = */ NULL));
1192 } /* int plugin_register_shutdown */
1194 int plugin_register_data_set (const data_set_t *ds)
1196 data_set_t *ds_copy;
1199 if ((data_sets != NULL)
1200 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1202 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1203 plugin_unregister_data_set (ds->type);
1205 else if (data_sets == NULL)
1207 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1208 if (data_sets == NULL)
1212 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1213 if (ds_copy == NULL)
1215 memcpy(ds_copy, ds, sizeof (data_set_t));
1217 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1219 if (ds_copy->ds == NULL)
1225 for (i = 0; i < ds->ds_num; i++)
1226 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1228 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1229 } /* int plugin_register_data_set */
1231 int plugin_register_log (const char *name,
1232 plugin_log_cb callback, user_data_t *ud)
1234 return (create_register_callback (&list_log, name,
1235 (void *) callback, ud));
1236 } /* int plugin_register_log */
1238 int plugin_register_notification (const char *name,
1239 plugin_notification_cb callback, user_data_t *ud)
1241 return (create_register_callback (&list_notification, name,
1242 (void *) callback, ud));
1243 } /* int plugin_register_log */
1245 int plugin_unregister_config (const char *name)
1247 cf_unregister (name);
1249 } /* int plugin_unregister_config */
1251 int plugin_unregister_complex_config (const char *name)
1253 cf_unregister_complex (name);
1255 } /* int plugin_unregister_complex_config */
1257 int plugin_unregister_init (const char *name)
1259 return (plugin_unregister (list_init, name));
1262 int plugin_unregister_read (const char *name) /* {{{ */
1270 pthread_mutex_lock (&read_lock);
1272 if (read_list == NULL)
1274 pthread_mutex_unlock (&read_lock);
1278 le = llist_search (read_list, name);
1281 pthread_mutex_unlock (&read_lock);
1282 WARNING ("plugin_unregister_read: No such read function: %s",
1287 llist_remove (read_list, le);
1290 assert (rf != NULL);
1291 rf->rf_type = RF_REMOVE;
1293 pthread_mutex_unlock (&read_lock);
1295 llentry_destroy (le);
1297 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1300 } /* }}} int plugin_unregister_read */
1302 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1304 read_func_t *rf = e->value;
1307 return strcmp (rf->rf_group, (const char *)group);
1308 } /* }}} int compare_read_func_group */
1310 int plugin_unregister_read_group (const char *group) /* {{{ */
1320 pthread_mutex_lock (&read_lock);
1322 if (read_list == NULL)
1324 pthread_mutex_unlock (&read_lock);
1330 le = llist_search_custom (read_list,
1331 compare_read_func_group, (void *)group);
1338 llist_remove (read_list, le);
1341 assert (rf != NULL);
1342 rf->rf_type = RF_REMOVE;
1344 llentry_destroy (le);
1346 DEBUG ("plugin_unregister_read_group: "
1347 "Marked `%s' (group `%s') for removal.",
1348 rf->rf_name, group);
1351 pthread_mutex_unlock (&read_lock);
1355 WARNING ("plugin_unregister_read_group: No such "
1356 "group of read function: %s", group);
1361 } /* }}} int plugin_unregister_read_group */
1363 int plugin_unregister_write (const char *name)
1365 return (plugin_unregister (list_write, name));
1368 int plugin_unregister_flush (const char *name)
1370 return (plugin_unregister (list_flush, name));
1373 int plugin_unregister_missing (const char *name)
1375 return (plugin_unregister (list_missing, name));
1378 int plugin_unregister_shutdown (const char *name)
1380 return (plugin_unregister (list_shutdown, name));
1383 int plugin_unregister_data_set (const char *name)
1387 if (data_sets == NULL)
1390 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1397 } /* int plugin_unregister_data_set */
1399 int plugin_unregister_log (const char *name)
1401 return (plugin_unregister (list_log, name));
1404 int plugin_unregister_notification (const char *name)
1406 return (plugin_unregister (list_notification, name));
1409 void plugin_init_all (void)
1411 const char *chain_name;
1415 /* Init the value cache */
1418 chain_name = global_option_get ("PreCacheChain");
1419 pre_cache_chain = fc_chain_get_by_name (chain_name);
1421 chain_name = global_option_get ("PostCacheChain");
1422 post_cache_chain = fc_chain_get_by_name (chain_name);
1425 char const *tmp = global_option_get ("WriteThreads");
1426 int num = atoi (tmp);
1431 start_write_threads ((size_t) num);
1434 if ((list_init == NULL) && (read_heap == NULL))
1437 /* Calling all init callbacks before checking if read callbacks
1438 * are available allows the init callbacks to register the read
1440 le = llist_head (list_init);
1443 callback_func_t *cf;
1444 plugin_init_cb callback;
1445 plugin_ctx_t old_ctx;
1448 old_ctx = plugin_set_ctx (cf->cf_ctx);
1449 callback = cf->cf_callback;
1450 status = (*callback) ();
1451 plugin_set_ctx (old_ctx);
1455 ERROR ("Initialization of plugin `%s' "
1456 "failed with status %i. "
1457 "Plugin will be unloaded.",
1459 /* Plugins that register read callbacks from the init
1460 * callback should take care of appropriate error
1461 * handling themselves. */
1462 /* FIXME: Unload _all_ functions */
1463 plugin_unregister_read (le->key);
1469 /* Start read-threads */
1470 if (read_heap != NULL)
1474 rt = global_option_get ("ReadThreads");
1477 start_read_threads ((num > 0) ? num : 5);
1479 } /* void plugin_init_all */
1481 /* TODO: Rename this function. */
1482 void plugin_read_all (void)
1484 uc_check_timeout ();
1487 } /* void plugin_read_all */
1489 /* Read function called when the `-T' command line argument is given. */
1490 int plugin_read_all_once (void)
1493 int return_status = 0;
1495 if (read_heap == NULL)
1497 NOTICE ("No read-functions are registered.");
1504 plugin_ctx_t old_ctx;
1506 rf = c_heap_get_root (read_heap);
1510 old_ctx = plugin_set_ctx (rf->rf_ctx);
1512 if (rf->rf_type == RF_SIMPLE)
1514 int (*callback) (void);
1516 callback = rf->rf_callback;
1517 status = (*callback) ();
1521 plugin_read_cb callback;
1523 callback = rf->rf_callback;
1524 status = (*callback) (&rf->rf_udata);
1527 plugin_set_ctx (old_ctx);
1531 NOTICE ("read-function of plugin `%s' failed.",
1536 destroy_callback ((void *) rf);
1539 return (return_status);
1540 } /* int plugin_read_all_once */
1542 int plugin_write (const char *plugin, /* {{{ */
1543 const data_set_t *ds, const value_list_t *vl)
1551 if (list_write == NULL)
1556 ds = plugin_get_ds (vl->type);
1559 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1569 le = llist_head (list_write);
1572 callback_func_t *cf = le->value;
1573 plugin_write_cb callback;
1575 /* do not switch plugin context; rather keep the context (interval)
1576 * information of the calling read plugin */
1578 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1579 callback = cf->cf_callback;
1580 status = (*callback) (ds, vl, &cf->cf_udata);
1589 if ((success == 0) && (failure != 0))
1594 else /* plugin != NULL */
1596 callback_func_t *cf;
1597 plugin_write_cb callback;
1599 le = llist_head (list_write);
1602 if (strcasecmp (plugin, le->key) == 0)
1613 /* do not switch plugin context; rather keep the context (interval)
1614 * information of the calling read plugin */
1616 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1617 callback = cf->cf_callback;
1618 status = (*callback) (ds, vl, &cf->cf_udata);
1622 } /* }}} int plugin_write */
1624 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1628 if (list_flush == NULL)
1631 le = llist_head (list_flush);
1634 callback_func_t *cf;
1635 plugin_flush_cb callback;
1636 plugin_ctx_t old_ctx;
1638 if ((plugin != NULL)
1639 && (strcmp (plugin, le->key) != 0))
1646 old_ctx = plugin_set_ctx (cf->cf_ctx);
1647 callback = cf->cf_callback;
1649 (*callback) (timeout, identifier, &cf->cf_udata);
1651 plugin_set_ctx (old_ctx);
1656 } /* int plugin_flush */
1658 void plugin_shutdown_all (void)
1662 stop_read_threads ();
1664 destroy_all_callbacks (&list_init);
1666 pthread_mutex_lock (&read_lock);
1667 llist_destroy (read_list);
1669 pthread_mutex_unlock (&read_lock);
1671 destroy_read_heap ();
1673 plugin_flush (/* plugin = */ NULL,
1675 /* identifier = */ NULL);
1678 if (list_shutdown != NULL)
1679 le = llist_head (list_shutdown);
1683 callback_func_t *cf;
1684 plugin_shutdown_cb callback;
1685 plugin_ctx_t old_ctx;
1688 old_ctx = plugin_set_ctx (cf->cf_ctx);
1689 callback = cf->cf_callback;
1691 /* Advance the pointer before calling the callback allows
1692 * shutdown functions to unregister themselves. If done the
1693 * other way around the memory `le' points to will be freed
1694 * after callback returns. */
1699 plugin_set_ctx (old_ctx);
1702 stop_write_threads ();
1704 /* Write plugins which use the `user_data' pointer usually need the
1705 * same data available to the flush callback. If this is the case, set
1706 * the free_function to NULL when registering the flush callback and to
1707 * the real free function when registering the write callback. This way
1708 * the data isn't freed twice. */
1709 destroy_all_callbacks (&list_flush);
1710 destroy_all_callbacks (&list_missing);
1711 destroy_all_callbacks (&list_write);
1713 destroy_all_callbacks (&list_notification);
1714 destroy_all_callbacks (&list_shutdown);
1715 destroy_all_callbacks (&list_log);
1717 plugin_free_loaded ();
1718 } /* void plugin_shutdown_all */
1720 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1724 if (list_missing == NULL)
1727 le = llist_head (list_missing);
1730 callback_func_t *cf;
1731 plugin_missing_cb callback;
1732 plugin_ctx_t old_ctx;
1736 old_ctx = plugin_set_ctx (cf->cf_ctx);
1737 callback = cf->cf_callback;
1739 status = (*callback) (vl, &cf->cf_udata);
1740 plugin_set_ctx (old_ctx);
1745 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1746 "failed with status %i.",
1759 } /* int }}} plugin_dispatch_missing */
1761 static int plugin_dispatch_values_internal (value_list_t *vl)
1764 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1766 value_t *saved_values;
1767 int saved_values_len;
1771 int free_meta_data = 0;
1773 if ((vl == NULL) || (vl->type[0] == 0)
1774 || (vl->values == NULL) || (vl->values_len < 1))
1776 ERROR ("plugin_dispatch_values: Invalid value list "
1777 "from plugin %s.", vl->plugin);
1781 /* Free meta data only if the calling function didn't specify any. In
1782 * this case matches and targets may add some and the calling function
1783 * may not expect (and therefore free) that data. */
1784 if (vl->meta == NULL)
1787 if (list_write == NULL)
1788 c_complain_once (LOG_WARNING, &no_write_complaint,
1789 "plugin_dispatch_values: No write callback has been "
1790 "registered. Please load at least one output plugin, "
1791 "if you want the collected data to be stored.");
1793 if (data_sets == NULL)
1795 ERROR ("plugin_dispatch_values: No data sets registered. "
1796 "Could the types database be read? Check "
1797 "your `TypesDB' setting!");
1801 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1803 char ident[6 * DATA_MAX_NAME_LEN];
1805 FORMAT_VL (ident, sizeof (ident), vl);
1806 INFO ("plugin_dispatch_values: Dataset not found: %s "
1807 "(from \"%s\"), check your types.db!",
1812 /* Assured by plugin_value_list_clone(). The time is determined at
1813 * _enqueue_ time. */
1814 assert (vl->time != 0);
1815 assert (vl->interval != 0);
1817 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1819 "plugin = %s; plugin_instance = %s; "
1820 "type = %s; type_instance = %s;",
1821 CDTIME_T_TO_DOUBLE (vl->time),
1822 CDTIME_T_TO_DOUBLE (vl->interval),
1824 vl->plugin, vl->plugin_instance,
1825 vl->type, vl->type_instance);
1828 assert (0 == strcmp (ds->type, vl->type));
1830 if (0 != strcmp (ds->type, vl->type))
1831 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1832 ds->type, vl->type);
1836 assert (ds->ds_num == vl->values_len);
1838 if (ds->ds_num != vl->values_len)
1840 ERROR ("plugin_dispatch_values: ds->type = %s: "
1841 "(ds->ds_num = %i) != "
1842 "(vl->values_len = %i)",
1843 ds->type, ds->ds_num, vl->values_len);
1848 escape_slashes (vl->host, sizeof (vl->host));
1849 escape_slashes (vl->plugin, sizeof (vl->plugin));
1850 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1851 escape_slashes (vl->type, sizeof (vl->type));
1852 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1854 /* Copy the values. This way, we can assure `targets' that they get
1855 * dynamically allocated values, which they can free and replace if
1857 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1859 saved_values = vl->values;
1860 saved_values_len = vl->values_len;
1862 vl->values = (value_t *) calloc (vl->values_len,
1863 sizeof (*vl->values));
1864 if (vl->values == NULL)
1866 ERROR ("plugin_dispatch_values: calloc failed.");
1867 vl->values = saved_values;
1870 memcpy (vl->values, saved_values,
1871 vl->values_len * sizeof (*vl->values));
1873 else /* if ((pre == NULL) && (post == NULL)) */
1875 saved_values = NULL;
1876 saved_values_len = 0;
1879 if (pre_cache_chain != NULL)
1881 status = fc_process_chain (ds, vl, pre_cache_chain);
1884 WARNING ("plugin_dispatch_values: Running the "
1885 "pre-cache chain failed with "
1889 else if (status == FC_TARGET_STOP)
1891 /* Restore the state of the value_list so that plugins
1892 * don't get confused.. */
1893 if (saved_values != NULL)
1896 vl->values = saved_values;
1897 vl->values_len = saved_values_len;
1903 /* Update the value cache */
1906 if (post_cache_chain != NULL)
1908 status = fc_process_chain (ds, vl, post_cache_chain);
1911 WARNING ("plugin_dispatch_values: Running the "
1912 "post-cache chain failed with "
1918 fc_default_action (ds, vl);
1920 /* Restore the state of the value_list so that plugins don't get
1922 if (saved_values != NULL)
1925 vl->values = saved_values;
1926 vl->values_len = saved_values_len;
1929 if ((free_meta_data != 0) && (vl->meta != NULL))
1931 meta_data_destroy (vl->meta);
1936 } /* int plugin_dispatch_values_internal */
1938 int plugin_dispatch_values (value_list_t const *vl)
1942 status = plugin_write_enqueue (vl);
1946 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
1947 "with status %i (%s).", status,
1948 sstrerror (status, errbuf, sizeof (errbuf)));
1955 int plugin_dispatch_notification (const notification_t *notif)
1958 /* Possible TODO: Add flap detection here */
1960 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1961 "time = %.3f; host = %s;",
1962 notif->severity, notif->message,
1963 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1965 /* Nobody cares for notifications */
1966 if (list_notification == NULL)
1969 le = llist_head (list_notification);
1972 callback_func_t *cf;
1973 plugin_notification_cb callback;
1976 /* do not switch plugin context; rather keep the context
1977 * (interval) information of the calling plugin */
1980 callback = cf->cf_callback;
1981 status = (*callback) (notif, &cf->cf_udata);
1984 WARNING ("plugin_dispatch_notification: Notification "
1985 "callback %s returned %i.",
1993 } /* int plugin_dispatch_notification */
1995 void plugin_log (int level, const char *format, ...)
2002 if (level >= LOG_DEBUG)
2006 va_start (ap, format);
2007 vsnprintf (msg, sizeof (msg), format, ap);
2008 msg[sizeof (msg) - 1] = '\0';
2011 if (list_log == NULL)
2013 fprintf (stderr, "%s\n", msg);
2017 le = llist_head (list_log);
2020 callback_func_t *cf;
2021 plugin_log_cb callback;
2024 callback = cf->cf_callback;
2026 /* do not switch plugin context; rather keep the context
2027 * (interval) information of the calling plugin */
2029 (*callback) (level, msg, &cf->cf_udata);
2033 } /* void plugin_log */
2035 int parse_log_severity (const char *severity)
2039 if ((0 == strcasecmp (severity, "emerg"))
2040 || (0 == strcasecmp (severity, "alert"))
2041 || (0 == strcasecmp (severity, "crit"))
2042 || (0 == strcasecmp (severity, "err")))
2043 log_level = LOG_ERR;
2044 else if (0 == strcasecmp (severity, "warning"))
2045 log_level = LOG_WARNING;
2046 else if (0 == strcasecmp (severity, "notice"))
2047 log_level = LOG_NOTICE;
2048 else if (0 == strcasecmp (severity, "info"))
2049 log_level = LOG_INFO;
2051 else if (0 == strcasecmp (severity, "debug"))
2052 log_level = LOG_DEBUG;
2053 #endif /* COLLECT_DEBUG */
2056 } /* int parse_log_severity */
2058 int parse_notif_severity (const char *severity)
2060 int notif_severity = -1;
2062 if (strcasecmp (severity, "FAILURE") == 0)
2063 notif_severity = NOTIF_FAILURE;
2064 else if (strcmp (severity, "OKAY") == 0)
2065 notif_severity = NOTIF_OKAY;
2066 else if ((strcmp (severity, "WARNING") == 0)
2067 || (strcmp (severity, "WARN") == 0))
2068 notif_severity = NOTIF_WARNING;
2070 return (notif_severity);
2071 } /* int parse_notif_severity */
2073 const data_set_t *plugin_get_ds (const char *name)
2077 if (data_sets == NULL)
2079 ERROR ("plugin_get_ds: No data sets are defined yet.");
2083 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2085 DEBUG ("No such dataset registered: %s", name);
2090 } /* data_set_t *plugin_get_ds */
2092 static int plugin_notification_meta_add (notification_t *n,
2094 enum notification_meta_type_e type,
2097 notification_meta_t *meta;
2098 notification_meta_t *tail;
2100 if ((n == NULL) || (name == NULL) || (value == NULL))
2102 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2106 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2109 ERROR ("plugin_notification_meta_add: malloc failed.");
2112 memset (meta, 0, sizeof (notification_meta_t));
2114 sstrncpy (meta->name, name, sizeof (meta->name));
2119 case NM_TYPE_STRING:
2121 meta->nm_value.nm_string = strdup ((const char *) value);
2122 if (meta->nm_value.nm_string == NULL)
2124 ERROR ("plugin_notification_meta_add: strdup failed.");
2130 case NM_TYPE_SIGNED_INT:
2132 meta->nm_value.nm_signed_int = *((int64_t *) value);
2135 case NM_TYPE_UNSIGNED_INT:
2137 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2140 case NM_TYPE_DOUBLE:
2142 meta->nm_value.nm_double = *((double *) value);
2145 case NM_TYPE_BOOLEAN:
2147 meta->nm_value.nm_boolean = *((_Bool *) value);
2152 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2156 } /* switch (type) */
2160 while ((tail != NULL) && (tail->next != NULL))
2169 } /* int plugin_notification_meta_add */
2171 int plugin_notification_meta_add_string (notification_t *n,
2175 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2178 int plugin_notification_meta_add_signed_int (notification_t *n,
2182 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2185 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2189 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2192 int plugin_notification_meta_add_double (notification_t *n,
2196 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2199 int plugin_notification_meta_add_boolean (notification_t *n,
2203 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2206 int plugin_notification_meta_copy (notification_t *dst,
2207 const notification_t *src)
2209 notification_meta_t *meta;
2211 assert (dst != NULL);
2212 assert (src != NULL);
2213 assert (dst != src);
2214 assert ((src->meta == NULL) || (src->meta != dst->meta));
2216 for (meta = src->meta; meta != NULL; meta = meta->next)
2218 if (meta->type == NM_TYPE_STRING)
2219 plugin_notification_meta_add_string (dst, meta->name,
2220 meta->nm_value.nm_string);
2221 else if (meta->type == NM_TYPE_SIGNED_INT)
2222 plugin_notification_meta_add_signed_int (dst, meta->name,
2223 meta->nm_value.nm_signed_int);
2224 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2225 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2226 meta->nm_value.nm_unsigned_int);
2227 else if (meta->type == NM_TYPE_DOUBLE)
2228 plugin_notification_meta_add_double (dst, meta->name,
2229 meta->nm_value.nm_double);
2230 else if (meta->type == NM_TYPE_BOOLEAN)
2231 plugin_notification_meta_add_boolean (dst, meta->name,
2232 meta->nm_value.nm_boolean);
2236 } /* int plugin_notification_meta_copy */
2238 int plugin_notification_meta_free (notification_meta_t *n)
2240 notification_meta_t *this;
2241 notification_meta_t *next;
2245 ERROR ("plugin_notification_meta_free: n == NULL!");
2250 while (this != NULL)
2254 if (this->type == NM_TYPE_STRING)
2256 free ((char *)this->nm_value.nm_string);
2257 this->nm_value.nm_string = NULL;
2265 } /* int plugin_notification_meta_free */
2267 static void plugin_ctx_destructor (void *ctx)
2270 } /* void plugin_ctx_destructor */
2272 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2274 static plugin_ctx_t *plugin_ctx_create (void)
2278 ctx = malloc (sizeof (*ctx));
2281 ERROR ("Failed to allocate plugin context: %s",
2282 sstrerror (errno, errbuf, sizeof (errbuf)));
2287 assert (plugin_ctx_key_initialized);
2288 pthread_setspecific (plugin_ctx_key, ctx);
2289 DEBUG("Created new plugin context.");
2291 } /* int plugin_ctx_create */
2293 void plugin_init_ctx (void)
2295 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2296 plugin_ctx_key_initialized = 1;
2297 } /* void plugin_init_ctx */
2299 plugin_ctx_t plugin_get_ctx (void)
2303 assert (plugin_ctx_key_initialized);
2304 ctx = pthread_getspecific (plugin_ctx_key);
2307 ctx = plugin_ctx_create ();
2308 /* this must no happen -- exit() instead? */
2314 } /* plugin_ctx_t plugin_get_ctx */
2316 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2321 assert (plugin_ctx_key_initialized);
2322 c = pthread_getspecific (plugin_ctx_key);
2325 c = plugin_ctx_create ();
2326 /* this must no happen -- exit() instead? */
2335 } /* void plugin_set_ctx */
2337 cdtime_t plugin_get_interval (void)
2341 interval = plugin_get_ctx().interval;
2345 return cf_get_default_interval ();
2346 } /* cdtime_t plugin_get_interval */
2350 void *(*start_routine) (void *);
2354 static void *plugin_thread_start (void *arg)
2356 plugin_thread_t *plugin_thread = arg;
2358 void *(*start_routine) (void *) = plugin_thread->start_routine;
2359 void *plugin_arg = plugin_thread->arg;
2361 plugin_set_ctx (plugin_thread->ctx);
2363 free (plugin_thread);
2365 return start_routine (plugin_arg);
2366 } /* void *plugin_thread_start */
2368 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2369 void *(*start_routine) (void *), void *arg)
2371 plugin_thread_t *plugin_thread;
2373 plugin_thread = malloc (sizeof (*plugin_thread));
2374 if (plugin_thread == NULL)
2377 plugin_thread->ctx = plugin_get_ctx ();
2378 plugin_thread->start_routine = start_routine;
2379 plugin_thread->arg = arg;
2381 return pthread_create (thread, attr,
2382 plugin_thread_start, plugin_thread);
2383 } /* int plugin_thread_create */
2385 /* vim: set sw=8 ts=8 noet fdm=marker : */