Move to kernel style SPDX license identifiers
[babeltrace.git] / src / python-plugin-provider / python-plugin-provider.c
index 765035e2df60dcde37713ffb72c2c699ba3e4b81..78026d6a1fd87e6ddb6883c0ff61fae4eecc964b 100644 (file)
@@ -1,40 +1,25 @@
 /*
- * 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>
@@ -46,7 +31,7 @@
 #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,
 
@@ -79,7 +64,7 @@ void append_python_traceback_error_cause(void)
                }
 
                (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
-                       "Babeltrace library", "%s", exc->str);
+                       BT_LIB_LOG_LIBBABELTRACE2_NAME, "%s", exc->str);
        }
 
 end:
@@ -101,7 +86,7 @@ void log_python_traceback(int log_level)
                }
 
                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:
@@ -140,17 +125,19 @@ int init_python(void)
                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;
@@ -250,7 +237,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Cannot find `name` attribute in Python plugin info object: "
@@ -268,7 +255,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Cannot find `author` attribute in Python plugin info object: "
@@ -286,7 +273,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Cannot find `description` attribute in Python plugin info object: "
@@ -304,7 +291,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Cannot find `license` attribute in Python plugin info object: "
@@ -322,7 +309,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Cannot find `version` attribute in Python plugin info object: "
@@ -341,7 +328,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Cannot find `comp_class_addrs` attribute in Python plugin info object: "
@@ -360,7 +347,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                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_LOGW(
                                        "Cannot decode Python plugin name string: "
@@ -377,7 +364,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                        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_LOGW(
                                "Plugin name is not a string: "
@@ -396,7 +383,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                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_LOGW(
                                        "Cannot decode Python plugin author string: "
@@ -416,7 +403,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                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_LOGW(
                                        "Cannot decode Python plugin description string: "
@@ -436,7 +423,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                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_LOGW(
                                        "Cannot decode Python plugin license string: "
@@ -477,7 +464,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                        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_LOGW(
                                                "Invalid Python plugin version format: "
@@ -502,7 +489,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                                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_LOGW(
                                                        "Cannot decode Python plugin version's extra string: "
@@ -558,7 +545,7 @@ int bt_plugin_from_python_plugin_info(PyObject *plugin_info,
                                                "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_LOGW(
                                                "Component class address is not an integer in Python plugin info object: "
@@ -637,7 +624,9 @@ int bt_plugin_python_create_all_from_file(const char *path,
                 * 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;
        }
@@ -700,7 +689,7 @@ int bt_plugin_python_create_all_from_file(const char *path,
                        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_LOGW(
                                "Cannot load Python plugin: path=\"%s\"", path);
This page took 0.027283 seconds and 4 git commands to generate.