X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=src%2Fpython.c;h=1ed6dc0165b0c5477b55d7c05f2f77eba8a8c261;hb=72a76347831a848e6722d9147297a1e03c4c01d8;hp=d16f739c861a1891d5a90d7dfdf2338497ea45a0;hpb=89fc8d1d16779841bd693020d9035aa5f35f127d;p=collectd.git diff --git a/src/python.c b/src/python.c index d16f739c..1ed6dc01 100644 --- a/src/python.c +++ b/src/python.c @@ -21,7 +21,7 @@ * DEALINGS IN THE SOFTWARE. * * Authors: - * Sven Trenkel + * Sven Trenkel **/ #include @@ -46,6 +46,19 @@ typedef struct cpy_callback_s { static char log_doc[] = "This function sends a string to all logging plugins."; +static char get_ds_doc[] = "get_dataset(name) -> definition\n" + "\n" + "Returns the definition of a dataset specified by name.\n" + "\n" + "'name' is a string specifying the dataset to query.\n" + "'definition' is a list of 4-tuples. Every tuple represents a \n" + " data source within the data set and its 4 values are the \n" + " name, type, min and max value.\n" + " 'name' is a string.\n" + " 'type' is a string that is equal to either DS_TYPE_COUNTER,\n" + " DS_TYPE_GAUGE, DS_TYPE_DERIVE or DS_TYPE_ABSOLUTE.\n" + " 'min' and 'max' are either a float or None."; + static char flush_doc[] = "flush([plugin][, timeout][, identifier]) -> None\n" "\n" "Flushes the cache of another plugin."; @@ -237,16 +250,16 @@ static void cpy_destroy_user_data(void *data) { static void cpy_build_name(char *buf, size_t size, PyObject *callback, const char *name) { const char *module = NULL; PyObject *mod = NULL; - + if (name != NULL) { snprintf(buf, size, "python.%s", name); return; } - + mod = PyObject_GetAttrString(callback, "__module__"); /* New reference. */ if (mod != NULL) module = cpy_unicode_or_bytes_to_string(&mod); - + if (module != NULL) { snprintf(buf, size, "python.%s", module); Py_XDECREF(mod); @@ -254,7 +267,7 @@ static void cpy_build_name(char *buf, size_t size, PyObject *callback, const cha return; } Py_XDECREF(mod); - + snprintf(buf, size, "python.%p", callback); PyErr_Clear(); } @@ -263,7 +276,7 @@ void cpy_log_exception(const char *context) { int l = 0, i; const char *typename = NULL, *message = NULL; PyObject *type, *value, *traceback, *tn, *m, *list; - + PyErr_Fetch(&type, &value, &traceback); PyErr_NormalizeException(&type, &value, &traceback); if (type == NULL) return; @@ -342,7 +355,7 @@ static int cpy_read_callback(user_data_t *data) { } static int cpy_write_callback(const data_set_t *ds, const value_list_t *value_list, user_data_t *data) { - int i; + size_t i; cpy_callback_t *c = data->data; PyObject *ret, *list, *temp, *dict = NULL; Values *v; @@ -355,22 +368,13 @@ static int cpy_write_callback(const data_set_t *ds, const value_list_t *value_li } for (i = 0; i < value_list->values_len; ++i) { if (ds->ds[i].type == DS_TYPE_COUNTER) { - if ((long) value_list->values[i].counter == value_list->values[i].counter) - PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].counter)); - else - PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].counter)); + PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].counter)); } else if (ds->ds[i].type == DS_TYPE_GAUGE) { PyList_SetItem(list, i, PyFloat_FromDouble(value_list->values[i].gauge)); } else if (ds->ds[i].type == DS_TYPE_DERIVE) { - if ((long) value_list->values[i].derive == value_list->values[i].derive) - PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].derive)); - else - PyList_SetItem(list, i, PyLong_FromLongLong(value_list->values[i].derive)); + PyList_SetItem(list, i, PyLong_FromLongLong(value_list->values[i].derive)); } else if (ds->ds[i].type == DS_TYPE_ABSOLUTE) { - if ((long) value_list->values[i].absolute == value_list->values[i].absolute) - PyList_SetItem(list, i, PyInt_FromLong(value_list->values[i].absolute)); - else - PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].absolute)); + PyList_SetItem(list, i, PyLong_FromUnsignedLongLong(value_list->values[i].absolute)); } else { Py_BEGIN_ALLOW_THREADS ERROR("cpy_write_callback: Unknown value type %d.", ds->ds[i].type); @@ -398,7 +402,7 @@ static int cpy_write_callback(const data_set_t *ds, const value_list_t *value_li uint64_t ui; double d; _Bool b; - + type = meta_data_type(meta, table[i]); if (type == MD_TYPE_STRING) { if (meta_data_get_string(meta, table[i], &string)) @@ -536,7 +540,7 @@ static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args char *name = NULL; PyObject *callback = NULL, *data = NULL, *mod = NULL; static char *kwlist[] = {"callback", "data", "name", NULL}; - + if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL; if (PyCallable_Check(callback) == 0) { PyMem_Free(name); @@ -548,10 +552,9 @@ static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args Py_INCREF(callback); Py_XINCREF(data); - c = malloc(sizeof(*c)); + c = calloc(1, sizeof(*c)); if (c == NULL) return NULL; - memset (c, 0, sizeof (*c)); c->name = strdup(buf); c->callback = callback; @@ -563,11 +566,43 @@ static PyObject *cpy_register_generic(cpy_callback_t **list_head, PyObject *args return cpy_string_to_unicode_or_bytes(buf); } -static PyObject *cpy_flush(cpy_callback_t **list_head, PyObject *args, PyObject *kwds) { +static PyObject *float_or_none(float number) { + if (isnan(number)) { + Py_RETURN_NONE; + } + return PyFloat_FromDouble(number); +} + +static PyObject *cpy_get_dataset(PyObject *self, PyObject *args) { + size_t i; + char *name; + const data_set_t *ds; + PyObject *list, *tuple; + + if (PyArg_ParseTuple(args, "et", NULL, &name) == 0) return NULL; + ds = plugin_get_ds(name); + PyMem_Free(name); + if (ds == NULL) { + PyErr_Format(PyExc_TypeError, "Dataset %s not found", name); + return NULL; + } + list = PyList_New(ds->ds_num); /* New reference. */ + for (i = 0; i < ds->ds_num; ++i) { + tuple = PyTuple_New(4); + PyTuple_SET_ITEM(tuple, 0, cpy_string_to_unicode_or_bytes(ds->ds[i].name)); + PyTuple_SET_ITEM(tuple, 1, cpy_string_to_unicode_or_bytes(DS_TYPE_TO_STRING(ds->ds[i].type))); + PyTuple_SET_ITEM(tuple, 2, float_or_none(ds->ds[i].min)); + PyTuple_SET_ITEM(tuple, 3, float_or_none(ds->ds[i].max)); + PyList_SET_ITEM(list, i, tuple); + } + return list; +} + +static PyObject *cpy_flush(PyObject *self, PyObject *args, PyObject *kwds) { int timeout = -1; char *plugin = NULL, *identifier = NULL; static char *kwlist[] = {"plugin", "timeout", "identifier", NULL}; - + if (PyArg_ParseTupleAndKeywords(args, kwds, "|etiet", kwlist, NULL, &plugin, &timeout, NULL, &identifier) == 0) return NULL; Py_BEGIN_ALLOW_THREADS plugin_flush(plugin, timeout, identifier); @@ -595,7 +630,7 @@ static PyObject *cpy_register_generic_userdata(void *reg, void *handler, PyObjec char *name = NULL; PyObject *callback = NULL, *data = NULL; static char *kwlist[] = {"callback", "data", "name", NULL}; - + if (PyArg_ParseTupleAndKeywords(args, kwds, "O|Oet", kwlist, &callback, &data, NULL, &name) == 0) return NULL; if (PyCallable_Check(callback) == 0) { PyMem_Free(name); @@ -604,14 +639,13 @@ static PyObject *cpy_register_generic_userdata(void *reg, void *handler, PyObjec } cpy_build_name(buf, sizeof(buf), callback, name); PyMem_Free(name); - + Py_INCREF(callback); Py_XINCREF(data); - c = malloc(sizeof(*c)); + c = calloc(1, sizeof(*c)); if (c == NULL) return NULL; - memset (c, 0, sizeof (*c)); c->name = strdup(buf); c->callback = callback; @@ -633,9 +667,8 @@ static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwd double interval = 0; char *name = NULL; PyObject *callback = NULL, *data = NULL; - struct timespec ts; static char *kwlist[] = {"callback", "interval", "data", "name", NULL}; - + if (PyArg_ParseTupleAndKeywords(args, kwds, "O|dOet", kwlist, &callback, &interval, &data, NULL, &name) == 0) return NULL; if (PyCallable_Check(callback) == 0) { PyMem_Free(name); @@ -644,14 +677,13 @@ static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwd } cpy_build_name(buf, sizeof(buf), callback, name); PyMem_Free(name); - + Py_INCREF(callback); Py_XINCREF(data); - c = malloc(sizeof(*c)); + c = calloc(1, sizeof(*c)); if (c == NULL) return NULL; - memset (c, 0, sizeof (*c)); c->name = strdup(buf); c->callback = callback; @@ -662,11 +694,8 @@ static PyObject *cpy_register_read(PyObject *self, PyObject *args, PyObject *kwd user_data.free_func = cpy_destroy_user_data; user_data.data = c; - ts.tv_sec = interval; - ts.tv_nsec = (interval - ts.tv_sec) * 1000000000; plugin_register_complex_read(/* group = */ "python", buf, - cpy_read_callback, &ts, &user_data); - + cpy_read_callback, DOUBLE_TO_CDTIME_T (interval), &user_data); return cpy_string_to_unicode_or_bytes(buf); } @@ -847,6 +876,7 @@ static PyMethodDef cpy_methods[] = { {"notice", cpy_notice, METH_VARARGS, log_doc}, {"warning", cpy_warning, METH_VARARGS, log_doc}, {"error", cpy_error, METH_VARARGS, log_doc}, + {"get_dataset", (PyCFunction) cpy_get_dataset, METH_VARARGS, get_ds_doc}, {"flush", (PyCFunction) cpy_flush, METH_VARARGS | METH_KEYWORDS, flush_doc}, {"register_log", (PyCFunction) cpy_register_log, METH_VARARGS | METH_KEYWORDS, reg_log_doc}, {"register_init", (PyCFunction) cpy_register_init, METH_VARARGS | METH_KEYWORDS, reg_init_doc}, @@ -870,7 +900,7 @@ static PyMethodDef cpy_methods[] = { static int cpy_shutdown(void) { cpy_callback_t *c; PyObject *ret; - + /* This can happen if the module was loaded but not configured. */ if (state != NULL) PyEval_RestoreThread(state); @@ -894,14 +924,14 @@ static void cpy_int_handler(int sig) { static void *cpy_interactive(void *data) { sigset_t sigset; struct sigaction sig_int_action, old; - + /* Signal handler in a plugin? Bad stuff, but the best way to * handle it I guess. In an interactive session people will * press Ctrl+C at some time, which will generate a SIGINT. * This will cause collectd to shutdown, thus killing the * interactive interpreter, and leaving the terminal in a * mess. Chances are, this isn't what the user wanted to do. - * + * * So this is the plan: * 1. Block SIGINT in the main thread. * 2. Install our own signal handler that does nothing. @@ -914,7 +944,7 @@ static void *cpy_interactive(void *data) { memset (&sig_int_action, '\0', sizeof (sig_int_action)); sig_int_action.sa_handler = cpy_int_handler; sigaction (SIGINT, &sig_int_action, &old); - + sigemptyset(&sigset); sigaddset(&sigset, SIGINT); pthread_sigmask(SIG_UNBLOCK, &sigset, NULL); @@ -943,7 +973,7 @@ static int cpy_init(void) { PyObject *ret; static pthread_t thread; sigset_t sigset; - + if (!Py_IsInitialized()) { WARNING("python: Plugin loaded but not configured."); plugin_unregister_shutdown("python"); @@ -974,10 +1004,10 @@ static int cpy_init(void) { static PyObject *cpy_oconfig_to_pyconfig(oconfig_item_t *ci, PyObject *parent) { int i; PyObject *item, *values, *children, *tmp; - + if (parent == NULL) parent = Py_None; - + values = PyTuple_New(ci->values_num); /* New reference. */ for (i = 0; i < ci->values_num; ++i) { if (ci->values[i].type == OCONFIG_TYPE_STRING) { @@ -988,7 +1018,7 @@ static PyObject *cpy_oconfig_to_pyconfig(oconfig_item_t *ci, PyObject *parent) { PyTuple_SET_ITEM(values, i, PyBool_FromLong(ci->values[i].value.boolean)); } } - + tmp = cpy_string_to_unicode_or_bytes(ci->key); item = PyObject_CallFunction((void *) &ConfigType, "NONO", tmp, parent, values, Py_None); if (item == NULL) @@ -1017,18 +1047,20 @@ PyMODINIT_FUNC PyInit_collectd(void) { } #endif -static int cpy_init_python() { - char *argv = ""; +static int cpy_init_python(void) { PyObject *sys; PyObject *module; #ifdef IS_PY3K + wchar_t *argv = L""; /* Add a builtin module, before Py_Initialize */ PyImport_AppendInittab("collectd", PyInit_collectd); +#else + char *argv = ""; #endif - + Py_Initialize(); - + PyType_Ready(&ConfigType); PyType_Ready(&PluginDataType); ValuesType.tp_base = &PluginDataType; @@ -1071,6 +1103,10 @@ static int cpy_init_python() { PyModule_AddIntConstant(module, "NOTIF_FAILURE", NOTIF_FAILURE); PyModule_AddIntConstant(module, "NOTIF_WARNING", NOTIF_WARNING); PyModule_AddIntConstant(module, "NOTIF_OKAY", NOTIF_OKAY); + PyModule_AddStringConstant(module, "DS_TYPE_COUNTER", DS_TYPE_TO_STRING(DS_TYPE_COUNTER)); + PyModule_AddStringConstant(module, "DS_TYPE_GAUGE", DS_TYPE_TO_STRING(DS_TYPE_GAUGE)); + PyModule_AddStringConstant(module, "DS_TYPE_DERIVE", DS_TYPE_TO_STRING(DS_TYPE_DERIVE)); + PyModule_AddStringConstant(module, "DS_TYPE_ABSOLUTE", DS_TYPE_TO_STRING(DS_TYPE_ABSOLUTE)); return 0; } @@ -1089,7 +1125,7 @@ static int cpy_config(oconfig_item_t *ci) { for (i = 0; i < ci->children_num; ++i) { oconfig_item_t *item = ci->children + i; - + if (strcasecmp(item->key, "Interactive") == 0) { if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN) continue; @@ -1097,9 +1133,13 @@ static int cpy_config(oconfig_item_t *ci) { } else if (strcasecmp(item->key, "Encoding") == 0) { if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_STRING) continue; +#ifdef IS_PY3K + NOTICE("python: \"Encoding\" was used in the config file but Python3 was used, which does not support changing encodings. Ignoring this."); +#else /* Why is this even necessary? And undocumented? */ if (PyUnicode_SetDefaultEncoding(item->values[0].value.string)) cpy_log_exception("setting default encoding"); +#endif } else if (strcasecmp(item->key, "LogTraces") == 0) { if (item->values_num != 1 || item->values[0].type != OCONFIG_TYPE_BOOLEAN) continue; @@ -1122,8 +1162,8 @@ static int cpy_config(oconfig_item_t *ci) { } else if (strcasecmp(item->key, "ModulePath") == 0) { char *dir = NULL; PyObject *dir_object; - - if (cf_util_get_string(item, &dir) != 0) + + if (cf_util_get_string(item, &dir) != 0) continue; dir_object = cpy_string_to_unicode_or_bytes(dir); /* New reference. */ if (dir_object == NULL) { @@ -1133,8 +1173,8 @@ static int cpy_config(oconfig_item_t *ci) { cpy_log_exception("python initialization"); continue; } - if (PyList_Append(sys_path, dir_object) != 0) { - ERROR("python plugin: Unable to append \"%s\" to " + if (PyList_Insert(sys_path, 0, dir_object) != 0) { + ERROR("python plugin: Unable to prepend \"%s\" to " "python module path.", dir); cpy_log_exception("python initialization"); } @@ -1143,8 +1183,8 @@ static int cpy_config(oconfig_item_t *ci) { } else if (strcasecmp(item->key, "Import") == 0) { char *module_name = NULL; PyObject *module; - - if (cf_util_get_string(item, &module_name) != 0) + + if (cf_util_get_string(item, &module_name) != 0) continue; module = PyImport_ImportModule(module_name); /* New reference. */ if (module == NULL) { @@ -1157,7 +1197,7 @@ static int cpy_config(oconfig_item_t *ci) { char *name = NULL; cpy_callback_t *c; PyObject *ret; - + if (cf_util_get_string(item, &name) != 0) continue; for (c = cpy_config_callbacks; c; c = c->next) {