X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=lib%2Fgraph%2Fgraph.c;h=3b48c561b685718aab9702040d84b3f2cd15a3c2;hb=d6e69534ef08a2dd8bff9eb5af1eab63736b3d31;hp=5b5acae75054b481ef6ec1b44f05a95b2b100530;hpb=49682acd61d65c4986fc2b61c13d7d7a2d28127e;p=babeltrace.git diff --git a/lib/graph/graph.c b/lib/graph/graph.c index 5b5acae7..3b48c561 100644 --- a/lib/graph/graph.c +++ b/lib/graph/graph.c @@ -1,10 +1,6 @@ /* - * graph.c - * - * Babeltrace Plugin Component Graph - * + * Copyright 2017-2018 Philippe Proulx * Copyright 2017 Jérémie Galarneau - * Copyright 2017 Philippe Proulx * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -28,28 +24,93 @@ #define BT_LOG_TAG "GRAPH" #include +#include +#include #include +#include +#include #include #include #include -#include -#include -#include +#include +#include +#include +#include +#include +#include #include +#include #include +#include +#include +#include #include #include +typedef void (*port_added_func_t)(const void *, const void *, void *); + +typedef void (*port_removed_func_t)(const void *, const void *, void *); + +typedef void (*ports_connected_func_t)(const void *, const void *, const void *, + const void *, void *); + +typedef void (*ports_disconnected_func_t)(const void *, const void *, + const void *, const void *, void *); + +typedef enum bt_self_component_status (*comp_init_method_t)(const void *, + const void *, void *); + struct bt_graph_listener { - void *func; + bt_graph_listener_removed_func removed; void *data; }; +struct bt_graph_listener_port_added { + struct bt_graph_listener base; + port_added_func_t func; +}; + +struct bt_graph_listener_port_removed { + struct bt_graph_listener base; + port_removed_func_t func; +}; + +struct bt_graph_listener_ports_connected { + struct bt_graph_listener base; + ports_connected_func_t func; +}; + +struct bt_graph_listener_ports_disconnected { + struct bt_graph_listener base; + ports_disconnected_func_t func; +}; + +#define INIT_LISTENERS_ARRAY(_type, _listeners) \ + do { \ + _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \ + if (!(_listeners)) { \ + BT_LOGE_STR("Failed to allocate one GArray."); \ + } \ + } while (0) + +#define CALL_REMOVE_LISTENERS(_type, _listeners) \ + do { \ + size_t i; \ + \ + for (i = 0; i < (_listeners)->len; i++) { \ + _type *listener = \ + &g_array_index((_listeners), _type, i); \ + \ + if (listener->base.removed) { \ + listener->base.removed(listener->base.data); \ + } \ + } \ + } while (0) + static -void bt_graph_destroy(struct bt_object *obj) +void destroy_graph(struct bt_object *obj) { - struct bt_graph *graph = container_of(obj, - struct bt_graph, base); + struct bt_graph *graph = container_of(obj, struct bt_graph, base); /* * The graph's reference count is 0 if we're here. Increment @@ -58,14 +119,14 @@ void bt_graph_destroy(struct bt_object *obj) * * 1. We put and destroy a connection. * 2. This connection's destructor finalizes its active - * notification iterators. - * 3. A notification iterator's finalization function gets a + * message iterators. + * 3. A message iterator's finalization function gets a * new reference on its component (reference count goes from * 0 to 1). * 4. Since this component's reference count goes to 1, it takes * a reference on its parent (this graph). This graph's * reference count goes from 0 to 1. - * 5. The notification iterator's finalization function puts its + * 5. The message iterator's finalization function puts its * component reference (reference count goes from 1 to 0). * 6. Since this component's reference count goes from 1 to 0, * it puts its parent (this graph). This graph's reference @@ -77,61 +138,174 @@ void bt_graph_destroy(struct bt_object *obj) * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This * ensures that this function is not called two times. */ - BT_LOGD("Destroying graph: addr=%p", graph); - obj->ref_count.count++; + BT_LIB_LOGD("Destroying graph: %!+g", graph); + obj->ref_count++; /* * Cancel the graph to disallow some operations, like creating - * notification iterators and adding ports to components. + * message iterators and adding ports to components. */ - (void) bt_graph_cancel(graph); + (void) bt_graph_cancel((void *) graph); + + /* Call all remove listeners */ + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added, + graph->listeners.source_output_port_added); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added, + graph->listeners.filter_output_port_added); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added, + graph->listeners.filter_input_port_added); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added, + graph->listeners.sink_input_port_added); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_removed, + graph->listeners.source_output_port_removed); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_removed, + graph->listeners.filter_output_port_removed); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_removed, + graph->listeners.filter_input_port_removed); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_removed, + graph->listeners.sink_input_port_removed); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected, + graph->listeners.source_filter_ports_connected); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected, + graph->listeners.source_sink_ports_connected); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected, + graph->listeners.filter_sink_ports_connected); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_disconnected, + graph->listeners.source_filter_ports_disconnected); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_disconnected, + graph->listeners.source_sink_ports_disconnected); + CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_disconnected, + graph->listeners.filter_sink_ports_disconnected); + + if (graph->messages) { + g_ptr_array_free(graph->messages, TRUE); + graph->messages = NULL; + } if (graph->connections) { BT_LOGD_STR("Destroying connections."); g_ptr_array_free(graph->connections, TRUE); + graph->connections = NULL; } + if (graph->components) { BT_LOGD_STR("Destroying components."); g_ptr_array_free(graph->components, TRUE); + graph->components = NULL; } + if (graph->sinks_to_consume) { g_queue_free(graph->sinks_to_consume); + graph->sinks_to_consume = NULL; + } + + if (graph->listeners.source_output_port_added) { + g_array_free(graph->listeners.source_output_port_added, TRUE); + graph->listeners.source_output_port_added = NULL; + } + + if (graph->listeners.filter_output_port_added) { + g_array_free(graph->listeners.filter_output_port_added, TRUE); + graph->listeners.filter_output_port_added = NULL; } - if (graph->listeners.port_added) { - g_array_free(graph->listeners.port_added, TRUE); + if (graph->listeners.filter_input_port_added) { + g_array_free(graph->listeners.filter_input_port_added, TRUE); + graph->listeners.filter_input_port_added = NULL; } - if (graph->listeners.port_removed) { - g_array_free(graph->listeners.port_removed, TRUE); + if (graph->listeners.sink_input_port_added) { + g_array_free(graph->listeners.sink_input_port_added, TRUE); + graph->listeners.sink_input_port_added = NULL; } - if (graph->listeners.ports_connected) { - g_array_free(graph->listeners.ports_connected, TRUE); + if (graph->listeners.source_output_port_removed) { + g_array_free(graph->listeners.source_output_port_removed, TRUE); + graph->listeners.source_output_port_removed = NULL; } - if (graph->listeners.ports_disconnected) { - g_array_free(graph->listeners.ports_disconnected, TRUE); + if (graph->listeners.filter_output_port_removed) { + g_array_free(graph->listeners.filter_output_port_removed, TRUE); + graph->listeners.filter_output_port_removed = NULL; } + if (graph->listeners.filter_input_port_removed) { + g_array_free(graph->listeners.filter_input_port_removed, TRUE); + graph->listeners.filter_input_port_removed = NULL; + } + + if (graph->listeners.sink_input_port_removed) { + g_array_free(graph->listeners.sink_input_port_removed, TRUE); + graph->listeners.sink_input_port_removed = NULL; + } + + if (graph->listeners.source_filter_ports_connected) { + g_array_free(graph->listeners.source_filter_ports_connected, + TRUE); + graph->listeners.source_filter_ports_connected = NULL; + } + + if (graph->listeners.source_sink_ports_connected) { + g_array_free(graph->listeners.source_sink_ports_connected, + TRUE); + graph->listeners.source_sink_ports_connected = NULL; + } + + if (graph->listeners.filter_sink_ports_connected) { + g_array_free(graph->listeners.filter_sink_ports_connected, + TRUE); + graph->listeners.filter_sink_ports_connected = NULL; + } + + if (graph->listeners.source_filter_ports_disconnected) { + g_array_free(graph->listeners.source_filter_ports_disconnected, + TRUE); + graph->listeners.source_filter_ports_disconnected = NULL; + } + + if (graph->listeners.source_sink_ports_disconnected) { + g_array_free(graph->listeners.source_sink_ports_disconnected, + TRUE); + graph->listeners.source_sink_ports_disconnected = NULL; + } + + if (graph->listeners.filter_sink_ports_disconnected) { + g_array_free(graph->listeners.filter_sink_ports_disconnected, + TRUE); + graph->listeners.filter_sink_ports_disconnected = NULL; + } + + bt_object_pool_finalize(&graph->event_msg_pool); + bt_object_pool_finalize(&graph->packet_begin_msg_pool); + bt_object_pool_finalize(&graph->packet_end_msg_pool); g_free(graph); } static -int init_listeners_array(GArray **listeners) +void destroy_message_event(struct bt_message *msg, + struct bt_graph *graph) { - int ret = 0; + bt_message_event_destroy(msg); +} - assert(listeners); - *listeners = g_array_new(FALSE, TRUE, sizeof(struct bt_graph_listener)); - if (!*listeners) { - BT_LOGE_STR("Failed to allocate one GArray."); - ret = -1; - goto end; - } +static +void destroy_message_packet_begin(struct bt_message *msg, + struct bt_graph *graph) +{ + bt_message_packet_beginning_destroy(msg); +} -end: - return ret; +static +void destroy_message_packet_end(struct bt_message *msg, + struct bt_graph *graph) +{ + bt_message_packet_end_destroy(msg); +} + +static +void notify_message_graph_is_destroyed(struct bt_message *msg) +{ + bt_message_unlink_graph(msg); } struct bt_graph *bt_graph_create(void) @@ -146,14 +320,15 @@ struct bt_graph *bt_graph_create(void) goto end; } - bt_object_init(graph, bt_graph_destroy); - - graph->connections = g_ptr_array_new_with_free_func(bt_object_release); + bt_object_init_shared(&graph->base, destroy_graph); + graph->connections = g_ptr_array_new_with_free_func( + (GDestroyNotify) bt_object_try_spec_release); if (!graph->connections) { BT_LOGE_STR("Failed to allocate one GPtrArray."); goto error; } - graph->components = g_ptr_array_new_with_free_func(bt_object_release); + graph->components = g_ptr_array_new_with_free_func( + (GDestroyNotify) bt_object_try_spec_release); if (!graph->components) { BT_LOGE_STR("Failed to allocate one GPtrArray."); goto error; @@ -164,198 +339,249 @@ struct bt_graph *bt_graph_create(void) goto error; } - ret = init_listeners_array(&graph->listeners.port_added); - if (ret) { - BT_LOGE_STR("Cannot create the \"port added\" listener array."); + bt_graph_set_can_consume(graph, true); + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, + graph->listeners.source_output_port_added); + + if (!graph->listeners.source_output_port_added) { + ret = -1; goto error; } - ret = init_listeners_array(&graph->listeners.port_removed); - if (ret) { - BT_LOGE_STR("Cannot create the \"port removed\" listener array."); + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, + graph->listeners.filter_output_port_added); + + if (!graph->listeners.filter_output_port_added) { + ret = -1; goto error; } - ret = init_listeners_array(&graph->listeners.ports_connected); - if (ret) { - BT_LOGE_STR("Cannot create the \"port connected\" listener array."); + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, + graph->listeners.filter_input_port_added); + + if (!graph->listeners.filter_input_port_added) { + ret = -1; goto error; } - ret = init_listeners_array(&graph->listeners.ports_disconnected); - if (ret) { - BT_LOGE_STR("Cannot create the \"port disconneted\" listener array."); + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, + graph->listeners.sink_input_port_added); + + if (!graph->listeners.sink_input_port_added) { + ret = -1; goto error; } - BT_LOGD("Created graph object: addr=%p", graph); + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_removed, + graph->listeners.source_output_port_removed); -end: - return graph; -error: - BT_PUT(graph); - goto end; -} + if (!graph->listeners.source_output_port_removed) { + ret = -1; + goto error; + } -enum bt_graph_status bt_graph_connect_ports(struct bt_graph *graph, - struct bt_port *upstream_port, struct bt_port *downstream_port, - struct bt_connection **user_connection) -{ - enum bt_graph_status status = BT_GRAPH_STATUS_OK; - struct bt_connection *connection = NULL; - struct bt_graph *upstream_graph = NULL; - struct bt_graph *downstream_graph = NULL; - struct bt_component *upstream_component = NULL; - struct bt_component *downstream_component = NULL; - enum bt_component_status component_status; - bt_bool upstream_was_already_in_graph; - bt_bool downstream_was_already_in_graph; + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_removed, + graph->listeners.filter_output_port_removed); - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - status = BT_GRAPH_STATUS_INVALID; - goto end; + if (!graph->listeners.filter_output_port_removed) { + ret = -1; + goto error; } - if (!upstream_port) { - BT_LOGW_STR("Invalid parameter: upstream port is NULL."); - status = BT_GRAPH_STATUS_INVALID; - goto end; - } + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_removed, + graph->listeners.filter_input_port_removed); - if (!downstream_port) { - BT_LOGW_STR("Invalid parameter: downstream port is NULL."); - status = BT_GRAPH_STATUS_INVALID; - goto end; + if (!graph->listeners.filter_input_port_removed) { + ret = -1; + goto error; } - BT_LOGD("Connecting component ports within graph: " - "graph-addr=%p, " - "upstream-port-addr=%p, upstream-port-name=\"%s\", " - "downstream-port-addr=%p, downstream-port-name=\"%s\"", - graph, upstream_port, bt_port_get_name(upstream_port), - downstream_port, bt_port_get_name(downstream_port)); + INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_removed, + graph->listeners.sink_input_port_removed); - if (graph->canceled) { - BT_LOGW_STR("Invalid parameter: graph is canceled."); - status = BT_GRAPH_STATUS_CANCELED; - goto end; + if (!graph->listeners.sink_input_port_removed) { + ret = -1; + goto error; } - /* Ensure appropriate types for upstream and downstream ports. */ - if (bt_port_get_type(upstream_port) != BT_PORT_TYPE_OUTPUT) { - BT_LOGW_STR("Invalid parameter: upstream port is not an output port."); - status = BT_GRAPH_STATUS_INVALID; - goto end; + INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected, + graph->listeners.source_filter_ports_connected); + + if (!graph->listeners.source_filter_ports_connected) { + ret = -1; + goto error; } - if (bt_port_get_type(downstream_port) != BT_PORT_TYPE_INPUT) { - BT_LOGW_STR("Invalid parameter: downstream port is not an input port."); - status = BT_GRAPH_STATUS_INVALID; - goto end; + + INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected, + graph->listeners.source_sink_ports_connected); + + if (!graph->listeners.source_sink_ports_connected) { + ret = -1; + goto error; } - /* Ensure that both ports are currently unconnected. */ - if (bt_port_is_connected(upstream_port)) { - BT_LOGW_STR("Invalid parameter: upstream port is already connected."); - status = BT_GRAPH_STATUS_INVALID; - goto end; + INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected, + graph->listeners.filter_sink_ports_connected); + + if (!graph->listeners.filter_sink_ports_connected) { + ret = -1; + goto error; } - if (bt_port_is_connected(downstream_port)) { - BT_LOGW_STR("Invalid parameter: downstream port is already connected."); - status = BT_GRAPH_STATUS_INVALID; - goto end; + INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_disconnected, + graph->listeners.source_filter_ports_disconnected); + + if (!graph->listeners.source_filter_ports_disconnected) { + ret = -1; + goto error; } - /* - * Ensure that both ports are still attached to their creating - * component. - */ - upstream_component = bt_port_get_component(upstream_port); - if (!upstream_component) { - BT_LOGW_STR("Invalid parameter: upstream port is loose (does not belong to a component)"); - status = BT_GRAPH_STATUS_INVALID; - goto end; + INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_disconnected, + graph->listeners.source_sink_ports_disconnected); + + if (!graph->listeners.source_sink_ports_disconnected) { + ret = -1; + goto error; } - downstream_component = bt_port_get_component(downstream_port); - if (!downstream_component) { - BT_LOGW_STR("Invalid parameter: downstream port is loose (does not belong to a component)"); - status = BT_GRAPH_STATUS_INVALID; - goto end; + INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_disconnected, + graph->listeners.filter_sink_ports_disconnected); + + if (!graph->listeners.filter_sink_ports_disconnected) { + ret = -1; + goto error; } - BT_LOGD("Connecting component ports: " - "upstream-comp-addr=%p, upstream-comp-name=\"%s\", " - "downstream-comp-addr=%p, downstream-comp-name=\"%s\"", - upstream_component, bt_component_get_name(upstream_component), - downstream_component, bt_component_get_name(downstream_component)); + ret = bt_object_pool_initialize(&graph->event_msg_pool, + (bt_object_pool_new_object_func) bt_message_event_new, + (bt_object_pool_destroy_object_func) destroy_message_event, + graph); + if (ret) { + BT_LOGE("Failed to initialize event message pool: ret=%d", + ret); + goto error; + } - /* Ensure the components are not already part of another graph. */ - upstream_graph = bt_component_get_graph(upstream_component); - if (upstream_graph && (graph != upstream_graph)) { - BT_LOGW("Invalid parameter: upstream port's component is already part of another graph: " - "other-graph-addr=%p", upstream_graph); - status = BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH; - goto end; + ret = bt_object_pool_initialize(&graph->packet_begin_msg_pool, + (bt_object_pool_new_object_func) bt_message_packet_beginning_new, + (bt_object_pool_destroy_object_func) destroy_message_packet_begin, + graph); + if (ret) { + BT_LOGE("Failed to initialize packet beginning message pool: ret=%d", + ret); + goto error; } - upstream_was_already_in_graph = (graph == upstream_graph); - downstream_graph = bt_component_get_graph(downstream_component); - if (downstream_graph && (graph != downstream_graph)) { - BT_LOGW("Invalid parameter: downstream port's component is already part of another graph: " - "other-graph-addr=%p", downstream_graph); - status = BT_GRAPH_STATUS_ALREADY_IN_A_GRAPH; - goto end; + + ret = bt_object_pool_initialize(&graph->packet_end_msg_pool, + (bt_object_pool_new_object_func) bt_message_packet_end_new, + (bt_object_pool_destroy_object_func) destroy_message_packet_end, + graph); + if (ret) { + BT_LOGE("Failed to initialize packet end message pool: ret=%d", + ret); + goto error; } - downstream_was_already_in_graph = (graph == downstream_graph); + + graph->messages = g_ptr_array_new_with_free_func( + (GDestroyNotify) notify_message_graph_is_destroyed); + BT_LIB_LOGD("Created graph object: %!+g", graph); + +end: + return (void *) graph; + +error: + BT_OBJECT_PUT_REF_AND_RESET(graph); + goto end; +} + +enum bt_graph_status bt_graph_connect_ports( + struct bt_graph *graph, + const struct bt_port_output *upstream_port_out, + const struct bt_port_input *downstream_port_in, + const struct bt_connection **user_connection) +{ + enum bt_graph_status status = BT_GRAPH_STATUS_OK; + struct bt_connection *connection = NULL; + struct bt_port *upstream_port = (void *) upstream_port_out; + struct bt_port *downstream_port = (void *) downstream_port_in; + struct bt_component *upstream_component = NULL; + struct bt_component *downstream_component = NULL; + enum bt_self_component_status component_status; + bool init_can_consume; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(upstream_port, "Upstream port"); + BT_ASSERT_PRE_NON_NULL(downstream_port, "Downstream port port"); + BT_ASSERT_PRE(!graph->canceled, "Graph is canceled: %!+g", graph); + BT_ASSERT_PRE(!bt_port_is_connected(upstream_port), + "Upstream port is already connected: %!+p", upstream_port); + BT_ASSERT_PRE(!bt_port_is_connected(downstream_port), + "Downstream port is already connected: %!+p", downstream_port); + BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port), + "Upstream port does not belong to a component: %!+p", + upstream_port); + BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port), + "Downstream port does not belong to a component: %!+p", + downstream_port); + init_can_consume = graph->can_consume; + BT_LIB_LOGD("Connecting component ports within graph: " + "%![graph-]+g, %![up-port-]+p, %![down-port-]+p", + graph, upstream_port, downstream_port); + bt_graph_set_can_consume(graph, false); + upstream_component = bt_port_borrow_component_inline( + (void *) upstream_port); + downstream_component = bt_port_borrow_component_inline( + (void *) downstream_port); /* * At this point the ports are not connected yet. Both * components need to accept an eventual connection to their * port by the other port before we continue. */ - BT_LOGD_STR("Asking upstream component to accept the connection."); + BT_LIB_LOGD("Asking upstream component to accept the connection: " + "%![comp-]+c", upstream_component); component_status = bt_component_accept_port_connection( - upstream_component, upstream_port, downstream_port); - if (component_status != BT_COMPONENT_STATUS_OK) { - if (component_status == BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION) { + upstream_component, (void *) upstream_port, + (void *) downstream_port); + if (component_status != BT_SELF_COMPONENT_STATUS_OK) { + if (component_status == BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION) { BT_LOGD_STR("Upstream component refused the connection."); } else { BT_LOGW("Cannot ask upstream component to accept the connection: " - "status=%s", bt_component_status_string(component_status)); + "status=%s", bt_self_component_status_string(component_status)); } - status = bt_graph_status_from_component_status( - component_status); + status = (int) component_status; goto end; } - BT_LOGD_STR("Asking downstream component to accept the connection."); + BT_LIB_LOGD("Asking downstream component to accept the connection: " + "%![comp-]+c", downstream_component); component_status = bt_component_accept_port_connection( - downstream_component, downstream_port, upstream_port); - if (component_status != BT_COMPONENT_STATUS_OK) { - if (component_status == BT_COMPONENT_STATUS_REFUSE_PORT_CONNECTION) { + downstream_component, (void *) downstream_port, + (void *) upstream_port); + if (component_status != BT_SELF_COMPONENT_STATUS_OK) { + if (component_status == BT_SELF_COMPONENT_STATUS_REFUSE_PORT_CONNECTION) { BT_LOGD_STR("Downstream component refused the connection."); } else { BT_LOGW("Cannot ask downstream component to accept the connection: " - "status=%s", bt_component_status_string(component_status)); + "status=%s", bt_self_component_status_string(component_status)); } - status = bt_graph_status_from_component_status( - component_status); + status = (int) component_status; goto end; } BT_LOGD_STR("Creating connection."); - connection = bt_connection_create(graph, upstream_port, - downstream_port); + connection = bt_connection_create(graph, (void *) upstream_port, + (void *) downstream_port); if (!connection) { BT_LOGW("Cannot create connection object."); status = BT_GRAPH_STATUS_NOMEM; goto end; } - BT_LOGD("Connection object created: conn-addr=%p", connection); + BT_LIB_LOGD("Connection object created: %!+x", connection); /* * Ownership of upstream_component/downstream_component and of @@ -363,52 +589,56 @@ enum bt_graph_status bt_graph_connect_ports(struct bt_graph *graph, */ g_ptr_array_add(graph->connections, connection); - if (!upstream_was_already_in_graph) { - g_ptr_array_add(graph->components, upstream_component); - bt_component_set_graph(upstream_component, graph); - } - if (!downstream_was_already_in_graph) { - g_ptr_array_add(graph->components, downstream_component); - bt_component_set_graph(downstream_component, graph); - if (bt_component_get_class_type(downstream_component) == - BT_COMPONENT_CLASS_TYPE_SINK) { - g_queue_push_tail(graph->sinks_to_consume, - downstream_component); - } - } - - /* - * The graph is now the parent of these components which - * garantees their existence for the duration of the graph's - * lifetime. - */ - /* * Notify both components that their port is connected. */ - BT_LOGD_STR("Notifying upstream component that its port is connected."); - bt_component_port_connected(upstream_component, upstream_port, + BT_LIB_LOGD("Notifying upstream component that its port is connected: " + "%![comp-]+c, %![port-]+p", upstream_component, upstream_port); + component_status = bt_component_port_connected(upstream_component, + (void *) upstream_port, (void *) downstream_port); + if (component_status != BT_SELF_COMPONENT_STATUS_OK) { + BT_LIB_LOGW("Error while notifying upstream component that its port is connected: " + "status=%s, %![graph-]+g, %![up-comp-]+c, " + "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", + bt_self_component_status_string(component_status), + graph, upstream_component, downstream_component, + upstream_port, downstream_port); + bt_connection_end(connection, true); + status = (int) component_status; + goto end; + } + + connection->msgied_upstream_port_connected = true; + BT_LIB_LOGD("Notifying downstream component that its port is connected: " + "%![comp-]+c, %![port-]+p", downstream_component, downstream_port); - BT_LOGD_STR("Notifying downstream component that its port is connected."); - bt_component_port_connected(downstream_component, downstream_port, - upstream_port); + component_status = bt_component_port_connected(downstream_component, + (void *) downstream_port, (void *) upstream_port); + if (component_status != BT_SELF_COMPONENT_STATUS_OK) { + BT_LIB_LOGW("Error while notifying downstream component that its port is connected: " + "status=%s, %![graph-]+g, %![up-comp-]+c, " + "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", + bt_self_component_status_string(component_status), + graph, upstream_component, downstream_component, + upstream_port, downstream_port); + bt_connection_end(connection, true); + status = (int) component_status; + goto end; + } + + connection->msgied_downstream_port_connected = true; /* * Notify the graph's creator that both ports are connected. */ BT_LOGD_STR("Notifying graph's user that new component ports are connected."); bt_graph_notify_ports_connected(graph, upstream_port, downstream_port); - BT_LOGD("Connected component ports within graph: " - "graph-addr=%p, " - "upstream-comp-addr=%p, upstream-comp-name=\"%s\", " - "downstream-comp-addr=%p, downstream-comp-name=\"%s\", " - "upstream-port-addr=%p, upstream-port-name=\"%s\", " - "downstream-port-addr=%p, downstream-port-name=\"%s\"", - graph, - upstream_component, bt_component_get_name(upstream_component), - downstream_component, bt_component_get_name(downstream_component), - upstream_port, bt_port_get_name(upstream_port), - downstream_port, bt_port_get_name(downstream_port)); + connection->msgied_graph_ports_connected = true; + BT_LIB_LOGD("Connected component ports within graph: " + "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, " + "%![up-port-]+p, %![down-port-]+p", + graph, upstream_component, downstream_component, + upstream_port, downstream_port); if (user_connection) { /* Move reference to user */ @@ -417,130 +647,177 @@ enum bt_graph_status bt_graph_connect_ports(struct bt_graph *graph, } end: - bt_put(upstream_graph); - bt_put(downstream_graph); - bt_put(upstream_component); - bt_put(downstream_component); - bt_put(connection); + bt_object_put_ref(connection); + (void) init_can_consume; + bt_graph_set_can_consume(graph, init_can_consume); return status; } -static -enum bt_graph_status bt_graph_consume_no_check(struct bt_graph *graph) +static inline +enum bt_graph_status consume_graph_sink(struct bt_component_sink *comp) { - struct bt_component *sink; - enum bt_graph_status status = BT_GRAPH_STATUS_OK; - enum bt_component_status comp_status; - GList *current_node; - - BT_LOGV("Making next sink consume: addr=%p", graph); - - if (g_queue_is_empty(graph->sinks_to_consume)) { - BT_LOGV_STR("Graph's sink queue is empty: end of graph."); - status = BT_GRAPH_STATUS_END; + enum bt_self_component_status comp_status; + struct bt_component_class_sink *sink_class = NULL; + + BT_ASSERT(comp); + sink_class = (void *) comp->parent.class; + BT_ASSERT(sink_class->methods.consume); + BT_LIB_LOGD("Calling user's consume method: %!+c", comp); + comp_status = sink_class->methods.consume((void *) comp); + BT_LOGD("User method returned: status=%s", + bt_self_component_status_string(comp_status)); + BT_ASSERT_PRE(comp_status == BT_SELF_COMPONENT_STATUS_OK || + comp_status == BT_SELF_COMPONENT_STATUS_END || + comp_status == BT_SELF_COMPONENT_STATUS_AGAIN || + comp_status == BT_SELF_COMPONENT_STATUS_ERROR || + comp_status == BT_SELF_COMPONENT_STATUS_NOMEM, + "Invalid component status returned by consuming method: " + "status=%s", bt_self_component_status_string(comp_status)); + if (comp_status < 0) { + BT_LOGW_STR("Consume method failed."); goto end; } - current_node = g_queue_pop_head_link(graph->sinks_to_consume); - sink = current_node->data; - BT_LOGV("Chose next sink to consume: comp-addr=%p, comp-name=\"%s\"", - sink, bt_component_get_name(sink)); - comp_status = bt_component_sink_consume(sink); - BT_LOGV("Consumed from sink: status=%s", - bt_component_status_string(comp_status)); - switch (comp_status) { - case BT_COMPONENT_STATUS_OK: - break; - case BT_COMPONENT_STATUS_END: - status = BT_GRAPH_STATUS_END; - break; - case BT_COMPONENT_STATUS_AGAIN: - status = BT_GRAPH_STATUS_AGAIN; - break; - case BT_COMPONENT_STATUS_INVALID: - status = BT_GRAPH_STATUS_INVALID; - break; - default: - status = BT_GRAPH_STATUS_ERROR; - break; - } + BT_LIB_LOGV("Consumed from sink: %![comp-]+c, status=%s", + comp, bt_self_component_status_string(comp_status)); - if (status != BT_GRAPH_STATUS_END) { - g_queue_push_tail_link(graph->sinks_to_consume, current_node); +end: + return (int) comp_status; +} + +/* + * `node` is removed from the queue of sinks to consume when passed to + * this function. This function adds it back to the queue if there's + * still something to consume afterwards. + */ +static inline +enum bt_graph_status consume_sink_node(struct bt_graph *graph, GList *node) +{ + enum bt_graph_status status; + struct bt_component_sink *sink; + + sink = node->data; + status = consume_graph_sink(sink); + if (unlikely(status != BT_GRAPH_STATUS_END)) { + g_queue_push_tail_link(graph->sinks_to_consume, node); goto end; } /* End reached, the node is not added back to the queue and free'd. */ - g_queue_delete_link(graph->sinks_to_consume, current_node); + g_queue_delete_link(graph->sinks_to_consume, node); /* Don't forward an END status if there are sinks left to consume. */ if (!g_queue_is_empty(graph->sinks_to_consume)) { status = BT_GRAPH_STATUS_OK; goto end; } + end: - BT_LOGV("Graph consumed: status=%s", bt_graph_status_string(status)); + BT_LIB_LOGV("Consumed sink node: %![comp-]+c, status=%s", + sink, bt_graph_status_string(status)); return status; } -enum bt_graph_status bt_graph_consume(struct bt_graph *graph) +BT_HIDDEN +enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph, + struct bt_component_sink *sink) { - enum bt_graph_status status = BT_GRAPH_STATUS_OK; + enum bt_graph_status status; + GList *sink_node; + int index; - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - status = BT_GRAPH_STATUS_INVALID; + BT_LIB_LOGV("Making specific sink consume: %![comp-]+c", sink); + BT_ASSERT(bt_component_borrow_graph((void *) sink) == graph); + + if (g_queue_is_empty(graph->sinks_to_consume)) { + BT_LOGV_STR("Graph's sink queue is empty: end of graph."); + status = BT_GRAPH_STATUS_END; goto end; } - if (graph->canceled) { - BT_LOGW("Invalid parameter: graph is canceled: " - "graph-addr=%p", graph); - status = BT_GRAPH_STATUS_CANCELED; + index = g_queue_index(graph->sinks_to_consume, sink); + if (index < 0) { + BT_LOGV_STR("Sink is not marked as consumable: sink is ended."); + status = BT_GRAPH_STATUS_END; goto end; } - status = bt_graph_consume_no_check(graph); + sink_node = g_queue_pop_nth_link(graph->sinks_to_consume, index); + BT_ASSERT(sink_node); + status = consume_sink_node(graph, sink_node); end: return status; } -enum bt_graph_status bt_graph_run(struct bt_graph *graph) +static inline +enum bt_graph_status consume_no_check(struct bt_graph *graph) { enum bt_graph_status status = BT_GRAPH_STATUS_OK; + struct bt_component *sink; + GList *current_node; - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - status = BT_GRAPH_STATUS_INVALID; - goto end; - } + BT_ASSERT_PRE(graph->has_sink, + "Graph has no sink component: %!+g", graph); + BT_LIB_LOGV("Making next sink consume: %![graph-]+g", graph); - if (graph->canceled) { - BT_LOGW("Invalid parameter: graph is canceled: " - "graph-addr=%p", graph); - status = BT_GRAPH_STATUS_CANCELED; + if (unlikely(g_queue_is_empty(graph->sinks_to_consume))) { + BT_LOGV_STR("Graph's sink queue is empty: end of graph."); + status = BT_GRAPH_STATUS_END; goto end; } - BT_LOGV("Running graph: addr=%p", graph); + current_node = g_queue_pop_head_link(graph->sinks_to_consume); + sink = current_node->data; + BT_LIB_LOGV("Chose next sink to consume: %!+c", sink); + status = consume_sink_node(graph, current_node); + +end: + return status; +} + +enum bt_graph_status bt_graph_consume( + struct bt_graph *graph) +{ + enum bt_graph_status status; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE(!graph->canceled, "Graph is canceled: %!+g", graph); + BT_ASSERT_PRE(graph->can_consume, + "Cannot consume graph in its current state: %!+g", graph); + bt_graph_set_can_consume(graph, BT_FALSE); + status = consume_no_check(graph); + bt_graph_set_can_consume(graph, BT_TRUE); + return status; +} + +enum bt_graph_status bt_graph_run(struct bt_graph *graph) +{ + enum bt_graph_status status = BT_GRAPH_STATUS_OK; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE(!graph->canceled, "Graph is canceled: %!+g", graph); + BT_ASSERT_PRE(graph->can_consume, + "Cannot consume graph in its current state: %!+g", graph); + bt_graph_set_can_consume(graph, BT_FALSE); + BT_LIB_LOGV("Running graph: %!+g", graph); do { /* * Check if the graph is canceled at each iteration. If * the graph was canceled by another thread or by a - * signal, this is not a warning nor an error, it was - * intentional: log with a DEBUG level only. + * signal handler, this is not a warning nor an error, + * it was intentional: log with a DEBUG level only. */ - if (graph->canceled) { - BT_LOGD("Stopping the graph: graph is canceled: " - "graph-addr=%p", graph); + if (unlikely(graph->canceled)) { + BT_LIB_LOGD("Stopping the graph: graph is canceled: " + "%!+g", graph); status = BT_GRAPH_STATUS_CANCELED; goto end; } - status = bt_graph_consume(graph); - if (status == BT_GRAPH_STATUS_AGAIN) { + status = consume_no_check(graph); + if (unlikely(status == BT_GRAPH_STATUS_AGAIN)) { /* * If AGAIN is received and there are multiple * sinks, go ahead and consume from the next @@ -548,13 +825,15 @@ enum bt_graph_status bt_graph_run(struct bt_graph *graph) * * However, in the case where a single sink is * left, the caller can decide to busy-wait and - * call bt_graph_run() continuously until the - * source is ready or it can decide to sleep for - * an arbitrary amount of time. + * call bt_graph_run() continuously + * until the source is ready or it can decide to + * sleep for an arbitrary amount of time. */ if (graph->sinks_to_consume->length > 1) { status = BT_GRAPH_STATUS_OK; } + } else if (status == BT_GRAPH_STATUS_NO_SINK) { + goto end; } } while (status == BT_GRAPH_STATUS_OK); @@ -563,147 +842,573 @@ enum bt_graph_status bt_graph_run(struct bt_graph *graph) } end: - BT_LOGV("Graph ran: status=%s", bt_graph_status_string(status)); + BT_LIB_LOGV("Graph ran: %![graph-]+g, status=%s", graph, + bt_graph_status_string(status)); + bt_graph_set_can_consume(graph, BT_TRUE); return status; } -static -int add_listener(GArray *listeners, void *func, void *data) +enum bt_graph_status +bt_graph_add_source_component_output_port_added_listener( + struct bt_graph *graph, + bt_graph_source_component_output_port_added_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) { - struct bt_graph_listener listener = { - .func = func, - .data = data, + struct bt_graph_listener_port_added listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_added_func_t) func, }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.source_output_port_added, listener); + listener_id = graph->listeners.source_output_port_added->len - 1; + BT_LIB_LOGV("Added \"source component output port added\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } - g_array_append_val(listeners, listener); - return listeners->len - 1; + return BT_GRAPH_STATUS_OK; } -int bt_graph_add_port_added_listener( +enum bt_graph_status +bt_graph_add_filter_component_output_port_added_listener( struct bt_graph *graph, - bt_graph_port_added_listener listener, void *data) + bt_graph_filter_component_output_port_added_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) { - int ret; - - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - ret = -1; - goto end; + struct bt_graph_listener_port_added listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_added_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.filter_output_port_added, listener); + listener_id = graph->listeners.filter_output_port_added->len - 1; + BT_LIB_LOGV("Added \"filter component output port added\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - if (!listener) { - BT_LOGW_STR("Invalid parameter: listener is NULL."); - ret = -1; - goto end; - } + return BT_GRAPH_STATUS_OK; +} - ret = add_listener(graph->listeners.port_added, listener, data); - BT_LOGV("Added \"port added\" listener to graph: " - "graph-addr=%p, listener-addr=%p, pos=%d", - graph, listener, ret); +enum bt_graph_status +bt_graph_add_filter_component_input_port_added_listener( + struct bt_graph *graph, + bt_graph_filter_component_input_port_added_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_port_added listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_added_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.filter_input_port_added, listener); + listener_id = graph->listeners.filter_input_port_added->len - 1; + BT_LIB_LOGV("Added \"filter component input port added\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } -end: - return ret; + return BT_GRAPH_STATUS_OK; } -int bt_graph_add_port_removed_listener( +enum bt_graph_status +bt_graph_add_sink_component_input_port_added_listener( struct bt_graph *graph, - bt_graph_port_removed_listener listener, void *data) + bt_graph_sink_component_input_port_added_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) { - int ret; - - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - ret = -1; - goto end; + struct bt_graph_listener_port_added listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_added_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.sink_input_port_added, listener); + listener_id = graph->listeners.sink_input_port_added->len - 1; + BT_LIB_LOGV("Added \"sink component input port added\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - if (!listener) { - BT_LOGW_STR("Invalid parameter: listener is NULL."); - ret = -1; - goto end; + return BT_GRAPH_STATUS_OK; +} + +enum bt_graph_status +bt_graph_add_source_component_output_port_removed_listener( + struct bt_graph *graph, + bt_graph_source_component_output_port_removed_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_port_removed listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_removed_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.source_output_port_removed, listener); + listener_id = graph->listeners.source_output_port_removed->len - 1; + BT_LIB_LOGV("Added \"source component output port removed\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - ret = add_listener(graph->listeners.port_removed, listener, data); - BT_LOGV("Added \"port removed\" listener to graph: " - "graph-addr=%p, listener-addr=%p, pos=%d", - graph, listener, ret); + return BT_GRAPH_STATUS_OK; +} -end: - return ret; +enum bt_graph_status +bt_graph_add_filter_component_output_port_removed_listener( + struct bt_graph *graph, + bt_graph_filter_component_output_port_removed_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_port_removed listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_removed_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.filter_output_port_removed, listener); + listener_id = graph->listeners.filter_output_port_removed->len - 1; + BT_LIB_LOGV("Added \"filter component output port removed\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } + + return BT_GRAPH_STATUS_OK; } -int bt_graph_add_ports_connected_listener( +enum bt_graph_status +bt_graph_add_filter_component_input_port_removed_listener( struct bt_graph *graph, - bt_graph_ports_connected_listener listener, void *data) + bt_graph_filter_component_input_port_removed_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) { - int ret; + struct bt_graph_listener_port_removed listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_removed_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.filter_input_port_removed, listener); + listener_id = graph->listeners.filter_input_port_removed->len - 1; + BT_LIB_LOGV("Added \"filter component input port removed\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - ret = -1; - goto end; + return BT_GRAPH_STATUS_OK; +} + +enum bt_graph_status +bt_graph_add_sink_component_input_port_removed_listener( + struct bt_graph *graph, + bt_graph_sink_component_input_port_removed_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_port_removed listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (port_removed_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.sink_input_port_removed, listener); + listener_id = graph->listeners.sink_input_port_removed->len - 1; + BT_LIB_LOGV("Added \"sink component input port removed\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - if (!listener) { - BT_LOGW_STR("Invalid parameter: listener is NULL."); - ret = -1; - goto end; + return BT_GRAPH_STATUS_OK; +} + +enum bt_graph_status +bt_graph_add_source_filter_component_ports_connected_listener( + struct bt_graph *graph, + bt_graph_source_filter_component_ports_connected_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_ports_connected listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (ports_connected_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.source_filter_ports_connected, + listener); + listener_id = graph->listeners.source_filter_ports_connected->len - 1; + BT_LIB_LOGV("Added \"source to filter component ports connected\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - ret = add_listener(graph->listeners.ports_connected, listener, data); - BT_LOGV("Added \"port connected\" listener to graph: " - "graph-addr=%p, listener-addr=%p, pos=%d", - graph, listener, ret); + return BT_GRAPH_STATUS_OK; +} -end: - return ret; +enum bt_graph_status +bt_graph_add_source_sink_component_ports_connected_listener( + struct bt_graph *graph, + bt_graph_source_sink_component_ports_connected_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_ports_connected listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (ports_connected_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.source_sink_ports_connected, + listener); + listener_id = graph->listeners.source_sink_ports_connected->len - 1; + BT_LIB_LOGV("Added \"source to sink component ports connected\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } + + return BT_GRAPH_STATUS_OK; } -int bt_graph_add_ports_disconnected_listener( +enum bt_graph_status +bt_graph_add_filter_sink_component_ports_connected_listener( struct bt_graph *graph, - bt_graph_ports_disconnected_listener listener, void *data) + bt_graph_filter_sink_component_ports_connected_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) { - int ret; + struct bt_graph_listener_ports_connected listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (ports_connected_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.filter_sink_ports_connected, + listener); + listener_id = graph->listeners.filter_sink_ports_connected->len - 1; + BT_LIB_LOGV("Added \"filter to sink component ports connected\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - ret = -1; - goto end; + return BT_GRAPH_STATUS_OK; +} + +enum bt_graph_status +bt_graph_add_source_filter_component_ports_disconnected_listener( + struct bt_graph *graph, + bt_graph_source_filter_component_ports_disconnected_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_ports_disconnected listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (ports_disconnected_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.source_filter_ports_disconnected, + listener); + listener_id = graph->listeners.source_filter_ports_disconnected->len - 1; + BT_LIB_LOGV("Added \"source to filter component ports disconnected\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - if (!listener) { - BT_LOGW_STR("Invalid parameter: listener is NULL."); - ret = -1; - goto end; + return BT_GRAPH_STATUS_OK; +} + +enum bt_graph_status +bt_graph_add_source_sink_component_ports_disconnected_listener( + struct bt_graph *graph, + bt_graph_source_sink_component_ports_disconnected_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_ports_disconnected listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (ports_disconnected_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.source_sink_ports_disconnected, + listener); + listener_id = graph->listeners.source_sink_ports_disconnected->len - 1; + BT_LIB_LOGV("Added \"source to sink component ports disconnected\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; } - ret = add_listener(graph->listeners.ports_disconnected, listener, data); - BT_LOGV("Added \"port disconnected\" listener to graph: " - "graph-addr=%p, listener-addr=%p, pos=%d", - graph, listener, ret); + return BT_GRAPH_STATUS_OK; +} -end: - return ret; +enum bt_graph_status +bt_graph_add_filter_sink_component_ports_disconnected_listener( + struct bt_graph *graph, + bt_graph_filter_sink_component_ports_disconnected_listener_func func, + bt_graph_listener_removed_func listener_removed, void *data, + int *out_listener_id) +{ + struct bt_graph_listener_ports_disconnected listener = { + .base = { + .removed = listener_removed, + .data = data, + }, + .func = (ports_disconnected_func_t) func, + }; + int listener_id; + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(func, "Listener"); + BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener"); + BT_ASSERT_PRE(!graph->in_remove_listener, + "Graph currently executing a \"listener removed\" listener: " + "%!+g", graph); + g_array_append_val(graph->listeners.filter_sink_ports_disconnected, + listener); + listener_id = graph->listeners.filter_sink_ports_disconnected->len - 1; + BT_LIB_LOGV("Added \"filter to sink component ports disconnected\" listener to graph: " + "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, + listener_id); + + if (listener_id) { + *out_listener_id = listener_id; + } + + return BT_GRAPH_STATUS_OK; } BT_HIDDEN void bt_graph_notify_port_added(struct bt_graph *graph, struct bt_port *port) { - size_t i; + uint64_t i; + GArray *listeners; + struct bt_component *comp; + + BT_ASSERT(graph); + BT_ASSERT(port); + BT_LIB_LOGV("Notifying graph listeners that a port was added: " + "%![graph-]+g, %![port-]+p", graph, port); + comp = bt_port_borrow_component_inline(port); + BT_ASSERT(comp); + + switch (comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_SOURCE: + { + switch (port->type) { + case BT_PORT_TYPE_OUTPUT: + listeners = graph->listeners.source_output_port_added; + break; + default: + abort(); + } - BT_LOGV("Notifying graph listeners that a port was added: " - "graph-addr=%p, port-addr=%p, port-name=\"%s\"", - graph, port, bt_port_get_name(port)); + break; + } + case BT_COMPONENT_CLASS_TYPE_FILTER: + { + switch (port->type) { + case BT_PORT_TYPE_INPUT: + listeners = graph->listeners.filter_input_port_added; + break; + case BT_PORT_TYPE_OUTPUT: + listeners = graph->listeners.filter_output_port_added; + break; + default: + abort(); + } - for (i = 0; i < graph->listeners.port_added->len; i++) { - struct bt_graph_listener listener = - g_array_index(graph->listeners.port_added, - struct bt_graph_listener, i); - bt_graph_port_added_listener func = listener.func; + break; + } + case BT_COMPONENT_CLASS_TYPE_SINK: + { + switch (port->type) { + case BT_PORT_TYPE_INPUT: + listeners = graph->listeners.sink_input_port_added; + break; + default: + abort(); + } - assert(func); - func(port, listener.data); + break; + } + default: + abort(); + } + + for (i = 0; i < listeners->len; i++) { + struct bt_graph_listener_port_added *listener = + &g_array_index(listeners, + struct bt_graph_listener_port_added, i); + + BT_ASSERT(listener->func); + listener->func(comp, port, listener->base.data); } } @@ -711,20 +1416,65 @@ BT_HIDDEN void bt_graph_notify_port_removed(struct bt_graph *graph, struct bt_component *comp, struct bt_port *port) { - size_t i; + uint64_t i; + GArray *listeners; + + BT_ASSERT(graph); + BT_ASSERT(port); + BT_LIB_LOGV("Notifying graph listeners that a port was removed: " + "%![graph-]+g, %![comp-]+c, %![port-]+p", graph, comp, port); + + switch (comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_SOURCE: + { + switch (port->type) { + case BT_PORT_TYPE_OUTPUT: + listeners = graph->listeners.source_output_port_removed; + break; + default: + abort(); + } - BT_LOGV("Notifying graph listeners that a port was removed: " - "graph-addr=%p, port-addr=%p, port-name=\"%s\"", - graph, port, bt_port_get_name(port)); + break; + } + case BT_COMPONENT_CLASS_TYPE_FILTER: + { + switch (port->type) { + case BT_PORT_TYPE_INPUT: + listeners = graph->listeners.filter_input_port_removed; + break; + case BT_PORT_TYPE_OUTPUT: + listeners = graph->listeners.filter_output_port_removed; + break; + default: + abort(); + } - for (i = 0; i < graph->listeners.port_removed->len; i++) { - struct bt_graph_listener listener = - g_array_index(graph->listeners.port_removed, - struct bt_graph_listener, i); - bt_graph_port_removed_listener func = listener.func; + break; + } + case BT_COMPONENT_CLASS_TYPE_SINK: + { + switch (port->type) { + case BT_PORT_TYPE_INPUT: + listeners = graph->listeners.sink_input_port_removed; + break; + default: + abort(); + } - assert(func); - func(comp, port, listener.data); + break; + } + default: + abort(); + } + + for (i = 0; i < listeners->len; i++) { + struct bt_graph_listener_port_removed *listener = + &g_array_index(listeners, + struct bt_graph_listener_port_removed, i); + + BT_ASSERT(listener->func); + listener->func(comp, port, listener->base.data); } } @@ -732,23 +1482,65 @@ BT_HIDDEN void bt_graph_notify_ports_connected(struct bt_graph *graph, struct bt_port *upstream_port, struct bt_port *downstream_port) { - size_t i; + uint64_t i; + GArray *listeners; + struct bt_component *upstream_comp; + struct bt_component *downstream_comp; + + BT_ASSERT(graph); + BT_ASSERT(upstream_port); + BT_ASSERT(downstream_port); + BT_LIB_LOGV("Notifying graph listeners that ports were connected: " + "%![graph-]+g, %![up-port-]+p, %![down-port-]+p", + graph, upstream_port, downstream_port); + upstream_comp = bt_port_borrow_component_inline(upstream_port); + BT_ASSERT(upstream_comp); + downstream_comp = bt_port_borrow_component_inline(downstream_port); + BT_ASSERT(downstream_comp); + + switch (upstream_comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_SOURCE: + { + switch (downstream_comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_FILTER: + listeners = + graph->listeners.source_filter_ports_connected; + break; + case BT_COMPONENT_CLASS_TYPE_SINK: + listeners = + graph->listeners.source_sink_ports_connected; + break; + default: + abort(); + } - BT_LOGV("Notifying graph listeners that two ports were connected: " - "graph-addr=%p, " - "upstream-port-addr=%p, upstream-port-name=\"%s\", " - "downstream-port-addr=%p, downstream-port-name=\"%s\"", - graph, upstream_port, bt_port_get_name(upstream_port), - downstream_port, bt_port_get_name(downstream_port)); + break; + } + case BT_COMPONENT_CLASS_TYPE_FILTER: + { + switch (downstream_comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_SINK: + listeners = + graph->listeners.filter_sink_ports_connected; + break; + default: + abort(); + } - for (i = 0; i < graph->listeners.ports_connected->len; i++) { - struct bt_graph_listener listener = - g_array_index(graph->listeners.ports_connected, - struct bt_graph_listener, i); - bt_graph_ports_connected_listener func = listener.func; + break; + } + default: + abort(); + } + + for (i = 0; i < listeners->len; i++) { + struct bt_graph_listener_ports_connected *listener = + &g_array_index(listeners, + struct bt_graph_listener_ports_connected, i); - assert(func); - func(upstream_port, downstream_port, listener.data); + BT_ASSERT(listener->func); + listener->func(upstream_comp, downstream_comp, + upstream_port, downstream_port, listener->base.data); } } @@ -756,58 +1548,401 @@ BT_HIDDEN void bt_graph_notify_ports_disconnected(struct bt_graph *graph, struct bt_component *upstream_comp, struct bt_component *downstream_comp, - struct bt_port *upstream_port, struct bt_port *downstream_port) + struct bt_port *upstream_port, + struct bt_port *downstream_port) +{ + uint64_t i; + GArray *listeners; + + BT_ASSERT(graph); + BT_ASSERT(upstream_comp); + BT_ASSERT(downstream_comp); + BT_ASSERT(upstream_port); + BT_ASSERT(downstream_port); + BT_LIB_LOGV("Notifying graph listeners that ports were disconnected: " + "%![graph-]+g, %![up-port-]+p, %![down-port-]+p, " + "%![up-comp-]+c, %![down-comp-]+c", + graph, upstream_port, downstream_port, upstream_comp, + downstream_comp); + + switch (upstream_comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_SOURCE: + { + switch (downstream_comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_FILTER: + listeners = + graph->listeners.source_filter_ports_disconnected; + break; + case BT_COMPONENT_CLASS_TYPE_SINK: + listeners = + graph->listeners.source_sink_ports_disconnected; + break; + default: + abort(); + } + + break; + } + case BT_COMPONENT_CLASS_TYPE_FILTER: + { + switch (downstream_comp->class->type) { + case BT_COMPONENT_CLASS_TYPE_SINK: + listeners = + graph->listeners.filter_sink_ports_disconnected; + break; + default: + abort(); + } + + break; + } + default: + abort(); + } + + for (i = 0; i < listeners->len; i++) { + struct bt_graph_listener_ports_disconnected *listener = + &g_array_index(listeners, + struct bt_graph_listener_ports_disconnected, i); + + BT_ASSERT(listener->func); + listener->func(upstream_comp, downstream_comp, + upstream_port, downstream_port, listener->base.data); + } +} + +enum bt_graph_status bt_graph_cancel( + struct bt_graph *graph) +{ + + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + graph->canceled = true; + BT_LIB_LOGV("Canceled graph: %!+i", graph); + return BT_GRAPH_STATUS_OK; +} + +bt_bool bt_graph_is_canceled(const struct bt_graph *graph) +{ + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + return graph->canceled ? BT_TRUE : BT_FALSE; +} + +BT_HIDDEN +void bt_graph_remove_connection(struct bt_graph *graph, + struct bt_connection *connection) { - size_t i; + BT_ASSERT(graph); + BT_ASSERT(connection); + BT_LIB_LOGV("Removing graph's connection: %![graph-]+g, %![conn-]+x", + graph, connection); + g_ptr_array_remove(graph->connections, connection); +} - BT_LOGV("Notifying graph listeners that two ports were disconnected: " - "graph-addr=%p, " - "upstream-port-addr=%p, upstream-port-name=\"%s\", " - "downstream-port-addr=%p, downstream-port-name=\"%s\"", - graph, upstream_port, bt_port_get_name(upstream_port), - downstream_port, bt_port_get_name(downstream_port)); +BT_ASSERT_PRE_FUNC +static inline +bool component_name_exists(struct bt_graph *graph, const char *name) +{ + bool exists = false; + uint64_t i; - for (i = 0; i < graph->listeners.ports_disconnected->len; i++) { - struct bt_graph_listener listener = - g_array_index(graph->listeners.ports_disconnected, - struct bt_graph_listener, i); - bt_graph_ports_disconnected_listener func = listener.func; + for (i = 0; i < graph->components->len; i++) { + struct bt_component *other_comp = graph->components->pdata[i]; - assert(func); - func(upstream_comp, downstream_comp, upstream_port, - downstream_port, listener.data); + if (strcmp(name, bt_component_get_name(other_comp)) == 0) { + BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: " + "%![other-comp-]+c, name=\"%s\"", + other_comp, name); + exists = true; + goto end; + } } + +end: + return exists; } -extern enum bt_graph_status bt_graph_cancel(struct bt_graph *graph) +static +enum bt_graph_status add_component_with_init_method_data( + struct bt_graph *graph, + struct bt_component_class *comp_cls, + comp_init_method_t init_method, + const char *name, const struct bt_value *params, + void *init_method_data, struct bt_component **user_component) { - enum bt_graph_status ret = BT_GRAPH_STATUS_OK; + enum bt_graph_status graph_status = BT_GRAPH_STATUS_OK; + enum bt_self_component_status comp_status; + struct bt_component *component = NULL; + int ret; + bool init_can_consume; + struct bt_value *new_params = NULL; + + BT_ASSERT(comp_cls); + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(name, "Name"); + BT_ASSERT_PRE(!graph->canceled, "Graph is canceled: %!+g", graph); + BT_ASSERT_PRE(!component_name_exists(graph, name), + "Duplicate component name: %!+g, name=\"%s\"", graph, name); + BT_ASSERT_PRE(!params || bt_value_is_map(params), + "Parameter value is not a map value: %!+v", params); + init_can_consume = graph->can_consume; + bt_graph_set_can_consume(graph, false); + BT_LIB_LOGD("Adding component to graph: " + "%![graph-]+g, %![cc-]+C, name=\"%s\", %![params-]+v, " + "init-method-data-addr=%p", + graph, comp_cls, name, params, init_method_data); + + if (!params) { + new_params = bt_value_map_create(); + if (!new_params) { + BT_LOGE_STR("Cannot create map value object."); + graph_status = BT_GRAPH_STATUS_NOMEM; + goto end; + } - if (!graph) { - BT_LOGW_STR("Invalid parameter: graph is NULL."); - ret = BT_GRAPH_STATUS_INVALID; + params = new_params; + } + + ret = bt_component_create(comp_cls, name, &component); + if (ret) { + BT_LOGE("Cannot create empty component object: ret=%d", + ret); + graph_status = BT_GRAPH_STATUS_NOMEM; goto end; } - graph->canceled = BT_TRUE; - BT_LOGV("Canceled graph: addr=%p", graph); + /* + * The user's initialization method needs to see that this + * component is part of the graph. If the user method fails, we + * immediately remove the component from the graph's components. + */ + g_ptr_array_add(graph->components, component); + bt_component_set_graph(component, graph); + + if (init_method) { + BT_LOGD_STR("Calling user's initialization method."); + comp_status = init_method(component, params, init_method_data); + BT_LOGD("User method returned: status=%s", + bt_self_component_status_string(comp_status)); + if (comp_status != BT_SELF_COMPONENT_STATUS_OK) { + BT_LOGW_STR("Initialization method failed."); + graph_status = (int) comp_status; + bt_component_set_graph(component, NULL); + g_ptr_array_remove_fast(graph->components, component); + goto end; + } + } + + /* + * Mark the component as initialized so that its finalization + * method is called when it is destroyed. + */ + component->initialized = true; + + /* + * If it's a sink component, it needs to be part of the graph's + * sink queue to be consumed by bt_graph_consume(). + */ + if (bt_component_is_sink(component)) { + graph->has_sink = true; + g_queue_push_tail(graph->sinks_to_consume, component); + } + + /* + * Freeze the component class now that it's instantiated at + * least once. + */ + BT_LOGD_STR("Freezing component class."); + bt_component_class_freeze(comp_cls); + BT_LIB_LOGD("Added component to graph: " + "%![graph-]+g, %![cc-]+C, name=\"%s\", %![params-]+v, " + "init-method-data-addr=%p, %![comp-]+c", + graph, comp_cls, name, params, init_method_data, component); + + if (user_component) { + /* Move reference to user */ + *user_component = component; + component = NULL; + } end: - return ret; + bt_object_put_ref(component); + bt_object_put_ref(new_params); + (void) init_can_consume; + bt_graph_set_can_consume(graph, init_can_consume); + return graph_status; +} + +enum bt_graph_status +bt_graph_add_source_component_with_init_method_data( + struct bt_graph *graph, + const struct bt_component_class_source *comp_cls, + const char *name, const struct bt_value *params, + void *init_method_data, + const struct bt_component_source **component) +{ + BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); + return add_component_with_init_method_data(graph, + (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, + name, params, init_method_data, (void *) component); +} + +enum bt_graph_status bt_graph_add_source_component( + struct bt_graph *graph, + const struct bt_component_class_source *comp_cls, + const char *name, const struct bt_value *params, + const struct bt_component_source **component) +{ + return bt_graph_add_source_component_with_init_method_data( + graph, comp_cls, name, params, NULL, component); +} + +enum bt_graph_status +bt_graph_add_filter_component_with_init_method_data( + struct bt_graph *graph, + const struct bt_component_class_filter *comp_cls, + const char *name, const struct bt_value *params, + void *init_method_data, + const struct bt_component_filter **component) +{ + BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); + return add_component_with_init_method_data(graph, + (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, + name, params, init_method_data, (void *) component); } -extern bt_bool bt_graph_is_canceled(struct bt_graph *graph) +enum bt_graph_status bt_graph_add_filter_component( + struct bt_graph *graph, + const struct bt_component_class_filter *comp_cls, + const char *name, const struct bt_value *params, + const struct bt_component_filter **component) { - return graph ? graph->canceled : BT_FALSE; + return bt_graph_add_filter_component_with_init_method_data( + graph, comp_cls, name, params, NULL, component); +} + +enum bt_graph_status +bt_graph_add_sink_component_with_init_method_data( + struct bt_graph *graph, + const struct bt_component_class_sink *comp_cls, + const char *name, const struct bt_value *params, + void *init_method_data, + const struct bt_component_sink **component) +{ + BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); + return add_component_with_init_method_data(graph, + (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, + name, params, init_method_data, (void *) component); +} + +enum bt_graph_status bt_graph_add_sink_component( + struct bt_graph *graph, + const struct bt_component_class_sink *comp_cls, + const char *name, const struct bt_value *params, + const struct bt_component_sink **component) +{ + return bt_graph_add_sink_component_with_init_method_data( + graph, comp_cls, name, params, NULL, component); } BT_HIDDEN -void bt_graph_remove_connection(struct bt_graph *graph, - struct bt_connection *connection) +int bt_graph_remove_unconnected_component(struct bt_graph *graph, + struct bt_component *component) { - assert(graph); - assert(connection); - BT_LOGV("Removing graph's connection: graph-addr=%p, conn-addr=%p", - graph, connection); - g_ptr_array_remove(graph->connections, connection); + bool init_can_consume; + uint64_t count; + uint64_t i; + int ret = 0; + + BT_ASSERT(graph); + BT_ASSERT(component); + BT_ASSERT(component->base.ref_count == 0); + BT_ASSERT(bt_component_borrow_graph(component) == graph); + + init_can_consume = graph->can_consume; + count = bt_component_get_input_port_count(component); + + for (i = 0; i < count; i++) { + struct bt_port *port = (void *) + bt_component_borrow_input_port_by_index(component, i); + + BT_ASSERT(port); + + if (bt_port_is_connected(port)) { + BT_LIB_LOGW("Cannot remove component from graph: " + "an input port is connected: " + "%![graph-]+g, %![comp-]+c, %![port-]+p", + graph, component, port); + goto error; + } + } + + count = bt_component_get_output_port_count(component); + + for (i = 0; i < count; i++) { + struct bt_port *port = (void *) + bt_component_borrow_output_port_by_index(component, i); + + BT_ASSERT(port); + + if (bt_port_is_connected(port)) { + BT_LIB_LOGW("Cannot remove component from graph: " + "an output port is connected: " + "%![graph-]+g, %![comp-]+c, %![port-]+p", + graph, component, port); + goto error; + } + } + + bt_graph_set_can_consume(graph, false); + + /* Possibly remove from sinks to consume */ + (void) g_queue_remove(graph->sinks_to_consume, component); + + if (graph->sinks_to_consume->length == 0) { + graph->has_sink = false; + } + + /* + * This calls bt_object_try_spec_release() on the component, and + * since its reference count is 0, its destructor is called. Its + * destructor calls the user's finalization method (if set). + */ + g_ptr_array_remove(graph->components, component); + goto end; + +error: + ret = -1; + +end: + (void) init_can_consume; + bt_graph_set_can_consume(graph, init_can_consume); + return ret; +} + +BT_HIDDEN +void bt_graph_add_message(struct bt_graph *graph, + struct bt_message *msg) +{ + BT_ASSERT(graph); + BT_ASSERT(msg); + + /* + * It's okay not to take a reference because, when a + * message's reference count drops to 0, either: + * + * * It is recycled back to one of this graph's pool. + * * It is destroyed because it doesn't have any link to any + * graph, which means the original graph is already destroyed. + */ + g_ptr_array_add(graph->messages, msg); +} + +void bt_graph_get_ref(const struct bt_graph *graph) +{ + bt_object_get_ref(graph); +} + +void bt_graph_put_ref(const struct bt_graph *graph) +{ + bt_object_put_ref(graph); }