src/perl.c

   1 /**
   2  * collectd - src/perl.c
   3  * Copyright (C) 2007  Sebastian Harl
   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  * Author:
  19  *   Sebastian Harl <sh at tokkee.org>
  20  **/
  21
  22 /*
  23  * This plugin embeds a Perl interpreter into collectd and provides an
  24  * interface for collectd plugins written in perl.
  25  */
  26
  27 /* do not automatically get the thread specific perl interpreter */
  28 #define PERL_NO_GET_CONTEXT
  29
  30 #include "collectd.h"
  31
  32 #include "configfile.h"
  33
  34 #include <EXTERN.h>
  35 #include <perl.h>
  36
  37 #include <XSUB.h>
  38
  39 /* Some versions of Perl define their own version of DEBUG... :-/ */
  40 #ifdef DEBUG
  41 # undef DEBUG
  42 #endif /* DEBUG */
  43
  44 /* ... while we want the definition found in plugin.h. */
  45 #include "plugin.h"
  46 #include "common.h"
  47
  48 #include <pthread.h>
  49
  50 #if !defined(USE_ITHREADS)
  51 # error "Perl does not support ithreads!"
  52 #endif /* !defined(USE_ITHREADS) */
  53
  54 /* clear the Perl sub's stack frame
  55  * (this should only be used inside an XSUB) */
  56 #define CLEAR_STACK_FRAME PL_stack_sp = PL_stack_base + *PL_markstack_ptr
  57
  58 #define PLUGIN_INIT     0
  59 #define PLUGIN_READ     1
  60 #define PLUGIN_WRITE    2
  61 #define PLUGIN_SHUTDOWN 3
  62 #define PLUGIN_LOG      4
  63 #define PLUGIN_NOTIF    5
  64
  65 #define PLUGIN_TYPES    6
  66
  67 #define PLUGIN_DATASET  255
  68
  69 #define log_debug(...) DEBUG ("perl: " __VA_ARGS__)
  70 #define log_info(...) INFO ("perl: " __VA_ARGS__)
  71 #define log_warn(...) WARNING ("perl: " __VA_ARGS__)
  72 #define log_err(...) ERROR ("perl: " __VA_ARGS__)
  73
  74 /* this is defined in DynaLoader.a */
  75 void boot_DynaLoader (PerlInterpreter *, CV *);
  76
  77 static XS (Collectd_plugin_register_ds);
  78 static XS (Collectd_plugin_unregister_ds);
  79 static XS (Collectd_plugin_dispatch_values);
  80 static XS (Collectd_plugin_dispatch_notification);
  81 static XS (Collectd_plugin_log);
  82 static XS (Collectd_call_by_name);
  83
  84 /*
  85  * private data types
  86  */
  87
  88 typedef struct c_ithread_s {
  89         /* the thread's Perl interpreter */
  90         PerlInterpreter *interp;
  91
  92         /* double linked list of threads */
  93         struct c_ithread_s *prev;
  94         struct c_ithread_s *next;
  95 } c_ithread_t;
  96
  97 typedef struct {
  98         c_ithread_t *head;
  99         c_ithread_t *tail;
 100
 101 #if COLLECT_DEBUG
 102         /* some usage stats */
 103         int number_of_threads;
 104 #endif /* COLLECT_DEBUG */
 105
 106         pthread_mutex_t mutex;
 107 } c_ithread_list_t;
 108
 109 /*
 110  * private variables
 111  */
 112
 113 /* if perl_threads != NULL perl_threads->head must
 114  * point to the "base" thread */
 115 static c_ithread_list_t *perl_threads = NULL;
 116
 117 /* the key used to store each pthread's ithread */
 118 static pthread_key_t perl_thr_key;
 119
 120 static int    perl_argc = 0;
 121 static char **perl_argv = NULL;
 122
 123 static char base_name[DATA_MAX_NAME_LEN] = "";
 124
 125 static struct {
 126         char name[64];
 127         XS ((*f));
 128 } api[] =
 129 {
 130         { "Collectd::plugin_register_data_set",   Collectd_plugin_register_ds },
 131         { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
 132         { "Collectd::plugin_dispatch_values",     Collectd_plugin_dispatch_values },
 133         { "Collectd::plugin_dispatch_notification",
 134                 Collectd_plugin_dispatch_notification },
 135         { "Collectd::plugin_log",                 Collectd_plugin_log },
 136         { "Collectd::call_by_name",               Collectd_call_by_name },
 137         { "", NULL }
 138 };
 139
 140 struct {
 141         char name[64];
 142         int  value;
 143 } constants[] =
 144 {
 145         { "Collectd::TYPE_INIT",       PLUGIN_INIT },
 146         { "Collectd::TYPE_READ",       PLUGIN_READ },
 147         { "Collectd::TYPE_WRITE",      PLUGIN_WRITE },
 148         { "Collectd::TYPE_SHUTDOWN",   PLUGIN_SHUTDOWN },
 149         { "Collectd::TYPE_LOG",        PLUGIN_LOG },
 150         { "Collectd::TYPE_NOTIF",      PLUGIN_NOTIF },
 151         { "Collectd::TYPE_DATASET",    PLUGIN_DATASET },
 152         { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
 153         { "Collectd::DS_TYPE_GAUGE",   DS_TYPE_GAUGE },
 154         { "Collectd::LOG_ERR",         LOG_ERR },
 155         { "Collectd::LOG_WARNING",     LOG_WARNING },
 156         { "Collectd::LOG_NOTICE",      LOG_NOTICE },
 157         { "Collectd::LOG_INFO",        LOG_INFO },
 158         { "Collectd::LOG_DEBUG",       LOG_DEBUG },
 159         { "Collectd::NOTIF_FAILURE",   NOTIF_FAILURE },
 160         { "Collectd::NOTIF_WARNING",   NOTIF_WARNING },
 161         { "Collectd::NOTIF_OKAY",      NOTIF_OKAY },
 162         { "", 0 }
 163 };
 164
 165 struct {
 166         char  name[64];
 167         char *var;
 168 } g_strings[] =
 169 {
 170         { "Collectd::hostname_g", hostname_g },
 171         { "", NULL }
 172 };
 173
 174 struct {
 175         char  name[64];
 176         int  *var;
 177 } g_integers[] =
 178 {
 179         { "Collectd::interval_g", &interval_g },
 180         { "", NULL }
 181 };
 182
 183 /*
 184  * Helper functions for data type conversion.
 185  */
 186
 187 /*
 188  * data source:
 189  * [
 190  *   {
 191  *     name => $ds_name,
 192  *     type => $ds_type,
 193  *     min  => $ds_min,
 194  *     max  => $ds_max
 195  *   },
 196  *   ...
 197  * ]
 198  */
 199 static int hv2data_source (pTHX_ HV *hash, data_source_t *ds)
 200 {
 201         SV **tmp = NULL;
 202
 203         if ((NULL == hash) || (NULL == ds))
 204                 return -1;
 205
 206         if (NULL != (tmp = hv_fetch (hash, "name", 4, 0))) {
 207                 strncpy (ds->name, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
 208                 ds->name[DATA_MAX_NAME_LEN - 1] = '\0';
 209         }
 210         else {
 211                 log_err ("hv2data_source: No DS name given.");
 212                 return -1;
 213         }
 214
 215         if (NULL != (tmp = hv_fetch (hash, "type", 4, 0))) {
 216                 ds->type = SvIV (*tmp);
 217
 218                 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
 219                         log_err ("hv2data_source: Invalid DS type.");
 220                         return -1;
 221                 }
 222         }
 223         else {
 224                 ds->type = DS_TYPE_COUNTER;
 225         }
 226
 227         if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
 228                 ds->min = SvNV (*tmp);
 229         else
 230                 ds->min = NAN;
 231
 232         if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
 233                 ds->max = SvNV (*tmp);
 234         else
 235                 ds->max = NAN;
 236         return 0;
 237 } /* static data_source_t *hv2data_source (HV *) */
 238
 239 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
 240 {
 241         const data_set_t *ds;
 242
 243         int i = 0;
 244
 245         if ((NULL == name) || (NULL == array) || (NULL == value))
 246                 return -1;
 247
 248         if (av_len (array) < len - 1)
 249                 len = av_len (array) + 1;
 250
 251         if (0 >= len)
 252                 return -1;
 253
 254         ds = plugin_get_ds (name);
 255         if (NULL == ds) {
 256                 log_err ("av2value: Unknown dataset \"%s\"", name);
 257                 return -1;
 258         }
 259
 260         if (ds->ds_num < len) {
 261                 log_warn ("av2value: Value length exceeds data set length.");
 262                 len = ds->ds_num;
 263         }
 264
 265         for (i = 0; i < len; ++i) {
 266                 SV **tmp = av_fetch (array, i, 0);
 267
 268                 if (NULL != tmp) {
 269                         if (DS_TYPE_COUNTER == ds->ds[i].type)
 270                                 value[i].counter = SvIV (*tmp);
 271                         else
 272                                 value[i].gauge = SvNV (*tmp);
 273                 }
 274                 else {
 275                         return -1;
 276                 }
 277         }
 278         return len;
 279 } /* static int av2value (char *, AV *, value_t *, int) */
 280
 281 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
 282 {
 283         int i = 0;
 284
 285         if ((NULL == ds) || (NULL == array))
 286                 return -1;
 287
 288         av_extend (array, ds->ds_num);
 289
 290         for (i = 0; i < ds->ds_num; ++i) {
 291                 HV *source = newHV ();
 292
 293                 if (NULL == hv_store (source, "name", 4,
 294                                 newSVpv (ds->ds[i].name, 0), 0))
 295                         return -1;
 296
 297                 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
 298                         return -1;
 299
 300                 if (! isnan (ds->ds[i].min))
 301                         if (NULL == hv_store (source, "min", 3,
 302                                         newSVnv (ds->ds[i].min), 0))
 303                                 return -1;
 304
 305                 if (! isnan (ds->ds[i].max))
 306                         if (NULL == hv_store (source, "max", 3,
 307                                         newSVnv (ds->ds[i].max), 0))
 308                                 return -1;
 309
 310                 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
 311                         return -1;
 312         }
 313         return 0;
 314 } /* static int data_set2av (data_set_t *, AV *) */
 315
 316 static int value_list2hv (pTHX_ value_list_t *vl, data_set_t *ds, HV *hash)
 317 {
 318         AV *values = NULL;
 319
 320         int i   = 0;
 321         int len = 0;
 322
 323         if ((NULL == vl) || (NULL == ds) || (NULL == hash))
 324                 return -1;
 325
 326         len = vl->values_len;
 327
 328         if (ds->ds_num < len) {
 329                 log_warn ("value2av: Value length exceeds data set length.");
 330                 len = ds->ds_num;
 331         }
 332
 333         values = newAV ();
 334         av_extend (values, len - 1);
 335
 336         for (i = 0; i < len; ++i) {
 337                 SV *val = NULL;
 338
 339                 if (DS_TYPE_COUNTER == ds->ds[i].type)
 340                         val = newSViv (vl->values[i].counter);
 341                 else
 342                         val = newSVnv (vl->values[i].gauge);
 343
 344                 if (NULL == av_store (values, i, val)) {
 345                         av_undef (values);
 346                         return -1;
 347                 }
 348         }
 349
 350         if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
 351                 return -1;
 352
 353         if (0 != vl->time)
 354                 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
 355                         return -1;
 356
 357         if ('\0' != vl->host[0])
 358                 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
 359                         return -1;
 360
 361         if ('\0' != vl->plugin[0])
 362                 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
 363                         return -1;
 364
 365         if ('\0' != vl->plugin_instance[0])
 366                 if (NULL == hv_store (hash, "plugin_instance", 15,
 367                                 newSVpv (vl->plugin_instance, 0), 0))
 368                         return -1;
 369
 370         if ('\0' != vl->type_instance[0])
 371                 if (NULL == hv_store (hash, "type_instance", 13,
 372                                 newSVpv (vl->type_instance, 0), 0))
 373                         return -1;
 374         return 0;
 375 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
 376
 377 static int notification2hv (pTHX_ notification_t *n, HV *hash)
 378 {
 379         if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
 380                 return -1;
 381
 382         if (0 != n->time)
 383                 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
 384                         return -1;
 385
 386         if ('\0' != *n->message)
 387                 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
 388                         return -1;
 389
 390         if ('\0' != *n->host)
 391                 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
 392                         return -1;
 393
 394         if ('\0' != *n->plugin)
 395                 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
 396                         return -1;
 397
 398         if ('\0' != *n->plugin_instance)
 399                 if (NULL == hv_store (hash, "plugin_instance", 15,
 400                                 newSVpv (n->plugin_instance, 0), 0))
 401                         return -1;
 402
 403         if ('\0' != *n->type)
 404                 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
 405                         return -1;
 406
 407         if ('\0' != *n->type_instance)
 408                 if (NULL == hv_store (hash, "type_instance", 13,
 409                                 newSVpv (n->type_instance, 0), 0))
 410                         return -1;
 411         return 0;
 412 } /* static int notification2hv (notification_t *, HV *) */
 413
 414 /*
 415  * Internal functions.
 416  */
 417
 418 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
 419         int status = 0;
 420         if (base_name[0] == '\0')
 421                 status = snprintf (buf, buf_len, "%s", module);
 422         else
 423                 status = snprintf (buf, buf_len, "%s::%s", base_name, module);
 424         if ((status < 0) || ((unsigned int)status >= buf_len))
 425                 return (NULL);
 426         buf[buf_len - 1] = '\0';
 427         return (buf);
 428 } /* char *get_module_name */
 429
 430 /*
 431  * Add a plugin's data set definition.
 432  */
 433 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
 434 {
 435         int len = -1;
 436         int ret = 0;
 437         int i   = 0;
 438
 439         data_source_t *ds  = NULL;
 440         data_set_t    *set = NULL;
 441
 442         if ((NULL == name) || (NULL == dataset))
 443                 return -1;
 444
 445         len = av_len (dataset);
 446
 447         if (-1 == len)
 448                 return -1;
 449
 450         ds  = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
 451         set = (data_set_t *)smalloc (sizeof (data_set_t));
 452
 453         for (i = 0; i <= len; ++i) {
 454                 SV **elem = av_fetch (dataset, i, 0);
 455
 456                 if (NULL == elem)
 457                         return -1;
 458
 459                 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
 460                         log_err ("pplugin_register_data_set: Invalid data source.");
 461                         return -1;
 462                 }
 463
 464                 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
 465                         return -1;
 466
 467                 log_debug ("pplugin_register_data_set: "
 468                                 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
 469                                 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
 470         }
 471
 472         strncpy (set->type, name, DATA_MAX_NAME_LEN);
 473         set->type[DATA_MAX_NAME_LEN - 1] = '\0';
 474
 475         set->ds_num = len + 1;
 476         set->ds = ds;
 477
 478         ret = plugin_register_data_set (set);
 479
 480         free (ds);
 481         free (set);
 482         return ret;
 483 } /* static int pplugin_register_data_set (char *, SV *) */
 484
 485 /*
 486  * Remove a plugin's data set definition.
 487  */
 488 static int pplugin_unregister_data_set (char *name)
 489 {
 490         if (NULL == name)
 491                 return 0;
 492         return plugin_unregister_data_set (name);
 493 } /* static int pplugin_unregister_data_set (char *) */
 494
 495 /*
 496  * Submit the values to the write functions.
 497  *
 498  * value list:
 499  * {
 500  *   values => [ @values ],
 501  *   time   => $time,
 502  *   host   => $host,
 503  *   plugin => $plugin,
 504  *   plugin_instance => $pinstance,
 505  *   type_instance   => $tinstance,
 506  * }
 507  */
 508 static int pplugin_dispatch_values (pTHX_ char *name, HV *values)
 509 {
 510         value_list_t list = VALUE_LIST_INIT;
 511         value_t      *val = NULL;
 512
 513         SV **tmp = NULL;
 514
 515         int ret = 0;
 516
 517         if ((NULL == name) || (NULL == values))
 518                 return -1;
 519
 520         if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
 521                         || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
 522                 log_err ("pplugin_dispatch_values: No valid values given.");
 523                 return -1;
 524         }
 525
 526         {
 527                 AV  *array = (AV *)SvRV (*tmp);
 528                 int len    = av_len (array) + 1;
 529
 530                 if (len <= 0)
 531                         return -1;
 532
 533                 val = (value_t *)smalloc (len * sizeof (value_t));
 534
 535                 list.values_len = av2value (aTHX_ name, (AV *)SvRV (*tmp), val, len);
 536                 list.values = val;
 537
 538                 if (-1 == list.values_len) {
 539                         sfree (val);
 540                         return -1;
 541                 }
 542         }
 543
 544         if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
 545                 list.time = (time_t)SvIV (*tmp);
 546         }
 547         else {
 548                 list.time = time (NULL);
 549         }
 550
 551         if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
 552                 strncpy (list.host, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
 553                 list.host[DATA_MAX_NAME_LEN - 1] = '\0';
 554         }
 555         else {
 556                 strcpy (list.host, hostname_g);
 557         }
 558
 559         if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0))) {
 560                 strncpy (list.plugin, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
 561                 list.plugin[DATA_MAX_NAME_LEN - 1] = '\0';
 562         }
 563
 564         if (NULL != (tmp = hv_fetch (values, "plugin_instance", 15, 0))) {
 565                 strncpy (list.plugin_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
 566                 list.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
 567         }
 568
 569         if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0))) {
 570                 strncpy (list.type_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
 571                 list.type_instance[DATA_MAX_NAME_LEN - 1] = '\0';
 572         }
 573
 574         ret = plugin_dispatch_values (name, &list);
 575
 576         sfree (val);
 577         return ret;
 578 } /* static int pplugin_dispatch_values (char *, HV *) */
 579
 580 /*
 581  * Dispatch a notification.
 582  *
 583  * notification:
 584  * {
 585  *   severity => $severity,
 586  *   time     => $time,
 587  *   message  => $msg,
 588  *   host     => $host,
 589  *   plugin   => $plugin,
 590  *   type     => $type,
 591  *   plugin_instance => $instance,
 592  *   type_instance   => $type_instance
 593  * }
 594  */
 595 static int pplugin_dispatch_notification (pTHX_ HV *notif)
 596 {
 597         notification_t n;
 598
 599         SV **tmp = NULL;
 600
 601         if (NULL == notif)
 602                 return -1;
 603
 604         memset (&n, 0, sizeof (n));
 605
 606         if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
 607                 n.severity = SvIV (*tmp);
 608         else
 609                 n.severity = NOTIF_FAILURE;
 610
 611         if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
 612                 n.time = (time_t)SvIV (*tmp);
 613         else
 614                 n.time = time (NULL);
 615
 616         if (NULL != (tmp = hv_fetch (notif, "message", 7, 0)))
 617                 strncpy (n.message, SvPV_nolen (*tmp), sizeof (n.message));
 618         n.message[sizeof (n.message) - 1] = '\0';
 619
 620         if (NULL != (tmp = hv_fetch (notif, "host", 4, 0)))
 621                 strncpy (n.host, SvPV_nolen (*tmp), sizeof (n.host));
 622         else
 623                 strncpy (n.host, hostname_g, sizeof (n.host));
 624         n.host[sizeof (n.host) - 1] = '\0';
 625
 626         if (NULL != (tmp = hv_fetch (notif, "plugin", 6, 0)))
 627                 strncpy (n.plugin, SvPV_nolen (*tmp), sizeof (n.plugin));
 628         n.plugin[sizeof (n.plugin) - 1] = '\0';
 629
 630         if (NULL != (tmp = hv_fetch (notif, "plugin_instance", 15, 0)))
 631                 strncpy (n.plugin_instance, SvPV_nolen (*tmp),
 632                                 sizeof (n.plugin_instance));
 633         n.plugin_instance[sizeof (n.plugin_instance) - 1] = '\0';
 634
 635         if (NULL != (tmp = hv_fetch (notif, "type", 4, 0)))
 636                 strncpy (n.type, SvPV_nolen (*tmp), sizeof (n.type));
 637         n.type[sizeof (n.type) - 1] = '\0';
 638
 639         if (NULL != (tmp = hv_fetch (notif, "type_instance", 13, 0)))
 640                 strncpy (n.type_instance, SvPV_nolen (*tmp), sizeof (n.type_instance));
 641         n.type_instance[sizeof (n.type_instance) - 1] = '\0';
 642         return plugin_dispatch_notification (&n);
 643 } /* static int pplugin_dispatch_notification (HV *) */
 644
 645 /*
 646  * Call all working functions of the given type.
 647  */
 648 static int pplugin_call_all (pTHX_ int type, ...)
 649 {
 650         int retvals = 0;
 651
 652         va_list ap;
 653         int ret = 0;
 654
 655         dSP;
 656
 657         if ((type < 0) || (type >= PLUGIN_TYPES))
 658                 return -1;
 659
 660         va_start (ap, type);
 661
 662         ENTER;
 663         SAVETMPS;
 664
 665         PUSHMARK (SP);
 666
 667         XPUSHs (sv_2mortal (newSViv ((IV)type)));
 668
 669         if (PLUGIN_WRITE == type) {
 670                 /*
 671                  * $_[0] = $plugin_type;
 672                  *
 673                  * $_[1] =
 674                  * [
 675                  *   {
 676                  *     name => $ds_name,
 677                  *     type => $ds_type,
 678                  *     min  => $ds_min,
 679                  *     max  => $ds_max
 680                  *   },
 681                  *   ...
 682                  * ];
 683                  *
 684                  * $_[2] =
 685                  * {
 686                  *   values => [ $v1, ... ],
 687                  *   time   => $time,
 688                  *   host   => $hostname,
 689                  *   plugin => $plugin,
 690                  *   plugin_instance => $instance,
 691                  *   type_instance   => $type_instance
 692                  * };
 693                  */
 694                 data_set_t   *ds;
 695                 value_list_t *vl;
 696
 697                 AV *pds = newAV ();
 698                 HV *pvl = newHV ();
 699
 700                 ds = va_arg (ap, data_set_t *);
 701                 vl = va_arg (ap, value_list_t *);
 702
 703                 if (-1 == data_set2av (aTHX_ ds, pds))
 704                         return -1;
 705
 706                 if (-1 == value_list2hv (aTHX_ vl, ds, pvl))
 707                         return -1;
 708
 709                 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
 710                 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
 711                 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
 712         }
 713         else if (PLUGIN_LOG == type) {
 714                 /*
 715                  * $_[0] = $level;
 716                  *
 717                  * $_[1] = $message;
 718                  */
 719                 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
 720                 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
 721         }
 722         else if (PLUGIN_NOTIF == type) {
 723                 /*
 724                  * $_[0] =
 725                  * {
 726                  *   severity => $severity,
 727                  *   time     => $time,
 728                  *   message  => $msg,
 729                  *   host     => $host,
 730                  *   plugin   => $plugin,
 731                  *   type     => $type,
 732                  *   plugin_instance => $instance,
 733                  *   type_instance   => $type_instance
 734                  * };
 735                  */
 736                 notification_t *n;
 737                 HV *notif = newHV ();
 738
 739                 n = va_arg (ap, notification_t *);
 740
 741                 if (-1 == notification2hv (aTHX_ n, notif))
 742                         return -1;
 743
 744                 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
 745         }
 746
 747         PUTBACK;
 748
 749         retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
 750
 751         SPAGAIN;
 752         if (0 < retvals) {
 753                 SV *tmp = POPs;
 754                 if (! SvTRUE (tmp))
 755                         ret = -1;
 756         }
 757
 758         PUTBACK;
 759         FREETMPS;
 760         LEAVE;
 761
 762         va_end (ap);
 763         return ret;
 764 } /* static int pplugin_call_all (int, ...) */
 765
 766 /*
 767  * Exported Perl API.
 768  */
 769
 770 /*
 771  * Collectd::plugin_register_data_set (type, dataset).
 772  *
 773  * type:
 774  *   type of the dataset
 775  *
 776  * dataset:
 777  *   dataset to be registered
 778  */
 779 static XS (Collectd_plugin_register_ds)
 780 {
 781         SV  *data = NULL;
 782         int ret   = 0;
 783
 784         dXSARGS;
 785
 786         if (2 != items) {
 787                 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
 788                 XSRETURN_EMPTY;
 789         }
 790
 791         log_debug ("Collectd::plugin_register_data_set: "
 792                         "type = \"%s\", dataset = \"%s\"",
 793                         SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
 794
 795         data = ST (1);
 796
 797         if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
 798                 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
 799                                 (AV *)SvRV (data));
 800         }
 801         else {
 802                 log_err ("Collectd::plugin_register_data_set: Invalid data.");
 803                 XSRETURN_EMPTY;
 804         }
 805
 806         if (0 == ret)
 807                 XSRETURN_YES;
 808         else
 809                 XSRETURN_EMPTY;
 810 } /* static XS (Collectd_plugin_register_ds) */
 811
 812 /*
 813  * Collectd::plugin_unregister_data_set (type).
 814  *
 815  * type:
 816  *   type of the dataset
 817  */
 818 static XS (Collectd_plugin_unregister_ds)
 819 {
 820         dXSARGS;
 821
 822         if (1 != items) {
 823                 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
 824                 XSRETURN_EMPTY;
 825         }
 826
 827         log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
 828                         SvPV_nolen (ST (0)));
 829
 830         if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (0))))
 831                 XSRETURN_YES;
 832         else
 833                 XSRETURN_EMPTY;
 834 } /* static XS (Collectd_plugin_register_ds) */
 835
 836 /*
 837  * Collectd::plugin_dispatch_values (name, values).
 838  *
 839  * name:
 840  *   name of the plugin
 841  *
 842  * values:
 843  *   value list to submit
 844  */
 845 static XS (Collectd_plugin_dispatch_values)
 846 {
 847         SV *values = NULL;
 848
 849         int ret = 0;
 850
 851         dXSARGS;
 852
 853         if (2 != items) {
 854                 log_err ("Usage: Collectd::plugin_dispatch_values(name, values)");
 855                 XSRETURN_EMPTY;
 856         }
 857
 858         log_debug ("Collectd::plugin_dispatch_values: "
 859                         "name = \"%s\", values=\"%s\"",
 860                         SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
 861
 862         values = ST (1);
 863
 864         if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
 865                 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
 866                 XSRETURN_EMPTY;
 867         }
 868
 869         if ((NULL == ST (0)) || (NULL == values))
 870                 XSRETURN_EMPTY;
 871
 872         ret = pplugin_dispatch_values (aTHX_ SvPV_nolen (ST (0)),
 873                         (HV *)SvRV (values));
 874
 875         if (0 == ret)
 876                 XSRETURN_YES;
 877         else
 878                 XSRETURN_EMPTY;
 879 } /* static XS (Collectd_plugin_dispatch_values) */
 880
 881 /*
 882  * Collectd::plugin_dispatch_notification (notif).
 883  *
 884  * notif:
 885  *   notification to dispatch
 886  */
 887 static XS (Collectd_plugin_dispatch_notification)
 888 {
 889         SV *notif = NULL;
 890
 891         int ret = 0;
 892
 893         dXSARGS;
 894
 895         if (1 != items) {
 896                 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
 897                 XSRETURN_EMPTY;
 898         }
 899
 900         log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
 901                         SvPV_nolen (ST (0)));
 902
 903         notif = ST (0);
 904
 905         if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
 906                 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
 907                 XSRETURN_EMPTY;
 908         }
 909
 910         ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
 911
 912         if (0 == ret)
 913                 XSRETURN_YES;
 914         else
 915                 XSRETURN_EMPTY;
 916 } /* static XS (Collectd_plugin_dispatch_notification) */
 917
 918 /*
 919  * Collectd::plugin_log (level, message).
 920  *
 921  * level:
 922  *   log level (LOG_DEBUG, ... LOG_ERR)
 923  *
 924  * message:
 925  *   log message
 926  */
 927 static XS (Collectd_plugin_log)
 928 {
 929         dXSARGS;
 930
 931         if (2 != items) {
 932                 log_err ("Usage: Collectd::plugin_log(level, message)");
 933                 XSRETURN_EMPTY;
 934         }
 935
 936         plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
 937         XSRETURN_YES;
 938 } /* static XS (Collectd_plugin_log) */
 939
 940 /*
 941  * Collectd::call_by_name (...).
 942  *
 943  * Call a Perl sub identified by its name passed through $Collectd::cb_name.
 944  */
 945 static XS (Collectd_call_by_name)
 946 {
 947         SV   *tmp  = NULL;
 948         char *name = NULL;
 949
 950         if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
 951                 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
 952                 CLEAR_STACK_FRAME;
 953                 return;
 954         }
 955
 956         name = SvPV_nolen (tmp);
 957
 958         if (NULL == get_cv (name, 0)) {
 959                 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
 960                 CLEAR_STACK_FRAME;
 961                 return;
 962         }
 963
 964         /* simply pass on the subroutine call without touching the stack,
 965          * thus leaving any arguments and return values in place */
 966         call_pv (name, 0);
 967 } /* static XS (Collectd_call_by_name) */
 968
 969 /*
 970  * collectd's perl interpreter based thread implementation.
 971  *
 972  * This has been inspired by Perl's ithreads introduced in version 5.6.0.
 973  */
 974
 975 /* must be called with perl_threads->mutex locked */
 976 static void c_ithread_destroy (c_ithread_t *ithread)
 977 {
 978         dTHXa (ithread->interp);
 979
 980         assert (NULL != perl_threads);
 981
 982         PERL_SET_CONTEXT (aTHX);
 983         log_debug ("Shutting down Perl interpreter %p...", aTHX);
 984
 985 #if COLLECT_DEBUG
 986         sv_report_used ();
 987
 988         --perl_threads->number_of_threads;
 989 #endif /* COLLECT_DEBUG */
 990
 991         perl_destruct (aTHX);
 992         perl_free (aTHX);
 993
 994         if (NULL == ithread->prev)
 995                 perl_threads->head = ithread->next;
 996         else
 997                 ithread->prev->next = ithread->next;
 998
 999         if (NULL == ithread->next)
1000                 perl_threads->tail = ithread->prev;
1001         else
1002                 ithread->next->prev = ithread->prev;
1003
1004         sfree (ithread);
1005         return;
1006 } /* static void c_ithread_destroy (c_ithread_t *) */
1007
1008 static void c_ithread_destructor (void *arg)
1009 {
1010         c_ithread_t *ithread = (c_ithread_t *)arg;
1011         c_ithread_t *t = NULL;
1012
1013         if (NULL == perl_threads)
1014                 return;
1015
1016         pthread_mutex_lock (&perl_threads->mutex);
1017
1018         for (t = perl_threads->head; NULL != t; t = t->next)
1019                 if (t == ithread)
1020                         break;
1021
1022         /* the ithread no longer exists */
1023         if (NULL == t)
1024                 return;
1025
1026         c_ithread_destroy (ithread);
1027
1028         pthread_mutex_unlock (&perl_threads->mutex);
1029         return;
1030 } /* static void c_ithread_destructor (void *) */
1031
1032 /* must be called with perl_threads->mutex locked */
1033 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
1034 {
1035         c_ithread_t *t = NULL;
1036         dTHXa (NULL);
1037
1038         assert (NULL != perl_threads);
1039
1040         t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
1041         memset (t, 0, sizeof (c_ithread_t));
1042
1043         t->interp = (NULL == base)
1044                 ? NULL
1045                 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1046
1047         aTHX = t->interp;
1048
1049         if (NULL != base) {
1050                 av_clear (PL_endav);
1051                 av_undef (PL_endav);
1052                 PL_endav = Nullav;
1053         }
1054
1055 #if COLLECT_DEBUG
1056         ++perl_threads->number_of_threads;
1057 #endif /* COLLECT_DEBUG */
1058
1059         t->next = NULL;
1060
1061         if (NULL == perl_threads->tail) {
1062                 perl_threads->head = t;
1063                 t->prev = NULL;
1064         }
1065         else {
1066                 perl_threads->tail->next = t;
1067                 t->prev = perl_threads->tail;
1068         }
1069
1070         perl_threads->tail = t;
1071
1072         pthread_setspecific (perl_thr_key, (const void *)t);
1073         return t;
1074 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1075
1076 /*
1077  * Interface to collectd.
1078  */
1079
1080 static int perl_init (void)
1081 {
1082         dTHX;
1083
1084         if (NULL == perl_threads)
1085                 return 0;
1086
1087         if (NULL == aTHX) {
1088                 c_ithread_t *t = NULL;
1089
1090                 pthread_mutex_lock (&perl_threads->mutex);
1091                 t = c_ithread_create (perl_threads->head->interp);
1092                 pthread_mutex_unlock (&perl_threads->mutex);
1093
1094                 aTHX = t->interp;
1095         }
1096
1097         log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
1098                         aTHX, perl_threads->number_of_threads);
1099         return pplugin_call_all (aTHX_ PLUGIN_INIT);
1100 } /* static int perl_init (void) */
1101
1102 static int perl_read (void)
1103 {
1104         dTHX;
1105
1106         if (NULL == perl_threads)
1107                 return 0;
1108
1109         if (NULL == aTHX) {
1110                 c_ithread_t *t = NULL;
1111
1112                 pthread_mutex_lock (&perl_threads->mutex);
1113                 t = c_ithread_create (perl_threads->head->interp);
1114                 pthread_mutex_unlock (&perl_threads->mutex);
1115
1116                 aTHX = t->interp;
1117         }
1118
1119         log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1120                         aTHX, perl_threads->number_of_threads);
1121         return pplugin_call_all (aTHX_ PLUGIN_READ);
1122 } /* static int perl_read (void) */
1123
1124 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1125 {
1126         dTHX;
1127
1128         if (NULL == perl_threads)
1129                 return 0;
1130
1131         if (NULL == aTHX) {
1132                 c_ithread_t *t = NULL;
1133
1134                 pthread_mutex_lock (&perl_threads->mutex);
1135                 t = c_ithread_create (perl_threads->head->interp);
1136                 pthread_mutex_unlock (&perl_threads->mutex);
1137
1138                 aTHX = t->interp;
1139         }
1140
1141         log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1142                         aTHX, perl_threads->number_of_threads);
1143         return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1144 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1145
1146 static void perl_log (int level, const char *msg)
1147 {
1148         dTHX;
1149
1150         if (NULL == perl_threads)
1151                 return;
1152
1153         if (NULL == aTHX) {
1154                 c_ithread_t *t = NULL;
1155
1156                 pthread_mutex_lock (&perl_threads->mutex);
1157                 t = c_ithread_create (perl_threads->head->interp);
1158                 pthread_mutex_unlock (&perl_threads->mutex);
1159
1160                 aTHX = t->interp;
1161         }
1162
1163         pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1164         return;
1165 } /* static void perl_log (int, const char *) */
1166
1167 static int perl_notify (const notification_t *notif)
1168 {
1169         dTHX;
1170
1171         if (NULL == perl_threads)
1172                 return 0;
1173
1174         if (NULL == aTHX) {
1175                 c_ithread_t *t = NULL;
1176
1177                 pthread_mutex_lock (&perl_threads->mutex);
1178                 t = c_ithread_create (perl_threads->head->interp);
1179                 pthread_mutex_unlock (&perl_threads->mutex);
1180
1181                 aTHX = t->interp;
1182         }
1183         return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1184 } /* static int perl_notify (const notification_t *) */
1185
1186 static int perl_shutdown (void)
1187 {
1188         c_ithread_t *t = NULL;
1189
1190         int ret = 0;
1191
1192         dTHX;
1193
1194         plugin_unregister_complex_config ("perl");
1195
1196         if (NULL == perl_threads)
1197                 return 0;
1198
1199         if (NULL == aTHX) {
1200                 c_ithread_t *t = NULL;
1201
1202                 pthread_mutex_lock (&perl_threads->mutex);
1203                 t = c_ithread_create (perl_threads->head->interp);
1204                 pthread_mutex_unlock (&perl_threads->mutex);
1205
1206                 aTHX = t->interp;
1207         }
1208
1209         log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1210                         aTHX, perl_threads->number_of_threads);
1211
1212         plugin_unregister_log ("perl");
1213         plugin_unregister_notification ("perl");
1214         plugin_unregister_init ("perl");
1215         plugin_unregister_read ("perl");
1216         plugin_unregister_write ("perl");
1217
1218         ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1219
1220         pthread_mutex_lock (&perl_threads->mutex);
1221         t = perl_threads->tail;
1222
1223         while (NULL != t) {
1224                 c_ithread_t *thr = t;
1225
1226                 /* the pointer has to be advanced before destroying
1227                  * the thread as this will free the memory */
1228                 t = t->prev;
1229
1230                 c_ithread_destroy (thr);
1231         }
1232
1233         pthread_mutex_unlock (&perl_threads->mutex);
1234         pthread_mutex_destroy (&perl_threads->mutex);
1235
1236         sfree (perl_threads);
1237
1238         pthread_key_delete (perl_thr_key);
1239
1240         PERL_SYS_TERM ();
1241
1242         plugin_unregister_shutdown ("perl");
1243         return ret;
1244 } /* static void perl_shutdown (void) */
1245
1246 /*
1247  * Access functions for global variables.
1248  *
1249  * These functions implement the "magic" used to access
1250  * the global variables from Perl.
1251  */
1252
1253 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1254 {
1255         char *pv = mg->mg_ptr;
1256         sv_setpv (var, pv);
1257         return 0;
1258 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1259
1260 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1261 {
1262         char *pv = mg->mg_ptr;
1263         strncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1264         pv[DATA_MAX_NAME_LEN - 1] = '\0';
1265         return 0;
1266 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1267
1268 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1269 {
1270         int *iv = (int *)mg->mg_ptr;
1271         sv_setiv (var, *iv);
1272         return 0;
1273 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1274
1275 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1276 {
1277         int *iv = (int *)mg->mg_ptr;
1278         *iv = (int)SvIV (var);
1279         return 0;
1280 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1281
1282 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1283 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1284
1285 /* bootstrap the Collectd module */
1286 static void xs_init (pTHX)
1287 {
1288         HV   *stash = NULL;
1289         SV   *tmp   = NULL;
1290         char *file  = __FILE__;
1291
1292         int i = 0;
1293
1294         dXSUB_SYS;
1295
1296         /* enable usage of Perl modules using shared libraries */
1297         newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1298
1299         /* register API */
1300         for (i = 0; NULL != api[i].f; ++i)
1301                 newXS (api[i].name, api[i].f, file);
1302
1303         stash = gv_stashpv ("Collectd", 1);
1304
1305         /* export "constants" */
1306         for (i = 0; '\0' != constants[i].name[0]; ++i)
1307                 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1308
1309         /* export global variables
1310          * by adding "magic" to the SV's representing the globale variables
1311          * perl is able to automagically call the get/set function when
1312          * accessing any such variable (this is basically the same as using
1313          * tie() in Perl) */
1314         /* global strings */
1315         for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1316                 tmp = get_sv (g_strings[i].name, 1);
1317                 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1318                                 g_strings[i].var, 0);
1319         }
1320
1321         /* global integers */
1322         for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1323                 tmp = get_sv (g_integers[i].name, 1);
1324                 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1325                                 (char *)g_integers[i].var, 0);
1326         }
1327         return;
1328 } /* static void xs_init (pTHX) */
1329
1330 /* Initialize the global Perl interpreter. */
1331 static int init_pi (int argc, char **argv)
1332 {
1333         dTHXa (NULL);
1334
1335         if (NULL != perl_threads)
1336                 return 0;
1337
1338         log_info ("Initializing Perl interpreter...");
1339 #if COLLECT_DEBUG
1340         {
1341                 int i = 0;
1342
1343                 for (i = 0; i < argc; ++i)
1344                         log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1345         }
1346 #endif /* COLLECT_DEBUG */
1347
1348         if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1349                 log_err ("init_pi: pthread_key_create failed");
1350
1351                 /* this must not happen - cowardly giving up if it does */
1352                 exit (1);
1353         }
1354
1355         PERL_SYS_INIT3 (&argc, &argv, &environ);
1356
1357         perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1358         memset (perl_threads, 0, sizeof (c_ithread_list_t));
1359
1360         pthread_mutex_init (&perl_threads->mutex, NULL);
1361         /* locking the mutex should not be necessary at this point
1362          * but let's just do it for the sake of completeness */
1363         pthread_mutex_lock (&perl_threads->mutex);
1364
1365         perl_threads->head = c_ithread_create (NULL);
1366         perl_threads->tail = perl_threads->head;
1367
1368         if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1369                 log_err ("init_pi: Not enough memory.");
1370                 exit (3);
1371         }
1372
1373         aTHX = perl_threads->head->interp;
1374         pthread_mutex_unlock (&perl_threads->mutex);
1375
1376         perl_construct (aTHX);
1377
1378         PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1379
1380         if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1381                 log_err ("init_pi: Unable to bootstrap Collectd.");
1382                 exit (1);
1383         }
1384
1385         /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1386         sv_setpv (get_sv ("0", 0), "collectd");
1387
1388         perl_run (aTHX);
1389
1390         plugin_register_log ("perl", perl_log);
1391         plugin_register_notification ("perl", perl_notify);
1392         plugin_register_init ("perl", perl_init);
1393
1394         plugin_register_read ("perl", perl_read);
1395
1396         plugin_register_write ("perl", perl_write);
1397         plugin_register_shutdown ("perl", perl_shutdown);
1398         return 0;
1399 } /* static int init_pi (const char **, const int) */
1400
1401 /*
1402  * LoadPlugin "<Plugin>"
1403  */
1404 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1405 {
1406         char module_name[DATA_MAX_NAME_LEN];
1407
1408         char *value = NULL;
1409
1410         if ((0 != ci->children_num) || (1 != ci->values_num)
1411                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1412                 log_err ("LoadPlugin expects a single string argument.");
1413                 return 1;
1414         }
1415
1416         value = ci->values[0].value.string;
1417
1418         if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1419                 log_err ("Invalid module name %s", value);
1420                 return (1);
1421         }
1422
1423         init_pi (perl_argc, perl_argv);
1424         assert (NULL != perl_threads);
1425         assert (NULL != perl_threads->head);
1426
1427         aTHX = perl_threads->head->interp;
1428
1429         log_debug ("perl_config: loading perl plugin \"%s\"", value);
1430         load_module (PERL_LOADMOD_NOIMPORT,
1431                         newSVpv (module_name, strlen (module_name)), Nullsv);
1432         return 0;
1433 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1434
1435 /*
1436  * BaseName "<Name>"
1437  */
1438 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1439 {
1440         char *value = NULL;
1441
1442         if ((0 != ci->children_num) || (1 != ci->values_num)
1443                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1444                 log_err ("BaseName expects a single string argument.");
1445                 return 1;
1446         }
1447
1448         value = ci->values[0].value.string;
1449
1450         log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1451         strncpy (base_name, value, sizeof (base_name));
1452         base_name[sizeof (base_name) - 1] = '\0';
1453         return 0;
1454 } /* static int perl_config_basename (oconfig_item_it *) */
1455
1456 /*
1457  * EnableDebugger "<Package>"|""
1458  */
1459 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1460 {
1461         char *value = NULL;
1462
1463         if ((0 != ci->children_num) || (1 != ci->values_num)
1464                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1465                 log_err ("EnableDebugger expects a single string argument.");
1466                 return 1;
1467         }
1468
1469         value = ci->values[0].value.string;
1470
1471         perl_argv = (char **)realloc (perl_argv,
1472                         (++perl_argc + 1) * sizeof (char *));
1473
1474         if (NULL == perl_argv) {
1475                 log_err ("perl_config: Not enough memory.");
1476                 exit (3);
1477         }
1478
1479         if ('\0' == value[0]) {
1480                 perl_argv[perl_argc - 1] = "-d";
1481         }
1482         else {
1483                 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1484                 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1485                 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1486         }
1487
1488         perl_argv[perl_argc] = NULL;
1489         return 0;
1490 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1491
1492 /*
1493  * IncludeDir "<Dir>"
1494  */
1495 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1496 {
1497         char *value = NULL;
1498
1499         if ((0 != ci->children_num) || (1 != ci->values_num)
1500                         || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1501                 log_err ("IncludeDir expects a single string argument.");
1502                 return 1;
1503         }
1504
1505         value = ci->values[0].value.string;
1506
1507         if (NULL == aTHX) {
1508                 perl_argv = (char **)realloc (perl_argv,
1509                                 (++perl_argc + 1) * sizeof (char *));
1510
1511                 if (NULL == perl_argv) {
1512                         log_err ("perl_config: Not enough memory.");
1513                         exit (3);
1514                 }
1515
1516                 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1517                 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1518                 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1519
1520                 perl_argv[perl_argc] = NULL;
1521         }
1522         else {
1523                 /* prepend the directory to @INC */
1524                 av_unshift (GvAVn (PL_incgv), 1);
1525                 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1526         }
1527         return 0;
1528 } /* static int perl_config_includedir (oconfig_item_it *) */
1529
1530 static int perl_config (oconfig_item_t *ci)
1531 {
1532         int i = 0;
1533
1534         dTHX;
1535
1536         /* dTHX does not get any valid values in case Perl
1537          * has not been initialized */
1538         if (NULL == perl_threads)
1539                 aTHX = NULL;
1540
1541         for (i = 0; i < ci->children_num; ++i) {
1542                 oconfig_item_t *c = ci->children + i;
1543
1544                 if (0 == strcasecmp (c->key, "LoadPlugin"))
1545                         perl_config_loadplugin (aTHX_ c);
1546                 else if (0 == strcasecmp (c->key, "BaseName"))
1547                         perl_config_basename (aTHX_ c);
1548                 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1549                         perl_config_enabledebugger (aTHX_ c);
1550                 else if (0 == strcasecmp (c->key, "IncludeDir"))
1551                         perl_config_includedir (aTHX_ c);
1552                 else
1553                         log_warn ("Ignoring unknown config key \"%s\".", c->key);
1554         }
1555         return 0;
1556 } /* static int perl_config (oconfig_item_t *) */
1557
1558 void module_register (void)
1559 {
1560         perl_argc = 4;
1561         perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1562
1563         /* default options for the Perl interpreter */
1564         perl_argv[0] = "";
1565         perl_argv[1] = "-MCollectd";
1566         perl_argv[2] = "-e";
1567         perl_argv[3] = "1";
1568         perl_argv[4] = NULL;
1569
1570         plugin_register_complex_config ("perl", perl_config);
1571         return;
1572 } /* void module_register (void) */
1573
1574 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */
1575