4 * Babeltrace Plugin (shared object)
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/compiler.h>
31 #include <babeltrace/ref.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/component/component-class-internal.h>
42 #define NATIVE_PLUGIN_SUFFIX ".so"
43 #define NATIVE_PLUGIN_SUFFIX_LEN sizeof(NATIVE_PLUGIN_SUFFIX)
44 #define LIBTOOL_PLUGIN_SUFFIX ".la"
45 #define LIBTOOL_PLUGIN_SUFFIX_LEN sizeof(LIBTOOL_PLUGIN_SUFFIX)
47 #define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \
48 sizeof(LIBTOOL_PLUGIN_SUFFIX))
50 #define SECTION_BEGIN(_name) (&(__start_##_name))
51 #define SECTION_END(_name) (&(__stop_##_name))
52 #define SECTION_ELEMENT_COUNT(_name) (SECTION_END(_name) - SECTION_BEGIN(_name))
54 #define DECLARE_SECTION(_type, _name) \
55 extern _type __start_##_name __attribute((weak)); \
56 extern _type __stop_##_name __attribute((weak))
58 DECLARE_SECTION(struct __bt_plugin_descriptor
const *, __bt_plugin_descriptors
);
59 DECLARE_SECTION(struct __bt_plugin_descriptor_attribute
const *, __bt_plugin_descriptor_attributes
);
60 DECLARE_SECTION(struct __bt_plugin_component_class_descriptor
const *, __bt_plugin_component_class_descriptors
);
61 DECLARE_SECTION(struct __bt_plugin_component_class_descriptor_attribute
const *, __bt_plugin_component_class_descriptor_attributes
);
64 * This hash table, global to the library, maps component class pointers
65 * to shared library handles.
67 * The keys (component classes) are NOT owned by this hash table, whereas
68 * the values (shared library handles) are owned by this hash table.
70 * The keys are the component classes created with
71 * bt_plugin_add_component_class(). They keep the shared library handle
72 * object created by their plugin alive so that the plugin's code is
73 * not discarded when it could still be in use by living components
74 * created from those component classes:
76 * [component] --ref-> [component class] --through this HT-> [shlib handle]
78 * This hash table exists for two reasons:
80 * 1. To allow this application:
82 * my_plugins = bt_plugin_create_all_from_file("/path/to/my-plugin.so");
83 * // instantiate components from a plugin's component classes
84 * // put plugins and free my_plugins here
85 * // user code of instantiated components still exists
87 * 2. To decouple the plugin subsystem from the component subsystem:
88 * while plugins objects need to know component class objects, the
89 * opposite is not necessary, thus it makes no sense for a component
90 * class to keep a reference to the plugin object from which it was
93 * An entry is removed from this HT when a component class is destroyed
94 * thanks to a custom destroy listener. When the entry is removed, the
95 * GLib function calls the value destroy notifier of the HT, which is
96 * bt_put(). This decreases the reference count of the mapped shared
97 * library handle. Assuming the original plugin object which contained
98 * some component classes is put first, when the last component class is
99 * removed from this HT, the shared library handle object's reference
100 * count falls to zero and the shared library is finally closed.
103 GHashTable
*comp_classes_to_shlib_handles
;
105 __attribute__((constructor
)) static
106 void init_comp_classes_to_shlib_handles(void) {
107 comp_classes_to_shlib_handles
= g_hash_table_new_full(g_direct_hash
,
108 g_direct_equal
, NULL
, bt_put
);
109 assert(comp_classes_to_shlib_handles
);
112 __attribute__((destructor
)) static
113 void fini_comp_classes_to_shlib_handles(void) {
114 if (comp_classes_to_shlib_handles
) {
115 g_hash_table_destroy(comp_classes_to_shlib_handles
);
120 void bt_plugin_so_shared_lib_handle_destroy(struct bt_object
*obj
)
122 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
;
125 shared_lib_handle
= container_of(obj
,
126 struct bt_plugin_so_shared_lib_handle
, base
);
128 if (shared_lib_handle
->init_called
&& shared_lib_handle
->exit
) {
129 enum bt_plugin_status status
= shared_lib_handle
->exit();
132 const char *path
= shared_lib_handle
->path
?
133 shared_lib_handle
->path
->str
: "[built-in]";
135 printf_verbose("Plugin in module `%s` exited with error %d\n",
140 if (shared_lib_handle
->module
) {
141 if (!g_module_close(shared_lib_handle
->module
)) {
142 printf_error("Module close error: %s\n",
147 if (shared_lib_handle
->path
) {
148 g_string_free(shared_lib_handle
->path
, TRUE
);
151 g_free(shared_lib_handle
);
155 struct bt_plugin_so_shared_lib_handle
*bt_plugin_so_shared_lib_handle_create(
158 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
160 shared_lib_handle
= g_new0(struct bt_plugin_so_shared_lib_handle
, 1);
161 if (!shared_lib_handle
) {
165 bt_object_init(shared_lib_handle
, bt_plugin_so_shared_lib_handle_destroy
);
171 shared_lib_handle
->path
= g_string_new(path
);
172 if (!shared_lib_handle
->path
) {
176 shared_lib_handle
->module
= g_module_open(path
, 0);
177 if (!shared_lib_handle
->module
) {
178 printf_verbose("Module open error: %s\n", g_module_error());
185 BT_PUT(shared_lib_handle
);
188 return shared_lib_handle
;
192 void bt_plugin_so_destroy_spec_data(struct bt_plugin
*plugin
)
194 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
196 if (!plugin
->spec_data
) {
200 assert(plugin
->type
== BT_PLUGIN_TYPE_SO
);
202 BT_PUT(spec
->shared_lib_handle
);
203 g_free(plugin
->spec_data
);
204 plugin
->spec_data
= NULL
;
208 * This function does the following:
210 * 1. Iterate on the plugin descriptor attributes section and set the
211 * plugin's attributes depending on the attribute types. This
212 * includes the name of the plugin, its description, and its
213 * initialization function, for example.
215 * 2. Iterate on the component class descriptors section and create one
216 * "full descriptor" (temporary structure) for each one that is found
217 * and attached to our plugin descriptor.
219 * 3. Iterate on the component class descriptor attributes section and
220 * set the corresponding full descriptor's attributes depending on
221 * the attribute types. This includes the description of the
222 * component class, as well as its initialization and destroy
225 * 4. Call the user's plugin initialization function, if any is
228 * 5. For each full component class descriptor, create a component class
229 * object, set its optional attributes, and add it to the plugin
232 * 6. Freeze the plugin object.
235 enum bt_plugin_status
bt_plugin_so_init(
236 struct bt_plugin
*plugin
,
237 const struct __bt_plugin_descriptor
*descriptor
,
238 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
239 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
240 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
241 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
242 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
243 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
)
246 * This structure's members point to the plugin's memory
249 struct comp_class_full_descriptor
{
250 const struct __bt_plugin_component_class_descriptor
*descriptor
;
251 const char *description
;
253 bt_component_class_init_method init_method
;
254 bt_component_class_destroy_method destroy_method
;
255 bt_component_class_filter_add_iterator_method filter_add_iterator_method
;
256 bt_component_class_sink_add_iterator_method sink_add_iterator_method
;
257 struct bt_component_class_iterator_methods iterator_methods
;
260 enum bt_plugin_status status
= BT_PLUGIN_STATUS_OK
;
261 struct __bt_plugin_descriptor_attribute
const * const *cur_attr_ptr
;
262 struct __bt_plugin_component_class_descriptor
const * const *cur_cc_descr_ptr
;
263 struct __bt_plugin_component_class_descriptor_attribute
const * const *cur_cc_descr_attr_ptr
;
264 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
265 GArray
*comp_class_full_descriptors
;
269 comp_class_full_descriptors
= g_array_new(FALSE
, TRUE
,
270 sizeof(struct comp_class_full_descriptor
));
271 if (!comp_class_full_descriptors
) {
272 status
= BT_PLUGIN_STATUS_ERROR
;
276 /* Set mandatory attributes */
277 spec
->descriptor
= descriptor
;
278 bt_plugin_set_name(plugin
, descriptor
->name
);
281 * Find and set optional attributes attached to this plugin
284 for (cur_attr_ptr
= attrs_begin
; cur_attr_ptr
!= attrs_end
; cur_attr_ptr
++) {
285 const struct __bt_plugin_descriptor_attribute
*cur_attr
=
288 if (cur_attr
->plugin_descriptor
!= descriptor
) {
292 switch (cur_attr
->type
) {
293 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_INIT
:
294 spec
->init
= cur_attr
->value
.init
;
296 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT
:
297 spec
->shared_lib_handle
->exit
= cur_attr
->value
.exit
;
299 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_AUTHOR
:
300 bt_plugin_set_author(plugin
, cur_attr
->value
.author
);
302 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_LICENSE
:
303 bt_plugin_set_license(plugin
, cur_attr
->value
.license
);
305 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
306 bt_plugin_set_description(plugin
, cur_attr
->value
.description
);
308 case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_VERSION
:
309 bt_plugin_set_version(plugin
,
310 (unsigned int) cur_attr
->value
.version
.major
,
311 (unsigned int) cur_attr
->value
.version
.minor
,
312 (unsigned int) cur_attr
->value
.version
.patch
,
313 cur_attr
->value
.version
.extra
);
316 printf_verbose("WARNING: Unknown attribute \"%s\" (type %d) for plugin %s\n",
317 cur_attr
->type_name
, cur_attr
->type
,
324 * Find component class descriptors attached to this plugin
325 * descriptor and initialize corresponding full component class
326 * descriptors in the array.
328 for (cur_cc_descr_ptr
= cc_descriptors_begin
; cur_cc_descr_ptr
!= cc_descriptors_end
; cur_cc_descr_ptr
++) {
329 const struct __bt_plugin_component_class_descriptor
*cur_cc_descr
=
331 struct comp_class_full_descriptor full_descriptor
= {0};
333 if (cur_cc_descr
->plugin_descriptor
!= descriptor
) {
337 full_descriptor
.descriptor
= cur_cc_descr
;
338 g_array_append_val(comp_class_full_descriptors
,
343 * Find component class descriptor attributes attached to this
344 * plugin descriptor and update corresponding full component
345 * class descriptors in the array.
347 for (cur_cc_descr_attr_ptr
= cc_descr_attrs_begin
; cur_cc_descr_attr_ptr
!= cc_descr_attrs_end
; cur_cc_descr_attr_ptr
++) {
348 const struct __bt_plugin_component_class_descriptor_attribute
*cur_cc_descr_attr
=
349 *cur_cc_descr_attr_ptr
;
351 if (cur_cc_descr_attr
->comp_class_descriptor
->plugin_descriptor
!=
356 /* Find the corresponding component class descriptor entry */
357 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
358 struct comp_class_full_descriptor
*cc_full_descr
=
359 &g_array_index(comp_class_full_descriptors
,
360 struct comp_class_full_descriptor
, i
);
362 if (cur_cc_descr_attr
->comp_class_descriptor
==
363 cc_full_descr
->descriptor
) {
364 switch (cur_cc_descr_attr
->type
) {
365 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION
:
366 cc_full_descr
->description
=
367 cur_cc_descr_attr
->value
.description
;
369 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_HELP
:
370 cc_full_descr
->help
=
371 cur_cc_descr_attr
->value
.help
;
373 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_INIT_METHOD
:
374 cc_full_descr
->init_method
=
375 cur_cc_descr_attr
->value
.init_method
;
377 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_DESTROY_METHOD
:
378 cc_full_descr
->destroy_method
=
379 cur_cc_descr_attr
->value
.destroy_method
;
381 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_FILTER_ADD_ITERATOR_METHOD
:
382 cc_full_descr
->filter_add_iterator_method
=
383 cur_cc_descr_attr
->value
.filter_add_iterator_method
;
385 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_SINK_ADD_ITERATOR_METHOD
:
386 cc_full_descr
->sink_add_iterator_method
=
387 cur_cc_descr_attr
->value
.sink_add_iterator_method
;
389 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_NOTIF_ITER_INIT_METHOD
:
390 cc_full_descr
->iterator_methods
.init
=
391 cur_cc_descr_attr
->value
.notif_iter_init_method
;
393 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_NOTIF_ITER_DESTROY_METHOD
:
394 cc_full_descr
->iterator_methods
.destroy
=
395 cur_cc_descr_attr
->value
.notif_iter_destroy_method
;
397 case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_NOTIF_ITER_SEEK_TIME_METHOD
:
398 cc_full_descr
->iterator_methods
.seek_time
=
399 cur_cc_descr_attr
->value
.notif_iter_seek_time_method
;
402 printf_verbose("WARNING: Unknown attribute \"%s\" (type %d) for component class %s (type %d) in plugin %s\n",
403 cur_cc_descr_attr
->type_name
,
404 cur_cc_descr_attr
->type
,
405 cur_cc_descr_attr
->comp_class_descriptor
->name
,
406 cur_cc_descr_attr
->comp_class_descriptor
->type
,
414 /* Initialize plugin */
416 status
= spec
->init(plugin
);
418 printf_verbose("Plugin `%s` initialization error: %d\n",
419 bt_plugin_get_name(plugin
), status
);
424 spec
->shared_lib_handle
->init_called
= true;
426 /* Add described component classes to plugin */
427 for (i
= 0; i
< comp_class_full_descriptors
->len
; i
++) {
428 struct comp_class_full_descriptor
*cc_full_descr
=
429 &g_array_index(comp_class_full_descriptors
,
430 struct comp_class_full_descriptor
, i
);
431 struct bt_component_class
*comp_class
;
433 switch (cc_full_descr
->descriptor
->type
) {
434 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
435 comp_class
= bt_component_class_source_create(
436 cc_full_descr
->descriptor
->name
,
437 cc_full_descr
->descriptor
->methods
.source
.notif_iter_get
,
438 cc_full_descr
->descriptor
->methods
.source
.notif_iter_next
);
440 case BT_COMPONENT_CLASS_TYPE_FILTER
:
441 comp_class
= bt_component_class_filter_create(
442 cc_full_descr
->descriptor
->name
,
443 cc_full_descr
->descriptor
->methods
.source
.notif_iter_get
,
444 cc_full_descr
->descriptor
->methods
.source
.notif_iter_next
);
446 case BT_COMPONENT_CLASS_TYPE_SINK
:
447 comp_class
= bt_component_class_sink_create(
448 cc_full_descr
->descriptor
->name
,
449 cc_full_descr
->descriptor
->methods
.sink
.consume
);
452 printf_verbose("WARNING: Unknown component class type %d for component class %s in plugin %s\n",
453 cc_full_descr
->descriptor
->type
,
454 cc_full_descr
->descriptor
->name
,
460 status
= BT_PLUGIN_STATUS_ERROR
;
464 if (cc_full_descr
->description
) {
465 ret
= bt_component_class_set_description(comp_class
,
466 cc_full_descr
->description
);
468 status
= BT_PLUGIN_STATUS_ERROR
;
474 if (cc_full_descr
->help
) {
475 ret
= bt_component_class_set_help(comp_class
,
476 cc_full_descr
->help
);
478 status
= BT_PLUGIN_STATUS_ERROR
;
484 if (cc_full_descr
->init_method
) {
485 ret
= bt_component_class_set_init_method(comp_class
,
486 cc_full_descr
->init_method
);
488 status
= BT_PLUGIN_STATUS_ERROR
;
494 if (cc_full_descr
->destroy_method
) {
495 ret
= bt_component_class_set_destroy_method(comp_class
,
496 cc_full_descr
->destroy_method
);
498 status
= BT_PLUGIN_STATUS_ERROR
;
504 switch (cc_full_descr
->descriptor
->type
) {
505 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
506 if (cc_full_descr
->iterator_methods
.init
) {
507 ret
= bt_component_class_source_set_notification_iterator_init_method(
509 cc_full_descr
->iterator_methods
.init
);
511 status
= BT_PLUGIN_STATUS_ERROR
;
517 if (cc_full_descr
->iterator_methods
.destroy
) {
518 ret
= bt_component_class_source_set_notification_iterator_destroy_method(
520 cc_full_descr
->iterator_methods
.destroy
);
522 status
= BT_PLUGIN_STATUS_ERROR
;
528 if (cc_full_descr
->iterator_methods
.seek_time
) {
529 ret
= bt_component_class_source_set_notification_iterator_seek_time_method(
531 cc_full_descr
->iterator_methods
.seek_time
);
533 status
= BT_PLUGIN_STATUS_ERROR
;
539 case BT_COMPONENT_CLASS_TYPE_FILTER
:
540 if (cc_full_descr
->filter_add_iterator_method
) {
541 ret
= bt_component_class_filter_set_add_iterator_method(
543 cc_full_descr
->filter_add_iterator_method
);
545 status
= BT_PLUGIN_STATUS_ERROR
;
551 if (cc_full_descr
->iterator_methods
.init
) {
552 ret
= bt_component_class_filter_set_notification_iterator_init_method(
554 cc_full_descr
->iterator_methods
.init
);
556 status
= BT_PLUGIN_STATUS_ERROR
;
562 if (cc_full_descr
->iterator_methods
.destroy
) {
563 ret
= bt_component_class_filter_set_notification_iterator_destroy_method(
565 cc_full_descr
->iterator_methods
.destroy
);
567 status
= BT_PLUGIN_STATUS_ERROR
;
573 if (cc_full_descr
->iterator_methods
.seek_time
) {
574 ret
= bt_component_class_filter_set_notification_iterator_seek_time_method(
576 cc_full_descr
->iterator_methods
.seek_time
);
578 status
= BT_PLUGIN_STATUS_ERROR
;
584 case BT_COMPONENT_CLASS_TYPE_SINK
:
585 if (cc_full_descr
->sink_add_iterator_method
) {
586 ret
= bt_component_class_sink_set_add_iterator_method(
588 cc_full_descr
->sink_add_iterator_method
);
590 status
= BT_PLUGIN_STATUS_ERROR
;
602 * Add component class to the plugin object.
604 * This will call back
605 * bt_plugin_so_on_add_component_class() so that we can
606 * add a mapping in comp_classes_to_shlib_handles when
607 * we know the component class is successfully added.
609 status
= bt_plugin_add_component_class(plugin
,
613 printf_verbose("Cannot add component class %s (type %d) to plugin `%s`: status = %d\n",
614 cc_full_descr
->descriptor
->name
,
615 cc_full_descr
->descriptor
->type
,
616 bt_plugin_get_name(plugin
), status
);
622 * All the plugin's component classes should be added at this
623 * point. We freeze the plugin so that it's not possible to add
624 * component classes to this plugin object after this stage
625 * (plugin object becomes immutable).
627 bt_plugin_freeze(plugin
);
630 g_array_free(comp_class_full_descriptors
, TRUE
);
635 struct bt_plugin
*bt_plugin_so_create_empty(
636 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
)
638 struct bt_plugin
*plugin
;
639 struct bt_plugin_so_spec_data
*spec
;
641 plugin
= bt_plugin_create_empty(BT_PLUGIN_TYPE_SO
);
646 plugin
->spec_data
= g_new0(struct bt_plugin_so_spec_data
, 1);
647 if (!plugin
->spec_data
) {
651 spec
= plugin
->spec_data
;
652 spec
->shared_lib_handle
= bt_get(shared_lib_handle
);
663 struct bt_plugin
**bt_plugin_so_create_all_from_sections(
664 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
,
665 struct __bt_plugin_descriptor
const * const *descriptors_begin
,
666 struct __bt_plugin_descriptor
const * const *descriptors_end
,
667 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
,
668 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
,
669 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
,
670 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
,
671 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
,
672 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
)
674 size_t descriptor_count
;
676 size_t cc_descriptors_count
;
677 size_t cc_descr_attrs_count
;
679 struct bt_plugin
**plugins
= NULL
;
681 descriptor_count
= descriptors_end
- descriptors_begin
;
682 attrs_count
= attrs_end
- attrs_begin
;
683 cc_descriptors_count
= cc_descriptors_end
- cc_descriptors_begin
;
684 cc_descr_attrs_count
= cc_descr_attrs_end
- cc_descr_attrs_begin
;
685 printf_verbose("Section: Plugin descriptors: [%p - %p], (%zu elements)\n",
686 descriptors_begin
, descriptors_end
, descriptor_count
);
687 printf_verbose("Section: Plugin descriptor attributes: [%p - %p], (%zu elements)\n",
688 attrs_begin
, attrs_end
, attrs_count
);
689 printf_verbose("Section: Plugin component class descriptors: [%p - %p], (%zu elements)\n",
690 cc_descriptors_begin
, cc_descriptors_end
, cc_descriptors_count
);
691 printf_verbose("Section: Plugin component class descriptor attributes: [%p - %p], (%zu elements)\n",
692 cc_descr_attrs_begin
, cc_descr_attrs_end
, cc_descr_attrs_count
);
693 plugins
= calloc(descriptor_count
+ 1, sizeof(*plugins
));
698 for (i
= 0; i
< descriptor_count
; i
++) {
699 enum bt_plugin_status status
;
700 const struct __bt_plugin_descriptor
*descriptor
=
701 descriptors_begin
[i
];
702 struct bt_plugin
*plugin
;
704 printf_verbose("Loading plugin %s (ABI %d.%d)\n", descriptor
->name
,
705 descriptor
->major
, descriptor
->minor
);
707 if (descriptor
->major
> __BT_PLUGIN_VERSION_MAJOR
) {
708 printf_error("Unknown plugin's major version: %d\n",
713 plugin
= bt_plugin_so_create_empty(shared_lib_handle
);
715 printf_error("Cannot allocate plugin object for plugin %s\n",
720 if (shared_lib_handle
&& shared_lib_handle
->path
) {
721 bt_plugin_set_path(plugin
, shared_lib_handle
->path
->str
);
724 status
= bt_plugin_so_init(plugin
, descriptor
, attrs_begin
,
725 attrs_end
, cc_descriptors_begin
, cc_descriptors_end
,
726 cc_descr_attrs_begin
, cc_descr_attrs_end
);
728 printf_error("Cannot initialize plugin object %s\n",
734 /* Transfer ownership to the array */
749 struct bt_plugin
**bt_plugin_so_create_all_from_static(void)
751 struct bt_plugin
**plugins
= NULL
;
752 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
=
753 bt_plugin_so_shared_lib_handle_create(NULL
);
755 if (!shared_lib_handle
) {
759 plugins
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
760 SECTION_BEGIN(__bt_plugin_descriptors
),
761 SECTION_END(__bt_plugin_descriptors
),
762 SECTION_BEGIN(__bt_plugin_descriptor_attributes
),
763 SECTION_END(__bt_plugin_descriptor_attributes
),
764 SECTION_BEGIN(__bt_plugin_component_class_descriptors
),
765 SECTION_END(__bt_plugin_component_class_descriptors
),
766 SECTION_BEGIN(__bt_plugin_component_class_descriptor_attributes
),
767 SECTION_END(__bt_plugin_component_class_descriptor_attributes
));
770 BT_PUT(shared_lib_handle
);
776 struct bt_plugin
**bt_plugin_so_create_all_from_file(const char *path
)
779 struct bt_plugin
**plugins
= NULL
;
780 struct __bt_plugin_descriptor
const * const *descriptors_begin
= NULL
;
781 struct __bt_plugin_descriptor
const * const *descriptors_end
= NULL
;
782 struct __bt_plugin_descriptor_attribute
const * const *attrs_begin
= NULL
;
783 struct __bt_plugin_descriptor_attribute
const * const *attrs_end
= NULL
;
784 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_begin
= NULL
;
785 struct __bt_plugin_component_class_descriptor
const * const *cc_descriptors_end
= NULL
;
786 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_begin
= NULL
;
787 struct __bt_plugin_component_class_descriptor_attribute
const * const *cc_descr_attrs_end
= NULL
;
788 bool is_libtool_wrapper
= false, is_shared_object
= false;
789 struct bt_plugin_so_shared_lib_handle
*shared_lib_handle
= NULL
;
795 path_len
= strlen(path
);
796 if (path_len
<= PLUGIN_SUFFIX_LEN
) {
802 * Check if the file ends with a known plugin file type suffix (i.e. .so
805 is_libtool_wrapper
= !strncmp(LIBTOOL_PLUGIN_SUFFIX
,
806 path
+ path_len
- LIBTOOL_PLUGIN_SUFFIX_LEN
,
807 LIBTOOL_PLUGIN_SUFFIX_LEN
);
808 is_shared_object
= !strncmp(NATIVE_PLUGIN_SUFFIX
,
809 path
+ path_len
- NATIVE_PLUGIN_SUFFIX_LEN
,
810 NATIVE_PLUGIN_SUFFIX_LEN
);
811 if (!is_shared_object
&& !is_libtool_wrapper
) {
812 /* Name indicates that this is not a plugin file. */
816 shared_lib_handle
= bt_plugin_so_shared_lib_handle_create(path
);
817 if (!shared_lib_handle
) {
821 if (!g_module_symbol(shared_lib_handle
->module
, "__start___bt_plugin_descriptors",
822 (gpointer
*) &descriptors_begin
)) {
823 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
824 "__start___bt_plugin_descriptors",
825 g_module_name(shared_lib_handle
->module
));
829 if (!g_module_symbol(shared_lib_handle
->module
, "__stop___bt_plugin_descriptors",
830 (gpointer
*) &descriptors_end
)) {
831 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
832 "__stop___bt_plugin_descriptors",
833 g_module_name(shared_lib_handle
->module
));
837 if (!g_module_symbol(shared_lib_handle
->module
, "__start___bt_plugin_descriptor_attributes",
838 (gpointer
*) &attrs_begin
)) {
839 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
840 "__start___bt_plugin_descriptor_attributes",
841 g_module_name(shared_lib_handle
->module
));
844 if (!g_module_symbol(shared_lib_handle
->module
, "__stop___bt_plugin_descriptor_attributes",
845 (gpointer
*) &attrs_end
)) {
846 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
847 "__stop___bt_plugin_descriptor_attributes",
848 g_module_name(shared_lib_handle
->module
));
851 if ((!!attrs_begin
- !!attrs_end
) != 0) {
852 printf_verbose("Found __start___bt_plugin_descriptor_attributes or __stop___bt_plugin_descriptor_attributes symbol, but not both in %s\n",
853 g_module_name(shared_lib_handle
->module
));
857 if (!g_module_symbol(shared_lib_handle
->module
, "__start___bt_plugin_component_class_descriptors",
858 (gpointer
*) &cc_descriptors_begin
)) {
859 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
860 "__start___bt_plugin_component_class_descriptors",
861 g_module_name(shared_lib_handle
->module
));
864 if (!g_module_symbol(shared_lib_handle
->module
, "__stop___bt_plugin_component_class_descriptors",
865 (gpointer
*) &cc_descriptors_end
)) {
866 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
867 "__stop___bt_plugin_component_class_descriptors",
868 g_module_name(shared_lib_handle
->module
));
871 if ((!!cc_descriptors_begin
- !!cc_descriptors_end
) != 0) {
872 printf_verbose("Found __start___bt_plugin_component_class_descriptors or __stop___bt_plugin_component_class_descriptors symbol, but not both in %s\n",
873 g_module_name(shared_lib_handle
->module
));
877 if (!g_module_symbol(shared_lib_handle
->module
, "__start___bt_plugin_component_class_descriptor_attributes",
878 (gpointer
*) &cc_descr_attrs_begin
)) {
879 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
880 "__start___bt_plugin_component_class_descriptor_attributes",
881 g_module_name(shared_lib_handle
->module
));
884 if (!g_module_symbol(shared_lib_handle
->module
, "__stop___bt_plugin_component_class_descriptor_attributes",
885 (gpointer
*) &cc_descr_attrs_end
)) {
886 printf_verbose("Unable to resolve plugin symbol %s from %s\n",
887 "__stop___bt_plugin_component_class_descriptor_attributes",
888 g_module_name(shared_lib_handle
->module
));
891 if ((!!cc_descr_attrs_begin
- !!cc_descr_attrs_end
) != 0) {
892 printf_verbose("Found __start___bt_plugin_component_class_descriptor_attributes or __stop___bt_plugin_component_class_descriptor_attributes symbol, but not both in %s\n",
893 g_module_name(shared_lib_handle
->module
));
897 /* Initialize plugin */
898 plugins
= bt_plugin_so_create_all_from_sections(shared_lib_handle
,
899 descriptors_begin
, descriptors_end
, attrs_begin
, attrs_end
,
900 cc_descriptors_begin
, cc_descriptors_end
,
901 cc_descr_attrs_begin
, cc_descr_attrs_end
);
904 BT_PUT(shared_lib_handle
);
909 void plugin_comp_class_destroy_listener(struct bt_component_class
*comp_class
,
912 gboolean exists
= g_hash_table_remove(comp_classes_to_shlib_handles
,
918 int bt_plugin_so_on_add_component_class(struct bt_plugin
*plugin
,
919 struct bt_component_class
*comp_class
)
922 struct bt_plugin_so_spec_data
*spec
= plugin
->spec_data
;
924 assert(plugin
->spec_data
);
925 assert(plugin
->type
== BT_PLUGIN_TYPE_SO
);
927 /* Map component class pointer to shared lib handle in global HT */
928 g_hash_table_insert(comp_classes_to_shlib_handles
, comp_class
,
929 bt_get(spec
->shared_lib_handle
));
931 /* Add our custom destroy listener */
932 ret
= bt_component_class_add_destroy_listener(comp_class
,
933 plugin_comp_class_destroy_listener
, NULL
);
940 /* Remove entry from global hash table (if exists) */
941 g_hash_table_remove(comp_classes_to_shlib_handles
,