src/lib/plugin/plugin-so.h

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