1 /**
2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2013 Florian octo Forster
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the
7 * Free Software Foundation; only version 2 of the License is applicable.
8 *
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17 *
18 * Authors:
19 * Florian octo Forster <octo at collectd.org>
20 * Sebastian Harl <sh at tokkee.org>
21 **/
23 #include "collectd.h"
24 #include "common.h"
25 #include "plugin.h"
26 #include "configfile.h"
27 #include "filter_chain.h"
28 #include "utils_avltree.h"
29 #include "utils_cache.h"
30 #include "utils_complain.h"
31 #include "utils_llist.h"
32 #include "utils_heap.h"
33 #include "utils_time.h"
35 #if HAVE_PTHREAD_H
36 # include <pthread.h>
37 #endif
39 #include <ltdl.h>
41 /*
42 * Private structures
43 */
44 struct callback_func_s
45 {
46 void *cf_callback;
47 user_data_t cf_udata;
48 plugin_ctx_t cf_ctx;
49 };
50 typedef struct callback_func_s callback_func_t;
52 #define RF_SIMPLE 0
53 #define RF_COMPLEX 1
54 #define RF_REMOVE 65535
55 struct read_func_s
56 {
57 /* `read_func_t' "inherits" from `callback_func_t'.
58 * The `rf_super' member MUST be the first one in this structure! */
59 #define rf_callback rf_super.cf_callback
60 #define rf_udata rf_super.cf_udata
61 #define rf_ctx rf_super.cf_ctx
62 callback_func_t rf_super;
63 char rf_group[DATA_MAX_NAME_LEN];
64 char *rf_name;
65 int rf_type;
66 cdtime_t rf_interval;
67 cdtime_t rf_effective_interval;
68 cdtime_t rf_next_read;
69 };
70 typedef struct read_func_s read_func_t;
72 struct write_queue_s;
73 typedef struct write_queue_s write_queue_t;
74 struct write_queue_s
75 {
76 value_list_t *vl;
77 plugin_ctx_t ctx;
78 write_queue_t *next;
79 };
81 /*
82 * Private variables
83 */
84 static c_avl_tree_t *plugins_loaded = NULL;
86 static llist_t *list_init;
87 static llist_t *list_write;
88 static llist_t *list_flush;
89 static llist_t *list_missing;
90 static llist_t *list_shutdown;
91 static llist_t *list_log;
92 static llist_t *list_notification;
94 static fc_chain_t *pre_cache_chain = NULL;
95 static fc_chain_t *post_cache_chain = NULL;
97 static c_avl_tree_t *data_sets;
99 static char *plugindir = NULL;
101 static c_heap_t *read_heap = NULL;
102 static llist_t *read_list;
103 static int read_loop = 1;
104 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
105 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
106 static pthread_t *read_threads = NULL;
107 static int read_threads_num = 0;
109 static write_queue_t *write_queue_head;
110 static write_queue_t *write_queue_tail;
111 static _Bool write_loop = 1;
112 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
113 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
114 static pthread_t *write_threads = NULL;
115 static size_t write_threads_num = 0;
117 static pthread_key_t plugin_ctx_key;
118 static _Bool plugin_ctx_key_initialized = 0;
120 /*
121 * Static functions
122 */
123 static int plugin_dispatch_values_internal (value_list_t *vl);
125 static const char *plugin_get_dir (void)
126 {
127 if (plugindir == NULL)
128 return (PLUGINDIR);
129 else
130 return (plugindir);
131 }
133 static void destroy_callback (callback_func_t *cf) /* {{{ */
134 {
135 if (cf == NULL)
136 return;
138 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
139 {
140 cf->cf_udata.free_func (cf->cf_udata.data);
141 cf->cf_udata.data = NULL;
142 cf->cf_udata.free_func = NULL;
143 }
144 sfree (cf);
145 } /* }}} void destroy_callback */
147 static void destroy_all_callbacks (llist_t **list) /* {{{ */
148 {
149 llentry_t *le;
151 if (*list == NULL)
152 return;
154 le = llist_head (*list);
155 while (le != NULL)
156 {
157 llentry_t *le_next;
159 le_next = le->next;
161 sfree (le->key);
162 destroy_callback (le->value);
163 le->value = NULL;
165 le = le_next;
166 }
168 llist_destroy (*list);
169 *list = NULL;
170 } /* }}} void destroy_all_callbacks */
172 static void destroy_read_heap (void) /* {{{ */
173 {
174 if (read_heap == NULL)
175 return;
177 while (42)
178 {
179 callback_func_t *cf;
181 cf = c_heap_get_root (read_heap);
182 if (cf == NULL)
183 break;
185 destroy_callback (cf);
186 }
188 c_heap_destroy (read_heap);
189 read_heap = NULL;
190 } /* }}} void destroy_read_heap */
192 static int register_callback (llist_t **list, /* {{{ */
193 const char *name, callback_func_t *cf)
194 {
195 llentry_t *le;
196 char *key;
198 if (*list == NULL)
199 {
200 *list = llist_create ();
201 if (*list == NULL)
202 {
203 ERROR ("plugin: register_callback: "
204 "llist_create failed.");
205 destroy_callback (cf);
206 return (-1);
207 }
208 }
210 key = strdup (name);
211 if (key == NULL)
212 {
213 ERROR ("plugin: register_callback: strdup failed.");
214 destroy_callback (cf);
215 return (-1);
216 }
218 le = llist_search (*list, name);
219 if (le == NULL)
220 {
221 le = llentry_create (key, cf);
222 if (le == NULL)
223 {
224 ERROR ("plugin: register_callback: "
225 "llentry_create failed.");
226 free (key);
227 destroy_callback (cf);
228 return (-1);
229 }
231 llist_append (*list, le);
232 }
233 else
234 {
235 callback_func_t *old_cf;
237 old_cf = le->value;
238 le->value = cf;
240 WARNING ("plugin: register_callback: "
241 "a callback named `%s' already exists - "
242 "overwriting the old entry!", name);
244 destroy_callback (old_cf);
245 sfree (key);
246 }
248 return (0);
249 } /* }}} int register_callback */
251 static int create_register_callback (llist_t **list, /* {{{ */
252 const char *name, void *callback, user_data_t *ud)
253 {
254 callback_func_t *cf;
256 cf = (callback_func_t *) malloc (sizeof (*cf));
257 if (cf == NULL)
258 {
259 ERROR ("plugin: create_register_callback: malloc failed.");
260 return (-1);
261 }
262 memset (cf, 0, sizeof (*cf));
264 cf->cf_callback = callback;
265 if (ud == NULL)
266 {
267 cf->cf_udata.data = NULL;
268 cf->cf_udata.free_func = NULL;
269 }
270 else
271 {
272 cf->cf_udata = *ud;
273 }
275 cf->cf_ctx = plugin_get_ctx ();
277 return (register_callback (list, name, cf));
278 } /* }}} int create_register_callback */
280 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
281 {
282 llentry_t *e;
284 if (list == NULL)
285 return (-1);
287 e = llist_search (list, name);
288 if (e == NULL)
289 return (-1);
291 llist_remove (list, e);
293 sfree (e->key);
294 destroy_callback (e->value);
296 llentry_destroy (e);
298 return (0);
299 } /* }}} int plugin_unregister */
301 /*
302 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
303 * object, but it will bitch about a shared object not having a
304 * ``module_register'' symbol..
305 */
306 static int plugin_load_file (char *file, uint32_t flags)
307 {
308 lt_dlhandle dlh;
309 void (*reg_handle) (void);
311 lt_dlinit ();
312 lt_dlerror (); /* clear errors */
314 #if LIBTOOL_VERSION == 2
315 if (flags & PLUGIN_FLAGS_GLOBAL) {
316 lt_dladvise advise;
317 lt_dladvise_init(&advise);
318 lt_dladvise_global(&advise);
319 dlh = lt_dlopenadvise(file, advise);
320 lt_dladvise_destroy(&advise);
321 } else {
322 dlh = lt_dlopen (file);
323 }
324 #else /* if LIBTOOL_VERSION == 1 */
325 if (flags & PLUGIN_FLAGS_GLOBAL)
326 WARNING ("plugin_load_file: The global flag is not supported, "
327 "libtool 2 is required for this.");
328 dlh = lt_dlopen (file);
329 #endif
331 if (dlh == NULL)
332 {
333 char errbuf[1024] = "";
335 ssnprintf (errbuf, sizeof (errbuf),
336 "lt_dlopen (\"%s\") failed: %s. "
337 "The most common cause for this problem are "
338 "missing dependencies. Use ldd(1) to check "
339 "the dependencies of the plugin "
340 "/ shared object.",
341 file, lt_dlerror ());
343 ERROR ("%s", errbuf);
344 /* Make sure this is printed to STDERR in any case, but also
345 * make sure it's printed only once. */
346 if (list_log != NULL)
347 fprintf (stderr, "ERROR: %s\n", errbuf);
349 return (1);
350 }
352 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
353 {
354 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
355 file, lt_dlerror ());
356 lt_dlclose (dlh);
357 return (-1);
358 }
360 (*reg_handle) ();
362 return (0);
363 }
365 static void *plugin_read_thread (void __attribute__((unused)) *args)
366 {
367 while (read_loop != 0)
368 {
369 read_func_t *rf;
370 plugin_ctx_t old_ctx;
371 cdtime_t now;
372 int status;
373 int rf_type;
374 int rc;
376 /* Get the read function that needs to be read next.
377 * We don't need to hold "read_lock" for the heap, but we need
378 * to call c_heap_get_root() and pthread_cond_wait() in the
379 * same protected block. */
380 pthread_mutex_lock (&read_lock);
381 rf = c_heap_get_root (read_heap);
382 if (rf == NULL)
383 {
384 pthread_cond_wait (&read_cond, &read_lock);
385 pthread_mutex_unlock (&read_lock);
386 continue;
387 }
388 pthread_mutex_unlock (&read_lock);
390 if (rf->rf_interval == 0)
391 {
392 /* this should not happen, because the interval is set
393 * for each plugin when loading it
394 * XXX: issue a warning? */
395 rf->rf_interval = plugin_get_interval ();
396 rf->rf_effective_interval = rf->rf_interval;
398 rf->rf_next_read = cdtime ();
399 }
401 /* sleep until this entry is due,
402 * using pthread_cond_timedwait */
403 pthread_mutex_lock (&read_lock);
404 /* In pthread_cond_timedwait, spurious wakeups are possible
405 * (and really happen, at least on NetBSD with > 1 CPU), thus
406 * we need to re-evaluate the condition every time
407 * pthread_cond_timedwait returns. */
408 rc = 0;
409 while ((read_loop != 0)
410 && (cdtime () < rf->rf_next_read)
411 && rc == 0)
412 {
413 struct timespec ts = { 0 };
415 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
417 rc = pthread_cond_timedwait (&read_cond, &read_lock,
418 &ts);
419 }
421 /* Must hold `read_lock' when accessing `rf->rf_type'. */
422 rf_type = rf->rf_type;
423 pthread_mutex_unlock (&read_lock);
425 /* Check if we're supposed to stop.. This may have interrupted
426 * the sleep, too. */
427 if (read_loop == 0)
428 {
429 /* Insert `rf' again, so it can be free'd correctly */
430 c_heap_insert (read_heap, rf);
431 break;
432 }
434 /* The entry has been marked for deletion. The linked list
435 * entry has already been removed by `plugin_unregister_read'.
436 * All we have to do here is free the `read_func_t' and
437 * continue. */
438 if (rf_type == RF_REMOVE)
439 {
440 DEBUG ("plugin_read_thread: Destroying the `%s' "
441 "callback.", rf->rf_name);
442 sfree (rf->rf_name);
443 destroy_callback ((callback_func_t *) rf);
444 rf = NULL;
445 continue;
446 }
448 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
450 old_ctx = plugin_set_ctx (rf->rf_ctx);
452 if (rf_type == RF_SIMPLE)
453 {
454 int (*callback) (void);
456 callback = rf->rf_callback;
457 status = (*callback) ();
458 }
459 else
460 {
461 plugin_read_cb callback;
463 assert (rf_type == RF_COMPLEX);
465 callback = rf->rf_callback;
466 status = (*callback) (&rf->rf_udata);
467 }
469 plugin_set_ctx (old_ctx);
471 /* If the function signals failure, we will increase the
472 * intervals in which it will be called. */
473 if (status != 0)
474 {
475 rf->rf_effective_interval *= 2;
476 if (rf->rf_effective_interval > TIME_T_TO_CDTIME_T (86400))
477 rf->rf_effective_interval = TIME_T_TO_CDTIME_T (86400);
479 NOTICE ("read-function of plugin `%s' failed. "
480 "Will suspend it for %.3f seconds.",
481 rf->rf_name,
482 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
483 }
484 else
485 {
486 /* Success: Restore the interval, if it was changed. */
487 rf->rf_effective_interval = rf->rf_interval;
488 }
490 /* update the ``next read due'' field */
491 now = cdtime ();
493 DEBUG ("plugin_read_thread: Effective interval of the "
494 "%s plugin is %.3f seconds.",
495 rf->rf_name,
496 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
498 /* Calculate the next (absolute) time at which this function
499 * should be called. */
500 rf->rf_next_read += rf->rf_effective_interval;
502 /* Check, if `rf_next_read' is in the past. */
503 if (rf->rf_next_read < now)
504 {
505 /* `rf_next_read' is in the past. Insert `now'
506 * so this value doesn't trail off into the
507 * past too much. */
508 rf->rf_next_read = now;
509 }
511 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
512 rf->rf_name,
513 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
515 /* Re-insert this read function into the heap again. */
516 c_heap_insert (read_heap, rf);
517 } /* while (read_loop) */
519 pthread_exit (NULL);
520 return ((void *) 0);
521 } /* void *plugin_read_thread */
523 static void start_read_threads (int num)
524 {
525 int i;
527 if (read_threads != NULL)
528 return;
530 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
531 if (read_threads == NULL)
532 {
533 ERROR ("plugin: start_read_threads: calloc failed.");
534 return;
535 }
537 read_threads_num = 0;
538 for (i = 0; i < num; i++)
539 {
540 if (pthread_create (read_threads + read_threads_num, NULL,
541 plugin_read_thread, NULL) == 0)
542 {
543 read_threads_num++;
544 }
545 else
546 {
547 ERROR ("plugin: start_read_threads: pthread_create failed.");
548 return;
549 }
550 } /* for (i) */
551 } /* void start_read_threads */
553 static void stop_read_threads (void)
554 {
555 int i;
557 if (read_threads == NULL)
558 return;
560 INFO ("collectd: Stopping %i read threads.", read_threads_num);
562 pthread_mutex_lock (&read_lock);
563 read_loop = 0;
564 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
565 pthread_cond_broadcast (&read_cond);
566 pthread_mutex_unlock (&read_lock);
568 for (i = 0; i < read_threads_num; i++)
569 {
570 if (pthread_join (read_threads[i], NULL) != 0)
571 {
572 ERROR ("plugin: stop_read_threads: pthread_join failed.");
573 }
574 read_threads[i] = (pthread_t) 0;
575 }
576 sfree (read_threads);
577 read_threads_num = 0;
578 } /* void stop_read_threads */
580 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
581 {
582 if (vl == NULL)
583 return;
585 meta_data_destroy (vl->meta);
586 sfree (vl->values);
587 sfree (vl);
588 } /* }}} void plugin_value_list_free */
590 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
591 {
592 value_list_t *vl;
594 if (vl_orig == NULL)
595 return (NULL);
597 vl = malloc (sizeof (*vl));
598 if (vl == NULL)
599 return (NULL);
600 memcpy (vl, vl_orig, sizeof (*vl));
602 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
603 if (vl->values == NULL)
604 {
605 plugin_value_list_free (vl);
606 return (NULL);
607 }
608 memcpy (vl->values, vl_orig->values,
609 vl_orig->values_len * sizeof (*vl->values));
611 vl->meta = meta_data_clone (vl->meta);
612 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
613 {
614 plugin_value_list_free (vl);
615 return (NULL);
616 }
618 if (vl->time == 0)
619 vl->time = cdtime ();
621 /* Fill in the interval from the thread context, if it is zero. */
622 if (vl->interval == 0)
623 {
624 plugin_ctx_t ctx = plugin_get_ctx ();
626 if (ctx.interval != 0)
627 vl->interval = ctx.interval;
628 else
629 {
630 char name[6 * DATA_MAX_NAME_LEN];
631 FORMAT_VL (name, sizeof (name), vl);
632 ERROR ("plugin_value_list_clone: Unable to determine "
633 "interval from context for "
634 "value list \"%s\". "
635 "This indicates a broken plugin. "
636 "Please report this problem to the "
637 "collectd mailing list or at "
638 "<http://collectd.org/bugs/>.", name);
639 vl->interval = cf_get_default_interval ();
640 }
641 }
643 return (vl);
644 } /* }}} value_list_t *plugin_value_list_clone */
646 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
647 {
648 write_queue_t *q;
650 q = malloc (sizeof (*q));
651 if (q == NULL)
652 return (ENOMEM);
653 q->next = NULL;
655 q->vl = plugin_value_list_clone (vl);
656 if (q->vl == NULL)
657 {
658 sfree (q);
659 return (ENOMEM);
660 }
662 /* Store context of caller (read plugin); otherwise, it would not be
663 * available to the write plugins when actually dispatching the
664 * value-list later on. */
665 q->ctx = plugin_get_ctx ();
667 pthread_mutex_lock (&write_lock);
669 if (write_queue_tail == NULL)
670 {
671 write_queue_head = q;
672 write_queue_tail = q;
673 }
674 else
675 {
676 write_queue_tail->next = q;
677 write_queue_tail = q;
678 }
680 pthread_cond_signal (&write_cond);
681 pthread_mutex_unlock (&write_lock);
683 return (0);
684 } /* }}} int plugin_write_enqueue */
686 static value_list_t *plugin_write_dequeue (void) /* {{{ */
687 {
688 write_queue_t *q;
689 value_list_t *vl;
691 pthread_mutex_lock (&write_lock);
693 while (write_loop && (write_queue_head == NULL))
694 pthread_cond_wait (&write_cond, &write_lock);
696 if (write_queue_head == NULL)
697 {
698 pthread_mutex_unlock (&write_lock);
699 return (NULL);
700 }
702 q = write_queue_head;
703 write_queue_head = q->next;
704 if (write_queue_head == NULL)
705 write_queue_tail = NULL;
707 pthread_mutex_unlock (&write_lock);
709 (void) plugin_set_ctx (q->ctx);
711 vl = q->vl;
712 sfree (q);
713 return (vl);
714 } /* }}} value_list_t *plugin_write_dequeue */
716 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
717 {
718 while (write_loop)
719 {
720 value_list_t *vl = plugin_write_dequeue ();
721 if (vl == NULL)
722 continue;
724 plugin_dispatch_values_internal (vl);
726 plugin_value_list_free (vl);
727 }
729 pthread_exit (NULL);
730 return ((void *) 0);
731 } /* }}} void *plugin_write_thread */
733 static void start_write_threads (size_t num) /* {{{ */
734 {
735 size_t i;
737 if (write_threads != NULL)
738 return;
740 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
741 if (write_threads == NULL)
742 {
743 ERROR ("plugin: start_write_threads: calloc failed.");
744 return;
745 }
747 write_threads_num = 0;
748 for (i = 0; i < num; i++)
749 {
750 int status;
752 status = pthread_create (write_threads + write_threads_num,
753 /* attr = */ NULL,
754 plugin_write_thread,
755 /* arg = */ NULL);
756 if (status != 0)
757 {
758 char errbuf[1024];
759 ERROR ("plugin: start_write_threads: pthread_create failed "
760 "with status %i (%s).", status,
761 sstrerror (status, errbuf, sizeof (errbuf)));
762 return;
763 }
765 write_threads_num++;
766 } /* for (i) */
767 } /* }}} void start_write_threads */
769 static void stop_write_threads (void) /* {{{ */
770 {
771 write_queue_t *q;
772 int i;
774 if (write_threads == NULL)
775 return;
777 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
779 pthread_mutex_lock (&write_lock);
780 write_loop = 0;
781 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
782 pthread_cond_broadcast (&write_cond);
783 pthread_mutex_unlock (&write_lock);
785 for (i = 0; i < write_threads_num; i++)
786 {
787 if (pthread_join (write_threads[i], NULL) != 0)
788 {
789 ERROR ("plugin: stop_write_threads: pthread_join failed.");
790 }
791 write_threads[i] = (pthread_t) 0;
792 }
793 sfree (write_threads);
794 write_threads_num = 0;
796 pthread_mutex_lock (&write_lock);
797 i = 0;
798 for (q = write_queue_head; q != NULL; )
799 {
800 write_queue_t *q1 = q;
801 plugin_value_list_free (q->vl);
802 q = q->next;
803 sfree (q1);
804 i++;
805 }
806 write_queue_head = NULL;
807 write_queue_tail = NULL;
808 pthread_mutex_unlock (&write_lock);
810 if (i > 0)
811 {
812 WARNING ("plugin: %i value list%s left after shutting down "
813 "the write threads.",
814 i, (i == 1) ? " was" : "s were");
815 }
816 } /* }}} void stop_write_threads */
818 /*
819 * Public functions
820 */
821 void plugin_set_dir (const char *dir)
822 {
823 if (plugindir != NULL)
824 free (plugindir);
826 if (dir == NULL)
827 plugindir = NULL;
828 else if ((plugindir = strdup (dir)) == NULL)
829 {
830 char errbuf[1024];
831 ERROR ("strdup failed: %s",
832 sstrerror (errno, errbuf, sizeof (errbuf)));
833 }
834 }
836 static _Bool plugin_is_loaded (char const *name)
837 {
838 int status;
840 if (plugins_loaded == NULL)
841 plugins_loaded = c_avl_create ((void *) strcasecmp);
842 assert (plugins_loaded != NULL);
844 status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
845 return (status == 0);
846 }
848 static int plugin_mark_loaded (char const *name)
849 {
850 char *name_copy;
851 int status;
853 name_copy = strdup (name);
854 if (name_copy == NULL)
855 return (ENOMEM);
857 status = c_avl_insert (plugins_loaded,
858 /* key = */ name_copy, /* value = */ NULL);
859 return (status);
860 }
862 static void plugin_free_loaded ()
863 {
864 void *key;
865 void *value;
867 if (plugins_loaded == NULL)
868 return;
870 while (c_avl_pick (plugins_loaded, &key, &value) == 0)
871 {
872 sfree (key);
873 assert (value == NULL);
874 }
876 c_avl_destroy (plugins_loaded);
877 plugins_loaded = NULL;
878 }
880 #define BUFSIZE 512
881 int plugin_load (char const *plugin_name, uint32_t flags)
882 {
883 DIR *dh;
884 const char *dir;
885 char filename[BUFSIZE] = "";
886 char typename[BUFSIZE];
887 int typename_len;
888 int ret;
889 struct stat statbuf;
890 struct dirent *de;
891 int status;
893 if (plugin_name == NULL)
894 return (EINVAL);
896 /* Check if plugin is already loaded and don't do anything in this
897 * case. */
898 if (plugin_is_loaded (plugin_name))
899 return (0);
901 dir = plugin_get_dir ();
902 ret = 1;
904 /*
905 * XXX: Magic at work:
906 *
907 * Some of the language bindings, for example the Python and Perl
908 * plugins, need to be able to export symbols to the scripts they run.
909 * For this to happen, the "Globals" flag needs to be set.
910 * Unfortunately, this technical detail is hard to explain to the
911 * average user and she shouldn't have to worry about this, ideally.
912 * So in order to save everyone's sanity use a different default for a
913 * handful of special plugins. --octo
914 */
915 if ((strcasecmp ("perl", plugin_name) == 0)
916 || (strcasecmp ("python", plugin_name) == 0))
917 flags |= PLUGIN_FLAGS_GLOBAL;
919 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
920 * type when matching the filename */
921 status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
922 if ((status < 0) || ((size_t) status >= sizeof (typename)))
923 {
924 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
925 return (-1);
926 }
927 typename_len = strlen (typename);
929 if ((dh = opendir (dir)) == NULL)
930 {
931 char errbuf[1024];
932 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
933 sstrerror (errno, errbuf, sizeof (errbuf)));
934 return (-1);
935 }
937 while ((de = readdir (dh)) != NULL)
938 {
939 if (strncasecmp (de->d_name, typename, typename_len))
940 continue;
942 status = ssnprintf (filename, sizeof (filename),
943 "%s/%s", dir, de->d_name);
944 if ((status < 0) || ((size_t) status >= sizeof (filename)))
945 {
946 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
947 dir, de->d_name);
948 continue;
949 }
951 if (lstat (filename, &statbuf) == -1)
952 {
953 char errbuf[1024];
954 WARNING ("plugin_load: stat (\"%s\") failed: %s",
955 filename,
956 sstrerror (errno, errbuf, sizeof (errbuf)));
957 continue;
958 }
959 else if (!S_ISREG (statbuf.st_mode))
960 {
961 /* don't follow symlinks */
962 WARNING ("plugin_load: %s is not a regular file.",
963 filename);
964 continue;
965 }
967 status = plugin_load_file (filename, flags);
968 if (status == 0)
969 {
970 /* success */
971 plugin_mark_loaded (plugin_name);
972 ret = 0;
973 break;
974 }
975 else
976 {
977 ERROR ("plugin_load: Load plugin \"%s\" failed with "
978 "status %i.", plugin_name, status);
979 }
980 }
982 closedir (dh);
984 if (filename[0] == 0)
985 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
986 plugin_name, dir);
988 return (ret);
989 }
991 /*
992 * The `register_*' functions follow
993 */
994 int plugin_register_config (const char *name,
995 int (*callback) (const char *key, const char *val),
996 const char **keys, int keys_num)
997 {
998 cf_register (name, callback, keys, keys_num);
999 return (0);
1000 } /* int plugin_register_config */
1002 int plugin_register_complex_config (const char *type,
1003 int (*callback) (oconfig_item_t *))
1004 {
1005 return (cf_register_complex (type, callback));
1006 } /* int plugin_register_complex_config */
1008 int plugin_register_init (const char *name,
1009 int (*callback) (void))
1010 {
1011 return (create_register_callback (&list_init, name, (void *) callback,
1012 /* user_data = */ NULL));
1013 } /* plugin_register_init */
1015 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1016 {
1017 const read_func_t *rf0;
1018 const read_func_t *rf1;
1020 rf0 = arg0;
1021 rf1 = arg1;
1023 if (rf0->rf_next_read < rf1->rf_next_read)
1024 return (-1);
1025 else if (rf0->rf_next_read > rf1->rf_next_read)
1026 return (1);
1027 else
1028 return (0);
1029 } /* int plugin_compare_read_func */
1031 /* Add a read function to both, the heap and a linked list. The linked list if
1032 * used to look-up read functions, especially for the remove function. The heap
1033 * is used to determine which plugin to read next. */
1034 static int plugin_insert_read (read_func_t *rf)
1035 {
1036 int status;
1037 llentry_t *le;
1039 rf->rf_next_read = cdtime ();
1040 rf->rf_effective_interval = rf->rf_interval;
1042 pthread_mutex_lock (&read_lock);
1044 if (read_list == NULL)
1045 {
1046 read_list = llist_create ();
1047 if (read_list == NULL)
1048 {
1049 pthread_mutex_unlock (&read_lock);
1050 ERROR ("plugin_insert_read: read_list failed.");
1051 return (-1);
1052 }
1053 }
1055 if (read_heap == NULL)
1056 {
1057 read_heap = c_heap_create (plugin_compare_read_func);
1058 if (read_heap == NULL)
1059 {
1060 pthread_mutex_unlock (&read_lock);
1061 ERROR ("plugin_insert_read: c_heap_create failed.");
1062 return (-1);
1063 }
1064 }
1066 le = llist_search (read_list, rf->rf_name);
1067 if (le != NULL)
1068 {
1069 pthread_mutex_unlock (&read_lock);
1070 WARNING ("The read function \"%s\" is already registered. "
1071 "Check for duplicate \"LoadPlugin\" lines "
1072 "in your configuration!",
1073 rf->rf_name);
1074 return (EINVAL);
1075 }
1077 le = llentry_create (rf->rf_name, rf);
1078 if (le == NULL)
1079 {
1080 pthread_mutex_unlock (&read_lock);
1081 ERROR ("plugin_insert_read: llentry_create failed.");
1082 return (-1);
1083 }
1085 status = c_heap_insert (read_heap, rf);
1086 if (status != 0)
1087 {
1088 pthread_mutex_unlock (&read_lock);
1089 ERROR ("plugin_insert_read: c_heap_insert failed.");
1090 llentry_destroy (le);
1091 return (-1);
1092 }
1094 /* This does not fail. */
1095 llist_append (read_list, le);
1097 /* Wake up all the read threads. */
1098 pthread_cond_broadcast (&read_cond);
1099 pthread_mutex_unlock (&read_lock);
1100 return (0);
1101 } /* int plugin_insert_read */
1103 int plugin_register_read (const char *name,
1104 int (*callback) (void))
1105 {
1106 read_func_t *rf;
1107 int status;
1109 rf = malloc (sizeof (*rf));
1110 if (rf == NULL)
1111 {
1112 ERROR ("plugin_register_read: malloc failed.");
1113 return (ENOMEM);
1114 }
1116 memset (rf, 0, sizeof (read_func_t));
1117 rf->rf_callback = (void *) callback;
1118 rf->rf_udata.data = NULL;
1119 rf->rf_udata.free_func = NULL;
1120 rf->rf_ctx = plugin_get_ctx ();
1121 rf->rf_group[0] = '\0';
1122 rf->rf_name = strdup (name);
1123 rf->rf_type = RF_SIMPLE;
1124 rf->rf_interval = plugin_get_interval ();
1126 status = plugin_insert_read (rf);
1127 if (status != 0)
1128 sfree (rf);
1130 return (status);
1131 } /* int plugin_register_read */
1133 int plugin_register_complex_read (const char *group, const char *name,
1134 plugin_read_cb callback,
1135 const struct timespec *interval,
1136 user_data_t *user_data)
1137 {
1138 read_func_t *rf;
1139 int status;
1141 rf = malloc (sizeof (*rf));
1142 if (rf == NULL)
1143 {
1144 ERROR ("plugin_register_complex_read: malloc failed.");
1145 return (ENOMEM);
1146 }
1148 memset (rf, 0, sizeof (read_func_t));
1149 rf->rf_callback = (void *) callback;
1150 if (group != NULL)
1151 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1152 else
1153 rf->rf_group[0] = '\0';
1154 rf->rf_name = strdup (name);
1155 rf->rf_type = RF_COMPLEX;
1156 if (interval != NULL)
1157 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1158 else
1159 rf->rf_interval = plugin_get_interval ();
1161 /* Set user data */
1162 if (user_data == NULL)
1163 {
1164 rf->rf_udata.data = NULL;
1165 rf->rf_udata.free_func = NULL;
1166 }
1167 else
1168 {
1169 rf->rf_udata = *user_data;
1170 }
1172 rf->rf_ctx = plugin_get_ctx ();
1174 status = plugin_insert_read (rf);
1175 if (status != 0)
1176 sfree (rf);
1178 return (status);
1179 } /* int plugin_register_complex_read */
1181 int plugin_register_write (const char *name,
1182 plugin_write_cb callback, user_data_t *ud)
1183 {
1184 return (create_register_callback (&list_write, name,
1185 (void *) callback, ud));
1186 } /* int plugin_register_write */
1188 int plugin_register_flush (const char *name,
1189 plugin_flush_cb callback, user_data_t *ud)
1190 {
1191 return (create_register_callback (&list_flush, name,
1192 (void *) callback, ud));
1193 } /* int plugin_register_flush */
1195 int plugin_register_missing (const char *name,
1196 plugin_missing_cb callback, user_data_t *ud)
1197 {
1198 return (create_register_callback (&list_missing, name,
1199 (void *) callback, ud));
1200 } /* int plugin_register_missing */
1202 int plugin_register_shutdown (const char *name,
1203 int (*callback) (void))
1204 {
1205 return (create_register_callback (&list_shutdown, name,
1206 (void *) callback, /* user_data = */ NULL));
1207 } /* int plugin_register_shutdown */
1209 int plugin_register_data_set (const data_set_t *ds)
1210 {
1211 data_set_t *ds_copy;
1212 int i;
1214 if ((data_sets != NULL)
1215 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1216 {
1217 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1218 plugin_unregister_data_set (ds->type);
1219 }
1220 else if (data_sets == NULL)
1221 {
1222 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1223 if (data_sets == NULL)
1224 return (-1);
1225 }
1227 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1228 if (ds_copy == NULL)
1229 return (-1);
1230 memcpy(ds_copy, ds, sizeof (data_set_t));
1232 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1233 * ds->ds_num);
1234 if (ds_copy->ds == NULL)
1235 {
1236 free (ds_copy);
1237 return (-1);
1238 }
1240 for (i = 0; i < ds->ds_num; i++)
1241 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1243 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1244 } /* int plugin_register_data_set */
1246 int plugin_register_log (const char *name,
1247 plugin_log_cb callback, user_data_t *ud)
1248 {
1249 return (create_register_callback (&list_log, name,
1250 (void *) callback, ud));
1251 } /* int plugin_register_log */
1253 int plugin_register_notification (const char *name,
1254 plugin_notification_cb callback, user_data_t *ud)
1255 {
1256 return (create_register_callback (&list_notification, name,
1257 (void *) callback, ud));
1258 } /* int plugin_register_log */
1260 int plugin_unregister_config (const char *name)
1261 {
1262 cf_unregister (name);
1263 return (0);
1264 } /* int plugin_unregister_config */
1266 int plugin_unregister_complex_config (const char *name)
1267 {
1268 cf_unregister_complex (name);
1269 return (0);
1270 } /* int plugin_unregister_complex_config */
1272 int plugin_unregister_init (const char *name)
1273 {
1274 return (plugin_unregister (list_init, name));
1275 }
1277 int plugin_unregister_read (const char *name) /* {{{ */
1278 {
1279 llentry_t *le;
1280 read_func_t *rf;
1282 if (name == NULL)
1283 return (-ENOENT);
1285 pthread_mutex_lock (&read_lock);
1287 if (read_list == NULL)
1288 {
1289 pthread_mutex_unlock (&read_lock);
1290 return (-ENOENT);
1291 }
1293 le = llist_search (read_list, name);
1294 if (le == NULL)
1295 {
1296 pthread_mutex_unlock (&read_lock);
1297 WARNING ("plugin_unregister_read: No such read function: %s",
1298 name);
1299 return (-ENOENT);
1300 }
1302 llist_remove (read_list, le);
1304 rf = le->value;
1305 assert (rf != NULL);
1306 rf->rf_type = RF_REMOVE;
1308 pthread_mutex_unlock (&read_lock);
1310 llentry_destroy (le);
1312 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1314 return (0);
1315 } /* }}} int plugin_unregister_read */
1317 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1318 {
1319 read_func_t *rf = e->value;
1320 char *group = ud;
1322 return strcmp (rf->rf_group, (const char *)group);
1323 } /* }}} int compare_read_func_group */
1325 int plugin_unregister_read_group (const char *group) /* {{{ */
1326 {
1327 llentry_t *le;
1328 read_func_t *rf;
1330 int found = 0;
1332 if (group == NULL)
1333 return (-ENOENT);
1335 pthread_mutex_lock (&read_lock);
1337 if (read_list == NULL)
1338 {
1339 pthread_mutex_unlock (&read_lock);
1340 return (-ENOENT);
1341 }
1343 while (42)
1344 {
1345 le = llist_search_custom (read_list,
1346 compare_read_func_group, (void *)group);
1348 if (le == NULL)
1349 break;
1351 ++found;
1353 llist_remove (read_list, le);
1355 rf = le->value;
1356 assert (rf != NULL);
1357 rf->rf_type = RF_REMOVE;
1359 llentry_destroy (le);
1361 DEBUG ("plugin_unregister_read_group: "
1362 "Marked `%s' (group `%s') for removal.",
1363 rf->rf_name, group);
1364 }
1366 pthread_mutex_unlock (&read_lock);
1368 if (found == 0)
1369 {
1370 WARNING ("plugin_unregister_read_group: No such "
1371 "group of read function: %s", group);
1372 return (-ENOENT);
1373 }
1375 return (0);
1376 } /* }}} int plugin_unregister_read_group */
1378 int plugin_unregister_write (const char *name)
1379 {
1380 return (plugin_unregister (list_write, name));
1381 }
1383 int plugin_unregister_flush (const char *name)
1384 {
1385 return (plugin_unregister (list_flush, name));
1386 }
1388 int plugin_unregister_missing (const char *name)
1389 {
1390 return (plugin_unregister (list_missing, name));
1391 }
1393 int plugin_unregister_shutdown (const char *name)
1394 {
1395 return (plugin_unregister (list_shutdown, name));
1396 }
1398 int plugin_unregister_data_set (const char *name)
1399 {
1400 data_set_t *ds;
1402 if (data_sets == NULL)
1403 return (-1);
1405 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1406 return (-1);
1408 sfree (ds->ds);
1409 sfree (ds);
1411 return (0);
1412 } /* int plugin_unregister_data_set */
1414 int plugin_unregister_log (const char *name)
1415 {
1416 return (plugin_unregister (list_log, name));
1417 }
1419 int plugin_unregister_notification (const char *name)
1420 {
1421 return (plugin_unregister (list_notification, name));
1422 }
1424 void plugin_init_all (void)
1425 {
1426 const char *chain_name;
1427 llentry_t *le;
1428 int status;
1430 /* Init the value cache */
1431 uc_init ();
1433 chain_name = global_option_get ("PreCacheChain");
1434 pre_cache_chain = fc_chain_get_by_name (chain_name);
1436 chain_name = global_option_get ("PostCacheChain");
1437 post_cache_chain = fc_chain_get_by_name (chain_name);
1439 {
1440 char const *tmp = global_option_get ("WriteThreads");
1441 int num = atoi (tmp);
1443 if (num < 1)
1444 num = 5;
1446 start_write_threads ((size_t) num);
1447 }
1449 if ((list_init == NULL) && (read_heap == NULL))
1450 return;
1452 /* Calling all init callbacks before checking if read callbacks
1453 * are available allows the init callbacks to register the read
1454 * callback. */
1455 le = llist_head (list_init);
1456 while (le != NULL)
1457 {
1458 callback_func_t *cf;
1459 plugin_init_cb callback;
1460 plugin_ctx_t old_ctx;
1462 cf = le->value;
1463 old_ctx = plugin_set_ctx (cf->cf_ctx);
1464 callback = cf->cf_callback;
1465 status = (*callback) ();
1466 plugin_set_ctx (old_ctx);
1468 if (status != 0)
1469 {
1470 ERROR ("Initialization of plugin `%s' "
1471 "failed with status %i. "
1472 "Plugin will be unloaded.",
1473 le->key, status);
1474 /* Plugins that register read callbacks from the init
1475 * callback should take care of appropriate error
1476 * handling themselves. */
1477 /* FIXME: Unload _all_ functions */
1478 plugin_unregister_read (le->key);
1479 }
1481 le = le->next;
1482 }
1484 /* Start read-threads */
1485 if (read_heap != NULL)
1486 {
1487 const char *rt;
1488 int num;
1489 rt = global_option_get ("ReadThreads");
1490 num = atoi (rt);
1491 if (num != -1)
1492 start_read_threads ((num > 0) ? num : 5);
1493 }
1494 } /* void plugin_init_all */
1496 /* TODO: Rename this function. */
1497 void plugin_read_all (void)
1498 {
1499 uc_check_timeout ();
1501 return;
1502 } /* void plugin_read_all */
1504 /* Read function called when the `-T' command line argument is given. */
1505 int plugin_read_all_once (void)
1506 {
1507 int status;
1508 int return_status = 0;
1510 if (read_heap == NULL)
1511 {
1512 NOTICE ("No read-functions are registered.");
1513 return (0);
1514 }
1516 while (42)
1517 {
1518 read_func_t *rf;
1519 plugin_ctx_t old_ctx;
1521 rf = c_heap_get_root (read_heap);
1522 if (rf == NULL)
1523 break;
1525 old_ctx = plugin_set_ctx (rf->rf_ctx);
1527 if (rf->rf_type == RF_SIMPLE)
1528 {
1529 int (*callback) (void);
1531 callback = rf->rf_callback;
1532 status = (*callback) ();
1533 }
1534 else
1535 {
1536 plugin_read_cb callback;
1538 callback = rf->rf_callback;
1539 status = (*callback) (&rf->rf_udata);
1540 }
1542 plugin_set_ctx (old_ctx);
1544 if (status != 0)
1545 {
1546 NOTICE ("read-function of plugin `%s' failed.",
1547 rf->rf_name);
1548 return_status = -1;
1549 }
1551 destroy_callback ((void *) rf);
1552 }
1554 return (return_status);
1555 } /* int plugin_read_all_once */
1557 int plugin_write (const char *plugin, /* {{{ */
1558 const data_set_t *ds, const value_list_t *vl)
1559 {
1560 llentry_t *le;
1561 int status;
1563 if (vl == NULL)
1564 return (EINVAL);
1566 if (list_write == NULL)
1567 return (ENOENT);
1569 if (ds == NULL)
1570 {
1571 ds = plugin_get_ds (vl->type);
1572 if (ds == NULL)
1573 {
1574 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1575 return (ENOENT);
1576 }
1577 }
1579 if (plugin == NULL)
1580 {
1581 int success = 0;
1582 int failure = 0;
1584 le = llist_head (list_write);
1585 while (le != NULL)
1586 {
1587 callback_func_t *cf = le->value;
1588 plugin_write_cb callback;
1590 /* do not switch plugin context; rather keep the context (interval)
1591 * information of the calling read plugin */
1593 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1594 callback = cf->cf_callback;
1595 status = (*callback) (ds, vl, &cf->cf_udata);
1596 if (status != 0)
1597 failure++;
1598 else
1599 success++;
1601 le = le->next;
1602 }
1604 if ((success == 0) && (failure != 0))
1605 status = -1;
1606 else
1607 status = 0;
1608 }
1609 else /* plugin != NULL */
1610 {
1611 callback_func_t *cf;
1612 plugin_write_cb callback;
1614 le = llist_head (list_write);
1615 while (le != NULL)
1616 {
1617 if (strcasecmp (plugin, le->key) == 0)
1618 break;
1620 le = le->next;
1621 }
1623 if (le == NULL)
1624 return (ENOENT);
1626 cf = le->value;
1628 /* do not switch plugin context; rather keep the context (interval)
1629 * information of the calling read plugin */
1631 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1632 callback = cf->cf_callback;
1633 status = (*callback) (ds, vl, &cf->cf_udata);
1634 }
1636 return (status);
1637 } /* }}} int plugin_write */
1639 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1640 {
1641 llentry_t *le;
1643 if (list_flush == NULL)
1644 return (0);
1646 le = llist_head (list_flush);
1647 while (le != NULL)
1648 {
1649 callback_func_t *cf;
1650 plugin_flush_cb callback;
1651 plugin_ctx_t old_ctx;
1653 if ((plugin != NULL)
1654 && (strcmp (plugin, le->key) != 0))
1655 {
1656 le = le->next;
1657 continue;
1658 }
1660 cf = le->value;
1661 old_ctx = plugin_set_ctx (cf->cf_ctx);
1662 callback = cf->cf_callback;
1664 (*callback) (timeout, identifier, &cf->cf_udata);
1666 plugin_set_ctx (old_ctx);
1668 le = le->next;
1669 }
1670 return (0);
1671 } /* int plugin_flush */
1673 void plugin_shutdown_all (void)
1674 {
1675 llentry_t *le;
1677 stop_read_threads ();
1679 destroy_all_callbacks (&list_init);
1681 pthread_mutex_lock (&read_lock);
1682 llist_destroy (read_list);
1683 read_list = NULL;
1684 pthread_mutex_unlock (&read_lock);
1686 destroy_read_heap ();
1688 plugin_flush (/* plugin = */ NULL,
1689 /* timeout = */ 0,
1690 /* identifier = */ NULL);
1692 le = NULL;
1693 if (list_shutdown != NULL)
1694 le = llist_head (list_shutdown);
1696 while (le != NULL)
1697 {
1698 callback_func_t *cf;
1699 plugin_shutdown_cb callback;
1700 plugin_ctx_t old_ctx;
1702 cf = le->value;
1703 old_ctx = plugin_set_ctx (cf->cf_ctx);
1704 callback = cf->cf_callback;
1706 /* Advance the pointer before calling the callback allows
1707 * shutdown functions to unregister themselves. If done the
1708 * other way around the memory `le' points to will be freed
1709 * after callback returns. */
1710 le = le->next;
1712 (*callback) ();
1714 plugin_set_ctx (old_ctx);
1715 }
1717 stop_write_threads ();
1719 /* Write plugins which use the `user_data' pointer usually need the
1720 * same data available to the flush callback. If this is the case, set
1721 * the free_function to NULL when registering the flush callback and to
1722 * the real free function when registering the write callback. This way
1723 * the data isn't freed twice. */
1724 destroy_all_callbacks (&list_flush);
1725 destroy_all_callbacks (&list_missing);
1726 destroy_all_callbacks (&list_write);
1728 destroy_all_callbacks (&list_notification);
1729 destroy_all_callbacks (&list_shutdown);
1730 destroy_all_callbacks (&list_log);
1732 plugin_free_loaded ();
1733 } /* void plugin_shutdown_all */
1735 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1736 {
1737 llentry_t *le;
1739 if (list_missing == NULL)
1740 return (0);
1742 le = llist_head (list_missing);
1743 while (le != NULL)
1744 {
1745 callback_func_t *cf;
1746 plugin_missing_cb callback;
1747 plugin_ctx_t old_ctx;
1748 int status;
1750 cf = le->value;
1751 old_ctx = plugin_set_ctx (cf->cf_ctx);
1752 callback = cf->cf_callback;
1754 status = (*callback) (vl, &cf->cf_udata);
1755 plugin_set_ctx (old_ctx);
1756 if (status != 0)
1757 {
1758 if (status < 0)
1759 {
1760 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1761 "failed with status %i.",
1762 le->key, status);
1763 return (status);
1764 }
1765 else
1766 {
1767 return (0);
1768 }
1769 }
1771 le = le->next;
1772 }
1773 return (0);
1774 } /* int }}} plugin_dispatch_missing */
1776 static int plugin_dispatch_values_internal (value_list_t *vl)
1777 {
1778 int status;
1779 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1781 value_t *saved_values;
1782 int saved_values_len;
1784 data_set_t *ds;
1786 int free_meta_data = 0;
1788 if ((vl == NULL) || (vl->type[0] == 0)
1789 || (vl->values == NULL) || (vl->values_len < 1))
1790 {
1791 ERROR ("plugin_dispatch_values: Invalid value list "
1792 "from plugin %s.", vl->plugin);
1793 return (-1);
1794 }
1796 /* Free meta data only if the calling function didn't specify any. In
1797 * this case matches and targets may add some and the calling function
1798 * may not expect (and therefore free) that data. */
1799 if (vl->meta == NULL)
1800 free_meta_data = 1;
1802 if (list_write == NULL)
1803 c_complain_once (LOG_WARNING, &no_write_complaint,
1804 "plugin_dispatch_values: No write callback has been "
1805 "registered. Please load at least one output plugin, "
1806 "if you want the collected data to be stored.");
1808 if (data_sets == NULL)
1809 {
1810 ERROR ("plugin_dispatch_values: No data sets registered. "
1811 "Could the types database be read? Check "
1812 "your `TypesDB' setting!");
1813 return (-1);
1814 }
1816 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1817 {
1818 char ident[6 * DATA_MAX_NAME_LEN];
1820 FORMAT_VL (ident, sizeof (ident), vl);
1821 INFO ("plugin_dispatch_values: Dataset not found: %s "
1822 "(from \"%s\"), check your types.db!",
1823 vl->type, ident);
1824 return (-1);
1825 }
1827 /* Assured by plugin_value_list_clone(). The time is determined at
1828 * _enqueue_ time. */
1829 assert (vl->time != 0);
1830 assert (vl->interval != 0);
1832 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1833 "host = %s; "
1834 "plugin = %s; plugin_instance = %s; "
1835 "type = %s; type_instance = %s;",
1836 CDTIME_T_TO_DOUBLE (vl->time),
1837 CDTIME_T_TO_DOUBLE (vl->interval),
1838 vl->host,
1839 vl->plugin, vl->plugin_instance,
1840 vl->type, vl->type_instance);
1842 #if COLLECT_DEBUG
1843 assert (0 == strcmp (ds->type, vl->type));
1844 #else
1845 if (0 != strcmp (ds->type, vl->type))
1846 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1847 ds->type, vl->type);
1848 #endif
1850 #if COLLECT_DEBUG
1851 assert (ds->ds_num == vl->values_len);
1852 #else
1853 if (ds->ds_num != vl->values_len)
1854 {
1855 ERROR ("plugin_dispatch_values: ds->type = %s: "
1856 "(ds->ds_num = %i) != "
1857 "(vl->values_len = %i)",
1858 ds->type, ds->ds_num, vl->values_len);
1859 return (-1);
1860 }
1861 #endif
1863 escape_slashes (vl->host, sizeof (vl->host));
1864 escape_slashes (vl->plugin, sizeof (vl->plugin));
1865 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1866 escape_slashes (vl->type, sizeof (vl->type));
1867 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1869 /* Copy the values. This way, we can assure `targets' that they get
1870 * dynamically allocated values, which they can free and replace if
1871 * they like. */
1872 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1873 {
1874 saved_values = vl->values;
1875 saved_values_len = vl->values_len;
1877 vl->values = (value_t *) calloc (vl->values_len,
1878 sizeof (*vl->values));
1879 if (vl->values == NULL)
1880 {
1881 ERROR ("plugin_dispatch_values: calloc failed.");
1882 vl->values = saved_values;
1883 return (-1);
1884 }
1885 memcpy (vl->values, saved_values,
1886 vl->values_len * sizeof (*vl->values));
1887 }
1888 else /* if ((pre == NULL) && (post == NULL)) */
1889 {
1890 saved_values = NULL;
1891 saved_values_len = 0;
1892 }
1894 if (pre_cache_chain != NULL)
1895 {
1896 status = fc_process_chain (ds, vl, pre_cache_chain);
1897 if (status < 0)
1898 {
1899 WARNING ("plugin_dispatch_values: Running the "
1900 "pre-cache chain failed with "
1901 "status %i (%#x).",
1902 status, status);
1903 }
1904 else if (status == FC_TARGET_STOP)
1905 {
1906 /* Restore the state of the value_list so that plugins
1907 * don't get confused.. */
1908 if (saved_values != NULL)
1909 {
1910 free (vl->values);
1911 vl->values = saved_values;
1912 vl->values_len = saved_values_len;
1913 }
1914 return (0);
1915 }
1916 }
1918 /* Update the value cache */
1919 uc_update (ds, vl);
1921 if (post_cache_chain != NULL)
1922 {
1923 status = fc_process_chain (ds, vl, post_cache_chain);
1924 if (status < 0)
1925 {
1926 WARNING ("plugin_dispatch_values: Running the "
1927 "post-cache chain failed with "
1928 "status %i (%#x).",
1929 status, status);
1930 }
1931 }
1932 else
1933 fc_default_action (ds, vl);
1935 /* Restore the state of the value_list so that plugins don't get
1936 * confused.. */
1937 if (saved_values != NULL)
1938 {
1939 free (vl->values);
1940 vl->values = saved_values;
1941 vl->values_len = saved_values_len;
1942 }
1944 if ((free_meta_data != 0) && (vl->meta != NULL))
1945 {
1946 meta_data_destroy (vl->meta);
1947 vl->meta = NULL;
1948 }
1950 return (0);
1951 } /* int plugin_dispatch_values_internal */
1953 int plugin_dispatch_values (value_list_t const *vl)
1954 {
1955 int status;
1957 status = plugin_write_enqueue (vl);
1958 if (status != 0)
1959 {
1960 char errbuf[1024];
1961 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
1962 "with status %i (%s).", status,
1963 sstrerror (status, errbuf, sizeof (errbuf)));
1964 return (status);
1965 }
1967 return (0);
1968 }
1970 int plugin_dispatch_notification (const notification_t *notif)
1971 {
1972 llentry_t *le;
1973 /* Possible TODO: Add flap detection here */
1975 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1976 "time = %.3f; host = %s;",
1977 notif->severity, notif->message,
1978 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1980 /* Nobody cares for notifications */
1981 if (list_notification == NULL)
1982 return (-1);
1984 le = llist_head (list_notification);
1985 while (le != NULL)
1986 {
1987 callback_func_t *cf;
1988 plugin_notification_cb callback;
1989 int status;
1991 /* do not switch plugin context; rather keep the context
1992 * (interval) information of the calling plugin */
1994 cf = le->value;
1995 callback = cf->cf_callback;
1996 status = (*callback) (notif, &cf->cf_udata);
1997 if (status != 0)
1998 {
1999 WARNING ("plugin_dispatch_notification: Notification "
2000 "callback %s returned %i.",
2001 le->key, status);
2002 }
2004 le = le->next;
2005 }
2007 return (0);
2008 } /* int plugin_dispatch_notification */
2010 void plugin_log (int level, const char *format, ...)
2011 {
2012 char msg[1024];
2013 va_list ap;
2014 llentry_t *le;
2016 #if !COLLECT_DEBUG
2017 if (level >= LOG_DEBUG)
2018 return;
2019 #endif
2021 va_start (ap, format);
2022 vsnprintf (msg, sizeof (msg), format, ap);
2023 msg[sizeof (msg) - 1] = '\0';
2024 va_end (ap);
2026 if (list_log == NULL)
2027 {
2028 fprintf (stderr, "%s\n", msg);
2029 return;
2030 }
2032 le = llist_head (list_log);
2033 while (le != NULL)
2034 {
2035 callback_func_t *cf;
2036 plugin_log_cb callback;
2038 cf = le->value;
2039 callback = cf->cf_callback;
2041 /* do not switch plugin context; rather keep the context
2042 * (interval) information of the calling plugin */
2044 (*callback) (level, msg, &cf->cf_udata);
2046 le = le->next;
2047 }
2048 } /* void plugin_log */
2050 int parse_log_severity (const char *severity)
2051 {
2052 int log_level = -1;
2054 if ((0 == strcasecmp (severity, "emerg"))
2055 || (0 == strcasecmp (severity, "alert"))
2056 || (0 == strcasecmp (severity, "crit"))
2057 || (0 == strcasecmp (severity, "err")))
2058 log_level = LOG_ERR;
2059 else if (0 == strcasecmp (severity, "warning"))
2060 log_level = LOG_WARNING;
2061 else if (0 == strcasecmp (severity, "notice"))
2062 log_level = LOG_NOTICE;
2063 else if (0 == strcasecmp (severity, "info"))
2064 log_level = LOG_INFO;
2065 #if COLLECT_DEBUG
2066 else if (0 == strcasecmp (severity, "debug"))
2067 log_level = LOG_DEBUG;
2068 #endif /* COLLECT_DEBUG */
2070 return (log_level);
2071 } /* int parse_log_severity */
2073 int parse_notif_severity (const char *severity)
2074 {
2075 int notif_severity = -1;
2077 if (strcasecmp (severity, "FAILURE") == 0)
2078 notif_severity = NOTIF_FAILURE;
2079 else if (strcmp (severity, "OKAY") == 0)
2080 notif_severity = NOTIF_OKAY;
2081 else if ((strcmp (severity, "WARNING") == 0)
2082 || (strcmp (severity, "WARN") == 0))
2083 notif_severity = NOTIF_WARNING;
2085 return (notif_severity);
2086 } /* int parse_notif_severity */
2088 const data_set_t *plugin_get_ds (const char *name)
2089 {
2090 data_set_t *ds;
2092 if (data_sets == NULL)
2093 {
2094 ERROR ("plugin_get_ds: No data sets are defined yet.");
2095 return (NULL);
2096 }
2098 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2099 {
2100 DEBUG ("No such dataset registered: %s", name);
2101 return (NULL);
2102 }
2104 return (ds);
2105 } /* data_set_t *plugin_get_ds */
2107 static int plugin_notification_meta_add (notification_t *n,
2108 const char *name,
2109 enum notification_meta_type_e type,
2110 const void *value)
2111 {
2112 notification_meta_t *meta;
2113 notification_meta_t *tail;
2115 if ((n == NULL) || (name == NULL) || (value == NULL))
2116 {
2117 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2118 return (-1);
2119 }
2121 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2122 if (meta == NULL)
2123 {
2124 ERROR ("plugin_notification_meta_add: malloc failed.");
2125 return (-1);
2126 }
2127 memset (meta, 0, sizeof (notification_meta_t));
2129 sstrncpy (meta->name, name, sizeof (meta->name));
2130 meta->type = type;
2132 switch (type)
2133 {
2134 case NM_TYPE_STRING:
2135 {
2136 meta->nm_value.nm_string = strdup ((const char *) value);
2137 if (meta->nm_value.nm_string == NULL)
2138 {
2139 ERROR ("plugin_notification_meta_add: strdup failed.");
2140 sfree (meta);
2141 return (-1);
2142 }
2143 break;
2144 }
2145 case NM_TYPE_SIGNED_INT:
2146 {
2147 meta->nm_value.nm_signed_int = *((int64_t *) value);
2148 break;
2149 }
2150 case NM_TYPE_UNSIGNED_INT:
2151 {
2152 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2153 break;
2154 }
2155 case NM_TYPE_DOUBLE:
2156 {
2157 meta->nm_value.nm_double = *((double *) value);
2158 break;
2159 }
2160 case NM_TYPE_BOOLEAN:
2161 {
2162 meta->nm_value.nm_boolean = *((_Bool *) value);
2163 break;
2164 }
2165 default:
2166 {
2167 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2168 sfree (meta);
2169 return (-1);
2170 }
2171 } /* switch (type) */
2173 meta->next = NULL;
2174 tail = n->meta;
2175 while ((tail != NULL) && (tail->next != NULL))
2176 tail = tail->next;
2178 if (tail == NULL)
2179 n->meta = meta;
2180 else
2181 tail->next = meta;
2183 return (0);
2184 } /* int plugin_notification_meta_add */
2186 int plugin_notification_meta_add_string (notification_t *n,
2187 const char *name,
2188 const char *value)
2189 {
2190 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2191 }
2193 int plugin_notification_meta_add_signed_int (notification_t *n,
2194 const char *name,
2195 int64_t value)
2196 {
2197 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2198 }
2200 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2201 const char *name,
2202 uint64_t value)
2203 {
2204 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2205 }
2207 int plugin_notification_meta_add_double (notification_t *n,
2208 const char *name,
2209 double value)
2210 {
2211 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2212 }
2214 int plugin_notification_meta_add_boolean (notification_t *n,
2215 const char *name,
2216 _Bool value)
2217 {
2218 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2219 }
2221 int plugin_notification_meta_copy (notification_t *dst,
2222 const notification_t *src)
2223 {
2224 notification_meta_t *meta;
2226 assert (dst != NULL);
2227 assert (src != NULL);
2228 assert (dst != src);
2229 assert ((src->meta == NULL) || (src->meta != dst->meta));
2231 for (meta = src->meta; meta != NULL; meta = meta->next)
2232 {
2233 if (meta->type == NM_TYPE_STRING)
2234 plugin_notification_meta_add_string (dst, meta->name,
2235 meta->nm_value.nm_string);
2236 else if (meta->type == NM_TYPE_SIGNED_INT)
2237 plugin_notification_meta_add_signed_int (dst, meta->name,
2238 meta->nm_value.nm_signed_int);
2239 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2240 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2241 meta->nm_value.nm_unsigned_int);
2242 else if (meta->type == NM_TYPE_DOUBLE)
2243 plugin_notification_meta_add_double (dst, meta->name,
2244 meta->nm_value.nm_double);
2245 else if (meta->type == NM_TYPE_BOOLEAN)
2246 plugin_notification_meta_add_boolean (dst, meta->name,
2247 meta->nm_value.nm_boolean);
2248 }
2250 return (0);
2251 } /* int plugin_notification_meta_copy */
2253 int plugin_notification_meta_free (notification_meta_t *n)
2254 {
2255 notification_meta_t *this;
2256 notification_meta_t *next;
2258 if (n == NULL)
2259 {
2260 ERROR ("plugin_notification_meta_free: n == NULL!");
2261 return (-1);
2262 }
2264 this = n;
2265 while (this != NULL)
2266 {
2267 next = this->next;
2269 if (this->type == NM_TYPE_STRING)
2270 {
2271 free ((char *)this->nm_value.nm_string);
2272 this->nm_value.nm_string = NULL;
2273 }
2274 sfree (this);
2276 this = next;
2277 }
2279 return (0);
2280 } /* int plugin_notification_meta_free */
2282 static void plugin_ctx_destructor (void *ctx)
2283 {
2284 sfree (ctx);
2285 } /* void plugin_ctx_destructor */
2287 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2289 static plugin_ctx_t *plugin_ctx_create (void)
2290 {
2291 plugin_ctx_t *ctx;
2293 ctx = malloc (sizeof (*ctx));
2294 if (ctx == NULL) {
2295 char errbuf[1024];
2296 ERROR ("Failed to allocate plugin context: %s",
2297 sstrerror (errno, errbuf, sizeof (errbuf)));
2298 return NULL;
2299 }
2301 *ctx = ctx_init;
2302 assert (plugin_ctx_key_initialized);
2303 pthread_setspecific (plugin_ctx_key, ctx);
2304 DEBUG("Created new plugin context.");
2305 return (ctx);
2306 } /* int plugin_ctx_create */
2308 void plugin_init_ctx (void)
2309 {
2310 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2311 plugin_ctx_key_initialized = 1;
2312 } /* void plugin_init_ctx */
2314 plugin_ctx_t plugin_get_ctx (void)
2315 {
2316 plugin_ctx_t *ctx;
2318 assert (plugin_ctx_key_initialized);
2319 ctx = pthread_getspecific (plugin_ctx_key);
2321 if (ctx == NULL) {
2322 ctx = plugin_ctx_create ();
2323 /* this must no happen -- exit() instead? */
2324 if (ctx == NULL)
2325 return ctx_init;
2326 }
2328 return (*ctx);
2329 } /* plugin_ctx_t plugin_get_ctx */
2331 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2332 {
2333 plugin_ctx_t *c;
2334 plugin_ctx_t old;
2336 assert (plugin_ctx_key_initialized);
2337 c = pthread_getspecific (plugin_ctx_key);
2339 if (c == NULL) {
2340 c = plugin_ctx_create ();
2341 /* this must no happen -- exit() instead? */
2342 if (c == NULL)
2343 return ctx_init;
2344 }
2346 old = *c;
2347 *c = ctx;
2349 return (old);
2350 } /* void plugin_set_ctx */
2352 cdtime_t plugin_get_interval (void)
2353 {
2354 cdtime_t interval;
2356 interval = plugin_get_ctx().interval;
2357 if (interval > 0)
2358 return interval;
2360 return cf_get_default_interval ();
2361 } /* cdtime_t plugin_get_interval */
2363 typedef struct {
2364 plugin_ctx_t ctx;
2365 void *(*start_routine) (void *);
2366 void *arg;
2367 } plugin_thread_t;
2369 static void *plugin_thread_start (void *arg)
2370 {
2371 plugin_thread_t *plugin_thread = arg;
2373 void *(*start_routine) (void *) = plugin_thread->start_routine;
2374 void *plugin_arg = plugin_thread->arg;
2376 plugin_set_ctx (plugin_thread->ctx);
2378 free (plugin_thread);
2380 return start_routine (plugin_arg);
2381 } /* void *plugin_thread_start */
2383 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2384 void *(*start_routine) (void *), void *arg)
2385 {
2386 plugin_thread_t *plugin_thread;
2388 plugin_thread = malloc (sizeof (*plugin_thread));
2389 if (plugin_thread == NULL)
2390 return -1;
2392 plugin_thread->ctx = plugin_get_ctx ();
2393 plugin_thread->start_routine = start_routine;
2394 plugin_thread->arg = arg;
2396 return pthread_create (thread, attr,
2397 plugin_thread_start, plugin_thread);
2398 } /* int plugin_thread_create */
2400 /* vim: set sw=8 ts=8 noet fdm=marker : */