1 #ifndef BABELTRACE2_PLUGIN_PLUGIN_CONST_H
2 #define BABELTRACE2_PLUGIN_PLUGIN_CONST_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
33 #include <babeltrace2/types.h>
34 #include <babeltrace2/property.h>
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
,
44 BT_PLUGIN_FIND_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
45 } bt_plugin_find_status
;
47 extern bt_plugin_find_status
bt_plugin_find(const char *plugin_name
,
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
,
50 bt_bool fail_on_load_error
, const bt_plugin
**plugin
);
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
;
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
);
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
,
68 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
69 } bt_plugin_find_all_from_file_status
;
71 extern bt_plugin_find_all_from_file_status
bt_plugin_find_all_from_file(
72 const char *path
, bt_bool fail_on_load_error
,
73 const bt_plugin_set
**plugin_set
);
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
,
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_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 */