+++ /dev/null
-/*
- * 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 "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 <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <inttypes.h>
-#include <sys/stat.h>
-#include <ftw.h>
-#include <pthread.h>
-
-#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)
-
-#define APPEND_ALL_FROM_DIR_NFDOPEN_MAX 8
-
-#ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
-#include <babeltrace2/plugin/python-plugin-provider-internal.h>
-
-static
-struct bt_plugin_set *(*bt_plugin_python_create_all_from_file_sym)(const char *path) =
- bt_plugin_python_create_all_from_file;
-
-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);
-
-static
-void init_python_plugin_provider(void) {
- if (bt_plugin_python_create_all_from_file_sym != NULL) {
- return;
- }
-
- 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 (!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;
- }
-
- BT_LOGI("Loaded Python plugin provider module: addr=%p",
- python_plugin_provider_module);
-}
-
-__attribute__((destructor)) static
-void fini_python_plugin_provider(void) {
- if (python_plugin_provider_module) {
- BT_LOGD("Unloading Python plugin provider module.");
-
- if (!g_module_close(python_plugin_provider_module)) {
- BT_LOGE("Failed to close the Python plugin provider module: %s.",
- g_module_error());
- }
-
- python_plugin_provider_module = NULL;
- }
-}
-#endif
-
-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;
-}
-
-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);
-}
-
-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();
-}
-
-const struct bt_plugin_set *bt_plugin_find_all_from_file(const char *path)
-{
- struct bt_plugin_set *plugin_set = NULL;
-
- BT_ASSERT_PRE_NON_NULL(path, "Path");
- BT_LOGD("Creating plugins from file: path=\"%s\"", path);
-
- /* Try shared object plugins */
- plugin_set = bt_plugin_so_create_all_from_file(path);
- if (plugin_set) {
- goto end;
- }
-
- /* 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;
- }
- }
-
-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 {
- BT_LOGD("Found no plugins in file: path=\"%s\"", path);
- }
-
- return plugin_set;
-}
-
-static void destroy_gstring(void *data)
-{
- g_string_free(data, TRUE);
-}
-
-const struct bt_plugin *bt_plugin_find(const char *plugin_name)
-{
- 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;
- }
-
- /*
- * 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.
- */
- 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;
- }
- }
-
- home_plugin_dir = bt_common_get_home_plugin_path();
- if (home_plugin_dir) {
- GString *home_plugin_dir_str =
- g_string_new(home_plugin_dir);
-
- if (!home_plugin_dir_str) {
- BT_LOGE_STR("Failed to allocate a GString.");
- goto end;
- }
-
- g_ptr_array_add(dirs, home_plugin_dir_str);
- }
-
- system_plugin_dir = bt_common_get_system_plugin_path();
- if (system_plugin_dir) {
- GString *system_plugin_dir_str =
- g_string_new(system_plugin_dir);
-
- if (!system_plugin_dir_str) {
- BT_LOGE_STR("Failed to allocate a GString.");
- goto end;
- }
-
- g_ptr_array_add(dirs, system_plugin_dir_str);
- }
-
- for (i = 0; i < dirs->len; i++) {
- GString *dir = g_ptr_array_index(dirs, i);
-
- BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
-
- /*
- * 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;
- }
-
- /* 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;
- }
-
- for (j = 0; j < plugin_set->plugins->len; j++) {
- const struct bt_plugin *candidate_plugin =
- g_ptr_array_index(plugin_set->plugins, j);
-
- 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;
- }
- }
-
- BT_LOGD("Plugin not found in directory: name=\"%s\", path=\"%s\"",
- plugin_name, dir->str);
- }
-
- 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);
-
- 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;
- }
- }
- }
-
-end:
- free(home_plugin_dir);
- bt_object_put_ref(plugin_set);
-
- if (dirs) {
- g_ptr_array_free(dirs, TRUE);
- }
-
- 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);
- }
-
- return plugin;
-}
-
-static struct {
- pthread_mutex_t lock;
- struct bt_plugin_set *plugin_set;
- bool recurse;
-} append_all_from_dir_info = {
- .lock = PTHREAD_MUTEX_INITIALIZER
-};
-
-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;
- }
-
- switch (flag) {
- case FTW_F:
- {
- const struct bt_plugin_set *plugins_from_file;
-
- if (name[0] == '.') {
- /* Skip hidden files */
- BT_LOGV("Skipping hidden file: path=\"%s\"", file);
- goto end;
- }
-
- plugins_from_file = bt_plugin_find_all_from_file(file);
-
- if (plugins_from_file) {
- size_t j;
-
- for (j = 0; j < plugins_from_file->plugins->len; j++) {
- struct bt_plugin *plugin =
- g_ptr_array_index(plugins_from_file->plugins, j);
-
- 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);
- }
-
- bt_object_put_ref(plugins_from_file);
- }
- break;
- }
- 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;
- }
-
-end:
- return ret;
-}
-
-static
-enum bt_plugin_status bt_plugin_create_append_all_from_dir(
- struct bt_plugin_set *plugin_set, const char *path,
- bt_bool recurse)
-{
- int nftw_flags = FTW_PHYS;
- enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
-
- 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;
- }
-
- 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(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;
- }
-
- BT_LOGD("Created %u plugins from directory: count=%u, path=\"%s\"",
- plugin_set->plugins->len, plugin_set->plugins->len, path);
- goto end;
-
-error:
- BT_OBJECT_PUT_REF_AND_RESET(plugin_set);
-
-end:
- return plugin_set;
-}
-
-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;
-}
-
-const char *bt_plugin_get_author(const struct bt_plugin *plugin)
-{
- BT_ASSERT_PRE_NON_NULL(plugin, "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_NON_NULL(plugin, "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_NON_NULL(plugin, "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_NON_NULL(plugin, "Plugin");
- return plugin->info.description_set ?
- plugin->info.description->str : NULL;
-}
-
-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;
-
- BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
-
- if (!plugin->info.version_set) {
- BT_LIB_LOGV("Plugin's version is not set: %!+l", plugin);
- avail = BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
- goto end;
- }
-
- if (major) {
- *major = plugin->info.version.major;
- }
-
- if (minor) {
- *minor = plugin->info.version.minor;
- }
-
- if (patch) {
- *patch = plugin->info.version.patch;
- }
-
- if (extra) {
- *extra = plugin->info.version.extra->str;
- }
-
-end:
- return avail;
-}
-
-uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin)
-{
- BT_ASSERT_PRE_NON_NULL(plugin, "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_NON_NULL(plugin, "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_NON_NULL(plugin, "Plugin");
- return (uint64_t) plugin->sink_comp_classes->len;
-}
-
-static inline
-struct bt_component_class *borrow_component_class_by_index(
- const struct bt_plugin *plugin, GPtrArray *comp_classes,
- uint64_t index)
-{
- 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 struct bt_component_class_source *
-bt_plugin_borrow_source_component_class_by_index_const(
- const struct bt_plugin *plugin, uint64_t index)
-{
- return (const void *) borrow_component_class_by_index(plugin,
- plugin->src_comp_classes, index);
-}
-
-const struct bt_component_class_filter *
-bt_plugin_borrow_filter_component_class_by_index_const(
- const struct bt_plugin *plugin, uint64_t index)
-{
- return (const void *) borrow_component_class_by_index(plugin,
- plugin->flt_comp_classes, index);
-}
-
-const struct bt_component_class_sink *
-bt_plugin_borrow_sink_component_class_by_index_const(
- const struct bt_plugin *plugin, uint64_t index)
-{
- return (const void *) borrow_component_class_by_index(plugin,
- plugin->sink_comp_classes, index);
-}
-
-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;
-
- BT_ASSERT_PRE_NON_NULL(plugin, "Plugin");
- BT_ASSERT_PRE_NON_NULL(name, "Name");
-
- for (i = 0; i < comp_classes->len; i++) {
- struct bt_component_class *comp_class_candidate =
- g_ptr_array_index(comp_classes, i);
- const char *comp_class_cand_name =
- bt_component_class_get_name(comp_class_candidate);
-
- BT_ASSERT(comp_class_cand_name);
-
- if (strcmp(name, comp_class_cand_name) == 0) {
- comp_class = comp_class_candidate;
- break;
- }
- }
-
- return comp_class;
-}
-
-const struct bt_component_class_source *
-bt_plugin_borrow_source_component_class_by_name_const(
- const struct bt_plugin *plugin, const char *name)
-{
- return (const void *) borrow_component_class_by_name(plugin,
- plugin->src_comp_classes, name);
-}
-
-const struct bt_component_class_filter *
-bt_plugin_borrow_filter_component_class_by_name_const(
- const struct bt_plugin *plugin, const char *name)
-{
- return (const void *) borrow_component_class_by_name(plugin,
- plugin->flt_comp_classes, name);
-}
-
-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);
-}
-
-void bt_plugin_get_ref(const struct bt_plugin *plugin)
-{
- bt_object_get_ref(plugin);
-}
-
-void bt_plugin_put_ref(const struct bt_plugin *plugin)
-{
- bt_object_put_ref(plugin);
-}
-
-void bt_plugin_set_get_ref(const struct bt_plugin_set *plugin_set)
-{
- bt_object_get_ref(plugin_set);
-}
-
-void bt_plugin_set_put_ref(const struct bt_plugin_set *plugin_set)
-{
- bt_object_put_ref(plugin_set);
-}
projects / babeltrace.git / blobdiff