lib: split real FC/field into single and double prec FC/field
[babeltrace.git] / src / lib / graph / graph.h
CommitLineData
6ac74c0c
PP
1#ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
2#define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
c0418dd9
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
f60c8b34 6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
c0418dd9 7 *
c0418dd9
JG
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * SOFTWARE.
25 */
26
870631a2
PP
27/* Protection: this file uses BT_LIB_LOG*() macros directly */
28#ifndef BT_LIB_LOG_SUPPORTED
29# error Please include "lib/logging.h" before including this file.
30#endif
31
3fadfbc0 32#include <babeltrace2/graph/graph.h>
3fadfbc0 33#include <babeltrace2/graph/message-const.h>
91d81473 34#include "common/macros.h"
578e048b
MJ
35#include "lib/object.h"
36#include "lib/object-pool.h"
37#include "common/assert.h"
de625d1c 38#include "common/common.h"
a256a42d 39#include <stdlib.h>
c0418dd9
JG
40#include <glib.h>
41
578e048b
MJ
42#include "component.h"
43#include "component-sink.h"
44#include "connection.h"
d24d5663 45#include "lib/func-status.h"
578e048b 46
51375aa9
PP
47/* Protection: this file uses BT_LIB_LOG*() macros directly */
48#ifndef BT_LIB_LOG_SUPPORTED
49# error Please include "lib/logging.h" before including this file.
50#endif
51
52/* Protection: this file uses BT_ASSERT_PRE*() macros directly */
53#ifndef BT_ASSERT_PRE_SUPPORTED
54# error Please include "lib/assert-pre.h" before including this file.
55#endif
56
57/* Protection: this file uses BT_ASSERT_POST*() macros directly */
58#ifndef BT_ASSERT_POST_SUPPORTED
59# error Please include "lib/assert-post.h" before including this file.
60#endif
61
1bf957a0
PP
62struct bt_component;
63struct bt_port;
64
5badd463
PP
65enum bt_graph_configuration_state {
66 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
67 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
68 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
38cda5da 69 BT_GRAPH_CONFIGURATION_STATE_FAULTY,
9b4f9b42 70 BT_GRAPH_CONFIGURATION_STATE_DESTROYING,
5badd463
PP
71};
72
f60c8b34
JG
73struct bt_graph {
74 /**
75 * A component graph contains components and point-to-point connection
76 * between these components.
c0418dd9 77 *
f60c8b34
JG
78 * In terms of ownership:
79 * 1) The graph is the components' parent,
80 * 2) The graph is the connnections' parent,
81 * 3) Components share the ownership of their connections,
82 * 4) A connection holds weak references to its two component endpoints.
c0418dd9 83 */
f60c8b34
JG
84 struct bt_object base;
85
86 /* Array of pointers to bt_connection. */
87 GPtrArray *connections;
88 /* Array of pointers to bt_component. */
89 GPtrArray *components;
90 /* Queue of pointers (weak references) to sink bt_components. */
91 GQueue *sinks_to_consume;
1bf957a0 92
056deb59
PP
93 uint64_t mip_version;
94
9b4f9b42
PP
95 /*
96 * Array of `struct bt_interrupter *`, each one owned by this.
97 * If any interrupter is set, then this graph is deemed
98 * interrupted.
99 */
100 GPtrArray *interrupters;
101
102 /*
103 * Default interrupter to support bt_graph_interrupt(); owned
104 * by this.
105 */
106 struct bt_interrupter *default_interrupter;
107
d94d92ac
PP
108 bool in_remove_listener;
109 bool has_sink;
8ed535b5
PP
110
111 /*
d94d92ac 112 * If this is false, then the public API's consuming
8ed535b5 113 * functions (bt_graph_consume() and bt_graph_run()) return
d24d5663 114 * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
8ed535b5
PP
115 * functions always work.
116 *
d6e69534 117 * In bt_port_output_message_iterator_create(), on success,
8ed535b5
PP
118 * this flag is cleared so that the iterator remains the only
119 * consumer for the graph's lifetime.
120 */
d94d92ac 121 bool can_consume;
202a3a13 122
5badd463 123 enum bt_graph_configuration_state config_state;
4725a201 124
1bf957a0 125 struct {
d94d92ac
PP
126 GArray *source_output_port_added;
127 GArray *filter_output_port_added;
128 GArray *filter_input_port_added;
129 GArray *sink_input_port_added;
d94d92ac
PP
130 GArray *source_filter_ports_connected;
131 GArray *source_sink_ports_connected;
9c0a126a 132 GArray *filter_filter_ports_connected;
d94d92ac 133 GArray *filter_sink_ports_connected;
1bf957a0 134 } listeners;
5c563278 135
d6e69534
PP
136 /* Pool of `struct bt_message_event *` */
137 struct bt_object_pool event_msg_pool;
5c563278 138
d6e69534
PP
139 /* Pool of `struct bt_message_packet_beginning *` */
140 struct bt_object_pool packet_begin_msg_pool;
5c563278 141
d6e69534
PP
142 /* Pool of `struct bt_message_packet_end *` */
143 struct bt_object_pool packet_end_msg_pool;
5c563278
PP
144
145 /*
d6e69534 146 * Array of `struct bt_message *` (weak).
5c563278 147 *
d6e69534 148 * This is an array of all the messages ever created from
5c563278 149 * this graph. Some of them can be in one of the pools above,
d6e69534 150 * some of them can be at large. Because each message has a
5c563278 151 * weak pointer to the graph containing its pool, we need to
d6e69534 152 * notify each message that the graph is gone on graph
5c563278
PP
153 * destruction.
154 *
155 * TODO: When we support a maximum size for object pools,
d6e69534 156 * add a way for a message to remove itself from this
5c563278
PP
157 * array (on destruction).
158 */
d6e69534 159 GPtrArray *messages;
c0418dd9
JG
160};
161
8ed535b5 162static inline
bdb288b3 163void bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
8ed535b5 164{
f6ccaed9 165 BT_ASSERT(graph);
8ed535b5
PP
166 graph->can_consume = can_consume;
167}
168
8ed535b5 169BT_HIDDEN
d24d5663 170int bt_graph_consume_sink_no_check(struct bt_graph *graph,
d94d92ac 171 struct bt_component_sink *sink);
8ed535b5 172
1bf957a0 173BT_HIDDEN
d24d5663 174enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
8cc56726 175 struct bt_port *port);
1bf957a0 176
1bf957a0 177BT_HIDDEN
d24d5663 178enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
8cc56726
SM
179 struct bt_graph *graph, struct bt_port *upstream_port,
180 struct bt_port *downstream_port);
1bf957a0 181
f167d3c0
PP
182BT_HIDDEN
183void bt_graph_remove_connection(struct bt_graph *graph,
184 struct bt_connection *connection);
185
8ed535b5
PP
186/*
187 * This only works with a component which is not connected at this
188 * point.
189 *
190 * Also the reference count of `component` should be 0 when you call
191 * this function, which means only `graph` owns the component, so it
192 * is safe to destroy.
193 */
194BT_HIDDEN
195int bt_graph_remove_unconnected_component(struct bt_graph *graph,
196 struct bt_component *component);
197
5c563278 198BT_HIDDEN
d6e69534
PP
199void bt_graph_add_message(struct bt_graph *graph,
200 struct bt_message *msg);
5c563278 201
9b4f9b42
PP
202BT_HIDDEN
203bool bt_graph_is_interrupted(const struct bt_graph *graph);
204
5badd463
PP
205static inline
206const char *bt_graph_configuration_state_string(
207 enum bt_graph_configuration_state state)
208{
209 switch (state) {
210 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
8a432889 211 return "CONFIGURING";
5badd463 212 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
8a432889 213 return "PARTIALLY_CONFIGURED";
5badd463 214 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
8a432889
PP
215 return "CONFIGURED";
216 case BT_GRAPH_CONFIGURATION_STATE_FAULTY:
217 return "FAULTY";
218 case BT_GRAPH_CONFIGURATION_STATE_DESTROYING:
219 return "DESTROYING";
5badd463
PP
220 default:
221 return "(unknown)";
222 }
223}
224
225static inline
d24d5663 226int bt_graph_configure(struct bt_graph *graph)
5badd463 227{
d24d5663 228 int status = BT_FUNC_STATUS_OK;
5badd463
PP
229 uint64_t i;
230
38cda5da
PP
231 BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
232
91d81473 233 if (G_LIKELY(graph->config_state ==
5badd463
PP
234 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
235 goto end;
236 }
237
cd6128ca 238 BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
5badd463
PP
239 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
240
241 for (i = 0; i < graph->components->len; i++) {
242 struct bt_component *comp = graph->components->pdata[i];
243 struct bt_component_sink *comp_sink = (void *) comp;
244 struct bt_component_class_sink *comp_cls_sink =
245 (void *) comp->class;
246
247 if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
248 continue;
249 }
250
251 if (comp_sink->graph_is_configured_method_called) {
252 continue;
253 }
254
255 if (comp_cls_sink->methods.graph_is_configured) {
d24d5663 256 enum bt_component_class_sink_graph_is_configured_method_status comp_status;
5badd463 257
5badd463
PP
258 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
259 "%![graph-]+g, %![comp-]+c",
260 graph, comp);
5badd463
PP
261 comp_status = comp_cls_sink->methods.graph_is_configured(
262 (void *) comp_sink);
5badd463 263 BT_LIB_LOGD("User method returned: status=%s",
d24d5663
PP
264 bt_common_func_status_string(comp_status));
265 BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
266 comp_status == BT_FUNC_STATUS_ERROR ||
267 comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
5badd463 268 "Unexpected returned status: status=%s",
d24d5663 269 bt_common_func_status_string(comp_status));
d24d5663 270 if (comp_status != BT_FUNC_STATUS_OK) {
870631a2
PP
271 if (comp_status < 0) {
272 BT_LIB_LOGW_APPEND_CAUSE(
273 "Component's \"graph is configured\" method failed: "
274 "%![comp-]+c, status=%s",
275 comp,
276 bt_common_func_status_string(
277 comp_status));
278 }
279
280 status = comp_status;
5badd463
PP
281 goto end;
282 }
283 }
284
285 comp_sink->graph_is_configured_method_called = true;
286 }
287
288 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
289
290end:
291 return status;
292}
293
8cc56726
SM
294static inline
295void bt_graph_make_faulty(struct bt_graph *graph)
296{
297 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
3f7d4d90 298 BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
8cc56726
SM
299}
300
6ac74c0c 301#endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
This page took 0.07657 seconds and 4 git commands to generate.