Commit | Line | Data |
---|---|---|
47e5a032 | 1 | /* |
f2b0325d | 2 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
47e5a032 | 3 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
47e5a032 JG |
4 | * |
5 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
6 | * of this software and associated documentation files (the "Software"), to deal | |
7 | * in the Software without restriction, including without limitation the rights | |
8 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
9 | * copies of the Software, and to permit persons to whom the Software is | |
10 | * furnished to do so, subject to the following conditions: | |
11 | * | |
12 | * The above copyright notice and this permission notice shall be included in | |
13 | * all copies or substantial portions of the Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
18 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
20 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
21 | * SOFTWARE. | |
22 | */ | |
23 | ||
b09a5592 | 24 | #define BT_LOG_TAG "MSG-ITER" |
5af447e5 PP |
25 | #include <babeltrace/lib-logging-internal.h> |
26 | ||
3d9990ac | 27 | #include <babeltrace/compiler-internal.h> |
0f15f666 | 28 | #include <babeltrace/trace-ir/field.h> |
78cf9df6 | 29 | #include <babeltrace/trace-ir/event-const.h> |
108b91d0 | 30 | #include <babeltrace/trace-ir/event-internal.h> |
78cf9df6 | 31 | #include <babeltrace/trace-ir/packet-const.h> |
108b91d0 PP |
32 | #include <babeltrace/trace-ir/packet-internal.h> |
33 | #include <babeltrace/trace-ir/stream-internal.h> | |
7b53201c | 34 | #include <babeltrace/graph/connection-const.h> |
bd14d768 | 35 | #include <babeltrace/graph/connection-internal.h> |
7b53201c | 36 | #include <babeltrace/graph/component-const.h> |
9e550e5f | 37 | #include <babeltrace/graph/component-internal.h> |
b2e0c907 PP |
38 | #include <babeltrace/graph/component-source-internal.h> |
39 | #include <babeltrace/graph/component-class-internal.h> | |
c3ac0193 | 40 | #include <babeltrace/graph/component-class-sink-colander-internal.h> |
7b53201c | 41 | #include <babeltrace/graph/component-sink-const.h> |
b09a5592 PP |
42 | #include <babeltrace/graph/message-const.h> |
43 | #include <babeltrace/graph/message-iterator.h> | |
44 | #include <babeltrace/graph/message-iterator-internal.h> | |
45 | #include <babeltrace/graph/self-component-port-input-message-iterator.h> | |
46 | #include <babeltrace/graph/port-output-message-iterator.h> | |
47 | #include <babeltrace/graph/message-internal.h> | |
48 | #include <babeltrace/graph/message-event-const.h> | |
49 | #include <babeltrace/graph/message-event-internal.h> | |
50 | #include <babeltrace/graph/message-packet-const.h> | |
51 | #include <babeltrace/graph/message-packet-internal.h> | |
52 | #include <babeltrace/graph/message-stream-const.h> | |
53 | #include <babeltrace/graph/message-stream-internal.h> | |
7b53201c PP |
54 | #include <babeltrace/graph/port-const.h> |
55 | #include <babeltrace/graph/graph.h> | |
56 | #include <babeltrace/graph/graph-const.h> | |
c3ac0193 | 57 | #include <babeltrace/graph/graph-internal.h> |
c55a9f58 | 58 | #include <babeltrace/types.h> |
8b45963b | 59 | #include <babeltrace/assert-internal.h> |
6ff151ad | 60 | #include <babeltrace/assert-pre-internal.h> |
fa054faf | 61 | #include <stdint.h> |
b04a393b | 62 | #include <inttypes.h> |
0fbb9a9f | 63 | #include <stdlib.h> |
3230ee6b | 64 | |
3fd7b79d PP |
65 | /* |
66 | * TODO: Use graph's state (number of active iterators, etc.) and | |
67 | * possibly system specifications to make a better guess than this. | |
68 | */ | |
b09a5592 | 69 | #define MSG_BATCH_SIZE 15 |
3fd7b79d | 70 | |
3230ee6b | 71 | struct stream_state { |
78cf9df6 PP |
72 | const struct bt_stream *stream; /* owned by this */ |
73 | const struct bt_packet *cur_packet; /* owned by this */ | |
b09a5592 | 74 | uint64_t expected_msg_seq_num; |
c55a9f58 | 75 | bt_bool is_ended; |
3230ee6b PP |
76 | }; |
77 | ||
22e3b27d | 78 | BT_ASSERT_PRE_FUNC |
3230ee6b PP |
79 | static |
80 | void destroy_stream_state(struct stream_state *stream_state) | |
81 | { | |
82 | if (!stream_state) { | |
83 | return; | |
84 | } | |
85 | ||
5af447e5 PP |
86 | BT_LOGV("Destroying stream state: stream-state-addr=%p", stream_state); |
87 | BT_LOGV_STR("Putting stream state's current packet."); | |
834e9996 | 88 | BT_OBJECT_PUT_REF_AND_RESET(stream_state->cur_packet); |
5af447e5 | 89 | BT_LOGV_STR("Putting stream state's stream."); |
834e9996 | 90 | BT_OBJECT_PUT_REF_AND_RESET(stream_state->stream); |
3230ee6b PP |
91 | g_free(stream_state); |
92 | } | |
93 | ||
22e3b27d | 94 | BT_ASSERT_PRE_FUNC |
3230ee6b | 95 | static |
78cf9df6 | 96 | struct stream_state *create_stream_state(const struct bt_stream *stream) |
3230ee6b PP |
97 | { |
98 | struct stream_state *stream_state = g_new0(struct stream_state, 1); | |
99 | ||
100 | if (!stream_state) { | |
5af447e5 | 101 | BT_LOGE_STR("Failed to allocate one stream state."); |
3230ee6b PP |
102 | goto end; |
103 | } | |
104 | ||
105 | /* | |
6ff151ad | 106 | * We keep a reference to the stream until we know it's ended. |
3230ee6b | 107 | */ |
4b70020d PP |
108 | stream_state->stream = stream; |
109 | bt_object_get_no_null_check(stream_state->stream); | |
834e9996 | 110 | BT_LIB_LOGV("Created stream state: %![stream-]+s, " |
5af447e5 | 111 | "stream-state-addr=%p", |
834e9996 | 112 | stream, stream_state); |
3230ee6b PP |
113 | |
114 | end: | |
115 | return stream_state; | |
116 | } | |
47e5a032 | 117 | |
c3ac0193 | 118 | static |
b09a5592 | 119 | void destroy_base_message_iterator(struct bt_object *obj) |
c3ac0193 | 120 | { |
b09a5592 | 121 | struct bt_message_iterator *iterator = (void *) obj; |
3fd7b79d PP |
122 | |
123 | BT_ASSERT(iterator); | |
124 | ||
b09a5592 PP |
125 | if (iterator->msgs) { |
126 | g_ptr_array_free(iterator->msgs, TRUE); | |
127 | iterator->msgs = NULL; | |
3fd7b79d PP |
128 | } |
129 | ||
130 | g_free(iterator); | |
c3ac0193 PP |
131 | } |
132 | ||
47e5a032 | 133 | static |
b09a5592 | 134 | void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj) |
47e5a032 | 135 | { |
b09a5592 | 136 | struct bt_self_component_port_input_message_iterator *iterator; |
8738a040 | 137 | |
8b45963b | 138 | BT_ASSERT(obj); |
d3eb6e8f | 139 | |
bd14d768 | 140 | /* |
b09a5592 | 141 | * The message iterator's reference count is 0 if we're |
bd14d768 PP |
142 | * here. Increment it to avoid a double-destroy (possibly |
143 | * infinitely recursive). This could happen for example if the | |
b09a5592 | 144 | * message iterator's finalization function does |
834e9996 PP |
145 | * bt_object_get_ref() (or anything that causes |
146 | * bt_object_get_ref() to be called) on itself (ref. count goes | |
147 | * from 0 to 1), and then bt_object_put_ref(): the reference | |
148 | * count would go from 1 to 0 again and this function would be | |
149 | * called again. | |
bd14d768 | 150 | */ |
1d7bf349 | 151 | obj->ref_count++; |
94a96686 | 152 | iterator = (void *) obj; |
b09a5592 | 153 | BT_LIB_LOGD("Destroying self component input port message iterator object: " |
834e9996 | 154 | "%!+i", iterator); |
b09a5592 | 155 | bt_self_component_port_input_message_iterator_finalize(iterator); |
d3eb6e8f | 156 | |
3230ee6b PP |
157 | if (iterator->stream_states) { |
158 | /* | |
159 | * Remove our destroy listener from each stream which | |
160 | * has a state in this iterator. Otherwise the destroy | |
161 | * listener would be called with an invalid/other | |
b09a5592 | 162 | * message iterator object. |
3230ee6b | 163 | */ |
3230ee6b | 164 | g_hash_table_destroy(iterator->stream_states); |
834e9996 | 165 | iterator->stream_states = NULL; |
3230ee6b PP |
166 | } |
167 | ||
bd14d768 PP |
168 | if (iterator->connection) { |
169 | /* | |
170 | * Remove ourself from the originating connection so | |
171 | * that it does not try to finalize a dangling pointer | |
172 | * later. | |
173 | */ | |
174 | bt_connection_remove_iterator(iterator->connection, iterator); | |
834e9996 | 175 | iterator->connection = NULL; |
bd14d768 PP |
176 | } |
177 | ||
b09a5592 | 178 | destroy_base_message_iterator(obj); |
47e5a032 JG |
179 | } |
180 | ||
bd14d768 | 181 | BT_HIDDEN |
b09a5592 PP |
182 | void bt_self_component_port_input_message_iterator_finalize( |
183 | struct bt_self_component_port_input_message_iterator *iterator) | |
bd14d768 | 184 | { |
834e9996 PP |
185 | typedef void (*method_t)(void *); |
186 | ||
bd14d768 | 187 | struct bt_component_class *comp_class = NULL; |
834e9996 | 188 | method_t method = NULL; |
bd14d768 | 189 | |
8b45963b | 190 | BT_ASSERT(iterator); |
bd14d768 PP |
191 | |
192 | switch (iterator->state) { | |
b09a5592 | 193 | case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED: |
dba1e5d8 | 194 | /* Skip user finalization if user initialization failed */ |
b09a5592 | 195 | BT_LIB_LOGD("Not finalizing non-initialized message iterator: " |
834e9996 | 196 | "%!+i", iterator); |
dba1e5d8 | 197 | return; |
b09a5592 PP |
198 | case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED: |
199 | case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED: | |
bd14d768 | 200 | /* Already finalized */ |
b09a5592 | 201 | BT_LIB_LOGD("Not finalizing message iterator: already finalized: " |
834e9996 | 202 | "%!+i", iterator); |
bd14d768 PP |
203 | return; |
204 | default: | |
205 | break; | |
206 | } | |
207 | ||
b09a5592 | 208 | BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator); |
5af447e5 | 209 | |
b09a5592 PP |
210 | if (iterator->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED) { |
211 | BT_LIB_LOGD("Updating message iterator's state: " | |
212 | "new-state=BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED"); | |
213 | iterator->state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED; | |
df14f8af | 214 | } else { |
b09a5592 PP |
215 | BT_LIB_LOGD("Updating message iterator's state: " |
216 | "new-state=BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED"); | |
217 | iterator->state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED; | |
df14f8af MD |
218 | } |
219 | ||
8b45963b | 220 | BT_ASSERT(iterator->upstream_component); |
bd14d768 PP |
221 | comp_class = iterator->upstream_component->class; |
222 | ||
223 | /* Call user-defined destroy method */ | |
224 | switch (comp_class->type) { | |
225 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
226 | { | |
834e9996 PP |
227 | struct bt_component_class_source *src_comp_cls = |
228 | (void *) comp_class; | |
bd14d768 | 229 | |
b09a5592 | 230 | method = (method_t) src_comp_cls->methods.msg_iter_finalize; |
bd14d768 PP |
231 | break; |
232 | } | |
233 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
234 | { | |
834e9996 PP |
235 | struct bt_component_class_filter *flt_comp_cls = |
236 | (void *) comp_class; | |
bd14d768 | 237 | |
b09a5592 | 238 | method = (method_t) flt_comp_cls->methods.msg_iter_finalize; |
bd14d768 PP |
239 | break; |
240 | } | |
241 | default: | |
242 | /* Unreachable */ | |
0fbb9a9f | 243 | abort(); |
bd14d768 PP |
244 | } |
245 | ||
834e9996 PP |
246 | if (method) { |
247 | BT_LIB_LOGD("Calling user's finalization method: %!+i", | |
5af447e5 | 248 | iterator); |
834e9996 | 249 | method(iterator); |
bd14d768 PP |
250 | } |
251 | ||
bd14d768 PP |
252 | iterator->upstream_component = NULL; |
253 | iterator->upstream_port = NULL; | |
b09a5592 | 254 | BT_LIB_LOGD("Finalized message iterator: %!+i", iterator); |
bd14d768 PP |
255 | } |
256 | ||
257 | BT_HIDDEN | |
b09a5592 PP |
258 | void bt_self_component_port_input_message_iterator_set_connection( |
259 | struct bt_self_component_port_input_message_iterator *iterator, | |
bd14d768 PP |
260 | struct bt_connection *connection) |
261 | { | |
8b45963b | 262 | BT_ASSERT(iterator); |
bd14d768 | 263 | iterator->connection = connection; |
b09a5592 | 264 | BT_LIB_LOGV("Set message iterator's connection: " |
834e9996 | 265 | "%![iter-]+i, %![conn-]+x", iterator, connection); |
bd14d768 PP |
266 | } |
267 | ||
fe7265b5 | 268 | static |
b09a5592 PP |
269 | int init_message_iterator(struct bt_message_iterator *iterator, |
270 | enum bt_message_iterator_type type, | |
fe7265b5 PP |
271 | bt_object_release_func destroy) |
272 | { | |
3fd7b79d PP |
273 | int ret = 0; |
274 | ||
1d7bf349 | 275 | bt_object_init_shared(&iterator->base, destroy); |
fe7265b5 | 276 | iterator->type = type; |
b09a5592 PP |
277 | iterator->msgs = g_ptr_array_new(); |
278 | if (!iterator->msgs) { | |
3fd7b79d PP |
279 | BT_LOGE_STR("Failed to allocate a GPtrArray."); |
280 | ret = -1; | |
281 | goto end; | |
282 | } | |
283 | ||
b09a5592 | 284 | g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE); |
3fd7b79d PP |
285 | |
286 | end: | |
287 | return ret; | |
fe7265b5 PP |
288 | } |
289 | ||
834e9996 | 290 | static |
b09a5592 PP |
291 | struct bt_self_component_port_input_message_iterator * |
292 | bt_self_component_port_input_message_iterator_create_initial( | |
3230ee6b | 293 | struct bt_component *upstream_comp, |
834e9996 | 294 | struct bt_port *upstream_port) |
47e5a032 | 295 | { |
3fd7b79d | 296 | int ret; |
b09a5592 | 297 | struct bt_self_component_port_input_message_iterator *iterator = NULL; |
47e5a032 | 298 | |
8b45963b PP |
299 | BT_ASSERT(upstream_comp); |
300 | BT_ASSERT(upstream_port); | |
8b45963b | 301 | BT_ASSERT(bt_port_is_connected(upstream_port)); |
b09a5592 | 302 | BT_LIB_LOGD("Creating initial message iterator on self component input port: " |
834e9996 PP |
303 | "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port); |
304 | BT_ASSERT(bt_component_get_class_type(upstream_comp) == | |
305 | BT_COMPONENT_CLASS_TYPE_SOURCE || | |
306 | bt_component_get_class_type(upstream_comp) == | |
307 | BT_COMPONENT_CLASS_TYPE_FILTER); | |
308 | iterator = g_new0( | |
b09a5592 | 309 | struct bt_self_component_port_input_message_iterator, 1); |
47e5a032 | 310 | if (!iterator) { |
834e9996 | 311 | BT_LOGE_STR("Failed to allocate one self component input port " |
b09a5592 | 312 | "message iterator."); |
73d5c1ad | 313 | goto end; |
47e5a032 JG |
314 | } |
315 | ||
b09a5592 PP |
316 | ret = init_message_iterator((void *) iterator, |
317 | BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT, | |
318 | bt_self_component_port_input_message_iterator_destroy); | |
3fd7b79d | 319 | if (ret) { |
b09a5592 | 320 | /* init_message_iterator() logs errors */ |
834e9996 | 321 | BT_OBJECT_PUT_REF_AND_RESET(iterator); |
3fd7b79d PP |
322 | goto end; |
323 | } | |
3230ee6b PP |
324 | |
325 | iterator->stream_states = g_hash_table_new_full(g_direct_hash, | |
326 | g_direct_equal, NULL, (GDestroyNotify) destroy_stream_state); | |
327 | if (!iterator->stream_states) { | |
5af447e5 | 328 | BT_LOGE_STR("Failed to allocate a GHashTable."); |
834e9996 | 329 | BT_OBJECT_PUT_REF_AND_RESET(iterator); |
73d5c1ad | 330 | goto end; |
3230ee6b PP |
331 | } |
332 | ||
bd14d768 PP |
333 | iterator->upstream_component = upstream_comp; |
334 | iterator->upstream_port = upstream_port; | |
834e9996 | 335 | iterator->connection = iterator->upstream_port->connection; |
f7c3ac09 | 336 | iterator->graph = bt_component_borrow_graph(upstream_comp); |
b09a5592 PP |
337 | iterator->state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED; |
338 | BT_LIB_LOGD("Created initial message iterator on self component input port: " | |
834e9996 PP |
339 | "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i", |
340 | upstream_port, upstream_comp, iterator); | |
3230ee6b | 341 | |
47e5a032 | 342 | end: |
834e9996 | 343 | return iterator; |
47e5a032 JG |
344 | } |
345 | ||
b09a5592 PP |
346 | struct bt_self_component_port_input_message_iterator * |
347 | bt_self_component_port_input_message_iterator_create( | |
834e9996 | 348 | struct bt_self_component_port_input *self_port) |
ea8d3e58 | 349 | { |
b09a5592 | 350 | typedef enum bt_self_message_iterator_status (*init_method_t)( |
834e9996 PP |
351 | void *, void *, void *); |
352 | ||
353 | init_method_t init_method = NULL; | |
b09a5592 | 354 | struct bt_self_component_port_input_message_iterator *iterator = |
834e9996 PP |
355 | NULL; |
356 | struct bt_port *port = (void *) self_port; | |
357 | struct bt_port *upstream_port; | |
358 | struct bt_component *comp; | |
359 | struct bt_component *upstream_comp; | |
360 | struct bt_component_class *upstream_comp_cls; | |
361 | ||
362 | BT_ASSERT_PRE_NON_NULL(port, "Port"); | |
7b53201c | 363 | comp = bt_port_borrow_component_inline(port); |
834e9996 PP |
364 | BT_ASSERT_PRE(bt_port_is_connected(port), |
365 | "Port is not connected: %![port-]+p", port); | |
366 | BT_ASSERT_PRE(comp, "Port is not part of a component: %![port-]+p", | |
367 | port); | |
368 | BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp), | |
369 | "Port's component's graph is canceled: " | |
370 | "%![port-]+p, %![comp-]+c", port, comp); | |
371 | BT_ASSERT(port->connection); | |
372 | upstream_port = port->connection->upstream_port; | |
373 | BT_ASSERT(upstream_port); | |
7b53201c | 374 | upstream_comp = bt_port_borrow_component_inline(upstream_port); |
834e9996 PP |
375 | BT_ASSERT(upstream_comp); |
376 | upstream_comp_cls = upstream_comp->class; | |
377 | BT_ASSERT(upstream_comp->class->type == | |
378 | BT_COMPONENT_CLASS_TYPE_SOURCE || | |
379 | upstream_comp->class->type == | |
380 | BT_COMPONENT_CLASS_TYPE_FILTER); | |
b09a5592 | 381 | iterator = bt_self_component_port_input_message_iterator_create_initial( |
834e9996 PP |
382 | upstream_comp, upstream_port); |
383 | if (!iterator) { | |
384 | BT_LOGW_STR("Cannot create self component input port " | |
b09a5592 | 385 | "message iterator."); |
834e9996 PP |
386 | goto end; |
387 | } | |
890882ef | 388 | |
834e9996 PP |
389 | switch (upstream_comp_cls->type) { |
390 | case BT_COMPONENT_CLASS_TYPE_SOURCE: | |
391 | { | |
392 | struct bt_component_class_source *src_comp_cls = | |
393 | (void *) upstream_comp_cls; | |
394 | ||
395 | init_method = | |
b09a5592 | 396 | (init_method_t) src_comp_cls->methods.msg_iter_init; |
834e9996 PP |
397 | break; |
398 | } | |
399 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
400 | { | |
401 | struct bt_component_class_filter *flt_comp_cls = | |
402 | (void *) upstream_comp_cls; | |
403 | ||
404 | init_method = | |
b09a5592 | 405 | (init_method_t) flt_comp_cls->methods.msg_iter_init; |
834e9996 PP |
406 | break; |
407 | } | |
408 | default: | |
409 | /* Unreachable */ | |
410 | abort(); | |
411 | } | |
412 | ||
413 | if (init_method) { | |
414 | int iter_status; | |
415 | ||
416 | BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator); | |
417 | iter_status = init_method(iterator, upstream_comp, | |
418 | upstream_port); | |
419 | BT_LOGD("User method returned: status=%s", | |
b09a5592 PP |
420 | bt_message_iterator_status_string(iter_status)); |
421 | if (iter_status != BT_MESSAGE_ITERATOR_STATUS_OK) { | |
834e9996 PP |
422 | BT_LOGW_STR("Initialization method failed."); |
423 | goto end; | |
424 | } | |
425 | } | |
426 | ||
b09a5592 | 427 | iterator->state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE; |
834e9996 | 428 | g_ptr_array_add(port->connection->iterators, iterator); |
b09a5592 | 429 | BT_LIB_LOGD("Created message iterator on self component input port: " |
834e9996 PP |
430 | "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i", |
431 | upstream_port, upstream_comp, iterator); | |
432 | ||
433 | end: | |
434 | return iterator; | |
ea8d3e58 JG |
435 | } |
436 | ||
b09a5592 PP |
437 | void *bt_self_message_iterator_get_data( |
438 | const struct bt_self_message_iterator *self_iterator) | |
ea8d3e58 | 439 | { |
b09a5592 | 440 | struct bt_self_component_port_input_message_iterator *iterator = |
834e9996 | 441 | (void *) self_iterator; |
ea8d3e58 | 442 | |
b09a5592 | 443 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
834e9996 | 444 | return iterator->user_data; |
8738a040 | 445 | } |
413bc2c4 | 446 | |
b09a5592 PP |
447 | void bt_self_message_iterator_set_data( |
448 | struct bt_self_message_iterator *self_iterator, void *data) | |
f7c3ac09 | 449 | { |
b09a5592 | 450 | struct bt_self_component_port_input_message_iterator *iterator = |
834e9996 | 451 | (void *) self_iterator; |
f7c3ac09 | 452 | |
b09a5592 | 453 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
834e9996 | 454 | iterator->user_data = data; |
b09a5592 | 455 | BT_LIB_LOGV("Set message iterator's user data: " |
834e9996 | 456 | "%!+i, user-data-addr=%p", iterator, data); |
f7c3ac09 PP |
457 | } |
458 | ||
6ff151ad PP |
459 | BT_ASSERT_PRE_FUNC |
460 | static inline | |
b09a5592 | 461 | void bt_message_borrow_packet_stream(const struct bt_message *msg, |
78cf9df6 PP |
462 | const struct bt_stream **stream, |
463 | const struct bt_packet **packet) | |
fa054faf | 464 | { |
b09a5592 | 465 | BT_ASSERT(msg); |
fa054faf | 466 | |
b09a5592 PP |
467 | switch (msg->type) { |
468 | case BT_MESSAGE_TYPE_EVENT: | |
78cf9df6 | 469 | *packet = bt_event_borrow_packet_const( |
b09a5592 | 470 | bt_message_event_borrow_event_const(msg)); |
78cf9df6 | 471 | *stream = bt_packet_borrow_stream_const(*packet); |
fa054faf | 472 | break; |
b09a5592 PP |
473 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: |
474 | *stream = bt_message_stream_beginning_borrow_stream_const(msg); | |
fa054faf | 475 | break; |
b09a5592 PP |
476 | case BT_MESSAGE_TYPE_STREAM_END: |
477 | *stream = bt_message_stream_end_borrow_stream_const(msg); | |
fa054faf | 478 | break; |
b09a5592 PP |
479 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: |
480 | *packet = bt_message_packet_beginning_borrow_packet_const(msg); | |
78cf9df6 | 481 | *stream = bt_packet_borrow_stream_const(*packet); |
fa054faf | 482 | break; |
b09a5592 PP |
483 | case BT_MESSAGE_TYPE_PACKET_END: |
484 | *packet = bt_message_packet_end_borrow_packet_const(msg); | |
78cf9df6 | 485 | *stream = bt_packet_borrow_stream_const(*packet); |
b04a393b | 486 | break; |
fa054faf | 487 | default: |
6ff151ad | 488 | break; |
fa054faf | 489 | } |
fa054faf PP |
490 | } |
491 | ||
6ff151ad PP |
492 | BT_ASSERT_PRE_FUNC |
493 | static inline | |
b09a5592 PP |
494 | bool validate_message( |
495 | struct bt_self_component_port_input_message_iterator *iterator, | |
496 | const struct bt_message *c_msg) | |
3230ee6b | 497 | { |
6ff151ad | 498 | bool is_valid = true; |
3230ee6b | 499 | struct stream_state *stream_state; |
78cf9df6 PP |
500 | const struct bt_stream *stream = NULL; |
501 | const struct bt_packet *packet = NULL; | |
b09a5592 | 502 | struct bt_message *msg = (void *) c_msg; |
6ff151ad | 503 | |
b09a5592 PP |
504 | BT_ASSERT(msg); |
505 | bt_message_borrow_packet_stream(c_msg, &stream, &packet); | |
6ff151ad PP |
506 | |
507 | if (!stream) { | |
b09a5592 | 508 | /* we don't care about messages not attached to streams */ |
6ff151ad PP |
509 | goto end; |
510 | } | |
3230ee6b | 511 | |
6ff151ad PP |
512 | stream_state = g_hash_table_lookup(iterator->stream_states, stream); |
513 | if (!stream_state) { | |
3230ee6b | 514 | /* |
b09a5592 PP |
515 | * No stream state for this stream: this message |
516 | * MUST be a BT_MESSAGE_TYPE_STREAM_BEGINNING message | |
6ff151ad | 517 | * and its sequence number must be 0. |
3230ee6b | 518 | */ |
b09a5592 PP |
519 | if (c_msg->type != BT_MESSAGE_TYPE_STREAM_BEGINNING) { |
520 | BT_ASSERT_PRE_MSG("Unexpected message: missing a " | |
521 | "BT_MESSAGE_TYPE_STREAM_BEGINNING " | |
522 | "message prior to this message: " | |
6ff151ad PP |
523 | "%![stream-]+s", stream); |
524 | is_valid = false; | |
3230ee6b PP |
525 | goto end; |
526 | } | |
527 | ||
b09a5592 PP |
528 | if (c_msg->seq_num == -1ULL) { |
529 | msg->seq_num = 0; | |
3230ee6b PP |
530 | } |
531 | ||
b09a5592 PP |
532 | if (c_msg->seq_num != 0) { |
533 | BT_ASSERT_PRE_MSG("Unexpected message sequence " | |
534 | "number for this message iterator: " | |
535 | "this is the first message for this " | |
6ff151ad PP |
536 | "stream, expecting sequence number 0: " |
537 | "seq-num=%" PRIu64 ", %![stream-]+s", | |
b09a5592 | 538 | c_msg->seq_num, stream); |
6ff151ad | 539 | is_valid = false; |
3230ee6b | 540 | goto end; |
3230ee6b | 541 | } |
3230ee6b | 542 | |
6ff151ad PP |
543 | stream_state = create_stream_state(stream); |
544 | if (!stream_state) { | |
545 | abort(); | |
546 | } | |
fa054faf | 547 | |
78cf9df6 PP |
548 | g_hash_table_insert(iterator->stream_states, |
549 | (void *) stream, stream_state); | |
b09a5592 | 550 | stream_state->expected_msg_seq_num++; |
6ff151ad | 551 | goto end; |
fa054faf PP |
552 | } |
553 | ||
6ff151ad PP |
554 | if (stream_state->is_ended) { |
555 | /* | |
b09a5592 | 556 | * There's a new message which has a reference to a |
6ff151ad | 557 | * stream which, from this iterator's point of view, is |
b09a5592 | 558 | * ended ("end of stream" message was returned). |
6ff151ad PP |
559 | * This is bad: the API guarantees that it can never |
560 | * happen. | |
561 | */ | |
562 | BT_ASSERT_PRE_MSG("Stream is already ended: %![stream-]+s", | |
563 | stream); | |
564 | is_valid = false; | |
fa054faf PP |
565 | goto end; |
566 | } | |
567 | ||
b09a5592 PP |
568 | if (c_msg->seq_num == -1ULL) { |
569 | msg->seq_num = stream_state->expected_msg_seq_num; | |
3230ee6b PP |
570 | } |
571 | ||
b09a5592 PP |
572 | if (c_msg->seq_num != -1ULL && |
573 | c_msg->seq_num != stream_state->expected_msg_seq_num) { | |
574 | BT_ASSERT_PRE_MSG("Unexpected message sequence number: " | |
6ff151ad PP |
575 | "seq-num=%" PRIu64 ", " |
576 | "expected-seq-num=%" PRIu64 ", %![stream-]+s", | |
b09a5592 | 577 | c_msg->seq_num, stream_state->expected_msg_seq_num, |
6ff151ad PP |
578 | stream); |
579 | is_valid = false; | |
fa054faf PP |
580 | goto end; |
581 | } | |
582 | ||
b09a5592 PP |
583 | switch (c_msg->type) { |
584 | case BT_MESSAGE_TYPE_STREAM_BEGINNING: | |
585 | BT_ASSERT_PRE_MSG("Unexpected BT_MESSAGE_TYPE_STREAM_BEGINNING " | |
586 | "message at this point: msg-seq-num=%" PRIu64 ", " | |
587 | "%![stream-]+s", c_msg->seq_num, stream); | |
6ff151ad PP |
588 | is_valid = false; |
589 | goto end; | |
b09a5592 | 590 | case BT_MESSAGE_TYPE_STREAM_END: |
6ff151ad | 591 | if (stream_state->cur_packet) { |
b09a5592 PP |
592 | BT_ASSERT_PRE_MSG("Unexpected BT_MESSAGE_TYPE_STREAM_END " |
593 | "message: missing a " | |
594 | "BT_MESSAGE_TYPE_PACKET_END message " | |
595 | "prior to this message: " | |
596 | "msg-seq-num=%" PRIu64 ", " | |
597 | "%![stream-]+s", c_msg->seq_num, stream); | |
6ff151ad PP |
598 | is_valid = false; |
599 | goto end; | |
600 | } | |
b09a5592 | 601 | stream_state->expected_msg_seq_num++; |
6ff151ad PP |
602 | stream_state->is_ended = true; |
603 | goto end; | |
b09a5592 | 604 | case BT_MESSAGE_TYPE_PACKET_BEGINNING: |
6ff151ad | 605 | if (stream_state->cur_packet) { |
b09a5592 PP |
606 | BT_ASSERT_PRE_MSG("Unexpected BT_MESSAGE_TYPE_PACKET_BEGINNING " |
607 | "message at this point: missing a " | |
608 | "BT_MESSAGE_TYPE_PACKET_END message " | |
609 | "prior to this message: " | |
610 | "msg-seq-num=%" PRIu64 ", %![stream-]+s, " | |
611 | "%![packet-]+a", c_msg->seq_num, stream, | |
6ff151ad PP |
612 | packet); |
613 | is_valid = false; | |
614 | goto end; | |
615 | } | |
b09a5592 | 616 | stream_state->expected_msg_seq_num++; |
4b70020d PP |
617 | stream_state->cur_packet = packet; |
618 | bt_object_get_no_null_check(stream_state->cur_packet); | |
6ff151ad | 619 | goto end; |
b09a5592 | 620 | case BT_MESSAGE_TYPE_PACKET_END: |
6ff151ad | 621 | if (!stream_state->cur_packet) { |
b09a5592 PP |
622 | BT_ASSERT_PRE_MSG("Unexpected BT_MESSAGE_TYPE_PACKET_END " |
623 | "message at this point: missing a " | |
624 | "BT_MESSAGE_TYPE_PACKET_BEGINNING message " | |
625 | "prior to this message: " | |
626 | "msg-seq-num=%" PRIu64 ", %![stream-]+s, " | |
627 | "%![packet-]+a", c_msg->seq_num, stream, | |
6ff151ad PP |
628 | packet); |
629 | is_valid = false; | |
630 | goto end; | |
631 | } | |
b09a5592 | 632 | stream_state->expected_msg_seq_num++; |
8138bfe1 | 633 | BT_OBJECT_PUT_REF_AND_RESET(stream_state->cur_packet); |
6ff151ad | 634 | goto end; |
b09a5592 | 635 | case BT_MESSAGE_TYPE_EVENT: |
6ff151ad PP |
636 | if (packet != stream_state->cur_packet) { |
637 | BT_ASSERT_PRE_MSG("Unexpected packet for " | |
b09a5592 PP |
638 | "BT_MESSAGE_TYPE_EVENT message: " |
639 | "msg-seq-num=%" PRIu64 ", %![stream-]+s, " | |
640 | "%![msg-packet-]+a, %![expected-packet-]+a", | |
641 | c_msg->seq_num, stream, | |
6ff151ad PP |
642 | stream_state->cur_packet, packet); |
643 | is_valid = false; | |
644 | goto end; | |
645 | } | |
b09a5592 | 646 | stream_state->expected_msg_seq_num++; |
6ff151ad PP |
647 | goto end; |
648 | default: | |
649 | break; | |
3230ee6b PP |
650 | } |
651 | ||
3230ee6b | 652 | end: |
6ff151ad | 653 | return is_valid; |
3230ee6b PP |
654 | } |
655 | ||
3fd7b79d PP |
656 | BT_ASSERT_PRE_FUNC |
657 | static inline | |
b09a5592 PP |
658 | bool validate_messages( |
659 | struct bt_self_component_port_input_message_iterator *iterator, | |
3fd7b79d PP |
660 | uint64_t count) |
661 | { | |
662 | bool ret = true; | |
b09a5592 PP |
663 | bt_message_array_const msgs = |
664 | (void *) iterator->base.msgs->pdata; | |
3fd7b79d PP |
665 | uint64_t i; |
666 | ||
667 | for (i = 0; i < count; i++) { | |
b09a5592 | 668 | ret = validate_message(iterator, msgs[i]); |
3fd7b79d PP |
669 | if (!ret) { |
670 | break; | |
671 | } | |
672 | } | |
673 | ||
674 | return ret; | |
675 | } | |
676 | ||
6ff151ad | 677 | BT_ASSERT_PRE_FUNC |
b09a5592 PP |
678 | static inline bool self_comp_port_input_msg_iter_can_end( |
679 | struct bt_self_component_port_input_message_iterator *iterator) | |
3230ee6b | 680 | { |
6ff151ad PP |
681 | GHashTableIter iter; |
682 | gpointer stream_key, state_value; | |
683 | bool ret = true; | |
3230ee6b | 684 | |
6ff151ad PP |
685 | /* |
686 | * Verify that this iterator received a | |
b09a5592 | 687 | * BT_MESSAGE_TYPE_STREAM_END message for each stream |
6ff151ad PP |
688 | * which has a state. |
689 | */ | |
3230ee6b | 690 | |
6ff151ad | 691 | g_hash_table_iter_init(&iter, iterator->stream_states); |
3230ee6b | 692 | |
6ff151ad PP |
693 | while (g_hash_table_iter_next(&iter, &stream_key, &state_value)) { |
694 | struct stream_state *stream_state = (void *) state_value; | |
3230ee6b | 695 | |
6ff151ad PP |
696 | BT_ASSERT(stream_state); |
697 | BT_ASSERT(stream_key); | |
fa054faf | 698 | |
6ff151ad | 699 | if (!stream_state->is_ended) { |
b09a5592 | 700 | BT_ASSERT_PRE_MSG("Ending message iterator, " |
6ff151ad PP |
701 | "but stream is not ended: " |
702 | "%![stream-]s", stream_key); | |
703 | ret = false; | |
704 | goto end; | |
705 | } | |
3230ee6b PP |
706 | } |
707 | ||
3230ee6b | 708 | end: |
3230ee6b PP |
709 | return ret; |
710 | } | |
711 | ||
b09a5592 PP |
712 | enum bt_message_iterator_status |
713 | bt_self_component_port_input_message_iterator_next( | |
714 | struct bt_self_component_port_input_message_iterator *iterator, | |
715 | bt_message_array_const *msgs, uint64_t *user_count) | |
3230ee6b | 716 | { |
b09a5592 PP |
717 | typedef enum bt_self_message_iterator_status (*method_t)( |
718 | void *, bt_message_array_const, uint64_t, uint64_t *); | |
834e9996 PP |
719 | |
720 | method_t method = NULL; | |
721 | struct bt_component_class *comp_cls; | |
b09a5592 | 722 | int status = BT_MESSAGE_ITERATOR_STATUS_OK; |
834e9996 | 723 | |
b09a5592 PP |
724 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
725 | BT_ASSERT_PRE_NON_NULL(msgs, "Message array (output)"); | |
726 | BT_ASSERT_PRE_NON_NULL(user_count, "Message count (output)"); | |
6ff151ad | 727 | BT_ASSERT_PRE(iterator->state == |
b09a5592 PP |
728 | BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE, |
729 | "Message iterator's \"next\" called, but " | |
6ff151ad PP |
730 | "iterator is in the wrong state: %!+i", iterator); |
731 | BT_ASSERT(iterator->upstream_component); | |
732 | BT_ASSERT(iterator->upstream_component->class); | |
834e9996 | 733 | BT_LIB_LOGD("Getting next self component input port " |
b09a5592 | 734 | "message iterator's messages: %!+i", iterator); |
834e9996 | 735 | comp_cls = iterator->upstream_component->class; |
d3eb6e8f | 736 | |
3230ee6b | 737 | /* Pick the appropriate "next" method */ |
834e9996 | 738 | switch (comp_cls->type) { |
d3eb6e8f PP |
739 | case BT_COMPONENT_CLASS_TYPE_SOURCE: |
740 | { | |
834e9996 PP |
741 | struct bt_component_class_source *src_comp_cls = |
742 | (void *) comp_cls; | |
d3eb6e8f | 743 | |
b09a5592 | 744 | method = (method_t) src_comp_cls->methods.msg_iter_next; |
d3eb6e8f PP |
745 | break; |
746 | } | |
747 | case BT_COMPONENT_CLASS_TYPE_FILTER: | |
748 | { | |
834e9996 PP |
749 | struct bt_component_class_filter *flt_comp_cls = |
750 | (void *) comp_cls; | |
d3eb6e8f | 751 | |
b09a5592 | 752 | method = (method_t) flt_comp_cls->methods.msg_iter_next; |
d3eb6e8f PP |
753 | break; |
754 | } | |
755 | default: | |
0fbb9a9f | 756 | abort(); |
d3eb6e8f PP |
757 | } |
758 | ||
3230ee6b | 759 | /* |
b09a5592 | 760 | * Call the user's "next" method to get the next messages |
fa054faf | 761 | * and status. |
3230ee6b | 762 | */ |
834e9996 | 763 | BT_ASSERT(method); |
6ff151ad | 764 | BT_LOGD_STR("Calling user's \"next\" method."); |
834e9996 | 765 | status = method(iterator, |
b09a5592 PP |
766 | (void *) iterator->base.msgs->pdata, |
767 | MSG_BATCH_SIZE, user_count); | |
6ff151ad | 768 | BT_LOGD("User method returned: status=%s", |
b09a5592 | 769 | bt_message_iterator_status_string(status)); |
3fd7b79d | 770 | if (status < 0) { |
6ff151ad | 771 | BT_LOGW_STR("User method failed."); |
6ff151ad PP |
772 | goto end; |
773 | } | |
3230ee6b | 774 | |
b09a5592 PP |
775 | if (iterator->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED || |
776 | iterator->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED_AND_ENDED) { | |
6ff151ad PP |
777 | /* |
778 | * The user's "next" method, somehow, cancelled its own | |
b09a5592 | 779 | * message iterator. This can happen, for example, |
6ff151ad PP |
780 | * when the user's method removes the port on which |
781 | * there's the connection from which the iterator was | |
782 | * created. In this case, said connection is ended, and | |
b09a5592 | 783 | * all its message iterators are finalized. |
6ff151ad | 784 | * |
b09a5592 PP |
785 | * Only bt_object_put_ref() the returned message if |
786 | * the status is BT_MESSAGE_ITERATOR_STATUS_OK | |
834e9996 | 787 | * because otherwise this field could be garbage. |
6ff151ad | 788 | */ |
b09a5592 | 789 | if (status == BT_MESSAGE_ITERATOR_STATUS_OK) { |
3fd7b79d | 790 | uint64_t i; |
b09a5592 PP |
791 | bt_message_array_const msgs = |
792 | (void *) iterator->base.msgs->pdata; | |
3fd7b79d PP |
793 | |
794 | for (i = 0; i < *user_count; i++) { | |
b09a5592 | 795 | bt_object_put_ref(msgs[i]); |
3fd7b79d | 796 | } |
3230ee6b PP |
797 | } |
798 | ||
b09a5592 | 799 | status = BT_MESSAGE_ITERATOR_STATUS_CANCELED; |
6ff151ad PP |
800 | goto end; |
801 | } | |
8cf27cc5 | 802 | |
3fd7b79d | 803 | switch (status) { |
b09a5592 PP |
804 | case BT_MESSAGE_ITERATOR_STATUS_OK: |
805 | BT_ASSERT_PRE(validate_messages(iterator, *user_count), | |
806 | "Messages are invalid at this point: " | |
807 | "%![msg-iter-]+i, count=%" PRIu64, | |
3fd7b79d | 808 | iterator, *user_count); |
b09a5592 | 809 | *msgs = (void *) iterator->base.msgs->pdata; |
3fd7b79d | 810 | break; |
b09a5592 | 811 | case BT_MESSAGE_ITERATOR_STATUS_AGAIN: |
3fd7b79d | 812 | goto end; |
b09a5592 PP |
813 | case BT_MESSAGE_ITERATOR_STATUS_END: |
814 | BT_ASSERT_PRE(self_comp_port_input_msg_iter_can_end(iterator), | |
815 | "Message iterator cannot end at this point: " | |
6ff151ad PP |
816 | "%!+i", iterator); |
817 | BT_ASSERT(iterator->state == | |
b09a5592 PP |
818 | BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); |
819 | iterator->state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED; | |
6ff151ad | 820 | BT_LOGD("Set new status: status=%s", |
b09a5592 | 821 | bt_message_iterator_status_string(status)); |
6ff151ad | 822 | goto end; |
6ff151ad PP |
823 | default: |
824 | /* Unknown non-error status */ | |
825 | abort(); | |
41a2b7ae PP |
826 | } |
827 | ||
828 | end: | |
3230ee6b PP |
829 | return status; |
830 | } | |
831 | ||
b09a5592 PP |
832 | enum bt_message_iterator_status |
833 | bt_port_output_message_iterator_next( | |
834 | struct bt_port_output_message_iterator *iterator, | |
835 | bt_message_array_const *msgs_to_user, | |
3fd7b79d | 836 | uint64_t *count_to_user) |
3230ee6b | 837 | { |
b09a5592 | 838 | enum bt_message_iterator_status status; |
94a96686 | 839 | enum bt_graph_status graph_status; |
3230ee6b | 840 | |
b09a5592 PP |
841 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
842 | BT_ASSERT_PRE_NON_NULL(msgs_to_user, "Message array (output)"); | |
843 | BT_ASSERT_PRE_NON_NULL(count_to_user, "Message count (output)"); | |
844 | BT_LIB_LOGD("Getting next output port message iterator's messages: " | |
94a96686 | 845 | "%!+i", iterator); |
3fd7b79d | 846 | |
834e9996 PP |
847 | graph_status = bt_graph_consume_sink_no_check(iterator->graph, |
848 | iterator->colander); | |
94a96686 PP |
849 | switch (graph_status) { |
850 | case BT_GRAPH_STATUS_CANCELED: | |
94a96686 | 851 | case BT_GRAPH_STATUS_AGAIN: |
94a96686 | 852 | case BT_GRAPH_STATUS_END: |
94a96686 | 853 | case BT_GRAPH_STATUS_NOMEM: |
834e9996 | 854 | status = (int) graph_status; |
94a96686 PP |
855 | break; |
856 | case BT_GRAPH_STATUS_OK: | |
b09a5592 | 857 | status = BT_MESSAGE_ITERATOR_STATUS_OK; |
3fd7b79d PP |
858 | |
859 | /* | |
b09a5592 | 860 | * On success, the colander sink moves the messages |
3fd7b79d | 861 | * to this iterator's array and sets this iterator's |
b09a5592 | 862 | * message count: move them to the user. |
3fd7b79d | 863 | */ |
b09a5592 | 864 | *msgs_to_user = (void *) iterator->base.msgs->pdata; |
834e9996 | 865 | *count_to_user = iterator->count; |
fe7265b5 | 866 | break; |
fe7265b5 | 867 | default: |
94a96686 | 868 | /* Other errors */ |
b09a5592 | 869 | status = BT_MESSAGE_ITERATOR_STATUS_ERROR; |
fe7265b5 | 870 | } |
3230ee6b | 871 | |
3230ee6b | 872 | return status; |
53d45b87 JG |
873 | } |
874 | ||
b09a5592 PP |
875 | struct bt_component *bt_self_component_port_input_message_iterator_borrow_component( |
876 | struct bt_self_component_port_input_message_iterator *iterator) | |
834e9996 | 877 | { |
b09a5592 | 878 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
834e9996 PP |
879 | return iterator->upstream_component; |
880 | } | |
881 | ||
b09a5592 PP |
882 | struct bt_self_component *bt_self_message_iterator_borrow_component( |
883 | struct bt_self_message_iterator *self_iterator) | |
413bc2c4 | 884 | { |
b09a5592 | 885 | struct bt_self_component_port_input_message_iterator *iterator = |
834e9996 | 886 | (void *) self_iterator; |
fe7265b5 | 887 | |
b09a5592 | 888 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
834e9996 | 889 | return (void *) iterator->upstream_component; |
413bc2c4 JG |
890 | } |
891 | ||
b09a5592 PP |
892 | struct bt_self_port_output *bt_self_message_iterator_borrow_port( |
893 | struct bt_self_message_iterator *self_iterator) | |
91457551 | 894 | { |
b09a5592 | 895 | struct bt_self_component_port_input_message_iterator *iterator = |
834e9996 PP |
896 | (void *) self_iterator; |
897 | ||
b09a5592 | 898 | BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); |
834e9996 | 899 | return (void *) iterator->upstream_port; |
91457551 | 900 | } |
c3ac0193 PP |
901 | |
902 | static | |
b09a5592 | 903 | void bt_port_output_message_iterator_destroy(struct bt_object *obj) |
c3ac0193 | 904 | { |
b09a5592 | 905 | struct bt_port_output_message_iterator *iterator = (void *) obj; |
c3ac0193 | 906 | |
b09a5592 | 907 | BT_LIB_LOGD("Destroying output port message iterator object: %!+i", |
c3ac0193 PP |
908 | iterator); |
909 | BT_LOGD_STR("Putting graph."); | |
834e9996 | 910 | BT_OBJECT_PUT_REF_AND_RESET(iterator->graph); |
c3ac0193 | 911 | BT_LOGD_STR("Putting colander sink component."); |
834e9996 | 912 | BT_OBJECT_PUT_REF_AND_RESET(iterator->colander); |
b09a5592 | 913 | destroy_base_message_iterator(obj); |
c3ac0193 PP |
914 | } |
915 | ||
b09a5592 PP |
916 | struct bt_port_output_message_iterator * |
917 | bt_port_output_message_iterator_create( | |
7b53201c PP |
918 | struct bt_graph *graph, |
919 | const struct bt_port_output *output_port) | |
c3ac0193 | 920 | { |
b09a5592 | 921 | struct bt_port_output_message_iterator *iterator = NULL; |
834e9996 | 922 | struct bt_component_class_sink *colander_comp_cls = NULL; |
c3ac0193 | 923 | struct bt_component *output_port_comp = NULL; |
834e9996 | 924 | struct bt_component_sink *colander_comp; |
c3ac0193 | 925 | enum bt_graph_status graph_status; |
834e9996 | 926 | struct bt_port_input *colander_in_port = NULL; |
c3ac0193 | 927 | struct bt_component_class_sink_colander_data colander_data; |
3fd7b79d | 928 | int ret; |
c3ac0193 | 929 | |
834e9996 | 930 | BT_ASSERT_PRE_NON_NULL(graph, "Graph"); |
6ff151ad | 931 | BT_ASSERT_PRE_NON_NULL(output_port, "Output port"); |
7b53201c PP |
932 | output_port_comp = bt_port_borrow_component_inline( |
933 | (const void *) output_port); | |
6ff151ad PP |
934 | BT_ASSERT_PRE(output_port_comp, |
935 | "Output port has no component: %!+p", output_port); | |
834e9996 PP |
936 | BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp) == |
937 | (void *) graph, | |
938 | "Output port is not part of graph: %![graph-]+g, %![port-]+p", | |
939 | graph, output_port); | |
c3ac0193 | 940 | |
b09a5592 PP |
941 | /* Create message iterator */ |
942 | BT_LIB_LOGD("Creating message iterator on output port: " | |
834e9996 | 943 | "%![port-]+p, %![comp-]+c", output_port, output_port_comp); |
b09a5592 | 944 | iterator = g_new0(struct bt_port_output_message_iterator, 1); |
c3ac0193 | 945 | if (!iterator) { |
b09a5592 | 946 | BT_LOGE_STR("Failed to allocate one output port message iterator."); |
c3ac0193 PP |
947 | goto error; |
948 | } | |
949 | ||
b09a5592 PP |
950 | ret = init_message_iterator((void *) iterator, |
951 | BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT, | |
952 | bt_port_output_message_iterator_destroy); | |
3fd7b79d | 953 | if (ret) { |
b09a5592 | 954 | /* init_message_iterator() logs errors */ |
8138bfe1 | 955 | BT_OBJECT_PUT_REF_AND_RESET(iterator); |
3fd7b79d PP |
956 | goto end; |
957 | } | |
c3ac0193 PP |
958 | |
959 | /* Create colander component */ | |
960 | colander_comp_cls = bt_component_class_sink_colander_get(); | |
961 | if (!colander_comp_cls) { | |
962 | BT_LOGW("Cannot get colander sink component class."); | |
963 | goto error; | |
964 | } | |
965 | ||
4b70020d PP |
966 | iterator->graph = graph; |
967 | bt_object_get_no_null_check(iterator->graph); | |
b09a5592 | 968 | colander_data.msgs = (void *) iterator->base.msgs->pdata; |
3fd7b79d | 969 | colander_data.count_addr = &iterator->count; |
a9de0e7a PP |
970 | |
971 | /* Hope that nobody uses this very unique name */ | |
834e9996 | 972 | graph_status = |
7b53201c | 973 | bt_graph_add_sink_component_with_init_method_data( |
a9de0e7a PP |
974 | (void *) graph, colander_comp_cls, |
975 | "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1", | |
7b53201c | 976 | NULL, &colander_data, (void *) &iterator->colander); |
c3ac0193 | 977 | if (graph_status != BT_GRAPH_STATUS_OK) { |
834e9996 PP |
978 | BT_LIB_LOGW("Cannot add colander sink component to graph: " |
979 | "%1[graph-]+g, status=%s", graph, | |
c3ac0193 PP |
980 | bt_graph_status_string(graph_status)); |
981 | goto error; | |
982 | } | |
983 | ||
984 | /* | |
985 | * Connect provided output port to the colander component's | |
986 | * input port. | |
987 | */ | |
7b53201c PP |
988 | colander_in_port = |
989 | (void *) bt_component_sink_borrow_input_port_by_index_const( | |
990 | (void *) iterator->colander, 0); | |
8b45963b | 991 | BT_ASSERT(colander_in_port); |
7b53201c | 992 | graph_status = bt_graph_connect_ports(graph, |
c3ac0193 PP |
993 | output_port, colander_in_port, NULL); |
994 | if (graph_status != BT_GRAPH_STATUS_OK) { | |
834e9996 PP |
995 | BT_LIB_LOGW("Cannot add colander sink component to graph: " |
996 | "%![graph-]+g, %![comp-]+c, status=%s", graph, | |
997 | iterator->colander, | |
c3ac0193 PP |
998 | bt_graph_status_string(graph_status)); |
999 | goto error; | |
1000 | } | |
1001 | ||
1002 | /* | |
1003 | * At this point everything went fine. Make the graph | |
b09a5592 | 1004 | * nonconsumable forever so that only this message iterator |
c3ac0193 | 1005 | * can consume (thanks to bt_graph_consume_sink_no_check()). |
b09a5592 PP |
1006 | * This avoids leaking the message created by the colander |
1007 | * sink and moved to the message iterator's message | |
94a96686 | 1008 | * member. |
c3ac0193 | 1009 | */ |
834e9996 | 1010 | bt_graph_set_can_consume(iterator->graph, false); |
c3ac0193 PP |
1011 | goto end; |
1012 | ||
1013 | error: | |
1014 | if (iterator && iterator->graph && iterator->colander) { | |
1015 | int ret; | |
1016 | ||
1017 | /* Remove created colander component from graph if any */ | |
1018 | colander_comp = iterator->colander; | |
8138bfe1 | 1019 | BT_OBJECT_PUT_REF_AND_RESET(iterator->colander); |
c3ac0193 PP |
1020 | |
1021 | /* | |
1022 | * At this point the colander component's reference | |
1023 | * count is 0 because iterator->colander was the only | |
1024 | * owner. We also know that it is not connected because | |
1025 | * this is the last operation before this function | |
1026 | * succeeds. | |
1027 | * | |
1028 | * Since we honor the preconditions here, | |
1029 | * bt_graph_remove_unconnected_component() always | |
1030 | * succeeds. | |
1031 | */ | |
1032 | ret = bt_graph_remove_unconnected_component(iterator->graph, | |
834e9996 | 1033 | (void *) colander_comp); |
8b45963b | 1034 | BT_ASSERT(ret == 0); |
c3ac0193 PP |
1035 | } |
1036 | ||
8138bfe1 | 1037 | BT_OBJECT_PUT_REF_AND_RESET(iterator); |
c3ac0193 PP |
1038 | |
1039 | end: | |
8138bfe1 | 1040 | bt_object_put_ref(colander_comp_cls); |
c3ac0193 PP |
1041 | return (void *) iterator; |
1042 | } | |
8c6884d9 | 1043 | |
b09a5592 PP |
1044 | void bt_port_output_message_iterator_get_ref( |
1045 | const struct bt_port_output_message_iterator *iterator) | |
8c6884d9 PP |
1046 | { |
1047 | bt_object_get_ref(iterator); | |
1048 | } | |
1049 | ||
b09a5592 PP |
1050 | void bt_port_output_message_iterator_put_ref( |
1051 | const struct bt_port_output_message_iterator *iterator) | |
8c6884d9 PP |
1052 | { |
1053 | bt_object_put_ref(iterator); | |
1054 | } | |
1055 | ||
b09a5592 PP |
1056 | void bt_self_component_port_input_message_iterator_get_ref( |
1057 | const struct bt_self_component_port_input_message_iterator *iterator) | |
8c6884d9 PP |
1058 | { |
1059 | bt_object_get_ref(iterator); | |
1060 | } | |
1061 | ||
b09a5592 PP |
1062 | void bt_self_component_port_input_message_iterator_put_ref( |
1063 | const struct bt_self_component_port_input_message_iterator *iterator) | |
8c6884d9 PP |
1064 | { |
1065 | bt_object_put_ref(iterator); | |
1066 | } |