Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_PLUGIN_PLUGIN_CONST_H |
2 | #define BABELTRACE2_PLUGIN_PLUGIN_CONST_H | |
90354d3a JG |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
38b48196 | 6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
90354d3a JG |
7 | * |
8 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
9 | * | |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
9df34b44 PP |
29 | #ifndef __BT_IN_BABELTRACE_H |
30 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
31 | #endif | |
32 | ||
544d0515 | 33 | #include <stdint.h> |
33b34c43 | 34 | #include <stddef.h> |
e0831b38 | 35 | |
8eee8ea2 PP |
36 | /* |
37 | * For bt_bool, bt_plugin, bt_plugin_set, bt_component_class, | |
38 | * bt_component_class_source, bt_component_class_filter, | |
39 | * bt_component_class_sink | |
40 | */ | |
71c5da58 | 41 | #include <babeltrace2/types.h> |
33b34c43 | 42 | |
ee78f405 | 43 | /* For bt_property_availability */ |
71c5da58 | 44 | #include <babeltrace2/property.h> |
834e9996 | 45 | |
38b48196 JG |
46 | #ifdef __cplusplus |
47 | extern "C" { | |
48 | #endif | |
633edee0 | 49 | |
fb25b9e3 PP |
50 | typedef enum bt_plugin_find_status { |
51 | BT_PLUGIN_FIND_STATUS_OK = __BT_FUNC_STATUS_OK, | |
52 | BT_PLUGIN_FIND_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
53 | BT_PLUGIN_FIND_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
54 | BT_PLUGIN_FIND_STATUS_LOADING_ERROR = __BT_FUNC_STATUS_LOADING_ERROR, | |
55 | BT_PLUGIN_FIND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
56 | } bt_plugin_find_status; | |
2b43acf9 | 57 | |
fb25b9e3 | 58 | extern bt_plugin_find_status bt_plugin_find(const char *plugin_name, |
01f50d54 | 59 | bt_bool fail_on_load_error, const bt_plugin **plugin); |
33b34c43 | 60 | |
fb25b9e3 PP |
61 | typedef enum bt_plugin_find_all_from_file_status { |
62 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
63 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
64 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
65 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_LOADING_ERROR = __BT_FUNC_STATUS_LOADING_ERROR, | |
66 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
67 | } bt_plugin_find_all_from_file_status; | |
68 | ||
69 | extern bt_plugin_find_all_from_file_status bt_plugin_find_all_from_file( | |
01f50d54 PP |
70 | const char *path, bt_bool fail_on_load_error, |
71 | const bt_plugin_set **plugin_set); | |
33b34c43 | 72 | |
fb25b9e3 PP |
73 | typedef enum bt_plugin_find_all_from_dir_status { |
74 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK = __BT_FUNC_STATUS_OK, | |
75 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
76 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
77 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_LOADING_ERROR = __BT_FUNC_STATUS_LOADING_ERROR, | |
78 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
79 | } bt_plugin_find_all_from_dir_status; | |
80 | ||
81 | extern bt_plugin_find_all_from_dir_status bt_plugin_find_all_from_dir( | |
01f50d54 PP |
82 | const char *path, bt_bool recurse, bt_bool fail_on_load_error, |
83 | const bt_plugin_set **plugin_set); | |
84 | ||
fb25b9e3 PP |
85 | typedef enum bt_plugin_find_all_from_static_status { |
86 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK = __BT_FUNC_STATUS_OK, | |
87 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
88 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
89 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_LOADING_ERROR = __BT_FUNC_STATUS_LOADING_ERROR, | |
90 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
91 | } bt_plugin_find_all_from_static_status; | |
92 | ||
93 | extern bt_plugin_find_all_from_static_status bt_plugin_find_all_from_static( | |
94 | bt_bool fail_on_load_error, const bt_plugin_set **plugin_set); | |
73299554 | 95 | |
8eee8ea2 | 96 | extern const char *bt_plugin_get_name(const bt_plugin *plugin); |
633edee0 | 97 | |
8eee8ea2 | 98 | extern const char *bt_plugin_get_author(const bt_plugin *plugin); |
633edee0 | 99 | |
8eee8ea2 | 100 | extern const char *bt_plugin_get_license(const bt_plugin *plugin); |
633edee0 | 101 | |
8eee8ea2 | 102 | extern const char *bt_plugin_get_description(const bt_plugin *plugin); |
f3bc2010 | 103 | |
8eee8ea2 | 104 | extern const char *bt_plugin_get_path(const bt_plugin *plugin); |
7c7c0433 | 105 | |
ee78f405 | 106 | extern bt_property_availability bt_plugin_get_version( |
8eee8ea2 | 107 | const bt_plugin *plugin, unsigned int *major, |
834e9996 PP |
108 | unsigned int *minor, unsigned int *patch, const char **extra); |
109 | ||
110 | extern uint64_t bt_plugin_get_source_component_class_count( | |
8eee8ea2 | 111 | const bt_plugin *plugin); |
834e9996 PP |
112 | |
113 | extern uint64_t bt_plugin_get_filter_component_class_count( | |
8eee8ea2 | 114 | const bt_plugin *plugin); |
b6de043b | 115 | |
834e9996 | 116 | extern uint64_t bt_plugin_get_sink_component_class_count( |
8eee8ea2 | 117 | const bt_plugin *plugin); |
33b34c43 | 118 | |
8eee8ea2 | 119 | extern const bt_component_class_source * |
3eff3102 | 120 | bt_plugin_borrow_source_component_class_by_index_const( |
8eee8ea2 | 121 | const bt_plugin *plugin, uint64_t index); |
33b34c43 | 122 | |
8eee8ea2 | 123 | extern const bt_component_class_filter * |
3a2cb327 | 124 | bt_plugin_borrow_filter_component_class_by_index_const( |
8eee8ea2 | 125 | const bt_plugin *plugin, uint64_t index); |
834e9996 | 126 | |
8eee8ea2 | 127 | extern const bt_component_class_sink * |
3a2cb327 | 128 | bt_plugin_borrow_sink_component_class_by_index_const( |
8eee8ea2 | 129 | const bt_plugin *plugin, uint64_t index); |
834e9996 | 130 | |
8eee8ea2 | 131 | extern const bt_component_class_source * |
7b53201c | 132 | bt_plugin_borrow_source_component_class_by_name_const( |
8eee8ea2 | 133 | const bt_plugin *plugin, const char *name); |
834e9996 | 134 | |
8eee8ea2 | 135 | extern const bt_component_class_filter * |
7b53201c | 136 | bt_plugin_borrow_filter_component_class_by_name_const( |
8eee8ea2 | 137 | const bt_plugin *plugin, const char *name); |
834e9996 | 138 | |
8eee8ea2 | 139 | extern const bt_component_class_sink * |
7b53201c | 140 | bt_plugin_borrow_sink_component_class_by_name_const( |
8eee8ea2 | 141 | const bt_plugin *plugin, const char *name); |
33b34c43 | 142 | |
8eee8ea2 | 143 | extern void bt_plugin_get_ref(const bt_plugin *plugin); |
8c6884d9 | 144 | |
8eee8ea2 | 145 | extern void bt_plugin_put_ref(const bt_plugin *plugin); |
8c6884d9 PP |
146 | |
147 | #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \ | |
148 | do { \ | |
149 | bt_plugin_put_ref(_var); \ | |
150 | (_var) = NULL; \ | |
151 | } while (0) | |
152 | ||
153 | #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \ | |
154 | do { \ | |
155 | bt_plugin_put_ref(_var_dst); \ | |
156 | (_var_dst) = (_var_src); \ | |
157 | (_var_src) = NULL; \ | |
158 | } while (0) | |
159 | ||
38b48196 JG |
160 | #ifdef __cplusplus |
161 | } | |
162 | #endif | |
90354d3a | 163 | |
3fd40f46 | 164 | #endif /* BABELTRACE2_PLUGIN_PLUGIN_CONST_H */ |