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 | ||
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 |
62 | struct bt_component; |
63 | struct bt_port; | |
64 | ||
5badd463 PP |
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, | |
38cda5da | 69 | BT_GRAPH_CONFIGURATION_STATE_FAULTY, |
9b4f9b42 | 70 | BT_GRAPH_CONFIGURATION_STATE_DESTROYING, |
5badd463 PP |
71 | }; |
72 | ||
f60c8b34 JG |
73 | struct 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 | |
9b4f9b42 PP |
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 | ||
d94d92ac PP |
106 | bool in_remove_listener; |
107 | bool has_sink; | |
8ed535b5 PP |
108 | |
109 | /* | |
d94d92ac | 110 | * If this is false, then the public API's consuming |
8ed535b5 | 111 | * functions (bt_graph_consume() and bt_graph_run()) return |
d24d5663 | 112 | * BT_FUNC_STATUS_CANNOT_CONSUME. The internal "no check" |
8ed535b5 PP |
113 | * functions always work. |
114 | * | |
d6e69534 | 115 | * In bt_port_output_message_iterator_create(), on success, |
8ed535b5 PP |
116 | * this flag is cleared so that the iterator remains the only |
117 | * consumer for the graph's lifetime. | |
118 | */ | |
d94d92ac | 119 | bool can_consume; |
202a3a13 | 120 | |
5badd463 | 121 | enum bt_graph_configuration_state config_state; |
4725a201 | 122 | |
1bf957a0 | 123 | struct { |
d94d92ac PP |
124 | GArray *source_output_port_added; |
125 | GArray *filter_output_port_added; | |
126 | GArray *filter_input_port_added; | |
127 | GArray *sink_input_port_added; | |
d94d92ac PP |
128 | GArray *source_filter_ports_connected; |
129 | GArray *source_sink_ports_connected; | |
9c0a126a | 130 | GArray *filter_filter_ports_connected; |
d94d92ac | 131 | GArray *filter_sink_ports_connected; |
1bf957a0 | 132 | } listeners; |
5c563278 | 133 | |
d6e69534 PP |
134 | /* Pool of `struct bt_message_event *` */ |
135 | struct bt_object_pool event_msg_pool; | |
5c563278 | 136 | |
d6e69534 PP |
137 | /* Pool of `struct bt_message_packet_beginning *` */ |
138 | struct bt_object_pool packet_begin_msg_pool; | |
5c563278 | 139 | |
d6e69534 PP |
140 | /* Pool of `struct bt_message_packet_end *` */ |
141 | struct bt_object_pool packet_end_msg_pool; | |
5c563278 PP |
142 | |
143 | /* | |
d6e69534 | 144 | * Array of `struct bt_message *` (weak). |
5c563278 | 145 | * |
d6e69534 | 146 | * This is an array of all the messages ever created from |
5c563278 | 147 | * this graph. Some of them can be in one of the pools above, |
d6e69534 | 148 | * some of them can be at large. Because each message has a |
5c563278 | 149 | * weak pointer to the graph containing its pool, we need to |
d6e69534 | 150 | * notify each message that the graph is gone on graph |
5c563278 PP |
151 | * destruction. |
152 | * | |
153 | * TODO: When we support a maximum size for object pools, | |
d6e69534 | 154 | * add a way for a message to remove itself from this |
5c563278 PP |
155 | * array (on destruction). |
156 | */ | |
d6e69534 | 157 | GPtrArray *messages; |
c0418dd9 JG |
158 | }; |
159 | ||
8ed535b5 | 160 | static inline |
bdb288b3 | 161 | void bt_graph_set_can_consume(struct bt_graph *graph, bool can_consume) |
8ed535b5 | 162 | { |
f6ccaed9 | 163 | BT_ASSERT(graph); |
8ed535b5 PP |
164 | graph->can_consume = can_consume; |
165 | } | |
166 | ||
8ed535b5 | 167 | BT_HIDDEN |
d24d5663 | 168 | int bt_graph_consume_sink_no_check(struct bt_graph *graph, |
d94d92ac | 169 | struct bt_component_sink *sink); |
8ed535b5 | 170 | |
1bf957a0 | 171 | BT_HIDDEN |
d24d5663 | 172 | enum bt_graph_listener_func_status bt_graph_notify_port_added(struct bt_graph *graph, |
8cc56726 | 173 | struct bt_port *port); |
1bf957a0 | 174 | |
1bf957a0 | 175 | BT_HIDDEN |
d24d5663 | 176 | enum bt_graph_listener_func_status bt_graph_notify_ports_connected( |
8cc56726 SM |
177 | struct bt_graph *graph, struct bt_port *upstream_port, |
178 | struct bt_port *downstream_port); | |
1bf957a0 | 179 | |
f167d3c0 PP |
180 | BT_HIDDEN |
181 | void bt_graph_remove_connection(struct bt_graph *graph, | |
182 | struct bt_connection *connection); | |
183 | ||
8ed535b5 PP |
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 | ||
5c563278 | 196 | BT_HIDDEN |
d6e69534 PP |
197 | void bt_graph_add_message(struct bt_graph *graph, |
198 | struct bt_message *msg); | |
5c563278 | 199 | |
9b4f9b42 PP |
200 | BT_HIDDEN |
201 | bool bt_graph_is_interrupted(const struct bt_graph *graph); | |
202 | ||
5badd463 PP |
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: | |
8a432889 | 209 | return "CONFIGURING"; |
5badd463 | 210 | case BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED: |
8a432889 | 211 | return "PARTIALLY_CONFIGURED"; |
5badd463 | 212 | case BT_GRAPH_CONFIGURATION_STATE_CONFIGURED: |
8a432889 PP |
213 | return "CONFIGURED"; |
214 | case BT_GRAPH_CONFIGURATION_STATE_FAULTY: | |
215 | return "FAULTY"; | |
216 | case BT_GRAPH_CONFIGURATION_STATE_DESTROYING: | |
217 | return "DESTROYING"; | |
5badd463 PP |
218 | default: |
219 | return "(unknown)"; | |
220 | } | |
221 | } | |
222 | ||
223 | static inline | |
d24d5663 | 224 | int bt_graph_configure(struct bt_graph *graph) |
5badd463 | 225 | { |
d24d5663 | 226 | int status = BT_FUNC_STATUS_OK; |
5badd463 PP |
227 | uint64_t i; |
228 | ||
38cda5da PP |
229 | BT_ASSERT(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY); |
230 | ||
91d81473 | 231 | if (G_LIKELY(graph->config_state == |
5badd463 PP |
232 | BT_GRAPH_CONFIGURATION_STATE_CONFIGURED)) { |
233 | goto end; | |
234 | } | |
235 | ||
cd6128ca | 236 | BT_ASSERT_PRE(graph->has_sink, "Graph has no sink component: %!+g", graph); |
5badd463 PP |
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) { | |
d24d5663 | 254 | enum bt_component_class_sink_graph_is_configured_method_status comp_status; |
5badd463 | 255 | |
5badd463 PP |
256 | BT_LIB_LOGD("Calling user's \"graph is configured\" method: " |
257 | "%![graph-]+g, %![comp-]+c", | |
258 | graph, comp); | |
5badd463 PP |
259 | comp_status = comp_cls_sink->methods.graph_is_configured( |
260 | (void *) comp_sink); | |
5badd463 | 261 | BT_LIB_LOGD("User method returned: status=%s", |
d24d5663 PP |
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, | |
5badd463 | 266 | "Unexpected returned status: status=%s", |
d24d5663 | 267 | bt_common_func_status_string(comp_status)); |
d24d5663 | 268 | if (comp_status != BT_FUNC_STATUS_OK) { |
870631a2 PP |
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; | |
5badd463 PP |
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 | ||
8cc56726 SM |
292 | static inline |
293 | void bt_graph_make_faulty(struct bt_graph *graph) | |
294 | { | |
295 | graph->config_state = BT_GRAPH_CONFIGURATION_STATE_FAULTY; | |
3f7d4d90 | 296 | BT_LIB_LOGI("Set graph's state to faulty: %![graph-]+g", graph); |
8cc56726 SM |
297 | } |
298 | ||
6ac74c0c | 299 | #endif /* BABELTRACE_GRAPH_GRAPH_INTERNAL_H */ |