/*
- * plugin.c
- *
- * Babeltrace Plugin
- *
+ * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
*
* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
*
* SOFTWARE.
*/
-#include <babeltrace/compiler.h>
-#include <babeltrace/ref.h>
-#include <babeltrace/plugin/plugin-dev.h>
-#include <babeltrace/plugin/plugin-internal.h>
-#include <babeltrace/component/component-class-internal.h>
-#include <string.h>
-#include <stdbool.h>
+#define BT_LOG_TAG "PLUGIN"
+#include <babeltrace2/lib-logging-internal.h>
+
+#include <babeltrace2/assert-internal.h>
+#include <babeltrace2/assert-pre-internal.h>
+#include <babeltrace2/babeltrace-internal.h>
+#include <babeltrace2/compiler-internal.h>
+#include <babeltrace2/common-internal.h>
+#include <babeltrace2/plugin/plugin-internal.h>
+#include <babeltrace2/plugin/plugin-so-internal.h>
+#include <babeltrace2/plugin/plugin-const.h>
+#include <babeltrace2/graph/component-class-const.h>
+#include <babeltrace2/graph/component-class-internal.h>
+#include <babeltrace2/types.h>
#include <glib.h>
-#include <gmodule.h>
#include <unistd.h>
#include <stdlib.h>
+#include <stdint.h>
+#include <inttypes.h>
#include <sys/stat.h>
-#include <dirent.h>
-
-#define PLUGIN_SYMBOL_NAME "__bt_plugin_name"
-#define PLUGIN_SYMBOL_AUTHOR "__bt_plugin_author"
-#define PLUGIN_SYMBOL_LICENSE "__bt_plugin_license"
-#define PLUGIN_SYMBOL_INIT "__bt_plugin_init"
-#define PLUGIN_SYMBOL_EXIT "__bt_plugin_exit"
-#define PLUGIN_SYMBOL_DESCRIPTION "__bt_plugin_description"
-#define NATIVE_PLUGIN_SUFFIX ".so"
-#define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
-#define LIBTOOL_PLUGIN_SUFFIX ".la"
-#define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
-
-#define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
- sizeof(LIBTOOL_PLUGIN_SUFFIX))
-
-#define SECTION_BEGIN(_name) &__start_##_name
-#define SECTION_END(_name) &__stop_##_name
-#define SECTION_ELEMENT_COUNT(_name) (SECTION_END(_name) - SECTION_BEGIN(_name))
-
-#define DECLARE_SECTION(_type, _name) \
- extern _type const __start_##_name __attribute((weak)); \
- extern _type const __stop_##_name __attribute((weak))
-
-DECLARE_SECTION(bt_plugin_init_func, __bt_plugin_init_funcs);
-DECLARE_SECTION(bt_plugin_exit_func, __bt_plugin_exit_funcs);
-DECLARE_SECTION(const char *, __bt_plugin_names);
-DECLARE_SECTION(const char *, __bt_plugin_authors);
-DECLARE_SECTION(const char *, __bt_plugin_licenses);
-DECLARE_SECTION(const char *, __bt_plugin_descriptions);
-
-#define PRINT_SECTION(_printer, _name) \
- do { \
- _printer("Section " #_name " [%p - %p], (%zu elements)\n", \
- SECTION_BEGIN(_name), SECTION_END(_name), \
- SECTION_ELEMENT_COUNT(_name)); \
- } while (0)
-
-#define PRINT_PLUG_IN_SECTIONS(_printer) \
- do { \
- PRINT_SECTION(_printer, __bt_plugin_init_funcs); \
- PRINT_SECTION(_printer, __bt_plugin_exit_funcs); \
- PRINT_SECTION(_printer, __bt_plugin_names); \
- PRINT_SECTION(_printer, __bt_plugin_authors); \
- PRINT_SECTION(_printer, __bt_plugin_licenses); \
- PRINT_SECTION(_printer, __bt_plugin_descriptions); \
- } while (0)
+#include <ftw.h>
+#include <pthread.h>
-/*
- * This hash table, global to the library, maps component class pointers
- * to shared library handles.
- *
- * The keys (component classes) are NOT owned by this hash table, whereas
- * the values (shared library handles) are owned by this hash table.
- *
- * The keys are the component classes created with
- * bt_plugin_add_component_class(). They keep the shared library handle
- * object created by their plugin alive so that the plugin's code is
- * not discarded when it could still be in use by living components
- * created from those component classes:
- *
- * [component] --ref-> [component class] --through this HT-> [shlib handle]
- *
- * This hash table exists for two reasons:
- *
- * 1. To allow this application:
- *
- * my_plugin = bt_plugin_create_from_file("/path/to/my-plugin.so");
- * // instantiate components from the plugin's component classes
- * BT_PUT(my_plugin);
- * // user code of instantiated components still exists
- *
- * 2. To decouple the plugin subsystem from the component subsystem:
- * while plugins objects need to know component class objects, the
- * opposite is not necessary, thus it makes no sense for a component
- * class to keep a reference to the plugin object from which it was
- * created.
- *
- * An entry is removed from this HT when a component class is destroyed
- * thanks to a custom destroy listener. When the entry is removed, the
- * GLib function calls the value destroy notifier of the HT, which is
- * bt_put(). This decreases the reference count of the mapped shared
- * library handle. Assuming the original plugin object which contained
- * some component classes is put first, when the last component class is
- * removed from this HT, the shared library handle object's reference
- * count falls to zero and the shared library is finally closed.
- */
-static
-GHashTable *comp_classes_to_shlib_handles;
+#define PYTHON_PLUGIN_PROVIDER_FILENAME "libbabeltrace2-python-plugin-provider." G_MODULE_SUFFIX
+#define PYTHON_PLUGIN_PROVIDER_SYM_NAME bt_plugin_python_create_all_from_file
+#define PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR TOSTRING(PYTHON_PLUGIN_PROVIDER_SYM_NAME)
-__attribute__((constructor)) static
-void init_comp_classes_to_shlib_handles(void) {
- comp_classes_to_shlib_handles = g_hash_table_new_full(g_direct_hash,
- g_direct_equal, NULL, bt_put);
- assert(comp_classes_to_shlib_handles);
-}
+#define APPEND_ALL_FROM_DIR_NFDOPEN_MAX 8
-__attribute__((destructor)) static
-void fini_comp_classes_to_shlib_handles(void) {
- if (comp_classes_to_shlib_handles) {
- g_hash_table_destroy(comp_classes_to_shlib_handles);
- }
-}
+#ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
+#include <babeltrace2/plugin/python-plugin-provider-internal.h>
static
-void bt_plugin_shared_lib_handle_destroy(struct bt_object *obj)
-{
- struct bt_plugin_shared_lib_handle *shared_lib_handle;
+struct bt_plugin_set *(*bt_plugin_python_create_all_from_file_sym)(const char *path) =
+ bt_plugin_python_create_all_from_file;
- assert(obj);
- shared_lib_handle = container_of(obj,
- struct bt_plugin_shared_lib_handle, base);
-
- if (shared_lib_handle->init_called && shared_lib_handle->exit) {
- enum bt_plugin_status status = shared_lib_handle->exit();
+static
+void init_python_plugin_provider(void) {}
+#else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */
+static GModule *python_plugin_provider_module;
+static
+struct bt_plugin_set *(*bt_plugin_python_create_all_from_file_sym)(const char *path);
- if (status < 0) {
- printf_verbose("Plugin `%s` exited with error %d\n",
- shared_lib_handle->name, status);
- }
+static
+void init_python_plugin_provider(void) {
+ if (bt_plugin_python_create_all_from_file_sym != NULL) {
+ return;
}
- if (shared_lib_handle->module) {
- if (!g_module_close(shared_lib_handle->module)) {
- printf_error("Module close error: %s\n",
- g_module_error());
- }
+ BT_LOGD_STR("Loading Python plugin provider module.");
+ python_plugin_provider_module =
+ g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME, 0);
+ if (!python_plugin_provider_module) {
+ BT_LOGI("Cannot open `%s`: %s: continuing without Python plugin support.",
+ PYTHON_PLUGIN_PROVIDER_FILENAME, g_module_error());
+ return;
}
- if (shared_lib_handle->path) {
- g_string_free(shared_lib_handle->path, TRUE);
+ if (!g_module_symbol(python_plugin_provider_module,
+ PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR,
+ (gpointer) &bt_plugin_python_create_all_from_file_sym)) {
+ BT_LOGI("Cannot find the Python plugin provider loading symbol: continuing without Python plugin support: "
+ "file=\"%s\", symbol=\"%s\"",
+ PYTHON_PLUGIN_PROVIDER_FILENAME,
+ PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR);
+ return;
}
- g_free(shared_lib_handle);
+ BT_LOGI("Loaded Python plugin provider module: addr=%p",
+ python_plugin_provider_module);
}
-static
-struct bt_plugin_shared_lib_handle *bt_plugin_shared_lib_handle_create(
- const char *path)
-{
- struct bt_plugin_shared_lib_handle *shared_lib_handle = NULL;
- gpointer symbol = NULL;
-
- shared_lib_handle = g_new0(struct bt_plugin_shared_lib_handle, 1);
- if (!shared_lib_handle) {
- goto error;
- }
+__attribute__((destructor)) static
+void fini_python_plugin_provider(void) {
+ if (python_plugin_provider_module) {
+ BT_LOGD("Unloading Python plugin provider module.");
- bt_object_init(shared_lib_handle, bt_plugin_shared_lib_handle_destroy);
+ if (!g_module_close(python_plugin_provider_module)) {
+ BT_LOGE("Failed to close the Python plugin provider module: %s.",
+ g_module_error());
+ }
- if (!path) {
- goto end;
+ python_plugin_provider_module = NULL;
}
+}
+#endif
- shared_lib_handle->path = g_string_new(path);
- if (!shared_lib_handle->path) {
- goto error;
- }
+uint64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set)
+{
+ BT_ASSERT_PRE_NON_NULL(plugin_set, "Plugin set");
+ return (uint64_t) plugin_set->plugins->len;
+}
- shared_lib_handle->module = g_module_open(path, 0);
- if (!shared_lib_handle->module) {
- printf_verbose("Module open error: %s\n", g_module_error());
- goto error;
- }
+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_NON_NULL(plugin_set, "Plugin set");
+ BT_ASSERT_PRE_VALID_INDEX(index, plugin_set->plugins->len);
+ return g_ptr_array_index(plugin_set->plugins, index);
+}
- if (!g_module_symbol(shared_lib_handle->module, PLUGIN_SYMBOL_NAME,
- (gpointer *) &shared_lib_handle->name)) {
- printf_verbose("Unable to resolve plugin symbol %s from %s\n",
- PLUGIN_SYMBOL_NAME,
- g_module_name(shared_lib_handle->module));
- goto error;
- }
+const struct bt_plugin_set *bt_plugin_find_all_from_static(void)
+{
+ /* bt_plugin_so_create_all_from_static() logs errors */
+ return bt_plugin_so_create_all_from_static();
+}
- if (!g_module_symbol(shared_lib_handle->module, PLUGIN_SYMBOL_LICENSE,
- (gpointer *) &shared_lib_handle->license)) {
- printf_verbose("Unable to resolve plugin symbol %s from %s\n",
- PLUGIN_SYMBOL_LICENSE,
- g_module_name(shared_lib_handle->module));
- goto error;
- }
+const struct bt_plugin_set *bt_plugin_find_all_from_file(const char *path)
+{
+ struct bt_plugin_set *plugin_set = NULL;
- if (!g_module_symbol(shared_lib_handle->module, PLUGIN_SYMBOL_AUTHOR,
- (gpointer *) &shared_lib_handle->author)) {
- printf_verbose("Unable to resolve plugin symbol %s from %s\n",
- PLUGIN_SYMBOL_AUTHOR,
- g_module_name(shared_lib_handle->module));
- goto error;
- }
+ BT_ASSERT_PRE_NON_NULL(path, "Path");
+ BT_LOGD("Creating plugins from file: path=\"%s\"", path);
- if (!g_module_symbol(shared_lib_handle->module, PLUGIN_SYMBOL_DESCRIPTION,
- (gpointer *) &shared_lib_handle->description)) {
- printf_verbose("Unable to resolve plugin symbol %s from %s\n",
- PLUGIN_SYMBOL_DESCRIPTION,
- g_module_name(shared_lib_handle->module));
- goto error;
+ /* Try shared object plugins */
+ plugin_set = bt_plugin_so_create_all_from_file(path);
+ if (plugin_set) {
+ goto end;
}
- if (!g_module_symbol(shared_lib_handle->module, PLUGIN_SYMBOL_INIT,
- &symbol)) {
- printf_verbose("Unable to resolve plugin symbol %s from %s\n",
- PLUGIN_SYMBOL_INIT,
- g_module_name(shared_lib_handle->module));
- goto error;
- } else {
- shared_lib_handle->init = *((bt_plugin_init_func *) symbol);
- if (!shared_lib_handle->init) {
- printf_verbose("NULL %s symbol target\n",
- PLUGIN_SYMBOL_INIT);
- goto error;
+ /* Try Python plugins if support is available */
+ init_python_plugin_provider();
+ if (bt_plugin_python_create_all_from_file_sym) {
+ plugin_set = bt_plugin_python_create_all_from_file_sym(path);
+ if (plugin_set) {
+ goto end;
}
}
- if (!g_module_symbol(shared_lib_handle->module, PLUGIN_SYMBOL_EXIT,
- &symbol)) {
- printf_verbose("Unable to resolve plugin symbol %s from %s\n",
- PLUGIN_SYMBOL_EXIT,
- g_module_name(shared_lib_handle->module));
- goto error;
+end:
+ if (plugin_set) {
+ BT_LOGD("Created %u plugins from file: "
+ "path=\"%s\", count=%u, plugin-set-addr=%p",
+ plugin_set->plugins->len, path,
+ plugin_set->plugins->len, plugin_set);
} else {
- shared_lib_handle->exit = *((bt_plugin_exit_func *) symbol);
- if (!shared_lib_handle->exit) {
- printf_verbose("NULL %s symbol target\n",
- PLUGIN_SYMBOL_EXIT);
- goto error;
- }
+ BT_LOGD("Found no plugins in file: path=\"%s\"", path);
}
- goto end;
-
-error:
- BT_PUT(shared_lib_handle);
-
-end:
- return shared_lib_handle;
+ return plugin_set;
}
-static
-void bt_plugin_destroy(struct bt_object *obj)
+static void destroy_gstring(void *data)
{
- struct bt_plugin *plugin;
-
- assert(obj);
- plugin = container_of(obj, struct bt_plugin, base);
-
- BT_PUT(plugin->shared_lib_handle);
-
- if (plugin->comp_classes) {
- g_ptr_array_free(plugin->comp_classes, TRUE);
- }
-
- g_free(plugin);
+ g_string_free(data, TRUE);
}
-static
-enum bt_plugin_status init_plugin(struct bt_plugin *plugin)
+const struct bt_plugin *bt_plugin_find(const char *plugin_name)
{
- enum bt_plugin_status status = BT_PLUGIN_STATUS_OK;
-
- if (plugin->shared_lib_handle->init) {
- status = plugin->shared_lib_handle->init(plugin);
-
- if (status < 0) {
- printf_verbose("Plugin `%s` initialization error: %d\n",
- plugin->shared_lib_handle->name, status);
- goto end;
- }
+ const char *system_plugin_dir;
+ char *home_plugin_dir = NULL;
+ const char *envvar;
+ const struct bt_plugin *plugin = NULL;
+ const struct bt_plugin_set *plugin_set = NULL;
+ GPtrArray *dirs = NULL;
+ int ret;
+ size_t i, j;
+
+ BT_ASSERT_PRE_NON_NULL(plugin_name, "Name");
+ BT_LOGD("Finding named plugin in standard directories and built-in plugins: "
+ "name=\"%s\"", plugin_name);
+ dirs = g_ptr_array_new_with_free_func((GDestroyNotify) destroy_gstring);
+ if (!dirs) {
+ BT_LOGE_STR("Failed to allocate a GPtrArray.");
+ goto end;
}
- plugin->shared_lib_handle->init_called = true;
-
/*
- * The initialization function should have added the component
- * classes at this point. We freeze the plugin so that it's not
- * possible to add component classes to this plugin object after
- * this stage (plugin object becomes immutable).
+ * Search order is:
+ *
+ * 1. BABELTRACE_PLUGIN_PATH environment variable
+ * (colon-separated list of directories)
+ * 2. ~/.local/lib/babeltrace2/plugins
+ * 3. Default system directory for Babeltrace plugins, usually
+ * /usr/lib/babeltrace2/plugins or
+ * /usr/local/lib/babeltrace2/plugins if installed
+ * locally
+ * 4. Built-in plugins (static)
+ *
+ * Directories are searched non-recursively.
*/
- plugin->frozen = true;
+ envvar = getenv("BABELTRACE_PLUGIN_PATH");
+ if (envvar) {
+ ret = bt_common_append_plugin_path_dirs(envvar, dirs);
+ if (ret) {
+ BT_LOGE_STR("Failed to append plugin path to array of directories.");
+ goto end;
+ }
+ }
-end:
- return status;
-}
+ home_plugin_dir = bt_common_get_home_plugin_path();
+ if (home_plugin_dir) {
+ GString *home_plugin_dir_str =
+ g_string_new(home_plugin_dir);
-struct bt_plugin *bt_plugin_create_from_file(const char *path)
-{
- size_t path_len;
- struct bt_plugin *plugin = NULL;
- bool is_libtool_wrapper = false, is_shared_object = false;
+ if (!home_plugin_dir_str) {
+ BT_LOGE_STR("Failed to allocate a GString.");
+ goto end;
+ }
- if (!path) {
- goto error;
+ g_ptr_array_add(dirs, home_plugin_dir_str);
}
- path_len = strlen(path);
- if (path_len <= PLUGIN_SUFFIX_LEN) {
- goto error;
- }
+ system_plugin_dir = bt_common_get_system_plugin_path();
+ if (system_plugin_dir) {
+ GString *system_plugin_dir_str =
+ g_string_new(system_plugin_dir);
- path_len++;
- /*
- * Check if the file ends with a known plugin file type suffix (i.e. .so
- * or .la on Linux).
- */
- is_libtool_wrapper = !strncmp(LIBTOOL_PLUGIN_SUFFIX,
- path + path_len - LIBTOOL_PLUGIN_SUFFIX_LEN,
- LIBTOOL_PLUGIN_SUFFIX_LEN);
- is_shared_object = !strncmp(NATIVE_PLUGIN_SUFFIX,
- path + path_len - NATIVE_PLUGIN_SUFFIX_LEN,
- NATIVE_PLUGIN_SUFFIX_LEN);
- if (!is_shared_object && !is_libtool_wrapper) {
- /* Name indicates that this is not a plugin file. */
- goto error;
- }
+ if (!system_plugin_dir_str) {
+ BT_LOGE_STR("Failed to allocate a GString.");
+ goto end;
+ }
- plugin = g_new0(struct bt_plugin, 1);
- if (!plugin) {
- goto error;
+ g_ptr_array_add(dirs, system_plugin_dir_str);
}
- bt_object_init(plugin, bt_plugin_destroy);
+ for (i = 0; i < dirs->len; i++) {
+ GString *dir = g_ptr_array_index(dirs, i);
- /* Create shared lib handle */
- plugin->shared_lib_handle = bt_plugin_shared_lib_handle_create(path);
- if (!plugin->shared_lib_handle) {
- printf_verbose("Failed to create a shared library handle (path `%s`)\n",
- path);
- goto error;
- }
+ BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
- /* Create empty array of component classes */
- plugin->comp_classes =
- g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
- if (!plugin->comp_classes) {
- goto error;
- }
+ /*
+ * Skip this if the directory does not exist because
+ * bt_plugin_find_all_from_dir() would log a warning.
+ */
+ if (!g_file_test(dir->str, G_FILE_TEST_IS_DIR)) {
+ BT_LOGV("Skipping nonexistent directory path: "
+ "path=\"%s\"", dir->str);
+ continue;
+ }
- /* Initialize plugin */
- if (init_plugin(plugin) < 0) {
- goto error;
- }
+ /* bt_plugin_find_all_from_dir() logs details/errors */
+ plugin_set = bt_plugin_find_all_from_dir(dir->str, BT_FALSE);
+ if (!plugin_set) {
+ BT_LOGD("No plugins found in directory: path=\"%s\"",
+ dir->str);
+ continue;
+ }
- goto end;
+ for (j = 0; j < plugin_set->plugins->len; j++) {
+ const struct bt_plugin *candidate_plugin =
+ g_ptr_array_index(plugin_set->plugins, j);
-error:
- BT_PUT(plugin);
+ if (strcmp(bt_plugin_get_name(candidate_plugin),
+ plugin_name) == 0) {
+ BT_LOGD("Plugin found in directory: name=\"%s\", path=\"%s\"",
+ plugin_name, dir->str);
+ plugin = candidate_plugin;
+ bt_object_get_no_null_check(plugin);
+ goto end;
+ }
+ }
-end:
- return plugin;
-}
+ BT_LOGD("Plugin not found in directory: name=\"%s\", path=\"%s\"",
+ plugin_name, dir->str);
+ }
-/* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
-static
-struct dirent *alloc_dirent(const char *path)
-{
- size_t len;
- long name_max;
- struct dirent *entry;
+ bt_object_put_ref(plugin_set);
+ plugin_set = bt_plugin_find_all_from_static();
+ if (plugin_set) {
+ for (j = 0; j < plugin_set->plugins->len; j++) {
+ const struct bt_plugin *candidate_plugin =
+ g_ptr_array_index(plugin_set->plugins, j);
- name_max = pathconf(path, _PC_NAME_MAX);
- if (name_max == -1) {
- name_max = PATH_MAX;
+ if (strcmp(bt_plugin_get_name(candidate_plugin),
+ plugin_name) == 0) {
+ BT_LOGD("Plugin found in built-in plugins: "
+ "name=\"%s\"", plugin_name);
+ plugin = candidate_plugin;
+ bt_object_get_no_null_check(plugin);
+ goto end;
+ }
+ }
}
- len = offsetof(struct dirent, d_name) + name_max + 1;
- entry = zmalloc(len);
- return entry;
-}
-static
-enum bt_plugin_status bt_plugin_create_append_all_from_dir(
- GPtrArray *plugins, const char *path, bool recurse)
-{
- DIR *directory = NULL;
- struct dirent *entry = NULL, *result = NULL;
- char *file_path = NULL;
- size_t path_len = strlen(path);
- enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
+end:
+ free(home_plugin_dir);
+ bt_object_put_ref(plugin_set);
- if (path_len >= PATH_MAX) {
- ret = BT_PLUGIN_STATUS_ERROR;
- goto end;
+ if (dirs) {
+ g_ptr_array_free(dirs, TRUE);
}
- entry = alloc_dirent(path);
- if (!entry) {
- ret = BT_PLUGIN_STATUS_ERROR;
- goto end;
+ if (plugin) {
+ BT_LIB_LOGD("Found plugin in standard directories and built-in plugins: "
+ "%!+l", plugin);
+ } else {
+ BT_LOGD("No plugin found in standard directories and built-in plugins: "
+ "name=\"%s\"", plugin_name);
}
- file_path = zmalloc(PATH_MAX);
- if (!file_path) {
- ret = BT_PLUGIN_STATUS_NOMEM;
- goto end;
- }
+ return plugin;
+}
- strncpy(file_path, path, path_len);
- /* Append a trailing '/' to the path */
- if (file_path[path_len - 1] != '/') {
- file_path[path_len++] = '/';
- }
+static struct {
+ pthread_mutex_t lock;
+ struct bt_plugin_set *plugin_set;
+ bool recurse;
+} append_all_from_dir_info = {
+ .lock = PTHREAD_MUTEX_INITIALIZER
+};
- directory = opendir(file_path);
- if (!directory) {
- perror("Failed to open plug-in directory");
- ret = BT_PLUGIN_STATUS_ERROR;
+static
+int nftw_append_all_from_dir(const char *file, const struct stat *sb, int flag,
+ struct FTW *s)
+{
+ int ret = 0;
+ const char *name = file + s->base;
+
+ /* Check for recursion */
+ if (!append_all_from_dir_info.recurse && s->level > 1) {
goto end;
}
- /* Recursively walk directory */
- while (!readdir_r(directory, entry, &result) && result) {
- struct stat st;
- int stat_ret;
- size_t file_name_len;
+ switch (flag) {
+ case FTW_F:
+ {
+ const struct bt_plugin_set *plugins_from_file;
- if (result->d_name[0] == '.') {
- /* Skip hidden files, . and .. */
- continue;
+ if (name[0] == '.') {
+ /* Skip hidden files */
+ BT_LOGV("Skipping hidden file: path=\"%s\"", file);
+ goto end;
}
- file_name_len = strlen(result->d_name);
+ plugins_from_file = bt_plugin_find_all_from_file(file);
- if (path_len + file_name_len >= PATH_MAX) {
- continue;
- }
+ if (plugins_from_file) {
+ size_t j;
- strncpy(file_path + path_len, result->d_name, file_name_len);
- file_path[path_len + file_name_len] = '\0';
-
- stat_ret = stat(file_path, &st);
- if (stat_ret < 0) {
- /* Continue to next file / directory. */
- printf_perror("Failed to stat() plugin file\n");
- continue;
- }
+ for (j = 0; j < plugins_from_file->plugins->len; j++) {
+ struct bt_plugin *plugin =
+ g_ptr_array_index(plugins_from_file->plugins, j);
- if (S_ISDIR(st.st_mode) && recurse) {
- ret = bt_plugin_create_append_all_from_dir(plugins,
- file_path, true);
- if (ret < 0) {
- goto end;
+ BT_LIB_LOGD("Adding plugin to plugin set: "
+ "plugin-path=\"%s\", %![plugin-]+l",
+ file, plugin);
+ bt_plugin_set_add_plugin(
+ append_all_from_dir_info.plugin_set,
+ plugin);
}
- } else if (S_ISREG(st.st_mode)) {
- struct bt_plugin *plugin = bt_plugin_create_from_file(file_path);
- if (plugin) {
- /* Transfer ownership to array */
- g_ptr_array_add(plugins, plugin);
- }
+ bt_object_put_ref(plugins_from_file);
}
+ break;
}
-end:
- if (directory) {
- if (closedir(directory)) {
- /*
- * We don't want to override the error since there is
- * nothing could do.
- */
- perror("Failed to close plug-in directory");
- }
+ case FTW_DNR:
+ /* Continue to next file / directory. */
+ BT_LOGW("Cannot enter directory: continuing: path=\"%s\"", file);
+ break;
+ case FTW_NS:
+ /* Continue to next file / directory. */
+ BT_LOGD("Cannot get file information: continuing: path=\"%s\"", file);
+ break;
}
- free(entry);
- free(file_path);
+
+end:
return ret;
}
-struct bt_plugin **bt_plugin_create_all_from_dir(const char *path,
- bool recurse)
+static
+enum bt_plugin_status bt_plugin_create_append_all_from_dir(
+ struct bt_plugin_set *plugin_set, const char *path,
+ bt_bool recurse)
{
- GPtrArray *plugins_array = NULL;
- struct bt_plugin **plugins = NULL;
- enum bt_plugin_status status;
+ int nftw_flags = FTW_PHYS;
+ enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
- if (!path) {
- goto error;
+ BT_ASSERT(plugin_set);
+ BT_ASSERT(path);
+ BT_ASSERT(strlen(path) < PATH_MAX);
+ pthread_mutex_lock(&append_all_from_dir_info.lock);
+ append_all_from_dir_info.plugin_set = plugin_set;
+ append_all_from_dir_info.recurse = recurse;
+ ret = nftw(path, nftw_append_all_from_dir,
+ APPEND_ALL_FROM_DIR_NFDOPEN_MAX, nftw_flags);
+ pthread_mutex_unlock(&append_all_from_dir_info.lock);
+ if (ret != 0) {
+ BT_LOGW_ERRNO("Cannot open directory", ": path=\"%s\"", path);
+ ret = BT_PLUGIN_STATUS_ERROR;
}
- plugins_array = g_ptr_array_new();
- if (!plugins_array) {
+ return ret;
+}
+
+const struct bt_plugin_set *bt_plugin_find_all_from_dir(const char *path,
+ bt_bool recurse)
+{
+ struct bt_plugin_set *plugin_set;
+ enum bt_plugin_status status;
+
+ BT_LOGD("Creating all plugins in directory: path=\"%s\", recurse=%d",
+ path, recurse);
+ plugin_set = bt_plugin_set_create();
+ if (!plugin_set) {
+ BT_LOGE_STR("Cannot create empty plugin set.");
goto error;
}
/* Append found plugins to array */
- status = bt_plugin_create_append_all_from_dir(plugins_array, path,
+ status = bt_plugin_create_append_all_from_dir(plugin_set, path,
recurse);
if (status < 0) {
+ BT_LOGW("Cannot append plugins found in directory: "
+ "path=\"%s\", status=%s",
+ path, bt_plugin_status_string(status));
goto error;
}
- /* Add sentinel to array */
- g_ptr_array_add(plugins_array, NULL);
- plugins = (struct bt_plugin **) plugins_array->pdata;
+ BT_LOGD("Created %u plugins from directory: count=%u, path=\"%s\"",
+ plugin_set->plugins->len, plugin_set->plugins->len, path);
goto end;
error:
- if (plugins_array) {
- g_ptr_array_free(plugins_array, TRUE);
- plugins_array = NULL;
- }
+ BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
end:
- if (plugins_array) {
- g_ptr_array_free(plugins_array, FALSE);
- }
+ return plugin_set;
+}
- return plugins;
+const char *bt_plugin_get_name(const struct bt_plugin *plugin)
+{
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return plugin->info.name_set ? plugin->info.name->str : NULL;
}
-static
-struct bt_plugin *bt_plugin_create_from_static_at_index(size_t i)
+const char *bt_plugin_get_author(const struct bt_plugin *plugin)
{
- struct bt_plugin *plugin = NULL;
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return plugin->info.author_set ? plugin->info.author->str : NULL;
+}
- plugin = g_new0(struct bt_plugin, 1);
- if (!plugin) {
- goto error;
- }
+const char *bt_plugin_get_license(const struct bt_plugin *plugin)
+{
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return plugin->info.license_set ? plugin->info.license->str : NULL;
+}
- bt_object_init(plugin, bt_plugin_destroy);
+const char *bt_plugin_get_path(const struct bt_plugin *plugin)
+{
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return plugin->info.path_set ? plugin->info.path->str : NULL;
+}
- /* Create shared lib handle */
- plugin->shared_lib_handle = bt_plugin_shared_lib_handle_create(NULL);
- if (!plugin->shared_lib_handle) {
- goto error;
- }
+const char *bt_plugin_get_description(const struct bt_plugin *plugin)
+{
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return plugin->info.description_set ?
+ plugin->info.description->str : NULL;
+}
- /* Fill shared lib handle */
- plugin->shared_lib_handle->init =
- (SECTION_BEGIN(__bt_plugin_init_funcs))[i];
- if (!plugin->shared_lib_handle->init) {
- goto error;
- }
+enum bt_property_availability bt_plugin_get_version(const struct bt_plugin *plugin,
+ unsigned int *major, unsigned int *minor, unsigned int *patch,
+ const char **extra)
+{
+ enum bt_property_availability avail =
+ BT_PROPERTY_AVAILABILITY_AVAILABLE;
- plugin->shared_lib_handle->exit =
- (SECTION_BEGIN(__bt_plugin_exit_funcs))[i];
- if (!plugin->shared_lib_handle->exit) {
- goto error;
- }
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
- plugin->shared_lib_handle->name = (SECTION_BEGIN(__bt_plugin_names))[i];
- plugin->shared_lib_handle->author =
- (SECTION_BEGIN(__bt_plugin_authors))[i];
- plugin->shared_lib_handle->license =
- (SECTION_BEGIN(__bt_plugin_licenses))[i];
- plugin->shared_lib_handle->description =
- (SECTION_BEGIN(__bt_plugin_descriptions))[i];
-
- /* Create empty array of component classes */
- plugin->comp_classes =
- g_ptr_array_new_with_free_func((GDestroyNotify) bt_put);
- if (!plugin->comp_classes) {
- goto error;
+ if (!plugin->info.version_set) {
+ BT_LIB_LOGV("Plugin's version is not set: %!+l", plugin);
+ avail = BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
+ goto end;
}
- /* Initialize plugin */
- if (init_plugin(plugin) < 0) {
- goto error;
+ if (major) {
+ *major = plugin->info.version.major;
}
- goto end;
-
-error:
- BT_PUT(plugin);
-
-end:
- return plugin;
-}
-
-struct bt_plugin **bt_plugin_create_all_from_static(void)
-{
- size_t count, i;
- struct bt_plugin **plugins = NULL;
-
- PRINT_PLUG_IN_SECTIONS(printf_verbose);
- count = SECTION_ELEMENT_COUNT(__bt_plugin_init_funcs);
- if (SECTION_ELEMENT_COUNT(__bt_plugin_exit_funcs) != count ||
- SECTION_ELEMENT_COUNT(__bt_plugin_names) != count ||
- SECTION_ELEMENT_COUNT(__bt_plugin_authors) != count ||
- SECTION_ELEMENT_COUNT(__bt_plugin_licenses) != count ||
- SECTION_ELEMENT_COUNT(__bt_plugin_descriptions) != count) {
- printf_error("Some statically-linked plug-ins do not define all the mandatory symbols\n");
- goto error;
+ if (minor) {
+ *minor = plugin->info.version.minor;
}
- printf_verbose("Detected %zu statically-linked plug-ins\n", count);
- plugins = g_new0(struct bt_plugin *, count + 1);
- if (!plugins) {
- goto error;
+ if (patch) {
+ *patch = plugin->info.version.patch;
}
- for (i = 0; i < count; i++) {
- struct bt_plugin *plugin =
- bt_plugin_create_from_static_at_index(i);
-
- if (!plugin) {
- printf_error("Cannot create statically-linked plug-in at index %zu\n",
- i);
- goto error;
- }
-
- /* Transfer ownership to the array */
- plugins[i] = plugin;
+ if (extra) {
+ *extra = plugin->info.version.extra->str;
}
- goto end;
-
-error:
- g_free(plugins);
-
end:
- return plugins;
+ return avail;
}
-const char *bt_plugin_get_name(struct bt_plugin *plugin)
+uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin)
{
- return plugin ? plugin->shared_lib_handle->name : NULL;
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return (uint64_t) plugin->src_comp_classes->len;
}
-const char *bt_plugin_get_author(struct bt_plugin *plugin)
+uint64_t bt_plugin_get_filter_component_class_count(const struct bt_plugin *plugin)
{
- return plugin ? plugin->shared_lib_handle->author : NULL;
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return (uint64_t) plugin->flt_comp_classes->len;
}
-const char *bt_plugin_get_license(struct bt_plugin *plugin)
+uint64_t bt_plugin_get_sink_component_class_count(const struct bt_plugin *plugin)
{
- return plugin ? plugin->shared_lib_handle->license : NULL;
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ return (uint64_t) plugin->sink_comp_classes->len;
}
-const char *bt_plugin_get_path(struct bt_plugin *plugin)
+static inline
+struct bt_component_class *borrow_component_class_by_index(
+ const struct bt_plugin *plugin, GPtrArray *comp_classes,
+ uint64_t index)
{
- return (plugin && plugin->shared_lib_handle->path) ?
- plugin->shared_lib_handle->path->str : NULL;
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ BT_ASSERT_PRE_VALID_INDEX(index, comp_classes->len);
+ return g_ptr_array_index(comp_classes, index);
}
-const char *bt_plugin_get_description(struct bt_plugin *plugin)
+const struct bt_component_class_source *
+bt_plugin_borrow_source_component_class_by_index_const(
+ const struct bt_plugin *plugin, uint64_t index)
{
- return plugin ? plugin->shared_lib_handle->description : NULL;
+ return (const void *) borrow_component_class_by_index(plugin,
+ plugin->src_comp_classes, index);
}
-int bt_plugin_get_component_class_count(struct bt_plugin *plugin)
+const struct bt_component_class_filter *
+bt_plugin_borrow_filter_component_class_by_index_const(
+ const struct bt_plugin *plugin, uint64_t index)
{
- return plugin ? plugin->comp_classes->len : -1;
+ return (const void *) borrow_component_class_by_index(plugin,
+ plugin->flt_comp_classes, index);
}
-struct bt_component_class *bt_plugin_get_component_class(
- struct bt_plugin *plugin, size_t index)
+const struct bt_component_class_sink *
+bt_plugin_borrow_sink_component_class_by_index_const(
+ const struct bt_plugin *plugin, uint64_t index)
{
- struct bt_component_class *comp_class = NULL;
-
- if (!plugin || index >= plugin->comp_classes->len) {
- goto error;
- }
-
- comp_class = g_ptr_array_index(plugin->comp_classes, index);
- bt_get(comp_class);
- goto end;
-
-error:
- BT_PUT(comp_class);
-
-end:
- return comp_class;
+ return (const void *) borrow_component_class_by_index(plugin,
+ plugin->sink_comp_classes, index);
}
-struct bt_component_class *bt_plugin_get_component_class_by_name_and_type(
- struct bt_plugin *plugin, const char *name,
- enum bt_component_type type)
+static inline
+struct bt_component_class *borrow_component_class_by_name(
+ const struct bt_plugin *plugin, GPtrArray *comp_classes,
+ const char *name)
{
struct bt_component_class *comp_class = NULL;
size_t i;
- if (!plugin || !name) {
- goto error;
- }
+ BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
+ BT_ASSERT_PRE_NON_NULL(name, "Name");
- for (i = 0; i < plugin->comp_classes->len; i++) {
+ for (i = 0; i < comp_classes->len; i++) {
struct bt_component_class *comp_class_candidate =
- g_ptr_array_index(plugin->comp_classes, i);
+ g_ptr_array_index(comp_classes, i);
const char *comp_class_cand_name =
bt_component_class_get_name(comp_class_candidate);
- enum bt_component_type comp_class_cand_type =
- bt_component_class_get_type(comp_class_candidate);
- assert(comp_class_cand_name);
- assert(comp_class_cand_type >= 0);
+ BT_ASSERT(comp_class_cand_name);
- if (strcmp(name, comp_class_cand_name) == 0 &&
- comp_class_cand_type == type) {
- comp_class = bt_get(comp_class_candidate);
+ if (strcmp(name, comp_class_cand_name) == 0) {
+ comp_class = comp_class_candidate;
break;
}
}
- goto end;
-
-error:
- BT_PUT(comp_class);
-
-end:
return comp_class;
}
-static
-void plugin_comp_class_destroy_listener(struct bt_component_class *comp_class,
- void *data)
+const struct bt_component_class_source *
+bt_plugin_borrow_source_component_class_by_name_const(
+ const struct bt_plugin *plugin, const char *name)
{
- gboolean exists = g_hash_table_remove(comp_classes_to_shlib_handles,
- comp_class);
- assert(exists);
+ return (const void *) borrow_component_class_by_name(plugin,
+ plugin->src_comp_classes, name);
}
-enum bt_plugin_status bt_plugin_add_component_class(
- struct bt_plugin *plugin, struct bt_component_class *comp_class)
+const struct bt_component_class_filter *
+bt_plugin_borrow_filter_component_class_by_name_const(
+ const struct bt_plugin *plugin, const char *name)
{
- enum bt_plugin_status status = BT_PLUGIN_STATUS_OK;
- struct bt_component_class *comp_class_dup = NULL;
- int ret;
- int comp_class_index = -1;
-
- if (!plugin || !comp_class || plugin->frozen) {
- goto error;
- }
-
- /* Check for duplicate */
- comp_class_dup = bt_plugin_get_component_class_by_name_and_type(plugin,
- bt_component_class_get_name(comp_class),
- bt_component_class_get_type(comp_class));
- if (comp_class_dup) {
- printf_verbose("Plugin `%s`: adding component class with existing name `%s` and type %d\n",
- plugin->shared_lib_handle->name,
- bt_component_class_get_name(comp_class),
- bt_component_class_get_type(comp_class));
- goto error;
- }
-
- /* Add new component class */
- comp_class_index = plugin->comp_classes->len;
- g_ptr_array_add(plugin->comp_classes, bt_get(comp_class));
-
- /* Map component class pointer to shared lib handle in global HT */
- g_hash_table_insert(comp_classes_to_shlib_handles, comp_class,
- bt_get(plugin->shared_lib_handle));
+ return (const void *) borrow_component_class_by_name(plugin,
+ plugin->flt_comp_classes, name);
+}
- /* Add our custom destroy listener */
- ret = bt_component_class_add_destroy_listener(comp_class,
- plugin_comp_class_destroy_listener, NULL);
- if (ret) {
- goto error;
- }
+const struct bt_component_class_sink *
+bt_plugin_borrow_sink_component_class_by_name_const(
+ const struct bt_plugin *plugin, const char *name)
+{
+ return (const void *) borrow_component_class_by_name(plugin,
+ plugin->sink_comp_classes, name);
+}
- goto end;
+void bt_plugin_get_ref(const struct bt_plugin *plugin)
+{
+ bt_object_get_ref(plugin);
+}
-error:
- /* Remove entry from global hash table (if exists) */
- g_hash_table_remove(comp_classes_to_shlib_handles,
- comp_class);
-
- /* Remove entry from plugin's component classes (if added) */
- if (comp_class_index >= 0) {
- g_ptr_array_remove_index(plugin->comp_classes,
- comp_class_index);
- }
+void bt_plugin_put_ref(const struct bt_plugin *plugin)
+{
+ bt_object_put_ref(plugin);
+}
- status = BT_PLUGIN_STATUS_ERROR;
+void bt_plugin_set_get_ref(const struct bt_plugin_set *plugin_set)
+{
+ bt_object_get_ref(plugin_set);
+}
-end:
- bt_put(comp_class_dup);
- return status;
+void bt_plugin_set_put_ref(const struct bt_plugin_set *plugin_set)
+{
+ bt_object_put_ref(plugin_set);
}
projects / babeltrace.git / blobdiff