Commit | Line | Data |
---|---|---|
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 | ||
3fadfbc0 | 27 | #include <babeltrace2/graph/graph.h> |
3fadfbc0 | 28 | #include <babeltrace2/graph/message-const.h> |
91d81473 | 29 | #include "common/macros.h" |
578e048b MJ |
30 | #include "lib/object.h" |
31 | #include "lib/object-pool.h" | |
32 | #include "common/assert.h" | |
de625d1c | 33 | #include "common/common.h" |
a256a42d | 34 | #include <stdlib.h> |
c0418dd9 JG |
35 | #include <glib.h> |
36 | ||
578e048b MJ |
37 | #include "component.h" |
38 | #include "component-sink.h" | |
39 | #include "connection.h" | |
40 | ||
1bf957a0 PP |
41 | struct bt_component; |
42 | struct bt_port; | |
43 | ||
5badd463 PP |
44 | enum bt_graph_configuration_state { |
45 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, | |
46 | BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED, | |
47 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURED, | |
38cda5da | 48 | BT_GRAPH_CONFIGURATION_STATE_FAULTY, |
5badd463 PP |
49 | }; |
50 | ||
f60c8b34 JG |
51 | struct bt_graph { |
52 | /** | |
53 | * A component graph contains components and point-to-point connection | |
54 | * between these components. | |
c0418dd9 | 55 | * |
f60c8b34 JG |
56 | * In terms of ownership: |
57 | * 1) The graph is the components' parent, | |
58 | * 2) The graph is the connnections' parent, | |
59 | * 3) Components share the ownership of their connections, | |
60 | * 4) A connection holds weak references to its two component endpoints. | |
c0418dd9 | 61 | */ |
f60c8b34 JG |
62 | struct bt_object base; |
63 | ||
64 | /* Array of pointers to bt_connection. */ | |
65 | GPtrArray *connections; | |
66 | /* Array of pointers to bt_component. */ | |
67 | GPtrArray *components; | |
68 | /* Queue of pointers (weak references) to sink bt_components. */ | |
69 | GQueue *sinks_to_consume; | |
1bf957a0 | 70 | |
d94d92ac PP |
71 | bool canceled; |
72 | bool in_remove_listener; | |
73 | bool has_sink; | |
8ed535b5 PP |
74 | |
75 | /* | |
d94d92ac | 76 | * If this is false, then the public API's consuming |
8ed535b5 PP |
77 | * functions (bt_graph_consume() and bt_graph_run()) return |
78 | * BT_GRAPH_STATUS_CANNOT_CONSUME. The internal "no check" | |
79 | * functions always work. | |
80 | * | |
d6e69534 | 81 | * In bt_port_output_message_iterator_create(), on success, |
8ed535b5 PP |
82 | * this flag is cleared so that the iterator remains the only |
83 | * consumer for the graph's lifetime. | |
84 | */ | |
d94d92ac | 85 | bool can_consume; |
202a3a13 | 86 | |
5badd463 | 87 | enum bt_graph_configuration_state config_state; |
4725a201 | 88 | |
1bf957a0 | 89 | struct { |
d94d92ac PP |
90 | GArray *source_output_port_added; |
91 | GArray *filter_output_port_added; | |
92 | GArray *filter_input_port_added; | |
93 | GArray *sink_input_port_added; | |
d94d92ac PP |
94 | GArray *source_filter_ports_connected; |
95 | GArray *source_sink_ports_connected; | |
9c0a126a | 96 | GArray *filter_filter_ports_connected; |
d94d92ac | 97 | GArray *filter_sink_ports_connected; |
1bf957a0 | 98 | } listeners; |
5c563278 | 99 | |
d6e69534 PP |
100 | /* Pool of `struct bt_message_event *` */ |
101 | struct bt_object_pool event_msg_pool; | |
5c563278 | 102 | |
d6e69534 PP |
103 | /* Pool of `struct bt_message_packet_beginning *` */ |
104 | struct bt_object_pool packet_begin_msg_pool; | |
5c563278 | 105 | |
d6e69534 PP |
106 | /* Pool of `struct bt_message_packet_end *` */ |
107 | struct bt_object_pool packet_end_msg_pool; | |
5c563278 PP |
108 | |
109 | /* | |
d6e69534 | 110 | * Array of `struct bt_message *` (weak). |
5c563278 | 111 | * |
d6e69534 | 112 | * This is an array of all the messages ever created from |
5c563278 | 113 | * this graph. Some of them can be in one of the pools above, |
d6e69534 | 114 | * some of them can be at large. Because each message has a |
5c563278 | 115 | * weak pointer to the graph containing its pool, we need to |
d6e69534 | 116 | * notify each message that the graph is gone on graph |
5c563278 PP |
117 | * destruction. |
118 | * | |
119 | * TODO: When we support a maximum size for object pools, | |
d6e69534 | 120 | * add a way for a message to remove itself from this |
5c563278 PP |
121 | * array (on destruction). |
122 | */ | |
d6e69534 | 123 | GPtrArray *messages; |
c0418dd9 JG |
124 | }; |
125 | ||
8ed535b5 | 126 | static inline |
d94d92ac | 127 | void _bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume) |
8ed535b5 | 128 | { |
f6ccaed9 | 129 | BT_ASSERT(graph); |
8ed535b5 PP |
130 | graph->can_consume = can_consume; |
131 | } | |
132 | ||
ad847455 PP |
133 | #ifdef BT_DEV_MODE |
134 | # define bt_graph_set_can_consume _bt_graph_set_can_consume | |
135 | #else | |
136 | # define bt_graph_set_can_consume(_graph, _can_consume) | |
137 | #endif | |
8ed535b5 PP |
138 | |
139 | BT_HIDDEN | |
140 | enum bt_graph_status bt_graph_consume_sink_no_check(struct bt_graph *graph, | |
d94d92ac | 141 | struct bt_component_sink *sink); |
8ed535b5 | 142 | |
1bf957a0 | 143 | BT_HIDDEN |
8cc56726 SM |
144 | enum bt_graph_listener_status bt_graph_notify_port_added(struct bt_graph *graph, |
145 | struct bt_port *port); | |
1bf957a0 | 146 | |
1bf957a0 | 147 | BT_HIDDEN |
8cc56726 SM |
148 | enum bt_graph_listener_status bt_graph_notify_ports_connected( |
149 | struct bt_graph *graph, struct bt_port *upstream_port, | |
150 | struct bt_port *downstream_port); | |
1bf957a0 | 151 | |
f167d3c0 PP |
152 | BT_HIDDEN |
153 | void bt_graph_remove_connection(struct bt_graph *graph, | |
154 | struct bt_connection *connection); | |
155 | ||
8ed535b5 PP |
156 | /* |
157 | * This only works with a component which is not connected at this | |
158 | * point. | |
159 | * | |
160 | * Also the reference count of `component` should be 0 when you call | |
161 | * this function, which means only `graph` owns the component, so it | |
162 | * is safe to destroy. | |
163 | */ | |
164 | BT_HIDDEN | |
165 | int bt_graph_remove_unconnected_component(struct bt_graph *graph, | |
166 | struct bt_component *component); | |
167 | ||
5c563278 | 168 | BT_HIDDEN |
d6e69534 PP |
169 | void bt_graph_add_message(struct bt_graph *graph, |
170 | struct bt_message *msg); | |
5c563278 | 171 | |
262e5473 PP |
172 | static inline |
173 | const char *bt_graph_status_string(enum bt_graph_status status) | |
174 | { | |
175 | switch (status) { | |
176 | case BT_GRAPH_STATUS_CANCELED: | |
177 | return "BT_GRAPH_STATUS_CANCELED"; | |
178 | case BT_GRAPH_STATUS_AGAIN: | |
179 | return "BT_GRAPH_STATUS_AGAIN"; | |
180 | case BT_GRAPH_STATUS_END: | |
181 | return "BT_GRAPH_STATUS_END"; | |
182 | case BT_GRAPH_STATUS_OK: | |
183 | return "BT_GRAPH_STATUS_OK"; | |
262e5473 PP |
184 | case BT_GRAPH_STATUS_ERROR: |
185 | return "BT_GRAPH_STATUS_ERROR"; | |
a256a42d PP |
186 | case BT_GRAPH_STATUS_NOMEM: |
187 | return "BT_GRAPH_STATUS_NOMEM"; | |
262e5473 PP |
188 | default: |
189 | return "(unknown)"; | |
190 | } | |
191 | } | |
192 | ||
5badd463 PP |
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 | ||
38cda5da PP |
215 | BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY); |
216 | ||
91d81473 | 217 | if (G_LIKELY(graph->config_state == |
5badd463 PP |
218 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) { |
219 | goto end; | |
220 | } | |
221 | ||
cd6128ca FD |
222 | #ifdef BT_ASSERT_PRE |
223 | BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph); | |
224 | #endif | |
225 | ||
5badd463 PP |
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 | ||
f6f301d7 PP |
259 | #ifdef BT_ASSERT_POST |
260 | BT_ASSERT_POST(comp_status == BT_SELF_COMPONENT_STATUS_OK || | |
5badd463 PP |
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) { | |
53719615 | 268 | status = BT_GRAPH_STATUS_ERROR; |
5badd463 PP |
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 | ||
8cc56726 SM |
290 | static inline |
291 | void bt_graph_make_faulty(struct bt_graph *graph) | |
292 | { | |
293 | graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY; | |
3f7d4d90 PP |
294 | #ifdef BT_LIB_LOGI |
295 | BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph); | |
8cc56726 SM |
296 | #endif |
297 | } | |
298 | ||
6ac74c0c | 299 | #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */ |