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