[babeltrace.git] / 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 "logging.h"

#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/compiler-internal.h>
#include <babeltrace/ref.h>
#include <babeltrace/plugin/plugin.h>
#include <babeltrace/plugin/plugin-internal.h>
#include <babeltrace/graph/component-class.h>
#include <babeltrace/graph/component-class-internal.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;
	sighandler_t old_sigint = signal(SIGINT, SIG_DFL);

	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:
	if (old_sigint != SIG_ERR) {
		(void) signal(SIGINT, old_sigint);
	}

	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
struct bt_plugin *bt_plugin_from_python_plugin_info(PyObject *plugin_info)
{
	struct 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;

	assert(plugin_info);
	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);

			assert(py_major);
			assert(py_minor);
			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);

			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++) {
			struct bt_component_class *comp_class;
			PyObject *py_comp_class_addr;

			py_comp_class_addr =
				PyList_GetItem(py_comp_class_addrs, i);
			assert(py_comp_class_addr);
			if (PyLong_Check(py_comp_class_addr)) {
				comp_class = (struct bt_component_class *)
					PyLong_AsUnsignedLongLong(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;
			}
		}
	}

	bt_plugin_freeze(plugin);

	goto end;

error:
	print_python_traceback_warn();
	pyerr_clear();
	BT_PUT(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
struct bt_plugin_set *bt_plugin_python_create_all_from_file(const char *path)
{
	struct bt_plugin_set *plugin_set = NULL;
	struct bt_plugin *plugin = NULL;
	PyObject *py_plugin_info = NULL;
	gchar *basename = NULL;
	size_t path_len;

	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_PUT(plugin_set);

end:
	bt_put(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"
86f21ef3	28	#include "logging.h"
3fe0bf43	29
55bb57e0	30	#include <babeltrace/babeltrace-internal.h>
3d9990ac	31	#include <babeltrace/compiler-internal.h>
55bb57e0	32	#include <babeltrace/ref.h>
9e0bf9b0	33	#include <babeltrace/plugin/plugin.h>
55bb57e0	34	#include <babeltrace/plugin/plugin-internal.h>
9e0bf9b0 PP	35	#include <babeltrace/graph/component-class.h>
9e0bf9b0 PP	36	#include <babeltrace/graph/component-class-internal.h>
55bb57e0 PP	37	#include <stdlib.h>
	38	#include <signal.h>
	39	#include <Python.h>
6fbd4105 PP	40	#include <glib.h>
6fbd4105 PP	41	#include <gmodule.h>
55bb57e0 PP	42
	43	#define PYTHON_PLUGIN_FILE_PREFIX "bt_plugin_"
	44	#define PYTHON_PLUGIN_FILE_PREFIX_LEN (sizeof(PYTHON_PLUGIN_FILE_PREFIX) - 1)
	45	#define PYTHON_PLUGIN_FILE_EXT ".py"
	46	#define PYTHON_PLUGIN_FILE_EXT_LEN (sizeof(PYTHON_PLUGIN_FILE_EXT) - 1)
	47
	48	enum python_state {
	49	/* init_python() not called yet */
	50	PYTHON_STATE_NOT_INITED,
	51
	52	/* init_python() called once with success */
	53	PYTHON_STATE_FULLY_INITIALIZED,
	54
	55	/* init_python() called once without success */
	56	PYTHON_STATE_CANNOT_INITIALIZE,
	57	} python_state = PYTHON_STATE_NOT_INITED;
	58
	59	static PyObject *py_try_load_plugin_module_func = NULL;
edc733b9	60	static bool python_was_initialized_by_us;
55bb57e0 PP	61
55bb57e0 PP	62	static
9e0bf9b0	63	void print_python_traceback_warn(void)
55bb57e0	64	{
9e0bf9b0 PP	65	if (BT_LOG_ON_WARN && Py_IsInitialized() && PyErr_Occurred()) {
9e0bf9b0 PP	66	BT_LOGW_STR("Exception occured: traceback: ");
55bb57e0 PP	67	PyErr_Print();
	68	}
	69	}
	70
	71	static
	72	void pyerr_clear(void)
	73	{
	74	if (Py_IsInitialized()) {
	75	PyErr_Clear();
	76	}
	77	}
	78
	79	static
	80	void init_python(void)
	81	{
	82	PyObject *py_bt2_py_plugin_mod = NULL;
	83	const char *dis_python_env;
	84	sighandler_t old_sigint = signal(SIGINT, SIG_DFL);
	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:
	131	if (old_sigint != SIG_ERR) {
	132	(void) signal(SIGINT, old_sigint);
	133	}
	134
9e0bf9b0	135	print_python_traceback_warn();
55bb57e0 PP	136	pyerr_clear();
	137	Py_XDECREF(py_bt2_py_plugin_mod);
	138	return;
	139	}
	140
	141	__attribute__((destructor)) static
	142	void fini_python(void) {
edc733b9	143	if (Py_IsInitialized() && python_was_initialized_by_us) {
55bb57e0 PP	144	if (py_try_load_plugin_module_func) {
	145	Py_DECREF(py_try_load_plugin_module_func);
	146	py_try_load_plugin_module_func = NULL;
	147	}
	148
	149	Py_Finalize();
9e0bf9b0	150	BT_LOGI_STR("Finalized Python interpreter.");
55bb57e0 PP	151	}
	152
	153	python_state = PYTHON_STATE_NOT_INITED;
	154	}
	155
	156	static
	157	struct bt_plugin bt_plugin_from_python_plugin_info(PyObject plugin_info)
	158	{
	159	struct bt_plugin *plugin = NULL;
	160	PyObject *py_name = NULL;
	161	PyObject *py_author = NULL;
	162	PyObject *py_description = NULL;
	163	PyObject *py_license = NULL;
	164	PyObject *py_version = NULL;
	165	PyObject *py_comp_class_addrs = NULL;
	166	const char *name = NULL;
	167	const char *author = NULL;
	168	const char *description = NULL;
	169	const char *license = NULL;
	170	unsigned int major = 0, minor = 0, patch = 0;
	171	const char *version_extra = NULL;
	172	int ret;
	173
	174	assert(plugin_info);
	175	assert(python_state == PYTHON_STATE_FULLY_INITIALIZED);
	176	py_name = PyObject_GetAttrString(plugin_info, "name");
	177	if (!py_name) {
9e0bf9b0 PP	178	BT_LOGW("Cannot find `name` attribute in Python plugin info object: "
9e0bf9b0 PP	179	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	180	goto error;
	181	}
	182
	183	py_author = PyObject_GetAttrString(plugin_info, "author");
	184	if (!py_author) {
9e0bf9b0 PP	185	BT_LOGW("Cannot find `author` attribute in Python plugin info object: "
9e0bf9b0 PP	186	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	187	goto error;
	188	}
	189
	190	py_description = PyObject_GetAttrString(plugin_info, "description");
	191	if (!py_description) {
9e0bf9b0 PP	192	BT_LOGW("Cannot find `desciption` attribute in Python plugin info object: "
9e0bf9b0 PP	193	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	194	goto error;
	195	}
	196
	197	py_license = PyObject_GetAttrString(plugin_info, "license");
	198	if (!py_license) {
9e0bf9b0 PP	199	BT_LOGW("Cannot find `license` attribute in Python plugin info object: "
9e0bf9b0 PP	200	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	201	goto error;
	202	}
	203
	204	py_version = PyObject_GetAttrString(plugin_info, "version");
	205	if (!py_version) {
9e0bf9b0 PP	206	BT_LOGW("Cannot find `version` attribute in Python plugin info object: "
9e0bf9b0 PP	207	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	208	goto error;
	209	}
	210
	211	py_comp_class_addrs = PyObject_GetAttrString(plugin_info,
	212	"comp_class_addrs");
	213	if (!py_comp_class_addrs) {
9e0bf9b0 PP	214	BT_LOGW("Cannot find `comp_class_addrs` attribute in Python plugin info object: "
9e0bf9b0 PP	215	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	216	goto error;
	217	}
	218
	219	if (PyUnicode_Check(py_name)) {
	220	name = PyUnicode_AsUTF8(py_name);
	221	if (!name) {
9e0bf9b0 PP	222	BT_LOGW("Cannot decode Python plugin name string: "
9e0bf9b0 PP	223	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	224	goto error;
	225	}
	226	} else {
	227	/* Plugin name is mandatory */
9e0bf9b0 PP	228	BT_LOGW("Plugin name is not a string: "
9e0bf9b0 PP	229	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	230	goto error;
	231	}
	232
	233	if (PyUnicode_Check(py_author)) {
	234	author = PyUnicode_AsUTF8(py_author);
	235	if (!author) {
9e0bf9b0 PP	236	BT_LOGW("Cannot decode Python plugin author string: "
9e0bf9b0 PP	237	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	238	goto error;
	239	}
	240	}
	241
	242	if (PyUnicode_Check(py_description)) {
	243	description = PyUnicode_AsUTF8(py_description);
	244	if (!description) {
9e0bf9b0 PP	245	BT_LOGW("Cannot decode Python plugin description string: "
9e0bf9b0 PP	246	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	247	goto error;
	248	}
	249	}
	250
	251	if (PyUnicode_Check(py_license)) {
	252	license = PyUnicode_AsUTF8(py_license);
	253	if (!license) {
9e0bf9b0 PP	254	BT_LOGW("Cannot decode Python plugin license string: "
9e0bf9b0 PP	255	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	256	goto error;
	257	}
	258	}
	259
	260	if (PyTuple_Check(py_version)) {
	261	if (PyTuple_Size(py_version) >= 3) {
	262	PyObject *py_major = PyTuple_GetItem(py_version, 0);
	263	PyObject *py_minor = PyTuple_GetItem(py_version, 1);
	264	PyObject *py_patch = PyTuple_GetItem(py_version, 2);
	265
	266	assert(py_major);
	267	assert(py_minor);
	268	assert(py_patch);
	269
	270	if (PyLong_Check(py_major)) {
	271	major = PyLong_AsUnsignedLong(py_major);
	272	}
	273
	274	if (PyLong_Check(py_minor)) {
	275	minor = PyLong_AsUnsignedLong(py_minor);
	276	}
	277
	278	if (PyLong_Check(py_patch)) {
	279	patch = PyLong_AsUnsignedLong(py_patch);
	280	}
	281
	282	if (PyErr_Occurred()) {
	283	/* Overflow error, most probably */
9e0bf9b0 PP	284	BT_LOGW("Invalid Python plugin version format: "
9e0bf9b0 PP	285	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	286	goto error;
	287	}
	288	}
	289
	290	if (PyTuple_Size(py_version) >= 4) {
	291	PyObject *py_extra = PyTuple_GetItem(py_version, 3);
	292
	293	assert(py_extra);
	294
	295	if (PyUnicode_Check(py_extra)) {
	296	version_extra = PyUnicode_AsUTF8(py_extra);
	297	if (!version_extra) {
9e0bf9b0 PP	298	BT_LOGW("Cannot decode Python plugin version's extra string: "
9e0bf9b0 PP	299	"py-plugin-info-addr=%p", plugin_info);
55bb57e0 PP	300	goto error;
	301	}
	302	}
	303	}
	304	}
	305
	306	plugin = bt_plugin_create_empty(BT_PLUGIN_TYPE_PYTHON);
	307	if (!plugin) {
9e0bf9b0	308	BT_LOGE_STR("Cannot create empty plugin object.");
55bb57e0 PP	309	goto error;
	310	}
	311
	312	bt_plugin_set_name(plugin, name);
	313
	314	if (description) {
	315	bt_plugin_set_description(plugin, description);
	316	}
	317
	318	if (author) {
	319	bt_plugin_set_author(plugin, author);
	320	}
	321
	322	if (license) {
	323	bt_plugin_set_license(plugin, license);
	324	}
	325
	326	bt_plugin_set_version(plugin, major, minor, patch, version_extra);
	327
	328	if (PyList_Check(py_comp_class_addrs)) {
	329	size_t i;
	330
	331	for (i = 0; i < PyList_Size(py_comp_class_addrs); i++) {
	332	struct bt_component_class *comp_class;
	333	PyObject *py_comp_class_addr;
	334
	335	py_comp_class_addr =
	336	PyList_GetItem(py_comp_class_addrs, i);
	337	assert(py_comp_class_addr);
	338	if (PyLong_Check(py_comp_class_addr)) {
	339	comp_class = (struct bt_component_class *)
	340	PyLong_AsUnsignedLongLong(py_comp_class_addr);
	341	} else {
9e0bf9b0 PP	342	BT_LOGW("Component class address is not an integer in Python plugin info object: "
	343	"py-plugin-info-addr=%p, index=%zu",
	344	plugin_info, i);
55bb57e0 PP	345	continue;
	346	}
	347
	348	ret = bt_plugin_add_component_class(plugin, comp_class);
	349	if (ret < 0) {
9e0bf9b0 PP	350	BT_LOGE("Cannot add component class to plugin: "
	351	"py-plugin-info-addr=%p, "
	352	"plugin-addr=%p, plugin-name=\"%s\", "
	353	"comp-class-addr=%p, "
	354	"comp-class-name=\"%s\", "
	355	"comp-class-type=%s",
	356	plugin_info,
	357	plugin, bt_plugin_get_name(plugin),
	358	comp_class,
	359	bt_component_class_get_name(comp_class),
	360	bt_component_class_type_string(
	361	bt_component_class_get_type(comp_class)));
55bb57e0 PP	362	continue;
	363	}
	364	}
	365	}
	366
	367	bt_plugin_freeze(plugin);
	368
	369	goto end;
	370
	371	error:
9e0bf9b0	372	print_python_traceback_warn();
55bb57e0 PP	373	pyerr_clear();
	374	BT_PUT(plugin);
	375
	376	end:
	377	Py_XDECREF(py_name);
	378	Py_XDECREF(py_author);
	379	Py_XDECREF(py_description);
	380	Py_XDECREF(py_license);
	381	Py_XDECREF(py_version);
	382	Py_XDECREF(py_comp_class_addrs);
	383	return plugin;
	384	}
	385
6fbd4105	386	G_MODULE_EXPORT
a8ff38ef	387	struct bt_plugin_set bt_plugin_python_create_all_from_file(const char path)
55bb57e0	388	{
a8ff38ef PP	389	struct bt_plugin_set *plugin_set = NULL;
a8ff38ef PP	390	struct bt_plugin *plugin = NULL;
55bb57e0 PP	391	PyObject *py_plugin_info = NULL;
	392	gchar *basename = NULL;
	393	size_t path_len;
	394
	395	assert(path);
	396
	397	if (python_state == PYTHON_STATE_CANNOT_INITIALIZE) {
	398	/*
	399	* We do not even care about the rest of the function
	400	* here because we already know Python cannot be fully
	401	* initialized.
	402	*/
	403	goto error;
	404	}
	405
9e0bf9b0	406	BT_LOGD("Creating all Python plugins from file: path=\"%s\"", path);
55bb57e0 PP	407	path_len = strlen(path);
	408
	409	/* File name ends with `.py` */
	410	if (strncmp(path + path_len - PYTHON_PLUGIN_FILE_EXT_LEN,
	411	PYTHON_PLUGIN_FILE_EXT,
	412	PYTHON_PLUGIN_FILE_EXT_LEN) != 0) {
9e0bf9b0	413	BT_LOGD("Skipping non-Python file: path=\"%s\"", path);
55bb57e0 PP	414	goto error;
	415	}
	416
	417	/* File name starts with `bt_plugin_` */
	418	basename = g_path_get_basename(path);
	419	if (!basename) {
9e0bf9b0	420	BT_LOGW("Cannot get path's basename: path=\"%s\"", path);
55bb57e0 PP	421	goto error;
	422	}
	423
	424	if (strncmp(basename, PYTHON_PLUGIN_FILE_PREFIX,
	425	PYTHON_PLUGIN_FILE_PREFIX_LEN) != 0) {
9e0bf9b0 PP	426	BT_LOGD("Skipping Python file not starting with `%s`: "
9e0bf9b0 PP	427	"path=\"%s\"", PYTHON_PLUGIN_FILE_PREFIX, path);
55bb57e0 PP	428	goto error;
	429	}
	430
	431	/*
	432	* Initialize Python now.
	433	*
	434	* This is not done in the library contructor because the
	435	* interpreter is somewhat slow to initialize. If you don't
	436	* have any potential Python plugins, you don't need to endure
	437	* this waiting time everytime you load the library.
	438	*/
	439	init_python();
	440	if (python_state != PYTHON_STATE_FULLY_INITIALIZED) {
	441	/*
	442	* For some reason we cannot initialize Python,
	443	* import the required modules, and get the required
	444	* attributes from them.
	445	*/
9e0bf9b0	446	BT_LOGI("Failed to initialize Python interpreter.");
55bb57e0 PP	447	goto error;
	448	}
	449
	450	/*
	451	* Call bt2.py_plugin._try_load_plugin_module() with this path
	452	* to get plugin info if the plugin is loadable and complete.
	453	* This function returns None when there's an error, but just in
	454	* case we also manually clear the last Python error state.
	455	*/
9e0bf9b0	456	BT_LOGD_STR("Getting Python plugin info object from Python module.");
55bb57e0 PP	457	py_plugin_info = PyObject_CallFunction(py_try_load_plugin_module_func,
	458	"(s)", path);
	459	if (!py_plugin_info \|\| py_plugin_info == Py_None) {
9e0bf9b0 PP	460	BT_LOGW("Cannot load Python plugin: path=\"%s\"", path);
9e0bf9b0 PP	461	print_python_traceback_warn();
55bb57e0 PP	462	PyErr_Clear();
	463	goto error;
	464	}
	465
	466	/*
	467	* Get bt_plugin from plugin info object.
55bb57e0	468	*/
a8ff38ef PP	469	plugin = bt_plugin_from_python_plugin_info(py_plugin_info);
a8ff38ef PP	470	if (!plugin) {
9e0bf9b0 PP	471	BT_LOGW("Cannot create plugin object from Python plugin info object: "
	472	"path=\"%s\", py-plugin-info-addr=%p",
	473	path, py_plugin_info);
55bb57e0 PP	474	goto error;
	475	}
	476
a8ff38ef PP	477	bt_plugin_set_path(plugin, path);
	478	plugin_set = bt_plugin_set_create();
	479	if (!plugin_set) {
9e0bf9b0	480	BT_LOGE_STR("Cannot create empty plugin set.");
55bb57e0 PP	481	goto error;
	482	}
	483
a8ff38ef	484	bt_plugin_set_add_plugin(plugin_set, plugin);
9e0bf9b0 PP	485	BT_LOGD("Created all Python plugins from file: path=\"%s\", "
	486	"plugin-addr=%p, plugin-name=\"%s\"",
	487	path, plugin, bt_plugin_get_name(plugin));
55bb57e0 PP	488	goto end;
	489
	490	error:
a8ff38ef	491	BT_PUT(plugin_set);
55bb57e0 PP	492
55bb57e0 PP	493	end:
a8ff38ef	494	bt_put(plugin);
55bb57e0 PP	495	Py_XDECREF(py_plugin_info);
55bb57e0 PP	496	g_free(basename);
a8ff38ef	497	return plugin_set;
55bb57e0	498	}