Merge branch 'kn/snort'
[collectd.git] / src / plugin.c
1 /**
2  * collectd - src/plugin.c
3  * Copyright (C) 2005-2013  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  **/
22
23 #include "collectd.h"
24 #include "common.h"
25 #include "plugin.h"
26 #include "configfile.h"
27 #include "filter_chain.h"
28 #include "utils_avltree.h"
29 #include "utils_cache.h"
30 #include "utils_complain.h"
31 #include "utils_llist.h"
32 #include "utils_heap.h"
33 #include "utils_time.h"
34
35 #if HAVE_PTHREAD_H
36 # include <pthread.h>
37 #endif
38
39 #include <ltdl.h>
40
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;
51
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         cdtime_t rf_interval;
67         cdtime_t rf_effective_interval;
68         cdtime_t rf_next_read;
69 };
70 typedef struct read_func_s read_func_t;
71
72 struct write_queue_s;
73 typedef struct write_queue_s write_queue_t;
74 struct write_queue_s
75 {
76         value_list_t *vl;
77         plugin_ctx_t ctx;
78         write_queue_t *next;
79 };
80
81 /*
82  * Private variables
83  */
84 static llist_t *list_init;
85 static llist_t *list_write;
86 static llist_t *list_flush;
87 static llist_t *list_missing;
88 static llist_t *list_shutdown;
89 static llist_t *list_log;
90 static llist_t *list_notification;
91
92 static fc_chain_t *pre_cache_chain = NULL;
93 static fc_chain_t *post_cache_chain = NULL;
94
95 static c_avl_tree_t *data_sets;
96
97 static char *plugindir = NULL;
98
99 static c_heap_t       *read_heap = NULL;
100 static llist_t        *read_list;
101 static int             read_loop = 1;
102 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
103 static pthread_cond_t  read_cond = PTHREAD_COND_INITIALIZER;
104 static pthread_t      *read_threads = NULL;
105 static int             read_threads_num = 0;
106
107 static write_queue_t  *write_queue_head;
108 static write_queue_t  *write_queue_tail;
109 static _Bool           write_loop = 1;
110 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
111 static pthread_cond_t  write_cond = PTHREAD_COND_INITIALIZER;
112 static pthread_t      *write_threads = NULL;
113 static size_t          write_threads_num = 0;
114
115 static pthread_key_t   plugin_ctx_key;
116 static _Bool           plugin_ctx_key_initialized = 0;
117
118 /*
119  * Static functions
120  */
121 static int plugin_dispatch_values_internal (value_list_t *vl);
122
123 static const char *plugin_get_dir (void)
124 {
125         if (plugindir == NULL)
126                 return (PLUGINDIR);
127         else
128                 return (plugindir);
129 }
130
131 static void destroy_callback (callback_func_t *cf) /* {{{ */
132 {
133         if (cf == NULL)
134                 return;
135
136         if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
137         {
138                 cf->cf_udata.free_func (cf->cf_udata.data);
139                 cf->cf_udata.data = NULL;
140                 cf->cf_udata.free_func = NULL;
141         }
142         sfree (cf);
143 } /* }}} void destroy_callback */
144
145 static void destroy_all_callbacks (llist_t **list) /* {{{ */
146 {
147         llentry_t *le;
148
149         if (*list == NULL)
150                 return;
151
152         le = llist_head (*list);
153         while (le != NULL)
154         {
155                 llentry_t *le_next;
156
157                 le_next = le->next;
158
159                 sfree (le->key);
160                 destroy_callback (le->value);
161                 le->value = NULL;
162
163                 le = le_next;
164         }
165
166         llist_destroy (*list);
167         *list = NULL;
168 } /* }}} void destroy_all_callbacks */
169
170 static void destroy_read_heap (void) /* {{{ */
171 {
172         if (read_heap == NULL)
173                 return;
174
175         while (42)
176         {
177                 callback_func_t *cf;
178
179                 cf = c_heap_get_root (read_heap);
180                 if (cf == NULL)
181                         break;
182
183                 destroy_callback (cf);
184         }
185
186         c_heap_destroy (read_heap);
187         read_heap = NULL;
188 } /* }}} void destroy_read_heap */
189
190 static int register_callback (llist_t **list, /* {{{ */
191                 const char *name, callback_func_t *cf)
192 {
193         llentry_t *le;
194         char *key;
195
196         if (*list == NULL)
197         {
198                 *list = llist_create ();
199                 if (*list == NULL)
200                 {
201                         ERROR ("plugin: register_callback: "
202                                         "llist_create failed.");
203                         destroy_callback (cf);
204                         return (-1);
205                 }
206         }
207
208         key = strdup (name);
209         if (key == NULL)
210         {
211                 ERROR ("plugin: register_callback: strdup failed.");
212                 destroy_callback (cf);
213                 return (-1);
214         }
215
216         le = llist_search (*list, name);
217         if (le == NULL)
218         {
219                 le = llentry_create (key, cf);
220                 if (le == NULL)
221                 {
222                         ERROR ("plugin: register_callback: "
223                                         "llentry_create failed.");
224                         free (key);
225                         destroy_callback (cf);
226                         return (-1);
227                 }
228
229                 llist_append (*list, le);
230         }
231         else
232         {
233                 callback_func_t *old_cf;
234
235                 old_cf = le->value;
236                 le->value = cf;
237
238                 WARNING ("plugin: register_callback: "
239                                 "a callback named `%s' already exists - "
240                                 "overwriting the old entry!", name);
241
242                 destroy_callback (old_cf);
243                 sfree (key);
244         }
245
246         return (0);
247 } /* }}} int register_callback */
248
249 static int create_register_callback (llist_t **list, /* {{{ */
250                 const char *name, void *callback, user_data_t *ud)
251 {
252         callback_func_t *cf;
253
254         cf = (callback_func_t *) malloc (sizeof (*cf));
255         if (cf == NULL)
256         {
257                 ERROR ("plugin: create_register_callback: malloc failed.");
258                 return (-1);
259         }
260         memset (cf, 0, sizeof (*cf));
261
262         cf->cf_callback = callback;
263         if (ud == NULL)
264         {
265                 cf->cf_udata.data = NULL;
266                 cf->cf_udata.free_func = NULL;
267         }
268         else
269         {
270                 cf->cf_udata = *ud;
271         }
272
273         cf->cf_ctx = plugin_get_ctx ();
274
275         return (register_callback (list, name, cf));
276 } /* }}} int create_register_callback */
277
278 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
279 {
280         llentry_t *e;
281
282         if (list == NULL)
283                 return (-1);
284
285         e = llist_search (list, name);
286         if (e == NULL)
287                 return (-1);
288
289         llist_remove (list, e);
290
291         sfree (e->key);
292         destroy_callback (e->value);
293
294         llentry_destroy (e);
295
296         return (0);
297 } /* }}} int plugin_unregister */
298
299 /*
300  * (Try to) load the shared object `file'. Won't complain if it isn't a shared
301  * object, but it will bitch about a shared object not having a
302  * ``module_register'' symbol..
303  */
304 static int plugin_load_file (char *file, uint32_t flags)
305 {
306         lt_dlhandle dlh;
307         void (*reg_handle) (void);
308
309         lt_dlinit ();
310         lt_dlerror (); /* clear errors */
311
312 #if LIBTOOL_VERSION == 2
313         if (flags & PLUGIN_FLAGS_GLOBAL) {
314                 lt_dladvise advise;
315                 lt_dladvise_init(&advise);
316                 lt_dladvise_global(&advise);
317                 dlh = lt_dlopenadvise(file, advise);
318                 lt_dladvise_destroy(&advise);
319         } else {
320                 dlh = lt_dlopen (file);
321         }
322 #else /* if LIBTOOL_VERSION == 1 */
323         if (flags & PLUGIN_FLAGS_GLOBAL)
324                 WARNING ("plugin_load_file: The global flag is not supported, "
325                                 "libtool 2 is required for this.");
326         dlh = lt_dlopen (file);
327 #endif
328
329         if (dlh == NULL)
330         {
331                 char errbuf[1024] = "";
332
333                 ssnprintf (errbuf, sizeof (errbuf),
334                                 "lt_dlopen (\"%s\") failed: %s. "
335                                 "The most common cause for this problem are "
336                                 "missing dependencies. Use ldd(1) to check "
337                                 "the dependencies of the plugin "
338                                 "/ shared object.",
339                                 file, lt_dlerror ());
340
341                 ERROR ("%s", errbuf);
342                 /* Make sure this is printed to STDERR in any case, but also
343                  * make sure it's printed only once. */
344                 if (list_log != NULL)
345                         fprintf (stderr, "ERROR: %s\n", errbuf);
346
347                 return (1);
348         }
349
350         if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
351         {
352                 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
353                                 file, lt_dlerror ());
354                 lt_dlclose (dlh);
355                 return (-1);
356         }
357
358         (*reg_handle) ();
359
360         return (0);
361 }
362
363 static void *plugin_read_thread (void __attribute__((unused)) *args)
364 {
365         while (read_loop != 0)
366         {
367                 read_func_t *rf;
368                 plugin_ctx_t old_ctx;
369                 cdtime_t now;
370                 int status;
371                 int rf_type;
372                 int rc;
373
374                 /* Get the read function that needs to be read next.
375                  * We don't need to hold "read_lock" for the heap, but we need
376                  * to call c_heap_get_root() and pthread_cond_wait() in the
377                  * same protected block. */
378                 pthread_mutex_lock (&read_lock);
379                 rf = c_heap_get_root (read_heap);
380                 if (rf == NULL)
381                 {
382                         pthread_cond_wait (&read_cond, &read_lock);
383                         pthread_mutex_unlock (&read_lock);
384                         continue;
385                 }
386                 pthread_mutex_unlock (&read_lock);
387
388                 if (rf->rf_interval == 0)
389                 {
390                         /* this should not happen, because the interval is set
391                          * for each plugin when loading it
392                          * XXX: issue a warning? */
393                         rf->rf_interval = plugin_get_interval ();
394                         rf->rf_effective_interval = rf->rf_interval;
395
396                         rf->rf_next_read = cdtime ();
397                 }
398
399                 /* sleep until this entry is due,
400                  * using pthread_cond_timedwait */
401                 pthread_mutex_lock (&read_lock);
402                 /* In pthread_cond_timedwait, spurious wakeups are possible
403                  * (and really happen, at least on NetBSD with > 1 CPU), thus
404                  * we need to re-evaluate the condition every time
405                  * pthread_cond_timedwait returns. */
406                 rc = 0;
407                 while ((read_loop != 0)
408                                 && (cdtime () < rf->rf_next_read)
409                                 && rc == 0)
410                 {
411                         struct timespec ts = { 0 };
412
413                         CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
414
415                         rc = pthread_cond_timedwait (&read_cond, &read_lock,
416                                 &ts);
417                 }
418
419                 /* Must hold `read_lock' when accessing `rf->rf_type'. */
420                 rf_type = rf->rf_type;
421                 pthread_mutex_unlock (&read_lock);
422
423                 /* Check if we're supposed to stop.. This may have interrupted
424                  * the sleep, too. */
425                 if (read_loop == 0)
426                 {
427                         /* Insert `rf' again, so it can be free'd correctly */
428                         c_heap_insert (read_heap, rf);
429                         break;
430                 }
431
432                 /* The entry has been marked for deletion. The linked list
433                  * entry has already been removed by `plugin_unregister_read'.
434                  * All we have to do here is free the `read_func_t' and
435                  * continue. */
436                 if (rf_type == RF_REMOVE)
437                 {
438                         DEBUG ("plugin_read_thread: Destroying the `%s' "
439                                         "callback.", rf->rf_name);
440                         destroy_callback ((callback_func_t *) rf);
441                         rf = NULL;
442                         continue;
443                 }
444
445                 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
446
447                 old_ctx = plugin_set_ctx (rf->rf_ctx);
448
449                 if (rf_type == RF_SIMPLE)
450                 {
451                         int (*callback) (void);
452
453                         callback = rf->rf_callback;
454                         status = (*callback) ();
455                 }
456                 else
457                 {
458                         plugin_read_cb callback;
459
460                         assert (rf_type == RF_COMPLEX);
461
462                         callback = rf->rf_callback;
463                         status = (*callback) (&rf->rf_udata);
464                 }
465
466                 plugin_set_ctx (old_ctx);
467
468                 /* If the function signals failure, we will increase the
469                  * intervals in which it will be called. */
470                 if (status != 0)
471                 {
472                         rf->rf_effective_interval *= 2;
473                         if (rf->rf_effective_interval > TIME_T_TO_CDTIME_T (86400))
474                                 rf->rf_effective_interval = TIME_T_TO_CDTIME_T (86400);
475
476                         NOTICE ("read-function of plugin `%s' failed. "
477                                         "Will suspend it for %.3f seconds.",
478                                         rf->rf_name,
479                                         CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
480                 }
481                 else
482                 {
483                         /* Success: Restore the interval, if it was changed. */
484                         rf->rf_effective_interval = rf->rf_interval;
485                 }
486
487                 /* update the ``next read due'' field */
488                 now = cdtime ();
489
490                 DEBUG ("plugin_read_thread: Effective interval of the "
491                                 "%s plugin is %.3f seconds.",
492                                 rf->rf_name,
493                                 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
494
495                 /* Calculate the next (absolute) time at which this function
496                  * should be called. */
497                 rf->rf_next_read += rf->rf_effective_interval;
498
499                 /* Check, if `rf_next_read' is in the past. */
500                 if (rf->rf_next_read < now)
501                 {
502                         /* `rf_next_read' is in the past. Insert `now'
503                          * so this value doesn't trail off into the
504                          * past too much. */
505                         rf->rf_next_read = now;
506                 }
507
508                 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
509                                 rf->rf_name,
510                                 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
511
512                 /* Re-insert this read function into the heap again. */
513                 c_heap_insert (read_heap, rf);
514         } /* while (read_loop) */
515
516         pthread_exit (NULL);
517         return ((void *) 0);
518 } /* void *plugin_read_thread */
519
520 static void start_read_threads (int num)
521 {
522         int i;
523
524         if (read_threads != NULL)
525                 return;
526
527         read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
528         if (read_threads == NULL)
529         {
530                 ERROR ("plugin: start_read_threads: calloc failed.");
531                 return;
532         }
533
534         read_threads_num = 0;
535         for (i = 0; i < num; i++)
536         {
537                 if (pthread_create (read_threads + read_threads_num, NULL,
538                                         plugin_read_thread, NULL) == 0)
539                 {
540                         read_threads_num++;
541                 }
542                 else
543                 {
544                         ERROR ("plugin: start_read_threads: pthread_create failed.");
545                         return;
546                 }
547         } /* for (i) */
548 } /* void start_read_threads */
549
550 static void stop_read_threads (void)
551 {
552         int i;
553
554         if (read_threads == NULL)
555                 return;
556
557         INFO ("collectd: Stopping %i read threads.", read_threads_num);
558
559         pthread_mutex_lock (&read_lock);
560         read_loop = 0;
561         DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
562         pthread_cond_broadcast (&read_cond);
563         pthread_mutex_unlock (&read_lock);
564
565         for (i = 0; i < read_threads_num; i++)
566         {
567                 if (pthread_join (read_threads[i], NULL) != 0)
568                 {
569                         ERROR ("plugin: stop_read_threads: pthread_join failed.");
570                 }
571                 read_threads[i] = (pthread_t) 0;
572         }
573         sfree (read_threads);
574         read_threads_num = 0;
575 } /* void stop_read_threads */
576
577 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
578 {
579         if (vl == NULL)
580                 return;
581
582         meta_data_destroy (vl->meta);
583         sfree (vl->values);
584         sfree (vl);
585 } /* }}} void plugin_value_list_free */
586
587 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
588 {
589         value_list_t *vl;
590
591         if (vl_orig == NULL)
592                 return (NULL);
593
594         vl = malloc (sizeof (*vl));
595         if (vl == NULL)
596                 return (NULL);
597         memcpy (vl, vl_orig, sizeof (*vl));
598
599         vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
600         if (vl->values == NULL)
601         {
602                 plugin_value_list_free (vl);
603                 return (NULL);
604         }
605         memcpy (vl->values, vl_orig->values,
606                         vl_orig->values_len * sizeof (*vl->values));
607
608         vl->meta = meta_data_clone (vl->meta);
609         if ((vl_orig->meta != NULL) && (vl->meta == NULL))
610         {
611                 plugin_value_list_free (vl);
612                 return (NULL);
613         }
614
615         if (vl->time == 0)
616                 vl->time = cdtime ();
617
618         /* Fill in the interval from the thread context, if it is zero. */
619         if (vl->interval == 0)
620         {
621                 plugin_ctx_t ctx = plugin_get_ctx ();
622
623                 if (ctx.interval != 0)
624                         vl->interval = ctx.interval;
625                 else
626                 {
627                         char name[6 * DATA_MAX_NAME_LEN];
628                         FORMAT_VL (name, sizeof (name), vl);
629                         ERROR ("plugin_value_list_clone: Unable to determine "
630                                         "interval from context for "
631                                         "value list \"%s\". "
632                                         "This indicates a broken plugin. "
633                                         "Please report this problem to the "
634                                         "collectd mailing list or at "
635                                         "<http://collectd.org/bugs/>.", name);
636                         vl->interval = cf_get_default_interval ();
637                 }
638         }
639
640         return (vl);
641 } /* }}} value_list_t *plugin_value_list_clone */
642
643 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
644 {
645         write_queue_t *q;
646
647         q = malloc (sizeof (*q));
648         if (q == NULL)
649                 return (ENOMEM);
650         q->next = NULL;
651
652         q->vl = plugin_value_list_clone (vl);
653         if (q->vl == NULL)
654         {
655                 sfree (q);
656                 return (ENOMEM);
657         }
658
659         /* Store context of caller (read plugin); otherwise, it would not be
660          * available to the write plugins when actually dispatching the
661          * value-list later on. */
662         q->ctx = plugin_get_ctx ();
663
664         pthread_mutex_lock (&write_lock);
665
666         if (write_queue_tail == NULL)
667         {
668                 write_queue_head = q;
669                 write_queue_tail = q;
670         }
671         else
672         {
673                 write_queue_tail->next = q;
674                 write_queue_tail = q;
675         }
676
677         pthread_cond_signal (&write_cond);
678         pthread_mutex_unlock (&write_lock);
679
680         return (0);
681 } /* }}} int plugin_write_enqueue */
682
683 static value_list_t *plugin_write_dequeue (void) /* {{{ */
684 {
685         write_queue_t *q;
686         value_list_t *vl;
687
688         pthread_mutex_lock (&write_lock);
689
690         while (write_loop && (write_queue_head == NULL))
691                 pthread_cond_wait (&write_cond, &write_lock);
692
693         if (write_queue_head == NULL)
694         {
695                 pthread_mutex_unlock (&write_lock);
696                 return (NULL);
697         }
698
699         q = write_queue_head;
700         write_queue_head = q->next;
701         if (write_queue_head == NULL)
702                 write_queue_tail = NULL;
703
704         pthread_mutex_unlock (&write_lock);
705
706         (void) plugin_set_ctx (q->ctx);
707
708         vl = q->vl;
709         sfree (q);
710         return (vl);
711 } /* }}} value_list_t *plugin_write_dequeue */
712
713 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
714 {
715         while (write_loop)
716         {
717                 value_list_t *vl = plugin_write_dequeue ();
718                 if (vl == NULL)
719                         continue;
720
721                 plugin_dispatch_values_internal (vl);
722
723                 plugin_value_list_free (vl);
724         }
725
726         pthread_exit (NULL);
727         return ((void *) 0);
728 } /* }}} void *plugin_write_thread */
729
730 static void start_write_threads (size_t num) /* {{{ */
731 {
732         size_t i;
733
734         if (write_threads != NULL)
735                 return;
736
737         write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
738         if (write_threads == NULL)
739         {
740                 ERROR ("plugin: start_write_threads: calloc failed.");
741                 return;
742         }
743
744         write_threads_num = 0;
745         for (i = 0; i < num; i++)
746         {
747                 int status;
748
749                 status = pthread_create (write_threads + write_threads_num,
750                                 /* attr = */ NULL,
751                                 plugin_write_thread,
752                                 /* arg = */ NULL);
753                 if (status != 0)
754                 {
755                         char errbuf[1024];
756                         ERROR ("plugin: start_write_threads: pthread_create failed "
757                                         "with status %i (%s).", status,
758                                         sstrerror (status, errbuf, sizeof (errbuf)));
759                         return;
760                 }
761
762                 write_threads_num++;
763         } /* for (i) */
764 } /* }}} void start_write_threads */
765
766 static void stop_write_threads (void) /* {{{ */
767 {
768         write_queue_t *q;
769         int i;
770
771         if (write_threads == NULL)
772                 return;
773
774         INFO ("collectd: Stopping %zu write threads.", write_threads_num);
775
776         pthread_mutex_lock (&write_lock);
777         write_loop = 0;
778         DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
779         pthread_cond_broadcast (&write_cond);
780         pthread_mutex_unlock (&write_lock);
781
782         for (i = 0; i < write_threads_num; i++)
783         {
784                 if (pthread_join (write_threads[i], NULL) != 0)
785                 {
786                         ERROR ("plugin: stop_write_threads: pthread_join failed.");
787                 }
788                 write_threads[i] = (pthread_t) 0;
789         }
790         sfree (write_threads);
791         write_threads_num = 0;
792
793         pthread_mutex_lock (&write_lock);
794         i = 0;
795         for (q = write_queue_head; q != NULL; )
796         {
797                 write_queue_t *q1 = q;
798                 plugin_value_list_free (q->vl);
799                 q = q->next;
800                 sfree (q1);
801                 i++;
802         }
803         write_queue_head = NULL;
804         write_queue_tail = NULL;
805         pthread_mutex_unlock (&write_lock);
806
807         if (i > 0)
808         {
809                 WARNING ("plugin: %i value list%s left after shutting down "
810                                 "the write threads.",
811                                 i, (i == 1) ? " was" : "s were");
812         }
813 } /* }}} void stop_write_threads */
814
815 /*
816  * Public functions
817  */
818 void plugin_set_dir (const char *dir)
819 {
820         if (plugindir != NULL)
821                 free (plugindir);
822
823         if (dir == NULL)
824                 plugindir = NULL;
825         else if ((plugindir = strdup (dir)) == NULL)
826         {
827                 char errbuf[1024];
828                 ERROR ("strdup failed: %s",
829                                 sstrerror (errno, errbuf, sizeof (errbuf)));
830         }
831 }
832
833 #define BUFSIZE 512
834 int plugin_load (const char *type, uint32_t flags)
835 {
836         DIR  *dh;
837         const char *dir;
838         char  filename[BUFSIZE] = "";
839         char  typename[BUFSIZE];
840         int   typename_len;
841         int   ret;
842         struct stat    statbuf;
843         struct dirent *de;
844         int status;
845
846         dir = plugin_get_dir ();
847         ret = 1;
848
849         /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
850          * type when matching the filename */
851         status = ssnprintf (typename, sizeof (typename), "%s.so", type);
852         if ((status < 0) || ((size_t) status >= sizeof (typename)))
853         {
854                 WARNING ("plugin_load: Filename too long: \"%s.so\"", type);
855                 return (-1);
856         }
857         typename_len = strlen (typename);
858
859         if ((dh = opendir (dir)) == NULL)
860         {
861                 char errbuf[1024];
862                 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
863                                 sstrerror (errno, errbuf, sizeof (errbuf)));
864                 return (-1);
865         }
866
867         while ((de = readdir (dh)) != NULL)
868         {
869                 if (strncasecmp (de->d_name, typename, typename_len))
870                         continue;
871
872                 status = ssnprintf (filename, sizeof (filename),
873                                 "%s/%s", dir, de->d_name);
874                 if ((status < 0) || ((size_t) status >= sizeof (filename)))
875                 {
876                         WARNING ("plugin_load: Filename too long: \"%s/%s\"",
877                                         dir, de->d_name);
878                         continue;
879                 }
880
881                 if (lstat (filename, &statbuf) == -1)
882                 {
883                         char errbuf[1024];
884                         WARNING ("plugin_load: stat (\"%s\") failed: %s",
885                                         filename,
886                                         sstrerror (errno, errbuf, sizeof (errbuf)));
887                         continue;
888                 }
889                 else if (!S_ISREG (statbuf.st_mode))
890                 {
891                         /* don't follow symlinks */
892                         WARNING ("plugin_load: %s is not a regular file.",
893                                         filename);
894                         continue;
895                 }
896
897                 status = plugin_load_file (filename, flags);
898                 if (status == 0)
899                 {
900                         /* success */
901                         ret = 0;
902                         break;
903                 }
904                 else
905                 {
906                         ERROR ("plugin_load: Load plugin \"%s\" failed with "
907                                         "status %i.", type, status);
908                 }
909         }
910
911         closedir (dh);
912
913         if (filename[0] == 0)
914                 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
915                                 type, dir);
916
917         return (ret);
918 }
919
920 /*
921  * The `register_*' functions follow
922  */
923 int plugin_register_config (const char *name,
924                 int (*callback) (const char *key, const char *val),
925                 const char **keys, int keys_num)
926 {
927         cf_register (name, callback, keys, keys_num);
928         return (0);
929 } /* int plugin_register_config */
930
931 int plugin_register_complex_config (const char *type,
932                 int (*callback) (oconfig_item_t *))
933 {
934         return (cf_register_complex (type, callback));
935 } /* int plugin_register_complex_config */
936
937 int plugin_register_init (const char *name,
938                 int (*callback) (void))
939 {
940         return (create_register_callback (&list_init, name, (void *) callback,
941                                 /* user_data = */ NULL));
942 } /* plugin_register_init */
943
944 static int plugin_compare_read_func (const void *arg0, const void *arg1)
945 {
946         const read_func_t *rf0;
947         const read_func_t *rf1;
948
949         rf0 = arg0;
950         rf1 = arg1;
951
952         if (rf0->rf_next_read < rf1->rf_next_read)
953                 return (-1);
954         else if (rf0->rf_next_read > rf1->rf_next_read)
955                 return (1);
956         else
957                 return (0);
958 } /* int plugin_compare_read_func */
959
960 /* Add a read function to both, the heap and a linked list. The linked list if
961  * used to look-up read functions, especially for the remove function. The heap
962  * is used to determine which plugin to read next. */
963 static int plugin_insert_read (read_func_t *rf)
964 {
965         int status;
966         llentry_t *le;
967
968         rf->rf_next_read = cdtime ();
969         rf->rf_effective_interval = rf->rf_interval;
970
971         pthread_mutex_lock (&read_lock);
972
973         if (read_list == NULL)
974         {
975                 read_list = llist_create ();
976                 if (read_list == NULL)
977                 {
978                         pthread_mutex_unlock (&read_lock);
979                         ERROR ("plugin_insert_read: read_list failed.");
980                         return (-1);
981                 }
982         }
983
984         if (read_heap == NULL)
985         {
986                 read_heap = c_heap_create (plugin_compare_read_func);
987                 if (read_heap == NULL)
988                 {
989                         pthread_mutex_unlock (&read_lock);
990                         ERROR ("plugin_insert_read: c_heap_create failed.");
991                         return (-1);
992                 }
993         }
994
995         le = llist_search (read_list, rf->rf_name);
996         if (le != NULL)
997         {
998                 pthread_mutex_unlock (&read_lock);
999                 WARNING ("The read function \"%s\" is already registered. "
1000                                 "Check for duplicate \"LoadPlugin\" lines "
1001                                 "in your configuration!",
1002                                 rf->rf_name);
1003                 return (EINVAL);
1004         }
1005
1006         le = llentry_create (rf->rf_name, rf);
1007         if (le == NULL)
1008         {
1009                 pthread_mutex_unlock (&read_lock);
1010                 ERROR ("plugin_insert_read: llentry_create failed.");
1011                 return (-1);
1012         }
1013
1014         status = c_heap_insert (read_heap, rf);
1015         if (status != 0)
1016         {
1017                 pthread_mutex_unlock (&read_lock);
1018                 ERROR ("plugin_insert_read: c_heap_insert failed.");
1019                 llentry_destroy (le);
1020                 return (-1);
1021         }
1022
1023         /* This does not fail. */
1024         llist_append (read_list, le);
1025
1026         /* Wake up all the read threads. */
1027         pthread_cond_broadcast (&read_cond);
1028         pthread_mutex_unlock (&read_lock);
1029         return (0);
1030 } /* int plugin_insert_read */
1031
1032 int plugin_register_read (const char *name,
1033                 int (*callback) (void))
1034 {
1035         read_func_t *rf;
1036         int status;
1037
1038         rf = malloc (sizeof (*rf));
1039         if (rf == NULL)
1040         {
1041                 ERROR ("plugin_register_read: malloc failed.");
1042                 return (ENOMEM);
1043         }
1044
1045         memset (rf, 0, sizeof (read_func_t));
1046         rf->rf_callback = (void *) callback;
1047         rf->rf_udata.data = NULL;
1048         rf->rf_udata.free_func = NULL;
1049         rf->rf_ctx = plugin_get_ctx ();
1050         rf->rf_group[0] = '\0';
1051         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
1052         rf->rf_type = RF_SIMPLE;
1053         rf->rf_interval = plugin_get_interval ();
1054
1055         status = plugin_insert_read (rf);
1056         if (status != 0)
1057                 sfree (rf);
1058
1059         return (status);
1060 } /* int plugin_register_read */
1061
1062 int plugin_register_complex_read (const char *group, const char *name,
1063                 plugin_read_cb callback,
1064                 const struct timespec *interval,
1065                 user_data_t *user_data)
1066 {
1067         read_func_t *rf;
1068         int status;
1069
1070         rf = malloc (sizeof (*rf));
1071         if (rf == NULL)
1072         {
1073                 ERROR ("plugin_register_complex_read: malloc failed.");
1074                 return (ENOMEM);
1075         }
1076
1077         memset (rf, 0, sizeof (read_func_t));
1078         rf->rf_callback = (void *) callback;
1079         if (group != NULL)
1080                 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1081         else
1082                 rf->rf_group[0] = '\0';
1083         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
1084         rf->rf_type = RF_COMPLEX;
1085         if (interval != NULL)
1086                 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1087         else
1088                 rf->rf_interval = plugin_get_interval ();
1089
1090         /* Set user data */
1091         if (user_data == NULL)
1092         {
1093                 rf->rf_udata.data = NULL;
1094                 rf->rf_udata.free_func = NULL;
1095         }
1096         else
1097         {
1098                 rf->rf_udata = *user_data;
1099         }
1100
1101         rf->rf_ctx = plugin_get_ctx ();
1102
1103         status = plugin_insert_read (rf);
1104         if (status != 0)
1105                 sfree (rf);
1106
1107         return (status);
1108 } /* int plugin_register_complex_read */
1109
1110 int plugin_register_write (const char *name,
1111                 plugin_write_cb callback, user_data_t *ud)
1112 {
1113         return (create_register_callback (&list_write, name,
1114                                 (void *) callback, ud));
1115 } /* int plugin_register_write */
1116
1117 int plugin_register_flush (const char *name,
1118                 plugin_flush_cb callback, user_data_t *ud)
1119 {
1120         return (create_register_callback (&list_flush, name,
1121                                 (void *) callback, ud));
1122 } /* int plugin_register_flush */
1123
1124 int plugin_register_missing (const char *name,
1125                 plugin_missing_cb callback, user_data_t *ud)
1126 {
1127         return (create_register_callback (&list_missing, name,
1128                                 (void *) callback, ud));
1129 } /* int plugin_register_missing */
1130
1131 int plugin_register_shutdown (const char *name,
1132                 int (*callback) (void))
1133 {
1134         return (create_register_callback (&list_shutdown, name,
1135                                 (void *) callback, /* user_data = */ NULL));
1136 } /* int plugin_register_shutdown */
1137
1138 int plugin_register_data_set (const data_set_t *ds)
1139 {
1140         data_set_t *ds_copy;
1141         int i;
1142
1143         if ((data_sets != NULL)
1144                         && (c_avl_get (data_sets, ds->type, NULL) == 0))
1145         {
1146                 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1147                 plugin_unregister_data_set (ds->type);
1148         }
1149         else if (data_sets == NULL)
1150         {
1151                 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1152                 if (data_sets == NULL)
1153                         return (-1);
1154         }
1155
1156         ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1157         if (ds_copy == NULL)
1158                 return (-1);
1159         memcpy(ds_copy, ds, sizeof (data_set_t));
1160
1161         ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1162                         * ds->ds_num);
1163         if (ds_copy->ds == NULL)
1164         {
1165                 free (ds_copy);
1166                 return (-1);
1167         }
1168
1169         for (i = 0; i < ds->ds_num; i++)
1170                 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1171
1172         return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1173 } /* int plugin_register_data_set */
1174
1175 int plugin_register_log (const char *name,
1176                 plugin_log_cb callback, user_data_t *ud)
1177 {
1178         return (create_register_callback (&list_log, name,
1179                                 (void *) callback, ud));
1180 } /* int plugin_register_log */
1181
1182 int plugin_register_notification (const char *name,
1183                 plugin_notification_cb callback, user_data_t *ud)
1184 {
1185         return (create_register_callback (&list_notification, name,
1186                                 (void *) callback, ud));
1187 } /* int plugin_register_log */
1188
1189 int plugin_unregister_config (const char *name)
1190 {
1191         cf_unregister (name);
1192         return (0);
1193 } /* int plugin_unregister_config */
1194
1195 int plugin_unregister_complex_config (const char *name)
1196 {
1197         cf_unregister_complex (name);
1198         return (0);
1199 } /* int plugin_unregister_complex_config */
1200
1201 int plugin_unregister_init (const char *name)
1202 {
1203         return (plugin_unregister (list_init, name));
1204 }
1205
1206 int plugin_unregister_read (const char *name) /* {{{ */
1207 {
1208         llentry_t *le;
1209         read_func_t *rf;
1210
1211         if (name == NULL)
1212                 return (-ENOENT);
1213
1214         pthread_mutex_lock (&read_lock);
1215
1216         if (read_list == NULL)
1217         {
1218                 pthread_mutex_unlock (&read_lock);
1219                 return (-ENOENT);
1220         }
1221
1222         le = llist_search (read_list, name);
1223         if (le == NULL)
1224         {
1225                 pthread_mutex_unlock (&read_lock);
1226                 WARNING ("plugin_unregister_read: No such read function: %s",
1227                                 name);
1228                 return (-ENOENT);
1229         }
1230
1231         llist_remove (read_list, le);
1232
1233         rf = le->value;
1234         assert (rf != NULL);
1235         rf->rf_type = RF_REMOVE;
1236
1237         pthread_mutex_unlock (&read_lock);
1238
1239         llentry_destroy (le);
1240
1241         DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1242
1243         return (0);
1244 } /* }}} int plugin_unregister_read */
1245
1246 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1247 {
1248         read_func_t *rf    = e->value;
1249         char        *group = ud;
1250
1251         return strcmp (rf->rf_group, (const char *)group);
1252 } /* }}} int compare_read_func_group */
1253
1254 int plugin_unregister_read_group (const char *group) /* {{{ */
1255 {
1256         llentry_t *le;
1257         read_func_t *rf;
1258
1259         int found = 0;
1260
1261         if (group == NULL)
1262                 return (-ENOENT);
1263
1264         pthread_mutex_lock (&read_lock);
1265
1266         if (read_list == NULL)
1267         {
1268                 pthread_mutex_unlock (&read_lock);
1269                 return (-ENOENT);
1270         }
1271
1272         while (42)
1273         {
1274                 le = llist_search_custom (read_list,
1275                                 compare_read_func_group, (void *)group);
1276
1277                 if (le == NULL)
1278                         break;
1279
1280                 ++found;
1281
1282                 llist_remove (read_list, le);
1283
1284                 rf = le->value;
1285                 assert (rf != NULL);
1286                 rf->rf_type = RF_REMOVE;
1287
1288                 llentry_destroy (le);
1289
1290                 DEBUG ("plugin_unregister_read_group: "
1291                                 "Marked `%s' (group `%s') for removal.",
1292                                 rf->rf_name, group);
1293         }
1294
1295         pthread_mutex_unlock (&read_lock);
1296
1297         if (found == 0)
1298         {
1299                 WARNING ("plugin_unregister_read_group: No such "
1300                                 "group of read function: %s", group);
1301                 return (-ENOENT);
1302         }
1303
1304         return (0);
1305 } /* }}} int plugin_unregister_read_group */
1306
1307 int plugin_unregister_write (const char *name)
1308 {
1309         return (plugin_unregister (list_write, name));
1310 }
1311
1312 int plugin_unregister_flush (const char *name)
1313 {
1314         return (plugin_unregister (list_flush, name));
1315 }
1316
1317 int plugin_unregister_missing (const char *name)
1318 {
1319         return (plugin_unregister (list_missing, name));
1320 }
1321
1322 int plugin_unregister_shutdown (const char *name)
1323 {
1324         return (plugin_unregister (list_shutdown, name));
1325 }
1326
1327 int plugin_unregister_data_set (const char *name)
1328 {
1329         data_set_t *ds;
1330
1331         if (data_sets == NULL)
1332                 return (-1);
1333
1334         if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1335                 return (-1);
1336
1337         sfree (ds->ds);
1338         sfree (ds);
1339
1340         return (0);
1341 } /* int plugin_unregister_data_set */
1342
1343 int plugin_unregister_log (const char *name)
1344 {
1345         return (plugin_unregister (list_log, name));
1346 }
1347
1348 int plugin_unregister_notification (const char *name)
1349 {
1350         return (plugin_unregister (list_notification, name));
1351 }
1352
1353 void plugin_init_all (void)
1354 {
1355         const char *chain_name;
1356         llentry_t *le;
1357         int status;
1358
1359         /* Init the value cache */
1360         uc_init ();
1361
1362         chain_name = global_option_get ("PreCacheChain");
1363         pre_cache_chain = fc_chain_get_by_name (chain_name);
1364
1365         chain_name = global_option_get ("PostCacheChain");
1366         post_cache_chain = fc_chain_get_by_name (chain_name);
1367
1368         {
1369                 char const *tmp = global_option_get ("WriteThreads");
1370                 int num = atoi (tmp);
1371
1372                 if (num < 1)
1373                         num = 5;
1374
1375                 start_write_threads ((size_t) num);
1376         }
1377
1378         if ((list_init == NULL) && (read_heap == NULL))
1379                 return;
1380
1381         /* Calling all init callbacks before checking if read callbacks
1382          * are available allows the init callbacks to register the read
1383          * callback. */
1384         le = llist_head (list_init);
1385         while (le != NULL)
1386         {
1387                 callback_func_t *cf;
1388                 plugin_init_cb callback;
1389                 plugin_ctx_t old_ctx;
1390
1391                 cf = le->value;
1392                 old_ctx = plugin_set_ctx (cf->cf_ctx);
1393                 callback = cf->cf_callback;
1394                 status = (*callback) ();
1395                 plugin_set_ctx (old_ctx);
1396
1397                 if (status != 0)
1398                 {
1399                         ERROR ("Initialization of plugin `%s' "
1400                                         "failed with status %i. "
1401                                         "Plugin will be unloaded.",
1402                                         le->key, status);
1403                         /* Plugins that register read callbacks from the init
1404                          * callback should take care of appropriate error
1405                          * handling themselves. */
1406                         /* FIXME: Unload _all_ functions */
1407                         plugin_unregister_read (le->key);
1408                 }
1409
1410                 le = le->next;
1411         }
1412
1413         /* Start read-threads */
1414         if (read_heap != NULL)
1415         {
1416                 const char *rt;
1417                 int num;
1418                 rt = global_option_get ("ReadThreads");
1419                 num = atoi (rt);
1420                 if (num != -1)
1421                         start_read_threads ((num > 0) ? num : 5);
1422         }
1423 } /* void plugin_init_all */
1424
1425 /* TODO: Rename this function. */
1426 void plugin_read_all (void)
1427 {
1428         uc_check_timeout ();
1429
1430         return;
1431 } /* void plugin_read_all */
1432
1433 /* Read function called when the `-T' command line argument is given. */
1434 int plugin_read_all_once (void)
1435 {
1436         int status;
1437         int return_status = 0;
1438
1439         if (read_heap == NULL)
1440         {
1441                 NOTICE ("No read-functions are registered.");
1442                 return (0);
1443         }
1444
1445         while (42)
1446         {
1447                 read_func_t *rf;
1448                 plugin_ctx_t old_ctx;
1449
1450                 rf = c_heap_get_root (read_heap);
1451                 if (rf == NULL)
1452                         break;
1453
1454                 old_ctx = plugin_set_ctx (rf->rf_ctx);
1455
1456                 if (rf->rf_type == RF_SIMPLE)
1457                 {
1458                         int (*callback) (void);
1459
1460                         callback = rf->rf_callback;
1461                         status = (*callback) ();
1462                 }
1463                 else
1464                 {
1465                         plugin_read_cb callback;
1466
1467                         callback = rf->rf_callback;
1468                         status = (*callback) (&rf->rf_udata);
1469                 }
1470
1471                 plugin_set_ctx (old_ctx);
1472
1473                 if (status != 0)
1474                 {
1475                         NOTICE ("read-function of plugin `%s' failed.",
1476                                         rf->rf_name);
1477                         return_status = -1;
1478                 }
1479
1480                 destroy_callback ((void *) rf);
1481         }
1482
1483         return (return_status);
1484 } /* int plugin_read_all_once */
1485
1486 int plugin_write (const char *plugin, /* {{{ */
1487                 const data_set_t *ds, const value_list_t *vl)
1488 {
1489   llentry_t *le;
1490   int status;
1491
1492   if (vl == NULL)
1493     return (EINVAL);
1494
1495   if (list_write == NULL)
1496     return (ENOENT);
1497
1498   if (ds == NULL)
1499   {
1500     ds = plugin_get_ds (vl->type);
1501     if (ds == NULL)
1502     {
1503       ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1504       return (ENOENT);
1505     }
1506   }
1507
1508   if (plugin == NULL)
1509   {
1510     int success = 0;
1511     int failure = 0;
1512
1513     le = llist_head (list_write);
1514     while (le != NULL)
1515     {
1516       callback_func_t *cf = le->value;
1517       plugin_write_cb callback;
1518
1519       /* do not switch plugin context; rather keep the context (interval)
1520        * information of the calling read plugin */
1521
1522       DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1523       callback = cf->cf_callback;
1524       status = (*callback) (ds, vl, &cf->cf_udata);
1525       if (status != 0)
1526         failure++;
1527       else
1528         success++;
1529
1530       le = le->next;
1531     }
1532
1533     if ((success == 0) && (failure != 0))
1534       status = -1;
1535     else
1536       status = 0;
1537   }
1538   else /* plugin != NULL */
1539   {
1540     callback_func_t *cf;
1541     plugin_write_cb callback;
1542
1543     le = llist_head (list_write);
1544     while (le != NULL)
1545     {
1546       if (strcasecmp (plugin, le->key) == 0)
1547         break;
1548
1549       le = le->next;
1550     }
1551
1552     if (le == NULL)
1553       return (ENOENT);
1554
1555     cf = le->value;
1556
1557     /* do not switch plugin context; rather keep the context (interval)
1558      * information of the calling read plugin */
1559
1560     DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1561     callback = cf->cf_callback;
1562     status = (*callback) (ds, vl, &cf->cf_udata);
1563   }
1564
1565   return (status);
1566 } /* }}} int plugin_write */
1567
1568 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1569 {
1570   llentry_t *le;
1571
1572   if (list_flush == NULL)
1573     return (0);
1574
1575   le = llist_head (list_flush);
1576   while (le != NULL)
1577   {
1578     callback_func_t *cf;
1579     plugin_flush_cb callback;
1580     plugin_ctx_t old_ctx;
1581
1582     if ((plugin != NULL)
1583         && (strcmp (plugin, le->key) != 0))
1584     {
1585       le = le->next;
1586       continue;
1587     }
1588
1589     cf = le->value;
1590     old_ctx = plugin_set_ctx (cf->cf_ctx);
1591     callback = cf->cf_callback;
1592
1593     (*callback) (timeout, identifier, &cf->cf_udata);
1594
1595     plugin_set_ctx (old_ctx);
1596
1597     le = le->next;
1598   }
1599   return (0);
1600 } /* int plugin_flush */
1601
1602 void plugin_shutdown_all (void)
1603 {
1604         llentry_t *le;
1605
1606         stop_read_threads ();
1607
1608         destroy_all_callbacks (&list_init);
1609
1610         pthread_mutex_lock (&read_lock);
1611         llist_destroy (read_list);
1612         read_list = NULL;
1613         pthread_mutex_unlock (&read_lock);
1614
1615         destroy_read_heap ();
1616
1617         plugin_flush (/* plugin = */ NULL,
1618                         /* timeout = */ 0,
1619                         /* identifier = */ NULL);
1620
1621         le = NULL;
1622         if (list_shutdown != NULL)
1623                 le = llist_head (list_shutdown);
1624
1625         while (le != NULL)
1626         {
1627                 callback_func_t *cf;
1628                 plugin_shutdown_cb callback;
1629                 plugin_ctx_t old_ctx;
1630
1631                 cf = le->value;
1632                 old_ctx = plugin_set_ctx (cf->cf_ctx);
1633                 callback = cf->cf_callback;
1634
1635                 /* Advance the pointer before calling the callback allows
1636                  * shutdown functions to unregister themselves. If done the
1637                  * other way around the memory `le' points to will be freed
1638                  * after callback returns. */
1639                 le = le->next;
1640
1641                 (*callback) ();
1642
1643                 plugin_set_ctx (old_ctx);
1644         }
1645
1646         stop_write_threads ();
1647
1648         /* Write plugins which use the `user_data' pointer usually need the
1649          * same data available to the flush callback. If this is the case, set
1650          * the free_function to NULL when registering the flush callback and to
1651          * the real free function when registering the write callback. This way
1652          * the data isn't freed twice. */
1653         destroy_all_callbacks (&list_flush);
1654         destroy_all_callbacks (&list_missing);
1655         destroy_all_callbacks (&list_write);
1656
1657         destroy_all_callbacks (&list_notification);
1658         destroy_all_callbacks (&list_shutdown);
1659         destroy_all_callbacks (&list_log);
1660 } /* void plugin_shutdown_all */
1661
1662 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1663 {
1664   llentry_t *le;
1665
1666   if (list_missing == NULL)
1667     return (0);
1668
1669   le = llist_head (list_missing);
1670   while (le != NULL)
1671   {
1672     callback_func_t *cf;
1673     plugin_missing_cb callback;
1674     plugin_ctx_t old_ctx;
1675     int status;
1676
1677     cf = le->value;
1678     old_ctx = plugin_set_ctx (cf->cf_ctx);
1679     callback = cf->cf_callback;
1680
1681     status = (*callback) (vl, &cf->cf_udata);
1682     plugin_set_ctx (old_ctx);
1683     if (status != 0)
1684     {
1685       if (status < 0)
1686       {
1687         ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1688             "failed with status %i.",
1689             le->key, status);
1690         return (status);
1691       }
1692       else
1693       {
1694         return (0);
1695       }
1696     }
1697
1698     le = le->next;
1699   }
1700   return (0);
1701 } /* int }}} plugin_dispatch_missing */
1702
1703 static int plugin_dispatch_values_internal (value_list_t *vl)
1704 {
1705         int status;
1706         static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1707
1708         value_t *saved_values;
1709         int      saved_values_len;
1710
1711         data_set_t *ds;
1712
1713         int free_meta_data = 0;
1714
1715         if ((vl == NULL) || (vl->type[0] == 0)
1716                         || (vl->values == NULL) || (vl->values_len < 1))
1717         {
1718                 ERROR ("plugin_dispatch_values: Invalid value list "
1719                                 "from plugin %s.", vl->plugin);
1720                 return (-1);
1721         }
1722
1723         /* Free meta data only if the calling function didn't specify any. In
1724          * this case matches and targets may add some and the calling function
1725          * may not expect (and therefore free) that data. */
1726         if (vl->meta == NULL)
1727                 free_meta_data = 1;
1728
1729         if (list_write == NULL)
1730                 c_complain_once (LOG_WARNING, &no_write_complaint,
1731                                 "plugin_dispatch_values: No write callback has been "
1732                                 "registered. Please load at least one output plugin, "
1733                                 "if you want the collected data to be stored.");
1734
1735         if (data_sets == NULL)
1736         {
1737                 ERROR ("plugin_dispatch_values: No data sets registered. "
1738                                 "Could the types database be read? Check "
1739                                 "your `TypesDB' setting!");
1740                 return (-1);
1741         }
1742
1743         if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1744         {
1745                 char ident[6 * DATA_MAX_NAME_LEN];
1746
1747                 FORMAT_VL (ident, sizeof (ident), vl);
1748                 INFO ("plugin_dispatch_values: Dataset not found: %s "
1749                                 "(from \"%s\"), check your types.db!",
1750                                 vl->type, ident);
1751                 return (-1);
1752         }
1753
1754         /* Assured by plugin_value_list_clone(). The time is determined at
1755          * _enqueue_ time. */
1756         assert (vl->time != 0);
1757         assert (vl->interval != 0);
1758
1759         DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1760                         "host = %s; "
1761                         "plugin = %s; plugin_instance = %s; "
1762                         "type = %s; type_instance = %s;",
1763                         CDTIME_T_TO_DOUBLE (vl->time),
1764                         CDTIME_T_TO_DOUBLE (vl->interval),
1765                         vl->host,
1766                         vl->plugin, vl->plugin_instance,
1767                         vl->type, vl->type_instance);
1768
1769 #if COLLECT_DEBUG
1770         assert (0 == strcmp (ds->type, vl->type));
1771 #else
1772         if (0 != strcmp (ds->type, vl->type))
1773                 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1774                                 ds->type, vl->type);
1775 #endif
1776
1777 #if COLLECT_DEBUG
1778         assert (ds->ds_num == vl->values_len);
1779 #else
1780         if (ds->ds_num != vl->values_len)
1781         {
1782                 ERROR ("plugin_dispatch_values: ds->type = %s: "
1783                                 "(ds->ds_num = %i) != "
1784                                 "(vl->values_len = %i)",
1785                                 ds->type, ds->ds_num, vl->values_len);
1786                 return (-1);
1787         }
1788 #endif
1789
1790         escape_slashes (vl->host, sizeof (vl->host));
1791         escape_slashes (vl->plugin, sizeof (vl->plugin));
1792         escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1793         escape_slashes (vl->type, sizeof (vl->type));
1794         escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1795
1796         /* Copy the values. This way, we can assure `targets' that they get
1797          * dynamically allocated values, which they can free and replace if
1798          * they like. */
1799         if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1800         {
1801                 saved_values     = vl->values;
1802                 saved_values_len = vl->values_len;
1803
1804                 vl->values = (value_t *) calloc (vl->values_len,
1805                                 sizeof (*vl->values));
1806                 if (vl->values == NULL)
1807                 {
1808                         ERROR ("plugin_dispatch_values: calloc failed.");
1809                         vl->values = saved_values;
1810                         return (-1);
1811                 }
1812                 memcpy (vl->values, saved_values,
1813                                 vl->values_len * sizeof (*vl->values));
1814         }
1815         else /* if ((pre == NULL) && (post == NULL)) */
1816         {
1817                 saved_values     = NULL;
1818                 saved_values_len = 0;
1819         }
1820
1821         if (pre_cache_chain != NULL)
1822         {
1823                 status = fc_process_chain (ds, vl, pre_cache_chain);
1824                 if (status < 0)
1825                 {
1826                         WARNING ("plugin_dispatch_values: Running the "
1827                                         "pre-cache chain failed with "
1828                                         "status %i (%#x).",
1829                                         status, status);
1830                 }
1831                 else if (status == FC_TARGET_STOP)
1832                 {
1833                         /* Restore the state of the value_list so that plugins
1834                          * don't get confused.. */
1835                         if (saved_values != NULL)
1836                         {
1837                                 free (vl->values);
1838                                 vl->values     = saved_values;
1839                                 vl->values_len = saved_values_len;
1840                         }
1841                         return (0);
1842                 }
1843         }
1844
1845         /* Update the value cache */
1846         uc_update (ds, vl);
1847
1848         if (post_cache_chain != NULL)
1849         {
1850                 status = fc_process_chain (ds, vl, post_cache_chain);
1851                 if (status < 0)
1852                 {
1853                         WARNING ("plugin_dispatch_values: Running the "
1854                                         "post-cache chain failed with "
1855                                         "status %i (%#x).",
1856                                         status, status);
1857                 }
1858         }
1859         else
1860                 fc_default_action (ds, vl);
1861
1862         /* Restore the state of the value_list so that plugins don't get
1863          * confused.. */
1864         if (saved_values != NULL)
1865         {
1866                 free (vl->values);
1867                 vl->values     = saved_values;
1868                 vl->values_len = saved_values_len;
1869         }
1870
1871         if ((free_meta_data != 0) && (vl->meta != NULL))
1872         {
1873                 meta_data_destroy (vl->meta);
1874                 vl->meta = NULL;
1875         }
1876
1877         return (0);
1878 } /* int plugin_dispatch_values_internal */
1879
1880 int plugin_dispatch_values (value_list_t const *vl)
1881 {
1882         int status;
1883
1884         status = plugin_write_enqueue (vl);
1885         if (status != 0)
1886         {
1887                 char errbuf[1024];
1888                 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
1889                                 "with status %i (%s).", status,
1890                                 sstrerror (status, errbuf, sizeof (errbuf)));
1891                 return (status);
1892         }
1893
1894         return (0);
1895 }
1896
1897 int plugin_dispatch_notification (const notification_t *notif)
1898 {
1899         llentry_t *le;
1900         /* Possible TODO: Add flap detection here */
1901
1902         DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1903                         "time = %.3f; host = %s;",
1904                         notif->severity, notif->message,
1905                         CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1906
1907         /* Nobody cares for notifications */
1908         if (list_notification == NULL)
1909                 return (-1);
1910
1911         le = llist_head (list_notification);
1912         while (le != NULL)
1913         {
1914                 callback_func_t *cf;
1915                 plugin_notification_cb callback;
1916                 int status;
1917
1918                 /* do not switch plugin context; rather keep the context
1919                  * (interval) information of the calling plugin */
1920
1921                 cf = le->value;
1922                 callback = cf->cf_callback;
1923                 status = (*callback) (notif, &cf->cf_udata);
1924                 if (status != 0)
1925                 {
1926                         WARNING ("plugin_dispatch_notification: Notification "
1927                                         "callback %s returned %i.",
1928                                         le->key, status);
1929                 }
1930
1931                 le = le->next;
1932         }
1933
1934         return (0);
1935 } /* int plugin_dispatch_notification */
1936
1937 void plugin_log (int level, const char *format, ...)
1938 {
1939         char msg[1024];
1940         va_list ap;
1941         llentry_t *le;
1942
1943 #if !COLLECT_DEBUG
1944         if (level >= LOG_DEBUG)
1945                 return;
1946 #endif
1947
1948         va_start (ap, format);
1949         vsnprintf (msg, sizeof (msg), format, ap);
1950         msg[sizeof (msg) - 1] = '\0';
1951         va_end (ap);
1952
1953         if (list_log == NULL)
1954         {
1955                 fprintf (stderr, "%s\n", msg);
1956                 return;
1957         }
1958
1959         le = llist_head (list_log);
1960         while (le != NULL)
1961         {
1962                 callback_func_t *cf;
1963                 plugin_log_cb callback;
1964
1965                 cf = le->value;
1966                 callback = cf->cf_callback;
1967
1968                 /* do not switch plugin context; rather keep the context
1969                  * (interval) information of the calling plugin */
1970
1971                 (*callback) (level, msg, &cf->cf_udata);
1972
1973                 le = le->next;
1974         }
1975 } /* void plugin_log */
1976
1977 int parse_log_severity (const char *severity)
1978 {
1979         int log_level = -1;
1980
1981         if ((0 == strcasecmp (severity, "emerg"))
1982                         || (0 == strcasecmp (severity, "alert"))
1983                         || (0 == strcasecmp (severity, "crit"))
1984                         || (0 == strcasecmp (severity, "err")))
1985                 log_level = LOG_ERR;
1986         else if (0 == strcasecmp (severity, "warning"))
1987                 log_level = LOG_WARNING;
1988         else if (0 == strcasecmp (severity, "notice"))
1989                 log_level = LOG_NOTICE;
1990         else if (0 == strcasecmp (severity, "info"))
1991                 log_level = LOG_INFO;
1992 #if COLLECT_DEBUG
1993         else if (0 == strcasecmp (severity, "debug"))
1994                 log_level = LOG_DEBUG;
1995 #endif /* COLLECT_DEBUG */
1996
1997         return (log_level);
1998 } /* int parse_log_severity */
1999
2000 int parse_notif_severity (const char *severity)
2001 {
2002         int notif_severity = -1;
2003
2004         if (strcasecmp (severity, "FAILURE") == 0)
2005                 notif_severity = NOTIF_FAILURE;
2006         else if (strcmp (severity, "OKAY") == 0)
2007                 notif_severity = NOTIF_OKAY;
2008         else if ((strcmp (severity, "WARNING") == 0)
2009                         || (strcmp (severity, "WARN") == 0))
2010                 notif_severity = NOTIF_WARNING;
2011
2012         return (notif_severity);
2013 } /* int parse_notif_severity */
2014
2015 const data_set_t *plugin_get_ds (const char *name)
2016 {
2017         data_set_t *ds;
2018
2019         if (data_sets == NULL)
2020         {
2021                 ERROR ("plugin_get_ds: No data sets are defined yet.");
2022                 return (NULL);
2023         }
2024
2025         if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2026         {
2027                 DEBUG ("No such dataset registered: %s", name);
2028                 return (NULL);
2029         }
2030
2031         return (ds);
2032 } /* data_set_t *plugin_get_ds */
2033
2034 static int plugin_notification_meta_add (notification_t *n,
2035     const char *name,
2036     enum notification_meta_type_e type,
2037     const void *value)
2038 {
2039   notification_meta_t *meta;
2040   notification_meta_t *tail;
2041
2042   if ((n == NULL) || (name == NULL) || (value == NULL))
2043   {
2044     ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2045     return (-1);
2046   }
2047
2048   meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2049   if (meta == NULL)
2050   {
2051     ERROR ("plugin_notification_meta_add: malloc failed.");
2052     return (-1);
2053   }
2054   memset (meta, 0, sizeof (notification_meta_t));
2055
2056   sstrncpy (meta->name, name, sizeof (meta->name));
2057   meta->type = type;
2058
2059   switch (type)
2060   {
2061     case NM_TYPE_STRING:
2062     {
2063       meta->nm_value.nm_string = strdup ((const char *) value);
2064       if (meta->nm_value.nm_string == NULL)
2065       {
2066         ERROR ("plugin_notification_meta_add: strdup failed.");
2067         sfree (meta);
2068         return (-1);
2069       }
2070       break;
2071     }
2072     case NM_TYPE_SIGNED_INT:
2073     {
2074       meta->nm_value.nm_signed_int = *((int64_t *) value);
2075       break;
2076     }
2077     case NM_TYPE_UNSIGNED_INT:
2078     {
2079       meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2080       break;
2081     }
2082     case NM_TYPE_DOUBLE:
2083     {
2084       meta->nm_value.nm_double = *((double *) value);
2085       break;
2086     }
2087     case NM_TYPE_BOOLEAN:
2088     {
2089       meta->nm_value.nm_boolean = *((_Bool *) value);
2090       break;
2091     }
2092     default:
2093     {
2094       ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2095       sfree (meta);
2096       return (-1);
2097     }
2098   } /* switch (type) */
2099
2100   meta->next = NULL;
2101   tail = n->meta;
2102   while ((tail != NULL) && (tail->next != NULL))
2103     tail = tail->next;
2104
2105   if (tail == NULL)
2106     n->meta = meta;
2107   else
2108     tail->next = meta;
2109
2110   return (0);
2111 } /* int plugin_notification_meta_add */
2112
2113 int plugin_notification_meta_add_string (notification_t *n,
2114     const char *name,
2115     const char *value)
2116 {
2117   return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2118 }
2119
2120 int plugin_notification_meta_add_signed_int (notification_t *n,
2121     const char *name,
2122     int64_t value)
2123 {
2124   return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2125 }
2126
2127 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2128     const char *name,
2129     uint64_t value)
2130 {
2131   return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2132 }
2133
2134 int plugin_notification_meta_add_double (notification_t *n,
2135     const char *name,
2136     double value)
2137 {
2138   return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2139 }
2140
2141 int plugin_notification_meta_add_boolean (notification_t *n,
2142     const char *name,
2143     _Bool value)
2144 {
2145   return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2146 }
2147
2148 int plugin_notification_meta_copy (notification_t *dst,
2149     const notification_t *src)
2150 {
2151   notification_meta_t *meta;
2152
2153   assert (dst != NULL);
2154   assert (src != NULL);
2155   assert (dst != src);
2156   assert ((src->meta == NULL) || (src->meta != dst->meta));
2157
2158   for (meta = src->meta; meta != NULL; meta = meta->next)
2159   {
2160     if (meta->type == NM_TYPE_STRING)
2161       plugin_notification_meta_add_string (dst, meta->name,
2162           meta->nm_value.nm_string);
2163     else if (meta->type == NM_TYPE_SIGNED_INT)
2164       plugin_notification_meta_add_signed_int (dst, meta->name,
2165           meta->nm_value.nm_signed_int);
2166     else if (meta->type == NM_TYPE_UNSIGNED_INT)
2167       plugin_notification_meta_add_unsigned_int (dst, meta->name,
2168           meta->nm_value.nm_unsigned_int);
2169     else if (meta->type == NM_TYPE_DOUBLE)
2170       plugin_notification_meta_add_double (dst, meta->name,
2171           meta->nm_value.nm_double);
2172     else if (meta->type == NM_TYPE_BOOLEAN)
2173       plugin_notification_meta_add_boolean (dst, meta->name,
2174           meta->nm_value.nm_boolean);
2175   }
2176
2177   return (0);
2178 } /* int plugin_notification_meta_copy */
2179
2180 int plugin_notification_meta_free (notification_meta_t *n)
2181 {
2182   notification_meta_t *this;
2183   notification_meta_t *next;
2184
2185   if (n == NULL)
2186   {
2187     ERROR ("plugin_notification_meta_free: n == NULL!");
2188     return (-1);
2189   }
2190
2191   this = n;
2192   while (this != NULL)
2193   {
2194     next = this->next;
2195
2196     if (this->type == NM_TYPE_STRING)
2197     {
2198       free ((char *)this->nm_value.nm_string);
2199       this->nm_value.nm_string = NULL;
2200     }
2201     sfree (this);
2202
2203     this = next;
2204   }
2205
2206   return (0);
2207 } /* int plugin_notification_meta_free */
2208
2209 static void plugin_ctx_destructor (void *ctx)
2210 {
2211         sfree (ctx);
2212 } /* void plugin_ctx_destructor */
2213
2214 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2215
2216 static plugin_ctx_t *plugin_ctx_create (void)
2217 {
2218         plugin_ctx_t *ctx;
2219
2220         ctx = malloc (sizeof (*ctx));
2221         if (ctx == NULL) {
2222                 char errbuf[1024];
2223                 ERROR ("Failed to allocate plugin context: %s",
2224                                 sstrerror (errno, errbuf, sizeof (errbuf)));
2225                 return NULL;
2226         }
2227
2228         *ctx = ctx_init;
2229         assert (plugin_ctx_key_initialized);
2230         pthread_setspecific (plugin_ctx_key, ctx);
2231         DEBUG("Created new plugin context.");
2232         return (ctx);
2233 } /* int plugin_ctx_create */
2234
2235 void plugin_init_ctx (void)
2236 {
2237         pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2238         plugin_ctx_key_initialized = 1;
2239 } /* void plugin_init_ctx */
2240
2241 plugin_ctx_t plugin_get_ctx (void)
2242 {
2243         plugin_ctx_t *ctx;
2244
2245         assert (plugin_ctx_key_initialized);
2246         ctx = pthread_getspecific (plugin_ctx_key);
2247
2248         if (ctx == NULL) {
2249                 ctx = plugin_ctx_create ();
2250                 /* this must no happen -- exit() instead? */
2251                 if (ctx == NULL)
2252                         return ctx_init;
2253         }
2254
2255         return (*ctx);
2256 } /* plugin_ctx_t plugin_get_ctx */
2257
2258 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2259 {
2260         plugin_ctx_t *c;
2261         plugin_ctx_t old;
2262
2263         assert (plugin_ctx_key_initialized);
2264         c = pthread_getspecific (plugin_ctx_key);
2265
2266         if (c == NULL) {
2267                 c = plugin_ctx_create ();
2268                 /* this must no happen -- exit() instead? */
2269                 if (c == NULL)
2270                         return ctx_init;
2271         }
2272
2273         old = *c;
2274         *c = ctx;
2275
2276         return (old);
2277 } /* void plugin_set_ctx */
2278
2279 cdtime_t plugin_get_interval (void)
2280 {
2281         cdtime_t interval;
2282
2283         interval = plugin_get_ctx().interval;
2284         if (interval > 0)
2285                 return interval;
2286
2287         return cf_get_default_interval ();
2288 } /* cdtime_t plugin_get_interval */
2289
2290 typedef struct {
2291         plugin_ctx_t ctx;
2292         void *(*start_routine) (void *);
2293         void *arg;
2294 } plugin_thread_t;
2295
2296 static void *plugin_thread_start (void *arg)
2297 {
2298         plugin_thread_t *plugin_thread = arg;
2299
2300         void *(*start_routine) (void *) = plugin_thread->start_routine;
2301         void *plugin_arg = plugin_thread->arg;
2302
2303         plugin_set_ctx (plugin_thread->ctx);
2304
2305         free (plugin_thread);
2306
2307         return start_routine (plugin_arg);
2308 } /* void *plugin_thread_start */
2309
2310 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2311                 void *(*start_routine) (void *), void *arg)
2312 {
2313         plugin_thread_t *plugin_thread;
2314
2315         plugin_thread = malloc (sizeof (*plugin_thread));
2316         if (plugin_thread == NULL)
2317                 return -1;
2318
2319         plugin_thread->ctx           = plugin_get_ctx ();
2320         plugin_thread->start_routine = start_routine;
2321         plugin_thread->arg           = arg;
2322
2323         return pthread_create (thread, attr,
2324                         plugin_thread_start, plugin_thread);
2325 } /* int plugin_thread_create */
2326
2327 /* vim: set sw=8 ts=8 noet fdm=marker : */