Document libbabeltrace2's C API
[babeltrace.git] / src / lib / graph / graph.c
index cf112fbd8393907c0f7a8f5637188fadeec0f606..b545a8ef234b247e9a0731902c4fb9d732bd6d41 100644 (file)
 #include "lib/assert-pre.h"
 #include "lib/assert-post.h"
 #include <babeltrace2/graph/graph.h>
-#include <babeltrace2/graph/graph-const.h>
-#include <babeltrace2/graph/component-source-const.h>
-#include <babeltrace2/graph/component-filter-const.h>
-#include <babeltrace2/graph/port-const.h>
+#include <babeltrace2/graph/component.h>
+#include <babeltrace2/graph/port.h>
 #include "lib/graph/message/message.h"
 #include "compat/compiler.h"
 #include "common/common.h"
 #include <babeltrace2/types.h>
 #include <babeltrace2/value.h>
-#include <babeltrace2/value-const.h>
 #include "lib/value.h"
 #include <unistd.h>
+#include <stdbool.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"
 
 typedef enum bt_graph_listener_func_status
 (*port_added_func_t)(const void *, const void *, void *);
 
-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 *);
-
-struct bt_graph_listener {
-       bt_graph_listener_removed_func removed;
-       void *data;
-};
+typedef enum bt_component_class_initialize_method_status
+(*comp_init_method_t)(const void *, void *, const void *, void *);
 
 struct bt_graph_listener_port_added {
-       struct bt_graph_listener base;
        port_added_func_t func;
-};
-
-struct bt_graph_listener_ports_connected {
-       struct bt_graph_listener base;
-       ports_connected_func_t func;
+       void *data;
 };
 
 #define INIT_LISTENERS_ARRAY(_type, _listeners)                                \
@@ -83,23 +69,6 @@ struct bt_graph_listener_ports_connected {
                }                                                       \
        } while (0)
 
-#define CALL_REMOVE_LISTENERS(_type, _listeners)                       \
-       do {                                                            \
-               size_t i;                                               \
-                                                                       \
-               if (!_listeners) {                                      \
-                       break;                                          \
-               }                                                       \
-               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 destroy_graph(struct bt_object *obj)
 {
@@ -133,30 +102,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);
-
-       /* 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_ports_connected,
-               graph->listeners.source_filter_ports_connected);
-       CALL_REMOVE_LISTENERS(struct bt_graph_listener_ports_connected,
-               graph->listeners.filter_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);
+       graph->config_state = BT_GRAPH_CONFIGURATION_STATE_DESTROYING;
 
        if (graph->messages) {
                g_ptr_array_free(graph->messages, TRUE);
@@ -175,6 +121,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;
@@ -200,30 +154,6 @@ void destroy_graph(struct bt_object *obj)
                graph->listeners.sink_input_port_added = 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.filter_filter_ports_connected) {
-               g_array_free(graph->listeners.filter_filter_ports_connected,
-                       TRUE);
-               graph->listeners.filter_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;
-       }
-
        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);
@@ -257,11 +187,16 @@ 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_NO_ERROR();
+       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 +205,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) {
@@ -293,7 +229,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;
        }
 
@@ -301,7 +236,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;
        }
 
@@ -309,7 +243,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;
        }
 
@@ -317,42 +250,24 @@ struct bt_graph *bt_graph_create(void)
                graph->listeners.sink_input_port_added);
 
        if (!graph->listeners.sink_input_port_added) {
-               ret = -1;
-               goto error;
-       }
-
-       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;
        }
 
-       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;
-       }
-
-       INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected,
-               graph->listeners.filter_filter_ports_connected);
-
-       if (!graph->listeners.filter_filter_ports_connected) {
-               ret = -1;
+       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;
        }
 
-       INIT_LISTENERS_ARRAY(struct bt_graph_listener_ports_connected,
-               graph->listeners.filter_sink_ports_connected);
-
-       if (!graph->listeners.filter_sink_ports_connected) {
-               ret = -1;
+       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,
@@ -405,7 +320,6 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports(
                const struct bt_connection **user_connection)
 {
        enum bt_graph_connect_ports_status status = BT_FUNC_STATUS_OK;
-       enum bt_graph_listener_func_status listener_status;
        struct bt_connection *connection = NULL;
        struct bt_port *upstream_port = (void *) upstream_port_out;
        struct bt_port *downstream_port = (void *) downstream_port_in;
@@ -414,10 +328,10 @@ 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");
-       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);
@@ -507,27 +421,6 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports(
 
        connection->notified_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.");
-       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;
-       }
-
-       connection->notified_graph_ports_connected = true;
        BT_LIB_LOGI("Connected component ports within graph: "
                "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, "
                "%![up-port-]+p, %![down-port-]+p",
@@ -537,7 +430,6 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports(
        if (user_connection) {
                /* Move reference to user */
                *user_connection = connection;
-               connection = NULL;
        }
 
 end:
@@ -557,20 +449,21 @@ 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));
+       BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(consume_status);
        if (consume_status) {
                if (consume_status < 0) {
                        BT_LIB_LOGW_APPEND_CAUSE(
@@ -632,7 +525,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.");
@@ -649,7 +542,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:
@@ -663,7 +556,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);
 
@@ -682,15 +575,16 @@ 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_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);
-       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);
@@ -710,8 +604,8 @@ 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->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,
@@ -727,15 +621,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;
                }
 
@@ -758,8 +652,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:
@@ -773,24 +674,17 @@ enum bt_graph_add_listener_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)
+               void *data, bt_listener_id *out_listener_id)
 {
        struct bt_graph_listener_port_added listener = {
-               .base = {
-                       .removed = listener_removed,
-                       .data = data,
-               },
                .func = (port_added_func_t) func,
+               .data = data,
        };
-       int listener_id;
+       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");
-       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_LOGD("Added \"source component output port added\" listener to graph: "
@@ -808,24 +702,17 @@ enum bt_graph_add_listener_status
 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)
+               void *data, bt_listener_id *out_listener_id)
 {
        struct bt_graph_listener_port_added listener = {
-               .base = {
-                       .removed = listener_removed,
-                       .data = data,
-               },
                .func = (port_added_func_t) func,
+               .data = data,
        };
-       int listener_id;
+       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");
-       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_LOGD("Added \"filter component output port added\" listener to graph: "
@@ -843,24 +730,17 @@ enum bt_graph_add_listener_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)
+               void *data, bt_listener_id *out_listener_id)
 {
        struct bt_graph_listener_port_added listener = {
-               .base = {
-                       .removed = listener_removed,
-                       .data = data,
-               },
                .func = (port_added_func_t) func,
+               .data = data,
        };
-       int listener_id;
+       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");
-       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_LOGD("Added \"filter component input port added\" listener to graph: "
@@ -878,24 +758,17 @@ enum bt_graph_add_listener_status
 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)
+               void *data, bt_listener_id *out_listener_id)
 {
        struct bt_graph_listener_port_added listener = {
-               .base = {
-                       .removed = listener_removed,
-                       .data = data,
-               },
                .func = (port_added_func_t) func,
+               .data = data,
        };
-       int listener_id;
+       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");
-       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_LOGD("Added \"sink component input port added\" listener to graph: "
@@ -909,150 +782,6 @@ bt_graph_add_sink_component_input_port_added_listener(
        return BT_FUNC_STATUS_OK;
 }
 
-enum bt_graph_add_listener_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_LOGD("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;
-       }
-
-       return BT_FUNC_STATUS_OK;
-}
-
-enum bt_graph_add_listener_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_LOGD("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_FUNC_STATUS_OK;
-}
-
-enum bt_graph_add_listener_status
-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)
-{
-       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_filter_ports_connected,
-               listener);
-       listener_id = graph->listeners.filter_filter_ports_connected->len - 1;
-       BT_LIB_LOGD("Added \"filter 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;
-       }
-
-       return BT_FUNC_STATUS_OK;
-}
-
-enum bt_graph_add_listener_status
-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)
-{
-       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_LOGD("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;
-       }
-
-       return BT_FUNC_STATUS_OK;
-}
-
 BT_HIDDEN
 enum bt_graph_listener_func_status bt_graph_notify_port_added(
                struct bt_graph *graph, struct bt_port *port)
@@ -1077,7 +806,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;
@@ -1092,7 +821,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;
@@ -1104,13 +833,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++) {
@@ -1120,7 +849,8 @@ enum bt_graph_listener_func_status bt_graph_notify_port_added(
 
 
                BT_ASSERT(listener->func);
-               status = listener->func(comp, port, listener->base.data);
+               status = listener->func(comp, port, listener->data);
+               BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status);
                if (status != BT_FUNC_STATUS_OK) {
                        goto end;
                }
@@ -1130,98 +860,6 @@ end:
        return status;
 }
 
-BT_HIDDEN
-enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
-               struct bt_graph *graph, struct bt_port *upstream_port,
-               struct bt_port *downstream_port)
-{
-       uint64_t i;
-       GArray *listeners;
-       struct bt_component *upstream_comp;
-       struct bt_component *downstream_comp;
-       enum bt_graph_listener_func_status status = BT_FUNC_STATUS_OK;
-
-       BT_ASSERT(graph);
-       BT_ASSERT(upstream_port);
-       BT_ASSERT(downstream_port);
-       BT_LIB_LOGD("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();
-               }
-
-               break;
-       }
-       case BT_COMPONENT_CLASS_TYPE_FILTER:
-       {
-               switch (downstream_comp->class->type) {
-               case BT_COMPONENT_CLASS_TYPE_FILTER:
-                       listeners =
-                               graph->listeners.filter_filter_ports_connected;
-                       break;
-               case BT_COMPONENT_CLASS_TYPE_SINK:
-                       listeners =
-                               graph->listeners.filter_sink_ports_connected;
-                       break;
-               default:
-                       abort();
-               }
-
-               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);
-
-               BT_ASSERT(listener->func);
-               status = listener->func(upstream_comp, downstream_comp,
-                       upstream_port, downstream_port, listener->base.data);
-               if (status != BT_FUNC_STATUS_OK) {
-                       goto end;
-               }
-       }
-
-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)
@@ -1233,7 +871,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)
 {
@@ -1263,10 +900,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;
@@ -1275,7 +912,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);
@@ -1323,10 +959,15 @@ 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));
+               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(
@@ -1351,7 +992,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;
@@ -1374,7 +1016,6 @@ int add_component_with_init_method_data(
        if (user_component) {
                /* Move reference to user */
                *user_component = component;
-               component = NULL;
        }
 
 end:
@@ -1390,13 +1031,14 @@ 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,
                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,
@@ -1407,21 +1049,23 @@ 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(
+       BT_ASSERT_PRE_NO_ERROR();
+       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_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,
@@ -1432,21 +1076,23 @@ 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(
+       BT_ASSERT_PRE_NO_ERROR();
+       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_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,
@@ -1457,88 +1103,52 @@ 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(
+       BT_ASSERT_PRE_NO_ERROR();
+       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);
+       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,
+       };
 
-       if (graph->sinks_to_consume->length == 0) {
-               graph->has_sink = false;
-       }
+       BT_ASSERT_PRE_NO_ERROR();
 
        /*
-        * 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
@@ -1559,6 +1169,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_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_ref_no_null_check(intr);
+       BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z",
+               graph, intr);
+       return BT_FUNC_STATUS_OK;
+}
+
+struct bt_interrupter *bt_graph_borrow_default_interrupter(bt_graph *graph)
+{
+       BT_ASSERT_PRE_NON_NULL(graph, "Graph");
+       return graph->default_interrupter;
+}
+
 void bt_graph_get_ref(const struct bt_graph *graph)
 {
        bt_object_get_ref(graph);
This page took 0.037997 seconds and 4 git commands to generate.