Code

src/libcollectdclient/network_buffer.c: Fix gcrypt build on FreeBSD.
[collectd.git] / src / plugin.c
1 /**
2  * collectd - src/plugin.c
3  * Copyright (C) 2005-2011  Florian octo Forster
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License as published by the
7  * Free Software Foundation; only version 2 of the License is applicable.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
17  *
18  * Authors:
19  *   Florian octo Forster <octo at collectd.org>
20  *   Sebastian Harl <sh at tokkee.org>
21  **/
23 #include "collectd.h"
24 #include "utils_complain.h"
26 #include <ltdl.h>
28 #if HAVE_PTHREAD_H
29 # include <pthread.h>
30 #endif
32 #include "common.h"
33 #include "plugin.h"
34 #include "configfile.h"
35 #include "utils_avltree.h"
36 #include "utils_llist.h"
37 #include "utils_heap.h"
38 #include "utils_cache.h"
39 #include "filter_chain.h"
41 /*
42  * Private structures
43  */
44 struct callback_func_s
45 {
46         void *cf_callback;
47         user_data_t cf_udata;
48         plugin_ctx_t cf_ctx;
49 };
50 typedef struct callback_func_s callback_func_t;
52 #define RF_SIMPLE  0
53 #define RF_COMPLEX 1
54 #define RF_REMOVE  65535
55 struct read_func_s
56 {
57         /* `read_func_t' "inherits" from `callback_func_t'.
58          * The `rf_super' member MUST be the first one in this structure! */
59 #define rf_callback rf_super.cf_callback
60 #define rf_udata rf_super.cf_udata
61 #define rf_ctx rf_super.cf_ctx
62         callback_func_t rf_super;
63         char rf_group[DATA_MAX_NAME_LEN];
64         char rf_name[DATA_MAX_NAME_LEN];
65         int rf_type;
66         struct timespec rf_interval;
67         struct timespec rf_effective_interval;
68         struct timespec rf_next_read;
69 };
70 typedef struct read_func_s read_func_t;
72 /*
73  * Private variables
74  */
75 static llist_t *list_init;
76 static llist_t *list_write;
77 static llist_t *list_flush;
78 static llist_t *list_missing;
79 static llist_t *list_shutdown;
80 static llist_t *list_log;
81 static llist_t *list_notification;
83 static fc_chain_t *pre_cache_chain = NULL;
84 static fc_chain_t *post_cache_chain = NULL;
86 static c_avl_tree_t *data_sets;
88 static char *plugindir = NULL;
90 static c_heap_t       *read_heap = NULL;
91 static llist_t        *read_list;
92 static int             read_loop = 1;
93 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
94 static pthread_cond_t  read_cond = PTHREAD_COND_INITIALIZER;
95 static pthread_t      *read_threads = NULL;
96 static int             read_threads_num = 0;
98 static pthread_key_t   plugin_ctx_key;
99 static _Bool           plugin_ctx_key_initialized = 0;
101 /*
102  * Static functions
103  */
104 static const char *plugin_get_dir (void)
106         if (plugindir == NULL)
107                 return (PLUGINDIR);
108         else
109                 return (plugindir);
112 static void destroy_callback (callback_func_t *cf) /* {{{ */
114         if (cf == NULL)
115                 return;
117         if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
118         {
119                 cf->cf_udata.free_func (cf->cf_udata.data);
120                 cf->cf_udata.data = NULL;
121                 cf->cf_udata.free_func = NULL;
122         }
123         sfree (cf);
124 } /* }}} void destroy_callback */
126 static void destroy_all_callbacks (llist_t **list) /* {{{ */
128         llentry_t *le;
130         if (*list == NULL)
131                 return;
133         le = llist_head (*list);
134         while (le != NULL)
135         {
136                 llentry_t *le_next;
138                 le_next = le->next;
140                 sfree (le->key);
141                 destroy_callback (le->value);
142                 le->value = NULL;
144                 le = le_next;
145         }
147         llist_destroy (*list);
148         *list = NULL;
149 } /* }}} void destroy_all_callbacks */
151 static void destroy_read_heap (void) /* {{{ */
153         if (read_heap == NULL)
154                 return;
156         while (42)
157         {
158                 callback_func_t *cf;
160                 cf = c_heap_get_root (read_heap);
161                 if (cf == NULL)
162                         break;
164                 destroy_callback (cf);
165         }
167         c_heap_destroy (read_heap);
168         read_heap = NULL;
169 } /* }}} void destroy_read_heap */
171 static int register_callback (llist_t **list, /* {{{ */
172                 const char *name, callback_func_t *cf)
174         llentry_t *le;
175         char *key;
177         if (*list == NULL)
178         {
179                 *list = llist_create ();
180                 if (*list == NULL)
181                 {
182                         ERROR ("plugin: register_callback: "
183                                         "llist_create failed.");
184                         destroy_callback (cf);
185                         return (-1);
186                 }
187         }
189         key = strdup (name);
190         if (key == NULL)
191         {
192                 ERROR ("plugin: register_callback: strdup failed.");
193                 destroy_callback (cf);
194                 return (-1);
195         }
197         le = llist_search (*list, name);
198         if (le == NULL)
199         {
200                 le = llentry_create (key, cf);
201                 if (le == NULL)
202                 {
203                         ERROR ("plugin: register_callback: "
204                                         "llentry_create failed.");
205                         free (key);
206                         destroy_callback (cf);
207                         return (-1);
208                 }
210                 llist_append (*list, le);
211         }
212         else
213         {
214                 callback_func_t *old_cf;
216                 old_cf = le->value;
217                 le->value = cf;
219                 WARNING ("plugin: register_callback: "
220                                 "a callback named `%s' already exists - "
221                                 "overwriting the old entry!", name);
223                 destroy_callback (old_cf);
224                 sfree (key);
225         }
227         return (0);
228 } /* }}} int register_callback */
230 static int create_register_callback (llist_t **list, /* {{{ */
231                 const char *name, void *callback, user_data_t *ud)
233         callback_func_t *cf;
235         cf = (callback_func_t *) malloc (sizeof (*cf));
236         if (cf == NULL)
237         {
238                 ERROR ("plugin: create_register_callback: malloc failed.");
239                 return (-1);
240         }
241         memset (cf, 0, sizeof (*cf));
243         cf->cf_callback = callback;
244         if (ud == NULL)
245         {
246                 cf->cf_udata.data = NULL;
247                 cf->cf_udata.free_func = NULL;
248         }
249         else
250         {
251                 cf->cf_udata = *ud;
252         }
254         cf->cf_ctx = plugin_get_ctx ();
256         return (register_callback (list, name, cf));
257 } /* }}} int create_register_callback */
259 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
261         llentry_t *e;
263         if (list == NULL)
264                 return (-1);
266         e = llist_search (list, name);
267         if (e == NULL)
268                 return (-1);
270         llist_remove (list, e);
272         sfree (e->key);
273         destroy_callback (e->value);
275         llentry_destroy (e);
277         return (0);
278 } /* }}} int plugin_unregister */
280 /*
281  * (Try to) load the shared object `file'. Won't complain if it isn't a shared
282  * object, but it will bitch about a shared object not having a
283  * ``module_register'' symbol..
284  */
285 static int plugin_load_file (char *file, uint32_t flags)
287         lt_dlhandle dlh;
288         void (*reg_handle) (void);
290         lt_dlinit ();
291         lt_dlerror (); /* clear errors */
293 #if LIBTOOL_VERSION == 2
294         if (flags & PLUGIN_FLAGS_GLOBAL) {
295                 lt_dladvise advise;
296                 lt_dladvise_init(&advise);
297                 lt_dladvise_global(&advise);
298                 dlh = lt_dlopenadvise(file, advise);
299                 lt_dladvise_destroy(&advise);
300         } else {
301                 dlh = lt_dlopen (file);
302         }
303 #else /* if LIBTOOL_VERSION == 1 */
304         if (flags & PLUGIN_FLAGS_GLOBAL)
305                 WARNING ("plugin_load_file: The global flag is not supported, "
306                                 "libtool 2 is required for this.");
307         dlh = lt_dlopen (file);
308 #endif
310         if (dlh == NULL)
311         {
312                 char errbuf[1024] = "";
314                 ssnprintf (errbuf, sizeof (errbuf),
315                                 "lt_dlopen (\"%s\") failed: %s. "
316                                 "The most common cause for this problem are "
317                                 "missing dependencies. Use ldd(1) to check "
318                                 "the dependencies of the plugin "
319                                 "/ shared object.",
320                                 file, lt_dlerror ());
322                 ERROR ("%s", errbuf);
323                 /* Make sure this is printed to STDERR in any case, but also
324                  * make sure it's printed only once. */
325                 if (list_log != NULL)
326                         fprintf (stderr, "ERROR: %s\n", errbuf);
328                 return (1);
329         }
331         if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
332         {
333                 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
334                                 file, lt_dlerror ());
335                 lt_dlclose (dlh);
336                 return (-1);
337         }
339         (*reg_handle) ();
341         return (0);
344 static _Bool timeout_reached(struct timespec timeout)
346         struct timeval now;
347         gettimeofday(&now, NULL);
348         return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
351 static void *plugin_read_thread (void __attribute__((unused)) *args)
353         while (read_loop != 0)
354         {
355                 read_func_t *rf;
356                 plugin_ctx_t old_ctx;
357                 cdtime_t now;
358                 int status;
359                 int rf_type;
360                 int rc;
362                 /* Get the read function that needs to be read next.
363                  * We don't need to hold "read_lock" for the heap, but we need
364                  * to call c_heap_get_root() and pthread_cond_wait() in the
365                  * same protected block. */
366                 pthread_mutex_lock (&read_lock);
367                 rf = c_heap_get_root (read_heap);
368                 if (rf == NULL)
369                 {
370                         pthread_cond_wait (&read_cond, &read_lock);
371                         pthread_mutex_unlock (&read_lock);
372                         continue;
373                 }
374                 pthread_mutex_unlock (&read_lock);
376                 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
377                 {
378                         /* this should not happen, because the interval is set
379                          * for each plugin when loading it
380                          * XXX: issue a warning? */
381                         now = cdtime ();
383                         CDTIME_T_TO_TIMESPEC (plugin_get_interval (), &rf->rf_interval);
385                         rf->rf_effective_interval = rf->rf_interval;
387                         CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
388                 }
390                 /* sleep until this entry is due,
391                  * using pthread_cond_timedwait */
392                 pthread_mutex_lock (&read_lock);
393                 /* In pthread_cond_timedwait, spurious wakeups are possible
394                  * (and really happen, at least on NetBSD with > 1 CPU), thus
395                  * we need to re-evaluate the condition every time
396                  * pthread_cond_timedwait returns. */
397                 rc = 0;
398                 while ((read_loop != 0)
399                                 && !timeout_reached(rf->rf_next_read)
400                                 && rc == 0)
401                 {
402                         rc = pthread_cond_timedwait (&read_cond, &read_lock,
403                                 &rf->rf_next_read);
404                 }
406                 /* Must hold `read_lock' when accessing `rf->rf_type'. */
407                 rf_type = rf->rf_type;
408                 pthread_mutex_unlock (&read_lock);
410                 /* Check if we're supposed to stop.. This may have interrupted
411                  * the sleep, too. */
412                 if (read_loop == 0)
413                 {
414                         /* Insert `rf' again, so it can be free'd correctly */
415                         c_heap_insert (read_heap, rf);
416                         break;
417                 }
419                 /* The entry has been marked for deletion. The linked list
420                  * entry has already been removed by `plugin_unregister_read'.
421                  * All we have to do here is free the `read_func_t' and
422                  * continue. */
423                 if (rf_type == RF_REMOVE)
424                 {
425                         DEBUG ("plugin_read_thread: Destroying the `%s' "
426                                         "callback.", rf->rf_name);
427                         destroy_callback ((callback_func_t *) rf);
428                         rf = NULL;
429                         continue;
430                 }
432                 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
434                 old_ctx = plugin_set_ctx (rf->rf_ctx);
436                 if (rf_type == RF_SIMPLE)
437                 {
438                         int (*callback) (void);
440                         callback = rf->rf_callback;
441                         status = (*callback) ();
442                 }
443                 else
444                 {
445                         plugin_read_cb callback;
447                         assert (rf_type == RF_COMPLEX);
449                         callback = rf->rf_callback;
450                         status = (*callback) (&rf->rf_udata);
451                 }
453                 plugin_set_ctx (old_ctx);
455                 /* If the function signals failure, we will increase the
456                  * intervals in which it will be called. */
457                 if (status != 0)
458                 {
459                         rf->rf_effective_interval.tv_sec *= 2;
460                         rf->rf_effective_interval.tv_nsec *= 2;
461                         NORMALIZE_TIMESPEC (rf->rf_effective_interval);
463                         if (rf->rf_effective_interval.tv_sec >= 86400)
464                         {
465                                 rf->rf_effective_interval.tv_sec = 86400;
466                                 rf->rf_effective_interval.tv_nsec = 0;
467                         }
469                         NOTICE ("read-function of plugin `%s' failed. "
470                                         "Will suspend it for %i seconds.",
471                                         rf->rf_name,
472                                         (int) rf->rf_effective_interval.tv_sec);
473                 }
474                 else
475                 {
476                         /* Success: Restore the interval, if it was changed. */
477                         rf->rf_effective_interval = rf->rf_interval;
478                 }
480                 /* update the ``next read due'' field */
481                 now = cdtime ();
483                 DEBUG ("plugin_read_thread: Effective interval of the "
484                                 "%s plugin is %i.%09i.",
485                                 rf->rf_name,
486                                 (int) rf->rf_effective_interval.tv_sec,
487                                 (int) rf->rf_effective_interval.tv_nsec);
489                 /* Calculate the next (absolute) time at which this function
490                  * should be called. */
491                 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
492                         + rf->rf_effective_interval.tv_sec;
493                 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
494                         + rf->rf_effective_interval.tv_nsec;
495                 NORMALIZE_TIMESPEC (rf->rf_next_read);
497                 /* Check, if `rf_next_read' is in the past. */
498                 if (TIMESPEC_TO_CDTIME_T (&rf->rf_next_read) < now)
499                 {
500                         /* `rf_next_read' is in the past. Insert `now'
501                          * so this value doesn't trail off into the
502                          * past too much. */
503                         CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
504                 }
506                 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
507                                 rf->rf_name,
508                                 (int) rf->rf_next_read.tv_sec,
509                                 (int) rf->rf_next_read.tv_nsec);
511                 /* Re-insert this read function into the heap again. */
512                 c_heap_insert (read_heap, rf);
513         } /* while (read_loop) */
515         pthread_exit (NULL);
516         return ((void *) 0);
517 } /* void *plugin_read_thread */
519 static void start_read_threads (int num)
521         int i;
523         if (read_threads != NULL)
524                 return;
526         read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
527         if (read_threads == NULL)
528         {
529                 ERROR ("plugin: start_read_threads: calloc failed.");
530                 return;
531         }
533         read_threads_num = 0;
534         for (i = 0; i < num; i++)
535         {
536                 if (pthread_create (read_threads + read_threads_num, NULL,
537                                         plugin_read_thread, NULL) == 0)
538                 {
539                         read_threads_num++;
540                 }
541                 else
542                 {
543                         ERROR ("plugin: start_read_threads: pthread_create failed.");
544                         return;
545                 }
546         } /* for (i) */
547 } /* void start_read_threads */
549 static void stop_read_threads (void)
551         int i;
553         if (read_threads == NULL)
554                 return;
556         INFO ("collectd: Stopping %i read threads.", read_threads_num);
558         pthread_mutex_lock (&read_lock);
559         read_loop = 0;
560         DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
561         pthread_cond_broadcast (&read_cond);
562         pthread_mutex_unlock (&read_lock);
564         for (i = 0; i < read_threads_num; i++)
565         {
566                 if (pthread_join (read_threads[i], NULL) != 0)
567                 {
568                         ERROR ("plugin: stop_read_threads: pthread_join failed.");
569                 }
570                 read_threads[i] = (pthread_t) 0;
571         }
572         sfree (read_threads);
573         read_threads_num = 0;
574 } /* void stop_read_threads */
576 /*
577  * Public functions
578  */
579 void plugin_set_dir (const char *dir)
581         if (plugindir != NULL)
582                 free (plugindir);
584         if (dir == NULL)
585                 plugindir = NULL;
586         else if ((plugindir = strdup (dir)) == NULL)
587         {
588                 char errbuf[1024];
589                 ERROR ("strdup failed: %s",
590                                 sstrerror (errno, errbuf, sizeof (errbuf)));
591         }
594 #define BUFSIZE 512
595 int plugin_load (const char *type, uint32_t flags)
597         DIR  *dh;
598         const char *dir;
599         char  filename[BUFSIZE] = "";
600         char  typename[BUFSIZE];
601         int   typename_len;
602         int   ret;
603         struct stat    statbuf;
604         struct dirent *de;
605         int status;
607         DEBUG ("type = %s", type);
609         dir = plugin_get_dir ();
610         ret = 1;
612         /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
613          * type when matching the filename */
614         status = ssnprintf (typename, sizeof (typename), "%s.so", type);
615         if ((status < 0) || ((size_t) status >= sizeof (typename)))
616         {
617                 WARNING ("snprintf: truncated: `%s.so'", type);
618                 return (-1);
619         }
620         typename_len = strlen (typename);
622         if ((dh = opendir (dir)) == NULL)
623         {
624                 char errbuf[1024];
625                 ERROR ("opendir (%s): %s", dir,
626                                 sstrerror (errno, errbuf, sizeof (errbuf)));
627                 return (-1);
628         }
630         while ((de = readdir (dh)) != NULL)
631         {
632                 if (strncasecmp (de->d_name, typename, typename_len))
633                         continue;
635                 status = ssnprintf (filename, sizeof (filename),
636                                 "%s/%s", dir, de->d_name);
637                 if ((status < 0) || ((size_t) status >= sizeof (filename)))
638                 {
639                         WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
640                         continue;
641                 }
643                 if (lstat (filename, &statbuf) == -1)
644                 {
645                         char errbuf[1024];
646                         WARNING ("stat %s: %s", filename,
647                                         sstrerror (errno, errbuf, sizeof (errbuf)));
648                         continue;
649                 }
650                 else if (!S_ISREG (statbuf.st_mode))
651                 {
652                         /* don't follow symlinks */
653                         WARNING ("stat %s: not a regular file", filename);
654                         continue;
655                 }
657                 if (plugin_load_file (filename, flags) == 0)
658                 {
659                         /* success */
660                         ret = 0;
661                         break;
662                 }
663                 else
664                 {
665                         fprintf (stderr, "Unable to load plugin %s.\n", type);
666                 }
667         }
669         closedir (dh);
671         if (filename[0] == '\0')
672                 fprintf (stderr, "Could not find plugin %s.\n", type);
674         return (ret);
677 /*
678  * The `register_*' functions follow
679  */
680 int plugin_register_config (const char *name,
681                 int (*callback) (const char *key, const char *val),
682                 const char **keys, int keys_num)
684         cf_register (name, callback, keys, keys_num);
685         return (0);
686 } /* int plugin_register_config */
688 int plugin_register_complex_config (const char *type,
689                 int (*callback) (oconfig_item_t *))
691         return (cf_register_complex (type, callback));
692 } /* int plugin_register_complex_config */
694 int plugin_register_init (const char *name,
695                 int (*callback) (void))
697         return (create_register_callback (&list_init, name, (void *) callback,
698                                 /* user_data = */ NULL));
699 } /* plugin_register_init */
701 static int plugin_compare_read_func (const void *arg0, const void *arg1)
703         const read_func_t *rf0;
704         const read_func_t *rf1;
706         rf0 = arg0;
707         rf1 = arg1;
709         if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
710                 return (-1);
711         else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
712                 return (1);
713         else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
714                 return (-1);
715         else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
716                 return (1);
717         else
718                 return (0);
719 } /* int plugin_compare_read_func */
721 /* Add a read function to both, the heap and a linked list. The linked list if
722  * used to look-up read functions, especially for the remove function. The heap
723  * is used to determine which plugin to read next. */
724 static int plugin_insert_read (read_func_t *rf)
726         int status;
727         llentry_t *le;
729         pthread_mutex_lock (&read_lock);
731         if (read_list == NULL)
732         {
733                 read_list = llist_create ();
734                 if (read_list == NULL)
735                 {
736                         pthread_mutex_unlock (&read_lock);
737                         ERROR ("plugin_insert_read: read_list failed.");
738                         return (-1);
739                 }
740         }
742         if (read_heap == NULL)
743         {
744                 read_heap = c_heap_create (plugin_compare_read_func);
745                 if (read_heap == NULL)
746                 {
747                         pthread_mutex_unlock (&read_lock);
748                         ERROR ("plugin_insert_read: c_heap_create failed.");
749                         return (-1);
750                 }
751         }
753         le = llist_search (read_list, rf->rf_name);
754         if (le != NULL)
755         {
756                 pthread_mutex_unlock (&read_lock);
757                 WARNING ("The read function \"%s\" is already registered. "
758                                 "Check for duplicate \"LoadPlugin\" lines "
759                                 "in your configuration!",
760                                 rf->rf_name);
761                 return (EINVAL);
762         }
764         le = llentry_create (rf->rf_name, rf);
765         if (le == NULL)
766         {
767                 pthread_mutex_unlock (&read_lock);
768                 ERROR ("plugin_insert_read: llentry_create failed.");
769                 return (-1);
770         }
772         status = c_heap_insert (read_heap, rf);
773         if (status != 0)
774         {
775                 pthread_mutex_unlock (&read_lock);
776                 ERROR ("plugin_insert_read: c_heap_insert failed.");
777                 llentry_destroy (le);
778                 return (-1);
779         }
781         /* This does not fail. */
782         llist_append (read_list, le);
784         /* Wake up all the read threads. */
785         pthread_cond_broadcast (&read_cond);
786         pthread_mutex_unlock (&read_lock);
787         return (0);
788 } /* int plugin_insert_read */
790 static int read_cb_wrapper (user_data_t *ud)
792         int (*callback) (void);
794         if (ud == NULL)
795                 return -1;
797         callback = ud->data;
798         return callback();
799 } /* int read_cb_wrapper */
801 int plugin_register_read (const char *name,
802                 int (*callback) (void))
804         read_func_t *rf;
805         plugin_ctx_t ctx = plugin_get_ctx ();
806         int status;
808         if (ctx.interval != 0) {
809                 /* If ctx.interval is not zero (== use the plugin or global
810                  * interval), we need to use the "complex" read callback,
811                  * because only that allows to specify a different interval.
812                  * Wrap the callback using read_cb_wrapper(). */
813                 struct timespec interval;
814                 user_data_t user_data;
816                 user_data.data = callback;
817                 user_data.free_func = NULL;
819                 CDTIME_T_TO_TIMESPEC (ctx.interval, &interval);
820                 return plugin_register_complex_read (/* group = */ NULL,
821                                 name, read_cb_wrapper, &interval, &user_data);
822         }
824         DEBUG ("plugin_register_read: default_interval = %.3f",
825                         CDTIME_T_TO_DOUBLE(plugin_get_interval ()));
827         rf = malloc (sizeof (*rf));
828         if (rf == NULL)
829         {
830                 ERROR ("plugin_register_read: malloc failed.");
831                 return (ENOMEM);
832         }
834         memset (rf, 0, sizeof (read_func_t));
835         rf->rf_callback = (void *) callback;
836         rf->rf_udata.data = NULL;
837         rf->rf_udata.free_func = NULL;
838         rf->rf_ctx = ctx;
839         rf->rf_group[0] = '\0';
840         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
841         rf->rf_type = RF_SIMPLE;
842         rf->rf_interval.tv_sec = 0;
843         rf->rf_interval.tv_nsec = 0;
844         rf->rf_effective_interval = rf->rf_interval;
846         status = plugin_insert_read (rf);
847         if (status != 0)
848                 sfree (rf);
850         return (status);
851 } /* int plugin_register_read */
853 int plugin_register_complex_read (const char *group, const char *name,
854                 plugin_read_cb callback,
855                 const struct timespec *interval,
856                 user_data_t *user_data)
858         read_func_t *rf;
859         plugin_ctx_t ctx = plugin_get_ctx ();
860         int status;
862         rf = malloc (sizeof (*rf));
863         if (rf == NULL)
864         {
865                 ERROR ("plugin_register_complex_read: malloc failed.");
866                 return (ENOMEM);
867         }
869         memset (rf, 0, sizeof (read_func_t));
870         rf->rf_callback = (void *) callback;
871         if (group != NULL)
872                 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
873         else
874                 rf->rf_group[0] = '\0';
875         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
876         rf->rf_type = RF_COMPLEX;
877         if (interval != NULL)
878         {
879                 rf->rf_interval = *interval;
880         }
881         else if (ctx.interval != 0)
882         {
883                 CDTIME_T_TO_TIMESPEC (ctx.interval, &rf->rf_interval);
884         }
885         rf->rf_effective_interval = rf->rf_interval;
887         DEBUG ("plugin_register_read: interval = %i.%09i",
888                         (int) rf->rf_interval.tv_sec,
889                         (int) rf->rf_interval.tv_nsec);
891         /* Set user data */
892         if (user_data == NULL)
893         {
894                 rf->rf_udata.data = NULL;
895                 rf->rf_udata.free_func = NULL;
896         }
897         else
898         {
899                 rf->rf_udata = *user_data;
900         }
902         rf->rf_ctx = ctx;
904         status = plugin_insert_read (rf);
905         if (status != 0)
906                 sfree (rf);
908         return (status);
909 } /* int plugin_register_complex_read */
911 int plugin_register_write (const char *name,
912                 plugin_write_cb callback, user_data_t *ud)
914         return (create_register_callback (&list_write, name,
915                                 (void *) callback, ud));
916 } /* int plugin_register_write */
918 int plugin_register_flush (const char *name,
919                 plugin_flush_cb callback, user_data_t *ud)
921         return (create_register_callback (&list_flush, name,
922                                 (void *) callback, ud));
923 } /* int plugin_register_flush */
925 int plugin_register_missing (const char *name,
926                 plugin_missing_cb callback, user_data_t *ud)
928         return (create_register_callback (&list_missing, name,
929                                 (void *) callback, ud));
930 } /* int plugin_register_missing */
932 int plugin_register_shutdown (const char *name,
933                 int (*callback) (void))
935         return (create_register_callback (&list_shutdown, name,
936                                 (void *) callback, /* user_data = */ NULL));
937 } /* int plugin_register_shutdown */
939 int plugin_register_data_set (const data_set_t *ds)
941         data_set_t *ds_copy;
942         int i;
944         if ((data_sets != NULL)
945                         && (c_avl_get (data_sets, ds->type, NULL) == 0))
946         {
947                 NOTICE ("Replacing DS `%s' with another version.", ds->type);
948                 plugin_unregister_data_set (ds->type);
949         }
950         else if (data_sets == NULL)
951         {
952                 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
953                 if (data_sets == NULL)
954                         return (-1);
955         }
957         ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
958         if (ds_copy == NULL)
959                 return (-1);
960         memcpy(ds_copy, ds, sizeof (data_set_t));
962         ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
963                         * ds->ds_num);
964         if (ds_copy->ds == NULL)
965         {
966                 free (ds_copy);
967                 return (-1);
968         }
970         for (i = 0; i < ds->ds_num; i++)
971                 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
973         return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
974 } /* int plugin_register_data_set */
976 int plugin_register_log (const char *name,
977                 plugin_log_cb callback, user_data_t *ud)
979         return (create_register_callback (&list_log, name,
980                                 (void *) callback, ud));
981 } /* int plugin_register_log */
983 int plugin_register_notification (const char *name,
984                 plugin_notification_cb callback, user_data_t *ud)
986         return (create_register_callback (&list_notification, name,
987                                 (void *) callback, ud));
988 } /* int plugin_register_log */
990 int plugin_unregister_config (const char *name)
992         cf_unregister (name);
993         return (0);
994 } /* int plugin_unregister_config */
996 int plugin_unregister_complex_config (const char *name)
998         cf_unregister_complex (name);
999         return (0);
1000 } /* int plugin_unregister_complex_config */
1002 int plugin_unregister_init (const char *name)
1004         return (plugin_unregister (list_init, name));
1007 int plugin_unregister_read (const char *name) /* {{{ */
1009         llentry_t *le;
1010         read_func_t *rf;
1012         if (name == NULL)
1013                 return (-ENOENT);
1015         pthread_mutex_lock (&read_lock);
1017         if (read_list == NULL)
1018         {
1019                 pthread_mutex_unlock (&read_lock);
1020                 return (-ENOENT);
1021         }
1023         le = llist_search (read_list, name);
1024         if (le == NULL)
1025         {
1026                 pthread_mutex_unlock (&read_lock);
1027                 WARNING ("plugin_unregister_read: No such read function: %s",
1028                                 name);
1029                 return (-ENOENT);
1030         }
1032         llist_remove (read_list, le);
1034         rf = le->value;
1035         assert (rf != NULL);
1036         rf->rf_type = RF_REMOVE;
1038         pthread_mutex_unlock (&read_lock);
1040         llentry_destroy (le);
1042         DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1044         return (0);
1045 } /* }}} int plugin_unregister_read */
1047 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1049         read_func_t *rf    = e->value;
1050         char        *group = ud;
1052         return strcmp (rf->rf_group, (const char *)group);
1053 } /* }}} int compare_read_func_group */
1055 int plugin_unregister_read_group (const char *group) /* {{{ */
1057         llentry_t *le;
1058         read_func_t *rf;
1060         int found = 0;
1062         if (group == NULL)
1063                 return (-ENOENT);
1065         pthread_mutex_lock (&read_lock);
1067         if (read_list == NULL)
1068         {
1069                 pthread_mutex_unlock (&read_lock);
1070                 return (-ENOENT);
1071         }
1073         while (42)
1074         {
1075                 le = llist_search_custom (read_list,
1076                                 compare_read_func_group, (void *)group);
1078                 if (le == NULL)
1079                         break;
1081                 ++found;
1083                 llist_remove (read_list, le);
1085                 rf = le->value;
1086                 assert (rf != NULL);
1087                 rf->rf_type = RF_REMOVE;
1089                 llentry_destroy (le);
1091                 DEBUG ("plugin_unregister_read_group: "
1092                                 "Marked `%s' (group `%s') for removal.",
1093                                 rf->rf_name, group);
1094         }
1096         pthread_mutex_unlock (&read_lock);
1098         if (found == 0)
1099         {
1100                 WARNING ("plugin_unregister_read_group: No such "
1101                                 "group of read function: %s", group);
1102                 return (-ENOENT);
1103         }
1105         return (0);
1106 } /* }}} int plugin_unregister_read_group */
1108 int plugin_unregister_write (const char *name)
1110         return (plugin_unregister (list_write, name));
1113 int plugin_unregister_flush (const char *name)
1115         return (plugin_unregister (list_flush, name));
1118 int plugin_unregister_missing (const char *name)
1120         return (plugin_unregister (list_missing, name));
1123 int plugin_unregister_shutdown (const char *name)
1125         return (plugin_unregister (list_shutdown, name));
1128 int plugin_unregister_data_set (const char *name)
1130         data_set_t *ds;
1132         if (data_sets == NULL)
1133                 return (-1);
1135         if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1136                 return (-1);
1138         sfree (ds->ds);
1139         sfree (ds);
1141         return (0);
1142 } /* int plugin_unregister_data_set */
1144 int plugin_unregister_log (const char *name)
1146         return (plugin_unregister (list_log, name));
1149 int plugin_unregister_notification (const char *name)
1151         return (plugin_unregister (list_notification, name));
1154 void plugin_init_all (void)
1156         const char *chain_name;
1157         llentry_t *le;
1158         int status;
1160         /* Init the value cache */
1161         uc_init ();
1163         chain_name = global_option_get ("PreCacheChain");
1164         pre_cache_chain = fc_chain_get_by_name (chain_name);
1166         chain_name = global_option_get ("PostCacheChain");
1167         post_cache_chain = fc_chain_get_by_name (chain_name);
1170         if ((list_init == NULL) && (read_heap == NULL))
1171                 return;
1173         /* Calling all init callbacks before checking if read callbacks
1174          * are available allows the init callbacks to register the read
1175          * callback. */
1176         le = llist_head (list_init);
1177         while (le != NULL)
1178         {
1179                 callback_func_t *cf;
1180                 plugin_init_cb callback;
1181                 plugin_ctx_t old_ctx;
1183                 cf = le->value;
1184                 old_ctx = plugin_set_ctx (cf->cf_ctx);
1185                 callback = cf->cf_callback;
1186                 status = (*callback) ();
1187                 plugin_set_ctx (old_ctx);
1189                 if (status != 0)
1190                 {
1191                         ERROR ("Initialization of plugin `%s' "
1192                                         "failed with status %i. "
1193                                         "Plugin will be unloaded.",
1194                                         le->key, status);
1195                         /* Plugins that register read callbacks from the init
1196                          * callback should take care of appropriate error
1197                          * handling themselves. */
1198                         /* FIXME: Unload _all_ functions */
1199                         plugin_unregister_read (le->key);
1200                 }
1202                 le = le->next;
1203         }
1205         /* Start read-threads */
1206         if (read_heap != NULL)
1207         {
1208                 const char *rt;
1209                 int num;
1210                 rt = global_option_get ("ReadThreads");
1211                 num = atoi (rt);
1212                 if (num != -1)
1213                         start_read_threads ((num > 0) ? num : 5);
1214         }
1215 } /* void plugin_init_all */
1217 /* TODO: Rename this function. */
1218 void plugin_read_all (void)
1220         uc_check_timeout ();
1222         return;
1223 } /* void plugin_read_all */
1225 /* Read function called when the `-T' command line argument is given. */
1226 int plugin_read_all_once (void)
1228         int status;
1229         int return_status = 0;
1231         if (read_heap == NULL)
1232         {
1233                 NOTICE ("No read-functions are registered.");
1234                 return (0);
1235         }
1237         while (42)
1238         {
1239                 read_func_t *rf;
1240                 plugin_ctx_t old_ctx;
1242                 rf = c_heap_get_root (read_heap);
1243                 if (rf == NULL)
1244                         break;
1246                 old_ctx = plugin_set_ctx (rf->rf_ctx);
1248                 if (rf->rf_type == RF_SIMPLE)
1249                 {
1250                         int (*callback) (void);
1252                         callback = rf->rf_callback;
1253                         status = (*callback) ();
1254                 }
1255                 else
1256                 {
1257                         plugin_read_cb callback;
1259                         callback = rf->rf_callback;
1260                         status = (*callback) (&rf->rf_udata);
1261                 }
1263                 plugin_set_ctx (old_ctx);
1265                 if (status != 0)
1266                 {
1267                         NOTICE ("read-function of plugin `%s' failed.",
1268                                         rf->rf_name);
1269                         return_status = -1;
1270                 }
1272                 destroy_callback ((void *) rf);
1273         }
1275         return (return_status);
1276 } /* int plugin_read_all_once */
1278 int plugin_write (const char *plugin, /* {{{ */
1279                 const data_set_t *ds, const value_list_t *vl)
1281   llentry_t *le;
1282   int status;
1284   if (vl == NULL)
1285     return (EINVAL);
1287   if (list_write == NULL)
1288     return (ENOENT);
1290   if (ds == NULL)
1291   {
1292     ds = plugin_get_ds (vl->type);
1293     if (ds == NULL)
1294     {
1295       ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1296       return (ENOENT);
1297     }
1298   }
1300   if (plugin == NULL)
1301   {
1302     int success = 0;
1303     int failure = 0;
1305     le = llist_head (list_write);
1306     while (le != NULL)
1307     {
1308       callback_func_t *cf = le->value;
1309       plugin_write_cb callback;
1311       /* do not switch plugin context; rather keep the context (interval)
1312        * information of the calling read plugin */
1314       DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1315       callback = cf->cf_callback;
1316       status = (*callback) (ds, vl, &cf->cf_udata);
1317       if (status != 0)
1318         failure++;
1319       else
1320         success++;
1322       le = le->next;
1323     }
1325     if ((success == 0) && (failure != 0))
1326       status = -1;
1327     else
1328       status = 0;
1329   }
1330   else /* plugin != NULL */
1331   {
1332     callback_func_t *cf;
1333     plugin_write_cb callback;
1335     le = llist_head (list_write);
1336     while (le != NULL)
1337     {
1338       if (strcasecmp (plugin, le->key) == 0)
1339         break;
1341       le = le->next;
1342     }
1344     if (le == NULL)
1345       return (ENOENT);
1347     cf = le->value;
1349     /* do not switch plugin context; rather keep the context (interval)
1350      * information of the calling read plugin */
1352     DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1353     callback = cf->cf_callback;
1354     status = (*callback) (ds, vl, &cf->cf_udata);
1355   }
1357   return (status);
1358 } /* }}} int plugin_write */
1360 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1362   llentry_t *le;
1364   if (list_flush == NULL)
1365     return (0);
1367   le = llist_head (list_flush);
1368   while (le != NULL)
1369   {
1370     callback_func_t *cf;
1371     plugin_flush_cb callback;
1372     plugin_ctx_t old_ctx;
1374     if ((plugin != NULL)
1375         && (strcmp (plugin, le->key) != 0))
1376     {
1377       le = le->next;
1378       continue;
1379     }
1381     cf = le->value;
1382     old_ctx = plugin_set_ctx (cf->cf_ctx);
1383     callback = cf->cf_callback;
1385     (*callback) (timeout, identifier, &cf->cf_udata);
1387     plugin_set_ctx (old_ctx);
1389     le = le->next;
1390   }
1391   return (0);
1392 } /* int plugin_flush */
1394 void plugin_shutdown_all (void)
1396         llentry_t *le;
1398         stop_read_threads ();
1400         destroy_all_callbacks (&list_init);
1402         pthread_mutex_lock (&read_lock);
1403         llist_destroy (read_list);
1404         read_list = NULL;
1405         pthread_mutex_unlock (&read_lock);
1407         destroy_read_heap ();
1409         plugin_flush (/* plugin = */ NULL,
1410                         /* timeout = */ 0,
1411                         /* identifier = */ NULL);
1413         le = NULL;
1414         if (list_shutdown != NULL)
1415                 le = llist_head (list_shutdown);
1417         while (le != NULL)
1418         {
1419                 callback_func_t *cf;
1420                 plugin_shutdown_cb callback;
1421                 plugin_ctx_t old_ctx;
1423                 cf = le->value;
1424                 old_ctx = plugin_set_ctx (cf->cf_ctx);
1425                 callback = cf->cf_callback;
1427                 /* Advance the pointer before calling the callback allows
1428                  * shutdown functions to unregister themselves. If done the
1429                  * other way around the memory `le' points to will be freed
1430                  * after callback returns. */
1431                 le = le->next;
1433                 (*callback) ();
1435                 plugin_set_ctx (old_ctx);
1436         }
1438         /* Write plugins which use the `user_data' pointer usually need the
1439          * same data available to the flush callback. If this is the case, set
1440          * the free_function to NULL when registering the flush callback and to
1441          * the real free function when registering the write callback. This way
1442          * the data isn't freed twice. */
1443         destroy_all_callbacks (&list_flush);
1444         destroy_all_callbacks (&list_missing);
1445         destroy_all_callbacks (&list_write);
1447         destroy_all_callbacks (&list_notification);
1448         destroy_all_callbacks (&list_shutdown);
1449         destroy_all_callbacks (&list_log);
1450 } /* void plugin_shutdown_all */
1452 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1454   llentry_t *le;
1456   if (list_missing == NULL)
1457     return (0);
1459   le = llist_head (list_missing);
1460   while (le != NULL)
1461   {
1462     callback_func_t *cf;
1463     plugin_missing_cb callback;
1464     plugin_ctx_t old_ctx;
1465     int status;
1467     cf = le->value;
1468     old_ctx = plugin_set_ctx (cf->cf_ctx);
1469     callback = cf->cf_callback;
1471     status = (*callback) (vl, &cf->cf_udata);
1472     plugin_set_ctx (old_ctx);
1473     if (status != 0)
1474     {
1475       if (status < 0)
1476       {
1477         ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1478             "failed with status %i.",
1479             le->key, status);
1480         return (status);
1481       }
1482       else
1483       {
1484         return (0);
1485       }
1486     }
1488     le = le->next;
1489   }
1490   return (0);
1491 } /* int }}} plugin_dispatch_missing */
1493 int plugin_dispatch_values (value_list_t *vl)
1495         int status;
1496         static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1498         value_t *saved_values;
1499         int      saved_values_len;
1501         data_set_t *ds;
1503         int free_meta_data = 0;
1505         if ((vl == NULL) || (vl->type[0] == 0)
1506                         || (vl->values == NULL) || (vl->values_len < 1))
1507         {
1508                 ERROR ("plugin_dispatch_values: Invalid value list "
1509                                 "from plugin %s.", vl->plugin);
1510                 return (-1);
1511         }
1513         /* Free meta data only if the calling function didn't specify any. In
1514          * this case matches and targets may add some and the calling function
1515          * may not expect (and therefore free) that data. */
1516         if (vl->meta == NULL)
1517                 free_meta_data = 1;
1519         if (list_write == NULL)
1520                 c_complain_once (LOG_WARNING, &no_write_complaint,
1521                                 "plugin_dispatch_values: No write callback has been "
1522                                 "registered. Please load at least one output plugin, "
1523                                 "if you want the collected data to be stored.");
1525         if (data_sets == NULL)
1526         {
1527                 ERROR ("plugin_dispatch_values: No data sets registered. "
1528                                 "Could the types database be read? Check "
1529                                 "your `TypesDB' setting!");
1530                 return (-1);
1531         }
1533         if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1534         {
1535                 char ident[6 * DATA_MAX_NAME_LEN];
1537                 FORMAT_VL (ident, sizeof (ident), vl);
1538                 INFO ("plugin_dispatch_values: Dataset not found: %s "
1539                                 "(from \"%s\"), check your types.db!",
1540                                 vl->type, ident);
1541                 return (-1);
1542         }
1544         if (vl->time == 0)
1545                 vl->time = cdtime ();
1547         if (vl->interval <= 0)
1548         {
1549                 plugin_ctx_t ctx = plugin_get_ctx ();
1551                 if (ctx.interval != 0)
1552                         vl->interval = ctx.interval;
1553                 else
1554                 {
1555                         char name[6 * DATA_MAX_NAME_LEN];
1556                         FORMAT_VL (name, sizeof (name), vl);
1557                         ERROR ("plugin_dispatch_values: Unable to determine "
1558                                         "interval from context for "
1559                                         "value list \"%s\". "
1560                                         "This indicates a broken plugin. "
1561                                         "Please report this problem to the "
1562                                         "collectd mailing list or at "
1563                                         "<http://collectd.org/bugs/>.", name);
1564                         vl->interval = cf_get_default_interval ();
1565                 }
1566         }
1568         DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1569                         "host = %s; "
1570                         "plugin = %s; plugin_instance = %s; "
1571                         "type = %s; type_instance = %s;",
1572                         CDTIME_T_TO_DOUBLE (vl->time),
1573                         CDTIME_T_TO_DOUBLE (vl->interval),
1574                         vl->host,
1575                         vl->plugin, vl->plugin_instance,
1576                         vl->type, vl->type_instance);
1578 #if COLLECT_DEBUG
1579         assert (0 == strcmp (ds->type, vl->type));
1580 #else
1581         if (0 != strcmp (ds->type, vl->type))
1582                 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1583                                 ds->type, vl->type);
1584 #endif
1586 #if COLLECT_DEBUG
1587         assert (ds->ds_num == vl->values_len);
1588 #else
1589         if (ds->ds_num != vl->values_len)
1590         {
1591                 ERROR ("plugin_dispatch_values: ds->type = %s: "
1592                                 "(ds->ds_num = %i) != "
1593                                 "(vl->values_len = %i)",
1594                                 ds->type, ds->ds_num, vl->values_len);
1595                 return (-1);
1596         }
1597 #endif
1599         escape_slashes (vl->host, sizeof (vl->host));
1600         escape_slashes (vl->plugin, sizeof (vl->plugin));
1601         escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1602         escape_slashes (vl->type, sizeof (vl->type));
1603         escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1605         /* Copy the values. This way, we can assure `targets' that they get
1606          * dynamically allocated values, which they can free and replace if
1607          * they like. */
1608         if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1609         {
1610                 saved_values     = vl->values;
1611                 saved_values_len = vl->values_len;
1613                 vl->values = (value_t *) calloc (vl->values_len,
1614                                 sizeof (*vl->values));
1615                 if (vl->values == NULL)
1616                 {
1617                         ERROR ("plugin_dispatch_values: calloc failed.");
1618                         vl->values = saved_values;
1619                         return (-1);
1620                 }
1621                 memcpy (vl->values, saved_values,
1622                                 vl->values_len * sizeof (*vl->values));
1623         }
1624         else /* if ((pre == NULL) && (post == NULL)) */
1625         {
1626                 saved_values     = NULL;
1627                 saved_values_len = 0;
1628         }
1630         if (pre_cache_chain != NULL)
1631         {
1632                 status = fc_process_chain (ds, vl, pre_cache_chain);
1633                 if (status < 0)
1634                 {
1635                         WARNING ("plugin_dispatch_values: Running the "
1636                                         "pre-cache chain failed with "
1637                                         "status %i (%#x).",
1638                                         status, status);
1639                 }
1640                 else if (status == FC_TARGET_STOP)
1641                 {
1642                         /* Restore the state of the value_list so that plugins
1643                          * don't get confused.. */
1644                         if (saved_values != NULL)
1645                         {
1646                                 free (vl->values);
1647                                 vl->values     = saved_values;
1648                                 vl->values_len = saved_values_len;
1649                         }
1650                         return (0);
1651                 }
1652         }
1654         /* Update the value cache */
1655         uc_update (ds, vl);
1657         if (post_cache_chain != NULL)
1658         {
1659                 status = fc_process_chain (ds, vl, post_cache_chain);
1660                 if (status < 0)
1661                 {
1662                         WARNING ("plugin_dispatch_values: Running the "
1663                                         "post-cache chain failed with "
1664                                         "status %i (%#x).",
1665                                         status, status);
1666                 }
1667         }
1668         else
1669                 fc_default_action (ds, vl);
1671         /* Restore the state of the value_list so that plugins don't get
1672          * confused.. */
1673         if (saved_values != NULL)
1674         {
1675                 free (vl->values);
1676                 vl->values     = saved_values;
1677                 vl->values_len = saved_values_len;
1678         }
1680         if ((free_meta_data != 0) && (vl->meta != NULL))
1681         {
1682                 meta_data_destroy (vl->meta);
1683                 vl->meta = NULL;
1684         }
1686         return (0);
1687 } /* int plugin_dispatch_values */
1689 int plugin_dispatch_values_secure (const value_list_t *vl)
1691   value_list_t vl_copy;
1692   int status;
1694   if (vl == NULL)
1695     return EINVAL;
1697   memcpy (&vl_copy, vl, sizeof (vl_copy));
1699   /* Write callbacks must not change the values and meta pointers, so we can
1700    * savely skip copying those and make this more efficient. */
1701   if ((pre_cache_chain == NULL) && (post_cache_chain == NULL))
1702     return (plugin_dispatch_values (&vl_copy));
1704   /* Set pointers to NULL, just to be on the save side. */
1705   vl_copy.values = NULL;
1706   vl_copy.meta = NULL;
1708   vl_copy.values = malloc (sizeof (*vl_copy.values) * vl->values_len);
1709   if (vl_copy.values == NULL)
1710   {
1711     ERROR ("plugin_dispatch_values_secure: malloc failed.");
1712     return (ENOMEM);
1713   }
1714   memcpy (vl_copy.values, vl->values, sizeof (*vl_copy.values) * vl->values_len);
1716   if (vl->meta != NULL)
1717   {
1718     vl_copy.meta = meta_data_clone (vl->meta);
1719     if (vl_copy.meta == NULL)
1720     {
1721       ERROR ("plugin_dispatch_values_secure: meta_data_clone failed.");
1722       free (vl_copy.values);
1723       return (ENOMEM);
1724     }
1725   } /* if (vl->meta) */
1727   status = plugin_dispatch_values (&vl_copy);
1729   meta_data_destroy (vl_copy.meta);
1730   free (vl_copy.values);
1732   return (status);
1733 } /* int plugin_dispatch_values_secure */
1735 int plugin_dispatch_notification (const notification_t *notif)
1737         llentry_t *le;
1738         /* Possible TODO: Add flap detection here */
1740         DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1741                         "time = %.3f; host = %s;",
1742                         notif->severity, notif->message,
1743                         CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1745         /* Nobody cares for notifications */
1746         if (list_notification == NULL)
1747                 return (-1);
1749         le = llist_head (list_notification);
1750         while (le != NULL)
1751         {
1752                 callback_func_t *cf;
1753                 plugin_notification_cb callback;
1754                 int status;
1756                 /* do not switch plugin context; rather keep the context
1757                  * (interval) information of the calling plugin */
1759                 cf = le->value;
1760                 callback = cf->cf_callback;
1761                 status = (*callback) (notif, &cf->cf_udata);
1762                 if (status != 0)
1763                 {
1764                         WARNING ("plugin_dispatch_notification: Notification "
1765                                         "callback %s returned %i.",
1766                                         le->key, status);
1767                 }
1769                 le = le->next;
1770         }
1772         return (0);
1773 } /* int plugin_dispatch_notification */
1775 void plugin_log (int level, const char *format, ...)
1777         char msg[1024];
1778         va_list ap;
1779         llentry_t *le;
1781 #if !COLLECT_DEBUG
1782         if (level >= LOG_DEBUG)
1783                 return;
1784 #endif
1786         va_start (ap, format);
1787         vsnprintf (msg, sizeof (msg), format, ap);
1788         msg[sizeof (msg) - 1] = '\0';
1789         va_end (ap);
1791         if (list_log == NULL)
1792         {
1793                 fprintf (stderr, "%s\n", msg);
1794                 return;
1795         }
1797         le = llist_head (list_log);
1798         while (le != NULL)
1799         {
1800                 callback_func_t *cf;
1801                 plugin_log_cb callback;
1803                 cf = le->value;
1804                 callback = cf->cf_callback;
1806                 /* do not switch plugin context; rather keep the context
1807                  * (interval) information of the calling plugin */
1809                 (*callback) (level, msg, &cf->cf_udata);
1811                 le = le->next;
1812         }
1813 } /* void plugin_log */
1815 int parse_log_severity (const char *severity)
1817         int log_level = -1;
1819         if ((0 == strcasecmp (severity, "emerg"))
1820                         || (0 == strcasecmp (severity, "alert"))
1821                         || (0 == strcasecmp (severity, "crit"))
1822                         || (0 == strcasecmp (severity, "err")))
1823                 log_level = LOG_ERR;
1824         else if (0 == strcasecmp (severity, "warning"))
1825                 log_level = LOG_WARNING;
1826         else if (0 == strcasecmp (severity, "notice"))
1827                 log_level = LOG_NOTICE;
1828         else if (0 == strcasecmp (severity, "info"))
1829                 log_level = LOG_INFO;
1830 #if COLLECT_DEBUG
1831         else if (0 == strcasecmp (severity, "debug"))
1832                 log_level = LOG_DEBUG;
1833 #endif /* COLLECT_DEBUG */
1835         return (log_level);
1836 } /* int parse_log_severity */
1838 int parse_notif_severity (const char *severity)
1840         int notif_severity = -1;
1842         if (strcasecmp (severity, "FAILURE") == 0)
1843                 notif_severity = NOTIF_FAILURE;
1844         else if (strcmp (severity, "OKAY") == 0)
1845                 notif_severity = NOTIF_OKAY;
1846         else if ((strcmp (severity, "WARNING") == 0)
1847                         || (strcmp (severity, "WARN") == 0))
1848                 notif_severity = NOTIF_WARNING;
1850         return (notif_severity);
1851 } /* int parse_notif_severity */
1853 const data_set_t *plugin_get_ds (const char *name)
1855         data_set_t *ds;
1857         if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1858         {
1859                 DEBUG ("No such dataset registered: %s", name);
1860                 return (NULL);
1861         }
1863         return (ds);
1864 } /* data_set_t *plugin_get_ds */
1866 static int plugin_notification_meta_add (notification_t *n,
1867     const char *name,
1868     enum notification_meta_type_e type,
1869     const void *value)
1871   notification_meta_t *meta;
1872   notification_meta_t *tail;
1874   if ((n == NULL) || (name == NULL) || (value == NULL))
1875   {
1876     ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1877     return (-1);
1878   }
1880   meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1881   if (meta == NULL)
1882   {
1883     ERROR ("plugin_notification_meta_add: malloc failed.");
1884     return (-1);
1885   }
1886   memset (meta, 0, sizeof (notification_meta_t));
1888   sstrncpy (meta->name, name, sizeof (meta->name));
1889   meta->type = type;
1891   switch (type)
1892   {
1893     case NM_TYPE_STRING:
1894     {
1895       meta->nm_value.nm_string = strdup ((const char *) value);
1896       if (meta->nm_value.nm_string == NULL)
1897       {
1898         ERROR ("plugin_notification_meta_add: strdup failed.");
1899         sfree (meta);
1900         return (-1);
1901       }
1902       break;
1903     }
1904     case NM_TYPE_SIGNED_INT:
1905     {
1906       meta->nm_value.nm_signed_int = *((int64_t *) value);
1907       break;
1908     }
1909     case NM_TYPE_UNSIGNED_INT:
1910     {
1911       meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1912       break;
1913     }
1914     case NM_TYPE_DOUBLE:
1915     {
1916       meta->nm_value.nm_double = *((double *) value);
1917       break;
1918     }
1919     case NM_TYPE_BOOLEAN:
1920     {
1921       meta->nm_value.nm_boolean = *((_Bool *) value);
1922       break;
1923     }
1924     default:
1925     {
1926       ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1927       sfree (meta);
1928       return (-1);
1929     }
1930   } /* switch (type) */
1932   meta->next = NULL;
1933   tail = n->meta;
1934   while ((tail != NULL) && (tail->next != NULL))
1935     tail = tail->next;
1937   if (tail == NULL)
1938     n->meta = meta;
1939   else
1940     tail->next = meta;
1942   return (0);
1943 } /* int plugin_notification_meta_add */
1945 int plugin_notification_meta_add_string (notification_t *n,
1946     const char *name,
1947     const char *value)
1949   return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1952 int plugin_notification_meta_add_signed_int (notification_t *n,
1953     const char *name,
1954     int64_t value)
1956   return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1959 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1960     const char *name,
1961     uint64_t value)
1963   return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1966 int plugin_notification_meta_add_double (notification_t *n,
1967     const char *name,
1968     double value)
1970   return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1973 int plugin_notification_meta_add_boolean (notification_t *n,
1974     const char *name,
1975     _Bool value)
1977   return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1980 int plugin_notification_meta_copy (notification_t *dst,
1981     const notification_t *src)
1983   notification_meta_t *meta;
1985   assert (dst != NULL);
1986   assert (src != NULL);
1987   assert (dst != src);
1988   assert ((src->meta == NULL) || (src->meta != dst->meta));
1990   for (meta = src->meta; meta != NULL; meta = meta->next)
1991   {
1992     if (meta->type == NM_TYPE_STRING)
1993       plugin_notification_meta_add_string (dst, meta->name,
1994           meta->nm_value.nm_string);
1995     else if (meta->type == NM_TYPE_SIGNED_INT)
1996       plugin_notification_meta_add_signed_int (dst, meta->name,
1997           meta->nm_value.nm_signed_int);
1998     else if (meta->type == NM_TYPE_UNSIGNED_INT)
1999       plugin_notification_meta_add_unsigned_int (dst, meta->name,
2000           meta->nm_value.nm_unsigned_int);
2001     else if (meta->type == NM_TYPE_DOUBLE)
2002       plugin_notification_meta_add_double (dst, meta->name,
2003           meta->nm_value.nm_double);
2004     else if (meta->type == NM_TYPE_BOOLEAN)
2005       plugin_notification_meta_add_boolean (dst, meta->name,
2006           meta->nm_value.nm_boolean);
2007   }
2009   return (0);
2010 } /* int plugin_notification_meta_copy */
2012 int plugin_notification_meta_free (notification_meta_t *n)
2014   notification_meta_t *this;
2015   notification_meta_t *next;
2017   if (n == NULL)
2018   {
2019     ERROR ("plugin_notification_meta_free: n == NULL!");
2020     return (-1);
2021   }
2023   this = n;
2024   while (this != NULL)
2025   {
2026     next = this->next;
2028     if (this->type == NM_TYPE_STRING)
2029     {
2030       free ((char *)this->nm_value.nm_string);
2031       this->nm_value.nm_string = NULL;
2032     }
2033     sfree (this);
2035     this = next;
2036   }
2038   return (0);
2039 } /* int plugin_notification_meta_free */
2041 static void plugin_ctx_destructor (void *ctx)
2043         sfree (ctx);
2044 } /* void plugin_ctx_destructor */
2046 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2048 static plugin_ctx_t *plugin_ctx_create (void)
2050         plugin_ctx_t *ctx;
2052         ctx = malloc (sizeof (*ctx));
2053         if (ctx == NULL) {
2054                 char errbuf[1024];
2055                 ERROR ("Failed to allocate plugin context: %s",
2056                                 sstrerror (errno, errbuf, sizeof (errbuf)));
2057                 return NULL;
2058         }
2060         *ctx = ctx_init;
2061         assert (plugin_ctx_key_initialized);
2062         pthread_setspecific (plugin_ctx_key, ctx);
2063         DEBUG("Created new plugin context.");
2064         return (ctx);
2065 } /* int plugin_ctx_create */
2067 void plugin_init_ctx (void)
2069         pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2070         plugin_ctx_key_initialized = 1;
2071 } /* void plugin_init_ctx */
2073 plugin_ctx_t plugin_get_ctx (void)
2075         plugin_ctx_t *ctx;
2077         assert (plugin_ctx_key_initialized);
2078         ctx = pthread_getspecific (plugin_ctx_key);
2080         if (ctx == NULL) {
2081                 ctx = plugin_ctx_create ();
2082                 /* this must no happen -- exit() instead? */
2083                 if (ctx == NULL)
2084                         return ctx_init;
2085         }
2087         return (*ctx);
2088 } /* plugin_ctx_t plugin_get_ctx */
2090 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2092         plugin_ctx_t *c;
2093         plugin_ctx_t old;
2095         assert (plugin_ctx_key_initialized);
2096         c = pthread_getspecific (plugin_ctx_key);
2098         if (c == NULL) {
2099                 c = plugin_ctx_create ();
2100                 /* this must no happen -- exit() instead? */
2101                 if (c == NULL)
2102                         return ctx_init;
2103         }
2105         old = *c;
2106         *c = ctx;
2108         return (old);
2109 } /* void plugin_set_ctx */
2111 cdtime_t plugin_get_interval (void)
2113         cdtime_t interval;
2115         interval = plugin_get_ctx().interval;
2116         if (interval > 0)
2117                 return interval;
2119         return cf_get_default_interval ();
2120 } /* cdtime_t plugin_get_interval */
2122 typedef struct {
2123         plugin_ctx_t ctx;
2124         void *(*start_routine) (void *);
2125         void *arg;
2126 } plugin_thread_t;
2128 static void *plugin_thread_start (void *arg)
2130         plugin_thread_t *plugin_thread = arg;
2132         void *(*start_routine) (void *) = plugin_thread->start_routine;
2133         void *plugin_arg = plugin_thread->arg;
2135         plugin_set_ctx (plugin_thread->ctx);
2137         free (plugin_thread);
2139         return start_routine (plugin_arg);
2140 } /* void *plugin_thread_start */
2142 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2143                 void *(*start_routine) (void *), void *arg)
2145         plugin_thread_t *plugin_thread;
2147         plugin_thread = malloc (sizeof (*plugin_thread));
2148         if (plugin_thread == NULL)
2149                 return -1;
2151         plugin_thread->ctx           = plugin_get_ctx ();
2152         plugin_thread->start_routine = start_routine;
2153         plugin_thread->arg           = arg;
2155         return pthread_create (thread, attr,
2156                         plugin_thread_start, plugin_thread);
2157 } /* int plugin_thread_create */
2159 /* vim: set sw=8 ts=8 noet fdm=marker : */