1 /**
2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2014 Florian octo Forster
4 *
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:
11 *
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
14 *
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.
22 *
23 * Authors:
24 * Florian octo Forster <octo at collectd.org>
25 * Sebastian Harl <sh at tokkee.org>
26 **/
28 #include "collectd.h"
29 #include "common.h"
30 #include "plugin.h"
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"
41 #include <ltdl.h>
43 /*
44 * Private structures
45 */
46 struct callback_func_s
47 {
48 void *cf_callback;
49 user_data_t cf_udata;
50 plugin_ctx_t cf_ctx;
51 };
52 typedef struct callback_func_s callback_func_t;
54 #define RF_SIMPLE 0
55 #define RF_COMPLEX 1
56 #define RF_REMOVE 65535
57 struct read_func_s
58 {
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];
66 char *rf_name;
67 int rf_type;
68 cdtime_t rf_interval;
69 cdtime_t rf_effective_interval;
70 cdtime_t rf_next_read;
71 };
72 typedef struct read_func_s read_func_t;
74 struct write_queue_s;
75 typedef struct write_queue_s write_queue_t;
76 struct write_queue_s
77 {
78 value_list_t *vl;
79 plugin_ctx_t ctx;
80 write_queue_t *next;
81 };
83 /*
84 * Private variables
85 */
86 static c_avl_tree_t *plugins_loaded = NULL;
88 static llist_t *list_init;
89 static llist_t *list_write;
90 static llist_t *list_flush;
91 static llist_t *list_missing;
92 static llist_t *list_shutdown;
93 static llist_t *list_log;
94 static llist_t *list_notification;
96 static fc_chain_t *pre_cache_chain = NULL;
97 static fc_chain_t *post_cache_chain = NULL;
99 static c_avl_tree_t *data_sets;
101 static char *plugindir = NULL;
103 #ifndef DEFAULT_MAX_READ_INTERVAL
104 # define DEFAULT_MAX_READ_INTERVAL TIME_T_TO_CDTIME_T (86400)
105 #endif
106 static c_heap_t *read_heap = NULL;
107 static llist_t *read_list;
108 static int read_loop = 1;
109 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
110 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
111 static pthread_t *read_threads = NULL;
112 static int read_threads_num = 0;
113 static cdtime_t max_read_interval = DEFAULT_MAX_READ_INTERVAL;
115 static write_queue_t *write_queue_head;
116 static write_queue_t *write_queue_tail;
117 static long write_queue_length = 0;
118 static _Bool write_loop = 1;
119 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
120 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
121 static pthread_t *write_threads = NULL;
122 static size_t write_threads_num = 0;
124 static pthread_key_t plugin_ctx_key;
125 static _Bool plugin_ctx_key_initialized = 0;
127 static long write_limit_high = 0;
128 static long write_limit_low = 0;
130 static derive_t stats_values_dropped = 0;
131 static _Bool record_statistics = 0;
133 /*
134 * Static functions
135 */
136 static int plugin_dispatch_values_internal (value_list_t *vl);
138 static const char *plugin_get_dir (void)
139 {
140 if (plugindir == NULL)
141 return (PLUGINDIR);
142 else
143 return (plugindir);
144 }
146 static void plugin_update_internal_statistics (void) { /* {{{ */
147 derive_t copy_write_queue_length;
148 value_list_t vl = VALUE_LIST_INIT;
149 value_t values[2];
151 copy_write_queue_length = write_queue_length;
153 /* Initialize `vl' */
154 vl.values = values;
155 vl.values_len = 2;
156 vl.time = 0;
157 sstrncpy (vl.host, hostname_g, sizeof (vl.host));
158 sstrncpy (vl.plugin, "collectd", sizeof (vl.plugin));
160 vl.type_instance[0] = 0;
161 vl.values_len = 1;
163 /* Write queue */
164 sstrncpy (vl.plugin_instance, "write_queue",
165 sizeof (vl.plugin_instance));
167 /* Write queue : queue length */
168 vl.values[0].gauge = (gauge_t) copy_write_queue_length;
169 sstrncpy (vl.type, "queue_length", sizeof (vl.type));
170 vl.type_instance[0] = 0;
171 plugin_dispatch_values (&vl);
173 /* Write queue : Values dropped (queue length > low limit) */
174 vl.values[0].derive = (derive_t) stats_values_dropped;
175 sstrncpy (vl.type, "derive", sizeof (vl.type));
176 sstrncpy (vl.type_instance, "dropped", sizeof (vl.type_instance));
177 plugin_dispatch_values (&vl);
179 /* Cache */
180 sstrncpy (vl.plugin_instance, "cache",
181 sizeof (vl.plugin_instance));
183 /* Cache : Nb entry in cache tree */
184 vl.values[0].gauge = (gauge_t) uc_get_size();
185 sstrncpy (vl.type, "cache_size", sizeof (vl.type));
186 vl.type_instance[0] = 0;
187 plugin_dispatch_values (&vl);
189 return;
190 } /* }}} void plugin_update_internal_statistics */
192 static void destroy_callback (callback_func_t *cf) /* {{{ */
193 {
194 if (cf == NULL)
195 return;
197 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
198 {
199 cf->cf_udata.free_func (cf->cf_udata.data);
200 cf->cf_udata.data = NULL;
201 cf->cf_udata.free_func = NULL;
202 }
203 sfree (cf);
204 } /* }}} void destroy_callback */
206 static void destroy_all_callbacks (llist_t **list) /* {{{ */
207 {
208 llentry_t *le;
210 if (*list == NULL)
211 return;
213 le = llist_head (*list);
214 while (le != NULL)
215 {
216 llentry_t *le_next;
218 le_next = le->next;
220 sfree (le->key);
221 destroy_callback (le->value);
222 le->value = NULL;
224 le = le_next;
225 }
227 llist_destroy (*list);
228 *list = NULL;
229 } /* }}} void destroy_all_callbacks */
231 static void destroy_read_heap (void) /* {{{ */
232 {
233 if (read_heap == NULL)
234 return;
236 while (42)
237 {
238 callback_func_t *cf;
240 cf = c_heap_get_root (read_heap);
241 if (cf == NULL)
242 break;
244 destroy_callback (cf);
245 }
247 c_heap_destroy (read_heap);
248 read_heap = NULL;
249 } /* }}} void destroy_read_heap */
251 static int register_callback (llist_t **list, /* {{{ */
252 const char *name, callback_func_t *cf)
253 {
254 llentry_t *le;
255 char *key;
257 if (*list == NULL)
258 {
259 *list = llist_create ();
260 if (*list == NULL)
261 {
262 ERROR ("plugin: register_callback: "
263 "llist_create failed.");
264 destroy_callback (cf);
265 return (-1);
266 }
267 }
269 key = strdup (name);
270 if (key == NULL)
271 {
272 ERROR ("plugin: register_callback: strdup failed.");
273 destroy_callback (cf);
274 return (-1);
275 }
277 le = llist_search (*list, name);
278 if (le == NULL)
279 {
280 le = llentry_create (key, cf);
281 if (le == NULL)
282 {
283 ERROR ("plugin: register_callback: "
284 "llentry_create failed.");
285 free (key);
286 destroy_callback (cf);
287 return (-1);
288 }
290 llist_append (*list, le);
291 }
292 else
293 {
294 callback_func_t *old_cf;
296 old_cf = le->value;
297 le->value = cf;
299 WARNING ("plugin: register_callback: "
300 "a callback named `%s' already exists - "
301 "overwriting the old entry!", name);
303 destroy_callback (old_cf);
304 sfree (key);
305 }
307 return (0);
308 } /* }}} int register_callback */
310 static void log_list_callbacks (llist_t **list, /* {{{ */
311 const char *comment)
312 {
313 char *str;
314 int len;
315 llentry_t *le;
316 int i;
317 int n;
318 char **keys;
320 n = llist_size(*list);
321 if (n == 0)
322 {
323 INFO("%s [none]", comment);
324 return;
325 }
327 keys = calloc(n, sizeof(char*));
329 if (keys == NULL)
330 {
331 ERROR("%s: failed to allocate memory for list of callbacks",
332 comment);
334 return;
335 }
337 for (le = llist_head (*list), i = 0, len = 0;
338 le != NULL;
339 le = le->next, i++)
340 {
341 keys[i] = le->key;
342 len += strlen(le->key) + 6;
343 }
344 str = malloc(len + 10);
345 if (str == NULL)
346 {
347 ERROR("%s: failed to allocate memory for list of callbacks",
348 comment);
349 }
350 else
351 {
352 *str = '\0';
353 strjoin(str, len, keys, n, "', '");
354 INFO("%s ['%s']", comment, str);
355 free(str);
356 }
357 free(keys);
358 } /* }}} void log_list_callbacks */
360 static int create_register_callback (llist_t **list, /* {{{ */
361 const char *name, void *callback, user_data_t *ud)
362 {
363 callback_func_t *cf;
365 cf = (callback_func_t *) malloc (sizeof (*cf));
366 if (cf == NULL)
367 {
368 ERROR ("plugin: create_register_callback: malloc failed.");
369 return (-1);
370 }
371 memset (cf, 0, sizeof (*cf));
373 cf->cf_callback = callback;
374 if (ud == NULL)
375 {
376 cf->cf_udata.data = NULL;
377 cf->cf_udata.free_func = NULL;
378 }
379 else
380 {
381 cf->cf_udata = *ud;
382 }
384 cf->cf_ctx = plugin_get_ctx ();
386 return (register_callback (list, name, cf));
387 } /* }}} int create_register_callback */
389 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
390 {
391 llentry_t *e;
393 if (list == NULL)
394 return (-1);
396 e = llist_search (list, name);
397 if (e == NULL)
398 return (-1);
400 llist_remove (list, e);
402 sfree (e->key);
403 destroy_callback (e->value);
405 llentry_destroy (e);
407 return (0);
408 } /* }}} int plugin_unregister */
410 /*
411 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
412 * object, but it will bitch about a shared object not having a
413 * ``module_register'' symbol..
414 */
415 static int plugin_load_file (char *file, uint32_t flags)
416 {
417 lt_dlhandle dlh;
418 void (*reg_handle) (void);
420 lt_dlinit ();
421 lt_dlerror (); /* clear errors */
423 #if LIBTOOL_VERSION == 2
424 if (flags & PLUGIN_FLAGS_GLOBAL) {
425 lt_dladvise advise;
426 lt_dladvise_init(&advise);
427 lt_dladvise_global(&advise);
428 dlh = lt_dlopenadvise(file, advise);
429 lt_dladvise_destroy(&advise);
430 } else {
431 dlh = lt_dlopen (file);
432 }
433 #else /* if LIBTOOL_VERSION == 1 */
434 if (flags & PLUGIN_FLAGS_GLOBAL)
435 WARNING ("plugin_load_file: The global flag is not supported, "
436 "libtool 2 is required for this.");
437 dlh = lt_dlopen (file);
438 #endif
440 if (dlh == NULL)
441 {
442 char errbuf[1024] = "";
444 ssnprintf (errbuf, sizeof (errbuf),
445 "lt_dlopen (\"%s\") failed: %s. "
446 "The most common cause for this problem is "
447 "missing dependencies. Use ldd(1) to check "
448 "the dependencies of the plugin "
449 "/ shared object.",
450 file, lt_dlerror ());
452 ERROR ("%s", errbuf);
453 /* Make sure this is printed to STDERR in any case, but also
454 * make sure it's printed only once. */
455 if (list_log != NULL)
456 fprintf (stderr, "ERROR: %s\n", errbuf);
458 return (1);
459 }
461 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
462 {
463 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
464 file, lt_dlerror ());
465 lt_dlclose (dlh);
466 return (-1);
467 }
469 (*reg_handle) ();
471 return (0);
472 }
474 static void *plugin_read_thread (void __attribute__((unused)) *args)
475 {
476 while (read_loop != 0)
477 {
478 read_func_t *rf;
479 plugin_ctx_t old_ctx;
480 cdtime_t now;
481 int status;
482 int rf_type;
483 int rc;
485 /* Get the read function that needs to be read next.
486 * We don't need to hold "read_lock" for the heap, but we need
487 * to call c_heap_get_root() and pthread_cond_wait() in the
488 * same protected block. */
489 pthread_mutex_lock (&read_lock);
490 rf = c_heap_get_root (read_heap);
491 if (rf == NULL)
492 {
493 pthread_cond_wait (&read_cond, &read_lock);
494 pthread_mutex_unlock (&read_lock);
495 continue;
496 }
497 pthread_mutex_unlock (&read_lock);
499 if (rf->rf_interval == 0)
500 {
501 /* this should not happen, because the interval is set
502 * for each plugin when loading it
503 * XXX: issue a warning? */
504 rf->rf_interval = plugin_get_interval ();
505 rf->rf_effective_interval = rf->rf_interval;
507 rf->rf_next_read = cdtime ();
508 }
510 /* sleep until this entry is due,
511 * using pthread_cond_timedwait */
512 pthread_mutex_lock (&read_lock);
513 /* In pthread_cond_timedwait, spurious wakeups are possible
514 * (and really happen, at least on NetBSD with > 1 CPU), thus
515 * we need to re-evaluate the condition every time
516 * pthread_cond_timedwait returns. */
517 rc = 0;
518 while ((read_loop != 0)
519 && (cdtime () < rf->rf_next_read)
520 && rc == 0)
521 {
522 struct timespec ts = { 0 };
524 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
526 rc = pthread_cond_timedwait (&read_cond, &read_lock,
527 &ts);
528 }
530 /* Must hold `read_lock' when accessing `rf->rf_type'. */
531 rf_type = rf->rf_type;
532 pthread_mutex_unlock (&read_lock);
534 /* Check if we're supposed to stop.. This may have interrupted
535 * the sleep, too. */
536 if (read_loop == 0)
537 {
538 /* Insert `rf' again, so it can be free'd correctly */
539 c_heap_insert (read_heap, rf);
540 break;
541 }
543 /* The entry has been marked for deletion. The linked list
544 * entry has already been removed by `plugin_unregister_read'.
545 * All we have to do here is free the `read_func_t' and
546 * continue. */
547 if (rf_type == RF_REMOVE)
548 {
549 DEBUG ("plugin_read_thread: Destroying the `%s' "
550 "callback.", rf->rf_name);
551 sfree (rf->rf_name);
552 destroy_callback ((callback_func_t *) rf);
553 rf = NULL;
554 continue;
555 }
557 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
559 old_ctx = plugin_set_ctx (rf->rf_ctx);
561 if (rf_type == RF_SIMPLE)
562 {
563 int (*callback) (void);
565 callback = rf->rf_callback;
566 status = (*callback) ();
567 }
568 else
569 {
570 plugin_read_cb callback;
572 assert (rf_type == RF_COMPLEX);
574 callback = rf->rf_callback;
575 status = (*callback) (&rf->rf_udata);
576 }
578 plugin_set_ctx (old_ctx);
580 /* If the function signals failure, we will increase the
581 * intervals in which it will be called. */
582 if (status != 0)
583 {
584 rf->rf_effective_interval *= 2;
585 if (rf->rf_effective_interval > max_read_interval)
586 rf->rf_effective_interval = max_read_interval;
588 NOTICE ("read-function of plugin `%s' failed. "
589 "Will suspend it for %.3f seconds.",
590 rf->rf_name,
591 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
592 }
593 else
594 {
595 /* Success: Restore the interval, if it was changed. */
596 rf->rf_effective_interval = rf->rf_interval;
597 }
599 /* update the ``next read due'' field */
600 now = cdtime ();
602 DEBUG ("plugin_read_thread: Effective interval of the "
603 "%s plugin is %.3f seconds.",
604 rf->rf_name,
605 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
607 /* Calculate the next (absolute) time at which this function
608 * should be called. */
609 rf->rf_next_read += rf->rf_effective_interval;
611 /* Check, if `rf_next_read' is in the past. */
612 if (rf->rf_next_read < now)
613 {
614 /* `rf_next_read' is in the past. Insert `now'
615 * so this value doesn't trail off into the
616 * past too much. */
617 rf->rf_next_read = now;
618 }
620 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
621 rf->rf_name,
622 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
624 /* Re-insert this read function into the heap again. */
625 c_heap_insert (read_heap, rf);
626 } /* while (read_loop) */
628 pthread_exit (NULL);
629 return ((void *) 0);
630 } /* void *plugin_read_thread */
632 static void start_read_threads (int num)
633 {
634 int i;
636 if (read_threads != NULL)
637 return;
639 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
640 if (read_threads == NULL)
641 {
642 ERROR ("plugin: start_read_threads: calloc failed.");
643 return;
644 }
646 read_threads_num = 0;
647 for (i = 0; i < num; i++)
648 {
649 if (pthread_create (read_threads + read_threads_num, NULL,
650 plugin_read_thread, NULL) == 0)
651 {
652 read_threads_num++;
653 }
654 else
655 {
656 ERROR ("plugin: start_read_threads: pthread_create failed.");
657 return;
658 }
659 } /* for (i) */
660 } /* void start_read_threads */
662 static void stop_read_threads (void)
663 {
664 int i;
666 if (read_threads == NULL)
667 return;
669 INFO ("collectd: Stopping %i read threads.", read_threads_num);
671 pthread_mutex_lock (&read_lock);
672 read_loop = 0;
673 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
674 pthread_cond_broadcast (&read_cond);
675 pthread_mutex_unlock (&read_lock);
677 for (i = 0; i < read_threads_num; i++)
678 {
679 if (pthread_join (read_threads[i], NULL) != 0)
680 {
681 ERROR ("plugin: stop_read_threads: pthread_join failed.");
682 }
683 read_threads[i] = (pthread_t) 0;
684 }
685 sfree (read_threads);
686 read_threads_num = 0;
687 } /* void stop_read_threads */
689 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
690 {
691 if (vl == NULL)
692 return;
694 meta_data_destroy (vl->meta);
695 sfree (vl->values);
696 sfree (vl);
697 } /* }}} void plugin_value_list_free */
699 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
700 {
701 value_list_t *vl;
703 if (vl_orig == NULL)
704 return (NULL);
706 vl = malloc (sizeof (*vl));
707 if (vl == NULL)
708 return (NULL);
709 memcpy (vl, vl_orig, sizeof (*vl));
711 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
712 if (vl->values == NULL)
713 {
714 plugin_value_list_free (vl);
715 return (NULL);
716 }
717 memcpy (vl->values, vl_orig->values,
718 vl_orig->values_len * sizeof (*vl->values));
720 vl->meta = meta_data_clone (vl->meta);
721 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
722 {
723 plugin_value_list_free (vl);
724 return (NULL);
725 }
727 if (vl->time == 0)
728 vl->time = cdtime ();
730 /* Fill in the interval from the thread context, if it is zero. */
731 if (vl->interval == 0)
732 {
733 plugin_ctx_t ctx = plugin_get_ctx ();
735 if (ctx.interval != 0)
736 vl->interval = ctx.interval;
737 else
738 {
739 char name[6 * DATA_MAX_NAME_LEN];
740 FORMAT_VL (name, sizeof (name), vl);
741 ERROR ("plugin_value_list_clone: Unable to determine "
742 "interval from context for "
743 "value list \"%s\". "
744 "This indicates a broken plugin. "
745 "Please report this problem to the "
746 "collectd mailing list or at "
747 "<http://collectd.org/bugs/>.", name);
748 vl->interval = cf_get_default_interval ();
749 }
750 }
752 return (vl);
753 } /* }}} value_list_t *plugin_value_list_clone */
755 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
756 {
757 write_queue_t *q;
759 q = malloc (sizeof (*q));
760 if (q == NULL)
761 return (ENOMEM);
762 q->next = NULL;
764 q->vl = plugin_value_list_clone (vl);
765 if (q->vl == NULL)
766 {
767 sfree (q);
768 return (ENOMEM);
769 }
771 /* Store context of caller (read plugin); otherwise, it would not be
772 * available to the write plugins when actually dispatching the
773 * value-list later on. */
774 q->ctx = plugin_get_ctx ();
776 pthread_mutex_lock (&write_lock);
778 if (write_queue_tail == NULL)
779 {
780 write_queue_head = q;
781 write_queue_tail = q;
782 write_queue_length = 1;
783 }
784 else
785 {
786 write_queue_tail->next = q;
787 write_queue_tail = q;
788 write_queue_length += 1;
789 }
791 pthread_cond_signal (&write_cond);
792 pthread_mutex_unlock (&write_lock);
794 return (0);
795 } /* }}} int plugin_write_enqueue */
797 static value_list_t *plugin_write_dequeue (void) /* {{{ */
798 {
799 write_queue_t *q;
800 value_list_t *vl;
802 pthread_mutex_lock (&write_lock);
804 while (write_loop && (write_queue_head == NULL))
805 pthread_cond_wait (&write_cond, &write_lock);
807 if (write_queue_head == NULL)
808 {
809 pthread_mutex_unlock (&write_lock);
810 return (NULL);
811 }
813 q = write_queue_head;
814 write_queue_head = q->next;
815 write_queue_length -= 1;
816 if (write_queue_head == NULL) {
817 write_queue_tail = NULL;
818 assert(0 == write_queue_length);
819 }
821 pthread_mutex_unlock (&write_lock);
823 (void) plugin_set_ctx (q->ctx);
825 vl = q->vl;
826 sfree (q);
827 return (vl);
828 } /* }}} value_list_t *plugin_write_dequeue */
830 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
831 {
832 while (write_loop)
833 {
834 value_list_t *vl = plugin_write_dequeue ();
835 if (vl == NULL)
836 continue;
838 plugin_dispatch_values_internal (vl);
840 plugin_value_list_free (vl);
841 }
843 pthread_exit (NULL);
844 return ((void *) 0);
845 } /* }}} void *plugin_write_thread */
847 static void start_write_threads (size_t num) /* {{{ */
848 {
849 size_t i;
851 if (write_threads != NULL)
852 return;
854 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
855 if (write_threads == NULL)
856 {
857 ERROR ("plugin: start_write_threads: calloc failed.");
858 return;
859 }
861 write_threads_num = 0;
862 for (i = 0; i < num; i++)
863 {
864 int status;
866 status = pthread_create (write_threads + write_threads_num,
867 /* attr = */ NULL,
868 plugin_write_thread,
869 /* arg = */ NULL);
870 if (status != 0)
871 {
872 char errbuf[1024];
873 ERROR ("plugin: start_write_threads: pthread_create failed "
874 "with status %i (%s).", status,
875 sstrerror (status, errbuf, sizeof (errbuf)));
876 return;
877 }
879 write_threads_num++;
880 } /* for (i) */
881 } /* }}} void start_write_threads */
883 static void stop_write_threads (void) /* {{{ */
884 {
885 write_queue_t *q;
886 int i;
888 if (write_threads == NULL)
889 return;
891 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
893 pthread_mutex_lock (&write_lock);
894 write_loop = 0;
895 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
896 pthread_cond_broadcast (&write_cond);
897 pthread_mutex_unlock (&write_lock);
899 for (i = 0; i < write_threads_num; i++)
900 {
901 if (pthread_join (write_threads[i], NULL) != 0)
902 {
903 ERROR ("plugin: stop_write_threads: pthread_join failed.");
904 }
905 write_threads[i] = (pthread_t) 0;
906 }
907 sfree (write_threads);
908 write_threads_num = 0;
910 pthread_mutex_lock (&write_lock);
911 i = 0;
912 for (q = write_queue_head; q != NULL; )
913 {
914 write_queue_t *q1 = q;
915 plugin_value_list_free (q->vl);
916 q = q->next;
917 sfree (q1);
918 i++;
919 }
920 write_queue_head = NULL;
921 write_queue_tail = NULL;
922 write_queue_length = 0;
923 pthread_mutex_unlock (&write_lock);
925 if (i > 0)
926 {
927 WARNING ("plugin: %i value list%s left after shutting down "
928 "the write threads.",
929 i, (i == 1) ? " was" : "s were");
930 }
931 } /* }}} void stop_write_threads */
933 /*
934 * Public functions
935 */
936 void plugin_set_dir (const char *dir)
937 {
938 if (plugindir != NULL)
939 free (plugindir);
941 if (dir == NULL)
942 plugindir = NULL;
943 else if ((plugindir = strdup (dir)) == NULL)
944 {
945 char errbuf[1024];
946 ERROR ("strdup failed: %s",
947 sstrerror (errno, errbuf, sizeof (errbuf)));
948 }
949 }
951 static _Bool plugin_is_loaded (char const *name)
952 {
953 int status;
955 if (plugins_loaded == NULL)
956 plugins_loaded = c_avl_create ((void *) strcasecmp);
957 assert (plugins_loaded != NULL);
959 status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
960 return (status == 0);
961 }
963 static int plugin_mark_loaded (char const *name)
964 {
965 char *name_copy;
966 int status;
968 name_copy = strdup (name);
969 if (name_copy == NULL)
970 return (ENOMEM);
972 status = c_avl_insert (plugins_loaded,
973 /* key = */ name_copy, /* value = */ NULL);
974 return (status);
975 }
977 static void plugin_free_loaded ()
978 {
979 void *key;
980 void *value;
982 if (plugins_loaded == NULL)
983 return;
985 while (c_avl_pick (plugins_loaded, &key, &value) == 0)
986 {
987 sfree (key);
988 assert (value == NULL);
989 }
991 c_avl_destroy (plugins_loaded);
992 plugins_loaded = NULL;
993 }
995 #define BUFSIZE 512
996 int plugin_load (char const *plugin_name, uint32_t flags)
997 {
998 DIR *dh;
999 const char *dir;
1000 char filename[BUFSIZE] = "";
1001 char typename[BUFSIZE];
1002 int ret;
1003 struct stat statbuf;
1004 struct dirent *de;
1005 int status;
1007 if (plugin_name == NULL)
1008 return (EINVAL);
1010 /* Check if plugin is already loaded and don't do anything in this
1011 * case. */
1012 if (plugin_is_loaded (plugin_name))
1013 return (0);
1015 dir = plugin_get_dir ();
1016 ret = 1;
1018 /*
1019 * XXX: Magic at work:
1020 *
1021 * Some of the language bindings, for example the Python and Perl
1022 * plugins, need to be able to export symbols to the scripts they run.
1023 * For this to happen, the "Globals" flag needs to be set.
1024 * Unfortunately, this technical detail is hard to explain to the
1025 * average user and she shouldn't have to worry about this, ideally.
1026 * So in order to save everyone's sanity use a different default for a
1027 * handful of special plugins. --octo
1028 */
1029 if ((strcasecmp ("perl", plugin_name) == 0)
1030 || (strcasecmp ("python", plugin_name) == 0))
1031 flags |= PLUGIN_FLAGS_GLOBAL;
1033 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
1034 * type when matching the filename */
1035 status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
1036 if ((status < 0) || ((size_t) status >= sizeof (typename)))
1037 {
1038 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
1039 return (-1);
1040 }
1042 if ((dh = opendir (dir)) == NULL)
1043 {
1044 char errbuf[1024];
1045 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
1046 sstrerror (errno, errbuf, sizeof (errbuf)));
1047 return (-1);
1048 }
1050 while ((de = readdir (dh)) != NULL)
1051 {
1052 if (strcasecmp (de->d_name, typename))
1053 continue;
1055 status = ssnprintf (filename, sizeof (filename),
1056 "%s/%s", dir, de->d_name);
1057 if ((status < 0) || ((size_t) status >= sizeof (filename)))
1058 {
1059 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
1060 dir, de->d_name);
1061 continue;
1062 }
1064 if (lstat (filename, &statbuf) == -1)
1065 {
1066 char errbuf[1024];
1067 WARNING ("plugin_load: stat (\"%s\") failed: %s",
1068 filename,
1069 sstrerror (errno, errbuf, sizeof (errbuf)));
1070 continue;
1071 }
1072 else if (!S_ISREG (statbuf.st_mode))
1073 {
1074 /* don't follow symlinks */
1075 WARNING ("plugin_load: %s is not a regular file.",
1076 filename);
1077 continue;
1078 }
1080 status = plugin_load_file (filename, flags);
1081 if (status == 0)
1082 {
1083 /* success */
1084 plugin_mark_loaded (plugin_name);
1085 ret = 0;
1086 break;
1087 }
1088 else
1089 {
1090 ERROR ("plugin_load: Load plugin \"%s\" failed with "
1091 "status %i.", plugin_name, status);
1092 }
1093 }
1095 closedir (dh);
1097 if (filename[0] == 0)
1098 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
1099 plugin_name, dir);
1101 return (ret);
1102 }
1104 /*
1105 * The `register_*' functions follow
1106 */
1107 int plugin_register_config (const char *name,
1108 int (*callback) (const char *key, const char *val),
1109 const char **keys, int keys_num)
1110 {
1111 cf_register (name, callback, keys, keys_num);
1112 return (0);
1113 } /* int plugin_register_config */
1115 int plugin_register_complex_config (const char *type,
1116 int (*callback) (oconfig_item_t *))
1117 {
1118 return (cf_register_complex (type, callback));
1119 } /* int plugin_register_complex_config */
1121 int plugin_register_init (const char *name,
1122 int (*callback) (void))
1123 {
1124 return (create_register_callback (&list_init, name, (void *) callback,
1125 /* user_data = */ NULL));
1126 } /* plugin_register_init */
1128 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1129 {
1130 const read_func_t *rf0;
1131 const read_func_t *rf1;
1133 rf0 = arg0;
1134 rf1 = arg1;
1136 if (rf0->rf_next_read < rf1->rf_next_read)
1137 return (-1);
1138 else if (rf0->rf_next_read > rf1->rf_next_read)
1139 return (1);
1140 else
1141 return (0);
1142 } /* int plugin_compare_read_func */
1144 /* Add a read function to both, the heap and a linked list. The linked list if
1145 * used to look-up read functions, especially for the remove function. The heap
1146 * is used to determine which plugin to read next. */
1147 static int plugin_insert_read (read_func_t *rf)
1148 {
1149 int status;
1150 llentry_t *le;
1152 rf->rf_next_read = cdtime ();
1153 rf->rf_effective_interval = rf->rf_interval;
1155 pthread_mutex_lock (&read_lock);
1157 if (read_list == NULL)
1158 {
1159 read_list = llist_create ();
1160 if (read_list == NULL)
1161 {
1162 pthread_mutex_unlock (&read_lock);
1163 ERROR ("plugin_insert_read: read_list failed.");
1164 return (-1);
1165 }
1166 }
1168 if (read_heap == NULL)
1169 {
1170 read_heap = c_heap_create (plugin_compare_read_func);
1171 if (read_heap == NULL)
1172 {
1173 pthread_mutex_unlock (&read_lock);
1174 ERROR ("plugin_insert_read: c_heap_create failed.");
1175 return (-1);
1176 }
1177 }
1179 le = llist_search (read_list, rf->rf_name);
1180 if (le != NULL)
1181 {
1182 pthread_mutex_unlock (&read_lock);
1183 WARNING ("The read function \"%s\" is already registered. "
1184 "Check for duplicate \"LoadPlugin\" lines "
1185 "in your configuration!",
1186 rf->rf_name);
1187 return (EINVAL);
1188 }
1190 le = llentry_create (rf->rf_name, rf);
1191 if (le == NULL)
1192 {
1193 pthread_mutex_unlock (&read_lock);
1194 ERROR ("plugin_insert_read: llentry_create failed.");
1195 return (-1);
1196 }
1198 status = c_heap_insert (read_heap, rf);
1199 if (status != 0)
1200 {
1201 pthread_mutex_unlock (&read_lock);
1202 ERROR ("plugin_insert_read: c_heap_insert failed.");
1203 llentry_destroy (le);
1204 return (-1);
1205 }
1207 /* This does not fail. */
1208 llist_append (read_list, le);
1210 /* Wake up all the read threads. */
1211 pthread_cond_broadcast (&read_cond);
1212 pthread_mutex_unlock (&read_lock);
1213 return (0);
1214 } /* int plugin_insert_read */
1216 int plugin_register_read (const char *name,
1217 int (*callback) (void))
1218 {
1219 read_func_t *rf;
1220 int status;
1222 rf = malloc (sizeof (*rf));
1223 if (rf == NULL)
1224 {
1225 ERROR ("plugin_register_read: malloc failed.");
1226 return (ENOMEM);
1227 }
1229 memset (rf, 0, sizeof (read_func_t));
1230 rf->rf_callback = (void *) callback;
1231 rf->rf_udata.data = NULL;
1232 rf->rf_udata.free_func = NULL;
1233 rf->rf_ctx = plugin_get_ctx ();
1234 rf->rf_group[0] = '\0';
1235 rf->rf_name = strdup (name);
1236 rf->rf_type = RF_SIMPLE;
1237 rf->rf_interval = plugin_get_interval ();
1239 status = plugin_insert_read (rf);
1240 if (status != 0)
1241 sfree (rf);
1243 return (status);
1244 } /* int plugin_register_read */
1246 int plugin_register_complex_read (const char *group, const char *name,
1247 plugin_read_cb callback,
1248 const struct timespec *interval,
1249 user_data_t *user_data)
1250 {
1251 read_func_t *rf;
1252 int status;
1254 rf = malloc (sizeof (*rf));
1255 if (rf == NULL)
1256 {
1257 ERROR ("plugin_register_complex_read: malloc failed.");
1258 return (ENOMEM);
1259 }
1261 memset (rf, 0, sizeof (read_func_t));
1262 rf->rf_callback = (void *) callback;
1263 if (group != NULL)
1264 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1265 else
1266 rf->rf_group[0] = '\0';
1267 rf->rf_name = strdup (name);
1268 rf->rf_type = RF_COMPLEX;
1269 if (interval != NULL)
1270 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1271 else
1272 rf->rf_interval = plugin_get_interval ();
1274 /* Set user data */
1275 if (user_data == NULL)
1276 {
1277 rf->rf_udata.data = NULL;
1278 rf->rf_udata.free_func = NULL;
1279 }
1280 else
1281 {
1282 rf->rf_udata = *user_data;
1283 }
1285 rf->rf_ctx = plugin_get_ctx ();
1287 status = plugin_insert_read (rf);
1288 if (status != 0)
1289 sfree (rf);
1291 return (status);
1292 } /* int plugin_register_complex_read */
1294 int plugin_register_write (const char *name,
1295 plugin_write_cb callback, user_data_t *ud)
1296 {
1297 return (create_register_callback (&list_write, name,
1298 (void *) callback, ud));
1299 } /* int plugin_register_write */
1301 int plugin_register_flush (const char *name,
1302 plugin_flush_cb callback, user_data_t *ud)
1303 {
1304 return (create_register_callback (&list_flush, name,
1305 (void *) callback, ud));
1306 } /* int plugin_register_flush */
1308 int plugin_register_missing (const char *name,
1309 plugin_missing_cb callback, user_data_t *ud)
1310 {
1311 return (create_register_callback (&list_missing, name,
1312 (void *) callback, ud));
1313 } /* int plugin_register_missing */
1315 int plugin_register_shutdown (const char *name,
1316 int (*callback) (void))
1317 {
1318 return (create_register_callback (&list_shutdown, name,
1319 (void *) callback, /* user_data = */ NULL));
1320 } /* int plugin_register_shutdown */
1322 static void plugin_free_data_sets (void)
1323 {
1324 void *key;
1325 void *value;
1327 if (data_sets == NULL)
1328 return;
1330 while (c_avl_pick (data_sets, &key, &value) == 0)
1331 {
1332 data_set_t *ds = value;
1333 /* key is a pointer to ds->type */
1335 sfree (ds->ds);
1336 sfree (ds);
1337 }
1339 c_avl_destroy (data_sets);
1340 data_sets = NULL;
1341 } /* void plugin_free_data_sets */
1343 int plugin_register_data_set (const data_set_t *ds)
1344 {
1345 data_set_t *ds_copy;
1346 int i;
1348 if ((data_sets != NULL)
1349 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1350 {
1351 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1352 plugin_unregister_data_set (ds->type);
1353 }
1354 else if (data_sets == NULL)
1355 {
1356 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1357 if (data_sets == NULL)
1358 return (-1);
1359 }
1361 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1362 if (ds_copy == NULL)
1363 return (-1);
1364 memcpy(ds_copy, ds, sizeof (data_set_t));
1366 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1367 * ds->ds_num);
1368 if (ds_copy->ds == NULL)
1369 {
1370 free (ds_copy);
1371 return (-1);
1372 }
1374 for (i = 0; i < ds->ds_num; i++)
1375 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1377 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1378 } /* int plugin_register_data_set */
1380 int plugin_register_log (const char *name,
1381 plugin_log_cb callback, user_data_t *ud)
1382 {
1383 return (create_register_callback (&list_log, name,
1384 (void *) callback, ud));
1385 } /* int plugin_register_log */
1387 int plugin_register_notification (const char *name,
1388 plugin_notification_cb callback, user_data_t *ud)
1389 {
1390 return (create_register_callback (&list_notification, name,
1391 (void *) callback, ud));
1392 } /* int plugin_register_log */
1394 int plugin_unregister_config (const char *name)
1395 {
1396 cf_unregister (name);
1397 return (0);
1398 } /* int plugin_unregister_config */
1400 int plugin_unregister_complex_config (const char *name)
1401 {
1402 cf_unregister_complex (name);
1403 return (0);
1404 } /* int plugin_unregister_complex_config */
1406 int plugin_unregister_init (const char *name)
1407 {
1408 return (plugin_unregister (list_init, name));
1409 }
1411 int plugin_unregister_read (const char *name) /* {{{ */
1412 {
1413 llentry_t *le;
1414 read_func_t *rf;
1416 if (name == NULL)
1417 return (-ENOENT);
1419 pthread_mutex_lock (&read_lock);
1421 if (read_list == NULL)
1422 {
1423 pthread_mutex_unlock (&read_lock);
1424 return (-ENOENT);
1425 }
1427 le = llist_search (read_list, name);
1428 if (le == NULL)
1429 {
1430 pthread_mutex_unlock (&read_lock);
1431 WARNING ("plugin_unregister_read: No such read function: %s",
1432 name);
1433 return (-ENOENT);
1434 }
1436 llist_remove (read_list, le);
1438 rf = le->value;
1439 assert (rf != NULL);
1440 rf->rf_type = RF_REMOVE;
1442 pthread_mutex_unlock (&read_lock);
1444 llentry_destroy (le);
1446 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1448 return (0);
1449 } /* }}} int plugin_unregister_read */
1451 void plugin_log_available_writers (void)
1452 {
1453 log_list_callbacks (&list_write, "Available write targets:");
1454 }
1456 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1457 {
1458 read_func_t *rf = e->value;
1459 char *group = ud;
1461 return strcmp (rf->rf_group, (const char *)group);
1462 } /* }}} int compare_read_func_group */
1464 int plugin_unregister_read_group (const char *group) /* {{{ */
1465 {
1466 llentry_t *le;
1467 read_func_t *rf;
1469 int found = 0;
1471 if (group == NULL)
1472 return (-ENOENT);
1474 pthread_mutex_lock (&read_lock);
1476 if (read_list == NULL)
1477 {
1478 pthread_mutex_unlock (&read_lock);
1479 return (-ENOENT);
1480 }
1482 while (42)
1483 {
1484 le = llist_search_custom (read_list,
1485 compare_read_func_group, (void *)group);
1487 if (le == NULL)
1488 break;
1490 ++found;
1492 llist_remove (read_list, le);
1494 rf = le->value;
1495 assert (rf != NULL);
1496 rf->rf_type = RF_REMOVE;
1498 llentry_destroy (le);
1500 DEBUG ("plugin_unregister_read_group: "
1501 "Marked `%s' (group `%s') for removal.",
1502 rf->rf_name, group);
1503 }
1505 pthread_mutex_unlock (&read_lock);
1507 if (found == 0)
1508 {
1509 WARNING ("plugin_unregister_read_group: No such "
1510 "group of read function: %s", group);
1511 return (-ENOENT);
1512 }
1514 return (0);
1515 } /* }}} int plugin_unregister_read_group */
1517 int plugin_unregister_write (const char *name)
1518 {
1519 return (plugin_unregister (list_write, name));
1520 }
1522 int plugin_unregister_flush (const char *name)
1523 {
1524 return (plugin_unregister (list_flush, name));
1525 }
1527 int plugin_unregister_missing (const char *name)
1528 {
1529 return (plugin_unregister (list_missing, name));
1530 }
1532 int plugin_unregister_shutdown (const char *name)
1533 {
1534 return (plugin_unregister (list_shutdown, name));
1535 }
1537 int plugin_unregister_data_set (const char *name)
1538 {
1539 data_set_t *ds;
1541 if (data_sets == NULL)
1542 return (-1);
1544 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1545 return (-1);
1547 sfree (ds->ds);
1548 sfree (ds);
1550 return (0);
1551 } /* int plugin_unregister_data_set */
1553 int plugin_unregister_log (const char *name)
1554 {
1555 return (plugin_unregister (list_log, name));
1556 }
1558 int plugin_unregister_notification (const char *name)
1559 {
1560 return (plugin_unregister (list_notification, name));
1561 }
1563 void plugin_init_all (void)
1564 {
1565 char const *chain_name;
1566 long write_threads_num;
1567 llentry_t *le;
1568 int status;
1570 /* Init the value cache */
1571 uc_init ();
1573 if (IS_TRUE (global_option_get ("CollectInternalStats")))
1574 record_statistics = 1;
1576 chain_name = global_option_get ("PreCacheChain");
1577 pre_cache_chain = fc_chain_get_by_name (chain_name);
1579 chain_name = global_option_get ("PostCacheChain");
1580 post_cache_chain = fc_chain_get_by_name (chain_name);
1582 write_limit_high = global_option_get_long ("WriteQueueLimitHigh",
1583 /* default = */ 0);
1584 if (write_limit_high < 0)
1585 {
1586 ERROR ("WriteQueueLimitHigh must be positive or zero.");
1587 write_limit_high = 0;
1588 }
1590 write_limit_low = global_option_get_long ("WriteQueueLimitLow",
1591 /* default = */ write_limit_high / 2);
1592 if (write_limit_low < 0)
1593 {
1594 ERROR ("WriteQueueLimitLow must be positive or zero.");
1595 write_limit_low = write_limit_high / 2;
1596 }
1597 else if (write_limit_low > write_limit_high)
1598 {
1599 ERROR ("WriteQueueLimitLow must not be larger than "
1600 "WriteQueueLimitHigh.");
1601 write_limit_low = write_limit_high;
1602 }
1604 write_threads_num = global_option_get_long ("WriteThreads",
1605 /* default = */ 5);
1606 if (write_threads_num < 1)
1607 {
1608 ERROR ("WriteThreads must be positive.");
1609 write_threads_num = 5;
1610 }
1612 start_write_threads ((size_t) write_threads_num);
1614 if ((list_init == NULL) && (read_heap == NULL))
1615 return;
1617 /* Calling all init callbacks before checking if read callbacks
1618 * are available allows the init callbacks to register the read
1619 * callback. */
1620 le = llist_head (list_init);
1621 while (le != NULL)
1622 {
1623 callback_func_t *cf;
1624 plugin_init_cb callback;
1625 plugin_ctx_t old_ctx;
1627 cf = le->value;
1628 old_ctx = plugin_set_ctx (cf->cf_ctx);
1629 callback = cf->cf_callback;
1630 status = (*callback) ();
1631 plugin_set_ctx (old_ctx);
1633 if (status != 0)
1634 {
1635 ERROR ("Initialization of plugin `%s' "
1636 "failed with status %i. "
1637 "Plugin will be unloaded.",
1638 le->key, status);
1639 /* Plugins that register read callbacks from the init
1640 * callback should take care of appropriate error
1641 * handling themselves. */
1642 /* FIXME: Unload _all_ functions */
1643 plugin_unregister_read (le->key);
1644 }
1646 le = le->next;
1647 }
1649 max_read_interval = global_option_get_time ("MaxReadInterval",
1650 DEFAULT_MAX_READ_INTERVAL);
1652 /* Start read-threads */
1653 if (read_heap != NULL)
1654 {
1655 const char *rt;
1656 int num;
1658 rt = global_option_get ("ReadThreads");
1659 num = atoi (rt);
1660 if (num != -1)
1661 start_read_threads ((num > 0) ? num : 5);
1662 }
1663 } /* void plugin_init_all */
1665 /* TODO: Rename this function. */
1666 void plugin_read_all (void)
1667 {
1668 if(record_statistics) {
1669 plugin_update_internal_statistics ();
1670 }
1671 uc_check_timeout ();
1673 return;
1674 } /* void plugin_read_all */
1676 /* Read function called when the `-T' command line argument is given. */
1677 int plugin_read_all_once (void)
1678 {
1679 int status;
1680 int return_status = 0;
1682 if (read_heap == NULL)
1683 {
1684 NOTICE ("No read-functions are registered.");
1685 return (0);
1686 }
1688 while (42)
1689 {
1690 read_func_t *rf;
1691 plugin_ctx_t old_ctx;
1693 rf = c_heap_get_root (read_heap);
1694 if (rf == NULL)
1695 break;
1697 old_ctx = plugin_set_ctx (rf->rf_ctx);
1699 if (rf->rf_type == RF_SIMPLE)
1700 {
1701 int (*callback) (void);
1703 callback = rf->rf_callback;
1704 status = (*callback) ();
1705 }
1706 else
1707 {
1708 plugin_read_cb callback;
1710 callback = rf->rf_callback;
1711 status = (*callback) (&rf->rf_udata);
1712 }
1714 plugin_set_ctx (old_ctx);
1716 if (status != 0)
1717 {
1718 NOTICE ("read-function of plugin `%s' failed.",
1719 rf->rf_name);
1720 return_status = -1;
1721 }
1723 destroy_callback ((void *) rf);
1724 }
1726 return (return_status);
1727 } /* int plugin_read_all_once */
1729 int plugin_write (const char *plugin, /* {{{ */
1730 const data_set_t *ds, const value_list_t *vl)
1731 {
1732 llentry_t *le;
1733 int status;
1735 if (vl == NULL)
1736 return (EINVAL);
1738 if (list_write == NULL)
1739 return (ENOENT);
1741 if (ds == NULL)
1742 {
1743 ds = plugin_get_ds (vl->type);
1744 if (ds == NULL)
1745 {
1746 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1747 return (ENOENT);
1748 }
1749 }
1751 if (plugin == NULL)
1752 {
1753 int success = 0;
1754 int failure = 0;
1756 le = llist_head (list_write);
1757 while (le != NULL)
1758 {
1759 callback_func_t *cf = le->value;
1760 plugin_write_cb callback;
1762 /* do not switch plugin context; rather keep the context (interval)
1763 * information of the calling read plugin */
1765 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1766 callback = cf->cf_callback;
1767 status = (*callback) (ds, vl, &cf->cf_udata);
1768 if (status != 0)
1769 failure++;
1770 else
1771 success++;
1773 le = le->next;
1774 }
1776 if ((success == 0) && (failure != 0))
1777 status = -1;
1778 else
1779 status = 0;
1780 }
1781 else /* plugin != NULL */
1782 {
1783 callback_func_t *cf;
1784 plugin_write_cb callback;
1786 le = llist_head (list_write);
1787 while (le != NULL)
1788 {
1789 if (strcasecmp (plugin, le->key) == 0)
1790 break;
1792 le = le->next;
1793 }
1795 if (le == NULL)
1796 return (ENOENT);
1798 cf = le->value;
1800 /* do not switch plugin context; rather keep the context (interval)
1801 * information of the calling read plugin */
1803 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1804 callback = cf->cf_callback;
1805 status = (*callback) (ds, vl, &cf->cf_udata);
1806 }
1808 return (status);
1809 } /* }}} int plugin_write */
1811 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1812 {
1813 llentry_t *le;
1815 if (list_flush == NULL)
1816 return (0);
1818 le = llist_head (list_flush);
1819 while (le != NULL)
1820 {
1821 callback_func_t *cf;
1822 plugin_flush_cb callback;
1823 plugin_ctx_t old_ctx;
1825 if ((plugin != NULL)
1826 && (strcmp (plugin, le->key) != 0))
1827 {
1828 le = le->next;
1829 continue;
1830 }
1832 cf = le->value;
1833 old_ctx = plugin_set_ctx (cf->cf_ctx);
1834 callback = cf->cf_callback;
1836 (*callback) (timeout, identifier, &cf->cf_udata);
1838 plugin_set_ctx (old_ctx);
1840 le = le->next;
1841 }
1842 return (0);
1843 } /* int plugin_flush */
1845 void plugin_shutdown_all (void)
1846 {
1847 llentry_t *le;
1849 stop_read_threads ();
1851 destroy_all_callbacks (&list_init);
1853 pthread_mutex_lock (&read_lock);
1854 llist_destroy (read_list);
1855 read_list = NULL;
1856 pthread_mutex_unlock (&read_lock);
1858 destroy_read_heap ();
1860 plugin_flush (/* plugin = */ NULL,
1861 /* timeout = */ 0,
1862 /* identifier = */ NULL);
1864 le = NULL;
1865 if (list_shutdown != NULL)
1866 le = llist_head (list_shutdown);
1868 while (le != NULL)
1869 {
1870 callback_func_t *cf;
1871 plugin_shutdown_cb callback;
1872 plugin_ctx_t old_ctx;
1874 cf = le->value;
1875 old_ctx = plugin_set_ctx (cf->cf_ctx);
1876 callback = cf->cf_callback;
1878 /* Advance the pointer before calling the callback allows
1879 * shutdown functions to unregister themselves. If done the
1880 * other way around the memory `le' points to will be freed
1881 * after callback returns. */
1882 le = le->next;
1884 (*callback) ();
1886 plugin_set_ctx (old_ctx);
1887 }
1889 stop_write_threads ();
1891 /* Write plugins which use the `user_data' pointer usually need the
1892 * same data available to the flush callback. If this is the case, set
1893 * the free_function to NULL when registering the flush callback and to
1894 * the real free function when registering the write callback. This way
1895 * the data isn't freed twice. */
1896 destroy_all_callbacks (&list_flush);
1897 destroy_all_callbacks (&list_missing);
1898 destroy_all_callbacks (&list_write);
1900 destroy_all_callbacks (&list_notification);
1901 destroy_all_callbacks (&list_shutdown);
1902 destroy_all_callbacks (&list_log);
1904 plugin_free_loaded ();
1905 plugin_free_data_sets ();
1906 } /* void plugin_shutdown_all */
1908 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1909 {
1910 llentry_t *le;
1912 if (list_missing == NULL)
1913 return (0);
1915 le = llist_head (list_missing);
1916 while (le != NULL)
1917 {
1918 callback_func_t *cf;
1919 plugin_missing_cb callback;
1920 plugin_ctx_t old_ctx;
1921 int status;
1923 cf = le->value;
1924 old_ctx = plugin_set_ctx (cf->cf_ctx);
1925 callback = cf->cf_callback;
1927 status = (*callback) (vl, &cf->cf_udata);
1928 plugin_set_ctx (old_ctx);
1929 if (status != 0)
1930 {
1931 if (status < 0)
1932 {
1933 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1934 "failed with status %i.",
1935 le->key, status);
1936 return (status);
1937 }
1938 else
1939 {
1940 return (0);
1941 }
1942 }
1944 le = le->next;
1945 }
1946 return (0);
1947 } /* int }}} plugin_dispatch_missing */
1949 static int plugin_dispatch_values_internal (value_list_t *vl)
1950 {
1951 int status;
1952 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1954 value_t *saved_values;
1955 int saved_values_len;
1957 data_set_t *ds;
1959 int free_meta_data = 0;
1961 if ((vl == NULL) || (vl->type[0] == 0)
1962 || (vl->values == NULL) || (vl->values_len < 1))
1963 {
1964 ERROR ("plugin_dispatch_values: Invalid value list "
1965 "from plugin %s.", vl->plugin);
1966 return (-1);
1967 }
1969 /* Free meta data only if the calling function didn't specify any. In
1970 * this case matches and targets may add some and the calling function
1971 * may not expect (and therefore free) that data. */
1972 if (vl->meta == NULL)
1973 free_meta_data = 1;
1975 if (list_write == NULL)
1976 c_complain_once (LOG_WARNING, &no_write_complaint,
1977 "plugin_dispatch_values: No write callback has been "
1978 "registered. Please load at least one output plugin, "
1979 "if you want the collected data to be stored.");
1981 if (data_sets == NULL)
1982 {
1983 ERROR ("plugin_dispatch_values: No data sets registered. "
1984 "Could the types database be read? Check "
1985 "your `TypesDB' setting!");
1986 return (-1);
1987 }
1989 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1990 {
1991 char ident[6 * DATA_MAX_NAME_LEN];
1993 FORMAT_VL (ident, sizeof (ident), vl);
1994 INFO ("plugin_dispatch_values: Dataset not found: %s "
1995 "(from \"%s\"), check your types.db!",
1996 vl->type, ident);
1997 return (-1);
1998 }
2000 /* Assured by plugin_value_list_clone(). The time is determined at
2001 * _enqueue_ time. */
2002 assert (vl->time != 0);
2003 assert (vl->interval != 0);
2005 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
2006 "host = %s; "
2007 "plugin = %s; plugin_instance = %s; "
2008 "type = %s; type_instance = %s;",
2009 CDTIME_T_TO_DOUBLE (vl->time),
2010 CDTIME_T_TO_DOUBLE (vl->interval),
2011 vl->host,
2012 vl->plugin, vl->plugin_instance,
2013 vl->type, vl->type_instance);
2015 #if COLLECT_DEBUG
2016 assert (0 == strcmp (ds->type, vl->type));
2017 #else
2018 if (0 != strcmp (ds->type, vl->type))
2019 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
2020 ds->type, vl->type);
2021 #endif
2023 #if COLLECT_DEBUG
2024 assert (ds->ds_num == vl->values_len);
2025 #else
2026 if (ds->ds_num != vl->values_len)
2027 {
2028 ERROR ("plugin_dispatch_values: ds->type = %s: "
2029 "(ds->ds_num = %i) != "
2030 "(vl->values_len = %i)",
2031 ds->type, ds->ds_num, vl->values_len);
2032 return (-1);
2033 }
2034 #endif
2036 escape_slashes (vl->host, sizeof (vl->host));
2037 escape_slashes (vl->plugin, sizeof (vl->plugin));
2038 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
2039 escape_slashes (vl->type, sizeof (vl->type));
2040 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
2042 /* Copy the values. This way, we can assure `targets' that they get
2043 * dynamically allocated values, which they can free and replace if
2044 * they like. */
2045 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
2046 {
2047 saved_values = vl->values;
2048 saved_values_len = vl->values_len;
2050 vl->values = (value_t *) calloc (vl->values_len,
2051 sizeof (*vl->values));
2052 if (vl->values == NULL)
2053 {
2054 ERROR ("plugin_dispatch_values: calloc failed.");
2055 vl->values = saved_values;
2056 return (-1);
2057 }
2058 memcpy (vl->values, saved_values,
2059 vl->values_len * sizeof (*vl->values));
2060 }
2061 else /* if ((pre == NULL) && (post == NULL)) */
2062 {
2063 saved_values = NULL;
2064 saved_values_len = 0;
2065 }
2067 if (pre_cache_chain != NULL)
2068 {
2069 status = fc_process_chain (ds, vl, pre_cache_chain);
2070 if (status < 0)
2071 {
2072 WARNING ("plugin_dispatch_values: Running the "
2073 "pre-cache chain failed with "
2074 "status %i (%#x).",
2075 status, status);
2076 }
2077 else if (status == FC_TARGET_STOP)
2078 {
2079 /* Restore the state of the value_list so that plugins
2080 * don't get confused.. */
2081 if (saved_values != NULL)
2082 {
2083 free (vl->values);
2084 vl->values = saved_values;
2085 vl->values_len = saved_values_len;
2086 }
2087 return (0);
2088 }
2089 }
2091 /* Update the value cache */
2092 uc_update (ds, vl);
2094 if (post_cache_chain != NULL)
2095 {
2096 status = fc_process_chain (ds, vl, post_cache_chain);
2097 if (status < 0)
2098 {
2099 WARNING ("plugin_dispatch_values: Running the "
2100 "post-cache chain failed with "
2101 "status %i (%#x).",
2102 status, status);
2103 }
2104 }
2105 else
2106 fc_default_action (ds, vl);
2108 /* Restore the state of the value_list so that plugins don't get
2109 * confused.. */
2110 if (saved_values != NULL)
2111 {
2112 free (vl->values);
2113 vl->values = saved_values;
2114 vl->values_len = saved_values_len;
2115 }
2117 if ((free_meta_data != 0) && (vl->meta != NULL))
2118 {
2119 meta_data_destroy (vl->meta);
2120 vl->meta = NULL;
2121 }
2123 return (0);
2124 } /* int plugin_dispatch_values_internal */
2126 static double get_drop_probability (void) /* {{{ */
2127 {
2128 long pos;
2129 long size;
2130 long wql;
2132 pthread_mutex_lock (&write_lock);
2133 wql = write_queue_length;
2134 pthread_mutex_unlock (&write_lock);
2136 if (wql < write_limit_low)
2137 return (0.0);
2138 if (wql >= write_limit_high)
2139 return (1.0);
2141 pos = 1 + wql - write_limit_low;
2142 size = 1 + write_limit_high - write_limit_low;
2144 return (((double) pos) / ((double) size));
2145 } /* }}} double get_drop_probability */
2147 static _Bool check_drop_value (void) /* {{{ */
2148 {
2149 static cdtime_t last_message_time = 0;
2150 static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2152 double p;
2153 double q;
2154 int status;
2156 if (write_limit_high == 0)
2157 return (0);
2159 p = get_drop_probability ();
2160 if (p == 0.0)
2161 return (0);
2163 status = pthread_mutex_trylock (&last_message_lock);
2164 if (status == 0)
2165 {
2166 cdtime_t now;
2168 now = cdtime ();
2169 if ((now - last_message_time) > TIME_T_TO_CDTIME_T (1))
2170 {
2171 last_message_time = now;
2172 ERROR ("plugin_dispatch_values: Low water mark "
2173 "reached. Dropping %.0f%% of metrics.",
2174 100.0 * p);
2175 }
2176 pthread_mutex_unlock (&last_message_lock);
2177 }
2179 if (p == 1.0)
2180 return (1);
2182 q = cdrand_d ();
2183 if (q > p)
2184 return (1);
2185 else
2186 return (0);
2187 } /* }}} _Bool check_drop_value */
2189 int plugin_dispatch_values (value_list_t const *vl)
2190 {
2191 int status;
2192 static pthread_mutex_t statistics_lock = PTHREAD_MUTEX_INITIALIZER;
2194 if (check_drop_value ()) {
2195 if(record_statistics) {
2196 pthread_mutex_lock(&statistics_lock);
2197 stats_values_dropped++;
2198 pthread_mutex_unlock(&statistics_lock);
2199 }
2200 return (0);
2201 }
2203 status = plugin_write_enqueue (vl);
2204 if (status != 0)
2205 {
2206 char errbuf[1024];
2207 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
2208 "with status %i (%s).", status,
2209 sstrerror (status, errbuf, sizeof (errbuf)));
2210 return (status);
2211 }
2213 return (0);
2214 }
2216 __attribute__((sentinel))
2217 int plugin_dispatch_multivalue (value_list_t const *template, /* {{{ */
2218 _Bool store_percentage, int store_type, ...)
2219 {
2220 value_list_t *vl;
2221 int failed = 0;
2222 gauge_t sum = 0.0;
2223 va_list ap;
2225 assert (template->values_len == 1);
2227 /* Calculate sum for Gauge to calculate percent if needed */
2228 if (DS_TYPE_GAUGE == store_type) {
2229 va_start (ap, store_type);
2230 while (42)
2231 {
2232 char const *name;
2233 gauge_t value;
2235 name = va_arg (ap, char const *);
2236 if (name == NULL)
2237 break;
2239 value = va_arg (ap, gauge_t);
2240 if (!isnan (value))
2241 sum += value;
2242 }
2243 va_end (ap);
2244 }
2247 vl = plugin_value_list_clone (template);
2248 /* plugin_value_list_clone makes sure vl->time is set to non-zero. */
2249 if (store_percentage)
2250 sstrncpy (vl->type, "percent", sizeof (vl->type));
2252 va_start (ap, store_type);
2253 while (42)
2254 {
2255 char const *name;
2256 int status;
2258 /* Set the type instance. */
2259 name = va_arg (ap, char const *);
2260 if (name == NULL)
2261 break;
2262 sstrncpy (vl->type_instance, name, sizeof (vl->type_instance));
2264 /* Set the value. */
2265 switch (store_type)
2266 {
2267 case DS_TYPE_GAUGE:
2268 vl->values[0].gauge = va_arg (ap, gauge_t);
2269 if (store_percentage)
2270 vl->values[0].gauge *= 100.0 / sum;
2271 break;
2272 case DS_TYPE_ABSOLUTE:
2273 vl->values[0].absolute = va_arg (ap, absolute_t);
2274 break;
2275 case DS_TYPE_COUNTER:
2276 vl->values[0].counter = va_arg (ap, counter_t);
2277 break;
2278 case DS_TYPE_DERIVE:
2279 vl->values[0].derive = va_arg (ap, derive_t);
2280 break;
2281 default:
2282 ERROR ("plugin_dispatch_multivalue: given store_type is incorrect.");
2283 failed++;
2284 }
2287 status = plugin_write_enqueue (vl);
2288 if (status != 0)
2289 failed++;
2290 }
2291 va_end (ap);
2293 plugin_value_list_free (vl);
2294 return (failed);
2295 } /* }}} int plugin_dispatch_multivalue */
2297 int plugin_dispatch_notification (const notification_t *notif)
2298 {
2299 llentry_t *le;
2300 /* Possible TODO: Add flap detection here */
2302 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
2303 "time = %.3f; host = %s;",
2304 notif->severity, notif->message,
2305 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
2307 /* Nobody cares for notifications */
2308 if (list_notification == NULL)
2309 return (-1);
2311 le = llist_head (list_notification);
2312 while (le != NULL)
2313 {
2314 callback_func_t *cf;
2315 plugin_notification_cb callback;
2316 int status;
2318 /* do not switch plugin context; rather keep the context
2319 * (interval) information of the calling plugin */
2321 cf = le->value;
2322 callback = cf->cf_callback;
2323 status = (*callback) (notif, &cf->cf_udata);
2324 if (status != 0)
2325 {
2326 WARNING ("plugin_dispatch_notification: Notification "
2327 "callback %s returned %i.",
2328 le->key, status);
2329 }
2331 le = le->next;
2332 }
2334 return (0);
2335 } /* int plugin_dispatch_notification */
2337 void plugin_log (int level, const char *format, ...)
2338 {
2339 char msg[1024];
2340 va_list ap;
2341 llentry_t *le;
2343 #if !COLLECT_DEBUG
2344 if (level >= LOG_DEBUG)
2345 return;
2346 #endif
2348 va_start (ap, format);
2349 vsnprintf (msg, sizeof (msg), format, ap);
2350 msg[sizeof (msg) - 1] = '\0';
2351 va_end (ap);
2353 if (list_log == NULL)
2354 {
2355 fprintf (stderr, "%s\n", msg);
2356 return;
2357 }
2359 le = llist_head (list_log);
2360 while (le != NULL)
2361 {
2362 callback_func_t *cf;
2363 plugin_log_cb callback;
2365 cf = le->value;
2366 callback = cf->cf_callback;
2368 /* do not switch plugin context; rather keep the context
2369 * (interval) information of the calling plugin */
2371 (*callback) (level, msg, &cf->cf_udata);
2373 le = le->next;
2374 }
2375 } /* void plugin_log */
2377 int parse_log_severity (const char *severity)
2378 {
2379 int log_level = -1;
2381 if ((0 == strcasecmp (severity, "emerg"))
2382 || (0 == strcasecmp (severity, "alert"))
2383 || (0 == strcasecmp (severity, "crit"))
2384 || (0 == strcasecmp (severity, "err")))
2385 log_level = LOG_ERR;
2386 else if (0 == strcasecmp (severity, "warning"))
2387 log_level = LOG_WARNING;
2388 else if (0 == strcasecmp (severity, "notice"))
2389 log_level = LOG_NOTICE;
2390 else if (0 == strcasecmp (severity, "info"))
2391 log_level = LOG_INFO;
2392 #if COLLECT_DEBUG
2393 else if (0 == strcasecmp (severity, "debug"))
2394 log_level = LOG_DEBUG;
2395 #endif /* COLLECT_DEBUG */
2397 return (log_level);
2398 } /* int parse_log_severity */
2400 int parse_notif_severity (const char *severity)
2401 {
2402 int notif_severity = -1;
2404 if (strcasecmp (severity, "FAILURE") == 0)
2405 notif_severity = NOTIF_FAILURE;
2406 else if (strcmp (severity, "OKAY") == 0)
2407 notif_severity = NOTIF_OKAY;
2408 else if ((strcmp (severity, "WARNING") == 0)
2409 || (strcmp (severity, "WARN") == 0))
2410 notif_severity = NOTIF_WARNING;
2412 return (notif_severity);
2413 } /* int parse_notif_severity */
2415 const data_set_t *plugin_get_ds (const char *name)
2416 {
2417 data_set_t *ds;
2419 if (data_sets == NULL)
2420 {
2421 ERROR ("plugin_get_ds: No data sets are defined yet.");
2422 return (NULL);
2423 }
2425 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2426 {
2427 DEBUG ("No such dataset registered: %s", name);
2428 return (NULL);
2429 }
2431 return (ds);
2432 } /* data_set_t *plugin_get_ds */
2434 static int plugin_notification_meta_add (notification_t *n,
2435 const char *name,
2436 enum notification_meta_type_e type,
2437 const void *value)
2438 {
2439 notification_meta_t *meta;
2440 notification_meta_t *tail;
2442 if ((n == NULL) || (name == NULL) || (value == NULL))
2443 {
2444 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2445 return (-1);
2446 }
2448 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2449 if (meta == NULL)
2450 {
2451 ERROR ("plugin_notification_meta_add: malloc failed.");
2452 return (-1);
2453 }
2454 memset (meta, 0, sizeof (notification_meta_t));
2456 sstrncpy (meta->name, name, sizeof (meta->name));
2457 meta->type = type;
2459 switch (type)
2460 {
2461 case NM_TYPE_STRING:
2462 {
2463 meta->nm_value.nm_string = strdup ((const char *) value);
2464 if (meta->nm_value.nm_string == NULL)
2465 {
2466 ERROR ("plugin_notification_meta_add: strdup failed.");
2467 sfree (meta);
2468 return (-1);
2469 }
2470 break;
2471 }
2472 case NM_TYPE_SIGNED_INT:
2473 {
2474 meta->nm_value.nm_signed_int = *((int64_t *) value);
2475 break;
2476 }
2477 case NM_TYPE_UNSIGNED_INT:
2478 {
2479 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2480 break;
2481 }
2482 case NM_TYPE_DOUBLE:
2483 {
2484 meta->nm_value.nm_double = *((double *) value);
2485 break;
2486 }
2487 case NM_TYPE_BOOLEAN:
2488 {
2489 meta->nm_value.nm_boolean = *((_Bool *) value);
2490 break;
2491 }
2492 default:
2493 {
2494 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2495 sfree (meta);
2496 return (-1);
2497 }
2498 } /* switch (type) */
2500 meta->next = NULL;
2501 tail = n->meta;
2502 while ((tail != NULL) && (tail->next != NULL))
2503 tail = tail->next;
2505 if (tail == NULL)
2506 n->meta = meta;
2507 else
2508 tail->next = meta;
2510 return (0);
2511 } /* int plugin_notification_meta_add */
2513 int plugin_notification_meta_add_string (notification_t *n,
2514 const char *name,
2515 const char *value)
2516 {
2517 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2518 }
2520 int plugin_notification_meta_add_signed_int (notification_t *n,
2521 const char *name,
2522 int64_t value)
2523 {
2524 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2525 }
2527 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2528 const char *name,
2529 uint64_t value)
2530 {
2531 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2532 }
2534 int plugin_notification_meta_add_double (notification_t *n,
2535 const char *name,
2536 double value)
2537 {
2538 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2539 }
2541 int plugin_notification_meta_add_boolean (notification_t *n,
2542 const char *name,
2543 _Bool value)
2544 {
2545 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2546 }
2548 int plugin_notification_meta_copy (notification_t *dst,
2549 const notification_t *src)
2550 {
2551 notification_meta_t *meta;
2553 assert (dst != NULL);
2554 assert (src != NULL);
2555 assert (dst != src);
2556 assert ((src->meta == NULL) || (src->meta != dst->meta));
2558 for (meta = src->meta; meta != NULL; meta = meta->next)
2559 {
2560 if (meta->type == NM_TYPE_STRING)
2561 plugin_notification_meta_add_string (dst, meta->name,
2562 meta->nm_value.nm_string);
2563 else if (meta->type == NM_TYPE_SIGNED_INT)
2564 plugin_notification_meta_add_signed_int (dst, meta->name,
2565 meta->nm_value.nm_signed_int);
2566 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2567 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2568 meta->nm_value.nm_unsigned_int);
2569 else if (meta->type == NM_TYPE_DOUBLE)
2570 plugin_notification_meta_add_double (dst, meta->name,
2571 meta->nm_value.nm_double);
2572 else if (meta->type == NM_TYPE_BOOLEAN)
2573 plugin_notification_meta_add_boolean (dst, meta->name,
2574 meta->nm_value.nm_boolean);
2575 }
2577 return (0);
2578 } /* int plugin_notification_meta_copy */
2580 int plugin_notification_meta_free (notification_meta_t *n)
2581 {
2582 notification_meta_t *this;
2583 notification_meta_t *next;
2585 if (n == NULL)
2586 {
2587 ERROR ("plugin_notification_meta_free: n == NULL!");
2588 return (-1);
2589 }
2591 this = n;
2592 while (this != NULL)
2593 {
2594 next = this->next;
2596 if (this->type == NM_TYPE_STRING)
2597 {
2598 free ((char *)this->nm_value.nm_string);
2599 this->nm_value.nm_string = NULL;
2600 }
2601 sfree (this);
2603 this = next;
2604 }
2606 return (0);
2607 } /* int plugin_notification_meta_free */
2609 static void plugin_ctx_destructor (void *ctx)
2610 {
2611 sfree (ctx);
2612 } /* void plugin_ctx_destructor */
2614 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2616 static plugin_ctx_t *plugin_ctx_create (void)
2617 {
2618 plugin_ctx_t *ctx;
2620 ctx = malloc (sizeof (*ctx));
2621 if (ctx == NULL) {
2622 char errbuf[1024];
2623 ERROR ("Failed to allocate plugin context: %s",
2624 sstrerror (errno, errbuf, sizeof (errbuf)));
2625 return NULL;
2626 }
2628 *ctx = ctx_init;
2629 assert (plugin_ctx_key_initialized);
2630 pthread_setspecific (plugin_ctx_key, ctx);
2631 DEBUG("Created new plugin context.");
2632 return (ctx);
2633 } /* int plugin_ctx_create */
2635 void plugin_init_ctx (void)
2636 {
2637 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2638 plugin_ctx_key_initialized = 1;
2639 } /* void plugin_init_ctx */
2641 plugin_ctx_t plugin_get_ctx (void)
2642 {
2643 plugin_ctx_t *ctx;
2645 assert (plugin_ctx_key_initialized);
2646 ctx = pthread_getspecific (plugin_ctx_key);
2648 if (ctx == NULL) {
2649 ctx = plugin_ctx_create ();
2650 /* this must no happen -- exit() instead? */
2651 if (ctx == NULL)
2652 return ctx_init;
2653 }
2655 return (*ctx);
2656 } /* plugin_ctx_t plugin_get_ctx */
2658 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2659 {
2660 plugin_ctx_t *c;
2661 plugin_ctx_t old;
2663 assert (plugin_ctx_key_initialized);
2664 c = pthread_getspecific (plugin_ctx_key);
2666 if (c == NULL) {
2667 c = plugin_ctx_create ();
2668 /* this must no happen -- exit() instead? */
2669 if (c == NULL)
2670 return ctx_init;
2671 }
2673 old = *c;
2674 *c = ctx;
2676 return (old);
2677 } /* void plugin_set_ctx */
2679 cdtime_t plugin_get_interval (void)
2680 {
2681 cdtime_t interval;
2683 interval = plugin_get_ctx().interval;
2684 if (interval > 0)
2685 return interval;
2687 return cf_get_default_interval ();
2688 } /* cdtime_t plugin_get_interval */
2690 typedef struct {
2691 plugin_ctx_t ctx;
2692 void *(*start_routine) (void *);
2693 void *arg;
2694 } plugin_thread_t;
2696 static void *plugin_thread_start (void *arg)
2697 {
2698 plugin_thread_t *plugin_thread = arg;
2700 void *(*start_routine) (void *) = plugin_thread->start_routine;
2701 void *plugin_arg = plugin_thread->arg;
2703 plugin_set_ctx (plugin_thread->ctx);
2705 free (plugin_thread);
2707 return start_routine (plugin_arg);
2708 } /* void *plugin_thread_start */
2710 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2711 void *(*start_routine) (void *), void *arg)
2712 {
2713 plugin_thread_t *plugin_thread;
2715 plugin_thread = malloc (sizeof (*plugin_thread));
2716 if (plugin_thread == NULL)
2717 return -1;
2719 plugin_thread->ctx = plugin_get_ctx ();
2720 plugin_thread->start_routine = start_routine;
2721 plugin_thread->arg = arg;
2723 return pthread_create (thread, attr,
2724 plugin_thread_start, plugin_thread);
2725 } /* int plugin_thread_create */
2727 /* vim: set sw=8 ts=8 noet fdm=marker : */