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