2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2014 Florian octo Forster
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian Harl <sh at tokkee.org>
28 /* _GNU_SOURCE is needed in Linux to use pthread_setname_np */
34 #include "configfile.h"
35 #include "filter_chain.h"
37 #include "utils_avltree.h"
38 #include "utils_cache.h"
39 #include "utils_complain.h"
40 #include "utils_heap.h"
41 #include "utils_llist.h"
42 #include "utils_random.h"
43 #include "utils_time.h"
46 #include <pthread_np.h> /* for pthread_set_name_np(3) */
54 struct callback_func_s {
59 typedef struct callback_func_s callback_func_t;
63 #define RF_REMOVE 65535
65 /* `read_func_t' "inherits" from `callback_func_t'.
66 * The `rf_super' member MUST be the first one in this structure! */
67 #define rf_callback rf_super.cf_callback
68 #define rf_udata rf_super.cf_udata
69 #define rf_ctx rf_super.cf_ctx
70 callback_func_t rf_super;
71 char rf_group[DATA_MAX_NAME_LEN];
75 cdtime_t rf_effective_interval;
76 cdtime_t rf_next_read;
78 typedef struct read_func_s read_func_t;
81 typedef struct write_queue_s write_queue_t;
82 struct write_queue_s {
88 struct flush_callback_s {
92 typedef struct flush_callback_s flush_callback_t;
97 static c_avl_tree_t *plugins_loaded = NULL;
99 static llist_t *list_init;
100 static llist_t *list_write;
101 static llist_t *list_flush;
102 static llist_t *list_missing;
103 static llist_t *list_shutdown;
104 static llist_t *list_log;
105 static llist_t *list_notification;
107 static fc_chain_t *pre_cache_chain = NULL;
108 static fc_chain_t *post_cache_chain = NULL;
110 static c_avl_tree_t *data_sets;
112 static char *plugindir = NULL;
114 #ifndef DEFAULT_MAX_READ_INTERVAL
115 #define DEFAULT_MAX_READ_INTERVAL TIME_T_TO_CDTIME_T_STATIC(86400)
117 static c_heap_t *read_heap = NULL;
118 static llist_t *read_list;
119 static int read_loop = 1;
120 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
121 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
122 static pthread_t *read_threads = NULL;
123 static size_t read_threads_num = 0;
124 static cdtime_t max_read_interval = DEFAULT_MAX_READ_INTERVAL;
126 static write_queue_t *write_queue_head;
127 static write_queue_t *write_queue_tail;
128 static long write_queue_length = 0;
129 static _Bool write_loop = 1;
130 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
131 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
132 static pthread_t *write_threads = NULL;
133 static size_t write_threads_num = 0;
135 static pthread_key_t plugin_ctx_key;
136 static _Bool plugin_ctx_key_initialized = 0;
138 static long write_limit_high = 0;
139 static long write_limit_low = 0;
141 static derive_t stats_values_dropped = 0;
142 static _Bool record_statistics = 0;
147 static int plugin_dispatch_values_internal(value_list_t *vl);
149 static const char *plugin_get_dir(void) {
150 if (plugindir == NULL)
156 static int plugin_update_internal_statistics(void) { /* {{{ */
157 gauge_t copy_write_queue_length = (gauge_t)write_queue_length;
159 /* Initialize `vl' */
160 value_list_t vl = VALUE_LIST_INIT;
161 sstrncpy(vl.plugin, "collectd", sizeof(vl.plugin));
162 vl.interval = plugin_get_interval();
165 sstrncpy(vl.plugin_instance, "write_queue", sizeof(vl.plugin_instance));
167 /* Write queue : queue length */
168 vl.values = &(value_t){.gauge = copy_write_queue_length};
170 sstrncpy(vl.type, "queue_length", sizeof(vl.type));
171 vl.type_instance[0] = 0;
172 plugin_dispatch_values(&vl);
174 /* Write queue : Values dropped (queue length > low limit) */
175 vl.values = &(value_t){.gauge = (gauge_t)stats_values_dropped};
177 sstrncpy(vl.type, "derive", sizeof(vl.type));
178 sstrncpy(vl.type_instance, "dropped", sizeof(vl.type_instance));
179 plugin_dispatch_values(&vl);
182 sstrncpy(vl.plugin_instance, "cache", sizeof(vl.plugin_instance));
184 /* Cache : Nb entry in cache tree */
185 vl.values = &(value_t){.gauge = (gauge_t)uc_get_size()};
187 sstrncpy(vl.type, "cache_size", sizeof(vl.type));
188 vl.type_instance[0] = 0;
189 plugin_dispatch_values(&vl);
192 } /* }}} int plugin_update_internal_statistics */
194 static void free_userdata(user_data_t const *ud) /* {{{ */
199 if ((ud->data != NULL) && (ud->free_func != NULL)) {
200 ud->free_func(ud->data);
202 } /* }}} void free_userdata */
204 static void destroy_callback(callback_func_t *cf) /* {{{ */
208 free_userdata(&cf->cf_udata);
210 } /* }}} void destroy_callback */
212 static void destroy_all_callbacks(llist_t **list) /* {{{ */
219 le = llist_head(*list);
226 destroy_callback(le->value);
232 llist_destroy(*list);
234 } /* }}} void destroy_all_callbacks */
236 static void destroy_read_heap(void) /* {{{ */
238 if (read_heap == NULL)
244 rf = c_heap_get_root(read_heap);
248 destroy_callback((callback_func_t *)rf);
251 c_heap_destroy(read_heap);
253 } /* }}} void destroy_read_heap */
255 static int register_callback(llist_t **list, /* {{{ */
256 const char *name, callback_func_t *cf) {
261 *list = llist_create();
263 ERROR("plugin: register_callback: "
264 "llist_create failed.");
265 destroy_callback(cf);
272 ERROR("plugin: register_callback: strdup failed.");
273 destroy_callback(cf);
277 le = llist_search(*list, name);
279 le = llentry_create(key, cf);
281 ERROR("plugin: register_callback: "
282 "llentry_create failed.");
284 destroy_callback(cf);
288 llist_append(*list, le);
290 callback_func_t *old_cf;
295 WARNING("plugin: register_callback: "
296 "a callback named `%s' already exists - "
297 "overwriting the old entry!",
300 destroy_callback(old_cf);
305 } /* }}} int register_callback */
307 static void log_list_callbacks(llist_t **list, /* {{{ */
308 const char *comment) {
316 n = llist_size(*list);
318 INFO("%s [none]", comment);
322 keys = calloc(n, sizeof(char *));
325 ERROR("%s: failed to allocate memory for list of callbacks", comment);
330 for (le = llist_head(*list), i = 0, len = 0; le != NULL; le = le->next, i++) {
332 len += strlen(le->key) + 6;
334 str = malloc(len + 10);
336 ERROR("%s: failed to allocate memory for list of callbacks", comment);
339 strjoin(str, len, keys, n, "', '");
340 INFO("%s ['%s']", comment, str);
344 } /* }}} void log_list_callbacks */
346 static int create_register_callback(llist_t **list, /* {{{ */
347 const char *name, void *callback,
348 user_data_t const *ud) {
351 cf = calloc(1, sizeof(*cf));
354 ERROR("plugin: create_register_callback: calloc failed.");
358 cf->cf_callback = callback;
360 cf->cf_udata.data = NULL;
361 cf->cf_udata.free_func = NULL;
366 cf->cf_ctx = plugin_get_ctx();
368 return register_callback(list, name, cf);
369 } /* }}} int create_register_callback */
371 static int plugin_unregister(llist_t *list, const char *name) /* {{{ */
378 e = llist_search(list, name);
382 llist_remove(list, e);
385 destroy_callback(e->value);
390 } /* }}} int plugin_unregister */
393 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
394 * object, but it will bitch about a shared object not having a
395 * ``module_register'' symbol..
397 static int plugin_load_file(const char *file, _Bool global) {
398 void (*reg_handle)(void);
400 int flags = RTLD_NOW;
402 flags |= RTLD_GLOBAL;
404 void *dlh = dlopen(file, flags);
407 char errbuf[1024] = "";
409 snprintf(errbuf, sizeof(errbuf),
410 "dlopen (\"%s\") failed: %s. "
411 "The most common cause for this problem is "
412 "missing dependencies. Use ldd(1) to check "
413 "the dependencies of the plugin "
418 /* Make sure this is printed to STDERR in any case, but also
419 * make sure it's printed only once. */
420 if (list_log != NULL)
421 fprintf(stderr, "ERROR: %s\n", errbuf);
426 reg_handle = (void (*)(void))dlsym(dlh, "module_register");
427 if (reg_handle == NULL) {
428 WARNING("Couldn't find symbol \"module_register\" in \"%s\": %s\n", file,
439 static void *plugin_read_thread(void __attribute__((unused)) * args) {
440 while (read_loop != 0) {
442 plugin_ctx_t old_ctx;
450 /* Get the read function that needs to be read next.
451 * We don't need to hold "read_lock" for the heap, but we need
452 * to call c_heap_get_root() and pthread_cond_wait() in the
453 * same protected block. */
454 pthread_mutex_lock(&read_lock);
455 rf = c_heap_get_root(read_heap);
457 pthread_cond_wait(&read_cond, &read_lock);
458 pthread_mutex_unlock(&read_lock);
461 pthread_mutex_unlock(&read_lock);
463 if (rf->rf_interval == 0) {
464 /* this should not happen, because the interval is set
465 * for each plugin when loading it
466 * XXX: issue a warning? */
467 rf->rf_interval = plugin_get_interval();
468 rf->rf_effective_interval = rf->rf_interval;
470 rf->rf_next_read = cdtime();
473 /* sleep until this entry is due,
474 * using pthread_cond_timedwait */
475 pthread_mutex_lock(&read_lock);
476 /* In pthread_cond_timedwait, spurious wakeups are possible
477 * (and really happen, at least on NetBSD with > 1 CPU), thus
478 * we need to re-evaluate the condition every time
479 * pthread_cond_timedwait returns. */
481 while ((read_loop != 0) && (cdtime() < rf->rf_next_read) && rc == 0) {
482 rc = pthread_cond_timedwait(&read_cond, &read_lock,
483 &CDTIME_T_TO_TIMESPEC(rf->rf_next_read));
486 /* Must hold `read_lock' when accessing `rf->rf_type'. */
487 rf_type = rf->rf_type;
488 pthread_mutex_unlock(&read_lock);
490 /* Check if we're supposed to stop.. This may have interrupted
492 if (read_loop == 0) {
493 /* Insert `rf' again, so it can be free'd correctly */
494 c_heap_insert(read_heap, rf);
498 /* The entry has been marked for deletion. The linked list
499 * entry has already been removed by `plugin_unregister_read'.
500 * All we have to do here is free the `read_func_t' and
502 if (rf_type == RF_REMOVE) {
503 DEBUG("plugin_read_thread: Destroying the `%s' "
507 destroy_callback((callback_func_t *)rf);
512 DEBUG("plugin_read_thread: Handling `%s'.", rf->rf_name);
516 old_ctx = plugin_set_ctx(rf->rf_ctx);
518 if (rf_type == RF_SIMPLE) {
519 int (*callback)(void);
521 callback = rf->rf_callback;
522 status = (*callback)();
524 plugin_read_cb callback;
526 assert(rf_type == RF_COMPLEX);
528 callback = rf->rf_callback;
529 status = (*callback)(&rf->rf_udata);
532 plugin_set_ctx(old_ctx);
534 /* If the function signals failure, we will increase the
535 * intervals in which it will be called. */
537 rf->rf_effective_interval *= 2;
538 if (rf->rf_effective_interval > max_read_interval)
539 rf->rf_effective_interval = max_read_interval;
541 NOTICE("read-function of plugin `%s' failed. "
542 "Will suspend it for %.3f seconds.",
543 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
545 /* Success: Restore the interval, if it was changed. */
546 rf->rf_effective_interval = rf->rf_interval;
549 /* update the ``next read due'' field */
552 /* calculate the time spent in the read function */
553 elapsed = (now - start);
555 if (elapsed > rf->rf_effective_interval)
557 "plugin_read_thread: read-function of the `%s' plugin took %.3f "
558 "seconds, which is above its read interval (%.3f seconds). You might "
559 "want to adjust the `Interval' or `ReadThreads' settings.",
560 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed),
561 CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
563 DEBUG("plugin_read_thread: read-function of the `%s' plugin took "
565 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed));
567 DEBUG("plugin_read_thread: Effective interval of the "
568 "`%s' plugin is %.3f seconds.",
569 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
571 /* Calculate the next (absolute) time at which this function
572 * should be called. */
573 rf->rf_next_read += rf->rf_effective_interval;
575 /* Check, if `rf_next_read' is in the past. */
576 if (rf->rf_next_read < now) {
577 /* `rf_next_read' is in the past. Insert `now'
578 * so this value doesn't trail off into the
580 rf->rf_next_read = now;
583 DEBUG("plugin_read_thread: Next read of the `%s' plugin at %.3f.",
584 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_next_read));
586 /* Re-insert this read function into the heap again. */
587 c_heap_insert(read_heap, rf);
588 } /* while (read_loop) */
592 } /* void *plugin_read_thread */
594 #ifdef PTHREAD_MAX_NAMELEN_NP
595 #define THREAD_NAME_MAX PTHREAD_MAX_NAMELEN_NP
597 #define THREAD_NAME_MAX 16
600 static void set_thread_name(pthread_t tid, char const *name) {
601 #if defined(HAVE_PTHREAD_SETNAME_NP) || defined(HAVE_PTHREAD_SET_NAME_NP)
603 /* glibc limits the length of the name and fails if the passed string
604 * is too long, so we truncate it here. */
605 char n[THREAD_NAME_MAX];
606 if (strlen(name) >= THREAD_NAME_MAX)
607 WARNING("set_thread_name(\"%s\"): name too long", name);
608 sstrncpy(n, name, sizeof(n));
610 #if defined(HAVE_PTHREAD_SETNAME_NP)
611 int status = pthread_setname_np(tid, n);
613 ERROR("set_thread_name(\"%s\"): %s", n, STRERROR(status));
615 #else /* if defined(HAVE_PTHREAD_SET_NAME_NP) */
616 pthread_set_name_np(tid, n);
622 static void start_read_threads(size_t num) /* {{{ */
624 if (read_threads != NULL)
627 read_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
628 if (read_threads == NULL) {
629 ERROR("plugin: start_read_threads: calloc failed.");
633 read_threads_num = 0;
634 for (size_t i = 0; i < num; i++) {
635 int status = pthread_create(read_threads + read_threads_num,
636 /* attr = */ NULL, plugin_read_thread,
639 ERROR("plugin: start_read_threads: pthread_create failed with status %i "
641 status, STRERROR(status));
645 char name[THREAD_NAME_MAX];
646 snprintf(name, sizeof(name), "reader#%zu", read_threads_num);
647 set_thread_name(read_threads[read_threads_num], name);
651 } /* }}} void start_read_threads */
653 static void stop_read_threads(void) {
654 if (read_threads == NULL)
657 INFO("collectd: Stopping %zu read threads.", read_threads_num);
659 pthread_mutex_lock(&read_lock);
661 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
662 pthread_cond_broadcast(&read_cond);
663 pthread_mutex_unlock(&read_lock);
665 for (size_t i = 0; i < read_threads_num; i++) {
666 if (pthread_join(read_threads[i], NULL) != 0) {
667 ERROR("plugin: stop_read_threads: pthread_join failed.");
669 read_threads[i] = (pthread_t)0;
672 read_threads_num = 0;
673 } /* void stop_read_threads */
675 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
680 meta_data_destroy(vl->meta);
683 } /* }}} void plugin_value_list_free */
685 static value_list_t *
686 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
693 vl = malloc(sizeof(*vl));
696 memcpy(vl, vl_orig, sizeof(*vl));
698 if (vl->host[0] == 0)
699 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
701 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
702 if (vl->values == NULL) {
703 plugin_value_list_free(vl);
706 memcpy(vl->values, vl_orig->values,
707 vl_orig->values_len * sizeof(*vl->values));
709 vl->meta = meta_data_clone(vl->meta);
710 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
711 plugin_value_list_free(vl);
718 /* Fill in the interval from the thread context, if it is zero. */
719 if (vl->interval == 0) {
720 plugin_ctx_t ctx = plugin_get_ctx();
722 if (ctx.interval != 0)
723 vl->interval = ctx.interval;
725 char name[6 * DATA_MAX_NAME_LEN];
726 FORMAT_VL(name, sizeof(name), vl);
727 ERROR("plugin_value_list_clone: Unable to determine "
728 "interval from context for "
729 "value list \"%s\". "
730 "This indicates a broken plugin. "
731 "Please report this problem to the "
732 "collectd mailing list or at "
733 "<http://collectd.org/bugs/>.",
735 vl->interval = cf_get_default_interval();
740 } /* }}} value_list_t *plugin_value_list_clone */
742 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
746 q = malloc(sizeof(*q));
751 q->vl = plugin_value_list_clone(vl);
757 /* Store context of caller (read plugin); otherwise, it would not be
758 * available to the write plugins when actually dispatching the
759 * value-list later on. */
760 q->ctx = plugin_get_ctx();
762 pthread_mutex_lock(&write_lock);
764 if (write_queue_tail == NULL) {
765 write_queue_head = q;
766 write_queue_tail = q;
767 write_queue_length = 1;
769 write_queue_tail->next = q;
770 write_queue_tail = q;
771 write_queue_length += 1;
774 pthread_cond_signal(&write_cond);
775 pthread_mutex_unlock(&write_lock);
778 } /* }}} int plugin_write_enqueue */
780 static value_list_t *plugin_write_dequeue(void) /* {{{ */
785 pthread_mutex_lock(&write_lock);
787 while (write_loop && (write_queue_head == NULL))
788 pthread_cond_wait(&write_cond, &write_lock);
790 if (write_queue_head == NULL) {
791 pthread_mutex_unlock(&write_lock);
795 q = write_queue_head;
796 write_queue_head = q->next;
797 write_queue_length -= 1;
798 if (write_queue_head == NULL) {
799 write_queue_tail = NULL;
800 assert(0 == write_queue_length);
803 pthread_mutex_unlock(&write_lock);
805 (void)plugin_set_ctx(q->ctx);
810 } /* }}} value_list_t *plugin_write_dequeue */
812 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
815 value_list_t *vl = plugin_write_dequeue();
819 plugin_dispatch_values_internal(vl);
821 plugin_value_list_free(vl);
826 } /* }}} void *plugin_write_thread */
828 static void start_write_threads(size_t num) /* {{{ */
830 if (write_threads != NULL)
833 write_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
834 if (write_threads == NULL) {
835 ERROR("plugin: start_write_threads: calloc failed.");
839 write_threads_num = 0;
840 for (size_t i = 0; i < num; i++) {
841 int status = pthread_create(write_threads + write_threads_num,
842 /* attr = */ NULL, plugin_write_thread,
845 ERROR("plugin: start_write_threads: pthread_create failed with status %i "
847 status, STRERROR(status));
851 char name[THREAD_NAME_MAX];
852 snprintf(name, sizeof(name), "writer#%zu", write_threads_num);
853 set_thread_name(write_threads[write_threads_num], name);
857 } /* }}} void start_write_threads */
859 static void stop_write_threads(void) /* {{{ */
864 if (write_threads == NULL)
867 INFO("collectd: Stopping %zu write threads.", write_threads_num);
869 pthread_mutex_lock(&write_lock);
871 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
872 pthread_cond_broadcast(&write_cond);
873 pthread_mutex_unlock(&write_lock);
875 for (i = 0; i < write_threads_num; i++) {
876 if (pthread_join(write_threads[i], NULL) != 0) {
877 ERROR("plugin: stop_write_threads: pthread_join failed.");
879 write_threads[i] = (pthread_t)0;
881 sfree(write_threads);
882 write_threads_num = 0;
884 pthread_mutex_lock(&write_lock);
886 for (q = write_queue_head; q != NULL;) {
887 write_queue_t *q1 = q;
888 plugin_value_list_free(q->vl);
893 write_queue_head = NULL;
894 write_queue_tail = NULL;
895 write_queue_length = 0;
896 pthread_mutex_unlock(&write_lock);
899 WARNING("plugin: %zu value list%s left after shutting down "
900 "the write threads.",
901 i, (i == 1) ? " was" : "s were");
903 } /* }}} void stop_write_threads */
908 void plugin_set_dir(const char *dir) {
916 plugindir = strdup(dir);
917 if (plugindir == NULL)
918 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
921 static _Bool plugin_is_loaded(char const *name) {
924 if (plugins_loaded == NULL)
926 c_avl_create((int (*)(const void *, const void *))strcasecmp);
927 assert(plugins_loaded != NULL);
929 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
933 static int plugin_mark_loaded(char const *name) {
937 name_copy = strdup(name);
938 if (name_copy == NULL)
941 status = c_avl_insert(plugins_loaded,
942 /* key = */ name_copy, /* value = */ NULL);
946 static void plugin_free_loaded(void) {
950 if (plugins_loaded == NULL)
953 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
955 assert(value == NULL);
958 c_avl_destroy(plugins_loaded);
959 plugins_loaded = NULL;
963 int plugin_load(char const *plugin_name, _Bool global) {
966 char filename[BUFSIZE] = "";
967 char typename[BUFSIZE];
973 if (plugin_name == NULL)
976 /* Check if plugin is already loaded and don't do anything in this
978 if (plugin_is_loaded(plugin_name))
981 dir = plugin_get_dir();
985 * XXX: Magic at work:
987 * Some of the language bindings, for example the Python and Perl
988 * plugins, need to be able to export symbols to the scripts they run.
989 * For this to happen, the "Globals" flag needs to be set.
990 * Unfortunately, this technical detail is hard to explain to the
991 * average user and she shouldn't have to worry about this, ideally.
992 * So in order to save everyone's sanity use a different default for a
993 * handful of special plugins. --octo
995 if ((strcasecmp("perl", plugin_name) == 0) ||
996 (strcasecmp("python", plugin_name) == 0))
999 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
1000 * type when matching the filename */
1001 status = snprintf(typename, sizeof(typename), "%s.so", plugin_name);
1002 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
1003 WARNING("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1007 if ((dh = opendir(dir)) == NULL) {
1008 ERROR("plugin_load: opendir (%s) failed: %s", dir, STRERRNO);
1012 while ((de = readdir(dh)) != NULL) {
1013 if (strcasecmp(de->d_name, typename))
1016 status = snprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1017 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1018 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1022 if (lstat(filename, &statbuf) == -1) {
1023 WARNING("plugin_load: stat (\"%s\") failed: %s", filename, STRERRNO);
1025 } else if (!S_ISREG(statbuf.st_mode)) {
1026 /* don't follow symlinks */
1027 WARNING("plugin_load: %s is not a regular file.", filename);
1031 status = plugin_load_file(filename, global);
1034 plugin_mark_loaded(plugin_name);
1036 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1039 ERROR("plugin_load: Load plugin \"%s\" failed with "
1041 plugin_name, status);
1047 if (filename[0] == 0)
1048 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1054 * The `register_*' functions follow
1056 int plugin_register_config(const char *name,
1057 int (*callback)(const char *key, const char *val),
1058 const char **keys, int keys_num) {
1059 cf_register(name, callback, keys, keys_num);
1061 } /* int plugin_register_config */
1063 int plugin_register_complex_config(const char *type,
1064 int (*callback)(oconfig_item_t *)) {
1065 return cf_register_complex(type, callback);
1066 } /* int plugin_register_complex_config */
1068 int plugin_register_init(const char *name, int (*callback)(void)) {
1069 return create_register_callback(&list_init, name, (void *)callback, NULL);
1070 } /* plugin_register_init */
1072 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1073 const read_func_t *rf0;
1074 const read_func_t *rf1;
1079 if (rf0->rf_next_read < rf1->rf_next_read)
1081 else if (rf0->rf_next_read > rf1->rf_next_read)
1085 } /* int plugin_compare_read_func */
1087 /* Add a read function to both, the heap and a linked list. The linked list if
1088 * used to look-up read functions, especially for the remove function. The heap
1089 * is used to determine which plugin to read next. */
1090 static int plugin_insert_read(read_func_t *rf) {
1094 rf->rf_next_read = cdtime();
1095 rf->rf_effective_interval = rf->rf_interval;
1097 pthread_mutex_lock(&read_lock);
1099 if (read_list == NULL) {
1100 read_list = llist_create();
1101 if (read_list == NULL) {
1102 pthread_mutex_unlock(&read_lock);
1103 ERROR("plugin_insert_read: read_list failed.");
1108 if (read_heap == NULL) {
1109 read_heap = c_heap_create(plugin_compare_read_func);
1110 if (read_heap == NULL) {
1111 pthread_mutex_unlock(&read_lock);
1112 ERROR("plugin_insert_read: c_heap_create failed.");
1117 le = llist_search(read_list, rf->rf_name);
1119 pthread_mutex_unlock(&read_lock);
1120 WARNING("The read function \"%s\" is already registered. "
1121 "Check for duplicates in your configuration!",
1126 le = llentry_create(rf->rf_name, rf);
1128 pthread_mutex_unlock(&read_lock);
1129 ERROR("plugin_insert_read: llentry_create failed.");
1133 status = c_heap_insert(read_heap, rf);
1135 pthread_mutex_unlock(&read_lock);
1136 ERROR("plugin_insert_read: c_heap_insert failed.");
1137 llentry_destroy(le);
1141 /* This does not fail. */
1142 llist_append(read_list, le);
1144 /* Wake up all the read threads. */
1145 pthread_cond_broadcast(&read_cond);
1146 pthread_mutex_unlock(&read_lock);
1148 } /* int plugin_insert_read */
1150 int plugin_register_read(const char *name, int (*callback)(void)) {
1154 rf = calloc(1, sizeof(*rf));
1156 ERROR("plugin_register_read: calloc failed.");
1160 rf->rf_callback = (void *)callback;
1161 rf->rf_udata.data = NULL;
1162 rf->rf_udata.free_func = NULL;
1163 rf->rf_ctx = plugin_get_ctx();
1164 rf->rf_group[0] = '\0';
1165 rf->rf_name = strdup(name);
1166 rf->rf_type = RF_SIMPLE;
1167 rf->rf_interval = plugin_get_interval();
1169 status = plugin_insert_read(rf);
1176 } /* int plugin_register_read */
1178 int plugin_register_complex_read(const char *group, const char *name,
1179 plugin_read_cb callback, cdtime_t interval,
1180 user_data_t const *user_data) {
1184 rf = calloc(1, sizeof(*rf));
1186 free_userdata(user_data);
1187 ERROR("plugin_register_complex_read: calloc failed.");
1191 rf->rf_callback = (void *)callback;
1193 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1195 rf->rf_group[0] = '\0';
1196 rf->rf_name = strdup(name);
1197 rf->rf_type = RF_COMPLEX;
1198 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1201 if (user_data == NULL) {
1202 rf->rf_udata.data = NULL;
1203 rf->rf_udata.free_func = NULL;
1205 rf->rf_udata = *user_data;
1208 rf->rf_ctx = plugin_get_ctx();
1210 status = plugin_insert_read(rf);
1212 free_userdata(&rf->rf_udata);
1218 } /* int plugin_register_complex_read */
1220 int plugin_register_write(const char *name, plugin_write_cb callback,
1221 user_data_t const *ud) {
1222 return create_register_callback(&list_write, name, (void *)callback, ud);
1223 } /* int plugin_register_write */
1225 static int plugin_flush_timeout_callback(user_data_t *ud) {
1226 flush_callback_t *cb = ud->data;
1228 return plugin_flush(cb->name, cb->timeout, NULL);
1229 } /* static int plugin_flush_callback */
1231 static void plugin_flush_timeout_callback_free(void *data) {
1232 flush_callback_t *cb = data;
1239 } /* static void plugin_flush_callback_free */
1241 static char *plugin_flush_callback_name(const char *name) {
1242 const char *flush_prefix = "flush/";
1247 prefix_size = strlen(flush_prefix);
1248 name_size = strlen(name);
1250 flush_name = malloc(name_size + prefix_size + 1);
1251 if (flush_name == NULL) {
1252 ERROR("plugin_flush_callback_name: malloc failed.");
1256 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1257 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1260 } /* static char *plugin_flush_callback_name */
1262 int plugin_register_flush(const char *name, plugin_flush_cb callback,
1263 user_data_t const *ud) {
1265 plugin_ctx_t ctx = plugin_get_ctx();
1267 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1271 if (ctx.flush_interval != 0) {
1273 flush_callback_t *cb;
1275 flush_name = plugin_flush_callback_name(name);
1276 if (flush_name == NULL)
1279 cb = malloc(sizeof(*cb));
1281 ERROR("plugin_register_flush: malloc failed.");
1286 cb->name = strdup(name);
1287 if (cb->name == NULL) {
1288 ERROR("plugin_register_flush: strdup failed.");
1293 cb->timeout = ctx.flush_timeout;
1295 status = plugin_register_complex_read(
1296 /* group = */ "flush",
1297 /* name = */ flush_name,
1298 /* callback = */ plugin_flush_timeout_callback,
1299 /* interval = */ ctx.flush_interval,
1300 /* user data = */ &(user_data_t){
1301 .data = cb, .free_func = plugin_flush_timeout_callback_free,
1309 } /* int plugin_register_flush */
1311 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 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 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 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 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 int plugin_unregister_config(const char *name) {
1381 cf_unregister(name);
1383 } /* int plugin_unregister_config */
1385 int plugin_unregister_complex_config(const char *name) {
1386 cf_unregister_complex(name);
1388 } /* int plugin_unregister_complex_config */
1390 int plugin_unregister_init(const char *name) {
1391 return plugin_unregister(list_init, name);
1394 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 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 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 int plugin_unregister_write(const char *name) {
1494 return plugin_unregister(list_write, name);
1497 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 int plugin_unregister_missing(const char *name) {
1514 return plugin_unregister(list_missing, name);
1517 int plugin_unregister_shutdown(const char *name) {
1518 return plugin_unregister(list_shutdown, name);
1521 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 int plugin_unregister_log(const char *name) {
1537 return plugin_unregister(list_log, name);
1540 int plugin_unregister_notification(const char *name) {
1541 return plugin_unregister(list_notification, name);
1544 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 = 1;
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 void plugin_read_all(void) {
1647 } /* void plugin_read_all */
1649 /* Read function called when the `-T' command line argument is given. */
1650 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 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 /* do not switch plugin context; rather keep the context (interval)
1724 * information of the calling read plugin */
1726 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1727 callback = cf->cf_callback;
1728 status = (*callback)(ds, vl, &cf->cf_udata);
1737 if ((success == 0) && (failure != 0))
1741 } else /* plugin != NULL */
1743 callback_func_t *cf;
1744 plugin_write_cb callback;
1746 le = llist_head(list_write);
1747 while (le != NULL) {
1748 if (strcasecmp(plugin, le->key) == 0)
1759 /* do not switch plugin context; rather keep the context (interval)
1760 * information of the calling read plugin */
1762 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1763 callback = cf->cf_callback;
1764 status = (*callback)(ds, vl, &cf->cf_udata);
1768 } /* }}} int plugin_write */
1770 int plugin_flush(const char *plugin, cdtime_t timeout, const char *identifier) {
1773 if (list_flush == NULL)
1776 le = llist_head(list_flush);
1777 while (le != NULL) {
1778 callback_func_t *cf;
1779 plugin_flush_cb callback;
1780 plugin_ctx_t old_ctx;
1782 if ((plugin != NULL) && (strcmp(plugin, le->key) != 0)) {
1788 old_ctx = plugin_set_ctx(cf->cf_ctx);
1789 callback = cf->cf_callback;
1791 (*callback)(timeout, identifier, &cf->cf_udata);
1793 plugin_set_ctx(old_ctx);
1798 } /* int plugin_flush */
1800 int plugin_shutdown_all(void) {
1802 int ret = 0; // Assume success.
1804 destroy_all_callbacks(&list_init);
1806 stop_read_threads();
1808 pthread_mutex_lock(&read_lock);
1809 llist_destroy(read_list);
1811 pthread_mutex_unlock(&read_lock);
1813 destroy_read_heap();
1815 /* blocks until all write threads have shut down. */
1816 stop_write_threads();
1818 /* ask all plugins to write out the state they kept. */
1819 plugin_flush(/* plugin = */ NULL,
1821 /* identifier = */ NULL);
1824 if (list_shutdown != NULL)
1825 le = llist_head(list_shutdown);
1827 while (le != NULL) {
1828 callback_func_t *cf;
1829 plugin_shutdown_cb callback;
1830 plugin_ctx_t old_ctx;
1833 old_ctx = plugin_set_ctx(cf->cf_ctx);
1834 callback = cf->cf_callback;
1836 /* Advance the pointer before calling the callback allows
1837 * shutdown functions to unregister themselves. If done the
1838 * other way around the memory `le' points to will be freed
1839 * after callback returns. */
1842 if ((*callback)() != 0)
1845 plugin_set_ctx(old_ctx);
1848 /* Write plugins which use the `user_data' pointer usually need the
1849 * same data available to the flush callback. If this is the case, set
1850 * the free_function to NULL when registering the flush callback and to
1851 * the real free function when registering the write callback. This way
1852 * the data isn't freed twice. */
1853 destroy_all_callbacks(&list_flush);
1854 destroy_all_callbacks(&list_missing);
1855 destroy_all_callbacks(&list_write);
1857 destroy_all_callbacks(&list_notification);
1858 destroy_all_callbacks(&list_shutdown);
1859 destroy_all_callbacks(&list_log);
1861 plugin_free_loaded();
1862 plugin_free_data_sets();
1864 } /* void plugin_shutdown_all */
1866 int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1868 if (list_missing == NULL)
1871 llentry_t *le = llist_head(list_missing);
1872 while (le != NULL) {
1873 callback_func_t *cf = le->value;
1874 plugin_ctx_t old_ctx = plugin_set_ctx(cf->cf_ctx);
1875 plugin_missing_cb callback = cf->cf_callback;
1877 int status = (*callback)(vl, &cf->cf_udata);
1878 plugin_set_ctx(old_ctx);
1881 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1882 "failed with status %i.",
1893 } /* int }}} plugin_dispatch_missing */
1895 static int plugin_dispatch_values_internal(value_list_t *vl) {
1897 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1899 _Bool free_meta_data = 0;
1903 /* These fields are initialized by plugin_value_list_clone() if needed: */
1904 assert(vl->host[0] != 0);
1905 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1906 assert(vl->interval != 0);
1908 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1909 ERROR("plugin_dispatch_values: Invalid value list "
1915 /* Free meta data only if the calling function didn't specify any. In
1916 * this case matches and targets may add some and the calling function
1917 * may not expect (and therefore free) that data. */
1918 if (vl->meta == NULL)
1921 if (list_write == NULL)
1922 c_complain_once(LOG_WARNING, &no_write_complaint,
1923 "plugin_dispatch_values: No write callback has been "
1924 "registered. Please load at least one output plugin, "
1925 "if you want the collected data to be stored.");
1927 if (data_sets == NULL) {
1928 ERROR("plugin_dispatch_values: No data sets registered. "
1929 "Could the types database be read? Check "
1930 "your `TypesDB' setting!");
1934 data_set_t *ds = NULL;
1935 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1936 char ident[6 * DATA_MAX_NAME_LEN];
1938 FORMAT_VL(ident, sizeof(ident), vl);
1939 INFO("plugin_dispatch_values: Dataset not found: %s "
1940 "(from \"%s\"), check your types.db!",
1945 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1947 "plugin = %s; plugin_instance = %s; "
1948 "type = %s; type_instance = %s;",
1949 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1950 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1953 assert(0 == strcmp(ds->type, vl->type));
1955 if (0 != strcmp(ds->type, vl->type))
1956 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1957 ds->type, vl->type);
1961 assert(ds->ds_num == vl->values_len);
1963 if (ds->ds_num != vl->values_len) {
1964 ERROR("plugin_dispatch_values: ds->type = %s: "
1965 "(ds->ds_num = %zu) != "
1966 "(vl->values_len = %zu)",
1967 ds->type, ds->ds_num, vl->values_len);
1972 escape_slashes(vl->host, sizeof(vl->host));
1973 escape_slashes(vl->plugin, sizeof(vl->plugin));
1974 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
1975 escape_slashes(vl->type, sizeof(vl->type));
1976 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
1978 if (pre_cache_chain != NULL) {
1979 status = fc_process_chain(ds, vl, pre_cache_chain);
1981 WARNING("plugin_dispatch_values: Running the "
1982 "pre-cache chain failed with "
1985 } else if (status == FC_TARGET_STOP)
1989 /* Update the value cache */
1992 if (post_cache_chain != NULL) {
1993 status = fc_process_chain(ds, vl, post_cache_chain);
1995 WARNING("plugin_dispatch_values: Running the "
1996 "post-cache chain failed with "
2001 fc_default_action(ds, vl);
2003 if ((free_meta_data != 0) && (vl->meta != NULL)) {
2004 meta_data_destroy(vl->meta);
2009 } /* int plugin_dispatch_values_internal */
2011 static double get_drop_probability(void) /* {{{ */
2017 pthread_mutex_lock(&write_lock);
2018 wql = write_queue_length;
2019 pthread_mutex_unlock(&write_lock);
2021 if (wql < write_limit_low)
2023 if (wql >= write_limit_high)
2026 pos = 1 + wql - write_limit_low;
2027 size = 1 + write_limit_high - write_limit_low;
2029 return (double)pos / (double)size;
2030 } /* }}} double get_drop_probability */
2032 static _Bool check_drop_value(void) /* {{{ */
2034 static cdtime_t last_message_time = 0;
2035 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2041 if (write_limit_high == 0)
2044 p = get_drop_probability();
2048 status = pthread_mutex_trylock(&last_message_lock);
2053 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2054 last_message_time = now;
2055 ERROR("plugin_dispatch_values: Low water mark "
2056 "reached. Dropping %.0f%% of metrics.",
2059 pthread_mutex_unlock(&last_message_lock);
2070 } /* }}} _Bool check_drop_value */
2072 int plugin_dispatch_values(value_list_t const *vl) {
2074 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2076 if (check_drop_value()) {
2077 if (record_statistics) {
2078 pthread_mutex_lock(&statistics_lock);
2079 stats_values_dropped++;
2080 pthread_mutex_unlock(&statistics_lock);
2085 status = plugin_write_enqueue(vl);
2087 ERROR("plugin_dispatch_values: plugin_write_enqueue failed with status %i "
2089 status, STRERROR(status));
2096 __attribute__((sentinel)) int
2097 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2098 _Bool store_percentage, int store_type, ...) {
2104 assert(template->values_len == 1);
2106 /* Calculate sum for Gauge to calculate percent if needed */
2107 if (DS_TYPE_GAUGE == store_type) {
2108 va_start(ap, store_type);
2113 name = va_arg(ap, char const *);
2117 value = va_arg(ap, gauge_t);
2124 vl = plugin_value_list_clone(template);
2125 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2126 if (store_percentage)
2127 sstrncpy(vl->type, "percent", sizeof(vl->type));
2129 va_start(ap, store_type);
2134 /* Set the type instance. */
2135 name = va_arg(ap, char const *);
2138 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2140 /* Set the value. */
2141 switch (store_type) {
2143 vl->values[0].gauge = va_arg(ap, gauge_t);
2144 if (store_percentage)
2145 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2147 case DS_TYPE_ABSOLUTE:
2148 vl->values[0].absolute = va_arg(ap, absolute_t);
2150 case DS_TYPE_COUNTER:
2151 vl->values[0].counter = va_arg(ap, counter_t);
2153 case DS_TYPE_DERIVE:
2154 vl->values[0].derive = va_arg(ap, derive_t);
2157 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2161 status = plugin_write_enqueue(vl);
2167 plugin_value_list_free(vl);
2169 } /* }}} int plugin_dispatch_multivalue */
2171 int plugin_dispatch_notification(const notification_t *notif) {
2173 /* Possible TODO: Add flap detection here */
2175 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2176 "time = %.3f; host = %s;",
2177 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2180 /* Nobody cares for notifications */
2181 if (list_notification == NULL)
2184 le = llist_head(list_notification);
2185 while (le != NULL) {
2186 callback_func_t *cf;
2187 plugin_notification_cb callback;
2190 /* do not switch plugin context; rather keep the context
2191 * (interval) information of the calling plugin */
2194 callback = cf->cf_callback;
2195 status = (*callback)(notif, &cf->cf_udata);
2197 WARNING("plugin_dispatch_notification: Notification "
2198 "callback %s returned %i.",
2206 } /* int plugin_dispatch_notification */
2208 void plugin_log(int level, const char *format, ...) {
2214 if (level >= LOG_DEBUG)
2218 va_start(ap, format);
2219 vsnprintf(msg, sizeof(msg), format, ap);
2220 msg[sizeof(msg) - 1] = '\0';
2223 if (list_log == NULL) {
2224 fprintf(stderr, "%s\n", msg);
2228 le = llist_head(list_log);
2229 while (le != NULL) {
2230 callback_func_t *cf;
2231 plugin_log_cb callback;
2234 callback = cf->cf_callback;
2236 /* do not switch plugin context; rather keep the context
2237 * (interval) information of the calling plugin */
2239 (*callback)(level, msg, &cf->cf_udata);
2243 } /* void plugin_log */
2245 int parse_log_severity(const char *severity) {
2248 if ((0 == strcasecmp(severity, "emerg")) ||
2249 (0 == strcasecmp(severity, "alert")) ||
2250 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2251 log_level = LOG_ERR;
2252 else if (0 == strcasecmp(severity, "warning"))
2253 log_level = LOG_WARNING;
2254 else if (0 == strcasecmp(severity, "notice"))
2255 log_level = LOG_NOTICE;
2256 else if (0 == strcasecmp(severity, "info"))
2257 log_level = LOG_INFO;
2259 else if (0 == strcasecmp(severity, "debug"))
2260 log_level = LOG_DEBUG;
2261 #endif /* COLLECT_DEBUG */
2264 } /* int parse_log_severity */
2266 int parse_notif_severity(const char *severity) {
2267 int notif_severity = -1;
2269 if (strcasecmp(severity, "FAILURE") == 0)
2270 notif_severity = NOTIF_FAILURE;
2271 else if (strcmp(severity, "OKAY") == 0)
2272 notif_severity = NOTIF_OKAY;
2273 else if ((strcmp(severity, "WARNING") == 0) ||
2274 (strcmp(severity, "WARN") == 0))
2275 notif_severity = NOTIF_WARNING;
2277 return notif_severity;
2278 } /* int parse_notif_severity */
2280 const data_set_t *plugin_get_ds(const char *name) {
2283 if (data_sets == NULL) {
2284 ERROR("plugin_get_ds: No data sets are defined yet.");
2288 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2289 DEBUG("No such dataset registered: %s", name);
2294 } /* data_set_t *plugin_get_ds */
2296 static int plugin_notification_meta_add(notification_t *n, const char *name,
2297 enum notification_meta_type_e type,
2298 const void *value) {
2299 notification_meta_t *meta;
2300 notification_meta_t *tail;
2302 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2303 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2307 meta = calloc(1, sizeof(*meta));
2309 ERROR("plugin_notification_meta_add: calloc failed.");
2313 sstrncpy(meta->name, name, sizeof(meta->name));
2317 case NM_TYPE_STRING: {
2318 meta->nm_value.nm_string = strdup((const char *)value);
2319 if (meta->nm_value.nm_string == NULL) {
2320 ERROR("plugin_notification_meta_add: strdup failed.");
2326 case NM_TYPE_SIGNED_INT: {
2327 meta->nm_value.nm_signed_int = *((int64_t *)value);
2330 case NM_TYPE_UNSIGNED_INT: {
2331 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2334 case NM_TYPE_DOUBLE: {
2335 meta->nm_value.nm_double = *((double *)value);
2338 case NM_TYPE_BOOLEAN: {
2339 meta->nm_value.nm_boolean = *((_Bool *)value);
2343 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2347 } /* switch (type) */
2351 while ((tail != NULL) && (tail->next != NULL))
2360 } /* int plugin_notification_meta_add */
2362 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2363 const char *value) {
2364 return plugin_notification_meta_add(n, name, NM_TYPE_STRING, value);
2367 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2369 return plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value);
2372 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2375 return plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value);
2378 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2380 return plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value);
2383 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2385 return plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value);
2388 int plugin_notification_meta_copy(notification_t *dst,
2389 const notification_t *src) {
2390 assert(dst != NULL);
2391 assert(src != NULL);
2393 assert((src->meta == NULL) || (src->meta != dst->meta));
2395 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2396 if (meta->type == NM_TYPE_STRING)
2397 plugin_notification_meta_add_string(dst, meta->name,
2398 meta->nm_value.nm_string);
2399 else if (meta->type == NM_TYPE_SIGNED_INT)
2400 plugin_notification_meta_add_signed_int(dst, meta->name,
2401 meta->nm_value.nm_signed_int);
2402 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2403 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2404 meta->nm_value.nm_unsigned_int);
2405 else if (meta->type == NM_TYPE_DOUBLE)
2406 plugin_notification_meta_add_double(dst, meta->name,
2407 meta->nm_value.nm_double);
2408 else if (meta->type == NM_TYPE_BOOLEAN)
2409 plugin_notification_meta_add_boolean(dst, meta->name,
2410 meta->nm_value.nm_boolean);
2414 } /* int plugin_notification_meta_copy */
2416 int plugin_notification_meta_free(notification_meta_t *n) {
2417 notification_meta_t *this;
2418 notification_meta_t *next;
2421 ERROR("plugin_notification_meta_free: n == NULL!");
2426 while (this != NULL) {
2429 if (this->type == NM_TYPE_STRING) {
2430 /* Assign to a temporary variable to work around nm_string's const
2432 void *tmp = (void *)this->nm_value.nm_string;
2435 this->nm_value.nm_string = NULL;
2443 } /* int plugin_notification_meta_free */
2445 static void plugin_ctx_destructor(void *ctx) {
2447 } /* void plugin_ctx_destructor */
2449 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2451 static plugin_ctx_t *plugin_ctx_create(void) {
2454 ctx = malloc(sizeof(*ctx));
2456 ERROR("Failed to allocate plugin context: %s", STRERRNO);
2461 assert(plugin_ctx_key_initialized);
2462 pthread_setspecific(plugin_ctx_key, ctx);
2463 DEBUG("Created new plugin context.");
2465 } /* int plugin_ctx_create */
2467 void plugin_init_ctx(void) {
2468 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2469 plugin_ctx_key_initialized = 1;
2470 } /* void plugin_init_ctx */
2472 plugin_ctx_t plugin_get_ctx(void) {
2475 assert(plugin_ctx_key_initialized);
2476 ctx = pthread_getspecific(plugin_ctx_key);
2479 ctx = plugin_ctx_create();
2480 /* this must no happen -- exit() instead? */
2486 } /* plugin_ctx_t plugin_get_ctx */
2488 plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2492 assert(plugin_ctx_key_initialized);
2493 c = pthread_getspecific(plugin_ctx_key);
2496 c = plugin_ctx_create();
2497 /* this must no happen -- exit() instead? */
2506 } /* void plugin_set_ctx */
2508 cdtime_t plugin_get_interval(void) {
2511 interval = plugin_get_ctx().interval;
2515 return cf_get_default_interval();
2516 } /* cdtime_t plugin_get_interval */
2520 void *(*start_routine)(void *);
2524 static void *plugin_thread_start(void *arg) {
2525 plugin_thread_t *plugin_thread = arg;
2527 void *(*start_routine)(void *) = plugin_thread->start_routine;
2528 void *plugin_arg = plugin_thread->arg;
2530 plugin_set_ctx(plugin_thread->ctx);
2532 sfree(plugin_thread);
2534 return start_routine(plugin_arg);
2535 } /* void *plugin_thread_start */
2537 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2538 void *(*start_routine)(void *), void *arg,
2540 plugin_thread_t *plugin_thread;
2542 plugin_thread = malloc(sizeof(*plugin_thread));
2543 if (plugin_thread == NULL)
2546 plugin_thread->ctx = plugin_get_ctx();
2547 plugin_thread->start_routine = start_routine;
2548 plugin_thread->arg = arg;
2550 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2552 sfree(plugin_thread);
2557 set_thread_name(*thread, name);
2560 } /* int plugin_thread_create */