002955d5164f96fb66096d0d1224350fd83c4399
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 now = cdtime ();
383 CDTIME_T_TO_TIMESPEC (interval_g, &rf->rf_interval);
385 rf->rf_effective_interval = rf->rf_interval;
387 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
388 }
390 /* sleep until this entry is due,
391 * using pthread_cond_timedwait */
392 pthread_mutex_lock (&read_lock);
393 /* In pthread_cond_timedwait, spurious wakeups are possible
394 * (and really happen, at least on NetBSD with > 1 CPU), thus
395 * we need to re-evaluate the condition every time
396 * pthread_cond_timedwait returns. */
397 rc = 0;
398 while ((read_loop != 0)
399 && !timeout_reached(rf->rf_next_read)
400 && rc == 0)
401 {
402 rc = pthread_cond_timedwait (&read_cond, &read_lock,
403 &rf->rf_next_read);
404 }
406 /* Must hold `read_lock' when accessing `rf->rf_type'. */
407 rf_type = rf->rf_type;
408 pthread_mutex_unlock (&read_lock);
410 /* Check if we're supposed to stop.. This may have interrupted
411 * the sleep, too. */
412 if (read_loop == 0)
413 {
414 /* Insert `rf' again, so it can be free'd correctly */
415 c_heap_insert (read_heap, rf);
416 break;
417 }
419 /* The entry has been marked for deletion. The linked list
420 * entry has already been removed by `plugin_unregister_read'.
421 * All we have to do here is free the `read_func_t' and
422 * continue. */
423 if (rf_type == RF_REMOVE)
424 {
425 DEBUG ("plugin_read_thread: Destroying the `%s' "
426 "callback.", rf->rf_name);
427 destroy_callback ((callback_func_t *) rf);
428 rf = NULL;
429 continue;
430 }
432 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
434 old_ctx = plugin_set_ctx (rf->rf_ctx);
436 if (rf_type == RF_SIMPLE)
437 {
438 int (*callback) (void);
440 callback = rf->rf_callback;
441 status = (*callback) ();
442 }
443 else
444 {
445 plugin_read_cb callback;
447 assert (rf_type == RF_COMPLEX);
449 callback = rf->rf_callback;
450 status = (*callback) (&rf->rf_udata);
451 }
453 plugin_set_ctx (old_ctx);
455 /* If the function signals failure, we will increase the
456 * intervals in which it will be called. */
457 if (status != 0)
458 {
459 rf->rf_effective_interval.tv_sec *= 2;
460 rf->rf_effective_interval.tv_nsec *= 2;
461 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
463 if (rf->rf_effective_interval.tv_sec >= 86400)
464 {
465 rf->rf_effective_interval.tv_sec = 86400;
466 rf->rf_effective_interval.tv_nsec = 0;
467 }
469 NOTICE ("read-function of plugin `%s' failed. "
470 "Will suspend it for %i seconds.",
471 rf->rf_name,
472 (int) rf->rf_effective_interval.tv_sec);
473 }
474 else
475 {
476 /* Success: Restore the interval, if it was changed. */
477 rf->rf_effective_interval = rf->rf_interval;
478 }
480 /* update the ``next read due'' field */
481 now = cdtime ();
483 DEBUG ("plugin_read_thread: Effective interval of the "
484 "%s plugin is %i.%09i.",
485 rf->rf_name,
486 (int) rf->rf_effective_interval.tv_sec,
487 (int) rf->rf_effective_interval.tv_nsec);
489 /* Calculate the next (absolute) time at which this function
490 * should be called. */
491 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
492 + rf->rf_effective_interval.tv_sec;
493 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
494 + rf->rf_effective_interval.tv_nsec;
495 NORMALIZE_TIMESPEC (rf->rf_next_read);
497 /* Check, if `rf_next_read' is in the past. */
498 if (TIMESPEC_TO_CDTIME_T (&rf->rf_next_read) < now)
499 {
500 /* `rf_next_read' is in the past. Insert `now'
501 * so this value doesn't trail off into the
502 * past too much. */
503 CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
504 }
506 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
507 rf->rf_name,
508 (int) rf->rf_next_read.tv_sec,
509 (int) rf->rf_next_read.tv_nsec);
511 /* Re-insert this read function into the heap again. */
512 c_heap_insert (read_heap, rf);
513 } /* while (read_loop) */
515 pthread_exit (NULL);
516 return ((void *) 0);
517 } /* void *plugin_read_thread */
519 static void start_read_threads (int num)
520 {
521 int i;
523 if (read_threads != NULL)
524 return;
526 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
527 if (read_threads == NULL)
528 {
529 ERROR ("plugin: start_read_threads: calloc failed.");
530 return;
531 }
533 read_threads_num = 0;
534 for (i = 0; i < num; i++)
535 {
536 if (pthread_create (read_threads + read_threads_num, NULL,
537 plugin_read_thread, NULL) == 0)
538 {
539 read_threads_num++;
540 }
541 else
542 {
543 ERROR ("plugin: start_read_threads: pthread_create failed.");
544 return;
545 }
546 } /* for (i) */
547 } /* void start_read_threads */
549 static void stop_read_threads (void)
550 {
551 int i;
553 if (read_threads == NULL)
554 return;
556 INFO ("collectd: Stopping %i read threads.", read_threads_num);
558 pthread_mutex_lock (&read_lock);
559 read_loop = 0;
560 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
561 pthread_cond_broadcast (&read_cond);
562 pthread_mutex_unlock (&read_lock);
564 for (i = 0; i < read_threads_num; i++)
565 {
566 if (pthread_join (read_threads[i], NULL) != 0)
567 {
568 ERROR ("plugin: stop_read_threads: pthread_join failed.");
569 }
570 read_threads[i] = (pthread_t) 0;
571 }
572 sfree (read_threads);
573 read_threads_num = 0;
574 } /* void stop_read_threads */
576 /*
577 * Public functions
578 */
579 void plugin_set_dir (const char *dir)
580 {
581 if (plugindir != NULL)
582 free (plugindir);
584 if (dir == NULL)
585 plugindir = NULL;
586 else if ((plugindir = strdup (dir)) == NULL)
587 {
588 char errbuf[1024];
589 ERROR ("strdup failed: %s",
590 sstrerror (errno, errbuf, sizeof (errbuf)));
591 }
592 }
594 #define BUFSIZE 512
595 int plugin_load (const char *type, uint32_t flags)
596 {
597 DIR *dh;
598 const char *dir;
599 char filename[BUFSIZE] = "";
600 char typename[BUFSIZE];
601 int typename_len;
602 int ret;
603 struct stat statbuf;
604 struct dirent *de;
605 int status;
607 DEBUG ("type = %s", type);
609 dir = plugin_get_dir ();
610 ret = 1;
612 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
613 * type when matching the filename */
614 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
615 if ((status < 0) || ((size_t) status >= sizeof (typename)))
616 {
617 WARNING ("snprintf: truncated: `%s.so'", type);
618 return (-1);
619 }
620 typename_len = strlen (typename);
622 if ((dh = opendir (dir)) == NULL)
623 {
624 char errbuf[1024];
625 ERROR ("opendir (%s): %s", dir,
626 sstrerror (errno, errbuf, sizeof (errbuf)));
627 return (-1);
628 }
630 while ((de = readdir (dh)) != NULL)
631 {
632 if (strncasecmp (de->d_name, typename, typename_len))
633 continue;
635 status = ssnprintf (filename, sizeof (filename),
636 "%s/%s", dir, de->d_name);
637 if ((status < 0) || ((size_t) status >= sizeof (filename)))
638 {
639 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
640 continue;
641 }
643 if (lstat (filename, &statbuf) == -1)
644 {
645 char errbuf[1024];
646 WARNING ("stat %s: %s", filename,
647 sstrerror (errno, errbuf, sizeof (errbuf)));
648 continue;
649 }
650 else if (!S_ISREG (statbuf.st_mode))
651 {
652 /* don't follow symlinks */
653 WARNING ("stat %s: not a regular file", filename);
654 continue;
655 }
657 if (plugin_load_file (filename, flags) == 0)
658 {
659 /* success */
660 ret = 0;
661 break;
662 }
663 else
664 {
665 fprintf (stderr, "Unable to load plugin %s.\n", type);
666 }
667 }
669 closedir (dh);
671 if (filename[0] == '\0')
672 fprintf (stderr, "Could not find plugin %s.\n", type);
674 return (ret);
675 }
677 /*
678 * The `register_*' functions follow
679 */
680 int plugin_register_config (const char *name,
681 int (*callback) (const char *key, const char *val),
682 const char **keys, int keys_num)
683 {
684 cf_register (name, callback, keys, keys_num);
685 return (0);
686 } /* int plugin_register_config */
688 int plugin_register_complex_config (const char *type,
689 int (*callback) (oconfig_item_t *))
690 {
691 return (cf_register_complex (type, callback));
692 } /* int plugin_register_complex_config */
694 int plugin_register_init (const char *name,
695 int (*callback) (void))
696 {
697 return (create_register_callback (&list_init, name, (void *) callback,
698 /* user_data = */ NULL));
699 } /* plugin_register_init */
701 static int plugin_compare_read_func (const void *arg0, const void *arg1)
702 {
703 const read_func_t *rf0;
704 const read_func_t *rf1;
706 rf0 = arg0;
707 rf1 = arg1;
709 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
710 return (-1);
711 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
712 return (1);
713 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
714 return (-1);
715 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
716 return (1);
717 else
718 return (0);
719 } /* int plugin_compare_read_func */
721 /* Add a read function to both, the heap and a linked list. The linked list if
722 * used to look-up read functions, especially for the remove function. The heap
723 * is used to determine which plugin to read next. */
724 static int plugin_insert_read (read_func_t *rf)
725 {
726 int status;
727 llentry_t *le;
729 pthread_mutex_lock (&read_lock);
731 if (read_list == NULL)
732 {
733 read_list = llist_create ();
734 if (read_list == NULL)
735 {
736 pthread_mutex_unlock (&read_lock);
737 ERROR ("plugin_insert_read: read_list failed.");
738 return (-1);
739 }
740 }
742 if (read_heap == NULL)
743 {
744 read_heap = c_heap_create (plugin_compare_read_func);
745 if (read_heap == NULL)
746 {
747 pthread_mutex_unlock (&read_lock);
748 ERROR ("plugin_insert_read: c_heap_create failed.");
749 return (-1);
750 }
751 }
753 le = llist_search (read_list, rf->rf_name);
754 if (le != NULL)
755 {
756 pthread_mutex_unlock (&read_lock);
757 WARNING ("The read function \"%s\" is already registered. "
758 "Check for duplicate \"LoadPlugin\" lines "
759 "in your configuration!",
760 rf->rf_name);
761 return (EINVAL);
762 }
764 le = llentry_create (rf->rf_name, rf);
765 if (le == NULL)
766 {
767 pthread_mutex_unlock (&read_lock);
768 ERROR ("plugin_insert_read: llentry_create failed.");
769 return (-1);
770 }
772 status = c_heap_insert (read_heap, rf);
773 if (status != 0)
774 {
775 pthread_mutex_unlock (&read_lock);
776 ERROR ("plugin_insert_read: c_heap_insert failed.");
777 llentry_destroy (le);
778 return (-1);
779 }
781 /* This does not fail. */
782 llist_append (read_list, le);
784 pthread_mutex_unlock (&read_lock);
785 return (0);
786 } /* int plugin_insert_read */
788 static int read_cb_wrapper (user_data_t *ud)
789 {
790 int (*callback) (void);
792 if (ud == NULL)
793 return -1;
795 callback = ud->data;
796 return callback();
797 } /* int read_cb_wrapper */
799 int plugin_register_read (const char *name,
800 int (*callback) (void))
801 {
802 read_func_t *rf;
803 plugin_ctx_t ctx = plugin_get_ctx ();
804 int status;
806 if (ctx.interval != 0) {
807 /* If ctx.interval is not zero (== use interval_g), we need to
808 * use the "complex" read callback, because only that allows to
809 * specify a different interval. Wrap the callback using
810 * read_cb_wrapper(). */
811 struct timespec interval;
812 user_data_t user_data;
814 DEBUG ("plugin_register_read: plugin_interval = %.3f",
815 CDTIME_T_TO_DOUBLE(plugin_interval));
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 rf = malloc (sizeof (*rf));
826 if (rf == NULL)
827 {
828 ERROR ("plugin_register_read: malloc failed.");
829 return (ENOMEM);
830 }
832 memset (rf, 0, sizeof (read_func_t));
833 rf->rf_callback = (void *) callback;
834 rf->rf_udata.data = NULL;
835 rf->rf_udata.free_func = NULL;
836 rf->rf_ctx = ctx;
837 rf->rf_group[0] = '\0';
838 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
839 rf->rf_type = RF_SIMPLE;
840 rf->rf_interval.tv_sec = 0;
841 rf->rf_interval.tv_nsec = 0;
842 rf->rf_effective_interval = rf->rf_interval;
844 status = plugin_insert_read (rf);
845 if (status != 0)
846 sfree (rf);
848 return (status);
849 } /* int plugin_register_read */
851 int plugin_register_complex_read (const char *group, const char *name,
852 plugin_read_cb callback,
853 const struct timespec *interval,
854 user_data_t *user_data)
855 {
856 read_func_t *rf;
857 plugin_ctx_t ctx = plugin_get_ctx ();
858 int status;
860 rf = malloc (sizeof (*rf));
861 if (rf == NULL)
862 {
863 ERROR ("plugin_register_complex_read: malloc failed.");
864 return (ENOMEM);
865 }
867 memset (rf, 0, sizeof (read_func_t));
868 rf->rf_callback = (void *) callback;
869 if (group != NULL)
870 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
871 else
872 rf->rf_group[0] = '\0';
873 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
874 rf->rf_type = RF_COMPLEX;
875 if (interval != NULL)
876 {
877 rf->rf_interval = *interval;
878 }
879 else if (ctx.interval != 0)
880 {
881 CDTIME_T_TO_TIMESPEC (ctx.interval, &rf->rf_interval);
882 }
883 rf->rf_effective_interval = rf->rf_interval;
885 /* Set user data */
886 if (user_data == NULL)
887 {
888 rf->rf_udata.data = NULL;
889 rf->rf_udata.free_func = NULL;
890 }
891 else
892 {
893 rf->rf_udata = *user_data;
894 }
896 rf->rf_ctx = ctx;
898 status = plugin_insert_read (rf);
899 if (status != 0)
900 sfree (rf);
902 return (status);
903 } /* int plugin_register_complex_read */
905 int plugin_register_write (const char *name,
906 plugin_write_cb callback, user_data_t *ud)
907 {
908 return (create_register_callback (&list_write, name,
909 (void *) callback, ud));
910 } /* int plugin_register_write */
912 int plugin_register_flush (const char *name,
913 plugin_flush_cb callback, user_data_t *ud)
914 {
915 return (create_register_callback (&list_flush, name,
916 (void *) callback, ud));
917 } /* int plugin_register_flush */
919 int plugin_register_missing (const char *name,
920 plugin_missing_cb callback, user_data_t *ud)
921 {
922 return (create_register_callback (&list_missing, name,
923 (void *) callback, ud));
924 } /* int plugin_register_missing */
926 int plugin_register_shutdown (const char *name,
927 int (*callback) (void))
928 {
929 return (create_register_callback (&list_shutdown, name,
930 (void *) callback, /* user_data = */ NULL));
931 } /* int plugin_register_shutdown */
933 int plugin_register_data_set (const data_set_t *ds)
934 {
935 data_set_t *ds_copy;
936 int i;
938 if ((data_sets != NULL)
939 && (c_avl_get (data_sets, ds->type, NULL) == 0))
940 {
941 NOTICE ("Replacing DS `%s' with another version.", ds->type);
942 plugin_unregister_data_set (ds->type);
943 }
944 else if (data_sets == NULL)
945 {
946 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
947 if (data_sets == NULL)
948 return (-1);
949 }
951 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
952 if (ds_copy == NULL)
953 return (-1);
954 memcpy(ds_copy, ds, sizeof (data_set_t));
956 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
957 * ds->ds_num);
958 if (ds_copy->ds == NULL)
959 {
960 free (ds_copy);
961 return (-1);
962 }
964 for (i = 0; i < ds->ds_num; i++)
965 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
967 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
968 } /* int plugin_register_data_set */
970 int plugin_register_log (const char *name,
971 plugin_log_cb callback, user_data_t *ud)
972 {
973 return (create_register_callback (&list_log, name,
974 (void *) callback, ud));
975 } /* int plugin_register_log */
977 int plugin_register_notification (const char *name,
978 plugin_notification_cb callback, user_data_t *ud)
979 {
980 return (create_register_callback (&list_notification, name,
981 (void *) callback, ud));
982 } /* int plugin_register_log */
984 int plugin_unregister_config (const char *name)
985 {
986 cf_unregister (name);
987 return (0);
988 } /* int plugin_unregister_config */
990 int plugin_unregister_complex_config (const char *name)
991 {
992 cf_unregister_complex (name);
993 return (0);
994 } /* int plugin_unregister_complex_config */
996 int plugin_unregister_init (const char *name)
997 {
998 return (plugin_unregister (list_init, name));
999 }
1001 int plugin_unregister_read (const char *name) /* {{{ */
1002 {
1003 llentry_t *le;
1004 read_func_t *rf;
1006 if (name == NULL)
1007 return (-ENOENT);
1009 pthread_mutex_lock (&read_lock);
1011 if (read_list == NULL)
1012 {
1013 pthread_mutex_unlock (&read_lock);
1014 return (-ENOENT);
1015 }
1017 le = llist_search (read_list, name);
1018 if (le == NULL)
1019 {
1020 pthread_mutex_unlock (&read_lock);
1021 WARNING ("plugin_unregister_read: No such read function: %s",
1022 name);
1023 return (-ENOENT);
1024 }
1026 llist_remove (read_list, le);
1028 rf = le->value;
1029 assert (rf != NULL);
1030 rf->rf_type = RF_REMOVE;
1032 pthread_mutex_unlock (&read_lock);
1034 llentry_destroy (le);
1036 DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1038 return (0);
1039 } /* }}} int plugin_unregister_read */
1041 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1042 {
1043 read_func_t *rf = e->value;
1044 char *group = ud;
1046 return strcmp (rf->rf_group, (const char *)group);
1047 } /* }}} int compare_read_func_group */
1049 int plugin_unregister_read_group (const char *group) /* {{{ */
1050 {
1051 llentry_t *le;
1052 read_func_t *rf;
1054 int found = 0;
1056 if (group == NULL)
1057 return (-ENOENT);
1059 pthread_mutex_lock (&read_lock);
1061 if (read_list == NULL)
1062 {
1063 pthread_mutex_unlock (&read_lock);
1064 return (-ENOENT);
1065 }
1067 while (42)
1068 {
1069 le = llist_search_custom (read_list,
1070 compare_read_func_group, (void *)group);
1072 if (le == NULL)
1073 break;
1075 ++found;
1077 llist_remove (read_list, le);
1079 rf = le->value;
1080 assert (rf != NULL);
1081 rf->rf_type = RF_REMOVE;
1083 llentry_destroy (le);
1085 DEBUG ("plugin_unregister_read_group: "
1086 "Marked `%s' (group `%s') for removal.",
1087 rf->rf_name, group);
1088 }
1090 pthread_mutex_unlock (&read_lock);
1092 if (found == 0)
1093 {
1094 WARNING ("plugin_unregister_read_group: No such "
1095 "group of read function: %s", group);
1096 return (-ENOENT);
1097 }
1099 return (0);
1100 } /* }}} int plugin_unregister_read_group */
1102 int plugin_unregister_write (const char *name)
1103 {
1104 return (plugin_unregister (list_write, name));
1105 }
1107 int plugin_unregister_flush (const char *name)
1108 {
1109 return (plugin_unregister (list_flush, name));
1110 }
1112 int plugin_unregister_missing (const char *name)
1113 {
1114 return (plugin_unregister (list_missing, name));
1115 }
1117 int plugin_unregister_shutdown (const char *name)
1118 {
1119 return (plugin_unregister (list_shutdown, name));
1120 }
1122 int plugin_unregister_data_set (const char *name)
1123 {
1124 data_set_t *ds;
1126 if (data_sets == NULL)
1127 return (-1);
1129 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1130 return (-1);
1132 sfree (ds->ds);
1133 sfree (ds);
1135 return (0);
1136 } /* int plugin_unregister_data_set */
1138 int plugin_unregister_log (const char *name)
1139 {
1140 return (plugin_unregister (list_log, name));
1141 }
1143 int plugin_unregister_notification (const char *name)
1144 {
1145 return (plugin_unregister (list_notification, name));
1146 }
1148 void plugin_init_all (void)
1149 {
1150 const char *chain_name;
1151 llentry_t *le;
1152 int status;
1154 /* Init the value cache */
1155 uc_init ();
1157 chain_name = global_option_get ("PreCacheChain");
1158 pre_cache_chain = fc_chain_get_by_name (chain_name);
1160 chain_name = global_option_get ("PostCacheChain");
1161 post_cache_chain = fc_chain_get_by_name (chain_name);
1164 if ((list_init == NULL) && (read_heap == NULL))
1165 return;
1167 /* Calling all init callbacks before checking if read callbacks
1168 * are available allows the init callbacks to register the read
1169 * callback. */
1170 le = llist_head (list_init);
1171 while (le != NULL)
1172 {
1173 callback_func_t *cf;
1174 plugin_init_cb callback;
1175 plugin_ctx_t old_ctx;
1177 cf = le->value;
1178 old_ctx = plugin_set_ctx (cf->cf_ctx);
1179 callback = cf->cf_callback;
1180 status = (*callback) ();
1181 plugin_set_ctx (old_ctx);
1183 if (status != 0)
1184 {
1185 ERROR ("Initialization of plugin `%s' "
1186 "failed with status %i. "
1187 "Plugin will be unloaded.",
1188 le->key, status);
1189 /* Plugins that register read callbacks from the init
1190 * callback should take care of appropriate error
1191 * handling themselves. */
1192 /* FIXME: Unload _all_ functions */
1193 plugin_unregister_read (le->key);
1194 }
1196 le = le->next;
1197 }
1199 /* Start read-threads */
1200 if (read_heap != NULL)
1201 {
1202 const char *rt;
1203 int num;
1204 rt = global_option_get ("ReadThreads");
1205 num = atoi (rt);
1206 if (num != -1)
1207 start_read_threads ((num > 0) ? num : 5);
1208 }
1209 } /* void plugin_init_all */
1211 /* TODO: Rename this function. */
1212 void plugin_read_all (void)
1213 {
1214 uc_check_timeout ();
1216 return;
1217 } /* void plugin_read_all */
1219 /* Read function called when the `-T' command line argument is given. */
1220 int plugin_read_all_once (void)
1221 {
1222 int status;
1223 int return_status = 0;
1225 if (read_heap == NULL)
1226 {
1227 NOTICE ("No read-functions are registered.");
1228 return (0);
1229 }
1231 while (42)
1232 {
1233 read_func_t *rf;
1234 plugin_ctx_t old_ctx;
1236 rf = c_heap_get_root (read_heap);
1237 if (rf == NULL)
1238 break;
1240 old_ctx = plugin_set_ctx (rf->rf_ctx);
1242 if (rf->rf_type == RF_SIMPLE)
1243 {
1244 int (*callback) (void);
1246 callback = rf->rf_callback;
1247 status = (*callback) ();
1248 }
1249 else
1250 {
1251 plugin_read_cb callback;
1253 callback = rf->rf_callback;
1254 status = (*callback) (&rf->rf_udata);
1255 }
1257 plugin_set_ctx (old_ctx);
1259 if (status != 0)
1260 {
1261 NOTICE ("read-function of plugin `%s' failed.",
1262 rf->rf_name);
1263 return_status = -1;
1264 }
1266 destroy_callback ((void *) rf);
1267 }
1269 return (return_status);
1270 } /* int plugin_read_all_once */
1272 int plugin_write (const char *plugin, /* {{{ */
1273 const data_set_t *ds, const value_list_t *vl)
1274 {
1275 llentry_t *le;
1276 int status;
1278 if (vl == NULL)
1279 return (EINVAL);
1281 if (list_write == NULL)
1282 return (ENOENT);
1284 if (ds == NULL)
1285 {
1286 ds = plugin_get_ds (vl->type);
1287 if (ds == NULL)
1288 {
1289 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1290 return (ENOENT);
1291 }
1292 }
1294 if (plugin == NULL)
1295 {
1296 int success = 0;
1297 int failure = 0;
1299 le = llist_head (list_write);
1300 while (le != NULL)
1301 {
1302 callback_func_t *cf = le->value;
1303 plugin_write_cb callback;
1304 plugin_ctx_t old_ctx = plugin_set_ctx (cf->cf_ctx);
1306 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1307 callback = cf->cf_callback;
1308 status = (*callback) (ds, vl, &cf->cf_udata);
1309 if (status != 0)
1310 failure++;
1311 else
1312 success++;
1314 plugin_set_ctx (old_ctx);
1316 le = le->next;
1317 }
1319 if ((success == 0) && (failure != 0))
1320 status = -1;
1321 else
1322 status = 0;
1323 }
1324 else /* plugin != NULL */
1325 {
1326 callback_func_t *cf;
1327 plugin_write_cb callback;
1328 plugin_ctx_t old_ctx;
1330 le = llist_head (list_write);
1331 while (le != NULL)
1332 {
1333 if (strcasecmp (plugin, le->key) == 0)
1334 break;
1336 le = le->next;
1337 }
1339 if (le == NULL)
1340 return (ENOENT);
1342 cf = le->value;
1344 old_ctx = plugin_set_ctx (cf->cf_ctx);
1346 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1347 callback = cf->cf_callback;
1348 status = (*callback) (ds, vl, &cf->cf_udata);
1350 plugin_set_ctx (old_ctx);
1351 }
1353 return (status);
1354 } /* }}} int plugin_write */
1356 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1357 {
1358 llentry_t *le;
1360 if (list_flush == NULL)
1361 return (0);
1363 le = llist_head (list_flush);
1364 while (le != NULL)
1365 {
1366 callback_func_t *cf;
1367 plugin_flush_cb callback;
1368 plugin_ctx_t old_ctx;
1370 if ((plugin != NULL)
1371 && (strcmp (plugin, le->key) != 0))
1372 {
1373 le = le->next;
1374 continue;
1375 }
1377 cf = le->value;
1378 old_ctx = plugin_set_ctx (cf->cf_ctx);
1379 callback = cf->cf_callback;
1381 (*callback) (timeout, identifier, &cf->cf_udata);
1383 plugin_set_ctx (old_ctx);
1385 le = le->next;
1386 }
1387 return (0);
1388 } /* int plugin_flush */
1390 void plugin_shutdown_all (void)
1391 {
1392 llentry_t *le;
1394 stop_read_threads ();
1396 destroy_all_callbacks (&list_init);
1398 pthread_mutex_lock (&read_lock);
1399 llist_destroy (read_list);
1400 read_list = NULL;
1401 pthread_mutex_unlock (&read_lock);
1403 destroy_read_heap ();
1405 plugin_flush (/* plugin = */ NULL,
1406 /* timeout = */ 0,
1407 /* identifier = */ NULL);
1409 le = NULL;
1410 if (list_shutdown != NULL)
1411 le = llist_head (list_shutdown);
1413 while (le != NULL)
1414 {
1415 callback_func_t *cf;
1416 plugin_shutdown_cb callback;
1417 plugin_ctx_t old_ctx;
1419 cf = le->value;
1420 old_ctx = plugin_set_ctx (cf->cf_ctx);
1421 callback = cf->cf_callback;
1423 /* Advance the pointer before calling the callback allows
1424 * shutdown functions to unregister themselves. If done the
1425 * other way around the memory `le' points to will be freed
1426 * after callback returns. */
1427 le = le->next;
1429 (*callback) ();
1431 plugin_set_ctx (old_ctx);
1432 }
1434 /* Write plugins which use the `user_data' pointer usually need the
1435 * same data available to the flush callback. If this is the case, set
1436 * the free_function to NULL when registering the flush callback and to
1437 * the real free function when registering the write callback. This way
1438 * the data isn't freed twice. */
1439 destroy_all_callbacks (&list_flush);
1440 destroy_all_callbacks (&list_missing);
1441 destroy_all_callbacks (&list_write);
1443 destroy_all_callbacks (&list_notification);
1444 destroy_all_callbacks (&list_shutdown);
1445 destroy_all_callbacks (&list_log);
1446 } /* void plugin_shutdown_all */
1448 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1449 {
1450 llentry_t *le;
1452 if (list_missing == NULL)
1453 return (0);
1455 le = llist_head (list_missing);
1456 while (le != NULL)
1457 {
1458 callback_func_t *cf;
1459 plugin_missing_cb callback;
1460 plugin_ctx_t old_ctx;
1461 int status;
1463 cf = le->value;
1464 old_ctx = plugin_set_ctx (cf->cf_ctx);
1465 callback = cf->cf_callback;
1467 status = (*callback) (vl, &cf->cf_udata);
1468 plugin_set_ctx (old_ctx);
1469 if (status != 0)
1470 {
1471 if (status < 0)
1472 {
1473 ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1474 "failed with status %i.",
1475 le->key, status);
1476 return (status);
1477 }
1478 else
1479 {
1480 return (0);
1481 }
1482 }
1484 le = le->next;
1485 }
1486 return (0);
1487 } /* int }}} plugin_dispatch_missing */
1489 int plugin_dispatch_values (value_list_t *vl)
1490 {
1491 int status;
1492 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1494 value_t *saved_values;
1495 int saved_values_len;
1497 data_set_t *ds;
1499 int free_meta_data = 0;
1501 if ((vl == NULL) || (vl->type[0] == 0)
1502 || (vl->values == NULL) || (vl->values_len < 1))
1503 {
1504 ERROR ("plugin_dispatch_values: Invalid value list "
1505 "from plugin %s.", vl->plugin);
1506 return (-1);
1507 }
1509 /* Free meta data only if the calling function didn't specify any. In
1510 * this case matches and targets may add some and the calling function
1511 * may not expect (and therefore free) that data. */
1512 if (vl->meta == NULL)
1513 free_meta_data = 1;
1515 if (list_write == NULL)
1516 c_complain_once (LOG_WARNING, &no_write_complaint,
1517 "plugin_dispatch_values: No write callback has been "
1518 "registered. Please load at least one output plugin, "
1519 "if you want the collected data to be stored.");
1521 if (data_sets == NULL)
1522 {
1523 ERROR ("plugin_dispatch_values: No data sets registered. "
1524 "Could the types database be read? Check "
1525 "your `TypesDB' setting!");
1526 return (-1);
1527 }
1529 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1530 {
1531 char ident[6 * DATA_MAX_NAME_LEN];
1533 FORMAT_VL (ident, sizeof (ident), vl);
1534 INFO ("plugin_dispatch_values: Dataset not found: %s "
1535 "(from \"%s\"), check your types.db!",
1536 vl->type, ident);
1537 return (-1);
1538 }
1540 if (vl->time == 0)
1541 vl->time = cdtime ();
1543 if (vl->interval <= 0) {
1544 plugin_ctx_t ctx = plugin_get_ctx ();
1546 if (ctx.interval != 0)
1547 vl->interval = ctx.interval;
1548 else
1549 vl->interval = interval_g;
1550 }
1552 DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1553 "host = %s; "
1554 "plugin = %s; plugin_instance = %s; "
1555 "type = %s; type_instance = %s;",
1556 CDTIME_T_TO_DOUBLE (vl->time),
1557 CDTIME_T_TO_DOUBLE (vl->interval),
1558 vl->host,
1559 vl->plugin, vl->plugin_instance,
1560 vl->type, vl->type_instance);
1562 #if COLLECT_DEBUG
1563 assert (0 == strcmp (ds->type, vl->type));
1564 #else
1565 if (0 != strcmp (ds->type, vl->type))
1566 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1567 ds->type, vl->type);
1568 #endif
1570 #if COLLECT_DEBUG
1571 assert (ds->ds_num == vl->values_len);
1572 #else
1573 if (ds->ds_num != vl->values_len)
1574 {
1575 ERROR ("plugin_dispatch_values: ds->type = %s: "
1576 "(ds->ds_num = %i) != "
1577 "(vl->values_len = %i)",
1578 ds->type, ds->ds_num, vl->values_len);
1579 return (-1);
1580 }
1581 #endif
1583 escape_slashes (vl->host, sizeof (vl->host));
1584 escape_slashes (vl->plugin, sizeof (vl->plugin));
1585 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1586 escape_slashes (vl->type, sizeof (vl->type));
1587 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1589 /* Copy the values. This way, we can assure `targets' that they get
1590 * dynamically allocated values, which they can free and replace if
1591 * they like. */
1592 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1593 {
1594 saved_values = vl->values;
1595 saved_values_len = vl->values_len;
1597 vl->values = (value_t *) calloc (vl->values_len,
1598 sizeof (*vl->values));
1599 if (vl->values == NULL)
1600 {
1601 ERROR ("plugin_dispatch_values: calloc failed.");
1602 vl->values = saved_values;
1603 return (-1);
1604 }
1605 memcpy (vl->values, saved_values,
1606 vl->values_len * sizeof (*vl->values));
1607 }
1608 else /* if ((pre == NULL) && (post == NULL)) */
1609 {
1610 saved_values = NULL;
1611 saved_values_len = 0;
1612 }
1614 if (pre_cache_chain != NULL)
1615 {
1616 status = fc_process_chain (ds, vl, pre_cache_chain);
1617 if (status < 0)
1618 {
1619 WARNING ("plugin_dispatch_values: Running the "
1620 "pre-cache chain failed with "
1621 "status %i (%#x).",
1622 status, status);
1623 }
1624 else if (status == FC_TARGET_STOP)
1625 {
1626 /* Restore the state of the value_list so that plugins
1627 * don't get confused.. */
1628 if (saved_values != NULL)
1629 {
1630 free (vl->values);
1631 vl->values = saved_values;
1632 vl->values_len = saved_values_len;
1633 }
1634 return (0);
1635 }
1636 }
1638 /* Update the value cache */
1639 uc_update (ds, vl);
1641 if (post_cache_chain != NULL)
1642 {
1643 status = fc_process_chain (ds, vl, post_cache_chain);
1644 if (status < 0)
1645 {
1646 WARNING ("plugin_dispatch_values: Running the "
1647 "post-cache chain failed with "
1648 "status %i (%#x).",
1649 status, status);
1650 }
1651 }
1652 else
1653 fc_default_action (ds, vl);
1655 /* Restore the state of the value_list so that plugins don't get
1656 * confused.. */
1657 if (saved_values != NULL)
1658 {
1659 free (vl->values);
1660 vl->values = saved_values;
1661 vl->values_len = saved_values_len;
1662 }
1664 if ((free_meta_data != 0) && (vl->meta != NULL))
1665 {
1666 meta_data_destroy (vl->meta);
1667 vl->meta = NULL;
1668 }
1670 return (0);
1671 } /* int plugin_dispatch_values */
1673 int plugin_dispatch_values_secure (const value_list_t *vl)
1674 {
1675 value_list_t vl_copy;
1676 int status;
1678 if (vl == NULL)
1679 return EINVAL;
1681 memcpy (&vl_copy, vl, sizeof (vl_copy));
1683 /* Write callbacks must not change the values and meta pointers, so we can
1684 * savely skip copying those and make this more efficient. */
1685 if ((pre_cache_chain == NULL) && (post_cache_chain == NULL))
1686 return (plugin_dispatch_values (&vl_copy));
1688 /* Set pointers to NULL, just to be on the save side. */
1689 vl_copy.values = NULL;
1690 vl_copy.meta = NULL;
1692 vl_copy.values = malloc (sizeof (*vl_copy.values) * vl->values_len);
1693 if (vl_copy.values == NULL)
1694 {
1695 ERROR ("plugin_dispatch_values_secure: malloc failed.");
1696 return (ENOMEM);
1697 }
1698 memcpy (vl_copy.values, vl->values, sizeof (*vl_copy.values) * vl->values_len);
1700 if (vl->meta != NULL)
1701 {
1702 vl_copy.meta = meta_data_clone (vl->meta);
1703 if (vl_copy.meta == NULL)
1704 {
1705 ERROR ("plugin_dispatch_values_secure: meta_data_clone failed.");
1706 free (vl_copy.values);
1707 return (ENOMEM);
1708 }
1709 } /* if (vl->meta) */
1711 status = plugin_dispatch_values (&vl_copy);
1713 meta_data_destroy (vl_copy.meta);
1714 free (vl_copy.values);
1716 return (status);
1717 } /* int plugin_dispatch_values_secure */
1719 int plugin_dispatch_notification (const notification_t *notif)
1720 {
1721 llentry_t *le;
1722 /* Possible TODO: Add flap detection here */
1724 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1725 "time = %.3f; host = %s;",
1726 notif->severity, notif->message,
1727 CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1729 /* Nobody cares for notifications */
1730 if (list_notification == NULL)
1731 return (-1);
1733 le = llist_head (list_notification);
1734 while (le != NULL)
1735 {
1736 callback_func_t *cf;
1737 plugin_notification_cb callback;
1738 plugin_ctx_t old_ctx;
1739 int status;
1741 cf = le->value;
1742 old_ctx = plugin_set_ctx (cf->cf_ctx);
1743 callback = cf->cf_callback;
1744 status = (*callback) (notif, &cf->cf_udata);
1745 plugin_set_ctx (old_ctx);
1746 if (status != 0)
1747 {
1748 WARNING ("plugin_dispatch_notification: Notification "
1749 "callback %s returned %i.",
1750 le->key, status);
1751 }
1753 le = le->next;
1754 }
1756 return (0);
1757 } /* int plugin_dispatch_notification */
1759 void plugin_log (int level, const char *format, ...)
1760 {
1761 char msg[1024];
1762 va_list ap;
1763 llentry_t *le;
1765 #if !COLLECT_DEBUG
1766 if (level >= LOG_DEBUG)
1767 return;
1768 #endif
1770 va_start (ap, format);
1771 vsnprintf (msg, sizeof (msg), format, ap);
1772 msg[sizeof (msg) - 1] = '\0';
1773 va_end (ap);
1775 if (list_log == NULL)
1776 {
1777 fprintf (stderr, "%s\n", msg);
1778 return;
1779 }
1781 le = llist_head (list_log);
1782 while (le != NULL)
1783 {
1784 callback_func_t *cf;
1785 plugin_log_cb callback;
1786 plugin_ctx_t old_ctx;
1788 cf = le->value;
1789 old_ctx = plugin_set_ctx (cf->cf_ctx);
1790 callback = cf->cf_callback;
1792 (*callback) (level, msg, &cf->cf_udata);
1794 plugin_set_ctx (old_ctx);
1795 le = le->next;
1796 }
1797 } /* void plugin_log */
1799 const data_set_t *plugin_get_ds (const char *name)
1800 {
1801 data_set_t *ds;
1803 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1804 {
1805 DEBUG ("No such dataset registered: %s", name);
1806 return (NULL);
1807 }
1809 return (ds);
1810 } /* data_set_t *plugin_get_ds */
1812 static int plugin_notification_meta_add (notification_t *n,
1813 const char *name,
1814 enum notification_meta_type_e type,
1815 const void *value)
1816 {
1817 notification_meta_t *meta;
1818 notification_meta_t *tail;
1820 if ((n == NULL) || (name == NULL) || (value == NULL))
1821 {
1822 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1823 return (-1);
1824 }
1826 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1827 if (meta == NULL)
1828 {
1829 ERROR ("plugin_notification_meta_add: malloc failed.");
1830 return (-1);
1831 }
1832 memset (meta, 0, sizeof (notification_meta_t));
1834 sstrncpy (meta->name, name, sizeof (meta->name));
1835 meta->type = type;
1837 switch (type)
1838 {
1839 case NM_TYPE_STRING:
1840 {
1841 meta->nm_value.nm_string = strdup ((const char *) value);
1842 if (meta->nm_value.nm_string == NULL)
1843 {
1844 ERROR ("plugin_notification_meta_add: strdup failed.");
1845 sfree (meta);
1846 return (-1);
1847 }
1848 break;
1849 }
1850 case NM_TYPE_SIGNED_INT:
1851 {
1852 meta->nm_value.nm_signed_int = *((int64_t *) value);
1853 break;
1854 }
1855 case NM_TYPE_UNSIGNED_INT:
1856 {
1857 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1858 break;
1859 }
1860 case NM_TYPE_DOUBLE:
1861 {
1862 meta->nm_value.nm_double = *((double *) value);
1863 break;
1864 }
1865 case NM_TYPE_BOOLEAN:
1866 {
1867 meta->nm_value.nm_boolean = *((_Bool *) value);
1868 break;
1869 }
1870 default:
1871 {
1872 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1873 sfree (meta);
1874 return (-1);
1875 }
1876 } /* switch (type) */
1878 meta->next = NULL;
1879 tail = n->meta;
1880 while ((tail != NULL) && (tail->next != NULL))
1881 tail = tail->next;
1883 if (tail == NULL)
1884 n->meta = meta;
1885 else
1886 tail->next = meta;
1888 return (0);
1889 } /* int plugin_notification_meta_add */
1891 int plugin_notification_meta_add_string (notification_t *n,
1892 const char *name,
1893 const char *value)
1894 {
1895 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1896 }
1898 int plugin_notification_meta_add_signed_int (notification_t *n,
1899 const char *name,
1900 int64_t value)
1901 {
1902 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1903 }
1905 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1906 const char *name,
1907 uint64_t value)
1908 {
1909 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1910 }
1912 int plugin_notification_meta_add_double (notification_t *n,
1913 const char *name,
1914 double value)
1915 {
1916 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1917 }
1919 int plugin_notification_meta_add_boolean (notification_t *n,
1920 const char *name,
1921 _Bool value)
1922 {
1923 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1924 }
1926 int plugin_notification_meta_copy (notification_t *dst,
1927 const notification_t *src)
1928 {
1929 notification_meta_t *meta;
1931 assert (dst != NULL);
1932 assert (src != NULL);
1933 assert (dst != src);
1934 assert ((src->meta == NULL) || (src->meta != dst->meta));
1936 for (meta = src->meta; meta != NULL; meta = meta->next)
1937 {
1938 if (meta->type == NM_TYPE_STRING)
1939 plugin_notification_meta_add_string (dst, meta->name,
1940 meta->nm_value.nm_string);
1941 else if (meta->type == NM_TYPE_SIGNED_INT)
1942 plugin_notification_meta_add_signed_int (dst, meta->name,
1943 meta->nm_value.nm_signed_int);
1944 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1945 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1946 meta->nm_value.nm_unsigned_int);
1947 else if (meta->type == NM_TYPE_DOUBLE)
1948 plugin_notification_meta_add_double (dst, meta->name,
1949 meta->nm_value.nm_double);
1950 else if (meta->type == NM_TYPE_BOOLEAN)
1951 plugin_notification_meta_add_boolean (dst, meta->name,
1952 meta->nm_value.nm_boolean);
1953 }
1955 return (0);
1956 } /* int plugin_notification_meta_copy */
1958 int plugin_notification_meta_free (notification_meta_t *n)
1959 {
1960 notification_meta_t *this;
1961 notification_meta_t *next;
1963 if (n == NULL)
1964 {
1965 ERROR ("plugin_notification_meta_free: n == NULL!");
1966 return (-1);
1967 }
1969 this = n;
1970 while (this != NULL)
1971 {
1972 next = this->next;
1974 if (this->type == NM_TYPE_STRING)
1975 {
1976 free ((char *)this->nm_value.nm_string);
1977 this->nm_value.nm_string = NULL;
1978 }
1979 sfree (this);
1981 this = next;
1982 }
1984 return (0);
1985 } /* int plugin_notification_meta_free */
1987 static void plugin_ctx_destructor (void *ctx)
1988 {
1989 sfree (ctx);
1990 } /* void plugin_ctx_destructor */
1992 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
1994 static plugin_ctx_t *plugin_ctx_create (void)
1995 {
1996 plugin_ctx_t *ctx;
1998 ctx = malloc (sizeof (*ctx));
1999 if (ctx == NULL) {
2000 char errbuf[1024];
2001 ERROR ("Failed to allocate plugin context: %s",
2002 sstrerror (errno, errbuf, sizeof (errbuf)));
2003 return NULL;
2004 }
2006 *ctx = ctx_init;
2007 assert (plugin_ctx_key_initialized);
2008 pthread_setspecific (plugin_ctx_key, ctx);
2009 DEBUG("Created new plugin context.");
2010 return (ctx);
2011 } /* int plugin_ctx_create */
2013 void plugin_init_ctx (void)
2014 {
2015 pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2016 plugin_ctx_key_initialized = 1;
2017 } /* void plugin_init_ctx */
2019 plugin_ctx_t plugin_get_ctx (void)
2020 {
2021 plugin_ctx_t *ctx;
2023 assert (plugin_ctx_key_initialized);
2024 ctx = pthread_getspecific (plugin_ctx_key);
2026 if (ctx == NULL) {
2027 ctx = plugin_ctx_create ();
2028 /* this must no happen -- exit() instead? */
2029 if (ctx == NULL)
2030 return ctx_init;
2031 }
2033 return (*ctx);
2034 } /* plugin_ctx_t plugin_get_ctx */
2036 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2037 {
2038 plugin_ctx_t *c;
2039 plugin_ctx_t old;
2041 assert (plugin_ctx_key_initialized);
2042 c = pthread_getspecific (plugin_ctx_key);
2044 if (c == NULL) {
2045 c = plugin_ctx_create ();
2046 /* this must no happen -- exit() instead? */
2047 if (c == NULL)
2048 return ctx_init;
2049 }
2051 old = *c;
2052 *c = ctx;
2054 return (old);
2055 } /* void plugin_set_ctx */
2057 cdtime_t plugin_get_interval (void)
2058 {
2059 cdtime_t interval;
2061 const char *interval_str;
2062 double interval_dbl;
2064 interval = plugin_get_ctx().interval;
2065 if (interval > 0)
2066 return interval;
2068 /* this should happen during initialization only */
2069 interval_str = global_option_get ("Interval");
2070 if (interval_str != NULL)
2071 {
2072 interval_dbl = atof (interval_str);
2073 if (interval_dbl > 0.0)
2074 interval = DOUBLE_TO_CDTIME_T (interval_dbl);
2075 }
2077 if (interval > 0)
2078 return interval;
2079 return TIME_T_TO_CDTIME_T (10);
2080 } /* cdtime_t plugin_get_interval */
2082 typedef struct {
2083 plugin_ctx_t ctx;
2084 void *(*start_routine) (void *);
2085 void *arg;
2086 } plugin_thread_t;
2088 static void *plugin_thread_start (void *arg)
2089 {
2090 plugin_thread_t *plugin_thread = arg;
2092 void *(*start_routine) (void *) = plugin_thread->start_routine;
2093 void *plugin_arg = plugin_thread->arg;
2095 plugin_set_ctx (plugin_thread->ctx);
2097 free (plugin_thread);
2099 return start_routine (plugin_arg);
2100 } /* void *plugin_thread_start */
2102 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2103 void *(*start_routine) (void *), void *arg)
2104 {
2105 plugin_thread_t *plugin_thread;
2107 plugin_thread = malloc (sizeof (*plugin_thread));
2108 if (plugin_thread == NULL)
2109 return -1;
2111 plugin_thread->ctx = plugin_get_ctx ();
2112 plugin_thread->start_routine = start_routine;
2113 plugin_thread->arg = arg;
2115 return pthread_create (thread, attr,
2116 plugin_thread_start, plugin_thread);
2117 } /* int plugin_thread_create */
2119 /* vim: set sw=8 ts=8 noet fdm=marker : */