2 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
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
24 #define BT_LOG_TAG "LIB/MSG-ITER"
25 #include "lib/logging.h"
27 #include "compat/compiler.h"
28 #include "compat/glib.h"
29 #include "lib/trace-ir/clock-class.h"
30 #include "lib/trace-ir/clock-snapshot.h"
31 #include <babeltrace2/trace-ir/field.h>
32 #include <babeltrace2/trace-ir/event-const.h>
33 #include "lib/trace-ir/event.h"
34 #include <babeltrace2/trace-ir/packet-const.h>
35 #include "lib/trace-ir/packet.h"
36 #include "lib/trace-ir/stream.h"
37 #include <babeltrace2/trace-ir/clock-class-const.h>
38 #include <babeltrace2/trace-ir/stream-class-const.h>
39 #include <babeltrace2/trace-ir/stream-const.h>
40 #include <babeltrace2/graph/connection-const.h>
41 #include <babeltrace2/graph/component-const.h>
42 #include <babeltrace2/graph/component-sink-const.h>
43 #include <babeltrace2/graph/message-const.h>
44 #include <babeltrace2/graph/message-iterator.h>
45 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
46 #include <babeltrace2/graph/message-event-const.h>
47 #include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
48 #include <babeltrace2/graph/message-packet-beginning.h>
49 #include <babeltrace2/graph/message-packet-beginning-const.h>
50 #include <babeltrace2/graph/message-packet-end-const.h>
51 #include <babeltrace2/graph/message-stream-beginning.h>
52 #include <babeltrace2/graph/message-stream-beginning-const.h>
53 #include <babeltrace2/graph/message-stream-end-const.h>
54 #include <babeltrace2/graph/port-const.h>
55 #include <babeltrace2/graph/graph.h>
56 #include <babeltrace2/graph/graph-const.h>
57 #include <babeltrace2/types.h>
58 #include "common/assert.h"
59 #include "lib/assert-pre.h"
60 #include "lib/assert-post.h"
65 #include "component-class.h"
66 #include "component.h"
67 #include "component-sink.h"
68 #include "component-source.h"
69 #include "connection.h"
71 #include "message/discarded-items.h"
72 #include "message/event.h"
73 #include "message/iterator.h"
74 #include "message/message.h"
75 #include "message/message-iterator-inactivity.h"
76 #include "message/stream.h"
77 #include "message/packet.h"
78 #include "lib/func-status.h"
81 * TODO: Use graph's state (number of active iterators, etc.) and
82 * possibly system specifications to make a better guess than this.
84 #define MSG_BATCH_SIZE 15
86 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
87 BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
88 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
89 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
90 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
91 "Message iterator is in the wrong state: %!+i", _iter)
94 void set_self_comp_port_input_msg_iterator_state(
95 struct bt_self_component_port_input_message_iterator
*iterator
,
96 enum bt_self_component_port_input_message_iterator_state state
)
99 BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
100 bt_self_component_port_input_message_iterator_state_string(state
));
101 iterator
->state
= state
;
105 void bt_self_component_port_input_message_iterator_destroy(struct bt_object
*obj
)
107 struct bt_self_component_port_input_message_iterator
*iterator
;
112 * The message iterator's reference count is 0 if we're
113 * here. Increment it to avoid a double-destroy (possibly
114 * infinitely recursive). This could happen for example if the
115 * message iterator's finalization function does
116 * bt_object_get_ref() (or anything that causes
117 * bt_object_get_ref() to be called) on itself (ref. count goes
118 * from 0 to 1), and then bt_object_put_ref(): the reference
119 * count would go from 1 to 0 again and this function would be
123 iterator
= (void *) obj
;
124 BT_LIB_LOGI("Destroying self component input port message iterator object: "
126 bt_self_component_port_input_message_iterator_try_finalize(iterator
);
128 if (iterator
->connection
) {
130 * Remove ourself from the originating connection so
131 * that it does not try to finalize a dangling pointer
134 bt_connection_remove_iterator(iterator
->connection
, iterator
);
135 iterator
->connection
= NULL
;
138 if (iterator
->auto_seek
.msgs
) {
139 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
140 bt_object_put_no_null_check(
141 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
144 g_queue_free(iterator
->auto_seek
.msgs
);
145 iterator
->auto_seek
.msgs
= NULL
;
148 if (iterator
->upstream_msg_iters
) {
150 * At this point the message iterator is finalized, so
151 * it's detached from any upstream message iterator.
153 BT_ASSERT(iterator
->upstream_msg_iters
->len
== 0);
154 g_ptr_array_free(iterator
->upstream_msg_iters
, TRUE
);
155 iterator
->upstream_msg_iters
= NULL
;
158 if (iterator
->msgs
) {
159 g_ptr_array_free(iterator
->msgs
, TRUE
);
160 iterator
->msgs
= NULL
;
167 void bt_self_component_port_input_message_iterator_try_finalize(
168 struct bt_self_component_port_input_message_iterator
*iterator
)
171 typedef void (*method_t
)(void *);
173 struct bt_component_class
*comp_class
= NULL
;
174 method_t method
= NULL
;
178 switch (iterator
->state
) {
179 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
:
180 /* Skip user finalization if user initialization failed */
181 BT_LIB_LOGD("Not finalizing non-initialized message iterator: "
184 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
:
185 /* Already finalized */
186 BT_LIB_LOGD("Not finalizing message iterator: already finalized: "
189 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
:
191 BT_LIB_LOGF("Message iterator is already being finalized: "
198 BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator
);
199 set_self_comp_port_input_msg_iterator_state(iterator
,
200 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
);
201 BT_ASSERT(iterator
->upstream_component
);
202 comp_class
= iterator
->upstream_component
->class;
204 /* Call user-defined destroy method */
205 switch (comp_class
->type
) {
206 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
208 struct bt_component_class_source
*src_comp_cls
=
211 method
= (method_t
) src_comp_cls
->methods
.msg_iter_finalize
;
214 case BT_COMPONENT_CLASS_TYPE_FILTER
:
216 struct bt_component_class_filter
*flt_comp_cls
=
219 method
= (method_t
) flt_comp_cls
->methods
.msg_iter_finalize
;
228 BT_LIB_LOGD("Calling user's finalization method: %!+i",
233 /* Detach upstream message iterators */
234 for (i
= 0; i
< iterator
->upstream_msg_iters
->len
; i
++) {
235 struct bt_self_component_port_input_message_iterator
*upstream_msg_iter
=
236 iterator
->upstream_msg_iters
->pdata
[i
];
238 upstream_msg_iter
->downstream_msg_iter
= NULL
;
241 g_ptr_array_set_size(iterator
->upstream_msg_iters
, 0);
243 /* Detach downstream message iterator */
244 if (iterator
->downstream_msg_iter
) {
247 BT_ASSERT(iterator
->downstream_msg_iter
->upstream_msg_iters
);
248 existed
= g_ptr_array_remove_fast(
249 iterator
->downstream_msg_iter
->upstream_msg_iters
,
254 iterator
->upstream_component
= NULL
;
255 iterator
->upstream_port
= NULL
;
256 set_self_comp_port_input_msg_iterator_state(iterator
,
257 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
);
258 BT_LIB_LOGD("Finalized message iterator: %!+i", iterator
);
265 void bt_self_component_port_input_message_iterator_set_connection(
266 struct bt_self_component_port_input_message_iterator
*iterator
,
267 struct bt_connection
*connection
)
270 iterator
->connection
= connection
;
271 BT_LIB_LOGI("Set message iterator's connection: "
272 "%![iter-]+i, %![conn-]+x", iterator
, connection
);
276 enum bt_message_iterator_can_seek_beginning_status
can_seek_ns_from_origin_true(
277 struct bt_self_component_port_input_message_iterator
*iterator
,
278 int64_t ns_from_origin
, bt_bool
*can_seek
)
282 return BT_FUNC_STATUS_OK
;
286 enum bt_message_iterator_can_seek_beginning_status
can_seek_beginning_true(
287 struct bt_self_component_port_input_message_iterator
*iterator
,
292 return BT_FUNC_STATUS_OK
;
296 int create_self_component_input_port_message_iterator(
297 struct bt_self_message_iterator
*self_downstream_msg_iter
,
298 struct bt_self_component_port_input
*self_port
,
299 struct bt_self_component_port_input_message_iterator
**message_iterator
)
301 typedef enum bt_component_class_message_iterator_initialize_method_status (*init_method_t
)(
302 void *, void *, void *, void *);
304 init_method_t init_method
= NULL
;
305 struct bt_self_component_port_input_message_iterator
*iterator
=
307 struct bt_self_component_port_input_message_iterator
*downstream_msg_iter
=
308 (void *) self_downstream_msg_iter
;
309 struct bt_port
*port
= (void *) self_port
;
310 struct bt_port
*upstream_port
;
311 struct bt_component
*comp
;
312 struct bt_component
*upstream_comp
;
313 struct bt_component_class
*upstream_comp_cls
;
316 BT_ASSERT_PRE_NON_NULL(message_iterator
, "Created message iterator");
317 BT_ASSERT_PRE_NON_NULL(port
, "Input port");
318 comp
= bt_port_borrow_component_inline(port
);
319 BT_ASSERT_PRE(bt_port_is_connected(port
),
320 "Input port is not connected: %![port-]+p", port
);
321 BT_ASSERT_PRE(comp
, "Input port is not part of a component: %![port-]+p",
323 BT_ASSERT(port
->connection
);
324 upstream_port
= port
->connection
->upstream_port
;
325 BT_ASSERT(upstream_port
);
326 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
327 BT_ASSERT(upstream_comp
);
329 bt_component_borrow_graph(upstream_comp
)->config_state
==
330 BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED
||
331 bt_component_borrow_graph(upstream_comp
)->config_state
==
332 BT_GRAPH_CONFIGURATION_STATE_CONFIGURED
,
333 "Graph is not configured: %!+g",
334 bt_component_borrow_graph(upstream_comp
));
335 upstream_comp_cls
= upstream_comp
->class;
336 BT_ASSERT(upstream_comp
->class->type
==
337 BT_COMPONENT_CLASS_TYPE_SOURCE
||
338 upstream_comp
->class->type
==
339 BT_COMPONENT_CLASS_TYPE_FILTER
);
340 BT_LIB_LOGI("Creating message iterator on self component input port: "
341 "%![up-comp-]+c, %![up-port-]+p", upstream_comp
, upstream_port
);
343 struct bt_self_component_port_input_message_iterator
, 1);
345 BT_LIB_LOGE_APPEND_CAUSE(
346 "Failed to allocate one self component input port "
347 "message iterator.");
348 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
352 bt_object_init_shared(&iterator
->base
,
353 bt_self_component_port_input_message_iterator_destroy
);
354 iterator
->msgs
= g_ptr_array_new();
355 if (!iterator
->msgs
) {
356 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
357 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
361 g_ptr_array_set_size(iterator
->msgs
, MSG_BATCH_SIZE
);
362 iterator
->last_ns_from_origin
= INT64_MIN
;
363 iterator
->auto_seek
.msgs
= g_queue_new();
364 if (!iterator
->auto_seek
.msgs
) {
365 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue.");
366 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
370 iterator
->upstream_msg_iters
= g_ptr_array_new();
371 if (!iterator
->upstream_msg_iters
) {
372 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
373 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
377 iterator
->upstream_component
= upstream_comp
;
378 iterator
->upstream_port
= upstream_port
;
379 iterator
->connection
= iterator
->upstream_port
->connection
;
380 iterator
->graph
= bt_component_borrow_graph(upstream_comp
);
381 set_self_comp_port_input_msg_iterator_state(iterator
,
382 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
);
384 switch (iterator
->upstream_component
->class->type
) {
385 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
387 struct bt_component_class_source
*src_comp_cls
=
388 (void *) iterator
->upstream_component
->class;
390 iterator
->methods
.next
=
391 (bt_self_component_port_input_message_iterator_next_method
)
392 src_comp_cls
->methods
.msg_iter_next
;
393 iterator
->methods
.seek_ns_from_origin
=
394 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
395 src_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
396 iterator
->methods
.seek_beginning
=
397 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
398 src_comp_cls
->methods
.msg_iter_seek_beginning
;
399 iterator
->methods
.can_seek_ns_from_origin
=
400 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
401 src_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
402 iterator
->methods
.can_seek_beginning
=
403 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
404 src_comp_cls
->methods
.msg_iter_can_seek_beginning
;
407 case BT_COMPONENT_CLASS_TYPE_FILTER
:
409 struct bt_component_class_filter
*flt_comp_cls
=
410 (void *) iterator
->upstream_component
->class;
412 iterator
->methods
.next
=
413 (bt_self_component_port_input_message_iterator_next_method
)
414 flt_comp_cls
->methods
.msg_iter_next
;
415 iterator
->methods
.seek_ns_from_origin
=
416 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
417 flt_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
418 iterator
->methods
.seek_beginning
=
419 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
420 flt_comp_cls
->methods
.msg_iter_seek_beginning
;
421 iterator
->methods
.can_seek_ns_from_origin
=
422 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
423 flt_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
424 iterator
->methods
.can_seek_beginning
=
425 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
426 flt_comp_cls
->methods
.msg_iter_can_seek_beginning
;
433 if (iterator
->methods
.seek_ns_from_origin
&&
434 !iterator
->methods
.can_seek_ns_from_origin
) {
435 iterator
->methods
.can_seek_ns_from_origin
=
436 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
437 can_seek_ns_from_origin_true
;
440 if (iterator
->methods
.seek_beginning
&&
441 !iterator
->methods
.can_seek_beginning
) {
442 iterator
->methods
.can_seek_beginning
=
443 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
444 can_seek_beginning_true
;
447 switch (upstream_comp_cls
->type
) {
448 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
450 struct bt_component_class_source
*src_comp_cls
=
451 (void *) upstream_comp_cls
;
454 (init_method_t
) src_comp_cls
->methods
.msg_iter_initialize
;
457 case BT_COMPONENT_CLASS_TYPE_FILTER
:
459 struct bt_component_class_filter
*flt_comp_cls
=
460 (void *) upstream_comp_cls
;
463 (init_method_t
) flt_comp_cls
->methods
.msg_iter_initialize
;
472 enum bt_component_class_message_iterator_initialize_method_status iter_status
;
474 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator
);
475 iter_status
= init_method(iterator
, &iterator
->config
, upstream_comp
,
477 BT_LOGD("User method returned: status=%s",
478 bt_common_func_status_string(iter_status
));
479 if (iter_status
!= BT_FUNC_STATUS_OK
) {
480 BT_LIB_LOGW_APPEND_CAUSE(
481 "Component input port message iterator initialization method failed: "
482 "%![iter-]+i, status=%s",
484 bt_common_func_status_string(iter_status
));
485 status
= iter_status
;
489 iterator
->config
.frozen
= true;
492 if (downstream_msg_iter
) {
493 /* Set this message iterator's downstream message iterator */
494 iterator
->downstream_msg_iter
= downstream_msg_iter
;
497 * Add this message iterator to the downstream message
498 * iterator's array of upstream message iterators.
500 g_ptr_array_add(downstream_msg_iter
->upstream_msg_iters
,
504 set_self_comp_port_input_msg_iterator_state(iterator
,
505 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
506 g_ptr_array_add(port
->connection
->iterators
, iterator
);
507 BT_LIB_LOGI("Created message iterator on self component input port: "
508 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
509 upstream_port
, upstream_comp
, iterator
);
511 *message_iterator
= iterator
;
512 status
= BT_FUNC_STATUS_OK
;
516 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
522 bt_self_component_port_input_message_iterator_create_from_message_iterator_status
523 bt_self_component_port_input_message_iterator_create_from_message_iterator(
524 struct bt_self_message_iterator
*self_msg_iter
,
525 struct bt_self_component_port_input
*input_port
,
526 struct bt_self_component_port_input_message_iterator
**message_iterator
)
528 BT_ASSERT_PRE_NON_NULL(self_msg_iter
, "Message iterator");
529 return create_self_component_input_port_message_iterator(self_msg_iter
,
530 input_port
, message_iterator
);
533 bt_self_component_port_input_message_iterator_create_from_sink_component_status
534 bt_self_component_port_input_message_iterator_create_from_sink_component(
535 struct bt_self_component_sink
*self_comp
,
536 struct bt_self_component_port_input
*input_port
,
537 struct bt_self_component_port_input_message_iterator
**message_iterator
)
539 BT_ASSERT_PRE_NON_NULL(self_comp
, "Sink component");
540 return create_self_component_input_port_message_iterator(NULL
,
541 input_port
, message_iterator
);
544 void *bt_self_message_iterator_get_data(
545 const struct bt_self_message_iterator
*self_iterator
)
547 struct bt_self_component_port_input_message_iterator
*iterator
=
548 (void *) self_iterator
;
550 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
551 return iterator
->user_data
;
554 void bt_self_message_iterator_set_data(
555 struct bt_self_message_iterator
*self_iterator
, void *data
)
557 struct bt_self_component_port_input_message_iterator
*iterator
=
558 (void *) self_iterator
;
560 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
561 iterator
->user_data
= data
;
562 BT_LIB_LOGD("Set message iterator's user data: "
563 "%!+i, user-data-addr=%p", iterator
, data
);
566 void bt_self_message_iterator_configuration_set_can_seek_forward(
567 bt_self_message_iterator_configuration
*config
,
568 bt_bool can_seek_forward
)
570 BT_ASSERT_PRE_NON_NULL(config
, "Message iterator configuration");
571 BT_ASSERT_PRE_DEV_HOT(config
, "Message iterator configuration", "");
573 config
->can_seek_forward
= can_seek_forward
;
577 * Validate that the default clock snapshot in `msg` doesn't make us go back in
581 BT_ASSERT_POST_DEV_FUNC
583 bool clock_snapshots_are_monotonic_one(
584 struct bt_self_component_port_input_message_iterator
*iterator
,
585 const bt_message
*msg
)
587 const struct bt_clock_snapshot
*clock_snapshot
= NULL
;
588 bt_message_type message_type
= bt_message_get_type(msg
);
589 int64_t ns_from_origin
;
590 enum bt_clock_snapshot_get_ns_from_origin_status clock_snapshot_status
;
593 * The default is true: if we can't figure out the clock snapshot
594 * (or there is none), assume it is fine.
598 switch (message_type
) {
599 case BT_MESSAGE_TYPE_EVENT
:
601 struct bt_message_event
*event_msg
= (struct bt_message_event
*) msg
;
602 clock_snapshot
= event_msg
->default_cs
;
605 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
607 struct bt_message_message_iterator_inactivity
*inactivity_msg
=
608 (struct bt_message_message_iterator_inactivity
*) msg
;
609 clock_snapshot
= inactivity_msg
->default_cs
;
612 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
613 case BT_MESSAGE_TYPE_PACKET_END
:
615 struct bt_message_packet
*packet_msg
= (struct bt_message_packet
*) msg
;
616 clock_snapshot
= packet_msg
->default_cs
;
619 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
620 case BT_MESSAGE_TYPE_STREAM_END
:
622 struct bt_message_stream
*stream_msg
= (struct bt_message_stream
*) msg
;
623 if (stream_msg
->default_cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
627 clock_snapshot
= stream_msg
->default_cs
;
630 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
631 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
633 struct bt_message_discarded_items
*discarded_msg
=
634 (struct bt_message_discarded_items
*) msg
;
636 clock_snapshot
= discarded_msg
->default_begin_cs
;
641 if (!clock_snapshot
) {
645 clock_snapshot_status
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, &ns_from_origin
);
646 if (clock_snapshot_status
!= BT_FUNC_STATUS_OK
) {
650 result
= ns_from_origin
>= iterator
->last_ns_from_origin
;
651 iterator
->last_ns_from_origin
= ns_from_origin
;
656 BT_ASSERT_POST_DEV_FUNC
658 bool clock_snapshots_are_monotonic(
659 struct bt_self_component_port_input_message_iterator
*iterator
,
660 bt_message_array_const msgs
, uint64_t msg_count
)
665 for (i
= 0; i
< msg_count
; i
++) {
666 if (!clock_snapshots_are_monotonic_one(iterator
, msgs
[i
])) {
679 * When a new stream begins, verify that the clock class tied to this
680 * stream is compatible with what we've seen before.
683 BT_ASSERT_POST_DEV_FUNC
685 bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator
*iterator
,
686 const struct bt_message
*msg
)
688 enum bt_message_type message_type
= bt_message_get_type(msg
);
691 if (message_type
== BT_MESSAGE_TYPE_STREAM_BEGINNING
) {
692 const struct bt_message_stream
*stream_msg
= (struct bt_message_stream
*) msg
;
693 const struct bt_clock_class
*clock_class
= stream_msg
->stream
->class->default_clock_class
;
694 bt_uuid clock_class_uuid
= NULL
;
697 clock_class_uuid
= bt_clock_class_get_uuid(clock_class
);
700 switch (iterator
->clock_expectation
.type
) {
701 case CLOCK_EXPECTATION_UNSET
:
703 * This is the first time we see a message with a clock
704 * snapshot: record the properties of that clock, against
705 * which we'll compare the clock properties of the following
710 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_NONE
;
711 } else if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
712 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_UNIX
;
713 } else if (clock_class_uuid
) {
714 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
;
715 bt_uuid_copy(iterator
->clock_expectation
.uuid
, clock_class_uuid
);
717 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
;
721 case CLOCK_EXPECTATION_NONE
:
723 BT_ASSERT_POST_DEV_MSG(
724 "Expecting no clock class, got one: %![cc-]+K",
732 case CLOCK_EXPECTATION_ORIGIN_UNIX
:
734 BT_ASSERT_POST_DEV_MSG(
735 "Expecting a clock class, got none.");
740 if (!bt_clock_class_origin_is_unix_epoch(clock_class
)) {
741 BT_ASSERT_POST_DEV_MSG(
742 "Expecting a clock class with Unix epoch origin: %![cc-]+K",
749 case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
:
751 BT_ASSERT_POST_DEV_MSG(
752 "Expecting a clock class, got none.");
757 if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
758 BT_ASSERT_POST_DEV_MSG(
759 "Expecting a clock class without Unix epoch origin: %![cc-]+K",
765 if (!clock_class_uuid
) {
766 BT_ASSERT_POST_DEV_MSG(
767 "Expecting a clock class with UUID: %![cc-]+K",
773 if (bt_uuid_compare(iterator
->clock_expectation
.uuid
, clock_class_uuid
)) {
774 BT_ASSERT_POST_DEV_MSG(
775 "Expecting a clock class with UUID, got one "
776 "with a different UUID: %![cc-]+K, expected-uuid=%!u",
777 clock_class
, iterator
->clock_expectation
.uuid
);
783 case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
:
785 BT_ASSERT_POST_DEV_MSG(
786 "Expecting a clock class, got none.");
791 if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
792 BT_ASSERT_POST_DEV_MSG(
793 "Expecting a clock class without Unix epoch origin: %![cc-]+K",
799 if (clock_class_uuid
) {
800 BT_ASSERT_POST_DEV_MSG(
801 "Expecting a clock class without UUID: %![cc-]+K",
816 BT_ASSERT_POST_DEV_FUNC
818 bool clock_classes_are_compatible(
819 struct bt_self_component_port_input_message_iterator
*iterator
,
820 bt_message_array_const msgs
, uint64_t msg_count
)
825 for (i
= 0; i
< msg_count
; i
++) {
826 if (!clock_classes_are_compatible_one(iterator
, msgs
[i
])) {
839 * Call the `next` method of the iterator. Do some validation on the returned
844 enum bt_component_class_message_iterator_next_method_status
845 call_iterator_next_method(
846 struct bt_self_component_port_input_message_iterator
*iterator
,
847 bt_message_array_const msgs
, uint64_t capacity
, uint64_t *user_count
)
849 enum bt_component_class_message_iterator_next_method_status status
;
851 BT_ASSERT(iterator
->methods
.next
);
852 BT_LOGD_STR("Calling user's \"next\" method.");
853 status
= iterator
->methods
.next(iterator
, msgs
, capacity
, user_count
);
854 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
855 bt_common_func_status_string(status
), *user_count
);
857 if (status
== BT_FUNC_STATUS_OK
) {
858 BT_ASSERT_POST_DEV(clock_classes_are_compatible(iterator
, msgs
, *user_count
),
859 "Clocks are not compatible");
860 BT_ASSERT_POST_DEV(clock_snapshots_are_monotonic(iterator
, msgs
, *user_count
),
861 "Clock snapshots are not monotonic");
867 enum bt_message_iterator_next_status
868 bt_self_component_port_input_message_iterator_next(
869 struct bt_self_component_port_input_message_iterator
*iterator
,
870 bt_message_array_const
*msgs
, uint64_t *user_count
)
872 enum bt_message_iterator_next_status status
= BT_FUNC_STATUS_OK
;
874 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
875 BT_ASSERT_PRE_DEV_NON_NULL(msgs
, "Message array (output)");
876 BT_ASSERT_PRE_DEV_NON_NULL(user_count
, "Message count (output)");
877 BT_ASSERT_PRE_DEV(iterator
->state
==
878 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
879 "Message iterator's \"next\" called, but "
880 "message iterator is in the wrong state: %!+i", iterator
);
881 BT_ASSERT(iterator
->upstream_component
);
882 BT_ASSERT(iterator
->upstream_component
->class);
884 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
885 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
886 "Graph is not configured: %!+g",
887 bt_component_borrow_graph(iterator
->upstream_component
));
888 BT_LIB_LOGD("Getting next self component input port "
889 "message iterator's messages: %!+i, batch-size=%u",
890 iterator
, MSG_BATCH_SIZE
);
893 * Call the user's "next" method to get the next messages
897 status
= (int) call_iterator_next_method(iterator
,
898 (void *) iterator
->msgs
->pdata
, MSG_BATCH_SIZE
,
900 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
901 bt_common_func_status_string(status
), *user_count
);
903 BT_LIB_LOGW_APPEND_CAUSE(
904 "Component input port message iterator's \"next\" method failed: "
905 "%![iter-]+i, status=%s",
906 iterator
, bt_common_func_status_string(status
));
911 * There is no way that this iterator could have been finalized
912 * during its "next" method, as the only way to do this is to
913 * put the last iterator's reference, and this can only be done
914 * by its downstream owner.
916 * For the same reason, there is no way that this iterator could
917 * have seeked (cannot seek a self message iterator).
919 BT_ASSERT(iterator
->state
==
920 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
923 case BT_FUNC_STATUS_OK
:
924 BT_ASSERT_POST_DEV(*user_count
<= MSG_BATCH_SIZE
,
925 "Invalid returned message count: greater than "
926 "batch size: count=%" PRIu64
", batch-size=%u",
927 *user_count
, MSG_BATCH_SIZE
);
928 *msgs
= (void *) iterator
->msgs
->pdata
;
930 case BT_FUNC_STATUS_AGAIN
:
932 case BT_FUNC_STATUS_END
:
933 set_self_comp_port_input_msg_iterator_state(iterator
,
934 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
);
937 /* Unknown non-error status */
945 struct bt_component
*
946 bt_self_component_port_input_message_iterator_borrow_component(
947 struct bt_self_component_port_input_message_iterator
*iterator
)
949 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
950 return iterator
->upstream_component
;
953 const struct bt_component
*
954 bt_self_component_port_input_message_iterator_borrow_component_const(
955 const struct bt_self_component_port_input_message_iterator
*iterator
)
957 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
958 return iterator
->upstream_component
;
961 struct bt_self_component
*bt_self_message_iterator_borrow_component(
962 struct bt_self_message_iterator
*self_iterator
)
964 struct bt_self_component_port_input_message_iterator
*iterator
=
965 (void *) self_iterator
;
967 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
968 return (void *) iterator
->upstream_component
;
971 struct bt_self_component_port_output
*bt_self_message_iterator_borrow_port(
972 struct bt_self_message_iterator
*self_iterator
)
974 struct bt_self_component_port_input_message_iterator
*iterator
=
975 (void *) self_iterator
;
977 BT_ASSERT_PRE_DEV_NON_NULL(iterator
, "Message iterator");
978 return (void *) iterator
->upstream_port
;
981 enum bt_message_iterator_can_seek_ns_from_origin_status
982 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
983 struct bt_self_component_port_input_message_iterator
*iterator
,
984 int64_t ns_from_origin
, bt_bool
*can_seek
)
986 enum bt_message_iterator_can_seek_ns_from_origin_status status
;
988 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
989 BT_ASSERT_PRE_NON_NULL(can_seek
, "Result (output)");
990 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
992 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
993 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
994 "Graph is not configured: %!+g",
995 bt_component_borrow_graph(iterator
->upstream_component
));
997 if (iterator
->methods
.can_seek_ns_from_origin
) {
999 * Initialize to an invalid value, so we can post-assert that
1000 * the method returned a valid value.
1004 BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i",
1007 status
= (int) iterator
->methods
.can_seek_ns_from_origin(iterator
,
1008 ns_from_origin
, can_seek
);
1010 if (status
!= BT_FUNC_STATUS_OK
) {
1011 BT_LIB_LOGW_APPEND_CAUSE(
1012 "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: "
1013 "%![iter-]+i, status=%s",
1014 iterator
, bt_common_func_status_string(status
));
1018 BT_ASSERT_POST(*can_seek
== BT_TRUE
|| *can_seek
== BT_FALSE
,
1019 "Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i",
1020 *can_seek
, iterator
);
1023 "User's \"can seek nanoseconds from origin\" returned successfully: "
1024 "%![iter-]+i, can-seek=%d",
1025 iterator
, *can_seek
);
1033 * Automatic seeking fall back: if we can seek to the beginning and the
1034 * iterator supports forward seeking then we can automatically seek to
1037 status
= (int) bt_self_component_port_input_message_iterator_can_seek_beginning(
1038 iterator
, can_seek
);
1039 if (status
!= BT_FUNC_STATUS_OK
) {
1043 *can_seek
= *can_seek
&& iterator
->config
.can_seek_forward
;
1049 enum bt_message_iterator_can_seek_beginning_status
1050 bt_self_component_port_input_message_iterator_can_seek_beginning(
1051 struct bt_self_component_port_input_message_iterator
*iterator
,
1054 enum bt_message_iterator_can_seek_beginning_status status
;
1056 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1057 BT_ASSERT_PRE_NON_NULL(can_seek
, "Result (output)");
1058 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1060 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1061 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1062 "Graph is not configured: %!+g",
1063 bt_component_borrow_graph(iterator
->upstream_component
));
1065 if (iterator
->methods
.can_seek_beginning
) {
1067 * Initialize to an invalid value, so we can post-assert that
1068 * the method returned a valid value.
1072 status
= (int) iterator
->methods
.can_seek_beginning(iterator
, can_seek
);
1075 status
!= BT_FUNC_STATUS_OK
||
1076 *can_seek
== BT_TRUE
||
1077 *can_seek
== BT_FALSE
,
1078 "Unexpected boolean value returned from user's \"can seek beginning\" method: val=%d, %![iter-]+i",
1079 *can_seek
, iterator
);
1081 *can_seek
= BT_FALSE
;
1082 status
= BT_FUNC_STATUS_OK
;
1089 void set_iterator_state_after_seeking(
1090 struct bt_self_component_port_input_message_iterator
*iterator
,
1093 enum bt_self_component_port_input_message_iterator_state new_state
= 0;
1095 /* Set iterator's state depending on seeking status */
1097 case BT_FUNC_STATUS_OK
:
1098 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
;
1100 case BT_FUNC_STATUS_AGAIN
:
1101 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
;
1103 case BT_FUNC_STATUS_ERROR
:
1104 case BT_FUNC_STATUS_MEMORY_ERROR
:
1105 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
;
1107 case BT_FUNC_STATUS_END
:
1108 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
;
1114 set_self_comp_port_input_msg_iterator_state(iterator
, new_state
);
1118 void reset_iterator_expectations(
1119 struct bt_self_component_port_input_message_iterator
*iterator
)
1121 iterator
->last_ns_from_origin
= INT64_MIN
;
1122 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_UNSET
;
1126 bool message_iterator_can_seek_beginning(
1127 struct bt_self_component_port_input_message_iterator
*iterator
)
1129 enum bt_message_iterator_can_seek_beginning_status status
;
1132 status
= bt_self_component_port_input_message_iterator_can_seek_beginning(
1133 iterator
, &can_seek
);
1134 if (status
!= BT_FUNC_STATUS_OK
) {
1135 can_seek
= BT_FALSE
;
1141 enum bt_message_iterator_seek_beginning_status
1142 bt_self_component_port_input_message_iterator_seek_beginning(
1143 struct bt_self_component_port_input_message_iterator
*iterator
)
1147 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1148 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1150 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1151 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1152 "Graph is not configured: %!+g",
1153 bt_component_borrow_graph(iterator
->upstream_component
));
1154 BT_ASSERT_PRE(message_iterator_can_seek_beginning(iterator
),
1155 "Message iterator cannot seek beginning: %!+i", iterator
);
1158 * We are seeking, reset our expectations about how the following
1159 * messages should look like.
1161 reset_iterator_expectations(iterator
);
1163 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator
);
1164 set_self_comp_port_input_msg_iterator_state(iterator
,
1165 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1166 status
= iterator
->methods
.seek_beginning(iterator
);
1167 BT_LOGD("User method returned: status=%s",
1168 bt_common_func_status_string(status
));
1169 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
1170 status
== BT_FUNC_STATUS_ERROR
||
1171 status
== BT_FUNC_STATUS_MEMORY_ERROR
||
1172 status
== BT_FUNC_STATUS_AGAIN
,
1173 "Unexpected status: %![iter-]+i, status=%s",
1174 iterator
, bt_common_func_status_string(status
));
1176 BT_LIB_LOGW_APPEND_CAUSE(
1177 "Component input port message iterator's \"seek beginning\" method failed: "
1178 "%![iter-]+i, status=%s",
1179 iterator
, bt_common_func_status_string(status
));
1182 set_iterator_state_after_seeking(iterator
, status
);
1187 bt_self_component_port_input_message_iterator_can_seek_forward(
1188 bt_self_component_port_input_message_iterator
*iterator
)
1190 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1192 return iterator
->config
.can_seek_forward
;
1196 * Structure used to record the state of a given stream during the fast-forward
1197 * phase of an auto-seek.
1199 struct auto_seek_stream_state
{
1201 * Value representing which step of this timeline we are at.
1204 * [SB] 1 [PB] 2 [PE] 1 [SE]
1206 * At each point in the timeline, the messages we need to replicate are:
1208 * 1: Stream beginning
1209 * 2: Stream beginning, packet beginning
1211 * Before "Stream beginning" and after "Stream end", we don't need to
1212 * replicate anything as the stream doesn't exist.
1215 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
,
1216 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
,
1220 * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
1221 * in. This is a weak reference, since the packet will always be
1222 * alive by the time we use it.
1224 struct bt_packet
*packet
;
1226 /* Have we see a message with a clock snapshot yet? */
1227 bool seen_clock_snapshot
;
1231 struct auto_seek_stream_state
*create_auto_seek_stream_state(void)
1233 return g_new0(struct auto_seek_stream_state
, 1);
1237 void destroy_auto_seek_stream_state(void *ptr
)
1243 GHashTable
*create_auto_seek_stream_states(void)
1245 return g_hash_table_new_full(g_direct_hash
, g_direct_equal
, NULL
,
1246 destroy_auto_seek_stream_state
);
1250 void destroy_auto_seek_stream_states(GHashTable
*stream_states
)
1252 g_hash_table_destroy(stream_states
);
1256 * Handle one message while we are in the fast-forward phase of an auto-seek.
1258 * Sets `*got_first` to true if the message's timestamp is greater or equal to
1259 * `ns_from_origin`. In other words, if this is the first message after our
1262 * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1263 * `struct auto_seek_stream_state` used to keep the state of each stream
1264 * during the fast-forward.
1268 int auto_seek_handle_message(
1269 struct bt_self_component_port_input_message_iterator
*iterator
,
1270 int64_t ns_from_origin
, const struct bt_message
*msg
,
1271 bool *got_first
, GHashTable
*stream_states
)
1273 int status
= BT_FUNC_STATUS_OK
;
1274 int64_t msg_ns_from_origin
;
1275 const struct bt_clock_snapshot
*clk_snapshot
= NULL
;
1279 BT_ASSERT(got_first
);
1281 switch (msg
->type
) {
1282 case BT_MESSAGE_TYPE_EVENT
:
1284 const struct bt_message_event
*event_msg
=
1287 clk_snapshot
= event_msg
->default_cs
;
1288 BT_ASSERT_POST_DEV(clk_snapshot
,
1289 "Event message has no default clock snapshot: %!+n",
1293 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1295 const struct bt_message_message_iterator_inactivity
*inactivity_msg
=
1298 clk_snapshot
= inactivity_msg
->default_cs
;
1299 BT_ASSERT(clk_snapshot
);
1302 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1303 case BT_MESSAGE_TYPE_PACKET_END
:
1305 const struct bt_message_packet
*packet_msg
=
1308 clk_snapshot
= packet_msg
->default_cs
;
1309 BT_ASSERT_POST_DEV(clk_snapshot
,
1310 "Packet message has no default clock snapshot: %!+n",
1314 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1315 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1317 struct bt_message_discarded_items
*msg_disc_items
=
1320 BT_ASSERT_POST_DEV(msg_disc_items
->default_begin_cs
&&
1321 msg_disc_items
->default_end_cs
,
1322 "Discarded events/packets message has no default clock snapshots: %!+n",
1324 ret
= bt_clock_snapshot_get_ns_from_origin(
1325 msg_disc_items
->default_begin_cs
,
1326 &msg_ns_from_origin
);
1328 status
= BT_FUNC_STATUS_ERROR
;
1332 if (msg_ns_from_origin
>= ns_from_origin
) {
1337 ret
= bt_clock_snapshot_get_ns_from_origin(
1338 msg_disc_items
->default_end_cs
,
1339 &msg_ns_from_origin
);
1341 status
= BT_FUNC_STATUS_ERROR
;
1345 if (msg_ns_from_origin
>= ns_from_origin
) {
1347 * The discarded items message's beginning time
1348 * is before the requested seeking time, but its
1349 * end time is after. Modify the message so as
1350 * to set its beginning time to the requested
1351 * seeking time, and make its item count unknown
1352 * as we don't know if items were really
1353 * discarded within the new time range.
1355 uint64_t new_begin_raw_value
= 0;
1357 ret
= bt_clock_class_clock_value_from_ns_from_origin(
1358 msg_disc_items
->default_end_cs
->clock_class
,
1359 ns_from_origin
, &new_begin_raw_value
);
1361 status
= BT_FUNC_STATUS_ERROR
;
1365 bt_clock_snapshot_set_raw_value(
1366 msg_disc_items
->default_begin_cs
,
1367 new_begin_raw_value
);
1368 msg_disc_items
->count
.base
.avail
=
1369 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
1372 * It is safe to push it because its beginning
1373 * time is exactly the requested seeking time.
1380 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1381 case BT_MESSAGE_TYPE_STREAM_END
:
1383 struct bt_message_stream
*stream_msg
=
1384 (struct bt_message_stream
*) msg
;
1386 if (stream_msg
->default_cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
1391 clk_snapshot
= stream_msg
->default_cs
;
1398 BT_ASSERT(clk_snapshot
);
1399 ret
= bt_clock_snapshot_get_ns_from_origin(clk_snapshot
,
1400 &msg_ns_from_origin
);
1402 status
= BT_FUNC_STATUS_ERROR
;
1406 if (msg_ns_from_origin
>= ns_from_origin
) {
1412 /* This message won't be sent downstream. */
1413 switch (msg
->type
) {
1414 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1416 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1417 struct auto_seek_stream_state
*stream_state
;
1419 /* Update stream's state: stream began. */
1420 stream_state
= create_auto_seek_stream_state();
1421 if (!stream_state
) {
1422 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1426 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1428 if (stream_msg
->default_cs_state
== BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
1429 stream_state
->seen_clock_snapshot
= true;
1432 BT_ASSERT(!bt_g_hash_table_contains(stream_states
, stream_msg
->stream
));
1433 g_hash_table_insert(stream_states
, stream_msg
->stream
, stream_state
);
1436 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1438 const struct bt_message_packet
*packet_msg
=
1440 struct auto_seek_stream_state
*stream_state
;
1442 /* Update stream's state: packet began. */
1443 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1444 BT_ASSERT(stream_state
);
1446 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1447 stream_state
->state
= AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
;
1448 BT_ASSERT(!stream_state
->packet
);
1449 stream_state
->packet
= packet_msg
->packet
;
1451 if (packet_msg
->packet
->stream
->class->packets_have_beginning_default_clock_snapshot
) {
1452 stream_state
->seen_clock_snapshot
= true;
1457 case BT_MESSAGE_TYPE_EVENT
:
1459 const struct bt_message_event
*event_msg
= (const void *) msg
;
1460 struct auto_seek_stream_state
*stream_state
;
1462 stream_state
= g_hash_table_lookup(stream_states
,
1463 event_msg
->event
->packet
->stream
);
1464 BT_ASSERT(stream_state
);
1466 // HELPME: are we sure that event messages have clock snapshots at this point?
1467 stream_state
->seen_clock_snapshot
= true;
1471 case BT_MESSAGE_TYPE_PACKET_END
:
1473 const struct bt_message_packet
*packet_msg
=
1475 struct auto_seek_stream_state
*stream_state
;
1477 /* Update stream's state: packet ended. */
1478 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1479 BT_ASSERT(stream_state
);
1481 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
);
1482 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1483 BT_ASSERT(stream_state
->packet
);
1484 stream_state
->packet
= NULL
;
1486 if (packet_msg
->packet
->stream
->class->packets_have_end_default_clock_snapshot
) {
1487 stream_state
->seen_clock_snapshot
= true;
1492 case BT_MESSAGE_TYPE_STREAM_END
:
1494 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1495 struct auto_seek_stream_state
*stream_state
;
1497 stream_state
= g_hash_table_lookup(stream_states
, stream_msg
->stream
);
1498 BT_ASSERT(stream_state
);
1499 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1500 BT_ASSERT(!stream_state
->packet
);
1502 /* Update stream's state: this stream doesn't exist anymore. */
1503 g_hash_table_remove(stream_states
, stream_msg
->stream
);
1506 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1507 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1509 const struct bt_message_discarded_items
*discarded_msg
=
1511 struct auto_seek_stream_state
*stream_state
;
1513 stream_state
= g_hash_table_lookup(stream_states
, discarded_msg
->stream
);
1514 BT_ASSERT(stream_state
);
1516 if ((msg
->type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
&& discarded_msg
->stream
->class->discarded_events_have_default_clock_snapshots
) ||
1517 (msg
->type
== BT_MESSAGE_TYPE_DISCARDED_PACKETS
&& discarded_msg
->stream
->class->discarded_packets_have_default_clock_snapshots
)) {
1518 stream_state
->seen_clock_snapshot
= true;
1527 bt_object_put_no_null_check(msg
);
1532 g_queue_push_tail(iterator
->auto_seek
.msgs
, (void *) msg
);
1536 BT_ASSERT(!msg
|| status
!= BT_FUNC_STATUS_OK
);
1541 int find_message_ge_ns_from_origin(
1542 struct bt_self_component_port_input_message_iterator
*iterator
,
1543 int64_t ns_from_origin
, GHashTable
*stream_states
)
1545 int status
= BT_FUNC_STATUS_OK
;
1546 enum bt_self_component_port_input_message_iterator_state init_state
=
1548 const struct bt_message
*messages
[MSG_BATCH_SIZE
];
1549 uint64_t user_count
= 0;
1551 bool got_first
= false;
1553 BT_ASSERT(iterator
);
1554 memset(&messages
[0], 0, sizeof(messages
[0]) * MSG_BATCH_SIZE
);
1557 * Make this iterator temporarily active (not seeking) to call
1558 * the "next" method.
1560 set_self_comp_port_input_msg_iterator_state(iterator
,
1561 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1563 BT_ASSERT(iterator
->methods
.next
);
1565 while (!got_first
) {
1567 * Call the user's "next" method to get the next
1568 * messages and status.
1570 status
= call_iterator_next_method(iterator
,
1571 &messages
[0], MSG_BATCH_SIZE
, &user_count
);
1572 BT_LOGD("User method returned: status=%s",
1573 bt_common_func_status_string(status
));
1575 BT_LIB_LOGW_APPEND_CAUSE(
1576 "Component input port message iterator's \"next\" method failed: "
1577 "%![iter-]+i, status=%s",
1578 iterator
, bt_common_func_status_string(status
));
1582 * The user's "next" method must not do any action which
1583 * would change the iterator's state.
1585 BT_ASSERT(iterator
->state
==
1586 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1589 case BT_FUNC_STATUS_OK
:
1590 BT_ASSERT_POST_DEV(user_count
<= MSG_BATCH_SIZE
,
1591 "Invalid returned message count: greater than "
1592 "batch size: count=%" PRIu64
", batch-size=%u",
1593 user_count
, MSG_BATCH_SIZE
);
1595 case BT_FUNC_STATUS_AGAIN
:
1596 case BT_FUNC_STATUS_ERROR
:
1597 case BT_FUNC_STATUS_MEMORY_ERROR
:
1598 case BT_FUNC_STATUS_END
:
1604 for (i
= 0; i
< user_count
; i
++) {
1606 g_queue_push_tail(iterator
->auto_seek
.msgs
,
1607 (void *) messages
[i
]);
1612 status
= auto_seek_handle_message(iterator
,
1613 ns_from_origin
, messages
[i
], &got_first
,
1615 if (status
== BT_FUNC_STATUS_OK
) {
1616 /* Message was either pushed or moved */
1625 for (i
= 0; i
< user_count
; i
++) {
1627 bt_object_put_no_null_check(messages
[i
]);
1631 set_self_comp_port_input_msg_iterator_state(iterator
, init_state
);
1636 * This function is installed as the iterator's next callback after we have
1637 * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1638 * messages saved in iterator->auto_seek.msgs. Once this is done, the original
1639 * next callback is put back.
1643 enum bt_component_class_message_iterator_next_method_status
post_auto_seek_next(
1644 struct bt_self_component_port_input_message_iterator
*iterator
,
1645 bt_message_array_const msgs
, uint64_t capacity
,
1648 BT_ASSERT(!g_queue_is_empty(iterator
->auto_seek
.msgs
));
1652 * Move auto-seek messages to the output array (which is this
1653 * iterator's base message array).
1655 while (capacity
> 0 && !g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1656 msgs
[*count
] = g_queue_pop_head(iterator
->auto_seek
.msgs
);
1661 BT_ASSERT(*count
> 0);
1663 if (g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1664 /* No more auto-seek messages, restore user's next callback. */
1665 BT_ASSERT(iterator
->auto_seek
.original_next_callback
);
1666 iterator
->methods
.next
= iterator
->auto_seek
.original_next_callback
;
1667 iterator
->auto_seek
.original_next_callback
= NULL
;
1670 return BT_FUNC_STATUS_OK
;
1674 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1675 int64_t ns_from_origin
, uint64_t *raw_value
)
1678 int64_t cc_offset_s
= clock_class
->offset_seconds
;
1679 uint64_t cc_offset_cycles
= clock_class
->offset_cycles
;
1680 uint64_t cc_freq
= clock_class
->frequency
;
1682 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1683 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1687 bool message_iterator_can_seek_ns_from_origin(
1688 struct bt_self_component_port_input_message_iterator
*iterator
,
1689 int64_t ns_from_origin
)
1691 enum bt_message_iterator_can_seek_ns_from_origin_status status
;
1694 status
= bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1695 iterator
, ns_from_origin
, &can_seek
);
1696 if (status
!= BT_FUNC_STATUS_OK
) {
1697 can_seek
= BT_FALSE
;
1703 enum bt_message_iterator_seek_ns_from_origin_status
1704 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1705 struct bt_self_component_port_input_message_iterator
*iterator
,
1706 int64_t ns_from_origin
)
1709 GHashTable
*stream_states
= NULL
;
1710 bt_bool can_seek_by_itself
;
1712 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1713 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1715 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1716 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1717 "Graph is not configured: %!+g",
1718 bt_component_borrow_graph(iterator
->upstream_component
));
1719 /* The iterator must be able to seek ns from origin one way or another. */
1721 message_iterator_can_seek_ns_from_origin(iterator
, ns_from_origin
),
1722 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1723 "ns-from-origin=%" PRId64
, iterator
, ns_from_origin
);
1724 set_self_comp_port_input_msg_iterator_state(iterator
,
1725 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1728 * We are seeking, reset our expectations about how the following
1729 * messages should look like.
1731 reset_iterator_expectations(iterator
);
1733 /* Check if the iterator can seek by itself. If not we'll use autoseek. */
1734 if (iterator
->methods
.can_seek_ns_from_origin
) {
1735 bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
1739 iterator
->methods
.can_seek_ns_from_origin(
1740 iterator
, ns_from_origin
, &can_seek_by_itself
);
1741 if (can_seek_status
!= BT_FUNC_STATUS_OK
) {
1742 status
= can_seek_status
;
1746 can_seek_by_itself
= false;
1749 if (can_seek_by_itself
) {
1750 /* The iterator knows how to seek to a particular time, let it handle this. */
1751 BT_ASSERT(iterator
->methods
.seek_ns_from_origin
);
1752 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1753 "%![iter-]+i, ns=%" PRId64
, iterator
, ns_from_origin
);
1754 status
= iterator
->methods
.seek_ns_from_origin(iterator
,
1756 BT_LOGD("User method returned: status=%s",
1757 bt_common_func_status_string(status
));
1758 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
1759 status
== BT_FUNC_STATUS_ERROR
||
1760 status
== BT_FUNC_STATUS_MEMORY_ERROR
||
1761 status
== BT_FUNC_STATUS_AGAIN
,
1762 "Unexpected status: %![iter-]+i, status=%s",
1763 iterator
, bt_common_func_status_string(status
));
1765 BT_LIB_LOGW_APPEND_CAUSE(
1766 "Component input port message iterator's \"seek nanoseconds from origin\" method failed: "
1767 "%![iter-]+i, status=%s",
1768 iterator
, bt_common_func_status_string(status
));
1772 * The iterator doesn't know how to seek by itself to a
1773 * particular time. We will seek to the beginning and fast
1774 * forward to the right place.
1776 enum bt_component_class_message_iterator_can_seek_beginning_method_status
1778 bt_bool can_seek_beginning
;
1780 can_seek_status
= iterator
->methods
.can_seek_beginning(iterator
,
1781 &can_seek_beginning
);
1782 BT_ASSERT(can_seek_status
== BT_FUNC_STATUS_OK
);
1783 BT_ASSERT(can_seek_beginning
);
1785 BT_ASSERT(iterator
->methods
.seek_beginning
);
1786 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1788 status
= iterator
->methods
.seek_beginning(iterator
);
1789 BT_LOGD("User method returned: status=%s",
1790 bt_common_func_status_string(status
));
1791 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
1792 status
== BT_FUNC_STATUS_ERROR
||
1793 status
== BT_FUNC_STATUS_MEMORY_ERROR
||
1794 status
== BT_FUNC_STATUS_AGAIN
,
1795 "Unexpected status: %![iter-]+i, status=%s",
1796 iterator
, bt_common_func_status_string(status
));
1798 BT_LIB_LOGW_APPEND_CAUSE(
1799 "Component input port message iterator's \"seek beginning\" method failed: "
1800 "%![iter-]+i, status=%s",
1801 iterator
, bt_common_func_status_string(status
));
1805 case BT_FUNC_STATUS_OK
:
1807 case BT_FUNC_STATUS_ERROR
:
1808 case BT_FUNC_STATUS_MEMORY_ERROR
:
1809 case BT_FUNC_STATUS_AGAIN
:
1816 * Find the first message which has a default clock
1817 * snapshot greater than or equal to the requested
1818 * seeking time, and move the received messages from
1819 * this point in the batch to this iterator's auto-seek
1822 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1823 bt_object_put_no_null_check(
1824 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
1827 stream_states
= create_auto_seek_stream_states();
1828 if (!stream_states
) {
1829 BT_LIB_LOGE_APPEND_CAUSE(
1830 "Failed to allocate one GHashTable.");
1831 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1835 status
= find_message_ge_ns_from_origin(iterator
,
1836 ns_from_origin
, stream_states
);
1838 case BT_FUNC_STATUS_OK
:
1839 case BT_FUNC_STATUS_END
:
1841 GHashTableIter iter
;
1842 gpointer key
, value
;
1845 * If some streams exist at the seek time, prepend the
1846 * required messages to put those streams in the right
1849 g_hash_table_iter_init(&iter
, stream_states
);
1850 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
1851 const bt_stream
*stream
= key
;
1852 struct auto_seek_stream_state
*stream_state
=
1853 (struct auto_seek_stream_state
*) value
;
1855 const bt_clock_class
*clock_class
= bt_stream_class_borrow_default_clock_class_const(
1856 bt_stream_borrow_class_const(stream
));
1857 /* Initialize to silence maybe-uninitialized warning. */
1858 uint64_t raw_value
= 0;
1861 * If we haven't seen a message with a clock snapshot, we don't know if our seek time is within
1862 * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value.
1864 * Also, it would be a bit of a lie to generate a stream begin message with the seek time as its
1865 * clock snapshot, because we don't really know if the stream existed at that time. If we have
1866 * seen a message with a clock snapshot in our seeking, then we are sure that the
1867 * seek time is not below the clock range, and we know the stream was active at that
1868 * time (and that we cut it short).
1870 if (stream_state
->seen_clock_snapshot
) {
1871 if (clock_raw_value_from_ns_from_origin(clock_class
, ns_from_origin
, &raw_value
) != 0) {
1872 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64
", %![cc-]+K",
1873 ns_from_origin
, clock_class
);
1874 status
= BT_FUNC_STATUS_ERROR
;
1879 switch (stream_state
->state
) {
1880 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
:
1881 BT_ASSERT(stream_state
->packet
);
1882 BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state
->packet
);
1884 if (stream
->class->packets_have_beginning_default_clock_snapshot
) {
1886 * If we are in the PACKET_BEGAN state, it means we have seen a "packet beginning"
1887 * message. If "packet beginning" packets have clock snapshots, then we must have
1888 * seen a clock snapshot.
1890 BT_ASSERT(stream_state
->seen_clock_snapshot
);
1892 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1893 (bt_self_message_iterator
*) iterator
, stream_state
->packet
, raw_value
);
1895 msg
= bt_message_packet_beginning_create((bt_self_message_iterator
*) iterator
,
1896 stream_state
->packet
);
1900 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1904 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1908 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
:
1909 msg
= bt_message_stream_beginning_create(
1910 (bt_self_message_iterator
*) iterator
, stream
);
1912 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1916 if (stream_state
->seen_clock_snapshot
) {
1917 bt_message_stream_beginning_set_default_clock_snapshot(msg
, raw_value
);
1920 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1927 * If there are messages in the auto-seek
1928 * message queue, replace the user's "next"
1929 * method with a custom, temporary "next" method
1930 * which returns them.
1932 if (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1933 BT_ASSERT(!iterator
->auto_seek
.original_next_callback
);
1934 iterator
->auto_seek
.original_next_callback
= iterator
->methods
.next
;
1936 iterator
->methods
.next
=
1937 (bt_self_component_port_input_message_iterator_next_method
)
1938 post_auto_seek_next
;
1942 * `BT_FUNC_STATUS_END` becomes
1943 * `BT_FUNC_STATUS_OK`: the next
1944 * time this iterator's "next" method is called,
1946 * `BT_FUNC_STATUS_END`.
1948 status
= BT_FUNC_STATUS_OK
;
1951 case BT_FUNC_STATUS_ERROR
:
1952 case BT_FUNC_STATUS_MEMORY_ERROR
:
1953 case BT_FUNC_STATUS_AGAIN
:
1961 * The following messages returned by the next method (including
1962 * post_auto_seek_next) must be after (or at) `ns_from_origin`.
1964 iterator
->last_ns_from_origin
= ns_from_origin
;
1967 if (stream_states
) {
1968 destroy_auto_seek_stream_states(stream_states
);
1969 stream_states
= NULL
;
1972 set_iterator_state_after_seeking(iterator
, status
);
1976 bt_bool
bt_self_message_iterator_is_interrupted(
1977 const struct bt_self_message_iterator
*self_msg_iter
)
1979 const struct bt_self_component_port_input_message_iterator
*iterator
=
1980 (const void *) self_msg_iter
;
1982 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1983 return (bt_bool
) bt_graph_is_interrupted(iterator
->graph
);
1986 void bt_self_component_port_input_message_iterator_get_ref(
1987 const struct bt_self_component_port_input_message_iterator
*iterator
)
1989 bt_object_get_ref(iterator
);
1992 void bt_self_component_port_input_message_iterator_put_ref(
1993 const struct bt_self_component_port_input_message_iterator
*iterator
)
1995 bt_object_put_ref(iterator
);