src/plugin.c

   1 /**
   2  * collectd - src/plugin.c
   3  * Copyright (C) 2005,2006  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 verplant.org>
  20  **/
  21
  22 #include "collectd.h"
  23
  24 #include <ltdl.h>
  25
  26 #if HAVE_PTHREAD_H
  27 # include <pthread.h>
  28 #endif
  29
  30 #include "common.h"
  31 #include "plugin.h"
  32 #include "configfile.h"
  33 #include "utils_llist.h"
  34
  35 /*
  36  * Private structures
  37  */
  38 struct read_func_s
  39 {
  40         int wait_time;
  41         int wait_left;
  42         int (*callback) (void);
  43         enum { DONE = 0, TODO = 1, ACTIVE = 2 } needs_read;
  44 };
  45 typedef struct read_func_s read_func_t;
  46
  47 /*
  48  * Private variables
  49  */
  50 static llist_t *list_init;
  51 static llist_t *list_read;
  52 static llist_t *list_write;
  53 static llist_t *list_shutdown;
  54 static llist_t *list_data_set;
  55 static llist_t *list_log;
  56
  57 static char *plugindir = NULL;
  58
  59 static int             read_loop = 1;
  60 static pthread_mutex_t read_lock = PTHREAD_MUTEX_INITIALIZER;
  61 static pthread_cond_t  read_cond = PTHREAD_COND_INITIALIZER;
  62 static pthread_t      *read_threads = NULL;
  63 static int             read_threads_num = 0;
  64
  65 /*
  66  * Static functions
  67  */
  68 static const char *plugin_get_dir (void)
  69 {
  70         if (plugindir == NULL)
  71                 return (PLUGINDIR);
  72         else
  73                 return (plugindir);
  74 }
  75
  76 static int register_callback (llist_t **list, const char *name, void *callback)
  77 {
  78         llentry_t *le;
  79
  80         if ((*list == NULL)
  81                         && ((*list = llist_create ()) == NULL))
  82                 return (-1);
  83
  84         le = llist_search (*list, name);
  85         if (le == NULL)
  86         {
  87                 le = llentry_create (name, callback);
  88                 if (le == NULL)
  89                         return (-1);
  90
  91                 llist_append (*list, le);
  92         }
  93         else
  94         {
  95                 le->value = callback;
  96         }
  97
  98         return (0);
  99 } /* int register_callback */
 100
 101 static int plugin_unregister (llist_t *list, const char *name)
 102 {
 103         llentry_t *e;
 104
 105         e = llist_search (list, name);
 106
 107         if (e == NULL)
 108                 return (-1);
 109
 110         llist_remove (list, e);
 111         llentry_destroy (e);
 112
 113         return (0);
 114 } /* int plugin_unregister */
 115
 116 /*
 117  * (Try to) load the shared object `file'. Won't complain if it isn't a shared
 118  * object, but it will bitch about a shared object not having a
 119  * ``module_register'' symbol..
 120  */
 121 static int plugin_load_file (char *file)
 122 {
 123         lt_dlhandle dlh;
 124         void (*reg_handle) (void);
 125
 126         DEBUG ("file = %s", file);
 127
 128         lt_dlinit ();
 129         lt_dlerror (); /* clear errors */
 130
 131         if ((dlh = lt_dlopen (file)) == NULL)
 132         {
 133                 const char *error = lt_dlerror ();
 134
 135                 ERROR ("lt_dlopen failed: %s", error);
 136                 fprintf (stderr, "lt_dlopen failed: %s\n", error);
 137                 return (1);
 138         }
 139
 140         if ((reg_handle = (void (*) (void)) lt_dlsym (dlh, "module_register")) == NULL)
 141         {
 142                 WARNING ("Couldn't find symbol ``module_register'' in ``%s'': %s\n",
 143                                 file, lt_dlerror ());
 144                 lt_dlclose (dlh);
 145                 return (-1);
 146         }
 147
 148         (*reg_handle) ();
 149
 150         return (0);
 151 }
 152
 153 static void *plugin_read_thread (void *args)
 154 {
 155         llentry_t   *le;
 156         read_func_t *rf;
 157         int          status;
 158         int          done;
 159
 160         pthread_mutex_lock (&read_lock);
 161
 162         while (read_loop != 0)
 163         {
 164                 le = llist_head (list_read);
 165                 done = 0;
 166
 167                 while ((read_loop != 0) && (le != NULL))
 168                 {
 169                         rf = (read_func_t *) le->value;
 170
 171                         if (rf->needs_read != TODO)
 172                         {
 173                                 le = le->next;
 174                                 continue;
 175                         }
 176
 177                         /* We will do this read function */
 178                         rf->needs_read = ACTIVE;
 179
 180                         DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Handling %s",
 181                                         (unsigned long int) pthread_self (), le->key);
 182                         pthread_mutex_unlock (&read_lock);
 183
 184                         status = rf->callback ();
 185                         done++;
 186
 187                         if (status != 0)
 188                         {
 189                                 if (rf->wait_time < interval_g)
 190                                         rf->wait_time = interval_g;
 191                                 rf->wait_left = rf->wait_time;
 192                                 rf->wait_time = rf->wait_time * 2;
 193                                 if (rf->wait_time > 86400)
 194                                         rf->wait_time = 86400;
 195
 196                                 NOTICE ("read-function of plugin `%s' "
 197                                                 "failed. Will suspend it for %i "
 198                                                 "seconds.", le->key, rf->wait_left);
 199                         }
 200                         else
 201                         {
 202                                 rf->wait_left = 0;
 203                                 rf->wait_time = interval_g;
 204                         }
 205
 206                         pthread_mutex_lock (&read_lock);
 207
 208                         rf->needs_read = DONE;
 209                         le = le->next;
 210                 } /* while (le != NULL) */
 211
 212                 if ((read_loop != 0) && (done == 0))
 213                 {
 214                         DEBUG ("[thread #%5lu] plugin: plugin_read_thread: Waiting on read_cond.",
 215                                         (unsigned long int) pthread_self ());
 216                         pthread_cond_wait (&read_cond, &read_lock);
 217                 }
 218         } /* while (read_loop) */
 219
 220         pthread_mutex_unlock (&read_lock);
 221
 222         pthread_exit (NULL);
 223 } /* void *plugin_read_thread */
 224
 225 static void start_threads (int num)
 226 {
 227         int i;
 228
 229         if (read_threads != NULL)
 230                 return;
 231
 232         read_threads = (pthread_t *) calloc (num, sizeof (pthread_t));
 233         if (read_threads == NULL)
 234         {
 235                 ERROR ("plugin: start_threads: calloc failed.");
 236                 return;
 237         }
 238
 239         read_threads_num = 0;
 240         for (i = 0; i < num; i++)
 241         {
 242                 if (pthread_create (read_threads + read_threads_num, NULL,
 243                                         plugin_read_thread, NULL) == 0)
 244                 {
 245                         read_threads_num++;
 246                 }
 247                 else
 248                 {
 249                         ERROR ("plugin: start_threads: pthread_create failed.");
 250                         return;
 251                 }
 252         } /* for (i) */
 253 } /* void start_threads */
 254
 255 static void stop_threads (void)
 256 {
 257         int i;
 258
 259         pthread_mutex_lock (&read_lock);
 260         read_loop = 0;
 261         DEBUG ("plugin: stop_threads: Signalling `read_cond'");
 262         pthread_cond_broadcast (&read_cond);
 263         pthread_mutex_unlock (&read_lock);
 264
 265         for (i = 0; i < read_threads_num; i++)
 266         {
 267                 if (pthread_join (read_threads[i], NULL) != 0)
 268                 {
 269                         ERROR ("plugin: stop_threads: pthread_join failed.");
 270                 }
 271                 read_threads[i] = (pthread_t) 0;
 272         }
 273         sfree (read_threads);
 274         read_threads_num = 0;
 275 } /* void stop_threads */
 276
 277 /*
 278  * Public functions
 279  */
 280 void plugin_set_dir (const char *dir)
 281 {
 282         if (plugindir != NULL)
 283                 free (plugindir);
 284
 285         if (dir == NULL)
 286                 plugindir = NULL;
 287         else if ((plugindir = strdup (dir)) == NULL)
 288         {
 289                 char errbuf[1024];
 290                 ERROR ("strdup failed: %s",
 291                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 292         }
 293 }
 294
 295 #define BUFSIZE 512
 296 int plugin_load (const char *type)
 297 {
 298         DIR  *dh;
 299         const char *dir;
 300         char  filename[BUFSIZE];
 301         char  typename[BUFSIZE];
 302         int   typename_len;
 303         int   ret;
 304         struct stat    statbuf;
 305         struct dirent *de;
 306
 307         DEBUG ("type = %s", type);
 308
 309         dir = plugin_get_dir ();
 310         ret = 1;
 311
 312         /* `cpu' should not match `cpufreq'. To solve this we add `.so' to the
 313          * type when matching the filename */
 314         if (snprintf (typename, BUFSIZE, "%s.so", type) >= BUFSIZE)
 315         {
 316                 WARNING ("snprintf: truncated: `%s.so'", type);
 317                 return (-1);
 318         }
 319         typename_len = strlen (typename);
 320
 321         if ((dh = opendir (dir)) == NULL)
 322         {
 323                 char errbuf[1024];
 324                 ERROR ("opendir (%s): %s", dir,
 325                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 326                 return (-1);
 327         }
 328
 329         while ((de = readdir (dh)) != NULL)
 330         {
 331                 if (strncasecmp (de->d_name, typename, typename_len))
 332                         continue;
 333
 334                 if (snprintf (filename, BUFSIZE, "%s/%s", dir, de->d_name) >= BUFSIZE)
 335                 {
 336                         WARNING ("snprintf: truncated: `%s/%s'", dir, de->d_name);
 337                         continue;
 338                 }
 339
 340                 if (lstat (filename, &statbuf) == -1)
 341                 {
 342                         char errbuf[1024];
 343                         WARNING ("stat %s: %s", filename,
 344                                         sstrerror (errno, errbuf, sizeof (errbuf)));
 345                         continue;
 346                 }
 347                 else if (!S_ISREG (statbuf.st_mode))
 348                 {
 349                         /* don't follow symlinks */
 350                         continue;
 351                 }
 352
 353                 if (plugin_load_file (filename) == 0)
 354                 {
 355                         /* success */
 356                         ret = 0;
 357                         break;
 358                 }
 359                 else
 360                 {
 361                         fprintf (stderr, "Unable to load plugin %s.\n", type);
 362                 }
 363         }
 364
 365         closedir (dh);
 366
 367         return (ret);
 368 }
 369
 370 /*
 371  * The `register_*' functions follow
 372  */
 373 int plugin_register_config (const char *name,
 374                 int (*callback) (const char *key, const char *val),
 375                 const char **keys, int keys_num)
 376 {
 377         cf_register (name, callback, keys, keys_num);
 378         return (0);
 379 } /* int plugin_register_config */
 380
 381 int plugin_register_complex_config (const char *type,
 382                 int (*callback) (oconfig_item_t *))
 383 {
 384         return (cf_register_complex (type, callback));
 385 } /* int plugin_register_complex_config */
 386
 387 int plugin_register_init (const char *name,
 388                 int (*callback) (void))
 389 {
 390         return (register_callback (&list_init, name, (void *) callback));
 391 } /* plugin_register_init */
 392
 393 int plugin_register_read (const char *name,
 394                 int (*callback) (void))
 395 {
 396         read_func_t *rf;
 397
 398         rf = (read_func_t *) malloc (sizeof (read_func_t));
 399         if (rf == NULL)
 400         {
 401                 char errbuf[1024];
 402                 ERROR ("plugin_register_read: malloc failed: %s",
 403                                 sstrerror (errno, errbuf, sizeof (errbuf)));
 404                 return (-1);
 405         }
 406
 407         memset (rf, '\0', sizeof (read_func_t));
 408         rf->wait_time = interval_g;
 409         rf->wait_left = 0;
 410         rf->callback = callback;
 411         rf->needs_read = DONE;
 412
 413         return (register_callback (&list_read, name, (void *) rf));
 414 } /* int plugin_register_read */
 415
 416 int plugin_register_write (const char *name,
 417                 int (*callback) (const data_set_t *ds, const value_list_t *vl))
 418 {
 419         return (register_callback (&list_write, name, (void *) callback));
 420 } /* int plugin_register_write */
 421
 422 int plugin_register_shutdown (char *name,
 423                 int (*callback) (void))
 424 {
 425         return (register_callback (&list_shutdown, name, (void *) callback));
 426 } /* int plugin_register_shutdown */
 427
 428 int plugin_register_data_set (const data_set_t *ds)
 429 {
 430         data_set_t *ds_copy;
 431         int i;
 432
 433         if ((list_data_set != NULL)
 434                         && (llist_search (list_data_set, ds->type) != NULL))
 435         {
 436                 NOTICE ("Replacing DS `%s' with another version.", ds->type);
 437                 plugin_unregister_data_set (ds->type);
 438         }
 439
 440         ds_copy = (data_set_t *) malloc (sizeof (data_set_t));
 441         if (ds_copy == NULL)
 442                 return (-1);
 443         memcpy(ds_copy, ds, sizeof (data_set_t));
 444
 445         ds_copy->ds = (data_source_t *) malloc (sizeof (data_source_t)
 446                         * ds->ds_num);
 447         if (ds_copy->ds == NULL)
 448         {
 449                 free (ds_copy);
 450                 return (-1);
 451         }
 452
 453         for (i = 0; i < ds->ds_num; i++)
 454                 memcpy (ds_copy->ds + i, ds->ds + i, sizeof (data_source_t));
 455
 456         return (register_callback (&list_data_set, ds->type, (void *) ds_copy));
 457 } /* int plugin_register_data_set */
 458
 459 int plugin_register_log (char *name,
 460                 void (*callback) (int priority, const char *msg))
 461 {
 462         return (register_callback (&list_log, name, (void *) callback));
 463 } /* int plugin_register_log */
 464
 465 int plugin_unregister_config (const char *name)
 466 {
 467         cf_unregister (name);
 468         return (0);
 469 } /* int plugin_unregister_config */
 470
 471 int plugin_unregister_complex_config (const char *name)
 472 {
 473         cf_unregister_complex (name);
 474         return (0);
 475 } /* int plugin_unregister_complex_config */
 476
 477 int plugin_unregister_init (const char *name)
 478 {
 479         return (plugin_unregister (list_init, name));
 480 }
 481
 482 int plugin_unregister_read (const char *name)
 483 {
 484         llentry_t *e;
 485
 486         e = llist_search (list_read, name);
 487
 488         if (e == NULL)
 489                 return (-1);
 490
 491         llist_remove (list_read, e);
 492         free (e->value);
 493         llentry_destroy (e);
 494
 495         return (0);
 496 }
 497
 498 int plugin_unregister_write (const char *name)
 499 {
 500         return (plugin_unregister (list_write, name));
 501 }
 502
 503 int plugin_unregister_shutdown (const char *name)
 504 {
 505         return (plugin_unregister (list_shutdown, name));
 506 }
 507
 508 int plugin_unregister_data_set (const char *name)
 509 {
 510         llentry_t  *e;
 511         data_set_t *ds;
 512
 513         if (list_data_set == NULL)
 514                 return (-1);
 515
 516         e = llist_search (list_data_set, name);
 517
 518         if (e == NULL)
 519                 return (-1);
 520
 521         llist_remove (list_data_set, e);
 522         ds = (data_set_t *) e->value;
 523         llentry_destroy (e);
 524
 525         sfree (ds->ds);
 526         sfree (ds);
 527
 528         return (0);
 529 } /* int plugin_unregister_data_set */
 530
 531 int plugin_unregister_log (const char *name)
 532 {
 533         return (plugin_unregister (list_log, name));
 534 }
 535
 536 void plugin_init_all (void)
 537 {
 538         int (*callback) (void);
 539         llentry_t *le;
 540         int status;
 541
 542         /* Start read-threads */
 543         if (list_read != NULL)
 544         {
 545                 const char *rt;
 546                 int num;
 547                 rt = global_option_get ("ReadThreads");
 548                 num = atoi (rt);
 549                 start_threads ((num > 0) ? num : 5);
 550         }
 551
 552         if (list_init == NULL)
 553                 return;
 554
 555         le = llist_head (list_init);
 556         while (le != NULL)
 557         {
 558                 callback = (int (*) (void)) le->value;
 559                 status = (*callback) ();
 560
 561                 if (status != 0)
 562                 {
 563                         ERROR ("Initialization of plugin `%s' "
 564                                         "failed with status %i. "
 565                                         "Plugin will be unloaded.",
 566                                         le->key, status);
 567                         /* FIXME: Unload _all_ functions */
 568                         plugin_unregister_read (le->key);
 569                 }
 570
 571                 le = le->next;
 572         }
 573 } /* void plugin_init_all */
 574
 575 void plugin_read_all (const int *loop)
 576 {
 577         llentry_t   *le;
 578         read_func_t *rf;
 579
 580         if (list_read == NULL)
 581                 return;
 582
 583         pthread_mutex_lock (&read_lock);
 584
 585         le = llist_head (list_read);
 586         while (le != NULL)
 587         {
 588                 rf = (read_func_t *) le->value;
 589
 590                 if (rf->needs_read != DONE)
 591                 {
 592                         le = le->next;
 593                         continue;
 594                 }
 595
 596                 if (rf->wait_left > 0)
 597                         rf->wait_left -= interval_g;
 598
 599                 if (rf->wait_left <= 0)
 600                 {
 601                         rf->needs_read = TODO;
 602                 }
 603
 604                 le = le->next;
 605         }
 606
 607         DEBUG ("plugin: plugin_read_all: Signalling `read_cond'");
 608         pthread_cond_broadcast (&read_cond);
 609         pthread_mutex_unlock (&read_lock);
 610 } /* void plugin_read_all */
 611
 612 void plugin_shutdown_all (void)
 613 {
 614         int (*callback) (void);
 615         llentry_t *le;
 616
 617         stop_threads ();
 618
 619         if (list_shutdown == NULL)
 620                 return;
 621
 622         le = llist_head (list_shutdown);
 623         while (le != NULL)
 624         {
 625                 callback = (int (*) (void)) le->value;
 626
 627                 /* Advance the pointer before calling the callback allows
 628                  * shutdown functions to unregister themselves. If done the
 629                  * other way around the memory `le' points to will be freed
 630                  * after callback returns. */
 631                 le = le->next;
 632
 633                 (*callback) ();
 634         }
 635 } /* void plugin_shutdown_all */
 636
 637 int plugin_dispatch_values (const char *name, value_list_t *vl)
 638 {
 639         int (*callback) (const data_set_t *, const value_list_t *);
 640         data_set_t *ds;
 641         llentry_t *le;
 642
 643         if ((list_write == NULL) || (list_data_set == NULL))
 644                 return (-1);
 645
 646         le = llist_search (list_data_set, name);
 647         if (le == NULL)
 648         {
 649                 DEBUG ("No such dataset registered: %s", name);
 650                 return (-1);
 651         }
 652
 653         ds = (data_set_t *) le->value;
 654
 655         DEBUG ("plugin: plugin_dispatch_values: time = %u; interval = %i; "
 656                         "host = %s; "
 657                         "plugin = %s; plugin_instance = %s; "
 658                         "type = %s; type_instance = %s;",
 659                         (unsigned int) vl->time, vl->interval,
 660                         vl->host,
 661                         vl->plugin, vl->plugin_instance,
 662                         ds->type, vl->type_instance);
 663
 664 #if COLLECT_DEBUG
 665         assert (ds->ds_num == vl->values_len);
 666 #else
 667         if (ds->ds_num != vl->values_len)
 668         {
 669                 ERROR ("plugin: ds->type = %s: (ds->ds_num = %i) != "
 670                                 "(vl->values_len = %i)",
 671                                 ds->type, ds->ds_num, vl->values_len);
 672                 return (-1);
 673         }
 674 #endif
 675
 676         escape_slashes (vl->host, sizeof (vl->host));
 677         escape_slashes (vl->plugin, sizeof (vl->plugin));
 678         escape_slashes (vl->plugin_instance, sizeof (vl->plugin_instance));
 679         escape_slashes (vl->type_instance, sizeof (vl->type_instance));
 680
 681         le = llist_head (list_write);
 682         while (le != NULL)
 683         {
 684                 callback = (int (*) (const data_set_t *, const value_list_t *)) le->value;
 685                 (*callback) (ds, vl);
 686
 687                 le = le->next;
 688         }
 689
 690         return (0);
 691 } /* int plugin_dispatch_values */
 692
 693 void plugin_log (int level, const char *format, ...)
 694 {
 695         char msg[512];
 696         va_list ap;
 697
 698         void (*callback) (int, const char *);
 699         llentry_t *le;
 700
 701         if (list_log == NULL)
 702                 return;
 703
 704 #if !COLLECT_DEBUG
 705         if (level >= LOG_DEBUG)
 706                 return;
 707 #endif
 708
 709         va_start (ap, format);
 710         vsnprintf (msg, 512, format, ap);
 711         msg[511] = '\0';
 712         va_end (ap);
 713
 714         le = llist_head (list_log);
 715         while (le != NULL)
 716         {
 717                 callback = (void (*) (int, const char *)) le->value;
 718                 (*callback) (level, msg);
 719
 720                 le = le->next;
 721         }
 722 } /* void plugin_log */
 723
 724 void plugin_complain (int level, complain_t *c, const char *format, ...)
 725 {
 726         char message[512];
 727         va_list ap;
 728
 729         if (c->delay > 0)
 730         {
 731                 c->delay--;
 732                 return;
 733         }
 734
 735         if (c->interval < interval_g)
 736                 c->interval = interval_g;
 737         else
 738                 c->interval *= 2;
 739
 740         if (c->interval > 86400)
 741                 c->interval = 86400;
 742
 743         c->delay = c->interval / interval_g;
 744
 745         va_start (ap, format);
 746         vsnprintf (message, 512, format, ap);
 747         message[511] = '\0';
 748         va_end (ap);
 749
 750         plugin_log (level, message);
 751 }
 752
 753 void plugin_relief (int level, complain_t *c, const char *format, ...)
 754 {
 755         char message[512];
 756         va_list ap;
 757
 758         if (c->interval == 0)
 759                 return;
 760
 761         c->interval = 0;
 762
 763         va_start (ap, format);
 764         vsnprintf (message, 512, format, ap);
 765         message[511] = '\0';
 766         va_end (ap);
 767
 768         plugin_log (level, message);
 769 }
 770
 771 const data_set_t *plugin_get_ds (const char *name)
 772 {
 773         data_set_t *ds;
 774         llentry_t *le;
 775
 776         le = llist_search (list_data_set, name);
 777         if (le == NULL)
 778         {
 779                 DEBUG ("No such dataset registered: %s", name);
 780                 return (NULL);
 781         }
 782
 783         ds = (data_set_t *) le->value;
 784
 785         return (ds);
 786 } /* data_set_t *plugin_get_ds */