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__)
60 /* this is defined in DynaLoader.a */
61 void boot_DynaLoader (PerlInterpreter *, CV *);
63 static XS (Collectd_plugin_register_ds);
64 static XS (Collectd_plugin_unregister_ds);
65 static XS (Collectd_plugin_dispatch_values);
66 static XS (Collectd_plugin_log);
72 static PerlInterpreter *perl = NULL;
74 static int perl_argc = 0;
75 static char **perl_argv = NULL;
77 static char base_name[DATA_MAX_NAME_LEN] = "";
84 { "Collectd::plugin_register_data_set", Collectd_plugin_register_ds },
85 { "Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds },
86 { "Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values },
87 { "Collectd::plugin_log", Collectd_plugin_log },
96 { "Collectd::TYPE_INIT", PLUGIN_INIT },
97 { "Collectd::TYPE_READ", PLUGIN_READ },
98 { "Collectd::TYPE_WRITE", PLUGIN_WRITE },
99 { "Collectd::TYPE_SHUTDOWN", PLUGIN_SHUTDOWN },
100 { "Collectd::TYPE_LOG", PLUGIN_LOG },
101 { "Collectd::TYPE_DATASET", PLUGIN_DATASET },
102 { "Collectd::DS_TYPE_COUNTER", DS_TYPE_COUNTER },
103 { "Collectd::DS_TYPE_GAUGE", DS_TYPE_GAUGE },
104 { "Collectd::LOG_ERR", LOG_ERR },
105 { "Collectd::LOG_WARNING", LOG_WARNING },
106 { "Collectd::LOG_NOTICE", LOG_NOTICE },
107 { "Collectd::LOG_INFO", LOG_INFO },
108 { "Collectd::LOG_DEBUG", LOG_DEBUG },
113 * Helper functions for data type conversion.
128 static int hv2data_source (HV *hash, data_source_t *ds)
132 if ((NULL == hash) || (NULL == ds))
135 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "name", 4, 0))) {
136 strncpy (ds->name, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
137 ds->name[DATA_MAX_NAME_LEN - 1] = '\0';
140 log_err ("hv2data_source: No DS name given.");
144 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "type", 4, 0))) {
145 ds->type = SvIV (*tmp);
147 if ((DS_TYPE_COUNTER != ds->type) && (DS_TYPE_GAUGE != ds->type)) {
148 log_err ("hv2data_source: Invalid DS type.");
153 ds->type = DS_TYPE_COUNTER;
156 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "min", 3, 0)))
157 ds->min = SvNV (*tmp);
161 if (NULL != (tmp = Perl_hv_fetch (perl, hash, "max", 3, 0)))
162 ds->max = SvNV (*tmp);
166 } /* static data_source_t *hv2data_source (HV *) */
168 static int av2value (char *name, AV *array, value_t *value, int len)
170 const data_set_t *ds;
174 if ((NULL == name) || (NULL == array) || (NULL == value))
177 if (Perl_av_len (perl, array) < len - 1)
178 len = Perl_av_len (perl, array) + 1;
183 ds = plugin_get_ds (name);
185 log_err ("av2value: Unknown dataset \"%s\"", name);
189 if (ds->ds_num < len) {
190 log_warn ("av2value: Value length exceeds data set length.");
194 for (i = 0; i < len; ++i) {
195 SV **tmp = Perl_av_fetch (perl, array, i, 0);
198 if (DS_TYPE_COUNTER == ds->ds[i].type)
199 value[i].counter = SvIV (*tmp);
201 value[i].gauge = SvNV (*tmp);
208 } /* static int av2value (char *, AV *, value_t *, int) */
210 static int data_set2av (data_set_t *ds, AV *array)
214 if ((NULL == ds) || (NULL == array))
217 Perl_av_extend (perl, array, ds->ds_num);
219 for (i = 0; i < ds->ds_num; ++i) {
220 HV *source = Perl_newHV (perl);
222 if (NULL == Perl_hv_store (perl, source, "name", 4,
223 Perl_newSVpv (perl, ds->ds[i].name, 0), 0))
226 if (NULL == Perl_hv_store (perl, source, "type", 4,
227 Perl_newSViv (perl, ds->ds[i].type), 0))
230 if (! isnan (ds->ds[i].min))
231 if (NULL == Perl_hv_store (perl, source, "min", 3,
232 Perl_newSVnv (perl, ds->ds[i].min), 0))
235 if (! isnan (ds->ds[i].max))
236 if (NULL == Perl_hv_store (perl, source, "max", 3,
237 Perl_newSVnv (perl, ds->ds[i].max), 0))
240 if (NULL == Perl_av_store (perl, array, i,
241 Perl_newRV_noinc (perl, (SV *)source)))
245 } /* static int data_set2av (data_set_t *, AV *) */
247 static int value_list2hv (value_list_t *vl, data_set_t *ds, HV *hash)
254 if ((NULL == vl) || (NULL == ds) || (NULL == hash))
257 len = vl->values_len;
259 if (ds->ds_num < len) {
260 log_warn ("value2av: Value length exceeds data set length.");
264 values = Perl_newAV (perl);
265 Perl_av_extend (perl, values, len - 1);
267 for (i = 0; i < len; ++i) {
270 if (DS_TYPE_COUNTER == ds->ds[i].type)
271 val = Perl_newSViv (perl, vl->values[i].counter);
273 val = Perl_newSVnv (perl, vl->values[i].gauge);
275 if (NULL == Perl_av_store (perl, values, i, val)) {
276 Perl_av_undef (perl, values);
281 if (NULL == Perl_hv_store (perl, hash, "values", 6,
282 Perl_newRV_noinc (perl, (SV *)values), 0))
286 if (NULL == Perl_hv_store (perl, hash, "time", 4,
287 Perl_newSViv (perl, vl->time), 0))
290 if ('\0' != vl->host[0])
291 if (NULL == Perl_hv_store (perl, hash, "host", 4,
292 Perl_newSVpv (perl, vl->host, 0), 0))
295 if ('\0' != vl->plugin[0])
296 if (NULL == Perl_hv_store (perl, hash, "plugin", 6,
297 Perl_newSVpv (perl, vl->plugin, 0), 0))
300 if ('\0' != vl->plugin_instance[0])
301 if (NULL == Perl_hv_store (perl, hash, "plugin_instance", 15,
302 Perl_newSVpv (perl, vl->plugin_instance, 0), 0))
305 if ('\0' != vl->type_instance[0])
306 if (NULL == Perl_hv_store (perl, hash, "type_instance", 13,
307 Perl_newSVpv (perl, vl->type_instance, 0), 0))
310 } /* static int value2av (value_list_t *, data_set_t *, HV *) */
313 * Internal functions.
316 static char *get_module_name (char *buf, size_t buf_len, const char *module) {
318 if (base_name[0] == '\0')
319 status = snprintf (buf, buf_len, "%s", module);
321 status = snprintf (buf, buf_len, "%s::%s", base_name, module);
322 if ((status < 0) || (status >= buf_len))
324 buf[buf_len - 1] = '\0';
326 } /* char *get_module_name */
329 * Add a plugin's data set definition.
331 static int pplugin_register_data_set (char *name, AV *dataset)
336 data_source_t *ds = NULL;
337 data_set_t *set = NULL;
339 if ((NULL == name) || (NULL == dataset))
342 len = Perl_av_len (perl, dataset);
347 ds = (data_source_t *)smalloc ((len + 1) * sizeof (data_source_t));
348 set = (data_set_t *)smalloc (sizeof (data_set_t));
350 for (i = 0; i <= len; ++i) {
351 SV **elem = Perl_av_fetch (perl, dataset, i, 0);
356 if (! (SvROK (*elem) && (SVt_PVHV == SvTYPE (SvRV (*elem))))) {
357 log_err ("pplugin_register_data_set: Invalid data source.");
361 if (-1 == hv2data_source ((HV *)SvRV (*elem), &ds[i]))
364 log_debug ("pplugin_register_data_set: "
365 "DS.name = \"%s\", DS.type = %i, DS.min = %f, DS.max = %f",
366 ds[i].name, ds[i].type, ds[i].min, ds[i].max);
369 strncpy (set->type, name, DATA_MAX_NAME_LEN);
370 set->type[DATA_MAX_NAME_LEN - 1] = '\0';
372 set->ds_num = len + 1;
374 return plugin_register_data_set (set);
375 } /* static int pplugin_register_data_set (char *, SV *) */
378 * Remove a plugin's data set definition.
380 static int pplugin_unregister_data_set (char *name)
384 return plugin_unregister_data_set (name);
385 } /* static int pplugin_unregister_data_set (char *) */
388 * Submit the values to the write functions.
392 * values => [ @values ],
396 * plugin_instance => $pinstance,
397 * type_instance => $tinstance,
400 static int pplugin_dispatch_values (char *name, HV *values)
402 value_list_t list = VALUE_LIST_INIT;
409 if ((NULL == name) || (NULL == values))
412 if ((NULL == (tmp = Perl_hv_fetch (perl, values, "values", 6, 0)))
413 || (! (SvROK (*tmp) && (SVt_PVAV == SvTYPE (SvRV (*tmp)))))) {
414 log_err ("pplugin_dispatch_values: No valid values given.");
419 AV *array = (AV *)SvRV (*tmp);
420 int len = Perl_av_len (perl, array) + 1;
425 val = (value_t *)smalloc (len * sizeof (value_t));
427 list.values_len = av2value (name, (AV *)SvRV (*tmp), val, len);
430 if (-1 == list.values_len) {
436 if (NULL != (tmp = Perl_hv_fetch (perl, values, "time", 4, 0))) {
437 list.time = (time_t)SvIV (*tmp);
440 list.time = time (NULL);
443 if (NULL != (tmp = Perl_hv_fetch (perl, values, "host", 4, 0))) {
444 strncpy (list.host, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
445 list.host[DATA_MAX_NAME_LEN - 1] = '\0';
448 strcpy (list.host, hostname_g);
451 if (NULL != (tmp = Perl_hv_fetch (perl, values, "plugin", 6, 0))) {
452 strncpy (list.plugin, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
453 list.plugin[DATA_MAX_NAME_LEN - 1] = '\0';
456 if (NULL != (tmp = Perl_hv_fetch (perl, values,
457 "plugin_instance", 15, 0))) {
458 strncpy (list.plugin_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
459 list.plugin_instance[DATA_MAX_NAME_LEN - 1] = '\0';
462 if (NULL != (tmp = Perl_hv_fetch (perl, values, "type_instance", 13, 0))) {
463 strncpy (list.type_instance, SvPV_nolen (*tmp), DATA_MAX_NAME_LEN);
464 list.type_instance[DATA_MAX_NAME_LEN - 1] = '\0';
467 ret = plugin_dispatch_values (name, &list);
471 } /* static int pplugin_dispatch_values (char *, HV *) */
474 * Call all working functions of the given type.
476 static int pplugin_call_all (int type, ...)
485 if ((type < 0) || (type >= PLUGIN_TYPES))
495 XPUSHs (sv_2mortal (Perl_newSViv (perl, (IV)type)));
497 if (PLUGIN_WRITE == type) {
499 * $_[0] = $plugin_type;
514 * values => [ $v1, ... ],
518 * plugin_instance => $instance,
519 * type_instance => $type_instance
525 AV *pds = Perl_newAV (perl);
526 HV *pvl = Perl_newHV (perl);
528 ds = va_arg (ap, data_set_t *);
529 vl = va_arg (ap, value_list_t *);
531 if (-1 == data_set2av (ds, pds))
534 if (-1 == value_list2hv (vl, ds, pvl))
537 XPUSHs (sv_2mortal (Perl_newSVpv (perl, ds->type, 0)));
538 XPUSHs (sv_2mortal (Perl_newRV_noinc (perl, (SV *)pds)));
539 XPUSHs (sv_2mortal (Perl_newRV_noinc (perl, (SV *)pvl)));
541 else if (PLUGIN_LOG == type) {
547 XPUSHs (sv_2mortal (Perl_newSViv (perl, va_arg (ap, int))));
548 XPUSHs (sv_2mortal (Perl_newSVpv (perl, va_arg (ap, char *), 0)));
553 retvals = Perl_call_pv (perl, "Collectd::plugin_call_all", G_SCALAR);
568 } /* static int pplugin_call_all (int, ...) */
575 * Collectd::plugin_register_data_set (type, dataset).
578 * type of the dataset
581 * dataset to be registered
583 static XS (Collectd_plugin_register_ds)
591 log_err ("Usage: Collectd::plugin_register_data_set(type, dataset)");
595 log_debug ("Collectd::plugin_register_data_set: "
596 "type = \"%s\", dataset = \"%s\"",
597 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
601 if (SvROK (data) && (SVt_PVAV == SvTYPE (SvRV (data)))) {
602 ret = pplugin_register_data_set (SvPV_nolen (ST (0)),
606 log_err ("Collectd::plugin_register_data_set: Invalid data.");
614 } /* static XS (Collectd_plugin_register_ds) */
617 * Collectd::plugin_unregister_data_set (type).
620 * type of the dataset
622 static XS (Collectd_plugin_unregister_ds)
627 log_err ("Usage: Collectd::plugin_unregister_data_set(type)");
631 log_debug ("Collectd::plugin_unregister_data_set: type = \"%s\"",
632 SvPV_nolen (ST (0)));
634 if (0 == pplugin_unregister_data_set (SvPV_nolen (ST (1))))
638 } /* static XS (Collectd_plugin_register_ds) */
641 * Collectd::plugin_dispatch_values (name, values).
647 * value list to submit
649 static XS (Collectd_plugin_dispatch_values)
658 log_err ("Usage: Collectd::plugin_dispatch_values(name, values)");
662 log_debug ("Collectd::plugin_dispatch_values: "
663 "name = \"%s\", values=\"%s\"",
664 SvPV_nolen (ST (0)), SvPV_nolen (ST (1)));
668 if (! (SvROK (values) && (SVt_PVHV == SvTYPE (SvRV (values))))) {
669 log_err ("Collectd::plugin_dispatch_values: Invalid values.");
673 if ((NULL == ST (0)) || (NULL == values))
676 ret = pplugin_dispatch_values (SvPV_nolen (ST (0)), (HV *)SvRV (values));
682 } /* static XS (Collectd_plugin_dispatch_values) */
685 * Collectd::plugin_log (level, message).
688 * log level (LOG_DEBUG, ... LOG_ERR)
693 static XS (Collectd_plugin_log)
698 log_err ("Usage: Collectd::plugin_log(level, message)");
702 plugin_log (SvIV (ST (0)), SvPV_nolen (ST (1)));
704 } /* static XS (Collectd_plugin_log) */
707 * Interface to collectd.
710 static int perl_init (void)
715 PERL_SET_CONTEXT (perl);
716 return pplugin_call_all (PLUGIN_INIT);
717 } /* static int perl_init (void) */
719 static int perl_read (void)
724 PERL_SET_CONTEXT (perl);
725 return pplugin_call_all (PLUGIN_READ);
726 } /* static int perl_read (void) */
728 static int perl_write (const data_set_t *ds, const value_list_t *vl)
733 PERL_SET_CONTEXT (perl);
734 return pplugin_call_all (PLUGIN_WRITE, ds, vl);
735 } /* static int perl_write (const data_set_t *, const value_list_t *) */
737 static void perl_log (int level, const char *msg)
742 PERL_SET_CONTEXT (perl);
743 pplugin_call_all (PLUGIN_LOG, level, msg);
745 } /* static void perl_log (int, const char *) */
747 static int perl_shutdown (void)
751 plugin_unregister_complex_config ("perl");
756 plugin_unregister_log ("perl");
757 plugin_unregister_init ("perl");
758 plugin_unregister_read ("perl");
759 plugin_unregister_write ("perl");
761 PERL_SET_CONTEXT (perl);
762 ret = pplugin_call_all (PLUGIN_SHUTDOWN);
765 Perl_sv_report_used (perl);
766 #endif /* COLLECT_DEBUG */
768 perl_destruct (perl);
774 plugin_unregister_shutdown ("perl");
776 } /* static void perl_shutdown (void) */
778 /* bootstrap the Collectd module */
779 static void xs_init (pTHX)
782 char *file = __FILE__;
788 /* enable usage of Perl modules using shared libraries */
789 Perl_newXS (perl, "DynaLoader::boot_DynaLoader", boot_DynaLoader, file);
792 for (i = 0; NULL != api[i].f; ++i)
793 Perl_newXS (perl, api[i].name, api[i].f, file);
795 stash = Perl_gv_stashpv (perl, "Collectd", 1);
797 /* export "constants" */
798 for (i = 0; '\0' != constants[i].name[0]; ++i)
799 Perl_newCONSTSUB (perl, stash, constants[i].name,
800 Perl_newSViv (perl, constants[i].value));
802 } /* static void xs_init (pTHX) */
804 /* Initialize the global Perl interpreter. */
805 static int init_pi (int argc, char **argv)
810 log_info ("Initializing Perl interpreter...");
815 for (i = 0; i < argc; ++i)
816 log_debug ("argv[%i] = \"%s\"", i, argv[i]);
818 #endif /* COLLECT_DEBUG */
820 PERL_SYS_INIT3 (&argc, &argv, &environ);
822 if (NULL == (perl = perl_alloc ())) {
823 log_err ("module_register: Not enough memory.");
826 perl_construct (perl);
828 PL_exit_flags |= PERL_EXIT_DESTRUCT_END;
830 if (0 != perl_parse (perl, xs_init, argc, argv, NULL)) {
831 log_err ("module_register: Unable to bootstrap Collectd.");
835 /* Set $0 to "collectd" because perl_parse() has to set it to "-e". */
836 Perl_sv_setpv (perl, Perl_get_sv (perl, "0", 0), "collectd");
840 plugin_register_log ("perl", perl_log);
841 plugin_register_init ("perl", perl_init);
843 plugin_register_read ("perl", perl_read);
845 plugin_register_write ("perl", perl_write);
846 plugin_register_shutdown ("perl", perl_shutdown);
848 } /* static int init_pi (const char **, const int) */
851 * LoadPlugin "<Plugin>"
853 static int perl_config_loadplugin (oconfig_item_t *ci)
855 char module_name[DATA_MAX_NAME_LEN];
859 if ((0 != ci->children_num) || (1 != ci->values_num)
860 || (OCONFIG_TYPE_STRING != ci->values[0].type))
863 value = ci->values[0].value.string;
865 if (NULL == get_module_name (module_name, sizeof (module_name), value)) {
866 log_err ("Invalid module name %s", value);
870 init_pi (perl_argc, perl_argv);
872 log_debug ("perl_config: loading perl plugin \"%s\"", value);
873 Perl_load_module (perl, PERL_LOADMOD_NOIMPORT,
874 Perl_newSVpv (perl, module_name, strlen (module_name)),
877 } /* static int perl_config_loadplugin (oconfig_item_it *) */
882 static int perl_config_basename (oconfig_item_t *ci)
886 if ((0 != ci->children_num) || (1 != ci->values_num)
887 || (OCONFIG_TYPE_STRING != ci->values[0].type))
890 value = ci->values[0].value.string;
892 log_debug ("perl_config: Setting plugin basename to \"%s\"", value);
893 strncpy (base_name, value, sizeof (base_name));
894 base_name[sizeof (base_name) - 1] = '\0';
896 } /* static int perl_config_basename (oconfig_item_it *) */
899 * EnableDebugger "<Package>"|""
901 static int perl_config_enabledebugger (oconfig_item_t *ci)
905 if ((0 != ci->children_num) || (1 != ci->values_num)
906 || (OCONFIG_TYPE_STRING != ci->values[0].type))
909 value = ci->values[0].value.string;
911 perl_argv = (char **)realloc (perl_argv,
912 (++perl_argc + 1) * sizeof (char *));
914 if (NULL == perl_argv) {
915 log_err ("perl_config: Not enough memory.");
919 if ('\0' == value[0]) {
920 perl_argv[perl_argc - 1] = "-d";
923 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 4);
924 sstrncpy (perl_argv[perl_argc - 1], "-d:", 4);
925 sstrncpy (perl_argv[perl_argc - 1] + 3, value, strlen (value) + 1);
928 perl_argv[perl_argc] = NULL;
930 } /* static int perl_config_enabledebugger (oconfig_item_it *) */
935 static int perl_config_includedir (oconfig_item_t *ci)
939 if ((0 != ci->children_num) || (1 != ci->values_num)
940 || (OCONFIG_TYPE_STRING != ci->values[0].type))
944 log_warn ("EnableDebugger has no effects if used after LoadPlugin.");
948 value = ci->values[0].value.string;
951 perl_argv = (char **)realloc (perl_argv,
952 (++perl_argc + 1) * sizeof (char *));
954 if (NULL == perl_argv) {
955 log_err ("perl_config: Not enough memory.");
959 perl_argv[perl_argc - 1] = (char *)smalloc (strlen (value) + 3);
960 sstrncpy(perl_argv[perl_argc - 1], "-I", 3);
961 sstrncpy(perl_argv[perl_argc - 1] + 2, value, strlen (value) + 1);
963 perl_argv[perl_argc] = NULL;
966 /* prepend the directory to @INC */
967 Perl_av_unshift (perl, GvAVn (PL_incgv), 1);
968 Perl_av_store (perl, GvAVn (PL_incgv),
969 0, Perl_newSVpv (perl, value, strlen (value)));
972 } /* static int perl_config_includedir (oconfig_item_it *) */
974 static int perl_config (oconfig_item_t *ci)
978 for (i = 0; i < ci->children_num; ++i) {
979 oconfig_item_t *c = ci->children + i;
981 if (0 == strcasecmp (c->key, "LoadPlugin"))
982 perl_config_loadplugin (c);
983 else if (0 == strcasecmp (c->key, "BaseName"))
984 perl_config_basename (c);
985 else if (0 == strcasecmp (c->key, "EnableDebugger"))
986 perl_config_enabledebugger (c);
987 else if (0 == strcasecmp (c->key, "IncludeDir"))
988 perl_config_includedir (c);
990 log_warn ("Ignoring unknown config key \"%s\".", c->key);
993 } /* static int perl_config (oconfig_item_t *) */
995 void module_register (void)
998 perl_argv = (char **)smalloc ((perl_argc + 1) * sizeof (char *));
1000 /* default options for the Perl interpreter */
1002 perl_argv[1] = "-MCollectd";
1003 perl_argv[2] = "-e";
1005 perl_argv[4] = NULL;
1007 plugin_register_complex_config ("perl", perl_config);
1009 } /* void module_register (void) */
1011 /* vim: set sw=4 ts=4 tw=78 noexpandtab : */