1 /**
2 * collectd - src/perl.c
3 * Copyright (C) 2007, 2008 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 **/
22 /*
23 * This plugin embeds a Perl interpreter into collectd and provides an
24 * interface for collectd plugins written in perl.
25 */
27 /* do not automatically get the thread specific perl interpreter */
28 #define PERL_NO_GET_CONTEXT
30 #define DONT_POISON_SPRINTF_YET 1
31 #include "collectd.h"
32 #undef DONT_POISON_SPRINTF_YET
34 #include "configfile.h"
36 #include <EXTERN.h>
37 #include <perl.h>
39 #if __GNUC__
40 # pragma GCC poison sprintf
41 #endif
43 #include <XSUB.h>
45 /* Some versions of Perl define their own version of DEBUG... :-/ */
46 #ifdef DEBUG
47 # undef DEBUG
48 #endif /* DEBUG */
50 /* ... while we want the definition found in plugin.h. */
51 #include "plugin.h"
52 #include "common.h"
54 #include <pthread.h>
56 #if !defined(USE_ITHREADS)
57 # error "Perl does not support ithreads!"
58 #endif /* !defined(USE_ITHREADS) */
60 /* clear the Perl sub's stack frame
61 * (this should only be used inside an XSUB) */
62 #define CLEAR_STACK_FRAME PL_stack_sp = PL_stack_base + *PL_markstack_ptr
64 #define PLUGIN_INIT 0
65 #define PLUGIN_READ 1
66 #define PLUGIN_WRITE 2
67 #define PLUGIN_SHUTDOWN 3
68 #define PLUGIN_LOG 4
69 #define PLUGIN_NOTIF 5
70 #define PLUGIN_FLUSH 6
72 #define PLUGIN_TYPES 7
74 #define PLUGIN_CONFIG 254
75 #define PLUGIN_DATASET 255
77 #define log_debug(...) DEBUG ("perl: " __VA_ARGS__)
78 #define log_info(...) INFO ("perl: " __VA_ARGS__)
79 #define log_warn(...) WARNING ("perl: " __VA_ARGS__)
80 #define log_err(...) ERROR ("perl: " __VA_ARGS__)
82 /* this is defined in DynaLoader.a */
83 void boot_DynaLoader (PerlInterpreter *, CV *);
85 static XS (Collectd_plugin_register_ds);
86 static XS (Collectd_plugin_unregister_ds);
87 static XS (Collectd_plugin_dispatch_values);
88 static XS (Collectd__plugin_flush);
89 static XS (Collectd_plugin_dispatch_notification);
90 static XS (Collectd_plugin_log);
91 static XS (Collectd_call_by_name);
93 /*
94 * private data types
95 */
97 typedef struct c_ithread_s {
98 /* the thread's Perl interpreter */
99 PerlInterpreter *interp;
101 /* double linked list of threads */
102 struct c_ithread_s *prev;
103 struct c_ithread_s *next;
104 } c_ithread_t;
106 typedef struct {
107 c_ithread_t *head;
108 c_ithread_t *tail;
110 #if COLLECT_DEBUG
111 /* some usage stats */
112 int number_of_threads;
113 #endif /* COLLECT_DEBUG */
115 pthread_mutex_t mutex;
116 } c_ithread_list_t;
118 /*
119 * private variables
120 */
122 /* if perl_threads != NULL perl_threads->head must
123 * point to the "base" thread */
124 static c_ithread_list_t *perl_threads = NULL;
126 /* the key used to store each pthread's ithread */
127 static pthread_key_t perl_thr_key;
129 static int perl_argc = 0;
130 static char **perl_argv = NULL;
132 static char base_name[DATA_MAX_NAME_LEN] = "";
134 static struct {
135 char name[64];
136 XS ((*f));
137 } api[] =
138 {
139 { "Collectd::plugin_register_data_set", Collectd_plugin_register_ds },
140 { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
141 { "Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values },
142 { "Collectd::_plugin_flush", Collectd__plugin_flush },
143 { "Collectd::plugin_dispatch_notification",
144 Collectd_plugin_dispatch_notification },
145 { "Collectd::plugin_log", Collectd_plugin_log },
146 { "Collectd::call_by_name", Collectd_call_by_name },
147 { "", NULL }
148 };
150 struct {
151 char name[64];
152 int value;
153 } constants[] =
154 {
155 { "Collectd::TYPE_INIT", PLUGIN_INIT },
156 { "Collectd::TYPE_READ", PLUGIN_READ },
157 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
158 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
159 { "Collectd::TYPE_LOG", PLUGIN_LOG },
160 { "Collectd::TYPE_NOTIF", PLUGIN_NOTIF },
161 { "Collectd::TYPE_FLUSH", PLUGIN_FLUSH },
162 { "Collectd::TYPE_CONFIG", PLUGIN_CONFIG },
163 { "Collectd::TYPE_DATASET", PLUGIN_DATASET },
164 { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
165 { "Collectd::DS_TYPE_GAUGE", DS_TYPE_GAUGE },
166 { "Collectd::LOG_ERR", LOG_ERR },
167 { "Collectd::LOG_WARNING", LOG_WARNING },
168 { "Collectd::LOG_NOTICE", LOG_NOTICE },
169 { "Collectd::LOG_INFO", LOG_INFO },
170 { "Collectd::LOG_DEBUG", LOG_DEBUG },
171 { "Collectd::NOTIF_FAILURE", NOTIF_FAILURE },
172 { "Collectd::NOTIF_WARNING", NOTIF_WARNING },
173 { "Collectd::NOTIF_OKAY", NOTIF_OKAY },
174 { "", 0 }
175 };
177 struct {
178 char name[64];
179 char *var;
180 } g_strings[] =
181 {
182 { "Collectd::hostname_g", hostname_g },
183 { "", NULL }
184 };
186 struct {
187 char name[64];
188 int *var;
189 } g_integers[] =
190 {
191 { "Collectd::interval_g", &interval_g },
192 { "", NULL }
193 };
195 /*
196 * Helper functions for data type conversion.
197 */
199 /*
200 * data source:
201 * [
202 * {
203 * name => $ds_name,
204 * type => $ds_type,
205 * min => $ds_min,
206 * max => $ds_max
207 * },
208 * ...
209 * ]
210 */
211 static int hv2data_source (pTHX_ HV *hash, data_source_t *ds)
212 {
213 SV **tmp = NULL;
215 if ((NULL == hash) || (NULL == ds))
216 return -1;
218 if (NULL != (tmp = hv_fetch (hash, "name", 4, 0))) {
219 sstrncpy (ds->name, SvPV_nolen (*tmp), sizeof (ds->name));
220 }
221 else {
222 log_err ("hv2data_source: No DS name given.");
223 return -1;
224 }
226 if (NULL != (tmp = hv_fetch (hash, "type", 4, 0))) {
227 ds->type = SvIV (*tmp);
229 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
230 log_err ("hv2data_source: Invalid DS type.");
231 return -1;
232 }
233 }
234 else {
235 ds->type = DS_TYPE_COUNTER;
236 }
238 if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
239 ds->min = SvNV (*tmp);
240 else
241 ds->min = NAN;
243 if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
244 ds->max = SvNV (*tmp);
245 else
246 ds->max = NAN;
247 return 0;
248 } /* static data_source_t *hv2data_source (HV *) */
250 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
251 {
252 const data_set_t *ds;
254 int i = 0;
256 if ((NULL == name) || (NULL == array) || (NULL == value))
257 return -1;
259 if (av_len (array) < len - 1)
260 len = av_len (array) + 1;
262 if (0 >= len)
263 return -1;
265 ds = plugin_get_ds (name);
266 if (NULL == ds) {
267 log_err ("av2value: Unknown dataset \"%s\"", name);
268 return -1;
269 }
271 if (ds->ds_num < len) {
272 log_warn ("av2value: Value length exceeds data set length.");
273 len = ds->ds_num;
274 }
276 for (i = 0; i < len; ++i) {
277 SV **tmp = av_fetch (array, i, 0);
279 if (NULL != tmp) {
280 if (DS_TYPE_COUNTER == ds->ds[i].type)
281 value[i].counter = SvIV (*tmp);
282 else
283 value[i].gauge = SvNV (*tmp);
284 }
285 else {
286 return -1;
287 }
288 }
289 return len;
290 } /* static int av2value (char *, AV *, value_t *, int) */
292 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
293 {
294 int i = 0;
296 if ((NULL == ds) || (NULL == array))
297 return -1;
299 av_extend (array, ds->ds_num);
301 for (i = 0; i < ds->ds_num; ++i) {
302 HV *source = newHV ();
304 if (NULL == hv_store (source, "name", 4,
305 newSVpv (ds->ds[i].name, 0), 0))
306 return -1;
308 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
309 return -1;
311 if (! isnan (ds->ds[i].min))
312 if (NULL == hv_store (source, "min", 3,
313 newSVnv (ds->ds[i].min), 0))
314 return -1;
316 if (! isnan (ds->ds[i].max))
317 if (NULL == hv_store (source, "max", 3,
318 newSVnv (ds->ds[i].max), 0))
319 return -1;
321 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
322 return -1;
323 }
324 return 0;
325 } /* static int data_set2av (data_set_t *, AV *) */
327 static int value_list2hv (pTHX_ value_list_t *vl, data_set_t *ds, HV *hash)
328 {
329 AV *values = NULL;
331 int i = 0;
332 int len = 0;
334 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
335 return -1;
337 len = vl->values_len;
339 if (ds->ds_num < len) {
340 log_warn ("value2av: Value length exceeds data set length.");
341 len = ds->ds_num;
342 }
344 values = newAV ();
345 av_extend (values, len - 1);
347 for (i = 0; i < len; ++i) {
348 SV *val = NULL;
350 if (DS_TYPE_COUNTER == ds->ds[i].type)
351 val = newSViv (vl->values[i].counter);
352 else
353 val = newSVnv (vl->values[i].gauge);
355 if (NULL == av_store (values, i, val)) {
356 av_undef (values);
357 return -1;
358 }
359 }
361 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
362 return -1;
364 if (0 != vl->time)
365 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
366 return -1;
368 if ('\0' != vl->host[0])
369 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
370 return -1;
372 if ('\0' != vl->plugin[0])
373 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
374 return -1;
376 if ('\0' != vl->plugin_instance[0])
377 if (NULL == hv_store (hash, "plugin_instance", 15,
378 newSVpv (vl->plugin_instance, 0), 0))
379 return -1;
381 if ('\0' != vl->type[0])
382 if (NULL == hv_store (hash, "type", 4, newSVpv (vl->type, 0), 0))
383 return -1;
385 if ('\0' != vl->type_instance[0])
386 if (NULL == hv_store (hash, "type_instance", 13,
387 newSVpv (vl->type_instance, 0), 0))
388 return -1;
389 return 0;
390 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
392 static int notification2hv (pTHX_ notification_t *n, HV *hash)
393 {
394 if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
395 return -1;
397 if (0 != n->time)
398 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
399 return -1;
401 if ('\0' != *n->message)
402 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
403 return -1;
405 if ('\0' != *n->host)
406 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
407 return -1;
409 if ('\0' != *n->plugin)
410 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
411 return -1;
413 if ('\0' != *n->plugin_instance)
414 if (NULL == hv_store (hash, "plugin_instance", 15,
415 newSVpv (n->plugin_instance, 0), 0))
416 return -1;
418 if ('\0' != *n->type)
419 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
420 return -1;
422 if ('\0' != *n->type_instance)
423 if (NULL == hv_store (hash, "type_instance", 13,
424 newSVpv (n->type_instance, 0), 0))
425 return -1;
426 return 0;
427 } /* static int notification2hv (notification_t *, HV *) */
429 static int oconfig_item2hv (pTHX_ oconfig_item_t *ci, HV *hash)
430 {
431 int i;
433 AV *values;
434 AV *children;
436 if (NULL == hv_store (hash, "key", 3, newSVpv (ci->key, 0), 0))
437 return -1;
439 values = newAV ();
440 if (0 < ci->values_num)
441 av_extend (values, ci->values_num);
443 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0)) {
444 av_clear (values);
445 av_undef (values);
446 return -1;
447 }
449 for (i = 0; i < ci->values_num; ++i) {
450 SV *value;
452 switch (ci->values[i].type) {
453 case OCONFIG_TYPE_STRING:
454 value = newSVpv (ci->values[i].value.string, 0);
455 break;
456 case OCONFIG_TYPE_NUMBER:
457 value = newSVnv ((NV)ci->values[i].value.number);
458 break;
459 case OCONFIG_TYPE_BOOLEAN:
460 value = ci->values[i].value.boolean ? &PL_sv_yes : &PL_sv_no;
461 break;
462 default:
463 log_err ("oconfig_item2hv: Invalid value type %i.",
464 ci->values[i].type);
465 value = &PL_sv_undef;
466 }
468 if (NULL == av_store (values, i, value)) {
469 sv_free (value);
470 return -1;
471 }
472 }
474 /* ignoring 'parent' member which is uninteresting in this case */
476 children = newAV ();
477 if (0 < ci->children_num)
478 av_extend (children, ci->children_num);
480 if (NULL == hv_store (hash, "children", 8, newRV_noinc ((SV *)children), 0)) {
481 av_clear (children);
482 av_undef (children);
483 return -1;
484 }
486 for (i = 0; i < ci->children_num; ++i) {
487 HV *child = newHV ();
489 if (0 != oconfig_item2hv (aTHX_ ci->children + i, child)) {
490 hv_clear (child);
491 hv_undef (child);
492 return -1;
493 }
495 if (NULL == av_store (children, i, newRV_noinc ((SV *)child))) {
496 hv_clear (child);
497 hv_undef (child);
498 return -1;
499 }
500 }
501 return 0;
502 } /* static int oconfig_item2hv (pTHX_ oconfig_item_t *, HV *) */
504 /*
505 * Internal functions.
506 */
508 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
509 int status = 0;
510 if (base_name[0] == '\0')
511 status = ssnprintf (buf, buf_len, "%s", module);
512 else
513 status = ssnprintf (buf, buf_len, "%s::%s", base_name, module);
514 if ((status < 0) || ((unsigned int)status >= buf_len))
515 return (NULL);
516 return (buf);
517 } /* char *get_module_name */
519 /*
520 * Add a plugin's data set definition.
521 */
522 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
523 {
524 int len = -1;
525 int ret = 0;
526 int i = 0;
528 data_source_t *ds = NULL;
529 data_set_t *set = NULL;
531 if ((NULL == name) || (NULL == dataset))
532 return -1;
534 len = av_len (dataset);
536 if (-1 == len)
537 return -1;
539 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
540 set = (data_set_t *)smalloc (sizeof (data_set_t));
542 for (i = 0; i <= len; ++i) {
543 SV **elem = av_fetch (dataset, i, 0);
545 if (NULL == elem)
546 return -1;
548 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
549 log_err ("pplugin_register_data_set: Invalid data source.");
550 return -1;
551 }
553 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
554 return -1;
556 log_debug ("pplugin_register_data_set: "
557 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
558 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
559 }
561 sstrncpy (set->type, name, sizeof (set->type));
563 set->ds_num = len + 1;
564 set->ds = ds;
566 ret = plugin_register_data_set (set);
568 free (ds);
569 free (set);
570 return ret;
571 } /* static int pplugin_register_data_set (char *, SV *) */
573 /*
574 * Remove a plugin's data set definition.
575 */
576 static int pplugin_unregister_data_set (char *name)
577 {
578 if (NULL == name)
579 return 0;
580 return plugin_unregister_data_set (name);
581 } /* static int pplugin_unregister_data_set (char *) */
583 /*
584 * Submit the values to the write functions.
585 *
586 * value list:
587 * {
588 * values => [ @values ],
589 * time => $time,
590 * host => $host,
591 * plugin => $plugin,
592 * plugin_instance => $pinstance,
593 * type_instance => $tinstance,
594 * }
595 */
596 static int pplugin_dispatch_values (pTHX_ HV *values)
597 {
598 value_list_t list = VALUE_LIST_INIT;
599 value_t *val = NULL;
601 SV **tmp = NULL;
603 int ret = 0;
605 if (NULL == values)
606 return -1;
608 if (NULL == (tmp = hv_fetch (values, "type", 4, 0))) {
609 log_err ("pplugin_dispatch_values: No type given.");
610 return -1;
611 }
613 sstrncpy (list.type, SvPV_nolen (*tmp), sizeof (list.type));
615 if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
616 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
617 log_err ("pplugin_dispatch_values: No valid values given.");
618 return -1;
619 }
621 {
622 AV *array = (AV *)SvRV (*tmp);
623 int len = av_len (array) + 1;
625 if (len <= 0)
626 return -1;
628 val = (value_t *)smalloc (len * sizeof (value_t));
630 list.values_len = av2value (aTHX_ list.type, (AV *)SvRV (*tmp),
631 val, len);
632 list.values = val;
634 if (-1 == list.values_len) {
635 sfree (val);
636 return -1;
637 }
638 }
640 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
641 list.time = (time_t)SvIV (*tmp);
642 }
643 else {
644 list.time = time (NULL);
645 }
647 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
648 sstrncpy (list.host, SvPV_nolen (*tmp), sizeof (list.host));
649 }
650 else {
651 sstrncpy (list.host, hostname_g, sizeof (list.host));
652 }
654 if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0)))
655 sstrncpy (list.plugin, SvPV_nolen (*tmp), sizeof (list.plugin));
657 if (NULL != (tmp = hv_fetch (values, "plugin_instance", 15, 0)))
658 sstrncpy (list.plugin_instance, SvPV_nolen (*tmp),
659 sizeof (list.plugin_instance));
661 if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0)))
662 sstrncpy (list.type_instance, SvPV_nolen (*tmp),
663 sizeof (list.type_instance));
665 ret = plugin_dispatch_values (&list);
667 sfree (val);
668 return ret;
669 } /* static int pplugin_dispatch_values (char *, HV *) */
671 /*
672 * Dispatch a notification.
673 *
674 * notification:
675 * {
676 * severity => $severity,
677 * time => $time,
678 * message => $msg,
679 * host => $host,
680 * plugin => $plugin,
681 * type => $type,
682 * plugin_instance => $instance,
683 * type_instance => $type_instance
684 * }
685 */
686 static int pplugin_dispatch_notification (pTHX_ HV *notif)
687 {
688 notification_t n;
690 SV **tmp = NULL;
692 if (NULL == notif)
693 return -1;
695 memset (&n, 0, sizeof (n));
697 if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
698 n.severity = SvIV (*tmp);
699 else
700 n.severity = NOTIF_FAILURE;
702 if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
703 n.time = (time_t)SvIV (*tmp);
704 else
705 n.time = time (NULL);
707 if (NULL != (tmp = hv_fetch (notif, "message", 7, 0)))
708 sstrncpy (n.message, SvPV_nolen (*tmp), sizeof (n.message));
710 if (NULL != (tmp = hv_fetch (notif, "host", 4, 0)))
711 sstrncpy (n.host, SvPV_nolen (*tmp), sizeof (n.host));
712 else
713 sstrncpy (n.host, hostname_g, sizeof (n.host));
715 if (NULL != (tmp = hv_fetch (notif, "plugin", 6, 0)))
716 sstrncpy (n.plugin, SvPV_nolen (*tmp), sizeof (n.plugin));
718 if (NULL != (tmp = hv_fetch (notif, "plugin_instance", 15, 0)))
719 sstrncpy (n.plugin_instance, SvPV_nolen (*tmp),
720 sizeof (n.plugin_instance));
722 if (NULL != (tmp = hv_fetch (notif, "type", 4, 0)))
723 sstrncpy (n.type, SvPV_nolen (*tmp), sizeof (n.type));
725 if (NULL != (tmp = hv_fetch (notif, "type_instance", 13, 0)))
726 sstrncpy (n.type_instance, SvPV_nolen (*tmp), sizeof (n.type_instance));
727 return plugin_dispatch_notification (&n);
728 } /* static int pplugin_dispatch_notification (HV *) */
730 /*
731 * Call all working functions of the given type.
732 */
733 static int pplugin_call_all (pTHX_ int type, ...)
734 {
735 int retvals = 0;
737 va_list ap;
738 int ret = 0;
740 dSP;
742 if ((type < 0) || (type >= PLUGIN_TYPES))
743 return -1;
745 va_start (ap, type);
747 ENTER;
748 SAVETMPS;
750 PUSHMARK (SP);
752 XPUSHs (sv_2mortal (newSViv ((IV)type)));
754 if (PLUGIN_WRITE == type) {
755 /*
756 * $_[0] = $plugin_type;
757 *
758 * $_[1] =
759 * [
760 * {
761 * name => $ds_name,
762 * type => $ds_type,
763 * min => $ds_min,
764 * max => $ds_max
765 * },
766 * ...
767 * ];
768 *
769 * $_[2] =
770 * {
771 * values => [ $v1, ... ],
772 * time => $time,
773 * host => $hostname,
774 * plugin => $plugin,
775 * type => $type,
776 * plugin_instance => $instance,
777 * type_instance => $type_instance
778 * };
779 */
780 data_set_t *ds;
781 value_list_t *vl;
783 AV *pds = newAV ();
784 HV *pvl = newHV ();
786 ds = va_arg (ap, data_set_t *);
787 vl = va_arg (ap, value_list_t *);
789 if (-1 == data_set2av (aTHX_ ds, pds)) {
790 av_clear (pds);
791 av_undef (pds);
792 pds = Nullav;
793 ret = -1;
794 }
796 if (-1 == value_list2hv (aTHX_ vl, ds, pvl)) {
797 hv_clear (pvl);
798 hv_undef (pvl);
799 pvl = Nullhv;
800 ret = -1;
801 }
803 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
804 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
805 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
806 }
807 else if (PLUGIN_LOG == type) {
808 /*
809 * $_[0] = $level;
810 *
811 * $_[1] = $message;
812 */
813 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
814 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
815 }
816 else if (PLUGIN_NOTIF == type) {
817 /*
818 * $_[0] =
819 * {
820 * severity => $severity,
821 * time => $time,
822 * message => $msg,
823 * host => $host,
824 * plugin => $plugin,
825 * type => $type,
826 * plugin_instance => $instance,
827 * type_instance => $type_instance
828 * };
829 */
830 notification_t *n;
831 HV *notif = newHV ();
833 n = va_arg (ap, notification_t *);
835 if (-1 == notification2hv (aTHX_ n, notif)) {
836 hv_clear (notif);
837 hv_undef (notif);
838 notif = Nullhv;
839 ret = -1;
840 }
842 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
843 }
844 else if (PLUGIN_FLUSH == type) {
845 /*
846 * $_[0] = $timeout;
847 * $_[1] = $identifier;
848 */
849 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
850 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
851 }
853 PUTBACK;
855 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
857 SPAGAIN;
858 if (0 < retvals) {
859 SV *tmp = POPs;
860 if (! SvTRUE (tmp))
861 ret = -1;
862 }
864 PUTBACK;
865 FREETMPS;
866 LEAVE;
868 va_end (ap);
869 return ret;
870 } /* static int pplugin_call_all (int, ...) */
872 /*
873 * Exported Perl API.
874 */
876 /*
877 * Collectd::plugin_register_data_set (type, dataset).
878 *
879 * type:
880 * type of the dataset
881 *
882 * dataset:
883 * dataset to be registered
884 */
885 static XS (Collectd_plugin_register_ds)
886 {
887 SV *data = NULL;
888 int ret = 0;
890 dXSARGS;
892 if (2 != items) {
893 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
894 XSRETURN_EMPTY;
895 }
897 log_debug ("Collectd::plugin_register_data_set: "
898 "type = \"%s\", dataset = \"%s\"",
899 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
901 data = ST (1);
903 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
904 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
905 (AV *)SvRV (data));
906 }
907 else {
908 log_err ("Collectd::plugin_register_data_set: Invalid data.");
909 XSRETURN_EMPTY;
910 }
912 if (0 == ret)
913 XSRETURN_YES;
914 else
915 XSRETURN_EMPTY;
916 } /* static XS (Collectd_plugin_register_ds) */
918 /*
919 * Collectd::plugin_unregister_data_set (type).
920 *
921 * type:
922 * type of the dataset
923 */
924 static XS (Collectd_plugin_unregister_ds)
925 {
926 dXSARGS;
928 if (1 != items) {
929 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
930 XSRETURN_EMPTY;
931 }
933 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
934 SvPV_nolen (ST (0)));
936 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (0))))
937 XSRETURN_YES;
938 else
939 XSRETURN_EMPTY;
940 } /* static XS (Collectd_plugin_register_ds) */
942 /*
943 * Collectd::plugin_dispatch_values (name, values).
944 *
945 * name:
946 * name of the plugin
947 *
948 * values:
949 * value list to submit
950 */
951 static XS (Collectd_plugin_dispatch_values)
952 {
953 SV *values = NULL;
954 int values_idx = 0;
956 int ret = 0;
958 dXSARGS;
960 if (2 == items) {
961 log_warn ("Collectd::plugin_dispatch_values with two arguments "
962 "is deprecated - pass the type through values->{type}.");
963 values_idx = 1;
964 }
965 else if (1 != items) {
966 log_err ("Usage: Collectd::plugin_dispatch_values(values)");
967 XSRETURN_EMPTY;
968 }
970 log_debug ("Collectd::plugin_dispatch_values: values=\"%s\"",
971 SvPV_nolen (ST (values_idx)));
973 values = ST (values_idx);
975 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
976 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
977 XSRETURN_EMPTY;
978 }
980 if (((2 == items) && (NULL == ST (0))) || (NULL == values))
981 XSRETURN_EMPTY;
983 if ((2 == items) && (NULL == hv_store ((HV *)SvRV (values), "type", 4,
984 newSVsv (ST (0)), 0))) {
985 log_err ("Collectd::plugin_dispatch_values: Could not store type.");
986 XSRETURN_EMPTY;
987 }
989 ret = pplugin_dispatch_values (aTHX_ (HV *)SvRV (values));
991 if (0 == ret)
992 XSRETURN_YES;
993 else
994 XSRETURN_EMPTY;
995 } /* static XS (Collectd_plugin_dispatch_values) */
997 /*
998 * Collectd::_plugin_flush (plugin, timeout, identifier).
999 *
1000 * plugin:
1001 * name of the plugin to flush
1002 *
1003 * timeout:
1004 * timeout to use when flushing the data
1005 *
1006 * identifier:
1007 * data-set identifier to flush
1008 */
1009 static XS (Collectd__plugin_flush)
1010 {
1011 char *plugin = NULL;
1012 int timeout = -1;
1013 char *id = NULL;
1015 dXSARGS;
1017 if (3 != items) {
1018 log_err ("Usage: Collectd::_plugin_flush(plugin, timeout, id)");
1019 XSRETURN_EMPTY;
1020 }
1022 if (SvOK (ST (0)))
1023 plugin = SvPV_nolen (ST (0));
1025 if (SvOK (ST (1)))
1026 timeout = (int)SvIV (ST (1));
1028 if (SvOK (ST (2)))
1029 id = SvPV_nolen (ST (2));
1031 log_debug ("Collectd::_plugin_flush: plugin = \"%s\", timeout = %i, "
1032 "id = \"%s\"", plugin, timeout, id);
1034 if (0 == plugin_flush (plugin, timeout, id))
1035 XSRETURN_YES;
1036 else
1037 XSRETURN_EMPTY;
1038 } /* static XS (Collectd__plugin_flush) */
1040 /*
1041 * Collectd::plugin_dispatch_notification (notif).
1042 *
1043 * notif:
1044 * notification to dispatch
1045 */
1046 static XS (Collectd_plugin_dispatch_notification)
1047 {
1048 SV *notif = NULL;
1050 int ret = 0;
1052 dXSARGS;
1054 if (1 != items) {
1055 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
1056 XSRETURN_EMPTY;
1057 }
1059 log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
1060 SvPV_nolen (ST (0)));
1062 notif = ST (0);
1064 if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
1065 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
1066 XSRETURN_EMPTY;
1067 }
1069 ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
1071 if (0 == ret)
1072 XSRETURN_YES;
1073 else
1074 XSRETURN_EMPTY;
1075 } /* static XS (Collectd_plugin_dispatch_notification) */
1077 /*
1078 * Collectd::plugin_log (level, message).
1079 *
1080 * level:
1081 * log level (LOG_DEBUG, ... LOG_ERR)
1082 *
1083 * message:
1084 * log message
1085 */
1086 static XS (Collectd_plugin_log)
1087 {
1088 dXSARGS;
1090 if (2 != items) {
1091 log_err ("Usage: Collectd::plugin_log(level, message)");
1092 XSRETURN_EMPTY;
1093 }
1095 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
1096 XSRETURN_YES;
1097 } /* static XS (Collectd_plugin_log) */
1099 /*
1100 * Collectd::call_by_name (...).
1101 *
1102 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
1103 */
1104 static XS (Collectd_call_by_name)
1105 {
1106 SV *tmp = NULL;
1107 char *name = NULL;
1109 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
1110 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
1111 CLEAR_STACK_FRAME;
1112 return;
1113 }
1115 name = SvPV_nolen (tmp);
1117 if (NULL == get_cv (name, 0)) {
1118 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
1119 CLEAR_STACK_FRAME;
1120 return;
1121 }
1123 /* simply pass on the subroutine call without touching the stack,
1124 * thus leaving any arguments and return values in place */
1125 call_pv (name, 0);
1126 } /* static XS (Collectd_call_by_name) */
1128 /*
1129 * collectd's perl interpreter based thread implementation.
1130 *
1131 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
1132 */
1134 /* must be called with perl_threads->mutex locked */
1135 static void c_ithread_destroy (c_ithread_t *ithread)
1136 {
1137 dTHXa (ithread->interp);
1139 assert (NULL != perl_threads);
1141 PERL_SET_CONTEXT (aTHX);
1142 log_debug ("Shutting down Perl interpreter %p...", aTHX);
1144 #if COLLECT_DEBUG
1145 sv_report_used ();
1147 --perl_threads->number_of_threads;
1148 #endif /* COLLECT_DEBUG */
1150 perl_destruct (aTHX);
1151 perl_free (aTHX);
1153 if (NULL == ithread->prev)
1154 perl_threads->head = ithread->next;
1155 else
1156 ithread->prev->next = ithread->next;
1158 if (NULL == ithread->next)
1159 perl_threads->tail = ithread->prev;
1160 else
1161 ithread->next->prev = ithread->prev;
1163 sfree (ithread);
1164 return;
1165 } /* static void c_ithread_destroy (c_ithread_t *) */
1167 static void c_ithread_destructor (void *arg)
1168 {
1169 c_ithread_t *ithread = (c_ithread_t *)arg;
1170 c_ithread_t *t = NULL;
1172 if (NULL == perl_threads)
1173 return;
1175 pthread_mutex_lock (&perl_threads->mutex);
1177 for (t = perl_threads->head; NULL != t; t = t->next)
1178 if (t == ithread)
1179 break;
1181 /* the ithread no longer exists */
1182 if (NULL == t)
1183 return;
1185 c_ithread_destroy (ithread);
1187 pthread_mutex_unlock (&perl_threads->mutex);
1188 return;
1189 } /* static void c_ithread_destructor (void *) */
1191 /* must be called with perl_threads->mutex locked */
1192 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
1193 {
1194 c_ithread_t *t = NULL;
1195 dTHXa (NULL);
1197 assert (NULL != perl_threads);
1199 t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
1200 memset (t, 0, sizeof (c_ithread_t));
1202 t->interp = (NULL == base)
1203 ? NULL
1204 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1206 aTHX = t->interp;
1208 if ((NULL != base) && (NULL != PL_endav)) {
1209 av_clear (PL_endav);
1210 av_undef (PL_endav);
1211 PL_endav = Nullav;
1212 }
1214 #if COLLECT_DEBUG
1215 ++perl_threads->number_of_threads;
1216 #endif /* COLLECT_DEBUG */
1218 t->next = NULL;
1220 if (NULL == perl_threads->tail) {
1221 perl_threads->head = t;
1222 t->prev = NULL;
1223 }
1224 else {
1225 perl_threads->tail->next = t;
1226 t->prev = perl_threads->tail;
1227 }
1229 perl_threads->tail = t;
1231 pthread_setspecific (perl_thr_key, (const void *)t);
1232 return t;
1233 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1235 /*
1236 * Interface to collectd.
1237 */
1239 static int perl_init (void)
1240 {
1241 dTHX;
1243 if (NULL == perl_threads)
1244 return 0;
1246 if (NULL == aTHX) {
1247 c_ithread_t *t = NULL;
1249 pthread_mutex_lock (&perl_threads->mutex);
1250 t = c_ithread_create (perl_threads->head->interp);
1251 pthread_mutex_unlock (&perl_threads->mutex);
1253 aTHX = t->interp;
1254 }
1256 log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
1257 aTHX, perl_threads->number_of_threads);
1258 return pplugin_call_all (aTHX_ PLUGIN_INIT);
1259 } /* static int perl_init (void) */
1261 static int perl_read (void)
1262 {
1263 dTHX;
1265 if (NULL == perl_threads)
1266 return 0;
1268 if (NULL == aTHX) {
1269 c_ithread_t *t = NULL;
1271 pthread_mutex_lock (&perl_threads->mutex);
1272 t = c_ithread_create (perl_threads->head->interp);
1273 pthread_mutex_unlock (&perl_threads->mutex);
1275 aTHX = t->interp;
1276 }
1278 log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1279 aTHX, perl_threads->number_of_threads);
1280 return pplugin_call_all (aTHX_ PLUGIN_READ);
1281 } /* static int perl_read (void) */
1283 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1284 {
1285 dTHX;
1287 if (NULL == perl_threads)
1288 return 0;
1290 if (NULL == aTHX) {
1291 c_ithread_t *t = NULL;
1293 pthread_mutex_lock (&perl_threads->mutex);
1294 t = c_ithread_create (perl_threads->head->interp);
1295 pthread_mutex_unlock (&perl_threads->mutex);
1297 aTHX = t->interp;
1298 }
1300 log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1301 aTHX, perl_threads->number_of_threads);
1302 return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1303 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1305 static void perl_log (int level, const char *msg)
1306 {
1307 dTHX;
1309 if (NULL == perl_threads)
1310 return;
1312 if (NULL == aTHX) {
1313 c_ithread_t *t = NULL;
1315 pthread_mutex_lock (&perl_threads->mutex);
1316 t = c_ithread_create (perl_threads->head->interp);
1317 pthread_mutex_unlock (&perl_threads->mutex);
1319 aTHX = t->interp;
1320 }
1322 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1323 return;
1324 } /* static void perl_log (int, const char *) */
1326 static int perl_notify (const notification_t *notif)
1327 {
1328 dTHX;
1330 if (NULL == perl_threads)
1331 return 0;
1333 if (NULL == aTHX) {
1334 c_ithread_t *t = NULL;
1336 pthread_mutex_lock (&perl_threads->mutex);
1337 t = c_ithread_create (perl_threads->head->interp);
1338 pthread_mutex_unlock (&perl_threads->mutex);
1340 aTHX = t->interp;
1341 }
1342 return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1343 } /* static int perl_notify (const notification_t *) */
1345 static int perl_flush (int timeout, const char *identifier)
1346 {
1347 dTHX;
1349 if (NULL == perl_threads)
1350 return 0;
1352 if (NULL == aTHX) {
1353 c_ithread_t *t = NULL;
1355 pthread_mutex_lock (&perl_threads->mutex);
1356 t = c_ithread_create (perl_threads->head->interp);
1357 pthread_mutex_unlock (&perl_threads->mutex);
1359 aTHX = t->interp;
1360 }
1361 return pplugin_call_all (aTHX_ PLUGIN_FLUSH, timeout, identifier);
1362 } /* static int perl_flush (const int) */
1364 static int perl_shutdown (void)
1365 {
1366 c_ithread_t *t = NULL;
1368 int ret = 0;
1370 dTHX;
1372 plugin_unregister_complex_config ("perl");
1374 if (NULL == perl_threads)
1375 return 0;
1377 if (NULL == aTHX) {
1378 c_ithread_t *t = NULL;
1380 pthread_mutex_lock (&perl_threads->mutex);
1381 t = c_ithread_create (perl_threads->head->interp);
1382 pthread_mutex_unlock (&perl_threads->mutex);
1384 aTHX = t->interp;
1385 }
1387 log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1388 aTHX, perl_threads->number_of_threads);
1390 plugin_unregister_log ("perl");
1391 plugin_unregister_notification ("perl");
1392 plugin_unregister_init ("perl");
1393 plugin_unregister_read ("perl");
1394 plugin_unregister_write ("perl");
1395 plugin_unregister_flush ("perl");
1397 ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1399 pthread_mutex_lock (&perl_threads->mutex);
1400 t = perl_threads->tail;
1402 while (NULL != t) {
1403 c_ithread_t *thr = t;
1405 /* the pointer has to be advanced before destroying
1406 * the thread as this will free the memory */
1407 t = t->prev;
1409 c_ithread_destroy (thr);
1410 }
1412 pthread_mutex_unlock (&perl_threads->mutex);
1413 pthread_mutex_destroy (&perl_threads->mutex);
1415 sfree (perl_threads);
1417 pthread_key_delete (perl_thr_key);
1419 PERL_SYS_TERM ();
1421 plugin_unregister_shutdown ("perl");
1422 return ret;
1423 } /* static void perl_shutdown (void) */
1425 /*
1426 * Access functions for global variables.
1427 *
1428 * These functions implement the "magic" used to access
1429 * the global variables from Perl.
1430 */
1432 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1433 {
1434 char *pv = mg->mg_ptr;
1435 sv_setpv (var, pv);
1436 return 0;
1437 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1439 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1440 {
1441 char *pv = mg->mg_ptr;
1442 sstrncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1443 return 0;
1444 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1446 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1447 {
1448 int *iv = (int *)mg->mg_ptr;
1449 sv_setiv (var, *iv);
1450 return 0;
1451 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1453 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1454 {
1455 int *iv = (int *)mg->mg_ptr;
1456 *iv = (int)SvIV (var);
1457 return 0;
1458 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1460 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1461 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1463 /* bootstrap the Collectd module */
1464 static void xs_init (pTHX)
1465 {
1466 HV *stash = NULL;
1467 SV *tmp = NULL;
1468 char *file = __FILE__;
1470 int i = 0;
1472 dXSUB_SYS;
1474 /* enable usage of Perl modules using shared libraries */
1475 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1477 /* register API */
1478 for (i = 0; NULL != api[i].f; ++i)
1479 newXS (api[i].name, api[i].f, file);
1481 stash = gv_stashpv ("Collectd", 1);
1483 /* export "constants" */
1484 for (i = 0; '\0' != constants[i].name[0]; ++i)
1485 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1487 /* export global variables
1488 * by adding "magic" to the SV's representing the globale variables
1489 * perl is able to automagically call the get/set function when
1490 * accessing any such variable (this is basically the same as using
1491 * tie() in Perl) */
1492 /* global strings */
1493 for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1494 tmp = get_sv (g_strings[i].name, 1);
1495 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1496 g_strings[i].var, 0);
1497 }
1499 /* global integers */
1500 for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1501 tmp = get_sv (g_integers[i].name, 1);
1502 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1503 (char *)g_integers[i].var, 0);
1504 }
1505 return;
1506 } /* static void xs_init (pTHX) */
1508 /* Initialize the global Perl interpreter. */
1509 static int init_pi (int argc, char **argv)
1510 {
1511 dTHXa (NULL);
1513 if (NULL != perl_threads)
1514 return 0;
1516 log_info ("Initializing Perl interpreter...");
1517 #if COLLECT_DEBUG
1518 {
1519 int i = 0;
1521 for (i = 0; i < argc; ++i)
1522 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1523 }
1524 #endif /* COLLECT_DEBUG */
1526 if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1527 log_err ("init_pi: pthread_key_create failed");
1529 /* this must not happen - cowardly giving up if it does */
1530 return -1;
1531 }
1533 #ifdef __FreeBSD__
1534 /* On FreeBSD, PERL_SYS_INIT3 expands to some expression which
1535 * triggers a "value computed is not used" warning by gcc. */
1536 (void)
1537 #endif
1538 PERL_SYS_INIT3 (&argc, &argv, &environ);
1540 perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1541 memset (perl_threads, 0, sizeof (c_ithread_list_t));
1543 pthread_mutex_init (&perl_threads->mutex, NULL);
1544 /* locking the mutex should not be necessary at this point
1545 * but let's just do it for the sake of completeness */
1546 pthread_mutex_lock (&perl_threads->mutex);
1548 perl_threads->head = c_ithread_create (NULL);
1549 perl_threads->tail = perl_threads->head;
1551 if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1552 log_err ("init_pi: Not enough memory.");
1553 exit (3);
1554 }
1556 aTHX = perl_threads->head->interp;
1557 pthread_mutex_unlock (&perl_threads->mutex);
1559 perl_construct (aTHX);
1561 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1563 if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1564 log_err ("init_pi: Unable to bootstrap Collectd.");
1566 perl_destruct (perl_threads->head->interp);
1567 perl_free (perl_threads->head->interp);
1568 sfree (perl_threads);
1570 pthread_key_delete (perl_thr_key);
1571 return -1;
1572 }
1574 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1575 sv_setpv (get_sv ("0", 0), "collectd");
1577 perl_run (aTHX);
1579 plugin_register_log ("perl", perl_log);
1580 plugin_register_notification ("perl", perl_notify);
1581 plugin_register_init ("perl", perl_init);
1583 plugin_register_read ("perl", perl_read);
1585 plugin_register_write ("perl", perl_write);
1586 plugin_register_flush ("perl", perl_flush);
1587 plugin_register_shutdown ("perl", perl_shutdown);
1588 return 0;
1589 } /* static int init_pi (const char **, const int) */
1591 /*
1592 * LoadPlugin "<Plugin>"
1593 */
1594 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1595 {
1596 char module_name[DATA_MAX_NAME_LEN];
1598 char *value = NULL;
1600 if ((0 != ci->children_num) || (1 != ci->values_num)
1601 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1602 log_err ("LoadPlugin expects a single string argument.");
1603 return 1;
1604 }
1606 value = ci->values[0].value.string;
1608 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1609 log_err ("Invalid module name %s", value);
1610 return (1);
1611 }
1613 if (0 != init_pi (perl_argc, perl_argv))
1614 return -1;
1616 assert (NULL != perl_threads);
1617 assert (NULL != perl_threads->head);
1619 aTHX = perl_threads->head->interp;
1621 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1622 load_module (PERL_LOADMOD_NOIMPORT,
1623 newSVpv (module_name, strlen (module_name)), Nullsv);
1624 return 0;
1625 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1627 /*
1628 * BaseName "<Name>"
1629 */
1630 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1631 {
1632 char *value = NULL;
1634 if ((0 != ci->children_num) || (1 != ci->values_num)
1635 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1636 log_err ("BaseName expects a single string argument.");
1637 return 1;
1638 }
1640 value = ci->values[0].value.string;
1642 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1643 sstrncpy (base_name, value, sizeof (base_name));
1644 return 0;
1645 } /* static int perl_config_basename (oconfig_item_it *) */
1647 /*
1648 * EnableDebugger "<Package>"|""
1649 */
1650 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1651 {
1652 char *value = NULL;
1654 if ((0 != ci->children_num) || (1 != ci->values_num)
1655 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1656 log_err ("EnableDebugger expects a single string argument.");
1657 return 1;
1658 }
1660 if (NULL != perl_threads) {
1661 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
1662 return 1;
1663 }
1665 value = ci->values[0].value.string;
1667 perl_argv = (char **)realloc (perl_argv,
1668 (++perl_argc + 1) * sizeof (char *));
1670 if (NULL == perl_argv) {
1671 log_err ("perl_config: Not enough memory.");
1672 exit (3);
1673 }
1675 if ('\0' == value[0]) {
1676 perl_argv[perl_argc - 1] = "-d";
1677 }
1678 else {
1679 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1680 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1681 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1682 }
1684 perl_argv[perl_argc] = NULL;
1685 return 0;
1686 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1688 /*
1689 * IncludeDir "<Dir>"
1690 */
1691 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1692 {
1693 char *value = NULL;
1695 if ((0 != ci->children_num) || (1 != ci->values_num)
1696 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1697 log_err ("IncludeDir expects a single string argument.");
1698 return 1;
1699 }
1701 value = ci->values[0].value.string;
1703 if (NULL == aTHX) {
1704 perl_argv = (char **)realloc (perl_argv,
1705 (++perl_argc + 1) * sizeof (char *));
1707 if (NULL == perl_argv) {
1708 log_err ("perl_config: Not enough memory.");
1709 exit (3);
1710 }
1712 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1713 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1714 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1716 perl_argv[perl_argc] = NULL;
1717 }
1718 else {
1719 /* prepend the directory to @INC */
1720 av_unshift (GvAVn (PL_incgv), 1);
1721 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1722 }
1723 return 0;
1724 } /* static int perl_config_includedir (oconfig_item_it *) */
1726 /*
1727 * <Plugin> block
1728 */
1729 static int perl_config_plugin (pTHX_ oconfig_item_t *ci)
1730 {
1731 int retvals = 0;
1732 int ret = 0;
1734 char *plugin;
1735 HV *config;
1737 dSP;
1739 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1740 log_err ("LoadPlugin expects a single string argument.");
1741 return 1;
1742 }
1744 plugin = ci->values[0].value.string;
1745 config = newHV ();
1747 if (0 != oconfig_item2hv (aTHX_ ci, config)) {
1748 hv_clear (config);
1749 hv_undef (config);
1751 log_err ("Unable to convert configuration to a Perl hash value.");
1752 config = Nullhv;
1753 }
1755 ENTER;
1756 SAVETMPS;
1758 PUSHMARK (SP);
1760 XPUSHs (sv_2mortal (newSVpv (plugin, 0)));
1761 XPUSHs (sv_2mortal (newRV_noinc ((SV *)config)));
1763 PUTBACK;
1765 retvals = call_pv ("Collectd::_plugin_dispatch_config", G_SCALAR);
1767 SPAGAIN;
1768 if (0 < retvals) {
1769 SV *tmp = POPs;
1770 if (! SvTRUE (tmp))
1771 ret = -1;
1772 }
1773 else
1774 ret = -1;
1776 PUTBACK;
1777 FREETMPS;
1778 LEAVE;
1779 return ret;
1780 } /* static int perl_config_plugin (oconfig_item_it *) */
1782 static int perl_config (oconfig_item_t *ci)
1783 {
1784 int i = 0;
1786 dTHX;
1788 /* dTHX does not get any valid values in case Perl
1789 * has not been initialized */
1790 if (NULL == perl_threads)
1791 aTHX = NULL;
1793 for (i = 0; i < ci->children_num; ++i) {
1794 oconfig_item_t *c = ci->children + i;
1796 if (0 == strcasecmp (c->key, "LoadPlugin"))
1797 perl_config_loadplugin (aTHX_ c);
1798 else if (0 == strcasecmp (c->key, "BaseName"))
1799 perl_config_basename (aTHX_ c);
1800 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1801 perl_config_enabledebugger (aTHX_ c);
1802 else if (0 == strcasecmp (c->key, "IncludeDir"))
1803 perl_config_includedir (aTHX_ c);
1804 else if (0 == strcasecmp (c->key, "Plugin"))
1805 perl_config_plugin (aTHX_ c);
1806 else
1807 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1808 }
1809 return 0;
1810 } /* static int perl_config (oconfig_item_t *) */
1812 void module_register (void)
1813 {
1814 perl_argc = 4;
1815 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1817 /* default options for the Perl interpreter */
1818 perl_argv[0] = "";
1819 perl_argv[1] = "-MCollectd";
1820 perl_argv[2] = "-e";
1821 perl_argv[3] = "1";
1822 perl_argv[4] = NULL;
1824 plugin_register_complex_config ("perl", perl_config);
1825 return;
1826 } /* void module_register (void) */
1828 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */