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 enum bt_graph_simple_sink_component_initialize_func_status
{
93 BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_OK
= __BT_FUNC_STATUS_OK
,
94 BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
95 BT_GRAPH_SIMPLE_SINK_COMPONENT_INITIALIZE_FUNC_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
96 } bt_graph_simple_sink_component_initialize_func_status
;
98 typedef bt_graph_simple_sink_component_initialize_func_status
99 (*bt_graph_simple_sink_component_initialize_func
)(
100 bt_self_component_port_input_message_iterator
*iterator
,
103 typedef enum bt_graph_simple_sink_component_consume_func_status
{
104 BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_OK
= __BT_FUNC_STATUS_OK
,
105 BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
106 BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
107 BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
108 BT_GRAPH_SIMPLE_SINK_COMPONENT_CONSUME_FUNC_STATUS_END
= __BT_FUNC_STATUS_END
,
109 } bt_graph_simple_sink_component_consume_func_status
;
111 typedef bt_graph_simple_sink_component_consume_func_status
112 (*bt_graph_simple_sink_component_consume_func
)(
113 bt_self_component_port_input_message_iterator
*iterator
,
116 typedef void (*bt_graph_simple_sink_component_finalize_func
)(void *data
);
118 extern bt_graph
*bt_graph_create(uint64_t mip_version
);
120 typedef enum bt_graph_add_component_status
{
121 BT_GRAPH_ADD_COMPONENT_STATUS_OK
= __BT_FUNC_STATUS_OK
,
122 BT_GRAPH_ADD_COMPONENT_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
123 BT_GRAPH_ADD_COMPONENT_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
124 } bt_graph_add_component_status
;
126 extern bt_graph_add_component_status
127 bt_graph_add_source_component(bt_graph
*graph
,
128 const bt_component_class_source
*component_class
,
129 const char *name
, const bt_value
*params
,
130 bt_logging_level log_level
, const bt_component_source
**component
);
132 extern bt_graph_add_component_status
133 bt_graph_add_source_component_with_initialize_method_data(
135 const bt_component_class_source
*component_class
,
136 const char *name
, const bt_value
*params
,
137 void *init_method_data
, bt_logging_level log_level
,
138 const bt_component_source
**component
);
140 extern bt_graph_add_component_status
141 bt_graph_add_filter_component(bt_graph
*graph
,
142 const bt_component_class_filter
*component_class
,
143 const char *name
, const bt_value
*params
,
144 bt_logging_level log_level
,
145 const bt_component_filter
**component
);
147 extern bt_graph_add_component_status
148 bt_graph_add_filter_component_with_initialize_method_data(
150 const bt_component_class_filter
*component_class
,
151 const char *name
, const bt_value
*params
,
152 void *init_method_data
, bt_logging_level log_level
,
153 const bt_component_filter
**component
);
155 extern bt_graph_add_component_status
156 bt_graph_add_sink_component(
157 bt_graph
*graph
, const bt_component_class_sink
*component_class
,
158 const char *name
, const bt_value
*params
,
159 bt_logging_level log_level
,
160 const bt_component_sink
**component
);
162 extern bt_graph_add_component_status
163 bt_graph_add_sink_component_with_initialize_method_data(
164 bt_graph
*graph
, const bt_component_class_sink
*component_class
,
165 const char *name
, const bt_value
*params
,
166 void *init_method_data
, bt_logging_level log_level
,
167 const bt_component_sink
**component
);
169 extern bt_graph_add_component_status
170 bt_graph_add_simple_sink_component(bt_graph
*graph
, const char *name
,
171 bt_graph_simple_sink_component_initialize_func init_func
,
172 bt_graph_simple_sink_component_consume_func consume_func
,
173 bt_graph_simple_sink_component_finalize_func finalize_func
,
174 void *user_data
, const bt_component_sink
**component
);
176 typedef enum bt_graph_connect_ports_status
{
177 BT_GRAPH_CONNECT_PORTS_STATUS_OK
= __BT_FUNC_STATUS_OK
,
178 BT_GRAPH_CONNECT_PORTS_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
179 BT_GRAPH_CONNECT_PORTS_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
180 } bt_graph_connect_ports_status
;
182 extern bt_graph_connect_ports_status
bt_graph_connect_ports(bt_graph
*graph
,
183 const bt_port_output
*upstream
,
184 const bt_port_input
*downstream
,
185 const bt_connection
**connection
);
187 typedef enum bt_graph_run_status
{
188 BT_GRAPH_RUN_STATUS_OK
= __BT_FUNC_STATUS_OK
,
189 BT_GRAPH_RUN_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
190 BT_GRAPH_RUN_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
191 BT_GRAPH_RUN_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
192 } bt_graph_run_status
;
194 extern bt_graph_run_status
bt_graph_run(bt_graph
*graph
);
196 typedef enum bt_graph_run_once_status
{
197 BT_GRAPH_RUN_ONCE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
198 BT_GRAPH_RUN_ONCE_STATUS_ERROR
= __BT_FUNC_STATUS_ERROR
,
199 BT_GRAPH_RUN_ONCE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
200 BT_GRAPH_RUN_ONCE_STATUS_AGAIN
= __BT_FUNC_STATUS_AGAIN
,
201 BT_GRAPH_RUN_ONCE_STATUS_END
= __BT_FUNC_STATUS_END
,
202 } bt_graph_run_once_status
;
204 extern bt_graph_run_once_status
bt_graph_run_once(bt_graph
*graph
);
206 typedef enum bt_graph_add_listener_status
{
207 BT_GRAPH_ADD_LISTENER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
208 BT_GRAPH_ADD_LISTENER_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
209 } bt_graph_add_listener_status
;
211 extern bt_graph_add_listener_status
212 bt_graph_add_filter_component_input_port_added_listener(
214 bt_graph_filter_component_input_port_added_listener_func listener
,
215 void *data
, bt_listener_id
*listener_id
);
217 extern bt_graph_add_listener_status
218 bt_graph_add_sink_component_input_port_added_listener(
220 bt_graph_sink_component_input_port_added_listener_func listener
,
221 void *data
, bt_listener_id
*listener_id
);
223 extern bt_graph_add_listener_status
224 bt_graph_add_source_component_output_port_added_listener(
226 bt_graph_source_component_output_port_added_listener_func listener
,
227 void *data
, bt_listener_id
*listener_id
);
229 extern bt_graph_add_listener_status
230 bt_graph_add_filter_component_output_port_added_listener(
232 bt_graph_filter_component_output_port_added_listener_func listener
,
233 void *data
, bt_listener_id
*listener_id
);
235 typedef enum bt_graph_add_interrupter_status
{
236 BT_GRAPH_ADD_INTERRUPTER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
237 BT_GRAPH_ADD_INTERRUPTER_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
238 } bt_graph_add_interrupter_status
;
240 extern bt_graph_add_interrupter_status
bt_graph_add_interrupter(bt_graph
*graph
,
241 const bt_interrupter
*interrupter
);
243 extern bt_interrupter
*bt_graph_borrow_default_interrupter(bt_graph
*graph
);
249 #endif /* BABELTRACE2_GRAPH_GRAPH_H */