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"
45 #include "component-class-sink-simple.h"
46 #include "component.h"
47 #include "component-sink.h"
48 #include "connection.h"
50 #include "interrupter.h"
51 #include "message/event.h"
52 #include "message/packet.h"
54 typedef enum bt_graph_listener_func_status
55 (*port_added_func_t
)(const void *, const void *, void *);
57 typedef enum bt_graph_listener_func_status
58 (*ports_connected_func_t
)(const void *, const void *, const void *,
59 const void *, void *);
61 typedef enum bt_component_class_initialize_method_status
62 (*comp_init_method_t
)(const void *, void *, const void *, void *);
64 struct bt_graph_listener
{
65 bt_graph_listener_removed_func removed
;
69 struct bt_graph_listener_port_added
{
70 struct bt_graph_listener base
;
71 port_added_func_t func
;
74 struct bt_graph_listener_ports_connected
{
75 struct bt_graph_listener base
;
76 ports_connected_func_t func
;
79 #define INIT_LISTENERS_ARRAY(_type, _listeners) \
81 _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \
82 if (!(_listeners)) { \
83 BT_LIB_LOGE_APPEND_CAUSE( \
84 "Failed to allocate one GArray."); \
88 #define CALL_REMOVE_LISTENERS(_type, _listeners) \
95 for (i = 0; i < (_listeners)->len; i++) { \
97 &g_array_index((_listeners), _type, i); \
99 if (listener->base.removed) { \
100 listener->base.removed(listener->base.data); \
106 void destroy_graph(struct bt_object
*obj
)
108 struct bt_graph
*graph
= container_of(obj
, struct bt_graph
, base
);
111 * The graph's reference count is 0 if we're here. Increment
112 * it to avoid a double-destroy (possibly infinitely recursive)
115 * 1. We put and destroy a connection.
116 * 2. This connection's destructor finalizes its active message
118 * 3. A message iterator's finalization function gets a new
119 * reference on its component (reference count goes from 0 to
121 * 4. Since this component's reference count goes to 1, it takes
122 * a reference on its parent (this graph). This graph's
123 * reference count goes from 0 to 1.
124 * 5. The message iterator's finalization function puts its
125 * component reference (reference count goes from 1 to 0).
126 * 6. Since this component's reference count goes from 1 to 0,
127 * it puts its parent (this graph). This graph's reference
128 * count goes from 1 to 0.
129 * 7. Since this graph's reference count goes from 1 to 0, its
130 * destructor is called (this function).
132 * With the incrementation below, the graph's reference count at
133 * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This
134 * ensures that this function is not called two times.
136 BT_LIB_LOGI("Destroying graph: %!+g", graph
);
138 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_DESTROYING
;
140 /* Call all remove listeners */
141 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
142 graph
->listeners
.source_output_port_added
);
143 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
144 graph
->listeners
.filter_output_port_added
);
145 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
146 graph
->listeners
.filter_input_port_added
);
147 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
148 graph
->listeners
.sink_input_port_added
);
149 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
150 graph
->listeners
.source_filter_ports_connected
);
151 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
152 graph
->listeners
.filter_filter_ports_connected
);
153 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
154 graph
->listeners
.source_sink_ports_connected
);
155 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
156 graph
->listeners
.filter_sink_ports_connected
);
158 if (graph
->messages
) {
159 g_ptr_array_free(graph
->messages
, TRUE
);
160 graph
->messages
= NULL
;
163 if (graph
->connections
) {
164 BT_LOGD_STR("Destroying connections.");
165 g_ptr_array_free(graph
->connections
, TRUE
);
166 graph
->connections
= NULL
;
169 if (graph
->components
) {
170 BT_LOGD_STR("Destroying components.");
171 g_ptr_array_free(graph
->components
, TRUE
);
172 graph
->components
= NULL
;
175 if (graph
->interrupters
) {
176 BT_LOGD_STR("Putting interrupters.");
177 g_ptr_array_free(graph
->interrupters
, TRUE
);
178 graph
->interrupters
= NULL
;
181 BT_OBJECT_PUT_REF_AND_RESET(graph
->default_interrupter
);
183 if (graph
->sinks_to_consume
) {
184 g_queue_free(graph
->sinks_to_consume
);
185 graph
->sinks_to_consume
= NULL
;
188 if (graph
->listeners
.source_output_port_added
) {
189 g_array_free(graph
->listeners
.source_output_port_added
, TRUE
);
190 graph
->listeners
.source_output_port_added
= NULL
;
193 if (graph
->listeners
.filter_output_port_added
) {
194 g_array_free(graph
->listeners
.filter_output_port_added
, TRUE
);
195 graph
->listeners
.filter_output_port_added
= NULL
;
198 if (graph
->listeners
.filter_input_port_added
) {
199 g_array_free(graph
->listeners
.filter_input_port_added
, TRUE
);
200 graph
->listeners
.filter_input_port_added
= NULL
;
203 if (graph
->listeners
.sink_input_port_added
) {
204 g_array_free(graph
->listeners
.sink_input_port_added
, TRUE
);
205 graph
->listeners
.sink_input_port_added
= NULL
;
208 if (graph
->listeners
.source_filter_ports_connected
) {
209 g_array_free(graph
->listeners
.source_filter_ports_connected
,
211 graph
->listeners
.source_filter_ports_connected
= NULL
;
214 if (graph
->listeners
.filter_filter_ports_connected
) {
215 g_array_free(graph
->listeners
.filter_filter_ports_connected
,
217 graph
->listeners
.filter_filter_ports_connected
= NULL
;
220 if (graph
->listeners
.source_sink_ports_connected
) {
221 g_array_free(graph
->listeners
.source_sink_ports_connected
,
223 graph
->listeners
.source_sink_ports_connected
= NULL
;
226 if (graph
->listeners
.filter_sink_ports_connected
) {
227 g_array_free(graph
->listeners
.filter_sink_ports_connected
,
229 graph
->listeners
.filter_sink_ports_connected
= NULL
;
232 bt_object_pool_finalize(&graph
->event_msg_pool
);
233 bt_object_pool_finalize(&graph
->packet_begin_msg_pool
);
234 bt_object_pool_finalize(&graph
->packet_end_msg_pool
);
239 void destroy_message_event(struct bt_message
*msg
,
240 struct bt_graph
*graph
)
242 bt_message_event_destroy(msg
);
246 void destroy_message_packet_begin(struct bt_message
*msg
,
247 struct bt_graph
*graph
)
249 bt_message_packet_destroy(msg
);
253 void destroy_message_packet_end(struct bt_message
*msg
,
254 struct bt_graph
*graph
)
256 bt_message_packet_destroy(msg
);
260 void notify_message_graph_is_destroyed(struct bt_message
*msg
)
262 bt_message_unlink_graph(msg
);
265 struct bt_graph
*bt_graph_create(uint64_t mip_version
)
267 struct bt_graph
*graph
;
270 BT_ASSERT_PRE(mip_version
<= bt_get_maximal_mip_version(),
271 "Unknown MIP version: mip-version=%" PRIu64
", "
272 "max-mip-version=%" PRIu64
,
273 mip_version
, bt_get_maximal_mip_version());
274 BT_LOGI_STR("Creating graph object.");
275 graph
= g_new0(struct bt_graph
, 1);
277 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one graph.");
281 bt_object_init_shared(&graph
->base
, destroy_graph
);
282 graph
->mip_version
= mip_version
;
283 graph
->connections
= g_ptr_array_new_with_free_func(
284 (GDestroyNotify
) bt_object_try_spec_release
);
285 if (!graph
->connections
) {
286 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
289 graph
->components
= g_ptr_array_new_with_free_func(
290 (GDestroyNotify
) bt_object_try_spec_release
);
291 if (!graph
->components
) {
292 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
295 graph
->sinks_to_consume
= g_queue_new();
296 if (!graph
->sinks_to_consume
) {
297 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GQueue.");
301 bt_graph_set_can_consume(graph
, true);
302 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
303 graph
->listeners
.source_output_port_added
);
305 if (!graph
->listeners
.source_output_port_added
) {
309 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
310 graph
->listeners
.filter_output_port_added
);
312 if (!graph
->listeners
.filter_output_port_added
) {
316 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
317 graph
->listeners
.filter_input_port_added
);
319 if (!graph
->listeners
.filter_input_port_added
) {
323 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
324 graph
->listeners
.sink_input_port_added
);
326 if (!graph
->listeners
.sink_input_port_added
) {
330 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
331 graph
->listeners
.source_filter_ports_connected
);
333 if (!graph
->listeners
.source_filter_ports_connected
) {
337 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
338 graph
->listeners
.source_sink_ports_connected
);
340 if (!graph
->listeners
.source_sink_ports_connected
) {
344 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
345 graph
->listeners
.filter_filter_ports_connected
);
347 if (!graph
->listeners
.filter_filter_ports_connected
) {
351 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
352 graph
->listeners
.filter_sink_ports_connected
);
354 if (!graph
->listeners
.filter_sink_ports_connected
) {
358 graph
->interrupters
= g_ptr_array_new_with_free_func(
359 (GDestroyNotify
) bt_object_put_ref_no_null_check
);
360 if (!graph
->interrupters
) {
361 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
365 graph
->default_interrupter
= bt_interrupter_create();
366 if (!graph
->default_interrupter
) {
367 BT_LIB_LOGE_APPEND_CAUSE(
368 "Failed to create one interrupter object.");
372 bt_graph_add_interrupter(graph
, graph
->default_interrupter
);
373 ret
= bt_object_pool_initialize(&graph
->event_msg_pool
,
374 (bt_object_pool_new_object_func
) bt_message_event_new
,
375 (bt_object_pool_destroy_object_func
) destroy_message_event
,
378 BT_LIB_LOGE_APPEND_CAUSE(
379 "Failed to initialize event message pool: ret=%d",
384 ret
= bt_object_pool_initialize(&graph
->packet_begin_msg_pool
,
385 (bt_object_pool_new_object_func
) bt_message_packet_beginning_new
,
386 (bt_object_pool_destroy_object_func
) destroy_message_packet_begin
,
389 BT_LIB_LOGE_APPEND_CAUSE(
390 "Failed to initialize packet beginning message pool: ret=%d",
395 ret
= bt_object_pool_initialize(&graph
->packet_end_msg_pool
,
396 (bt_object_pool_new_object_func
) bt_message_packet_end_new
,
397 (bt_object_pool_destroy_object_func
) destroy_message_packet_end
,
400 BT_LIB_LOGE_APPEND_CAUSE(
401 "Failed to initialize packet end message pool: ret=%d",
406 graph
->messages
= g_ptr_array_new_with_free_func(
407 (GDestroyNotify
) notify_message_graph_is_destroyed
);
408 BT_LIB_LOGI("Created graph object: %!+g", graph
);
411 return (void *) graph
;
414 BT_OBJECT_PUT_REF_AND_RESET(graph
);
418 enum bt_graph_connect_ports_status
bt_graph_connect_ports(
419 struct bt_graph
*graph
,
420 const struct bt_port_output
*upstream_port_out
,
421 const struct bt_port_input
*downstream_port_in
,
422 const struct bt_connection
**user_connection
)
424 enum bt_graph_connect_ports_status status
= BT_FUNC_STATUS_OK
;
425 enum bt_graph_listener_func_status listener_status
;
426 struct bt_connection
*connection
= NULL
;
427 struct bt_port
*upstream_port
= (void *) upstream_port_out
;
428 struct bt_port
*downstream_port
= (void *) downstream_port_in
;
429 struct bt_component
*upstream_component
= NULL
;
430 struct bt_component
*downstream_component
= NULL
;
431 enum bt_component_class_port_connected_method_status port_connected_status
;
432 bool init_can_consume
;
434 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
435 BT_ASSERT_PRE_NON_NULL(upstream_port
, "Upstream port");
436 BT_ASSERT_PRE_NON_NULL(downstream_port
, "Downstream port port");
438 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
439 "Graph is not in the \"configuring\" state: %!+g", graph
);
440 BT_ASSERT_PRE(!bt_port_is_connected(upstream_port
),
441 "Upstream port is already connected: %!+p", upstream_port
);
442 BT_ASSERT_PRE(!bt_port_is_connected(downstream_port
),
443 "Downstream port is already connected: %!+p", downstream_port
);
444 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port
),
445 "Upstream port does not belong to a component: %!+p",
447 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port
),
448 "Downstream port does not belong to a component: %!+p",
450 init_can_consume
= graph
->can_consume
;
451 BT_LIB_LOGI("Connecting component ports within graph: "
452 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
453 graph
, upstream_port
, downstream_port
);
454 bt_graph_set_can_consume(graph
, false);
455 upstream_component
= bt_port_borrow_component_inline(
456 (void *) upstream_port
);
457 downstream_component
= bt_port_borrow_component_inline(
458 (void *) downstream_port
);
460 BT_LOGD_STR("Creating connection.");
461 connection
= bt_connection_create(graph
, (void *) upstream_port
,
462 (void *) downstream_port
);
464 BT_LIB_LOGE_APPEND_CAUSE("Cannot create connection object.");
465 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
469 BT_LIB_LOGD("Connection object created: %!+x", connection
);
472 * Ownership of upstream_component/downstream_component and of
473 * the connection object is transferred to the graph.
475 g_ptr_array_add(graph
->connections
, connection
);
478 * Notify both components that their port is connected.
480 BT_LIB_LOGD("Notifying upstream component that its port is connected: "
481 "%![comp-]+c, %![port-]+p", upstream_component
, upstream_port
);
482 port_connected_status
= bt_component_port_connected(upstream_component
,
483 (void *) upstream_port
, (void *) downstream_port
);
484 if (port_connected_status
!= BT_FUNC_STATUS_OK
) {
485 if (port_connected_status
< 0) {
486 BT_LIB_LOGW_APPEND_CAUSE(
487 "Upstream component's \"port connected\" method failed: "
488 "status=%s, %![graph-]+g, %![up-comp-]+c, "
489 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
490 bt_common_func_status_string(
491 port_connected_status
),
492 graph
, upstream_component
, downstream_component
,
493 upstream_port
, downstream_port
);
496 bt_connection_end(connection
, true);
497 status
= (int) port_connected_status
;
501 connection
->notified_upstream_port_connected
= true;
502 BT_LIB_LOGD("Notifying downstream component that its port is connected: "
503 "%![comp-]+c, %![port-]+p", downstream_component
,
505 port_connected_status
= bt_component_port_connected(downstream_component
,
506 (void *) downstream_port
, (void *) upstream_port
);
507 if (port_connected_status
!= BT_FUNC_STATUS_OK
) {
508 if (port_connected_status
< 0) {
509 BT_LIB_LOGW_APPEND_CAUSE(
510 "Downstream component's \"port connected\" method failed: "
511 "status=%s, %![graph-]+g, %![up-comp-]+c, "
512 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
513 bt_common_func_status_string(
514 port_connected_status
),
515 graph
, upstream_component
, downstream_component
,
516 upstream_port
, downstream_port
);
519 bt_connection_end(connection
, true);
520 status
= (int) port_connected_status
;
524 connection
->notified_downstream_port_connected
= true;
527 * Notify the graph's creator that both ports are connected.
529 BT_LOGD_STR("Notifying graph's user that new component ports are connected.");
530 listener_status
= bt_graph_notify_ports_connected(graph
, upstream_port
, downstream_port
);
531 if (listener_status
!= BT_FUNC_STATUS_OK
) {
532 if (listener_status
< 0) {
533 BT_LIB_LOGW_APPEND_CAUSE(
534 "Graph \"ports connected\" listener failed: "
535 "status=%d, %![graph-]+g, %![up-comp-]+c, "
536 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
537 listener_status
, graph
,
538 upstream_component
, downstream_component
,
539 upstream_port
, downstream_port
);
542 status
= (int) listener_status
;
546 connection
->notified_graph_ports_connected
= true;
547 BT_LIB_LOGI("Connected component ports within graph: "
548 "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
549 "%![up-port-]+p, %![down-port-]+p",
550 graph
, upstream_component
, downstream_component
,
551 upstream_port
, downstream_port
);
553 if (user_connection
) {
554 /* Move reference to user */
555 *user_connection
= connection
;
560 if (status
!= BT_FUNC_STATUS_OK
) {
561 bt_graph_make_faulty(graph
);
564 bt_object_put_ref(connection
);
565 (void) init_can_consume
;
566 bt_graph_set_can_consume(graph
, init_can_consume
);
571 int consume_graph_sink(struct bt_component_sink
*comp
)
573 enum bt_component_class_sink_consume_method_status consume_status
;
574 struct bt_component_class_sink
*sink_class
= NULL
;
577 sink_class
= (void *) comp
->parent
.class;
578 BT_ASSERT_DBG(sink_class
->methods
.consume
);
579 BT_LIB_LOGD("Calling user's consume method: %!+c", comp
);
580 consume_status
= sink_class
->methods
.consume((void *) comp
);
581 BT_LOGD("User method returned: status=%s",
582 bt_common_func_status_string(consume_status
));
583 BT_ASSERT_POST_DEV(consume_status
== BT_FUNC_STATUS_OK
||
584 consume_status
== BT_FUNC_STATUS_END
||
585 consume_status
== BT_FUNC_STATUS_AGAIN
||
586 consume_status
== BT_FUNC_STATUS_ERROR
||
587 consume_status
== BT_FUNC_STATUS_MEMORY_ERROR
,
588 "Invalid component status returned by consuming method: "
589 "status=%s", bt_common_func_status_string(consume_status
));
590 if (consume_status
) {
591 if (consume_status
< 0) {
592 BT_LIB_LOGW_APPEND_CAUSE(
593 "Component's \"consume\" method failed: "
594 "status=%s, %![comp-]+c",
595 bt_common_func_status_string(consume_status
),
602 BT_LIB_LOGD("Consumed from sink: %![comp-]+c, status=%s",
603 comp
, bt_common_func_status_string(consume_status
));
606 return consume_status
;
610 * `node` is removed from the queue of sinks to consume when passed to
611 * this function. This function adds it back to the queue if there's
612 * still something to consume afterwards.
615 int consume_sink_node(struct bt_graph
*graph
, GList
*node
)
618 struct bt_component_sink
*sink
;
621 status
= consume_graph_sink(sink
);
622 if (G_UNLIKELY(status
!= BT_FUNC_STATUS_END
)) {
623 g_queue_push_tail_link(graph
->sinks_to_consume
, node
);
627 /* End reached, the node is not added back to the queue and free'd. */
628 g_queue_delete_link(graph
->sinks_to_consume
, node
);
630 /* Don't forward an END status if there are sinks left to consume. */
631 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
632 status
= BT_FUNC_STATUS_OK
;
637 BT_LIB_LOGD("Consumed sink node: %![comp-]+c, status=%s",
638 sink
, bt_common_func_status_string(status
));
643 int bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
644 struct bt_component_sink
*sink
)
650 BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink
);
651 BT_ASSERT_DBG(bt_component_borrow_graph((void *) sink
) == graph
);
653 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
654 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
655 status
= BT_FUNC_STATUS_END
;
659 index
= g_queue_index(graph
->sinks_to_consume
, sink
);
661 BT_LIB_LOGD("Sink component is not marked as consumable: "
662 "component sink is ended: %![comp-]+c", sink
);
663 status
= BT_FUNC_STATUS_END
;
667 sink_node
= g_queue_pop_nth_link(graph
->sinks_to_consume
, index
);
668 BT_ASSERT_DBG(sink_node
);
669 status
= consume_sink_node(graph
, sink_node
);
676 int consume_no_check(struct bt_graph
*graph
)
678 int status
= BT_FUNC_STATUS_OK
;
679 struct bt_component
*sink
;
682 BT_ASSERT_PRE_DEV(graph
->has_sink
,
683 "Graph has no sink component: %!+g", graph
);
684 BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph
);
686 if (G_UNLIKELY(g_queue_is_empty(graph
->sinks_to_consume
))) {
687 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
688 status
= BT_FUNC_STATUS_END
;
692 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
693 sink
= current_node
->data
;
694 BT_LIB_LOGD("Chose next sink to consume: %!+c", sink
);
695 status
= consume_sink_node(graph
, current_node
);
701 enum bt_graph_run_once_status
bt_graph_run_once(struct bt_graph
*graph
)
703 enum bt_graph_run_once_status status
;
705 BT_ASSERT_PRE_DEV_NON_NULL(graph
, "Graph");
706 BT_ASSERT_PRE_DEV(graph
->can_consume
,
707 "Cannot consume graph in its current state: %!+g", graph
);
708 BT_ASSERT_PRE_DEV(graph
->config_state
!=
709 BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
710 "Graph is in a faulty state: %!+g", graph
);
711 bt_graph_set_can_consume(graph
, false);
712 status
= bt_graph_configure(graph
);
713 if (G_UNLIKELY(status
)) {
714 /* bt_graph_configure() logs errors */
718 status
= consume_no_check(graph
);
719 bt_graph_set_can_consume(graph
, true);
725 enum bt_graph_run_status
bt_graph_run(struct bt_graph
*graph
)
727 enum bt_graph_run_status status
;
729 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
730 BT_ASSERT_PRE(graph
->can_consume
,
731 "Cannot consume graph in its current state: %!+g", graph
);
732 BT_ASSERT_PRE(graph
->config_state
!= BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
733 "Graph is in a faulty state: %!+g", graph
);
734 bt_graph_set_can_consume(graph
, false);
735 status
= bt_graph_configure(graph
);
736 if (G_UNLIKELY(status
)) {
737 /* bt_graph_configure() logs errors */
741 BT_LIB_LOGI("Running graph: %!+g", graph
);
745 * Check if the graph is interrupted at each iteration.
746 * If the graph was interrupted by another thread or by
747 * a signal handler, this is NOT a warning nor an error;
748 * it was intentional: log with an INFO level only.
750 if (G_UNLIKELY(bt_graph_is_interrupted(graph
))) {
751 BT_LIB_LOGI("Stopping the graph: "
752 "graph was interrupted: %!+g", graph
);
753 status
= BT_FUNC_STATUS_AGAIN
;
757 status
= consume_no_check(graph
);
758 if (G_UNLIKELY(status
== BT_FUNC_STATUS_AGAIN
)) {
760 * If AGAIN is received and there are multiple
761 * sinks, go ahead and consume from the next
764 * However, in the case where a single sink is
765 * left, the caller can decide to busy-wait and
766 * call bt_graph_run() continuously
767 * until the source is ready or it can decide to
768 * sleep for an arbitrary amount of time.
770 if (graph
->sinks_to_consume
->length
> 1) {
771 status
= BT_FUNC_STATUS_OK
;
774 } while (status
== BT_FUNC_STATUS_OK
);
776 if (status
== BT_FUNC_STATUS_END
) {
778 * The last call to consume_no_check() returned
779 * `BT_FUNC_STATUS_END`, but bt_graph_run() has no
780 * `BT_GRAPH_RUN_STATUS_END` status: replace with
781 * `BT_GRAPH_RUN_STATUS_OK` (success: graph ran
784 status
= BT_FUNC_STATUS_OK
;
788 BT_LIB_LOGI("Graph ran: %![graph-]+g, status=%s", graph
,
789 bt_common_func_status_string(status
));
790 bt_graph_set_can_consume(graph
, true);
794 enum bt_graph_add_listener_status
795 bt_graph_add_source_component_output_port_added_listener(
796 struct bt_graph
*graph
,
797 bt_graph_source_component_output_port_added_listener_func func
,
798 bt_graph_listener_removed_func listener_removed
, void *data
,
799 bt_listener_id
*out_listener_id
)
801 struct bt_graph_listener_port_added listener
= {
803 .removed
= listener_removed
,
806 .func
= (port_added_func_t
) func
,
808 bt_listener_id listener_id
;
810 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
811 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
812 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
813 BT_ASSERT_PRE(!graph
->in_remove_listener
,
814 "Graph currently executing a \"listener removed\" listener: "
816 g_array_append_val(graph
->listeners
.source_output_port_added
, listener
);
817 listener_id
= graph
->listeners
.source_output_port_added
->len
- 1;
818 BT_LIB_LOGD("Added \"source component output port added\" listener to graph: "
819 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
823 *out_listener_id
= listener_id
;
826 return BT_FUNC_STATUS_OK
;
829 enum bt_graph_add_listener_status
830 bt_graph_add_filter_component_output_port_added_listener(
831 struct bt_graph
*graph
,
832 bt_graph_filter_component_output_port_added_listener_func func
,
833 bt_graph_listener_removed_func listener_removed
, void *data
,
834 bt_listener_id
*out_listener_id
)
836 struct bt_graph_listener_port_added listener
= {
838 .removed
= listener_removed
,
841 .func
= (port_added_func_t
) func
,
843 bt_listener_id listener_id
;
845 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
846 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
847 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
848 BT_ASSERT_PRE(!graph
->in_remove_listener
,
849 "Graph currently executing a \"listener removed\" listener: "
851 g_array_append_val(graph
->listeners
.filter_output_port_added
, listener
);
852 listener_id
= graph
->listeners
.filter_output_port_added
->len
- 1;
853 BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: "
854 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
858 *out_listener_id
= listener_id
;
861 return BT_FUNC_STATUS_OK
;
864 enum bt_graph_add_listener_status
865 bt_graph_add_filter_component_input_port_added_listener(
866 struct bt_graph
*graph
,
867 bt_graph_filter_component_input_port_added_listener_func func
,
868 bt_graph_listener_removed_func listener_removed
, void *data
,
869 bt_listener_id
*out_listener_id
)
871 struct bt_graph_listener_port_added listener
= {
873 .removed
= listener_removed
,
876 .func
= (port_added_func_t
) func
,
878 bt_listener_id listener_id
;
880 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
881 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
882 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
883 BT_ASSERT_PRE(!graph
->in_remove_listener
,
884 "Graph currently executing a \"listener removed\" listener: "
886 g_array_append_val(graph
->listeners
.filter_input_port_added
, listener
);
887 listener_id
= graph
->listeners
.filter_input_port_added
->len
- 1;
888 BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: "
889 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
893 *out_listener_id
= listener_id
;
896 return BT_FUNC_STATUS_OK
;
899 enum bt_graph_add_listener_status
900 bt_graph_add_sink_component_input_port_added_listener(
901 struct bt_graph
*graph
,
902 bt_graph_sink_component_input_port_added_listener_func func
,
903 bt_graph_listener_removed_func listener_removed
, void *data
,
904 bt_listener_id
*out_listener_id
)
906 struct bt_graph_listener_port_added listener
= {
908 .removed
= listener_removed
,
911 .func
= (port_added_func_t
) func
,
913 bt_listener_id listener_id
;
915 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
916 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
917 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
918 BT_ASSERT_PRE(!graph
->in_remove_listener
,
919 "Graph currently executing a \"listener removed\" listener: "
921 g_array_append_val(graph
->listeners
.sink_input_port_added
, listener
);
922 listener_id
= graph
->listeners
.sink_input_port_added
->len
- 1;
923 BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: "
924 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
928 *out_listener_id
= listener_id
;
931 return BT_FUNC_STATUS_OK
;
934 enum bt_graph_add_listener_status
935 bt_graph_add_source_filter_component_ports_connected_listener(
936 struct bt_graph
*graph
,
937 bt_graph_source_filter_component_ports_connected_listener_func func
,
938 bt_graph_listener_removed_func listener_removed
, void *data
,
939 bt_listener_id
*out_listener_id
)
941 struct bt_graph_listener_ports_connected listener
= {
943 .removed
= listener_removed
,
946 .func
= (ports_connected_func_t
) func
,
948 bt_listener_id listener_id
;
950 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
951 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
952 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
953 BT_ASSERT_PRE(!graph
->in_remove_listener
,
954 "Graph currently executing a \"listener removed\" listener: "
956 g_array_append_val(graph
->listeners
.source_filter_ports_connected
,
958 listener_id
= graph
->listeners
.source_filter_ports_connected
->len
- 1;
959 BT_LIB_LOGD("Added \"source to filter component ports connected\" listener to graph: "
960 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
964 *out_listener_id
= listener_id
;
967 return BT_FUNC_STATUS_OK
;
970 enum bt_graph_add_listener_status
971 bt_graph_add_source_sink_component_ports_connected_listener(
972 struct bt_graph
*graph
,
973 bt_graph_source_sink_component_ports_connected_listener_func func
,
974 bt_graph_listener_removed_func listener_removed
, void *data
,
975 bt_listener_id
*out_listener_id
)
977 struct bt_graph_listener_ports_connected listener
= {
979 .removed
= listener_removed
,
982 .func
= (ports_connected_func_t
) func
,
984 bt_listener_id listener_id
;
986 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
987 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
988 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
989 BT_ASSERT_PRE(!graph
->in_remove_listener
,
990 "Graph currently executing a \"listener removed\" listener: "
992 g_array_append_val(graph
->listeners
.source_sink_ports_connected
,
994 listener_id
= graph
->listeners
.source_sink_ports_connected
->len
- 1;
995 BT_LIB_LOGD("Added \"source to sink component ports connected\" listener to graph: "
996 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1000 *out_listener_id
= listener_id
;
1003 return BT_FUNC_STATUS_OK
;
1006 enum bt_graph_add_listener_status
1007 bt_graph_add_filter_filter_component_ports_connected_listener(
1008 struct bt_graph
*graph
,
1009 bt_graph_filter_filter_component_ports_connected_listener_func func
,
1010 bt_graph_listener_removed_func listener_removed
, void *data
,
1011 bt_listener_id
*out_listener_id
)
1013 struct bt_graph_listener_ports_connected listener
= {
1015 .removed
= listener_removed
,
1018 .func
= (ports_connected_func_t
) func
,
1020 bt_listener_id listener_id
;
1022 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1023 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1024 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1025 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1026 "Graph currently executing a \"listener removed\" listener: "
1028 g_array_append_val(graph
->listeners
.filter_filter_ports_connected
,
1030 listener_id
= graph
->listeners
.filter_filter_ports_connected
->len
- 1;
1031 BT_LIB_LOGD("Added \"filter to filter component ports connected\" listener to graph: "
1032 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1036 *out_listener_id
= listener_id
;
1039 return BT_FUNC_STATUS_OK
;
1042 enum bt_graph_add_listener_status
1043 bt_graph_add_filter_sink_component_ports_connected_listener(
1044 struct bt_graph
*graph
,
1045 bt_graph_filter_sink_component_ports_connected_listener_func func
,
1046 bt_graph_listener_removed_func listener_removed
, void *data
,
1047 bt_listener_id
*out_listener_id
)
1049 struct bt_graph_listener_ports_connected listener
= {
1051 .removed
= listener_removed
,
1054 .func
= (ports_connected_func_t
) func
,
1056 bt_listener_id listener_id
;
1058 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1059 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1060 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1061 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1062 "Graph currently executing a \"listener removed\" listener: "
1064 g_array_append_val(graph
->listeners
.filter_sink_ports_connected
,
1066 listener_id
= graph
->listeners
.filter_sink_ports_connected
->len
- 1;
1067 BT_LIB_LOGD("Added \"filter to sink component ports connected\" listener to graph: "
1068 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1072 *out_listener_id
= listener_id
;
1075 return BT_FUNC_STATUS_OK
;
1079 enum bt_graph_listener_func_status
bt_graph_notify_port_added(
1080 struct bt_graph
*graph
, struct bt_port
*port
)
1084 struct bt_component
*comp
;
1085 enum bt_graph_listener_func_status status
= BT_FUNC_STATUS_OK
;
1089 BT_LIB_LOGD("Notifying graph listeners that a port was added: "
1090 "%![graph-]+g, %![port-]+p", graph
, port
);
1091 comp
= bt_port_borrow_component_inline(port
);
1094 switch (comp
->class->type
) {
1095 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1097 switch (port
->type
) {
1098 case BT_PORT_TYPE_OUTPUT
:
1099 listeners
= graph
->listeners
.source_output_port_added
;
1107 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1109 switch (port
->type
) {
1110 case BT_PORT_TYPE_INPUT
:
1111 listeners
= graph
->listeners
.filter_input_port_added
;
1113 case BT_PORT_TYPE_OUTPUT
:
1114 listeners
= graph
->listeners
.filter_output_port_added
;
1122 case BT_COMPONENT_CLASS_TYPE_SINK
:
1124 switch (port
->type
) {
1125 case BT_PORT_TYPE_INPUT
:
1126 listeners
= graph
->listeners
.sink_input_port_added
;
1138 for (i
= 0; i
< listeners
->len
; i
++) {
1139 struct bt_graph_listener_port_added
*listener
=
1140 &g_array_index(listeners
,
1141 struct bt_graph_listener_port_added
, i
);
1144 BT_ASSERT(listener
->func
);
1145 status
= listener
->func(comp
, port
, listener
->base
.data
);
1146 if (status
!= BT_FUNC_STATUS_OK
) {
1156 enum bt_graph_listener_func_status
bt_graph_notify_ports_connected(
1157 struct bt_graph
*graph
, struct bt_port
*upstream_port
,
1158 struct bt_port
*downstream_port
)
1162 struct bt_component
*upstream_comp
;
1163 struct bt_component
*downstream_comp
;
1164 enum bt_graph_listener_func_status status
= BT_FUNC_STATUS_OK
;
1167 BT_ASSERT(upstream_port
);
1168 BT_ASSERT(downstream_port
);
1169 BT_LIB_LOGD("Notifying graph listeners that ports were connected: "
1170 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
1171 graph
, upstream_port
, downstream_port
);
1172 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
1173 BT_ASSERT(upstream_comp
);
1174 downstream_comp
= bt_port_borrow_component_inline(downstream_port
);
1175 BT_ASSERT(downstream_comp
);
1177 switch (upstream_comp
->class->type
) {
1178 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1180 switch (downstream_comp
->class->type
) {
1181 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1183 graph
->listeners
.source_filter_ports_connected
;
1185 case BT_COMPONENT_CLASS_TYPE_SINK
:
1187 graph
->listeners
.source_sink_ports_connected
;
1195 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1197 switch (downstream_comp
->class->type
) {
1198 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1200 graph
->listeners
.filter_filter_ports_connected
;
1202 case BT_COMPONENT_CLASS_TYPE_SINK
:
1204 graph
->listeners
.filter_sink_ports_connected
;
1216 for (i
= 0; i
< listeners
->len
; i
++) {
1217 struct bt_graph_listener_ports_connected
*listener
=
1218 &g_array_index(listeners
,
1219 struct bt_graph_listener_ports_connected
, i
);
1221 BT_ASSERT(listener
->func
);
1222 status
= listener
->func(upstream_comp
, downstream_comp
,
1223 upstream_port
, downstream_port
, listener
->base
.data
);
1224 if (status
!= BT_FUNC_STATUS_OK
) {
1234 void bt_graph_remove_connection(struct bt_graph
*graph
,
1235 struct bt_connection
*connection
)
1238 BT_ASSERT(connection
);
1239 BT_LIB_LOGD("Removing graph's connection: %![graph-]+g, %![conn-]+x",
1241 g_ptr_array_remove(graph
->connections
, connection
);
1245 bool component_name_exists(struct bt_graph
*graph
, const char *name
)
1247 bool exists
= false;
1250 for (i
= 0; i
< graph
->components
->len
; i
++) {
1251 struct bt_component
*other_comp
= graph
->components
->pdata
[i
];
1253 if (strcmp(name
, bt_component_get_name(other_comp
)) == 0) {
1254 BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: "
1255 "%![other-comp-]+c, name=\"%s\"",
1267 int add_component_with_init_method_data(
1268 struct bt_graph
*graph
,
1269 struct bt_component_class
*comp_cls
,
1270 comp_init_method_t init_method
,
1271 const char *name
, const struct bt_value
*params
,
1272 void *init_method_data
, bt_logging_level log_level
,
1273 const struct bt_component
**user_component
)
1275 int status
= BT_FUNC_STATUS_OK
;
1276 enum bt_component_class_initialize_method_status init_status
;
1277 struct bt_component
*component
= NULL
;
1279 bool init_can_consume
;
1280 struct bt_value
*new_params
= NULL
;
1282 BT_ASSERT(comp_cls
);
1283 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1284 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1286 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1287 "Graph is not in the \"configuring\" state: %!+g", graph
);
1288 BT_ASSERT_PRE(!component_name_exists(graph
, name
),
1289 "Duplicate component name: %!+g, name=\"%s\"", graph
, name
);
1290 BT_ASSERT_PRE(!params
|| bt_value_is_map(params
),
1291 "Parameter value is not a map value: %!+v", params
);
1292 init_can_consume
= graph
->can_consume
;
1293 bt_graph_set_can_consume(graph
, false);
1294 BT_LIB_LOGI("Adding component to graph: "
1295 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1296 "%![params-]+v, init-method-data-addr=%p",
1297 graph
, comp_cls
, name
,
1298 bt_common_logging_level_string(log_level
), params
,
1302 new_params
= bt_value_map_create();
1304 BT_LIB_LOGE_APPEND_CAUSE(
1305 "Cannot create empty map value object.");
1306 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1310 params
= new_params
;
1313 ret
= bt_component_create(comp_cls
, name
, log_level
, &component
);
1315 BT_LIB_LOGE_APPEND_CAUSE(
1316 "Cannot create empty component object: ret=%d",
1318 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1323 * The user's initialization method needs to see that this
1324 * component is part of the graph. If the user method fails, we
1325 * immediately remove the component from the graph's components.
1327 g_ptr_array_add(graph
->components
, component
);
1328 bt_component_set_graph(component
, graph
);
1329 bt_value_freeze(params
);
1333 * There is no use for config objects right now, so just pass
1336 BT_LOGD_STR("Calling user's initialization method.");
1337 init_status
= init_method(component
, NULL
, params
, init_method_data
);
1338 BT_LOGD("User method returned: status=%s",
1339 bt_common_func_status_string(init_status
));
1340 if (init_status
!= BT_FUNC_STATUS_OK
) {
1341 if (init_status
< 0) {
1342 BT_LIB_LOGW_APPEND_CAUSE(
1343 "Component initialization method failed: "
1344 "status=%s, %![comp-]+c",
1345 bt_common_func_status_string(init_status
),
1349 status
= init_status
;
1350 bt_component_set_graph(component
, NULL
);
1351 g_ptr_array_remove_fast(graph
->components
, component
);
1357 * Mark the component as initialized so that its finalization
1358 * method is called when it is destroyed.
1360 component
->initialized
= true;
1363 * If it's a sink component, it needs to be part of the graph's
1364 * sink queue to be consumed by bt_graph_run() or
1365 * bt_graph_run_once().
1367 if (bt_component_is_sink(component
)) {
1368 graph
->has_sink
= true;
1369 g_queue_push_tail(graph
->sinks_to_consume
, component
);
1373 * Freeze the component class now that it's instantiated at
1376 BT_LOGD_STR("Freezing component class.");
1377 bt_component_class_freeze(comp_cls
);
1378 BT_LIB_LOGI("Added component to graph: "
1379 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1380 "%![params-]+v, init-method-data-addr=%p, %![comp-]+c",
1381 graph
, comp_cls
, name
,
1382 bt_common_logging_level_string(log_level
), params
,
1383 init_method_data
, component
);
1385 if (user_component
) {
1386 /* Move reference to user */
1387 *user_component
= component
;
1392 if (status
!= BT_FUNC_STATUS_OK
) {
1393 bt_graph_make_faulty(graph
);
1396 bt_object_put_ref(component
);
1397 bt_object_put_ref(new_params
);
1398 (void) init_can_consume
;
1399 bt_graph_set_can_consume(graph
, init_can_consume
);
1403 enum bt_graph_add_component_status
1404 bt_graph_add_source_component_with_initialize_method_data(
1405 struct bt_graph
*graph
,
1406 const struct bt_component_class_source
*comp_cls
,
1407 const char *name
, const struct bt_value
*params
,
1408 void *init_method_data
, bt_logging_level log_level
,
1409 const struct bt_component_source
**component
)
1411 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1412 return add_component_with_init_method_data(graph
,
1413 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1414 name
, params
, init_method_data
, log_level
, (void *) component
);
1417 enum bt_graph_add_component_status
bt_graph_add_source_component(
1418 struct bt_graph
*graph
,
1419 const struct bt_component_class_source
*comp_cls
,
1420 const char *name
, const struct bt_value
*params
,
1421 enum bt_logging_level log_level
,
1422 const struct bt_component_source
**component
)
1424 return bt_graph_add_source_component_with_initialize_method_data(
1425 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1428 enum bt_graph_add_component_status
1429 bt_graph_add_filter_component_with_initialize_method_data(
1430 struct bt_graph
*graph
,
1431 const struct bt_component_class_filter
*comp_cls
,
1432 const char *name
, const struct bt_value
*params
,
1433 void *init_method_data
, enum bt_logging_level log_level
,
1434 const struct bt_component_filter
**component
)
1436 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1437 return add_component_with_init_method_data(graph
,
1438 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1439 name
, params
, init_method_data
, log_level
, (void *) component
);
1442 enum bt_graph_add_component_status
bt_graph_add_filter_component(
1443 struct bt_graph
*graph
,
1444 const struct bt_component_class_filter
*comp_cls
,
1445 const char *name
, const struct bt_value
*params
,
1446 enum bt_logging_level log_level
,
1447 const struct bt_component_filter
**component
)
1449 return bt_graph_add_filter_component_with_initialize_method_data(
1450 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1453 enum bt_graph_add_component_status
1454 bt_graph_add_sink_component_with_initialize_method_data(
1455 struct bt_graph
*graph
,
1456 const struct bt_component_class_sink
*comp_cls
,
1457 const char *name
, const struct bt_value
*params
,
1458 void *init_method_data
, enum bt_logging_level log_level
,
1459 const struct bt_component_sink
**component
)
1461 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1462 return add_component_with_init_method_data(graph
,
1463 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1464 name
, params
, init_method_data
, log_level
, (void *) component
);
1467 enum bt_graph_add_component_status
bt_graph_add_sink_component(
1468 struct bt_graph
*graph
,
1469 const struct bt_component_class_sink
*comp_cls
,
1470 const char *name
, const struct bt_value
*params
,
1471 enum bt_logging_level log_level
,
1472 const struct bt_component_sink
**component
)
1474 return bt_graph_add_sink_component_with_initialize_method_data(
1475 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1478 enum bt_graph_add_component_status
1479 bt_graph_add_simple_sink_component(struct bt_graph
*graph
, const char *name
,
1480 bt_graph_simple_sink_component_initialize_func init_func
,
1481 bt_graph_simple_sink_component_consume_func consume_func
,
1482 bt_graph_simple_sink_component_finalize_func finalize_func
,
1483 void *user_data
, const bt_component_sink
**component
)
1485 enum bt_graph_add_component_status status
;
1486 struct bt_component_class_sink
*comp_cls
;
1487 struct simple_sink_init_method_data init_method_data
= {
1488 .init_func
= init_func
,
1489 .consume_func
= consume_func
,
1490 .finalize_func
= finalize_func
,
1491 .user_data
= user_data
,
1495 * Other preconditions are checked by
1496 * bt_graph_add_sink_component_with_init_method_data().
1498 BT_ASSERT_PRE_NON_NULL(consume_func
, "Consume function");
1500 comp_cls
= bt_component_class_sink_simple_borrow();
1502 BT_LIB_LOGE_APPEND_CAUSE(
1503 "Cannot borrow simple sink component class.");
1504 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1508 status
= bt_graph_add_sink_component_with_initialize_method_data(graph
,
1509 comp_cls
, name
, NULL
, &init_method_data
,
1510 BT_LOGGING_LEVEL_NONE
, component
);
1517 void bt_graph_add_message(struct bt_graph
*graph
,
1518 struct bt_message
*msg
)
1524 * It's okay not to take a reference because, when a
1525 * message's reference count drops to 0, either:
1527 * * It is recycled back to one of this graph's pool.
1528 * * It is destroyed because it doesn't have any link to any
1529 * graph, which means the original graph is already destroyed.
1531 g_ptr_array_add(graph
->messages
, msg
);
1535 bool bt_graph_is_interrupted(const struct bt_graph
*graph
)
1537 BT_ASSERT_DBG(graph
);
1538 return bt_interrupter_array_any_is_set(graph
->interrupters
);
1541 enum bt_graph_add_interrupter_status
bt_graph_add_interrupter(
1542 struct bt_graph
*graph
, const struct bt_interrupter
*intr
)
1544 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1545 BT_ASSERT_PRE_NON_NULL(intr
, "Interrupter");
1546 g_ptr_array_add(graph
->interrupters
, (void *) intr
);
1547 bt_object_get_ref_no_null_check(intr
);
1548 BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z",
1550 return BT_FUNC_STATUS_OK
;
1553 void bt_graph_interrupt(struct bt_graph
*graph
)
1555 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1556 bt_interrupter_set(graph
->default_interrupter
);
1557 BT_LIB_LOGI("Interrupted graph: %!+g", graph
);
1560 void bt_graph_get_ref(const struct bt_graph
*graph
)
1562 bt_object_get_ref(graph
);
1565 void bt_graph_put_ref(const struct bt_graph
*graph
)
1567 bt_object_put_ref(graph
);