2 * Babeltrace trace converter - CLI tool's configuration
4 * Copyright 2016-2019 EfficiOS Inc.
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
25 #define BT_LOG_TAG "CLI/PLUGINS"
28 #include "babeltrace2-plugins.h"
31 #include <babeltrace2/babeltrace.h>
33 /* Array of bt_plugin * */
34 static GPtrArray
*loaded_plugins
;
36 void init_loaded_plugins(void)
38 loaded_plugins
= g_ptr_array_new_with_free_func(
39 (GDestroyNotify
) bt_plugin_put_ref
);
42 void fini_loaded_plugins(void)
44 g_ptr_array_free(loaded_plugins
, TRUE
);
47 const bt_plugin
*borrow_loaded_plugin_by_name(const char *name
)
50 const bt_plugin
*plugin
= NULL
;
53 BT_LOGI("Finding plugin: name=\"%s\"", name
);
55 for (i
= 0; i
< loaded_plugins
->len
; i
++) {
56 plugin
= g_ptr_array_index(loaded_plugins
, i
);
58 if (strcmp(name
, bt_plugin_get_name(plugin
)) == 0) {
66 BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p",
69 BT_LOGI("Cannot find plugin: name=\"%s\"", name
);
75 size_t get_loaded_plugins_count(void)
77 return loaded_plugins
->len
;
80 const bt_plugin
**borrow_loaded_plugins(void)
82 return (const bt_plugin
**) loaded_plugins
->pdata
;
85 const bt_plugin
*borrow_loaded_plugin_by_index(size_t index
)
87 BT_ASSERT(index
< loaded_plugins
->len
);
88 return g_ptr_array_index(loaded_plugins
, index
);
92 void add_to_loaded_plugins(const bt_plugin_set
*plugin_set
)
97 count
= bt_plugin_set_get_plugin_count(plugin_set
);
98 BT_ASSERT(count
>= 0);
100 for (i
= 0; i
< count
; i
++) {
101 const bt_plugin
*plugin
=
102 bt_plugin_set_borrow_plugin_by_index_const(plugin_set
, i
);
103 const bt_plugin
*loaded_plugin
=
104 borrow_loaded_plugin_by_name(bt_plugin_get_name(plugin
));
109 BT_LOGI("Not using plugin: another one already exists with the same name: "
110 "plugin-name=\"%s\", plugin-path=\"%s\", "
111 "existing-plugin-path=\"%s\"",
112 bt_plugin_get_name(plugin
),
113 bt_plugin_get_path(plugin
),
114 bt_plugin_get_path(loaded_plugin
));
116 /* Add to global array. */
117 BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"",
118 bt_plugin_get_name(plugin
));
119 bt_plugin_get_ref(plugin
);
120 g_ptr_array_add(loaded_plugins
, (void *) plugin
);
126 int load_dynamic_plugins(const bt_value
*plugin_paths
)
128 int nr_paths
, i
, ret
= 0;
130 nr_paths
= bt_value_array_get_length(plugin_paths
);
132 BT_LOGI_STR("No dynamic plugin path.");
136 BT_LOGI_STR("Loading dynamic plugins.");
138 for (i
= 0; i
< nr_paths
; i
++) {
139 const bt_value
*plugin_path_value
= NULL
;
140 const char *plugin_path
;
141 const bt_plugin_set
*plugin_set
= NULL
;
142 bt_plugin_find_all_from_dir_status status
;
145 bt_value_array_borrow_element_by_index_const(
147 plugin_path
= bt_value_string_get(plugin_path_value
);
150 * Skip this if the directory does not exist because
151 * bt_plugin_find_all_from_dir() expects an existing
154 if (!g_file_test(plugin_path
, G_FILE_TEST_IS_DIR
)) {
155 BT_LOGI("Skipping nonexistent directory path: "
156 "path=\"%s\"", plugin_path
);
160 status
= bt_plugin_find_all_from_dir(plugin_path
, BT_FALSE
,
161 BT_TRUE
, &plugin_set
);
163 BT_CLI_LOGE_APPEND_CAUSE(
164 "Unable to load dynamic plugins from directory: "
165 "path=\"%s\"", plugin_path
);
169 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND
) {
170 BT_LOGI("No plugins found in directory: path=\"%s\"",
175 BT_ASSERT(status
== BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK
);
176 BT_ASSERT(plugin_set
);
177 add_to_loaded_plugins(plugin_set
);
178 bt_plugin_set_put_ref(plugin_set
);
185 int load_static_plugins(void)
188 const bt_plugin_set
*plugin_set
;
189 bt_plugin_find_all_from_static_status status
;
191 BT_LOGI("Loading static plugins.");
192 status
= bt_plugin_find_all_from_static(BT_FALSE
, &plugin_set
);
194 BT_LOGE("Unable to load static plugins.");
198 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND
) {
199 BT_LOGI("No static plugins found.");
203 BT_ASSERT(status
== BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK
);
204 BT_ASSERT(plugin_set
);
205 add_to_loaded_plugins(plugin_set
);
206 bt_plugin_set_put_ref(plugin_set
);
212 int require_loaded_plugins(const bt_value
*plugin_paths
)
214 static bool loaded
= false;
223 if (load_dynamic_plugins(plugin_paths
)) {
228 if (load_static_plugins()) {
233 BT_LOGI("Loaded all plugins: count=%u", loaded_plugins
->len
);