Commit | Line | Data |
---|---|---|
c0418dd9 | 1 | /* |
0235b0db MJ |
2 | * SPDX-License-Identifier: MIT |
3 | * | |
e2f7325d | 4 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
f60c8b34 | 5 | * Copyright 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
c0418dd9 JG |
6 | */ |
7 | ||
350ad6c1 | 8 | #define BT_LOG_TAG "LIB/GRAPH" |
c2d9d9cf | 9 | #include "lib/logging.h" |
262e5473 | 10 | |
578e048b | 11 | #include "common/assert.h" |
d98421f2 | 12 | #include "lib/assert-cond.h" |
3fadfbc0 | 13 | #include <babeltrace2/graph/graph.h> |
43c59509 PP |
14 | #include <babeltrace2/graph/component.h> |
15 | #include <babeltrace2/graph/port.h> | |
578e048b MJ |
16 | #include "lib/graph/message/message.h" |
17 | #include "compat/compiler.h" | |
18 | #include "common/common.h" | |
3fadfbc0 MJ |
19 | #include <babeltrace2/types.h> |
20 | #include <babeltrace2/value.h> | |
578e048b | 21 | #include "lib/value.h" |
f60c8b34 | 22 | #include <unistd.h> |
c4f23e30 | 23 | #include <stdbool.h> |
1bf957a0 PP |
24 | #include <glib.h> |
25 | ||
078033ed | 26 | #include "component-class-sink-simple.h" |
578e048b MJ |
27 | #include "component.h" |
28 | #include "component-sink.h" | |
29 | #include "connection.h" | |
30 | #include "graph.h" | |
9b4f9b42 | 31 | #include "interrupter.h" |
578e048b MJ |
32 | #include "message/event.h" |
33 | #include "message/packet.h" | |
34 | ||
d24d5663 PP |
35 | typedef enum bt_graph_listener_func_status |
36 | (*port_added_func_t)(const void *, const void *, void *); | |
0d72b8c3 | 37 | |
21a9f056 | 38 | typedef enum bt_component_class_initialize_method_status |
59225a3e | 39 | (*comp_init_method_t)(const void *, void *, const void *, void *); |
d24d5663 | 40 | |
d94d92ac | 41 | struct bt_graph_listener_port_added { |
d94d92ac | 42 | port_added_func_t func; |
f3d6b4c2 | 43 | void *data; |
d94d92ac | 44 | }; |
8cc092c9 | 45 | |
d94d92ac PP |
46 | #define INIT_LISTENERS_ARRAY(_type, _listeners) \ |
47 | do { \ | |
48 | _listeners = g_array_new(FALSE, TRUE, sizeof(_type)); \ | |
49 | if (!(_listeners)) { \ | |
870631a2 PP |
50 | BT_LIB_LOGE_APPEND_CAUSE( \ |
51 | "Failed to allocate one GArray."); \ | |
d94d92ac PP |
52 | } \ |
53 | } while (0) | |
54 | ||
f60c8b34 | 55 | static |
d94d92ac | 56 | void destroy_graph(struct bt_object *obj) |
c0418dd9 | 57 | { |
0d72b8c3 | 58 | struct bt_graph *graph = container_of(obj, struct bt_graph, base); |
c0418dd9 | 59 | |
bd14d768 PP |
60 | /* |
61 | * The graph's reference count is 0 if we're here. Increment | |
62 | * it to avoid a double-destroy (possibly infinitely recursive) | |
63 | * in this situation: | |
64 | * | |
65 | * 1. We put and destroy a connection. | |
d0fea130 PP |
66 | * 2. This connection's destructor finalizes its active message |
67 | * iterators. | |
68 | * 3. A message iterator's finalization function gets a new | |
69 | * reference on its component (reference count goes from 0 to | |
70 | * 1). | |
bd14d768 PP |
71 | * 4. Since this component's reference count goes to 1, it takes |
72 | * a reference on its parent (this graph). This graph's | |
73 | * reference count goes from 0 to 1. | |
d6e69534 | 74 | * 5. The message iterator's finalization function puts its |
bd14d768 PP |
75 | * component reference (reference count goes from 1 to 0). |
76 | * 6. Since this component's reference count goes from 1 to 0, | |
77 | * it puts its parent (this graph). This graph's reference | |
78 | * count goes from 1 to 0. | |
d0fea130 PP |
79 | * 7. Since this graph's reference count goes from 1 to 0, its |
80 | * destructor is called (this function). | |
bd14d768 PP |
81 | * |
82 | * With the incrementation below, the graph's reference count at | |
83 | * step 4 goes from 1 to 2, and from 2 to 1 at step 6. This | |
84 | * ensures that this function is not called two times. | |
85 | */ | |
3f7d4d90 | 86 | BT_LIB_LOGI("Destroying graph: %!+g", graph); |
3fea54f6 | 87 | obj->ref_count++; |
9b4f9b42 | 88 | graph->config_state = BT_GRAPH_CONFIGURATION_STATE_DESTROYING; |
49682acd | 89 | |
d6e69534 PP |
90 | if (graph->messages) { |
91 | g_ptr_array_free(graph->messages, TRUE); | |
92 | graph->messages = NULL; | |
5c563278 PP |
93 | } |
94 | ||
c0418dd9 | 95 | if (graph->connections) { |
262e5473 | 96 | BT_LOGD_STR("Destroying connections."); |
c0418dd9 | 97 | g_ptr_array_free(graph->connections, TRUE); |
d94d92ac | 98 | graph->connections = NULL; |
c0418dd9 | 99 | } |
5c563278 | 100 | |
bd14d768 | 101 | if (graph->components) { |
262e5473 | 102 | BT_LOGD_STR("Destroying components."); |
bd14d768 | 103 | g_ptr_array_free(graph->components, TRUE); |
d94d92ac | 104 | graph->components = NULL; |
bd14d768 | 105 | } |
5c563278 | 106 | |
9b4f9b42 PP |
107 | if (graph->interrupters) { |
108 | BT_LOGD_STR("Putting interrupters."); | |
109 | g_ptr_array_free(graph->interrupters, TRUE); | |
110 | graph->interrupters = NULL; | |
111 | } | |
112 | ||
113 | BT_OBJECT_PUT_REF_AND_RESET(graph->default_interrupter); | |
114 | ||
f60c8b34 JG |
115 | if (graph->sinks_to_consume) { |
116 | g_queue_free(graph->sinks_to_consume); | |
d94d92ac PP |
117 | graph->sinks_to_consume = NULL; |
118 | } | |
119 | ||
120 | if (graph->listeners.source_output_port_added) { | |
121 | g_array_free(graph->listeners.source_output_port_added, TRUE); | |
122 | graph->listeners.source_output_port_added = NULL; | |
123 | } | |
124 | ||
125 | if (graph->listeners.filter_output_port_added) { | |
126 | g_array_free(graph->listeners.filter_output_port_added, TRUE); | |
127 | graph->listeners.filter_output_port_added = NULL; | |
128 | } | |
129 | ||
130 | if (graph->listeners.filter_input_port_added) { | |
131 | g_array_free(graph->listeners.filter_input_port_added, TRUE); | |
132 | graph->listeners.filter_input_port_added = NULL; | |
c0418dd9 | 133 | } |
1bf957a0 | 134 | |
d94d92ac PP |
135 | if (graph->listeners.sink_input_port_added) { |
136 | g_array_free(graph->listeners.sink_input_port_added, TRUE); | |
137 | graph->listeners.sink_input_port_added = NULL; | |
1bf957a0 PP |
138 | } |
139 | ||
d6e69534 PP |
140 | bt_object_pool_finalize(&graph->event_msg_pool); |
141 | bt_object_pool_finalize(&graph->packet_begin_msg_pool); | |
142 | bt_object_pool_finalize(&graph->packet_end_msg_pool); | |
c0418dd9 JG |
143 | g_free(graph); |
144 | } | |
145 | ||
5c563278 | 146 | static |
d6e69534 | 147 | void destroy_message_event(struct bt_message *msg, |
5c563278 PP |
148 | struct bt_graph *graph) |
149 | { | |
d6e69534 | 150 | bt_message_event_destroy(msg); |
5c563278 PP |
151 | } |
152 | ||
153 | static | |
d6e69534 | 154 | void destroy_message_packet_begin(struct bt_message *msg, |
5c563278 PP |
155 | struct bt_graph *graph) |
156 | { | |
5df26c89 | 157 | bt_message_packet_destroy(msg); |
5c563278 PP |
158 | } |
159 | ||
160 | static | |
d6e69534 | 161 | void destroy_message_packet_end(struct bt_message *msg, |
5c563278 PP |
162 | struct bt_graph *graph) |
163 | { | |
5df26c89 | 164 | bt_message_packet_destroy(msg); |
5c563278 PP |
165 | } |
166 | ||
167 | static | |
d6e69534 | 168 | void notify_message_graph_is_destroyed(struct bt_message *msg) |
5c563278 | 169 | { |
d6e69534 | 170 | bt_message_unlink_graph(msg); |
5c563278 PP |
171 | } |
172 | ||
056deb59 | 173 | struct bt_graph *bt_graph_create(uint64_t mip_version) |
c0418dd9 | 174 | { |
f60c8b34 | 175 | struct bt_graph *graph; |
1bf957a0 | 176 | int ret; |
c0418dd9 | 177 | |
17f3083a | 178 | BT_ASSERT_PRE_NO_ERROR(); |
056deb59 PP |
179 | BT_ASSERT_PRE(mip_version <= bt_get_maximal_mip_version(), |
180 | "Unknown MIP version: mip-version=%" PRIu64 ", " | |
181 | "max-mip-version=%" PRIu64, | |
182 | mip_version, bt_get_maximal_mip_version()); | |
3f7d4d90 | 183 | BT_LOGI_STR("Creating graph object."); |
f60c8b34 | 184 | graph = g_new0(struct bt_graph, 1); |
c0418dd9 | 185 | if (!graph) { |
870631a2 | 186 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one graph."); |
c0418dd9 JG |
187 | goto end; |
188 | } | |
189 | ||
d94d92ac | 190 | bt_object_init_shared(&graph->base, destroy_graph); |
056deb59 | 191 | graph->mip_version = mip_version; |
3fea54f6 PP |
192 | graph->connections = g_ptr_array_new_with_free_func( |
193 | (GDestroyNotify) bt_object_try_spec_release); | |
c0418dd9 | 194 | if (!graph->connections) { |
870631a2 | 195 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); |
c0418dd9 JG |
196 | goto error; |
197 | } | |
3fea54f6 PP |
198 | graph->components = g_ptr_array_new_with_free_func( |
199 | (GDestroyNotify) bt_object_try_spec_release); | |
f60c8b34 | 200 | if (!graph->components) { |
870631a2 | 201 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); |
f60c8b34 JG |
202 | goto error; |
203 | } | |
204 | graph->sinks_to_consume = g_queue_new(); | |
205 | if (!graph->sinks_to_consume) { | |
870631a2 | 206 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GQueue."); |
c0418dd9 JG |
207 | goto error; |
208 | } | |
1bf957a0 | 209 | |
d94d92ac PP |
210 | bt_graph_set_can_consume(graph, true); |
211 | INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, | |
212 | graph->listeners.source_output_port_added); | |
213 | ||
214 | if (!graph->listeners.source_output_port_added) { | |
1bf957a0 PP |
215 | goto error; |
216 | } | |
217 | ||
d94d92ac PP |
218 | INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, |
219 | graph->listeners.filter_output_port_added); | |
220 | ||
221 | if (!graph->listeners.filter_output_port_added) { | |
1bf957a0 PP |
222 | goto error; |
223 | } | |
224 | ||
d94d92ac PP |
225 | INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, |
226 | graph->listeners.filter_input_port_added); | |
227 | ||
228 | if (!graph->listeners.filter_input_port_added) { | |
1bf957a0 PP |
229 | goto error; |
230 | } | |
231 | ||
d94d92ac PP |
232 | INIT_LISTENERS_ARRAY(struct bt_graph_listener_port_added, |
233 | graph->listeners.sink_input_port_added); | |
234 | ||
235 | if (!graph->listeners.sink_input_port_added) { | |
d94d92ac PP |
236 | goto error; |
237 | } | |
238 | ||
9b4f9b42 | 239 | graph->interrupters = g_ptr_array_new_with_free_func( |
6871026b | 240 | (GDestroyNotify) bt_object_put_ref_no_null_check); |
9b4f9b42 PP |
241 | if (!graph->interrupters) { |
242 | BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate one GPtrArray."); | |
243 | goto error; | |
244 | } | |
245 | ||
246 | graph->default_interrupter = bt_interrupter_create(); | |
247 | if (!graph->default_interrupter) { | |
248 | BT_LIB_LOGE_APPEND_CAUSE( | |
249 | "Failed to create one interrupter object."); | |
250 | goto error; | |
251 | } | |
252 | ||
253 | bt_graph_add_interrupter(graph, graph->default_interrupter); | |
d6e69534 PP |
254 | ret = bt_object_pool_initialize(&graph->event_msg_pool, |
255 | (bt_object_pool_new_object_func) bt_message_event_new, | |
256 | (bt_object_pool_destroy_object_func) destroy_message_event, | |
5c563278 PP |
257 | graph); |
258 | if (ret) { | |
870631a2 PP |
259 | BT_LIB_LOGE_APPEND_CAUSE( |
260 | "Failed to initialize event message pool: ret=%d", | |
5c563278 PP |
261 | ret); |
262 | goto error; | |
263 | } | |
264 | ||
d6e69534 PP |
265 | ret = bt_object_pool_initialize(&graph->packet_begin_msg_pool, |
266 | (bt_object_pool_new_object_func) bt_message_packet_beginning_new, | |
267 | (bt_object_pool_destroy_object_func) destroy_message_packet_begin, | |
5c563278 PP |
268 | graph); |
269 | if (ret) { | |
870631a2 PP |
270 | BT_LIB_LOGE_APPEND_CAUSE( |
271 | "Failed to initialize packet beginning message pool: ret=%d", | |
5c563278 PP |
272 | ret); |
273 | goto error; | |
274 | } | |
275 | ||
d6e69534 PP |
276 | ret = bt_object_pool_initialize(&graph->packet_end_msg_pool, |
277 | (bt_object_pool_new_object_func) bt_message_packet_end_new, | |
278 | (bt_object_pool_destroy_object_func) destroy_message_packet_end, | |
5c563278 PP |
279 | graph); |
280 | if (ret) { | |
870631a2 PP |
281 | BT_LIB_LOGE_APPEND_CAUSE( |
282 | "Failed to initialize packet end message pool: ret=%d", | |
5c563278 PP |
283 | ret); |
284 | goto error; | |
285 | } | |
286 | ||
d6e69534 PP |
287 | graph->messages = g_ptr_array_new_with_free_func( |
288 | (GDestroyNotify) notify_message_graph_is_destroyed); | |
3f7d4d90 | 289 | BT_LIB_LOGI("Created graph object: %!+g", graph); |
262e5473 | 290 | |
c0418dd9 | 291 | end: |
a2d06fd5 | 292 | return (void *) graph; |
d94d92ac | 293 | |
c0418dd9 | 294 | error: |
65300d60 | 295 | BT_OBJECT_PUT_REF_AND_RESET(graph); |
c0418dd9 JG |
296 | goto end; |
297 | } | |
298 | ||
d24d5663 | 299 | enum bt_graph_connect_ports_status bt_graph_connect_ports( |
0d72b8c3 PP |
300 | struct bt_graph *graph, |
301 | const struct bt_port_output *upstream_port_out, | |
302 | const struct bt_port_input *downstream_port_in, | |
303 | const struct bt_connection **user_connection) | |
f60c8b34 | 304 | { |
d24d5663 | 305 | enum bt_graph_connect_ports_status status = BT_FUNC_STATUS_OK; |
f60c8b34 | 306 | struct bt_connection *connection = NULL; |
d94d92ac PP |
307 | struct bt_port *upstream_port = (void *) upstream_port_out; |
308 | struct bt_port *downstream_port = (void *) downstream_port_in; | |
f60c8b34 JG |
309 | struct bt_component *upstream_component = NULL; |
310 | struct bt_component *downstream_component = NULL; | |
d24d5663 | 311 | enum bt_component_class_port_connected_method_status port_connected_status; |
d94d92ac | 312 | bool init_can_consume; |
f60c8b34 | 313 | |
17f3083a | 314 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
315 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
316 | BT_ASSERT_PRE_NON_NULL(upstream_port, "Upstream port"); | |
317 | BT_ASSERT_PRE_NON_NULL(downstream_port, "Downstream port port"); | |
5badd463 PP |
318 | BT_ASSERT_PRE( |
319 | graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, | |
38cda5da | 320 | "Graph is not in the \"configuring\" state: %!+g", graph); |
d94d92ac PP |
321 | BT_ASSERT_PRE(!bt_port_is_connected(upstream_port), |
322 | "Upstream port is already connected: %!+p", upstream_port); | |
323 | BT_ASSERT_PRE(!bt_port_is_connected(downstream_port), | |
324 | "Downstream port is already connected: %!+p", downstream_port); | |
0d72b8c3 | 325 | BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) upstream_port), |
d94d92ac PP |
326 | "Upstream port does not belong to a component: %!+p", |
327 | upstream_port); | |
0d72b8c3 | 328 | BT_ASSERT_PRE(bt_port_borrow_component_inline((void *) downstream_port), |
d94d92ac PP |
329 | "Downstream port does not belong to a component: %!+p", |
330 | downstream_port); | |
4aa7981f | 331 | init_can_consume = graph->can_consume; |
3f7d4d90 | 332 | BT_LIB_LOGI("Connecting component ports within graph: " |
d94d92ac PP |
333 | "%![graph-]+g, %![up-port-]+p, %![down-port-]+p", |
334 | graph, upstream_port, downstream_port); | |
335 | bt_graph_set_can_consume(graph, false); | |
0d72b8c3 | 336 | upstream_component = bt_port_borrow_component_inline( |
d94d92ac | 337 | (void *) upstream_port); |
0d72b8c3 | 338 | downstream_component = bt_port_borrow_component_inline( |
d94d92ac | 339 | (void *) downstream_port); |
262e5473 | 340 | |
262e5473 | 341 | BT_LOGD_STR("Creating connection."); |
d94d92ac PP |
342 | connection = bt_connection_create(graph, (void *) upstream_port, |
343 | (void *) downstream_port); | |
f60c8b34 | 344 | if (!connection) { |
870631a2 | 345 | BT_LIB_LOGE_APPEND_CAUSE("Cannot create connection object."); |
d24d5663 | 346 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
a256a42d | 347 | goto end; |
f60c8b34 JG |
348 | } |
349 | ||
d94d92ac | 350 | BT_LIB_LOGD("Connection object created: %!+x", connection); |
262e5473 | 351 | |
f60c8b34 | 352 | /* |
72b913fb PP |
353 | * Ownership of upstream_component/downstream_component and of |
354 | * the connection object is transferred to the graph. | |
f60c8b34 JG |
355 | */ |
356 | g_ptr_array_add(graph->connections, connection); | |
ffeb0eed | 357 | |
f60c8b34 | 358 | /* |
0d8b4d8e | 359 | * Notify both components that their port is connected. |
f60c8b34 | 360 | */ |
d94d92ac PP |
361 | BT_LIB_LOGD("Notifying upstream component that its port is connected: " |
362 | "%![comp-]+c, %![port-]+p", upstream_component, upstream_port); | |
d24d5663 | 363 | port_connected_status = bt_component_port_connected(upstream_component, |
d94d92ac | 364 | (void *) upstream_port, (void *) downstream_port); |
d24d5663 | 365 | if (port_connected_status != BT_FUNC_STATUS_OK) { |
870631a2 PP |
366 | if (port_connected_status < 0) { |
367 | BT_LIB_LOGW_APPEND_CAUSE( | |
368 | "Upstream component's \"port connected\" method failed: " | |
369 | "status=%s, %![graph-]+g, %![up-comp-]+c, " | |
370 | "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", | |
371 | bt_common_func_status_string( | |
372 | port_connected_status), | |
373 | graph, upstream_component, downstream_component, | |
374 | upstream_port, downstream_port); | |
375 | } | |
376 | ||
bf55043c | 377 | bt_connection_end(connection, true); |
d24d5663 | 378 | status = (int) port_connected_status; |
bf55043c PP |
379 | goto end; |
380 | } | |
381 | ||
85031ceb | 382 | connection->notified_upstream_port_connected = true; |
d94d92ac PP |
383 | BT_LIB_LOGD("Notifying downstream component that its port is connected: " |
384 | "%![comp-]+c, %![port-]+p", downstream_component, | |
385 | downstream_port); | |
d24d5663 | 386 | port_connected_status = bt_component_port_connected(downstream_component, |
d94d92ac | 387 | (void *) downstream_port, (void *) upstream_port); |
d24d5663 | 388 | if (port_connected_status != BT_FUNC_STATUS_OK) { |
870631a2 PP |
389 | if (port_connected_status < 0) { |
390 | BT_LIB_LOGW_APPEND_CAUSE( | |
391 | "Downstream component's \"port connected\" method failed: " | |
392 | "status=%s, %![graph-]+g, %![up-comp-]+c, " | |
393 | "%![down-comp-]+c, %![up-port-]+p, %![down-port-]+p", | |
394 | bt_common_func_status_string( | |
395 | port_connected_status), | |
396 | graph, upstream_component, downstream_component, | |
397 | upstream_port, downstream_port); | |
398 | } | |
399 | ||
bf55043c | 400 | bt_connection_end(connection, true); |
d24d5663 | 401 | status = (int) port_connected_status; |
bf55043c PP |
402 | goto end; |
403 | } | |
404 | ||
85031ceb | 405 | connection->notified_downstream_port_connected = true; |
1bf957a0 | 406 | |
3f7d4d90 | 407 | BT_LIB_LOGI("Connected component ports within graph: " |
d94d92ac PP |
408 | "%![graph-]+g, %![up-comp-]+c, %![down-comp-]+c, " |
409 | "%![up-port-]+p, %![down-port-]+p", | |
410 | graph, upstream_component, downstream_component, | |
411 | upstream_port, downstream_port); | |
1bf957a0 | 412 | |
a256a42d | 413 | if (user_connection) { |
1a6a376a PP |
414 | /* Move reference to user */ |
415 | *user_connection = connection; | |
a256a42d PP |
416 | } |
417 | ||
f60c8b34 | 418 | end: |
d24d5663 | 419 | if (status != BT_FUNC_STATUS_OK) { |
8cc56726 | 420 | bt_graph_make_faulty(graph); |
38cda5da PP |
421 | } |
422 | ||
65300d60 | 423 | bt_object_put_ref(connection); |
d94d92ac PP |
424 | (void) init_can_consume; |
425 | bt_graph_set_can_consume(graph, init_can_consume); | |
a256a42d | 426 | return status; |
f60c8b34 JG |
427 | } |
428 | ||
ad847455 | 429 | static inline |
d24d5663 | 430 | int consume_graph_sink(struct bt_component_sink *comp) |
c0418dd9 | 431 | { |
d24d5663 | 432 | enum bt_component_class_sink_consume_method_status consume_status; |
d94d92ac PP |
433 | struct bt_component_class_sink *sink_class = NULL; |
434 | ||
98b15851 | 435 | BT_ASSERT_DBG(comp); |
d94d92ac | 436 | sink_class = (void *) comp->parent.class; |
98b15851 | 437 | BT_ASSERT_DBG(sink_class->methods.consume); |
d94d92ac | 438 | BT_LIB_LOGD("Calling user's consume method: %!+c", comp); |
d24d5663 | 439 | consume_status = sink_class->methods.consume((void *) comp); |
d94d92ac | 440 | BT_LOGD("User method returned: status=%s", |
d24d5663 | 441 | bt_common_func_status_string(consume_status)); |
bdb288b3 | 442 | BT_ASSERT_POST_DEV(consume_status == BT_FUNC_STATUS_OK || |
d24d5663 PP |
443 | consume_status == BT_FUNC_STATUS_END || |
444 | consume_status == BT_FUNC_STATUS_AGAIN || | |
445 | consume_status == BT_FUNC_STATUS_ERROR || | |
446 | consume_status == BT_FUNC_STATUS_MEMORY_ERROR, | |
d94d92ac | 447 | "Invalid component status returned by consuming method: " |
d24d5663 | 448 | "status=%s", bt_common_func_status_string(consume_status)); |
6ecdcca3 | 449 | BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(consume_status); |
870631a2 PP |
450 | if (consume_status) { |
451 | if (consume_status < 0) { | |
452 | BT_LIB_LOGW_APPEND_CAUSE( | |
453 | "Component's \"consume\" method failed: " | |
454 | "status=%s, %![comp-]+c", | |
455 | bt_common_func_status_string(consume_status), | |
456 | comp); | |
457 | } | |
458 | ||
d94d92ac PP |
459 | goto end; |
460 | } | |
461 | ||
3f7d4d90 | 462 | BT_LIB_LOGD("Consumed from sink: %![comp-]+c, status=%s", |
d24d5663 | 463 | comp, bt_common_func_status_string(consume_status)); |
d94d92ac PP |
464 | |
465 | end: | |
d24d5663 | 466 | return consume_status; |
8ed535b5 PP |
467 | } |
468 | ||
469 | /* | |
470 | * `node` is removed from the queue of sinks to consume when passed to | |
471 | * this function. This function adds it back to the queue if there's | |
472 | * still something to consume afterwards. | |
473 | */ | |
ad847455 | 474 | static inline |
d24d5663 | 475 | int consume_sink_node(struct bt_graph *graph, GList *node) |
8ed535b5 | 476 | { |
d24d5663 | 477 | int status; |
d94d92ac | 478 | struct bt_component_sink *sink; |
8ed535b5 PP |
479 | |
480 | sink = node->data; | |
481 | status = consume_graph_sink(sink); | |
d24d5663 | 482 | if (G_UNLIKELY(status != BT_FUNC_STATUS_END)) { |
8ed535b5 | 483 | g_queue_push_tail_link(graph->sinks_to_consume, node); |
f60c8b34 JG |
484 | goto end; |
485 | } | |
486 | ||
487 | /* End reached, the node is not added back to the queue and free'd. */ | |
8ed535b5 | 488 | g_queue_delete_link(graph->sinks_to_consume, node); |
f60c8b34 JG |
489 | |
490 | /* Don't forward an END status if there are sinks left to consume. */ | |
491 | if (!g_queue_is_empty(graph->sinks_to_consume)) { | |
d24d5663 | 492 | status = BT_FUNC_STATUS_OK; |
f60c8b34 JG |
493 | goto end; |
494 | } | |
8ed535b5 PP |
495 | |
496 | end: | |
3f7d4d90 | 497 | BT_LIB_LOGD("Consumed sink node: %![comp-]+c, status=%s", |
d24d5663 | 498 | sink, bt_common_func_status_string(status)); |
8ed535b5 PP |
499 | return status; |
500 | } | |
501 | ||
502 | BT_HIDDEN | |
d24d5663 | 503 | int bt_graph_consume_sink_no_check(struct bt_graph *graph, |
d94d92ac | 504 | struct bt_component_sink *sink) |
8ed535b5 | 505 | { |
d24d5663 | 506 | int status; |
8ed535b5 PP |
507 | GList *sink_node; |
508 | int index; | |
509 | ||
3f7d4d90 | 510 | BT_LIB_LOGD("Making specific sink consume: %![comp-]+c", sink); |
98b15851 | 511 | BT_ASSERT_DBG(bt_component_borrow_graph((void *) sink) == graph); |
8ed535b5 PP |
512 | |
513 | if (g_queue_is_empty(graph->sinks_to_consume)) { | |
3f7d4d90 | 514 | BT_LOGD_STR("Graph's sink queue is empty: end of graph."); |
d24d5663 | 515 | status = BT_FUNC_STATUS_END; |
8ed535b5 PP |
516 | goto end; |
517 | } | |
518 | ||
519 | index = g_queue_index(graph->sinks_to_consume, sink); | |
520 | if (index < 0) { | |
3f7d4d90 PP |
521 | BT_LIB_LOGD("Sink component is not marked as consumable: " |
522 | "component sink is ended: %![comp-]+c", sink); | |
d24d5663 | 523 | status = BT_FUNC_STATUS_END; |
8ed535b5 PP |
524 | goto end; |
525 | } | |
526 | ||
527 | sink_node = g_queue_pop_nth_link(graph->sinks_to_consume, index); | |
98b15851 | 528 | BT_ASSERT_DBG(sink_node); |
8ed535b5 PP |
529 | status = consume_sink_node(graph, sink_node); |
530 | ||
531 | end: | |
532 | return status; | |
533 | } | |
534 | ||
ad847455 | 535 | static inline |
d24d5663 | 536 | int consume_no_check(struct bt_graph *graph) |
8ed535b5 | 537 | { |
d24d5663 | 538 | int status = BT_FUNC_STATUS_OK; |
8ed535b5 PP |
539 | struct bt_component *sink; |
540 | GList *current_node; | |
541 | ||
bdb288b3 | 542 | BT_ASSERT_PRE_DEV(graph->has_sink, |
f6ccaed9 | 543 | "Graph has no sink component: %!+g", graph); |
3f7d4d90 | 544 | BT_LIB_LOGD("Making next sink component consume: %![graph-]+g", graph); |
8ed535b5 | 545 | |
91d81473 | 546 | if (G_UNLIKELY(g_queue_is_empty(graph->sinks_to_consume))) { |
3f7d4d90 | 547 | BT_LOGD_STR("Graph's sink queue is empty: end of graph."); |
d24d5663 | 548 | status = BT_FUNC_STATUS_END; |
8ed535b5 PP |
549 | goto end; |
550 | } | |
551 | ||
552 | current_node = g_queue_pop_head_link(graph->sinks_to_consume); | |
553 | sink = current_node->data; | |
3f7d4d90 | 554 | BT_LIB_LOGD("Chose next sink to consume: %!+c", sink); |
8ed535b5 PP |
555 | status = consume_sink_node(graph, current_node); |
556 | ||
f60c8b34 JG |
557 | end: |
558 | return status; | |
c0418dd9 JG |
559 | } |
560 | ||
648dab91 | 561 | enum bt_graph_run_once_status bt_graph_run_once(struct bt_graph *graph) |
851b70bd | 562 | { |
648dab91 | 563 | enum bt_graph_run_once_status status; |
1d915789 | 564 | |
17f3083a | 565 | BT_ASSERT_PRE_NO_ERROR(); |
bdb288b3 | 566 | BT_ASSERT_PRE_DEV_NON_NULL(graph, "Graph"); |
bdb288b3 | 567 | BT_ASSERT_PRE_DEV(graph->can_consume, |
f6ccaed9 | 568 | "Cannot consume graph in its current state: %!+g", graph); |
bdb288b3 PP |
569 | BT_ASSERT_PRE_DEV(graph->config_state != |
570 | BT_GRAPH_CONFIGURATION_STATE_FAULTY, | |
38cda5da | 571 | "Graph is in a faulty state: %!+g", graph); |
4725a201 | 572 | bt_graph_set_can_consume(graph, false); |
5badd463 | 573 | status = bt_graph_configure(graph); |
91d81473 | 574 | if (G_UNLIKELY(status)) { |
5badd463 PP |
575 | /* bt_graph_configure() logs errors */ |
576 | goto end; | |
577 | } | |
578 | ||
d94d92ac | 579 | status = consume_no_check(graph); |
4725a201 | 580 | bt_graph_set_can_consume(graph, true); |
5badd463 PP |
581 | |
582 | end: | |
26a15756 | 583 | return status; |
851b70bd PP |
584 | } |
585 | ||
d24d5663 | 586 | enum bt_graph_run_status bt_graph_run(struct bt_graph *graph) |
f60c8b34 | 587 | { |
d24d5663 | 588 | enum bt_graph_run_status status; |
f60c8b34 | 589 | |
17f3083a | 590 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac | 591 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
ad847455 PP |
592 | BT_ASSERT_PRE(graph->can_consume, |
593 | "Cannot consume graph in its current state: %!+g", graph); | |
38cda5da PP |
594 | BT_ASSERT_PRE(graph->config_state != BT_GRAPH_CONFIGURATION_STATE_FAULTY, |
595 | "Graph is in a faulty state: %!+g", graph); | |
4725a201 | 596 | bt_graph_set_can_consume(graph, false); |
5badd463 | 597 | status = bt_graph_configure(graph); |
91d81473 | 598 | if (G_UNLIKELY(status)) { |
5badd463 PP |
599 | /* bt_graph_configure() logs errors */ |
600 | goto end; | |
601 | } | |
602 | ||
3f7d4d90 | 603 | BT_LIB_LOGI("Running graph: %!+g", graph); |
262e5473 | 604 | |
f60c8b34 | 605 | do { |
851b70bd | 606 | /* |
9b4f9b42 PP |
607 | * Check if the graph is interrupted at each iteration. |
608 | * If the graph was interrupted by another thread or by | |
609 | * a signal handler, this is NOT a warning nor an error; | |
610 | * it was intentional: log with an INFO level only. | |
851b70bd | 611 | */ |
9b4f9b42 PP |
612 | if (G_UNLIKELY(bt_graph_is_interrupted(graph))) { |
613 | BT_LIB_LOGI("Stopping the graph: " | |
614 | "graph was interrupted: %!+g", graph); | |
615 | status = BT_FUNC_STATUS_AGAIN; | |
851b70bd PP |
616 | goto end; |
617 | } | |
618 | ||
d94d92ac | 619 | status = consume_no_check(graph); |
d24d5663 | 620 | if (G_UNLIKELY(status == BT_FUNC_STATUS_AGAIN)) { |
f60c8b34 | 621 | /* |
202a3a13 PP |
622 | * If AGAIN is received and there are multiple |
623 | * sinks, go ahead and consume from the next | |
624 | * sink. | |
f60c8b34 | 625 | * |
202a3a13 PP |
626 | * However, in the case where a single sink is |
627 | * left, the caller can decide to busy-wait and | |
0d72b8c3 | 628 | * call bt_graph_run() continuously |
d94d92ac PP |
629 | * until the source is ready or it can decide to |
630 | * sleep for an arbitrary amount of time. | |
f60c8b34 JG |
631 | */ |
632 | if (graph->sinks_to_consume->length > 1) { | |
d24d5663 | 633 | status = BT_FUNC_STATUS_OK; |
f60c8b34 JG |
634 | } |
635 | } | |
d24d5663 | 636 | } while (status == BT_FUNC_STATUS_OK); |
f60c8b34 | 637 | |
9669d693 PP |
638 | if (status == BT_FUNC_STATUS_END) { |
639 | /* | |
640 | * The last call to consume_no_check() returned | |
641 | * `BT_FUNC_STATUS_END`, but bt_graph_run() has no | |
642 | * `BT_GRAPH_RUN_STATUS_END` status: replace with | |
643 | * `BT_GRAPH_RUN_STATUS_OK` (success: graph ran | |
644 | * completely). | |
645 | */ | |
646 | status = BT_FUNC_STATUS_OK; | |
f60c8b34 | 647 | } |
262e5473 | 648 | |
202a3a13 | 649 | end: |
3f7d4d90 | 650 | BT_LIB_LOGI("Graph ran: %![graph-]+g, status=%s", graph, |
d24d5663 | 651 | bt_common_func_status_string(status)); |
4725a201 | 652 | bt_graph_set_can_consume(graph, true); |
72b913fb | 653 | return status; |
f60c8b34 | 654 | } |
1bf957a0 | 655 | |
d24d5663 | 656 | enum bt_graph_add_listener_status |
0d72b8c3 PP |
657 | bt_graph_add_source_component_output_port_added_listener( |
658 | struct bt_graph *graph, | |
659 | bt_graph_source_component_output_port_added_listener_func func, | |
f3d6b4c2 | 660 | void *data, bt_listener_id *out_listener_id) |
1bf957a0 | 661 | { |
d94d92ac | 662 | struct bt_graph_listener_port_added listener = { |
d94d92ac | 663 | .func = (port_added_func_t) func, |
f3d6b4c2 | 664 | .data = data, |
1bf957a0 | 665 | }; |
2054a0d1 | 666 | bt_listener_id listener_id; |
1bf957a0 | 667 | |
17f3083a | 668 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
669 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
670 | BT_ASSERT_PRE_NON_NULL(func, "Listener"); | |
d94d92ac PP |
671 | g_array_append_val(graph->listeners.source_output_port_added, listener); |
672 | listener_id = graph->listeners.source_output_port_added->len - 1; | |
3f7d4d90 | 673 | BT_LIB_LOGD("Added \"source component output port added\" listener to graph: " |
d94d92ac PP |
674 | "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, |
675 | listener_id); | |
676 | ||
677 | if (listener_id) { | |
678 | *out_listener_id = listener_id; | |
679 | } | |
680 | ||
d24d5663 | 681 | return BT_FUNC_STATUS_OK; |
1bf957a0 PP |
682 | } |
683 | ||
d24d5663 | 684 | enum bt_graph_add_listener_status |
0d72b8c3 PP |
685 | bt_graph_add_filter_component_output_port_added_listener( |
686 | struct bt_graph *graph, | |
687 | bt_graph_filter_component_output_port_added_listener_func func, | |
f3d6b4c2 | 688 | void *data, bt_listener_id *out_listener_id) |
1bf957a0 | 689 | { |
d94d92ac | 690 | struct bt_graph_listener_port_added listener = { |
d94d92ac | 691 | .func = (port_added_func_t) func, |
f3d6b4c2 | 692 | .data = data, |
d94d92ac | 693 | }; |
2054a0d1 | 694 | bt_listener_id listener_id; |
1bf957a0 | 695 | |
17f3083a | 696 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
697 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
698 | BT_ASSERT_PRE_NON_NULL(func, "Listener"); | |
d94d92ac PP |
699 | g_array_append_val(graph->listeners.filter_output_port_added, listener); |
700 | listener_id = graph->listeners.filter_output_port_added->len - 1; | |
3f7d4d90 | 701 | BT_LIB_LOGD("Added \"filter component output port added\" listener to graph: " |
d94d92ac PP |
702 | "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, |
703 | listener_id); | |
704 | ||
705 | if (listener_id) { | |
706 | *out_listener_id = listener_id; | |
707 | } | |
708 | ||
d24d5663 | 709 | return BT_FUNC_STATUS_OK; |
d94d92ac | 710 | } |
262e5473 | 711 | |
d24d5663 | 712 | enum bt_graph_add_listener_status |
0d72b8c3 PP |
713 | bt_graph_add_filter_component_input_port_added_listener( |
714 | struct bt_graph *graph, | |
715 | bt_graph_filter_component_input_port_added_listener_func func, | |
f3d6b4c2 | 716 | void *data, bt_listener_id *out_listener_id) |
d94d92ac | 717 | { |
d94d92ac | 718 | struct bt_graph_listener_port_added listener = { |
d94d92ac | 719 | .func = (port_added_func_t) func, |
f3d6b4c2 | 720 | .data = data, |
d94d92ac | 721 | }; |
2054a0d1 | 722 | bt_listener_id listener_id; |
8cc092c9 | 723 | |
17f3083a | 724 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
725 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
726 | BT_ASSERT_PRE_NON_NULL(func, "Listener"); | |
d94d92ac PP |
727 | g_array_append_val(graph->listeners.filter_input_port_added, listener); |
728 | listener_id = graph->listeners.filter_input_port_added->len - 1; | |
3f7d4d90 | 729 | BT_LIB_LOGD("Added \"filter component input port added\" listener to graph: " |
d94d92ac PP |
730 | "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, |
731 | listener_id); | |
732 | ||
733 | if (listener_id) { | |
734 | *out_listener_id = listener_id; | |
735 | } | |
736 | ||
d24d5663 | 737 | return BT_FUNC_STATUS_OK; |
d94d92ac | 738 | } |
1bf957a0 | 739 | |
d24d5663 | 740 | enum bt_graph_add_listener_status |
0d72b8c3 PP |
741 | bt_graph_add_sink_component_input_port_added_listener( |
742 | struct bt_graph *graph, | |
743 | bt_graph_sink_component_input_port_added_listener_func func, | |
f3d6b4c2 | 744 | void *data, bt_listener_id *out_listener_id) |
d94d92ac | 745 | { |
d94d92ac | 746 | struct bt_graph_listener_port_added listener = { |
d94d92ac | 747 | .func = (port_added_func_t) func, |
f3d6b4c2 | 748 | .data = data, |
d94d92ac | 749 | }; |
2054a0d1 | 750 | bt_listener_id listener_id; |
1bf957a0 | 751 | |
17f3083a | 752 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
753 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
754 | BT_ASSERT_PRE_NON_NULL(func, "Listener"); | |
d94d92ac PP |
755 | g_array_append_val(graph->listeners.sink_input_port_added, listener); |
756 | listener_id = graph->listeners.sink_input_port_added->len - 1; | |
3f7d4d90 | 757 | BT_LIB_LOGD("Added \"sink component input port added\" listener to graph: " |
d94d92ac PP |
758 | "%![graph-]+g, listener-addr=%p, id=%d", graph, listener, |
759 | listener_id); | |
760 | ||
761 | if (listener_id) { | |
762 | *out_listener_id = listener_id; | |
763 | } | |
764 | ||
d24d5663 | 765 | return BT_FUNC_STATUS_OK; |
1bf957a0 PP |
766 | } |
767 | ||
1bf957a0 | 768 | BT_HIDDEN |
d24d5663 | 769 | enum bt_graph_listener_func_status bt_graph_notify_port_added( |
8cc56726 | 770 | struct bt_graph *graph, struct bt_port *port) |
1bf957a0 | 771 | { |
d94d92ac PP |
772 | uint64_t i; |
773 | GArray *listeners; | |
774 | struct bt_component *comp; | |
d24d5663 | 775 | enum bt_graph_listener_func_status status = BT_FUNC_STATUS_OK; |
1bf957a0 | 776 | |
d94d92ac PP |
777 | BT_ASSERT(graph); |
778 | BT_ASSERT(port); | |
3f7d4d90 | 779 | BT_LIB_LOGD("Notifying graph listeners that a port was added: " |
d94d92ac | 780 | "%![graph-]+g, %![port-]+p", graph, port); |
0d72b8c3 | 781 | comp = bt_port_borrow_component_inline(port); |
d94d92ac PP |
782 | BT_ASSERT(comp); |
783 | ||
784 | switch (comp->class->type) { | |
785 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
786 | { | |
787 | switch (port->type) { | |
788 | case BT_PORT_TYPE_OUTPUT: | |
789 | listeners = graph->listeners.source_output_port_added; | |
790 | break; | |
791 | default: | |
498e7994 | 792 | bt_common_abort(); |
d94d92ac PP |
793 | } |
794 | ||
795 | break; | |
796 | } | |
797 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
798 | { | |
799 | switch (port->type) { | |
800 | case BT_PORT_TYPE_INPUT: | |
801 | listeners = graph->listeners.filter_input_port_added; | |
802 | break; | |
803 | case BT_PORT_TYPE_OUTPUT: | |
804 | listeners = graph->listeners.filter_output_port_added; | |
805 | break; | |
806 | default: | |
498e7994 | 807 | bt_common_abort(); |
d94d92ac | 808 | } |
262e5473 | 809 | |
d94d92ac PP |
810 | break; |
811 | } | |
812 | case BT_COMPONENT_CLASS_TYPE_SINK: | |
813 | { | |
814 | switch (port->type) { | |
815 | case BT_PORT_TYPE_INPUT: | |
816 | listeners = graph->listeners.sink_input_port_added; | |
817 | break; | |
818 | default: | |
498e7994 | 819 | bt_common_abort(); |
d94d92ac | 820 | } |
1bf957a0 | 821 | |
d94d92ac PP |
822 | break; |
823 | } | |
824 | default: | |
498e7994 | 825 | bt_common_abort(); |
d94d92ac PP |
826 | } |
827 | ||
828 | for (i = 0; i < listeners->len; i++) { | |
829 | struct bt_graph_listener_port_added *listener = | |
830 | &g_array_index(listeners, | |
831 | struct bt_graph_listener_port_added, i); | |
832 | ||
8cc56726 | 833 | |
d94d92ac | 834 | BT_ASSERT(listener->func); |
f3d6b4c2 | 835 | status = listener->func(comp, port, listener->data); |
6ecdcca3 | 836 | BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(status); |
d24d5663 | 837 | if (status != BT_FUNC_STATUS_OK) { |
8cc56726 SM |
838 | goto end; |
839 | } | |
1bf957a0 | 840 | } |
8cc56726 SM |
841 | |
842 | end: | |
843 | return status; | |
1bf957a0 PP |
844 | } |
845 | ||
f167d3c0 PP |
846 | BT_HIDDEN |
847 | void bt_graph_remove_connection(struct bt_graph *graph, | |
848 | struct bt_connection *connection) | |
849 | { | |
f6ccaed9 PP |
850 | BT_ASSERT(graph); |
851 | BT_ASSERT(connection); | |
3f7d4d90 | 852 | BT_LIB_LOGD("Removing graph's connection: %![graph-]+g, %![conn-]+x", |
262e5473 | 853 | graph, connection); |
f167d3c0 PP |
854 | g_ptr_array_remove(graph->connections, connection); |
855 | } | |
36712f1d | 856 | |
d94d92ac PP |
857 | static inline |
858 | bool component_name_exists(struct bt_graph *graph, const char *name) | |
859 | { | |
860 | bool exists = false; | |
861 | uint64_t i; | |
862 | ||
863 | for (i = 0; i < graph->components->len; i++) { | |
864 | struct bt_component *other_comp = graph->components->pdata[i]; | |
865 | ||
866 | if (strcmp(name, bt_component_get_name(other_comp)) == 0) { | |
d98421f2 | 867 | BT_ASSERT_COND_MSG("Another component with the same name already exists in the graph: " |
d94d92ac PP |
868 | "%![other-comp-]+c, name=\"%s\"", |
869 | other_comp, name); | |
870 | exists = true; | |
871 | goto end; | |
872 | } | |
873 | } | |
874 | ||
875 | end: | |
876 | return exists; | |
877 | } | |
878 | ||
879 | static | |
d24d5663 | 880 | int add_component_with_init_method_data( |
0d72b8c3 | 881 | struct bt_graph *graph, |
d94d92ac PP |
882 | struct bt_component_class *comp_cls, |
883 | comp_init_method_t init_method, | |
05e21286 | 884 | const char *name, const struct bt_value *params, |
e874da19 | 885 | void *init_method_data, bt_logging_level log_level, |
9628043c | 886 | const struct bt_component **user_component) |
36712f1d | 887 | { |
d24d5663 | 888 | int status = BT_FUNC_STATUS_OK; |
21a9f056 | 889 | enum bt_component_class_initialize_method_status init_status; |
36712f1d | 890 | struct bt_component *component = NULL; |
d94d92ac PP |
891 | int ret; |
892 | bool init_can_consume; | |
05e21286 | 893 | struct bt_value *new_params = NULL; |
36712f1d | 894 | |
d94d92ac PP |
895 | BT_ASSERT(comp_cls); |
896 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); | |
897 | BT_ASSERT_PRE_NON_NULL(name, "Name"); | |
5badd463 PP |
898 | BT_ASSERT_PRE( |
899 | graph->config_state == BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, | |
38cda5da | 900 | "Graph is not in the \"configuring\" state: %!+g", graph); |
d94d92ac PP |
901 | BT_ASSERT_PRE(!component_name_exists(graph, name), |
902 | "Duplicate component name: %!+g, name=\"%s\"", graph, name); | |
903 | BT_ASSERT_PRE(!params || bt_value_is_map(params), | |
904 | "Parameter value is not a map value: %!+v", params); | |
4aa7981f | 905 | init_can_consume = graph->can_consume; |
d94d92ac | 906 | bt_graph_set_can_consume(graph, false); |
3f7d4d90 | 907 | BT_LIB_LOGI("Adding component to graph: " |
e874da19 PP |
908 | "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, " |
909 | "%![params-]+v, init-method-data-addr=%p", | |
910 | graph, comp_cls, name, | |
911 | bt_common_logging_level_string(log_level), params, | |
912 | init_method_data); | |
36712f1d | 913 | |
d94d92ac | 914 | if (!params) { |
05e21286 PP |
915 | new_params = bt_value_map_create(); |
916 | if (!new_params) { | |
870631a2 PP |
917 | BT_LIB_LOGE_APPEND_CAUSE( |
918 | "Cannot create empty map value object."); | |
d24d5663 | 919 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
36712f1d PP |
920 | goto end; |
921 | } | |
05e21286 PP |
922 | |
923 | params = new_params; | |
36712f1d PP |
924 | } |
925 | ||
e874da19 | 926 | ret = bt_component_create(comp_cls, name, log_level, &component); |
d94d92ac | 927 | if (ret) { |
870631a2 PP |
928 | BT_LIB_LOGE_APPEND_CAUSE( |
929 | "Cannot create empty component object: ret=%d", | |
d94d92ac | 930 | ret); |
d24d5663 | 931 | status = BT_FUNC_STATUS_MEMORY_ERROR; |
36712f1d PP |
932 | goto end; |
933 | } | |
934 | ||
935 | /* | |
936 | * The user's initialization method needs to see that this | |
937 | * component is part of the graph. If the user method fails, we | |
938 | * immediately remove the component from the graph's components. | |
939 | */ | |
940 | g_ptr_array_add(graph->components, component); | |
941 | bt_component_set_graph(component, graph); | |
0d47d31b | 942 | bt_value_freeze(params); |
36712f1d | 943 | |
d94d92ac | 944 | if (init_method) { |
59225a3e SM |
945 | /* |
946 | * There is no use for config objects right now, so just pass | |
947 | * NULL. | |
948 | */ | |
36712f1d | 949 | BT_LOGD_STR("Calling user's initialization method."); |
59225a3e | 950 | init_status = init_method(component, NULL, params, init_method_data); |
36712f1d | 951 | BT_LOGD("User method returned: status=%s", |
d24d5663 | 952 | bt_common_func_status_string(init_status)); |
6ecdcca3 | 953 | BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(init_status); |
d24d5663 | 954 | if (init_status != BT_FUNC_STATUS_OK) { |
870631a2 PP |
955 | if (init_status < 0) { |
956 | BT_LIB_LOGW_APPEND_CAUSE( | |
957 | "Component initialization method failed: " | |
958 | "status=%s, %![comp-]+c", | |
959 | bt_common_func_status_string(init_status), | |
960 | component); | |
961 | } | |
962 | ||
d24d5663 | 963 | status = init_status; |
36712f1d PP |
964 | bt_component_set_graph(component, NULL); |
965 | g_ptr_array_remove_fast(graph->components, component); | |
966 | goto end; | |
967 | } | |
968 | } | |
969 | ||
970 | /* | |
971 | * Mark the component as initialized so that its finalization | |
972 | * method is called when it is destroyed. | |
973 | */ | |
974 | component->initialized = true; | |
975 | ||
976 | /* | |
977 | * If it's a sink component, it needs to be part of the graph's | |
648dab91 PP |
978 | * sink queue to be consumed by bt_graph_run() or |
979 | * bt_graph_run_once(). | |
36712f1d PP |
980 | */ |
981 | if (bt_component_is_sink(component)) { | |
d94d92ac | 982 | graph->has_sink = true; |
36712f1d PP |
983 | g_queue_push_tail(graph->sinks_to_consume, component); |
984 | } | |
985 | ||
986 | /* | |
987 | * Freeze the component class now that it's instantiated at | |
988 | * least once. | |
989 | */ | |
990 | BT_LOGD_STR("Freezing component class."); | |
d94d92ac | 991 | bt_component_class_freeze(comp_cls); |
3f7d4d90 | 992 | BT_LIB_LOGI("Added component to graph: " |
e874da19 PP |
993 | "%![graph-]+g, %![cc-]+C, name=\"%s\", log-level=%s, " |
994 | "%![params-]+v, init-method-data-addr=%p, %![comp-]+c", | |
995 | graph, comp_cls, name, | |
996 | bt_common_logging_level_string(log_level), params, | |
997 | init_method_data, component); | |
36712f1d PP |
998 | |
999 | if (user_component) { | |
1000 | /* Move reference to user */ | |
1001 | *user_component = component; | |
36712f1d PP |
1002 | } |
1003 | ||
1004 | end: | |
d24d5663 | 1005 | if (status != BT_FUNC_STATUS_OK) { |
8cc56726 | 1006 | bt_graph_make_faulty(graph); |
38cda5da PP |
1007 | } |
1008 | ||
65300d60 | 1009 | bt_object_put_ref(component); |
05e21286 | 1010 | bt_object_put_ref(new_params); |
d94d92ac PP |
1011 | (void) init_can_consume; |
1012 | bt_graph_set_can_consume(graph, init_can_consume); | |
d24d5663 | 1013 | return status; |
36712f1d PP |
1014 | } |
1015 | ||
d24d5663 | 1016 | enum bt_graph_add_component_status |
21a9f056 | 1017 | bt_graph_add_source_component_with_initialize_method_data( |
0d72b8c3 PP |
1018 | struct bt_graph *graph, |
1019 | const struct bt_component_class_source *comp_cls, | |
05e21286 | 1020 | const char *name, const struct bt_value *params, |
e874da19 | 1021 | void *init_method_data, bt_logging_level log_level, |
0d72b8c3 | 1022 | const struct bt_component_source **component) |
d94d92ac | 1023 | { |
17f3083a | 1024 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
1025 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
1026 | return add_component_with_init_method_data(graph, | |
1027 | (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, | |
e874da19 | 1028 | name, params, init_method_data, log_level, (void *) component); |
d94d92ac PP |
1029 | } |
1030 | ||
d24d5663 | 1031 | enum bt_graph_add_component_status bt_graph_add_source_component( |
0d72b8c3 PP |
1032 | struct bt_graph *graph, |
1033 | const struct bt_component_class_source *comp_cls, | |
05e21286 | 1034 | const char *name, const struct bt_value *params, |
9628043c | 1035 | enum bt_logging_level log_level, |
0d72b8c3 | 1036 | const struct bt_component_source **component) |
d94d92ac | 1037 | { |
17f3083a | 1038 | BT_ASSERT_PRE_NO_ERROR(); |
21a9f056 | 1039 | return bt_graph_add_source_component_with_initialize_method_data( |
e874da19 | 1040 | graph, comp_cls, name, params, NULL, log_level, component); |
d94d92ac PP |
1041 | } |
1042 | ||
d24d5663 | 1043 | enum bt_graph_add_component_status |
21a9f056 | 1044 | bt_graph_add_filter_component_with_initialize_method_data( |
0d72b8c3 PP |
1045 | struct bt_graph *graph, |
1046 | const struct bt_component_class_filter *comp_cls, | |
05e21286 | 1047 | const char *name, const struct bt_value *params, |
9628043c | 1048 | void *init_method_data, enum bt_logging_level log_level, |
0d72b8c3 | 1049 | const struct bt_component_filter **component) |
d94d92ac | 1050 | { |
17f3083a | 1051 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
1052 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
1053 | return add_component_with_init_method_data(graph, | |
1054 | (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, | |
e874da19 | 1055 | name, params, init_method_data, log_level, (void *) component); |
d94d92ac PP |
1056 | } |
1057 | ||
d24d5663 | 1058 | enum bt_graph_add_component_status bt_graph_add_filter_component( |
0d72b8c3 PP |
1059 | struct bt_graph *graph, |
1060 | const struct bt_component_class_filter *comp_cls, | |
05e21286 | 1061 | const char *name, const struct bt_value *params, |
9628043c | 1062 | enum bt_logging_level log_level, |
0d72b8c3 | 1063 | const struct bt_component_filter **component) |
d94d92ac | 1064 | { |
17f3083a | 1065 | BT_ASSERT_PRE_NO_ERROR(); |
21a9f056 | 1066 | return bt_graph_add_filter_component_with_initialize_method_data( |
e874da19 | 1067 | graph, comp_cls, name, params, NULL, log_level, component); |
d94d92ac PP |
1068 | } |
1069 | ||
d24d5663 | 1070 | enum bt_graph_add_component_status |
21a9f056 | 1071 | bt_graph_add_sink_component_with_initialize_method_data( |
0d72b8c3 PP |
1072 | struct bt_graph *graph, |
1073 | const struct bt_component_class_sink *comp_cls, | |
05e21286 | 1074 | const char *name, const struct bt_value *params, |
9628043c | 1075 | void *init_method_data, enum bt_logging_level log_level, |
0d72b8c3 | 1076 | const struct bt_component_sink **component) |
36712f1d | 1077 | { |
17f3083a | 1078 | BT_ASSERT_PRE_NO_ERROR(); |
d94d92ac PP |
1079 | BT_ASSERT_PRE_NON_NULL(comp_cls, "Component class"); |
1080 | return add_component_with_init_method_data(graph, | |
1081 | (void *) comp_cls, (comp_init_method_t) comp_cls->methods.init, | |
e874da19 | 1082 | name, params, init_method_data, log_level, (void *) component); |
d94d92ac PP |
1083 | } |
1084 | ||
d24d5663 | 1085 | enum bt_graph_add_component_status bt_graph_add_sink_component( |
0d72b8c3 PP |
1086 | struct bt_graph *graph, |
1087 | const struct bt_component_class_sink *comp_cls, | |
05e21286 | 1088 | const char *name, const struct bt_value *params, |
9628043c | 1089 | enum bt_logging_level log_level, |
0d72b8c3 | 1090 | const struct bt_component_sink **component) |
d94d92ac | 1091 | { |
17f3083a | 1092 | BT_ASSERT_PRE_NO_ERROR(); |
21a9f056 | 1093 | return bt_graph_add_sink_component_with_initialize_method_data( |
e874da19 | 1094 | graph, comp_cls, name, params, NULL, log_level, component); |
36712f1d | 1095 | } |
8ed535b5 | 1096 | |
078033ed PP |
1097 | enum bt_graph_add_component_status |
1098 | bt_graph_add_simple_sink_component(struct bt_graph *graph, const char *name, | |
21a9f056 | 1099 | bt_graph_simple_sink_component_initialize_func init_func, |
078033ed PP |
1100 | bt_graph_simple_sink_component_consume_func consume_func, |
1101 | bt_graph_simple_sink_component_finalize_func finalize_func, | |
1102 | void *user_data, const bt_component_sink **component) | |
1103 | { | |
1104 | enum bt_graph_add_component_status status; | |
1105 | struct bt_component_class_sink *comp_cls; | |
1106 | struct simple_sink_init_method_data init_method_data = { | |
1107 | .init_func = init_func, | |
1108 | .consume_func = consume_func, | |
1109 | .finalize_func = finalize_func, | |
1110 | .user_data = user_data, | |
1111 | }; | |
1112 | ||
17f3083a SM |
1113 | BT_ASSERT_PRE_NO_ERROR(); |
1114 | ||
078033ed PP |
1115 | /* |
1116 | * Other preconditions are checked by | |
1117 | * bt_graph_add_sink_component_with_init_method_data(). | |
1118 | */ | |
1119 | BT_ASSERT_PRE_NON_NULL(consume_func, "Consume function"); | |
1120 | ||
1121 | comp_cls = bt_component_class_sink_simple_borrow(); | |
1122 | if (!comp_cls) { | |
1123 | BT_LIB_LOGE_APPEND_CAUSE( | |
1124 | "Cannot borrow simple sink component class."); | |
1125 | status = BT_FUNC_STATUS_MEMORY_ERROR; | |
1126 | goto end; | |
1127 | } | |
1128 | ||
21a9f056 | 1129 | status = bt_graph_add_sink_component_with_initialize_method_data(graph, |
078033ed PP |
1130 | comp_cls, name, NULL, &init_method_data, |
1131 | BT_LOGGING_LEVEL_NONE, component); | |
1132 | ||
1133 | end: | |
1134 | return status; | |
1135 | } | |
1136 | ||
5c563278 | 1137 | BT_HIDDEN |
d6e69534 PP |
1138 | void bt_graph_add_message(struct bt_graph *graph, |
1139 | struct bt_message *msg) | |
5c563278 PP |
1140 | { |
1141 | BT_ASSERT(graph); | |
d6e69534 | 1142 | BT_ASSERT(msg); |
5c563278 PP |
1143 | |
1144 | /* | |
1145 | * It's okay not to take a reference because, when a | |
d6e69534 | 1146 | * message's reference count drops to 0, either: |
5c563278 PP |
1147 | * |
1148 | * * It is recycled back to one of this graph's pool. | |
1149 | * * It is destroyed because it doesn't have any link to any | |
1150 | * graph, which means the original graph is already destroyed. | |
1151 | */ | |
d6e69534 | 1152 | g_ptr_array_add(graph->messages, msg); |
5c563278 | 1153 | } |
c5b9b441 | 1154 | |
9b4f9b42 PP |
1155 | BT_HIDDEN |
1156 | bool bt_graph_is_interrupted(const struct bt_graph *graph) | |
1157 | { | |
98b15851 | 1158 | BT_ASSERT_DBG(graph); |
9b4f9b42 PP |
1159 | return bt_interrupter_array_any_is_set(graph->interrupters); |
1160 | } | |
1161 | ||
1162 | enum bt_graph_add_interrupter_status bt_graph_add_interrupter( | |
1163 | struct bt_graph *graph, const struct bt_interrupter *intr) | |
1164 | { | |
17f3083a | 1165 | BT_ASSERT_PRE_NO_ERROR(); |
9b4f9b42 PP |
1166 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
1167 | BT_ASSERT_PRE_NON_NULL(intr, "Interrupter"); | |
1168 | g_ptr_array_add(graph->interrupters, (void *) intr); | |
6871026b | 1169 | bt_object_get_ref_no_null_check(intr); |
9b4f9b42 PP |
1170 | BT_LIB_LOGD("Added interrupter to graph: %![graph-]+g, %![intr-]+z", |
1171 | graph, intr); | |
1172 | return BT_FUNC_STATUS_OK; | |
1173 | } | |
1174 | ||
c513d240 | 1175 | struct bt_interrupter *bt_graph_borrow_default_interrupter(bt_graph *graph) |
9b4f9b42 PP |
1176 | { |
1177 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); | |
c513d240 | 1178 | return graph->default_interrupter; |
9b4f9b42 PP |
1179 | } |
1180 | ||
c5b9b441 PP |
1181 | void bt_graph_get_ref(const struct bt_graph *graph) |
1182 | { | |
1183 | bt_object_get_ref(graph); | |
1184 | } | |
1185 | ||
1186 | void bt_graph_put_ref(const struct bt_graph *graph) | |
1187 | { | |
1188 | bt_object_put_ref(graph); | |
1189 | } |