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 "PLUGIN-SO"
27 #include <babeltrace/lib-logging-internal.h>
29 #include <babeltrace/assert-internal.h>
30 #include <babeltrace/assert-pre-internal.h>
31 #include <babeltrace/compiler-internal.h>
32 #include <babeltrace/plugin/plugin-internal.h>
33 #include <babeltrace/plugin/plugin-so-internal.h>
34 #include <babeltrace/plugin/plugin-dev.h>
35 #include <babeltrace/plugin/plugin-internal.h>
36 #include <babeltrace/graph/component-class-internal.h>
37 #include <babeltrace/graph/component-class.h>
38 #include <babeltrace/graph/component-class-source.h>
39 #include <babeltrace/graph/component-class-filter.h>
40 #include <babeltrace/graph/component-class-sink.h>
41 #include <babeltrace/types.h>
42 #include <babeltrace/list-internal.h>
48 #define NATIVE_PLUGIN_SUFFIX "." G_MODULE_SUFFIX
49 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
50 #define LIBTOOL_PLUGIN_SUFFIX ".la"
51 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
53 #define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
54 sizeof(LIBTOOL_PLUGIN_SUFFIX))
59 * This list, global to the library, keeps all component classes that
60 * have a reference to their shared library handles. It allows iteration
61 * on all component classes still present when the destructor executes
62 * to release the shared library handle references they might still have.
64 * The list items are the component classes created with
65 * bt_plugin_add_component_class(). They keep the shared library handle
66 * object created by their plugin alive so that the plugin's code is
67 * not discarded when it could still be in use by living components
68 * created from those component classes:
70 * [component] --ref-> [component class]-> [shlib handle]
72 * It allows this use-case:
74 * my_plugins = bt_plugin_find_all_from_file("/path/to/my-plugin.so");
75 * // instantiate components from a plugin's component classes
76 * // put plugins and free my_plugins here
77 * // user code of instantiated components still exists
79 * An entry is removed from this list when a component class is
80 * destroyed thanks to a custom destroy listener. When the entry is
81 * removed, the entry is removed from the list, and we release the
82 * reference on the shlib handle. Assuming the original plugin object
83 * which contained some component classes is put first, when the last
84 * component class is removed from this list, the shared library handle
85 * object's reference count falls to zero and the shared library is
90 BT_LIST_HEAD(component_class_list
);
92 __attribute__((destructor
)) static
93 void fini_comp_class_list(void)
95 struct bt_component_class
*comp_class
, *tmp
;
97 bt_list_for_each_entry_safe(comp_class
, tmp
, &component_class_list
, node
) {
98 bt_list_del(&comp_class
->node
);
99 BT_OBJECT_PUT_REF_AND_RESET(comp_class
->so_handle
);
102 BT_LOGD_STR("Released references from all component classes to shared library handles.");
106 const char *bt_self_plugin_status_string(enum bt_self_plugin_status status
)
109 case BT_SELF_PLUGIN_STATUS_OK
:
110 return "BT_SELF_PLUGIN_STATUS_OK";
111 case BT_SELF_PLUGIN_STATUS_ERROR
:
112 return "BT_SELF_PLUGIN_STATUS_ERROR";
113 case BT_SELF_PLUGIN_STATUS_NOMEM
:
114 return "BT_SELF_PLUGIN_STATUS_NOMEM";
121 void bt_plugin_so_shared_lib_handle_destroy(struct bt_object
*obj
)
123 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
;
126 shared_lib_handle
= container_of(obj
,
127 struct bt_plugin_so_shared_lib_handle
, base
);
128 const char *path
= shared_lib_handle
->path
?
129 shared_lib_handle
->path
->str
: NULL
;
131 BT_LOGD("Destroying shared library handle: addr=%p, path=\"%s\"",
132 shared_lib_handle
, path
);
134 if (shared_lib_handle
->init_called
&& shared_lib_handle
->exit
) {
135 BT_LOGD_STR("Calling user's plugin exit function.");
136 shared_lib_handle
->exit();
137 BT_LOGD_STR("User function returned.");
140 if (shared_lib_handle
->module
) {
143 * Valgrind shows incomplete stack traces when
144 * dynamically loaded libraries are closed before it
145 * finishes. Use the BABELTRACE_NO_DLCLOSE in a debug
146 * build to avoid this.
148 const char *var
= getenv("BABELTRACE_NO_DLCLOSE");
150 if (!var
|| strcmp(var
, "1") != 0) {
152 BT_LOGD("Closing GModule: path=\"%s\"", path
);
154 if (!g_module_close(shared_lib_handle
->module
)) {
155 BT_LOGE("Cannot close GModule: %s: path=\"%s\"",
156 g_module_error(), path
);
159 shared_lib_handle
->module
= NULL
;
162 BT_LOGD("Not closing GModule because `BABELTRACE_NO_DLCLOSE=1`: "
163 "path=\"%s\"", path
);
168 if (shared_lib_handle
->path
) {
169 g_string_free(shared_lib_handle
->path
, TRUE
);
170 shared_lib_handle
->path
= NULL
;
173 g_free(shared_lib_handle
);
177 struct bt_plugin_so_shared_lib_handle
*bt_plugin_so_shared_lib_handle_create(
180 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
182 BT_LOGD("Creating shared library handle: path=\"%s\"", path
);
183 shared_lib_handle
= g_new0(struct bt_plugin_so_shared_lib_handle
, 1);
184 if (!shared_lib_handle
) {
185 BT_LOGE_STR("Failed to allocate one shared library handle.");
189 bt_object_init_shared(&shared_lib_handle
->base
,
190 bt_plugin_so_shared_lib_handle_destroy
);
196 shared_lib_handle
->path
= g_string_new(path
);
197 if (!shared_lib_handle
->path
) {
198 BT_LOGE_STR("Failed to allocate a GString.");
202 shared_lib_handle
->module
= g_module_open(path
, G_MODULE_BIND_LOCAL
);
203 if (!shared_lib_handle
->module
) {
205 * DEBUG-level logging because we're only _trying_ to
206 * open this file as a Babeltrace plugin: if it's not,
207 * it's not an error. And because this can be tried
208 * during bt_plugin_find_all_from_dir(), it's not even
211 BT_LOGD("Cannot open GModule: %s: path=\"%s\"",
212 g_module_error(), path
);
219 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
222 if (shared_lib_handle
) {
223 BT_LOGD("Created shared library handle: path=\"%s\", addr=%p",
224 path
, shared_lib_handle
);
227 return shared_lib_handle
;
231 void bt_plugin_so_destroy_spec_data(struct bt_plugin
*plugin
)
233 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
235 if (!plugin
->spec_data
) {
239 BT_ASSERT(plugin
->type
== BT_PLUGIN_TYPE_SO
);
241 BT_OBJECT_PUT_REF_AND_RESET(spec
->shared_lib_handle
);
242 g_free(plugin
->spec_data
);
243 plugin
->spec_data
= NULL
;
247 * This function does the following:
249 * 1. Iterate on the plugin descriptor attributes section and set the
250 * plugin's attributes depending on the attribute types. This
251 * includes the name of the plugin, its description, and its
252 * initialization function, for example.
254 * 2. Iterate on the component class descriptors section and create one
255 * "full descriptor" (temporary structure) for each one that is found
256 * and attached to our plugin descriptor.
258 * 3. Iterate on the component class descriptor attributes section and
259 * set the corresponding full descriptor's attributes depending on
260 * the attribute types. This includes the description of the
261 * component class, as well as its initialization and destroy
264 * 4. Call the user's plugin initialization function, if any is
267 * 5. For each full component class descriptor, create a component class
268 * object, set its optional attributes, and add it to the plugin
271 * 6. Freeze the plugin object.
274 enum bt_plugin_status
bt_plugin_so_init(
275 struct bt_plugin
*plugin
,
276 const struct __bt_plugin_descriptor
*descriptor
,
277 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
278 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
279 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
280 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
281 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
282 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
)
285 * This structure's members point to the plugin's memory
288 struct comp_class_full_descriptor
{
289 const struct __bt_plugin_component_class_descriptor
*descriptor
;
290 const char *description
;
295 bt_component_class_source_init_method init
;
296 bt_component_class_source_finalize_method finalize
;
297 bt_component_class_source_query_method query
;
298 bt_component_class_source_accept_output_port_connection_method accept_output_port_connection
;
299 bt_component_class_source_output_port_connected_method output_port_connected
;
300 bt_component_class_source_message_iterator_init_method msg_iter_init
;
301 bt_component_class_source_message_iterator_finalize_method msg_iter_finalize
;
305 bt_component_class_filter_init_method init
;
306 bt_component_class_filter_finalize_method finalize
;
307 bt_component_class_filter_query_method query
;
308 bt_component_class_filter_accept_input_port_connection_method accept_input_port_connection
;
309 bt_component_class_filter_accept_output_port_connection_method accept_output_port_connection
;
310 bt_component_class_filter_input_port_connected_method input_port_connected
;
311 bt_component_class_filter_output_port_connected_method output_port_connected
;
312 bt_component_class_filter_message_iterator_init_method msg_iter_init
;
313 bt_component_class_filter_message_iterator_finalize_method msg_iter_finalize
;
317 bt_component_class_sink_init_method init
;
318 bt_component_class_sink_finalize_method finalize
;
319 bt_component_class_sink_query_method query
;
320 bt_component_class_sink_accept_input_port_connection_method accept_input_port_connection
;
321 bt_component_class_sink_input_port_connected_method input_port_connected
;
326 enum bt_plugin_status status
= BT_PLUGIN_STATUS_OK
;
327 struct __bt_plugin_descriptor_attribute
const * const *cur_attr_ptr
;
328 struct __bt_plugin_component_class_descriptor
const * const *cur_cc_descr_ptr
;
329 struct __bt_plugin_component_class_descriptor_attribute
const * const *cur_cc_descr_attr_ptr
;
330 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
331 GArray
*comp_class_full_descriptors
;
335 BT_LOGD("Initializing plugin object from descriptors found in sections: "
336 "plugin-addr=%p, plugin-path=\"%s\", "
337 "attrs-begin-addr=%p, attrs-end-addr=%p, "
338 "cc-descr-begin-addr=%p, cc-descr-end-addr=%p, "
339 "cc-descr-attrs-begin-addr=%p, cc-descr-attrs-end-addr=%p",
341 spec
->shared_lib_handle
->path
?
342 spec
->shared_lib_handle
->path
->str
: NULL
,
343 attrs_begin
, attrs_end
,
344 cc_descriptors_begin
, cc_descriptors_end
,
345 cc_descr_attrs_begin
, cc_descr_attrs_end
);
346 comp_class_full_descriptors
= g_array_new(FALSE
, TRUE
,
347 sizeof(struct comp_class_full_descriptor
));
348 if (!comp_class_full_descriptors
) {
349 BT_LOGE_STR("Failed to allocate a GArray.");
350 status
= BT_PLUGIN_STATUS_ERROR
;
354 /* Set mandatory attributes */
355 spec
->descriptor
= descriptor
;
356 bt_plugin_set_name(plugin
, descriptor
->name
);
359 * Find and set optional attributes attached to this plugin
362 for (cur_attr_ptr
= attrs_begin
; cur_attr_ptr
!= attrs_end
; cur_attr_ptr
++) {
363 const struct __bt_plugin_descriptor_attribute
*cur_attr
=
366 if (cur_attr
== NULL
) {
370 if (cur_attr
->plugin_descriptor
!= descriptor
) {
374 switch (cur_attr
->type
) {
375 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_INIT
:
376 spec
->init
= cur_attr
->value
.init
;
378 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT
:
379 spec
->shared_lib_handle
->exit
= cur_attr
->value
.exit
;
381 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_AUTHOR
:
382 bt_plugin_set_author(plugin
, cur_attr
->value
.author
);
384 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_LICENSE
:
385 bt_plugin_set_license(plugin
, cur_attr
->value
.license
);
387 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
388 bt_plugin_set_description(plugin
, cur_attr
->value
.description
);
390 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_VERSION
:
391 bt_plugin_set_version(plugin
,
392 (unsigned int) cur_attr
->value
.version
.major
,
393 (unsigned int) cur_attr
->value
.version
.minor
,
394 (unsigned int) cur_attr
->value
.version
.patch
,
395 cur_attr
->value
.version
.extra
);
399 * WARN-level logging because this should not
400 * happen with the appropriate ABI version. If
401 * we're here, we know that for the reported
402 * version of the ABI, this attribute is
405 BT_LOGW("Ignoring unknown plugin descriptor attribute: "
406 "plugin-path=\"%s\", plugin-name=\"%s\", "
407 "attr-type-name=\"%s\", attr-type-id=%d",
408 spec
->shared_lib_handle
->path
?
409 spec
->shared_lib_handle
->path
->str
:
411 descriptor
->name
, cur_attr
->type_name
,
418 * Find component class descriptors attached to this plugin
419 * descriptor and initialize corresponding full component class
420 * descriptors in the array.
422 for (cur_cc_descr_ptr
= cc_descriptors_begin
; cur_cc_descr_ptr
!= cc_descriptors_end
; cur_cc_descr_ptr
++) {
423 const struct __bt_plugin_component_class_descriptor
*cur_cc_descr
=
425 struct comp_class_full_descriptor full_descriptor
= {0};
427 if (cur_cc_descr
== NULL
) {
431 if (cur_cc_descr
->plugin_descriptor
!= descriptor
) {
435 full_descriptor
.descriptor
= cur_cc_descr
;
436 g_array_append_val(comp_class_full_descriptors
,
441 * Find component class descriptor attributes attached to this
442 * plugin descriptor and update corresponding full component
443 * class descriptors in the array.
445 for (cur_cc_descr_attr_ptr
= cc_descr_attrs_begin
; cur_cc_descr_attr_ptr
!= cc_descr_attrs_end
; cur_cc_descr_attr_ptr
++) {
446 const struct __bt_plugin_component_class_descriptor_attribute
*cur_cc_descr_attr
=
447 *cur_cc_descr_attr_ptr
;
448 enum bt_component_class_type cc_type
;
450 if (cur_cc_descr_attr
== NULL
) {
454 if (cur_cc_descr_attr
->comp_class_descriptor
->plugin_descriptor
!=
459 cc_type
= cur_cc_descr_attr
->comp_class_descriptor
->type
;
461 /* Find the corresponding component class descriptor entry */
462 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
463 struct comp_class_full_descriptor
*cc_full_descr
=
464 &g_array_index(comp_class_full_descriptors
,
465 struct comp_class_full_descriptor
, i
);
467 if (cur_cc_descr_attr
->comp_class_descriptor
!=
468 cc_full_descr
->descriptor
) {
472 switch (cur_cc_descr_attr
->type
) {
473 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
474 cc_full_descr
->description
=
475 cur_cc_descr_attr
->value
.description
;
477 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_HELP
:
478 cc_full_descr
->help
=
479 cur_cc_descr_attr
->value
.help
;
481 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INIT_METHOD
:
483 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
484 cc_full_descr
->methods
.source
.init
=
485 cur_cc_descr_attr
->value
.source_init_method
;
487 case BT_COMPONENT_CLASS_TYPE_FILTER
:
488 cc_full_descr
->methods
.filter
.init
=
489 cur_cc_descr_attr
->value
.filter_init_method
;
491 case BT_COMPONENT_CLASS_TYPE_SINK
:
492 cc_full_descr
->methods
.sink
.init
=
493 cur_cc_descr_attr
->value
.sink_init_method
;
499 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_FINALIZE_METHOD
:
501 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
502 cc_full_descr
->methods
.source
.finalize
=
503 cur_cc_descr_attr
->value
.source_finalize_method
;
505 case BT_COMPONENT_CLASS_TYPE_FILTER
:
506 cc_full_descr
->methods
.filter
.finalize
=
507 cur_cc_descr_attr
->value
.filter_finalize_method
;
509 case BT_COMPONENT_CLASS_TYPE_SINK
:
510 cc_full_descr
->methods
.sink
.finalize
=
511 cur_cc_descr_attr
->value
.sink_finalize_method
;
517 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_QUERY_METHOD
:
519 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
520 cc_full_descr
->methods
.source
.query
=
521 cur_cc_descr_attr
->value
.source_query_method
;
523 case BT_COMPONENT_CLASS_TYPE_FILTER
:
524 cc_full_descr
->methods
.filter
.query
=
525 cur_cc_descr_attr
->value
.filter_query_method
;
527 case BT_COMPONENT_CLASS_TYPE_SINK
:
528 cc_full_descr
->methods
.sink
.query
=
529 cur_cc_descr_attr
->value
.sink_query_method
;
535 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_ACCEPT_INPUT_PORT_CONNECTION_METHOD
:
537 case BT_COMPONENT_CLASS_TYPE_FILTER
:
538 cc_full_descr
->methods
.filter
.accept_input_port_connection
=
539 cur_cc_descr_attr
->value
.filter_accept_input_port_connection_method
;
541 case BT_COMPONENT_CLASS_TYPE_SINK
:
542 cc_full_descr
->methods
.sink
.accept_input_port_connection
=
543 cur_cc_descr_attr
->value
.sink_accept_input_port_connection_method
;
549 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_ACCEPT_OUTPUT_PORT_CONNECTION_METHOD
:
551 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
552 cc_full_descr
->methods
.source
.accept_output_port_connection
=
553 cur_cc_descr_attr
->value
.source_accept_output_port_connection_method
;
555 case BT_COMPONENT_CLASS_TYPE_FILTER
:
556 cc_full_descr
->methods
.filter
.accept_output_port_connection
=
557 cur_cc_descr_attr
->value
.filter_accept_output_port_connection_method
;
563 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INPUT_PORT_CONNECTED_METHOD
:
565 case BT_COMPONENT_CLASS_TYPE_FILTER
:
566 cc_full_descr
->methods
.filter
.input_port_connected
=
567 cur_cc_descr_attr
->value
.filter_input_port_connected_method
;
569 case BT_COMPONENT_CLASS_TYPE_SINK
:
570 cc_full_descr
->methods
.sink
.input_port_connected
=
571 cur_cc_descr_attr
->value
.sink_input_port_connected_method
;
577 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_OUTPUT_PORT_CONNECTED_METHOD
:
579 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
580 cc_full_descr
->methods
.source
.output_port_connected
=
581 cur_cc_descr_attr
->value
.source_output_port_connected_method
;
583 case BT_COMPONENT_CLASS_TYPE_FILTER
:
584 cc_full_descr
->methods
.filter
.output_port_connected
=
585 cur_cc_descr_attr
->value
.filter_output_port_connected_method
;
591 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_INIT_METHOD
:
593 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
594 cc_full_descr
->methods
.source
.msg_iter_init
=
595 cur_cc_descr_attr
->value
.source_msg_iter_init_method
;
597 case BT_COMPONENT_CLASS_TYPE_FILTER
:
598 cc_full_descr
->methods
.filter
.msg_iter_init
=
599 cur_cc_descr_attr
->value
.filter_msg_iter_init_method
;
605 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_MSG_ITER_FINALIZE_METHOD
:
607 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
608 cc_full_descr
->methods
.source
.msg_iter_finalize
=
609 cur_cc_descr_attr
->value
.source_msg_iter_finalize_method
;
611 case BT_COMPONENT_CLASS_TYPE_FILTER
:
612 cc_full_descr
->methods
.filter
.msg_iter_finalize
=
613 cur_cc_descr_attr
->value
.filter_msg_iter_finalize_method
;
621 * WARN-level logging because this
622 * should not happen with the
623 * appropriate ABI version. If we're
624 * here, we know that for the reported
625 * version of the ABI, this attribute is
628 BT_LOGW("Ignoring unknown component class descriptor attribute: "
629 "plugin-path=\"%s\", "
630 "plugin-name=\"%s\", "
631 "comp-class-name=\"%s\", "
632 "comp-class-type=%s, "
633 "attr-type-name=\"%s\", "
635 spec
->shared_lib_handle
->path
?
636 spec
->shared_lib_handle
->path
->str
:
639 cur_cc_descr_attr
->comp_class_descriptor
->name
,
640 bt_component_class_type_string(
641 cur_cc_descr_attr
->comp_class_descriptor
->type
),
642 cur_cc_descr_attr
->type_name
,
643 cur_cc_descr_attr
->type
);
649 /* Initialize plugin */
651 enum bt_self_plugin_status init_status
;
653 BT_LOGD_STR("Calling user's plugin initialization function.");
654 init_status
= spec
->init((void *) plugin
);
655 BT_LOGD("User function returned: %s",
656 bt_self_plugin_status_string(init_status
));
658 if (init_status
< 0) {
659 BT_LOGW_STR("User's plugin initialization function failed.");
660 status
= BT_PLUGIN_STATUS_ERROR
;
665 spec
->shared_lib_handle
->init_called
= BT_TRUE
;
667 /* Add described component classes to plugin */
668 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
669 struct comp_class_full_descriptor
*cc_full_descr
=
670 &g_array_index(comp_class_full_descriptors
,
671 struct comp_class_full_descriptor
, i
);
672 struct bt_component_class
*comp_class
= NULL
;
673 struct bt_component_class_source
*src_comp_class
= NULL
;
674 struct bt_component_class_filter
*flt_comp_class
= NULL
;
675 struct bt_component_class_sink
*sink_comp_class
= NULL
;
677 BT_LOGD("Creating and setting properties of plugin's component class: "
678 "plugin-path=\"%s\", plugin-name=\"%s\", "
679 "comp-class-name=\"%s\", comp-class-type=%s",
680 spec
->shared_lib_handle
->path
?
681 spec
->shared_lib_handle
->path
->str
:
684 cc_full_descr
->descriptor
->name
,
685 bt_component_class_type_string(
686 cc_full_descr
->descriptor
->type
));
688 switch (cc_full_descr
->descriptor
->type
) {
689 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
690 src_comp_class
= bt_component_class_source_create(
691 cc_full_descr
->descriptor
->name
,
692 cc_full_descr
->descriptor
->methods
.source
.msg_iter_next
);
693 comp_class
= bt_component_class_source_as_component_class(
696 case BT_COMPONENT_CLASS_TYPE_FILTER
:
697 flt_comp_class
= bt_component_class_filter_create(
698 cc_full_descr
->descriptor
->name
,
699 cc_full_descr
->descriptor
->methods
.source
.msg_iter_next
);
700 comp_class
= bt_component_class_filter_as_component_class(
703 case BT_COMPONENT_CLASS_TYPE_SINK
:
704 sink_comp_class
= bt_component_class_sink_create(
705 cc_full_descr
->descriptor
->name
,
706 cc_full_descr
->descriptor
->methods
.sink
.consume
);
707 comp_class
= bt_component_class_sink_as_component_class(
712 * WARN-level logging because this should not
713 * happen with the appropriate ABI version. If
714 * we're here, we know that for the reported
715 * version of the ABI, this component class type
718 BT_LOGW("Ignoring unknown component class type: "
719 "plugin-path=\"%s\", plugin-name=\"%s\", "
720 "comp-class-name=\"%s\", comp-class-type=%d",
721 spec
->shared_lib_handle
->path
->str
?
722 spec
->shared_lib_handle
->path
->str
:
725 cc_full_descr
->descriptor
->name
,
726 cc_full_descr
->descriptor
->type
);
731 BT_LOGE_STR("Cannot create component class.");
732 status
= BT_PLUGIN_STATUS_ERROR
;
736 if (cc_full_descr
->description
) {
737 ret
= bt_component_class_set_description(
738 comp_class
, cc_full_descr
->description
);
740 BT_LOGE_STR("Cannot set component class's description.");
741 status
= BT_PLUGIN_STATUS_ERROR
;
742 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
747 if (cc_full_descr
->help
) {
748 ret
= bt_component_class_set_help(comp_class
,
749 cc_full_descr
->help
);
751 BT_LOGE_STR("Cannot set component class's help string.");
752 status
= BT_PLUGIN_STATUS_ERROR
;
753 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
758 switch (cc_full_descr
->descriptor
->type
) {
759 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
760 if (cc_full_descr
->methods
.source
.init
) {
761 ret
= bt_component_class_source_set_init_method(
763 cc_full_descr
->methods
.source
.init
);
765 BT_LOGE_STR("Cannot set source component class's initialization method.");
766 status
= BT_PLUGIN_STATUS_ERROR
;
767 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
772 if (cc_full_descr
->methods
.source
.finalize
) {
773 ret
= bt_component_class_source_set_finalize_method(
775 cc_full_descr
->methods
.source
.finalize
);
777 BT_LOGE_STR("Cannot set source component class's finalization method.");
778 status
= BT_PLUGIN_STATUS_ERROR
;
779 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
784 if (cc_full_descr
->methods
.source
.query
) {
785 ret
= bt_component_class_source_set_query_method(
787 cc_full_descr
->methods
.source
.query
);
789 BT_LOGE_STR("Cannot set source component class's query method.");
790 status
= BT_PLUGIN_STATUS_ERROR
;
791 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
796 if (cc_full_descr
->methods
.source
.accept_output_port_connection
) {
797 ret
= bt_component_class_source_set_accept_output_port_connection_method(
799 cc_full_descr
->methods
.source
.accept_output_port_connection
);
801 BT_LOGE_STR("Cannot set source component class's \"accept input output connection\" method.");
802 status
= BT_PLUGIN_STATUS_ERROR
;
803 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
808 if (cc_full_descr
->methods
.source
.output_port_connected
) {
809 ret
= bt_component_class_source_set_output_port_connected_method(
811 cc_full_descr
->methods
.source
.output_port_connected
);
813 BT_LOGE_STR("Cannot set source component class's \"output port connected\" method.");
814 status
= BT_PLUGIN_STATUS_ERROR
;
815 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
820 if (cc_full_descr
->methods
.source
.msg_iter_init
) {
821 ret
= bt_component_class_source_set_message_iterator_init_method(
823 cc_full_descr
->methods
.source
.msg_iter_init
);
825 BT_LOGE_STR("Cannot set source component class's message iterator initialization method.");
826 status
= BT_PLUGIN_STATUS_ERROR
;
827 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
832 if (cc_full_descr
->methods
.source
.msg_iter_finalize
) {
833 ret
= bt_component_class_source_set_message_iterator_finalize_method(
835 cc_full_descr
->methods
.source
.msg_iter_finalize
);
837 BT_LOGE_STR("Cannot set source component class's message iterator finalization method.");
838 status
= BT_PLUGIN_STATUS_ERROR
;
839 BT_OBJECT_PUT_REF_AND_RESET(src_comp_class
);
845 case BT_COMPONENT_CLASS_TYPE_FILTER
:
846 if (cc_full_descr
->methods
.filter
.init
) {
847 ret
= bt_component_class_filter_set_init_method(
849 cc_full_descr
->methods
.filter
.init
);
851 BT_LOGE_STR("Cannot set filter component class's initialization method.");
852 status
= BT_PLUGIN_STATUS_ERROR
;
853 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
858 if (cc_full_descr
->methods
.filter
.finalize
) {
859 ret
= bt_component_class_filter_set_finalize_method(
861 cc_full_descr
->methods
.filter
.finalize
);
863 BT_LOGE_STR("Cannot set filter component class's finalization method.");
864 status
= BT_PLUGIN_STATUS_ERROR
;
865 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
870 if (cc_full_descr
->methods
.filter
.query
) {
871 ret
= bt_component_class_filter_set_query_method(
873 cc_full_descr
->methods
.filter
.query
);
875 BT_LOGE_STR("Cannot set filter component class's query method.");
876 status
= BT_PLUGIN_STATUS_ERROR
;
877 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
882 if (cc_full_descr
->methods
.filter
.accept_input_port_connection
) {
883 ret
= bt_component_class_filter_set_accept_input_port_connection_method(
885 cc_full_descr
->methods
.filter
.accept_input_port_connection
);
887 BT_LOGE_STR("Cannot set filter component class's \"accept input port connection\" method.");
888 status
= BT_PLUGIN_STATUS_ERROR
;
889 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
894 if (cc_full_descr
->methods
.filter
.accept_output_port_connection
) {
895 ret
= bt_component_class_filter_set_accept_output_port_connection_method(
897 cc_full_descr
->methods
.filter
.accept_output_port_connection
);
899 BT_LOGE_STR("Cannot set filter component class's \"accept input output connection\" method.");
900 status
= BT_PLUGIN_STATUS_ERROR
;
901 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
906 if (cc_full_descr
->methods
.filter
.input_port_connected
) {
907 ret
= bt_component_class_filter_set_input_port_connected_method(
909 cc_full_descr
->methods
.filter
.input_port_connected
);
911 BT_LOGE_STR("Cannot set filter component class's \"input port connected\" method.");
912 status
= BT_PLUGIN_STATUS_ERROR
;
913 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
918 if (cc_full_descr
->methods
.filter
.output_port_connected
) {
919 ret
= bt_component_class_filter_set_output_port_connected_method(
921 cc_full_descr
->methods
.filter
.output_port_connected
);
923 BT_LOGE_STR("Cannot set filter component class's \"output port connected\" method.");
924 status
= BT_PLUGIN_STATUS_ERROR
;
925 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
930 if (cc_full_descr
->methods
.filter
.msg_iter_init
) {
931 ret
= bt_component_class_filter_set_message_iterator_init_method(
933 cc_full_descr
->methods
.filter
.msg_iter_init
);
935 BT_LOGE_STR("Cannot set filter component class's message iterator initialization method.");
936 status
= BT_PLUGIN_STATUS_ERROR
;
937 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
942 if (cc_full_descr
->methods
.filter
.msg_iter_finalize
) {
943 ret
= bt_component_class_filter_set_message_iterator_finalize_method(
945 cc_full_descr
->methods
.filter
.msg_iter_finalize
);
947 BT_LOGE_STR("Cannot set filter component class's message iterator finalization method.");
948 status
= BT_PLUGIN_STATUS_ERROR
;
949 BT_OBJECT_PUT_REF_AND_RESET(flt_comp_class
);
955 case BT_COMPONENT_CLASS_TYPE_SINK
:
956 if (cc_full_descr
->methods
.sink
.init
) {
957 ret
= bt_component_class_sink_set_init_method(
959 cc_full_descr
->methods
.sink
.init
);
961 BT_LOGE_STR("Cannot set sink component class's initialization method.");
962 status
= BT_PLUGIN_STATUS_ERROR
;
963 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
968 if (cc_full_descr
->methods
.sink
.finalize
) {
969 ret
= bt_component_class_sink_set_finalize_method(
971 cc_full_descr
->methods
.sink
.finalize
);
973 BT_LOGE_STR("Cannot set sink component class's finalization method.");
974 status
= BT_PLUGIN_STATUS_ERROR
;
975 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
980 if (cc_full_descr
->methods
.sink
.query
) {
981 ret
= bt_component_class_sink_set_query_method(
983 cc_full_descr
->methods
.sink
.query
);
985 BT_LOGE_STR("Cannot set sink component class's query method.");
986 status
= BT_PLUGIN_STATUS_ERROR
;
987 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
992 if (cc_full_descr
->methods
.sink
.accept_input_port_connection
) {
993 ret
= bt_component_class_sink_set_accept_input_port_connection_method(
995 cc_full_descr
->methods
.sink
.accept_input_port_connection
);
997 BT_LOGE_STR("Cannot set sink component class's \"accept input port connection\" method.");
998 status
= BT_PLUGIN_STATUS_ERROR
;
999 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1004 if (cc_full_descr
->methods
.sink
.input_port_connected
) {
1005 ret
= bt_component_class_sink_set_input_port_connected_method(
1007 cc_full_descr
->methods
.sink
.input_port_connected
);
1009 BT_LOGE_STR("Cannot set sink component class's \"input port connected\" method.");
1010 status
= BT_PLUGIN_STATUS_ERROR
;
1011 BT_OBJECT_PUT_REF_AND_RESET(sink_comp_class
);
1022 * Add component class to the plugin object.
1024 * This will call back
1025 * bt_plugin_so_on_add_component_class() so that we can
1026 * add a mapping in the component class list when we
1027 * know the component class is successfully added.
1029 status
= bt_plugin_add_component_class(plugin
,
1030 (void *) comp_class
);
1031 BT_OBJECT_PUT_REF_AND_RESET(comp_class
);
1033 BT_LOGE("Cannot add component class to plugin.");
1039 g_array_free(comp_class_full_descriptors
, TRUE
);
1044 struct bt_plugin
*bt_plugin_so_create_empty(
1045 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
)
1047 struct bt_plugin
*plugin
;
1048 struct bt_plugin_so_spec_data
*spec
;
1050 plugin
= bt_plugin_create_empty(BT_PLUGIN_TYPE_SO
);
1055 plugin
->destroy_spec_data
= bt_plugin_so_destroy_spec_data
;
1056 plugin
->spec_data
= g_new0(struct bt_plugin_so_spec_data
, 1);
1057 if (!plugin
->spec_data
) {
1058 BT_LOGE_STR("Failed to allocate one SO plugin specific data structure.");
1062 spec
= plugin
->spec_data
;
1063 spec
->shared_lib_handle
= shared_lib_handle
;
1064 bt_object_get_no_null_check(spec
->shared_lib_handle
);
1068 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1075 size_t count_non_null_items_in_section(const void *begin
, const void *end
)
1078 const int * const *begin_int
= (const int * const *) begin
;
1079 const int * const *end_int
= (const int * const *) end
;
1080 const int * const *iter
;
1082 for (iter
= begin_int
; iter
!= end_int
; iter
++) {
1092 struct bt_plugin_set
*bt_plugin_so_create_all_from_sections(
1093 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
,
1094 struct __bt_plugin_descriptor
const * const *descriptors_begin
,
1095 struct __bt_plugin_descriptor
const * const *descriptors_end
,
1096 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
1097 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
1098 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
1099 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
1100 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
1101 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
)
1103 size_t descriptor_count
;
1105 size_t cc_descriptors_count
;
1106 size_t cc_descr_attrs_count
;
1108 struct bt_plugin_set
*plugin_set
= NULL
;
1110 descriptor_count
= count_non_null_items_in_section(descriptors_begin
, descriptors_end
);
1111 attrs_count
= count_non_null_items_in_section(attrs_begin
, attrs_end
);
1112 cc_descriptors_count
= count_non_null_items_in_section(cc_descriptors_begin
, cc_descriptors_end
);
1113 cc_descr_attrs_count
= count_non_null_items_in_section(cc_descr_attrs_begin
, cc_descr_attrs_end
);
1115 BT_LOGD("Creating all SO plugins from sections: "
1116 "plugin-path=\"%s\", "
1117 "descr-begin-addr=%p, descr-end-addr=%p, "
1118 "attrs-begin-addr=%p, attrs-end-addr=%p, "
1119 "cc-descr-begin-addr=%p, cc-descr-end-addr=%p, "
1120 "cc-descr-attrs-begin-addr=%p, cc-descr-attrs-end-addr=%p, "
1121 "descr-count=%zu, attrs-count=%zu, "
1122 "cc-descr-count=%zu, cc-descr-attrs-count=%zu",
1123 shared_lib_handle
->path
? shared_lib_handle
->path
->str
: NULL
,
1124 descriptors_begin
, descriptors_end
,
1125 attrs_begin
, attrs_end
,
1126 cc_descriptors_begin
, cc_descriptors_end
,
1127 cc_descr_attrs_begin
, cc_descr_attrs_end
,
1128 descriptor_count
, attrs_count
,
1129 cc_descriptors_count
, cc_descr_attrs_count
);
1130 plugin_set
= bt_plugin_set_create();
1132 BT_LOGE_STR("Cannot create empty plugin set.");
1136 for (i
= 0; i
< descriptors_end
- descriptors_begin
; i
++) {
1137 enum bt_plugin_status status
;
1138 const struct __bt_plugin_descriptor
*descriptor
=
1139 descriptors_begin
[i
];
1140 struct bt_plugin
*plugin
;
1142 if (descriptor
== NULL
) {
1146 BT_LOGD("Creating plugin object for plugin: "
1147 "name=\"%s\", abi-major=%d, abi-minor=%d",
1148 descriptor
->name
, descriptor
->major
, descriptor
->minor
);
1150 if (descriptor
->major
> __BT_PLUGIN_VERSION_MAJOR
) {
1152 * DEBUG-level logging because we're only
1153 * _trying_ to open this file as a compatible
1154 * Babeltrace plugin: if it's not, it's not an
1155 * error. And because this can be tried during
1156 * bt_plugin_find_all_from_dir(), it's not
1159 BT_LOGD("Unknown ABI major version: abi-major=%d",
1164 plugin
= bt_plugin_so_create_empty(shared_lib_handle
);
1166 BT_LOGE_STR("Cannot create empty shared library handle.");
1170 if (shared_lib_handle
&& shared_lib_handle
->path
) {
1171 bt_plugin_set_path(plugin
, shared_lib_handle
->path
->str
);
1174 status
= bt_plugin_so_init(plugin
, descriptor
, attrs_begin
,
1175 attrs_end
, cc_descriptors_begin
, cc_descriptors_end
,
1176 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1179 * DEBUG-level logging because we're only
1180 * _trying_ to open this file as a compatible
1181 * Babeltrace plugin: if it's not, it's not an
1182 * error. And because this can be tried during
1183 * bt_plugin_find_all_from_dir(), it's not
1186 BT_LOGD_STR("Cannot initialize SO plugin object from sections.");
1187 BT_OBJECT_PUT_REF_AND_RESET(plugin
);
1191 /* Add to plugin set */
1192 bt_plugin_set_add_plugin(plugin_set
, plugin
);
1193 bt_object_put_ref(plugin
);
1199 BT_OBJECT_PUT_REF_AND_RESET(plugin_set
);
1206 struct bt_plugin_set
*bt_plugin_so_create_all_from_static(void)
1208 struct bt_plugin_set
*plugin_set
= NULL
;
1209 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
=
1210 bt_plugin_so_shared_lib_handle_create(NULL
);
1212 if (!shared_lib_handle
) {
1216 BT_LOGD_STR("Creating all SO plugins from built-in plugins.");
1217 plugin_set
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
1218 __bt_get_begin_section_plugin_descriptors(),
1219 __bt_get_end_section_plugin_descriptors(),
1220 __bt_get_begin_section_plugin_descriptor_attributes(),
1221 __bt_get_end_section_plugin_descriptor_attributes(),
1222 __bt_get_begin_section_component_class_descriptors(),
1223 __bt_get_end_section_component_class_descriptors(),
1224 __bt_get_begin_section_component_class_descriptor_attributes(),
1225 __bt_get_end_section_component_class_descriptor_attributes());
1228 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
1234 struct bt_plugin_set
*bt_plugin_so_create_all_from_file(const char *path
)
1237 struct bt_plugin_set
*plugin_set
= NULL
;
1238 struct __bt_plugin_descriptor
const * const *descriptors_begin
= NULL
;
1239 struct __bt_plugin_descriptor
const * const *descriptors_end
= NULL
;
1240 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
= NULL
;
1241 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
= NULL
;
1242 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
= NULL
;
1243 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
= NULL
;
1244 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
= NULL
;
1245 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
= NULL
;
1246 struct __bt_plugin_descriptor
const * const *(*get_begin_section_plugin_descriptors
)(void);
1247 struct __bt_plugin_descriptor
const * const *(*get_end_section_plugin_descriptors
)(void);
1248 struct __bt_plugin_descriptor_attribute
const * const *(*get_begin_section_plugin_descriptor_attributes
)(void);
1249 struct __bt_plugin_descriptor_attribute
const * const *(*get_end_section_plugin_descriptor_attributes
)(void);
1250 struct __bt_plugin_component_class_descriptor
const * const *(*get_begin_section_component_class_descriptors
)(void);
1251 struct __bt_plugin_component_class_descriptor
const * const *(*get_end_section_component_class_descriptors
)(void);
1252 struct __bt_plugin_component_class_descriptor_attribute
const * const *(*get_begin_section_component_class_descriptor_attributes
)(void);
1253 struct __bt_plugin_component_class_descriptor_attribute
const * const *(*get_end_section_component_class_descriptor_attributes
)(void);
1254 bt_bool is_libtool_wrapper
= BT_FALSE
, is_shared_object
= BT_FALSE
;
1255 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
1258 BT_LOGW_STR("Invalid parameter: path is NULL.");
1262 BT_LOGD("Creating all SO plugins from file: path=\"%s\"", path
);
1263 path_len
= strlen(path
);
1264 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
1265 BT_LOGW("Invalid parameter: path length is too short: "
1266 "path-length=%zu", path_len
);
1272 * Check if the file ends with a known plugin file type suffix (i.e. .so
1275 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
1276 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
1277 LIBTOOL_PLUGIN_SUFFIX_LEN
);
1278 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
1279 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
1280 NATIVE_PLUGIN_SUFFIX_LEN
);
1281 if (!is_shared_object
&& !is_libtool_wrapper
) {
1282 /* Name indicates this is not a plugin file; not an error */
1283 BT_LOGV("File is not a SO plugin file: path=\"%s\"", path
);
1287 shared_lib_handle
= bt_plugin_so_shared_lib_handle_create(path
);
1288 if (!shared_lib_handle
) {
1289 BT_LOGD_STR("Cannot create shared library handle.");
1293 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_plugin_descriptors",
1294 (gpointer
*) &get_begin_section_plugin_descriptors
)) {
1295 descriptors_begin
= get_begin_section_plugin_descriptors();
1297 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1298 "symbol=\"%s\"", path
,
1299 "__bt_get_begin_section_plugin_descriptors");
1303 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_plugin_descriptors",
1304 (gpointer
*) &get_end_section_plugin_descriptors
)) {
1305 descriptors_end
= get_end_section_plugin_descriptors();
1307 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1308 "symbol=\"%s\"", path
,
1309 "__bt_get_end_section_plugin_descriptors");
1313 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_plugin_descriptor_attributes",
1314 (gpointer
*) &get_begin_section_plugin_descriptor_attributes
)) {
1315 attrs_begin
= get_begin_section_plugin_descriptor_attributes();
1317 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1318 "symbol=\"%s\"", path
,
1319 "__bt_get_begin_section_plugin_descriptor_attributes");
1322 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_plugin_descriptor_attributes",
1323 (gpointer
*) &get_end_section_plugin_descriptor_attributes
)) {
1324 attrs_end
= get_end_section_plugin_descriptor_attributes();
1326 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1327 "symbol=\"%s\"", path
,
1328 "__bt_get_end_section_plugin_descriptor_attributes");
1331 if ((!!attrs_begin
- !!attrs_end
) != 0) {
1332 BT_LOGD("Found section start or end symbol, but not both: "
1333 "path=\"%s\", symbol-start=\"%s\", "
1334 "symbol-end=\"%s\", symbol-start-addr=%p, "
1335 "symbol-end-addr=%p",
1336 path
, "__bt_get_begin_section_plugin_descriptor_attributes",
1337 "__bt_get_end_section_plugin_descriptor_attributes",
1338 attrs_begin
, attrs_end
);
1342 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_component_class_descriptors",
1343 (gpointer
*) &get_begin_section_component_class_descriptors
)) {
1344 cc_descriptors_begin
= get_begin_section_component_class_descriptors();
1346 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1347 "symbol=\"%s\"", path
,
1348 "__bt_get_begin_section_component_class_descriptors");
1351 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_component_class_descriptors",
1352 (gpointer
*) &get_end_section_component_class_descriptors
)) {
1353 cc_descriptors_end
= get_end_section_component_class_descriptors();
1355 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1356 "symbol=\"%s\"", path
,
1357 "__bt_get_end_section_component_class_descriptors");
1360 if ((!!cc_descriptors_begin
- !!cc_descriptors_end
) != 0) {
1361 BT_LOGD("Found section start or end symbol, but not both: "
1362 "path=\"%s\", symbol-start=\"%s\", "
1363 "symbol-end=\"%s\", symbol-start-addr=%p, "
1364 "symbol-end-addr=%p",
1365 path
, "__bt_get_begin_section_component_class_descriptors",
1366 "__bt_get_end_section_component_class_descriptors",
1367 cc_descriptors_begin
, cc_descriptors_end
);
1371 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_begin_section_component_class_descriptor_attributes",
1372 (gpointer
*) &get_begin_section_component_class_descriptor_attributes
)) {
1373 cc_descr_attrs_begin
= get_begin_section_component_class_descriptor_attributes();
1375 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1376 "symbol=\"%s\"", path
,
1377 "__bt_get_begin_section_component_class_descriptor_attributes");
1380 if (g_module_symbol(shared_lib_handle
->module
, "__bt_get_end_section_component_class_descriptor_attributes",
1381 (gpointer
*) &get_end_section_component_class_descriptor_attributes
)) {
1382 cc_descr_attrs_end
= get_end_section_component_class_descriptor_attributes();
1384 BT_LOGD("Cannot resolve plugin symbol: path=\"%s\", "
1385 "symbol=\"%s\"", path
,
1386 "__bt_get_end_section_component_class_descriptor_attributes");
1389 if ((!!cc_descr_attrs_begin
- !!cc_descr_attrs_end
) != 0) {
1390 BT_LOGD("Found section start or end symbol, but not both: "
1391 "path=\"%s\", symbol-start=\"%s\", "
1392 "symbol-end=\"%s\", symbol-start-addr=%p, "
1393 "symbol-end-addr=%p",
1394 path
, "__bt_get_begin_section_component_class_descriptor_attributes",
1395 "__bt_get_end_section_component_class_descriptor_attributes",
1396 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1400 /* Initialize plugin */
1401 BT_LOGD_STR("Initializing plugin object.");
1402 plugin_set
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
1403 descriptors_begin
, descriptors_end
, attrs_begin
, attrs_end
,
1404 cc_descriptors_begin
, cc_descriptors_end
,
1405 cc_descr_attrs_begin
, cc_descr_attrs_end
);
1408 BT_OBJECT_PUT_REF_AND_RESET(shared_lib_handle
);
1413 void plugin_comp_class_destroy_listener(struct bt_component_class
*comp_class
,
1416 bt_list_del(&comp_class
->node
);
1417 BT_OBJECT_PUT_REF_AND_RESET(comp_class
->so_handle
);
1418 BT_LOGV("Component class destroyed: removed entry from list: "
1419 "comp-cls-addr=%p", comp_class
);
1423 void bt_plugin_so_on_add_component_class(struct bt_plugin
*plugin
,
1424 struct bt_component_class
*comp_class
)
1426 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
1428 BT_ASSERT(plugin
->spec_data
);
1429 BT_ASSERT(plugin
->type
== BT_PLUGIN_TYPE_SO
);
1431 bt_list_add(&comp_class
->node
, &component_class_list
);
1432 comp_class
->so_handle
= spec
->shared_lib_handle
;
1433 bt_object_get_no_null_check(comp_class
->so_handle
);
1435 /* Add our custom destroy listener */
1436 bt_component_class_add_destroy_listener(comp_class
,
1437 plugin_comp_class_destroy_listener
, NULL
);