2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #define BT_LOG_TAG "LIB/PLUGIN-SO"
9 #include "lib/logging.h"
11 #include "common/assert.h"
12 #include "compat/compiler.h"
13 #include <babeltrace2/plugin/plugin-dev.h>
14 #include "lib/graph/component-class.h"
15 #include <babeltrace2/graph/component-class.h>
16 #include <babeltrace2/types.h>
17 #include "common/list.h"
25 #include "plugin-so.h"
26 #include "lib/func-status.h"
27 #include "common/common.h"
29 #define NATIVE_PLUGIN_SUFFIX "." G_MODULE_SUFFIX
30 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
31 #define LIBTOOL_PLUGIN_SUFFIX ".la"
32 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
34 #define PLUGIN_SUFFIX_LEN bt_max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
35 sizeof(LIBTOOL_PLUGIN_SUFFIX))
40 * This list, global to the library, keeps all component classes that
41 * have a reference to their shared library handles. It allows iteration
42 * on all component classes still present when the destructor executes
43 * to release the shared library handle references they might still have.
45 * The list items are the component classes created with
46 * bt_plugin_add_component_class(). They keep the shared library handle
47 * object created by their plugin alive so that the plugin's code is
48 * not discarded when it could still be in use by living components
49 * created from those component classes:
51 * [component] --ref-> [component class]-> [shlib handle]
53 * It allows this use-case:
55 * my_plugins = bt_plugin_find_all_from_file("/path/to/my-plugin.so");
56 * // instantiate components from a plugin's component classes
57 * // put plugins and free my_plugins here
58 * // user code of instantiated components still exists
60 * An entry is removed from this list when a component class is
61 * destroyed thanks to a custom destroy listener. When the entry is
62 * removed, the entry is removed from the list, and we release the
63 * reference on the shlib handle. Assuming the original plugin object
64 * which contained some component classes is put first, when the last
65 * component class is removed from this list, the shared library handle
66 * object's reference count falls to zero and the shared library is
69 * We're not using a GLib linked list here because this destructor is
70 * called after GLib's thread-specific data is destroyed, which contains
71 * the allocated memory for GLib data structures (what's used by
76 BT_LIST_HEAD(component_class_list
);
78 __attribute__((destructor
)) static
79 void fini_comp_class_list(void)
81 struct bt_component_class
*comp_class
, *tmp
;
83 bt_list_for_each_entry_safe(comp_class
, tmp
, &component_class_list
, node
) {
84 bt_list_del(&comp_class
->node
);
85 BT_OBJECT_PUT_REF_AND_RESET(comp_class
->so_handle
);
88 BT_LOGD_STR("Released references from all component classes to shared library handles.");
92 void bt_plugin_so_shared_lib_handle_destroy(struct bt_object
*obj
)
94 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
;
97 shared_lib_handle
= container_of(obj
,
98 struct bt_plugin_so_shared_lib_handle
, base
);
99 const char *path
= shared_lib_handle
->path
?
100 shared_lib_handle
->path
->str
: NULL
;
102 BT_LOGI("Destroying shared library handle: addr=%p, path=\"%s\"",
103 shared_lib_handle
, path
);
105 if (shared_lib_handle
->init_called
&& shared_lib_handle
->exit
) {
106 BT_LOGD_STR("Calling user's plugin exit function.");
107 shared_lib_handle
->exit();
108 BT_LOGD_STR("User function returned.");
111 if (shared_lib_handle
->module
) {
114 * Valgrind shows incomplete stack traces when
115 * dynamically loaded libraries are closed before it
116 * finishes. Use the LIBBABELTRACE2_NO_DLCLOSE in a debug
117 * build to avoid this.
119 const char *var
= getenv("LIBBABELTRACE2_NO_DLCLOSE");
121 if (!var
|| strcmp(var
, "1") != 0) {
123 BT_LOGI("Closing GModule: path=\"%s\"", path
);
125 if (!g_module_close(shared_lib_handle
->module
)) {
127 * Just log here: we're in a destructor,
128 * so we cannot append an error cause
129 * (there's no returned status).
131 BT_LOGE("Cannot close GModule: %s: path=\"%s\"",
132 g_module_error(), path
);
135 shared_lib_handle
->module
= NULL
;
138 BT_LOGI("Not closing GModule because `LIBBABELTRACE2_NO_DLCLOSE=1`: "
139 "path=\"%s\"", path
);
144 if (shared_lib_handle
->path
) {
145 g_string_free(shared_lib_handle
->path
, TRUE
);
146 shared_lib_handle
->path
= NULL
;
149 g_free(shared_lib_handle
);
153 int bt_plugin_so_shared_lib_handle_create(
155 struct bt_plugin_so_shared_lib_handle
**shared_lib_handle
)
157 int status
= BT_FUNC_STATUS_OK
;
159 BT_ASSERT(shared_lib_handle
);
160 BT_LOGI("Creating shared library handle: path=\"%s\"", path
? path
: "(null)");
161 *shared_lib_handle
= g_new0(struct bt_plugin_so_shared_lib_handle
, 1);
162 if (!*shared_lib_handle
) {
163 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one shared library handle.");
164 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
168 bt_object_init_shared(&(*shared_lib_handle
)->base
,
169 bt_plugin_so_shared_lib_handle_destroy
);
175 (*shared_lib_handle
)->path
= g_string_new(path
);
176 if (!(*shared_lib_handle
)->path
) {
177 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
178 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
182 (*shared_lib_handle
)->module
= g_module_open(path
, G_MODULE_BIND_LOCAL
);
183 if (!(*shared_lib_handle
)->module
) {
185 * INFO-level logging because we're only _trying_ to
186 * open this file as a Babeltrace plugin: if it's not,
187 * it's not an error. And because this can be tried
188 * during bt_plugin_find_all_from_dir(), it's not even a
191 BT_LOGI("Cannot open GModule: %s: path=\"%s\"",
192 g_module_error(), path
);
193 BT_OBJECT_PUT_REF_AND_RESET(*shared_lib_handle
);
194 status
= BT_FUNC_STATUS_NOT_FOUND
;
201 BT_ASSERT(*shared_lib_handle
|| status
!= BT_FUNC_STATUS_OK
);
202 if (*shared_lib_handle
) {
203 BT_LOGI("Created shared library handle: path=\"%s\", addr=%p",
204 path
? path
: "(null)", *shared_lib_handle
);
211 void bt_plugin_so_destroy_spec_data(struct bt_plugin
*plugin
)
213 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
215 if (!plugin
->spec_data
) {
219 BT_ASSERT(plugin
->type
== BT_PLUGIN_TYPE_SO
);
221 BT_OBJECT_PUT_REF_AND_RESET(spec
->shared_lib_handle
);
222 g_free(plugin
->spec_data
);
223 plugin
->spec_data
= NULL
;
227 * This function does the following:
229 * 1. Iterate on the plugin descriptor attributes section and set the
230 * plugin's attributes depending on the attribute types. This
231 * includes the name of the plugin, its description, and its
232 * initialization function, for example.
234 * 2. Iterate on the component class descriptors section and create one
235 * "full descriptor" (temporary structure) for each one that is found
236 * and attached to our plugin descriptor.
238 * 3. Iterate on the component class descriptor attributes section and
239 * set the corresponding full descriptor's attributes depending on
240 * the attribute types. This includes the description of the
241 * component class, as well as its initialization and destroy
244 * 4. Call the user's plugin initialization function, if any is
247 * 5. For each full component class descriptor, create a component class
248 * object, set its optional attributes, and add it to the plugin
251 * 6. Freeze the plugin object.
254 int bt_plugin_so_init(struct bt_plugin
*plugin
,
255 bool fail_on_load_error
,
256 const struct __bt_plugin_descriptor
*descriptor
,
257 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
258 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
259 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
260 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
261 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
262 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
)
265 * This structure's members point to the plugin's memory
268 struct comp_class_full_descriptor
{
269 const struct __bt_plugin_component_class_descriptor
*descriptor
;
270 const char *description
;
275 bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions
;
276 bt_component_class_source_initialize_method init
;
277 bt_component_class_source_finalize_method finalize
;
278 bt_component_class_source_query_method query
;
279 bt_component_class_source_output_port_connected_method output_port_connected
;
280 bt_message_iterator_class_initialize_method msg_iter_initialize
;
281 bt_message_iterator_class_finalize_method msg_iter_finalize
;
282 bt_message_iterator_class_seek_ns_from_origin_method msg_iter_seek_ns_from_origin
;
283 bt_message_iterator_class_seek_beginning_method msg_iter_seek_beginning
;
284 bt_message_iterator_class_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin
;
285 bt_message_iterator_class_can_seek_beginning_method msg_iter_can_seek_beginning
;
289 bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions
;
290 bt_component_class_filter_initialize_method init
;
291 bt_component_class_filter_finalize_method finalize
;
292 bt_component_class_filter_query_method query
;
293 bt_component_class_filter_input_port_connected_method input_port_connected
;
294 bt_component_class_filter_output_port_connected_method output_port_connected
;
295 bt_message_iterator_class_initialize_method msg_iter_initialize
;
296 bt_message_iterator_class_finalize_method msg_iter_finalize
;
297 bt_message_iterator_class_seek_ns_from_origin_method msg_iter_seek_ns_from_origin
;
298 bt_message_iterator_class_seek_beginning_method msg_iter_seek_beginning
;
299 bt_message_iterator_class_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin
;
300 bt_message_iterator_class_can_seek_beginning_method msg_iter_can_seek_beginning
;
304 bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions
;
305 bt_component_class_sink_initialize_method init
;
306 bt_component_class_sink_finalize_method finalize
;
307 bt_component_class_sink_query_method query
;
308 bt_component_class_sink_input_port_connected_method input_port_connected
;
309 bt_component_class_sink_graph_is_configured_method graph_is_configured
;
314 int status
= BT_FUNC_STATUS_OK
;
315 struct __bt_plugin_descriptor_attribute
const * const *cur_attr_ptr
;
316 struct __bt_plugin_component_class_descriptor
const * const *cur_cc_descr_ptr
;
317 struct __bt_plugin_component_class_descriptor_attribute
const * const *cur_cc_descr_attr_ptr
;
318 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
319 GArray
*comp_class_full_descriptors
;
322 struct bt_message_iterator_class
*msg_iter_class
= NULL
;
324 BT_LOGI("Initializing plugin object from descriptors found in sections: "
325 "plugin-addr=%p, plugin-path=\"%s\", "
326 "attrs-begin-addr=%p, attrs-end-addr=%p, "
327 "cc-descr-begin-addr=%p, cc-descr-end-addr=%p, "
328 "cc-descr-attrs-begin-addr=%p, cc-descr-attrs-end-addr=%p",
330 spec
->shared_lib_handle
->path
?
331 spec
->shared_lib_handle
->path
->str
: NULL
,
332 attrs_begin
, attrs_end
,
333 cc_descriptors_begin
, cc_descriptors_end
,
334 cc_descr_attrs_begin
, cc_descr_attrs_end
);
335 comp_class_full_descriptors
= g_array_new(FALSE
, TRUE
,
336 sizeof(struct comp_class_full_descriptor
));
337 if (!comp_class_full_descriptors
) {
338 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
339 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
343 /* Set mandatory attributes */
344 spec
->descriptor
= descriptor
;
345 bt_plugin_set_name(plugin
, descriptor
->name
);
348 * Find and set optional attributes attached to this plugin
351 for (cur_attr_ptr
= attrs_begin
; cur_attr_ptr
!= attrs_end
; cur_attr_ptr
++) {
352 const struct __bt_plugin_descriptor_attribute
*cur_attr
=
359 if (cur_attr
->plugin_descriptor
!= descriptor
) {
363 switch (cur_attr
->type
) {
364 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_INIT
:
365 spec
->init
= cur_attr
->value
.init
;
367 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT
:
368 spec
->shared_lib_handle
->exit
= cur_attr
->value
.exit
;
370 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_AUTHOR
:
371 bt_plugin_set_author(plugin
, cur_attr
->value
.author
);
373 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_LICENSE
:
374 bt_plugin_set_license(plugin
, cur_attr
->value
.license
);
376 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
377 bt_plugin_set_description(plugin
, cur_attr
->value
.description
);
379 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_VERSION
:
380 bt_plugin_set_version(plugin
,
381 (unsigned int) cur_attr
->value
.version
.major
,
382 (unsigned int) cur_attr
->value
.version
.minor
,
383 (unsigned int) cur_attr
->value
.version
.patch
,
384 cur_attr
->value
.version
.extra
);
387 if (fail_on_load_error
) {
388 BT_LIB_LOGW_APPEND_CAUSE(
389 "Unknown plugin descriptor attribute: "
390 "plugin-path=\"%s\", plugin-name=\"%s\", "
391 "attr-type-name=\"%s\", attr-type-id=%d",
392 spec
->shared_lib_handle
->path
?
393 spec
->shared_lib_handle
->path
->str
:
395 descriptor
->name
, cur_attr
->type_name
,
397 status
= BT_FUNC_STATUS_ERROR
;
401 "Ignoring unknown plugin descriptor attribute: "
402 "plugin-path=\"%s\", plugin-name=\"%s\", "
403 "attr-type-name=\"%s\", attr-type-id=%d",
404 spec
->shared_lib_handle
->path
?
405 spec
->shared_lib_handle
->path
->str
:
407 descriptor
->name
, cur_attr
->type_name
,
416 * Find component class descriptors attached to this plugin
417 * descriptor and initialize corresponding full component class
418 * descriptors in the array.
420 for (cur_cc_descr_ptr
= cc_descriptors_begin
; cur_cc_descr_ptr
!= cc_descriptors_end
; cur_cc_descr_ptr
++) {
421 const struct __bt_plugin_component_class_descriptor
*cur_cc_descr
=
423 struct comp_class_full_descriptor full_descriptor
= {0};
429 if (cur_cc_descr
->plugin_descriptor
!= descriptor
) {
433 full_descriptor
.descriptor
= cur_cc_descr
;
434 g_array_append_val(comp_class_full_descriptors
,
439 * Find component class descriptor attributes attached to this
440 * plugin descriptor and update corresponding full component
441 * class descriptors in the array.
443 for (cur_cc_descr_attr_ptr
= cc_descr_attrs_begin
; cur_cc_descr_attr_ptr
!= cc_descr_attrs_end
; cur_cc_descr_attr_ptr
++) {
444 const struct __bt_plugin_component_class_descriptor_attribute
*cur_cc_descr_attr
=
445 *cur_cc_descr_attr_ptr
;
446 enum bt_component_class_type cc_type
;
448 if (!cur_cc_descr_attr
) {
452 if (cur_cc_descr_attr
->comp_class_descriptor
->plugin_descriptor
!=
457 cc_type
= cur_cc_descr_attr
->comp_class_descriptor
->type
;
459 /* Find the corresponding component class descriptor entry */
460 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
461 struct comp_class_full_descriptor
*cc_full_descr
=
462 &bt_g_array_index(comp_class_full_descriptors
,
463 struct comp_class_full_descriptor
, i
);
465 if (cur_cc_descr_attr
->comp_class_descriptor
!=
466 cc_full_descr
->descriptor
) {
470 switch (cur_cc_descr_attr
->type
) {
471 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
472 cc_full_descr
->description
=
473 cur_cc_descr_attr
->value
.description
;
475 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_HELP
:
476 cc_full_descr
->help
=
477 cur_cc_descr_attr
->value
.help
;
479 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_GET_SUPPORTED_MIP_VERSIONS_METHOD
:
481 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
482 cc_full_descr
->methods
.source
.get_supported_mip_versions
=
483 cur_cc_descr_attr
->value
.source_get_supported_mip_versions_method
;
485 case BT_COMPONENT_CLASS_TYPE_FILTER
:
486 cc_full_descr
->methods
.filter
.get_supported_mip_versions
=
487 cur_cc_descr_attr
->value
.filter_get_supported_mip_versions_method
;
489 case BT_COMPONENT_CLASS_TYPE_SINK
:
490 cc_full_descr
->methods
.sink
.get_supported_mip_versions
=
491 cur_cc_descr_attr
->value
.sink_get_supported_mip_versions_method
;
497 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INITIALIZE_METHOD
:
499 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
500 cc_full_descr
->methods
.source
.init
=
501 cur_cc_descr_attr
->value
.source_initialize_method
;
503 case BT_COMPONENT_CLASS_TYPE_FILTER
:
504 cc_full_descr
->methods
.filter
.init
=
505 cur_cc_descr_attr
->value
.filter_initialize_method
;
507 case BT_COMPONENT_CLASS_TYPE_SINK
:
508 cc_full_descr
->methods
.sink
.init
=
509 cur_cc_descr_attr
->value
.sink_initialize_method
;
515 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_FINALIZE_METHOD
:
517 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
518 cc_full_descr
->methods
.source
.finalize
=
519 cur_cc_descr_attr
->value
.source_finalize_method
;
521 case BT_COMPONENT_CLASS_TYPE_FILTER
:
522 cc_full_descr
->methods
.filter
.finalize
=
523 cur_cc_descr_attr
->value
.filter_finalize_method
;
525 case BT_COMPONENT_CLASS_TYPE_SINK
:
526 cc_full_descr
->methods
.sink
.finalize
=
527 cur_cc_descr_attr
->value
.sink_finalize_method
;
533 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_QUERY_METHOD
:
535 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
536 cc_full_descr
->methods
.source
.query
=
537 cur_cc_descr_attr
->value
.source_query_method
;
539 case BT_COMPONENT_CLASS_TYPE_FILTER
:
540 cc_full_descr
->methods
.filter
.query
=
541 cur_cc_descr_attr
->value
.filter_query_method
;
543 case BT_COMPONENT_CLASS_TYPE_SINK
:
544 cc_full_descr
->methods
.sink
.query
=
545 cur_cc_descr_attr
->value
.sink_query_method
;
551 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INPUT_PORT_CONNECTED_METHOD
:
553 case BT_COMPONENT_CLASS_TYPE_FILTER
:
554 cc_full_descr
->methods
.filter
.input_port_connected
=
555 cur_cc_descr_attr
->value
.filter_input_port_connected_method
;
557 case BT_COMPONENT_CLASS_TYPE_SINK
:
558 cc_full_descr
->methods
.sink
.input_port_connected
=
559 cur_cc_descr_attr
->value
.sink_input_port_connected_method
;
565 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_OUTPUT_PORT_CONNECTED_METHOD
:
567 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
568 cc_full_descr
->methods
.source
.output_port_connected
=
569 cur_cc_descr_attr
->value
.source_output_port_connected_method
;
571 case BT_COMPONENT_CLASS_TYPE_FILTER
:
572 cc_full_descr
->methods
.filter
.output_port_connected
=
573 cur_cc_descr_attr
->value
.filter_output_port_connected_method
;
579 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_GRAPH_IS_CONFIGURED_METHOD
:
581 case BT_COMPONENT_CLASS_TYPE_SINK
:
582 cc_full_descr
->methods
.sink
.graph_is_configured
=
583 cur_cc_descr_attr
->value
.sink_graph_is_configured_method
;
589 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_INITIALIZE_METHOD
:
591 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
592 cc_full_descr
->methods
.source
.msg_iter_initialize
=
593 cur_cc_descr_attr
->value
.msg_iter_initialize_method
;
595 case BT_COMPONENT_CLASS_TYPE_FILTER
:
596 cc_full_descr
->methods
.filter
.msg_iter_initialize
=
597 cur_cc_descr_attr
->value
.msg_iter_initialize_method
;
603 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_FINALIZE_METHOD
:
605 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
606 cc_full_descr
->methods
.source
.msg_iter_finalize
=
607 cur_cc_descr_attr
->value
.msg_iter_finalize_method
;
609 case BT_COMPONENT_CLASS_TYPE_FILTER
:
610 cc_full_descr
->methods
.filter
.msg_iter_finalize
=
611 cur_cc_descr_attr
->value
.msg_iter_finalize_method
;
617 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_SEEK_NS_FROM_ORIGIN_METHOD
:
619 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
620 cc_full_descr
->methods
.source
.msg_iter_seek_ns_from_origin
=
621 cur_cc_descr_attr
->value
.msg_iter_seek_ns_from_origin_method
;
623 case BT_COMPONENT_CLASS_TYPE_FILTER
:
624 cc_full_descr
->methods
.filter
.msg_iter_seek_ns_from_origin
=
625 cur_cc_descr_attr
->value
.msg_iter_seek_ns_from_origin_method
;
631 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_SEEK_BEGINNING_METHOD
:
633 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
634 cc_full_descr
->methods
.source
.msg_iter_seek_beginning
=
635 cur_cc_descr_attr
->value
.msg_iter_seek_beginning_method
;
637 case BT_COMPONENT_CLASS_TYPE_FILTER
:
638 cc_full_descr
->methods
.filter
.msg_iter_seek_beginning
=
639 cur_cc_descr_attr
->value
.msg_iter_seek_beginning_method
;
645 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_CAN_SEEK_NS_FROM_ORIGIN_METHOD
:
647 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
648 cc_full_descr
->methods
.source
.msg_iter_can_seek_ns_from_origin
=
649 cur_cc_descr_attr
->value
.msg_iter_can_seek_ns_from_origin_method
;
651 case BT_COMPONENT_CLASS_TYPE_FILTER
:
652 cc_full_descr
->methods
.filter
.msg_iter_can_seek_ns_from_origin
=
653 cur_cc_descr_attr
->value
.msg_iter_can_seek_ns_from_origin_method
;
659 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_CAN_SEEK_BEGINNING_METHOD
:
661 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
662 cc_full_descr
->methods
.source
.msg_iter_can_seek_beginning
=
663 cur_cc_descr_attr
->value
.msg_iter_can_seek_beginning_method
;
665 case BT_COMPONENT_CLASS_TYPE_FILTER
:
666 cc_full_descr
->methods
.filter
.msg_iter_can_seek_beginning
=
667 cur_cc_descr_attr
->value
.msg_iter_can_seek_beginning_method
;
674 if (fail_on_load_error
) {
675 BT_LIB_LOGW_APPEND_CAUSE(
676 "Unknown component class descriptor attribute: "
677 "plugin-path=\"%s\", "
678 "plugin-name=\"%s\", "
679 "comp-class-name=\"%s\", "
680 "comp-class-type=%s, "
681 "attr-type-name=\"%s\", "
683 spec
->shared_lib_handle
->path
?
684 spec
->shared_lib_handle
->path
->str
:
687 cur_cc_descr_attr
->comp_class_descriptor
->name
,
688 bt_common_component_class_type_string(
689 cur_cc_descr_attr
->comp_class_descriptor
->type
),
690 cur_cc_descr_attr
->type_name
,
691 cur_cc_descr_attr
->type
);
692 status
= BT_FUNC_STATUS_ERROR
;
696 "Ignoring unknown component class descriptor attribute: "
697 "plugin-path=\"%s\", "
698 "plugin-name=\"%s\", "
699 "comp-class-name=\"%s\", "
700 "comp-class-type=%s, "
701 "attr-type-name=\"%s\", "
703 spec
->shared_lib_handle
->path
?
704 spec
->shared_lib_handle
->path
->str
:
707 cur_cc_descr_attr
->comp_class_descriptor
->name
,
708 bt_common_component_class_type_string(
709 cur_cc_descr_attr
->comp_class_descriptor
->type
),
710 cur_cc_descr_attr
->type_name
,
711 cur_cc_descr_attr
->type
);
719 /* Initialize plugin */
721 enum bt_plugin_initialize_func_status init_status
;
723 BT_LOGD_STR("Calling user's plugin initialization function.");
724 init_status
= spec
->init((void *) plugin
);
725 BT_LOGD("User function returned: status=%s",
726 bt_common_func_status_string(init_status
));
728 if (init_status
< 0) {
729 if (fail_on_load_error
) {
730 BT_LIB_LOGW_APPEND_CAUSE(
731 "User's plugin initialization function failed: "
733 bt_common_func_status_string(init_status
));
734 status
= init_status
;
738 * Since we don't return an error,
739 * there's no way to communicate this
740 * error to the caller.
742 bt_current_thread_clear_error();
744 "User's plugin initialization function failed: "
746 bt_common_func_status_string(init_status
));
747 status
= BT_FUNC_STATUS_NOT_FOUND
;
754 spec
->shared_lib_handle
->init_called
= BT_TRUE
;
756 /* Add described component classes to plugin */
757 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
758 struct comp_class_full_descriptor
*cc_full_descr
=
759 &bt_g_array_index(comp_class_full_descriptors
,
760 struct comp_class_full_descriptor
, i
);
761 struct bt_component_class
*comp_class
= NULL
;
762 struct bt_component_class_source
*src_comp_class
= NULL
;
763 struct bt_component_class_filter
*flt_comp_class
= NULL
;
764 struct bt_component_class_sink
*sink_comp_class
= NULL
;
766 BT_LOGI("Creating and setting properties of plugin's component class: "
767 "plugin-path=\"%s\", plugin-name=\"%s\", "
768 "comp-class-name=\"%s\", comp-class-type=%s",
769 spec
->shared_lib_handle
->path
?
770 spec
->shared_lib_handle
->path
->str
:
773 cc_full_descr
->descriptor
->name
,
774 bt_common_component_class_type_string(
775 cc_full_descr
->descriptor
->type
));
777 if (cc_full_descr
->descriptor
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
||
778 cc_full_descr
->descriptor
->type
== BT_COMPONENT_CLASS_TYPE_FILTER
) {
779 bt_message_iterator_class_next_method next_method
;
780 bt_message_iterator_class_initialize_method init_method
;
781 bt_message_iterator_class_finalize_method fini_method
;
782 bt_message_iterator_class_seek_ns_from_origin_method seek_ns_from_origin_method
;
783 bt_message_iterator_class_seek_beginning_method seek_beginning_method
;
784 bt_message_iterator_class_can_seek_ns_from_origin_method can_seek_ns_from_origin_method
;
785 bt_message_iterator_class_can_seek_beginning_method can_seek_beginning_method
;
787 if (cc_full_descr
->descriptor
->type
== BT_COMPONENT_CLASS_TYPE_SOURCE
) {
788 next_method
= cc_full_descr
->descriptor
->methods
.source
.msg_iter_next
;
789 init_method
= cc_full_descr
->methods
.source
.msg_iter_initialize
;
790 fini_method
= cc_full_descr
->methods
.source
.msg_iter_finalize
;
791 seek_ns_from_origin_method
= cc_full_descr
->methods
.source
.msg_iter_seek_ns_from_origin
;
792 can_seek_ns_from_origin_method
= cc_full_descr
->methods
.source
.msg_iter_can_seek_ns_from_origin
;
793 seek_beginning_method
= cc_full_descr
->methods
.source
.msg_iter_seek_beginning
;
794 can_seek_beginning_method
= cc_full_descr
->methods
.source
.msg_iter_can_seek_beginning
;
796 next_method
= cc_full_descr
->descriptor
->methods
.filter
.msg_iter_next
;
797 init_method
= cc_full_descr
->methods
.filter
.msg_iter_initialize
;
798 fini_method
= cc_full_descr
->methods
.filter
.msg_iter_finalize
;
799 seek_ns_from_origin_method
= cc_full_descr
->methods
.filter
.msg_iter_seek_ns_from_origin
;
800 can_seek_ns_from_origin_method
= cc_full_descr
->methods
.filter
.msg_iter_can_seek_ns_from_origin
;
801 seek_beginning_method
= cc_full_descr
->methods
.filter
.msg_iter_seek_beginning
;
802 can_seek_beginning_method
= cc_full_descr
->methods
.filter
.msg_iter_can_seek_beginning
;
805 msg_iter_class
= bt_message_iterator_class_create(next_method
);
806 if (!msg_iter_class
) {
807 BT_LIB_LOGE_APPEND_CAUSE(
808 "Cannot create message iterator class.");
809 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
814 ret
= bt_message_iterator_class_set_initialize_method(
815 msg_iter_class
, init_method
);
817 BT_LIB_LOGE_APPEND_CAUSE(
818 "Cannot set message iterator initialization method.");
819 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
825 ret
= bt_message_iterator_class_set_finalize_method(
826 msg_iter_class
, fini_method
);
828 BT_LIB_LOGE_APPEND_CAUSE(
829 "Cannot set message iterator finalization method.");
830 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
835 if (seek_ns_from_origin_method
) {
836 ret
= bt_message_iterator_class_set_seek_ns_from_origin_methods(
838 seek_ns_from_origin_method
,
839 can_seek_ns_from_origin_method
);
841 BT_LIB_LOGE_APPEND_CAUSE(
842 "Cannot set message iterator \"seek nanoseconds from origin\" methods.");
843 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
848 if (seek_beginning_method
) {
849 ret
= bt_message_iterator_class_set_seek_beginning_methods(
851 seek_beginning_method
,
852 can_seek_beginning_method
);
854 BT_LIB_LOGE_APPEND_CAUSE(
855 "Cannot set message iterator \"seek beginning\" methods.");
856 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
862 switch (cc_full_descr
->descriptor
->type
) {
863 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
864 BT_ASSERT(msg_iter_class
);
866 src_comp_class
= bt_component_class_source_create(
867 cc_full_descr
->descriptor
->name
, msg_iter_class
);
868 comp_class
= bt_component_class_source_as_component_class(
871 case BT_COMPONENT_CLASS_TYPE_FILTER
:
872 BT_ASSERT(msg_iter_class
);
874 flt_comp_class
= bt_component_class_filter_create(
875 cc_full_descr
->descriptor
->name
, msg_iter_class
);
876 comp_class
= bt_component_class_filter_as_component_class(
879 case BT_COMPONENT_CLASS_TYPE_SINK
:
880 BT_ASSERT(!msg_iter_class
);
882 sink_comp_class
= bt_component_class_sink_create(
883 cc_full_descr
->descriptor
->name
,
884 cc_full_descr
->descriptor
->methods
.sink
.consume
);
885 comp_class
= bt_component_class_sink_as_component_class(
889 if (fail_on_load_error
) {
890 BT_LIB_LOGW_APPEND_CAUSE(
891 "Unknown component class type: "
892 "plugin-path=\"%s\", plugin-name=\"%s\", "
893 "comp-class-name=\"%s\", comp-class-type=%d",
894 spec
->shared_lib_handle
->path
->str
?
895 spec
->shared_lib_handle
->path
->str
:
898 cc_full_descr
->descriptor
->name
,
899 cc_full_descr
->descriptor
->type
);
900 status
= BT_FUNC_STATUS_ERROR
;
904 "Ignoring unknown component class type: "
905 "plugin-path=\"%s\", plugin-name=\"%s\", "
906 "comp-class-name=\"%s\", comp-class-type=%d",
907 spec
->shared_lib_handle
->path
->str
?
908 spec
->shared_lib_handle
->path
->str
:
911 cc_full_descr
->descriptor
->name
,
912 cc_full_descr
->descriptor
->type
);
918 BT_LIB_LOGE_APPEND_CAUSE(
919 "Cannot create component class.");
920 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
925 * The component class has taken a reference on the message
926 * iterator class, so we can drop ours. The message iterator
927 * class will get destroyed at the same time as the component
930 bt_message_iterator_class_put_ref(msg_iter_class
);
931 msg_iter_class
= NULL
;
933 if (cc_full_descr
->description
) {
934 ret
= bt_component_class_set_description(
935 comp_class
, cc_full_descr
->description
);
937 BT_LIB_LOGE_APPEND_CAUSE(
938 "Cannot set component class's description.");
939 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
940 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
945 if (cc_full_descr
->help
) {
946 ret
= bt_component_class_set_help(comp_class
,
947 cc_full_descr
->help
);
949 BT_LIB_LOGE_APPEND_CAUSE(
950 "Cannot set component class's help string.");
951 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
952 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
957 switch (cc_full_descr
->descriptor
->type
) {
958 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
959 if (cc_full_descr
->methods
.source
.get_supported_mip_versions
) {
960 ret
= bt_component_class_source_set_get_supported_mip_versions_method(
962 cc_full_descr
->methods
.source
.get_supported_mip_versions
);
964 BT_LIB_LOGE_APPEND_CAUSE(
965 "Cannot set source component class's \"get supported MIP versions\" method.");
966 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
967 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
972 if (cc_full_descr
->methods
.source
.init
) {
973 ret
= bt_component_class_source_set_initialize_method(
975 cc_full_descr
->methods
.source
.init
);
977 BT_LIB_LOGE_APPEND_CAUSE(
978 "Cannot set source component class's initialization method.");
979 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
980 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
985 if (cc_full_descr
->methods
.source
.finalize
) {
986 ret
= bt_component_class_source_set_finalize_method(
988 cc_full_descr
->methods
.source
.finalize
);
990 BT_LIB_LOGE_APPEND_CAUSE(
991 "Cannot set source component class's finalization method.");
992 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
993 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
998 if (cc_full_descr
->methods
.source
.query
) {
999 ret
= bt_component_class_source_set_query_method(
1001 cc_full_descr
->methods
.source
.query
);
1003 BT_LIB_LOGE_APPEND_CAUSE(
1004 "Cannot set source component class's query method.");
1005 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1006 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
1011 if (cc_full_descr
->methods
.source
.output_port_connected
) {
1012 ret
= bt_component_class_source_set_output_port_connected_method(
1014 cc_full_descr
->methods
.source
.output_port_connected
);
1016 BT_LIB_LOGE_APPEND_CAUSE(
1017 "Cannot set source component class's \"output port connected\" method.");
1018 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1019 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
1025 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1026 if (cc_full_descr
->methods
.filter
.get_supported_mip_versions
) {
1027 ret
= bt_component_class_filter_set_get_supported_mip_versions_method(
1029 cc_full_descr
->methods
.filter
.get_supported_mip_versions
);
1031 BT_LIB_LOGE_APPEND_CAUSE(
1032 "Cannot set filter component class's \"get supported MIP versions\" method.");
1033 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1034 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1039 if (cc_full_descr
->methods
.filter
.init
) {
1040 ret
= bt_component_class_filter_set_initialize_method(
1042 cc_full_descr
->methods
.filter
.init
);
1044 BT_LIB_LOGE_APPEND_CAUSE(
1045 "Cannot set filter component class's initialization method.");
1046 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1047 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1052 if (cc_full_descr
->methods
.filter
.finalize
) {
1053 ret
= bt_component_class_filter_set_finalize_method(
1055 cc_full_descr
->methods
.filter
.finalize
);
1057 BT_LIB_LOGE_APPEND_CAUSE(
1058 "Cannot set filter component class's finalization method.");
1059 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1060 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1065 if (cc_full_descr
->methods
.filter
.query
) {
1066 ret
= bt_component_class_filter_set_query_method(
1068 cc_full_descr
->methods
.filter
.query
);
1070 BT_LIB_LOGE_APPEND_CAUSE(
1071 "Cannot set filter component class's query method.");
1072 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1073 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1078 if (cc_full_descr
->methods
.filter
.input_port_connected
) {
1079 ret
= bt_component_class_filter_set_input_port_connected_method(
1081 cc_full_descr
->methods
.filter
.input_port_connected
);
1083 BT_LIB_LOGE_APPEND_CAUSE(
1084 "Cannot set filter component class's \"input port connected\" method.");
1085 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1086 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1091 if (cc_full_descr
->methods
.filter
.output_port_connected
) {
1092 ret
= bt_component_class_filter_set_output_port_connected_method(
1094 cc_full_descr
->methods
.filter
.output_port_connected
);
1096 BT_LIB_LOGE_APPEND_CAUSE(
1097 "Cannot set filter component class's \"output port connected\" method.");
1098 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1099 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1105 case BT_COMPONENT_CLASS_TYPE_SINK
:
1106 if (cc_full_descr
->methods
.sink
.get_supported_mip_versions
) {
1107 ret
= bt_component_class_sink_set_get_supported_mip_versions_method(
1109 cc_full_descr
->methods
.sink
.get_supported_mip_versions
);
1111 BT_LIB_LOGE_APPEND_CAUSE(
1112 "Cannot set sink component class's \"get supported MIP versions\" method.");
1113 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1114 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1119 if (cc_full_descr
->methods
.sink
.init
) {
1120 ret
= bt_component_class_sink_set_initialize_method(
1122 cc_full_descr
->methods
.sink
.init
);
1124 BT_LIB_LOGE_APPEND_CAUSE(
1125 "Cannot set sink component class's initialization method.");
1126 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1127 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1132 if (cc_full_descr
->methods
.sink
.finalize
) {
1133 ret
= bt_component_class_sink_set_finalize_method(
1135 cc_full_descr
->methods
.sink
.finalize
);
1137 BT_LIB_LOGE_APPEND_CAUSE(
1138 "Cannot set sink component class's finalization method.");
1139 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1140 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1145 if (cc_full_descr
->methods
.sink
.query
) {
1146 ret
= bt_component_class_sink_set_query_method(
1148 cc_full_descr
->methods
.sink
.query
);
1150 BT_LIB_LOGE_APPEND_CAUSE(
1151 "Cannot set sink component class's query method.");
1152 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1153 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1158 if (cc_full_descr
->methods
.sink
.input_port_connected
) {
1159 ret
= bt_component_class_sink_set_input_port_connected_method(
1161 cc_full_descr
->methods
.sink
.input_port_connected
);
1163 BT_LIB_LOGE_APPEND_CAUSE(
1164 "Cannot set sink component class's \"input port connected\" method.");
1165 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1166 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1171 if (cc_full_descr
->methods
.sink
.graph_is_configured
) {
1172 ret
= bt_component_class_sink_set_graph_is_configured_method(
1174 cc_full_descr
->methods
.sink
.graph_is_configured
);
1176 BT_LIB_LOGE_APPEND_CAUSE(
1177 "Cannot set sink component class's \"graph is configured\" method.");
1178 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1179 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1190 * Add component class to the plugin object.
1192 * This will call back
1193 * bt_plugin_so_on_add_component_class() so that we can
1194 * add a mapping in the component class list when we
1195 * know the component class is successfully added.
1197 status
= bt_plugin_add_component_class(plugin
,
1198 (void *) comp_class
);
1199 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
1201 BT_LIB_LOGE_APPEND_CAUSE(
1202 "Cannot add component class to plugin.");
1208 bt_message_iterator_class_put_ref(msg_iter_class
);
1209 g_array_free(comp_class_full_descriptors
, TRUE
);
1214 struct bt_plugin
*bt_plugin_so_create_empty(
1215 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
)
1217 struct bt_plugin
*plugin
;
1218 struct bt_plugin_so_spec_data
*spec
;
1220 plugin
= bt_plugin_create_empty(BT_PLUGIN_TYPE_SO
);
1225 plugin
->destroy_spec_data
= bt_plugin_so_destroy_spec_data
;
1226 plugin
->spec_data
= g_new0(struct bt_plugin_so_spec_data
, 1);
1227 if (!plugin
->spec_data
) {
1228 BT_LIB_LOGE_APPEND_CAUSE(
1229 "Failed to allocate one SO plugin specific data structure.");
1233 spec
= plugin
->spec_data
;
1234 spec
->shared_lib_handle
= shared_lib_handle
;
1235 bt_object_get_ref_no_null_check(spec
->shared_lib_handle
);
1239 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1246 size_t count_non_null_items_in_section(const void *begin
, const void *end
)
1249 const int * const *begin_int
= (const int * const *) begin
;
1250 const int * const *end_int
= (const int * const *) end
;
1251 const int * const *iter
;
1253 for (iter
= begin_int
; iter
!= end_int
; iter
++) {
1263 int bt_plugin_so_create_all_from_sections(
1264 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
,
1265 bool fail_on_load_error
,
1266 struct __bt_plugin_descriptor
const * const *descriptors_begin
,
1267 struct __bt_plugin_descriptor
const * const *descriptors_end
,
1268 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
1269 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
1270 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
1271 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
1272 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
1273 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
,
1274 struct bt_plugin_set
**plugin_set_out
)
1276 int status
= BT_FUNC_STATUS_OK
;
1277 size_t descriptor_count
;
1279 size_t cc_descriptors_count
;
1280 size_t cc_descr_attrs_count
;
1283 BT_ASSERT(shared_lib_handle
);
1284 BT_ASSERT(plugin_set_out
);
1285 *plugin_set_out
= NULL
;
1286 descriptor_count
= count_non_null_items_in_section(descriptors_begin
, descriptors_end
);
1287 attrs_count
= count_non_null_items_in_section(attrs_begin
, attrs_end
);
1288 cc_descriptors_count
= count_non_null_items_in_section(cc_descriptors_begin
, cc_descriptors_end
);
1289 cc_descr_attrs_count
= count_non_null_items_in_section(cc_descr_attrs_begin
, cc_descr_attrs_end
);
1290 BT_LOGI("Creating all SO plugins from sections: "
1291 "plugin-path=\"%s\", "
1292 "descr-begin-addr=%p, descr-end-addr=%p, "
1293 "attrs-begin-addr=%p, attrs-end-addr=%p, "
1294 "cc-descr-begin-addr=%p, cc-descr-end-addr=%p, "
1295 "cc-descr-attrs-begin-addr=%p, cc-descr-attrs-end-addr=%p, "
1296 "descr-count=%zu, attrs-count=%zu, "
1297 "cc-descr-count=%zu, cc-descr-attrs-count=%zu",
1298 shared_lib_handle
->path
? shared_lib_handle
->path
->str
: NULL
,
1299 descriptors_begin
, descriptors_end
,
1300 attrs_begin
, attrs_end
,
1301 cc_descriptors_begin
, cc_descriptors_end
,
1302 cc_descr_attrs_begin
, cc_descr_attrs_end
,
1303 descriptor_count
, attrs_count
,
1304 cc_descriptors_count
, cc_descr_attrs_count
);
1305 *plugin_set_out
= bt_plugin_set_create();
1306 if (!*plugin_set_out
) {
1307 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set.");
1308 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1312 for (i
= 0; i
< descriptors_end
- descriptors_begin
; i
++) {
1313 const struct __bt_plugin_descriptor
*descriptor
=
1314 descriptors_begin
[i
];
1315 struct bt_plugin
*plugin
;
1321 BT_LOGI("Creating plugin object for plugin: name=\"%s\"",
1323 plugin
= bt_plugin_so_create_empty(shared_lib_handle
);
1325 BT_LIB_LOGE_APPEND_CAUSE(
1326 "Cannot create empty shared library handle.");
1327 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1331 if (shared_lib_handle
->path
) {
1332 bt_plugin_set_path(plugin
,
1333 shared_lib_handle
->path
->str
);
1336 status
= bt_plugin_so_init(plugin
, fail_on_load_error
,
1337 descriptor
, attrs_begin
, attrs_end
,
1338 cc_descriptors_begin
, cc_descriptors_end
,
1339 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1340 if (status
== BT_FUNC_STATUS_OK
) {
1341 /* Add to plugin set */
1342 bt_plugin_set_add_plugin(*plugin_set_out
, plugin
);
1343 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1344 } else if (status
== BT_FUNC_STATUS_NOT_FOUND
) {
1346 * There was an error initializing the plugin,
1347 * but `fail_on_load_error` is false.
1349 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1350 } else if (status
< 0) {
1352 * bt_plugin_so_init() handles
1353 * `fail_on_load_error`, so this is a "real"
1356 BT_LIB_LOGW_APPEND_CAUSE(
1357 "Cannot initialize SO plugin object from sections.");
1358 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1365 BT_ASSERT(*plugin_set_out
);
1367 if ((*plugin_set_out
)->plugins
->len
== 0) {
1368 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
1369 status
= BT_FUNC_STATUS_NOT_FOUND
;
1375 BT_ASSERT(status
< 0);
1376 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
1382 int bt_plugin_so_create_all_from_static(bool fail_on_load_error
,
1383 struct bt_plugin_set
**plugin_set_out
)
1386 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
1388 BT_ASSERT(plugin_set_out
);
1389 *plugin_set_out
= NULL
;
1390 status
= bt_plugin_so_shared_lib_handle_create(NULL
,
1391 &shared_lib_handle
);
1392 if (status
!= BT_FUNC_STATUS_OK
) {
1393 BT_ASSERT(!shared_lib_handle
);
1397 BT_ASSERT(shared_lib_handle
);
1398 BT_LOGD_STR("Creating all SO plugins from built-in plugins.");
1399 status
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
1401 __bt_get_begin_section_plugin_descriptors(),
1402 __bt_get_end_section_plugin_descriptors(),
1403 __bt_get_begin_section_plugin_descriptor_attributes(),
1404 __bt_get_end_section_plugin_descriptor_attributes(),
1405 __bt_get_begin_section_component_class_descriptors(),
1406 __bt_get_end_section_component_class_descriptors(),
1407 __bt_get_begin_section_component_class_descriptor_attributes(),
1408 __bt_get_end_section_component_class_descriptor_attributes(),
1410 BT_ASSERT((status
== BT_FUNC_STATUS_OK
&& *plugin_set_out
&&
1411 (*plugin_set_out
)->plugins
->len
> 0) || !*plugin_set_out
);
1414 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
1418 int bt_plugin_so_create_all_from_file(const char *path
,
1419 bool fail_on_load_error
, struct bt_plugin_set
**plugin_set_out
)
1423 struct __bt_plugin_descriptor
const * const *descriptors_begin
= NULL
;
1424 struct __bt_plugin_descriptor
const * const *descriptors_end
= NULL
;
1425 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
= NULL
;
1426 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
= NULL
;
1427 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
= NULL
;
1428 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
= NULL
;
1429 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
= NULL
;
1430 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
= NULL
;
1431 struct __bt_plugin_descriptor
const * const *(*get_begin_section_plugin_descriptors
)(void);
1432 struct __bt_plugin_descriptor
const * const *(*get_end_section_plugin_descriptors
)(void);
1433 struct __bt_plugin_descriptor_attribute
const * const *(*get_begin_section_plugin_descriptor_attributes
)(void);
1434 struct __bt_plugin_descriptor_attribute
const * const *(*get_end_section_plugin_descriptor_attributes
)(void);
1435 struct __bt_plugin_component_class_descriptor
const * const *(*get_begin_section_component_class_descriptors
)(void);
1436 struct __bt_plugin_component_class_descriptor
const * const *(*get_end_section_component_class_descriptors
)(void);
1437 struct __bt_plugin_component_class_descriptor_attribute
const * const *(*get_begin_section_component_class_descriptor_attributes
)(void);
1438 struct __bt_plugin_component_class_descriptor_attribute
const * const *(*get_end_section_component_class_descriptor_attributes
)(void);
1439 bt_bool is_libtool_wrapper
= BT_FALSE
, is_shared_object
= BT_FALSE
;
1440 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
1443 BT_ASSERT(plugin_set_out
);
1444 *plugin_set_out
= NULL
;
1445 path_len
= strlen(path
);
1448 * An SO plugin file must have a known plugin file suffix. So the file
1449 * path must be longer than the suffix length.
1451 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
1452 BT_LOGI("Path is too short to be an `.so` or `.la` plugin file:"
1453 "path=%s, path-length=%zu, min-length=%zu",
1454 path
, path_len
, PLUGIN_SUFFIX_LEN
);
1455 status
= BT_FUNC_STATUS_NOT_FOUND
;
1459 BT_LOGI("Trying to create all SO plugins from file: path=\"%s\"", path
);
1463 * Check if the file ends with a known plugin file type suffix
1464 * (i.e. .so or .la on Linux).
1466 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
1467 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
1468 LIBTOOL_PLUGIN_SUFFIX_LEN
);
1469 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
1470 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
1471 NATIVE_PLUGIN_SUFFIX_LEN
);
1472 if (!is_shared_object
&& !is_libtool_wrapper
) {
1473 /* Name indicates this is not a plugin file; not an error */
1474 BT_LOGI("File is not an SO plugin file: path=\"%s\"", path
);
1475 status
= BT_FUNC_STATUS_NOT_FOUND
;
1479 status
= bt_plugin_so_shared_lib_handle_create(path
,
1480 &shared_lib_handle
);
1481 if (status
!= BT_FUNC_STATUS_OK
) {
1482 /* bt_plugin_so_shared_lib_handle_create() logs more details */
1483 BT_ASSERT(!shared_lib_handle
);
1487 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_plugin_descriptors",
1488 (gpointer
*) &get_begin_section_plugin_descriptors
)) {
1489 descriptors_begin
= get_begin_section_plugin_descriptors();
1492 * Use this first symbol to know whether or not this
1493 * shared object _looks like_ a Babeltrace plugin. Since
1494 * g_module_symbol() failed, assume that this is not a
1495 * Babeltrace plugin, so it's not an error.
1497 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1498 "symbol=\"%s\"", path
,
1499 "__bt_get_begin_section_plugin_descriptors");
1500 status
= BT_FUNC_STATUS_NOT_FOUND
;
1505 * If g_module_symbol() fails for any of the other symbols, fail
1506 * if `fail_on_load_error` is true.
1508 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_plugin_descriptors",
1509 (gpointer
*) &get_end_section_plugin_descriptors
)) {
1510 descriptors_end
= get_end_section_plugin_descriptors();
1512 if (fail_on_load_error
) {
1513 BT_LIB_LOGW_APPEND_CAUSE(
1514 "Cannot resolve plugin symbol: path=\"%s\", "
1515 "symbol=\"%s\"", path
,
1516 "__bt_get_end_section_plugin_descriptors");
1517 status
= BT_FUNC_STATUS_ERROR
;
1520 "Cannot resolve plugin symbol: path=\"%s\", "
1521 "symbol=\"%s\"", path
,
1522 "__bt_get_end_section_plugin_descriptors");
1523 status
= BT_FUNC_STATUS_NOT_FOUND
;
1529 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_plugin_descriptor_attributes",
1530 (gpointer
*) &get_begin_section_plugin_descriptor_attributes
)) {
1531 attrs_begin
= get_begin_section_plugin_descriptor_attributes();
1533 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1534 "symbol=\"%s\"", path
,
1535 "__bt_get_begin_section_plugin_descriptor_attributes");
1538 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_plugin_descriptor_attributes",
1539 (gpointer
*) &get_end_section_plugin_descriptor_attributes
)) {
1540 attrs_end
= get_end_section_plugin_descriptor_attributes();
1542 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1543 "symbol=\"%s\"", path
,
1544 "__bt_get_end_section_plugin_descriptor_attributes");
1547 if ((!!attrs_begin
- !!attrs_end
) != 0) {
1548 if (fail_on_load_error
) {
1549 BT_LIB_LOGW_APPEND_CAUSE(
1550 "Found section start or end symbol, but not both: "
1551 "path=\"%s\", symbol-start=\"%s\", "
1552 "symbol-end=\"%s\", symbol-start-addr=%p, "
1553 "symbol-end-addr=%p",
1554 path
, "__bt_get_begin_section_plugin_descriptor_attributes",
1555 "__bt_get_end_section_plugin_descriptor_attributes",
1556 attrs_begin
, attrs_end
);
1557 status
= BT_FUNC_STATUS_ERROR
;
1560 "Found section start or end symbol, but not both: "
1561 "path=\"%s\", symbol-start=\"%s\", "
1562 "symbol-end=\"%s\", symbol-start-addr=%p, "
1563 "symbol-end-addr=%p",
1564 path
, "__bt_get_begin_section_plugin_descriptor_attributes",
1565 "__bt_get_end_section_plugin_descriptor_attributes",
1566 attrs_begin
, attrs_end
);
1567 status
= BT_FUNC_STATUS_NOT_FOUND
;
1573 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_component_class_descriptors",
1574 (gpointer
*) &get_begin_section_component_class_descriptors
)) {
1575 cc_descriptors_begin
= get_begin_section_component_class_descriptors();
1577 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1578 "symbol=\"%s\"", path
,
1579 "__bt_get_begin_section_component_class_descriptors");
1582 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_component_class_descriptors",
1583 (gpointer
*) &get_end_section_component_class_descriptors
)) {
1584 cc_descriptors_end
= get_end_section_component_class_descriptors();
1586 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1587 "symbol=\"%s\"", path
,
1588 "__bt_get_end_section_component_class_descriptors");
1591 if ((!!cc_descriptors_begin
- !!cc_descriptors_end
) != 0) {
1592 if (fail_on_load_error
) {
1593 BT_LIB_LOGW_APPEND_CAUSE(
1594 "Found section start or end symbol, but not both: "
1595 "path=\"%s\", symbol-start=\"%s\", "
1596 "symbol-end=\"%s\", symbol-start-addr=%p, "
1597 "symbol-end-addr=%p",
1598 path
, "__bt_get_begin_section_component_class_descriptors",
1599 "__bt_get_end_section_component_class_descriptors",
1600 cc_descriptors_begin
, cc_descriptors_end
);
1601 status
= BT_FUNC_STATUS_ERROR
;
1604 "Found section start or end symbol, but not both: "
1605 "path=\"%s\", symbol-start=\"%s\", "
1606 "symbol-end=\"%s\", symbol-start-addr=%p, "
1607 "symbol-end-addr=%p",
1608 path
, "__bt_get_begin_section_component_class_descriptors",
1609 "__bt_get_end_section_component_class_descriptors",
1610 cc_descriptors_begin
, cc_descriptors_end
);
1611 status
= BT_FUNC_STATUS_NOT_FOUND
;
1617 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_component_class_descriptor_attributes",
1618 (gpointer
*) &get_begin_section_component_class_descriptor_attributes
)) {
1619 cc_descr_attrs_begin
= get_begin_section_component_class_descriptor_attributes();
1621 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1622 "symbol=\"%s\"", path
,
1623 "__bt_get_begin_section_component_class_descriptor_attributes");
1626 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_component_class_descriptor_attributes",
1627 (gpointer
*) &get_end_section_component_class_descriptor_attributes
)) {
1628 cc_descr_attrs_end
= get_end_section_component_class_descriptor_attributes();
1630 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1631 "symbol=\"%s\"", path
,
1632 "__bt_get_end_section_component_class_descriptor_attributes");
1635 if ((!!cc_descr_attrs_begin
- !!cc_descr_attrs_end
) != 0) {
1636 if (fail_on_load_error
) {
1637 BT_LIB_LOGW_APPEND_CAUSE(
1638 "Found section start or end symbol, but not both: "
1639 "path=\"%s\", symbol-start=\"%s\", "
1640 "symbol-end=\"%s\", symbol-start-addr=%p, "
1641 "symbol-end-addr=%p",
1642 path
, "__bt_get_begin_section_component_class_descriptor_attributes",
1643 "__bt_get_end_section_component_class_descriptor_attributes",
1644 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1645 status
= BT_FUNC_STATUS_ERROR
;
1648 "Found section start or end symbol, but not both: "
1649 "path=\"%s\", symbol-start=\"%s\", "
1650 "symbol-end=\"%s\", symbol-start-addr=%p, "
1651 "symbol-end-addr=%p",
1652 path
, "__bt_get_begin_section_component_class_descriptor_attributes",
1653 "__bt_get_end_section_component_class_descriptor_attributes",
1654 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1655 status
= BT_FUNC_STATUS_NOT_FOUND
;
1661 /* Initialize plugin */
1662 BT_LOGD_STR("Initializing plugin object.");
1663 status
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
1665 descriptors_begin
, descriptors_end
, attrs_begin
, attrs_end
,
1666 cc_descriptors_begin
, cc_descriptors_end
,
1667 cc_descr_attrs_begin
, cc_descr_attrs_end
, plugin_set_out
);
1670 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
1675 void plugin_comp_class_destroy_listener(struct bt_component_class
*comp_class
,
1676 void *data
__attribute__((unused
)))
1678 bt_list_del(&comp_class
->node
);
1679 BT_OBJECT_PUT_REF_AND_RESET(comp_class
->so_handle
);
1680 BT_LOGD("Component class destroyed: removed entry from list: "
1681 "comp-cls-addr=%p", comp_class
);
1685 * This function would normally not be BT_EXPORTed, but it is used by the
1686 * Python plugin provider, which is conceptually part of libbabeltrace2, but
1687 * implemented as a separate shared object, for modularity. It is therefore
1688 * exposed, but not part of the public ABI.
1691 void bt_plugin_so_on_add_component_class(struct bt_plugin
*plugin
,
1692 struct bt_component_class
*comp_class
)
1694 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
1696 BT_ASSERT(plugin
->spec_data
);
1697 BT_ASSERT(plugin
->type
== BT_PLUGIN_TYPE_SO
);
1699 bt_list_add(&comp_class
->node
, &component_class_list
);
1700 comp_class
->so_handle
= spec
->shared_lib_handle
;
1701 bt_object_get_ref_no_null_check(comp_class
->so_handle
);
1703 /* Add our custom destroy listener */
1704 bt_component_class_add_destroy_listener(comp_class
,
1705 plugin_comp_class_destroy_listener
, NULL
);