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;
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;
108 static fc_chain_t *post_cache_chain;
110 static c_avl_tree_t *data_sets;
112 static char *plugindir;
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;
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;
123 static size_t read_threads_num;
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;
129 static bool write_loop = true;
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;
133 static size_t write_threads_num;
135 static pthread_key_t plugin_ctx_key;
136 static bool plugin_ctx_key_initialized;
138 static long write_limit_high;
139 static long write_limit_low;
141 static derive_t stats_values_dropped;
142 static bool record_statistics;
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) {
350 if (name == NULL || callback == NULL)
353 callback_func_t *cf = calloc(1, sizeof(*cf));
356 ERROR("plugin: create_register_callback: calloc failed.");
360 cf->cf_callback = callback;
362 cf->cf_udata = (user_data_t){
363 .data = NULL, .free_func = NULL,
369 cf->cf_ctx = plugin_get_ctx();
371 return register_callback(list, name, cf);
372 } /* }}} int create_register_callback */
374 static int plugin_unregister(llist_t *list, const char *name) /* {{{ */
381 e = llist_search(list, name);
385 llist_remove(list, e);
388 destroy_callback(e->value);
393 } /* }}} int plugin_unregister */
395 /* plugin_load_file loads the shared object "file" and calls its
396 * "module_register" function. Returns zero on success, non-zero otherwise. */
397 static int plugin_load_file(char const *file, bool global) {
398 int flags = RTLD_NOW;
400 flags |= RTLD_GLOBAL;
402 void *dlh = dlopen(file, flags);
404 char errbuf[1024] = "";
406 snprintf(errbuf, sizeof(errbuf),
407 "dlopen(\"%s\") failed: %s. "
408 "The most common cause for this problem is missing dependencies. "
409 "Use ldd(1) to check the dependencies of the plugin / shared "
413 /* This error is printed to STDERR unconditionally. If list_log is NULL,
414 * plugin_log() will also print to STDERR. We avoid duplicate output by
415 * checking that the list of log handlers, list_log, is not NULL. */
416 fprintf(stderr, "ERROR: %s\n", errbuf);
417 if (list_log != NULL) {
424 void (*reg_handle)(void) = dlsym(dlh, "module_register");
425 if (reg_handle == NULL) {
426 ERROR("Couldn't find symbol \"module_register\" in \"%s\": %s\n", file,
436 static void *plugin_read_thread(void __attribute__((unused)) * args) {
437 while (read_loop != 0) {
439 plugin_ctx_t old_ctx;
447 /* Get the read function that needs to be read next.
448 * We don't need to hold "read_lock" for the heap, but we need
449 * to call c_heap_get_root() and pthread_cond_wait() in the
450 * same protected block. */
451 pthread_mutex_lock(&read_lock);
452 rf = c_heap_get_root(read_heap);
454 pthread_cond_wait(&read_cond, &read_lock);
455 pthread_mutex_unlock(&read_lock);
458 pthread_mutex_unlock(&read_lock);
460 if (rf->rf_interval == 0) {
461 /* this should not happen, because the interval is set
462 * for each plugin when loading it
463 * XXX: issue a warning? */
464 rf->rf_interval = plugin_get_interval();
465 rf->rf_effective_interval = rf->rf_interval;
467 rf->rf_next_read = cdtime();
470 /* sleep until this entry is due,
471 * using pthread_cond_timedwait */
472 pthread_mutex_lock(&read_lock);
473 /* In pthread_cond_timedwait, spurious wakeups are possible
474 * (and really happen, at least on NetBSD with > 1 CPU), thus
475 * we need to re-evaluate the condition every time
476 * pthread_cond_timedwait returns. */
478 while ((read_loop != 0) && (cdtime() < rf->rf_next_read) && rc == 0) {
479 rc = pthread_cond_timedwait(&read_cond, &read_lock,
480 &CDTIME_T_TO_TIMESPEC(rf->rf_next_read));
483 /* Must hold `read_lock' when accessing `rf->rf_type'. */
484 rf_type = rf->rf_type;
485 pthread_mutex_unlock(&read_lock);
487 /* Check if we're supposed to stop.. This may have interrupted
489 if (read_loop == 0) {
490 /* Insert `rf' again, so it can be free'd correctly */
491 c_heap_insert(read_heap, rf);
495 /* The entry has been marked for deletion. The linked list
496 * entry has already been removed by `plugin_unregister_read'.
497 * All we have to do here is free the `read_func_t' and
499 if (rf_type == RF_REMOVE) {
500 DEBUG("plugin_read_thread: Destroying the `%s' "
504 destroy_callback((callback_func_t *)rf);
509 DEBUG("plugin_read_thread: Handling `%s'.", rf->rf_name);
513 old_ctx = plugin_set_ctx(rf->rf_ctx);
515 if (rf_type == RF_SIMPLE) {
516 int (*callback)(void);
518 callback = rf->rf_callback;
519 status = (*callback)();
521 plugin_read_cb callback;
523 assert(rf_type == RF_COMPLEX);
525 callback = rf->rf_callback;
526 status = (*callback)(&rf->rf_udata);
529 plugin_set_ctx(old_ctx);
531 /* If the function signals failure, we will increase the
532 * intervals in which it will be called. */
534 rf->rf_effective_interval *= 2;
535 if (rf->rf_effective_interval > max_read_interval)
536 rf->rf_effective_interval = max_read_interval;
538 NOTICE("read-function of plugin `%s' failed. "
539 "Will suspend it for %.3f seconds.",
540 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
542 /* Success: Restore the interval, if it was changed. */
543 rf->rf_effective_interval = rf->rf_interval;
546 /* update the ``next read due'' field */
549 /* calculate the time spent in the read function */
550 elapsed = (now - start);
552 if (elapsed > rf->rf_effective_interval)
554 "plugin_read_thread: read-function of the `%s' plugin took %.3f "
555 "seconds, which is above its read interval (%.3f seconds). You might "
556 "want to adjust the `Interval' or `ReadThreads' settings.",
557 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed),
558 CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
560 DEBUG("plugin_read_thread: read-function of the `%s' plugin took "
562 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed));
564 DEBUG("plugin_read_thread: Effective interval of the "
565 "`%s' plugin is %.3f seconds.",
566 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
568 /* Calculate the next (absolute) time at which this function
569 * should be called. */
570 rf->rf_next_read += rf->rf_effective_interval;
572 /* Check, if `rf_next_read' is in the past. */
573 if (rf->rf_next_read < now) {
574 /* `rf_next_read' is in the past. Insert `now'
575 * so this value doesn't trail off into the
577 rf->rf_next_read = now;
580 DEBUG("plugin_read_thread: Next read of the `%s' plugin at %.3f.",
581 rf->rf_name, CDTIME_T_TO_DOUBLE(rf->rf_next_read));
583 /* Re-insert this read function into the heap again. */
584 c_heap_insert(read_heap, rf);
585 } /* while (read_loop) */
589 } /* void *plugin_read_thread */
591 #ifdef PTHREAD_MAX_NAMELEN_NP
592 #define THREAD_NAME_MAX PTHREAD_MAX_NAMELEN_NP
594 #define THREAD_NAME_MAX 16
597 static void set_thread_name(pthread_t tid, char const *name) {
598 #if defined(HAVE_PTHREAD_SETNAME_NP) || defined(HAVE_PTHREAD_SET_NAME_NP)
600 /* glibc limits the length of the name and fails if the passed string
601 * is too long, so we truncate it here. */
602 char n[THREAD_NAME_MAX];
603 if (strlen(name) >= THREAD_NAME_MAX)
604 WARNING("set_thread_name(\"%s\"): name too long", name);
605 sstrncpy(n, name, sizeof(n));
607 #if defined(HAVE_PTHREAD_SETNAME_NP)
608 int status = pthread_setname_np(tid, n);
610 ERROR("set_thread_name(\"%s\"): %s", n, STRERROR(status));
612 #else /* if defined(HAVE_PTHREAD_SET_NAME_NP) */
613 pthread_set_name_np(tid, n);
619 static void start_read_threads(size_t num) /* {{{ */
621 if (read_threads != NULL)
624 read_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
625 if (read_threads == NULL) {
626 ERROR("plugin: start_read_threads: calloc failed.");
630 read_threads_num = 0;
631 for (size_t i = 0; i < num; i++) {
632 int status = pthread_create(read_threads + read_threads_num,
633 /* attr = */ NULL, plugin_read_thread,
636 ERROR("plugin: start_read_threads: pthread_create failed with status %i "
638 status, STRERROR(status));
642 char name[THREAD_NAME_MAX];
643 snprintf(name, sizeof(name), "reader#%" PRIsz, read_threads_num);
644 set_thread_name(read_threads[read_threads_num], name);
648 } /* }}} void start_read_threads */
650 static void stop_read_threads(void) {
651 if (read_threads == NULL)
654 INFO("collectd: Stopping %" PRIsz " read threads.", read_threads_num);
656 pthread_mutex_lock(&read_lock);
658 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
659 pthread_cond_broadcast(&read_cond);
660 pthread_mutex_unlock(&read_lock);
662 for (size_t i = 0; i < read_threads_num; i++) {
663 if (pthread_join(read_threads[i], NULL) != 0) {
664 ERROR("plugin: stop_read_threads: pthread_join failed.");
666 read_threads[i] = (pthread_t)0;
669 read_threads_num = 0;
670 } /* void stop_read_threads */
672 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
677 meta_data_destroy(vl->meta);
680 } /* }}} void plugin_value_list_free */
682 static value_list_t *
683 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
690 vl = malloc(sizeof(*vl));
693 memcpy(vl, vl_orig, sizeof(*vl));
695 if (vl->host[0] == 0)
696 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
698 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
699 if (vl->values == NULL) {
700 plugin_value_list_free(vl);
703 memcpy(vl->values, vl_orig->values,
704 vl_orig->values_len * sizeof(*vl->values));
706 vl->meta = meta_data_clone(vl->meta);
707 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
708 plugin_value_list_free(vl);
715 /* Fill in the interval from the thread context, if it is zero. */
716 if (vl->interval == 0) {
717 plugin_ctx_t ctx = plugin_get_ctx();
719 if (ctx.interval != 0)
720 vl->interval = ctx.interval;
722 char name[6 * DATA_MAX_NAME_LEN];
723 FORMAT_VL(name, sizeof(name), vl);
724 ERROR("plugin_value_list_clone: Unable to determine "
725 "interval from context for "
726 "value list \"%s\". "
727 "This indicates a broken plugin. "
728 "Please report this problem to the "
729 "collectd mailing list or at "
730 "<http://collectd.org/bugs/>.",
732 vl->interval = cf_get_default_interval();
737 } /* }}} value_list_t *plugin_value_list_clone */
739 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
743 q = malloc(sizeof(*q));
748 q->vl = plugin_value_list_clone(vl);
754 /* Store context of caller (read plugin); otherwise, it would not be
755 * available to the write plugins when actually dispatching the
756 * value-list later on. */
757 q->ctx = plugin_get_ctx();
759 pthread_mutex_lock(&write_lock);
761 if (write_queue_tail == NULL) {
762 write_queue_head = q;
763 write_queue_tail = q;
764 write_queue_length = 1;
766 write_queue_tail->next = q;
767 write_queue_tail = q;
768 write_queue_length += 1;
771 pthread_cond_signal(&write_cond);
772 pthread_mutex_unlock(&write_lock);
775 } /* }}} int plugin_write_enqueue */
777 static value_list_t *plugin_write_dequeue(void) /* {{{ */
782 pthread_mutex_lock(&write_lock);
784 while (write_loop && (write_queue_head == NULL))
785 pthread_cond_wait(&write_cond, &write_lock);
787 if (write_queue_head == NULL) {
788 pthread_mutex_unlock(&write_lock);
792 q = write_queue_head;
793 write_queue_head = q->next;
794 write_queue_length -= 1;
795 if (write_queue_head == NULL) {
796 write_queue_tail = NULL;
797 assert(0 == write_queue_length);
800 pthread_mutex_unlock(&write_lock);
802 (void)plugin_set_ctx(q->ctx);
807 } /* }}} value_list_t *plugin_write_dequeue */
809 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
812 value_list_t *vl = plugin_write_dequeue();
816 plugin_dispatch_values_internal(vl);
818 plugin_value_list_free(vl);
823 } /* }}} void *plugin_write_thread */
825 static void start_write_threads(size_t num) /* {{{ */
827 if (write_threads != NULL)
830 write_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
831 if (write_threads == NULL) {
832 ERROR("plugin: start_write_threads: calloc failed.");
836 write_threads_num = 0;
837 for (size_t i = 0; i < num; i++) {
838 int status = pthread_create(write_threads + write_threads_num,
839 /* attr = */ NULL, plugin_write_thread,
842 ERROR("plugin: start_write_threads: pthread_create failed with status %i "
844 status, STRERROR(status));
848 char name[THREAD_NAME_MAX];
849 snprintf(name, sizeof(name), "writer#%" PRIsz, write_threads_num);
850 set_thread_name(write_threads[write_threads_num], name);
854 } /* }}} void start_write_threads */
856 static void stop_write_threads(void) /* {{{ */
861 if (write_threads == NULL)
864 INFO("collectd: Stopping %" PRIsz " write threads.", write_threads_num);
866 pthread_mutex_lock(&write_lock);
868 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
869 pthread_cond_broadcast(&write_cond);
870 pthread_mutex_unlock(&write_lock);
872 for (i = 0; i < write_threads_num; i++) {
873 if (pthread_join(write_threads[i], NULL) != 0) {
874 ERROR("plugin: stop_write_threads: pthread_join failed.");
876 write_threads[i] = (pthread_t)0;
878 sfree(write_threads);
879 write_threads_num = 0;
881 pthread_mutex_lock(&write_lock);
883 for (q = write_queue_head; q != NULL;) {
884 write_queue_t *q1 = q;
885 plugin_value_list_free(q->vl);
890 write_queue_head = NULL;
891 write_queue_tail = NULL;
892 write_queue_length = 0;
893 pthread_mutex_unlock(&write_lock);
896 WARNING("plugin: %" PRIsz " value list%s left after shutting down "
897 "the write threads.",
898 i, (i == 1) ? " was" : "s were");
900 } /* }}} void stop_write_threads */
905 void plugin_set_dir(const char *dir) {
913 plugindir = strdup(dir);
914 if (plugindir == NULL)
915 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
918 static bool plugin_is_loaded(char const *name) {
921 if (plugins_loaded == NULL)
923 c_avl_create((int (*)(const void *, const void *))strcasecmp);
924 assert(plugins_loaded != NULL);
926 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
930 static int plugin_mark_loaded(char const *name) {
934 name_copy = strdup(name);
935 if (name_copy == NULL)
938 status = c_avl_insert(plugins_loaded,
939 /* key = */ name_copy, /* value = */ NULL);
943 static void plugin_free_loaded(void) {
947 if (plugins_loaded == NULL)
950 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
952 assert(value == NULL);
955 c_avl_destroy(plugins_loaded);
956 plugins_loaded = NULL;
960 int plugin_load(char const *plugin_name, bool global) {
963 char filename[BUFSIZE] = "";
964 char typename[BUFSIZE];
970 if (plugin_name == NULL)
973 /* Check if plugin is already loaded and don't do anything in this
975 if (plugin_is_loaded(plugin_name))
978 dir = plugin_get_dir();
982 * XXX: Magic at work:
984 * Some of the language bindings, for example the Python and Perl
985 * plugins, need to be able to export symbols to the scripts they run.
986 * For this to happen, the "Globals" flag needs to be set.
987 * Unfortunately, this technical detail is hard to explain to the
988 * average user and she shouldn't have to worry about this, ideally.
989 * So in order to save everyone's sanity use a different default for a
990 * handful of special plugins. --octo
992 if ((strcasecmp("perl", plugin_name) == 0) ||
993 (strcasecmp("python", plugin_name) == 0))
996 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
997 * type when matching the filename */
998 status = snprintf(typename, sizeof(typename), "%s.so", plugin_name);
999 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
1000 WARNING("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1004 if ((dh = opendir(dir)) == NULL) {
1005 ERROR("plugin_load: opendir (%s) failed: %s", dir, STRERRNO);
1009 while ((de = readdir(dh)) != NULL) {
1010 if (strcasecmp(de->d_name, typename))
1013 status = snprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1014 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1015 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1019 if (lstat(filename, &statbuf) == -1) {
1020 WARNING("plugin_load: stat (\"%s\") failed: %s", filename, STRERRNO);
1022 } else if (!S_ISREG(statbuf.st_mode)) {
1023 /* don't follow symlinks */
1024 WARNING("plugin_load: %s is not a regular file.", filename);
1028 status = plugin_load_file(filename, global);
1031 plugin_mark_loaded(plugin_name);
1033 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1036 ERROR("plugin_load: Load plugin \"%s\" failed with "
1038 plugin_name, status);
1044 if (filename[0] == 0)
1045 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1051 * The `register_*' functions follow
1053 int plugin_register_config(const char *name,
1054 int (*callback)(const char *key, const char *val),
1055 const char **keys, int keys_num) {
1056 cf_register(name, callback, keys, keys_num);
1058 } /* int plugin_register_config */
1060 int plugin_register_complex_config(const char *type,
1061 int (*callback)(oconfig_item_t *)) {
1062 return cf_register_complex(type, callback);
1063 } /* int plugin_register_complex_config */
1065 int plugin_register_init(const char *name, int (*callback)(void)) {
1066 return create_register_callback(&list_init, name, (void *)callback, NULL);
1067 } /* plugin_register_init */
1069 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1070 const read_func_t *rf0;
1071 const read_func_t *rf1;
1076 if (rf0->rf_next_read < rf1->rf_next_read)
1078 else if (rf0->rf_next_read > rf1->rf_next_read)
1082 } /* int plugin_compare_read_func */
1084 /* Add a read function to both, the heap and a linked list. The linked list if
1085 * used to look-up read functions, especially for the remove function. The heap
1086 * is used to determine which plugin to read next. */
1087 static int plugin_insert_read(read_func_t *rf) {
1091 rf->rf_next_read = cdtime();
1092 rf->rf_effective_interval = rf->rf_interval;
1094 pthread_mutex_lock(&read_lock);
1096 if (read_list == NULL) {
1097 read_list = llist_create();
1098 if (read_list == NULL) {
1099 pthread_mutex_unlock(&read_lock);
1100 ERROR("plugin_insert_read: read_list failed.");
1105 if (read_heap == NULL) {
1106 read_heap = c_heap_create(plugin_compare_read_func);
1107 if (read_heap == NULL) {
1108 pthread_mutex_unlock(&read_lock);
1109 ERROR("plugin_insert_read: c_heap_create failed.");
1114 le = llist_search(read_list, rf->rf_name);
1116 pthread_mutex_unlock(&read_lock);
1117 WARNING("The read function \"%s\" is already registered. "
1118 "Check for duplicates in your configuration!",
1123 le = llentry_create(rf->rf_name, rf);
1125 pthread_mutex_unlock(&read_lock);
1126 ERROR("plugin_insert_read: llentry_create failed.");
1130 status = c_heap_insert(read_heap, rf);
1132 pthread_mutex_unlock(&read_lock);
1133 ERROR("plugin_insert_read: c_heap_insert failed.");
1134 llentry_destroy(le);
1138 /* This does not fail. */
1139 llist_append(read_list, le);
1141 /* Wake up all the read threads. */
1142 pthread_cond_broadcast(&read_cond);
1143 pthread_mutex_unlock(&read_lock);
1145 } /* int plugin_insert_read */
1147 int plugin_register_read(const char *name, int (*callback)(void)) {
1151 rf = calloc(1, sizeof(*rf));
1153 ERROR("plugin_register_read: calloc failed.");
1157 rf->rf_callback = (void *)callback;
1158 rf->rf_udata.data = NULL;
1159 rf->rf_udata.free_func = NULL;
1160 rf->rf_ctx = plugin_get_ctx();
1161 rf->rf_group[0] = '\0';
1162 rf->rf_name = strdup(name);
1163 rf->rf_type = RF_SIMPLE;
1164 rf->rf_interval = plugin_get_interval();
1165 rf->rf_ctx.interval = rf->rf_interval;
1167 status = plugin_insert_read(rf);
1174 } /* int plugin_register_read */
1176 int plugin_register_complex_read(const char *group, const char *name,
1177 plugin_read_cb callback, cdtime_t interval,
1178 user_data_t const *user_data) {
1182 rf = calloc(1, sizeof(*rf));
1184 free_userdata(user_data);
1185 ERROR("plugin_register_complex_read: calloc failed.");
1189 rf->rf_callback = (void *)callback;
1191 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1193 rf->rf_group[0] = '\0';
1194 rf->rf_name = strdup(name);
1195 rf->rf_type = RF_COMPLEX;
1196 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1199 if (user_data == NULL) {
1200 rf->rf_udata.data = NULL;
1201 rf->rf_udata.free_func = NULL;
1203 rf->rf_udata = *user_data;
1206 rf->rf_ctx = plugin_get_ctx();
1207 rf->rf_ctx.interval = rf->rf_interval;
1209 status = plugin_insert_read(rf);
1211 free_userdata(&rf->rf_udata);
1217 } /* int plugin_register_complex_read */
1219 int plugin_register_write(const char *name, plugin_write_cb callback,
1220 user_data_t const *ud) {
1221 return create_register_callback(&list_write, name, (void *)callback, ud);
1222 } /* int plugin_register_write */
1224 static int plugin_flush_timeout_callback(user_data_t *ud) {
1225 flush_callback_t *cb = ud->data;
1227 return plugin_flush(cb->name, cb->timeout, NULL);
1228 } /* static int plugin_flush_callback */
1230 static void plugin_flush_timeout_callback_free(void *data) {
1231 flush_callback_t *cb = data;
1238 } /* static void plugin_flush_callback_free */
1240 static char *plugin_flush_callback_name(const char *name) {
1241 const char *flush_prefix = "flush/";
1246 prefix_size = strlen(flush_prefix);
1247 name_size = strlen(name);
1249 flush_name = malloc(name_size + prefix_size + 1);
1250 if (flush_name == NULL) {
1251 ERROR("plugin_flush_callback_name: malloc failed.");
1255 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1256 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1259 } /* static char *plugin_flush_callback_name */
1261 int plugin_register_flush(const char *name, plugin_flush_cb callback,
1262 user_data_t const *ud) {
1264 plugin_ctx_t ctx = plugin_get_ctx();
1266 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1270 if (ctx.flush_interval != 0) {
1272 flush_callback_t *cb;
1274 flush_name = plugin_flush_callback_name(name);
1275 if (flush_name == NULL)
1278 cb = malloc(sizeof(*cb));
1280 ERROR("plugin_register_flush: malloc failed.");
1285 cb->name = strdup(name);
1286 if (cb->name == NULL) {
1287 ERROR("plugin_register_flush: strdup failed.");
1292 cb->timeout = ctx.flush_timeout;
1294 status = plugin_register_complex_read(
1295 /* group = */ "flush",
1296 /* name = */ flush_name,
1297 /* callback = */ plugin_flush_timeout_callback,
1298 /* interval = */ ctx.flush_interval,
1299 /* user data = */ &(user_data_t){
1300 .data = cb, .free_func = plugin_flush_timeout_callback_free,
1308 } /* int plugin_register_flush */
1310 int plugin_register_missing(const char *name, plugin_missing_cb callback,
1311 user_data_t const *ud) {
1312 return create_register_callback(&list_missing, name, (void *)callback, ud);
1313 } /* int plugin_register_missing */
1315 int plugin_register_shutdown(const char *name, int (*callback)(void)) {
1316 return create_register_callback(&list_shutdown, name, (void *)callback, NULL);
1317 } /* int plugin_register_shutdown */
1319 static void plugin_free_data_sets(void) {
1323 if (data_sets == NULL)
1326 while (c_avl_pick(data_sets, &key, &value) == 0) {
1327 data_set_t *ds = value;
1328 /* key is a pointer to ds->type */
1334 c_avl_destroy(data_sets);
1336 } /* void plugin_free_data_sets */
1338 int plugin_register_data_set(const data_set_t *ds) {
1339 data_set_t *ds_copy;
1341 if ((data_sets != NULL) && (c_avl_get(data_sets, ds->type, NULL) == 0)) {
1342 NOTICE("Replacing DS `%s' with another version.", ds->type);
1343 plugin_unregister_data_set(ds->type);
1344 } else if (data_sets == NULL) {
1345 data_sets = c_avl_create((int (*)(const void *, const void *))strcmp);
1346 if (data_sets == NULL)
1350 ds_copy = malloc(sizeof(*ds_copy));
1351 if (ds_copy == NULL)
1353 memcpy(ds_copy, ds, sizeof(data_set_t));
1355 ds_copy->ds = malloc(sizeof(*ds_copy->ds) * ds->ds_num);
1356 if (ds_copy->ds == NULL) {
1361 for (size_t i = 0; i < ds->ds_num; i++)
1362 memcpy(ds_copy->ds + i, ds->ds + i, sizeof(data_source_t));
1364 return c_avl_insert(data_sets, (void *)ds_copy->type, (void *)ds_copy);
1365 } /* int plugin_register_data_set */
1367 int plugin_register_log(const char *name, plugin_log_cb callback,
1368 user_data_t const *ud) {
1369 return create_register_callback(&list_log, name, (void *)callback, ud);
1370 } /* int plugin_register_log */
1372 int plugin_register_notification(const char *name,
1373 plugin_notification_cb callback,
1374 user_data_t const *ud) {
1375 return create_register_callback(&list_notification, name, (void *)callback,
1377 } /* int plugin_register_log */
1379 int plugin_unregister_config(const char *name) {
1380 cf_unregister(name);
1382 } /* int plugin_unregister_config */
1384 int plugin_unregister_complex_config(const char *name) {
1385 cf_unregister_complex(name);
1387 } /* int plugin_unregister_complex_config */
1389 int plugin_unregister_init(const char *name) {
1390 return plugin_unregister(list_init, name);
1393 int plugin_unregister_read(const char *name) /* {{{ */
1401 pthread_mutex_lock(&read_lock);
1403 if (read_list == NULL) {
1404 pthread_mutex_unlock(&read_lock);
1408 le = llist_search(read_list, name);
1410 pthread_mutex_unlock(&read_lock);
1411 WARNING("plugin_unregister_read: No such read function: %s", name);
1415 llist_remove(read_list, le);
1419 rf->rf_type = RF_REMOVE;
1421 pthread_mutex_unlock(&read_lock);
1423 llentry_destroy(le);
1425 DEBUG("plugin_unregister_read: Marked `%s' for removal.", name);
1428 } /* }}} int plugin_unregister_read */
1430 void plugin_log_available_writers(void) {
1431 log_list_callbacks(&list_write, "Available write targets:");
1434 static int compare_read_func_group(llentry_t *e, void *ud) /* {{{ */
1436 read_func_t *rf = e->value;
1439 return strcmp(rf->rf_group, (const char *)group);
1440 } /* }}} int compare_read_func_group */
1442 int plugin_unregister_read_group(const char *group) /* {{{ */
1452 pthread_mutex_lock(&read_lock);
1454 if (read_list == NULL) {
1455 pthread_mutex_unlock(&read_lock);
1460 le = llist_search_custom(read_list, compare_read_func_group, (void *)group);
1467 llist_remove(read_list, le);
1471 rf->rf_type = RF_REMOVE;
1473 llentry_destroy(le);
1475 DEBUG("plugin_unregister_read_group: "
1476 "Marked `%s' (group `%s') for removal.",
1477 rf->rf_name, group);
1480 pthread_mutex_unlock(&read_lock);
1483 WARNING("plugin_unregister_read_group: No such "
1484 "group of read function: %s",
1490 } /* }}} int plugin_unregister_read_group */
1492 int plugin_unregister_write(const char *name) {
1493 return plugin_unregister(list_write, name);
1496 int plugin_unregister_flush(const char *name) {
1497 plugin_ctx_t ctx = plugin_get_ctx();
1499 if (ctx.flush_interval != 0) {
1502 flush_name = plugin_flush_callback_name(name);
1503 if (flush_name != NULL) {
1504 plugin_unregister_read(flush_name);
1509 return plugin_unregister(list_flush, name);
1512 int plugin_unregister_missing(const char *name) {
1513 return plugin_unregister(list_missing, name);
1516 int plugin_unregister_shutdown(const char *name) {
1517 return plugin_unregister(list_shutdown, name);
1520 int plugin_unregister_data_set(const char *name) {
1523 if (data_sets == NULL)
1526 if (c_avl_remove(data_sets, name, NULL, (void *)&ds) != 0)
1533 } /* int plugin_unregister_data_set */
1535 int plugin_unregister_log(const char *name) {
1536 return plugin_unregister(list_log, name);
1539 int plugin_unregister_notification(const char *name) {
1540 return plugin_unregister(list_notification, name);
1543 int plugin_init_all(void) {
1544 char const *chain_name;
1549 /* Init the value cache */
1552 if (IS_TRUE(global_option_get("CollectInternalStats"))) {
1553 record_statistics = true;
1554 plugin_register_read("collectd", plugin_update_internal_statistics);
1557 chain_name = global_option_get("PreCacheChain");
1558 pre_cache_chain = fc_chain_get_by_name(chain_name);
1560 chain_name = global_option_get("PostCacheChain");
1561 post_cache_chain = fc_chain_get_by_name(chain_name);
1563 write_limit_high = global_option_get_long("WriteQueueLimitHigh",
1565 if (write_limit_high < 0) {
1566 ERROR("WriteQueueLimitHigh must be positive or zero.");
1567 write_limit_high = 0;
1571 global_option_get_long("WriteQueueLimitLow",
1572 /* default = */ write_limit_high / 2);
1573 if (write_limit_low < 0) {
1574 ERROR("WriteQueueLimitLow must be positive or zero.");
1575 write_limit_low = write_limit_high / 2;
1576 } else if (write_limit_low > write_limit_high) {
1577 ERROR("WriteQueueLimitLow must not be larger than "
1578 "WriteQueueLimitHigh.");
1579 write_limit_low = write_limit_high;
1582 write_threads_num = global_option_get_long("WriteThreads",
1584 if (write_threads_num < 1) {
1585 ERROR("WriteThreads must be positive.");
1586 write_threads_num = 5;
1589 if ((list_init == NULL) && (read_heap == NULL))
1592 /* Calling all init callbacks before checking if read callbacks
1593 * are available allows the init callbacks to register the read
1595 le = llist_head(list_init);
1596 while (le != NULL) {
1597 callback_func_t *cf;
1598 plugin_init_cb callback;
1599 plugin_ctx_t old_ctx;
1602 old_ctx = plugin_set_ctx(cf->cf_ctx);
1603 callback = cf->cf_callback;
1604 status = (*callback)();
1605 plugin_set_ctx(old_ctx);
1608 ERROR("Initialization of plugin `%s' "
1609 "failed with status %i. "
1610 "Plugin will be unloaded.",
1612 /* Plugins that register read callbacks from the init
1613 * callback should take care of appropriate error
1614 * handling themselves. */
1615 /* FIXME: Unload _all_ functions */
1616 plugin_unregister_read(le->key);
1623 start_write_threads((size_t)write_threads_num);
1626 global_option_get_time("MaxReadInterval", DEFAULT_MAX_READ_INTERVAL);
1628 /* Start read-threads */
1629 if (read_heap != NULL) {
1633 rt = global_option_get("ReadThreads");
1636 start_read_threads((num > 0) ? ((size_t)num) : 5);
1639 } /* void plugin_init_all */
1641 /* TODO: Rename this function. */
1642 void plugin_read_all(void) {
1646 } /* void plugin_read_all */
1648 /* Read function called when the `-T' command line argument is given. */
1649 int plugin_read_all_once(void) {
1651 int return_status = 0;
1653 if (read_heap == NULL) {
1654 NOTICE("No read-functions are registered.");
1660 plugin_ctx_t old_ctx;
1662 rf = c_heap_get_root(read_heap);
1666 old_ctx = plugin_set_ctx(rf->rf_ctx);
1668 if (rf->rf_type == RF_SIMPLE) {
1669 int (*callback)(void);
1671 callback = rf->rf_callback;
1672 status = (*callback)();
1674 plugin_read_cb callback;
1676 callback = rf->rf_callback;
1677 status = (*callback)(&rf->rf_udata);
1680 plugin_set_ctx(old_ctx);
1683 NOTICE("read-function of plugin `%s' failed.", rf->rf_name);
1688 destroy_callback((void *)rf);
1691 return return_status;
1692 } /* int plugin_read_all_once */
1694 int plugin_write(const char *plugin, /* {{{ */
1695 const data_set_t *ds, const value_list_t *vl) {
1702 if (list_write == NULL)
1706 ds = plugin_get_ds(vl->type);
1708 ERROR("plugin_write: Unable to lookup type `%s'.", vl->type);
1713 if (plugin == NULL) {
1717 le = llist_head(list_write);
1718 while (le != NULL) {
1719 callback_func_t *cf = le->value;
1720 plugin_write_cb callback;
1722 /* Keep the read plugin's interval and flush information but update the
1724 plugin_ctx_t old_ctx = plugin_get_ctx();
1725 plugin_ctx_t ctx = old_ctx;
1726 ctx.name = cf->cf_ctx.name;
1727 plugin_set_ctx(ctx);
1729 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1730 callback = cf->cf_callback;
1731 status = (*callback)(ds, vl, &cf->cf_udata);
1737 plugin_set_ctx(old_ctx);
1741 if ((success == 0) && (failure != 0))
1745 } else /* plugin != NULL */
1747 callback_func_t *cf;
1748 plugin_write_cb callback;
1750 le = llist_head(list_write);
1751 while (le != NULL) {
1752 if (strcasecmp(plugin, le->key) == 0)
1763 /* do not switch plugin context; rather keep the context (interval)
1764 * information of the calling read plugin */
1766 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1767 callback = cf->cf_callback;
1768 status = (*callback)(ds, vl, &cf->cf_udata);
1772 } /* }}} int plugin_write */
1774 int plugin_flush(const char *plugin, cdtime_t timeout, const char *identifier) {
1777 if (list_flush == NULL)
1780 le = llist_head(list_flush);
1781 while (le != NULL) {
1782 callback_func_t *cf;
1783 plugin_flush_cb callback;
1784 plugin_ctx_t old_ctx;
1786 if ((plugin != NULL) && (strcmp(plugin, le->key) != 0)) {
1792 old_ctx = plugin_set_ctx(cf->cf_ctx);
1793 callback = cf->cf_callback;
1795 (*callback)(timeout, identifier, &cf->cf_udata);
1797 plugin_set_ctx(old_ctx);
1802 } /* int plugin_flush */
1804 int plugin_shutdown_all(void) {
1806 int ret = 0; // Assume success.
1808 destroy_all_callbacks(&list_init);
1810 stop_read_threads();
1812 pthread_mutex_lock(&read_lock);
1813 llist_destroy(read_list);
1815 pthread_mutex_unlock(&read_lock);
1817 destroy_read_heap();
1819 /* blocks until all write threads have shut down. */
1820 stop_write_threads();
1822 /* ask all plugins to write out the state they kept. */
1823 plugin_flush(/* plugin = */ NULL,
1825 /* identifier = */ NULL);
1828 if (list_shutdown != NULL)
1829 le = llist_head(list_shutdown);
1831 while (le != NULL) {
1832 callback_func_t *cf;
1833 plugin_shutdown_cb callback;
1834 plugin_ctx_t old_ctx;
1837 old_ctx = plugin_set_ctx(cf->cf_ctx);
1838 callback = cf->cf_callback;
1840 /* Advance the pointer before calling the callback allows
1841 * shutdown functions to unregister themselves. If done the
1842 * other way around the memory `le' points to will be freed
1843 * after callback returns. */
1846 if ((*callback)() != 0)
1849 plugin_set_ctx(old_ctx);
1852 /* Write plugins which use the `user_data' pointer usually need the
1853 * same data available to the flush callback. If this is the case, set
1854 * the free_function to NULL when registering the flush callback and to
1855 * the real free function when registering the write callback. This way
1856 * the data isn't freed twice. */
1857 destroy_all_callbacks(&list_flush);
1858 destroy_all_callbacks(&list_missing);
1859 destroy_all_callbacks(&list_write);
1861 destroy_all_callbacks(&list_notification);
1862 destroy_all_callbacks(&list_shutdown);
1863 destroy_all_callbacks(&list_log);
1865 plugin_free_loaded();
1866 plugin_free_data_sets();
1868 } /* void plugin_shutdown_all */
1870 int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1872 if (list_missing == NULL)
1875 llentry_t *le = llist_head(list_missing);
1876 while (le != NULL) {
1877 callback_func_t *cf = le->value;
1878 plugin_ctx_t old_ctx = plugin_set_ctx(cf->cf_ctx);
1879 plugin_missing_cb callback = cf->cf_callback;
1881 int status = (*callback)(vl, &cf->cf_udata);
1882 plugin_set_ctx(old_ctx);
1885 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1886 "failed with status %i.",
1897 } /* int }}} plugin_dispatch_missing */
1899 static int plugin_dispatch_values_internal(value_list_t *vl) {
1901 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1903 bool free_meta_data = false;
1907 /* These fields are initialized by plugin_value_list_clone() if needed: */
1908 assert(vl->host[0] != 0);
1909 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1910 assert(vl->interval != 0);
1912 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1913 ERROR("plugin_dispatch_values: Invalid value list "
1919 /* Free meta data only if the calling function didn't specify any. In
1920 * this case matches and targets may add some and the calling function
1921 * may not expect (and therefore free) that data. */
1922 if (vl->meta == NULL)
1923 free_meta_data = true;
1925 if (list_write == NULL)
1926 c_complain_once(LOG_WARNING, &no_write_complaint,
1927 "plugin_dispatch_values: No write callback has been "
1928 "registered. Please load at least one output plugin, "
1929 "if you want the collected data to be stored.");
1931 if (data_sets == NULL) {
1932 ERROR("plugin_dispatch_values: No data sets registered. "
1933 "Could the types database be read? Check "
1934 "your `TypesDB' setting!");
1938 data_set_t *ds = NULL;
1939 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1940 char ident[6 * DATA_MAX_NAME_LEN];
1942 FORMAT_VL(ident, sizeof(ident), vl);
1943 INFO("plugin_dispatch_values: Dataset not found: %s "
1944 "(from \"%s\"), check your types.db!",
1949 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1951 "plugin = %s; plugin_instance = %s; "
1952 "type = %s; type_instance = %s;",
1953 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1954 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1957 assert(0 == strcmp(ds->type, vl->type));
1959 if (0 != strcmp(ds->type, vl->type))
1960 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1961 ds->type, vl->type);
1965 assert(ds->ds_num == vl->values_len);
1967 if (ds->ds_num != vl->values_len) {
1968 ERROR("plugin_dispatch_values: ds->type = %s: "
1969 "(ds->ds_num = %" PRIsz ") != "
1970 "(vl->values_len = %" PRIsz ")",
1971 ds->type, ds->ds_num, vl->values_len);
1976 escape_slashes(vl->host, sizeof(vl->host));
1977 escape_slashes(vl->plugin, sizeof(vl->plugin));
1978 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
1979 escape_slashes(vl->type, sizeof(vl->type));
1980 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
1982 if (pre_cache_chain != NULL) {
1983 status = fc_process_chain(ds, vl, pre_cache_chain);
1985 WARNING("plugin_dispatch_values: Running the "
1986 "pre-cache chain failed with "
1989 } else if (status == FC_TARGET_STOP)
1993 /* Update the value cache */
1996 if (post_cache_chain != NULL) {
1997 status = fc_process_chain(ds, vl, post_cache_chain);
1999 WARNING("plugin_dispatch_values: Running the "
2000 "post-cache chain failed with "
2005 fc_default_action(ds, vl);
2007 if ((free_meta_data == true) && (vl->meta != NULL)) {
2008 meta_data_destroy(vl->meta);
2013 } /* int plugin_dispatch_values_internal */
2015 static double get_drop_probability(void) /* {{{ */
2021 pthread_mutex_lock(&write_lock);
2022 wql = write_queue_length;
2023 pthread_mutex_unlock(&write_lock);
2025 if (wql < write_limit_low)
2027 if (wql >= write_limit_high)
2030 pos = 1 + wql - write_limit_low;
2031 size = 1 + write_limit_high - write_limit_low;
2033 return (double)pos / (double)size;
2034 } /* }}} double get_drop_probability */
2036 static bool check_drop_value(void) /* {{{ */
2038 static cdtime_t last_message_time;
2039 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2045 if (write_limit_high == 0)
2048 p = get_drop_probability();
2052 status = pthread_mutex_trylock(&last_message_lock);
2057 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2058 last_message_time = now;
2059 ERROR("plugin_dispatch_values: Low water mark "
2060 "reached. Dropping %.0f%% of metrics.",
2063 pthread_mutex_unlock(&last_message_lock);
2074 } /* }}} bool check_drop_value */
2076 int plugin_dispatch_values(value_list_t const *vl) {
2078 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2080 if (check_drop_value()) {
2081 if (record_statistics) {
2082 pthread_mutex_lock(&statistics_lock);
2083 stats_values_dropped++;
2084 pthread_mutex_unlock(&statistics_lock);
2089 status = plugin_write_enqueue(vl);
2091 ERROR("plugin_dispatch_values: plugin_write_enqueue failed with status %i "
2093 status, STRERROR(status));
2100 __attribute__((sentinel)) int
2101 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2102 bool store_percentage, int store_type, ...) {
2108 assert(template->values_len == 1);
2110 /* Calculate sum for Gauge to calculate percent if needed */
2111 if (DS_TYPE_GAUGE == store_type) {
2112 va_start(ap, store_type);
2117 name = va_arg(ap, char const *);
2121 value = va_arg(ap, gauge_t);
2128 vl = plugin_value_list_clone(template);
2129 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2130 if (store_percentage)
2131 sstrncpy(vl->type, "percent", sizeof(vl->type));
2133 va_start(ap, store_type);
2138 /* Set the type instance. */
2139 name = va_arg(ap, char const *);
2142 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2144 /* Set the value. */
2145 switch (store_type) {
2147 vl->values[0].gauge = va_arg(ap, gauge_t);
2148 if (store_percentage)
2149 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2151 case DS_TYPE_ABSOLUTE:
2152 vl->values[0].absolute = va_arg(ap, absolute_t);
2154 case DS_TYPE_COUNTER:
2155 vl->values[0].counter = va_arg(ap, counter_t);
2157 case DS_TYPE_DERIVE:
2158 vl->values[0].derive = va_arg(ap, derive_t);
2161 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2165 status = plugin_write_enqueue(vl);
2171 plugin_value_list_free(vl);
2173 } /* }}} int plugin_dispatch_multivalue */
2175 int plugin_dispatch_notification(const notification_t *notif) {
2177 /* Possible TODO: Add flap detection here */
2179 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2180 "time = %.3f; host = %s;",
2181 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2184 /* Nobody cares for notifications */
2185 if (list_notification == NULL)
2188 le = llist_head(list_notification);
2189 while (le != NULL) {
2190 callback_func_t *cf;
2191 plugin_notification_cb callback;
2194 /* do not switch plugin context; rather keep the context
2195 * (interval) information of the calling plugin */
2198 callback = cf->cf_callback;
2199 status = (*callback)(notif, &cf->cf_udata);
2201 WARNING("plugin_dispatch_notification: Notification "
2202 "callback %s returned %i.",
2210 } /* int plugin_dispatch_notification */
2212 void plugin_log(int level, const char *format, ...) {
2218 if (level >= LOG_DEBUG)
2222 va_start(ap, format);
2223 vsnprintf(msg, sizeof(msg), format, ap);
2224 msg[sizeof(msg) - 1] = '\0';
2227 if (list_log == NULL) {
2228 fprintf(stderr, "%s\n", msg);
2232 le = llist_head(list_log);
2233 while (le != NULL) {
2234 callback_func_t *cf;
2235 plugin_log_cb callback;
2238 callback = cf->cf_callback;
2240 /* do not switch plugin context; rather keep the context
2241 * (interval) information of the calling plugin */
2243 (*callback)(level, msg, &cf->cf_udata);
2247 } /* void plugin_log */
2249 void daemon_log(int level, const char *format, ...) {
2250 char msg[1024] = ""; // Size inherits from plugin_log()
2252 char const *name = plugin_get_ctx().name;
2257 va_start(ap, format);
2258 vsnprintf(msg, sizeof(msg), format, ap);
2261 plugin_log(level, "%s plugin: %s", name, msg);
2262 } /* void daemon_log */
2264 int parse_log_severity(const char *severity) {
2267 if ((0 == strcasecmp(severity, "emerg")) ||
2268 (0 == strcasecmp(severity, "alert")) ||
2269 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2270 log_level = LOG_ERR;
2271 else if (0 == strcasecmp(severity, "warning"))
2272 log_level = LOG_WARNING;
2273 else if (0 == strcasecmp(severity, "notice"))
2274 log_level = LOG_NOTICE;
2275 else if (0 == strcasecmp(severity, "info"))
2276 log_level = LOG_INFO;
2278 else if (0 == strcasecmp(severity, "debug"))
2279 log_level = LOG_DEBUG;
2280 #endif /* COLLECT_DEBUG */
2283 } /* int parse_log_severity */
2285 int parse_notif_severity(const char *severity) {
2286 int notif_severity = -1;
2288 if (strcasecmp(severity, "FAILURE") == 0)
2289 notif_severity = NOTIF_FAILURE;
2290 else if (strcmp(severity, "OKAY") == 0)
2291 notif_severity = NOTIF_OKAY;
2292 else if ((strcmp(severity, "WARNING") == 0) ||
2293 (strcmp(severity, "WARN") == 0))
2294 notif_severity = NOTIF_WARNING;
2296 return notif_severity;
2297 } /* int parse_notif_severity */
2299 const data_set_t *plugin_get_ds(const char *name) {
2302 if (data_sets == NULL) {
2303 ERROR("plugin_get_ds: No data sets are defined yet.");
2307 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2308 DEBUG("No such dataset registered: %s", name);
2313 } /* data_set_t *plugin_get_ds */
2315 static int plugin_notification_meta_add(notification_t *n, const char *name,
2316 enum notification_meta_type_e type,
2317 const void *value) {
2318 notification_meta_t *meta;
2319 notification_meta_t *tail;
2321 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2322 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2326 meta = calloc(1, sizeof(*meta));
2328 ERROR("plugin_notification_meta_add: calloc failed.");
2332 sstrncpy(meta->name, name, sizeof(meta->name));
2336 case NM_TYPE_STRING: {
2337 meta->nm_value.nm_string = strdup((const char *)value);
2338 if (meta->nm_value.nm_string == NULL) {
2339 ERROR("plugin_notification_meta_add: strdup failed.");
2345 case NM_TYPE_SIGNED_INT: {
2346 meta->nm_value.nm_signed_int = *((int64_t *)value);
2349 case NM_TYPE_UNSIGNED_INT: {
2350 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2353 case NM_TYPE_DOUBLE: {
2354 meta->nm_value.nm_double = *((double *)value);
2357 case NM_TYPE_BOOLEAN: {
2358 meta->nm_value.nm_boolean = *((bool *)value);
2362 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2366 } /* switch (type) */
2370 while ((tail != NULL) && (tail->next != NULL))
2379 } /* int plugin_notification_meta_add */
2381 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2382 const char *value) {
2383 return plugin_notification_meta_add(n, name, NM_TYPE_STRING, value);
2386 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2388 return plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value);
2391 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2394 return plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value);
2397 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2399 return plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value);
2402 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2404 return plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value);
2407 int plugin_notification_meta_copy(notification_t *dst,
2408 const notification_t *src) {
2409 assert(dst != NULL);
2410 assert(src != NULL);
2412 assert((src->meta == NULL) || (src->meta != dst->meta));
2414 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2415 if (meta->type == NM_TYPE_STRING)
2416 plugin_notification_meta_add_string(dst, meta->name,
2417 meta->nm_value.nm_string);
2418 else if (meta->type == NM_TYPE_SIGNED_INT)
2419 plugin_notification_meta_add_signed_int(dst, meta->name,
2420 meta->nm_value.nm_signed_int);
2421 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2422 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2423 meta->nm_value.nm_unsigned_int);
2424 else if (meta->type == NM_TYPE_DOUBLE)
2425 plugin_notification_meta_add_double(dst, meta->name,
2426 meta->nm_value.nm_double);
2427 else if (meta->type == NM_TYPE_BOOLEAN)
2428 plugin_notification_meta_add_boolean(dst, meta->name,
2429 meta->nm_value.nm_boolean);
2433 } /* int plugin_notification_meta_copy */
2435 int plugin_notification_meta_free(notification_meta_t *n) {
2436 notification_meta_t *this;
2437 notification_meta_t *next;
2440 ERROR("plugin_notification_meta_free: n == NULL!");
2445 while (this != NULL) {
2448 if (this->type == NM_TYPE_STRING) {
2449 /* Assign to a temporary variable to work around nm_string's const
2451 void *tmp = (void *)this->nm_value.nm_string;
2454 this->nm_value.nm_string = NULL;
2462 } /* int plugin_notification_meta_free */
2464 static void plugin_ctx_destructor(void *ctx) {
2466 } /* void plugin_ctx_destructor */
2468 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2470 static plugin_ctx_t *plugin_ctx_create(void) {
2473 ctx = malloc(sizeof(*ctx));
2475 ERROR("Failed to allocate plugin context: %s", STRERRNO);
2480 assert(plugin_ctx_key_initialized);
2481 pthread_setspecific(plugin_ctx_key, ctx);
2482 DEBUG("Created new plugin context.");
2484 } /* int plugin_ctx_create */
2486 void plugin_init_ctx(void) {
2487 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2488 plugin_ctx_key_initialized = true;
2489 } /* void plugin_init_ctx */
2491 plugin_ctx_t plugin_get_ctx(void) {
2494 assert(plugin_ctx_key_initialized);
2495 ctx = pthread_getspecific(plugin_ctx_key);
2498 ctx = plugin_ctx_create();
2499 /* this must no happen -- exit() instead? */
2505 } /* plugin_ctx_t plugin_get_ctx */
2507 plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2511 assert(plugin_ctx_key_initialized);
2512 c = pthread_getspecific(plugin_ctx_key);
2515 c = plugin_ctx_create();
2516 /* this must no happen -- exit() instead? */
2525 } /* void plugin_set_ctx */
2527 cdtime_t plugin_get_interval(void) {
2530 interval = plugin_get_ctx().interval;
2534 return cf_get_default_interval();
2535 } /* cdtime_t plugin_get_interval */
2539 void *(*start_routine)(void *);
2543 static void *plugin_thread_start(void *arg) {
2544 plugin_thread_t *plugin_thread = arg;
2546 void *(*start_routine)(void *) = plugin_thread->start_routine;
2547 void *plugin_arg = plugin_thread->arg;
2549 plugin_set_ctx(plugin_thread->ctx);
2551 sfree(plugin_thread);
2553 return start_routine(plugin_arg);
2554 } /* void *plugin_thread_start */
2556 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2557 void *(*start_routine)(void *), void *arg,
2559 plugin_thread_t *plugin_thread;
2561 plugin_thread = malloc(sizeof(*plugin_thread));
2562 if (plugin_thread == NULL)
2565 plugin_thread->ctx = plugin_get_ctx();
2566 plugin_thread->start_routine = start_routine;
2567 plugin_thread->arg = arg;
2569 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2571 sfree(plugin_thread);
2576 set_thread_name(*thread, name);
2579 } /* int plugin_thread_create */