Commit | Line | Data |
---|---|---|
33b34c43 | 1 | /* |
f2b0325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
33b34c43 | 3 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
33b34c43 PP |
4 | * |
5 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
6 | * | |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
24 | */ | |
25 | ||
b03487ab | 26 | #define BT_LOG_TAG "LIB/PLUGIN" |
1633ef46 | 27 | #include "lib/logging.h" |
8c1a3187 | 28 | |
57952005 MJ |
29 | #include "common/assert.h" |
30 | #include "lib/assert-pre.h" | |
85e7137b | 31 | #include "common/macros.h" |
57952005 MJ |
32 | #include "compat/compiler.h" |
33 | #include "common/common.h" | |
71c5da58 MJ |
34 | #include <babeltrace2/plugin/plugin-const.h> |
35 | #include <babeltrace2/graph/component-class-const.h> | |
a8f90e5d | 36 | #include <babeltrace2/current-thread.h> |
57952005 | 37 | #include "lib/graph/component-class.h" |
71c5da58 | 38 | #include <babeltrace2/types.h> |
33b34c43 | 39 | #include <glib.h> |
33b34c43 PP |
40 | #include <unistd.h> |
41 | #include <stdlib.h> | |
9ac68eb1 | 42 | #include <stdint.h> |
8c1a3187 | 43 | #include <inttypes.h> |
33b34c43 | 44 | #include <sys/stat.h> |
1307d39e MJ |
45 | #include <ftw.h> |
46 | #include <pthread.h> | |
33b34c43 | 47 | |
57952005 MJ |
48 | #include "plugin.h" |
49 | #include "plugin-so.h" | |
fb25b9e3 | 50 | #include "lib/func-status.h" |
57952005 | 51 | |
7b783015 MJ |
52 | #define PYTHON_PLUGIN_PROVIDER_FILENAME "babeltrace2-python-plugin-provider." G_MODULE_SUFFIX |
53 | #define PYTHON_PLUGIN_PROVIDER_DIR BABELTRACE_PLUGIN_PROVIDERS_DIR | |
6fbd4105 | 54 | #define PYTHON_PLUGIN_PROVIDER_SYM_NAME bt_plugin_python_create_all_from_file |
85e7137b | 55 | #define PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR G_STRINGIFY(PYTHON_PLUGIN_PROVIDER_SYM_NAME) |
33b34c43 | 56 | |
1307d39e MJ |
57 | #define APPEND_ALL_FROM_DIR_NFDOPEN_MAX 8 |
58 | ||
6fbd4105 | 59 | #ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT |
57952005 | 60 | #include <plugin/python-plugin-provider.h> |
1307d39e | 61 | |
33b34c43 | 62 | static |
fb25b9e3 | 63 | int (*bt_plugin_python_create_all_from_file_sym)( |
01f50d54 PP |
64 | const char *path, bool fail_on_load_error, |
65 | struct bt_plugin_set **plugin_set_out) = | |
6fbd4105 | 66 | bt_plugin_python_create_all_from_file; |
336ea5cd MJ |
67 | |
68 | static | |
a8f90e5d | 69 | enum bt_plugin_status init_python_plugin_provider(void) |
01f50d54 PP |
70 | { |
71 | } | |
6fbd4105 PP |
72 | #else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */ |
73 | static GModule *python_plugin_provider_module; | |
01f50d54 | 74 | |
6fbd4105 | 75 | static |
fb25b9e3 PP |
76 | int (*bt_plugin_python_create_all_from_file_sym)( |
77 | const char *path, bool fail_on_load_error, | |
01f50d54 | 78 | struct bt_plugin_set **plugin_set_out); |
33b34c43 | 79 | |
336ea5cd | 80 | static |
a8f90e5d PP |
81 | int init_python_plugin_provider(void) { |
82 | int status = BT_FUNC_STATUS_OK; | |
7b783015 MJ |
83 | const char *provider_dir_envvar; |
84 | static const char * const provider_dir_envvar_name = "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR"; | |
85 | char *provider_path = NULL; | |
a8f90e5d | 86 | |
336ea5cd | 87 | if (bt_plugin_python_create_all_from_file_sym != NULL) { |
a8f90e5d | 88 | goto end; |
336ea5cd MJ |
89 | } |
90 | ||
a684a357 | 91 | BT_LOGI_STR("Loading Python plugin provider module."); |
7b783015 MJ |
92 | |
93 | provider_dir_envvar = getenv(provider_dir_envvar_name); | |
94 | if (provider_dir_envvar) { | |
95 | provider_path = g_build_filename(provider_dir_envvar, | |
96 | PYTHON_PLUGIN_PROVIDER_FILENAME, NULL); | |
97 | BT_LOGI("Using `%s` environment variable to find the Python " | |
98 | "plugin provider: path=\"%s\"", provider_dir_envvar_name, | |
99 | provider_path); | |
100 | } else { | |
101 | provider_path = g_build_filename(PYTHON_PLUGIN_PROVIDER_DIR, | |
102 | PYTHON_PLUGIN_PROVIDER_FILENAME, NULL); | |
103 | BT_LOGI("Using default path (`%s` environment variable is not " | |
104 | "set) to find the Python plugin provider: path=\"%s\"", | |
105 | provider_dir_envvar_name, provider_path); | |
106 | } | |
107 | ||
108 | python_plugin_provider_module = g_module_open(provider_path, 0); | |
6fbd4105 | 109 | if (!python_plugin_provider_module) { |
01f50d54 PP |
110 | /* |
111 | * This is not an error. The whole point of having an | |
112 | * external Python plugin provider is that it can be | |
113 | * missing and the Babeltrace library still works. | |
114 | */ | |
20e3b31e | 115 | BT_LOGI("Cannot open `%s`: %s: continuing without Python plugin support.", |
7b783015 | 116 | provider_path, g_module_error()); |
a8f90e5d | 117 | goto end; |
33b34c43 PP |
118 | } |
119 | ||
6fbd4105 PP |
120 | if (!g_module_symbol(python_plugin_provider_module, |
121 | PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR, | |
122 | (gpointer) &bt_plugin_python_create_all_from_file_sym)) { | |
01f50d54 PP |
123 | /* |
124 | * This is an error because, since we found the Python | |
125 | * plugin provider shared object, we expect this symbol | |
126 | * to exist. | |
127 | */ | |
a8f90e5d PP |
128 | BT_LIB_LOGE_APPEND_CAUSE( |
129 | "Cannot find the Python plugin provider loading symbol: " | |
01f50d54 | 130 | "%s: continuing without Python plugin support: " |
8c1a3187 | 131 | "file=\"%s\", symbol=\"%s\"", |
01f50d54 | 132 | g_module_error(), |
7b783015 | 133 | provider_path, |
8c1a3187 | 134 | PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR); |
a8f90e5d PP |
135 | status = BT_FUNC_STATUS_ERROR; |
136 | goto end; | |
33b34c43 | 137 | } |
8c1a3187 | 138 | |
9e0bf9b0 | 139 | BT_LOGI("Loaded Python plugin provider module: addr=%p", |
8c1a3187 | 140 | python_plugin_provider_module); |
a8f90e5d PP |
141 | |
142 | end: | |
7b783015 MJ |
143 | g_free(provider_path); |
144 | ||
a8f90e5d | 145 | return status; |
33b34c43 PP |
146 | } |
147 | ||
6fbd4105 PP |
148 | __attribute__((destructor)) static |
149 | void fini_python_plugin_provider(void) { | |
150 | if (python_plugin_provider_module) { | |
a684a357 | 151 | BT_LOGI("Unloading Python plugin provider module."); |
8c1a3187 PP |
152 | |
153 | if (!g_module_close(python_plugin_provider_module)) { | |
a8f90e5d PP |
154 | /* |
155 | * This occurs when the library is finalized: do | |
156 | * NOT append an error cause. | |
157 | */ | |
8c1a3187 PP |
158 | BT_LOGE("Failed to close the Python plugin provider module: %s.", |
159 | g_module_error()); | |
160 | } | |
161 | ||
6fbd4105 | 162 | python_plugin_provider_module = NULL; |
6ba0b073 | 163 | } |
6ba0b073 | 164 | } |
6fbd4105 | 165 | #endif |
6ba0b073 | 166 | |
15a5b9a8 | 167 | uint64_t bt_plugin_set_get_plugin_count(const struct bt_plugin_set *plugin_set) |
a8ff38ef | 168 | { |
fa6cfec3 | 169 | BT_ASSERT_PRE_DEV_NON_NULL(plugin_set, "Plugin set"); |
834e9996 | 170 | return (uint64_t) plugin_set->plugins->len; |
a8ff38ef PP |
171 | } |
172 | ||
3a2cb327 PP |
173 | const struct bt_plugin *bt_plugin_set_borrow_plugin_by_index_const( |
174 | const struct bt_plugin_set *plugin_set, uint64_t index) | |
a8ff38ef | 175 | { |
fa6cfec3 PP |
176 | BT_ASSERT_PRE_DEV_NON_NULL(plugin_set, "Plugin set"); |
177 | BT_ASSERT_PRE_DEV_VALID_INDEX(index, plugin_set->plugins->len); | |
834e9996 | 178 | return g_ptr_array_index(plugin_set->plugins, index); |
a8ff38ef PP |
179 | } |
180 | ||
fb25b9e3 | 181 | enum bt_plugin_find_all_from_static_status bt_plugin_find_all_from_static( |
01f50d54 PP |
182 | bt_bool fail_on_load_error, |
183 | const struct bt_plugin_set **plugin_set_out) | |
6ba0b073 | 184 | { |
8c1a3187 | 185 | /* bt_plugin_so_create_all_from_static() logs errors */ |
01f50d54 PP |
186 | return bt_plugin_so_create_all_from_static(fail_on_load_error, |
187 | (void *) plugin_set_out); | |
6ba0b073 PP |
188 | } |
189 | ||
fb25b9e3 PP |
190 | enum bt_plugin_find_all_from_file_status bt_plugin_find_all_from_file( |
191 | const char *path, bt_bool fail_on_load_error, | |
01f50d54 | 192 | const struct bt_plugin_set **plugin_set_out) |
33b34c43 | 193 | { |
fb25b9e3 | 194 | enum bt_plugin_find_all_from_file_status status; |
33b34c43 | 195 | |
834e9996 | 196 | BT_ASSERT_PRE_NON_NULL(path, "Path"); |
01f50d54 | 197 | BT_ASSERT_PRE_NON_NULL(path, "Plugin set (output)"); |
a684a357 | 198 | BT_LOGI("Creating plugins from file: path=\"%s\"", path); |
6ba0b073 | 199 | |
55bb57e0 | 200 | /* Try shared object plugins */ |
01f50d54 PP |
201 | status = bt_plugin_so_create_all_from_file(path, fail_on_load_error, |
202 | (void *) plugin_set_out); | |
fb25b9e3 | 203 | if (status == BT_FUNC_STATUS_OK) { |
01f50d54 PP |
204 | BT_ASSERT(*plugin_set_out); |
205 | BT_ASSERT((*plugin_set_out)->plugins->len > 0); | |
206 | goto end; | |
207 | } else if (status < 0) { | |
208 | BT_ASSERT(!*plugin_set_out); | |
6ba0b073 PP |
209 | goto end; |
210 | } | |
211 | ||
fb25b9e3 | 212 | BT_ASSERT(status == BT_FUNC_STATUS_NOT_FOUND); |
01f50d54 PP |
213 | BT_ASSERT(!*plugin_set_out); |
214 | ||
6fbd4105 | 215 | /* Try Python plugins if support is available */ |
a8f90e5d PP |
216 | status = init_python_plugin_provider(); |
217 | if (status < 0) { | |
218 | /* init_python_plugin_provider() logs errors */ | |
219 | goto end; | |
220 | } | |
221 | ||
222 | BT_ASSERT(status == BT_FUNC_STATUS_OK); | |
223 | status = BT_FUNC_STATUS_NOT_FOUND; | |
224 | ||
6fbd4105 | 225 | if (bt_plugin_python_create_all_from_file_sym) { |
a8f90e5d | 226 | /* Python plugin provider exists */ |
01f50d54 PP |
227 | status = bt_plugin_python_create_all_from_file_sym(path, |
228 | fail_on_load_error, (void *) plugin_set_out); | |
fb25b9e3 | 229 | if (status == BT_FUNC_STATUS_OK) { |
01f50d54 PP |
230 | BT_ASSERT(*plugin_set_out); |
231 | BT_ASSERT((*plugin_set_out)->plugins->len > 0); | |
232 | goto end; | |
233 | } else if (status < 0) { | |
a8f90e5d PP |
234 | /* |
235 | * bt_plugin_python_create_all_from_file_sym() | |
236 | * handles `fail_on_load_error` itself, so this | |
237 | * is a "real" error. | |
238 | */ | |
01f50d54 | 239 | BT_ASSERT(!*plugin_set_out); |
6fbd4105 PP |
240 | goto end; |
241 | } | |
01f50d54 | 242 | |
fb25b9e3 | 243 | BT_ASSERT(status == BT_FUNC_STATUS_NOT_FOUND); |
01f50d54 | 244 | BT_ASSERT(!*plugin_set_out); |
6ba0b073 PP |
245 | } |
246 | ||
33b34c43 | 247 | end: |
fb25b9e3 | 248 | if (status == BT_FUNC_STATUS_OK) { |
a684a357 | 249 | BT_LOGI("Created %u plugins from file: " |
8c1a3187 | 250 | "path=\"%s\", count=%u, plugin-set-addr=%p", |
01f50d54 PP |
251 | (*plugin_set_out)->plugins->len, path, |
252 | (*plugin_set_out)->plugins->len, | |
253 | *plugin_set_out); | |
fb25b9e3 | 254 | } else if (status == BT_FUNC_STATUS_NOT_FOUND) { |
a684a357 | 255 | BT_LOGI("Found no plugins in file: path=\"%s\"", path); |
8c1a3187 PP |
256 | } |
257 | ||
01f50d54 | 258 | return status; |
33b34c43 PP |
259 | } |
260 | ||
1670bffd PP |
261 | static void destroy_gstring(void *data) |
262 | { | |
263 | g_string_free(data, TRUE); | |
264 | } | |
265 | ||
fb25b9e3 | 266 | enum bt_plugin_find_status bt_plugin_find(const char *plugin_name, |
01f50d54 | 267 | bt_bool fail_on_load_error, const struct bt_plugin **plugin_out) |
1670bffd PP |
268 | { |
269 | const char *system_plugin_dir; | |
270 | char *home_plugin_dir = NULL; | |
271 | const char *envvar; | |
3a2cb327 PP |
272 | const struct bt_plugin *plugin = NULL; |
273 | const struct bt_plugin_set *plugin_set = NULL; | |
1670bffd PP |
274 | GPtrArray *dirs = NULL; |
275 | int ret; | |
fb25b9e3 | 276 | int status = BT_FUNC_STATUS_OK; |
a8ff38ef | 277 | size_t i, j; |
1670bffd | 278 | |
834e9996 | 279 | BT_ASSERT_PRE_NON_NULL(plugin_name, "Name"); |
01f50d54 | 280 | BT_ASSERT_PRE_NON_NULL(plugin_out, "Plugin (output)"); |
a684a357 | 281 | BT_LOGI("Finding named plugin in standard directories and built-in plugins: " |
8c1a3187 | 282 | "name=\"%s\"", plugin_name); |
1670bffd PP |
283 | dirs = g_ptr_array_new_with_free_func((GDestroyNotify) destroy_gstring); |
284 | if (!dirs) { | |
a8f90e5d | 285 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); |
fb25b9e3 | 286 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
1670bffd PP |
287 | goto end; |
288 | } | |
289 | ||
290 | /* | |
291 | * Search order is: | |
292 | * | |
293 | * 1. BABELTRACE_PLUGIN_PATH environment variable | |
294 | * (colon-separated list of directories) | |
fed88866 | 295 | * 2. ~/.local/lib/babeltrace2/plugins |
1670bffd | 296 | * 3. Default system directory for Babeltrace plugins, usually |
fed88866 PP |
297 | * /usr/lib/babeltrace2/plugins or |
298 | * /usr/local/lib/babeltrace2/plugins if installed | |
1670bffd PP |
299 | * locally |
300 | * 4. Built-in plugins (static) | |
301 | * | |
302 | * Directories are searched non-recursively. | |
303 | */ | |
304 | envvar = getenv("BABELTRACE_PLUGIN_PATH"); | |
305 | if (envvar) { | |
306 | ret = bt_common_append_plugin_path_dirs(envvar, dirs); | |
307 | if (ret) { | |
a8f90e5d PP |
308 | BT_LIB_LOGE_APPEND_CAUSE( |
309 | "Failed to append plugin path to array of directories."); | |
fb25b9e3 | 310 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
1670bffd PP |
311 | goto end; |
312 | } | |
313 | } | |
314 | ||
c864e29a | 315 | home_plugin_dir = bt_common_get_home_plugin_path(BT_LOG_OUTPUT_LEVEL); |
1670bffd | 316 | if (home_plugin_dir) { |
01f50d54 | 317 | GString *home_plugin_dir_str = g_string_new(home_plugin_dir); |
1670bffd PP |
318 | |
319 | if (!home_plugin_dir_str) { | |
a8f90e5d | 320 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
fb25b9e3 | 321 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
1670bffd PP |
322 | goto end; |
323 | } | |
324 | ||
325 | g_ptr_array_add(dirs, home_plugin_dir_str); | |
326 | } | |
327 | ||
328 | system_plugin_dir = bt_common_get_system_plugin_path(); | |
329 | if (system_plugin_dir) { | |
330 | GString *system_plugin_dir_str = | |
331 | g_string_new(system_plugin_dir); | |
332 | ||
333 | if (!system_plugin_dir_str) { | |
a8f90e5d | 334 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString."); |
fb25b9e3 | 335 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
1670bffd PP |
336 | goto end; |
337 | } | |
338 | ||
339 | g_ptr_array_add(dirs, system_plugin_dir_str); | |
340 | } | |
341 | ||
342 | for (i = 0; i < dirs->len; i++) { | |
343 | GString *dir = g_ptr_array_index(dirs, i); | |
344 | ||
8138bfe1 | 345 | BT_OBJECT_PUT_REF_AND_RESET(plugin_set); |
8c1a3187 | 346 | |
50ad9320 PP |
347 | /* |
348 | * Skip this if the directory does not exist because | |
781ae911 | 349 | * bt_plugin_find_all_from_dir() would log a warning. |
50ad9320 PP |
350 | */ |
351 | if (!g_file_test(dir->str, G_FILE_TEST_IS_DIR)) { | |
a684a357 | 352 | BT_LOGI("Skipping nonexistent directory path: " |
50ad9320 PP |
353 | "path=\"%s\"", dir->str); |
354 | continue; | |
355 | } | |
356 | ||
781ae911 | 357 | /* bt_plugin_find_all_from_dir() logs details/errors */ |
01f50d54 PP |
358 | status = bt_plugin_find_all_from_dir(dir->str, BT_FALSE, |
359 | fail_on_load_error, &plugin_set); | |
360 | if (status < 0) { | |
361 | BT_ASSERT(!plugin_set); | |
362 | goto end; | |
fb25b9e3 | 363 | } else if (status == BT_FUNC_STATUS_NOT_FOUND) { |
01f50d54 | 364 | BT_ASSERT(!plugin_set); |
a684a357 | 365 | BT_LOGI("No plugins found in directory: path=\"%s\"", |
8c1a3187 | 366 | dir->str); |
1670bffd PP |
367 | continue; |
368 | } | |
369 | ||
fb25b9e3 | 370 | BT_ASSERT(status == BT_FUNC_STATUS_OK); |
01f50d54 PP |
371 | BT_ASSERT(plugin_set); |
372 | ||
a8ff38ef | 373 | for (j = 0; j < plugin_set->plugins->len; j++) { |
3a2cb327 | 374 | const struct bt_plugin *candidate_plugin = |
a8ff38ef | 375 | g_ptr_array_index(plugin_set->plugins, j); |
1670bffd | 376 | |
a8ff38ef PP |
377 | if (strcmp(bt_plugin_get_name(candidate_plugin), |
378 | plugin_name) == 0) { | |
a684a357 | 379 | BT_LOGI("Plugin found in directory: name=\"%s\", path=\"%s\"", |
8c1a3187 | 380 | plugin_name, dir->str); |
01f50d54 PP |
381 | *plugin_out = candidate_plugin; |
382 | bt_object_get_no_null_check(*plugin_out); | |
1670bffd PP |
383 | goto end; |
384 | } | |
1670bffd | 385 | } |
8c1a3187 | 386 | |
a684a357 | 387 | BT_LOGI("Plugin not found in directory: name=\"%s\", path=\"%s\"", |
8c1a3187 | 388 | plugin_name, dir->str); |
1670bffd PP |
389 | } |
390 | ||
01f50d54 PP |
391 | BT_OBJECT_PUT_REF_AND_RESET(plugin_set); |
392 | status = bt_plugin_find_all_from_static(fail_on_load_error, | |
393 | &plugin_set); | |
394 | if (status < 0) { | |
395 | BT_ASSERT(!plugin_set); | |
396 | goto end; | |
fb25b9e3 | 397 | } else if (status == BT_FUNC_STATUS_NOT_FOUND) { |
01f50d54 PP |
398 | BT_ASSERT(!plugin_set); |
399 | BT_LOGI_STR("No plugins found in built-in plugins."); | |
400 | goto end; | |
401 | } | |
402 | ||
fb25b9e3 | 403 | BT_ASSERT(status == BT_FUNC_STATUS_OK); |
01f50d54 PP |
404 | BT_ASSERT(plugin_set); |
405 | ||
406 | for (j = 0; j < plugin_set->plugins->len; j++) { | |
407 | const struct bt_plugin *candidate_plugin = | |
408 | g_ptr_array_index(plugin_set->plugins, j); | |
409 | ||
410 | if (strcmp(bt_plugin_get_name(candidate_plugin), | |
411 | plugin_name) == 0) { | |
412 | BT_LOGI("Plugin found in built-in plugins: " | |
413 | "name=\"%s\"", plugin_name); | |
414 | *plugin_out = candidate_plugin; | |
415 | bt_object_get_no_null_check(*plugin_out); | |
416 | goto end; | |
1670bffd | 417 | } |
1670bffd PP |
418 | } |
419 | ||
fb25b9e3 | 420 | status = BT_FUNC_STATUS_NOT_FOUND; |
01f50d54 | 421 | |
1670bffd PP |
422 | end: |
423 | free(home_plugin_dir); | |
8138bfe1 | 424 | bt_object_put_ref(plugin_set); |
1670bffd PP |
425 | |
426 | if (dirs) { | |
427 | g_ptr_array_free(dirs, TRUE); | |
428 | } | |
429 | ||
fb25b9e3 | 430 | if (status == BT_FUNC_STATUS_OK) { |
a684a357 | 431 | BT_LIB_LOGI("Found plugin in standard directories and built-in plugins: " |
834e9996 | 432 | "%!+l", plugin); |
fb25b9e3 | 433 | } else if (status == BT_FUNC_STATUS_NOT_FOUND) { |
a684a357 | 434 | BT_LOGI("No plugin found in standard directories and built-in plugins: " |
8c1a3187 PP |
435 | "name=\"%s\"", plugin_name); |
436 | } | |
437 | ||
01f50d54 | 438 | return status; |
1670bffd PP |
439 | } |
440 | ||
1307d39e MJ |
441 | static struct { |
442 | pthread_mutex_t lock; | |
443 | struct bt_plugin_set *plugin_set; | |
834e9996 | 444 | bool recurse; |
01f50d54 | 445 | bool fail_on_load_error; |
fb25b9e3 | 446 | int status; |
1307d39e MJ |
447 | } append_all_from_dir_info = { |
448 | .lock = PTHREAD_MUTEX_INITIALIZER | |
449 | }; | |
450 | ||
33b34c43 | 451 | static |
01f50d54 PP |
452 | int nftw_append_all_from_dir(const char *file, |
453 | const struct stat *sb, int flag, struct FTW *s) | |
33b34c43 | 454 | { |
1307d39e MJ |
455 | int ret = 0; |
456 | const char *name = file + s->base; | |
457 | ||
458 | /* Check for recursion */ | |
459 | if (!append_all_from_dir_info.recurse && s->level > 1) { | |
460 | goto end; | |
461 | } | |
462 | ||
463 | switch (flag) { | |
464 | case FTW_F: | |
be3c4e36 | 465 | { |
01f50d54 | 466 | const struct bt_plugin_set *plugins_from_file = NULL; |
be3c4e36 | 467 | |
1307d39e MJ |
468 | if (name[0] == '.') { |
469 | /* Skip hidden files */ | |
a684a357 | 470 | BT_LOGI("Skipping hidden file: path=\"%s\"", file); |
1307d39e MJ |
471 | goto end; |
472 | } | |
be3c4e36 | 473 | |
01f50d54 PP |
474 | append_all_from_dir_info.status = |
475 | bt_plugin_find_all_from_file(file, | |
476 | append_all_from_dir_info.fail_on_load_error, | |
477 | &plugins_from_file); | |
fb25b9e3 | 478 | if (append_all_from_dir_info.status == BT_FUNC_STATUS_OK) { |
1307d39e MJ |
479 | size_t j; |
480 | ||
01f50d54 PP |
481 | BT_ASSERT(plugins_from_file); |
482 | ||
1307d39e MJ |
483 | for (j = 0; j < plugins_from_file->plugins->len; j++) { |
484 | struct bt_plugin *plugin = | |
485 | g_ptr_array_index(plugins_from_file->plugins, j); | |
486 | ||
a684a357 | 487 | BT_LIB_LOGI("Adding plugin to plugin set: " |
834e9996 PP |
488 | "plugin-path=\"%s\", %![plugin-]+l", |
489 | file, plugin); | |
3a2cb327 PP |
490 | bt_plugin_set_add_plugin( |
491 | append_all_from_dir_info.plugin_set, | |
492 | plugin); | |
1307d39e | 493 | } |
33b34c43 | 494 | |
8138bfe1 | 495 | bt_object_put_ref(plugins_from_file); |
01f50d54 PP |
496 | goto end; |
497 | } else if (append_all_from_dir_info.status < 0) { | |
498 | /* bt_plugin_find_all_from_file() logs errors */ | |
499 | BT_ASSERT(!plugins_from_file); | |
500 | ret = -1; | |
501 | goto end; | |
1307d39e | 502 | } |
01f50d54 PP |
503 | |
504 | /* | |
505 | * Not found in this file: this is no an error; continue | |
506 | * walking the directories. | |
507 | */ | |
508 | BT_ASSERT(!plugins_from_file); | |
509 | BT_ASSERT(append_all_from_dir_info.status == | |
fb25b9e3 | 510 | BT_FUNC_STATUS_NOT_FOUND); |
1307d39e | 511 | break; |
be3c4e36 | 512 | } |
1307d39e MJ |
513 | case FTW_DNR: |
514 | /* Continue to next file / directory. */ | |
01f50d54 | 515 | BT_LOGI("Cannot enter directory: continuing: path=\"%s\"", file); |
1307d39e MJ |
516 | break; |
517 | case FTW_NS: | |
518 | /* Continue to next file / directory. */ | |
a684a357 | 519 | BT_LOGI("Cannot get file information: continuing: path=\"%s\"", file); |
1307d39e | 520 | break; |
33b34c43 | 521 | } |
1307d39e MJ |
522 | |
523 | end: | |
524 | return ret; | |
33b34c43 PP |
525 | } |
526 | ||
527 | static | |
fb25b9e3 PP |
528 | int bt_plugin_create_append_all_from_dir(struct bt_plugin_set *plugin_set, |
529 | const char *path, bt_bool recurse, bt_bool fail_on_load_error) | |
33b34c43 | 530 | { |
1307d39e | 531 | int nftw_flags = FTW_PHYS; |
01f50d54 | 532 | int ret; |
fb25b9e3 | 533 | int status; |
f9d17c1c | 534 | struct stat sb; |
33b34c43 | 535 | |
834e9996 PP |
536 | BT_ASSERT(plugin_set); |
537 | BT_ASSERT(path); | |
538 | BT_ASSERT(strlen(path) < PATH_MAX); | |
f9d17c1c JR |
539 | |
540 | /* | |
541 | * Make sure that path exists and is accessible. | |
542 | * This is necessary since Cygwin implementation of nftw() is not POSIX | |
543 | * compliant. Cygwin nftw() implementation does not fail on non-existent | |
544 | * path with ENOENT. Instead, it flags the directory as FTW_NS. FTW_NS during | |
545 | * nftw_append_all_from_dir is not treated as an error since we are | |
546 | * traversing the tree for plugin discovery. | |
547 | */ | |
548 | if (stat(path, &sb)) { | |
549 | BT_LOGW_ERRNO("Cannot open directory", | |
550 | ": path=\"%s\", recurse=%d", | |
551 | path, recurse); | |
a8f90e5d PP |
552 | (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN( |
553 | "Babeltrace library", | |
554 | "Cannot open directory: path=\"%s\", recurse=%d", | |
555 | path, recurse); | |
fb25b9e3 | 556 | status = BT_FUNC_STATUS_ERROR; |
f9d17c1c JR |
557 | goto end; |
558 | } | |
559 | ||
1307d39e | 560 | pthread_mutex_lock(&append_all_from_dir_info.lock); |
1307d39e MJ |
561 | append_all_from_dir_info.plugin_set = plugin_set; |
562 | append_all_from_dir_info.recurse = recurse; | |
fb25b9e3 | 563 | append_all_from_dir_info.status = BT_FUNC_STATUS_OK; |
01f50d54 | 564 | append_all_from_dir_info.fail_on_load_error = fail_on_load_error; |
1307d39e MJ |
565 | ret = nftw(path, nftw_append_all_from_dir, |
566 | APPEND_ALL_FROM_DIR_NFDOPEN_MAX, nftw_flags); | |
01f50d54 PP |
567 | append_all_from_dir_info.plugin_set = NULL; |
568 | status = append_all_from_dir_info.status; | |
1307d39e | 569 | pthread_mutex_unlock(&append_all_from_dir_info.lock); |
01f50d54 | 570 | if (ret) { |
a8f90e5d | 571 | BT_LIB_LOGW_APPEND_CAUSE("Failed to walk directory", |
01f50d54 PP |
572 | ": path=\"%s\", recurse=%d", |
573 | path, recurse); | |
fb25b9e3 | 574 | status = BT_FUNC_STATUS_ERROR; |
01f50d54 PP |
575 | goto end; |
576 | } | |
577 | ||
fb25b9e3 | 578 | if (status == BT_FUNC_STATUS_NOT_FOUND) { |
01f50d54 PP |
579 | /* |
580 | * We're just appending in this function; even if | |
581 | * nothing was found, it's still okay from the caller's | |
582 | * perspective. | |
583 | */ | |
fb25b9e3 | 584 | status = BT_FUNC_STATUS_OK; |
33b34c43 | 585 | } |
8c1a3187 | 586 | |
01f50d54 | 587 | end: |
70d47316 | 588 | return status; |
33b34c43 PP |
589 | } |
590 | ||
fb25b9e3 PP |
591 | enum bt_plugin_find_all_from_dir_status bt_plugin_find_all_from_dir( |
592 | const char *path, bt_bool recurse, bt_bool fail_on_load_error, | |
01f50d54 | 593 | const struct bt_plugin_set **plugin_set_out) |
33b34c43 | 594 | { |
fb25b9e3 PP |
595 | enum bt_plugin_find_all_from_dir_status status = |
596 | BT_FUNC_STATUS_OK; | |
33b34c43 | 597 | |
01f50d54 | 598 | BT_ASSERT_PRE_NON_NULL(plugin_set_out, "Plugin set (output)"); |
a684a357 | 599 | BT_LOGI("Creating all plugins in directory: path=\"%s\", recurse=%d", |
8c1a3187 | 600 | path, recurse); |
01f50d54 PP |
601 | *plugin_set_out = bt_plugin_set_create(); |
602 | if (!*plugin_set_out) { | |
a8f90e5d | 603 | BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set."); |
fb25b9e3 | 604 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
a8ff38ef PP |
605 | goto error; |
606 | } | |
607 | ||
01f50d54 PP |
608 | /* |
609 | * Append found plugins to array (never returns | |
fb25b9e3 | 610 | * `BT_FUNC_STATUS_NOT_FOUND`) |
01f50d54 PP |
611 | */ |
612 | status = bt_plugin_create_append_all_from_dir((void *) *plugin_set_out, | |
613 | path, recurse, fail_on_load_error); | |
33b34c43 | 614 | if (status < 0) { |
01f50d54 PP |
615 | /* |
616 | * bt_plugin_create_append_all_from_dir() handles | |
617 | * `fail_on_load_error`, so this is a "real" error. | |
618 | */ | |
a8f90e5d PP |
619 | BT_LIB_LOGE_APPEND_CAUSE( |
620 | "Cannot append plugins found in directory: " | |
dbd7f7e9 | 621 | "path=\"%s\", status=%s", |
fb25b9e3 | 622 | path, bt_common_func_status_string(status)); |
33b34c43 PP |
623 | goto error; |
624 | } | |
625 | ||
fb25b9e3 | 626 | BT_ASSERT(status == BT_FUNC_STATUS_OK); |
01f50d54 PP |
627 | |
628 | if ((*plugin_set_out)->plugins->len == 0) { | |
629 | /* Nothing was appended: not found */ | |
630 | BT_LOGI("No plugins found in directory: path=\"%s\"", path); | |
fb25b9e3 | 631 | status = BT_FUNC_STATUS_NOT_FOUND; |
01f50d54 PP |
632 | goto error; |
633 | } | |
634 | ||
a684a357 | 635 | BT_LOGI("Created %u plugins from directory: count=%u, path=\"%s\"", |
01f50d54 PP |
636 | (*plugin_set_out)->plugins->len, |
637 | (*plugin_set_out)->plugins->len, path); | |
33b34c43 PP |
638 | goto end; |
639 | ||
640 | error: | |
fb25b9e3 | 641 | BT_ASSERT(status != BT_FUNC_STATUS_OK); |
01f50d54 | 642 | BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out); |
33b34c43 PP |
643 | |
644 | end: | |
01f50d54 | 645 | return status; |
33b34c43 PP |
646 | } |
647 | ||
3a2cb327 | 648 | const char *bt_plugin_get_name(const struct bt_plugin *plugin) |
33b34c43 | 649 | { |
fa6cfec3 | 650 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 | 651 | return plugin->info.name_set ? plugin->info.name->str : NULL; |
33b34c43 PP |
652 | } |
653 | ||
3a2cb327 | 654 | const char *bt_plugin_get_author(const struct bt_plugin *plugin) |
33b34c43 | 655 | { |
fa6cfec3 | 656 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 | 657 | return plugin->info.author_set ? plugin->info.author->str : NULL; |
33b34c43 PP |
658 | } |
659 | ||
3a2cb327 | 660 | const char *bt_plugin_get_license(const struct bt_plugin *plugin) |
33b34c43 | 661 | { |
fa6cfec3 | 662 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 | 663 | return plugin->info.license_set ? plugin->info.license->str : NULL; |
33b34c43 PP |
664 | } |
665 | ||
3a2cb327 | 666 | const char *bt_plugin_get_path(const struct bt_plugin *plugin) |
33b34c43 | 667 | { |
fa6cfec3 | 668 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 | 669 | return plugin->info.path_set ? plugin->info.path->str : NULL; |
33b34c43 PP |
670 | } |
671 | ||
3a2cb327 | 672 | const char *bt_plugin_get_description(const struct bt_plugin *plugin) |
33b34c43 | 673 | { |
fa6cfec3 | 674 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 PP |
675 | return plugin->info.description_set ? |
676 | plugin->info.description->str : NULL; | |
33b34c43 PP |
677 | } |
678 | ||
3a2cb327 | 679 | enum bt_property_availability bt_plugin_get_version(const struct bt_plugin *plugin, |
b6de043b PP |
680 | unsigned int *major, unsigned int *minor, unsigned int *patch, |
681 | const char **extra) | |
682 | { | |
834e9996 PP |
683 | enum bt_property_availability avail = |
684 | BT_PROPERTY_AVAILABILITY_AVAILABLE; | |
b6de043b | 685 | |
fa6cfec3 | 686 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
8c1a3187 PP |
687 | |
688 | if (!plugin->info.version_set) { | |
a684a357 | 689 | BT_LIB_LOGD("Plugin's version is not set: %!+l", plugin); |
834e9996 | 690 | avail = BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE; |
b6de043b PP |
691 | goto end; |
692 | } | |
693 | ||
694 | if (major) { | |
55bb57e0 | 695 | *major = plugin->info.version.major; |
b6de043b PP |
696 | } |
697 | ||
698 | if (minor) { | |
55bb57e0 | 699 | *minor = plugin->info.version.minor; |
b6de043b PP |
700 | } |
701 | ||
702 | if (patch) { | |
55bb57e0 | 703 | *patch = plugin->info.version.patch; |
b6de043b PP |
704 | } |
705 | ||
706 | if (extra) { | |
55bb57e0 | 707 | *extra = plugin->info.version.extra->str; |
b6de043b PP |
708 | } |
709 | ||
710 | end: | |
834e9996 | 711 | return avail; |
b6de043b PP |
712 | } |
713 | ||
3a2cb327 | 714 | uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin *plugin) |
33b34c43 | 715 | { |
fa6cfec3 | 716 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 | 717 | return (uint64_t) plugin->src_comp_classes->len; |
33b34c43 PP |
718 | } |
719 | ||
3a2cb327 | 720 | uint64_t bt_plugin_get_filter_component_class_count(const struct bt_plugin *plugin) |
33b34c43 | 721 | { |
fa6cfec3 | 722 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 PP |
723 | return (uint64_t) plugin->flt_comp_classes->len; |
724 | } | |
33b34c43 | 725 | |
3a2cb327 | 726 | uint64_t bt_plugin_get_sink_component_class_count(const struct bt_plugin *plugin) |
834e9996 | 727 | { |
fa6cfec3 | 728 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
834e9996 PP |
729 | return (uint64_t) plugin->sink_comp_classes->len; |
730 | } | |
8c1a3187 | 731 | |
834e9996 PP |
732 | static inline |
733 | struct bt_component_class *borrow_component_class_by_index( | |
3a2cb327 | 734 | const struct bt_plugin *plugin, GPtrArray *comp_classes, |
834e9996 PP |
735 | uint64_t index) |
736 | { | |
fa6cfec3 PP |
737 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
738 | BT_ASSERT_PRE_DEV_VALID_INDEX(index, comp_classes->len); | |
834e9996 PP |
739 | return g_ptr_array_index(comp_classes, index); |
740 | } | |
33b34c43 | 741 | |
7b53201c | 742 | const struct bt_component_class_source * |
3eff3102 | 743 | bt_plugin_borrow_source_component_class_by_index_const( |
3a2cb327 | 744 | const struct bt_plugin *plugin, uint64_t index) |
834e9996 | 745 | { |
7b53201c | 746 | return (const void *) borrow_component_class_by_index(plugin, |
834e9996 PP |
747 | plugin->src_comp_classes, index); |
748 | } | |
33b34c43 | 749 | |
7b53201c | 750 | const struct bt_component_class_filter * |
3a2cb327 PP |
751 | bt_plugin_borrow_filter_component_class_by_index_const( |
752 | const struct bt_plugin *plugin, uint64_t index) | |
834e9996 | 753 | { |
7b53201c | 754 | return (const void *) borrow_component_class_by_index(plugin, |
834e9996 PP |
755 | plugin->flt_comp_classes, index); |
756 | } | |
757 | ||
7b53201c | 758 | const struct bt_component_class_sink * |
3a2cb327 PP |
759 | bt_plugin_borrow_sink_component_class_by_index_const( |
760 | const struct bt_plugin *plugin, uint64_t index) | |
834e9996 | 761 | { |
7b53201c | 762 | return (const void *) borrow_component_class_by_index(plugin, |
834e9996 | 763 | plugin->sink_comp_classes, index); |
33b34c43 PP |
764 | } |
765 | ||
834e9996 PP |
766 | static inline |
767 | struct bt_component_class *borrow_component_class_by_name( | |
3a2cb327 | 768 | const struct bt_plugin *plugin, GPtrArray *comp_classes, |
834e9996 | 769 | const char *name) |
33b34c43 PP |
770 | { |
771 | struct bt_component_class *comp_class = NULL; | |
772 | size_t i; | |
773 | ||
fa6cfec3 PP |
774 | BT_ASSERT_PRE_DEV_NON_NULL(plugin, "Plugin"); |
775 | BT_ASSERT_PRE_DEV_NON_NULL(name, "Name"); | |
33b34c43 | 776 | |
834e9996 | 777 | for (i = 0; i < comp_classes->len; i++) { |
33b34c43 | 778 | struct bt_component_class *comp_class_candidate = |
834e9996 | 779 | g_ptr_array_index(comp_classes, i); |
33b34c43 PP |
780 | const char *comp_class_cand_name = |
781 | bt_component_class_get_name(comp_class_candidate); | |
33b34c43 | 782 | |
8b45963b | 783 | BT_ASSERT(comp_class_cand_name); |
33b34c43 | 784 | |
834e9996 PP |
785 | if (strcmp(name, comp_class_cand_name) == 0) { |
786 | comp_class = comp_class_candidate; | |
33b34c43 PP |
787 | break; |
788 | } | |
789 | } | |
790 | ||
33b34c43 PP |
791 | return comp_class; |
792 | } | |
793 | ||
7b53201c | 794 | const struct bt_component_class_source * |
3a2cb327 PP |
795 | bt_plugin_borrow_source_component_class_by_name_const( |
796 | const struct bt_plugin *plugin, const char *name) | |
33b34c43 | 797 | { |
7b53201c | 798 | return (const void *) borrow_component_class_by_name(plugin, |
834e9996 PP |
799 | plugin->src_comp_classes, name); |
800 | } | |
33b34c43 | 801 | |
7b53201c | 802 | const struct bt_component_class_filter * |
3a2cb327 PP |
803 | bt_plugin_borrow_filter_component_class_by_name_const( |
804 | const struct bt_plugin *plugin, const char *name) | |
834e9996 | 805 | { |
7b53201c | 806 | return (const void *) borrow_component_class_by_name(plugin, |
834e9996 PP |
807 | plugin->flt_comp_classes, name); |
808 | } | |
33b34c43 | 809 | |
7b53201c | 810 | const struct bt_component_class_sink * |
3a2cb327 PP |
811 | bt_plugin_borrow_sink_component_class_by_name_const( |
812 | const struct bt_plugin *plugin, const char *name) | |
834e9996 | 813 | { |
7b53201c | 814 | return (const void *) borrow_component_class_by_name(plugin, |
834e9996 | 815 | plugin->sink_comp_classes, name); |
33b34c43 | 816 | } |
8c6884d9 PP |
817 | |
818 | void bt_plugin_get_ref(const struct bt_plugin *plugin) | |
819 | { | |
820 | bt_object_get_ref(plugin); | |
821 | } | |
822 | ||
823 | void bt_plugin_put_ref(const struct bt_plugin *plugin) | |
824 | { | |
825 | bt_object_put_ref(plugin); | |
826 | } | |
827 | ||
828 | void bt_plugin_set_get_ref(const struct bt_plugin_set *plugin_set) | |
829 | { | |
830 | bt_object_get_ref(plugin_set); | |
831 | } | |
832 | ||
833 | void bt_plugin_set_put_ref(const struct bt_plugin_set *plugin_set) | |
834 | { | |
835 | bt_object_put_ref(plugin_set); | |
836 | } |