[babeltrace.git] / src / python-plugin-provider / python-plugin-provider.c

/*
 * python-plugin-provider.c
 *
 * Babeltrace Python plugin provider
 *
 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#define BT_LOG_TAG "PLUGIN-PY"

#include "common/babeltrace.h"
#include "compat/compiler.h"
#include <babeltrace2/plugin/plugin-const.h>
#include "lib/plugin/plugin.h"
#include <babeltrace2/graph/component-class.h>
#include "lib/graph/component-class.h"
#include <stdlib.h>
#include <signal.h>
#include <Python.h>
#include <glib.h>
#include <gmodule.h>

#define PYTHON_PLUGIN_FILE_PREFIX	"bt_plugin_"
#define PYTHON_PLUGIN_FILE_PREFIX_LEN	(sizeof(PYTHON_PLUGIN_FILE_PREFIX) - 1)
#define PYTHON_PLUGIN_FILE_EXT		".py"
#define PYTHON_PLUGIN_FILE_EXT_LEN	(sizeof(PYTHON_PLUGIN_FILE_EXT) - 1)

enum python_state {
	/* init_python() not called yet */
	PYTHON_STATE_NOT_INITED,

	/* init_python() called once with success */
	PYTHON_STATE_FULLY_INITIALIZED,

	/* init_python() called once without success */
	PYTHON_STATE_CANNOT_INITIALIZE,
} python_state = PYTHON_STATE_NOT_INITED;

static PyObject *py_try_load_plugin_module_func = NULL;
static bool python_was_initialized_by_us;

static
void print_python_traceback_warn(void)
{
	if (BT_LOG_ON_WARN && Py_IsInitialized() && PyErr_Occurred()) {
		BT_LOGW_STR("Exception occured: traceback: ");
		PyErr_Print();
	}
}

static
void pyerr_clear(void)
{
	if (Py_IsInitialized()) {
		PyErr_Clear();
	}
}

static
void init_python(void)
{
	PyObject *py_bt2_py_plugin_mod = NULL;
	const char *dis_python_env;
#ifndef __MINGW32__
	sighandler_t old_sigint = signal(SIGINT, SIG_DFL);
#endif

	if (python_state != PYTHON_STATE_NOT_INITED) {
		goto end;
	}

	/*
	 * User can disable Python plugin support with the
	 * BABELTRACE_DISABLE_PYTHON_PLUGINS environment variable set to
	 * 1.
	 */
	dis_python_env = getenv("BABELTRACE_DISABLE_PYTHON_PLUGINS");
	if (dis_python_env && strcmp(dis_python_env, "1") == 0) {
		BT_LOGI_STR("Python plugin support is disabled because `BABELTRACE_DISABLE_PYTHON_PLUGINS=1`.");
		python_state = PYTHON_STATE_CANNOT_INITIALIZE;
		goto end;
	}

	if (!Py_IsInitialized()) {
		BT_LOGI_STR("Python interpreter is not initialized: initializing Python interpreter.");
		Py_InitializeEx(0);
		python_was_initialized_by_us = true;
		BT_LOGI("Initialized Python interpreter: version=\"%s\"",
			Py_GetVersion());
	} else {
		BT_LOGI("Python interpreter is already initialized: version=\"%s\"",
			Py_GetVersion());
	}

	py_bt2_py_plugin_mod = PyImport_ImportModule("bt2.py_plugin");
	if (!py_bt2_py_plugin_mod) {
		BT_LOGI_STR("Cannot import bt2.py_plugin Python module: Python plugin support is disabled.");
		python_state = PYTHON_STATE_CANNOT_INITIALIZE;
		goto end;
	}

	py_try_load_plugin_module_func =
		PyObject_GetAttrString(py_bt2_py_plugin_mod, "_try_load_plugin_module");
	if (!py_try_load_plugin_module_func) {
		BT_LOGI_STR("Cannot get _try_load_plugin_module attribute from bt2.py_plugin Python module: Python plugin support is disabled.");
		python_state = PYTHON_STATE_CANNOT_INITIALIZE;
		goto end;
	}

	python_state = PYTHON_STATE_FULLY_INITIALIZED;

end:
#ifndef __MINGW32__
	if (old_sigint != SIG_ERR) {
		(void) signal(SIGINT, old_sigint);
	}
#endif

	print_python_traceback_warn();
	pyerr_clear();
	Py_XDECREF(py_bt2_py_plugin_mod);
	return;
}

__attribute__((destructor)) static
void fini_python(void) {
	if (Py_IsInitialized() && python_was_initialized_by_us) {
		if (py_try_load_plugin_module_func) {
			Py_DECREF(py_try_load_plugin_module_func);
			py_try_load_plugin_module_func = NULL;
		}

		Py_Finalize();
		BT_LOGI_STR("Finalized Python interpreter.");
	}

	python_state = PYTHON_STATE_NOT_INITED;
}

static
bt_plugin *bt_plugin_from_python_plugin_info(PyObject *plugin_info)
{
	bt_plugin *plugin = NULL;
	PyObject *py_name = NULL;
	PyObject *py_author = NULL;
	PyObject *py_description = NULL;
	PyObject *py_license = NULL;
	PyObject *py_version = NULL;
	PyObject *py_comp_class_addrs = NULL;
	const char *name = NULL;
	const char *author = NULL;
	const char *description = NULL;
	const char *license = NULL;
	unsigned int major = 0, minor = 0, patch = 0;
	const char *version_extra = NULL;
	int ret;

	BT_ASSERT(plugin_info);
	BT_ASSERT(python_state == PYTHON_STATE_FULLY_INITIALIZED);
	py_name = PyObject_GetAttrString(plugin_info, "name");
	if (!py_name) {
		BT_LOGW("Cannot find `name` attribute in Python plugin info object: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	py_author = PyObject_GetAttrString(plugin_info, "author");
	if (!py_author) {
		BT_LOGW("Cannot find `author` attribute in Python plugin info object: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	py_description = PyObject_GetAttrString(plugin_info, "description");
	if (!py_description) {
		BT_LOGW("Cannot find `desciption` attribute in Python plugin info object: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	py_license = PyObject_GetAttrString(plugin_info, "license");
	if (!py_license) {
		BT_LOGW("Cannot find `license` attribute in Python plugin info object: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	py_version = PyObject_GetAttrString(plugin_info, "version");
	if (!py_version) {
		BT_LOGW("Cannot find `version` attribute in Python plugin info object: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	py_comp_class_addrs = PyObject_GetAttrString(plugin_info,
		"comp_class_addrs");
	if (!py_comp_class_addrs) {
		BT_LOGW("Cannot find `comp_class_addrs` attribute in Python plugin info object: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	if (PyUnicode_Check(py_name)) {
		name = PyUnicode_AsUTF8(py_name);
		if (!name) {
			BT_LOGW("Cannot decode Python plugin name string: "
				"py-plugin-info-addr=%p", plugin_info);
			goto error;
		}
	} else {
		/* Plugin name is mandatory */
		BT_LOGW("Plugin name is not a string: "
			"py-plugin-info-addr=%p", plugin_info);
		goto error;
	}

	if (PyUnicode_Check(py_author)) {
		author = PyUnicode_AsUTF8(py_author);
		if (!author) {
			BT_LOGW("Cannot decode Python plugin author string: "
				"py-plugin-info-addr=%p", plugin_info);
			goto error;
		}
	}

	if (PyUnicode_Check(py_description)) {
		description = PyUnicode_AsUTF8(py_description);
		if (!description) {
			BT_LOGW("Cannot decode Python plugin description string: "
				"py-plugin-info-addr=%p", plugin_info);
			goto error;
		}
	}

	if (PyUnicode_Check(py_license)) {
		license = PyUnicode_AsUTF8(py_license);
		if (!license) {
			BT_LOGW("Cannot decode Python plugin license string: "
				"py-plugin-info-addr=%p", plugin_info);
			goto error;
		}
	}

	if (PyTuple_Check(py_version)) {
		if (PyTuple_Size(py_version) >= 3) {
			PyObject *py_major = PyTuple_GetItem(py_version, 0);
			PyObject *py_minor = PyTuple_GetItem(py_version, 1);
			PyObject *py_patch = PyTuple_GetItem(py_version, 2);

			BT_ASSERT(py_major);
			BT_ASSERT(py_minor);
			BT_ASSERT(py_patch);

			if (PyLong_Check(py_major)) {
				major = PyLong_AsUnsignedLong(py_major);
			}

			if (PyLong_Check(py_minor)) {
				minor = PyLong_AsUnsignedLong(py_minor);
			}

			if (PyLong_Check(py_patch)) {
				patch = PyLong_AsUnsignedLong(py_patch);
			}

			if (PyErr_Occurred()) {
				/* Overflow error, most probably */
				BT_LOGW("Invalid Python plugin version format: "
					"py-plugin-info-addr=%p", plugin_info);
				goto error;
			}
		}

		if (PyTuple_Size(py_version) >= 4) {
			PyObject *py_extra = PyTuple_GetItem(py_version, 3);

			BT_ASSERT(py_extra);

			if (PyUnicode_Check(py_extra)) {
				version_extra = PyUnicode_AsUTF8(py_extra);
				if (!version_extra) {
				BT_LOGW("Cannot decode Python plugin version's extra string: "
					"py-plugin-info-addr=%p", plugin_info);
					goto error;
				}
			}
		}
	}

	plugin = bt_plugin_create_empty(BT_PLUGIN_TYPE_PYTHON);
	if (!plugin) {
		BT_LOGE_STR("Cannot create empty plugin object.");
		goto error;
	}

	bt_plugin_set_name(plugin, name);

	if (description) {
		bt_plugin_set_description(plugin, description);
	}

	if (author) {
		bt_plugin_set_author(plugin, author);
	}

	if (license) {
		bt_plugin_set_license(plugin, license);
	}

	bt_plugin_set_version(plugin, major, minor, patch, version_extra);

	if (PyList_Check(py_comp_class_addrs)) {
		size_t i;

		for (i = 0; i < PyList_Size(py_comp_class_addrs); i++) {
			bt_component_class *comp_class;
			PyObject *py_comp_class_addr;

			py_comp_class_addr =
				PyList_GetItem(py_comp_class_addrs, i);
			BT_ASSERT(py_comp_class_addr);
			if (PyLong_Check(py_comp_class_addr)) {
				comp_class = PyLong_AsVoidPtr(py_comp_class_addr);
			} else {
				BT_LOGW("Component class address is not an integer in Python plugin info object: "
					"py-plugin-info-addr=%p, index=%zu",
					plugin_info, i);
				continue;
			}

			ret = bt_plugin_add_component_class(plugin, comp_class);
			if (ret < 0) {
				BT_LOGE("Cannot add component class to plugin: "
					"py-plugin-info-addr=%p, "
					"plugin-addr=%p, plugin-name=\"%s\", "
					"comp-class-addr=%p, "
					"comp-class-name=\"%s\", "
					"comp-class-type=%s",
					plugin_info,
					plugin, bt_plugin_get_name(plugin),
					comp_class,
					bt_component_class_get_name(comp_class),
					bt_component_class_type_string(
						bt_component_class_get_type(comp_class)));
				continue;
			}
		}
	}

	goto end;

error:
	print_python_traceback_warn();
	pyerr_clear();
	BT_OBJECT_PUT_REF_AND_RESET(plugin);

end:
	Py_XDECREF(py_name);
	Py_XDECREF(py_author);
	Py_XDECREF(py_description);
	Py_XDECREF(py_license);
	Py_XDECREF(py_version);
	Py_XDECREF(py_comp_class_addrs);
	return plugin;
}

G_MODULE_EXPORT
bt_plugin_set *bt_plugin_python_create_all_from_file(const char *path)
{
	bt_plugin_set *plugin_set = NULL;
	bt_plugin *plugin = NULL;
	PyObject *py_plugin_info = NULL;
	gchar *basename = NULL;
	size_t path_len;

	BT_ASSERT(path);

	if (python_state == PYTHON_STATE_CANNOT_INITIALIZE) {
		/*
		 * We do not even care about the rest of the function
		 * here because we already know Python cannot be fully
		 * initialized.
		 */
		goto error;
	}

	BT_LOGD("Creating all Python plugins from file: path=\"%s\"", path);
	path_len = strlen(path);

	/* File name ends with `.py` */
	if (strncmp(path + path_len - PYTHON_PLUGIN_FILE_EXT_LEN,
			PYTHON_PLUGIN_FILE_EXT,
			PYTHON_PLUGIN_FILE_EXT_LEN) != 0) {
		BT_LOGD("Skipping non-Python file: path=\"%s\"", path);
		goto error;
	}

	/* File name starts with `bt_plugin_` */
	basename = g_path_get_basename(path);
	if (!basename) {
		BT_LOGW("Cannot get path's basename: path=\"%s\"", path);
		goto error;
	}

	if (strncmp(basename, PYTHON_PLUGIN_FILE_PREFIX,
			PYTHON_PLUGIN_FILE_PREFIX_LEN) != 0) {
		BT_LOGD("Skipping Python file not starting with `%s`: "
			"path=\"%s\"", PYTHON_PLUGIN_FILE_PREFIX, path);
		goto error;
	}

	/*
	 * Initialize Python now.
	 *
	 * This is not done in the library contructor because the
	 * interpreter is somewhat slow to initialize. If you don't
	 * have any potential Python plugins, you don't need to endure
	 * this waiting time everytime you load the library.
	 */
	init_python();
	if (python_state != PYTHON_STATE_FULLY_INITIALIZED) {
		/*
		 * For some reason we cannot initialize Python,
		 * import the required modules, and get the required
		 * attributes from them.
		 */
		BT_LOGI("Failed to initialize Python interpreter.");
		goto error;
	}

	/*
	 * Call bt2.py_plugin._try_load_plugin_module() with this path
	 * to get plugin info if the plugin is loadable and complete.
	 * This function returns None when there's an error, but just in
	 * case we also manually clear the last Python error state.
	 */
	BT_LOGD_STR("Getting Python plugin info object from Python module.");
	py_plugin_info = PyObject_CallFunction(py_try_load_plugin_module_func,
		"(s)", path);
	if (!py_plugin_info || py_plugin_info == Py_None) {
		BT_LOGW("Cannot load Python plugin: path=\"%s\"", path);
		print_python_traceback_warn();
		PyErr_Clear();
		goto error;
	}

	/*
	 * Get bt_plugin from plugin info object.
	 */
	plugin = bt_plugin_from_python_plugin_info(py_plugin_info);
	if (!plugin) {
		BT_LOGW("Cannot create plugin object from Python plugin info object: "
			"path=\"%s\", py-plugin-info-addr=%p",
			path, py_plugin_info);
		goto error;
	}

	bt_plugin_set_path(plugin, path);
	plugin_set = bt_plugin_set_create();
	if (!plugin_set) {
		BT_LOGE_STR("Cannot create empty plugin set.");
		goto error;
	}

	bt_plugin_set_add_plugin(plugin_set, plugin);
	BT_LOGD("Created all Python plugins from file: path=\"%s\", "
		"plugin-addr=%p, plugin-name=\"%s\"",
		path, plugin, bt_plugin_get_name(plugin));
	goto end;

error:
	BT_OBJECT_PUT_REF_AND_RESET(plugin_set);

end:
	bt_plugin_put_ref(plugin);
	Py_XDECREF(py_plugin_info);
	g_free(basename);
	return plugin_set;
}
Commit	Line	Data
55bb57e0	1	/*
6fbd4105	2	* python-plugin-provider.c
55bb57e0	3	*
6fbd4105	4	* Babeltrace Python plugin provider
55bb57e0 PP	5	*
	6	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
3fe0bf43	27	#define BT_LOG_TAG "PLUGIN-PY"
3fe0bf43	28
578e048b MJ	29	#include "common/babeltrace.h"
578e048b MJ	30	#include "compat/compiler.h"
3fadfbc0	31	#include <babeltrace2/plugin/plugin-const.h>
578e048b	32	#include "lib/plugin/plugin.h"
3fadfbc0	33	#include <babeltrace2/graph/component-class.h>
578e048b	34	#include "lib/graph/component-class.h"
55bb57e0 PP	35	#include <stdlib.h>
	36	#include <signal.h>
	37	#include <Python.h>
6fbd4105 PP	38	#include <glib.h>
6fbd4105 PP	39	#include <gmodule.h>
55bb57e0 PP	40
	41	#define PYTHON_PLUGIN_FILE_PREFIX "bt_plugin_"
	42	#define PYTHON_PLUGIN_FILE_PREFIX_LEN (sizeof(PYTHON_PLUGIN_FILE_PREFIX) - 1)
	43	#define PYTHON_PLUGIN_FILE_EXT ".py"
	44	#define PYTHON_PLUGIN_FILE_EXT_LEN (sizeof(PYTHON_PLUGIN_FILE_EXT) - 1)
	45
	46	enum python_state {
	47	/* init_python() not called yet */
	48	PYTHON_STATE_NOT_INITED,
	49
	50	/* init_python() called once with success */
	51	PYTHON_STATE_FULLY_INITIALIZED,
	52
	53	/* init_python() called once without success */
	54	PYTHON_STATE_CANNOT_INITIALIZE,
	55	} python_state = PYTHON_STATE_NOT_INITED;
	56
	57	static PyObject *py_try_load_plugin_module_func = NULL;
edc733b9	58	static bool python_was_initialized_by_us;
55bb57e0 PP	59
55bb57e0 PP	60	static
9e0bf9b0	61	void print_python_traceback_warn(void)
55bb57e0	62	{
9e0bf9b0 PP	63	if (BT_LOG_ON_WARN && Py_IsInitialized() && PyErr_Occurred()) {
9e0bf9b0 PP	64	BT_LOGW_STR("Exception occured: traceback: ");
55bb57e0 PP	65	PyErr_Print();
	66	}
	67	}
	68
	69	static
	70	void pyerr_clear(void)
	71	{
	72	if (Py_IsInitialized()) {
	73	PyErr_Clear();
	74	}
	75	}
	76
	77	static
	78	void init_python(void)
	79	{
	80	PyObject *py_bt2_py_plugin_mod = NULL;
	81	const char *dis_python_env;
c9028270	82	#ifndef __MINGW32__
55bb57e0	83	sighandler_t old_sigint = signal(SIGINT, SIG_DFL);
c9028270	84	#endif
55bb57e0 PP	85
	86	if (python_state != PYTHON_STATE_NOT_INITED) {
	87	goto end;
	88	}
	89
	90	/*
	91	* User can disable Python plugin support with the
	92	* BABELTRACE_DISABLE_PYTHON_PLUGINS environment variable set to
	93	* 1.
	94	*/
	95	dis_python_env = getenv("BABELTRACE_DISABLE_PYTHON_PLUGINS");
9e0bf9b0 PP	96	if (dis_python_env && strcmp(dis_python_env, "1") == 0) {
9e0bf9b0 PP	97	BT_LOGI_STR("Python plugin support is disabled because `BABELTRACE_DISABLE_PYTHON_PLUGINS=1`.");
55bb57e0 PP	98	python_state = PYTHON_STATE_CANNOT_INITIALIZE;
	99	goto end;
	100	}
	101
	102	if (!Py_IsInitialized()) {
13e4a3e3	103	BT_LOGI_STR("Python interpreter is not initialized: initializing Python interpreter.");
55bb57e0	104	Py_InitializeEx(0);
edc733b9	105	python_was_initialized_by_us = true;
9e0bf9b0 PP	106	BT_LOGI("Initialized Python interpreter: version=\"%s\"",
9e0bf9b0 PP	107	Py_GetVersion());
13e4a3e3 PP	108	} else {
	109	BT_LOGI("Python interpreter is already initialized: version=\"%s\"",
	110	Py_GetVersion());
55bb57e0 PP	111	}
	112
	113	py_bt2_py_plugin_mod = PyImport_ImportModule("bt2.py_plugin");
	114	if (!py_bt2_py_plugin_mod) {
9e0bf9b0	115	BT_LOGI_STR("Cannot import bt2.py_plugin Python module: Python plugin support is disabled.");
55bb57e0 PP	116	python_state = PYTHON_STATE_CANNOT_INITIALIZE;
	117	goto end;
	118	}
	119
	120	py_try_load_plugin_module_func =
	121	PyObject_GetAttrString(py_bt2_py_plugin_mod, "_try_load_plugin_module");
	122	if (!py_try_load_plugin_module_func) {
9e0bf9b0	123	BT_LOGI_STR("Cannot get _try_load_plugin_module attribute from bt2.py_plugin Python module: Python plugin support is disabled.");
55bb57e0 PP	124	python_state = PYTHON_STATE_CANNOT_INITIALIZE;
	125	goto end;
	126	}
	127
	128	python_state = PYTHON_STATE_FULLY_INITIALIZED;
	129
	130	end:
c9028270	131	#ifndef __MINGW32__
55bb57e0 PP	132	if (old_sigint != SIG_ERR) {
	133	(void) signal(SIGINT, old_sigint);
	134	}
c9028270	135	#endif
55bb57e0	136
9e0bf9b0	137	print_python_traceback_warn();
55bb57e0 PP	138	pyerr_clear();
	139	Py_XDECREF(py_bt2_py_plugin_mod);
	140	return;
	141	}
	142
	143	__attribute__((destructor)) static
	144	void fini_python(void) {
edc733b9	145	if (Py_IsInitialized() && python_was_initialized_by_us) {
55bb57e0 PP	146	if (py_try_load_plugin_module_func) {
	147	Py_DECREF(py_try_load_plugin_module_func);
	148	py_try_load_plugin_module_func = NULL;
	149	}
	150
	151	Py_Finalize();
9e0bf9b0	152	BT_LOGI_STR("Finalized Python interpreter.");
55bb57e0 PP	153	}
	154
	155	python_state = PYTHON_STATE_NOT_INITED;
	156	}
	157
	158	static
88b3fc9c	159	bt_plugin bt_plugin_from_python_plugin_info(PyObject plugin_info)
55bb57e0	160	{
88b3fc9c	161	bt_plugin *plugin = NULL;
55bb57e0 PP	162	PyObject *py_name = NULL;
	163	PyObject *py_author = NULL;
	164	PyObject *py_description = NULL;
	165	PyObject *py_license = NULL;
	166	PyObject *py_version = NULL;
	167	PyObject *py_comp_class_addrs = NULL;
	168	const char *name = NULL;
	169	const char *author = NULL;
	170	const char *description = NULL;
	171	const char *license = NULL;
	172	unsigned int major = 0, minor = 0, patch = 0;
	173	const char *version_extra = NULL;
	174	int ret;
	175
f6ccaed9 PP	176	BT_ASSERT(plugin_info);
f6ccaed9 PP	177	BT_ASSERT(python_state == PYTHON_STATE_FULLY_INITIALIZED);
55bb57e0 PP	178	py_name = PyObject_GetAttrString(plugin_info, "name");
55bb57e0 PP	179	if (!py_name) {
9e0bf9b0 PP	180	BT_LOGW("Cannot find `name` attribute in Python plugin info object: "
9e0bf9b0 PP	181	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	182	goto error;
	183	}
	184
	185	py_author = PyObject_GetAttrString(plugin_info, "author");
	186	if (!py_author) {
9e0bf9b0 PP	187	BT_LOGW("Cannot find `author` attribute in Python plugin info object: "
9e0bf9b0 PP	188	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	189	goto error;
	190	}
	191
	192	py_description = PyObject_GetAttrString(plugin_info, "description");
	193	if (!py_description) {
9e0bf9b0 PP	194	BT_LOGW("Cannot find `desciption` attribute in Python plugin info object: "
9e0bf9b0 PP	195	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	196	goto error;
	197	}
	198
	199	py_license = PyObject_GetAttrString(plugin_info, "license");
	200	if (!py_license) {
9e0bf9b0 PP	201	BT_LOGW("Cannot find `license` attribute in Python plugin info object: "
9e0bf9b0 PP	202	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	203	goto error;
	204	}
	205
	206	py_version = PyObject_GetAttrString(plugin_info, "version");
	207	if (!py_version) {
9e0bf9b0 PP	208	BT_LOGW("Cannot find `version` attribute in Python plugin info object: "
9e0bf9b0 PP	209	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	210	goto error;
	211	}
	212
	213	py_comp_class_addrs = PyObject_GetAttrString(plugin_info,
	214	"comp_class_addrs");
	215	if (!py_comp_class_addrs) {
9e0bf9b0 PP	216	BT_LOGW("Cannot find `comp_class_addrs` attribute in Python plugin info object: "
9e0bf9b0 PP	217	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	218	goto error;
	219	}
	220
	221	if (PyUnicode_Check(py_name)) {
	222	name = PyUnicode_AsUTF8(py_name);
	223	if (!name) {
9e0bf9b0 PP	224	BT_LOGW("Cannot decode Python plugin name string: "
9e0bf9b0 PP	225	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	226	goto error;
	227	}
	228	} else {
	229	/* Plugin name is mandatory */
9e0bf9b0 PP	230	BT_LOGW("Plugin name is not a string: "
9e0bf9b0 PP	231	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	232	goto error;
	233	}
	234
	235	if (PyUnicode_Check(py_author)) {
	236	author = PyUnicode_AsUTF8(py_author);
	237	if (!author) {
9e0bf9b0 PP	238	BT_LOGW("Cannot decode Python plugin author string: "
9e0bf9b0 PP	239	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	240	goto error;
	241	}
	242	}
	243
	244	if (PyUnicode_Check(py_description)) {
	245	description = PyUnicode_AsUTF8(py_description);
	246	if (!description) {
9e0bf9b0 PP	247	BT_LOGW("Cannot decode Python plugin description string: "
9e0bf9b0 PP	248	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	249	goto error;
	250	}
	251	}
	252
	253	if (PyUnicode_Check(py_license)) {
	254	license = PyUnicode_AsUTF8(py_license);
	255	if (!license) {
9e0bf9b0 PP	256	BT_LOGW("Cannot decode Python plugin license string: "
9e0bf9b0 PP	257	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	258	goto error;
	259	}
	260	}
	261
	262	if (PyTuple_Check(py_version)) {
	263	if (PyTuple_Size(py_version) >= 3) {
	264	PyObject *py_major = PyTuple_GetItem(py_version, 0);
	265	PyObject *py_minor = PyTuple_GetItem(py_version, 1);
	266	PyObject *py_patch = PyTuple_GetItem(py_version, 2);
	267
f6ccaed9 PP	268	BT_ASSERT(py_major);
	269	BT_ASSERT(py_minor);
	270	BT_ASSERT(py_patch);
55bb57e0 PP	271
	272	if (PyLong_Check(py_major)) {
	273	major = PyLong_AsUnsignedLong(py_major);
	274	}
	275
	276	if (PyLong_Check(py_minor)) {
	277	minor = PyLong_AsUnsignedLong(py_minor);
	278	}
	279
	280	if (PyLong_Check(py_patch)) {
	281	patch = PyLong_AsUnsignedLong(py_patch);
	282	}
	283
	284	if (PyErr_Occurred()) {
	285	/* Overflow error, most probably */
9e0bf9b0 PP	286	BT_LOGW("Invalid Python plugin version format: "
9e0bf9b0 PP	287	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	288	goto error;
	289	}
	290	}
	291
	292	if (PyTuple_Size(py_version) >= 4) {
	293	PyObject *py_extra = PyTuple_GetItem(py_version, 3);
	294
f6ccaed9	295	BT_ASSERT(py_extra);
55bb57e0 PP	296
	297	if (PyUnicode_Check(py_extra)) {
	298	version_extra = PyUnicode_AsUTF8(py_extra);
	299	if (!version_extra) {
9e0bf9b0 PP	300	BT_LOGW("Cannot decode Python plugin version's extra string: "
9e0bf9b0 PP	301	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	302	goto error;
	303	}
	304	}
	305	}
	306	}
	307
	308	plugin = bt_plugin_create_empty(BT_PLUGIN_TYPE_PYTHON);
	309	if (!plugin) {
9e0bf9b0	310	BT_LOGE_STR("Cannot create empty plugin object.");
55bb57e0 PP	311	goto error;
	312	}
	313
	314	bt_plugin_set_name(plugin, name);
	315
	316	if (description) {
	317	bt_plugin_set_description(plugin, description);
	318	}
	319
	320	if (author) {
	321	bt_plugin_set_author(plugin, author);
	322	}
	323
	324	if (license) {
	325	bt_plugin_set_license(plugin, license);
	326	}
	327
	328	bt_plugin_set_version(plugin, major, minor, patch, version_extra);
	329
	330	if (PyList_Check(py_comp_class_addrs)) {
	331	size_t i;
	332
	333	for (i = 0; i < PyList_Size(py_comp_class_addrs); i++) {
b19ff26f	334	bt_component_class *comp_class;
55bb57e0 PP	335	PyObject *py_comp_class_addr;
	336
	337	py_comp_class_addr =
	338	PyList_GetItem(py_comp_class_addrs, i);
f6ccaed9	339	BT_ASSERT(py_comp_class_addr);
55bb57e0	340	if (PyLong_Check(py_comp_class_addr)) {
babe0791	341	comp_class = PyLong_AsVoidPtr(py_comp_class_addr);
55bb57e0	342	} else {
9e0bf9b0 PP	343	BT_LOGW("Component class address is not an integer in Python plugin info object: "
	344	"py-plugin-info-addr=%p, index=%zu",
	345	plugin_info, i);
55bb57e0 PP	346	continue;
	347	}
	348
	349	ret = bt_plugin_add_component_class(plugin, comp_class);
	350	if (ret < 0) {
9e0bf9b0 PP	351	BT_LOGE("Cannot add component class to plugin: "
	352	"py-plugin-info-addr=%p, "
	353	"plugin-addr=%p, plugin-name=\"%s\", "
	354	"comp-class-addr=%p, "
	355	"comp-class-name=\"%s\", "
	356	"comp-class-type=%s",
	357	plugin_info,
	358	plugin, bt_plugin_get_name(plugin),
	359	comp_class,
	360	bt_component_class_get_name(comp_class),
	361	bt_component_class_type_string(
	362	bt_component_class_get_type(comp_class)));
55bb57e0 PP	363	continue;
	364	}
	365	}
	366	}
	367
55bb57e0 PP	368	goto end;
	369
	370	error:
9e0bf9b0	371	print_python_traceback_warn();
55bb57e0	372	pyerr_clear();
65300d60	373	BT_OBJECT_PUT_REF_AND_RESET(plugin);
55bb57e0 PP	374
	375	end:
	376	Py_XDECREF(py_name);
	377	Py_XDECREF(py_author);
	378	Py_XDECREF(py_description);
	379	Py_XDECREF(py_license);
	380	Py_XDECREF(py_version);
	381	Py_XDECREF(py_comp_class_addrs);
	382	return plugin;
	383	}
	384
6fbd4105	385	G_MODULE_EXPORT
b19ff26f	386	bt_plugin_set bt_plugin_python_create_all_from_file(const char path)
55bb57e0	387	{
b19ff26f	388	bt_plugin_set *plugin_set = NULL;
88b3fc9c	389	bt_plugin *plugin = NULL;
55bb57e0 PP	390	PyObject *py_plugin_info = NULL;
	391	gchar *basename = NULL;
	392	size_t path_len;
	393
f6ccaed9	394	BT_ASSERT(path);
55bb57e0 PP	395
	396	if (python_state == PYTHON_STATE_CANNOT_INITIALIZE) {
	397	/*
	398	* We do not even care about the rest of the function
	399	* here because we already know Python cannot be fully
	400	* initialized.
	401	*/
	402	goto error;
	403	}
	404
9e0bf9b0	405	BT_LOGD("Creating all Python plugins from file: path=\"%s\"", path);
55bb57e0 PP	406	path_len = strlen(path);
	407
	408	/* File name ends with `.py` */
	409	if (strncmp(path + path_len - PYTHON_PLUGIN_FILE_EXT_LEN,
	410	PYTHON_PLUGIN_FILE_EXT,
	411	PYTHON_PLUGIN_FILE_EXT_LEN) != 0) {
9e0bf9b0	412	BT_LOGD("Skipping non-Python file: path=\"%s\"", path);
55bb57e0 PP	413	goto error;
	414	}
	415
	416	/* File name starts with `bt_plugin_` */
	417	basename = g_path_get_basename(path);
	418	if (!basename) {
9e0bf9b0	419	BT_LOGW("Cannot get path's basename: path=\"%s\"", path);
55bb57e0 PP	420	goto error;
	421	}
	422
	423	if (strncmp(basename, PYTHON_PLUGIN_FILE_PREFIX,
	424	PYTHON_PLUGIN_FILE_PREFIX_LEN) != 0) {
9e0bf9b0 PP	425	BT_LOGD("Skipping Python file not starting with `%s`: "
9e0bf9b0 PP	426	"path=\"%s\"", PYTHON_PLUGIN_FILE_PREFIX, path);
55bb57e0 PP	427	goto error;
	428	}
	429
	430	/*
	431	* Initialize Python now.
	432	*
	433	* This is not done in the library contructor because the
	434	* interpreter is somewhat slow to initialize. If you don't
	435	* have any potential Python plugins, you don't need to endure
	436	* this waiting time everytime you load the library.
	437	*/
	438	init_python();
	439	if (python_state != PYTHON_STATE_FULLY_INITIALIZED) {
	440	/*
	441	* For some reason we cannot initialize Python,
	442	* import the required modules, and get the required
	443	* attributes from them.
	444	*/
9e0bf9b0	445	BT_LOGI("Failed to initialize Python interpreter.");
55bb57e0 PP	446	goto error;
	447	}
	448
	449	/*
	450	* Call bt2.py_plugin._try_load_plugin_module() with this path
	451	* to get plugin info if the plugin is loadable and complete.
	452	* This function returns None when there's an error, but just in
	453	* case we also manually clear the last Python error state.
	454	*/
9e0bf9b0	455	BT_LOGD_STR("Getting Python plugin info object from Python module.");
55bb57e0 PP	456	py_plugin_info = PyObject_CallFunction(py_try_load_plugin_module_func,
	457	"(s)", path);
	458	if (!py_plugin_info \|\| py_plugin_info == Py_None) {
9e0bf9b0 PP	459	BT_LOGW("Cannot load Python plugin: path=\"%s\"", path);
9e0bf9b0 PP	460	print_python_traceback_warn();
55bb57e0 PP	461	PyErr_Clear();
	462	goto error;
	463	}
	464
	465	/*
	466	* Get bt_plugin from plugin info object.
55bb57e0	467	*/
a8ff38ef PP	468	plugin = bt_plugin_from_python_plugin_info(py_plugin_info);
a8ff38ef PP	469	if (!plugin) {
9e0bf9b0 PP	470	BT_LOGW("Cannot create plugin object from Python plugin info object: "
	471	"path=\"%s\", py-plugin-info-addr=%p",
	472	path, py_plugin_info);
55bb57e0 PP	473	goto error;
	474	}
	475
a8ff38ef PP	476	bt_plugin_set_path(plugin, path);
	477	plugin_set = bt_plugin_set_create();
	478	if (!plugin_set) {
9e0bf9b0	479	BT_LOGE_STR("Cannot create empty plugin set.");
55bb57e0 PP	480	goto error;
	481	}
	482
a8ff38ef	483	bt_plugin_set_add_plugin(plugin_set, plugin);
9e0bf9b0 PP	484	BT_LOGD("Created all Python plugins from file: path=\"%s\", "
	485	"plugin-addr=%p, plugin-name=\"%s\"",
	486	path, plugin, bt_plugin_get_name(plugin));
55bb57e0 PP	487	goto end;
	488
	489	error:
65300d60	490	BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
55bb57e0 PP	491
55bb57e0 PP	492	end:
c5b9b441	493	bt_plugin_put_ref(plugin);
55bb57e0 PP	494	Py_XDECREF(py_plugin_info);
55bb57e0 PP	495	g_free(basename);
a8ff38ef	496	return plugin_set;
55bb57e0	497	}