X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fplugin%2Fplugin.c;h=9f0bc2ac22efdba4f4299e89690de6575b6224a1;hb=a12f3d624772f543137e60252101871cd6017a06;hp=0651ae72f328c477c7a83cefa37f2ec741dfa784;hpb=2b43acf9fd5d2062f3f4154f0c7cf95819e976ea;p=babeltrace.git diff --git a/lib/plugin/plugin.c b/lib/plugin/plugin.c index 0651ae72..9f0bc2ac 100644 --- a/lib/plugin/plugin.c +++ b/lib/plugin/plugin.c @@ -1,10 +1,6 @@ /* - * plugin.c - * - * Babeltrace Plugin (generic) - * + * Copyright 2017-2018 Philippe Proulx * Copyright 2016 Jérémie Galarneau - * Copyright 2017 Philippe Proulx * * Author: Jérémie Galarneau * @@ -27,90 +23,146 @@ * SOFTWARE. */ +#define BT_LOG_TAG "PLUGIN" +#include + +#include +#include #include #include -#include #include #include #include +#include +#include +#include +#include #include #include #include +#include +#include #include -#include +#include +#include -#define PYTHON_PLUGIN_PROVIDER_FILENAME "libbabeltrace-python-plugin-provider." G_MODULE_SUFFIX +#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 + static -struct bt_plugin **(*bt_plugin_python_create_all_from_file_sym)(const char *path) = +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 **(*bt_plugin_python_create_all_from_file_sym)(const char *path); +struct bt_plugin_set *(*bt_plugin_python_create_all_from_file_sym)(const char *path); -__attribute__((constructor)) static +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, - G_MODULE_BIND_LOCAL); + g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME, 0); if (!python_plugin_provider_module) { - printf_warning("Cannot find `%s`: Python plugin support is disabled\n", - PYTHON_PLUGIN_PROVIDER_FILENAME); + 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)) { - printf_warning("Cannot find the Python plugin provider loading symbole: Python plugin support is disabled\n"); + 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) { - (void) g_module_close(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 -struct bt_plugin **bt_plugin_create_all_from_static(void) +uint64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set) { - return bt_plugin_so_create_all_from_static(); + BT_ASSERT_PRE_NON_NULL(plugin_set, "Plugin set"); + return (uint64_t) plugin_set->plugins->len; } -struct bt_plugin **bt_plugin_create_all_from_file(const char *path) +const struct bt_plugin *bt_plugin_set_borrow_plugin_by_index_const( + const struct bt_plugin_set *plugin_set, uint64_t index) { - struct bt_plugin **plugins = NULL; + 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 (!path) { - goto end; - } +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; - printf_verbose("Trying to load plugins from `%s`\n", path); + BT_ASSERT_PRE_NON_NULL(path, "Path"); + BT_LOGD("Creating plugins from file: path=\"%s\"", path); /* Try shared object plugins */ - plugins = bt_plugin_so_create_all_from_file(path); - if (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) { - plugins = bt_plugin_python_create_all_from_file_sym(path); - if (plugins) { + plugin_set = bt_plugin_python_create_all_from_file_sym(path); + if (plugin_set) { goto end; } } end: - return plugins; + 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) @@ -118,37 +170,23 @@ static void destroy_gstring(void *data) g_string_free(data, TRUE); } -void free_plugins(struct bt_plugin **plugins) { - if (plugins) { - struct bt_plugin **cur_plugin = plugins; - - while (*cur_plugin) { - bt_put(*cur_plugin); - cur_plugin++; - } - - free(plugins); - } -} - -struct bt_plugin *bt_plugin_find(const char *plugin_name) +const struct bt_plugin *bt_plugin_find(const char *plugin_name) { const char *system_plugin_dir; char *home_plugin_dir = NULL; const char *envvar; - struct bt_plugin *plugin = NULL; - struct bt_plugin **plugins = NULL; - struct bt_plugin **cur_plugin; + const struct bt_plugin *plugin = NULL; + const struct bt_plugin_set *plugin_set = NULL; GPtrArray *dirs = NULL; int ret; - size_t i; - - if (!plugin_name) { - goto end; - } + 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; } @@ -170,6 +208,7 @@ struct bt_plugin *bt_plugin_find(const char *plugin_name) 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; } } @@ -180,6 +219,7 @@ struct bt_plugin *bt_plugin_find(const char *plugin_name) g_string_new(home_plugin_dir); if (!home_plugin_dir_str) { + BT_LOGE_STR("Failed to allocate a GString."); goto end; } @@ -192,6 +232,7 @@ struct bt_plugin *bt_plugin_find(const char *plugin_name) g_string_new(system_plugin_dir); if (!system_plugin_dir_str) { + BT_LOGE_STR("Failed to allocate a GString."); goto end; } @@ -201,268 +242,250 @@ struct bt_plugin *bt_plugin_find(const char *plugin_name) for (i = 0; i < dirs->len; i++) { GString *dir = g_ptr_array_index(dirs, i); - printf_verbose("Trying to load plugins from directory `%s`\n", - dir->str); - free_plugins(plugins); - plugins = bt_plugin_create_all_from_dir(dir->str, false); - if (!plugins) { + 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; } - cur_plugin = plugins; + /* 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; + } - while (*cur_plugin) { - if (strcmp(bt_plugin_get_name(*cur_plugin), plugin_name) - == 0) { - plugin = bt_get(*cur_plugin); + 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; } - - cur_plugin++; } + + BT_LOGD("Plugin not found in directory: name=\"%s\", path=\"%s\"", + plugin_name, dir->str); } - free_plugins(plugins); - plugins = bt_plugin_create_all_from_static(); - cur_plugin = plugins; + 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); - while (*cur_plugin) { - if (strcmp(bt_plugin_get_name(*cur_plugin), plugin_name) == 0) { - plugin = bt_get(*cur_plugin); - goto end; + 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; + } } - - cur_plugin++; } end: free(home_plugin_dir); - free_plugins(plugins); + bt_object_put_ref(plugin_set); if (dirs) { g_ptr_array_free(dirs, TRUE); } - return plugin; -} - -struct bt_component_class *bt_plugin_find_component_class( - const char *plugin_name, const char *comp_cls_name, - enum bt_component_class_type comp_cls_type) -{ - struct bt_plugin *plugin = NULL; - struct bt_component_class *comp_cls = NULL; - - if (!plugin_name || !comp_cls_name) { - 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); } - plugin = bt_plugin_find(plugin_name); - if (!plugin) { - goto end; - } - - comp_cls = bt_plugin_get_component_class_by_name_and_type( - plugin, comp_cls_name, comp_cls_type); - -end: - bt_put(plugin); - return comp_cls; + return plugin; } -/* 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; - - name_max = pathconf(path, _PC_NAME_MAX); - if (name_max == -1) { - name_max = PATH_MAX; - } - len = offsetof(struct dirent, d_name) + name_max + 1; - entry = zmalloc(len); - return entry; -} +static struct { + pthread_mutex_t lock; + struct bt_plugin_set *plugin_set; + bool recurse; +} append_all_from_dir_info = { + .lock = PTHREAD_MUTEX_INITIALIZER +}; static -enum bt_plugin_status bt_plugin_create_append_all_from_dir( - GPtrArray *plugins, const char *path, bool recurse) +int nftw_append_all_from_dir(const char *file, const struct stat *sb, int flag, + struct FTW *s) { - DIR *directory = NULL; - struct dirent *entry = NULL, *result = NULL; - char *file_path = NULL; - size_t path_len; - enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK; - - if (!path) { - ret = BT_PLUGIN_STATUS_ERROR; - goto end; - } - - path_len = strlen(path); - - if (path_len >= PATH_MAX) { - ret = BT_PLUGIN_STATUS_ERROR; - goto end; - } - - entry = alloc_dirent(path); - if (!entry) { - ret = BT_PLUGIN_STATUS_ERROR; - goto end; - } - - file_path = zmalloc(PATH_MAX); - if (!file_path) { - ret = BT_PLUGIN_STATUS_NOMEM; - goto end; - } - - strncpy(file_path, path, path_len); - /* Append a trailing '/' to the path */ - if (file_path[path_len - 1] != '/') { - file_path[path_len++] = '/'; - } + int ret = 0; + const char *name = file + s->base; - directory = opendir(file_path); - if (!directory) { - perror("Failed to open plug-in directory"); - ret = BT_PLUGIN_STATUS_ERROR; + /* 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 **plugins_from_file = - bt_plugin_create_all_from_file(file_path); - - if (plugins_from_file) { - struct bt_plugin **plugin; - - for (plugin = plugins_from_file; *plugin; plugin++) { - /* Transfer ownership to array */ - g_ptr_array_add(plugins, *plugin); - } - free(plugins_from_file); - } + 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: - 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"); - } + 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; } - free(entry); - free(file_path); + return ret; } -struct bt_plugin **bt_plugin_create_all_from_dir(const char *path, - bool recurse) +const struct bt_plugin_set *bt_plugin_find_all_from_dir(const char *path, + bt_bool recurse) { - GPtrArray *plugins_array = g_ptr_array_new(); - struct bt_plugin **plugins = NULL; + 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 plugins; + return plugin_set; } -const char *bt_plugin_get_name(struct bt_plugin *plugin) +const char *bt_plugin_get_name(const struct bt_plugin *plugin) { - return plugin && plugin->info.name_set ? plugin->info.name->str : NULL; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return plugin->info.name_set ? plugin->info.name->str : NULL; } -const char *bt_plugin_get_author(struct bt_plugin *plugin) +const char *bt_plugin_get_author(const struct bt_plugin *plugin) { - return plugin && plugin->info.author_set ? plugin->info.author->str : NULL; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return plugin->info.author_set ? plugin->info.author->str : NULL; } -const char *bt_plugin_get_license(struct bt_plugin *plugin) +const char *bt_plugin_get_license(const struct bt_plugin *plugin) { - return plugin && plugin->info.license_set ? plugin->info.license->str : NULL; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return plugin->info.license_set ? plugin->info.license->str : NULL; } -const char *bt_plugin_get_path(struct bt_plugin *plugin) +const char *bt_plugin_get_path(const struct bt_plugin *plugin) { - return plugin && plugin->info.path_set ? plugin->info.path->str : NULL; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return plugin->info.path_set ? plugin->info.path->str : NULL; } -const char *bt_plugin_get_description(struct bt_plugin *plugin) +const char *bt_plugin_get_description(const struct bt_plugin *plugin) { - return plugin && plugin->info.description_set ? plugin->info.description->str : NULL; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return plugin->info.description_set ? + plugin->info.description->str : NULL; } -enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin, +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_plugin_status status = BT_PLUGIN_STATUS_OK; + enum bt_property_availability avail = + BT_PROPERTY_AVAILABILITY_AVAILABLE; + + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); - if (!plugin || !plugin->info.version_set) { - status = BT_PLUGIN_STATUS_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; } @@ -483,120 +506,129 @@ enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin, } end: - return status; + return avail; } -int bt_plugin_get_component_class_count(struct bt_plugin *plugin) +uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin) { - return plugin ? plugin->comp_classes->len : -1; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return (uint64_t) plugin->src_comp_classes->len; } -struct bt_component_class *bt_plugin_get_component_class( - struct bt_plugin *plugin, size_t index) +uint64_t bt_plugin_get_filter_component_class_count(const struct bt_plugin *plugin) { - struct bt_component_class *comp_class = NULL; + BT_ASSERT_PRE_NON_NULL(plugin, "Plugin"); + return (uint64_t) plugin->flt_comp_classes->len; +} - if (!plugin || index >= plugin->comp_classes->len) { - goto error; - } +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; +} - comp_class = g_ptr_array_index(plugin->comp_classes, index); - bt_get(comp_class); - goto end; +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); +} -error: - BT_PUT(comp_class); +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); +} -end: - return comp_class; +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); } -struct bt_component_class *bt_plugin_get_component_class_by_name_and_type( - struct bt_plugin *plugin, const char *name, - enum bt_component_class_type type) +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; - 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_class_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; } -enum bt_plugin_status bt_plugin_add_component_class( - struct bt_plugin *plugin, struct bt_component_class *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) { - 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", - bt_plugin_get_name(plugin), - bt_component_class_get_name(comp_class), - bt_component_class_get_type(comp_class)); - goto error; - } + return (const void *) borrow_component_class_by_name(plugin, + plugin->src_comp_classes, name); +} - /* Add new component class */ - comp_class_index = plugin->comp_classes->len; - g_ptr_array_add(plugin->comp_classes, bt_get(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) +{ + return (const void *) borrow_component_class_by_name(plugin, + plugin->flt_comp_classes, name); +} - /* Special case for a shared object plugin */ - if (plugin->type == BT_PLUGIN_TYPE_SO) { - ret = bt_plugin_so_on_add_component_class(plugin, comp_class); - 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 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); }