/*
- * 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/current-thread.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,
GString *exc = NULL;
if (Py_IsInitialized() && PyErr_Occurred()) {
- exc = bt_py_common_format_exception(BT_LOG_OUTPUT_LEVEL);
+ 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(
- "Babeltrace library", "%s", exc->str);
+ BT_LIB_LOG_LIBBABELTRACE2_NAME, "%s", exc->str);
}
end:
GString *exc = NULL;
if (Py_IsInitialized() && PyErr_Occurred()) {
- exc = bt_py_common_format_exception(BT_LOG_OUTPUT_LEVEL);
+ 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:\n%s", exc->str);
+ "Exception occurred: Python traceback:\n%s", exc->str);
}
end:
ret = BT_FUNC_STATUS_ERROR;
goto end;
default:
- abort();
+ 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;
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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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;
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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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;
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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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;
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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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;
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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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;
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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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;
BT_LIB_LOGW_APPEND_CAUSE(
"Cannot decode Python plugin name string: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Cannot decode Python plugin name string: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
BT_LIB_LOGW_APPEND_CAUSE(
"Plugin name is not a string: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Plugin name is not a string: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
BT_LIB_LOGW_APPEND_CAUSE(
"Cannot decode Python plugin author string: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Cannot decode Python plugin author string: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
BT_LIB_LOGW_APPEND_CAUSE(
"Cannot decode Python plugin description string: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Cannot decode Python plugin description string: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
BT_LIB_LOGW_APPEND_CAUSE(
"Cannot decode Python plugin license string: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Cannot decode Python plugin license string: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
BT_LIB_LOGW_APPEND_CAUSE(
"Invalid Python plugin version format: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Invalid Python plugin version format: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
BT_LIB_LOGW_APPEND_CAUSE(
"Cannot decode Python plugin version's extra string: "
"py-plugin-info-addr=%p", plugin_info);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Cannot decode Python plugin version's extra string: "
"py-plugin-info-addr=%p", plugin_info);
status = BT_FUNC_STATUS_NOT_FOUND;
"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_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ 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);
* Python plugins are disabled, so it's simply not
* found.
*/
- BT_LOGI_STR("Python plugin support was disabled previously because `BABELTRACE_DISABLE_PYTHON_PLUGINS=1`.");
+ 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;
}
append_python_traceback_error_cause();
BT_LIB_LOGW_APPEND_CAUSE(
"Cannot load Python plugin: path=\"%s\"", path);
- status = BT_FUNC_STATUS_LOADING_ERROR;
+ status = BT_FUNC_STATUS_ERROR;
} else {
- BT_LIB_LOGI(
+ BT_LIB_LOGW(
"Cannot load Python plugin: path=\"%s\"", path);
status = BT_FUNC_STATUS_NOT_FOUND;
}
error:
BT_ASSERT(status != BT_FUNC_STATUS_OK);
- log_python_traceback(fail_on_load_error ? BT_LOG_WARNING : BT_LOG_INFO);
+ log_python_traceback(BT_LOG_WARNING);
pyerr_clear();
BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out);