projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| fb2dcc52 JG |
1 | #ifndef BABELTRACE_PLUGIN_INTERNAL_H |
| 2 | #define BABELTRACE_PLUGIN__INTERNAL_H | |
| 3 | ||
| 4 | /* | |
| 5 | * BabelTrace - Plug-in Internal | |
| 6 | * | |
| 7 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@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/babeltrace-internal.h> | |
| 31 | #include <babeltrace/ref-internal.h> | |
| 32 | #include <babeltrace/plugin/component.h> | |
| 33 | #include <babeltrace/plugin/plugin.h> | |
| 34 | #include <gmodule.h> | |
| 35 | ||
| 36 | /** | |
| 37 | * Plug-ins are owned by bt_component_factory and the bt_component_class-es | |
| 38 | * it provides. This means that its lifetime bound by either the component | |
| 39 | * factory's, or the concrete components' lifetime which may be in use and which | |
| 40 | * have hold a reference to their bt_component_class which, in turn, have a | |
| 41 | * reference to their plugin. | |
| 42 | * | |
| 43 | * This ensures that a plugin's library is not closed while it is being used | |
| 44 | * even if the bt_component_factory which created its components is destroyed. | |
| 45 | */ | |
| 46 | struct bt_plugin { | |
| 47 | struct bt_ref ref; | |
| 48 | const char *name; | |
| 49 | const char *author; | |
| 50 | const char *license; | |
| 51 | bt_plugin_init_func init; | |
| 52 | bt_plugin_exit_func exit; | |
| 53 | GModule *module; | |
| 54 | }; | |
| 55 | ||
| 56 | BT_HIDDEN | |
| 57 | struct bt_plugin *bt_plugin_create(GModule *module); | |
| 58 | ||
| 59 | BT_HIDDEN | |
| 60 | enum bt_component_status bt_plugin_register_component_classes( | |
| 61 | struct bt_plugin *plugin, struct bt_component_factory *factory); | |
| 62 | ||
| 63 | BT_HIDDEN | |
| 64 | void bt_plugin_get(struct bt_plugin *plugin); | |
| 65 | ||
| 66 | BT_HIDDEN | |
| 67 | void bt_plugin_put(struct bt_plugin *plugin); | |
| 68 | ||
| 69 | #endif /* BABELTRACE_PLUGIN_COMPONENT_CLASS_INTERNAL_H */ |