include/babeltrace/plugin/plugin-so-internal.h

   1 #ifndef BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H
   2 #define BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Plug-in Interface
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <glib.h>
  32 #include <gmodule.h>
  33
  34 struct bt_plugin;
  35 struct bt_component_class;
  36
  37 struct bt_plugin_so_shared_lib_handle {
  38         struct bt_object base;
  39         GString *path;
  40         GModule *module;
  41
  42         /* True if initialization function was called */
  43         bool init_called;
  44         bt_plugin_exit_func exit;
  45 };
  46
  47 struct bt_plugin_so_spec_data {
  48         /* Shared lib. handle: owned by this */
  49         struct bt_plugin_so_shared_lib_handle *shared_lib_handle;
  50
  51         /* Pointers to plugin's memory: do NOT free */
  52         const struct __bt_plugin_descriptor *descriptor;
  53         bt_plugin_init_func init;
  54         const struct __bt_plugin_descriptor_version *version;
  55 };
  56
  57 BT_HIDDEN
  58 struct bt_plugin **bt_plugin_so_create_all_from_file(const char *path);
  59
  60 BT_HIDDEN
  61 struct bt_plugin **bt_plugin_so_create_all_from_static(void);
  62
  63 BT_HIDDEN
  64 int bt_plugin_so_on_add_component_class(struct bt_plugin *plugin,
  65                 struct bt_component_class *comp_class);
  66
  67 BT_HIDDEN
  68 void bt_plugin_so_destroy_spec_data(struct bt_plugin *plugin);
  69
  70 #endif /* BABELTRACE_PLUGIN_PLUGIN_SO_INTERNAL_H */