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_cache.h"
38 #include "utils_threshold.h"
39 #include "filter_chain.h"
41 /*
42 * Private structures
43 */
44 struct read_func_s
45 {
46 int wait_time;
47 int wait_left;
48 int (*callback) (void);
49 enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
50 };
51 typedef struct read_func_s read_func_t;
53 /*
54 * Private variables
55 */
56 static llist_t *list_init;
57 static llist_t *list_read;
58 static llist_t *list_write;
59 static llist_t *list_flush;
60 static llist_t *list_shutdown;
61 static llist_t *list_log;
62 static llist_t *list_notification;
64 static fc_chain_t *pre_cache_chain = NULL;
65 static fc_chain_t *post_cache_chain = NULL;
67 static c_avl_tree_t *data_sets;
69 static char *plugindir = NULL;
71 static int read_loop = 1;
72 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
73 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
74 static pthread_t *read_threads = NULL;
75 static int read_threads_num = 0;
77 /*
78 * Static functions
79 */
80 static const char *plugin_get_dir (void)
81 {
82 if (plugindir == NULL)
83 return (PLUGINDIR);
84 else
85 return (plugindir);
86 }
88 static int register_callback (llist_t **list, const char *name, void *callback)
89 {
90 llentry_t *le;
91 char *key;
93 if ((*list == NULL)
94 && ((*list = llist_create ()) == NULL))
95 return (-1);
97 le = llist_search (*list, name);
98 if (le == NULL)
99 {
100 key = strdup (name);
101 if (key == NULL)
102 return (-1);
104 le = llentry_create (key, callback);
105 if (le == NULL)
106 {
107 free (key);
108 return (-1);
109 }
111 llist_append (*list, le);
112 }
113 else
114 {
115 le->value = callback;
116 }
118 return (0);
119 } /* int register_callback */
121 static int plugin_unregister (llist_t *list, const char *name)
122 {
123 llentry_t *e;
125 e = llist_search (list, name);
127 if (e == NULL)
128 return (-1);
130 llist_remove (list, e);
131 free (e->key);
132 llentry_destroy (e);
134 return (0);
135 } /* int plugin_unregister */
137 /*
138 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
139 * object, but it will bitch about a shared object not having a
140 * ``module_register'' symbol..
141 */
142 static int plugin_load_file (char *file)
143 {
144 lt_dlhandle dlh;
145 void (*reg_handle) (void);
147 DEBUG ("file = %s", file);
149 lt_dlinit ();
150 lt_dlerror (); /* clear errors */
152 if ((dlh = lt_dlopen (file)) == NULL)
153 {
154 const char *error = lt_dlerror ();
156 ERROR ("lt_dlopen (%s) failed: %s", file, error);
157 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
158 return (1);
159 }
161 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
162 {
163 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
164 file, lt_dlerror ());
165 lt_dlclose (dlh);
166 return (-1);
167 }
169 (*reg_handle) ();
171 return (0);
172 }
174 static void *plugin_read_thread (void __attribute__((unused)) *args)
175 {
176 llentry_t *le;
177 read_func_t *rf;
178 int status;
179 int done;
181 pthread_mutex_lock (&read_lock);
183 while (read_loop != 0)
184 {
185 le = llist_head (list_read);
186 done = 0;
188 while ((read_loop != 0) && (le != NULL))
189 {
190 rf = (read_func_t *) le->value;
192 if (rf->needs_read != TODO)
193 {
194 le = le->next;
195 continue;
196 }
198 /* We will do this read function */
199 rf->needs_read = ACTIVE;
201 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
202 (unsigned long int) pthread_self (), le->key);
203 pthread_mutex_unlock (&read_lock);
205 status = rf->callback ();
206 done++;
208 if (status != 0)
209 {
210 if (rf->wait_time < interval_g)
211 rf->wait_time = interval_g;
212 rf->wait_left = rf->wait_time;
213 rf->wait_time = rf->wait_time * 2;
214 if (rf->wait_time > 86400)
215 rf->wait_time = 86400;
217 NOTICE ("read-function of plugin `%s' "
218 "failed. Will suspend it for %i "
219 "seconds.", le->key, rf->wait_left);
220 }
221 else
222 {
223 rf->wait_left = 0;
224 rf->wait_time = interval_g;
225 }
227 pthread_mutex_lock (&read_lock);
229 rf->needs_read = DONE;
230 le = le->next;
231 } /* while (le != NULL) */
233 if ((read_loop != 0) && (done == 0))
234 {
235 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
236 (unsigned long int) pthread_self ());
237 pthread_cond_wait (&read_cond, &read_lock);
238 }
239 } /* while (read_loop) */
241 pthread_mutex_unlock (&read_lock);
243 pthread_exit (NULL);
244 return ((void *) 0);
245 } /* void *plugin_read_thread */
247 static void start_threads (int num)
248 {
249 int i;
251 if (read_threads != NULL)
252 return;
254 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
255 if (read_threads == NULL)
256 {
257 ERROR ("plugin: start_threads: calloc failed.");
258 return;
259 }
261 read_threads_num = 0;
262 for (i = 0; i < num; i++)
263 {
264 if (pthread_create (read_threads + read_threads_num, NULL,
265 plugin_read_thread, NULL) == 0)
266 {
267 read_threads_num++;
268 }
269 else
270 {
271 ERROR ("plugin: start_threads: pthread_create failed.");
272 return;
273 }
274 } /* for (i) */
275 } /* void start_threads */
277 static void stop_threads (void)
278 {
279 int i;
281 if (read_threads == NULL)
282 return;
284 pthread_mutex_lock (&read_lock);
285 read_loop = 0;
286 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
287 pthread_cond_broadcast (&read_cond);
288 pthread_mutex_unlock (&read_lock);
290 for (i = 0; i < read_threads_num; i++)
291 {
292 if (pthread_join (read_threads[i], NULL) != 0)
293 {
294 ERROR ("plugin: stop_threads: pthread_join failed.");
295 }
296 read_threads[i] = (pthread_t) 0;
297 }
298 sfree (read_threads);
299 read_threads_num = 0;
300 } /* void stop_threads */
302 /*
303 * Public functions
304 */
305 void plugin_set_dir (const char *dir)
306 {
307 if (plugindir != NULL)
308 free (plugindir);
310 if (dir == NULL)
311 plugindir = NULL;
312 else if ((plugindir = strdup (dir)) == NULL)
313 {
314 char errbuf[1024];
315 ERROR ("strdup failed: %s",
316 sstrerror (errno, errbuf, sizeof (errbuf)));
317 }
318 }
320 #define BUFSIZE 512
321 int plugin_load (const char *type)
322 {
323 DIR *dh;
324 const char *dir;
325 char filename[BUFSIZE] = "";
326 char typename[BUFSIZE];
327 int typename_len;
328 int ret;
329 struct stat statbuf;
330 struct dirent *de;
331 int status;
333 DEBUG ("type = %s", type);
335 dir = plugin_get_dir ();
336 ret = 1;
338 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
339 * type when matching the filename */
340 status = ssnprintf (typename, sizeof (typename), "%s.so", type);
341 if ((status < 0) || ((size_t) status >= sizeof (typename)))
342 {
343 WARNING ("snprintf: truncated: `%s.so'", type);
344 return (-1);
345 }
346 typename_len = strlen (typename);
348 if ((dh = opendir (dir)) == NULL)
349 {
350 char errbuf[1024];
351 ERROR ("opendir (%s): %s", dir,
352 sstrerror (errno, errbuf, sizeof (errbuf)));
353 return (-1);
354 }
356 while ((de = readdir (dh)) != NULL)
357 {
358 if (strncasecmp (de->d_name, typename, typename_len))
359 continue;
361 status = ssnprintf (filename, sizeof (filename),
362 "%s/%s", dir, de->d_name);
363 if ((status < 0) || ((size_t) status >= sizeof (filename)))
364 {
365 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
366 continue;
367 }
369 if (lstat (filename, &statbuf) == -1)
370 {
371 char errbuf[1024];
372 WARNING ("stat %s: %s", filename,
373 sstrerror (errno, errbuf, sizeof (errbuf)));
374 continue;
375 }
376 else if (!S_ISREG (statbuf.st_mode))
377 {
378 /* don't follow symlinks */
379 continue;
380 }
382 if (plugin_load_file (filename) == 0)
383 {
384 /* success */
385 ret = 0;
386 break;
387 }
388 else
389 {
390 fprintf (stderr, "Unable to load plugin %s.\n", type);
391 }
392 }
394 closedir (dh);
396 if (filename[0] == '\0')
397 fprintf (stderr, "Could not find plugin %s.\n", type);
399 return (ret);
400 }
402 /*
403 * The `register_*' functions follow
404 */
405 int plugin_register_config (const char *name,
406 int (*callback) (const char *key, const char *val),
407 const char **keys, int keys_num)
408 {
409 cf_register (name, callback, keys, keys_num);
410 return (0);
411 } /* int plugin_register_config */
413 int plugin_register_complex_config (const char *type,
414 int (*callback) (oconfig_item_t *))
415 {
416 return (cf_register_complex (type, callback));
417 } /* int plugin_register_complex_config */
419 int plugin_register_init (const char *name,
420 int (*callback) (void))
421 {
422 return (register_callback (&list_init, name, (void *) callback));
423 } /* plugin_register_init */
425 int plugin_register_read (const char *name,
426 int (*callback) (void))
427 {
428 read_func_t *rf;
430 rf = (read_func_t *) malloc (sizeof (read_func_t));
431 if (rf == NULL)
432 {
433 char errbuf[1024];
434 ERROR ("plugin_register_read: malloc failed: %s",
435 sstrerror (errno, errbuf, sizeof (errbuf)));
436 return (-1);
437 }
439 memset (rf, '\0', sizeof (read_func_t));
440 rf->wait_time = interval_g;
441 rf->wait_left = 0;
442 rf->callback = callback;
443 rf->needs_read = DONE;
445 return (register_callback (&list_read, name, (void *) rf));
446 } /* int plugin_register_read */
448 int plugin_register_write (const char *name,
449 int (*callback) (const data_set_t *ds, const value_list_t *vl))
450 {
451 return (register_callback (&list_write, name, (void *) callback));
452 } /* int plugin_register_write */
454 int plugin_register_flush (const char *name,
455 int (*callback) (const int timeout, const char *identifier))
456 {
457 return (register_callback (&list_flush, name, (void *) callback));
458 } /* int plugin_register_flush */
460 int plugin_register_shutdown (char *name,
461 int (*callback) (void))
462 {
463 return (register_callback (&list_shutdown, name, (void *) callback));
464 } /* int plugin_register_shutdown */
466 int plugin_register_data_set (const data_set_t *ds)
467 {
468 data_set_t *ds_copy;
469 int i;
471 if ((data_sets != NULL)
472 && (c_avl_get (data_sets, ds->type, NULL) == 0))
473 {
474 NOTICE ("Replacing DS `%s' with another version.", ds->type);
475 plugin_unregister_data_set (ds->type);
476 }
477 else if (data_sets == NULL)
478 {
479 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
480 if (data_sets == NULL)
481 return (-1);
482 }
484 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
485 if (ds_copy == NULL)
486 return (-1);
487 memcpy(ds_copy, ds, sizeof (data_set_t));
489 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
490 * ds->ds_num);
491 if (ds_copy->ds == NULL)
492 {
493 free (ds_copy);
494 return (-1);
495 }
497 for (i = 0; i < ds->ds_num; i++)
498 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
500 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
501 } /* int plugin_register_data_set */
503 int plugin_register_log (char *name,
504 void (*callback) (int priority, const char *msg))
505 {
506 return (register_callback (&list_log, name, (void *) callback));
507 } /* int plugin_register_log */
509 int plugin_register_notification (const char *name,
510 int (*callback) (const notification_t *notif))
511 {
512 return (register_callback (&list_notification, name, (void *) callback));
513 } /* int plugin_register_log */
515 int plugin_unregister_config (const char *name)
516 {
517 cf_unregister (name);
518 return (0);
519 } /* int plugin_unregister_config */
521 int plugin_unregister_complex_config (const char *name)
522 {
523 cf_unregister_complex (name);
524 return (0);
525 } /* int plugin_unregister_complex_config */
527 int plugin_unregister_init (const char *name)
528 {
529 return (plugin_unregister (list_init, name));
530 }
532 int plugin_unregister_read (const char *name)
533 {
534 llentry_t *e;
536 e = llist_search (list_read, name);
538 if (e == NULL)
539 return (-1);
541 llist_remove (list_read, e);
542 free (e->value);
543 free (e->key);
544 llentry_destroy (e);
546 return (0);
547 }
549 int plugin_unregister_write (const char *name)
550 {
551 return (plugin_unregister (list_write, name));
552 }
554 int plugin_unregister_flush (const char *name)
555 {
556 return (plugin_unregister (list_flush, name));
557 }
559 int plugin_unregister_shutdown (const char *name)
560 {
561 return (plugin_unregister (list_shutdown, name));
562 }
564 int plugin_unregister_data_set (const char *name)
565 {
566 data_set_t *ds;
568 if (data_sets == NULL)
569 return (-1);
571 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
572 return (-1);
574 sfree (ds->ds);
575 sfree (ds);
577 return (0);
578 } /* int plugin_unregister_data_set */
580 int plugin_unregister_log (const char *name)
581 {
582 return (plugin_unregister (list_log, name));
583 }
585 int plugin_unregister_notification (const char *name)
586 {
587 return (plugin_unregister (list_notification, name));
588 }
590 void plugin_init_all (void)
591 {
592 const char *chain_name;
593 int (*callback) (void);
594 llentry_t *le;
595 int status;
597 /* Init the value cache */
598 uc_init ();
600 chain_name = global_option_get ("PreCacheChain");
601 pre_cache_chain = fc_chain_get_by_name (chain_name);
603 chain_name = global_option_get ("PostCacheChain");
604 post_cache_chain = fc_chain_get_by_name (chain_name);
607 if ((list_init == NULL) && (list_read == NULL))
608 return;
610 /* Calling all init callbacks before checking if read callbacks
611 * are available allows the init callbacks to register the read
612 * callback. */
613 le = llist_head (list_init);
614 while (le != NULL)
615 {
616 callback = (int (*) (void)) le->value;
617 status = (*callback) ();
619 if (status != 0)
620 {
621 ERROR ("Initialization of plugin `%s' "
622 "failed with status %i. "
623 "Plugin will be unloaded.",
624 le->key, status);
625 /* Plugins that register read callbacks from the init
626 * callback should take care of appropriate error
627 * handling themselves. */
628 /* FIXME: Unload _all_ functions */
629 plugin_unregister_read (le->key);
630 }
632 le = le->next;
633 }
635 /* Start read-threads */
636 if (list_read != NULL)
637 {
638 const char *rt;
639 int num;
640 rt = global_option_get ("ReadThreads");
641 num = atoi (rt);
642 if (num != -1)
643 start_threads ((num > 0) ? num : 5);
644 }
645 } /* void plugin_init_all */
647 void plugin_read_all (void)
648 {
649 llentry_t *le;
650 read_func_t *rf;
652 uc_check_timeout ();
654 if (list_read == NULL)
655 return;
657 pthread_mutex_lock (&read_lock);
659 le = llist_head (list_read);
660 while (le != NULL)
661 {
662 rf = (read_func_t *) le->value;
664 if (rf->needs_read != DONE)
665 {
666 le = le->next;
667 continue;
668 }
670 if (rf->wait_left > 0)
671 rf->wait_left -= interval_g;
673 if (rf->wait_left <= 0)
674 {
675 rf->needs_read = TODO;
676 }
678 le = le->next;
679 }
681 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
682 pthread_cond_broadcast (&read_cond);
683 pthread_mutex_unlock (&read_lock);
684 } /* void plugin_read_all */
686 /* Read function called when the `-T' command line argument is given. */
687 int plugin_read_all_once (void)
688 {
689 llentry_t *le;
690 read_func_t *rf;
691 int status;
692 int return_status = 0;
694 if (list_read == NULL)
695 {
696 NOTICE ("No read-functions are registered.");
697 return (0);
698 }
700 for (le = llist_head (list_read);
701 le != NULL;
702 le = le->next)
703 {
704 rf = (read_func_t *) le->value;
705 status = rf->callback ();
706 if (status != 0)
707 {
708 NOTICE ("read-function of plugin `%s' failed.",
709 le->key);
710 return_status = -1;
711 }
712 }
714 return (return_status);
715 } /* int plugin_read_all_once */
717 int plugin_write (const char *plugin, /* {{{ */
718 const data_set_t *ds, const value_list_t *vl)
719 {
720 int (*callback) (const data_set_t *ds, const value_list_t *vl);
721 llentry_t *le;
722 int status;
724 if (vl == NULL)
725 return (EINVAL);
727 if (list_write == NULL)
728 return (ENOENT);
730 if (ds == NULL)
731 {
732 ds = plugin_get_ds (vl->type);
733 if (ds == NULL)
734 {
735 ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
736 return (ENOENT);
737 }
738 }
740 if (plugin == NULL)
741 {
742 int success = 0;
743 int failure = 0;
745 le = llist_head (list_write);
746 while (le != NULL)
747 {
748 callback = le->value;
749 status = (*callback) (ds, vl);
750 if (status != 0)
751 failure++;
752 else
753 success++;
755 le = le->next;
756 }
758 if ((success == 0) && (failure != 0))
759 status = -1;
760 else
761 status = 0;
762 }
763 else /* plugin != NULL */
764 {
765 le = llist_head (list_write);
766 while (le != NULL)
767 {
768 if (strcasecmp (plugin, le->key) == 0)
769 break;
771 le = le->next;
772 }
774 if (le == NULL)
775 return (ENOENT);
777 callback = le->value;
778 status = (*callback) (ds, vl);
779 }
781 return (status);
782 } /* }}} int plugin_write */
784 int plugin_flush (const char *plugin, int timeout, const char *identifier)
785 {
786 int (*callback) (int timeout, const char *identifier);
787 llentry_t *le;
789 if (list_flush == NULL)
790 return (0);
792 le = llist_head (list_flush);
793 while (le != NULL)
794 {
795 if ((plugin != NULL)
796 && (strcmp (plugin, le->key) != 0))
797 {
798 le = le->next;
799 continue;
800 }
802 callback = (int (*) (int, const char *)) le->value;
803 (*callback) (timeout, identifier);
805 le = le->next;
806 }
807 return (0);
808 } /* int plugin_flush */
810 void plugin_shutdown_all (void)
811 {
812 int (*callback) (void);
813 llentry_t *le;
815 stop_threads ();
817 if (list_shutdown == NULL)
818 return;
820 le = llist_head (list_shutdown);
821 while (le != NULL)
822 {
823 callback = (int (*) (void)) le->value;
825 /* Advance the pointer before calling the callback allows
826 * shutdown functions to unregister themselves. If done the
827 * other way around the memory `le' points to will be freed
828 * after callback returns. */
829 le = le->next;
831 (*callback) ();
832 }
833 } /* void plugin_shutdown_all */
835 int plugin_dispatch_values (value_list_t *vl)
836 {
837 int status;
838 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
840 data_set_t *ds;
842 if ((vl == NULL) || (*vl->type == '\0')) {
843 ERROR ("plugin_dispatch_values: Invalid value list.");
844 return (-1);
845 }
847 if (list_write == NULL)
848 c_complain_once (LOG_WARNING, &no_write_complaint,
849 "plugin_dispatch_values: No write callback has been "
850 "registered. Please load at least one output plugin, "
851 "if you want the collected data to be stored.");
853 if (data_sets == NULL)
854 {
855 ERROR ("plugin_dispatch_values: No data sets registered. "
856 "Could the types database be read? Check "
857 "your `TypesDB' setting!");
858 return (-1);
859 }
861 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
862 {
863 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
864 return (-1);
865 }
867 if (vl->time == 0)
868 vl->time = time (NULL);
870 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
871 "host = %s; "
872 "plugin = %s; plugin_instance = %s; "
873 "type = %s; type_instance = %s;",
874 (unsigned int) vl->time, vl->interval,
875 vl->host,
876 vl->plugin, vl->plugin_instance,
877 vl->type, vl->type_instance);
879 #if COLLECT_DEBUG
880 assert (0 == strcmp (ds->type, vl->type));
881 #else
882 if (0 != strcmp (ds->type, vl->type))
883 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
884 ds->type, vl->type);
885 #endif
887 #if COLLECT_DEBUG
888 assert (ds->ds_num == vl->values_len);
889 #else
890 if (ds->ds_num != vl->values_len)
891 {
892 ERROR ("plugin_dispatch_values: ds->type = %s: "
893 "(ds->ds_num = %i) != "
894 "(vl->values_len = %i)",
895 ds->type, ds->ds_num, vl->values_len);
896 return (-1);
897 }
898 #endif
900 escape_slashes (vl->host, sizeof (vl->host));
901 escape_slashes (vl->plugin, sizeof (vl->plugin));
902 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
903 escape_slashes (vl->type, sizeof (vl->type));
904 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
906 if (pre_cache_chain != NULL)
907 {
908 status = fc_process_chain (ds, vl, pre_cache_chain);
909 if (status < 0)
910 {
911 WARNING ("plugin_dispatch_values: Running the "
912 "pre-cache chain failed with "
913 "status %i (%#x).",
914 status, status);
915 }
916 else if (status == FC_TARGET_STOP)
917 return (0);
918 }
920 /* Update the value cache */
921 uc_update (ds, vl);
923 if (post_cache_chain != NULL)
924 {
925 status = fc_process_chain (ds, vl, post_cache_chain);
926 if (status < 0)
927 {
928 WARNING ("plugin_dispatch_values: Running the "
929 "post-cache chain failed with "
930 "status %i (%#x).",
931 status, status);
932 }
933 }
934 else
935 fc_default_action (ds, vl);
937 return (0);
938 } /* int plugin_dispatch_values */
940 int plugin_dispatch_notification (const notification_t *notif)
941 {
942 int (*callback) (const notification_t *);
943 llentry_t *le;
944 /* Possible TODO: Add flap detection here */
946 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
947 "time = %u; host = %s;",
948 notif->severity, notif->message,
949 (unsigned int) notif->time, notif->host);
951 /* Nobody cares for notifications */
952 if (list_notification == NULL)
953 return (-1);
955 le = llist_head (list_notification);
956 while (le != NULL)
957 {
958 callback = (int (*) (const notification_t *)) le->value;
959 (*callback) (notif);
961 le = le->next;
962 }
964 return (0);
965 } /* int plugin_dispatch_notification */
967 void plugin_log (int level, const char *format, ...)
968 {
969 char msg[1024];
970 va_list ap;
972 void (*callback) (int, const char *);
973 llentry_t *le;
975 if (list_log == NULL)
976 return;
978 #if !COLLECT_DEBUG
979 if (level >= LOG_DEBUG)
980 return;
981 #endif
983 va_start (ap, format);
984 vsnprintf (msg, sizeof (msg), format, ap);
985 msg[sizeof (msg) - 1] = '\0';
986 va_end (ap);
988 le = llist_head (list_log);
989 while (le != NULL)
990 {
991 callback = (void (*) (int, const char *)) le->value;
992 (*callback) (level, msg);
994 le = le->next;
995 }
996 } /* void plugin_log */
998 const data_set_t *plugin_get_ds (const char *name)
999 {
1000 data_set_t *ds;
1002 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1003 {
1004 DEBUG ("No such dataset registered: %s", name);
1005 return (NULL);
1006 }
1008 return (ds);
1009 } /* data_set_t *plugin_get_ds */
1011 static int plugin_notification_meta_add (notification_t *n,
1012 const char *name,
1013 enum notification_meta_type_e type,
1014 const void *value)
1015 {
1016 notification_meta_t *meta;
1017 notification_meta_t *tail;
1019 if ((n == NULL) || (name == NULL) || (value == NULL))
1020 {
1021 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1022 return (-1);
1023 }
1025 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1026 if (meta == NULL)
1027 {
1028 ERROR ("plugin_notification_meta_add: malloc failed.");
1029 return (-1);
1030 }
1031 memset (meta, 0, sizeof (notification_meta_t));
1033 sstrncpy (meta->name, name, sizeof (meta->name));
1034 meta->type = type;
1036 switch (type)
1037 {
1038 case NM_TYPE_STRING:
1039 {
1040 meta->nm_value.nm_string = strdup ((const char *) value);
1041 if (meta->nm_value.nm_string == NULL)
1042 {
1043 ERROR ("plugin_notification_meta_add: strdup failed.");
1044 sfree (meta);
1045 return (-1);
1046 }
1047 break;
1048 }
1049 case NM_TYPE_SIGNED_INT:
1050 {
1051 meta->nm_value.nm_signed_int = *((int64_t *) value);
1052 break;
1053 }
1054 case NM_TYPE_UNSIGNED_INT:
1055 {
1056 meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1057 break;
1058 }
1059 case NM_TYPE_DOUBLE:
1060 {
1061 meta->nm_value.nm_double = *((double *) value);
1062 break;
1063 }
1064 case NM_TYPE_BOOLEAN:
1065 {
1066 meta->nm_value.nm_boolean = *((bool *) value);
1067 break;
1068 }
1069 default:
1070 {
1071 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1072 sfree (meta);
1073 return (-1);
1074 }
1075 } /* switch (type) */
1077 meta->next = NULL;
1078 tail = n->meta;
1079 while ((tail != NULL) && (tail->next != NULL))
1080 tail = tail->next;
1082 if (tail == NULL)
1083 n->meta = meta;
1084 else
1085 tail->next = meta;
1087 return (0);
1088 } /* int plugin_notification_meta_add */
1090 int plugin_notification_meta_add_string (notification_t *n,
1091 const char *name,
1092 const char *value)
1093 {
1094 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1095 }
1097 int plugin_notification_meta_add_signed_int (notification_t *n,
1098 const char *name,
1099 int64_t value)
1100 {
1101 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1102 }
1104 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1105 const char *name,
1106 uint64_t value)
1107 {
1108 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1109 }
1111 int plugin_notification_meta_add_double (notification_t *n,
1112 const char *name,
1113 double value)
1114 {
1115 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1116 }
1118 int plugin_notification_meta_add_boolean (notification_t *n,
1119 const char *name,
1120 bool value)
1121 {
1122 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1123 }
1125 int plugin_notification_meta_copy (notification_t *dst,
1126 const notification_t *src)
1127 {
1128 notification_meta_t *meta;
1130 assert (dst != NULL);
1131 assert (src != NULL);
1132 assert (dst != src);
1133 assert ((src->meta == NULL) || (src->meta != dst->meta));
1135 for (meta = src->meta; meta != NULL; meta = meta->next)
1136 {
1137 if (meta->type == NM_TYPE_STRING)
1138 plugin_notification_meta_add_string (dst, meta->name,
1139 meta->nm_value.nm_string);
1140 else if (meta->type == NM_TYPE_SIGNED_INT)
1141 plugin_notification_meta_add_signed_int (dst, meta->name,
1142 meta->nm_value.nm_signed_int);
1143 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1144 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1145 meta->nm_value.nm_unsigned_int);
1146 else if (meta->type == NM_TYPE_DOUBLE)
1147 plugin_notification_meta_add_double (dst, meta->name,
1148 meta->nm_value.nm_double);
1149 else if (meta->type == NM_TYPE_BOOLEAN)
1150 plugin_notification_meta_add_boolean (dst, meta->name,
1151 meta->nm_value.nm_boolean);
1152 }
1154 return (0);
1155 } /* int plugin_notification_meta_copy */
1157 int plugin_notification_meta_free (notification_meta_t *n)
1158 {
1159 notification_meta_t *this;
1160 notification_meta_t *next;
1162 if (n == NULL)
1163 {
1164 ERROR ("plugin_notification_meta_free: n == NULL!");
1165 return (-1);
1166 }
1168 this = n;
1169 while (this != NULL)
1170 {
1171 next = this->next;
1173 if (this->type == NM_TYPE_STRING)
1174 {
1175 free ((char *)this->nm_value.nm_string);
1176 this->nm_value.nm_string = NULL;
1177 }
1178 sfree (this);
1180 this = next;
1181 }
1183 return (0);
1184 } /* int plugin_notification_meta_free */