1 #ifndef BABELTRACE2_PLUGIN_PLUGIN_CONST_H
2 #define BABELTRACE2_PLUGIN_PLUGIN_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
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
29 #ifndef __BT_IN_BABELTRACE_H
30 # error "Please include <babeltrace2/babeltrace.h> instead."
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
41 #include <babeltrace2/types.h>
43 /* For bt_property_availability */
44 #include <babeltrace2/property.h>
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
;
58 extern bt_plugin_find_status
bt_plugin_find(const char *plugin_name
,
59 bt_bool fail_on_load_error
, const bt_plugin
**plugin
);
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
;
69 extern bt_plugin_find_all_from_file_status
bt_plugin_find_all_from_file(
70 const char *path
, bt_bool fail_on_load_error
,
71 const bt_plugin_set
**plugin_set
);
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
;
81 extern bt_plugin_find_all_from_dir_status
bt_plugin_find_all_from_dir(
82 const char *path
, bt_bool recurse
, bt_bool fail_on_load_error
,
83 const bt_plugin_set
**plugin_set
);
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
;
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
);
96 extern const char *bt_plugin_get_name(const bt_plugin
*plugin
);
98 extern const char *bt_plugin_get_author(const bt_plugin
*plugin
);
100 extern const char *bt_plugin_get_license(const bt_plugin
*plugin
);
102 extern const char *bt_plugin_get_description(const bt_plugin
*plugin
);
104 extern const char *bt_plugin_get_path(const bt_plugin
*plugin
);
106 extern bt_property_availability
bt_plugin_get_version(
107 const bt_plugin
*plugin
, unsigned int *major
,
108 unsigned int *minor
, unsigned int *patch
, const char **extra
);
110 extern uint64_t bt_plugin_get_source_component_class_count(
111 const bt_plugin
*plugin
);
113 extern uint64_t bt_plugin_get_filter_component_class_count(
114 const bt_plugin
*plugin
);
116 extern uint64_t bt_plugin_get_sink_component_class_count(
117 const bt_plugin
*plugin
);
119 extern const bt_component_class_source
*
120 bt_plugin_borrow_source_component_class_by_index_const(
121 const bt_plugin
*plugin
, uint64_t index
);
123 extern const bt_component_class_filter
*
124 bt_plugin_borrow_filter_component_class_by_index_const(
125 const bt_plugin
*plugin
, uint64_t index
);
127 extern const bt_component_class_sink
*
128 bt_plugin_borrow_sink_component_class_by_index_const(
129 const bt_plugin
*plugin
, uint64_t index
);
131 extern const bt_component_class_source
*
132 bt_plugin_borrow_source_component_class_by_name_const(
133 const bt_plugin
*plugin
, const char *name
);
135 extern const bt_component_class_filter
*
136 bt_plugin_borrow_filter_component_class_by_name_const(
137 const bt_plugin
*plugin
, const char *name
);
139 extern const bt_component_class_sink
*
140 bt_plugin_borrow_sink_component_class_by_name_const(
141 const bt_plugin
*plugin
, const char *name
);
143 extern void bt_plugin_get_ref(const bt_plugin
*plugin
);
145 extern void bt_plugin_put_ref(const bt_plugin
*plugin
);
147 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
149 bt_plugin_put_ref(_var); \
153 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
155 bt_plugin_put_ref(_var_dst); \
156 (_var_dst) = (_var_src); \
164 #endif /* BABELTRACE2_PLUGIN_PLUGIN_CONST_H */