src/daemon/plugin.c

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