src/plugin.c

   1 /**
   2  * collectd - src/plugin.c
   3  * Copyright (C) 2005-2011  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at collectd.org>
  20  *   Sebastian Harl <sh at tokkee.org>
  21  **/
  22
  23 #include "collectd.h"
  24 #include "utils_complain.h"
  25
  26 #include <ltdl.h>
  27
  28 #if HAVE_PTHREAD_H
  29 # include <pthread.h>
  30 #endif
  31
  32 #include "common.h"
  33 #include "plugin.h"
  34 #include "configfile.h"
  35 #include "utils_avltree.h"
  36 #include "utils_llist.h"
  37 #include "utils_heap.h"
  38 #include "utils_cache.h"
  39 #include "filter_chain.h"
  40
  41 /*
  42  * Private structures
  43  */
  44 struct callback_func_s
  45 {
  46         void *cf_callback;
  47         user_data_t cf_udata;
  48 };
  49 typedef struct callback_func_s callback_func_t;
  50
  51 #define RF_SIMPLE  0
  52 #define RF_COMPLEX 1
  53 #define RF_REMOVE  65535
  54 struct read_func_s
  55 {
  56         /* `read_func_t' "inherits" from `callback_func_t'.
  57          * The `rf_super' member MUST be the first one in this structure! */
  58 #define rf_callback rf_super.cf_callback
  59 #define rf_udata rf_super.cf_udata
  60         callback_func_t rf_super;
  61         char rf_group[DATA_MAX_NAME_LEN];
  62         char rf_name[DATA_MAX_NAME_LEN];
  63         int rf_type;
  64         struct timespec rf_interval;
  65         struct timespec rf_effective_interval;
  66         struct timespec rf_next_read;
  67 };
  68 typedef struct read_func_s read_func_t;
  69
  70 /*
  71  * Private variables
  72  */
  73 static llist_t *list_init;
  74 static llist_t *list_write;
  75 static llist_t *list_flush;
  76 static llist_t *list_missing;
  77 static llist_t *list_shutdown;
  78 static llist_t *list_log;
  79 static llist_t *list_notification;
  80
  81 static fc_chain_t *pre_cache_chain = NULL;
  82 static fc_chain_t *post_cache_chain = NULL;
  83
  84 static c_avl_tree_t *data_sets;
  85
  86 static char *plugindir = NULL;
  87
  88 static c_heap_t       *read_heap = NULL;
  89 static llist_t        *read_list;
  90 static int             read_loop = 1;
  91 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
  92 static pthread_cond_t  read_cond = PTHREAD_COND_INITIALIZER;
  93 static pthread_t      *read_threads = NULL;
  94 static int             read_threads_num = 0;
  95
  96 /*
  97  * Static functions
  98  */
  99 static const char *plugin_get_dir (void)
 100 {
 101         if (plugindir == NULL)
 102                 return (PLUGINDIR);
 103         else
 104                 return (plugindir);
 105 }
 106
 107 static void destroy_callback (callback_func_t *cf) /* {{{ */
 108 {
 109         if (cf == NULL)
 110                 return;
 111
 112         if ((cf->cf_udata.data != NULL) && (cf->cf_udata.free_func != NULL))
 113         {
 114                 cf->cf_udata.free_func (cf->cf_udata.data);
 115                 cf->cf_udata.data = NULL;
 116                 cf->cf_udata.free_func = NULL;
 117         }
 118         sfree (cf);
 119 } /* }}} void destroy_callback */
 120
 121 static void destroy_all_callbacks (llist_t **list) /* {{{ */
 122 {
 123         llentry_t *le;
 124
 125         if (*list == NULL)
 126                 return;
 127
 128         le = llist_head (*list);
 129         while (le != NULL)
 130         {
 131                 llentry_t *le_next;
 132
 133                 le_next = le->next;
 134
 135                 sfree (le->key);
 136                 destroy_callback (le->value);
 137                 le->value = NULL;
 138
 139                 le = le_next;
 140         }
 141
 142         llist_destroy (*list);
 143         *list = NULL;
 144 } /* }}} void destroy_all_callbacks */
 145
 146 static void destroy_read_heap (void) /* {{{ */
 147 {
 148         if (read_heap == NULL)
 149                 return;
 150
 151         while (42)
 152         {
 153                 callback_func_t *cf;
 154
 155                 cf = c_heap_get_root (read_heap);
 156                 if (cf == NULL)
 157                         break;
 158
 159                 destroy_callback (cf);
 160         }
 161
 162         c_heap_destroy (read_heap);
 163         read_heap = NULL;
 164 } /* }}} void destroy_read_heap */
 165
 166 static int register_callback (llist_t **list, /* {{{ */
 167                 const char *name, callback_func_t *cf)
 168 {
 169         llentry_t *le;
 170         char *key;
 171
 172         if (*list == NULL)
 173         {
 174                 *list = llist_create ();
 175                 if (*list == NULL)
 176                 {
 177                         ERROR ("plugin: register_callback: "
 178                                         "llist_create failed.");
 179                         destroy_callback (cf);
 180                         return (-1);
 181                 }
 182         }
 183
 184         key = strdup (name);
 185         if (key == NULL)
 186         {
 187                 ERROR ("plugin: register_callback: strdup failed.");
 188                 destroy_callback (cf);
 189                 return (-1);
 190         }
 191
 192         le = llist_search (*list, name);
 193         if (le == NULL)
 194         {
 195                 le = llentry_create (key, cf);
 196                 if (le == NULL)
 197                 {
 198                         ERROR ("plugin: register_callback: "
 199                                         "llentry_create failed.");
 200                         free (key);
 201                         destroy_callback (cf);
 202                         return (-1);
 203                 }
 204
 205                 llist_append (*list, le);
 206         }
 207         else
 208         {
 209                 callback_func_t *old_cf;
 210
 211                 old_cf = le->value;
 212                 le->value = cf;
 213
 214                 WARNING ("plugin: register_callback: "
 215                                 "a callback named `%s' already exists - "
 216                                 "overwriting the old entry!", name);
 217
 218                 destroy_callback (old_cf);
 219                 sfree (key);
 220         }
 221
 222         return (0);
 223 } /* }}} int register_callback */
 224
 225 static int create_register_callback (llist_t **list, /* {{{ */
 226                 const char *name, void *callback, user_data_t *ud)
 227 {
 228         callback_func_t *cf;
 229
 230         cf = (callback_func_t *) malloc (sizeof (*cf));
 231         if (cf == NULL)
 232         {
 233                 ERROR ("plugin: create_register_callback: malloc failed.");
 234                 return (-1);
 235         }
 236         memset (cf, 0, sizeof (*cf));
 237
 238         cf->cf_callback = callback;
 239         if (ud == NULL)
 240         {
 241                 cf->cf_udata.data = NULL;
 242                 cf->cf_udata.free_func = NULL;
 243         }
 244         else
 245         {
 246                 cf->cf_udata = *ud;
 247         }
 248
 249         return (register_callback (list, name, cf));
 250 } /* }}} int create_register_callback */
 251
 252 static int plugin_unregister (llist_t *list, const char *name) /* {{{ */
 253 {
 254         llentry_t *e;
 255
 256         if (list == NULL)
 257                 return (-1);
 258
 259         e = llist_search (list, name);
 260         if (e == NULL)
 261                 return (-1);
 262
 263         llist_remove (list, e);
 264
 265         sfree (e->key);
 266         destroy_callback (e->value);
 267
 268         llentry_destroy (e);
 269
 270         return (0);
 271 } /* }}} int plugin_unregister */
 272
 273 /*
 274  * (Try to) load the shared object `file'. Won't complain if it isn't a shared
 275  * object, but it will bitch about a shared object not having a
 276  * ``module_register'' symbol..
 277  */
 278 static int plugin_load_file (char *file, uint32_t flags)
 279 {
 280         lt_dlhandle dlh;
 281         void (*reg_handle) (void);
 282
 283         DEBUG ("file = %s", file);
 284
 285         lt_dlinit ();
 286         lt_dlerror (); /* clear errors */
 287
 288 #if LIBTOOL_VERSION == 2
 289         if (flags & PLUGIN_FLAGS_GLOBAL) {
 290                 lt_dladvise advise;
 291                 lt_dladvise_init(&advise);
 292                 lt_dladvise_global(&advise);
 293                 dlh = lt_dlopenadvise(file, advise);
 294                 lt_dladvise_destroy(&advise);
 295         } else {
 296                 dlh = lt_dlopen (file);
 297         }
 298 #else /* if LIBTOOL_VERSION == 1 */
 299         if (flags & PLUGIN_FLAGS_GLOBAL)
 300                 ERROR ("plugin_load_file: The global flag is not supported, "
 301                                 "libtool 2 is required for this.");
 302         dlh = lt_dlopen (file);
 303 #endif
 304
 305         if (dlh == NULL)
 306         {
 307                 const char *error = lt_dlerror ();
 308
 309                 ERROR ("lt_dlopen (%s) failed: %s", file, error);
 310                 fprintf (stderr, "lt_dlopen (%s) failed: %s\n", file, error);
 311                 return (1);
 312         }
 313
 314         if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
 315         {
 316                 WARNING ("Couldn't find symbol `module_register' in `%s': %s\n",
 317                                 file, lt_dlerror ());
 318                 lt_dlclose (dlh);
 319                 return (-1);
 320         }
 321
 322         (*reg_handle) ();
 323
 324         return (0);
 325 }
 326
 327 static _Bool timeout_reached(struct timespec timeout)
 328 {
 329         struct timeval now;
 330         gettimeofday(&now, NULL);
 331         return (now.tv_sec >= timeout.tv_sec && now.tv_usec >= (timeout.tv_nsec / 1000));
 332 }
 333
 334 static void *plugin_read_thread (void __attribute__((unused)) *args)
 335 {
 336         while (read_loop != 0)
 337         {
 338                 read_func_t *rf;
 339                 cdtime_t now;
 340                 int status;
 341                 int rf_type;
 342                 int rc;
 343
 344                 /* Get the read function that needs to be read next. */
 345                 rf = c_heap_get_root (read_heap);
 346                 if (rf == NULL)
 347                 {
 348                         struct timespec abstime;
 349
 350                         now = cdtime ();
 351
 352                         CDTIME_T_TO_TIMESPEC (now + interval_g, &abstime);
 353
 354                         pthread_mutex_lock (&read_lock);
 355                         pthread_cond_timedwait (&read_cond, &read_lock,
 356                                         &abstime);
 357                         pthread_mutex_unlock (&read_lock);
 358                         continue;
 359                 }
 360
 361                 if ((rf->rf_interval.tv_sec == 0) && (rf->rf_interval.tv_nsec == 0))
 362                 {
 363                         now = cdtime ();
 364
 365                         CDTIME_T_TO_TIMESPEC (interval_g, &rf->rf_interval);
 366
 367                         rf->rf_effective_interval = rf->rf_interval;
 368
 369                         CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
 370                 }
 371
 372                 /* sleep until this entry is due,
 373                  * using pthread_cond_timedwait */
 374                 pthread_mutex_lock (&read_lock);
 375                 /* In pthread_cond_timedwait, spurious wakeups are possible
 376                  * (and really happen, at least on NetBSD with > 1 CPU), thus
 377                  * we need to re-evaluate the condition every time
 378                  * pthread_cond_timedwait returns. */
 379                 rc = 0;
 380                 while ((read_loop != 0)
 381                                 && !timeout_reached(rf->rf_next_read)
 382                                 && rc == 0)
 383                 {
 384                         rc = pthread_cond_timedwait (&read_cond, &read_lock,
 385                                 &rf->rf_next_read);
 386                 }
 387
 388                 /* Must hold `read_lock' when accessing `rf->rf_type'. */
 389                 rf_type = rf->rf_type;
 390                 pthread_mutex_unlock (&read_lock);
 391
 392                 /* Check if we're supposed to stop.. This may have interrupted
 393                  * the sleep, too. */
 394                 if (read_loop == 0)
 395                 {
 396                         /* Insert `rf' again, so it can be free'd correctly */
 397                         c_heap_insert (read_heap, rf);
 398                         break;
 399                 }
 400
 401                 /* The entry has been marked for deletion. The linked list
 402                  * entry has already been removed by `plugin_unregister_read'.
 403                  * All we have to do here is free the `read_func_t' and
 404                  * continue. */
 405                 if (rf_type == RF_REMOVE)
 406                 {
 407                         DEBUG ("plugin_read_thread: Destroying the `%s' "
 408                                         "callback.", rf->rf_name);
 409                         destroy_callback ((callback_func_t *) rf);
 410                         rf = NULL;
 411                         continue;
 412                 }
 413
 414                 DEBUG ("plugin_read_thread: Handling `%s'.", rf->rf_name);
 415
 416                 if (rf_type == RF_SIMPLE)
 417                 {
 418                         int (*callback) (void);
 419
 420                         callback = rf->rf_callback;
 421                         status = (*callback) ();
 422                 }
 423                 else
 424                 {
 425                         plugin_read_cb callback;
 426
 427                         assert (rf_type == RF_COMPLEX);
 428
 429                         callback = rf->rf_callback;
 430                         status = (*callback) (&rf->rf_udata);
 431                 }
 432
 433                 /* If the function signals failure, we will increase the
 434                  * intervals in which it will be called. */
 435                 if (status != 0)
 436                 {
 437                         rf->rf_effective_interval.tv_sec *= 2;
 438                         rf->rf_effective_interval.tv_nsec *= 2;
 439                         NORMALIZE_TIMESPEC (rf->rf_effective_interval);
 440
 441                         if (rf->rf_effective_interval.tv_sec >= 86400)
 442                         {
 443                                 rf->rf_effective_interval.tv_sec = 86400;
 444                                 rf->rf_effective_interval.tv_nsec = 0;
 445                         }
 446
 447                         NOTICE ("read-function of plugin `%s' failed. "
 448                                         "Will suspend it for %i seconds.",
 449                                         rf->rf_name,
 450                                         (int) rf->rf_effective_interval.tv_sec);
 451                 }
 452                 else
 453                 {
 454                         /* Success: Restore the interval, if it was changed. */
 455                         rf->rf_effective_interval = rf->rf_interval;
 456                 }
 457
 458                 /* update the ``next read due'' field */
 459                 now = cdtime ();
 460
 461                 DEBUG ("plugin_read_thread: Effective interval of the "
 462                                 "%s plugin is %i.%09i.",
 463                                 rf->rf_name,
 464                                 (int) rf->rf_effective_interval.tv_sec,
 465                                 (int) rf->rf_effective_interval.tv_nsec);
 466
 467                 /* Calculate the next (absolute) time at which this function
 468                  * should be called. */
 469                 rf->rf_next_read.tv_sec = rf->rf_next_read.tv_sec
 470                         + rf->rf_effective_interval.tv_sec;
 471                 rf->rf_next_read.tv_nsec = rf->rf_next_read.tv_nsec
 472                         + rf->rf_effective_interval.tv_nsec;
 473                 NORMALIZE_TIMESPEC (rf->rf_next_read);
 474
 475                 /* Check, if `rf_next_read' is in the past. */
 476                 if (TIMESPEC_TO_CDTIME_T (&rf->rf_next_read) < now)
 477                 {
 478                         /* `rf_next_read' is in the past. Insert `now'
 479                          * so this value doesn't trail off into the
 480                          * past too much. */
 481                         CDTIME_T_TO_TIMESPEC (now, &rf->rf_next_read);
 482                 }
 483
 484                 DEBUG ("plugin_read_thread: Next read of the %s plugin at %i.%09i.",
 485                                 rf->rf_name,
 486                                 (int) rf->rf_next_read.tv_sec,
 487                                 (int) rf->rf_next_read.tv_nsec);
 488
 489                 /* Re-insert this read function into the heap again. */
 490                 c_heap_insert (read_heap, rf);
 491         } /* while (read_loop) */
 492
 493         pthread_exit (NULL);
 494         return ((void *) 0);
 495 } /* void *plugin_read_thread */
 496
 497 static void start_read_threads (int num)
 498 {
 499         int i;
 500
 501         if (read_threads != NULL)
 502                 return;
 503
 504         read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
 505         if (read_threads == NULL)
 506         {
 507                 ERROR ("plugin: start_read_threads: calloc failed.");
 508                 return;
 509         }
 510
 511         read_threads_num = 0;
 512         for (i = 0; i < num; i++)
 513         {
 514                 if (pthread_create (read_threads + read_threads_num, NULL,
 515                                         plugin_read_thread, NULL) == 0)
 516                 {
 517                         read_threads_num++;
 518                 }
 519                 else
 520                 {
 521                         ERROR ("plugin: start_read_threads: pthread_create failed.");
 522                         return;
 523                 }
 524         } /* for (i) */
 525 } /* void start_read_threads */
 526
 527 static void stop_read_threads (void)
 528 {
 529         int i;
 530
 531         if (read_threads == NULL)
 532                 return;
 533
 534         INFO ("collectd: Stopping %i read threads.", read_threads_num);
 535
 536         pthread_mutex_lock (&read_lock);
 537         read_loop = 0;
 538         DEBUG ("plugin: stop_read_threads: Signalling `read_cond'");
 539         pthread_cond_broadcast (&read_cond);
 540         pthread_mutex_unlock (&read_lock);
 541
 542         for (i = 0; i < read_threads_num; i++)
 543         {
 544                 if (pthread_join (read_threads[i], NULL) != 0)
 545                 {
 546                         ERROR ("plugin: stop_read_threads: pthread_join failed.");
 547                 }
 548                 read_threads[i] = (pthread_t) 0;
 549         }
 550         sfree (read_threads);
 551         read_threads_num = 0;
 552 } /* void stop_read_threads */
 553
 554 /*
 555  * Public functions
 556  */
 557 void plugin_set_dir (const char *dir)
 558 {
 559         if (plugindir != NULL)
 560                 free (plugindir);
 561
 562         if (dir == NULL)
 563                 plugindir = NULL;
 564         else if ((plugindir = strdup (dir)) == NULL)
 565         {
 566                 char errbuf[1024];
 567                 ERROR ("strdup failed: %s",
 568                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 569         }
 570 }
 571
 572 #define BUFSIZE 512
 573 int plugin_load (const char *type, uint32_t flags)
 574 {
 575         DIR  *dh;
 576         const char *dir;
 577         char  filename[BUFSIZE] = "";
 578         char  typename[BUFSIZE];
 579         int   typename_len;
 580         int   ret;
 581         struct stat    statbuf;
 582         struct dirent *de;
 583         int status;
 584
 585         DEBUG ("type = %s", type);
 586
 587         dir = plugin_get_dir ();
 588         ret = 1;
 589
 590         /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
 591          * type when matching the filename */
 592         status = ssnprintf (typename, sizeof (typename), "%s.so", type);
 593         if ((status < 0) || ((size_t) status >= sizeof (typename)))
 594         {
 595                 WARNING ("snprintf: truncated: `%s.so'", type);
 596                 return (-1);
 597         }
 598         typename_len = strlen (typename);
 599
 600         if ((dh = opendir (dir)) == NULL)
 601         {
 602                 char errbuf[1024];
 603                 ERROR ("opendir (%s): %s", dir,
 604                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 605                 return (-1);
 606         }
 607
 608         while ((de = readdir (dh)) != NULL)
 609         {
 610                 if (strncasecmp (de->d_name, typename, typename_len))
 611                         continue;
 612
 613                 status = ssnprintf (filename, sizeof (filename),
 614                                 "%s/%s", dir, de->d_name);
 615                 if ((status < 0) || ((size_t) status >= sizeof (filename)))
 616                 {
 617                         WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
 618                         continue;
 619                 }
 620
 621                 if (lstat (filename, &statbuf) == -1)
 622                 {
 623                         char errbuf[1024];
 624                         WARNING ("stat %s: %s", filename,
 625                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 626                         continue;
 627                 }
 628                 else if (!S_ISREG (statbuf.st_mode))
 629                 {
 630                         /* don't follow symlinks */
 631                         WARNING ("stat %s: not a regular file", filename);
 632                         continue;
 633                 }
 634
 635                 if (plugin_load_file (filename, flags) == 0)
 636                 {
 637                         /* success */
 638                         ret = 0;
 639                         break;
 640                 }
 641                 else
 642                 {
 643                         fprintf (stderr, "Unable to load plugin %s.\n", type);
 644                 }
 645         }
 646
 647         closedir (dh);
 648
 649         if (filename[0] == '\0')
 650                 fprintf (stderr, "Could not find plugin %s.\n", type);
 651
 652         return (ret);
 653 }
 654
 655 /*
 656  * The `register_*' functions follow
 657  */
 658 int plugin_register_config (const char *name,
 659                 int (*callback) (const char *key, const char *val),
 660                 const char **keys, int keys_num)
 661 {
 662         cf_register (name, callback, keys, keys_num);
 663         return (0);
 664 } /* int plugin_register_config */
 665
 666 int plugin_register_complex_config (const char *type,
 667                 int (*callback) (oconfig_item_t *))
 668 {
 669         return (cf_register_complex (type, callback));
 670 } /* int plugin_register_complex_config */
 671
 672 int plugin_register_init (const char *name,
 673                 int (*callback) (void))
 674 {
 675         return (create_register_callback (&list_init, name, (void *) callback,
 676                                 /* user_data = */ NULL));
 677 } /* plugin_register_init */
 678
 679 static int plugin_compare_read_func (const void *arg0, const void *arg1)
 680 {
 681         const read_func_t *rf0;
 682         const read_func_t *rf1;
 683
 684         rf0 = arg0;
 685         rf1 = arg1;
 686
 687         if (rf0->rf_next_read.tv_sec < rf1->rf_next_read.tv_sec)
 688                 return (-1);
 689         else if (rf0->rf_next_read.tv_sec > rf1->rf_next_read.tv_sec)
 690                 return (1);
 691         else if (rf0->rf_next_read.tv_nsec < rf1->rf_next_read.tv_nsec)
 692                 return (-1);
 693         else if (rf0->rf_next_read.tv_nsec > rf1->rf_next_read.tv_nsec)
 694                 return (1);
 695         else
 696                 return (0);
 697 } /* int plugin_compare_read_func */
 698
 699 /* Add a read function to both, the heap and a linked list. The linked list if
 700  * used to look-up read functions, especially for the remove function. The heap
 701  * is used to determine which plugin to read next. */
 702 static int plugin_insert_read (read_func_t *rf)
 703 {
 704         int status;
 705         llentry_t *le;
 706
 707         pthread_mutex_lock (&read_lock);
 708
 709         if (read_list == NULL)
 710         {
 711                 read_list = llist_create ();
 712                 if (read_list == NULL)
 713                 {
 714                         pthread_mutex_unlock (&read_lock);
 715                         ERROR ("plugin_insert_read: read_list failed.");
 716                         return (-1);
 717                 }
 718         }
 719
 720         if (read_heap == NULL)
 721         {
 722                 read_heap = c_heap_create (plugin_compare_read_func);
 723                 if (read_heap == NULL)
 724                 {
 725                         pthread_mutex_unlock (&read_lock);
 726                         ERROR ("plugin_insert_read: c_heap_create failed.");
 727                         return (-1);
 728                 }
 729         }
 730
 731         le = llist_search (read_list, rf->rf_name);
 732         if (le != NULL)
 733         {
 734                 pthread_mutex_unlock (&read_lock);
 735                 WARNING ("The read function \"%s\" is already registered. "
 736                                 "Check for duplicate \"LoadPlugin\" lines "
 737                                 "in your configuration!",
 738                                 rf->rf_name);
 739                 return (EINVAL);
 740         }
 741
 742         le = llentry_create (rf->rf_name, rf);
 743         if (le == NULL)
 744         {
 745                 pthread_mutex_unlock (&read_lock);
 746                 ERROR ("plugin_insert_read: llentry_create failed.");
 747                 return (-1);
 748         }
 749
 750         status = c_heap_insert (read_heap, rf);
 751         if (status != 0)
 752         {
 753                 pthread_mutex_unlock (&read_lock);
 754                 ERROR ("plugin_insert_read: c_heap_insert failed.");
 755                 llentry_destroy (le);
 756                 return (-1);
 757         }
 758
 759         /* This does not fail. */
 760         llist_append (read_list, le);
 761
 762         pthread_mutex_unlock (&read_lock);
 763         return (0);
 764 } /* int plugin_insert_read */
 765
 766 int plugin_register_read (const char *name,
 767                 int (*callback) (void))
 768 {
 769         read_func_t *rf;
 770
 771         rf = (read_func_t *) malloc (sizeof (read_func_t));
 772         if (rf == NULL)
 773         {
 774                 char errbuf[1024];
 775                 ERROR ("plugin_register_read: malloc failed: %s",
 776                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 777                 return (-1);
 778         }
 779
 780         memset (rf, 0, sizeof (read_func_t));
 781         rf->rf_callback = (void *) callback;
 782         rf->rf_udata.data = NULL;
 783         rf->rf_udata.free_func = NULL;
 784         rf->rf_group[0] = '\0';
 785         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
 786         rf->rf_type = RF_SIMPLE;
 787         rf->rf_interval.tv_sec = 0;
 788         rf->rf_interval.tv_nsec = 0;
 789         rf->rf_effective_interval = rf->rf_interval;
 790
 791         return (plugin_insert_read (rf));
 792 } /* int plugin_register_read */
 793
 794 int plugin_register_complex_read (const char *group, const char *name,
 795                 plugin_read_cb callback,
 796                 const struct timespec *interval,
 797                 user_data_t *user_data)
 798 {
 799         read_func_t *rf;
 800
 801         rf = (read_func_t *) malloc (sizeof (read_func_t));
 802         if (rf == NULL)
 803         {
 804                 ERROR ("plugin_register_complex_read: malloc failed.");
 805                 return (-1);
 806         }
 807
 808         memset (rf, 0, sizeof (read_func_t));
 809         rf->rf_callback = (void *) callback;
 810         if (group != NULL)
 811                 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
 812         else
 813                 rf->rf_group[0] = '\0';
 814         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
 815         rf->rf_type = RF_COMPLEX;
 816         if (interval != NULL)
 817         {
 818                 rf->rf_interval = *interval;
 819         }
 820         rf->rf_effective_interval = rf->rf_interval;
 821
 822         /* Set user data */
 823         if (user_data == NULL)
 824         {
 825                 rf->rf_udata.data = NULL;
 826                 rf->rf_udata.free_func = NULL;
 827         }
 828         else
 829         {
 830                 rf->rf_udata = *user_data;
 831         }
 832
 833         return (plugin_insert_read (rf));
 834 } /* int plugin_register_complex_read */
 835
 836 int plugin_register_write (const char *name,
 837                 plugin_write_cb callback, user_data_t *ud)
 838 {
 839         return (create_register_callback (&list_write, name,
 840                                 (void *) callback, ud));
 841 } /* int plugin_register_write */
 842
 843 int plugin_register_flush (const char *name,
 844                 plugin_flush_cb callback, user_data_t *ud)
 845 {
 846         return (create_register_callback (&list_flush, name,
 847                                 (void *) callback, ud));
 848 } /* int plugin_register_flush */
 849
 850 int plugin_register_missing (const char *name,
 851                 plugin_missing_cb callback, user_data_t *ud)
 852 {
 853         return (create_register_callback (&list_missing, name,
 854                                 (void *) callback, ud));
 855 } /* int plugin_register_missing */
 856
 857 int plugin_register_shutdown (char *name,
 858                 int (*callback) (void))
 859 {
 860         return (create_register_callback (&list_shutdown, name,
 861                                 (void *) callback, /* user_data = */ NULL));
 862 } /* int plugin_register_shutdown */
 863
 864 int plugin_register_data_set (const data_set_t *ds)
 865 {
 866         data_set_t *ds_copy;
 867         int i;
 868
 869         if ((data_sets != NULL)
 870                         && (c_avl_get (data_sets, ds->type, NULL) == 0))
 871         {
 872                 NOTICE ("Replacing DS `%s' with another version.", ds->type);
 873                 plugin_unregister_data_set (ds->type);
 874         }
 875         else if (data_sets == NULL)
 876         {
 877                 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
 878                 if (data_sets == NULL)
 879                         return (-1);
 880         }
 881
 882         ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
 883         if (ds_copy == NULL)
 884                 return (-1);
 885         memcpy(ds_copy, ds, sizeof (data_set_t));
 886
 887         ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
 888                         * ds->ds_num);
 889         if (ds_copy->ds == NULL)
 890         {
 891                 free (ds_copy);
 892                 return (-1);
 893         }
 894
 895         for (i = 0; i < ds->ds_num; i++)
 896                 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
 897
 898         return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
 899 } /* int plugin_register_data_set */
 900
 901 int plugin_register_log (const char *name,
 902                 plugin_log_cb callback, user_data_t *ud)
 903 {
 904         return (create_register_callback (&list_log, name,
 905                                 (void *) callback, ud));
 906 } /* int plugin_register_log */
 907
 908 int plugin_register_notification (const char *name,
 909                 plugin_notification_cb callback, user_data_t *ud)
 910 {
 911         return (create_register_callback (&list_notification, name,
 912                                 (void *) callback, ud));
 913 } /* int plugin_register_log */
 914
 915 int plugin_unregister_config (const char *name)
 916 {
 917         cf_unregister (name);
 918         return (0);
 919 } /* int plugin_unregister_config */
 920
 921 int plugin_unregister_complex_config (const char *name)
 922 {
 923         cf_unregister_complex (name);
 924         return (0);
 925 } /* int plugin_unregister_complex_config */
 926
 927 int plugin_unregister_init (const char *name)
 928 {
 929         return (plugin_unregister (list_init, name));
 930 }
 931
 932 int plugin_unregister_read (const char *name) /* {{{ */
 933 {
 934         llentry_t *le;
 935         read_func_t *rf;
 936
 937         if (name == NULL)
 938                 return (-ENOENT);
 939
 940         pthread_mutex_lock (&read_lock);
 941
 942         if (read_list == NULL)
 943         {
 944                 pthread_mutex_unlock (&read_lock);
 945                 return (-ENOENT);
 946         }
 947
 948         le = llist_search (read_list, name);
 949         if (le == NULL)
 950         {
 951                 pthread_mutex_unlock (&read_lock);
 952                 WARNING ("plugin_unregister_read: No such read function: %s",
 953                                 name);
 954                 return (-ENOENT);
 955         }
 956
 957         llist_remove (read_list, le);
 958
 959         rf = le->value;
 960         assert (rf != NULL);
 961         rf->rf_type = RF_REMOVE;
 962
 963         pthread_mutex_unlock (&read_lock);
 964
 965         llentry_destroy (le);
 966
 967         DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
 968
 969         return (0);
 970 } /* }}} int plugin_unregister_read */
 971
 972 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
 973 {
 974         read_func_t *rf    = e->value;
 975         char        *group = ud;
 976
 977         return strcmp (rf->rf_group, (const char *)group);
 978 } /* }}} int compare_read_func_group */
 979
 980 int plugin_unregister_read_group (const char *group) /* {{{ */
 981 {
 982         llentry_t *le;
 983         read_func_t *rf;
 984
 985         int found = 0;
 986
 987         if (group == NULL)
 988                 return (-ENOENT);
 989
 990         pthread_mutex_lock (&read_lock);
 991
 992         if (read_list == NULL)
 993         {
 994                 pthread_mutex_unlock (&read_lock);
 995                 return (-ENOENT);
 996         }
 997
 998         while (42)
 999         {
1000                 le = llist_search_custom (read_list,
1001                                 compare_read_func_group, (void *)group);
1002
1003                 if (le == NULL)
1004                         break;
1005
1006                 ++found;
1007
1008                 llist_remove (read_list, le);
1009
1010                 rf = le->value;
1011                 assert (rf != NULL);
1012                 rf->rf_type = RF_REMOVE;
1013
1014                 llentry_destroy (le);
1015
1016                 DEBUG ("plugin_unregister_read_group: "
1017                                 "Marked `%s' (group `%s') for removal.",
1018                                 rf->rf_name, group);
1019         }
1020
1021         pthread_mutex_unlock (&read_lock);
1022
1023         if (found == 0)
1024         {
1025                 WARNING ("plugin_unregister_read_group: No such "
1026                                 "group of read function: %s", group);
1027                 return (-ENOENT);
1028         }
1029
1030         return (0);
1031 } /* }}} int plugin_unregister_read_group */
1032
1033 int plugin_unregister_write (const char *name)
1034 {
1035         return (plugin_unregister (list_write, name));
1036 }
1037
1038 int plugin_unregister_flush (const char *name)
1039 {
1040         return (plugin_unregister (list_flush, name));
1041 }
1042
1043 int plugin_unregister_missing (const char *name)
1044 {
1045         return (plugin_unregister (list_missing, name));
1046 }
1047
1048 int plugin_unregister_shutdown (const char *name)
1049 {
1050         return (plugin_unregister (list_shutdown, name));
1051 }
1052
1053 int plugin_unregister_data_set (const char *name)
1054 {
1055         data_set_t *ds;
1056
1057         if (data_sets == NULL)
1058                 return (-1);
1059
1060         if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1061                 return (-1);
1062
1063         sfree (ds->ds);
1064         sfree (ds);
1065
1066         return (0);
1067 } /* int plugin_unregister_data_set */
1068
1069 int plugin_unregister_log (const char *name)
1070 {
1071         return (plugin_unregister (list_log, name));
1072 }
1073
1074 int plugin_unregister_notification (const char *name)
1075 {
1076         return (plugin_unregister (list_notification, name));
1077 }
1078
1079 void plugin_init_all (void)
1080 {
1081         const char *chain_name;
1082         llentry_t *le;
1083         int status;
1084
1085         /* Init the value cache */
1086         uc_init ();
1087
1088         chain_name = global_option_get ("PreCacheChain");
1089         pre_cache_chain = fc_chain_get_by_name (chain_name);
1090
1091         chain_name = global_option_get ("PostCacheChain");
1092         post_cache_chain = fc_chain_get_by_name (chain_name);
1093
1094
1095         if ((list_init == NULL) && (read_heap == NULL))
1096                 return;
1097
1098         /* Calling all init callbacks before checking if read callbacks
1099          * are available allows the init callbacks to register the read
1100          * callback. */
1101         le = llist_head (list_init);
1102         while (le != NULL)
1103         {
1104                 callback_func_t *cf;
1105                 plugin_init_cb callback;
1106
1107                 cf = le->value;
1108                 callback = cf->cf_callback;
1109                 status = (*callback) ();
1110
1111                 if (status != 0)
1112                 {
1113                         ERROR ("Initialization of plugin `%s' "
1114                                         "failed with status %i. "
1115                                         "Plugin will be unloaded.",
1116                                         le->key, status);
1117                         /* Plugins that register read callbacks from the init
1118                          * callback should take care of appropriate error
1119                          * handling themselves. */
1120                         /* FIXME: Unload _all_ functions */
1121                         plugin_unregister_read (le->key);
1122                 }
1123
1124                 le = le->next;
1125         }
1126
1127         /* Start read-threads */
1128         if (read_heap != NULL)
1129         {
1130                 const char *rt;
1131                 int num;
1132                 rt = global_option_get ("ReadThreads");
1133                 num = atoi (rt);
1134                 if (num != -1)
1135                         start_read_threads ((num > 0) ? num : 5);
1136         }
1137 } /* void plugin_init_all */
1138
1139 /* TODO: Rename this function. */
1140 void plugin_read_all (void)
1141 {
1142         uc_check_timeout ();
1143
1144         return;
1145 } /* void plugin_read_all */
1146
1147 /* Read function called when the `-T' command line argument is given. */
1148 int plugin_read_all_once (void)
1149 {
1150         int status;
1151         int return_status = 0;
1152
1153         if (read_heap == NULL)
1154         {
1155                 NOTICE ("No read-functions are registered.");
1156                 return (0);
1157         }
1158
1159         while (42)
1160         {
1161                 read_func_t *rf;
1162
1163                 rf = c_heap_get_root (read_heap);
1164                 if (rf == NULL)
1165                         break;
1166
1167                 if (rf->rf_type == RF_SIMPLE)
1168                 {
1169                         int (*callback) (void);
1170
1171                         callback = rf->rf_callback;
1172                         status = (*callback) ();
1173                 }
1174                 else
1175                 {
1176                         plugin_read_cb callback;
1177
1178                         callback = rf->rf_callback;
1179                         status = (*callback) (&rf->rf_udata);
1180                 }
1181
1182                 if (status != 0)
1183                 {
1184                         NOTICE ("read-function of plugin `%s' failed.",
1185                                         rf->rf_name);
1186                         return_status = -1;
1187                 }
1188
1189                 destroy_callback ((void *) rf);
1190         }
1191
1192         return (return_status);
1193 } /* int plugin_read_all_once */
1194
1195 int plugin_write (const char *plugin, /* {{{ */
1196                 const data_set_t *ds, const value_list_t *vl)
1197 {
1198   llentry_t *le;
1199   int status;
1200
1201   if (vl == NULL)
1202     return (EINVAL);
1203
1204   if (list_write == NULL)
1205     return (ENOENT);
1206
1207   if (ds == NULL)
1208   {
1209     ds = plugin_get_ds (vl->type);
1210     if (ds == NULL)
1211     {
1212       ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1213       return (ENOENT);
1214     }
1215   }
1216
1217   if (plugin == NULL)
1218   {
1219     int success = 0;
1220     int failure = 0;
1221
1222     le = llist_head (list_write);
1223     while (le != NULL)
1224     {
1225       callback_func_t *cf = le->value;
1226       plugin_write_cb callback;
1227
1228       DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1229       callback = cf->cf_callback;
1230       status = (*callback) (ds, vl, &cf->cf_udata);
1231       if (status != 0)
1232         failure++;
1233       else
1234         success++;
1235
1236       le = le->next;
1237     }
1238
1239     if ((success == 0) && (failure != 0))
1240       status = -1;
1241     else
1242       status = 0;
1243   }
1244   else /* plugin != NULL */
1245   {
1246     callback_func_t *cf;
1247     plugin_write_cb callback;
1248
1249     le = llist_head (list_write);
1250     while (le != NULL)
1251     {
1252       if (strcasecmp (plugin, le->key) == 0)
1253         break;
1254
1255       le = le->next;
1256     }
1257
1258     if (le == NULL)
1259       return (ENOENT);
1260
1261     cf = le->value;
1262
1263     DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1264     callback = cf->cf_callback;
1265     status = (*callback) (ds, vl, &cf->cf_udata);
1266   }
1267
1268   return (status);
1269 } /* }}} int plugin_write */
1270
1271 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1272 {
1273   llentry_t *le;
1274
1275   if (list_flush == NULL)
1276     return (0);
1277
1278   le = llist_head (list_flush);
1279   while (le != NULL)
1280   {
1281     callback_func_t *cf;
1282     plugin_flush_cb callback;
1283
1284     if ((plugin != NULL)
1285         && (strcmp (plugin, le->key) != 0))
1286     {
1287       le = le->next;
1288       continue;
1289     }
1290
1291     cf = le->value;
1292     callback = cf->cf_callback;
1293
1294     (*callback) (timeout, identifier, &cf->cf_udata);
1295
1296     le = le->next;
1297   }
1298   return (0);
1299 } /* int plugin_flush */
1300
1301 void plugin_shutdown_all (void)
1302 {
1303         llentry_t *le;
1304
1305         stop_read_threads ();
1306
1307         destroy_all_callbacks (&list_init);
1308
1309         pthread_mutex_lock (&read_lock);
1310         llist_destroy (read_list);
1311         read_list = NULL;
1312         pthread_mutex_unlock (&read_lock);
1313
1314         destroy_read_heap ();
1315
1316         plugin_flush (/* plugin = */ NULL,
1317                         /* timeout = */ 0,
1318                         /* identifier = */ NULL);
1319
1320         le = NULL;
1321         if (list_shutdown != NULL)
1322                 le = llist_head (list_shutdown);
1323
1324         while (le != NULL)
1325         {
1326                 callback_func_t *cf;
1327                 plugin_shutdown_cb callback;
1328
1329                 cf = le->value;
1330                 callback = cf->cf_callback;
1331
1332                 /* Advance the pointer before calling the callback allows
1333                  * shutdown functions to unregister themselves. If done the
1334                  * other way around the memory `le' points to will be freed
1335                  * after callback returns. */
1336                 le = le->next;
1337
1338                 (*callback) ();
1339         }
1340
1341         /* Write plugins which use the `user_data' pointer usually need the
1342          * same data available to the flush callback. If this is the case, set
1343          * the free_function to NULL when registering the flush callback and to
1344          * the real free function when registering the write callback. This way
1345          * the data isn't freed twice. */
1346         destroy_all_callbacks (&list_flush);
1347         destroy_all_callbacks (&list_missing);
1348         destroy_all_callbacks (&list_write);
1349
1350         destroy_all_callbacks (&list_notification);
1351         destroy_all_callbacks (&list_shutdown);
1352         destroy_all_callbacks (&list_log);
1353 } /* void plugin_shutdown_all */
1354
1355 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1356 {
1357   llentry_t *le;
1358
1359   if (list_missing == NULL)
1360     return (0);
1361
1362   le = llist_head (list_missing);
1363   while (le != NULL)
1364   {
1365     callback_func_t *cf;
1366     plugin_missing_cb callback;
1367     int status;
1368
1369     cf = le->value;
1370     callback = cf->cf_callback;
1371
1372     status = (*callback) (vl, &cf->cf_udata);
1373     if (status != 0)
1374     {
1375       if (status < 0)
1376       {
1377         ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1378             "failed with status %i.",
1379             le->key, status);
1380         return (status);
1381       }
1382       else
1383       {
1384         return (0);
1385       }
1386     }
1387
1388     le = le->next;
1389   }
1390   return (0);
1391 } /* int }}} plugin_dispatch_missing */
1392
1393 int plugin_dispatch_values (value_list_t *vl)
1394 {
1395         int status;
1396         static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1397
1398         value_t *saved_values;
1399         int      saved_values_len;
1400
1401         data_set_t *ds;
1402
1403         int free_meta_data = 0;
1404
1405         if ((vl == NULL) || (vl->type[0] == 0)
1406                         || (vl->values == NULL) || (vl->values_len < 1))
1407         {
1408                 ERROR ("plugin_dispatch_values: Invalid value list.");
1409                 return (-1);
1410         }
1411
1412         /* Free meta data only if the calling function didn't specify any. In
1413          * this case matches and targets may add some and the calling function
1414          * may not expect (and therefore free) that data. */
1415         if (vl->meta == NULL)
1416                 free_meta_data = 1;
1417
1418         if (list_write == NULL)
1419                 c_complain_once (LOG_WARNING, &no_write_complaint,
1420                                 "plugin_dispatch_values: No write callback has been "
1421                                 "registered. Please load at least one output plugin, "
1422                                 "if you want the collected data to be stored.");
1423
1424         if (data_sets == NULL)
1425         {
1426                 ERROR ("plugin_dispatch_values: No data sets registered. "
1427                                 "Could the types database be read? Check "
1428                                 "your `TypesDB' setting!");
1429                 return (-1);
1430         }
1431
1432         if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1433         {
1434                 char ident[6 * DATA_MAX_NAME_LEN];
1435
1436                 FORMAT_VL (ident, sizeof (ident), vl);
1437                 INFO ("plugin_dispatch_values: Dataset not found: %s "
1438                                 "(from \"%s\"), check your types.db!",
1439                                 vl->type, ident);
1440                 return (-1);
1441         }
1442
1443         if (vl->time == 0)
1444                 vl->time = cdtime ();
1445
1446         if (vl->interval <= 0)
1447                 vl->interval = interval_g;
1448
1449         DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1450                         "host = %s; "
1451                         "plugin = %s; plugin_instance = %s; "
1452                         "type = %s; type_instance = %s;",
1453                         CDTIME_T_TO_DOUBLE (vl->time),
1454                         CDTIME_T_TO_DOUBLE (vl->interval),
1455                         vl->host,
1456                         vl->plugin, vl->plugin_instance,
1457                         vl->type, vl->type_instance);
1458
1459 #if COLLECT_DEBUG
1460         assert (0 == strcmp (ds->type, vl->type));
1461 #else
1462         if (0 != strcmp (ds->type, vl->type))
1463                 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1464                                 ds->type, vl->type);
1465 #endif
1466
1467 #if COLLECT_DEBUG
1468         assert (ds->ds_num == vl->values_len);
1469 #else
1470         if (ds->ds_num != vl->values_len)
1471         {
1472                 ERROR ("plugin_dispatch_values: ds->type = %s: "
1473                                 "(ds->ds_num = %i) != "
1474                                 "(vl->values_len = %i)",
1475                                 ds->type, ds->ds_num, vl->values_len);
1476                 return (-1);
1477         }
1478 #endif
1479
1480         escape_slashes (vl->host, sizeof (vl->host));
1481         escape_slashes (vl->plugin, sizeof (vl->plugin));
1482         escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1483         escape_slashes (vl->type, sizeof (vl->type));
1484         escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1485
1486         /* Copy the values. This way, we can assure `targets' that they get
1487          * dynamically allocated values, which they can free and replace if
1488          * they like. */
1489         if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1490         {
1491                 saved_values     = vl->values;
1492                 saved_values_len = vl->values_len;
1493
1494                 vl->values = (value_t *) calloc (vl->values_len,
1495                                 sizeof (*vl->values));
1496                 if (vl->values == NULL)
1497                 {
1498                         ERROR ("plugin_dispatch_values: calloc failed.");
1499                         vl->values = saved_values;
1500                         return (-1);
1501                 }
1502                 memcpy (vl->values, saved_values,
1503                                 vl->values_len * sizeof (*vl->values));
1504         }
1505         else /* if ((pre == NULL) && (post == NULL)) */
1506         {
1507                 saved_values     = NULL;
1508                 saved_values_len = 0;
1509         }
1510
1511         if (pre_cache_chain != NULL)
1512         {
1513                 status = fc_process_chain (ds, vl, pre_cache_chain);
1514                 if (status < 0)
1515                 {
1516                         WARNING ("plugin_dispatch_values: Running the "
1517                                         "pre-cache chain failed with "
1518                                         "status %i (%#x).",
1519                                         status, status);
1520                 }
1521                 else if (status == FC_TARGET_STOP)
1522                 {
1523                         /* Restore the state of the value_list so that plugins
1524                          * don't get confused.. */
1525                         if (saved_values != NULL)
1526                         {
1527                                 free (vl->values);
1528                                 vl->values     = saved_values;
1529                                 vl->values_len = saved_values_len;
1530                         }
1531                         return (0);
1532                 }
1533         }
1534
1535         /* Update the value cache */
1536         uc_update (ds, vl);
1537
1538         if (post_cache_chain != NULL)
1539         {
1540                 status = fc_process_chain (ds, vl, post_cache_chain);
1541                 if (status < 0)
1542                 {
1543                         WARNING ("plugin_dispatch_values: Running the "
1544                                         "post-cache chain failed with "
1545                                         "status %i (%#x).",
1546                                         status, status);
1547                 }
1548         }
1549         else
1550                 fc_default_action (ds, vl);
1551
1552         /* Restore the state of the value_list so that plugins don't get
1553          * confused.. */
1554         if (saved_values != NULL)
1555         {
1556                 free (vl->values);
1557                 vl->values     = saved_values;
1558                 vl->values_len = saved_values_len;
1559         }
1560
1561         if ((free_meta_data != 0) && (vl->meta != NULL))
1562         {
1563                 meta_data_destroy (vl->meta);
1564                 vl->meta = NULL;
1565         }
1566
1567         return (0);
1568 } /* int plugin_dispatch_values */
1569
1570 int plugin_dispatch_notification (const notification_t *notif)
1571 {
1572         llentry_t *le;
1573         /* Possible TODO: Add flap detection here */
1574
1575         DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1576                         "time = %.3f; host = %s;",
1577                         notif->severity, notif->message,
1578                         CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1579
1580         /* Nobody cares for notifications */
1581         if (list_notification == NULL)
1582                 return (-1);
1583
1584         le = llist_head (list_notification);
1585         while (le != NULL)
1586         {
1587                 callback_func_t *cf;
1588                 plugin_notification_cb callback;
1589                 int status;
1590
1591                 cf = le->value;
1592                 callback = cf->cf_callback;
1593                 status = (*callback) (notif, &cf->cf_udata);
1594                 if (status != 0)
1595                 {
1596                         WARNING ("plugin_dispatch_notification: Notification "
1597                                         "callback %s returned %i.",
1598                                         le->key, status);
1599                 }
1600
1601                 le = le->next;
1602         }
1603
1604         return (0);
1605 } /* int plugin_dispatch_notification */
1606
1607 void plugin_log (int level, const char *format, ...)
1608 {
1609         char msg[1024];
1610         va_list ap;
1611         llentry_t *le;
1612
1613 #if !COLLECT_DEBUG
1614         if (level >= LOG_DEBUG)
1615                 return;
1616 #endif
1617
1618         va_start (ap, format);
1619         vsnprintf (msg, sizeof (msg), format, ap);
1620         msg[sizeof (msg) - 1] = '\0';
1621         va_end (ap);
1622
1623         if (list_log == NULL)
1624         {
1625                 fprintf (stderr, "%s\n", msg);
1626                 return;
1627         }
1628
1629         le = llist_head (list_log);
1630         while (le != NULL)
1631         {
1632                 callback_func_t *cf;
1633                 plugin_log_cb callback;
1634
1635                 cf = le->value;
1636                 callback = cf->cf_callback;
1637
1638                 (*callback) (level, msg, &cf->cf_udata);
1639
1640                 le = le->next;
1641         }
1642 } /* void plugin_log */
1643
1644 const data_set_t *plugin_get_ds (const char *name)
1645 {
1646         data_set_t *ds;
1647
1648         if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1649         {
1650                 DEBUG ("No such dataset registered: %s", name);
1651                 return (NULL);
1652         }
1653
1654         return (ds);
1655 } /* data_set_t *plugin_get_ds */
1656
1657 static int plugin_notification_meta_add (notification_t *n,
1658     const char *name,
1659     enum notification_meta_type_e type,
1660     const void *value)
1661 {
1662   notification_meta_t *meta;
1663   notification_meta_t *tail;
1664
1665   if ((n == NULL) || (name == NULL) || (value == NULL))
1666   {
1667     ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1668     return (-1);
1669   }
1670
1671   meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1672   if (meta == NULL)
1673   {
1674     ERROR ("plugin_notification_meta_add: malloc failed.");
1675     return (-1);
1676   }
1677   memset (meta, 0, sizeof (notification_meta_t));
1678
1679   sstrncpy (meta->name, name, sizeof (meta->name));
1680   meta->type = type;
1681
1682   switch (type)
1683   {
1684     case NM_TYPE_STRING:
1685     {
1686       meta->nm_value.nm_string = strdup ((const char *) value);
1687       if (meta->nm_value.nm_string == NULL)
1688       {
1689         ERROR ("plugin_notification_meta_add: strdup failed.");
1690         sfree (meta);
1691         return (-1);
1692       }
1693       break;
1694     }
1695     case NM_TYPE_SIGNED_INT:
1696     {
1697       meta->nm_value.nm_signed_int = *((int64_t *) value);
1698       break;
1699     }
1700     case NM_TYPE_UNSIGNED_INT:
1701     {
1702       meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1703       break;
1704     }
1705     case NM_TYPE_DOUBLE:
1706     {
1707       meta->nm_value.nm_double = *((double *) value);
1708       break;
1709     }
1710     case NM_TYPE_BOOLEAN:
1711     {
1712       meta->nm_value.nm_boolean = *((_Bool *) value);
1713       break;
1714     }
1715     default:
1716     {
1717       ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1718       sfree (meta);
1719       return (-1);
1720     }
1721   } /* switch (type) */
1722
1723   meta->next = NULL;
1724   tail = n->meta;
1725   while ((tail != NULL) && (tail->next != NULL))
1726     tail = tail->next;
1727
1728   if (tail == NULL)
1729     n->meta = meta;
1730   else
1731     tail->next = meta;
1732
1733   return (0);
1734 } /* int plugin_notification_meta_add */
1735
1736 int plugin_notification_meta_add_string (notification_t *n,
1737     const char *name,
1738     const char *value)
1739 {
1740   return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1741 }
1742
1743 int plugin_notification_meta_add_signed_int (notification_t *n,
1744     const char *name,
1745     int64_t value)
1746 {
1747   return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1748 }
1749
1750 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1751     const char *name,
1752     uint64_t value)
1753 {
1754   return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1755 }
1756
1757 int plugin_notification_meta_add_double (notification_t *n,
1758     const char *name,
1759     double value)
1760 {
1761   return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1762 }
1763
1764 int plugin_notification_meta_add_boolean (notification_t *n,
1765     const char *name,
1766     _Bool value)
1767 {
1768   return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1769 }
1770
1771 int plugin_notification_meta_copy (notification_t *dst,
1772     const notification_t *src)
1773 {
1774   notification_meta_t *meta;
1775
1776   assert (dst != NULL);
1777   assert (src != NULL);
1778   assert (dst != src);
1779   assert ((src->meta == NULL) || (src->meta != dst->meta));
1780
1781   for (meta = src->meta; meta != NULL; meta = meta->next)
1782   {
1783     if (meta->type == NM_TYPE_STRING)
1784       plugin_notification_meta_add_string (dst, meta->name,
1785           meta->nm_value.nm_string);
1786     else if (meta->type == NM_TYPE_SIGNED_INT)
1787       plugin_notification_meta_add_signed_int (dst, meta->name,
1788           meta->nm_value.nm_signed_int);
1789     else if (meta->type == NM_TYPE_UNSIGNED_INT)
1790       plugin_notification_meta_add_unsigned_int (dst, meta->name,
1791           meta->nm_value.nm_unsigned_int);
1792     else if (meta->type == NM_TYPE_DOUBLE)
1793       plugin_notification_meta_add_double (dst, meta->name,
1794           meta->nm_value.nm_double);
1795     else if (meta->type == NM_TYPE_BOOLEAN)
1796       plugin_notification_meta_add_boolean (dst, meta->name,
1797           meta->nm_value.nm_boolean);
1798   }
1799
1800   return (0);
1801 } /* int plugin_notification_meta_copy */
1802
1803 int plugin_notification_meta_free (notification_meta_t *n)
1804 {
1805   notification_meta_t *this;
1806   notification_meta_t *next;
1807
1808   if (n == NULL)
1809   {
1810     ERROR ("plugin_notification_meta_free: n == NULL!");
1811     return (-1);
1812   }
1813
1814   this = n;
1815   while (this != NULL)
1816   {
1817     next = this->next;
1818
1819     if (this->type == NM_TYPE_STRING)
1820     {
1821       free ((char *)this->nm_value.nm_string);
1822       this->nm_value.nm_string = NULL;
1823     }
1824     sfree (this);
1825
1826     this = next;
1827   }
1828
1829   return (0);
1830 } /* int plugin_notification_meta_free */
1831
1832 /* vim: set sw=8 ts=8 noet fdm=marker : */