lib: use common precond. assert. macros from `assert-cond.h` thru lib
[babeltrace.git] / src / lib / graph / graph.c
index 9e7e8ffce188b0b156a067c40d0febb8d4365f0f..f40c61047078efdc8abcf4ad573dd44bc4e7cd6a 100644 (file)
@@ -1,43 +1,23 @@
 /*
+ * SPDX-License-Identifier: MIT
+ *
  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
  * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
  */
 
 #define BT_LOG_TAG "LIB/GRAPH"
 #include "lib/logging.h"
 
 #include "common/assert.h"
-#include "lib/assert-pre.h"
-#include "lib/assert-post.h"
+#include "lib/assert-cond.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>
@@ -332,7 +312,7 @@ enum bt_graph_connect_ports_status bt_graph_connect_ports(
        bool init_can_consume;
 
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(graph, "Graph");
+       BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
        BT_ASSERT_PRE_NON_NULL(upstream_port, "Upstream port");
        BT_ASSERT_PRE_NON_NULL(downstream_port, "Downstream port port");
        BT_ASSERT_PRE(
@@ -578,21 +558,92 @@ end:
        return status;
 }
 
+static
+int configure_graph(struct bt_graph *graph)
+{
+       int status = BT_FUNC_STATUS_OK;
+       uint64_t i;
+
+       BT_ASSERT_DBG(graph->config_state !=
+               BT_GRAPH_CONFIGURATION_STATE_FAULTY);
+
+       if (G_LIKELY(graph->config_state ==
+                       BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
+               goto end;
+       }
+
+       BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
+       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_component_class_sink_graph_is_configured_method_status comp_status;
+
+                       BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
+                               "%![graph-]+g, %![comp-]+c",
+                               graph, comp);
+                       comp_status = comp_cls_sink->methods.graph_is_configured(
+                               (void *) comp_sink);
+                       BT_LIB_LOGD("User method returned: status=%s",
+                               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_common_func_status_string(comp_status));
+                       BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(comp_status);
+                       if (comp_status != BT_FUNC_STATUS_OK) {
+                               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;
+                       }
+               }
+
+               comp_sink->graph_is_configured_method_called = true;
+       }
+
+       graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
+
+end:
+       return status;
+}
+
 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_NON_NULL(graph);
        BT_ASSERT_PRE_DEV(graph->can_consume,
                "Cannot consume graph in its current state: %!+g", graph);
        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);
+       status = configure_graph(graph);
        if (G_UNLIKELY(status)) {
-               /* bt_graph_configure() logs errors */
+               /* configure_graph() logs errors */
                goto end;
        }
 
@@ -608,15 +659,15 @@ 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_NON_NULL(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,
                "Graph is in a faulty state: %!+g", graph);
        bt_graph_set_can_consume(graph, false);
-       status = bt_graph_configure(graph);
+       status = configure_graph(graph);
        if (G_UNLIKELY(status)) {
-               /* bt_graph_configure() logs errors */
+               /* configure_graph() logs errors */
                goto end;
        }
 
@@ -686,8 +737,8 @@ 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_GRAPH_NON_NULL(graph);
+       BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
        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: "
@@ -714,8 +765,8 @@ 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_GRAPH_NON_NULL(graph);
+       BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
        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: "
@@ -742,8 +793,8 @@ 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_GRAPH_NON_NULL(graph);
+       BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
        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: "
@@ -770,8 +821,8 @@ 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_GRAPH_NON_NULL(graph);
+       BT_ASSERT_PRE_LISTENER_FUNC_NON_NULL(func);
        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: "
@@ -884,7 +935,7 @@ bool component_name_exists(struct bt_graph *graph, const char *name)
                struct bt_component *other_comp = graph->components->pdata[i];
 
                if (strcmp(name, bt_component_get_name(other_comp)) == 0) {
-                       BT_ASSERT_PRE_MSG("Another component with the same name already exists in the graph: "
+                       BT_ASSERT_COND_MSG("Another component with the same name already exists in the graph: "
                                "%![other-comp-]+c, name=\"%s\"",
                                other_comp, name);
                        exists = true;
@@ -913,15 +964,14 @@ int add_component_with_init_method_data(
        struct bt_value *new_params = NULL;
 
        BT_ASSERT(comp_cls);
-       BT_ASSERT_PRE_NON_NULL(graph, "Graph");
-       BT_ASSERT_PRE_NON_NULL(name, "Name");
+       BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
+       BT_ASSERT_PRE_NAME_NON_NULL(name);
        BT_ASSERT_PRE(
                graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
                "Graph is not in the \"configuring\" state: %!+g", graph);
        BT_ASSERT_PRE(!component_name_exists(graph, name),
                "Duplicate component name: %!+g, name=\"%s\"", graph, name);
-       BT_ASSERT_PRE(!params || bt_value_is_map(params),
-               "Parameter value is not a map value: %!+v", params);
+       BT_ASSERT_PRE_PARAM_VALUE_IS_MAP(params);
        init_can_consume = graph->can_consume;
        bt_graph_set_can_consume(graph, false);
        BT_LIB_LOGI("Adding component to graph: "
@@ -1042,7 +1092,7 @@ bt_graph_add_source_component_with_initialize_method_data(
                const struct bt_component_source **component)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class");
+       BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
        return add_component_with_init_method_data(graph,
                (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init,
                name, params, init_method_data, log_level, (void *) component);
@@ -1069,7 +1119,7 @@ bt_graph_add_filter_component_with_initialize_method_data(
                const struct bt_component_filter **component)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class");
+       BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
        return add_component_with_init_method_data(graph,
                (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init,
                name, params, init_method_data, log_level, (void *) component);
@@ -1096,7 +1146,7 @@ bt_graph_add_sink_component_with_initialize_method_data(
                const struct bt_component_sink **component)
 {
        BT_ASSERT_PRE_NO_ERROR();
-       BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class");
+       BT_ASSERT_PRE_COMP_CLS_NON_NULL(comp_cls);
        return add_component_with_init_method_data(graph,
                (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init,
                name, params, init_method_data, log_level, (void *) component);
@@ -1183,8 +1233,8 @@ 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");
+       BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
+       BT_ASSERT_PRE_INTR_NON_NULL(intr);
        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",
@@ -1194,7 +1244,7 @@ enum bt_graph_add_interrupter_status bt_graph_add_interrupter(
 
 struct bt_interrupter *bt_graph_borrow_default_interrupter(bt_graph *graph)
 {
-       BT_ASSERT_PRE_NON_NULL(graph, "Graph");
+       BT_ASSERT_PRE_GRAPH_NON_NULL(graph);
        return graph->default_interrupter;
 }
 
This page took 0.027355 seconds and 4 git commands to generate.