X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fgraph.c;h=4cdb06c1c474f8eb7c6822b5d5e36f8dd7e010ca;hb=c4f23e30bf67d2523163614bc9461d84cbe1ae80;hp=deb7a11527b2ee74191edda2871e0472d19634ce;hpb=d24d56638469189904fb6ddbb3c725817b3e9417;p=babeltrace.git diff --git a/src/lib/graph/graph.c b/src/lib/graph/graph.c index deb7a115..4cdb06c1 100644 --- a/src/lib/graph/graph.c +++ b/src/lib/graph/graph.c @@ -40,12 +40,15 @@ #include #include "lib/value.h" #include +#include #include +#include "component-class-sink-simple.h" #include "component.h" #include "component-sink.h" #include "connection.h" #include "graph.h" +#include "interrupter.h" #include "message/event.h" #include "message/packet.h" @@ -56,8 +59,8 @@ typedef enum bt_graph_listener_func_status (*ports_connected_func_t)(const void *, const void *, const void *, const void *, void *); -typedef enum bt_component_class_init_method_status -(*comp_init_method_t)(const void *, const void *, void *); +typedef enum bt_component_class_initialize_method_status +(*comp_init_method_t)(const void *, void *, const void *, void *); struct bt_graph_listener { bt_graph_listener_removed_func removed; @@ -78,7 +81,8 @@ struct bt_graph_listener_ports_connected { do { \ _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \ if (!(_listeners)) { \ - BT_LOGE_STR("Failed to allocate one GArray."); \ + BT_LIB_LOGE_APPEND_CAUSE( \ + "Failed to allocate one GArray."); \ } \ } while (0) @@ -132,12 +136,7 @@ void destroy_graph(struct bt_object *obj) */ BT_LIB_LOGI("Destroying graph: %!+g", graph); obj->ref_count++; - - /* - * Cancel the graph to disallow some operations, like creating - * message iterators and adding ports to components. - */ - (void) bt_graph_cancel((void *) graph); + graph->config_state = BT_GRAPH_CONFIGURATION_STATE_DESTROYING; /* Call all remove listeners */ CALL_REMOVE_LISTENERS(struct bt_graph_listener_port_added, @@ -174,6 +173,14 @@ void destroy_graph(struct bt_object *obj) graph->components = NULL; } + if (graph->interrupters) { + BT_LOGD_STR("Putting interrupters."); + g_ptr_array_free(graph->interrupters, TRUE); + graph->interrupters = NULL; + } + + BT_OBJECT_PUT_REF_AND_RESET(graph->default_interrupter); + if (graph->sinks_to_consume) { g_queue_free(graph->sinks_to_consume); graph->sinks_to_consume = NULL; @@ -256,34 +263,39 @@ void notify_message_graph_is_destroyed(struct bt_message *msg) bt_message_unlink_graph(msg); } -struct bt_graph *bt_graph_create(void) +struct bt_graph *bt_graph_create(uint64_t mip_version) { struct bt_graph *graph; int ret; + BT_ASSERT_PRE(mip_version <= bt_get_maximal_mip_version(), + "Unknown MIP version: mip-version=%" PRIu64 ", " + "max-mip-version=%" PRIu64, + mip_version, bt_get_maximal_mip_version()); BT_LOGI_STR("Creating graph object."); graph = g_new0(struct bt_graph, 1); if (!graph) { - BT_LOGE_STR("Failed to allocate one graph."); + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one graph."); goto end; } bt_object_init_shared(&graph->base, destroy_graph); + graph->mip_version = mip_version; 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."); + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); goto error; } 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."); + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); goto error; } graph->sinks_to_consume = g_queue_new(); if (!graph->sinks_to_consume) { - BT_LOGE_STR("Failed to allocate one GQueue."); + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GQueue."); goto error; } @@ -292,7 +304,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.source_output_port_added); if (!graph->listeners.source_output_port_added) { - ret = -1; goto error; } @@ -300,7 +311,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.filter_output_port_added); if (!graph->listeners.filter_output_port_added) { - ret = -1; goto error; } @@ -308,7 +318,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.filter_input_port_added); if (!graph->listeners.filter_input_port_added) { - ret = -1; goto error; } @@ -316,7 +325,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.sink_input_port_added); if (!graph->listeners.sink_input_port_added) { - ret = -1; goto error; } @@ -324,7 +332,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.source_filter_ports_connected); if (!graph->listeners.source_filter_ports_connected) { - ret = -1; goto error; } @@ -332,7 +339,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.source_sink_ports_connected); if (!graph->listeners.source_sink_ports_connected) { - ret = -1; goto error; } @@ -340,7 +346,6 @@ struct bt_graph *bt_graph_create(void) graph->listeners.filter_filter_ports_connected); if (!graph->listeners.filter_filter_ports_connected) { - ret = -1; goto error; } @@ -348,16 +353,31 @@ struct bt_graph *bt_graph_create(void) graph->listeners.filter_sink_ports_connected); if (!graph->listeners.filter_sink_ports_connected) { - ret = -1; goto error; } + graph->interrupters = g_ptr_array_new_with_free_func( + (GDestroyNotify) bt_object_put_ref_no_null_check); + if (!graph->interrupters) { + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); + goto error; + } + + graph->default_interrupter = bt_interrupter_create(); + if (!graph->default_interrupter) { + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to create one interrupter object."); + goto error; + } + + bt_graph_add_interrupter(graph, graph->default_interrupter); 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", + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to initialize event message pool: ret=%d", ret); goto error; } @@ -367,7 +387,8 @@ struct bt_graph *bt_graph_create(void) (bt_object_pool_destroy_object_func) destroy_message_packet_begin, graph); if (ret) { - BT_LOGE("Failed to initialize packet beginning message pool: ret=%d", + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to initialize packet beginning message pool: ret=%d", ret); goto error; } @@ -377,7 +398,8 @@ struct bt_graph *bt_graph_create(void) (bt_object_pool_destroy_object_func) destroy_message_packet_end, graph); if (ret) { - BT_LOGE("Failed to initialize packet end message pool: ret=%d", + BT_LIB_LOGE_APPEND_CAUSE( + "Failed to initialize packet end message pool: ret=%d", ret); goto error; } @@ -413,7 +435,6 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports( 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( graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not in the \"configuring\" state: %!+g", graph); @@ -441,7 +462,7 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports( connection = bt_connection_create(graph, (void *) upstream_port, (void *) downstream_port); if (!connection) { - BT_LOGW("Cannot create connection object."); + BT_LIB_LOGE_APPEND_CAUSE("Cannot create connection object."); status = BT_FUNC_STATUS_MEMORY_ERROR; goto end; } @@ -462,12 +483,17 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports( port_connected_status = bt_component_port_connected(upstream_component, (void *) upstream_port, (void *) downstream_port); if (port_connected_status != BT_FUNC_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_common_func_status_string(port_connected_status), - graph, upstream_component, downstream_component, - upstream_port, downstream_port); + if (port_connected_status < 0) { + BT_LIB_LOGW_APPEND_CAUSE( + "Upstream component's \"port connected\" method failed: " + "status=%s, %![graph-]+g, %![up-comp-]+c, " + "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", + bt_common_func_status_string( + port_connected_status), + graph, upstream_component, downstream_component, + upstream_port, downstream_port); + } + bt_connection_end(connection, true); status = (int) port_connected_status; goto end; @@ -480,12 +506,17 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports( port_connected_status = bt_component_port_connected(downstream_component, (void *) downstream_port, (void *) upstream_port); if (port_connected_status != BT_FUNC_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_common_func_status_string(port_connected_status), - graph, upstream_component, downstream_component, - upstream_port, downstream_port); + if (port_connected_status < 0) { + BT_LIB_LOGW_APPEND_CAUSE( + "Downstream component's \"port connected\" method failed: " + "status=%s, %![graph-]+g, %![up-comp-]+c, " + "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", + bt_common_func_status_string( + port_connected_status), + graph, upstream_component, downstream_component, + upstream_port, downstream_port); + } + bt_connection_end(connection, true); status = (int) port_connected_status; goto end; @@ -499,6 +530,16 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports( BT_LOGD_STR("Notifying graph's user that new component ports are connected."); listener_status = bt_graph_notify_ports_connected(graph, upstream_port, downstream_port); if (listener_status != BT_FUNC_STATUS_OK) { + if (listener_status < 0) { + BT_LIB_LOGW_APPEND_CAUSE( + "Graph \"ports connected\" listener failed: " + "status=%d, %![graph-]+g, %![up-comp-]+c, " + "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", + listener_status, graph, + upstream_component, downstream_component, + upstream_port, downstream_port); + } + status = (int) listener_status; goto end; } @@ -533,22 +574,29 @@ int consume_graph_sink(struct bt_component_sink *comp) enum bt_component_class_sink_consume_method_status consume_status; struct bt_component_class_sink *sink_class = NULL; - BT_ASSERT(comp); + BT_ASSERT_DBG(comp); sink_class = (void *) comp->parent.class; - BT_ASSERT(sink_class->methods.consume); + BT_ASSERT_DBG(sink_class->methods.consume); BT_LIB_LOGD("Calling user's consume method: %!+c", comp); consume_status = sink_class->methods.consume((void *) comp); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(consume_status)); - BT_ASSERT_POST(consume_status == BT_FUNC_STATUS_OK || + BT_ASSERT_POST_DEV(consume_status == BT_FUNC_STATUS_OK || consume_status == BT_FUNC_STATUS_END || consume_status == BT_FUNC_STATUS_AGAIN || consume_status == BT_FUNC_STATUS_ERROR || consume_status == BT_FUNC_STATUS_MEMORY_ERROR, "Invalid component status returned by consuming method: " "status=%s", bt_common_func_status_string(consume_status)); - if (consume_status < 0) { - BT_LOGW_STR("Consume method failed."); + if (consume_status) { + if (consume_status < 0) { + BT_LIB_LOGW_APPEND_CAUSE( + "Component's \"consume\" method failed: " + "status=%s, %![comp-]+c", + bt_common_func_status_string(consume_status), + comp); + } + goto end; } @@ -601,7 +649,7 @@ int bt_graph_consume_sink_no_check(struct bt_graph *graph, int index; BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink); - BT_ASSERT(bt_component_borrow_graph((void *) sink) == graph); + BT_ASSERT_DBG(bt_component_borrow_graph((void *) sink) == graph); if (g_queue_is_empty(graph->sinks_to_consume)) { BT_LOGD_STR("Graph's sink queue is empty: end of graph."); @@ -618,7 +666,7 @@ int bt_graph_consume_sink_no_check(struct bt_graph *graph, } sink_node = g_queue_pop_nth_link(graph->sinks_to_consume, index); - BT_ASSERT(sink_node); + BT_ASSERT_DBG(sink_node); status = consume_sink_node(graph, sink_node); end: @@ -632,7 +680,7 @@ int consume_no_check(struct bt_graph *graph) struct bt_component *sink; GList *current_node; - BT_ASSERT_PRE(graph->has_sink, + BT_ASSERT_PRE_DEV(graph->has_sink, "Graph has no sink component: %!+g", graph); BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph); @@ -651,15 +699,15 @@ end: return status; } -enum bt_graph_consume_status bt_graph_consume(struct bt_graph *graph) +enum bt_graph_run_once_status bt_graph_run_once(struct bt_graph *graph) { - enum bt_graph_consume_status status; + enum bt_graph_run_once_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, + BT_ASSERT_PRE_DEV_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_DEV(graph->can_consume, "Cannot consume graph in its current state: %!+g", graph); - BT_ASSERT_PRE(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY, + BT_ASSERT_PRE_DEV(graph->config_state != + BT_GRAPH_CONFIGURATION_STATE_FAULTY, "Graph is in a faulty state: %!+g", graph); bt_graph_set_can_consume(graph, false); status = bt_graph_configure(graph); @@ -680,7 +728,6 @@ enum bt_graph_run_status bt_graph_run(struct bt_graph *graph) enum bt_graph_run_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_ASSERT_PRE(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY, @@ -696,15 +743,15 @@ enum bt_graph_run_status bt_graph_run(struct bt_graph *graph) do { /* - * Check if the graph is canceled at each iteration. If - * the graph was canceled by another thread or by a - * signal handler, this is not a warning nor an error, - * it was intentional: log with a DEBUG level only. + * Check if the graph is interrupted at each iteration. + * If the graph was interrupted by another thread or by + * a signal handler, this is NOT a warning nor an error; + * it was intentional: log with an INFO level only. */ - if (G_UNLIKELY(graph->canceled)) { - BT_LIB_LOGI("Stopping the graph: graph is canceled: " - "%!+g", graph); - status = BT_FUNC_STATUS_CANCELED; + if (G_UNLIKELY(bt_graph_is_interrupted(graph))) { + BT_LIB_LOGI("Stopping the graph: " + "graph was interrupted: %!+g", graph); + status = BT_FUNC_STATUS_AGAIN; goto end; } @@ -727,8 +774,15 @@ enum bt_graph_run_status bt_graph_run(struct bt_graph *graph) } } while (status == BT_FUNC_STATUS_OK); - if (g_queue_is_empty(graph->sinks_to_consume)) { - status = BT_FUNC_STATUS_END; + if (status == BT_FUNC_STATUS_END) { + /* + * The last call to consume_no_check() returned + * `BT_FUNC_STATUS_END`, but bt_graph_run() has no + * `BT_GRAPH_RUN_STATUS_END` status: replace with + * `BT_GRAPH_RUN_STATUS_OK` (success: graph ran + * completely). + */ + status = BT_FUNC_STATUS_OK; } end: @@ -743,7 +797,7 @@ 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) + bt_listener_id *out_listener_id) { struct bt_graph_listener_port_added listener = { .base = { @@ -752,7 +806,7 @@ bt_graph_add_source_component_output_port_added_listener( }, .func = (port_added_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -778,7 +832,7 @@ bt_graph_add_filter_component_output_port_added_listener( struct bt_graph *graph, bt_graph_filter_component_output_port_added_listener_func func, bt_graph_listener_removed_func listener_removed, void *data, - int *out_listener_id) + bt_listener_id *out_listener_id) { struct bt_graph_listener_port_added listener = { .base = { @@ -787,7 +841,7 @@ bt_graph_add_filter_component_output_port_added_listener( }, .func = (port_added_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -813,7 +867,7 @@ 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) + bt_listener_id *out_listener_id) { struct bt_graph_listener_port_added listener = { .base = { @@ -822,7 +876,7 @@ bt_graph_add_filter_component_input_port_added_listener( }, .func = (port_added_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -848,7 +902,7 @@ bt_graph_add_sink_component_input_port_added_listener( struct bt_graph *graph, bt_graph_sink_component_input_port_added_listener_func func, bt_graph_listener_removed_func listener_removed, void *data, - int *out_listener_id) + bt_listener_id *out_listener_id) { struct bt_graph_listener_port_added listener = { .base = { @@ -857,7 +911,7 @@ bt_graph_add_sink_component_input_port_added_listener( }, .func = (port_added_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -883,7 +937,7 @@ 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) + bt_listener_id *out_listener_id) { struct bt_graph_listener_ports_connected listener = { .base = { @@ -892,7 +946,7 @@ bt_graph_add_source_filter_component_ports_connected_listener( }, .func = (ports_connected_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -919,7 +973,7 @@ 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) + bt_listener_id *out_listener_id) { struct bt_graph_listener_ports_connected listener = { .base = { @@ -928,7 +982,7 @@ bt_graph_add_source_sink_component_ports_connected_listener( }, .func = (ports_connected_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -955,7 +1009,7 @@ bt_graph_add_filter_filter_component_ports_connected_listener( struct bt_graph *graph, bt_graph_filter_filter_component_ports_connected_listener_func func, bt_graph_listener_removed_func listener_removed, void *data, - int *out_listener_id) + bt_listener_id *out_listener_id) { struct bt_graph_listener_ports_connected listener = { .base = { @@ -964,7 +1018,7 @@ bt_graph_add_filter_filter_component_ports_connected_listener( }, .func = (ports_connected_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -991,7 +1045,7 @@ bt_graph_add_filter_sink_component_ports_connected_listener( struct bt_graph *graph, bt_graph_filter_sink_component_ports_connected_listener_func func, bt_graph_listener_removed_func listener_removed, void *data, - int *out_listener_id) + bt_listener_id *out_listener_id) { struct bt_graph_listener_ports_connected listener = { .base = { @@ -1000,7 +1054,7 @@ bt_graph_add_filter_sink_component_ports_connected_listener( }, .func = (ports_connected_func_t) func, }; - int listener_id; + bt_listener_id listener_id; BT_ASSERT_PRE_NON_NULL(graph, "Graph"); BT_ASSERT_PRE_NON_NULL(func, "Listener"); @@ -1177,20 +1231,6 @@ end: return status; } -enum bt_graph_cancel_status bt_graph_cancel(struct bt_graph *graph) -{ - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - graph->canceled = true; - BT_LIB_LOGI("Canceled graph: %!+i", graph); - return BT_FUNC_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) @@ -1202,7 +1242,6 @@ void bt_graph_remove_connection(struct bt_graph *graph, g_ptr_array_remove(graph->connections, connection); } -BT_ASSERT_PRE_FUNC static inline bool component_name_exists(struct bt_graph *graph, const char *name) { @@ -1232,10 +1271,10 @@ int add_component_with_init_method_data( comp_init_method_t init_method, const char *name, const struct bt_value *params, void *init_method_data, bt_logging_level log_level, - struct bt_component **user_component) + const struct bt_component **user_component) { int status = BT_FUNC_STATUS_OK; - enum bt_component_class_init_method_status init_status; + enum bt_component_class_initialize_method_status init_status; struct bt_component *component = NULL; int ret; bool init_can_consume; @@ -1244,7 +1283,6 @@ int add_component_with_init_method_data( 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( graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not in the \"configuring\" state: %!+g", graph); @@ -1264,7 +1302,8 @@ int add_component_with_init_method_data( if (!params) { new_params = bt_value_map_create(); if (!new_params) { - BT_LOGE_STR("Cannot create empty map value object."); + BT_LIB_LOGE_APPEND_CAUSE( + "Cannot create empty map value object."); status = BT_FUNC_STATUS_MEMORY_ERROR; goto end; } @@ -1274,7 +1313,8 @@ int add_component_with_init_method_data( ret = bt_component_create(comp_cls, name, log_level, &component); if (ret) { - BT_LOGE("Cannot create empty component object: ret=%d", + BT_LIB_LOGE_APPEND_CAUSE( + "Cannot create empty component object: ret=%d", ret); status = BT_FUNC_STATUS_MEMORY_ERROR; goto end; @@ -1290,13 +1330,23 @@ int add_component_with_init_method_data( bt_value_freeze(params); if (init_method) { + /* + * There is no use for config objects right now, so just pass + * NULL. + */ BT_LOGD_STR("Calling user's initialization method."); - init_status = init_method(component, params, init_method_data); + init_status = init_method(component, NULL, params, init_method_data); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(init_status)); if (init_status != BT_FUNC_STATUS_OK) { - BT_LIB_LOGW("Component initialization method failed: " - "%!+c", component); + if (init_status < 0) { + BT_LIB_LOGW_APPEND_CAUSE( + "Component initialization method failed: " + "status=%s, %![comp-]+c", + bt_common_func_status_string(init_status), + component); + } + status = init_status; bt_component_set_graph(component, NULL); g_ptr_array_remove_fast(graph->components, component); @@ -1312,7 +1362,8 @@ int add_component_with_init_method_data( /* * If it's a sink component, it needs to be part of the graph's - * sink queue to be consumed by bt_graph_consume(). + * sink queue to be consumed by bt_graph_run() or + * bt_graph_run_once(). */ if (bt_component_is_sink(component)) { graph->has_sink = true; @@ -1351,7 +1402,7 @@ end: } enum bt_graph_add_component_status -bt_graph_add_source_component_with_init_method_data( +bt_graph_add_source_component_with_initialize_method_data( struct bt_graph *graph, const struct bt_component_class_source *comp_cls, const char *name, const struct bt_value *params, @@ -1368,19 +1419,19 @@ enum bt_graph_add_component_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, - bt_logging_level log_level, + enum bt_logging_level log_level, const struct bt_component_source **component) { - return bt_graph_add_source_component_with_init_method_data( + return bt_graph_add_source_component_with_initialize_method_data( graph, comp_cls, name, params, NULL, log_level, component); } enum bt_graph_add_component_status -bt_graph_add_filter_component_with_init_method_data( +bt_graph_add_filter_component_with_initialize_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, bt_logging_level log_level, + void *init_method_data, enum bt_logging_level log_level, const struct bt_component_filter **component) { BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); @@ -1393,19 +1444,19 @@ enum bt_graph_add_component_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, - bt_logging_level log_level, + enum bt_logging_level log_level, const struct bt_component_filter **component) { - return bt_graph_add_filter_component_with_init_method_data( + return bt_graph_add_filter_component_with_initialize_method_data( graph, comp_cls, name, params, NULL, log_level, component); } enum bt_graph_add_component_status -bt_graph_add_sink_component_with_init_method_data( +bt_graph_add_sink_component_with_initialize_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, bt_logging_level log_level, + void *init_method_data, enum bt_logging_level log_level, const struct bt_component_sink **component) { BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); @@ -1418,86 +1469,49 @@ enum bt_graph_add_component_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, - bt_logging_level log_level, + enum bt_logging_level log_level, const struct bt_component_sink **component) { - return bt_graph_add_sink_component_with_init_method_data( + return bt_graph_add_sink_component_with_initialize_method_data( graph, comp_cls, name, params, NULL, log_level, component); } -BT_HIDDEN -int bt_graph_remove_unconnected_component(struct bt_graph *graph, - struct bt_component *component) +enum bt_graph_add_component_status +bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name, + bt_graph_simple_sink_component_initialize_func init_func, + bt_graph_simple_sink_component_consume_func consume_func, + bt_graph_simple_sink_component_finalize_func finalize_func, + void *user_data, const bt_component_sink **component) { - 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; - } + enum bt_graph_add_component_status status; + struct bt_component_class_sink *comp_cls; + struct simple_sink_init_method_data init_method_data = { + .init_func = init_func, + .consume_func = consume_func, + .finalize_func = finalize_func, + .user_data = user_data, + }; /* - * 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). + * Other preconditions are checked by + * bt_graph_add_sink_component_with_init_method_data(). */ - g_ptr_array_remove(graph->components, component); - goto end; + BT_ASSERT_PRE_NON_NULL(consume_func, "Consume function"); -error: - ret = -1; + comp_cls = bt_component_class_sink_simple_borrow(); + if (!comp_cls) { + BT_LIB_LOGE_APPEND_CAUSE( + "Cannot borrow simple sink component class."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto end; + } + + status = bt_graph_add_sink_component_with_initialize_method_data(graph, + comp_cls, name, NULL, &init_method_data, + BT_LOGGING_LEVEL_NONE, component); end: - (void) init_can_consume; - bt_graph_set_can_consume(graph, init_can_consume); - return ret; + return status; } BT_HIDDEN @@ -1518,6 +1532,32 @@ void bt_graph_add_message(struct bt_graph *graph, g_ptr_array_add(graph->messages, msg); } +BT_HIDDEN +bool bt_graph_is_interrupted(const struct bt_graph *graph) +{ + BT_ASSERT_DBG(graph); + return bt_interrupter_array_any_is_set(graph->interrupters); +} + +enum bt_graph_add_interrupter_status bt_graph_add_interrupter( + struct bt_graph *graph, const struct bt_interrupter *intr) +{ + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + BT_ASSERT_PRE_NON_NULL(intr, "Interrupter"); + g_ptr_array_add(graph->interrupters, (void *) intr); + bt_object_get_ref_no_null_check(intr); + BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z", + graph, intr); + return BT_FUNC_STATUS_OK; +} + +void bt_graph_interrupt(struct bt_graph *graph) +{ + BT_ASSERT_PRE_NON_NULL(graph, "Graph"); + bt_interrupter_set(graph->default_interrupter); + BT_LIB_LOGI("Interrupted graph: %!+g", graph); +} + void bt_graph_get_ref(const struct bt_graph *graph) { bt_object_get_ref(graph);