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 int plugin_update_internal_statistics(void) { /* {{{ */
157 gauge_t copy_write_queue_length = (gauge_t)write_queue_length;
159 /* Initialize `vl' */
160 value_list_t vl = VALUE_LIST_INIT;
161 sstrncpy(vl.plugin, "collectd", sizeof(vl.plugin));
162 vl.interval = plugin_get_interval();
165 sstrncpy(vl.plugin_instance, "write_queue", sizeof(vl.plugin_instance));
167 /* Write queue : queue length */
168 vl.values = &(value_t){.gauge = copy_write_queue_length};
170 sstrncpy(vl.type, "queue_length", sizeof(vl.type));
171 vl.type_instance[0] = 0;
172 plugin_dispatch_values(&vl);
174 /* Write queue : Values dropped (queue length > low limit) */
175 vl.values = &(value_t){.gauge = (gauge_t)stats_values_dropped};
177 sstrncpy(vl.type, "derive", sizeof(vl.type));
178 sstrncpy(vl.type_instance, "dropped", sizeof(vl.type_instance));
179 plugin_dispatch_values(&vl);
182 sstrncpy(vl.plugin_instance, "cache", sizeof(vl.plugin_instance));
184 /* Cache : Nb entry in cache tree */
185 vl.values = &(value_t){.gauge = (gauge_t)uc_get_size()};
187 sstrncpy(vl.type, "cache_size", sizeof(vl.type));
188 vl.type_instance[0] = 0;
189 plugin_dispatch_values(&vl);
192 } /* }}} int plugin_update_internal_statistics */
194 static void destroy_callback(callback_func_t *cf) /* {{{ */
199 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL)) {
200 cf->cf_udata.free_func(cf->cf_udata.data);
201 cf->cf_udata.data = NULL;
202 cf->cf_udata.free_func = NULL;
205 } /* }}} void destroy_callback */
207 static void destroy_all_callbacks(llist_t **list) /* {{{ */
214 le = llist_head(*list);
221 destroy_callback(le->value);
227 llist_destroy(*list);
229 } /* }}} void destroy_all_callbacks */
231 static void destroy_read_heap(void) /* {{{ */
233 if (read_heap == NULL)
239 rf = c_heap_get_root(read_heap);
243 destroy_callback((callback_func_t *)rf);
246 c_heap_destroy(read_heap);
248 } /* }}} void destroy_read_heap */
250 static int register_callback(llist_t **list, /* {{{ */
251 const char *name, callback_func_t *cf) {
256 *list = llist_create();
258 ERROR("plugin: register_callback: "
259 "llist_create failed.");
260 destroy_callback(cf);
267 ERROR("plugin: register_callback: strdup failed.");
268 destroy_callback(cf);
272 le = llist_search(*list, name);
274 le = llentry_create(key, cf);
276 ERROR("plugin: register_callback: "
277 "llentry_create failed.");
279 destroy_callback(cf);
283 llist_append(*list, le);
285 callback_func_t *old_cf;
290 WARNING("plugin: register_callback: "
291 "a callback named `%s' already exists - "
292 "overwriting the old entry!",
295 destroy_callback(old_cf);
300 } /* }}} int register_callback */
302 static void log_list_callbacks(llist_t **list, /* {{{ */
303 const char *comment) {
311 n = llist_size(*list);
313 INFO("%s [none]", comment);
317 keys = calloc(n, sizeof(char *));
320 ERROR("%s: failed to allocate memory for list of callbacks", comment);
325 for (le = llist_head(*list), i = 0, len = 0; le != NULL; le = le->next, i++) {
327 len += strlen(le->key) + 6;
329 str = malloc(len + 10);
331 ERROR("%s: failed to allocate memory for list of callbacks", comment);
334 strjoin(str, len, keys, n, "', '");
335 INFO("%s ['%s']", comment, str);
339 } /* }}} void log_list_callbacks */
341 static int create_register_callback(llist_t **list, /* {{{ */
342 const char *name, void *callback,
343 user_data_t const *ud) {
346 cf = calloc(1, sizeof(*cf));
348 ERROR("plugin: create_register_callback: calloc failed.");
352 cf->cf_callback = callback;
354 cf->cf_udata.data = NULL;
355 cf->cf_udata.free_func = NULL;
360 cf->cf_ctx = plugin_get_ctx();
362 return (register_callback(list, name, cf));
363 } /* }}} int create_register_callback */
365 static int plugin_unregister(llist_t *list, const char *name) /* {{{ */
372 e = llist_search(list, name);
376 llist_remove(list, e);
379 destroy_callback(e->value);
384 } /* }}} int plugin_unregister */
387 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
388 * object, but it will bitch about a shared object not having a
389 * ``module_register'' symbol..
391 static int plugin_load_file(const char *file, _Bool global) {
392 void (*reg_handle)(void);
394 int flags = RTLD_NOW;
396 flags |= RTLD_GLOBAL;
398 void *dlh = dlopen(file, flags);
401 char errbuf[1024] = "";
403 ssnprintf(errbuf, sizeof(errbuf),
404 "dlopen (\"%s\") failed: %s. "
405 "The most common cause for this problem is "
406 "missing dependencies. Use ldd(1) to check "
407 "the dependencies of the plugin "
412 /* Make sure this is printed to STDERR in any case, but also
413 * make sure it's printed only once. */
414 if (list_log != NULL)
415 fprintf(stderr, "ERROR: %s\n", errbuf);
420 reg_handle = (void (*)(void))dlsym(dlh, "module_register");
421 if (reg_handle == NULL) {
422 WARNING("Couldn't find symbol \"module_register\" in \"%s\": %s\n", file,
433 static void *plugin_read_thread(void __attribute__((unused)) * args) {
434 while (read_loop != 0) {
436 plugin_ctx_t old_ctx;
444 /* Get the read function that needs to be read next.
445 * We don't need to hold "read_lock" for the heap, but we need
446 * to call c_heap_get_root() and pthread_cond_wait() in the
447 * same protected block. */
448 pthread_mutex_lock(&read_lock);
449 rf = c_heap_get_root(read_heap);
451 pthread_cond_wait(&read_cond, &read_lock);
452 pthread_mutex_unlock(&read_lock);
455 pthread_mutex_unlock(&read_lock);
457 if (rf->rf_interval == 0) {
458 /* this should not happen, because the interval is set
459 * for each plugin when loading it
460 * XXX: issue a warning? */
461 rf->rf_interval = plugin_get_interval();
462 rf->rf_effective_interval = rf->rf_interval;
464 rf->rf_next_read = cdtime();
467 /* sleep until this entry is due,
468 * using pthread_cond_timedwait */
469 pthread_mutex_lock(&read_lock);
470 /* In pthread_cond_timedwait, spurious wakeups are possible
471 * (and really happen, at least on NetBSD with > 1 CPU), thus
472 * we need to re-evaluate the condition every time
473 * pthread_cond_timedwait returns. */
475 while ((read_loop != 0) && (cdtime() < rf->rf_next_read) && rc == 0) {
476 rc = pthread_cond_timedwait(&read_cond, &read_lock,
477 &CDTIME_T_TO_TIMESPEC(rf->rf_next_read));
480 /* Must hold `read_lock' when accessing `rf->rf_type'. */
481 rf_type = rf->rf_type;
482 pthread_mutex_unlock(&read_lock);
484 /* Check if we're supposed to stop.. This may have interrupted
486 if (read_loop == 0) {
487 /* Insert `rf' again, so it can be free'd correctly */
488 c_heap_insert(read_heap, rf);
492 /* The entry has been marked for deletion. The linked list
493 * entry has already been removed by `plugin_unregister_read'.
494 * All we have to do here is free the `read_func_t' and
496 if (rf_type == RF_REMOVE) {
497 DEBUG("plugin_read_thread: Destroying the `%s' "
501 destroy_callback((callback_func_t *)rf);
506 DEBUG("plugin_read_thread: Handling `%s'.", rf->rf_name);
510 old_ctx = plugin_set_ctx(rf->rf_ctx);
512 if (rf_type == RF_SIMPLE) {
513 int (*callback)(void);
515 callback = rf->rf_callback;
516 status = (*callback)();
518 plugin_read_cb callback;
520 assert(rf_type == RF_COMPLEX);
522 callback = rf->rf_callback;
523 status = (*callback)(&rf->rf_udata);
526 plugin_set_ctx(old_ctx);
528 /* If the function signals failure, we will increase the
529 * intervals in which it will be called. */
531 rf->rf_effective_interval *= 2;
532 if (rf->rf_effective_interval > max_read_interval)
533 rf->rf_effective_interval = max_read_interval;
535 NOTICE("read-function of plugin `%s' failed. "
536 "Will suspend it for %.3f seconds.",
537 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
539 /* Success: Restore the interval, if it was changed. */
540 rf->rf_effective_interval = rf->rf_interval;
543 /* update the ``next read due'' field */
546 /* calculate the time spent in the read function */
547 elapsed = (now - start);
549 if (elapsed > rf->rf_effective_interval)
551 "plugin_read_thread: read-function of the `%s' plugin took %.3f "
552 "seconds, which is above its read interval (%.3f seconds). You might "
553 "want to adjust the `Interval' or `ReadThreads' settings.",
554 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed),
555 CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
557 DEBUG("plugin_read_thread: read-function of the `%s' plugin took "
559 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed));
561 DEBUG("plugin_read_thread: Effective interval of the "
562 "`%s' plugin is %.3f seconds.",
563 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
565 /* Calculate the next (absolute) time at which this function
566 * should be called. */
567 rf->rf_next_read += rf->rf_effective_interval;
569 /* Check, if `rf_next_read' is in the past. */
570 if (rf->rf_next_read < now) {
571 /* `rf_next_read' is in the past. Insert `now'
572 * so this value doesn't trail off into the
574 rf->rf_next_read = now;
577 DEBUG("plugin_read_thread: Next read of the `%s' plugin at %.3f.",
578 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_next_read));
580 /* Re-insert this read function into the heap again. */
581 c_heap_insert(read_heap, rf);
582 } /* while (read_loop) */
586 } /* void *plugin_read_thread */
588 #ifdef PTHREAD_MAX_NAMELEN_NP
589 #define THREAD_NAME_MAX PTHREAD_MAX_NAMELEN_NP
591 #define THREAD_NAME_MAX 16
594 static void set_thread_name(pthread_t tid, char const *name) {
595 #if defined(HAVE_PTHREAD_SETNAME_NP) || defined(HAVE_PTHREAD_SET_NAME_NP)
597 /* glibc limits the length of the name and fails if the passed string
598 * is too long, so we truncate it here. */
599 char n[THREAD_NAME_MAX];
600 if (strlen(name) >= THREAD_NAME_MAX)
601 WARNING("set_thread_name(\"%s\"): name too long", name);
602 sstrncpy(n, name, sizeof(n));
604 #if defined(HAVE_PTHREAD_SETNAME_NP)
605 int status = pthread_setname_np(tid, n);
608 ERROR("set_thread_name(\"%s\"): %s", n,
609 sstrerror(status, errbuf, sizeof(errbuf)));
611 #else /* if defined(HAVE_PTHREAD_SET_NAME_NP) */
612 pthread_set_name_np(tid, n);
618 static void start_read_threads(size_t num) /* {{{ */
620 if (read_threads != NULL)
623 read_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
624 if (read_threads == NULL) {
625 ERROR("plugin: start_read_threads: calloc failed.");
629 read_threads_num = 0;
630 for (size_t i = 0; i < num; i++) {
631 int status = pthread_create(read_threads + read_threads_num,
632 /* attr = */ NULL, plugin_read_thread,
636 ERROR("plugin: start_read_threads: pthread_create failed "
637 "with status %i (%s).",
638 status, sstrerror(status, errbuf, sizeof(errbuf)));
642 char name[THREAD_NAME_MAX];
643 ssnprintf(name, sizeof(name), "reader#%zu", read_threads_num);
644 set_thread_name(read_threads[read_threads_num], name);
648 } /* }}} void start_read_threads */
650 static void stop_read_threads(void) {
651 if (read_threads == NULL)
654 INFO("collectd: Stopping %zu read threads.", read_threads_num);
656 pthread_mutex_lock(&read_lock);
658 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
659 pthread_cond_broadcast(&read_cond);
660 pthread_mutex_unlock(&read_lock);
662 for (size_t i = 0; i < read_threads_num; i++) {
663 if (pthread_join(read_threads[i], NULL) != 0) {
664 ERROR("plugin: stop_read_threads: pthread_join failed.");
666 read_threads[i] = (pthread_t)0;
669 read_threads_num = 0;
670 } /* void stop_read_threads */
672 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
677 meta_data_destroy(vl->meta);
680 } /* }}} void plugin_value_list_free */
682 static value_list_t *
683 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
690 vl = malloc(sizeof(*vl));
693 memcpy(vl, vl_orig, sizeof(*vl));
695 if (vl->host[0] == 0)
696 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
698 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
699 if (vl->values == NULL) {
700 plugin_value_list_free(vl);
703 memcpy(vl->values, vl_orig->values,
704 vl_orig->values_len * sizeof(*vl->values));
706 vl->meta = meta_data_clone(vl->meta);
707 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
708 plugin_value_list_free(vl);
715 /* Fill in the interval from the thread context, if it is zero. */
716 if (vl->interval == 0) {
717 plugin_ctx_t ctx = plugin_get_ctx();
719 if (ctx.interval != 0)
720 vl->interval = ctx.interval;
722 char name[6 * DATA_MAX_NAME_LEN];
723 FORMAT_VL(name, sizeof(name), vl);
724 ERROR("plugin_value_list_clone: Unable to determine "
725 "interval from context for "
726 "value list \"%s\". "
727 "This indicates a broken plugin. "
728 "Please report this problem to the "
729 "collectd mailing list or at "
730 "<http://collectd.org/bugs/>.",
732 vl->interval = cf_get_default_interval();
737 } /* }}} value_list_t *plugin_value_list_clone */
739 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
743 q = malloc(sizeof(*q));
748 q->vl = plugin_value_list_clone(vl);
754 /* Store context of caller (read plugin); otherwise, it would not be
755 * available to the write plugins when actually dispatching the
756 * value-list later on. */
757 q->ctx = plugin_get_ctx();
759 pthread_mutex_lock(&write_lock);
761 if (write_queue_tail == NULL) {
762 write_queue_head = q;
763 write_queue_tail = q;
764 write_queue_length = 1;
766 write_queue_tail->next = q;
767 write_queue_tail = q;
768 write_queue_length += 1;
771 pthread_cond_signal(&write_cond);
772 pthread_mutex_unlock(&write_lock);
775 } /* }}} int plugin_write_enqueue */
777 static value_list_t *plugin_write_dequeue(void) /* {{{ */
782 pthread_mutex_lock(&write_lock);
784 while (write_loop && (write_queue_head == NULL))
785 pthread_cond_wait(&write_cond, &write_lock);
787 if (write_queue_head == NULL) {
788 pthread_mutex_unlock(&write_lock);
792 q = write_queue_head;
793 write_queue_head = q->next;
794 write_queue_length -= 1;
795 if (write_queue_head == NULL) {
796 write_queue_tail = NULL;
797 assert(0 == write_queue_length);
800 pthread_mutex_unlock(&write_lock);
802 (void)plugin_set_ctx(q->ctx);
807 } /* }}} value_list_t *plugin_write_dequeue */
809 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
812 value_list_t *vl = plugin_write_dequeue();
816 plugin_dispatch_values_internal(vl);
818 plugin_value_list_free(vl);
823 } /* }}} void *plugin_write_thread */
825 static void start_write_threads(size_t num) /* {{{ */
827 if (write_threads != NULL)
830 write_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
831 if (write_threads == NULL) {
832 ERROR("plugin: start_write_threads: calloc failed.");
836 write_threads_num = 0;
837 for (size_t i = 0; i < num; i++) {
838 int status = pthread_create(write_threads + write_threads_num,
839 /* attr = */ NULL, plugin_write_thread,
843 ERROR("plugin: start_write_threads: pthread_create failed "
844 "with status %i (%s).",
845 status, sstrerror(status, errbuf, sizeof(errbuf)));
849 char name[THREAD_NAME_MAX];
850 ssnprintf(name, sizeof(name), "writer#%zu", write_threads_num);
851 set_thread_name(write_threads[write_threads_num], name);
855 } /* }}} void start_write_threads */
857 static void stop_write_threads(void) /* {{{ */
862 if (write_threads == NULL)
865 INFO("collectd: Stopping %zu write threads.", write_threads_num);
867 pthread_mutex_lock(&write_lock);
869 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
870 pthread_cond_broadcast(&write_cond);
871 pthread_mutex_unlock(&write_lock);
873 for (i = 0; i < write_threads_num; i++) {
874 if (pthread_join(write_threads[i], NULL) != 0) {
875 ERROR("plugin: stop_write_threads: pthread_join failed.");
877 write_threads[i] = (pthread_t)0;
879 sfree(write_threads);
880 write_threads_num = 0;
882 pthread_mutex_lock(&write_lock);
884 for (q = write_queue_head; q != NULL;) {
885 write_queue_t *q1 = q;
886 plugin_value_list_free(q->vl);
891 write_queue_head = NULL;
892 write_queue_tail = NULL;
893 write_queue_length = 0;
894 pthread_mutex_unlock(&write_lock);
897 WARNING("plugin: %zu value list%s left after shutting down "
898 "the write threads.",
899 i, (i == 1) ? " was" : "s were");
901 } /* }}} void stop_write_threads */
906 void plugin_set_dir(const char *dir) {
914 plugindir = strdup(dir);
915 if (plugindir == NULL)
916 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
919 static _Bool plugin_is_loaded(char const *name) {
922 if (plugins_loaded == NULL)
924 c_avl_create((int (*)(const void *, const void *))strcasecmp);
925 assert(plugins_loaded != NULL);
927 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
928 return (status == 0);
931 static int plugin_mark_loaded(char const *name) {
935 name_copy = strdup(name);
936 if (name_copy == NULL)
939 status = c_avl_insert(plugins_loaded,
940 /* key = */ name_copy, /* value = */ NULL);
944 static void plugin_free_loaded(void) {
948 if (plugins_loaded == NULL)
951 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
953 assert(value == NULL);
956 c_avl_destroy(plugins_loaded);
957 plugins_loaded = NULL;
961 int plugin_load(char const *plugin_name, _Bool global) {
964 char filename[BUFSIZE] = "";
965 char typename[BUFSIZE];
971 if (plugin_name == NULL)
974 /* Check if plugin is already loaded and don't do anything in this
976 if (plugin_is_loaded(plugin_name))
979 dir = plugin_get_dir();
983 * XXX: Magic at work:
985 * Some of the language bindings, for example the Python and Perl
986 * plugins, need to be able to export symbols to the scripts they run.
987 * For this to happen, the "Globals" flag needs to be set.
988 * Unfortunately, this technical detail is hard to explain to the
989 * average user and she shouldn't have to worry about this, ideally.
990 * So in order to save everyone's sanity use a different default for a
991 * handful of special plugins. --octo
993 if ((strcasecmp("perl", plugin_name) == 0) ||
994 (strcasecmp("python", plugin_name) == 0))
997 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
998 * type when matching the filename */
999 status = ssnprintf(typename, sizeof(typename), "%s.so", plugin_name);
1000 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
1001 WARNING("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1005 if ((dh = opendir(dir)) == NULL) {
1007 ERROR("plugin_load: opendir (%s) failed: %s", dir,
1008 sstrerror(errno, errbuf, sizeof(errbuf)));
1012 while ((de = readdir(dh)) != NULL) {
1013 if (strcasecmp(de->d_name, typename))
1016 status = ssnprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1017 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1018 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1022 if (lstat(filename, &statbuf) == -1) {
1024 WARNING("plugin_load: stat (\"%s\") failed: %s", filename,
1025 sstrerror(errno, errbuf, sizeof(errbuf)));
1027 } else if (!S_ISREG(statbuf.st_mode)) {
1028 /* don't follow symlinks */
1029 WARNING("plugin_load: %s is not a regular file.", filename);
1033 status = plugin_load_file(filename, global);
1036 plugin_mark_loaded(plugin_name);
1038 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1041 ERROR("plugin_load: Load plugin \"%s\" failed with "
1043 plugin_name, status);
1049 if (filename[0] == 0)
1050 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1056 * The `register_*' functions follow
1058 int plugin_register_config(const char *name,
1059 int (*callback)(const char *key, const char *val),
1060 const char **keys, int keys_num) {
1061 cf_register(name, callback, keys, keys_num);
1063 } /* int plugin_register_config */
1065 int plugin_register_complex_config(const char *type,
1066 int (*callback)(oconfig_item_t *)) {
1067 return (cf_register_complex(type, callback));
1068 } /* int plugin_register_complex_config */
1070 int plugin_register_init(const char *name, int (*callback)(void)) {
1071 return (create_register_callback(&list_init, name, (void *)callback,
1072 /* user_data = */ NULL));
1073 } /* plugin_register_init */
1075 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1076 const read_func_t *rf0;
1077 const read_func_t *rf1;
1082 if (rf0->rf_next_read < rf1->rf_next_read)
1084 else if (rf0->rf_next_read > rf1->rf_next_read)
1088 } /* int plugin_compare_read_func */
1090 /* Add a read function to both, the heap and a linked list. The linked list if
1091 * used to look-up read functions, especially for the remove function. The heap
1092 * is used to determine which plugin to read next. */
1093 static int plugin_insert_read(read_func_t *rf) {
1097 rf->rf_next_read = cdtime();
1098 rf->rf_effective_interval = rf->rf_interval;
1100 pthread_mutex_lock(&read_lock);
1102 if (read_list == NULL) {
1103 read_list = llist_create();
1104 if (read_list == NULL) {
1105 pthread_mutex_unlock(&read_lock);
1106 ERROR("plugin_insert_read: read_list failed.");
1111 if (read_heap == NULL) {
1112 read_heap = c_heap_create(plugin_compare_read_func);
1113 if (read_heap == NULL) {
1114 pthread_mutex_unlock(&read_lock);
1115 ERROR("plugin_insert_read: c_heap_create failed.");
1120 le = llist_search(read_list, rf->rf_name);
1122 pthread_mutex_unlock(&read_lock);
1123 WARNING("The read function \"%s\" is already registered. "
1124 "Check for duplicate \"LoadPlugin\" lines "
1125 "in your configuration!",
1130 le = llentry_create(rf->rf_name, rf);
1132 pthread_mutex_unlock(&read_lock);
1133 ERROR("plugin_insert_read: llentry_create failed.");
1137 status = c_heap_insert(read_heap, rf);
1139 pthread_mutex_unlock(&read_lock);
1140 ERROR("plugin_insert_read: c_heap_insert failed.");
1141 llentry_destroy(le);
1145 /* This does not fail. */
1146 llist_append(read_list, le);
1148 /* Wake up all the read threads. */
1149 pthread_cond_broadcast(&read_cond);
1150 pthread_mutex_unlock(&read_lock);
1152 } /* int plugin_insert_read */
1154 int plugin_register_read(const char *name, int (*callback)(void)) {
1158 rf = calloc(1, sizeof(*rf));
1160 ERROR("plugin_register_read: calloc failed.");
1164 rf->rf_callback = (void *)callback;
1165 rf->rf_udata.data = NULL;
1166 rf->rf_udata.free_func = NULL;
1167 rf->rf_ctx = plugin_get_ctx();
1168 rf->rf_group[0] = '\0';
1169 rf->rf_name = strdup(name);
1170 rf->rf_type = RF_SIMPLE;
1171 rf->rf_interval = plugin_get_interval();
1173 status = plugin_insert_read(rf);
1180 } /* int plugin_register_read */
1182 int plugin_register_complex_read(const char *group, const char *name,
1183 plugin_read_cb callback, cdtime_t interval,
1184 user_data_t const *user_data) {
1188 rf = calloc(1, sizeof(*rf));
1190 ERROR("plugin_register_complex_read: calloc failed.");
1194 rf->rf_callback = (void *)callback;
1196 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1198 rf->rf_group[0] = '\0';
1199 rf->rf_name = strdup(name);
1200 rf->rf_type = RF_COMPLEX;
1201 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1204 if (user_data == NULL) {
1205 rf->rf_udata.data = NULL;
1206 rf->rf_udata.free_func = NULL;
1208 rf->rf_udata = *user_data;
1211 rf->rf_ctx = plugin_get_ctx();
1213 status = plugin_insert_read(rf);
1220 } /* int plugin_register_complex_read */
1222 int plugin_register_write(const char *name, plugin_write_cb callback,
1223 user_data_t const *ud) {
1224 return (create_register_callback(&list_write, name, (void *)callback, ud));
1225 } /* int plugin_register_write */
1227 static int plugin_flush_timeout_callback(user_data_t *ud) {
1228 flush_callback_t *cb = ud->data;
1230 return plugin_flush(cb->name, cb->timeout, /* identifier = */ NULL);
1231 } /* static int plugin_flush_callback */
1233 static void plugin_flush_timeout_callback_free(void *data) {
1234 flush_callback_t *cb = data;
1241 } /* static void plugin_flush_callback_free */
1243 static char *plugin_flush_callback_name(const char *name) {
1244 const char *flush_prefix = "flush/";
1249 prefix_size = strlen(flush_prefix);
1250 name_size = strlen(name);
1252 flush_name = malloc(name_size + prefix_size + 1);
1253 if (flush_name == NULL) {
1254 ERROR("plugin_flush_callback_name: malloc failed.");
1258 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1259 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1262 } /* static char *plugin_flush_callback_name */
1264 int plugin_register_flush(const char *name, plugin_flush_cb callback,
1265 user_data_t const *ud) {
1267 plugin_ctx_t ctx = plugin_get_ctx();
1269 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1273 if (ctx.flush_interval != 0) {
1275 flush_callback_t *cb;
1277 flush_name = plugin_flush_callback_name(name);
1278 if (flush_name == NULL)
1281 cb = malloc(sizeof(*cb));
1283 ERROR("plugin_register_flush: malloc failed.");
1288 cb->name = strdup(name);
1289 if (cb->name == NULL) {
1290 ERROR("plugin_register_flush: strdup failed.");
1295 cb->timeout = ctx.flush_timeout;
1297 status = plugin_register_complex_read(
1298 /* group = */ "flush",
1299 /* name = */ flush_name,
1300 /* callback = */ plugin_flush_timeout_callback,
1301 /* interval = */ ctx.flush_interval,
1302 /* user data = */ &(user_data_t){
1303 .data = cb, .free_func = plugin_flush_timeout_callback_free,
1315 } /* int plugin_register_flush */
1317 int plugin_register_missing(const char *name, plugin_missing_cb callback,
1318 user_data_t const *ud) {
1319 return (create_register_callback(&list_missing, name, (void *)callback, ud));
1320 } /* int plugin_register_missing */
1322 int plugin_register_shutdown(const char *name, int (*callback)(void)) {
1323 return (create_register_callback(&list_shutdown, name, (void *)callback,
1324 /* user_data = */ NULL));
1325 } /* int plugin_register_shutdown */
1327 static void plugin_free_data_sets(void) {
1331 if (data_sets == NULL)
1334 while (c_avl_pick(data_sets, &key, &value) == 0) {
1335 data_set_t *ds = value;
1336 /* key is a pointer to ds->type */
1342 c_avl_destroy(data_sets);
1344 } /* void plugin_free_data_sets */
1346 int plugin_register_data_set(const data_set_t *ds) {
1347 data_set_t *ds_copy;
1349 if ((data_sets != NULL) && (c_avl_get(data_sets, ds->type, NULL) == 0)) {
1350 NOTICE("Replacing DS `%s' with another version.", ds->type);
1351 plugin_unregister_data_set(ds->type);
1352 } else if (data_sets == NULL) {
1353 data_sets = c_avl_create((int (*)(const void *, const void *))strcmp);
1354 if (data_sets == NULL)
1358 ds_copy = malloc(sizeof(*ds_copy));
1359 if (ds_copy == NULL)
1361 memcpy(ds_copy, ds, sizeof(data_set_t));
1363 ds_copy->ds = malloc(sizeof(*ds_copy->ds) * ds->ds_num);
1364 if (ds_copy->ds == NULL) {
1369 for (size_t i = 0; i < ds->ds_num; i++)
1370 memcpy(ds_copy->ds + i, ds->ds + i, sizeof(data_source_t));
1372 return (c_avl_insert(data_sets, (void *)ds_copy->type, (void *)ds_copy));
1373 } /* int plugin_register_data_set */
1375 int plugin_register_log(const char *name, plugin_log_cb callback,
1376 user_data_t const *ud) {
1377 return (create_register_callback(&list_log, name, (void *)callback, ud));
1378 } /* int plugin_register_log */
1380 int plugin_register_notification(const char *name,
1381 plugin_notification_cb callback,
1382 user_data_t const *ud) {
1384 create_register_callback(&list_notification, name, (void *)callback, ud));
1385 } /* int plugin_register_log */
1387 int plugin_unregister_config(const char *name) {
1388 cf_unregister(name);
1390 } /* int plugin_unregister_config */
1392 int plugin_unregister_complex_config(const char *name) {
1393 cf_unregister_complex(name);
1395 } /* int plugin_unregister_complex_config */
1397 int plugin_unregister_init(const char *name) {
1398 return (plugin_unregister(list_init, name));
1401 int plugin_unregister_read(const char *name) /* {{{ */
1409 pthread_mutex_lock(&read_lock);
1411 if (read_list == NULL) {
1412 pthread_mutex_unlock(&read_lock);
1416 le = llist_search(read_list, name);
1418 pthread_mutex_unlock(&read_lock);
1419 WARNING("plugin_unregister_read: No such read function: %s", name);
1423 llist_remove(read_list, le);
1427 rf->rf_type = RF_REMOVE;
1429 pthread_mutex_unlock(&read_lock);
1431 llentry_destroy(le);
1433 DEBUG("plugin_unregister_read: Marked `%s' for removal.", name);
1436 } /* }}} int plugin_unregister_read */
1438 void plugin_log_available_writers(void) {
1439 log_list_callbacks(&list_write, "Available write targets:");
1442 static int compare_read_func_group(llentry_t *e, void *ud) /* {{{ */
1444 read_func_t *rf = e->value;
1447 return strcmp(rf->rf_group, (const char *)group);
1448 } /* }}} int compare_read_func_group */
1450 int plugin_unregister_read_group(const char *group) /* {{{ */
1460 pthread_mutex_lock(&read_lock);
1462 if (read_list == NULL) {
1463 pthread_mutex_unlock(&read_lock);
1468 le = llist_search_custom(read_list, compare_read_func_group, (void *)group);
1475 llist_remove(read_list, le);
1479 rf->rf_type = RF_REMOVE;
1481 llentry_destroy(le);
1483 DEBUG("plugin_unregister_read_group: "
1484 "Marked `%s' (group `%s') for removal.",
1485 rf->rf_name, group);
1488 pthread_mutex_unlock(&read_lock);
1491 WARNING("plugin_unregister_read_group: No such "
1492 "group of read function: %s",
1498 } /* }}} int plugin_unregister_read_group */
1500 int plugin_unregister_write(const char *name) {
1501 return (plugin_unregister(list_write, name));
1504 int plugin_unregister_flush(const char *name) {
1505 plugin_ctx_t ctx = plugin_get_ctx();
1507 if (ctx.flush_interval != 0) {
1510 flush_name = plugin_flush_callback_name(name);
1511 if (flush_name != NULL) {
1512 plugin_unregister_read(flush_name);
1517 return plugin_unregister(list_flush, name);
1520 int plugin_unregister_missing(const char *name) {
1521 return (plugin_unregister(list_missing, name));
1524 int plugin_unregister_shutdown(const char *name) {
1525 return (plugin_unregister(list_shutdown, name));
1528 int plugin_unregister_data_set(const char *name) {
1531 if (data_sets == NULL)
1534 if (c_avl_remove(data_sets, name, NULL, (void *)&ds) != 0)
1541 } /* int plugin_unregister_data_set */
1543 int plugin_unregister_log(const char *name) {
1544 return (plugin_unregister(list_log, name));
1547 int plugin_unregister_notification(const char *name) {
1548 return (plugin_unregister(list_notification, name));
1551 int plugin_init_all(void) {
1552 char const *chain_name;
1557 /* Init the value cache */
1560 if (IS_TRUE(global_option_get("CollectInternalStats"))) {
1561 record_statistics = 1;
1562 plugin_register_read("collectd", plugin_update_internal_statistics);
1565 chain_name = global_option_get("PreCacheChain");
1566 pre_cache_chain = fc_chain_get_by_name(chain_name);
1568 chain_name = global_option_get("PostCacheChain");
1569 post_cache_chain = fc_chain_get_by_name(chain_name);
1571 write_limit_high = global_option_get_long("WriteQueueLimitHigh",
1573 if (write_limit_high < 0) {
1574 ERROR("WriteQueueLimitHigh must be positive or zero.");
1575 write_limit_high = 0;
1579 global_option_get_long("WriteQueueLimitLow",
1580 /* default = */ write_limit_high / 2);
1581 if (write_limit_low < 0) {
1582 ERROR("WriteQueueLimitLow must be positive or zero.");
1583 write_limit_low = write_limit_high / 2;
1584 } else if (write_limit_low > write_limit_high) {
1585 ERROR("WriteQueueLimitLow must not be larger than "
1586 "WriteQueueLimitHigh.");
1587 write_limit_low = write_limit_high;
1590 write_threads_num = global_option_get_long("WriteThreads",
1592 if (write_threads_num < 1) {
1593 ERROR("WriteThreads must be positive.");
1594 write_threads_num = 5;
1597 if ((list_init == NULL) && (read_heap == NULL))
1600 /* Calling all init callbacks before checking if read callbacks
1601 * are available allows the init callbacks to register the read
1603 le = llist_head(list_init);
1604 while (le != NULL) {
1605 callback_func_t *cf;
1606 plugin_init_cb callback;
1607 plugin_ctx_t old_ctx;
1610 old_ctx = plugin_set_ctx(cf->cf_ctx);
1611 callback = cf->cf_callback;
1612 status = (*callback)();
1613 plugin_set_ctx(old_ctx);
1616 ERROR("Initialization of plugin `%s' "
1617 "failed with status %i. "
1618 "Plugin will be unloaded.",
1620 /* Plugins that register read callbacks from the init
1621 * callback should take care of appropriate error
1622 * handling themselves. */
1623 /* FIXME: Unload _all_ functions */
1624 plugin_unregister_read(le->key);
1631 start_write_threads((size_t)write_threads_num);
1634 global_option_get_time("MaxReadInterval", DEFAULT_MAX_READ_INTERVAL);
1636 /* Start read-threads */
1637 if (read_heap != NULL) {
1641 rt = global_option_get("ReadThreads");
1644 start_read_threads((num > 0) ? ((size_t)num) : 5);
1647 } /* void plugin_init_all */
1649 /* TODO: Rename this function. */
1650 void plugin_read_all(void) {
1654 } /* void plugin_read_all */
1656 /* Read function called when the `-T' command line argument is given. */
1657 int plugin_read_all_once(void) {
1659 int return_status = 0;
1661 if (read_heap == NULL) {
1662 NOTICE("No read-functions are registered.");
1668 plugin_ctx_t old_ctx;
1670 rf = c_heap_get_root(read_heap);
1674 old_ctx = plugin_set_ctx(rf->rf_ctx);
1676 if (rf->rf_type == RF_SIMPLE) {
1677 int (*callback)(void);
1679 callback = rf->rf_callback;
1680 status = (*callback)();
1682 plugin_read_cb callback;
1684 callback = rf->rf_callback;
1685 status = (*callback)(&rf->rf_udata);
1688 plugin_set_ctx(old_ctx);
1691 NOTICE("read-function of plugin `%s' failed.", rf->rf_name);
1696 destroy_callback((void *)rf);
1699 return (return_status);
1700 } /* int plugin_read_all_once */
1702 int plugin_write(const char *plugin, /* {{{ */
1703 const data_set_t *ds, const value_list_t *vl) {
1710 if (list_write == NULL)
1714 ds = plugin_get_ds(vl->type);
1716 ERROR("plugin_write: Unable to lookup type `%s'.", vl->type);
1721 if (plugin == NULL) {
1725 le = llist_head(list_write);
1726 while (le != NULL) {
1727 callback_func_t *cf = le->value;
1728 plugin_write_cb callback;
1730 /* do not switch plugin context; rather keep the context (interval)
1731 * information of the calling read plugin */
1733 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1734 callback = cf->cf_callback;
1735 status = (*callback)(ds, vl, &cf->cf_udata);
1744 if ((success == 0) && (failure != 0))
1748 } else /* plugin != NULL */
1750 callback_func_t *cf;
1751 plugin_write_cb callback;
1753 le = llist_head(list_write);
1754 while (le != NULL) {
1755 if (strcasecmp(plugin, le->key) == 0)
1766 /* do not switch plugin context; rather keep the context (interval)
1767 * information of the calling read plugin */
1769 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1770 callback = cf->cf_callback;
1771 status = (*callback)(ds, vl, &cf->cf_udata);
1775 } /* }}} int plugin_write */
1777 int plugin_flush(const char *plugin, cdtime_t timeout, const char *identifier) {
1780 if (list_flush == NULL)
1783 le = llist_head(list_flush);
1784 while (le != NULL) {
1785 callback_func_t *cf;
1786 plugin_flush_cb callback;
1787 plugin_ctx_t old_ctx;
1789 if ((plugin != NULL) && (strcmp(plugin, le->key) != 0)) {
1795 old_ctx = plugin_set_ctx(cf->cf_ctx);
1796 callback = cf->cf_callback;
1798 (*callback)(timeout, identifier, &cf->cf_udata);
1800 plugin_set_ctx(old_ctx);
1805 } /* int plugin_flush */
1807 int plugin_shutdown_all(void) {
1809 int ret = 0; // Assume success.
1811 destroy_all_callbacks(&list_init);
1813 stop_read_threads();
1815 pthread_mutex_lock(&read_lock);
1816 llist_destroy(read_list);
1818 pthread_mutex_unlock(&read_lock);
1820 destroy_read_heap();
1822 /* blocks until all write threads have shut down. */
1823 stop_write_threads();
1825 /* ask all plugins to write out the state they kept. */
1826 plugin_flush(/* plugin = */ NULL,
1828 /* identifier = */ NULL);
1831 if (list_shutdown != NULL)
1832 le = llist_head(list_shutdown);
1834 while (le != NULL) {
1835 callback_func_t *cf;
1836 plugin_shutdown_cb callback;
1837 plugin_ctx_t old_ctx;
1840 old_ctx = plugin_set_ctx(cf->cf_ctx);
1841 callback = cf->cf_callback;
1843 /* Advance the pointer before calling the callback allows
1844 * shutdown functions to unregister themselves. If done the
1845 * other way around the memory `le' points to will be freed
1846 * after callback returns. */
1849 if ((*callback)() != 0)
1852 plugin_set_ctx(old_ctx);
1855 /* Write plugins which use the `user_data' pointer usually need the
1856 * same data available to the flush callback. If this is the case, set
1857 * the free_function to NULL when registering the flush callback and to
1858 * the real free function when registering the write callback. This way
1859 * the data isn't freed twice. */
1860 destroy_all_callbacks(&list_flush);
1861 destroy_all_callbacks(&list_missing);
1862 destroy_all_callbacks(&list_write);
1864 destroy_all_callbacks(&list_notification);
1865 destroy_all_callbacks(&list_shutdown);
1866 destroy_all_callbacks(&list_log);
1868 plugin_free_loaded();
1869 plugin_free_data_sets();
1871 } /* void plugin_shutdown_all */
1873 int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1877 if (list_missing == NULL)
1880 le = llist_head(list_missing);
1881 while (le != NULL) {
1882 callback_func_t *cf;
1883 plugin_missing_cb callback;
1884 plugin_ctx_t old_ctx;
1888 old_ctx = plugin_set_ctx(cf->cf_ctx);
1889 callback = cf->cf_callback;
1891 status = (*callback)(vl, &cf->cf_udata);
1892 plugin_set_ctx(old_ctx);
1895 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1896 "failed with status %i.",
1907 } /* int }}} plugin_dispatch_missing */
1909 static int plugin_dispatch_values_internal(value_list_t *vl) {
1911 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1915 _Bool free_meta_data = 0;
1919 /* These fields are initialized by plugin_value_list_clone() if needed: */
1920 assert(vl->host[0] != 0);
1921 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1922 assert(vl->interval != 0);
1924 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1925 ERROR("plugin_dispatch_values: Invalid value list "
1931 /* Free meta data only if the calling function didn't specify any. In
1932 * this case matches and targets may add some and the calling function
1933 * may not expect (and therefore free) that data. */
1934 if (vl->meta == NULL)
1937 if (list_write == NULL)
1938 c_complain_once(LOG_WARNING, &no_write_complaint,
1939 "plugin_dispatch_values: No write callback has been "
1940 "registered. Please load at least one output plugin, "
1941 "if you want the collected data to be stored.");
1943 if (data_sets == NULL) {
1944 ERROR("plugin_dispatch_values: No data sets registered. "
1945 "Could the types database be read? Check "
1946 "your `TypesDB' setting!");
1950 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1951 char ident[6 * DATA_MAX_NAME_LEN];
1953 FORMAT_VL(ident, sizeof(ident), vl);
1954 INFO("plugin_dispatch_values: Dataset not found: %s "
1955 "(from \"%s\"), check your types.db!",
1960 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1962 "plugin = %s; plugin_instance = %s; "
1963 "type = %s; type_instance = %s;",
1964 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1965 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1968 assert(0 == strcmp(ds->type, vl->type));
1970 if (0 != strcmp(ds->type, vl->type))
1971 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1972 ds->type, vl->type);
1976 assert(ds->ds_num == vl->values_len);
1978 if (ds->ds_num != vl->values_len) {
1979 ERROR("plugin_dispatch_values: ds->type = %s: "
1980 "(ds->ds_num = %zu) != "
1981 "(vl->values_len = %zu)",
1982 ds->type, ds->ds_num, vl->values_len);
1987 escape_slashes(vl->host, sizeof(vl->host));
1988 escape_slashes(vl->plugin, sizeof(vl->plugin));
1989 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
1990 escape_slashes(vl->type, sizeof(vl->type));
1991 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
1993 if (pre_cache_chain != NULL) {
1994 status = fc_process_chain(ds, vl, pre_cache_chain);
1996 WARNING("plugin_dispatch_values: Running the "
1997 "pre-cache chain failed with "
2000 } else if (status == FC_TARGET_STOP)
2004 /* Update the value cache */
2007 if (post_cache_chain != NULL) {
2008 status = fc_process_chain(ds, vl, post_cache_chain);
2010 WARNING("plugin_dispatch_values: Running the "
2011 "post-cache chain failed with "
2016 fc_default_action(ds, vl);
2018 if ((free_meta_data != 0) && (vl->meta != NULL)) {
2019 meta_data_destroy(vl->meta);
2024 } /* int plugin_dispatch_values_internal */
2026 static double get_drop_probability(void) /* {{{ */
2032 pthread_mutex_lock(&write_lock);
2033 wql = write_queue_length;
2034 pthread_mutex_unlock(&write_lock);
2036 if (wql < write_limit_low)
2038 if (wql >= write_limit_high)
2041 pos = 1 + wql - write_limit_low;
2042 size = 1 + write_limit_high - write_limit_low;
2044 return (((double)pos) / ((double)size));
2045 } /* }}} double get_drop_probability */
2047 static _Bool check_drop_value(void) /* {{{ */
2049 static cdtime_t last_message_time = 0;
2050 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2056 if (write_limit_high == 0)
2059 p = get_drop_probability();
2063 status = pthread_mutex_trylock(&last_message_lock);
2068 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2069 last_message_time = now;
2070 ERROR("plugin_dispatch_values: Low water mark "
2071 "reached. Dropping %.0f%% of metrics.",
2074 pthread_mutex_unlock(&last_message_lock);
2085 } /* }}} _Bool check_drop_value */
2087 int plugin_dispatch_values(value_list_t const *vl) {
2089 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2091 if (check_drop_value()) {
2092 if (record_statistics) {
2093 pthread_mutex_lock(&statistics_lock);
2094 stats_values_dropped++;
2095 pthread_mutex_unlock(&statistics_lock);
2100 status = plugin_write_enqueue(vl);
2103 ERROR("plugin_dispatch_values: plugin_write_enqueue failed "
2104 "with status %i (%s).",
2105 status, sstrerror(status, errbuf, sizeof(errbuf)));
2112 __attribute__((sentinel)) int
2113 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2114 _Bool store_percentage, int store_type, ...) {
2120 assert(template->values_len == 1);
2122 /* Calculate sum for Gauge to calculate percent if needed */
2123 if (DS_TYPE_GAUGE == store_type) {
2124 va_start(ap, store_type);
2129 name = va_arg(ap, char const *);
2133 value = va_arg(ap, gauge_t);
2140 vl = plugin_value_list_clone(template);
2141 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2142 if (store_percentage)
2143 sstrncpy(vl->type, "percent", sizeof(vl->type));
2145 va_start(ap, store_type);
2150 /* Set the type instance. */
2151 name = va_arg(ap, char const *);
2154 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2156 /* Set the value. */
2157 switch (store_type) {
2159 vl->values[0].gauge = va_arg(ap, gauge_t);
2160 if (store_percentage)
2161 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2163 case DS_TYPE_ABSOLUTE:
2164 vl->values[0].absolute = va_arg(ap, absolute_t);
2166 case DS_TYPE_COUNTER:
2167 vl->values[0].counter = va_arg(ap, counter_t);
2169 case DS_TYPE_DERIVE:
2170 vl->values[0].derive = va_arg(ap, derive_t);
2173 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2177 status = plugin_write_enqueue(vl);
2183 plugin_value_list_free(vl);
2185 } /* }}} int plugin_dispatch_multivalue */
2187 int plugin_dispatch_notification(const notification_t *notif) {
2189 /* Possible TODO: Add flap detection here */
2191 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2192 "time = %.3f; host = %s;",
2193 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2196 /* Nobody cares for notifications */
2197 if (list_notification == NULL)
2200 le = llist_head(list_notification);
2201 while (le != NULL) {
2202 callback_func_t *cf;
2203 plugin_notification_cb callback;
2206 /* do not switch plugin context; rather keep the context
2207 * (interval) information of the calling plugin */
2210 callback = cf->cf_callback;
2211 status = (*callback)(notif, &cf->cf_udata);
2213 WARNING("plugin_dispatch_notification: Notification "
2214 "callback %s returned %i.",
2222 } /* int plugin_dispatch_notification */
2224 void plugin_log(int level, const char *format, ...) {
2230 if (level >= LOG_DEBUG)
2234 va_start(ap, format);
2235 vsnprintf(msg, sizeof(msg), format, ap);
2236 msg[sizeof(msg) - 1] = '\0';
2239 if (list_log == NULL) {
2240 fprintf(stderr, "%s\n", msg);
2244 le = llist_head(list_log);
2245 while (le != NULL) {
2246 callback_func_t *cf;
2247 plugin_log_cb callback;
2250 callback = cf->cf_callback;
2252 /* do not switch plugin context; rather keep the context
2253 * (interval) information of the calling plugin */
2255 (*callback)(level, msg, &cf->cf_udata);
2259 } /* void plugin_log */
2261 int parse_log_severity(const char *severity) {
2264 if ((0 == strcasecmp(severity, "emerg")) ||
2265 (0 == strcasecmp(severity, "alert")) ||
2266 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2267 log_level = LOG_ERR;
2268 else if (0 == strcasecmp(severity, "warning"))
2269 log_level = LOG_WARNING;
2270 else if (0 == strcasecmp(severity, "notice"))
2271 log_level = LOG_NOTICE;
2272 else if (0 == strcasecmp(severity, "info"))
2273 log_level = LOG_INFO;
2275 else if (0 == strcasecmp(severity, "debug"))
2276 log_level = LOG_DEBUG;
2277 #endif /* COLLECT_DEBUG */
2280 } /* int parse_log_severity */
2282 int parse_notif_severity(const char *severity) {
2283 int notif_severity = -1;
2285 if (strcasecmp(severity, "FAILURE") == 0)
2286 notif_severity = NOTIF_FAILURE;
2287 else if (strcmp(severity, "OKAY") == 0)
2288 notif_severity = NOTIF_OKAY;
2289 else if ((strcmp(severity, "WARNING") == 0) ||
2290 (strcmp(severity, "WARN") == 0))
2291 notif_severity = NOTIF_WARNING;
2293 return (notif_severity);
2294 } /* int parse_notif_severity */
2296 const data_set_t *plugin_get_ds(const char *name) {
2299 if (data_sets == NULL) {
2300 ERROR("plugin_get_ds: No data sets are defined yet.");
2304 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2305 DEBUG("No such dataset registered: %s", name);
2310 } /* data_set_t *plugin_get_ds */
2312 static int plugin_notification_meta_add(notification_t *n, const char *name,
2313 enum notification_meta_type_e type,
2314 const void *value) {
2315 notification_meta_t *meta;
2316 notification_meta_t *tail;
2318 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2319 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2323 meta = calloc(1, sizeof(*meta));
2325 ERROR("plugin_notification_meta_add: calloc failed.");
2329 sstrncpy(meta->name, name, sizeof(meta->name));
2333 case NM_TYPE_STRING: {
2334 meta->nm_value.nm_string = strdup((const char *)value);
2335 if (meta->nm_value.nm_string == NULL) {
2336 ERROR("plugin_notification_meta_add: strdup failed.");
2342 case NM_TYPE_SIGNED_INT: {
2343 meta->nm_value.nm_signed_int = *((int64_t *)value);
2346 case NM_TYPE_UNSIGNED_INT: {
2347 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2350 case NM_TYPE_DOUBLE: {
2351 meta->nm_value.nm_double = *((double *)value);
2354 case NM_TYPE_BOOLEAN: {
2355 meta->nm_value.nm_boolean = *((_Bool *)value);
2359 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2363 } /* switch (type) */
2367 while ((tail != NULL) && (tail->next != NULL))
2376 } /* int plugin_notification_meta_add */
2378 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2379 const char *value) {
2380 return (plugin_notification_meta_add(n, name, NM_TYPE_STRING, value));
2383 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2385 return (plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value));
2388 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2391 return (plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value));
2394 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2396 return (plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value));
2399 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2401 return (plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value));
2404 int plugin_notification_meta_copy(notification_t *dst,
2405 const notification_t *src) {
2406 assert(dst != NULL);
2407 assert(src != NULL);
2409 assert((src->meta == NULL) || (src->meta != dst->meta));
2411 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2412 if (meta->type == NM_TYPE_STRING)
2413 plugin_notification_meta_add_string(dst, meta->name,
2414 meta->nm_value.nm_string);
2415 else if (meta->type == NM_TYPE_SIGNED_INT)
2416 plugin_notification_meta_add_signed_int(dst, meta->name,
2417 meta->nm_value.nm_signed_int);
2418 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2419 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2420 meta->nm_value.nm_unsigned_int);
2421 else if (meta->type == NM_TYPE_DOUBLE)
2422 plugin_notification_meta_add_double(dst, meta->name,
2423 meta->nm_value.nm_double);
2424 else if (meta->type == NM_TYPE_BOOLEAN)
2425 plugin_notification_meta_add_boolean(dst, meta->name,
2426 meta->nm_value.nm_boolean);
2430 } /* int plugin_notification_meta_copy */
2432 int plugin_notification_meta_free(notification_meta_t *n) {
2433 notification_meta_t *this;
2434 notification_meta_t *next;
2437 ERROR("plugin_notification_meta_free: n == NULL!");
2442 while (this != NULL) {
2445 if (this->type == NM_TYPE_STRING) {
2446 /* Assign to a temporary variable to work around nm_string's const
2448 void *tmp = (void *)this->nm_value.nm_string;
2451 this->nm_value.nm_string = NULL;
2459 } /* int plugin_notification_meta_free */
2461 static void plugin_ctx_destructor(void *ctx) {
2463 } /* void plugin_ctx_destructor */
2465 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2467 static plugin_ctx_t *plugin_ctx_create(void) {
2470 ctx = malloc(sizeof(*ctx));
2473 ERROR("Failed to allocate plugin context: %s",
2474 sstrerror(errno, errbuf, sizeof(errbuf)));
2479 assert(plugin_ctx_key_initialized);
2480 pthread_setspecific(plugin_ctx_key, ctx);
2481 DEBUG("Created new plugin context.");
2483 } /* int plugin_ctx_create */
2485 void plugin_init_ctx(void) {
2486 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2487 plugin_ctx_key_initialized = 1;
2488 } /* void plugin_init_ctx */
2490 plugin_ctx_t plugin_get_ctx(void) {
2493 assert(plugin_ctx_key_initialized);
2494 ctx = pthread_getspecific(plugin_ctx_key);
2497 ctx = plugin_ctx_create();
2498 /* this must no happen -- exit() instead? */
2504 } /* plugin_ctx_t plugin_get_ctx */
2506 plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2510 assert(plugin_ctx_key_initialized);
2511 c = pthread_getspecific(plugin_ctx_key);
2514 c = plugin_ctx_create();
2515 /* this must no happen -- exit() instead? */
2524 } /* void plugin_set_ctx */
2526 cdtime_t plugin_get_interval(void) {
2529 interval = plugin_get_ctx().interval;
2533 return cf_get_default_interval();
2534 } /* cdtime_t plugin_get_interval */
2538 void *(*start_routine)(void *);
2542 static void *plugin_thread_start(void *arg) {
2543 plugin_thread_t *plugin_thread = arg;
2545 void *(*start_routine)(void *) = plugin_thread->start_routine;
2546 void *plugin_arg = plugin_thread->arg;
2548 plugin_set_ctx(plugin_thread->ctx);
2550 sfree(plugin_thread);
2552 return start_routine(plugin_arg);
2553 } /* void *plugin_thread_start */
2555 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2556 void *(*start_routine)(void *), void *arg,
2558 plugin_thread_t *plugin_thread;
2560 plugin_thread = malloc(sizeof(*plugin_thread));
2561 if (plugin_thread == NULL)
2564 plugin_thread->ctx = plugin_get_ctx();
2565 plugin_thread->start_routine = start_routine;
2566 plugin_thread->arg = arg;
2568 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2570 sfree(plugin_thread);
2575 set_thread_name(*thread, name);
2578 } /* int plugin_thread_create */