lib: rename include dir to babeltrace2
[babeltrace.git] / include / babeltrace2 / graph / graph-internal.h
1 #ifndef BABELTRACE_GRAPH_GRAPH_INTERNAL_H
2 #define BABELTRACE_GRAPH_GRAPH_INTERNAL_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
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
27 #include <babeltrace2/graph/graph.h>
28 #include <babeltrace2/graph/connection-internal.h>
29 #include <babeltrace2/graph/message-const.h>
30 #include <babeltrace2/graph/component-internal.h>
31 #include <babeltrace2/graph/component-sink-internal.h>
32 #include <babeltrace2/babeltrace-internal.h>
33 #include <babeltrace2/object-internal.h>
34 #include <babeltrace2/object-pool-internal.h>
35 #include <babeltrace2/assert-internal.h>
36 #include <stdlib.h>
37 #include <glib.h>
38
39 struct bt_component;
40 struct bt_port;
41
42 enum bt_graph_configuration_state {
43 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
44 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
45 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
46 BT_GRAPH_CONFIGURATION_STATE_FAULTY,
47 };
48
49 struct bt_graph {
50 /**
51 * A component graph contains components and point-to-point connection
52 * between these components.
53 *
54 * In terms of ownership:
55 * 1) The graph is the components' parent,
56 * 2) The graph is the connnections' parent,
57 * 3) Components share the ownership of their connections,
58 * 4) A connection holds weak references to its two component endpoints.
59 */
60 struct bt_object base;
61
62 /* Array of pointers to bt_connection. */
63 GPtrArray *connections;
64 /* Array of pointers to bt_component. */
65 GPtrArray *components;
66 /* Queue of pointers (weak references) to sink bt_components. */
67 GQueue *sinks_to_consume;
68
69 bool canceled;
70 bool in_remove_listener;
71 bool has_sink;
72
73 /*
74 * If this is false, then the public API's consuming
75 * functions (bt_graph_consume() and bt_graph_run()) return
76 * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check"
77 * functions always work.
78 *
79 * In bt_port_output_message_iterator_create(), on success,
80 * this flag is cleared so that the iterator remains the only
81 * consumer for the graph's lifetime.
82 */
83 bool can_consume;
84
85 enum bt_graph_configuration_state config_state;
86
87 struct {
88 GArray *source_output_port_added;
89 GArray *filter_output_port_added;
90 GArray *filter_input_port_added;
91 GArray *sink_input_port_added;
92 GArray *source_filter_ports_connected;
93 GArray *source_sink_ports_connected;
94 GArray *filter_filter_ports_connected;
95 GArray *filter_sink_ports_connected;
96 } listeners;
97
98 /* Pool of `struct bt_message_event *` */
99 struct bt_object_pool event_msg_pool;
100
101 /* Pool of `struct bt_message_packet_beginning *` */
102 struct bt_object_pool packet_begin_msg_pool;
103
104 /* Pool of `struct bt_message_packet_end *` */
105 struct bt_object_pool packet_end_msg_pool;
106
107 /*
108 * Array of `struct bt_message *` (weak).
109 *
110 * This is an array of all the messages ever created from
111 * this graph. Some of them can be in one of the pools above,
112 * some of them can be at large. Because each message has a
113 * weak pointer to the graph containing its pool, we need to
114 * notify each message that the graph is gone on graph
115 * destruction.
116 *
117 * TODO: When we support a maximum size for object pools,
118 * add a way for a message to remove itself from this
119 * array (on destruction).
120 */
121 GPtrArray *messages;
122 };
123
124 static inline
125 void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
126 {
127 BT_ASSERT(graph);
128 graph->can_consume = can_consume;
129 }
130
131 #ifdef BT_DEV_MODE
132 # define bt_graph_set_can_consume _bt_graph_set_can_consume
133 #else
134 # define bt_graph_set_can_consume(_graph, _can_consume)
135 #endif
136
137 BT_HIDDEN
138 enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph,
139 struct bt_component_sink *sink);
140
141 BT_HIDDEN
142 enum bt_graph_listener_status bt_graph_notify_port_added(struct bt_graph *graph,
143 struct bt_port *port);
144
145 BT_HIDDEN
146 enum bt_graph_listener_status bt_graph_notify_ports_connected(
147 struct bt_graph *graph, struct bt_port *upstream_port,
148 struct bt_port *downstream_port);
149
150 BT_HIDDEN
151 void bt_graph_remove_connection(struct bt_graph *graph,
152 struct bt_connection *connection);
153
154 /*
155 * This only works with a component which is not connected at this
156 * point.
157 *
158 * Also the reference count of `component` should be 0 when you call
159 * this function, which means only `graph` owns the component, so it
160 * is safe to destroy.
161 */
162 BT_HIDDEN
163 int bt_graph_remove_unconnected_component(struct bt_graph *graph,
164 struct bt_component *component);
165
166 BT_HIDDEN
167 void bt_graph_add_message(struct bt_graph *graph,
168 struct bt_message *msg);
169
170 static inline
171 const char *bt_graph_status_string(enum bt_graph_status status)
172 {
173 switch (status) {
174 case BT_GRAPH_STATUS_CANCELED:
175 return "BT_GRAPH_STATUS_CANCELED";
176 case BT_GRAPH_STATUS_AGAIN:
177 return "BT_GRAPH_STATUS_AGAIN";
178 case BT_GRAPH_STATUS_END:
179 return "BT_GRAPH_STATUS_END";
180 case BT_GRAPH_STATUS_OK:
181 return "BT_GRAPH_STATUS_OK";
182 case BT_GRAPH_STATUS_ERROR:
183 return "BT_GRAPH_STATUS_ERROR";
184 case BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION:
185 return "BT_GRAPH_STATUS_COMPONENT_REFUSES_PORT_CONNECTION";
186 case BT_GRAPH_STATUS_NOMEM:
187 return "BT_GRAPH_STATUS_NOMEM";
188 default:
189 return "(unknown)";
190 }
191 }
192
193 static inline
194 const char *bt_graph_configuration_state_string(
195 enum bt_graph_configuration_state state)
196 {
197 switch (state) {
198 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
199 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURING";
200 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
201 return "BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED";
202 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
203 return "BT_GRAPH_CONFIGURATION_STATE_CONFIGURED";
204 default:
205 return "(unknown)";
206 }
207 }
208
209 static inline
210 enum bt_graph_status bt_graph_configure(struct bt_graph *graph)
211 {
212 enum bt_graph_status status = BT_GRAPH_STATUS_OK;
213 uint64_t i;
214
215 BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
216
217 if (likely(graph->config_state ==
218 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
219 goto end;
220 }
221
222 #ifdef BT_ASSERT_PRE
223 BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
224 #endif
225
226 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
227
228 for (i = 0; i < graph->components->len; i++) {
229 struct bt_component *comp = graph->components->pdata[i];
230 struct bt_component_sink *comp_sink = (void *) comp;
231 struct bt_component_class_sink *comp_cls_sink =
232 (void *) comp->class;
233
234 if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
235 continue;
236 }
237
238 if (comp_sink->graph_is_configured_method_called) {
239 continue;
240 }
241
242 if (comp_cls_sink->methods.graph_is_configured) {
243 enum bt_self_component_status comp_status;
244
245 #ifdef BT_LIB_LOGD
246 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
247 "%![graph-]+g, %![comp-]+c",
248 graph, comp);
249 #endif
250
251 comp_status = comp_cls_sink->methods.graph_is_configured(
252 (void *) comp_sink);
253
254 #ifdef BT_LIB_LOGD
255 BT_LIB_LOGD("User method returned: status=%s",
256 bt_self_component_status_string(comp_status));
257 #endif
258
259 #ifdef BT_ASSERT_PRE
260 BT_ASSERT_PRE(comp_status == BT_SELF_COMPONENT_STATUS_OK ||
261 comp_status == BT_SELF_COMPONENT_STATUS_ERROR ||
262 comp_status == BT_SELF_COMPONENT_STATUS_NOMEM,
263 "Unexpected returned status: status=%s",
264 bt_self_component_status_string(comp_status));
265 #endif
266
267 if (comp_status != BT_SELF_COMPONENT_STATUS_OK) {
268 status = BT_GRAPH_STATUS_ERROR;
269 #ifdef BT_LIB_LOGW
270 BT_LIB_LOGW("User's \"graph is configured\" method failed: "
271 "%![comp-]+c, status=%s",
272 comp,
273 bt_self_component_status_string(
274 comp_status));
275 #endif
276
277 goto end;
278 }
279 }
280
281 comp_sink->graph_is_configured_method_called = true;
282 }
283
284 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
285
286 end:
287 return status;
288 }
289
290 static inline
291 void bt_graph_make_faulty(struct bt_graph *graph)
292 {
293 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
294 #ifdef BT_LIB_LOGD
295 BT_LIB_LOGD("Set graph's state to faulty: %![graph-]+g", graph);
296 #endif
297 }
298
299 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
This page took 0.035218 seconds and 4 git commands to generate.