2 * collectd - src/perl.c
3 * Copyright (C) 2007 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_log);
81 static XS (Collectd_call_by_name);
87 typedef struct c_ithread_s {
88 /* the thread's Perl interpreter */
89 PerlInterpreter *interp;
91 /* double linked list of threads */
92 struct c_ithread_s *prev;
93 struct c_ithread_s *next;
101 /* some usage stats */
102 int number_of_threads;
103 #endif /* COLLECT_DEBUG */
105 pthread_mutex_t mutex;
112 /* if perl_threads != NULL perl_threads->head must
113 * point to the "base" thread */
114 static c_ithread_list_t *perl_threads = NULL;
116 /* the key used to store each pthread's ithread */
117 static pthread_key_t perl_thr_key;
119 static int perl_argc = 0;
120 static char **perl_argv = NULL;
122 static char base_name[DATA_MAX_NAME_LEN] = "";
129 { "Collectd::plugin_register_data_set", Collectd_plugin_register_ds },
130 { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
131 { "Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values },
132 { "Collectd::plugin_log", Collectd_plugin_log },
133 { "Collectd::call_by_name", Collectd_call_by_name },
142 { "Collectd::TYPE_INIT", PLUGIN_INIT },
143 { "Collectd::TYPE_READ", PLUGIN_READ },
144 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
145 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
146 { "Collectd::TYPE_LOG", PLUGIN_LOG },
147 { "Collectd::TYPE_NOTIF", PLUGIN_NOTIF },
148 { "Collectd::TYPE_DATASET", PLUGIN_DATASET },
149 { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
150 { "Collectd::DS_TYPE_GAUGE", DS_TYPE_GAUGE },
151 { "Collectd::LOG_ERR", LOG_ERR },
152 { "Collectd::LOG_WARNING", LOG_WARNING },
153 { "Collectd::LOG_NOTICE", LOG_NOTICE },
154 { "Collectd::LOG_INFO", LOG_INFO },
155 { "Collectd::LOG_DEBUG", LOG_DEBUG },
156 { "Collectd::NOTIF_FAILURE", NOTIF_FAILURE },
157 { "Collectd::NOTIF_WARNING", NOTIF_WARNING },
158 { "Collectd::NOTIF_OKAY", NOTIF_OKAY },
167 { "Collectd::hostname_g", hostname_g },
176 { "Collectd::interval_g", &interval_g },
181 * Helper functions for data type conversion.
196 static int hv2data_source (pTHX_ HV *hash, data_source_t *ds)
200 if ((NULL == hash) || (NULL == ds))
203 if (NULL != (tmp = hv_fetch (hash, "name", 4, 0))) {
204 strncpy (ds->name, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
205 ds->name[DATA_MAX_NAME_LEN - 1] = '\0';
208 log_err ("hv2data_source: No DS name given.");
212 if (NULL != (tmp = hv_fetch (hash, "type", 4, 0))) {
213 ds->type = SvIV (*tmp);
215 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
216 log_err ("hv2data_source: Invalid DS type.");
221 ds->type = DS_TYPE_COUNTER;
224 if (NULL != (tmp = hv_fetch (hash, "min", 3, 0)))
225 ds->min = SvNV (*tmp);
229 if (NULL != (tmp = hv_fetch (hash, "max", 3, 0)))
230 ds->max = SvNV (*tmp);
234 } /* static data_source_t *hv2data_source (HV *) */
236 static int av2value (pTHX_ char *name, AV *array, value_t *value, int len)
238 const data_set_t *ds;
242 if ((NULL == name) || (NULL == array) || (NULL == value))
245 if (av_len (array) < len - 1)
246 len = av_len (array) + 1;
251 ds = plugin_get_ds (name);
253 log_err ("av2value: Unknown dataset \"%s\"", name);
257 if (ds->ds_num < len) {
258 log_warn ("av2value: Value length exceeds data set length.");
262 for (i = 0; i < len; ++i) {
263 SV **tmp = av_fetch (array, i, 0);
266 if (DS_TYPE_COUNTER == ds->ds[i].type)
267 value[i].counter = SvIV (*tmp);
269 value[i].gauge = SvNV (*tmp);
276 } /* static int av2value (char *, AV *, value_t *, int) */
278 static int data_set2av (pTHX_ data_set_t *ds, AV *array)
282 if ((NULL == ds) || (NULL == array))
285 av_extend (array, ds->ds_num);
287 for (i = 0; i < ds->ds_num; ++i) {
288 HV *source = newHV ();
290 if (NULL == hv_store (source, "name", 4,
291 newSVpv (ds->ds[i].name, 0), 0))
294 if (NULL == hv_store (source, "type", 4, newSViv (ds->ds[i].type), 0))
297 if (! isnan (ds->ds[i].min))
298 if (NULL == hv_store (source, "min", 3,
299 newSVnv (ds->ds[i].min), 0))
302 if (! isnan (ds->ds[i].max))
303 if (NULL == hv_store (source, "max", 3,
304 newSVnv (ds->ds[i].max), 0))
307 if (NULL == av_store (array, i, newRV_noinc ((SV *)source)))
311 } /* static int data_set2av (data_set_t *, AV *) */
313 static int value_list2hv (pTHX_ value_list_t *vl, data_set_t *ds, HV *hash)
320 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
323 len = vl->values_len;
325 if (ds->ds_num < len) {
326 log_warn ("value2av: Value length exceeds data set length.");
331 av_extend (values, len - 1);
333 for (i = 0; i < len; ++i) {
336 if (DS_TYPE_COUNTER == ds->ds[i].type)
337 val = newSViv (vl->values[i].counter);
339 val = newSVnv (vl->values[i].gauge);
341 if (NULL == av_store (values, i, val)) {
347 if (NULL == hv_store (hash, "values", 6, newRV_noinc ((SV *)values), 0))
351 if (NULL == hv_store (hash, "time", 4, newSViv (vl->time), 0))
354 if ('\0' != vl->host[0])
355 if (NULL == hv_store (hash, "host", 4, newSVpv (vl->host, 0), 0))
358 if ('\0' != vl->plugin[0])
359 if (NULL == hv_store (hash, "plugin", 6, newSVpv (vl->plugin, 0), 0))
362 if ('\0' != vl->plugin_instance[0])
363 if (NULL == hv_store (hash, "plugin_instance", 15,
364 newSVpv (vl->plugin_instance, 0), 0))
367 if ('\0' != vl->type_instance[0])
368 if (NULL == hv_store (hash, "type_instance", 13,
369 newSVpv (vl->type_instance, 0), 0))
372 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
374 static int notification2hv (pTHX_ notification_t *n, HV *hash)
376 if (NULL == hv_store (hash, "severity", 8, newSViv (n->severity), 0))
380 if (NULL == hv_store (hash, "time", 4, newSViv (n->time), 0))
383 if ('\0' != *n->message)
384 if (NULL == hv_store (hash, "message", 7, newSVpv (n->message, 0), 0))
387 if ('\0' != *n->host)
388 if (NULL == hv_store (hash, "host", 4, newSVpv (n->host, 0), 0))
391 if ('\0' != *n->plugin)
392 if (NULL == hv_store (hash, "plugin", 6, newSVpv (n->plugin, 0), 0))
395 if ('\0' != *n->plugin_instance)
396 if (NULL == hv_store (hash, "plugin_instance", 15,
397 newSVpv (n->plugin_instance, 0), 0))
400 if ('\0' != *n->type)
401 if (NULL == hv_store (hash, "type", 4, newSVpv (n->type, 0), 0))
404 if ('\0' != *n->type_instance)
405 if (NULL == hv_store (hash, "type_instance", 13,
406 newSVpv (n->type_instance, 0), 0))
409 } /* static int notification2hv (notification_t *, HV *) */
412 * Internal functions.
415 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
417 if (base_name[0] == '\0')
418 status = snprintf (buf, buf_len, "%s", module);
420 status = snprintf (buf, buf_len, "%s::%s", base_name, module);
421 if ((status < 0) || ((unsigned int)status >= buf_len))
423 buf[buf_len - 1] = '\0';
425 } /* char *get_module_name */
428 * Add a plugin's data set definition.
430 static int pplugin_register_data_set (pTHX_ char *name, AV *dataset)
436 data_source_t *ds = NULL;
437 data_set_t *set = NULL;
439 if ((NULL == name) || (NULL == dataset))
442 len = av_len (dataset);
447 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
448 set = (data_set_t *)smalloc (sizeof (data_set_t));
450 for (i = 0; i <= len; ++i) {
451 SV **elem = av_fetch (dataset, i, 0);
456 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
457 log_err ("pplugin_register_data_set: Invalid data source.");
461 if (-1 == hv2data_source (aTHX_ (HV *)SvRV (*elem), &ds[i]))
464 log_debug ("pplugin_register_data_set: "
465 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
466 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
469 strncpy (set->type, name, DATA_MAX_NAME_LEN);
470 set->type[DATA_MAX_NAME_LEN - 1] = '\0';
472 set->ds_num = len + 1;
475 ret = plugin_register_data_set (set);
480 } /* static int pplugin_register_data_set (char *, SV *) */
483 * Remove a plugin's data set definition.
485 static int pplugin_unregister_data_set (char *name)
489 return plugin_unregister_data_set (name);
490 } /* static int pplugin_unregister_data_set (char *) */
493 * Submit the values to the write functions.
497 * values => [ @values ],
501 * plugin_instance => $pinstance,
502 * type_instance => $tinstance,
505 static int pplugin_dispatch_values (pTHX_ char *name, HV *values)
507 value_list_t list = VALUE_LIST_INIT;
514 if ((NULL == name) || (NULL == values))
517 if ((NULL == (tmp = hv_fetch (values, "values", 6, 0)))
518 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
519 log_err ("pplugin_dispatch_values: No valid values given.");
524 AV *array = (AV *)SvRV (*tmp);
525 int len = av_len (array) + 1;
530 val = (value_t *)smalloc (len * sizeof (value_t));
532 list.values_len = av2value (aTHX_ name, (AV *)SvRV (*tmp), val, len);
535 if (-1 == list.values_len) {
541 if (NULL != (tmp = hv_fetch (values, "time", 4, 0))) {
542 list.time = (time_t)SvIV (*tmp);
545 list.time = time (NULL);
548 if (NULL != (tmp = hv_fetch (values, "host", 4, 0))) {
549 strncpy (list.host, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
550 list.host[DATA_MAX_NAME_LEN - 1] = '\0';
553 strcpy (list.host, hostname_g);
556 if (NULL != (tmp = hv_fetch (values, "plugin", 6, 0))) {
557 strncpy (list.plugin, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
558 list.plugin[DATA_MAX_NAME_LEN - 1] = '\0';
561 if (NULL != (tmp = hv_fetch (values,
562 "plugin_instance", 15, 0))) {
563 strncpy (list.plugin_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
564 list.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
567 if (NULL != (tmp = hv_fetch (values, "type_instance", 13, 0))) {
568 strncpy (list.type_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
569 list.type_instance[DATA_MAX_NAME_LEN - 1] = '\0';
572 ret = plugin_dispatch_values (name, &list);
576 } /* static int pplugin_dispatch_values (char *, HV *) */
579 * Call all working functions of the given type.
581 static int pplugin_call_all (pTHX_ int type, ...)
590 if ((type < 0) || (type >= PLUGIN_TYPES))
600 XPUSHs (sv_2mortal (newSViv ((IV)type)));
602 if (PLUGIN_WRITE == type) {
604 * $_[0] = $plugin_type;
619 * values => [ $v1, ... ],
623 * plugin_instance => $instance,
624 * type_instance => $type_instance
633 ds = va_arg (ap, data_set_t *);
634 vl = va_arg (ap, value_list_t *);
636 if (-1 == data_set2av (aTHX_ ds, pds))
639 if (-1 == value_list2hv (aTHX_ vl, ds, pvl))
642 XPUSHs (sv_2mortal (newSVpv (ds->type, 0)));
643 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pds)));
644 XPUSHs (sv_2mortal (newRV_noinc ((SV *)pvl)));
646 else if (PLUGIN_LOG == type) {
652 XPUSHs (sv_2mortal (newSViv (va_arg (ap, int))));
653 XPUSHs (sv_2mortal (newSVpv (va_arg (ap, char *), 0)));
655 else if (PLUGIN_NOTIF == type) {
659 * severity => $severity,
665 * plugin_instance => $instance,
666 * type_instance => $type_instance
670 HV *notif = newHV ();
672 n = va_arg (ap, notification_t *);
674 if (-1 == notification2hv (aTHX_ n, notif))
677 XPUSHs (sv_2mortal (newRV_noinc ((SV *)notif)));
682 retvals = call_pv ("Collectd::plugin_call_all", G_SCALAR);
697 } /* static int pplugin_call_all (int, ...) */
704 * Collectd::plugin_register_data_set (type, dataset).
707 * type of the dataset
710 * dataset to be registered
712 static XS (Collectd_plugin_register_ds)
720 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
724 log_debug ("Collectd::plugin_register_data_set: "
725 "type = \"%s\", dataset = \"%s\"",
726 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
730 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
731 ret = pplugin_register_data_set (aTHX_ SvPV_nolen (ST (0)),
735 log_err ("Collectd::plugin_register_data_set: Invalid data.");
743 } /* static XS (Collectd_plugin_register_ds) */
746 * Collectd::plugin_unregister_data_set (type).
749 * type of the dataset
751 static XS (Collectd_plugin_unregister_ds)
756 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
760 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
761 SvPV_nolen (ST (0)));
763 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (1))))
767 } /* static XS (Collectd_plugin_register_ds) */
770 * Collectd::plugin_dispatch_values (name, values).
776 * value list to submit
778 static XS (Collectd_plugin_dispatch_values)
787 log_err ("Usage: Collectd::plugin_dispatch_values(name, values)");
791 log_debug ("Collectd::plugin_dispatch_values: "
792 "name = \"%s\", values=\"%s\"",
793 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
797 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
798 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
802 if ((NULL == ST (0)) || (NULL == values))
805 ret = pplugin_dispatch_values (aTHX_ SvPV_nolen (ST (0)),
806 (HV *)SvRV (values));
812 } /* static XS (Collectd_plugin_dispatch_values) */
815 * Collectd::plugin_log (level, message).
818 * log level (LOG_DEBUG, ... LOG_ERR)
823 static XS (Collectd_plugin_log)
828 log_err ("Usage: Collectd::plugin_log(level, message)");
832 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
834 } /* static XS (Collectd_plugin_log) */
837 * Collectd::call_by_name (...).
839 * Call a Perl sub identified by its name passed through $Collectd::cb_name.
841 static XS (Collectd_call_by_name)
846 if (NULL == (tmp = get_sv ("Collectd::cb_name", 0))) {
847 sv_setpv (get_sv ("@", 1), "cb_name has not been set");
852 name = SvPV_nolen (tmp);
854 if (NULL == get_cv (name, 0)) {
855 sv_setpvf (get_sv ("@", 1), "unknown callback \"%s\"", name);
860 /* simply pass on the subroutine call without touching the stack,
861 * thus leaving any arguments and return values in place */
863 } /* static XS (Collectd_call_by_name) */
866 * collectd's perl interpreter based thread implementation.
868 * This has been inspired by Perl's ithreads introduced in version 5.6.0.
871 /* must be called with perl_threads->mutex locked */
872 static void c_ithread_destroy (c_ithread_t *ithread)
874 dTHXa (ithread->interp);
876 assert (NULL != perl_threads);
878 PERL_SET_CONTEXT (aTHX);
879 log_debug ("Shutting down Perl interpreter %p...", aTHX);
884 --perl_threads->number_of_threads;
885 #endif /* COLLECT_DEBUG */
887 perl_destruct (aTHX);
890 if (NULL == ithread->prev)
891 perl_threads->head = ithread->next;
893 ithread->prev->next = ithread->next;
895 if (NULL == ithread->next)
896 perl_threads->tail = ithread->prev;
898 ithread->next->prev = ithread->prev;
902 } /* static void c_ithread_destroy (c_ithread_t *) */
904 static void c_ithread_destructor (void *arg)
906 c_ithread_t *ithread = (c_ithread_t *)arg;
907 c_ithread_t *t = NULL;
909 if (NULL == perl_threads)
912 pthread_mutex_lock (&perl_threads->mutex);
914 for (t = perl_threads->head; NULL != t; t = t->next)
918 /* the ithread no longer exists */
922 c_ithread_destroy (ithread);
924 pthread_mutex_unlock (&perl_threads->mutex);
926 } /* static void c_ithread_destructor (void *) */
928 /* must be called with perl_threads->mutex locked */
929 static c_ithread_t *c_ithread_create (PerlInterpreter *base)
931 c_ithread_t *t = NULL;
934 assert (NULL != perl_threads);
936 t = (c_ithread_t *)smalloc (sizeof (c_ithread_t));
937 memset (t, 0, sizeof (c_ithread_t));
939 t->interp = (NULL == base)
941 : perl_clone (base, CLONEf_KEEP_PTR_TABLE);
952 ++perl_threads->number_of_threads;
953 #endif /* COLLECT_DEBUG */
957 if (NULL == perl_threads->tail) {
958 perl_threads->head = t;
962 perl_threads->tail->next = t;
963 t->prev = perl_threads->tail;
966 perl_threads->tail = t;
968 pthread_setspecific (perl_thr_key, (const void *)t);
970 } /* static c_ithread_t *c_ithread_create (PerlInterpreter *) */
973 * Interface to collectd.
976 static int perl_init (void)
980 if (NULL == perl_threads)
984 c_ithread_t *t = NULL;
986 pthread_mutex_lock (&perl_threads->mutex);
987 t = c_ithread_create (perl_threads->head->interp);
988 pthread_mutex_unlock (&perl_threads->mutex);
993 log_debug ("perl_init: c_ithread: interp = %p (active threads: %i)",
994 aTHX, perl_threads->number_of_threads);
995 return pplugin_call_all (aTHX_ PLUGIN_INIT);
996 } /* static int perl_init (void) */
998 static int perl_read (void)
1002 if (NULL == perl_threads)
1006 c_ithread_t *t = NULL;
1008 pthread_mutex_lock (&perl_threads->mutex);
1009 t = c_ithread_create (perl_threads->head->interp);
1010 pthread_mutex_unlock (&perl_threads->mutex);
1015 log_debug ("perl_read: c_ithread: interp = %p (active threads: %i)",
1016 aTHX, perl_threads->number_of_threads);
1017 return pplugin_call_all (aTHX_ PLUGIN_READ);
1018 } /* static int perl_read (void) */
1020 static int perl_write (const data_set_t *ds, const value_list_t *vl)
1024 if (NULL == perl_threads)
1028 c_ithread_t *t = NULL;
1030 pthread_mutex_lock (&perl_threads->mutex);
1031 t = c_ithread_create (perl_threads->head->interp);
1032 pthread_mutex_unlock (&perl_threads->mutex);
1037 log_debug ("perl_write: c_ithread: interp = %p (active threads: %i)",
1038 aTHX, perl_threads->number_of_threads);
1039 return pplugin_call_all (aTHX_ PLUGIN_WRITE, ds, vl);
1040 } /* static int perl_write (const data_set_t *, const value_list_t *) */
1042 static void perl_log (int level, const char *msg)
1046 if (NULL == perl_threads)
1050 c_ithread_t *t = NULL;
1052 pthread_mutex_lock (&perl_threads->mutex);
1053 t = c_ithread_create (perl_threads->head->interp);
1054 pthread_mutex_unlock (&perl_threads->mutex);
1059 pplugin_call_all (aTHX_ PLUGIN_LOG, level, msg);
1061 } /* static void perl_log (int, const char *) */
1063 static int perl_notify (const notification_t *notif)
1067 if (NULL == perl_threads)
1071 c_ithread_t *t = NULL;
1073 pthread_mutex_lock (&perl_threads->mutex);
1074 t = c_ithread_create (perl_threads->head->interp);
1075 pthread_mutex_unlock (&perl_threads->mutex);
1079 return pplugin_call_all (aTHX_ PLUGIN_NOTIF, notif);
1080 } /* static int perl_notify (const notification_t *) */
1082 static int perl_shutdown (void)
1084 c_ithread_t *t = NULL;
1090 plugin_unregister_complex_config ("perl");
1092 if (NULL == perl_threads)
1096 c_ithread_t *t = NULL;
1098 pthread_mutex_lock (&perl_threads->mutex);
1099 t = c_ithread_create (perl_threads->head->interp);
1100 pthread_mutex_unlock (&perl_threads->mutex);
1105 log_debug ("perl_shutdown: c_ithread: interp = %p (active threads: %i)",
1106 aTHX, perl_threads->number_of_threads);
1108 plugin_unregister_log ("perl");
1109 plugin_unregister_init ("perl");
1110 plugin_unregister_read ("perl");
1111 plugin_unregister_write ("perl");
1113 ret = pplugin_call_all (aTHX_ PLUGIN_SHUTDOWN);
1115 pthread_mutex_lock (&perl_threads->mutex);
1116 t = perl_threads->tail;
1119 c_ithread_t *thr = t;
1121 /* the pointer has to be advanced before destroying
1122 * the thread as this will free the memory */
1125 c_ithread_destroy (thr);
1128 pthread_mutex_unlock (&perl_threads->mutex);
1129 pthread_mutex_destroy (&perl_threads->mutex);
1131 sfree (perl_threads);
1133 pthread_key_delete (perl_thr_key);
1137 plugin_unregister_shutdown ("perl");
1139 } /* static void perl_shutdown (void) */
1142 * Access functions for global variables.
1144 * These functions implement the "magic" used to access
1145 * the global variables from Perl.
1148 static int g_pv_get (pTHX_ SV *var, MAGIC *mg)
1150 char *pv = mg->mg_ptr;
1153 } /* static int g_pv_get (pTHX_ SV *, MAGIC *) */
1155 static int g_pv_set (pTHX_ SV *var, MAGIC *mg)
1157 char *pv = mg->mg_ptr;
1158 strncpy (pv, SvPV_nolen (var), DATA_MAX_NAME_LEN);
1159 pv[DATA_MAX_NAME_LEN - 1] = '\0';
1161 } /* static int g_pv_set (pTHX_ SV *, MAGIC *) */
1163 static int g_iv_get (pTHX_ SV *var, MAGIC *mg)
1165 int *iv = (int *)mg->mg_ptr;
1166 sv_setiv (var, *iv);
1168 } /* static int g_iv_get (pTHX_ SV *, MAGIC *) */
1170 static int g_iv_set (pTHX_ SV *var, MAGIC *mg)
1172 int *iv = (int *)mg->mg_ptr;
1173 *iv = (int)SvIV (var);
1175 } /* static int g_iv_set (pTHX_ SV *, MAGIC *) */
1177 static MGVTBL g_pv_vtbl = { g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL };
1178 static MGVTBL g_iv_vtbl = { g_iv_get, g_iv_set, NULL, NULL, NULL, NULL, NULL };
1180 /* bootstrap the Collectd module */
1181 static void xs_init (pTHX)
1185 char *file = __FILE__;
1191 /* enable usage of Perl modules using shared libraries */
1192 newXS ("DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
1195 for (i = 0; NULL != api[i].f; ++i)
1196 newXS (api[i].name, api[i].f, file);
1198 stash = gv_stashpv ("Collectd", 1);
1200 /* export "constants" */
1201 for (i = 0; '\0' != constants[i].name[0]; ++i)
1202 newCONSTSUB (stash, constants[i].name, newSViv (constants[i].value));
1204 /* export global variables
1205 * by adding "magic" to the SV's representing the globale variables
1206 * perl is able to automagically call the get/set function when
1207 * accessing any such variable (this is basically the same as using
1209 /* global strings */
1210 for (i = 0; '\0' != g_strings[i].name[0]; ++i) {
1211 tmp = get_sv (g_strings[i].name, 1);
1212 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl,
1213 g_strings[i].var, 0);
1216 /* global integers */
1217 for (i = 0; '\0' != g_integers[i].name[0]; ++i) {
1218 tmp = get_sv (g_integers[i].name, 1);
1219 sv_magicext (tmp, NULL, PERL_MAGIC_ext, &g_iv_vtbl,
1220 (char *)g_integers[i].var, 0);
1223 } /* static void xs_init (pTHX) */
1225 /* Initialize the global Perl interpreter. */
1226 static int init_pi (int argc, char **argv)
1230 if (NULL != perl_threads)
1233 log_info ("Initializing Perl interpreter...");
1238 for (i = 0; i < argc; ++i)
1239 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
1241 #endif /* COLLECT_DEBUG */
1243 if (0 != pthread_key_create (&perl_thr_key, c_ithread_destructor)) {
1244 log_err ("init_pi: pthread_key_create failed");
1246 /* this must not happen - cowardly giving up if it does */
1250 PERL_SYS_INIT3 (&argc, &argv, &environ);
1252 perl_threads = (c_ithread_list_t *)smalloc (sizeof (c_ithread_list_t));
1253 memset (perl_threads, 0, sizeof (c_ithread_list_t));
1255 pthread_mutex_init (&perl_threads->mutex, NULL);
1256 /* locking the mutex should not be necessary at this point
1257 * but let's just do it for the sake of completeness */
1258 pthread_mutex_lock (&perl_threads->mutex);
1260 perl_threads->head = c_ithread_create (NULL);
1261 perl_threads->tail = perl_threads->head;
1263 if (NULL == (perl_threads->head->interp = perl_alloc ())) {
1264 log_err ("init_pi: Not enough memory.");
1268 aTHX = perl_threads->head->interp;
1269 pthread_mutex_unlock (&perl_threads->mutex);
1271 perl_construct (aTHX);
1273 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
1275 if (0 != perl_parse (aTHX_ xs_init, argc, argv, NULL)) {
1276 log_err ("init_pi: Unable to bootstrap Collectd.");
1280 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
1281 sv_setpv (get_sv ("0", 0), "collectd");
1285 plugin_register_log ("perl", perl_log);
1286 plugin_register_notification ("perl", perl_notify);
1287 plugin_register_init ("perl", perl_init);
1289 plugin_register_read ("perl", perl_read);
1291 plugin_register_write ("perl", perl_write);
1292 plugin_register_shutdown ("perl", perl_shutdown);
1294 } /* static int init_pi (const char **, const int) */
1297 * LoadPlugin "<Plugin>"
1299 static int perl_config_loadplugin (pTHX_ oconfig_item_t *ci)
1301 char module_name[DATA_MAX_NAME_LEN];
1305 if ((0 != ci->children_num) || (1 != ci->values_num)
1306 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1307 log_err ("LoadPlugin expects a single string argument.");
1311 value = ci->values[0].value.string;
1313 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
1314 log_err ("Invalid module name %s", value);
1318 init_pi (perl_argc, perl_argv);
1319 assert (NULL != perl_threads);
1320 assert (NULL != perl_threads->head);
1322 aTHX = perl_threads->head->interp;
1324 log_debug ("perl_config: loading perl plugin \"%s\"", value);
1325 load_module (PERL_LOADMOD_NOIMPORT,
1326 newSVpv (module_name, strlen (module_name)), Nullsv);
1328 } /* static int perl_config_loadplugin (oconfig_item_it *) */
1333 static int perl_config_basename (pTHX_ oconfig_item_t *ci)
1337 if ((0 != ci->children_num) || (1 != ci->values_num)
1338 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1339 log_err ("BaseName expects a single string argument.");
1343 value = ci->values[0].value.string;
1345 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
1346 strncpy (base_name, value, sizeof (base_name));
1347 base_name[sizeof (base_name) - 1] = '\0';
1349 } /* static int perl_config_basename (oconfig_item_it *) */
1352 * EnableDebugger "<Package>"|""
1354 static int perl_config_enabledebugger (pTHX_ oconfig_item_t *ci)
1358 if ((0 != ci->children_num) || (1 != ci->values_num)
1359 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1360 log_err ("EnableDebugger expects a single string argument.");
1364 value = ci->values[0].value.string;
1366 perl_argv = (char **)realloc (perl_argv,
1367 (++perl_argc + 1) * sizeof (char *));
1369 if (NULL == perl_argv) {
1370 log_err ("perl_config: Not enough memory.");
1374 if ('\0' == value[0]) {
1375 perl_argv[perl_argc - 1] = "-d";
1378 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
1379 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
1380 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
1383 perl_argv[perl_argc] = NULL;
1385 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
1388 * IncludeDir "<Dir>"
1390 static int perl_config_includedir (pTHX_ oconfig_item_t *ci)
1394 if ((0 != ci->children_num) || (1 != ci->values_num)
1395 || (OCONFIG_TYPE_STRING != ci->values[0].type)) {
1396 log_err ("IncludeDir expects a single string argument.");
1400 value = ci->values[0].value.string;
1403 perl_argv = (char **)realloc (perl_argv,
1404 (++perl_argc + 1) * sizeof (char *));
1406 if (NULL == perl_argv) {
1407 log_err ("perl_config: Not enough memory.");
1411 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
1412 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
1413 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
1415 perl_argv[perl_argc] = NULL;
1418 /* prepend the directory to @INC */
1419 av_unshift (GvAVn (PL_incgv), 1);
1420 av_store (GvAVn (PL_incgv), 0, newSVpv (value, strlen (value)));
1423 } /* static int perl_config_includedir (oconfig_item_it *) */
1425 static int perl_config (oconfig_item_t *ci)
1431 /* dTHX does not get any valid values in case Perl
1432 * has not been initialized */
1433 if (NULL == perl_threads)
1436 for (i = 0; i < ci->children_num; ++i) {
1437 oconfig_item_t *c = ci->children + i;
1439 if (0 == strcasecmp (c->key, "LoadPlugin"))
1440 perl_config_loadplugin (aTHX_ c);
1441 else if (0 == strcasecmp (c->key, "BaseName"))
1442 perl_config_basename (aTHX_ c);
1443 else if (0 == strcasecmp (c->key, "EnableDebugger"))
1444 perl_config_enabledebugger (aTHX_ c);
1445 else if (0 == strcasecmp (c->key, "IncludeDir"))
1446 perl_config_includedir (aTHX_ c);
1448 log_warn ("Ignoring unknown config key \"%s\".", c->key);
1451 } /* static int perl_config (oconfig_item_t *) */
1453 void module_register (void)
1456 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1458 /* default options for the Perl interpreter */
1460 perl_argv[1] = "-MCollectd";
1461 perl_argv[2] = "-e";
1463 perl_argv[4] = NULL;
1465 plugin_register_complex_config ("perl", perl_config);
1467 } /* void module_register (void) */
1469 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */