2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to deal
7 * in the Software without restriction, including without limitation the rights
8 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 * copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 #define BT_LOG_TAG "LIB/GRAPH"
25 #include "lib/logging.h"
27 #include "common/assert.h"
28 #include "lib/assert-pre.h"
29 #include "lib/assert-post.h"
30 #include <babeltrace2/graph/graph.h>
31 #include <babeltrace2/graph/graph-const.h>
32 #include <babeltrace2/graph/component-source-const.h>
33 #include <babeltrace2/graph/component-filter-const.h>
34 #include <babeltrace2/graph/port-const.h>
35 #include "lib/graph/message/message.h"
36 #include "compat/compiler.h"
37 #include "common/common.h"
38 #include <babeltrace2/types.h>
39 #include <babeltrace2/value.h>
40 #include <babeltrace2/value-const.h>
41 #include "lib/value.h"
46 #include "component-class-sink-simple.h"
47 #include "component.h"
48 #include "component-sink.h"
49 #include "connection.h"
51 #include "interrupter.h"
52 #include "message/event.h"
53 #include "message/packet.h"
55 typedef enum bt_graph_listener_func_status
56 (*port_added_func_t
)(const void *, const void *, void *);
58 typedef enum bt_graph_listener_func_status
59 (*ports_connected_func_t
)(const void *, const void *, const void *,
60 const void *, void *);
62 typedef enum bt_component_class_initialize_method_status
63 (*comp_init_method_t
)(const void *, void *, const void *, void *);
65 struct bt_graph_listener
{
66 bt_graph_listener_removed_func removed
;
70 struct bt_graph_listener_port_added
{
71 struct bt_graph_listener base
;
72 port_added_func_t func
;
75 struct bt_graph_listener_ports_connected
{
76 struct bt_graph_listener base
;
77 ports_connected_func_t func
;
80 #define INIT_LISTENERS_ARRAY(_type, _listeners) \
82 _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \
83 if (!(_listeners)) { \
84 BT_LIB_LOGE_APPEND_CAUSE( \
85 "Failed to allocate one GArray."); \
89 #define CALL_REMOVE_LISTENERS(_type, _listeners) \
96 for (i = 0; i < (_listeners)->len; i++) { \
98 &g_array_index((_listeners), _type, i); \
100 if (listener->base.removed) { \
101 listener->base.removed(listener->base.data); \
107 void destroy_graph(struct bt_object
*obj
)
109 struct bt_graph
*graph
= container_of(obj
, struct bt_graph
, base
);
112 * The graph's reference count is 0 if we're here. Increment
113 * it to avoid a double-destroy (possibly infinitely recursive)
116 * 1. We put and destroy a connection.
117 * 2. This connection's destructor finalizes its active message
119 * 3. A message iterator's finalization function gets a new
120 * reference on its component (reference count goes from 0 to
122 * 4. Since this component's reference count goes to 1, it takes
123 * a reference on its parent (this graph). This graph's
124 * reference count goes from 0 to 1.
125 * 5. The message iterator's finalization function puts its
126 * component reference (reference count goes from 1 to 0).
127 * 6. Since this component's reference count goes from 1 to 0,
128 * it puts its parent (this graph). This graph's reference
129 * count goes from 1 to 0.
130 * 7. Since this graph's reference count goes from 1 to 0, its
131 * destructor is called (this function).
133 * With the incrementation below, the graph's reference count at
134 * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This
135 * ensures that this function is not called two times.
137 BT_LIB_LOGI("Destroying graph: %!+g", graph
);
139 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_DESTROYING
;
141 /* Call all remove listeners */
142 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
143 graph
->listeners
.source_output_port_added
);
144 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
145 graph
->listeners
.filter_output_port_added
);
146 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
147 graph
->listeners
.filter_input_port_added
);
148 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
149 graph
->listeners
.sink_input_port_added
);
150 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
151 graph
->listeners
.source_filter_ports_connected
);
152 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
153 graph
->listeners
.filter_filter_ports_connected
);
154 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
155 graph
->listeners
.source_sink_ports_connected
);
156 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
157 graph
->listeners
.filter_sink_ports_connected
);
159 if (graph
->messages
) {
160 g_ptr_array_free(graph
->messages
, TRUE
);
161 graph
->messages
= NULL
;
164 if (graph
->connections
) {
165 BT_LOGD_STR("Destroying connections.");
166 g_ptr_array_free(graph
->connections
, TRUE
);
167 graph
->connections
= NULL
;
170 if (graph
->components
) {
171 BT_LOGD_STR("Destroying components.");
172 g_ptr_array_free(graph
->components
, TRUE
);
173 graph
->components
= NULL
;
176 if (graph
->interrupters
) {
177 BT_LOGD_STR("Putting interrupters.");
178 g_ptr_array_free(graph
->interrupters
, TRUE
);
179 graph
->interrupters
= NULL
;
182 BT_OBJECT_PUT_REF_AND_RESET(graph
->default_interrupter
);
184 if (graph
->sinks_to_consume
) {
185 g_queue_free(graph
->sinks_to_consume
);
186 graph
->sinks_to_consume
= NULL
;
189 if (graph
->listeners
.source_output_port_added
) {
190 g_array_free(graph
->listeners
.source_output_port_added
, TRUE
);
191 graph
->listeners
.source_output_port_added
= NULL
;
194 if (graph
->listeners
.filter_output_port_added
) {
195 g_array_free(graph
->listeners
.filter_output_port_added
, TRUE
);
196 graph
->listeners
.filter_output_port_added
= NULL
;
199 if (graph
->listeners
.filter_input_port_added
) {
200 g_array_free(graph
->listeners
.filter_input_port_added
, TRUE
);
201 graph
->listeners
.filter_input_port_added
= NULL
;
204 if (graph
->listeners
.sink_input_port_added
) {
205 g_array_free(graph
->listeners
.sink_input_port_added
, TRUE
);
206 graph
->listeners
.sink_input_port_added
= NULL
;
209 if (graph
->listeners
.source_filter_ports_connected
) {
210 g_array_free(graph
->listeners
.source_filter_ports_connected
,
212 graph
->listeners
.source_filter_ports_connected
= NULL
;
215 if (graph
->listeners
.filter_filter_ports_connected
) {
216 g_array_free(graph
->listeners
.filter_filter_ports_connected
,
218 graph
->listeners
.filter_filter_ports_connected
= NULL
;
221 if (graph
->listeners
.source_sink_ports_connected
) {
222 g_array_free(graph
->listeners
.source_sink_ports_connected
,
224 graph
->listeners
.source_sink_ports_connected
= NULL
;
227 if (graph
->listeners
.filter_sink_ports_connected
) {
228 g_array_free(graph
->listeners
.filter_sink_ports_connected
,
230 graph
->listeners
.filter_sink_ports_connected
= NULL
;
233 bt_object_pool_finalize(&graph
->event_msg_pool
);
234 bt_object_pool_finalize(&graph
->packet_begin_msg_pool
);
235 bt_object_pool_finalize(&graph
->packet_end_msg_pool
);
240 void destroy_message_event(struct bt_message
*msg
,
241 struct bt_graph
*graph
)
243 bt_message_event_destroy(msg
);
247 void destroy_message_packet_begin(struct bt_message
*msg
,
248 struct bt_graph
*graph
)
250 bt_message_packet_destroy(msg
);
254 void destroy_message_packet_end(struct bt_message
*msg
,
255 struct bt_graph
*graph
)
257 bt_message_packet_destroy(msg
);
261 void notify_message_graph_is_destroyed(struct bt_message
*msg
)
263 bt_message_unlink_graph(msg
);
266 struct bt_graph
*bt_graph_create(uint64_t mip_version
)
268 struct bt_graph
*graph
;
271 BT_ASSERT_PRE_NO_ERROR();
272 BT_ASSERT_PRE(mip_version
<= bt_get_maximal_mip_version(),
273 "Unknown MIP version: mip-version=%" PRIu64
", "
274 "max-mip-version=%" PRIu64
,
275 mip_version
, bt_get_maximal_mip_version());
276 BT_LOGI_STR("Creating graph object.");
277 graph
= g_new0(struct bt_graph
, 1);
279 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one graph.");
283 bt_object_init_shared(&graph
->base
, destroy_graph
);
284 graph
->mip_version
= mip_version
;
285 graph
->connections
= g_ptr_array_new_with_free_func(
286 (GDestroyNotify
) bt_object_try_spec_release
);
287 if (!graph
->connections
) {
288 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
291 graph
->components
= g_ptr_array_new_with_free_func(
292 (GDestroyNotify
) bt_object_try_spec_release
);
293 if (!graph
->components
) {
294 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
297 graph
->sinks_to_consume
= g_queue_new();
298 if (!graph
->sinks_to_consume
) {
299 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GQueue.");
303 bt_graph_set_can_consume(graph
, true);
304 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
305 graph
->listeners
.source_output_port_added
);
307 if (!graph
->listeners
.source_output_port_added
) {
311 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
312 graph
->listeners
.filter_output_port_added
);
314 if (!graph
->listeners
.filter_output_port_added
) {
318 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
319 graph
->listeners
.filter_input_port_added
);
321 if (!graph
->listeners
.filter_input_port_added
) {
325 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
326 graph
->listeners
.sink_input_port_added
);
328 if (!graph
->listeners
.sink_input_port_added
) {
332 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
333 graph
->listeners
.source_filter_ports_connected
);
335 if (!graph
->listeners
.source_filter_ports_connected
) {
339 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
340 graph
->listeners
.source_sink_ports_connected
);
342 if (!graph
->listeners
.source_sink_ports_connected
) {
346 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
347 graph
->listeners
.filter_filter_ports_connected
);
349 if (!graph
->listeners
.filter_filter_ports_connected
) {
353 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
354 graph
->listeners
.filter_sink_ports_connected
);
356 if (!graph
->listeners
.filter_sink_ports_connected
) {
360 graph
->interrupters
= g_ptr_array_new_with_free_func(
361 (GDestroyNotify
) bt_object_put_ref_no_null_check
);
362 if (!graph
->interrupters
) {
363 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
367 graph
->default_interrupter
= bt_interrupter_create();
368 if (!graph
->default_interrupter
) {
369 BT_LIB_LOGE_APPEND_CAUSE(
370 "Failed to create one interrupter object.");
374 bt_graph_add_interrupter(graph
, graph
->default_interrupter
);
375 ret
= bt_object_pool_initialize(&graph
->event_msg_pool
,
376 (bt_object_pool_new_object_func
) bt_message_event_new
,
377 (bt_object_pool_destroy_object_func
) destroy_message_event
,
380 BT_LIB_LOGE_APPEND_CAUSE(
381 "Failed to initialize event message pool: ret=%d",
386 ret
= bt_object_pool_initialize(&graph
->packet_begin_msg_pool
,
387 (bt_object_pool_new_object_func
) bt_message_packet_beginning_new
,
388 (bt_object_pool_destroy_object_func
) destroy_message_packet_begin
,
391 BT_LIB_LOGE_APPEND_CAUSE(
392 "Failed to initialize packet beginning message pool: ret=%d",
397 ret
= bt_object_pool_initialize(&graph
->packet_end_msg_pool
,
398 (bt_object_pool_new_object_func
) bt_message_packet_end_new
,
399 (bt_object_pool_destroy_object_func
) destroy_message_packet_end
,
402 BT_LIB_LOGE_APPEND_CAUSE(
403 "Failed to initialize packet end message pool: ret=%d",
408 graph
->messages
= g_ptr_array_new_with_free_func(
409 (GDestroyNotify
) notify_message_graph_is_destroyed
);
410 BT_LIB_LOGI("Created graph object: %!+g", graph
);
413 return (void *) graph
;
416 BT_OBJECT_PUT_REF_AND_RESET(graph
);
420 enum bt_graph_connect_ports_status
bt_graph_connect_ports(
421 struct bt_graph
*graph
,
422 const struct bt_port_output
*upstream_port_out
,
423 const struct bt_port_input
*downstream_port_in
,
424 const struct bt_connection
**user_connection
)
426 enum bt_graph_connect_ports_status status
= BT_FUNC_STATUS_OK
;
427 enum bt_graph_listener_func_status listener_status
;
428 struct bt_connection
*connection
= NULL
;
429 struct bt_port
*upstream_port
= (void *) upstream_port_out
;
430 struct bt_port
*downstream_port
= (void *) downstream_port_in
;
431 struct bt_component
*upstream_component
= NULL
;
432 struct bt_component
*downstream_component
= NULL
;
433 enum bt_component_class_port_connected_method_status port_connected_status
;
434 bool init_can_consume
;
436 BT_ASSERT_PRE_NO_ERROR();
437 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
438 BT_ASSERT_PRE_NON_NULL(upstream_port
, "Upstream port");
439 BT_ASSERT_PRE_NON_NULL(downstream_port
, "Downstream port port");
441 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
442 "Graph is not in the \"configuring\" state: %!+g", graph
);
443 BT_ASSERT_PRE(!bt_port_is_connected(upstream_port
),
444 "Upstream port is already connected: %!+p", upstream_port
);
445 BT_ASSERT_PRE(!bt_port_is_connected(downstream_port
),
446 "Downstream port is already connected: %!+p", downstream_port
);
447 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port
),
448 "Upstream port does not belong to a component: %!+p",
450 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port
),
451 "Downstream port does not belong to a component: %!+p",
453 init_can_consume
= graph
->can_consume
;
454 BT_LIB_LOGI("Connecting component ports within graph: "
455 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
456 graph
, upstream_port
, downstream_port
);
457 bt_graph_set_can_consume(graph
, false);
458 upstream_component
= bt_port_borrow_component_inline(
459 (void *) upstream_port
);
460 downstream_component
= bt_port_borrow_component_inline(
461 (void *) downstream_port
);
463 BT_LOGD_STR("Creating connection.");
464 connection
= bt_connection_create(graph
, (void *) upstream_port
,
465 (void *) downstream_port
);
467 BT_LIB_LOGE_APPEND_CAUSE("Cannot create connection object.");
468 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
472 BT_LIB_LOGD("Connection object created: %!+x", connection
);
475 * Ownership of upstream_component/downstream_component and of
476 * the connection object is transferred to the graph.
478 g_ptr_array_add(graph
->connections
, connection
);
481 * Notify both components that their port is connected.
483 BT_LIB_LOGD("Notifying upstream component that its port is connected: "
484 "%![comp-]+c, %![port-]+p", upstream_component
, upstream_port
);
485 port_connected_status
= bt_component_port_connected(upstream_component
,
486 (void *) upstream_port
, (void *) downstream_port
);
487 if (port_connected_status
!= BT_FUNC_STATUS_OK
) {
488 if (port_connected_status
< 0) {
489 BT_LIB_LOGW_APPEND_CAUSE(
490 "Upstream component's \"port connected\" method failed: "
491 "status=%s, %![graph-]+g, %![up-comp-]+c, "
492 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
493 bt_common_func_status_string(
494 port_connected_status
),
495 graph
, upstream_component
, downstream_component
,
496 upstream_port
, downstream_port
);
499 bt_connection_end(connection
, true);
500 status
= (int) port_connected_status
;
504 connection
->notified_upstream_port_connected
= true;
505 BT_LIB_LOGD("Notifying downstream component that its port is connected: "
506 "%![comp-]+c, %![port-]+p", downstream_component
,
508 port_connected_status
= bt_component_port_connected(downstream_component
,
509 (void *) downstream_port
, (void *) upstream_port
);
510 if (port_connected_status
!= BT_FUNC_STATUS_OK
) {
511 if (port_connected_status
< 0) {
512 BT_LIB_LOGW_APPEND_CAUSE(
513 "Downstream component's \"port connected\" method failed: "
514 "status=%s, %![graph-]+g, %![up-comp-]+c, "
515 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
516 bt_common_func_status_string(
517 port_connected_status
),
518 graph
, upstream_component
, downstream_component
,
519 upstream_port
, downstream_port
);
522 bt_connection_end(connection
, true);
523 status
= (int) port_connected_status
;
527 connection
->notified_downstream_port_connected
= true;
530 * Notify the graph's creator that both ports are connected.
532 BT_LOGD_STR("Notifying graph's user that new component ports are connected.");
533 listener_status
= bt_graph_notify_ports_connected(graph
, upstream_port
, downstream_port
);
534 if (listener_status
!= BT_FUNC_STATUS_OK
) {
535 if (listener_status
< 0) {
536 BT_LIB_LOGW_APPEND_CAUSE(
537 "Graph \"ports connected\" listener failed: "
538 "status=%d, %![graph-]+g, %![up-comp-]+c, "
539 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
540 listener_status
, graph
,
541 upstream_component
, downstream_component
,
542 upstream_port
, downstream_port
);
545 status
= (int) listener_status
;
549 connection
->notified_graph_ports_connected
= true;
550 BT_LIB_LOGI("Connected component ports within graph: "
551 "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
552 "%![up-port-]+p, %![down-port-]+p",
553 graph
, upstream_component
, downstream_component
,
554 upstream_port
, downstream_port
);
556 if (user_connection
) {
557 /* Move reference to user */
558 *user_connection
= connection
;
563 if (status
!= BT_FUNC_STATUS_OK
) {
564 bt_graph_make_faulty(graph
);
567 bt_object_put_ref(connection
);
568 (void) init_can_consume
;
569 bt_graph_set_can_consume(graph
, init_can_consume
);
574 int consume_graph_sink(struct bt_component_sink
*comp
)
576 enum bt_component_class_sink_consume_method_status consume_status
;
577 struct bt_component_class_sink
*sink_class
= NULL
;
580 sink_class
= (void *) comp
->parent
.class;
581 BT_ASSERT_DBG(sink_class
->methods
.consume
);
582 BT_LIB_LOGD("Calling user's consume method: %!+c", comp
);
583 consume_status
= sink_class
->methods
.consume((void *) comp
);
584 BT_LOGD("User method returned: status=%s",
585 bt_common_func_status_string(consume_status
));
586 BT_ASSERT_POST_DEV(consume_status
== BT_FUNC_STATUS_OK
||
587 consume_status
== BT_FUNC_STATUS_END
||
588 consume_status
== BT_FUNC_STATUS_AGAIN
||
589 consume_status
== BT_FUNC_STATUS_ERROR
||
590 consume_status
== BT_FUNC_STATUS_MEMORY_ERROR
,
591 "Invalid component status returned by consuming method: "
592 "status=%s", bt_common_func_status_string(consume_status
));
593 BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(consume_status
);
594 if (consume_status
) {
595 if (consume_status
< 0) {
596 BT_LIB_LOGW_APPEND_CAUSE(
597 "Component's \"consume\" method failed: "
598 "status=%s, %![comp-]+c",
599 bt_common_func_status_string(consume_status
),
606 BT_LIB_LOGD("Consumed from sink: %![comp-]+c, status=%s",
607 comp
, bt_common_func_status_string(consume_status
));
610 return consume_status
;
614 * `node` is removed from the queue of sinks to consume when passed to
615 * this function. This function adds it back to the queue if there's
616 * still something to consume afterwards.
619 int consume_sink_node(struct bt_graph
*graph
, GList
*node
)
622 struct bt_component_sink
*sink
;
625 status
= consume_graph_sink(sink
);
626 if (G_UNLIKELY(status
!= BT_FUNC_STATUS_END
)) {
627 g_queue_push_tail_link(graph
->sinks_to_consume
, node
);
631 /* End reached, the node is not added back to the queue and free'd. */
632 g_queue_delete_link(graph
->sinks_to_consume
, node
);
634 /* Don't forward an END status if there are sinks left to consume. */
635 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
636 status
= BT_FUNC_STATUS_OK
;
641 BT_LIB_LOGD("Consumed sink node: %![comp-]+c, status=%s",
642 sink
, bt_common_func_status_string(status
));
647 int bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
648 struct bt_component_sink
*sink
)
654 BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink
);
655 BT_ASSERT_DBG(bt_component_borrow_graph((void *) sink
) == graph
);
657 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
658 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
659 status
= BT_FUNC_STATUS_END
;
663 index
= g_queue_index(graph
->sinks_to_consume
, sink
);
665 BT_LIB_LOGD("Sink component is not marked as consumable: "
666 "component sink is ended: %![comp-]+c", sink
);
667 status
= BT_FUNC_STATUS_END
;
671 sink_node
= g_queue_pop_nth_link(graph
->sinks_to_consume
, index
);
672 BT_ASSERT_DBG(sink_node
);
673 status
= consume_sink_node(graph
, sink_node
);
680 int consume_no_check(struct bt_graph
*graph
)
682 int status
= BT_FUNC_STATUS_OK
;
683 struct bt_component
*sink
;
686 BT_ASSERT_PRE_DEV(graph
->has_sink
,
687 "Graph has no sink component: %!+g", graph
);
688 BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph
);
690 if (G_UNLIKELY(g_queue_is_empty(graph
->sinks_to_consume
))) {
691 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
692 status
= BT_FUNC_STATUS_END
;
696 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
697 sink
= current_node
->data
;
698 BT_LIB_LOGD("Chose next sink to consume: %!+c", sink
);
699 status
= consume_sink_node(graph
, current_node
);
705 enum bt_graph_run_once_status
bt_graph_run_once(struct bt_graph
*graph
)
707 enum bt_graph_run_once_status status
;
709 BT_ASSERT_PRE_NO_ERROR();
710 BT_ASSERT_PRE_DEV_NON_NULL(graph
, "Graph");
711 BT_ASSERT_PRE_DEV(graph
->can_consume
,
712 "Cannot consume graph in its current state: %!+g", graph
);
713 BT_ASSERT_PRE_DEV(graph
->config_state
!=
714 BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
715 "Graph is in a faulty state: %!+g", graph
);
716 bt_graph_set_can_consume(graph
, false);
717 status
= bt_graph_configure(graph
);
718 if (G_UNLIKELY(status
)) {
719 /* bt_graph_configure() logs errors */
723 status
= consume_no_check(graph
);
724 bt_graph_set_can_consume(graph
, true);
730 enum bt_graph_run_status
bt_graph_run(struct bt_graph
*graph
)
732 enum bt_graph_run_status status
;
734 BT_ASSERT_PRE_NO_ERROR();
735 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
736 BT_ASSERT_PRE(graph
->can_consume
,
737 "Cannot consume graph in its current state: %!+g", graph
);
738 BT_ASSERT_PRE(graph
->config_state
!= BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
739 "Graph is in a faulty state: %!+g", graph
);
740 bt_graph_set_can_consume(graph
, false);
741 status
= bt_graph_configure(graph
);
742 if (G_UNLIKELY(status
)) {
743 /* bt_graph_configure() logs errors */
747 BT_LIB_LOGI("Running graph: %!+g", graph
);
751 * Check if the graph is interrupted at each iteration.
752 * If the graph was interrupted by another thread or by
753 * a signal handler, this is NOT a warning nor an error;
754 * it was intentional: log with an INFO level only.
756 if (G_UNLIKELY(bt_graph_is_interrupted(graph
))) {
757 BT_LIB_LOGI("Stopping the graph: "
758 "graph was interrupted: %!+g", graph
);
759 status
= BT_FUNC_STATUS_AGAIN
;
763 status
= consume_no_check(graph
);
764 if (G_UNLIKELY(status
== BT_FUNC_STATUS_AGAIN
)) {
766 * If AGAIN is received and there are multiple
767 * sinks, go ahead and consume from the next
770 * However, in the case where a single sink is
771 * left, the caller can decide to busy-wait and
772 * call bt_graph_run() continuously
773 * until the source is ready or it can decide to
774 * sleep for an arbitrary amount of time.
776 if (graph
->sinks_to_consume
->length
> 1) {
777 status
= BT_FUNC_STATUS_OK
;
780 } while (status
== BT_FUNC_STATUS_OK
);
782 if (status
== BT_FUNC_STATUS_END
) {
784 * The last call to consume_no_check() returned
785 * `BT_FUNC_STATUS_END`, but bt_graph_run() has no
786 * `BT_GRAPH_RUN_STATUS_END` status: replace with
787 * `BT_GRAPH_RUN_STATUS_OK` (success: graph ran
790 status
= BT_FUNC_STATUS_OK
;
794 BT_LIB_LOGI("Graph ran: %![graph-]+g, status=%s", graph
,
795 bt_common_func_status_string(status
));
796 bt_graph_set_can_consume(graph
, true);
800 enum bt_graph_add_listener_status
801 bt_graph_add_source_component_output_port_added_listener(
802 struct bt_graph
*graph
,
803 bt_graph_source_component_output_port_added_listener_func func
,
804 bt_graph_listener_removed_func listener_removed
, void *data
,
805 bt_listener_id
*out_listener_id
)
807 struct bt_graph_listener_port_added listener
= {
809 .removed
= listener_removed
,
812 .func
= (port_added_func_t
) func
,
814 bt_listener_id listener_id
;
816 BT_ASSERT_PRE_NO_ERROR();
817 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
818 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
819 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
820 BT_ASSERT_PRE(!graph
->in_remove_listener
,
821 "Graph currently executing a \"listener removed\" listener: "
823 g_array_append_val(graph
->listeners
.source_output_port_added
, listener
);
824 listener_id
= graph
->listeners
.source_output_port_added
->len
- 1;
825 BT_LIB_LOGD("Added \"source component output port added\" listener to graph: "
826 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
830 *out_listener_id
= listener_id
;
833 return BT_FUNC_STATUS_OK
;
836 enum bt_graph_add_listener_status
837 bt_graph_add_filter_component_output_port_added_listener(
838 struct bt_graph
*graph
,
839 bt_graph_filter_component_output_port_added_listener_func func
,
840 bt_graph_listener_removed_func listener_removed
, void *data
,
841 bt_listener_id
*out_listener_id
)
843 struct bt_graph_listener_port_added listener
= {
845 .removed
= listener_removed
,
848 .func
= (port_added_func_t
) func
,
850 bt_listener_id listener_id
;
852 BT_ASSERT_PRE_NO_ERROR();
853 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
854 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
855 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
856 BT_ASSERT_PRE(!graph
->in_remove_listener
,
857 "Graph currently executing a \"listener removed\" listener: "
859 g_array_append_val(graph
->listeners
.filter_output_port_added
, listener
);
860 listener_id
= graph
->listeners
.filter_output_port_added
->len
- 1;
861 BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: "
862 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
866 *out_listener_id
= listener_id
;
869 return BT_FUNC_STATUS_OK
;
872 enum bt_graph_add_listener_status
873 bt_graph_add_filter_component_input_port_added_listener(
874 struct bt_graph
*graph
,
875 bt_graph_filter_component_input_port_added_listener_func func
,
876 bt_graph_listener_removed_func listener_removed
, void *data
,
877 bt_listener_id
*out_listener_id
)
879 struct bt_graph_listener_port_added listener
= {
881 .removed
= listener_removed
,
884 .func
= (port_added_func_t
) func
,
886 bt_listener_id listener_id
;
888 BT_ASSERT_PRE_NO_ERROR();
889 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
890 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
891 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
892 BT_ASSERT_PRE(!graph
->in_remove_listener
,
893 "Graph currently executing a \"listener removed\" listener: "
895 g_array_append_val(graph
->listeners
.filter_input_port_added
, listener
);
896 listener_id
= graph
->listeners
.filter_input_port_added
->len
- 1;
897 BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: "
898 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
902 *out_listener_id
= listener_id
;
905 return BT_FUNC_STATUS_OK
;
908 enum bt_graph_add_listener_status
909 bt_graph_add_sink_component_input_port_added_listener(
910 struct bt_graph
*graph
,
911 bt_graph_sink_component_input_port_added_listener_func func
,
912 bt_graph_listener_removed_func listener_removed
, void *data
,
913 bt_listener_id
*out_listener_id
)
915 struct bt_graph_listener_port_added listener
= {
917 .removed
= listener_removed
,
920 .func
= (port_added_func_t
) func
,
922 bt_listener_id listener_id
;
924 BT_ASSERT_PRE_NO_ERROR();
925 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
926 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
927 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
928 BT_ASSERT_PRE(!graph
->in_remove_listener
,
929 "Graph currently executing a \"listener removed\" listener: "
931 g_array_append_val(graph
->listeners
.sink_input_port_added
, listener
);
932 listener_id
= graph
->listeners
.sink_input_port_added
->len
- 1;
933 BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: "
934 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
938 *out_listener_id
= listener_id
;
941 return BT_FUNC_STATUS_OK
;
944 enum bt_graph_add_listener_status
945 bt_graph_add_source_filter_component_ports_connected_listener(
946 struct bt_graph
*graph
,
947 bt_graph_source_filter_component_ports_connected_listener_func func
,
948 bt_graph_listener_removed_func listener_removed
, void *data
,
949 bt_listener_id
*out_listener_id
)
951 struct bt_graph_listener_ports_connected listener
= {
953 .removed
= listener_removed
,
956 .func
= (ports_connected_func_t
) func
,
958 bt_listener_id listener_id
;
960 BT_ASSERT_PRE_NO_ERROR();
961 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
962 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
963 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
964 BT_ASSERT_PRE(!graph
->in_remove_listener
,
965 "Graph currently executing a \"listener removed\" listener: "
967 g_array_append_val(graph
->listeners
.source_filter_ports_connected
,
969 listener_id
= graph
->listeners
.source_filter_ports_connected
->len
- 1;
970 BT_LIB_LOGD("Added \"source to filter component ports connected\" listener to graph: "
971 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
975 *out_listener_id
= listener_id
;
978 return BT_FUNC_STATUS_OK
;
981 enum bt_graph_add_listener_status
982 bt_graph_add_source_sink_component_ports_connected_listener(
983 struct bt_graph
*graph
,
984 bt_graph_source_sink_component_ports_connected_listener_func func
,
985 bt_graph_listener_removed_func listener_removed
, void *data
,
986 bt_listener_id
*out_listener_id
)
988 struct bt_graph_listener_ports_connected listener
= {
990 .removed
= listener_removed
,
993 .func
= (ports_connected_func_t
) func
,
995 bt_listener_id listener_id
;
997 BT_ASSERT_PRE_NO_ERROR();
998 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
999 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1000 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1001 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1002 "Graph currently executing a \"listener removed\" listener: "
1004 g_array_append_val(graph
->listeners
.source_sink_ports_connected
,
1006 listener_id
= graph
->listeners
.source_sink_ports_connected
->len
- 1;
1007 BT_LIB_LOGD("Added \"source to sink component ports connected\" listener to graph: "
1008 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1012 *out_listener_id
= listener_id
;
1015 return BT_FUNC_STATUS_OK
;
1018 enum bt_graph_add_listener_status
1019 bt_graph_add_filter_filter_component_ports_connected_listener(
1020 struct bt_graph
*graph
,
1021 bt_graph_filter_filter_component_ports_connected_listener_func func
,
1022 bt_graph_listener_removed_func listener_removed
, void *data
,
1023 bt_listener_id
*out_listener_id
)
1025 struct bt_graph_listener_ports_connected listener
= {
1027 .removed
= listener_removed
,
1030 .func
= (ports_connected_func_t
) func
,
1032 bt_listener_id listener_id
;
1034 BT_ASSERT_PRE_NO_ERROR();
1035 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1036 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1037 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1038 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1039 "Graph currently executing a \"listener removed\" listener: "
1041 g_array_append_val(graph
->listeners
.filter_filter_ports_connected
,
1043 listener_id
= graph
->listeners
.filter_filter_ports_connected
->len
- 1;
1044 BT_LIB_LOGD("Added \"filter to filter component ports connected\" listener to graph: "
1045 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1049 *out_listener_id
= listener_id
;
1052 return BT_FUNC_STATUS_OK
;
1055 enum bt_graph_add_listener_status
1056 bt_graph_add_filter_sink_component_ports_connected_listener(
1057 struct bt_graph
*graph
,
1058 bt_graph_filter_sink_component_ports_connected_listener_func func
,
1059 bt_graph_listener_removed_func listener_removed
, void *data
,
1060 bt_listener_id
*out_listener_id
)
1062 struct bt_graph_listener_ports_connected listener
= {
1064 .removed
= listener_removed
,
1067 .func
= (ports_connected_func_t
) func
,
1069 bt_listener_id listener_id
;
1071 BT_ASSERT_PRE_NO_ERROR();
1072 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1073 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1074 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1075 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1076 "Graph currently executing a \"listener removed\" listener: "
1078 g_array_append_val(graph
->listeners
.filter_sink_ports_connected
,
1080 listener_id
= graph
->listeners
.filter_sink_ports_connected
->len
- 1;
1081 BT_LIB_LOGD("Added \"filter to sink component ports connected\" listener to graph: "
1082 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1086 *out_listener_id
= listener_id
;
1089 return BT_FUNC_STATUS_OK
;
1093 enum bt_graph_listener_func_status
bt_graph_notify_port_added(
1094 struct bt_graph
*graph
, struct bt_port
*port
)
1098 struct bt_component
*comp
;
1099 enum bt_graph_listener_func_status status
= BT_FUNC_STATUS_OK
;
1103 BT_LIB_LOGD("Notifying graph listeners that a port was added: "
1104 "%![graph-]+g, %![port-]+p", graph
, port
);
1105 comp
= bt_port_borrow_component_inline(port
);
1108 switch (comp
->class->type
) {
1109 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1111 switch (port
->type
) {
1112 case BT_PORT_TYPE_OUTPUT
:
1113 listeners
= graph
->listeners
.source_output_port_added
;
1121 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1123 switch (port
->type
) {
1124 case BT_PORT_TYPE_INPUT
:
1125 listeners
= graph
->listeners
.filter_input_port_added
;
1127 case BT_PORT_TYPE_OUTPUT
:
1128 listeners
= graph
->listeners
.filter_output_port_added
;
1136 case BT_COMPONENT_CLASS_TYPE_SINK
:
1138 switch (port
->type
) {
1139 case BT_PORT_TYPE_INPUT
:
1140 listeners
= graph
->listeners
.sink_input_port_added
;
1152 for (i
= 0; i
< listeners
->len
; i
++) {
1153 struct bt_graph_listener_port_added
*listener
=
1154 &g_array_index(listeners
,
1155 struct bt_graph_listener_port_added
, i
);
1158 BT_ASSERT(listener
->func
);
1159 status
= listener
->func(comp
, port
, listener
->base
.data
);
1160 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status
);
1161 if (status
!= BT_FUNC_STATUS_OK
) {
1171 enum bt_graph_listener_func_status
bt_graph_notify_ports_connected(
1172 struct bt_graph
*graph
, struct bt_port
*upstream_port
,
1173 struct bt_port
*downstream_port
)
1177 struct bt_component
*upstream_comp
;
1178 struct bt_component
*downstream_comp
;
1179 enum bt_graph_listener_func_status status
= BT_FUNC_STATUS_OK
;
1182 BT_ASSERT(upstream_port
);
1183 BT_ASSERT(downstream_port
);
1184 BT_LIB_LOGD("Notifying graph listeners that ports were connected: "
1185 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
1186 graph
, upstream_port
, downstream_port
);
1187 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
1188 BT_ASSERT(upstream_comp
);
1189 downstream_comp
= bt_port_borrow_component_inline(downstream_port
);
1190 BT_ASSERT(downstream_comp
);
1192 switch (upstream_comp
->class->type
) {
1193 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1195 switch (downstream_comp
->class->type
) {
1196 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1198 graph
->listeners
.source_filter_ports_connected
;
1200 case BT_COMPONENT_CLASS_TYPE_SINK
:
1202 graph
->listeners
.source_sink_ports_connected
;
1210 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1212 switch (downstream_comp
->class->type
) {
1213 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1215 graph
->listeners
.filter_filter_ports_connected
;
1217 case BT_COMPONENT_CLASS_TYPE_SINK
:
1219 graph
->listeners
.filter_sink_ports_connected
;
1231 for (i
= 0; i
< listeners
->len
; i
++) {
1232 struct bt_graph_listener_ports_connected
*listener
=
1233 &g_array_index(listeners
,
1234 struct bt_graph_listener_ports_connected
, i
);
1236 BT_ASSERT(listener
->func
);
1237 status
= listener
->func(upstream_comp
, downstream_comp
,
1238 upstream_port
, downstream_port
, listener
->base
.data
);
1239 BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(status
);
1240 if (status
!= BT_FUNC_STATUS_OK
) {
1250 void bt_graph_remove_connection(struct bt_graph
*graph
,
1251 struct bt_connection
*connection
)
1254 BT_ASSERT(connection
);
1255 BT_LIB_LOGD("Removing graph's connection: %![graph-]+g, %![conn-]+x",
1257 g_ptr_array_remove(graph
->connections
, connection
);
1261 bool component_name_exists(struct bt_graph
*graph
, const char *name
)
1263 bool exists
= false;
1266 for (i
= 0; i
< graph
->components
->len
; i
++) {
1267 struct bt_component
*other_comp
= graph
->components
->pdata
[i
];
1269 if (strcmp(name
, bt_component_get_name(other_comp
)) == 0) {
1270 BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: "
1271 "%![other-comp-]+c, name=\"%s\"",
1283 int add_component_with_init_method_data(
1284 struct bt_graph
*graph
,
1285 struct bt_component_class
*comp_cls
,
1286 comp_init_method_t init_method
,
1287 const char *name
, const struct bt_value
*params
,
1288 void *init_method_data
, bt_logging_level log_level
,
1289 const struct bt_component
**user_component
)
1291 int status
= BT_FUNC_STATUS_OK
;
1292 enum bt_component_class_initialize_method_status init_status
;
1293 struct bt_component
*component
= NULL
;
1295 bool init_can_consume
;
1296 struct bt_value
*new_params
= NULL
;
1298 BT_ASSERT(comp_cls
);
1299 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1300 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1302 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1303 "Graph is not in the \"configuring\" state: %!+g", graph
);
1304 BT_ASSERT_PRE(!component_name_exists(graph
, name
),
1305 "Duplicate component name: %!+g, name=\"%s\"", graph
, name
);
1306 BT_ASSERT_PRE(!params
|| bt_value_is_map(params
),
1307 "Parameter value is not a map value: %!+v", params
);
1308 init_can_consume
= graph
->can_consume
;
1309 bt_graph_set_can_consume(graph
, false);
1310 BT_LIB_LOGI("Adding component to graph: "
1311 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1312 "%![params-]+v, init-method-data-addr=%p",
1313 graph
, comp_cls
, name
,
1314 bt_common_logging_level_string(log_level
), params
,
1318 new_params
= bt_value_map_create();
1320 BT_LIB_LOGE_APPEND_CAUSE(
1321 "Cannot create empty map value object.");
1322 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1326 params
= new_params
;
1329 ret
= bt_component_create(comp_cls
, name
, log_level
, &component
);
1331 BT_LIB_LOGE_APPEND_CAUSE(
1332 "Cannot create empty component object: ret=%d",
1334 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1339 * The user's initialization method needs to see that this
1340 * component is part of the graph. If the user method fails, we
1341 * immediately remove the component from the graph's components.
1343 g_ptr_array_add(graph
->components
, component
);
1344 bt_component_set_graph(component
, graph
);
1345 bt_value_freeze(params
);
1349 * There is no use for config objects right now, so just pass
1352 BT_LOGD_STR("Calling user's initialization method.");
1353 init_status
= init_method(component
, NULL
, params
, init_method_data
);
1354 BT_LOGD("User method returned: status=%s",
1355 bt_common_func_status_string(init_status
));
1356 BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(init_status
);
1357 if (init_status
!= BT_FUNC_STATUS_OK
) {
1358 if (init_status
< 0) {
1359 BT_LIB_LOGW_APPEND_CAUSE(
1360 "Component initialization method failed: "
1361 "status=%s, %![comp-]+c",
1362 bt_common_func_status_string(init_status
),
1366 status
= init_status
;
1367 bt_component_set_graph(component
, NULL
);
1368 g_ptr_array_remove_fast(graph
->components
, component
);
1374 * Mark the component as initialized so that its finalization
1375 * method is called when it is destroyed.
1377 component
->initialized
= true;
1380 * If it's a sink component, it needs to be part of the graph's
1381 * sink queue to be consumed by bt_graph_run() or
1382 * bt_graph_run_once().
1384 if (bt_component_is_sink(component
)) {
1385 graph
->has_sink
= true;
1386 g_queue_push_tail(graph
->sinks_to_consume
, component
);
1390 * Freeze the component class now that it's instantiated at
1393 BT_LOGD_STR("Freezing component class.");
1394 bt_component_class_freeze(comp_cls
);
1395 BT_LIB_LOGI("Added component to graph: "
1396 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1397 "%![params-]+v, init-method-data-addr=%p, %![comp-]+c",
1398 graph
, comp_cls
, name
,
1399 bt_common_logging_level_string(log_level
), params
,
1400 init_method_data
, component
);
1402 if (user_component
) {
1403 /* Move reference to user */
1404 *user_component
= component
;
1409 if (status
!= BT_FUNC_STATUS_OK
) {
1410 bt_graph_make_faulty(graph
);
1413 bt_object_put_ref(component
);
1414 bt_object_put_ref(new_params
);
1415 (void) init_can_consume
;
1416 bt_graph_set_can_consume(graph
, init_can_consume
);
1420 enum bt_graph_add_component_status
1421 bt_graph_add_source_component_with_initialize_method_data(
1422 struct bt_graph
*graph
,
1423 const struct bt_component_class_source
*comp_cls
,
1424 const char *name
, const struct bt_value
*params
,
1425 void *init_method_data
, bt_logging_level log_level
,
1426 const struct bt_component_source
**component
)
1428 BT_ASSERT_PRE_NO_ERROR();
1429 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1430 return add_component_with_init_method_data(graph
,
1431 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1432 name
, params
, init_method_data
, log_level
, (void *) component
);
1435 enum bt_graph_add_component_status
bt_graph_add_source_component(
1436 struct bt_graph
*graph
,
1437 const struct bt_component_class_source
*comp_cls
,
1438 const char *name
, const struct bt_value
*params
,
1439 enum bt_logging_level log_level
,
1440 const struct bt_component_source
**component
)
1442 BT_ASSERT_PRE_NO_ERROR();
1443 return bt_graph_add_source_component_with_initialize_method_data(
1444 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1447 enum bt_graph_add_component_status
1448 bt_graph_add_filter_component_with_initialize_method_data(
1449 struct bt_graph
*graph
,
1450 const struct bt_component_class_filter
*comp_cls
,
1451 const char *name
, const struct bt_value
*params
,
1452 void *init_method_data
, enum bt_logging_level log_level
,
1453 const struct bt_component_filter
**component
)
1455 BT_ASSERT_PRE_NO_ERROR();
1456 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1457 return add_component_with_init_method_data(graph
,
1458 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1459 name
, params
, init_method_data
, log_level
, (void *) component
);
1462 enum bt_graph_add_component_status
bt_graph_add_filter_component(
1463 struct bt_graph
*graph
,
1464 const struct bt_component_class_filter
*comp_cls
,
1465 const char *name
, const struct bt_value
*params
,
1466 enum bt_logging_level log_level
,
1467 const struct bt_component_filter
**component
)
1469 BT_ASSERT_PRE_NO_ERROR();
1470 return bt_graph_add_filter_component_with_initialize_method_data(
1471 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1474 enum bt_graph_add_component_status
1475 bt_graph_add_sink_component_with_initialize_method_data(
1476 struct bt_graph
*graph
,
1477 const struct bt_component_class_sink
*comp_cls
,
1478 const char *name
, const struct bt_value
*params
,
1479 void *init_method_data
, enum bt_logging_level log_level
,
1480 const struct bt_component_sink
**component
)
1482 BT_ASSERT_PRE_NO_ERROR();
1483 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1484 return add_component_with_init_method_data(graph
,
1485 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1486 name
, params
, init_method_data
, log_level
, (void *) component
);
1489 enum bt_graph_add_component_status
bt_graph_add_sink_component(
1490 struct bt_graph
*graph
,
1491 const struct bt_component_class_sink
*comp_cls
,
1492 const char *name
, const struct bt_value
*params
,
1493 enum bt_logging_level log_level
,
1494 const struct bt_component_sink
**component
)
1496 BT_ASSERT_PRE_NO_ERROR();
1497 return bt_graph_add_sink_component_with_initialize_method_data(
1498 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1501 enum bt_graph_add_component_status
1502 bt_graph_add_simple_sink_component(struct bt_graph
*graph
, const char *name
,
1503 bt_graph_simple_sink_component_initialize_func init_func
,
1504 bt_graph_simple_sink_component_consume_func consume_func
,
1505 bt_graph_simple_sink_component_finalize_func finalize_func
,
1506 void *user_data
, const bt_component_sink
**component
)
1508 enum bt_graph_add_component_status status
;
1509 struct bt_component_class_sink
*comp_cls
;
1510 struct simple_sink_init_method_data init_method_data
= {
1511 .init_func
= init_func
,
1512 .consume_func
= consume_func
,
1513 .finalize_func
= finalize_func
,
1514 .user_data
= user_data
,
1517 BT_ASSERT_PRE_NO_ERROR();
1520 * Other preconditions are checked by
1521 * bt_graph_add_sink_component_with_init_method_data().
1523 BT_ASSERT_PRE_NON_NULL(consume_func
, "Consume function");
1525 comp_cls
= bt_component_class_sink_simple_borrow();
1527 BT_LIB_LOGE_APPEND_CAUSE(
1528 "Cannot borrow simple sink component class.");
1529 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1533 status
= bt_graph_add_sink_component_with_initialize_method_data(graph
,
1534 comp_cls
, name
, NULL
, &init_method_data
,
1535 BT_LOGGING_LEVEL_NONE
, component
);
1542 void bt_graph_add_message(struct bt_graph
*graph
,
1543 struct bt_message
*msg
)
1549 * It's okay not to take a reference because, when a
1550 * message's reference count drops to 0, either:
1552 * * It is recycled back to one of this graph's pool.
1553 * * It is destroyed because it doesn't have any link to any
1554 * graph, which means the original graph is already destroyed.
1556 g_ptr_array_add(graph
->messages
, msg
);
1560 bool bt_graph_is_interrupted(const struct bt_graph
*graph
)
1562 BT_ASSERT_DBG(graph
);
1563 return bt_interrupter_array_any_is_set(graph
->interrupters
);
1566 enum bt_graph_add_interrupter_status
bt_graph_add_interrupter(
1567 struct bt_graph
*graph
, const struct bt_interrupter
*intr
)
1569 BT_ASSERT_PRE_NO_ERROR();
1570 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1571 BT_ASSERT_PRE_NON_NULL(intr
, "Interrupter");
1572 g_ptr_array_add(graph
->interrupters
, (void *) intr
);
1573 bt_object_get_ref_no_null_check(intr
);
1574 BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z",
1576 return BT_FUNC_STATUS_OK
;
1579 void bt_graph_interrupt(struct bt_graph
*graph
)
1581 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1582 bt_interrupter_set(graph
->default_interrupter
);
1583 BT_LIB_LOGI("Interrupted graph: %!+g", graph
);
1586 void bt_graph_get_ref(const struct bt_graph
*graph
)
1588 bt_object_get_ref(graph
);
1591 void bt_graph_put_ref(const struct bt_graph
*graph
)
1593 bt_object_put_ref(graph
);