src/plugin.c

   1 /**
   2  * collectd - src/plugin.c
   3  * Copyright (C) 2005-2010  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                 le = llentry_create (rf->rf_name, rf);
 735                 if (le == NULL)
 736                 {
 737                         pthread_mutex_unlock (&read_lock);
 738                         ERROR ("plugin_insert_read: llentry_create failed.");
 739                         return (-1);
 740                 }
 741
 742                 status = c_heap_insert (read_heap, rf);
 743                 if (status != 0)
 744                 {
 745                         pthread_mutex_unlock (&read_lock);
 746                         ERROR ("plugin_insert_read: c_heap_insert failed.");
 747                         llentry_destroy (le);
 748                         return (-1);
 749                 }
 750
 751                 /* This does not fail. */
 752                 llist_append (read_list, le);
 753         }
 754         else
 755         {
 756                 INFO ("plugin: plugin_insert_read: "
 757                                 "read function for plugin `%s' already added.",
 758                                 rf->rf_name);
 759         }
 760
 761         pthread_mutex_unlock (&read_lock);
 762         return (0);
 763 } /* int plugin_insert_read */
 764
 765 int plugin_register_read (const char *name,
 766                 int (*callback) (void))
 767 {
 768         read_func_t *rf;
 769
 770         rf = (read_func_t *) malloc (sizeof (read_func_t));
 771         if (rf == NULL)
 772         {
 773                 char errbuf[1024];
 774                 ERROR ("plugin_register_read: malloc failed: %s",
 775                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 776                 return (-1);
 777         }
 778
 779         memset (rf, 0, sizeof (read_func_t));
 780         rf->rf_callback = (void *) callback;
 781         rf->rf_udata.data = NULL;
 782         rf->rf_udata.free_func = NULL;
 783         rf->rf_group[0] = '\0';
 784         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
 785         rf->rf_type = RF_SIMPLE;
 786         rf->rf_interval.tv_sec = 0;
 787         rf->rf_interval.tv_nsec = 0;
 788         rf->rf_effective_interval = rf->rf_interval;
 789
 790         return (plugin_insert_read (rf));
 791 } /* int plugin_register_read */
 792
 793 int plugin_register_complex_read (const char *group, const char *name,
 794                 plugin_read_cb callback,
 795                 const struct timespec *interval,
 796                 user_data_t *user_data)
 797 {
 798         read_func_t *rf;
 799
 800         rf = (read_func_t *) malloc (sizeof (read_func_t));
 801         if (rf == NULL)
 802         {
 803                 ERROR ("plugin_register_complex_read: malloc failed.");
 804                 return (-1);
 805         }
 806
 807         memset (rf, 0, sizeof (read_func_t));
 808         rf->rf_callback = (void *) callback;
 809         if (group != NULL)
 810                 sstrncpy (rf->rf_group, group, sizeof (rf->rf_group));
 811         else
 812                 rf->rf_group[0] = '\0';
 813         sstrncpy (rf->rf_name, name, sizeof (rf->rf_name));
 814         rf->rf_type = RF_COMPLEX;
 815         if (interval != NULL)
 816         {
 817                 rf->rf_interval = *interval;
 818         }
 819         rf->rf_effective_interval = rf->rf_interval;
 820
 821         /* Set user data */
 822         if (user_data == NULL)
 823         {
 824                 rf->rf_udata.data = NULL;
 825                 rf->rf_udata.free_func = NULL;
 826         }
 827         else
 828         {
 829                 rf->rf_udata = *user_data;
 830         }
 831
 832         return (plugin_insert_read (rf));
 833 } /* int plugin_register_complex_read */
 834
 835 int plugin_register_write (const char *name,
 836                 plugin_write_cb callback, user_data_t *ud)
 837 {
 838         return (create_register_callback (&list_write, name,
 839                                 (void *) callback, ud));
 840 } /* int plugin_register_write */
 841
 842 int plugin_register_flush (const char *name,
 843                 plugin_flush_cb callback, user_data_t *ud)
 844 {
 845         return (create_register_callback (&list_flush, name,
 846                                 (void *) callback, ud));
 847 } /* int plugin_register_flush */
 848
 849 int plugin_register_missing (const char *name,
 850                 plugin_missing_cb callback, user_data_t *ud)
 851 {
 852         return (create_register_callback (&list_missing, name,
 853                                 (void *) callback, ud));
 854 } /* int plugin_register_missing */
 855
 856 int plugin_register_shutdown (char *name,
 857                 int (*callback) (void))
 858 {
 859         return (create_register_callback (&list_shutdown, name,
 860                                 (void *) callback, /* user_data = */ NULL));
 861 } /* int plugin_register_shutdown */
 862
 863 int plugin_register_data_set (const data_set_t *ds)
 864 {
 865         data_set_t *ds_copy;
 866         int i;
 867
 868         if ((data_sets != NULL)
 869                         && (c_avl_get (data_sets, ds->type, NULL) == 0))
 870         {
 871                 NOTICE ("Replacing DS `%s' with another version.", ds->type);
 872                 plugin_unregister_data_set (ds->type);
 873         }
 874         else if (data_sets == NULL)
 875         {
 876                 data_sets = c_avl_create ((int (*) (const void *, const void *)) strcmp);
 877                 if (data_sets == NULL)
 878                         return (-1);
 879         }
 880
 881         ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
 882         if (ds_copy == NULL)
 883                 return (-1);
 884         memcpy(ds_copy, ds, sizeof (data_set_t));
 885
 886         ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
 887                         * ds->ds_num);
 888         if (ds_copy->ds == NULL)
 889         {
 890                 free (ds_copy);
 891                 return (-1);
 892         }
 893
 894         for (i = 0; i < ds->ds_num; i++)
 895                 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
 896
 897         return (c_avl_insert (data_sets, (void *) ds_copy->type, (void *) ds_copy));
 898 } /* int plugin_register_data_set */
 899
 900 int plugin_register_log (const char *name,
 901                 plugin_log_cb callback, user_data_t *ud)
 902 {
 903         return (create_register_callback (&list_log, name,
 904                                 (void *) callback, ud));
 905 } /* int plugin_register_log */
 906
 907 int plugin_register_notification (const char *name,
 908                 plugin_notification_cb callback, user_data_t *ud)
 909 {
 910         return (create_register_callback (&list_notification, name,
 911                                 (void *) callback, ud));
 912 } /* int plugin_register_log */
 913
 914 int plugin_unregister_config (const char *name)
 915 {
 916         cf_unregister (name);
 917         return (0);
 918 } /* int plugin_unregister_config */
 919
 920 int plugin_unregister_complex_config (const char *name)
 921 {
 922         cf_unregister_complex (name);
 923         return (0);
 924 } /* int plugin_unregister_complex_config */
 925
 926 int plugin_unregister_init (const char *name)
 927 {
 928         return (plugin_unregister (list_init, name));
 929 }
 930
 931 int plugin_unregister_read (const char *name) /* {{{ */
 932 {
 933         llentry_t *le;
 934         read_func_t *rf;
 935
 936         if (name == NULL)
 937                 return (-ENOENT);
 938
 939         pthread_mutex_lock (&read_lock);
 940
 941         if (read_list == NULL)
 942         {
 943                 pthread_mutex_unlock (&read_lock);
 944                 return (-ENOENT);
 945         }
 946
 947         le = llist_search (read_list, name);
 948         if (le == NULL)
 949         {
 950                 pthread_mutex_unlock (&read_lock);
 951                 WARNING ("plugin_unregister_read: No such read function: %s",
 952                                 name);
 953                 return (-ENOENT);
 954         }
 955
 956         llist_remove (read_list, le);
 957
 958         rf = le->value;
 959         assert (rf != NULL);
 960         rf->rf_type = RF_REMOVE;
 961
 962         pthread_mutex_unlock (&read_lock);
 963
 964         llentry_destroy (le);
 965
 966         DEBUG ("plugin_unregister_read: Marked `%s' for removal.", name);
 967
 968         return (0);
 969 } /* }}} int plugin_unregister_read */
 970
 971 static int compare_read_func_group (llentry_t *e, void *ud) /* {{{ */
 972 {
 973         read_func_t *rf    = e->value;
 974         char        *group = ud;
 975
 976         return strcmp (rf->rf_group, (const char *)group);
 977 } /* }}} int compare_read_func_group */
 978
 979 int plugin_unregister_read_group (const char *group) /* {{{ */
 980 {
 981         llentry_t *le;
 982         read_func_t *rf;
 983
 984         int found = 0;
 985
 986         if (group == NULL)
 987                 return (-ENOENT);
 988
 989         pthread_mutex_lock (&read_lock);
 990
 991         if (read_list == NULL)
 992         {
 993                 pthread_mutex_unlock (&read_lock);
 994                 return (-ENOENT);
 995         }
 996
 997         while (42)
 998         {
 999                 le = llist_search_custom (read_list,
1000                                 compare_read_func_group, (void *)group);
1001
1002                 if (le == NULL)
1003                         break;
1004
1005                 ++found;
1006
1007                 llist_remove (read_list, le);
1008
1009                 rf = le->value;
1010                 assert (rf != NULL);
1011                 rf->rf_type = RF_REMOVE;
1012
1013                 llentry_destroy (le);
1014
1015                 DEBUG ("plugin_unregister_read_group: "
1016                                 "Marked `%s' (group `%s') for removal.",
1017                                 rf->rf_name, group);
1018         }
1019
1020         pthread_mutex_unlock (&read_lock);
1021
1022         if (found == 0)
1023         {
1024                 WARNING ("plugin_unregister_read_group: No such "
1025                                 "group of read function: %s", group);
1026                 return (-ENOENT);
1027         }
1028
1029         return (0);
1030 } /* }}} int plugin_unregister_read_group */
1031
1032 int plugin_unregister_write (const char *name)
1033 {
1034         return (plugin_unregister (list_write, name));
1035 }
1036
1037 int plugin_unregister_flush (const char *name)
1038 {
1039         return (plugin_unregister (list_flush, name));
1040 }
1041
1042 int plugin_unregister_missing (const char *name)
1043 {
1044         return (plugin_unregister (list_missing, name));
1045 }
1046
1047 int plugin_unregister_shutdown (const char *name)
1048 {
1049         return (plugin_unregister (list_shutdown, name));
1050 }
1051
1052 int plugin_unregister_data_set (const char *name)
1053 {
1054         data_set_t *ds;
1055
1056         if (data_sets == NULL)
1057                 return (-1);
1058
1059         if (c_avl_remove (data_sets, name, NULL, (void *) &ds) != 0)
1060                 return (-1);
1061
1062         sfree (ds->ds);
1063         sfree (ds);
1064
1065         return (0);
1066 } /* int plugin_unregister_data_set */
1067
1068 int plugin_unregister_log (const char *name)
1069 {
1070         return (plugin_unregister (list_log, name));
1071 }
1072
1073 int plugin_unregister_notification (const char *name)
1074 {
1075         return (plugin_unregister (list_notification, name));
1076 }
1077
1078 void plugin_init_all (void)
1079 {
1080         const char *chain_name;
1081         llentry_t *le;
1082         int status;
1083
1084         /* Init the value cache */
1085         uc_init ();
1086
1087         chain_name = global_option_get ("PreCacheChain");
1088         pre_cache_chain = fc_chain_get_by_name (chain_name);
1089
1090         chain_name = global_option_get ("PostCacheChain");
1091         post_cache_chain = fc_chain_get_by_name (chain_name);
1092
1093
1094         if ((list_init == NULL) && (read_heap == NULL))
1095                 return;
1096
1097         /* Calling all init callbacks before checking if read callbacks
1098          * are available allows the init callbacks to register the read
1099          * callback. */
1100         le = llist_head (list_init);
1101         while (le != NULL)
1102         {
1103                 callback_func_t *cf;
1104                 plugin_init_cb callback;
1105
1106                 cf = le->value;
1107                 callback = cf->cf_callback;
1108                 status = (*callback) ();
1109
1110                 if (status != 0)
1111                 {
1112                         ERROR ("Initialization of plugin `%s' "
1113                                         "failed with status %i. "
1114                                         "Plugin will be unloaded.",
1115                                         le->key, status);
1116                         /* Plugins that register read callbacks from the init
1117                          * callback should take care of appropriate error
1118                          * handling themselves. */
1119                         /* FIXME: Unload _all_ functions */
1120                         plugin_unregister_read (le->key);
1121                 }
1122
1123                 le = le->next;
1124         }
1125
1126         /* Start read-threads */
1127         if (read_heap != NULL)
1128         {
1129                 const char *rt;
1130                 int num;
1131                 rt = global_option_get ("ReadThreads");
1132                 num = atoi (rt);
1133                 if (num != -1)
1134                         start_read_threads ((num > 0) ? num : 5);
1135         }
1136 } /* void plugin_init_all */
1137
1138 /* TODO: Rename this function. */
1139 void plugin_read_all (void)
1140 {
1141         uc_check_timeout ();
1142
1143         return;
1144 } /* void plugin_read_all */
1145
1146 /* Read function called when the `-T' command line argument is given. */
1147 int plugin_read_all_once (void)
1148 {
1149         int status;
1150         int return_status = 0;
1151
1152         if (read_heap == NULL)
1153         {
1154                 NOTICE ("No read-functions are registered.");
1155                 return (0);
1156         }
1157
1158         while (42)
1159         {
1160                 read_func_t *rf;
1161
1162                 rf = c_heap_get_root (read_heap);
1163                 if (rf == NULL)
1164                         break;
1165
1166                 if (rf->rf_type == RF_SIMPLE)
1167                 {
1168                         int (*callback) (void);
1169
1170                         callback = rf->rf_callback;
1171                         status = (*callback) ();
1172                 }
1173                 else
1174                 {
1175                         plugin_read_cb callback;
1176
1177                         callback = rf->rf_callback;
1178                         status = (*callback) (&rf->rf_udata);
1179                 }
1180
1181                 if (status != 0)
1182                 {
1183                         NOTICE ("read-function of plugin `%s' failed.",
1184                                         rf->rf_name);
1185                         return_status = -1;
1186                 }
1187
1188                 destroy_callback ((void *) rf);
1189         }
1190
1191         return (return_status);
1192 } /* int plugin_read_all_once */
1193
1194 int plugin_write (const char *plugin, /* {{{ */
1195                 const data_set_t *ds, const value_list_t *vl)
1196 {
1197   llentry_t *le;
1198   int status;
1199
1200   if (vl == NULL)
1201     return (EINVAL);
1202
1203   if (list_write == NULL)
1204     return (ENOENT);
1205
1206   if (ds == NULL)
1207   {
1208     ds = plugin_get_ds (vl->type);
1209     if (ds == NULL)
1210     {
1211       ERROR ("plugin_write: Unable to lookup type `%s'.", vl->type);
1212       return (ENOENT);
1213     }
1214   }
1215
1216   if (plugin == NULL)
1217   {
1218     int success = 0;
1219     int failure = 0;
1220
1221     le = llist_head (list_write);
1222     while (le != NULL)
1223     {
1224       callback_func_t *cf = le->value;
1225       plugin_write_cb callback;
1226
1227       DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1228       callback = cf->cf_callback;
1229       status = (*callback) (ds, vl, &cf->cf_udata);
1230       if (status != 0)
1231         failure++;
1232       else
1233         success++;
1234
1235       le = le->next;
1236     }
1237
1238     if ((success == 0) && (failure != 0))
1239       status = -1;
1240     else
1241       status = 0;
1242   }
1243   else /* plugin != NULL */
1244   {
1245     callback_func_t *cf;
1246     plugin_write_cb callback;
1247
1248     le = llist_head (list_write);
1249     while (le != NULL)
1250     {
1251       if (strcasecmp (plugin, le->key) == 0)
1252         break;
1253
1254       le = le->next;
1255     }
1256
1257     if (le == NULL)
1258       return (ENOENT);
1259
1260     cf = le->value;
1261
1262     DEBUG ("plugin: plugin_write: Writing values via %s.", le->key);
1263     callback = cf->cf_callback;
1264     status = (*callback) (ds, vl, &cf->cf_udata);
1265   }
1266
1267   return (status);
1268 } /* }}} int plugin_write */
1269
1270 int plugin_flush (const char *plugin, cdtime_t timeout, const char *identifier)
1271 {
1272   llentry_t *le;
1273
1274   if (list_flush == NULL)
1275     return (0);
1276
1277   le = llist_head (list_flush);
1278   while (le != NULL)
1279   {
1280     callback_func_t *cf;
1281     plugin_flush_cb callback;
1282
1283     if ((plugin != NULL)
1284         && (strcmp (plugin, le->key) != 0))
1285     {
1286       le = le->next;
1287       continue;
1288     }
1289
1290     cf = le->value;
1291     callback = cf->cf_callback;
1292
1293     (*callback) (timeout, identifier, &cf->cf_udata);
1294
1295     le = le->next;
1296   }
1297   return (0);
1298 } /* int plugin_flush */
1299
1300 void plugin_shutdown_all (void)
1301 {
1302         llentry_t *le;
1303
1304         stop_read_threads ();
1305
1306         destroy_all_callbacks (&list_init);
1307
1308         pthread_mutex_lock (&read_lock);
1309         llist_destroy (read_list);
1310         read_list = NULL;
1311         pthread_mutex_unlock (&read_lock);
1312
1313         destroy_read_heap ();
1314
1315         plugin_flush (/* plugin = */ NULL,
1316                         /* timeout = */ 0,
1317                         /* identifier = */ NULL);
1318
1319         le = NULL;
1320         if (list_shutdown != NULL)
1321                 le = llist_head (list_shutdown);
1322
1323         while (le != NULL)
1324         {
1325                 callback_func_t *cf;
1326                 plugin_shutdown_cb callback;
1327
1328                 cf = le->value;
1329                 callback = cf->cf_callback;
1330
1331                 /* Advance the pointer before calling the callback allows
1332                  * shutdown functions to unregister themselves. If done the
1333                  * other way around the memory `le' points to will be freed
1334                  * after callback returns. */
1335                 le = le->next;
1336
1337                 (*callback) ();
1338         }
1339
1340         /* Write plugins which use the `user_data' pointer usually need the
1341          * same data available to the flush callback. If this is the case, set
1342          * the free_function to NULL when registering the flush callback and to
1343          * the real free function when registering the write callback. This way
1344          * the data isn't freed twice. */
1345         destroy_all_callbacks (&list_flush);
1346         destroy_all_callbacks (&list_missing);
1347         destroy_all_callbacks (&list_write);
1348
1349         destroy_all_callbacks (&list_notification);
1350         destroy_all_callbacks (&list_shutdown);
1351         destroy_all_callbacks (&list_log);
1352 } /* void plugin_shutdown_all */
1353
1354 int plugin_dispatch_missing (const value_list_t *vl) /* {{{ */
1355 {
1356   llentry_t *le;
1357
1358   if (list_missing == NULL)
1359     return (0);
1360
1361   le = llist_head (list_missing);
1362   while (le != NULL)
1363   {
1364     callback_func_t *cf;
1365     plugin_missing_cb callback;
1366     int status;
1367
1368     cf = le->value;
1369     callback = cf->cf_callback;
1370
1371     status = (*callback) (vl, &cf->cf_udata);
1372     if (status != 0)
1373     {
1374       if (status < 0)
1375       {
1376         ERROR ("plugin_dispatch_missing: Callback function \"%s\" "
1377             "failed with status %i.",
1378             le->key, status);
1379         return (status);
1380       }
1381       else
1382       {
1383         return (0);
1384       }
1385     }
1386
1387     le = le->next;
1388   }
1389   return (0);
1390 } /* int }}} plugin_dispatch_missing */
1391
1392 int plugin_dispatch_values (value_list_t *vl)
1393 {
1394         int status;
1395         static c_complain_t no_write_complaint = C_COMPLAIN_INIT_STATIC;
1396
1397         value_t *saved_values;
1398         int      saved_values_len;
1399
1400         data_set_t *ds;
1401
1402         int free_meta_data = 0;
1403
1404         if ((vl == NULL) || (vl->type[0] == 0)
1405                         || (vl->values == NULL) || (vl->values_len < 1))
1406         {
1407                 ERROR ("plugin_dispatch_values: Invalid value list.");
1408                 return (-1);
1409         }
1410
1411         /* Free meta data only if the calling function didn't specify any. In
1412          * this case matches and targets may add some and the calling function
1413          * may not expect (and therefore free) that data. */
1414         if (vl->meta == NULL)
1415                 free_meta_data = 1;
1416
1417         if (list_write == NULL)
1418                 c_complain_once (LOG_WARNING, &no_write_complaint,
1419                                 "plugin_dispatch_values: No write callback has been "
1420                                 "registered. Please load at least one output plugin, "
1421                                 "if you want the collected data to be stored.");
1422
1423         if (data_sets == NULL)
1424         {
1425                 ERROR ("plugin_dispatch_values: No data sets registered. "
1426                                 "Could the types database be read? Check "
1427                                 "your `TypesDB' setting!");
1428                 return (-1);
1429         }
1430
1431         if (c_avl_get (data_sets, vl->type, (void *) &ds) != 0)
1432         {
1433                 char ident[6 * DATA_MAX_NAME_LEN];
1434
1435                 FORMAT_VL (ident, sizeof (ident), vl);
1436                 INFO ("plugin_dispatch_values: Dataset not found: %s "
1437                                 "(from \"%s\"), check your types.db!",
1438                                 vl->type, ident);
1439                 return (-1);
1440         }
1441
1442         if (vl->time == 0)
1443                 vl->time = cdtime ();
1444
1445         if (vl->interval <= 0)
1446                 vl->interval = interval_g;
1447
1448         DEBUG ("plugin_dispatch_values: time = %.3f; interval = %.3f; "
1449                         "host = %s; "
1450                         "plugin = %s; plugin_instance = %s; "
1451                         "type = %s; type_instance = %s;",
1452                         CDTIME_T_TO_DOUBLE (vl->time),
1453                         CDTIME_T_TO_DOUBLE (vl->interval),
1454                         vl->host,
1455                         vl->plugin, vl->plugin_instance,
1456                         vl->type, vl->type_instance);
1457
1458 #if COLLECT_DEBUG
1459         assert (0 == strcmp (ds->type, vl->type));
1460 #else
1461         if (0 != strcmp (ds->type, vl->type))
1462                 WARNING ("plugin_dispatch_values: (ds->type = %s) != (vl->type = %s)",
1463                                 ds->type, vl->type);
1464 #endif
1465
1466 #if COLLECT_DEBUG
1467         assert (ds->ds_num == vl->values_len);
1468 #else
1469         if (ds->ds_num != vl->values_len)
1470         {
1471                 ERROR ("plugin_dispatch_values: ds->type = %s: "
1472                                 "(ds->ds_num = %i) != "
1473                                 "(vl->values_len = %i)",
1474                                 ds->type, ds->ds_num, vl->values_len);
1475                 return (-1);
1476         }
1477 #endif
1478
1479         escape_slashes (vl->host, sizeof (vl->host));
1480         escape_slashes (vl->plugin, sizeof (vl->plugin));
1481         escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
1482         escape_slashes (vl->type, sizeof (vl->type));
1483         escape_slashes (vl->type_instance, sizeof (vl->type_instance));
1484
1485         /* Copy the values. This way, we can assure `targets' that they get
1486          * dynamically allocated values, which they can free and replace if
1487          * they like. */
1488         if ((pre_cache_chain != NULL) || (post_cache_chain != NULL))
1489         {
1490                 saved_values     = vl->values;
1491                 saved_values_len = vl->values_len;
1492
1493                 vl->values = (value_t *) calloc (vl->values_len,
1494                                 sizeof (*vl->values));
1495                 if (vl->values == NULL)
1496                 {
1497                         ERROR ("plugin_dispatch_values: calloc failed.");
1498                         vl->values = saved_values;
1499                         return (-1);
1500                 }
1501                 memcpy (vl->values, saved_values,
1502                                 vl->values_len * sizeof (*vl->values));
1503         }
1504         else /* if ((pre == NULL) && (post == NULL)) */
1505         {
1506                 saved_values     = NULL;
1507                 saved_values_len = 0;
1508         }
1509
1510         if (pre_cache_chain != NULL)
1511         {
1512                 status = fc_process_chain (ds, vl, pre_cache_chain);
1513                 if (status < 0)
1514                 {
1515                         WARNING ("plugin_dispatch_values: Running the "
1516                                         "pre-cache chain failed with "
1517                                         "status %i (%#x).",
1518                                         status, status);
1519                 }
1520                 else if (status == FC_TARGET_STOP)
1521                 {
1522                         /* Restore the state of the value_list so that plugins
1523                          * don't get confused.. */
1524                         if (saved_values != NULL)
1525                         {
1526                                 free (vl->values);
1527                                 vl->values     = saved_values;
1528                                 vl->values_len = saved_values_len;
1529                         }
1530                         return (0);
1531                 }
1532         }
1533
1534         /* Update the value cache */
1535         uc_update (ds, vl);
1536
1537         if (post_cache_chain != NULL)
1538         {
1539                 status = fc_process_chain (ds, vl, post_cache_chain);
1540                 if (status < 0)
1541                 {
1542                         WARNING ("plugin_dispatch_values: Running the "
1543                                         "post-cache chain failed with "
1544                                         "status %i (%#x).",
1545                                         status, status);
1546                 }
1547         }
1548         else
1549                 fc_default_action (ds, vl);
1550
1551         /* Restore the state of the value_list so that plugins don't get
1552          * confused.. */
1553         if (saved_values != NULL)
1554         {
1555                 free (vl->values);
1556                 vl->values     = saved_values;
1557                 vl->values_len = saved_values_len;
1558         }
1559
1560         if ((free_meta_data != 0) && (vl->meta != NULL))
1561         {
1562                 meta_data_destroy (vl->meta);
1563                 vl->meta = NULL;
1564         }
1565
1566         return (0);
1567 } /* int plugin_dispatch_values */
1568
1569 int plugin_dispatch_notification (const notification_t *notif)
1570 {
1571         llentry_t *le;
1572         /* Possible TODO: Add flap detection here */
1573
1574         DEBUG ("plugin_dispatch_notification: severity = %i; message = %s; "
1575                         "time = %.3f; host = %s;",
1576                         notif->severity, notif->message,
1577                         CDTIME_T_TO_DOUBLE (notif->time), notif->host);
1578
1579         /* Nobody cares for notifications */
1580         if (list_notification == NULL)
1581                 return (-1);
1582
1583         le = llist_head (list_notification);
1584         while (le != NULL)
1585         {
1586                 callback_func_t *cf;
1587                 plugin_notification_cb callback;
1588                 int status;
1589
1590                 cf = le->value;
1591                 callback = cf->cf_callback;
1592                 status = (*callback) (notif, &cf->cf_udata);
1593                 if (status != 0)
1594                 {
1595                         WARNING ("plugin_dispatch_notification: Notification "
1596                                         "callback %s returned %i.",
1597                                         le->key, status);
1598                 }
1599
1600                 le = le->next;
1601         }
1602
1603         return (0);
1604 } /* int plugin_dispatch_notification */
1605
1606 void plugin_log (int level, const char *format, ...)
1607 {
1608         char msg[1024];
1609         va_list ap;
1610         llentry_t *le;
1611
1612 #if !COLLECT_DEBUG
1613         if (level >= LOG_DEBUG)
1614                 return;
1615 #endif
1616
1617         va_start (ap, format);
1618         vsnprintf (msg, sizeof (msg), format, ap);
1619         msg[sizeof (msg) - 1] = '\0';
1620         va_end (ap);
1621
1622         if (list_log == NULL)
1623         {
1624                 fprintf (stderr, "%s\n", msg);
1625                 return;
1626         }
1627
1628         le = llist_head (list_log);
1629         while (le != NULL)
1630         {
1631                 callback_func_t *cf;
1632                 plugin_log_cb callback;
1633
1634                 cf = le->value;
1635                 callback = cf->cf_callback;
1636
1637                 (*callback) (level, msg, &cf->cf_udata);
1638
1639                 le = le->next;
1640         }
1641 } /* void plugin_log */
1642
1643 const data_set_t *plugin_get_ds (const char *name)
1644 {
1645         data_set_t *ds;
1646
1647         if (c_avl_get (data_sets, name, (void *) &ds) != 0)
1648         {
1649                 DEBUG ("No such dataset registered: %s", name);
1650                 return (NULL);
1651         }
1652
1653         return (ds);
1654 } /* data_set_t *plugin_get_ds */
1655
1656 static int plugin_notification_meta_add (notification_t *n,
1657     const char *name,
1658     enum notification_meta_type_e type,
1659     const void *value)
1660 {
1661   notification_meta_t *meta;
1662   notification_meta_t *tail;
1663
1664   if ((n == NULL) || (name == NULL) || (value == NULL))
1665   {
1666     ERROR ("plugin_notification_meta_add: A pointer is NULL!");
1667     return (-1);
1668   }
1669
1670   meta = (notification_meta_t *) malloc (sizeof (notification_meta_t));
1671   if (meta == NULL)
1672   {
1673     ERROR ("plugin_notification_meta_add: malloc failed.");
1674     return (-1);
1675   }
1676   memset (meta, 0, sizeof (notification_meta_t));
1677
1678   sstrncpy (meta->name, name, sizeof (meta->name));
1679   meta->type = type;
1680
1681   switch (type)
1682   {
1683     case NM_TYPE_STRING:
1684     {
1685       meta->nm_value.nm_string = strdup ((const char *) value);
1686       if (meta->nm_value.nm_string == NULL)
1687       {
1688         ERROR ("plugin_notification_meta_add: strdup failed.");
1689         sfree (meta);
1690         return (-1);
1691       }
1692       break;
1693     }
1694     case NM_TYPE_SIGNED_INT:
1695     {
1696       meta->nm_value.nm_signed_int = *((int64_t *) value);
1697       break;
1698     }
1699     case NM_TYPE_UNSIGNED_INT:
1700     {
1701       meta->nm_value.nm_unsigned_int = *((uint64_t *) value);
1702       break;
1703     }
1704     case NM_TYPE_DOUBLE:
1705     {
1706       meta->nm_value.nm_double = *((double *) value);
1707       break;
1708     }
1709     case NM_TYPE_BOOLEAN:
1710     {
1711       meta->nm_value.nm_boolean = *((_Bool *) value);
1712       break;
1713     }
1714     default:
1715     {
1716       ERROR ("plugin_notification_meta_add: Unknown type: %i", type);
1717       sfree (meta);
1718       return (-1);
1719     }
1720   } /* switch (type) */
1721
1722   meta->next = NULL;
1723   tail = n->meta;
1724   while ((tail != NULL) && (tail->next != NULL))
1725     tail = tail->next;
1726
1727   if (tail == NULL)
1728     n->meta = meta;
1729   else
1730     tail->next = meta;
1731
1732   return (0);
1733 } /* int plugin_notification_meta_add */
1734
1735 int plugin_notification_meta_add_string (notification_t *n,
1736     const char *name,
1737     const char *value)
1738 {
1739   return (plugin_notification_meta_add (n, name, NM_TYPE_STRING, value));
1740 }
1741
1742 int plugin_notification_meta_add_signed_int (notification_t *n,
1743     const char *name,
1744     int64_t value)
1745 {
1746   return (plugin_notification_meta_add (n, name, NM_TYPE_SIGNED_INT, &value));
1747 }
1748
1749 int plugin_notification_meta_add_unsigned_int (notification_t *n,
1750     const char *name,
1751     uint64_t value)
1752 {
1753   return (plugin_notification_meta_add (n, name, NM_TYPE_UNSIGNED_INT, &value));
1754 }
1755
1756 int plugin_notification_meta_add_double (notification_t *n,
1757     const char *name,
1758     double value)
1759 {
1760   return (plugin_notification_meta_add (n, name, NM_TYPE_DOUBLE, &value));
1761 }
1762
1763 int plugin_notification_meta_add_boolean (notification_t *n,
1764     const char *name,
1765     _Bool value)
1766 {
1767   return (plugin_notification_meta_add (n, name, NM_TYPE_BOOLEAN, &value));
1768 }
1769
1770 int plugin_notification_meta_copy (notification_t *dst,
1771     const notification_t *src)
1772 {
1773   notification_meta_t *meta;
1774
1775   assert (dst != NULL);
1776   assert (src != NULL);
1777   assert (dst != src);
1778   assert ((src->meta == NULL) || (src->meta != dst->meta));
1779
1780   for (meta = src->meta; meta != NULL; meta = meta->next)
1781   {
1782     if (meta->type == NM_TYPE_STRING)
1783       plugin_notification_meta_add_string (dst, meta->name,
1784           meta->nm_value.nm_string);
1785     else if (meta->type == NM_TYPE_SIGNED_INT)
1786       plugin_notification_meta_add_signed_int (dst, meta->name,
1787           meta->nm_value.nm_signed_int);
1788     else if (meta->type == NM_TYPE_UNSIGNED_INT)
1789       plugin_notification_meta_add_unsigned_int (dst, meta->name,
1790           meta->nm_value.nm_unsigned_int);
1791     else if (meta->type == NM_TYPE_DOUBLE)
1792       plugin_notification_meta_add_double (dst, meta->name,
1793           meta->nm_value.nm_double);
1794     else if (meta->type == NM_TYPE_BOOLEAN)
1795       plugin_notification_meta_add_boolean (dst, meta->name,
1796           meta->nm_value.nm_boolean);
1797   }
1798
1799   return (0);
1800 } /* int plugin_notification_meta_copy */
1801
1802 int plugin_notification_meta_free (notification_meta_t *n)
1803 {
1804   notification_meta_t *this;
1805   notification_meta_t *next;
1806
1807   if (n == NULL)
1808   {
1809     ERROR ("plugin_notification_meta_free: n == NULL!");
1810     return (-1);
1811   }
1812
1813   this = n;
1814   while (this != NULL)
1815   {
1816     next = this->next;
1817
1818     if (this->type == NM_TYPE_STRING)
1819     {
1820       free ((char *)this->nm_value.nm_string);
1821       this->nm_value.nm_string = NULL;
1822     }
1823     sfree (this);
1824
1825     this = next;
1826   }
1827
1828   return (0);
1829 } /* int plugin_notification_meta_free */
1830
1831 /* vim: set sw=8 ts=8 noet fdm=marker : */