2 * collectd - src/perl.c
3 * Copyright (C) 2007, 2008 Sebastian Harl
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.
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.
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
19 * Sebastian Harl <sh at tokkee.org>
23 * This plugin embeds a Perl interpreter into collectd and provides an
24 * interface for collectd plugins written in perl.
27 /* do not automatically get the thread specific perl interpreter */
28 #define PERL_NO_GET_CONTEXT
30 #define DONT_POISON_SPRINTF_YET 1
32 #undef DONT_POISON_SPRINTF_YET
34 #include "configfile.h"
39 #if defined(COLLECT_DEBUG) && COLLECT_DEBUG && defined(__GNUC__) && __GNUC__
40 # pragma GCC poison sprintf
45 /* Some versions of Perl define their own version of DEBUG... :-/ */
50 /* ... while we want the definition found in plugin.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
66 #define PLUGIN_WRITE 2
67 #define PLUGIN_SHUTDOWN 3
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);
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;
111 /* some usage stats */
112 int number_of_threads;
113 #endif /* COLLECT_DEBUG */
115 pthread_mutex_t mutex;
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] = "";
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 },
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 },
182 { "Collectd::hostname_g", hostname_g },
191 { "Collectd::interval_g", &interval_g },
196 * Helper functions for data type conversion.
211 static int hv2data_source (pTHX_ HV *hash, data_source_t *ds)
215 if ((NULL == hash) || (NULL == ds))
218 if (NULL != (tmp = hv_fetch (hash, "name", 4, 0))) {
219 sstrncpy (ds->name, SvPV_nolen (*tmp), sizeof (ds->name));
222 log_err ("hv2data_source: No DS name given.");
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.");
235 ds->type = DS_TYPE_COUNTER;
238 if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
239 ds->min = SvNV (*tmp);
243 if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
244 ds->max = SvNV (*tmp);
248 } /* static data_source_t *hv2data_source (HV *) */
250 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
252 const data_set_t *ds;
256 if ((NULL == name) || (NULL == array) || (NULL == value))
259 if (av_len (array) < len - 1)
260 len = av_len (array) + 1;
265 ds = plugin_get_ds (name);
267 log_err ("av2value: Unknown dataset \"%s\"", name);
271 if (ds->ds_num < len) {
272 log_warn ("av2value: Value length exceeds data set length.");
276 for (i = 0; i < len; ++i) {
277 SV **tmp = av_fetch (array, i, 0);
280 if (DS_TYPE_COUNTER == ds->ds[i].type)
281 value[i].counter = SvIV (*tmp);
283 value[i].gauge = SvNV (*tmp);
290 } /* static int av2value (char *, AV *, value_t *, int) */
292 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
296 if ((NULL == ds) || (NULL == array))
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))
308 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
311 if (! isnan (ds->ds[i].min))
312 if (NULL == hv_store (source, "min", 3,
313 newSVnv (ds->ds[i].min), 0))
316 if (! isnan (ds->ds[i].max))
317 if (NULL == hv_store (source, "max", 3,
318 newSVnv (ds->ds[i].max), 0))
321 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
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)
334 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
337 len = vl->values_len;
339 if (ds->ds_num < len) {
340 log_warn ("value2av: Value length exceeds data set length.");
345 av_extend (values, len - 1);
347 for (i = 0; i < len; ++i) {
350 if (DS_TYPE_COUNTER == ds->ds[i].type)
351 val = newSViv (vl->values[i].counter);
353 val = newSVnv (vl->values[i].gauge);
355 if (NULL == av_store (values, i, val)) {
361 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
365 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
368 if ('\0' != vl->host[0])
369 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
372 if ('\0' != vl->plugin[0])
373 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
376 if ('\0' != vl->plugin_instance[0])
377 if (NULL == hv_store (hash, "plugin_instance", 15,
378 newSVpv (vl->plugin_instance, 0), 0))
381 if ('\0' != vl->type[0])
382 if (NULL == hv_store (hash, "type", 4, newSVpv (vl->type, 0), 0))
385 if ('\0' != vl->type_instance[0])
386 if (NULL == hv_store (hash, "type_instance", 13,
387 newSVpv (vl->type_instance, 0), 0))
390 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
392 static int notification2hv (pTHX_ notification_t *n, HV *hash)
394 if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
398 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
401 if ('\0' != *n->message)
402 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
405 if ('\0' != *n->host)
406 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
409 if ('\0' != *n->plugin)
410 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
413 if ('\0' != *n->plugin_instance)
414 if (NULL == hv_store (hash, "plugin_instance", 15,
415 newSVpv (n->plugin_instance, 0), 0))
418 if ('\0' != *n->type)
419 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
422 if ('\0' != *n->type_instance)
423 if (NULL == hv_store (hash, "type_instance", 13,
424 newSVpv (n->type_instance, 0), 0))
427 } /* static int notification2hv (notification_t *, HV *) */
429 static int oconfig_item2hv (pTHX_ oconfig_item_t *ci, HV *hash)
436 if (NULL == hv_store (hash, "key", 3, newSVpv (ci->key, 0), 0))
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)) {
449 for (i = 0; i < ci->values_num; ++i) {
452 switch (ci->values[i].type) {
453 case OCONFIG_TYPE_STRING:
454 value = newSVpv (ci->values[i].value.string, 0);
456 case OCONFIG_TYPE_NUMBER:
457 value = newSVnv ((NV)ci->values[i].value.number);
459 case OCONFIG_TYPE_BOOLEAN:
460 value = ci->values[i].value.boolean ? &PL_sv_yes : &PL_sv_no;
463 log_err ("oconfig_item2hv: Invalid value type %i.",
465 value = &PL_sv_undef;
468 if (NULL == av_store (values, i, value)) {
474 /* ignoring 'parent' member which is uninteresting in this case */
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)) {
486 for (i = 0; i < ci->children_num; ++i) {
487 HV *child = newHV ();
489 if (0 != oconfig_item2hv (aTHX_ ci->children + i, child)) {
495 if (NULL == av_store (children, i, newRV_noinc ((SV *)child))) {
502 } /* static int oconfig_item2hv (pTHX_ oconfig_item_t *, HV *) */
505 * Internal functions.
508 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
510 if (base_name[0] == '\0')
511 status = ssnprintf (buf, buf_len, "%s", module);
513 status = ssnprintf (buf, buf_len, "%s::%s", base_name, module);
514 if ((status < 0) || ((unsigned int)status >= buf_len))
517 } /* char *get_module_name */
520 * Add a plugin's data set definition.
522 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
528 data_source_t *ds = NULL;
529 data_set_t *set = NULL;
531 if ((NULL == name) || (NULL == dataset))
534 len = av_len (dataset);
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);
548 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
549 log_err ("pplugin_register_data_set: Invalid data source.");
553 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
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);
561 sstrncpy (set->type, name, sizeof (set->type));
563 set->ds_num = len + 1;
566 ret = plugin_register_data_set (set);
571 } /* static int pplugin_register_data_set (char *, SV *) */
574 * Remove a plugin's data set definition.
576 static int pplugin_unregister_data_set (char *name)
580 return plugin_unregister_data_set (name);
581 } /* static int pplugin_unregister_data_set (char *) */
584 * Submit the values to the write functions.
588 * values => [ @values ],
592 * plugin_instance => $pinstance,
593 * type_instance => $tinstance,
596 static int pplugin_dispatch_values (pTHX_ HV *values)
598 value_list_t list = VALUE_LIST_INIT;
608 if (NULL == (tmp = hv_fetch (values, "type", 4, 0))) {
609 log_err ("pplugin_dispatch_values: No type given.");
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.");
622 AV *array = (AV *)SvRV (*tmp);
623 int len = av_len (array) + 1;
628 val = (value_t *)smalloc (len * sizeof (value_t));
630 list.values_len = av2value (aTHX_ list.type, (AV *)SvRV (*tmp),
634 if (-1 == list.values_len) {
640 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
641 list.time = (time_t)SvIV (*tmp);
644 list.time = time (NULL);
647 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
648 sstrncpy (list.host, SvPV_nolen (*tmp), sizeof (list.host));
651 sstrncpy (list.host, hostname_g, sizeof (list.host));
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);
669 } /* static int pplugin_dispatch_values (char *, HV *) */
672 * Dispatch a notification.
676 * severity => $severity,
682 * plugin_instance => $instance,
683 * type_instance => $type_instance
686 static int pplugin_dispatch_notification (pTHX_ HV *notif)
695 memset (&n, 0, sizeof (n));
697 if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
698 n.severity = SvIV (*tmp);
700 n.severity = NOTIF_FAILURE;
702 if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
703 n.time = (time_t)SvIV (*tmp);
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));
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 *) */
731 * Call all working functions of the given type.
733 static int pplugin_call_all (pTHX_ int type, ...)
742 if ((type < 0) || (type >= PLUGIN_TYPES))
752 XPUSHs (sv_2mortal (newSViv ((IV)type)));
754 if (PLUGIN_WRITE == type) {
756 * $_[0] = $plugin_type;
771 * values => [ $v1, ... ],
776 * plugin_instance => $instance,
777 * type_instance => $type_instance
786 ds = va_arg (ap, data_set_t *);
787 vl = va_arg (ap, value_list_t *);
789 if (-1 == data_set2av (aTHX_ ds, pds)) {
796 if (-1 == value_list2hv (aTHX_ vl, ds, pvl)) {
803 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
804 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
805 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
807 else if (PLUGIN_LOG == type) {
813 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
814 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
816 else if (PLUGIN_NOTIF == type) {
820 * severity => $severity,
826 * plugin_instance => $instance,
827 * type_instance => $type_instance
831 HV *notif = newHV ();
833 n = va_arg (ap, notification_t *);
835 if (-1 == notification2hv (aTHX_ n, notif)) {
842 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
844 else if (PLUGIN_FLUSH == type) {
847 * $_[1] = $identifier;
849 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
850 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
855 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
870 } /* static int pplugin_call_all (int, ...) */
877 * Collectd::plugin_register_data_set (type, dataset).
880 * type of the dataset
883 * dataset to be registered
885 static XS (Collectd_plugin_register_ds)
893 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
897 log_debug ("Collectd::plugin_register_data_set: "
898 "type = \"%s\", dataset = \"%s\"",
899 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
903 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
904 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
908 log_err ("Collectd::plugin_register_data_set: Invalid data.");
916 } /* static XS (Collectd_plugin_register_ds) */
919 * Collectd::plugin_unregister_data_set (type).
922 * type of the dataset
924 static XS (Collectd_plugin_unregister_ds)
929 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
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))))
940 } /* static XS (Collectd_plugin_register_ds) */
943 * Collectd::plugin_dispatch_values (name, values).
949 * value list to submit
951 static XS (Collectd_plugin_dispatch_values)
961 log_warn ("Collectd::plugin_dispatch_values with two arguments "
962 "is deprecated - pass the type through values->{type}.");
965 else if (1 != items) {
966 log_err ("Usage: Collectd::plugin_dispatch_values(values)");
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.");
980 if (((2 == items) && (NULL == ST (0))) || (NULL == values))
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.");
989 ret = pplugin_dispatch_values (aTHX_ (HV *)SvRV (values));
995 } /* static XS (Collectd_plugin_dispatch_values) */
998 * Collectd::_plugin_flush (plugin, timeout, identifier).
1001 * name of the plugin to flush
1004 * timeout to use when flushing the data
1007 * data-set identifier to flush
1009 static XS (Collectd__plugin_flush)
1011 char *plugin = NULL;
1018 log_err ("Usage: Collectd::_plugin_flush(plugin, timeout, id)");
1023 plugin = SvPV_nolen (ST (0));
1026 timeout = (int)SvIV (ST (1));
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))
1038 } /* static XS (Collectd__plugin_flush) */
1041 * Collectd::plugin_dispatch_notification (notif).
1044 * notification to dispatch
1046 static XS (Collectd_plugin_dispatch_notification)
1055 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
1059 log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
1060 SvPV_nolen (ST (0)));
1064 if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
1065 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
1069 ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
1075 } /* static XS (Collectd_plugin_dispatch_notification) */
1078 * Collectd::plugin_log (level, message).
1081 * log level (LOG_DEBUG, ... LOG_ERR)
1086 static XS (Collectd_plugin_log)
1091 log_err ("Usage: Collectd::plugin_log(level, message)");
1095 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
1097 } /* static XS (Collectd_plugin_log) */
1100 * Collectd::call_by_name (...).
1102 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
1104 static XS (Collectd_call_by_name)
1109 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
1110 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
1115 name = SvPV_nolen (tmp);
1117 if (NULL == get_cv (name, 0)) {
1118 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
1123 /* simply pass on the subroutine call without touching the stack,
1124 * thus leaving any arguments and return values in place */
1126 } /* static XS (Collectd_call_by_name) */
1129 * collectd's perl interpreter based thread implementation.
1131 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
1134 /* must be called with perl_threads->mutex locked */
1135 static void c_ithread_destroy (c_ithread_t *ithread)
1137 dTHXa (ithread->interp);
1139 assert (NULL != perl_threads);
1141 PERL_SET_CONTEXT (aTHX);
1142 log_debug ("Shutting down Perl interpreter %p...", aTHX);
1147 --perl_threads->number_of_threads;
1148 #endif /* COLLECT_DEBUG */
1150 perl_destruct (aTHX);
1153 if (NULL == ithread->prev)
1154 perl_threads->head = ithread->next;
1156 ithread->prev->next = ithread->next;
1158 if (NULL == ithread->next)
1159 perl_threads->tail = ithread->prev;
1161 ithread->next->prev = ithread->prev;
1165 } /* static void c_ithread_destroy (c_ithread_t *) */
1167 static void c_ithread_destructor (void *arg)
1169 c_ithread_t *ithread = (c_ithread_t *)arg;
1170 c_ithread_t *t = NULL;
1172 if (NULL == perl_threads)
1175 pthread_mutex_lock (&perl_threads->mutex);
1177 for (t = perl_threads->head; NULL != t; t = t->next)
1181 /* the ithread no longer exists */
1185 c_ithread_destroy (ithread);
1187 pthread_mutex_unlock (&perl_threads->mutex);
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)
1194 c_ithread_t *t = 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)
1204 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1208 if ((NULL != base) && (NULL != PL_endav)) {
1209 av_clear (PL_endav);
1210 av_undef (PL_endav);
1215 ++perl_threads->number_of_threads;
1216 #endif /* COLLECT_DEBUG */
1220 if (NULL == perl_threads->tail) {
1221 perl_threads->head = t;
1225 perl_threads->tail->next = t;
1226 t->prev = perl_threads->tail;
1229 perl_threads->tail = t;
1231 pthread_setspecific (perl_thr_key, (const void *)t);
1233 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1236 * Interface to collectd.
1239 static int perl_init (void)
1243 if (NULL == perl_threads)
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);
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)
1265 if (NULL == perl_threads)
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);
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)
1287 if (NULL == perl_threads)
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);
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)
1309 if (NULL == perl_threads)
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);
1322 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1324 } /* static void perl_log (int, const char *) */
1326 static int perl_notify (const notification_t *notif)
1330 if (NULL == perl_threads)
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);
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)
1349 if (NULL == perl_threads)
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);
1361 return pplugin_call_all (aTHX_ PLUGIN_FLUSH, timeout, identifier);
1362 } /* static int perl_flush (const int) */
1364 static int perl_shutdown (void)
1366 c_ithread_t *t = NULL;
1372 plugin_unregister_complex_config ("perl");
1374 if (NULL == perl_threads)
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);
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;
1403 c_ithread_t *thr = t;
1405 /* the pointer has to be advanced before destroying
1406 * the thread as this will free the memory */
1409 c_ithread_destroy (thr);
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);
1421 plugin_unregister_shutdown ("perl");
1423 } /* static void perl_shutdown (void) */
1426 * Access functions for global variables.
1428 * These functions implement the "magic" used to access
1429 * the global variables from Perl.
1432 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1434 char *pv = mg->mg_ptr;
1437 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1439 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1441 char *pv = mg->mg_ptr;
1442 sstrncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1444 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1446 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1448 int *iv = (int *)mg->mg_ptr;
1449 sv_setiv (var, *iv);
1451 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1453 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1455 int *iv = (int *)mg->mg_ptr;
1456 *iv = (int)SvIV (var);
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)
1468 char *file = __FILE__;
1474 /* enable usage of Perl modules using shared libraries */
1475 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
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
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);
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);
1506 } /* static void xs_init (pTHX) */
1508 /* Initialize the global Perl interpreter. */
1509 static int init_pi (int argc, char **argv)
1513 if (NULL != perl_threads)
1516 log_info ("Initializing Perl interpreter...");
1521 for (i = 0; i < argc; ++i)
1522 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
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 */
1534 /* On FreeBSD, PERL_SYS_INIT3 expands to some expression which
1535 * triggers a "value computed is not used" warning by gcc. */
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.");
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 SV *err = get_sv ("@", 1);
1565 log_err ("init_pi: Unable to bootstrap Collectd: %s",
1568 perl_destruct (perl_threads->head->interp);
1569 perl_free (perl_threads->head->interp);
1570 sfree (perl_threads);
1572 pthread_key_delete (perl_thr_key);
1576 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1577 sv_setpv (get_sv ("0", 0), "collectd");
1581 plugin_register_log ("perl", perl_log);
1582 plugin_register_notification ("perl", perl_notify);
1583 plugin_register_init ("perl", perl_init);
1585 plugin_register_read ("perl", perl_read);
1587 plugin_register_write ("perl", perl_write);
1588 plugin_register_flush ("perl", perl_flush);
1589 plugin_register_shutdown ("perl", perl_shutdown);
1591 } /* static int init_pi (const char **, const int) */
1594 * LoadPlugin "<Plugin>"
1596 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1598 char module_name[DATA_MAX_NAME_LEN];
1602 if ((0 != ci->children_num) || (1 != ci->values_num)
1603 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1604 log_err ("LoadPlugin expects a single string argument.");
1608 value = ci->values[0].value.string;
1610 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1611 log_err ("Invalid module name %s", value);
1615 if (0 != init_pi (perl_argc, perl_argv))
1618 assert (NULL != perl_threads);
1619 assert (NULL != perl_threads->head);
1621 aTHX = perl_threads->head->interp;
1623 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1624 load_module (PERL_LOADMOD_NOIMPORT,
1625 newSVpv (module_name, strlen (module_name)), Nullsv);
1627 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1632 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1636 if ((0 != ci->children_num) || (1 != ci->values_num)
1637 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1638 log_err ("BaseName expects a single string argument.");
1642 value = ci->values[0].value.string;
1644 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1645 sstrncpy (base_name, value, sizeof (base_name));
1647 } /* static int perl_config_basename (oconfig_item_it *) */
1650 * EnableDebugger "<Package>"|""
1652 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1656 if ((0 != ci->children_num) || (1 != ci->values_num)
1657 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1658 log_err ("EnableDebugger expects a single string argument.");
1662 if (NULL != perl_threads) {
1663 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
1667 value = ci->values[0].value.string;
1669 perl_argv = (char **)realloc (perl_argv,
1670 (++perl_argc + 1) * sizeof (char *));
1672 if (NULL == perl_argv) {
1673 log_err ("perl_config: Not enough memory.");
1677 if ('\0' == value[0]) {
1678 perl_argv[perl_argc - 1] = "-d";
1681 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1682 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1683 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1686 perl_argv[perl_argc] = NULL;
1688 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1691 * IncludeDir "<Dir>"
1693 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1697 if ((0 != ci->children_num) || (1 != ci->values_num)
1698 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1699 log_err ("IncludeDir expects a single string argument.");
1703 value = ci->values[0].value.string;
1706 perl_argv = (char **)realloc (perl_argv,
1707 (++perl_argc + 1) * sizeof (char *));
1709 if (NULL == perl_argv) {
1710 log_err ("perl_config: Not enough memory.");
1714 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1715 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1716 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1718 perl_argv[perl_argc] = NULL;
1721 /* prepend the directory to @INC */
1722 av_unshift (GvAVn (PL_incgv), 1);
1723 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1726 } /* static int perl_config_includedir (oconfig_item_it *) */
1731 static int perl_config_plugin (pTHX_ oconfig_item_t *ci)
1741 if ((1 != ci->values_num) || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1742 log_err ("LoadPlugin expects a single string argument.");
1746 plugin = ci->values[0].value.string;
1749 if (0 != oconfig_item2hv (aTHX_ ci, config)) {
1753 log_err ("Unable to convert configuration to a Perl hash value.");
1762 XPUSHs (sv_2mortal (newSVpv (plugin, 0)));
1763 XPUSHs (sv_2mortal (newRV_noinc ((SV *)config)));
1767 retvals = call_pv ("Collectd::_plugin_dispatch_config", G_SCALAR);
1782 } /* static int perl_config_plugin (oconfig_item_it *) */
1784 static int perl_config (oconfig_item_t *ci)
1791 for (i = 0; i < ci->children_num; ++i) {
1792 oconfig_item_t *c = ci->children + i;
1793 int current_status = 0;
1795 if (NULL != perl_threads)
1796 aTHX = PERL_GET_CONTEXT;
1798 if (0 == strcasecmp (c->key, "LoadPlugin"))
1799 current_status = perl_config_loadplugin (aTHX_ c);
1800 else if (0 == strcasecmp (c->key, "BaseName"))
1801 current_status = perl_config_basename (aTHX_ c);
1802 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1803 current_status = perl_config_enabledebugger (aTHX_ c);
1804 else if (0 == strcasecmp (c->key, "IncludeDir"))
1805 current_status = perl_config_includedir (aTHX_ c);
1806 else if (0 == strcasecmp (c->key, "Plugin"))
1807 current_status = perl_config_plugin (aTHX_ c);
1810 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1814 /* fatal error - it's up to perl_config_* to clean up */
1815 if (0 > current_status) {
1816 log_err ("Configuration failed with a fatal error - "
1817 "plugin disabled!");
1818 return current_status;
1821 status += current_status;
1824 } /* static int perl_config (oconfig_item_t *) */
1826 void module_register (void)
1829 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1831 /* default options for the Perl interpreter */
1833 perl_argv[1] = "-MCollectd";
1834 perl_argv[2] = "-e";
1836 perl_argv[4] = NULL;
1838 plugin_register_complex_config ("perl", perl_config);
1840 } /* void module_register (void) */
1842 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */