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 *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 static 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;
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->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->type == DS_TYPE_GAUGE) {
354 PyList_SetItem(list, i, PyFloat_FromDouble(value_list->values[i].gauge));
355 } else if (ds->ds->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->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->type);
370 CPY_RETURN_FROM_THREADS 0;
372 if (PyErr_Occurred() != NULL) {
373 cpy_log_exception("value building for write callback");
374 CPY_RETURN_FROM_THREADS 0;
377 v = PyObject_New(Values, (void *) &ValuesType);
378 sstrncpy(v->data.host, value_list->host, sizeof(v->data.host));
379 sstrncpy(v->data.type, value_list->type, sizeof(v->data.type));
380 sstrncpy(v->data.type_instance, value_list->type_instance, sizeof(v->data.type_instance));
381 sstrncpy(v->data.plugin, value_list->plugin, sizeof(v->data.plugin));
382 sstrncpy(v->data.plugin_instance, value_list->plugin_instance, sizeof(v->data.plugin_instance));
383 v->data.time = value_list->time;
384 v->interval = value_list->interval;
386 ret = PyObject_CallFunctionObjArgs(c->callback, v, c->data, (void *) 0); /* New reference. */
388 cpy_log_exception("write callback");
396 static int cpy_notification_callback(const notification_t *notification, user_data_t *data) {
397 cpy_callback_t *c = data->data;
402 n = PyObject_New(Notification, (void *) &NotificationType);
403 sstrncpy(n->data.host, notification->host, sizeof(n->data.host));
404 sstrncpy(n->data.type, notification->type, sizeof(n->data.type));
405 sstrncpy(n->data.type_instance, notification->type_instance, sizeof(n->data.type_instance));
406 sstrncpy(n->data.plugin, notification->plugin, sizeof(n->data.plugin));
407 sstrncpy(n->data.plugin_instance, notification->plugin_instance, sizeof(n->data.plugin_instance));
408 n->data.time = notification->time;
409 sstrncpy(n->message, notification->message, sizeof(n->message));
410 n->severity = notification->severity;
411 ret = PyObject_CallFunctionObjArgs(c->callback, n, c->data, (void *) 0); /* New reference. */
413 cpy_log_exception("notification callback");
421 static void cpy_log_callback(int severity, const char *message, user_data_t *data) {
422 cpy_callback_t * c = data->data;
423 PyObject *ret, *text;
426 text = cpy_string_to_unicode_or_bytes(message);
428 ret = PyObject_CallFunction(c->callback, "iN", severity, text); /* New reference. */
430 ret = PyObject_CallFunction(c->callback, "iNO", severity, text, c->data); /* New reference. */
434 /* Do we really want to trigger a log callback because a log callback failed?
437 /* In case someone wanted to be clever, replaced stderr and failed at that. */
445 static void cpy_flush_callback(int timeout, const char *id, user_data_t *data) {
446 cpy_callback_t * c = data->data;
447 PyObject *ret, *text;
450 text = cpy_string_to_unicode_or_bytes(id);
452 ret = PyObject_CallFunction(c->callback, "iN", timeout, text); /* New reference. */
454 ret = PyObject_CallFunction(c->callback, "iNO", timeout, text, c->data); /* New reference. */
457 cpy_log_exception("flush callback");
464 static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
467 const char *name = NULL;
468 PyObject *callback = NULL, *data = NULL, *mod = NULL;
469 static char *kwlist[] = {"callback", "data", "name", NULL};
471 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL;
472 if (PyCallable_Check(callback) == 0) {
473 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
476 cpy_build_name(buf, sizeof(buf), callback, name);
480 c = malloc(sizeof(*c));
481 c->name = strdup(buf);
482 c->callback = callback;
484 c->next = *list_head;
487 return cpy_string_to_unicode_or_bytes(buf);
490 static PyObject *cpy_flush(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) {
492 const char *plugin = NULL, *identifier = NULL;
493 static char *kwlist[] = {"plugin", "timeout", "identifier", NULL};
495 if (PyArg_ParseTupleAndKeywords(args, kwds, "|etiet", kwlist, NULL, &plugin, &timeout, NULL, &identifier) == 0) return NULL;
496 Py_BEGIN_ALLOW_THREADS
497 plugin_flush(plugin, timeout, identifier);
502 static PyObject *cpy_register_config(PyObject *self, PyObject *args, PyObject *kwds) {
503 return cpy_register_generic(&cpy_config_callbacks, args, kwds);
506 static PyObject *cpy_register_init(PyObject *self, PyObject *args, PyObject *kwds) {
507 return cpy_register_generic(&cpy_init_callbacks, args, kwds);
510 typedef int reg_function_t(const char *name, void *callback, void *data);
512 static PyObject *cpy_register_generic_userdata(void *reg, void *handler, PyObject *args, PyObject *kwds) {
514 reg_function_t *register_function = (reg_function_t *) reg;
515 cpy_callback_t *c = NULL;
516 user_data_t *user_data = NULL;
517 const char *name = NULL;
518 PyObject *callback = NULL, *data = NULL;
519 static char *kwlist[] = {"callback", "data", "name", NULL};
521 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL;
522 if (PyCallable_Check(callback) == 0) {
523 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
526 cpy_build_name(buf, sizeof(buf), callback, name);
530 c = malloc(sizeof(*c));
531 c->name = strdup(buf);
532 c->callback = callback;
535 user_data = malloc(sizeof(*user_data));
536 user_data->free_func = cpy_destroy_user_data;
538 register_function(buf, handler, user_data);
539 return cpy_string_to_unicode_or_bytes(buf);
542 static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwds) {
544 cpy_callback_t *c = NULL;
545 user_data_t *user_data = NULL;
547 const char *name = NULL;
548 PyObject *callback = NULL, *data = NULL;
550 static char *kwlist[] = {"callback", "interval", "data", "name", NULL};
552 if (PyArg_ParseTupleAndKeywords(args, kwds, "O|dOet", kwlist, &callback, &interval, &data, NULL, &name) == 0) return NULL;
553 if (PyCallable_Check(callback) == 0) {
554 PyErr_SetString(PyExc_TypeError, "callback needs a be a callable object.");
557 cpy_build_name(buf, sizeof(buf), callback, name);
561 c = malloc(sizeof(*c));
562 c->name = strdup(buf);
563 c->callback = callback;
566 user_data = malloc(sizeof(*user_data));
567 user_data->free_func = cpy_destroy_user_data;
569 ts.tv_sec = interval;
570 ts.tv_nsec = (interval - ts.tv_sec) * 1000000000;
571 plugin_register_complex_read(buf, cpy_read_callback, &ts, user_data);
572 return cpy_string_to_unicode_or_bytes(buf);
575 static PyObject *cpy_register_log(PyObject *self, PyObject *args, PyObject *kwds) {
576 return cpy_register_generic_userdata((void *) plugin_register_log,
577 (void *) cpy_log_callback, args, kwds);
580 static PyObject *cpy_register_write(PyObject *self, PyObject *args, PyObject *kwds) {
581 return cpy_register_generic_userdata((void *) plugin_register_write,
582 (void *) cpy_write_callback, args, kwds);
585 static PyObject *cpy_register_notification(PyObject *self, PyObject *args, PyObject *kwds) {
586 return cpy_register_generic_userdata((void *) plugin_register_notification,
587 (void *) cpy_notification_callback, args, kwds);
590 static PyObject *cpy_register_flush(PyObject *self, PyObject *args, PyObject *kwds) {
591 return cpy_register_generic_userdata((void *) plugin_register_flush,
592 (void *) cpy_flush_callback, args, kwds);
595 static PyObject *cpy_register_shutdown(PyObject *self, PyObject *args, PyObject *kwds) {
596 return cpy_register_generic(&cpy_shutdown_callbacks, args, kwds);
599 static PyObject *cpy_error(PyObject *self, PyObject *args) {
601 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
602 Py_BEGIN_ALLOW_THREADS
603 plugin_log(LOG_ERR, "%s", text);
608 static PyObject *cpy_warning(PyObject *self, PyObject *args) {
610 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
611 Py_BEGIN_ALLOW_THREADS
612 plugin_log(LOG_WARNING, "%s", text);
617 static PyObject *cpy_notice(PyObject *self, PyObject *args) {
619 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
620 Py_BEGIN_ALLOW_THREADS
621 plugin_log(LOG_NOTICE, "%s", text);
626 static PyObject *cpy_info(PyObject *self, PyObject *args) {
628 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
629 Py_BEGIN_ALLOW_THREADS
630 plugin_log(LOG_INFO, "%s", text);
635 static PyObject *cpy_debug(PyObject *self, PyObject *args) {
638 if (PyArg_ParseTuple(args, "et", NULL, &text) == 0) return NULL;
639 Py_BEGIN_ALLOW_THREADS
640 plugin_log(LOG_DEBUG, "%s", text);
646 static PyObject *cpy_unregister_generic(cpy_callback_t **list_head, PyObject *arg, const char *desc) {
649 cpy_callback_t *prev = NULL, *tmp;
652 name = cpy_unicode_or_bytes_to_string(&arg);
655 if (!PyCallable_Check(arg)) {
656 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
660 cpy_build_name(buf, sizeof(buf), arg, NULL);
663 for (tmp = *list_head; tmp; prev = tmp, tmp = tmp->next)
664 if (strcmp(name, tmp->name) == 0)
669 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
672 /* Yes, this is actually save. To call this function the caller has to
673 * hold the GIL. Well, save as long as there is only one GIL anyway ... */
675 *list_head = tmp->next;
677 prev->next = tmp->next;
678 cpy_destroy_user_data(tmp);
682 typedef int cpy_unregister_function_t(const char *name);
684 static PyObject *cpy_unregister_generic_userdata(cpy_unregister_function_t *unreg, PyObject *arg, const char *desc) {
689 name = cpy_unicode_or_bytes_to_string(&arg);
692 if (!PyCallable_Check(arg)) {
693 PyErr_SetString(PyExc_TypeError, "This function needs a string or a callable object as its only parameter.");
697 cpy_build_name(buf, sizeof(buf), arg, NULL);
700 if (unreg(name) == 0) {
704 PyErr_Format(PyExc_RuntimeError, "Unable to unregister %s callback '%s'.", desc, name);
709 static PyObject *cpy_unregister_log(PyObject *self, PyObject *arg) {
710 return cpy_unregister_generic_userdata(plugin_unregister_log, arg, "log");
713 static PyObject *cpy_unregister_init(PyObject *self, PyObject *arg) {
714 return cpy_unregister_generic(&cpy_init_callbacks, arg, "init");
717 static PyObject *cpy_unregister_config(PyObject *self, PyObject *arg) {
718 return cpy_unregister_generic(&cpy_config_callbacks, arg, "config");
721 static PyObject *cpy_unregister_read(PyObject *self, PyObject *arg) {
722 return cpy_unregister_generic_userdata(plugin_unregister_read, arg, "read");
725 static PyObject *cpy_unregister_write(PyObject *self, PyObject *arg) {
726 return cpy_unregister_generic_userdata(plugin_unregister_write, arg, "write");
729 static PyObject *cpy_unregister_notification(PyObject *self, PyObject *arg) {
730 return cpy_unregister_generic_userdata(plugin_unregister_notification, arg, "notification");
733 static PyObject *cpy_unregister_flush(PyObject *self, PyObject *arg) {
734 return cpy_unregister_generic_userdata(plugin_unregister_flush, arg, "flush");
737 static PyObject *cpy_unregister_shutdown(PyObject *self, PyObject *arg) {
738 return cpy_unregister_generic(&cpy_shutdown_callbacks, arg, "shutdown");
741 static PyMethodDef cpy_methods[] = {
742 {"debug", cpy_debug, METH_VARARGS, log_doc},
743 {"info", cpy_info, METH_VARARGS, log_doc},
744 {"notice", cpy_notice, METH_VARARGS, log_doc},
745 {"warning", cpy_warning, METH_VARARGS, log_doc},
746 {"error", cpy_error, METH_VARARGS, log_doc},
747 {"flush", (PyCFunction) cpy_flush, METH_VARARGS | METH_KEYWORDS, flush_doc},
748 {"register_log", (PyCFunction) cpy_register_log, METH_VARARGS | METH_KEYWORDS, reg_log_doc},
749 {"register_init", (PyCFunction) cpy_register_init, METH_VARARGS | METH_KEYWORDS, reg_init_doc},
750 {"register_config", (PyCFunction) cpy_register_config, METH_VARARGS | METH_KEYWORDS, reg_config_doc},
751 {"register_read", (PyCFunction) cpy_register_read, METH_VARARGS | METH_KEYWORDS, reg_read_doc},
752 {"register_write", (PyCFunction) cpy_register_write, METH_VARARGS | METH_KEYWORDS, reg_write_doc},
753 {"register_notification", (PyCFunction) cpy_register_notification, METH_VARARGS | METH_KEYWORDS, reg_notification_doc},
754 {"register_flush", (PyCFunction) cpy_register_flush, METH_VARARGS | METH_KEYWORDS, reg_flush_doc},
755 {"register_shutdown", (PyCFunction) cpy_register_shutdown, METH_VARARGS | METH_KEYWORDS, reg_shutdown_doc},
756 {"unregister_log", cpy_unregister_log, METH_O, unregister_doc},
757 {"unregister_init", cpy_unregister_init, METH_O, unregister_doc},
758 {"unregister_config", cpy_unregister_config, METH_O, unregister_doc},
759 {"unregister_read", cpy_unregister_read, METH_O, unregister_doc},
760 {"unregister_write", cpy_unregister_write, METH_O, unregister_doc},
761 {"unregister_notification", cpy_unregister_notification, METH_O, unregister_doc},
762 {"unregister_flush", cpy_unregister_flush, METH_O, unregister_doc},
763 {"unregister_shutdown", cpy_unregister_shutdown, METH_O, unregister_doc},
767 static int cpy_shutdown(void) {
771 /* This can happen if the module was loaded but not configured. */
773 PyEval_RestoreThread(state);
775 for (c = cpy_shutdown_callbacks; c; c = c->next) {
776 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
778 cpy_log_exception("shutdown callback");
787 static void cpy_int_handler(int sig) {
791 static void *cpy_interactive(void *data) {
793 struct sigaction sig_int_action, old;
795 /* Signal handler in a plugin? Bad stuff, but the best way to
796 * handle it I guess. In an interactive session people will
797 * press Ctrl+C at some time, which will generate a SIGINT.
798 * This will cause collectd to shutdown, thus killing the
799 * interactive interpreter, and leaving the terminal in a
800 * mess. Chances are, this isn't what the user wanted to do.
802 * So this is the plan:
803 * 1. Block SIGINT in the main thread.
804 * 2. Install our own signal handler that does nothing.
805 * 3. Unblock SIGINT in the interactive thread.
807 * This will make sure that SIGINT won't kill collectd but
808 * still interrupt syscalls like sleep and pause.
809 * It does not raise a KeyboardInterrupt exception because so
810 * far nobody managed to figure out how to do that. */
811 memset (&sig_int_action, '\0', sizeof (sig_int_action));
812 sig_int_action.sa_handler = cpy_int_handler;
813 sigaction (SIGINT, &sig_int_action, &old);
815 sigemptyset(&sigset);
816 sigaddset(&sigset, SIGINT);
817 pthread_sigmask(SIG_UNBLOCK, &sigset, NULL);
818 PyEval_AcquireThread(state);
819 if (PyImport_ImportModule("readline") == NULL) {
820 /* This interactive session will suck. */
821 cpy_log_exception("interactive session init");
823 PyRun_InteractiveLoop(stdin, "<stdin>");
825 PyEval_ReleaseThread(state);
826 NOTICE("python: Interactive interpreter exited, stopping collectd ...");
827 /* Restore the original collectd SIGINT handler and raise SIGINT.
828 * The main thread still has SIGINT blocked and there's nothing we
829 * can do about that so this thread will handle it. But that's not
830 * important, except that it won't interrupt the main loop and so
831 * it might take a few seconds before collectd really shuts down. */
832 sigaction (SIGINT, &old, NULL);
838 static int cpy_init(void) {
841 static pthread_t thread;
844 PyEval_InitThreads();
845 /* Now it's finally OK to use python threads. */
846 for (c = cpy_init_callbacks; c; c = c->next) {
847 ret = PyObject_CallFunctionObjArgs(c->callback, c->data, (void *) 0); /* New reference. */
849 cpy_log_exception("init callback");
853 sigemptyset(&sigset);
854 sigaddset(&sigset, SIGINT);
855 pthread_sigmask(SIG_BLOCK, &sigset, NULL);
856 state = PyEval_SaveThread();
857 if (do_interactive) {
858 if (pthread_create(&thread, NULL, cpy_interactive, NULL)) {
859 ERROR("python: Error creating thread for interactive interpreter.");
866 static PyObject *cpy_oconfig_to_pyconfig(oconfig_item_t *ci, PyObject *parent) {
868 PyObject *item, *values, *children, *tmp;
873 values = PyTuple_New(ci->values_num); /* New reference. */
874 for (i = 0; i < ci->values_num; ++i) {
875 if (ci->values[i].type == OCONFIG_TYPE_STRING) {
876 PyTuple_SET_ITEM(values, i, cpy_string_to_unicode_or_bytes(ci->values[i].value.string));
877 } else if (ci->values[i].type == OCONFIG_TYPE_NUMBER) {
878 PyTuple_SET_ITEM(values, i, PyFloat_FromDouble(ci->values[i].value.number));
879 } else if (ci->values[i].type == OCONFIG_TYPE_BOOLEAN) {
880 PyTuple_SET_ITEM(values, i, PyBool_FromLong(ci->values[i].value.boolean));
884 tmp = cpy_string_to_unicode_or_bytes(ci->key);
885 item = PyObject_CallFunction((void *) &ConfigType, "NONO", tmp, parent, values, Py_None);
888 children = PyTuple_New(ci->children_num); /* New reference. */
889 for (i = 0; i < ci->children_num; ++i) {
890 PyTuple_SET_ITEM(children, i, cpy_oconfig_to_pyconfig(ci->children + i, item));
892 tmp = ((Config *) item)->children;
893 ((Config *) item)->children = children;
899 static struct PyModuleDef collectdmodule = {
900 PyModuleDef_HEAD_INIT,
901 "collectd", /* name of module */
902 "The python interface to collectd", /* module documentation, may be NULL */
907 PyMODINIT_FUNC PyInit_collectd(void) {
908 return PyModule_Create(&collectdmodule);
912 static int cpy_config(oconfig_item_t *ci) {
918 /* Ok in theory we shouldn't do initialization at this point
919 * but we have to. In order to give python scripts a chance
920 * to register a config callback we need to be able to execute
921 * python code during the config callback so we have to start
922 * the interpreter here. */
923 /* Do *not* use the python "thread" module at this point! */
926 /* Add a builtin module, before Py_Initialize */
927 PyImport_AppendInittab("collectd", PyInit_collectd);
932 PyType_Ready(&ConfigType);
933 PyType_Ready(&PluginDataType);
934 ValuesType.tp_base = &PluginDataType;
935 PyType_Ready(&ValuesType);
936 NotificationType.tp_base = &PluginDataType;
937 PyType_Ready(&NotificationType);
938 sys = PyImport_ImportModule("sys"); /* New reference. */
940 cpy_log_exception("python initialization");
943 sys_path = PyObject_GetAttrString(sys, "path"); /* New reference. */
945 if (sys_path == NULL) {
946 cpy_log_exception("python initialization");
950 module = PyImport_ImportModule("collectd");
952 module = Py_InitModule("collectd", cpy_methods); /* Borrowed reference. */
954 PyModule_AddObject(module, "Config", (void *) &ConfigType); /* Steals a reference. */
955 PyModule_AddObject(module, "Values", (void *) &ValuesType); /* Steals a reference. */
956 PyModule_AddObject(module, "Notification", (void *) &NotificationType); /* Steals a reference. */
957 PyModule_AddIntConstant(module, "LOG_DEBUG", LOG_DEBUG);
958 PyModule_AddIntConstant(module, "LOG_INFO", LOG_INFO);
959 PyModule_AddIntConstant(module, "LOG_NOTICE", LOG_NOTICE);
960 PyModule_AddIntConstant(module, "LOG_WARNING", LOG_WARNING);
961 PyModule_AddIntConstant(module, "LOG_ERROR", LOG_ERR);
962 PyModule_AddIntConstant(module, "NOTIF_FAILURE", NOTIF_FAILURE);
963 PyModule_AddIntConstant(module, "NOTIF_WARNING", NOTIF_WARNING);
964 PyModule_AddIntConstant(module, "NOTIF_OKAY", NOTIF_OKAY);
965 for (i = 0; i < ci->children_num; ++i) {
966 oconfig_item_t *item = ci->children + i;
968 if (strcasecmp(item->key, "Interactive") == 0) {
969 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN)
971 do_interactive = item->values[0].value.boolean;
972 } else if (strcasecmp(item->key, "Encoding") == 0) {
973 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_STRING)
975 /* Why is this even necessary? And undocumented? */
976 if (PyUnicode_SetDefaultEncoding(item->values[0].value.string))
977 cpy_log_exception("setting default encoding");
978 } else if (strcasecmp(item->key, "LogTraces") == 0) {
979 if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN)
981 if (!item->values[0].value.boolean) {
982 Py_XDECREF(cpy_format_exception);
983 cpy_format_exception = NULL;
986 if (cpy_format_exception)
988 tb = PyImport_ImportModule("traceback"); /* New reference. */
990 cpy_log_exception("python initialization");
993 cpy_format_exception = PyObject_GetAttrString(tb, "format_exception"); /* New reference. */
995 if (cpy_format_exception == NULL)
996 cpy_log_exception("python initialization");
997 } else if (strcasecmp(item->key, "ModulePath") == 0) {
999 PyObject *dir_object;
1001 if (cf_util_get_string(item, &dir) != 0)
1003 dir_object = cpy_string_to_unicode_or_bytes(dir); /* New reference. */
1004 if (dir_object == NULL) {
1005 ERROR("python plugin: Unable to convert \"%s\" to "
1006 "a python object.", dir);
1008 cpy_log_exception("python initialization");
1011 if (PyList_Append(sys_path, dir_object) != 0) {
1012 ERROR("python plugin: Unable to append \"%s\" to "
1013 "python module path.", dir);
1014 cpy_log_exception("python initialization");
1016 Py_DECREF(dir_object);
1018 } else if (strcasecmp(item->key, "Import") == 0) {
1019 char *module_name = NULL;
1022 if (cf_util_get_string(item, &module_name) != 0)
1024 module = PyImport_ImportModule(module_name); /* New reference. */
1025 if (module == NULL) {
1026 ERROR("python plugin: Error importing module \"%s\".", module_name);
1027 cpy_log_exception("importing module");
1031 } else if (strcasecmp(item->key, "Module") == 0) {
1036 if (cf_util_get_string(item, &name) != 0)
1038 for (c = cpy_config_callbacks; c; c = c->next) {
1039 if (strcasecmp(c->name + 7, name) == 0)
1043 WARNING("python plugin: Found a configuration for the \"%s\" plugin, "
1044 "but the plugin isn't loaded or didn't register "
1045 "a configuration callback.", name);
1050 if (c->data == NULL)
1051 ret = PyObject_CallFunction(c->callback, "N",
1052 cpy_oconfig_to_pyconfig(item, NULL)); /* New reference. */
1054 ret = PyObject_CallFunction(c->callback, "NO",
1055 cpy_oconfig_to_pyconfig(item, NULL), c->data); /* New reference. */
1057 cpy_log_exception("loading module");
1061 WARNING("python plugin: Ignoring unknown config key \"%s\".", item->key);
1064 Py_DECREF(sys_path);
1068 void module_register(void) {
1069 plugin_register_complex_config("python", cpy_config);
1070 plugin_register_init("python", cpy_init);
1071 plugin_register_shutdown("python", cpy_shutdown);