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.h"
46 #include "component-sink.h"
47 #include "connection.h"
49 #include "message/event.h"
50 #include "message/packet.h"
52 typedef enum bt_graph_listener_status (*port_added_func_t
)(
53 const void *, const void *, void *);
55 typedef enum bt_graph_listener_status (*ports_connected_func_t
)(
56 const void *, const void *, const void *, const void *, void *);
58 typedef enum bt_self_component_status (*comp_init_method_t
)(const void *,
59 const void *, void *);
61 struct bt_graph_listener
{
62 bt_graph_listener_removed_func removed
;
66 struct bt_graph_listener_port_added
{
67 struct bt_graph_listener base
;
68 port_added_func_t func
;
71 struct bt_graph_listener_ports_connected
{
72 struct bt_graph_listener base
;
73 ports_connected_func_t func
;
76 #define INIT_LISTENERS_ARRAY(_type, _listeners) \
78 _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \
79 if (!(_listeners)) { \
80 BT_LOGE_STR("Failed to allocate one GArray."); \
84 #define CALL_REMOVE_LISTENERS(_type, _listeners) \
91 for (i = 0; i < (_listeners)->len; i++) { \
93 &g_array_index((_listeners), _type, i); \
95 if (listener->base.removed) { \
96 listener->base.removed(listener->base.data); \
102 void destroy_graph(struct bt_object
*obj
)
104 struct bt_graph
*graph
= container_of(obj
, struct bt_graph
, base
);
107 * The graph's reference count is 0 if we're here. Increment
108 * it to avoid a double-destroy (possibly infinitely recursive)
111 * 1. We put and destroy a connection.
112 * 2. This connection's destructor finalizes its active message
114 * 3. A message iterator's finalization function gets a new
115 * reference on its component (reference count goes from 0 to
117 * 4. Since this component's reference count goes to 1, it takes
118 * a reference on its parent (this graph). This graph's
119 * reference count goes from 0 to 1.
120 * 5. The message iterator's finalization function puts its
121 * component reference (reference count goes from 1 to 0).
122 * 6. Since this component's reference count goes from 1 to 0,
123 * it puts its parent (this graph). This graph's reference
124 * count goes from 1 to 0.
125 * 7. Since this graph's reference count goes from 1 to 0, its
126 * destructor is called (this function).
128 * With the incrementation below, the graph's reference count at
129 * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This
130 * ensures that this function is not called two times.
132 BT_LIB_LOGI("Destroying graph: %!+g", graph
);
136 * Cancel the graph to disallow some operations, like creating
137 * message iterators and adding ports to components.
139 (void) bt_graph_cancel((void *) graph
);
141 /* Call all remove listeners */
142 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
143 graph
->listeners
.source_output_port_added
);
144 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
145 graph
->listeners
.filter_output_port_added
);
146 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
147 graph
->listeners
.filter_input_port_added
);
148 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
149 graph
->listeners
.sink_input_port_added
);
150 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
151 graph
->listeners
.source_filter_ports_connected
);
152 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
153 graph
->listeners
.filter_filter_ports_connected
);
154 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
155 graph
->listeners
.source_sink_ports_connected
);
156 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
157 graph
->listeners
.filter_sink_ports_connected
);
159 if (graph
->messages
) {
160 g_ptr_array_free(graph
->messages
, TRUE
);
161 graph
->messages
= NULL
;
164 if (graph
->connections
) {
165 BT_LOGD_STR("Destroying connections.");
166 g_ptr_array_free(graph
->connections
, TRUE
);
167 graph
->connections
= NULL
;
170 if (graph
->components
) {
171 BT_LOGD_STR("Destroying components.");
172 g_ptr_array_free(graph
->components
, TRUE
);
173 graph
->components
= NULL
;
176 if (graph
->sinks_to_consume
) {
177 g_queue_free(graph
->sinks_to_consume
);
178 graph
->sinks_to_consume
= NULL
;
181 if (graph
->listeners
.source_output_port_added
) {
182 g_array_free(graph
->listeners
.source_output_port_added
, TRUE
);
183 graph
->listeners
.source_output_port_added
= NULL
;
186 if (graph
->listeners
.filter_output_port_added
) {
187 g_array_free(graph
->listeners
.filter_output_port_added
, TRUE
);
188 graph
->listeners
.filter_output_port_added
= NULL
;
191 if (graph
->listeners
.filter_input_port_added
) {
192 g_array_free(graph
->listeners
.filter_input_port_added
, TRUE
);
193 graph
->listeners
.filter_input_port_added
= NULL
;
196 if (graph
->listeners
.sink_input_port_added
) {
197 g_array_free(graph
->listeners
.sink_input_port_added
, TRUE
);
198 graph
->listeners
.sink_input_port_added
= NULL
;
201 if (graph
->listeners
.source_filter_ports_connected
) {
202 g_array_free(graph
->listeners
.source_filter_ports_connected
,
204 graph
->listeners
.source_filter_ports_connected
= NULL
;
207 if (graph
->listeners
.filter_filter_ports_connected
) {
208 g_array_free(graph
->listeners
.filter_filter_ports_connected
,
210 graph
->listeners
.filter_filter_ports_connected
= NULL
;
213 if (graph
->listeners
.source_sink_ports_connected
) {
214 g_array_free(graph
->listeners
.source_sink_ports_connected
,
216 graph
->listeners
.source_sink_ports_connected
= NULL
;
219 if (graph
->listeners
.filter_sink_ports_connected
) {
220 g_array_free(graph
->listeners
.filter_sink_ports_connected
,
222 graph
->listeners
.filter_sink_ports_connected
= NULL
;
225 bt_object_pool_finalize(&graph
->event_msg_pool
);
226 bt_object_pool_finalize(&graph
->packet_begin_msg_pool
);
227 bt_object_pool_finalize(&graph
->packet_end_msg_pool
);
232 void destroy_message_event(struct bt_message
*msg
,
233 struct bt_graph
*graph
)
235 bt_message_event_destroy(msg
);
239 void destroy_message_packet_begin(struct bt_message
*msg
,
240 struct bt_graph
*graph
)
242 bt_message_packet_destroy(msg
);
246 void destroy_message_packet_end(struct bt_message
*msg
,
247 struct bt_graph
*graph
)
249 bt_message_packet_destroy(msg
);
253 void notify_message_graph_is_destroyed(struct bt_message
*msg
)
255 bt_message_unlink_graph(msg
);
258 struct bt_graph
*bt_graph_create(void)
260 struct bt_graph
*graph
;
263 BT_LOGI_STR("Creating graph object.");
264 graph
= g_new0(struct bt_graph
, 1);
266 BT_LOGE_STR("Failed to allocate one graph.");
270 bt_object_init_shared(&graph
->base
, destroy_graph
);
271 graph
->connections
= g_ptr_array_new_with_free_func(
272 (GDestroyNotify
) bt_object_try_spec_release
);
273 if (!graph
->connections
) {
274 BT_LOGE_STR("Failed to allocate one GPtrArray.");
277 graph
->components
= g_ptr_array_new_with_free_func(
278 (GDestroyNotify
) bt_object_try_spec_release
);
279 if (!graph
->components
) {
280 BT_LOGE_STR("Failed to allocate one GPtrArray.");
283 graph
->sinks_to_consume
= g_queue_new();
284 if (!graph
->sinks_to_consume
) {
285 BT_LOGE_STR("Failed to allocate one GQueue.");
289 bt_graph_set_can_consume(graph
, true);
290 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
291 graph
->listeners
.source_output_port_added
);
293 if (!graph
->listeners
.source_output_port_added
) {
298 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
299 graph
->listeners
.filter_output_port_added
);
301 if (!graph
->listeners
.filter_output_port_added
) {
306 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
307 graph
->listeners
.filter_input_port_added
);
309 if (!graph
->listeners
.filter_input_port_added
) {
314 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
315 graph
->listeners
.sink_input_port_added
);
317 if (!graph
->listeners
.sink_input_port_added
) {
322 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
323 graph
->listeners
.source_filter_ports_connected
);
325 if (!graph
->listeners
.source_filter_ports_connected
) {
330 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
331 graph
->listeners
.source_sink_ports_connected
);
333 if (!graph
->listeners
.source_sink_ports_connected
) {
338 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
339 graph
->listeners
.filter_filter_ports_connected
);
341 if (!graph
->listeners
.filter_filter_ports_connected
) {
346 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
347 graph
->listeners
.filter_sink_ports_connected
);
349 if (!graph
->listeners
.filter_sink_ports_connected
) {
354 ret
= bt_object_pool_initialize(&graph
->event_msg_pool
,
355 (bt_object_pool_new_object_func
) bt_message_event_new
,
356 (bt_object_pool_destroy_object_func
) destroy_message_event
,
359 BT_LOGE("Failed to initialize event message pool: ret=%d",
364 ret
= bt_object_pool_initialize(&graph
->packet_begin_msg_pool
,
365 (bt_object_pool_new_object_func
) bt_message_packet_beginning_new
,
366 (bt_object_pool_destroy_object_func
) destroy_message_packet_begin
,
369 BT_LOGE("Failed to initialize packet beginning message pool: ret=%d",
374 ret
= bt_object_pool_initialize(&graph
->packet_end_msg_pool
,
375 (bt_object_pool_new_object_func
) bt_message_packet_end_new
,
376 (bt_object_pool_destroy_object_func
) destroy_message_packet_end
,
379 BT_LOGE("Failed to initialize packet end message pool: ret=%d",
384 graph
->messages
= g_ptr_array_new_with_free_func(
385 (GDestroyNotify
) notify_message_graph_is_destroyed
);
386 BT_LIB_LOGI("Created graph object: %!+g", graph
);
389 return (void *) graph
;
392 BT_OBJECT_PUT_REF_AND_RESET(graph
);
396 enum bt_graph_status
bt_graph_connect_ports(
397 struct bt_graph
*graph
,
398 const struct bt_port_output
*upstream_port_out
,
399 const struct bt_port_input
*downstream_port_in
,
400 const struct bt_connection
**user_connection
)
402 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
403 enum bt_graph_listener_status listener_status
;
404 struct bt_connection
*connection
= NULL
;
405 struct bt_port
*upstream_port
= (void *) upstream_port_out
;
406 struct bt_port
*downstream_port
= (void *) downstream_port_in
;
407 struct bt_component
*upstream_component
= NULL
;
408 struct bt_component
*downstream_component
= NULL
;
409 enum bt_self_component_status component_status
;
410 bool init_can_consume
;
412 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
413 BT_ASSERT_PRE_NON_NULL(upstream_port
, "Upstream port");
414 BT_ASSERT_PRE_NON_NULL(downstream_port
, "Downstream port port");
415 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
417 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
418 "Graph is not in the \"configuring\" state: %!+g", graph
);
419 BT_ASSERT_PRE(!bt_port_is_connected(upstream_port
),
420 "Upstream port is already connected: %!+p", upstream_port
);
421 BT_ASSERT_PRE(!bt_port_is_connected(downstream_port
),
422 "Downstream port is already connected: %!+p", downstream_port
);
423 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port
),
424 "Upstream port does not belong to a component: %!+p",
426 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port
),
427 "Downstream port does not belong to a component: %!+p",
429 init_can_consume
= graph
->can_consume
;
430 BT_LIB_LOGI("Connecting component ports within graph: "
431 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
432 graph
, upstream_port
, downstream_port
);
433 bt_graph_set_can_consume(graph
, false);
434 upstream_component
= bt_port_borrow_component_inline(
435 (void *) upstream_port
);
436 downstream_component
= bt_port_borrow_component_inline(
437 (void *) downstream_port
);
439 BT_LOGD_STR("Creating connection.");
440 connection
= bt_connection_create(graph
, (void *) upstream_port
,
441 (void *) downstream_port
);
443 BT_LOGW("Cannot create connection object.");
444 status
= BT_GRAPH_STATUS_NOMEM
;
448 BT_LIB_LOGD("Connection object created: %!+x", connection
);
451 * Ownership of upstream_component/downstream_component and of
452 * the connection object is transferred to the graph.
454 g_ptr_array_add(graph
->connections
, connection
);
457 * Notify both components that their port is connected.
459 BT_LIB_LOGD("Notifying upstream component that its port is connected: "
460 "%![comp-]+c, %![port-]+p", upstream_component
, upstream_port
);
461 component_status
= bt_component_port_connected(upstream_component
,
462 (void *) upstream_port
, (void *) downstream_port
);
463 if (component_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
464 BT_LIB_LOGW("Error while notifying upstream component that its port is connected: "
465 "status=%s, %![graph-]+g, %![up-comp-]+c, "
466 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
467 bt_self_component_status_string(component_status
),
468 graph
, upstream_component
, downstream_component
,
469 upstream_port
, downstream_port
);
470 bt_connection_end(connection
, true);
471 status
= (int) component_status
;
475 connection
->notified_upstream_port_connected
= true;
476 BT_LIB_LOGD("Notifying downstream component that its port is connected: "
477 "%![comp-]+c, %![port-]+p", downstream_component
,
479 component_status
= bt_component_port_connected(downstream_component
,
480 (void *) downstream_port
, (void *) upstream_port
);
481 if (component_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
482 BT_LIB_LOGW("Error while notifying downstream component that its port is connected: "
483 "status=%s, %![graph-]+g, %![up-comp-]+c, "
484 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
485 bt_self_component_status_string(component_status
),
486 graph
, upstream_component
, downstream_component
,
487 upstream_port
, downstream_port
);
488 bt_connection_end(connection
, true);
489 status
= (int) component_status
;
493 connection
->notified_downstream_port_connected
= true;
496 * Notify the graph's creator that both ports are connected.
498 BT_LOGD_STR("Notifying graph's user that new component ports are connected.");
499 listener_status
= bt_graph_notify_ports_connected(graph
, upstream_port
, downstream_port
);
500 if (listener_status
!= BT_GRAPH_LISTENER_STATUS_OK
) {
501 status
= (int) listener_status
;
505 connection
->notified_graph_ports_connected
= true;
506 BT_LIB_LOGI("Connected component ports within graph: "
507 "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
508 "%![up-port-]+p, %![down-port-]+p",
509 graph
, upstream_component
, downstream_component
,
510 upstream_port
, downstream_port
);
512 if (user_connection
) {
513 /* Move reference to user */
514 *user_connection
= connection
;
519 if (status
!= BT_GRAPH_STATUS_OK
) {
520 bt_graph_make_faulty(graph
);
523 bt_object_put_ref(connection
);
524 (void) init_can_consume
;
525 bt_graph_set_can_consume(graph
, init_can_consume
);
530 enum bt_graph_status
consume_graph_sink(struct bt_component_sink
*comp
)
532 enum bt_self_component_status comp_status
;
533 struct bt_component_class_sink
*sink_class
= NULL
;
536 sink_class
= (void *) comp
->parent
.class;
537 BT_ASSERT(sink_class
->methods
.consume
);
538 BT_LIB_LOGD("Calling user's consume method: %!+c", comp
);
539 comp_status
= sink_class
->methods
.consume((void *) comp
);
540 BT_LOGD("User method returned: status=%s",
541 bt_self_component_status_string(comp_status
));
542 BT_ASSERT_POST(comp_status
== BT_SELF_COMPONENT_STATUS_OK
||
543 comp_status
== BT_SELF_COMPONENT_STATUS_END
||
544 comp_status
== BT_SELF_COMPONENT_STATUS_AGAIN
||
545 comp_status
== BT_SELF_COMPONENT_STATUS_ERROR
||
546 comp_status
== BT_SELF_COMPONENT_STATUS_NOMEM
,
547 "Invalid component status returned by consuming method: "
548 "status=%s", bt_self_component_status_string(comp_status
));
549 if (comp_status
< 0) {
550 BT_LOGW_STR("Consume method failed.");
554 BT_LIB_LOGD("Consumed from sink: %![comp-]+c, status=%s",
555 comp
, bt_self_component_status_string(comp_status
));
558 return (int) comp_status
;
562 * `node` is removed from the queue of sinks to consume when passed to
563 * this function. This function adds it back to the queue if there's
564 * still something to consume afterwards.
567 enum bt_graph_status
consume_sink_node(struct bt_graph
*graph
, GList
*node
)
569 enum bt_graph_status status
;
570 struct bt_component_sink
*sink
;
573 status
= consume_graph_sink(sink
);
574 if (G_UNLIKELY(status
!= BT_GRAPH_STATUS_END
)) {
575 g_queue_push_tail_link(graph
->sinks_to_consume
, node
);
579 /* End reached, the node is not added back to the queue and free'd. */
580 g_queue_delete_link(graph
->sinks_to_consume
, node
);
582 /* Don't forward an END status if there are sinks left to consume. */
583 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
584 status
= BT_GRAPH_STATUS_OK
;
589 BT_LIB_LOGD("Consumed sink node: %![comp-]+c, status=%s",
590 sink
, bt_graph_status_string(status
));
595 enum bt_graph_status
bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
596 struct bt_component_sink
*sink
)
598 enum bt_graph_status status
;
602 BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink
);
603 BT_ASSERT(bt_component_borrow_graph((void *) sink
) == graph
);
605 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
606 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
607 status
= BT_GRAPH_STATUS_END
;
611 index
= g_queue_index(graph
->sinks_to_consume
, sink
);
613 BT_LIB_LOGD("Sink component is not marked as consumable: "
614 "component sink is ended: %![comp-]+c", sink
);
615 status
= BT_GRAPH_STATUS_END
;
619 sink_node
= g_queue_pop_nth_link(graph
->sinks_to_consume
, index
);
620 BT_ASSERT(sink_node
);
621 status
= consume_sink_node(graph
, sink_node
);
628 enum bt_graph_status
consume_no_check(struct bt_graph
*graph
)
630 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
631 struct bt_component
*sink
;
634 BT_ASSERT_PRE(graph
->has_sink
,
635 "Graph has no sink component: %!+g", graph
);
636 BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph
);
638 if (G_UNLIKELY(g_queue_is_empty(graph
->sinks_to_consume
))) {
639 BT_LOGD_STR("Graph's sink queue is empty: end of graph.");
640 status
= BT_GRAPH_STATUS_END
;
644 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
645 sink
= current_node
->data
;
646 BT_LIB_LOGD("Chose next sink to consume: %!+c", sink
);
647 status
= consume_sink_node(graph
, current_node
);
653 enum bt_graph_status
bt_graph_consume(struct bt_graph
*graph
)
655 enum bt_graph_status status
;
657 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
658 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
659 BT_ASSERT_PRE(graph
->can_consume
,
660 "Cannot consume graph in its current state: %!+g", graph
);
661 BT_ASSERT_PRE(graph
->config_state
!= BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
662 "Graph is in a faulty state: %!+g", graph
);
663 bt_graph_set_can_consume(graph
, false);
664 status
= bt_graph_configure(graph
);
665 if (G_UNLIKELY(status
)) {
666 /* bt_graph_configure() logs errors */
670 status
= consume_no_check(graph
);
671 bt_graph_set_can_consume(graph
, true);
677 enum bt_graph_status
bt_graph_run(struct bt_graph
*graph
)
679 enum bt_graph_status status
;
681 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
682 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
683 BT_ASSERT_PRE(graph
->can_consume
,
684 "Cannot consume graph in its current state: %!+g", graph
);
685 BT_ASSERT_PRE(graph
->config_state
!= BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
686 "Graph is in a faulty state: %!+g", graph
);
687 bt_graph_set_can_consume(graph
, false);
688 status
= bt_graph_configure(graph
);
689 if (G_UNLIKELY(status
)) {
690 /* bt_graph_configure() logs errors */
694 BT_LIB_LOGI("Running graph: %!+g", graph
);
698 * Check if the graph is canceled at each iteration. If
699 * the graph was canceled by another thread or by a
700 * signal handler, this is not a warning nor an error,
701 * it was intentional: log with a DEBUG level only.
703 if (G_UNLIKELY(graph
->canceled
)) {
704 BT_LIB_LOGI("Stopping the graph: graph is canceled: "
706 status
= BT_GRAPH_STATUS_CANCELED
;
710 status
= consume_no_check(graph
);
711 if (G_UNLIKELY(status
== BT_GRAPH_STATUS_AGAIN
)) {
713 * If AGAIN is received and there are multiple
714 * sinks, go ahead and consume from the next
717 * However, in the case where a single sink is
718 * left, the caller can decide to busy-wait and
719 * call bt_graph_run() continuously
720 * until the source is ready or it can decide to
721 * sleep for an arbitrary amount of time.
723 if (graph
->sinks_to_consume
->length
> 1) {
724 status
= BT_GRAPH_STATUS_OK
;
727 } while (status
== BT_GRAPH_STATUS_OK
);
729 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
730 status
= BT_GRAPH_STATUS_END
;
734 BT_LIB_LOGI("Graph ran: %![graph-]+g, status=%s", graph
,
735 bt_graph_status_string(status
));
736 bt_graph_set_can_consume(graph
, true);
741 bt_graph_add_source_component_output_port_added_listener(
742 struct bt_graph
*graph
,
743 bt_graph_source_component_output_port_added_listener_func func
,
744 bt_graph_listener_removed_func listener_removed
, void *data
,
745 int *out_listener_id
)
747 struct bt_graph_listener_port_added listener
= {
749 .removed
= listener_removed
,
752 .func
= (port_added_func_t
) func
,
756 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
757 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
758 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
759 BT_ASSERT_PRE(!graph
->in_remove_listener
,
760 "Graph currently executing a \"listener removed\" listener: "
762 g_array_append_val(graph
->listeners
.source_output_port_added
, listener
);
763 listener_id
= graph
->listeners
.source_output_port_added
->len
- 1;
764 BT_LIB_LOGD("Added \"source component output port added\" listener to graph: "
765 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
769 *out_listener_id
= listener_id
;
772 return BT_GRAPH_STATUS_OK
;
776 bt_graph_add_filter_component_output_port_added_listener(
777 struct bt_graph
*graph
,
778 bt_graph_filter_component_output_port_added_listener_func func
,
779 bt_graph_listener_removed_func listener_removed
, void *data
,
780 int *out_listener_id
)
782 struct bt_graph_listener_port_added listener
= {
784 .removed
= listener_removed
,
787 .func
= (port_added_func_t
) func
,
791 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
792 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
793 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
794 BT_ASSERT_PRE(!graph
->in_remove_listener
,
795 "Graph currently executing a \"listener removed\" listener: "
797 g_array_append_val(graph
->listeners
.filter_output_port_added
, listener
);
798 listener_id
= graph
->listeners
.filter_output_port_added
->len
- 1;
799 BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: "
800 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
804 *out_listener_id
= listener_id
;
807 return BT_GRAPH_STATUS_OK
;
811 bt_graph_add_filter_component_input_port_added_listener(
812 struct bt_graph
*graph
,
813 bt_graph_filter_component_input_port_added_listener_func func
,
814 bt_graph_listener_removed_func listener_removed
, void *data
,
815 int *out_listener_id
)
817 struct bt_graph_listener_port_added listener
= {
819 .removed
= listener_removed
,
822 .func
= (port_added_func_t
) func
,
826 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
827 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
828 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
829 BT_ASSERT_PRE(!graph
->in_remove_listener
,
830 "Graph currently executing a \"listener removed\" listener: "
832 g_array_append_val(graph
->listeners
.filter_input_port_added
, listener
);
833 listener_id
= graph
->listeners
.filter_input_port_added
->len
- 1;
834 BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: "
835 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
839 *out_listener_id
= listener_id
;
842 return BT_GRAPH_STATUS_OK
;
846 bt_graph_add_sink_component_input_port_added_listener(
847 struct bt_graph
*graph
,
848 bt_graph_sink_component_input_port_added_listener_func func
,
849 bt_graph_listener_removed_func listener_removed
, void *data
,
850 int *out_listener_id
)
852 struct bt_graph_listener_port_added listener
= {
854 .removed
= listener_removed
,
857 .func
= (port_added_func_t
) func
,
861 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
862 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
863 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
864 BT_ASSERT_PRE(!graph
->in_remove_listener
,
865 "Graph currently executing a \"listener removed\" listener: "
867 g_array_append_val(graph
->listeners
.sink_input_port_added
, listener
);
868 listener_id
= graph
->listeners
.sink_input_port_added
->len
- 1;
869 BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: "
870 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
874 *out_listener_id
= listener_id
;
877 return BT_GRAPH_STATUS_OK
;
881 bt_graph_add_source_filter_component_ports_connected_listener(
882 struct bt_graph
*graph
,
883 bt_graph_source_filter_component_ports_connected_listener_func func
,
884 bt_graph_listener_removed_func listener_removed
, void *data
,
885 int *out_listener_id
)
887 struct bt_graph_listener_ports_connected listener
= {
889 .removed
= listener_removed
,
892 .func
= (ports_connected_func_t
) func
,
896 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
897 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
898 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
899 BT_ASSERT_PRE(!graph
->in_remove_listener
,
900 "Graph currently executing a \"listener removed\" listener: "
902 g_array_append_val(graph
->listeners
.source_filter_ports_connected
,
904 listener_id
= graph
->listeners
.source_filter_ports_connected
->len
- 1;
905 BT_LIB_LOGD("Added \"source to filter component ports connected\" listener to graph: "
906 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
910 *out_listener_id
= listener_id
;
913 return BT_GRAPH_STATUS_OK
;
917 bt_graph_add_source_sink_component_ports_connected_listener(
918 struct bt_graph
*graph
,
919 bt_graph_source_sink_component_ports_connected_listener_func func
,
920 bt_graph_listener_removed_func listener_removed
, void *data
,
921 int *out_listener_id
)
923 struct bt_graph_listener_ports_connected listener
= {
925 .removed
= listener_removed
,
928 .func
= (ports_connected_func_t
) func
,
932 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
933 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
934 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
935 BT_ASSERT_PRE(!graph
->in_remove_listener
,
936 "Graph currently executing a \"listener removed\" listener: "
938 g_array_append_val(graph
->listeners
.source_sink_ports_connected
,
940 listener_id
= graph
->listeners
.source_sink_ports_connected
->len
- 1;
941 BT_LIB_LOGD("Added \"source to sink component ports connected\" listener to graph: "
942 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
946 *out_listener_id
= listener_id
;
949 return BT_GRAPH_STATUS_OK
;
953 bt_graph_add_filter_filter_component_ports_connected_listener(
954 struct bt_graph
*graph
,
955 bt_graph_filter_filter_component_ports_connected_listener_func func
,
956 bt_graph_listener_removed_func listener_removed
, void *data
,
957 int *out_listener_id
)
959 struct bt_graph_listener_ports_connected listener
= {
961 .removed
= listener_removed
,
964 .func
= (ports_connected_func_t
) func
,
968 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
969 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
970 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
971 BT_ASSERT_PRE(!graph
->in_remove_listener
,
972 "Graph currently executing a \"listener removed\" listener: "
974 g_array_append_val(graph
->listeners
.filter_filter_ports_connected
,
976 listener_id
= graph
->listeners
.filter_filter_ports_connected
->len
- 1;
977 BT_LIB_LOGD("Added \"filter to filter component ports connected\" listener to graph: "
978 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
982 *out_listener_id
= listener_id
;
985 return BT_GRAPH_STATUS_OK
;
989 bt_graph_add_filter_sink_component_ports_connected_listener(
990 struct bt_graph
*graph
,
991 bt_graph_filter_sink_component_ports_connected_listener_func func
,
992 bt_graph_listener_removed_func listener_removed
, void *data
,
993 int *out_listener_id
)
995 struct bt_graph_listener_ports_connected listener
= {
997 .removed
= listener_removed
,
1000 .func
= (ports_connected_func_t
) func
,
1004 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1005 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1006 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1007 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1008 "Graph currently executing a \"listener removed\" listener: "
1010 g_array_append_val(graph
->listeners
.filter_sink_ports_connected
,
1012 listener_id
= graph
->listeners
.filter_sink_ports_connected
->len
- 1;
1013 BT_LIB_LOGD("Added \"filter to sink component ports connected\" listener to graph: "
1014 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1018 *out_listener_id
= listener_id
;
1021 return BT_GRAPH_STATUS_OK
;
1025 enum bt_graph_listener_status
bt_graph_notify_port_added(
1026 struct bt_graph
*graph
, struct bt_port
*port
)
1030 struct bt_component
*comp
;
1031 enum bt_graph_listener_status status
= BT_GRAPH_LISTENER_STATUS_OK
;
1035 BT_LIB_LOGD("Notifying graph listeners that a port was added: "
1036 "%![graph-]+g, %![port-]+p", graph
, port
);
1037 comp
= bt_port_borrow_component_inline(port
);
1040 switch (comp
->class->type
) {
1041 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1043 switch (port
->type
) {
1044 case BT_PORT_TYPE_OUTPUT
:
1045 listeners
= graph
->listeners
.source_output_port_added
;
1053 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1055 switch (port
->type
) {
1056 case BT_PORT_TYPE_INPUT
:
1057 listeners
= graph
->listeners
.filter_input_port_added
;
1059 case BT_PORT_TYPE_OUTPUT
:
1060 listeners
= graph
->listeners
.filter_output_port_added
;
1068 case BT_COMPONENT_CLASS_TYPE_SINK
:
1070 switch (port
->type
) {
1071 case BT_PORT_TYPE_INPUT
:
1072 listeners
= graph
->listeners
.sink_input_port_added
;
1084 for (i
= 0; i
< listeners
->len
; i
++) {
1085 struct bt_graph_listener_port_added
*listener
=
1086 &g_array_index(listeners
,
1087 struct bt_graph_listener_port_added
, i
);
1090 BT_ASSERT(listener
->func
);
1091 status
= listener
->func(comp
, port
, listener
->base
.data
);
1092 if (status
!= BT_GRAPH_LISTENER_STATUS_OK
) {
1102 enum bt_graph_listener_status
bt_graph_notify_ports_connected(
1103 struct bt_graph
*graph
, struct bt_port
*upstream_port
,
1104 struct bt_port
*downstream_port
)
1108 struct bt_component
*upstream_comp
;
1109 struct bt_component
*downstream_comp
;
1110 enum bt_graph_listener_status status
= BT_GRAPH_LISTENER_STATUS_OK
;
1113 BT_ASSERT(upstream_port
);
1114 BT_ASSERT(downstream_port
);
1115 BT_LIB_LOGD("Notifying graph listeners that ports were connected: "
1116 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
1117 graph
, upstream_port
, downstream_port
);
1118 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
1119 BT_ASSERT(upstream_comp
);
1120 downstream_comp
= bt_port_borrow_component_inline(downstream_port
);
1121 BT_ASSERT(downstream_comp
);
1123 switch (upstream_comp
->class->type
) {
1124 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1126 switch (downstream_comp
->class->type
) {
1127 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1129 graph
->listeners
.source_filter_ports_connected
;
1131 case BT_COMPONENT_CLASS_TYPE_SINK
:
1133 graph
->listeners
.source_sink_ports_connected
;
1141 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1143 switch (downstream_comp
->class->type
) {
1144 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1146 graph
->listeners
.filter_filter_ports_connected
;
1148 case BT_COMPONENT_CLASS_TYPE_SINK
:
1150 graph
->listeners
.filter_sink_ports_connected
;
1162 for (i
= 0; i
< listeners
->len
; i
++) {
1163 struct bt_graph_listener_ports_connected
*listener
=
1164 &g_array_index(listeners
,
1165 struct bt_graph_listener_ports_connected
, i
);
1167 BT_ASSERT(listener
->func
);
1168 status
= listener
->func(upstream_comp
, downstream_comp
,
1169 upstream_port
, downstream_port
, listener
->base
.data
);
1170 if (status
!= BT_GRAPH_LISTENER_STATUS_OK
) {
1179 enum bt_graph_status
bt_graph_cancel(struct bt_graph
*graph
)
1182 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1183 graph
->canceled
= true;
1184 BT_LIB_LOGI("Canceled graph: %!+i", graph
);
1185 return BT_GRAPH_STATUS_OK
;
1188 bt_bool
bt_graph_is_canceled(const struct bt_graph
*graph
)
1190 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1191 return graph
->canceled
? BT_TRUE
: BT_FALSE
;
1195 void bt_graph_remove_connection(struct bt_graph
*graph
,
1196 struct bt_connection
*connection
)
1199 BT_ASSERT(connection
);
1200 BT_LIB_LOGD("Removing graph's connection: %![graph-]+g, %![conn-]+x",
1202 g_ptr_array_remove(graph
->connections
, connection
);
1207 bool component_name_exists(struct bt_graph
*graph
, const char *name
)
1209 bool exists
= false;
1212 for (i
= 0; i
< graph
->components
->len
; i
++) {
1213 struct bt_component
*other_comp
= graph
->components
->pdata
[i
];
1215 if (strcmp(name
, bt_component_get_name(other_comp
)) == 0) {
1216 BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: "
1217 "%![other-comp-]+c, name=\"%s\"",
1229 enum bt_graph_status
add_component_with_init_method_data(
1230 struct bt_graph
*graph
,
1231 struct bt_component_class
*comp_cls
,
1232 comp_init_method_t init_method
,
1233 const char *name
, const struct bt_value
*params
,
1234 void *init_method_data
, bt_logging_level log_level
,
1235 struct bt_component
**user_component
)
1237 enum bt_graph_status graph_status
= BT_GRAPH_STATUS_OK
;
1238 enum bt_self_component_status comp_status
;
1239 struct bt_component
*component
= NULL
;
1241 bool init_can_consume
;
1242 struct bt_value
*new_params
= NULL
;
1244 BT_ASSERT(comp_cls
);
1245 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1246 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1247 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
1249 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1250 "Graph is not in the \"configuring\" state: %!+g", graph
);
1251 BT_ASSERT_PRE(!component_name_exists(graph
, name
),
1252 "Duplicate component name: %!+g, name=\"%s\"", graph
, name
);
1253 BT_ASSERT_PRE(!params
|| bt_value_is_map(params
),
1254 "Parameter value is not a map value: %!+v", params
);
1255 init_can_consume
= graph
->can_consume
;
1256 bt_graph_set_can_consume(graph
, false);
1257 BT_LIB_LOGI("Adding component to graph: "
1258 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1259 "%![params-]+v, init-method-data-addr=%p",
1260 graph
, comp_cls
, name
,
1261 bt_common_logging_level_string(log_level
), params
,
1265 new_params
= bt_value_map_create();
1267 BT_LOGE_STR("Cannot create empty map value object.");
1268 graph_status
= BT_GRAPH_STATUS_NOMEM
;
1272 params
= new_params
;
1275 ret
= bt_component_create(comp_cls
, name
, log_level
, &component
);
1277 BT_LOGE("Cannot create empty component object: ret=%d",
1279 graph_status
= BT_GRAPH_STATUS_NOMEM
;
1284 * The user's initialization method needs to see that this
1285 * component is part of the graph. If the user method fails, we
1286 * immediately remove the component from the graph's components.
1288 g_ptr_array_add(graph
->components
, component
);
1289 bt_component_set_graph(component
, graph
);
1290 bt_value_freeze(params
);
1293 BT_LOGD_STR("Calling user's initialization method.");
1294 comp_status
= init_method(component
, params
, init_method_data
);
1295 BT_LOGD("User method returned: status=%s",
1296 bt_self_component_status_string(comp_status
));
1297 if (comp_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
1298 BT_LOGW_STR("Initialization method failed.");
1299 graph_status
= (int) comp_status
;
1300 bt_component_set_graph(component
, NULL
);
1301 g_ptr_array_remove_fast(graph
->components
, component
);
1307 * Mark the component as initialized so that its finalization
1308 * method is called when it is destroyed.
1310 component
->initialized
= true;
1313 * If it's a sink component, it needs to be part of the graph's
1314 * sink queue to be consumed by bt_graph_consume().
1316 if (bt_component_is_sink(component
)) {
1317 graph
->has_sink
= true;
1318 g_queue_push_tail(graph
->sinks_to_consume
, component
);
1322 * Freeze the component class now that it's instantiated at
1325 BT_LOGD_STR("Freezing component class.");
1326 bt_component_class_freeze(comp_cls
);
1327 BT_LIB_LOGI("Added component to graph: "
1328 "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, "
1329 "%![params-]+v, init-method-data-addr=%p, %![comp-]+c",
1330 graph
, comp_cls
, name
,
1331 bt_common_logging_level_string(log_level
), params
,
1332 init_method_data
, component
);
1334 if (user_component
) {
1335 /* Move reference to user */
1336 *user_component
= component
;
1341 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1342 bt_graph_make_faulty(graph
);
1345 bt_object_put_ref(component
);
1346 bt_object_put_ref(new_params
);
1347 (void) init_can_consume
;
1348 bt_graph_set_can_consume(graph
, init_can_consume
);
1349 return graph_status
;
1352 enum bt_graph_status
1353 bt_graph_add_source_component_with_init_method_data(
1354 struct bt_graph
*graph
,
1355 const struct bt_component_class_source
*comp_cls
,
1356 const char *name
, const struct bt_value
*params
,
1357 void *init_method_data
, bt_logging_level log_level
,
1358 const struct bt_component_source
**component
)
1360 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1361 return add_component_with_init_method_data(graph
,
1362 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1363 name
, params
, init_method_data
, log_level
, (void *) component
);
1366 enum bt_graph_status
bt_graph_add_source_component(
1367 struct bt_graph
*graph
,
1368 const struct bt_component_class_source
*comp_cls
,
1369 const char *name
, const struct bt_value
*params
,
1370 bt_logging_level log_level
,
1371 const struct bt_component_source
**component
)
1373 return bt_graph_add_source_component_with_init_method_data(
1374 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1377 enum bt_graph_status
1378 bt_graph_add_filter_component_with_init_method_data(
1379 struct bt_graph
*graph
,
1380 const struct bt_component_class_filter
*comp_cls
,
1381 const char *name
, const struct bt_value
*params
,
1382 void *init_method_data
, bt_logging_level log_level
,
1383 const struct bt_component_filter
**component
)
1385 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1386 return add_component_with_init_method_data(graph
,
1387 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1388 name
, params
, init_method_data
, log_level
, (void *) component
);
1391 enum bt_graph_status
bt_graph_add_filter_component(
1392 struct bt_graph
*graph
,
1393 const struct bt_component_class_filter
*comp_cls
,
1394 const char *name
, const struct bt_value
*params
,
1395 bt_logging_level log_level
,
1396 const struct bt_component_filter
**component
)
1398 return bt_graph_add_filter_component_with_init_method_data(
1399 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1402 enum bt_graph_status
1403 bt_graph_add_sink_component_with_init_method_data(
1404 struct bt_graph
*graph
,
1405 const struct bt_component_class_sink
*comp_cls
,
1406 const char *name
, const struct bt_value
*params
,
1407 void *init_method_data
, bt_logging_level log_level
,
1408 const struct bt_component_sink
**component
)
1410 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1411 return add_component_with_init_method_data(graph
,
1412 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1413 name
, params
, init_method_data
, log_level
, (void *) component
);
1416 enum bt_graph_status
bt_graph_add_sink_component(
1417 struct bt_graph
*graph
,
1418 const struct bt_component_class_sink
*comp_cls
,
1419 const char *name
, const struct bt_value
*params
,
1420 bt_logging_level log_level
,
1421 const struct bt_component_sink
**component
)
1423 return bt_graph_add_sink_component_with_init_method_data(
1424 graph
, comp_cls
, name
, params
, NULL
, log_level
, component
);
1428 int bt_graph_remove_unconnected_component(struct bt_graph
*graph
,
1429 struct bt_component
*component
)
1431 bool init_can_consume
;
1437 BT_ASSERT(component
);
1438 BT_ASSERT(component
->base
.ref_count
== 0);
1439 BT_ASSERT(bt_component_borrow_graph(component
) == graph
);
1441 init_can_consume
= graph
->can_consume
;
1442 count
= bt_component_get_input_port_count(component
);
1444 for (i
= 0; i
< count
; i
++) {
1445 struct bt_port
*port
= (void *)
1446 bt_component_borrow_input_port_by_index(component
, i
);
1450 if (bt_port_is_connected(port
)) {
1451 BT_LIB_LOGW("Cannot remove component from graph: "
1452 "an input port is connected: "
1453 "%![graph-]+g, %![comp-]+c, %![port-]+p",
1454 graph
, component
, port
);
1459 count
= bt_component_get_output_port_count(component
);
1461 for (i
= 0; i
< count
; i
++) {
1462 struct bt_port
*port
= (void *)
1463 bt_component_borrow_output_port_by_index(component
, i
);
1467 if (bt_port_is_connected(port
)) {
1468 BT_LIB_LOGW("Cannot remove component from graph: "
1469 "an output port is connected: "
1470 "%![graph-]+g, %![comp-]+c, %![port-]+p",
1471 graph
, component
, port
);
1476 bt_graph_set_can_consume(graph
, false);
1478 /* Possibly remove from sinks to consume */
1479 (void) g_queue_remove(graph
->sinks_to_consume
, component
);
1481 if (graph
->sinks_to_consume
->length
== 0) {
1482 graph
->has_sink
= false;
1486 * This calls bt_object_try_spec_release() on the component, and
1487 * since its reference count is 0, its destructor is called. Its
1488 * destructor calls the user's finalization method (if set).
1490 g_ptr_array_remove(graph
->components
, component
);
1497 (void) init_can_consume
;
1498 bt_graph_set_can_consume(graph
, init_can_consume
);
1503 void bt_graph_add_message(struct bt_graph
*graph
,
1504 struct bt_message
*msg
)
1510 * It's okay not to take a reference because, when a
1511 * message's reference count drops to 0, either:
1513 * * It is recycled back to one of this graph's pool.
1514 * * It is destroyed because it doesn't have any link to any
1515 * graph, which means the original graph is already destroyed.
1517 g_ptr_array_add(graph
->messages
, msg
);
1520 void bt_graph_get_ref(const struct bt_graph
*graph
)
1522 bt_object_get_ref(graph
);
1525 void bt_graph_put_ref(const struct bt_graph
*graph
)
1527 bt_object_put_ref(graph
);