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_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
45 BT_PLUGIN_FIND_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
46 } bt_plugin_find_status
;
48 extern bt_plugin_find_status
bt_plugin_find(const char *plugin_name
,
49 bt_bool fail_on_load_error
, const bt_plugin
**plugin
);
51 typedef enum bt_plugin_find_all_from_file_status
{
52 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
53 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_NOT_FOUND
= __BT_FUNC_STATUS_NOT_FOUND
,
54 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
55 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
56 BT_PLUGIN_FIND_ALL_FROM_FILE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
57 } bt_plugin_find_all_from_file_status
;
59 extern bt_plugin_find_all_from_file_status
bt_plugin_find_all_from_file(
60 const char *path
, bt_bool fail_on_load_error
,
61 const bt_plugin_set
**plugin_set
);
63 typedef enum bt_plugin_find_all_from_dir_status
{
64 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK
= __BT_FUNC_STATUS_OK
,
65 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND
= __BT_FUNC_STATUS_NOT_FOUND
,
66 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
67 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
68 BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
69 } bt_plugin_find_all_from_dir_status
;
71 extern bt_plugin_find_all_from_dir_status
bt_plugin_find_all_from_dir(
72 const char *path
, bt_bool recurse
, bt_bool fail_on_load_error
,
73 const bt_plugin_set
**plugin_set
);
75 typedef enum bt_plugin_find_all_from_static_status
{
76 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK
= __BT_FUNC_STATUS_OK
,
77 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND
= __BT_FUNC_STATUS_NOT_FOUND
,
78 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
79 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_LOADING_ERROR
= __BT_FUNC_STATUS_LOADING_ERROR
,
80 BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
81 } bt_plugin_find_all_from_static_status
;
83 extern bt_plugin_find_all_from_static_status
bt_plugin_find_all_from_static(
84 bt_bool fail_on_load_error
, const bt_plugin_set
**plugin_set
);
86 extern const char *bt_plugin_get_name(const bt_plugin
*plugin
);
88 extern const char *bt_plugin_get_author(const bt_plugin
*plugin
);
90 extern const char *bt_plugin_get_license(const bt_plugin
*plugin
);
92 extern const char *bt_plugin_get_description(const bt_plugin
*plugin
);
94 extern const char *bt_plugin_get_path(const bt_plugin
*plugin
);
96 extern bt_property_availability
bt_plugin_get_version(
97 const bt_plugin
*plugin
, unsigned int *major
,
98 unsigned int *minor
, unsigned int *patch
, const char **extra
);
100 extern uint64_t bt_plugin_get_source_component_class_count(
101 const bt_plugin
*plugin
);
103 extern uint64_t bt_plugin_get_filter_component_class_count(
104 const bt_plugin
*plugin
);
106 extern uint64_t bt_plugin_get_sink_component_class_count(
107 const bt_plugin
*plugin
);
109 extern const bt_component_class_source
*
110 bt_plugin_borrow_source_component_class_by_index_const(
111 const bt_plugin
*plugin
, uint64_t index
);
113 extern const bt_component_class_filter
*
114 bt_plugin_borrow_filter_component_class_by_index_const(
115 const bt_plugin
*plugin
, uint64_t index
);
117 extern const bt_component_class_sink
*
118 bt_plugin_borrow_sink_component_class_by_index_const(
119 const bt_plugin
*plugin
, uint64_t index
);
121 extern const bt_component_class_source
*
122 bt_plugin_borrow_source_component_class_by_name_const(
123 const bt_plugin
*plugin
, const char *name
);
125 extern const bt_component_class_filter
*
126 bt_plugin_borrow_filter_component_class_by_name_const(
127 const bt_plugin
*plugin
, const char *name
);
129 extern const bt_component_class_sink
*
130 bt_plugin_borrow_sink_component_class_by_name_const(
131 const bt_plugin
*plugin
, const char *name
);
133 extern void bt_plugin_get_ref(const bt_plugin
*plugin
);
135 extern void bt_plugin_put_ref(const bt_plugin
*plugin
);
137 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
139 bt_plugin_put_ref(_var); \
143 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
145 bt_plugin_put_ref(_var_dst); \
146 (_var_dst) = (_var_src); \
154 #endif /* BABELTRACE2_PLUGIN_PLUGIN_CONST_H */