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 cf = c_heap_get_root (read_heap);
250 destroy_callback (cf);
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;
491 /* Get the read function that needs to be read next.
492 * We don't need to hold "read_lock" for the heap, but we need
493 * to call c_heap_get_root() and pthread_cond_wait() in the
494 * same protected block. */
495 pthread_mutex_lock (&read_lock);
496 rf = c_heap_get_root (read_heap);
499 pthread_cond_wait (&read_cond, &read_lock);
500 pthread_mutex_unlock (&read_lock);
503 pthread_mutex_unlock (&read_lock);
505 if (rf->rf_interval == 0)
507 /* this should not happen, because the interval is set
508 * for each plugin when loading it
509 * XXX: issue a warning? */
510 rf->rf_interval = plugin_get_interval ();
511 rf->rf_effective_interval = rf->rf_interval;
513 rf->rf_next_read = cdtime ();
516 /* sleep until this entry is due,
517 * using pthread_cond_timedwait */
518 pthread_mutex_lock (&read_lock);
519 /* In pthread_cond_timedwait, spurious wakeups are possible
520 * (and really happen, at least on NetBSD with > 1 CPU), thus
521 * we need to re-evaluate the condition every time
522 * pthread_cond_timedwait returns. */
524 while ((read_loop != 0)
525 && (cdtime () < rf->rf_next_read)
528 struct timespec ts = { 0 };
530 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
532 rc = pthread_cond_timedwait (&read_cond, &read_lock,
536 /* Must hold `read_lock' when accessing `rf->rf_type'. */
537 rf_type = rf->rf_type;
538 pthread_mutex_unlock (&read_lock);
540 /* Check if we're supposed to stop.. This may have interrupted
544 /* Insert `rf' again, so it can be free'd correctly */
545 c_heap_insert (read_heap, rf);
549 /* The entry has been marked for deletion. The linked list
550 * entry has already been removed by `plugin_unregister_read'.
551 * All we have to do here is free the `read_func_t' and
553 if (rf_type == RF_REMOVE)
555 DEBUG ("plugin_read_thread: Destroying the `%s' "
556 "callback.", rf->rf_name);
558 destroy_callback ((callback_func_t *) rf);
563 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
565 old_ctx = plugin_set_ctx (rf->rf_ctx);
567 if (rf_type == RF_SIMPLE)
569 int (*callback) (void);
571 callback = rf->rf_callback;
572 status = (*callback) ();
576 plugin_read_cb callback;
578 assert (rf_type == RF_COMPLEX);
580 callback = rf->rf_callback;
581 status = (*callback) (&rf->rf_udata);
584 plugin_set_ctx (old_ctx);
586 /* If the function signals failure, we will increase the
587 * intervals in which it will be called. */
590 rf->rf_effective_interval *= 2;
591 if (rf->rf_effective_interval > max_read_interval)
592 rf->rf_effective_interval = max_read_interval;
594 NOTICE ("read-function of plugin `%s' failed. "
595 "Will suspend it for %.3f seconds.",
597 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
601 /* Success: Restore the interval, if it was changed. */
602 rf->rf_effective_interval = rf->rf_interval;
605 /* update the ``next read due'' field */
608 DEBUG ("plugin_read_thread: Effective interval of the "
609 "%s plugin is %.3f seconds.",
611 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
613 /* Calculate the next (absolute) time at which this function
614 * should be called. */
615 rf->rf_next_read += rf->rf_effective_interval;
617 /* Check, if `rf_next_read' is in the past. */
618 if (rf->rf_next_read < now)
620 /* `rf_next_read' is in the past. Insert `now'
621 * so this value doesn't trail off into the
623 rf->rf_next_read = now;
626 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
628 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
630 /* Re-insert this read function into the heap again. */
631 c_heap_insert (read_heap, rf);
632 } /* while (read_loop) */
636 } /* void *plugin_read_thread */
638 static void start_read_threads (int num)
642 if (read_threads != NULL)
645 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
646 if (read_threads == NULL)
648 ERROR ("plugin: start_read_threads: calloc failed.");
652 read_threads_num = 0;
653 for (i = 0; i < num; i++)
655 if (pthread_create (read_threads + read_threads_num, NULL,
656 plugin_read_thread, NULL) == 0)
662 ERROR ("plugin: start_read_threads: pthread_create failed.");
666 } /* void start_read_threads */
668 static void stop_read_threads (void)
672 if (read_threads == NULL)
675 INFO ("collectd: Stopping %i read threads.", read_threads_num);
677 pthread_mutex_lock (&read_lock);
679 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
680 pthread_cond_broadcast (&read_cond);
681 pthread_mutex_unlock (&read_lock);
683 for (i = 0; i < read_threads_num; i++)
685 if (pthread_join (read_threads[i], NULL) != 0)
687 ERROR ("plugin: stop_read_threads: pthread_join failed.");
689 read_threads[i] = (pthread_t) 0;
691 sfree (read_threads);
692 read_threads_num = 0;
693 } /* void stop_read_threads */
695 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
700 meta_data_destroy (vl->meta);
703 } /* }}} void plugin_value_list_free */
705 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
712 vl = malloc (sizeof (*vl));
715 memcpy (vl, vl_orig, sizeof (*vl));
717 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
718 if (vl->values == NULL)
720 plugin_value_list_free (vl);
723 memcpy (vl->values, vl_orig->values,
724 vl_orig->values_len * sizeof (*vl->values));
726 vl->meta = meta_data_clone (vl->meta);
727 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
729 plugin_value_list_free (vl);
734 vl->time = cdtime ();
736 /* Fill in the interval from the thread context, if it is zero. */
737 if (vl->interval == 0)
739 plugin_ctx_t ctx = plugin_get_ctx ();
741 if (ctx.interval != 0)
742 vl->interval = ctx.interval;
745 char name[6 * DATA_MAX_NAME_LEN];
746 FORMAT_VL (name, sizeof (name), vl);
747 ERROR ("plugin_value_list_clone: Unable to determine "
748 "interval from context for "
749 "value list \"%s\". "
750 "This indicates a broken plugin. "
751 "Please report this problem to the "
752 "collectd mailing list or at "
753 "<http://collectd.org/bugs/>.", name);
754 vl->interval = cf_get_default_interval ();
759 } /* }}} value_list_t *plugin_value_list_clone */
761 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
765 q = malloc (sizeof (*q));
770 q->vl = plugin_value_list_clone (vl);
777 /* Store context of caller (read plugin); otherwise, it would not be
778 * available to the write plugins when actually dispatching the
779 * value-list later on. */
780 q->ctx = plugin_get_ctx ();
782 pthread_mutex_lock (&write_lock);
784 if (write_queue_tail == NULL)
786 write_queue_head = q;
787 write_queue_tail = q;
788 write_queue_length = 1;
792 write_queue_tail->next = q;
793 write_queue_tail = q;
794 write_queue_length += 1;
797 pthread_cond_signal (&write_cond);
798 pthread_mutex_unlock (&write_lock);
801 } /* }}} int plugin_write_enqueue */
803 static value_list_t *plugin_write_dequeue (void) /* {{{ */
808 pthread_mutex_lock (&write_lock);
810 while (write_loop && (write_queue_head == NULL))
811 pthread_cond_wait (&write_cond, &write_lock);
813 if (write_queue_head == NULL)
815 pthread_mutex_unlock (&write_lock);
819 q = write_queue_head;
820 write_queue_head = q->next;
821 write_queue_length -= 1;
822 if (write_queue_head == NULL) {
823 write_queue_tail = NULL;
824 assert(0 == write_queue_length);
827 pthread_mutex_unlock (&write_lock);
829 (void) plugin_set_ctx (q->ctx);
834 } /* }}} value_list_t *plugin_write_dequeue */
836 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
840 value_list_t *vl = plugin_write_dequeue ();
844 plugin_dispatch_values_internal (vl);
846 plugin_value_list_free (vl);
851 } /* }}} void *plugin_write_thread */
853 static void start_write_threads (size_t num) /* {{{ */
857 if (write_threads != NULL)
860 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
861 if (write_threads == NULL)
863 ERROR ("plugin: start_write_threads: calloc failed.");
867 write_threads_num = 0;
868 for (i = 0; i < num; i++)
872 status = pthread_create (write_threads + write_threads_num,
879 ERROR ("plugin: start_write_threads: pthread_create failed "
880 "with status %i (%s).", status,
881 sstrerror (status, errbuf, sizeof (errbuf)));
887 } /* }}} void start_write_threads */
889 static void stop_write_threads (void) /* {{{ */
894 if (write_threads == NULL)
897 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
899 pthread_mutex_lock (&write_lock);
901 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
902 pthread_cond_broadcast (&write_cond);
903 pthread_mutex_unlock (&write_lock);
905 for (i = 0; i < write_threads_num; i++)
907 if (pthread_join (write_threads[i], NULL) != 0)
909 ERROR ("plugin: stop_write_threads: pthread_join failed.");
911 write_threads[i] = (pthread_t) 0;
913 sfree (write_threads);
914 write_threads_num = 0;
916 pthread_mutex_lock (&write_lock);
918 for (q = write_queue_head; q != NULL; )
920 write_queue_t *q1 = q;
921 plugin_value_list_free (q->vl);
926 write_queue_head = NULL;
927 write_queue_tail = NULL;
928 write_queue_length = 0;
929 pthread_mutex_unlock (&write_lock);
933 WARNING ("plugin: %i value list%s left after shutting down "
934 "the write threads.",
935 i, (i == 1) ? " was" : "s were");
937 } /* }}} void stop_write_threads */
942 void plugin_set_dir (const char *dir)
944 if (plugindir != NULL)
949 else if ((plugindir = strdup (dir)) == NULL)
952 ERROR ("strdup failed: %s",
953 sstrerror (errno, errbuf, sizeof (errbuf)));
957 static _Bool plugin_is_loaded (char const *name)
961 if (plugins_loaded == NULL)
962 plugins_loaded = c_avl_create ((void *) strcasecmp);
963 assert (plugins_loaded != NULL);
965 status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
966 return (status == 0);
969 static int plugin_mark_loaded (char const *name)
974 name_copy = strdup (name);
975 if (name_copy == NULL)
978 status = c_avl_insert (plugins_loaded,
979 /* key = */ name_copy, /* value = */ NULL);
983 static void plugin_free_loaded ()
988 if (plugins_loaded == NULL)
991 while (c_avl_pick (plugins_loaded, &key, &value) == 0)
994 assert (value == NULL);
997 c_avl_destroy (plugins_loaded);
998 plugins_loaded = NULL;
1002 int plugin_load (char const *plugin_name, uint32_t flags)
1006 char filename[BUFSIZE] = "";
1007 char typename[BUFSIZE];
1009 struct stat statbuf;
1013 if (plugin_name == NULL)
1016 /* Check if plugin is already loaded and don't do anything in this
1018 if (plugin_is_loaded (plugin_name))
1021 dir = plugin_get_dir ();
1025 * XXX: Magic at work:
1027 * Some of the language bindings, for example the Python and Perl
1028 * plugins, need to be able to export symbols to the scripts they run.
1029 * For this to happen, the "Globals" flag needs to be set.
1030 * Unfortunately, this technical detail is hard to explain to the
1031 * average user and she shouldn't have to worry about this, ideally.
1032 * So in order to save everyone's sanity use a different default for a
1033 * handful of special plugins. --octo
1035 if ((strcasecmp ("perl", plugin_name) == 0)
1036 || (strcasecmp ("python", plugin_name) == 0))
1037 flags |= PLUGIN_FLAGS_GLOBAL;
1039 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
1040 * type when matching the filename */
1041 status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
1042 if ((status < 0) || ((size_t) status >= sizeof (typename)))
1044 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1048 if ((dh = opendir (dir)) == NULL)
1051 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
1052 sstrerror (errno, errbuf, sizeof (errbuf)));
1056 while ((de = readdir (dh)) != NULL)
1058 if (strcasecmp (de->d_name, typename))
1061 status = ssnprintf (filename, sizeof (filename),
1062 "%s/%s", dir, de->d_name);
1063 if ((status < 0) || ((size_t) status >= sizeof (filename)))
1065 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
1070 if (lstat (filename, &statbuf) == -1)
1073 WARNING ("plugin_load: stat (\"%s\") failed: %s",
1075 sstrerror (errno, errbuf, sizeof (errbuf)));
1078 else if (!S_ISREG (statbuf.st_mode))
1080 /* don't follow symlinks */
1081 WARNING ("plugin_load: %s is not a regular file.",
1086 status = plugin_load_file (filename, flags);
1090 plugin_mark_loaded (plugin_name);
1096 ERROR ("plugin_load: Load plugin \"%s\" failed with "
1097 "status %i.", plugin_name, status);
1103 if (filename[0] == 0)
1104 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
1111 * The `register_*' functions follow
1113 int plugin_register_config (const char *name,
1114 int (*callback) (const char *key, const char *val),
1115 const char **keys, int keys_num)
1117 cf_register (name, callback, keys, keys_num);
1119 } /* int plugin_register_config */
1121 int plugin_register_complex_config (const char *type,
1122 int (*callback) (oconfig_item_t *))
1124 return (cf_register_complex (type, callback));
1125 } /* int plugin_register_complex_config */
1127 int plugin_register_init (const char *name,
1128 int (*callback) (void))
1130 return (create_register_callback (&list_init, name, (void *) callback,
1131 /* user_data = */ NULL));
1132 } /* plugin_register_init */
1134 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1136 const read_func_t *rf0;
1137 const read_func_t *rf1;
1142 if (rf0->rf_next_read < rf1->rf_next_read)
1144 else if (rf0->rf_next_read > rf1->rf_next_read)
1148 } /* int plugin_compare_read_func */
1150 /* Add a read function to both, the heap and a linked list. The linked list if
1151 * used to look-up read functions, especially for the remove function. The heap
1152 * is used to determine which plugin to read next. */
1153 static int plugin_insert_read (read_func_t *rf)
1158 rf->rf_next_read = cdtime ();
1159 rf->rf_effective_interval = rf->rf_interval;
1161 pthread_mutex_lock (&read_lock);
1163 if (read_list == NULL)
1165 read_list = llist_create ();
1166 if (read_list == NULL)
1168 pthread_mutex_unlock (&read_lock);
1169 ERROR ("plugin_insert_read: read_list failed.");
1174 if (read_heap == NULL)
1176 read_heap = c_heap_create (plugin_compare_read_func);
1177 if (read_heap == NULL)
1179 pthread_mutex_unlock (&read_lock);
1180 ERROR ("plugin_insert_read: c_heap_create failed.");
1185 le = llist_search (read_list, rf->rf_name);
1188 pthread_mutex_unlock (&read_lock);
1189 WARNING ("The read function \"%s\" is already registered. "
1190 "Check for duplicate \"LoadPlugin\" lines "
1191 "in your configuration!",
1196 le = llentry_create (rf->rf_name, rf);
1199 pthread_mutex_unlock (&read_lock);
1200 ERROR ("plugin_insert_read: llentry_create failed.");
1204 status = c_heap_insert (read_heap, rf);
1207 pthread_mutex_unlock (&read_lock);
1208 ERROR ("plugin_insert_read: c_heap_insert failed.");
1209 llentry_destroy (le);
1213 /* This does not fail. */
1214 llist_append (read_list, le);
1216 /* Wake up all the read threads. */
1217 pthread_cond_broadcast (&read_cond);
1218 pthread_mutex_unlock (&read_lock);
1220 } /* int plugin_insert_read */
1222 int plugin_register_read (const char *name,
1223 int (*callback) (void))
1228 rf = malloc (sizeof (*rf));
1231 ERROR ("plugin_register_read: malloc failed.");
1235 memset (rf, 0, sizeof (read_func_t));
1236 rf->rf_callback = (void *) callback;
1237 rf->rf_udata.data = NULL;
1238 rf->rf_udata.free_func = NULL;
1239 rf->rf_ctx = plugin_get_ctx ();
1240 rf->rf_group[0] = '\0';
1241 rf->rf_name = strdup (name);
1242 rf->rf_type = RF_SIMPLE;
1243 rf->rf_interval = plugin_get_interval ();
1245 status = plugin_insert_read (rf);
1250 } /* int plugin_register_read */
1252 int plugin_register_complex_read (const char *group, const char *name,
1253 plugin_read_cb callback,
1255 user_data_t *user_data)
1260 rf = malloc (sizeof (*rf));
1263 ERROR ("plugin_register_complex_read: malloc failed.");
1267 memset (rf, 0, sizeof (read_func_t));
1268 rf->rf_callback = (void *) callback;
1270 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1272 rf->rf_group[0] = '\0';
1273 rf->rf_name = strdup (name);
1274 rf->rf_type = RF_COMPLEX;
1275 rf->rf_interval = (interval != 0) ? interval : plugin_get_interval ();
1278 if (user_data == NULL)
1280 rf->rf_udata.data = NULL;
1281 rf->rf_udata.free_func = NULL;
1285 rf->rf_udata = *user_data;
1288 rf->rf_ctx = plugin_get_ctx ();
1290 status = plugin_insert_read (rf);
1295 } /* int plugin_register_complex_read */
1297 int plugin_register_write (const char *name,
1298 plugin_write_cb callback, user_data_t *ud)
1300 return (create_register_callback (&list_write, name,
1301 (void *) callback, ud));
1302 } /* int plugin_register_write */
1304 static int plugin_flush_timeout_callback (user_data_t *ud)
1306 flush_callback_t *cb = ud->data;
1308 return plugin_flush (cb->name, cb->timeout, /* identifier = */ NULL);
1309 } /* static int plugin_flush_callback */
1311 static void plugin_flush_timeout_callback_free (void *data)
1313 flush_callback_t *cb = data;
1315 if (cb == NULL) return;
1319 } /* static void plugin_flush_callback_free */
1321 static char *plugin_flush_callback_name (const char *name)
1323 char *flush_prefix = "flush/";
1328 prefix_size = strlen(flush_prefix);
1329 name_size = strlen(name);
1331 flush_name = malloc (sizeof(char) * (name_size + prefix_size + 1));
1332 if (flush_name == NULL)
1334 ERROR ("plugin_flush_callback_name: malloc failed.");
1338 sstrncpy (flush_name, flush_prefix, prefix_size + 1);
1339 sstrncpy (flush_name + prefix_size, name, name_size + 1);
1342 } /* static char *plugin_flush_callback_name */
1344 int plugin_register_flush (const char *name,
1345 plugin_flush_cb callback, user_data_t *ud)
1348 plugin_ctx_t ctx = plugin_get_ctx ();
1350 status = create_register_callback (&list_flush, name,
1351 (void *) callback, ud);
1355 if (ctx.flush_interval != 0)
1359 flush_callback_t *cb;
1361 flush_name = plugin_flush_callback_name (name);
1362 if (flush_name == NULL)
1365 cb = malloc(sizeof(flush_callback_t));
1368 ERROR ("plugin_register_flush: malloc failed.");
1373 cb->name = strdup (name);
1374 if (cb->name == NULL)
1376 ERROR ("plugin_register_flush: strdup failed.");
1381 cb->timeout = ctx.flush_timeout;
1384 ud.free_func = plugin_flush_timeout_callback_free;
1386 status = plugin_register_complex_read (
1387 /* group = */ "flush",
1388 /* name = */ flush_name,
1389 /* callback = */ plugin_flush_timeout_callback,
1390 /* interval = */ ctx.flush_interval,
1391 /* user data = */ &ud);
1403 } /* int plugin_register_flush */
1405 int plugin_register_missing (const char *name,
1406 plugin_missing_cb callback, user_data_t *ud)
1408 return (create_register_callback (&list_missing, name,
1409 (void *) callback, ud));
1410 } /* int plugin_register_missing */
1412 int plugin_register_shutdown (const char *name,
1413 int (*callback) (void))
1415 return (create_register_callback (&list_shutdown, name,
1416 (void *) callback, /* user_data = */ NULL));
1417 } /* int plugin_register_shutdown */
1419 static void plugin_free_data_sets (void)
1424 if (data_sets == NULL)
1427 while (c_avl_pick (data_sets, &key, &value) == 0)
1429 data_set_t *ds = value;
1430 /* key is a pointer to ds->type */
1436 c_avl_destroy (data_sets);
1438 } /* void plugin_free_data_sets */
1440 int plugin_register_data_set (const data_set_t *ds)
1442 data_set_t *ds_copy;
1445 if ((data_sets != NULL)
1446 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1448 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1449 plugin_unregister_data_set (ds->type);
1451 else if (data_sets == NULL)
1453 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1454 if (data_sets == NULL)
1458 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1459 if (ds_copy == NULL)
1461 memcpy(ds_copy, ds, sizeof (data_set_t));
1463 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1465 if (ds_copy->ds == NULL)
1471 for (i = 0; i < ds->ds_num; i++)
1472 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1474 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1475 } /* int plugin_register_data_set */
1477 int plugin_register_log (const char *name,
1478 plugin_log_cb callback, user_data_t *ud)
1480 return (create_register_callback (&list_log, name,
1481 (void *) callback, ud));
1482 } /* int plugin_register_log */
1484 int plugin_register_notification (const char *name,
1485 plugin_notification_cb callback, user_data_t *ud)
1487 return (create_register_callback (&list_notification, name,
1488 (void *) callback, ud));
1489 } /* int plugin_register_log */
1491 int plugin_unregister_config (const char *name)
1493 cf_unregister (name);
1495 } /* int plugin_unregister_config */
1497 int plugin_unregister_complex_config (const char *name)
1499 cf_unregister_complex (name);
1501 } /* int plugin_unregister_complex_config */
1503 int plugin_unregister_init (const char *name)
1505 return (plugin_unregister (list_init, name));
1508 int plugin_unregister_read (const char *name) /* {{{ */
1516 pthread_mutex_lock (&read_lock);
1518 if (read_list == NULL)
1520 pthread_mutex_unlock (&read_lock);
1524 le = llist_search (read_list, name);
1527 pthread_mutex_unlock (&read_lock);
1528 WARNING ("plugin_unregister_read: No such read function: %s",
1533 llist_remove (read_list, le);
1536 assert (rf != NULL);
1537 rf->rf_type = RF_REMOVE;
1539 pthread_mutex_unlock (&read_lock);
1541 llentry_destroy (le);
1543 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1546 } /* }}} int plugin_unregister_read */
1548 void plugin_log_available_writers (void)
1550 log_list_callbacks (&list_write, "Available write targets:");
1553 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1555 read_func_t *rf = e->value;
1558 return strcmp (rf->rf_group, (const char *)group);
1559 } /* }}} int compare_read_func_group */
1561 int plugin_unregister_read_group (const char *group) /* {{{ */
1571 pthread_mutex_lock (&read_lock);
1573 if (read_list == NULL)
1575 pthread_mutex_unlock (&read_lock);
1581 le = llist_search_custom (read_list,
1582 compare_read_func_group, (void *)group);
1589 llist_remove (read_list, le);
1592 assert (rf != NULL);
1593 rf->rf_type = RF_REMOVE;
1595 llentry_destroy (le);
1597 DEBUG ("plugin_unregister_read_group: "
1598 "Marked `%s' (group `%s') for removal.",
1599 rf->rf_name, group);
1602 pthread_mutex_unlock (&read_lock);
1606 WARNING ("plugin_unregister_read_group: No such "
1607 "group of read function: %s", group);
1612 } /* }}} int plugin_unregister_read_group */
1614 int plugin_unregister_write (const char *name)
1616 return (plugin_unregister (list_write, name));
1619 int plugin_unregister_flush (const char *name)
1621 plugin_ctx_t ctx = plugin_get_ctx ();
1623 if (ctx.flush_interval != 0)
1627 flush_name = plugin_flush_callback_name (name);
1628 if (flush_name != NULL)
1630 plugin_unregister_read(flush_name);
1635 return plugin_unregister (list_flush, name);
1638 int plugin_unregister_missing (const char *name)
1640 return (plugin_unregister (list_missing, name));
1643 int plugin_unregister_shutdown (const char *name)
1645 return (plugin_unregister (list_shutdown, name));
1648 int plugin_unregister_data_set (const char *name)
1652 if (data_sets == NULL)
1655 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1662 } /* int plugin_unregister_data_set */
1664 int plugin_unregister_log (const char *name)
1666 return (plugin_unregister (list_log, name));
1669 int plugin_unregister_notification (const char *name)
1671 return (plugin_unregister (list_notification, name));
1674 void plugin_init_all (void)
1676 char const *chain_name;
1677 long write_threads_num;
1681 /* Init the value cache */
1684 if (IS_TRUE (global_option_get ("CollectInternalStats")))
1685 record_statistics = 1;
1687 chain_name = global_option_get ("PreCacheChain");
1688 pre_cache_chain = fc_chain_get_by_name (chain_name);
1690 chain_name = global_option_get ("PostCacheChain");
1691 post_cache_chain = fc_chain_get_by_name (chain_name);
1693 write_limit_high = global_option_get_long ("WriteQueueLimitHigh",
1695 if (write_limit_high < 0)
1697 ERROR ("WriteQueueLimitHigh must be positive or zero.");
1698 write_limit_high = 0;
1701 write_limit_low = global_option_get_long ("WriteQueueLimitLow",
1702 /* default = */ write_limit_high / 2);
1703 if (write_limit_low < 0)
1705 ERROR ("WriteQueueLimitLow must be positive or zero.");
1706 write_limit_low = write_limit_high / 2;
1708 else if (write_limit_low > write_limit_high)
1710 ERROR ("WriteQueueLimitLow must not be larger than "
1711 "WriteQueueLimitHigh.");
1712 write_limit_low = write_limit_high;
1715 write_threads_num = global_option_get_long ("WriteThreads",
1717 if (write_threads_num < 1)
1719 ERROR ("WriteThreads must be positive.");
1720 write_threads_num = 5;
1723 start_write_threads ((size_t) write_threads_num);
1725 if ((list_init == NULL) && (read_heap == NULL))
1728 /* Calling all init callbacks before checking if read callbacks
1729 * are available allows the init callbacks to register the read
1731 le = llist_head (list_init);
1734 callback_func_t *cf;
1735 plugin_init_cb callback;
1736 plugin_ctx_t old_ctx;
1739 old_ctx = plugin_set_ctx (cf->cf_ctx);
1740 callback = cf->cf_callback;
1741 status = (*callback) ();
1742 plugin_set_ctx (old_ctx);
1746 ERROR ("Initialization of plugin `%s' "
1747 "failed with status %i. "
1748 "Plugin will be unloaded.",
1750 /* Plugins that register read callbacks from the init
1751 * callback should take care of appropriate error
1752 * handling themselves. */
1753 /* FIXME: Unload _all_ functions */
1754 plugin_unregister_read (le->key);
1760 max_read_interval = global_option_get_time ("MaxReadInterval",
1761 DEFAULT_MAX_READ_INTERVAL);
1763 /* Start read-threads */
1764 if (read_heap != NULL)
1769 rt = global_option_get ("ReadThreads");
1772 start_read_threads ((num > 0) ? num : 5);
1774 } /* void plugin_init_all */
1776 /* TODO: Rename this function. */
1777 void plugin_read_all (void)
1779 if(record_statistics) {
1780 plugin_update_internal_statistics ();
1782 uc_check_timeout ();
1785 } /* void plugin_read_all */
1787 /* Read function called when the `-T' command line argument is given. */
1788 int plugin_read_all_once (void)
1791 int return_status = 0;
1793 if (read_heap == NULL)
1795 NOTICE ("No read-functions are registered.");
1802 plugin_ctx_t old_ctx;
1804 rf = c_heap_get_root (read_heap);
1808 old_ctx = plugin_set_ctx (rf->rf_ctx);
1810 if (rf->rf_type == RF_SIMPLE)
1812 int (*callback) (void);
1814 callback = rf->rf_callback;
1815 status = (*callback) ();
1819 plugin_read_cb callback;
1821 callback = rf->rf_callback;
1822 status = (*callback) (&rf->rf_udata);
1825 plugin_set_ctx (old_ctx);
1829 NOTICE ("read-function of plugin `%s' failed.",
1834 destroy_callback ((void *) rf);
1837 return (return_status);
1838 } /* int plugin_read_all_once */
1840 int plugin_write (const char *plugin, /* {{{ */
1841 const data_set_t *ds, const value_list_t *vl)
1849 if (list_write == NULL)
1854 ds = plugin_get_ds (vl->type);
1857 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1867 le = llist_head (list_write);
1870 callback_func_t *cf = le->value;
1871 plugin_write_cb callback;
1873 /* do not switch plugin context; rather keep the context (interval)
1874 * information of the calling read plugin */
1876 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1877 callback = cf->cf_callback;
1878 status = (*callback) (ds, vl, &cf->cf_udata);
1887 if ((success == 0) && (failure != 0))
1892 else /* plugin != NULL */
1894 callback_func_t *cf;
1895 plugin_write_cb callback;
1897 le = llist_head (list_write);
1900 if (strcasecmp (plugin, le->key) == 0)
1911 /* do not switch plugin context; rather keep the context (interval)
1912 * information of the calling read plugin */
1914 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1915 callback = cf->cf_callback;
1916 status = (*callback) (ds, vl, &cf->cf_udata);
1920 } /* }}} int plugin_write */
1922 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1926 if (list_flush == NULL)
1929 le = llist_head (list_flush);
1932 callback_func_t *cf;
1933 plugin_flush_cb callback;
1934 plugin_ctx_t old_ctx;
1936 if ((plugin != NULL)
1937 && (strcmp (plugin, le->key) != 0))
1944 old_ctx = plugin_set_ctx (cf->cf_ctx);
1945 callback = cf->cf_callback;
1947 (*callback) (timeout, identifier, &cf->cf_udata);
1949 plugin_set_ctx (old_ctx);
1954 } /* int plugin_flush */
1956 void plugin_shutdown_all (void)
1960 stop_read_threads ();
1962 destroy_all_callbacks (&list_init);
1964 pthread_mutex_lock (&read_lock);
1965 llist_destroy (read_list);
1967 pthread_mutex_unlock (&read_lock);
1969 destroy_read_heap ();
1971 plugin_flush (/* plugin = */ NULL,
1973 /* identifier = */ NULL);
1976 if (list_shutdown != NULL)
1977 le = llist_head (list_shutdown);
1981 callback_func_t *cf;
1982 plugin_shutdown_cb callback;
1983 plugin_ctx_t old_ctx;
1986 old_ctx = plugin_set_ctx (cf->cf_ctx);
1987 callback = cf->cf_callback;
1989 /* Advance the pointer before calling the callback allows
1990 * shutdown functions to unregister themselves. If done the
1991 * other way around the memory `le' points to will be freed
1992 * after callback returns. */
1997 plugin_set_ctx (old_ctx);
2000 stop_write_threads ();
2002 /* Write plugins which use the `user_data' pointer usually need the
2003 * same data available to the flush callback. If this is the case, set
2004 * the free_function to NULL when registering the flush callback and to
2005 * the real free function when registering the write callback. This way
2006 * the data isn't freed twice. */
2007 destroy_all_callbacks (&list_flush);
2008 destroy_all_callbacks (&list_missing);
2009 destroy_all_callbacks (&list_write);
2011 destroy_all_callbacks (&list_notification);
2012 destroy_all_callbacks (&list_shutdown);
2013 destroy_all_callbacks (&list_log);
2015 plugin_free_loaded ();
2016 plugin_free_data_sets ();
2017 } /* void plugin_shutdown_all */
2019 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
2023 if (list_missing == NULL)
2026 le = llist_head (list_missing);
2029 callback_func_t *cf;
2030 plugin_missing_cb callback;
2031 plugin_ctx_t old_ctx;
2035 old_ctx = plugin_set_ctx (cf->cf_ctx);
2036 callback = cf->cf_callback;
2038 status = (*callback) (vl, &cf->cf_udata);
2039 plugin_set_ctx (old_ctx);
2044 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
2045 "failed with status %i.",
2058 } /* int }}} plugin_dispatch_missing */
2060 static int plugin_dispatch_values_internal (value_list_t *vl)
2063 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
2065 value_t *saved_values;
2066 int saved_values_len;
2070 int free_meta_data = 0;
2072 if ((vl == NULL) || (vl->type[0] == 0)
2073 || (vl->values == NULL) || (vl->values_len < 1))
2075 ERROR ("plugin_dispatch_values: Invalid value list "
2076 "from plugin %s.", vl->plugin);
2080 /* Free meta data only if the calling function didn't specify any. In
2081 * this case matches and targets may add some and the calling function
2082 * may not expect (and therefore free) that data. */
2083 if (vl->meta == NULL)
2086 if (list_write == NULL)
2087 c_complain_once (LOG_WARNING, &no_write_complaint,
2088 "plugin_dispatch_values: No write callback has been "
2089 "registered. Please load at least one output plugin, "
2090 "if you want the collected data to be stored.");
2092 if (data_sets == NULL)
2094 ERROR ("plugin_dispatch_values: No data sets registered. "
2095 "Could the types database be read? Check "
2096 "your `TypesDB' setting!");
2100 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
2102 char ident[6 * DATA_MAX_NAME_LEN];
2104 FORMAT_VL (ident, sizeof (ident), vl);
2105 INFO ("plugin_dispatch_values: Dataset not found: %s "
2106 "(from \"%s\"), check your types.db!",
2111 /* Assured by plugin_value_list_clone(). The time is determined at
2112 * _enqueue_ time. */
2113 assert (vl->time != 0);
2114 assert (vl->interval != 0);
2116 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
2118 "plugin = %s; plugin_instance = %s; "
2119 "type = %s; type_instance = %s;",
2120 CDTIME_T_TO_DOUBLE (vl->time),
2121 CDTIME_T_TO_DOUBLE (vl->interval),
2123 vl->plugin, vl->plugin_instance,
2124 vl->type, vl->type_instance);
2127 assert (0 == strcmp (ds->type, vl->type));
2129 if (0 != strcmp (ds->type, vl->type))
2130 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
2131 ds->type, vl->type);
2135 assert (ds->ds_num == vl->values_len);
2137 if (ds->ds_num != vl->values_len)
2139 ERROR ("plugin_dispatch_values: ds->type = %s: "
2140 "(ds->ds_num = %zu) != "
2141 "(vl->values_len = %zu)",
2142 ds->type, ds->ds_num, vl->values_len);
2147 escape_slashes (vl->host, sizeof (vl->host));
2148 escape_slashes (vl->plugin, sizeof (vl->plugin));
2149 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
2150 escape_slashes (vl->type, sizeof (vl->type));
2151 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
2153 /* Copy the values. This way, we can assure `targets' that they get
2154 * dynamically allocated values, which they can free and replace if
2156 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
2158 saved_values = vl->values;
2159 saved_values_len = vl->values_len;
2161 vl->values = (value_t *) calloc (vl->values_len,
2162 sizeof (*vl->values));
2163 if (vl->values == NULL)
2165 ERROR ("plugin_dispatch_values: calloc failed.");
2166 vl->values = saved_values;
2169 memcpy (vl->values, saved_values,
2170 vl->values_len * sizeof (*vl->values));
2172 else /* if ((pre == NULL) && (post == NULL)) */
2174 saved_values = NULL;
2175 saved_values_len = 0;
2178 if (pre_cache_chain != NULL)
2180 status = fc_process_chain (ds, vl, pre_cache_chain);
2183 WARNING ("plugin_dispatch_values: Running the "
2184 "pre-cache chain failed with "
2188 else if (status == FC_TARGET_STOP)
2190 /* Restore the state of the value_list so that plugins
2191 * don't get confused.. */
2192 if (saved_values != NULL)
2195 vl->values = saved_values;
2196 vl->values_len = saved_values_len;
2202 /* Update the value cache */
2205 if (post_cache_chain != NULL)
2207 status = fc_process_chain (ds, vl, post_cache_chain);
2210 WARNING ("plugin_dispatch_values: Running the "
2211 "post-cache chain failed with "
2217 fc_default_action (ds, vl);
2219 /* Restore the state of the value_list so that plugins don't get
2221 if (saved_values != NULL)
2224 vl->values = saved_values;
2225 vl->values_len = saved_values_len;
2228 if ((free_meta_data != 0) && (vl->meta != NULL))
2230 meta_data_destroy (vl->meta);
2235 } /* int plugin_dispatch_values_internal */
2237 static double get_drop_probability (void) /* {{{ */
2243 pthread_mutex_lock (&write_lock);
2244 wql = write_queue_length;
2245 pthread_mutex_unlock (&write_lock);
2247 if (wql < write_limit_low)
2249 if (wql >= write_limit_high)
2252 pos = 1 + wql - write_limit_low;
2253 size = 1 + write_limit_high - write_limit_low;
2255 return (((double) pos) / ((double) size));
2256 } /* }}} double get_drop_probability */
2258 static _Bool check_drop_value (void) /* {{{ */
2260 static cdtime_t last_message_time = 0;
2261 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2267 if (write_limit_high == 0)
2270 p = get_drop_probability ();
2274 status = pthread_mutex_trylock (&last_message_lock);
2280 if ((now - last_message_time) > TIME_T_TO_CDTIME_T (1))
2282 last_message_time = now;
2283 ERROR ("plugin_dispatch_values: Low water mark "
2284 "reached. Dropping %.0f%% of metrics.",
2287 pthread_mutex_unlock (&last_message_lock);
2298 } /* }}} _Bool check_drop_value */
2300 int plugin_dispatch_values (value_list_t const *vl)
2303 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2305 if (check_drop_value ()) {
2306 if(record_statistics) {
2307 pthread_mutex_lock(&statistics_lock);
2308 stats_values_dropped++;
2309 pthread_mutex_unlock(&statistics_lock);
2314 status = plugin_write_enqueue (vl);
2318 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
2319 "with status %i (%s).", status,
2320 sstrerror (status, errbuf, sizeof (errbuf)));
2327 __attribute__((sentinel))
2328 int plugin_dispatch_multivalue (value_list_t const *template, /* {{{ */
2329 _Bool store_percentage, int store_type, ...)
2336 assert (template->values_len == 1);
2338 /* Calculate sum for Gauge to calculate percent if needed */
2339 if (DS_TYPE_GAUGE == store_type) {
2340 va_start (ap, store_type);
2346 name = va_arg (ap, char const *);
2350 value = va_arg (ap, gauge_t);
2358 vl = plugin_value_list_clone (template);
2359 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2360 if (store_percentage)
2361 sstrncpy (vl->type, "percent", sizeof (vl->type));
2363 va_start (ap, store_type);
2369 /* Set the type instance. */
2370 name = va_arg (ap, char const *);
2373 sstrncpy (vl->type_instance, name, sizeof (vl->type_instance));
2375 /* Set the value. */
2379 vl->values[0].gauge = va_arg (ap, gauge_t);
2380 if (store_percentage)
2381 vl->values[0].gauge *= 100.0 / sum;
2383 case DS_TYPE_ABSOLUTE:
2384 vl->values[0].absolute = va_arg (ap, absolute_t);
2386 case DS_TYPE_COUNTER:
2387 vl->values[0].counter = va_arg (ap, counter_t);
2389 case DS_TYPE_DERIVE:
2390 vl->values[0].derive = va_arg (ap, derive_t);
2393 ERROR ("plugin_dispatch_multivalue: given store_type is incorrect.");
2398 status = plugin_write_enqueue (vl);
2404 plugin_value_list_free (vl);
2406 } /* }}} int plugin_dispatch_multivalue */
2408 int plugin_dispatch_notification (const notification_t *notif)
2411 /* Possible TODO: Add flap detection here */
2413 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
2414 "time = %.3f; host = %s;",
2415 notif->severity, notif->message,
2416 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
2418 /* Nobody cares for notifications */
2419 if (list_notification == NULL)
2422 le = llist_head (list_notification);
2425 callback_func_t *cf;
2426 plugin_notification_cb callback;
2429 /* do not switch plugin context; rather keep the context
2430 * (interval) information of the calling plugin */
2433 callback = cf->cf_callback;
2434 status = (*callback) (notif, &cf->cf_udata);
2437 WARNING ("plugin_dispatch_notification: Notification "
2438 "callback %s returned %i.",
2446 } /* int plugin_dispatch_notification */
2448 void plugin_log (int level, const char *format, ...)
2455 if (level >= LOG_DEBUG)
2459 va_start (ap, format);
2460 vsnprintf (msg, sizeof (msg), format, ap);
2461 msg[sizeof (msg) - 1] = '\0';
2464 if (list_log == NULL)
2466 fprintf (stderr, "%s\n", msg);
2470 le = llist_head (list_log);
2473 callback_func_t *cf;
2474 plugin_log_cb callback;
2477 callback = cf->cf_callback;
2479 /* do not switch plugin context; rather keep the context
2480 * (interval) information of the calling plugin */
2482 (*callback) (level, msg, &cf->cf_udata);
2486 } /* void plugin_log */
2488 int parse_log_severity (const char *severity)
2492 if ((0 == strcasecmp (severity, "emerg"))
2493 || (0 == strcasecmp (severity, "alert"))
2494 || (0 == strcasecmp (severity, "crit"))
2495 || (0 == strcasecmp (severity, "err")))
2496 log_level = LOG_ERR;
2497 else if (0 == strcasecmp (severity, "warning"))
2498 log_level = LOG_WARNING;
2499 else if (0 == strcasecmp (severity, "notice"))
2500 log_level = LOG_NOTICE;
2501 else if (0 == strcasecmp (severity, "info"))
2502 log_level = LOG_INFO;
2504 else if (0 == strcasecmp (severity, "debug"))
2505 log_level = LOG_DEBUG;
2506 #endif /* COLLECT_DEBUG */
2509 } /* int parse_log_severity */
2511 int parse_notif_severity (const char *severity)
2513 int notif_severity = -1;
2515 if (strcasecmp (severity, "FAILURE") == 0)
2516 notif_severity = NOTIF_FAILURE;
2517 else if (strcmp (severity, "OKAY") == 0)
2518 notif_severity = NOTIF_OKAY;
2519 else if ((strcmp (severity, "WARNING") == 0)
2520 || (strcmp (severity, "WARN") == 0))
2521 notif_severity = NOTIF_WARNING;
2523 return (notif_severity);
2524 } /* int parse_notif_severity */
2526 const data_set_t *plugin_get_ds (const char *name)
2530 if (data_sets == NULL)
2532 ERROR ("plugin_get_ds: No data sets are defined yet.");
2536 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2538 DEBUG ("No such dataset registered: %s", name);
2543 } /* data_set_t *plugin_get_ds */
2545 static int plugin_notification_meta_add (notification_t *n,
2547 enum notification_meta_type_e type,
2550 notification_meta_t *meta;
2551 notification_meta_t *tail;
2553 if ((n == NULL) || (name == NULL) || (value == NULL))
2555 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2559 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2562 ERROR ("plugin_notification_meta_add: malloc failed.");
2565 memset (meta, 0, sizeof (notification_meta_t));
2567 sstrncpy (meta->name, name, sizeof (meta->name));
2572 case NM_TYPE_STRING:
2574 meta->nm_value.nm_string = strdup ((const char *) value);
2575 if (meta->nm_value.nm_string == NULL)
2577 ERROR ("plugin_notification_meta_add: strdup failed.");
2583 case NM_TYPE_SIGNED_INT:
2585 meta->nm_value.nm_signed_int = *((int64_t *) value);
2588 case NM_TYPE_UNSIGNED_INT:
2590 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2593 case NM_TYPE_DOUBLE:
2595 meta->nm_value.nm_double = *((double *) value);
2598 case NM_TYPE_BOOLEAN:
2600 meta->nm_value.nm_boolean = *((_Bool *) value);
2605 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2609 } /* switch (type) */
2613 while ((tail != NULL) && (tail->next != NULL))
2622 } /* int plugin_notification_meta_add */
2624 int plugin_notification_meta_add_string (notification_t *n,
2628 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2631 int plugin_notification_meta_add_signed_int (notification_t *n,
2635 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2638 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2642 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2645 int plugin_notification_meta_add_double (notification_t *n,
2649 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2652 int plugin_notification_meta_add_boolean (notification_t *n,
2656 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2659 int plugin_notification_meta_copy (notification_t *dst,
2660 const notification_t *src)
2662 notification_meta_t *meta;
2664 assert (dst != NULL);
2665 assert (src != NULL);
2666 assert (dst != src);
2667 assert ((src->meta == NULL) || (src->meta != dst->meta));
2669 for (meta = src->meta; meta != NULL; meta = meta->next)
2671 if (meta->type == NM_TYPE_STRING)
2672 plugin_notification_meta_add_string (dst, meta->name,
2673 meta->nm_value.nm_string);
2674 else if (meta->type == NM_TYPE_SIGNED_INT)
2675 plugin_notification_meta_add_signed_int (dst, meta->name,
2676 meta->nm_value.nm_signed_int);
2677 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2678 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2679 meta->nm_value.nm_unsigned_int);
2680 else if (meta->type == NM_TYPE_DOUBLE)
2681 plugin_notification_meta_add_double (dst, meta->name,
2682 meta->nm_value.nm_double);
2683 else if (meta->type == NM_TYPE_BOOLEAN)
2684 plugin_notification_meta_add_boolean (dst, meta->name,
2685 meta->nm_value.nm_boolean);
2689 } /* int plugin_notification_meta_copy */
2691 int plugin_notification_meta_free (notification_meta_t *n)
2693 notification_meta_t *this;
2694 notification_meta_t *next;
2698 ERROR ("plugin_notification_meta_free: n == NULL!");
2703 while (this != NULL)
2707 if (this->type == NM_TYPE_STRING)
2709 free ((char *)this->nm_value.nm_string);
2710 this->nm_value.nm_string = NULL;
2718 } /* int plugin_notification_meta_free */
2720 static void plugin_ctx_destructor (void *ctx)
2723 } /* void plugin_ctx_destructor */
2725 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2727 static plugin_ctx_t *plugin_ctx_create (void)
2731 ctx = malloc (sizeof (*ctx));
2734 ERROR ("Failed to allocate plugin context: %s",
2735 sstrerror (errno, errbuf, sizeof (errbuf)));
2740 assert (plugin_ctx_key_initialized);
2741 pthread_setspecific (plugin_ctx_key, ctx);
2742 DEBUG("Created new plugin context.");
2744 } /* int plugin_ctx_create */
2746 void plugin_init_ctx (void)
2748 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2749 plugin_ctx_key_initialized = 1;
2750 } /* void plugin_init_ctx */
2752 plugin_ctx_t plugin_get_ctx (void)
2756 assert (plugin_ctx_key_initialized);
2757 ctx = pthread_getspecific (plugin_ctx_key);
2760 ctx = plugin_ctx_create ();
2761 /* this must no happen -- exit() instead? */
2767 } /* plugin_ctx_t plugin_get_ctx */
2769 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2774 assert (plugin_ctx_key_initialized);
2775 c = pthread_getspecific (plugin_ctx_key);
2778 c = plugin_ctx_create ();
2779 /* this must no happen -- exit() instead? */
2788 } /* void plugin_set_ctx */
2790 cdtime_t plugin_get_interval (void)
2794 interval = plugin_get_ctx().interval;
2798 return cf_get_default_interval ();
2799 } /* cdtime_t plugin_get_interval */
2803 void *(*start_routine) (void *);
2807 static void *plugin_thread_start (void *arg)
2809 plugin_thread_t *plugin_thread = arg;
2811 void *(*start_routine) (void *) = plugin_thread->start_routine;
2812 void *plugin_arg = plugin_thread->arg;
2814 plugin_set_ctx (plugin_thread->ctx);
2816 free (plugin_thread);
2818 return start_routine (plugin_arg);
2819 } /* void *plugin_thread_start */
2821 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2822 void *(*start_routine) (void *), void *arg)
2824 plugin_thread_t *plugin_thread;
2826 plugin_thread = malloc (sizeof (*plugin_thread));
2827 if (plugin_thread == NULL)
2830 plugin_thread->ctx = plugin_get_ctx ();
2831 plugin_thread->start_routine = start_routine;
2832 plugin_thread->arg = arg;
2834 return pthread_create (thread, attr,
2835 plugin_thread_start, plugin_thread);
2836 } /* int plugin_thread_create */
2838 /* vim: set sw=8 ts=8 noet fdm=marker : */