lib: remove `BT_GRAPH_RUN_STATUS_END`
[babeltrace.git] / src / lib / graph / graph.c
index e4aed1f28143550eb647d4a7065274289e257b07..ed66ba89ef5c2c13d1629c6421aa16ef5db80fa5 100644 (file)
@@ -42,6 +42,7 @@
 #include <unistd.h>
 #include <glib.h>
 
+#include "component-class-sink-simple.h"
 #include "component.h"
 #include "component-sink.h"
 #include "connection.h"
@@ -57,8 +58,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;
@@ -261,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) {
@@ -274,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) {
@@ -297,7 +303,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;
        }
 
@@ -305,7 +310,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;
        }
 
@@ -313,7 +317,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;
        }
 
@@ -321,7 +324,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;
        }
 
@@ -329,7 +331,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;
        }
 
@@ -337,7 +338,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;
        }
 
@@ -345,7 +345,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;
        }
 
@@ -353,12 +352,11 @@ 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_no_null_check);
+               (GDestroyNotify) bt_object_put_ref_no_null_check);
        if (!graph->interrupters) {
                BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray.");
                goto error;
@@ -575,9 +573,9 @@ 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",
@@ -650,7 +648,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.");
@@ -667,7 +665,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:
@@ -700,9 +698,9 @@ 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->can_consume,
@@ -775,8 +773,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:
@@ -1265,10 +1270,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;
@@ -1324,8 +1329,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 +1361,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;
@@ -1391,7 +1401,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,
@@ -1408,19 +1418,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");
@@ -1433,19 +1443,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");
@@ -1458,88 +1468,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_APPEND_CAUSE(
-                               "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_APPEND_CAUSE(
-                               "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
@@ -1563,7 +1534,7 @@ void bt_graph_add_message(struct bt_graph *graph,
 BT_HIDDEN
 bool bt_graph_is_interrupted(const struct bt_graph *graph)
 {
-       BT_ASSERT(graph);
+       BT_ASSERT_DBG(graph);
        return bt_interrupter_array_any_is_set(graph->interrupters);
 }
 
@@ -1573,7 +1544,7 @@ enum bt_graph_add_interrupter_status bt_graph_add_interrupter(
        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_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;
This page took 0.028076 seconds and 4 git commands to generate.