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
65 #define PLUGIN_TYPES 6
67 #define PLUGIN_DATASET 255
69 #define log_debug(...) DEBUG ("perl: " __VA_ARGS__)
70 #define log_info(...) INFO ("perl: " __VA_ARGS__)
71 #define log_warn(...) WARNING ("perl: " __VA_ARGS__)
72 #define log_err(...) ERROR ("perl: " __VA_ARGS__)
74 /* this is defined in DynaLoader.a */
75 void boot_DynaLoader (PerlInterpreter *, CV *);
77 static XS (Collectd_plugin_register_ds);
78 static XS (Collectd_plugin_unregister_ds);
79 static XS (Collectd_plugin_dispatch_values);
80 static XS (Collectd_plugin_dispatch_notification);
81 static XS (Collectd_plugin_log);
82 static XS (Collectd_call_by_name);
88 typedef struct c_ithread_s {
89 /* the thread's Perl interpreter */
90 PerlInterpreter *interp;
92 /* double linked list of threads */
93 struct c_ithread_s *prev;
94 struct c_ithread_s *next;
102 /* some usage stats */
103 int number_of_threads;
104 #endif /* COLLECT_DEBUG */
106 pthread_mutex_t mutex;
113 /* if perl_threads != NULL perl_threads->head must
114 * point to the "base" thread */
115 static c_ithread_list_t *perl_threads = NULL;
117 /* the key used to store each pthread's ithread */
118 static pthread_key_t perl_thr_key;
120 static int perl_argc = 0;
121 static char **perl_argv = NULL;
123 static char base_name[DATA_MAX_NAME_LEN] = "";
130 { "Collectd::plugin_register_data_set", Collectd_plugin_register_ds },
131 { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
132 { "Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values },
133 { "Collectd::plugin_dispatch_notification",
134 Collectd_plugin_dispatch_notification },
135 { "Collectd::plugin_log", Collectd_plugin_log },
136 { "Collectd::call_by_name", Collectd_call_by_name },
145 { "Collectd::TYPE_INIT", PLUGIN_INIT },
146 { "Collectd::TYPE_READ", PLUGIN_READ },
147 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
148 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
149 { "Collectd::TYPE_LOG", PLUGIN_LOG },
150 { "Collectd::TYPE_NOTIF", PLUGIN_NOTIF },
151 { "Collectd::TYPE_DATASET", PLUGIN_DATASET },
152 { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
153 { "Collectd::DS_TYPE_GAUGE", DS_TYPE_GAUGE },
154 { "Collectd::LOG_ERR", LOG_ERR },
155 { "Collectd::LOG_WARNING", LOG_WARNING },
156 { "Collectd::LOG_NOTICE", LOG_NOTICE },
157 { "Collectd::LOG_INFO", LOG_INFO },
158 { "Collectd::LOG_DEBUG", LOG_DEBUG },
159 { "Collectd::NOTIF_FAILURE", NOTIF_FAILURE },
160 { "Collectd::NOTIF_WARNING", NOTIF_WARNING },
161 { "Collectd::NOTIF_OKAY", NOTIF_OKAY },
170 { "Collectd::hostname_g", hostname_g },
179 { "Collectd::interval_g", &interval_g },
184 * Helper functions for data type conversion.
199 static int hv2data_source (pTHX_ HV *hash, data_source_t *ds)
203 if ((NULL == hash) || (NULL == ds))
206 if (NULL != (tmp = hv_fetch (hash, "name", 4, 0))) {
207 sstrncpy (ds->name, SvPV_nolen (*tmp), sizeof (ds->name));
210 log_err ("hv2data_source: No DS name given.");
214 if (NULL != (tmp = hv_fetch (hash, "type", 4, 0))) {
215 ds->type = SvIV (*tmp);
217 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
218 log_err ("hv2data_source: Invalid DS type.");
223 ds->type = DS_TYPE_COUNTER;
226 if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
227 ds->min = SvNV (*tmp);
231 if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
232 ds->max = SvNV (*tmp);
236 } /* static data_source_t *hv2data_source (HV *) */
238 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
240 const data_set_t *ds;
244 if ((NULL == name) || (NULL == array) || (NULL == value))
247 if (av_len (array) < len - 1)
248 len = av_len (array) + 1;
253 ds = plugin_get_ds (name);
255 log_err ("av2value: Unknown dataset \"%s\"", name);
259 if (ds->ds_num < len) {
260 log_warn ("av2value: Value length exceeds data set length.");
264 for (i = 0; i < len; ++i) {
265 SV **tmp = av_fetch (array, i, 0);
268 if (DS_TYPE_COUNTER == ds->ds[i].type)
269 value[i].counter = SvIV (*tmp);
271 value[i].gauge = SvNV (*tmp);
278 } /* static int av2value (char *, AV *, value_t *, int) */
280 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
284 if ((NULL == ds) || (NULL == array))
287 av_extend (array, ds->ds_num);
289 for (i = 0; i < ds->ds_num; ++i) {
290 HV *source = newHV ();
292 if (NULL == hv_store (source, "name", 4,
293 newSVpv (ds->ds[i].name, 0), 0))
296 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
299 if (! isnan (ds->ds[i].min))
300 if (NULL == hv_store (source, "min", 3,
301 newSVnv (ds->ds[i].min), 0))
304 if (! isnan (ds->ds[i].max))
305 if (NULL == hv_store (source, "max", 3,
306 newSVnv (ds->ds[i].max), 0))
309 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
313 } /* static int data_set2av (data_set_t *, AV *) */
315 static int value_list2hv (pTHX_ value_list_t *vl, data_set_t *ds, HV *hash)
322 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
325 len = vl->values_len;
327 if (ds->ds_num < len) {
328 log_warn ("value2av: Value length exceeds data set length.");
333 av_extend (values, len - 1);
335 for (i = 0; i < len; ++i) {
338 if (DS_TYPE_COUNTER == ds->ds[i].type)
339 val = newSViv (vl->values[i].counter);
341 val = newSVnv (vl->values[i].gauge);
343 if (NULL == av_store (values, i, val)) {
349 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
353 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
356 if ('\0' != vl->host[0])
357 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
360 if ('\0' != vl->plugin[0])
361 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
364 if ('\0' != vl->plugin_instance[0])
365 if (NULL == hv_store (hash, "plugin_instance", 15,
366 newSVpv (vl->plugin_instance, 0), 0))
369 if ('\0' != vl->type[0])
370 if (NULL == hv_store (hash, "type", 4, newSVpv (vl->type, 0), 0))
373 if ('\0' != vl->type_instance[0])
374 if (NULL == hv_store (hash, "type_instance", 13,
375 newSVpv (vl->type_instance, 0), 0))
378 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
380 static int notification2hv (pTHX_ notification_t *n, HV *hash)
382 if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
386 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
389 if ('\0' != *n->message)
390 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
393 if ('\0' != *n->host)
394 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
397 if ('\0' != *n->plugin)
398 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
401 if ('\0' != *n->plugin_instance)
402 if (NULL == hv_store (hash, "plugin_instance", 15,
403 newSVpv (n->plugin_instance, 0), 0))
406 if ('\0' != *n->type)
407 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
410 if ('\0' != *n->type_instance)
411 if (NULL == hv_store (hash, "type_instance", 13,
412 newSVpv (n->type_instance, 0), 0))
415 } /* static int notification2hv (notification_t *, HV *) */
418 * Internal functions.
421 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
423 if (base_name[0] == '\0')
424 status = ssnprintf (buf, buf_len, "%s", module);
426 status = ssnprintf (buf, buf_len, "%s::%s", base_name, module);
427 if ((status < 0) || ((unsigned int)status >= buf_len))
430 } /* char *get_module_name */
433 * Add a plugin's data set definition.
435 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
441 data_source_t *ds = NULL;
442 data_set_t *set = NULL;
444 if ((NULL == name) || (NULL == dataset))
447 len = av_len (dataset);
452 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
453 set = (data_set_t *)smalloc (sizeof (data_set_t));
455 for (i = 0; i <= len; ++i) {
456 SV **elem = av_fetch (dataset, i, 0);
461 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
462 log_err ("pplugin_register_data_set: Invalid data source.");
466 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
469 log_debug ("pplugin_register_data_set: "
470 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
471 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
474 sstrncpy (set->type, name, sizeof (set->type));
476 set->ds_num = len + 1;
479 ret = plugin_register_data_set (set);
484 } /* static int pplugin_register_data_set (char *, SV *) */
487 * Remove a plugin's data set definition.
489 static int pplugin_unregister_data_set (char *name)
493 return plugin_unregister_data_set (name);
494 } /* static int pplugin_unregister_data_set (char *) */
497 * Submit the values to the write functions.
501 * values => [ @values ],
505 * plugin_instance => $pinstance,
506 * type_instance => $tinstance,
509 static int pplugin_dispatch_values (pTHX_ HV *values)
511 value_list_t list = VALUE_LIST_INIT;
521 if (NULL == (tmp = hv_fetch (values, "type", 4, 0))) {
522 log_err ("pplugin_dispatch_values: No type given.");
526 sstrncpy (list.type, SvPV_nolen (*tmp), sizeof (list.type));
528 if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
529 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
530 log_err ("pplugin_dispatch_values: No valid values given.");
535 AV *array = (AV *)SvRV (*tmp);
536 int len = av_len (array) + 1;
541 val = (value_t *)smalloc (len * sizeof (value_t));
543 list.values_len = av2value (aTHX_ list.type, (AV *)SvRV (*tmp),
547 if (-1 == list.values_len) {
553 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
554 list.time = (time_t)SvIV (*tmp);
557 list.time = time (NULL);
560 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
561 sstrncpy (list.host, SvPV_nolen (*tmp), sizeof (list.host));
564 strcpy (list.host, hostname_g);
567 if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0)))
568 sstrncpy (list.plugin, SvPV_nolen (*tmp), sizeof (list.plugin));
570 if (NULL != (tmp = hv_fetch (values, "plugin_instance", 15, 0)))
571 sstrncpy (list.plugin_instance, SvPV_nolen (*tmp),
572 sizeof (list.plugin_instance));
574 if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0)))
575 sstrncpy (list.type_instance, SvPV_nolen (*tmp),
576 sizeof (list.type_instance));
578 ret = plugin_dispatch_values (&list);
582 } /* static int pplugin_dispatch_values (char *, HV *) */
585 * Dispatch a notification.
589 * severity => $severity,
595 * plugin_instance => $instance,
596 * type_instance => $type_instance
599 static int pplugin_dispatch_notification (pTHX_ HV *notif)
608 memset (&n, 0, sizeof (n));
610 if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
611 n.severity = SvIV (*tmp);
613 n.severity = NOTIF_FAILURE;
615 if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
616 n.time = (time_t)SvIV (*tmp);
618 n.time = time (NULL);
620 if (NULL != (tmp = hv_fetch (notif, "message", 7, 0)))
621 sstrncpy (n.message, SvPV_nolen (*tmp), sizeof (n.message));
623 if (NULL != (tmp = hv_fetch (notif, "host", 4, 0)))
624 sstrncpy (n.host, SvPV_nolen (*tmp), sizeof (n.host));
626 sstrncpy (n.host, hostname_g, sizeof (n.host));
628 if (NULL != (tmp = hv_fetch (notif, "plugin", 6, 0)))
629 sstrncpy (n.plugin, SvPV_nolen (*tmp), sizeof (n.plugin));
631 if (NULL != (tmp = hv_fetch (notif, "plugin_instance", 15, 0)))
632 sstrncpy (n.plugin_instance, SvPV_nolen (*tmp),
633 sizeof (n.plugin_instance));
635 if (NULL != (tmp = hv_fetch (notif, "type", 4, 0)))
636 sstrncpy (n.type, SvPV_nolen (*tmp), sizeof (n.type));
638 if (NULL != (tmp = hv_fetch (notif, "type_instance", 13, 0)))
639 sstrncpy (n.type_instance, SvPV_nolen (*tmp), sizeof (n.type_instance));
640 return plugin_dispatch_notification (&n);
641 } /* static int pplugin_dispatch_notification (HV *) */
644 * Call all working functions of the given type.
646 static int pplugin_call_all (pTHX_ int type, ...)
655 if ((type < 0) || (type >= PLUGIN_TYPES))
665 XPUSHs (sv_2mortal (newSViv ((IV)type)));
667 if (PLUGIN_WRITE == type) {
669 * $_[0] = $plugin_type;
684 * values => [ $v1, ... ],
689 * plugin_instance => $instance,
690 * type_instance => $type_instance
699 ds = va_arg (ap, data_set_t *);
700 vl = va_arg (ap, value_list_t *);
702 if (-1 == data_set2av (aTHX_ ds, pds)) {
709 if (-1 == value_list2hv (aTHX_ vl, ds, pvl)) {
716 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
717 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
718 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
720 else if (PLUGIN_LOG == type) {
726 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
727 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
729 else if (PLUGIN_NOTIF == type) {
733 * severity => $severity,
739 * plugin_instance => $instance,
740 * type_instance => $type_instance
744 HV *notif = newHV ();
746 n = va_arg (ap, notification_t *);
748 if (-1 == notification2hv (aTHX_ n, notif)) {
755 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
760 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
775 } /* static int pplugin_call_all (int, ...) */
782 * Collectd::plugin_register_data_set (type, dataset).
785 * type of the dataset
788 * dataset to be registered
790 static XS (Collectd_plugin_register_ds)
798 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
802 log_debug ("Collectd::plugin_register_data_set: "
803 "type = \"%s\", dataset = \"%s\"",
804 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
808 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
809 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
813 log_err ("Collectd::plugin_register_data_set: Invalid data.");
821 } /* static XS (Collectd_plugin_register_ds) */
824 * Collectd::plugin_unregister_data_set (type).
827 * type of the dataset
829 static XS (Collectd_plugin_unregister_ds)
834 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
838 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
839 SvPV_nolen (ST (0)));
841 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (0))))
845 } /* static XS (Collectd_plugin_register_ds) */
848 * Collectd::plugin_dispatch_values (name, values).
854 * value list to submit
856 static XS (Collectd_plugin_dispatch_values)
866 log_warn ("Collectd::plugin_dispatch_values with two arguments "
867 "is deprecated - pass the type through values->{type}.");
870 else if (1 != items) {
871 log_err ("Usage: Collectd::plugin_dispatch_values(values)");
875 log_debug ("Collectd::plugin_dispatch_values: values=\"%s\"",
876 SvPV_nolen (ST (values_idx)));
878 values = ST (values_idx);
880 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
881 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
885 if (((2 == items) && (NULL == ST (0))) || (NULL == values))
888 if ((2 == items) && (NULL == hv_store ((HV *)SvRV (values), "type", 4,
889 newSVsv (ST (0)), 0))) {
890 log_err ("Collectd::plugin_dispatch_values: Could not store type.");
894 ret = pplugin_dispatch_values (aTHX_ (HV *)SvRV (values));
900 } /* static XS (Collectd_plugin_dispatch_values) */
903 * Collectd::plugin_dispatch_notification (notif).
906 * notification to dispatch
908 static XS (Collectd_plugin_dispatch_notification)
917 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
921 log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
922 SvPV_nolen (ST (0)));
926 if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
927 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
931 ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
937 } /* static XS (Collectd_plugin_dispatch_notification) */
940 * Collectd::plugin_log (level, message).
943 * log level (LOG_DEBUG, ... LOG_ERR)
948 static XS (Collectd_plugin_log)
953 log_err ("Usage: Collectd::plugin_log(level, message)");
957 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
959 } /* static XS (Collectd_plugin_log) */
962 * Collectd::call_by_name (...).
964 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
966 static XS (Collectd_call_by_name)
971 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
972 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
977 name = SvPV_nolen (tmp);
979 if (NULL == get_cv (name, 0)) {
980 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
985 /* simply pass on the subroutine call without touching the stack,
986 * thus leaving any arguments and return values in place */
988 } /* static XS (Collectd_call_by_name) */
991 * collectd's perl interpreter based thread implementation.
993 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
996 /* must be called with perl_threads->mutex locked */
997 static void c_ithread_destroy (c_ithread_t *ithread)
999 dTHXa (ithread->interp);
1001 assert (NULL != perl_threads);
1003 PERL_SET_CONTEXT (aTHX);
1004 log_debug ("Shutting down Perl interpreter %p...", aTHX);
1009 --perl_threads->number_of_threads;
1010 #endif /* COLLECT_DEBUG */
1012 perl_destruct (aTHX);
1015 if (NULL == ithread->prev)
1016 perl_threads->head = ithread->next;
1018 ithread->prev->next = ithread->next;
1020 if (NULL == ithread->next)
1021 perl_threads->tail = ithread->prev;
1023 ithread->next->prev = ithread->prev;
1027 } /* static void c_ithread_destroy (c_ithread_t *) */
1029 static void c_ithread_destructor (void *arg)
1031 c_ithread_t *ithread = (c_ithread_t *)arg;
1032 c_ithread_t *t = NULL;
1034 if (NULL == perl_threads)
1037 pthread_mutex_lock (&perl_threads->mutex);
1039 for (t = perl_threads->head; NULL != t; t = t->next)
1043 /* the ithread no longer exists */
1047 c_ithread_destroy (ithread);
1049 pthread_mutex_unlock (&perl_threads->mutex);
1051 } /* static void c_ithread_destructor (void *) */
1053 /* must be called with perl_threads->mutex locked */
1054 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
1056 c_ithread_t *t = NULL;
1059 assert (NULL != perl_threads);
1061 t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
1062 memset (t, 0, sizeof (c_ithread_t));
1064 t->interp = (NULL == base)
1066 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1071 av_clear (PL_endav);
1072 av_undef (PL_endav);
1077 ++perl_threads->number_of_threads;
1078 #endif /* COLLECT_DEBUG */
1082 if (NULL == perl_threads->tail) {
1083 perl_threads->head = t;
1087 perl_threads->tail->next = t;
1088 t->prev = perl_threads->tail;
1091 perl_threads->tail = t;
1093 pthread_setspecific (perl_thr_key, (const void *)t);
1095 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1098 * Interface to collectd.
1101 static int perl_init (void)
1105 if (NULL == perl_threads)
1109 c_ithread_t *t = NULL;
1111 pthread_mutex_lock (&perl_threads->mutex);
1112 t = c_ithread_create (perl_threads->head->interp);
1113 pthread_mutex_unlock (&perl_threads->mutex);
1118 log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
1119 aTHX, perl_threads->number_of_threads);
1120 return pplugin_call_all (aTHX_ PLUGIN_INIT);
1121 } /* static int perl_init (void) */
1123 static int perl_read (void)
1127 if (NULL == perl_threads)
1131 c_ithread_t *t = NULL;
1133 pthread_mutex_lock (&perl_threads->mutex);
1134 t = c_ithread_create (perl_threads->head->interp);
1135 pthread_mutex_unlock (&perl_threads->mutex);
1140 log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1141 aTHX, perl_threads->number_of_threads);
1142 return pplugin_call_all (aTHX_ PLUGIN_READ);
1143 } /* static int perl_read (void) */
1145 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1149 if (NULL == perl_threads)
1153 c_ithread_t *t = NULL;
1155 pthread_mutex_lock (&perl_threads->mutex);
1156 t = c_ithread_create (perl_threads->head->interp);
1157 pthread_mutex_unlock (&perl_threads->mutex);
1162 log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1163 aTHX, perl_threads->number_of_threads);
1164 return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1165 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1167 static void perl_log (int level, const char *msg)
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 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1186 } /* static void perl_log (int, const char *) */
1188 static int perl_notify (const notification_t *notif)
1192 if (NULL == perl_threads)
1196 c_ithread_t *t = NULL;
1198 pthread_mutex_lock (&perl_threads->mutex);
1199 t = c_ithread_create (perl_threads->head->interp);
1200 pthread_mutex_unlock (&perl_threads->mutex);
1204 return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1205 } /* static int perl_notify (const notification_t *) */
1207 static int perl_shutdown (void)
1209 c_ithread_t *t = NULL;
1215 plugin_unregister_complex_config ("perl");
1217 if (NULL == perl_threads)
1221 c_ithread_t *t = NULL;
1223 pthread_mutex_lock (&perl_threads->mutex);
1224 t = c_ithread_create (perl_threads->head->interp);
1225 pthread_mutex_unlock (&perl_threads->mutex);
1230 log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1231 aTHX, perl_threads->number_of_threads);
1233 plugin_unregister_log ("perl");
1234 plugin_unregister_notification ("perl");
1235 plugin_unregister_init ("perl");
1236 plugin_unregister_read ("perl");
1237 plugin_unregister_write ("perl");
1239 ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1241 pthread_mutex_lock (&perl_threads->mutex);
1242 t = perl_threads->tail;
1245 c_ithread_t *thr = t;
1247 /* the pointer has to be advanced before destroying
1248 * the thread as this will free the memory */
1251 c_ithread_destroy (thr);
1254 pthread_mutex_unlock (&perl_threads->mutex);
1255 pthread_mutex_destroy (&perl_threads->mutex);
1257 sfree (perl_threads);
1259 pthread_key_delete (perl_thr_key);
1263 plugin_unregister_shutdown ("perl");
1265 } /* static void perl_shutdown (void) */
1268 * Access functions for global variables.
1270 * These functions implement the "magic" used to access
1271 * the global variables from Perl.
1274 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1276 char *pv = mg->mg_ptr;
1279 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1281 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1283 char *pv = mg->mg_ptr;
1284 sstrncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1286 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1288 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1290 int *iv = (int *)mg->mg_ptr;
1291 sv_setiv (var, *iv);
1293 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1295 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1297 int *iv = (int *)mg->mg_ptr;
1298 *iv = (int)SvIV (var);
1300 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1302 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1303 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1305 /* bootstrap the Collectd module */
1306 static void xs_init (pTHX)
1310 char *file = __FILE__;
1316 /* enable usage of Perl modules using shared libraries */
1317 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1320 for (i = 0; NULL != api[i].f; ++i)
1321 newXS (api[i].name, api[i].f, file);
1323 stash = gv_stashpv ("Collectd", 1);
1325 /* export "constants" */
1326 for (i = 0; '\0' != constants[i].name[0]; ++i)
1327 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1329 /* export global variables
1330 * by adding "magic" to the SV's representing the globale variables
1331 * perl is able to automagically call the get/set function when
1332 * accessing any such variable (this is basically the same as using
1334 /* global strings */
1335 for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1336 tmp = get_sv (g_strings[i].name, 1);
1337 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1338 g_strings[i].var, 0);
1341 /* global integers */
1342 for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1343 tmp = get_sv (g_integers[i].name, 1);
1344 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1345 (char *)g_integers[i].var, 0);
1348 } /* static void xs_init (pTHX) */
1350 /* Initialize the global Perl interpreter. */
1351 static int init_pi (int argc, char **argv)
1355 if (NULL != perl_threads)
1358 log_info ("Initializing Perl interpreter...");
1363 for (i = 0; i < argc; ++i)
1364 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1366 #endif /* COLLECT_DEBUG */
1368 if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1369 log_err ("init_pi: pthread_key_create failed");
1371 /* this must not happen - cowardly giving up if it does */
1375 PERL_SYS_INIT3 (&argc, &argv, &environ);
1377 perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1378 memset (perl_threads, 0, sizeof (c_ithread_list_t));
1380 pthread_mutex_init (&perl_threads->mutex, NULL);
1381 /* locking the mutex should not be necessary at this point
1382 * but let's just do it for the sake of completeness */
1383 pthread_mutex_lock (&perl_threads->mutex);
1385 perl_threads->head = c_ithread_create (NULL);
1386 perl_threads->tail = perl_threads->head;
1388 if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1389 log_err ("init_pi: Not enough memory.");
1393 aTHX = perl_threads->head->interp;
1394 pthread_mutex_unlock (&perl_threads->mutex);
1396 perl_construct (aTHX);
1398 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1400 if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1401 log_err ("init_pi: Unable to bootstrap Collectd.");
1405 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1406 sv_setpv (get_sv ("0", 0), "collectd");
1410 plugin_register_log ("perl", perl_log);
1411 plugin_register_notification ("perl", perl_notify);
1412 plugin_register_init ("perl", perl_init);
1414 plugin_register_read ("perl", perl_read);
1416 plugin_register_write ("perl", perl_write);
1417 plugin_register_shutdown ("perl", perl_shutdown);
1419 } /* static int init_pi (const char **, const int) */
1422 * LoadPlugin "<Plugin>"
1424 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1426 char module_name[DATA_MAX_NAME_LEN];
1430 if ((0 != ci->children_num) || (1 != ci->values_num)
1431 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1432 log_err ("LoadPlugin expects a single string argument.");
1436 value = ci->values[0].value.string;
1438 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1439 log_err ("Invalid module name %s", value);
1443 init_pi (perl_argc, perl_argv);
1444 assert (NULL != perl_threads);
1445 assert (NULL != perl_threads->head);
1447 aTHX = perl_threads->head->interp;
1449 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1450 load_module (PERL_LOADMOD_NOIMPORT,
1451 newSVpv (module_name, strlen (module_name)), Nullsv);
1453 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1458 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1462 if ((0 != ci->children_num) || (1 != ci->values_num)
1463 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1464 log_err ("BaseName expects a single string argument.");
1468 value = ci->values[0].value.string;
1470 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1471 sstrncpy (base_name, value, sizeof (base_name));
1473 } /* static int perl_config_basename (oconfig_item_it *) */
1476 * EnableDebugger "<Package>"|""
1478 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1482 if ((0 != ci->children_num) || (1 != ci->values_num)
1483 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1484 log_err ("EnableDebugger expects a single string argument.");
1488 if (NULL != perl_threads) {
1489 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
1493 value = ci->values[0].value.string;
1495 perl_argv = (char **)realloc (perl_argv,
1496 (++perl_argc + 1) * sizeof (char *));
1498 if (NULL == perl_argv) {
1499 log_err ("perl_config: Not enough memory.");
1503 if ('\0' == value[0]) {
1504 perl_argv[perl_argc - 1] = "-d";
1507 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1508 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1509 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1512 perl_argv[perl_argc] = NULL;
1514 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1517 * IncludeDir "<Dir>"
1519 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1523 if ((0 != ci->children_num) || (1 != ci->values_num)
1524 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1525 log_err ("IncludeDir expects a single string argument.");
1529 value = ci->values[0].value.string;
1532 perl_argv = (char **)realloc (perl_argv,
1533 (++perl_argc + 1) * sizeof (char *));
1535 if (NULL == perl_argv) {
1536 log_err ("perl_config: Not enough memory.");
1540 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1541 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1542 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1544 perl_argv[perl_argc] = NULL;
1547 /* prepend the directory to @INC */
1548 av_unshift (GvAVn (PL_incgv), 1);
1549 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1552 } /* static int perl_config_includedir (oconfig_item_it *) */
1554 static int perl_config (oconfig_item_t *ci)
1560 /* dTHX does not get any valid values in case Perl
1561 * has not been initialized */
1562 if (NULL == perl_threads)
1565 for (i = 0; i < ci->children_num; ++i) {
1566 oconfig_item_t *c = ci->children + i;
1568 if (0 == strcasecmp (c->key, "LoadPlugin"))
1569 perl_config_loadplugin (aTHX_ c);
1570 else if (0 == strcasecmp (c->key, "BaseName"))
1571 perl_config_basename (aTHX_ c);
1572 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1573 perl_config_enabledebugger (aTHX_ c);
1574 else if (0 == strcasecmp (c->key, "IncludeDir"))
1575 perl_config_includedir (aTHX_ c);
1577 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1580 } /* static int perl_config (oconfig_item_t *) */
1582 void module_register (void)
1585 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1587 /* default options for the Perl interpreter */
1589 perl_argv[1] = "-MCollectd";
1590 perl_argv[2] = "-e";
1592 perl_argv[4] = NULL;
1594 plugin_register_complex_config ("perl", perl_config);
1596 } /* void module_register (void) */
1598 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */