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 strncpy (ds->name, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
208 ds->name[DATA_MAX_NAME_LEN - 1] = '\0';
211 log_err ("hv2data_source: No DS name given.");
215 if (NULL != (tmp = hv_fetch (hash, "type", 4, 0))) {
216 ds->type = SvIV (*tmp);
218 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
219 log_err ("hv2data_source: Invalid DS type.");
224 ds->type = DS_TYPE_COUNTER;
227 if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
228 ds->min = SvNV (*tmp);
232 if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
233 ds->max = SvNV (*tmp);
237 } /* static data_source_t *hv2data_source (HV *) */
239 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
241 const data_set_t *ds;
245 if ((NULL == name) || (NULL == array) || (NULL == value))
248 if (av_len (array) < len - 1)
249 len = av_len (array) + 1;
254 ds = plugin_get_ds (name);
256 log_err ("av2value: Unknown dataset \"%s\"", name);
260 if (ds->ds_num < len) {
261 log_warn ("av2value: Value length exceeds data set length.");
265 for (i = 0; i < len; ++i) {
266 SV **tmp = av_fetch (array, i, 0);
269 if (DS_TYPE_COUNTER == ds->ds[i].type)
270 value[i].counter = SvIV (*tmp);
272 value[i].gauge = SvNV (*tmp);
279 } /* static int av2value (char *, AV *, value_t *, int) */
281 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
285 if ((NULL == ds) || (NULL == array))
288 av_extend (array, ds->ds_num);
290 for (i = 0; i < ds->ds_num; ++i) {
291 HV *source = newHV ();
293 if (NULL == hv_store (source, "name", 4,
294 newSVpv (ds->ds[i].name, 0), 0))
297 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
300 if (! isnan (ds->ds[i].min))
301 if (NULL == hv_store (source, "min", 3,
302 newSVnv (ds->ds[i].min), 0))
305 if (! isnan (ds->ds[i].max))
306 if (NULL == hv_store (source, "max", 3,
307 newSVnv (ds->ds[i].max), 0))
310 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
314 } /* static int data_set2av (data_set_t *, AV *) */
316 static int value_list2hv (pTHX_ value_list_t *vl, data_set_t *ds, HV *hash)
323 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
326 len = vl->values_len;
328 if (ds->ds_num < len) {
329 log_warn ("value2av: Value length exceeds data set length.");
334 av_extend (values, len - 1);
336 for (i = 0; i < len; ++i) {
339 if (DS_TYPE_COUNTER == ds->ds[i].type)
340 val = newSViv (vl->values[i].counter);
342 val = newSVnv (vl->values[i].gauge);
344 if (NULL == av_store (values, i, val)) {
350 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
354 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
357 if ('\0' != vl->host[0])
358 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
361 if ('\0' != vl->plugin[0])
362 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
365 if ('\0' != vl->plugin_instance[0])
366 if (NULL == hv_store (hash, "plugin_instance", 15,
367 newSVpv (vl->plugin_instance, 0), 0))
370 if ('\0' != vl->type_instance[0])
371 if (NULL == hv_store (hash, "type_instance", 13,
372 newSVpv (vl->type_instance, 0), 0))
375 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
377 static int notification2hv (pTHX_ notification_t *n, HV *hash)
379 if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
383 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
386 if ('\0' != *n->message)
387 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
390 if ('\0' != *n->host)
391 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
394 if ('\0' != *n->plugin)
395 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
398 if ('\0' != *n->plugin_instance)
399 if (NULL == hv_store (hash, "plugin_instance", 15,
400 newSVpv (n->plugin_instance, 0), 0))
403 if ('\0' != *n->type)
404 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
407 if ('\0' != *n->type_instance)
408 if (NULL == hv_store (hash, "type_instance", 13,
409 newSVpv (n->type_instance, 0), 0))
412 } /* static int notification2hv (notification_t *, HV *) */
415 * Internal functions.
418 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
420 if (base_name[0] == '\0')
421 status = snprintf (buf, buf_len, "%s", module);
423 status = snprintf (buf, buf_len, "%s::%s", base_name, module);
424 if ((status < 0) || ((unsigned int)status >= buf_len))
426 buf[buf_len - 1] = '\0';
428 } /* char *get_module_name */
431 * Add a plugin's data set definition.
433 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
439 data_source_t *ds = NULL;
440 data_set_t *set = NULL;
442 if ((NULL == name) || (NULL == dataset))
445 len = av_len (dataset);
450 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
451 set = (data_set_t *)smalloc (sizeof (data_set_t));
453 for (i = 0; i <= len; ++i) {
454 SV **elem = av_fetch (dataset, i, 0);
459 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
460 log_err ("pplugin_register_data_set: Invalid data source.");
464 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
467 log_debug ("pplugin_register_data_set: "
468 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
469 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
472 strncpy (set->type, name, DATA_MAX_NAME_LEN);
473 set->type[DATA_MAX_NAME_LEN - 1] = '\0';
475 set->ds_num = len + 1;
478 ret = plugin_register_data_set (set);
483 } /* static int pplugin_register_data_set (char *, SV *) */
486 * Remove a plugin's data set definition.
488 static int pplugin_unregister_data_set (char *name)
492 return plugin_unregister_data_set (name);
493 } /* static int pplugin_unregister_data_set (char *) */
496 * Submit the values to the write functions.
500 * values => [ @values ],
504 * plugin_instance => $pinstance,
505 * type_instance => $tinstance,
508 static int pplugin_dispatch_values (pTHX_ char *name, HV *values)
510 value_list_t list = VALUE_LIST_INIT;
517 if ((NULL == name) || (NULL == values))
520 if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
521 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
522 log_err ("pplugin_dispatch_values: No valid values given.");
527 AV *array = (AV *)SvRV (*tmp);
528 int len = av_len (array) + 1;
533 val = (value_t *)smalloc (len * sizeof (value_t));
535 list.values_len = av2value (aTHX_ name, (AV *)SvRV (*tmp), val, len);
538 if (-1 == list.values_len) {
544 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
545 list.time = (time_t)SvIV (*tmp);
548 list.time = time (NULL);
551 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
552 strncpy (list.host, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
553 list.host[DATA_MAX_NAME_LEN - 1] = '\0';
556 strcpy (list.host, hostname_g);
559 if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0))) {
560 strncpy (list.plugin, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
561 list.plugin[DATA_MAX_NAME_LEN - 1] = '\0';
564 if (NULL != (tmp = hv_fetch (values, "plugin_instance", 15, 0))) {
565 strncpy (list.plugin_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
566 list.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
569 if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0))) {
570 strncpy (list.type_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
571 list.type_instance[DATA_MAX_NAME_LEN - 1] = '\0';
574 ret = plugin_dispatch_values (name, &list);
578 } /* static int pplugin_dispatch_values (char *, HV *) */
581 * Dispatch a notification.
585 * severity => $severity,
591 * plugin_instance => $instance,
592 * type_instance => $type_instance
595 static int pplugin_dispatch_notification (pTHX_ HV *notif)
604 memset (&n, 0, sizeof (n));
606 if (NULL != (tmp = hv_fetch (notif, "severity", 8, 0)))
607 n.severity = SvIV (*tmp);
609 n.severity = NOTIF_FAILURE;
611 if (NULL != (tmp = hv_fetch (notif, "time", 4, 0)))
612 n.time = (time_t)SvIV (*tmp);
614 n.time = time (NULL);
616 if (NULL != (tmp = hv_fetch (notif, "message", 7, 0)))
617 strncpy (n.message, SvPV_nolen (*tmp), sizeof (n.message));
618 n.message[sizeof (n.message) - 1] = '\0';
620 if (NULL != (tmp = hv_fetch (notif, "host", 4, 0)))
621 strncpy (n.host, SvPV_nolen (*tmp), sizeof (n.host));
623 strncpy (n.host, hostname_g, sizeof (n.host));
624 n.host[sizeof (n.host) - 1] = '\0';
626 if (NULL != (tmp = hv_fetch (notif, "plugin", 6, 0)))
627 strncpy (n.plugin, SvPV_nolen (*tmp), sizeof (n.plugin));
628 n.plugin[sizeof (n.plugin) - 1] = '\0';
630 if (NULL != (tmp = hv_fetch (notif, "plugin_instance", 15, 0)))
631 strncpy (n.plugin_instance, SvPV_nolen (*tmp),
632 sizeof (n.plugin_instance));
633 n.plugin_instance[sizeof (n.plugin_instance) - 1] = '\0';
635 if (NULL != (tmp = hv_fetch (notif, "type", 4, 0)))
636 strncpy (n.type, SvPV_nolen (*tmp), sizeof (n.type));
637 n.type[sizeof (n.type) - 1] = '\0';
639 if (NULL != (tmp = hv_fetch (notif, "type_instance", 13, 0)))
640 strncpy (n.type_instance, SvPV_nolen (*tmp), sizeof (n.type_instance));
641 n.type_instance[sizeof (n.type_instance) - 1] = '\0';
642 return plugin_dispatch_notification (&n);
643 } /* static int pplugin_dispatch_notification (HV *) */
646 * Call all working functions of the given type.
648 static int pplugin_call_all (pTHX_ int type, ...)
657 if ((type < 0) || (type >= PLUGIN_TYPES))
667 XPUSHs (sv_2mortal (newSViv ((IV)type)));
669 if (PLUGIN_WRITE == type) {
671 * $_[0] = $plugin_type;
686 * values => [ $v1, ... ],
690 * plugin_instance => $instance,
691 * type_instance => $type_instance
700 ds = va_arg (ap, data_set_t *);
701 vl = va_arg (ap, value_list_t *);
703 if (-1 == data_set2av (aTHX_ ds, pds)) {
710 if (-1 == value_list2hv (aTHX_ vl, ds, pvl)) {
717 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
718 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
719 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
721 else if (PLUGIN_LOG == type) {
727 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
728 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
730 else if (PLUGIN_NOTIF == type) {
734 * severity => $severity,
740 * plugin_instance => $instance,
741 * type_instance => $type_instance
745 HV *notif = newHV ();
747 n = va_arg (ap, notification_t *);
749 if (-1 == notification2hv (aTHX_ n, notif)) {
756 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
761 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
776 } /* static int pplugin_call_all (int, ...) */
783 * Collectd::plugin_register_data_set (type, dataset).
786 * type of the dataset
789 * dataset to be registered
791 static XS (Collectd_plugin_register_ds)
799 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
803 log_debug ("Collectd::plugin_register_data_set: "
804 "type = \"%s\", dataset = \"%s\"",
805 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
809 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
810 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
814 log_err ("Collectd::plugin_register_data_set: Invalid data.");
822 } /* static XS (Collectd_plugin_register_ds) */
825 * Collectd::plugin_unregister_data_set (type).
828 * type of the dataset
830 static XS (Collectd_plugin_unregister_ds)
835 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
839 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
840 SvPV_nolen (ST (0)));
842 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (0))))
846 } /* static XS (Collectd_plugin_register_ds) */
849 * Collectd::plugin_dispatch_values (name, values).
855 * value list to submit
857 static XS (Collectd_plugin_dispatch_values)
866 log_err ("Usage: Collectd::plugin_dispatch_values(name, values)");
870 log_debug ("Collectd::plugin_dispatch_values: "
871 "name = \"%s\", values=\"%s\"",
872 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
876 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
877 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
881 if ((NULL == ST (0)) || (NULL == values))
884 ret = pplugin_dispatch_values (aTHX_ SvPV_nolen (ST (0)),
885 (HV *)SvRV (values));
891 } /* static XS (Collectd_plugin_dispatch_values) */
894 * Collectd::plugin_dispatch_notification (notif).
897 * notification to dispatch
899 static XS (Collectd_plugin_dispatch_notification)
908 log_err ("Usage: Collectd::plugin_dispatch_notification(notif)");
912 log_debug ("Collectd::plugin_dispatch_notification: notif = \"%s\"",
913 SvPV_nolen (ST (0)));
917 if (! (SvROK (notif) && (SVt_PVHV == SvTYPE (SvRV (notif))))) {
918 log_err ("Collectd::plugin_dispatch_notification: Invalid notif.");
922 ret = pplugin_dispatch_notification (aTHX_ (HV *)SvRV (notif));
928 } /* static XS (Collectd_plugin_dispatch_notification) */
931 * Collectd::plugin_log (level, message).
934 * log level (LOG_DEBUG, ... LOG_ERR)
939 static XS (Collectd_plugin_log)
944 log_err ("Usage: Collectd::plugin_log(level, message)");
948 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
950 } /* static XS (Collectd_plugin_log) */
953 * Collectd::call_by_name (...).
955 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
957 static XS (Collectd_call_by_name)
962 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
963 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
968 name = SvPV_nolen (tmp);
970 if (NULL == get_cv (name, 0)) {
971 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
976 /* simply pass on the subroutine call without touching the stack,
977 * thus leaving any arguments and return values in place */
979 } /* static XS (Collectd_call_by_name) */
982 * collectd's perl interpreter based thread implementation.
984 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
987 /* must be called with perl_threads->mutex locked */
988 static void c_ithread_destroy (c_ithread_t *ithread)
990 dTHXa (ithread->interp);
992 assert (NULL != perl_threads);
994 PERL_SET_CONTEXT (aTHX);
995 log_debug ("Shutting down Perl interpreter %p...", aTHX);
1000 --perl_threads->number_of_threads;
1001 #endif /* COLLECT_DEBUG */
1003 perl_destruct (aTHX);
1006 if (NULL == ithread->prev)
1007 perl_threads->head = ithread->next;
1009 ithread->prev->next = ithread->next;
1011 if (NULL == ithread->next)
1012 perl_threads->tail = ithread->prev;
1014 ithread->next->prev = ithread->prev;
1018 } /* static void c_ithread_destroy (c_ithread_t *) */
1020 static void c_ithread_destructor (void *arg)
1022 c_ithread_t *ithread = (c_ithread_t *)arg;
1023 c_ithread_t *t = NULL;
1025 if (NULL == perl_threads)
1028 pthread_mutex_lock (&perl_threads->mutex);
1030 for (t = perl_threads->head; NULL != t; t = t->next)
1034 /* the ithread no longer exists */
1038 c_ithread_destroy (ithread);
1040 pthread_mutex_unlock (&perl_threads->mutex);
1042 } /* static void c_ithread_destructor (void *) */
1044 /* must be called with perl_threads->mutex locked */
1045 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
1047 c_ithread_t *t = NULL;
1050 assert (NULL != perl_threads);
1052 t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
1053 memset (t, 0, sizeof (c_ithread_t));
1055 t->interp = (NULL == base)
1057 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
1062 av_clear (PL_endav);
1063 av_undef (PL_endav);
1068 ++perl_threads->number_of_threads;
1069 #endif /* COLLECT_DEBUG */
1073 if (NULL == perl_threads->tail) {
1074 perl_threads->head = t;
1078 perl_threads->tail->next = t;
1079 t->prev = perl_threads->tail;
1082 perl_threads->tail = t;
1084 pthread_setspecific (perl_thr_key, (const void *)t);
1086 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
1089 * Interface to collectd.
1092 static int perl_init (void)
1096 if (NULL == perl_threads)
1100 c_ithread_t *t = NULL;
1102 pthread_mutex_lock (&perl_threads->mutex);
1103 t = c_ithread_create (perl_threads->head->interp);
1104 pthread_mutex_unlock (&perl_threads->mutex);
1109 log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
1110 aTHX, perl_threads->number_of_threads);
1111 return pplugin_call_all (aTHX_ PLUGIN_INIT);
1112 } /* static int perl_init (void) */
1114 static int perl_read (void)
1118 if (NULL == perl_threads)
1122 c_ithread_t *t = NULL;
1124 pthread_mutex_lock (&perl_threads->mutex);
1125 t = c_ithread_create (perl_threads->head->interp);
1126 pthread_mutex_unlock (&perl_threads->mutex);
1131 log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1132 aTHX, perl_threads->number_of_threads);
1133 return pplugin_call_all (aTHX_ PLUGIN_READ);
1134 } /* static int perl_read (void) */
1136 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1140 if (NULL == perl_threads)
1144 c_ithread_t *t = NULL;
1146 pthread_mutex_lock (&perl_threads->mutex);
1147 t = c_ithread_create (perl_threads->head->interp);
1148 pthread_mutex_unlock (&perl_threads->mutex);
1153 log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1154 aTHX, perl_threads->number_of_threads);
1155 return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1156 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1158 static void perl_log (int level, const char *msg)
1162 if (NULL == perl_threads)
1166 c_ithread_t *t = NULL;
1168 pthread_mutex_lock (&perl_threads->mutex);
1169 t = c_ithread_create (perl_threads->head->interp);
1170 pthread_mutex_unlock (&perl_threads->mutex);
1175 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1177 } /* static void perl_log (int, const char *) */
1179 static int perl_notify (const notification_t *notif)
1183 if (NULL == perl_threads)
1187 c_ithread_t *t = NULL;
1189 pthread_mutex_lock (&perl_threads->mutex);
1190 t = c_ithread_create (perl_threads->head->interp);
1191 pthread_mutex_unlock (&perl_threads->mutex);
1195 return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1196 } /* static int perl_notify (const notification_t *) */
1198 static int perl_shutdown (void)
1200 c_ithread_t *t = NULL;
1206 plugin_unregister_complex_config ("perl");
1208 if (NULL == perl_threads)
1212 c_ithread_t *t = NULL;
1214 pthread_mutex_lock (&perl_threads->mutex);
1215 t = c_ithread_create (perl_threads->head->interp);
1216 pthread_mutex_unlock (&perl_threads->mutex);
1221 log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1222 aTHX, perl_threads->number_of_threads);
1224 plugin_unregister_log ("perl");
1225 plugin_unregister_notification ("perl");
1226 plugin_unregister_init ("perl");
1227 plugin_unregister_read ("perl");
1228 plugin_unregister_write ("perl");
1230 ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1232 pthread_mutex_lock (&perl_threads->mutex);
1233 t = perl_threads->tail;
1236 c_ithread_t *thr = t;
1238 /* the pointer has to be advanced before destroying
1239 * the thread as this will free the memory */
1242 c_ithread_destroy (thr);
1245 pthread_mutex_unlock (&perl_threads->mutex);
1246 pthread_mutex_destroy (&perl_threads->mutex);
1248 sfree (perl_threads);
1250 pthread_key_delete (perl_thr_key);
1254 plugin_unregister_shutdown ("perl");
1256 } /* static void perl_shutdown (void) */
1259 * Access functions for global variables.
1261 * These functions implement the "magic" used to access
1262 * the global variables from Perl.
1265 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1267 char *pv = mg->mg_ptr;
1270 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1272 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1274 char *pv = mg->mg_ptr;
1275 strncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1276 pv[DATA_MAX_NAME_LEN - 1] = '\0';
1278 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1280 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1282 int *iv = (int *)mg->mg_ptr;
1283 sv_setiv (var, *iv);
1285 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1287 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1289 int *iv = (int *)mg->mg_ptr;
1290 *iv = (int)SvIV (var);
1292 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1294 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1295 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1297 /* bootstrap the Collectd module */
1298 static void xs_init (pTHX)
1302 char *file = __FILE__;
1308 /* enable usage of Perl modules using shared libraries */
1309 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1312 for (i = 0; NULL != api[i].f; ++i)
1313 newXS (api[i].name, api[i].f, file);
1315 stash = gv_stashpv ("Collectd", 1);
1317 /* export "constants" */
1318 for (i = 0; '\0' != constants[i].name[0]; ++i)
1319 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1321 /* export global variables
1322 * by adding "magic" to the SV's representing the globale variables
1323 * perl is able to automagically call the get/set function when
1324 * accessing any such variable (this is basically the same as using
1326 /* global strings */
1327 for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1328 tmp = get_sv (g_strings[i].name, 1);
1329 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1330 g_strings[i].var, 0);
1333 /* global integers */
1334 for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1335 tmp = get_sv (g_integers[i].name, 1);
1336 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1337 (char *)g_integers[i].var, 0);
1340 } /* static void xs_init (pTHX) */
1342 /* Initialize the global Perl interpreter. */
1343 static int init_pi (int argc, char **argv)
1347 if (NULL != perl_threads)
1350 log_info ("Initializing Perl interpreter...");
1355 for (i = 0; i < argc; ++i)
1356 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1358 #endif /* COLLECT_DEBUG */
1360 if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1361 log_err ("init_pi: pthread_key_create failed");
1363 /* this must not happen - cowardly giving up if it does */
1368 /* On FreeBSD, PERL_SYS_INIT3 expands to some expression which
1369 * triggers a "value computed is not used" warning by gcc. */
1372 PERL_SYS_INIT3 (&argc, &argv, &environ);
1374 perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1375 memset (perl_threads, 0, sizeof (c_ithread_list_t));
1377 pthread_mutex_init (&perl_threads->mutex, NULL);
1378 /* locking the mutex should not be necessary at this point
1379 * but let's just do it for the sake of completeness */
1380 pthread_mutex_lock (&perl_threads->mutex);
1382 perl_threads->head = c_ithread_create (NULL);
1383 perl_threads->tail = perl_threads->head;
1385 if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1386 log_err ("init_pi: Not enough memory.");
1390 aTHX = perl_threads->head->interp;
1391 pthread_mutex_unlock (&perl_threads->mutex);
1393 perl_construct (aTHX);
1395 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1397 if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1398 log_err ("init_pi: Unable to bootstrap Collectd.");
1402 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1403 sv_setpv (get_sv ("0", 0), "collectd");
1407 plugin_register_log ("perl", perl_log);
1408 plugin_register_notification ("perl", perl_notify);
1409 plugin_register_init ("perl", perl_init);
1411 plugin_register_read ("perl", perl_read);
1413 plugin_register_write ("perl", perl_write);
1414 plugin_register_shutdown ("perl", perl_shutdown);
1416 } /* static int init_pi (const char **, const int) */
1419 * LoadPlugin "<Plugin>"
1421 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1423 char module_name[DATA_MAX_NAME_LEN];
1427 if ((0 != ci->children_num) || (1 != ci->values_num)
1428 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1429 log_err ("LoadPlugin expects a single string argument.");
1433 value = ci->values[0].value.string;
1435 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1436 log_err ("Invalid module name %s", value);
1440 init_pi (perl_argc, perl_argv);
1441 assert (NULL != perl_threads);
1442 assert (NULL != perl_threads->head);
1444 aTHX = perl_threads->head->interp;
1446 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1447 load_module (PERL_LOADMOD_NOIMPORT,
1448 newSVpv (module_name, strlen (module_name)), Nullsv);
1450 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1455 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1459 if ((0 != ci->children_num) || (1 != ci->values_num)
1460 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1461 log_err ("BaseName expects a single string argument.");
1465 value = ci->values[0].value.string;
1467 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1468 strncpy (base_name, value, sizeof (base_name));
1469 base_name[sizeof (base_name) - 1] = '\0';
1471 } /* static int perl_config_basename (oconfig_item_it *) */
1474 * EnableDebugger "<Package>"|""
1476 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1480 if ((0 != ci->children_num) || (1 != ci->values_num)
1481 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1482 log_err ("EnableDebugger expects a single string argument.");
1486 if (NULL != perl_threads) {
1487 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
1491 value = ci->values[0].value.string;
1493 perl_argv = (char **)realloc (perl_argv,
1494 (++perl_argc + 1) * sizeof (char *));
1496 if (NULL == perl_argv) {
1497 log_err ("perl_config: Not enough memory.");
1501 if ('\0' == value[0]) {
1502 perl_argv[perl_argc - 1] = "-d";
1505 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1506 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1507 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1510 perl_argv[perl_argc] = NULL;
1512 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1515 * IncludeDir "<Dir>"
1517 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1521 if ((0 != ci->children_num) || (1 != ci->values_num)
1522 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1523 log_err ("IncludeDir expects a single string argument.");
1527 value = ci->values[0].value.string;
1530 perl_argv = (char **)realloc (perl_argv,
1531 (++perl_argc + 1) * sizeof (char *));
1533 if (NULL == perl_argv) {
1534 log_err ("perl_config: Not enough memory.");
1538 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1539 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1540 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1542 perl_argv[perl_argc] = NULL;
1545 /* prepend the directory to @INC */
1546 av_unshift (GvAVn (PL_incgv), 1);
1547 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1550 } /* static int perl_config_includedir (oconfig_item_it *) */
1552 static int perl_config (oconfig_item_t *ci)
1558 /* dTHX does not get any valid values in case Perl
1559 * has not been initialized */
1560 if (NULL == perl_threads)
1563 for (i = 0; i < ci->children_num; ++i) {
1564 oconfig_item_t *c = ci->children + i;
1566 if (0 == strcasecmp (c->key, "LoadPlugin"))
1567 perl_config_loadplugin (aTHX_ c);
1568 else if (0 == strcasecmp (c->key, "BaseName"))
1569 perl_config_basename (aTHX_ c);
1570 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1571 perl_config_enabledebugger (aTHX_ c);
1572 else if (0 == strcasecmp (c->key, "IncludeDir"))
1573 perl_config_includedir (aTHX_ c);
1575 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1578 } /* static int perl_config (oconfig_item_t *) */
1580 void module_register (void)
1583 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1585 /* default options for the Perl interpreter */
1587 perl_argv[1] = "-MCollectd";
1588 perl_argv[2] = "-e";
1590 perl_argv[4] = NULL;
1592 plugin_register_complex_config ("perl", perl_config);
1594 } /* void module_register (void) */
1596 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */