4 * Babeltrace Plugin Component Graph
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28 #define BT_LOG_TAG "GRAPH"
29 #include <babeltrace/lib-logging-internal.h>
31 #include <babeltrace/graph/component-internal.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.h>
36 #include <babeltrace/graph/component-filter.h>
37 #include <babeltrace/graph/port.h>
38 #include <babeltrace/compiler-internal.h>
39 #include <babeltrace/types.h>
40 #include <babeltrace/values.h>
41 #include <babeltrace/values-internal.h>
45 struct bt_graph_listener
{
47 bt_graph_listener_removed removed
;
52 int init_listeners_array(GArray
**listeners
)
57 *listeners
= g_array_new(FALSE
, TRUE
, sizeof(struct bt_graph_listener
));
59 BT_LOGE_STR("Failed to allocate one GArray.");
69 void call_remove_listeners(GArray
*listeners
)
73 for (i
= 0; i
< listeners
->len
; i
++) {
74 struct bt_graph_listener listener
=
75 g_array_index(listeners
, struct bt_graph_listener
, i
);
77 if (listener
.removed
) {
78 listener
.removed(listener
.data
);
84 void bt_graph_destroy(struct bt_object
*obj
)
86 struct bt_graph
*graph
= container_of(obj
,
87 struct bt_graph
, base
);
90 * The graph's reference count is 0 if we're here. Increment
91 * it to avoid a double-destroy (possibly infinitely recursive)
94 * 1. We put and destroy a connection.
95 * 2. This connection's destructor finalizes its active
96 * notification iterators.
97 * 3. A notification iterator's finalization function gets a
98 * new reference on its component (reference count goes from
100 * 4. Since this component's reference count goes to 1, it takes
101 * a reference on its parent (this graph). This graph's
102 * reference count goes from 0 to 1.
103 * 5. The notification iterator's finalization function puts its
104 * component reference (reference count goes from 1 to 0).
105 * 6. Since this component's reference count goes from 1 to 0,
106 * it puts its parent (this graph). This graph's reference
107 * count goes from 1 to 0.
108 * 7. Since this graph's reference count goes from 1 to 0,
109 * its destructor is called (this function).
111 * With the incrementation below, the graph's reference count at
112 * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This
113 * ensures that this function is not called two times.
115 BT_LOGD("Destroying graph: addr=%p", graph
);
116 obj
->ref_count
.count
++;
119 * Cancel the graph to disallow some operations, like creating
120 * notification iterators and adding ports to components.
122 (void) bt_graph_cancel(graph
);
124 /* Call all remove listeners */
125 call_remove_listeners(graph
->listeners
.port_added
);
126 call_remove_listeners(graph
->listeners
.port_removed
);
127 call_remove_listeners(graph
->listeners
.ports_connected
);
128 call_remove_listeners(graph
->listeners
.ports_disconnected
);
130 if (graph
->connections
) {
131 BT_LOGD_STR("Destroying connections.");
132 g_ptr_array_free(graph
->connections
, TRUE
);
134 if (graph
->components
) {
135 BT_LOGD_STR("Destroying components.");
136 g_ptr_array_free(graph
->components
, TRUE
);
138 if (graph
->sinks_to_consume
) {
139 g_queue_free(graph
->sinks_to_consume
);
142 if (graph
->listeners
.port_added
) {
143 g_array_free(graph
->listeners
.port_added
, TRUE
);
146 if (graph
->listeners
.port_removed
) {
147 g_array_free(graph
->listeners
.port_removed
, TRUE
);
150 if (graph
->listeners
.ports_connected
) {
151 g_array_free(graph
->listeners
.ports_connected
, TRUE
);
154 if (graph
->listeners
.ports_disconnected
) {
155 g_array_free(graph
->listeners
.ports_disconnected
, TRUE
);
161 struct bt_graph
*bt_graph_create(void)
163 struct bt_graph
*graph
;
166 BT_LOGD_STR("Creating graph object.");
167 graph
= g_new0(struct bt_graph
, 1);
169 BT_LOGE_STR("Failed to allocate one graph.");
173 bt_object_init(graph
, bt_graph_destroy
);
175 graph
->connections
= g_ptr_array_new_with_free_func(bt_object_release
);
176 if (!graph
->connections
) {
177 BT_LOGE_STR("Failed to allocate one GPtrArray.");
180 graph
->components
= g_ptr_array_new_with_free_func(bt_object_release
);
181 if (!graph
->components
) {
182 BT_LOGE_STR("Failed to allocate one GPtrArray.");
185 graph
->sinks_to_consume
= g_queue_new();
186 if (!graph
->sinks_to_consume
) {
187 BT_LOGE_STR("Failed to allocate one GQueue.");
191 graph
->can_consume
= BT_TRUE
;
192 ret
= init_listeners_array(&graph
->listeners
.port_added
);
194 BT_LOGE_STR("Cannot create the \"port added\" listener array.");
198 ret
= init_listeners_array(&graph
->listeners
.port_removed
);
200 BT_LOGE_STR("Cannot create the \"port removed\" listener array.");
204 ret
= init_listeners_array(&graph
->listeners
.ports_connected
);
206 BT_LOGE_STR("Cannot create the \"port connected\" listener array.");
210 ret
= init_listeners_array(&graph
->listeners
.ports_disconnected
);
212 BT_LOGE_STR("Cannot create the \"port disconneted\" listener array.");
216 BT_LOGD("Created graph object: addr=%p", graph
);
225 enum bt_graph_status
bt_graph_connect_ports(struct bt_graph
*graph
,
226 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
,
227 struct bt_connection
**user_connection
)
229 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
230 struct bt_connection
*connection
= NULL
;
231 struct bt_graph
*upstream_graph
= NULL
;
232 struct bt_graph
*downstream_graph
= NULL
;
233 struct bt_component
*upstream_component
= NULL
;
234 struct bt_component
*downstream_component
= NULL
;
235 enum bt_component_status component_status
;
236 const bt_bool init_can_consume
= graph
->can_consume
;
239 BT_LOGW_STR("Invalid parameter: graph is NULL.");
240 status
= BT_GRAPH_STATUS_INVALID
;
244 if (!upstream_port
) {
245 BT_LOGW_STR("Invalid parameter: upstream port is NULL.");
246 status
= BT_GRAPH_STATUS_INVALID
;
250 if (!downstream_port
) {
251 BT_LOGW_STR("Invalid parameter: downstream port is NULL.");
252 status
= BT_GRAPH_STATUS_INVALID
;
256 BT_LOGD("Connecting component ports within graph: "
258 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
259 "downstream-port-addr=%p, downstream-port-name=\"%s\"",
260 graph
, upstream_port
, bt_port_get_name(upstream_port
),
261 downstream_port
, bt_port_get_name(downstream_port
));
263 if (graph
->canceled
) {
264 BT_LOGW_STR("Invalid parameter: graph is canceled.");
265 status
= BT_GRAPH_STATUS_CANCELED
;
269 graph
->can_consume
= BT_FALSE
;
271 /* Ensure appropriate types for upstream and downstream ports. */
272 if (bt_port_get_type(upstream_port
) != BT_PORT_TYPE_OUTPUT
) {
273 BT_LOGW_STR("Invalid parameter: upstream port is not an output port.");
274 status
= BT_GRAPH_STATUS_INVALID
;
277 if (bt_port_get_type(downstream_port
) != BT_PORT_TYPE_INPUT
) {
278 BT_LOGW_STR("Invalid parameter: downstream port is not an input port.");
279 status
= BT_GRAPH_STATUS_INVALID
;
283 /* Ensure that both ports are currently unconnected. */
284 if (bt_port_is_connected(upstream_port
)) {
285 BT_LOGW_STR("Invalid parameter: upstream port is already connected.");
286 status
= BT_GRAPH_STATUS_INVALID
;
290 if (bt_port_is_connected(downstream_port
)) {
291 BT_LOGW_STR("Invalid parameter: downstream port is already connected.");
292 status
= BT_GRAPH_STATUS_INVALID
;
297 * Ensure that both ports are still attached to their creating
300 upstream_component
= bt_port_get_component(upstream_port
);
301 if (!upstream_component
) {
302 BT_LOGW_STR("Invalid parameter: upstream port is loose (does not belong to a component)");
303 status
= BT_GRAPH_STATUS_INVALID
;
307 downstream_component
= bt_port_get_component(downstream_port
);
308 if (!downstream_component
) {
309 BT_LOGW_STR("Invalid parameter: downstream port is loose (does not belong to a component)");
310 status
= BT_GRAPH_STATUS_INVALID
;
314 BT_LOGD("Connecting component ports: "
315 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
316 "downstream-comp-addr=%p, downstream-comp-name=\"%s\"",
317 upstream_component
, bt_component_get_name(upstream_component
),
318 downstream_component
, bt_component_get_name(downstream_component
));
321 * At this point the ports are not connected yet. Both
322 * components need to accept an eventual connection to their
323 * port by the other port before we continue.
325 BT_LOGD_STR("Asking upstream component to accept the connection.");
326 component_status
= bt_component_accept_port_connection(
327 upstream_component
, upstream_port
, downstream_port
);
328 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
329 if (component_status
== BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
) {
330 BT_LOGD_STR("Upstream component refused the connection.");
332 BT_LOGW("Cannot ask upstream component to accept the connection: "
333 "status=%s", bt_component_status_string(component_status
));
336 status
= bt_graph_status_from_component_status(
341 BT_LOGD_STR("Asking downstream component to accept the connection.");
342 component_status
= bt_component_accept_port_connection(
343 downstream_component
, downstream_port
, upstream_port
);
344 if (component_status
!= BT_COMPONENT_STATUS_OK
) {
345 if (component_status
== BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION
) {
346 BT_LOGD_STR("Downstream component refused the connection.");
348 BT_LOGW("Cannot ask downstream component to accept the connection: "
349 "status=%s", bt_component_status_string(component_status
));
352 status
= bt_graph_status_from_component_status(
357 BT_LOGD_STR("Creating connection.");
358 connection
= bt_connection_create(graph
, upstream_port
,
361 BT_LOGW("Cannot create connection object.");
362 status
= BT_GRAPH_STATUS_NOMEM
;
366 BT_LOGD("Connection object created: conn-addr=%p", connection
);
369 * Ownership of upstream_component/downstream_component and of
370 * the connection object is transferred to the graph.
372 g_ptr_array_add(graph
->connections
, connection
);
375 * Notify both components that their port is connected.
377 BT_LOGD_STR("Notifying upstream component that its port is connected.");
378 bt_component_port_connected(upstream_component
, upstream_port
,
380 BT_LOGD_STR("Notifying downstream component that its port is connected.");
381 bt_component_port_connected(downstream_component
, downstream_port
,
385 * Notify the graph's creator that both ports are connected.
387 BT_LOGD_STR("Notifying graph's user that new component ports are connected.");
388 bt_graph_notify_ports_connected(graph
, upstream_port
, downstream_port
);
389 BT_LOGD("Connected component ports within graph: "
391 "upstream-comp-addr=%p, upstream-comp-name=\"%s\", "
392 "downstream-comp-addr=%p, downstream-comp-name=\"%s\", "
393 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
394 "downstream-port-addr=%p, downstream-port-name=\"%s\"",
396 upstream_component
, bt_component_get_name(upstream_component
),
397 downstream_component
, bt_component_get_name(downstream_component
),
398 upstream_port
, bt_port_get_name(upstream_port
),
399 downstream_port
, bt_port_get_name(downstream_port
));
401 if (user_connection
) {
402 /* Move reference to user */
403 *user_connection
= connection
;
408 bt_put(upstream_graph
);
409 bt_put(downstream_graph
);
410 bt_put(upstream_component
);
411 bt_put(downstream_component
);
413 graph
->can_consume
= init_can_consume
;
418 enum bt_graph_status
consume_graph_sink(struct bt_component
*sink
)
420 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
421 enum bt_component_status comp_status
;
424 comp_status
= bt_component_sink_consume(sink
);
425 BT_LOGV("Consumed from sink: addr=%p, name=\"%s\", status=%s",
426 sink
, bt_component_get_name(sink
),
427 bt_component_status_string(comp_status
));
429 switch (comp_status
) {
430 case BT_COMPONENT_STATUS_OK
:
432 case BT_COMPONENT_STATUS_END
:
433 status
= BT_GRAPH_STATUS_END
;
435 case BT_COMPONENT_STATUS_AGAIN
:
436 status
= BT_GRAPH_STATUS_AGAIN
;
438 case BT_COMPONENT_STATUS_INVALID
:
439 status
= BT_GRAPH_STATUS_INVALID
;
442 status
= BT_GRAPH_STATUS_ERROR
;
450 * `node` is removed from the queue of sinks to consume when passed to
451 * this function. This function adds it back to the queue if there's
452 * still something to consume afterwards.
455 enum bt_graph_status
consume_sink_node(struct bt_graph
*graph
,
458 enum bt_graph_status status
;
459 struct bt_component
*sink
;
462 status
= consume_graph_sink(sink
);
463 if (status
!= BT_GRAPH_STATUS_END
) {
464 g_queue_push_tail_link(graph
->sinks_to_consume
, node
);
468 /* End reached, the node is not added back to the queue and free'd. */
469 g_queue_delete_link(graph
->sinks_to_consume
, node
);
471 /* Don't forward an END status if there are sinks left to consume. */
472 if (!g_queue_is_empty(graph
->sinks_to_consume
)) {
473 status
= BT_GRAPH_STATUS_OK
;
478 BT_LOGV("Consumed sink node: status=%s", bt_graph_status_string(status
));
483 enum bt_graph_status
bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
484 struct bt_component
*sink
)
486 enum bt_graph_status status
;
490 BT_LOGV("Making specific sink consume: addr=%p, "
491 "comp-addr=%p, comp-name=\"%s\"",
492 graph
, sink
, bt_component_get_name(sink
));
494 assert(bt_component_borrow_graph(sink
) == graph
);
496 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
497 BT_LOGV_STR("Graph's sink queue is empty: end of graph.");
498 status
= BT_GRAPH_STATUS_END
;
502 index
= g_queue_index(graph
->sinks_to_consume
, sink
);
504 BT_LOGV_STR("Sink is not marked as consumable: sink is ended.");
505 status
= BT_GRAPH_STATUS_END
;
509 sink_node
= g_queue_pop_nth_link(graph
->sinks_to_consume
, index
);
511 status
= consume_sink_node(graph
, sink_node
);
518 enum bt_graph_status
bt_graph_consume_no_check(struct bt_graph
*graph
)
520 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
521 struct bt_component
*sink
;
524 BT_LOGV("Making next sink consume: addr=%p", graph
);
526 if (!graph
->has_sink
) {
527 BT_LOGW_STR("Graph has no sink component.");
528 status
= BT_GRAPH_STATUS_NO_SINK
;
532 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
533 BT_LOGV_STR("Graph's sink queue is empty: end of graph.");
534 status
= BT_GRAPH_STATUS_END
;
538 current_node
= g_queue_pop_head_link(graph
->sinks_to_consume
);
539 sink
= current_node
->data
;
540 BT_LOGV("Chose next sink to consume: comp-addr=%p, comp-name=\"%s\"",
541 sink
, bt_component_get_name(sink
));
542 status
= consume_sink_node(graph
, current_node
);
548 enum bt_graph_status
bt_graph_consume(struct bt_graph
*graph
)
550 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
553 BT_LOGW_STR("Invalid parameter: graph is NULL.");
554 status
= BT_GRAPH_STATUS_INVALID
;
558 if (graph
->canceled
) {
559 BT_LOGW("Invalid parameter: graph is canceled: "
560 "graph-addr=%p", graph
);
561 status
= BT_GRAPH_STATUS_CANCELED
;
565 if (!graph
->can_consume
) {
566 BT_LOGW_STR("Cannot consume graph in its current state.");
567 status
= BT_GRAPH_STATUS_CANNOT_CONSUME
;
571 graph
->can_consume
= BT_FALSE
;
572 status
= bt_graph_consume_no_check(graph
);
573 graph
->can_consume
= BT_TRUE
;
579 enum bt_graph_status
bt_graph_run(struct bt_graph
*graph
)
581 enum bt_graph_status status
= BT_GRAPH_STATUS_OK
;
584 BT_LOGW_STR("Invalid parameter: graph is NULL.");
585 status
= BT_GRAPH_STATUS_INVALID
;
589 if (graph
->canceled
) {
590 BT_LOGW("Invalid parameter: graph is canceled: "
591 "graph-addr=%p", graph
);
592 status
= BT_GRAPH_STATUS_CANCELED
;
596 if (!graph
->can_consume
) {
597 BT_LOGW_STR("Cannot run graph in its current state.");
598 status
= BT_GRAPH_STATUS_CANNOT_CONSUME
;
602 graph
->can_consume
= BT_FALSE
;
603 BT_LOGV("Running graph: addr=%p", graph
);
607 * Check if the graph is canceled at each iteration. If
608 * the graph was canceled by another thread or by a
609 * signal, this is not a warning nor an error, it was
610 * intentional: log with a DEBUG level only.
612 if (graph
->canceled
) {
613 BT_LOGD("Stopping the graph: graph is canceled: "
614 "graph-addr=%p", graph
);
615 status
= BT_GRAPH_STATUS_CANCELED
;
619 status
= bt_graph_consume_no_check(graph
);
620 if (status
== BT_GRAPH_STATUS_AGAIN
) {
622 * If AGAIN is received and there are multiple
623 * sinks, go ahead and consume from the next
626 * However, in the case where a single sink is
627 * left, the caller can decide to busy-wait and
628 * call bt_graph_run() continuously until the
629 * source is ready or it can decide to sleep for
630 * an arbitrary amount of time.
632 if (graph
->sinks_to_consume
->length
> 1) {
633 status
= BT_GRAPH_STATUS_OK
;
635 } else if (status
== BT_GRAPH_STATUS_NO_SINK
) {
638 } while (status
== BT_GRAPH_STATUS_OK
);
640 if (g_queue_is_empty(graph
->sinks_to_consume
)) {
641 status
= BT_GRAPH_STATUS_END
;
645 BT_LOGV("Graph ran: status=%s", bt_graph_status_string(status
));
646 graph
->can_consume
= BT_TRUE
;
651 int add_listener(GArray
*listeners
, void *func
, void *removed
, void *data
)
653 struct bt_graph_listener listener
= {
659 g_array_append_val(listeners
, listener
);
660 return listeners
->len
- 1;
663 int bt_graph_add_port_added_listener(
664 struct bt_graph
*graph
,
665 bt_graph_port_added_listener listener
,
666 bt_graph_listener_removed listener_removed
, void *data
)
671 BT_LOGW_STR("Invalid parameter: graph is NULL.");
676 if (graph
->in_remove_listener
) {
677 BT_LOGW("Cannot call this function during the execution of a remove listener: "
684 BT_LOGW_STR("Invalid parameter: listener is NULL.");
689 ret
= add_listener(graph
->listeners
.port_added
, listener
,
690 listener_removed
, data
);
691 BT_LOGV("Added \"port added\" listener to graph: "
692 "graph-addr=%p, listener-addr=%p, pos=%d",
693 graph
, listener
, ret
);
699 int bt_graph_add_port_removed_listener(
700 struct bt_graph
*graph
,
701 bt_graph_port_removed_listener listener
,
702 bt_graph_listener_removed listener_removed
, void *data
)
707 BT_LOGW_STR("Invalid parameter: graph is NULL.");
712 if (graph
->in_remove_listener
) {
713 BT_LOGW("Cannot call this function during the execution of a remove listener: "
720 BT_LOGW_STR("Invalid parameter: listener is NULL.");
725 ret
= add_listener(graph
->listeners
.port_removed
, listener
,
726 listener_removed
, data
);
727 BT_LOGV("Added \"port removed\" listener to graph: "
728 "graph-addr=%p, listener-addr=%p, pos=%d",
729 graph
, listener
, ret
);
735 int bt_graph_add_ports_connected_listener(
736 struct bt_graph
*graph
,
737 bt_graph_ports_connected_listener listener
,
738 bt_graph_listener_removed listener_removed
, void *data
)
743 BT_LOGW_STR("Invalid parameter: graph is NULL.");
748 if (graph
->in_remove_listener
) {
749 BT_LOGW("Cannot call this function during the execution of a remove listener: "
756 BT_LOGW_STR("Invalid parameter: listener is NULL.");
761 ret
= add_listener(graph
->listeners
.ports_connected
, listener
,
762 listener_removed
, data
);
763 BT_LOGV("Added \"port connected\" listener to graph: "
764 "graph-addr=%p, listener-addr=%p, pos=%d",
765 graph
, listener
, ret
);
771 int bt_graph_add_ports_disconnected_listener(
772 struct bt_graph
*graph
,
773 bt_graph_ports_disconnected_listener listener
,
774 bt_graph_listener_removed listener_removed
, void *data
)
779 BT_LOGW_STR("Invalid parameter: graph is NULL.");
784 if (graph
->in_remove_listener
) {
785 BT_LOGW("Cannot call this function during the execution of a remove listener: "
792 BT_LOGW_STR("Invalid parameter: listener is NULL.");
797 ret
= add_listener(graph
->listeners
.ports_disconnected
, listener
,
798 listener_removed
, data
);
799 BT_LOGV("Added \"port disconnected\" listener to graph: "
800 "graph-addr=%p, listener-addr=%p, pos=%d",
801 graph
, listener
, ret
);
808 void bt_graph_notify_port_added(struct bt_graph
*graph
, struct bt_port
*port
)
812 BT_LOGV("Notifying graph listeners that a port was added: "
813 "graph-addr=%p, port-addr=%p, port-name=\"%s\"",
814 graph
, port
, bt_port_get_name(port
));
816 for (i
= 0; i
< graph
->listeners
.port_added
->len
; i
++) {
817 struct bt_graph_listener listener
=
818 g_array_index(graph
->listeners
.port_added
,
819 struct bt_graph_listener
, i
);
820 bt_graph_port_added_listener func
= listener
.func
;
823 func(port
, listener
.data
);
828 void bt_graph_notify_port_removed(struct bt_graph
*graph
,
829 struct bt_component
*comp
, struct bt_port
*port
)
833 BT_LOGV("Notifying graph listeners that a port was removed: "
834 "graph-addr=%p, port-addr=%p, port-name=\"%s\"",
835 graph
, port
, bt_port_get_name(port
));
837 for (i
= 0; i
< graph
->listeners
.port_removed
->len
; i
++) {
838 struct bt_graph_listener listener
=
839 g_array_index(graph
->listeners
.port_removed
,
840 struct bt_graph_listener
, i
);
841 bt_graph_port_removed_listener func
= listener
.func
;
844 func(comp
, port
, listener
.data
);
849 void bt_graph_notify_ports_connected(struct bt_graph
*graph
,
850 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
)
854 BT_LOGV("Notifying graph listeners that two ports were connected: "
856 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
857 "downstream-port-addr=%p, downstream-port-name=\"%s\"",
858 graph
, upstream_port
, bt_port_get_name(upstream_port
),
859 downstream_port
, bt_port_get_name(downstream_port
));
861 for (i
= 0; i
< graph
->listeners
.ports_connected
->len
; i
++) {
862 struct bt_graph_listener listener
=
863 g_array_index(graph
->listeners
.ports_connected
,
864 struct bt_graph_listener
, i
);
865 bt_graph_ports_connected_listener func
= listener
.func
;
868 func(upstream_port
, downstream_port
, listener
.data
);
873 void bt_graph_notify_ports_disconnected(struct bt_graph
*graph
,
874 struct bt_component
*upstream_comp
,
875 struct bt_component
*downstream_comp
,
876 struct bt_port
*upstream_port
, struct bt_port
*downstream_port
)
880 BT_LOGV("Notifying graph listeners that two ports were disconnected: "
882 "upstream-port-addr=%p, upstream-port-name=\"%s\", "
883 "downstream-port-addr=%p, downstream-port-name=\"%s\"",
884 graph
, upstream_port
, bt_port_get_name(upstream_port
),
885 downstream_port
, bt_port_get_name(downstream_port
));
887 for (i
= 0; i
< graph
->listeners
.ports_disconnected
->len
; i
++) {
888 struct bt_graph_listener listener
=
889 g_array_index(graph
->listeners
.ports_disconnected
,
890 struct bt_graph_listener
, i
);
891 bt_graph_ports_disconnected_listener func
= listener
.func
;
894 func(upstream_comp
, downstream_comp
, upstream_port
,
895 downstream_port
, listener
.data
);
899 enum bt_graph_status
bt_graph_cancel(struct bt_graph
*graph
)
901 enum bt_graph_status ret
= BT_GRAPH_STATUS_OK
;
904 BT_LOGW_STR("Invalid parameter: graph is NULL.");
905 ret
= BT_GRAPH_STATUS_INVALID
;
909 graph
->canceled
= BT_TRUE
;
910 BT_LOGV("Canceled graph: addr=%p", graph
);
916 bt_bool
bt_graph_is_canceled(struct bt_graph
*graph
)
918 bt_bool canceled
= BT_FALSE
;
921 BT_LOGW_STR("Invalid parameter: graph is NULL.");
925 canceled
= graph
->canceled
;
932 void bt_graph_remove_connection(struct bt_graph
*graph
,
933 struct bt_connection
*connection
)
937 BT_LOGV("Removing graph's connection: graph-addr=%p, conn-addr=%p",
939 g_ptr_array_remove(graph
->connections
, connection
);
942 enum bt_graph_status
bt_graph_add_component_with_init_method_data(
943 struct bt_graph
*graph
,
944 struct bt_component_class
*component_class
,
945 const char *name
, struct bt_value
*params
,
946 void *init_method_data
,
947 struct bt_component
**user_component
)
949 enum bt_graph_status graph_status
= BT_GRAPH_STATUS_OK
;
950 enum bt_component_status comp_status
;
951 struct bt_component
*component
= NULL
;
952 enum bt_component_class_type type
;
954 const bt_bool init_can_consume
= graph
->can_consume
;
959 BT_LOGW_STR("Invalid parameter: graph is NULL.");
960 graph_status
= BT_GRAPH_STATUS_INVALID
;
964 if (!component_class
) {
965 BT_LOGW_STR("Invalid parameter: component class is NULL.");
966 graph_status
= BT_GRAPH_STATUS_INVALID
;
970 graph
->can_consume
= BT_FALSE
;
971 type
= bt_component_class_get_type(component_class
);
972 BT_LOGD("Adding component to graph: "
973 "graph-addr=%p, comp-cls-addr=%p, "
974 "comp-cls-type=%s, name=\"%s\", params-addr=%p, "
975 "init-method-data-addr=%p",
976 graph
, component_class
, bt_component_class_type_string(type
),
977 name
, params
, init_method_data
);
980 BT_LOGW_STR("Invalid parameter: name is NULL.");
981 graph_status
= BT_GRAPH_STATUS_INVALID
;
985 if (graph
->canceled
) {
986 BT_LOGW_STR("Invalid parameter: graph is canceled.");
987 graph_status
= BT_GRAPH_STATUS_CANCELED
;
991 if (type
!= BT_COMPONENT_CLASS_TYPE_SOURCE
&&
992 type
!= BT_COMPONENT_CLASS_TYPE_FILTER
&&
993 type
!= BT_COMPONENT_CLASS_TYPE_SINK
) {
994 BT_LOGW("Invalid parameter: unknown component class type: "
996 graph_status
= BT_GRAPH_STATUS_INVALID
;
1000 for (i
= 0; i
< graph
->components
->len
; i
++) {
1001 void *other_comp
= graph
->components
->pdata
[i
];
1003 if (strcmp(name
, bt_component_get_name(other_comp
)) == 0) {
1004 BT_LOGW("Invalid parameter: another component with the same name already exists in the graph: "
1005 "other-comp-addr=%p, name=\"%s\"",
1007 graph_status
= BT_GRAPH_STATUS_INVALID
;
1013 * Parameters must be a map value, but we create a convenient
1014 * empty one if it's NULL.
1017 if (!bt_value_is_map(params
)) {
1018 BT_LOGW("Invalid parameter: initialization parameters must be a map value: "
1020 bt_value_type_string(bt_value_get_type(params
)));
1021 graph_status
= BT_GRAPH_STATUS_INVALID
;
1025 params
= bt_value_map_create();
1027 BT_LOGE_STR("Cannot create map value object.");
1028 graph_status
= BT_GRAPH_STATUS_NOMEM
;
1033 comp_status
= bt_component_create(component_class
, name
, &component
);
1034 if (comp_status
!= BT_COMPONENT_STATUS_OK
) {
1035 BT_LOGE("Cannot create empty component object: status=%s",
1036 bt_component_status_string(comp_status
));
1037 graph_status
= bt_graph_status_from_component_status(
1043 * The user's initialization method needs to see that this
1044 * component is part of the graph. If the user method fails, we
1045 * immediately remove the component from the graph's components.
1047 g_ptr_array_add(graph
->components
, component
);
1048 bt_component_set_graph(component
, graph
);
1050 if (component_class
->methods
.init
) {
1051 BT_LOGD_STR("Calling user's initialization method.");
1052 comp_status
= component_class
->methods
.init(
1053 bt_private_component_from_component(component
), params
,
1055 BT_LOGD("User method returned: status=%s",
1056 bt_component_status_string(comp_status
));
1057 if (comp_status
!= BT_COMPONENT_STATUS_OK
) {
1058 BT_LOGW_STR("Initialization method failed.");
1059 graph_status
= bt_graph_status_from_component_status(
1061 bt_component_set_graph(component
, NULL
);
1062 g_ptr_array_remove_fast(graph
->components
, component
);
1068 * Mark the component as initialized so that its finalization
1069 * method is called when it is destroyed.
1071 component
->initialized
= true;
1074 * If it's a sink component, it needs to be part of the graph's
1075 * sink queue to be consumed by bt_graph_consume().
1077 if (bt_component_is_sink(component
)) {
1078 graph
->has_sink
= BT_TRUE
;
1079 g_queue_push_tail(graph
->sinks_to_consume
, component
);
1083 * Freeze the component class now that it's instantiated at
1086 BT_LOGD_STR("Freezing component class.");
1087 bt_component_class_freeze(component
->class);
1088 BT_LOGD("Added component to graph: "
1089 "graph-addr=%p, comp-cls-addr=%p, "
1090 "comp-cls-type=%s, name=\"%s\", params-addr=%p, "
1091 "init-method-data-addr=%p, comp-addr=%p",
1092 graph
, component_class
, bt_component_class_type_string(type
),
1093 name
, params
, init_method_data
, component
);
1095 if (user_component
) {
1096 /* Move reference to user */
1097 *user_component
= component
;
1104 graph
->can_consume
= init_can_consume
;
1105 return graph_status
;
1108 enum bt_graph_status
bt_graph_add_component(
1109 struct bt_graph
*graph
,
1110 struct bt_component_class
*component_class
,
1111 const char *name
, struct bt_value
*params
,
1112 struct bt_component
**component
)
1114 return bt_graph_add_component_with_init_method_data(graph
,
1115 component_class
, name
, params
, NULL
, component
);
1119 int bt_graph_remove_unconnected_component(struct bt_graph
*graph
,
1120 struct bt_component
*component
)
1122 const bt_bool init_can_consume
= graph
->can_consume
;
1129 assert(component
->base
.ref_count
.count
== 0);
1130 assert(bt_component_borrow_graph(component
) == graph
);
1132 count
= bt_component_get_input_port_count(component
);
1134 for (i
= 0; i
< count
; i
++) {
1135 struct bt_port
*port
=
1136 bt_component_get_input_port_by_index(component
, i
);
1141 if (bt_port_is_connected(port
)) {
1142 BT_LOGW("Cannot remove component from graph: "
1143 "an input port is connected: "
1144 "graph-addr=%p, comp-addr=%p, "
1145 "comp-name=\"%s\", connected-port-addr=%p, "
1146 "connected-port-name=\"%s\"",
1148 bt_component_get_name(component
),
1149 port
, bt_port_get_name(port
));
1154 count
= bt_component_get_output_port_count(component
);
1156 for (i
= 0; i
< count
; i
++) {
1157 struct bt_port
*port
=
1158 bt_component_get_output_port_by_index(component
, i
);
1163 if (bt_port_is_connected(port
)) {
1164 BT_LOGW("Cannot remove component from graph: "
1165 "an output port is connected: "
1166 "graph-addr=%p, comp-addr=%p, "
1167 "comp-name=\"%s\", connected-port-addr=%p, "
1168 "connected-port-name=\"%s\"",
1170 bt_component_get_name(component
),
1171 port
, bt_port_get_name(port
));
1176 graph
->can_consume
= BT_FALSE
;
1178 /* Possibly remove from sinks to consume */
1179 (void) g_queue_remove(graph
->sinks_to_consume
, component
);
1181 if (graph
->sinks_to_consume
->length
== 0) {
1182 graph
->has_sink
= BT_FALSE
;
1186 * This calls bt_object_release() on the component, and since
1187 * its reference count is 0, its destructor is called. Its
1188 * destructor calls the user's finalization method (if set).
1190 g_ptr_array_remove(graph
->components
, component
);
1197 graph
->can_consume
= init_can_consume
;