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_flush;
59 static llist_t *list_shutdown;
60 static llist_t *list_log;
61 static llist_t *list_notification;
63 static c_avl_tree_t *data_sets;
65 static char *plugindir = NULL;
67 static int read_loop = 1;
68 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
69 static pthread_cond_t read_cond = PTHREAD_COND_INITIALIZER;
70 static pthread_t *read_threads = NULL;
71 static int read_threads_num = 0;
73 /*
74 * Static functions
75 */
76 static const char *plugin_get_dir (void)
77 {
78 if (plugindir == NULL)
79 return (PLUGINDIR);
80 else
81 return (plugindir);
82 }
84 static int register_callback (llist_t **list, const char *name, void *callback)
85 {
86 llentry_t *le;
87 char *key;
89 if ((*list == NULL)
90 && ((*list = llist_create ()) == NULL))
91 return (-1);
93 le = llist_search (*list, name);
94 if (le == NULL)
95 {
96 key = strdup (name);
97 if (key == NULL)
98 return (-1);
100 le = llentry_create (key, callback);
101 if (le == NULL)
102 {
103 free (key);
104 return (-1);
105 }
107 llist_append (*list, le);
108 }
109 else
110 {
111 le->value = callback;
112 }
114 return (0);
115 } /* int register_callback */
117 static int plugin_unregister (llist_t *list, const char *name)
118 {
119 llentry_t *e;
121 e = llist_search (list, name);
123 if (e == NULL)
124 return (-1);
126 llist_remove (list, e);
127 free (e->key);
128 llentry_destroy (e);
130 return (0);
131 } /* int plugin_unregister */
133 /*
134 * (Try to) load the shared object `file'. Won't complain if it isn't a shared
135 * object, but it will bitch about a shared object not having a
136 * ``module_register'' symbol..
137 */
138 static int plugin_load_file (char *file)
139 {
140 lt_dlhandle dlh;
141 void (*reg_handle) (void);
143 DEBUG ("file = %s", file);
145 lt_dlinit ();
146 lt_dlerror (); /* clear errors */
148 if ((dlh = lt_dlopen (file)) == NULL)
149 {
150 const char *error = lt_dlerror ();
152 ERROR ("lt_dlopen failed: %s", error);
153 fprintf (stderr, "lt_dlopen failed: %s\n", error);
154 return (1);
155 }
157 if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
158 {
159 WARNING ("Couldn't find symbol ``module_register'' in ``%s'': %s\n",
160 file, lt_dlerror ());
161 lt_dlclose (dlh);
162 return (-1);
163 }
165 (*reg_handle) ();
167 return (0);
168 }
170 static void *plugin_read_thread (void *args)
171 {
172 llentry_t *le;
173 read_func_t *rf;
174 int status;
175 int done;
177 pthread_mutex_lock (&read_lock);
179 while (read_loop != 0)
180 {
181 le = llist_head (list_read);
182 done = 0;
184 while ((read_loop != 0) && (le != NULL))
185 {
186 rf = (read_func_t *) le->value;
188 if (rf->needs_read != TODO)
189 {
190 le = le->next;
191 continue;
192 }
194 /* We will do this read function */
195 rf->needs_read = ACTIVE;
197 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
198 (unsigned long int) pthread_self (), le->key);
199 pthread_mutex_unlock (&read_lock);
201 status = rf->callback ();
202 done++;
204 if (status != 0)
205 {
206 if (rf->wait_time < interval_g)
207 rf->wait_time = interval_g;
208 rf->wait_left = rf->wait_time;
209 rf->wait_time = rf->wait_time * 2;
210 if (rf->wait_time > 86400)
211 rf->wait_time = 86400;
213 NOTICE ("read-function of plugin `%s' "
214 "failed. Will suspend it for %i "
215 "seconds.", le->key, rf->wait_left);
216 }
217 else
218 {
219 rf->wait_left = 0;
220 rf->wait_time = interval_g;
221 }
223 pthread_mutex_lock (&read_lock);
225 rf->needs_read = DONE;
226 le = le->next;
227 } /* while (le != NULL) */
229 if ((read_loop != 0) && (done == 0))
230 {
231 DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
232 (unsigned long int) pthread_self ());
233 pthread_cond_wait (&read_cond, &read_lock);
234 }
235 } /* while (read_loop) */
237 pthread_mutex_unlock (&read_lock);
239 pthread_exit (NULL);
240 return ((void *) 0);
241 } /* void *plugin_read_thread */
243 static void start_threads (int num)
244 {
245 int i;
247 if (read_threads != NULL)
248 return;
250 read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
251 if (read_threads == NULL)
252 {
253 ERROR ("plugin: start_threads: calloc failed.");
254 return;
255 }
257 read_threads_num = 0;
258 for (i = 0; i < num; i++)
259 {
260 if (pthread_create (read_threads + read_threads_num, NULL,
261 plugin_read_thread, NULL) == 0)
262 {
263 read_threads_num++;
264 }
265 else
266 {
267 ERROR ("plugin: start_threads: pthread_create failed.");
268 return;
269 }
270 } /* for (i) */
271 } /* void start_threads */
273 static void stop_threads (void)
274 {
275 int i;
277 pthread_mutex_lock (&read_lock);
278 read_loop = 0;
279 DEBUG ("plugin: stop_threads: Signalling `read_cond'");
280 pthread_cond_broadcast (&read_cond);
281 pthread_mutex_unlock (&read_lock);
283 for (i = 0; i < read_threads_num; i++)
284 {
285 if (pthread_join (read_threads[i], NULL) != 0)
286 {
287 ERROR ("plugin: stop_threads: pthread_join failed.");
288 }
289 read_threads[i] = (pthread_t) 0;
290 }
291 sfree (read_threads);
292 read_threads_num = 0;
293 } /* void stop_threads */
295 /*
296 * Public functions
297 */
298 void plugin_set_dir (const char *dir)
299 {
300 if (plugindir != NULL)
301 free (plugindir);
303 if (dir == NULL)
304 plugindir = NULL;
305 else if ((plugindir = strdup (dir)) == NULL)
306 {
307 char errbuf[1024];
308 ERROR ("strdup failed: %s",
309 sstrerror (errno, errbuf, sizeof (errbuf)));
310 }
311 }
313 #define BUFSIZE 512
314 int plugin_load (const char *type)
315 {
316 DIR *dh;
317 const char *dir;
318 char filename[BUFSIZE] = "";
319 char typename[BUFSIZE];
320 int typename_len;
321 int ret;
322 struct stat statbuf;
323 struct dirent *de;
325 DEBUG ("type = %s", type);
327 dir = plugin_get_dir ();
328 ret = 1;
330 /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
331 * type when matching the filename */
332 if (ssnprintf (typename, sizeof (typename),
333 "%s.so", type) >= sizeof (typename))
334 {
335 WARNING ("snprintf: truncated: `%s.so'", type);
336 return (-1);
337 }
338 typename_len = strlen (typename);
340 if ((dh = opendir (dir)) == NULL)
341 {
342 char errbuf[1024];
343 ERROR ("opendir (%s): %s", dir,
344 sstrerror (errno, errbuf, sizeof (errbuf)));
345 return (-1);
346 }
348 while ((de = readdir (dh)) != NULL)
349 {
350 if (strncasecmp (de->d_name, typename, typename_len))
351 continue;
353 if (ssnprintf (filename, sizeof (filename),
354 "%s/%s", dir, de->d_name) >= sizeof (filename))
355 {
356 WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
357 continue;
358 }
360 if (lstat (filename, &statbuf) == -1)
361 {
362 char errbuf[1024];
363 WARNING ("stat %s: %s", filename,
364 sstrerror (errno, errbuf, sizeof (errbuf)));
365 continue;
366 }
367 else if (!S_ISREG (statbuf.st_mode))
368 {
369 /* don't follow symlinks */
370 continue;
371 }
373 if (plugin_load_file (filename) == 0)
374 {
375 /* success */
376 ret = 0;
377 break;
378 }
379 else
380 {
381 fprintf (stderr, "Unable to load plugin %s.\n", type);
382 }
383 }
385 closedir (dh);
387 if (filename[0] == '\0')
388 fprintf (stderr, "Could not find plugin %s.\n", type);
390 return (ret);
391 }
393 /*
394 * The `register_*' functions follow
395 */
396 int plugin_register_config (const char *name,
397 int (*callback) (const char *key, const char *val),
398 const char **keys, int keys_num)
399 {
400 cf_register (name, callback, keys, keys_num);
401 return (0);
402 } /* int plugin_register_config */
404 int plugin_register_complex_config (const char *type,
405 int (*callback) (oconfig_item_t *))
406 {
407 return (cf_register_complex (type, callback));
408 } /* int plugin_register_complex_config */
410 int plugin_register_init (const char *name,
411 int (*callback) (void))
412 {
413 return (register_callback (&list_init, name, (void *) callback));
414 } /* plugin_register_init */
416 int plugin_register_read (const char *name,
417 int (*callback) (void))
418 {
419 read_func_t *rf;
421 rf = (read_func_t *) malloc (sizeof (read_func_t));
422 if (rf == NULL)
423 {
424 char errbuf[1024];
425 ERROR ("plugin_register_read: malloc failed: %s",
426 sstrerror (errno, errbuf, sizeof (errbuf)));
427 return (-1);
428 }
430 memset (rf, '\0', sizeof (read_func_t));
431 rf->wait_time = interval_g;
432 rf->wait_left = 0;
433 rf->callback = callback;
434 rf->needs_read = DONE;
436 return (register_callback (&list_read, name, (void *) rf));
437 } /* int plugin_register_read */
439 int plugin_register_write (const char *name,
440 int (*callback) (const data_set_t *ds, const value_list_t *vl))
441 {
442 return (register_callback (&list_write, name, (void *) callback));
443 } /* int plugin_register_write */
445 int plugin_register_flush (const char *name,
446 int (*callback) (const int timeout, const char *identifier))
447 {
448 return (register_callback (&list_flush, name, (void *) callback));
449 } /* int plugin_register_flush */
451 int plugin_register_shutdown (char *name,
452 int (*callback) (void))
453 {
454 return (register_callback (&list_shutdown, name, (void *) callback));
455 } /* int plugin_register_shutdown */
457 int plugin_register_data_set (const data_set_t *ds)
458 {
459 data_set_t *ds_copy;
460 int i;
462 if ((data_sets != NULL)
463 && (c_avl_get (data_sets, ds->type, NULL) == 0))
464 {
465 NOTICE ("Replacing DS `%s' with another version.", ds->type);
466 plugin_unregister_data_set (ds->type);
467 }
468 else if (data_sets == NULL)
469 {
470 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
471 if (data_sets == NULL)
472 return (-1);
473 }
475 ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
476 if (ds_copy == NULL)
477 return (-1);
478 memcpy(ds_copy, ds, sizeof (data_set_t));
480 ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
481 * ds->ds_num);
482 if (ds_copy->ds == NULL)
483 {
484 free (ds_copy);
485 return (-1);
486 }
488 for (i = 0; i < ds->ds_num; i++)
489 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
491 return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
492 } /* int plugin_register_data_set */
494 int plugin_register_log (char *name,
495 void (*callback) (int priority, const char *msg))
496 {
497 return (register_callback (&list_log, name, (void *) callback));
498 } /* int plugin_register_log */
500 int plugin_register_notification (const char *name,
501 int (*callback) (const notification_t *notif))
502 {
503 return (register_callback (&list_notification, name, (void *) callback));
504 } /* int plugin_register_log */
506 int plugin_unregister_config (const char *name)
507 {
508 cf_unregister (name);
509 return (0);
510 } /* int plugin_unregister_config */
512 int plugin_unregister_complex_config (const char *name)
513 {
514 cf_unregister_complex (name);
515 return (0);
516 } /* int plugin_unregister_complex_config */
518 int plugin_unregister_init (const char *name)
519 {
520 return (plugin_unregister (list_init, name));
521 }
523 int plugin_unregister_read (const char *name)
524 {
525 llentry_t *e;
527 e = llist_search (list_read, name);
529 if (e == NULL)
530 return (-1);
532 llist_remove (list_read, e);
533 free (e->value);
534 free (e->key);
535 llentry_destroy (e);
537 return (0);
538 }
540 int plugin_unregister_write (const char *name)
541 {
542 return (plugin_unregister (list_write, name));
543 }
545 int plugin_unregister_flush (const char *name)
546 {
547 return (plugin_unregister (list_flush, name));
548 }
550 int plugin_unregister_shutdown (const char *name)
551 {
552 return (plugin_unregister (list_shutdown, name));
553 }
555 int plugin_unregister_data_set (const char *name)
556 {
557 data_set_t *ds;
559 if (data_sets == NULL)
560 return (-1);
562 if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
563 return (-1);
565 sfree (ds->ds);
566 sfree (ds);
568 return (0);
569 } /* int plugin_unregister_data_set */
571 int plugin_unregister_log (const char *name)
572 {
573 return (plugin_unregister (list_log, name));
574 }
576 int plugin_unregister_notification (const char *name)
577 {
578 return (plugin_unregister (list_notification, name));
579 }
581 void plugin_init_all (void)
582 {
583 int (*callback) (void);
584 llentry_t *le;
585 int status;
587 /* Init the value cache */
588 uc_init ();
590 if ((list_init == NULL) && (list_read == NULL))
591 return;
593 /* Calling all init callbacks before checking if read callbacks
594 * are available allows the init callbacks to register the read
595 * callback. */
596 le = llist_head (list_init);
597 while (le != NULL)
598 {
599 callback = (int (*) (void)) le->value;
600 status = (*callback) ();
602 if (status != 0)
603 {
604 ERROR ("Initialization of plugin `%s' "
605 "failed with status %i. "
606 "Plugin will be unloaded.",
607 le->key, status);
608 /* Plugins that register read callbacks from the init
609 * callback should take care of appropriate error
610 * handling themselves. */
611 /* FIXME: Unload _all_ functions */
612 plugin_unregister_read (le->key);
613 }
615 le = le->next;
616 }
618 /* Start read-threads */
619 if (list_read != NULL)
620 {
621 const char *rt;
622 int num;
623 rt = global_option_get ("ReadThreads");
624 num = atoi (rt);
625 start_threads ((num > 0) ? num : 5);
626 }
627 } /* void plugin_init_all */
629 void plugin_read_all (void)
630 {
631 llentry_t *le;
632 read_func_t *rf;
634 uc_check_timeout ();
636 if (list_read == NULL)
637 return;
639 pthread_mutex_lock (&read_lock);
641 le = llist_head (list_read);
642 while (le != NULL)
643 {
644 rf = (read_func_t *) le->value;
646 if (rf->needs_read != DONE)
647 {
648 le = le->next;
649 continue;
650 }
652 if (rf->wait_left > 0)
653 rf->wait_left -= interval_g;
655 if (rf->wait_left <= 0)
656 {
657 rf->needs_read = TODO;
658 }
660 le = le->next;
661 }
663 DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
664 pthread_cond_broadcast (&read_cond);
665 pthread_mutex_unlock (&read_lock);
666 } /* void plugin_read_all */
668 int plugin_flush_one (int timeout, const char *name)
669 {
670 int (*callback) (int);
671 llentry_t *le;
672 int status;
674 if (list_flush == NULL)
675 return (-1);
677 le = llist_search (list_flush, name);
678 if (le == NULL)
679 return (-1);
680 callback = (int (*) (int)) le->value;
682 status = (*callback) (timeout);
684 return (status);
685 } /* int plugin_flush_ont */
687 void plugin_flush_all (int timeout)
688 {
689 int (*callback) (int);
690 llentry_t *le;
692 if (list_flush == NULL)
693 return;
695 le = llist_head (list_flush);
696 while (le != NULL)
697 {
698 callback = (int (*) (int)) le->value;
699 le = le->next;
701 (*callback) (timeout);
702 }
703 } /* void plugin_flush_all */
705 int plugin_flush (const char *plugin, int timeout, const char *identifier)
706 {
707 int (*callback) (int timeout, const char *identifier);
708 llentry_t *le;
710 if (list_flush == NULL)
711 return (0);
713 le = llist_head (list_flush);
714 while (le != NULL)
715 {
716 if ((plugin != NULL)
717 && (strcmp (plugin, le->key) != 0))
718 continue;
720 callback = (int (*) (int, const char *)) le->value;
721 le = le->next;
723 (*callback) (timeout, identifier);
724 }
725 return (0);
726 } /* int plugin_flush */
728 void plugin_shutdown_all (void)
729 {
730 int (*callback) (void);
731 llentry_t *le;
733 stop_threads ();
735 if (list_shutdown == NULL)
736 return;
738 le = llist_head (list_shutdown);
739 while (le != NULL)
740 {
741 callback = (int (*) (void)) le->value;
743 /* Advance the pointer before calling the callback allows
744 * shutdown functions to unregister themselves. If done the
745 * other way around the memory `le' points to will be freed
746 * after callback returns. */
747 le = le->next;
749 (*callback) ();
750 }
751 } /* void plugin_shutdown_all */
753 int plugin_dispatch_values (value_list_t *vl)
754 {
755 static c_complain_t no_write_complaint = C_COMPLAIN_INIT;
757 int (*callback) (const data_set_t *, const value_list_t *);
758 data_set_t *ds;
759 llentry_t *le;
761 if ((vl == NULL) || (*vl->type == '\0')) {
762 ERROR ("plugin_dispatch_values: Invalid value list.");
763 return (-1);
764 }
766 if (list_write == NULL)
767 c_complain_once (LOG_WARNING, &no_write_complaint,
768 "plugin_dispatch_values: No write callback has been "
769 "registered. Please load at least one output plugin, "
770 "if you want the collected data to be stored.");
772 if (data_sets == NULL)
773 {
774 ERROR ("plugin_dispatch_values: No data sets registered. "
775 "Could the types database be read? Check "
776 "your `TypesDB' setting!");
777 return (-1);
778 }
780 if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
781 {
782 INFO ("plugin_dispatch_values: Dataset not found: %s", vl->type);
783 return (-1);
784 }
786 DEBUG ("plugin_dispatch_values: time = %u; interval = %i; "
787 "host = %s; "
788 "plugin = %s; plugin_instance = %s; "
789 "type = %s; type_instance = %s;",
790 (unsigned int) vl->time, vl->interval,
791 vl->host,
792 vl->plugin, vl->plugin_instance,
793 vl->type, vl->type_instance);
795 #if COLLECT_DEBUG
796 assert (0 == strcmp (ds->type, vl->type));
797 #else
798 if (0 != strcmp (ds->type, vl->type))
799 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
800 ds->type, vl->type);
801 #endif
803 #if COLLECT_DEBUG
804 assert (ds->ds_num == vl->values_len);
805 #else
806 if (ds->ds_num != vl->values_len)
807 {
808 ERROR ("plugin_dispatch_values: ds->type = %s: "
809 "(ds->ds_num = %i) != "
810 "(vl->values_len = %i)",
811 ds->type, ds->ds_num, vl->values_len);
812 return (-1);
813 }
814 #endif
816 escape_slashes (vl->host, sizeof (vl->host));
817 escape_slashes (vl->plugin, sizeof (vl->plugin));
818 escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
819 escape_slashes (vl->type, sizeof (vl->type));
820 escape_slashes (vl->type_instance, sizeof (vl->type_instance));
822 /* Update the value cache */
823 uc_update (ds, vl);
824 ut_check_threshold (ds, vl);
826 le = llist_head (list_write);
827 while (le != NULL)
828 {
829 callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
830 (*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[512];
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, 512, format, ap);
883 msg[511] = '\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 */