2 * collectd - src/python.c
3 * Copyright (C) 2009 Sven Trenkel
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
24 * Sven Trenkel <collectd at semidefinite.de>
28 #include <structmember.h>
40 typedef struct cpy_callback_s {
44 struct cpy_callback_s *next;
47 static char log_doc[] = "This function sends a string to all logging plugins.";
49 static char flush_doc[] = "flush([plugin][, timeout][, identifier]) -> None\n"
51 "Flushes the cache of another plugin.";
53 static char unregister_doc[] = "Unregisters a callback. This function needs exactly one parameter either\n"
54 "the function to unregister or the callback identifier to unregister.";
56 static char reg_log_doc[] = "register_log(callback[, data][, name]) -> identifier\n"
58 "Register a callback function for log messages.\n"
60 "'callback' is a callable object that will be called every time something\n"
62 "'data' is an optional object that will be passed back to the callback\n"
63 " function every time it is called.\n"
64 "'name' is an optional identifier for this callback. The default name\n"
65 " is 'python.<module>'.\n"
66 " Every callback needs a unique identifier, so if you want to\n"
67 " register this callback multiple time from the same module you need\n"
68 " to specify a name here.\n"
69 "'identifier' is the full identifier assigned to this callback.\n"
71 "The callback function will be called with two or three parameters:\n"
72 "severity: An integer that should be compared to the LOG_ constants.\n"
73 "message: The text to be logged.\n"
74 "data: The optional data parameter passed to the register function.\n"
75 " If the parameter was omitted it will be omitted here, too.";
77 static char reg_init_doc[] = "register_init(callback[, data][, name]) -> identifier\n"
79 "Register a callback function that will be executed once after the config.\n"
80 "file has been read, all plugins heve been loaded and the collectd has\n"
81 "forked into the background.\n"
83 "'callback' is a callable object that will be executed.\n"
84 "'data' is an optional object that will be passed back to the callback\n"
85 " function when it is called.\n"
86 "'name' is an optional identifier for this callback. The default name\n"
87 " is 'python.<module>'.\n"
88 " Every callback needs a unique identifier, so if you want to\n"
89 " register this callback multiple time from the same module you need\n"
90 " to specify a name here.\n"
91 "'identifier' is the full identifier assigned to this callback.\n"
93 "The callback function will be called without parameters, except for\n"
94 "data if it was supplied.";
96 static char reg_config_doc[] = "register_config(callback[, data][, name]) -> identifier\n"
98 "Register a callback function for config file entries.\n"
99 "'callback' is a callable object that will be called for every config block.\n"
100 "'data' is an optional object that will be passed back to the callback\n"
101 " function every time it is called.\n"
102 "'name' is an optional identifier for this callback. The default name\n"
103 " is 'python.<module>'.\n"
104 " Every callback needs a unique identifier, so if you want to\n"
105 " register this callback multiple time from the same module you need\n"
106 " to specify a name here.\n"
107 "'identifier' is the full identifier assigned to this callback.\n"
109 "The callback function will be called with one or two parameters:\n"
110 "config: A Config object.\n"
111 "data: The optional data parameter passed to the register function.\n"
112 " If the parameter was omitted it will be omitted here, too.";
114 static char reg_read_doc[] = "register_read(callback[, interval][, data][, name]) -> identifier\n"
116 "Register a callback function for reading data. It will just be called\n"
117 "in a fixed interval to signal that it's time to dispatch new values.\n"
118 "'callback' is a callable object that will be called every time something\n"
120 "'interval' is the number of seconds between between calls to the callback\n"
121 " function. Full float precision is supported here.\n"
122 "'data' is an optional object that will be passed back to the callback\n"
123 " function every time it is called.\n"
124 "'name' is an optional identifier for this callback. The default name\n"
125 " is 'python.<module>'.\n"
126 " Every callback needs a unique identifier, so if you want to\n"
127 " register this callback multiple time from the same module you need\n"
128 " to specify a name here.\n"
129 "'identifier' is the full identifier assigned to this callback.\n"
131 "The callback function will be called without parameters, except for\n"
132 "data if it was supplied.";
134 static char reg_write_doc[] = "register_write(callback[, data][, name]) -> identifier\n"
136 "Register a callback function to receive values dispatched by other plugins.\n"
137 "'callback' is a callable object that will be called every time a value\n"
139 "'data' is an optional object that will be passed back to the callback\n"
140 " function every time it is called.\n"
141 "'name' is an optional identifier for this callback. The default name\n"
142 " is 'python.<module>'.\n"
143 " Every callback needs a unique identifier, so if you want to\n"
144 " register this callback multiple time from the same module you need\n"
145 " to specify a name here.\n"
146 "'identifier' is the full identifier assigned to this callback.\n"
148 "The callback function will be called with one or two parameters:\n"
149 "values: A Values object which is a copy of the dispatched values.\n"
150 "data: The optional data parameter passed to the register function.\n"
151 " If the parameter was omitted it will be omitted here, too.";
153 static char reg_notification_doc[] = "register_notification(callback[, data][, name]) -> identifier\n"
155 "Register a callback function for notifications.\n"
156 "'callback' is a callable object that will be called every time a notification\n"
158 "'data' is an optional object that will be passed back to the callback\n"
159 " function every time it is called.\n"
160 "'name' is an optional identifier for this callback. The default name\n"
161 " is 'python.<module>'.\n"
162 " Every callback needs a unique identifier, so if you want to\n"
163 " register this callback multiple time from the same module you need\n"
164 " to specify a name here.\n"
165 "'identifier' is the full identifier assigned to this callback.\n"
167 "The callback function will be called with one or two parameters:\n"
168 "notification: A copy of the notification that was dispatched.\n"
169 "data: The optional data parameter passed to the register function.\n"
170 " If the parameter was omitted it will be omitted here, too.";
172 static char reg_flush_doc[] = "register_flush(callback[, data][, name]) -> identifier\n"
174 "Register a callback function for flush messages.\n"
175 "'callback' is a callable object that will be called every time a plugin\n"
176 " requests a flush for either this or all plugins.\n"
177 "'data' is an optional object that will be passed back to the callback\n"
178 " function every time it is called.\n"
179 "'name' is an optional identifier for this callback. The default name\n"
180 " is 'python.<module>'.\n"
181 " Every callback needs a unique identifier, so if you want to\n"
182 " register this callback multiple time from the same module you need\n"
183 " to specify a name here.\n"
184 "'identifier' is the full identifier assigned to this callback.\n"
186 "The callback function will be called with two or three parameters:\n"
187 "timeout: Indicates that only data older than 'timeout' seconds is to\n"
189 "id: Specifies which values are to be flushed.\n"
190 "data: The optional data parameter passed to the register function.\n"
191 " If the parameter was omitted it will be omitted here, too.";
193 static char reg_shutdown_doc[] = "register_shutdown(callback[, data][, name]) -> identifier\n"
195 "Register a callback function for collectd shutdown.\n"
196 "'callback' is a callable object that will be called once collectd is\n"
198 "'data' is an optional object that will be passed back to the callback\n"
199 " function if it is called.\n"
200 "'name' is an optional identifier for this callback. The default name\n"
201 " is 'python.<module>'.\n"
202 " Every callback needs a unique identifier, so if you want to\n"
203 " register this callback multiple time from the same module you need\n"
204 " to specify a name here.\n"
205 "'identifier' is the full identifier assigned to this callback.\n"
207 "The callback function will be called with no parameters except for\n"
208 " data if it was supplied.";
211 static int do_interactive = 0;
213 /* This is our global thread state. Python saves some stuff in thread-local
214 * storage. So if we allow the interpreter to run in the background
215 * (the scriptwriters might have created some threads from python), we have
216 * to save the state so we can resume it later after shutdown. */
218 static PyThreadState *state;
220 static PyObject *sys_path, *cpy_format_exception;
222 static cpy_callback_t *cpy_config_callbacks;
223 static cpy_callback_t *cpy_init_callbacks;
224 static cpy_callback_t *cpy_shutdown_callbacks;
226 static void cpy_destroy_user_data(void *data) {
227 cpy_callback_t *c = data;
229 Py_DECREF(c->callback);
234 /* You must hold the GIL to call this function!
235 * But if you managed to extract the callback parameter then you probably already do. */
237 static void cpy_build_name(char *buf, size_t size, PyObject *callback, const char *name) {
238 const char *module = NULL;
239 PyObject *mod = NULL;
242 snprintf(buf, size, "python.%s", name);
246 mod = PyObject_GetAttrString(callback, "__module__"); /* New reference. */
248 module = cpy_unicode_or_bytes_to_string(&mod);
250 if (module != NULL) {
251 snprintf(buf, size, "python.%s", module);
258 snprintf(buf, size, "python.%p", callback);
262 void cpy_log_exception(const char *context) {
264 const char *typename = NULL, *message = NULL;
265 PyObject *type, *value, *traceback, *tn, *m, *list;
267 PyErr_Fetch(&type, &value, &traceback);
268 PyErr_NormalizeException(&type, &value, &traceback);
269 if (type == NULL) return;
270 tn = PyObject_GetAttrString(type, "__name__"); /* New reference. */
271 m = PyObject_Str(value); /* New reference. */
273 typename = cpy_unicode_or_bytes_to_string(&tn);
275 message = cpy_unicode_or_bytes_to_string(&m);
276 if (typename == NULL)
277 typename = "NamelessException";
280 Py_BEGIN_ALLOW_THREADS
281 ERROR("Unhandled python exception in %s: %s: %s", context, typename, message);
285 if (!cpy_format_exception) {
289 Py_XDECREF(traceback);
296 list = PyObject_CallFunction(cpy_format_exception, "NNN", type, value, traceback); /* New reference. */
298 l = PyObject_Length(list);
299 for (i = 0; i < l; ++i) {
303 line = PyList_GET_ITEM(list, i); /* Borrowed reference. */
305 s = strdup(cpy_unicode_or_bytes_to_string(&line));
307 if (s[strlen(s) - 1] == '\n')
308 s[strlen(s) - 1] = 0;
309 Py_BEGIN_ALLOW_THREADS
318 static int cpy_read_callback(user_data_t *data) {
319 cpy_callback_t *c = data->data;
323 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
325 cpy_log_exception("read callback");
335 static int cpy_write_callback(const data_set_t *ds, const value_list_t *value_list, user_data_t *data) {
337 cpy_callback_t *c = data->data;
338 PyObject *ret, *list, *temp, *dict = NULL, *val;
342 list = PyList_New(value_list->values_len); /* New reference. */
344 cpy_log_exception("write callback");
345 CPY_RETURN_FROM_THREADS 0;
347 for (i = 0; i < value_list->values_len; ++i) {
348 if (ds->ds[i].type == DS_TYPE_COUNTER) {
349 if ((long) value_list->values[i].counter == value_list->values[i].counter)
350 PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].counter));
352 PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].counter));
353 } else if (ds->ds[i].type == DS_TYPE_GAUGE) {
354 PyList_SetItem(list, i, PyFloat_FromDouble(value_list->values[i].gauge));
355 } else if (ds->ds[i].type == DS_TYPE_DERIVE) {
356 if ((long) value_list->values[i].derive == value_list->values[i].derive)
357 PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].derive));
359 PyList_SetItem(list, i, PyLong_FromLongLong(value_list->values[i].derive));
360 } else if (ds->ds[i].type == DS_TYPE_ABSOLUTE) {
361 if ((long) value_list->values[i].absolute == value_list->values[i].absolute)
362 PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].absolute));
364 PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].absolute));
366 Py_BEGIN_ALLOW_THREADS
367 ERROR("cpy_write_callback: Unknown value type %d.", ds->ds[i].type);
370 CPY_RETURN_FROM_THREADS 0;
372 if (PyErr_Occurred() != NULL) {
373 cpy_log_exception("value building for write callback");
375 CPY_RETURN_FROM_THREADS 0;
379 if (value_list->meta) {
382 meta_data_t *meta = value_list->meta;
384 num = meta_data_toc(meta, &table);
385 for (i = 0; i < num; ++i) {
393 type = meta_data_type(meta, table[i]);
394 if (type == MD_TYPE_STRING) {
395 if (meta_data_get_string(meta, table[i], &string))
397 temp = cpy_string_to_unicode_or_bytes(string);
399 PyDict_SetItemString(dict, table[i], temp);
401 } else if (type == MD_TYPE_SIGNED_INT) {
402 if (meta_data_get_signed_int(meta, table[i], &si))
404 temp = PyObject_CallFunctionObjArgs((void *) &SignedType, PyLong_FromLongLong(si), (void *) 0);
405 PyDict_SetItemString(dict, table[i], temp);
407 } else if (type == MD_TYPE_UNSIGNED_INT) {
408 if (meta_data_get_unsigned_int(meta, table[i], &ui))
410 temp = PyObject_CallFunctionObjArgs((void *) &UnsignedType, PyLong_FromUnsignedLongLong(ui), (void *) 0);
411 PyDict_SetItemString(dict, table[i], temp);
413 } else if (type == MD_TYPE_DOUBLE) {
414 if (meta_data_get_double(meta, table[i], &d))
416 temp = PyFloat_FromDouble(d);
417 PyDict_SetItemString(dict, table[i], temp);
419 } else if (type == MD_TYPE_BOOLEAN) {
420 if (meta_data_get_boolean(meta, table[i], &b))
423 PyDict_SetItemString(dict, table[i], Py_True);
425 PyDict_SetItemString(dict, table[i], Py_False);
431 val = Values_New(); /* New reference. */
433 sstrncpy(v->data.host, value_list->host, sizeof(v->data.host));
434 sstrncpy(v->data.type, value_list->type, sizeof(v->data.type));
435 sstrncpy(v->data.type_instance, value_list->type_instance, sizeof(v->data.type_instance));
436 sstrncpy(v->data.plugin, value_list->plugin, sizeof(v->data.plugin));
437 sstrncpy(v->data.plugin_instance, value_list->plugin_instance, sizeof(v->data.plugin_instance));
438 v->data.time = CDTIME_T_TO_DOUBLE(value_list->time);
439 v->interval = CDTIME_T_TO_DOUBLE(value_list->interval);
444 ret = PyObject_CallFunctionObjArgs(c->callback, v, c->data, (void *) 0); /* New reference. */
447 cpy_log_exception("write callback");
455 static int cpy_notification_callback(const notification_t *notification, user_data_t *data) {
456 cpy_callback_t *c = data->data;
457 PyObject *ret, *notify;
461 notify = Notification_New(); /* New reference. */
462 n = (Notification *) notify;
463 sstrncpy(n->data.host, notification->host, sizeof(n->data.host));
464 sstrncpy(n->data.type, notification->type, sizeof(n->data.type));
465 sstrncpy(n->data.type_instance, notification->type_instance, sizeof(n->data.type_instance));
466 sstrncpy(n->data.plugin, notification->plugin, sizeof(n->data.plugin));
467 sstrncpy(n->data.plugin_instance, notification->plugin_instance, sizeof(n->data.plugin_instance));
468 n->data.time = CDTIME_T_TO_DOUBLE(notification->time);
469 sstrncpy(n->message, notification->message, sizeof(n->message));
470 n->severity = notification->severity;
471 ret = PyObject_CallFunctionObjArgs(c->callback, n, c->data, (void *) 0); /* New reference. */
474 cpy_log_exception("notification callback");
482 static void cpy_log_callback(int severity, const char *message, user_data_t *data) {
483 cpy_callback_t * c = data->data;
484 PyObject *ret, *text;
487 text = cpy_string_to_unicode_or_bytes(message);
489 ret = PyObject_CallFunction(c->callback, "iN", severity, text); /* New reference. */
491 ret = PyObject_CallFunction(c->callback, "iNO", severity, text, c->data); /* New reference. */
495 /* Do we really want to trigger a log callback because a log callback failed?
498 /* In case someone wanted to be clever, replaced stderr and failed at that. */
506 static void cpy_flush_callback(int timeout, const char *id, user_data_t *data) {
507 cpy_callback_t * c = data->data;
508 PyObject *ret, *text;
511 text = cpy_string_to_unicode_or_bytes(id);
513 ret = PyObject_CallFunction(c->callback, "iN", timeout, text); /* New reference. */
515 ret = PyObject_CallFunction(c->callback, "iNO", timeout, text, c->data); /* New reference. */
518 cpy_log_exception("flush callback");
525 static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
528 const char *name = NULL;
529 PyObject *callback = NULL, *data = NULL, *mod = NULL;
530 static char *kwlist[] = {"callback", "data", "name", NULL};
532 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL;
533 if (PyCallable_Check(callback) == 0) {
534 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
537 cpy_build_name(buf, sizeof(buf), callback, name);
541 c = malloc(sizeof(*c));
542 c->name = strdup(buf);
543 c->callback = callback;
545 c->next = *list_head;
548 return cpy_string_to_unicode_or_bytes(buf);
551 static PyObject *cpy_flush(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
553 const char *plugin = NULL, *identifier = NULL;
554 static char *kwlist[] = {"plugin", "timeout", "identifier", NULL};
556 if (PyArg_ParseTupleAndKeywords(args, kwds, "|etiet", kwlist, NULL, &plugin, &timeout, NULL, &identifier) == 0) return NULL;
557 Py_BEGIN_ALLOW_THREADS
558 plugin_flush(plugin, timeout, identifier);
563 static PyObject *cpy_register_config(PyObject *self, PyObject *args, PyObject *kwds) {
564 return cpy_register_generic(&cpy_config_callbacks, args, kwds);
567 static PyObject *cpy_register_init(PyObject *self, PyObject *args, PyObject *kwds) {
568 return cpy_register_generic(&cpy_init_callbacks, args, kwds);
571 typedef int reg_function_t(const char *name, void *callback, void *data);
573 static PyObject *cpy_register_generic_userdata(void *reg, void *handler, PyObject *args, PyObject *kwds) {
575 reg_function_t *register_function = (reg_function_t *) reg;
576 cpy_callback_t *c = NULL;
577 user_data_t *user_data = NULL;
578 const char *name = NULL;
579 PyObject *callback = NULL, *data = NULL;
580 static char *kwlist[] = {"callback", "data", "name", NULL};
582 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL;
583 if (PyCallable_Check(callback) == 0) {
584 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
587 cpy_build_name(buf, sizeof(buf), callback, name);
591 c = malloc(sizeof(*c));
592 c->name = strdup(buf);
593 c->callback = callback;
596 user_data = malloc(sizeof(*user_data));
597 user_data->free_func = cpy_destroy_user_data;
599 register_function(buf, handler, user_data);
600 return cpy_string_to_unicode_or_bytes(buf);
603 static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwds) {
605 cpy_callback_t *c = NULL;
606 user_data_t *user_data = NULL;
608 const char *name = NULL;
609 PyObject *callback = NULL, *data = NULL;
611 static char *kwlist[] = {"callback", "interval", "data", "name", NULL};
613 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|dOet", kwlist, &callback, &interval, &data, NULL, &name) == 0) return NULL;
614 if (PyCallable_Check(callback) == 0) {
615 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
618 cpy_build_name(buf, sizeof(buf), callback, name);
622 c = malloc(sizeof(*c));
623 c->name = strdup(buf);
624 c->callback = callback;
627 user_data = malloc(sizeof(*user_data));
628 user_data->free_func = cpy_destroy_user_data;
630 ts.tv_sec = interval;
631 ts.tv_nsec = (interval - ts.tv_sec) * 1000000000;
632 plugin_register_complex_read(/* group = */ NULL, buf,
633 cpy_read_callback, &ts, user_data);
634 return cpy_string_to_unicode_or_bytes(buf);
637 static PyObject *cpy_register_log(PyObject *self, PyObject *args, PyObject *kwds) {
638 return cpy_register_generic_userdata((void *) plugin_register_log,
639 (void *) cpy_log_callback, args, kwds);
642 static PyObject *cpy_register_write(PyObject *self, PyObject *args, PyObject *kwds) {
643 return cpy_register_generic_userdata((void *) plugin_register_write,
644 (void *) cpy_write_callback, args, kwds);
647 static PyObject *cpy_register_notification(PyObject *self, PyObject *args, PyObject *kwds) {
648 return cpy_register_generic_userdata((void *) plugin_register_notification,
649 (void *) cpy_notification_callback, args, kwds);
652 static PyObject *cpy_register_flush(PyObject *self, PyObject *args, PyObject *kwds) {
653 return cpy_register_generic_userdata((void *) plugin_register_flush,
654 (void *) cpy_flush_callback, args, kwds);
657 static PyObject *cpy_register_shutdown(PyObject *self, PyObject *args, PyObject *kwds) {
658 return cpy_register_generic(&cpy_shutdown_callbacks, args, kwds);
661 static PyObject *cpy_error(PyObject *self, PyObject *args) {
663 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
664 Py_BEGIN_ALLOW_THREADS
665 plugin_log(LOG_ERR, "%s", text);
670 static PyObject *cpy_warning(PyObject *self, PyObject *args) {
672 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
673 Py_BEGIN_ALLOW_THREADS
674 plugin_log(LOG_WARNING, "%s", text);
679 static PyObject *cpy_notice(PyObject *self, PyObject *args) {
681 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
682 Py_BEGIN_ALLOW_THREADS
683 plugin_log(LOG_NOTICE, "%s", text);
688 static PyObject *cpy_info(PyObject *self, PyObject *args) {
690 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
691 Py_BEGIN_ALLOW_THREADS
692 plugin_log(LOG_INFO, "%s", text);
697 static PyObject *cpy_debug(PyObject *self, PyObject *args) {
700 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
701 Py_BEGIN_ALLOW_THREADS
702 plugin_log(LOG_DEBUG, "%s", text);
708 static PyObject *cpy_unregister_generic(cpy_callback_t **list_head, PyObject *arg, const char *desc) {
711 cpy_callback_t *prev = NULL, *tmp;
714 name = cpy_unicode_or_bytes_to_string(&arg);
717 if (!PyCallable_Check(arg)) {
718 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
722 cpy_build_name(buf, sizeof(buf), arg, NULL);
725 for (tmp = *list_head; tmp; prev = tmp, tmp = tmp->next)
726 if (strcmp(name, tmp->name) == 0)
731 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
734 /* Yes, this is actually save. To call this function the caller has to
735 * hold the GIL. Well, save as long as there is only one GIL anyway ... */
737 *list_head = tmp->next;
739 prev->next = tmp->next;
740 cpy_destroy_user_data(tmp);
744 typedef int cpy_unregister_function_t(const char *name);
746 static PyObject *cpy_unregister_generic_userdata(cpy_unregister_function_t *unreg, PyObject *arg, const char *desc) {
751 name = cpy_unicode_or_bytes_to_string(&arg);
754 if (!PyCallable_Check(arg)) {
755 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
759 cpy_build_name(buf, sizeof(buf), arg, NULL);
762 if (unreg(name) == 0) {
766 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
771 static PyObject *cpy_unregister_log(PyObject *self, PyObject *arg) {
772 return cpy_unregister_generic_userdata(plugin_unregister_log, arg, "log");
775 static PyObject *cpy_unregister_init(PyObject *self, PyObject *arg) {
776 return cpy_unregister_generic(&cpy_init_callbacks, arg, "init");
779 static PyObject *cpy_unregister_config(PyObject *self, PyObject *arg) {
780 return cpy_unregister_generic(&cpy_config_callbacks, arg, "config");
783 static PyObject *cpy_unregister_read(PyObject *self, PyObject *arg) {
784 return cpy_unregister_generic_userdata(plugin_unregister_read, arg, "read");
787 static PyObject *cpy_unregister_write(PyObject *self, PyObject *arg) {
788 return cpy_unregister_generic_userdata(plugin_unregister_write, arg, "write");
791 static PyObject *cpy_unregister_notification(PyObject *self, PyObject *arg) {
792 return cpy_unregister_generic_userdata(plugin_unregister_notification, arg, "notification");
795 static PyObject *cpy_unregister_flush(PyObject *self, PyObject *arg) {
796 return cpy_unregister_generic_userdata(plugin_unregister_flush, arg, "flush");
799 static PyObject *cpy_unregister_shutdown(PyObject *self, PyObject *arg) {
800 return cpy_unregister_generic(&cpy_shutdown_callbacks, arg, "shutdown");
803 static PyMethodDef cpy_methods[] = {
804 {"debug", cpy_debug, METH_VARARGS, log_doc},
805 {"info", cpy_info, METH_VARARGS, log_doc},
806 {"notice", cpy_notice, METH_VARARGS, log_doc},
807 {"warning", cpy_warning, METH_VARARGS, log_doc},
808 {"error", cpy_error, METH_VARARGS, log_doc},
809 {"flush", (PyCFunction) cpy_flush, METH_VARARGS | METH_KEYWORDS, flush_doc},
810 {"register_log", (PyCFunction) cpy_register_log, METH_VARARGS | METH_KEYWORDS, reg_log_doc},
811 {"register_init", (PyCFunction) cpy_register_init, METH_VARARGS | METH_KEYWORDS, reg_init_doc},
812 {"register_config", (PyCFunction) cpy_register_config, METH_VARARGS | METH_KEYWORDS, reg_config_doc},
813 {"register_read", (PyCFunction) cpy_register_read, METH_VARARGS | METH_KEYWORDS, reg_read_doc},
814 {"register_write", (PyCFunction) cpy_register_write, METH_VARARGS | METH_KEYWORDS, reg_write_doc},
815 {"register_notification", (PyCFunction) cpy_register_notification, METH_VARARGS | METH_KEYWORDS, reg_notification_doc},
816 {"register_flush", (PyCFunction) cpy_register_flush, METH_VARARGS | METH_KEYWORDS, reg_flush_doc},
817 {"register_shutdown", (PyCFunction) cpy_register_shutdown, METH_VARARGS | METH_KEYWORDS, reg_shutdown_doc},
818 {"unregister_log", cpy_unregister_log, METH_O, unregister_doc},
819 {"unregister_init", cpy_unregister_init, METH_O, unregister_doc},
820 {"unregister_config", cpy_unregister_config, METH_O, unregister_doc},
821 {"unregister_read", cpy_unregister_read, METH_O, unregister_doc},
822 {"unregister_write", cpy_unregister_write, METH_O, unregister_doc},
823 {"unregister_notification", cpy_unregister_notification, METH_O, unregister_doc},
824 {"unregister_flush", cpy_unregister_flush, METH_O, unregister_doc},
825 {"unregister_shutdown", cpy_unregister_shutdown, METH_O, unregister_doc},
829 static int cpy_shutdown(void) {
833 /* This can happen if the module was loaded but not configured. */
835 PyEval_RestoreThread(state);
837 for (c = cpy_shutdown_callbacks; c; c = c->next) {
838 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
840 cpy_log_exception("shutdown callback");
849 static void cpy_int_handler(int sig) {
853 static void *cpy_interactive(void *data) {
855 struct sigaction sig_int_action, old;
857 /* Signal handler in a plugin? Bad stuff, but the best way to
858 * handle it I guess. In an interactive session people will
859 * press Ctrl+C at some time, which will generate a SIGINT.
860 * This will cause collectd to shutdown, thus killing the
861 * interactive interpreter, and leaving the terminal in a
862 * mess. Chances are, this isn't what the user wanted to do.
864 * So this is the plan:
865 * 1. Block SIGINT in the main thread.
866 * 2. Install our own signal handler that does nothing.
867 * 3. Unblock SIGINT in the interactive thread.
869 * This will make sure that SIGINT won't kill collectd but
870 * still interrupt syscalls like sleep and pause.
871 * It does not raise a KeyboardInterrupt exception because so
872 * far nobody managed to figure out how to do that. */
873 memset (&sig_int_action, '\0', sizeof (sig_int_action));
874 sig_int_action.sa_handler = cpy_int_handler;
875 sigaction (SIGINT, &sig_int_action, &old);
877 sigemptyset(&sigset);
878 sigaddset(&sigset, SIGINT);
879 pthread_sigmask(SIG_UNBLOCK, &sigset, NULL);
880 PyEval_AcquireThread(state);
881 if (PyImport_ImportModule("readline") == NULL) {
882 /* This interactive session will suck. */
883 cpy_log_exception("interactive session init");
885 PyRun_InteractiveLoop(stdin, "<stdin>");
887 PyEval_ReleaseThread(state);
888 NOTICE("python: Interactive interpreter exited, stopping collectd ...");
889 /* Restore the original collectd SIGINT handler and raise SIGINT.
890 * The main thread still has SIGINT blocked and there's nothing we
891 * can do about that so this thread will handle it. But that's not
892 * important, except that it won't interrupt the main loop and so
893 * it might take a few seconds before collectd really shuts down. */
894 sigaction (SIGINT, &old, NULL);
900 static int cpy_init(void) {
903 static pthread_t thread;
906 if (!Py_IsInitialized()) {
907 WARNING("python: Plugin loaded but not configured.");
908 plugin_unregister_shutdown("python");
911 PyEval_InitThreads();
912 /* Now it's finally OK to use python threads. */
913 for (c = cpy_init_callbacks; c; c = c->next) {
914 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
916 cpy_log_exception("init callback");
920 sigemptyset(&sigset);
921 sigaddset(&sigset, SIGINT);
922 pthread_sigmask(SIG_BLOCK, &sigset, NULL);
923 state = PyEval_SaveThread();
924 if (do_interactive) {
925 if (pthread_create(&thread, NULL, cpy_interactive, NULL)) {
926 ERROR("python: Error creating thread for interactive interpreter.");
933 static PyObject *cpy_oconfig_to_pyconfig(oconfig_item_t *ci, PyObject *parent) {
935 PyObject *item, *values, *children, *tmp;
940 values = PyTuple_New(ci->values_num); /* New reference. */
941 for (i = 0; i < ci->values_num; ++i) {
942 if (ci->values[i].type == OCONFIG_TYPE_STRING) {
943 PyTuple_SET_ITEM(values, i, cpy_string_to_unicode_or_bytes(ci->values[i].value.string));
944 } else if (ci->values[i].type == OCONFIG_TYPE_NUMBER) {
945 PyTuple_SET_ITEM(values, i, PyFloat_FromDouble(ci->values[i].value.number));
946 } else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN) {
947 PyTuple_SET_ITEM(values, i, PyBool_FromLong(ci->values[i].value.boolean));
951 tmp = cpy_string_to_unicode_or_bytes(ci->key);
952 item = PyObject_CallFunction((void *) &ConfigType, "NONO", tmp, parent, values, Py_None);
955 children = PyTuple_New(ci->children_num); /* New reference. */
956 for (i = 0; i < ci->children_num; ++i) {
957 PyTuple_SET_ITEM(children, i, cpy_oconfig_to_pyconfig(ci->children + i, item));
959 tmp = ((Config *) item)->children;
960 ((Config *) item)->children = children;
966 static struct PyModuleDef collectdmodule = {
967 PyModuleDef_HEAD_INIT,
968 "collectd", /* name of module */
969 "The python interface to collectd", /* module documentation, may be NULL */
974 PyMODINIT_FUNC PyInit_collectd(void) {
975 return PyModule_Create(&collectdmodule);
979 static int cpy_init_python() {
985 /* Add a builtin module, before Py_Initialize */
986 PyImport_AppendInittab("collectd", PyInit_collectd);
991 PyType_Ready(&ConfigType);
992 PyType_Ready(&PluginDataType);
993 ValuesType.tp_base = &PluginDataType;
994 PyType_Ready(&ValuesType);
995 NotificationType.tp_base = &PluginDataType;
996 PyType_Ready(&NotificationType);
997 SignedType.tp_base = &PyLong_Type;
998 PyType_Ready(&SignedType);
999 UnsignedType.tp_base = &PyLong_Type;
1000 PyType_Ready(&UnsignedType);
1001 sys = PyImport_ImportModule("sys"); /* New reference. */
1003 cpy_log_exception("python initialization");
1006 sys_path = PyObject_GetAttrString(sys, "path"); /* New reference. */
1008 if (sys_path == NULL) {
1009 cpy_log_exception("python initialization");
1012 PySys_SetArgv(1, &argv);
1013 PyList_SetSlice(sys_path, 0, 1, NULL);
1016 module = PyImport_ImportModule("collectd");
1018 module = Py_InitModule("collectd", cpy_methods); /* Borrowed reference. */
1020 PyModule_AddObject(module, "Config", (void *) &ConfigType); /* Steals a reference. */
1021 PyModule_AddObject(module, "Values", (void *) &ValuesType); /* Steals a reference. */
1022 PyModule_AddObject(module, "Notification", (void *) &NotificationType); /* Steals a reference. */
1023 PyModule_AddObject(module, "Signed", (void *) &SignedType); /* Steals a reference. */
1024 PyModule_AddObject(module, "Unsigned", (void *) &UnsignedType); /* Steals a reference. */
1025 PyModule_AddIntConstant(module, "LOG_DEBUG", LOG_DEBUG);
1026 PyModule_AddIntConstant(module, "LOG_INFO", LOG_INFO);
1027 PyModule_AddIntConstant(module, "LOG_NOTICE", LOG_NOTICE);
1028 PyModule_AddIntConstant(module, "LOG_WARNING", LOG_WARNING);
1029 PyModule_AddIntConstant(module, "LOG_ERROR", LOG_ERR);
1030 PyModule_AddIntConstant(module, "NOTIF_FAILURE", NOTIF_FAILURE);
1031 PyModule_AddIntConstant(module, "NOTIF_WARNING", NOTIF_WARNING);
1032 PyModule_AddIntConstant(module, "NOTIF_OKAY", NOTIF_OKAY);
1036 static int cpy_config(oconfig_item_t *ci) {
1040 /* Ok in theory we shouldn't do initialization at this point
1041 * but we have to. In order to give python scripts a chance
1042 * to register a config callback we need to be able to execute
1043 * python code during the config callback so we have to start
1044 * the interpreter here. */
1045 /* Do *not* use the python "thread" module at this point! */
1047 if (!Py_IsInitialized() && cpy_init_python()) return 1;
1049 for (i = 0; i < ci->children_num; ++i) {
1050 oconfig_item_t *item = ci->children + i;
1052 if (strcasecmp(item->key, "Interactive") == 0) {
1053 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN)
1055 do_interactive = item->values[0].value.boolean;
1056 } else if (strcasecmp(item->key, "Encoding") == 0) {
1057 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_STRING)
1059 /* Why is this even necessary? And undocumented? */
1060 if (PyUnicode_SetDefaultEncoding(item->values[0].value.string))
1061 cpy_log_exception("setting default encoding");
1062 } else if (strcasecmp(item->key, "LogTraces") == 0) {
1063 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN)
1065 if (!item->values[0].value.boolean) {
1066 Py_XDECREF(cpy_format_exception);
1067 cpy_format_exception = NULL;
1070 if (cpy_format_exception)
1072 tb = PyImport_ImportModule("traceback"); /* New reference. */
1074 cpy_log_exception("python initialization");
1077 cpy_format_exception = PyObject_GetAttrString(tb, "format_exception"); /* New reference. */
1079 if (cpy_format_exception == NULL)
1080 cpy_log_exception("python initialization");
1081 } else if (strcasecmp(item->key, "ModulePath") == 0) {
1083 PyObject *dir_object;
1085 if (cf_util_get_string(item, &dir) != 0)
1087 dir_object = cpy_string_to_unicode_or_bytes(dir); /* New reference. */
1088 if (dir_object == NULL) {
1089 ERROR("python plugin: Unable to convert \"%s\" to "
1090 "a python object.", dir);
1092 cpy_log_exception("python initialization");
1095 if (PyList_Append(sys_path, dir_object) != 0) {
1096 ERROR("python plugin: Unable to append \"%s\" to "
1097 "python module path.", dir);
1098 cpy_log_exception("python initialization");
1100 Py_DECREF(dir_object);
1102 } else if (strcasecmp(item->key, "Import") == 0) {
1103 char *module_name = NULL;
1106 if (cf_util_get_string(item, &module_name) != 0)
1108 module = PyImport_ImportModule(module_name); /* New reference. */
1109 if (module == NULL) {
1110 ERROR("python plugin: Error importing module \"%s\".", module_name);
1111 cpy_log_exception("importing module");
1115 } else if (strcasecmp(item->key, "Module") == 0) {
1120 if (cf_util_get_string(item, &name) != 0)
1122 for (c = cpy_config_callbacks; c; c = c->next) {
1123 if (strcasecmp(c->name + 7, name) == 0)
1127 WARNING("python plugin: Found a configuration for the \"%s\" plugin, "
1128 "but the plugin isn't loaded or didn't register "
1129 "a configuration callback.", name);
1134 if (c->data == NULL)
1135 ret = PyObject_CallFunction(c->callback, "N",
1136 cpy_oconfig_to_pyconfig(item, NULL)); /* New reference. */
1138 ret = PyObject_CallFunction(c->callback, "NO",
1139 cpy_oconfig_to_pyconfig(item, NULL), c->data); /* New reference. */
1141 cpy_log_exception("loading module");
1145 WARNING("python plugin: Ignoring unknown config key \"%s\".", item->key);
1151 void module_register(void) {
1152 plugin_register_complex_config("python", cpy_config);
1153 plugin_register_init("python", cpy_init);
1154 plugin_register_shutdown("python", cpy_shutdown);