Code

cb1005e8dffaa0537737183d338fc7278040fd3e
[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  **/
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 #include "utils_random.h"
36 #if HAVE_PTHREAD_H
37 # include <pthread.h>
38 #endif
40 #include <ltdl.h>
42 /*
43  * Private structures
44  */
45 struct callback_func_s
46 {
47         void *cf_callback;
48         user_data_t cf_udata;
49         plugin_ctx_t cf_ctx;
50 };
51 typedef struct callback_func_s callback_func_t;
53 #define RF_SIMPLE  0
54 #define RF_COMPLEX 1
55 #define RF_REMOVE  65535
56 struct read_func_s
57 {
58         /* `read_func_t' "inherits" from `callback_func_t'.
59          * The `rf_super' member MUST be the first one in this structure! */
60 #define rf_callback rf_super.cf_callback
61 #define rf_udata rf_super.cf_udata
62 #define rf_ctx rf_super.cf_ctx
63         callback_func_t rf_super;
64         char rf_group[DATA_MAX_NAME_LEN];
65         char *rf_name;
66         int rf_type;
67         cdtime_t rf_interval;
68         cdtime_t rf_effective_interval;
69         cdtime_t rf_next_read;
70 };
71 typedef struct read_func_s read_func_t;
73 struct write_queue_s;
74 typedef struct write_queue_s write_queue_t;
75 struct write_queue_s
76 {
77         value_list_t *vl;
78         plugin_ctx_t ctx;
79         write_queue_t *next;
80 };
82 /*
83  * Private variables
84  */
85 static c_avl_tree_t *plugins_loaded = NULL;
87 static llist_t *list_init;
88 static llist_t *list_write;
89 static llist_t *list_flush;
90 static llist_t *list_missing;
91 static llist_t *list_shutdown;
92 static llist_t *list_log;
93 static llist_t *list_notification;
95 static fc_chain_t *pre_cache_chain = NULL;
96 static fc_chain_t *post_cache_chain = NULL;
98 static c_avl_tree_t *data_sets;
100 static char *plugindir = NULL;
102 static c_heap_t       *read_heap = NULL;
103 static llist_t        *read_list;
104 static int             read_loop = 1;
105 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
106 static pthread_cond_t  read_cond = PTHREAD_COND_INITIALIZER;
107 static pthread_t      *read_threads = NULL;
108 static int             read_threads_num = 0;
110 static write_queue_t  *write_queue_head;
111 static write_queue_t  *write_queue_tail;
112 static long            write_queue_length = 0;
113 static _Bool           write_loop = 1;
114 static pthread_mutex_t write_lock = PTHREAD_MUTEX_INITIALIZER;
115 static pthread_cond_t  write_cond = PTHREAD_COND_INITIALIZER;
116 static pthread_t      *write_threads = NULL;
117 static size_t          write_threads_num = 0;
119 static pthread_key_t   plugin_ctx_key;
120 static _Bool           plugin_ctx_key_initialized = 0;
122 static long            write_limit_high = 0;
123 static long            write_limit_low = 0;
125 /*
126  * Static functions
127  */
128 static int plugin_dispatch_values_internal (value_list_t *vl);
130 static const char *plugin_get_dir (void)
132         if (plugindir == NULL)
133                 return (PLUGINDIR);
134         else
135                 return (plugindir);
138 static void destroy_callback (callback_func_t *cf) /* {{{ */
140         if (cf == NULL)
141                 return;
143         if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
144         {
145                 cf->cf_udata.free_func (cf->cf_udata.data);
146                 cf->cf_udata.data = NULL;
147                 cf->cf_udata.free_func = NULL;
148         }
149         sfree (cf);
150 } /* }}} void destroy_callback */
152 static void destroy_all_callbacks (llist_t **list) /* {{{ */
154         llentry_t *le;
156         if (*list == NULL)
157                 return;
159         le = llist_head (*list);
160         while (le != NULL)
161         {
162                 llentry_t *le_next;
164                 le_next = le->next;
166                 sfree (le->key);
167                 destroy_callback (le->value);
168                 le->value = NULL;
170                 le = le_next;
171         }
173         llist_destroy (*list);
174         *list = NULL;
175 } /* }}} void destroy_all_callbacks */
177 static void destroy_read_heap (void) /* {{{ */
179         if (read_heap == NULL)
180                 return;
182         while (42)
183         {
184                 callback_func_t *cf;
186                 cf = c_heap_get_root (read_heap);
187                 if (cf == NULL)
188                         break;
190                 destroy_callback (cf);
191         }
193         c_heap_destroy (read_heap);
194         read_heap = NULL;
195 } /* }}} void destroy_read_heap */
197 static int register_callback (llist_t **list, /* {{{ */
198                 const char *name, callback_func_t *cf)
200         llentry_t *le;
201         char *key;
203         if (*list == NULL)
204         {
205                 *list = llist_create ();
206                 if (*list == NULL)
207                 {
208                         ERROR ("plugin: register_callback: "
209                                         "llist_create failed.");
210                         destroy_callback (cf);
211                         return (-1);
212                 }
213         }
215         key = strdup (name);
216         if (key == NULL)
217         {
218                 ERROR ("plugin: register_callback: strdup failed.");
219                 destroy_callback (cf);
220                 return (-1);
221         }
223         le = llist_search (*list, name);
224         if (le == NULL)
225         {
226                 le = llentry_create (key, cf);
227                 if (le == NULL)
228                 {
229                         ERROR ("plugin: register_callback: "
230                                         "llentry_create failed.");
231                         free (key);
232                         destroy_callback (cf);
233                         return (-1);
234                 }
236                 llist_append (*list, le);
237         }
238         else
239         {
240                 callback_func_t *old_cf;
242                 old_cf = le->value;
243                 le->value = cf;
245                 WARNING ("plugin: register_callback: "
246                                 "a callback named `%s' already exists - "
247                                 "overwriting the old entry!", name);
249                 destroy_callback (old_cf);
250                 sfree (key);
251         }
253         return (0);
254 } /* }}} int register_callback */
256 static int create_register_callback (llist_t **list, /* {{{ */
257                 const char *name, void *callback, user_data_t *ud)
259         callback_func_t *cf;
261         cf = (callback_func_t *) malloc (sizeof (*cf));
262         if (cf == NULL)
263         {
264                 ERROR ("plugin: create_register_callback: malloc failed.");
265                 return (-1);
266         }
267         memset (cf, 0, sizeof (*cf));
269         cf->cf_callback = callback;
270         if (ud == NULL)
271         {
272                 cf->cf_udata.data = NULL;
273                 cf->cf_udata.free_func = NULL;
274         }
275         else
276         {
277                 cf->cf_udata = *ud;
278         }
280         cf->cf_ctx = plugin_get_ctx ();
282         return (register_callback (list, name, cf));
283 } /* }}} int create_register_callback */
285 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
287         llentry_t *e;
289         if (list == NULL)
290                 return (-1);
292         e = llist_search (list, name);
293         if (e == NULL)
294                 return (-1);
296         llist_remove (list, e);
298         sfree (e->key);
299         destroy_callback (e->value);
301         llentry_destroy (e);
303         return (0);
304 } /* }}} int plugin_unregister */
306 /*
307  * (Try to) load the shared object `file'. Won't complain if it isn't a shared
308  * object, but it will bitch about a shared object not having a
309  * ``module_register'' symbol..
310  */
311 static int plugin_load_file (char *file, uint32_t flags)
313         lt_dlhandle dlh;
314         void (*reg_handle) (void);
316         lt_dlinit ();
317         lt_dlerror (); /* clear errors */
319 #if LIBTOOL_VERSION == 2
320         if (flags & PLUGIN_FLAGS_GLOBAL) {
321                 lt_dladvise advise;
322                 lt_dladvise_init(&advise);
323                 lt_dladvise_global(&advise);
324                 dlh = lt_dlopenadvise(file, advise);
325                 lt_dladvise_destroy(&advise);
326         } else {
327                 dlh = lt_dlopen (file);
328         }
329 #else /* if LIBTOOL_VERSION == 1 */
330         if (flags & PLUGIN_FLAGS_GLOBAL)
331                 WARNING ("plugin_load_file: The global flag is not supported, "
332                                 "libtool 2 is required for this.");
333         dlh = lt_dlopen (file);
334 #endif
336         if (dlh == NULL)
337         {
338                 char errbuf[1024] = "";
340                 ssnprintf (errbuf, sizeof (errbuf),
341                                 "lt_dlopen (\"%s\") failed: %s. "
342                                 "The most common cause for this problem is "
343                                 "missing dependencies. Use ldd(1) to check "
344                                 "the dependencies of the plugin "
345                                 "/ shared object.",
346                                 file, lt_dlerror ());
348                 ERROR ("%s", errbuf);
349                 /* Make sure this is printed to STDERR in any case, but also
350                  * make sure it's printed only once. */
351                 if (list_log != NULL)
352                         fprintf (stderr, "ERROR: %s\n", errbuf);
354                 return (1);
355         }
357         if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
358         {
359                 WARNING ("Couldn't find symbol \"module_register\" in \"%s\": %s\n",
360                                 file, lt_dlerror ());
361                 lt_dlclose (dlh);
362                 return (-1);
363         }
365         (*reg_handle) ();
367         return (0);
370 static void *plugin_read_thread (void __attribute__((unused)) *args)
372         while (read_loop != 0)
373         {
374                 read_func_t *rf;
375                 plugin_ctx_t old_ctx;
376                 cdtime_t now;
377                 int status;
378                 int rf_type;
379                 int rc;
381                 /* Get the read function that needs to be read next.
382                  * We don't need to hold "read_lock" for the heap, but we need
383                  * to call c_heap_get_root() and pthread_cond_wait() in the
384                  * same protected block. */
385                 pthread_mutex_lock (&read_lock);
386                 rf = c_heap_get_root (read_heap);
387                 if (rf == NULL)
388                 {
389                         pthread_cond_wait (&read_cond, &read_lock);
390                         pthread_mutex_unlock (&read_lock);
391                         continue;
392                 }
393                 pthread_mutex_unlock (&read_lock);
395                 if (rf->rf_interval == 0)
396                 {
397                         /* this should not happen, because the interval is set
398                          * for each plugin when loading it
399                          * XXX: issue a warning? */
400                         rf->rf_interval = plugin_get_interval ();
401                         rf->rf_effective_interval = rf->rf_interval;
403                         rf->rf_next_read = cdtime ();
404                 }
406                 /* sleep until this entry is due,
407                  * using pthread_cond_timedwait */
408                 pthread_mutex_lock (&read_lock);
409                 /* In pthread_cond_timedwait, spurious wakeups are possible
410                  * (and really happen, at least on NetBSD with > 1 CPU), thus
411                  * we need to re-evaluate the condition every time
412                  * pthread_cond_timedwait returns. */
413                 rc = 0;
414                 while ((read_loop != 0)
415                                 && (cdtime () < rf->rf_next_read)
416                                 && rc == 0)
417                 {
418                         struct timespec ts = { 0 };
420                         CDTIME_T_TO_TIMESPEC (rf->rf_next_read, &ts);
422                         rc = pthread_cond_timedwait (&read_cond, &read_lock,
423                                 &ts);
424                 }
426                 /* Must hold `read_lock' when accessing `rf->rf_type'. */
427                 rf_type = rf->rf_type;
428                 pthread_mutex_unlock (&read_lock);
430                 /* Check if we're supposed to stop.. This may have interrupted
431                  * the sleep, too. */
432                 if (read_loop == 0)
433                 {
434                         /* Insert `rf' again, so it can be free'd correctly */
435                         c_heap_insert (read_heap, rf);
436                         break;
437                 }
439                 /* The entry has been marked for deletion. The linked list
440                  * entry has already been removed by `plugin_unregister_read'.
441                  * All we have to do here is free the `read_func_t' and
442                  * continue. */
443                 if (rf_type == RF_REMOVE)
444                 {
445                         DEBUG ("plugin_read_thread: Destroying the `%s' "
446                                         "callback.", rf->rf_name);
447                         sfree (rf->rf_name);
448                         destroy_callback ((callback_func_t *) rf);
449                         rf = NULL;
450                         continue;
451                 }
453                 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
455                 old_ctx = plugin_set_ctx (rf->rf_ctx);
457                 if (rf_type == RF_SIMPLE)
458                 {
459                         int (*callback) (void);
461                         callback = rf->rf_callback;
462                         status = (*callback) ();
463                 }
464                 else
465                 {
466                         plugin_read_cb callback;
468                         assert (rf_type == RF_COMPLEX);
470                         callback = rf->rf_callback;
471                         status = (*callback) (&rf->rf_udata);
472                 }
474                 plugin_set_ctx (old_ctx);
476                 /* If the function signals failure, we will increase the
477                  * intervals in which it will be called. */
478                 if (status != 0)
479                 {
480                         rf->rf_effective_interval *= 2;
481                         if (rf->rf_effective_interval > TIME_T_TO_CDTIME_T (86400))
482                                 rf->rf_effective_interval = TIME_T_TO_CDTIME_T (86400);
484                         NOTICE ("read-function of plugin `%s' failed. "
485                                         "Will suspend it for %.3f seconds.",
486                                         rf->rf_name,
487                                         CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
488                 }
489                 else
490                 {
491                         /* Success: Restore the interval, if it was changed. */
492                         rf->rf_effective_interval = rf->rf_interval;
493                 }
495                 /* update the ``next read due'' field */
496                 now = cdtime ();
498                 DEBUG ("plugin_read_thread: Effective interval of the "
499                                 "%s plugin is %.3f seconds.",
500                                 rf->rf_name,
501                                 CDTIME_T_TO_DOUBLE (rf->rf_effective_interval));
503                 /* Calculate the next (absolute) time at which this function
504                  * should be called. */
505                 rf->rf_next_read += rf->rf_effective_interval;
507                 /* Check, if `rf_next_read' is in the past. */
508                 if (rf->rf_next_read < now)
509                 {
510                         /* `rf_next_read' is in the past. Insert `now'
511                          * so this value doesn't trail off into the
512                          * past too much. */
513                         rf->rf_next_read = now;
514                 }
516                 DEBUG ("plugin_read_thread: Next read of the %s plugin at %.3f.",
517                                 rf->rf_name,
518                                 CDTIME_T_TO_DOUBLE (rf->rf_next_read));
520                 /* Re-insert this read function into the heap again. */
521                 c_heap_insert (read_heap, rf);
522         } /* while (read_loop) */
524         pthread_exit (NULL);
525         return ((void *) 0);
526 } /* void *plugin_read_thread */
528 static void start_read_threads (int num)
530         int i;
532         if (read_threads != NULL)
533                 return;
535         read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
536         if (read_threads == NULL)
537         {
538                 ERROR ("plugin: start_read_threads: calloc failed.");
539                 return;
540         }
542         read_threads_num = 0;
543         for (i = 0; i < num; i++)
544         {
545                 if (pthread_create (read_threads + read_threads_num, NULL,
546                                         plugin_read_thread, NULL) == 0)
547                 {
548                         read_threads_num++;
549                 }
550                 else
551                 {
552                         ERROR ("plugin: start_read_threads: pthread_create failed.");
553                         return;
554                 }
555         } /* for (i) */
556 } /* void start_read_threads */
558 static void stop_read_threads (void)
560         int i;
562         if (read_threads == NULL)
563                 return;
565         INFO ("collectd: Stopping %i read threads.", read_threads_num);
567         pthread_mutex_lock (&read_lock);
568         read_loop = 0;
569         DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
570         pthread_cond_broadcast (&read_cond);
571         pthread_mutex_unlock (&read_lock);
573         for (i = 0; i < read_threads_num; i++)
574         {
575                 if (pthread_join (read_threads[i], NULL) != 0)
576                 {
577                         ERROR ("plugin: stop_read_threads: pthread_join failed.");
578                 }
579                 read_threads[i] = (pthread_t) 0;
580         }
581         sfree (read_threads);
582         read_threads_num = 0;
583 } /* void stop_read_threads */
585 static void plugin_value_list_free (value_list_t *vl) /* {{{ */
587         if (vl == NULL)
588                 return;
590         meta_data_destroy (vl->meta);
591         sfree (vl->values);
592         sfree (vl);
593 } /* }}} void plugin_value_list_free */
595 static value_list_t *plugin_value_list_clone (value_list_t const *vl_orig) /* {{{ */
597         value_list_t *vl;
599         if (vl_orig == NULL)
600                 return (NULL);
602         vl = malloc (sizeof (*vl));
603         if (vl == NULL)
604                 return (NULL);
605         memcpy (vl, vl_orig, sizeof (*vl));
607         vl->values = calloc (vl_orig->values_len, sizeof (*vl->values));
608         if (vl->values == NULL)
609         {
610                 plugin_value_list_free (vl);
611                 return (NULL);
612         }
613         memcpy (vl->values, vl_orig->values,
614                         vl_orig->values_len * sizeof (*vl->values));
616         vl->meta = meta_data_clone (vl->meta);
617         if ((vl_orig->meta != NULL) && (vl->meta == NULL))
618         {
619                 plugin_value_list_free (vl);
620                 return (NULL);
621         }
623         if (vl->time == 0)
624                 vl->time = cdtime ();
626         /* Fill in the interval from the thread context, if it is zero. */
627         if (vl->interval == 0)
628         {
629                 plugin_ctx_t ctx = plugin_get_ctx ();
631                 if (ctx.interval != 0)
632                         vl->interval = ctx.interval;
633                 else
634                 {
635                         char name[6 * DATA_MAX_NAME_LEN];
636                         FORMAT_VL (name, sizeof (name), vl);
637                         ERROR ("plugin_value_list_clone: Unable to determine "
638                                         "interval from context for "
639                                         "value list \"%s\". "
640                                         "This indicates a broken plugin. "
641                                         "Please report this problem to the "
642                                         "collectd mailing list or at "
643                                         "<http://collectd.org/bugs/>.", name);
644                         vl->interval = cf_get_default_interval ();
645                 }
646         }
648         return (vl);
649 } /* }}} value_list_t *plugin_value_list_clone */
651 static int plugin_write_enqueue (value_list_t const *vl) /* {{{ */
653         write_queue_t *q;
655         q = malloc (sizeof (*q));
656         if (q == NULL)
657                 return (ENOMEM);
658         q->next = NULL;
660         q->vl = plugin_value_list_clone (vl);
661         if (q->vl == NULL)
662         {
663                 sfree (q);
664                 return (ENOMEM);
665         }
667         /* Store context of caller (read plugin); otherwise, it would not be
668          * available to the write plugins when actually dispatching the
669          * value-list later on. */
670         q->ctx = plugin_get_ctx ();
672         pthread_mutex_lock (&write_lock);
674         if (write_queue_tail == NULL)
675         {
676                 write_queue_head = q;
677                 write_queue_tail = q;
678                 write_queue_length = 1;
679         }
680         else
681         {
682                 write_queue_tail->next = q;
683                 write_queue_tail = q;
684                 write_queue_length += 1;
685         }
687         pthread_cond_signal (&write_cond);
688         pthread_mutex_unlock (&write_lock);
690         return (0);
691 } /* }}} int plugin_write_enqueue */
693 static value_list_t *plugin_write_dequeue (void) /* {{{ */
695         write_queue_t *q;
696         value_list_t *vl;
698         pthread_mutex_lock (&write_lock);
700         while (write_loop && (write_queue_head == NULL))
701                 pthread_cond_wait (&write_cond, &write_lock);
703         if (write_queue_head == NULL)
704         {
705                 pthread_mutex_unlock (&write_lock);
706                 return (NULL);
707         }
709         q = write_queue_head;
710         write_queue_head = q->next;
711         write_queue_length -= 1;
712         if (write_queue_head == NULL) {
713                 write_queue_tail = NULL;
714                 assert(0 == write_queue_length);
715                 }
717         pthread_mutex_unlock (&write_lock);
719         (void) plugin_set_ctx (q->ctx);
721         vl = q->vl;
722         sfree (q);
723         return (vl);
724 } /* }}} value_list_t *plugin_write_dequeue */
726 static void *plugin_write_thread (void __attribute__((unused)) *args) /* {{{ */
728         while (write_loop)
729         {
730                 value_list_t *vl = plugin_write_dequeue ();
731                 if (vl == NULL)
732                         continue;
734                 plugin_dispatch_values_internal (vl);
736                 plugin_value_list_free (vl);
737         }
739         pthread_exit (NULL);
740         return ((void *) 0);
741 } /* }}} void *plugin_write_thread */
743 static void start_write_threads (size_t num) /* {{{ */
745         size_t i;
747         if (write_threads != NULL)
748                 return;
750         write_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
751         if (write_threads == NULL)
752         {
753                 ERROR ("plugin: start_write_threads: calloc failed.");
754                 return;
755         }
757         write_threads_num = 0;
758         for (i = 0; i < num; i++)
759         {
760                 int status;
762                 status = pthread_create (write_threads + write_threads_num,
763                                 /* attr = */ NULL,
764                                 plugin_write_thread,
765                                 /* arg = */ NULL);
766                 if (status != 0)
767                 {
768                         char errbuf[1024];
769                         ERROR ("plugin: start_write_threads: pthread_create failed "
770                                         "with status %i (%s).", status,
771                                         sstrerror (status, errbuf, sizeof (errbuf)));
772                         return;
773                 }
775                 write_threads_num++;
776         } /* for (i) */
777 } /* }}} void start_write_threads */
779 static void stop_write_threads (void) /* {{{ */
781         write_queue_t *q;
782         int i;
784         if (write_threads == NULL)
785                 return;
787         INFO ("collectd: Stopping %zu write threads.", write_threads_num);
789         pthread_mutex_lock (&write_lock);
790         write_loop = 0;
791         DEBUG ("plugin: stop_write_threads: Signalling `write_cond'");
792         pthread_cond_broadcast (&write_cond);
793         pthread_mutex_unlock (&write_lock);
795         for (i = 0; i < write_threads_num; i++)
796         {
797                 if (pthread_join (write_threads[i], NULL) != 0)
798                 {
799                         ERROR ("plugin: stop_write_threads: pthread_join failed.");
800                 }
801                 write_threads[i] = (pthread_t) 0;
802         }
803         sfree (write_threads);
804         write_threads_num = 0;
806         pthread_mutex_lock (&write_lock);
807         i = 0;
808         for (q = write_queue_head; q != NULL; )
809         {
810                 write_queue_t *q1 = q;
811                 plugin_value_list_free (q->vl);
812                 q = q->next;
813                 sfree (q1);
814                 i++;
815         }
816         write_queue_head = NULL;
817         write_queue_tail = NULL;
818         write_queue_length = 0;
819         pthread_mutex_unlock (&write_lock);
821         if (i > 0)
822         {
823                 WARNING ("plugin: %i value list%s left after shutting down "
824                                 "the write threads.",
825                                 i, (i == 1) ? " was" : "s were");
826         }
827 } /* }}} void stop_write_threads */
829 /*
830  * Public functions
831  */
832 void plugin_set_dir (const char *dir)
834         if (plugindir != NULL)
835                 free (plugindir);
837         if (dir == NULL)
838                 plugindir = NULL;
839         else if ((plugindir = strdup (dir)) == NULL)
840         {
841                 char errbuf[1024];
842                 ERROR ("strdup failed: %s",
843                                 sstrerror (errno, errbuf, sizeof (errbuf)));
844         }
847 static _Bool plugin_is_loaded (char const *name)
849         int status;
851         if (plugins_loaded == NULL)
852                 plugins_loaded = c_avl_create ((void *) strcasecmp);
853         assert (plugins_loaded != NULL);
855         status = c_avl_get (plugins_loaded, name, /* ret_value = */ NULL);
856         return (status == 0);
859 static int plugin_mark_loaded (char const *name)
861         char *name_copy;
862         int status;
864         name_copy = strdup (name);
865         if (name_copy == NULL)
866                 return (ENOMEM);
868         status = c_avl_insert (plugins_loaded,
869                         /* key = */ name_copy, /* value = */ NULL);
870         return (status);
873 static void plugin_free_loaded ()
875         void *key;
876         void *value;
878         if (plugins_loaded == NULL)
879                 return;
881         while (c_avl_pick (plugins_loaded, &key, &value) == 0)
882         {
883                 sfree (key);
884                 assert (value == NULL);
885         }
887         c_avl_destroy (plugins_loaded);
888         plugins_loaded = NULL;
891 #define BUFSIZE 512
892 int plugin_load (char const *plugin_name, uint32_t flags)
894         DIR  *dh;
895         const char *dir;
896         char  filename[BUFSIZE] = "";
897         char  typename[BUFSIZE];
898         int   ret;
899         struct stat    statbuf;
900         struct dirent *de;
901         int status;
903         if (plugin_name == NULL)
904                 return (EINVAL);
906         /* Check if plugin is already loaded and don't do anything in this
907          * case. */
908         if (plugin_is_loaded (plugin_name))
909                 return (0);
911         dir = plugin_get_dir ();
912         ret = 1;
914         /*
915          * XXX: Magic at work:
916          *
917          * Some of the language bindings, for example the Python and Perl
918          * plugins, need to be able to export symbols to the scripts they run.
919          * For this to happen, the "Globals" flag needs to be set.
920          * Unfortunately, this technical detail is hard to explain to the
921          * average user and she shouldn't have to worry about this, ideally.
922          * So in order to save everyone's sanity use a different default for a
923          * handful of special plugins. --octo
924          */
925         if ((strcasecmp ("perl", plugin_name) == 0)
926                         || (strcasecmp ("python", plugin_name) == 0))
927                 flags |= PLUGIN_FLAGS_GLOBAL;
929         /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
930          * type when matching the filename */
931         status = ssnprintf (typename, sizeof (typename), "%s.so", plugin_name);
932         if ((status < 0) || ((size_t) status >= sizeof (typename)))
933         {
934                 WARNING ("plugin_load: Filename too long: \"%s.so\"", plugin_name);
935                 return (-1);
936         }
938         if ((dh = opendir (dir)) == NULL)
939         {
940                 char errbuf[1024];
941                 ERROR ("plugin_load: opendir (%s) failed: %s", dir,
942                                 sstrerror (errno, errbuf, sizeof (errbuf)));
943                 return (-1);
944         }
946         while ((de = readdir (dh)) != NULL)
947         {
948                 if (strcasecmp (de->d_name, typename))
949                         continue;
951                 status = ssnprintf (filename, sizeof (filename),
952                                 "%s/%s", dir, de->d_name);
953                 if ((status < 0) || ((size_t) status >= sizeof (filename)))
954                 {
955                         WARNING ("plugin_load: Filename too long: \"%s/%s\"",
956                                         dir, de->d_name);
957                         continue;
958                 }
960                 if (lstat (filename, &statbuf) == -1)
961                 {
962                         char errbuf[1024];
963                         WARNING ("plugin_load: stat (\"%s\") failed: %s",
964                                         filename,
965                                         sstrerror (errno, errbuf, sizeof (errbuf)));
966                         continue;
967                 }
968                 else if (!S_ISREG (statbuf.st_mode))
969                 {
970                         /* don't follow symlinks */
971                         WARNING ("plugin_load: %s is not a regular file.",
972                                         filename);
973                         continue;
974                 }
976                 status = plugin_load_file (filename, flags);
977                 if (status == 0)
978                 {
979                         /* success */
980                         plugin_mark_loaded (plugin_name);
981                         ret = 0;
982                         break;
983                 }
984                 else
985                 {
986                         ERROR ("plugin_load: Load plugin \"%s\" failed with "
987                                         "status %i.", plugin_name, status);
988                 }
989         }
991         closedir (dh);
993         if (filename[0] == 0)
994                 ERROR ("plugin_load: Could not find plugin \"%s\" in %s",
995                                 plugin_name, dir);
997         return (ret);
1000 /*
1001  * The `register_*' functions follow
1002  */
1003 int plugin_register_config (const char *name,
1004                 int (*callback) (const char *key, const char *val),
1005                 const char **keys, int keys_num)
1007         cf_register (name, callback, keys, keys_num);
1008         return (0);
1009 } /* int plugin_register_config */
1011 int plugin_register_complex_config (const char *type,
1012                 int (*callback) (oconfig_item_t *))
1014         return (cf_register_complex (type, callback));
1015 } /* int plugin_register_complex_config */
1017 int plugin_register_init (const char *name,
1018                 int (*callback) (void))
1020         return (create_register_callback (&list_init, name, (void *) callback,
1021                                 /* user_data = */ NULL));
1022 } /* plugin_register_init */
1024 static int plugin_compare_read_func (const void *arg0, const void *arg1)
1026         const read_func_t *rf0;
1027         const read_func_t *rf1;
1029         rf0 = arg0;
1030         rf1 = arg1;
1032         if (rf0->rf_next_read < rf1->rf_next_read)
1033                 return (-1);
1034         else if (rf0->rf_next_read > rf1->rf_next_read)
1035                 return (1);
1036         else
1037                 return (0);
1038 } /* int plugin_compare_read_func */
1040 /* Add a read function to both, the heap and a linked list. The linked list if
1041  * used to look-up read functions, especially for the remove function. The heap
1042  * is used to determine which plugin to read next. */
1043 static int plugin_insert_read (read_func_t *rf)
1045         int status;
1046         llentry_t *le;
1048         rf->rf_next_read = cdtime ();
1049         rf->rf_effective_interval = rf->rf_interval;
1051         pthread_mutex_lock (&read_lock);
1053         if (read_list == NULL)
1054         {
1055                 read_list = llist_create ();
1056                 if (read_list == NULL)
1057                 {
1058                         pthread_mutex_unlock (&read_lock);
1059                         ERROR ("plugin_insert_read: read_list failed.");
1060                         return (-1);
1061                 }
1062         }
1064         if (read_heap == NULL)
1065         {
1066                 read_heap = c_heap_create (plugin_compare_read_func);
1067                 if (read_heap == NULL)
1068                 {
1069                         pthread_mutex_unlock (&read_lock);
1070                         ERROR ("plugin_insert_read: c_heap_create failed.");
1071                         return (-1);
1072                 }
1073         }
1075         le = llist_search (read_list, rf->rf_name);
1076         if (le != NULL)
1077         {
1078                 pthread_mutex_unlock (&read_lock);
1079                 WARNING ("The read function \"%s\" is already registered. "
1080                                 "Check for duplicate \"LoadPlugin\" lines "
1081                                 "in your configuration!",
1082                                 rf->rf_name);
1083                 return (EINVAL);
1084         }
1086         le = llentry_create (rf->rf_name, rf);
1087         if (le == NULL)
1088         {
1089                 pthread_mutex_unlock (&read_lock);
1090                 ERROR ("plugin_insert_read: llentry_create failed.");
1091                 return (-1);
1092         }
1094         status = c_heap_insert (read_heap, rf);
1095         if (status != 0)
1096         {
1097                 pthread_mutex_unlock (&read_lock);
1098                 ERROR ("plugin_insert_read: c_heap_insert failed.");
1099                 llentry_destroy (le);
1100                 return (-1);
1101         }
1103         /* This does not fail. */
1104         llist_append (read_list, le);
1106         /* Wake up all the read threads. */
1107         pthread_cond_broadcast (&read_cond);
1108         pthread_mutex_unlock (&read_lock);
1109         return (0);
1110 } /* int plugin_insert_read */
1112 int plugin_register_read (const char *name,
1113                 int (*callback) (void))
1115         read_func_t *rf;
1116         int status;
1118         rf = malloc (sizeof (*rf));
1119         if (rf == NULL)
1120         {
1121                 ERROR ("plugin_register_read: malloc failed.");
1122                 return (ENOMEM);
1123         }
1125         memset (rf, 0, sizeof (read_func_t));
1126         rf->rf_callback = (void *) callback;
1127         rf->rf_udata.data = NULL;
1128         rf->rf_udata.free_func = NULL;
1129         rf->rf_ctx = plugin_get_ctx ();
1130         rf->rf_group[0] = '\0';
1131         rf->rf_name = strdup (name);
1132         rf->rf_type = RF_SIMPLE;
1133         rf->rf_interval = plugin_get_interval ();
1135         status = plugin_insert_read (rf);
1136         if (status != 0)
1137                 sfree (rf);
1139         return (status);
1140 } /* int plugin_register_read */
1142 int plugin_register_complex_read (const char *group, const char *name,
1143                 plugin_read_cb callback,
1144                 const struct timespec *interval,
1145                 user_data_t *user_data)
1147         read_func_t *rf;
1148         int status;
1150         rf = malloc (sizeof (*rf));
1151         if (rf == NULL)
1152         {
1153                 ERROR ("plugin_register_complex_read: malloc failed.");
1154                 return (ENOMEM);
1155         }
1157         memset (rf, 0, sizeof (read_func_t));
1158         rf->rf_callback = (void *) callback;
1159         if (group != NULL)
1160                 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
1161         else
1162                 rf->rf_group[0] = '\0';
1163         rf->rf_name = strdup (name);
1164         rf->rf_type = RF_COMPLEX;
1165         if (interval != NULL)
1166                 rf->rf_interval = TIMESPEC_TO_CDTIME_T (interval);
1167         else
1168                 rf->rf_interval = plugin_get_interval ();
1170         /* Set user data */
1171         if (user_data == NULL)
1172         {
1173                 rf->rf_udata.data = NULL;
1174                 rf->rf_udata.free_func = NULL;
1175         }
1176         else
1177         {
1178                 rf->rf_udata = *user_data;
1179         }
1181         rf->rf_ctx = plugin_get_ctx ();
1183         status = plugin_insert_read (rf);
1184         if (status != 0)
1185                 sfree (rf);
1187         return (status);
1188 } /* int plugin_register_complex_read */
1190 int plugin_register_write (const char *name,
1191                 plugin_write_cb callback, user_data_t *ud)
1193         return (create_register_callback (&list_write, name,
1194                                 (void *) callback, ud));
1195 } /* int plugin_register_write */
1197 int plugin_register_flush (const char *name,
1198                 plugin_flush_cb callback, user_data_t *ud)
1200         return (create_register_callback (&list_flush, name,
1201                                 (void *) callback, ud));
1202 } /* int plugin_register_flush */
1204 int plugin_register_missing (const char *name,
1205                 plugin_missing_cb callback, user_data_t *ud)
1207         return (create_register_callback (&list_missing, name,
1208                                 (void *) callback, ud));
1209 } /* int plugin_register_missing */
1211 int plugin_register_shutdown (const char *name,
1212                 int (*callback) (void))
1214         return (create_register_callback (&list_shutdown, name,
1215                                 (void *) callback, /* user_data = */ NULL));
1216 } /* int plugin_register_shutdown */
1218 static void plugin_free_data_sets (void)
1220         void *key;
1221         void *value;
1223         if (data_sets == NULL)
1224                 return;
1226         while (c_avl_pick (data_sets, &key, &value) == 0)
1227         {
1228                 data_set_t *ds = value;
1229                 /* key is a pointer to ds->type */
1231                 sfree (ds->ds);
1232                 sfree (ds);
1233         }
1235         c_avl_destroy (data_sets);
1236         data_sets = NULL;
1237 } /* void plugin_free_data_sets */
1239 int plugin_register_data_set (const data_set_t *ds)
1241         data_set_t *ds_copy;
1242         int i;
1244         if ((data_sets != NULL)
1245                         && (c_avl_get (data_sets, ds->type, NULL) == 0))
1246         {
1247                 NOTICE ("Replacing DS `%s' with another version.", ds->type);
1248                 plugin_unregister_data_set (ds->type);
1249         }
1250         else if (data_sets == NULL)
1251         {
1252                 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
1253                 if (data_sets == NULL)
1254                         return (-1);
1255         }
1257         ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
1258         if (ds_copy == NULL)
1259                 return (-1);
1260         memcpy(ds_copy, ds, sizeof (data_set_t));
1262         ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
1263                         * ds->ds_num);
1264         if (ds_copy->ds == NULL)
1265         {
1266                 free (ds_copy);
1267                 return (-1);
1268         }
1270         for (i = 0; i < ds->ds_num; i++)
1271                 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
1273         return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
1274 } /* int plugin_register_data_set */
1276 int plugin_register_log (const char *name,
1277                 plugin_log_cb callback, user_data_t *ud)
1279         return (create_register_callback (&list_log, name,
1280                                 (void *) callback, ud));
1281 } /* int plugin_register_log */
1283 int plugin_register_notification (const char *name,
1284                 plugin_notification_cb callback, user_data_t *ud)
1286         return (create_register_callback (&list_notification, name,
1287                                 (void *) callback, ud));
1288 } /* int plugin_register_log */
1290 int plugin_unregister_config (const char *name)
1292         cf_unregister (name);
1293         return (0);
1294 } /* int plugin_unregister_config */
1296 int plugin_unregister_complex_config (const char *name)
1298         cf_unregister_complex (name);
1299         return (0);
1300 } /* int plugin_unregister_complex_config */
1302 int plugin_unregister_init (const char *name)
1304         return (plugin_unregister (list_init, name));
1307 int plugin_unregister_read (const char *name) /* {{{ */
1309         llentry_t *le;
1310         read_func_t *rf;
1312         if (name == NULL)
1313                 return (-ENOENT);
1315         pthread_mutex_lock (&read_lock);
1317         if (read_list == NULL)
1318         {
1319                 pthread_mutex_unlock (&read_lock);
1320                 return (-ENOENT);
1321         }
1323         le = llist_search (read_list, name);
1324         if (le == NULL)
1325         {
1326                 pthread_mutex_unlock (&read_lock);
1327                 WARNING ("plugin_unregister_read: No such read function: %s",
1328                                 name);
1329                 return (-ENOENT);
1330         }
1332         llist_remove (read_list, le);
1334         rf = le->value;
1335         assert (rf != NULL);
1336         rf->rf_type = RF_REMOVE;
1338         pthread_mutex_unlock (&read_lock);
1340         llentry_destroy (le);
1342         DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
1344         return (0);
1345 } /* }}} int plugin_unregister_read */
1347 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
1349         read_func_t *rf    = e->value;
1350         char        *group = ud;
1352         return strcmp (rf->rf_group, (const char *)group);
1353 } /* }}} int compare_read_func_group */
1355 int plugin_unregister_read_group (const char *group) /* {{{ */
1357         llentry_t *le;
1358         read_func_t *rf;
1360         int found = 0;
1362         if (group == NULL)
1363                 return (-ENOENT);
1365         pthread_mutex_lock (&read_lock);
1367         if (read_list == NULL)
1368         {
1369                 pthread_mutex_unlock (&read_lock);
1370                 return (-ENOENT);
1371         }
1373         while (42)
1374         {
1375                 le = llist_search_custom (read_list,
1376                                 compare_read_func_group, (void *)group);
1378                 if (le == NULL)
1379                         break;
1381                 ++found;
1383                 llist_remove (read_list, le);
1385                 rf = le->value;
1386                 assert (rf != NULL);
1387                 rf->rf_type = RF_REMOVE;
1389                 llentry_destroy (le);
1391                 DEBUG ("plugin_unregister_read_group: "
1392                                 "Marked `%s' (group `%s') for removal.",
1393                                 rf->rf_name, group);
1394         }
1396         pthread_mutex_unlock (&read_lock);
1398         if (found == 0)
1399         {
1400                 WARNING ("plugin_unregister_read_group: No such "
1401                                 "group of read function: %s", group);
1402                 return (-ENOENT);
1403         }
1405         return (0);
1406 } /* }}} int plugin_unregister_read_group */
1408 int plugin_unregister_write (const char *name)
1410         return (plugin_unregister (list_write, name));
1413 int plugin_unregister_flush (const char *name)
1415         return (plugin_unregister (list_flush, name));
1418 int plugin_unregister_missing (const char *name)
1420         return (plugin_unregister (list_missing, name));
1423 int plugin_unregister_shutdown (const char *name)
1425         return (plugin_unregister (list_shutdown, name));
1428 int plugin_unregister_data_set (const char *name)
1430         data_set_t *ds;
1432         if (data_sets == NULL)
1433                 return (-1);
1435         if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1436                 return (-1);
1438         sfree (ds->ds);
1439         sfree (ds);
1441         return (0);
1442 } /* int plugin_unregister_data_set */
1444 int plugin_unregister_log (const char *name)
1446         return (plugin_unregister (list_log, name));
1449 int plugin_unregister_notification (const char *name)
1451         return (plugin_unregister (list_notification, name));
1454 void plugin_init_all (void)
1456         char const *chain_name;
1457         long write_threads_num;
1458         llentry_t *le;
1459         int status;
1461         /* Init the value cache */
1462         uc_init ();
1464         chain_name = global_option_get ("PreCacheChain");
1465         pre_cache_chain = fc_chain_get_by_name (chain_name);
1467         chain_name = global_option_get ("PostCacheChain");
1468         post_cache_chain = fc_chain_get_by_name (chain_name);
1470         write_limit_high = global_option_get_long ("WriteQueueLimitHigh",
1471                         /* default = */ 0);
1472         if (write_limit_high < 0)
1473         {
1474                 ERROR ("WriteQueueLimitHigh must be positive or zero.");
1475                 write_limit_high = 0;
1476         }
1478         write_limit_low = global_option_get_long ("WriteQueueLimitLow",
1479                         /* default = */ write_limit_high / 2);
1480         if (write_limit_low < 0)
1481         {
1482                 ERROR ("WriteQueueLimitLow must be positive or zero.");
1483                 write_limit_low = write_limit_high / 2;
1484         }
1485         else if (write_limit_low > write_limit_high)
1486         {
1487                 ERROR ("WriteQueueLimitLow must not be larger than "
1488                                 "WriteQueueLimitHigh.");
1489                 write_limit_low = write_limit_high;
1490         }
1492         write_threads_num = global_option_get_long ("WriteThreads",
1493                         /* default = */ 5);
1494         if (write_threads_num < 1)
1495         {
1496                 ERROR ("WriteThreads must be positive.");
1497                 write_threads_num = 5;
1498         }
1500         start_write_threads ((size_t) write_threads_num);
1502         if ((list_init == NULL) && (read_heap == NULL))
1503                 return;
1505         /* Calling all init callbacks before checking if read callbacks
1506          * are available allows the init callbacks to register the read
1507          * callback. */
1508         le = llist_head (list_init);
1509         while (le != NULL)
1510         {
1511                 callback_func_t *cf;
1512                 plugin_init_cb callback;
1513                 plugin_ctx_t old_ctx;
1515                 cf = le->value;
1516                 old_ctx = plugin_set_ctx (cf->cf_ctx);
1517                 callback = cf->cf_callback;
1518                 status = (*callback) ();
1519                 plugin_set_ctx (old_ctx);
1521                 if (status != 0)
1522                 {
1523                         ERROR ("Initialization of plugin `%s' "
1524                                         "failed with status %i. "
1525                                         "Plugin will be unloaded.",
1526                                         le->key, status);
1527                         /* Plugins that register read callbacks from the init
1528                          * callback should take care of appropriate error
1529                          * handling themselves. */
1530                         /* FIXME: Unload _all_ functions */
1531                         plugin_unregister_read (le->key);
1532                 }
1534                 le = le->next;
1535         }
1537         /* Start read-threads */
1538         if (read_heap != NULL)
1539         {
1540                 const char *rt;
1541                 int num;
1542                 rt = global_option_get ("ReadThreads");
1543                 num = atoi (rt);
1544                 if (num != -1)
1545                         start_read_threads ((num > 0) ? num : 5);
1546         }
1547 } /* void plugin_init_all */
1549 /* TODO: Rename this function. */
1550 void plugin_read_all (void)
1552         uc_check_timeout ();
1554         return;
1555 } /* void plugin_read_all */
1557 /* Read function called when the `-T' command line argument is given. */
1558 int plugin_read_all_once (void)
1560         int status;
1561         int return_status = 0;
1563         if (read_heap == NULL)
1564         {
1565                 NOTICE ("No read-functions are registered.");
1566                 return (0);
1567         }
1569         while (42)
1570         {
1571                 read_func_t *rf;
1572                 plugin_ctx_t old_ctx;
1574                 rf = c_heap_get_root (read_heap);
1575                 if (rf == NULL)
1576                         break;
1578                 old_ctx = plugin_set_ctx (rf->rf_ctx);
1580                 if (rf->rf_type == RF_SIMPLE)
1581                 {
1582                         int (*callback) (void);
1584                         callback = rf->rf_callback;
1585                         status = (*callback) ();
1586                 }
1587                 else
1588                 {
1589                         plugin_read_cb callback;
1591                         callback = rf->rf_callback;
1592                         status = (*callback) (&rf->rf_udata);
1593                 }
1595                 plugin_set_ctx (old_ctx);
1597                 if (status != 0)
1598                 {
1599                         NOTICE ("read-function of plugin `%s' failed.",
1600                                         rf->rf_name);
1601                         return_status = -1;
1602                 }
1604                 destroy_callback ((void *) rf);
1605         }
1607         return (return_status);
1608 } /* int plugin_read_all_once */
1610 int plugin_write (const char *plugin, /* {{{ */
1611                 const data_set_t *ds, const value_list_t *vl)
1613   llentry_t *le;
1614   int status;
1616   if (vl == NULL)
1617     return (EINVAL);
1619   if (list_write == NULL)
1620     return (ENOENT);
1622   if (ds == NULL)
1623   {
1624     ds = plugin_get_ds (vl->type);
1625     if (ds == NULL)
1626     {
1627       ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1628       return (ENOENT);
1629     }
1630   }
1632   if (plugin == NULL)
1633   {
1634     int success = 0;
1635     int failure = 0;
1637     le = llist_head (list_write);
1638     while (le != NULL)
1639     {
1640       callback_func_t *cf = le->value;
1641       plugin_write_cb callback;
1643       /* do not switch plugin context; rather keep the context (interval)
1644        * information of the calling read plugin */
1646       DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1647       callback = cf->cf_callback;
1648       status = (*callback) (ds, vl, &cf->cf_udata);
1649       if (status != 0)
1650         failure++;
1651       else
1652         success++;
1654       le = le->next;
1655     }
1657     if ((success == 0) && (failure != 0))
1658       status = -1;
1659     else
1660       status = 0;
1661   }
1662   else /* plugin != NULL */
1663   {
1664     callback_func_t *cf;
1665     plugin_write_cb callback;
1667     le = llist_head (list_write);
1668     while (le != NULL)
1669     {
1670       if (strcasecmp (plugin, le->key) == 0)
1671         break;
1673       le = le->next;
1674     }
1676     if (le == NULL)
1677       return (ENOENT);
1679     cf = le->value;
1681     /* do not switch plugin context; rather keep the context (interval)
1682      * information of the calling read plugin */
1684     DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1685     callback = cf->cf_callback;
1686     status = (*callback) (ds, vl, &cf->cf_udata);
1687   }
1689   return (status);
1690 } /* }}} int plugin_write */
1692 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1694   llentry_t *le;
1696   if (list_flush == NULL)
1697     return (0);
1699   le = llist_head (list_flush);
1700   while (le != NULL)
1701   {
1702     callback_func_t *cf;
1703     plugin_flush_cb callback;
1704     plugin_ctx_t old_ctx;
1706     if ((plugin != NULL)
1707         && (strcmp (plugin, le->key) != 0))
1708     {
1709       le = le->next;
1710       continue;
1711     }
1713     cf = le->value;
1714     old_ctx = plugin_set_ctx (cf->cf_ctx);
1715     callback = cf->cf_callback;
1717     (*callback) (timeout, identifier, &cf->cf_udata);
1719     plugin_set_ctx (old_ctx);
1721     le = le->next;
1722   }
1723   return (0);
1724 } /* int plugin_flush */
1726 void plugin_shutdown_all (void)
1728         llentry_t *le;
1730         stop_read_threads ();
1732         destroy_all_callbacks (&list_init);
1734         pthread_mutex_lock (&read_lock);
1735         llist_destroy (read_list);
1736         read_list = NULL;
1737         pthread_mutex_unlock (&read_lock);
1739         destroy_read_heap ();
1741         plugin_flush (/* plugin = */ NULL,
1742                         /* timeout = */ 0,
1743                         /* identifier = */ NULL);
1745         le = NULL;
1746         if (list_shutdown != NULL)
1747                 le = llist_head (list_shutdown);
1749         while (le != NULL)
1750         {
1751                 callback_func_t *cf;
1752                 plugin_shutdown_cb callback;
1753                 plugin_ctx_t old_ctx;
1755                 cf = le->value;
1756                 old_ctx = plugin_set_ctx (cf->cf_ctx);
1757                 callback = cf->cf_callback;
1759                 /* Advance the pointer before calling the callback allows
1760                  * shutdown functions to unregister themselves. If done the
1761                  * other way around the memory `le' points to will be freed
1762                  * after callback returns. */
1763                 le = le->next;
1765                 (*callback) ();
1767                 plugin_set_ctx (old_ctx);
1768         }
1770         stop_write_threads ();
1772         /* Write plugins which use the `user_data' pointer usually need the
1773          * same data available to the flush callback. If this is the case, set
1774          * the free_function to NULL when registering the flush callback and to
1775          * the real free function when registering the write callback. This way
1776          * the data isn't freed twice. */
1777         destroy_all_callbacks (&list_flush);
1778         destroy_all_callbacks (&list_missing);
1779         destroy_all_callbacks (&list_write);
1781         destroy_all_callbacks (&list_notification);
1782         destroy_all_callbacks (&list_shutdown);
1783         destroy_all_callbacks (&list_log);
1785         plugin_free_loaded ();
1786         plugin_free_data_sets ();
1787 } /* void plugin_shutdown_all */
1789 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1791   llentry_t *le;
1793   if (list_missing == NULL)
1794     return (0);
1796   le = llist_head (list_missing);
1797   while (le != NULL)
1798   {
1799     callback_func_t *cf;
1800     plugin_missing_cb callback;
1801     plugin_ctx_t old_ctx;
1802     int status;
1804     cf = le->value;
1805     old_ctx = plugin_set_ctx (cf->cf_ctx);
1806     callback = cf->cf_callback;
1808     status = (*callback) (vl, &cf->cf_udata);
1809     plugin_set_ctx (old_ctx);
1810     if (status != 0)
1811     {
1812       if (status < 0)
1813       {
1814         ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1815             "failed with status %i.",
1816             le->key, status);
1817         return (status);
1818       }
1819       else
1820       {
1821         return (0);
1822       }
1823     }
1825     le = le->next;
1826   }
1827   return (0);
1828 } /* int }}} plugin_dispatch_missing */
1830 static int plugin_dispatch_values_internal (value_list_t *vl)
1832         int status;
1833         static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1835         value_t *saved_values;
1836         int      saved_values_len;
1838         data_set_t *ds;
1840         int free_meta_data = 0;
1842         if ((vl == NULL) || (vl->type[0] == 0)
1843                         || (vl->values == NULL) || (vl->values_len < 1))
1844         {
1845                 ERROR ("plugin_dispatch_values: Invalid value list "
1846                                 "from plugin %s.", vl->plugin);
1847                 return (-1);
1848         }
1850         /* Free meta data only if the calling function didn't specify any. In
1851          * this case matches and targets may add some and the calling function
1852          * may not expect (and therefore free) that data. */
1853         if (vl->meta == NULL)
1854                 free_meta_data = 1;
1856         if (list_write == NULL)
1857                 c_complain_once (LOG_WARNING, &no_write_complaint,
1858                                 "plugin_dispatch_values: No write callback has been "
1859                                 "registered. Please load at least one output plugin, "
1860                                 "if you want the collected data to be stored.");
1862         if (data_sets == NULL)
1863         {
1864                 ERROR ("plugin_dispatch_values: No data sets registered. "
1865                                 "Could the types database be read? Check "
1866                                 "your `TypesDB' setting!");
1867                 return (-1);
1868         }
1870         if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1871         {
1872                 char ident[6 * DATA_MAX_NAME_LEN];
1874                 FORMAT_VL (ident, sizeof (ident), vl);
1875                 INFO ("plugin_dispatch_values: Dataset not found: %s "
1876                                 "(from \"%s\"), check your types.db!",
1877                                 vl->type, ident);
1878                 return (-1);
1879         }
1881         /* Assured by plugin_value_list_clone(). The time is determined at
1882          * _enqueue_ time. */
1883         assert (vl->time != 0);
1884         assert (vl->interval != 0);
1886         DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1887                         "host = %s; "
1888                         "plugin = %s; plugin_instance = %s; "
1889                         "type = %s; type_instance = %s;",
1890                         CDTIME_T_TO_DOUBLE (vl->time),
1891                         CDTIME_T_TO_DOUBLE (vl->interval),
1892                         vl->host,
1893                         vl->plugin, vl->plugin_instance,
1894                         vl->type, vl->type_instance);
1896 #if COLLECT_DEBUG
1897         assert (0 == strcmp (ds->type, vl->type));
1898 #else
1899         if (0 != strcmp (ds->type, vl->type))
1900                 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1901                                 ds->type, vl->type);
1902 #endif
1904 #if COLLECT_DEBUG
1905         assert (ds->ds_num == vl->values_len);
1906 #else
1907         if (ds->ds_num != vl->values_len)
1908         {
1909                 ERROR ("plugin_dispatch_values: ds->type = %s: "
1910                                 "(ds->ds_num = %i) != "
1911                                 "(vl->values_len = %i)",
1912                                 ds->type, ds->ds_num, vl->values_len);
1913                 return (-1);
1914         }
1915 #endif
1917         escape_slashes (vl->host, sizeof (vl->host));
1918         escape_slashes (vl->plugin, sizeof (vl->plugin));
1919         escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1920         escape_slashes (vl->type, sizeof (vl->type));
1921         escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1923         /* Copy the values. This way, we can assure `targets' that they get
1924          * dynamically allocated values, which they can free and replace if
1925          * they like. */
1926         if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1927         {
1928                 saved_values     = vl->values;
1929                 saved_values_len = vl->values_len;
1931                 vl->values = (value_t *) calloc (vl->values_len,
1932                                 sizeof (*vl->values));
1933                 if (vl->values == NULL)
1934                 {
1935                         ERROR ("plugin_dispatch_values: calloc failed.");
1936                         vl->values = saved_values;
1937                         return (-1);
1938                 }
1939                 memcpy (vl->values, saved_values,
1940                                 vl->values_len * sizeof (*vl->values));
1941         }
1942         else /* if ((pre == NULL) && (post == NULL)) */
1943         {
1944                 saved_values     = NULL;
1945                 saved_values_len = 0;
1946         }
1948         if (pre_cache_chain != NULL)
1949         {
1950                 status = fc_process_chain (ds, vl, pre_cache_chain);
1951                 if (status < 0)
1952                 {
1953                         WARNING ("plugin_dispatch_values: Running the "
1954                                         "pre-cache chain failed with "
1955                                         "status %i (%#x).",
1956                                         status, status);
1957                 }
1958                 else if (status == FC_TARGET_STOP)
1959                 {
1960                         /* Restore the state of the value_list so that plugins
1961                          * don't get confused.. */
1962                         if (saved_values != NULL)
1963                         {
1964                                 free (vl->values);
1965                                 vl->values     = saved_values;
1966                                 vl->values_len = saved_values_len;
1967                         }
1968                         return (0);
1969                 }
1970         }
1972         /* Update the value cache */
1973         uc_update (ds, vl);
1975         if (post_cache_chain != NULL)
1976         {
1977                 status = fc_process_chain (ds, vl, post_cache_chain);
1978                 if (status < 0)
1979                 {
1980                         WARNING ("plugin_dispatch_values: Running the "
1981                                         "post-cache chain failed with "
1982                                         "status %i (%#x).",
1983                                         status, status);
1984                 }
1985         }
1986         else
1987                 fc_default_action (ds, vl);
1989         /* Restore the state of the value_list so that plugins don't get
1990          * confused.. */
1991         if (saved_values != NULL)
1992         {
1993                 free (vl->values);
1994                 vl->values     = saved_values;
1995                 vl->values_len = saved_values_len;
1996         }
1998         if ((free_meta_data != 0) && (vl->meta != NULL))
1999         {
2000                 meta_data_destroy (vl->meta);
2001                 vl->meta = NULL;
2002         }
2004         return (0);
2005 } /* int plugin_dispatch_values_internal */
2007 static double get_drop_probability (void) /* {{{ */
2009         long pos;
2010         long size;
2011         long wql;
2013         pthread_mutex_lock (&write_lock);
2014         wql = write_queue_length;
2015         pthread_mutex_unlock (&write_lock);
2017         if (wql < write_limit_low)
2018                 return (0.0);
2019         if (wql >= write_limit_high)
2020                 return (1.0);
2022         pos = 1 + wql - write_limit_low;
2023         size = 1 + write_limit_high - write_limit_low;
2025         return (((double) pos) / ((double) size));
2026 } /* }}} double get_drop_probability */
2028 static _Bool check_drop_value (void) /* {{{ */
2030         static cdtime_t last_message_time = 0;
2031         static pthread_mutex_t last_message_lock = PTHREAD_MUTEX_INITIALIZER;
2033         double p;
2034         double q;
2035         int status;
2037         if (write_limit_high == 0)
2038                 return (0);
2040         p = get_drop_probability ();
2041         if (p == 0.0)
2042                 return (0);
2044         status = pthread_mutex_trylock (&last_message_lock);
2045         if (status == 0)
2046         {
2047                 cdtime_t now;
2049                 now = cdtime ();
2050                 if ((now - last_message_time) > TIME_T_TO_CDTIME_T (1))
2051                 {
2052                         last_message_time = now;
2053                         ERROR ("plugin_dispatch_values: Low water mark "
2054                                         "reached. Dropping %.0f%% of metrics.",
2055                                         100.0 * p);
2056                 }
2057                 pthread_mutex_unlock (&last_message_lock);
2058         }
2060         if (p == 1.0)
2061                 return (1);
2063         q = cdrand_d ();
2064         if (q > p)
2065                 return (1);
2066         else
2067                 return (0);
2068 } /* }}} _Bool check_drop_value */
2070 int plugin_dispatch_values (value_list_t const *vl)
2072         int status;
2074         if (check_drop_value ())
2075                 return (0);
2077         status = plugin_write_enqueue (vl);
2078         if (status != 0)
2079         {
2080                 char errbuf[1024];
2081                 ERROR ("plugin_dispatch_values: plugin_write_enqueue failed "
2082                                 "with status %i (%s).", status,
2083                                 sstrerror (status, errbuf, sizeof (errbuf)));
2084                 return (status);
2085         }
2087         return (0);
2090 int plugin_dispatch_notification (const notification_t *notif)
2092         llentry_t *le;
2093         /* Possible TODO: Add flap detection here */
2095         DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
2096                         "time = %.3f; host = %s;",
2097                         notif->severity, notif->message,
2098                         CDTIME_T_TO_DOUBLE (notif->time), notif->host);
2100         /* Nobody cares for notifications */
2101         if (list_notification == NULL)
2102                 return (-1);
2104         le = llist_head (list_notification);
2105         while (le != NULL)
2106         {
2107                 callback_func_t *cf;
2108                 plugin_notification_cb callback;
2109                 int status;
2111                 /* do not switch plugin context; rather keep the context
2112                  * (interval) information of the calling plugin */
2114                 cf = le->value;
2115                 callback = cf->cf_callback;
2116                 status = (*callback) (notif, &cf->cf_udata);
2117                 if (status != 0)
2118                 {
2119                         WARNING ("plugin_dispatch_notification: Notification "
2120                                         "callback %s returned %i.",
2121                                         le->key, status);
2122                 }
2124                 le = le->next;
2125         }
2127         return (0);
2128 } /* int plugin_dispatch_notification */
2130 void plugin_log (int level, const char *format, ...)
2132         char msg[1024];
2133         va_list ap;
2134         llentry_t *le;
2136 #if !COLLECT_DEBUG
2137         if (level >= LOG_DEBUG)
2138                 return;
2139 #endif
2141         va_start (ap, format);
2142         vsnprintf (msg, sizeof (msg), format, ap);
2143         msg[sizeof (msg) - 1] = '\0';
2144         va_end (ap);
2146         if (list_log == NULL)
2147         {
2148                 fprintf (stderr, "%s\n", msg);
2149                 return;
2150         }
2152         le = llist_head (list_log);
2153         while (le != NULL)
2154         {
2155                 callback_func_t *cf;
2156                 plugin_log_cb callback;
2158                 cf = le->value;
2159                 callback = cf->cf_callback;
2161                 /* do not switch plugin context; rather keep the context
2162                  * (interval) information of the calling plugin */
2164                 (*callback) (level, msg, &cf->cf_udata);
2166                 le = le->next;
2167         }
2168 } /* void plugin_log */
2170 int parse_log_severity (const char *severity)
2172         int log_level = -1;
2174         if ((0 == strcasecmp (severity, "emerg"))
2175                         || (0 == strcasecmp (severity, "alert"))
2176                         || (0 == strcasecmp (severity, "crit"))
2177                         || (0 == strcasecmp (severity, "err")))
2178                 log_level = LOG_ERR;
2179         else if (0 == strcasecmp (severity, "warning"))
2180                 log_level = LOG_WARNING;
2181         else if (0 == strcasecmp (severity, "notice"))
2182                 log_level = LOG_NOTICE;
2183         else if (0 == strcasecmp (severity, "info"))
2184                 log_level = LOG_INFO;
2185 #if COLLECT_DEBUG
2186         else if (0 == strcasecmp (severity, "debug"))
2187                 log_level = LOG_DEBUG;
2188 #endif /* COLLECT_DEBUG */
2190         return (log_level);
2191 } /* int parse_log_severity */
2193 int parse_notif_severity (const char *severity)
2195         int notif_severity = -1;
2197         if (strcasecmp (severity, "FAILURE") == 0)
2198                 notif_severity = NOTIF_FAILURE;
2199         else if (strcmp (severity, "OKAY") == 0)
2200                 notif_severity = NOTIF_OKAY;
2201         else if ((strcmp (severity, "WARNING") == 0)
2202                         || (strcmp (severity, "WARN") == 0))
2203                 notif_severity = NOTIF_WARNING;
2205         return (notif_severity);
2206 } /* int parse_notif_severity */
2208 const data_set_t *plugin_get_ds (const char *name)
2210         data_set_t *ds;
2212         if (data_sets == NULL)
2213         {
2214                 ERROR ("plugin_get_ds: No data sets are defined yet.");
2215                 return (NULL);
2216         }
2218         if (c_avl_get (data_sets, name, (void *) &ds) != 0)
2219         {
2220                 DEBUG ("No such dataset registered: %s", name);
2221                 return (NULL);
2222         }
2224         return (ds);
2225 } /* data_set_t *plugin_get_ds */
2227 static int plugin_notification_meta_add (notification_t *n,
2228     const char *name,
2229     enum notification_meta_type_e type,
2230     const void *value)
2232   notification_meta_t *meta;
2233   notification_meta_t *tail;
2235   if ((n == NULL) || (name == NULL) || (value == NULL))
2236   {
2237     ERROR ("plugin_notification_meta_add: A pointer is NULL!");
2238     return (-1);
2239   }
2241   meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
2242   if (meta == NULL)
2243   {
2244     ERROR ("plugin_notification_meta_add: malloc failed.");
2245     return (-1);
2246   }
2247   memset (meta, 0, sizeof (notification_meta_t));
2249   sstrncpy (meta->name, name, sizeof (meta->name));
2250   meta->type = type;
2252   switch (type)
2253   {
2254     case NM_TYPE_STRING:
2255     {
2256       meta->nm_value.nm_string = strdup ((const char *) value);
2257       if (meta->nm_value.nm_string == NULL)
2258       {
2259         ERROR ("plugin_notification_meta_add: strdup failed.");
2260         sfree (meta);
2261         return (-1);
2262       }
2263       break;
2264     }
2265     case NM_TYPE_SIGNED_INT:
2266     {
2267       meta->nm_value.nm_signed_int = *((int64_t *) value);
2268       break;
2269     }
2270     case NM_TYPE_UNSIGNED_INT:
2271     {
2272       meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
2273       break;
2274     }
2275     case NM_TYPE_DOUBLE:
2276     {
2277       meta->nm_value.nm_double = *((double *) value);
2278       break;
2279     }
2280     case NM_TYPE_BOOLEAN:
2281     {
2282       meta->nm_value.nm_boolean = *((_Bool *) value);
2283       break;
2284     }
2285     default:
2286     {
2287       ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
2288       sfree (meta);
2289       return (-1);
2290     }
2291   } /* switch (type) */
2293   meta->next = NULL;
2294   tail = n->meta;
2295   while ((tail != NULL) && (tail->next != NULL))
2296     tail = tail->next;
2298   if (tail == NULL)
2299     n->meta = meta;
2300   else
2301     tail->next = meta;
2303   return (0);
2304 } /* int plugin_notification_meta_add */
2306 int plugin_notification_meta_add_string (notification_t *n,
2307     const char *name,
2308     const char *value)
2310   return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
2313 int plugin_notification_meta_add_signed_int (notification_t *n,
2314     const char *name,
2315     int64_t value)
2317   return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
2320 int plugin_notification_meta_add_unsigned_int (notification_t *n,
2321     const char *name,
2322     uint64_t value)
2324   return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
2327 int plugin_notification_meta_add_double (notification_t *n,
2328     const char *name,
2329     double value)
2331   return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
2334 int plugin_notification_meta_add_boolean (notification_t *n,
2335     const char *name,
2336     _Bool value)
2338   return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
2341 int plugin_notification_meta_copy (notification_t *dst,
2342     const notification_t *src)
2344   notification_meta_t *meta;
2346   assert (dst != NULL);
2347   assert (src != NULL);
2348   assert (dst != src);
2349   assert ((src->meta == NULL) || (src->meta != dst->meta));
2351   for (meta = src->meta; meta != NULL; meta = meta->next)
2352   {
2353     if (meta->type == NM_TYPE_STRING)
2354       plugin_notification_meta_add_string (dst, meta->name,
2355           meta->nm_value.nm_string);
2356     else if (meta->type == NM_TYPE_SIGNED_INT)
2357       plugin_notification_meta_add_signed_int (dst, meta->name,
2358           meta->nm_value.nm_signed_int);
2359     else if (meta->type == NM_TYPE_UNSIGNED_INT)
2360       plugin_notification_meta_add_unsigned_int (dst, meta->name,
2361           meta->nm_value.nm_unsigned_int);
2362     else if (meta->type == NM_TYPE_DOUBLE)
2363       plugin_notification_meta_add_double (dst, meta->name,
2364           meta->nm_value.nm_double);
2365     else if (meta->type == NM_TYPE_BOOLEAN)
2366       plugin_notification_meta_add_boolean (dst, meta->name,
2367           meta->nm_value.nm_boolean);
2368   }
2370   return (0);
2371 } /* int plugin_notification_meta_copy */
2373 int plugin_notification_meta_free (notification_meta_t *n)
2375   notification_meta_t *this;
2376   notification_meta_t *next;
2378   if (n == NULL)
2379   {
2380     ERROR ("plugin_notification_meta_free: n == NULL!");
2381     return (-1);
2382   }
2384   this = n;
2385   while (this != NULL)
2386   {
2387     next = this->next;
2389     if (this->type == NM_TYPE_STRING)
2390     {
2391       free ((char *)this->nm_value.nm_string);
2392       this->nm_value.nm_string = NULL;
2393     }
2394     sfree (this);
2396     this = next;
2397   }
2399   return (0);
2400 } /* int plugin_notification_meta_free */
2402 static void plugin_ctx_destructor (void *ctx)
2404         sfree (ctx);
2405 } /* void plugin_ctx_destructor */
2407 static plugin_ctx_t ctx_init = { /* interval = */ 0 };
2409 static plugin_ctx_t *plugin_ctx_create (void)
2411         plugin_ctx_t *ctx;
2413         ctx = malloc (sizeof (*ctx));
2414         if (ctx == NULL) {
2415                 char errbuf[1024];
2416                 ERROR ("Failed to allocate plugin context: %s",
2417                                 sstrerror (errno, errbuf, sizeof (errbuf)));
2418                 return NULL;
2419         }
2421         *ctx = ctx_init;
2422         assert (plugin_ctx_key_initialized);
2423         pthread_setspecific (plugin_ctx_key, ctx);
2424         DEBUG("Created new plugin context.");
2425         return (ctx);
2426 } /* int plugin_ctx_create */
2428 void plugin_init_ctx (void)
2430         pthread_key_create (&plugin_ctx_key, plugin_ctx_destructor);
2431         plugin_ctx_key_initialized = 1;
2432 } /* void plugin_init_ctx */
2434 plugin_ctx_t plugin_get_ctx (void)
2436         plugin_ctx_t *ctx;
2438         assert (plugin_ctx_key_initialized);
2439         ctx = pthread_getspecific (plugin_ctx_key);
2441         if (ctx == NULL) {
2442                 ctx = plugin_ctx_create ();
2443                 /* this must no happen -- exit() instead? */
2444                 if (ctx == NULL)
2445                         return ctx_init;
2446         }
2448         return (*ctx);
2449 } /* plugin_ctx_t plugin_get_ctx */
2451 plugin_ctx_t plugin_set_ctx (plugin_ctx_t ctx)
2453         plugin_ctx_t *c;
2454         plugin_ctx_t old;
2456         assert (plugin_ctx_key_initialized);
2457         c = pthread_getspecific (plugin_ctx_key);
2459         if (c == NULL) {
2460                 c = plugin_ctx_create ();
2461                 /* this must no happen -- exit() instead? */
2462                 if (c == NULL)
2463                         return ctx_init;
2464         }
2466         old = *c;
2467         *c = ctx;
2469         return (old);
2470 } /* void plugin_set_ctx */
2472 cdtime_t plugin_get_interval (void)
2474         cdtime_t interval;
2476         interval = plugin_get_ctx().interval;
2477         if (interval > 0)
2478                 return interval;
2480         return cf_get_default_interval ();
2481 } /* cdtime_t plugin_get_interval */
2483 typedef struct {
2484         plugin_ctx_t ctx;
2485         void *(*start_routine) (void *);
2486         void *arg;
2487 } plugin_thread_t;
2489 static void *plugin_thread_start (void *arg)
2491         plugin_thread_t *plugin_thread = arg;
2493         void *(*start_routine) (void *) = plugin_thread->start_routine;
2494         void *plugin_arg = plugin_thread->arg;
2496         plugin_set_ctx (plugin_thread->ctx);
2498         free (plugin_thread);
2500         return start_routine (plugin_arg);
2501 } /* void *plugin_thread_start */
2503 int plugin_thread_create (pthread_t *thread, const pthread_attr_t *attr,
2504                 void *(*start_routine) (void *), void *arg)
2506         plugin_thread_t *plugin_thread;
2508         plugin_thread = malloc (sizeof (*plugin_thread));
2509         if (plugin_thread == NULL)
2510                 return -1;
2512         plugin_thread->ctx           = plugin_get_ctx ();
2513         plugin_thread->start_routine = start_routine;
2514         plugin_thread->arg           = arg;
2516         return pthread_create (thread, attr,
2517                         plugin_thread_start, plugin_thread);
2518 } /* int plugin_thread_create */
2520 /* vim: set sw=8 ts=8 noet fdm=marker : */