![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
14126cd5efad0c1441fe1728ce6f73d414193ed4
1 /**
2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2009 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 verplant.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 "utils_threshold.h"
40 #include "filter_chain.h"
42 /*
43 * Private structures
44 */
45 struct callback_func_s
46 {
47 void *cf_callback;
48 user_data_t cf_udata;
49 };
50 typedef struct callback_func_s callback_func_t;
52 #define RF_SIMPLE 0
53 #define RF_COMPLEX 1
54 struct read_func_s
55 {
56 /* `read_func_t' "inherits" from `callback_func_t'.
57 * The `rf_super' member MUST be the first one in this structure! */
58 #define rf_callback rf_super.cf_callback
59 #define rf_udata rf_super.cf_udata
60 callback_func_t rf_super;
61 char rf_name[DATA_MAX_NAME_LEN];
62 int rf_type;
63 struct timespec rf_interval;
64 struct timespec rf_effective_interval;
65 struct timespec rf_next_read;
66 };
67 typedef struct read_func_s read_func_t;
69 /*
70 * Private variables
71 */
72 static llist_t *list_init;
73 static llist_t *list_write;
74 static llist_t *list_flush;
75 static llist_t *list_shutdown;
76 static llist_t *list_log;
77 static llist_t *list_notification;
79 static fc_chain_t *pre_cache_chain = NULL;
80 static fc_chain_t *post_cache_chain = NULL;
82 static c_avl_tree_t *data_sets;
84 static char *plugindir = NULL;
86 static c_heap_t *read_heap = NULL;
87 static int read_loop = 1;
88 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
89 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
90 static pthread_t *read_threads = NULL;
91 static int read_threads_num = 0;
93 /*
94 * Static functions
95 */
96 static const char *plugin_get_dir (void)
97 {
98 if (plugindir == NULL)
99 return (PLUGINDIR);
100 else
101 return (plugindir);
102 }
104 static void destroy_callback (callback_func_t *cf) /* {{{ */
105 {
106 if (cf == NULL)
107 return;
109 if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
110 {
111 cf->cf_udata.free_func (cf->cf_udata.data);
112 cf->cf_udata.data = NULL;
113 cf->cf_udata.free_func = NULL;
114 }
115 sfree (cf);
116 } /* }}} void destroy_callback */
118 static void destroy_all_callbacks (llist_t **list) /* {{{ */
119 {
120 llentry_t *le;
122 if (*list == NULL)
123 return;
125 le = llist_head (*list);
126 while (le != NULL)
127 {
128 llentry_t *le_next;
130 le_next = le->next;
132 sfree (le->key);
133 destroy_callback (le->value);
134 le->value = NULL;
136 le = le_next;
137 }
139 llist_destroy (*list);
140 *list = NULL;
141 } /* }}} void destroy_all_callbacks */
143 static void destroy_read_heap (void) /* {{{ */
144 {
145 if (read_heap == NULL)
146 return;
148 while (42)
149 {
150 callback_func_t *cf;
152 cf = c_head_get_root (read_heap);
153 if (cf == NULL)
154 break;
156 destroy_callback (cf);
157 }
159 c_heap_destroy (read_heap);
160 read_heap = NULL;
161 } /* }}} void destroy_read_heap */
163 static int register_callback (llist_t **list, /* {{{ */
164 const char *name, callback_func_t *cf)
165 {
166 llentry_t *le;
167 char *key;
169 if (*list == NULL)
170 {
171 *list = llist_create ();
172 if (*list == NULL)
173 {
174 ERROR ("plugin: create_register_callback: "
175 "llist_create failed.");
176 destroy_callback (cf);
177 return (-1);
178 }
179 }
181 key = strdup (name);
182 if (key == NULL)
183 {
184 ERROR ("plugin: create_register_callback: strdup failed.");
185 destroy_callback (cf);
186 return (-1);
187 }
189 le = llist_search (*list, name);
190 if (le == NULL)
191 {
192 le = llentry_create (key, cf);
193 if (le == NULL)
194 {
195 ERROR ("plugin: create_register_callback: "
196 "llentry_create failed.");
197 free (key);
198 destroy_callback (cf);
199 return (-1);
200 }
202 llist_append (*list, le);
203 }
204 else
205 {
206 callback_func_t *old_cf;
208 old_cf = le->value;
209 le->value = cf;
211 destroy_callback (old_cf);
212 sfree (key);
213 }
215 return (0);
216 } /* }}} int register_callback */
218 static int create_register_callback (llist_t **list, /* {{{ */
219 const char *name, void *callback, user_data_t *ud)
220 {
221 callback_func_t *cf;
223 cf = (callback_func_t *) malloc (sizeof (*cf));
224 if (cf == NULL)
225 {
226 ERROR ("plugin: create_register_callback: malloc failed.");
227 return (-1);
228 }
229 memset (cf, 0, sizeof (*cf));
231 cf->cf_callback = callback;
232 if (ud == NULL)
233 {
234 cf->cf_udata.data = NULL;
235 cf->cf_udata.free_func = NULL;
236 }
237 else
238 {
239 cf->cf_udata = *ud;
240 }
242 return (register_callback (list, name, cf));
243 } /* }}} int create_register_callback */
245 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
246 {
247 llentry_t *e;
249 if (list == NULL)
250 return (-1);
252 e = llist_search (list, name);
253 if (e == NULL)
254 return (-1);
256 llist_remove (list, e);
258 sfree (e->key);
259 destroy_callback (e->value);
261 llentry_destroy (e);
263 return (0);
264 } /* }}} int plugin_unregister */
266 /*
267 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
268 * object, but it will bitch about a shared object not having a
269 * ``module_register'' symbol..
270 */
271 static int plugin_load_file (char *file)
272 {
273 lt_dlhandle dlh;
274 void (*reg_handle) (void);
276 DEBUG ("file = %s", file);
278 lt_dlinit ();
279 lt_dlerror (); /* clear errors */
281 if ((dlh = lt_dlopen (file)) == NULL)
282 {
283 const char *error = lt_dlerror ();
285 ERROR ("lt_dlopen (%s) failed: %s", file, error);
286 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
287 return (1);
288 }
290 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
291 {
292 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
293 file, lt_dlerror ());
294 lt_dlclose (dlh);
295 return (-1);
296 }
298 (*reg_handle) ();
300 return (0);
301 }
303 static void *plugin_read_thread (void __attribute__((unused)) *args)
304 {
305 while (read_loop != 0)
306 {
307 read_func_t *rf;
308 struct timeval now;
309 int status;
311 /* Get the read function that needs to be read next. */
312 rf = c_head_get_root (read_heap);
313 if (rf == NULL)
314 {
315 struct timespec abstime;
317 gettimeofday (&now, /* timezone = */ NULL);
319 abstime.tv_sec = now.tv_sec + interval_g;
320 abstime.tv_nsec = 1000 * now.tv_usec;
322 pthread_mutex_lock (&read_lock);
323 pthread_cond_timedwait (&read_cond, &read_lock,
324 &abstime);
325 pthread_mutex_unlock (&read_lock);
326 continue;
327 }
329 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
330 {
331 gettimeofday (&now, /* timezone = */ NULL);
333 rf->rf_interval.tv_sec = interval_g;
334 rf->rf_interval.tv_nsec = 0;
336 rf->rf_effective_interval = rf->rf_interval;
338 rf->rf_next_read.tv_sec = now.tv_sec;
339 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
340 }
342 /* sleep until this entry is due,
343 * using pthread_cond_timedwait */
344 pthread_mutex_lock (&read_lock);
345 pthread_cond_timedwait (&read_cond, &read_lock,
346 &rf->rf_next_read);
347 pthread_mutex_unlock (&read_lock);
349 /* Check if we're supposed to stop.. This may have interrupted
350 * the sleep, too. */
351 if (read_loop == 0)
352 {
353 /* Insert `rf' again, so it can be free'd correctly */
354 c_heap_insert (read_heap, rf);
355 break;
356 }
358 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
360 if (rf->rf_type == RF_SIMPLE)
361 {
362 int (*callback) (void);
364 callback = rf->rf_callback;
365 status = (*callback) ();
366 }
367 else
368 {
369 plugin_read_cb callback;
371 callback = rf->rf_callback;
372 status = (*callback) (&rf->rf_udata);
373 }
375 /* If the function signals failure, we will increase the
376 * intervals in which it will be called. */
377 if (status != 0)
378 {
379 rf->rf_effective_interval.tv_sec *= 2;
380 rf->rf_effective_interval.tv_nsec *= 2;
381 NORMALIZE_TIMESPEC (rf->rf_effective_interval);
383 if (rf->rf_effective_interval.tv_sec >= 86400)
384 {
385 rf->rf_effective_interval.tv_sec = 86400;
386 rf->rf_effective_interval.tv_nsec = 0;
387 }
389 NOTICE ("read-function of plugin `%s' failed. "
390 "Will suspend it for %i seconds.",
391 rf->rf_name,
392 (int) rf->rf_effective_interval.tv_sec);
393 }
394 else
395 {
396 /* Success: Restore the interval, if it was changed. */
397 rf->rf_effective_interval = rf->rf_interval;
398 }
400 /* update the ``next read due'' field */
401 gettimeofday (&now, /* timezone = */ NULL);
403 DEBUG ("plugin_read_thread: Effective interval of the "
404 "%s plugin is %i.%09i.",
405 rf->rf_name,
406 (int) rf->rf_effective_interval.tv_sec,
407 (int) rf->rf_effective_interval.tv_nsec);
409 /* Calculate the next (absolute) time at which this function
410 * should be called. */
411 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
412 + rf->rf_effective_interval.tv_sec;
413 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
414 + rf->rf_effective_interval.tv_nsec;
415 NORMALIZE_TIMESPEC (rf->rf_next_read);
417 /* Check, if `rf_next_read' is in the past. */
418 if ((rf->rf_next_read.tv_sec < now.tv_sec)
419 || ((rf->rf_next_read.tv_sec == now.tv_sec)
420 && (rf->rf_next_read.tv_nsec < (1000 * now.tv_usec))))
421 {
422 /* `rf_next_read' is in the past. Insert `now'
423 * so this value doesn't trail off into the
424 * past too much. */
425 rf->rf_next_read.tv_sec = now.tv_sec;
426 rf->rf_next_read.tv_nsec = 1000 * now.tv_usec;
427 }
429 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
430 rf->rf_name,
431 (int) rf->rf_next_read.tv_sec,
432 (int) rf->rf_next_read.tv_nsec);
434 /* Re-insert this read function into the heap again. */
435 c_heap_insert (read_heap, rf);
436 } /* while (read_loop) */
438 pthread_exit (NULL);
439 return ((void *) 0);
440 } /* void *plugin_read_thread */
442 static void start_read_threads (int num)
443 {
444 int i;
446 if (read_threads != NULL)
447 return;
449 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
450 if (read_threads == NULL)
451 {
452 ERROR ("plugin: start_read_threads: calloc failed.");
453 return;
454 }
456 read_threads_num = 0;
457 for (i = 0; i < num; i++)
458 {
459 if (pthread_create (read_threads + read_threads_num, NULL,
460 plugin_read_thread, NULL) == 0)
461 {
462 read_threads_num++;
463 }
464 else
465 {
466 ERROR ("plugin: start_read_threads: pthread_create failed.");
467 return;
468 }
469 } /* for (i) */
470 } /* void start_read_threads */
472 static void stop_read_threads (void)
473 {
474 int i;
476 if (read_threads == NULL)
477 return;
479 INFO ("collectd: Stopping %i read threads.", read_threads_num);
481 pthread_mutex_lock (&read_lock);
482 read_loop = 0;
483 DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
484 pthread_cond_broadcast (&read_cond);
485 pthread_mutex_unlock (&read_lock);
487 for (i = 0; i < read_threads_num; i++)
488 {
489 if (pthread_join (read_threads[i], NULL) != 0)
490 {
491 ERROR ("plugin: stop_read_threads: pthread_join failed.");
492 }
493 read_threads[i] = (pthread_t) 0;
494 }
495 sfree (read_threads);
496 read_threads_num = 0;
497 } /* void stop_read_threads */
499 /*
500 * Public functions
501 */
502 void plugin_set_dir (const char *dir)
503 {
504 if (plugindir != NULL)
505 free (plugindir);
507 if (dir == NULL)
508 plugindir = NULL;
509 else if ((plugindir = strdup (dir)) == NULL)
510 {
511 char errbuf[1024];
512 ERROR ("strdup failed: %s",
513 sstrerror (errno, errbuf, sizeof (errbuf)));
514 }
515 }
517 #define BUFSIZE 512
518 int plugin_load (const char *type)
519 {
520 DIR *dh;
521 const char *dir;
522 char filename[BUFSIZE] = "";
523 char typename[BUFSIZE];
524 int typename_len;
525 int ret;
526 struct stat statbuf;
527 struct dirent *de;
528 int status;
530 DEBUG ("type = %s", type);
532 dir = plugin_get_dir ();
533 ret = 1;
535 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
536 * type when matching the filename */
537 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
538 if ((status < 0) || ((size_t) status >= sizeof (typename)))
539 {
540 WARNING ("snprintf: truncated: `%s.so'", type);
541 return (-1);
542 }
543 typename_len = strlen (typename);
545 if ((dh = opendir (dir)) == NULL)
546 {
547 char errbuf[1024];
548 ERROR ("opendir (%s): %s", dir,
549 sstrerror (errno, errbuf, sizeof (errbuf)));
550 return (-1);
551 }
553 while ((de = readdir (dh)) != NULL)
554 {
555 if (strncasecmp (de->d_name, typename, typename_len))
556 continue;
558 status = ssnprintf (filename, sizeof (filename),
559 "%s/%s", dir, de->d_name);
560 if ((status < 0) || ((size_t) status >= sizeof (filename)))
561 {
562 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
563 continue;
564 }
566 if (lstat (filename, &statbuf) == -1)
567 {
568 char errbuf[1024];
569 WARNING ("stat %s: %s", filename,
570 sstrerror (errno, errbuf, sizeof (errbuf)));
571 continue;
572 }
573 else if (!S_ISREG (statbuf.st_mode))
574 {
575 /* don't follow symlinks */
576 continue;
577 }
579 if (plugin_load_file (filename) == 0)
580 {
581 /* success */
582 ret = 0;
583 break;
584 }
585 else
586 {
587 fprintf (stderr, "Unable to load plugin %s.\n", type);
588 }
589 }
591 closedir (dh);
593 if (filename[0] == '\0')
594 fprintf (stderr, "Could not find plugin %s.\n", type);
596 return (ret);
597 }
599 /*
600 * The `register_*' functions follow
601 */
602 int plugin_register_config (const char *name,
603 int (*callback) (const char *key, const char *val),
604 const char **keys, int keys_num)
605 {
606 cf_register (name, callback, keys, keys_num);
607 return (0);
608 } /* int plugin_register_config */
610 int plugin_register_complex_config (const char *type,
611 int (*callback) (oconfig_item_t *))
612 {
613 return (cf_register_complex (type, callback));
614 } /* int plugin_register_complex_config */
616 int plugin_register_init (const char *name,
617 int (*callback) (void))
618 {
619 return (create_register_callback (&list_init, name, (void *) callback,
620 /* user_data = */ NULL));
621 } /* plugin_register_init */
623 static int plugin_compare_read_func (const void *arg0, const void *arg1)
624 {
625 const read_func_t *rf0;
626 const read_func_t *rf1;
628 rf0 = arg0;
629 rf1 = arg1;
631 if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
632 return (-1);
633 else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
634 return (1);
635 else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
636 return (-1);
637 else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
638 return (1);
639 else
640 return (0);
641 } /* int plugin_compare_read_func */
643 int plugin_register_read (const char *name,
644 int (*callback) (void))
645 {
646 read_func_t *rf;
648 if (read_heap == NULL)
649 {
650 read_heap = c_heap_create (plugin_compare_read_func);
651 if (read_heap == NULL)
652 {
653 ERROR ("plugin_register_complex_read: "
654 "c_heap_create failed.");
655 return (-1);
656 }
657 }
659 rf = (read_func_t *) malloc (sizeof (read_func_t));
660 if (rf == NULL)
661 {
662 char errbuf[1024];
663 ERROR ("plugin_register_read: malloc failed: %s",
664 sstrerror (errno, errbuf, sizeof (errbuf)));
665 return (-1);
666 }
668 memset (rf, 0, sizeof (read_func_t));
669 rf->rf_callback = (void *) callback;
670 rf->rf_udata.data = NULL;
671 rf->rf_udata.free_func = NULL;
672 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
673 rf->rf_type = RF_SIMPLE;
674 rf->rf_interval.tv_sec = 0;
675 rf->rf_interval.tv_nsec = 0;
676 rf->rf_effective_interval = rf->rf_interval;
678 return (c_heap_insert (read_heap, rf));
679 } /* int plugin_register_read */
681 int plugin_register_complex_read (const char *name,
682 plugin_read_cb callback, user_data_t *user_data)
683 {
684 read_func_t *rf;
686 if (read_heap == NULL)
687 {
688 read_heap = c_heap_create (plugin_compare_read_func);
689 if (read_heap == NULL)
690 {
691 ERROR ("plugin_register_complex_read: "
692 "c_heap_create failed.");
693 return (-1);
694 }
695 }
697 rf = (read_func_t *) malloc (sizeof (read_func_t));
698 if (rf == NULL)
699 {
700 ERROR ("plugin_register_complex_read: malloc failed.");
701 return (-1);
702 }
704 memset (rf, 0, sizeof (read_func_t));
705 rf->rf_callback = (void *) callback;
706 sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
707 rf->rf_type = RF_COMPLEX;
708 rf->rf_interval.tv_sec = 0;
709 rf->rf_interval.tv_nsec = 0;
710 rf->rf_effective_interval = rf->rf_interval;
712 /* Set user data */
713 if (user_data == NULL)
714 {
715 rf->rf_udata.data = NULL;
716 rf->rf_udata.free_func = NULL;
717 }
718 else
719 {
720 rf->rf_udata = *user_data;
721 }
723 return (c_heap_insert (read_heap, rf));
724 } /* int plugin_register_complex_read */
726 int plugin_register_write (const char *name,
727 plugin_write_cb callback, user_data_t *ud)
728 {
729 return (create_register_callback (&list_write, name,
730 (void *) callback, ud));
731 } /* int plugin_register_write */
733 int plugin_register_flush (const char *name,
734 plugin_flush_cb callback, user_data_t *ud)
735 {
736 return (create_register_callback (&list_flush, name,
737 (void *) callback, ud));
738 } /* int plugin_register_flush */
740 int plugin_register_shutdown (char *name,
741 int (*callback) (void))
742 {
743 return (create_register_callback (&list_shutdown, name,
744 (void *) callback, /* user_data = */ NULL));
745 } /* int plugin_register_shutdown */
747 int plugin_register_data_set (const data_set_t *ds)
748 {
749 data_set_t *ds_copy;
750 int i;
752 if ((data_sets != NULL)
753 && (c_avl_get (data_sets, ds->type, NULL) == 0))
754 {
755 NOTICE ("Replacing DS `%s' with another version.", ds->type);
756 plugin_unregister_data_set (ds->type);
757 }
758 else if (data_sets == NULL)
759 {
760 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
761 if (data_sets == NULL)
762 return (-1);
763 }
765 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
766 if (ds_copy == NULL)
767 return (-1);
768 memcpy(ds_copy, ds, sizeof (data_set_t));
770 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
771 * ds->ds_num);
772 if (ds_copy->ds == NULL)
773 {
774 free (ds_copy);
775 return (-1);
776 }
778 for (i = 0; i < ds->ds_num; i++)
779 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
781 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
782 } /* int plugin_register_data_set */
784 int plugin_register_log (const char *name,
785 plugin_log_cb callback, user_data_t *ud)
786 {
787 return (create_register_callback (&list_log, name,
788 (void *) callback, ud));
789 } /* int plugin_register_log */
791 int plugin_register_notification (const char *name,
792 plugin_notification_cb callback, user_data_t *ud)
793 {
794 return (create_register_callback (&list_notification, name,
795 (void *) callback, ud));
796 } /* int plugin_register_log */
798 int plugin_unregister_config (const char *name)
799 {
800 cf_unregister (name);
801 return (0);
802 } /* int plugin_unregister_config */
804 int plugin_unregister_complex_config (const char *name)
805 {
806 cf_unregister_complex (name);
807 return (0);
808 } /* int plugin_unregister_complex_config */
810 int plugin_unregister_init (const char *name)
811 {
812 return (plugin_unregister (list_init, name));
813 }
815 int plugin_unregister_read (const char *name)
816 {
817 /* TODO: Implement removal of a specific key from the heap. */
818 assert (0);
819 return (-1);
820 }
822 int plugin_unregister_write (const char *name)
823 {
824 return (plugin_unregister (list_write, name));
825 }
827 int plugin_unregister_flush (const char *name)
828 {
829 return (plugin_unregister (list_flush, name));
830 }
832 int plugin_unregister_shutdown (const char *name)
833 {
834 return (plugin_unregister (list_shutdown, name));
835 }
837 int plugin_unregister_data_set (const char *name)
838 {
839 data_set_t *ds;
841 if (data_sets == NULL)
842 return (-1);
844 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
845 return (-1);
847 sfree (ds->ds);
848 sfree (ds);
850 return (0);
851 } /* int plugin_unregister_data_set */
853 int plugin_unregister_log (const char *name)
854 {
855 return (plugin_unregister (list_log, name));
856 }
858 int plugin_unregister_notification (const char *name)
859 {
860 return (plugin_unregister (list_notification, name));
861 }
863 void plugin_init_all (void)
864 {
865 const char *chain_name;
866 llentry_t *le;
867 int status;
869 /* Init the value cache */
870 uc_init ();
872 chain_name = global_option_get ("PreCacheChain");
873 pre_cache_chain = fc_chain_get_by_name (chain_name);
875 chain_name = global_option_get ("PostCacheChain");
876 post_cache_chain = fc_chain_get_by_name (chain_name);
879 if ((list_init == NULL) && (read_heap == NULL))
880 return;
882 /* Calling all init callbacks before checking if read callbacks
883 * are available allows the init callbacks to register the read
884 * callback. */
885 le = llist_head (list_init);
886 while (le != NULL)
887 {
888 callback_func_t *cf;
889 plugin_init_cb callback;
891 cf = le->value;
892 callback = cf->cf_callback;
893 status = (*callback) ();
895 if (status != 0)
896 {
897 ERROR ("Initialization of plugin `%s' "
898 "failed with status %i. "
899 "Plugin will be unloaded.",
900 le->key, status);
901 /* Plugins that register read callbacks from the init
902 * callback should take care of appropriate error
903 * handling themselves. */
904 /* FIXME: Unload _all_ functions */
905 plugin_unregister_read (le->key);
906 }
908 le = le->next;
909 }
911 /* Start read-threads */
912 if (read_heap != NULL)
913 {
914 const char *rt;
915 int num;
916 rt = global_option_get ("ReadThreads");
917 num = atoi (rt);
918 if (num != -1)
919 start_read_threads ((num > 0) ? num : 5);
920 }
921 } /* void plugin_init_all */
923 /* TODO: Rename this function. */
924 void plugin_read_all (void)
925 {
926 uc_check_timeout ();
928 return;
929 } /* void plugin_read_all */
931 /* Read function called when the `-T' command line argument is given. */
932 int plugin_read_all_once (void)
933 {
934 llentry_t *le;
935 int status;
936 int return_status = 0;
938 if (read_heap == NULL)
939 {
940 NOTICE ("No read-functions are registered.");
941 return (0);
942 }
944 while (42)
945 {
946 read_func_t *rf;
948 rf = c_head_get_root (read_heap);
949 if (rf == NULL)
950 break;
952 if (rf->rf_type == RF_SIMPLE)
953 {
954 int (*callback) (void);
956 callback = rf->rf_callback;
957 status = (*callback) ();
958 }
959 else
960 {
961 plugin_read_cb callback;
963 callback = rf->rf_callback;
964 status = (*callback) (&rf->rf_udata);
965 }
967 if (status != 0)
968 {
969 NOTICE ("read-function of plugin `%s' failed.",
970 le->key);
971 return_status = -1;
972 }
974 destroy_callback ((void *) rf);
975 }
977 return (return_status);
978 } /* int plugin_read_all_once */
980 int plugin_write (const char *plugin, /* {{{ */
981 const data_set_t *ds, const value_list_t *vl)
982 {
983 llentry_t *le;
984 int status;
986 if (vl == NULL)
987 return (EINVAL);
989 if (list_write == NULL)
990 return (ENOENT);
992 if (ds == NULL)
993 {
994 ds = plugin_get_ds (vl->type);
995 if (ds == NULL)
996 {
997 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
998 return (ENOENT);
999 }
1000 }
1002 if (plugin == NULL)
1003 {
1004 int success = 0;
1005 int failure = 0;
1007 le = llist_head (list_write);
1008 while (le != NULL)
1009 {
1010 callback_func_t *cf = le->value;
1011 plugin_write_cb callback;
1013 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1014 callback = cf->cf_callback;
1015 status = (*callback) (ds, vl, &cf->cf_udata);
1016 if (status != 0)
1017 failure++;
1018 else
1019 success++;
1021 le = le->next;
1022 }
1024 if ((success == 0) && (failure != 0))
1025 status = -1;
1026 else
1027 status = 0;
1028 }
1029 else /* plugin != NULL */
1030 {
1031 callback_func_t *cf;
1032 plugin_write_cb callback;
1034 le = llist_head (list_write);
1035 while (le != NULL)
1036 {
1037 if (strcasecmp (plugin, le->key) == 0)
1038 break;
1040 le = le->next;
1041 }
1043 if (le == NULL)
1044 return (ENOENT);
1046 cf = le->value;
1048 DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1049 callback = cf->cf_callback;
1050 status = (*callback) (ds, vl, &cf->cf_udata);
1051 }
1053 return (status);
1054 } /* }}} int plugin_write */
1056 int plugin_flush (const char *plugin, int timeout, const char *identifier)
1057 {
1058 llentry_t *le;
1060 if (list_flush == NULL)
1061 return (0);
1063 le = llist_head (list_flush);
1064 while (le != NULL)
1065 {
1066 callback_func_t *cf;
1067 plugin_flush_cb callback;
1069 if ((plugin != NULL)
1070 && (strcmp (plugin, le->key) != 0))
1071 {
1072 le = le->next;
1073 continue;
1074 }
1076 cf = le->value;
1077 callback = cf->cf_callback;
1079 (*callback) (timeout, identifier, &cf->cf_udata);
1081 le = le->next;
1082 }
1083 return (0);
1084 } /* int plugin_flush */
1086 void plugin_shutdown_all (void)
1087 {
1088 llentry_t *le;
1090 stop_read_threads ();
1092 destroy_all_callbacks (&list_init);
1093 destroy_read_heap ();
1095 plugin_flush (/* plugin = */ NULL, /* timeout = */ -1,
1096 /* identifier = */ NULL);
1098 le = NULL;
1099 if (list_shutdown != NULL)
1100 le = llist_head (list_shutdown);
1102 while (le != NULL)
1103 {
1104 callback_func_t *cf;
1105 plugin_shutdown_cb callback;
1107 cf = le->value;
1108 callback = cf->cf_callback;
1110 /* Advance the pointer before calling the callback allows
1111 * shutdown functions to unregister themselves. If done the
1112 * other way around the memory `le' points to will be freed
1113 * after callback returns. */
1114 le = le->next;
1116 (*callback) ();
1117 }
1119 destroy_all_callbacks (&list_write);
1120 destroy_all_callbacks (&list_flush);
1121 destroy_all_callbacks (&list_notification);
1122 destroy_all_callbacks (&list_shutdown);
1123 destroy_all_callbacks (&list_log);
1124 } /* void plugin_shutdown_all */
1126 int plugin_dispatch_values (value_list_t *vl)
1127 {
1128 int status;
1129 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1131 value_t *saved_values;
1132 int saved_values_len;
1134 data_set_t *ds;
1136 if ((vl == NULL) || (vl->type[0] == 0)
1137 || (vl->values == NULL) || (vl->values_len < 1))
1138 {
1139 ERROR ("plugin_dispatch_values: Invalid value list.");
1140 return (-1);
1141 }
1143 if (list_write == NULL)
1144 c_complain_once (LOG_WARNING, &no_write_complaint,
1145 "plugin_dispatch_values: No write callback has been "
1146 "registered. Please load at least one output plugin, "
1147 "if you want the collected data to be stored.");
1149 if (data_sets == NULL)
1150 {
1151 ERROR ("plugin_dispatch_values: No data sets registered. "
1152 "Could the types database be read? Check "
1153 "your `TypesDB' setting!");
1154 return (-1);
1155 }
1157 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1158 {
1159 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
1160 return (-1);
1161 }
1163 if (vl->time == 0)
1164 vl->time = time (NULL);
1166 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
1167 "host = %s; "
1168 "plugin = %s; plugin_instance = %s; "
1169 "type = %s; type_instance = %s;",
1170 (unsigned int) vl->time, vl->interval,
1171 vl->host,
1172 vl->plugin, vl->plugin_instance,
1173 vl->type, vl->type_instance);
1175 #if COLLECT_DEBUG
1176 assert (0 == strcmp (ds->type, vl->type));
1177 #else
1178 if (0 != strcmp (ds->type, vl->type))
1179 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1180 ds->type, vl->type);
1181 #endif
1183 #if COLLECT_DEBUG
1184 assert (ds->ds_num == vl->values_len);
1185 #else
1186 if (ds->ds_num != vl->values_len)
1187 {
1188 ERROR ("plugin_dispatch_values: ds->type = %s: "
1189 "(ds->ds_num = %i) != "
1190 "(vl->values_len = %i)",
1191 ds->type, ds->ds_num, vl->values_len);
1192 return (-1);
1193 }
1194 #endif
1196 escape_slashes (vl->host, sizeof (vl->host));
1197 escape_slashes (vl->plugin, sizeof (vl->plugin));
1198 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1199 escape_slashes (vl->type, sizeof (vl->type));
1200 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1202 /* Copy the values. This way, we can assure `targets' that they get
1203 * dynamically allocated values, which they can free and replace if
1204 * they like. */
1205 if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1206 {
1207 saved_values = vl->values;
1208 saved_values_len = vl->values_len;
1210 vl->values = (value_t *) calloc (vl->values_len,
1211 sizeof (*vl->values));
1212 if (vl->values == NULL)
1213 {
1214 ERROR ("plugin_dispatch_values: calloc failed.");
1215 vl->values = saved_values;
1216 return (-1);
1217 }
1218 memcpy (vl->values, saved_values,
1219 vl->values_len * sizeof (*vl->values));
1220 }
1221 else /* if ((pre == NULL) && (post == NULL)) */
1222 {
1223 saved_values = NULL;
1224 saved_values_len = 0;
1225 }
1227 if (pre_cache_chain != NULL)
1228 {
1229 status = fc_process_chain (ds, vl, pre_cache_chain);
1230 if (status < 0)
1231 {
1232 WARNING ("plugin_dispatch_values: Running the "
1233 "pre-cache chain failed with "
1234 "status %i (%#x).",
1235 status, status);
1236 }
1237 else if (status == FC_TARGET_STOP)
1238 {
1239 /* Restore the state of the value_list so that plugins
1240 * don't get confused.. */
1241 if (saved_values != NULL)
1242 {
1243 free (vl->values);
1244 vl->values = saved_values;
1245 vl->values_len = saved_values_len;
1246 }
1247 return (0);
1248 }
1249 }
1251 /* Update the value cache */
1252 uc_update (ds, vl);
1254 if (post_cache_chain != NULL)
1255 {
1256 status = fc_process_chain (ds, vl, post_cache_chain);
1257 if (status < 0)
1258 {
1259 WARNING ("plugin_dispatch_values: Running the "
1260 "post-cache chain failed with "
1261 "status %i (%#x).",
1262 status, status);
1263 }
1264 }
1265 else
1266 fc_default_action (ds, vl);
1268 /* Restore the state of the value_list so that plugins don't get
1269 * confused.. */
1270 if (saved_values != NULL)
1271 {
1272 free (vl->values);
1273 vl->values = saved_values;
1274 vl->values_len = saved_values_len;
1275 }
1277 return (0);
1278 } /* int plugin_dispatch_values */
1280 int plugin_dispatch_notification (const notification_t *notif)
1281 {
1282 llentry_t *le;
1283 /* Possible TODO: Add flap detection here */
1285 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1286 "time = %u; host = %s;",
1287 notif->severity, notif->message,
1288 (unsigned int) notif->time, notif->host);
1290 /* Nobody cares for notifications */
1291 if (list_notification == NULL)
1292 return (-1);
1294 le = llist_head (list_notification);
1295 while (le != NULL)
1296 {
1297 callback_func_t *cf;
1298 plugin_notification_cb callback;
1299 int status;
1301 cf = le->value;
1302 callback = cf->cf_callback;
1303 status = (*callback) (notif, &cf->cf_udata);
1304 if (status != 0)
1305 {
1306 WARNING ("plugin_dispatch_notification: Notification "
1307 "callback %s returned %i.",
1308 le->key, status);
1309 }
1311 le = le->next;
1312 }
1314 return (0);
1315 } /* int plugin_dispatch_notification */
1317 void plugin_log (int level, const char *format, ...)
1318 {
1319 char msg[1024];
1320 va_list ap;
1321 llentry_t *le;
1323 if (list_log == NULL)
1324 return;
1326 #if !COLLECT_DEBUG
1327 if (level >= LOG_DEBUG)
1328 return;
1329 #endif
1331 va_start (ap, format);
1332 vsnprintf (msg, sizeof (msg), format, ap);
1333 msg[sizeof (msg) - 1] = '\0';
1334 va_end (ap);
1336 le = llist_head (list_log);
1337 while (le != NULL)
1338 {
1339 callback_func_t *cf;
1340 plugin_log_cb callback;
1342 cf = le->value;
1343 callback = cf->cf_callback;
1345 (*callback) (level, msg, &cf->cf_udata);
1347 le = le->next;
1348 }
1349 } /* void plugin_log */
1351 const data_set_t *plugin_get_ds (const char *name)
1352 {
1353 data_set_t *ds;
1355 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1356 {
1357 DEBUG ("No such dataset registered: %s", name);
1358 return (NULL);
1359 }
1361 return (ds);
1362 } /* data_set_t *plugin_get_ds */
1364 static int plugin_notification_meta_add (notification_t *n,
1365 const char *name,
1366 enum notification_meta_type_e type,
1367 const void *value)
1368 {
1369 notification_meta_t *meta;
1370 notification_meta_t *tail;
1372 if ((n == NULL) || (name == NULL) || (value == NULL))
1373 {
1374 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1375 return (-1);
1376 }
1378 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1379 if (meta == NULL)
1380 {
1381 ERROR ("plugin_notification_meta_add: malloc failed.");
1382 return (-1);
1383 }
1384 memset (meta, 0, sizeof (notification_meta_t));
1386 sstrncpy (meta->name, name, sizeof (meta->name));
1387 meta->type = type;
1389 switch (type)
1390 {
1391 case NM_TYPE_STRING:
1392 {
1393 meta->nm_value.nm_string = strdup ((const char *) value);
1394 if (meta->nm_value.nm_string == NULL)
1395 {
1396 ERROR ("plugin_notification_meta_add: strdup failed.");
1397 sfree (meta);
1398 return (-1);
1399 }
1400 break;
1401 }
1402 case NM_TYPE_SIGNED_INT:
1403 {
1404 meta->nm_value.nm_signed_int = *((int64_t *) value);
1405 break;
1406 }
1407 case NM_TYPE_UNSIGNED_INT:
1408 {
1409 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1410 break;
1411 }
1412 case NM_TYPE_DOUBLE:
1413 {
1414 meta->nm_value.nm_double = *((double *) value);
1415 break;
1416 }
1417 case NM_TYPE_BOOLEAN:
1418 {
1419 meta->nm_value.nm_boolean = *((bool *) value);
1420 break;
1421 }
1422 default:
1423 {
1424 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1425 sfree (meta);
1426 return (-1);
1427 }
1428 } /* switch (type) */
1430 meta->next = NULL;
1431 tail = n->meta;
1432 while ((tail != NULL) && (tail->next != NULL))
1433 tail = tail->next;
1435 if (tail == NULL)
1436 n->meta = meta;
1437 else
1438 tail->next = meta;
1440 return (0);
1441 } /* int plugin_notification_meta_add */
1443 int plugin_notification_meta_add_string (notification_t *n,
1444 const char *name,
1445 const char *value)
1446 {
1447 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1448 }
1450 int plugin_notification_meta_add_signed_int (notification_t *n,
1451 const char *name,
1452 int64_t value)
1453 {
1454 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1455 }
1457 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1458 const char *name,
1459 uint64_t value)
1460 {
1461 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1462 }
1464 int plugin_notification_meta_add_double (notification_t *n,
1465 const char *name,
1466 double value)
1467 {
1468 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1469 }
1471 int plugin_notification_meta_add_boolean (notification_t *n,
1472 const char *name,
1473 bool value)
1474 {
1475 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1476 }
1478 int plugin_notification_meta_copy (notification_t *dst,
1479 const notification_t *src)
1480 {
1481 notification_meta_t *meta;
1483 assert (dst != NULL);
1484 assert (src != NULL);
1485 assert (dst != src);
1486 assert ((src->meta == NULL) || (src->meta != dst->meta));
1488 for (meta = src->meta; meta != NULL; meta = meta->next)
1489 {
1490 if (meta->type == NM_TYPE_STRING)
1491 plugin_notification_meta_add_string (dst, meta->name,
1492 meta->nm_value.nm_string);
1493 else if (meta->type == NM_TYPE_SIGNED_INT)
1494 plugin_notification_meta_add_signed_int (dst, meta->name,
1495 meta->nm_value.nm_signed_int);
1496 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1497 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1498 meta->nm_value.nm_unsigned_int);
1499 else if (meta->type == NM_TYPE_DOUBLE)
1500 plugin_notification_meta_add_double (dst, meta->name,
1501 meta->nm_value.nm_double);
1502 else if (meta->type == NM_TYPE_BOOLEAN)
1503 plugin_notification_meta_add_boolean (dst, meta->name,
1504 meta->nm_value.nm_boolean);
1505 }
1507 return (0);
1508 } /* int plugin_notification_meta_copy */
1510 int plugin_notification_meta_free (notification_meta_t *n)
1511 {
1512 notification_meta_t *this;
1513 notification_meta_t *next;
1515 if (n == NULL)
1516 {
1517 ERROR ("plugin_notification_meta_free: n == NULL!");
1518 return (-1);
1519 }
1521 this = n;
1522 while (this != NULL)
1523 {
1524 next = this->next;
1526 if (this->type == NM_TYPE_STRING)
1527 {
1528 free ((char *)this->nm_value.nm_string);
1529 this->nm_value.nm_string = NULL;
1530 }
1531 sfree (this);
1533 this = next;
1534 }
1536 return (0);
1537 } /* int plugin_notification_meta_free */
1539 /* vim: set sw=8 ts=8 noet fdm=marker : */