lib: add bt_{graph,query_executor}_add_interrupter()
[babeltrace.git] / src / lib / graph / graph.h
index b3b178c647bf4e9ae9b49aa2af3bab96067b9762..4e500d49002417b44854a324134c1e8b2f90f698 100644 (file)
  * SOFTWARE.
  */
 
+/* Protection: this file uses BT_LIB_LOG*() macros directly */
+#ifndef BT_LIB_LOG_SUPPORTED
+# error Please include "lib/logging.h" before including this file.
+#endif
+
 #include <babeltrace2/graph/graph.h>
 #include <babeltrace2/graph/message-const.h>
 #include "common/macros.h"
 #include "component.h"
 #include "component-sink.h"
 #include "connection.h"
+#include "lib/func-status.h"
+
+/* Protection: this file uses BT_LIB_LOG*() macros directly */
+#ifndef BT_LIB_LOG_SUPPORTED
+# error Please include "lib/logging.h" before including this file.
+#endif
+
+/* Protection: this file uses BT_ASSERT_PRE*() macros directly */
+#ifndef BT_ASSERT_PRE_SUPPORTED
+# error Please include "lib/assert-pre.h" before including this file.
+#endif
+
+/* Protection: this file uses BT_ASSERT_POST*() macros directly */
+#ifndef BT_ASSERT_POST_SUPPORTED
+# error Please include "lib/assert-post.h" before including this file.
+#endif
 
 struct bt_component;
 struct bt_port;
@@ -46,6 +67,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 {
@@ -68,14 +90,26 @@ struct bt_graph {
        /* Queue of pointers (weak references) to sink bt_components. */
        GQueue *sinks_to_consume;
 
-       bool canceled;
+       /*
+        * 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 to support bt_graph_interrupt(); owned
+        * by this.
+        */
+       struct bt_interrupter *default_interrupter;
+
        bool in_remove_listener;
        bool has_sink;
 
        /*
         * If this is false, then the public API's consuming
         * functions (bt_graph_consume() and bt_graph_run()) return
-        * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
+        * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
         * functions always work.
         *
         * In bt_port_output_message_iterator_create(), on success,
@@ -124,28 +158,22 @@ 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);
        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
-enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph,
+int bt_graph_consume_sink_no_check(struct bt_graph *graph,
                struct bt_component_sink *sink);
 
 BT_HIDDEN
-enum bt_graph_listener_status bt_graph_notify_port_added(struct bt_graph *graph,
+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_status bt_graph_notify_ports_connected(
+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);
 
@@ -169,26 +197,8 @@ BT_HIDDEN
 void bt_graph_add_message(struct bt_graph *graph,
                struct bt_message *msg);
 
-static inline
-const char *bt_graph_status_string(enum bt_graph_status status)
-{
-       switch (status) {
-       case BT_GRAPH_STATUS_CANCELED:
-               return "BT_GRAPH_STATUS_CANCELED";
-       case BT_GRAPH_STATUS_AGAIN:
-               return "BT_GRAPH_STATUS_AGAIN";
-       case BT_GRAPH_STATUS_END:
-               return "BT_GRAPH_STATUS_END";
-       case BT_GRAPH_STATUS_OK:
-               return "BT_GRAPH_STATUS_OK";
-       case BT_GRAPH_STATUS_ERROR:
-               return "BT_GRAPH_STATUS_ERROR";
-       case BT_GRAPH_STATUS_NOMEM:
-               return "BT_GRAPH_STATUS_NOMEM";
-       default:
-               return "(unknown)";
-       }
-}
+BT_HIDDEN
+bool bt_graph_is_interrupted(const struct bt_graph *graph);
 
 static inline
 const char *bt_graph_configuration_state_string(
@@ -207,9 +217,9 @@ const char *bt_graph_configuration_state_string(
 }
 
 static inline
-enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
+int bt_graph_configure(struct bt_graph *graph)
 {
-       enum bt_graph_status status = BT_GRAPH_STATUS_OK;
+       int status = BT_FUNC_STATUS_OK;
        uint64_t i;
 
        BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
@@ -219,10 +229,7 @@ enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
                goto end;
        }
 
-#ifdef BT_ASSERT_PRE
        BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
-#endif
-
        graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
 
        for (i = 0; i < graph->components->len; i++) {
@@ -240,40 +247,32 @@ enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
                }
 
                if (comp_cls_sink->methods.graph_is_configured) {
-                       enum bt_self_component_status comp_status;
+                       enum bt_component_class_sink_graph_is_configured_method_status comp_status;
 
-#ifdef BT_LIB_LOGD
                        BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
                                "%![graph-]+g, %![comp-]+c",
                                graph, comp);
-#endif
-
                        comp_status = comp_cls_sink->methods.graph_is_configured(
                                (void *) comp_sink);
-
-#ifdef BT_LIB_LOGD
                        BT_LIB_LOGD("User method returned: status=%s",
-                               bt_self_component_status_string(comp_status));
-#endif
-
-#ifdef BT_ASSERT_PRE
-                       BT_ASSERT_PRE(comp_status == BT_SELF_COMPONENT_STATUS_OK ||
-                               comp_status == BT_SELF_COMPONENT_STATUS_ERROR ||
-                               comp_status == BT_SELF_COMPONENT_STATUS_NOMEM,
+                               bt_common_func_status_string(comp_status));
+                       BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
+                               comp_status == BT_FUNC_STATUS_ERROR ||
+                               comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
                                "Unexpected returned status: status=%s",
-                               bt_self_component_status_string(comp_status));
-#endif
-
-                       if (comp_status != BT_SELF_COMPONENT_STATUS_OK) {
-                               status = BT_GRAPH_STATUS_ERROR;
-#ifdef BT_LIB_LOGW
-                               BT_LIB_LOGW("User's \"graph is configured\" method failed: "
-                                       "%![comp-]+c, status=%s",
-                                       comp,
-                                       bt_self_component_status_string(
-                                               comp_status));
-#endif
-
+                               bt_common_func_status_string(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: "
+                                               "%![comp-]+c, status=%s",
+                                               comp,
+                                               bt_common_func_status_string(
+                                                       comp_status));
+                               }
+
+                               status = comp_status;
                                goto end;
                        }
                }
@@ -291,9 +290,7 @@ static inline
 void bt_graph_make_faulty(struct bt_graph *graph)
 {
        graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
-#ifdef BT_LIB_LOGI
        BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
-#endif
 }
 
 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
This page took 0.027283 seconds and 4 git commands to generate.