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 */
33 #include "configfile.h"
34 #include "filter_chain.h"
36 #include "utils/avltree/avltree.h"
37 #include "utils/common/common.h"
38 #include "utils/heap/heap.h"
39 #include "utils_cache.h"
40 #include "utils_complain.h"
41 #include "utils_llist.h"
42 #include "utils_random.h"
43 #include "utils_time.h"
46 #define EXPORT __declspec(dllexport)
54 #include <pthread_np.h> /* for pthread_set_name_np(3) */
62 struct callback_func_s {
67 typedef struct callback_func_s callback_func_t;
71 #define RF_REMOVE 65535
73 /* `read_func_t' "inherits" from `callback_func_t'.
74 * The `rf_super' member MUST be the first one in this structure! */
75 #define rf_callback rf_super.cf_callback
76 #define rf_udata rf_super.cf_udata
77 #define rf_ctx rf_super.cf_ctx
78 callback_func_t rf_super;
79 char rf_group[DATA_MAX_NAME_LEN];
83 cdtime_t rf_effective_interval;
84 cdtime_t rf_next_read;
86 typedef struct read_func_s read_func_t;
89 typedef struct write_queue_s write_queue_t;
90 struct write_queue_s {
96 struct flush_callback_s {
100 typedef struct flush_callback_s flush_callback_t;
105 static c_avl_tree_t *plugins_loaded;
107 static llist_t *list_init;
108 static llist_t *list_write;
109 static llist_t *list_flush;
110 static llist_t *list_missing;
111 static llist_t *list_shutdown;
112 static llist_t *list_log;
113 static llist_t *list_notification;
115 static fc_chain_t *pre_cache_chain;
116 static fc_chain_t *post_cache_chain;
118 static c_avl_tree_t *data_sets;
120 static char *plugindir;
122 #ifndef DEFAULT_MAX_READ_INTERVAL
123 #define DEFAULT_MAX_READ_INTERVAL TIME_T_TO_CDTIME_T_STATIC(86400)
125 static c_heap_t *read_heap;
126 static llist_t *read_list;
127 static int read_loop = 1;
128 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
129 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
130 static pthread_t *read_threads;
131 static size_t read_threads_num;
132 static cdtime_t max_read_interval = DEFAULT_MAX_READ_INTERVAL;
134 static write_queue_t *write_queue_head;
135 static write_queue_t *write_queue_tail;
136 static long write_queue_length;
137 static bool write_loop = true;
138 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
139 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
140 static pthread_t *write_threads;
141 static size_t write_threads_num;
143 static pthread_key_t plugin_ctx_key;
144 static bool plugin_ctx_key_initialized;
146 static long write_limit_high;
147 static long write_limit_low;
149 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
150 static derive_t stats_values_dropped;
151 static bool record_statistics;
156 static int plugin_dispatch_values_internal(value_list_t *vl);
158 static const char *plugin_get_dir(void) {
159 if (plugindir == NULL)
165 static int plugin_update_internal_statistics(void) { /* {{{ */
166 gauge_t copy_write_queue_length = (gauge_t)write_queue_length;
168 /* Initialize `vl' */
169 value_list_t vl = VALUE_LIST_INIT;
170 sstrncpy(vl.plugin, "collectd", sizeof(vl.plugin));
171 vl.interval = plugin_get_interval();
174 sstrncpy(vl.plugin_instance, "write_queue", sizeof(vl.plugin_instance));
176 /* Write queue : queue length */
177 vl.values = &(value_t){.gauge = copy_write_queue_length};
179 sstrncpy(vl.type, "queue_length", sizeof(vl.type));
180 vl.type_instance[0] = 0;
181 plugin_dispatch_values(&vl);
183 /* Write queue : Values dropped (queue length > low limit) */
184 vl.values = &(value_t){.gauge = (gauge_t)stats_values_dropped};
186 sstrncpy(vl.type, "derive", sizeof(vl.type));
187 sstrncpy(vl.type_instance, "dropped", sizeof(vl.type_instance));
188 plugin_dispatch_values(&vl);
191 sstrncpy(vl.plugin_instance, "cache", sizeof(vl.plugin_instance));
193 /* Cache : Nb entry in cache tree */
194 vl.values = &(value_t){.gauge = (gauge_t)uc_get_size()};
196 sstrncpy(vl.type, "cache_size", sizeof(vl.type));
197 vl.type_instance[0] = 0;
198 plugin_dispatch_values(&vl);
201 } /* }}} int plugin_update_internal_statistics */
203 static void free_userdata(user_data_t const *ud) /* {{{ */
208 if ((ud->data != NULL) && (ud->free_func != NULL)) {
209 ud->free_func(ud->data);
211 } /* }}} void free_userdata */
213 static void destroy_callback(callback_func_t *cf) /* {{{ */
217 free_userdata(&cf->cf_udata);
219 } /* }}} void destroy_callback */
221 static void destroy_all_callbacks(llist_t **list) /* {{{ */
228 le = llist_head(*list);
235 destroy_callback(le->value);
241 llist_destroy(*list);
243 } /* }}} void destroy_all_callbacks */
245 static void destroy_read_heap(void) /* {{{ */
247 if (read_heap == NULL)
253 rf = c_heap_get_root(read_heap);
257 destroy_callback((callback_func_t *)rf);
260 c_heap_destroy(read_heap);
262 } /* }}} void destroy_read_heap */
264 static int register_callback(llist_t **list, /* {{{ */
265 const char *name, callback_func_t *cf) {
270 *list = llist_create();
272 ERROR("plugin: register_callback: "
273 "llist_create failed.");
274 destroy_callback(cf);
281 ERROR("plugin: register_callback: strdup failed.");
282 destroy_callback(cf);
286 le = llist_search(*list, name);
288 le = llentry_create(key, cf);
290 ERROR("plugin: register_callback: "
291 "llentry_create failed.");
293 destroy_callback(cf);
297 llist_append(*list, le);
299 callback_func_t *old_cf;
304 P_WARNING("register_callback: "
305 "a callback named `%s' already exists - "
306 "overwriting the old entry!",
309 destroy_callback(old_cf);
314 } /* }}} int register_callback */
316 static void log_list_callbacks(llist_t **list, /* {{{ */
317 const char *comment) {
324 n = llist_size(*list);
326 INFO("%s: [none]", comment);
330 char **keys = calloc(n, sizeof(*keys));
332 ERROR("%s: failed to allocate memory for list of callbacks", comment);
336 for (le = llist_head(*list), i = 0, len = 0; le != NULL; le = le->next, i++) {
338 len += strlen(le->key) + 6;
340 str = malloc(len + 10);
342 ERROR("%s: failed to allocate memory for list of callbacks", comment);
345 strjoin(str, len, keys, n, "', '");
346 INFO("%s ['%s']", comment, str);
350 } /* }}} void log_list_callbacks */
352 static int create_register_callback(llist_t **list, /* {{{ */
353 const char *name, void *callback,
354 user_data_t const *ud) {
356 if (name == NULL || callback == NULL)
359 callback_func_t *cf = calloc(1, sizeof(*cf));
362 ERROR("plugin: create_register_callback: calloc failed.");
366 cf->cf_callback = callback;
368 cf->cf_udata = (user_data_t){
376 cf->cf_ctx = plugin_get_ctx();
378 return register_callback(list, name, cf);
379 } /* }}} int create_register_callback */
381 static int plugin_unregister(llist_t *list, const char *name) /* {{{ */
388 e = llist_search(list, name);
392 llist_remove(list, e);
395 destroy_callback(e->value);
400 } /* }}} int plugin_unregister */
402 /* plugin_load_file loads the shared object "file" and calls its
403 * "module_register" function. Returns zero on success, non-zero otherwise. */
404 static int plugin_load_file(char const *file, bool global) {
405 int flags = RTLD_NOW;
407 flags |= RTLD_GLOBAL;
409 void *dlh = dlopen(file, flags);
411 char errbuf[1024] = "";
413 snprintf(errbuf, sizeof(errbuf),
414 "dlopen(\"%s\") failed: %s. "
415 "The most common cause for this problem is missing dependencies. "
416 "Use ldd(1) to check the dependencies of the plugin / shared "
420 /* This error is printed to STDERR unconditionally. If list_log is NULL,
421 * plugin_log() will also print to STDERR. We avoid duplicate output by
422 * checking that the list of log handlers, list_log, is not NULL. */
423 fprintf(stderr, "ERROR: %s\n", errbuf);
424 if (list_log != NULL) {
431 void (*reg_handle)(void) = dlsym(dlh, "module_register");
432 if (reg_handle == NULL) {
433 ERROR("Couldn't find symbol \"module_register\" in \"%s\": %s\n", file,
443 static void *plugin_read_thread(void __attribute__((unused)) * args) {
444 while (read_loop != 0) {
446 plugin_ctx_t old_ctx;
454 /* Get the read function that needs to be read next.
455 * We don't need to hold "read_lock" for the heap, but we need
456 * to call c_heap_get_root() and pthread_cond_wait() in the
457 * same protected block. */
458 pthread_mutex_lock(&read_lock);
459 rf = c_heap_get_root(read_heap);
461 pthread_cond_wait(&read_cond, &read_lock);
462 pthread_mutex_unlock(&read_lock);
465 pthread_mutex_unlock(&read_lock);
467 if (rf->rf_interval == 0) {
468 /* this should not happen, because the interval is set
469 * for each plugin when loading it
470 * XXX: issue a warning? */
471 rf->rf_interval = plugin_get_interval();
472 rf->rf_effective_interval = rf->rf_interval;
474 rf->rf_next_read = cdtime();
477 /* sleep until this entry is due,
478 * using pthread_cond_timedwait */
479 pthread_mutex_lock(&read_lock);
480 /* In pthread_cond_timedwait, spurious wakeups are possible
481 * (and really happen, at least on NetBSD with > 1 CPU), thus
482 * we need to re-evaluate the condition every time
483 * pthread_cond_timedwait returns. */
485 while ((read_loop != 0) && (cdtime() < rf->rf_next_read) && rc == 0) {
486 rc = pthread_cond_timedwait(&read_cond, &read_lock,
487 &CDTIME_T_TO_TIMESPEC(rf->rf_next_read));
490 /* Must hold `read_lock' when accessing `rf->rf_type'. */
491 rf_type = rf->rf_type;
492 pthread_mutex_unlock(&read_lock);
494 /* Check if we're supposed to stop.. This may have interrupted
496 if (read_loop == 0) {
497 /* Insert `rf' again, so it can be free'd correctly */
498 c_heap_insert(read_heap, rf);
502 /* The entry has been marked for deletion. The linked list
503 * entry has already been removed by `plugin_unregister_read'.
504 * All we have to do here is free the `read_func_t' and
506 if (rf_type == RF_REMOVE) {
507 DEBUG("plugin_read_thread: Destroying the `%s' "
511 destroy_callback((callback_func_t *)rf);
516 DEBUG("plugin_read_thread: Handling `%s'.", rf->rf_name);
520 old_ctx = plugin_set_ctx(rf->rf_ctx);
522 if (rf_type == RF_SIMPLE) {
523 int (*callback)(void);
525 callback = rf->rf_callback;
526 status = (*callback)();
528 plugin_read_cb callback;
530 assert(rf_type == RF_COMPLEX);
532 callback = rf->rf_callback;
533 status = (*callback)(&rf->rf_udata);
536 plugin_set_ctx(old_ctx);
538 /* If the function signals failure, we will increase the
539 * intervals in which it will be called. */
541 rf->rf_effective_interval *= 2;
542 if (rf->rf_effective_interval > max_read_interval)
543 rf->rf_effective_interval = max_read_interval;
545 NOTICE("read-function of plugin `%s' failed. "
546 "Will suspend it for %.3f seconds.",
547 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
549 /* Success: Restore the interval, if it was changed. */
550 rf->rf_effective_interval = rf->rf_interval;
553 /* update the ``next read due'' field */
556 /* calculate the time spent in the read function */
557 elapsed = (now - start);
559 if (elapsed > rf->rf_effective_interval)
561 "plugin_read_thread: read-function of the `%s' plugin took %.3f "
562 "seconds, which is above its read interval (%.3f seconds). You might "
563 "want to adjust the `Interval' or `ReadThreads' settings.",
564 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed),
565 CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
567 DEBUG("plugin_read_thread: read-function of the `%s' plugin took "
569 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed));
571 DEBUG("plugin_read_thread: Effective interval of the "
572 "`%s' plugin is %.3f seconds.",
573 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
575 /* Calculate the next (absolute) time at which this function
576 * should be called. */
577 rf->rf_next_read += rf->rf_effective_interval;
579 /* Check, if `rf_next_read' is in the past. */
580 if (rf->rf_next_read < now) {
581 /* `rf_next_read' is in the past. Insert `now'
582 * so this value doesn't trail off into the
584 rf->rf_next_read = now;
587 DEBUG("plugin_read_thread: Next read of the `%s' plugin at %.3f.",
588 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_next_read));
590 /* Re-insert this read function into the heap again. */
591 c_heap_insert(read_heap, rf);
592 } /* while (read_loop) */
596 } /* void *plugin_read_thread */
598 #ifdef PTHREAD_MAX_NAMELEN_NP
599 #define THREAD_NAME_MAX PTHREAD_MAX_NAMELEN_NP
601 #define THREAD_NAME_MAX 16
604 static void set_thread_name(pthread_t tid, char const *name) {
605 #if defined(HAVE_PTHREAD_SETNAME_NP) || defined(HAVE_PTHREAD_SET_NAME_NP)
607 /* glibc limits the length of the name and fails if the passed string
608 * is too long, so we truncate it here. */
609 char n[THREAD_NAME_MAX];
610 if (strlen(name) >= THREAD_NAME_MAX)
611 WARNING("set_thread_name(\"%s\"): name too long", name);
612 sstrncpy(n, name, sizeof(n));
614 #if defined(HAVE_PTHREAD_SETNAME_NP)
615 int status = pthread_setname_np(tid, n);
617 ERROR("set_thread_name(\"%s\"): %s", n, STRERROR(status));
619 #else /* if defined(HAVE_PTHREAD_SET_NAME_NP) */
620 pthread_set_name_np(tid, n);
626 static void start_read_threads(size_t num) /* {{{ */
628 if (read_threads != NULL)
631 read_threads = calloc(num, sizeof(*read_threads));
632 if (read_threads == NULL) {
633 ERROR("plugin: start_read_threads: calloc failed.");
637 read_threads_num = 0;
638 for (size_t i = 0; i < num; i++) {
639 int status = pthread_create(read_threads + read_threads_num,
640 /* attr = */ NULL, plugin_read_thread,
643 ERROR("plugin: start_read_threads: pthread_create failed with status %i "
645 status, STRERROR(status));
649 char name[THREAD_NAME_MAX];
650 ssnprintf(name, sizeof(name), "reader#%" PRIu64,
651 (uint64_t)read_threads_num);
652 set_thread_name(read_threads[read_threads_num], name);
656 } /* }}} void start_read_threads */
658 static void stop_read_threads(void) {
659 if (read_threads == NULL)
662 INFO("collectd: Stopping %" PRIsz " read threads.", read_threads_num);
664 pthread_mutex_lock(&read_lock);
666 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
667 pthread_cond_broadcast(&read_cond);
668 pthread_mutex_unlock(&read_lock);
670 for (size_t i = 0; i < read_threads_num; i++) {
671 if (pthread_join(read_threads[i], NULL) != 0) {
672 ERROR("plugin: stop_read_threads: pthread_join failed.");
674 read_threads[i] = (pthread_t)0;
677 read_threads_num = 0;
678 } /* void stop_read_threads */
680 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
685 meta_data_destroy(vl->meta);
688 } /* }}} void plugin_value_list_free */
690 static value_list_t *
691 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
698 vl = malloc(sizeof(*vl));
701 memcpy(vl, vl_orig, sizeof(*vl));
703 if (vl->host[0] == 0)
704 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
706 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
707 if (vl->values == NULL) {
708 plugin_value_list_free(vl);
711 memcpy(vl->values, vl_orig->values,
712 vl_orig->values_len * sizeof(*vl->values));
714 vl->meta = meta_data_clone(vl->meta);
715 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
716 plugin_value_list_free(vl);
723 /* Fill in the interval from the thread context, if it is zero. */
724 if (vl->interval == 0)
725 vl->interval = plugin_get_interval();
728 } /* }}} value_list_t *plugin_value_list_clone */
730 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
734 q = malloc(sizeof(*q));
739 q->vl = plugin_value_list_clone(vl);
745 /* Store context of caller (read plugin); otherwise, it would not be
746 * available to the write plugins when actually dispatching the
747 * value-list later on. */
748 q->ctx = plugin_get_ctx();
750 pthread_mutex_lock(&write_lock);
752 if (write_queue_tail == NULL) {
753 write_queue_head = q;
754 write_queue_tail = q;
755 write_queue_length = 1;
757 write_queue_tail->next = q;
758 write_queue_tail = q;
759 write_queue_length += 1;
762 pthread_cond_signal(&write_cond);
763 pthread_mutex_unlock(&write_lock);
766 } /* }}} int plugin_write_enqueue */
768 static value_list_t *plugin_write_dequeue(void) /* {{{ */
773 pthread_mutex_lock(&write_lock);
775 while (write_loop && (write_queue_head == NULL))
776 pthread_cond_wait(&write_cond, &write_lock);
778 if (write_queue_head == NULL) {
779 pthread_mutex_unlock(&write_lock);
783 q = write_queue_head;
784 write_queue_head = q->next;
785 write_queue_length -= 1;
786 if (write_queue_head == NULL) {
787 write_queue_tail = NULL;
788 assert(0 == write_queue_length);
791 pthread_mutex_unlock(&write_lock);
793 (void)plugin_set_ctx(q->ctx);
798 } /* }}} value_list_t *plugin_write_dequeue */
800 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
803 value_list_t *vl = plugin_write_dequeue();
807 plugin_dispatch_values_internal(vl);
809 plugin_value_list_free(vl);
814 } /* }}} void *plugin_write_thread */
816 static void start_write_threads(size_t num) /* {{{ */
818 if (write_threads != NULL)
821 write_threads = calloc(num, sizeof(*write_threads));
822 if (write_threads == NULL) {
823 ERROR("plugin: start_write_threads: calloc failed.");
827 write_threads_num = 0;
828 for (size_t i = 0; i < num; i++) {
829 int status = pthread_create(write_threads + write_threads_num,
830 /* attr = */ NULL, plugin_write_thread,
833 ERROR("plugin: start_write_threads: pthread_create failed with status %i "
835 status, STRERROR(status));
839 char name[THREAD_NAME_MAX];
840 ssnprintf(name, sizeof(name), "writer#%" PRIu64,
841 (uint64_t)write_threads_num);
842 set_thread_name(write_threads[write_threads_num], name);
846 } /* }}} void start_write_threads */
848 static void stop_write_threads(void) /* {{{ */
853 if (write_threads == NULL)
856 INFO("collectd: Stopping %" PRIsz " write threads.", write_threads_num);
858 pthread_mutex_lock(&write_lock);
860 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
861 pthread_cond_broadcast(&write_cond);
862 pthread_mutex_unlock(&write_lock);
864 for (i = 0; i < write_threads_num; i++) {
865 if (pthread_join(write_threads[i], NULL) != 0) {
866 ERROR("plugin: stop_write_threads: pthread_join failed.");
868 write_threads[i] = (pthread_t)0;
870 sfree(write_threads);
871 write_threads_num = 0;
873 pthread_mutex_lock(&write_lock);
875 for (q = write_queue_head; q != NULL;) {
876 write_queue_t *q1 = q;
877 plugin_value_list_free(q->vl);
882 write_queue_head = NULL;
883 write_queue_tail = NULL;
884 write_queue_length = 0;
885 pthread_mutex_unlock(&write_lock);
888 WARNING("plugin: %" PRIsz " value list%s left after shutting down "
889 "the write threads.",
890 i, (i == 1) ? " was" : "s were");
892 } /* }}} void stop_write_threads */
897 void plugin_set_dir(const char *dir) {
905 plugindir = strdup(dir);
906 if (plugindir == NULL)
907 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
910 static bool plugin_is_loaded(char const *name) {
913 if (plugins_loaded == NULL)
915 c_avl_create((int (*)(const void *, const void *))strcasecmp);
916 assert(plugins_loaded != NULL);
918 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
922 static int plugin_mark_loaded(char const *name) {
926 name_copy = strdup(name);
927 if (name_copy == NULL)
930 status = c_avl_insert(plugins_loaded,
931 /* key = */ name_copy, /* value = */ NULL);
935 static void plugin_free_loaded(void) {
939 if (plugins_loaded == NULL)
942 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
944 assert(value == NULL);
947 c_avl_destroy(plugins_loaded);
948 plugins_loaded = NULL;
953 #define SHLIB_SUFFIX ".dll"
955 #define SHLIB_SUFFIX ".so"
957 int plugin_load(char const *plugin_name, bool global) {
960 char filename[BUFSIZE] = "";
961 char typename[BUFSIZE];
967 if (plugin_name == NULL)
970 /* Check if plugin is already loaded and don't do anything in this
972 if (plugin_is_loaded(plugin_name))
975 dir = plugin_get_dir();
979 * XXX: Magic at work:
981 * Some of the language bindings, for example the Python and Perl
982 * plugins, need to be able to export symbols to the scripts they run.
983 * For this to happen, the "Globals" flag needs to be set.
984 * Unfortunately, this technical detail is hard to explain to the
985 * average user and she shouldn't have to worry about this, ideally.
986 * So in order to save everyone's sanity use a different default for a
987 * handful of special plugins. --octo
989 if ((strcasecmp("perl", plugin_name) == 0) ||
990 (strcasecmp("python", plugin_name) == 0))
993 /* `cpu' should not match `cpufreq'. To solve this we add SHLIB_SUFFIX to the
994 * type when matching the filename */
995 status = snprintf(typename, sizeof(typename), "%s" SHLIB_SUFFIX, plugin_name);
996 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
997 WARNING("plugin_load: Filename too long: \"%s" SHLIB_SUFFIX "\"",
1002 if ((dh = opendir(dir)) == NULL) {
1003 ERROR("plugin_load: opendir (%s) failed: %s", dir, STRERRNO);
1007 while ((de = readdir(dh)) != NULL) {
1008 if (strcasecmp(de->d_name, typename))
1011 status = snprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1012 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1013 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1017 if (lstat(filename, &statbuf) == -1) {
1018 WARNING("plugin_load: stat (\"%s\") failed: %s", filename, STRERRNO);
1020 } else if (!S_ISREG(statbuf.st_mode)) {
1021 /* don't follow symlinks */
1022 WARNING("plugin_load: %s is not a regular file.", filename);
1026 status = plugin_load_file(filename, global);
1029 plugin_mark_loaded(plugin_name);
1031 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1034 ERROR("plugin_load: Load plugin \"%s\" failed with "
1036 plugin_name, status);
1042 if (filename[0] == 0)
1043 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1049 * The `register_*' functions follow
1051 EXPORT int plugin_register_config(const char *name,
1052 int (*callback)(const char *key,
1054 const char **keys, int keys_num) {
1055 cf_register(name, callback, keys, keys_num);
1057 } /* int plugin_register_config */
1059 EXPORT int plugin_register_complex_config(const char *type,
1060 int (*callback)(oconfig_item_t *)) {
1061 return cf_register_complex(type, callback);
1062 } /* int plugin_register_complex_config */
1064 EXPORT int plugin_register_init(const char *name, int (*callback)(void)) {
1065 return create_register_callback(&list_init, name, (void *)callback, NULL);
1066 } /* plugin_register_init */
1068 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1069 const read_func_t *rf0;
1070 const read_func_t *rf1;
1075 if (rf0->rf_next_read < rf1->rf_next_read)
1077 else if (rf0->rf_next_read > rf1->rf_next_read)
1081 } /* int plugin_compare_read_func */
1083 /* Add a read function to both, the heap and a linked list. The linked list if
1084 * used to look-up read functions, especially for the remove function. The heap
1085 * is used to determine which plugin to read next. */
1086 static int plugin_insert_read(read_func_t *rf) {
1090 rf->rf_next_read = cdtime();
1091 rf->rf_effective_interval = rf->rf_interval;
1093 pthread_mutex_lock(&read_lock);
1095 if (read_list == NULL) {
1096 read_list = llist_create();
1097 if (read_list == NULL) {
1098 pthread_mutex_unlock(&read_lock);
1099 ERROR("plugin_insert_read: read_list failed.");
1104 if (read_heap == NULL) {
1105 read_heap = c_heap_create(plugin_compare_read_func);
1106 if (read_heap == NULL) {
1107 pthread_mutex_unlock(&read_lock);
1108 ERROR("plugin_insert_read: c_heap_create failed.");
1113 le = llist_search(read_list, rf->rf_name);
1115 pthread_mutex_unlock(&read_lock);
1116 P_WARNING("The read function \"%s\" is already registered. "
1117 "Check for duplicates in your configuration!",
1122 le = llentry_create(rf->rf_name, rf);
1124 pthread_mutex_unlock(&read_lock);
1125 ERROR("plugin_insert_read: llentry_create failed.");
1129 status = c_heap_insert(read_heap, rf);
1131 pthread_mutex_unlock(&read_lock);
1132 ERROR("plugin_insert_read: c_heap_insert failed.");
1133 llentry_destroy(le);
1137 /* This does not fail. */
1138 llist_append(read_list, le);
1140 /* Wake up all the read threads. */
1141 pthread_cond_broadcast(&read_cond);
1142 pthread_mutex_unlock(&read_lock);
1144 } /* int plugin_insert_read */
1146 EXPORT int plugin_register_read(const char *name, int (*callback)(void)) {
1150 rf = calloc(1, sizeof(*rf));
1152 ERROR("plugin_register_read: calloc failed.");
1156 rf->rf_callback = (void *)callback;
1157 rf->rf_udata.data = NULL;
1158 rf->rf_udata.free_func = NULL;
1159 rf->rf_ctx = plugin_get_ctx();
1160 rf->rf_group[0] = '\0';
1161 rf->rf_name = strdup(name);
1162 rf->rf_type = RF_SIMPLE;
1163 rf->rf_interval = plugin_get_interval();
1164 rf->rf_ctx.interval = rf->rf_interval;
1166 status = plugin_insert_read(rf);
1173 } /* int plugin_register_read */
1175 EXPORT int plugin_register_complex_read(const char *group, const char *name,
1176 plugin_read_cb callback,
1178 user_data_t const *user_data) {
1182 rf = calloc(1, sizeof(*rf));
1184 free_userdata(user_data);
1185 ERROR("plugin_register_complex_read: calloc failed.");
1189 rf->rf_callback = (void *)callback;
1191 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1193 rf->rf_group[0] = '\0';
1194 rf->rf_name = strdup(name);
1195 rf->rf_type = RF_COMPLEX;
1196 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1199 if (user_data == NULL) {
1200 rf->rf_udata.data = NULL;
1201 rf->rf_udata.free_func = NULL;
1203 rf->rf_udata = *user_data;
1206 rf->rf_ctx = plugin_get_ctx();
1207 rf->rf_ctx.interval = rf->rf_interval;
1209 status = plugin_insert_read(rf);
1211 free_userdata(&rf->rf_udata);
1217 } /* int plugin_register_complex_read */
1219 EXPORT int plugin_register_write(const char *name, plugin_write_cb callback,
1220 user_data_t const *ud) {
1221 return create_register_callback(&list_write, name, (void *)callback, ud);
1222 } /* int plugin_register_write */
1224 static int plugin_flush_timeout_callback(user_data_t *ud) {
1225 flush_callback_t *cb = ud->data;
1227 return plugin_flush(cb->name, cb->timeout, NULL);
1228 } /* static int plugin_flush_callback */
1230 static void plugin_flush_timeout_callback_free(void *data) {
1231 flush_callback_t *cb = data;
1238 } /* static void plugin_flush_callback_free */
1240 static char *plugin_flush_callback_name(const char *name) {
1241 const char *flush_prefix = "flush/";
1246 prefix_size = strlen(flush_prefix);
1247 name_size = strlen(name);
1249 flush_name = malloc(name_size + prefix_size + 1);
1250 if (flush_name == NULL) {
1251 ERROR("plugin_flush_callback_name: malloc failed.");
1255 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1256 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1259 } /* static char *plugin_flush_callback_name */
1261 EXPORT int plugin_register_flush(const char *name, plugin_flush_cb callback,
1262 user_data_t const *ud) {
1264 plugin_ctx_t ctx = plugin_get_ctx();
1266 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1270 if (ctx.flush_interval != 0) {
1272 flush_callback_t *cb;
1274 flush_name = plugin_flush_callback_name(name);
1275 if (flush_name == NULL)
1278 cb = malloc(sizeof(*cb));
1280 ERROR("plugin_register_flush: malloc failed.");
1285 cb->name = strdup(name);
1286 if (cb->name == NULL) {
1287 ERROR("plugin_register_flush: strdup failed.");
1292 cb->timeout = ctx.flush_timeout;
1294 status = plugin_register_complex_read(
1295 /* group = */ "flush",
1296 /* name = */ flush_name,
1297 /* callback = */ plugin_flush_timeout_callback,
1298 /* interval = */ ctx.flush_interval,
1302 .free_func = plugin_flush_timeout_callback_free,
1310 } /* int plugin_register_flush */
1312 EXPORT int plugin_register_missing(const char *name, plugin_missing_cb callback,
1313 user_data_t const *ud) {
1314 return create_register_callback(&list_missing, name, (void *)callback, ud);
1315 } /* int plugin_register_missing */
1317 EXPORT int plugin_register_shutdown(const char *name, int (*callback)(void)) {
1318 return create_register_callback(&list_shutdown, name, (void *)callback, NULL);
1319 } /* int plugin_register_shutdown */
1321 static void plugin_free_data_sets(void) {
1325 if (data_sets == NULL)
1328 while (c_avl_pick(data_sets, &key, &value) == 0) {
1329 data_set_t *ds = value;
1330 /* key is a pointer to ds->type */
1336 c_avl_destroy(data_sets);
1338 } /* void plugin_free_data_sets */
1340 EXPORT int plugin_register_data_set(const data_set_t *ds) {
1341 data_set_t *ds_copy;
1343 if ((data_sets != NULL) && (c_avl_get(data_sets, ds->type, NULL) == 0)) {
1344 NOTICE("Replacing DS `%s' with another version.", ds->type);
1345 plugin_unregister_data_set(ds->type);
1346 } else if (data_sets == NULL) {
1347 data_sets = c_avl_create((int (*)(const void *, const void *))strcmp);
1348 if (data_sets == NULL)
1352 ds_copy = malloc(sizeof(*ds_copy));
1353 if (ds_copy == NULL)
1355 memcpy(ds_copy, ds, sizeof(data_set_t));
1357 ds_copy->ds = malloc(sizeof(*ds_copy->ds) * ds->ds_num);
1358 if (ds_copy->ds == NULL) {
1363 for (size_t i = 0; i < ds->ds_num; i++)
1364 memcpy(ds_copy->ds + i, ds->ds + i, sizeof(data_source_t));
1366 return c_avl_insert(data_sets, (void *)ds_copy->type, (void *)ds_copy);
1367 } /* int plugin_register_data_set */
1369 EXPORT int plugin_register_log(const char *name, plugin_log_cb callback,
1370 user_data_t const *ud) {
1371 return create_register_callback(&list_log, name, (void *)callback, ud);
1372 } /* int plugin_register_log */
1374 EXPORT int plugin_register_notification(const char *name,
1375 plugin_notification_cb callback,
1376 user_data_t const *ud) {
1377 return create_register_callback(&list_notification, name, (void *)callback,
1379 } /* int plugin_register_log */
1381 EXPORT int plugin_unregister_config(const char *name) {
1382 cf_unregister(name);
1384 } /* int plugin_unregister_config */
1386 EXPORT int plugin_unregister_complex_config(const char *name) {
1387 cf_unregister_complex(name);
1389 } /* int plugin_unregister_complex_config */
1391 EXPORT int plugin_unregister_init(const char *name) {
1392 return plugin_unregister(list_init, name);
1395 EXPORT int plugin_unregister_read(const char *name) /* {{{ */
1403 pthread_mutex_lock(&read_lock);
1405 if (read_list == NULL) {
1406 pthread_mutex_unlock(&read_lock);
1410 le = llist_search(read_list, name);
1412 pthread_mutex_unlock(&read_lock);
1413 WARNING("plugin_unregister_read: No such read function: %s", name);
1417 llist_remove(read_list, le);
1421 rf->rf_type = RF_REMOVE;
1423 pthread_mutex_unlock(&read_lock);
1425 llentry_destroy(le);
1427 DEBUG("plugin_unregister_read: Marked `%s' for removal.", name);
1430 } /* }}} int plugin_unregister_read */
1432 EXPORT void plugin_log_available_writers(void) {
1433 log_list_callbacks(&list_write, "Available write targets:");
1436 static int compare_read_func_group(llentry_t *e, void *ud) /* {{{ */
1438 read_func_t *rf = e->value;
1441 return strcmp(rf->rf_group, (const char *)group);
1442 } /* }}} int compare_read_func_group */
1444 EXPORT int plugin_unregister_read_group(const char *group) /* {{{ */
1454 pthread_mutex_lock(&read_lock);
1456 if (read_list == NULL) {
1457 pthread_mutex_unlock(&read_lock);
1462 le = llist_search_custom(read_list, compare_read_func_group, (void *)group);
1469 llist_remove(read_list, le);
1473 rf->rf_type = RF_REMOVE;
1475 llentry_destroy(le);
1477 DEBUG("plugin_unregister_read_group: "
1478 "Marked `%s' (group `%s') for removal.",
1479 rf->rf_name, group);
1482 pthread_mutex_unlock(&read_lock);
1485 WARNING("plugin_unregister_read_group: No such "
1486 "group of read function: %s",
1492 } /* }}} int plugin_unregister_read_group */
1494 EXPORT int plugin_unregister_write(const char *name) {
1495 return plugin_unregister(list_write, name);
1498 EXPORT int plugin_unregister_flush(const char *name) {
1499 plugin_ctx_t ctx = plugin_get_ctx();
1501 if (ctx.flush_interval != 0) {
1504 flush_name = plugin_flush_callback_name(name);
1505 if (flush_name != NULL) {
1506 plugin_unregister_read(flush_name);
1511 return plugin_unregister(list_flush, name);
1514 EXPORT int plugin_unregister_missing(const char *name) {
1515 return plugin_unregister(list_missing, name);
1518 EXPORT int plugin_unregister_shutdown(const char *name) {
1519 return plugin_unregister(list_shutdown, name);
1522 EXPORT int plugin_unregister_data_set(const char *name) {
1525 if (data_sets == NULL)
1528 if (c_avl_remove(data_sets, name, NULL, (void *)&ds) != 0)
1535 } /* int plugin_unregister_data_set */
1537 EXPORT int plugin_unregister_log(const char *name) {
1538 return plugin_unregister(list_log, name);
1541 EXPORT int plugin_unregister_notification(const char *name) {
1542 return plugin_unregister(list_notification, name);
1545 EXPORT int plugin_init_all(void) {
1546 char const *chain_name;
1551 /* Init the value cache */
1554 if (IS_TRUE(global_option_get("CollectInternalStats"))) {
1555 record_statistics = true;
1556 plugin_register_read("collectd", plugin_update_internal_statistics);
1559 chain_name = global_option_get("PreCacheChain");
1560 pre_cache_chain = fc_chain_get_by_name(chain_name);
1562 chain_name = global_option_get("PostCacheChain");
1563 post_cache_chain = fc_chain_get_by_name(chain_name);
1565 write_limit_high = global_option_get_long("WriteQueueLimitHigh",
1567 if (write_limit_high < 0) {
1568 ERROR("WriteQueueLimitHigh must be positive or zero.");
1569 write_limit_high = 0;
1573 global_option_get_long("WriteQueueLimitLow",
1574 /* default = */ write_limit_high / 2);
1575 if (write_limit_low < 0) {
1576 ERROR("WriteQueueLimitLow must be positive or zero.");
1577 write_limit_low = write_limit_high / 2;
1578 } else if (write_limit_low > write_limit_high) {
1579 ERROR("WriteQueueLimitLow must not be larger than "
1580 "WriteQueueLimitHigh.");
1581 write_limit_low = write_limit_high;
1584 write_threads_num = global_option_get_long("WriteThreads",
1586 if (write_threads_num < 1) {
1587 ERROR("WriteThreads must be positive.");
1588 write_threads_num = 5;
1591 if ((list_init == NULL) && (read_heap == NULL))
1594 /* Calling all init callbacks before checking if read callbacks
1595 * are available allows the init callbacks to register the read
1597 le = llist_head(list_init);
1598 while (le != NULL) {
1599 callback_func_t *cf;
1600 plugin_init_cb callback;
1601 plugin_ctx_t old_ctx;
1604 old_ctx = plugin_set_ctx(cf->cf_ctx);
1605 callback = cf->cf_callback;
1606 status = (*callback)();
1607 plugin_set_ctx(old_ctx);
1610 ERROR("Initialization of plugin `%s' "
1611 "failed with status %i. "
1612 "Plugin will be unloaded.",
1614 /* Plugins that register read callbacks from the init
1615 * callback should take care of appropriate error
1616 * handling themselves. */
1617 /* FIXME: Unload _all_ functions */
1618 plugin_unregister_read(le->key);
1625 start_write_threads((size_t)write_threads_num);
1628 global_option_get_time("MaxReadInterval", DEFAULT_MAX_READ_INTERVAL);
1630 /* Start read-threads */
1631 if (read_heap != NULL) {
1635 rt = global_option_get("ReadThreads");
1638 start_read_threads((num > 0) ? ((size_t)num) : 5);
1641 } /* void plugin_init_all */
1643 /* TODO: Rename this function. */
1644 EXPORT void plugin_read_all(void) {
1648 } /* void plugin_read_all */
1650 /* Read function called when the `-T' command line argument is given. */
1651 EXPORT int plugin_read_all_once(void) {
1653 int return_status = 0;
1655 if (read_heap == NULL) {
1656 NOTICE("No read-functions are registered.");
1662 plugin_ctx_t old_ctx;
1664 rf = c_heap_get_root(read_heap);
1668 old_ctx = plugin_set_ctx(rf->rf_ctx);
1670 if (rf->rf_type == RF_SIMPLE) {
1671 int (*callback)(void);
1673 callback = rf->rf_callback;
1674 status = (*callback)();
1676 plugin_read_cb callback;
1678 callback = rf->rf_callback;
1679 status = (*callback)(&rf->rf_udata);
1682 plugin_set_ctx(old_ctx);
1685 NOTICE("read-function of plugin `%s' failed.", rf->rf_name);
1690 destroy_callback((void *)rf);
1693 return return_status;
1694 } /* int plugin_read_all_once */
1696 EXPORT int plugin_write(const char *plugin, /* {{{ */
1697 const data_set_t *ds, const value_list_t *vl) {
1704 if (list_write == NULL)
1708 ds = plugin_get_ds(vl->type);
1710 ERROR("plugin_write: Unable to lookup type `%s'.", vl->type);
1715 if (plugin == NULL) {
1719 le = llist_head(list_write);
1720 while (le != NULL) {
1721 callback_func_t *cf = le->value;
1722 plugin_write_cb callback;
1724 /* Keep the read plugin's interval and flush information but update the
1726 plugin_ctx_t old_ctx = plugin_get_ctx();
1727 plugin_ctx_t ctx = old_ctx;
1728 ctx.name = cf->cf_ctx.name;
1729 plugin_set_ctx(ctx);
1731 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1732 callback = cf->cf_callback;
1733 status = (*callback)(ds, vl, &cf->cf_udata);
1739 plugin_set_ctx(old_ctx);
1743 if ((success == 0) && (failure != 0))
1747 } else /* plugin != NULL */
1749 callback_func_t *cf;
1750 plugin_write_cb callback;
1752 le = llist_head(list_write);
1753 while (le != NULL) {
1754 if (strcasecmp(plugin, le->key) == 0)
1765 /* do not switch plugin context; rather keep the context (interval)
1766 * information of the calling read plugin */
1768 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1769 callback = cf->cf_callback;
1770 status = (*callback)(ds, vl, &cf->cf_udata);
1774 } /* }}} int plugin_write */
1776 EXPORT int plugin_flush(const char *plugin, cdtime_t timeout,
1777 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 EXPORT 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 EXPORT int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1875 if (list_missing == NULL)
1878 llentry_t *le = llist_head(list_missing);
1879 while (le != NULL) {
1880 callback_func_t *cf = le->value;
1881 plugin_ctx_t old_ctx = plugin_set_ctx(cf->cf_ctx);
1882 plugin_missing_cb callback = cf->cf_callback;
1884 int status = (*callback)(vl, &cf->cf_udata);
1885 plugin_set_ctx(old_ctx);
1888 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1889 "failed with status %i.",
1900 } /* int }}} plugin_dispatch_missing */
1902 static int plugin_dispatch_values_internal(value_list_t *vl) {
1904 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1906 bool free_meta_data = false;
1910 /* These fields are initialized by plugin_value_list_clone() if needed: */
1911 assert(vl->host[0] != 0);
1912 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1913 assert(vl->interval != 0);
1915 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1916 ERROR("plugin_dispatch_values: Invalid value list "
1922 /* Free meta data only if the calling function didn't specify any. In
1923 * this case matches and targets may add some and the calling function
1924 * may not expect (and therefore free) that data. */
1925 if (vl->meta == NULL)
1926 free_meta_data = true;
1928 if (list_write == NULL)
1929 c_complain_once(LOG_WARNING, &no_write_complaint,
1930 "plugin_dispatch_values: No write callback has been "
1931 "registered. Please load at least one output plugin, "
1932 "if you want the collected data to be stored.");
1934 if (data_sets == NULL) {
1935 ERROR("plugin_dispatch_values: No data sets registered. "
1936 "Could the types database be read? Check "
1937 "your `TypesDB' setting!");
1941 data_set_t *ds = NULL;
1942 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1943 char ident[6 * DATA_MAX_NAME_LEN];
1945 FORMAT_VL(ident, sizeof(ident), vl);
1946 INFO("plugin_dispatch_values: Dataset not found: %s "
1947 "(from \"%s\"), check your types.db!",
1952 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1954 "plugin = %s; plugin_instance = %s; "
1955 "type = %s; type_instance = %s;",
1956 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1957 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1960 assert(0 == strcmp(ds->type, vl->type));
1962 if (0 != strcmp(ds->type, vl->type))
1963 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1964 ds->type, vl->type);
1968 assert(ds->ds_num == vl->values_len);
1970 if (ds->ds_num != vl->values_len) {
1971 ERROR("plugin_dispatch_values: ds->type = %s: "
1972 "(ds->ds_num = %" PRIsz ") != "
1973 "(vl->values_len = %" PRIsz ")",
1974 ds->type, ds->ds_num, vl->values_len);
1979 escape_slashes(vl->host, sizeof(vl->host));
1980 escape_slashes(vl->plugin, sizeof(vl->plugin));
1981 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
1982 escape_slashes(vl->type, sizeof(vl->type));
1983 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
1985 if (pre_cache_chain != NULL) {
1986 status = fc_process_chain(ds, vl, pre_cache_chain);
1988 WARNING("plugin_dispatch_values: Running the "
1989 "pre-cache chain failed with "
1992 } else if (status == FC_TARGET_STOP)
1996 /* Update the value cache */
1999 if (post_cache_chain != NULL) {
2000 status = fc_process_chain(ds, vl, post_cache_chain);
2002 WARNING("plugin_dispatch_values: Running the "
2003 "post-cache chain failed with "
2008 fc_default_action(ds, vl);
2010 if ((free_meta_data == true) && (vl->meta != NULL)) {
2011 meta_data_destroy(vl->meta);
2016 } /* int plugin_dispatch_values_internal */
2018 static double get_drop_probability(void) /* {{{ */
2024 pthread_mutex_lock(&write_lock);
2025 wql = write_queue_length;
2026 pthread_mutex_unlock(&write_lock);
2028 if (wql < write_limit_low)
2030 if (wql >= write_limit_high)
2033 pos = 1 + wql - write_limit_low;
2034 size = 1 + write_limit_high - write_limit_low;
2036 return (double)pos / (double)size;
2037 } /* }}} double get_drop_probability */
2039 static bool check_drop_value(void) /* {{{ */
2041 static cdtime_t last_message_time;
2042 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2048 if (write_limit_high == 0)
2051 p = get_drop_probability();
2055 status = pthread_mutex_trylock(&last_message_lock);
2060 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2061 last_message_time = now;
2062 ERROR("plugin_dispatch_values: Low water mark "
2063 "reached. Dropping %.0f%% of metrics.",
2066 pthread_mutex_unlock(&last_message_lock);
2077 } /* }}} bool check_drop_value */
2079 EXPORT int plugin_dispatch_values(value_list_t const *vl) {
2082 if (check_drop_value()) {
2083 if (record_statistics) {
2084 pthread_mutex_lock(&statistics_lock);
2085 stats_values_dropped++;
2086 pthread_mutex_unlock(&statistics_lock);
2091 status = plugin_write_enqueue(vl);
2093 ERROR("plugin_dispatch_values: plugin_write_enqueue failed with status %i "
2095 status, STRERROR(status));
2102 __attribute__((sentinel)) int
2103 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2104 bool store_percentage, int store_type, ...) {
2110 if (check_drop_value()) {
2111 if (record_statistics) {
2112 pthread_mutex_lock(&statistics_lock);
2113 stats_values_dropped++;
2114 pthread_mutex_unlock(&statistics_lock);
2119 assert(template->values_len == 1);
2121 /* Calculate sum for Gauge to calculate percent if needed */
2122 if (DS_TYPE_GAUGE == store_type) {
2123 va_start(ap, store_type);
2128 name = va_arg(ap, char const *);
2132 value = va_arg(ap, gauge_t);
2139 vl = plugin_value_list_clone(template);
2140 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2141 if (store_percentage)
2142 sstrncpy(vl->type, "percent", sizeof(vl->type));
2144 va_start(ap, store_type);
2149 /* Set the type instance. */
2150 name = va_arg(ap, char const *);
2153 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2155 /* Set the value. */
2156 switch (store_type) {
2158 vl->values[0].gauge = va_arg(ap, gauge_t);
2159 if (store_percentage)
2160 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2162 case DS_TYPE_ABSOLUTE:
2163 vl->values[0].absolute = va_arg(ap, absolute_t);
2165 case DS_TYPE_COUNTER:
2166 vl->values[0].counter = va_arg(ap, counter_t);
2168 case DS_TYPE_DERIVE:
2169 vl->values[0].derive = va_arg(ap, derive_t);
2172 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2176 status = plugin_write_enqueue(vl);
2182 plugin_value_list_free(vl);
2184 } /* }}} int plugin_dispatch_multivalue */
2186 EXPORT int plugin_dispatch_notification(const notification_t *notif) {
2188 /* Possible TODO: Add flap detection here */
2190 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2191 "time = %.3f; host = %s;",
2192 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2195 /* Nobody cares for notifications */
2196 if (list_notification == NULL)
2199 le = llist_head(list_notification);
2200 while (le != NULL) {
2201 callback_func_t *cf;
2202 plugin_notification_cb callback;
2205 /* do not switch plugin context; rather keep the context
2206 * (interval) information of the calling plugin */
2209 callback = cf->cf_callback;
2210 status = (*callback)(notif, &cf->cf_udata);
2212 WARNING("plugin_dispatch_notification: Notification "
2213 "callback %s returned %i.",
2221 } /* int plugin_dispatch_notification */
2223 EXPORT void plugin_log(int level, const char *format, ...) {
2229 if (level >= LOG_DEBUG)
2233 va_start(ap, format);
2234 vsnprintf(msg, sizeof(msg), format, ap);
2235 msg[sizeof(msg) - 1] = '\0';
2238 if (list_log == NULL) {
2239 fprintf(stderr, "%s\n", msg);
2243 le = llist_head(list_log);
2244 while (le != NULL) {
2245 callback_func_t *cf;
2246 plugin_log_cb callback;
2249 callback = cf->cf_callback;
2251 /* do not switch plugin context; rather keep the context
2252 * (interval) information of the calling plugin */
2254 (*callback)(level, msg, &cf->cf_udata);
2258 } /* void plugin_log */
2260 void daemon_log(int level, const char *format, ...) {
2261 char msg[1024] = ""; // Size inherits from plugin_log()
2263 char const *name = plugin_get_ctx().name;
2268 va_start(ap, format);
2269 vsnprintf(msg, sizeof(msg), format, ap);
2272 plugin_log(level, "%s plugin: %s", name, msg);
2273 } /* void daemon_log */
2275 int parse_log_severity(const char *severity) {
2278 if ((0 == strcasecmp(severity, "emerg")) ||
2279 (0 == strcasecmp(severity, "alert")) ||
2280 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2281 log_level = LOG_ERR;
2282 else if (0 == strcasecmp(severity, "warning"))
2283 log_level = LOG_WARNING;
2284 else if (0 == strcasecmp(severity, "notice"))
2285 log_level = LOG_NOTICE;
2286 else if (0 == strcasecmp(severity, "info"))
2287 log_level = LOG_INFO;
2289 else if (0 == strcasecmp(severity, "debug"))
2290 log_level = LOG_DEBUG;
2291 #endif /* COLLECT_DEBUG */
2294 } /* int parse_log_severity */
2296 EXPORT int parse_notif_severity(const char *severity) {
2297 int notif_severity = -1;
2299 if (strcasecmp(severity, "FAILURE") == 0)
2300 notif_severity = NOTIF_FAILURE;
2301 else if (strcmp(severity, "OKAY") == 0)
2302 notif_severity = NOTIF_OKAY;
2303 else if ((strcmp(severity, "WARNING") == 0) ||
2304 (strcmp(severity, "WARN") == 0))
2305 notif_severity = NOTIF_WARNING;
2307 return notif_severity;
2308 } /* int parse_notif_severity */
2310 EXPORT const data_set_t *plugin_get_ds(const char *name) {
2313 if (data_sets == NULL) {
2314 P_ERROR("plugin_get_ds: No data sets are defined yet.");
2318 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2319 DEBUG("No such dataset registered: %s", name);
2324 } /* data_set_t *plugin_get_ds */
2326 static int plugin_notification_meta_add(notification_t *n, const char *name,
2327 enum notification_meta_type_e type,
2328 const void *value) {
2329 notification_meta_t *meta;
2330 notification_meta_t *tail;
2332 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2333 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2337 meta = calloc(1, sizeof(*meta));
2339 ERROR("plugin_notification_meta_add: calloc failed.");
2343 sstrncpy(meta->name, name, sizeof(meta->name));
2347 case NM_TYPE_STRING: {
2348 meta->nm_value.nm_string = strdup((const char *)value);
2349 if (meta->nm_value.nm_string == NULL) {
2350 ERROR("plugin_notification_meta_add: strdup failed.");
2356 case NM_TYPE_SIGNED_INT: {
2357 meta->nm_value.nm_signed_int = *((int64_t *)value);
2360 case NM_TYPE_UNSIGNED_INT: {
2361 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2364 case NM_TYPE_DOUBLE: {
2365 meta->nm_value.nm_double = *((double *)value);
2368 case NM_TYPE_BOOLEAN: {
2369 meta->nm_value.nm_boolean = *((bool *)value);
2373 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2377 } /* switch (type) */
2381 while ((tail != NULL) && (tail->next != NULL))
2390 } /* int plugin_notification_meta_add */
2392 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2393 const char *value) {
2394 return plugin_notification_meta_add(n, name, NM_TYPE_STRING, value);
2397 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2399 return plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value);
2402 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2405 return plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value);
2408 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2410 return plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value);
2413 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2415 return plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value);
2418 int plugin_notification_meta_copy(notification_t *dst,
2419 const notification_t *src) {
2420 assert(dst != NULL);
2421 assert(src != NULL);
2423 assert((src->meta == NULL) || (src->meta != dst->meta));
2425 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2426 if (meta->type == NM_TYPE_STRING)
2427 plugin_notification_meta_add_string(dst, meta->name,
2428 meta->nm_value.nm_string);
2429 else if (meta->type == NM_TYPE_SIGNED_INT)
2430 plugin_notification_meta_add_signed_int(dst, meta->name,
2431 meta->nm_value.nm_signed_int);
2432 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2433 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2434 meta->nm_value.nm_unsigned_int);
2435 else if (meta->type == NM_TYPE_DOUBLE)
2436 plugin_notification_meta_add_double(dst, meta->name,
2437 meta->nm_value.nm_double);
2438 else if (meta->type == NM_TYPE_BOOLEAN)
2439 plugin_notification_meta_add_boolean(dst, meta->name,
2440 meta->nm_value.nm_boolean);
2444 } /* int plugin_notification_meta_copy */
2446 int plugin_notification_meta_free(notification_meta_t *n) {
2447 notification_meta_t *this;
2448 notification_meta_t *next;
2451 ERROR("plugin_notification_meta_free: n == NULL!");
2456 while (this != NULL) {
2459 if (this->type == NM_TYPE_STRING) {
2460 /* Assign to a temporary variable to work around nm_string's const
2462 void *tmp = (void *)this->nm_value.nm_string;
2465 this->nm_value.nm_string = NULL;
2473 } /* int plugin_notification_meta_free */
2475 static void plugin_ctx_destructor(void *ctx) {
2477 } /* void plugin_ctx_destructor */
2479 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2481 static plugin_ctx_t *plugin_ctx_create(void) {
2484 ctx = malloc(sizeof(*ctx));
2486 ERROR("Failed to allocate plugin context: %s", STRERRNO);
2491 assert(plugin_ctx_key_initialized);
2492 pthread_setspecific(plugin_ctx_key, ctx);
2493 DEBUG("Created new plugin context.");
2495 } /* int plugin_ctx_create */
2497 EXPORT void plugin_init_ctx(void) {
2498 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2499 plugin_ctx_key_initialized = true;
2500 } /* void plugin_init_ctx */
2502 EXPORT plugin_ctx_t plugin_get_ctx(void) {
2505 assert(plugin_ctx_key_initialized);
2506 ctx = pthread_getspecific(plugin_ctx_key);
2509 ctx = plugin_ctx_create();
2510 /* this must no happen -- exit() instead? */
2516 } /* plugin_ctx_t plugin_get_ctx */
2518 EXPORT plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2522 assert(plugin_ctx_key_initialized);
2523 c = pthread_getspecific(plugin_ctx_key);
2526 c = plugin_ctx_create();
2527 /* this must no happen -- exit() instead? */
2536 } /* void plugin_set_ctx */
2538 EXPORT cdtime_t plugin_get_interval(void) {
2541 interval = plugin_get_ctx().interval;
2545 P_ERROR("plugin_get_interval: Unable to determine Interval from context.");
2547 return cf_get_default_interval();
2548 } /* cdtime_t plugin_get_interval */
2552 void *(*start_routine)(void *);
2556 static void *plugin_thread_start(void *arg) {
2557 plugin_thread_t *plugin_thread = arg;
2559 void *(*start_routine)(void *) = plugin_thread->start_routine;
2560 void *plugin_arg = plugin_thread->arg;
2562 plugin_set_ctx(plugin_thread->ctx);
2564 sfree(plugin_thread);
2566 return start_routine(plugin_arg);
2567 } /* void *plugin_thread_start */
2569 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2570 void *(*start_routine)(void *), void *arg,
2572 plugin_thread_t *plugin_thread;
2574 plugin_thread = malloc(sizeof(*plugin_thread));
2575 if (plugin_thread == NULL)
2578 plugin_thread->ctx = plugin_get_ctx();
2579 plugin_thread->start_routine = start_routine;
2580 plugin_thread->arg = arg;
2582 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2584 sfree(plugin_thread);
2589 set_thread_name(*thread, name);
2592 } /* int plugin_thread_create */