2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2014 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian Harl <sh at tokkee.org>
28 /* _GNU_SOURCE is needed in Linux to use pthread_setname_np */
34 #include "configfile.h"
35 #include "filter_chain.h"
37 #include "utils_avltree.h"
38 #include "utils_cache.h"
39 #include "utils_complain.h"
40 #include "utils_heap.h"
41 #include "utils_llist.h"
42 #include "utils_random.h"
43 #include "utils_time.h"
46 #include <pthread_np.h> /* for pthread_set_name_np(3) */
54 struct callback_func_s {
59 typedef struct callback_func_s callback_func_t;
63 #define RF_REMOVE 65535
65 /* `read_func_t' "inherits" from `callback_func_t'.
66 * The `rf_super' member MUST be the first one in this structure! */
67 #define rf_callback rf_super.cf_callback
68 #define rf_udata rf_super.cf_udata
69 #define rf_ctx rf_super.cf_ctx
70 callback_func_t rf_super;
71 char rf_group[DATA_MAX_NAME_LEN];
75 cdtime_t rf_effective_interval;
76 cdtime_t rf_next_read;
78 typedef struct read_func_s read_func_t;
81 typedef struct write_queue_s write_queue_t;
82 struct write_queue_s {
88 struct flush_callback_s {
92 typedef struct flush_callback_s flush_callback_t;
97 static c_avl_tree_t *plugins_loaded = NULL;
99 static llist_t *list_init;
100 static llist_t *list_write;
101 static llist_t *list_flush;
102 static llist_t *list_missing;
103 static llist_t *list_shutdown;
104 static llist_t *list_log;
105 static llist_t *list_notification;
107 static fc_chain_t *pre_cache_chain = NULL;
108 static fc_chain_t *post_cache_chain = NULL;
110 static c_avl_tree_t *data_sets;
112 static char *plugindir = NULL;
114 #ifndef DEFAULT_MAX_READ_INTERVAL
115 #define DEFAULT_MAX_READ_INTERVAL TIME_T_TO_CDTIME_T_STATIC(86400)
117 static c_heap_t *read_heap = NULL;
118 static llist_t *read_list;
119 static int read_loop = 1;
120 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
121 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
122 static pthread_t *read_threads = NULL;
123 static size_t read_threads_num = 0;
124 static cdtime_t max_read_interval = DEFAULT_MAX_READ_INTERVAL;
126 static write_queue_t *write_queue_head;
127 static write_queue_t *write_queue_tail;
128 static long write_queue_length = 0;
129 static _Bool write_loop = 1;
130 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
131 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
132 static pthread_t *write_threads = NULL;
133 static size_t write_threads_num = 0;
135 static pthread_key_t plugin_ctx_key;
136 static _Bool plugin_ctx_key_initialized = 0;
138 static long write_limit_high = 0;
139 static long write_limit_low = 0;
141 static derive_t stats_values_dropped = 0;
142 static _Bool record_statistics = 0;
147 static int plugin_dispatch_values_internal(value_list_t *vl);
149 static const char *plugin_get_dir(void) {
150 if (plugindir == NULL)
156 static void plugin_update_internal_statistics(void) { /* {{{ */
158 gauge_t copy_write_queue_length = (gauge_t)write_queue_length;
160 /* Initialize `vl' */
161 value_list_t vl = VALUE_LIST_INIT;
162 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
163 sstrncpy(vl.plugin, "collectd", sizeof(vl.plugin));
166 sstrncpy(vl.plugin_instance, "write_queue", sizeof(vl.plugin_instance));
168 /* Write queue : queue length */
169 vl.values = &(value_t){.gauge = copy_write_queue_length};
171 sstrncpy(vl.type, "queue_length", sizeof(vl.type));
172 vl.type_instance[0] = 0;
173 plugin_dispatch_values(&vl);
175 /* Write queue : Values dropped (queue length > low limit) */
176 vl.values = &(value_t){.gauge = (gauge_t)stats_values_dropped};
178 sstrncpy(vl.type, "derive", sizeof(vl.type));
179 sstrncpy(vl.type_instance, "dropped", sizeof(vl.type_instance));
180 plugin_dispatch_values(&vl);
183 sstrncpy(vl.plugin_instance, "cache", sizeof(vl.plugin_instance));
185 /* Cache : Nb entry in cache tree */
186 vl.values = &(value_t){.gauge = (gauge_t)uc_get_size()};
188 sstrncpy(vl.type, "cache_size", sizeof(vl.type));
189 vl.type_instance[0] = 0;
190 plugin_dispatch_values(&vl);
193 } /* }}} void plugin_update_internal_statistics */
195 static void destroy_callback(callback_func_t *cf) /* {{{ */
200 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL)) {
201 cf->cf_udata.free_func(cf->cf_udata.data);
202 cf->cf_udata.data = NULL;
203 cf->cf_udata.free_func = NULL;
206 } /* }}} void destroy_callback */
208 static void destroy_all_callbacks(llist_t **list) /* {{{ */
215 le = llist_head(*list);
222 destroy_callback(le->value);
228 llist_destroy(*list);
230 } /* }}} void destroy_all_callbacks */
232 static void destroy_read_heap(void) /* {{{ */
234 if (read_heap == NULL)
240 rf = c_heap_get_root(read_heap);
244 destroy_callback((callback_func_t *)rf);
247 c_heap_destroy(read_heap);
249 } /* }}} void destroy_read_heap */
251 static int register_callback(llist_t **list, /* {{{ */
252 const char *name, callback_func_t *cf) {
257 *list = llist_create();
259 ERROR("plugin: register_callback: "
260 "llist_create failed.");
261 destroy_callback(cf);
268 ERROR("plugin: register_callback: strdup failed.");
269 destroy_callback(cf);
273 le = llist_search(*list, name);
275 le = llentry_create(key, cf);
277 ERROR("plugin: register_callback: "
278 "llentry_create failed.");
280 destroy_callback(cf);
284 llist_append(*list, le);
286 callback_func_t *old_cf;
291 WARNING("plugin: register_callback: "
292 "a callback named `%s' already exists - "
293 "overwriting the old entry!",
296 destroy_callback(old_cf);
301 } /* }}} int register_callback */
303 static void log_list_callbacks(llist_t **list, /* {{{ */
304 const char *comment) {
312 n = llist_size(*list);
314 INFO("%s [none]", comment);
318 keys = calloc(n, sizeof(char *));
321 ERROR("%s: failed to allocate memory for list of callbacks", comment);
326 for (le = llist_head(*list), i = 0, len = 0; le != NULL; le = le->next, i++) {
328 len += strlen(le->key) + 6;
330 str = malloc(len + 10);
332 ERROR("%s: failed to allocate memory for list of callbacks", comment);
335 strjoin(str, len, keys, n, "', '");
336 INFO("%s ['%s']", comment, str);
340 } /* }}} void log_list_callbacks */
342 static int create_register_callback(llist_t **list, /* {{{ */
343 const char *name, void *callback,
344 user_data_t const *ud) {
347 cf = calloc(1, sizeof(*cf));
349 ERROR("plugin: create_register_callback: calloc failed.");
353 cf->cf_callback = callback;
355 cf->cf_udata.data = NULL;
356 cf->cf_udata.free_func = NULL;
361 cf->cf_ctx = plugin_get_ctx();
363 return (register_callback(list, name, cf));
364 } /* }}} int create_register_callback */
366 static int plugin_unregister(llist_t *list, const char *name) /* {{{ */
373 e = llist_search(list, name);
377 llist_remove(list, e);
380 destroy_callback(e->value);
385 } /* }}} int plugin_unregister */
388 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
389 * object, but it will bitch about a shared object not having a
390 * ``module_register'' symbol..
392 static int plugin_load_file(char *file, uint32_t flags) {
394 void (*reg_handle)(void);
397 lt_dlerror(); /* clear errors */
399 #if LIBTOOL_VERSION == 2
400 if (flags & PLUGIN_FLAGS_GLOBAL) {
402 lt_dladvise_init(&advise);
403 lt_dladvise_global(&advise);
404 dlh = lt_dlopenadvise(file, advise);
405 lt_dladvise_destroy(&advise);
407 dlh = lt_dlopen(file);
409 #else /* if LIBTOOL_VERSION == 1 */
410 if (flags & PLUGIN_FLAGS_GLOBAL)
411 WARNING("plugin_load_file: The global flag is not supported, "
412 "libtool 2 is required for this.");
413 dlh = lt_dlopen(file);
417 char errbuf[1024] = "";
419 ssnprintf(errbuf, sizeof(errbuf),
420 "lt_dlopen (\"%s\") failed: %s. "
421 "The most common cause for this problem is "
422 "missing dependencies. Use ldd(1) to check "
423 "the dependencies of the plugin "
428 /* Make sure this is printed to STDERR in any case, but also
429 * make sure it's printed only once. */
430 if (list_log != NULL)
431 fprintf(stderr, "ERROR: %s\n", errbuf);
436 if ((reg_handle = (void (*)(void))lt_dlsym(dlh, "module_register")) == NULL) {
437 WARNING("Couldn't find symbol \"module_register\" in \"%s\": %s\n", file,
448 static void *plugin_read_thread(void __attribute__((unused)) * args) {
449 while (read_loop != 0) {
451 plugin_ctx_t old_ctx;
459 /* Get the read function that needs to be read next.
460 * We don't need to hold "read_lock" for the heap, but we need
461 * to call c_heap_get_root() and pthread_cond_wait() in the
462 * same protected block. */
463 pthread_mutex_lock(&read_lock);
464 rf = c_heap_get_root(read_heap);
466 pthread_cond_wait(&read_cond, &read_lock);
467 pthread_mutex_unlock(&read_lock);
470 pthread_mutex_unlock(&read_lock);
472 if (rf->rf_interval == 0) {
473 /* this should not happen, because the interval is set
474 * for each plugin when loading it
475 * XXX: issue a warning? */
476 rf->rf_interval = plugin_get_interval();
477 rf->rf_effective_interval = rf->rf_interval;
479 rf->rf_next_read = cdtime();
482 /* sleep until this entry is due,
483 * using pthread_cond_timedwait */
484 pthread_mutex_lock(&read_lock);
485 /* In pthread_cond_timedwait, spurious wakeups are possible
486 * (and really happen, at least on NetBSD with > 1 CPU), thus
487 * we need to re-evaluate the condition every time
488 * pthread_cond_timedwait returns. */
490 while ((read_loop != 0) && (cdtime() < rf->rf_next_read) && rc == 0) {
491 rc = pthread_cond_timedwait(&read_cond, &read_lock,
492 &CDTIME_T_TO_TIMESPEC(rf->rf_next_read));
495 /* Must hold `read_lock' when accessing `rf->rf_type'. */
496 rf_type = rf->rf_type;
497 pthread_mutex_unlock(&read_lock);
499 /* Check if we're supposed to stop.. This may have interrupted
501 if (read_loop == 0) {
502 /* Insert `rf' again, so it can be free'd correctly */
503 c_heap_insert(read_heap, rf);
507 /* The entry has been marked for deletion. The linked list
508 * entry has already been removed by `plugin_unregister_read'.
509 * All we have to do here is free the `read_func_t' and
511 if (rf_type == RF_REMOVE) {
512 DEBUG("plugin_read_thread: Destroying the `%s' "
516 destroy_callback((callback_func_t *)rf);
521 DEBUG("plugin_read_thread: Handling `%s'.", rf->rf_name);
525 old_ctx = plugin_set_ctx(rf->rf_ctx);
527 if (rf_type == RF_SIMPLE) {
528 int (*callback)(void);
530 callback = rf->rf_callback;
531 status = (*callback)();
533 plugin_read_cb callback;
535 assert(rf_type == RF_COMPLEX);
537 callback = rf->rf_callback;
538 status = (*callback)(&rf->rf_udata);
541 plugin_set_ctx(old_ctx);
543 /* If the function signals failure, we will increase the
544 * intervals in which it will be called. */
546 rf->rf_effective_interval *= 2;
547 if (rf->rf_effective_interval > max_read_interval)
548 rf->rf_effective_interval = max_read_interval;
550 NOTICE("read-function of plugin `%s' failed. "
551 "Will suspend it for %.3f seconds.",
552 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
554 /* Success: Restore the interval, if it was changed. */
555 rf->rf_effective_interval = rf->rf_interval;
558 /* update the ``next read due'' field */
561 /* calculate the time spent in the read function */
562 elapsed = (now - start);
564 if (elapsed > rf->rf_effective_interval)
566 "plugin_read_thread: read-function of the `%s' plugin took %.3f "
567 "seconds, which is above its read interval (%.3f seconds). You might "
568 "want to adjust the `Interval' or `ReadThreads' settings.",
569 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed),
570 CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
572 DEBUG("plugin_read_thread: read-function of the `%s' plugin took "
574 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed));
576 DEBUG("plugin_read_thread: Effective interval of the "
577 "`%s' plugin is %.3f seconds.",
578 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
580 /* Calculate the next (absolute) time at which this function
581 * should be called. */
582 rf->rf_next_read += rf->rf_effective_interval;
584 /* Check, if `rf_next_read' is in the past. */
585 if (rf->rf_next_read < now) {
586 /* `rf_next_read' is in the past. Insert `now'
587 * so this value doesn't trail off into the
589 rf->rf_next_read = now;
592 DEBUG("plugin_read_thread: Next read of the `%s' plugin at %.3f.",
593 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_next_read));
595 /* Re-insert this read function into the heap again. */
596 c_heap_insert(read_heap, rf);
597 } /* while (read_loop) */
601 } /* void *plugin_read_thread */
603 #ifdef PTHREAD_MAX_NAMELEN_NP
604 #define THREAD_NAME_MAX PTHREAD_MAX_NAMELEN_NP
606 #define THREAD_NAME_MAX 16
609 static void set_thread_name(pthread_t tid, char const *name) {
610 #if defined(HAVE_PTHREAD_SETNAME_NP) || defined(HAVE_PTHREAD_SET_NAME_NP)
612 /* glibc limits the length of the name and fails if the passed string
613 * is too long, so we truncate it here. */
614 char n[THREAD_NAME_MAX];
615 if (strlen(name) >= THREAD_NAME_MAX)
616 WARNING("set_thread_name(\"%s\"): name too long", name);
617 sstrncpy(n, name, sizeof(n));
619 #if defined(HAVE_PTHREAD_SETNAME_NP)
620 int status = pthread_setname_np(tid, n);
623 ERROR("set_thread_name(\"%s\"): %s", n,
624 sstrerror(status, errbuf, sizeof(errbuf)));
626 #else /* if defined(HAVE_PTHREAD_SET_NAME_NP) */
627 pthread_set_name_np(tid, n);
633 static void start_read_threads(size_t num) /* {{{ */
635 if (read_threads != NULL)
638 read_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
639 if (read_threads == NULL) {
640 ERROR("plugin: start_read_threads: calloc failed.");
644 read_threads_num = 0;
645 for (size_t i = 0; i < num; i++) {
646 int status = pthread_create(read_threads + read_threads_num,
647 /* attr = */ NULL, plugin_read_thread,
651 ERROR("plugin: start_read_threads: pthread_create failed "
652 "with status %i (%s).",
653 status, sstrerror(status, errbuf, sizeof(errbuf)));
657 char name[THREAD_NAME_MAX];
658 ssnprintf(name, sizeof(name), "reader#%zu", read_threads_num);
659 set_thread_name(read_threads[read_threads_num], name);
663 } /* }}} void start_read_threads */
665 static void stop_read_threads(void) {
666 if (read_threads == NULL)
669 INFO("collectd: Stopping %zu read threads.", read_threads_num);
671 pthread_mutex_lock(&read_lock);
673 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
674 pthread_cond_broadcast(&read_cond);
675 pthread_mutex_unlock(&read_lock);
677 for (size_t i = 0; i < read_threads_num; i++) {
678 if (pthread_join(read_threads[i], NULL) != 0) {
679 ERROR("plugin: stop_read_threads: pthread_join failed.");
681 read_threads[i] = (pthread_t)0;
684 read_threads_num = 0;
685 } /* void stop_read_threads */
687 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
692 meta_data_destroy(vl->meta);
695 } /* }}} void plugin_value_list_free */
697 static value_list_t *
698 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
705 vl = malloc(sizeof(*vl));
708 memcpy(vl, vl_orig, sizeof(*vl));
710 if (vl->host[0] == 0)
711 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
713 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
714 if (vl->values == NULL) {
715 plugin_value_list_free(vl);
718 memcpy(vl->values, vl_orig->values,
719 vl_orig->values_len * sizeof(*vl->values));
721 vl->meta = meta_data_clone(vl->meta);
722 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
723 plugin_value_list_free(vl);
730 /* Fill in the interval from the thread context, if it is zero. */
731 if (vl->interval == 0) {
732 plugin_ctx_t ctx = plugin_get_ctx();
734 if (ctx.interval != 0)
735 vl->interval = ctx.interval;
737 char name[6 * DATA_MAX_NAME_LEN];
738 FORMAT_VL(name, sizeof(name), vl);
739 ERROR("plugin_value_list_clone: Unable to determine "
740 "interval from context for "
741 "value list \"%s\". "
742 "This indicates a broken plugin. "
743 "Please report this problem to the "
744 "collectd mailing list or at "
745 "<http://collectd.org/bugs/>.",
747 vl->interval = cf_get_default_interval();
752 } /* }}} value_list_t *plugin_value_list_clone */
754 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
758 q = malloc(sizeof(*q));
763 q->vl = plugin_value_list_clone(vl);
769 /* Store context of caller (read plugin); otherwise, it would not be
770 * available to the write plugins when actually dispatching the
771 * value-list later on. */
772 q->ctx = plugin_get_ctx();
774 pthread_mutex_lock(&write_lock);
776 if (write_queue_tail == NULL) {
777 write_queue_head = q;
778 write_queue_tail = q;
779 write_queue_length = 1;
781 write_queue_tail->next = q;
782 write_queue_tail = q;
783 write_queue_length += 1;
786 pthread_cond_signal(&write_cond);
787 pthread_mutex_unlock(&write_lock);
790 } /* }}} int plugin_write_enqueue */
792 static value_list_t *plugin_write_dequeue(void) /* {{{ */
797 pthread_mutex_lock(&write_lock);
799 while (write_loop && (write_queue_head == NULL))
800 pthread_cond_wait(&write_cond, &write_lock);
802 if (write_queue_head == NULL) {
803 pthread_mutex_unlock(&write_lock);
807 q = write_queue_head;
808 write_queue_head = q->next;
809 write_queue_length -= 1;
810 if (write_queue_head == NULL) {
811 write_queue_tail = NULL;
812 assert(0 == write_queue_length);
815 pthread_mutex_unlock(&write_lock);
817 (void)plugin_set_ctx(q->ctx);
822 } /* }}} value_list_t *plugin_write_dequeue */
824 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
827 value_list_t *vl = plugin_write_dequeue();
831 plugin_dispatch_values_internal(vl);
833 plugin_value_list_free(vl);
838 } /* }}} void *plugin_write_thread */
840 static void start_write_threads(size_t num) /* {{{ */
842 if (write_threads != NULL)
845 write_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
846 if (write_threads == NULL) {
847 ERROR("plugin: start_write_threads: calloc failed.");
851 write_threads_num = 0;
852 for (size_t i = 0; i < num; i++) {
853 int status = pthread_create(write_threads + write_threads_num,
854 /* attr = */ NULL, plugin_write_thread,
858 ERROR("plugin: start_write_threads: pthread_create failed "
859 "with status %i (%s).",
860 status, sstrerror(status, errbuf, sizeof(errbuf)));
864 char name[THREAD_NAME_MAX];
865 ssnprintf(name, sizeof(name), "writer#%zu", write_threads_num);
866 set_thread_name(write_threads[write_threads_num], name);
870 } /* }}} void start_write_threads */
872 static void stop_write_threads(void) /* {{{ */
877 if (write_threads == NULL)
880 INFO("collectd: Stopping %zu write threads.", write_threads_num);
882 pthread_mutex_lock(&write_lock);
884 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
885 pthread_cond_broadcast(&write_cond);
886 pthread_mutex_unlock(&write_lock);
888 for (i = 0; i < write_threads_num; i++) {
889 if (pthread_join(write_threads[i], NULL) != 0) {
890 ERROR("plugin: stop_write_threads: pthread_join failed.");
892 write_threads[i] = (pthread_t)0;
894 sfree(write_threads);
895 write_threads_num = 0;
897 pthread_mutex_lock(&write_lock);
899 for (q = write_queue_head; q != NULL;) {
900 write_queue_t *q1 = q;
901 plugin_value_list_free(q->vl);
906 write_queue_head = NULL;
907 write_queue_tail = NULL;
908 write_queue_length = 0;
909 pthread_mutex_unlock(&write_lock);
912 WARNING("plugin: %zu value list%s left after shutting down "
913 "the write threads.",
914 i, (i == 1) ? " was" : "s were");
916 } /* }}} void stop_write_threads */
921 void plugin_set_dir(const char *dir) {
929 plugindir = strdup(dir);
930 if (plugindir == NULL)
931 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
934 static _Bool plugin_is_loaded(char const *name) {
937 if (plugins_loaded == NULL)
939 c_avl_create((int (*)(const void *, const void *))strcasecmp);
940 assert(plugins_loaded != NULL);
942 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
943 return (status == 0);
946 static int plugin_mark_loaded(char const *name) {
950 name_copy = strdup(name);
951 if (name_copy == NULL)
954 status = c_avl_insert(plugins_loaded,
955 /* key = */ name_copy, /* value = */ NULL);
959 static void plugin_free_loaded(void) {
963 if (plugins_loaded == NULL)
966 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
968 assert(value == NULL);
971 c_avl_destroy(plugins_loaded);
972 plugins_loaded = NULL;
976 int plugin_load(char const *plugin_name, uint32_t flags) {
979 char filename[BUFSIZE] = "";
980 char typename[BUFSIZE];
986 if (plugin_name == NULL)
989 /* Check if plugin is already loaded and don't do anything in this
991 if (plugin_is_loaded(plugin_name))
994 dir = plugin_get_dir();
998 * XXX: Magic at work:
1000 * Some of the language bindings, for example the Python and Perl
1001 * plugins, need to be able to export symbols to the scripts they run.
1002 * For this to happen, the "Globals" flag needs to be set.
1003 * Unfortunately, this technical detail is hard to explain to the
1004 * average user and she shouldn't have to worry about this, ideally.
1005 * So in order to save everyone's sanity use a different default for a
1006 * handful of special plugins. --octo
1008 if ((strcasecmp("perl", plugin_name) == 0) ||
1009 (strcasecmp("python", plugin_name) == 0))
1010 flags |= PLUGIN_FLAGS_GLOBAL;
1012 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
1013 * type when matching the filename */
1014 status = ssnprintf(typename, sizeof(typename), "%s.so", plugin_name);
1015 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
1016 WARNING("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1020 if ((dh = opendir(dir)) == NULL) {
1022 ERROR("plugin_load: opendir (%s) failed: %s", dir,
1023 sstrerror(errno, errbuf, sizeof(errbuf)));
1027 while ((de = readdir(dh)) != NULL) {
1028 if (strcasecmp(de->d_name, typename))
1031 status = ssnprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1032 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1033 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1037 if (lstat(filename, &statbuf) == -1) {
1039 WARNING("plugin_load: stat (\"%s\") failed: %s", filename,
1040 sstrerror(errno, errbuf, sizeof(errbuf)));
1042 } else if (!S_ISREG(statbuf.st_mode)) {
1043 /* don't follow symlinks */
1044 WARNING("plugin_load: %s is not a regular file.", filename);
1048 status = plugin_load_file(filename, flags);
1051 plugin_mark_loaded(plugin_name);
1053 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1056 ERROR("plugin_load: Load plugin \"%s\" failed with "
1058 plugin_name, status);
1064 if (filename[0] == 0)
1065 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1071 * The `register_*' functions follow
1073 int plugin_register_config(const char *name,
1074 int (*callback)(const char *key, const char *val),
1075 const char **keys, int keys_num) {
1076 cf_register(name, callback, keys, keys_num);
1078 } /* int plugin_register_config */
1080 int plugin_register_complex_config(const char *type,
1081 int (*callback)(oconfig_item_t *)) {
1082 return (cf_register_complex(type, callback));
1083 } /* int plugin_register_complex_config */
1085 int plugin_register_init(const char *name, int (*callback)(void)) {
1086 return (create_register_callback(&list_init, name, (void *)callback,
1087 /* user_data = */ NULL));
1088 } /* plugin_register_init */
1090 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1091 const read_func_t *rf0;
1092 const read_func_t *rf1;
1097 if (rf0->rf_next_read < rf1->rf_next_read)
1099 else if (rf0->rf_next_read > rf1->rf_next_read)
1103 } /* int plugin_compare_read_func */
1105 /* Add a read function to both, the heap and a linked list. The linked list if
1106 * used to look-up read functions, especially for the remove function. The heap
1107 * is used to determine which plugin to read next. */
1108 static int plugin_insert_read(read_func_t *rf) {
1112 rf->rf_next_read = cdtime();
1113 rf->rf_effective_interval = rf->rf_interval;
1115 pthread_mutex_lock(&read_lock);
1117 if (read_list == NULL) {
1118 read_list = llist_create();
1119 if (read_list == NULL) {
1120 pthread_mutex_unlock(&read_lock);
1121 ERROR("plugin_insert_read: read_list failed.");
1126 if (read_heap == NULL) {
1127 read_heap = c_heap_create(plugin_compare_read_func);
1128 if (read_heap == NULL) {
1129 pthread_mutex_unlock(&read_lock);
1130 ERROR("plugin_insert_read: c_heap_create failed.");
1135 le = llist_search(read_list, rf->rf_name);
1137 pthread_mutex_unlock(&read_lock);
1138 WARNING("The read function \"%s\" is already registered. "
1139 "Check for duplicate \"LoadPlugin\" lines "
1140 "in your configuration!",
1145 le = llentry_create(rf->rf_name, rf);
1147 pthread_mutex_unlock(&read_lock);
1148 ERROR("plugin_insert_read: llentry_create failed.");
1152 status = c_heap_insert(read_heap, rf);
1154 pthread_mutex_unlock(&read_lock);
1155 ERROR("plugin_insert_read: c_heap_insert failed.");
1156 llentry_destroy(le);
1160 /* This does not fail. */
1161 llist_append(read_list, le);
1163 /* Wake up all the read threads. */
1164 pthread_cond_broadcast(&read_cond);
1165 pthread_mutex_unlock(&read_lock);
1167 } /* int plugin_insert_read */
1169 int plugin_register_read(const char *name, int (*callback)(void)) {
1173 rf = calloc(1, sizeof(*rf));
1175 ERROR("plugin_register_read: calloc failed.");
1179 rf->rf_callback = (void *)callback;
1180 rf->rf_udata.data = NULL;
1181 rf->rf_udata.free_func = NULL;
1182 rf->rf_ctx = plugin_get_ctx();
1183 rf->rf_group[0] = '\0';
1184 rf->rf_name = strdup(name);
1185 rf->rf_type = RF_SIMPLE;
1186 rf->rf_interval = plugin_get_interval();
1188 status = plugin_insert_read(rf);
1195 } /* int plugin_register_read */
1197 int plugin_register_complex_read(const char *group, const char *name,
1198 plugin_read_cb callback, cdtime_t interval,
1199 user_data_t const *user_data) {
1203 rf = calloc(1, sizeof(*rf));
1205 ERROR("plugin_register_complex_read: calloc failed.");
1209 rf->rf_callback = (void *)callback;
1211 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1213 rf->rf_group[0] = '\0';
1214 rf->rf_name = strdup(name);
1215 rf->rf_type = RF_COMPLEX;
1216 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1219 if (user_data == NULL) {
1220 rf->rf_udata.data = NULL;
1221 rf->rf_udata.free_func = NULL;
1223 rf->rf_udata = *user_data;
1226 rf->rf_ctx = plugin_get_ctx();
1228 status = plugin_insert_read(rf);
1235 } /* int plugin_register_complex_read */
1237 int plugin_register_write(const char *name, plugin_write_cb callback,
1238 user_data_t const *ud) {
1239 return (create_register_callback(&list_write, name, (void *)callback, ud));
1240 } /* int plugin_register_write */
1242 static int plugin_flush_timeout_callback(user_data_t *ud) {
1243 flush_callback_t *cb = ud->data;
1245 return plugin_flush(cb->name, cb->timeout, /* identifier = */ NULL);
1246 } /* static int plugin_flush_callback */
1248 static void plugin_flush_timeout_callback_free(void *data) {
1249 flush_callback_t *cb = data;
1256 } /* static void plugin_flush_callback_free */
1258 static char *plugin_flush_callback_name(const char *name) {
1259 const char *flush_prefix = "flush/";
1264 prefix_size = strlen(flush_prefix);
1265 name_size = strlen(name);
1267 flush_name = malloc(name_size + prefix_size + 1);
1268 if (flush_name == NULL) {
1269 ERROR("plugin_flush_callback_name: malloc failed.");
1273 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1274 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1277 } /* static char *plugin_flush_callback_name */
1279 int plugin_register_flush(const char *name, plugin_flush_cb callback,
1280 user_data_t const *ud) {
1282 plugin_ctx_t ctx = plugin_get_ctx();
1284 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1288 if (ctx.flush_interval != 0) {
1290 flush_callback_t *cb;
1292 flush_name = plugin_flush_callback_name(name);
1293 if (flush_name == NULL)
1296 cb = malloc(sizeof(*cb));
1298 ERROR("plugin_register_flush: malloc failed.");
1303 cb->name = strdup(name);
1304 if (cb->name == NULL) {
1305 ERROR("plugin_register_flush: strdup failed.");
1310 cb->timeout = ctx.flush_timeout;
1312 status = plugin_register_complex_read(
1313 /* group = */ "flush",
1314 /* name = */ flush_name,
1315 /* callback = */ plugin_flush_timeout_callback,
1316 /* interval = */ ctx.flush_interval,
1317 /* user data = */ &(user_data_t){
1318 .data = cb, .free_func = plugin_flush_timeout_callback_free,
1330 } /* int plugin_register_flush */
1332 int plugin_register_missing(const char *name, plugin_missing_cb callback,
1333 user_data_t const *ud) {
1334 return (create_register_callback(&list_missing, name, (void *)callback, ud));
1335 } /* int plugin_register_missing */
1337 int plugin_register_shutdown(const char *name, int (*callback)(void)) {
1338 return (create_register_callback(&list_shutdown, name, (void *)callback,
1339 /* user_data = */ NULL));
1340 } /* int plugin_register_shutdown */
1342 static void plugin_free_data_sets(void) {
1346 if (data_sets == NULL)
1349 while (c_avl_pick(data_sets, &key, &value) == 0) {
1350 data_set_t *ds = value;
1351 /* key is a pointer to ds->type */
1357 c_avl_destroy(data_sets);
1359 } /* void plugin_free_data_sets */
1361 int plugin_register_data_set(const data_set_t *ds) {
1362 data_set_t *ds_copy;
1364 if ((data_sets != NULL) && (c_avl_get(data_sets, ds->type, NULL) == 0)) {
1365 NOTICE("Replacing DS `%s' with another version.", ds->type);
1366 plugin_unregister_data_set(ds->type);
1367 } else if (data_sets == NULL) {
1368 data_sets = c_avl_create((int (*)(const void *, const void *))strcmp);
1369 if (data_sets == NULL)
1373 ds_copy = malloc(sizeof(*ds_copy));
1374 if (ds_copy == NULL)
1376 memcpy(ds_copy, ds, sizeof(data_set_t));
1378 ds_copy->ds = malloc(sizeof(*ds_copy->ds) * ds->ds_num);
1379 if (ds_copy->ds == NULL) {
1384 for (size_t i = 0; i < ds->ds_num; i++)
1385 memcpy(ds_copy->ds + i, ds->ds + i, sizeof(data_source_t));
1387 return (c_avl_insert(data_sets, (void *)ds_copy->type, (void *)ds_copy));
1388 } /* int plugin_register_data_set */
1390 int plugin_register_log(const char *name, plugin_log_cb callback,
1391 user_data_t const *ud) {
1392 return (create_register_callback(&list_log, name, (void *)callback, ud));
1393 } /* int plugin_register_log */
1395 int plugin_register_notification(const char *name,
1396 plugin_notification_cb callback,
1397 user_data_t const *ud) {
1399 create_register_callback(&list_notification, name, (void *)callback, ud));
1400 } /* int plugin_register_log */
1402 int plugin_unregister_config(const char *name) {
1403 cf_unregister(name);
1405 } /* int plugin_unregister_config */
1407 int plugin_unregister_complex_config(const char *name) {
1408 cf_unregister_complex(name);
1410 } /* int plugin_unregister_complex_config */
1412 int plugin_unregister_init(const char *name) {
1413 return (plugin_unregister(list_init, name));
1416 int plugin_unregister_read(const char *name) /* {{{ */
1424 pthread_mutex_lock(&read_lock);
1426 if (read_list == NULL) {
1427 pthread_mutex_unlock(&read_lock);
1431 le = llist_search(read_list, name);
1433 pthread_mutex_unlock(&read_lock);
1434 WARNING("plugin_unregister_read: No such read function: %s", name);
1438 llist_remove(read_list, le);
1442 rf->rf_type = RF_REMOVE;
1444 pthread_mutex_unlock(&read_lock);
1446 llentry_destroy(le);
1448 DEBUG("plugin_unregister_read: Marked `%s' for removal.", name);
1451 } /* }}} int plugin_unregister_read */
1453 void plugin_log_available_writers(void) {
1454 log_list_callbacks(&list_write, "Available write targets:");
1457 static int compare_read_func_group(llentry_t *e, void *ud) /* {{{ */
1459 read_func_t *rf = e->value;
1462 return strcmp(rf->rf_group, (const char *)group);
1463 } /* }}} int compare_read_func_group */
1465 int plugin_unregister_read_group(const char *group) /* {{{ */
1475 pthread_mutex_lock(&read_lock);
1477 if (read_list == NULL) {
1478 pthread_mutex_unlock(&read_lock);
1483 le = llist_search_custom(read_list, compare_read_func_group, (void *)group);
1490 llist_remove(read_list, le);
1494 rf->rf_type = RF_REMOVE;
1496 llentry_destroy(le);
1498 DEBUG("plugin_unregister_read_group: "
1499 "Marked `%s' (group `%s') for removal.",
1500 rf->rf_name, group);
1503 pthread_mutex_unlock(&read_lock);
1506 WARNING("plugin_unregister_read_group: No such "
1507 "group of read function: %s",
1513 } /* }}} int plugin_unregister_read_group */
1515 int plugin_unregister_write(const char *name) {
1516 return (plugin_unregister(list_write, name));
1519 int plugin_unregister_flush(const char *name) {
1520 plugin_ctx_t ctx = plugin_get_ctx();
1522 if (ctx.flush_interval != 0) {
1525 flush_name = plugin_flush_callback_name(name);
1526 if (flush_name != NULL) {
1527 plugin_unregister_read(flush_name);
1532 return plugin_unregister(list_flush, name);
1535 int plugin_unregister_missing(const char *name) {
1536 return (plugin_unregister(list_missing, name));
1539 int plugin_unregister_shutdown(const char *name) {
1540 return (plugin_unregister(list_shutdown, name));
1543 int plugin_unregister_data_set(const char *name) {
1546 if (data_sets == NULL)
1549 if (c_avl_remove(data_sets, name, NULL, (void *)&ds) != 0)
1556 } /* int plugin_unregister_data_set */
1558 int plugin_unregister_log(const char *name) {
1559 return (plugin_unregister(list_log, name));
1562 int plugin_unregister_notification(const char *name) {
1563 return (plugin_unregister(list_notification, name));
1566 int plugin_init_all(void) {
1567 char const *chain_name;
1572 /* Init the value cache */
1575 if (IS_TRUE(global_option_get("CollectInternalStats")))
1576 record_statistics = 1;
1578 chain_name = global_option_get("PreCacheChain");
1579 pre_cache_chain = fc_chain_get_by_name(chain_name);
1581 chain_name = global_option_get("PostCacheChain");
1582 post_cache_chain = fc_chain_get_by_name(chain_name);
1584 write_limit_high = global_option_get_long("WriteQueueLimitHigh",
1586 if (write_limit_high < 0) {
1587 ERROR("WriteQueueLimitHigh must be positive or zero.");
1588 write_limit_high = 0;
1592 global_option_get_long("WriteQueueLimitLow",
1593 /* default = */ write_limit_high / 2);
1594 if (write_limit_low < 0) {
1595 ERROR("WriteQueueLimitLow must be positive or zero.");
1596 write_limit_low = write_limit_high / 2;
1597 } else if (write_limit_low > write_limit_high) {
1598 ERROR("WriteQueueLimitLow must not be larger than "
1599 "WriteQueueLimitHigh.");
1600 write_limit_low = write_limit_high;
1603 write_threads_num = global_option_get_long("WriteThreads",
1605 if (write_threads_num < 1) {
1606 ERROR("WriteThreads must be positive.");
1607 write_threads_num = 5;
1610 if ((list_init == NULL) && (read_heap == NULL))
1613 /* Calling all init callbacks before checking if read callbacks
1614 * are available allows the init callbacks to register the read
1616 le = llist_head(list_init);
1617 while (le != NULL) {
1618 callback_func_t *cf;
1619 plugin_init_cb callback;
1620 plugin_ctx_t old_ctx;
1623 old_ctx = plugin_set_ctx(cf->cf_ctx);
1624 callback = cf->cf_callback;
1625 status = (*callback)();
1626 plugin_set_ctx(old_ctx);
1629 ERROR("Initialization of plugin `%s' "
1630 "failed with status %i. "
1631 "Plugin will be unloaded.",
1633 /* Plugins that register read callbacks from the init
1634 * callback should take care of appropriate error
1635 * handling themselves. */
1636 /* FIXME: Unload _all_ functions */
1637 plugin_unregister_read(le->key);
1644 start_write_threads((size_t)write_threads_num);
1647 global_option_get_time("MaxReadInterval", DEFAULT_MAX_READ_INTERVAL);
1649 /* Start read-threads */
1650 if (read_heap != NULL) {
1654 rt = global_option_get("ReadThreads");
1657 start_read_threads((num > 0) ? ((size_t)num) : 5);
1660 } /* void plugin_init_all */
1662 /* TODO: Rename this function. */
1663 void plugin_read_all(void) {
1664 if (record_statistics) {
1665 plugin_update_internal_statistics();
1670 } /* void plugin_read_all */
1672 /* Read function called when the `-T' command line argument is given. */
1673 int plugin_read_all_once(void) {
1675 int return_status = 0;
1677 if (read_heap == NULL) {
1678 NOTICE("No read-functions are registered.");
1684 plugin_ctx_t old_ctx;
1686 rf = c_heap_get_root(read_heap);
1690 old_ctx = plugin_set_ctx(rf->rf_ctx);
1692 if (rf->rf_type == RF_SIMPLE) {
1693 int (*callback)(void);
1695 callback = rf->rf_callback;
1696 status = (*callback)();
1698 plugin_read_cb callback;
1700 callback = rf->rf_callback;
1701 status = (*callback)(&rf->rf_udata);
1704 plugin_set_ctx(old_ctx);
1707 NOTICE("read-function of plugin `%s' failed.", rf->rf_name);
1712 destroy_callback((void *)rf);
1715 return (return_status);
1716 } /* int plugin_read_all_once */
1718 int plugin_write(const char *plugin, /* {{{ */
1719 const data_set_t *ds, const value_list_t *vl) {
1726 if (list_write == NULL)
1730 ds = plugin_get_ds(vl->type);
1732 ERROR("plugin_write: Unable to lookup type `%s'.", vl->type);
1737 if (plugin == NULL) {
1741 le = llist_head(list_write);
1742 while (le != NULL) {
1743 callback_func_t *cf = le->value;
1744 plugin_write_cb callback;
1746 /* do not switch plugin context; rather keep the context (interval)
1747 * information of the calling read plugin */
1749 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1750 callback = cf->cf_callback;
1751 status = (*callback)(ds, vl, &cf->cf_udata);
1760 if ((success == 0) && (failure != 0))
1764 } else /* plugin != NULL */
1766 callback_func_t *cf;
1767 plugin_write_cb callback;
1769 le = llist_head(list_write);
1770 while (le != NULL) {
1771 if (strcasecmp(plugin, le->key) == 0)
1782 /* do not switch plugin context; rather keep the context (interval)
1783 * information of the calling read plugin */
1785 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1786 callback = cf->cf_callback;
1787 status = (*callback)(ds, vl, &cf->cf_udata);
1791 } /* }}} int plugin_write */
1793 int plugin_flush(const char *plugin, cdtime_t timeout, const char *identifier) {
1796 if (list_flush == NULL)
1799 le = llist_head(list_flush);
1800 while (le != NULL) {
1801 callback_func_t *cf;
1802 plugin_flush_cb callback;
1803 plugin_ctx_t old_ctx;
1805 if ((plugin != NULL) && (strcmp(plugin, le->key) != 0)) {
1811 old_ctx = plugin_set_ctx(cf->cf_ctx);
1812 callback = cf->cf_callback;
1814 (*callback)(timeout, identifier, &cf->cf_udata);
1816 plugin_set_ctx(old_ctx);
1821 } /* int plugin_flush */
1823 int plugin_shutdown_all(void) {
1825 int ret = 0; // Assume success.
1827 destroy_all_callbacks(&list_init);
1829 stop_read_threads();
1831 pthread_mutex_lock(&read_lock);
1832 llist_destroy(read_list);
1834 pthread_mutex_unlock(&read_lock);
1836 destroy_read_heap();
1838 /* blocks until all write threads have shut down. */
1839 stop_write_threads();
1841 /* ask all plugins to write out the state they kept. */
1842 plugin_flush(/* plugin = */ NULL,
1844 /* identifier = */ NULL);
1847 if (list_shutdown != NULL)
1848 le = llist_head(list_shutdown);
1850 while (le != NULL) {
1851 callback_func_t *cf;
1852 plugin_shutdown_cb callback;
1853 plugin_ctx_t old_ctx;
1856 old_ctx = plugin_set_ctx(cf->cf_ctx);
1857 callback = cf->cf_callback;
1859 /* Advance the pointer before calling the callback allows
1860 * shutdown functions to unregister themselves. If done the
1861 * other way around the memory `le' points to will be freed
1862 * after callback returns. */
1865 if ((*callback)() != 0)
1868 plugin_set_ctx(old_ctx);
1871 /* Write plugins which use the `user_data' pointer usually need the
1872 * same data available to the flush callback. If this is the case, set
1873 * the free_function to NULL when registering the flush callback and to
1874 * the real free function when registering the write callback. This way
1875 * the data isn't freed twice. */
1876 destroy_all_callbacks(&list_flush);
1877 destroy_all_callbacks(&list_missing);
1878 destroy_all_callbacks(&list_write);
1880 destroy_all_callbacks(&list_notification);
1881 destroy_all_callbacks(&list_shutdown);
1882 destroy_all_callbacks(&list_log);
1884 plugin_free_loaded();
1885 plugin_free_data_sets();
1887 } /* void plugin_shutdown_all */
1889 int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1893 if (list_missing == NULL)
1896 le = llist_head(list_missing);
1897 while (le != NULL) {
1898 callback_func_t *cf;
1899 plugin_missing_cb callback;
1900 plugin_ctx_t old_ctx;
1904 old_ctx = plugin_set_ctx(cf->cf_ctx);
1905 callback = cf->cf_callback;
1907 status = (*callback)(vl, &cf->cf_udata);
1908 plugin_set_ctx(old_ctx);
1911 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1912 "failed with status %i.",
1923 } /* int }}} plugin_dispatch_missing */
1925 static int plugin_dispatch_values_internal(value_list_t *vl) {
1927 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1931 _Bool free_meta_data = 0;
1935 /* These fields are initialized by plugin_value_list_clone() if needed: */
1936 assert(vl->host[0] != 0);
1937 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1938 assert(vl->interval != 0);
1940 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1941 ERROR("plugin_dispatch_values: Invalid value list "
1947 /* Free meta data only if the calling function didn't specify any. In
1948 * this case matches and targets may add some and the calling function
1949 * may not expect (and therefore free) that data. */
1950 if (vl->meta == NULL)
1953 if (list_write == NULL)
1954 c_complain_once(LOG_WARNING, &no_write_complaint,
1955 "plugin_dispatch_values: No write callback has been "
1956 "registered. Please load at least one output plugin, "
1957 "if you want the collected data to be stored.");
1959 if (data_sets == NULL) {
1960 ERROR("plugin_dispatch_values: No data sets registered. "
1961 "Could the types database be read? Check "
1962 "your `TypesDB' setting!");
1966 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1967 char ident[6 * DATA_MAX_NAME_LEN];
1969 FORMAT_VL(ident, sizeof(ident), vl);
1970 INFO("plugin_dispatch_values: Dataset not found: %s "
1971 "(from \"%s\"), check your types.db!",
1976 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1978 "plugin = %s; plugin_instance = %s; "
1979 "type = %s; type_instance = %s;",
1980 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1981 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1984 assert(0 == strcmp(ds->type, vl->type));
1986 if (0 != strcmp(ds->type, vl->type))
1987 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1988 ds->type, vl->type);
1992 assert(ds->ds_num == vl->values_len);
1994 if (ds->ds_num != vl->values_len) {
1995 ERROR("plugin_dispatch_values: ds->type = %s: "
1996 "(ds->ds_num = %zu) != "
1997 "(vl->values_len = %zu)",
1998 ds->type, ds->ds_num, vl->values_len);
2003 escape_slashes(vl->host, sizeof(vl->host));
2004 escape_slashes(vl->plugin, sizeof(vl->plugin));
2005 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
2006 escape_slashes(vl->type, sizeof(vl->type));
2007 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
2009 if (pre_cache_chain != NULL) {
2010 status = fc_process_chain(ds, vl, pre_cache_chain);
2012 WARNING("plugin_dispatch_values: Running the "
2013 "pre-cache chain failed with "
2016 } else if (status == FC_TARGET_STOP)
2020 /* Update the value cache */
2023 if (post_cache_chain != NULL) {
2024 status = fc_process_chain(ds, vl, post_cache_chain);
2026 WARNING("plugin_dispatch_values: Running the "
2027 "post-cache chain failed with "
2032 fc_default_action(ds, vl);
2034 if ((free_meta_data != 0) && (vl->meta != NULL)) {
2035 meta_data_destroy(vl->meta);
2040 } /* int plugin_dispatch_values_internal */
2042 static double get_drop_probability(void) /* {{{ */
2048 pthread_mutex_lock(&write_lock);
2049 wql = write_queue_length;
2050 pthread_mutex_unlock(&write_lock);
2052 if (wql < write_limit_low)
2054 if (wql >= write_limit_high)
2057 pos = 1 + wql - write_limit_low;
2058 size = 1 + write_limit_high - write_limit_low;
2060 return (((double)pos) / ((double)size));
2061 } /* }}} double get_drop_probability */
2063 static _Bool check_drop_value(void) /* {{{ */
2065 static cdtime_t last_message_time = 0;
2066 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2072 if (write_limit_high == 0)
2075 p = get_drop_probability();
2079 status = pthread_mutex_trylock(&last_message_lock);
2084 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2085 last_message_time = now;
2086 ERROR("plugin_dispatch_values: Low water mark "
2087 "reached. Dropping %.0f%% of metrics.",
2090 pthread_mutex_unlock(&last_message_lock);
2101 } /* }}} _Bool check_drop_value */
2103 int plugin_dispatch_values(value_list_t const *vl) {
2105 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2107 if (check_drop_value()) {
2108 if (record_statistics) {
2109 pthread_mutex_lock(&statistics_lock);
2110 stats_values_dropped++;
2111 pthread_mutex_unlock(&statistics_lock);
2116 status = plugin_write_enqueue(vl);
2119 ERROR("plugin_dispatch_values: plugin_write_enqueue failed "
2120 "with status %i (%s).",
2121 status, sstrerror(status, errbuf, sizeof(errbuf)));
2128 __attribute__((sentinel)) int
2129 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2130 _Bool store_percentage, int store_type, ...) {
2136 assert(template->values_len == 1);
2138 /* Calculate sum for Gauge to calculate percent if needed */
2139 if (DS_TYPE_GAUGE == store_type) {
2140 va_start(ap, store_type);
2145 name = va_arg(ap, char const *);
2149 value = va_arg(ap, gauge_t);
2156 vl = plugin_value_list_clone(template);
2157 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2158 if (store_percentage)
2159 sstrncpy(vl->type, "percent", sizeof(vl->type));
2161 va_start(ap, store_type);
2166 /* Set the type instance. */
2167 name = va_arg(ap, char const *);
2170 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2172 /* Set the value. */
2173 switch (store_type) {
2175 vl->values[0].gauge = va_arg(ap, gauge_t);
2176 if (store_percentage)
2177 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2179 case DS_TYPE_ABSOLUTE:
2180 vl->values[0].absolute = va_arg(ap, absolute_t);
2182 case DS_TYPE_COUNTER:
2183 vl->values[0].counter = va_arg(ap, counter_t);
2185 case DS_TYPE_DERIVE:
2186 vl->values[0].derive = va_arg(ap, derive_t);
2189 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2193 status = plugin_write_enqueue(vl);
2199 plugin_value_list_free(vl);
2201 } /* }}} int plugin_dispatch_multivalue */
2203 int plugin_dispatch_notification(const notification_t *notif) {
2205 /* Possible TODO: Add flap detection here */
2207 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2208 "time = %.3f; host = %s;",
2209 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2212 /* Nobody cares for notifications */
2213 if (list_notification == NULL)
2216 le = llist_head(list_notification);
2217 while (le != NULL) {
2218 callback_func_t *cf;
2219 plugin_notification_cb callback;
2222 /* do not switch plugin context; rather keep the context
2223 * (interval) information of the calling plugin */
2226 callback = cf->cf_callback;
2227 status = (*callback)(notif, &cf->cf_udata);
2229 WARNING("plugin_dispatch_notification: Notification "
2230 "callback %s returned %i.",
2238 } /* int plugin_dispatch_notification */
2240 void plugin_log(int level, const char *format, ...) {
2246 if (level >= LOG_DEBUG)
2250 va_start(ap, format);
2251 vsnprintf(msg, sizeof(msg), format, ap);
2252 msg[sizeof(msg) - 1] = '\0';
2255 if (list_log == NULL) {
2256 fprintf(stderr, "%s\n", msg);
2260 le = llist_head(list_log);
2261 while (le != NULL) {
2262 callback_func_t *cf;
2263 plugin_log_cb callback;
2266 callback = cf->cf_callback;
2268 /* do not switch plugin context; rather keep the context
2269 * (interval) information of the calling plugin */
2271 (*callback)(level, msg, &cf->cf_udata);
2275 } /* void plugin_log */
2277 int parse_log_severity(const char *severity) {
2280 if ((0 == strcasecmp(severity, "emerg")) ||
2281 (0 == strcasecmp(severity, "alert")) ||
2282 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2283 log_level = LOG_ERR;
2284 else if (0 == strcasecmp(severity, "warning"))
2285 log_level = LOG_WARNING;
2286 else if (0 == strcasecmp(severity, "notice"))
2287 log_level = LOG_NOTICE;
2288 else if (0 == strcasecmp(severity, "info"))
2289 log_level = LOG_INFO;
2291 else if (0 == strcasecmp(severity, "debug"))
2292 log_level = LOG_DEBUG;
2293 #endif /* COLLECT_DEBUG */
2296 } /* int parse_log_severity */
2298 int parse_notif_severity(const char *severity) {
2299 int notif_severity = -1;
2301 if (strcasecmp(severity, "FAILURE") == 0)
2302 notif_severity = NOTIF_FAILURE;
2303 else if (strcmp(severity, "OKAY") == 0)
2304 notif_severity = NOTIF_OKAY;
2305 else if ((strcmp(severity, "WARNING") == 0) ||
2306 (strcmp(severity, "WARN") == 0))
2307 notif_severity = NOTIF_WARNING;
2309 return (notif_severity);
2310 } /* int parse_notif_severity */
2312 const data_set_t *plugin_get_ds(const char *name) {
2315 if (data_sets == NULL) {
2316 ERROR("plugin_get_ds: No data sets are defined yet.");
2320 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2321 DEBUG("No such dataset registered: %s", name);
2326 } /* data_set_t *plugin_get_ds */
2328 static int plugin_notification_meta_add(notification_t *n, const char *name,
2329 enum notification_meta_type_e type,
2330 const void *value) {
2331 notification_meta_t *meta;
2332 notification_meta_t *tail;
2334 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2335 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2339 meta = calloc(1, sizeof(*meta));
2341 ERROR("plugin_notification_meta_add: calloc failed.");
2345 sstrncpy(meta->name, name, sizeof(meta->name));
2349 case NM_TYPE_STRING: {
2350 meta->nm_value.nm_string = strdup((const char *)value);
2351 if (meta->nm_value.nm_string == NULL) {
2352 ERROR("plugin_notification_meta_add: strdup failed.");
2358 case NM_TYPE_SIGNED_INT: {
2359 meta->nm_value.nm_signed_int = *((int64_t *)value);
2362 case NM_TYPE_UNSIGNED_INT: {
2363 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2366 case NM_TYPE_DOUBLE: {
2367 meta->nm_value.nm_double = *((double *)value);
2370 case NM_TYPE_BOOLEAN: {
2371 meta->nm_value.nm_boolean = *((_Bool *)value);
2375 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2379 } /* switch (type) */
2383 while ((tail != NULL) && (tail->next != NULL))
2392 } /* int plugin_notification_meta_add */
2394 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2395 const char *value) {
2396 return (plugin_notification_meta_add(n, name, NM_TYPE_STRING, value));
2399 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2401 return (plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value));
2404 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2407 return (plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value));
2410 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2412 return (plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value));
2415 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2417 return (plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value));
2420 int plugin_notification_meta_copy(notification_t *dst,
2421 const notification_t *src) {
2422 assert(dst != NULL);
2423 assert(src != NULL);
2425 assert((src->meta == NULL) || (src->meta != dst->meta));
2427 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2428 if (meta->type == NM_TYPE_STRING)
2429 plugin_notification_meta_add_string(dst, meta->name,
2430 meta->nm_value.nm_string);
2431 else if (meta->type == NM_TYPE_SIGNED_INT)
2432 plugin_notification_meta_add_signed_int(dst, meta->name,
2433 meta->nm_value.nm_signed_int);
2434 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2435 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2436 meta->nm_value.nm_unsigned_int);
2437 else if (meta->type == NM_TYPE_DOUBLE)
2438 plugin_notification_meta_add_double(dst, meta->name,
2439 meta->nm_value.nm_double);
2440 else if (meta->type == NM_TYPE_BOOLEAN)
2441 plugin_notification_meta_add_boolean(dst, meta->name,
2442 meta->nm_value.nm_boolean);
2446 } /* int plugin_notification_meta_copy */
2448 int plugin_notification_meta_free(notification_meta_t *n) {
2449 notification_meta_t *this;
2450 notification_meta_t *next;
2453 ERROR("plugin_notification_meta_free: n == NULL!");
2458 while (this != NULL) {
2461 if (this->type == NM_TYPE_STRING) {
2462 /* Assign to a temporary variable to work around nm_string's const
2464 void *tmp = (void *)this->nm_value.nm_string;
2467 this->nm_value.nm_string = NULL;
2475 } /* int plugin_notification_meta_free */
2477 static void plugin_ctx_destructor(void *ctx) {
2479 } /* void plugin_ctx_destructor */
2481 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2483 static plugin_ctx_t *plugin_ctx_create(void) {
2486 ctx = malloc(sizeof(*ctx));
2489 ERROR("Failed to allocate plugin context: %s",
2490 sstrerror(errno, errbuf, sizeof(errbuf)));
2495 assert(plugin_ctx_key_initialized);
2496 pthread_setspecific(plugin_ctx_key, ctx);
2497 DEBUG("Created new plugin context.");
2499 } /* int plugin_ctx_create */
2501 void plugin_init_ctx(void) {
2502 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2503 plugin_ctx_key_initialized = 1;
2504 } /* void plugin_init_ctx */
2506 plugin_ctx_t plugin_get_ctx(void) {
2509 assert(plugin_ctx_key_initialized);
2510 ctx = pthread_getspecific(plugin_ctx_key);
2513 ctx = plugin_ctx_create();
2514 /* this must no happen -- exit() instead? */
2520 } /* plugin_ctx_t plugin_get_ctx */
2522 plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2526 assert(plugin_ctx_key_initialized);
2527 c = pthread_getspecific(plugin_ctx_key);
2530 c = plugin_ctx_create();
2531 /* this must no happen -- exit() instead? */
2540 } /* void plugin_set_ctx */
2542 cdtime_t plugin_get_interval(void) {
2545 interval = plugin_get_ctx().interval;
2549 return cf_get_default_interval();
2550 } /* cdtime_t plugin_get_interval */
2554 void *(*start_routine)(void *);
2558 static void *plugin_thread_start(void *arg) {
2559 plugin_thread_t *plugin_thread = arg;
2561 void *(*start_routine)(void *) = plugin_thread->start_routine;
2562 void *plugin_arg = plugin_thread->arg;
2564 plugin_set_ctx(plugin_thread->ctx);
2566 sfree(plugin_thread);
2568 return start_routine(plugin_arg);
2569 } /* void *plugin_thread_start */
2571 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2572 void *(*start_routine)(void *), void *arg,
2574 plugin_thread_t *plugin_thread;
2576 plugin_thread = malloc(sizeof(*plugin_thread));
2577 if (plugin_thread == NULL)
2580 plugin_thread->ctx = plugin_get_ctx();
2581 plugin_thread->start_routine = start_routine;
2582 plugin_thread->arg = arg;
2584 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2586 sfree(plugin_thread);
2591 set_thread_name(*thread, name);
2594 } /* int plugin_thread_create */
2596 /* vim: set sw=8 ts=8 noet fdm=marker : */