4 * Babeltrace Plugin Component Graph
6 * Copyright 2017 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
29 #include <babeltrace/component/component-internal.h>
30 #include <babeltrace/component/graph-internal.h>
31 #include <babeltrace/component/connection-internal.h>
32 #include <babeltrace/component/component-sink-internal.h>
33 #include <babeltrace/component/component-source.h>
34 #include <babeltrace/component/component-filter.h>
35 #include <babeltrace/component/port.h>
36 #include <babeltrace/compiler.h>
40 void bt_graph_destroy(struct bt_object
*obj
)
42 struct bt_graph
*graph
= container_of(obj
,
43 struct bt_graph
, base
);
45 if (graph
->components
) {
46 g_ptr_array_free(graph
->components
, TRUE
);
48 if (graph
->connections
) {
49 g_ptr_array_free(graph
->connections
, TRUE
);
51 if (graph
->sinks_to_consume
) {
52 g_queue_free(graph
->sinks_to_consume
);
57 struct bt_graph
*bt_graph_create(void)
59 struct bt_graph
*graph
;
61 graph
= g_new0(struct bt_graph
, 1);
66 bt_object_init(graph
, bt_graph_destroy
);
68 graph
->connections
= g_ptr_array_new_with_free_func(bt_object_release
);
69 if (!graph
->connections
) {
72 graph
->components
= g_ptr_array_new_with_free_func(bt_object_release
);
73 if (!graph
->components
) {
76 graph
->sinks_to_consume
= g_queue_new();
77 if (!graph
->sinks_to_consume
) {
87 struct bt_connection
*bt_graph_connect(struct bt_graph
*graph
,
88 struct bt_port
*upstream_port
,
89 struct bt_port
*downstream_port
)
91 struct bt_connection
*connection
= NULL
;
92 struct bt_graph
*upstream_graph
= NULL
;
93 struct bt_graph
*downstream_graph
= NULL
;
94 struct bt_component
*upstream_component
= NULL
;
95 struct bt_component
*downstream_component
= NULL
;
96 enum bt_component_status component_status
;
97 bool components_added
= false;
99 if (!graph
|| !upstream_port
|| !downstream_port
) {
103 if (bt_port_get_type(upstream_port
) != BT_PORT_TYPE_OUTPUT
) {
106 if (bt_port_get_type(downstream_port
) != BT_PORT_TYPE_INPUT
) {
110 /* Ensure the components are not already part of another graph. */
111 upstream_component
= bt_port_get_component(upstream_port
);
112 assert(upstream_component
);
113 upstream_graph
= bt_component_get_graph(upstream_component
);
114 if (upstream_graph
&& (graph
!= upstream_graph
)) {
115 fprintf(stderr
, "Upstream component is already part of another graph\n");
119 downstream_component
= bt_port_get_component(downstream_port
);
120 assert(downstream_component
);
121 downstream_graph
= bt_component_get_graph(downstream_component
);
122 if (downstream_graph
&& (graph
!= downstream_graph
)) {
123 fprintf(stderr
, "Downstream component is already part of another graph\n");
127 connection
= bt_connection_create(graph
, upstream_port
,
134 * Ownership of up/downstream_component and of the connection object is
135 * transferred to the graph.
137 g_ptr_array_add(graph
->connections
, connection
);
138 g_ptr_array_add(graph
->components
, upstream_component
);
139 g_ptr_array_add(graph
->components
, downstream_component
);
140 if (bt_component_get_class_type(downstream_component
) ==
141 BT_COMPONENT_CLASS_TYPE_SINK
) {
142 g_queue_push_tail(graph
->sinks_to_consume
,
143 downstream_component
);
147 * The graph is now the parent of these components which garantees their
148 * existence for the duration of the graph's lifetime.
150 bt_component_set_graph(upstream_component
, graph
);
151 bt_put(upstream_component
);
152 bt_component_set_graph(downstream_component
, graph
);
153 bt_put(downstream_component
);
155 /* Rollback the connection from this point on. */
156 components_added
= true;
159 * The components and connection are added to the graph before invoking
160 * the new_connection method in order to make them visible to the
161 * components during the method's invocation.
163 component_status
= bt_component_new_connection(upstream_component
,
164 upstream_port
, connection
);
165 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
168 component_status
= bt_component_new_connection(downstream_component
,
169 downstream_port
, connection
);
170 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
174 bt_put(upstream_graph
);
175 bt_put(downstream_graph
);
178 if (components_added
) {
179 if (bt_component_get_class_type(downstream_component
) ==
180 BT_COMPONENT_CLASS_TYPE_SINK
) {
181 g_queue_pop_tail(graph
->sinks_to_consume
);
183 g_ptr_array_set_size(graph
->connections
,
184 graph
->connections
->len
- 1);
185 g_ptr_array_set_size(graph
->components
,
186 graph
->components
->len
- 2);
192 enum bt_component_status
get_component_port_counts(
193 struct bt_component
*component
, uint64_t *input_count
,
194 uint64_t *output_count
)
196 enum bt_component_status ret
;
198 switch (bt_component_get_class_type(component
)) {
199 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
200 ret
= bt_component_source_get_output_port_count(component
,
202 if (ret
!= BT_COMPONENT_STATUS_OK
) {
206 case BT_COMPONENT_CLASS_TYPE_FILTER
:
207 ret
= bt_component_filter_get_output_port_count(component
,
209 if (ret
!= BT_COMPONENT_STATUS_OK
) {
212 ret
= bt_component_filter_get_input_port_count(component
,
214 if (ret
!= BT_COMPONENT_STATUS_OK
) {
218 case BT_COMPONENT_CLASS_TYPE_SINK
:
219 ret
= bt_component_sink_get_input_port_count(component
,
221 if (ret
!= BT_COMPONENT_STATUS_OK
) {
229 ret
= BT_COMPONENT_STATUS_OK
;
235 struct bt_port
*get_input_port(struct bt_component
*component
, int index
)
237 struct bt_port
*port
= NULL
;
239 switch (bt_component_get_class_type(component
)) {
240 case BT_COMPONENT_CLASS_TYPE_FILTER
:
241 port
= bt_component_filter_get_input_port_at_index(component
,
244 case BT_COMPONENT_CLASS_TYPE_SINK
:
245 port
= bt_component_sink_get_input_port_at_index(component
,
255 struct bt_port
*get_output_port(struct bt_component
*component
, int index
)
257 struct bt_port
*port
= NULL
;
259 switch (bt_component_get_class_type(component
)) {
260 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
261 port
= bt_component_source_get_output_port_at_index(component
,
264 case BT_COMPONENT_CLASS_TYPE_FILTER
:
265 port
= bt_component_filter_get_output_port_at_index(component
,
274 enum bt_graph_status
bt_graph_add_component_as_sibling(struct bt_graph
*graph
,
275 struct bt_component
*origin
,
276 struct bt_component
*new_component
)
278 uint64_t origin_input_port_count
= 0;
279 uint64_t origin_output_port_count
= 0;
280 uint64_t new_input_port_count
= 0;
281 uint64_t new_output_port_count
= 0;
282 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
283 struct bt_graph
*origin_graph
= NULL
;
284 struct bt_graph
*new_graph
= NULL
;
285 struct bt_port
*origin_port
= NULL
;
286 struct bt_port
*new_port
= NULL
;
287 struct bt_port
*upstream_port
= NULL
;
288 struct bt_port
*downstream_port
= NULL
;
289 struct bt_connection
*origin_connection
= NULL
;
290 struct bt_connection
*new_connection
= NULL
;
293 if (!graph
|| !origin
|| !new_component
) {
294 status
= BT_GRAPH_STATUS_INVALID
;
298 if (bt_component_get_class_type(origin
) !=
299 bt_component_get_class_type(new_component
)) {
300 status
= BT_GRAPH_STATUS_INVALID
;
304 origin_graph
= bt_component_get_graph(origin
);
305 if (!origin_graph
|| (origin_graph
!= graph
)) {
306 status
= BT_GRAPH_STATUS_INVALID
;
310 new_graph
= bt_component_get_graph(new_component
);
312 status
= BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH
;
316 if (get_component_port_counts(origin
, &origin_input_port_count
,
317 &origin_output_port_count
) != BT_COMPONENT_STATUS_OK
) {
318 status
= BT_GRAPH_STATUS_INVALID
;
321 if (get_component_port_counts(new_component
, &new_input_port_count
,
322 &new_output_port_count
) != BT_COMPONENT_STATUS_OK
) {
323 status
= BT_GRAPH_STATUS_INVALID
;
327 if (origin_input_port_count
!= new_input_port_count
||
328 origin_output_port_count
!= new_output_port_count
) {
329 status
= BT_GRAPH_STATUS_INVALID
;
333 /* Replicate input connections. */
334 for (port_index
= 0; port_index
< origin_input_port_count
; port_index
++) {
335 uint64_t connection_count
, connection_index
;
337 origin_port
= get_input_port(origin
, port_index
);
339 status
= BT_GRAPH_STATUS_ERROR
;
340 goto error_disconnect
;
342 new_port
= get_input_port(new_component
, port_index
);
344 status
= BT_GRAPH_STATUS_ERROR
;
345 goto error_disconnect
;
348 if (bt_port_get_connection_count(origin_port
, &connection_count
) !=
350 status
= BT_GRAPH_STATUS_ERROR
;
351 goto error_disconnect
;
354 for (connection_index
= 0; connection_index
< connection_count
;
355 connection_index
++) {
356 origin_connection
= bt_port_get_connection(origin_port
,
358 if (!origin_connection
) {
359 goto error_disconnect
;
362 upstream_port
= bt_connection_get_output_port(
364 if (!upstream_port
) {
365 goto error_disconnect
;
368 new_connection
= bt_graph_connect(graph
, upstream_port
,
370 if (!new_connection
) {
371 goto error_disconnect
;
374 BT_PUT(upstream_port
);
375 BT_PUT(origin_connection
);
376 BT_PUT(new_connection
);
382 /* Replicate output connections. */
383 for (port_index
= 0; port_index
< origin_output_port_count
; port_index
++) {
384 uint64_t connection_count
, connection_index
;
386 origin_port
= get_output_port(origin
, port_index
);
388 status
= BT_GRAPH_STATUS_ERROR
;
389 goto error_disconnect
;
391 new_port
= get_output_port(new_component
, port_index
);
393 status
= BT_GRAPH_STATUS_ERROR
;
394 goto error_disconnect
;
397 if (bt_port_get_connection_count(origin_port
, &connection_count
) !=
399 status
= BT_GRAPH_STATUS_ERROR
;
400 goto error_disconnect
;
403 for (connection_index
= 0; connection_index
< connection_count
;
404 connection_index
++) {
405 origin_connection
= bt_port_get_connection(origin_port
,
407 if (!origin_connection
) {
408 goto error_disconnect
;
411 downstream_port
= bt_connection_get_input_port(
413 if (!downstream_port
) {
414 goto error_disconnect
;
417 new_connection
= bt_graph_connect(graph
, new_port
,
419 if (!new_connection
) {
420 goto error_disconnect
;
423 BT_PUT(downstream_port
);
424 BT_PUT(origin_connection
);
425 BT_PUT(new_connection
);
431 bt_put(origin_graph
);
435 bt_put(upstream_port
);
436 bt_put(downstream_port
);
437 bt_put(origin_connection
);
438 bt_put(new_connection
);
441 /* Destroy all connections of the new component. */
446 enum bt_component_status
bt_graph_consume(struct bt_graph
*graph
)
448 struct bt_component
*sink
;
449 enum bt_component_status status
;
453 status
= BT_COMPONENT_STATUS_INVALID
;
457 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
458 status
= BT_COMPONENT_STATUS_END
;
462 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
463 sink
= current_node
->data
;
464 status
= bt_component_sink_consume(sink
);
465 if (status
!= BT_COMPONENT_STATUS_END
) {
466 g_queue_push_tail_link(graph
->sinks_to_consume
, current_node
);
470 /* End reached, the node is not added back to the queue and free'd. */
471 g_queue_delete_link(graph
->sinks_to_consume
, current_node
);
473 /* Don't forward an END status if there are sinks left to consume. */
474 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
475 status
= BT_GRAPH_STATUS_OK
;
482 enum bt_graph_status
bt_graph_run(struct bt_graph
*graph
,
483 enum bt_component_status
*_component_status
)
485 enum bt_component_status component_status
;
486 enum bt_graph_status graph_status
= BT_GRAPH_STATUS_OK
;
489 graph_status
= BT_GRAPH_STATUS_INVALID
;
494 component_status
= bt_graph_consume(graph
);
495 if (component_status
== BT_COMPONENT_STATUS_AGAIN
) {
497 * If AGAIN is received and there are multiple sinks,
498 * go ahead and consume from the next sink.
500 * However, in the case where a single sink is left,
501 * the caller can decide to busy-wait and call
502 * bt_graph_run continuously until the source is ready
503 * or it can decide to sleep for an arbitrary amount of
506 if (graph
->sinks_to_consume
->length
> 1) {
507 component_status
= BT_COMPONENT_STATUS_OK
;
510 } while (component_status
== BT_COMPONENT_STATUS_OK
);
512 if (_component_status
) {
513 *_component_status
= component_status
;
516 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
517 graph_status
= BT_GRAPH_STATUS_END
;
518 } else if (component_status
== BT_COMPONENT_STATUS_AGAIN
) {
519 graph_status
= BT_GRAPH_STATUS_AGAIN
;
521 graph_status
= BT_GRAPH_STATUS_ERROR
;