2 * SPDX-License-Identifier: MIT
4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 #ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
9 #define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
11 /* Protection: this file uses BT_LIB_LOG*() macros directly */
12 #ifndef BT_LIB_LOG_SUPPORTED
13 # error Please include "lib/logging.h" before including this file.
16 #include <babeltrace2/graph/graph.h>
17 #include <babeltrace2/graph/message.h>
18 #include "common/macros.h"
19 #include "lib/object.h"
20 #include "lib/object-pool.h"
21 #include "common/assert.h"
22 #include "common/common.h"
27 #include "component.h"
28 #include "component-sink.h"
29 #include "connection.h"
30 #include "lib/func-status.h"
32 /* Protection: this file uses BT_LIB_LOG*() macros directly */
33 #ifndef BT_LIB_LOG_SUPPORTED
34 # error Please include "lib/logging.h" before including this file.
38 * Protection: this file uses precondition and postcondition assertion
41 #ifndef BT_ASSERT_COND_SUPPORTED
42 # error Please include "lib/assert-cond.h" before including this file.
48 enum bt_graph_configuration_state
{
49 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
50 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
,
51 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
,
52 BT_GRAPH_CONFIGURATION_STATE_FAULTY
,
53 BT_GRAPH_CONFIGURATION_STATE_DESTROYING
,
58 * A component graph contains components and point-to-point connection
59 * between these components.
61 * In terms of ownership:
62 * 1) The graph is the components' parent,
63 * 2) The graph is the connnections' parent,
64 * 3) Components share the ownership of their connections,
65 * 4) A connection holds weak references to its two component endpoints.
67 struct bt_object base
;
69 /* Array of pointers to bt_connection. */
70 GPtrArray
*connections
;
71 /* Array of pointers to bt_component. */
72 GPtrArray
*components
;
73 /* Queue of pointers (weak references) to sink bt_components. */
74 GQueue
*sinks_to_consume
;
79 * Array of `struct bt_interrupter *`, each one owned by this.
80 * If any interrupter is set, then this graph is deemed
83 GPtrArray
*interrupters
;
86 * Default interrupter, owned by this.
88 struct bt_interrupter
*default_interrupter
;
93 * If this is false, then the public API's consuming
94 * functions (bt_graph_consume() and bt_graph_run()) return
95 * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
96 * functions always work.
98 * In bt_port_output_message_iterator_create(), on success,
99 * this flag is cleared so that the iterator remains the only
100 * consumer for the graph's lifetime.
104 enum bt_graph_configuration_state config_state
;
107 GArray
*source_output_port_added
;
108 GArray
*filter_output_port_added
;
109 GArray
*filter_input_port_added
;
110 GArray
*sink_input_port_added
;
113 /* Pool of `struct bt_message_event *` */
114 struct bt_object_pool event_msg_pool
;
116 /* Pool of `struct bt_message_packet_beginning *` */
117 struct bt_object_pool packet_begin_msg_pool
;
119 /* Pool of `struct bt_message_packet_end *` */
120 struct bt_object_pool packet_end_msg_pool
;
123 * Array of `struct bt_message *` (weak).
125 * This is an array of all the messages ever created from
126 * this graph. Some of them can be in one of the pools above,
127 * some of them can be at large. Because each message has a
128 * weak pointer to the graph containing its pool, we need to
129 * notify each message that the graph is gone on graph
132 * TODO: When we support a maximum size for object pools,
133 * add a way for a message to remove itself from this
134 * array (on destruction).
140 void bt_graph_set_can_consume(struct bt_graph
*graph
, bool can_consume
)
142 BT_ASSERT_DBG(graph
);
143 graph
->can_consume
= can_consume
;
147 int bt_graph_consume_sink_no_check(struct bt_graph
*graph
,
148 struct bt_component_sink
*sink
);
151 enum bt_graph_listener_func_status
bt_graph_notify_port_added(struct bt_graph
*graph
,
152 struct bt_port
*port
);
155 void bt_graph_remove_connection(struct bt_graph
*graph
,
156 struct bt_connection
*connection
);
159 void bt_graph_add_message(struct bt_graph
*graph
,
160 struct bt_message
*msg
);
163 bool bt_graph_is_interrupted(const struct bt_graph
*graph
);
166 const char *bt_graph_configuration_state_string(
167 enum bt_graph_configuration_state state
)
170 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
:
171 return "CONFIGURING";
172 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
:
173 return "PARTIALLY_CONFIGURED";
174 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
:
176 case BT_GRAPH_CONFIGURATION_STATE_FAULTY
:
178 case BT_GRAPH_CONFIGURATION_STATE_DESTROYING
:
186 void bt_graph_make_faulty(struct bt_graph
*graph
)
188 graph
->config_state
= BT_GRAPH_CONFIGURATION_STATE_FAULTY
;
189 BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph
);
192 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */