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