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.
29 #include "configfile.h"
36 /* Some versions of Perl define their own version of DEBUG... :-/ */
41 /* ... while we want the definition found in plugin.h. */
47 #define PLUGIN_WRITE 2
48 #define PLUGIN_SHUTDOWN 3
51 #define PLUGIN_TYPES 5
53 #define PLUGIN_DATASET 255
55 #define log_debug(...) DEBUG ("perl: " __VA_ARGS__)
56 #define log_info(...) INFO ("perl: " __VA_ARGS__)
57 #define log_warn(...) WARNING ("perl: " __VA_ARGS__)
58 #define log_err(...) ERROR ("perl: " __VA_ARGS__)
61 /* this is defined in DynaLoader.a */
62 void boot_DynaLoader (PerlInterpreter *, CV *);
64 static XS (Collectd_plugin_register_ds);
65 static XS (Collectd_plugin_unregister_ds);
66 static XS (Collectd_plugin_dispatch_values);
67 static XS (Collectd_plugin_log);
84 /* valid configuration file keys */
85 static const char *config_keys[] =
91 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
93 static PerlInterpreter *perl = NULL;
95 static int perl_argc = 0;
96 static char **perl_argv = NULL;
98 static char base_name[DATA_MAX_NAME_LEN] = "";
100 static HV *data_sets;
107 { "Collectd::plugin_register_data_set", Collectd_plugin_register_ds },
108 { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
109 { "Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values },
110 { "Collectd::plugin_log", Collectd_plugin_log },
119 { "Collectd::TYPE_INIT", PLUGIN_INIT },
120 { "Collectd::TYPE_READ", PLUGIN_READ },
121 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
122 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
123 { "Collectd::TYPE_LOG", PLUGIN_LOG },
124 { "Collectd::TYPE_DATASET", PLUGIN_DATASET },
125 { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
126 { "Collectd::DS_TYPE_GAUGE", DS_TYPE_GAUGE },
127 { "Collectd::LOG_ERR", LOG_ERR },
128 { "Collectd::LOG_WARNING", LOG_WARNING },
129 { "Collectd::LOG_NOTICE", LOG_NOTICE },
130 { "Collectd::LOG_INFO", LOG_INFO },
131 { "Collectd::LOG_DEBUG", LOG_DEBUG },
137 * Helper functions for data type conversion.
152 static int hv2data_source (HV *hash, data_source_t *ds)
156 if ((NULL == hash) || (NULL == ds))
159 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "name", 4, 0))) {
160 strncpy (ds->name, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
161 ds->name[DATA_MAX_NAME_LEN - 1] = '\0';
164 log_err ("hv2data_source: No DS name given.");
168 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "type", 4, 0))) {
169 ds->type = SvIV (*tmp);
171 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
172 log_err ("hv2data_source: Invalid DS type.");
177 ds->type = DS_TYPE_COUNTER;
180 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "min", 3, 0)))
181 ds->min = SvNV (*tmp);
185 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "max", 3, 0)))
186 ds->max = SvNV (*tmp);
190 } /* static data_source_t *hv2data_source (HV *) */
192 static int av2value (char *name, AV *array, value_t *value, int len)
196 ds_types_t *ds = NULL;
200 if ((NULL == name) || (NULL == array) || (NULL == value))
203 if (Perl_av_len (perl, array) < len - 1)
204 len = Perl_av_len (perl, array) + 1;
209 tmp = Perl_hv_fetch (perl, data_sets, name, strlen (name), 0);
211 log_err ("av2value: No dataset for \"%s\".", name);
214 ds = (ds_types_t *)SvIV ((SV *)SvRV (*tmp));
217 log_warn ("av2value: Value length exceeds data set length.");
221 for (i = 0; i < len; ++i) {
222 SV **tmp = Perl_av_fetch (perl, array, i, 0);
225 if (DS_TYPE_COUNTER == ds->values[i])
226 value[i].counter = SvIV (*tmp);
228 value[i].gauge = SvNV (*tmp);
235 } /* static int av2value (char *, AV *, value_t *, int) */
237 static int data_set2av (data_set_t *ds, AV *array)
241 if ((NULL == ds) || (NULL == array))
244 Perl_av_extend (perl, array, ds->ds_num);
246 for (i = 0; i < ds->ds_num; ++i) {
247 HV *source = Perl_newHV (perl);
249 if (NULL == Perl_hv_store (perl, source, "name", 4,
250 Perl_newSVpv (perl, ds->ds[i].name, 0), 0))
253 if (NULL == Perl_hv_store (perl, source, "type", 4,
254 Perl_newSViv (perl, ds->ds[i].type), 0))
257 if (! isnan (ds->ds[i].min))
258 if (NULL == Perl_hv_store (perl, source, "min", 3,
259 Perl_newSVnv (perl, ds->ds[i].min), 0))
262 if (! isnan (ds->ds[i].max))
263 if (NULL == Perl_hv_store (perl, source, "max", 3,
264 Perl_newSVnv (perl, ds->ds[i].max), 0))
267 if (NULL == Perl_av_store (perl, array, i,
268 Perl_newRV_noinc (perl, (SV *)source)))
272 } /* static int data_set2av (data_set_t *, AV *) */
274 static int value_list2hv (value_list_t *vl, data_set_t *ds, HV *hash)
281 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
284 len = vl->values_len;
286 if (ds->ds_num < len) {
287 log_warn ("value2av: Value length exceeds data set length.");
291 values = Perl_newAV (perl);
292 Perl_av_extend (perl, values, len - 1);
294 for (i = 0; i < len; ++i) {
297 if (DS_TYPE_COUNTER == ds->ds[i].type)
298 val = Perl_newSViv (perl, vl->values[i].counter);
300 val = Perl_newSVnv (perl, vl->values[i].gauge);
302 if (NULL == Perl_av_store (perl, values, i, val)) {
303 Perl_av_undef (perl, values);
308 if (NULL == Perl_hv_store (perl, hash, "values", 6,
309 Perl_newRV_noinc (perl, (SV *)values), 0))
313 if (NULL == Perl_hv_store (perl, hash, "time", 4,
314 Perl_newSViv (perl, vl->time), 0))
317 if ('\0' != vl->host[0])
318 if (NULL == Perl_hv_store (perl, hash, "host", 4,
319 Perl_newSVpv (perl, vl->host, 0), 0))
322 if ('\0' != vl->plugin[0])
323 if (NULL == Perl_hv_store (perl, hash, "plugin", 6,
324 Perl_newSVpv (perl, vl->plugin, 0), 0))
327 if ('\0' != vl->plugin_instance[0])
328 if (NULL == Perl_hv_store (perl, hash, "plugin_instance", 15,
329 Perl_newSVpv (perl, vl->plugin_instance, 0), 0))
332 if ('\0' != vl->type_instance[0])
333 if (NULL == Perl_hv_store (perl, hash, "type_instance", 13,
334 Perl_newSVpv (perl, vl->type_instance, 0), 0))
337 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
341 * Internal functions.
344 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
346 if (base_name[0] == '\0')
347 status = snprintf (buf, buf_len, "%s", module);
349 status = snprintf (buf, buf_len, "%s::%s", base_name, module);
350 if ((status < 0) || (status >= buf_len))
352 buf[buf_len - 1] = '\0';
354 } /* char *get_module_name */
357 * Add a plugin's data set definition.
359 static int pplugin_register_data_set (char *name, AV *dataset)
364 data_source_t *ds = NULL;
365 data_set_t *set = NULL;
367 ds_types_t *types = NULL;
369 if ((NULL == name) || (NULL == dataset))
372 len = Perl_av_len (perl, dataset);
377 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
378 set = (data_set_t *)smalloc (sizeof (data_set_t));
380 types = (ds_types_t *)smalloc (sizeof (ds_types_t));
381 types->len = len + 1;
382 types->values = (int *)smalloc ((types->len) * sizeof (int));
384 for (i = 0; i <= len; ++i) {
385 SV **elem = Perl_av_fetch (perl, dataset, i, 0);
390 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
391 log_err ("pplugin_register_data_set: Invalid data source.");
395 if (-1 == hv2data_source ((HV *)SvRV (*elem), &ds[i]))
398 types->values[i] = ds[i].type;
399 log_debug ("pplugin_register_data_set: "
400 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
401 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
404 if (NULL == Perl_hv_store (perl, data_sets, name, strlen (name),
405 Perl_sv_setref_pv (perl, Perl_newSV (perl, 0), 0, types), 0))
408 strncpy (set->type, name, DATA_MAX_NAME_LEN);
409 set->type[DATA_MAX_NAME_LEN - 1] = '\0';
411 set->ds_num = len + 1;
413 return plugin_register_data_set (set);
414 } /* static int pplugin_register_data_set (char *, SV *) */
417 * Remove a plugin's data set definition.
419 static int pplugin_unregister_data_set (char *name)
426 /* freeing the allocated memory of the element itself (ds_types_t *)
427 * causes a segfault during perl_destruct () thus I assume perl somehow
428 * takes care of this... */
430 tmp = Perl_hv_delete (perl, data_sets, name, strlen (name), 0);
432 ds_types_t *ds = (ds_types_t *)SvIV ((SV *)SvRV (tmp));
435 return plugin_unregister_data_set (name);
436 } /* static int pplugin_unregister_data_set (char *) */
439 * Submit the values to the write functions.
443 * values => [ @values ],
447 * plugin_instance => $pinstance,
448 * type_instance => $tinstance,
451 static int pplugin_dispatch_values (char *name, HV *values)
453 value_list_t list = VALUE_LIST_INIT;
460 if ((NULL == name) || (NULL == values))
463 if ((NULL == (tmp = Perl_hv_fetch (perl, values, "values", 6, 0)))
464 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
465 log_err ("pplugin_dispatch_values: No valid values given.");
470 AV *array = (AV *)SvRV (*tmp);
471 int len = Perl_av_len (perl, array) + 1;
473 val = (value_t *)smalloc (len * sizeof (value_t));
475 list.values_len = av2value (name, (AV *)SvRV (*tmp), val, len);
478 if (-1 == list.values_len) {
484 if (NULL != (tmp = Perl_hv_fetch (perl, values, "time", 4, 0))) {
485 list.time = (time_t)SvIV (*tmp);
488 list.time = time (NULL);
491 if (NULL != (tmp = Perl_hv_fetch (perl, values, "host", 4, 0))) {
492 strncpy (list.host, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
493 list.host[DATA_MAX_NAME_LEN - 1] = '\0';
496 strcpy (list.host, hostname_g);
499 if (NULL != (tmp = Perl_hv_fetch (perl, values, "plugin", 6, 0))) {
500 strncpy (list.plugin, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
501 list.plugin[DATA_MAX_NAME_LEN - 1] = '\0';
504 if (NULL != (tmp = Perl_hv_fetch (perl, values,
505 "plugin_instance", 15, 0))) {
506 strncpy (list.plugin_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
507 list.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
510 if (NULL != (tmp = Perl_hv_fetch (perl, values, "type_instance", 13, 0))) {
511 strncpy (list.type_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
512 list.type_instance[DATA_MAX_NAME_LEN - 1] = '\0';
515 ret = plugin_dispatch_values (name, &list);
519 } /* static int pplugin_dispatch_values (char *, HV *) */
522 * Call all working functions of the given type.
524 static int pplugin_call_all (int type, ...)
533 if ((type < 0) || (type >= PLUGIN_TYPES))
543 XPUSHs (sv_2mortal (Perl_newSViv (perl, (IV)type)));
545 if (PLUGIN_WRITE == type) {
547 * $_[0] = $plugin_type;
562 * values => [ $v1, ... ],
566 * plugin_instance => $instance,
567 * type_instance => $type_instance
573 AV *pds = Perl_newAV (perl);
574 HV *pvl = Perl_newHV (perl);
576 ds = va_arg (ap, data_set_t *);
577 vl = va_arg (ap, value_list_t *);
579 if (-1 == data_set2av (ds, pds))
582 if (-1 == value_list2hv (vl, ds, pvl))
585 XPUSHs (sv_2mortal (Perl_newSVpv (perl, ds->type, 0)));
586 XPUSHs (sv_2mortal (Perl_newRV_noinc (perl, (SV *)pds)));
587 XPUSHs (sv_2mortal (Perl_newRV_noinc (perl, (SV *)pvl)));
589 else if (PLUGIN_LOG == type) {
595 XPUSHs (sv_2mortal (Perl_newSViv (perl, va_arg (ap, int))));
596 XPUSHs (sv_2mortal (Perl_newSVpv (perl, va_arg (ap, char *), 0)));
601 retvals = Perl_call_pv (perl, "Collectd::plugin_call_all", G_SCALAR);
616 } /* static int pplugin_call_all (int, ...) */
624 * Collectd::plugin_register_data_set (type, dataset).
627 * type of the dataset
630 * dataset to be registered
632 static XS (Collectd_plugin_register_ds)
640 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
644 log_debug ("Collectd::plugin_register_data_set: "
645 "type = \"%s\", dataset = \"%s\"",
646 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
650 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
651 ret = pplugin_register_data_set (SvPV_nolen (ST (0)),
655 log_err ("Collectd::plugin_register_data_set: Invalid data.");
663 } /* static XS (Collectd_plugin_register_ds) */
666 * Collectd::plugin_unregister_data_set (type).
669 * type of the dataset
671 static XS (Collectd_plugin_unregister_ds)
676 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
680 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
681 SvPV_nolen (ST (0)));
683 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (1))))
687 } /* static XS (Collectd_plugin_register_ds) */
690 * Collectd::plugin_dispatch_values (name, values).
696 * value list to submit
698 static XS (Collectd_plugin_dispatch_values)
707 log_err ("Usage: Collectd::plugin_dispatch_values(name, values)");
711 log_debug ("Collectd::plugin_dispatch_values: "
712 "name = \"%s\", values=\"%s\"",
713 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
717 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
718 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
722 if ((NULL == ST (0)) || (NULL == values))
725 ret = pplugin_dispatch_values (SvPV_nolen (ST (0)), (HV *)SvRV (values));
731 } /* static XS (Collectd_plugin_dispatch_values) */
734 * Collectd::plugin_log (level, message).
737 * log level (LOG_DEBUG, ... LOG_ERR)
742 static XS (Collectd_plugin_log)
747 log_err ("Usage: Collectd::plugin_log(level, message)");
751 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
753 } /* static XS (Collectd_plugin_log) */
757 * Interface to collectd.
760 static int perl_init (void)
765 PERL_SET_CONTEXT (perl);
766 return pplugin_call_all (PLUGIN_INIT);
767 } /* static int perl_init (void) */
769 static int perl_read (void)
774 PERL_SET_CONTEXT (perl);
775 return pplugin_call_all (PLUGIN_READ);
776 } /* static int perl_read (void) */
778 static int perl_write (const data_set_t *ds, const value_list_t *vl)
783 PERL_SET_CONTEXT (perl);
784 return pplugin_call_all (PLUGIN_WRITE, ds, vl);
785 } /* static int perl_write (const data_set_t *, const value_list_t *) */
787 static void perl_log (int level, const char *msg)
792 PERL_SET_CONTEXT (perl);
793 pplugin_call_all (PLUGIN_LOG, level, msg);
795 } /* static void perl_log (int, const char *) */
797 static int perl_shutdown (void)
801 plugin_unregister_config ("perl");
806 plugin_unregister_log ("perl");
807 plugin_unregister_init ("perl");
808 plugin_unregister_read ("perl");
809 plugin_unregister_write ("perl");
811 PERL_SET_CONTEXT (perl);
812 ret = pplugin_call_all (PLUGIN_SHUTDOWN);
814 if (0 < Perl_hv_iterinit (perl, data_sets)) {
818 while (NULL != Perl_hv_iternextsv (perl, data_sets, &k, &l)) {
819 pplugin_unregister_data_set (k);
823 Perl_hv_undef (perl, data_sets);
826 Perl_sv_report_used (perl);
827 #endif /* COLLECT_DEBUG */
829 perl_destruct (perl);
835 plugin_unregister_shutdown ("perl");
837 } /* static void perl_shutdown (void) */
839 /* bootstrap the Collectd module */
840 static void xs_init (pTHX)
843 char *file = __FILE__;
849 /* enable usage of Perl modules using shared libraries */
850 Perl_newXS (perl, "DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
853 for (i = 0; NULL != api[i].f; ++i)
854 Perl_newXS (perl, api[i].name, api[i].f, file);
856 stash = Perl_gv_stashpv (perl, "Collectd", 1);
858 /* export "constants" */
859 for (i = 0; '\0' != constants[i].name[0]; ++i)
860 Perl_newCONSTSUB (perl, stash, constants[i].name,
861 Perl_newSViv (perl, constants[i].value));
863 } /* static void xs_init (pTHX) */
865 /* Initialize the global Perl interpreter. */
866 static int init_pi (int argc, char **argv)
871 log_info ("Initializing Perl interpreter...");
876 for (i = 0; i < argc; ++i)
877 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
879 #endif /* COLLECT_DEBUG */
881 PERL_SYS_INIT3 (&argc, &argv, &environ);
883 if (NULL == (perl = perl_alloc ())) {
884 log_err ("module_register: Not enough memory.");
887 perl_construct (perl);
889 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
891 if (0 != perl_parse (perl, xs_init, argc, argv, NULL)) {
892 log_err ("module_register: Unable to bootstrap Collectd.");
897 data_sets = Perl_newHV (perl);
899 plugin_register_log ("perl", perl_log);
900 plugin_register_init ("perl", perl_init);
902 plugin_register_read ("perl", perl_read);
904 plugin_register_write ("perl", perl_write);
905 plugin_register_shutdown ("perl", perl_shutdown);
907 } /* static int init_pi (const char **, const int) */
909 static int perl_config (const char *key, const char *value)
911 log_debug ("perl_config: key = \"%s\", value=\"%s\"", key, value);
913 if (0 == strcasecmp (key, "LoadPlugin")) {
914 char module_name[DATA_MAX_NAME_LEN];
916 if (get_module_name (module_name, sizeof (module_name), value)
918 log_err ("Invalid module name %s", value);
920 } /* if (get_module_name == NULL) */
922 init_pi (perl_argc, perl_argv);
924 log_debug ("perl_config: loading perl plugin \"%s\"", value);
925 Perl_load_module (perl, PERL_LOADMOD_NOIMPORT,
926 Perl_newSVpv (perl, module_name, strlen (module_name)),
929 else if (0 == strcasecmp (key, "BaseName")) {
930 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
931 strncpy (base_name, value, sizeof (base_name));
932 base_name[sizeof (base_name) - 1] = '\0';
934 else if (0 == strcasecmp (key, "IncludeDir")) {
935 perl_argv = (char **)realloc (perl_argv,
936 (++perl_argc + 1) * sizeof (char *));
938 if (NULL == perl_argv) {
939 log_err ("perl_config: Not enough memory.");
943 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
944 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
945 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
947 perl_argv[perl_argc] = NULL;
953 } /* static int perl_config (char *, char *) */
955 void module_register (void)
958 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
960 /* default options for the Perl interpreter */
962 perl_argv[1] = "-MCollectd";
967 plugin_register_config ("perl", perl_config, config_keys, config_keys_num);
969 } /* void module_register (void) */
971 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */