X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fgraph.h;h=01dfaec6a8df300cccde917a897560cb2fd31d4e;hb=HEAD;hp=74c794707206e6770fa12f616ead62c74e3bfa9e;hpb=bdb288b3e94e412a33c8647d44f6cfac66ca0665;p=babeltrace.git diff --git a/src/lib/graph/graph.h b/src/lib/graph/graph.h index 74c79470..efc96991 100644 --- a/src/lib/graph/graph.h +++ b/src/lib/graph/graph.h @@ -1,64 +1,35 @@ -#ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H -#define BABELTRACE_GRAPH_GRAPH_INTERNAL_H - /* + * SPDX-License-Identifier: MIT + * * Copyright 2017-2018 Philippe Proulx * Copyright 2017 Jérémie Galarneau - * - * 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_LIB_GRAPH_GRAPH_H +#define BABELTRACE_LIB_GRAPH_GRAPH_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 -#include -#include "common/macros.h" +#include #include "lib/object.h" #include "lib/object-pool.h" #include "common/assert.h" -#include "common/common.h" -#include +#include #include #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; @@ -67,6 +38,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 { @@ -76,7 +48,7 @@ struct bt_graph { * * In terms of ownership: * 1) The graph is the components' parent, - * 2) The graph is the connnections' parent, + * 2) The graph is the connections' parent, * 3) Components share the ownership of their connections, * 4) A connection holds weak references to its two component endpoints. */ @@ -89,8 +61,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 +96,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 *` */ @@ -147,129 +127,44 @@ struct bt_graph { static inline 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; } -BT_HIDDEN int bt_graph_consume_sink_no_check(struct bt_graph *graph, struct bt_component_sink *sink); -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); +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)"; } } -static inline -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); - - 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)); - 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; - } - } - - comp_sink->graph_is_configured_method_called = true; - } - - graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED; - -end: - return status; -} - static inline void bt_graph_make_faulty(struct bt_graph *graph) { @@ -277,4 +172,4 @@ void bt_graph_make_faulty(struct bt_graph *graph) BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph); } -#endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */ +#endif /* BABELTRACE_LIB_GRAPH_GRAPH_H */