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