2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #define BT_LOG_TAG "LIB/PLUGIN"
27 #include "lib/logging.h"
29 #include "common/assert.h"
30 #include "lib/assert-pre.h"
31 #include "common/macros.h"
32 #include "compat/compiler.h"
33 #include "common/common.h"
34 #include <babeltrace2/plugin/plugin-loading.h>
35 #include <babeltrace2/graph/component-class.h>
36 #include <babeltrace2/error-reporting.h>
37 #include "lib/graph/component-class.h"
38 #include <babeltrace2/types.h>
50 #include "plugin-so.h"
51 #include "lib/func-status.h"
53 #define PYTHON_PLUGIN_PROVIDER_FILENAME "babeltrace2-python-plugin-provider." G_MODULE_SUFFIX
54 #define PYTHON_PLUGIN_PROVIDER_DIR BABELTRACE_PLUGIN_PROVIDERS_DIR
55 #define PYTHON_PLUGIN_PROVIDER_SYM_NAME bt_plugin_python_create_all_from_file
56 #define PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR G_STRINGIFY(PYTHON_PLUGIN_PROVIDER_SYM_NAME)
58 #define APPEND_ALL_FROM_DIR_NFDOPEN_MAX 8
60 /* Declare here to make sure definition in both ifdef branches are in sync. */
62 int init_python_plugin_provider(void);
63 typedef int (*create_all_from_file_sym_type
)(
65 bool fail_on_load_error
,
66 struct bt_plugin_set
**plugin_set_out
);
68 #ifdef BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT
69 #include <plugin/python-plugin-provider.h>
72 create_all_from_file_sym_type
73 bt_plugin_python_create_all_from_file_sym
=
74 bt_plugin_python_create_all_from_file
;
77 int init_python_plugin_provider(void)
80 #else /* BT_BUILT_IN_PYTHON_PLUGIN_SUPPORT */
81 static GModule
*python_plugin_provider_module
;
84 create_all_from_file_sym_type bt_plugin_python_create_all_from_file_sym
;
87 int init_python_plugin_provider(void) {
88 int status
= BT_FUNC_STATUS_OK
;
89 const char *provider_dir_envvar
;
90 static const char * const provider_dir_envvar_name
= "LIBBABELTRACE2_PLUGIN_PROVIDER_DIR";
91 char *provider_path
= NULL
;
93 if (bt_plugin_python_create_all_from_file_sym
) {
97 BT_LOGI_STR("Loading Python plugin provider module.");
99 provider_dir_envvar
= getenv(provider_dir_envvar_name
);
100 if (provider_dir_envvar
) {
101 provider_path
= g_build_filename(provider_dir_envvar
,
102 PYTHON_PLUGIN_PROVIDER_FILENAME
, NULL
);
103 BT_LOGI("Using `%s` environment variable to find the Python "
104 "plugin provider: path=\"%s\"", provider_dir_envvar_name
,
107 provider_path
= g_build_filename(PYTHON_PLUGIN_PROVIDER_DIR
,
108 PYTHON_PLUGIN_PROVIDER_FILENAME
, NULL
);
109 BT_LOGI("Using default path (`%s` environment variable is not "
110 "set) to find the Python plugin provider: path=\"%s\"",
111 provider_dir_envvar_name
, provider_path
);
114 python_plugin_provider_module
= g_module_open(provider_path
, 0);
115 if (!python_plugin_provider_module
) {
117 * This is not an error. The whole point of having an
118 * external Python plugin provider is that it can be
119 * missing and the Babeltrace library still works.
121 BT_LOGI("Cannot open `%s`: %s: continuing without Python plugin support.",
122 provider_path
, g_module_error());
126 if (!g_module_symbol(python_plugin_provider_module
,
127 PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR
,
128 (gpointer
) &bt_plugin_python_create_all_from_file_sym
)) {
130 * This is an error because, since we found the Python
131 * plugin provider shared object, we expect this symbol
134 BT_LIB_LOGE_APPEND_CAUSE(
135 "Cannot find the Python plugin provider loading symbol: "
136 "%s: continuing without Python plugin support: "
137 "file=\"%s\", symbol=\"%s\"",
140 PYTHON_PLUGIN_PROVIDER_SYM_NAME_STR
);
141 status
= BT_FUNC_STATUS_ERROR
;
145 BT_LOGI("Loaded Python plugin provider module: addr=%p",
146 python_plugin_provider_module
);
149 g_free(provider_path
);
154 __attribute__((destructor
)) static
155 void fini_python_plugin_provider(void) {
156 if (python_plugin_provider_module
) {
157 BT_LOGI("Unloading Python plugin provider module.");
159 if (!g_module_close(python_plugin_provider_module
)) {
161 * This occurs when the library is finalized: do
162 * NOT append an error cause.
164 BT_LOGE("Failed to close the Python plugin provider module: %s.",
168 python_plugin_provider_module
= NULL
;
173 uint64_t bt_plugin_set_get_plugin_count(const struct bt_plugin_set
*plugin_set
)
175 BT_ASSERT_PRE_DEV_NON_NULL(plugin_set
, "Plugin set");
176 return (uint64_t) plugin_set
->plugins
->len
;
179 const struct bt_plugin
*bt_plugin_set_borrow_plugin_by_index_const(
180 const struct bt_plugin_set
*plugin_set
, uint64_t index
)
182 BT_ASSERT_PRE_DEV_NON_NULL(plugin_set
, "Plugin set");
183 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, plugin_set
->plugins
->len
);
184 return g_ptr_array_index(plugin_set
->plugins
, index
);
187 enum bt_plugin_find_all_from_static_status
bt_plugin_find_all_from_static(
188 bt_bool fail_on_load_error
,
189 const struct bt_plugin_set
**plugin_set_out
)
191 BT_ASSERT_PRE_NO_ERROR();
193 /* bt_plugin_so_create_all_from_static() logs errors */
194 return bt_plugin_so_create_all_from_static(fail_on_load_error
,
195 (void *) plugin_set_out
);
198 enum bt_plugin_find_all_from_file_status
bt_plugin_find_all_from_file(
199 const char *path
, bt_bool fail_on_load_error
,
200 const struct bt_plugin_set
**plugin_set_out
)
202 enum bt_plugin_find_all_from_file_status status
;
204 BT_ASSERT_PRE_NO_ERROR();
205 BT_ASSERT_PRE_NON_NULL(path
, "Path");
206 BT_ASSERT_PRE_NON_NULL(path
, "Plugin set (output)");
207 BT_LOGI("Creating plugins from file: path=\"%s\"", path
);
209 /* Try shared object plugins */
210 status
= bt_plugin_so_create_all_from_file(path
, fail_on_load_error
,
211 (void *) plugin_set_out
);
212 if (status
== BT_FUNC_STATUS_OK
) {
213 BT_ASSERT(*plugin_set_out
);
214 BT_ASSERT((*plugin_set_out
)->plugins
->len
> 0);
216 } else if (status
< 0) {
217 BT_ASSERT(!*plugin_set_out
);
221 BT_ASSERT(status
== BT_FUNC_STATUS_NOT_FOUND
);
222 BT_ASSERT(!*plugin_set_out
);
224 /* Try Python plugins if support is available */
225 status
= init_python_plugin_provider();
227 /* init_python_plugin_provider() logs errors */
231 BT_ASSERT(status
== BT_FUNC_STATUS_OK
);
232 status
= BT_FUNC_STATUS_NOT_FOUND
;
234 if (bt_plugin_python_create_all_from_file_sym
) {
235 /* Python plugin provider exists */
236 status
= bt_plugin_python_create_all_from_file_sym(path
,
237 fail_on_load_error
, (void *) plugin_set_out
);
238 if (status
== BT_FUNC_STATUS_OK
) {
239 BT_ASSERT(*plugin_set_out
);
240 BT_ASSERT((*plugin_set_out
)->plugins
->len
> 0);
242 } else if (status
< 0) {
244 * bt_plugin_python_create_all_from_file_sym()
245 * handles `fail_on_load_error` itself, so this
248 BT_ASSERT(!*plugin_set_out
);
252 BT_ASSERT(status
== BT_FUNC_STATUS_NOT_FOUND
);
253 BT_ASSERT(!*plugin_set_out
);
257 if (status
== BT_FUNC_STATUS_OK
) {
258 BT_LOGI("Created %u plugins from file: "
259 "path=\"%s\", count=%u, plugin-set-addr=%p",
260 (*plugin_set_out
)->plugins
->len
, path
,
261 (*plugin_set_out
)->plugins
->len
,
263 } else if (status
== BT_FUNC_STATUS_NOT_FOUND
) {
264 BT_LOGI("Found no plugins in file: path=\"%s\"", path
);
271 void destroy_gstring(void *data
)
273 g_string_free(data
, TRUE
);
276 enum bt_plugin_find_all_status
bt_plugin_find_all(bt_bool find_in_std_env_var
,
277 bt_bool find_in_user_dir
, bt_bool find_in_sys_dir
,
278 bt_bool find_in_static
, bt_bool fail_on_load_error
,
279 const struct bt_plugin_set
**plugin_set_out
)
281 char *home_plugin_dir
= NULL
;
282 const struct bt_plugin_set
*plugin_set
= NULL
;
283 GPtrArray
*dirs
= NULL
;
285 int status
= BT_FUNC_STATUS_OK
;
286 uint64_t dir_i
, plugin_i
;
288 BT_ASSERT_PRE_NO_ERROR();
289 BT_ASSERT_PRE_NON_NULL(plugin_set_out
, "Plugin set (output)");
290 BT_LOGI("Finding all plugins in standard directories and built-in plugins: "
291 "find-in-std-env-var=%d, find-in-user-dir=%d, "
292 "find-in-sys-dir=%d, find-in-static=%d",
293 find_in_std_env_var
, find_in_user_dir
, find_in_sys_dir
,
295 dirs
= g_ptr_array_new_with_free_func((GDestroyNotify
) destroy_gstring
);
297 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
298 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
302 *plugin_set_out
= bt_plugin_set_create();
303 if (!*plugin_set_out
) {
304 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set.");
305 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
312 * 1. `BABELTRACE_PLUGIN_PATH` environment variable
313 * (colon-separated list of directories)
314 * 2. `~/.local/lib/babeltrace2/plugins`
315 * 3. Default system directory for Babeltrace plugins, usually
316 * `/usr/lib/babeltrace2/plugins` or
317 * `/usr/local/lib/babeltrace2/plugins` if installed locally
318 * 4. Built-in plugins (static)
320 * Directories are searched non-recursively.
322 if (find_in_std_env_var
) {
323 const char *envvar
= getenv("BABELTRACE_PLUGIN_PATH");
326 ret
= bt_common_append_plugin_path_dirs(envvar
, dirs
);
328 BT_LIB_LOGE_APPEND_CAUSE(
329 "Failed to append plugin path to array of directories.");
330 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
336 if (find_in_user_dir
) {
337 home_plugin_dir
= bt_common_get_home_plugin_path(
338 BT_LOG_OUTPUT_LEVEL
);
339 if (home_plugin_dir
) {
340 GString
*home_plugin_dir_str
= g_string_new(
343 if (!home_plugin_dir_str
) {
344 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
345 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
349 g_ptr_array_add(dirs
, home_plugin_dir_str
);
353 if (find_in_sys_dir
) {
354 const char *system_plugin_dir
=
355 bt_common_get_system_plugin_path();
357 if (system_plugin_dir
) {
358 GString
*system_plugin_dir_str
=
359 g_string_new(system_plugin_dir
);
361 if (!system_plugin_dir_str
) {
362 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
363 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
367 g_ptr_array_add(dirs
, system_plugin_dir_str
);
371 for (dir_i
= 0; dir_i
< dirs
->len
; dir_i
++) {
372 GString
*dir
= dirs
->pdata
[dir_i
];
374 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
377 * Skip this if the directory does not exist because
378 * bt_plugin_find_all_from_dir() would log a warning.
380 if (!g_file_test(dir
->str
, G_FILE_TEST_IS_DIR
)) {
381 BT_LOGI("Skipping nonexistent directory path: "
382 "path=\"%s\"", dir
->str
);
386 /* bt_plugin_find_all_from_dir() logs details/errors */
387 status
= bt_plugin_find_all_from_dir(dir
->str
, BT_FALSE
,
388 fail_on_load_error
, &plugin_set
);
390 BT_ASSERT(!plugin_set
);
392 } else if (status
== BT_FUNC_STATUS_NOT_FOUND
) {
393 BT_ASSERT(!plugin_set
);
394 BT_LOGI("No plugins found in directory: path=\"%s\"",
399 BT_ASSERT(status
== BT_FUNC_STATUS_OK
);
400 BT_ASSERT(plugin_set
);
401 BT_LOGI("Found plugins in directory: path=\"%s\", count=%u",
402 dir
->str
, plugin_set
->plugins
->len
);
404 for (plugin_i
= 0; plugin_i
< plugin_set
->plugins
->len
;
406 bt_plugin_set_add_plugin((void *) *plugin_set_out
,
407 plugin_set
->plugins
->pdata
[plugin_i
]);
411 if (find_in_static
) {
412 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
413 status
= bt_plugin_find_all_from_static(fail_on_load_error
,
416 BT_ASSERT(!plugin_set
);
418 } else if (status
== BT_FUNC_STATUS_NOT_FOUND
) {
419 BT_ASSERT(!plugin_set
);
420 BT_LOGI_STR("No plugins found in built-in plugins.");
424 BT_ASSERT(status
== BT_FUNC_STATUS_OK
);
425 BT_ASSERT(plugin_set
);
426 BT_LOGI("Found built-in plugins: count=%u",
427 plugin_set
->plugins
->len
);
429 for (plugin_i
= 0; plugin_i
< plugin_set
->plugins
->len
;
431 bt_plugin_set_add_plugin((void *) *plugin_set_out
,
432 plugin_set
->plugins
->pdata
[plugin_i
]);
437 free(home_plugin_dir
);
438 bt_object_put_ref(plugin_set
);
441 g_ptr_array_free(dirs
, TRUE
);
445 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
447 BT_ASSERT(*plugin_set_out
);
449 if ((*plugin_set_out
)->plugins
->len
> 0) {
450 BT_LOGI("Found plugins in standard directories and built-in plugins: "
451 "count=%u", (*plugin_set_out
)->plugins
->len
);
452 status
= BT_FUNC_STATUS_OK
;
454 BT_LOGI_STR("No plugins found in standard directories and built-in plugins.");
455 status
= BT_FUNC_STATUS_NOT_FOUND
;
456 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
463 enum bt_plugin_find_status
bt_plugin_find(const char *plugin_name
,
464 bt_bool find_in_std_env_var
, bt_bool find_in_user_dir
,
465 bt_bool find_in_sys_dir
, bt_bool find_in_static
,
466 bt_bool fail_on_load_error
, const struct bt_plugin
**plugin_out
)
468 enum bt_plugin_find_status status
;
469 const struct bt_plugin_set
*plugin_set
= NULL
;
472 BT_ASSERT_PRE_NO_ERROR();
473 BT_ASSERT_PRE_NON_NULL(plugin_name
, "Name");
474 BT_ASSERT_PRE_NON_NULL(plugin_out
, "Plugin (output)");
475 BT_LOGI("Finding named plugin in standard directories and built-in plugins: "
476 "name=\"%s\", find-in-std-env-var=%d, find-in-user-dir=%d, "
477 "find-in-sys-dir=%d, find-in-static=%d",
478 plugin_name
, find_in_std_env_var
, find_in_user_dir
,
479 find_in_sys_dir
, find_in_static
);
480 status
= (enum bt_plugin_find_status
) bt_plugin_find_all(find_in_std_env_var
, find_in_user_dir
,
481 find_in_sys_dir
, find_in_static
, fail_on_load_error
,
483 if (status
!= BT_FUNC_STATUS_OK
) {
484 BT_ASSERT(!plugin_set
);
488 BT_ASSERT(plugin_set
);
490 for (i
= 0; i
< plugin_set
->plugins
->len
; i
++) {
491 const struct bt_plugin
*plugin
= plugin_set
->plugins
->pdata
[i
];
493 if (strcmp(plugin
->info
.name
->str
, plugin_name
) == 0) {
494 *plugin_out
= plugin
;
495 bt_object_get_ref_no_null_check(*plugin_out
);
500 status
= BT_FUNC_STATUS_NOT_FOUND
;
503 if (status
== BT_FUNC_STATUS_OK
) {
504 BT_ASSERT(*plugin_out
);
505 BT_LIB_LOGI("Found plugin in standard directories and built-in plugins: "
506 "%!+l", *plugin_out
);
507 } else if (status
== BT_FUNC_STATUS_NOT_FOUND
) {
508 BT_LOGI("No plugin found in standard directories and built-in plugins: "
509 "name=\"%s\"", plugin_name
);
512 bt_plugin_set_put_ref(plugin_set
);
518 pthread_mutex_t lock
;
519 struct bt_plugin_set
*plugin_set
;
521 bool fail_on_load_error
;
523 } append_all_from_dir_info
= {
524 .lock
= PTHREAD_MUTEX_INITIALIZER
528 int nftw_append_all_from_dir(const char *file
,
529 const struct stat
*sb
, int flag
, struct FTW
*s
)
532 const char *name
= file
+ s
->base
;
534 /* Check for recursion */
535 if (!append_all_from_dir_info
.recurse
&& s
->level
> 1) {
542 const struct bt_plugin_set
*plugins_from_file
= NULL
;
544 if (name
[0] == '.') {
545 /* Skip hidden files */
546 BT_LOGI("Skipping hidden file: path=\"%s\"", file
);
550 append_all_from_dir_info
.status
=
551 bt_plugin_find_all_from_file(file
,
552 append_all_from_dir_info
.fail_on_load_error
,
554 if (append_all_from_dir_info
.status
== BT_FUNC_STATUS_OK
) {
557 BT_ASSERT(plugins_from_file
);
559 for (j
= 0; j
< plugins_from_file
->plugins
->len
; j
++) {
560 struct bt_plugin
*plugin
=
561 g_ptr_array_index(plugins_from_file
->plugins
, j
);
563 BT_LIB_LOGI("Adding plugin to plugin set: "
564 "plugin-path=\"%s\", %![plugin-]+l",
566 bt_plugin_set_add_plugin(
567 append_all_from_dir_info
.plugin_set
,
571 bt_object_put_ref(plugins_from_file
);
573 } else if (append_all_from_dir_info
.status
< 0) {
574 /* bt_plugin_find_all_from_file() logs errors */
575 BT_ASSERT(!plugins_from_file
);
581 * Not found in this file: this is no an error; continue
582 * walking the directories.
584 BT_ASSERT(!plugins_from_file
);
585 BT_ASSERT(append_all_from_dir_info
.status
==
586 BT_FUNC_STATUS_NOT_FOUND
);
590 /* Continue to next file / directory. */
591 BT_LOGI("Cannot enter directory: continuing: path=\"%s\"", file
);
594 /* Continue to next file / directory. */
595 BT_LOGI("Cannot get file information: continuing: path=\"%s\"", file
);
604 int bt_plugin_create_append_all_from_dir(struct bt_plugin_set
*plugin_set
,
605 const char *path
, bt_bool recurse
, bt_bool fail_on_load_error
)
607 int nftw_flags
= FTW_PHYS
;
612 BT_ASSERT(plugin_set
);
614 BT_ASSERT(strlen(path
) < PATH_MAX
);
617 * Make sure that path exists and is accessible.
618 * This is necessary since Cygwin implementation of nftw() is not POSIX
619 * compliant. Cygwin nftw() implementation does not fail on non-existent
620 * path with ENOENT. Instead, it flags the directory as FTW_NS. FTW_NS during
621 * nftw_append_all_from_dir is not treated as an error since we are
622 * traversing the tree for plugin discovery.
624 if (stat(path
, &sb
)) {
625 BT_LOGW_ERRNO("Cannot open directory",
626 ": path=\"%s\", recurse=%d",
628 (void) BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_UNKNOWN(
629 BT_LIB_LOG_LIBBABELTRACE2_NAME
,
630 "Cannot open directory: path=\"%s\", recurse=%d",
632 status
= BT_FUNC_STATUS_ERROR
;
636 pthread_mutex_lock(&append_all_from_dir_info
.lock
);
637 append_all_from_dir_info
.plugin_set
= plugin_set
;
638 append_all_from_dir_info
.recurse
= recurse
;
639 append_all_from_dir_info
.status
= BT_FUNC_STATUS_OK
;
640 append_all_from_dir_info
.fail_on_load_error
= fail_on_load_error
;
641 ret
= nftw(path
, nftw_append_all_from_dir
,
642 APPEND_ALL_FROM_DIR_NFDOPEN_MAX
, nftw_flags
);
643 append_all_from_dir_info
.plugin_set
= NULL
;
644 status
= append_all_from_dir_info
.status
;
645 pthread_mutex_unlock(&append_all_from_dir_info
.lock
);
647 BT_LIB_LOGW_APPEND_CAUSE("Failed to walk directory",
648 ": path=\"%s\", recurse=%d",
650 status
= BT_FUNC_STATUS_ERROR
;
654 if (status
== BT_FUNC_STATUS_NOT_FOUND
) {
656 * We're just appending in this function; even if
657 * nothing was found, it's still okay from the caller's
660 status
= BT_FUNC_STATUS_OK
;
667 enum bt_plugin_find_all_from_dir_status
bt_plugin_find_all_from_dir(
668 const char *path
, bt_bool recurse
, bt_bool fail_on_load_error
,
669 const struct bt_plugin_set
**plugin_set_out
)
671 enum bt_plugin_find_all_from_dir_status status
=
674 BT_ASSERT_PRE_NO_ERROR();
675 BT_ASSERT_PRE_NON_NULL(plugin_set_out
, "Plugin set (output)");
676 BT_LOGI("Creating all plugins in directory: path=\"%s\", recurse=%d",
678 *plugin_set_out
= bt_plugin_set_create();
679 if (!*plugin_set_out
) {
680 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set.");
681 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
686 * Append found plugins to array (never returns
687 * `BT_FUNC_STATUS_NOT_FOUND`)
689 status
= bt_plugin_create_append_all_from_dir((void *) *plugin_set_out
,
690 path
, recurse
, fail_on_load_error
);
693 * bt_plugin_create_append_all_from_dir() handles
694 * `fail_on_load_error`, so this is a "real" error.
696 BT_LIB_LOGE_APPEND_CAUSE(
697 "Cannot append plugins found in directory: "
698 "path=\"%s\", status=%s",
699 path
, bt_common_func_status_string(status
));
703 BT_ASSERT(status
== BT_FUNC_STATUS_OK
);
705 if ((*plugin_set_out
)->plugins
->len
== 0) {
706 /* Nothing was appended: not found */
707 BT_LOGI("No plugins found in directory: path=\"%s\"", path
);
708 status
= BT_FUNC_STATUS_NOT_FOUND
;
712 BT_LOGI("Created %u plugins from directory: count=%u, path=\"%s\"",
713 (*plugin_set_out
)->plugins
->len
,
714 (*plugin_set_out
)->plugins
->len
, path
);
718 BT_ASSERT(status
!= BT_FUNC_STATUS_OK
);
719 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
725 const char *bt_plugin_get_name(const struct bt_plugin
*plugin
)
727 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
728 return plugin
->info
.name_set
? plugin
->info
.name
->str
: NULL
;
731 const char *bt_plugin_get_author(const struct bt_plugin
*plugin
)
733 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
734 return plugin
->info
.author_set
? plugin
->info
.author
->str
: NULL
;
737 const char *bt_plugin_get_license(const struct bt_plugin
*plugin
)
739 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
740 return plugin
->info
.license_set
? plugin
->info
.license
->str
: NULL
;
743 const char *bt_plugin_get_path(const struct bt_plugin
*plugin
)
745 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
746 return plugin
->info
.path_set
? plugin
->info
.path
->str
: NULL
;
749 const char *bt_plugin_get_description(const struct bt_plugin
*plugin
)
751 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
752 return plugin
->info
.description_set
?
753 plugin
->info
.description
->str
: NULL
;
756 enum bt_property_availability
bt_plugin_get_version(const struct bt_plugin
*plugin
,
757 unsigned int *major
, unsigned int *minor
, unsigned int *patch
,
760 enum bt_property_availability avail
=
761 BT_PROPERTY_AVAILABILITY_AVAILABLE
;
763 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
765 if (!plugin
->info
.version_set
) {
766 BT_LIB_LOGD("Plugin's version is not set: %!+l", plugin
);
767 avail
= BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
772 *major
= plugin
->info
.version
.major
;
776 *minor
= plugin
->info
.version
.minor
;
780 *patch
= plugin
->info
.version
.patch
;
784 *extra
= plugin
->info
.version
.extra
->str
;
791 uint64_t bt_plugin_get_source_component_class_count(const struct bt_plugin
*plugin
)
793 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
794 return (uint64_t) plugin
->src_comp_classes
->len
;
797 uint64_t bt_plugin_get_filter_component_class_count(const struct bt_plugin
*plugin
)
799 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
800 return (uint64_t) plugin
->flt_comp_classes
->len
;
803 uint64_t bt_plugin_get_sink_component_class_count(const struct bt_plugin
*plugin
)
805 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
806 return (uint64_t) plugin
->sink_comp_classes
->len
;
810 struct bt_component_class
*borrow_component_class_by_index(
811 const struct bt_plugin
*plugin
, GPtrArray
*comp_classes
,
814 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
815 BT_ASSERT_PRE_DEV_VALID_INDEX(index
, comp_classes
->len
);
816 return g_ptr_array_index(comp_classes
, index
);
819 const struct bt_component_class_source
*
820 bt_plugin_borrow_source_component_class_by_index_const(
821 const struct bt_plugin
*plugin
, uint64_t index
)
823 return (const void *) borrow_component_class_by_index(plugin
,
824 plugin
->src_comp_classes
, index
);
827 const struct bt_component_class_filter
*
828 bt_plugin_borrow_filter_component_class_by_index_const(
829 const struct bt_plugin
*plugin
, uint64_t index
)
831 return (const void *) borrow_component_class_by_index(plugin
,
832 plugin
->flt_comp_classes
, index
);
835 const struct bt_component_class_sink
*
836 bt_plugin_borrow_sink_component_class_by_index_const(
837 const struct bt_plugin
*plugin
, uint64_t index
)
839 return (const void *) borrow_component_class_by_index(plugin
,
840 plugin
->sink_comp_classes
, index
);
844 struct bt_component_class
*borrow_component_class_by_name(
845 const struct bt_plugin
*plugin
, GPtrArray
*comp_classes
,
848 struct bt_component_class
*comp_class
= NULL
;
851 BT_ASSERT_PRE_DEV_NON_NULL(plugin
, "Plugin");
852 BT_ASSERT_PRE_DEV_NON_NULL(name
, "Name");
854 for (i
= 0; i
< comp_classes
->len
; i
++) {
855 struct bt_component_class
*comp_class_candidate
=
856 g_ptr_array_index(comp_classes
, i
);
857 const char *comp_class_cand_name
=
858 bt_component_class_get_name(comp_class_candidate
);
860 BT_ASSERT_DBG(comp_class_cand_name
);
862 if (strcmp(name
, comp_class_cand_name
) == 0) {
863 comp_class
= comp_class_candidate
;
871 const struct bt_component_class_source
*
872 bt_plugin_borrow_source_component_class_by_name_const(
873 const struct bt_plugin
*plugin
, const char *name
)
875 return (const void *) borrow_component_class_by_name(plugin
,
876 plugin
->src_comp_classes
, name
);
879 const struct bt_component_class_filter
*
880 bt_plugin_borrow_filter_component_class_by_name_const(
881 const struct bt_plugin
*plugin
, const char *name
)
883 return (const void *) borrow_component_class_by_name(plugin
,
884 plugin
->flt_comp_classes
, name
);
887 const struct bt_component_class_sink
*
888 bt_plugin_borrow_sink_component_class_by_name_const(
889 const struct bt_plugin
*plugin
, const char *name
)
891 return (const void *) borrow_component_class_by_name(plugin
,
892 plugin
->sink_comp_classes
, name
);
895 void bt_plugin_get_ref(const struct bt_plugin
*plugin
)
897 bt_object_get_ref(plugin
);
900 void bt_plugin_put_ref(const struct bt_plugin
*plugin
)
902 bt_object_put_ref(plugin
);
905 void bt_plugin_set_get_ref(const struct bt_plugin_set
*plugin_set
)
907 bt_object_get_ref(plugin_set
);
910 void bt_plugin_set_put_ref(const struct bt_plugin_set
*plugin_set
)
912 bt_object_put_ref(plugin_set
);