lib: remove unused _NO_SINK graph status
[babeltrace.git] / include / babeltrace / graph / graph-internal.h
index 2ff92d35f741e63b20800589c7fb8ec831107172..d9ae46f6b0573785e462e8c6f8f8f52a3145a43f 100644 (file)
@@ -26,7 +26,9 @@
 
 #include <babeltrace/graph/graph.h>
 #include <babeltrace/graph/connection-internal.h>
-#include <babeltrace/graph/notification-const.h>
+#include <babeltrace/graph/message-const.h>
+#include <babeltrace/graph/component-internal.h>
+#include <babeltrace/graph/component-sink-internal.h>
 #include <babeltrace/babeltrace-internal.h>
 #include <babeltrace/object-internal.h>
 #include <babeltrace/object-pool-internal.h>
 struct bt_component;
 struct bt_port;
 
+enum bt_graph_configuration_state {
+       BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
+       BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
+       BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
+       BT_GRAPH_CONFIGURATION_STATE_FAULTY,
+};
+
 struct bt_graph {
        /**
         * A component graph contains components and point-to-point connection
@@ -67,53 +76,49 @@ struct bt_graph {
         * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
         * functions always work.
         *
-        * In bt_port_output_notification_iterator_create(), on success,
+        * In bt_port_output_message_iterator_create(), on success,
         * this flag is cleared so that the iterator remains the only
         * consumer for the graph's lifetime.
         */
        bool can_consume;
 
+       enum bt_graph_configuration_state config_state;
+
        struct {
                GArray *source_output_port_added;
                GArray *filter_output_port_added;
                GArray *filter_input_port_added;
                GArray *sink_input_port_added;
-               GArray *source_output_port_removed;
-               GArray *filter_output_port_removed;
-               GArray *filter_input_port_removed;
-               GArray *sink_input_port_removed;
                GArray *source_filter_ports_connected;
                GArray *source_sink_ports_connected;
+               GArray *filter_filter_ports_connected;
                GArray *filter_sink_ports_connected;
-               GArray *source_filter_ports_disconnected;
-               GArray *source_sink_ports_disconnected;
-               GArray *filter_sink_ports_disconnected;
        } listeners;
 
-       /* Pool of `struct bt_notification_event *` */
-       struct bt_object_pool event_notif_pool;
+       /* Pool of `struct bt_message_event *` */
+       struct bt_object_pool event_msg_pool;
 
-       /* Pool of `struct bt_notification_packet_beginning *` */
-       struct bt_object_pool packet_begin_notif_pool;
+       /* Pool of `struct bt_message_packet_beginning *` */
+       struct bt_object_pool packet_begin_msg_pool;
 
-       /* Pool of `struct bt_notification_packet_end *` */
-       struct bt_object_pool packet_end_notif_pool;
+       /* Pool of `struct bt_message_packet_end *` */
+       struct bt_object_pool packet_end_msg_pool;
 
        /*
-        * Array of `struct bt_notification *` (weak).
+        * Array of `struct bt_message *` (weak).
         *
-        * This is an array of all the notifications ever created from
+        * This is an array of all the messages ever created from
         * this graph. Some of them can be in one of the pools above,
-        * some of them can be at large. Because each notification has a
+        * some of them can be at large. Because each message has a
         * weak pointer to the graph containing its pool, we need to
-        * notify each notification that the graph is gone on graph
+        * notify each message that the graph is gone on graph
         * destruction.
         *
         * TODO: When we support a maximum size for object pools,
-        * add a way for a notification to remove itself from this
+        * add a way for a message to remove itself from this
         * array (on destruction).
         */
-       GPtrArray *notifications;
+       GPtrArray *messages;
 };
 
 static inline
@@ -136,21 +141,10 @@ enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph,
 BT_HIDDEN
 void bt_graph_notify_port_added(struct bt_graph *graph, struct bt_port *port);
 
-BT_HIDDEN
-void bt_graph_notify_port_removed(struct bt_graph *graph,
-               struct bt_component *comp, struct bt_port *port);
-
 BT_HIDDEN
 void bt_graph_notify_ports_connected(struct bt_graph *graph,
                struct bt_port *upstream_port, struct bt_port *downstream_port);
 
-BT_HIDDEN
-void bt_graph_notify_ports_disconnected(struct bt_graph *graph,
-               struct bt_component *upstream_comp,
-               struct bt_component *downstream_comp,
-               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);
@@ -168,8 +162,8 @@ int bt_graph_remove_unconnected_component(struct bt_graph *graph,
                struct bt_component *component);
 
 BT_HIDDEN
-void bt_graph_add_notification(struct bt_graph *graph,
-               struct bt_notification *notif);
+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)
@@ -183,8 +177,6 @@ const char *bt_graph_status_string(enum bt_graph_status status)
                return "BT_GRAPH_STATUS_END";
        case BT_GRAPH_STATUS_OK:
                return "BT_GRAPH_STATUS_OK";
-       case BT_GRAPH_STATUS_NO_SINK:
-               return "BT_GRAPH_STATUS_NO_SINK";
        case BT_GRAPH_STATUS_ERROR:
                return "BT_GRAPH_STATUS_ERROR";
        case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
@@ -196,4 +188,101 @@ const char *bt_graph_status_string(enum bt_graph_status status)
        }
 }
 
+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";
+       case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
+               return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
+       case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
+               return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
+       default:
+               return "(unknown)";
+       }
+}
+
+static inline
+enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
+{
+       enum bt_graph_status status = BT_GRAPH_STATUS_OK;
+       uint64_t i;
+
+       BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
+
+       if (likely(graph->config_state ==
+                       BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
+               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++) {
+               struct bt_component *comp = graph->components->pdata[i];
+               struct bt_component_sink *comp_sink = (void *) comp;
+               struct bt_component_class_sink *comp_cls_sink =
+                       (void *) comp->class;
+
+               if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
+                       continue;
+               }
+
+               if (comp_sink->graph_is_configured_method_called) {
+                       continue;
+               }
+
+               if (comp_cls_sink->methods.graph_is_configured) {
+                       enum bt_self_component_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,
+                               "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
+
+                               goto end;
+                       }
+               }
+
+               comp_sink->graph_is_configured_method_called = true;
+       }
+
+       graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
+
+end:
+       return status;
+}
+
 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
This page took 0.026413 seconds and 4 git commands to generate.