| 1 | /* |
| 2 | * plugin-so.c |
| 3 | * |
| 4 | * Babeltrace Plugin (shared object) |
| 5 | * |
| 6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 7 | * Copyright 2017 Philippe Proulx <pproulx@efficios.com> |
| 8 | * |
| 9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 10 | * |
| 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: |
| 17 | * |
| 18 | * The above copyright notice and this permission notice shall be included in |
| 19 | * all copies or substantial portions of the Software. |
| 20 | * |
| 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 |
| 27 | * SOFTWARE. |
| 28 | */ |
| 29 | |
| 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> |
| 37 | #include <string.h> |
| 38 | #include <stdbool.h> |
| 39 | #include <glib.h> |
| 40 | #include <gmodule.h> |
| 41 | |
| 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) |
| 46 | |
| 47 | #define PLUGIN_SUFFIX_LEN max_t(size_t, sizeof(NATIVE_PLUGIN_SUFFIX), \ |
| 48 | sizeof(LIBTOOL_PLUGIN_SUFFIX)) |
| 49 | |
| 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)) |
| 53 | |
| 54 | #define DECLARE_SECTION(_type, _name) \ |
| 55 | extern _type __start_##_name __attribute((weak)); \ |
| 56 | extern _type __stop_##_name __attribute((weak)) |
| 57 | |
| 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); |
| 62 | |
| 63 | /* |
| 64 | * This hash table, global to the library, maps component class pointers |
| 65 | * to shared library handles. |
| 66 | * |
| 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. |
| 69 | * |
| 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: |
| 75 | * |
| 76 | * [component] --ref-> [component class] --through this HT-> [shlib handle] |
| 77 | * |
| 78 | * This hash table exists for two reasons: |
| 79 | * |
| 80 | * 1. To allow this application: |
| 81 | * |
| 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 |
| 86 | * |
| 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 |
| 91 | * created. |
| 92 | * |
| 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. |
| 101 | */ |
| 102 | static |
| 103 | GHashTable *comp_classes_to_shlib_handles; |
| 104 | |
| 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); |
| 110 | } |
| 111 | |
| 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); |
| 116 | } |
| 117 | } |
| 118 | |
| 119 | static |
| 120 | void bt_plugin_so_shared_lib_handle_destroy(struct bt_object *obj) |
| 121 | { |
| 122 | struct bt_plugin_so_shared_lib_handle *shared_lib_handle; |
| 123 | |
| 124 | assert(obj); |
| 125 | shared_lib_handle = container_of(obj, |
| 126 | struct bt_plugin_so_shared_lib_handle, base); |
| 127 | |
| 128 | if (shared_lib_handle->init_called && shared_lib_handle->exit) { |
| 129 | enum bt_plugin_status status = shared_lib_handle->exit(); |
| 130 | |
| 131 | if (status < 0) { |
| 132 | const char *path = shared_lib_handle->path ? |
| 133 | shared_lib_handle->path->str : "[built-in]"; |
| 134 | |
| 135 | printf_verbose("Plugin in module `%s` exited with error %d\n", |
| 136 | path, status); |
| 137 | } |
| 138 | } |
| 139 | |
| 140 | if (shared_lib_handle->module) { |
| 141 | if (!g_module_close(shared_lib_handle->module)) { |
| 142 | printf_error("Module close error: %s\n", |
| 143 | g_module_error()); |
| 144 | } |
| 145 | } |
| 146 | |
| 147 | if (shared_lib_handle->path) { |
| 148 | g_string_free(shared_lib_handle->path, TRUE); |
| 149 | } |
| 150 | |
| 151 | g_free(shared_lib_handle); |
| 152 | } |
| 153 | |
| 154 | static |
| 155 | struct bt_plugin_so_shared_lib_handle *bt_plugin_so_shared_lib_handle_create( |
| 156 | const char *path) |
| 157 | { |
| 158 | struct bt_plugin_so_shared_lib_handle *shared_lib_handle = NULL; |
| 159 | |
| 160 | shared_lib_handle = g_new0(struct bt_plugin_so_shared_lib_handle, 1); |
| 161 | if (!shared_lib_handle) { |
| 162 | goto error; |
| 163 | } |
| 164 | |
| 165 | bt_object_init(shared_lib_handle, bt_plugin_so_shared_lib_handle_destroy); |
| 166 | |
| 167 | if (!path) { |
| 168 | goto end; |
| 169 | } |
| 170 | |
| 171 | shared_lib_handle->path = g_string_new(path); |
| 172 | if (!shared_lib_handle->path) { |
| 173 | goto error; |
| 174 | } |
| 175 | |
| 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()); |
| 179 | goto error; |
| 180 | } |
| 181 | |
| 182 | goto end; |
| 183 | |
| 184 | error: |
| 185 | BT_PUT(shared_lib_handle); |
| 186 | |
| 187 | end: |
| 188 | return shared_lib_handle; |
| 189 | } |
| 190 | |
| 191 | BT_HIDDEN |
| 192 | void bt_plugin_so_destroy_spec_data(struct bt_plugin *plugin) |
| 193 | { |
| 194 | struct bt_plugin_so_spec_data *spec = plugin->spec_data; |
| 195 | |
| 196 | if (!plugin->spec_data) { |
| 197 | return; |
| 198 | } |
| 199 | |
| 200 | assert(plugin->type == BT_PLUGIN_TYPE_SO); |
| 201 | assert(spec); |
| 202 | BT_PUT(spec->shared_lib_handle); |
| 203 | g_free(plugin->spec_data); |
| 204 | plugin->spec_data = NULL; |
| 205 | } |
| 206 | |
| 207 | /* |
| 208 | * This function does the following: |
| 209 | * |
| 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. |
| 214 | * |
| 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. |
| 218 | * |
| 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 |
| 223 | * methods. |
| 224 | * |
| 225 | * 4. Call the user's plugin initialization function, if any is |
| 226 | * defined. |
| 227 | * |
| 228 | * 5. For each full component class descriptor, create a component class |
| 229 | * object, set its optional attributes, and add it to the plugin |
| 230 | * object. |
| 231 | * |
| 232 | * 6. Freeze the plugin object. |
| 233 | */ |
| 234 | static |
| 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) |
| 244 | { |
| 245 | /* |
| 246 | * This structure's members point to the plugin's memory |
| 247 | * (do NOT free). |
| 248 | */ |
| 249 | struct comp_class_full_descriptor { |
| 250 | const struct __bt_plugin_component_class_descriptor *descriptor; |
| 251 | const char *description; |
| 252 | const char *help; |
| 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; |
| 258 | }; |
| 259 | |
| 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; |
| 266 | size_t i; |
| 267 | int ret; |
| 268 | |
| 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; |
| 273 | goto end; |
| 274 | } |
| 275 | |
| 276 | /* Set mandatory attributes */ |
| 277 | spec->descriptor = descriptor; |
| 278 | bt_plugin_set_name(plugin, descriptor->name); |
| 279 | |
| 280 | /* |
| 281 | * Find and set optional attributes attached to this plugin |
| 282 | * descriptor. |
| 283 | */ |
| 284 | for (cur_attr_ptr = attrs_begin; cur_attr_ptr != attrs_end; cur_attr_ptr++) { |
| 285 | const struct __bt_plugin_descriptor_attribute *cur_attr = |
| 286 | *cur_attr_ptr; |
| 287 | |
| 288 | if (cur_attr->plugin_descriptor != descriptor) { |
| 289 | continue; |
| 290 | } |
| 291 | |
| 292 | switch (cur_attr->type) { |
| 293 | case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_INIT: |
| 294 | spec->init = cur_attr->value.init; |
| 295 | break; |
| 296 | case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_EXIT: |
| 297 | spec->shared_lib_handle->exit = cur_attr->value.exit; |
| 298 | break; |
| 299 | case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_AUTHOR: |
| 300 | bt_plugin_set_author(plugin, cur_attr->value.author); |
| 301 | break; |
| 302 | case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_LICENSE: |
| 303 | bt_plugin_set_license(plugin, cur_attr->value.license); |
| 304 | break; |
| 305 | case BT_PLUGIN_DESCRIPTOR_ATTRIBUTE_TYPE_DESCRIPTION: |
| 306 | bt_plugin_set_description(plugin, cur_attr->value.description); |
| 307 | break; |
| 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); |
| 314 | break; |
| 315 | default: |
| 316 | printf_verbose("WARNING: Unknown attribute \"%s\" (type %d) for plugin %s\n", |
| 317 | cur_attr->type_name, cur_attr->type, |
| 318 | descriptor->name); |
| 319 | break; |
| 320 | } |
| 321 | } |
| 322 | |
| 323 | /* |
| 324 | * Find component class descriptors attached to this plugin |
| 325 | * descriptor and initialize corresponding full component class |
| 326 | * descriptors in the array. |
| 327 | */ |
| 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 = |
| 330 | *cur_cc_descr_ptr; |
| 331 | struct comp_class_full_descriptor full_descriptor = {0}; |
| 332 | |
| 333 | if (cur_cc_descr->plugin_descriptor != descriptor) { |
| 334 | continue; |
| 335 | } |
| 336 | |
| 337 | full_descriptor.descriptor = cur_cc_descr; |
| 338 | g_array_append_val(comp_class_full_descriptors, |
| 339 | full_descriptor); |
| 340 | } |
| 341 | |
| 342 | /* |
| 343 | * Find component class descriptor attributes attached to this |
| 344 | * plugin descriptor and update corresponding full component |
| 345 | * class descriptors in the array. |
| 346 | */ |
| 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; |
| 350 | |
| 351 | if (cur_cc_descr_attr->comp_class_descriptor->plugin_descriptor != |
| 352 | descriptor) { |
| 353 | continue; |
| 354 | } |
| 355 | |
| 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); |
| 361 | |
| 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; |
| 368 | break; |
| 369 | case BT_PLUGIN_COMPONENT_CLASS_DESCRIPTOR_ATTRIBUTE_TYPE_HELP: |
| 370 | cc_full_descr->help = |
| 371 | cur_cc_descr_attr->value.help; |
| 372 | break; |
| 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; |
| 376 | break; |
| 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; |
| 380 | break; |
| 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; |
| 384 | break; |
| 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; |
| 388 | break; |
| 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; |
| 392 | break; |
| 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; |
| 396 | break; |
| 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; |
| 400 | break; |
| 401 | default: |
| 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, |
| 407 | descriptor->name); |
| 408 | break; |
| 409 | } |
| 410 | } |
| 411 | } |
| 412 | } |
| 413 | |
| 414 | /* Initialize plugin */ |
| 415 | if (spec->init) { |
| 416 | status = spec->init(plugin); |
| 417 | if (status < 0) { |
| 418 | printf_verbose("Plugin `%s` initialization error: %d\n", |
| 419 | bt_plugin_get_name(plugin), status); |
| 420 | goto end; |
| 421 | } |
| 422 | } |
| 423 | |
| 424 | spec->shared_lib_handle->init_called = true; |
| 425 | |
| 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; |
| 432 | |
| 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); |
| 439 | break; |
| 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); |
| 445 | break; |
| 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); |
| 450 | break; |
| 451 | default: |
| 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, |
| 455 | descriptor->name); |
| 456 | continue; |
| 457 | } |
| 458 | |
| 459 | if (!comp_class) { |
| 460 | status = BT_PLUGIN_STATUS_ERROR; |
| 461 | goto end; |
| 462 | } |
| 463 | |
| 464 | if (cc_full_descr->description) { |
| 465 | ret = bt_component_class_set_description(comp_class, |
| 466 | cc_full_descr->description); |
| 467 | if (ret) { |
| 468 | status = BT_PLUGIN_STATUS_ERROR; |
| 469 | BT_PUT(comp_class); |
| 470 | goto end; |
| 471 | } |
| 472 | } |
| 473 | |
| 474 | if (cc_full_descr->help) { |
| 475 | ret = bt_component_class_set_help(comp_class, |
| 476 | cc_full_descr->help); |
| 477 | if (ret) { |
| 478 | status = BT_PLUGIN_STATUS_ERROR; |
| 479 | BT_PUT(comp_class); |
| 480 | goto end; |
| 481 | } |
| 482 | } |
| 483 | |
| 484 | if (cc_full_descr->init_method) { |
| 485 | ret = bt_component_class_set_init_method(comp_class, |
| 486 | cc_full_descr->init_method); |
| 487 | if (ret) { |
| 488 | status = BT_PLUGIN_STATUS_ERROR; |
| 489 | BT_PUT(comp_class); |
| 490 | goto end; |
| 491 | } |
| 492 | } |
| 493 | |
| 494 | if (cc_full_descr->destroy_method) { |
| 495 | ret = bt_component_class_set_destroy_method(comp_class, |
| 496 | cc_full_descr->destroy_method); |
| 497 | if (ret) { |
| 498 | status = BT_PLUGIN_STATUS_ERROR; |
| 499 | BT_PUT(comp_class); |
| 500 | goto end; |
| 501 | } |
| 502 | } |
| 503 | |
| 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( |
| 508 | comp_class, |
| 509 | cc_full_descr->iterator_methods.init); |
| 510 | if (ret) { |
| 511 | status = BT_PLUGIN_STATUS_ERROR; |
| 512 | BT_PUT(comp_class); |
| 513 | goto end; |
| 514 | } |
| 515 | } |
| 516 | |
| 517 | if (cc_full_descr->iterator_methods.destroy) { |
| 518 | ret = bt_component_class_source_set_notification_iterator_destroy_method( |
| 519 | comp_class, |
| 520 | cc_full_descr->iterator_methods.destroy); |
| 521 | if (ret) { |
| 522 | status = BT_PLUGIN_STATUS_ERROR; |
| 523 | BT_PUT(comp_class); |
| 524 | goto end; |
| 525 | } |
| 526 | } |
| 527 | |
| 528 | if (cc_full_descr->iterator_methods.seek_time) { |
| 529 | ret = bt_component_class_source_set_notification_iterator_seek_time_method( |
| 530 | comp_class, |
| 531 | cc_full_descr->iterator_methods.seek_time); |
| 532 | if (ret) { |
| 533 | status = BT_PLUGIN_STATUS_ERROR; |
| 534 | BT_PUT(comp_class); |
| 535 | goto end; |
| 536 | } |
| 537 | } |
| 538 | break; |
| 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( |
| 542 | comp_class, |
| 543 | cc_full_descr->filter_add_iterator_method); |
| 544 | if (ret) { |
| 545 | status = BT_PLUGIN_STATUS_ERROR; |
| 546 | BT_PUT(comp_class); |
| 547 | goto end; |
| 548 | } |
| 549 | } |
| 550 | |
| 551 | if (cc_full_descr->iterator_methods.init) { |
| 552 | ret = bt_component_class_filter_set_notification_iterator_init_method( |
| 553 | comp_class, |
| 554 | cc_full_descr->iterator_methods.init); |
| 555 | if (ret) { |
| 556 | status = BT_PLUGIN_STATUS_ERROR; |
| 557 | BT_PUT(comp_class); |
| 558 | goto end; |
| 559 | } |
| 560 | } |
| 561 | |
| 562 | if (cc_full_descr->iterator_methods.destroy) { |
| 563 | ret = bt_component_class_filter_set_notification_iterator_destroy_method( |
| 564 | comp_class, |
| 565 | cc_full_descr->iterator_methods.destroy); |
| 566 | if (ret) { |
| 567 | status = BT_PLUGIN_STATUS_ERROR; |
| 568 | BT_PUT(comp_class); |
| 569 | goto end; |
| 570 | } |
| 571 | } |
| 572 | |
| 573 | if (cc_full_descr->iterator_methods.seek_time) { |
| 574 | ret = bt_component_class_filter_set_notification_iterator_seek_time_method( |
| 575 | comp_class, |
| 576 | cc_full_descr->iterator_methods.seek_time); |
| 577 | if (ret) { |
| 578 | status = BT_PLUGIN_STATUS_ERROR; |
| 579 | BT_PUT(comp_class); |
| 580 | goto end; |
| 581 | } |
| 582 | } |
| 583 | break; |
| 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( |
| 587 | comp_class, |
| 588 | cc_full_descr->sink_add_iterator_method); |
| 589 | if (ret) { |
| 590 | status = BT_PLUGIN_STATUS_ERROR; |
| 591 | BT_PUT(comp_class); |
| 592 | goto end; |
| 593 | } |
| 594 | } |
| 595 | break; |
| 596 | default: |
| 597 | assert(false); |
| 598 | break; |
| 599 | } |
| 600 | |
| 601 | /* |
| 602 | * Add component class to the plugin object. |
| 603 | * |
| 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. |
| 608 | */ |
| 609 | status = bt_plugin_add_component_class(plugin, |
| 610 | comp_class); |
| 611 | BT_PUT(comp_class); |
| 612 | if (status < 0) { |
| 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); |
| 617 | goto end; |
| 618 | } |
| 619 | } |
| 620 | |
| 621 | /* |
| 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). |
| 626 | */ |
| 627 | bt_plugin_freeze(plugin); |
| 628 | |
| 629 | end: |
| 630 | g_array_free(comp_class_full_descriptors, TRUE); |
| 631 | return status; |
| 632 | } |
| 633 | |
| 634 | static |
| 635 | struct bt_plugin *bt_plugin_so_create_empty( |
| 636 | struct bt_plugin_so_shared_lib_handle *shared_lib_handle) |
| 637 | { |
| 638 | struct bt_plugin *plugin; |
| 639 | struct bt_plugin_so_spec_data *spec; |
| 640 | |
| 641 | plugin = bt_plugin_create_empty(BT_PLUGIN_TYPE_SO); |
| 642 | if (!plugin) { |
| 643 | goto error; |
| 644 | } |
| 645 | |
| 646 | plugin->spec_data = g_new0(struct bt_plugin_so_spec_data, 1); |
| 647 | if (!plugin->spec_data) { |
| 648 | goto error; |
| 649 | } |
| 650 | |
| 651 | spec = plugin->spec_data; |
| 652 | spec->shared_lib_handle = bt_get(shared_lib_handle); |
| 653 | goto end; |
| 654 | |
| 655 | error: |
| 656 | BT_PUT(plugin); |
| 657 | |
| 658 | end: |
| 659 | return plugin; |
| 660 | } |
| 661 | |
| 662 | static |
| 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) |
| 673 | { |
| 674 | size_t descriptor_count; |
| 675 | size_t attrs_count; |
| 676 | size_t cc_descriptors_count; |
| 677 | size_t cc_descr_attrs_count; |
| 678 | size_t i; |
| 679 | struct bt_plugin **plugins = NULL; |
| 680 | |
| 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)); |
| 694 | if (!plugins) { |
| 695 | goto error; |
| 696 | } |
| 697 | |
| 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; |
| 703 | |
| 704 | printf_verbose("Loading plugin %s (ABI %d.%d)\n", descriptor->name, |
| 705 | descriptor->major, descriptor->minor); |
| 706 | |
| 707 | if (descriptor->major > __BT_PLUGIN_VERSION_MAJOR) { |
| 708 | printf_error("Unknown plugin's major version: %d\n", |
| 709 | descriptor->major); |
| 710 | goto error; |
| 711 | } |
| 712 | |
| 713 | plugin = bt_plugin_so_create_empty(shared_lib_handle); |
| 714 | if (!plugin) { |
| 715 | printf_error("Cannot allocate plugin object for plugin %s\n", |
| 716 | descriptor->name); |
| 717 | goto error; |
| 718 | } |
| 719 | |
| 720 | if (shared_lib_handle && shared_lib_handle->path) { |
| 721 | bt_plugin_set_path(plugin, shared_lib_handle->path->str); |
| 722 | } |
| 723 | |
| 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); |
| 727 | if (status < 0) { |
| 728 | printf_error("Cannot initialize plugin object %s\n", |
| 729 | descriptor->name); |
| 730 | BT_PUT(plugin); |
| 731 | goto error; |
| 732 | } |
| 733 | |
| 734 | /* Transfer ownership to the array */ |
| 735 | plugins[i] = plugin; |
| 736 | } |
| 737 | |
| 738 | goto end; |
| 739 | |
| 740 | error: |
| 741 | g_free(plugins); |
| 742 | plugins = NULL; |
| 743 | |
| 744 | end: |
| 745 | return plugins; |
| 746 | } |
| 747 | |
| 748 | BT_HIDDEN |
| 749 | struct bt_plugin **bt_plugin_so_create_all_from_static(void) |
| 750 | { |
| 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); |
| 754 | |
| 755 | if (!shared_lib_handle) { |
| 756 | goto end; |
| 757 | } |
| 758 | |
| 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)); |
| 768 | |
| 769 | end: |
| 770 | BT_PUT(shared_lib_handle); |
| 771 | |
| 772 | return plugins; |
| 773 | } |
| 774 | |
| 775 | BT_HIDDEN |
| 776 | struct bt_plugin **bt_plugin_so_create_all_from_file(const char *path) |
| 777 | { |
| 778 | size_t path_len; |
| 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; |
| 790 | |
| 791 | if (!path) { |
| 792 | goto end; |
| 793 | } |
| 794 | |
| 795 | path_len = strlen(path); |
| 796 | if (path_len <= PLUGIN_SUFFIX_LEN) { |
| 797 | goto end; |
| 798 | } |
| 799 | |
| 800 | path_len++; |
| 801 | /* |
| 802 | * Check if the file ends with a known plugin file type suffix (i.e. .so |
| 803 | * or .la on Linux). |
| 804 | */ |
| 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. */ |
| 813 | goto end; |
| 814 | } |
| 815 | |
| 816 | shared_lib_handle = bt_plugin_so_shared_lib_handle_create(path); |
| 817 | if (!shared_lib_handle) { |
| 818 | goto end; |
| 819 | } |
| 820 | |
| 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)); |
| 826 | goto end; |
| 827 | } |
| 828 | |
| 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)); |
| 834 | goto end; |
| 835 | } |
| 836 | |
| 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)); |
| 842 | } |
| 843 | |
| 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)); |
| 849 | } |
| 850 | |
| 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)); |
| 854 | goto end; |
| 855 | } |
| 856 | |
| 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)); |
| 862 | } |
| 863 | |
| 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)); |
| 869 | } |
| 870 | |
| 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)); |
| 874 | goto end; |
| 875 | } |
| 876 | |
| 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)); |
| 882 | } |
| 883 | |
| 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)); |
| 889 | } |
| 890 | |
| 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)); |
| 894 | goto end; |
| 895 | } |
| 896 | |
| 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); |
| 902 | |
| 903 | end: |
| 904 | BT_PUT(shared_lib_handle); |
| 905 | return plugins; |
| 906 | } |
| 907 | |
| 908 | static |
| 909 | void plugin_comp_class_destroy_listener(struct bt_component_class *comp_class, |
| 910 | void *data) |
| 911 | { |
| 912 | gboolean exists = g_hash_table_remove(comp_classes_to_shlib_handles, |
| 913 | comp_class); |
| 914 | assert(exists); |
| 915 | } |
| 916 | |
| 917 | BT_HIDDEN |
| 918 | int bt_plugin_so_on_add_component_class(struct bt_plugin *plugin, |
| 919 | struct bt_component_class *comp_class) |
| 920 | { |
| 921 | int ret; |
| 922 | struct bt_plugin_so_spec_data *spec = plugin->spec_data; |
| 923 | |
| 924 | assert(plugin->spec_data); |
| 925 | assert(plugin->type == BT_PLUGIN_TYPE_SO); |
| 926 | |
| 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)); |
| 930 | |
| 931 | /* Add our custom destroy listener */ |
| 932 | ret = bt_component_class_add_destroy_listener(comp_class, |
| 933 | plugin_comp_class_destroy_listener, NULL); |
| 934 | if (ret) { |
| 935 | goto error; |
| 936 | } |
| 937 | goto end; |
| 938 | |
| 939 | error: |
| 940 | /* Remove entry from global hash table (if exists) */ |
| 941 | g_hash_table_remove(comp_classes_to_shlib_handles, |
| 942 | comp_class); |
| 943 | |
| 944 | end: |
| 945 | return ret; |
| 946 | } |