src/daemon/plugin.c

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