projects / babeltrace.git / blob
? search:


f40c61047078efdc8abcf4ad573dd44bc4e7cd6a
[babeltrace.git] / src / lib / graph / graph.c
1 /*
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 */
7
8 #define BT_LOG_TAG "LIB/GRAPH"
9 #include "lib/logging.h"
10
11 #include "common/assert.h"
12 #include "lib/assert-cond.h"
13 #include <babeltrace2/graph/graph.h>
14 #include <babeltrace2/graph/component.h>
15 #include <babeltrace2/graph/port.h>
16 #include "lib/graph/message/message.h"
17 #include "compat/compiler.h"
18 #include "common/common.h"
19 #include <babeltrace2/types.h>
20 #include <babeltrace2/value.h>
21 #include "lib/value.h"
22 #include <unistd.h>
23 #include <stdbool.h>
24 #include <glib.h>
25
26 #include "component-class-sink-simple.h"
27 #include "component.h"
28 #include "component-sink.h"
29 #include "connection.h"
30 #include "graph.h"
31 #include "interrupter.h"
32 #include "message/event.h"
33 #include "message/packet.h"
34
35 typedef enum bt_graph_listener_func_status
36 (*port_added_func_t)(const void *, const void *, void *);
37
38 typedef enum bt_component_class_initialize_method_status
39 (*comp_init_method_t)(const void *, void *, const void *, void *);
40
41 struct bt_graph_listener_port_added {
42 port_added_func_t func;
43 void *data;
44 };
45
46 #define INIT_LISTENERS_ARRAY(_type, _listeners) \
47 do { \
48 _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \
49 if (!(_listeners)) { \
50 BT_LIB_LOGE_APPEND_CAUSE( \
51 "Failed to allocate one GArray."); \
52 } \
53 } while (0)
54
55 static
56 void destroy_graph(struct bt_object *obj)
57 {
58 struct bt_graph *graph = container_of(obj, struct bt_graph, base);
59
60 /*
61 * The graph's reference count is 0 if we're here. Increment
62 * it to avoid a double-destroy (possibly infinitely recursive)
63 * in this situation:
64 *
65 * 1. We put and destroy a connection.
66 * 2. This connection's destructor finalizes its active message
67 * iterators.
68 * 3. A message iterator's finalization function gets a new
69 * reference on its component (reference count goes from 0 to
70 * 1).
71 * 4. Since this component's reference count goes to 1, it takes
72 * a reference on its parent (this graph). This graph's
73 * reference count goes from 0 to 1.
74 * 5. The message iterator's finalization function puts its
75 * component reference (reference count goes from 1 to 0).
76 * 6. Since this component's reference count goes from 1 to 0,
77 * it puts its parent (this graph). This graph's reference
78 * count goes from 1 to 0.
79 * 7. Since this graph's reference count goes from 1 to 0, its
80 * destructor is called (this function).
81 *
82 * With the incrementation below, the graph's reference count at
83 * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This
84 * ensures that this function is not called two times.
85 */
86 BT_LIB_LOGI("Destroying graph: %!+g", graph);
87 obj->ref_count++;
88 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_DESTROYING;
89
90 if (graph->messages) {
91 g_ptr_array_free(graph->messages, TRUE);
92 graph->messages = NULL;
93 }
94
95 if (graph->connections) {
96 BT_LOGD_STR("Destroying connections.");
97 g_ptr_array_free(graph->connections, TRUE);
98 graph->connections = NULL;
99 }
100
101 if (graph->components) {
102 BT_LOGD_STR("Destroying components.");
103 g_ptr_array_free(graph->components, TRUE);
104 graph->components = NULL;
105 }
106
107 if (graph->interrupters) {
108 BT_LOGD_STR("Putting interrupters.");
109 g_ptr_array_free(graph->interrupters, TRUE);
110 graph->interrupters = NULL;
111 }
112
113 BT_OBJECT_PUT_REF_AND_RESET(graph->default_interrupter);
114
115 if (graph->sinks_to_consume) {
116 g_queue_free(graph->sinks_to_consume);
117 graph->sinks_to_consume = NULL;
118 }
119
120 if (graph->listeners.source_output_port_added) {
121 g_array_free(graph->listeners.source_output_port_added, TRUE);
122 graph->listeners.source_output_port_added = NULL;
123 }
124
125 if (graph->listeners.filter_output_port_added) {
126 g_array_free(graph->listeners.filter_output_port_added, TRUE);
127 graph->listeners.filter_output_port_added = NULL;
128 }
129
130 if (graph->listeners.filter_input_port_added) {
131 g_array_free(graph->listeners.filter_input_port_added, TRUE);
132 graph->listeners.filter_input_port_added = NULL;
133 }
134
135 if (graph->listeners.sink_input_port_added) {
136 g_array_free(graph->listeners.sink_input_port_added, TRUE);
137 graph->listeners.sink_input_port_added = NULL;
138 }
139
140 bt_object_pool_finalize(&graph->event_msg_pool);
141 bt_object_pool_finalize(&graph->packet_begin_msg_pool);
142 bt_object_pool_finalize(&graph->packet_end_msg_pool);
143 g_free(graph);
144 }
145
146 static
147 void destroy_message_event(struct bt_message *msg,
148 struct bt_graph *graph)
149 {
150 bt_message_event_destroy(msg);
151 }
152
153 static
154 void destroy_message_packet_begin(struct bt_message *msg,
155 struct bt_graph *graph)
156 {
157 bt_message_packet_destroy(msg);
158 }
159
160 static
161 void destroy_message_packet_end(struct bt_message *msg,
162 struct bt_graph *graph)
163 {
164 bt_message_packet_destroy(msg);
165 }
166
167 static
168 void notify_message_graph_is_destroyed(struct bt_message *msg)
169 {
170 bt_message_unlink_graph(msg);
171 }
172
173 struct bt_graph *bt_graph_create(uint64_t mip_version)
174 {
175 struct bt_graph *graph;
176 int ret;
177
178 BT_ASSERT_PRE_NO_ERROR();
179 BT_ASSERT_PRE(mip_version <= bt_get_maximal_mip_version(),
180 "Unknown MIP version: mip-version=%" PRIu64 ", "
181 "max-mip-version=%" PRIu64,
182 mip_version, bt_get_maximal_mip_version());
183 BT_LOGI_STR("Creating graph object.");
184 graph = g_new0(struct bt_graph, 1);
185 if (!graph) {
186 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one graph.");
187 goto end;
188 }
189
190 bt_object_init_shared(&graph->base, destroy_graph);
191 graph->mip_version = mip_version;
192 graph->connections = g_ptr_array_new_with_free_func(
193 (GDestroyNotify) bt_object_try_spec_release);
194 if (!graph->connections) {
195 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
196 goto error;
197 }
198 graph->components = g_ptr_array_new_with_free_func(
199 (GDestroyNotify) bt_object_try_spec_release);
200 if (!graph->components) {
201 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
202 goto error;
203 }
204 graph->sinks_to_consume = g_queue_new();
205 if (!graph->sinks_to_consume) {
206 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GQueue.");
207 goto error;
208 }
209
210 bt_graph_set_can_consume(graph, true);
211 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added,
212 graph->listeners.source_output_port_added);
213
214 if (!graph->listeners.source_output_port_added) {
215 goto error;
216 }
217
218 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added,
219 graph->listeners.filter_output_port_added);
220
221 if (!graph->listeners.filter_output_port_added) {
222 goto error;
223 }
224
225 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added,
226 graph->listeners.filter_input_port_added);
227
228 if (!graph->listeners.filter_input_port_added) {
229 goto error;
230 }
231
232 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added,
233 graph->listeners.sink_input_port_added);
234
235 if (!graph->listeners.sink_input_port_added) {
236 goto error;
237 }
238
239 graph->interrupters = g_ptr_array_new_with_free_func(
240 (GDestroyNotify) bt_object_put_ref_no_null_check);
241 if (!graph->interrupters) {
242 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
243 goto error;
244 }
245
246 graph->default_interrupter = bt_interrupter_create();
247 if (!graph->default_interrupter) {
248 BT_LIB_LOGE_APPEND_CAUSE(
249 "Failed to create one interrupter object.");
250 goto error;
251 }
252
253 bt_graph_add_interrupter(graph, graph->default_interrupter);
254 ret = bt_object_pool_initialize(&graph->event_msg_pool,
255 (bt_object_pool_new_object_func) bt_message_event_new,
256 (bt_object_pool_destroy_object_func) destroy_message_event,
257 graph);
258 if (ret) {
259 BT_LIB_LOGE_APPEND_CAUSE(
260 "Failed to initialize event message pool: ret=%d",
261 ret);
262 goto error;
263 }
264
265 ret = bt_object_pool_initialize(&graph->packet_begin_msg_pool,
266 (bt_object_pool_new_object_func) bt_message_packet_beginning_new,
267 (bt_object_pool_destroy_object_func) destroy_message_packet_begin,
268 graph);
269 if (ret) {
270 BT_LIB_LOGE_APPEND_CAUSE(
271 "Failed to initialize packet beginning message pool: ret=%d",
272 ret);
273 goto error;
274 }
275
276 ret = bt_object_pool_initialize(&graph->packet_end_msg_pool,
277 (bt_object_pool_new_object_func) bt_message_packet_end_new,
278 (bt_object_pool_destroy_object_func) destroy_message_packet_end,
279 graph);
280 if (ret) {
281 BT_LIB_LOGE_APPEND_CAUSE(
282 "Failed to initialize packet end message pool: ret=%d",
283 ret);
284 goto error;
285 }
286
287 graph->messages = g_ptr_array_new_with_free_func(
288 (GDestroyNotify) notify_message_graph_is_destroyed);
289 BT_LIB_LOGI("Created graph object: %!+g", graph);
290
291 end:
292 return (void *) graph;
293
294 error:
295 BT_OBJECT_PUT_REF_AND_RESET(graph);
296 goto end;
297 }
298
299 enum bt_graph_connect_ports_status bt_graph_connect_ports(
300 struct bt_graph *graph,
301 const struct bt_port_output *upstream_port_out,
302 const struct bt_port_input *downstream_port_in,
303 const struct bt_connection **user_connection)
304 {
305 enum bt_graph_connect_ports_status status = BT_FUNC_STATUS_OK;
306 struct bt_connection *connection = NULL;
307 struct bt_port *upstream_port = (void *) upstream_port_out;
308 struct bt_port *downstream_port = (void *) downstream_port_in;
309 struct bt_component *upstream_component = NULL;
310 struct bt_component *downstream_component = NULL;
311 enum bt_component_class_port_connected_method_status port_connected_status;
312 bool init_can_consume;
313
314 BT_ASSERT_PRE_NO_ERROR();
315 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
316 BT_ASSERT_PRE_NON_NULL(upstream_port, "Upstream port");
317 BT_ASSERT_PRE_NON_NULL(downstream_port, "Downstream port port");
318 BT_ASSERT_PRE(
319 graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
320 "Graph is not in the \"configuring\" state: %!+g", graph);
321 BT_ASSERT_PRE(!bt_port_is_connected(upstream_port),
322 "Upstream port is already connected: %!+p", upstream_port);
323 BT_ASSERT_PRE(!bt_port_is_connected(downstream_port),
324 "Downstream port is already connected: %!+p", downstream_port);
325 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port),
326 "Upstream port does not belong to a component: %!+p",
327 upstream_port);
328 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port),
329 "Downstream port does not belong to a component: %!+p",
330 downstream_port);
331 init_can_consume = graph->can_consume;
332 BT_LIB_LOGI("Connecting component ports within graph: "
333 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
334 graph, upstream_port, downstream_port);
335 bt_graph_set_can_consume(graph, false);
336 upstream_component = bt_port_borrow_component_inline(
337 (void *) upstream_port);
338 downstream_component = bt_port_borrow_component_inline(
339 (void *) downstream_port);
340
341 BT_LOGD_STR("Creating connection.");
342 connection = bt_connection_create(graph, (void *) upstream_port,
343 (void *) downstream_port);
344 if (!connection) {
345 BT_LIB_LOGE_APPEND_CAUSE("Cannot create connection object.");
346 status = BT_FUNC_STATUS_MEMORY_ERROR;
347 goto end;
348 }
349
350 BT_LIB_LOGD("Connection object created: %!+x", connection);
351
352 /*
353 * Ownership of upstream_component/downstream_component and of
354 * the connection object is transferred to the graph.
355 */
356 g_ptr_array_add(graph->connections, connection);
357
358 /*
359 * Notify both components that their port is connected.
360 */
361 BT_LIB_LOGD("Notifying upstream component that its port is connected: "
362 "%![comp-]+c, %![port-]+p", upstream_component, upstream_port);
363 port_connected_status = bt_component_port_connected(upstream_component,
364 (void *) upstream_port, (void *) downstream_port);
365 if (port_connected_status != BT_FUNC_STATUS_OK) {
366 if (port_connected_status < 0) {
367 BT_LIB_LOGW_APPEND_CAUSE(
368 "Upstream component's \"port connected\" method failed: "
369 "status=%s, %![graph-]+g, %![up-comp-]+c, "
370 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
371 bt_common_func_status_string(
372 port_connected_status),
373 graph, upstream_component, downstream_component,
374 upstream_port, downstream_port);
375 }
376
377 bt_connection_end(connection, true);
378 status = (int) port_connected_status;
379 goto end;
380 }
381
382 connection->notified_upstream_port_connected = true;
383 BT_LIB_LOGD("Notifying downstream component that its port is connected: "
384 "%![comp-]+c, %![port-]+p", downstream_component,
385 downstream_port);
386 port_connected_status = bt_component_port_connected(downstream_component,
387 (void *) downstream_port, (void *) upstream_port);
388 if (port_connected_status != BT_FUNC_STATUS_OK) {
389 if (port_connected_status < 0) {
390 BT_LIB_LOGW_APPEND_CAUSE(
391 "Downstream component's \"port connected\" method failed: "
392 "status=%s, %![graph-]+g, %![up-comp-]+c, "
393 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
394 bt_common_func_status_string(
395 port_connected_status),
396 graph, upstream_component, downstream_component,
397 upstream_port, downstream_port);
398 }
399
400 bt_connection_end(connection, true);
401 status = (int) port_connected_status;
402 goto end;
403 }
404
405 connection->notified_downstream_port_connected = true;
406
407 BT_LIB_LOGI("Connected component ports within graph: "
408 "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
409 "%![up-port-]+p, %![down-port-]+p",
410 graph, upstream_component, downstream_component,
411 upstream_port, downstream_port);
412
413 if (user_connection) {
414 /* Move reference to user */
415 *user_connection = connection;
416 }
417
418 end:
419 if (status != BT_FUNC_STATUS_OK) {
420 bt_graph_make_faulty(graph);
421 }
422
423 bt_object_put_ref(connection);
424 (void) init_can_consume;
425 bt_graph_set_can_consume(graph, init_can_consume);
426 return status;
427 }
428
429 static inline
430 int consume_graph_sink(struct bt_component_sink *comp)
431 {
432 enum bt_component_class_sink_consume_method_status consume_status;
433 struct bt_component_class_sink *sink_class = NULL;
434
435 BT_ASSERT_DBG(comp);
436 sink_class = (void *) comp->parent.class;
437 BT_ASSERT_DBG(sink_class->methods.consume);
438 BT_LIB_LOGD("Calling user's consume method: %!+c", comp);
439 consume_status = sink_class->methods.consume((void *) comp);
440 BT_LOGD("User method returned: status=%s",
441 bt_common_func_status_string(consume_status));
442 BT_ASSERT_POST_DEV(consume_status == BT_FUNC_STATUS_OK ||
443 consume_status == BT_FUNC_STATUS_END ||
444 consume_status == BT_FUNC_STATUS_AGAIN ||
445 consume_status == BT_FUNC_STATUS_ERROR ||
446 consume_status == BT_FUNC_STATUS_MEMORY_ERROR,
447 "Invalid component status returned by consuming method: "
448 "status=%s", bt_common_func_status_string(consume_status));
449 BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(consume_status);
450 if (consume_status) {
451 if (consume_status < 0) {
452 BT_LIB_LOGW_APPEND_CAUSE(
453 "Component's \"consume\" method failed: "
454 "status=%s, %![comp-]+c",
455 bt_common_func_status_string(consume_status),
456 comp);
457 }
458
459 goto end;
460 }
461
462 BT_LIB_LOGD("Consumed from sink: %![comp-]+c, status=%s",
463 comp, bt_common_func_status_string(consume_status));
464
465 end:
466 return consume_status;
467 }
468
469 /*
470 * `node` is removed from the queue of sinks to consume when passed to
471 * this function. This function adds it back to the queue if there's
472 * still something to consume afterwards.
473 */
474 static inline
475 int consume_sink_node(struct bt_graph *graph, GList *node)
476 {
477 int status;
478 struct bt_component_sink *sink;
479
480 sink = node->data;
481 status = consume_graph_sink(sink);
482 if (G_UNLIKELY(status != BT_FUNC_STATUS_END)) {
483 g_queue_push_tail_link(graph->sinks_to_consume, node);
484 goto end;
485 }
486
487 /* End reached, the node is not added back to the queue and free'd. */
488 g_queue_delete_link(graph->sinks_to_consume, node);
489
490 /* Don't forward an END status if there are sinks left to consume. */
491 if (!g_queue_is_empty(graph->sinks_to_consume)) {
492 status = BT_FUNC_STATUS_OK;
493 goto end;
494 }
495
496 end:
497 BT_LIB_LOGD("Consumed sink node: %![comp-]+c, status=%s",
498 sink, bt_common_func_status_string(status));
499 return status;
500 }
501
502 BT_HIDDEN
503 int bt_graph_consume_sink_no_check(struct bt_graph *graph,
504 struct bt_component_sink *sink)
505 {
506 int status;
507 GList *sink_node;
508 int index;
509
510 BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink);
511 BT_ASSERT_DBG(bt_component_borrow_graph((void *) sink) == graph);
512
513 if (g_queue_is_empty(graph->sinks_to_consume)) {
514 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
515 status = BT_FUNC_STATUS_END;
516 goto end;
517 }
518
519 index = g_queue_index(graph->sinks_to_consume, sink);
520 if (index < 0) {
521 BT_LIB_LOGD("Sink component is not marked as consumable: "
522 "component sink is ended: %![comp-]+c", sink);
523 status = BT_FUNC_STATUS_END;
524 goto end;
525 }
526
527 sink_node = g_queue_pop_nth_link(graph->sinks_to_consume, index);
528 BT_ASSERT_DBG(sink_node);
529 status = consume_sink_node(graph, sink_node);
530
531 end:
532 return status;
533 }
534
535 static inline
536 int consume_no_check(struct bt_graph *graph)
537 {
538 int status = BT_FUNC_STATUS_OK;
539 struct bt_component *sink;
540 GList *current_node;
541
542 BT_ASSERT_PRE_DEV(graph->has_sink,
543 "Graph has no sink component: %!+g", graph);
544 BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph);
545
546 if (G_UNLIKELY(g_queue_is_empty(graph->sinks_to_consume))) {
547 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
548 status = BT_FUNC_STATUS_END;
549 goto end;
550 }
551
552 current_node = g_queue_pop_head_link(graph->sinks_to_consume);
553 sink = current_node->data;
554 BT_LIB_LOGD("Chose next sink to consume: %!+c", sink);
555 status = consume_sink_node(graph, current_node);
556
557 end:
558 return status;
559 }
560
561 static
562 int configure_graph(struct bt_graph *graph)
563 {
564 int status = BT_FUNC_STATUS_OK;
565 uint64_t i;
566
567 BT_ASSERT_DBG(graph->config_state !=
568 BT_GRAPH_CONFIGURATION_STATE_FAULTY);
569
570 if (G_LIKELY(graph->config_state ==
571 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
572 goto end;
573 }
574
575 BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
576 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
577
578 for (i = 0; i < graph->components->len; i++) {
579 struct bt_component *comp = graph->components->pdata[i];
580 struct bt_component_sink *comp_sink = (void *) comp;
581 struct bt_component_class_sink *comp_cls_sink =
582 (void *) comp->class;
583
584 if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
585 continue;
586 }
587
588 if (comp_sink->graph_is_configured_method_called) {
589 continue;
590 }
591
592 if (comp_cls_sink->methods.graph_is_configured) {
593 enum bt_component_class_sink_graph_is_configured_method_status comp_status;
594
595 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
596 "%![graph-]+g, %![comp-]+c",
597 graph, comp);
598 comp_status = comp_cls_sink->methods.graph_is_configured(
599 (void *) comp_sink);
600 BT_LIB_LOGD("User method returned: status=%s",
601 bt_common_func_status_string(comp_status));
602 BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
603 comp_status == BT_FUNC_STATUS_ERROR ||
604 comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
605 "Unexpected returned status: status=%s",
606 bt_common_func_status_string(comp_status));
607 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(comp_status);
608 if (comp_status != BT_FUNC_STATUS_OK) {
609 if (comp_status < 0) {
610 BT_LIB_LOGW_APPEND_CAUSE(
611 "Component's \"graph is configured\" method failed: "
612 "%![comp-]+c, status=%s",
613 comp,
614 bt_common_func_status_string(
615 comp_status));
616 }
617
618 status = comp_status;
619 goto end;
620 }
621 }
622
623 comp_sink->graph_is_configured_method_called = true;
624 }
625
626 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
627
628 end:
629 return status;
630 }
631
632 enum bt_graph_run_once_status bt_graph_run_once(struct bt_graph *graph)
633 {
634 enum bt_graph_run_once_status status;
635
636 BT_ASSERT_PRE_NO_ERROR();
637 BT_ASSERT_PRE_DEV_GRAPH_NON_NULL(graph);
638 BT_ASSERT_PRE_DEV(graph->can_consume,
639 "Cannot consume graph in its current state: %!+g", graph);
640 BT_ASSERT_PRE_DEV(graph->config_state !=
641 BT_GRAPH_CONFIGURATION_STATE_FAULTY,
642 "Graph is in a faulty state: %!+g", graph);
643 bt_graph_set_can_consume(graph, false);
644 status = configure_graph(graph);
645 if (G_UNLIKELY(status)) {
646 /* configure_graph() logs errors */
647 goto end;
648 }
649
650 status = consume_no_check(graph);
651 bt_graph_set_can_consume(graph, true);
652
653 end:
654 return status;
655 }
656
657 enum bt_graph_run_status bt_graph_run(struct bt_graph *graph)
658 {
659 enum bt_graph_run_status status;
660
661 BT_ASSERT_PRE_NO_ERROR();
662 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
663 BT_ASSERT_PRE(graph->can_consume,
664 "Cannot consume graph in its current state: %!+g", graph);
665 BT_ASSERT_PRE(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY,
666 "Graph is in a faulty state: %!+g", graph);
667 bt_graph_set_can_consume(graph, false);
668 status = configure_graph(graph);
669 if (G_UNLIKELY(status)) {
670 /* configure_graph() logs errors */
671 goto end;
672 }
673
674 BT_LIB_LOGI("Running graph: %!+g", graph);
675
676 do {
677 /*
678 * Check if the graph is interrupted at each iteration.
679 * If the graph was interrupted by another thread or by
680 * a signal handler, this is NOT a warning nor an error;
681 * it was intentional: log with an INFO level only.
682 */
683 if (G_UNLIKELY(bt_graph_is_interrupted(graph))) {
684 BT_LIB_LOGI("Stopping the graph: "
685 "graph was interrupted: %!+g", graph);
686 status = BT_FUNC_STATUS_AGAIN;
687 goto end;
688 }
689
690 status = consume_no_check(graph);
691 if (G_UNLIKELY(status == BT_FUNC_STATUS_AGAIN)) {
692 /*
693 * If AGAIN is received and there are multiple
694 * sinks, go ahead and consume from the next
695 * sink.
696 *
697 * However, in the case where a single sink is
698 * left, the caller can decide to busy-wait and
699 * call bt_graph_run() continuously
700 * until the source is ready or it can decide to
701 * sleep for an arbitrary amount of time.
702 */
703 if (graph->sinks_to_consume->length > 1) {
704 status = BT_FUNC_STATUS_OK;
705 }
706 }
707 } while (status == BT_FUNC_STATUS_OK);
708
709 if (status == BT_FUNC_STATUS_END) {
710 /*
711 * The last call to consume_no_check() returned
712 * `BT_FUNC_STATUS_END`, but bt_graph_run() has no
713 * `BT_GRAPH_RUN_STATUS_END` status: replace with
714 * `BT_GRAPH_RUN_STATUS_OK` (success: graph ran
715 * completely).
716 */
717 status = BT_FUNC_STATUS_OK;
718 }
719
720 end:
721 BT_LIB_LOGI("Graph ran: %![graph-]+g, status=%s", graph,
722 bt_common_func_status_string(status));
723 bt_graph_set_can_consume(graph, true);
724 return status;
725 }
726
727 enum bt_graph_add_listener_status
728 bt_graph_add_source_component_output_port_added_listener(
729 struct bt_graph *graph,
730 bt_graph_source_component_output_port_added_listener_func func,
731 void *data, bt_listener_id *out_listener_id)
732 {
733 struct bt_graph_listener_port_added listener = {
734 .func = (port_added_func_t) func,
735 .data = data,
736 };
737 bt_listener_id listener_id;
738
739 BT_ASSERT_PRE_NO_ERROR();
740 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
741 BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
742 g_array_append_val(graph->listeners.source_output_port_added, listener);
743 listener_id = graph->listeners.source_output_port_added->len - 1;
744 BT_LIB_LOGD("Added \"source component output port added\" listener to graph: "
745 "%![graph-]+g, listener-addr=%p, id=%d", graph, listener,
746 listener_id);
747
748 if (listener_id) {
749 *out_listener_id = listener_id;
750 }
751
752 return BT_FUNC_STATUS_OK;
753 }
754
755 enum bt_graph_add_listener_status
756 bt_graph_add_filter_component_output_port_added_listener(
757 struct bt_graph *graph,
758 bt_graph_filter_component_output_port_added_listener_func func,
759 void *data, bt_listener_id *out_listener_id)
760 {
761 struct bt_graph_listener_port_added listener = {
762 .func = (port_added_func_t) func,
763 .data = data,
764 };
765 bt_listener_id listener_id;
766
767 BT_ASSERT_PRE_NO_ERROR();
768 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
769 BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
770 g_array_append_val(graph->listeners.filter_output_port_added, listener);
771 listener_id = graph->listeners.filter_output_port_added->len - 1;
772 BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: "
773 "%![graph-]+g, listener-addr=%p, id=%d", graph, listener,
774 listener_id);
775
776 if (listener_id) {
777 *out_listener_id = listener_id;
778 }
779
780 return BT_FUNC_STATUS_OK;
781 }
782
783 enum bt_graph_add_listener_status
784 bt_graph_add_filter_component_input_port_added_listener(
785 struct bt_graph *graph,
786 bt_graph_filter_component_input_port_added_listener_func func,
787 void *data, bt_listener_id *out_listener_id)
788 {
789 struct bt_graph_listener_port_added listener = {
790 .func = (port_added_func_t) func,
791 .data = data,
792 };
793 bt_listener_id listener_id;
794
795 BT_ASSERT_PRE_NO_ERROR();
796 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
797 BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
798 g_array_append_val(graph->listeners.filter_input_port_added, listener);
799 listener_id = graph->listeners.filter_input_port_added->len - 1;
800 BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: "
801 "%![graph-]+g, listener-addr=%p, id=%d", graph, listener,
802 listener_id);
803
804 if (listener_id) {
805 *out_listener_id = listener_id;
806 }
807
808 return BT_FUNC_STATUS_OK;
809 }
810
811 enum bt_graph_add_listener_status
812 bt_graph_add_sink_component_input_port_added_listener(
813 struct bt_graph *graph,
814 bt_graph_sink_component_input_port_added_listener_func func,
815 void *data, bt_listener_id *out_listener_id)
816 {
817 struct bt_graph_listener_port_added listener = {
818 .func = (port_added_func_t) func,
819 .data = data,
820 };
821 bt_listener_id listener_id;
822
823 BT_ASSERT_PRE_NO_ERROR();
824 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
825 BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
826 g_array_append_val(graph->listeners.sink_input_port_added, listener);
827 listener_id = graph->listeners.sink_input_port_added->len - 1;
828 BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: "
829 "%![graph-]+g, listener-addr=%p, id=%d", graph, listener,
830 listener_id);
831
832 if (listener_id) {
833 *out_listener_id = listener_id;
834 }
835
836 return BT_FUNC_STATUS_OK;
837 }
838
839 BT_HIDDEN
840 enum bt_graph_listener_func_status bt_graph_notify_port_added(
841 struct bt_graph *graph, struct bt_port *port)
842 {
843 uint64_t i;
844 GArray *listeners;
845 struct bt_component *comp;
846 enum bt_graph_listener_func_status status = BT_FUNC_STATUS_OK;
847
848 BT_ASSERT(graph);
849 BT_ASSERT(port);
850 BT_LIB_LOGD("Notifying graph listeners that a port was added: "
851 "%![graph-]+g, %![port-]+p", graph, port);
852 comp = bt_port_borrow_component_inline(port);
853 BT_ASSERT(comp);
854
855 switch (comp->class->type) {
856 case BT_COMPONENT_CLASS_TYPE_SOURCE:
857 {
858 switch (port->type) {
859 case BT_PORT_TYPE_OUTPUT:
860 listeners = graph->listeners.source_output_port_added;
861 break;
862 default:
863 bt_common_abort();
864 }
865
866 break;
867 }
868 case BT_COMPONENT_CLASS_TYPE_FILTER:
869 {
870 switch (port->type) {
871 case BT_PORT_TYPE_INPUT:
872 listeners = graph->listeners.filter_input_port_added;
873 break;
874 case BT_PORT_TYPE_OUTPUT:
875 listeners = graph->listeners.filter_output_port_added;
876 break;
877 default:
878 bt_common_abort();
879 }
880
881 break;
882 }
883 case BT_COMPONENT_CLASS_TYPE_SINK:
884 {
885 switch (port->type) {
886 case BT_PORT_TYPE_INPUT:
887 listeners = graph->listeners.sink_input_port_added;
888 break;
889 default:
890 bt_common_abort();
891 }
892
893 break;
894 }
895 default:
896 bt_common_abort();
897 }
898
899 for (i = 0; i < listeners->len; i++) {
900 struct bt_graph_listener_port_added *listener =
901 &g_array_index(listeners,
902 struct bt_graph_listener_port_added, i);
903
904
905 BT_ASSERT(listener->func);
906 status = listener->func(comp, port, listener->data);
907 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
908 if (status != BT_FUNC_STATUS_OK) {
909 goto end;
910 }
911 }
912
913 end:
914 return status;
915 }
916
917 BT_HIDDEN
918 void bt_graph_remove_connection(struct bt_graph *graph,
919 struct bt_connection *connection)
920 {
921 BT_ASSERT(graph);
922 BT_ASSERT(connection);
923 BT_LIB_LOGD("Removing graph's connection: %![graph-]+g, %![conn-]+x",
924 graph, connection);
925 g_ptr_array_remove(graph->connections, connection);
926 }
927
928 static inline
929 bool component_name_exists(struct bt_graph *graph, const char *name)
930 {
931 bool exists = false;
932 uint64_t i;
933
934 for (i = 0; i < graph->components->len; i++) {
935 struct bt_component *other_comp = graph->components->pdata[i];
936
937 if (strcmp(name, bt_component_get_name(other_comp)) == 0) {
938 BT_ASSERT_COND_MSG("Another component with the same name already exists in the graph: "
939 "%![other-comp-]+c, name=\"%s\"",
940 other_comp, name);
941 exists = true;
942 goto end;
943 }
944 }
945
946 end:
947 return exists;
948 }
949
950 static
951 int add_component_with_init_method_data(
952 struct bt_graph *graph,
953 struct bt_component_class *comp_cls,
954 comp_init_method_t init_method,
955 const char *name, const struct bt_value *params,
956 void *init_method_data, bt_logging_level log_level,
957 const struct bt_component **user_component)
958 {
959 int status = BT_FUNC_STATUS_OK;
960 enum bt_component_class_initialize_method_status init_status;
961 struct bt_component *component = NULL;
962 int ret;
963 bool init_can_consume;
964 struct bt_value *new_params = NULL;
965
966 BT_ASSERT(comp_cls);
967 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
968 BT_ASSERT_PRE_NAME_NON_NULL(name);
969 BT_ASSERT_PRE(
970 graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
971 "Graph is not in the \"configuring\" state: %!+g", graph);
972 BT_ASSERT_PRE(!component_name_exists(graph, name),
973 "Duplicate component name: %!+g, name=\"%s\"", graph, name);
974 BT_ASSERT_PRE_PARAM_VALUE_IS_MAP(params);
975 init_can_consume = graph->can_consume;
976 bt_graph_set_can_consume(graph, false);
977 BT_LIB_LOGI("Adding component to graph: "
978 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
979 "%![params-]+v, init-method-data-addr=%p",
980 graph, comp_cls, name,
981 bt_common_logging_level_string(log_level), params,
982 init_method_data);
983
984 if (!params) {
985 new_params = bt_value_map_create();
986 if (!new_params) {
987 BT_LIB_LOGE_APPEND_CAUSE(
988 "Cannot create empty map value object.");
989 status = BT_FUNC_STATUS_MEMORY_ERROR;
990 goto end;
991 }
992
993 params = new_params;
994 }
995
996 ret = bt_component_create(comp_cls, name, log_level, &component);
997 if (ret) {
998 BT_LIB_LOGE_APPEND_CAUSE(
999 "Cannot create empty component object: ret=%d",
1000 ret);
1001 status = BT_FUNC_STATUS_MEMORY_ERROR;
1002 goto end;
1003 }
1004
1005 /*
1006 * The user's initialization method needs to see that this
1007 * component is part of the graph. If the user method fails, we
1008 * immediately remove the component from the graph's components.
1009 */
1010 g_ptr_array_add(graph->components, component);
1011 bt_component_set_graph(component, graph);
1012 bt_value_freeze(params);
1013
1014 if (init_method) {
1015 /*
1016 * There is no use for config objects right now, so just pass
1017 * NULL.
1018 */
1019 BT_LOGD_STR("Calling user's initialization method.");
1020 init_status = init_method(component, NULL, params, init_method_data);
1021 BT_LOGD("User method returned: status=%s",
1022 bt_common_func_status_string(init_status));
1023 BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(init_status);
1024 if (init_status != BT_FUNC_STATUS_OK) {
1025 if (init_status < 0) {
1026 BT_LIB_LOGW_APPEND_CAUSE(
1027 "Component initialization method failed: "
1028 "status=%s, %![comp-]+c",
1029 bt_common_func_status_string(init_status),
1030 component);
1031 }
1032
1033 status = init_status;
1034 bt_component_set_graph(component, NULL);
1035 g_ptr_array_remove_fast(graph->components, component);
1036 goto end;
1037 }
1038 }
1039
1040 /*
1041 * Mark the component as initialized so that its finalization
1042 * method is called when it is destroyed.
1043 */
1044 component->initialized = true;
1045
1046 /*
1047 * If it's a sink component, it needs to be part of the graph's
1048 * sink queue to be consumed by bt_graph_run() or
1049 * bt_graph_run_once().
1050 */
1051 if (bt_component_is_sink(component)) {
1052 graph->has_sink = true;
1053 g_queue_push_tail(graph->sinks_to_consume, component);
1054 }
1055
1056 /*
1057 * Freeze the component class now that it's instantiated at
1058 * least once.
1059 */
1060 BT_LOGD_STR("Freezing component class.");
1061 bt_component_class_freeze(comp_cls);
1062 BT_LIB_LOGI("Added component to graph: "
1063 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1064 "%![params-]+v, init-method-data-addr=%p, %![comp-]+c",
1065 graph, comp_cls, name,
1066 bt_common_logging_level_string(log_level), params,
1067 init_method_data, component);
1068
1069 if (user_component) {
1070 /* Move reference to user */
1071 *user_component = component;
1072 }
1073
1074 end:
1075 if (status != BT_FUNC_STATUS_OK) {
1076 bt_graph_make_faulty(graph);
1077 }
1078
1079 bt_object_put_ref(component);
1080 bt_object_put_ref(new_params);
1081 (void) init_can_consume;
1082 bt_graph_set_can_consume(graph, init_can_consume);
1083 return status;
1084 }
1085
1086 enum bt_graph_add_component_status
1087 bt_graph_add_source_component_with_initialize_method_data(
1088 struct bt_graph *graph,
1089 const struct bt_component_class_source *comp_cls,
1090 const char *name, const struct bt_value *params,
1091 void *init_method_data, bt_logging_level log_level,
1092 const struct bt_component_source **component)
1093 {
1094 BT_ASSERT_PRE_NO_ERROR();
1095 BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
1096 return add_component_with_init_method_data(graph,
1097 (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init,
1098 name, params, init_method_data, log_level, (void *) component);
1099 }
1100
1101 enum bt_graph_add_component_status bt_graph_add_source_component(
1102 struct bt_graph *graph,
1103 const struct bt_component_class_source *comp_cls,
1104 const char *name, const struct bt_value *params,
1105 enum bt_logging_level log_level,
1106 const struct bt_component_source **component)
1107 {
1108 BT_ASSERT_PRE_NO_ERROR();
1109 return bt_graph_add_source_component_with_initialize_method_data(
1110 graph, comp_cls, name, params, NULL, log_level, component);
1111 }
1112
1113 enum bt_graph_add_component_status
1114 bt_graph_add_filter_component_with_initialize_method_data(
1115 struct bt_graph *graph,
1116 const struct bt_component_class_filter *comp_cls,
1117 const char *name, const struct bt_value *params,
1118 void *init_method_data, enum bt_logging_level log_level,
1119 const struct bt_component_filter **component)
1120 {
1121 BT_ASSERT_PRE_NO_ERROR();
1122 BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
1123 return add_component_with_init_method_data(graph,
1124 (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init,
1125 name, params, init_method_data, log_level, (void *) component);
1126 }
1127
1128 enum bt_graph_add_component_status bt_graph_add_filter_component(
1129 struct bt_graph *graph,
1130 const struct bt_component_class_filter *comp_cls,
1131 const char *name, const struct bt_value *params,
1132 enum bt_logging_level log_level,
1133 const struct bt_component_filter **component)
1134 {
1135 BT_ASSERT_PRE_NO_ERROR();
1136 return bt_graph_add_filter_component_with_initialize_method_data(
1137 graph, comp_cls, name, params, NULL, log_level, component);
1138 }
1139
1140 enum bt_graph_add_component_status
1141 bt_graph_add_sink_component_with_initialize_method_data(
1142 struct bt_graph *graph,
1143 const struct bt_component_class_sink *comp_cls,
1144 const char *name, const struct bt_value *params,
1145 void *init_method_data, enum bt_logging_level log_level,
1146 const struct bt_component_sink **component)
1147 {
1148 BT_ASSERT_PRE_NO_ERROR();
1149 BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
1150 return add_component_with_init_method_data(graph,
1151 (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init,
1152 name, params, init_method_data, log_level, (void *) component);
1153 }
1154
1155 enum bt_graph_add_component_status bt_graph_add_sink_component(
1156 struct bt_graph *graph,
1157 const struct bt_component_class_sink *comp_cls,
1158 const char *name, const struct bt_value *params,
1159 enum bt_logging_level log_level,
1160 const struct bt_component_sink **component)
1161 {
1162 BT_ASSERT_PRE_NO_ERROR();
1163 return bt_graph_add_sink_component_with_initialize_method_data(
1164 graph, comp_cls, name, params, NULL, log_level, component);
1165 }
1166
1167 enum bt_graph_add_component_status
1168 bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name,
1169 bt_graph_simple_sink_component_initialize_func init_func,
1170 bt_graph_simple_sink_component_consume_func consume_func,
1171 bt_graph_simple_sink_component_finalize_func finalize_func,
1172 void *user_data, const bt_component_sink **component)
1173 {
1174 enum bt_graph_add_component_status status;
1175 struct bt_component_class_sink *comp_cls;
1176 struct simple_sink_init_method_data init_method_data = {
1177 .init_func = init_func,
1178 .consume_func = consume_func,
1179 .finalize_func = finalize_func,
1180 .user_data = user_data,
1181 };
1182
1183 BT_ASSERT_PRE_NO_ERROR();
1184
1185 /*
1186 * Other preconditions are checked by
1187 * bt_graph_add_sink_component_with_init_method_data().
1188 */
1189 BT_ASSERT_PRE_NON_NULL(consume_func, "Consume function");
1190
1191 comp_cls = bt_component_class_sink_simple_borrow();
1192 if (!comp_cls) {
1193 BT_LIB_LOGE_APPEND_CAUSE(
1194 "Cannot borrow simple sink component class.");
1195 status = BT_FUNC_STATUS_MEMORY_ERROR;
1196 goto end;
1197 }
1198
1199 status = bt_graph_add_sink_component_with_initialize_method_data(graph,
1200 comp_cls, name, NULL, &init_method_data,
1201 BT_LOGGING_LEVEL_NONE, component);
1202
1203 end:
1204 return status;
1205 }
1206
1207 BT_HIDDEN
1208 void bt_graph_add_message(struct bt_graph *graph,
1209 struct bt_message *msg)
1210 {
1211 BT_ASSERT(graph);
1212 BT_ASSERT(msg);
1213
1214 /*
1215 * It's okay not to take a reference because, when a
1216 * message's reference count drops to 0, either:
1217 *
1218 * * It is recycled back to one of this graph's pool.
1219 * * It is destroyed because it doesn't have any link to any
1220 * graph, which means the original graph is already destroyed.
1221 */
1222 g_ptr_array_add(graph->messages, msg);
1223 }
1224
1225 BT_HIDDEN
1226 bool bt_graph_is_interrupted(const struct bt_graph *graph)
1227 {
1228 BT_ASSERT_DBG(graph);
1229 return bt_interrupter_array_any_is_set(graph->interrupters);
1230 }
1231
1232 enum bt_graph_add_interrupter_status bt_graph_add_interrupter(
1233 struct bt_graph *graph, const struct bt_interrupter *intr)
1234 {
1235 BT_ASSERT_PRE_NO_ERROR();
1236 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
1237 BT_ASSERT_PRE_INTR_NON_NULL(intr);
1238 g_ptr_array_add(graph->interrupters, (void *) intr);
1239 bt_object_get_ref_no_null_check(intr);
1240 BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z",
1241 graph, intr);
1242 return BT_FUNC_STATUS_OK;
1243 }
1244
1245 struct bt_interrupter *bt_graph_borrow_default_interrupter(bt_graph *graph)
1246 {
1247 BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
1248 return graph->default_interrupter;
1249 }
1250
1251 void bt_graph_get_ref(const struct bt_graph *graph)
1252 {
1253 bt_object_get_ref(graph);
1254 }
1255
1256 void bt_graph_put_ref(const struct bt_graph *graph)
1257 {
1258 bt_object_put_ref(graph);
1259 }
BabelTrace - Trace Format Babel Tower
This page took 0.06681 seconds and 3 git commands to generate.