lib: graph.c: add missing `enum` and `const` keywords
[babeltrace.git] / src / lib / graph / graph.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 /* 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
32 #include <babeltrace2/graph/graph.h>
33 #include <babeltrace2/graph/message-const.h>
34 #include "common/macros.h"
35 #include "lib/object.h"
36 #include "lib/object-pool.h"
37 #include "common/assert.h"
38 #include "common/common.h"
39 #include <stdlib.h>
40 #include <glib.h>
41
42 #include "component.h"
43 #include "component-sink.h"
44 #include "connection.h"
45 #include "lib/func-status.h"
46
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
62 struct bt_component;
63 struct bt_port;
64
65 enum bt_graph_configuration_state {
66 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
67 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED,
68 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
69 BT_GRAPH_CONFIGURATION_STATE_FAULTY,
70 BT_GRAPH_CONFIGURATION_STATE_DESTROYING,
71 };
72
73 struct bt_graph {
74 /**
75 * A component graph contains components and point-to-point connection
76 * between these components.
77 *
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.
83 */
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;
92
93 /*
94 * Array of `struct bt_interrupter *`, each one owned by this.
95 * If any interrupter is set, then this graph is deemed
96 * interrupted.
97 */
98 GPtrArray *interrupters;
99
100 /*
101 * Default interrupter to support bt_graph_interrupt(); owned
102 * by this.
103 */
104 struct bt_interrupter *default_interrupter;
105
106 bool in_remove_listener;
107 bool has_sink;
108
109 /*
110 * If this is false, then the public API's consuming
111 * functions (bt_graph_consume() and bt_graph_run()) return
112 * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check"
113 * functions always work.
114 *
115 * In bt_port_output_message_iterator_create(), on success,
116 * this flag is cleared so that the iterator remains the only
117 * consumer for the graph's lifetime.
118 */
119 bool can_consume;
120
121 enum bt_graph_configuration_state config_state;
122
123 struct {
124 GArray *source_output_port_added;
125 GArray *filter_output_port_added;
126 GArray *filter_input_port_added;
127 GArray *sink_input_port_added;
128 GArray *source_filter_ports_connected;
129 GArray *source_sink_ports_connected;
130 GArray *filter_filter_ports_connected;
131 GArray *filter_sink_ports_connected;
132 } listeners;
133
134 /* Pool of `struct bt_message_event *` */
135 struct bt_object_pool event_msg_pool;
136
137 /* Pool of `struct bt_message_packet_beginning *` */
138 struct bt_object_pool packet_begin_msg_pool;
139
140 /* Pool of `struct bt_message_packet_end *` */
141 struct bt_object_pool packet_end_msg_pool;
142
143 /*
144 * Array of `struct bt_message *` (weak).
145 *
146 * This is an array of all the messages ever created from
147 * this graph. Some of them can be in one of the pools above,
148 * some of them can be at large. Because each message has a
149 * weak pointer to the graph containing its pool, we need to
150 * notify each message that the graph is gone on graph
151 * destruction.
152 *
153 * TODO: When we support a maximum size for object pools,
154 * add a way for a message to remove itself from this
155 * array (on destruction).
156 */
157 GPtrArray *messages;
158 };
159
160 static inline
161 void bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume)
162 {
163 BT_ASSERT(graph);
164 graph->can_consume = can_consume;
165 }
166
167 BT_HIDDEN
168 int bt_graph_consume_sink_no_check(struct bt_graph *graph,
169 struct bt_component_sink *sink);
170
171 BT_HIDDEN
172 enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph,
173 struct bt_port *port);
174
175 BT_HIDDEN
176 enum bt_graph_listener_func_status bt_graph_notify_ports_connected(
177 struct bt_graph *graph, struct bt_port *upstream_port,
178 struct bt_port *downstream_port);
179
180 BT_HIDDEN
181 void bt_graph_remove_connection(struct bt_graph *graph,
182 struct bt_connection *connection);
183
184 /*
185 * This only works with a component which is not connected at this
186 * point.
187 *
188 * Also the reference count of `component` should be 0 when you call
189 * this function, which means only `graph` owns the component, so it
190 * is safe to destroy.
191 */
192 BT_HIDDEN
193 int bt_graph_remove_unconnected_component(struct bt_graph *graph,
194 struct bt_component *component);
195
196 BT_HIDDEN
197 void bt_graph_add_message(struct bt_graph *graph,
198 struct bt_message *msg);
199
200 BT_HIDDEN
201 bool bt_graph_is_interrupted(const struct bt_graph *graph);
202
203 static inline
204 const char *bt_graph_configuration_state_string(
205 enum bt_graph_configuration_state state)
206 {
207 switch (state) {
208 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURING:
209 return "CONFIGURING";
210 case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED:
211 return "PARTIALLY_CONFIGURED";
212 case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED:
213 return "CONFIGURED";
214 case BT_GRAPH_CONFIGURATION_STATE_FAULTY:
215 return "FAULTY";
216 case BT_GRAPH_CONFIGURATION_STATE_DESTROYING:
217 return "DESTROYING";
218 default:
219 return "(unknown)";
220 }
221 }
222
223 static inline
224 int bt_graph_configure(struct bt_graph *graph)
225 {
226 int status = BT_FUNC_STATUS_OK;
227 uint64_t i;
228
229 BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY);
230
231 if (G_LIKELY(graph->config_state ==
232 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) {
233 goto end;
234 }
235
236 BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph);
237 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED;
238
239 for (i = 0; i < graph->components->len; i++) {
240 struct bt_component *comp = graph->components->pdata[i];
241 struct bt_component_sink *comp_sink = (void *) comp;
242 struct bt_component_class_sink *comp_cls_sink =
243 (void *) comp->class;
244
245 if (comp->class->type != BT_COMPONENT_CLASS_TYPE_SINK) {
246 continue;
247 }
248
249 if (comp_sink->graph_is_configured_method_called) {
250 continue;
251 }
252
253 if (comp_cls_sink->methods.graph_is_configured) {
254 enum bt_component_class_sink_graph_is_configured_method_status comp_status;
255
256 BT_LIB_LOGD("Calling user's \"graph is configured\" method: "
257 "%![graph-]+g, %![comp-]+c",
258 graph, comp);
259 comp_status = comp_cls_sink->methods.graph_is_configured(
260 (void *) comp_sink);
261 BT_LIB_LOGD("User method returned: status=%s",
262 bt_common_func_status_string(comp_status));
263 BT_ASSERT_POST(comp_status == BT_FUNC_STATUS_OK ||
264 comp_status == BT_FUNC_STATUS_ERROR ||
265 comp_status == BT_FUNC_STATUS_MEMORY_ERROR,
266 "Unexpected returned status: status=%s",
267 bt_common_func_status_string(comp_status));
268 if (comp_status != BT_FUNC_STATUS_OK) {
269 if (comp_status < 0) {
270 BT_LIB_LOGW_APPEND_CAUSE(
271 "Component's \"graph is configured\" method failed: "
272 "%![comp-]+c, status=%s",
273 comp,
274 bt_common_func_status_string(
275 comp_status));
276 }
277
278 status = comp_status;
279 goto end;
280 }
281 }
282
283 comp_sink->graph_is_configured_method_called = true;
284 }
285
286 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_CONFIGURED;
287
288 end:
289 return status;
290 }
291
292 static inline
293 void bt_graph_make_faulty(struct bt_graph *graph)
294 {
295 graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY;
296 BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph);
297 }
298
299 #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */
This page took 0.037114 seconds and 4 git commands to generate.