1 #ifndef BABELTRACE_PLUGIN_PLUGIN_CONST_H
2 #define BABELTRACE_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
33 * For bt_bool, bt_plugin, bt_plugin_set, bt_component_class,
34 * bt_component_class_source, bt_component_class_filter,
35 * bt_component_class_sink
37 #include <babeltrace2/types.h>
39 /* For bt_property_availability */
40 #include <babeltrace2/property.h>
42 /* For __BT_FUNC_STATUS_* */
43 #define __BT_FUNC_STATUS_ENABLE
44 #include <babeltrace2/func-status.h>
45 #undef __BT_FUNC_STATUS_ENABLE
51 typedef enum bt_plugin_find_status
{
52 BT_PLUGIN_FIND_STATUS_OK
= __BT_FUNC_STATUS_OK
,
53 BT_PLUGIN_FIND_STATUS_NOT_FOUND
= __BT_FUNC_STATUS_NOT_FOUND
,
54 BT_PLUGIN_FIND_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
55 BT_PLUGIN_FIND_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
56 BT_PLUGIN_FIND_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
57 } bt_plugin_find_status
;
59 extern bt_plugin_find_status
bt_plugin_find(const char *plugin_name
,
60 bt_bool fail_on_load_error
, const bt_plugin
**plugin
);
62 typedef enum bt_plugin_find_all_from_file_status
{
63 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
64 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_NOT_FOUND
= __BT_FUNC_STATUS_NOT_FOUND
,
65 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
66 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
67 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
68 } bt_plugin_find_all_from_file_status
;
70 extern bt_plugin_find_all_from_file_status
bt_plugin_find_all_from_file(
71 const char *path
, bt_bool fail_on_load_error
,
72 const bt_plugin_set
**plugin_set
);
74 typedef enum bt_plugin_find_all_from_dir_status
{
75 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK
= __BT_FUNC_STATUS_OK
,
76 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND
= __BT_FUNC_STATUS_NOT_FOUND
,
77 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
78 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
79 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
80 } bt_plugin_find_all_from_dir_status
;
82 extern bt_plugin_find_all_from_dir_status
bt_plugin_find_all_from_dir(
83 const char *path
, bt_bool recurse
, bt_bool fail_on_load_error
,
84 const bt_plugin_set
**plugin_set
);
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
,
90 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
91 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
92 } bt_plugin_find_all_from_static_status
;
94 extern bt_plugin_find_all_from_static_status
bt_plugin_find_all_from_static(
95 bt_bool fail_on_load_error
, const bt_plugin_set
**plugin_set
);
97 extern const char *bt_plugin_get_name(const bt_plugin
*plugin
);
99 extern const char *bt_plugin_get_author(const bt_plugin
*plugin
);
101 extern const char *bt_plugin_get_license(const bt_plugin
*plugin
);
103 extern const char *bt_plugin_get_description(const bt_plugin
*plugin
);
105 extern const char *bt_plugin_get_path(const bt_plugin
*plugin
);
107 extern bt_property_availability
bt_plugin_get_version(
108 const bt_plugin
*plugin
, unsigned int *major
,
109 unsigned int *minor
, unsigned int *patch
, const char **extra
);
111 extern uint64_t bt_plugin_get_source_component_class_count(
112 const bt_plugin
*plugin
);
114 extern uint64_t bt_plugin_get_filter_component_class_count(
115 const bt_plugin
*plugin
);
117 extern uint64_t bt_plugin_get_sink_component_class_count(
118 const bt_plugin
*plugin
);
120 extern const bt_component_class_source
*
121 bt_plugin_borrow_source_component_class_by_index_const(
122 const bt_plugin
*plugin
, uint64_t index
);
124 extern const bt_component_class_filter
*
125 bt_plugin_borrow_filter_component_class_by_index_const(
126 const bt_plugin
*plugin
, uint64_t index
);
128 extern const bt_component_class_sink
*
129 bt_plugin_borrow_sink_component_class_by_index_const(
130 const bt_plugin
*plugin
, uint64_t index
);
132 extern const bt_component_class_source
*
133 bt_plugin_borrow_source_component_class_by_name_const(
134 const bt_plugin
*plugin
, const char *name
);
136 extern const bt_component_class_filter
*
137 bt_plugin_borrow_filter_component_class_by_name_const(
138 const bt_plugin
*plugin
, const char *name
);
140 extern const bt_component_class_sink
*
141 bt_plugin_borrow_sink_component_class_by_name_const(
142 const bt_plugin
*plugin
, const char *name
);
144 extern void bt_plugin_get_ref(const bt_plugin
*plugin
);
146 extern void bt_plugin_put_ref(const bt_plugin
*plugin
);
148 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
150 bt_plugin_put_ref(_var); \
154 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
156 bt_plugin_put_ref(_var_dst); \
157 (_var_dst) = (_var_src); \
165 #include <babeltrace2/undef-func-status.h>
167 #endif /* BABELTRACE_PLUGIN_PLUGIN_CONST_H */