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"
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_DATASET 255
76 #define log_debug(...) DEBUG ("perl: " __VA_ARGS__)
77 #define log_info(...) INFO ("perl: " __VA_ARGS__)
78 #define log_warn(...) WARNING ("perl: " __VA_ARGS__)
79 #define log_err(...) ERROR ("perl: " __VA_ARGS__)
81 /* this is defined in DynaLoader.a */
82 void boot_DynaLoader (PerlInterpreter *, CV *);
84 static XS (Collectd_plugin_register_ds);
85 static XS (Collectd_plugin_unregister_ds);
86 static XS (Collectd_plugin_dispatch_values);
87 static XS (Collectd_plugin_flush_one);
88 static XS (Collectd_plugin_flush_all);
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_one", Collectd_plugin_flush_one },
143 { "Collectd::plugin_flush_all", Collectd_plugin_flush_all },
144 { "Collectd::plugin_dispatch_notification",
145 Collectd_plugin_dispatch_notification },
146 { "Collectd::plugin_log", Collectd_plugin_log },
147 { "Collectd::call_by_name", Collectd_call_by_name },
156 { "Collectd::TYPE_INIT", PLUGIN_INIT },
157 { "Collectd::TYPE_READ", PLUGIN_READ },
158 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
159 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
160 { "Collectd::TYPE_LOG", PLUGIN_LOG },
161 { "Collectd::TYPE_NOTIF", PLUGIN_NOTIF },
162 { "Collectd::TYPE_FLUSH", PLUGIN_FLUSH },
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 *) */
430 * Internal functions.
433 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
435 if (base_name[0] == '\0')
436 status = ssnprintf (buf, buf_len, "%s", module);
438 status = ssnprintf (buf, buf_len, "%s::%s", base_name, module);
439 if ((status < 0) || ((unsigned int)status >= buf_len))
442 } /* char *get_module_name */
445 * Add a plugin's data set definition.
447 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
453 data_source_t *ds = NULL;
454 data_set_t *set = NULL;
456 if ((NULL == name) || (NULL == dataset))
459 len = av_len (dataset);
464 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
465 set = (data_set_t *)smalloc (sizeof (data_set_t));
467 for (i = 0; i <= len; ++i) {
468 SV **elem = av_fetch (dataset, i, 0);
473 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
474 log_err ("pplugin_register_data_set: Invalid data source.");
478 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
481 log_debug ("pplugin_register_data_set: "
482 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
483 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
486 sstrncpy (set->type, name, sizeof (set->type));
488 set->ds_num = len + 1;
491 ret = plugin_register_data_set (set);
496 } /* static int pplugin_register_data_set (char *, SV *) */
499 * Remove a plugin's data set definition.
501 static int pplugin_unregister_data_set (char *name)
505 return plugin_unregister_data_set (name);
506 } /* static int pplugin_unregister_data_set (char *) */
509 * Submit the values to the write functions.
513 * values => [ @values ],
517 * plugin_instance => $pinstance,
518 * type_instance => $tinstance,
521 static int pplugin_dispatch_values (pTHX_ HV *values)
523 value_list_t list = VALUE_LIST_INIT;
533 if (NULL == (tmp = hv_fetch (values, "type", 4, 0))) {
534 log_err ("pplugin_dispatch_values: No type given.");
538 sstrncpy (list.type, SvPV_nolen (*tmp), sizeof (list.type));
540 if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
541 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
542 log_err ("pplugin_dispatch_values: No valid values given.");
547 AV *array = (AV *)SvRV (*tmp);
548 int len = av_len (array) + 1;
553 val = (value_t *)smalloc (len * sizeof (value_t));
555 list.values_len = av2value (aTHX_ list.type, (AV *)SvRV (*tmp),
559 if (-1 == list.values_len) {
565 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
566 list.time = (time_t)SvIV (*tmp);
569 list.time = time (NULL);
572 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
573 sstrncpy (list.host, SvPV_nolen (*tmp), sizeof (list.host));
576 sstrncpy (list.host, hostname_g, sizeof (list.host));
579 if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0)))
580 sstrncpy (list.plugin, SvPV_nolen (*tmp), sizeof (list.plugin));
582 if (NULL != (tmp = hv_fetch (values, "plugin_instance", 15, 0)))
583 sstrncpy (list.plugin_instance, SvPV_nolen (*tmp),
584 sizeof (list.plugin_instance));
586 if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0)))
587 sstrncpy (list.type_instance, SvPV_nolen (*tmp),
588 sizeof (list.type_instance));
590 ret = plugin_dispatch_values (&list);
594 } /* static int pplugin_dispatch_values (char *, HV *) */
597 * Dispatch a notification.
601 * severity => $severity,
607 * plugin_instance => $instance,
608 * type_instance => $type_instance
611 static int pplugin_dispatch_notification (pTHX_ HV *notif)
620 memset (&n, 0, sizeof (n));
622 if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
623 n.severity = SvIV (*tmp);
625 n.severity = NOTIF_FAILURE;
627 if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
628 n.time = (time_t)SvIV (*tmp);
630 n.time = time (NULL);
632 if (NULL != (tmp = hv_fetch (notif, "message", 7, 0)))
633 sstrncpy (n.message, SvPV_nolen (*tmp), sizeof (n.message));
635 if (NULL != (tmp = hv_fetch (notif, "host", 4, 0)))
636 sstrncpy (n.host, SvPV_nolen (*tmp), sizeof (n.host));
638 sstrncpy (n.host, hostname_g, sizeof (n.host));
640 if (NULL != (tmp = hv_fetch (notif, "plugin", 6, 0)))
641 sstrncpy (n.plugin, SvPV_nolen (*tmp), sizeof (n.plugin));
643 if (NULL != (tmp = hv_fetch (notif, "plugin_instance", 15, 0)))
644 sstrncpy (n.plugin_instance, SvPV_nolen (*tmp),
645 sizeof (n.plugin_instance));
647 if (NULL != (tmp = hv_fetch (notif, "type", 4, 0)))
648 sstrncpy (n.type, SvPV_nolen (*tmp), sizeof (n.type));
650 if (NULL != (tmp = hv_fetch (notif, "type_instance", 13, 0)))
651 sstrncpy (n.type_instance, SvPV_nolen (*tmp), sizeof (n.type_instance));
652 return plugin_dispatch_notification (&n);
653 } /* static int pplugin_dispatch_notification (HV *) */
656 * Call all working functions of the given type.
658 static int pplugin_call_all (pTHX_ int type, ...)
667 if ((type < 0) || (type >= PLUGIN_TYPES))
677 XPUSHs (sv_2mortal (newSViv ((IV)type)));
679 if (PLUGIN_WRITE == type) {
681 * $_[0] = $plugin_type;
696 * values => [ $v1, ... ],
701 * plugin_instance => $instance,
702 * type_instance => $type_instance
711 ds = va_arg (ap, data_set_t *);
712 vl = va_arg (ap, value_list_t *);
714 if (-1 == data_set2av (aTHX_ ds, pds)) {
721 if (-1 == value_list2hv (aTHX_ vl, ds, pvl)) {
728 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
729 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
730 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
732 else if (PLUGIN_LOG == type) {
738 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
739 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
741 else if (PLUGIN_NOTIF == type) {
745 * severity => $severity,
751 * plugin_instance => $instance,
752 * type_instance => $type_instance
756 HV *notif = newHV ();
758 n = va_arg (ap, notification_t *);
760 if (-1 == notification2hv (aTHX_ n, notif)) {
767 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
769 else if (PLUGIN_FLUSH == type) {
773 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
778 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
793 } /* static int pplugin_call_all (int, ...) */
800 * Collectd::plugin_register_data_set (type, dataset).
803 * type of the dataset
806 * dataset to be registered
808 static XS (Collectd_plugin_register_ds)
816 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
820 log_debug ("Collectd::plugin_register_data_set: "
821 "type = \"%s\", dataset = \"%s\"",
822 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
826 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
827 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
831 log_err ("Collectd::plugin_register_data_set: Invalid data.");
839 } /* static XS (Collectd_plugin_register_ds) */
842 * Collectd::plugin_unregister_data_set (type).
845 * type of the dataset
847 static XS (Collectd_plugin_unregister_ds)
852 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
856 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
857 SvPV_nolen (ST (0)));
859 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (0))))
863 } /* static XS (Collectd_plugin_register_ds) */
866 * Collectd::plugin_dispatch_values (name, values).
872 * value list to submit
874 static XS (Collectd_plugin_dispatch_values)
884 log_warn ("Collectd::plugin_dispatch_values with two arguments "
885 "is deprecated - pass the type through values->{type}.");
888 else if (1 != items) {
889 log_err ("Usage: Collectd::plugin_dispatch_values(values)");
893 log_debug ("Collectd::plugin_dispatch_values: values=\"%s\"",
894 SvPV_nolen (ST (values_idx)));
896 values = ST (values_idx);
898 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
899 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
903 if (((2 == items) && (NULL == ST (0))) || (NULL == values))
906 if ((2 == items) && (NULL == hv_store ((HV *)SvRV (values), "type", 4,
907 newSVsv (ST (0)), 0))) {
908 log_err ("Collectd::plugin_dispatch_values: Could not store type.");
912 ret = pplugin_dispatch_values (aTHX_ (HV *)SvRV (values));
918 } /* static XS (Collectd_plugin_dispatch_values) */
921 * Collectd::plugin_flush_one (timeout, name).
924 * timeout to use when flushing the data
927 * name of the plugin to flush
929 static XS (Collectd_plugin_flush_one)
934 log_err ("Usage: Collectd::plugin_flush_one(timeout, name)");
938 log_debug ("Collectd::plugin_flush_one: timeout = %i, name = \"%s\"",
939 (int)SvIV (ST (0)), SvPV_nolen (ST (1)));
941 if (0 == plugin_flush_one ((int)SvIV (ST (0)), SvPV_nolen (ST (1))))
945 } /* static XS (Collectd_plugin_flush_one) */
948 * Collectd::plugin_flush_all (timeout).
951 * timeout to use when flushing the data
953 static XS (Collectd_plugin_flush_all)
958 log_err ("Usage: Collectd::plugin_flush_all(timeout)");
962 log_debug ("Collectd::plugin_flush_all: timeout = %i", (int)SvIV (ST (0)));
964 plugin_flush_all ((int)SvIV (ST (0)));
966 } /* static XS (Collectd_plugin_flush_all) */
969 * Collectd::plugin_dispatch_notification (notif).
972 * notification to dispatch
974 static XS (Collectd_plugin_dispatch_notification)
983 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
987 log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
988 SvPV_nolen (ST (0)));
992 if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
993 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
997 ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
1003 } /* static XS (Collectd_plugin_dispatch_notification) */
1006 * Collectd::plugin_log (level, message).
1009 * log level (LOG_DEBUG, ... LOG_ERR)
1014 static XS (Collectd_plugin_log)
1019 log_err ("Usage: Collectd::plugin_log(level, message)");
1023 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
1025 } /* static XS (Collectd_plugin_log) */
1028 * Collectd::call_by_name (...).
1030 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
1032 static XS (Collectd_call_by_name)
1037 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
1038 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
1043 name = SvPV_nolen (tmp);
1045 if (NULL == get_cv (name, 0)) {
1046 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
1051 /* simply pass on the subroutine call without touching the stack,
1052 * thus leaving any arguments and return values in place */
1054 } /* static XS (Collectd_call_by_name) */
1057 * collectd's perl interpreter based thread implementation.
1059 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
1062 /* must be called with perl_threads->mutex locked */
1063 static void c_ithread_destroy (c_ithread_t *ithread)
1065 dTHXa (ithread->interp);
1067 assert (NULL != perl_threads);
1069 PERL_SET_CONTEXT (aTHX);
1070 log_debug ("Shutting down Perl interpreter %p...", aTHX);
1075 --perl_threads->number_of_threads;
1076 #endif /* COLLECT_DEBUG */
1078 perl_destruct (aTHX);
1081 if (NULL == ithread->prev)
1082 perl_threads->head = ithread->next;
1084 ithread->prev->next = ithread->next;
1086 if (NULL == ithread->next)
1087 perl_threads->tail = ithread->prev;
1089 ithread->next->prev = ithread->prev;
1093 } /* static void c_ithread_destroy (c_ithread_t *) */
1095 static void c_ithread_destructor (void *arg)
1097 c_ithread_t *ithread = (c_ithread_t *)arg;
1098 c_ithread_t *t = NULL;
1100 if (NULL == perl_threads)
1103 pthread_mutex_lock (&perl_threads->mutex);
1105 for (t = perl_threads->head; NULL != t; t = t->next)
1109 /* the ithread no longer exists */
1113 c_ithread_destroy (ithread);
1115 pthread_mutex_unlock (&perl_threads->mutex);
1117 } /* static void c_ithread_destructor (void *) */
1119 /* must be called with perl_threads->mutex locked */
1120 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
1122 c_ithread_t *t = NULL;
1125 assert (NULL != perl_threads);
1127 t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
1128 memset (t, 0, sizeof (c_ithread_t));
1130 t->interp = (NULL == base)
1132 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1136 if ((NULL != base) && (NULL != PL_endav)) {
1137 av_clear (PL_endav);
1138 av_undef (PL_endav);
1143 ++perl_threads->number_of_threads;
1144 #endif /* COLLECT_DEBUG */
1148 if (NULL == perl_threads->tail) {
1149 perl_threads->head = t;
1153 perl_threads->tail->next = t;
1154 t->prev = perl_threads->tail;
1157 perl_threads->tail = t;
1159 pthread_setspecific (perl_thr_key, (const void *)t);
1161 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1164 * Interface to collectd.
1167 static int perl_init (void)
1171 if (NULL == perl_threads)
1175 c_ithread_t *t = NULL;
1177 pthread_mutex_lock (&perl_threads->mutex);
1178 t = c_ithread_create (perl_threads->head->interp);
1179 pthread_mutex_unlock (&perl_threads->mutex);
1184 log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
1185 aTHX, perl_threads->number_of_threads);
1186 return pplugin_call_all (aTHX_ PLUGIN_INIT);
1187 } /* static int perl_init (void) */
1189 static int perl_read (void)
1193 if (NULL == perl_threads)
1197 c_ithread_t *t = NULL;
1199 pthread_mutex_lock (&perl_threads->mutex);
1200 t = c_ithread_create (perl_threads->head->interp);
1201 pthread_mutex_unlock (&perl_threads->mutex);
1206 log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1207 aTHX, perl_threads->number_of_threads);
1208 return pplugin_call_all (aTHX_ PLUGIN_READ);
1209 } /* static int perl_read (void) */
1211 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1215 if (NULL == perl_threads)
1219 c_ithread_t *t = NULL;
1221 pthread_mutex_lock (&perl_threads->mutex);
1222 t = c_ithread_create (perl_threads->head->interp);
1223 pthread_mutex_unlock (&perl_threads->mutex);
1228 log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1229 aTHX, perl_threads->number_of_threads);
1230 return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1231 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1233 static void perl_log (int level, const char *msg)
1237 if (NULL == perl_threads)
1241 c_ithread_t *t = NULL;
1243 pthread_mutex_lock (&perl_threads->mutex);
1244 t = c_ithread_create (perl_threads->head->interp);
1245 pthread_mutex_unlock (&perl_threads->mutex);
1250 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1252 } /* static void perl_log (int, const char *) */
1254 static int perl_notify (const notification_t *notif)
1258 if (NULL == perl_threads)
1262 c_ithread_t *t = NULL;
1264 pthread_mutex_lock (&perl_threads->mutex);
1265 t = c_ithread_create (perl_threads->head->interp);
1266 pthread_mutex_unlock (&perl_threads->mutex);
1270 return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1271 } /* static int perl_notify (const notification_t *) */
1273 /* TODO: Implement flushing of single identifiers. */
1274 static int perl_flush (int timeout, const char *identifier)
1278 if (NULL == perl_threads)
1282 c_ithread_t *t = NULL;
1284 pthread_mutex_lock (&perl_threads->mutex);
1285 t = c_ithread_create (perl_threads->head->interp);
1286 pthread_mutex_unlock (&perl_threads->mutex);
1290 return pplugin_call_all (aTHX_ PLUGIN_FLUSH, timeout);
1291 } /* static int perl_flush (const int) */
1293 static int perl_shutdown (void)
1295 c_ithread_t *t = NULL;
1301 plugin_unregister_complex_config ("perl");
1303 if (NULL == perl_threads)
1307 c_ithread_t *t = NULL;
1309 pthread_mutex_lock (&perl_threads->mutex);
1310 t = c_ithread_create (perl_threads->head->interp);
1311 pthread_mutex_unlock (&perl_threads->mutex);
1316 log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1317 aTHX, perl_threads->number_of_threads);
1319 plugin_unregister_log ("perl");
1320 plugin_unregister_notification ("perl");
1321 plugin_unregister_init ("perl");
1322 plugin_unregister_read ("perl");
1323 plugin_unregister_write ("perl");
1324 plugin_unregister_flush ("perl");
1326 ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1328 pthread_mutex_lock (&perl_threads->mutex);
1329 t = perl_threads->tail;
1332 c_ithread_t *thr = t;
1334 /* the pointer has to be advanced before destroying
1335 * the thread as this will free the memory */
1338 c_ithread_destroy (thr);
1341 pthread_mutex_unlock (&perl_threads->mutex);
1342 pthread_mutex_destroy (&perl_threads->mutex);
1344 sfree (perl_threads);
1346 pthread_key_delete (perl_thr_key);
1350 plugin_unregister_shutdown ("perl");
1352 } /* static void perl_shutdown (void) */
1355 * Access functions for global variables.
1357 * These functions implement the "magic" used to access
1358 * the global variables from Perl.
1361 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1363 char *pv = mg->mg_ptr;
1366 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1368 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1370 char *pv = mg->mg_ptr;
1371 sstrncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1373 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1375 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1377 int *iv = (int *)mg->mg_ptr;
1378 sv_setiv (var, *iv);
1380 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1382 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1384 int *iv = (int *)mg->mg_ptr;
1385 *iv = (int)SvIV (var);
1387 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1389 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1390 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1392 /* bootstrap the Collectd module */
1393 static void xs_init (pTHX)
1397 char *file = __FILE__;
1403 /* enable usage of Perl modules using shared libraries */
1404 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1407 for (i = 0; NULL != api[i].f; ++i)
1408 newXS (api[i].name, api[i].f, file);
1410 stash = gv_stashpv ("Collectd", 1);
1412 /* export "constants" */
1413 for (i = 0; '\0' != constants[i].name[0]; ++i)
1414 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1416 /* export global variables
1417 * by adding "magic" to the SV's representing the globale variables
1418 * perl is able to automagically call the get/set function when
1419 * accessing any such variable (this is basically the same as using
1421 /* global strings */
1422 for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1423 tmp = get_sv (g_strings[i].name, 1);
1424 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1425 g_strings[i].var, 0);
1428 /* global integers */
1429 for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1430 tmp = get_sv (g_integers[i].name, 1);
1431 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1432 (char *)g_integers[i].var, 0);
1435 } /* static void xs_init (pTHX) */
1437 /* Initialize the global Perl interpreter. */
1438 static int init_pi (int argc, char **argv)
1442 if (NULL != perl_threads)
1445 log_info ("Initializing Perl interpreter...");
1450 for (i = 0; i < argc; ++i)
1451 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1453 #endif /* COLLECT_DEBUG */
1455 if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1456 log_err ("init_pi: pthread_key_create failed");
1458 /* this must not happen - cowardly giving up if it does */
1463 /* On FreeBSD, PERL_SYS_INIT3 expands to some expression which
1464 * triggers a "value computed is not used" warning by gcc. */
1467 PERL_SYS_INIT3 (&argc, &argv, &environ);
1469 perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1470 memset (perl_threads, 0, sizeof (c_ithread_list_t));
1472 pthread_mutex_init (&perl_threads->mutex, NULL);
1473 /* locking the mutex should not be necessary at this point
1474 * but let's just do it for the sake of completeness */
1475 pthread_mutex_lock (&perl_threads->mutex);
1477 perl_threads->head = c_ithread_create (NULL);
1478 perl_threads->tail = perl_threads->head;
1480 if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1481 log_err ("init_pi: Not enough memory.");
1485 aTHX = perl_threads->head->interp;
1486 pthread_mutex_unlock (&perl_threads->mutex);
1488 perl_construct (aTHX);
1490 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1492 if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1493 log_err ("init_pi: Unable to bootstrap Collectd.");
1495 perl_destruct (perl_threads->head->interp);
1496 perl_free (perl_threads->head->interp);
1497 sfree (perl_threads);
1499 pthread_key_delete (perl_thr_key);
1503 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1504 sv_setpv (get_sv ("0", 0), "collectd");
1508 plugin_register_log ("perl", perl_log);
1509 plugin_register_notification ("perl", perl_notify);
1510 plugin_register_init ("perl", perl_init);
1512 plugin_register_read ("perl", perl_read);
1514 plugin_register_write ("perl", perl_write);
1515 plugin_register_flush ("perl", perl_flush);
1516 plugin_register_shutdown ("perl", perl_shutdown);
1518 } /* static int init_pi (const char **, const int) */
1521 * LoadPlugin "<Plugin>"
1523 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1525 char module_name[DATA_MAX_NAME_LEN];
1529 if ((0 != ci->children_num) || (1 != ci->values_num)
1530 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1531 log_err ("LoadPlugin expects a single string argument.");
1535 value = ci->values[0].value.string;
1537 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1538 log_err ("Invalid module name %s", value);
1542 if (0 != init_pi (perl_argc, perl_argv))
1545 assert (NULL != perl_threads);
1546 assert (NULL != perl_threads->head);
1548 aTHX = perl_threads->head->interp;
1550 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1551 load_module (PERL_LOADMOD_NOIMPORT,
1552 newSVpv (module_name, strlen (module_name)), Nullsv);
1554 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1559 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1563 if ((0 != ci->children_num) || (1 != ci->values_num)
1564 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1565 log_err ("BaseName expects a single string argument.");
1569 value = ci->values[0].value.string;
1571 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1572 sstrncpy (base_name, value, sizeof (base_name));
1574 } /* static int perl_config_basename (oconfig_item_it *) */
1577 * EnableDebugger "<Package>"|""
1579 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1583 if ((0 != ci->children_num) || (1 != ci->values_num)
1584 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1585 log_err ("EnableDebugger expects a single string argument.");
1589 if (NULL != perl_threads) {
1590 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
1594 value = ci->values[0].value.string;
1596 perl_argv = (char **)realloc (perl_argv,
1597 (++perl_argc + 1) * sizeof (char *));
1599 if (NULL == perl_argv) {
1600 log_err ("perl_config: Not enough memory.");
1604 if ('\0' == value[0]) {
1605 perl_argv[perl_argc - 1] = "-d";
1608 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1609 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1610 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1613 perl_argv[perl_argc] = NULL;
1615 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1618 * IncludeDir "<Dir>"
1620 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1624 if ((0 != ci->children_num) || (1 != ci->values_num)
1625 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1626 log_err ("IncludeDir expects a single string argument.");
1630 value = ci->values[0].value.string;
1633 perl_argv = (char **)realloc (perl_argv,
1634 (++perl_argc + 1) * sizeof (char *));
1636 if (NULL == perl_argv) {
1637 log_err ("perl_config: Not enough memory.");
1641 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1642 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1643 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1645 perl_argv[perl_argc] = NULL;
1648 /* prepend the directory to @INC */
1649 av_unshift (GvAVn (PL_incgv), 1);
1650 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1653 } /* static int perl_config_includedir (oconfig_item_it *) */
1655 static int perl_config (oconfig_item_t *ci)
1661 /* dTHX does not get any valid values in case Perl
1662 * has not been initialized */
1663 if (NULL == perl_threads)
1666 for (i = 0; i < ci->children_num; ++i) {
1667 oconfig_item_t *c = ci->children + i;
1669 if (0 == strcasecmp (c->key, "LoadPlugin"))
1670 perl_config_loadplugin (aTHX_ c);
1671 else if (0 == strcasecmp (c->key, "BaseName"))
1672 perl_config_basename (aTHX_ c);
1673 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1674 perl_config_enabledebugger (aTHX_ c);
1675 else if (0 == strcasecmp (c->key, "IncludeDir"))
1676 perl_config_includedir (aTHX_ c);
1678 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1681 } /* static int perl_config (oconfig_item_t *) */
1683 void module_register (void)
1686 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1688 /* default options for the Perl interpreter */
1690 perl_argv[1] = "-MCollectd";
1691 perl_argv[2] = "-e";
1693 perl_argv[4] = NULL;
1695 plugin_register_complex_config ("perl", perl_config);
1697 } /* void module_register (void) */
1699 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */