X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fgraph.c;h=b3e41d320db112db8ac65421974c7ed96a06107d;hb=59225a3e0e13a9c674234755e55055d9ff68d635;hp=076fc5fd1a439a2d7d2f088d18c1e2618321bbf6;hpb=bdb288b3e94e412a33c8647d44f6cfac66ca0665;p=babeltrace.git

diff --git a/src/lib/graph/graph.c b/src/lib/graph/graph.c
index 076fc5fd..b3e41d32 100644
--- a/src/lib/graph/graph.c
+++ b/src/lib/graph/graph.c
@@ -42,10 +42,12 @@
 #include <unistd.h>
 #include <glib.h>
 
+#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"
 
@@ -57,7 +59,7 @@ typedef enum bt_graph_listener_func_status
 		const void *, void *);
 
 typedef enum bt_component_class_init_method_status
-(*comp_init_method_t)(const void *, const void *, void *);
+(*comp_init_method_t)(const void *, void *, const void *, void *);
 
 struct bt_graph_listener {
 	bt_graph_listener_removed_func removed;
@@ -133,12 +135,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,
@@ -175,6 +172,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;
@@ -257,11 +262,15 @@ 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) {
@@ -270,6 +279,7 @@ struct bt_graph *bt_graph_create(void)
 	}
 
 	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) {
@@ -353,6 +363,21 @@ struct bt_graph *bt_graph_create(void)
 		goto error;
 	}
 
+	graph->interrupters = g_ptr_array_new_with_free_func(
+		(GDestroyNotify) bt_object_put_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,
@@ -417,7 +442,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);
@@ -682,12 +706,11 @@ 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_DEV_NON_NULL(graph, "Graph");
-	BT_ASSERT_PRE_DEV(!graph->canceled, "Graph is canceled: %!+g", graph);
 	BT_ASSERT_PRE_DEV(graph->can_consume,
 		"Cannot consume graph in its current state: %!+g", graph);
 	BT_ASSERT_PRE_DEV(graph->config_state !=
@@ -712,7 +735,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,
@@ -728,15 +750,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;
 		}
 
@@ -775,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 = {
@@ -784,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");
@@ -810,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 = {
@@ -819,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");
@@ -845,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 = {
@@ -854,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");
@@ -880,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 = {
@@ -889,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");
@@ -915,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 = {
@@ -924,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");
@@ -951,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 = {
@@ -960,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");
@@ -987,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 = {
@@ -996,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");
@@ -1023,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 = {
@@ -1032,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");
@@ -1209,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_DEV_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)
@@ -1234,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)
 {
@@ -1264,7 +1271,7 @@ 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;
@@ -1276,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);
@@ -1324,8 +1330,12 @@ 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) {
@@ -1352,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;
@@ -1408,7 +1419,7 @@ 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(
@@ -1420,7 +1431,7 @@ 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, 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");
@@ -1433,7 +1444,7 @@ 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(
@@ -1445,7 +1456,7 @@ 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, 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");
@@ -1458,13 +1469,51 @@ 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(
 		graph, comp_cls, name, params, NULL, log_level, 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_init_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)
+{
+	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,
+	};
+
+	/*
+	 * Other preconditions are checked by
+	 * bt_graph_add_sink_component_with_init_method_data().
+	 */
+	BT_ASSERT_PRE_NON_NULL(consume_func, "Consume function");
+
+	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_init_method_data(graph,
+		comp_cls, name, NULL, &init_method_data,
+		BT_LOGGING_LEVEL_NONE, component);
+
+end:
+	return status;
+}
+
 BT_HIDDEN
 int bt_graph_remove_unconnected_component(struct bt_graph *graph,
 		struct bt_component *component)
@@ -1560,6 +1609,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(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_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);