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-SO"
27 #include "lib/logging.h"
29 #include "common/assert.h"
30 #include "lib/assert-pre.h"
31 #include "compat/compiler.h"
32 #include <babeltrace2/plugin/plugin-dev.h>
33 #include "lib/graph/component-class.h"
34 #include <babeltrace2/graph/component-class.h>
35 #include <babeltrace2/graph/component-class-source.h>
36 #include <babeltrace2/graph/component-class-filter.h>
37 #include <babeltrace2/graph/component-class-sink.h>
38 #include <babeltrace2/types.h>
39 #include "common/list.h"
46 #include "plugin-so.h"
47 #include "lib/func-status.h"
48 #include "common/common.h"
50 #define NATIVE_PLUGIN_SUFFIX "." G_MODULE_SUFFIX
51 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
52 #define LIBTOOL_PLUGIN_SUFFIX ".la"
53 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
55 #define PLUGIN_SUFFIX_LEN bt_max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
56 sizeof(LIBTOOL_PLUGIN_SUFFIX))
61 * This list, global to the library, keeps all component classes that
62 * have a reference to their shared library handles. It allows iteration
63 * on all component classes still present when the destructor executes
64 * to release the shared library handle references they might still have.
66 * The list items are the component classes created with
67 * bt_plugin_add_component_class(). They keep the shared library handle
68 * object created by their plugin alive so that the plugin's code is
69 * not discarded when it could still be in use by living components
70 * created from those component classes:
72 * [component] --ref-> [component class]-> [shlib handle]
74 * It allows this use-case:
76 * my_plugins = bt_plugin_find_all_from_file("/path/to/my-plugin.so");
77 * // instantiate components from a plugin's component classes
78 * // put plugins and free my_plugins here
79 * // user code of instantiated components still exists
81 * An entry is removed from this list when a component class is
82 * destroyed thanks to a custom destroy listener. When the entry is
83 * removed, the entry is removed from the list, and we release the
84 * reference on the shlib handle. Assuming the original plugin object
85 * which contained some component classes is put first, when the last
86 * component class is removed from this list, the shared library handle
87 * object's reference count falls to zero and the shared library is
92 BT_LIST_HEAD(component_class_list
);
94 __attribute__((destructor
)) static
95 void fini_comp_class_list(void)
97 struct bt_component_class
*comp_class
, *tmp
;
99 bt_list_for_each_entry_safe(comp_class
, tmp
, &component_class_list
, node
) {
100 bt_list_del(&comp_class
->node
);
101 BT_OBJECT_PUT_REF_AND_RESET(comp_class
->so_handle
);
104 BT_LOGD_STR("Released references from all component classes to shared library handles.");
108 void bt_plugin_so_shared_lib_handle_destroy(struct bt_object
*obj
)
110 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
;
113 shared_lib_handle
= container_of(obj
,
114 struct bt_plugin_so_shared_lib_handle
, base
);
115 const char *path
= shared_lib_handle
->path
?
116 shared_lib_handle
->path
->str
: NULL
;
118 BT_LOGI("Destroying shared library handle: addr=%p, path=\"%s\"",
119 shared_lib_handle
, path
);
121 if (shared_lib_handle
->init_called
&& shared_lib_handle
->exit
) {
122 BT_LOGD_STR("Calling user's plugin exit function.");
123 shared_lib_handle
->exit();
124 BT_LOGD_STR("User function returned.");
127 if (shared_lib_handle
->module
) {
130 * Valgrind shows incomplete stack traces when
131 * dynamically loaded libraries are closed before it
132 * finishes. Use the LIBBABELTRACE2_NO_DLCLOSE in a debug
133 * build to avoid this.
135 const char *var
= getenv("LIBBABELTRACE2_NO_DLCLOSE");
137 if (!var
|| strcmp(var
, "1") != 0) {
139 BT_LOGI("Closing GModule: path=\"%s\"", path
);
141 if (!g_module_close(shared_lib_handle
->module
)) {
143 * Just log here: we're in a destructor,
144 * so we cannot append an error cause
145 * (there's no returned status).
147 BT_LOGE("Cannot close GModule: %s: path=\"%s\"",
148 g_module_error(), path
);
151 shared_lib_handle
->module
= NULL
;
154 BT_LOGI("Not closing GModule because `LIBBABELTRACE2_NO_DLCLOSE=1`: "
155 "path=\"%s\"", path
);
160 if (shared_lib_handle
->path
) {
161 g_string_free(shared_lib_handle
->path
, TRUE
);
162 shared_lib_handle
->path
= NULL
;
165 g_free(shared_lib_handle
);
169 int bt_plugin_so_shared_lib_handle_create(
171 struct bt_plugin_so_shared_lib_handle
**shared_lib_handle
)
173 int status
= BT_FUNC_STATUS_OK
;
175 BT_ASSERT(shared_lib_handle
);
176 BT_LOGI("Creating shared library handle: path=\"%s\"", path
);
177 *shared_lib_handle
= g_new0(struct bt_plugin_so_shared_lib_handle
, 1);
178 if (!*shared_lib_handle
) {
179 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one shared library handle.");
180 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
184 bt_object_init_shared(&(*shared_lib_handle
)->base
,
185 bt_plugin_so_shared_lib_handle_destroy
);
191 (*shared_lib_handle
)->path
= g_string_new(path
);
192 if (!(*shared_lib_handle
)->path
) {
193 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GString.");
194 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
198 (*shared_lib_handle
)->module
= g_module_open(path
, G_MODULE_BIND_LOCAL
);
199 if (!(*shared_lib_handle
)->module
) {
201 * INFO-level logging because we're only _trying_ to
202 * open this file as a Babeltrace plugin: if it's not,
203 * it's not an error. And because this can be tried
204 * during bt_plugin_find_all_from_dir(), it's not even a
207 BT_LOGI("Cannot open GModule: %s: path=\"%s\"",
208 g_module_error(), path
);
209 BT_OBJECT_PUT_REF_AND_RESET(*shared_lib_handle
);
210 status
= BT_FUNC_STATUS_NOT_FOUND
;
217 BT_ASSERT(*shared_lib_handle
|| status
!= BT_FUNC_STATUS_OK
);
218 if (*shared_lib_handle
) {
219 BT_LOGI("Created shared library handle: path=\"%s\", addr=%p",
220 path
, *shared_lib_handle
);
227 void bt_plugin_so_destroy_spec_data(struct bt_plugin
*plugin
)
229 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
231 if (!plugin
->spec_data
) {
235 BT_ASSERT(plugin
->type
== BT_PLUGIN_TYPE_SO
);
237 BT_OBJECT_PUT_REF_AND_RESET(spec
->shared_lib_handle
);
238 g_free(plugin
->spec_data
);
239 plugin
->spec_data
= NULL
;
243 * This function does the following:
245 * 1. Iterate on the plugin descriptor attributes section and set the
246 * plugin's attributes depending on the attribute types. This
247 * includes the name of the plugin, its description, and its
248 * initialization function, for example.
250 * 2. Iterate on the component class descriptors section and create one
251 * "full descriptor" (temporary structure) for each one that is found
252 * and attached to our plugin descriptor.
254 * 3. Iterate on the component class descriptor attributes section and
255 * set the corresponding full descriptor's attributes depending on
256 * the attribute types. This includes the description of the
257 * component class, as well as its initialization and destroy
260 * 4. Call the user's plugin initialization function, if any is
263 * 5. For each full component class descriptor, create a component class
264 * object, set its optional attributes, and add it to the plugin
267 * 6. Freeze the plugin object.
270 int bt_plugin_so_init(struct bt_plugin
*plugin
,
271 bool fail_on_load_error
,
272 const struct __bt_plugin_descriptor
*descriptor
,
273 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
274 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
275 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
276 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
277 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
278 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
)
281 * This structure's members point to the plugin's memory
284 struct comp_class_full_descriptor
{
285 const struct __bt_plugin_component_class_descriptor
*descriptor
;
286 const char *description
;
291 bt_component_class_source_get_supported_mip_versions_method get_supported_mip_versions
;
292 bt_component_class_source_initialize_method init
;
293 bt_component_class_source_finalize_method finalize
;
294 bt_component_class_source_query_method query
;
295 bt_component_class_source_output_port_connected_method output_port_connected
;
296 bt_component_class_source_message_iterator_initialize_method msg_iter_initialize
;
297 bt_component_class_source_message_iterator_finalize_method msg_iter_finalize
;
298 bt_component_class_source_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin
;
299 bt_component_class_source_message_iterator_seek_beginning_method msg_iter_seek_beginning
;
300 bt_component_class_source_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin
;
301 bt_component_class_source_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning
;
305 bt_component_class_filter_get_supported_mip_versions_method get_supported_mip_versions
;
306 bt_component_class_filter_initialize_method init
;
307 bt_component_class_filter_finalize_method finalize
;
308 bt_component_class_filter_query_method query
;
309 bt_component_class_filter_input_port_connected_method input_port_connected
;
310 bt_component_class_filter_output_port_connected_method output_port_connected
;
311 bt_component_class_filter_message_iterator_initialize_method msg_iter_initialize
;
312 bt_component_class_filter_message_iterator_finalize_method msg_iter_finalize
;
313 bt_component_class_filter_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin
;
314 bt_component_class_filter_message_iterator_seek_beginning_method msg_iter_seek_beginning
;
315 bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin
;
316 bt_component_class_filter_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning
;
320 bt_component_class_sink_get_supported_mip_versions_method get_supported_mip_versions
;
321 bt_component_class_sink_initialize_method init
;
322 bt_component_class_sink_finalize_method finalize
;
323 bt_component_class_sink_query_method query
;
324 bt_component_class_sink_input_port_connected_method input_port_connected
;
325 bt_component_class_sink_graph_is_configured_method graph_is_configured
;
330 int status
= BT_FUNC_STATUS_OK
;
331 struct __bt_plugin_descriptor_attribute
const * const *cur_attr_ptr
;
332 struct __bt_plugin_component_class_descriptor
const * const *cur_cc_descr_ptr
;
333 struct __bt_plugin_component_class_descriptor_attribute
const * const *cur_cc_descr_attr_ptr
;
334 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
335 GArray
*comp_class_full_descriptors
;
339 BT_LOGI("Initializing plugin object from descriptors found in sections: "
340 "plugin-addr=%p, plugin-path=\"%s\", "
341 "attrs-begin-addr=%p, attrs-end-addr=%p, "
342 "cc-descr-begin-addr=%p, cc-descr-end-addr=%p, "
343 "cc-descr-attrs-begin-addr=%p, cc-descr-attrs-end-addr=%p",
345 spec
->shared_lib_handle
->path
?
346 spec
->shared_lib_handle
->path
->str
: NULL
,
347 attrs_begin
, attrs_end
,
348 cc_descriptors_begin
, cc_descriptors_end
,
349 cc_descr_attrs_begin
, cc_descr_attrs_end
);
350 comp_class_full_descriptors
= g_array_new(FALSE
, TRUE
,
351 sizeof(struct comp_class_full_descriptor
));
352 if (!comp_class_full_descriptors
) {
353 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GArray.");
354 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
358 /* Set mandatory attributes */
359 spec
->descriptor
= descriptor
;
360 bt_plugin_set_name(plugin
, descriptor
->name
);
363 * Find and set optional attributes attached to this plugin
366 for (cur_attr_ptr
= attrs_begin
; cur_attr_ptr
!= attrs_end
; cur_attr_ptr
++) {
367 const struct __bt_plugin_descriptor_attribute
*cur_attr
=
374 if (cur_attr
->plugin_descriptor
!= descriptor
) {
378 switch (cur_attr
->type
) {
379 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_INIT
:
380 spec
->init
= cur_attr
->value
.init
;
382 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT
:
383 spec
->shared_lib_handle
->exit
= cur_attr
->value
.exit
;
385 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_AUTHOR
:
386 bt_plugin_set_author(plugin
, cur_attr
->value
.author
);
388 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_LICENSE
:
389 bt_plugin_set_license(plugin
, cur_attr
->value
.license
);
391 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
392 bt_plugin_set_description(plugin
, cur_attr
->value
.description
);
394 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_VERSION
:
395 bt_plugin_set_version(plugin
,
396 (unsigned int) cur_attr
->value
.version
.major
,
397 (unsigned int) cur_attr
->value
.version
.minor
,
398 (unsigned int) cur_attr
->value
.version
.patch
,
399 cur_attr
->value
.version
.extra
);
402 if (fail_on_load_error
) {
403 BT_LIB_LOGW_APPEND_CAUSE(
404 "Unknown plugin descriptor attribute: "
405 "plugin-path=\"%s\", plugin-name=\"%s\", "
406 "attr-type-name=\"%s\", attr-type-id=%d",
407 spec
->shared_lib_handle
->path
?
408 spec
->shared_lib_handle
->path
->str
:
410 descriptor
->name
, cur_attr
->type_name
,
412 status
= BT_FUNC_STATUS_ERROR
;
416 "Ignoring unknown plugin descriptor attribute: "
417 "plugin-path=\"%s\", plugin-name=\"%s\", "
418 "attr-type-name=\"%s\", attr-type-id=%d",
419 spec
->shared_lib_handle
->path
?
420 spec
->shared_lib_handle
->path
->str
:
422 descriptor
->name
, cur_attr
->type_name
,
431 * Find component class descriptors attached to this plugin
432 * descriptor and initialize corresponding full component class
433 * descriptors in the array.
435 for (cur_cc_descr_ptr
= cc_descriptors_begin
; cur_cc_descr_ptr
!= cc_descriptors_end
; cur_cc_descr_ptr
++) {
436 const struct __bt_plugin_component_class_descriptor
*cur_cc_descr
=
438 struct comp_class_full_descriptor full_descriptor
= {0};
444 if (cur_cc_descr
->plugin_descriptor
!= descriptor
) {
448 full_descriptor
.descriptor
= cur_cc_descr
;
449 g_array_append_val(comp_class_full_descriptors
,
454 * Find component class descriptor attributes attached to this
455 * plugin descriptor and update corresponding full component
456 * class descriptors in the array.
458 for (cur_cc_descr_attr_ptr
= cc_descr_attrs_begin
; cur_cc_descr_attr_ptr
!= cc_descr_attrs_end
; cur_cc_descr_attr_ptr
++) {
459 const struct __bt_plugin_component_class_descriptor_attribute
*cur_cc_descr_attr
=
460 *cur_cc_descr_attr_ptr
;
461 enum bt_component_class_type cc_type
;
463 if (!cur_cc_descr_attr
) {
467 if (cur_cc_descr_attr
->comp_class_descriptor
->plugin_descriptor
!=
472 cc_type
= cur_cc_descr_attr
->comp_class_descriptor
->type
;
474 /* Find the corresponding component class descriptor entry */
475 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
476 struct comp_class_full_descriptor
*cc_full_descr
=
477 &g_array_index(comp_class_full_descriptors
,
478 struct comp_class_full_descriptor
, i
);
480 if (cur_cc_descr_attr
->comp_class_descriptor
!=
481 cc_full_descr
->descriptor
) {
485 switch (cur_cc_descr_attr
->type
) {
486 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
487 cc_full_descr
->description
=
488 cur_cc_descr_attr
->value
.description
;
490 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_HELP
:
491 cc_full_descr
->help
=
492 cur_cc_descr_attr
->value
.help
;
494 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_GET_SUPPORTED_MIP_VERSIONS_METHOD
:
496 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
497 cc_full_descr
->methods
.source
.get_supported_mip_versions
=
498 cur_cc_descr_attr
->value
.source_get_supported_mip_versions_method
;
500 case BT_COMPONENT_CLASS_TYPE_FILTER
:
501 cc_full_descr
->methods
.filter
.get_supported_mip_versions
=
502 cur_cc_descr_attr
->value
.filter_get_supported_mip_versions_method
;
504 case BT_COMPONENT_CLASS_TYPE_SINK
:
505 cc_full_descr
->methods
.sink
.get_supported_mip_versions
=
506 cur_cc_descr_attr
->value
.sink_get_supported_mip_versions_method
;
512 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INITIALIZE_METHOD
:
514 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
515 cc_full_descr
->methods
.source
.init
=
516 cur_cc_descr_attr
->value
.source_initialize_method
;
518 case BT_COMPONENT_CLASS_TYPE_FILTER
:
519 cc_full_descr
->methods
.filter
.init
=
520 cur_cc_descr_attr
->value
.filter_initialize_method
;
522 case BT_COMPONENT_CLASS_TYPE_SINK
:
523 cc_full_descr
->methods
.sink
.init
=
524 cur_cc_descr_attr
->value
.sink_initialize_method
;
530 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_FINALIZE_METHOD
:
532 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
533 cc_full_descr
->methods
.source
.finalize
=
534 cur_cc_descr_attr
->value
.source_finalize_method
;
536 case BT_COMPONENT_CLASS_TYPE_FILTER
:
537 cc_full_descr
->methods
.filter
.finalize
=
538 cur_cc_descr_attr
->value
.filter_finalize_method
;
540 case BT_COMPONENT_CLASS_TYPE_SINK
:
541 cc_full_descr
->methods
.sink
.finalize
=
542 cur_cc_descr_attr
->value
.sink_finalize_method
;
548 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_QUERY_METHOD
:
550 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
551 cc_full_descr
->methods
.source
.query
=
552 cur_cc_descr_attr
->value
.source_query_method
;
554 case BT_COMPONENT_CLASS_TYPE_FILTER
:
555 cc_full_descr
->methods
.filter
.query
=
556 cur_cc_descr_attr
->value
.filter_query_method
;
558 case BT_COMPONENT_CLASS_TYPE_SINK
:
559 cc_full_descr
->methods
.sink
.query
=
560 cur_cc_descr_attr
->value
.sink_query_method
;
566 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INPUT_PORT_CONNECTED_METHOD
:
568 case BT_COMPONENT_CLASS_TYPE_FILTER
:
569 cc_full_descr
->methods
.filter
.input_port_connected
=
570 cur_cc_descr_attr
->value
.filter_input_port_connected_method
;
572 case BT_COMPONENT_CLASS_TYPE_SINK
:
573 cc_full_descr
->methods
.sink
.input_port_connected
=
574 cur_cc_descr_attr
->value
.sink_input_port_connected_method
;
580 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_OUTPUT_PORT_CONNECTED_METHOD
:
582 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
583 cc_full_descr
->methods
.source
.output_port_connected
=
584 cur_cc_descr_attr
->value
.source_output_port_connected_method
;
586 case BT_COMPONENT_CLASS_TYPE_FILTER
:
587 cc_full_descr
->methods
.filter
.output_port_connected
=
588 cur_cc_descr_attr
->value
.filter_output_port_connected_method
;
594 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_GRAPH_IS_CONFIGURED_METHOD
:
596 case BT_COMPONENT_CLASS_TYPE_SINK
:
597 cc_full_descr
->methods
.sink
.graph_is_configured
=
598 cur_cc_descr_attr
->value
.sink_graph_is_configured_method
;
604 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_INITIALIZE_METHOD
:
606 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
607 cc_full_descr
->methods
.source
.msg_iter_initialize
=
608 cur_cc_descr_attr
->value
.source_msg_iter_initialize_method
;
610 case BT_COMPONENT_CLASS_TYPE_FILTER
:
611 cc_full_descr
->methods
.filter
.msg_iter_initialize
=
612 cur_cc_descr_attr
->value
.filter_msg_iter_initialize_method
;
618 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_FINALIZE_METHOD
:
620 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
621 cc_full_descr
->methods
.source
.msg_iter_finalize
=
622 cur_cc_descr_attr
->value
.source_msg_iter_finalize_method
;
624 case BT_COMPONENT_CLASS_TYPE_FILTER
:
625 cc_full_descr
->methods
.filter
.msg_iter_finalize
=
626 cur_cc_descr_attr
->value
.filter_msg_iter_finalize_method
;
632 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_SEEK_NS_FROM_ORIGIN_METHOD
:
634 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
635 cc_full_descr
->methods
.source
.msg_iter_seek_ns_from_origin
=
636 cur_cc_descr_attr
->value
.source_msg_iter_seek_ns_from_origin_method
;
638 case BT_COMPONENT_CLASS_TYPE_FILTER
:
639 cc_full_descr
->methods
.filter
.msg_iter_seek_ns_from_origin
=
640 cur_cc_descr_attr
->value
.filter_msg_iter_seek_ns_from_origin_method
;
646 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_SEEK_BEGINNING_METHOD
:
648 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
649 cc_full_descr
->methods
.source
.msg_iter_seek_beginning
=
650 cur_cc_descr_attr
->value
.source_msg_iter_seek_beginning_method
;
652 case BT_COMPONENT_CLASS_TYPE_FILTER
:
653 cc_full_descr
->methods
.filter
.msg_iter_seek_beginning
=
654 cur_cc_descr_attr
->value
.filter_msg_iter_seek_beginning_method
;
660 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_CAN_SEEK_NS_FROM_ORIGIN_METHOD
:
662 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
663 cc_full_descr
->methods
.source
.msg_iter_can_seek_ns_from_origin
=
664 cur_cc_descr_attr
->value
.source_msg_iter_can_seek_ns_from_origin_method
;
666 case BT_COMPONENT_CLASS_TYPE_FILTER
:
667 cc_full_descr
->methods
.filter
.msg_iter_can_seek_ns_from_origin
=
668 cur_cc_descr_attr
->value
.filter_msg_iter_can_seek_ns_from_origin_method
;
674 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_CAN_SEEK_BEGINNING_METHOD
:
676 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
677 cc_full_descr
->methods
.source
.msg_iter_can_seek_beginning
=
678 cur_cc_descr_attr
->value
.source_msg_iter_can_seek_beginning_method
;
680 case BT_COMPONENT_CLASS_TYPE_FILTER
:
681 cc_full_descr
->methods
.filter
.msg_iter_can_seek_beginning
=
682 cur_cc_descr_attr
->value
.filter_msg_iter_can_seek_beginning_method
;
689 if (fail_on_load_error
) {
690 BT_LIB_LOGW_APPEND_CAUSE(
691 "Unknown component class descriptor attribute: "
692 "plugin-path=\"%s\", "
693 "plugin-name=\"%s\", "
694 "comp-class-name=\"%s\", "
695 "comp-class-type=%s, "
696 "attr-type-name=\"%s\", "
698 spec
->shared_lib_handle
->path
?
699 spec
->shared_lib_handle
->path
->str
:
702 cur_cc_descr_attr
->comp_class_descriptor
->name
,
703 bt_component_class_type_string(
704 cur_cc_descr_attr
->comp_class_descriptor
->type
),
705 cur_cc_descr_attr
->type_name
,
706 cur_cc_descr_attr
->type
);
707 status
= BT_FUNC_STATUS_ERROR
;
711 "Ignoring unknown component class descriptor attribute: "
712 "plugin-path=\"%s\", "
713 "plugin-name=\"%s\", "
714 "comp-class-name=\"%s\", "
715 "comp-class-type=%s, "
716 "attr-type-name=\"%s\", "
718 spec
->shared_lib_handle
->path
?
719 spec
->shared_lib_handle
->path
->str
:
722 cur_cc_descr_attr
->comp_class_descriptor
->name
,
723 bt_component_class_type_string(
724 cur_cc_descr_attr
->comp_class_descriptor
->type
),
725 cur_cc_descr_attr
->type_name
,
726 cur_cc_descr_attr
->type
);
734 /* Initialize plugin */
736 enum bt_plugin_initialize_func_status init_status
;
738 BT_LOGD_STR("Calling user's plugin initialization function.");
739 init_status
= spec
->init((void *) plugin
);
740 BT_LOGD("User function returned: status=%s",
741 bt_common_func_status_string(init_status
));
743 if (init_status
< 0) {
744 if (fail_on_load_error
) {
745 BT_LIB_LOGW_APPEND_CAUSE(
746 "User's plugin initialization function failed: "
748 bt_common_func_status_string(init_status
));
749 status
= init_status
;
753 "User's plugin initialization function failed: "
755 bt_common_func_status_string(init_status
));
756 status
= BT_FUNC_STATUS_NOT_FOUND
;
763 spec
->shared_lib_handle
->init_called
= BT_TRUE
;
765 /* Add described component classes to plugin */
766 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
767 struct comp_class_full_descriptor
*cc_full_descr
=
768 &g_array_index(comp_class_full_descriptors
,
769 struct comp_class_full_descriptor
, i
);
770 struct bt_component_class
*comp_class
= NULL
;
771 struct bt_component_class_source
*src_comp_class
= NULL
;
772 struct bt_component_class_filter
*flt_comp_class
= NULL
;
773 struct bt_component_class_sink
*sink_comp_class
= NULL
;
775 BT_LOGI("Creating and setting properties of plugin's component class: "
776 "plugin-path=\"%s\", plugin-name=\"%s\", "
777 "comp-class-name=\"%s\", comp-class-type=%s",
778 spec
->shared_lib_handle
->path
?
779 spec
->shared_lib_handle
->path
->str
:
782 cc_full_descr
->descriptor
->name
,
783 bt_component_class_type_string(
784 cc_full_descr
->descriptor
->type
));
786 switch (cc_full_descr
->descriptor
->type
) {
787 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
788 src_comp_class
= bt_component_class_source_create(
789 cc_full_descr
->descriptor
->name
,
790 cc_full_descr
->descriptor
->methods
.source
.msg_iter_next
);
791 comp_class
= bt_component_class_source_as_component_class(
794 case BT_COMPONENT_CLASS_TYPE_FILTER
:
795 flt_comp_class
= bt_component_class_filter_create(
796 cc_full_descr
->descriptor
->name
,
797 cc_full_descr
->descriptor
->methods
.source
.msg_iter_next
);
798 comp_class
= bt_component_class_filter_as_component_class(
801 case BT_COMPONENT_CLASS_TYPE_SINK
:
802 sink_comp_class
= bt_component_class_sink_create(
803 cc_full_descr
->descriptor
->name
,
804 cc_full_descr
->descriptor
->methods
.sink
.consume
);
805 comp_class
= bt_component_class_sink_as_component_class(
809 if (fail_on_load_error
) {
810 BT_LIB_LOGW_APPEND_CAUSE(
811 "Unknown component class type: "
812 "plugin-path=\"%s\", plugin-name=\"%s\", "
813 "comp-class-name=\"%s\", comp-class-type=%d",
814 spec
->shared_lib_handle
->path
->str
?
815 spec
->shared_lib_handle
->path
->str
:
818 cc_full_descr
->descriptor
->name
,
819 cc_full_descr
->descriptor
->type
);
820 status
= BT_FUNC_STATUS_ERROR
;
824 "Ignoring unknown component class type: "
825 "plugin-path=\"%s\", plugin-name=\"%s\", "
826 "comp-class-name=\"%s\", comp-class-type=%d",
827 spec
->shared_lib_handle
->path
->str
?
828 spec
->shared_lib_handle
->path
->str
:
831 cc_full_descr
->descriptor
->name
,
832 cc_full_descr
->descriptor
->type
);
838 BT_LIB_LOGE_APPEND_CAUSE(
839 "Cannot create component class.");
840 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
844 if (cc_full_descr
->description
) {
845 ret
= bt_component_class_set_description(
846 comp_class
, cc_full_descr
->description
);
848 BT_LIB_LOGE_APPEND_CAUSE(
849 "Cannot set component class's description.");
850 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
851 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
856 if (cc_full_descr
->help
) {
857 ret
= bt_component_class_set_help(comp_class
,
858 cc_full_descr
->help
);
860 BT_LIB_LOGE_APPEND_CAUSE(
861 "Cannot set component class's help string.");
862 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
863 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
868 switch (cc_full_descr
->descriptor
->type
) {
869 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
870 if (cc_full_descr
->methods
.source
.get_supported_mip_versions
) {
871 ret
= bt_component_class_source_set_get_supported_mip_versions_method(
873 cc_full_descr
->methods
.source
.get_supported_mip_versions
);
875 BT_LIB_LOGE_APPEND_CAUSE(
876 "Cannot set source component class's \"get supported MIP versions\" method.");
877 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
878 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
883 if (cc_full_descr
->methods
.source
.init
) {
884 ret
= bt_component_class_source_set_initialize_method(
886 cc_full_descr
->methods
.source
.init
);
888 BT_LIB_LOGE_APPEND_CAUSE(
889 "Cannot set source component class's initialization method.");
890 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
891 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
896 if (cc_full_descr
->methods
.source
.finalize
) {
897 ret
= bt_component_class_source_set_finalize_method(
899 cc_full_descr
->methods
.source
.finalize
);
901 BT_LIB_LOGE_APPEND_CAUSE(
902 "Cannot set source component class's finalization method.");
903 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
904 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
909 if (cc_full_descr
->methods
.source
.query
) {
910 ret
= bt_component_class_source_set_query_method(
912 cc_full_descr
->methods
.source
.query
);
914 BT_LIB_LOGE_APPEND_CAUSE(
915 "Cannot set source component class's query method.");
916 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
917 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
922 if (cc_full_descr
->methods
.source
.output_port_connected
) {
923 ret
= bt_component_class_source_set_output_port_connected_method(
925 cc_full_descr
->methods
.source
.output_port_connected
);
927 BT_LIB_LOGE_APPEND_CAUSE(
928 "Cannot set source component class's \"output port connected\" method.");
929 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
930 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
935 if (cc_full_descr
->methods
.source
.msg_iter_initialize
) {
936 ret
= bt_component_class_source_set_message_iterator_initialize_method(
938 cc_full_descr
->methods
.source
.msg_iter_initialize
);
940 BT_LIB_LOGE_APPEND_CAUSE(
941 "Cannot set source component class's message iterator initialization method.");
942 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
943 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
948 if (cc_full_descr
->methods
.source
.msg_iter_finalize
) {
949 ret
= bt_component_class_source_set_message_iterator_finalize_method(
951 cc_full_descr
->methods
.source
.msg_iter_finalize
);
953 BT_LIB_LOGE_APPEND_CAUSE(
954 "Cannot set source component class's message iterator finalization method.");
955 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
956 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
961 if (cc_full_descr
->methods
.source
.msg_iter_seek_ns_from_origin
) {
962 ret
= bt_component_class_source_set_message_iterator_seek_ns_from_origin_methods(
964 cc_full_descr
->methods
.source
.msg_iter_seek_ns_from_origin
,
965 cc_full_descr
->methods
.source
.msg_iter_can_seek_ns_from_origin
);
967 BT_LIB_LOGE_APPEND_CAUSE(
968 "Cannot set source component class's message iterator \"seek nanoseconds from origin\" methods.");
969 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
970 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
975 if (cc_full_descr
->methods
.source
.msg_iter_seek_beginning
) {
976 ret
= bt_component_class_source_set_message_iterator_seek_beginning_methods(
978 cc_full_descr
->methods
.source
.msg_iter_seek_beginning
,
979 cc_full_descr
->methods
.source
.msg_iter_can_seek_beginning
);
981 BT_LIB_LOGE_APPEND_CAUSE(
982 "Cannot set source component class's message iterator \"seek beginning\" methods.");
983 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
984 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
990 case BT_COMPONENT_CLASS_TYPE_FILTER
:
991 if (cc_full_descr
->methods
.filter
.get_supported_mip_versions
) {
992 ret
= bt_component_class_filter_set_get_supported_mip_versions_method(
994 cc_full_descr
->methods
.filter
.get_supported_mip_versions
);
996 BT_LIB_LOGE_APPEND_CAUSE(
997 "Cannot set filter component class's \"get supported MIP versions\" method.");
998 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
999 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1004 if (cc_full_descr
->methods
.filter
.init
) {
1005 ret
= bt_component_class_filter_set_initialize_method(
1007 cc_full_descr
->methods
.filter
.init
);
1009 BT_LIB_LOGE_APPEND_CAUSE(
1010 "Cannot set filter component class's initialization method.");
1011 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1012 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1017 if (cc_full_descr
->methods
.filter
.finalize
) {
1018 ret
= bt_component_class_filter_set_finalize_method(
1020 cc_full_descr
->methods
.filter
.finalize
);
1022 BT_LIB_LOGE_APPEND_CAUSE(
1023 "Cannot set filter component class's finalization method.");
1024 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1025 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1030 if (cc_full_descr
->methods
.filter
.query
) {
1031 ret
= bt_component_class_filter_set_query_method(
1033 cc_full_descr
->methods
.filter
.query
);
1035 BT_LIB_LOGE_APPEND_CAUSE(
1036 "Cannot set filter component class's query method.");
1037 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1038 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1043 if (cc_full_descr
->methods
.filter
.input_port_connected
) {
1044 ret
= bt_component_class_filter_set_input_port_connected_method(
1046 cc_full_descr
->methods
.filter
.input_port_connected
);
1048 BT_LIB_LOGE_APPEND_CAUSE(
1049 "Cannot set filter component class's \"input port connected\" method.");
1050 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1051 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1056 if (cc_full_descr
->methods
.filter
.output_port_connected
) {
1057 ret
= bt_component_class_filter_set_output_port_connected_method(
1059 cc_full_descr
->methods
.filter
.output_port_connected
);
1061 BT_LIB_LOGE_APPEND_CAUSE(
1062 "Cannot set filter component class's \"output port connected\" method.");
1063 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1064 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1069 if (cc_full_descr
->methods
.filter
.msg_iter_initialize
) {
1070 ret
= bt_component_class_filter_set_message_iterator_initialize_method(
1072 cc_full_descr
->methods
.filter
.msg_iter_initialize
);
1074 BT_LIB_LOGE_APPEND_CAUSE(
1075 "Cannot set filter component class's message iterator initialization method.");
1076 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1077 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1082 if (cc_full_descr
->methods
.filter
.msg_iter_finalize
) {
1083 ret
= bt_component_class_filter_set_message_iterator_finalize_method(
1085 cc_full_descr
->methods
.filter
.msg_iter_finalize
);
1087 BT_LIB_LOGE_APPEND_CAUSE(
1088 "Cannot set filter component class's message iterator finalization method.");
1089 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1090 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1095 if (cc_full_descr
->methods
.filter
.msg_iter_seek_ns_from_origin
) {
1096 ret
= bt_component_class_filter_set_message_iterator_seek_ns_from_origin_methods(
1098 cc_full_descr
->methods
.filter
.msg_iter_seek_ns_from_origin
,
1099 cc_full_descr
->methods
.filter
.msg_iter_can_seek_ns_from_origin
);
1101 BT_LIB_LOGE_APPEND_CAUSE(
1102 "Cannot set filter component class's message iterator \"seek nanoseconds from origin\" methods.");
1103 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1104 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1109 if (cc_full_descr
->methods
.filter
.msg_iter_seek_beginning
) {
1110 ret
= bt_component_class_filter_set_message_iterator_seek_beginning_methods(
1112 cc_full_descr
->methods
.filter
.msg_iter_seek_beginning
,
1113 cc_full_descr
->methods
.filter
.msg_iter_can_seek_beginning
);
1115 BT_LIB_LOGE_APPEND_CAUSE(
1116 "Cannot set filter component class's message iterator \"seek beginning\" methods.");
1117 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1118 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
1124 case BT_COMPONENT_CLASS_TYPE_SINK
:
1125 if (cc_full_descr
->methods
.sink
.get_supported_mip_versions
) {
1126 ret
= bt_component_class_sink_set_get_supported_mip_versions_method(
1128 cc_full_descr
->methods
.sink
.get_supported_mip_versions
);
1130 BT_LIB_LOGE_APPEND_CAUSE(
1131 "Cannot set sink component class's \"get supported MIP versions\" method.");
1132 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1133 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1138 if (cc_full_descr
->methods
.sink
.init
) {
1139 ret
= bt_component_class_sink_set_initialize_method(
1141 cc_full_descr
->methods
.sink
.init
);
1143 BT_LIB_LOGE_APPEND_CAUSE(
1144 "Cannot set sink component class's initialization method.");
1145 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1146 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1151 if (cc_full_descr
->methods
.sink
.finalize
) {
1152 ret
= bt_component_class_sink_set_finalize_method(
1154 cc_full_descr
->methods
.sink
.finalize
);
1156 BT_LIB_LOGE_APPEND_CAUSE(
1157 "Cannot set sink component class's finalization method.");
1158 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1159 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1164 if (cc_full_descr
->methods
.sink
.query
) {
1165 ret
= bt_component_class_sink_set_query_method(
1167 cc_full_descr
->methods
.sink
.query
);
1169 BT_LIB_LOGE_APPEND_CAUSE(
1170 "Cannot set sink component class's query method.");
1171 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1172 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1177 if (cc_full_descr
->methods
.sink
.input_port_connected
) {
1178 ret
= bt_component_class_sink_set_input_port_connected_method(
1180 cc_full_descr
->methods
.sink
.input_port_connected
);
1182 BT_LIB_LOGE_APPEND_CAUSE(
1183 "Cannot set sink component class's \"input port connected\" method.");
1184 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1185 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1190 if (cc_full_descr
->methods
.sink
.graph_is_configured
) {
1191 ret
= bt_component_class_sink_set_graph_is_configured_method(
1193 cc_full_descr
->methods
.sink
.graph_is_configured
);
1195 BT_LIB_LOGE_APPEND_CAUSE(
1196 "Cannot set sink component class's \"graph is configured\" method.");
1197 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1198 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1209 * Add component class to the plugin object.
1211 * This will call back
1212 * bt_plugin_so_on_add_component_class() so that we can
1213 * add a mapping in the component class list when we
1214 * know the component class is successfully added.
1216 status
= bt_plugin_add_component_class(plugin
,
1217 (void *) comp_class
);
1218 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
1220 BT_LIB_LOGE_APPEND_CAUSE(
1221 "Cannot add component class to plugin.");
1227 g_array_free(comp_class_full_descriptors
, TRUE
);
1232 struct bt_plugin
*bt_plugin_so_create_empty(
1233 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
)
1235 struct bt_plugin
*plugin
;
1236 struct bt_plugin_so_spec_data
*spec
;
1238 plugin
= bt_plugin_create_empty(BT_PLUGIN_TYPE_SO
);
1243 plugin
->destroy_spec_data
= bt_plugin_so_destroy_spec_data
;
1244 plugin
->spec_data
= g_new0(struct bt_plugin_so_spec_data
, 1);
1245 if (!plugin
->spec_data
) {
1246 BT_LIB_LOGE_APPEND_CAUSE(
1247 "Failed to allocate one SO plugin specific data structure.");
1251 spec
= plugin
->spec_data
;
1252 spec
->shared_lib_handle
= shared_lib_handle
;
1253 bt_object_get_ref_no_null_check(spec
->shared_lib_handle
);
1257 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1264 size_t count_non_null_items_in_section(const void *begin
, const void *end
)
1267 const int * const *begin_int
= (const int * const *) begin
;
1268 const int * const *end_int
= (const int * const *) end
;
1269 const int * const *iter
;
1271 for (iter
= begin_int
; iter
!= end_int
; iter
++) {
1281 int bt_plugin_so_create_all_from_sections(
1282 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
,
1283 bool fail_on_load_error
,
1284 struct __bt_plugin_descriptor
const * const *descriptors_begin
,
1285 struct __bt_plugin_descriptor
const * const *descriptors_end
,
1286 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
1287 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
1288 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
1289 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
1290 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
1291 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
,
1292 struct bt_plugin_set
**plugin_set_out
)
1294 int status
= BT_FUNC_STATUS_OK
;
1295 size_t descriptor_count
;
1297 size_t cc_descriptors_count
;
1298 size_t cc_descr_attrs_count
;
1301 BT_ASSERT(shared_lib_handle
);
1302 BT_ASSERT(plugin_set_out
);
1303 *plugin_set_out
= NULL
;
1304 descriptor_count
= count_non_null_items_in_section(descriptors_begin
, descriptors_end
);
1305 attrs_count
= count_non_null_items_in_section(attrs_begin
, attrs_end
);
1306 cc_descriptors_count
= count_non_null_items_in_section(cc_descriptors_begin
, cc_descriptors_end
);
1307 cc_descr_attrs_count
= count_non_null_items_in_section(cc_descr_attrs_begin
, cc_descr_attrs_end
);
1308 BT_LOGI("Creating all SO plugins from sections: "
1309 "plugin-path=\"%s\", "
1310 "descr-begin-addr=%p, descr-end-addr=%p, "
1311 "attrs-begin-addr=%p, attrs-end-addr=%p, "
1312 "cc-descr-begin-addr=%p, cc-descr-end-addr=%p, "
1313 "cc-descr-attrs-begin-addr=%p, cc-descr-attrs-end-addr=%p, "
1314 "descr-count=%zu, attrs-count=%zu, "
1315 "cc-descr-count=%zu, cc-descr-attrs-count=%zu",
1316 shared_lib_handle
->path
? shared_lib_handle
->path
->str
: NULL
,
1317 descriptors_begin
, descriptors_end
,
1318 attrs_begin
, attrs_end
,
1319 cc_descriptors_begin
, cc_descriptors_end
,
1320 cc_descr_attrs_begin
, cc_descr_attrs_end
,
1321 descriptor_count
, attrs_count
,
1322 cc_descriptors_count
, cc_descr_attrs_count
);
1323 *plugin_set_out
= bt_plugin_set_create();
1324 if (!*plugin_set_out
) {
1325 BT_LIB_LOGE_APPEND_CAUSE("Cannot create empty plugin set.");
1326 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1330 for (i
= 0; i
< descriptors_end
- descriptors_begin
; i
++) {
1331 const struct __bt_plugin_descriptor
*descriptor
=
1332 descriptors_begin
[i
];
1333 struct bt_plugin
*plugin
;
1339 BT_LOGI("Creating plugin object for plugin: "
1340 "name=\"%s\", abi-major=%d, abi-minor=%d",
1341 descriptor
->name
, descriptor
->major
, descriptor
->minor
);
1343 if (descriptor
->major
> __BT_PLUGIN_VERSION_MAJOR
) {
1344 if (fail_on_load_error
) {
1345 BT_LIB_LOGW_APPEND_CAUSE(
1346 "Unknown ABI major version: abi-major=%d",
1348 status
= BT_FUNC_STATUS_ERROR
;
1352 "Unknown ABI major version: abi-major=%d",
1358 plugin
= bt_plugin_so_create_empty(shared_lib_handle
);
1360 BT_LIB_LOGE_APPEND_CAUSE(
1361 "Cannot create empty shared library handle.");
1362 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1366 if (shared_lib_handle
->path
) {
1367 bt_plugin_set_path(plugin
,
1368 shared_lib_handle
->path
->str
);
1371 status
= bt_plugin_so_init(plugin
, fail_on_load_error
,
1372 descriptor
, attrs_begin
, attrs_end
,
1373 cc_descriptors_begin
, cc_descriptors_end
,
1374 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1375 if (status
== BT_FUNC_STATUS_OK
) {
1376 /* Add to plugin set */
1377 bt_plugin_set_add_plugin(*plugin_set_out
, plugin
);
1378 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1379 } else if (status
< 0) {
1381 * bt_plugin_so_init() handles
1382 * `fail_on_load_error`, so this is a "real"
1385 BT_LIB_LOGW_APPEND_CAUSE(
1386 "Cannot initialize SO plugin object from sections.");
1387 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1394 BT_ASSERT(*plugin_set_out
);
1396 if ((*plugin_set_out
)->plugins
->len
== 0) {
1397 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
1398 status
= BT_FUNC_STATUS_NOT_FOUND
;
1404 BT_ASSERT(status
< 0);
1405 BT_OBJECT_PUT_REF_AND_RESET(*plugin_set_out
);
1412 int bt_plugin_so_create_all_from_static(bool fail_on_load_error
,
1413 struct bt_plugin_set
**plugin_set_out
)
1416 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
1418 BT_ASSERT(plugin_set_out
);
1419 *plugin_set_out
= NULL
;
1420 status
= bt_plugin_so_shared_lib_handle_create(NULL
,
1421 &shared_lib_handle
);
1422 if (status
!= BT_FUNC_STATUS_OK
) {
1423 BT_ASSERT(!shared_lib_handle
);
1427 BT_ASSERT(shared_lib_handle
);
1428 BT_LOGD_STR("Creating all SO plugins from built-in plugins.");
1429 status
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
1431 __bt_get_begin_section_plugin_descriptors(),
1432 __bt_get_end_section_plugin_descriptors(),
1433 __bt_get_begin_section_plugin_descriptor_attributes(),
1434 __bt_get_end_section_plugin_descriptor_attributes(),
1435 __bt_get_begin_section_component_class_descriptors(),
1436 __bt_get_end_section_component_class_descriptors(),
1437 __bt_get_begin_section_component_class_descriptor_attributes(),
1438 __bt_get_end_section_component_class_descriptor_attributes(),
1440 BT_ASSERT((status
== BT_FUNC_STATUS_OK
&& *plugin_set_out
&&
1441 (*plugin_set_out
)->plugins
->len
> 0) || !*plugin_set_out
);
1444 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
1449 int bt_plugin_so_create_all_from_file(const char *path
,
1450 bool fail_on_load_error
, struct bt_plugin_set
**plugin_set_out
)
1454 struct __bt_plugin_descriptor
const * const *descriptors_begin
= NULL
;
1455 struct __bt_plugin_descriptor
const * const *descriptors_end
= NULL
;
1456 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
= NULL
;
1457 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
= NULL
;
1458 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
= NULL
;
1459 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
= NULL
;
1460 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
= NULL
;
1461 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
= NULL
;
1462 struct __bt_plugin_descriptor
const * const *(*get_begin_section_plugin_descriptors
)(void);
1463 struct __bt_plugin_descriptor
const * const *(*get_end_section_plugin_descriptors
)(void);
1464 struct __bt_plugin_descriptor_attribute
const * const *(*get_begin_section_plugin_descriptor_attributes
)(void);
1465 struct __bt_plugin_descriptor_attribute
const * const *(*get_end_section_plugin_descriptor_attributes
)(void);
1466 struct __bt_plugin_component_class_descriptor
const * const *(*get_begin_section_component_class_descriptors
)(void);
1467 struct __bt_plugin_component_class_descriptor
const * const *(*get_end_section_component_class_descriptors
)(void);
1468 struct __bt_plugin_component_class_descriptor_attribute
const * const *(*get_begin_section_component_class_descriptor_attributes
)(void);
1469 struct __bt_plugin_component_class_descriptor_attribute
const * const *(*get_end_section_component_class_descriptor_attributes
)(void);
1470 bt_bool is_libtool_wrapper
= BT_FALSE
, is_shared_object
= BT_FALSE
;
1471 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
1474 BT_ASSERT(plugin_set_out
);
1475 *plugin_set_out
= NULL
;
1476 path_len
= strlen(path
);
1479 * An SO plugin file must have a known plugin file suffix. So the file
1480 * path must be longer than the suffix length.
1482 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
1483 BT_LOGI("Path is too short to be an `.so` or `.la` plugin file:"
1484 "path=%s, path-length=%zu, min-length=%zu",
1485 path
, path_len
, PLUGIN_SUFFIX_LEN
);
1486 status
= BT_FUNC_STATUS_NOT_FOUND
;
1490 BT_LOGI("Trying to create all SO plugins from file: path=\"%s\"", path
);
1494 * Check if the file ends with a known plugin file type suffix
1495 * (i.e. .so or .la on Linux).
1497 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
1498 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
1499 LIBTOOL_PLUGIN_SUFFIX_LEN
);
1500 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
1501 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
1502 NATIVE_PLUGIN_SUFFIX_LEN
);
1503 if (!is_shared_object
&& !is_libtool_wrapper
) {
1504 /* Name indicates this is not a plugin file; not an error */
1505 BT_LOGI("File is not an SO plugin file: path=\"%s\"", path
);
1506 status
= BT_FUNC_STATUS_NOT_FOUND
;
1510 status
= bt_plugin_so_shared_lib_handle_create(path
,
1511 &shared_lib_handle
);
1512 if (status
!= BT_FUNC_STATUS_OK
) {
1513 /* bt_plugin_so_shared_lib_handle_create() logs more details */
1514 BT_ASSERT(!shared_lib_handle
);
1518 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_plugin_descriptors",
1519 (gpointer
*) &get_begin_section_plugin_descriptors
)) {
1520 descriptors_begin
= get_begin_section_plugin_descriptors();
1523 * Use this first symbol to know whether or not this
1524 * shared object _looks like_ a Babeltrace plugin. Since
1525 * g_module_symbol() failed, assume that this is not a
1526 * Babeltrace plugin, so it's not an error.
1528 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1529 "symbol=\"%s\"", path
,
1530 "__bt_get_begin_section_plugin_descriptors");
1531 status
= BT_FUNC_STATUS_NOT_FOUND
;
1536 * If g_module_symbol() fails for any of the other symbols, fail
1537 * if `fail_on_load_error` is true.
1539 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_plugin_descriptors",
1540 (gpointer
*) &get_end_section_plugin_descriptors
)) {
1541 descriptors_end
= get_end_section_plugin_descriptors();
1543 if (fail_on_load_error
) {
1544 BT_LIB_LOGW_APPEND_CAUSE(
1545 "Cannot resolve plugin symbol: path=\"%s\", "
1546 "symbol=\"%s\"", path
,
1547 "__bt_get_end_section_plugin_descriptors");
1548 status
= BT_FUNC_STATUS_ERROR
;
1551 "Cannot resolve plugin symbol: path=\"%s\", "
1552 "symbol=\"%s\"", path
,
1553 "__bt_get_end_section_plugin_descriptors");
1554 status
= BT_FUNC_STATUS_NOT_FOUND
;
1560 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_plugin_descriptor_attributes",
1561 (gpointer
*) &get_begin_section_plugin_descriptor_attributes
)) {
1562 attrs_begin
= get_begin_section_plugin_descriptor_attributes();
1564 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1565 "symbol=\"%s\"", path
,
1566 "__bt_get_begin_section_plugin_descriptor_attributes");
1569 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_plugin_descriptor_attributes",
1570 (gpointer
*) &get_end_section_plugin_descriptor_attributes
)) {
1571 attrs_end
= get_end_section_plugin_descriptor_attributes();
1573 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1574 "symbol=\"%s\"", path
,
1575 "__bt_get_end_section_plugin_descriptor_attributes");
1578 if ((!!attrs_begin
- !!attrs_end
) != 0) {
1579 if (fail_on_load_error
) {
1580 BT_LIB_LOGW_APPEND_CAUSE(
1581 "Found section start or end symbol, but not both: "
1582 "path=\"%s\", symbol-start=\"%s\", "
1583 "symbol-end=\"%s\", symbol-start-addr=%p, "
1584 "symbol-end-addr=%p",
1585 path
, "__bt_get_begin_section_plugin_descriptor_attributes",
1586 "__bt_get_end_section_plugin_descriptor_attributes",
1587 attrs_begin
, attrs_end
);
1588 status
= BT_FUNC_STATUS_ERROR
;
1591 "Found section start or end symbol, but not both: "
1592 "path=\"%s\", symbol-start=\"%s\", "
1593 "symbol-end=\"%s\", symbol-start-addr=%p, "
1594 "symbol-end-addr=%p",
1595 path
, "__bt_get_begin_section_plugin_descriptor_attributes",
1596 "__bt_get_end_section_plugin_descriptor_attributes",
1597 attrs_begin
, attrs_end
);
1598 status
= BT_FUNC_STATUS_NOT_FOUND
;
1604 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_component_class_descriptors",
1605 (gpointer
*) &get_begin_section_component_class_descriptors
)) {
1606 cc_descriptors_begin
= get_begin_section_component_class_descriptors();
1608 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1609 "symbol=\"%s\"", path
,
1610 "__bt_get_begin_section_component_class_descriptors");
1613 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_component_class_descriptors",
1614 (gpointer
*) &get_end_section_component_class_descriptors
)) {
1615 cc_descriptors_end
= get_end_section_component_class_descriptors();
1617 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1618 "symbol=\"%s\"", path
,
1619 "__bt_get_end_section_component_class_descriptors");
1622 if ((!!cc_descriptors_begin
- !!cc_descriptors_end
) != 0) {
1623 if (fail_on_load_error
) {
1624 BT_LIB_LOGW_APPEND_CAUSE(
1625 "Found section start or end symbol, but not both: "
1626 "path=\"%s\", symbol-start=\"%s\", "
1627 "symbol-end=\"%s\", symbol-start-addr=%p, "
1628 "symbol-end-addr=%p",
1629 path
, "__bt_get_begin_section_component_class_descriptors",
1630 "__bt_get_end_section_component_class_descriptors",
1631 cc_descriptors_begin
, cc_descriptors_end
);
1632 status
= BT_FUNC_STATUS_ERROR
;
1635 "Found section start or end symbol, but not both: "
1636 "path=\"%s\", symbol-start=\"%s\", "
1637 "symbol-end=\"%s\", symbol-start-addr=%p, "
1638 "symbol-end-addr=%p",
1639 path
, "__bt_get_begin_section_component_class_descriptors",
1640 "__bt_get_end_section_component_class_descriptors",
1641 cc_descriptors_begin
, cc_descriptors_end
);
1642 status
= BT_FUNC_STATUS_NOT_FOUND
;
1648 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_component_class_descriptor_attributes",
1649 (gpointer
*) &get_begin_section_component_class_descriptor_attributes
)) {
1650 cc_descr_attrs_begin
= get_begin_section_component_class_descriptor_attributes();
1652 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1653 "symbol=\"%s\"", path
,
1654 "__bt_get_begin_section_component_class_descriptor_attributes");
1657 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_component_class_descriptor_attributes",
1658 (gpointer
*) &get_end_section_component_class_descriptor_attributes
)) {
1659 cc_descr_attrs_end
= get_end_section_component_class_descriptor_attributes();
1661 BT_LOGI("Cannot resolve plugin symbol: path=\"%s\", "
1662 "symbol=\"%s\"", path
,
1663 "__bt_get_end_section_component_class_descriptor_attributes");
1666 if ((!!cc_descr_attrs_begin
- !!cc_descr_attrs_end
) != 0) {
1667 if (fail_on_load_error
) {
1668 BT_LIB_LOGW_APPEND_CAUSE(
1669 "Found section start or end symbol, but not both: "
1670 "path=\"%s\", symbol-start=\"%s\", "
1671 "symbol-end=\"%s\", symbol-start-addr=%p, "
1672 "symbol-end-addr=%p",
1673 path
, "__bt_get_begin_section_component_class_descriptor_attributes",
1674 "__bt_get_end_section_component_class_descriptor_attributes",
1675 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1676 status
= BT_FUNC_STATUS_ERROR
;
1679 "Found section start or end symbol, but not both: "
1680 "path=\"%s\", symbol-start=\"%s\", "
1681 "symbol-end=\"%s\", symbol-start-addr=%p, "
1682 "symbol-end-addr=%p",
1683 path
, "__bt_get_begin_section_component_class_descriptor_attributes",
1684 "__bt_get_end_section_component_class_descriptor_attributes",
1685 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1686 status
= BT_FUNC_STATUS_NOT_FOUND
;
1692 /* Initialize plugin */
1693 BT_LOGD_STR("Initializing plugin object.");
1694 status
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
1696 descriptors_begin
, descriptors_end
, attrs_begin
, attrs_end
,
1697 cc_descriptors_begin
, cc_descriptors_end
,
1698 cc_descr_attrs_begin
, cc_descr_attrs_end
, plugin_set_out
);
1701 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
1706 void plugin_comp_class_destroy_listener(struct bt_component_class
*comp_class
,
1709 bt_list_del(&comp_class
->node
);
1710 BT_OBJECT_PUT_REF_AND_RESET(comp_class
->so_handle
);
1711 BT_LOGD("Component class destroyed: removed entry from list: "
1712 "comp-cls-addr=%p", comp_class
);
1715 void bt_plugin_so_on_add_component_class(struct bt_plugin
*plugin
,
1716 struct bt_component_class
*comp_class
)
1718 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
1720 BT_ASSERT(plugin
->spec_data
);
1721 BT_ASSERT(plugin
->type
== BT_PLUGIN_TYPE_SO
);
1723 bt_list_add(&comp_class
->node
, &component_class_list
);
1724 comp_class
->so_handle
= spec
->shared_lib_handle
;
1725 bt_object_get_ref_no_null_check(comp_class
->so_handle
);
1727 /* Add our custom destroy listener */
1728 bt_component_class_add_destroy_listener(comp_class
,
1729 plugin_comp_class_destroy_listener
, NULL
);