projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 90354d3a JG |
1 | #ifndef BABELTRACE_PLUGIN_H |
| 2 | #define BABELTRACE_PLUGIN_H | |
| 3 | ||
| 4 | /* | |
| 5 | * BabelTrace - Plug-in | |
| 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 <stdint.h> | |
| 31 | ||
| 32 | #ifdef __cplusplus | |
| 33 | extern "C" { | |
| 34 | #endif | |
| 35 | ||
| 36 | struct bt_plugin; | |
| 37 | struct bt_notification; | |
| 38 | ||
| 39 | enum bt_plugin_type { | |
| 40 | BT_PLUGIN_TYPE_UNKNOWN = -1, | |
| 41 | /* A source plug-in is a notification generator. */ | |
| 42 | BT_PLUGIN_TYPE_SOURCE = 0, | |
| 43 | /* A sink plug-in handles incoming notifications. */ | |
| 44 | BT_PLUGIN_TYPE_SINK = 1, | |
| 45 | /* A filter plug-in implements both SOURCE and SINK interfaces. */ | |
| 46 | BT_PLUGIN_TYPE_FILTER = 2, | |
| 47 | }; | |
| 48 | ||
| b5c2631a JG |
49 | typedef void (*bt_plugin_destroy_func)(struct bt_plugin *); |
| 50 | ||
| 90354d3a JG |
51 | /** |
| 52 | * Plug-in discovery functions. | |
| 53 | * | |
| 54 | * The Babeltrace plug-in architecture mandates that a given plug-in shared | |
| 55 | * object only define one plug-in. These functions are used to query a about | |
| 56 | * shared object about its attributes. | |
| 57 | * | |
| 58 | * The functions marked as mandatory MUST be exported by the shared object | |
| 59 | * to be considered a valid plug-in. | |
| 60 | */ | |
| b5c2631a JG |
61 | /* Plug-in discovery functions... find a better name */ |
| 62 | enum bt_plugin_type bt_plugin_lib_get_type(void); | |
| 63 | const char *bt_plugin_lib_get_format_name(void); | |
| 90354d3a JG |
64 | |
| 65 | /* TODO: document mandatory fields and their expected types */ | |
| b5c2631a JG |
66 | struct bt_plugin *bt_plugin_create(struct bt_ctf_field *params); |
| 67 | void *bt_plugin_get_user_data(struct bt_plugin *plugin); | |
| 68 | int bt_plugin_set_error_stream(struct bt_plugin *plugin, FILE *error_stream); | |
| 90354d3a | 69 | |
| b5c2631a | 70 | /* Refcounting */ |
| 90354d3a JG |
71 | void bt_plugin_get(struct bt_plugin *plugin); |
| 72 | void bt_plugin_put(struct bt_plugin *plugin); | |
| 73 | ||
| 74 | #ifdef __cplusplus | |
| 75 | } | |
| 76 | #endif | |
| 77 | ||
| 78 | #endif /* BABELTRACE_PLUGIN_H */ |