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 snprintf(name, sizeof(name), "reader#%" PRIu64, (uint64_t)read_threads_num);
651 set_thread_name(read_threads[read_threads_num], name);
655 } /* }}} void start_read_threads */
657 static void stop_read_threads(void) {
658 if (read_threads == NULL)
661 INFO("collectd: Stopping %" PRIsz " read threads.", read_threads_num);
663 pthread_mutex_lock(&read_lock);
665 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
666 pthread_cond_broadcast(&read_cond);
667 pthread_mutex_unlock(&read_lock);
669 for (size_t i = 0; i < read_threads_num; i++) {
670 if (pthread_join(read_threads[i], NULL) != 0) {
671 ERROR("plugin: stop_read_threads: pthread_join failed.");
673 read_threads[i] = (pthread_t)0;
676 read_threads_num = 0;
677 } /* void stop_read_threads */
679 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
684 meta_data_destroy(vl->meta);
687 } /* }}} void plugin_value_list_free */
689 static value_list_t *
690 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
697 vl = malloc(sizeof(*vl));
700 memcpy(vl, vl_orig, sizeof(*vl));
702 if (vl->host[0] == 0)
703 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
705 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
706 if (vl->values == NULL) {
707 plugin_value_list_free(vl);
710 memcpy(vl->values, vl_orig->values,
711 vl_orig->values_len * sizeof(*vl->values));
713 vl->meta = meta_data_clone(vl->meta);
714 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
715 plugin_value_list_free(vl);
722 /* Fill in the interval from the thread context, if it is zero. */
723 if (vl->interval == 0)
724 vl->interval = plugin_get_interval();
727 } /* }}} value_list_t *plugin_value_list_clone */
729 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
733 q = malloc(sizeof(*q));
738 q->vl = plugin_value_list_clone(vl);
744 /* Store context of caller (read plugin); otherwise, it would not be
745 * available to the write plugins when actually dispatching the
746 * value-list later on. */
747 q->ctx = plugin_get_ctx();
749 pthread_mutex_lock(&write_lock);
751 if (write_queue_tail == NULL) {
752 write_queue_head = q;
753 write_queue_tail = q;
754 write_queue_length = 1;
756 write_queue_tail->next = q;
757 write_queue_tail = q;
758 write_queue_length += 1;
761 pthread_cond_signal(&write_cond);
762 pthread_mutex_unlock(&write_lock);
765 } /* }}} int plugin_write_enqueue */
767 static value_list_t *plugin_write_dequeue(void) /* {{{ */
772 pthread_mutex_lock(&write_lock);
774 while (write_loop && (write_queue_head == NULL))
775 pthread_cond_wait(&write_cond, &write_lock);
777 if (write_queue_head == NULL) {
778 pthread_mutex_unlock(&write_lock);
782 q = write_queue_head;
783 write_queue_head = q->next;
784 write_queue_length -= 1;
785 if (write_queue_head == NULL) {
786 write_queue_tail = NULL;
787 assert(0 == write_queue_length);
790 pthread_mutex_unlock(&write_lock);
792 (void)plugin_set_ctx(q->ctx);
797 } /* }}} value_list_t *plugin_write_dequeue */
799 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
802 value_list_t *vl = plugin_write_dequeue();
806 plugin_dispatch_values_internal(vl);
808 plugin_value_list_free(vl);
813 } /* }}} void *plugin_write_thread */
815 static void start_write_threads(size_t num) /* {{{ */
817 if (write_threads != NULL)
820 write_threads = calloc(num, sizeof(*write_threads));
821 if (write_threads == NULL) {
822 ERROR("plugin: start_write_threads: calloc failed.");
826 write_threads_num = 0;
827 for (size_t i = 0; i < num; i++) {
828 int status = pthread_create(write_threads + write_threads_num,
829 /* attr = */ NULL, plugin_write_thread,
832 ERROR("plugin: start_write_threads: pthread_create failed with status %i "
834 status, STRERROR(status));
838 char name[THREAD_NAME_MAX];
839 snprintf(name, sizeof(name), "writer#%" PRIu64,
840 (uint64_t)write_threads_num);
841 set_thread_name(write_threads[write_threads_num], name);
845 } /* }}} void start_write_threads */
847 static void stop_write_threads(void) /* {{{ */
852 if (write_threads == NULL)
855 INFO("collectd: Stopping %" PRIsz " write threads.", write_threads_num);
857 pthread_mutex_lock(&write_lock);
859 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
860 pthread_cond_broadcast(&write_cond);
861 pthread_mutex_unlock(&write_lock);
863 for (i = 0; i < write_threads_num; i++) {
864 if (pthread_join(write_threads[i], NULL) != 0) {
865 ERROR("plugin: stop_write_threads: pthread_join failed.");
867 write_threads[i] = (pthread_t)0;
869 sfree(write_threads);
870 write_threads_num = 0;
872 pthread_mutex_lock(&write_lock);
874 for (q = write_queue_head; q != NULL;) {
875 write_queue_t *q1 = q;
876 plugin_value_list_free(q->vl);
881 write_queue_head = NULL;
882 write_queue_tail = NULL;
883 write_queue_length = 0;
884 pthread_mutex_unlock(&write_lock);
887 WARNING("plugin: %" PRIsz " value list%s left after shutting down "
888 "the write threads.",
889 i, (i == 1) ? " was" : "s were");
891 } /* }}} void stop_write_threads */
896 void plugin_set_dir(const char *dir) {
904 plugindir = strdup(dir);
905 if (plugindir == NULL)
906 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
909 static bool plugin_is_loaded(char const *name) {
912 if (plugins_loaded == NULL)
914 c_avl_create((int (*)(const void *, const void *))strcasecmp);
915 assert(plugins_loaded != NULL);
917 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
921 static int plugin_mark_loaded(char const *name) {
925 name_copy = strdup(name);
926 if (name_copy == NULL)
929 status = c_avl_insert(plugins_loaded,
930 /* key = */ name_copy, /* value = */ NULL);
934 static void plugin_free_loaded(void) {
938 if (plugins_loaded == NULL)
941 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
943 assert(value == NULL);
946 c_avl_destroy(plugins_loaded);
947 plugins_loaded = NULL;
952 #define SHLIB_SUFFIX ".dll"
954 #define SHLIB_SUFFIX ".so"
956 int plugin_load(char const *plugin_name, bool global) {
959 char filename[BUFSIZE] = "";
960 char typename[BUFSIZE];
966 if (plugin_name == NULL)
969 /* Check if plugin is already loaded and don't do anything in this
971 if (plugin_is_loaded(plugin_name))
974 dir = plugin_get_dir();
978 * XXX: Magic at work:
980 * Some of the language bindings, for example the Python and Perl
981 * plugins, need to be able to export symbols to the scripts they run.
982 * For this to happen, the "Globals" flag needs to be set.
983 * Unfortunately, this technical detail is hard to explain to the
984 * average user and she shouldn't have to worry about this, ideally.
985 * So in order to save everyone's sanity use a different default for a
986 * handful of special plugins. --octo
988 if ((strcasecmp("perl", plugin_name) == 0) ||
989 (strcasecmp("python", plugin_name) == 0))
992 /* `cpu' should not match `cpufreq'. To solve this we add SHLIB_SUFFIX to the
993 * type when matching the filename */
994 status = snprintf(typename, sizeof(typename), "%s" SHLIB_SUFFIX, plugin_name);
995 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
996 WARNING("plugin_load: Filename too long: \"%s" SHLIB_SUFFIX "\"",
1001 if ((dh = opendir(dir)) == NULL) {
1002 ERROR("plugin_load: opendir (%s) failed: %s", dir, STRERRNO);
1006 while ((de = readdir(dh)) != NULL) {
1007 if (strcasecmp(de->d_name, typename))
1010 status = snprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1011 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1012 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1016 if (lstat(filename, &statbuf) == -1) {
1017 WARNING("plugin_load: stat (\"%s\") failed: %s", filename, STRERRNO);
1019 } else if (!S_ISREG(statbuf.st_mode)) {
1020 /* don't follow symlinks */
1021 WARNING("plugin_load: %s is not a regular file.", filename);
1025 status = plugin_load_file(filename, global);
1028 plugin_mark_loaded(plugin_name);
1030 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1033 ERROR("plugin_load: Load plugin \"%s\" failed with "
1035 plugin_name, status);
1041 if (filename[0] == 0)
1042 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1048 * The `register_*' functions follow
1050 EXPORT int plugin_register_config(const char *name,
1051 int (*callback)(const char *key,
1053 const char **keys, int keys_num) {
1054 cf_register(name, callback, keys, keys_num);
1056 } /* int plugin_register_config */
1058 EXPORT int plugin_register_complex_config(const char *type,
1059 int (*callback)(oconfig_item_t *)) {
1060 return cf_register_complex(type, callback);
1061 } /* int plugin_register_complex_config */
1063 EXPORT int plugin_register_init(const char *name, int (*callback)(void)) {
1064 return create_register_callback(&list_init, name, (void *)callback, NULL);
1065 } /* plugin_register_init */
1067 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1068 const read_func_t *rf0;
1069 const read_func_t *rf1;
1074 if (rf0->rf_next_read < rf1->rf_next_read)
1076 else if (rf0->rf_next_read > rf1->rf_next_read)
1080 } /* int plugin_compare_read_func */
1082 /* Add a read function to both, the heap and a linked list. The linked list if
1083 * used to look-up read functions, especially for the remove function. The heap
1084 * is used to determine which plugin to read next. */
1085 static int plugin_insert_read(read_func_t *rf) {
1089 rf->rf_next_read = cdtime();
1090 rf->rf_effective_interval = rf->rf_interval;
1092 pthread_mutex_lock(&read_lock);
1094 if (read_list == NULL) {
1095 read_list = llist_create();
1096 if (read_list == NULL) {
1097 pthread_mutex_unlock(&read_lock);
1098 ERROR("plugin_insert_read: read_list failed.");
1103 if (read_heap == NULL) {
1104 read_heap = c_heap_create(plugin_compare_read_func);
1105 if (read_heap == NULL) {
1106 pthread_mutex_unlock(&read_lock);
1107 ERROR("plugin_insert_read: c_heap_create failed.");
1112 le = llist_search(read_list, rf->rf_name);
1114 pthread_mutex_unlock(&read_lock);
1115 P_WARNING("The read function \"%s\" is already registered. "
1116 "Check for duplicates in your configuration!",
1121 le = llentry_create(rf->rf_name, rf);
1123 pthread_mutex_unlock(&read_lock);
1124 ERROR("plugin_insert_read: llentry_create failed.");
1128 status = c_heap_insert(read_heap, rf);
1130 pthread_mutex_unlock(&read_lock);
1131 ERROR("plugin_insert_read: c_heap_insert failed.");
1132 llentry_destroy(le);
1136 /* This does not fail. */
1137 llist_append(read_list, le);
1139 /* Wake up all the read threads. */
1140 pthread_cond_broadcast(&read_cond);
1141 pthread_mutex_unlock(&read_lock);
1143 } /* int plugin_insert_read */
1145 EXPORT int plugin_register_read(const char *name, int (*callback)(void)) {
1149 rf = calloc(1, sizeof(*rf));
1151 ERROR("plugin_register_read: calloc failed.");
1155 rf->rf_callback = (void *)callback;
1156 rf->rf_udata.data = NULL;
1157 rf->rf_udata.free_func = NULL;
1158 rf->rf_ctx = plugin_get_ctx();
1159 rf->rf_group[0] = '\0';
1160 rf->rf_name = strdup(name);
1161 rf->rf_type = RF_SIMPLE;
1162 rf->rf_interval = plugin_get_interval();
1163 rf->rf_ctx.interval = rf->rf_interval;
1165 status = plugin_insert_read(rf);
1172 } /* int plugin_register_read */
1174 EXPORT int plugin_register_complex_read(const char *group, const char *name,
1175 plugin_read_cb callback,
1177 user_data_t const *user_data) {
1181 rf = calloc(1, sizeof(*rf));
1183 free_userdata(user_data);
1184 ERROR("plugin_register_complex_read: calloc failed.");
1188 rf->rf_callback = (void *)callback;
1190 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1192 rf->rf_group[0] = '\0';
1193 rf->rf_name = strdup(name);
1194 rf->rf_type = RF_COMPLEX;
1195 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1198 if (user_data == NULL) {
1199 rf->rf_udata.data = NULL;
1200 rf->rf_udata.free_func = NULL;
1202 rf->rf_udata = *user_data;
1205 rf->rf_ctx = plugin_get_ctx();
1206 rf->rf_ctx.interval = rf->rf_interval;
1208 status = plugin_insert_read(rf);
1210 free_userdata(&rf->rf_udata);
1216 } /* int plugin_register_complex_read */
1218 EXPORT int plugin_register_write(const char *name, plugin_write_cb callback,
1219 user_data_t const *ud) {
1220 return create_register_callback(&list_write, name, (void *)callback, ud);
1221 } /* int plugin_register_write */
1223 static int plugin_flush_timeout_callback(user_data_t *ud) {
1224 flush_callback_t *cb = ud->data;
1226 return plugin_flush(cb->name, cb->timeout, NULL);
1227 } /* static int plugin_flush_callback */
1229 static void plugin_flush_timeout_callback_free(void *data) {
1230 flush_callback_t *cb = data;
1237 } /* static void plugin_flush_callback_free */
1239 static char *plugin_flush_callback_name(const char *name) {
1240 const char *flush_prefix = "flush/";
1245 prefix_size = strlen(flush_prefix);
1246 name_size = strlen(name);
1248 flush_name = malloc(name_size + prefix_size + 1);
1249 if (flush_name == NULL) {
1250 ERROR("plugin_flush_callback_name: malloc failed.");
1254 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1255 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1258 } /* static char *plugin_flush_callback_name */
1260 EXPORT int plugin_register_flush(const char *name, plugin_flush_cb callback,
1261 user_data_t const *ud) {
1263 plugin_ctx_t ctx = plugin_get_ctx();
1265 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1269 if (ctx.flush_interval != 0) {
1271 flush_callback_t *cb;
1273 flush_name = plugin_flush_callback_name(name);
1274 if (flush_name == NULL)
1277 cb = malloc(sizeof(*cb));
1279 ERROR("plugin_register_flush: malloc failed.");
1284 cb->name = strdup(name);
1285 if (cb->name == NULL) {
1286 ERROR("plugin_register_flush: strdup failed.");
1291 cb->timeout = ctx.flush_timeout;
1293 status = plugin_register_complex_read(
1294 /* group = */ "flush",
1295 /* name = */ flush_name,
1296 /* callback = */ plugin_flush_timeout_callback,
1297 /* interval = */ ctx.flush_interval,
1301 .free_func = plugin_flush_timeout_callback_free,
1309 } /* int plugin_register_flush */
1311 EXPORT int plugin_register_missing(const char *name, plugin_missing_cb callback,
1312 user_data_t const *ud) {
1313 return create_register_callback(&list_missing, name, (void *)callback, ud);
1314 } /* int plugin_register_missing */
1316 EXPORT int plugin_register_shutdown(const char *name, int (*callback)(void)) {
1317 return create_register_callback(&list_shutdown, name, (void *)callback, NULL);
1318 } /* int plugin_register_shutdown */
1320 static void plugin_free_data_sets(void) {
1324 if (data_sets == NULL)
1327 while (c_avl_pick(data_sets, &key, &value) == 0) {
1328 data_set_t *ds = value;
1329 /* key is a pointer to ds->type */
1335 c_avl_destroy(data_sets);
1337 } /* void plugin_free_data_sets */
1339 EXPORT int plugin_register_data_set(const data_set_t *ds) {
1340 data_set_t *ds_copy;
1342 if ((data_sets != NULL) && (c_avl_get(data_sets, ds->type, NULL) == 0)) {
1343 NOTICE("Replacing DS `%s' with another version.", ds->type);
1344 plugin_unregister_data_set(ds->type);
1345 } else if (data_sets == NULL) {
1346 data_sets = c_avl_create((int (*)(const void *, const void *))strcmp);
1347 if (data_sets == NULL)
1351 ds_copy = malloc(sizeof(*ds_copy));
1352 if (ds_copy == NULL)
1354 memcpy(ds_copy, ds, sizeof(data_set_t));
1356 ds_copy->ds = malloc(sizeof(*ds_copy->ds) * ds->ds_num);
1357 if (ds_copy->ds == NULL) {
1362 for (size_t i = 0; i < ds->ds_num; i++)
1363 memcpy(ds_copy->ds + i, ds->ds + i, sizeof(data_source_t));
1365 return c_avl_insert(data_sets, (void *)ds_copy->type, (void *)ds_copy);
1366 } /* int plugin_register_data_set */
1368 EXPORT int plugin_register_log(const char *name, plugin_log_cb callback,
1369 user_data_t const *ud) {
1370 return create_register_callback(&list_log, name, (void *)callback, ud);
1371 } /* int plugin_register_log */
1373 EXPORT int plugin_register_notification(const char *name,
1374 plugin_notification_cb callback,
1375 user_data_t const *ud) {
1376 return create_register_callback(&list_notification, name, (void *)callback,
1378 } /* int plugin_register_log */
1380 EXPORT int plugin_unregister_config(const char *name) {
1381 cf_unregister(name);
1383 } /* int plugin_unregister_config */
1385 EXPORT int plugin_unregister_complex_config(const char *name) {
1386 cf_unregister_complex(name);
1388 } /* int plugin_unregister_complex_config */
1390 EXPORT int plugin_unregister_init(const char *name) {
1391 return plugin_unregister(list_init, name);
1394 EXPORT int plugin_unregister_read(const char *name) /* {{{ */
1402 pthread_mutex_lock(&read_lock);
1404 if (read_list == NULL) {
1405 pthread_mutex_unlock(&read_lock);
1409 le = llist_search(read_list, name);
1411 pthread_mutex_unlock(&read_lock);
1412 WARNING("plugin_unregister_read: No such read function: %s", name);
1416 llist_remove(read_list, le);
1420 rf->rf_type = RF_REMOVE;
1422 pthread_mutex_unlock(&read_lock);
1424 llentry_destroy(le);
1426 DEBUG("plugin_unregister_read: Marked `%s' for removal.", name);
1429 } /* }}} int plugin_unregister_read */
1431 EXPORT void plugin_log_available_writers(void) {
1432 log_list_callbacks(&list_write, "Available write targets:");
1435 static int compare_read_func_group(llentry_t *e, void *ud) /* {{{ */
1437 read_func_t *rf = e->value;
1440 return strcmp(rf->rf_group, (const char *)group);
1441 } /* }}} int compare_read_func_group */
1443 EXPORT int plugin_unregister_read_group(const char *group) /* {{{ */
1453 pthread_mutex_lock(&read_lock);
1455 if (read_list == NULL) {
1456 pthread_mutex_unlock(&read_lock);
1461 le = llist_search_custom(read_list, compare_read_func_group, (void *)group);
1468 llist_remove(read_list, le);
1472 rf->rf_type = RF_REMOVE;
1474 llentry_destroy(le);
1476 DEBUG("plugin_unregister_read_group: "
1477 "Marked `%s' (group `%s') for removal.",
1478 rf->rf_name, group);
1481 pthread_mutex_unlock(&read_lock);
1484 WARNING("plugin_unregister_read_group: No such "
1485 "group of read function: %s",
1491 } /* }}} int plugin_unregister_read_group */
1493 EXPORT int plugin_unregister_write(const char *name) {
1494 return plugin_unregister(list_write, name);
1497 EXPORT int plugin_unregister_flush(const char *name) {
1498 plugin_ctx_t ctx = plugin_get_ctx();
1500 if (ctx.flush_interval != 0) {
1503 flush_name = plugin_flush_callback_name(name);
1504 if (flush_name != NULL) {
1505 plugin_unregister_read(flush_name);
1510 return plugin_unregister(list_flush, name);
1513 EXPORT int plugin_unregister_missing(const char *name) {
1514 return plugin_unregister(list_missing, name);
1517 EXPORT int plugin_unregister_shutdown(const char *name) {
1518 return plugin_unregister(list_shutdown, name);
1521 EXPORT int plugin_unregister_data_set(const char *name) {
1524 if (data_sets == NULL)
1527 if (c_avl_remove(data_sets, name, NULL, (void *)&ds) != 0)
1534 } /* int plugin_unregister_data_set */
1536 EXPORT int plugin_unregister_log(const char *name) {
1537 return plugin_unregister(list_log, name);
1540 EXPORT int plugin_unregister_notification(const char *name) {
1541 return plugin_unregister(list_notification, name);
1544 EXPORT int plugin_init_all(void) {
1545 char const *chain_name;
1550 /* Init the value cache */
1553 if (IS_TRUE(global_option_get("CollectInternalStats"))) {
1554 record_statistics = true;
1555 plugin_register_read("collectd", plugin_update_internal_statistics);
1558 chain_name = global_option_get("PreCacheChain");
1559 pre_cache_chain = fc_chain_get_by_name(chain_name);
1561 chain_name = global_option_get("PostCacheChain");
1562 post_cache_chain = fc_chain_get_by_name(chain_name);
1564 write_limit_high = global_option_get_long("WriteQueueLimitHigh",
1566 if (write_limit_high < 0) {
1567 ERROR("WriteQueueLimitHigh must be positive or zero.");
1568 write_limit_high = 0;
1572 global_option_get_long("WriteQueueLimitLow",
1573 /* default = */ write_limit_high / 2);
1574 if (write_limit_low < 0) {
1575 ERROR("WriteQueueLimitLow must be positive or zero.");
1576 write_limit_low = write_limit_high / 2;
1577 } else if (write_limit_low > write_limit_high) {
1578 ERROR("WriteQueueLimitLow must not be larger than "
1579 "WriteQueueLimitHigh.");
1580 write_limit_low = write_limit_high;
1583 write_threads_num = global_option_get_long("WriteThreads",
1585 if (write_threads_num < 1) {
1586 ERROR("WriteThreads must be positive.");
1587 write_threads_num = 5;
1590 if ((list_init == NULL) && (read_heap == NULL))
1593 /* Calling all init callbacks before checking if read callbacks
1594 * are available allows the init callbacks to register the read
1596 le = llist_head(list_init);
1597 while (le != NULL) {
1598 callback_func_t *cf;
1599 plugin_init_cb callback;
1600 plugin_ctx_t old_ctx;
1603 old_ctx = plugin_set_ctx(cf->cf_ctx);
1604 callback = cf->cf_callback;
1605 status = (*callback)();
1606 plugin_set_ctx(old_ctx);
1609 ERROR("Initialization of plugin `%s' "
1610 "failed with status %i. "
1611 "Plugin will be unloaded.",
1613 /* Plugins that register read callbacks from the init
1614 * callback should take care of appropriate error
1615 * handling themselves. */
1616 /* FIXME: Unload _all_ functions */
1617 plugin_unregister_read(le->key);
1624 start_write_threads((size_t)write_threads_num);
1627 global_option_get_time("MaxReadInterval", DEFAULT_MAX_READ_INTERVAL);
1629 /* Start read-threads */
1630 if (read_heap != NULL) {
1634 rt = global_option_get("ReadThreads");
1637 start_read_threads((num > 0) ? ((size_t)num) : 5);
1640 } /* void plugin_init_all */
1642 /* TODO: Rename this function. */
1643 EXPORT void plugin_read_all(void) {
1647 } /* void plugin_read_all */
1649 /* Read function called when the `-T' command line argument is given. */
1650 EXPORT int plugin_read_all_once(void) {
1652 int return_status = 0;
1654 if (read_heap == NULL) {
1655 NOTICE("No read-functions are registered.");
1661 plugin_ctx_t old_ctx;
1663 rf = c_heap_get_root(read_heap);
1667 old_ctx = plugin_set_ctx(rf->rf_ctx);
1669 if (rf->rf_type == RF_SIMPLE) {
1670 int (*callback)(void);
1672 callback = rf->rf_callback;
1673 status = (*callback)();
1675 plugin_read_cb callback;
1677 callback = rf->rf_callback;
1678 status = (*callback)(&rf->rf_udata);
1681 plugin_set_ctx(old_ctx);
1684 NOTICE("read-function of plugin `%s' failed.", rf->rf_name);
1689 destroy_callback((void *)rf);
1692 return return_status;
1693 } /* int plugin_read_all_once */
1695 EXPORT int plugin_write(const char *plugin, /* {{{ */
1696 const data_set_t *ds, const value_list_t *vl) {
1703 if (list_write == NULL)
1707 ds = plugin_get_ds(vl->type);
1709 ERROR("plugin_write: Unable to lookup type `%s'.", vl->type);
1714 if (plugin == NULL) {
1718 le = llist_head(list_write);
1719 while (le != NULL) {
1720 callback_func_t *cf = le->value;
1721 plugin_write_cb callback;
1723 /* Keep the read plugin's interval and flush information but update the
1725 plugin_ctx_t old_ctx = plugin_get_ctx();
1726 plugin_ctx_t ctx = old_ctx;
1727 ctx.name = cf->cf_ctx.name;
1728 plugin_set_ctx(ctx);
1730 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1731 callback = cf->cf_callback;
1732 status = (*callback)(ds, vl, &cf->cf_udata);
1738 plugin_set_ctx(old_ctx);
1742 if ((success == 0) && (failure != 0))
1746 } else /* plugin != NULL */
1748 callback_func_t *cf;
1749 plugin_write_cb callback;
1751 le = llist_head(list_write);
1752 while (le != NULL) {
1753 if (strcasecmp(plugin, le->key) == 0)
1764 /* do not switch plugin context; rather keep the context (interval)
1765 * information of the calling read plugin */
1767 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1768 callback = cf->cf_callback;
1769 status = (*callback)(ds, vl, &cf->cf_udata);
1773 } /* }}} int plugin_write */
1775 EXPORT int plugin_flush(const char *plugin, cdtime_t timeout,
1776 const char *identifier) {
1779 if (list_flush == NULL)
1782 le = llist_head(list_flush);
1783 while (le != NULL) {
1784 callback_func_t *cf;
1785 plugin_flush_cb callback;
1786 plugin_ctx_t old_ctx;
1788 if ((plugin != NULL) && (strcmp(plugin, le->key) != 0)) {
1794 old_ctx = plugin_set_ctx(cf->cf_ctx);
1795 callback = cf->cf_callback;
1797 (*callback)(timeout, identifier, &cf->cf_udata);
1799 plugin_set_ctx(old_ctx);
1804 } /* int plugin_flush */
1806 EXPORT int plugin_shutdown_all(void) {
1808 int ret = 0; // Assume success.
1810 destroy_all_callbacks(&list_init);
1812 stop_read_threads();
1814 pthread_mutex_lock(&read_lock);
1815 llist_destroy(read_list);
1817 pthread_mutex_unlock(&read_lock);
1819 destroy_read_heap();
1821 /* blocks until all write threads have shut down. */
1822 stop_write_threads();
1824 /* ask all plugins to write out the state they kept. */
1825 plugin_flush(/* plugin = */ NULL,
1827 /* identifier = */ NULL);
1830 if (list_shutdown != NULL)
1831 le = llist_head(list_shutdown);
1833 while (le != NULL) {
1834 callback_func_t *cf;
1835 plugin_shutdown_cb callback;
1836 plugin_ctx_t old_ctx;
1839 old_ctx = plugin_set_ctx(cf->cf_ctx);
1840 callback = cf->cf_callback;
1842 /* Advance the pointer before calling the callback allows
1843 * shutdown functions to unregister themselves. If done the
1844 * other way around the memory `le' points to will be freed
1845 * after callback returns. */
1848 if ((*callback)() != 0)
1851 plugin_set_ctx(old_ctx);
1854 /* Write plugins which use the `user_data' pointer usually need the
1855 * same data available to the flush callback. If this is the case, set
1856 * the free_function to NULL when registering the flush callback and to
1857 * the real free function when registering the write callback. This way
1858 * the data isn't freed twice. */
1859 destroy_all_callbacks(&list_flush);
1860 destroy_all_callbacks(&list_missing);
1861 destroy_all_callbacks(&list_write);
1863 destroy_all_callbacks(&list_notification);
1864 destroy_all_callbacks(&list_shutdown);
1865 destroy_all_callbacks(&list_log);
1867 plugin_free_loaded();
1868 plugin_free_data_sets();
1870 } /* void plugin_shutdown_all */
1872 EXPORT int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1874 if (list_missing == NULL)
1877 llentry_t *le = llist_head(list_missing);
1878 while (le != NULL) {
1879 callback_func_t *cf = le->value;
1880 plugin_ctx_t old_ctx = plugin_set_ctx(cf->cf_ctx);
1881 plugin_missing_cb callback = cf->cf_callback;
1883 int status = (*callback)(vl, &cf->cf_udata);
1884 plugin_set_ctx(old_ctx);
1887 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1888 "failed with status %i.",
1899 } /* int }}} plugin_dispatch_missing */
1901 static int plugin_dispatch_values_internal(value_list_t *vl) {
1903 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1905 bool free_meta_data = false;
1909 /* These fields are initialized by plugin_value_list_clone() if needed: */
1910 assert(vl->host[0] != 0);
1911 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1912 assert(vl->interval != 0);
1914 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1915 ERROR("plugin_dispatch_values: Invalid value list "
1921 /* Free meta data only if the calling function didn't specify any. In
1922 * this case matches and targets may add some and the calling function
1923 * may not expect (and therefore free) that data. */
1924 if (vl->meta == NULL)
1925 free_meta_data = true;
1927 if (list_write == NULL)
1928 c_complain_once(LOG_WARNING, &no_write_complaint,
1929 "plugin_dispatch_values: No write callback has been "
1930 "registered. Please load at least one output plugin, "
1931 "if you want the collected data to be stored.");
1933 if (data_sets == NULL) {
1934 ERROR("plugin_dispatch_values: No data sets registered. "
1935 "Could the types database be read? Check "
1936 "your `TypesDB' setting!");
1940 data_set_t *ds = NULL;
1941 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1942 char ident[6 * DATA_MAX_NAME_LEN];
1944 FORMAT_VL(ident, sizeof(ident), vl);
1945 INFO("plugin_dispatch_values: Dataset not found: %s "
1946 "(from \"%s\"), check your types.db!",
1951 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1953 "plugin = %s; plugin_instance = %s; "
1954 "type = %s; type_instance = %s;",
1955 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1956 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1959 assert(0 == strcmp(ds->type, vl->type));
1961 if (0 != strcmp(ds->type, vl->type))
1962 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1963 ds->type, vl->type);
1967 assert(ds->ds_num == vl->values_len);
1969 if (ds->ds_num != vl->values_len) {
1970 ERROR("plugin_dispatch_values: ds->type = %s: "
1971 "(ds->ds_num = %" PRIsz ") != "
1972 "(vl->values_len = %" PRIsz ")",
1973 ds->type, ds->ds_num, vl->values_len);
1978 escape_slashes(vl->host, sizeof(vl->host));
1979 escape_slashes(vl->plugin, sizeof(vl->plugin));
1980 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
1981 escape_slashes(vl->type, sizeof(vl->type));
1982 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
1984 if (pre_cache_chain != NULL) {
1985 status = fc_process_chain(ds, vl, pre_cache_chain);
1987 WARNING("plugin_dispatch_values: Running the "
1988 "pre-cache chain failed with "
1991 } else if (status == FC_TARGET_STOP)
1995 /* Update the value cache */
1998 if (post_cache_chain != NULL) {
1999 status = fc_process_chain(ds, vl, post_cache_chain);
2001 WARNING("plugin_dispatch_values: Running the "
2002 "post-cache chain failed with "
2007 fc_default_action(ds, vl);
2009 if ((free_meta_data == true) && (vl->meta != NULL)) {
2010 meta_data_destroy(vl->meta);
2015 } /* int plugin_dispatch_values_internal */
2017 static double get_drop_probability(void) /* {{{ */
2023 pthread_mutex_lock(&write_lock);
2024 wql = write_queue_length;
2025 pthread_mutex_unlock(&write_lock);
2027 if (wql < write_limit_low)
2029 if (wql >= write_limit_high)
2032 pos = 1 + wql - write_limit_low;
2033 size = 1 + write_limit_high - write_limit_low;
2035 return (double)pos / (double)size;
2036 } /* }}} double get_drop_probability */
2038 static bool check_drop_value(void) /* {{{ */
2040 static cdtime_t last_message_time;
2041 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2047 if (write_limit_high == 0)
2050 p = get_drop_probability();
2054 status = pthread_mutex_trylock(&last_message_lock);
2059 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2060 last_message_time = now;
2061 ERROR("plugin_dispatch_values: Low water mark "
2062 "reached. Dropping %.0f%% of metrics.",
2065 pthread_mutex_unlock(&last_message_lock);
2076 } /* }}} bool check_drop_value */
2078 EXPORT int plugin_dispatch_values(value_list_t const *vl) {
2081 if (check_drop_value()) {
2082 if (record_statistics) {
2083 pthread_mutex_lock(&statistics_lock);
2084 stats_values_dropped++;
2085 pthread_mutex_unlock(&statistics_lock);
2090 status = plugin_write_enqueue(vl);
2092 ERROR("plugin_dispatch_values: plugin_write_enqueue failed with status %i "
2094 status, STRERROR(status));
2101 __attribute__((sentinel)) int
2102 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2103 bool store_percentage, int store_type, ...) {
2109 if (check_drop_value()) {
2110 if (record_statistics) {
2111 pthread_mutex_lock(&statistics_lock);
2112 stats_values_dropped++;
2113 pthread_mutex_unlock(&statistics_lock);
2118 assert(template->values_len == 1);
2120 /* Calculate sum for Gauge to calculate percent if needed */
2121 if (DS_TYPE_GAUGE == store_type) {
2122 va_start(ap, store_type);
2127 name = va_arg(ap, char const *);
2131 value = va_arg(ap, gauge_t);
2138 vl = plugin_value_list_clone(template);
2139 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2140 if (store_percentage)
2141 sstrncpy(vl->type, "percent", sizeof(vl->type));
2143 va_start(ap, store_type);
2148 /* Set the type instance. */
2149 name = va_arg(ap, char const *);
2152 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2154 /* Set the value. */
2155 switch (store_type) {
2157 vl->values[0].gauge = va_arg(ap, gauge_t);
2158 if (store_percentage)
2159 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2161 case DS_TYPE_ABSOLUTE:
2162 vl->values[0].absolute = va_arg(ap, absolute_t);
2164 case DS_TYPE_COUNTER:
2165 vl->values[0].counter = va_arg(ap, counter_t);
2167 case DS_TYPE_DERIVE:
2168 vl->values[0].derive = va_arg(ap, derive_t);
2171 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2175 status = plugin_write_enqueue(vl);
2181 plugin_value_list_free(vl);
2183 } /* }}} int plugin_dispatch_multivalue */
2185 EXPORT int plugin_dispatch_notification(const notification_t *notif) {
2187 /* Possible TODO: Add flap detection here */
2189 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2190 "time = %.3f; host = %s;",
2191 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2194 /* Nobody cares for notifications */
2195 if (list_notification == NULL)
2198 le = llist_head(list_notification);
2199 while (le != NULL) {
2200 callback_func_t *cf;
2201 plugin_notification_cb callback;
2204 /* do not switch plugin context; rather keep the context
2205 * (interval) information of the calling plugin */
2208 callback = cf->cf_callback;
2209 status = (*callback)(notif, &cf->cf_udata);
2211 WARNING("plugin_dispatch_notification: Notification "
2212 "callback %s returned %i.",
2220 } /* int plugin_dispatch_notification */
2222 EXPORT void plugin_log(int level, const char *format, ...) {
2228 if (level >= LOG_DEBUG)
2232 va_start(ap, format);
2233 vsnprintf(msg, sizeof(msg), format, ap);
2234 msg[sizeof(msg) - 1] = '\0';
2237 if (list_log == NULL) {
2238 fprintf(stderr, "%s\n", msg);
2242 le = llist_head(list_log);
2243 while (le != NULL) {
2244 callback_func_t *cf;
2245 plugin_log_cb callback;
2248 callback = cf->cf_callback;
2250 /* do not switch plugin context; rather keep the context
2251 * (interval) information of the calling plugin */
2253 (*callback)(level, msg, &cf->cf_udata);
2257 } /* void plugin_log */
2259 void daemon_log(int level, const char *format, ...) {
2260 char msg[1024] = ""; // Size inherits from plugin_log()
2262 char const *name = plugin_get_ctx().name;
2267 va_start(ap, format);
2268 vsnprintf(msg, sizeof(msg), format, ap);
2271 plugin_log(level, "%s plugin: %s", name, msg);
2272 } /* void daemon_log */
2274 int parse_log_severity(const char *severity) {
2277 if ((0 == strcasecmp(severity, "emerg")) ||
2278 (0 == strcasecmp(severity, "alert")) ||
2279 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2280 log_level = LOG_ERR;
2281 else if (0 == strcasecmp(severity, "warning"))
2282 log_level = LOG_WARNING;
2283 else if (0 == strcasecmp(severity, "notice"))
2284 log_level = LOG_NOTICE;
2285 else if (0 == strcasecmp(severity, "info"))
2286 log_level = LOG_INFO;
2288 else if (0 == strcasecmp(severity, "debug"))
2289 log_level = LOG_DEBUG;
2290 #endif /* COLLECT_DEBUG */
2293 } /* int parse_log_severity */
2295 EXPORT int parse_notif_severity(const char *severity) {
2296 int notif_severity = -1;
2298 if (strcasecmp(severity, "FAILURE") == 0)
2299 notif_severity = NOTIF_FAILURE;
2300 else if (strcmp(severity, "OKAY") == 0)
2301 notif_severity = NOTIF_OKAY;
2302 else if ((strcmp(severity, "WARNING") == 0) ||
2303 (strcmp(severity, "WARN") == 0))
2304 notif_severity = NOTIF_WARNING;
2306 return notif_severity;
2307 } /* int parse_notif_severity */
2309 EXPORT const data_set_t *plugin_get_ds(const char *name) {
2312 if (data_sets == NULL) {
2313 P_ERROR("plugin_get_ds: No data sets are defined yet.");
2317 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2318 DEBUG("No such dataset registered: %s", name);
2323 } /* data_set_t *plugin_get_ds */
2325 static int plugin_notification_meta_add(notification_t *n, const char *name,
2326 enum notification_meta_type_e type,
2327 const void *value) {
2328 notification_meta_t *meta;
2329 notification_meta_t *tail;
2331 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2332 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2336 meta = calloc(1, sizeof(*meta));
2338 ERROR("plugin_notification_meta_add: calloc failed.");
2342 sstrncpy(meta->name, name, sizeof(meta->name));
2346 case NM_TYPE_STRING: {
2347 meta->nm_value.nm_string = strdup((const char *)value);
2348 if (meta->nm_value.nm_string == NULL) {
2349 ERROR("plugin_notification_meta_add: strdup failed.");
2355 case NM_TYPE_SIGNED_INT: {
2356 meta->nm_value.nm_signed_int = *((int64_t *)value);
2359 case NM_TYPE_UNSIGNED_INT: {
2360 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2363 case NM_TYPE_DOUBLE: {
2364 meta->nm_value.nm_double = *((double *)value);
2367 case NM_TYPE_BOOLEAN: {
2368 meta->nm_value.nm_boolean = *((bool *)value);
2372 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2376 } /* switch (type) */
2380 while ((tail != NULL) && (tail->next != NULL))
2389 } /* int plugin_notification_meta_add */
2391 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2392 const char *value) {
2393 return plugin_notification_meta_add(n, name, NM_TYPE_STRING, value);
2396 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2398 return plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value);
2401 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2404 return plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value);
2407 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2409 return plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value);
2412 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2414 return plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value);
2417 int plugin_notification_meta_copy(notification_t *dst,
2418 const notification_t *src) {
2419 assert(dst != NULL);
2420 assert(src != NULL);
2422 assert((src->meta == NULL) || (src->meta != dst->meta));
2424 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2425 if (meta->type == NM_TYPE_STRING)
2426 plugin_notification_meta_add_string(dst, meta->name,
2427 meta->nm_value.nm_string);
2428 else if (meta->type == NM_TYPE_SIGNED_INT)
2429 plugin_notification_meta_add_signed_int(dst, meta->name,
2430 meta->nm_value.nm_signed_int);
2431 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2432 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2433 meta->nm_value.nm_unsigned_int);
2434 else if (meta->type == NM_TYPE_DOUBLE)
2435 plugin_notification_meta_add_double(dst, meta->name,
2436 meta->nm_value.nm_double);
2437 else if (meta->type == NM_TYPE_BOOLEAN)
2438 plugin_notification_meta_add_boolean(dst, meta->name,
2439 meta->nm_value.nm_boolean);
2443 } /* int plugin_notification_meta_copy */
2445 int plugin_notification_meta_free(notification_meta_t *n) {
2446 notification_meta_t *this;
2447 notification_meta_t *next;
2450 ERROR("plugin_notification_meta_free: n == NULL!");
2455 while (this != NULL) {
2458 if (this->type == NM_TYPE_STRING) {
2459 /* Assign to a temporary variable to work around nm_string's const
2461 void *tmp = (void *)this->nm_value.nm_string;
2464 this->nm_value.nm_string = NULL;
2472 } /* int plugin_notification_meta_free */
2474 static void plugin_ctx_destructor(void *ctx) {
2476 } /* void plugin_ctx_destructor */
2478 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2480 static plugin_ctx_t *plugin_ctx_create(void) {
2483 ctx = malloc(sizeof(*ctx));
2485 ERROR("Failed to allocate plugin context: %s", STRERRNO);
2490 assert(plugin_ctx_key_initialized);
2491 pthread_setspecific(plugin_ctx_key, ctx);
2492 DEBUG("Created new plugin context.");
2494 } /* int plugin_ctx_create */
2496 EXPORT void plugin_init_ctx(void) {
2497 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2498 plugin_ctx_key_initialized = true;
2499 } /* void plugin_init_ctx */
2501 EXPORT plugin_ctx_t plugin_get_ctx(void) {
2504 assert(plugin_ctx_key_initialized);
2505 ctx = pthread_getspecific(plugin_ctx_key);
2508 ctx = plugin_ctx_create();
2509 /* this must no happen -- exit() instead? */
2515 } /* plugin_ctx_t plugin_get_ctx */
2517 EXPORT plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2521 assert(plugin_ctx_key_initialized);
2522 c = pthread_getspecific(plugin_ctx_key);
2525 c = plugin_ctx_create();
2526 /* this must no happen -- exit() instead? */
2535 } /* void plugin_set_ctx */
2537 EXPORT cdtime_t plugin_get_interval(void) {
2540 interval = plugin_get_ctx().interval;
2544 P_ERROR("plugin_get_interval: Unable to determine Interval from context.");
2546 return cf_get_default_interval();
2547 } /* cdtime_t plugin_get_interval */
2551 void *(*start_routine)(void *);
2555 static void *plugin_thread_start(void *arg) {
2556 plugin_thread_t *plugin_thread = arg;
2558 void *(*start_routine)(void *) = plugin_thread->start_routine;
2559 void *plugin_arg = plugin_thread->arg;
2561 plugin_set_ctx(plugin_thread->ctx);
2563 sfree(plugin_thread);
2565 return start_routine(plugin_arg);
2566 } /* void *plugin_thread_start */
2568 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2569 void *(*start_routine)(void *), void *arg,
2571 plugin_thread_t *plugin_thread;
2573 plugin_thread = malloc(sizeof(*plugin_thread));
2574 if (plugin_thread == NULL)
2577 plugin_thread->ctx = plugin_get_ctx();
2578 plugin_thread->start_routine = start_routine;
2579 plugin_thread->arg = arg;
2581 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2583 sfree(plugin_thread);
2588 set_thread_name(*thread, name);
2591 } /* int plugin_thread_create */