lib: make auto-seek skip over packet messages without clock snapshots
[babeltrace.git] / src / lib / graph / iterator.c
CommitLineData
47e5a032 1/*
0235b0db
MJ
2 * SPDX-License-Identifier: MIT
3 *
e2f7325d 4 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
47e5a032 5 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
47e5a032
JG
6 */
7
350ad6c1 8#define BT_LOG_TAG "LIB/MSG-ITER"
c2d9d9cf 9#include "lib/logging.h"
5af447e5 10
578e048b 11#include "compat/compiler.h"
e74dbb33 12#include "compat/glib.h"
578e048b
MJ
13#include "lib/trace-ir/clock-class.h"
14#include "lib/trace-ir/clock-snapshot.h"
3fadfbc0 15#include <babeltrace2/trace-ir/field.h>
43c59509 16#include <babeltrace2/trace-ir/event.h>
578e048b 17#include "lib/trace-ir/event.h"
43c59509 18#include <babeltrace2/trace-ir/packet.h>
578e048b
MJ
19#include "lib/trace-ir/packet.h"
20#include "lib/trace-ir/stream.h"
43c59509
PP
21#include <babeltrace2/trace-ir/clock-class.h>
22#include <babeltrace2/trace-ir/stream-class.h>
23#include <babeltrace2/trace-ir/stream.h>
24#include <babeltrace2/graph/connection.h>
25#include <babeltrace2/graph/component.h>
26#include <babeltrace2/graph/message.h>
27#include <babeltrace2/graph/self-component.h>
28#include <babeltrace2/graph/port.h>
3fadfbc0 29#include <babeltrace2/graph/graph.h>
43c59509 30#include <babeltrace2/graph/message-iterator.h>
3fadfbc0 31#include <babeltrace2/types.h>
578e048b 32#include "common/assert.h"
d98421f2 33#include "lib/assert-cond.h"
fa054faf 34#include <stdint.h>
2ec84d26 35#include <inttypes.h>
c4f23e30 36#include <stdbool.h>
0fbb9a9f 37#include <stdlib.h>
3230ee6b 38
578e048b 39#include "component-class.h"
578e048b
MJ
40#include "component.h"
41#include "component-sink.h"
42#include "component-source.h"
43#include "connection.h"
44#include "graph.h"
a3f0c7db 45#include "message-iterator-class.h"
578e048b
MJ
46#include "message/discarded-items.h"
47#include "message/event.h"
48#include "message/iterator.h"
49#include "message/message.h"
50#include "message/message-iterator-inactivity.h"
51#include "message/stream.h"
52#include "message/packet.h"
d24d5663 53#include "lib/func-status.h"
578e048b 54
d4393e08
PP
55/*
56 * TODO: Use graph's state (number of active iterators, etc.) and
57 * possibly system specifications to make a better guess than this.
58 */
d6e69534 59#define MSG_BATCH_SIZE 15
d4393e08 60
7474e7d3 61#define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
1778c2a4
PP
62 BT_ASSERT_PRE("has-state-to-seek", \
63 (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE || \
d5b13b9b 64 (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ENDED || \
9a2c8b8e
PP
65 (_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
66 (_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
1778c2a4 67 "Message iterator is in the wrong state: %!+i", (_iter))
47e5a032 68
d0fea130 69static inline
9a2c8b8e
PP
70void set_msg_iterator_state(struct bt_message_iterator *iterator,
71 enum bt_message_iterator_state state)
d0fea130 72{
98b15851 73 BT_ASSERT_DBG(iterator);
7474e7d3 74 BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
9a2c8b8e 75 bt_message_iterator_state_string(state));
d0fea130
PP
76 iterator->state = state;
77}
78
47e5a032 79static
9a2c8b8e 80void bt_message_iterator_destroy(struct bt_object *obj)
47e5a032 81{
9a2c8b8e 82 struct bt_message_iterator *iterator;
8738a040 83
f6ccaed9 84 BT_ASSERT(obj);
d3eb6e8f 85
bd14d768 86 /*
d6e69534 87 * The message iterator's reference count is 0 if we're
bd14d768
PP
88 * here. Increment it to avoid a double-destroy (possibly
89 * infinitely recursive). This could happen for example if the
d6e69534 90 * message iterator's finalization function does
d94d92ac
PP
91 * bt_object_get_ref() (or anything that causes
92 * bt_object_get_ref() to be called) on itself (ref. count goes
93 * from 0 to 1), and then bt_object_put_ref(): the reference
94 * count would go from 1 to 0 again and this function would be
95 * called again.
bd14d768 96 */
3fea54f6 97 obj->ref_count++;
07245ac2 98 iterator = (void *) obj;
3f7d4d90 99 BT_LIB_LOGI("Destroying self component input port message iterator object: "
d94d92ac 100 "%!+i", iterator);
9a2c8b8e 101 bt_message_iterator_try_finalize(iterator);
d3eb6e8f 102
bd14d768
PP
103 if (iterator->connection) {
104 /*
105 * Remove ourself from the originating connection so
106 * that it does not try to finalize a dangling pointer
107 * later.
108 */
109 bt_connection_remove_iterator(iterator->connection, iterator);
d94d92ac 110 iterator->connection = NULL;
bd14d768
PP
111 }
112
da9c4c52
SM
113 if (iterator->auto_seek.msgs) {
114 while (!g_queue_is_empty(iterator->auto_seek.msgs)) {
6871026b 115 bt_object_put_ref_no_null_check(
da9c4c52 116 g_queue_pop_tail(iterator->auto_seek.msgs));
7474e7d3
PP
117 }
118
da9c4c52
SM
119 g_queue_free(iterator->auto_seek.msgs);
120 iterator->auto_seek.msgs = NULL;
7474e7d3
PP
121 }
122
ca02df0a
PP
123 if (iterator->upstream_msg_iters) {
124 /*
125 * At this point the message iterator is finalized, so
126 * it's detached from any upstream message iterator.
127 */
128 BT_ASSERT(iterator->upstream_msg_iters->len == 0);
129 g_ptr_array_free(iterator->upstream_msg_iters, TRUE);
130 iterator->upstream_msg_iters = NULL;
131 }
132
6c373cc9
PP
133 if (iterator->msgs) {
134 g_ptr_array_free(iterator->msgs, TRUE);
135 iterator->msgs = NULL;
136 }
137
138 g_free(iterator);
47e5a032
JG
139}
140
bd14d768 141BT_HIDDEN
9a2c8b8e
PP
142void bt_message_iterator_try_finalize(
143 struct bt_message_iterator *iterator)
bd14d768 144{
ca02df0a 145 uint64_t i;
fca28f75 146 bool call_user_finalize = true;
bd14d768 147
f6ccaed9 148 BT_ASSERT(iterator);
bd14d768
PP
149
150 switch (iterator->state) {
9a2c8b8e 151 case BT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED:
fca28f75
SM
152 /*
153 * If this function is called while the iterator is in the
154 * NON_INITIALIZED state, it means the user initialization
155 * method has either not been called, or has failed. We
156 * therefore don't want to call the user finalization method.
157 * However, the initialization method might have created some
158 * upstream message iterators before failing, so we want to
159 * execute the rest of this function, which unlinks the related
160 * iterators.
161 */
162 call_user_finalize = false;
163 break;
9a2c8b8e 164 case BT_MESSAGE_ITERATOR_STATE_FINALIZED:
bd14d768 165 /* Already finalized */
d6e69534 166 BT_LIB_LOGD("Not finalizing message iterator: already finalized: "
d94d92ac 167 "%!+i", iterator);
d0fea130 168 goto end;
9a2c8b8e 169 case BT_MESSAGE_ITERATOR_STATE_FINALIZING:
870631a2 170 /* Finalizing */
d0fea130
PP
171 BT_LIB_LOGF("Message iterator is already being finalized: "
172 "%!+i", iterator);
498e7994 173 bt_common_abort();
bd14d768
PP
174 default:
175 break;
176 }
177
d6e69534 178 BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator);
9a2c8b8e
PP
179 set_msg_iterator_state(iterator,
180 BT_MESSAGE_ITERATOR_STATE_FINALIZING);
f6ccaed9 181 BT_ASSERT(iterator->upstream_component);
bd14d768
PP
182
183 /* Call user-defined destroy method */
fca28f75 184 if (call_user_finalize) {
a3f0c7db 185 typedef void (*method_t)(void *);
41a3efcd 186 method_t method;
fca28f75
SM
187 struct bt_component_class *comp_class =
188 iterator->upstream_component->class;
41a3efcd 189 struct bt_component_class_with_iterator_class *class_with_iter_class;
fca28f75 190
41a3efcd
SM
191 BT_ASSERT(bt_component_class_has_message_iterator_class(comp_class));
192 class_with_iter_class = container_of(comp_class,
193 struct bt_component_class_with_iterator_class, parent);
194 method = (method_t) class_with_iter_class->msg_iter_cls->methods.finalize;
bd14d768 195
fca28f75
SM
196 if (method) {
197 const bt_error *saved_error;
42a63165 198
fca28f75 199 saved_error = bt_current_thread_take_error();
42a63165 200
fca28f75
SM
201 BT_LIB_LOGD("Calling user's finalization method: %!+i",
202 iterator);
203 method(iterator);
4fb18ad2 204 BT_ASSERT_POST_NO_ERROR("bt_message_iterator_class_finalize_method");
42a63165 205
fca28f75
SM
206 if (saved_error) {
207 BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error);
208 }
42a63165 209 }
bd14d768
PP
210 }
211
ca02df0a
PP
212 /* Detach upstream message iterators */
213 for (i = 0; i < iterator->upstream_msg_iters->len; i++) {
9a2c8b8e 214 struct bt_message_iterator *upstream_msg_iter =
ca02df0a
PP
215 iterator->upstream_msg_iters->pdata[i];
216
217 upstream_msg_iter->downstream_msg_iter = NULL;
218 }
219
220 g_ptr_array_set_size(iterator->upstream_msg_iters, 0);
221
222 /* Detach downstream message iterator */
223 if (iterator->downstream_msg_iter) {
224 gboolean existed;
225
226 BT_ASSERT(iterator->downstream_msg_iter->upstream_msg_iters);
227 existed = g_ptr_array_remove_fast(
228 iterator->downstream_msg_iter->upstream_msg_iters,
229 iterator);
230 BT_ASSERT(existed);
231 }
232
bd14d768
PP
233 iterator->upstream_component = NULL;
234 iterator->upstream_port = NULL;
9a2c8b8e
PP
235 set_msg_iterator_state(iterator,
236 BT_MESSAGE_ITERATOR_STATE_FINALIZED);
d6e69534 237 BT_LIB_LOGD("Finalized message iterator: %!+i", iterator);
d0fea130
PP
238
239end:
240 return;
bd14d768
PP
241}
242
243BT_HIDDEN
9a2c8b8e
PP
244void bt_message_iterator_set_connection(
245 struct bt_message_iterator *iterator,
bd14d768
PP
246 struct bt_connection *connection)
247{
f6ccaed9 248 BT_ASSERT(iterator);
bd14d768 249 iterator->connection = connection;
3f7d4d90 250 BT_LIB_LOGI("Set message iterator's connection: "
d94d92ac 251 "%![iter-]+i, %![conn-]+x", iterator, connection);
bd14d768
PP
252}
253
7474e7d3 254static
f2fb1b32 255enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true(
9a2c8b8e 256 struct bt_message_iterator *iterator,
f2fb1b32 257 int64_t ns_from_origin, bt_bool *can_seek)
7474e7d3 258{
f2fb1b32
SM
259 *can_seek = BT_TRUE;
260
261 return BT_FUNC_STATUS_OK;
7474e7d3
PP
262}
263
264static
f2fb1b32 265enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true(
9a2c8b8e 266 struct bt_message_iterator *iterator,
f2fb1b32 267 bt_bool *can_seek)
7474e7d3 268{
f2fb1b32
SM
269 *can_seek = BT_TRUE;
270
271 return BT_FUNC_STATUS_OK;
7474e7d3
PP
272}
273
d94d92ac 274static
e803df70 275int create_self_component_input_port_message_iterator(
ca02df0a 276 struct bt_self_message_iterator *self_downstream_msg_iter,
e803df70 277 struct bt_self_component_port_input *self_port,
1778c2a4
PP
278 struct bt_message_iterator **message_iterator,
279 const char *api_func)
47e5a032 280{
a3f0c7db 281 bt_message_iterator_class_initialize_method init_method = NULL;
9a2c8b8e 282 struct bt_message_iterator *iterator =
ca02df0a 283 NULL;
9a2c8b8e 284 struct bt_message_iterator *downstream_msg_iter =
ca02df0a
PP
285 (void *) self_downstream_msg_iter;
286 struct bt_port *port = (void *) self_port;
287 struct bt_port *upstream_port;
288 struct bt_component *comp;
289 struct bt_component *upstream_comp;
290 struct bt_component_class *upstream_comp_cls;
41a3efcd 291 struct bt_component_class_with_iterator_class *upstream_comp_cls_with_iter_cls;
e803df70 292 int status;
47e5a032 293
1778c2a4
PP
294 BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "message-iterator-output",
295 message_iterator, "Created message iterator (output)");
296 BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "input-port", port,
297 "Input port");
ca02df0a 298 comp = bt_port_borrow_component_inline(port);
1778c2a4
PP
299 BT_ASSERT_PRE_FROM_FUNC(api_func, "input-port-is-connected",
300 bt_port_is_connected(port),
ca02df0a 301 "Input port is not connected: %![port-]+p", port);
1778c2a4
PP
302 BT_ASSERT_PRE_FROM_FUNC(api_func, "input-port-has-component",
303 comp, "Input port is not part of a component: %![port-]+p",
ca02df0a 304 port);
ca02df0a
PP
305 BT_ASSERT(port->connection);
306 upstream_port = port->connection->upstream_port;
f6ccaed9 307 BT_ASSERT(upstream_port);
ca02df0a
PP
308 upstream_comp = bt_port_borrow_component_inline(upstream_port);
309 BT_ASSERT(upstream_comp);
1778c2a4 310 BT_ASSERT_PRE_FROM_FUNC(api_func, "graph-is-configured",
9b4f9b42
PP
311 bt_component_borrow_graph(upstream_comp)->config_state ==
312 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED ||
313 bt_component_borrow_graph(upstream_comp)->config_state ==
314 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED,
ca02df0a
PP
315 "Graph is not configured: %!+g",
316 bt_component_borrow_graph(upstream_comp));
317 upstream_comp_cls = upstream_comp->class;
318 BT_ASSERT(upstream_comp->class->type ==
d94d92ac 319 BT_COMPONENT_CLASS_TYPE_SOURCE ||
ca02df0a 320 upstream_comp->class->type ==
d94d92ac 321 BT_COMPONENT_CLASS_TYPE_FILTER);
ca02df0a
PP
322 BT_LIB_LOGI("Creating message iterator on self component input port: "
323 "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port);
d94d92ac 324 iterator = g_new0(
9a2c8b8e 325 struct bt_message_iterator, 1);
47e5a032 326 if (!iterator) {
870631a2
PP
327 BT_LIB_LOGE_APPEND_CAUSE(
328 "Failed to allocate one self component input port "
d6e69534 329 "message iterator.");
e803df70 330 status = BT_FUNC_STATUS_MEMORY_ERROR;
870631a2 331 goto error;
47e5a032
JG
332 }
333
6c373cc9 334 bt_object_init_shared(&iterator->base,
9a2c8b8e 335 bt_message_iterator_destroy);
6c373cc9
PP
336 iterator->msgs = g_ptr_array_new();
337 if (!iterator->msgs) {
338 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
e803df70 339 status = BT_FUNC_STATUS_MEMORY_ERROR;
870631a2 340 goto error;
d4393e08 341 }
3230ee6b 342
6c373cc9 343 g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE);
54b135a0 344 iterator->last_ns_from_origin = INT64_MIN;
da9c4c52
SM
345 iterator->auto_seek.msgs = g_queue_new();
346 if (!iterator->auto_seek.msgs) {
870631a2 347 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue.");
e803df70 348 status = BT_FUNC_STATUS_MEMORY_ERROR;
ca02df0a
PP
349 goto error;
350 }
351
352 iterator->upstream_msg_iters = g_ptr_array_new();
353 if (!iterator->upstream_msg_iters) {
354 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
e803df70 355 status = BT_FUNC_STATUS_MEMORY_ERROR;
ca02df0a 356 goto error;
3230ee6b
PP
357 }
358
bd14d768
PP
359 iterator->upstream_component = upstream_comp;
360 iterator->upstream_port = upstream_port;
d94d92ac 361 iterator->connection = iterator->upstream_port->connection;
5c563278 362 iterator->graph = bt_component_borrow_graph(upstream_comp);
9a2c8b8e
PP
363 set_msg_iterator_state(iterator,
364 BT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED);
7474e7d3 365
41a3efcd
SM
366 /* Copy methods from the message iterator class to the message iterator. */
367 BT_ASSERT(bt_component_class_has_message_iterator_class(upstream_comp_cls));
368 upstream_comp_cls_with_iter_cls = container_of(upstream_comp_cls,
369 struct bt_component_class_with_iterator_class, parent);
370
371 iterator->methods.next =
9a2c8b8e 372 (bt_message_iterator_next_method)
41a3efcd
SM
373 upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.next;
374 iterator->methods.seek_ns_from_origin =
9a2c8b8e 375 (bt_message_iterator_seek_ns_from_origin_method)
41a3efcd
SM
376 upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.seek_ns_from_origin;
377 iterator->methods.seek_beginning =
9a2c8b8e 378 (bt_message_iterator_seek_beginning_method)
41a3efcd
SM
379 upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.seek_beginning;
380 iterator->methods.can_seek_ns_from_origin =
9a2c8b8e 381 (bt_message_iterator_can_seek_ns_from_origin_method)
41a3efcd
SM
382 upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.can_seek_ns_from_origin;
383 iterator->methods.can_seek_beginning =
9a2c8b8e 384 (bt_message_iterator_can_seek_beginning_method)
41a3efcd 385 upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.can_seek_beginning;
7474e7d3
PP
386
387 if (iterator->methods.seek_ns_from_origin &&
388 !iterator->methods.can_seek_ns_from_origin) {
389 iterator->methods.can_seek_ns_from_origin =
9a2c8b8e 390 (bt_message_iterator_can_seek_ns_from_origin_method)
7474e7d3
PP
391 can_seek_ns_from_origin_true;
392 }
393
394 if (iterator->methods.seek_beginning &&
395 !iterator->methods.can_seek_beginning) {
396 iterator->methods.can_seek_beginning =
9a2c8b8e 397 (bt_message_iterator_can_seek_beginning_method)
7474e7d3
PP
398 can_seek_beginning_true;
399 }
400
41a3efcd
SM
401 /* Call iterator's init method. */
402 init_method = upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.initialize;
d94d92ac
PP
403
404 if (init_method) {
a3f0c7db 405 enum bt_message_iterator_class_initialize_method_status iter_status;
d94d92ac
PP
406
407 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator);
a3f0c7db
SM
408 iter_status = init_method(
409 (struct bt_self_message_iterator *) iterator,
410 &iterator->config,
a3f0c7db 411 (struct bt_self_component_port_output *) upstream_port);
d94d92ac 412 BT_LOGD("User method returned: status=%s",
d24d5663 413 bt_common_func_status_string(iter_status));
1778c2a4
PP
414 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
415 "bt_message_iterator_class_initialize_method",
416 iter_status);
d24d5663 417 if (iter_status != BT_FUNC_STATUS_OK) {
870631a2
PP
418 BT_LIB_LOGW_APPEND_CAUSE(
419 "Component input port message iterator initialization method failed: "
420 "%![iter-]+i, status=%s",
421 iterator,
422 bt_common_func_status_string(iter_status));
e803df70 423 status = iter_status;
870631a2 424 goto error;
d94d92ac 425 }
8d8b141d
SM
426
427 iterator->config.frozen = true;
d94d92ac
PP
428 }
429
ca02df0a
PP
430 if (downstream_msg_iter) {
431 /* Set this message iterator's downstream message iterator */
432 iterator->downstream_msg_iter = downstream_msg_iter;
433
434 /*
435 * Add this message iterator to the downstream message
436 * iterator's array of upstream message iterators.
437 */
438 g_ptr_array_add(downstream_msg_iter->upstream_msg_iters,
439 iterator);
440 }
441
9a2c8b8e
PP
442 set_msg_iterator_state(iterator,
443 BT_MESSAGE_ITERATOR_STATE_ACTIVE);
d94d92ac 444 g_ptr_array_add(port->connection->iterators, iterator);
3f7d4d90 445 BT_LIB_LOGI("Created message iterator on self component input port: "
d94d92ac
PP
446 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
447 upstream_port, upstream_comp, iterator);
e803df70
SM
448
449 *message_iterator = iterator;
450 status = BT_FUNC_STATUS_OK;
870631a2
PP
451 goto end;
452
453error:
454 BT_OBJECT_PUT_REF_AND_RESET(iterator);
d94d92ac
PP
455
456end:
e803df70 457 return status;
ea8d3e58
JG
458}
459
9a2c8b8e
PP
460bt_message_iterator_create_from_message_iterator_status
461bt_message_iterator_create_from_message_iterator(
ca02df0a 462 struct bt_self_message_iterator *self_msg_iter,
e803df70 463 struct bt_self_component_port_input *input_port,
9a2c8b8e 464 struct bt_message_iterator **message_iterator)
ca02df0a 465{
17f3083a 466 BT_ASSERT_PRE_NO_ERROR();
d5b13b9b 467 BT_ASSERT_PRE_MSG_ITER_NON_NULL(self_msg_iter);
ca02df0a 468 return create_self_component_input_port_message_iterator(self_msg_iter,
1778c2a4 469 input_port, message_iterator, __func__);
ca02df0a
PP
470}
471
9a2c8b8e
PP
472bt_message_iterator_create_from_sink_component_status
473bt_message_iterator_create_from_sink_component(
ca02df0a 474 struct bt_self_component_sink *self_comp,
e803df70 475 struct bt_self_component_port_input *input_port,
9a2c8b8e 476 struct bt_message_iterator **message_iterator)
ca02df0a 477{
17f3083a 478 BT_ASSERT_PRE_NO_ERROR();
1778c2a4 479 BT_ASSERT_PRE_NON_NULL("sink-component", self_comp, "Sink component");
ca02df0a 480 return create_self_component_input_port_message_iterator(NULL,
1778c2a4 481 input_port, message_iterator, __func__);
ca02df0a
PP
482}
483
d6e69534
PP
484void *bt_self_message_iterator_get_data(
485 const struct bt_self_message_iterator *self_iterator)
ea8d3e58 486{
9a2c8b8e 487 struct bt_message_iterator *iterator =
d94d92ac 488 (void *) self_iterator;
ea8d3e58 489
d5b13b9b 490 BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
d94d92ac 491 return iterator->user_data;
8738a040 492}
413bc2c4 493
d6e69534
PP
494void bt_self_message_iterator_set_data(
495 struct bt_self_message_iterator *self_iterator, void *data)
5c563278 496{
9a2c8b8e 497 struct bt_message_iterator *iterator =
d94d92ac 498 (void *) self_iterator;
5c563278 499
d5b13b9b 500 BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
d94d92ac 501 iterator->user_data = data;
3f7d4d90 502 BT_LIB_LOGD("Set message iterator's user data: "
d94d92ac 503 "%!+i, user-data-addr=%p", iterator, data);
5c563278
PP
504}
505
8d8b141d
SM
506void bt_self_message_iterator_configuration_set_can_seek_forward(
507 bt_self_message_iterator_configuration *config,
508 bt_bool can_seek_forward)
509{
1778c2a4
PP
510 BT_ASSERT_PRE_NON_NULL("message-iterator-configuration", config,
511 "Message iterator configuration");
512 BT_ASSERT_PRE_DEV_HOT("message-iterator-configuration", config,
513 "Message iterator configuration", "");
8d8b141d
SM
514
515 config->can_seek_forward = can_seek_forward;
516}
517
54b135a0
SM
518/*
519 * Validate that the default clock snapshot in `msg` doesn't make us go back in
520 * time.
521 */
522
d98421f2 523BT_ASSERT_COND_DEV_FUNC
54b135a0
SM
524static
525bool clock_snapshots_are_monotonic_one(
9a2c8b8e 526 struct bt_message_iterator *iterator,
54b135a0
SM
527 const bt_message *msg)
528{
529 const struct bt_clock_snapshot *clock_snapshot = NULL;
530 bt_message_type message_type = bt_message_get_type(msg);
531 int64_t ns_from_origin;
d24d5663 532 enum bt_clock_snapshot_get_ns_from_origin_status clock_snapshot_status;
54b135a0
SM
533
534 /*
535 * The default is true: if we can't figure out the clock snapshot
536 * (or there is none), assume it is fine.
537 */
538 bool result = true;
539
540 switch (message_type) {
541 case BT_MESSAGE_TYPE_EVENT:
542 {
543 struct bt_message_event *event_msg = (struct bt_message_event *) msg;
544 clock_snapshot = event_msg->default_cs;
545 break;
546 }
547 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
548 {
549 struct bt_message_message_iterator_inactivity *inactivity_msg =
550 (struct bt_message_message_iterator_inactivity *) msg;
60d02328 551 clock_snapshot = inactivity_msg->cs;
54b135a0
SM
552 break;
553 }
554 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
555 case BT_MESSAGE_TYPE_PACKET_END:
556 {
557 struct bt_message_packet *packet_msg = (struct bt_message_packet *) msg;
558 clock_snapshot = packet_msg->default_cs;
559 break;
560 }
188edac1
SM
561 case BT_MESSAGE_TYPE_STREAM_BEGINNING:
562 case BT_MESSAGE_TYPE_STREAM_END:
54b135a0 563 {
188edac1
SM
564 struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg;
565 if (stream_msg->default_cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
566 goto end;
54b135a0 567 }
188edac1
SM
568
569 clock_snapshot = stream_msg->default_cs;
54b135a0
SM
570 break;
571 }
54b135a0
SM
572 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
573 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
574 {
575 struct bt_message_discarded_items *discarded_msg =
576 (struct bt_message_discarded_items *) msg;
577
578 clock_snapshot = discarded_msg->default_begin_cs;
579 break;
580 }
581 }
582
583 if (!clock_snapshot) {
584 goto end;
585 }
586
d747e85f
SM
587 clock_snapshot_status = bt_clock_snapshot_get_ns_from_origin(
588 clock_snapshot, &ns_from_origin);
d24d5663 589 if (clock_snapshot_status != BT_FUNC_STATUS_OK) {
d747e85f
SM
590 /*
591 * bt_clock_snapshot_get_ns_from_origin can return
592 * OVERFLOW_ERROR. We don't really want to report an error to
593 * our caller, so just clear it.
594 */
595 bt_current_thread_clear_error();
54b135a0
SM
596 goto end;
597 }
598
599 result = ns_from_origin >= iterator->last_ns_from_origin;
600 iterator->last_ns_from_origin = ns_from_origin;
601end:
602 return result;
603}
604
d98421f2 605BT_ASSERT_COND_DEV_FUNC
54b135a0
SM
606static
607bool clock_snapshots_are_monotonic(
9a2c8b8e 608 struct bt_message_iterator *iterator,
54b135a0
SM
609 bt_message_array_const msgs, uint64_t msg_count)
610{
611 uint64_t i;
612 bool result;
613
614 for (i = 0; i < msg_count; i++) {
615 if (!clock_snapshots_are_monotonic_one(iterator, msgs[i])) {
616 result = false;
617 goto end;
618 }
619 }
620
621 result = true;
622
623end:
624 return result;
625}
626
627/*
628 * When a new stream begins, verify that the clock class tied to this
629 * stream is compatible with what we've seen before.
630 */
631
d98421f2 632BT_ASSERT_COND_DEV_FUNC
54b135a0 633static
9a2c8b8e 634bool clock_classes_are_compatible_one(struct bt_message_iterator *iterator,
54b135a0
SM
635 const struct bt_message *msg)
636{
637 enum bt_message_type message_type = bt_message_get_type(msg);
638 bool result;
639
640 if (message_type == BT_MESSAGE_TYPE_STREAM_BEGINNING) {
641 const struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg;
642 const struct bt_clock_class *clock_class = stream_msg->stream->class->default_clock_class;
643 bt_uuid clock_class_uuid = NULL;
644
645 if (clock_class) {
646 clock_class_uuid = bt_clock_class_get_uuid(clock_class);
647 }
648
649 switch (iterator->clock_expectation.type) {
650 case CLOCK_EXPECTATION_UNSET:
651 /*
652 * This is the first time we see a message with a clock
653 * snapshot: record the properties of that clock, against
654 * which we'll compare the clock properties of the following
655 * messages.
656 */
657
658 if (!clock_class) {
659 iterator->clock_expectation.type = CLOCK_EXPECTATION_NONE;
660 } else if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
661 iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_UNIX;
662 } else if (clock_class_uuid) {
663 iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_UUID;
6162e6b7 664 bt_uuid_copy(iterator->clock_expectation.uuid, clock_class_uuid);
54b135a0
SM
665 } else {
666 iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID;
667 }
668 break;
669
670 case CLOCK_EXPECTATION_NONE:
671 if (clock_class) {
d98421f2 672 BT_ASSERT_COND_DEV_MSG(
bdb288b3 673 "Expecting no clock class, got one: %![cc-]+K",
54b135a0
SM
674 clock_class);
675 result = false;
676 goto end;
677 }
678
679 break;
680
681 case CLOCK_EXPECTATION_ORIGIN_UNIX:
682 if (!clock_class) {
d98421f2 683 BT_ASSERT_COND_DEV_MSG(
bdb288b3 684 "Expecting a clock class, got none.");
54b135a0
SM
685 result = false;
686 goto end;
687 }
688
689 if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
d98421f2 690 BT_ASSERT_COND_DEV_MSG(
bdb288b3 691 "Expecting a clock class with Unix epoch origin: %![cc-]+K",
54b135a0
SM
692 clock_class);
693 result = false;
694 goto end;
695 }
696 break;
697
698 case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID:
699 if (!clock_class) {
d98421f2 700 BT_ASSERT_COND_DEV_MSG(
bdb288b3 701 "Expecting a clock class, got none.");
54b135a0
SM
702 result = false;
703 goto end;
704 }
705
706 if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
d98421f2 707 BT_ASSERT_COND_DEV_MSG(
bdb288b3 708 "Expecting a clock class without Unix epoch origin: %![cc-]+K",
54b135a0
SM
709 clock_class);
710 result = false;
711 goto end;
712 }
713
714 if (!clock_class_uuid) {
d98421f2 715 BT_ASSERT_COND_DEV_MSG(
bdb288b3 716 "Expecting a clock class with UUID: %![cc-]+K",
54b135a0
SM
717 clock_class);
718 result = false;
719 goto end;
720 }
721
722 if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) {
d98421f2 723 BT_ASSERT_COND_DEV_MSG(
bdb288b3 724 "Expecting a clock class with UUID, got one "
54b135a0
SM
725 "with a different UUID: %![cc-]+K, expected-uuid=%!u",
726 clock_class, iterator->clock_expectation.uuid);
727 result = false;
728 goto end;
729 }
730 break;
731
732 case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID:
733 if (!clock_class) {
d98421f2 734 BT_ASSERT_COND_DEV_MSG(
bdb288b3 735 "Expecting a clock class, got none.");
54b135a0
SM
736 result = false;
737 goto end;
738 }
739
740 if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
d98421f2 741 BT_ASSERT_COND_DEV_MSG(
bdb288b3 742 "Expecting a clock class without Unix epoch origin: %![cc-]+K",
54b135a0
SM
743 clock_class);
744 result = false;
745 goto end;
746 }
747
748 if (clock_class_uuid) {
d98421f2 749 BT_ASSERT_COND_DEV_MSG(
bdb288b3 750 "Expecting a clock class without UUID: %![cc-]+K",
54b135a0
SM
751 clock_class);
752 result = false;
753 goto end;
754 }
755 break;
756 }
757 }
758
759 result = true;
760
761end:
762 return result;
763}
764
d98421f2 765BT_ASSERT_COND_DEV_FUNC
54b135a0
SM
766static
767bool clock_classes_are_compatible(
9a2c8b8e 768 struct bt_message_iterator *iterator,
54b135a0
SM
769 bt_message_array_const msgs, uint64_t msg_count)
770{
771 uint64_t i;
772 bool result;
773
774 for (i = 0; i < msg_count; i++) {
775 if (!clock_classes_are_compatible_one(iterator, msgs[i])) {
776 result = false;
777 goto end;
778 }
779 }
780
781 result = true;
782
783end:
784 return result;
785}
786
787/*
788 * Call the `next` method of the iterator. Do some validation on the returned
789 * messages.
790 */
791
1778c2a4
PP
792#define NEXT_METHOD_NAME "bt_message_iterator_class_next_method"
793
54b135a0 794static
a3f0c7db 795enum bt_message_iterator_class_next_method_status
d24d5663 796call_iterator_next_method(
9a2c8b8e 797 struct bt_message_iterator *iterator,
54b135a0
SM
798 bt_message_array_const msgs, uint64_t capacity, uint64_t *user_count)
799{
a3f0c7db 800 enum bt_message_iterator_class_next_method_status status;
54b135a0 801
98b15851 802 BT_ASSERT_DBG(iterator->methods.next);
54b135a0 803 BT_LOGD_STR("Calling user's \"next\" method.");
54b135a0 804 status = iterator->methods.next(iterator, msgs, capacity, user_count);
f6f301d7 805 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64,
d24d5663 806 bt_common_func_status_string(status), *user_count);
54b135a0 807
d24d5663 808 if (status == BT_FUNC_STATUS_OK) {
1778c2a4
PP
809 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
810 "message-clock-classes-are-compatible",
811 clock_classes_are_compatible(iterator, msgs,
812 *user_count),
54b135a0 813 "Clocks are not compatible");
1778c2a4
PP
814 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
815 "message-clock-snapshots-are-monotonic",
816 clock_snapshots_are_monotonic(iterator, msgs,
817 *user_count),
54b135a0
SM
818 "Clock snapshots are not monotonic");
819 }
820
1778c2a4
PP
821 BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(NEXT_METHOD_NAME,
822 status);
6ecdcca3 823
54b135a0
SM
824 return status;
825}
826
d24d5663 827enum bt_message_iterator_next_status
9a2c8b8e
PP
828bt_message_iterator_next(
829 struct bt_message_iterator *iterator,
d6e69534 830 bt_message_array_const *msgs, uint64_t *user_count)
3230ee6b 831{
d24d5663 832 enum bt_message_iterator_next_status status = BT_FUNC_STATUS_OK;
d94d92ac 833
17f3083a 834 BT_ASSERT_PRE_DEV_NO_ERROR();
d5b13b9b 835 BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
1778c2a4
PP
836 BT_ASSERT_PRE_DEV_NON_NULL("message-array-output", msgs,
837 "Message array (output)");
838 BT_ASSERT_PRE_DEV_NON_NULL("user-count-output", user_count,
839 "Message count (output)");
840 BT_ASSERT_PRE_DEV("message-iterator-is-active",
841 iterator->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE,
d6e69534 842 "Message iterator's \"next\" called, but "
7474e7d3 843 "message iterator is in the wrong state: %!+i", iterator);
98b15851
PP
844 BT_ASSERT_DBG(iterator->upstream_component);
845 BT_ASSERT_DBG(iterator->upstream_component->class);
1778c2a4 846 BT_ASSERT_PRE_DEV("graph-is-configured",
5badd463
PP
847 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
848 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
4725a201
PP
849 "Graph is not configured: %!+g",
850 bt_component_borrow_graph(iterator->upstream_component));
d94d92ac 851 BT_LIB_LOGD("Getting next self component input port "
3f7d4d90
PP
852 "message iterator's messages: %!+i, batch-size=%u",
853 iterator, MSG_BATCH_SIZE);
d3eb6e8f 854
3230ee6b 855 /*
d6e69534 856 * Call the user's "next" method to get the next messages
fa054faf 857 * and status.
3230ee6b 858 */
3f7d4d90 859 *user_count = 0;
d24d5663 860 status = (int) call_iterator_next_method(iterator,
6c373cc9 861 (void *) iterator->msgs->pdata, MSG_BATCH_SIZE,
7474e7d3 862 user_count);
870631a2
PP
863 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64,
864 bt_common_func_status_string(status), *user_count);
d4393e08 865 if (status < 0) {
870631a2
PP
866 BT_LIB_LOGW_APPEND_CAUSE(
867 "Component input port message iterator's \"next\" method failed: "
868 "%![iter-]+i, status=%s",
869 iterator, bt_common_func_status_string(status));
f42867e2
PP
870 goto end;
871 }
3230ee6b 872
d0fea130
PP
873 /*
874 * There is no way that this iterator could have been finalized
875 * during its "next" method, as the only way to do this is to
876 * put the last iterator's reference, and this can only be done
877 * by its downstream owner.
7474e7d3
PP
878 *
879 * For the same reason, there is no way that this iterator could
880 * have seeked (cannot seek a self message iterator).
d0fea130 881 */
98b15851 882 BT_ASSERT_DBG(iterator->state ==
9a2c8b8e 883 BT_MESSAGE_ITERATOR_STATE_ACTIVE);
8cf27cc5 884
d4393e08 885 switch (status) {
d24d5663 886 case BT_FUNC_STATUS_OK:
1778c2a4
PP
887 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, "count-lteq-capacity",
888 *user_count <= MSG_BATCH_SIZE,
7474e7d3
PP
889 "Invalid returned message count: greater than "
890 "batch size: count=%" PRIu64 ", batch-size=%u",
891 *user_count, MSG_BATCH_SIZE);
6c373cc9 892 *msgs = (void *) iterator->msgs->pdata;
d4393e08 893 break;
d24d5663 894 case BT_FUNC_STATUS_AGAIN:
d4393e08 895 goto end;
d24d5663 896 case BT_FUNC_STATUS_END:
9a2c8b8e
PP
897 set_msg_iterator_state(iterator,
898 BT_MESSAGE_ITERATOR_STATE_ENDED);
f42867e2 899 goto end;
f42867e2
PP
900 default:
901 /* Unknown non-error status */
498e7994 902 bt_common_abort();
41a2b7ae
PP
903 }
904
905end:
3230ee6b
PP
906 return status;
907}
908
7474e7d3 909struct bt_component *
9a2c8b8e
PP
910bt_message_iterator_borrow_component(
911 struct bt_message_iterator *iterator)
d94d92ac 912{
d5b13b9b 913 BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
d94d92ac
PP
914 return iterator->upstream_component;
915}
916
d6e69534
PP
917struct bt_self_component *bt_self_message_iterator_borrow_component(
918 struct bt_self_message_iterator *self_iterator)
413bc2c4 919{
9a2c8b8e 920 struct bt_message_iterator *iterator =
d94d92ac 921 (void *) self_iterator;
90157d89 922
d5b13b9b 923 BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
d94d92ac 924 return (void *) iterator->upstream_component;
413bc2c4
JG
925}
926
50e763f6 927struct bt_self_component_port_output *bt_self_message_iterator_borrow_port(
d6e69534 928 struct bt_self_message_iterator *self_iterator)
91457551 929{
9a2c8b8e 930 struct bt_message_iterator *iterator =
d94d92ac
PP
931 (void *) self_iterator;
932
d5b13b9b 933 BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator);
d94d92ac 934 return (void *) iterator->upstream_port;
91457551 935}
8ed535b5 936
1778c2a4
PP
937#define CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME \
938 "bt_message_iterator_class_can_seek_ns_from_origin_method"
939
f2fb1b32 940enum bt_message_iterator_can_seek_ns_from_origin_status
9a2c8b8e
PP
941bt_message_iterator_can_seek_ns_from_origin(
942 struct bt_message_iterator *iterator,
f2fb1b32 943 int64_t ns_from_origin, bt_bool *can_seek)
7474e7d3 944{
f2fb1b32 945 enum bt_message_iterator_can_seek_ns_from_origin_status status;
7474e7d3 946
17f3083a 947 BT_ASSERT_PRE_NO_ERROR();
d5b13b9b
PP
948 BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
949 BT_ASSERT_PRE_RES_OUT_NON_NULL(can_seek);
7474e7d3 950 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1778c2a4 951 BT_ASSERT_PRE("graph-is-configured",
5badd463
PP
952 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
953 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
7474e7d3
PP
954 "Graph is not configured: %!+g",
955 bt_component_borrow_graph(iterator->upstream_component));
956
957 if (iterator->methods.can_seek_ns_from_origin) {
f2fb1b32
SM
958 /*
959 * Initialize to an invalid value, so we can post-assert that
960 * the method returned a valid value.
961 */
962 *can_seek = -1;
963
c0e46a7c
SM
964 BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i",
965 iterator);
966
f2fb1b32
SM
967 status = (int) iterator->methods.can_seek_ns_from_origin(iterator,
968 ns_from_origin, can_seek);
969
1778c2a4
PP
970 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
971 CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME, status);
6ecdcca3 972
c0e46a7c
SM
973 if (status != BT_FUNC_STATUS_OK) {
974 BT_LIB_LOGW_APPEND_CAUSE(
975 "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: "
976 "%![iter-]+i, status=%s",
977 iterator, bt_common_func_status_string(status));
978 goto end;
979 }
980
1778c2a4
PP
981 BT_ASSERT_POST(CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME,
982 "valid-return-value",
983 *can_seek == BT_TRUE || *can_seek == BT_FALSE,
f2fb1b32
SM
984 "Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i",
985 *can_seek, iterator);
986
c0e46a7c
SM
987 BT_LIB_LOGD(
988 "User's \"can seek nanoseconds from origin\" returned successfully: "
989 "%![iter-]+i, can-seek=%d",
990 iterator, *can_seek);
991
992 if (*can_seek) {
993 goto end;
994 }
7474e7d3
PP
995 }
996
997 /*
c0e46a7c
SM
998 * Automatic seeking fall back: if we can seek to the beginning and the
999 * iterator supports forward seeking then we can automatically seek to
1000 * any timestamp.
7474e7d3 1001 */
9a2c8b8e 1002 status = (int) bt_message_iterator_can_seek_beginning(
f2fb1b32 1003 iterator, can_seek);
c0e46a7c
SM
1004 if (status != BT_FUNC_STATUS_OK) {
1005 goto end;
1006 }
1007
1008 *can_seek = *can_seek && iterator->config.can_seek_forward;
7474e7d3
PP
1009
1010end:
f2fb1b32 1011 return status;
7474e7d3
PP
1012}
1013
1778c2a4
PP
1014#define CAN_SEEK_BEGINNING_METHOD_NAME \
1015 "bt_message_iterator_class_can_seek_beginning"
1016
f2fb1b32 1017enum bt_message_iterator_can_seek_beginning_status
9a2c8b8e
PP
1018bt_message_iterator_can_seek_beginning(
1019 struct bt_message_iterator *iterator,
f2fb1b32 1020 bt_bool *can_seek)
7474e7d3 1021{
f2fb1b32 1022 enum bt_message_iterator_can_seek_beginning_status status;
7474e7d3 1023
17f3083a 1024 BT_ASSERT_PRE_NO_ERROR();
d5b13b9b
PP
1025 BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
1026 BT_ASSERT_PRE_RES_OUT_NON_NULL(can_seek);
7474e7d3 1027 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1778c2a4 1028 BT_ASSERT_PRE("graph-is-configured",
5badd463
PP
1029 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1030 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
7474e7d3
PP
1031 "Graph is not configured: %!+g",
1032 bt_component_borrow_graph(iterator->upstream_component));
1033
1034 if (iterator->methods.can_seek_beginning) {
f2fb1b32
SM
1035 /*
1036 * Initialize to an invalid value, so we can post-assert that
1037 * the method returned a valid value.
1038 */
1039 *can_seek = -1;
1040
1041 status = (int) iterator->methods.can_seek_beginning(iterator, can_seek);
1042
1778c2a4
PP
1043 BT_ASSERT_POST(CAN_SEEK_BEGINNING_METHOD_NAME,
1044 "valid-return-value",
f2fb1b32
SM
1045 status != BT_FUNC_STATUS_OK ||
1046 *can_seek == BT_TRUE ||
1047 *can_seek == BT_FALSE,
1048 "Unexpected boolean value returned from user's \"can seek beginning\" method: val=%d, %![iter-]+i",
1049 *can_seek, iterator);
1778c2a4
PP
1050 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
1051 CAN_SEEK_BEGINNING_METHOD_NAME, status);
f2fb1b32
SM
1052 } else {
1053 *can_seek = BT_FALSE;
1054 status = BT_FUNC_STATUS_OK;
7474e7d3
PP
1055 }
1056
f2fb1b32 1057 return status;
7474e7d3
PP
1058}
1059
1060static inline
003e713f 1061void set_iterator_state_after_seeking(
9a2c8b8e 1062 struct bt_message_iterator *iterator,
d24d5663 1063 int status)
7474e7d3 1064{
9a2c8b8e 1065 enum bt_message_iterator_state new_state = 0;
7474e7d3
PP
1066
1067 /* Set iterator's state depending on seeking status */
1068 switch (status) {
d24d5663 1069 case BT_FUNC_STATUS_OK:
9a2c8b8e 1070 new_state = BT_MESSAGE_ITERATOR_STATE_ACTIVE;
7474e7d3 1071 break;
d24d5663 1072 case BT_FUNC_STATUS_AGAIN:
9a2c8b8e 1073 new_state = BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN;
7474e7d3 1074 break;
d24d5663
PP
1075 case BT_FUNC_STATUS_ERROR:
1076 case BT_FUNC_STATUS_MEMORY_ERROR:
9a2c8b8e 1077 new_state = BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR;
7474e7d3 1078 break;
d24d5663 1079 case BT_FUNC_STATUS_END:
9a2c8b8e 1080 new_state = BT_MESSAGE_ITERATOR_STATE_ENDED;
7474e7d3
PP
1081 break;
1082 default:
498e7994 1083 bt_common_abort();
7474e7d3
PP
1084 }
1085
9a2c8b8e 1086 set_msg_iterator_state(iterator, new_state);
7474e7d3
PP
1087}
1088
54b135a0
SM
1089static
1090void reset_iterator_expectations(
9a2c8b8e 1091 struct bt_message_iterator *iterator)
54b135a0
SM
1092{
1093 iterator->last_ns_from_origin = INT64_MIN;
1094 iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET;
1095}
1096
f2fb1b32
SM
1097static
1098bool message_iterator_can_seek_beginning(
9a2c8b8e 1099 struct bt_message_iterator *iterator)
f2fb1b32
SM
1100{
1101 enum bt_message_iterator_can_seek_beginning_status status;
1102 bt_bool can_seek;
1103
9a2c8b8e 1104 status = bt_message_iterator_can_seek_beginning(
f2fb1b32
SM
1105 iterator, &can_seek);
1106 if (status != BT_FUNC_STATUS_OK) {
1107 can_seek = BT_FALSE;
1108 }
1109
1110 return can_seek;
1111}
1112
1778c2a4
PP
1113#define SEEK_BEGINNING_METHOD_NAME \
1114 "bt_message_iterator_class_seek_beginning_method"
1115
d24d5663 1116enum bt_message_iterator_seek_beginning_status
1778c2a4 1117bt_message_iterator_seek_beginning(struct bt_message_iterator *iterator)
7474e7d3 1118{
9275bef4 1119 int status;
7474e7d3 1120
17f3083a 1121 BT_ASSERT_PRE_NO_ERROR();
d5b13b9b 1122 BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
7474e7d3 1123 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1778c2a4 1124 BT_ASSERT_PRE("graph-is-configured",
5badd463
PP
1125 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1126 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
7474e7d3
PP
1127 "Graph is not configured: %!+g",
1128 bt_component_borrow_graph(iterator->upstream_component));
1778c2a4
PP
1129 BT_ASSERT_PRE("can-seek-beginning",
1130 message_iterator_can_seek_beginning(iterator),
7474e7d3 1131 "Message iterator cannot seek beginning: %!+i", iterator);
54b135a0
SM
1132
1133 /*
1134 * We are seeking, reset our expectations about how the following
1135 * messages should look like.
1136 */
1137 reset_iterator_expectations(iterator);
1138
7474e7d3 1139 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator);
9a2c8b8e
PP
1140 set_msg_iterator_state(iterator,
1141 BT_MESSAGE_ITERATOR_STATE_SEEKING);
7474e7d3
PP
1142 status = iterator->methods.seek_beginning(iterator);
1143 BT_LOGD("User method returned: status=%s",
d24d5663 1144 bt_common_func_status_string(status));
1778c2a4
PP
1145 BT_ASSERT_POST(SEEK_BEGINNING_METHOD_NAME, "valid-status",
1146 status == BT_FUNC_STATUS_OK ||
d24d5663
PP
1147 status == BT_FUNC_STATUS_ERROR ||
1148 status == BT_FUNC_STATUS_MEMORY_ERROR ||
1149 status == BT_FUNC_STATUS_AGAIN,
7474e7d3 1150 "Unexpected status: %![iter-]+i, status=%s",
d24d5663 1151 iterator, bt_common_func_status_string(status));
1778c2a4
PP
1152 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(SEEK_BEGINNING_METHOD_NAME,
1153 status);
870631a2
PP
1154 if (status < 0) {
1155 BT_LIB_LOGW_APPEND_CAUSE(
1156 "Component input port message iterator's \"seek beginning\" method failed: "
1157 "%![iter-]+i, status=%s",
1158 iterator, bt_common_func_status_string(status));
1159 }
1160
7474e7d3
PP
1161 set_iterator_state_after_seeking(iterator, status);
1162 return status;
1163}
1164
8d8b141d 1165bt_bool
9a2c8b8e
PP
1166bt_message_iterator_can_seek_forward(
1167 bt_message_iterator *iterator)
8d8b141d 1168{
d5b13b9b 1169 BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
8d8b141d
SM
1170
1171 return iterator->config.can_seek_forward;
1172}
1173
5b7b55be
SM
1174/*
1175 * Structure used to record the state of a given stream during the fast-forward
1176 * phase of an auto-seek.
1177 */
1178struct auto_seek_stream_state {
1179 /*
1180 * Value representing which step of this timeline we are at.
1181 *
1182 * time --->
188edac1 1183 * [SB] 1 [PB] 2 [PE] 1 [SE]
5b7b55be
SM
1184 *
1185 * At each point in the timeline, the messages we need to replicate are:
1186 *
1187 * 1: Stream beginning
188edac1 1188 * 2: Stream beginning, packet beginning
5b7b55be
SM
1189 *
1190 * Before "Stream beginning" and after "Stream end", we don't need to
1191 * replicate anything as the stream doesn't exist.
1192 */
1193 enum {
1194 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN,
5b7b55be
SM
1195 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN,
1196 } state;
1197
1198 /*
1199 * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
1200 * in. This is a weak reference, since the packet will always be
1201 * alive by the time we use it.
1202 */
1203 struct bt_packet *packet;
188edac1
SM
1204
1205 /* Have we see a message with a clock snapshot yet? */
1206 bool seen_clock_snapshot;
5b7b55be
SM
1207};
1208
1209static
1210struct auto_seek_stream_state *create_auto_seek_stream_state(void)
1211{
1212 return g_new0(struct auto_seek_stream_state, 1);
1213}
1214
1215static
1216void destroy_auto_seek_stream_state(void *ptr)
1217{
1218 g_free(ptr);
1219}
1220
1221static
1222GHashTable *create_auto_seek_stream_states(void)
1223{
1224 return g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL,
1225 destroy_auto_seek_stream_state);
1226}
1227
1228static
1229void destroy_auto_seek_stream_states(GHashTable *stream_states)
1230{
1231 g_hash_table_destroy(stream_states);
1232}
1233
1234/*
1235 * Handle one message while we are in the fast-forward phase of an auto-seek.
1236 *
1237 * Sets `*got_first` to true if the message's timestamp is greater or equal to
1238 * `ns_from_origin`. In other words, if this is the first message after our
1239 * seek point.
1240 *
1241 * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1242 * `struct auto_seek_stream_state` used to keep the state of each stream
1243 * during the fast-forward.
1244 */
1245
7474e7d3 1246static inline
d24d5663 1247int auto_seek_handle_message(
9a2c8b8e 1248 struct bt_message_iterator *iterator,
5b9e151d 1249 int64_t ns_from_origin, const struct bt_message *msg,
5b7b55be 1250 bool *got_first, GHashTable *stream_states)
7474e7d3 1251{
d24d5663 1252 int status = BT_FUNC_STATUS_OK;
5b9e151d 1253 int64_t msg_ns_from_origin;
7474e7d3 1254 const struct bt_clock_snapshot *clk_snapshot = NULL;
5b9e151d
PP
1255 int ret;
1256
98b15851
PP
1257 BT_ASSERT_DBG(msg);
1258 BT_ASSERT_DBG(got_first);
7474e7d3
PP
1259
1260 switch (msg->type) {
1261 case BT_MESSAGE_TYPE_EVENT:
1262 {
1263 const struct bt_message_event *event_msg =
1264 (const void *) msg;
1265
2c091c04 1266 clk_snapshot = event_msg->default_cs;
1778c2a4
PP
1267 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
1268 "event-message-has-default-clock-snapshot",
1269 clk_snapshot,
c7072d5a
PP
1270 "Event message has no default clock snapshot: %!+n",
1271 event_msg);
7474e7d3
PP
1272 break;
1273 }
b9fd9cbb 1274 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
7474e7d3 1275 {
b9fd9cbb 1276 const struct bt_message_message_iterator_inactivity *inactivity_msg =
7474e7d3
PP
1277 (const void *) msg;
1278
60d02328 1279 clk_snapshot = inactivity_msg->cs;
98b15851 1280 BT_ASSERT_DBG(clk_snapshot);
7474e7d3
PP
1281 break;
1282 }
16663a5e
PP
1283 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
1284 case BT_MESSAGE_TYPE_PACKET_END:
c7072d5a
PP
1285 {
1286 const struct bt_message_packet *packet_msg =
1287 (const void *) msg;
1288
ed3039e4
SM
1289 if (msg->type == BT_MESSAGE_TYPE_PACKET_BEGINNING
1290 && !packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) {
1291 goto skip_msg;
1292 }
1293
1294 if (msg->type == BT_MESSAGE_TYPE_PACKET_END
1295 && !packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) {
1296 goto skip_msg;
1297 }
1298
c7072d5a 1299 clk_snapshot = packet_msg->default_cs;
1778c2a4
PP
1300 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
1301 "packet-message-has-default-clock-snapshot",
1302 clk_snapshot,
c7072d5a
PP
1303 "Packet message has no default clock snapshot: %!+n",
1304 packet_msg);
1305 break;
1306 }
16663a5e
PP
1307 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1308 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
7474e7d3 1309 {
5b9e151d
PP
1310 struct bt_message_discarded_items *msg_disc_items =
1311 (void *) msg;
1312
ed3039e4
SM
1313 if (msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS &&
1314 !msg_disc_items->stream->class->discarded_events_have_default_clock_snapshots) {
1315 goto skip_msg;
1316 }
1317
1318 if (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS &&
1319 !msg_disc_items->stream->class->discarded_packets_have_default_clock_snapshots) {
1320 goto skip_msg;
1321 }
1322
1778c2a4
PP
1323 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
1324 "discarded-events-packets-message-has-default-clock-snapshot",
1325 msg_disc_items->default_begin_cs &&
1326 msg_disc_items->default_end_cs,
5b9e151d
PP
1327 "Discarded events/packets message has no default clock snapshots: %!+n",
1328 msg_disc_items);
1329 ret = bt_clock_snapshot_get_ns_from_origin(
1330 msg_disc_items->default_begin_cs,
1331 &msg_ns_from_origin);
1332 if (ret) {
d24d5663 1333 status = BT_FUNC_STATUS_ERROR;
5b9e151d
PP
1334 goto end;
1335 }
7474e7d3 1336
5b9e151d
PP
1337 if (msg_ns_from_origin >= ns_from_origin) {
1338 *got_first = true;
1339 goto push_msg;
1340 }
1341
1342 ret = bt_clock_snapshot_get_ns_from_origin(
1343 msg_disc_items->default_end_cs,
1344 &msg_ns_from_origin);
1345 if (ret) {
d24d5663 1346 status = BT_FUNC_STATUS_ERROR;
5b9e151d
PP
1347 goto end;
1348 }
1349
1350 if (msg_ns_from_origin >= ns_from_origin) {
1351 /*
1352 * The discarded items message's beginning time
1353 * is before the requested seeking time, but its
1354 * end time is after. Modify the message so as
1355 * to set its beginning time to the requested
1356 * seeking time, and make its item count unknown
1357 * as we don't know if items were really
1358 * discarded within the new time range.
1359 */
4af85094 1360 uint64_t new_begin_raw_value = 0;
5b9e151d
PP
1361
1362 ret = bt_clock_class_clock_value_from_ns_from_origin(
1363 msg_disc_items->default_end_cs->clock_class,
1364 ns_from_origin, &new_begin_raw_value);
1365 if (ret) {
d24d5663 1366 status = BT_FUNC_STATUS_ERROR;
5b9e151d
PP
1367 goto end;
1368 }
1369
1370 bt_clock_snapshot_set_raw_value(
1371 msg_disc_items->default_begin_cs,
1372 new_begin_raw_value);
1373 msg_disc_items->count.base.avail =
1374 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE;
1375
1376 /*
1377 * It is safe to push it because its beginning
1378 * time is exactly the requested seeking time.
1379 */
1380 goto push_msg;
1381 } else {
1382 goto skip_msg;
1383 }
7474e7d3 1384 }
188edac1
SM
1385 case BT_MESSAGE_TYPE_STREAM_BEGINNING:
1386 case BT_MESSAGE_TYPE_STREAM_END:
7474e7d3 1387 {
188edac1
SM
1388 struct bt_message_stream *stream_msg =
1389 (struct bt_message_stream *) msg;
7474e7d3 1390
188edac1
SM
1391 if (stream_msg->default_cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
1392 /* Ignore */
5b9e151d 1393 goto skip_msg;
16663a5e
PP
1394 }
1395
188edac1 1396 clk_snapshot = stream_msg->default_cs;
7474e7d3
PP
1397 break;
1398 }
1399 default:
498e7994 1400 bt_common_abort();
7474e7d3
PP
1401 }
1402
98b15851 1403 BT_ASSERT_DBG(clk_snapshot);
5b9e151d
PP
1404 ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot,
1405 &msg_ns_from_origin);
1406 if (ret) {
d24d5663 1407 status = BT_FUNC_STATUS_ERROR;
7474e7d3
PP
1408 goto end;
1409 }
1410
5b9e151d
PP
1411 if (msg_ns_from_origin >= ns_from_origin) {
1412 *got_first = true;
1413 goto push_msg;
1414 }
1415
1416skip_msg:
5b7b55be
SM
1417 /* This message won't be sent downstream. */
1418 switch (msg->type) {
1419 case BT_MESSAGE_TYPE_STREAM_BEGINNING:
1420 {
1421 const struct bt_message_stream *stream_msg = (const void *) msg;
1422 struct auto_seek_stream_state *stream_state;
5b7b55be
SM
1423
1424 /* Update stream's state: stream began. */
1425 stream_state = create_auto_seek_stream_state();
1426 if (!stream_state) {
d24d5663 1427 status = BT_FUNC_STATUS_MEMORY_ERROR;
5b7b55be
SM
1428 goto end;
1429 }
1430
1431 stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN;
e74dbb33 1432
188edac1
SM
1433 if (stream_msg->default_cs_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) {
1434 stream_state->seen_clock_snapshot = true;
1435 }
1436
98b15851 1437 BT_ASSERT_DBG(!bt_g_hash_table_contains(stream_states, stream_msg->stream));
e74dbb33 1438 g_hash_table_insert(stream_states, stream_msg->stream, stream_state);
5b7b55be
SM
1439 break;
1440 }
188edac1 1441 case BT_MESSAGE_TYPE_PACKET_BEGINNING:
5b7b55be 1442 {
188edac1 1443 const struct bt_message_packet *packet_msg =
5b7b55be
SM
1444 (const void *) msg;
1445 struct auto_seek_stream_state *stream_state;
1446
188edac1
SM
1447 /* Update stream's state: packet began. */
1448 stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream);
98b15851
PP
1449 BT_ASSERT_DBG(stream_state);
1450 BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN);
188edac1 1451 stream_state->state = AUTO_SEEK_STREAM_STATE_PACKET_BEGAN;
98b15851 1452 BT_ASSERT_DBG(!stream_state->packet);
188edac1
SM
1453 stream_state->packet = packet_msg->packet;
1454
1455 if (packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) {
1456 stream_state->seen_clock_snapshot = true;
1457 }
1458
5b7b55be
SM
1459 break;
1460 }
188edac1 1461 case BT_MESSAGE_TYPE_EVENT:
5b7b55be 1462 {
188edac1 1463 const struct bt_message_event *event_msg = (const void *) msg;
5b7b55be
SM
1464 struct auto_seek_stream_state *stream_state;
1465
188edac1 1466 stream_state = g_hash_table_lookup(stream_states,
03cc4222 1467 event_msg->event->stream);
98b15851 1468 BT_ASSERT_DBG(stream_state);
5b7b55be 1469
188edac1
SM
1470 // HELPME: are we sure that event messages have clock snapshots at this point?
1471 stream_state->seen_clock_snapshot = true;
1472
5b7b55be
SM
1473 break;
1474 }
1475 case BT_MESSAGE_TYPE_PACKET_END:
1476 {
1477 const struct bt_message_packet *packet_msg =
1478 (const void *) msg;
1479 struct auto_seek_stream_state *stream_state;
1480
1481 /* Update stream's state: packet ended. */
1482 stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream);
98b15851
PP
1483 BT_ASSERT_DBG(stream_state);
1484 BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_PACKET_BEGAN);
188edac1 1485 stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN;
98b15851 1486 BT_ASSERT_DBG(stream_state->packet);
5b7b55be 1487 stream_state->packet = NULL;
5b7b55be 1488
188edac1
SM
1489 if (packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) {
1490 stream_state->seen_clock_snapshot = true;
1491 }
5b7b55be 1492
5b7b55be
SM
1493 break;
1494 }
1495 case BT_MESSAGE_TYPE_STREAM_END:
1496 {
1497 const struct bt_message_stream *stream_msg = (const void *) msg;
1498 struct auto_seek_stream_state *stream_state;
1499
1500 stream_state = g_hash_table_lookup(stream_states, stream_msg->stream);
98b15851
PP
1501 BT_ASSERT_DBG(stream_state);
1502 BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN);
1503 BT_ASSERT_DBG(!stream_state->packet);
5b7b55be
SM
1504
1505 /* Update stream's state: this stream doesn't exist anymore. */
1506 g_hash_table_remove(stream_states, stream_msg->stream);
1507 break;
1508 }
188edac1
SM
1509 case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
1510 case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
1511 {
1512 const struct bt_message_discarded_items *discarded_msg =
1513 (const void *) msg;
1514 struct auto_seek_stream_state *stream_state;
1515
1516 stream_state = g_hash_table_lookup(stream_states, discarded_msg->stream);
98b15851 1517 BT_ASSERT_DBG(stream_state);
188edac1
SM
1518
1519 if ((msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS && discarded_msg->stream->class->discarded_events_have_default_clock_snapshots) ||
1520 (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS && discarded_msg->stream->class->discarded_packets_have_default_clock_snapshots)) {
1521 stream_state->seen_clock_snapshot = true;
1522 }
1523
1524 break;
1525 }
5b7b55be
SM
1526 default:
1527 break;
1528 }
1529
6871026b 1530 bt_object_put_ref_no_null_check(msg);
04c0cec6 1531 msg = NULL;
5b9e151d
PP
1532 goto end;
1533
1534push_msg:
da9c4c52 1535 g_queue_push_tail(iterator->auto_seek.msgs, (void *) msg);
5b9e151d 1536 msg = NULL;
7474e7d3
PP
1537
1538end:
98b15851 1539 BT_ASSERT_DBG(!msg || status != BT_FUNC_STATUS_OK);
5b9e151d 1540 return status;
7474e7d3
PP
1541}
1542
1543static
d24d5663 1544int find_message_ge_ns_from_origin(
9a2c8b8e 1545 struct bt_message_iterator *iterator,
5b7b55be 1546 int64_t ns_from_origin, GHashTable *stream_states)
7474e7d3 1547{
c70a96a6 1548 int status = BT_FUNC_STATUS_OK;
9a2c8b8e 1549 enum bt_message_iterator_state init_state =
7474e7d3
PP
1550 iterator->state;
1551 const struct bt_message *messages[MSG_BATCH_SIZE];
1552 uint64_t user_count = 0;
1553 uint64_t i;
5b9e151d 1554 bool got_first = false;
7474e7d3 1555
98b15851 1556 BT_ASSERT_DBG(iterator);
7474e7d3
PP
1557 memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE);
1558
1559 /*
1560 * Make this iterator temporarily active (not seeking) to call
1561 * the "next" method.
1562 */
9a2c8b8e
PP
1563 set_msg_iterator_state(iterator,
1564 BT_MESSAGE_ITERATOR_STATE_ACTIVE);
7474e7d3 1565
98b15851 1566 BT_ASSERT_DBG(iterator->methods.next);
7474e7d3 1567
e0dade92 1568 while (!got_first) {
7474e7d3
PP
1569 /*
1570 * Call the user's "next" method to get the next
1571 * messages and status.
1572 */
54b135a0 1573 status = call_iterator_next_method(iterator,
7474e7d3 1574 &messages[0], MSG_BATCH_SIZE, &user_count);
870631a2
PP
1575 BT_LOGD("User method returned: status=%s",
1576 bt_common_func_status_string(status));
1577 if (status < 0) {
1578 BT_LIB_LOGW_APPEND_CAUSE(
1579 "Component input port message iterator's \"next\" method failed: "
1580 "%![iter-]+i, status=%s",
1581 iterator, bt_common_func_status_string(status));
1582 }
7474e7d3 1583
7474e7d3
PP
1584 /*
1585 * The user's "next" method must not do any action which
1586 * would change the iterator's state.
1587 */
98b15851 1588 BT_ASSERT_DBG(iterator->state ==
9a2c8b8e 1589 BT_MESSAGE_ITERATOR_STATE_ACTIVE);
7474e7d3
PP
1590
1591 switch (status) {
d24d5663 1592 case BT_FUNC_STATUS_OK:
1778c2a4
PP
1593 BT_ASSERT_POST_DEV(NEXT_METHOD_NAME,
1594 "count-lteq-capacity",
1595 user_count <= MSG_BATCH_SIZE,
7474e7d3
PP
1596 "Invalid returned message count: greater than "
1597 "batch size: count=%" PRIu64 ", batch-size=%u",
1598 user_count, MSG_BATCH_SIZE);
1599 break;
d24d5663
PP
1600 case BT_FUNC_STATUS_AGAIN:
1601 case BT_FUNC_STATUS_ERROR:
1602 case BT_FUNC_STATUS_MEMORY_ERROR:
1603 case BT_FUNC_STATUS_END:
7474e7d3
PP
1604 goto end;
1605 default:
498e7994 1606 bt_common_abort();
7474e7d3
PP
1607 }
1608
7474e7d3 1609 for (i = 0; i < user_count; i++) {
5b9e151d 1610 if (got_first) {
da9c4c52 1611 g_queue_push_tail(iterator->auto_seek.msgs,
5b9e151d
PP
1612 (void *) messages[i]);
1613 messages[i] = NULL;
7474e7d3
PP
1614 continue;
1615 }
1616
5b9e151d 1617 status = auto_seek_handle_message(iterator,
5b7b55be
SM
1618 ns_from_origin, messages[i], &got_first,
1619 stream_states);
d24d5663 1620 if (status == BT_FUNC_STATUS_OK) {
e0dade92 1621 /* Message was either pushed or moved */
5b9e151d
PP
1622 messages[i] = NULL;
1623 } else {
7474e7d3
PP
1624 goto end;
1625 }
7474e7d3
PP
1626 }
1627 }
1628
1629end:
1630 for (i = 0; i < user_count; i++) {
1631 if (messages[i]) {
6871026b 1632 bt_object_put_ref_no_null_check(messages[i]);
7474e7d3
PP
1633 }
1634 }
1635
9a2c8b8e 1636 set_msg_iterator_state(iterator, init_state);
7474e7d3
PP
1637 return status;
1638}
1639
5b7b55be
SM
1640/*
1641 * This function is installed as the iterator's next callback after we have
1642 * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1643 * messages saved in iterator->auto_seek.msgs. Once this is done, the original
1644 * next callback is put back.
1645 */
1646
7474e7d3 1647static
a3f0c7db 1648enum bt_message_iterator_class_next_method_status post_auto_seek_next(
9a2c8b8e 1649 struct bt_message_iterator *iterator,
7474e7d3
PP
1650 bt_message_array_const msgs, uint64_t capacity,
1651 uint64_t *count)
1652{
da9c4c52 1653 BT_ASSERT(!g_queue_is_empty(iterator->auto_seek.msgs));
5b9e151d 1654 *count = 0;
7474e7d3
PP
1655
1656 /*
1657 * Move auto-seek messages to the output array (which is this
5b9e151d 1658 * iterator's base message array).
7474e7d3 1659 */
da9c4c52
SM
1660 while (capacity > 0 && !g_queue_is_empty(iterator->auto_seek.msgs)) {
1661 msgs[*count] = g_queue_pop_head(iterator->auto_seek.msgs);
5b9e151d
PP
1662 capacity--;
1663 (*count)++;
7474e7d3 1664 }
7474e7d3 1665
5b9e151d
PP
1666 BT_ASSERT(*count > 0);
1667
da9c4c52 1668 if (g_queue_is_empty(iterator->auto_seek.msgs)) {
572075a8
SM
1669 /* No more auto-seek messages, restore user's next callback. */
1670 BT_ASSERT(iterator->auto_seek.original_next_callback);
1671 iterator->methods.next = iterator->auto_seek.original_next_callback;
1672 iterator->auto_seek.original_next_callback = NULL;
7474e7d3
PP
1673 }
1674
d24d5663 1675 return BT_FUNC_STATUS_OK;
7474e7d3
PP
1676}
1677
5b7b55be
SM
1678static inline
1679int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class,
1680 int64_t ns_from_origin, uint64_t *raw_value)
1681{
1682
1683 int64_t cc_offset_s = clock_class->offset_seconds;
1684 uint64_t cc_offset_cycles = clock_class->offset_cycles;
1685 uint64_t cc_freq = clock_class->frequency;
1686
1687 return bt_common_clock_value_from_ns_from_origin(cc_offset_s,
1688 cc_offset_cycles, cc_freq, ns_from_origin, raw_value);
1689}
1690
f2fb1b32
SM
1691static
1692bool message_iterator_can_seek_ns_from_origin(
9a2c8b8e 1693 struct bt_message_iterator *iterator,
f2fb1b32
SM
1694 int64_t ns_from_origin)
1695{
1696 enum bt_message_iterator_can_seek_ns_from_origin_status status;
1697 bt_bool can_seek;
1698
9a2c8b8e 1699 status = bt_message_iterator_can_seek_ns_from_origin(
f2fb1b32
SM
1700 iterator, ns_from_origin, &can_seek);
1701 if (status != BT_FUNC_STATUS_OK) {
1702 can_seek = BT_FALSE;
1703 }
1704
1705 return can_seek;
1706}
5b7b55be 1707
1778c2a4
PP
1708#define SEEK_NS_FROM_ORIGIN_METHOD_NAME \
1709 "bt_message_iterator_class_seek_ns_from_origin_method"
1710
1711
d24d5663 1712enum bt_message_iterator_seek_ns_from_origin_status
9a2c8b8e
PP
1713bt_message_iterator_seek_ns_from_origin(
1714 struct bt_message_iterator *iterator,
7474e7d3
PP
1715 int64_t ns_from_origin)
1716{
1717 int status;
5b7b55be 1718 GHashTable *stream_states = NULL;
c0e46a7c 1719 bt_bool can_seek_by_itself;
7474e7d3 1720
17f3083a 1721 BT_ASSERT_PRE_NO_ERROR();
d5b13b9b 1722 BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
7474e7d3 1723 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
1778c2a4 1724 BT_ASSERT_PRE("graph-is-configured",
5badd463
PP
1725 bt_component_borrow_graph(iterator->upstream_component)->config_state !=
1726 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
7474e7d3
PP
1727 "Graph is not configured: %!+g",
1728 bt_component_borrow_graph(iterator->upstream_component));
c0e46a7c 1729 /* The iterator must be able to seek ns from origin one way or another. */
1778c2a4 1730 BT_ASSERT_PRE("can-seek-ns-from-origin",
f2fb1b32 1731 message_iterator_can_seek_ns_from_origin(iterator, ns_from_origin),
7474e7d3
PP
1732 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1733 "ns-from-origin=%" PRId64, iterator, ns_from_origin);
9a2c8b8e
PP
1734 set_msg_iterator_state(iterator,
1735 BT_MESSAGE_ITERATOR_STATE_SEEKING);
7474e7d3 1736
54b135a0
SM
1737 /*
1738 * We are seeking, reset our expectations about how the following
1739 * messages should look like.
1740 */
1741 reset_iterator_expectations(iterator);
1742
c0e46a7c
SM
1743 /* Check if the iterator can seek by itself. If not we'll use autoseek. */
1744 if (iterator->methods.can_seek_ns_from_origin) {
a3f0c7db 1745 bt_message_iterator_class_can_seek_ns_from_origin_method_status
c0e46a7c
SM
1746 can_seek_status;
1747
1748 can_seek_status =
1749 iterator->methods.can_seek_ns_from_origin(
1750 iterator, ns_from_origin, &can_seek_by_itself);
1751 if (can_seek_status != BT_FUNC_STATUS_OK) {
1752 status = can_seek_status;
1753 goto end;
1754 }
1755 } else {
1756 can_seek_by_itself = false;
1757 }
1758
1759 if (can_seek_by_itself) {
5b7b55be 1760 /* The iterator knows how to seek to a particular time, let it handle this. */
2e1b5615 1761 BT_ASSERT(iterator->methods.seek_ns_from_origin);
7474e7d3
PP
1762 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1763 "%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin);
1764 status = iterator->methods.seek_ns_from_origin(iterator,
1765 ns_from_origin);
1766 BT_LOGD("User method returned: status=%s",
d24d5663 1767 bt_common_func_status_string(status));
1778c2a4
PP
1768 BT_ASSERT_POST(SEEK_NS_FROM_ORIGIN_METHOD_NAME, "valid-status",
1769 status == BT_FUNC_STATUS_OK ||
d24d5663
PP
1770 status == BT_FUNC_STATUS_ERROR ||
1771 status == BT_FUNC_STATUS_MEMORY_ERROR ||
1772 status == BT_FUNC_STATUS_AGAIN,
7474e7d3 1773 "Unexpected status: %![iter-]+i, status=%s",
d24d5663 1774 iterator, bt_common_func_status_string(status));
1778c2a4
PP
1775 BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(
1776 SEEK_NS_FROM_ORIGIN_METHOD_NAME, status);
870631a2
PP
1777 if (status < 0) {
1778 BT_LIB_LOGW_APPEND_CAUSE(
1779 "Component input port message iterator's \"seek nanoseconds from origin\" method failed: "
1780 "%![iter-]+i, status=%s",
1781 iterator, bt_common_func_status_string(status));
1782 }
7474e7d3 1783 } else {
5b7b55be 1784 /*
c0e46a7c
SM
1785 * The iterator doesn't know how to seek by itself to a
1786 * particular time. We will seek to the beginning and fast
1787 * forward to the right place.
5b7b55be 1788 */
a3f0c7db 1789 enum bt_message_iterator_class_can_seek_beginning_method_status can_seek_status;
f2fb1b32
SM
1790 bt_bool can_seek_beginning;
1791
1792 can_seek_status = iterator->methods.can_seek_beginning(iterator,
1793 &can_seek_beginning);
1794 BT_ASSERT(can_seek_status == BT_FUNC_STATUS_OK);
1795 BT_ASSERT(can_seek_beginning);
7474e7d3
PP
1796 BT_ASSERT(iterator->methods.seek_beginning);
1797 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1798 iterator);
1799 status = iterator->methods.seek_beginning(iterator);
1800 BT_LOGD("User method returned: status=%s",
d24d5663 1801 bt_common_func_status_string(status));
1778c2a4
PP
1802 BT_ASSERT_POST(SEEK_BEGINNING_METHOD_NAME, "valid-status",
1803 status == BT_FUNC_STATUS_OK ||
d24d5663
PP
1804 status == BT_FUNC_STATUS_ERROR ||
1805 status == BT_FUNC_STATUS_MEMORY_ERROR ||
1806 status == BT_FUNC_STATUS_AGAIN,
7474e7d3 1807 "Unexpected status: %![iter-]+i, status=%s",
d24d5663 1808 iterator, bt_common_func_status_string(status));
870631a2
PP
1809 if (status < 0) {
1810 BT_LIB_LOGW_APPEND_CAUSE(
1811 "Component input port message iterator's \"seek beginning\" method failed: "
1812 "%![iter-]+i, status=%s",
1813 iterator, bt_common_func_status_string(status));
1814 }
1815
7474e7d3 1816 switch (status) {
d24d5663 1817 case BT_FUNC_STATUS_OK:
7474e7d3 1818 break;
d24d5663
PP
1819 case BT_FUNC_STATUS_ERROR:
1820 case BT_FUNC_STATUS_MEMORY_ERROR:
1821 case BT_FUNC_STATUS_AGAIN:
7474e7d3
PP
1822 goto end;
1823 default:
498e7994 1824 bt_common_abort();
7474e7d3
PP
1825 }
1826
1827 /*
1828 * Find the first message which has a default clock
1829 * snapshot greater than or equal to the requested
5b9e151d
PP
1830 * seeking time, and move the received messages from
1831 * this point in the batch to this iterator's auto-seek
1832 * message queue.
7474e7d3 1833 */
da9c4c52 1834 while (!g_queue_is_empty(iterator->auto_seek.msgs)) {
6871026b 1835 bt_object_put_ref_no_null_check(
da9c4c52 1836 g_queue_pop_tail(iterator->auto_seek.msgs));
5b9e151d
PP
1837 }
1838
5b7b55be
SM
1839 stream_states = create_auto_seek_stream_states();
1840 if (!stream_states) {
870631a2
PP
1841 BT_LIB_LOGE_APPEND_CAUSE(
1842 "Failed to allocate one GHashTable.");
d24d5663 1843 status = BT_FUNC_STATUS_MEMORY_ERROR;
5b7b55be
SM
1844 goto end;
1845 }
1846
7474e7d3 1847 status = find_message_ge_ns_from_origin(iterator,
5b7b55be 1848 ns_from_origin, stream_states);
7474e7d3 1849 switch (status) {
d24d5663
PP
1850 case BT_FUNC_STATUS_OK:
1851 case BT_FUNC_STATUS_END:
5b7b55be
SM
1852 {
1853 GHashTableIter iter;
1854 gpointer key, value;
1855
1856 /*
1857 * If some streams exist at the seek time, prepend the
1858 * required messages to put those streams in the right
1859 * state.
1860 */
1861 g_hash_table_iter_init(&iter, stream_states);
1862 while (g_hash_table_iter_next (&iter, &key, &value)) {
1863 const bt_stream *stream = key;
1864 struct auto_seek_stream_state *stream_state =
1865 (struct auto_seek_stream_state *) value;
1866 bt_message *msg;
1867 const bt_clock_class *clock_class = bt_stream_class_borrow_default_clock_class_const(
1868 bt_stream_borrow_class_const(stream));
188edac1
SM
1869 /* Initialize to silence maybe-uninitialized warning. */
1870 uint64_t raw_value = 0;
1871
1872 /*
1873 * If we haven't seen a message with a clock snapshot, we don't know if our seek time is within
1874 * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value.
1875 *
1876 * Also, it would be a bit of a lie to generate a stream begin message with the seek time as its
1877 * clock snapshot, because we don't really know if the stream existed at that time. If we have
1878 * seen a message with a clock snapshot in our seeking, then we are sure that the
1879 * seek time is not below the clock range, and we know the stream was active at that
1880 * time (and that we cut it short).
1881 */
1882 if (stream_state->seen_clock_snapshot) {
1883 if (clock_raw_value_from_ns_from_origin(clock_class, ns_from_origin, &raw_value) != 0) {
1884 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64 ", %![cc-]+K",
1885 ns_from_origin, clock_class);
1886 status = BT_FUNC_STATUS_ERROR;
1887 goto end;
1888 }
5b7b55be
SM
1889 }
1890
1891 switch (stream_state->state) {
1892 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN:
1893 BT_ASSERT(stream_state->packet);
1894 BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state->packet);
188edac1
SM
1895
1896 if (stream->class->packets_have_beginning_default_clock_snapshot) {
1897 /*
1898 * If we are in the PACKET_BEGAN state, it means we have seen a "packet beginning"
1899 * message. If "packet beginning" packets have clock snapshots, then we must have
1900 * seen a clock snapshot.
1901 */
1902 BT_ASSERT(stream_state->seen_clock_snapshot);
1903
1904 msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
1905 (bt_self_message_iterator *) iterator, stream_state->packet, raw_value);
1906 } else {
1907 msg = bt_message_packet_beginning_create((bt_self_message_iterator *) iterator,
1908 stream_state->packet);
5b7b55be
SM
1909 }
1910
5b7b55be 1911 if (!msg) {
d24d5663 1912 status = BT_FUNC_STATUS_MEMORY_ERROR;
5b7b55be
SM
1913 goto end;
1914 }
1915
5b7b55be
SM
1916 g_queue_push_head(iterator->auto_seek.msgs, msg);
1917 msg = NULL;
1918 /* fall-thru */
188edac1 1919
5b7b55be
SM
1920 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN:
1921 msg = bt_message_stream_beginning_create(
1922 (bt_self_message_iterator *) iterator, stream);
1923 if (!msg) {
d24d5663 1924 status = BT_FUNC_STATUS_MEMORY_ERROR;
5b7b55be
SM
1925 goto end;
1926 }
1927
188edac1
SM
1928 if (stream_state->seen_clock_snapshot) {
1929 bt_message_stream_beginning_set_default_clock_snapshot(msg, raw_value);
1930 }
1931
5b7b55be
SM
1932 g_queue_push_head(iterator->auto_seek.msgs, msg);
1933 msg = NULL;
1934 break;
1935 }
1936 }
1937
7474e7d3 1938 /*
5b9e151d
PP
1939 * If there are messages in the auto-seek
1940 * message queue, replace the user's "next"
1941 * method with a custom, temporary "next" method
1942 * which returns them.
7474e7d3 1943 */
da9c4c52 1944 if (!g_queue_is_empty(iterator->auto_seek.msgs)) {
572075a8
SM
1945 BT_ASSERT(!iterator->auto_seek.original_next_callback);
1946 iterator->auto_seek.original_next_callback = iterator->methods.next;
1947
5b9e151d 1948 iterator->methods.next =
9a2c8b8e 1949 (bt_message_iterator_next_method)
5b9e151d
PP
1950 post_auto_seek_next;
1951 }
1952
1953 /*
d24d5663
PP
1954 * `BT_FUNC_STATUS_END` becomes
1955 * `BT_FUNC_STATUS_OK`: the next
5b9e151d
PP
1956 * time this iterator's "next" method is called,
1957 * it will return
d24d5663 1958 * `BT_FUNC_STATUS_END`.
5b9e151d 1959 */
d24d5663 1960 status = BT_FUNC_STATUS_OK;
7474e7d3 1961 break;
5b7b55be 1962 }
d24d5663
PP
1963 case BT_FUNC_STATUS_ERROR:
1964 case BT_FUNC_STATUS_MEMORY_ERROR:
1965 case BT_FUNC_STATUS_AGAIN:
7474e7d3 1966 goto end;
7474e7d3 1967 default:
498e7994 1968 bt_common_abort();
7474e7d3
PP
1969 }
1970 }
1971
54b135a0
SM
1972 /*
1973 * The following messages returned by the next method (including
1974 * post_auto_seek_next) must be after (or at) `ns_from_origin`.
1975 */
1976 iterator->last_ns_from_origin = ns_from_origin;
1977
7474e7d3 1978end:
5b7b55be
SM
1979 if (stream_states) {
1980 destroy_auto_seek_stream_states(stream_states);
1981 stream_states = NULL;
1982 }
870631a2 1983
7474e7d3 1984 set_iterator_state_after_seeking(iterator, status);
7474e7d3
PP
1985 return status;
1986}
1987
9b4f9b42
PP
1988bt_bool bt_self_message_iterator_is_interrupted(
1989 const struct bt_self_message_iterator *self_msg_iter)
1990{
9a2c8b8e 1991 const struct bt_message_iterator *iterator =
9b4f9b42
PP
1992 (const void *) self_msg_iter;
1993
d5b13b9b 1994 BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator);
9b4f9b42
PP
1995 return (bt_bool) bt_graph_is_interrupted(iterator->graph);
1996}
1997
9a2c8b8e
PP
1998void bt_message_iterator_get_ref(
1999 const struct bt_message_iterator *iterator)
c5b9b441
PP
2000{
2001 bt_object_get_ref(iterator);
2002}
2003
9a2c8b8e
PP
2004void bt_message_iterator_put_ref(
2005 const struct bt_message_iterator *iterator)
c5b9b441
PP
2006{
2007 bt_object_put_ref(iterator);
2008}
This page took 0.194817 seconds and 4 git commands to generate.