Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_PLUGIN_PLUGIN_CONST_H |
2 | #define BABELTRACE2_PLUGIN_PLUGIN_CONST_H | |
90354d3a JG |
3 | |
4 | /* | |
bbb7b5f0 | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
90354d3a JG |
6 | * |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
24 | */ | |
25 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
544d0515 | 30 | #include <stdint.h> |
33b34c43 | 31 | #include <stddef.h> |
9d408fca | 32 | |
3fadfbc0 | 33 | #include <babeltrace2/types.h> |
3fadfbc0 | 34 | #include <babeltrace2/property.h> |
d94d92ac | 35 | |
38b48196 JG |
36 | #ifdef __cplusplus |
37 | extern "C" { | |
38 | #endif | |
633edee0 | 39 | |
d24d5663 PP |
40 | typedef enum bt_plugin_find_status { |
41 | BT_PLUGIN_FIND_STATUS_OK = __BT_FUNC_STATUS_OK, | |
42 | BT_PLUGIN_FIND_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
43 | BT_PLUGIN_FIND_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
d24d5663 PP |
44 | BT_PLUGIN_FIND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
45 | } bt_plugin_find_status; | |
2b43acf9 | 46 | |
d24d5663 | 47 | extern bt_plugin_find_status bt_plugin_find(const char *plugin_name, |
577fa92f PP |
48 | bt_bool find_in_std_env_var, bt_bool find_in_user_dir, |
49 | bt_bool find_in_sys_dir, bt_bool find_in_static, | |
9736d991 | 50 | bt_bool fail_on_load_error, const bt_plugin **plugin); |
33b34c43 | 51 | |
577fa92f PP |
52 | typedef enum bt_plugin_find_all_status { |
53 | BT_PLUGIN_FIND_ALL_STATUS_OK = __BT_FUNC_STATUS_OK, | |
54 | BT_PLUGIN_FIND_ALL_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
55 | BT_PLUGIN_FIND_ALL_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
56 | BT_PLUGIN_FIND_ALL_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
57 | } bt_plugin_find_all_status; | |
58 | ||
59 | bt_plugin_find_all_status bt_plugin_find_all(bt_bool find_in_std_env_var, | |
60 | bt_bool find_in_user_dir, bt_bool find_in_sys_dir, | |
61 | bt_bool find_in_static, bt_bool fail_on_load_error, | |
62 | const bt_plugin_set **plugin_set); | |
63 | ||
d24d5663 PP |
64 | typedef enum bt_plugin_find_all_from_file_status { |
65 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
66 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
67 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
d24d5663 PP |
68 | BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
69 | } bt_plugin_find_all_from_file_status; | |
70 | ||
71 | extern bt_plugin_find_all_from_file_status bt_plugin_find_all_from_file( | |
9736d991 PP |
72 | const char *path, bt_bool fail_on_load_error, |
73 | const bt_plugin_set **plugin_set); | |
33b34c43 | 74 | |
d24d5663 PP |
75 | typedef enum bt_plugin_find_all_from_dir_status { |
76 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK = __BT_FUNC_STATUS_OK, | |
77 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
78 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
d24d5663 PP |
79 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
80 | } bt_plugin_find_all_from_dir_status; | |
81 | ||
82 | extern bt_plugin_find_all_from_dir_status bt_plugin_find_all_from_dir( | |
9736d991 PP |
83 | const char *path, bt_bool recurse, bt_bool fail_on_load_error, |
84 | const bt_plugin_set **plugin_set); | |
85 | ||
d24d5663 PP |
86 | typedef enum bt_plugin_find_all_from_static_status { |
87 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK = __BT_FUNC_STATUS_OK, | |
88 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND = __BT_FUNC_STATUS_NOT_FOUND, | |
89 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_ERROR = __BT_FUNC_STATUS_ERROR, | |
d24d5663 PP |
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 | |
b19ff26f | 96 | extern const char *bt_plugin_get_name(const bt_plugin *plugin); |
633edee0 | 97 | |
b19ff26f | 98 | extern const char *bt_plugin_get_author(const bt_plugin *plugin); |
633edee0 | 99 | |
b19ff26f | 100 | extern const char *bt_plugin_get_license(const bt_plugin *plugin); |
633edee0 | 101 | |
b19ff26f | 102 | extern const char *bt_plugin_get_description(const bt_plugin *plugin); |
f3bc2010 | 103 | |
b19ff26f | 104 | extern const char *bt_plugin_get_path(const bt_plugin *plugin); |
7c7c0433 | 105 | |
4cdfc5e8 | 106 | extern bt_property_availability bt_plugin_get_version( |
b19ff26f | 107 | const bt_plugin *plugin, unsigned int *major, |
d94d92ac PP |
108 | unsigned int *minor, unsigned int *patch, const char **extra); |
109 | ||
110 | extern uint64_t bt_plugin_get_source_component_class_count( | |
b19ff26f | 111 | const bt_plugin *plugin); |
d94d92ac PP |
112 | |
113 | extern uint64_t bt_plugin_get_filter_component_class_count( | |
b19ff26f | 114 | const bt_plugin *plugin); |
b6de043b | 115 | |
d94d92ac | 116 | extern uint64_t bt_plugin_get_sink_component_class_count( |
b19ff26f | 117 | const bt_plugin *plugin); |
33b34c43 | 118 | |
b19ff26f | 119 | extern const bt_component_class_source * |
3f79b5cf | 120 | bt_plugin_borrow_source_component_class_by_index_const( |
b19ff26f | 121 | const bt_plugin *plugin, uint64_t index); |
33b34c43 | 122 | |
b19ff26f | 123 | extern const bt_component_class_filter * |
92fed4e1 | 124 | bt_plugin_borrow_filter_component_class_by_index_const( |
b19ff26f | 125 | const bt_plugin *plugin, uint64_t index); |
d94d92ac | 126 | |
b19ff26f | 127 | extern const bt_component_class_sink * |
92fed4e1 | 128 | bt_plugin_borrow_sink_component_class_by_index_const( |
b19ff26f | 129 | const bt_plugin *plugin, uint64_t index); |
d94d92ac | 130 | |
b19ff26f | 131 | extern const bt_component_class_source * |
0d72b8c3 | 132 | bt_plugin_borrow_source_component_class_by_name_const( |
b19ff26f | 133 | const bt_plugin *plugin, const char *name); |
d94d92ac | 134 | |
b19ff26f | 135 | extern const bt_component_class_filter * |
0d72b8c3 | 136 | bt_plugin_borrow_filter_component_class_by_name_const( |
b19ff26f | 137 | const bt_plugin *plugin, const char *name); |
d94d92ac | 138 | |
b19ff26f | 139 | extern const bt_component_class_sink * |
0d72b8c3 | 140 | bt_plugin_borrow_sink_component_class_by_name_const( |
b19ff26f | 141 | const bt_plugin *plugin, const char *name); |
33b34c43 | 142 | |
b19ff26f | 143 | extern void bt_plugin_get_ref(const bt_plugin *plugin); |
c5b9b441 | 144 | |
b19ff26f | 145 | extern void bt_plugin_put_ref(const bt_plugin *plugin); |
c5b9b441 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 | |
924dc299 | 164 | #endif /* BABELTRACE2_PLUGIN_PLUGIN_CONST_H */ |