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 "GRAPH"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/assert-internal.h>
28 #include <babeltrace/assert-pre-internal.h>
29 #include <babeltrace/graph/component-internal.h>
30 #include <babeltrace/graph/graph.h>
31 #include <babeltrace/graph/graph-const.h>
32 #include <babeltrace/graph/graph-internal.h>
33 #include <babeltrace/graph/connection-internal.h>
34 #include <babeltrace/graph/component-sink-internal.h>
35 #include <babeltrace/graph/component-source-const.h>
36 #include <babeltrace/graph/component-filter-const.h>
37 #include <babeltrace/graph/port-const.h>
38 #include <babeltrace/graph/message-internal.h>
39 #include <babeltrace/graph/message-event-internal.h>
40 #include <babeltrace/graph/message-packet-internal.h>
41 #include <babeltrace/compiler-internal.h>
42 #include <babeltrace/common-internal.h>
43 #include <babeltrace/types.h>
44 #include <babeltrace/value.h>
45 #include <babeltrace/value-const.h>
46 #include <babeltrace/value-internal.h>
50 typedef void (*port_added_func_t
)(const void *, const void *, void *);
52 typedef void (*ports_connected_func_t
)(const void *, const void *, const void *,
53 const void *, void *);
55 typedef enum bt_self_component_status (*comp_init_method_t
)(const void *,
56 const void *, void *);
58 struct bt_graph_listener
{
59 bt_graph_listener_removed_func removed
;
63 struct bt_graph_listener_port_added
{
64 struct bt_graph_listener base
;
65 port_added_func_t func
;
68 struct bt_graph_listener_ports_connected
{
69 struct bt_graph_listener base
;
70 ports_connected_func_t func
;
73 #define INIT_LISTENERS_ARRAY(_type, _listeners) \
75 _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \
76 if (!(_listeners)) { \
77 BT_LOGE_STR("Failed to allocate one GArray."); \
81 #define CALL_REMOVE_LISTENERS(_type, _listeners) \
85 for (i = 0; i < (_listeners)->len; i++) { \
87 &g_array_index((_listeners), _type, i); \
89 if (listener->base.removed) { \
90 listener->base.removed(listener->base.data); \
96 void destroy_graph(struct bt_object
*obj
)
98 struct bt_graph
*graph
= container_of(obj
, struct bt_graph
, base
);
101 * The graph's reference count is 0 if we're here. Increment
102 * it to avoid a double-destroy (possibly infinitely recursive)
105 * 1. We put and destroy a connection.
106 * 2. This connection's destructor finalizes its active message
108 * 3. A message iterator's finalization function gets a new
109 * reference on its component (reference count goes from 0 to
111 * 4. Since this component's reference count goes to 1, it takes
112 * a reference on its parent (this graph). This graph's
113 * reference count goes from 0 to 1.
114 * 5. The message iterator's finalization function puts its
115 * component reference (reference count goes from 1 to 0).
116 * 6. Since this component's reference count goes from 1 to 0,
117 * it puts its parent (this graph). This graph's reference
118 * count goes from 1 to 0.
119 * 7. Since this graph's reference count goes from 1 to 0, its
120 * destructor is called (this function).
122 * With the incrementation below, the graph's reference count at
123 * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This
124 * ensures that this function is not called two times.
126 BT_LIB_LOGD("Destroying graph: %!+g", graph
);
130 * Cancel the graph to disallow some operations, like creating
131 * message iterators and adding ports to components.
133 (void) bt_graph_cancel((void *) graph
);
135 /* Call all remove listeners */
136 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
137 graph
->listeners
.source_output_port_added
);
138 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
139 graph
->listeners
.filter_output_port_added
);
140 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
141 graph
->listeners
.filter_input_port_added
);
142 CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added
,
143 graph
->listeners
.sink_input_port_added
);
144 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
145 graph
->listeners
.source_filter_ports_connected
);
146 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
147 graph
->listeners
.filter_filter_ports_connected
);
148 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
149 graph
->listeners
.source_sink_ports_connected
);
150 CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected
,
151 graph
->listeners
.filter_sink_ports_connected
);
153 if (graph
->messages
) {
154 g_ptr_array_free(graph
->messages
, TRUE
);
155 graph
->messages
= NULL
;
158 if (graph
->connections
) {
159 BT_LOGD_STR("Destroying connections.");
160 g_ptr_array_free(graph
->connections
, TRUE
);
161 graph
->connections
= NULL
;
164 if (graph
->components
) {
165 BT_LOGD_STR("Destroying components.");
166 g_ptr_array_free(graph
->components
, TRUE
);
167 graph
->components
= NULL
;
170 if (graph
->sinks_to_consume
) {
171 g_queue_free(graph
->sinks_to_consume
);
172 graph
->sinks_to_consume
= NULL
;
175 if (graph
->listeners
.source_output_port_added
) {
176 g_array_free(graph
->listeners
.source_output_port_added
, TRUE
);
177 graph
->listeners
.source_output_port_added
= NULL
;
180 if (graph
->listeners
.filter_output_port_added
) {
181 g_array_free(graph
->listeners
.filter_output_port_added
, TRUE
);
182 graph
->listeners
.filter_output_port_added
= NULL
;
185 if (graph
->listeners
.filter_input_port_added
) {
186 g_array_free(graph
->listeners
.filter_input_port_added
, TRUE
);
187 graph
->listeners
.filter_input_port_added
= NULL
;
190 if (graph
->listeners
.sink_input_port_added
) {
191 g_array_free(graph
->listeners
.sink_input_port_added
, TRUE
);
192 graph
->listeners
.sink_input_port_added
= NULL
;
195 if (graph
->listeners
.source_filter_ports_connected
) {
196 g_array_free(graph
->listeners
.source_filter_ports_connected
,
198 graph
->listeners
.source_filter_ports_connected
= NULL
;
201 if (graph
->listeners
.filter_filter_ports_connected
) {
202 g_array_free(graph
->listeners
.filter_filter_ports_connected
,
204 graph
->listeners
.filter_filter_ports_connected
= NULL
;
207 if (graph
->listeners
.source_sink_ports_connected
) {
208 g_array_free(graph
->listeners
.source_sink_ports_connected
,
210 graph
->listeners
.source_sink_ports_connected
= NULL
;
213 if (graph
->listeners
.filter_sink_ports_connected
) {
214 g_array_free(graph
->listeners
.filter_sink_ports_connected
,
216 graph
->listeners
.filter_sink_ports_connected
= NULL
;
219 bt_object_pool_finalize(&graph
->event_msg_pool
);
220 bt_object_pool_finalize(&graph
->packet_begin_msg_pool
);
221 bt_object_pool_finalize(&graph
->packet_end_msg_pool
);
226 void destroy_message_event(struct bt_message
*msg
,
227 struct bt_graph
*graph
)
229 bt_message_event_destroy(msg
);
233 void destroy_message_packet_begin(struct bt_message
*msg
,
234 struct bt_graph
*graph
)
236 bt_message_packet_destroy(msg
);
240 void destroy_message_packet_end(struct bt_message
*msg
,
241 struct bt_graph
*graph
)
243 bt_message_packet_destroy(msg
);
247 void notify_message_graph_is_destroyed(struct bt_message
*msg
)
249 bt_message_unlink_graph(msg
);
252 struct bt_graph
*bt_graph_create(void)
254 struct bt_graph
*graph
;
257 BT_LOGD_STR("Creating graph object.");
258 graph
= g_new0(struct bt_graph
, 1);
260 BT_LOGE_STR("Failed to allocate one graph.");
264 bt_object_init_shared(&graph
->base
, destroy_graph
);
265 graph
->connections
= g_ptr_array_new_with_free_func(
266 (GDestroyNotify
) bt_object_try_spec_release
);
267 if (!graph
->connections
) {
268 BT_LOGE_STR("Failed to allocate one GPtrArray.");
271 graph
->components
= g_ptr_array_new_with_free_func(
272 (GDestroyNotify
) bt_object_try_spec_release
);
273 if (!graph
->components
) {
274 BT_LOGE_STR("Failed to allocate one GPtrArray.");
277 graph
->sinks_to_consume
= g_queue_new();
278 if (!graph
->sinks_to_consume
) {
279 BT_LOGE_STR("Failed to allocate one GQueue.");
283 bt_graph_set_can_consume(graph
, true);
284 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
285 graph
->listeners
.source_output_port_added
);
287 if (!graph
->listeners
.source_output_port_added
) {
292 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
293 graph
->listeners
.filter_output_port_added
);
295 if (!graph
->listeners
.filter_output_port_added
) {
300 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
301 graph
->listeners
.filter_input_port_added
);
303 if (!graph
->listeners
.filter_input_port_added
) {
308 INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added
,
309 graph
->listeners
.sink_input_port_added
);
311 if (!graph
->listeners
.sink_input_port_added
) {
316 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
317 graph
->listeners
.source_filter_ports_connected
);
319 if (!graph
->listeners
.source_filter_ports_connected
) {
324 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
325 graph
->listeners
.source_sink_ports_connected
);
327 if (!graph
->listeners
.source_sink_ports_connected
) {
332 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
333 graph
->listeners
.filter_filter_ports_connected
);
335 if (!graph
->listeners
.filter_filter_ports_connected
) {
340 INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected
,
341 graph
->listeners
.filter_sink_ports_connected
);
343 if (!graph
->listeners
.filter_sink_ports_connected
) {
348 ret
= bt_object_pool_initialize(&graph
->event_msg_pool
,
349 (bt_object_pool_new_object_func
) bt_message_event_new
,
350 (bt_object_pool_destroy_object_func
) destroy_message_event
,
353 BT_LOGE("Failed to initialize event message pool: ret=%d",
358 ret
= bt_object_pool_initialize(&graph
->packet_begin_msg_pool
,
359 (bt_object_pool_new_object_func
) bt_message_packet_beginning_new
,
360 (bt_object_pool_destroy_object_func
) destroy_message_packet_begin
,
363 BT_LOGE("Failed to initialize packet beginning message pool: ret=%d",
368 ret
= bt_object_pool_initialize(&graph
->packet_end_msg_pool
,
369 (bt_object_pool_new_object_func
) bt_message_packet_end_new
,
370 (bt_object_pool_destroy_object_func
) destroy_message_packet_end
,
373 BT_LOGE("Failed to initialize packet end message pool: ret=%d",
378 graph
->messages
= g_ptr_array_new_with_free_func(
379 (GDestroyNotify
) notify_message_graph_is_destroyed
);
380 BT_LIB_LOGD("Created graph object: %!+g", graph
);
383 return (void *) graph
;
386 BT_OBJECT_PUT_REF_AND_RESET(graph
);
390 enum bt_graph_status
bt_graph_connect_ports(
391 struct bt_graph
*graph
,
392 const struct bt_port_output
*upstream_port_out
,
393 const struct bt_port_input
*downstream_port_in
,
394 const struct bt_connection
**user_connection
)
396 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
397 struct bt_connection
*connection
= NULL
;
398 struct bt_port
*upstream_port
= (void *) upstream_port_out
;
399 struct bt_port
*downstream_port
= (void *) downstream_port_in
;
400 struct bt_component
*upstream_component
= NULL
;
401 struct bt_component
*downstream_component
= NULL
;
402 enum bt_self_component_status component_status
;
403 bool init_can_consume
;
405 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
406 BT_ASSERT_PRE_NON_NULL(upstream_port
, "Upstream port");
407 BT_ASSERT_PRE_NON_NULL(downstream_port
, "Downstream port port");
408 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
410 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
411 "Graph is already configured: %!+g", graph
);
412 BT_ASSERT_PRE(!bt_port_is_connected(upstream_port
),
413 "Upstream port is already connected: %!+p", upstream_port
);
414 BT_ASSERT_PRE(!bt_port_is_connected(downstream_port
),
415 "Downstream port is already connected: %!+p", downstream_port
);
416 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port
),
417 "Upstream port does not belong to a component: %!+p",
419 BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port
),
420 "Downstream port does not belong to a component: %!+p",
422 init_can_consume
= graph
->can_consume
;
423 BT_LIB_LOGD("Connecting component ports within graph: "
424 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
425 graph
, upstream_port
, downstream_port
);
426 bt_graph_set_can_consume(graph
, false);
427 upstream_component
= bt_port_borrow_component_inline(
428 (void *) upstream_port
);
429 downstream_component
= bt_port_borrow_component_inline(
430 (void *) downstream_port
);
433 * At this point the ports are not connected yet. Both
434 * components need to accept an eventual connection to their
435 * port by the other port before we continue.
437 BT_LIB_LOGD("Asking upstream component to accept the connection: "
438 "%![comp-]+c", upstream_component
);
439 component_status
= bt_component_accept_port_connection(
440 upstream_component
, (void *) upstream_port
,
441 (void *) downstream_port
);
442 if (component_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
443 if (component_status
== BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
) {
444 BT_LOGD_STR("Upstream component refused the connection.");
446 BT_LOGW("Cannot ask upstream component to accept the connection: "
447 "status=%s", bt_self_component_status_string(component_status
));
450 status
= (int) component_status
;
454 BT_LIB_LOGD("Asking downstream component to accept the connection: "
455 "%![comp-]+c", downstream_component
);
456 component_status
= bt_component_accept_port_connection(
457 downstream_component
, (void *) downstream_port
,
458 (void *) upstream_port
);
459 if (component_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
460 if (component_status
== BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
) {
461 BT_LOGD_STR("Downstream component refused the connection.");
463 BT_LOGW("Cannot ask downstream component to accept the connection: "
464 "status=%s", bt_self_component_status_string(component_status
));
467 status
= (int) component_status
;
471 BT_LOGD_STR("Creating connection.");
472 connection
= bt_connection_create(graph
, (void *) upstream_port
,
473 (void *) downstream_port
);
475 BT_LOGW("Cannot create connection object.");
476 status
= BT_GRAPH_STATUS_NOMEM
;
480 BT_LIB_LOGD("Connection object created: %!+x", connection
);
483 * Ownership of upstream_component/downstream_component and of
484 * the connection object is transferred to the graph.
486 g_ptr_array_add(graph
->connections
, connection
);
489 * Notify both components that their port is connected.
491 BT_LIB_LOGD("Notifying upstream component that its port is connected: "
492 "%![comp-]+c, %![port-]+p", upstream_component
, upstream_port
);
493 component_status
= bt_component_port_connected(upstream_component
,
494 (void *) upstream_port
, (void *) downstream_port
);
495 if (component_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
496 BT_LIB_LOGW("Error while notifying upstream component that its port is connected: "
497 "status=%s, %![graph-]+g, %![up-comp-]+c, "
498 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
499 bt_self_component_status_string(component_status
),
500 graph
, upstream_component
, downstream_component
,
501 upstream_port
, downstream_port
);
502 bt_connection_end(connection
, true);
503 status
= (int) component_status
;
507 connection
->notified_upstream_port_connected
= true;
508 BT_LIB_LOGD("Notifying downstream component that its port is connected: "
509 "%![comp-]+c, %![port-]+p", downstream_component
,
511 component_status
= bt_component_port_connected(downstream_component
,
512 (void *) downstream_port
, (void *) upstream_port
);
513 if (component_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
514 BT_LIB_LOGW("Error while notifying downstream component that its port is connected: "
515 "status=%s, %![graph-]+g, %![up-comp-]+c, "
516 "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p",
517 bt_self_component_status_string(component_status
),
518 graph
, upstream_component
, downstream_component
,
519 upstream_port
, downstream_port
);
520 bt_connection_end(connection
, true);
521 status
= (int) component_status
;
525 connection
->notified_downstream_port_connected
= true;
528 * Notify the graph's creator that both ports are connected.
530 BT_LOGD_STR("Notifying graph's user that new component ports are connected.");
531 bt_graph_notify_ports_connected(graph
, upstream_port
, downstream_port
);
532 connection
->notified_graph_ports_connected
= true;
533 BT_LIB_LOGD("Connected component ports within graph: "
534 "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
535 "%![up-port-]+p, %![down-port-]+p",
536 graph
, upstream_component
, downstream_component
,
537 upstream_port
, downstream_port
);
539 if (user_connection
) {
540 /* Move reference to user */
541 *user_connection
= connection
;
546 bt_object_put_ref(connection
);
547 (void) init_can_consume
;
548 bt_graph_set_can_consume(graph
, init_can_consume
);
553 enum bt_graph_status
consume_graph_sink(struct bt_component_sink
*comp
)
555 enum bt_self_component_status comp_status
;
556 struct bt_component_class_sink
*sink_class
= NULL
;
559 sink_class
= (void *) comp
->parent
.class;
560 BT_ASSERT(sink_class
->methods
.consume
);
561 BT_LIB_LOGD("Calling user's consume method: %!+c", comp
);
562 comp_status
= sink_class
->methods
.consume((void *) comp
);
563 BT_LOGD("User method returned: status=%s",
564 bt_self_component_status_string(comp_status
));
565 BT_ASSERT_PRE(comp_status
== BT_SELF_COMPONENT_STATUS_OK
||
566 comp_status
== BT_SELF_COMPONENT_STATUS_END
||
567 comp_status
== BT_SELF_COMPONENT_STATUS_AGAIN
||
568 comp_status
== BT_SELF_COMPONENT_STATUS_ERROR
||
569 comp_status
== BT_SELF_COMPONENT_STATUS_NOMEM
,
570 "Invalid component status returned by consuming method: "
571 "status=%s", bt_self_component_status_string(comp_status
));
572 if (comp_status
< 0) {
573 BT_LOGW_STR("Consume method failed.");
577 BT_LIB_LOGV("Consumed from sink: %![comp-]+c, status=%s",
578 comp
, bt_self_component_status_string(comp_status
));
581 return (int) comp_status
;
585 * `node` is removed from the queue of sinks to consume when passed to
586 * this function. This function adds it back to the queue if there's
587 * still something to consume afterwards.
590 enum bt_graph_status
consume_sink_node(struct bt_graph
*graph
, GList
*node
)
592 enum bt_graph_status status
;
593 struct bt_component_sink
*sink
;
596 status
= consume_graph_sink(sink
);
597 if (unlikely(status
!= BT_GRAPH_STATUS_END
)) {
598 g_queue_push_tail_link(graph
->sinks_to_consume
, node
);
602 /* End reached, the node is not added back to the queue and free'd. */
603 g_queue_delete_link(graph
->sinks_to_consume
, node
);
605 /* Don't forward an END status if there are sinks left to consume. */
606 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
607 status
= BT_GRAPH_STATUS_OK
;
612 BT_LIB_LOGV("Consumed sink node: %![comp-]+c, status=%s",
613 sink
, bt_graph_status_string(status
));
618 enum bt_graph_status
bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
619 struct bt_component_sink
*sink
)
621 enum bt_graph_status status
;
625 BT_LIB_LOGV("Making specific sink consume: %![comp-]+c", sink
);
626 BT_ASSERT(bt_component_borrow_graph((void *) sink
) == graph
);
628 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
629 BT_LOGV_STR("Graph's sink queue is empty: end of graph.");
630 status
= BT_GRAPH_STATUS_END
;
634 index
= g_queue_index(graph
->sinks_to_consume
, sink
);
636 BT_LOGV_STR("Sink is not marked as consumable: sink is ended.");
637 status
= BT_GRAPH_STATUS_END
;
641 sink_node
= g_queue_pop_nth_link(graph
->sinks_to_consume
, index
);
642 BT_ASSERT(sink_node
);
643 status
= consume_sink_node(graph
, sink_node
);
650 enum bt_graph_status
consume_no_check(struct bt_graph
*graph
)
652 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
653 struct bt_component
*sink
;
656 BT_ASSERT_PRE(graph
->has_sink
,
657 "Graph has no sink component: %!+g", graph
);
658 BT_LIB_LOGV("Making next sink consume: %![graph-]+g", graph
);
660 if (unlikely(g_queue_is_empty(graph
->sinks_to_consume
))) {
661 BT_LOGV_STR("Graph's sink queue is empty: end of graph.");
662 status
= BT_GRAPH_STATUS_END
;
666 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
667 sink
= current_node
->data
;
668 BT_LIB_LOGV("Chose next sink to consume: %!+c", sink
);
669 status
= consume_sink_node(graph
, current_node
);
675 enum bt_graph_status
bt_graph_consume(struct bt_graph
*graph
)
677 enum bt_graph_status status
;
679 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
680 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
681 BT_ASSERT_PRE(graph
->can_consume
,
682 "Cannot consume graph in its current state: %!+g", graph
);
683 bt_graph_set_can_consume(graph
, false);
684 status
= bt_graph_configure(graph
);
686 /* bt_graph_configure() logs errors */
690 status
= consume_no_check(graph
);
691 bt_graph_set_can_consume(graph
, true);
697 enum bt_graph_status
bt_graph_run(struct bt_graph
*graph
)
699 enum bt_graph_status status
;
701 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
702 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
703 BT_ASSERT_PRE(graph
->can_consume
,
704 "Cannot consume graph in its current state: %!+g", graph
);
705 bt_graph_set_can_consume(graph
, false);
706 status
= bt_graph_configure(graph
);
708 /* bt_graph_configure() logs errors */
712 BT_LIB_LOGV("Running graph: %!+g", graph
);
716 * Check if the graph is canceled at each iteration. If
717 * the graph was canceled by another thread or by a
718 * signal handler, this is not a warning nor an error,
719 * it was intentional: log with a DEBUG level only.
721 if (unlikely(graph
->canceled
)) {
722 BT_LIB_LOGD("Stopping the graph: graph is canceled: "
724 status
= BT_GRAPH_STATUS_CANCELED
;
728 status
= consume_no_check(graph
);
729 if (unlikely(status
== BT_GRAPH_STATUS_AGAIN
)) {
731 * If AGAIN is received and there are multiple
732 * sinks, go ahead and consume from the next
735 * However, in the case where a single sink is
736 * left, the caller can decide to busy-wait and
737 * call bt_graph_run() continuously
738 * until the source is ready or it can decide to
739 * sleep for an arbitrary amount of time.
741 if (graph
->sinks_to_consume
->length
> 1) {
742 status
= BT_GRAPH_STATUS_OK
;
744 } else if (status
== BT_GRAPH_STATUS_NO_SINK
) {
747 } while (status
== BT_GRAPH_STATUS_OK
);
749 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
750 status
= BT_GRAPH_STATUS_END
;
754 BT_LIB_LOGV("Graph ran: %![graph-]+g, status=%s", graph
,
755 bt_graph_status_string(status
));
756 bt_graph_set_can_consume(graph
, true);
761 bt_graph_add_source_component_output_port_added_listener(
762 struct bt_graph
*graph
,
763 bt_graph_source_component_output_port_added_listener_func func
,
764 bt_graph_listener_removed_func listener_removed
, void *data
,
765 int *out_listener_id
)
767 struct bt_graph_listener_port_added listener
= {
769 .removed
= listener_removed
,
772 .func
= (port_added_func_t
) func
,
776 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
777 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
778 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
779 BT_ASSERT_PRE(!graph
->in_remove_listener
,
780 "Graph currently executing a \"listener removed\" listener: "
782 g_array_append_val(graph
->listeners
.source_output_port_added
, listener
);
783 listener_id
= graph
->listeners
.source_output_port_added
->len
- 1;
784 BT_LIB_LOGV("Added \"source component output port added\" listener to graph: "
785 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
789 *out_listener_id
= listener_id
;
792 return BT_GRAPH_STATUS_OK
;
796 bt_graph_add_filter_component_output_port_added_listener(
797 struct bt_graph
*graph
,
798 bt_graph_filter_component_output_port_added_listener_func func
,
799 bt_graph_listener_removed_func listener_removed
, void *data
,
800 int *out_listener_id
)
802 struct bt_graph_listener_port_added listener
= {
804 .removed
= listener_removed
,
807 .func
= (port_added_func_t
) func
,
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
.filter_output_port_added
, listener
);
818 listener_id
= graph
->listeners
.filter_output_port_added
->len
- 1;
819 BT_LIB_LOGV("Added \"filter 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_GRAPH_STATUS_OK
;
831 bt_graph_add_filter_component_input_port_added_listener(
832 struct bt_graph
*graph
,
833 bt_graph_filter_component_input_port_added_listener_func func
,
834 bt_graph_listener_removed_func listener_removed
, void *data
,
835 int *out_listener_id
)
837 struct bt_graph_listener_port_added listener
= {
839 .removed
= listener_removed
,
842 .func
= (port_added_func_t
) func
,
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_input_port_added
, listener
);
853 listener_id
= graph
->listeners
.filter_input_port_added
->len
- 1;
854 BT_LIB_LOGV("Added \"filter component input port added\" listener to graph: "
855 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
859 *out_listener_id
= listener_id
;
862 return BT_GRAPH_STATUS_OK
;
866 bt_graph_add_sink_component_input_port_added_listener(
867 struct bt_graph
*graph
,
868 bt_graph_sink_component_input_port_added_listener_func func
,
869 bt_graph_listener_removed_func listener_removed
, void *data
,
870 int *out_listener_id
)
872 struct bt_graph_listener_port_added listener
= {
874 .removed
= listener_removed
,
877 .func
= (port_added_func_t
) func
,
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
.sink_input_port_added
, listener
);
888 listener_id
= graph
->listeners
.sink_input_port_added
->len
- 1;
889 BT_LIB_LOGV("Added \"sink 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_GRAPH_STATUS_OK
;
901 bt_graph_add_source_filter_component_ports_connected_listener(
902 struct bt_graph
*graph
,
903 bt_graph_source_filter_component_ports_connected_listener_func func
,
904 bt_graph_listener_removed_func listener_removed
, void *data
,
905 int *out_listener_id
)
907 struct bt_graph_listener_ports_connected listener
= {
909 .removed
= listener_removed
,
912 .func
= (ports_connected_func_t
) func
,
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
.source_filter_ports_connected
,
924 listener_id
= graph
->listeners
.source_filter_ports_connected
->len
- 1;
925 BT_LIB_LOGV("Added \"source to filter component ports connected\" listener to graph: "
926 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
930 *out_listener_id
= listener_id
;
933 return BT_GRAPH_STATUS_OK
;
937 bt_graph_add_source_sink_component_ports_connected_listener(
938 struct bt_graph
*graph
,
939 bt_graph_source_sink_component_ports_connected_listener_func func
,
940 bt_graph_listener_removed_func listener_removed
, void *data
,
941 int *out_listener_id
)
943 struct bt_graph_listener_ports_connected listener
= {
945 .removed
= listener_removed
,
948 .func
= (ports_connected_func_t
) func
,
952 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
953 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
954 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
955 BT_ASSERT_PRE(!graph
->in_remove_listener
,
956 "Graph currently executing a \"listener removed\" listener: "
958 g_array_append_val(graph
->listeners
.source_sink_ports_connected
,
960 listener_id
= graph
->listeners
.source_sink_ports_connected
->len
- 1;
961 BT_LIB_LOGV("Added \"source to sink component ports connected\" listener to graph: "
962 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
966 *out_listener_id
= listener_id
;
969 return BT_GRAPH_STATUS_OK
;
973 bt_graph_add_filter_filter_component_ports_connected_listener(
974 struct bt_graph
*graph
,
975 bt_graph_filter_filter_component_ports_connected_listener_func func
,
976 bt_graph_listener_removed_func listener_removed
, void *data
,
977 int *out_listener_id
)
979 struct bt_graph_listener_ports_connected listener
= {
981 .removed
= listener_removed
,
984 .func
= (ports_connected_func_t
) func
,
988 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
989 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
990 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
991 BT_ASSERT_PRE(!graph
->in_remove_listener
,
992 "Graph currently executing a \"listener removed\" listener: "
994 g_array_append_val(graph
->listeners
.filter_filter_ports_connected
,
996 listener_id
= graph
->listeners
.filter_filter_ports_connected
->len
- 1;
997 BT_LIB_LOGV("Added \"filter to filter component ports connected\" listener to graph: "
998 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1002 *out_listener_id
= listener_id
;
1005 return BT_GRAPH_STATUS_OK
;
1008 enum bt_graph_status
1009 bt_graph_add_filter_sink_component_ports_connected_listener(
1010 struct bt_graph
*graph
,
1011 bt_graph_filter_sink_component_ports_connected_listener_func func
,
1012 bt_graph_listener_removed_func listener_removed
, void *data
,
1013 int *out_listener_id
)
1015 struct bt_graph_listener_ports_connected listener
= {
1017 .removed
= listener_removed
,
1020 .func
= (ports_connected_func_t
) func
,
1024 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1025 BT_ASSERT_PRE_NON_NULL(func
, "Listener");
1026 BT_ASSERT_PRE_NON_NULL(func
, "\"Listener removed\" listener");
1027 BT_ASSERT_PRE(!graph
->in_remove_listener
,
1028 "Graph currently executing a \"listener removed\" listener: "
1030 g_array_append_val(graph
->listeners
.filter_sink_ports_connected
,
1032 listener_id
= graph
->listeners
.filter_sink_ports_connected
->len
- 1;
1033 BT_LIB_LOGV("Added \"filter to sink component ports connected\" listener to graph: "
1034 "%![graph-]+g, listener-addr=%p, id=%d", graph
, listener
,
1038 *out_listener_id
= listener_id
;
1041 return BT_GRAPH_STATUS_OK
;
1045 void bt_graph_notify_port_added(struct bt_graph
*graph
, struct bt_port
*port
)
1049 struct bt_component
*comp
;
1053 BT_LIB_LOGV("Notifying graph listeners that a port was added: "
1054 "%![graph-]+g, %![port-]+p", graph
, port
);
1055 comp
= bt_port_borrow_component_inline(port
);
1058 switch (comp
->class->type
) {
1059 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1061 switch (port
->type
) {
1062 case BT_PORT_TYPE_OUTPUT
:
1063 listeners
= graph
->listeners
.source_output_port_added
;
1071 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1073 switch (port
->type
) {
1074 case BT_PORT_TYPE_INPUT
:
1075 listeners
= graph
->listeners
.filter_input_port_added
;
1077 case BT_PORT_TYPE_OUTPUT
:
1078 listeners
= graph
->listeners
.filter_output_port_added
;
1086 case BT_COMPONENT_CLASS_TYPE_SINK
:
1088 switch (port
->type
) {
1089 case BT_PORT_TYPE_INPUT
:
1090 listeners
= graph
->listeners
.sink_input_port_added
;
1102 for (i
= 0; i
< listeners
->len
; i
++) {
1103 struct bt_graph_listener_port_added
*listener
=
1104 &g_array_index(listeners
,
1105 struct bt_graph_listener_port_added
, i
);
1107 BT_ASSERT(listener
->func
);
1108 listener
->func(comp
, port
, listener
->base
.data
);
1113 void bt_graph_notify_ports_connected(struct bt_graph
*graph
,
1114 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
)
1118 struct bt_component
*upstream_comp
;
1119 struct bt_component
*downstream_comp
;
1122 BT_ASSERT(upstream_port
);
1123 BT_ASSERT(downstream_port
);
1124 BT_LIB_LOGV("Notifying graph listeners that ports were connected: "
1125 "%![graph-]+g, %![up-port-]+p, %![down-port-]+p",
1126 graph
, upstream_port
, downstream_port
);
1127 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
1128 BT_ASSERT(upstream_comp
);
1129 downstream_comp
= bt_port_borrow_component_inline(downstream_port
);
1130 BT_ASSERT(downstream_comp
);
1132 switch (upstream_comp
->class->type
) {
1133 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1135 switch (downstream_comp
->class->type
) {
1136 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1138 graph
->listeners
.source_filter_ports_connected
;
1140 case BT_COMPONENT_CLASS_TYPE_SINK
:
1142 graph
->listeners
.source_sink_ports_connected
;
1150 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1152 switch (downstream_comp
->class->type
) {
1153 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1155 graph
->listeners
.filter_filter_ports_connected
;
1157 case BT_COMPONENT_CLASS_TYPE_SINK
:
1159 graph
->listeners
.filter_sink_ports_connected
;
1171 for (i
= 0; i
< listeners
->len
; i
++) {
1172 struct bt_graph_listener_ports_connected
*listener
=
1173 &g_array_index(listeners
,
1174 struct bt_graph_listener_ports_connected
, i
);
1176 BT_ASSERT(listener
->func
);
1177 listener
->func(upstream_comp
, downstream_comp
,
1178 upstream_port
, downstream_port
, listener
->base
.data
);
1182 enum bt_graph_status
bt_graph_cancel(struct bt_graph
*graph
)
1185 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1186 graph
->canceled
= true;
1187 BT_LIB_LOGV("Canceled graph: %!+i", graph
);
1188 return BT_GRAPH_STATUS_OK
;
1191 bt_bool
bt_graph_is_canceled(const struct bt_graph
*graph
)
1193 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1194 return graph
->canceled
? BT_TRUE
: BT_FALSE
;
1198 void bt_graph_remove_connection(struct bt_graph
*graph
,
1199 struct bt_connection
*connection
)
1202 BT_ASSERT(connection
);
1203 BT_LIB_LOGV("Removing graph's connection: %![graph-]+g, %![conn-]+x",
1205 g_ptr_array_remove(graph
->connections
, connection
);
1210 bool component_name_exists(struct bt_graph
*graph
, const char *name
)
1212 bool exists
= false;
1215 for (i
= 0; i
< graph
->components
->len
; i
++) {
1216 struct bt_component
*other_comp
= graph
->components
->pdata
[i
];
1218 if (strcmp(name
, bt_component_get_name(other_comp
)) == 0) {
1219 BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: "
1220 "%![other-comp-]+c, name=\"%s\"",
1232 enum bt_graph_status
add_component_with_init_method_data(
1233 struct bt_graph
*graph
,
1234 struct bt_component_class
*comp_cls
,
1235 comp_init_method_t init_method
,
1236 const char *name
, const struct bt_value
*params
,
1237 void *init_method_data
, struct bt_component
**user_component
)
1239 enum bt_graph_status graph_status
= BT_GRAPH_STATUS_OK
;
1240 enum bt_self_component_status comp_status
;
1241 struct bt_component
*component
= NULL
;
1243 bool init_can_consume
;
1244 struct bt_value
*new_params
= NULL
;
1246 BT_ASSERT(comp_cls
);
1247 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1248 BT_ASSERT_PRE_NON_NULL(name
, "Name");
1249 BT_ASSERT_PRE(!graph
->canceled
, "Graph is canceled: %!+g", graph
);
1251 graph
->config_state
== BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1252 "Graph is already configured: %!+g", graph
);
1253 BT_ASSERT_PRE(!component_name_exists(graph
, name
),
1254 "Duplicate component name: %!+g, name=\"%s\"", graph
, name
);
1255 BT_ASSERT_PRE(!params
|| bt_value_is_map(params
),
1256 "Parameter value is not a map value: %!+v", params
);
1257 init_can_consume
= graph
->can_consume
;
1258 bt_graph_set_can_consume(graph
, false);
1259 BT_LIB_LOGD("Adding component to graph: "
1260 "%![graph-]+g, %![cc-]+C, name=\"%s\", %![params-]+v, "
1261 "init-method-data-addr=%p",
1262 graph
, comp_cls
, name
, params
, init_method_data
);
1265 new_params
= bt_value_map_create();
1267 BT_LOGE_STR("Cannot create map value object.");
1268 graph_status
= BT_GRAPH_STATUS_NOMEM
;
1272 params
= new_params
;
1275 ret
= bt_component_create(comp_cls
, name
, &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
);
1292 BT_LOGD_STR("Calling user's initialization method.");
1293 comp_status
= init_method(component
, params
, init_method_data
);
1294 BT_LOGD("User method returned: status=%s",
1295 bt_self_component_status_string(comp_status
));
1296 if (comp_status
!= BT_SELF_COMPONENT_STATUS_OK
) {
1297 BT_LOGW_STR("Initialization method failed.");
1298 graph_status
= (int) comp_status
;
1299 bt_component_set_graph(component
, NULL
);
1300 g_ptr_array_remove_fast(graph
->components
, component
);
1306 * Mark the component as initialized so that its finalization
1307 * method is called when it is destroyed.
1309 component
->initialized
= true;
1312 * If it's a sink component, it needs to be part of the graph's
1313 * sink queue to be consumed by bt_graph_consume().
1315 if (bt_component_is_sink(component
)) {
1316 graph
->has_sink
= true;
1317 g_queue_push_tail(graph
->sinks_to_consume
, component
);
1321 * Freeze the component class now that it's instantiated at
1324 BT_LOGD_STR("Freezing component class.");
1325 bt_component_class_freeze(comp_cls
);
1326 BT_LIB_LOGD("Added component to graph: "
1327 "%![graph-]+g, %![cc-]+C, name=\"%s\", %![params-]+v, "
1328 "init-method-data-addr=%p, %![comp-]+c",
1329 graph
, comp_cls
, name
, params
, init_method_data
, component
);
1331 if (user_component
) {
1332 /* Move reference to user */
1333 *user_component
= component
;
1338 bt_object_put_ref(component
);
1339 bt_object_put_ref(new_params
);
1340 (void) init_can_consume
;
1341 bt_graph_set_can_consume(graph
, init_can_consume
);
1342 return graph_status
;
1345 enum bt_graph_status
1346 bt_graph_add_source_component_with_init_method_data(
1347 struct bt_graph
*graph
,
1348 const struct bt_component_class_source
*comp_cls
,
1349 const char *name
, const struct bt_value
*params
,
1350 void *init_method_data
,
1351 const struct bt_component_source
**component
)
1353 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1354 return add_component_with_init_method_data(graph
,
1355 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1356 name
, params
, init_method_data
, (void *) component
);
1359 enum bt_graph_status
bt_graph_add_source_component(
1360 struct bt_graph
*graph
,
1361 const struct bt_component_class_source
*comp_cls
,
1362 const char *name
, const struct bt_value
*params
,
1363 const struct bt_component_source
**component
)
1365 return bt_graph_add_source_component_with_init_method_data(
1366 graph
, comp_cls
, name
, params
, NULL
, component
);
1369 enum bt_graph_status
1370 bt_graph_add_filter_component_with_init_method_data(
1371 struct bt_graph
*graph
,
1372 const struct bt_component_class_filter
*comp_cls
,
1373 const char *name
, const struct bt_value
*params
,
1374 void *init_method_data
,
1375 const struct bt_component_filter
**component
)
1377 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1378 return add_component_with_init_method_data(graph
,
1379 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1380 name
, params
, init_method_data
, (void *) component
);
1383 enum bt_graph_status
bt_graph_add_filter_component(
1384 struct bt_graph
*graph
,
1385 const struct bt_component_class_filter
*comp_cls
,
1386 const char *name
, const struct bt_value
*params
,
1387 const struct bt_component_filter
**component
)
1389 return bt_graph_add_filter_component_with_init_method_data(
1390 graph
, comp_cls
, name
, params
, NULL
, component
);
1393 enum bt_graph_status
1394 bt_graph_add_sink_component_with_init_method_data(
1395 struct bt_graph
*graph
,
1396 const struct bt_component_class_sink
*comp_cls
,
1397 const char *name
, const struct bt_value
*params
,
1398 void *init_method_data
,
1399 const struct bt_component_sink
**component
)
1401 BT_ASSERT_PRE_NON_NULL(comp_cls
, "Component class");
1402 return add_component_with_init_method_data(graph
,
1403 (void *) comp_cls
, (comp_init_method_t
) comp_cls
->methods
.init
,
1404 name
, params
, init_method_data
, (void *) component
);
1407 enum bt_graph_status
bt_graph_add_sink_component(
1408 struct bt_graph
*graph
,
1409 const struct bt_component_class_sink
*comp_cls
,
1410 const char *name
, const struct bt_value
*params
,
1411 const struct bt_component_sink
**component
)
1413 return bt_graph_add_sink_component_with_init_method_data(
1414 graph
, comp_cls
, name
, params
, NULL
, component
);
1418 int bt_graph_remove_unconnected_component(struct bt_graph
*graph
,
1419 struct bt_component
*component
)
1421 bool init_can_consume
;
1427 BT_ASSERT(component
);
1428 BT_ASSERT(component
->base
.ref_count
== 0);
1429 BT_ASSERT(bt_component_borrow_graph(component
) == graph
);
1431 init_can_consume
= graph
->can_consume
;
1432 count
= bt_component_get_input_port_count(component
);
1434 for (i
= 0; i
< count
; i
++) {
1435 struct bt_port
*port
= (void *)
1436 bt_component_borrow_input_port_by_index(component
, i
);
1440 if (bt_port_is_connected(port
)) {
1441 BT_LIB_LOGW("Cannot remove component from graph: "
1442 "an input port is connected: "
1443 "%![graph-]+g, %![comp-]+c, %![port-]+p",
1444 graph
, component
, port
);
1449 count
= bt_component_get_output_port_count(component
);
1451 for (i
= 0; i
< count
; i
++) {
1452 struct bt_port
*port
= (void *)
1453 bt_component_borrow_output_port_by_index(component
, i
);
1457 if (bt_port_is_connected(port
)) {
1458 BT_LIB_LOGW("Cannot remove component from graph: "
1459 "an output port is connected: "
1460 "%![graph-]+g, %![comp-]+c, %![port-]+p",
1461 graph
, component
, port
);
1466 bt_graph_set_can_consume(graph
, false);
1468 /* Possibly remove from sinks to consume */
1469 (void) g_queue_remove(graph
->sinks_to_consume
, component
);
1471 if (graph
->sinks_to_consume
->length
== 0) {
1472 graph
->has_sink
= false;
1476 * This calls bt_object_try_spec_release() on the component, and
1477 * since its reference count is 0, its destructor is called. Its
1478 * destructor calls the user's finalization method (if set).
1480 g_ptr_array_remove(graph
->components
, component
);
1487 (void) init_can_consume
;
1488 bt_graph_set_can_consume(graph
, init_can_consume
);
1493 void bt_graph_add_message(struct bt_graph
*graph
,
1494 struct bt_message
*msg
)
1500 * It's okay not to take a reference because, when a
1501 * message's reference count drops to 0, either:
1503 * * It is recycled back to one of this graph's pool.
1504 * * It is destroyed because it doesn't have any link to any
1505 * graph, which means the original graph is already destroyed.
1507 g_ptr_array_add(graph
->messages
, msg
);
1510 void bt_graph_get_ref(const struct bt_graph
*graph
)
1512 bt_object_get_ref(graph
);
1515 void bt_graph_put_ref(const struct bt_graph
*graph
)
1517 bt_object_put_ref(graph
);