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_init_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
) {
310 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
311 graph
->listeners
.filter_output_port_added
);
313 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
) {
326 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
327 graph
->listeners
.sink_input_port_added
);
329 if (!graph
->listeners
.sink_input_port_added
) {
334 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
335 graph
->listeners
.source_filter_ports_connected
);
337 if (!graph
->listeners
.source_filter_ports_connected
) {
342 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
343 graph
->listeners
.source_sink_ports_connected
);
345 if (!graph
->listeners
.source_sink_ports_connected
) {
350 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
351 graph
->listeners
.filter_filter_ports_connected
);
353 if (!graph
->listeners
.filter_filter_ports_connected
) {
358 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
359 graph
->listeners
.filter_sink_ports_connected
);
361 if (!graph
->listeners
.filter_sink_ports_connected
) {
366 graph
->interrupters
= g_ptr_array_new_with_free_func(
367 (GDestroyNotify
) bt_object_put_no_null_check
);
368 if (!graph
->interrupters
) {
369 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
373 graph
->default_interrupter
= bt_interrupter_create();
374 if (!graph
->default_interrupter
) {
375 BT_LIB_LOGE_APPEND_CAUSE(
376 "Failed to create one interrupter object.");
380 bt_graph_add_interrupter(graph
, graph
->default_interrupter
);
381 ret
= bt_object_pool_initialize(&graph
->event_msg_pool
,
382 (bt_object_pool_new_object_func
) bt_message_event_new
,
383 (bt_object_pool_destroy_object_func
) destroy_message_event
,
386 BT_LIB_LOGE_APPEND_CAUSE(
387 "Failed to initialize event message pool: ret=%d",
392 ret
= bt_object_pool_initialize(&graph
->packet_begin_msg_pool
,
393 (bt_object_pool_new_object_func
) bt_message_packet_beginning_new
,
394 (bt_object_pool_destroy_object_func
) destroy_message_packet_begin
,
397 BT_LIB_LOGE_APPEND_CAUSE(
398 "Failed to initialize packet beginning message pool: ret=%d",
403 ret
= bt_object_pool_initialize(&graph
->packet_end_msg_pool
,
404 (bt_object_pool_new_object_func
) bt_message_packet_end_new
,
405 (bt_object_pool_destroy_object_func
) destroy_message_packet_end
,
408 BT_LIB_LOGE_APPEND_CAUSE(
409 "Failed to initialize packet end message pool: ret=%d",
414 graph
->messages
= g_ptr_array_new_with_free_func(
415 (GDestroyNotify
) notify_message_graph_is_destroyed
);
416 BT_LIB_LOGI("Created graph object: %!+g", graph
);
419 return (void *) graph
;
422 BT_OBJECT_PUT_REF_AND_RESET(graph
);
426 enum bt_graph_connect_ports_status
bt_graph_connect_ports(
427 struct bt_graph
*graph
,
428 const struct bt_port_output
*upstream_port_out
,
429 const struct bt_port_input
*downstream_port_in
,
430 const struct bt_connection
**user_connection
)
432 enum bt_graph_connect_ports_status status
= BT_FUNC_STATUS_OK
;
433 enum bt_graph_listener_func_status listener_status
;
434 struct bt_connection
*connection
= NULL
;
435 struct bt_port
*upstream_port
= (void *) upstream_port_out
;
436 struct bt_port
*downstream_port
= (void *) downstream_port_in
;
437 struct bt_component
*upstream_component
= NULL
;
438 struct bt_component
*downstream_component
= NULL
;
439 enum bt_component_class_port_connected_method_status port_connected_status
;
440 bool init_can_consume
;
442 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
443 BT_ASSERT_PRE_NON_NULL(upstream_port
, "Upstream port");
444 BT_ASSERT_PRE_NON_NULL(downstream_port
, "Downstream port port");
446 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
447 "Graph is not in the \"configuring\" state: %!+g", graph
);
448 BT_ASSERT_PRE(!bt_port_is_connected(upstream_port
),
449 "Upstream port is already connected: %!+p", upstream_port
);
450 BT_ASSERT_PRE(!bt_port_is_connected(downstream_port
),
451 "Downstream port is already connected: %!+p", downstream_port
);
452 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port
),
453 "Upstream port does not belong to a component: %!+p",
455 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port
),
456 "Downstream port does not belong to a component: %!+p",
458 init_can_consume
= graph
->can_consume
;
459 BT_LIB_LOGI("Connecting component ports within graph: "
460 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
461 graph
, upstream_port
, downstream_port
);
462 bt_graph_set_can_consume(graph
, false);
463 upstream_component
= bt_port_borrow_component_inline(
464 (void *) upstream_port
);
465 downstream_component
= bt_port_borrow_component_inline(
466 (void *) downstream_port
);
468 BT_LOGD_STR("Creating connection.");
469 connection
= bt_connection_create(graph
, (void *) upstream_port
,
470 (void *) downstream_port
);
472 BT_LIB_LOGE_APPEND_CAUSE("Cannot create connection object.");
473 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
477 BT_LIB_LOGD("Connection object created: %!+x", connection
);
480 * Ownership of upstream_component/downstream_component and of
481 * the connection object is transferred to the graph.
483 g_ptr_array_add(graph
->connections
, connection
);
486 * Notify both components that their port is connected.
488 BT_LIB_LOGD("Notifying upstream component that its port is connected: "
489 "%![comp-]+c, %![port-]+p", upstream_component
, upstream_port
);
490 port_connected_status
= bt_component_port_connected(upstream_component
,
491 (void *) upstream_port
, (void *) downstream_port
);
492 if (port_connected_status
!= BT_FUNC_STATUS_OK
) {
493 if (port_connected_status
< 0) {
494 BT_LIB_LOGW_APPEND_CAUSE(
495 "Upstream component's \"port connected\" method failed: "
496 "status=%s, %![graph-]+g, %![up-comp-]+c, "
497 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
498 bt_common_func_status_string(
499 port_connected_status
),
500 graph
, upstream_component
, downstream_component
,
501 upstream_port
, downstream_port
);
504 bt_connection_end(connection
, true);
505 status
= (int) port_connected_status
;
509 connection
->notified_upstream_port_connected
= true;
510 BT_LIB_LOGD("Notifying downstream component that its port is connected: "
511 "%![comp-]+c, %![port-]+p", downstream_component
,
513 port_connected_status
= bt_component_port_connected(downstream_component
,
514 (void *) downstream_port
, (void *) upstream_port
);
515 if (port_connected_status
!= BT_FUNC_STATUS_OK
) {
516 if (port_connected_status
< 0) {
517 BT_LIB_LOGW_APPEND_CAUSE(
518 "Downstream component's \"port connected\" method failed: "
519 "status=%s, %![graph-]+g, %![up-comp-]+c, "
520 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
521 bt_common_func_status_string(
522 port_connected_status
),
523 graph
, upstream_component
, downstream_component
,
524 upstream_port
, downstream_port
);
527 bt_connection_end(connection
, true);
528 status
= (int) port_connected_status
;
532 connection
->notified_downstream_port_connected
= true;
535 * Notify the graph's creator that both ports are connected.
537 BT_LOGD_STR("Notifying graph's user that new component ports are connected.");
538 listener_status
= bt_graph_notify_ports_connected(graph
, upstream_port
, downstream_port
);
539 if (listener_status
!= BT_FUNC_STATUS_OK
) {
540 if (listener_status
< 0) {
541 BT_LIB_LOGW_APPEND_CAUSE(
542 "Graph \"ports connected\" listener failed: "
543 "status=%d, %![graph-]+g, %![up-comp-]+c, "
544 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
545 listener_status
, graph
,
546 upstream_component
, downstream_component
,
547 upstream_port
, downstream_port
);
550 status
= (int) listener_status
;
554 connection
->notified_graph_ports_connected
= true;
555 BT_LIB_LOGI("Connected component ports within graph: "
556 "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
557 "%![up-port-]+p, %![down-port-]+p",
558 graph
, upstream_component
, downstream_component
,
559 upstream_port
, downstream_port
);
561 if (user_connection
) {
562 /* Move reference to user */
563 *user_connection
= connection
;
568 if (status
!= BT_FUNC_STATUS_OK
) {
569 bt_graph_make_faulty(graph
);
572 bt_object_put_ref(connection
);
573 (void) init_can_consume
;
574 bt_graph_set_can_consume(graph
, init_can_consume
);
579 int consume_graph_sink(struct bt_component_sink
*comp
)
581 enum bt_component_class_sink_consume_method_status consume_status
;
582 struct bt_component_class_sink
*sink_class
= NULL
;
585 sink_class
= (void *) comp
->parent
.class;
586 BT_ASSERT(sink_class
->methods
.consume
);
587 BT_LIB_LOGD("Calling user's consume method: %!+c", comp
);
588 consume_status
= sink_class
->methods
.consume((void *) comp
);
589 BT_LOGD("User method returned: status=%s",
590 bt_common_func_status_string(consume_status
));
591 BT_ASSERT_POST_DEV(consume_status
== BT_FUNC_STATUS_OK
||
592 consume_status
== BT_FUNC_STATUS_END
||
593 consume_status
== BT_FUNC_STATUS_AGAIN
||
594 consume_status
== BT_FUNC_STATUS_ERROR
||
595 consume_status
== BT_FUNC_STATUS_MEMORY_ERROR
,
596 "Invalid component status returned by consuming method: "
597 "status=%s", bt_common_func_status_string(consume_status
));
598 if (consume_status
) {
599 if (consume_status
< 0) {
600 BT_LIB_LOGW_APPEND_CAUSE(
601 "Component's \"consume\" method failed: "
602 "status=%s, %![comp-]+c",
603 bt_common_func_status_string(consume_status
),
610 BT_LIB_LOGD("Consumed from sink: %![comp-]+c, status=%s",
611 comp
, bt_common_func_status_string(consume_status
));
614 return consume_status
;
618 * `node` is removed from the queue of sinks to consume when passed to
619 * this function. This function adds it back to the queue if there's
620 * still something to consume afterwards.
623 int consume_sink_node(struct bt_graph
*graph
, GList
*node
)
626 struct bt_component_sink
*sink
;
629 status
= consume_graph_sink(sink
);
630 if (G_UNLIKELY(status
!= BT_FUNC_STATUS_END
)) {
631 g_queue_push_tail_link(graph
->sinks_to_consume
, node
);
635 /* End reached, the node is not added back to the queue and free'd. */
636 g_queue_delete_link(graph
->sinks_to_consume
, node
);
638 /* Don't forward an END status if there are sinks left to consume. */
639 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
640 status
= BT_FUNC_STATUS_OK
;
645 BT_LIB_LOGD("Consumed sink node: %![comp-]+c, status=%s",
646 sink
, bt_common_func_status_string(status
));
651 int bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
652 struct bt_component_sink
*sink
)
658 BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink
);
659 BT_ASSERT(bt_component_borrow_graph((void *) sink
) == graph
);
661 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
662 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
663 status
= BT_FUNC_STATUS_END
;
667 index
= g_queue_index(graph
->sinks_to_consume
, sink
);
669 BT_LIB_LOGD("Sink component is not marked as consumable: "
670 "component sink is ended: %![comp-]+c", sink
);
671 status
= BT_FUNC_STATUS_END
;
675 sink_node
= g_queue_pop_nth_link(graph
->sinks_to_consume
, index
);
676 BT_ASSERT(sink_node
);
677 status
= consume_sink_node(graph
, sink_node
);
684 int consume_no_check(struct bt_graph
*graph
)
686 int status
= BT_FUNC_STATUS_OK
;
687 struct bt_component
*sink
;
690 BT_ASSERT_PRE_DEV(graph
->has_sink
,
691 "Graph has no sink component: %!+g", graph
);
692 BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph
);
694 if (G_UNLIKELY(g_queue_is_empty(graph
->sinks_to_consume
))) {
695 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
696 status
= BT_FUNC_STATUS_END
;
700 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
701 sink
= current_node
->data
;
702 BT_LIB_LOGD("Chose next sink to consume: %!+c", sink
);
703 status
= consume_sink_node(graph
, current_node
);
709 enum bt_graph_run_once_status
bt_graph_run_once(struct bt_graph
*graph
)
711 enum bt_graph_run_once_status status
;
713 BT_ASSERT_PRE_DEV_NON_NULL(graph
, "Graph");
714 BT_ASSERT_PRE_DEV(graph
->can_consume
,
715 "Cannot consume graph in its current state: %!+g", graph
);
716 BT_ASSERT_PRE_DEV(graph
->config_state
!=
717 BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
718 "Graph is in a faulty state: %!+g", graph
);
719 bt_graph_set_can_consume(graph
, false);
720 status
= bt_graph_configure(graph
);
721 if (G_UNLIKELY(status
)) {
722 /* bt_graph_configure() logs errors */
726 status
= consume_no_check(graph
);
727 bt_graph_set_can_consume(graph
, true);
733 enum bt_graph_run_status
bt_graph_run(struct bt_graph
*graph
)
735 enum bt_graph_run_status status
;
737 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
738 BT_ASSERT_PRE(graph
->can_consume
,
739 "Cannot consume graph in its current state: %!+g", graph
);
740 BT_ASSERT_PRE(graph
->config_state
!= BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
741 "Graph is in a faulty state: %!+g", graph
);
742 bt_graph_set_can_consume(graph
, false);
743 status
= bt_graph_configure(graph
);
744 if (G_UNLIKELY(status
)) {
745 /* bt_graph_configure() logs errors */
749 BT_LIB_LOGI("Running graph: %!+g", graph
);
753 * Check if the graph is interrupted at each iteration.
754 * If the graph was interrupted by another thread or by
755 * a signal handler, this is NOT a warning nor an error;
756 * it was intentional: log with an INFO level only.
758 if (G_UNLIKELY(bt_graph_is_interrupted(graph
))) {
759 BT_LIB_LOGI("Stopping the graph: "
760 "graph was interrupted: %!+g", graph
);
761 status
= BT_FUNC_STATUS_AGAIN
;
765 status
= consume_no_check(graph
);
766 if (G_UNLIKELY(status
== BT_FUNC_STATUS_AGAIN
)) {
768 * If AGAIN is received and there are multiple
769 * sinks, go ahead and consume from the next
772 * However, in the case where a single sink is
773 * left, the caller can decide to busy-wait and
774 * call bt_graph_run() continuously
775 * until the source is ready or it can decide to
776 * sleep for an arbitrary amount of time.
778 if (graph
->sinks_to_consume
->length
> 1) {
779 status
= BT_FUNC_STATUS_OK
;
782 } while (status
== BT_FUNC_STATUS_OK
);
784 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
785 status
= BT_FUNC_STATUS_END
;
789 BT_LIB_LOGI("Graph ran: %![graph-]+g, status=%s", graph
,
790 bt_common_func_status_string(status
));
791 bt_graph_set_can_consume(graph
, true);
795 enum bt_graph_add_listener_status
796 bt_graph_add_source_component_output_port_added_listener(
797 struct bt_graph
*graph
,
798 bt_graph_source_component_output_port_added_listener_func func
,
799 bt_graph_listener_removed_func listener_removed
, void *data
,
800 bt_listener_id
*out_listener_id
)
802 struct bt_graph_listener_port_added listener
= {
804 .removed
= listener_removed
,
807 .func
= (port_added_func_t
) func
,
809 bt_listener_id listener_id
;
811 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
812 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
813 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
814 BT_ASSERT_PRE(!graph
->in_remove_listener
,
815 "Graph currently executing a \"listener removed\" listener: "
817 g_array_append_val(graph
->listeners
.source_output_port_added
, listener
);
818 listener_id
= graph
->listeners
.source_output_port_added
->len
- 1;
819 BT_LIB_LOGD("Added \"source component output port added\" listener to graph: "
820 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
824 *out_listener_id
= listener_id
;
827 return BT_FUNC_STATUS_OK
;
830 enum bt_graph_add_listener_status
831 bt_graph_add_filter_component_output_port_added_listener(
832 struct bt_graph
*graph
,
833 bt_graph_filter_component_output_port_added_listener_func func
,
834 bt_graph_listener_removed_func listener_removed
, void *data
,
835 bt_listener_id
*out_listener_id
)
837 struct bt_graph_listener_port_added listener
= {
839 .removed
= listener_removed
,
842 .func
= (port_added_func_t
) func
,
844 bt_listener_id listener_id
;
846 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
847 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
848 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
849 BT_ASSERT_PRE(!graph
->in_remove_listener
,
850 "Graph currently executing a \"listener removed\" listener: "
852 g_array_append_val(graph
->listeners
.filter_output_port_added
, listener
);
853 listener_id
= graph
->listeners
.filter_output_port_added
->len
- 1;
854 BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: "
855 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
859 *out_listener_id
= listener_id
;
862 return BT_FUNC_STATUS_OK
;
865 enum bt_graph_add_listener_status
866 bt_graph_add_filter_component_input_port_added_listener(
867 struct bt_graph
*graph
,
868 bt_graph_filter_component_input_port_added_listener_func func
,
869 bt_graph_listener_removed_func listener_removed
, void *data
,
870 bt_listener_id
*out_listener_id
)
872 struct bt_graph_listener_port_added listener
= {
874 .removed
= listener_removed
,
877 .func
= (port_added_func_t
) func
,
879 bt_listener_id listener_id
;
881 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
882 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
883 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
884 BT_ASSERT_PRE(!graph
->in_remove_listener
,
885 "Graph currently executing a \"listener removed\" listener: "
887 g_array_append_val(graph
->listeners
.filter_input_port_added
, listener
);
888 listener_id
= graph
->listeners
.filter_input_port_added
->len
- 1;
889 BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: "
890 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
894 *out_listener_id
= listener_id
;
897 return BT_FUNC_STATUS_OK
;
900 enum bt_graph_add_listener_status
901 bt_graph_add_sink_component_input_port_added_listener(
902 struct bt_graph
*graph
,
903 bt_graph_sink_component_input_port_added_listener_func func
,
904 bt_graph_listener_removed_func listener_removed
, void *data
,
905 bt_listener_id
*out_listener_id
)
907 struct bt_graph_listener_port_added listener
= {
909 .removed
= listener_removed
,
912 .func
= (port_added_func_t
) func
,
914 bt_listener_id listener_id
;
916 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
917 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
918 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
919 BT_ASSERT_PRE(!graph
->in_remove_listener
,
920 "Graph currently executing a \"listener removed\" listener: "
922 g_array_append_val(graph
->listeners
.sink_input_port_added
, listener
);
923 listener_id
= graph
->listeners
.sink_input_port_added
->len
- 1;
924 BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: "
925 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
929 *out_listener_id
= listener_id
;
932 return BT_FUNC_STATUS_OK
;
935 enum bt_graph_add_listener_status
936 bt_graph_add_source_filter_component_ports_connected_listener(
937 struct bt_graph
*graph
,
938 bt_graph_source_filter_component_ports_connected_listener_func func
,
939 bt_graph_listener_removed_func listener_removed
, void *data
,
940 bt_listener_id
*out_listener_id
)
942 struct bt_graph_listener_ports_connected listener
= {
944 .removed
= listener_removed
,
947 .func
= (ports_connected_func_t
) func
,
949 bt_listener_id listener_id
;
951 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
952 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
953 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
954 BT_ASSERT_PRE(!graph
->in_remove_listener
,
955 "Graph currently executing a \"listener removed\" listener: "
957 g_array_append_val(graph
->listeners
.source_filter_ports_connected
,
959 listener_id
= graph
->listeners
.source_filter_ports_connected
->len
- 1;
960 BT_LIB_LOGD("Added \"source to filter component ports connected\" listener to graph: "
961 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
965 *out_listener_id
= listener_id
;
968 return BT_FUNC_STATUS_OK
;
971 enum bt_graph_add_listener_status
972 bt_graph_add_source_sink_component_ports_connected_listener(
973 struct bt_graph
*graph
,
974 bt_graph_source_sink_component_ports_connected_listener_func func
,
975 bt_graph_listener_removed_func listener_removed
, void *data
,
976 bt_listener_id
*out_listener_id
)
978 struct bt_graph_listener_ports_connected listener
= {
980 .removed
= listener_removed
,
983 .func
= (ports_connected_func_t
) func
,
985 bt_listener_id listener_id
;
987 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
988 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
989 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
990 BT_ASSERT_PRE(!graph
->in_remove_listener
,
991 "Graph currently executing a \"listener removed\" listener: "
993 g_array_append_val(graph
->listeners
.source_sink_ports_connected
,
995 listener_id
= graph
->listeners
.source_sink_ports_connected
->len
- 1;
996 BT_LIB_LOGD("Added \"source to sink component ports connected\" listener to graph: "
997 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1001 *out_listener_id
= listener_id
;
1004 return BT_FUNC_STATUS_OK
;
1007 enum bt_graph_add_listener_status
1008 bt_graph_add_filter_filter_component_ports_connected_listener(
1009 struct bt_graph
*graph
,
1010 bt_graph_filter_filter_component_ports_connected_listener_func func
,
1011 bt_graph_listener_removed_func listener_removed
, void *data
,
1012 bt_listener_id
*out_listener_id
)
1014 struct bt_graph_listener_ports_connected listener
= {
1016 .removed
= listener_removed
,
1019 .func
= (ports_connected_func_t
) func
,
1021 bt_listener_id listener_id
;
1023 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1024 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1025 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1026 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1027 "Graph currently executing a \"listener removed\" listener: "
1029 g_array_append_val(graph
->listeners
.filter_filter_ports_connected
,
1031 listener_id
= graph
->listeners
.filter_filter_ports_connected
->len
- 1;
1032 BT_LIB_LOGD("Added \"filter to filter component ports connected\" listener to graph: "
1033 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1037 *out_listener_id
= listener_id
;
1040 return BT_FUNC_STATUS_OK
;
1043 enum bt_graph_add_listener_status
1044 bt_graph_add_filter_sink_component_ports_connected_listener(
1045 struct bt_graph
*graph
,
1046 bt_graph_filter_sink_component_ports_connected_listener_func func
,
1047 bt_graph_listener_removed_func listener_removed
, void *data
,
1048 bt_listener_id
*out_listener_id
)
1050 struct bt_graph_listener_ports_connected listener
= {
1052 .removed
= listener_removed
,
1055 .func
= (ports_connected_func_t
) func
,
1057 bt_listener_id listener_id
;
1059 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1060 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1061 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1062 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1063 "Graph currently executing a \"listener removed\" listener: "
1065 g_array_append_val(graph
->listeners
.filter_sink_ports_connected
,
1067 listener_id
= graph
->listeners
.filter_sink_ports_connected
->len
- 1;
1068 BT_LIB_LOGD("Added \"filter to sink component ports connected\" listener to graph: "
1069 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1073 *out_listener_id
= listener_id
;
1076 return BT_FUNC_STATUS_OK
;
1080 enum bt_graph_listener_func_status
bt_graph_notify_port_added(
1081 struct bt_graph
*graph
, struct bt_port
*port
)
1085 struct bt_component
*comp
;
1086 enum bt_graph_listener_func_status status
= BT_FUNC_STATUS_OK
;
1090 BT_LIB_LOGD("Notifying graph listeners that a port was added: "
1091 "%![graph-]+g, %![port-]+p", graph
, port
);
1092 comp
= bt_port_borrow_component_inline(port
);
1095 switch (comp
->class->type
) {
1096 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1098 switch (port
->type
) {
1099 case BT_PORT_TYPE_OUTPUT
:
1100 listeners
= graph
->listeners
.source_output_port_added
;
1108 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1110 switch (port
->type
) {
1111 case BT_PORT_TYPE_INPUT
:
1112 listeners
= graph
->listeners
.filter_input_port_added
;
1114 case BT_PORT_TYPE_OUTPUT
:
1115 listeners
= graph
->listeners
.filter_output_port_added
;
1123 case BT_COMPONENT_CLASS_TYPE_SINK
:
1125 switch (port
->type
) {
1126 case BT_PORT_TYPE_INPUT
:
1127 listeners
= graph
->listeners
.sink_input_port_added
;
1139 for (i
= 0; i
< listeners
->len
; i
++) {
1140 struct bt_graph_listener_port_added
*listener
=
1141 &g_array_index(listeners
,
1142 struct bt_graph_listener_port_added
, i
);
1145 BT_ASSERT(listener
->func
);
1146 status
= listener
->func(comp
, port
, listener
->base
.data
);
1147 if (status
!= BT_FUNC_STATUS_OK
) {
1157 enum bt_graph_listener_func_status
bt_graph_notify_ports_connected(
1158 struct bt_graph
*graph
, struct bt_port
*upstream_port
,
1159 struct bt_port
*downstream_port
)
1163 struct bt_component
*upstream_comp
;
1164 struct bt_component
*downstream_comp
;
1165 enum bt_graph_listener_func_status status
= BT_FUNC_STATUS_OK
;
1168 BT_ASSERT(upstream_port
);
1169 BT_ASSERT(downstream_port
);
1170 BT_LIB_LOGD("Notifying graph listeners that ports were connected: "
1171 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
1172 graph
, upstream_port
, downstream_port
);
1173 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
1174 BT_ASSERT(upstream_comp
);
1175 downstream_comp
= bt_port_borrow_component_inline(downstream_port
);
1176 BT_ASSERT(downstream_comp
);
1178 switch (upstream_comp
->class->type
) {
1179 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1181 switch (downstream_comp
->class->type
) {
1182 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1184 graph
->listeners
.source_filter_ports_connected
;
1186 case BT_COMPONENT_CLASS_TYPE_SINK
:
1188 graph
->listeners
.source_sink_ports_connected
;
1196 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1198 switch (downstream_comp
->class->type
) {
1199 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1201 graph
->listeners
.filter_filter_ports_connected
;
1203 case BT_COMPONENT_CLASS_TYPE_SINK
:
1205 graph
->listeners
.filter_sink_ports_connected
;
1217 for (i
= 0; i
< listeners
->len
; i
++) {
1218 struct bt_graph_listener_ports_connected
*listener
=
1219 &g_array_index(listeners
,
1220 struct bt_graph_listener_ports_connected
, i
);
1222 BT_ASSERT(listener
->func
);
1223 status
= listener
->func(upstream_comp
, downstream_comp
,
1224 upstream_port
, downstream_port
, listener
->base
.data
);
1225 if (status
!= BT_FUNC_STATUS_OK
) {
1235 void bt_graph_remove_connection(struct bt_graph
*graph
,
1236 struct bt_connection
*connection
)
1239 BT_ASSERT(connection
);
1240 BT_LIB_LOGD("Removing graph's connection: %![graph-]+g, %![conn-]+x",
1242 g_ptr_array_remove(graph
->connections
, connection
);
1246 bool component_name_exists(struct bt_graph
*graph
, const char *name
)
1248 bool exists
= false;
1251 for (i
= 0; i
< graph
->components
->len
; i
++) {
1252 struct bt_component
*other_comp
= graph
->components
->pdata
[i
];
1254 if (strcmp(name
, bt_component_get_name(other_comp
)) == 0) {
1255 BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: "
1256 "%![other-comp-]+c, name=\"%s\"",
1268 int add_component_with_init_method_data(
1269 struct bt_graph
*graph
,
1270 struct bt_component_class
*comp_cls
,
1271 comp_init_method_t init_method
,
1272 const char *name
, const struct bt_value
*params
,
1273 void *init_method_data
, bt_logging_level log_level
,
1274 const struct bt_component
**user_component
)
1276 int status
= BT_FUNC_STATUS_OK
;
1277 enum bt_component_class_init_method_status init_status
;
1278 struct bt_component
*component
= NULL
;
1280 bool init_can_consume
;
1281 struct bt_value
*new_params
= NULL
;
1283 BT_ASSERT(comp_cls
);
1284 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1285 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1287 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1288 "Graph is not in the \"configuring\" state: %!+g", graph
);
1289 BT_ASSERT_PRE(!component_name_exists(graph
, name
),
1290 "Duplicate component name: %!+g, name=\"%s\"", graph
, name
);
1291 BT_ASSERT_PRE(!params
|| bt_value_is_map(params
),
1292 "Parameter value is not a map value: %!+v", params
);
1293 init_can_consume
= graph
->can_consume
;
1294 bt_graph_set_can_consume(graph
, false);
1295 BT_LIB_LOGI("Adding component to graph: "
1296 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1297 "%![params-]+v, init-method-data-addr=%p",
1298 graph
, comp_cls
, name
,
1299 bt_common_logging_level_string(log_level
), params
,
1303 new_params
= bt_value_map_create();
1305 BT_LIB_LOGE_APPEND_CAUSE(
1306 "Cannot create empty map value object.");
1307 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1311 params
= new_params
;
1314 ret
= bt_component_create(comp_cls
, name
, log_level
, &component
);
1316 BT_LIB_LOGE_APPEND_CAUSE(
1317 "Cannot create empty component object: ret=%d",
1319 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1324 * The user's initialization method needs to see that this
1325 * component is part of the graph. If the user method fails, we
1326 * immediately remove the component from the graph's components.
1328 g_ptr_array_add(graph
->components
, component
);
1329 bt_component_set_graph(component
, graph
);
1330 bt_value_freeze(params
);
1334 * There is no use for config objects right now, so just pass
1337 BT_LOGD_STR("Calling user's initialization method.");
1338 init_status
= init_method(component
, NULL
, params
, init_method_data
);
1339 BT_LOGD("User method returned: status=%s",
1340 bt_common_func_status_string(init_status
));
1341 if (init_status
!= BT_FUNC_STATUS_OK
) {
1342 if (init_status
< 0) {
1343 BT_LIB_LOGW_APPEND_CAUSE(
1344 "Component initialization method failed: "
1345 "status=%s, %![comp-]+c",
1346 bt_common_func_status_string(init_status
),
1350 status
= init_status
;
1351 bt_component_set_graph(component
, NULL
);
1352 g_ptr_array_remove_fast(graph
->components
, component
);
1358 * Mark the component as initialized so that its finalization
1359 * method is called when it is destroyed.
1361 component
->initialized
= true;
1364 * If it's a sink component, it needs to be part of the graph's
1365 * sink queue to be consumed by bt_graph_run() or
1366 * bt_graph_run_once().
1368 if (bt_component_is_sink(component
)) {
1369 graph
->has_sink
= true;
1370 g_queue_push_tail(graph
->sinks_to_consume
, component
);
1374 * Freeze the component class now that it's instantiated at
1377 BT_LOGD_STR("Freezing component class.");
1378 bt_component_class_freeze(comp_cls
);
1379 BT_LIB_LOGI("Added component to graph: "
1380 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1381 "%![params-]+v, init-method-data-addr=%p, %![comp-]+c",
1382 graph
, comp_cls
, name
,
1383 bt_common_logging_level_string(log_level
), params
,
1384 init_method_data
, component
);
1386 if (user_component
) {
1387 /* Move reference to user */
1388 *user_component
= component
;
1393 if (status
!= BT_FUNC_STATUS_OK
) {
1394 bt_graph_make_faulty(graph
);
1397 bt_object_put_ref(component
);
1398 bt_object_put_ref(new_params
);
1399 (void) init_can_consume
;
1400 bt_graph_set_can_consume(graph
, init_can_consume
);
1404 enum bt_graph_add_component_status
1405 bt_graph_add_source_component_with_init_method_data(
1406 struct bt_graph
*graph
,
1407 const struct bt_component_class_source
*comp_cls
,
1408 const char *name
, const struct bt_value
*params
,
1409 void *init_method_data
, bt_logging_level log_level
,
1410 const struct bt_component_source
**component
)
1412 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1413 return add_component_with_init_method_data(graph
,
1414 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1415 name
, params
, init_method_data
, log_level
, (void *) component
);
1418 enum bt_graph_add_component_status
bt_graph_add_source_component(
1419 struct bt_graph
*graph
,
1420 const struct bt_component_class_source
*comp_cls
,
1421 const char *name
, const struct bt_value
*params
,
1422 enum bt_logging_level log_level
,
1423 const struct bt_component_source
**component
)
1425 return bt_graph_add_source_component_with_init_method_data(
1426 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1429 enum bt_graph_add_component_status
1430 bt_graph_add_filter_component_with_init_method_data(
1431 struct bt_graph
*graph
,
1432 const struct bt_component_class_filter
*comp_cls
,
1433 const char *name
, const struct bt_value
*params
,
1434 void *init_method_data
, enum bt_logging_level log_level
,
1435 const struct bt_component_filter
**component
)
1437 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1438 return add_component_with_init_method_data(graph
,
1439 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1440 name
, params
, init_method_data
, log_level
, (void *) component
);
1443 enum bt_graph_add_component_status
bt_graph_add_filter_component(
1444 struct bt_graph
*graph
,
1445 const struct bt_component_class_filter
*comp_cls
,
1446 const char *name
, const struct bt_value
*params
,
1447 enum bt_logging_level log_level
,
1448 const struct bt_component_filter
**component
)
1450 return bt_graph_add_filter_component_with_init_method_data(
1451 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1454 enum bt_graph_add_component_status
1455 bt_graph_add_sink_component_with_init_method_data(
1456 struct bt_graph
*graph
,
1457 const struct bt_component_class_sink
*comp_cls
,
1458 const char *name
, const struct bt_value
*params
,
1459 void *init_method_data
, enum bt_logging_level log_level
,
1460 const struct bt_component_sink
**component
)
1462 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1463 return add_component_with_init_method_data(graph
,
1464 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1465 name
, params
, init_method_data
, log_level
, (void *) component
);
1468 enum bt_graph_add_component_status
bt_graph_add_sink_component(
1469 struct bt_graph
*graph
,
1470 const struct bt_component_class_sink
*comp_cls
,
1471 const char *name
, const struct bt_value
*params
,
1472 enum bt_logging_level log_level
,
1473 const struct bt_component_sink
**component
)
1475 return bt_graph_add_sink_component_with_init_method_data(
1476 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1479 enum bt_graph_add_component_status
1480 bt_graph_add_simple_sink_component(struct bt_graph
*graph
, const char *name
,
1481 bt_graph_simple_sink_component_init_func init_func
,
1482 bt_graph_simple_sink_component_consume_func consume_func
,
1483 bt_graph_simple_sink_component_finalize_func finalize_func
,
1484 void *user_data
, const bt_component_sink
**component
)
1486 enum bt_graph_add_component_status status
;
1487 struct bt_component_class_sink
*comp_cls
;
1488 struct simple_sink_init_method_data init_method_data
= {
1489 .init_func
= init_func
,
1490 .consume_func
= consume_func
,
1491 .finalize_func
= finalize_func
,
1492 .user_data
= user_data
,
1496 * Other preconditions are checked by
1497 * bt_graph_add_sink_component_with_init_method_data().
1499 BT_ASSERT_PRE_NON_NULL(consume_func
, "Consume function");
1501 comp_cls
= bt_component_class_sink_simple_borrow();
1503 BT_LIB_LOGE_APPEND_CAUSE(
1504 "Cannot borrow simple sink component class.");
1505 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1509 status
= bt_graph_add_sink_component_with_init_method_data(graph
,
1510 comp_cls
, name
, NULL
, &init_method_data
,
1511 BT_LOGGING_LEVEL_NONE
, component
);
1518 int bt_graph_remove_unconnected_component(struct bt_graph
*graph
,
1519 struct bt_component
*component
)
1521 bool init_can_consume
;
1527 BT_ASSERT(component
);
1528 BT_ASSERT(component
->base
.ref_count
== 0);
1529 BT_ASSERT(bt_component_borrow_graph(component
) == graph
);
1531 init_can_consume
= graph
->can_consume
;
1532 count
= bt_component_get_input_port_count(component
);
1534 for (i
= 0; i
< count
; i
++) {
1535 struct bt_port
*port
= (void *)
1536 bt_component_borrow_input_port_by_index(component
, i
);
1540 if (bt_port_is_connected(port
)) {
1541 BT_LIB_LOGW_APPEND_CAUSE(
1542 "Cannot remove component from graph: "
1543 "an input port is connected: "
1544 "%![graph-]+g, %![comp-]+c, %![port-]+p",
1545 graph
, component
, port
);
1550 count
= bt_component_get_output_port_count(component
);
1552 for (i
= 0; i
< count
; i
++) {
1553 struct bt_port
*port
= (void *)
1554 bt_component_borrow_output_port_by_index(component
, i
);
1558 if (bt_port_is_connected(port
)) {
1559 BT_LIB_LOGW_APPEND_CAUSE(
1560 "Cannot remove component from graph: "
1561 "an output port is connected: "
1562 "%![graph-]+g, %![comp-]+c, %![port-]+p",
1563 graph
, component
, port
);
1568 bt_graph_set_can_consume(graph
, false);
1570 /* Possibly remove from sinks to consume */
1571 (void) g_queue_remove(graph
->sinks_to_consume
, component
);
1573 if (graph
->sinks_to_consume
->length
== 0) {
1574 graph
->has_sink
= false;
1578 * This calls bt_object_try_spec_release() on the component, and
1579 * since its reference count is 0, its destructor is called. Its
1580 * destructor calls the user's finalization method (if set).
1582 g_ptr_array_remove(graph
->components
, component
);
1589 (void) init_can_consume
;
1590 bt_graph_set_can_consume(graph
, init_can_consume
);
1595 void bt_graph_add_message(struct bt_graph
*graph
,
1596 struct bt_message
*msg
)
1602 * It's okay not to take a reference because, when a
1603 * message's reference count drops to 0, either:
1605 * * It is recycled back to one of this graph's pool.
1606 * * It is destroyed because it doesn't have any link to any
1607 * graph, which means the original graph is already destroyed.
1609 g_ptr_array_add(graph
->messages
, msg
);
1613 bool bt_graph_is_interrupted(const struct bt_graph
*graph
)
1616 return bt_interrupter_array_any_is_set(graph
->interrupters
);
1619 enum bt_graph_add_interrupter_status
bt_graph_add_interrupter(
1620 struct bt_graph
*graph
, const struct bt_interrupter
*intr
)
1622 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1623 BT_ASSERT_PRE_NON_NULL(intr
, "Interrupter");
1624 g_ptr_array_add(graph
->interrupters
, (void *) intr
);
1625 bt_object_get_no_null_check(intr
);
1626 BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z",
1628 return BT_FUNC_STATUS_OK
;
1631 void bt_graph_interrupt(struct bt_graph
*graph
)
1633 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1634 bt_interrupter_set(graph
->default_interrupter
);
1635 BT_LIB_LOGI("Interrupted graph: %!+g", graph
);
1638 void bt_graph_get_ref(const struct bt_graph
*graph
)
1640 bt_object_get_ref(graph
);
1643 void bt_graph_put_ref(const struct bt_graph
*graph
)
1645 bt_object_put_ref(graph
);