X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fplugin%2Fplugin.c;h=f45121a22477eb9f0d02722093e5fbf024f17df1;hb=cc3083746886be8518d7c1c31541c6047a3ad43f;hp=d85604afbd89a2e15ad15a5b402dbc19bcca72b0;hpb=3230ee6b4f3a704958b761daecae835c56938bc9;p=babeltrace.git diff --git a/lib/plugin/plugin.c b/lib/plugin/plugin.c index d85604af..f45121a2 100644 --- a/lib/plugin/plugin.c +++ b/lib/plugin/plugin.c @@ -27,15 +27,23 @@ * SOFTWARE. */ +#define BT_LOG_TAG "PLUGIN" +#include + #include #include #include #include #include #include +#include +#include +#include #include #include #include +#include +#include #include #include @@ -46,20 +54,21 @@ #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; #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 void init_python_plugin_provider(void) { + BT_LOGD_STR("Loading Python plugin provider module."); python_plugin_provider_module = g_module_open(PYTHON_PLUGIN_PROVIDER_FILENAME, G_MODULE_BIND_LOCAL); if (!python_plugin_provider_module) { - printf_warning("Cannot find `%s`: Python plugin support is disabled\n", + BT_LOGI("Cannot find `%s`: continuing without Python plugin support.", PYTHON_PLUGIN_PROVIDER_FILENAME); return; } @@ -67,50 +76,114 @@ void init_python_plugin_provider(void) { 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_LOGD("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) +extern +int64_t bt_plugin_set_get_plugin_count(struct bt_plugin_set *plugin_set) { + int64_t count = -1; + + if (!plugin_set) { + BT_LOGW_STR("Invalid parameter: plugin set is NULL."); + goto end; + } + + count = (int64_t) plugin_set->plugins->len; + +end: + return count; +} + +extern +struct bt_plugin *bt_plugin_set_get_plugin(struct bt_plugin_set *plugin_set, + uint64_t index) +{ + struct bt_plugin *plugin = NULL; + + if (!plugin_set) { + BT_LOGW_STR("Invalid parameter: plugin set is NULL."); + goto end; + } + + if (index >= plugin_set->plugins->len) { + BT_LOGW("Invalid parameter: index is out of bounds: " + "addr=%p, index=%" PRIu64 ", count=%u", + plugin_set, index, plugin_set->plugins->len); + goto end; + } + + plugin = bt_get(g_ptr_array_index(plugin_set->plugins, index)); + +end: + return plugin; +} + +struct bt_plugin_set *bt_plugin_create_all_from_static(void) +{ + /* bt_plugin_so_create_all_from_static() logs errors */ return bt_plugin_so_create_all_from_static(); } -struct bt_plugin **bt_plugin_create_all_from_file(const char *path) +struct bt_plugin_set *bt_plugin_create_all_from_file(const char *path) { - struct bt_plugin **plugins = NULL; + struct bt_plugin_set *plugin_set = NULL; if (!path) { + BT_LOGW_STR("Invalid parameter: path is NULL."); goto end; } - printf_verbose("Trying to load plugins from `%s`\n", 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 */ 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 +191,27 @@ 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 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; + struct bt_plugin_set *plugin_set = NULL; GPtrArray *dirs = NULL; int ret; - size_t i; + size_t i, j; if (!plugin_name) { + BT_LOGW_STR("Invalid parameter: plugin name is NULL."); goto end; } + 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 +233,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 +244,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 +257,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,48 +267,67 @@ 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_PUT(plugin_set); + + /* bt_plugin_create_all_from_dir() logs details/errors */ + plugin_set = bt_plugin_create_all_from_dir(dir->str, BT_FALSE); + if (!plugin_set) { + BT_LOGD("No plugins found in directory: path=\"%s\"", + dir->str); continue; } - cur_plugin = plugins; + for (j = 0; j < plugin_set->plugins->len; j++) { + 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); + 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 = bt_get(candidate_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_put(plugin_set); + plugin_set = bt_plugin_create_all_from_static(); + if (plugin_set) { + for (j = 0; j < plugin_set->plugins->len; j++) { + 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 = bt_get(candidate_plugin); + goto end; + } } - - cur_plugin++; } end: free(home_plugin_dir); - free_plugins(plugins); + bt_put(plugin_set); if (dirs) { g_ptr_array_free(dirs, TRUE); } + if (plugin) { + BT_LOGD("Found plugin in standard directories and built-in plugins: " + "addr=%p, name=\"%s\", path=\"%s\"", + plugin, plugin_name, bt_plugin_get_path(plugin)); + } else { + BT_LOGD("No plugin found in standard directories and built-in plugins: " + "name=\"%s\"", plugin_name); + } + return plugin; } @@ -253,17 +338,32 @@ struct bt_component_class *bt_plugin_find_component_class( struct bt_plugin *plugin = NULL; struct bt_component_class *comp_cls = NULL; - if (!plugin_name || !comp_cls_name) { + if (!plugin_name) { + BT_LOGW_STR("Invalid parameter: plugin name is NULL."); + goto end; + } + + if (!comp_cls_name) { + BT_LOGW_STR("Invalid parameter: component class name is NULL."); goto end; } + BT_LOGD("Finding named plugin and component class in standard directories and built-in plugins: " + "plugin-name=\"%s\", comp-class-name=\"%s\"", + plugin_name, comp_cls_name); plugin = bt_plugin_find(plugin_name); if (!plugin) { + BT_LOGD_STR("Plugin not found."); goto end; } comp_cls = bt_plugin_get_component_class_by_name_and_type( plugin, comp_cls_name, comp_cls_type); + if (!comp_cls) { + BT_LOGD("Component class not found in plugin: " + "plugin-addr=%p, plugin-path=\"%s\"", + plugin, bt_plugin_get_path(plugin)); + } end: bt_put(plugin); @@ -289,7 +389,8 @@ struct dirent *alloc_dirent(const char *path) static enum bt_plugin_status bt_plugin_create_append_all_from_dir( - GPtrArray *plugins, const char *path, bool recurse) + struct bt_plugin_set *plugin_set, const char *path, + bt_bool recurse) { DIR *directory = NULL; struct dirent *entry = NULL, *result = NULL; @@ -298,25 +399,29 @@ enum bt_plugin_status bt_plugin_create_append_all_from_dir( enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK; if (!path) { + BT_LOGW_STR("Invalid parameter: path is NULL."); ret = BT_PLUGIN_STATUS_ERROR; goto end; } path_len = strlen(path); - if (path_len >= PATH_MAX) { + BT_LOGW("Invalid parameter: path length is too large: " + "path-length=%zu", path_len); ret = BT_PLUGIN_STATUS_ERROR; goto end; } entry = alloc_dirent(path); if (!entry) { + BT_LOGE_STR("Failed to allocate a directory entry."); ret = BT_PLUGIN_STATUS_ERROR; goto end; } file_path = zmalloc(PATH_MAX); if (!file_path) { + BT_LOGE("Failed to allocate %zu bytes.", (size_t) PATH_MAX); ret = BT_PLUGIN_STATUS_NOMEM; goto end; } @@ -329,8 +434,16 @@ enum bt_plugin_status bt_plugin_create_append_all_from_dir( directory = opendir(file_path); if (!directory) { - printf_verbose("Failed to open plugin directory \"%s\"\n", - file_path); + if (errno == EACCES) { + BT_LOGD("Cannot open directory: %s: continuing: " + "path=\"%s\", errno=%d", + strerror(errno), file_path, errno); + goto end; + } + + BT_LOGW("Cannot open directory: %s: " + "path=\"%s\", errno=%d", + strerror(errno), file_path, errno); ret = BT_PLUGIN_STATUS_ERROR; goto end; } @@ -341,14 +454,25 @@ enum bt_plugin_status bt_plugin_create_append_all_from_dir( int stat_ret; size_t file_name_len; + if (strcmp(result->d_name, ".") == 0 || + strcmp(result->d_name, "..") == 0) { + continue; + } + if (result->d_name[0] == '.') { /* Skip hidden files, . and .. */ + BT_LOGV("Skipping hidden file: path=\"%s/%s\"", + path, result->d_name); continue; } file_name_len = strlen(result->d_name); if (path_len + file_name_len >= PATH_MAX) { + BT_LOGD("Skipping file because its path length is too large: continuing: " + "path=\"%s/%s\", length=%zu", + path, result->d_name, + (size_t) (path_len + file_name_len)); continue; } @@ -357,32 +481,44 @@ enum bt_plugin_status bt_plugin_create_append_all_from_dir( stat_ret = stat(file_path, &st); if (stat_ret < 0) { /* Continue to next file / directory. */ - printf_perror("Failed to stat() plugin file\n"); + BT_LOGD("Cannot get file information: %s: continuing: " + "path=\"%s\", errno=%d", + strerror(errno), file_path, errno); continue; } if (S_ISDIR(st.st_mode) && recurse) { - ret = bt_plugin_create_append_all_from_dir(plugins, - file_path, true); + ret = bt_plugin_create_append_all_from_dir(plugin_set, + file_path, BT_TRUE); if (ret < 0) { + BT_LOGW("Cannot recurse into directory to find plugins: " + "path=\"%s\", ret=%d", file_path, ret); goto end; } } else if (S_ISREG(st.st_mode)) { - struct bt_plugin **plugins_from_file = + struct bt_plugin_set *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); + 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_LOGD("Adding plugin to plugin set: " + "plugin-path=\"%s\", plugin-addr=%p, plugin-name=\"%s\"", + file_path, plugin, + bt_plugin_get_name(plugin)); + bt_plugin_set_add_plugin(plugin_set, + plugin); } - free(plugins_from_file); + bt_put(plugins_from_file); } } } + end: if (directory) { if (closedir(directory)) { @@ -390,70 +526,135 @@ end: * We don't want to override the error since there is * nothing could do. */ - perror("Failed to close plug-in directory"); + BT_LOGE("Cannot close directory entry: %s: " + "path=\"%s\", errno=%d", + strerror(errno), path, errno); } } + free(entry); free(file_path); return ret; } -struct bt_plugin **bt_plugin_create_all_from_dir(const char *path, - bool recurse) +struct bt_plugin_set *bt_plugin_create_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_PUT(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) { - return plugin && plugin->info.name_set ? plugin->info.name->str : NULL; + const char *val = NULL; + + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto end; + } + + if (plugin->info.name_set) { + val = plugin->info.name->str; + } + +end: + return val; } const char *bt_plugin_get_author(struct bt_plugin *plugin) { - return plugin && plugin->info.author_set ? plugin->info.author->str : NULL; + const char *val = NULL; + + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto end; + } + + if (plugin->info.author_set) { + val = plugin->info.author->str; + } + +end: + return val; } const char *bt_plugin_get_license(struct bt_plugin *plugin) { - return plugin && plugin->info.license_set ? plugin->info.license->str : NULL; + const char *val = NULL; + + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto end; + } + + if (plugin->info.license_set) { + val = plugin->info.license->str; + } + +end: + return val; } const char *bt_plugin_get_path(struct bt_plugin *plugin) { - return plugin && plugin->info.path_set ? plugin->info.path->str : NULL; + const char *val = NULL; + + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto end; + } + + if (plugin->info.path_set) { + val = plugin->info.path->str; + } + +end: + return val; } const char *bt_plugin_get_description(struct bt_plugin *plugin) { - return plugin && plugin->info.description_set ? plugin->info.description->str : NULL; + const char *val = NULL; + + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto end; + } + + if (plugin->info.description_set) { + val = plugin->info.description->str; + } + +end: + return val; } enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin, @@ -462,7 +663,14 @@ enum bt_plugin_status bt_plugin_get_version(struct bt_plugin *plugin, { enum bt_plugin_status status = BT_PLUGIN_STATUS_OK; - if (!plugin || !plugin->info.version_set) { + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + status = BT_PLUGIN_STATUS_ERROR; + goto end; + } + + if (!plugin->info.version_set) { + BT_LOGV("Plugin's version is not set: addr=%p", plugin); status = BT_PLUGIN_STATUS_ERROR; goto end; } @@ -487,17 +695,25 @@ end: return status; } -int bt_plugin_get_component_class_count(struct bt_plugin *plugin) +int64_t bt_plugin_get_component_class_count(struct bt_plugin *plugin) { - return plugin ? plugin->comp_classes->len : -1; + return plugin ? plugin->comp_classes->len : (int64_t) -1; } -struct bt_component_class *bt_plugin_get_component_class( - struct bt_plugin *plugin, size_t index) +struct bt_component_class *bt_plugin_get_component_class_by_index( + struct bt_plugin *plugin, uint64_t index) { struct bt_component_class *comp_class = NULL; - if (!plugin || index >= plugin->comp_classes->len) { + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto error; + } + + if (index >= plugin->comp_classes->len) { + BT_LOGW("Invalid parameter: index is out of bounds: " + "addr=%p, index=%" PRIu64 ", count=%u", + plugin, index, plugin->comp_classes->len); goto error; } @@ -519,7 +735,13 @@ struct bt_component_class *bt_plugin_get_component_class_by_name_and_type( struct bt_component_class *comp_class = NULL; size_t i; - if (!plugin || !name) { + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto error; + } + + if (!name) { + BT_LOGW_STR("Invalid parameter: name is NULL."); goto error; } @@ -557,7 +779,20 @@ enum bt_plugin_status bt_plugin_add_component_class( struct bt_component_class *comp_class_dup = NULL; int comp_class_index = -1; - if (!plugin || !comp_class || plugin->frozen) { + if (!plugin) { + BT_LOGW_STR("Invalid parameter: plugin is NULL."); + goto error; + } + + if (!comp_class) { + BT_LOGW_STR("Invalid parameter: component class is NULL."); + goto error; + } + + if (plugin->frozen) { + BT_LOGW("Invalid parameter: plugin is frozen: " + "addr=%p, name=\"%s\"", plugin, + bt_plugin_get_name(plugin)); goto error; } @@ -566,10 +801,14 @@ enum bt_plugin_status bt_plugin_add_component_class( 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_LOGW("Invalid parameter: a component class with this name and type already exists in the plugin: " + "plugin-addr=%p, plugin-name=\"%s\", plugin-path=\"%s\", " + "comp-class-name=\"%s\", comp-class-type=%s", + plugin, bt_plugin_get_name(plugin), + bt_plugin_get_path(plugin), bt_component_class_get_name(comp_class), - bt_component_class_get_type(comp_class)); + bt_component_class_type_string( + bt_component_class_get_type(comp_class))); goto error; } @@ -582,6 +821,15 @@ enum bt_plugin_status bt_plugin_add_component_class( bt_plugin_so_on_add_component_class(plugin, comp_class); } + BT_LOGD("Added component class to plugin: " + "plugin-addr=%p, plugin-name=\"%s\", plugin-path=\"%s\", " + "comp-class-addr=%p, comp-class-name=\"%s\", comp-class-type=%s", + plugin, bt_plugin_get_name(plugin), + bt_plugin_get_path(plugin), + comp_class, + bt_component_class_get_name(comp_class), + bt_component_class_type_string( + bt_component_class_get_type(comp_class))); goto end; error: