4d503f7c457196493cdb1ce5c9e852d9f44cc8a5
1 /**
2 * collectd - src/plugin.c
3 * Copyright (C) 2005-2008 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"
40 /*
41 * Private structures
42 */
43 struct read_func_s
44 {
45 int wait_time;
46 int wait_left;
47 int (*callback) (void);
48 enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
49 };
50 typedef struct read_func_s read_func_t;
52 /*
53 * Private variables
54 */
55 static llist_t *list_init;
56 static llist_t *list_read;
57 static llist_t *list_write;
58 static llist_t *list_filter;
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 c_avl_tree_t *data_sets;
66 static char *plugindir = NULL;
68 static int read_loop = 1;
69 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
70 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
71 static pthread_t *read_threads = NULL;
72 static int read_threads_num = 0;
74 /*
75 * Static functions
76 */
77 static const char *plugin_get_dir (void)
78 {
79 if (plugindir == NULL)
80 return (PLUGINDIR);
81 else
82 return (plugindir);
83 }
85 static int register_callback (llist_t **list, const char *name, void *callback)
86 {
87 llentry_t *le;
88 char *key;
90 if ((*list == NULL)
91 && ((*list = llist_create ()) == NULL))
92 return (-1);
94 le = llist_search (*list, name);
95 if (le == NULL)
96 {
97 key = strdup (name);
98 if (key == NULL)
99 return (-1);
101 le = llentry_create (key, callback);
102 if (le == NULL)
103 {
104 free (key);
105 return (-1);
106 }
108 llist_append (*list, le);
109 }
110 else
111 {
112 le->value = callback;
113 }
115 return (0);
116 } /* int register_callback */
118 static int plugin_unregister (llist_t *list, const char *name)
119 {
120 llentry_t *e;
122 e = llist_search (list, name);
124 if (e == NULL)
125 return (-1);
127 llist_remove (list, e);
128 free (e->key);
129 llentry_destroy (e);
131 return (0);
132 } /* int plugin_unregister */
134 /*
135 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
136 * object, but it will bitch about a shared object not having a
137 * ``module_register'' symbol..
138 */
139 static int plugin_load_file (char *file)
140 {
141 lt_dlhandle dlh;
142 void (*reg_handle) (void);
144 DEBUG ("file = %s", file);
146 lt_dlinit ();
147 lt_dlerror (); /* clear errors */
149 if ((dlh = lt_dlopen (file)) == NULL)
150 {
151 const char *error = lt_dlerror ();
153 ERROR ("lt_dlopen (%s) failed: %s", file, error);
154 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
155 return (1);
156 }
158 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
159 {
160 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
161 file, lt_dlerror ());
162 lt_dlclose (dlh);
163 return (-1);
164 }
166 (*reg_handle) ();
168 return (0);
169 }
171 static void *plugin_read_thread (void *args)
172 {
173 llentry_t *le;
174 read_func_t *rf;
175 int status;
176 int done;
178 pthread_mutex_lock (&read_lock);
180 while (read_loop != 0)
181 {
182 le = llist_head (list_read);
183 done = 0;
185 while ((read_loop != 0) && (le != NULL))
186 {
187 rf = (read_func_t *) le->value;
189 if (rf->needs_read != TODO)
190 {
191 le = le->next;
192 continue;
193 }
195 /* We will do this read function */
196 rf->needs_read = ACTIVE;
198 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
199 (unsigned long int) pthread_self (), le->key);
200 pthread_mutex_unlock (&read_lock);
202 status = rf->callback ();
203 done++;
205 if (status != 0)
206 {
207 if (rf->wait_time < interval_g)
208 rf->wait_time = interval_g;
209 rf->wait_left = rf->wait_time;
210 rf->wait_time = rf->wait_time * 2;
211 if (rf->wait_time > 86400)
212 rf->wait_time = 86400;
214 NOTICE ("read-function of plugin `%s' "
215 "failed. Will suspend it for %i "
216 "seconds.", le->key, rf->wait_left);
217 }
218 else
219 {
220 rf->wait_left = 0;
221 rf->wait_time = interval_g;
222 }
224 pthread_mutex_lock (&read_lock);
226 rf->needs_read = DONE;
227 le = le->next;
228 } /* while (le != NULL) */
230 if ((read_loop != 0) && (done == 0))
231 {
232 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
233 (unsigned long int) pthread_self ());
234 pthread_cond_wait (&read_cond, &read_lock);
235 }
236 } /* while (read_loop) */
238 pthread_mutex_unlock (&read_lock);
240 pthread_exit (NULL);
241 return ((void *) 0);
242 } /* void *plugin_read_thread */
244 static void start_threads (int num)
245 {
246 int i;
248 if (read_threads != NULL)
249 return;
251 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
252 if (read_threads == NULL)
253 {
254 ERROR ("plugin: start_threads: calloc failed.");
255 return;
256 }
258 read_threads_num = 0;
259 for (i = 0; i < num; i++)
260 {
261 if (pthread_create (read_threads + read_threads_num, NULL,
262 plugin_read_thread, NULL) == 0)
263 {
264 read_threads_num++;
265 }
266 else
267 {
268 ERROR ("plugin: start_threads: pthread_create failed.");
269 return;
270 }
271 } /* for (i) */
272 } /* void start_threads */
274 static void stop_threads (void)
275 {
276 int i;
278 pthread_mutex_lock (&read_lock);
279 read_loop = 0;
280 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
281 pthread_cond_broadcast (&read_cond);
282 pthread_mutex_unlock (&read_lock);
284 for (i = 0; i < read_threads_num; i++)
285 {
286 if (pthread_join (read_threads[i], NULL) != 0)
287 {
288 ERROR ("plugin: stop_threads: pthread_join failed.");
289 }
290 read_threads[i] = (pthread_t) 0;
291 }
292 sfree (read_threads);
293 read_threads_num = 0;
294 } /* void stop_threads */
296 /*
297 * Public functions
298 */
299 void plugin_set_dir (const char *dir)
300 {
301 if (plugindir != NULL)
302 free (plugindir);
304 if (dir == NULL)
305 plugindir = NULL;
306 else if ((plugindir = strdup (dir)) == NULL)
307 {
308 char errbuf[1024];
309 ERROR ("strdup failed: %s",
310 sstrerror (errno, errbuf, sizeof (errbuf)));
311 }
312 }
314 #define BUFSIZE 512
315 int plugin_load (const char *type)
316 {
317 DIR *dh;
318 const char *dir;
319 char filename[BUFSIZE] = "";
320 char typename[BUFSIZE];
321 int typename_len;
322 int ret;
323 struct stat statbuf;
324 struct dirent *de;
326 DEBUG ("type = %s", type);
328 dir = plugin_get_dir ();
329 ret = 1;
331 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
332 * type when matching the filename */
333 if (ssnprintf (typename, sizeof (typename),
334 "%s.so", type) >= sizeof (typename))
335 {
336 WARNING ("snprintf: truncated: `%s.so'", type);
337 return (-1);
338 }
339 typename_len = strlen (typename);
341 if ((dh = opendir (dir)) == NULL)
342 {
343 char errbuf[1024];
344 ERROR ("opendir (%s): %s", dir,
345 sstrerror (errno, errbuf, sizeof (errbuf)));
346 return (-1);
347 }
349 while ((de = readdir (dh)) != NULL)
350 {
351 if (strncasecmp (de->d_name, typename, typename_len))
352 continue;
354 if (ssnprintf (filename, sizeof (filename),
355 "%s/%s", dir, de->d_name) >= sizeof (filename))
356 {
357 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
358 continue;
359 }
361 if (lstat (filename, &statbuf) == -1)
362 {
363 char errbuf[1024];
364 WARNING ("stat %s: %s", filename,
365 sstrerror (errno, errbuf, sizeof (errbuf)));
366 continue;
367 }
368 else if (!S_ISREG (statbuf.st_mode))
369 {
370 /* don't follow symlinks */
371 continue;
372 }
374 if (plugin_load_file (filename) == 0)
375 {
376 /* success */
377 ret = 0;
378 break;
379 }
380 else
381 {
382 fprintf (stderr, "Unable to load plugin %s.\n", type);
383 }
384 }
386 closedir (dh);
388 if (filename[0] == '\0')
389 fprintf (stderr, "Could not find plugin %s.\n", type);
391 return (ret);
392 }
394 /*
395 * The `register_*' functions follow
396 */
397 int plugin_register_config (const char *name,
398 int (*callback) (const char *key, const char *val),
399 const char **keys, int keys_num)
400 {
401 cf_register (name, callback, keys, keys_num);
402 return (0);
403 } /* int plugin_register_config */
405 int plugin_register_complex_config (const char *type,
406 int (*callback) (oconfig_item_t *))
407 {
408 return (cf_register_complex (type, callback));
409 } /* int plugin_register_complex_config */
411 int plugin_register_init (const char *name,
412 int (*callback) (void))
413 {
414 return (register_callback (&list_init, name, (void *) callback));
415 } /* plugin_register_init */
417 int plugin_register_read (const char *name,
418 int (*callback) (void))
419 {
420 read_func_t *rf;
422 rf = (read_func_t *) malloc (sizeof (read_func_t));
423 if (rf == NULL)
424 {
425 char errbuf[1024];
426 ERROR ("plugin_register_read: malloc failed: %s",
427 sstrerror (errno, errbuf, sizeof (errbuf)));
428 return (-1);
429 }
431 memset (rf, '\0', sizeof (read_func_t));
432 rf->wait_time = interval_g;
433 rf->wait_left = 0;
434 rf->callback = callback;
435 rf->needs_read = DONE;
437 return (register_callback (&list_read, name, (void *) rf));
438 } /* int plugin_register_read */
440 int plugin_register_write (const char *name,
441 int (*callback) (const data_set_t *ds, const value_list_t *vl))
442 {
443 return (register_callback (&list_write, name, (void *) callback));
444 } /* int plugin_register_write */
446 int plugin_register_filter (const char *name,
447 int (*callback) (const data_set_t *ds, value_list_t *vl))
448 {
449 return (register_callback (&list_filter, name, (void *) callback));
450 } /* int plugin_register_filter */
452 int plugin_register_flush (const char *name,
453 int (*callback) (const int timeout, const char *identifier))
454 {
455 return (register_callback (&list_flush, name, (void *) callback));
456 } /* int plugin_register_flush */
458 int plugin_register_shutdown (char *name,
459 int (*callback) (void))
460 {
461 return (register_callback (&list_shutdown, name, (void *) callback));
462 } /* int plugin_register_shutdown */
464 int plugin_register_data_set (const data_set_t *ds)
465 {
466 data_set_t *ds_copy;
467 int i;
469 if ((data_sets != NULL)
470 && (c_avl_get (data_sets, ds->type, NULL) == 0))
471 {
472 NOTICE ("Replacing DS `%s' with another version.", ds->type);
473 plugin_unregister_data_set (ds->type);
474 }
475 else if (data_sets == NULL)
476 {
477 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
478 if (data_sets == NULL)
479 return (-1);
480 }
482 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
483 if (ds_copy == NULL)
484 return (-1);
485 memcpy(ds_copy, ds, sizeof (data_set_t));
487 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
488 * ds->ds_num);
489 if (ds_copy->ds == NULL)
490 {
491 free (ds_copy);
492 return (-1);
493 }
495 for (i = 0; i < ds->ds_num; i++)
496 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
498 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
499 } /* int plugin_register_data_set */
501 int plugin_register_log (char *name,
502 void (*callback) (int priority, const char *msg))
503 {
504 return (register_callback (&list_log, name, (void *) callback));
505 } /* int plugin_register_log */
507 int plugin_register_notification (const char *name,
508 int (*callback) (const notification_t *notif))
509 {
510 return (register_callback (&list_notification, name, (void *) callback));
511 } /* int plugin_register_log */
513 int plugin_unregister_config (const char *name)
514 {
515 cf_unregister (name);
516 return (0);
517 } /* int plugin_unregister_config */
519 int plugin_unregister_complex_config (const char *name)
520 {
521 cf_unregister_complex (name);
522 return (0);
523 } /* int plugin_unregister_complex_config */
525 int plugin_unregister_init (const char *name)
526 {
527 return (plugin_unregister (list_init, name));
528 }
530 int plugin_unregister_read (const char *name)
531 {
532 llentry_t *e;
534 e = llist_search (list_read, name);
536 if (e == NULL)
537 return (-1);
539 llist_remove (list_read, e);
540 free (e->value);
541 free (e->key);
542 llentry_destroy (e);
544 return (0);
545 }
547 int plugin_unregister_write (const char *name)
548 {
549 return (plugin_unregister (list_write, name));
550 }
552 int plugin_unregister_filter (const char *name)
553 {
554 return (plugin_unregister (list_filter, name));
555 }
557 int plugin_unregister_flush (const char *name)
558 {
559 return (plugin_unregister (list_flush, name));
560 }
562 int plugin_unregister_shutdown (const char *name)
563 {
564 return (plugin_unregister (list_shutdown, name));
565 }
567 int plugin_unregister_data_set (const char *name)
568 {
569 data_set_t *ds;
571 if (data_sets == NULL)
572 return (-1);
574 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
575 return (-1);
577 sfree (ds->ds);
578 sfree (ds);
580 return (0);
581 } /* int plugin_unregister_data_set */
583 int plugin_unregister_log (const char *name)
584 {
585 return (plugin_unregister (list_log, name));
586 }
588 int plugin_unregister_notification (const char *name)
589 {
590 return (plugin_unregister (list_notification, name));
591 }
593 void plugin_init_all (void)
594 {
595 int (*callback) (void);
596 llentry_t *le;
597 int status;
599 /* Init the value cache */
600 uc_init ();
602 if ((list_init == NULL) && (list_read == NULL))
603 return;
605 /* Calling all init callbacks before checking if read callbacks
606 * are available allows the init callbacks to register the read
607 * callback. */
608 le = llist_head (list_init);
609 while (le != NULL)
610 {
611 callback = (int (*) (void)) le->value;
612 status = (*callback) ();
614 if (status != 0)
615 {
616 ERROR ("Initialization of plugin `%s' "
617 "failed with status %i. "
618 "Plugin will be unloaded.",
619 le->key, status);
620 /* Plugins that register read callbacks from the init
621 * callback should take care of appropriate error
622 * handling themselves. */
623 /* FIXME: Unload _all_ functions */
624 plugin_unregister_read (le->key);
625 }
627 le = le->next;
628 }
630 /* Start read-threads */
631 if (list_read != NULL)
632 {
633 const char *rt;
634 int num;
635 rt = global_option_get ("ReadThreads");
636 num = atoi (rt);
637 start_threads ((num > 0) ? num : 5);
638 }
639 } /* void plugin_init_all */
641 void plugin_read_all (void)
642 {
643 llentry_t *le;
644 read_func_t *rf;
646 uc_check_timeout ();
648 if (list_read == NULL)
649 return;
651 pthread_mutex_lock (&read_lock);
653 le = llist_head (list_read);
654 while (le != NULL)
655 {
656 rf = (read_func_t *) le->value;
658 if (rf->needs_read != DONE)
659 {
660 le = le->next;
661 continue;
662 }
664 if (rf->wait_left > 0)
665 rf->wait_left -= interval_g;
667 if (rf->wait_left <= 0)
668 {
669 rf->needs_read = TODO;
670 }
672 le = le->next;
673 }
675 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
676 pthread_cond_broadcast (&read_cond);
677 pthread_mutex_unlock (&read_lock);
678 } /* void plugin_read_all */
680 int plugin_flush (const char *plugin, int timeout, const char *identifier)
681 {
682 int (*callback) (int timeout, const char *identifier);
683 llentry_t *le;
685 if (list_flush == NULL)
686 return (0);
688 le = llist_head (list_flush);
689 while (le != NULL)
690 {
691 if ((plugin != NULL)
692 && (strcmp (plugin, le->key) != 0))
693 {
694 le = le->next;
695 continue;
696 }
698 callback = (int (*) (int, const char *)) le->value;
699 (*callback) (timeout, identifier);
701 le = le->next;
702 }
703 return (0);
704 } /* int plugin_flush */
706 void plugin_shutdown_all (void)
707 {
708 int (*callback) (void);
709 llentry_t *le;
711 stop_threads ();
713 if (list_shutdown == NULL)
714 return;
716 le = llist_head (list_shutdown);
717 while (le != NULL)
718 {
719 callback = (int (*) (void)) le->value;
721 /* Advance the pointer before calling the callback allows
722 * shutdown functions to unregister themselves. If done the
723 * other way around the memory `le' points to will be freed
724 * after callback returns. */
725 le = le->next;
727 (*callback) ();
728 }
729 } /* void plugin_shutdown_all */
731 int plugin_dispatch_values (value_list_t *vl)
732 {
733 static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
735 data_set_t *ds;
736 llentry_t *le;
738 int filter = 0;
740 if ((vl == NULL) || (*vl->type == '\0')) {
741 ERROR ("plugin_dispatch_values: Invalid value list.");
742 return (-1);
743 }
745 if (list_write == NULL)
746 c_complain_once (LOG_WARNING, &no_write_complaint,
747 "plugin_dispatch_values: No write callback has been "
748 "registered. Please load at least one output plugin, "
749 "if you want the collected data to be stored.");
751 if (data_sets == NULL)
752 {
753 ERROR ("plugin_dispatch_values: No data sets registered. "
754 "Could the types database be read? Check "
755 "your `TypesDB' setting!");
756 return (-1);
757 }
759 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
760 {
761 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
762 return (-1);
763 }
765 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
766 "host = %s; "
767 "plugin = %s; plugin_instance = %s; "
768 "type = %s; type_instance = %s;",
769 (unsigned int) vl->time, vl->interval,
770 vl->host,
771 vl->plugin, vl->plugin_instance,
772 vl->type, vl->type_instance);
774 #if COLLECT_DEBUG
775 assert (0 == strcmp (ds->type, vl->type));
776 #else
777 if (0 != strcmp (ds->type, vl->type))
778 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
779 ds->type, vl->type);
780 #endif
782 #if COLLECT_DEBUG
783 assert (ds->ds_num == vl->values_len);
784 #else
785 if (ds->ds_num != vl->values_len)
786 {
787 ERROR ("plugin_dispatch_values: ds->type = %s: "
788 "(ds->ds_num = %i) != "
789 "(vl->values_len = %i)",
790 ds->type, ds->ds_num, vl->values_len);
791 return (-1);
792 }
793 #endif
795 escape_slashes (vl->host, sizeof (vl->host));
796 escape_slashes (vl->plugin, sizeof (vl->plugin));
797 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
798 escape_slashes (vl->type, sizeof (vl->type));
799 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
801 le = llist_head (list_filter);
802 while (le != NULL)
803 {
804 int (*filter_callback) (const data_set_t *, value_list_t *) =
805 (int (*) (const data_set_t *, value_list_t *)) le->value;
807 filter |= (*filter_callback) (ds, vl);
809 if (filter == FILTER_IGNORE)
810 return (-1);
812 le = le->next;
813 }
815 /* Update the value cache */
816 uc_update (ds, vl);
818 if ((filter & FILTER_NOTHRESHOLD_CHECK) == 0)
819 ut_check_threshold (ds, vl);
821 if (filter & FILTER_NOWRITE)
822 return (0);
824 le = llist_head (list_write);
825 while (le != NULL)
826 {
827 int (*write_callback) (const data_set_t *, const value_list_t *) =
828 (int (*) (const data_set_t *, const value_list_t *)) le->value;
830 (*write_callback) (ds, vl);
832 le = le->next;
833 }
835 return (0);
836 } /* int plugin_dispatch_values */
838 int plugin_dispatch_notification (const notification_t *notif)
839 {
840 int (*callback) (const notification_t *);
841 llentry_t *le;
842 /* Possible TODO: Add flap detection here */
844 DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
845 "time = %u; host = %s;",
846 notif->severity, notif->message,
847 (unsigned int) notif->time, notif->host);
849 /* Nobody cares for notifications */
850 if (list_notification == NULL)
851 return (-1);
853 le = llist_head (list_notification);
854 while (le != NULL)
855 {
856 callback = (int (*) (const notification_t *)) le->value;
857 (*callback) (notif);
859 le = le->next;
860 }
862 return (0);
863 } /* int plugin_dispatch_notification */
865 void plugin_log (int level, const char *format, ...)
866 {
867 char msg[1024];
868 va_list ap;
870 void (*callback) (int, const char *);
871 llentry_t *le;
873 if (list_log == NULL)
874 return;
876 #if !COLLECT_DEBUG
877 if (level >= LOG_DEBUG)
878 return;
879 #endif
881 va_start (ap, format);
882 vsnprintf (msg, sizeof (msg), format, ap);
883 msg[sizeof (msg) - 1] = '\0';
884 va_end (ap);
886 le = llist_head (list_log);
887 while (le != NULL)
888 {
889 callback = (void (*) (int, const char *)) le->value;
890 (*callback) (level, msg);
892 le = le->next;
893 }
894 } /* void plugin_log */
896 const data_set_t *plugin_get_ds (const char *name)
897 {
898 data_set_t *ds;
900 if (c_avl_get (data_sets, name, (void *) &ds) != 0)
901 {
902 DEBUG ("No such dataset registered: %s", name);
903 return (NULL);
904 }
906 return (ds);
907 } /* data_set_t *plugin_get_ds */
909 static int plugin_notification_meta_add (notification_t *n,
910 const char *name,
911 enum notification_meta_type_e type,
912 const void *value)
913 {
914 notification_meta_t *meta;
915 notification_meta_t *tail;
917 if ((n == NULL) || (name == NULL) || (value == NULL))
918 {
919 ERROR ("plugin_notification_meta_add: A pointer is NULL!");
920 return (-1);
921 }
923 meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
924 if (meta == NULL)
925 {
926 ERROR ("plugin_notification_meta_add: malloc failed.");
927 return (-1);
928 }
929 memset (meta, 0, sizeof (notification_meta_t));
931 sstrncpy (meta->name, name, sizeof (meta->name));
932 meta->type = type;
934 switch (type)
935 {
936 case NM_TYPE_STRING:
937 {
938 meta->value_string = strdup ((const char *) value);
939 if (meta->value_string == NULL)
940 {
941 ERROR ("plugin_notification_meta_add: strdup failed.");
942 sfree (meta);
943 return (-1);
944 }
945 break;
946 }
947 case NM_TYPE_SIGNED_INT:
948 {
949 meta->value_signed_int = *((int64_t *) value);
950 break;
951 }
952 case NM_TYPE_UNSIGNED_INT:
953 {
954 meta->value_unsigned_int = *((uint64_t *) value);
955 break;
956 }
957 case NM_TYPE_DOUBLE:
958 {
959 meta->value_double = *((double *) value);
960 break;
961 }
962 case NM_TYPE_BOOLEAN:
963 {
964 meta->value_boolean = *((bool *) value);
965 break;
966 }
967 default:
968 {
969 ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
970 sfree (meta);
971 return (-1);
972 }
973 } /* switch (type) */
975 meta->next = NULL;
976 tail = n->meta;
977 while ((tail != NULL) && (tail->next != NULL))
978 tail = tail->next;
980 if (tail == NULL)
981 n->meta = meta;
982 else
983 tail->next = meta;
985 return (0);
986 } /* int plugin_notification_meta_add */
988 int plugin_notification_meta_add_string (notification_t *n,
989 const char *name,
990 const char *value)
991 {
992 return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
993 }
995 int plugin_notification_meta_add_signed_int (notification_t *n,
996 const char *name,
997 int64_t value)
998 {
999 return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1000 }
1002 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1003 const char *name,
1004 uint64_t value)
1005 {
1006 return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1007 }
1009 int plugin_notification_meta_add_double (notification_t *n,
1010 const char *name,
1011 double value)
1012 {
1013 return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1014 }
1016 int plugin_notification_meta_add_boolean (notification_t *n,
1017 const char *name,
1018 bool value)
1019 {
1020 return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1021 }
1023 int plugin_notification_meta_copy (notification_t *dst,
1024 const notification_t *src)
1025 {
1026 notification_meta_t *meta;
1028 assert (dst != NULL);
1029 assert (src != NULL);
1030 assert (dst != src);
1031 assert ((src->meta == NULL) || (src->meta != dst->meta));
1033 for (meta = src->meta; meta != NULL; meta = meta->next)
1034 {
1035 if (meta->type == NM_TYPE_STRING)
1036 plugin_notification_meta_add_string (dst, meta->name,
1037 meta->value_string);
1038 else if (meta->type == NM_TYPE_SIGNED_INT)
1039 plugin_notification_meta_add_signed_int (dst, meta->name,
1040 meta->value_signed_int);
1041 else if (meta->type == NM_TYPE_UNSIGNED_INT)
1042 plugin_notification_meta_add_unsigned_int (dst, meta->name,
1043 meta->value_unsigned_int);
1044 else if (meta->type == NM_TYPE_DOUBLE)
1045 plugin_notification_meta_add_double (dst, meta->name,
1046 meta->value_double);
1047 else if (meta->type == NM_TYPE_BOOLEAN)
1048 plugin_notification_meta_add_boolean (dst, meta->name,
1049 meta->value_boolean);
1050 }
1052 return (0);
1053 } /* int plugin_notification_meta_copy */
1055 int plugin_notification_meta_free (notification_t *n)
1056 {
1057 notification_meta_t *this;
1058 notification_meta_t *next;
1060 if (n == NULL)
1061 {
1062 ERROR ("plugin_notification_meta_free: n == NULL!");
1063 return (-1);
1064 }
1066 this = n->meta;
1067 n->meta = NULL;
1068 while (this != NULL)
1069 {
1070 next = this->next;
1072 if (this->type == NM_TYPE_STRING)
1073 {
1074 free ((char *)this->value_string);
1075 this->value_string = NULL;
1076 }
1077 sfree (this);
1079 this = next;
1080 }
1082 return (0);
1083 } /* int plugin_notification_meta_free */