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>
46 typedef enum bt_plugin_status
{
47 BT_PLUGIN_STATUS_OK
= 0,
48 BT_PLUGIN_STATUS_NOT_FOUND
= 2,
49 BT_PLUGIN_STATUS_ERROR
= -1,
50 BT_PLUGIN_STATUS_LOADING_ERROR
= -2,
51 BT_PLUGIN_STATUS_NOMEM
= -12,
54 extern bt_plugin_status
bt_plugin_find(const char *plugin_name
,
55 bt_bool fail_on_load_error
, const bt_plugin
**plugin
);
57 extern bt_plugin_status
bt_plugin_find_all_from_file(
58 const char *path
, bt_bool fail_on_load_error
,
59 const bt_plugin_set
**plugin_set
);
61 extern bt_plugin_status
bt_plugin_find_all_from_dir(
62 const char *path
, bt_bool recurse
, bt_bool fail_on_load_error
,
63 const bt_plugin_set
**plugin_set
);
65 extern bt_plugin_status
bt_plugin_find_all_from_static(
66 bt_bool fail_on_load_error
,
67 const bt_plugin_set
**plugin_set
);
69 extern const char *bt_plugin_get_name(const bt_plugin
*plugin
);
71 extern const char *bt_plugin_get_author(const bt_plugin
*plugin
);
73 extern const char *bt_plugin_get_license(const bt_plugin
*plugin
);
75 extern const char *bt_plugin_get_description(const bt_plugin
*plugin
);
77 extern const char *bt_plugin_get_path(const bt_plugin
*plugin
);
79 extern bt_property_availability
bt_plugin_get_version(
80 const bt_plugin
*plugin
, unsigned int *major
,
81 unsigned int *minor
, unsigned int *patch
, const char **extra
);
83 extern uint64_t bt_plugin_get_source_component_class_count(
84 const bt_plugin
*plugin
);
86 extern uint64_t bt_plugin_get_filter_component_class_count(
87 const bt_plugin
*plugin
);
89 extern uint64_t bt_plugin_get_sink_component_class_count(
90 const bt_plugin
*plugin
);
92 extern const bt_component_class_source
*
93 bt_plugin_borrow_source_component_class_by_index_const(
94 const bt_plugin
*plugin
, uint64_t index
);
96 extern const bt_component_class_filter
*
97 bt_plugin_borrow_filter_component_class_by_index_const(
98 const bt_plugin
*plugin
, uint64_t index
);
100 extern const bt_component_class_sink
*
101 bt_plugin_borrow_sink_component_class_by_index_const(
102 const bt_plugin
*plugin
, uint64_t index
);
104 extern const bt_component_class_source
*
105 bt_plugin_borrow_source_component_class_by_name_const(
106 const bt_plugin
*plugin
, const char *name
);
108 extern const bt_component_class_filter
*
109 bt_plugin_borrow_filter_component_class_by_name_const(
110 const bt_plugin
*plugin
, const char *name
);
112 extern const bt_component_class_sink
*
113 bt_plugin_borrow_sink_component_class_by_name_const(
114 const bt_plugin
*plugin
, const char *name
);
116 extern void bt_plugin_get_ref(const bt_plugin
*plugin
);
118 extern void bt_plugin_put_ref(const bt_plugin
*plugin
);
120 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
122 bt_plugin_put_ref(_var); \
126 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
128 bt_plugin_put_ref(_var_dst); \
129 (_var_dst) = (_var_src); \
137 #endif /* BABELTRACE_PLUGIN_PLUGIN_CONST_H */