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 #include <babeltrace/types.h>
35 /* For enum bt_component_class_type */
36 #include <babeltrace/graph/component-class.h>
38 /* For enum bt_component_class_source */
39 #include <babeltrace/graph/component-class-source.h>
41 /* For enum bt_component_class_filter */
42 #include <babeltrace/graph/component-class-filter.h>
44 /* For enum bt_component_class_sink */
45 #include <babeltrace/graph/component-class-sink.h>
47 /* For enum bt_property_availability */
48 #include <babeltrace/property.h>
56 struct bt_component_class
;
57 struct bt_component_class_source
;
58 struct bt_component_class_filter
;
59 struct bt_component_class_sink
;
61 enum bt_plugin_status
{
62 BT_PLUGIN_STATUS_OK
= 0,
63 BT_PLUGIN_STATUS_ERROR
= -1,
64 BT_PLUGIN_STATUS_NOMEM
= -12,
67 extern const struct bt_plugin
*bt_plugin_find(const char *plugin_name
);
69 extern const struct bt_plugin_set
*bt_plugin_create_all_from_file(
72 extern const struct bt_plugin_set
*bt_plugin_create_all_from_dir(
73 const char *path
, bt_bool recurse
);
75 extern const struct bt_plugin_set
*bt_plugin_create_all_from_static(void);
77 extern const char *bt_plugin_get_name(const struct bt_plugin
*plugin
);
79 extern const char *bt_plugin_get_author(const struct bt_plugin
*plugin
);
81 extern const char *bt_plugin_get_license(const struct bt_plugin
*plugin
);
83 extern const char *bt_plugin_get_description(const struct bt_plugin
*plugin
);
85 extern const char *bt_plugin_get_path(const struct bt_plugin
*plugin
);
87 extern enum bt_property_availability
bt_plugin_get_version(
88 const struct bt_plugin
*plugin
, unsigned int *major
,
89 unsigned int *minor
, unsigned int *patch
, const char **extra
);
91 extern uint64_t bt_plugin_get_source_component_class_count(
92 const struct bt_plugin
*plugin
);
94 extern uint64_t bt_plugin_get_filter_component_class_count(
95 const struct bt_plugin
*plugin
);
97 extern uint64_t bt_plugin_get_sink_component_class_count(
98 const struct bt_plugin
*plugin
);
100 extern const struct bt_component_class_source
*
101 bt_plugin_borrow_source_component_class_by_index_const_const(
102 const struct bt_plugin
*plugin
, uint64_t index
);
104 extern const struct bt_component_class_filter
*
105 bt_plugin_borrow_filter_component_class_by_index_const(
106 const struct bt_plugin
*plugin
, uint64_t index
);
108 extern const struct bt_component_class_sink
*
109 bt_plugin_borrow_sink_component_class_by_index_const(
110 const struct bt_plugin
*plugin
, uint64_t index
);
112 extern const struct bt_component_class_source
*
113 bt_plugin_borrow_source_component_class_by_name_const(
114 const struct bt_plugin
*plugin
, const char *name
);
116 extern const struct bt_component_class_filter
*
117 bt_plugin_borrow_filter_component_class_by_name_const(
118 const struct bt_plugin
*plugin
, const char *name
);
120 extern const struct bt_component_class_sink
*
121 bt_plugin_borrow_sink_component_class_by_name_const(
122 const struct bt_plugin
*plugin
, const char *name
);
124 extern void bt_plugin_get_ref(const struct bt_plugin
*plugin
);
126 extern void bt_plugin_put_ref(const struct bt_plugin
*plugin
);
128 #define BT_PLUGIN_PUT_REF_AND_RESET(_var) \
130 bt_plugin_put_ref(_var); \
134 #define BT_PLUGIN_MOVE_REF(_var_dst, _var_src) \
136 bt_plugin_put_ref(_var_dst); \
137 (_var_dst) = (_var_src); \
145 #endif /* BABELTRACE_PLUGIN_PLUGIN_CONST_H */