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
32 #include "configfile.h"
39 /* Some versions of Perl define their own version of DEBUG... :-/ */
44 /* ... while we want the definition found in plugin.h. */
50 #if !defined(USE_ITHREADS)
51 # error "Perl does not support ithreads!"
52 #endif /* !defined(USE_ITHREADS) */
54 /* clear the Perl sub's stack frame
55 * (this should only be used inside an XSUB) */
56 #define CLEAR_STACK_FRAME PL_stack_sp = PL_stack_base + *PL_markstack_ptr
60 #define PLUGIN_WRITE 2
61 #define PLUGIN_SHUTDOWN 3
63 #define PLUGIN_NOTIF 5
64 #define PLUGIN_FLUSH 6
66 #define PLUGIN_TYPES 7
68 #define PLUGIN_DATASET 255
70 #define log_debug(...) DEBUG ("perl: " __VA_ARGS__)
71 #define log_info(...) INFO ("perl: " __VA_ARGS__)
72 #define log_warn(...) WARNING ("perl: " __VA_ARGS__)
73 #define log_err(...) ERROR ("perl: " __VA_ARGS__)
75 /* this is defined in DynaLoader.a */
76 void boot_DynaLoader (PerlInterpreter *, CV *);
78 static XS (Collectd_plugin_register_ds);
79 static XS (Collectd_plugin_unregister_ds);
80 static XS (Collectd_plugin_dispatch_values);
81 static XS (Collectd_plugin_flush_one);
82 static XS (Collectd_plugin_flush_all);
83 static XS (Collectd_plugin_dispatch_notification);
84 static XS (Collectd_plugin_log);
85 static XS (Collectd_call_by_name);
91 typedef struct c_ithread_s {
92 /* the thread's Perl interpreter */
93 PerlInterpreter *interp;
95 /* double linked list of threads */
96 struct c_ithread_s *prev;
97 struct c_ithread_s *next;
105 /* some usage stats */
106 int number_of_threads;
107 #endif /* COLLECT_DEBUG */
109 pthread_mutex_t mutex;
116 /* if perl_threads != NULL perl_threads->head must
117 * point to the "base" thread */
118 static c_ithread_list_t *perl_threads = NULL;
120 /* the key used to store each pthread's ithread */
121 static pthread_key_t perl_thr_key;
123 static int perl_argc = 0;
124 static char **perl_argv = NULL;
126 static char base_name[DATA_MAX_NAME_LEN] = "";
133 { "Collectd::plugin_register_data_set", Collectd_plugin_register_ds },
134 { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
135 { "Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values },
136 { "Collectd::plugin_flush_one", Collectd_plugin_flush_one },
137 { "Collectd::plugin_flush_all", Collectd_plugin_flush_all },
138 { "Collectd::plugin_dispatch_notification",
139 Collectd_plugin_dispatch_notification },
140 { "Collectd::plugin_log", Collectd_plugin_log },
141 { "Collectd::call_by_name", Collectd_call_by_name },
150 { "Collectd::TYPE_INIT", PLUGIN_INIT },
151 { "Collectd::TYPE_READ", PLUGIN_READ },
152 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
153 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
154 { "Collectd::TYPE_LOG", PLUGIN_LOG },
155 { "Collectd::TYPE_NOTIF", PLUGIN_NOTIF },
156 { "Collectd::TYPE_FLUSH", PLUGIN_FLUSH },
157 { "Collectd::TYPE_DATASET", PLUGIN_DATASET },
158 { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
159 { "Collectd::DS_TYPE_GAUGE", DS_TYPE_GAUGE },
160 { "Collectd::LOG_ERR", LOG_ERR },
161 { "Collectd::LOG_WARNING", LOG_WARNING },
162 { "Collectd::LOG_NOTICE", LOG_NOTICE },
163 { "Collectd::LOG_INFO", LOG_INFO },
164 { "Collectd::LOG_DEBUG", LOG_DEBUG },
165 { "Collectd::NOTIF_FAILURE", NOTIF_FAILURE },
166 { "Collectd::NOTIF_WARNING", NOTIF_WARNING },
167 { "Collectd::NOTIF_OKAY", NOTIF_OKAY },
176 { "Collectd::hostname_g", hostname_g },
185 { "Collectd::interval_g", &interval_g },
190 * Helper functions for data type conversion.
205 static int hv2data_source (pTHX_ HV *hash, data_source_t *ds)
209 if ((NULL == hash) || (NULL == ds))
212 if (NULL != (tmp = hv_fetch (hash, "name", 4, 0))) {
213 sstrncpy (ds->name, SvPV_nolen (*tmp), sizeof (ds->name));
216 log_err ("hv2data_source: No DS name given.");
220 if (NULL != (tmp = hv_fetch (hash, "type", 4, 0))) {
221 ds->type = SvIV (*tmp);
223 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
224 log_err ("hv2data_source: Invalid DS type.");
229 ds->type = DS_TYPE_COUNTER;
232 if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
233 ds->min = SvNV (*tmp);
237 if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
238 ds->max = SvNV (*tmp);
242 } /* static data_source_t *hv2data_source (HV *) */
244 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
246 const data_set_t *ds;
250 if ((NULL == name) || (NULL == array) || (NULL == value))
253 if (av_len (array) < len - 1)
254 len = av_len (array) + 1;
259 ds = plugin_get_ds (name);
261 log_err ("av2value: Unknown dataset \"%s\"", name);
265 if (ds->ds_num < len) {
266 log_warn ("av2value: Value length exceeds data set length.");
270 for (i = 0; i < len; ++i) {
271 SV **tmp = av_fetch (array, i, 0);
274 if (DS_TYPE_COUNTER == ds->ds[i].type)
275 value[i].counter = SvIV (*tmp);
277 value[i].gauge = SvNV (*tmp);
284 } /* static int av2value (char *, AV *, value_t *, int) */
286 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
290 if ((NULL == ds) || (NULL == array))
293 av_extend (array, ds->ds_num);
295 for (i = 0; i < ds->ds_num; ++i) {
296 HV *source = newHV ();
298 if (NULL == hv_store (source, "name", 4,
299 newSVpv (ds->ds[i].name, 0), 0))
302 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
305 if (! isnan (ds->ds[i].min))
306 if (NULL == hv_store (source, "min", 3,
307 newSVnv (ds->ds[i].min), 0))
310 if (! isnan (ds->ds[i].max))
311 if (NULL == hv_store (source, "max", 3,
312 newSVnv (ds->ds[i].max), 0))
315 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
319 } /* static int data_set2av (data_set_t *, AV *) */
321 static int value_list2hv (pTHX_ value_list_t *vl, data_set_t *ds, HV *hash)
328 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
331 len = vl->values_len;
333 if (ds->ds_num < len) {
334 log_warn ("value2av: Value length exceeds data set length.");
339 av_extend (values, len - 1);
341 for (i = 0; i < len; ++i) {
344 if (DS_TYPE_COUNTER == ds->ds[i].type)
345 val = newSViv (vl->values[i].counter);
347 val = newSVnv (vl->values[i].gauge);
349 if (NULL == av_store (values, i, val)) {
355 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
359 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
362 if ('\0' != vl->host[0])
363 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
366 if ('\0' != vl->plugin[0])
367 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
370 if ('\0' != vl->plugin_instance[0])
371 if (NULL == hv_store (hash, "plugin_instance", 15,
372 newSVpv (vl->plugin_instance, 0), 0))
375 if ('\0' != vl->type[0])
376 if (NULL == hv_store (hash, "type", 4, newSVpv (vl->type, 0), 0))
379 if ('\0' != vl->type_instance[0])
380 if (NULL == hv_store (hash, "type_instance", 13,
381 newSVpv (vl->type_instance, 0), 0))
384 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
386 static int notification2hv (pTHX_ notification_t *n, HV *hash)
388 if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
392 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
395 if ('\0' != *n->message)
396 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
399 if ('\0' != *n->host)
400 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
403 if ('\0' != *n->plugin)
404 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
407 if ('\0' != *n->plugin_instance)
408 if (NULL == hv_store (hash, "plugin_instance", 15,
409 newSVpv (n->plugin_instance, 0), 0))
412 if ('\0' != *n->type)
413 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
416 if ('\0' != *n->type_instance)
417 if (NULL == hv_store (hash, "type_instance", 13,
418 newSVpv (n->type_instance, 0), 0))
421 } /* static int notification2hv (notification_t *, HV *) */
424 * Internal functions.
427 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
429 if (base_name[0] == '\0')
430 status = ssnprintf (buf, buf_len, "%s", module);
432 status = ssnprintf (buf, buf_len, "%s::%s", base_name, module);
433 if ((status < 0) || ((unsigned int)status >= buf_len))
436 } /* char *get_module_name */
439 * Add a plugin's data set definition.
441 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
447 data_source_t *ds = NULL;
448 data_set_t *set = NULL;
450 if ((NULL == name) || (NULL == dataset))
453 len = av_len (dataset);
458 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
459 set = (data_set_t *)smalloc (sizeof (data_set_t));
461 for (i = 0; i <= len; ++i) {
462 SV **elem = av_fetch (dataset, i, 0);
467 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
468 log_err ("pplugin_register_data_set: Invalid data source.");
472 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
475 log_debug ("pplugin_register_data_set: "
476 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
477 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
480 sstrncpy (set->type, name, sizeof (set->type));
482 set->ds_num = len + 1;
485 ret = plugin_register_data_set (set);
490 } /* static int pplugin_register_data_set (char *, SV *) */
493 * Remove a plugin's data set definition.
495 static int pplugin_unregister_data_set (char *name)
499 return plugin_unregister_data_set (name);
500 } /* static int pplugin_unregister_data_set (char *) */
503 * Submit the values to the write functions.
507 * values => [ @values ],
511 * plugin_instance => $pinstance,
512 * type_instance => $tinstance,
515 static int pplugin_dispatch_values (pTHX_ HV *values)
517 value_list_t list = VALUE_LIST_INIT;
527 if (NULL == (tmp = hv_fetch (values, "type", 4, 0))) {
528 log_err ("pplugin_dispatch_values: No type given.");
532 sstrncpy (list.type, SvPV_nolen (*tmp), sizeof (list.type));
534 if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
535 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
536 log_err ("pplugin_dispatch_values: No valid values given.");
541 AV *array = (AV *)SvRV (*tmp);
542 int len = av_len (array) + 1;
547 val = (value_t *)smalloc (len * sizeof (value_t));
549 list.values_len = av2value (aTHX_ list.type, (AV *)SvRV (*tmp),
553 if (-1 == list.values_len) {
559 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
560 list.time = (time_t)SvIV (*tmp);
563 list.time = time (NULL);
566 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
567 sstrncpy (list.host, SvPV_nolen (*tmp), sizeof (list.host));
570 sstrncpy (list.host, hostname_g, sizeof (list.host));
573 if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0)))
574 sstrncpy (list.plugin, SvPV_nolen (*tmp), sizeof (list.plugin));
576 if (NULL != (tmp = hv_fetch (values, "plugin_instance", 15, 0)))
577 sstrncpy (list.plugin_instance, SvPV_nolen (*tmp),
578 sizeof (list.plugin_instance));
580 if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0)))
581 sstrncpy (list.type_instance, SvPV_nolen (*tmp),
582 sizeof (list.type_instance));
584 ret = plugin_dispatch_values (&list);
588 } /* static int pplugin_dispatch_values (char *, HV *) */
591 * Dispatch a notification.
595 * severity => $severity,
601 * plugin_instance => $instance,
602 * type_instance => $type_instance
605 static int pplugin_dispatch_notification (pTHX_ HV *notif)
614 memset (&n, 0, sizeof (n));
616 if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
617 n.severity = SvIV (*tmp);
619 n.severity = NOTIF_FAILURE;
621 if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
622 n.time = (time_t)SvIV (*tmp);
624 n.time = time (NULL);
626 if (NULL != (tmp = hv_fetch (notif, "message", 7, 0)))
627 sstrncpy (n.message, SvPV_nolen (*tmp), sizeof (n.message));
629 if (NULL != (tmp = hv_fetch (notif, "host", 4, 0)))
630 sstrncpy (n.host, SvPV_nolen (*tmp), sizeof (n.host));
632 sstrncpy (n.host, hostname_g, sizeof (n.host));
634 if (NULL != (tmp = hv_fetch (notif, "plugin", 6, 0)))
635 sstrncpy (n.plugin, SvPV_nolen (*tmp), sizeof (n.plugin));
637 if (NULL != (tmp = hv_fetch (notif, "plugin_instance", 15, 0)))
638 sstrncpy (n.plugin_instance, SvPV_nolen (*tmp),
639 sizeof (n.plugin_instance));
641 if (NULL != (tmp = hv_fetch (notif, "type", 4, 0)))
642 sstrncpy (n.type, SvPV_nolen (*tmp), sizeof (n.type));
644 if (NULL != (tmp = hv_fetch (notif, "type_instance", 13, 0)))
645 sstrncpy (n.type_instance, SvPV_nolen (*tmp), sizeof (n.type_instance));
646 return plugin_dispatch_notification (&n);
647 } /* static int pplugin_dispatch_notification (HV *) */
650 * Call all working functions of the given type.
652 static int pplugin_call_all (pTHX_ int type, ...)
661 if ((type < 0) || (type >= PLUGIN_TYPES))
671 XPUSHs (sv_2mortal (newSViv ((IV)type)));
673 if (PLUGIN_WRITE == type) {
675 * $_[0] = $plugin_type;
690 * values => [ $v1, ... ],
695 * plugin_instance => $instance,
696 * type_instance => $type_instance
705 ds = va_arg (ap, data_set_t *);
706 vl = va_arg (ap, value_list_t *);
708 if (-1 == data_set2av (aTHX_ ds, pds)) {
715 if (-1 == value_list2hv (aTHX_ vl, ds, pvl)) {
722 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
723 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
724 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
726 else if (PLUGIN_LOG == type) {
732 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
733 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
735 else if (PLUGIN_NOTIF == type) {
739 * severity => $severity,
745 * plugin_instance => $instance,
746 * type_instance => $type_instance
750 HV *notif = newHV ();
752 n = va_arg (ap, notification_t *);
754 if (-1 == notification2hv (aTHX_ n, notif)) {
761 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
763 else if (PLUGIN_FLUSH == type) {
767 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
772 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
787 } /* static int pplugin_call_all (int, ...) */
794 * Collectd::plugin_register_data_set (type, dataset).
797 * type of the dataset
800 * dataset to be registered
802 static XS (Collectd_plugin_register_ds)
810 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
814 log_debug ("Collectd::plugin_register_data_set: "
815 "type = \"%s\", dataset = \"%s\"",
816 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
820 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
821 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
825 log_err ("Collectd::plugin_register_data_set: Invalid data.");
833 } /* static XS (Collectd_plugin_register_ds) */
836 * Collectd::plugin_unregister_data_set (type).
839 * type of the dataset
841 static XS (Collectd_plugin_unregister_ds)
846 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
850 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
851 SvPV_nolen (ST (0)));
853 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (0))))
857 } /* static XS (Collectd_plugin_register_ds) */
860 * Collectd::plugin_dispatch_values (name, values).
866 * value list to submit
868 static XS (Collectd_plugin_dispatch_values)
878 log_warn ("Collectd::plugin_dispatch_values with two arguments "
879 "is deprecated - pass the type through values->{type}.");
882 else if (1 != items) {
883 log_err ("Usage: Collectd::plugin_dispatch_values(values)");
887 log_debug ("Collectd::plugin_dispatch_values: values=\"%s\"",
888 SvPV_nolen (ST (values_idx)));
890 values = ST (values_idx);
892 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
893 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
897 if (((2 == items) && (NULL == ST (0))) || (NULL == values))
900 if ((2 == items) && (NULL == hv_store ((HV *)SvRV (values), "type", 4,
901 newSVsv (ST (0)), 0))) {
902 log_err ("Collectd::plugin_dispatch_values: Could not store type.");
906 ret = pplugin_dispatch_values (aTHX_ (HV *)SvRV (values));
912 } /* static XS (Collectd_plugin_dispatch_values) */
915 * Collectd::plugin_flush_one (timeout, name).
918 * timeout to use when flushing the data
921 * name of the plugin to flush
923 static XS (Collectd_plugin_flush_one)
928 log_err ("Usage: Collectd::plugin_flush_one(timeout, name)");
932 log_debug ("Collectd::plugin_flush_one: timeout = %i, name = \"%s\"",
933 (int)SvIV (ST (0)), SvPV_nolen (ST (1)));
935 if (0 == plugin_flush_one ((int)SvIV (ST (0)), SvPV_nolen (ST (1))))
939 } /* static XS (Collectd_plugin_flush_one) */
942 * Collectd::plugin_flush_all (timeout).
945 * timeout to use when flushing the data
947 static XS (Collectd_plugin_flush_all)
952 log_err ("Usage: Collectd::plugin_flush_all(timeout)");
956 log_debug ("Collectd::plugin_flush_all: timeout = %i", (int)SvIV (ST (0)));
958 plugin_flush_all ((int)SvIV (ST (0)));
960 } /* static XS (Collectd_plugin_flush_all) */
963 * Collectd::plugin_dispatch_notification (notif).
966 * notification to dispatch
968 static XS (Collectd_plugin_dispatch_notification)
977 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
981 log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
982 SvPV_nolen (ST (0)));
986 if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
987 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
991 ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
997 } /* static XS (Collectd_plugin_dispatch_notification) */
1000 * Collectd::plugin_log (level, message).
1003 * log level (LOG_DEBUG, ... LOG_ERR)
1008 static XS (Collectd_plugin_log)
1013 log_err ("Usage: Collectd::plugin_log(level, message)");
1017 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
1019 } /* static XS (Collectd_plugin_log) */
1022 * Collectd::call_by_name (...).
1024 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
1026 static XS (Collectd_call_by_name)
1031 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
1032 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
1037 name = SvPV_nolen (tmp);
1039 if (NULL == get_cv (name, 0)) {
1040 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
1045 /* simply pass on the subroutine call without touching the stack,
1046 * thus leaving any arguments and return values in place */
1048 } /* static XS (Collectd_call_by_name) */
1051 * collectd's perl interpreter based thread implementation.
1053 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
1056 /* must be called with perl_threads->mutex locked */
1057 static void c_ithread_destroy (c_ithread_t *ithread)
1059 dTHXa (ithread->interp);
1061 assert (NULL != perl_threads);
1063 PERL_SET_CONTEXT (aTHX);
1064 log_debug ("Shutting down Perl interpreter %p...", aTHX);
1069 --perl_threads->number_of_threads;
1070 #endif /* COLLECT_DEBUG */
1072 perl_destruct (aTHX);
1075 if (NULL == ithread->prev)
1076 perl_threads->head = ithread->next;
1078 ithread->prev->next = ithread->next;
1080 if (NULL == ithread->next)
1081 perl_threads->tail = ithread->prev;
1083 ithread->next->prev = ithread->prev;
1087 } /* static void c_ithread_destroy (c_ithread_t *) */
1089 static void c_ithread_destructor (void *arg)
1091 c_ithread_t *ithread = (c_ithread_t *)arg;
1092 c_ithread_t *t = NULL;
1094 if (NULL == perl_threads)
1097 pthread_mutex_lock (&perl_threads->mutex);
1099 for (t = perl_threads->head; NULL != t; t = t->next)
1103 /* the ithread no longer exists */
1107 c_ithread_destroy (ithread);
1109 pthread_mutex_unlock (&perl_threads->mutex);
1111 } /* static void c_ithread_destructor (void *) */
1113 /* must be called with perl_threads->mutex locked */
1114 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
1116 c_ithread_t *t = NULL;
1119 assert (NULL != perl_threads);
1121 t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
1122 memset (t, 0, sizeof (c_ithread_t));
1124 t->interp = (NULL == base)
1126 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1130 if ((NULL != base) && (NULL != PL_endav)) {
1131 av_clear (PL_endav);
1132 av_undef (PL_endav);
1137 ++perl_threads->number_of_threads;
1138 #endif /* COLLECT_DEBUG */
1142 if (NULL == perl_threads->tail) {
1143 perl_threads->head = t;
1147 perl_threads->tail->next = t;
1148 t->prev = perl_threads->tail;
1151 perl_threads->tail = t;
1153 pthread_setspecific (perl_thr_key, (const void *)t);
1155 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1158 * Interface to collectd.
1161 static int perl_init (void)
1165 if (NULL == perl_threads)
1169 c_ithread_t *t = NULL;
1171 pthread_mutex_lock (&perl_threads->mutex);
1172 t = c_ithread_create (perl_threads->head->interp);
1173 pthread_mutex_unlock (&perl_threads->mutex);
1178 log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
1179 aTHX, perl_threads->number_of_threads);
1180 return pplugin_call_all (aTHX_ PLUGIN_INIT);
1181 } /* static int perl_init (void) */
1183 static int perl_read (void)
1187 if (NULL == perl_threads)
1191 c_ithread_t *t = NULL;
1193 pthread_mutex_lock (&perl_threads->mutex);
1194 t = c_ithread_create (perl_threads->head->interp);
1195 pthread_mutex_unlock (&perl_threads->mutex);
1200 log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1201 aTHX, perl_threads->number_of_threads);
1202 return pplugin_call_all (aTHX_ PLUGIN_READ);
1203 } /* static int perl_read (void) */
1205 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1209 if (NULL == perl_threads)
1213 c_ithread_t *t = NULL;
1215 pthread_mutex_lock (&perl_threads->mutex);
1216 t = c_ithread_create (perl_threads->head->interp);
1217 pthread_mutex_unlock (&perl_threads->mutex);
1222 log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1223 aTHX, perl_threads->number_of_threads);
1224 return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1225 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1227 static void perl_log (int level, const char *msg)
1231 if (NULL == perl_threads)
1235 c_ithread_t *t = NULL;
1237 pthread_mutex_lock (&perl_threads->mutex);
1238 t = c_ithread_create (perl_threads->head->interp);
1239 pthread_mutex_unlock (&perl_threads->mutex);
1244 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1246 } /* static void perl_log (int, const char *) */
1248 static int perl_notify (const notification_t *notif)
1252 if (NULL == perl_threads)
1256 c_ithread_t *t = NULL;
1258 pthread_mutex_lock (&perl_threads->mutex);
1259 t = c_ithread_create (perl_threads->head->interp);
1260 pthread_mutex_unlock (&perl_threads->mutex);
1264 return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1265 } /* static int perl_notify (const notification_t *) */
1267 /* TODO: Implement flushing of single identifiers. */
1268 static int perl_flush (int timeout, const char *identifier)
1272 if (NULL == perl_threads)
1276 c_ithread_t *t = NULL;
1278 pthread_mutex_lock (&perl_threads->mutex);
1279 t = c_ithread_create (perl_threads->head->interp);
1280 pthread_mutex_unlock (&perl_threads->mutex);
1284 return pplugin_call_all (aTHX_ PLUGIN_FLUSH, timeout);
1285 } /* static int perl_flush (const int) */
1287 static int perl_shutdown (void)
1289 c_ithread_t *t = NULL;
1295 plugin_unregister_complex_config ("perl");
1297 if (NULL == perl_threads)
1301 c_ithread_t *t = NULL;
1303 pthread_mutex_lock (&perl_threads->mutex);
1304 t = c_ithread_create (perl_threads->head->interp);
1305 pthread_mutex_unlock (&perl_threads->mutex);
1310 log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1311 aTHX, perl_threads->number_of_threads);
1313 plugin_unregister_log ("perl");
1314 plugin_unregister_notification ("perl");
1315 plugin_unregister_init ("perl");
1316 plugin_unregister_read ("perl");
1317 plugin_unregister_write ("perl");
1318 plugin_unregister_flush ("perl");
1320 ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1322 pthread_mutex_lock (&perl_threads->mutex);
1323 t = perl_threads->tail;
1326 c_ithread_t *thr = t;
1328 /* the pointer has to be advanced before destroying
1329 * the thread as this will free the memory */
1332 c_ithread_destroy (thr);
1335 pthread_mutex_unlock (&perl_threads->mutex);
1336 pthread_mutex_destroy (&perl_threads->mutex);
1338 sfree (perl_threads);
1340 pthread_key_delete (perl_thr_key);
1344 plugin_unregister_shutdown ("perl");
1346 } /* static void perl_shutdown (void) */
1349 * Access functions for global variables.
1351 * These functions implement the "magic" used to access
1352 * the global variables from Perl.
1355 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1357 char *pv = mg->mg_ptr;
1360 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1362 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1364 char *pv = mg->mg_ptr;
1365 sstrncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1367 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1369 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1371 int *iv = (int *)mg->mg_ptr;
1372 sv_setiv (var, *iv);
1374 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1376 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1378 int *iv = (int *)mg->mg_ptr;
1379 *iv = (int)SvIV (var);
1381 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1383 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1384 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1386 /* bootstrap the Collectd module */
1387 static void xs_init (pTHX)
1391 char *file = __FILE__;
1397 /* enable usage of Perl modules using shared libraries */
1398 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1401 for (i = 0; NULL != api[i].f; ++i)
1402 newXS (api[i].name, api[i].f, file);
1404 stash = gv_stashpv ("Collectd", 1);
1406 /* export "constants" */
1407 for (i = 0; '\0' != constants[i].name[0]; ++i)
1408 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1410 /* export global variables
1411 * by adding "magic" to the SV's representing the globale variables
1412 * perl is able to automagically call the get/set function when
1413 * accessing any such variable (this is basically the same as using
1415 /* global strings */
1416 for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1417 tmp = get_sv (g_strings[i].name, 1);
1418 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1419 g_strings[i].var, 0);
1422 /* global integers */
1423 for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1424 tmp = get_sv (g_integers[i].name, 1);
1425 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1426 (char *)g_integers[i].var, 0);
1429 } /* static void xs_init (pTHX) */
1431 /* Initialize the global Perl interpreter. */
1432 static int init_pi (int argc, char **argv)
1436 if (NULL != perl_threads)
1439 log_info ("Initializing Perl interpreter...");
1444 for (i = 0; i < argc; ++i)
1445 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1447 #endif /* COLLECT_DEBUG */
1449 if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1450 log_err ("init_pi: pthread_key_create failed");
1452 /* this must not happen - cowardly giving up if it does */
1457 /* On FreeBSD, PERL_SYS_INIT3 expands to some expression which
1458 * triggers a "value computed is not used" warning by gcc. */
1461 PERL_SYS_INIT3 (&argc, &argv, &environ);
1463 perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1464 memset (perl_threads, 0, sizeof (c_ithread_list_t));
1466 pthread_mutex_init (&perl_threads->mutex, NULL);
1467 /* locking the mutex should not be necessary at this point
1468 * but let's just do it for the sake of completeness */
1469 pthread_mutex_lock (&perl_threads->mutex);
1471 perl_threads->head = c_ithread_create (NULL);
1472 perl_threads->tail = perl_threads->head;
1474 if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1475 log_err ("init_pi: Not enough memory.");
1479 aTHX = perl_threads->head->interp;
1480 pthread_mutex_unlock (&perl_threads->mutex);
1482 perl_construct (aTHX);
1484 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1486 if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1487 log_err ("init_pi: Unable to bootstrap Collectd.");
1489 perl_destruct (perl_threads->head->interp);
1490 perl_free (perl_threads->head->interp);
1491 sfree (perl_threads);
1493 pthread_key_delete (perl_thr_key);
1497 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1498 sv_setpv (get_sv ("0", 0), "collectd");
1502 plugin_register_log ("perl", perl_log);
1503 plugin_register_notification ("perl", perl_notify);
1504 plugin_register_init ("perl", perl_init);
1506 plugin_register_read ("perl", perl_read);
1508 plugin_register_write ("perl", perl_write);
1509 plugin_register_flush ("perl", perl_flush);
1510 plugin_register_shutdown ("perl", perl_shutdown);
1512 } /* static int init_pi (const char **, const int) */
1515 * LoadPlugin "<Plugin>"
1517 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1519 char module_name[DATA_MAX_NAME_LEN];
1523 if ((0 != ci->children_num) || (1 != ci->values_num)
1524 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1525 log_err ("LoadPlugin expects a single string argument.");
1529 value = ci->values[0].value.string;
1531 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1532 log_err ("Invalid module name %s", value);
1536 if (0 != init_pi (perl_argc, perl_argv))
1539 assert (NULL != perl_threads);
1540 assert (NULL != perl_threads->head);
1542 aTHX = perl_threads->head->interp;
1544 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1545 load_module (PERL_LOADMOD_NOIMPORT,
1546 newSVpv (module_name, strlen (module_name)), Nullsv);
1548 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1553 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1557 if ((0 != ci->children_num) || (1 != ci->values_num)
1558 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1559 log_err ("BaseName expects a single string argument.");
1563 value = ci->values[0].value.string;
1565 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1566 sstrncpy (base_name, value, sizeof (base_name));
1568 } /* static int perl_config_basename (oconfig_item_it *) */
1571 * EnableDebugger "<Package>"|""
1573 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1577 if ((0 != ci->children_num) || (1 != ci->values_num)
1578 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1579 log_err ("EnableDebugger expects a single string argument.");
1583 if (NULL != perl_threads) {
1584 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
1588 value = ci->values[0].value.string;
1590 perl_argv = (char **)realloc (perl_argv,
1591 (++perl_argc + 1) * sizeof (char *));
1593 if (NULL == perl_argv) {
1594 log_err ("perl_config: Not enough memory.");
1598 if ('\0' == value[0]) {
1599 perl_argv[perl_argc - 1] = "-d";
1602 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1603 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1604 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1607 perl_argv[perl_argc] = NULL;
1609 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1612 * IncludeDir "<Dir>"
1614 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1618 if ((0 != ci->children_num) || (1 != ci->values_num)
1619 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1620 log_err ("IncludeDir expects a single string argument.");
1624 value = ci->values[0].value.string;
1627 perl_argv = (char **)realloc (perl_argv,
1628 (++perl_argc + 1) * sizeof (char *));
1630 if (NULL == perl_argv) {
1631 log_err ("perl_config: Not enough memory.");
1635 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1636 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1637 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1639 perl_argv[perl_argc] = NULL;
1642 /* prepend the directory to @INC */
1643 av_unshift (GvAVn (PL_incgv), 1);
1644 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1647 } /* static int perl_config_includedir (oconfig_item_it *) */
1649 static int perl_config (oconfig_item_t *ci)
1655 /* dTHX does not get any valid values in case Perl
1656 * has not been initialized */
1657 if (NULL == perl_threads)
1660 for (i = 0; i < ci->children_num; ++i) {
1661 oconfig_item_t *c = ci->children + i;
1663 if (0 == strcasecmp (c->key, "LoadPlugin"))
1664 perl_config_loadplugin (aTHX_ c);
1665 else if (0 == strcasecmp (c->key, "BaseName"))
1666 perl_config_basename (aTHX_ c);
1667 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1668 perl_config_enabledebugger (aTHX_ c);
1669 else if (0 == strcasecmp (c->key, "IncludeDir"))
1670 perl_config_includedir (aTHX_ c);
1672 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1675 } /* static int perl_config (oconfig_item_t *) */
1677 void module_register (void)
1680 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1682 /* default options for the Perl interpreter */
1684 perl_argv[1] = "-MCollectd";
1685 perl_argv[2] = "-e";
1687 perl_argv[4] = NULL;
1689 plugin_register_complex_config ("perl", perl_config);
1691 } /* void module_register (void) */
1693 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */