Document libbabeltrace2's C API

[babeltrace.git] / src / lib / graph / graph.h

diff --git a/src/lib/graph/graph.h b/src/lib/graph/graph.h
index ef847361e16dcd352b10abf12f3444bedcb6afb1..7fffd0ca3bc213c8cb093bbdf73205d9d4cbbe6f 100644 (file)
--- a/src/lib/graph/graph.h
+++ b/src/lib/graph/graph.h
@@ -30,12 +30,13 @@
 #endif
 
 #include <babeltrace2/graph/graph.h>
-#include <babeltrace2/graph/message-const.h>
+#include <babeltrace2/graph/message.h>
 #include "common/macros.h"
 #include "lib/object.h"
 #include "lib/object-pool.h"
 #include "common/assert.h"
 #include "common/common.h"
+#include <stdbool.h>
 #include <stdlib.h>
 #include <glib.h>
 
@@ -67,6 +68,7 @@ enum bt_graph_configuration_state {
        BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
        BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
        BT_GRAPH_CONFIGURATION_STATE_FAULTY,
+       BT_GRAPH_CONFIGURATION_STATE_DESTROYING,
 };
 
 struct bt_graph {
@@ -89,8 +91,20 @@ struct bt_graph {
        /* Queue of pointers (weak references) to sink bt_components. */
        GQueue *sinks_to_consume;
 
-       bool canceled;
-       bool in_remove_listener;
+       uint64_t mip_version;
+
+       /*
+        * Array of `struct bt_interrupter *`, each one owned by this.
+        * If any interrupter is set, then this graph is deemed
+        * interrupted.
+        */
+       GPtrArray *interrupters;
+
+       /*
+        * Default interrupter, owned by this.
+        */
+       struct bt_interrupter *default_interrupter;
+
        bool has_sink;
 
        /*
@@ -112,10 +126,6 @@ struct bt_graph {
                GArray *filter_output_port_added;
                GArray *filter_input_port_added;
                GArray *sink_input_port_added;
-               GArray *source_filter_ports_connected;
-               GArray *source_sink_ports_connected;
-               GArray *filter_filter_ports_connected;
-               GArray *filter_sink_ports_connected;
        } listeners;
 
        /* Pool of `struct bt_message_event *` */
@@ -145,18 +155,12 @@ struct bt_graph {
 };
 
 static inline
-void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
+void bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
 {
-       BT_ASSERT(graph);
+       BT_ASSERT_DBG(graph);
        graph->can_consume = can_consume;
 }
 
-#ifdef BT_DEV_MODE
-# define bt_graph_set_can_consume      _bt_graph_set_can_consume
-#else
-# define bt_graph_set_can_consume(_graph, _can_consume)
-#endif
-
 BT_HIDDEN
 int bt_graph_consume_sink_no_check(struct bt_graph *graph,
                struct bt_component_sink *sink);
@@ -165,42 +169,32 @@ BT_HIDDEN
 enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
                struct bt_port *port);
 
-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);
-
 BT_HIDDEN
 void bt_graph_remove_connection(struct bt_graph *graph,
                struct bt_connection *connection);
 
-/*
- * This only works with a component which is not connected at this
- * point.
- *
- * Also the reference count of `component` should be 0 when you call
- * this function, which means only `graph` owns the component, so it
- * is safe to destroy.
- */
-BT_HIDDEN
-int bt_graph_remove_unconnected_component(struct bt_graph *graph,
-               struct bt_component *component);
-
 BT_HIDDEN
 void bt_graph_add_message(struct bt_graph *graph,
                struct bt_message *msg);
 
+BT_HIDDEN
+bool bt_graph_is_interrupted(const struct bt_graph *graph);
+
 static inline
 const char *bt_graph_configuration_state_string(
                enum bt_graph_configuration_state state)
 {
        switch (state) {
        case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
-               return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
+               return "CONFIGURING";
        case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
-               return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
+               return "PARTIALLY_CONFIGURED";
        case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
-               return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
+               return "CONFIGURED";
+       case BT_GRAPH_CONFIGURATION_STATE_FAULTY:
+               return "FAULTY";
+       case BT_GRAPH_CONFIGURATION_STATE_DESTROYING:
+               return "DESTROYING";
        default:
                return "(unknown)";
        }
@@ -212,7 +206,8 @@ int bt_graph_configure(struct bt_graph *graph)
        int status = BT_FUNC_STATUS_OK;
        uint64_t i;
 
-       BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
+       BT_ASSERT_DBG(graph->config_state !=
+               BT_GRAPH_CONFIGURATION_STATE_FAULTY);
 
        if (G_LIKELY(graph->config_state ==
                        BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
@@ -251,8 +246,8 @@ int bt_graph_configure(struct bt_graph *graph)
                                comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
                                "Unexpected returned status: status=%s",
                                bt_common_func_status_string(comp_status));
+                       BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(comp_status);
                        if (comp_status != BT_FUNC_STATUS_OK) {
-                               comp_status = BT_FUNC_STATUS_ERROR;
                                if (comp_status < 0) {
                                        BT_LIB_LOGW_APPEND_CAUSE(
                                                "Component's \"graph is configured\" method failed: "