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