Port: Set PATH_MAX on GNU Hurd
[babeltrace.git] / src / lib / plugin / plugin.c
index aec5ed6837cb94378b173ad7c5a02245189b55d6..434bb3ea5a0d43fa510d894c909a09f0ef8fba14 100644 (file)
@@ -1,43 +1,27 @@
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Author: Jérémie Galarneau <jeremie.galarneau@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 "LIB/PLUGIN"
 #include "lib/logging.h"
 
 #include "common/assert.h"
-#include "lib/assert-pre.h"
+#include "lib/assert-cond.h"
 #include "common/macros.h"
 #include "compat/compiler.h"
+#include "compat/limits.h"
 #include "common/common.h"
-#include <babeltrace2/plugin/plugin-const.h>
-#include <babeltrace2/graph/component-class-const.h>
-#include <babeltrace2/current-thread.h>
+#include <babeltrace2/plugin/plugin-loading.h>
+#include <babeltrace2/graph/component-class.h>
+#include <babeltrace2/error-reporting.h>
 #include "lib/graph/component-class.h"
 #include <babeltrace2/types.h>
 #include <glib.h>
 #include <unistd.h>
+#include <stdbool.h>
 #include <stdlib.h>
 #include <stdint.h>
 #include <inttypes.h>
 
 #define APPEND_ALL_FROM_DIR_NFDOPEN_MAX        8
 
+/* Declare here to make sure definition in both ifdef branches are in sync. */
+static
+int init_python_plugin_provider(void);
+typedef int (*create_all_from_file_sym_type)(
+               const char *path,
+               bool fail_on_load_error,
+               struct bt_plugin_set **plugin_set_out);
+
 #ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
 #include <plugin/python-plugin-provider.h>
 
 static
-int (*bt_plugin_python_create_all_from_file_sym)(
-               const char *path, bool fail_on_load_error,
-               struct bt_plugin_set **plugin_set_out) =
-       bt_plugin_python_create_all_from_file;
+create_all_from_file_sym_type
+       bt_plugin_python_create_all_from_file_sym =
+                       bt_plugin_python_create_all_from_file;
 
 static
-enum bt_plugin_status init_python_plugin_provider(void)
+int init_python_plugin_provider(void)
 {
 }
 #else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */
 static GModule *python_plugin_provider_module;
 
 static
-int (*bt_plugin_python_create_all_from_file_sym)(
-               const char *path, bool fail_on_load_error,
-                struct bt_plugin_set **plugin_set_out);
+create_all_from_file_sym_type bt_plugin_python_create_all_from_file_sym;
 
 static
 int init_python_plugin_provider(void) {
@@ -166,14 +155,14 @@ void fini_python_plugin_provider(void) {
 
 uint64_t bt_plugin_set_get_plugin_count(const struct bt_plugin_set *plugin_set)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin_set, "Plugin set");
+       BT_ASSERT_PRE_DEV_PLUGIN_SET_NON_NULL(plugin_set);
        return (uint64_t) plugin_set->plugins->len;
 }
 
 const struct bt_plugin *bt_plugin_set_borrow_plugin_by_index_const(
                const struct bt_plugin_set *plugin_set, uint64_t index)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin_set, "Plugin set");
+       BT_ASSERT_PRE_DEV_PLUGIN_SET_NON_NULL(plugin_set);
        BT_ASSERT_PRE_DEV_VALID_INDEX(index, plugin_set->plugins->len);
        return g_ptr_array_index(plugin_set->plugins, index);
 }
@@ -182,6 +171,8 @@ enum bt_plugin_find_all_from_static_status bt_plugin_find_all_from_static(
                bt_bool fail_on_load_error,
                const struct bt_plugin_set **plugin_set_out)
 {
+       BT_ASSERT_PRE_NO_ERROR();
+
        /* bt_plugin_so_create_all_from_static() logs errors */
        return bt_plugin_so_create_all_from_static(fail_on_load_error,
                (void *) plugin_set_out);
@@ -193,8 +184,9 @@ enum bt_plugin_find_all_from_file_status bt_plugin_find_all_from_file(
 {
        enum bt_plugin_find_all_from_file_status status;
 
-       BT_ASSERT_PRE_NON_NULL(path, "Path");
-       BT_ASSERT_PRE_NON_NULL(path, "Plugin set (output)");
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_NON_NULL("path", path, "Path");
+       BT_ASSERT_PRE_PLUGIN_SET_OUT_NON_NULL(path);
        BT_LOGI("Creating plugins from file: path=\"%s\"", path);
 
        /* Try shared object plugins */
@@ -276,7 +268,8 @@ enum bt_plugin_find_all_status bt_plugin_find_all(bt_bool find_in_std_env_var,
        int status = BT_FUNC_STATUS_OK;
        uint64_t dir_i, plugin_i;
 
-       BT_ASSERT_PRE_NON_NULL(plugin_set_out, "Plugin set (output)");
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_PLUGIN_SET_OUT_NON_NULL(plugin_set_out);
        BT_LOGI("Finding all plugins in standard directories and built-in plugins: "
                "find-in-std-env-var=%d, find-in-user-dir=%d, "
                "find-in-sys-dir=%d, find-in-static=%d",
@@ -459,8 +452,9 @@ enum bt_plugin_find_status bt_plugin_find(const char *plugin_name,
        const struct bt_plugin_set *plugin_set = NULL;
        uint64_t i;
 
-       BT_ASSERT_PRE_NON_NULL(plugin_name, "Name");
-       BT_ASSERT_PRE_NON_NULL(plugin_out, "Plugin (output)");
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_NAME_NON_NULL(plugin_name);
+       BT_ASSERT_PRE_PLUGIN_OUT_NON_NULL(plugin_out);
        BT_LOGI("Finding named plugin in standard directories and built-in plugins: "
                "name=\"%s\", find-in-std-env-var=%d, find-in-user-dir=%d, "
                "find-in-sys-dir=%d, find-in-static=%d",
@@ -615,7 +609,7 @@ int bt_plugin_create_append_all_from_dir(struct bt_plugin_set *plugin_set,
                        ": path=\"%s\", recurse=%d",
                        path, recurse);
                (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
-                       "Babeltrace library",
+                       BT_LIB_LOG_LIBBABELTRACE2_NAME,
                        "Cannot open directory: path=\"%s\", recurse=%d",
                        path, recurse);
                status = BT_FUNC_STATUS_ERROR;
@@ -660,7 +654,8 @@ enum bt_plugin_find_all_from_dir_status bt_plugin_find_all_from_dir(
        enum bt_plugin_find_all_from_dir_status status =
                BT_FUNC_STATUS_OK;
 
-       BT_ASSERT_PRE_NON_NULL(plugin_set_out, "Plugin set (output)");
+       BT_ASSERT_PRE_NO_ERROR();
+       BT_ASSERT_PRE_PLUGIN_SET_OUT_NON_NULL(plugin_set_out);
        BT_LOGI("Creating all plugins in directory: path=\"%s\", recurse=%d",
                path, recurse);
        *plugin_set_out = bt_plugin_set_create();
@@ -712,31 +707,31 @@ end:
 
 const char *bt_plugin_get_name(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return plugin->info.name_set ? plugin->info.name->str : NULL;
 }
 
 const char *bt_plugin_get_author(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return plugin->info.author_set ? plugin->info.author->str : NULL;
 }
 
 const char *bt_plugin_get_license(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return plugin->info.license_set ? plugin->info.license->str : NULL;
 }
 
 const char *bt_plugin_get_path(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return plugin->info.path_set ? plugin->info.path->str : NULL;
 }
 
 const char *bt_plugin_get_description(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return plugin->info.description_set ?
                plugin->info.description->str : NULL;
 }
@@ -748,7 +743,7 @@ enum bt_property_availability bt_plugin_get_version(const struct bt_plugin *plug
        enum bt_property_availability avail =
                BT_PROPERTY_AVAILABILITY_AVAILABLE;
 
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
 
        if (!plugin->info.version_set) {
                BT_LIB_LOGD("Plugin's version is not set: %!+l", plugin);
@@ -778,19 +773,19 @@ end:
 
 uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return (uint64_t) plugin->src_comp_classes->len;
 }
 
 uint64_t bt_plugin_get_filter_component_class_count(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return (uint64_t) plugin->flt_comp_classes->len;
 }
 
 uint64_t bt_plugin_get_sink_component_class_count(const struct bt_plugin *plugin)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        return (uint64_t) plugin->sink_comp_classes->len;
 }
 
@@ -799,7 +794,7 @@ struct bt_component_class *borrow_component_class_by_index(
                const struct bt_plugin *plugin, GPtrArray *comp_classes,
                uint64_t index)
 {
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
        BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp_classes->len);
        return g_ptr_array_index(comp_classes, index);
 }
@@ -836,8 +831,8 @@ struct bt_component_class *borrow_component_class_by_name(
        struct bt_component_class *comp_class = NULL;
        size_t i;
 
-       BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin");
-       BT_ASSERT_PRE_DEV_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_DEV_PLUGIN_NON_NULL(plugin);
+       BT_ASSERT_PRE_DEV_NAME_NON_NULL(name);
 
        for (i = 0; i < comp_classes->len; i++) {
                struct bt_component_class *comp_class_candidate =
This page took 0.026195 seconds and 4 git commands to generate.