-#ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
-#define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
-
/*
+ * 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.
*/
+#ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
+#define BABELTRACE_GRAPH_GRAPH_INTERNAL_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
+
#include <babeltrace2/graph/graph.h>
-#include <babeltrace2/graph/message-const.h>
-#include "common/babeltrace.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>
#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;
BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
BT_GRAPH_CONFIGURATION_STATE_FAULTY,
+ BT_GRAPH_CONFIGURATION_STATE_DESTROYING,
};
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;
/*
* 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,
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 *` */
};
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
-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(
- 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);
-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_COMPONENT_REFUSES_PORT_CONNECTION:
- return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
- 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(
{
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)";
}
}
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);
+ BT_ASSERT_DBG(graph->config_state !=
+ BT_GRAPH_CONFIGURATION_STATE_FAULTY);
- if (likely(graph->config_state ==
+ if (G_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++) {
}
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));
+ 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;
}
}
void bt_graph_make_faulty(struct bt_graph *graph)
{
graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
-#ifdef BT_LIB_LOGD
- BT_LIB_LOGD("Set graph's state to faulty: %![graph-]+g", graph);
-#endif
+ BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
}
#endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
projects / babeltrace.git / blobdiff