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>
31 #include "configfile.h"
32 #include "filter_chain.h"
33 #include "utils_avltree.h"
34 #include "utils_cache.h"
35 #include "utils_complain.h"
36 #include "utils_llist.h"
37 #include "utils_heap.h"
38 #include "utils_time.h"
39 #include "utils_random.h"
46 struct callback_func_s
52 typedef struct callback_func_s callback_func_t;
56 #define RF_REMOVE 65535
59 /* `read_func_t' "inherits" from `callback_func_t'.
60 * The `rf_super' member MUST be the first one in this structure! */
61 #define rf_callback rf_super.cf_callback
62 #define rf_udata rf_super.cf_udata
63 #define rf_ctx rf_super.cf_ctx
64 callback_func_t rf_super;
65 char rf_group[DATA_MAX_NAME_LEN];
69 cdtime_t rf_effective_interval;
70 cdtime_t rf_next_read;
72 typedef struct read_func_s read_func_t;
75 typedef struct write_queue_s write_queue_t;
83 struct flush_callback_s {
87 typedef struct flush_callback_s flush_callback_t;
92 static c_avl_tree_t *plugins_loaded = NULL;
94 static llist_t *list_init;
95 static llist_t *list_write;
96 static llist_t *list_flush;
97 static llist_t *list_missing;
98 static llist_t *list_shutdown;
99 static llist_t *list_log;
100 static llist_t *list_notification;
102 static fc_chain_t *pre_cache_chain = NULL;
103 static fc_chain_t *post_cache_chain = NULL;
105 static c_avl_tree_t *data_sets;
107 static char *plugindir = NULL;
109 #ifndef DEFAULT_MAX_READ_INTERVAL
110 # define DEFAULT_MAX_READ_INTERVAL TIME_T_TO_CDTIME_T (86400)
112 static c_heap_t *read_heap = NULL;
113 static llist_t *read_list;
114 static int read_loop = 1;
115 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
116 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
117 static pthread_t *read_threads = NULL;
118 static int read_threads_num = 0;
119 static cdtime_t max_read_interval = DEFAULT_MAX_READ_INTERVAL;
121 static write_queue_t *write_queue_head;
122 static write_queue_t *write_queue_tail;
123 static long write_queue_length = 0;
124 static _Bool write_loop = 1;
125 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
126 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
127 static pthread_t *write_threads = NULL;
128 static size_t write_threads_num = 0;
130 static pthread_key_t plugin_ctx_key;
131 static _Bool plugin_ctx_key_initialized = 0;
133 static long write_limit_high = 0;
134 static long write_limit_low = 0;
136 static derive_t stats_values_dropped = 0;
137 static _Bool record_statistics = 0;
142 static int plugin_dispatch_values_internal (value_list_t *vl);
144 static const char *plugin_get_dir (void)
146 if (plugindir == NULL)
152 static void plugin_update_internal_statistics (void) { /* {{{ */
153 derive_t copy_write_queue_length;
154 value_list_t vl = VALUE_LIST_INIT;
157 copy_write_queue_length = write_queue_length;
159 /* Initialize `vl' */
163 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
164 sstrncpy (vl.plugin, "collectd", sizeof (vl.plugin));
166 vl.type_instance[0] = 0;
170 sstrncpy (vl.plugin_instance, "write_queue",
171 sizeof (vl.plugin_instance));
173 /* Write queue : queue length */
174 vl.values[0].gauge = (gauge_t) copy_write_queue_length;
175 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
176 vl.type_instance[0] = 0;
177 plugin_dispatch_values (&vl);
179 /* Write queue : Values dropped (queue length > low limit) */
180 vl.values[0].derive = (derive_t) stats_values_dropped;
181 sstrncpy (vl.type, "derive", sizeof (vl.type));
182 sstrncpy (vl.type_instance, "dropped", sizeof (vl.type_instance));
183 plugin_dispatch_values (&vl);
186 sstrncpy (vl.plugin_instance, "cache",
187 sizeof (vl.plugin_instance));
189 /* Cache : Nb entry in cache tree */
190 vl.values[0].gauge = (gauge_t) uc_get_size();
191 sstrncpy (vl.type, "cache_size", sizeof (vl.type));
192 vl.type_instance[0] = 0;
193 plugin_dispatch_values (&vl);
196 } /* }}} void plugin_update_internal_statistics */
198 static void destroy_callback (callback_func_t *cf) /* {{{ */
203 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
205 cf->cf_udata.free_func (cf->cf_udata.data);
206 cf->cf_udata.data = NULL;
207 cf->cf_udata.free_func = NULL;
210 } /* }}} void destroy_callback */
212 static void destroy_all_callbacks (llist_t **list) /* {{{ */
219 le = llist_head (*list);
227 destroy_callback (le->value);
233 llist_destroy (*list);
235 } /* }}} void destroy_all_callbacks */
237 static void destroy_read_heap (void) /* {{{ */
239 if (read_heap == NULL)
246 rf = c_heap_get_root (read_heap);
250 destroy_callback ((callback_func_t *) rf);
253 c_heap_destroy (read_heap);
255 } /* }}} void destroy_read_heap */
257 static int register_callback (llist_t **list, /* {{{ */
258 const char *name, callback_func_t *cf)
265 *list = llist_create ();
268 ERROR ("plugin: register_callback: "
269 "llist_create failed.");
270 destroy_callback (cf);
278 ERROR ("plugin: register_callback: strdup failed.");
279 destroy_callback (cf);
283 le = llist_search (*list, name);
286 le = llentry_create (key, cf);
289 ERROR ("plugin: register_callback: "
290 "llentry_create failed.");
292 destroy_callback (cf);
296 llist_append (*list, le);
300 callback_func_t *old_cf;
305 WARNING ("plugin: register_callback: "
306 "a callback named `%s' already exists - "
307 "overwriting the old entry!", name);
309 destroy_callback (old_cf);
314 } /* }}} int register_callback */
316 static void log_list_callbacks (llist_t **list, /* {{{ */
326 n = llist_size(*list);
329 INFO("%s [none]", comment);
333 keys = calloc(n, sizeof(char*));
337 ERROR("%s: failed to allocate memory for list of callbacks",
343 for (le = llist_head (*list), i = 0, len = 0;
348 len += strlen(le->key) + 6;
350 str = malloc(len + 10);
353 ERROR("%s: failed to allocate memory for list of callbacks",
359 strjoin(str, len, keys, n, "', '");
360 INFO("%s ['%s']", comment, str);
364 } /* }}} void log_list_callbacks */
366 static int create_register_callback (llist_t **list, /* {{{ */
367 const char *name, void *callback, user_data_t *ud)
371 cf = (callback_func_t *) malloc (sizeof (*cf));
374 ERROR ("plugin: create_register_callback: malloc failed.");
377 memset (cf, 0, sizeof (*cf));
379 cf->cf_callback = callback;
382 cf->cf_udata.data = NULL;
383 cf->cf_udata.free_func = NULL;
390 cf->cf_ctx = plugin_get_ctx ();
392 return (register_callback (list, name, cf));
393 } /* }}} int create_register_callback */
395 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
402 e = llist_search (list, name);
406 llist_remove (list, e);
409 destroy_callback (e->value);
414 } /* }}} int plugin_unregister */
417 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
418 * object, but it will bitch about a shared object not having a
419 * ``module_register'' symbol..
421 static int plugin_load_file (char *file, uint32_t flags)
424 void (*reg_handle) (void);
427 lt_dlerror (); /* clear errors */
429 #if LIBTOOL_VERSION == 2
430 if (flags & PLUGIN_FLAGS_GLOBAL) {
432 lt_dladvise_init(&advise);
433 lt_dladvise_global(&advise);
434 dlh = lt_dlopenadvise(file, advise);
435 lt_dladvise_destroy(&advise);
437 dlh = lt_dlopen (file);
439 #else /* if LIBTOOL_VERSION == 1 */
440 if (flags & PLUGIN_FLAGS_GLOBAL)
441 WARNING ("plugin_load_file: The global flag is not supported, "
442 "libtool 2 is required for this.");
443 dlh = lt_dlopen (file);
448 char errbuf[1024] = "";
450 ssnprintf (errbuf, sizeof (errbuf),
451 "lt_dlopen (\"%s\") failed: %s. "
452 "The most common cause for this problem is "
453 "missing dependencies. Use ldd(1) to check "
454 "the dependencies of the plugin "
456 file, lt_dlerror ());
458 ERROR ("%s", errbuf);
459 /* Make sure this is printed to STDERR in any case, but also
460 * make sure it's printed only once. */
461 if (list_log != NULL)
462 fprintf (stderr, "ERROR: %s\n", errbuf);
467 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
469 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
470 file, lt_dlerror ());
480 static void *plugin_read_thread (void __attribute__((unused)) *args)
482 while (read_loop != 0)
485 plugin_ctx_t old_ctx;
493 /* Get the read function that needs to be read next.
494 * We don't need to hold "read_lock" for the heap, but we need
495 * to call c_heap_get_root() and pthread_cond_wait() in the
496 * same protected block. */
497 pthread_mutex_lock (&read_lock);
498 rf = c_heap_get_root (read_heap);
501 pthread_cond_wait (&read_cond, &read_lock);
502 pthread_mutex_unlock (&read_lock);
505 pthread_mutex_unlock (&read_lock);
507 if (rf->rf_interval == 0)
509 /* this should not happen, because the interval is set
510 * for each plugin when loading it
511 * XXX: issue a warning? */
512 rf->rf_interval = plugin_get_interval ();
513 rf->rf_effective_interval = rf->rf_interval;
515 rf->rf_next_read = cdtime ();
518 /* sleep until this entry is due,
519 * using pthread_cond_timedwait */
520 pthread_mutex_lock (&read_lock);
521 /* In pthread_cond_timedwait, spurious wakeups are possible
522 * (and really happen, at least on NetBSD with > 1 CPU), thus
523 * we need to re-evaluate the condition every time
524 * pthread_cond_timedwait returns. */
526 while ((read_loop != 0)
527 && (cdtime () < rf->rf_next_read)
530 struct timespec ts = { 0 };
532 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
534 rc = pthread_cond_timedwait (&read_cond, &read_lock,
538 /* Must hold `read_lock' when accessing `rf->rf_type'. */
539 rf_type = rf->rf_type;
540 pthread_mutex_unlock (&read_lock);
542 /* Check if we're supposed to stop.. This may have interrupted
546 /* Insert `rf' again, so it can be free'd correctly */
547 c_heap_insert (read_heap, rf);
551 /* The entry has been marked for deletion. The linked list
552 * entry has already been removed by `plugin_unregister_read'.
553 * All we have to do here is free the `read_func_t' and
555 if (rf_type == RF_REMOVE)
557 DEBUG ("plugin_read_thread: Destroying the `%s' "
558 "callback.", rf->rf_name);
560 destroy_callback ((callback_func_t *) rf);
565 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
569 old_ctx = plugin_set_ctx (rf->rf_ctx);
571 if (rf_type == RF_SIMPLE)
573 int (*callback) (void);
575 callback = rf->rf_callback;
576 status = (*callback) ();
580 plugin_read_cb callback;
582 assert (rf_type == RF_COMPLEX);
584 callback = rf->rf_callback;
585 status = (*callback) (&rf->rf_udata);
588 plugin_set_ctx (old_ctx);
590 /* If the function signals failure, we will increase the
591 * intervals in which it will be called. */
594 rf->rf_effective_interval *= 2;
595 if (rf->rf_effective_interval > max_read_interval)
596 rf->rf_effective_interval = max_read_interval;
598 NOTICE ("read-function of plugin `%s' failed. "
599 "Will suspend it for %.3f seconds.",
601 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
605 /* Success: Restore the interval, if it was changed. */
606 rf->rf_effective_interval = rf->rf_interval;
609 /* update the ``next read due'' field */
612 /* calculate the time spent in the read function */
613 elapsed = (now - start);
615 if (elapsed > rf->rf_effective_interval)
616 WARNING ("plugin_read_thread: read-function of the `%s' plugin took %.3f "
617 "seconds, which is above its read interval (%.3f seconds). You might "
618 "want to adjust the `Interval' or `ReadThreads' settings.",
619 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed),
620 CDTIME_T_TO_DOUBLE(rf->rf_effective_interval));
622 DEBUG ("plugin_read_thread: read-function of the `%s' plugin took "
624 rf->rf_name, CDTIME_T_TO_DOUBLE(elapsed));
626 DEBUG ("plugin_read_thread: Effective interval of the "
627 "%s plugin is %.3f seconds.",
629 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
631 /* Calculate the next (absolute) time at which this function
632 * should be called. */
633 rf->rf_next_read += rf->rf_effective_interval;
635 /* Check, if `rf_next_read' is in the past. */
636 if (rf->rf_next_read < now)
638 /* `rf_next_read' is in the past. Insert `now'
639 * so this value doesn't trail off into the
641 rf->rf_next_read = now;
644 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
646 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
648 /* Re-insert this read function into the heap again. */
649 c_heap_insert (read_heap, rf);
650 } /* while (read_loop) */
654 } /* void *plugin_read_thread */
656 static void start_read_threads (int num)
660 if (read_threads != NULL)
663 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
664 if (read_threads == NULL)
666 ERROR ("plugin: start_read_threads: calloc failed.");
670 read_threads_num = 0;
671 for (i = 0; i < num; i++)
673 if (pthread_create (read_threads + read_threads_num, NULL,
674 plugin_read_thread, NULL) == 0)
680 ERROR ("plugin: start_read_threads: pthread_create failed.");
684 } /* void start_read_threads */
686 static void stop_read_threads (void)
690 if (read_threads == NULL)
693 INFO ("collectd: Stopping %i read threads.", read_threads_num);
695 pthread_mutex_lock (&read_lock);
697 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
698 pthread_cond_broadcast (&read_cond);
699 pthread_mutex_unlock (&read_lock);
701 for (i = 0; i < read_threads_num; i++)
703 if (pthread_join (read_threads[i], NULL) != 0)
705 ERROR ("plugin: stop_read_threads: pthread_join failed.");
707 read_threads[i] = (pthread_t) 0;
709 sfree (read_threads);
710 read_threads_num = 0;
711 } /* void stop_read_threads */
713 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
718 meta_data_destroy (vl->meta);
721 } /* }}} void plugin_value_list_free */
723 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
730 vl = malloc (sizeof (*vl));
733 memcpy (vl, vl_orig, sizeof (*vl));
735 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
736 if (vl->values == NULL)
738 plugin_value_list_free (vl);
741 memcpy (vl->values, vl_orig->values,
742 vl_orig->values_len * sizeof (*vl->values));
744 vl->meta = meta_data_clone (vl->meta);
745 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
747 plugin_value_list_free (vl);
752 vl->time = cdtime ();
754 /* Fill in the interval from the thread context, if it is zero. */
755 if (vl->interval == 0)
757 plugin_ctx_t ctx = plugin_get_ctx ();
759 if (ctx.interval != 0)
760 vl->interval = ctx.interval;
763 char name[6 * DATA_MAX_NAME_LEN];
764 FORMAT_VL (name, sizeof (name), vl);
765 ERROR ("plugin_value_list_clone: Unable to determine "
766 "interval from context for "
767 "value list \"%s\". "
768 "This indicates a broken plugin. "
769 "Please report this problem to the "
770 "collectd mailing list or at "
771 "<http://collectd.org/bugs/>.", name);
772 vl->interval = cf_get_default_interval ();
777 } /* }}} value_list_t *plugin_value_list_clone */
779 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
783 q = malloc (sizeof (*q));
788 q->vl = plugin_value_list_clone (vl);
795 /* Store context of caller (read plugin); otherwise, it would not be
796 * available to the write plugins when actually dispatching the
797 * value-list later on. */
798 q->ctx = plugin_get_ctx ();
800 pthread_mutex_lock (&write_lock);
802 if (write_queue_tail == NULL)
804 write_queue_head = q;
805 write_queue_tail = q;
806 write_queue_length = 1;
810 write_queue_tail->next = q;
811 write_queue_tail = q;
812 write_queue_length += 1;
815 pthread_cond_signal (&write_cond);
816 pthread_mutex_unlock (&write_lock);
819 } /* }}} int plugin_write_enqueue */
821 static value_list_t *plugin_write_dequeue (void) /* {{{ */
826 pthread_mutex_lock (&write_lock);
828 while (write_loop && (write_queue_head == NULL))
829 pthread_cond_wait (&write_cond, &write_lock);
831 if (write_queue_head == NULL)
833 pthread_mutex_unlock (&write_lock);
837 q = write_queue_head;
838 write_queue_head = q->next;
839 write_queue_length -= 1;
840 if (write_queue_head == NULL) {
841 write_queue_tail = NULL;
842 assert(0 == write_queue_length);
845 pthread_mutex_unlock (&write_lock);
847 (void) plugin_set_ctx (q->ctx);
852 } /* }}} value_list_t *plugin_write_dequeue */
854 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
858 value_list_t *vl = plugin_write_dequeue ();
862 plugin_dispatch_values_internal (vl);
864 plugin_value_list_free (vl);
869 } /* }}} void *plugin_write_thread */
871 static void start_write_threads (size_t num) /* {{{ */
875 if (write_threads != NULL)
878 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
879 if (write_threads == NULL)
881 ERROR ("plugin: start_write_threads: calloc failed.");
885 write_threads_num = 0;
886 for (i = 0; i < num; i++)
890 status = pthread_create (write_threads + write_threads_num,
897 ERROR ("plugin: start_write_threads: pthread_create failed "
898 "with status %i (%s).", status,
899 sstrerror (status, errbuf, sizeof (errbuf)));
905 } /* }}} void start_write_threads */
907 static void stop_write_threads (void) /* {{{ */
912 if (write_threads == NULL)
915 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
917 pthread_mutex_lock (&write_lock);
919 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
920 pthread_cond_broadcast (&write_cond);
921 pthread_mutex_unlock (&write_lock);
923 for (i = 0; i < write_threads_num; i++)
925 if (pthread_join (write_threads[i], NULL) != 0)
927 ERROR ("plugin: stop_write_threads: pthread_join failed.");
929 write_threads[i] = (pthread_t) 0;
931 sfree (write_threads);
932 write_threads_num = 0;
934 pthread_mutex_lock (&write_lock);
936 for (q = write_queue_head; q != NULL; )
938 write_queue_t *q1 = q;
939 plugin_value_list_free (q->vl);
944 write_queue_head = NULL;
945 write_queue_tail = NULL;
946 write_queue_length = 0;
947 pthread_mutex_unlock (&write_lock);
951 WARNING ("plugin: %zu value list%s left after shutting down "
952 "the write threads.",
953 i, (i == 1) ? " was" : "s were");
955 } /* }}} void stop_write_threads */
960 void plugin_set_dir (const char *dir)
962 if (plugindir != NULL)
967 else if ((plugindir = strdup (dir)) == NULL)
970 ERROR ("strdup failed: %s",
971 sstrerror (errno, errbuf, sizeof (errbuf)));
975 static _Bool plugin_is_loaded (char const *name)
979 if (plugins_loaded == NULL)
980 plugins_loaded = c_avl_create ((void *) strcasecmp);
981 assert (plugins_loaded != NULL);
983 status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
984 return (status == 0);
987 static int plugin_mark_loaded (char const *name)
992 name_copy = strdup (name);
993 if (name_copy == NULL)
996 status = c_avl_insert (plugins_loaded,
997 /* key = */ name_copy, /* value = */ NULL);
1001 static void plugin_free_loaded ()
1006 if (plugins_loaded == NULL)
1009 while (c_avl_pick (plugins_loaded, &key, &value) == 0)
1012 assert (value == NULL);
1015 c_avl_destroy (plugins_loaded);
1016 plugins_loaded = NULL;
1020 int plugin_load (char const *plugin_name, uint32_t flags)
1024 char filename[BUFSIZE] = "";
1025 char typename[BUFSIZE];
1027 struct stat statbuf;
1031 if (plugin_name == NULL)
1034 /* Check if plugin is already loaded and don't do anything in this
1036 if (plugin_is_loaded (plugin_name))
1039 dir = plugin_get_dir ();
1043 * XXX: Magic at work:
1045 * Some of the language bindings, for example the Python and Perl
1046 * plugins, need to be able to export symbols to the scripts they run.
1047 * For this to happen, the "Globals" flag needs to be set.
1048 * Unfortunately, this technical detail is hard to explain to the
1049 * average user and she shouldn't have to worry about this, ideally.
1050 * So in order to save everyone's sanity use a different default for a
1051 * handful of special plugins. --octo
1053 if ((strcasecmp ("perl", plugin_name) == 0)
1054 || (strcasecmp ("python", plugin_name) == 0))
1055 flags |= PLUGIN_FLAGS_GLOBAL;
1057 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
1058 * type when matching the filename */
1059 status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
1060 if ((status < 0) || ((size_t) status >= sizeof (typename)))
1062 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1066 if ((dh = opendir (dir)) == NULL)
1069 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
1070 sstrerror (errno, errbuf, sizeof (errbuf)));
1074 while ((de = readdir (dh)) != NULL)
1076 if (strcasecmp (de->d_name, typename))
1079 status = ssnprintf (filename, sizeof (filename),
1080 "%s/%s", dir, de->d_name);
1081 if ((status < 0) || ((size_t) status >= sizeof (filename)))
1083 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
1088 if (lstat (filename, &statbuf) == -1)
1091 WARNING ("plugin_load: stat (\"%s\") failed: %s",
1093 sstrerror (errno, errbuf, sizeof (errbuf)));
1096 else if (!S_ISREG (statbuf.st_mode))
1098 /* don't follow symlinks */
1099 WARNING ("plugin_load: %s is not a regular file.",
1104 status = plugin_load_file (filename, flags);
1108 plugin_mark_loaded (plugin_name);
1110 INFO ("plugin_load: plugin \"%s\" successfully loaded.", plugin_name);
1115 ERROR ("plugin_load: Load plugin \"%s\" failed with "
1116 "status %i.", plugin_name, status);
1122 if (filename[0] == 0)
1123 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
1130 * The `register_*' functions follow
1132 int plugin_register_config (const char *name,
1133 int (*callback) (const char *key, const char *val),
1134 const char **keys, int keys_num)
1136 cf_register (name, callback, keys, keys_num);
1138 } /* int plugin_register_config */
1140 int plugin_register_complex_config (const char *type,
1141 int (*callback) (oconfig_item_t *))
1143 return (cf_register_complex (type, callback));
1144 } /* int plugin_register_complex_config */
1146 int plugin_register_init (const char *name,
1147 int (*callback) (void))
1149 return (create_register_callback (&list_init, name, (void *) callback,
1150 /* user_data = */ NULL));
1151 } /* plugin_register_init */
1153 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1155 const read_func_t *rf0;
1156 const read_func_t *rf1;
1161 if (rf0->rf_next_read < rf1->rf_next_read)
1163 else if (rf0->rf_next_read > rf1->rf_next_read)
1167 } /* int plugin_compare_read_func */
1169 /* Add a read function to both, the heap and a linked list. The linked list if
1170 * used to look-up read functions, especially for the remove function. The heap
1171 * is used to determine which plugin to read next. */
1172 static int plugin_insert_read (read_func_t *rf)
1177 rf->rf_next_read = cdtime ();
1178 rf->rf_effective_interval = rf->rf_interval;
1180 pthread_mutex_lock (&read_lock);
1182 if (read_list == NULL)
1184 read_list = llist_create ();
1185 if (read_list == NULL)
1187 pthread_mutex_unlock (&read_lock);
1188 ERROR ("plugin_insert_read: read_list failed.");
1193 if (read_heap == NULL)
1195 read_heap = c_heap_create (plugin_compare_read_func);
1196 if (read_heap == NULL)
1198 pthread_mutex_unlock (&read_lock);
1199 ERROR ("plugin_insert_read: c_heap_create failed.");
1204 le = llist_search (read_list, rf->rf_name);
1207 pthread_mutex_unlock (&read_lock);
1208 WARNING ("The read function \"%s\" is already registered. "
1209 "Check for duplicate \"LoadPlugin\" lines "
1210 "in your configuration!",
1215 le = llentry_create (rf->rf_name, rf);
1218 pthread_mutex_unlock (&read_lock);
1219 ERROR ("plugin_insert_read: llentry_create failed.");
1223 status = c_heap_insert (read_heap, rf);
1226 pthread_mutex_unlock (&read_lock);
1227 ERROR ("plugin_insert_read: c_heap_insert failed.");
1228 llentry_destroy (le);
1232 /* This does not fail. */
1233 llist_append (read_list, le);
1235 /* Wake up all the read threads. */
1236 pthread_cond_broadcast (&read_cond);
1237 pthread_mutex_unlock (&read_lock);
1239 } /* int plugin_insert_read */
1241 int plugin_register_read (const char *name,
1242 int (*callback) (void))
1247 rf = malloc (sizeof (*rf));
1250 ERROR ("plugin_register_read: malloc failed.");
1254 memset (rf, 0, sizeof (read_func_t));
1255 rf->rf_callback = (void *) callback;
1256 rf->rf_udata.data = NULL;
1257 rf->rf_udata.free_func = NULL;
1258 rf->rf_ctx = plugin_get_ctx ();
1259 rf->rf_group[0] = '\0';
1260 rf->rf_name = strdup (name);
1261 rf->rf_type = RF_SIMPLE;
1262 rf->rf_interval = plugin_get_interval ();
1264 status = plugin_insert_read (rf);
1266 sfree (rf->rf_name);
1271 } /* int plugin_register_read */
1273 int plugin_register_complex_read (const char *group, const char *name,
1274 plugin_read_cb callback,
1276 user_data_t *user_data)
1281 rf = malloc (sizeof (*rf));
1284 ERROR ("plugin_register_complex_read: malloc failed.");
1288 memset (rf, 0, sizeof (read_func_t));
1289 rf->rf_callback = (void *) callback;
1291 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1293 rf->rf_group[0] = '\0';
1294 rf->rf_name = strdup (name);
1295 rf->rf_type = RF_COMPLEX;
1296 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval ();
1299 if (user_data == NULL)
1301 rf->rf_udata.data = NULL;
1302 rf->rf_udata.free_func = NULL;
1306 rf->rf_udata = *user_data;
1309 rf->rf_ctx = plugin_get_ctx ();
1311 status = plugin_insert_read (rf);
1313 sfree (rf->rf_name);
1318 } /* int plugin_register_complex_read */
1320 int plugin_register_write (const char *name,
1321 plugin_write_cb callback, user_data_t *ud)
1323 return (create_register_callback (&list_write, name,
1324 (void *) callback, ud));
1325 } /* int plugin_register_write */
1327 static int plugin_flush_timeout_callback (user_data_t *ud)
1329 flush_callback_t *cb = ud->data;
1331 return plugin_flush (cb->name, cb->timeout, /* identifier = */ NULL);
1332 } /* static int plugin_flush_callback */
1334 static void plugin_flush_timeout_callback_free (void *data)
1336 flush_callback_t *cb = data;
1338 if (cb == NULL) return;
1342 } /* static void plugin_flush_callback_free */
1344 static char *plugin_flush_callback_name (const char *name)
1346 char *flush_prefix = "flush/";
1351 prefix_size = strlen(flush_prefix);
1352 name_size = strlen(name);
1354 flush_name = malloc (sizeof(char) * (name_size + prefix_size + 1));
1355 if (flush_name == NULL)
1357 ERROR ("plugin_flush_callback_name: malloc failed.");
1361 sstrncpy (flush_name, flush_prefix, prefix_size + 1);
1362 sstrncpy (flush_name + prefix_size, name, name_size + 1);
1365 } /* static char *plugin_flush_callback_name */
1367 int plugin_register_flush (const char *name,
1368 plugin_flush_cb callback, user_data_t *ud)
1371 plugin_ctx_t ctx = plugin_get_ctx ();
1373 status = create_register_callback (&list_flush, name,
1374 (void *) callback, ud);
1378 if (ctx.flush_interval != 0)
1382 flush_callback_t *cb;
1384 flush_name = plugin_flush_callback_name (name);
1385 if (flush_name == NULL)
1388 cb = malloc(sizeof(flush_callback_t));
1391 ERROR ("plugin_register_flush: malloc failed.");
1396 cb->name = strdup (name);
1397 if (cb->name == NULL)
1399 ERROR ("plugin_register_flush: strdup failed.");
1404 cb->timeout = ctx.flush_timeout;
1407 ud.free_func = plugin_flush_timeout_callback_free;
1409 status = plugin_register_complex_read (
1410 /* group = */ "flush",
1411 /* name = */ flush_name,
1412 /* callback = */ plugin_flush_timeout_callback,
1413 /* interval = */ ctx.flush_interval,
1414 /* user data = */ &ud);
1426 } /* int plugin_register_flush */
1428 int plugin_register_missing (const char *name,
1429 plugin_missing_cb callback, user_data_t *ud)
1431 return (create_register_callback (&list_missing, name,
1432 (void *) callback, ud));
1433 } /* int plugin_register_missing */
1435 int plugin_register_shutdown (const char *name,
1436 int (*callback) (void))
1438 return (create_register_callback (&list_shutdown, name,
1439 (void *) callback, /* user_data = */ NULL));
1440 } /* int plugin_register_shutdown */
1442 static void plugin_free_data_sets (void)
1447 if (data_sets == NULL)
1450 while (c_avl_pick (data_sets, &key, &value) == 0)
1452 data_set_t *ds = value;
1453 /* key is a pointer to ds->type */
1459 c_avl_destroy (data_sets);
1461 } /* void plugin_free_data_sets */
1463 int plugin_register_data_set (const data_set_t *ds)
1465 data_set_t *ds_copy;
1468 if ((data_sets != NULL)
1469 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1471 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1472 plugin_unregister_data_set (ds->type);
1474 else if (data_sets == NULL)
1476 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1477 if (data_sets == NULL)
1481 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1482 if (ds_copy == NULL)
1484 memcpy(ds_copy, ds, sizeof (data_set_t));
1486 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1488 if (ds_copy->ds == NULL)
1494 for (i = 0; i < ds->ds_num; i++)
1495 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1497 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1498 } /* int plugin_register_data_set */
1500 int plugin_register_log (const char *name,
1501 plugin_log_cb callback, user_data_t *ud)
1503 return (create_register_callback (&list_log, name,
1504 (void *) callback, ud));
1505 } /* int plugin_register_log */
1507 int plugin_register_notification (const char *name,
1508 plugin_notification_cb callback, user_data_t *ud)
1510 return (create_register_callback (&list_notification, name,
1511 (void *) callback, ud));
1512 } /* int plugin_register_log */
1514 int plugin_unregister_config (const char *name)
1516 cf_unregister (name);
1518 } /* int plugin_unregister_config */
1520 int plugin_unregister_complex_config (const char *name)
1522 cf_unregister_complex (name);
1524 } /* int plugin_unregister_complex_config */
1526 int plugin_unregister_init (const char *name)
1528 return (plugin_unregister (list_init, name));
1531 int plugin_unregister_read (const char *name) /* {{{ */
1539 pthread_mutex_lock (&read_lock);
1541 if (read_list == NULL)
1543 pthread_mutex_unlock (&read_lock);
1547 le = llist_search (read_list, name);
1550 pthread_mutex_unlock (&read_lock);
1551 WARNING ("plugin_unregister_read: No such read function: %s",
1556 llist_remove (read_list, le);
1559 assert (rf != NULL);
1560 rf->rf_type = RF_REMOVE;
1562 pthread_mutex_unlock (&read_lock);
1564 llentry_destroy (le);
1566 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1569 } /* }}} int plugin_unregister_read */
1571 void plugin_log_available_writers (void)
1573 log_list_callbacks (&list_write, "Available write targets:");
1576 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1578 read_func_t *rf = e->value;
1581 return strcmp (rf->rf_group, (const char *)group);
1582 } /* }}} int compare_read_func_group */
1584 int plugin_unregister_read_group (const char *group) /* {{{ */
1594 pthread_mutex_lock (&read_lock);
1596 if (read_list == NULL)
1598 pthread_mutex_unlock (&read_lock);
1604 le = llist_search_custom (read_list,
1605 compare_read_func_group, (void *)group);
1612 llist_remove (read_list, le);
1615 assert (rf != NULL);
1616 rf->rf_type = RF_REMOVE;
1618 llentry_destroy (le);
1620 DEBUG ("plugin_unregister_read_group: "
1621 "Marked `%s' (group `%s') for removal.",
1622 rf->rf_name, group);
1625 pthread_mutex_unlock (&read_lock);
1629 WARNING ("plugin_unregister_read_group: No such "
1630 "group of read function: %s", group);
1635 } /* }}} int plugin_unregister_read_group */
1637 int plugin_unregister_write (const char *name)
1639 return (plugin_unregister (list_write, name));
1642 int plugin_unregister_flush (const char *name)
1644 plugin_ctx_t ctx = plugin_get_ctx ();
1646 if (ctx.flush_interval != 0)
1650 flush_name = plugin_flush_callback_name (name);
1651 if (flush_name != NULL)
1653 plugin_unregister_read(flush_name);
1658 return plugin_unregister (list_flush, name);
1661 int plugin_unregister_missing (const char *name)
1663 return (plugin_unregister (list_missing, name));
1666 int plugin_unregister_shutdown (const char *name)
1668 return (plugin_unregister (list_shutdown, name));
1671 int plugin_unregister_data_set (const char *name)
1675 if (data_sets == NULL)
1678 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1685 } /* int plugin_unregister_data_set */
1687 int plugin_unregister_log (const char *name)
1689 return (plugin_unregister (list_log, name));
1692 int plugin_unregister_notification (const char *name)
1694 return (plugin_unregister (list_notification, name));
1697 void plugin_init_all (void)
1699 char const *chain_name;
1700 long write_threads_num;
1704 /* Init the value cache */
1707 if (IS_TRUE (global_option_get ("CollectInternalStats")))
1708 record_statistics = 1;
1710 chain_name = global_option_get ("PreCacheChain");
1711 pre_cache_chain = fc_chain_get_by_name (chain_name);
1713 chain_name = global_option_get ("PostCacheChain");
1714 post_cache_chain = fc_chain_get_by_name (chain_name);
1716 write_limit_high = global_option_get_long ("WriteQueueLimitHigh",
1718 if (write_limit_high < 0)
1720 ERROR ("WriteQueueLimitHigh must be positive or zero.");
1721 write_limit_high = 0;
1724 write_limit_low = global_option_get_long ("WriteQueueLimitLow",
1725 /* default = */ write_limit_high / 2);
1726 if (write_limit_low < 0)
1728 ERROR ("WriteQueueLimitLow must be positive or zero.");
1729 write_limit_low = write_limit_high / 2;
1731 else if (write_limit_low > write_limit_high)
1733 ERROR ("WriteQueueLimitLow must not be larger than "
1734 "WriteQueueLimitHigh.");
1735 write_limit_low = write_limit_high;
1738 write_threads_num = global_option_get_long ("WriteThreads",
1740 if (write_threads_num < 1)
1742 ERROR ("WriteThreads must be positive.");
1743 write_threads_num = 5;
1746 start_write_threads ((size_t) write_threads_num);
1748 if ((list_init == NULL) && (read_heap == NULL))
1751 /* Calling all init callbacks before checking if read callbacks
1752 * are available allows the init callbacks to register the read
1754 le = llist_head (list_init);
1757 callback_func_t *cf;
1758 plugin_init_cb callback;
1759 plugin_ctx_t old_ctx;
1762 old_ctx = plugin_set_ctx (cf->cf_ctx);
1763 callback = cf->cf_callback;
1764 status = (*callback) ();
1765 plugin_set_ctx (old_ctx);
1769 ERROR ("Initialization of plugin `%s' "
1770 "failed with status %i. "
1771 "Plugin will be unloaded.",
1773 /* Plugins that register read callbacks from the init
1774 * callback should take care of appropriate error
1775 * handling themselves. */
1776 /* FIXME: Unload _all_ functions */
1777 plugin_unregister_read (le->key);
1783 max_read_interval = global_option_get_time ("MaxReadInterval",
1784 DEFAULT_MAX_READ_INTERVAL);
1786 /* Start read-threads */
1787 if (read_heap != NULL)
1792 rt = global_option_get ("ReadThreads");
1795 start_read_threads ((num > 0) ? num : 5);
1797 } /* void plugin_init_all */
1799 /* TODO: Rename this function. */
1800 void plugin_read_all (void)
1802 if(record_statistics) {
1803 plugin_update_internal_statistics ();
1805 uc_check_timeout ();
1808 } /* void plugin_read_all */
1810 /* Read function called when the `-T' command line argument is given. */
1811 int plugin_read_all_once (void)
1814 int return_status = 0;
1816 if (read_heap == NULL)
1818 NOTICE ("No read-functions are registered.");
1825 plugin_ctx_t old_ctx;
1827 rf = c_heap_get_root (read_heap);
1831 old_ctx = plugin_set_ctx (rf->rf_ctx);
1833 if (rf->rf_type == RF_SIMPLE)
1835 int (*callback) (void);
1837 callback = rf->rf_callback;
1838 status = (*callback) ();
1842 plugin_read_cb callback;
1844 callback = rf->rf_callback;
1845 status = (*callback) (&rf->rf_udata);
1848 plugin_set_ctx (old_ctx);
1852 NOTICE ("read-function of plugin `%s' failed.",
1857 sfree (rf->rf_name);
1858 destroy_callback ((void *) rf);
1861 return (return_status);
1862 } /* int plugin_read_all_once */
1864 int plugin_write (const char *plugin, /* {{{ */
1865 const data_set_t *ds, const value_list_t *vl)
1873 if (list_write == NULL)
1878 ds = plugin_get_ds (vl->type);
1881 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1891 le = llist_head (list_write);
1894 callback_func_t *cf = le->value;
1895 plugin_write_cb callback;
1897 /* do not switch plugin context; rather keep the context (interval)
1898 * information of the calling read plugin */
1900 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1901 callback = cf->cf_callback;
1902 status = (*callback) (ds, vl, &cf->cf_udata);
1911 if ((success == 0) && (failure != 0))
1916 else /* plugin != NULL */
1918 callback_func_t *cf;
1919 plugin_write_cb callback;
1921 le = llist_head (list_write);
1924 if (strcasecmp (plugin, le->key) == 0)
1935 /* do not switch plugin context; rather keep the context (interval)
1936 * information of the calling read plugin */
1938 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1939 callback = cf->cf_callback;
1940 status = (*callback) (ds, vl, &cf->cf_udata);
1944 } /* }}} int plugin_write */
1946 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1950 if (list_flush == NULL)
1953 le = llist_head (list_flush);
1956 callback_func_t *cf;
1957 plugin_flush_cb callback;
1958 plugin_ctx_t old_ctx;
1960 if ((plugin != NULL)
1961 && (strcmp (plugin, le->key) != 0))
1968 old_ctx = plugin_set_ctx (cf->cf_ctx);
1969 callback = cf->cf_callback;
1971 (*callback) (timeout, identifier, &cf->cf_udata);
1973 plugin_set_ctx (old_ctx);
1978 } /* int plugin_flush */
1980 void plugin_shutdown_all (void)
1984 stop_read_threads ();
1986 destroy_all_callbacks (&list_init);
1988 pthread_mutex_lock (&read_lock);
1989 llist_destroy (read_list);
1991 pthread_mutex_unlock (&read_lock);
1993 destroy_read_heap ();
1995 plugin_flush (/* plugin = */ NULL,
1997 /* identifier = */ NULL);
2000 if (list_shutdown != NULL)
2001 le = llist_head (list_shutdown);
2005 callback_func_t *cf;
2006 plugin_shutdown_cb callback;
2007 plugin_ctx_t old_ctx;
2010 old_ctx = plugin_set_ctx (cf->cf_ctx);
2011 callback = cf->cf_callback;
2013 /* Advance the pointer before calling the callback allows
2014 * shutdown functions to unregister themselves. If done the
2015 * other way around the memory `le' points to will be freed
2016 * after callback returns. */
2021 plugin_set_ctx (old_ctx);
2024 stop_write_threads ();
2026 /* Write plugins which use the `user_data' pointer usually need the
2027 * same data available to the flush callback. If this is the case, set
2028 * the free_function to NULL when registering the flush callback and to
2029 * the real free function when registering the write callback. This way
2030 * the data isn't freed twice. */
2031 destroy_all_callbacks (&list_flush);
2032 destroy_all_callbacks (&list_missing);
2033 destroy_all_callbacks (&list_write);
2035 destroy_all_callbacks (&list_notification);
2036 destroy_all_callbacks (&list_shutdown);
2037 destroy_all_callbacks (&list_log);
2039 plugin_free_loaded ();
2040 plugin_free_data_sets ();
2041 } /* void plugin_shutdown_all */
2043 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
2047 if (list_missing == NULL)
2050 le = llist_head (list_missing);
2053 callback_func_t *cf;
2054 plugin_missing_cb callback;
2055 plugin_ctx_t old_ctx;
2059 old_ctx = plugin_set_ctx (cf->cf_ctx);
2060 callback = cf->cf_callback;
2062 status = (*callback) (vl, &cf->cf_udata);
2063 plugin_set_ctx (old_ctx);
2068 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
2069 "failed with status %i.",
2082 } /* int }}} plugin_dispatch_missing */
2084 static int plugin_dispatch_values_internal (value_list_t *vl)
2087 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
2089 value_t *saved_values;
2090 int saved_values_len;
2094 int free_meta_data = 0;
2096 if ((vl == NULL) || (vl->type[0] == 0)
2097 || (vl->values == NULL) || (vl->values_len < 1))
2099 ERROR ("plugin_dispatch_values: Invalid value list "
2100 "from plugin %s.", vl->plugin);
2104 /* Free meta data only if the calling function didn't specify any. In
2105 * this case matches and targets may add some and the calling function
2106 * may not expect (and therefore free) that data. */
2107 if (vl->meta == NULL)
2110 if (list_write == NULL)
2111 c_complain_once (LOG_WARNING, &no_write_complaint,
2112 "plugin_dispatch_values: No write callback has been "
2113 "registered. Please load at least one output plugin, "
2114 "if you want the collected data to be stored.");
2116 if (data_sets == NULL)
2118 ERROR ("plugin_dispatch_values: No data sets registered. "
2119 "Could the types database be read? Check "
2120 "your `TypesDB' setting!");
2124 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
2126 char ident[6 * DATA_MAX_NAME_LEN];
2128 FORMAT_VL (ident, sizeof (ident), vl);
2129 INFO ("plugin_dispatch_values: Dataset not found: %s "
2130 "(from \"%s\"), check your types.db!",
2135 /* Assured by plugin_value_list_clone(). The time is determined at
2136 * _enqueue_ time. */
2137 assert (vl->time != 0);
2138 assert (vl->interval != 0);
2140 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
2142 "plugin = %s; plugin_instance = %s; "
2143 "type = %s; type_instance = %s;",
2144 CDTIME_T_TO_DOUBLE (vl->time),
2145 CDTIME_T_TO_DOUBLE (vl->interval),
2147 vl->plugin, vl->plugin_instance,
2148 vl->type, vl->type_instance);
2151 assert (0 == strcmp (ds->type, vl->type));
2153 if (0 != strcmp (ds->type, vl->type))
2154 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
2155 ds->type, vl->type);
2159 assert (ds->ds_num == vl->values_len);
2161 if (ds->ds_num != vl->values_len)
2163 ERROR ("plugin_dispatch_values: ds->type = %s: "
2164 "(ds->ds_num = %zu) != "
2165 "(vl->values_len = %zu)",
2166 ds->type, ds->ds_num, vl->values_len);
2171 escape_slashes (vl->host, sizeof (vl->host));
2172 escape_slashes (vl->plugin, sizeof (vl->plugin));
2173 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
2174 escape_slashes (vl->type, sizeof (vl->type));
2175 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
2177 /* Copy the values. This way, we can assure `targets' that they get
2178 * dynamically allocated values, which they can free and replace if
2180 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
2182 saved_values = vl->values;
2183 saved_values_len = vl->values_len;
2185 vl->values = (value_t *) calloc (vl->values_len,
2186 sizeof (*vl->values));
2187 if (vl->values == NULL)
2189 ERROR ("plugin_dispatch_values: calloc failed.");
2190 vl->values = saved_values;
2193 memcpy (vl->values, saved_values,
2194 vl->values_len * sizeof (*vl->values));
2196 else /* if ((pre == NULL) && (post == NULL)) */
2198 saved_values = NULL;
2199 saved_values_len = 0;
2202 if (pre_cache_chain != NULL)
2204 status = fc_process_chain (ds, vl, pre_cache_chain);
2207 WARNING ("plugin_dispatch_values: Running the "
2208 "pre-cache chain failed with "
2212 else if (status == FC_TARGET_STOP)
2214 /* Restore the state of the value_list so that plugins
2215 * don't get confused.. */
2216 if (saved_values != NULL)
2219 vl->values = saved_values;
2220 vl->values_len = saved_values_len;
2226 /* Update the value cache */
2229 if (post_cache_chain != NULL)
2231 status = fc_process_chain (ds, vl, post_cache_chain);
2234 WARNING ("plugin_dispatch_values: Running the "
2235 "post-cache chain failed with "
2241 fc_default_action (ds, vl);
2243 /* Restore the state of the value_list so that plugins don't get
2245 if (saved_values != NULL)
2248 vl->values = saved_values;
2249 vl->values_len = saved_values_len;
2252 if ((free_meta_data != 0) && (vl->meta != NULL))
2254 meta_data_destroy (vl->meta);
2259 } /* int plugin_dispatch_values_internal */
2261 static double get_drop_probability (void) /* {{{ */
2267 pthread_mutex_lock (&write_lock);
2268 wql = write_queue_length;
2269 pthread_mutex_unlock (&write_lock);
2271 if (wql < write_limit_low)
2273 if (wql >= write_limit_high)
2276 pos = 1 + wql - write_limit_low;
2277 size = 1 + write_limit_high - write_limit_low;
2279 return (((double) pos) / ((double) size));
2280 } /* }}} double get_drop_probability */
2282 static _Bool check_drop_value (void) /* {{{ */
2284 static cdtime_t last_message_time = 0;
2285 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2291 if (write_limit_high == 0)
2294 p = get_drop_probability ();
2298 status = pthread_mutex_trylock (&last_message_lock);
2304 if ((now - last_message_time) > TIME_T_TO_CDTIME_T (1))
2306 last_message_time = now;
2307 ERROR ("plugin_dispatch_values: Low water mark "
2308 "reached. Dropping %.0f%% of metrics.",
2311 pthread_mutex_unlock (&last_message_lock);
2322 } /* }}} _Bool check_drop_value */
2324 int plugin_dispatch_values (value_list_t const *vl)
2327 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2329 if (check_drop_value ()) {
2330 if(record_statistics) {
2331 pthread_mutex_lock(&statistics_lock);
2332 stats_values_dropped++;
2333 pthread_mutex_unlock(&statistics_lock);
2338 status = plugin_write_enqueue (vl);
2342 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
2343 "with status %i (%s).", status,
2344 sstrerror (status, errbuf, sizeof (errbuf)));
2351 __attribute__((sentinel))
2352 int plugin_dispatch_multivalue (value_list_t const *template, /* {{{ */
2353 _Bool store_percentage, int store_type, ...)
2360 assert (template->values_len == 1);
2362 /* Calculate sum for Gauge to calculate percent if needed */
2363 if (DS_TYPE_GAUGE == store_type) {
2364 va_start (ap, store_type);
2370 name = va_arg (ap, char const *);
2374 value = va_arg (ap, gauge_t);
2382 vl = plugin_value_list_clone (template);
2383 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2384 if (store_percentage)
2385 sstrncpy (vl->type, "percent", sizeof (vl->type));
2387 va_start (ap, store_type);
2393 /* Set the type instance. */
2394 name = va_arg (ap, char const *);
2397 sstrncpy (vl->type_instance, name, sizeof (vl->type_instance));
2399 /* Set the value. */
2403 vl->values[0].gauge = va_arg (ap, gauge_t);
2404 if (store_percentage)
2405 vl->values[0].gauge *= 100.0 / sum;
2407 case DS_TYPE_ABSOLUTE:
2408 vl->values[0].absolute = va_arg (ap, absolute_t);
2410 case DS_TYPE_COUNTER:
2411 vl->values[0].counter = va_arg (ap, counter_t);
2413 case DS_TYPE_DERIVE:
2414 vl->values[0].derive = va_arg (ap, derive_t);
2417 ERROR ("plugin_dispatch_multivalue: given store_type is incorrect.");
2422 status = plugin_write_enqueue (vl);
2428 plugin_value_list_free (vl);
2430 } /* }}} int plugin_dispatch_multivalue */
2432 int plugin_dispatch_notification (const notification_t *notif)
2435 /* Possible TODO: Add flap detection here */
2437 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
2438 "time = %.3f; host = %s;",
2439 notif->severity, notif->message,
2440 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
2442 /* Nobody cares for notifications */
2443 if (list_notification == NULL)
2446 le = llist_head (list_notification);
2449 callback_func_t *cf;
2450 plugin_notification_cb callback;
2453 /* do not switch plugin context; rather keep the context
2454 * (interval) information of the calling plugin */
2457 callback = cf->cf_callback;
2458 status = (*callback) (notif, &cf->cf_udata);
2461 WARNING ("plugin_dispatch_notification: Notification "
2462 "callback %s returned %i.",
2470 } /* int plugin_dispatch_notification */
2472 void plugin_log (int level, const char *format, ...)
2479 if (level >= LOG_DEBUG)
2483 va_start (ap, format);
2484 vsnprintf (msg, sizeof (msg), format, ap);
2485 msg[sizeof (msg) - 1] = '\0';
2488 if (list_log == NULL)
2490 fprintf (stderr, "%s\n", msg);
2494 le = llist_head (list_log);
2497 callback_func_t *cf;
2498 plugin_log_cb callback;
2501 callback = cf->cf_callback;
2503 /* do not switch plugin context; rather keep the context
2504 * (interval) information of the calling plugin */
2506 (*callback) (level, msg, &cf->cf_udata);
2510 } /* void plugin_log */
2512 int parse_log_severity (const char *severity)
2516 if ((0 == strcasecmp (severity, "emerg"))
2517 || (0 == strcasecmp (severity, "alert"))
2518 || (0 == strcasecmp (severity, "crit"))
2519 || (0 == strcasecmp (severity, "err")))
2520 log_level = LOG_ERR;
2521 else if (0 == strcasecmp (severity, "warning"))
2522 log_level = LOG_WARNING;
2523 else if (0 == strcasecmp (severity, "notice"))
2524 log_level = LOG_NOTICE;
2525 else if (0 == strcasecmp (severity, "info"))
2526 log_level = LOG_INFO;
2528 else if (0 == strcasecmp (severity, "debug"))
2529 log_level = LOG_DEBUG;
2530 #endif /* COLLECT_DEBUG */
2533 } /* int parse_log_severity */
2535 int parse_notif_severity (const char *severity)
2537 int notif_severity = -1;
2539 if (strcasecmp (severity, "FAILURE") == 0)
2540 notif_severity = NOTIF_FAILURE;
2541 else if (strcmp (severity, "OKAY") == 0)
2542 notif_severity = NOTIF_OKAY;
2543 else if ((strcmp (severity, "WARNING") == 0)
2544 || (strcmp (severity, "WARN") == 0))
2545 notif_severity = NOTIF_WARNING;
2547 return (notif_severity);
2548 } /* int parse_notif_severity */
2550 const data_set_t *plugin_get_ds (const char *name)
2554 if (data_sets == NULL)
2556 ERROR ("plugin_get_ds: No data sets are defined yet.");
2560 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2562 DEBUG ("No such dataset registered: %s", name);
2567 } /* data_set_t *plugin_get_ds */
2569 static int plugin_notification_meta_add (notification_t *n,
2571 enum notification_meta_type_e type,
2574 notification_meta_t *meta;
2575 notification_meta_t *tail;
2577 if ((n == NULL) || (name == NULL) || (value == NULL))
2579 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2583 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2586 ERROR ("plugin_notification_meta_add: malloc failed.");
2589 memset (meta, 0, sizeof (notification_meta_t));
2591 sstrncpy (meta->name, name, sizeof (meta->name));
2596 case NM_TYPE_STRING:
2598 meta->nm_value.nm_string = strdup ((const char *) value);
2599 if (meta->nm_value.nm_string == NULL)
2601 ERROR ("plugin_notification_meta_add: strdup failed.");
2607 case NM_TYPE_SIGNED_INT:
2609 meta->nm_value.nm_signed_int = *((int64_t *) value);
2612 case NM_TYPE_UNSIGNED_INT:
2614 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2617 case NM_TYPE_DOUBLE:
2619 meta->nm_value.nm_double = *((double *) value);
2622 case NM_TYPE_BOOLEAN:
2624 meta->nm_value.nm_boolean = *((_Bool *) value);
2629 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2633 } /* switch (type) */
2637 while ((tail != NULL) && (tail->next != NULL))
2646 } /* int plugin_notification_meta_add */
2648 int plugin_notification_meta_add_string (notification_t *n,
2652 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2655 int plugin_notification_meta_add_signed_int (notification_t *n,
2659 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2662 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2666 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2669 int plugin_notification_meta_add_double (notification_t *n,
2673 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2676 int plugin_notification_meta_add_boolean (notification_t *n,
2680 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2683 int plugin_notification_meta_copy (notification_t *dst,
2684 const notification_t *src)
2686 notification_meta_t *meta;
2688 assert (dst != NULL);
2689 assert (src != NULL);
2690 assert (dst != src);
2691 assert ((src->meta == NULL) || (src->meta != dst->meta));
2693 for (meta = src->meta; meta != NULL; meta = meta->next)
2695 if (meta->type == NM_TYPE_STRING)
2696 plugin_notification_meta_add_string (dst, meta->name,
2697 meta->nm_value.nm_string);
2698 else if (meta->type == NM_TYPE_SIGNED_INT)
2699 plugin_notification_meta_add_signed_int (dst, meta->name,
2700 meta->nm_value.nm_signed_int);
2701 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2702 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2703 meta->nm_value.nm_unsigned_int);
2704 else if (meta->type == NM_TYPE_DOUBLE)
2705 plugin_notification_meta_add_double (dst, meta->name,
2706 meta->nm_value.nm_double);
2707 else if (meta->type == NM_TYPE_BOOLEAN)
2708 plugin_notification_meta_add_boolean (dst, meta->name,
2709 meta->nm_value.nm_boolean);
2713 } /* int plugin_notification_meta_copy */
2715 int plugin_notification_meta_free (notification_meta_t *n)
2717 notification_meta_t *this;
2718 notification_meta_t *next;
2722 ERROR ("plugin_notification_meta_free: n == NULL!");
2727 while (this != NULL)
2731 if (this->type == NM_TYPE_STRING)
2733 free ((char *)this->nm_value.nm_string);
2734 this->nm_value.nm_string = NULL;
2742 } /* int plugin_notification_meta_free */
2744 static void plugin_ctx_destructor (void *ctx)
2747 } /* void plugin_ctx_destructor */
2749 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2751 static plugin_ctx_t *plugin_ctx_create (void)
2755 ctx = malloc (sizeof (*ctx));
2758 ERROR ("Failed to allocate plugin context: %s",
2759 sstrerror (errno, errbuf, sizeof (errbuf)));
2764 assert (plugin_ctx_key_initialized);
2765 pthread_setspecific (plugin_ctx_key, ctx);
2766 DEBUG("Created new plugin context.");
2768 } /* int plugin_ctx_create */
2770 void plugin_init_ctx (void)
2772 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2773 plugin_ctx_key_initialized = 1;
2774 } /* void plugin_init_ctx */
2776 plugin_ctx_t plugin_get_ctx (void)
2780 assert (plugin_ctx_key_initialized);
2781 ctx = pthread_getspecific (plugin_ctx_key);
2784 ctx = plugin_ctx_create ();
2785 /* this must no happen -- exit() instead? */
2791 } /* plugin_ctx_t plugin_get_ctx */
2793 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2798 assert (plugin_ctx_key_initialized);
2799 c = pthread_getspecific (plugin_ctx_key);
2802 c = plugin_ctx_create ();
2803 /* this must no happen -- exit() instead? */
2812 } /* void plugin_set_ctx */
2814 cdtime_t plugin_get_interval (void)
2818 interval = plugin_get_ctx().interval;
2822 return cf_get_default_interval ();
2823 } /* cdtime_t plugin_get_interval */
2827 void *(*start_routine) (void *);
2831 static void *plugin_thread_start (void *arg)
2833 plugin_thread_t *plugin_thread = arg;
2835 void *(*start_routine) (void *) = plugin_thread->start_routine;
2836 void *plugin_arg = plugin_thread->arg;
2838 plugin_set_ctx (plugin_thread->ctx);
2840 free (plugin_thread);
2842 return start_routine (plugin_arg);
2843 } /* void *plugin_thread_start */
2845 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2846 void *(*start_routine) (void *), void *arg)
2848 plugin_thread_t *plugin_thread;
2850 plugin_thread = malloc (sizeof (*plugin_thread));
2851 if (plugin_thread == NULL)
2854 plugin_thread->ctx = plugin_get_ctx ();
2855 plugin_thread->start_routine = start_routine;
2856 plugin_thread->arg = arg;
2858 return pthread_create (thread, attr,
2859 plugin_thread_start, plugin_thread);
2860 } /* int plugin_thread_create */
2862 /* vim: set sw=8 ts=8 noet fdm=marker : */