![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
1 /**
2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2011 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 "utils_complain.h"
26 #include <ltdl.h>
28 #if HAVE_PTHREAD_H
29 # include <pthread.h>
30 #endif
32 #include "common.h"
33 #include "plugin.h"
34 #include "configfile.h"
35 #include "utils_avltree.h"
36 #include "utils_llist.h"
37 #include "utils_heap.h"
38 #include "utils_cache.h"
39 #include "filter_chain.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 struct timespec rf_interval;
67 struct timespec rf_effective_interval;
68 struct timespec rf_next_read;
69 };
70 typedef struct read_func_s read_func_t;
72 /*
73 * Private variables
74 */
75 static llist_t *list_init;
76 static llist_t *list_write;
77 static llist_t *list_flush;
78 static llist_t *list_missing;
79 static llist_t *list_shutdown;
80 static llist_t *list_log;
81 static llist_t *list_notification;
83 static fc_chain_t *pre_cache_chain = NULL;
84 static fc_chain_t *post_cache_chain = NULL;
86 static c_avl_tree_t *data_sets;
88 static char *plugindir = NULL;
90 static c_heap_t *read_heap = NULL;
91 static llist_t *read_list;
92 static int read_loop = 1;
93 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
94 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
95 static pthread_t *read_threads = NULL;
96 static int read_threads_num = 0;
98 static pthread_key_t plugin_ctx_key;
99 static _Bool plugin_ctx_key_initialized = 0;
101 /*
102 * Static functions
103 */
104 static const char *plugin_get_dir (void)
105 {
106 if (plugindir == NULL)
107 return (PLUGINDIR);
108 else
109 return (plugindir);
110 }
112 static void destroy_callback (callback_func_t *cf) /* {{{ */
113 {
114 if (cf == NULL)
115 return;
117 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
118 {
119 cf->cf_udata.free_func (cf->cf_udata.data);
120 cf->cf_udata.data = NULL;
121 cf->cf_udata.free_func = NULL;
122 }
123 sfree (cf);
124 } /* }}} void destroy_callback */
126 static void destroy_all_callbacks (llist_t **list) /* {{{ */
127 {
128 llentry_t *le;
130 if (*list == NULL)
131 return;
133 le = llist_head (*list);
134 while (le != NULL)
135 {
136 llentry_t *le_next;
138 le_next = le->next;
140 sfree (le->key);
141 destroy_callback (le->value);
142 le->value = NULL;
144 le = le_next;
145 }
147 llist_destroy (*list);
148 *list = NULL;
149 } /* }}} void destroy_all_callbacks */
151 static void destroy_read_heap (void) /* {{{ */
152 {
153 if (read_heap == NULL)
154 return;
156 while (42)
157 {
158 callback_func_t *cf;
160 cf = c_heap_get_root (read_heap);
161 if (cf == NULL)
162 break;
164 destroy_callback (cf);
165 }
167 c_heap_destroy (read_heap);
168 read_heap = NULL;
169 } /* }}} void destroy_read_heap */
171 static int register_callback (llist_t **list, /* {{{ */
172 const char *name, callback_func_t *cf)
173 {
174 llentry_t *le;
175 char *key;
177 if (*list == NULL)
178 {
179 *list = llist_create ();
180 if (*list == NULL)
181 {
182 ERROR ("plugin: register_callback: "
183 "llist_create failed.");
184 destroy_callback (cf);
185 return (-1);
186 }
187 }
189 key = strdup (name);
190 if (key == NULL)
191 {
192 ERROR ("plugin: register_callback: strdup failed.");
193 destroy_callback (cf);
194 return (-1);
195 }
197 le = llist_search (*list, name);
198 if (le == NULL)
199 {
200 le = llentry_create (key, cf);
201 if (le == NULL)
202 {
203 ERROR ("plugin: register_callback: "
204 "llentry_create failed.");
205 free (key);
206 destroy_callback (cf);
207 return (-1);
208 }
210 llist_append (*list, le);
211 }
212 else
213 {
214 callback_func_t *old_cf;
216 old_cf = le->value;
217 le->value = cf;
219 WARNING ("plugin: register_callback: "
220 "a callback named `%s' already exists - "
221 "overwriting the old entry!", name);
223 destroy_callback (old_cf);
224 sfree (key);
225 }
227 return (0);
228 } /* }}} int register_callback */
230 static int create_register_callback (llist_t **list, /* {{{ */
231 const char *name, void *callback, user_data_t *ud)
232 {
233 callback_func_t *cf;
235 cf = (callback_func_t *) malloc (sizeof (*cf));
236 if (cf == NULL)
237 {
238 ERROR ("plugin: create_register_callback: malloc failed.");
239 return (-1);
240 }
241 memset (cf, 0, sizeof (*cf));
243 cf->cf_callback = callback;
244 if (ud == NULL)
245 {
246 cf->cf_udata.data = NULL;
247 cf->cf_udata.free_func = NULL;
248 }
249 else
250 {
251 cf->cf_udata = *ud;
252 }
254 cf->cf_ctx = plugin_get_ctx ();
256 return (register_callback (list, name, cf));
257 } /* }}} int create_register_callback */
259 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
260 {
261 llentry_t *e;
263 if (list == NULL)
264 return (-1);
266 e = llist_search (list, name);
267 if (e == NULL)
268 return (-1);
270 llist_remove (list, e);
272 sfree (e->key);
273 destroy_callback (e->value);
275 llentry_destroy (e);
277 return (0);
278 } /* }}} int plugin_unregister */
280 /*
281 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
282 * object, but it will bitch about a shared object not having a
283 * ``module_register'' symbol..
284 */
285 static int plugin_load_file (char *file, uint32_t flags)
286 {
287 lt_dlhandle dlh;
288 void (*reg_handle) (void);
290 lt_dlinit ();
291 lt_dlerror (); /* clear errors */
293 #if LIBTOOL_VERSION == 2
294 if (flags & PLUGIN_FLAGS_GLOBAL) {
295 lt_dladvise advise;
296 lt_dladvise_init(&advise);
297 lt_dladvise_global(&advise);
298 dlh = lt_dlopenadvise(file, advise);
299 lt_dladvise_destroy(&advise);
300 } else {
301 dlh = lt_dlopen (file);
302 }
303 #else /* if LIBTOOL_VERSION == 1 */
304 if (flags & PLUGIN_FLAGS_GLOBAL)
305 WARNING ("plugin_load_file: The global flag is not supported, "
306 "libtool 2 is required for this.");
307 dlh = lt_dlopen (file);
308 #endif
310 if (dlh == NULL)
311 {
312 char errbuf[1024] = "";
314 ssnprintf (errbuf, sizeof (errbuf),
315 "lt_dlopen (\"%s\") failed: %s. "
316 "The most common cause for this problem are "
317 "missing dependencies. Use ldd(1) to check "
318 "the dependencies of the plugin "
319 "/ shared object.",
320 file, lt_dlerror ());
322 ERROR ("%s", errbuf);
323 /* Make sure this is printed to STDERR in any case, but also
324 * make sure it's printed only once. */
325 if (list_log != NULL)
326 fprintf (stderr, "ERROR: %s\n", errbuf);
328 return (1);
329 }
331 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
332 {
333 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
334 file, lt_dlerror ());
335 lt_dlclose (dlh);
336 return (-1);
337 }
339 (*reg_handle) ();
341 return (0);
342 }
344 static _Bool timeout_reached(struct timespec timeout)
345 {
346 struct timeval now;
347 gettimeofday(&now, NULL);
348 return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
349 }
351 static void *plugin_read_thread (void __attribute__((unused)) *args)
352 {
353 while (read_loop != 0)
354 {
355 read_func_t *rf;
356 plugin_ctx_t old_ctx;
357 cdtime_t now;
358 int status;
359 int rf_type;
360 int rc;
362 /* Get the read function that needs to be read next. */
363 rf = c_heap_get_root (read_heap);
364 if (rf == NULL)
365 {
366 struct timespec abstime;
368 now = cdtime ();
370 CDTIME_T_TO_TIMESPEC (now + interval_g, &abstime);
372 pthread_mutex_lock (&read_lock);
373 pthread_cond_timedwait (&read_cond, &read_lock,
374 &abstime);
375 pthread_mutex_unlock (&read_lock);
376 continue;
377 }
379 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
380 {
381 /* this should not happen, because the interval is set
382 * for each plugin when loading it
383 * XXX: issue a warning? */
384 now = cdtime ();
386 CDTIME_T_TO_TIMESPEC (plugin_get_interval (), &rf->rf_interval);
388 rf->rf_effective_interval = rf->rf_interval;
390 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
391 }
393 /* sleep until this entry is due,
394 * using pthread_cond_timedwait */
395 pthread_mutex_lock (&read_lock);
396 /* In pthread_cond_timedwait, spurious wakeups are possible
397 * (and really happen, at least on NetBSD with > 1 CPU), thus
398 * we need to re-evaluate the condition every time
399 * pthread_cond_timedwait returns. */
400 rc = 0;
401 while ((read_loop != 0)
402 && !timeout_reached(rf->rf_next_read)
403 && rc == 0)
404 {
405 rc = pthread_cond_timedwait (&read_cond, &read_lock,
406 &rf->rf_next_read);
407 }
409 /* Must hold `read_lock' when accessing `rf->rf_type'. */
410 rf_type = rf->rf_type;
411 pthread_mutex_unlock (&read_lock);
413 /* Check if we're supposed to stop.. This may have interrupted
414 * the sleep, too. */
415 if (read_loop == 0)
416 {
417 /* Insert `rf' again, so it can be free'd correctly */
418 c_heap_insert (read_heap, rf);
419 break;
420 }
422 /* The entry has been marked for deletion. The linked list
423 * entry has already been removed by `plugin_unregister_read'.
424 * All we have to do here is free the `read_func_t' and
425 * continue. */
426 if (rf_type == RF_REMOVE)
427 {
428 DEBUG ("plugin_read_thread: Destroying the `%s' "
429 "callback.", rf->rf_name);
430 destroy_callback ((callback_func_t *) rf);
431 rf = NULL;
432 continue;
433 }
435 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
437 old_ctx = plugin_set_ctx (rf->rf_ctx);
439 if (rf_type == RF_SIMPLE)
440 {
441 int (*callback) (void);
443 callback = rf->rf_callback;
444 status = (*callback) ();
445 }
446 else
447 {
448 plugin_read_cb callback;
450 assert (rf_type == RF_COMPLEX);
452 callback = rf->rf_callback;
453 status = (*callback) (&rf->rf_udata);
454 }
456 plugin_set_ctx (old_ctx);
458 /* If the function signals failure, we will increase the
459 * intervals in which it will be called. */
460 if (status != 0)
461 {
462 rf->rf_effective_interval.tv_sec *= 2;
463 rf->rf_effective_interval.tv_nsec *= 2;
464 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
466 if (rf->rf_effective_interval.tv_sec >= 86400)
467 {
468 rf->rf_effective_interval.tv_sec = 86400;
469 rf->rf_effective_interval.tv_nsec = 0;
470 }
472 NOTICE ("read-function of plugin `%s' failed. "
473 "Will suspend it for %i seconds.",
474 rf->rf_name,
475 (int) rf->rf_effective_interval.tv_sec);
476 }
477 else
478 {
479 /* Success: Restore the interval, if it was changed. */
480 rf->rf_effective_interval = rf->rf_interval;
481 }
483 /* update the ``next read due'' field */
484 now = cdtime ();
486 DEBUG ("plugin_read_thread: Effective interval of the "
487 "%s plugin is %i.%09i.",
488 rf->rf_name,
489 (int) rf->rf_effective_interval.tv_sec,
490 (int) rf->rf_effective_interval.tv_nsec);
492 /* Calculate the next (absolute) time at which this function
493 * should be called. */
494 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
495 + rf->rf_effective_interval.tv_sec;
496 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
497 + rf->rf_effective_interval.tv_nsec;
498 NORMALIZE_TIMESPEC (rf->rf_next_read);
500 /* Check, if `rf_next_read' is in the past. */
501 if (TIMESPEC_TO_CDTIME_T (&rf->rf_next_read) < now)
502 {
503 /* `rf_next_read' is in the past. Insert `now'
504 * so this value doesn't trail off into the
505 * past too much. */
506 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
507 }
509 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
510 rf->rf_name,
511 (int) rf->rf_next_read.tv_sec,
512 (int) rf->rf_next_read.tv_nsec);
514 /* Re-insert this read function into the heap again. */
515 c_heap_insert (read_heap, rf);
516 } /* while (read_loop) */
518 pthread_exit (NULL);
519 return ((void *) 0);
520 } /* void *plugin_read_thread */
522 static void start_read_threads (int num)
523 {
524 int i;
526 if (read_threads != NULL)
527 return;
529 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
530 if (read_threads == NULL)
531 {
532 ERROR ("plugin: start_read_threads: calloc failed.");
533 return;
534 }
536 read_threads_num = 0;
537 for (i = 0; i < num; i++)
538 {
539 if (pthread_create (read_threads + read_threads_num, NULL,
540 plugin_read_thread, NULL) == 0)
541 {
542 read_threads_num++;
543 }
544 else
545 {
546 ERROR ("plugin: start_read_threads: pthread_create failed.");
547 return;
548 }
549 } /* for (i) */
550 } /* void start_read_threads */
552 static void stop_read_threads (void)
553 {
554 int i;
556 if (read_threads == NULL)
557 return;
559 INFO ("collectd: Stopping %i read threads.", read_threads_num);
561 pthread_mutex_lock (&read_lock);
562 read_loop = 0;
563 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
564 pthread_cond_broadcast (&read_cond);
565 pthread_mutex_unlock (&read_lock);
567 for (i = 0; i < read_threads_num; i++)
568 {
569 if (pthread_join (read_threads[i], NULL) != 0)
570 {
571 ERROR ("plugin: stop_read_threads: pthread_join failed.");
572 }
573 read_threads[i] = (pthread_t) 0;
574 }
575 sfree (read_threads);
576 read_threads_num = 0;
577 } /* void stop_read_threads */
579 /*
580 * Public functions
581 */
582 void plugin_set_dir (const char *dir)
583 {
584 if (plugindir != NULL)
585 free (plugindir);
587 if (dir == NULL)
588 plugindir = NULL;
589 else if ((plugindir = strdup (dir)) == NULL)
590 {
591 char errbuf[1024];
592 ERROR ("strdup failed: %s",
593 sstrerror (errno, errbuf, sizeof (errbuf)));
594 }
595 }
597 #define BUFSIZE 512
598 int plugin_load (const char *type, uint32_t flags)
599 {
600 DIR *dh;
601 const char *dir;
602 char filename[BUFSIZE] = "";
603 char typename[BUFSIZE];
604 int typename_len;
605 int ret;
606 struct stat statbuf;
607 struct dirent *de;
608 int status;
610 DEBUG ("type = %s", type);
612 dir = plugin_get_dir ();
613 ret = 1;
615 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
616 * type when matching the filename */
617 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
618 if ((status < 0) || ((size_t) status >= sizeof (typename)))
619 {
620 WARNING ("snprintf: truncated: `%s.so'", type);
621 return (-1);
622 }
623 typename_len = strlen (typename);
625 if ((dh = opendir (dir)) == NULL)
626 {
627 char errbuf[1024];
628 ERROR ("opendir (%s): %s", dir,
629 sstrerror (errno, errbuf, sizeof (errbuf)));
630 return (-1);
631 }
633 while ((de = readdir (dh)) != NULL)
634 {
635 if (strncasecmp (de->d_name, typename, typename_len))
636 continue;
638 status = ssnprintf (filename, sizeof (filename),
639 "%s/%s", dir, de->d_name);
640 if ((status < 0) || ((size_t) status >= sizeof (filename)))
641 {
642 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
643 continue;
644 }
646 if (lstat (filename, &statbuf) == -1)
647 {
648 char errbuf[1024];
649 WARNING ("stat %s: %s", filename,
650 sstrerror (errno, errbuf, sizeof (errbuf)));
651 continue;
652 }
653 else if (!S_ISREG (statbuf.st_mode))
654 {
655 /* don't follow symlinks */
656 WARNING ("stat %s: not a regular file", filename);
657 continue;
658 }
660 if (plugin_load_file (filename, flags) == 0)
661 {
662 /* success */
663 ret = 0;
664 break;
665 }
666 else
667 {
668 fprintf (stderr, "Unable to load plugin %s.\n", type);
669 }
670 }
672 closedir (dh);
674 if (filename[0] == '\0')
675 fprintf (stderr, "Could not find plugin %s.\n", type);
677 return (ret);
678 }
680 /*
681 * The `register_*' functions follow
682 */
683 int plugin_register_config (const char *name,
684 int (*callback) (const char *key, const char *val),
685 const char **keys, int keys_num)
686 {
687 cf_register (name, callback, keys, keys_num);
688 return (0);
689 } /* int plugin_register_config */
691 int plugin_register_complex_config (const char *type,
692 int (*callback) (oconfig_item_t *))
693 {
694 return (cf_register_complex (type, callback));
695 } /* int plugin_register_complex_config */
697 int plugin_register_init (const char *name,
698 int (*callback) (void))
699 {
700 return (create_register_callback (&list_init, name, (void *) callback,
701 /* user_data = */ NULL));
702 } /* plugin_register_init */
704 static int plugin_compare_read_func (const void *arg0, const void *arg1)
705 {
706 const read_func_t *rf0;
707 const read_func_t *rf1;
709 rf0 = arg0;
710 rf1 = arg1;
712 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
713 return (-1);
714 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
715 return (1);
716 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
717 return (-1);
718 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
719 return (1);
720 else
721 return (0);
722 } /* int plugin_compare_read_func */
724 /* Add a read function to both, the heap and a linked list. The linked list if
725 * used to look-up read functions, especially for the remove function. The heap
726 * is used to determine which plugin to read next. */
727 static int plugin_insert_read (read_func_t *rf)
728 {
729 int status;
730 llentry_t *le;
732 pthread_mutex_lock (&read_lock);
734 if (read_list == NULL)
735 {
736 read_list = llist_create ();
737 if (read_list == NULL)
738 {
739 pthread_mutex_unlock (&read_lock);
740 ERROR ("plugin_insert_read: read_list failed.");
741 return (-1);
742 }
743 }
745 if (read_heap == NULL)
746 {
747 read_heap = c_heap_create (plugin_compare_read_func);
748 if (read_heap == NULL)
749 {
750 pthread_mutex_unlock (&read_lock);
751 ERROR ("plugin_insert_read: c_heap_create failed.");
752 return (-1);
753 }
754 }
756 le = llist_search (read_list, rf->rf_name);
757 if (le != NULL)
758 {
759 pthread_mutex_unlock (&read_lock);
760 WARNING ("The read function \"%s\" is already registered. "
761 "Check for duplicate \"LoadPlugin\" lines "
762 "in your configuration!",
763 rf->rf_name);
764 return (EINVAL);
765 }
767 le = llentry_create (rf->rf_name, rf);
768 if (le == NULL)
769 {
770 pthread_mutex_unlock (&read_lock);
771 ERROR ("plugin_insert_read: llentry_create failed.");
772 return (-1);
773 }
775 status = c_heap_insert (read_heap, rf);
776 if (status != 0)
777 {
778 pthread_mutex_unlock (&read_lock);
779 ERROR ("plugin_insert_read: c_heap_insert failed.");
780 llentry_destroy (le);
781 return (-1);
782 }
784 /* This does not fail. */
785 llist_append (read_list, le);
787 pthread_mutex_unlock (&read_lock);
788 return (0);
789 } /* int plugin_insert_read */
791 static int read_cb_wrapper (user_data_t *ud)
792 {
793 int (*callback) (void);
795 if (ud == NULL)
796 return -1;
798 callback = ud->data;
799 return callback();
800 } /* int read_cb_wrapper */
802 int plugin_register_read (const char *name,
803 int (*callback) (void))
804 {
805 read_func_t *rf;
806 plugin_ctx_t ctx = plugin_get_ctx ();
807 int status;
809 if (ctx.interval != 0) {
810 /* If ctx.interval is not zero (== use the plugin or global
811 * interval), we need to use the "complex" read callback,
812 * because only that allows to specify a different interval.
813 * Wrap the callback using read_cb_wrapper(). */
814 struct timespec interval;
815 user_data_t user_data;
817 user_data.data = callback;
818 user_data.free_func = NULL;
820 CDTIME_T_TO_TIMESPEC (ctx.interval, &interval);
821 return plugin_register_complex_read (/* group = */ NULL,
822 name, read_cb_wrapper, &interval, &user_data);
823 }
825 DEBUG ("plugin_register_read: default_interval = %.3f",
826 CDTIME_T_TO_DOUBLE(plugin_get_interval ()));
828 rf = malloc (sizeof (*rf));
829 if (rf == NULL)
830 {
831 ERROR ("plugin_register_read: malloc failed.");
832 return (ENOMEM);
833 }
835 memset (rf, 0, sizeof (read_func_t));
836 rf->rf_callback = (void *) callback;
837 rf->rf_udata.data = NULL;
838 rf->rf_udata.free_func = NULL;
839 rf->rf_ctx = ctx;
840 rf->rf_group[0] = '\0';
841 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
842 rf->rf_type = RF_SIMPLE;
843 rf->rf_interval.tv_sec = 0;
844 rf->rf_interval.tv_nsec = 0;
845 rf->rf_effective_interval = rf->rf_interval;
847 status = plugin_insert_read (rf);
848 if (status != 0)
849 sfree (rf);
851 return (status);
852 } /* int plugin_register_read */
854 int plugin_register_complex_read (const char *group, const char *name,
855 plugin_read_cb callback,
856 const struct timespec *interval,
857 user_data_t *user_data)
858 {
859 read_func_t *rf;
860 plugin_ctx_t ctx = plugin_get_ctx ();
861 int status;
863 rf = malloc (sizeof (*rf));
864 if (rf == NULL)
865 {
866 ERROR ("plugin_register_complex_read: malloc failed.");
867 return (ENOMEM);
868 }
870 memset (rf, 0, sizeof (read_func_t));
871 rf->rf_callback = (void *) callback;
872 if (group != NULL)
873 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
874 else
875 rf->rf_group[0] = '\0';
876 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
877 rf->rf_type = RF_COMPLEX;
878 if (interval != NULL)
879 {
880 rf->rf_interval = *interval;
881 }
882 else if (ctx.interval != 0)
883 {
884 CDTIME_T_TO_TIMESPEC (ctx.interval, &rf->rf_interval);
885 }
886 rf->rf_effective_interval = rf->rf_interval;
888 DEBUG ("plugin_register_read: interval = %i.%09i",
889 (int) rf->rf_interval.tv_sec,
890 (int) rf->rf_interval.tv_nsec);
892 /* Set user data */
893 if (user_data == NULL)
894 {
895 rf->rf_udata.data = NULL;
896 rf->rf_udata.free_func = NULL;
897 }
898 else
899 {
900 rf->rf_udata = *user_data;
901 }
903 rf->rf_ctx = ctx;
905 status = plugin_insert_read (rf);
906 if (status != 0)
907 sfree (rf);
909 return (status);
910 } /* int plugin_register_complex_read */
912 int plugin_register_write (const char *name,
913 plugin_write_cb callback, user_data_t *ud)
914 {
915 return (create_register_callback (&list_write, name,
916 (void *) callback, ud));
917 } /* int plugin_register_write */
919 int plugin_register_flush (const char *name,
920 plugin_flush_cb callback, user_data_t *ud)
921 {
922 return (create_register_callback (&list_flush, name,
923 (void *) callback, ud));
924 } /* int plugin_register_flush */
926 int plugin_register_missing (const char *name,
927 plugin_missing_cb callback, user_data_t *ud)
928 {
929 return (create_register_callback (&list_missing, name,
930 (void *) callback, ud));
931 } /* int plugin_register_missing */
933 int plugin_register_shutdown (const char *name,
934 int (*callback) (void))
935 {
936 return (create_register_callback (&list_shutdown, name,
937 (void *) callback, /* user_data = */ NULL));
938 } /* int plugin_register_shutdown */
940 int plugin_register_data_set (const data_set_t *ds)
941 {
942 data_set_t *ds_copy;
943 int i;
945 if ((data_sets != NULL)
946 && (c_avl_get (data_sets, ds->type, NULL) == 0))
947 {
948 NOTICE ("Replacing DS `%s' with another version.", ds->type);
949 plugin_unregister_data_set (ds->type);
950 }
951 else if (data_sets == NULL)
952 {
953 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
954 if (data_sets == NULL)
955 return (-1);
956 }
958 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
959 if (ds_copy == NULL)
960 return (-1);
961 memcpy(ds_copy, ds, sizeof (data_set_t));
963 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
964 * ds->ds_num);
965 if (ds_copy->ds == NULL)
966 {
967 free (ds_copy);
968 return (-1);
969 }
971 for (i = 0; i < ds->ds_num; i++)
972 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
974 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
975 } /* int plugin_register_data_set */
977 int plugin_register_log (const char *name,
978 plugin_log_cb callback, user_data_t *ud)
979 {
980 return (create_register_callback (&list_log, name,
981 (void *) callback, ud));
982 } /* int plugin_register_log */
984 int plugin_register_notification (const char *name,
985 plugin_notification_cb callback, user_data_t *ud)
986 {
987 return (create_register_callback (&list_notification, name,
988 (void *) callback, ud));
989 } /* int plugin_register_log */
991 int plugin_unregister_config (const char *name)
992 {
993 cf_unregister (name);
994 return (0);
995 } /* int plugin_unregister_config */
997 int plugin_unregister_complex_config (const char *name)
998 {
999 cf_unregister_complex (name);
1000 return (0);
1001 } /* int plugin_unregister_complex_config */
1003 int plugin_unregister_init (const char *name)
1004 {
1005 return (plugin_unregister (list_init, name));
1006 }
1008 int plugin_unregister_read (const char *name) /* {{{ */
1009 {
1010 llentry_t *le;
1011 read_func_t *rf;
1013 if (name == NULL)
1014 return (-ENOENT);
1016 pthread_mutex_lock (&read_lock);
1018 if (read_list == NULL)
1019 {
1020 pthread_mutex_unlock (&read_lock);
1021 return (-ENOENT);
1022 }
1024 le = llist_search (read_list, name);
1025 if (le == NULL)
1026 {
1027 pthread_mutex_unlock (&read_lock);
1028 WARNING ("plugin_unregister_read: No such read function: %s",
1029 name);
1030 return (-ENOENT);
1031 }
1033 llist_remove (read_list, le);
1035 rf = le->value;
1036 assert (rf != NULL);
1037 rf->rf_type = RF_REMOVE;
1039 pthread_mutex_unlock (&read_lock);
1041 llentry_destroy (le);
1043 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1045 return (0);
1046 } /* }}} int plugin_unregister_read */
1048 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1049 {
1050 read_func_t *rf = e->value;
1051 char *group = ud;
1053 return strcmp (rf->rf_group, (const char *)group);
1054 } /* }}} int compare_read_func_group */
1056 int plugin_unregister_read_group (const char *group) /* {{{ */
1057 {
1058 llentry_t *le;
1059 read_func_t *rf;
1061 int found = 0;
1063 if (group == NULL)
1064 return (-ENOENT);
1066 pthread_mutex_lock (&read_lock);
1068 if (read_list == NULL)
1069 {
1070 pthread_mutex_unlock (&read_lock);
1071 return (-ENOENT);
1072 }
1074 while (42)
1075 {
1076 le = llist_search_custom (read_list,
1077 compare_read_func_group, (void *)group);
1079 if (le == NULL)
1080 break;
1082 ++found;
1084 llist_remove (read_list, le);
1086 rf = le->value;
1087 assert (rf != NULL);
1088 rf->rf_type = RF_REMOVE;
1090 llentry_destroy (le);
1092 DEBUG ("plugin_unregister_read_group: "
1093 "Marked `%s' (group `%s') for removal.",
1094 rf->rf_name, group);
1095 }
1097 pthread_mutex_unlock (&read_lock);
1099 if (found == 0)
1100 {
1101 WARNING ("plugin_unregister_read_group: No such "
1102 "group of read function: %s", group);
1103 return (-ENOENT);
1104 }
1106 return (0);
1107 } /* }}} int plugin_unregister_read_group */
1109 int plugin_unregister_write (const char *name)
1110 {
1111 return (plugin_unregister (list_write, name));
1112 }
1114 int plugin_unregister_flush (const char *name)
1115 {
1116 return (plugin_unregister (list_flush, name));
1117 }
1119 int plugin_unregister_missing (const char *name)
1120 {
1121 return (plugin_unregister (list_missing, name));
1122 }
1124 int plugin_unregister_shutdown (const char *name)
1125 {
1126 return (plugin_unregister (list_shutdown, name));
1127 }
1129 int plugin_unregister_data_set (const char *name)
1130 {
1131 data_set_t *ds;
1133 if (data_sets == NULL)
1134 return (-1);
1136 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1137 return (-1);
1139 sfree (ds->ds);
1140 sfree (ds);
1142 return (0);
1143 } /* int plugin_unregister_data_set */
1145 int plugin_unregister_log (const char *name)
1146 {
1147 return (plugin_unregister (list_log, name));
1148 }
1150 int plugin_unregister_notification (const char *name)
1151 {
1152 return (plugin_unregister (list_notification, name));
1153 }
1155 void plugin_init_all (void)
1156 {
1157 const char *chain_name;
1158 llentry_t *le;
1159 int status;
1161 /* Init the value cache */
1162 uc_init ();
1164 chain_name = global_option_get ("PreCacheChain");
1165 pre_cache_chain = fc_chain_get_by_name (chain_name);
1167 chain_name = global_option_get ("PostCacheChain");
1168 post_cache_chain = fc_chain_get_by_name (chain_name);
1171 if ((list_init == NULL) && (read_heap == NULL))
1172 return;
1174 /* Calling all init callbacks before checking if read callbacks
1175 * are available allows the init callbacks to register the read
1176 * callback. */
1177 le = llist_head (list_init);
1178 while (le != NULL)
1179 {
1180 callback_func_t *cf;
1181 plugin_init_cb callback;
1182 plugin_ctx_t old_ctx;
1184 cf = le->value;
1185 old_ctx = plugin_set_ctx (cf->cf_ctx);
1186 callback = cf->cf_callback;
1187 status = (*callback) ();
1188 plugin_set_ctx (old_ctx);
1190 if (status != 0)
1191 {
1192 ERROR ("Initialization of plugin `%s' "
1193 "failed with status %i. "
1194 "Plugin will be unloaded.",
1195 le->key, status);
1196 /* Plugins that register read callbacks from the init
1197 * callback should take care of appropriate error
1198 * handling themselves. */
1199 /* FIXME: Unload _all_ functions */
1200 plugin_unregister_read (le->key);
1201 }
1203 le = le->next;
1204 }
1206 /* Start read-threads */
1207 if (read_heap != NULL)
1208 {
1209 const char *rt;
1210 int num;
1211 rt = global_option_get ("ReadThreads");
1212 num = atoi (rt);
1213 if (num != -1)
1214 start_read_threads ((num > 0) ? num : 5);
1215 }
1216 } /* void plugin_init_all */
1218 /* TODO: Rename this function. */
1219 void plugin_read_all (void)
1220 {
1221 uc_check_timeout ();
1223 return;
1224 } /* void plugin_read_all */
1226 /* Read function called when the `-T' command line argument is given. */
1227 int plugin_read_all_once (void)
1228 {
1229 int status;
1230 int return_status = 0;
1232 if (read_heap == NULL)
1233 {
1234 NOTICE ("No read-functions are registered.");
1235 return (0);
1236 }
1238 while (42)
1239 {
1240 read_func_t *rf;
1241 plugin_ctx_t old_ctx;
1243 rf = c_heap_get_root (read_heap);
1244 if (rf == NULL)
1245 break;
1247 old_ctx = plugin_set_ctx (rf->rf_ctx);
1249 if (rf->rf_type == RF_SIMPLE)
1250 {
1251 int (*callback) (void);
1253 callback = rf->rf_callback;
1254 status = (*callback) ();
1255 }
1256 else
1257 {
1258 plugin_read_cb callback;
1260 callback = rf->rf_callback;
1261 status = (*callback) (&rf->rf_udata);
1262 }
1264 plugin_set_ctx (old_ctx);
1266 if (status != 0)
1267 {
1268 NOTICE ("read-function of plugin `%s' failed.",
1269 rf->rf_name);
1270 return_status = -1;
1271 }
1273 destroy_callback ((void *) rf);
1274 }
1276 return (return_status);
1277 } /* int plugin_read_all_once */
1279 int plugin_write (const char *plugin, /* {{{ */
1280 const data_set_t *ds, const value_list_t *vl)
1281 {
1282 llentry_t *le;
1283 int status;
1285 if (vl == NULL)
1286 return (EINVAL);
1288 if (list_write == NULL)
1289 return (ENOENT);
1291 if (ds == NULL)
1292 {
1293 ds = plugin_get_ds (vl->type);
1294 if (ds == NULL)
1295 {
1296 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1297 return (ENOENT);
1298 }
1299 }
1301 if (plugin == NULL)
1302 {
1303 int success = 0;
1304 int failure = 0;
1306 le = llist_head (list_write);
1307 while (le != NULL)
1308 {
1309 callback_func_t *cf = le->value;
1310 plugin_write_cb callback;
1312 /* do not switch plugin context; rather keep the context (interval)
1313 * information of the calling read plugin */
1315 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1316 callback = cf->cf_callback;
1317 status = (*callback) (ds, vl, &cf->cf_udata);
1318 if (status != 0)
1319 failure++;
1320 else
1321 success++;
1323 le = le->next;
1324 }
1326 if ((success == 0) && (failure != 0))
1327 status = -1;
1328 else
1329 status = 0;
1330 }
1331 else /* plugin != NULL */
1332 {
1333 callback_func_t *cf;
1334 plugin_write_cb callback;
1336 le = llist_head (list_write);
1337 while (le != NULL)
1338 {
1339 if (strcasecmp (plugin, le->key) == 0)
1340 break;
1342 le = le->next;
1343 }
1345 if (le == NULL)
1346 return (ENOENT);
1348 cf = le->value;
1350 /* do not switch plugin context; rather keep the context (interval)
1351 * information of the calling read plugin */
1353 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1354 callback = cf->cf_callback;
1355 status = (*callback) (ds, vl, &cf->cf_udata);
1356 }
1358 return (status);
1359 } /* }}} int plugin_write */
1361 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1362 {
1363 llentry_t *le;
1365 if (list_flush == NULL)
1366 return (0);
1368 le = llist_head (list_flush);
1369 while (le != NULL)
1370 {
1371 callback_func_t *cf;
1372 plugin_flush_cb callback;
1373 plugin_ctx_t old_ctx;
1375 if ((plugin != NULL)
1376 && (strcmp (plugin, le->key) != 0))
1377 {
1378 le = le->next;
1379 continue;
1380 }
1382 cf = le->value;
1383 old_ctx = plugin_set_ctx (cf->cf_ctx);
1384 callback = cf->cf_callback;
1386 (*callback) (timeout, identifier, &cf->cf_udata);
1388 plugin_set_ctx (old_ctx);
1390 le = le->next;
1391 }
1392 return (0);
1393 } /* int plugin_flush */
1395 void plugin_shutdown_all (void)
1396 {
1397 llentry_t *le;
1399 stop_read_threads ();
1401 destroy_all_callbacks (&list_init);
1403 pthread_mutex_lock (&read_lock);
1404 llist_destroy (read_list);
1405 read_list = NULL;
1406 pthread_mutex_unlock (&read_lock);
1408 destroy_read_heap ();
1410 plugin_flush (/* plugin = */ NULL,
1411 /* timeout = */ 0,
1412 /* identifier = */ NULL);
1414 le = NULL;
1415 if (list_shutdown != NULL)
1416 le = llist_head (list_shutdown);
1418 while (le != NULL)
1419 {
1420 callback_func_t *cf;
1421 plugin_shutdown_cb callback;
1422 plugin_ctx_t old_ctx;
1424 cf = le->value;
1425 old_ctx = plugin_set_ctx (cf->cf_ctx);
1426 callback = cf->cf_callback;
1428 /* Advance the pointer before calling the callback allows
1429 * shutdown functions to unregister themselves. If done the
1430 * other way around the memory `le' points to will be freed
1431 * after callback returns. */
1432 le = le->next;
1434 (*callback) ();
1436 plugin_set_ctx (old_ctx);
1437 }
1439 /* Write plugins which use the `user_data' pointer usually need the
1440 * same data available to the flush callback. If this is the case, set
1441 * the free_function to NULL when registering the flush callback and to
1442 * the real free function when registering the write callback. This way
1443 * the data isn't freed twice. */
1444 destroy_all_callbacks (&list_flush);
1445 destroy_all_callbacks (&list_missing);
1446 destroy_all_callbacks (&list_write);
1448 destroy_all_callbacks (&list_notification);
1449 destroy_all_callbacks (&list_shutdown);
1450 destroy_all_callbacks (&list_log);
1451 } /* void plugin_shutdown_all */
1453 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1454 {
1455 llentry_t *le;
1457 if (list_missing == NULL)
1458 return (0);
1460 le = llist_head (list_missing);
1461 while (le != NULL)
1462 {
1463 callback_func_t *cf;
1464 plugin_missing_cb callback;
1465 plugin_ctx_t old_ctx;
1466 int status;
1468 cf = le->value;
1469 old_ctx = plugin_set_ctx (cf->cf_ctx);
1470 callback = cf->cf_callback;
1472 status = (*callback) (vl, &cf->cf_udata);
1473 plugin_set_ctx (old_ctx);
1474 if (status != 0)
1475 {
1476 if (status < 0)
1477 {
1478 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1479 "failed with status %i.",
1480 le->key, status);
1481 return (status);
1482 }
1483 else
1484 {
1485 return (0);
1486 }
1487 }
1489 le = le->next;
1490 }
1491 return (0);
1492 } /* int }}} plugin_dispatch_missing */
1494 int plugin_dispatch_values (value_list_t *vl)
1495 {
1496 int status;
1497 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1499 value_t *saved_values;
1500 int saved_values_len;
1502 data_set_t *ds;
1504 int free_meta_data = 0;
1506 if ((vl == NULL) || (vl->type[0] == 0)
1507 || (vl->values == NULL) || (vl->values_len < 1))
1508 {
1509 ERROR ("plugin_dispatch_values: Invalid value list "
1510 "from plugin %s.", vl->plugin);
1511 return (-1);
1512 }
1514 /* Free meta data only if the calling function didn't specify any. In
1515 * this case matches and targets may add some and the calling function
1516 * may not expect (and therefore free) that data. */
1517 if (vl->meta == NULL)
1518 free_meta_data = 1;
1520 if (list_write == NULL)
1521 c_complain_once (LOG_WARNING, &no_write_complaint,
1522 "plugin_dispatch_values: No write callback has been "
1523 "registered. Please load at least one output plugin, "
1524 "if you want the collected data to be stored.");
1526 if (data_sets == NULL)
1527 {
1528 ERROR ("plugin_dispatch_values: No data sets registered. "
1529 "Could the types database be read? Check "
1530 "your `TypesDB' setting!");
1531 return (-1);
1532 }
1534 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1535 {
1536 char ident[6 * DATA_MAX_NAME_LEN];
1538 FORMAT_VL (ident, sizeof (ident), vl);
1539 INFO ("plugin_dispatch_values: Dataset not found: %s "
1540 "(from \"%s\"), check your types.db!",
1541 vl->type, ident);
1542 return (-1);
1543 }
1545 if (vl->time == 0)
1546 vl->time = cdtime ();
1548 if (vl->interval <= 0) {
1549 plugin_ctx_t ctx = plugin_get_ctx ();
1551 if (ctx.interval != 0)
1552 vl->interval = ctx.interval;
1553 else
1554 vl->interval = interval_g;
1555 }
1557 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1558 "host = %s; "
1559 "plugin = %s; plugin_instance = %s; "
1560 "type = %s; type_instance = %s;",
1561 CDTIME_T_TO_DOUBLE (vl->time),
1562 CDTIME_T_TO_DOUBLE (vl->interval),
1563 vl->host,
1564 vl->plugin, vl->plugin_instance,
1565 vl->type, vl->type_instance);
1567 #if COLLECT_DEBUG
1568 assert (0 == strcmp (ds->type, vl->type));
1569 #else
1570 if (0 != strcmp (ds->type, vl->type))
1571 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1572 ds->type, vl->type);
1573 #endif
1575 #if COLLECT_DEBUG
1576 assert (ds->ds_num == vl->values_len);
1577 #else
1578 if (ds->ds_num != vl->values_len)
1579 {
1580 ERROR ("plugin_dispatch_values: ds->type = %s: "
1581 "(ds->ds_num = %i) != "
1582 "(vl->values_len = %i)",
1583 ds->type, ds->ds_num, vl->values_len);
1584 return (-1);
1585 }
1586 #endif
1588 escape_slashes (vl->host, sizeof (vl->host));
1589 escape_slashes (vl->plugin, sizeof (vl->plugin));
1590 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1591 escape_slashes (vl->type, sizeof (vl->type));
1592 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1594 /* Copy the values. This way, we can assure `targets' that they get
1595 * dynamically allocated values, which they can free and replace if
1596 * they like. */
1597 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1598 {
1599 saved_values = vl->values;
1600 saved_values_len = vl->values_len;
1602 vl->values = (value_t *) calloc (vl->values_len,
1603 sizeof (*vl->values));
1604 if (vl->values == NULL)
1605 {
1606 ERROR ("plugin_dispatch_values: calloc failed.");
1607 vl->values = saved_values;
1608 return (-1);
1609 }
1610 memcpy (vl->values, saved_values,
1611 vl->values_len * sizeof (*vl->values));
1612 }
1613 else /* if ((pre == NULL) && (post == NULL)) */
1614 {
1615 saved_values = NULL;
1616 saved_values_len = 0;
1617 }
1619 if (pre_cache_chain != NULL)
1620 {
1621 status = fc_process_chain (ds, vl, pre_cache_chain);
1622 if (status < 0)
1623 {
1624 WARNING ("plugin_dispatch_values: Running the "
1625 "pre-cache chain failed with "
1626 "status %i (%#x).",
1627 status, status);
1628 }
1629 else if (status == FC_TARGET_STOP)
1630 {
1631 /* Restore the state of the value_list so that plugins
1632 * don't get confused.. */
1633 if (saved_values != NULL)
1634 {
1635 free (vl->values);
1636 vl->values = saved_values;
1637 vl->values_len = saved_values_len;
1638 }
1639 return (0);
1640 }
1641 }
1643 /* Update the value cache */
1644 uc_update (ds, vl);
1646 if (post_cache_chain != NULL)
1647 {
1648 status = fc_process_chain (ds, vl, post_cache_chain);
1649 if (status < 0)
1650 {
1651 WARNING ("plugin_dispatch_values: Running the "
1652 "post-cache chain failed with "
1653 "status %i (%#x).",
1654 status, status);
1655 }
1656 }
1657 else
1658 fc_default_action (ds, vl);
1660 /* Restore the state of the value_list so that plugins don't get
1661 * confused.. */
1662 if (saved_values != NULL)
1663 {
1664 free (vl->values);
1665 vl->values = saved_values;
1666 vl->values_len = saved_values_len;
1667 }
1669 if ((free_meta_data != 0) && (vl->meta != NULL))
1670 {
1671 meta_data_destroy (vl->meta);
1672 vl->meta = NULL;
1673 }
1675 return (0);
1676 } /* int plugin_dispatch_values */
1678 int plugin_dispatch_values_secure (const value_list_t *vl)
1679 {
1680 value_list_t vl_copy;
1681 int status;
1683 if (vl == NULL)
1684 return EINVAL;
1686 memcpy (&vl_copy, vl, sizeof (vl_copy));
1688 /* Write callbacks must not change the values and meta pointers, so we can
1689 * savely skip copying those and make this more efficient. */
1690 if ((pre_cache_chain == NULL) && (post_cache_chain == NULL))
1691 return (plugin_dispatch_values (&vl_copy));
1693 /* Set pointers to NULL, just to be on the save side. */
1694 vl_copy.values = NULL;
1695 vl_copy.meta = NULL;
1697 vl_copy.values = malloc (sizeof (*vl_copy.values) * vl->values_len);
1698 if (vl_copy.values == NULL)
1699 {
1700 ERROR ("plugin_dispatch_values_secure: malloc failed.");
1701 return (ENOMEM);
1702 }
1703 memcpy (vl_copy.values, vl->values, sizeof (*vl_copy.values) * vl->values_len);
1705 if (vl->meta != NULL)
1706 {
1707 vl_copy.meta = meta_data_clone (vl->meta);
1708 if (vl_copy.meta == NULL)
1709 {
1710 ERROR ("plugin_dispatch_values_secure: meta_data_clone failed.");
1711 free (vl_copy.values);
1712 return (ENOMEM);
1713 }
1714 } /* if (vl->meta) */
1716 status = plugin_dispatch_values (&vl_copy);
1718 meta_data_destroy (vl_copy.meta);
1719 free (vl_copy.values);
1721 return (status);
1722 } /* int plugin_dispatch_values_secure */
1724 int plugin_dispatch_notification (const notification_t *notif)
1725 {
1726 llentry_t *le;
1727 /* Possible TODO: Add flap detection here */
1729 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1730 "time = %.3f; host = %s;",
1731 notif->severity, notif->message,
1732 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1734 /* Nobody cares for notifications */
1735 if (list_notification == NULL)
1736 return (-1);
1738 le = llist_head (list_notification);
1739 while (le != NULL)
1740 {
1741 callback_func_t *cf;
1742 plugin_notification_cb callback;
1743 int status;
1745 /* do not switch plugin context; rather keep the context
1746 * (interval) information of the calling plugin */
1748 cf = le->value;
1749 callback = cf->cf_callback;
1750 status = (*callback) (notif, &cf->cf_udata);
1751 if (status != 0)
1752 {
1753 WARNING ("plugin_dispatch_notification: Notification "
1754 "callback %s returned %i.",
1755 le->key, status);
1756 }
1758 le = le->next;
1759 }
1761 return (0);
1762 } /* int plugin_dispatch_notification */
1764 void plugin_log (int level, const char *format, ...)
1765 {
1766 char msg[1024];
1767 va_list ap;
1768 llentry_t *le;
1770 #if !COLLECT_DEBUG
1771 if (level >= LOG_DEBUG)
1772 return;
1773 #endif
1775 va_start (ap, format);
1776 vsnprintf (msg, sizeof (msg), format, ap);
1777 msg[sizeof (msg) - 1] = '\0';
1778 va_end (ap);
1780 if (list_log == NULL)
1781 {
1782 fprintf (stderr, "%s\n", msg);
1783 return;
1784 }
1786 le = llist_head (list_log);
1787 while (le != NULL)
1788 {
1789 callback_func_t *cf;
1790 plugin_log_cb callback;
1792 cf = le->value;
1793 callback = cf->cf_callback;
1795 /* do not switch plugin context; rather keep the context
1796 * (interval) information of the calling plugin */
1798 (*callback) (level, msg, &cf->cf_udata);
1800 le = le->next;
1801 }
1802 } /* void plugin_log */
1804 const data_set_t *plugin_get_ds (const char *name)
1805 {
1806 data_set_t *ds;
1808 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1809 {
1810 DEBUG ("No such dataset registered: %s", name);
1811 return (NULL);
1812 }
1814 return (ds);
1815 } /* data_set_t *plugin_get_ds */
1817 static int plugin_notification_meta_add (notification_t *n,
1818 const char *name,
1819 enum notification_meta_type_e type,
1820 const void *value)
1821 {
1822 notification_meta_t *meta;
1823 notification_meta_t *tail;
1825 if ((n == NULL) || (name == NULL) || (value == NULL))
1826 {
1827 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1828 return (-1);
1829 }
1831 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1832 if (meta == NULL)
1833 {
1834 ERROR ("plugin_notification_meta_add: malloc failed.");
1835 return (-1);
1836 }
1837 memset (meta, 0, sizeof (notification_meta_t));
1839 sstrncpy (meta->name, name, sizeof (meta->name));
1840 meta->type = type;
1842 switch (type)
1843 {
1844 case NM_TYPE_STRING:
1845 {
1846 meta->nm_value.nm_string = strdup ((const char *) value);
1847 if (meta->nm_value.nm_string == NULL)
1848 {
1849 ERROR ("plugin_notification_meta_add: strdup failed.");
1850 sfree (meta);
1851 return (-1);
1852 }
1853 break;
1854 }
1855 case NM_TYPE_SIGNED_INT:
1856 {
1857 meta->nm_value.nm_signed_int = *((int64_t *) value);
1858 break;
1859 }
1860 case NM_TYPE_UNSIGNED_INT:
1861 {
1862 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1863 break;
1864 }
1865 case NM_TYPE_DOUBLE:
1866 {
1867 meta->nm_value.nm_double = *((double *) value);
1868 break;
1869 }
1870 case NM_TYPE_BOOLEAN:
1871 {
1872 meta->nm_value.nm_boolean = *((_Bool *) value);
1873 break;
1874 }
1875 default:
1876 {
1877 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1878 sfree (meta);
1879 return (-1);
1880 }
1881 } /* switch (type) */
1883 meta->next = NULL;
1884 tail = n->meta;
1885 while ((tail != NULL) && (tail->next != NULL))
1886 tail = tail->next;
1888 if (tail == NULL)
1889 n->meta = meta;
1890 else
1891 tail->next = meta;
1893 return (0);
1894 } /* int plugin_notification_meta_add */
1896 int plugin_notification_meta_add_string (notification_t *n,
1897 const char *name,
1898 const char *value)
1899 {
1900 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1901 }
1903 int plugin_notification_meta_add_signed_int (notification_t *n,
1904 const char *name,
1905 int64_t value)
1906 {
1907 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1908 }
1910 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1911 const char *name,
1912 uint64_t value)
1913 {
1914 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1915 }
1917 int plugin_notification_meta_add_double (notification_t *n,
1918 const char *name,
1919 double value)
1920 {
1921 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1922 }
1924 int plugin_notification_meta_add_boolean (notification_t *n,
1925 const char *name,
1926 _Bool value)
1927 {
1928 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1929 }
1931 int plugin_notification_meta_copy (notification_t *dst,
1932 const notification_t *src)
1933 {
1934 notification_meta_t *meta;
1936 assert (dst != NULL);
1937 assert (src != NULL);
1938 assert (dst != src);
1939 assert ((src->meta == NULL) || (src->meta != dst->meta));
1941 for (meta = src->meta; meta != NULL; meta = meta->next)
1942 {
1943 if (meta->type == NM_TYPE_STRING)
1944 plugin_notification_meta_add_string (dst, meta->name,
1945 meta->nm_value.nm_string);
1946 else if (meta->type == NM_TYPE_SIGNED_INT)
1947 plugin_notification_meta_add_signed_int (dst, meta->name,
1948 meta->nm_value.nm_signed_int);
1949 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1950 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1951 meta->nm_value.nm_unsigned_int);
1952 else if (meta->type == NM_TYPE_DOUBLE)
1953 plugin_notification_meta_add_double (dst, meta->name,
1954 meta->nm_value.nm_double);
1955 else if (meta->type == NM_TYPE_BOOLEAN)
1956 plugin_notification_meta_add_boolean (dst, meta->name,
1957 meta->nm_value.nm_boolean);
1958 }
1960 return (0);
1961 } /* int plugin_notification_meta_copy */
1963 int plugin_notification_meta_free (notification_meta_t *n)
1964 {
1965 notification_meta_t *this;
1966 notification_meta_t *next;
1968 if (n == NULL)
1969 {
1970 ERROR ("plugin_notification_meta_free: n == NULL!");
1971 return (-1);
1972 }
1974 this = n;
1975 while (this != NULL)
1976 {
1977 next = this->next;
1979 if (this->type == NM_TYPE_STRING)
1980 {
1981 free ((char *)this->nm_value.nm_string);
1982 this->nm_value.nm_string = NULL;
1983 }
1984 sfree (this);
1986 this = next;
1987 }
1989 return (0);
1990 } /* int plugin_notification_meta_free */
1992 static void plugin_ctx_destructor (void *ctx)
1993 {
1994 sfree (ctx);
1995 } /* void plugin_ctx_destructor */
1997 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
1999 static plugin_ctx_t *plugin_ctx_create (void)
2000 {
2001 plugin_ctx_t *ctx;
2003 ctx = malloc (sizeof (*ctx));
2004 if (ctx == NULL) {
2005 char errbuf[1024];
2006 ERROR ("Failed to allocate plugin context: %s",
2007 sstrerror (errno, errbuf, sizeof (errbuf)));
2008 return NULL;
2009 }
2011 *ctx = ctx_init;
2012 assert (plugin_ctx_key_initialized);
2013 pthread_setspecific (plugin_ctx_key, ctx);
2014 DEBUG("Created new plugin context.");
2015 return (ctx);
2016 } /* int plugin_ctx_create */
2018 void plugin_init_ctx (void)
2019 {
2020 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2021 plugin_ctx_key_initialized = 1;
2022 } /* void plugin_init_ctx */
2024 plugin_ctx_t plugin_get_ctx (void)
2025 {
2026 plugin_ctx_t *ctx;
2028 assert (plugin_ctx_key_initialized);
2029 ctx = pthread_getspecific (plugin_ctx_key);
2031 if (ctx == NULL) {
2032 ctx = plugin_ctx_create ();
2033 /* this must no happen -- exit() instead? */
2034 if (ctx == NULL)
2035 return ctx_init;
2036 }
2038 return (*ctx);
2039 } /* plugin_ctx_t plugin_get_ctx */
2041 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2042 {
2043 plugin_ctx_t *c;
2044 plugin_ctx_t old;
2046 assert (plugin_ctx_key_initialized);
2047 c = pthread_getspecific (plugin_ctx_key);
2049 if (c == NULL) {
2050 c = plugin_ctx_create ();
2051 /* this must no happen -- exit() instead? */
2052 if (c == NULL)
2053 return ctx_init;
2054 }
2056 old = *c;
2057 *c = ctx;
2059 return (old);
2060 } /* void plugin_set_ctx */
2062 cdtime_t plugin_get_interval (void)
2063 {
2064 cdtime_t interval;
2066 const char *interval_str;
2067 double interval_dbl;
2069 interval = plugin_get_ctx().interval;
2070 if (interval > 0)
2071 return interval;
2073 /* this should happen during initialization only */
2074 interval_str = global_option_get ("Interval");
2075 if (interval_str != NULL)
2076 {
2077 interval_dbl = atof (interval_str);
2078 if (interval_dbl > 0.0)
2079 interval = DOUBLE_TO_CDTIME_T (interval_dbl);
2080 }
2082 if (interval > 0)
2083 return interval;
2084 return TIME_T_TO_CDTIME_T (10);
2085 } /* cdtime_t plugin_get_interval */
2087 typedef struct {
2088 plugin_ctx_t ctx;
2089 void *(*start_routine) (void *);
2090 void *arg;
2091 } plugin_thread_t;
2093 static void *plugin_thread_start (void *arg)
2094 {
2095 plugin_thread_t *plugin_thread = arg;
2097 void *(*start_routine) (void *) = plugin_thread->start_routine;
2098 void *plugin_arg = plugin_thread->arg;
2100 plugin_set_ctx (plugin_thread->ctx);
2102 free (plugin_thread);
2104 return start_routine (plugin_arg);
2105 } /* void *plugin_thread_start */
2107 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2108 void *(*start_routine) (void *), void *arg)
2109 {
2110 plugin_thread_t *plugin_thread;
2112 plugin_thread = malloc (sizeof (*plugin_thread));
2113 if (plugin_thread == NULL)
2114 return -1;
2116 plugin_thread->ctx = plugin_get_ctx ();
2117 plugin_thread->start_routine = start_routine;
2118 plugin_thread->arg = arg;
2120 return pthread_create (thread, attr,
2121 plugin_thread_start, plugin_thread);
2122 } /* int plugin_thread_create */
2124 /* vim: set sw=8 ts=8 noet fdm=marker : */