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);
614 ERROR("set_thread_name(\"%s\"): %s", n,
615 sstrerror(status, errbuf, sizeof(errbuf)));
617 #else /* if defined(HAVE_PTHREAD_SET_NAME_NP) */
618 pthread_set_name_np(tid, n);
624 static void start_read_threads(size_t num) /* {{{ */
626 if (read_threads != NULL)
629 read_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
630 if (read_threads == NULL) {
631 ERROR("plugin: start_read_threads: calloc failed.");
635 read_threads_num = 0;
636 for (size_t i = 0; i < num; i++) {
637 int status = pthread_create(read_threads + read_threads_num,
638 /* attr = */ NULL, plugin_read_thread,
642 ERROR("plugin: start_read_threads: pthread_create failed "
643 "with status %i (%s).",
644 status, sstrerror(status, errbuf, sizeof(errbuf)));
648 char name[THREAD_NAME_MAX];
649 snprintf(name, sizeof(name), "reader#%zu", read_threads_num);
650 set_thread_name(read_threads[read_threads_num], name);
654 } /* }}} void start_read_threads */
656 static void stop_read_threads(void) {
657 if (read_threads == NULL)
660 INFO("collectd: Stopping %zu read threads.", read_threads_num);
662 pthread_mutex_lock(&read_lock);
664 DEBUG("plugin: stop_read_threads: Signalling `read_cond'");
665 pthread_cond_broadcast(&read_cond);
666 pthread_mutex_unlock(&read_lock);
668 for (size_t i = 0; i < read_threads_num; i++) {
669 if (pthread_join(read_threads[i], NULL) != 0) {
670 ERROR("plugin: stop_read_threads: pthread_join failed.");
672 read_threads[i] = (pthread_t)0;
675 read_threads_num = 0;
676 } /* void stop_read_threads */
678 static void plugin_value_list_free(value_list_t *vl) /* {{{ */
683 meta_data_destroy(vl->meta);
686 } /* }}} void plugin_value_list_free */
688 static value_list_t *
689 plugin_value_list_clone(value_list_t const *vl_orig) /* {{{ */
696 vl = malloc(sizeof(*vl));
699 memcpy(vl, vl_orig, sizeof(*vl));
701 if (vl->host[0] == 0)
702 sstrncpy(vl->host, hostname_g, sizeof(vl->host));
704 vl->values = calloc(vl_orig->values_len, sizeof(*vl->values));
705 if (vl->values == NULL) {
706 plugin_value_list_free(vl);
709 memcpy(vl->values, vl_orig->values,
710 vl_orig->values_len * sizeof(*vl->values));
712 vl->meta = meta_data_clone(vl->meta);
713 if ((vl_orig->meta != NULL) && (vl->meta == NULL)) {
714 plugin_value_list_free(vl);
721 /* Fill in the interval from the thread context, if it is zero. */
722 if (vl->interval == 0) {
723 plugin_ctx_t ctx = plugin_get_ctx();
725 if (ctx.interval != 0)
726 vl->interval = ctx.interval;
728 char name[6 * DATA_MAX_NAME_LEN];
729 FORMAT_VL(name, sizeof(name), vl);
730 ERROR("plugin_value_list_clone: Unable to determine "
731 "interval from context for "
732 "value list \"%s\". "
733 "This indicates a broken plugin. "
734 "Please report this problem to the "
735 "collectd mailing list or at "
736 "<http://collectd.org/bugs/>.",
738 vl->interval = cf_get_default_interval();
743 } /* }}} value_list_t *plugin_value_list_clone */
745 static int plugin_write_enqueue(value_list_t const *vl) /* {{{ */
749 q = malloc(sizeof(*q));
754 q->vl = plugin_value_list_clone(vl);
760 /* Store context of caller (read plugin); otherwise, it would not be
761 * available to the write plugins when actually dispatching the
762 * value-list later on. */
763 q->ctx = plugin_get_ctx();
765 pthread_mutex_lock(&write_lock);
767 if (write_queue_tail == NULL) {
768 write_queue_head = q;
769 write_queue_tail = q;
770 write_queue_length = 1;
772 write_queue_tail->next = q;
773 write_queue_tail = q;
774 write_queue_length += 1;
777 pthread_cond_signal(&write_cond);
778 pthread_mutex_unlock(&write_lock);
781 } /* }}} int plugin_write_enqueue */
783 static value_list_t *plugin_write_dequeue(void) /* {{{ */
788 pthread_mutex_lock(&write_lock);
790 while (write_loop && (write_queue_head == NULL))
791 pthread_cond_wait(&write_cond, &write_lock);
793 if (write_queue_head == NULL) {
794 pthread_mutex_unlock(&write_lock);
798 q = write_queue_head;
799 write_queue_head = q->next;
800 write_queue_length -= 1;
801 if (write_queue_head == NULL) {
802 write_queue_tail = NULL;
803 assert(0 == write_queue_length);
806 pthread_mutex_unlock(&write_lock);
808 (void)plugin_set_ctx(q->ctx);
813 } /* }}} value_list_t *plugin_write_dequeue */
815 static void *plugin_write_thread(void __attribute__((unused)) * args) /* {{{ */
818 value_list_t *vl = plugin_write_dequeue();
822 plugin_dispatch_values_internal(vl);
824 plugin_value_list_free(vl);
829 } /* }}} void *plugin_write_thread */
831 static void start_write_threads(size_t num) /* {{{ */
833 if (write_threads != NULL)
836 write_threads = (pthread_t *)calloc(num, sizeof(pthread_t));
837 if (write_threads == NULL) {
838 ERROR("plugin: start_write_threads: calloc failed.");
842 write_threads_num = 0;
843 for (size_t i = 0; i < num; i++) {
844 int status = pthread_create(write_threads + write_threads_num,
845 /* attr = */ NULL, plugin_write_thread,
849 ERROR("plugin: start_write_threads: pthread_create failed "
850 "with status %i (%s).",
851 status, sstrerror(status, errbuf, sizeof(errbuf)));
855 char name[THREAD_NAME_MAX];
856 snprintf(name, sizeof(name), "writer#%zu", write_threads_num);
857 set_thread_name(write_threads[write_threads_num], name);
861 } /* }}} void start_write_threads */
863 static void stop_write_threads(void) /* {{{ */
868 if (write_threads == NULL)
871 INFO("collectd: Stopping %zu write threads.", write_threads_num);
873 pthread_mutex_lock(&write_lock);
875 DEBUG("plugin: stop_write_threads: Signalling `write_cond'");
876 pthread_cond_broadcast(&write_cond);
877 pthread_mutex_unlock(&write_lock);
879 for (i = 0; i < write_threads_num; i++) {
880 if (pthread_join(write_threads[i], NULL) != 0) {
881 ERROR("plugin: stop_write_threads: pthread_join failed.");
883 write_threads[i] = (pthread_t)0;
885 sfree(write_threads);
886 write_threads_num = 0;
888 pthread_mutex_lock(&write_lock);
890 for (q = write_queue_head; q != NULL;) {
891 write_queue_t *q1 = q;
892 plugin_value_list_free(q->vl);
897 write_queue_head = NULL;
898 write_queue_tail = NULL;
899 write_queue_length = 0;
900 pthread_mutex_unlock(&write_lock);
903 WARNING("plugin: %zu value list%s left after shutting down "
904 "the write threads.",
905 i, (i == 1) ? " was" : "s were");
907 } /* }}} void stop_write_threads */
912 void plugin_set_dir(const char *dir) {
920 plugindir = strdup(dir);
921 if (plugindir == NULL)
922 ERROR("plugin_set_dir: strdup(\"%s\") failed", dir);
925 static _Bool plugin_is_loaded(char const *name) {
928 if (plugins_loaded == NULL)
930 c_avl_create((int (*)(const void *, const void *))strcasecmp);
931 assert(plugins_loaded != NULL);
933 status = c_avl_get(plugins_loaded, name, /* ret_value = */ NULL);
937 static int plugin_mark_loaded(char const *name) {
941 name_copy = strdup(name);
942 if (name_copy == NULL)
945 status = c_avl_insert(plugins_loaded,
946 /* key = */ name_copy, /* value = */ NULL);
950 static void plugin_free_loaded(void) {
954 if (plugins_loaded == NULL)
957 while (c_avl_pick(plugins_loaded, &key, &value) == 0) {
959 assert(value == NULL);
962 c_avl_destroy(plugins_loaded);
963 plugins_loaded = NULL;
967 int plugin_load(char const *plugin_name, _Bool global) {
970 char filename[BUFSIZE] = "";
971 char typename[BUFSIZE];
977 if (plugin_name == NULL)
980 /* Check if plugin is already loaded and don't do anything in this
982 if (plugin_is_loaded(plugin_name))
985 dir = plugin_get_dir();
989 * XXX: Magic at work:
991 * Some of the language bindings, for example the Python and Perl
992 * plugins, need to be able to export symbols to the scripts they run.
993 * For this to happen, the "Globals" flag needs to be set.
994 * Unfortunately, this technical detail is hard to explain to the
995 * average user and she shouldn't have to worry about this, ideally.
996 * So in order to save everyone's sanity use a different default for a
997 * handful of special plugins. --octo
999 if ((strcasecmp("perl", plugin_name) == 0) ||
1000 (strcasecmp("python", plugin_name) == 0))
1003 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
1004 * type when matching the filename */
1005 status = snprintf(typename, sizeof(typename), "%s.so", plugin_name);
1006 if ((status < 0) || ((size_t)status >= sizeof(typename))) {
1007 WARNING("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1011 if ((dh = opendir(dir)) == NULL) {
1013 ERROR("plugin_load: opendir (%s) failed: %s", dir,
1014 sstrerror(errno, errbuf, sizeof(errbuf)));
1018 while ((de = readdir(dh)) != NULL) {
1019 if (strcasecmp(de->d_name, typename))
1022 status = snprintf(filename, sizeof(filename), "%s/%s", dir, de->d_name);
1023 if ((status < 0) || ((size_t)status >= sizeof(filename))) {
1024 WARNING("plugin_load: Filename too long: \"%s/%s\"", dir, de->d_name);
1028 if (lstat(filename, &statbuf) == -1) {
1030 WARNING("plugin_load: stat (\"%s\") failed: %s", filename,
1031 sstrerror(errno, errbuf, sizeof(errbuf)));
1033 } else if (!S_ISREG(statbuf.st_mode)) {
1034 /* don't follow symlinks */
1035 WARNING("plugin_load: %s is not a regular file.", filename);
1039 status = plugin_load_file(filename, global);
1042 plugin_mark_loaded(plugin_name);
1044 INFO("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1047 ERROR("plugin_load: Load plugin \"%s\" failed with "
1049 plugin_name, status);
1055 if (filename[0] == 0)
1056 ERROR("plugin_load: Could not find plugin \"%s\" in %s", plugin_name, dir);
1062 * The `register_*' functions follow
1064 int plugin_register_config(const char *name,
1065 int (*callback)(const char *key, const char *val),
1066 const char **keys, int keys_num) {
1067 cf_register(name, callback, keys, keys_num);
1069 } /* int plugin_register_config */
1071 int plugin_register_complex_config(const char *type,
1072 int (*callback)(oconfig_item_t *)) {
1073 return cf_register_complex(type, callback);
1074 } /* int plugin_register_complex_config */
1076 int plugin_register_init(const char *name, int (*callback)(void)) {
1077 return create_register_callback(&list_init, name, (void *)callback, NULL);
1078 } /* plugin_register_init */
1080 static int plugin_compare_read_func(const void *arg0, const void *arg1) {
1081 const read_func_t *rf0;
1082 const read_func_t *rf1;
1087 if (rf0->rf_next_read < rf1->rf_next_read)
1089 else if (rf0->rf_next_read > rf1->rf_next_read)
1093 } /* int plugin_compare_read_func */
1095 /* Add a read function to both, the heap and a linked list. The linked list if
1096 * used to look-up read functions, especially for the remove function. The heap
1097 * is used to determine which plugin to read next. */
1098 static int plugin_insert_read(read_func_t *rf) {
1102 rf->rf_next_read = cdtime();
1103 rf->rf_effective_interval = rf->rf_interval;
1105 pthread_mutex_lock(&read_lock);
1107 if (read_list == NULL) {
1108 read_list = llist_create();
1109 if (read_list == NULL) {
1110 pthread_mutex_unlock(&read_lock);
1111 ERROR("plugin_insert_read: read_list failed.");
1116 if (read_heap == NULL) {
1117 read_heap = c_heap_create(plugin_compare_read_func);
1118 if (read_heap == NULL) {
1119 pthread_mutex_unlock(&read_lock);
1120 ERROR("plugin_insert_read: c_heap_create failed.");
1125 le = llist_search(read_list, rf->rf_name);
1127 pthread_mutex_unlock(&read_lock);
1128 WARNING("The read function \"%s\" is already registered. "
1129 "Check for duplicates in your configuration!",
1134 le = llentry_create(rf->rf_name, rf);
1136 pthread_mutex_unlock(&read_lock);
1137 ERROR("plugin_insert_read: llentry_create failed.");
1141 status = c_heap_insert(read_heap, rf);
1143 pthread_mutex_unlock(&read_lock);
1144 ERROR("plugin_insert_read: c_heap_insert failed.");
1145 llentry_destroy(le);
1149 /* This does not fail. */
1150 llist_append(read_list, le);
1152 /* Wake up all the read threads. */
1153 pthread_cond_broadcast(&read_cond);
1154 pthread_mutex_unlock(&read_lock);
1156 } /* int plugin_insert_read */
1158 int plugin_register_read(const char *name, int (*callback)(void)) {
1162 rf = calloc(1, sizeof(*rf));
1164 ERROR("plugin_register_read: calloc failed.");
1168 rf->rf_callback = (void *)callback;
1169 rf->rf_udata.data = NULL;
1170 rf->rf_udata.free_func = NULL;
1171 rf->rf_ctx = plugin_get_ctx();
1172 rf->rf_group[0] = '\0';
1173 rf->rf_name = strdup(name);
1174 rf->rf_type = RF_SIMPLE;
1175 rf->rf_interval = plugin_get_interval();
1177 status = plugin_insert_read(rf);
1184 } /* int plugin_register_read */
1186 int plugin_register_complex_read(const char *group, const char *name,
1187 plugin_read_cb callback, cdtime_t interval,
1188 user_data_t const *user_data) {
1192 rf = calloc(1, sizeof(*rf));
1194 free_userdata(user_data);
1195 ERROR("plugin_register_complex_read: calloc failed.");
1199 rf->rf_callback = (void *)callback;
1201 sstrncpy(rf->rf_group, group, sizeof(rf->rf_group));
1203 rf->rf_group[0] = '\0';
1204 rf->rf_name = strdup(name);
1205 rf->rf_type = RF_COMPLEX;
1206 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval();
1209 if (user_data == NULL) {
1210 rf->rf_udata.data = NULL;
1211 rf->rf_udata.free_func = NULL;
1213 rf->rf_udata = *user_data;
1216 rf->rf_ctx = plugin_get_ctx();
1218 status = plugin_insert_read(rf);
1220 free_userdata(&rf->rf_udata);
1226 } /* int plugin_register_complex_read */
1228 int plugin_register_write(const char *name, plugin_write_cb callback,
1229 user_data_t const *ud) {
1230 return create_register_callback(&list_write, name, (void *)callback, ud);
1231 } /* int plugin_register_write */
1233 static int plugin_flush_timeout_callback(user_data_t *ud) {
1234 flush_callback_t *cb = ud->data;
1236 return plugin_flush(cb->name, cb->timeout, NULL);
1237 } /* static int plugin_flush_callback */
1239 static void plugin_flush_timeout_callback_free(void *data) {
1240 flush_callback_t *cb = data;
1247 } /* static void plugin_flush_callback_free */
1249 static char *plugin_flush_callback_name(const char *name) {
1250 const char *flush_prefix = "flush/";
1255 prefix_size = strlen(flush_prefix);
1256 name_size = strlen(name);
1258 flush_name = malloc(name_size + prefix_size + 1);
1259 if (flush_name == NULL) {
1260 ERROR("plugin_flush_callback_name: malloc failed.");
1264 sstrncpy(flush_name, flush_prefix, prefix_size + 1);
1265 sstrncpy(flush_name + prefix_size, name, name_size + 1);
1268 } /* static char *plugin_flush_callback_name */
1270 int plugin_register_flush(const char *name, plugin_flush_cb callback,
1271 user_data_t const *ud) {
1273 plugin_ctx_t ctx = plugin_get_ctx();
1275 status = create_register_callback(&list_flush, name, (void *)callback, ud);
1279 if (ctx.flush_interval != 0) {
1281 flush_callback_t *cb;
1283 flush_name = plugin_flush_callback_name(name);
1284 if (flush_name == NULL)
1287 cb = malloc(sizeof(*cb));
1289 ERROR("plugin_register_flush: malloc failed.");
1294 cb->name = strdup(name);
1295 if (cb->name == NULL) {
1296 ERROR("plugin_register_flush: strdup failed.");
1301 cb->timeout = ctx.flush_timeout;
1303 status = plugin_register_complex_read(
1304 /* group = */ "flush",
1305 /* name = */ flush_name,
1306 /* callback = */ plugin_flush_timeout_callback,
1307 /* interval = */ ctx.flush_interval,
1308 /* user data = */ &(user_data_t){
1309 .data = cb, .free_func = plugin_flush_timeout_callback_free,
1317 } /* int plugin_register_flush */
1319 int plugin_register_missing(const char *name, plugin_missing_cb callback,
1320 user_data_t const *ud) {
1321 return create_register_callback(&list_missing, name, (void *)callback, ud);
1322 } /* int plugin_register_missing */
1324 int plugin_register_shutdown(const char *name, int (*callback)(void)) {
1325 return create_register_callback(&list_shutdown, name, (void *)callback,
1327 } /* int plugin_register_shutdown */
1329 static void plugin_free_data_sets(void) {
1333 if (data_sets == NULL)
1336 while (c_avl_pick(data_sets, &key, &value) == 0) {
1337 data_set_t *ds = value;
1338 /* key is a pointer to ds->type */
1344 c_avl_destroy(data_sets);
1346 } /* void plugin_free_data_sets */
1348 int plugin_register_data_set(const data_set_t *ds) {
1349 data_set_t *ds_copy;
1351 if ((data_sets != NULL) && (c_avl_get(data_sets, ds->type, NULL) == 0)) {
1352 NOTICE("Replacing DS `%s' with another version.", ds->type);
1353 plugin_unregister_data_set(ds->type);
1354 } else if (data_sets == NULL) {
1355 data_sets = c_avl_create((int (*)(const void *, const void *))strcmp);
1356 if (data_sets == NULL)
1360 ds_copy = malloc(sizeof(*ds_copy));
1361 if (ds_copy == NULL)
1363 memcpy(ds_copy, ds, sizeof(data_set_t));
1365 ds_copy->ds = malloc(sizeof(*ds_copy->ds) * ds->ds_num);
1366 if (ds_copy->ds == NULL) {
1371 for (size_t i = 0; i < ds->ds_num; i++)
1372 memcpy(ds_copy->ds + i, ds->ds + i, sizeof(data_source_t));
1374 return c_avl_insert(data_sets, (void *)ds_copy->type, (void *)ds_copy);
1375 } /* int plugin_register_data_set */
1377 int plugin_register_log(const char *name, plugin_log_cb callback,
1378 user_data_t const *ud) {
1379 return create_register_callback(&list_log, name, (void *)callback, ud);
1380 } /* int plugin_register_log */
1382 int plugin_register_notification(const char *name,
1383 plugin_notification_cb callback,
1384 user_data_t const *ud) {
1385 return create_register_callback(&list_notification, name, (void *)callback,
1387 } /* int plugin_register_log */
1389 int plugin_unregister_config(const char *name) {
1390 cf_unregister(name);
1392 } /* int plugin_unregister_config */
1394 int plugin_unregister_complex_config(const char *name) {
1395 cf_unregister_complex(name);
1397 } /* int plugin_unregister_complex_config */
1399 int plugin_unregister_init(const char *name) {
1400 return plugin_unregister(list_init, name);
1403 int plugin_unregister_read(const char *name) /* {{{ */
1411 pthread_mutex_lock(&read_lock);
1413 if (read_list == NULL) {
1414 pthread_mutex_unlock(&read_lock);
1418 le = llist_search(read_list, name);
1420 pthread_mutex_unlock(&read_lock);
1421 WARNING("plugin_unregister_read: No such read function: %s", name);
1425 llist_remove(read_list, le);
1429 rf->rf_type = RF_REMOVE;
1431 pthread_mutex_unlock(&read_lock);
1433 llentry_destroy(le);
1435 DEBUG("plugin_unregister_read: Marked `%s' for removal.", name);
1438 } /* }}} int plugin_unregister_read */
1440 void plugin_log_available_writers(void) {
1441 log_list_callbacks(&list_write, "Available write targets:");
1444 static int compare_read_func_group(llentry_t *e, void *ud) /* {{{ */
1446 read_func_t *rf = e->value;
1449 return strcmp(rf->rf_group, (const char *)group);
1450 } /* }}} int compare_read_func_group */
1452 int plugin_unregister_read_group(const char *group) /* {{{ */
1462 pthread_mutex_lock(&read_lock);
1464 if (read_list == NULL) {
1465 pthread_mutex_unlock(&read_lock);
1470 le = llist_search_custom(read_list, compare_read_func_group, (void *)group);
1477 llist_remove(read_list, le);
1481 rf->rf_type = RF_REMOVE;
1483 llentry_destroy(le);
1485 DEBUG("plugin_unregister_read_group: "
1486 "Marked `%s' (group `%s') for removal.",
1487 rf->rf_name, group);
1490 pthread_mutex_unlock(&read_lock);
1493 WARNING("plugin_unregister_read_group: No such "
1494 "group of read function: %s",
1500 } /* }}} int plugin_unregister_read_group */
1502 int plugin_unregister_write(const char *name) {
1503 return plugin_unregister(list_write, name);
1506 int plugin_unregister_flush(const char *name) {
1507 plugin_ctx_t ctx = plugin_get_ctx();
1509 if (ctx.flush_interval != 0) {
1512 flush_name = plugin_flush_callback_name(name);
1513 if (flush_name != NULL) {
1514 plugin_unregister_read(flush_name);
1519 return plugin_unregister(list_flush, name);
1522 int plugin_unregister_missing(const char *name) {
1523 return plugin_unregister(list_missing, name);
1526 int plugin_unregister_shutdown(const char *name) {
1527 return plugin_unregister(list_shutdown, name);
1530 int plugin_unregister_data_set(const char *name) {
1533 if (data_sets == NULL)
1536 if (c_avl_remove(data_sets, name, NULL, (void *)&ds) != 0)
1543 } /* int plugin_unregister_data_set */
1545 int plugin_unregister_log(const char *name) {
1546 return plugin_unregister(list_log, name);
1549 int plugin_unregister_notification(const char *name) {
1550 return plugin_unregister(list_notification, name);
1553 int plugin_init_all(void) {
1554 char const *chain_name;
1559 /* Init the value cache */
1562 if (IS_TRUE(global_option_get("CollectInternalStats"))) {
1563 record_statistics = 1;
1564 plugin_register_read("collectd", plugin_update_internal_statistics);
1567 chain_name = global_option_get("PreCacheChain");
1568 pre_cache_chain = fc_chain_get_by_name(chain_name);
1570 chain_name = global_option_get("PostCacheChain");
1571 post_cache_chain = fc_chain_get_by_name(chain_name);
1573 write_limit_high = global_option_get_long("WriteQueueLimitHigh",
1575 if (write_limit_high < 0) {
1576 ERROR("WriteQueueLimitHigh must be positive or zero.");
1577 write_limit_high = 0;
1581 global_option_get_long("WriteQueueLimitLow",
1582 /* default = */ write_limit_high / 2);
1583 if (write_limit_low < 0) {
1584 ERROR("WriteQueueLimitLow must be positive or zero.");
1585 write_limit_low = write_limit_high / 2;
1586 } else if (write_limit_low > write_limit_high) {
1587 ERROR("WriteQueueLimitLow must not be larger than "
1588 "WriteQueueLimitHigh.");
1589 write_limit_low = write_limit_high;
1592 write_threads_num = global_option_get_long("WriteThreads",
1594 if (write_threads_num < 1) {
1595 ERROR("WriteThreads must be positive.");
1596 write_threads_num = 5;
1599 if ((list_init == NULL) && (read_heap == NULL))
1602 /* Calling all init callbacks before checking if read callbacks
1603 * are available allows the init callbacks to register the read
1605 le = llist_head(list_init);
1606 while (le != NULL) {
1607 callback_func_t *cf;
1608 plugin_init_cb callback;
1609 plugin_ctx_t old_ctx;
1612 old_ctx = plugin_set_ctx(cf->cf_ctx);
1613 callback = cf->cf_callback;
1614 status = (*callback)();
1615 plugin_set_ctx(old_ctx);
1618 ERROR("Initialization of plugin `%s' "
1619 "failed with status %i. "
1620 "Plugin will be unloaded.",
1622 /* Plugins that register read callbacks from the init
1623 * callback should take care of appropriate error
1624 * handling themselves. */
1625 /* FIXME: Unload _all_ functions */
1626 plugin_unregister_read(le->key);
1633 start_write_threads((size_t)write_threads_num);
1636 global_option_get_time("MaxReadInterval", DEFAULT_MAX_READ_INTERVAL);
1638 /* Start read-threads */
1639 if (read_heap != NULL) {
1643 rt = global_option_get("ReadThreads");
1646 start_read_threads((num > 0) ? ((size_t)num) : 5);
1649 } /* void plugin_init_all */
1651 /* TODO: Rename this function. */
1652 void plugin_read_all(void) {
1656 } /* void plugin_read_all */
1658 /* Read function called when the `-T' command line argument is given. */
1659 int plugin_read_all_once(void) {
1661 int return_status = 0;
1663 if (read_heap == NULL) {
1664 NOTICE("No read-functions are registered.");
1670 plugin_ctx_t old_ctx;
1672 rf = c_heap_get_root(read_heap);
1676 old_ctx = plugin_set_ctx(rf->rf_ctx);
1678 if (rf->rf_type == RF_SIMPLE) {
1679 int (*callback)(void);
1681 callback = rf->rf_callback;
1682 status = (*callback)();
1684 plugin_read_cb callback;
1686 callback = rf->rf_callback;
1687 status = (*callback)(&rf->rf_udata);
1690 plugin_set_ctx(old_ctx);
1693 NOTICE("read-function of plugin `%s' failed.", rf->rf_name);
1698 destroy_callback((void *)rf);
1701 return return_status;
1702 } /* int plugin_read_all_once */
1704 int plugin_write(const char *plugin, /* {{{ */
1705 const data_set_t *ds, const value_list_t *vl) {
1712 if (list_write == NULL)
1716 ds = plugin_get_ds(vl->type);
1718 ERROR("plugin_write: Unable to lookup type `%s'.", vl->type);
1723 if (plugin == NULL) {
1727 le = llist_head(list_write);
1728 while (le != NULL) {
1729 callback_func_t *cf = le->value;
1730 plugin_write_cb callback;
1732 /* do not switch plugin context; rather keep the context (interval)
1733 * information of the calling read plugin */
1735 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1736 callback = cf->cf_callback;
1737 status = (*callback)(ds, vl, &cf->cf_udata);
1746 if ((success == 0) && (failure != 0))
1750 } else /* plugin != NULL */
1752 callback_func_t *cf;
1753 plugin_write_cb callback;
1755 le = llist_head(list_write);
1756 while (le != NULL) {
1757 if (strcasecmp(plugin, le->key) == 0)
1768 /* do not switch plugin context; rather keep the context (interval)
1769 * information of the calling read plugin */
1771 DEBUG("plugin: plugin_write: Writing values via %s.", le->key);
1772 callback = cf->cf_callback;
1773 status = (*callback)(ds, vl, &cf->cf_udata);
1777 } /* }}} int plugin_write */
1779 int plugin_flush(const char *plugin, cdtime_t timeout, const char *identifier) {
1782 if (list_flush == NULL)
1785 le = llist_head(list_flush);
1786 while (le != NULL) {
1787 callback_func_t *cf;
1788 plugin_flush_cb callback;
1789 plugin_ctx_t old_ctx;
1791 if ((plugin != NULL) && (strcmp(plugin, le->key) != 0)) {
1797 old_ctx = plugin_set_ctx(cf->cf_ctx);
1798 callback = cf->cf_callback;
1800 (*callback)(timeout, identifier, &cf->cf_udata);
1802 plugin_set_ctx(old_ctx);
1807 } /* int plugin_flush */
1809 int plugin_shutdown_all(void) {
1811 int ret = 0; // Assume success.
1813 destroy_all_callbacks(&list_init);
1815 stop_read_threads();
1817 pthread_mutex_lock(&read_lock);
1818 llist_destroy(read_list);
1820 pthread_mutex_unlock(&read_lock);
1822 destroy_read_heap();
1824 /* blocks until all write threads have shut down. */
1825 stop_write_threads();
1827 /* ask all plugins to write out the state they kept. */
1828 plugin_flush(/* plugin = */ NULL,
1830 /* identifier = */ NULL);
1833 if (list_shutdown != NULL)
1834 le = llist_head(list_shutdown);
1836 while (le != NULL) {
1837 callback_func_t *cf;
1838 plugin_shutdown_cb callback;
1839 plugin_ctx_t old_ctx;
1842 old_ctx = plugin_set_ctx(cf->cf_ctx);
1843 callback = cf->cf_callback;
1845 /* Advance the pointer before calling the callback allows
1846 * shutdown functions to unregister themselves. If done the
1847 * other way around the memory `le' points to will be freed
1848 * after callback returns. */
1851 if ((*callback)() != 0)
1854 plugin_set_ctx(old_ctx);
1857 /* Write plugins which use the `user_data' pointer usually need the
1858 * same data available to the flush callback. If this is the case, set
1859 * the free_function to NULL when registering the flush callback and to
1860 * the real free function when registering the write callback. This way
1861 * the data isn't freed twice. */
1862 destroy_all_callbacks(&list_flush);
1863 destroy_all_callbacks(&list_missing);
1864 destroy_all_callbacks(&list_write);
1866 destroy_all_callbacks(&list_notification);
1867 destroy_all_callbacks(&list_shutdown);
1868 destroy_all_callbacks(&list_log);
1870 plugin_free_loaded();
1871 plugin_free_data_sets();
1873 } /* void plugin_shutdown_all */
1875 int plugin_dispatch_missing(const value_list_t *vl) /* {{{ */
1879 if (list_missing == NULL)
1882 le = llist_head(list_missing);
1883 while (le != NULL) {
1884 callback_func_t *cf;
1885 plugin_missing_cb callback;
1886 plugin_ctx_t old_ctx;
1890 old_ctx = plugin_set_ctx(cf->cf_ctx);
1891 callback = cf->cf_callback;
1893 status = (*callback)(vl, &cf->cf_udata);
1894 plugin_set_ctx(old_ctx);
1897 ERROR("plugin_dispatch_missing: Callback function \"%s\" "
1898 "failed with status %i.",
1909 } /* int }}} plugin_dispatch_missing */
1911 static int plugin_dispatch_values_internal(value_list_t *vl) {
1913 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1917 _Bool free_meta_data = 0;
1921 /* These fields are initialized by plugin_value_list_clone() if needed: */
1922 assert(vl->host[0] != 0);
1923 assert(vl->time != 0); /* The time is determined at _enqueue_ time. */
1924 assert(vl->interval != 0);
1926 if (vl->type[0] == 0 || vl->values == NULL || vl->values_len < 1) {
1927 ERROR("plugin_dispatch_values: Invalid value list "
1933 /* Free meta data only if the calling function didn't specify any. In
1934 * this case matches and targets may add some and the calling function
1935 * may not expect (and therefore free) that data. */
1936 if (vl->meta == NULL)
1939 if (list_write == NULL)
1940 c_complain_once(LOG_WARNING, &no_write_complaint,
1941 "plugin_dispatch_values: No write callback has been "
1942 "registered. Please load at least one output plugin, "
1943 "if you want the collected data to be stored.");
1945 if (data_sets == NULL) {
1946 ERROR("plugin_dispatch_values: No data sets registered. "
1947 "Could the types database be read? Check "
1948 "your `TypesDB' setting!");
1952 if (c_avl_get(data_sets, vl->type, (void *)&ds) != 0) {
1953 char ident[6 * DATA_MAX_NAME_LEN];
1955 FORMAT_VL(ident, sizeof(ident), vl);
1956 INFO("plugin_dispatch_values: Dataset not found: %s "
1957 "(from \"%s\"), check your types.db!",
1962 DEBUG("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1964 "plugin = %s; plugin_instance = %s; "
1965 "type = %s; type_instance = %s;",
1966 CDTIME_T_TO_DOUBLE(vl->time), CDTIME_T_TO_DOUBLE(vl->interval),
1967 vl->host, vl->plugin, vl->plugin_instance, vl->type, vl->type_instance);
1970 assert(0 == strcmp(ds->type, vl->type));
1972 if (0 != strcmp(ds->type, vl->type))
1973 WARNING("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1974 ds->type, vl->type);
1978 assert(ds->ds_num == vl->values_len);
1980 if (ds->ds_num != vl->values_len) {
1981 ERROR("plugin_dispatch_values: ds->type = %s: "
1982 "(ds->ds_num = %zu) != "
1983 "(vl->values_len = %zu)",
1984 ds->type, ds->ds_num, vl->values_len);
1989 escape_slashes(vl->host, sizeof(vl->host));
1990 escape_slashes(vl->plugin, sizeof(vl->plugin));
1991 escape_slashes(vl->plugin_instance, sizeof(vl->plugin_instance));
1992 escape_slashes(vl->type, sizeof(vl->type));
1993 escape_slashes(vl->type_instance, sizeof(vl->type_instance));
1995 if (pre_cache_chain != NULL) {
1996 status = fc_process_chain(ds, vl, pre_cache_chain);
1998 WARNING("plugin_dispatch_values: Running the "
1999 "pre-cache chain failed with "
2002 } else if (status == FC_TARGET_STOP)
2006 /* Update the value cache */
2009 if (post_cache_chain != NULL) {
2010 status = fc_process_chain(ds, vl, post_cache_chain);
2012 WARNING("plugin_dispatch_values: Running the "
2013 "post-cache chain failed with "
2018 fc_default_action(ds, vl);
2020 if ((free_meta_data != 0) && (vl->meta != NULL)) {
2021 meta_data_destroy(vl->meta);
2026 } /* int plugin_dispatch_values_internal */
2028 static double get_drop_probability(void) /* {{{ */
2034 pthread_mutex_lock(&write_lock);
2035 wql = write_queue_length;
2036 pthread_mutex_unlock(&write_lock);
2038 if (wql < write_limit_low)
2040 if (wql >= write_limit_high)
2043 pos = 1 + wql - write_limit_low;
2044 size = 1 + write_limit_high - write_limit_low;
2046 return (double)pos / (double)size;
2047 } /* }}} double get_drop_probability */
2049 static _Bool check_drop_value(void) /* {{{ */
2051 static cdtime_t last_message_time = 0;
2052 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2058 if (write_limit_high == 0)
2061 p = get_drop_probability();
2065 status = pthread_mutex_trylock(&last_message_lock);
2070 if ((now - last_message_time) > TIME_T_TO_CDTIME_T(1)) {
2071 last_message_time = now;
2072 ERROR("plugin_dispatch_values: Low water mark "
2073 "reached. Dropping %.0f%% of metrics.",
2076 pthread_mutex_unlock(&last_message_lock);
2087 } /* }}} _Bool check_drop_value */
2089 int plugin_dispatch_values(value_list_t const *vl) {
2091 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2093 if (check_drop_value()) {
2094 if (record_statistics) {
2095 pthread_mutex_lock(&statistics_lock);
2096 stats_values_dropped++;
2097 pthread_mutex_unlock(&statistics_lock);
2102 status = plugin_write_enqueue(vl);
2105 ERROR("plugin_dispatch_values: plugin_write_enqueue failed "
2106 "with status %i (%s).",
2107 status, sstrerror(status, errbuf, sizeof(errbuf)));
2114 __attribute__((sentinel)) int
2115 plugin_dispatch_multivalue(value_list_t const *template, /* {{{ */
2116 _Bool store_percentage, int store_type, ...) {
2122 assert(template->values_len == 1);
2124 /* Calculate sum for Gauge to calculate percent if needed */
2125 if (DS_TYPE_GAUGE == store_type) {
2126 va_start(ap, store_type);
2131 name = va_arg(ap, char const *);
2135 value = va_arg(ap, gauge_t);
2142 vl = plugin_value_list_clone(template);
2143 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2144 if (store_percentage)
2145 sstrncpy(vl->type, "percent", sizeof(vl->type));
2147 va_start(ap, store_type);
2152 /* Set the type instance. */
2153 name = va_arg(ap, char const *);
2156 sstrncpy(vl->type_instance, name, sizeof(vl->type_instance));
2158 /* Set the value. */
2159 switch (store_type) {
2161 vl->values[0].gauge = va_arg(ap, gauge_t);
2162 if (store_percentage)
2163 vl->values[0].gauge *= sum ? (100.0 / sum) : NAN;
2165 case DS_TYPE_ABSOLUTE:
2166 vl->values[0].absolute = va_arg(ap, absolute_t);
2168 case DS_TYPE_COUNTER:
2169 vl->values[0].counter = va_arg(ap, counter_t);
2171 case DS_TYPE_DERIVE:
2172 vl->values[0].derive = va_arg(ap, derive_t);
2175 ERROR("plugin_dispatch_multivalue: given store_type is incorrect.");
2179 status = plugin_write_enqueue(vl);
2185 plugin_value_list_free(vl);
2187 } /* }}} int plugin_dispatch_multivalue */
2189 int plugin_dispatch_notification(const notification_t *notif) {
2191 /* Possible TODO: Add flap detection here */
2193 DEBUG("plugin_dispatch_notification: severity = %i; message = %s; "
2194 "time = %.3f; host = %s;",
2195 notif->severity, notif->message, CDTIME_T_TO_DOUBLE(notif->time),
2198 /* Nobody cares for notifications */
2199 if (list_notification == NULL)
2202 le = llist_head(list_notification);
2203 while (le != NULL) {
2204 callback_func_t *cf;
2205 plugin_notification_cb callback;
2208 /* do not switch plugin context; rather keep the context
2209 * (interval) information of the calling plugin */
2212 callback = cf->cf_callback;
2213 status = (*callback)(notif, &cf->cf_udata);
2215 WARNING("plugin_dispatch_notification: Notification "
2216 "callback %s returned %i.",
2224 } /* int plugin_dispatch_notification */
2226 void plugin_log(int level, const char *format, ...) {
2232 if (level >= LOG_DEBUG)
2236 va_start(ap, format);
2237 vsnprintf(msg, sizeof(msg), format, ap);
2238 msg[sizeof(msg) - 1] = '\0';
2241 if (list_log == NULL) {
2242 fprintf(stderr, "%s\n", msg);
2246 le = llist_head(list_log);
2247 while (le != NULL) {
2248 callback_func_t *cf;
2249 plugin_log_cb callback;
2252 callback = cf->cf_callback;
2254 /* do not switch plugin context; rather keep the context
2255 * (interval) information of the calling plugin */
2257 (*callback)(level, msg, &cf->cf_udata);
2261 } /* void plugin_log */
2263 int parse_log_severity(const char *severity) {
2266 if ((0 == strcasecmp(severity, "emerg")) ||
2267 (0 == strcasecmp(severity, "alert")) ||
2268 (0 == strcasecmp(severity, "crit")) || (0 == strcasecmp(severity, "err")))
2269 log_level = LOG_ERR;
2270 else if (0 == strcasecmp(severity, "warning"))
2271 log_level = LOG_WARNING;
2272 else if (0 == strcasecmp(severity, "notice"))
2273 log_level = LOG_NOTICE;
2274 else if (0 == strcasecmp(severity, "info"))
2275 log_level = LOG_INFO;
2277 else if (0 == strcasecmp(severity, "debug"))
2278 log_level = LOG_DEBUG;
2279 #endif /* COLLECT_DEBUG */
2282 } /* int parse_log_severity */
2284 int parse_notif_severity(const char *severity) {
2285 int notif_severity = -1;
2287 if (strcasecmp(severity, "FAILURE") == 0)
2288 notif_severity = NOTIF_FAILURE;
2289 else if (strcmp(severity, "OKAY") == 0)
2290 notif_severity = NOTIF_OKAY;
2291 else if ((strcmp(severity, "WARNING") == 0) ||
2292 (strcmp(severity, "WARN") == 0))
2293 notif_severity = NOTIF_WARNING;
2295 return notif_severity;
2296 } /* int parse_notif_severity */
2298 const data_set_t *plugin_get_ds(const char *name) {
2301 if (data_sets == NULL) {
2302 ERROR("plugin_get_ds: No data sets are defined yet.");
2306 if (c_avl_get(data_sets, name, (void *)&ds) != 0) {
2307 DEBUG("No such dataset registered: %s", name);
2312 } /* data_set_t *plugin_get_ds */
2314 static int plugin_notification_meta_add(notification_t *n, const char *name,
2315 enum notification_meta_type_e type,
2316 const void *value) {
2317 notification_meta_t *meta;
2318 notification_meta_t *tail;
2320 if ((n == NULL) || (name == NULL) || (value == NULL)) {
2321 ERROR("plugin_notification_meta_add: A pointer is NULL!");
2325 meta = calloc(1, sizeof(*meta));
2327 ERROR("plugin_notification_meta_add: calloc failed.");
2331 sstrncpy(meta->name, name, sizeof(meta->name));
2335 case NM_TYPE_STRING: {
2336 meta->nm_value.nm_string = strdup((const char *)value);
2337 if (meta->nm_value.nm_string == NULL) {
2338 ERROR("plugin_notification_meta_add: strdup failed.");
2344 case NM_TYPE_SIGNED_INT: {
2345 meta->nm_value.nm_signed_int = *((int64_t *)value);
2348 case NM_TYPE_UNSIGNED_INT: {
2349 meta->nm_value.nm_unsigned_int = *((uint64_t *)value);
2352 case NM_TYPE_DOUBLE: {
2353 meta->nm_value.nm_double = *((double *)value);
2356 case NM_TYPE_BOOLEAN: {
2357 meta->nm_value.nm_boolean = *((_Bool *)value);
2361 ERROR("plugin_notification_meta_add: Unknown type: %i", type);
2365 } /* switch (type) */
2369 while ((tail != NULL) && (tail->next != NULL))
2378 } /* int plugin_notification_meta_add */
2380 int plugin_notification_meta_add_string(notification_t *n, const char *name,
2381 const char *value) {
2382 return plugin_notification_meta_add(n, name, NM_TYPE_STRING, value);
2385 int plugin_notification_meta_add_signed_int(notification_t *n, const char *name,
2387 return plugin_notification_meta_add(n, name, NM_TYPE_SIGNED_INT, &value);
2390 int plugin_notification_meta_add_unsigned_int(notification_t *n,
2393 return plugin_notification_meta_add(n, name, NM_TYPE_UNSIGNED_INT, &value);
2396 int plugin_notification_meta_add_double(notification_t *n, const char *name,
2398 return plugin_notification_meta_add(n, name, NM_TYPE_DOUBLE, &value);
2401 int plugin_notification_meta_add_boolean(notification_t *n, const char *name,
2403 return plugin_notification_meta_add(n, name, NM_TYPE_BOOLEAN, &value);
2406 int plugin_notification_meta_copy(notification_t *dst,
2407 const notification_t *src) {
2408 assert(dst != NULL);
2409 assert(src != NULL);
2411 assert((src->meta == NULL) || (src->meta != dst->meta));
2413 for (notification_meta_t *meta = src->meta; meta != NULL; meta = meta->next) {
2414 if (meta->type == NM_TYPE_STRING)
2415 plugin_notification_meta_add_string(dst, meta->name,
2416 meta->nm_value.nm_string);
2417 else if (meta->type == NM_TYPE_SIGNED_INT)
2418 plugin_notification_meta_add_signed_int(dst, meta->name,
2419 meta->nm_value.nm_signed_int);
2420 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2421 plugin_notification_meta_add_unsigned_int(dst, meta->name,
2422 meta->nm_value.nm_unsigned_int);
2423 else if (meta->type == NM_TYPE_DOUBLE)
2424 plugin_notification_meta_add_double(dst, meta->name,
2425 meta->nm_value.nm_double);
2426 else if (meta->type == NM_TYPE_BOOLEAN)
2427 plugin_notification_meta_add_boolean(dst, meta->name,
2428 meta->nm_value.nm_boolean);
2432 } /* int plugin_notification_meta_copy */
2434 int plugin_notification_meta_free(notification_meta_t *n) {
2435 notification_meta_t *this;
2436 notification_meta_t *next;
2439 ERROR("plugin_notification_meta_free: n == NULL!");
2444 while (this != NULL) {
2447 if (this->type == NM_TYPE_STRING) {
2448 /* Assign to a temporary variable to work around nm_string's const
2450 void *tmp = (void *)this->nm_value.nm_string;
2453 this->nm_value.nm_string = NULL;
2461 } /* int plugin_notification_meta_free */
2463 static void plugin_ctx_destructor(void *ctx) {
2465 } /* void plugin_ctx_destructor */
2467 static plugin_ctx_t ctx_init = {/* interval = */ 0};
2469 static plugin_ctx_t *plugin_ctx_create(void) {
2472 ctx = malloc(sizeof(*ctx));
2475 ERROR("Failed to allocate plugin context: %s",
2476 sstrerror(errno, errbuf, sizeof(errbuf)));
2481 assert(plugin_ctx_key_initialized);
2482 pthread_setspecific(plugin_ctx_key, ctx);
2483 DEBUG("Created new plugin context.");
2485 } /* int plugin_ctx_create */
2487 void plugin_init_ctx(void) {
2488 pthread_key_create(&plugin_ctx_key, plugin_ctx_destructor);
2489 plugin_ctx_key_initialized = 1;
2490 } /* void plugin_init_ctx */
2492 plugin_ctx_t plugin_get_ctx(void) {
2495 assert(plugin_ctx_key_initialized);
2496 ctx = pthread_getspecific(plugin_ctx_key);
2499 ctx = plugin_ctx_create();
2500 /* this must no happen -- exit() instead? */
2506 } /* plugin_ctx_t plugin_get_ctx */
2508 plugin_ctx_t plugin_set_ctx(plugin_ctx_t ctx) {
2512 assert(plugin_ctx_key_initialized);
2513 c = pthread_getspecific(plugin_ctx_key);
2516 c = plugin_ctx_create();
2517 /* this must no happen -- exit() instead? */
2526 } /* void plugin_set_ctx */
2528 cdtime_t plugin_get_interval(void) {
2531 interval = plugin_get_ctx().interval;
2535 return cf_get_default_interval();
2536 } /* cdtime_t plugin_get_interval */
2540 void *(*start_routine)(void *);
2544 static void *plugin_thread_start(void *arg) {
2545 plugin_thread_t *plugin_thread = arg;
2547 void *(*start_routine)(void *) = plugin_thread->start_routine;
2548 void *plugin_arg = plugin_thread->arg;
2550 plugin_set_ctx(plugin_thread->ctx);
2552 sfree(plugin_thread);
2554 return start_routine(plugin_arg);
2555 } /* void *plugin_thread_start */
2557 int plugin_thread_create(pthread_t *thread, const pthread_attr_t *attr,
2558 void *(*start_routine)(void *), void *arg,
2560 plugin_thread_t *plugin_thread;
2562 plugin_thread = malloc(sizeof(*plugin_thread));
2563 if (plugin_thread == NULL)
2566 plugin_thread->ctx = plugin_get_ctx();
2567 plugin_thread->start_routine = start_routine;
2568 plugin_thread->arg = arg;
2570 int ret = pthread_create(thread, attr, plugin_thread_start, plugin_thread);
2572 sfree(plugin_thread);
2577 set_thread_name(*thread, name);
2580 } /* int plugin_thread_create */