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 <babeltrace/types.h>
39 /* For enum bt_component_class_type */
40 #include <babeltrace/graph/component-class.h>
42 /* For enum bt_component_class_source */
43 #include <babeltrace/graph/component-class-source.h>
45 /* For enum bt_component_class_filter */
46 #include <babeltrace/graph/component-class-filter.h>
48 /* For enum bt_component_class_sink */
49 #include <babeltrace/graph/component-class-sink.h>
51 /* For enum bt_property_availability */
52 #include <babeltrace/property.h>
58 enum bt_plugin_status
{
59 BT_PLUGIN_STATUS_OK
= 0,
60 BT_PLUGIN_STATUS_ERROR
= -1,
61 BT_PLUGIN_STATUS_NOMEM
= -12,
64 extern const bt_plugin
*bt_plugin_find(const char *plugin_name
);
66 extern const bt_plugin_set
*bt_plugin_find_all_from_file(
69 extern const bt_plugin_set
*bt_plugin_find_all_from_dir(
70 const char *path
, bt_bool recurse
);
72 extern const bt_plugin_set
*bt_plugin_find_all_from_static(void);
74 extern const char *bt_plugin_get_name(const bt_plugin
*plugin
);
76 extern const char *bt_plugin_get_author(const bt_plugin
*plugin
);
78 extern const char *bt_plugin_get_license(const bt_plugin
*plugin
);
80 extern const char *bt_plugin_get_description(const bt_plugin
*plugin
);
82 extern const char *bt_plugin_get_path(const bt_plugin
*plugin
);
84 extern enum bt_property_availability
bt_plugin_get_version(
85 const bt_plugin
*plugin
, unsigned int *major
,
86 unsigned int *minor
, unsigned int *patch
, const char **extra
);
88 extern uint64_t bt_plugin_get_source_component_class_count(
89 const bt_plugin
*plugin
);
91 extern uint64_t bt_plugin_get_filter_component_class_count(
92 const bt_plugin
*plugin
);
94 extern uint64_t bt_plugin_get_sink_component_class_count(
95 const bt_plugin
*plugin
);
97 extern const bt_component_class_source
*
98 bt_plugin_borrow_source_component_class_by_index_const_const(
99 const bt_plugin
*plugin
, uint64_t index
);
101 extern const bt_component_class_filter
*
102 bt_plugin_borrow_filter_component_class_by_index_const(
103 const bt_plugin
*plugin
, uint64_t index
);
105 extern const bt_component_class_sink
*
106 bt_plugin_borrow_sink_component_class_by_index_const(
107 const bt_plugin
*plugin
, uint64_t index
);
109 extern const bt_component_class_source
*
110 bt_plugin_borrow_source_component_class_by_name_const(
111 const bt_plugin
*plugin
, const char *name
);
113 extern const bt_component_class_filter
*
114 bt_plugin_borrow_filter_component_class_by_name_const(
115 const bt_plugin
*plugin
, const char *name
);
117 extern const bt_component_class_sink
*
118 bt_plugin_borrow_sink_component_class_by_name_const(
119 const bt_plugin
*plugin
, const char *name
);
121 extern void bt_plugin_get_ref(const bt_plugin
*plugin
);
123 extern void bt_plugin_put_ref(const bt_plugin
*plugin
);
125 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
127 bt_plugin_put_ref(_var); \
131 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
133 bt_plugin_put_ref(_var_dst); \
134 (_var_dst) = (_var_src); \
142 #endif /* BABELTRACE_PLUGIN_PLUGIN_CONST_H */