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/port-output-message-iterator.h>
47 #include <babeltrace2/graph/message-event-const.h>
48 #include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
49 #include <babeltrace2/graph/message-packet-beginning.h>
50 #include <babeltrace2/graph/message-packet-beginning-const.h>
51 #include <babeltrace2/graph/message-packet-end-const.h>
52 #include <babeltrace2/graph/message-stream-beginning.h>
53 #include <babeltrace2/graph/message-stream-beginning-const.h>
54 #include <babeltrace2/graph/message-stream-end-const.h>
55 #include <babeltrace2/graph/port-const.h>
56 #include <babeltrace2/graph/graph.h>
57 #include <babeltrace2/graph/graph-const.h>
58 #include <babeltrace2/types.h>
59 #include "common/assert.h"
60 #include "lib/assert-pre.h"
61 #include "lib/assert-post.h"
66 #include "component-class.h"
67 #include "component-class-sink-colander.h"
68 #include "component.h"
69 #include "component-sink.h"
70 #include "component-source.h"
71 #include "connection.h"
73 #include "message/discarded-items.h"
74 #include "message/event.h"
75 #include "message/iterator.h"
76 #include "message/message.h"
77 #include "message/message-iterator-inactivity.h"
78 #include "message/stream.h"
79 #include "message/packet.h"
80 #include "lib/func-status.h"
83 * TODO: Use graph's state (number of active iterators, etc.) and
84 * possibly system specifications to make a better guess than this.
86 #define MSG_BATCH_SIZE 15
88 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
89 BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
90 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
91 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
92 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
93 "Message iterator is in the wrong state: %!+i", _iter)
96 void set_self_comp_port_input_msg_iterator_state(
97 struct bt_self_component_port_input_message_iterator
*iterator
,
98 enum bt_self_component_port_input_message_iterator_state state
)
101 BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
102 bt_self_component_port_input_message_iterator_state_string(state
));
103 iterator
->state
= state
;
107 void destroy_base_message_iterator(struct bt_object
*obj
)
109 struct bt_message_iterator
*iterator
= (void *) obj
;
113 if (iterator
->msgs
) {
114 g_ptr_array_free(iterator
->msgs
, TRUE
);
115 iterator
->msgs
= NULL
;
122 void bt_self_component_port_input_message_iterator_destroy(struct bt_object
*obj
)
124 struct bt_self_component_port_input_message_iterator
*iterator
;
129 * The message iterator's reference count is 0 if we're
130 * here. Increment it to avoid a double-destroy (possibly
131 * infinitely recursive). This could happen for example if the
132 * message iterator's finalization function does
133 * bt_object_get_ref() (or anything that causes
134 * bt_object_get_ref() to be called) on itself (ref. count goes
135 * from 0 to 1), and then bt_object_put_ref(): the reference
136 * count would go from 1 to 0 again and this function would be
140 iterator
= (void *) obj
;
141 BT_LIB_LOGI("Destroying self component input port message iterator object: "
143 bt_self_component_port_input_message_iterator_try_finalize(iterator
);
145 if (iterator
->connection
) {
147 * Remove ourself from the originating connection so
148 * that it does not try to finalize a dangling pointer
151 bt_connection_remove_iterator(iterator
->connection
, iterator
);
152 iterator
->connection
= NULL
;
155 if (iterator
->auto_seek
.msgs
) {
156 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
157 bt_object_put_no_null_check(
158 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
161 g_queue_free(iterator
->auto_seek
.msgs
);
162 iterator
->auto_seek
.msgs
= NULL
;
165 destroy_base_message_iterator(obj
);
169 void bt_self_component_port_input_message_iterator_try_finalize(
170 struct bt_self_component_port_input_message_iterator
*iterator
)
172 typedef void (*method_t
)(void *);
174 struct bt_component_class
*comp_class
= NULL
;
175 method_t method
= NULL
;
179 switch (iterator
->state
) {
180 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
:
181 /* Skip user finalization if user initialization failed */
182 BT_LIB_LOGD("Not finalizing non-initialized message iterator: "
185 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
:
186 /* Already finalized */
187 BT_LIB_LOGD("Not finalizing message iterator: already finalized: "
190 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
:
192 BT_LIB_LOGF("Message iterator is already being finalized: "
199 BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator
);
200 set_self_comp_port_input_msg_iterator_state(iterator
,
201 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
);
202 BT_ASSERT(iterator
->upstream_component
);
203 comp_class
= iterator
->upstream_component
->class;
205 /* Call user-defined destroy method */
206 switch (comp_class
->type
) {
207 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
209 struct bt_component_class_source
*src_comp_cls
=
212 method
= (method_t
) src_comp_cls
->methods
.msg_iter_finalize
;
215 case BT_COMPONENT_CLASS_TYPE_FILTER
:
217 struct bt_component_class_filter
*flt_comp_cls
=
220 method
= (method_t
) flt_comp_cls
->methods
.msg_iter_finalize
;
229 BT_LIB_LOGD("Calling user's finalization method: %!+i",
234 iterator
->upstream_component
= NULL
;
235 iterator
->upstream_port
= NULL
;
236 set_self_comp_port_input_msg_iterator_state(iterator
,
237 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
);
238 BT_LIB_LOGD("Finalized message iterator: %!+i", iterator
);
245 void bt_self_component_port_input_message_iterator_set_connection(
246 struct bt_self_component_port_input_message_iterator
*iterator
,
247 struct bt_connection
*connection
)
250 iterator
->connection
= connection
;
251 BT_LIB_LOGI("Set message iterator's connection: "
252 "%![iter-]+i, %![conn-]+x", iterator
, connection
);
256 int init_message_iterator(struct bt_message_iterator
*iterator
,
257 enum bt_message_iterator_type type
,
258 bt_object_release_func destroy
)
262 bt_object_init_shared(&iterator
->base
, destroy
);
263 iterator
->type
= type
;
264 iterator
->msgs
= g_ptr_array_new();
265 if (!iterator
->msgs
) {
266 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray.");
271 g_ptr_array_set_size(iterator
->msgs
, MSG_BATCH_SIZE
);
278 bt_bool
can_seek_ns_from_origin_true(
279 struct bt_self_component_port_input_message_iterator
*iterator
,
280 int64_t ns_from_origin
)
286 bt_bool
can_seek_beginning_true(
287 struct bt_self_component_port_input_message_iterator
*iterator
)
293 struct bt_self_component_port_input_message_iterator
*
294 bt_self_component_port_input_message_iterator_create_initial(
295 struct bt_component
*upstream_comp
,
296 struct bt_port
*upstream_port
)
299 struct bt_self_component_port_input_message_iterator
*iterator
= NULL
;
301 BT_ASSERT(upstream_comp
);
302 BT_ASSERT(upstream_port
);
303 BT_ASSERT(bt_port_is_connected(upstream_port
));
304 BT_LIB_LOGI("Creating initial message iterator on self component input port: "
305 "%![up-comp-]+c, %![up-port-]+p", upstream_comp
, upstream_port
);
306 BT_ASSERT(bt_component_get_class_type(upstream_comp
) ==
307 BT_COMPONENT_CLASS_TYPE_SOURCE
||
308 bt_component_get_class_type(upstream_comp
) ==
309 BT_COMPONENT_CLASS_TYPE_FILTER
);
311 struct bt_self_component_port_input_message_iterator
, 1);
313 BT_LIB_LOGE_APPEND_CAUSE(
314 "Failed to allocate one self component input port "
315 "message iterator.");
319 ret
= init_message_iterator((void *) iterator
,
320 BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
,
321 bt_self_component_port_input_message_iterator_destroy
);
323 /* init_message_iterator() logs errors */
327 iterator
->last_ns_from_origin
= INT64_MIN
;
329 iterator
->auto_seek
.msgs
= g_queue_new();
330 if (!iterator
->auto_seek
.msgs
) {
331 BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue.");
336 iterator
->upstream_component
= upstream_comp
;
337 iterator
->upstream_port
= upstream_port
;
338 iterator
->connection
= iterator
->upstream_port
->connection
;
339 iterator
->graph
= bt_component_borrow_graph(upstream_comp
);
340 set_self_comp_port_input_msg_iterator_state(iterator
,
341 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
);
343 switch (iterator
->upstream_component
->class->type
) {
344 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
346 struct bt_component_class_source
*src_comp_cls
=
347 (void *) iterator
->upstream_component
->class;
349 iterator
->methods
.next
=
350 (bt_self_component_port_input_message_iterator_next_method
)
351 src_comp_cls
->methods
.msg_iter_next
;
352 iterator
->methods
.seek_ns_from_origin
=
353 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
354 src_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
355 iterator
->methods
.seek_beginning
=
356 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
357 src_comp_cls
->methods
.msg_iter_seek_beginning
;
358 iterator
->methods
.can_seek_ns_from_origin
=
359 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
360 src_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
361 iterator
->methods
.can_seek_beginning
=
362 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
363 src_comp_cls
->methods
.msg_iter_can_seek_beginning
;
366 case BT_COMPONENT_CLASS_TYPE_FILTER
:
368 struct bt_component_class_filter
*flt_comp_cls
=
369 (void *) iterator
->upstream_component
->class;
371 iterator
->methods
.next
=
372 (bt_self_component_port_input_message_iterator_next_method
)
373 flt_comp_cls
->methods
.msg_iter_next
;
374 iterator
->methods
.seek_ns_from_origin
=
375 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
376 flt_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
377 iterator
->methods
.seek_beginning
=
378 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
379 flt_comp_cls
->methods
.msg_iter_seek_beginning
;
380 iterator
->methods
.can_seek_ns_from_origin
=
381 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
382 flt_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
383 iterator
->methods
.can_seek_beginning
=
384 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
385 flt_comp_cls
->methods
.msg_iter_can_seek_beginning
;
392 if (iterator
->methods
.seek_ns_from_origin
&&
393 !iterator
->methods
.can_seek_ns_from_origin
) {
394 iterator
->methods
.can_seek_ns_from_origin
=
395 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
396 can_seek_ns_from_origin_true
;
399 if (iterator
->methods
.seek_beginning
&&
400 !iterator
->methods
.can_seek_beginning
) {
401 iterator
->methods
.can_seek_beginning
=
402 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
403 can_seek_beginning_true
;
406 BT_LIB_LOGI("Created initial message iterator on self component input port: "
407 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
408 upstream_port
, upstream_comp
, iterator
);
412 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
418 struct bt_self_component_port_input_message_iterator
*
419 bt_self_component_port_input_message_iterator_create(
420 struct bt_self_component_port_input
*self_port
)
422 typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t
)(
423 void *, void *, void *);
425 init_method_t init_method
= NULL
;
426 struct bt_self_component_port_input_message_iterator
*iterator
=
428 struct bt_port
*port
= (void *) self_port
;
429 struct bt_port
*upstream_port
;
430 struct bt_component
*comp
;
431 struct bt_component
*upstream_comp
;
432 struct bt_component_class
*upstream_comp_cls
;
434 BT_ASSERT_PRE_NON_NULL(port
, "Port");
435 comp
= bt_port_borrow_component_inline(port
);
436 BT_ASSERT_PRE(bt_port_is_connected(port
),
437 "Port is not connected: %![port-]+p", port
);
438 BT_ASSERT_PRE(comp
, "Port is not part of a component: %![port-]+p",
440 BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp
),
441 "Port's component's graph is canceled: "
442 "%![port-]+p, %![comp-]+c", port
, comp
);
443 BT_ASSERT(port
->connection
);
444 upstream_port
= port
->connection
->upstream_port
;
445 BT_ASSERT(upstream_port
);
446 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
447 BT_ASSERT(upstream_comp
);
449 bt_component_borrow_graph(upstream_comp
)->config_state
!=
450 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
451 "Graph is not configured: %!+g",
452 bt_component_borrow_graph(upstream_comp
));
453 upstream_comp_cls
= upstream_comp
->class;
454 BT_ASSERT(upstream_comp
->class->type
==
455 BT_COMPONENT_CLASS_TYPE_SOURCE
||
456 upstream_comp
->class->type
==
457 BT_COMPONENT_CLASS_TYPE_FILTER
);
458 iterator
= bt_self_component_port_input_message_iterator_create_initial(
459 upstream_comp
, upstream_port
);
461 BT_LIB_LOGE_APPEND_CAUSE(
462 "Cannot create self component input port message iterator.");
466 switch (upstream_comp_cls
->type
) {
467 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
469 struct bt_component_class_source
*src_comp_cls
=
470 (void *) upstream_comp_cls
;
473 (init_method_t
) src_comp_cls
->methods
.msg_iter_init
;
476 case BT_COMPONENT_CLASS_TYPE_FILTER
:
478 struct bt_component_class_filter
*flt_comp_cls
=
479 (void *) upstream_comp_cls
;
482 (init_method_t
) flt_comp_cls
->methods
.msg_iter_init
;
491 enum bt_component_class_message_iterator_init_method_status iter_status
;
493 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator
);
494 iter_status
= init_method(iterator
, upstream_comp
,
496 BT_LOGD("User method returned: status=%s",
497 bt_common_func_status_string(iter_status
));
498 if (iter_status
!= BT_FUNC_STATUS_OK
) {
499 BT_LIB_LOGW_APPEND_CAUSE(
500 "Component input port message iterator initialization method failed: "
501 "%![iter-]+i, status=%s",
503 bt_common_func_status_string(iter_status
));
508 set_self_comp_port_input_msg_iterator_state(iterator
,
509 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
510 g_ptr_array_add(port
->connection
->iterators
, iterator
);
511 BT_LIB_LOGI("Created message iterator on self component input port: "
512 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
513 upstream_port
, upstream_comp
, iterator
);
517 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
523 void *bt_self_message_iterator_get_data(
524 const struct bt_self_message_iterator
*self_iterator
)
526 struct bt_self_component_port_input_message_iterator
*iterator
=
527 (void *) self_iterator
;
529 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
530 return iterator
->user_data
;
533 void bt_self_message_iterator_set_data(
534 struct bt_self_message_iterator
*self_iterator
, void *data
)
536 struct bt_self_component_port_input_message_iterator
*iterator
=
537 (void *) self_iterator
;
539 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
540 iterator
->user_data
= data
;
541 BT_LIB_LOGD("Set message iterator's user data: "
542 "%!+i, user-data-addr=%p", iterator
, data
);
546 * Validate that the default clock snapshot in `msg` doesn't make us go back in
552 bool clock_snapshots_are_monotonic_one(
553 struct bt_self_component_port_input_message_iterator
*iterator
,
554 const bt_message
*msg
)
556 const struct bt_clock_snapshot
*clock_snapshot
= NULL
;
557 bt_message_type message_type
= bt_message_get_type(msg
);
558 int64_t ns_from_origin
;
559 enum bt_clock_snapshot_get_ns_from_origin_status clock_snapshot_status
;
562 * The default is true: if we can't figure out the clock snapshot
563 * (or there is none), assume it is fine.
567 switch (message_type
) {
568 case BT_MESSAGE_TYPE_EVENT
:
570 struct bt_message_event
*event_msg
= (struct bt_message_event
*) msg
;
571 clock_snapshot
= event_msg
->default_cs
;
574 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
576 struct bt_message_message_iterator_inactivity
*inactivity_msg
=
577 (struct bt_message_message_iterator_inactivity
*) msg
;
578 clock_snapshot
= inactivity_msg
->default_cs
;
581 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
582 case BT_MESSAGE_TYPE_PACKET_END
:
584 struct bt_message_packet
*packet_msg
= (struct bt_message_packet
*) msg
;
585 clock_snapshot
= packet_msg
->default_cs
;
588 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
589 case BT_MESSAGE_TYPE_STREAM_END
:
591 struct bt_message_stream
*stream_msg
= (struct bt_message_stream
*) msg
;
592 if (stream_msg
->default_cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
596 clock_snapshot
= stream_msg
->default_cs
;
599 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
600 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
602 struct bt_message_discarded_items
*discarded_msg
=
603 (struct bt_message_discarded_items
*) msg
;
605 clock_snapshot
= discarded_msg
->default_begin_cs
;
610 if (!clock_snapshot
) {
614 clock_snapshot_status
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, &ns_from_origin
);
615 if (clock_snapshot_status
!= BT_FUNC_STATUS_OK
) {
619 result
= ns_from_origin
>= iterator
->last_ns_from_origin
;
620 iterator
->last_ns_from_origin
= ns_from_origin
;
627 bool clock_snapshots_are_monotonic(
628 struct bt_self_component_port_input_message_iterator
*iterator
,
629 bt_message_array_const msgs
, uint64_t msg_count
)
634 for (i
= 0; i
< msg_count
; i
++) {
635 if (!clock_snapshots_are_monotonic_one(iterator
, msgs
[i
])) {
648 * When a new stream begins, verify that the clock class tied to this
649 * stream is compatible with what we've seen before.
654 bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator
*iterator
,
655 const struct bt_message
*msg
)
657 enum bt_message_type message_type
= bt_message_get_type(msg
);
660 if (message_type
== BT_MESSAGE_TYPE_STREAM_BEGINNING
) {
661 const struct bt_message_stream
*stream_msg
= (struct bt_message_stream
*) msg
;
662 const struct bt_clock_class
*clock_class
= stream_msg
->stream
->class->default_clock_class
;
663 bt_uuid clock_class_uuid
= NULL
;
666 clock_class_uuid
= bt_clock_class_get_uuid(clock_class
);
669 switch (iterator
->clock_expectation
.type
) {
670 case CLOCK_EXPECTATION_UNSET
:
672 * This is the first time we see a message with a clock
673 * snapshot: record the properties of that clock, against
674 * which we'll compare the clock properties of the following
679 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_NONE
;
680 } else if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
681 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_UNIX
;
682 } else if (clock_class_uuid
) {
683 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
;
684 memcpy(iterator
->clock_expectation
.uuid
, clock_class_uuid
, BABELTRACE_UUID_LEN
);
686 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
;
690 case CLOCK_EXPECTATION_NONE
:
692 BT_ASSERT_POST_MSG("Expecting no clock class, got one: %![cc-]+K",
700 case CLOCK_EXPECTATION_ORIGIN_UNIX
:
702 BT_ASSERT_POST_MSG("Expecting a clock class, got none.");
707 if (!bt_clock_class_origin_is_unix_epoch(clock_class
)) {
708 BT_ASSERT_POST_MSG("Expecting a clock class with Unix epoch origin: %![cc-]+K",
715 case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
:
717 BT_ASSERT_POST_MSG("Expecting a clock class, got none.");
722 if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
723 BT_ASSERT_POST_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
729 if (!clock_class_uuid
) {
730 BT_ASSERT_POST_MSG("Expecting a clock class with UUID: %![cc-]+K",
736 if (bt_uuid_compare(iterator
->clock_expectation
.uuid
, clock_class_uuid
)) {
737 BT_ASSERT_POST_MSG("Expecting a clock class with UUID, got one "
738 "with a different UUID: %![cc-]+K, expected-uuid=%!u",
739 clock_class
, iterator
->clock_expectation
.uuid
);
745 case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
:
747 BT_ASSERT_POST_MSG("Expecting a clock class, got none.");
752 if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
753 BT_ASSERT_POST_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
759 if (clock_class_uuid
) {
760 BT_ASSERT_POST_MSG("Expecting a clock class without UUID: %![cc-]+K",
777 bool clock_classes_are_compatible(
778 struct bt_self_component_port_input_message_iterator
*iterator
,
779 bt_message_array_const msgs
, uint64_t msg_count
)
784 for (i
= 0; i
< msg_count
; i
++) {
785 if (!clock_classes_are_compatible_one(iterator
, msgs
[i
])) {
798 * Call the `next` method of the iterator. Do some validation on the returned
803 enum bt_component_class_message_iterator_next_method_status
804 call_iterator_next_method(
805 struct bt_self_component_port_input_message_iterator
*iterator
,
806 bt_message_array_const msgs
, uint64_t capacity
, uint64_t *user_count
)
808 enum bt_component_class_message_iterator_next_method_status status
;
810 BT_ASSERT(iterator
->methods
.next
);
811 BT_LOGD_STR("Calling user's \"next\" method.");
812 status
= iterator
->methods
.next(iterator
, msgs
, capacity
, user_count
);
813 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
814 bt_common_func_status_string(status
), *user_count
);
816 if (status
== BT_FUNC_STATUS_OK
) {
817 BT_ASSERT_POST(clock_classes_are_compatible(iterator
, msgs
, *user_count
),
818 "Clocks are not compatible");
819 BT_ASSERT_POST(clock_snapshots_are_monotonic(iterator
, msgs
, *user_count
),
820 "Clock snapshots are not monotonic");
826 enum bt_message_iterator_next_status
827 bt_self_component_port_input_message_iterator_next(
828 struct bt_self_component_port_input_message_iterator
*iterator
,
829 bt_message_array_const
*msgs
, uint64_t *user_count
)
831 enum bt_message_iterator_next_status status
= BT_FUNC_STATUS_OK
;
833 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
834 BT_ASSERT_PRE_NON_NULL(msgs
, "Message array (output)");
835 BT_ASSERT_PRE_NON_NULL(user_count
, "Message count (output)");
836 BT_ASSERT_PRE(iterator
->state
==
837 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
838 "Message iterator's \"next\" called, but "
839 "message iterator is in the wrong state: %!+i", iterator
);
840 BT_ASSERT(iterator
->upstream_component
);
841 BT_ASSERT(iterator
->upstream_component
->class);
843 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
844 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
845 "Graph is not configured: %!+g",
846 bt_component_borrow_graph(iterator
->upstream_component
));
847 BT_LIB_LOGD("Getting next self component input port "
848 "message iterator's messages: %!+i, batch-size=%u",
849 iterator
, MSG_BATCH_SIZE
);
852 * Call the user's "next" method to get the next messages
856 status
= (int) call_iterator_next_method(iterator
,
857 (void *) iterator
->base
.msgs
->pdata
, MSG_BATCH_SIZE
,
859 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
860 bt_common_func_status_string(status
), *user_count
);
862 BT_LIB_LOGW_APPEND_CAUSE(
863 "Component input port message iterator's \"next\" method failed: "
864 "%![iter-]+i, status=%s",
865 iterator
, bt_common_func_status_string(status
));
870 * There is no way that this iterator could have been finalized
871 * during its "next" method, as the only way to do this is to
872 * put the last iterator's reference, and this can only be done
873 * by its downstream owner.
875 * For the same reason, there is no way that this iterator could
876 * have seeked (cannot seek a self message iterator).
878 BT_ASSERT(iterator
->state
==
879 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
882 case BT_FUNC_STATUS_OK
:
883 BT_ASSERT_POST(*user_count
<= MSG_BATCH_SIZE
,
884 "Invalid returned message count: greater than "
885 "batch size: count=%" PRIu64
", batch-size=%u",
886 *user_count
, MSG_BATCH_SIZE
);
887 *msgs
= (void *) iterator
->base
.msgs
->pdata
;
889 case BT_FUNC_STATUS_AGAIN
:
891 case BT_FUNC_STATUS_END
:
892 set_self_comp_port_input_msg_iterator_state(iterator
,
893 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
);
896 /* Unknown non-error status */
904 enum bt_message_iterator_next_status
bt_port_output_message_iterator_next(
905 struct bt_port_output_message_iterator
*iterator
,
906 bt_message_array_const
*msgs_to_user
,
907 uint64_t *count_to_user
)
909 enum bt_message_iterator_next_status status
;
912 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
913 BT_ASSERT_PRE_NON_NULL(msgs_to_user
, "Message array (output)");
914 BT_ASSERT_PRE_NON_NULL(count_to_user
, "Message count (output)");
915 BT_LIB_LOGD("Getting next output port message iterator's messages: "
917 graph_status
= bt_graph_consume_sink_no_check(iterator
->graph
,
919 switch (graph_status
) {
920 case BT_FUNC_STATUS_CANCELED
:
921 case BT_FUNC_STATUS_AGAIN
:
922 case BT_FUNC_STATUS_END
:
923 case BT_FUNC_STATUS_MEMORY_ERROR
:
924 status
= (int) graph_status
;
926 case BT_FUNC_STATUS_OK
:
927 status
= BT_FUNC_STATUS_OK
;
930 * On success, the colander sink moves the messages
931 * to this iterator's array and sets this iterator's
932 * message count: move them to the user.
934 *msgs_to_user
= (void *) iterator
->base
.msgs
->pdata
;
935 *count_to_user
= iterator
->count
;
939 status
= BT_FUNC_STATUS_ERROR
;
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_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_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_NON_NULL(iterator
, "Message iterator");
968 return (void *) iterator
->upstream_component
;
971 struct bt_self_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_NON_NULL(iterator
, "Message iterator");
978 return (void *) iterator
->upstream_port
;
982 void bt_port_output_message_iterator_destroy(struct bt_object
*obj
)
984 struct bt_port_output_message_iterator
*iterator
= (void *) obj
;
986 BT_LIB_LOGI("Destroying output port message iterator object: %!+i",
988 BT_LOGD_STR("Putting graph.");
989 BT_OBJECT_PUT_REF_AND_RESET(iterator
->graph
);
990 BT_LOGD_STR("Putting colander sink component.");
991 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
992 destroy_base_message_iterator(obj
);
995 struct bt_port_output_message_iterator
*
996 bt_port_output_message_iterator_create(struct bt_graph
*graph
,
997 const struct bt_port_output
*output_port
)
999 struct bt_port_output_message_iterator
*iterator
= NULL
;
1000 struct bt_component_class_sink
*colander_comp_cls
= NULL
;
1001 struct bt_component
*output_port_comp
= NULL
;
1002 struct bt_component_sink
*colander_comp
;
1004 struct bt_port_input
*colander_in_port
= NULL
;
1005 struct bt_component_class_sink_colander_data colander_data
;
1008 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
1009 BT_ASSERT_PRE_NON_NULL(output_port
, "Output port");
1010 output_port_comp
= bt_port_borrow_component_inline(
1011 (const void *) output_port
);
1012 BT_ASSERT_PRE(output_port_comp
,
1013 "Output port has no component: %!+p", output_port
);
1014 BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp
) ==
1016 "Output port is not part of graph: %![graph-]+g, %![port-]+p",
1017 graph
, output_port
);
1018 BT_ASSERT_PRE(!graph
->has_sink
,
1019 "Graph already has a sink component: %![graph-]+g");
1021 /* Create message iterator */
1022 BT_LIB_LOGI("Creating message iterator on output port: "
1023 "%![port-]+p, %![comp-]+c", output_port
, output_port_comp
);
1024 iterator
= g_new0(struct bt_port_output_message_iterator
, 1);
1026 BT_LIB_LOGE_APPEND_CAUSE(
1027 "Failed to allocate one output port message iterator.");
1031 ret
= init_message_iterator((void *) iterator
,
1032 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
,
1033 bt_port_output_message_iterator_destroy
);
1035 /* init_message_iterator() logs errors */
1036 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
1040 /* Create colander component */
1041 colander_comp_cls
= bt_component_class_sink_colander_get();
1042 if (!colander_comp_cls
) {
1043 /* bt_component_class_sink_colander_get() logs errors */
1044 BT_LIB_LOGE_APPEND_CAUSE(
1045 "Cannot get colander sink component class.");
1049 iterator
->graph
= graph
;
1050 bt_object_get_no_null_check(iterator
->graph
);
1051 colander_data
.msgs
= (void *) iterator
->base
.msgs
->pdata
;
1052 colander_data
.count_addr
= &iterator
->count
;
1055 * Hope that nobody uses this very unique name.
1057 * We pass `BT_LOGGING_LEVEL_NONE` but the colander component
1058 * class module does not use this level anyway since it belongs
1061 graph_status
= bt_graph_add_sink_component_with_init_method_data(
1062 (void *) graph
, colander_comp_cls
,
1063 "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
1064 NULL
, &colander_data
, BT_LOGGING_LEVEL_NONE
,
1065 (void *) &iterator
->colander
);
1066 if (graph_status
!= BT_FUNC_STATUS_OK
) {
1067 BT_LIB_LOGE_APPEND_CAUSE(
1068 "Cannot add colander sink component to graph: "
1069 "%![graph-]+g, status=%s", graph
,
1070 bt_common_func_status_string(graph_status
));
1075 * Connect provided output port to the colander component's
1079 (void *) bt_component_sink_borrow_input_port_by_index_const(
1080 (void *) iterator
->colander
, 0);
1081 BT_ASSERT(colander_in_port
);
1082 graph_status
= bt_graph_connect_ports(graph
,
1083 output_port
, colander_in_port
, NULL
);
1084 if (graph_status
!= BT_FUNC_STATUS_OK
) {
1085 BT_LIB_LOGW_APPEND_CAUSE(
1086 "Cannot connect colander sink's port: "
1087 "%![graph-]+g, %![comp-]+c, status=%s", graph
,
1089 bt_common_func_status_string(graph_status
));
1094 * At this point everything went fine. Make the graph
1095 * nonconsumable forever so that only this message iterator
1096 * can consume (thanks to bt_graph_consume_sink_no_check()).
1097 * This avoids leaking the message created by the colander
1098 * sink and moved to the message iterator's message
1101 bt_graph_set_can_consume(iterator
->graph
, false);
1103 /* Also set the graph as being configured. */
1104 graph_status
= bt_graph_configure(graph
);
1105 if (graph_status
!= BT_FUNC_STATUS_OK
) {
1106 BT_LIB_LOGW_APPEND_CAUSE(
1107 "Cannot configure graph after having "
1108 "added and connected colander sink: "
1109 "%![graph-]+g, %![comp-]+c, status=%s", graph
,
1111 bt_common_func_status_string(graph_status
));
1117 if (iterator
&& iterator
->graph
&& iterator
->colander
) {
1120 /* Remove created colander component from graph if any */
1121 colander_comp
= iterator
->colander
;
1122 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
1125 * At this point the colander component's reference
1126 * count is 0 because iterator->colander was the only
1127 * owner. We also know that it is not connected because
1128 * this is the last operation before this function
1131 * Since we honor the preconditions here,
1132 * bt_graph_remove_unconnected_component() always
1135 ret
= bt_graph_remove_unconnected_component(iterator
->graph
,
1136 (void *) colander_comp
);
1137 BT_ASSERT(ret
== 0);
1140 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
1143 bt_object_put_ref(colander_comp_cls
);
1144 return (void *) iterator
;
1147 bt_bool
bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1148 struct bt_self_component_port_input_message_iterator
*iterator
,
1149 int64_t ns_from_origin
)
1151 bt_bool can
= BT_FALSE
;
1153 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1154 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1156 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1157 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1158 "Graph is not configured: %!+g",
1159 bt_component_borrow_graph(iterator
->upstream_component
));
1161 if (iterator
->methods
.can_seek_ns_from_origin
) {
1162 can
= iterator
->methods
.can_seek_ns_from_origin(iterator
,
1168 * Automatic seeking fall back: if we can seek to the beginning,
1169 * then we can automatically seek to any message.
1171 if (iterator
->methods
.can_seek_beginning
) {
1172 can
= iterator
->methods
.can_seek_beginning(iterator
);
1179 bt_bool
bt_self_component_port_input_message_iterator_can_seek_beginning(
1180 struct bt_self_component_port_input_message_iterator
*iterator
)
1182 bt_bool can
= BT_FALSE
;
1184 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1185 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1187 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1188 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1189 "Graph is not configured: %!+g",
1190 bt_component_borrow_graph(iterator
->upstream_component
));
1192 if (iterator
->methods
.can_seek_beginning
) {
1193 can
= iterator
->methods
.can_seek_beginning(iterator
);
1200 void set_iterator_state_after_seeking(
1201 struct bt_self_component_port_input_message_iterator
*iterator
,
1204 enum bt_self_component_port_input_message_iterator_state new_state
= 0;
1206 /* Set iterator's state depending on seeking status */
1208 case BT_FUNC_STATUS_OK
:
1209 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
;
1211 case BT_FUNC_STATUS_AGAIN
:
1212 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
;
1214 case BT_FUNC_STATUS_ERROR
:
1215 case BT_FUNC_STATUS_MEMORY_ERROR
:
1216 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
;
1218 case BT_FUNC_STATUS_END
:
1219 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
;
1225 set_self_comp_port_input_msg_iterator_state(iterator
, new_state
);
1229 void reset_iterator_expectations(
1230 struct bt_self_component_port_input_message_iterator
*iterator
)
1232 iterator
->last_ns_from_origin
= INT64_MIN
;
1233 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_UNSET
;
1236 enum bt_message_iterator_seek_beginning_status
1237 bt_self_component_port_input_message_iterator_seek_beginning(
1238 struct bt_self_component_port_input_message_iterator
*iterator
)
1242 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1243 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1245 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1246 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1247 "Graph is not configured: %!+g",
1248 bt_component_borrow_graph(iterator
->upstream_component
));
1250 bt_self_component_port_input_message_iterator_can_seek_beginning(
1252 "Message iterator cannot seek beginning: %!+i", iterator
);
1255 * We are seeking, reset our expectations about how the following
1256 * messages should look like.
1258 reset_iterator_expectations(iterator
);
1260 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator
);
1261 set_self_comp_port_input_msg_iterator_state(iterator
,
1262 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1263 status
= iterator
->methods
.seek_beginning(iterator
);
1264 BT_LOGD("User method returned: status=%s",
1265 bt_common_func_status_string(status
));
1266 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
1267 status
== BT_FUNC_STATUS_ERROR
||
1268 status
== BT_FUNC_STATUS_MEMORY_ERROR
||
1269 status
== BT_FUNC_STATUS_AGAIN
,
1270 "Unexpected status: %![iter-]+i, status=%s",
1271 iterator
, bt_common_func_status_string(status
));
1273 BT_LIB_LOGW_APPEND_CAUSE(
1274 "Component input port message iterator's \"seek beginning\" method failed: "
1275 "%![iter-]+i, status=%s",
1276 iterator
, bt_common_func_status_string(status
));
1279 set_iterator_state_after_seeking(iterator
, status
);
1284 * Structure used to record the state of a given stream during the fast-forward
1285 * phase of an auto-seek.
1287 struct auto_seek_stream_state
{
1289 * Value representing which step of this timeline we are at.
1292 * [SB] 1 [PB] 2 [PE] 1 [SE]
1294 * At each point in the timeline, the messages we need to replicate are:
1296 * 1: Stream beginning
1297 * 2: Stream beginning, packet beginning
1299 * Before "Stream beginning" and after "Stream end", we don't need to
1300 * replicate anything as the stream doesn't exist.
1303 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
,
1304 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
,
1308 * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
1309 * in. This is a weak reference, since the packet will always be
1310 * alive by the time we use it.
1312 struct bt_packet
*packet
;
1314 /* Have we see a message with a clock snapshot yet? */
1315 bool seen_clock_snapshot
;
1319 struct auto_seek_stream_state
*create_auto_seek_stream_state(void)
1321 return g_new0(struct auto_seek_stream_state
, 1);
1325 void destroy_auto_seek_stream_state(void *ptr
)
1331 GHashTable
*create_auto_seek_stream_states(void)
1333 return g_hash_table_new_full(g_direct_hash
, g_direct_equal
, NULL
,
1334 destroy_auto_seek_stream_state
);
1338 void destroy_auto_seek_stream_states(GHashTable
*stream_states
)
1340 g_hash_table_destroy(stream_states
);
1344 * Handle one message while we are in the fast-forward phase of an auto-seek.
1346 * Sets `*got_first` to true if the message's timestamp is greater or equal to
1347 * `ns_from_origin`. In other words, if this is the first message after our
1350 * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1351 * `struct auto_seek_stream_state` used to keep the state of each stream
1352 * during the fast-forward.
1356 int auto_seek_handle_message(
1357 struct bt_self_component_port_input_message_iterator
*iterator
,
1358 int64_t ns_from_origin
, const struct bt_message
*msg
,
1359 bool *got_first
, GHashTable
*stream_states
)
1361 int status
= BT_FUNC_STATUS_OK
;
1362 int64_t msg_ns_from_origin
;
1363 const struct bt_clock_snapshot
*clk_snapshot
= NULL
;
1367 BT_ASSERT(got_first
);
1369 switch (msg
->type
) {
1370 case BT_MESSAGE_TYPE_EVENT
:
1372 const struct bt_message_event
*event_msg
=
1375 clk_snapshot
= event_msg
->default_cs
;
1376 BT_ASSERT_POST(clk_snapshot
,
1377 "Event message has no default clock snapshot: %!+n",
1381 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1383 const struct bt_message_message_iterator_inactivity
*inactivity_msg
=
1386 clk_snapshot
= inactivity_msg
->default_cs
;
1387 BT_ASSERT(clk_snapshot
);
1390 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1391 case BT_MESSAGE_TYPE_PACKET_END
:
1393 const struct bt_message_packet
*packet_msg
=
1396 clk_snapshot
= packet_msg
->default_cs
;
1397 BT_ASSERT_POST(clk_snapshot
,
1398 "Packet message has no default clock snapshot: %!+n",
1402 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1403 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1405 struct bt_message_discarded_items
*msg_disc_items
=
1408 BT_ASSERT_POST(msg_disc_items
->default_begin_cs
&&
1409 msg_disc_items
->default_end_cs
,
1410 "Discarded events/packets message has no default clock snapshots: %!+n",
1412 ret
= bt_clock_snapshot_get_ns_from_origin(
1413 msg_disc_items
->default_begin_cs
,
1414 &msg_ns_from_origin
);
1416 status
= BT_FUNC_STATUS_ERROR
;
1420 if (msg_ns_from_origin
>= ns_from_origin
) {
1425 ret
= bt_clock_snapshot_get_ns_from_origin(
1426 msg_disc_items
->default_end_cs
,
1427 &msg_ns_from_origin
);
1429 status
= BT_FUNC_STATUS_ERROR
;
1433 if (msg_ns_from_origin
>= ns_from_origin
) {
1435 * The discarded items message's beginning time
1436 * is before the requested seeking time, but its
1437 * end time is after. Modify the message so as
1438 * to set its beginning time to the requested
1439 * seeking time, and make its item count unknown
1440 * as we don't know if items were really
1441 * discarded within the new time range.
1443 uint64_t new_begin_raw_value
;
1445 ret
= bt_clock_class_clock_value_from_ns_from_origin(
1446 msg_disc_items
->default_end_cs
->clock_class
,
1447 ns_from_origin
, &new_begin_raw_value
);
1449 status
= BT_FUNC_STATUS_ERROR
;
1453 bt_clock_snapshot_set_raw_value(
1454 msg_disc_items
->default_begin_cs
,
1455 new_begin_raw_value
);
1456 msg_disc_items
->count
.base
.avail
=
1457 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
1460 * It is safe to push it because its beginning
1461 * time is exactly the requested seeking time.
1468 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1469 case BT_MESSAGE_TYPE_STREAM_END
:
1471 struct bt_message_stream
*stream_msg
=
1472 (struct bt_message_stream
*) msg
;
1474 if (stream_msg
->default_cs_state
!= BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
1479 clk_snapshot
= stream_msg
->default_cs
;
1486 BT_ASSERT(clk_snapshot
);
1487 ret
= bt_clock_snapshot_get_ns_from_origin(clk_snapshot
,
1488 &msg_ns_from_origin
);
1490 status
= BT_FUNC_STATUS_ERROR
;
1494 if (msg_ns_from_origin
>= ns_from_origin
) {
1500 /* This message won't be sent downstream. */
1501 switch (msg
->type
) {
1502 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1504 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1505 struct auto_seek_stream_state
*stream_state
;
1507 /* Update stream's state: stream began. */
1508 stream_state
= create_auto_seek_stream_state();
1509 if (!stream_state
) {
1510 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1514 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1516 if (stream_msg
->default_cs_state
== BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN
) {
1517 stream_state
->seen_clock_snapshot
= true;
1520 BT_ASSERT(!bt_g_hash_table_contains(stream_states
, stream_msg
->stream
));
1521 g_hash_table_insert(stream_states
, stream_msg
->stream
, stream_state
);
1524 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1526 const struct bt_message_packet
*packet_msg
=
1528 struct auto_seek_stream_state
*stream_state
;
1530 /* Update stream's state: packet began. */
1531 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1532 BT_ASSERT(stream_state
);
1534 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1535 stream_state
->state
= AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
;
1536 BT_ASSERT(!stream_state
->packet
);
1537 stream_state
->packet
= packet_msg
->packet
;
1539 if (packet_msg
->packet
->stream
->class->packets_have_beginning_default_clock_snapshot
) {
1540 stream_state
->seen_clock_snapshot
= true;
1545 case BT_MESSAGE_TYPE_EVENT
:
1547 const struct bt_message_event
*event_msg
= (const void *) msg
;
1548 struct auto_seek_stream_state
*stream_state
;
1550 stream_state
= g_hash_table_lookup(stream_states
,
1551 event_msg
->event
->packet
->stream
);
1552 BT_ASSERT(stream_state
);
1554 // HELPME: are we sure that event messages have clock snapshots at this point?
1555 stream_state
->seen_clock_snapshot
= true;
1559 case BT_MESSAGE_TYPE_PACKET_END
:
1561 const struct bt_message_packet
*packet_msg
=
1563 struct auto_seek_stream_state
*stream_state
;
1565 /* Update stream's state: packet ended. */
1566 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1567 BT_ASSERT(stream_state
);
1569 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
);
1570 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1571 BT_ASSERT(stream_state
->packet
);
1572 stream_state
->packet
= NULL
;
1574 if (packet_msg
->packet
->stream
->class->packets_have_end_default_clock_snapshot
) {
1575 stream_state
->seen_clock_snapshot
= true;
1580 case BT_MESSAGE_TYPE_STREAM_END
:
1582 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1583 struct auto_seek_stream_state
*stream_state
;
1585 stream_state
= g_hash_table_lookup(stream_states
, stream_msg
->stream
);
1586 BT_ASSERT(stream_state
);
1587 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1588 BT_ASSERT(!stream_state
->packet
);
1590 /* Update stream's state: this stream doesn't exist anymore. */
1591 g_hash_table_remove(stream_states
, stream_msg
->stream
);
1594 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1595 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1597 const struct bt_message_discarded_items
*discarded_msg
=
1599 struct auto_seek_stream_state
*stream_state
;
1601 stream_state
= g_hash_table_lookup(stream_states
, discarded_msg
->stream
);
1602 BT_ASSERT(stream_state
);
1604 if ((msg
->type
== BT_MESSAGE_TYPE_DISCARDED_EVENTS
&& discarded_msg
->stream
->class->discarded_events_have_default_clock_snapshots
) ||
1605 (msg
->type
== BT_MESSAGE_TYPE_DISCARDED_PACKETS
&& discarded_msg
->stream
->class->discarded_packets_have_default_clock_snapshots
)) {
1606 stream_state
->seen_clock_snapshot
= true;
1615 bt_object_put_no_null_check(msg
);
1620 g_queue_push_tail(iterator
->auto_seek
.msgs
, (void *) msg
);
1624 BT_ASSERT(!msg
|| status
!= BT_FUNC_STATUS_OK
);
1629 int find_message_ge_ns_from_origin(
1630 struct bt_self_component_port_input_message_iterator
*iterator
,
1631 int64_t ns_from_origin
, GHashTable
*stream_states
)
1634 enum bt_self_component_port_input_message_iterator_state init_state
=
1636 const struct bt_message
*messages
[MSG_BATCH_SIZE
];
1637 uint64_t user_count
= 0;
1639 bool got_first
= false;
1641 BT_ASSERT(iterator
);
1642 memset(&messages
[0], 0, sizeof(messages
[0]) * MSG_BATCH_SIZE
);
1645 * Make this iterator temporarily active (not seeking) to call
1646 * the "next" method.
1648 set_self_comp_port_input_msg_iterator_state(iterator
,
1649 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1651 BT_ASSERT(iterator
->methods
.next
);
1653 while (!got_first
) {
1655 * Call the user's "next" method to get the next
1656 * messages and status.
1658 status
= call_iterator_next_method(iterator
,
1659 &messages
[0], MSG_BATCH_SIZE
, &user_count
);
1660 BT_LOGD("User method returned: status=%s",
1661 bt_common_func_status_string(status
));
1663 BT_LIB_LOGW_APPEND_CAUSE(
1664 "Component input port message iterator's \"next\" method failed: "
1665 "%![iter-]+i, status=%s",
1666 iterator
, bt_common_func_status_string(status
));
1670 * The user's "next" method must not do any action which
1671 * would change the iterator's state.
1673 BT_ASSERT(iterator
->state
==
1674 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1677 case BT_FUNC_STATUS_OK
:
1678 BT_ASSERT_POST(user_count
<= MSG_BATCH_SIZE
,
1679 "Invalid returned message count: greater than "
1680 "batch size: count=%" PRIu64
", batch-size=%u",
1681 user_count
, MSG_BATCH_SIZE
);
1683 case BT_FUNC_STATUS_AGAIN
:
1684 case BT_FUNC_STATUS_ERROR
:
1685 case BT_FUNC_STATUS_MEMORY_ERROR
:
1686 case BT_FUNC_STATUS_END
:
1692 for (i
= 0; i
< user_count
; i
++) {
1694 g_queue_push_tail(iterator
->auto_seek
.msgs
,
1695 (void *) messages
[i
]);
1700 status
= auto_seek_handle_message(iterator
,
1701 ns_from_origin
, messages
[i
], &got_first
,
1703 if (status
== BT_FUNC_STATUS_OK
) {
1704 /* Message was either pushed or moved */
1713 for (i
= 0; i
< user_count
; i
++) {
1715 bt_object_put_no_null_check(messages
[i
]);
1719 set_self_comp_port_input_msg_iterator_state(iterator
, init_state
);
1724 * This function is installed as the iterator's next callback after we have
1725 * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1726 * messages saved in iterator->auto_seek.msgs. Once this is done, the original
1727 * next callback is put back.
1731 enum bt_component_class_message_iterator_next_method_status
post_auto_seek_next(
1732 struct bt_self_component_port_input_message_iterator
*iterator
,
1733 bt_message_array_const msgs
, uint64_t capacity
,
1736 BT_ASSERT(!g_queue_is_empty(iterator
->auto_seek
.msgs
));
1740 * Move auto-seek messages to the output array (which is this
1741 * iterator's base message array).
1743 while (capacity
> 0 && !g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1744 msgs
[*count
] = g_queue_pop_head(iterator
->auto_seek
.msgs
);
1749 BT_ASSERT(*count
> 0);
1751 if (g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1752 /* No more auto-seek messages, restore user's next callback. */
1753 BT_ASSERT(iterator
->auto_seek
.original_next_callback
);
1754 iterator
->methods
.next
= iterator
->auto_seek
.original_next_callback
;
1755 iterator
->auto_seek
.original_next_callback
= NULL
;
1758 return BT_FUNC_STATUS_OK
;
1762 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1763 int64_t ns_from_origin
, uint64_t *raw_value
)
1766 int64_t cc_offset_s
= clock_class
->offset_seconds
;
1767 uint64_t cc_offset_cycles
= clock_class
->offset_cycles
;
1768 uint64_t cc_freq
= clock_class
->frequency
;
1770 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1771 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1775 enum bt_message_iterator_seek_ns_from_origin_status
1776 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1777 struct bt_self_component_port_input_message_iterator
*iterator
,
1778 int64_t ns_from_origin
)
1781 GHashTable
*stream_states
= NULL
;
1783 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1784 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1786 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1787 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1788 "Graph is not configured: %!+g",
1789 bt_component_borrow_graph(iterator
->upstream_component
));
1791 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1792 iterator
, ns_from_origin
),
1793 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1794 "ns-from-origin=%" PRId64
, iterator
, ns_from_origin
);
1795 set_self_comp_port_input_msg_iterator_state(iterator
,
1796 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1799 * We are seeking, reset our expectations about how the following
1800 * messages should look like.
1802 reset_iterator_expectations(iterator
);
1804 if (iterator
->methods
.seek_ns_from_origin
) {
1805 /* The iterator knows how to seek to a particular time, let it handle this. */
1806 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1807 "%![iter-]+i, ns=%" PRId64
, iterator
, ns_from_origin
);
1808 status
= iterator
->methods
.seek_ns_from_origin(iterator
,
1810 BT_LOGD("User method returned: status=%s",
1811 bt_common_func_status_string(status
));
1812 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
1813 status
== BT_FUNC_STATUS_ERROR
||
1814 status
== BT_FUNC_STATUS_MEMORY_ERROR
||
1815 status
== BT_FUNC_STATUS_AGAIN
,
1816 "Unexpected status: %![iter-]+i, status=%s",
1817 iterator
, bt_common_func_status_string(status
));
1819 BT_LIB_LOGW_APPEND_CAUSE(
1820 "Component input port message iterator's \"seek nanoseconds from origin\" method failed: "
1821 "%![iter-]+i, status=%s",
1822 iterator
, bt_common_func_status_string(status
));
1826 * The iterator doesn't know how to seek to a particular time. We will
1827 * seek to the beginning and fast forward to the right place.
1829 BT_ASSERT(iterator
->methods
.can_seek_beginning(iterator
));
1830 BT_ASSERT(iterator
->methods
.seek_beginning
);
1831 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1833 status
= iterator
->methods
.seek_beginning(iterator
);
1834 BT_LOGD("User method returned: status=%s",
1835 bt_common_func_status_string(status
));
1836 BT_ASSERT_POST(status
== BT_FUNC_STATUS_OK
||
1837 status
== BT_FUNC_STATUS_ERROR
||
1838 status
== BT_FUNC_STATUS_MEMORY_ERROR
||
1839 status
== BT_FUNC_STATUS_AGAIN
,
1840 "Unexpected status: %![iter-]+i, status=%s",
1841 iterator
, bt_common_func_status_string(status
));
1843 BT_LIB_LOGW_APPEND_CAUSE(
1844 "Component input port message iterator's \"seek beginning\" method failed: "
1845 "%![iter-]+i, status=%s",
1846 iterator
, bt_common_func_status_string(status
));
1850 case BT_FUNC_STATUS_OK
:
1852 case BT_FUNC_STATUS_ERROR
:
1853 case BT_FUNC_STATUS_MEMORY_ERROR
:
1854 case BT_FUNC_STATUS_AGAIN
:
1861 * Find the first message which has a default clock
1862 * snapshot greater than or equal to the requested
1863 * seeking time, and move the received messages from
1864 * this point in the batch to this iterator's auto-seek
1867 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1868 bt_object_put_no_null_check(
1869 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
1872 stream_states
= create_auto_seek_stream_states();
1873 if (!stream_states
) {
1874 BT_LIB_LOGE_APPEND_CAUSE(
1875 "Failed to allocate one GHashTable.");
1876 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1880 status
= find_message_ge_ns_from_origin(iterator
,
1881 ns_from_origin
, stream_states
);
1883 case BT_FUNC_STATUS_OK
:
1884 case BT_FUNC_STATUS_END
:
1886 GHashTableIter iter
;
1887 gpointer key
, value
;
1890 * If some streams exist at the seek time, prepend the
1891 * required messages to put those streams in the right
1894 g_hash_table_iter_init(&iter
, stream_states
);
1895 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
1896 const bt_stream
*stream
= key
;
1897 struct auto_seek_stream_state
*stream_state
=
1898 (struct auto_seek_stream_state
*) value
;
1900 const bt_clock_class
*clock_class
= bt_stream_class_borrow_default_clock_class_const(
1901 bt_stream_borrow_class_const(stream
));
1902 /* Initialize to silence maybe-uninitialized warning. */
1903 uint64_t raw_value
= 0;
1906 * If we haven't seen a message with a clock snapshot, we don't know if our seek time is within
1907 * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value.
1909 * Also, it would be a bit of a lie to generate a stream begin message with the seek time as its
1910 * clock snapshot, because we don't really know if the stream existed at that time. If we have
1911 * seen a message with a clock snapshot in our seeking, then we are sure that the
1912 * seek time is not below the clock range, and we know the stream was active at that
1913 * time (and that we cut it short).
1915 if (stream_state
->seen_clock_snapshot
) {
1916 if (clock_raw_value_from_ns_from_origin(clock_class
, ns_from_origin
, &raw_value
) != 0) {
1917 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64
", %![cc-]+K",
1918 ns_from_origin
, clock_class
);
1919 status
= BT_FUNC_STATUS_ERROR
;
1924 switch (stream_state
->state
) {
1925 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
:
1926 BT_ASSERT(stream_state
->packet
);
1927 BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state
->packet
);
1929 if (stream
->class->packets_have_beginning_default_clock_snapshot
) {
1931 * If we are in the PACKET_BEGAN state, it means we have seen a "packet beginning"
1932 * message. If "packet beginning" packets have clock snapshots, then we must have
1933 * seen a clock snapshot.
1935 BT_ASSERT(stream_state
->seen_clock_snapshot
);
1937 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1938 (bt_self_message_iterator
*) iterator
, stream_state
->packet
, raw_value
);
1940 msg
= bt_message_packet_beginning_create((bt_self_message_iterator
*) iterator
,
1941 stream_state
->packet
);
1945 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1949 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1953 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
:
1954 msg
= bt_message_stream_beginning_create(
1955 (bt_self_message_iterator
*) iterator
, stream
);
1957 status
= BT_FUNC_STATUS_MEMORY_ERROR
;
1961 if (stream_state
->seen_clock_snapshot
) {
1962 bt_message_stream_beginning_set_default_clock_snapshot(msg
, raw_value
);
1965 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1972 * If there are messages in the auto-seek
1973 * message queue, replace the user's "next"
1974 * method with a custom, temporary "next" method
1975 * which returns them.
1977 if (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1978 BT_ASSERT(!iterator
->auto_seek
.original_next_callback
);
1979 iterator
->auto_seek
.original_next_callback
= iterator
->methods
.next
;
1981 iterator
->methods
.next
=
1982 (bt_self_component_port_input_message_iterator_next_method
)
1983 post_auto_seek_next
;
1987 * `BT_FUNC_STATUS_END` becomes
1988 * `BT_FUNC_STATUS_OK`: the next
1989 * time this iterator's "next" method is called,
1991 * `BT_FUNC_STATUS_END`.
1993 status
= BT_FUNC_STATUS_OK
;
1996 case BT_FUNC_STATUS_ERROR
:
1997 case BT_FUNC_STATUS_MEMORY_ERROR
:
1998 case BT_FUNC_STATUS_AGAIN
:
2006 * The following messages returned by the next method (including
2007 * post_auto_seek_next) must be after (or at) `ns_from_origin`.
2009 iterator
->last_ns_from_origin
= ns_from_origin
;
2012 if (stream_states
) {
2013 destroy_auto_seek_stream_states(stream_states
);
2014 stream_states
= NULL
;
2017 set_iterator_state_after_seeking(iterator
, status
);
2022 bt_self_component_port_input_message_iterator
*
2023 borrow_output_port_message_iterator_upstream_iterator(
2024 struct bt_port_output_message_iterator
*iterator
)
2026 struct bt_component_class_sink_colander_priv_data
*colander_data
;
2028 BT_ASSERT(iterator
);
2029 colander_data
= (void *) iterator
->colander
->parent
.user_data
;
2030 BT_ASSERT(colander_data
);
2031 BT_ASSERT(colander_data
->msg_iter
);
2032 return colander_data
->msg_iter
;
2035 bt_bool
bt_port_output_message_iterator_can_seek_ns_from_origin(
2036 struct bt_port_output_message_iterator
*iterator
,
2037 int64_t ns_from_origin
)
2039 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2040 return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
2041 borrow_output_port_message_iterator_upstream_iterator(
2042 iterator
), ns_from_origin
);
2045 bt_bool
bt_port_output_message_iterator_can_seek_beginning(
2046 struct bt_port_output_message_iterator
*iterator
)
2048 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2049 return bt_self_component_port_input_message_iterator_can_seek_beginning(
2050 borrow_output_port_message_iterator_upstream_iterator(
2054 enum bt_message_iterator_seek_ns_from_origin_status
2055 bt_port_output_message_iterator_seek_ns_from_origin(
2056 struct bt_port_output_message_iterator
*iterator
,
2057 int64_t ns_from_origin
)
2059 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2060 return bt_self_component_port_input_message_iterator_seek_ns_from_origin(
2061 borrow_output_port_message_iterator_upstream_iterator(iterator
),
2065 enum bt_message_iterator_seek_beginning_status
2066 bt_port_output_message_iterator_seek_beginning(
2067 struct bt_port_output_message_iterator
*iterator
)
2069 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2070 return bt_self_component_port_input_message_iterator_seek_beginning(
2071 borrow_output_port_message_iterator_upstream_iterator(
2075 void bt_port_output_message_iterator_get_ref(
2076 const struct bt_port_output_message_iterator
*iterator
)
2078 bt_object_get_ref(iterator
);
2081 void bt_port_output_message_iterator_put_ref(
2082 const struct bt_port_output_message_iterator
*iterator
)
2084 bt_object_put_ref(iterator
);
2087 void bt_self_component_port_input_message_iterator_get_ref(
2088 const struct bt_self_component_port_input_message_iterator
*iterator
)
2090 bt_object_get_ref(iterator
);
2093 void bt_self_component_port_input_message_iterator_put_ref(
2094 const struct bt_self_component_port_input_message_iterator
*iterator
)
2096 bt_object_put_ref(iterator
);