src/cli/babeltrace2-plugins.c

   1 /*
   2  * Babeltrace trace converter - CLI tool's configuration
   3  *
   4  * Copyright 2016-2019 EfficiOS Inc.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  */
  24
  25 #define BT_LOG_TAG "CLI/PLUGINS"
  26 #include "logging.h"
  27
  28 #include "babeltrace2-plugins.h"
  29
  30 #include <stdbool.h>
  31 #include <babeltrace2/babeltrace.h>
  32
  33 /* Array of bt_plugin * */
  34 static GPtrArray *loaded_plugins;
  35
  36 void init_loaded_plugins(void)
  37 {
  38         loaded_plugins = g_ptr_array_new_with_free_func(
  39                 (GDestroyNotify) bt_plugin_put_ref);
  40 }
  41
  42 void fini_loaded_plugins(void)
  43 {
  44         g_ptr_array_free(loaded_plugins, TRUE);
  45 }
  46
  47 const bt_plugin *find_loaded_plugin(const char *name)
  48 {
  49         int i;
  50         const bt_plugin *plugin = NULL;
  51
  52         BT_ASSERT(name);
  53         BT_LOGI("Finding plugin: name=\"%s\"", name);
  54
  55         for (i = 0; i < loaded_plugins->len; i++) {
  56                 plugin = g_ptr_array_index(loaded_plugins, i);
  57
  58                 if (strcmp(name, bt_plugin_get_name(plugin)) == 0) {
  59                         break;
  60                 }
  61
  62                 plugin = NULL;
  63         }
  64
  65         if (plugin) {
  66                 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
  67                         name, plugin);
  68         } else {
  69                 BT_LOGI("Cannot find plugin: name=\"%s\"", name);
  70         }
  71
  72         bt_plugin_get_ref(plugin);
  73         return plugin;
  74 }
  75
  76 size_t get_loaded_plugins_count(void)
  77 {
  78         return loaded_plugins->len;
  79 }
  80
  81 const bt_plugin **borrow_loaded_plugins(void)
  82 {
  83         return (const bt_plugin **) loaded_plugins->pdata;
  84 }
  85
  86 const bt_plugin *borrow_loaded_plugin(size_t index)
  87 {
  88         BT_ASSERT(index < loaded_plugins->len);
  89         return g_ptr_array_index(loaded_plugins, index);
  90 }
  91
  92 static
  93 void add_to_loaded_plugins(const bt_plugin_set *plugin_set)
  94 {
  95         int64_t i;
  96         int64_t count;
  97
  98         count = bt_plugin_set_get_plugin_count(plugin_set);
  99         BT_ASSERT(count >= 0);
 100
 101         for (i = 0; i < count; i++) {
 102                 const bt_plugin *plugin =
 103                         bt_plugin_set_borrow_plugin_by_index_const(plugin_set, i);
 104                 const bt_plugin *loaded_plugin =
 105                         find_loaded_plugin(bt_plugin_get_name(plugin));
 106
 107                 BT_ASSERT(plugin);
 108
 109                 if (loaded_plugin) {
 110                         BT_LOGI("Not using plugin: another one already exists with the same name: "
 111                                 "plugin-name=\"%s\", plugin-path=\"%s\", "
 112                                 "existing-plugin-path=\"%s\"",
 113                                 bt_plugin_get_name(plugin),
 114                                 bt_plugin_get_path(plugin),
 115                                 bt_plugin_get_path(loaded_plugin));
 116                         bt_plugin_put_ref(loaded_plugin);
 117                 } else {
 118                         /* Add to global array. */
 119                         BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
 120                                 bt_plugin_get_name(plugin));
 121                         bt_plugin_get_ref(plugin);
 122                         g_ptr_array_add(loaded_plugins, (void *) plugin);
 123                 }
 124         }
 125 }
 126
 127 static
 128 int load_dynamic_plugins(const bt_value *plugin_paths)
 129 {
 130         int nr_paths, i, ret = 0;
 131
 132         nr_paths = bt_value_array_get_length(plugin_paths);
 133         if (nr_paths == 0) {
 134                 BT_LOGI_STR("No dynamic plugin path.");
 135                 goto end;
 136         }
 137
 138         BT_LOGI_STR("Loading dynamic plugins.");
 139
 140         for (i = 0; i < nr_paths; i++) {
 141                 const bt_value *plugin_path_value = NULL;
 142                 const char *plugin_path;
 143                 const bt_plugin_set *plugin_set = NULL;
 144                 bt_plugin_find_all_from_dir_status status;
 145
 146                 plugin_path_value =
 147                         bt_value_array_borrow_element_by_index_const(
 148                                 plugin_paths, i);
 149                 plugin_path = bt_value_string_get(plugin_path_value);
 150
 151                 /*
 152                  * Skip this if the directory does not exist because
 153                  * bt_plugin_find_all_from_dir() expects an existing
 154                  * directory.
 155                  */
 156                 if (!g_file_test(plugin_path, G_FILE_TEST_IS_DIR)) {
 157                         BT_LOGI("Skipping nonexistent directory path: "
 158                                 "path=\"%s\"", plugin_path);
 159                         continue;
 160                 }
 161
 162                 status = bt_plugin_find_all_from_dir(plugin_path, BT_FALSE,
 163                         BT_TRUE, &plugin_set);
 164                 if (status < 0) {
 165                         BT_CLI_LOGE_APPEND_CAUSE(
 166                                 "Unable to load dynamic plugins from directory: "
 167                                 "path=\"%s\"", plugin_path);
 168                         ret = status;
 169                         goto end;
 170                 } else if (status ==
 171                                 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND) {
 172                         BT_LOGI("No plugins found in directory: path=\"%s\"",
 173                                 plugin_path);
 174                         continue;
 175                 }
 176
 177                 BT_ASSERT(status == BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK);
 178                 BT_ASSERT(plugin_set);
 179                 add_to_loaded_plugins(plugin_set);
 180                 bt_plugin_set_put_ref(plugin_set);
 181         }
 182 end:
 183         return ret;
 184 }
 185
 186 static
 187 int load_static_plugins(void)
 188 {
 189         int ret = 0;
 190         const bt_plugin_set *plugin_set;
 191         bt_plugin_find_all_from_static_status status;
 192
 193         BT_LOGI("Loading static plugins.");
 194         status = bt_plugin_find_all_from_static(BT_FALSE, &plugin_set);
 195         if (status < 0) {
 196                 BT_LOGE("Unable to load static plugins.");
 197                 ret = -1;
 198                 goto end;
 199         } else if (status ==
 200                         BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND) {
 201                 BT_LOGI("No static plugins found.");
 202                 goto end;
 203         }
 204
 205         BT_ASSERT(status == BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK);
 206         BT_ASSERT(plugin_set);
 207         add_to_loaded_plugins(plugin_set);
 208         bt_plugin_set_put_ref(plugin_set);
 209
 210 end:
 211         return ret;
 212 }
 213
 214 int require_loaded_plugins(const bt_value *plugin_paths)
 215 {
 216         static bool loaded = false;
 217         static int ret = 0;
 218
 219         if (loaded) {
 220                 goto end;
 221         }
 222
 223         loaded = true;
 224
 225         if (load_dynamic_plugins(plugin_paths)) {
 226                 ret = -1;
 227                 goto end;
 228         }
 229
 230         if (load_static_plugins()) {
 231                 ret = -1;
 232                 goto end;
 233         }
 234
 235         BT_LOGI("Loaded all plugins: count=%u", loaded_plugins->len);
 236
 237 end:
 238         return ret;
 239 }