1 #ifndef BABELTRACE2_GRAPH_GRAPH_H
2 #define BABELTRACE2_GRAPH_GRAPH_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."
30 #include <babeltrace2/types.h>
31 #include <babeltrace2/logging.h>
37 typedef enum bt_graph_listener_func_status
{
38 BT_GRAPH_LISTENER_FUNC_STATUS_OK
= __BT_FUNC_STATUS_OK
,
39 BT_GRAPH_LISTENER_FUNC_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
40 BT_GRAPH_LISTENER_FUNC_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
41 } bt_graph_listener_func_status
;
43 typedef bt_graph_listener_func_status
44 (*bt_graph_filter_component_input_port_added_listener_func
)(
45 const bt_component_filter
*component
,
46 const bt_port_input
*port
, void *data
);
48 typedef bt_graph_listener_func_status
49 (*bt_graph_sink_component_input_port_added_listener_func
)(
50 const bt_component_sink
*component
,
51 const bt_port_input
*port
, void *data
);
53 typedef bt_graph_listener_func_status
54 (*bt_graph_source_component_output_port_added_listener_func
)(
55 const bt_component_source
*component
,
56 const bt_port_output
*port
, void *data
);
58 typedef bt_graph_listener_func_status
59 (*bt_graph_filter_component_output_port_added_listener_func
)(
60 const bt_component_filter
*component
,
61 const bt_port_output
*port
, void *data
);
63 typedef bt_graph_listener_func_status
64 (*bt_graph_source_filter_component_ports_connected_listener_func
)(
65 const bt_component_source
*source_component
,
66 const bt_component_filter
*filter_component
,
67 const bt_port_output
*upstream_port
,
68 const bt_port_input
*downstream_port
, void *data
);
70 typedef bt_graph_listener_func_status
71 (*bt_graph_source_sink_component_ports_connected_listener_func
)(
72 const bt_component_source
*source_component
,
73 const bt_component_sink
*sink_component
,
74 const bt_port_output
*upstream_port
,
75 const bt_port_input
*downstream_port
, void *data
);
77 typedef bt_graph_listener_func_status
78 (*bt_graph_filter_filter_component_ports_connected_listener_func
)(
79 const bt_component_filter
*filter_component_upstream
,
80 const bt_component_filter
*filter_component_downstream
,
81 const bt_port_output
*upstream_port
,
82 const bt_port_input
*downstream_port
,
85 typedef bt_graph_listener_func_status
86 (*bt_graph_filter_sink_component_ports_connected_listener_func
)(
87 const bt_component_filter
*filter_component
,
88 const bt_component_sink
*sink_component
,
89 const bt_port_output
*upstream_port
,
90 const bt_port_input
*downstream_port
, void *data
);
92 typedef void (* bt_graph_listener_removed_func
)(void *data
);
94 extern bt_graph
*bt_graph_create(void);
96 typedef enum bt_graph_add_component_status
{
97 BT_GRAPH_ADD_COMPONENT_STATUS_OK
= __BT_FUNC_STATUS_OK
,
98 BT_GRAPH_ADD_COMPONENT_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
99 BT_GRAPH_ADD_COMPONENT_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
100 } bt_graph_add_component_status
;
102 extern bt_graph_add_component_status
103 bt_graph_add_source_component(bt_graph
*graph
,
104 const bt_component_class_source
*component_class
,
105 const char *name
, const bt_value
*params
,
106 bt_logging_level log_level
, const bt_component_source
**component
);
108 extern bt_graph_add_component_status
109 bt_graph_add_source_component_with_init_method_data(
111 const bt_component_class_source
*component_class
,
112 const char *name
, const bt_value
*params
,
113 void *init_method_data
, bt_logging_level log_level
,
114 const bt_component_source
**component
);
116 extern bt_graph_add_component_status
117 bt_graph_add_filter_component(bt_graph
*graph
,
118 const bt_component_class_filter
*component_class
,
119 const char *name
, const bt_value
*params
,
120 bt_logging_level log_level
,
121 const bt_component_filter
**component
);
123 extern bt_graph_add_component_status
124 bt_graph_add_filter_component_with_init_method_data(
126 const bt_component_class_filter
*component_class
,
127 const char *name
, const bt_value
*params
,
128 void *init_method_data
, bt_logging_level log_level
,
129 const bt_component_filter
**component
);
131 extern bt_graph_add_component_status
132 bt_graph_add_sink_component(
133 bt_graph
*graph
, const bt_component_class_sink
*component_class
,
134 const char *name
, const bt_value
*params
,
135 bt_logging_level log_level
,
136 const bt_component_sink
**component
);
138 extern bt_graph_add_component_status
139 bt_graph_add_sink_component_with_init_method_data(
140 bt_graph
*graph
, const bt_component_class_sink
*component_class
,
141 const char *name
, const bt_value
*params
,
142 void *init_method_data
, bt_logging_level log_level
,
143 const bt_component_sink
**component
);
145 typedef enum bt_graph_connect_ports_status
{
146 BT_GRAPH_CONNECT_PORTS_STATUS_OK
= __BT_FUNC_STATUS_OK
,
147 BT_GRAPH_CONNECT_PORTS_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
148 BT_GRAPH_CONNECT_PORTS_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
149 } bt_graph_connect_ports_status
;
151 extern bt_graph_connect_ports_status
bt_graph_connect_ports(bt_graph
*graph
,
152 const bt_port_output
*upstream
,
153 const bt_port_input
*downstream
,
154 const bt_connection
**connection
);
156 typedef enum bt_graph_run_status
{
157 BT_GRAPH_RUN_STATUS_OK
= __BT_FUNC_STATUS_OK
,
158 BT_GRAPH_RUN_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
159 BT_GRAPH_RUN_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
160 BT_GRAPH_RUN_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
161 BT_GRAPH_RUN_STATUS_END
= __BT_FUNC_STATUS_END
,
162 } bt_graph_run_status
;
164 extern bt_graph_run_status
bt_graph_run(bt_graph
*graph
);
166 typedef enum bt_graph_run_once_status
{
167 BT_GRAPH_RUN_ONCE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
168 BT_GRAPH_RUN_ONCE_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
169 BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
170 BT_GRAPH_RUN_ONCE_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
171 BT_GRAPH_RUN_ONCE_STATUS_END
= __BT_FUNC_STATUS_END
,
172 } bt_graph_run_once_status
;
174 extern bt_graph_run_once_status
bt_graph_run_once(bt_graph
*graph
);
176 typedef enum bt_graph_add_listener_status
{
177 BT_GRAPH_ADD_LISTENER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
178 BT_GRAPH_ADD_LISTENER_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
179 } bt_graph_add_listener_status
;
181 extern bt_graph_add_listener_status
182 bt_graph_add_filter_component_input_port_added_listener(
184 bt_graph_filter_component_input_port_added_listener_func listener
,
185 bt_graph_listener_removed_func listener_removed
, void *data
,
186 bt_listener_id
*listener_id
);
188 extern bt_graph_add_listener_status
189 bt_graph_add_sink_component_input_port_added_listener(
191 bt_graph_sink_component_input_port_added_listener_func listener
,
192 bt_graph_listener_removed_func listener_removed
, void *data
,
193 bt_listener_id
*listener_id
);
195 extern bt_graph_add_listener_status
196 bt_graph_add_source_component_output_port_added_listener(
198 bt_graph_source_component_output_port_added_listener_func listener
,
199 bt_graph_listener_removed_func listener_removed
, void *data
,
200 bt_listener_id
*listener_id
);
202 extern bt_graph_add_listener_status
203 bt_graph_add_filter_component_output_port_added_listener(
205 bt_graph_filter_component_output_port_added_listener_func listener
,
206 bt_graph_listener_removed_func listener_removed
, void *data
,
207 bt_listener_id
*listener_id
);
209 extern bt_graph_add_listener_status
210 bt_graph_add_source_filter_component_ports_connected_listener(
212 bt_graph_source_filter_component_ports_connected_listener_func listener
,
213 bt_graph_listener_removed_func listener_removed
, void *data
,
214 bt_listener_id
*listener_id
);
216 extern bt_graph_add_listener_status
217 bt_graph_add_filter_filter_component_ports_connected_listener(
219 bt_graph_filter_filter_component_ports_connected_listener_func listener
,
220 bt_graph_listener_removed_func listener_removed
, void *data
,
221 bt_listener_id
*listener_id
);
223 extern bt_graph_add_listener_status
224 bt_graph_add_source_sink_component_ports_connected_listener(
226 bt_graph_source_sink_component_ports_connected_listener_func listener
,
227 bt_graph_listener_removed_func listener_removed
, void *data
,
228 bt_listener_id
*listener_id
);
230 extern bt_graph_add_listener_status
231 bt_graph_add_filter_sink_component_ports_connected_listener(
233 bt_graph_filter_sink_component_ports_connected_listener_func listener
,
234 bt_graph_listener_removed_func listener_removed
, void *data
,
235 bt_listener_id
*listener_id
);
237 typedef enum bt_graph_add_interrupter_status
{
238 BT_GRAPH_ADD_INTERRUPTER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
239 BT_GRAPH_ADD_INTERRUPTER_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
240 } bt_graph_add_interrupter_status
;
242 extern bt_graph_add_interrupter_status
bt_graph_add_interrupter(bt_graph
*graph
,
243 const bt_interrupter
*interrupter
);
245 extern void bt_graph_interrupt(bt_graph
*graph
);
251 #endif /* BABELTRACE2_GRAPH_GRAPH_H */