lib: add pre condition asserts to check current thread has no error
[babeltrace.git] / src / lib / graph / graph.c
index 591b65d2036feb94a4ec8cd7891d6e507947cfbf..22c4f92f8ec33314cd7f74cec71a5adb0781e3b8 100644 (file)
@@ -40,6 +40,7 @@
 #include <babeltrace2/value-const.h>
 #include "lib/value.h"
 #include <unistd.h>
+#include <stdbool.h>
 #include <glib.h>
 
 #include "component-class-sink-simple.h"
@@ -267,6 +268,7 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
        struct bt_graph *graph;
        int ret;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE(mip_version <= bt_get_maximal_mip_version(),
                "Unknown MIP version: mip-version=%" PRIu64 ", "
                "max-mip-version=%" PRIu64,
@@ -303,7 +305,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.source_output_port_added);
 
        if (!graph->listeners.source_output_port_added) {
-               ret = -1;
                goto error;
        }
 
@@ -311,7 +312,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.filter_output_port_added);
 
        if (!graph->listeners.filter_output_port_added) {
-               ret = -1;
                goto error;
        }
 
@@ -319,7 +319,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.filter_input_port_added);
 
        if (!graph->listeners.filter_input_port_added) {
-               ret = -1;
                goto error;
        }
 
@@ -327,7 +326,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.sink_input_port_added);
 
        if (!graph->listeners.sink_input_port_added) {
-               ret = -1;
                goto error;
        }
 
@@ -335,7 +333,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.source_filter_ports_connected);
 
        if (!graph->listeners.source_filter_ports_connected) {
-               ret = -1;
                goto error;
        }
 
@@ -343,7 +340,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.source_sink_ports_connected);
 
        if (!graph->listeners.source_sink_ports_connected) {
-               ret = -1;
                goto error;
        }
 
@@ -351,7 +347,6 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                graph->listeners.filter_filter_ports_connected);
 
        if (!graph->listeners.filter_filter_ports_connected) {
-               ret = -1;
                goto error;
        }
 
@@ -359,12 +354,11 @@ struct bt_graph *bt_graph_create(uint64_t mip_version)
                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;
@@ -439,6 +433,7 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports(
        enum bt_component_class_port_connected_method_status port_connected_status;
        bool init_can_consume;
 
+       BT_ASSERT_PRE_NO_ERROR();
        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");
@@ -581,9 +576,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",
@@ -595,6 +590,7 @@ int consume_graph_sink(struct bt_component_sink *comp)
                consume_status == BT_FUNC_STATUS_MEMORY_ERROR,
                "Invalid component status returned by consuming method: "
                "status=%s", bt_common_func_status_string(consume_status));
+       BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(consume_status);
        if (consume_status) {
                if (consume_status < 0) {
                        BT_LIB_LOGW_APPEND_CAUSE(
@@ -656,7 +652,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.");
@@ -673,7 +669,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:
@@ -710,6 +706,7 @@ enum bt_graph_run_once_status bt_graph_run_once(struct bt_graph *graph)
 {
        enum bt_graph_run_once_status status;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_DEV_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_DEV(graph->can_consume,
                "Cannot consume graph in its current state: %!+g", graph);
@@ -734,6 +731,7 @@ enum bt_graph_run_status bt_graph_run(struct bt_graph *graph)
 {
        enum bt_graph_run_status status;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE(graph->can_consume,
                "Cannot consume graph in its current state: %!+g", graph);
@@ -781,8 +779,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:
@@ -808,6 +813,7 @@ bt_graph_add_source_component_output_port_added_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -843,6 +849,7 @@ bt_graph_add_filter_component_output_port_added_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -878,6 +885,7 @@ bt_graph_add_filter_component_input_port_added_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -913,6 +921,7 @@ bt_graph_add_sink_component_input_port_added_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -948,6 +957,7 @@ bt_graph_add_source_filter_component_ports_connected_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -984,6 +994,7 @@ bt_graph_add_source_sink_component_ports_connected_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -1020,6 +1031,7 @@ bt_graph_add_filter_filter_component_ports_connected_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -1056,6 +1068,7 @@ bt_graph_add_filter_sink_component_ports_connected_listener(
        };
        bt_listener_id listener_id;
 
+       BT_ASSERT_PRE_NO_ERROR();
        BT_ASSERT_PRE_NON_NULL(graph, "Graph");
        BT_ASSERT_PRE_NON_NULL(func, "Listener");
        BT_ASSERT_PRE_NON_NULL(func, "\"Listener removed\" listener");
@@ -1100,7 +1113,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added(
                        listeners = graph->listeners.source_output_port_added;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
@@ -1115,7 +1128,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added(
                        listeners = graph->listeners.filter_output_port_added;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
@@ -1127,13 +1140,13 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added(
                        listeners = graph->listeners.sink_input_port_added;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        for (i = 0; i < listeners->len; i++) {
@@ -1144,6 +1157,7 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added(
 
                BT_ASSERT(listener->func);
                status = listener->func(comp, port, listener->base.data);
+               BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
                if (status != BT_FUNC_STATUS_OK) {
                        goto end;
                }
@@ -1188,7 +1202,7 @@ enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
                                graph->listeners.source_sink_ports_connected;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
@@ -1205,13 +1219,13 @@ enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
                                graph->listeners.filter_sink_ports_connected;
                        break;
                default:
-                       abort();
+                       bt_common_abort();
                }
 
                break;
        }
        default:
-               abort();
+               bt_common_abort();
        }
 
        for (i = 0; i < listeners->len; i++) {
@@ -1222,6 +1236,7 @@ enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
                BT_ASSERT(listener->func);
                status = listener->func(upstream_comp, downstream_comp,
                        upstream_port, downstream_port, listener->base.data);
+               BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(status);
                if (status != BT_FUNC_STATUS_OK) {
                        goto end;
                }
@@ -1338,6 +1353,7 @@ int add_component_with_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));
+               BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(init_status);
                if (init_status != BT_FUNC_STATUS_OK) {
                        if (init_status < 0) {
                                BT_LIB_LOGW_APPEND_CAUSE(
@@ -1409,6 +1425,7 @@ bt_graph_add_source_component_with_initialize_method_data(
                void *init_method_data, bt_logging_level log_level,
                const struct bt_component_source **component)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        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,
@@ -1422,6 +1439,7 @@ enum bt_graph_add_component_status bt_graph_add_source_component(
                enum bt_logging_level log_level,
                const struct bt_component_source **component)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        return bt_graph_add_source_component_with_initialize_method_data(
                graph, comp_cls, name, params, NULL, log_level, component);
 }
@@ -1434,6 +1452,7 @@ bt_graph_add_filter_component_with_initialize_method_data(
                void *init_method_data, enum bt_logging_level log_level,
                const struct bt_component_filter **component)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        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,
@@ -1447,6 +1466,7 @@ enum bt_graph_add_component_status bt_graph_add_filter_component(
                enum bt_logging_level log_level,
                const struct bt_component_filter **component)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        return bt_graph_add_filter_component_with_initialize_method_data(
                graph, comp_cls, name, params, NULL, log_level, component);
 }
@@ -1459,6 +1479,7 @@ bt_graph_add_sink_component_with_initialize_method_data(
                void *init_method_data, enum bt_logging_level log_level,
                const struct bt_component_sink **component)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        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,
@@ -1472,6 +1493,7 @@ enum bt_graph_add_component_status bt_graph_add_sink_component(
                enum bt_logging_level log_level,
                const struct bt_component_sink **component)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        return bt_graph_add_sink_component_with_initialize_method_data(
                graph, comp_cls, name, params, NULL, log_level, component);
 }
@@ -1492,6 +1514,8 @@ bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name,
                .user_data = user_data,
        };
 
+       BT_ASSERT_PRE_NO_ERROR();
+
        /*
         * Other preconditions are checked by
         * bt_graph_add_sink_component_with_init_method_data().
@@ -1514,83 +1538,6 @@ end:
        return status;
 }
 
-BT_HIDDEN
-int bt_graph_remove_unconnected_component(struct bt_graph *graph,
-               struct bt_component *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;
-       }
-
-       /*
-        * 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)
@@ -1612,17 +1559,18 @@ 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);
 }
 
 enum bt_graph_add_interrupter_status bt_graph_add_interrupter(
                struct bt_graph *graph, const struct bt_interrupter *intr)
 {
+       BT_ASSERT_PRE_NO_ERROR();
        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.030569 seconds and 4 git commands to generate.