/*
- * python-plugin-provider.c
- *
- * Babeltrace Python plugin provider
+ * SPDX-License-Identifier: MIT
*
* 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.
+ * Babeltrace Python plugin provider
*/
#define BT_LOG_TAG "LIB/PLUGIN-PY"
-
#include "lib/logging.h"
+
+#include "python-plugin-provider.h"
+
#include "common/macros.h"
#include "compat/compiler.h"
-#include <babeltrace2/plugin/plugin-const.h>
+#include <babeltrace2/plugin/plugin-loading.h>
#include "lib/plugin/plugin.h"
#include <babeltrace2/graph/component-class.h>
+#include <babeltrace2/error-reporting.h>
#include "lib/graph/component-class.h"
+#include "py-common/py-common.h"
+#include <stdbool.h>
#include <stdlib.h>
#include <signal.h>
#include <Python.h>
#define PYTHON_PLUGIN_FILE_EXT ".py"
#define PYTHON_PLUGIN_FILE_EXT_LEN (sizeof(PYTHON_PLUGIN_FILE_EXT) - 1)
-enum python_state {
+static enum python_state {
/* init_python() not called yet */
PYTHON_STATE_NOT_INITED,
static bool python_was_initialized_by_us;
static
-void print_python_traceback(int log_level)
+void append_python_traceback_error_cause(void)
+{
+ GString *exc = NULL;
+
+ if (Py_IsInitialized() && PyErr_Occurred()) {
+ exc = bt_py_common_format_current_exception(BT_LOG_OUTPUT_LEVEL);
+ if (!exc) {
+ BT_LOGE_STR("Failed to format Python exception.");
+ goto end;
+ }
+
+ (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
+ BT_LIB_LOG_LIBBABELTRACE2_NAME, "%s", exc->str);
+ }
+
+end:
+ if (exc) {
+ g_string_free(exc, TRUE);
+ }
+}
+
+static
+void log_python_traceback(int log_level)
{
- if (BT_LOG_ON(log_level) && Py_IsInitialized() && PyErr_Occurred()) {
+ GString *exc = NULL;
+
+ if (Py_IsInitialized() && PyErr_Occurred()) {
+ exc = bt_py_common_format_current_exception(BT_LOG_OUTPUT_LEVEL);
+ if (!exc) {
+ BT_LOGE_STR("Failed to format Python exception.");
+ goto end;
+ }
+
BT_LOG_WRITE(log_level, BT_LOG_TAG,
- "Exception occured: Python traceback: ");
- PyErr_Print();
+ "Exception occurred: Python traceback:\n%s", exc->str);
+ }
+
+end:
+ if (exc) {
+ g_string_free(exc, TRUE);
}
}
}
static
-void init_python(void)
+int init_python(void)
{
+ int ret = BT_FUNC_STATUS_OK;
PyObject *py_bt2_py_plugin_mod = NULL;
const char *dis_python_env;
#ifndef __MINGW32__
sig_t old_sigint = signal(SIGINT, SIG_DFL);
#endif
- if (python_state != PYTHON_STATE_NOT_INITED) {
+ switch (python_state) {
+ case PYTHON_STATE_NOT_INITED:
+ break;
+ case PYTHON_STATE_FULLY_INITIALIZED:
+ goto end;
+ case PYTHON_STATE_WONT_INITIALIZE:
+ ret = BT_FUNC_STATUS_NOT_FOUND;
goto end;
+ case PYTHON_STATE_CANNOT_INITIALIZE:
+ ret = BT_FUNC_STATUS_ERROR;
+ goto end;
+ default:
+ bt_common_abort();
}
/*
* User can disable Python plugin support with the
- * BABELTRACE_DISABLE_PYTHON_PLUGINS environment variable set to
- * 1.
+ * `LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS` environment variable
+ * set to 1.
*/
- dis_python_env = getenv("BABELTRACE_DISABLE_PYTHON_PLUGINS");
+ dis_python_env = getenv("LIBBABELTRACE2_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`.");
+ BT_LOGI_STR("Python plugin support is disabled because the "
+ "`LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS` environment "
+ "variable is set to `1`.");
python_state = PYTHON_STATE_WONT_INITIALIZE;
+ ret = BT_FUNC_STATUS_NOT_FOUND;
goto end;
}
py_bt2_py_plugin_mod = PyImport_ImportModule("bt2.py_plugin");
if (!py_bt2_py_plugin_mod) {
- BT_LOGW_STR("Cannot import bt2.py_plugin Python module: Python plugin support is disabled.");
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot import `bt2.py_plugin` Python module: "
+ "Python plugin support is disabled.");
python_state = PYTHON_STATE_CANNOT_INITIALIZE;
+ ret = BT_FUNC_STATUS_ERROR;
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_LOGW_STR("Cannot get _try_load_plugin_module attribute from bt2.py_plugin Python module: Python plugin support is disabled.");
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot get `_try_load_plugin_module` attribute from `bt2.py_plugin` Python module: "
+ "Python plugin support is disabled.");
python_state = PYTHON_STATE_CANNOT_INITIALIZE;
+ ret = BT_FUNC_STATUS_ERROR;
goto end;
}
}
#endif
- print_python_traceback(BT_LOG_WARN);
+ log_python_traceback(ret == BT_FUNC_STATUS_ERROR ?
+ BT_LOG_WARNING : BT_LOG_INFO);
pyerr_clear();
Py_XDECREF(py_bt2_py_plugin_mod);
- return;
+ return ret;
}
__attribute__((destructor)) static
}
static
-enum bt_plugin_status bt_plugin_from_python_plugin_info(PyObject *plugin_info,
+int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
bool fail_on_load_error, bt_plugin **plugin_out)
{
- enum bt_plugin_status status = BT_PLUGIN_STATUS_OK;
+ int status = BT_FUNC_STATUS_OK;
PyObject *py_name = NULL;
PyObject *py_author = NULL;
PyObject *py_description = NULL;
BT_ASSERT(python_state == PYTHON_STATE_FULLY_INITIALIZED);
py_name = PyObject_GetAttrString(plugin_info, "name");
if (!py_name) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot find `name` attribute in Python plugin info object: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot find `name` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot find `name` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
py_author = PyObject_GetAttrString(plugin_info, "author");
if (!py_author) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot find `author` attribute in Python plugin info object: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot find `author` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot find `author` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
py_description = PyObject_GetAttrString(plugin_info, "description");
if (!py_description) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot find `desciption` attribute in Python plugin info object: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot find `description` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot find `description` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
py_license = PyObject_GetAttrString(plugin_info, "license");
if (!py_license) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot find `license` attribute in Python plugin info object: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot find `license` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot find `license` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
py_version = PyObject_GetAttrString(plugin_info, "version");
if (!py_version) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot find `version` attribute in Python plugin info object: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot find `version` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot find `version` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
py_comp_class_addrs = PyObject_GetAttrString(plugin_info,
"comp_class_addrs");
if (!py_comp_class_addrs) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot find `comp_class_addrs` attribute in Python plugin info object: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot find `comp_class_addrs` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot find `comp_class_addrs` attribute in Python plugin info object: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
if (PyUnicode_Check(py_name)) {
name = PyUnicode_AsUTF8(py_name);
if (!name) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot decode Python plugin name string: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ?
- BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot decode Python plugin name string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot decode Python plugin name string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
} else {
/* Plugin name is mandatory */
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Plugin name is not a string: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Plugin name is not a string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Plugin name is not a string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
if (PyUnicode_Check(py_author)) {
author = PyUnicode_AsUTF8(py_author);
if (!author) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot decode Python plugin author string: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ?
- BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot decode Python plugin author string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot decode Python plugin author string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
}
if (PyUnicode_Check(py_description)) {
description = PyUnicode_AsUTF8(py_description);
if (!description) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot decode Python plugin description string: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ?
- BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot decode Python plugin description string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot decode Python plugin description string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
}
if (PyUnicode_Check(py_license)) {
license = PyUnicode_AsUTF8(py_license);
if (!license) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot decode Python plugin license string: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ?
- BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot decode Python plugin license string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot decode Python plugin license string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
}
if (PyErr_Occurred()) {
/* Overflow error, most probably */
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Invalid Python plugin version format: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ?
- BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Invalid Python plugin version format: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Invalid Python plugin version format: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
}
if (PyUnicode_Check(py_extra)) {
version_extra = PyUnicode_AsUTF8(py_extra);
if (!version_extra) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot decode Python plugin version's extra string: "
- "py-plugin-info-addr=%p", plugin_info);
- status = fail_on_load_error ?
- BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot decode Python plugin version's extra string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot decode Python plugin version's extra string: "
+ "py-plugin-info-addr=%p", plugin_info);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
}
*plugin_out = bt_plugin_create_empty(BT_PLUGIN_TYPE_PYTHON);
if (!*plugin_out) {
- BT_LOGE_STR("Cannot create empty plugin object.");
- status = BT_PLUGIN_STATUS_NOMEM;
+ BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin object.");
+ status = BT_FUNC_STATUS_MEMORY_ERROR;
goto error;
}
if (PyLong_Check(py_comp_class_addr)) {
comp_class = PyLong_AsVoidPtr(py_comp_class_addr);
} else {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Component class address is not an integer in Python plugin info object: "
- "py-plugin-info-addr=%p, index=%zu",
- plugin_info, i);
-
if (fail_on_load_error) {
- status = BT_PLUGIN_STATUS_LOADING_ERROR;
- goto error;
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Component class address is not an integer in Python plugin info object: "
+ "py-plugin-info-addr=%p, index=%zu",
+ plugin_info, i);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Component class address is not an integer in Python plugin info object: "
+ "py-plugin-info-addr=%p, index=%zu",
+ plugin_info, i);
+ status = BT_FUNC_STATUS_NOT_FOUND;
}
continue;
status = bt_plugin_add_component_class(*plugin_out,
comp_class);
if (status < 0) {
- BT_LOGE("Cannot add component class to plugin: "
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Cannot add component class to plugin: "
"py-plugin-info-addr=%p, "
"plugin-addr=%p, plugin-name=\"%s\", "
"comp-class-addr=%p, "
goto end;
error:
- BT_ASSERT(status != BT_PLUGIN_STATUS_OK);
- print_python_traceback(fail_on_load_error ? BT_LOG_WARN : BT_LOG_INFO);
+ BT_ASSERT(status != BT_FUNC_STATUS_OK);
+ log_python_traceback(fail_on_load_error ? BT_LOG_WARNING : BT_LOG_INFO);
pyerr_clear();
BT_OBJECT_PUT_REF_AND_RESET(*plugin_out);
}
G_MODULE_EXPORT
-enum bt_plugin_status bt_plugin_python_create_all_from_file(const char *path,
+int bt_plugin_python_create_all_from_file(const char *path,
bool fail_on_load_error, struct bt_plugin_set **plugin_set_out)
{
bt_plugin *plugin = NULL;
PyObject *py_plugin_info = NULL;
gchar *basename = NULL;
size_t path_len;
- enum bt_plugin_status status = BT_PLUGIN_STATUS_OK;
+ int status = BT_FUNC_STATUS_OK;
BT_ASSERT(path);
* here because we already know Python cannot be fully
* initialized.
*/
- status = BT_PLUGIN_STATUS_ERROR;
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Python interpreter could not be initialized previously.");
+ status = BT_FUNC_STATUS_ERROR;
goto error;
} else if (python_state == PYTHON_STATE_WONT_INITIALIZE) {
/*
* Python plugins are disabled, so it's simply not
* found.
*/
- status = BT_PLUGIN_STATUS_NOT_FOUND;
+ BT_LOGI_STR("Python plugin support was disabled previously "
+ "because the `LIBBABELTRACE2_DISABLE_PYTHON_PLUGINS` "
+ "environment variable is set to `1`.");
+ status = BT_FUNC_STATUS_NOT_FOUND;
goto error;
}
PYTHON_PLUGIN_FILE_EXT,
PYTHON_PLUGIN_FILE_EXT_LEN) != 0) {
BT_LOGI("Skipping non-Python file: path=\"%s\"", path);
- status = BT_PLUGIN_STATUS_NOT_FOUND;
+ status = BT_FUNC_STATUS_NOT_FOUND;
goto error;
}
/* File name starts with `bt_plugin_` */
basename = g_path_get_basename(path);
if (!basename) {
- BT_LOGE("Cannot get path's basename: path=\"%s\"", path);
- status = BT_PLUGIN_STATUS_ERROR;
+ BT_LIB_LOGE_APPEND_CAUSE(
+ "Cannot get path's basename: path=\"%s\"", path);
+ status = BT_FUNC_STATUS_ERROR;
goto error;
}
PYTHON_PLUGIN_FILE_PREFIX_LEN) != 0) {
BT_LOGI("Skipping Python file not starting with `%s`: "
"path=\"%s\"", PYTHON_PLUGIN_FILE_PREFIX, path);
- status = BT_PLUGIN_STATUS_NOT_FOUND;
+ status = BT_FUNC_STATUS_NOT_FOUND;
goto error;
}
* 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_WONT_INITIALIZE) {
- /*
- * This is not an error: the environment requires that
- * Python plugins are disabled, so it's simply not
- * found.
- */
- status = BT_PLUGIN_STATUS_NOT_FOUND;
- goto error;
- } else 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_LOGE("Failed to initialize Python interpreter.");
- status = BT_PLUGIN_STATUS_ERROR;
+ status = init_python();
+ if (status != BT_FUNC_STATUS_OK) {
+ /* init_python() logs and append errors */
goto error;
}
py_plugin_info = PyObject_CallFunction(py_try_load_plugin_module_func,
"(s)", path);
if (!py_plugin_info || py_plugin_info == Py_None) {
- BT_LOG_WRITE(fail_on_load_error ?
- BT_LOG_WARN : BT_LOG_INFO, BT_LOG_TAG,
- "Cannot load Python plugin: path=\"%s\"", path);
- print_python_traceback(fail_on_load_error ? BT_LOG_WARN :
- BT_LOG_INFO);
- PyErr_Clear();
- status = fail_on_load_error ? BT_PLUGIN_STATUS_LOADING_ERROR :
- BT_PLUGIN_STATUS_NOT_FOUND;
+ if (fail_on_load_error) {
+ append_python_traceback_error_cause();
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot load Python plugin: path=\"%s\"", path);
+ status = BT_FUNC_STATUS_ERROR;
+ } else {
+ BT_LIB_LOGW(
+ "Cannot load Python plugin: path=\"%s\"", path);
+ status = BT_FUNC_STATUS_NOT_FOUND;
+ }
+
goto error;
}
* bt_plugin_from_python_plugin_info() handles
* `fail_on_load_error`, so this is a "real" error.
*/
- BT_LOGW("Cannot create plugin object from Python plugin info object: "
+ BT_LIB_LOGW_APPEND_CAUSE(
+ "Cannot create plugin object from Python plugin info object: "
"path=\"%s\", py-plugin-info-addr=%p",
path, py_plugin_info);
BT_ASSERT(!plugin);
goto error;
- } else if (status == BT_PLUGIN_STATUS_NOT_FOUND) {
+ } else if (status == BT_FUNC_STATUS_NOT_FOUND) {
BT_ASSERT(!plugin);
goto error;
}
- BT_ASSERT(status == BT_PLUGIN_STATUS_OK);
+ BT_ASSERT(status == BT_FUNC_STATUS_OK);
BT_ASSERT(plugin);
bt_plugin_set_path(plugin, path);
*plugin_set_out = bt_plugin_set_create();
if (!*plugin_set_out) {
- BT_LOGE_STR("Cannot create empty plugin set.");
- status = BT_PLUGIN_STATUS_NOMEM;
+ BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set.");
+ status = BT_FUNC_STATUS_MEMORY_ERROR;
goto error;
}
goto end;
error:
- BT_ASSERT(status != BT_PLUGIN_STATUS_OK);
+ BT_ASSERT(status != BT_FUNC_STATUS_OK);
+ log_python_traceback(BT_LOG_WARNING);
+ pyerr_clear();
BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out);
end:
bt_plugin_put_ref(plugin);
Py_XDECREF(py_plugin_info);
+
g_free(basename);
+
return status;
}
projects / babeltrace.git / blobdiff