src/plugin.c

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