X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fplugin%2Fplugin.c;h=aec5ed6837cb94378b173ad7c5a02245189b55d6;hb=98b15851a941e7342b8bb19e265cdc3a40fabfb8;hp=74b3eb51d3b1fd1a9d68de5f5d834fc8ed03f5f8;hpb=870631a2db01676b476dbee615aade0a22926bcd;p=babeltrace.git diff --git a/src/lib/plugin/plugin.c b/src/lib/plugin/plugin.c index 74b3eb51..aec5ed68 100644 --- a/src/lib/plugin/plugin.c +++ b/src/lib/plugin/plugin.c @@ -49,7 +49,8 @@ #include "plugin-so.h" #include "lib/func-status.h" -#define PYTHON_PLUGIN_PROVIDER_FILENAME "libbabeltrace2-python-plugin-provider." G_MODULE_SUFFIX +#define PYTHON_PLUGIN_PROVIDER_FILENAME "babeltrace2-python-plugin-provider." G_MODULE_SUFFIX +#define PYTHON_PLUGIN_PROVIDER_DIR BABELTRACE_PLUGIN_PROVIDERS_DIR #define PYTHON_PLUGIN_PROVIDER_SYM_NAME bt_plugin_python_create_all_from_file #define PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR G_STRINGIFY(PYTHON_PLUGIN_PROVIDER_SYM_NAME) @@ -79,14 +80,32 @@ int (*bt_plugin_python_create_all_from_file_sym)( static int init_python_plugin_provider(void) { int status = BT_FUNC_STATUS_OK; + const char *provider_dir_envvar; + static const char * const provider_dir_envvar_name = "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR"; + char *provider_path = NULL; - if (bt_plugin_python_create_all_from_file_sym != NULL) { + if (bt_plugin_python_create_all_from_file_sym) { goto end; } BT_LOGI_STR("Loading Python plugin provider module."); - python_plugin_provider_module = - g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME, 0); + + provider_dir_envvar = getenv(provider_dir_envvar_name); + if (provider_dir_envvar) { + provider_path = g_build_filename(provider_dir_envvar, + PYTHON_PLUGIN_PROVIDER_FILENAME, NULL); + BT_LOGI("Using `%s` environment variable to find the Python " + "plugin provider: path=\"%s\"", provider_dir_envvar_name, + provider_path); + } else { + provider_path = g_build_filename(PYTHON_PLUGIN_PROVIDER_DIR, + PYTHON_PLUGIN_PROVIDER_FILENAME, NULL); + BT_LOGI("Using default path (`%s` environment variable is not " + "set) to find the Python plugin provider: path=\"%s\"", + provider_dir_envvar_name, provider_path); + } + + python_plugin_provider_module = g_module_open(provider_path, 0); if (!python_plugin_provider_module) { /* * This is not an error. The whole point of having an @@ -94,7 +113,7 @@ int init_python_plugin_provider(void) { * missing and the Babeltrace library still works. */ BT_LOGI("Cannot open `%s`: %s: continuing without Python plugin support.", - PYTHON_PLUGIN_PROVIDER_FILENAME, g_module_error()); + provider_path, g_module_error()); goto end; } @@ -111,7 +130,7 @@ int init_python_plugin_provider(void) { "%s: continuing without Python plugin support: " "file=\"%s\", symbol=\"%s\"", g_module_error(), - PYTHON_PLUGIN_PROVIDER_FILENAME, + provider_path, PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR); status = BT_FUNC_STATUS_ERROR; goto end; @@ -121,6 +140,8 @@ int init_python_plugin_provider(void) { python_plugin_provider_module); end: + g_free(provider_path); + return status; } @@ -143,17 +164,17 @@ void fini_python_plugin_provider(void) { } #endif -uint64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set) +uint64_t bt_plugin_set_get_plugin_count(const struct bt_plugin_set *plugin_set) { - BT_ASSERT_PRE_NON_NULL(plugin_set, "Plugin set"); + BT_ASSERT_PRE_DEV_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); + BT_ASSERT_PRE_DEV_NON_NULL(plugin_set, "Plugin set"); + BT_ASSERT_PRE_DEV_VALID_INDEX(index, plugin_set->plugins->len); return g_ptr_array_index(plugin_set->plugins, index); } @@ -237,28 +258,30 @@ end: return status; } -static void destroy_gstring(void *data) +static +void destroy_gstring(void *data) { g_string_free(data, TRUE); } -enum bt_plugin_find_status bt_plugin_find(const char *plugin_name, - bt_bool fail_on_load_error, const struct bt_plugin **plugin_out) +enum bt_plugin_find_all_status bt_plugin_find_all(bt_bool find_in_std_env_var, + bt_bool find_in_user_dir, bt_bool find_in_sys_dir, + bt_bool find_in_static, bt_bool fail_on_load_error, + const struct bt_plugin_set **plugin_set_out) { - 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; int status = BT_FUNC_STATUS_OK; - size_t i, j; + uint64_t dir_i, plugin_i; - BT_ASSERT_PRE_NON_NULL(plugin_name, "Name"); - BT_ASSERT_PRE_NON_NULL(plugin_out, "Plugin (output)"); - BT_LOGI("Finding named plugin in standard directories and built-in plugins: " - "name=\"%s\"", plugin_name); + BT_ASSERT_PRE_NON_NULL(plugin_set_out, "Plugin set (output)"); + 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", + find_in_std_env_var, find_in_user_dir, find_in_sys_dir, + find_in_static); dirs = g_ptr_array_new_with_free_func((GDestroyNotify) destroy_gstring); if (!dirs) { BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); @@ -266,60 +289,77 @@ enum bt_plugin_find_status bt_plugin_find(const char *plugin_name, goto end; } + *plugin_set_out = bt_plugin_set_create(); + if (!*plugin_set_out) { + BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + /* * Search order is: * - * 1. BABELTRACE_PLUGIN_PATH environment variable + * 1. `BABELTRACE_PLUGIN_PATH` environment variable * (colon-separated list of directories) - * 2. ~/.local/lib/babeltrace2/plugins + * 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 + * `/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_LIB_LOGE_APPEND_CAUSE( - "Failed to append plugin path to array of directories."); - status = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; + if (find_in_std_env_var) { + const char *envvar = getenv("BABELTRACE_PLUGIN_PATH"); + + if (envvar) { + ret = bt_common_append_plugin_path_dirs(envvar, dirs); + if (ret) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to append plugin path to array of directories."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } } } - home_plugin_dir = bt_common_get_home_plugin_path(BT_LOG_OUTPUT_LEVEL); - if (home_plugin_dir) { - GString *home_plugin_dir_str = g_string_new(home_plugin_dir); + if (find_in_user_dir) { + home_plugin_dir = bt_common_get_home_plugin_path( + BT_LOG_OUTPUT_LEVEL); + if (home_plugin_dir) { + GString *home_plugin_dir_str = g_string_new( + home_plugin_dir); - if (!home_plugin_dir_str) { - BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); - status = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; - } + if (!home_plugin_dir_str) { + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } - g_ptr_array_add(dirs, home_plugin_dir_str); + 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 (find_in_sys_dir) { + const char *system_plugin_dir = + bt_common_get_system_plugin_path(); - if (!system_plugin_dir_str) { - BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); - status = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; - } + if (system_plugin_dir) { + GString *system_plugin_dir_str = + g_string_new(system_plugin_dir); - g_ptr_array_add(dirs, system_plugin_dir_str); + if (!system_plugin_dir_str) { + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + 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); + for (dir_i = 0; dir_i < dirs->len; dir_i++) { + GString *dir = dirs->pdata[dir_i]; BT_OBJECT_PUT_REF_AND_RESET(plugin_set); @@ -348,50 +388,100 @@ enum bt_plugin_find_status bt_plugin_find(const char *plugin_name, BT_ASSERT(status == BT_FUNC_STATUS_OK); BT_ASSERT(plugin_set); + BT_LOGI("Found plugins in directory: path=\"%s\", count=%u", + dir->str, plugin_set->plugins->len); - for (j = 0; j < plugin_set->plugins->len; j++) { - const struct bt_plugin *candidate_plugin = - g_ptr_array_index(plugin_set->plugins, j); + for (plugin_i = 0; plugin_i < plugin_set->plugins->len; + plugin_i++) { + bt_plugin_set_add_plugin((void *) *plugin_set_out, + plugin_set->plugins->pdata[plugin_i]); + } + } - if (strcmp(bt_plugin_get_name(candidate_plugin), - plugin_name) == 0) { - BT_LOGI("Plugin found in directory: name=\"%s\", path=\"%s\"", - plugin_name, dir->str); - *plugin_out = candidate_plugin; - bt_object_get_no_null_check(*plugin_out); - goto end; - } + if (find_in_static) { + BT_OBJECT_PUT_REF_AND_RESET(plugin_set); + status = bt_plugin_find_all_from_static(fail_on_load_error, + &plugin_set); + if (status < 0) { + BT_ASSERT(!plugin_set); + goto end; + } else if (status == BT_FUNC_STATUS_NOT_FOUND) { + BT_ASSERT(!plugin_set); + BT_LOGI_STR("No plugins found in built-in plugins."); + goto end; } - BT_LOGI("Plugin not found in directory: name=\"%s\", path=\"%s\"", - plugin_name, dir->str); + BT_ASSERT(status == BT_FUNC_STATUS_OK); + BT_ASSERT(plugin_set); + BT_LOGI("Found built-in plugins: count=%u", + plugin_set->plugins->len); + + for (plugin_i = 0; plugin_i < plugin_set->plugins->len; + plugin_i++) { + bt_plugin_set_add_plugin((void *) *plugin_set_out, + plugin_set->plugins->pdata[plugin_i]); + } + } + +end: + free(home_plugin_dir); + bt_object_put_ref(plugin_set); + + if (dirs) { + g_ptr_array_free(dirs, TRUE); } - BT_OBJECT_PUT_REF_AND_RESET(plugin_set); - status = bt_plugin_find_all_from_static(fail_on_load_error, - &plugin_set); if (status < 0) { + BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out); + } else { + BT_ASSERT(*plugin_set_out); + + if ((*plugin_set_out)->plugins->len > 0) { + BT_LOGI("Found plugins in standard directories and built-in plugins: " + "count=%u", (*plugin_set_out)->plugins->len); + status = BT_FUNC_STATUS_OK; + } else { + BT_LOGI_STR("No plugins found in standard directories and built-in plugins."); + status = BT_FUNC_STATUS_NOT_FOUND; + BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out); + } + } + + return status; +} + +enum bt_plugin_find_status bt_plugin_find(const char *plugin_name, + bt_bool find_in_std_env_var, bt_bool find_in_user_dir, + bt_bool find_in_sys_dir, bt_bool find_in_static, + bt_bool fail_on_load_error, const struct bt_plugin **plugin_out) +{ + enum bt_plugin_find_status status; + 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_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", + plugin_name, find_in_std_env_var, find_in_user_dir, + find_in_sys_dir, find_in_static); + status = (enum bt_plugin_find_status) bt_plugin_find_all(find_in_std_env_var, find_in_user_dir, + find_in_sys_dir, find_in_static, fail_on_load_error, + &plugin_set); + if (status != BT_FUNC_STATUS_OK) { BT_ASSERT(!plugin_set); goto end; - } else if (status == BT_FUNC_STATUS_NOT_FOUND) { - BT_ASSERT(!plugin_set); - BT_LOGI_STR("No plugins found in built-in plugins."); - goto end; } - BT_ASSERT(status == BT_FUNC_STATUS_OK); BT_ASSERT(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); + for (i = 0; i < plugin_set->plugins->len; i++) { + const struct bt_plugin *plugin = plugin_set->plugins->pdata[i]; - if (strcmp(bt_plugin_get_name(candidate_plugin), - plugin_name) == 0) { - BT_LOGI("Plugin found in built-in plugins: " - "name=\"%s\"", plugin_name); - *plugin_out = candidate_plugin; - bt_object_get_no_null_check(*plugin_out); + if (strcmp(plugin->info.name->str, plugin_name) == 0) { + *plugin_out = plugin; + bt_object_get_ref_no_null_check(*plugin_out); goto end; } } @@ -399,21 +489,17 @@ enum bt_plugin_find_status bt_plugin_find(const char *plugin_name, status = BT_FUNC_STATUS_NOT_FOUND; end: - free(home_plugin_dir); - bt_object_put_ref(plugin_set); - - if (dirs) { - g_ptr_array_free(dirs, TRUE); - } - if (status == BT_FUNC_STATUS_OK) { + BT_ASSERT(*plugin_out); BT_LIB_LOGI("Found plugin in standard directories and built-in plugins: " - "%!+l", plugin); - } else if (status == BT_FUNC_STATUS_NOT_FOUND) { + "%!+l", *plugin_out); + } else if (status == BT_FUNC_STATUS_NOT_FOUND) { BT_LOGI("No plugin found in standard directories and built-in plugins: " "name=\"%s\"", plugin_name); } + bt_plugin_set_put_ref(plugin_set); + return status; } @@ -626,31 +712,31 @@ end: const char *bt_plugin_get_name(const struct bt_plugin *plugin) { - BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + BT_ASSERT_PRE_DEV_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"); + BT_ASSERT_PRE_DEV_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"); + BT_ASSERT_PRE_DEV_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"); + BT_ASSERT_PRE_DEV_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"); + BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); return plugin->info.description_set ? plugin->info.description->str : NULL; } @@ -662,7 +748,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_NON_NULL(plugin, "Plugin"); + BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); if (!plugin->info.version_set) { BT_LIB_LOGD("Plugin's version is not set: %!+l", plugin); @@ -692,19 +778,19 @@ end: uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin) { - BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + BT_ASSERT_PRE_DEV_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"); + BT_ASSERT_PRE_DEV_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"); + BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); return (uint64_t) plugin->sink_comp_classes->len; } @@ -713,8 +799,8 @@ 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); + BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); + BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp_classes->len); return g_ptr_array_index(comp_classes, index); } @@ -750,8 +836,8 @@ struct bt_component_class *borrow_component_class_by_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"); + BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); + BT_ASSERT_PRE_DEV_NON_NULL(name, "Name"); for (i = 0; i < comp_classes->len; i++) { struct bt_component_class *comp_class_candidate = @@ -759,7 +845,7 @@ struct bt_component_class *borrow_component_class_by_name( const char *comp_class_cand_name = bt_component_class_get_name(comp_class_candidate); - BT_ASSERT(comp_class_cand_name); + BT_ASSERT_DBG(comp_class_cand_name); if (strcmp(name, comp_class_cand_name) == 0) { comp_class = comp_class_candidate;