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[DATA_MAX_NAME_LEN];
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 llist_t *list_init;
85 static llist_t *list_write;
86 static llist_t *list_flush;
87 static llist_t *list_missing;
88 static llist_t *list_shutdown;
89 static llist_t *list_log;
90 static llist_t *list_notification;
92 static fc_chain_t *pre_cache_chain = NULL;
93 static fc_chain_t *post_cache_chain = NULL;
95 static c_avl_tree_t *data_sets;
97 static char *plugindir = NULL;
99 static c_heap_t *read_heap = NULL;
100 static llist_t *read_list;
101 static int read_loop = 1;
102 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
103 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
104 static pthread_t *read_threads = NULL;
105 static int read_threads_num = 0;
107 static write_queue_t *write_queue_head;
108 static write_queue_t *write_queue_tail;
109 static _Bool write_loop = 1;
110 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
111 static pthread_cond_t write_cond = PTHREAD_COND_INITIALIZER;
112 static pthread_t *write_threads = NULL;
113 static size_t write_threads_num = 0;
115 static pthread_key_t plugin_ctx_key;
116 static _Bool plugin_ctx_key_initialized = 0;
118 /*
119 * Static functions
120 */
121 static int plugin_dispatch_values_internal (value_list_t *vl);
123 static const char *plugin_get_dir (void)
124 {
125 if (plugindir == NULL)
126 return (PLUGINDIR);
127 else
128 return (plugindir);
129 }
131 static void destroy_callback (callback_func_t *cf) /* {{{ */
132 {
133 if (cf == NULL)
134 return;
136 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
137 {
138 cf->cf_udata.free_func (cf->cf_udata.data);
139 cf->cf_udata.data = NULL;
140 cf->cf_udata.free_func = NULL;
141 }
142 sfree (cf);
143 } /* }}} void destroy_callback */
145 static void destroy_all_callbacks (llist_t **list) /* {{{ */
146 {
147 llentry_t *le;
149 if (*list == NULL)
150 return;
152 le = llist_head (*list);
153 while (le != NULL)
154 {
155 llentry_t *le_next;
157 le_next = le->next;
159 sfree (le->key);
160 destroy_callback (le->value);
161 le->value = NULL;
163 le = le_next;
164 }
166 llist_destroy (*list);
167 *list = NULL;
168 } /* }}} void destroy_all_callbacks */
170 static void destroy_read_heap (void) /* {{{ */
171 {
172 if (read_heap == NULL)
173 return;
175 while (42)
176 {
177 callback_func_t *cf;
179 cf = c_heap_get_root (read_heap);
180 if (cf == NULL)
181 break;
183 destroy_callback (cf);
184 }
186 c_heap_destroy (read_heap);
187 read_heap = NULL;
188 } /* }}} void destroy_read_heap */
190 static int register_callback (llist_t **list, /* {{{ */
191 const char *name, callback_func_t *cf)
192 {
193 llentry_t *le;
194 char *key;
196 if (*list == NULL)
197 {
198 *list = llist_create ();
199 if (*list == NULL)
200 {
201 ERROR ("plugin: register_callback: "
202 "llist_create failed.");
203 destroy_callback (cf);
204 return (-1);
205 }
206 }
208 key = strdup (name);
209 if (key == NULL)
210 {
211 ERROR ("plugin: register_callback: strdup failed.");
212 destroy_callback (cf);
213 return (-1);
214 }
216 le = llist_search (*list, name);
217 if (le == NULL)
218 {
219 le = llentry_create (key, cf);
220 if (le == NULL)
221 {
222 ERROR ("plugin: register_callback: "
223 "llentry_create failed.");
224 free (key);
225 destroy_callback (cf);
226 return (-1);
227 }
229 llist_append (*list, le);
230 }
231 else
232 {
233 callback_func_t *old_cf;
235 old_cf = le->value;
236 le->value = cf;
238 WARNING ("plugin: register_callback: "
239 "a callback named `%s' already exists - "
240 "overwriting the old entry!", name);
242 destroy_callback (old_cf);
243 sfree (key);
244 }
246 return (0);
247 } /* }}} int register_callback */
249 static int create_register_callback (llist_t **list, /* {{{ */
250 const char *name, void *callback, user_data_t *ud)
251 {
252 callback_func_t *cf;
254 cf = (callback_func_t *) malloc (sizeof (*cf));
255 if (cf == NULL)
256 {
257 ERROR ("plugin: create_register_callback: malloc failed.");
258 return (-1);
259 }
260 memset (cf, 0, sizeof (*cf));
262 cf->cf_callback = callback;
263 if (ud == NULL)
264 {
265 cf->cf_udata.data = NULL;
266 cf->cf_udata.free_func = NULL;
267 }
268 else
269 {
270 cf->cf_udata = *ud;
271 }
273 cf->cf_ctx = plugin_get_ctx ();
275 return (register_callback (list, name, cf));
276 } /* }}} int create_register_callback */
278 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
279 {
280 llentry_t *e;
282 if (list == NULL)
283 return (-1);
285 e = llist_search (list, name);
286 if (e == NULL)
287 return (-1);
289 llist_remove (list, e);
291 sfree (e->key);
292 destroy_callback (e->value);
294 llentry_destroy (e);
296 return (0);
297 } /* }}} int plugin_unregister */
299 /*
300 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
301 * object, but it will bitch about a shared object not having a
302 * ``module_register'' symbol..
303 */
304 static int plugin_load_file (char *file, uint32_t flags)
305 {
306 lt_dlhandle dlh;
307 void (*reg_handle) (void);
309 lt_dlinit ();
310 lt_dlerror (); /* clear errors */
312 #if LIBTOOL_VERSION == 2
313 if (flags & PLUGIN_FLAGS_GLOBAL) {
314 lt_dladvise advise;
315 lt_dladvise_init(&advise);
316 lt_dladvise_global(&advise);
317 dlh = lt_dlopenadvise(file, advise);
318 lt_dladvise_destroy(&advise);
319 } else {
320 dlh = lt_dlopen (file);
321 }
322 #else /* if LIBTOOL_VERSION == 1 */
323 if (flags & PLUGIN_FLAGS_GLOBAL)
324 WARNING ("plugin_load_file: The global flag is not supported, "
325 "libtool 2 is required for this.");
326 dlh = lt_dlopen (file);
327 #endif
329 if (dlh == NULL)
330 {
331 char errbuf[1024] = "";
333 ssnprintf (errbuf, sizeof (errbuf),
334 "lt_dlopen (\"%s\") failed: %s. "
335 "The most common cause for this problem are "
336 "missing dependencies. Use ldd(1) to check "
337 "the dependencies of the plugin "
338 "/ shared object.",
339 file, lt_dlerror ());
341 ERROR ("%s", errbuf);
342 /* Make sure this is printed to STDERR in any case, but also
343 * make sure it's printed only once. */
344 if (list_log != NULL)
345 fprintf (stderr, "ERROR: %s\n", errbuf);
347 return (1);
348 }
350 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
351 {
352 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
353 file, lt_dlerror ());
354 lt_dlclose (dlh);
355 return (-1);
356 }
358 (*reg_handle) ();
360 return (0);
361 }
363 static void *plugin_read_thread (void __attribute__((unused)) *args)
364 {
365 while (read_loop != 0)
366 {
367 read_func_t *rf;
368 plugin_ctx_t old_ctx;
369 cdtime_t now;
370 int status;
371 int rf_type;
372 int rc;
374 /* Get the read function that needs to be read next.
375 * We don't need to hold "read_lock" for the heap, but we need
376 * to call c_heap_get_root() and pthread_cond_wait() in the
377 * same protected block. */
378 pthread_mutex_lock (&read_lock);
379 rf = c_heap_get_root (read_heap);
380 if (rf == NULL)
381 {
382 pthread_cond_wait (&read_cond, &read_lock);
383 pthread_mutex_unlock (&read_lock);
384 continue;
385 }
386 pthread_mutex_unlock (&read_lock);
388 if (rf->rf_interval == 0)
389 {
390 /* this should not happen, because the interval is set
391 * for each plugin when loading it
392 * XXX: issue a warning? */
393 rf->rf_interval = plugin_get_interval ();
394 rf->rf_effective_interval = rf->rf_interval;
396 rf->rf_next_read = cdtime ();
397 }
399 /* sleep until this entry is due,
400 * using pthread_cond_timedwait */
401 pthread_mutex_lock (&read_lock);
402 /* In pthread_cond_timedwait, spurious wakeups are possible
403 * (and really happen, at least on NetBSD with > 1 CPU), thus
404 * we need to re-evaluate the condition every time
405 * pthread_cond_timedwait returns. */
406 rc = 0;
407 while ((read_loop != 0)
408 && (cdtime () < rf->rf_next_read)
409 && rc == 0)
410 {
411 struct timespec ts = { 0 };
413 CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
415 rc = pthread_cond_timedwait (&read_cond, &read_lock,
416 &ts);
417 }
419 /* Must hold `read_lock' when accessing `rf->rf_type'. */
420 rf_type = rf->rf_type;
421 pthread_mutex_unlock (&read_lock);
423 /* Check if we're supposed to stop.. This may have interrupted
424 * the sleep, too. */
425 if (read_loop == 0)
426 {
427 /* Insert `rf' again, so it can be free'd correctly */
428 c_heap_insert (read_heap, rf);
429 break;
430 }
432 /* The entry has been marked for deletion. The linked list
433 * entry has already been removed by `plugin_unregister_read'.
434 * All we have to do here is free the `read_func_t' and
435 * continue. */
436 if (rf_type == RF_REMOVE)
437 {
438 DEBUG ("plugin_read_thread: Destroying the `%s' "
439 "callback.", rf->rf_name);
440 destroy_callback ((callback_func_t *) rf);
441 rf = NULL;
442 continue;
443 }
445 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
447 old_ctx = plugin_set_ctx (rf->rf_ctx);
449 if (rf_type == RF_SIMPLE)
450 {
451 int (*callback) (void);
453 callback = rf->rf_callback;
454 status = (*callback) ();
455 }
456 else
457 {
458 plugin_read_cb callback;
460 assert (rf_type == RF_COMPLEX);
462 callback = rf->rf_callback;
463 status = (*callback) (&rf->rf_udata);
464 }
466 plugin_set_ctx (old_ctx);
468 /* If the function signals failure, we will increase the
469 * intervals in which it will be called. */
470 if (status != 0)
471 {
472 rf->rf_effective_interval *= 2;
473 if (rf->rf_effective_interval > TIME_T_TO_CDTIME_T (86400))
474 rf->rf_effective_interval = TIME_T_TO_CDTIME_T (86400);
476 NOTICE ("read-function of plugin `%s' failed. "
477 "Will suspend it for %.3f seconds.",
478 rf->rf_name,
479 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
480 }
481 else
482 {
483 /* Success: Restore the interval, if it was changed. */
484 rf->rf_effective_interval = rf->rf_interval;
485 }
487 /* update the ``next read due'' field */
488 now = cdtime ();
490 DEBUG ("plugin_read_thread: Effective interval of the "
491 "%s plugin is %.3f seconds.",
492 rf->rf_name,
493 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
495 /* Calculate the next (absolute) time at which this function
496 * should be called. */
497 rf->rf_next_read += rf->rf_effective_interval;
499 /* Check, if `rf_next_read' is in the past. */
500 if (rf->rf_next_read < now)
501 {
502 /* `rf_next_read' is in the past. Insert `now'
503 * so this value doesn't trail off into the
504 * past too much. */
505 rf->rf_next_read = now;
506 }
508 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
509 rf->rf_name,
510 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
512 /* Re-insert this read function into the heap again. */
513 c_heap_insert (read_heap, rf);
514 } /* while (read_loop) */
516 pthread_exit (NULL);
517 return ((void *) 0);
518 } /* void *plugin_read_thread */
520 static void start_read_threads (int num)
521 {
522 int i;
524 if (read_threads != NULL)
525 return;
527 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
528 if (read_threads == NULL)
529 {
530 ERROR ("plugin: start_read_threads: calloc failed.");
531 return;
532 }
534 read_threads_num = 0;
535 for (i = 0; i < num; i++)
536 {
537 if (pthread_create (read_threads + read_threads_num, NULL,
538 plugin_read_thread, NULL) == 0)
539 {
540 read_threads_num++;
541 }
542 else
543 {
544 ERROR ("plugin: start_read_threads: pthread_create failed.");
545 return;
546 }
547 } /* for (i) */
548 } /* void start_read_threads */
550 static void stop_read_threads (void)
551 {
552 int i;
554 if (read_threads == NULL)
555 return;
557 INFO ("collectd: Stopping %i read threads.", read_threads_num);
559 pthread_mutex_lock (&read_lock);
560 read_loop = 0;
561 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
562 pthread_cond_broadcast (&read_cond);
563 pthread_mutex_unlock (&read_lock);
565 for (i = 0; i < read_threads_num; i++)
566 {
567 if (pthread_join (read_threads[i], NULL) != 0)
568 {
569 ERROR ("plugin: stop_read_threads: pthread_join failed.");
570 }
571 read_threads[i] = (pthread_t) 0;
572 }
573 sfree (read_threads);
574 read_threads_num = 0;
575 } /* void stop_read_threads */
577 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
578 {
579 if (vl == NULL)
580 return;
582 meta_data_destroy (vl->meta);
583 sfree (vl->values);
584 sfree (vl);
585 } /* }}} void plugin_value_list_free */
587 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
588 {
589 value_list_t *vl;
591 if (vl_orig == NULL)
592 return (NULL);
594 vl = malloc (sizeof (*vl));
595 if (vl == NULL)
596 return (NULL);
597 memcpy (vl, vl_orig, sizeof (*vl));
599 vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
600 if (vl->values == NULL)
601 {
602 plugin_value_list_free (vl);
603 return (NULL);
604 }
605 memcpy (vl->values, vl_orig->values,
606 vl_orig->values_len * sizeof (*vl->values));
608 vl->meta = meta_data_clone (vl->meta);
609 if ((vl_orig->meta != NULL) && (vl->meta == NULL))
610 {
611 plugin_value_list_free (vl);
612 return (NULL);
613 }
615 if (vl->time == 0)
616 vl->time = cdtime ();
618 /* Fill in the interval from the thread context, if it is zero. */
619 if (vl->interval == 0)
620 {
621 plugin_ctx_t ctx = plugin_get_ctx ();
623 if (ctx.interval != 0)
624 vl->interval = ctx.interval;
625 else
626 {
627 char name[6 * DATA_MAX_NAME_LEN];
628 FORMAT_VL (name, sizeof (name), vl);
629 ERROR ("plugin_value_list_clone: Unable to determine "
630 "interval from context for "
631 "value list \"%s\". "
632 "This indicates a broken plugin. "
633 "Please report this problem to the "
634 "collectd mailing list or at "
635 "<http://collectd.org/bugs/>.", name);
636 vl->interval = cf_get_default_interval ();
637 }
638 }
640 return (vl);
641 } /* }}} value_list_t *plugin_value_list_clone */
643 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
644 {
645 write_queue_t *q;
647 q = malloc (sizeof (*q));
648 if (q == NULL)
649 return (ENOMEM);
650 q->next = NULL;
652 q->vl = plugin_value_list_clone (vl);
653 if (q->vl == NULL)
654 {
655 sfree (q);
656 return (ENOMEM);
657 }
659 /* Store context of caller (read plugin); otherwise, it would not be
660 * available to the write plugins when actually dispatching the
661 * value-list later on. */
662 q->ctx = plugin_get_ctx ();
664 pthread_mutex_lock (&write_lock);
666 if (write_queue_tail == NULL)
667 {
668 write_queue_head = q;
669 write_queue_tail = q;
670 }
671 else
672 {
673 write_queue_tail->next = q;
674 write_queue_tail = q;
675 }
677 pthread_cond_signal (&write_cond);
678 pthread_mutex_unlock (&write_lock);
680 return (0);
681 } /* }}} int plugin_write_enqueue */
683 static value_list_t *plugin_write_dequeue (void) /* {{{ */
684 {
685 write_queue_t *q;
686 value_list_t *vl;
688 pthread_mutex_lock (&write_lock);
690 while (write_loop && (write_queue_head == NULL))
691 pthread_cond_wait (&write_cond, &write_lock);
693 if (write_queue_head == NULL)
694 {
695 pthread_mutex_unlock (&write_lock);
696 return (NULL);
697 }
699 q = write_queue_head;
700 write_queue_head = q->next;
701 if (write_queue_head == NULL)
702 write_queue_tail = NULL;
704 pthread_mutex_unlock (&write_lock);
706 (void) plugin_set_ctx (q->ctx);
708 vl = q->vl;
709 sfree (q);
710 return (vl);
711 } /* }}} value_list_t *plugin_write_dequeue */
713 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
714 {
715 while (write_loop)
716 {
717 value_list_t *vl = plugin_write_dequeue ();
718 if (vl == NULL)
719 continue;
721 plugin_dispatch_values_internal (vl);
723 plugin_value_list_free (vl);
724 }
726 pthread_exit (NULL);
727 return ((void *) 0);
728 } /* }}} void *plugin_write_thread */
730 static void start_write_threads (size_t num) /* {{{ */
731 {
732 size_t i;
734 if (write_threads != NULL)
735 return;
737 write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
738 if (write_threads == NULL)
739 {
740 ERROR ("plugin: start_write_threads: calloc failed.");
741 return;
742 }
744 write_threads_num = 0;
745 for (i = 0; i < num; i++)
746 {
747 int status;
749 status = pthread_create (write_threads + write_threads_num,
750 /* attr = */ NULL,
751 plugin_write_thread,
752 /* arg = */ NULL);
753 if (status != 0)
754 {
755 char errbuf[1024];
756 ERROR ("plugin: start_write_threads: pthread_create failed "
757 "with status %i (%s).", status,
758 sstrerror (status, errbuf, sizeof (errbuf)));
759 return;
760 }
762 write_threads_num++;
763 } /* for (i) */
764 } /* }}} void start_write_threads */
766 static void stop_write_threads (void) /* {{{ */
767 {
768 write_queue_t *q;
769 int i;
771 if (write_threads == NULL)
772 return;
774 INFO ("collectd: Stopping %zu write threads.", write_threads_num);
776 pthread_mutex_lock (&write_lock);
777 write_loop = 0;
778 DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
779 pthread_cond_broadcast (&write_cond);
780 pthread_mutex_unlock (&write_lock);
782 for (i = 0; i < write_threads_num; i++)
783 {
784 if (pthread_join (write_threads[i], NULL) != 0)
785 {
786 ERROR ("plugin: stop_write_threads: pthread_join failed.");
787 }
788 write_threads[i] = (pthread_t) 0;
789 }
790 sfree (write_threads);
791 write_threads_num = 0;
793 pthread_mutex_lock (&write_lock);
794 i = 0;
795 for (q = write_queue_head; q != NULL; )
796 {
797 write_queue_t *q1 = q;
798 plugin_value_list_free (q->vl);
799 q = q->next;
800 sfree (q1);
801 i++;
802 }
803 write_queue_head = NULL;
804 write_queue_tail = NULL;
805 pthread_mutex_unlock (&write_lock);
807 if (i > 0)
808 {
809 WARNING ("plugin: %i value list%s left after shutting down "
810 "the write threads.",
811 i, (i == 1) ? " was" : "s were");
812 }
813 } /* }}} void stop_write_threads */
815 /*
816 * Public functions
817 */
818 void plugin_set_dir (const char *dir)
819 {
820 if (plugindir != NULL)
821 free (plugindir);
823 if (dir == NULL)
824 plugindir = NULL;
825 else if ((plugindir = strdup (dir)) == NULL)
826 {
827 char errbuf[1024];
828 ERROR ("strdup failed: %s",
829 sstrerror (errno, errbuf, sizeof (errbuf)));
830 }
831 }
833 #define BUFSIZE 512
834 int plugin_load (const char *type, uint32_t flags)
835 {
836 DIR *dh;
837 const char *dir;
838 char filename[BUFSIZE] = "";
839 char typename[BUFSIZE];
840 int typename_len;
841 int ret;
842 struct stat statbuf;
843 struct dirent *de;
844 int status;
846 dir = plugin_get_dir ();
847 ret = 1;
849 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
850 * type when matching the filename */
851 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
852 if ((status < 0) || ((size_t) status >= sizeof (typename)))
853 {
854 WARNING ("plugin_load: Filename too long: \"%s.so\"", type);
855 return (-1);
856 }
857 typename_len = strlen (typename);
859 if ((dh = opendir (dir)) == NULL)
860 {
861 char errbuf[1024];
862 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
863 sstrerror (errno, errbuf, sizeof (errbuf)));
864 return (-1);
865 }
867 while ((de = readdir (dh)) != NULL)
868 {
869 if (strncasecmp (de->d_name, typename, typename_len))
870 continue;
872 status = ssnprintf (filename, sizeof (filename),
873 "%s/%s", dir, de->d_name);
874 if ((status < 0) || ((size_t) status >= sizeof (filename)))
875 {
876 WARNING ("plugin_load: Filename too long: \"%s/%s\"",
877 dir, de->d_name);
878 continue;
879 }
881 if (lstat (filename, &statbuf) == -1)
882 {
883 char errbuf[1024];
884 WARNING ("plugin_load: stat (\"%s\") failed: %s",
885 filename,
886 sstrerror (errno, errbuf, sizeof (errbuf)));
887 continue;
888 }
889 else if (!S_ISREG (statbuf.st_mode))
890 {
891 /* don't follow symlinks */
892 WARNING ("plugin_load: %s is not a regular file.",
893 filename);
894 continue;
895 }
897 status = plugin_load_file (filename, flags);
898 if (status == 0)
899 {
900 /* success */
901 ret = 0;
902 break;
903 }
904 else
905 {
906 ERROR ("plugin_load: Load plugin \"%s\" failed with "
907 "status %i.", type, status);
908 }
909 }
911 closedir (dh);
913 if (filename[0] == 0)
914 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
915 type, dir);
917 return (ret);
918 }
920 /*
921 * The `register_*' functions follow
922 */
923 int plugin_register_config (const char *name,
924 int (*callback) (const char *key, const char *val),
925 const char **keys, int keys_num)
926 {
927 cf_register (name, callback, keys, keys_num);
928 return (0);
929 } /* int plugin_register_config */
931 int plugin_register_complex_config (const char *type,
932 int (*callback) (oconfig_item_t *))
933 {
934 return (cf_register_complex (type, callback));
935 } /* int plugin_register_complex_config */
937 int plugin_register_init (const char *name,
938 int (*callback) (void))
939 {
940 return (create_register_callback (&list_init, name, (void *) callback,
941 /* user_data = */ NULL));
942 } /* plugin_register_init */
944 static int plugin_compare_read_func (const void *arg0, const void *arg1)
945 {
946 const read_func_t *rf0;
947 const read_func_t *rf1;
949 rf0 = arg0;
950 rf1 = arg1;
952 if (rf0->rf_next_read < rf1->rf_next_read)
953 return (-1);
954 else if (rf0->rf_next_read > rf1->rf_next_read)
955 return (1);
956 else
957 return (0);
958 } /* int plugin_compare_read_func */
960 /* Add a read function to both, the heap and a linked list. The linked list if
961 * used to look-up read functions, especially for the remove function. The heap
962 * is used to determine which plugin to read next. */
963 static int plugin_insert_read (read_func_t *rf)
964 {
965 int status;
966 llentry_t *le;
968 rf->rf_next_read = cdtime ();
969 rf->rf_effective_interval = rf->rf_interval;
971 pthread_mutex_lock (&read_lock);
973 if (read_list == NULL)
974 {
975 read_list = llist_create ();
976 if (read_list == NULL)
977 {
978 pthread_mutex_unlock (&read_lock);
979 ERROR ("plugin_insert_read: read_list failed.");
980 return (-1);
981 }
982 }
984 if (read_heap == NULL)
985 {
986 read_heap = c_heap_create (plugin_compare_read_func);
987 if (read_heap == NULL)
988 {
989 pthread_mutex_unlock (&read_lock);
990 ERROR ("plugin_insert_read: c_heap_create failed.");
991 return (-1);
992 }
993 }
995 le = llist_search (read_list, rf->rf_name);
996 if (le != NULL)
997 {
998 pthread_mutex_unlock (&read_lock);
999 WARNING ("The read function \"%s\" is already registered. "
1000 "Check for duplicate \"LoadPlugin\" lines "
1001 "in your configuration!",
1002 rf->rf_name);
1003 return (EINVAL);
1004 }
1006 le = llentry_create (rf->rf_name, rf);
1007 if (le == NULL)
1008 {
1009 pthread_mutex_unlock (&read_lock);
1010 ERROR ("plugin_insert_read: llentry_create failed.");
1011 return (-1);
1012 }
1014 status = c_heap_insert (read_heap, rf);
1015 if (status != 0)
1016 {
1017 pthread_mutex_unlock (&read_lock);
1018 ERROR ("plugin_insert_read: c_heap_insert failed.");
1019 llentry_destroy (le);
1020 return (-1);
1021 }
1023 /* This does not fail. */
1024 llist_append (read_list, le);
1026 /* Wake up all the read threads. */
1027 pthread_cond_broadcast (&read_cond);
1028 pthread_mutex_unlock (&read_lock);
1029 return (0);
1030 } /* int plugin_insert_read */
1032 int plugin_register_read (const char *name,
1033 int (*callback) (void))
1034 {
1035 read_func_t *rf;
1036 int status;
1038 rf = malloc (sizeof (*rf));
1039 if (rf == NULL)
1040 {
1041 ERROR ("plugin_register_read: malloc failed.");
1042 return (ENOMEM);
1043 }
1045 memset (rf, 0, sizeof (read_func_t));
1046 rf->rf_callback = (void *) callback;
1047 rf->rf_udata.data = NULL;
1048 rf->rf_udata.free_func = NULL;
1049 rf->rf_ctx = plugin_get_ctx ();
1050 rf->rf_group[0] = '\0';
1051 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
1052 rf->rf_type = RF_SIMPLE;
1053 rf->rf_interval = plugin_get_interval ();
1055 status = plugin_insert_read (rf);
1056 if (status != 0)
1057 sfree (rf);
1059 return (status);
1060 } /* int plugin_register_read */
1062 int plugin_register_complex_read (const char *group, const char *name,
1063 plugin_read_cb callback,
1064 const struct timespec *interval,
1065 user_data_t *user_data)
1066 {
1067 read_func_t *rf;
1068 int status;
1070 rf = malloc (sizeof (*rf));
1071 if (rf == NULL)
1072 {
1073 ERROR ("plugin_register_complex_read: malloc failed.");
1074 return (ENOMEM);
1075 }
1077 memset (rf, 0, sizeof (read_func_t));
1078 rf->rf_callback = (void *) callback;
1079 if (group != NULL)
1080 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1081 else
1082 rf->rf_group[0] = '\0';
1083 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
1084 rf->rf_type = RF_COMPLEX;
1085 if (interval != NULL)
1086 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1087 else
1088 rf->rf_interval = plugin_get_interval ();
1090 /* Set user data */
1091 if (user_data == NULL)
1092 {
1093 rf->rf_udata.data = NULL;
1094 rf->rf_udata.free_func = NULL;
1095 }
1096 else
1097 {
1098 rf->rf_udata = *user_data;
1099 }
1101 rf->rf_ctx = plugin_get_ctx ();
1103 status = plugin_insert_read (rf);
1104 if (status != 0)
1105 sfree (rf);
1107 return (status);
1108 } /* int plugin_register_complex_read */
1110 int plugin_register_write (const char *name,
1111 plugin_write_cb callback, user_data_t *ud)
1112 {
1113 return (create_register_callback (&list_write, name,
1114 (void *) callback, ud));
1115 } /* int plugin_register_write */
1117 int plugin_register_flush (const char *name,
1118 plugin_flush_cb callback, user_data_t *ud)
1119 {
1120 return (create_register_callback (&list_flush, name,
1121 (void *) callback, ud));
1122 } /* int plugin_register_flush */
1124 int plugin_register_missing (const char *name,
1125 plugin_missing_cb callback, user_data_t *ud)
1126 {
1127 return (create_register_callback (&list_missing, name,
1128 (void *) callback, ud));
1129 } /* int plugin_register_missing */
1131 int plugin_register_shutdown (const char *name,
1132 int (*callback) (void))
1133 {
1134 return (create_register_callback (&list_shutdown, name,
1135 (void *) callback, /* user_data = */ NULL));
1136 } /* int plugin_register_shutdown */
1138 static void plugin_free_data_sets (void)
1139 {
1140 void *key;
1141 void *value;
1143 if (data_sets == NULL)
1144 return;
1146 while (c_avl_pick (data_sets, &key, &value) == 0)
1147 {
1148 data_set_t *ds = value;
1149 /* key is a pointer to ds->type */
1151 sfree (ds->ds);
1152 sfree (ds);
1153 }
1155 c_avl_destroy (data_sets);
1156 data_sets = NULL;
1157 } /* void plugin_free_data_sets */
1159 int plugin_register_data_set (const data_set_t *ds)
1160 {
1161 data_set_t *ds_copy;
1162 int i;
1164 if ((data_sets != NULL)
1165 && (c_avl_get (data_sets, ds->type, NULL) == 0))
1166 {
1167 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1168 plugin_unregister_data_set (ds->type);
1169 }
1170 else if (data_sets == NULL)
1171 {
1172 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1173 if (data_sets == NULL)
1174 return (-1);
1175 }
1177 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1178 if (ds_copy == NULL)
1179 return (-1);
1180 memcpy(ds_copy, ds, sizeof (data_set_t));
1182 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1183 * ds->ds_num);
1184 if (ds_copy->ds == NULL)
1185 {
1186 free (ds_copy);
1187 return (-1);
1188 }
1190 for (i = 0; i < ds->ds_num; i++)
1191 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1193 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1194 } /* int plugin_register_data_set */
1196 int plugin_register_log (const char *name,
1197 plugin_log_cb callback, user_data_t *ud)
1198 {
1199 return (create_register_callback (&list_log, name,
1200 (void *) callback, ud));
1201 } /* int plugin_register_log */
1203 int plugin_register_notification (const char *name,
1204 plugin_notification_cb callback, user_data_t *ud)
1205 {
1206 return (create_register_callback (&list_notification, name,
1207 (void *) callback, ud));
1208 } /* int plugin_register_log */
1210 int plugin_unregister_config (const char *name)
1211 {
1212 cf_unregister (name);
1213 return (0);
1214 } /* int plugin_unregister_config */
1216 int plugin_unregister_complex_config (const char *name)
1217 {
1218 cf_unregister_complex (name);
1219 return (0);
1220 } /* int plugin_unregister_complex_config */
1222 int plugin_unregister_init (const char *name)
1223 {
1224 return (plugin_unregister (list_init, name));
1225 }
1227 int plugin_unregister_read (const char *name) /* {{{ */
1228 {
1229 llentry_t *le;
1230 read_func_t *rf;
1232 if (name == NULL)
1233 return (-ENOENT);
1235 pthread_mutex_lock (&read_lock);
1237 if (read_list == NULL)
1238 {
1239 pthread_mutex_unlock (&read_lock);
1240 return (-ENOENT);
1241 }
1243 le = llist_search (read_list, name);
1244 if (le == NULL)
1245 {
1246 pthread_mutex_unlock (&read_lock);
1247 WARNING ("plugin_unregister_read: No such read function: %s",
1248 name);
1249 return (-ENOENT);
1250 }
1252 llist_remove (read_list, le);
1254 rf = le->value;
1255 assert (rf != NULL);
1256 rf->rf_type = RF_REMOVE;
1258 pthread_mutex_unlock (&read_lock);
1260 llentry_destroy (le);
1262 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1264 return (0);
1265 } /* }}} int plugin_unregister_read */
1267 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1268 {
1269 read_func_t *rf = e->value;
1270 char *group = ud;
1272 return strcmp (rf->rf_group, (const char *)group);
1273 } /* }}} int compare_read_func_group */
1275 int plugin_unregister_read_group (const char *group) /* {{{ */
1276 {
1277 llentry_t *le;
1278 read_func_t *rf;
1280 int found = 0;
1282 if (group == 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 while (42)
1294 {
1295 le = llist_search_custom (read_list,
1296 compare_read_func_group, (void *)group);
1298 if (le == NULL)
1299 break;
1301 ++found;
1303 llist_remove (read_list, le);
1305 rf = le->value;
1306 assert (rf != NULL);
1307 rf->rf_type = RF_REMOVE;
1309 llentry_destroy (le);
1311 DEBUG ("plugin_unregister_read_group: "
1312 "Marked `%s' (group `%s') for removal.",
1313 rf->rf_name, group);
1314 }
1316 pthread_mutex_unlock (&read_lock);
1318 if (found == 0)
1319 {
1320 WARNING ("plugin_unregister_read_group: No such "
1321 "group of read function: %s", group);
1322 return (-ENOENT);
1323 }
1325 return (0);
1326 } /* }}} int plugin_unregister_read_group */
1328 int plugin_unregister_write (const char *name)
1329 {
1330 return (plugin_unregister (list_write, name));
1331 }
1333 int plugin_unregister_flush (const char *name)
1334 {
1335 return (plugin_unregister (list_flush, name));
1336 }
1338 int plugin_unregister_missing (const char *name)
1339 {
1340 return (plugin_unregister (list_missing, name));
1341 }
1343 int plugin_unregister_shutdown (const char *name)
1344 {
1345 return (plugin_unregister (list_shutdown, name));
1346 }
1348 int plugin_unregister_data_set (const char *name)
1349 {
1350 data_set_t *ds;
1352 if (data_sets == NULL)
1353 return (-1);
1355 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1356 return (-1);
1358 sfree (ds->ds);
1359 sfree (ds);
1361 return (0);
1362 } /* int plugin_unregister_data_set */
1364 int plugin_unregister_log (const char *name)
1365 {
1366 return (plugin_unregister (list_log, name));
1367 }
1369 int plugin_unregister_notification (const char *name)
1370 {
1371 return (plugin_unregister (list_notification, name));
1372 }
1374 void plugin_init_all (void)
1375 {
1376 const char *chain_name;
1377 llentry_t *le;
1378 int status;
1380 /* Init the value cache */
1381 uc_init ();
1383 chain_name = global_option_get ("PreCacheChain");
1384 pre_cache_chain = fc_chain_get_by_name (chain_name);
1386 chain_name = global_option_get ("PostCacheChain");
1387 post_cache_chain = fc_chain_get_by_name (chain_name);
1389 {
1390 char const *tmp = global_option_get ("WriteThreads");
1391 int num = atoi (tmp);
1393 if (num < 1)
1394 num = 5;
1396 start_write_threads ((size_t) num);
1397 }
1399 if ((list_init == NULL) && (read_heap == NULL))
1400 return;
1402 /* Calling all init callbacks before checking if read callbacks
1403 * are available allows the init callbacks to register the read
1404 * callback. */
1405 le = llist_head (list_init);
1406 while (le != NULL)
1407 {
1408 callback_func_t *cf;
1409 plugin_init_cb callback;
1410 plugin_ctx_t old_ctx;
1412 cf = le->value;
1413 old_ctx = plugin_set_ctx (cf->cf_ctx);
1414 callback = cf->cf_callback;
1415 status = (*callback) ();
1416 plugin_set_ctx (old_ctx);
1418 if (status != 0)
1419 {
1420 ERROR ("Initialization of plugin `%s' "
1421 "failed with status %i. "
1422 "Plugin will be unloaded.",
1423 le->key, status);
1424 /* Plugins that register read callbacks from the init
1425 * callback should take care of appropriate error
1426 * handling themselves. */
1427 /* FIXME: Unload _all_ functions */
1428 plugin_unregister_read (le->key);
1429 }
1431 le = le->next;
1432 }
1434 /* Start read-threads */
1435 if (read_heap != NULL)
1436 {
1437 const char *rt;
1438 int num;
1439 rt = global_option_get ("ReadThreads");
1440 num = atoi (rt);
1441 if (num != -1)
1442 start_read_threads ((num > 0) ? num : 5);
1443 }
1444 } /* void plugin_init_all */
1446 /* TODO: Rename this function. */
1447 void plugin_read_all (void)
1448 {
1449 uc_check_timeout ();
1451 return;
1452 } /* void plugin_read_all */
1454 /* Read function called when the `-T' command line argument is given. */
1455 int plugin_read_all_once (void)
1456 {
1457 int status;
1458 int return_status = 0;
1460 if (read_heap == NULL)
1461 {
1462 NOTICE ("No read-functions are registered.");
1463 return (0);
1464 }
1466 while (42)
1467 {
1468 read_func_t *rf;
1469 plugin_ctx_t old_ctx;
1471 rf = c_heap_get_root (read_heap);
1472 if (rf == NULL)
1473 break;
1475 old_ctx = plugin_set_ctx (rf->rf_ctx);
1477 if (rf->rf_type == RF_SIMPLE)
1478 {
1479 int (*callback) (void);
1481 callback = rf->rf_callback;
1482 status = (*callback) ();
1483 }
1484 else
1485 {
1486 plugin_read_cb callback;
1488 callback = rf->rf_callback;
1489 status = (*callback) (&rf->rf_udata);
1490 }
1492 plugin_set_ctx (old_ctx);
1494 if (status != 0)
1495 {
1496 NOTICE ("read-function of plugin `%s' failed.",
1497 rf->rf_name);
1498 return_status = -1;
1499 }
1501 destroy_callback ((void *) rf);
1502 }
1504 return (return_status);
1505 } /* int plugin_read_all_once */
1507 int plugin_write (const char *plugin, /* {{{ */
1508 const data_set_t *ds, const value_list_t *vl)
1509 {
1510 llentry_t *le;
1511 int status;
1513 if (vl == NULL)
1514 return (EINVAL);
1516 if (list_write == NULL)
1517 return (ENOENT);
1519 if (ds == NULL)
1520 {
1521 ds = plugin_get_ds (vl->type);
1522 if (ds == NULL)
1523 {
1524 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1525 return (ENOENT);
1526 }
1527 }
1529 if (plugin == NULL)
1530 {
1531 int success = 0;
1532 int failure = 0;
1534 le = llist_head (list_write);
1535 while (le != NULL)
1536 {
1537 callback_func_t *cf = le->value;
1538 plugin_write_cb callback;
1540 /* do not switch plugin context; rather keep the context (interval)
1541 * information of the calling read plugin */
1543 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1544 callback = cf->cf_callback;
1545 status = (*callback) (ds, vl, &cf->cf_udata);
1546 if (status != 0)
1547 failure++;
1548 else
1549 success++;
1551 le = le->next;
1552 }
1554 if ((success == 0) && (failure != 0))
1555 status = -1;
1556 else
1557 status = 0;
1558 }
1559 else /* plugin != NULL */
1560 {
1561 callback_func_t *cf;
1562 plugin_write_cb callback;
1564 le = llist_head (list_write);
1565 while (le != NULL)
1566 {
1567 if (strcasecmp (plugin, le->key) == 0)
1568 break;
1570 le = le->next;
1571 }
1573 if (le == NULL)
1574 return (ENOENT);
1576 cf = le->value;
1578 /* do not switch plugin context; rather keep the context (interval)
1579 * information of the calling read plugin */
1581 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1582 callback = cf->cf_callback;
1583 status = (*callback) (ds, vl, &cf->cf_udata);
1584 }
1586 return (status);
1587 } /* }}} int plugin_write */
1589 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1590 {
1591 llentry_t *le;
1593 if (list_flush == NULL)
1594 return (0);
1596 le = llist_head (list_flush);
1597 while (le != NULL)
1598 {
1599 callback_func_t *cf;
1600 plugin_flush_cb callback;
1601 plugin_ctx_t old_ctx;
1603 if ((plugin != NULL)
1604 && (strcmp (plugin, le->key) != 0))
1605 {
1606 le = le->next;
1607 continue;
1608 }
1610 cf = le->value;
1611 old_ctx = plugin_set_ctx (cf->cf_ctx);
1612 callback = cf->cf_callback;
1614 (*callback) (timeout, identifier, &cf->cf_udata);
1616 plugin_set_ctx (old_ctx);
1618 le = le->next;
1619 }
1620 return (0);
1621 } /* int plugin_flush */
1623 void plugin_shutdown_all (void)
1624 {
1625 llentry_t *le;
1627 stop_read_threads ();
1629 destroy_all_callbacks (&list_init);
1631 pthread_mutex_lock (&read_lock);
1632 llist_destroy (read_list);
1633 read_list = NULL;
1634 pthread_mutex_unlock (&read_lock);
1636 destroy_read_heap ();
1638 plugin_flush (/* plugin = */ NULL,
1639 /* timeout = */ 0,
1640 /* identifier = */ NULL);
1642 le = NULL;
1643 if (list_shutdown != NULL)
1644 le = llist_head (list_shutdown);
1646 while (le != NULL)
1647 {
1648 callback_func_t *cf;
1649 plugin_shutdown_cb callback;
1650 plugin_ctx_t old_ctx;
1652 cf = le->value;
1653 old_ctx = plugin_set_ctx (cf->cf_ctx);
1654 callback = cf->cf_callback;
1656 /* Advance the pointer before calling the callback allows
1657 * shutdown functions to unregister themselves. If done the
1658 * other way around the memory `le' points to will be freed
1659 * after callback returns. */
1660 le = le->next;
1662 (*callback) ();
1664 plugin_set_ctx (old_ctx);
1665 }
1667 stop_write_threads ();
1669 /* Write plugins which use the `user_data' pointer usually need the
1670 * same data available to the flush callback. If this is the case, set
1671 * the free_function to NULL when registering the flush callback and to
1672 * the real free function when registering the write callback. This way
1673 * the data isn't freed twice. */
1674 destroy_all_callbacks (&list_flush);
1675 destroy_all_callbacks (&list_missing);
1676 destroy_all_callbacks (&list_write);
1678 destroy_all_callbacks (&list_notification);
1679 destroy_all_callbacks (&list_shutdown);
1680 destroy_all_callbacks (&list_log);
1682 plugin_free_data_sets ();
1683 } /* void plugin_shutdown_all */
1685 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1686 {
1687 llentry_t *le;
1689 if (list_missing == NULL)
1690 return (0);
1692 le = llist_head (list_missing);
1693 while (le != NULL)
1694 {
1695 callback_func_t *cf;
1696 plugin_missing_cb callback;
1697 plugin_ctx_t old_ctx;
1698 int status;
1700 cf = le->value;
1701 old_ctx = plugin_set_ctx (cf->cf_ctx);
1702 callback = cf->cf_callback;
1704 status = (*callback) (vl, &cf->cf_udata);
1705 plugin_set_ctx (old_ctx);
1706 if (status != 0)
1707 {
1708 if (status < 0)
1709 {
1710 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1711 "failed with status %i.",
1712 le->key, status);
1713 return (status);
1714 }
1715 else
1716 {
1717 return (0);
1718 }
1719 }
1721 le = le->next;
1722 }
1723 return (0);
1724 } /* int }}} plugin_dispatch_missing */
1726 static int plugin_dispatch_values_internal (value_list_t *vl)
1727 {
1728 int status;
1729 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1731 value_t *saved_values;
1732 int saved_values_len;
1734 data_set_t *ds;
1736 int free_meta_data = 0;
1738 if ((vl == NULL) || (vl->type[0] == 0)
1739 || (vl->values == NULL) || (vl->values_len < 1))
1740 {
1741 ERROR ("plugin_dispatch_values: Invalid value list "
1742 "from plugin %s.", vl->plugin);
1743 return (-1);
1744 }
1746 /* Free meta data only if the calling function didn't specify any. In
1747 * this case matches and targets may add some and the calling function
1748 * may not expect (and therefore free) that data. */
1749 if (vl->meta == NULL)
1750 free_meta_data = 1;
1752 if (list_write == NULL)
1753 c_complain_once (LOG_WARNING, &no_write_complaint,
1754 "plugin_dispatch_values: No write callback has been "
1755 "registered. Please load at least one output plugin, "
1756 "if you want the collected data to be stored.");
1758 if (data_sets == NULL)
1759 {
1760 ERROR ("plugin_dispatch_values: No data sets registered. "
1761 "Could the types database be read? Check "
1762 "your `TypesDB' setting!");
1763 return (-1);
1764 }
1766 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1767 {
1768 char ident[6 * DATA_MAX_NAME_LEN];
1770 FORMAT_VL (ident, sizeof (ident), vl);
1771 INFO ("plugin_dispatch_values: Dataset not found: %s "
1772 "(from \"%s\"), check your types.db!",
1773 vl->type, ident);
1774 return (-1);
1775 }
1777 /* Assured by plugin_value_list_clone(). The time is determined at
1778 * _enqueue_ time. */
1779 assert (vl->time != 0);
1780 assert (vl->interval != 0);
1782 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1783 "host = %s; "
1784 "plugin = %s; plugin_instance = %s; "
1785 "type = %s; type_instance = %s;",
1786 CDTIME_T_TO_DOUBLE (vl->time),
1787 CDTIME_T_TO_DOUBLE (vl->interval),
1788 vl->host,
1789 vl->plugin, vl->plugin_instance,
1790 vl->type, vl->type_instance);
1792 #if COLLECT_DEBUG
1793 assert (0 == strcmp (ds->type, vl->type));
1794 #else
1795 if (0 != strcmp (ds->type, vl->type))
1796 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1797 ds->type, vl->type);
1798 #endif
1800 #if COLLECT_DEBUG
1801 assert (ds->ds_num == vl->values_len);
1802 #else
1803 if (ds->ds_num != vl->values_len)
1804 {
1805 ERROR ("plugin_dispatch_values: ds->type = %s: "
1806 "(ds->ds_num = %i) != "
1807 "(vl->values_len = %i)",
1808 ds->type, ds->ds_num, vl->values_len);
1809 return (-1);
1810 }
1811 #endif
1813 escape_slashes (vl->host, sizeof (vl->host));
1814 escape_slashes (vl->plugin, sizeof (vl->plugin));
1815 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1816 escape_slashes (vl->type, sizeof (vl->type));
1817 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1819 /* Copy the values. This way, we can assure `targets' that they get
1820 * dynamically allocated values, which they can free and replace if
1821 * they like. */
1822 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1823 {
1824 saved_values = vl->values;
1825 saved_values_len = vl->values_len;
1827 vl->values = (value_t *) calloc (vl->values_len,
1828 sizeof (*vl->values));
1829 if (vl->values == NULL)
1830 {
1831 ERROR ("plugin_dispatch_values: calloc failed.");
1832 vl->values = saved_values;
1833 return (-1);
1834 }
1835 memcpy (vl->values, saved_values,
1836 vl->values_len * sizeof (*vl->values));
1837 }
1838 else /* if ((pre == NULL) && (post == NULL)) */
1839 {
1840 saved_values = NULL;
1841 saved_values_len = 0;
1842 }
1844 if (pre_cache_chain != NULL)
1845 {
1846 status = fc_process_chain (ds, vl, pre_cache_chain);
1847 if (status < 0)
1848 {
1849 WARNING ("plugin_dispatch_values: Running the "
1850 "pre-cache chain failed with "
1851 "status %i (%#x).",
1852 status, status);
1853 }
1854 else if (status == FC_TARGET_STOP)
1855 {
1856 /* Restore the state of the value_list so that plugins
1857 * don't get confused.. */
1858 if (saved_values != NULL)
1859 {
1860 free (vl->values);
1861 vl->values = saved_values;
1862 vl->values_len = saved_values_len;
1863 }
1864 return (0);
1865 }
1866 }
1868 /* Update the value cache */
1869 uc_update (ds, vl);
1871 if (post_cache_chain != NULL)
1872 {
1873 status = fc_process_chain (ds, vl, post_cache_chain);
1874 if (status < 0)
1875 {
1876 WARNING ("plugin_dispatch_values: Running the "
1877 "post-cache chain failed with "
1878 "status %i (%#x).",
1879 status, status);
1880 }
1881 }
1882 else
1883 fc_default_action (ds, vl);
1885 /* Restore the state of the value_list so that plugins don't get
1886 * confused.. */
1887 if (saved_values != NULL)
1888 {
1889 free (vl->values);
1890 vl->values = saved_values;
1891 vl->values_len = saved_values_len;
1892 }
1894 if ((free_meta_data != 0) && (vl->meta != NULL))
1895 {
1896 meta_data_destroy (vl->meta);
1897 vl->meta = NULL;
1898 }
1900 return (0);
1901 } /* int plugin_dispatch_values_internal */
1903 int plugin_dispatch_values (value_list_t const *vl)
1904 {
1905 int status;
1907 status = plugin_write_enqueue (vl);
1908 if (status != 0)
1909 {
1910 char errbuf[1024];
1911 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
1912 "with status %i (%s).", status,
1913 sstrerror (status, errbuf, sizeof (errbuf)));
1914 return (status);
1915 }
1917 return (0);
1918 }
1920 int plugin_dispatch_notification (const notification_t *notif)
1921 {
1922 llentry_t *le;
1923 /* Possible TODO: Add flap detection here */
1925 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1926 "time = %.3f; host = %s;",
1927 notif->severity, notif->message,
1928 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1930 /* Nobody cares for notifications */
1931 if (list_notification == NULL)
1932 return (-1);
1934 le = llist_head (list_notification);
1935 while (le != NULL)
1936 {
1937 callback_func_t *cf;
1938 plugin_notification_cb callback;
1939 int status;
1941 /* do not switch plugin context; rather keep the context
1942 * (interval) information of the calling plugin */
1944 cf = le->value;
1945 callback = cf->cf_callback;
1946 status = (*callback) (notif, &cf->cf_udata);
1947 if (status != 0)
1948 {
1949 WARNING ("plugin_dispatch_notification: Notification "
1950 "callback %s returned %i.",
1951 le->key, status);
1952 }
1954 le = le->next;
1955 }
1957 return (0);
1958 } /* int plugin_dispatch_notification */
1960 void plugin_log (int level, const char *format, ...)
1961 {
1962 char msg[1024];
1963 va_list ap;
1964 llentry_t *le;
1966 #if !COLLECT_DEBUG
1967 if (level >= LOG_DEBUG)
1968 return;
1969 #endif
1971 va_start (ap, format);
1972 vsnprintf (msg, sizeof (msg), format, ap);
1973 msg[sizeof (msg) - 1] = '\0';
1974 va_end (ap);
1976 if (list_log == NULL)
1977 {
1978 fprintf (stderr, "%s\n", msg);
1979 return;
1980 }
1982 le = llist_head (list_log);
1983 while (le != NULL)
1984 {
1985 callback_func_t *cf;
1986 plugin_log_cb callback;
1988 cf = le->value;
1989 callback = cf->cf_callback;
1991 /* do not switch plugin context; rather keep the context
1992 * (interval) information of the calling plugin */
1994 (*callback) (level, msg, &cf->cf_udata);
1996 le = le->next;
1997 }
1998 } /* void plugin_log */
2000 int parse_log_severity (const char *severity)
2001 {
2002 int log_level = -1;
2004 if ((0 == strcasecmp (severity, "emerg"))
2005 || (0 == strcasecmp (severity, "alert"))
2006 || (0 == strcasecmp (severity, "crit"))
2007 || (0 == strcasecmp (severity, "err")))
2008 log_level = LOG_ERR;
2009 else if (0 == strcasecmp (severity, "warning"))
2010 log_level = LOG_WARNING;
2011 else if (0 == strcasecmp (severity, "notice"))
2012 log_level = LOG_NOTICE;
2013 else if (0 == strcasecmp (severity, "info"))
2014 log_level = LOG_INFO;
2015 #if COLLECT_DEBUG
2016 else if (0 == strcasecmp (severity, "debug"))
2017 log_level = LOG_DEBUG;
2018 #endif /* COLLECT_DEBUG */
2020 return (log_level);
2021 } /* int parse_log_severity */
2023 int parse_notif_severity (const char *severity)
2024 {
2025 int notif_severity = -1;
2027 if (strcasecmp (severity, "FAILURE") == 0)
2028 notif_severity = NOTIF_FAILURE;
2029 else if (strcmp (severity, "OKAY") == 0)
2030 notif_severity = NOTIF_OKAY;
2031 else if ((strcmp (severity, "WARNING") == 0)
2032 || (strcmp (severity, "WARN") == 0))
2033 notif_severity = NOTIF_WARNING;
2035 return (notif_severity);
2036 } /* int parse_notif_severity */
2038 const data_set_t *plugin_get_ds (const char *name)
2039 {
2040 data_set_t *ds;
2042 if (data_sets == NULL)
2043 {
2044 ERROR ("plugin_get_ds: No data sets are defined yet.");
2045 return (NULL);
2046 }
2048 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2049 {
2050 DEBUG ("No such dataset registered: %s", name);
2051 return (NULL);
2052 }
2054 return (ds);
2055 } /* data_set_t *plugin_get_ds */
2057 static int plugin_notification_meta_add (notification_t *n,
2058 const char *name,
2059 enum notification_meta_type_e type,
2060 const void *value)
2061 {
2062 notification_meta_t *meta;
2063 notification_meta_t *tail;
2065 if ((n == NULL) || (name == NULL) || (value == NULL))
2066 {
2067 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2068 return (-1);
2069 }
2071 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2072 if (meta == NULL)
2073 {
2074 ERROR ("plugin_notification_meta_add: malloc failed.");
2075 return (-1);
2076 }
2077 memset (meta, 0, sizeof (notification_meta_t));
2079 sstrncpy (meta->name, name, sizeof (meta->name));
2080 meta->type = type;
2082 switch (type)
2083 {
2084 case NM_TYPE_STRING:
2085 {
2086 meta->nm_value.nm_string = strdup ((const char *) value);
2087 if (meta->nm_value.nm_string == NULL)
2088 {
2089 ERROR ("plugin_notification_meta_add: strdup failed.");
2090 sfree (meta);
2091 return (-1);
2092 }
2093 break;
2094 }
2095 case NM_TYPE_SIGNED_INT:
2096 {
2097 meta->nm_value.nm_signed_int = *((int64_t *) value);
2098 break;
2099 }
2100 case NM_TYPE_UNSIGNED_INT:
2101 {
2102 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2103 break;
2104 }
2105 case NM_TYPE_DOUBLE:
2106 {
2107 meta->nm_value.nm_double = *((double *) value);
2108 break;
2109 }
2110 case NM_TYPE_BOOLEAN:
2111 {
2112 meta->nm_value.nm_boolean = *((_Bool *) value);
2113 break;
2114 }
2115 default:
2116 {
2117 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2118 sfree (meta);
2119 return (-1);
2120 }
2121 } /* switch (type) */
2123 meta->next = NULL;
2124 tail = n->meta;
2125 while ((tail != NULL) && (tail->next != NULL))
2126 tail = tail->next;
2128 if (tail == NULL)
2129 n->meta = meta;
2130 else
2131 tail->next = meta;
2133 return (0);
2134 } /* int plugin_notification_meta_add */
2136 int plugin_notification_meta_add_string (notification_t *n,
2137 const char *name,
2138 const char *value)
2139 {
2140 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2141 }
2143 int plugin_notification_meta_add_signed_int (notification_t *n,
2144 const char *name,
2145 int64_t value)
2146 {
2147 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2148 }
2150 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2151 const char *name,
2152 uint64_t value)
2153 {
2154 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2155 }
2157 int plugin_notification_meta_add_double (notification_t *n,
2158 const char *name,
2159 double value)
2160 {
2161 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2162 }
2164 int plugin_notification_meta_add_boolean (notification_t *n,
2165 const char *name,
2166 _Bool value)
2167 {
2168 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2169 }
2171 int plugin_notification_meta_copy (notification_t *dst,
2172 const notification_t *src)
2173 {
2174 notification_meta_t *meta;
2176 assert (dst != NULL);
2177 assert (src != NULL);
2178 assert (dst != src);
2179 assert ((src->meta == NULL) || (src->meta != dst->meta));
2181 for (meta = src->meta; meta != NULL; meta = meta->next)
2182 {
2183 if (meta->type == NM_TYPE_STRING)
2184 plugin_notification_meta_add_string (dst, meta->name,
2185 meta->nm_value.nm_string);
2186 else if (meta->type == NM_TYPE_SIGNED_INT)
2187 plugin_notification_meta_add_signed_int (dst, meta->name,
2188 meta->nm_value.nm_signed_int);
2189 else if (meta->type == NM_TYPE_UNSIGNED_INT)
2190 plugin_notification_meta_add_unsigned_int (dst, meta->name,
2191 meta->nm_value.nm_unsigned_int);
2192 else if (meta->type == NM_TYPE_DOUBLE)
2193 plugin_notification_meta_add_double (dst, meta->name,
2194 meta->nm_value.nm_double);
2195 else if (meta->type == NM_TYPE_BOOLEAN)
2196 plugin_notification_meta_add_boolean (dst, meta->name,
2197 meta->nm_value.nm_boolean);
2198 }
2200 return (0);
2201 } /* int plugin_notification_meta_copy */
2203 int plugin_notification_meta_free (notification_meta_t *n)
2204 {
2205 notification_meta_t *this;
2206 notification_meta_t *next;
2208 if (n == NULL)
2209 {
2210 ERROR ("plugin_notification_meta_free: n == NULL!");
2211 return (-1);
2212 }
2214 this = n;
2215 while (this != NULL)
2216 {
2217 next = this->next;
2219 if (this->type == NM_TYPE_STRING)
2220 {
2221 free ((char *)this->nm_value.nm_string);
2222 this->nm_value.nm_string = NULL;
2223 }
2224 sfree (this);
2226 this = next;
2227 }
2229 return (0);
2230 } /* int plugin_notification_meta_free */
2232 static void plugin_ctx_destructor (void *ctx)
2233 {
2234 sfree (ctx);
2235 } /* void plugin_ctx_destructor */
2237 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2239 static plugin_ctx_t *plugin_ctx_create (void)
2240 {
2241 plugin_ctx_t *ctx;
2243 ctx = malloc (sizeof (*ctx));
2244 if (ctx == NULL) {
2245 char errbuf[1024];
2246 ERROR ("Failed to allocate plugin context: %s",
2247 sstrerror (errno, errbuf, sizeof (errbuf)));
2248 return NULL;
2249 }
2251 *ctx = ctx_init;
2252 assert (plugin_ctx_key_initialized);
2253 pthread_setspecific (plugin_ctx_key, ctx);
2254 DEBUG("Created new plugin context.");
2255 return (ctx);
2256 } /* int plugin_ctx_create */
2258 void plugin_init_ctx (void)
2259 {
2260 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2261 plugin_ctx_key_initialized = 1;
2262 } /* void plugin_init_ctx */
2264 plugin_ctx_t plugin_get_ctx (void)
2265 {
2266 plugin_ctx_t *ctx;
2268 assert (plugin_ctx_key_initialized);
2269 ctx = pthread_getspecific (plugin_ctx_key);
2271 if (ctx == NULL) {
2272 ctx = plugin_ctx_create ();
2273 /* this must no happen -- exit() instead? */
2274 if (ctx == NULL)
2275 return ctx_init;
2276 }
2278 return (*ctx);
2279 } /* plugin_ctx_t plugin_get_ctx */
2281 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2282 {
2283 plugin_ctx_t *c;
2284 plugin_ctx_t old;
2286 assert (plugin_ctx_key_initialized);
2287 c = pthread_getspecific (plugin_ctx_key);
2289 if (c == NULL) {
2290 c = plugin_ctx_create ();
2291 /* this must no happen -- exit() instead? */
2292 if (c == NULL)
2293 return ctx_init;
2294 }
2296 old = *c;
2297 *c = ctx;
2299 return (old);
2300 } /* void plugin_set_ctx */
2302 cdtime_t plugin_get_interval (void)
2303 {
2304 cdtime_t interval;
2306 interval = plugin_get_ctx().interval;
2307 if (interval > 0)
2308 return interval;
2310 return cf_get_default_interval ();
2311 } /* cdtime_t plugin_get_interval */
2313 typedef struct {
2314 plugin_ctx_t ctx;
2315 void *(*start_routine) (void *);
2316 void *arg;
2317 } plugin_thread_t;
2319 static void *plugin_thread_start (void *arg)
2320 {
2321 plugin_thread_t *plugin_thread = arg;
2323 void *(*start_routine) (void *) = plugin_thread->start_routine;
2324 void *plugin_arg = plugin_thread->arg;
2326 plugin_set_ctx (plugin_thread->ctx);
2328 free (plugin_thread);
2330 return start_routine (plugin_arg);
2331 } /* void *plugin_thread_start */
2333 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2334 void *(*start_routine) (void *), void *arg)
2335 {
2336 plugin_thread_t *plugin_thread;
2338 plugin_thread = malloc (sizeof (*plugin_thread));
2339 if (plugin_thread == NULL)
2340 return -1;
2342 plugin_thread->ctx = plugin_get_ctx ();
2343 plugin_thread->start_routine = start_routine;
2344 plugin_thread->arg = arg;
2346 return pthread_create (thread, attr,
2347 plugin_thread_start, plugin_thread);
2348 } /* int plugin_thread_create */
2350 /* vim: set sw=8 ts=8 noet fdm=marker : */