*
* Authors:
* Sebastian Harl <sh at tokkee.org>
+ * Pavel Rochnyak <pavel2000 ngs.ru>
**/
/*
#undef DONT_POISON_SPRINTF_YET
-#if HAVE_STDBOOL_H
#include <stdbool.h>
-#endif
#include <EXTERN.h>
#include <perl.h>
#define PLUGIN_LOG 4
#define PLUGIN_NOTIF 5
#define PLUGIN_FLUSH 6
+#define PLUGIN_FLUSH_ALL 7 /* For collectd-5.6 only */
-#define PLUGIN_TYPES 7
+#define PLUGIN_TYPES 8
#define PLUGIN_CONFIG 254
#define PLUGIN_DATASET 255
/* this is defined in DynaLoader.a */
void boot_DynaLoader(PerlInterpreter *, CV *);
+static XS(Collectd_plugin_register_read);
+static XS(Collectd_plugin_register_write);
+static XS(Collectd_plugin_register_log);
+static XS(Collectd_plugin_register_notification);
+static XS(Collectd_plugin_register_flush);
+static XS(Collectd_plugin_unregister_read);
+static XS(Collectd_plugin_unregister_write);
+static XS(Collectd_plugin_unregister_log);
+static XS(Collectd_plugin_unregister_notification);
+static XS(Collectd_plugin_unregister_flush);
static XS(Collectd_plugin_register_ds);
static XS(Collectd_plugin_unregister_ds);
static XS(Collectd_plugin_dispatch_values);
static XS(Collectd__fc_register);
static XS(Collectd_call_by_name);
+static int perl_read(user_data_t *ud);
+static int perl_write(const data_set_t *ds, const value_list_t *vl,
+ user_data_t *user_data);
+static void perl_log(int level, const char *msg, user_data_t *user_data);
+static int perl_notify(const notification_t *notif, user_data_t *user_data);
+static int perl_flush(cdtime_t timeout, const char *identifier,
+ user_data_t *user_data);
+
/*
* private data types
*/
* private variables
*/
+static _Bool register_legacy_flush = 1;
+
/* if perl_threads != NULL perl_threads->head must
* point to the "base" thread */
static c_ithread_list_t *perl_threads = NULL;
char name[64];
XS((*f));
} api[] = {
+ {"Collectd::plugin_register_read", Collectd_plugin_register_read},
+ {"Collectd::plugin_register_write", Collectd_plugin_register_write},
+ {"Collectd::plugin_register_log", Collectd_plugin_register_log},
+ {"Collectd::plugin_register_notification",
+ Collectd_plugin_register_notification},
+ {"Collectd::plugin_register_flush", Collectd_plugin_register_flush},
+ {"Collectd::plugin_unregister_read", Collectd_plugin_unregister_read},
+ {"Collectd::plugin_unregister_write", Collectd_plugin_unregister_write},
+ {"Collectd::plugin_unregister_log", Collectd_plugin_unregister_log},
+ {"Collectd::plugin_unregister_notification",
+ Collectd_plugin_unregister_notification},
+ {"Collectd::plugin_unregister_flush", Collectd_plugin_unregister_flush},
{"Collectd::plugin_register_data_set", Collectd_plugin_register_ds},
{"Collectd::plugin_unregister_data_set", Collectd_plugin_unregister_ds},
{"Collectd::plugin_dispatch_values", Collectd_plugin_dispatch_values},
{"Collectd::NOTIF_WARNING", NOTIF_WARNING},
{"Collectd::NOTIF_OKAY", NOTIF_OKAY},
{"", 0}};
-
-struct {
- char name[64];
- char *var;
-} g_strings[] = {{"Collectd::hostname_g", hostname_g}, {"", NULL}};
-
/*
* Helper functions for data type conversion.
*/
if (array_len < ds->ds_num) {
log_warn("av2value: array does not contain enough elements for type "
- "\"%s\": got %zu, want %zu",
+ "\"%s\": got %" PRIsz ", want %" PRIsz,
name, array_len, ds->ds_num);
return 0;
} else if (array_len > ds->ds_num) {
log_warn("av2value: array contains excess elements for type \"%s\": got "
- "%zu, want %zu",
+ "%" PRIsz ", want %" PRIsz,
name, array_len, ds->ds_num);
}
if (NULL != (tmp = hv_fetch(hash, "host", 4, 0)))
sstrncpy(vl->host, SvPV_nolen(*tmp), sizeof(vl->host));
- else
- sstrncpy(vl->host, hostname_g, sizeof(vl->host));
if (NULL != (tmp = hv_fetch(hash, "plugin", 6, 0)))
sstrncpy(vl->plugin, SvPV_nolen(*tmp), sizeof(vl->plugin));
* meta => [ { name => <name>, value => <value> }, ... ]
* }
*/
-static int av2notification_meta(pTHX_ AV *array, notification_meta_t **ret_meta) {
+static int av2notification_meta(pTHX_ AV *array,
+ notification_meta_t **ret_meta) {
notification_meta_t *tail = NULL;
int len = av_len(array);
static int notification_meta2av(pTHX_ notification_meta_t *meta, AV *array) {
int meta_num = 0;
-
- while (meta) {
+ for (notification_meta_t *m = meta; m != NULL; m = m->next) {
++meta_num;
- meta = meta->next;
}
av_extend(array, meta_num);
static char *get_module_name(char *buf, size_t buf_len, const char *module) {
int status = 0;
if (base_name[0] == '\0')
- status = ssnprintf(buf, buf_len, "%s", module);
+ status = snprintf(buf, buf_len, "%s", module);
else
- status = ssnprintf(buf, buf_len, "%s::%s", base_name, module);
+ status = snprintf(buf, buf_len, "%s::%s", base_name, module);
if ((status < 0) || ((unsigned int)status >= buf_len))
- return (NULL);
- return (buf);
+ return NULL;
+ return buf;
} /* char *get_module_name */
/*
return 0;
}
- ret = call_pv(sub_name, G_SCALAR);
+ ret = call_pv(sub_name, G_SCALAR | G_EVAL);
t->running = old_running;
return ret;
/*
* Call all working functions of the given type.
*/
-static int pplugin_call_all(pTHX_ int type, ...) {
+static int pplugin_call(pTHX_ int type, ...) {
int retvals = 0;
va_list ap;
int ret = 0;
+ char *subname;
dSP;
PUSHMARK(SP);
- XPUSHs(sv_2mortal(newSViv((IV)type)));
+ if (PLUGIN_READ == type) {
+ subname = va_arg(ap, char *);
+ } else if (PLUGIN_WRITE == type) {
+ data_set_t *ds;
+ value_list_t *vl;
+
+ AV *pds = newAV();
+ HV *pvl = newHV();
- if (PLUGIN_WRITE == type) {
+ subname = va_arg(ap, char *);
/*
* $_[0] = $plugin_type;
*
* type_instance => $type_instance
* };
*/
- data_set_t *ds;
- value_list_t *vl;
-
- AV *pds = newAV();
- HV *pvl = newHV();
-
ds = va_arg(ap, data_set_t *);
vl = va_arg(ap, value_list_t *);
XPUSHs(sv_2mortal(newRV_noinc((SV *)pds)));
XPUSHs(sv_2mortal(newRV_noinc((SV *)pvl)));
} else if (PLUGIN_LOG == type) {
+ subname = va_arg(ap, char *);
/*
* $_[0] = $level;
*
XPUSHs(sv_2mortal(newSViv(va_arg(ap, int))));
XPUSHs(sv_2mortal(newSVpv(va_arg(ap, char *), 0)));
} else if (PLUGIN_NOTIF == type) {
+ notification_t *n;
+ HV *notif = newHV();
+
+ subname = va_arg(ap, char *);
/*
* $_[0] =
* {
* type_instance => $type_instance
* };
*/
- notification_t *n;
- HV *notif = newHV();
-
n = va_arg(ap, notification_t *);
if (-1 == notification2hv(aTHX_ n, notif)) {
XPUSHs(sv_2mortal(newRV_noinc((SV *)notif)));
} else if (PLUGIN_FLUSH == type) {
cdtime_t timeout;
+ subname = va_arg(ap, char *);
+ /*
+ * $_[0] = $timeout;
+ * $_[1] = $identifier;
+ */
+ timeout = va_arg(ap, cdtime_t);
+ XPUSHs(sv_2mortal(newSVnv(CDTIME_T_TO_DOUBLE(timeout))));
+ XPUSHs(sv_2mortal(newSVpv(va_arg(ap, char *), 0)));
+ } else if (PLUGIN_FLUSH_ALL == type) {
+ cdtime_t timeout;
+ subname = "Collectd::plugin_call_all";
/*
* $_[0] = $timeout;
* $_[1] = $identifier;
*/
timeout = va_arg(ap, cdtime_t);
+ XPUSHs(sv_2mortal(newSViv((IV)PLUGIN_FLUSH)));
XPUSHs(sv_2mortal(newSVnv(CDTIME_T_TO_DOUBLE(timeout))));
XPUSHs(sv_2mortal(newSVpv(va_arg(ap, char *), 0)));
+ } else if (PLUGIN_INIT == type) {
+ subname = "Collectd::plugin_call_all";
+ XPUSHs(sv_2mortal(newSViv((IV)type)));
+ } else if (PLUGIN_SHUTDOWN == type) {
+ subname = "Collectd::plugin_call_all";
+ XPUSHs(sv_2mortal(newSViv((IV)type)));
+ } else { /* Unknown type. Run 'plugin_call_all' and make compiler happy */
+ subname = "Collectd::plugin_call_all";
+ XPUSHs(sv_2mortal(newSViv((IV)type)));
}
PUTBACK;
- retvals = call_pv_locked(aTHX_ "Collectd::plugin_call_all");
+ retvals = call_pv_locked(aTHX_ subname);
SPAGAIN;
- if (0 < retvals) {
+ if (SvTRUE(ERRSV)) {
+ if (PLUGIN_LOG != type)
+ ERROR("perl: %s error: %s", subname, SvPV_nolen(ERRSV));
+ ret = -1;
+ } else if (0 < retvals) {
SV *tmp = POPs;
if (!SvTRUE(tmp))
ret = -1;
va_end(ap);
return ret;
-} /* static int pplugin_call_all (int, ...) */
+} /* static int pplugin_call (int, ...) */
/*
* collectd's Perl interpreter based thread implementation.
assert(NULL != perl_threads);
PERL_SET_CONTEXT(aTHX);
+ /* Mark as running to avoid deadlock:
+ c_ithread_destroy -> log_debug -> perl_log()
+ */
+ ithread->running = 1;
log_debug("Shutting down Perl interpreter %p...", aTHX);
#if COLLECT_DEBUG
}
SPAGAIN;
- if (0 < retvals) {
+ if (SvTRUE(ERRSV)) {
+ ERROR("perl: Collectd::fc_call error: %s", SvPV_nolen(ERRSV));
+ ret = -1;
+ } else if (0 < retvals) {
SV *tmp = POPs;
/* the exec callbacks return a status, while
* Exported Perl API.
*/
+static void _plugin_register_generic_userdata(pTHX, int type,
+ const char *desc) {
+ int ret = 0;
+ user_data_t userdata;
+ char *pluginname;
+
+ dXSARGS;
+
+ if (2 != items) {
+ log_err("Usage: Collectd::plugin_register_%s(pluginname, subname)", desc);
+ XSRETURN_EMPTY;
+ }
+
+ if (!SvOK(ST(0))) {
+ log_err("Collectd::plugin_register_%s(pluginname, subname): "
+ "Invalid pluginname",
+ desc);
+ XSRETURN_EMPTY;
+ }
+ if (!SvOK(ST(1))) {
+ log_err("Collectd::plugin_register_%s(pluginname, subname): "
+ "Invalid subname",
+ desc);
+ XSRETURN_EMPTY;
+ }
+
+ /* Use pluginname as-is to allow flush a single perl plugin */
+ pluginname = SvPV_nolen(ST(0));
+
+ log_debug("Collectd::plugin_register_%s: "
+ "plugin = \"%s\", sub = \"%s\"",
+ desc, pluginname, SvPV_nolen(ST(1)));
+
+ memset(&userdata, 0, sizeof(userdata));
+ userdata.data = strdup(SvPV_nolen(ST(1)));
+ userdata.free_func = free;
+
+ if (PLUGIN_READ == type) {
+ ret = plugin_register_complex_read(
+ "perl", /* group */
+ pluginname, perl_read, plugin_get_interval(), /* Default interval */
+ &userdata);
+ } else if (PLUGIN_WRITE == type) {
+ ret = plugin_register_write(pluginname, perl_write, &userdata);
+ } else if (PLUGIN_LOG == type) {
+ ret = plugin_register_log(pluginname, perl_log, &userdata);
+ } else if (PLUGIN_NOTIF == type) {
+ ret = plugin_register_notification(pluginname, perl_notify, &userdata);
+ } else if (PLUGIN_FLUSH == type) {
+ if (1 == register_legacy_flush) { /* For collectd-5.7 only, #1731 */
+ register_legacy_flush = 0;
+ ret = plugin_register_flush("perl", perl_flush, /* user_data = */ NULL);
+ }
+
+ if (0 == ret) {
+ ret = plugin_register_flush(pluginname, perl_flush, &userdata);
+ } else {
+ free(userdata.data);
+ }
+ } else {
+ ret = -1;
+ }
+
+ if (0 == ret)
+ XSRETURN_YES;
+ else
+ XSRETURN_EMPTY;
+} /* static void _plugin_register_generic_userdata ( ... ) */
+
+/*
+ * Collectd::plugin_register_TYPE (pluginname, subname).
+ *
+ * pluginname:
+ * name of the perl plugin
+ *
+ * subname:
+ * name of the plugin's subroutine that does the work
+ */
+
+static XS(Collectd_plugin_register_read) {
+ return _plugin_register_generic_userdata(aTHX, PLUGIN_READ, "read");
+}
+
+static XS(Collectd_plugin_register_write) {
+ return _plugin_register_generic_userdata(aTHX, PLUGIN_WRITE, "write");
+}
+
+static XS(Collectd_plugin_register_log) {
+ return _plugin_register_generic_userdata(aTHX, PLUGIN_LOG, "log");
+}
+
+static XS(Collectd_plugin_register_notification) {
+ return _plugin_register_generic_userdata(aTHX, PLUGIN_NOTIF, "notification");
+}
+
+static XS(Collectd_plugin_register_flush) {
+ return _plugin_register_generic_userdata(aTHX, PLUGIN_FLUSH, "flush");
+}
+
+typedef int perl_unregister_function_t(const char *name);
+
+static void _plugin_unregister_generic(pTHX, perl_unregister_function_t *unreg,
+ const char *desc) {
+ dXSARGS;
+
+ if (1 != items) {
+ log_err("Usage: Collectd::plugin_unregister_%s(pluginname)", desc);
+ XSRETURN_EMPTY;
+ }
+
+ if (!SvOK(ST(0))) {
+ log_err("Collectd::plugin_unregister_%s(pluginname): "
+ "Invalid pluginname",
+ desc);
+ XSRETURN_EMPTY;
+ }
+
+ log_debug("Collectd::plugin_unregister_%s: plugin = \"%s\"", desc,
+ SvPV_nolen(ST(0)));
+
+ unreg(SvPV_nolen(ST(0)));
+
+ XSRETURN_EMPTY;
+
+ return;
+} /* static void _plugin_unregister_generic ( ... ) */
+
+/*
+ * Collectd::plugin_unregister_TYPE (pluginname).
+ *
+ * TYPE:
+ * type of callback to be unregistered: read, write, log, notification, flush
+ *
+ * pluginname:
+ * name of the perl plugin
+ */
+
+static XS(Collectd_plugin_unregister_read) {
+ return _plugin_unregister_generic(aTHX, plugin_unregister_read, "read");
+}
+
+static XS(Collectd_plugin_unregister_write) {
+ return _plugin_unregister_generic(aTHX, plugin_unregister_write, "write");
+}
+
+static XS(Collectd_plugin_unregister_log) {
+ return _plugin_unregister_generic(aTHX, plugin_unregister_log, "log");
+}
+
+static XS(Collectd_plugin_unregister_notification) {
+ return _plugin_unregister_generic(aTHX, plugin_unregister_notification,
+ "notification");
+}
+
+static XS(Collectd_plugin_unregister_flush) {
+ return _plugin_unregister_generic(aTHX, plugin_unregister_flush, "flush");
+}
+
/*
* Collectd::plugin_register_data_set (type, dataset).
*
/* Lock the base thread to avoid race conditions with c_ithread_create().
* See https://github.com/collectd/collectd/issues/9 and
* https://github.com/collectd/collectd/issues/1706 for details.
- */
+ */
assert(aTHX == perl_threads->head->interp);
pthread_mutex_lock(&perl_threads->mutex);
- status = pplugin_call_all(aTHX_ PLUGIN_INIT);
+ status = pplugin_call(aTHX_ PLUGIN_INIT);
pthread_mutex_unlock(&perl_threads->mutex);
return status;
} /* static int perl_init (void) */
-static int perl_read(void) {
+static int perl_read(user_data_t *user_data) {
dTHX;
if (NULL == perl_threads)
log_debug("perl_read: c_ithread: interp = %p (active threads: %i)", aTHX,
perl_threads->number_of_threads);
- return pplugin_call_all(aTHX_ PLUGIN_READ);
-} /* static int perl_read (void) */
+
+ return pplugin_call(aTHX_ PLUGIN_READ, user_data->data);
+} /* static int perl_read (user_data_t *user_data) */
static int perl_write(const data_set_t *ds, const value_list_t *vl,
- user_data_t __attribute__((unused)) * user_data) {
+ user_data_t *user_data) {
int status;
dTHX;
log_debug("perl_write: c_ithread: interp = %p (active threads: %i)", aTHX,
perl_threads->number_of_threads);
- status = pplugin_call_all(aTHX_ PLUGIN_WRITE, ds, vl);
+ status = pplugin_call(aTHX_ PLUGIN_WRITE, user_data->data, ds, vl);
if (aTHX == perl_threads->head->interp)
pthread_mutex_unlock(&perl_threads->mutex);
return status;
} /* static int perl_write (const data_set_t *, const value_list_t *) */
-static void perl_log(int level, const char *msg,
- user_data_t __attribute__((unused)) * user_data) {
+static void perl_log(int level, const char *msg, user_data_t *user_data) {
dTHX;
if (NULL == perl_threads)
/* Lock the base thread if this is not called from one of the read threads
* to avoid race conditions with c_ithread_create(). See
* https://github.com/collectd/collectd/issues/9 for details.
- */
+ */
if (aTHX == perl_threads->head->interp)
pthread_mutex_lock(&perl_threads->mutex);
- pplugin_call_all(aTHX_ PLUGIN_LOG, level, msg);
+ pplugin_call(aTHX_ PLUGIN_LOG, user_data->data, level, msg);
if (aTHX == perl_threads->head->interp)
pthread_mutex_unlock(&perl_threads->mutex);
return;
} /* static void perl_log (int, const char *) */
-static int perl_notify(const notification_t *notif,
- user_data_t __attribute__((unused)) * user_data) {
+static int perl_notify(const notification_t *notif, user_data_t *user_data) {
dTHX;
if (NULL == perl_threads)
aTHX = t->interp;
}
- return pplugin_call_all(aTHX_ PLUGIN_NOTIF, notif);
+ return pplugin_call(aTHX_ PLUGIN_NOTIF, user_data->data, notif);
} /* static int perl_notify (const notification_t *) */
static int perl_flush(cdtime_t timeout, const char *identifier,
- user_data_t __attribute__((unused)) * user_data) {
+ user_data_t *user_data) {
dTHX;
if (NULL == perl_threads)
aTHX = t->interp;
}
- return pplugin_call_all(aTHX_ PLUGIN_FLUSH, timeout, identifier);
+
+ /* For collectd-5.6 only, #1731 */
+ if (user_data == NULL || user_data->data == NULL)
+ return pplugin_call(aTHX_ PLUGIN_FLUSH_ALL, timeout, identifier);
+
+ return pplugin_call(aTHX_ PLUGIN_FLUSH, user_data->data, timeout, identifier);
} /* static int perl_flush (const int) */
static int perl_shutdown(void) {
dTHX;
plugin_unregister_complex_config("perl");
+ plugin_unregister_read_group("perl");
if (NULL == perl_threads)
return 0;
log_debug("perl_shutdown: c_ithread: interp = %p (active threads: %i)", aTHX,
perl_threads->number_of_threads);
- plugin_unregister_log("perl");
- plugin_unregister_notification("perl");
plugin_unregister_init("perl");
- plugin_unregister_read("perl");
- plugin_unregister_write("perl");
- plugin_unregister_flush("perl");
+ plugin_unregister_flush("perl"); /* For collectd-5.6 only, #1731 */
- ret = pplugin_call_all(aTHX_ PLUGIN_SHUTDOWN);
+ ret = pplugin_call(aTHX_ PLUGIN_SHUTDOWN);
pthread_mutex_lock(&perl_threads->mutex);
t = perl_threads->tail;
return 0;
} /* static int g_interval_set (pTHX_ SV *, MAGIC *) */
-static MGVTBL g_pv_vtbl = {g_pv_get, g_pv_set, NULL, NULL, NULL, NULL, NULL
+static MGVTBL g_pv_vtbl = {g_pv_get,
+ g_pv_set,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL
#if HAVE_PERL_STRUCT_MGVTBL_SVT_LOCAL
,
NULL
#endif
};
-static MGVTBL g_interval_vtbl = {g_interval_get, g_interval_set, NULL, NULL,
- NULL, NULL, NULL
+static MGVTBL g_interval_vtbl = {g_interval_get,
+ g_interval_set,
+ NULL,
+ NULL,
+ NULL,
+ NULL,
+ NULL
#if HAVE_PERL_STRUCT_MGVTBL_SVT_LOCAL
,
NULL
* accessing any such variable (this is basically the same as using
* tie() in Perl) */
/* global strings */
+ struct {
+ char name[64];
+ char *var;
+ } g_strings[] = {{"Collectd::hostname_g", hostname_g}, {"", NULL}};
+
for (int i = 0; '\0' != g_strings[i].name[0]; ++i) {
tmp = get_sv(g_strings[i].name, 1);
sv_magicext(tmp, NULL, PERL_MAGIC_ext, &g_pv_vtbl, g_strings[i].var, 0);
perl_run(aTHX);
- plugin_register_log("perl", perl_log, /* user_data = */ NULL);
- plugin_register_notification("perl", perl_notify,
- /* user_data = */ NULL);
plugin_register_init("perl", perl_init);
-
- plugin_register_read("perl", perl_read);
-
- plugin_register_write("perl", perl_write, /* user_data = */ NULL);
- plugin_register_flush("perl", perl_flush, /* user_data = */ NULL);
plugin_register_shutdown("perl", perl_shutdown);
return 0;
} /* static int init_pi (const char **, const int) */
if (NULL == get_module_name(module_name, sizeof(module_name), value)) {
log_err("Invalid module name %s", value);
- return (1);
+ return 1;
}
if (0 != init_pi(perl_argc, perl_argv))
current_status = perl_config_includedir(aTHX_ c);
else if (0 == strcasecmp(c->key, "Plugin"))
current_status = perl_config_plugin(aTHX_ c);
+ else if (0 == strcasecmp(c->key, "RegisterLegacyFlush"))
+ cf_util_get_boolean(c, ®ister_legacy_flush);
else {
log_warn("Ignoring unknown config key \"%s\".", c->key);
current_status = 0;
plugin_register_complex_config("perl", perl_config);
return;
} /* void module_register (void) */
-
-/* vim: set sw=4 ts=4 tw=78 noexpandtab : */
projects / collectd.git / blobdiff