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/graph/connection-const.h>
38 #include <babeltrace2/graph/component-const.h>
39 #include <babeltrace2/graph/component-sink-const.h>
40 #include <babeltrace2/graph/message-const.h>
41 #include <babeltrace2/graph/message-iterator-const.h>
42 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
43 #include <babeltrace2/graph/port-output-message-iterator.h>
44 #include <babeltrace2/graph/message-event-const.h>
45 #include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
46 #include <babeltrace2/graph/message-packet-beginning.h>
47 #include <babeltrace2/graph/message-packet-beginning-const.h>
48 #include <babeltrace2/graph/message-packet-end-const.h>
49 #include <babeltrace2/graph/message-stream-activity-beginning.h>
50 #include <babeltrace2/graph/message-stream-activity-beginning-const.h>
51 #include <babeltrace2/graph/message-stream-activity-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"
65 #include "component-class.h"
66 #include "component-class-sink-colander.h"
67 #include "component.h"
68 #include "component-sink.h"
69 #include "component-source.h"
70 #include "connection.h"
72 #include "message/discarded-items.h"
73 #include "message/event.h"
74 #include "message/iterator.h"
75 #include "message/message.h"
76 #include "message/message-iterator-inactivity.h"
77 #include "message/stream.h"
78 #include "message/packet.h"
79 #include "message/stream-activity.h"
82 * TODO: Use graph's state (number of active iterators, etc.) and
83 * possibly system specifications to make a better guess than this.
85 #define MSG_BATCH_SIZE 15
87 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
88 BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
89 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
90 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
91 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
92 "Message iterator is in the wrong state: %!+i", _iter)
95 void set_self_comp_port_input_msg_iterator_state(
96 struct bt_self_component_port_input_message_iterator
*iterator
,
97 enum bt_self_component_port_input_message_iterator_state state
)
100 BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
101 bt_self_component_port_input_message_iterator_state_string(state
));
102 iterator
->state
= state
;
106 void destroy_base_message_iterator(struct bt_object
*obj
)
108 struct bt_message_iterator
*iterator
= (void *) obj
;
112 if (iterator
->msgs
) {
113 g_ptr_array_free(iterator
->msgs
, TRUE
);
114 iterator
->msgs
= NULL
;
121 void bt_self_component_port_input_message_iterator_destroy(struct bt_object
*obj
)
123 struct bt_self_component_port_input_message_iterator
*iterator
;
128 * The message iterator's reference count is 0 if we're
129 * here. Increment it to avoid a double-destroy (possibly
130 * infinitely recursive). This could happen for example if the
131 * message iterator's finalization function does
132 * bt_object_get_ref() (or anything that causes
133 * bt_object_get_ref() to be called) on itself (ref. count goes
134 * from 0 to 1), and then bt_object_put_ref(): the reference
135 * count would go from 1 to 0 again and this function would be
139 iterator
= (void *) obj
;
140 BT_LIB_LOGI("Destroying self component input port message iterator object: "
142 bt_self_component_port_input_message_iterator_try_finalize(iterator
);
144 if (iterator
->connection
) {
146 * Remove ourself from the originating connection so
147 * that it does not try to finalize a dangling pointer
150 bt_connection_remove_iterator(iterator
->connection
, iterator
);
151 iterator
->connection
= NULL
;
154 if (iterator
->auto_seek
.msgs
) {
155 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
156 bt_object_put_no_null_check(
157 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
160 g_queue_free(iterator
->auto_seek
.msgs
);
161 iterator
->auto_seek
.msgs
= NULL
;
164 destroy_base_message_iterator(obj
);
168 void bt_self_component_port_input_message_iterator_try_finalize(
169 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
:
190 /* Already finalized */
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 iterator
->upstream_component
= NULL
;
234 iterator
->upstream_port
= NULL
;
235 set_self_comp_port_input_msg_iterator_state(iterator
,
236 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
);
237 BT_LIB_LOGD("Finalized message iterator: %!+i", iterator
);
244 void bt_self_component_port_input_message_iterator_set_connection(
245 struct bt_self_component_port_input_message_iterator
*iterator
,
246 struct bt_connection
*connection
)
249 iterator
->connection
= connection
;
250 BT_LIB_LOGI("Set message iterator's connection: "
251 "%![iter-]+i, %![conn-]+x", iterator
, connection
);
255 int init_message_iterator(struct bt_message_iterator
*iterator
,
256 enum bt_message_iterator_type type
,
257 bt_object_release_func destroy
)
261 bt_object_init_shared(&iterator
->base
, destroy
);
262 iterator
->type
= type
;
263 iterator
->msgs
= g_ptr_array_new();
264 if (!iterator
->msgs
) {
265 BT_LOGE_STR("Failed to allocate a GPtrArray.");
270 g_ptr_array_set_size(iterator
->msgs
, MSG_BATCH_SIZE
);
277 bt_bool
can_seek_ns_from_origin_true(
278 struct bt_self_component_port_input_message_iterator
*iterator
,
279 int64_t ns_from_origin
)
285 bt_bool
can_seek_beginning_true(
286 struct bt_self_component_port_input_message_iterator
*iterator
)
292 struct bt_self_component_port_input_message_iterator
*
293 bt_self_component_port_input_message_iterator_create_initial(
294 struct bt_component
*upstream_comp
,
295 struct bt_port
*upstream_port
)
298 struct bt_self_component_port_input_message_iterator
*iterator
= NULL
;
300 BT_ASSERT(upstream_comp
);
301 BT_ASSERT(upstream_port
);
302 BT_ASSERT(bt_port_is_connected(upstream_port
));
303 BT_LIB_LOGI("Creating initial message iterator on self component input port: "
304 "%![up-comp-]+c, %![up-port-]+p", upstream_comp
, upstream_port
);
305 BT_ASSERT(bt_component_get_class_type(upstream_comp
) ==
306 BT_COMPONENT_CLASS_TYPE_SOURCE
||
307 bt_component_get_class_type(upstream_comp
) ==
308 BT_COMPONENT_CLASS_TYPE_FILTER
);
310 struct bt_self_component_port_input_message_iterator
, 1);
312 BT_LOGE_STR("Failed to allocate one self component input port "
313 "message iterator.");
317 ret
= init_message_iterator((void *) iterator
,
318 BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
,
319 bt_self_component_port_input_message_iterator_destroy
);
321 /* init_message_iterator() logs errors */
322 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
326 iterator
->last_ns_from_origin
= INT64_MIN
;
328 iterator
->auto_seek
.msgs
= g_queue_new();
329 if (!iterator
->auto_seek
.msgs
) {
330 BT_LOGE_STR("Failed to allocate a GQueue.");
335 iterator
->upstream_component
= upstream_comp
;
336 iterator
->upstream_port
= upstream_port
;
337 iterator
->connection
= iterator
->upstream_port
->connection
;
338 iterator
->graph
= bt_component_borrow_graph(upstream_comp
);
339 set_self_comp_port_input_msg_iterator_state(iterator
,
340 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
);
342 switch (iterator
->upstream_component
->class->type
) {
343 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
345 struct bt_component_class_source
*src_comp_cls
=
346 (void *) iterator
->upstream_component
->class;
348 iterator
->methods
.next
=
349 (bt_self_component_port_input_message_iterator_next_method
)
350 src_comp_cls
->methods
.msg_iter_next
;
351 iterator
->methods
.seek_ns_from_origin
=
352 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
353 src_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
354 iterator
->methods
.seek_beginning
=
355 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
356 src_comp_cls
->methods
.msg_iter_seek_beginning
;
357 iterator
->methods
.can_seek_ns_from_origin
=
358 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
359 src_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
360 iterator
->methods
.can_seek_beginning
=
361 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
362 src_comp_cls
->methods
.msg_iter_can_seek_beginning
;
365 case BT_COMPONENT_CLASS_TYPE_FILTER
:
367 struct bt_component_class_filter
*flt_comp_cls
=
368 (void *) iterator
->upstream_component
->class;
370 iterator
->methods
.next
=
371 (bt_self_component_port_input_message_iterator_next_method
)
372 flt_comp_cls
->methods
.msg_iter_next
;
373 iterator
->methods
.seek_ns_from_origin
=
374 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
375 flt_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
376 iterator
->methods
.seek_beginning
=
377 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
378 flt_comp_cls
->methods
.msg_iter_seek_beginning
;
379 iterator
->methods
.can_seek_ns_from_origin
=
380 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
381 flt_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
382 iterator
->methods
.can_seek_beginning
=
383 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
384 flt_comp_cls
->methods
.msg_iter_can_seek_beginning
;
391 if (iterator
->methods
.seek_ns_from_origin
&&
392 !iterator
->methods
.can_seek_ns_from_origin
) {
393 iterator
->methods
.can_seek_ns_from_origin
=
394 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
395 can_seek_ns_from_origin_true
;
398 if (iterator
->methods
.seek_beginning
&&
399 !iterator
->methods
.can_seek_beginning
) {
400 iterator
->methods
.can_seek_beginning
=
401 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
402 can_seek_beginning_true
;
405 BT_LIB_LOGI("Created initial message iterator on self component input port: "
406 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
407 upstream_port
, upstream_comp
, iterator
);
413 struct bt_self_component_port_input_message_iterator
*
414 bt_self_component_port_input_message_iterator_create(
415 struct bt_self_component_port_input
*self_port
)
417 typedef enum bt_self_message_iterator_status (*init_method_t
)(
418 void *, void *, void *);
420 init_method_t init_method
= NULL
;
421 struct bt_self_component_port_input_message_iterator
*iterator
=
423 struct bt_port
*port
= (void *) self_port
;
424 struct bt_port
*upstream_port
;
425 struct bt_component
*comp
;
426 struct bt_component
*upstream_comp
;
427 struct bt_component_class
*upstream_comp_cls
;
429 BT_ASSERT_PRE_NON_NULL(port
, "Port");
430 comp
= bt_port_borrow_component_inline(port
);
431 BT_ASSERT_PRE(bt_port_is_connected(port
),
432 "Port is not connected: %![port-]+p", port
);
433 BT_ASSERT_PRE(comp
, "Port is not part of a component: %![port-]+p",
435 BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp
),
436 "Port's component's graph is canceled: "
437 "%![port-]+p, %![comp-]+c", port
, comp
);
438 BT_ASSERT(port
->connection
);
439 upstream_port
= port
->connection
->upstream_port
;
440 BT_ASSERT(upstream_port
);
441 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
442 BT_ASSERT(upstream_comp
);
444 bt_component_borrow_graph(upstream_comp
)->config_state
!=
445 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
446 "Graph is not configured: %!+g",
447 bt_component_borrow_graph(upstream_comp
));
448 upstream_comp_cls
= upstream_comp
->class;
449 BT_ASSERT(upstream_comp
->class->type
==
450 BT_COMPONENT_CLASS_TYPE_SOURCE
||
451 upstream_comp
->class->type
==
452 BT_COMPONENT_CLASS_TYPE_FILTER
);
453 iterator
= bt_self_component_port_input_message_iterator_create_initial(
454 upstream_comp
, upstream_port
);
456 BT_LOGW_STR("Cannot create self component input port "
457 "message iterator.");
461 switch (upstream_comp_cls
->type
) {
462 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
464 struct bt_component_class_source
*src_comp_cls
=
465 (void *) upstream_comp_cls
;
468 (init_method_t
) src_comp_cls
->methods
.msg_iter_init
;
471 case BT_COMPONENT_CLASS_TYPE_FILTER
:
473 struct bt_component_class_filter
*flt_comp_cls
=
474 (void *) upstream_comp_cls
;
477 (init_method_t
) flt_comp_cls
->methods
.msg_iter_init
;
488 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator
);
489 iter_status
= init_method(iterator
, upstream_comp
,
491 BT_LOGD("User method returned: status=%s",
492 bt_message_iterator_status_string(iter_status
));
493 if (iter_status
!= BT_MESSAGE_ITERATOR_STATUS_OK
) {
494 BT_LOGW_STR("Initialization method failed.");
495 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
500 set_self_comp_port_input_msg_iterator_state(iterator
,
501 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
502 g_ptr_array_add(port
->connection
->iterators
, iterator
);
503 BT_LIB_LOGI("Created message iterator on self component input port: "
504 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
505 upstream_port
, upstream_comp
, iterator
);
511 void *bt_self_message_iterator_get_data(
512 const struct bt_self_message_iterator
*self_iterator
)
514 struct bt_self_component_port_input_message_iterator
*iterator
=
515 (void *) self_iterator
;
517 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
518 return iterator
->user_data
;
521 void bt_self_message_iterator_set_data(
522 struct bt_self_message_iterator
*self_iterator
, void *data
)
524 struct bt_self_component_port_input_message_iterator
*iterator
=
525 (void *) self_iterator
;
527 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
528 iterator
->user_data
= data
;
529 BT_LIB_LOGD("Set message iterator's user data: "
530 "%!+i, user-data-addr=%p", iterator
, data
);
534 * Validate that the default clock snapshot in `msg` doesn't make us go back in
540 bool clock_snapshots_are_monotonic_one(
541 struct bt_self_component_port_input_message_iterator
*iterator
,
542 const bt_message
*msg
)
544 const struct bt_clock_snapshot
*clock_snapshot
= NULL
;
545 bt_message_type message_type
= bt_message_get_type(msg
);
546 int64_t ns_from_origin
;
547 enum bt_clock_snapshot_status clock_snapshot_status
;
550 * The default is true: if we can't figure out the clock snapshot
551 * (or there is none), assume it is fine.
555 switch (message_type
) {
556 case BT_MESSAGE_TYPE_EVENT
:
558 struct bt_message_event
*event_msg
= (struct bt_message_event
*) msg
;
559 clock_snapshot
= event_msg
->default_cs
;
562 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
564 struct bt_message_message_iterator_inactivity
*inactivity_msg
=
565 (struct bt_message_message_iterator_inactivity
*) msg
;
566 clock_snapshot
= inactivity_msg
->default_cs
;
569 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
570 case BT_MESSAGE_TYPE_PACKET_END
:
572 struct bt_message_packet
*packet_msg
= (struct bt_message_packet
*) msg
;
573 clock_snapshot
= packet_msg
->default_cs
;
576 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
577 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
579 struct bt_message_stream_activity
*str_act_msg
=
580 (struct bt_message_stream_activity
*) msg
;
582 if (str_act_msg
->default_cs_state
== BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
) {
583 clock_snapshot
= str_act_msg
->default_cs
;
587 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
588 case BT_MESSAGE_TYPE_STREAM_END
:
589 /* These messages don't have clock snapshots. */
591 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
592 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
594 struct bt_message_discarded_items
*discarded_msg
=
595 (struct bt_message_discarded_items
*) msg
;
597 clock_snapshot
= discarded_msg
->default_begin_cs
;
602 if (!clock_snapshot
) {
606 clock_snapshot_status
= bt_clock_snapshot_get_ns_from_origin(clock_snapshot
, &ns_from_origin
);
607 if (clock_snapshot_status
!= BT_CLOCK_SNAPSHOT_STATUS_OK
) {
611 result
= ns_from_origin
>= iterator
->last_ns_from_origin
;
612 iterator
->last_ns_from_origin
= ns_from_origin
;
619 bool clock_snapshots_are_monotonic(
620 struct bt_self_component_port_input_message_iterator
*iterator
,
621 bt_message_array_const msgs
, uint64_t msg_count
)
626 for (i
= 0; i
< msg_count
; i
++) {
627 if (!clock_snapshots_are_monotonic_one(iterator
, msgs
[i
])) {
640 * When a new stream begins, verify that the clock class tied to this
641 * stream is compatible with what we've seen before.
646 bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator
*iterator
,
647 const struct bt_message
*msg
)
649 enum bt_message_type message_type
= bt_message_get_type(msg
);
652 if (message_type
== BT_MESSAGE_TYPE_STREAM_BEGINNING
) {
653 const struct bt_message_stream
*stream_msg
= (struct bt_message_stream
*) msg
;
654 const struct bt_clock_class
*clock_class
= stream_msg
->stream
->class->default_clock_class
;
655 bt_uuid clock_class_uuid
= NULL
;
658 clock_class_uuid
= bt_clock_class_get_uuid(clock_class
);
661 switch (iterator
->clock_expectation
.type
) {
662 case CLOCK_EXPECTATION_UNSET
:
664 * This is the first time we see a message with a clock
665 * snapshot: record the properties of that clock, against
666 * which we'll compare the clock properties of the following
671 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_NONE
;
672 } else if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
673 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_UNIX
;
674 } else if (clock_class_uuid
) {
675 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
;
676 memcpy(iterator
->clock_expectation
.uuid
, clock_class_uuid
, BABELTRACE_UUID_LEN
);
678 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
;
682 case CLOCK_EXPECTATION_NONE
:
684 BT_ASSERT_PRE_MSG("Expecting no clock class, got one: %![cc-]+K",
692 case CLOCK_EXPECTATION_ORIGIN_UNIX
:
694 BT_ASSERT_PRE_MSG("Expecting a clock class, got none.");
699 if (!bt_clock_class_origin_is_unix_epoch(clock_class
)) {
700 BT_ASSERT_PRE_MSG("Expecting a clock class with Unix epoch origin: %![cc-]+K",
707 case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID
:
709 BT_ASSERT_PRE_MSG("Expecting a clock class, got none.");
714 if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
715 BT_ASSERT_PRE_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
721 if (!clock_class_uuid
) {
722 BT_ASSERT_PRE_MSG("Expecting a clock class with UUID: %![cc-]+K",
728 if (bt_uuid_compare(iterator
->clock_expectation
.uuid
, clock_class_uuid
)) {
729 BT_ASSERT_PRE_MSG("Expecting a clock class with UUID, got one "
730 "with a different UUID: %![cc-]+K, expected-uuid=%!u",
731 clock_class
, iterator
->clock_expectation
.uuid
);
737 case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID
:
739 BT_ASSERT_PRE_MSG("Expecting a clock class, got none.");
744 if (bt_clock_class_origin_is_unix_epoch(clock_class
)) {
745 BT_ASSERT_PRE_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
751 if (clock_class_uuid
) {
752 BT_ASSERT_PRE_MSG("Expecting a clock class without UUID: %![cc-]+K",
769 bool clock_classes_are_compatible(
770 struct bt_self_component_port_input_message_iterator
*iterator
,
771 bt_message_array_const msgs
, uint64_t msg_count
)
776 for (i
= 0; i
< msg_count
; i
++) {
777 if (!clock_classes_are_compatible_one(iterator
, msgs
[i
])) {
790 * Call the `next` method of the iterator. Do some validation on the returned
795 bt_message_iterator_status
call_iterator_next_method(
796 struct bt_self_component_port_input_message_iterator
*iterator
,
797 bt_message_array_const msgs
, uint64_t capacity
, uint64_t *user_count
)
799 bt_message_iterator_status status
;
801 BT_ASSERT(iterator
->methods
.next
);
802 BT_LOGD_STR("Calling user's \"next\" method.");
804 status
= iterator
->methods
.next(iterator
, msgs
, capacity
, user_count
);
806 if (status
== BT_MESSAGE_ITERATOR_STATUS_OK
) {
807 BT_ASSERT_PRE(clock_classes_are_compatible(iterator
, msgs
, *user_count
),
808 "Clocks are not compatible");
809 BT_ASSERT_PRE(clock_snapshots_are_monotonic(iterator
, msgs
, *user_count
),
810 "Clock snapshots are not monotonic");
816 enum bt_message_iterator_status
817 bt_self_component_port_input_message_iterator_next(
818 struct bt_self_component_port_input_message_iterator
*iterator
,
819 bt_message_array_const
*msgs
, uint64_t *user_count
)
821 int status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
823 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
824 BT_ASSERT_PRE_NON_NULL(msgs
, "Message array (output)");
825 BT_ASSERT_PRE_NON_NULL(user_count
, "Message count (output)");
826 BT_ASSERT_PRE(iterator
->state
==
827 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
828 "Message iterator's \"next\" called, but "
829 "message iterator is in the wrong state: %!+i", iterator
);
830 BT_ASSERT(iterator
->upstream_component
);
831 BT_ASSERT(iterator
->upstream_component
->class);
833 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
834 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
835 "Graph is not configured: %!+g",
836 bt_component_borrow_graph(iterator
->upstream_component
));
837 BT_LIB_LOGD("Getting next self component input port "
838 "message iterator's messages: %!+i, batch-size=%u",
839 iterator
, MSG_BATCH_SIZE
);
842 * Call the user's "next" method to get the next messages
846 status
= call_iterator_next_method(iterator
,
847 (void *) iterator
->base
.msgs
->pdata
, MSG_BATCH_SIZE
,
849 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
850 bt_message_iterator_status_string(status
), *user_count
);
852 BT_LOGW_STR("User method failed.");
857 * There is no way that this iterator could have been finalized
858 * during its "next" method, as the only way to do this is to
859 * put the last iterator's reference, and this can only be done
860 * by its downstream owner.
862 * For the same reason, there is no way that this iterator could
863 * have seeked (cannot seek a self message iterator).
865 BT_ASSERT(iterator
->state
==
866 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
869 case BT_MESSAGE_ITERATOR_STATUS_OK
:
870 BT_ASSERT_PRE(*user_count
<= MSG_BATCH_SIZE
,
871 "Invalid returned message count: greater than "
872 "batch size: count=%" PRIu64
", batch-size=%u",
873 *user_count
, MSG_BATCH_SIZE
);
874 *msgs
= (void *) iterator
->base
.msgs
->pdata
;
876 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
878 case BT_MESSAGE_ITERATOR_STATUS_END
:
879 set_self_comp_port_input_msg_iterator_state(iterator
,
880 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
);
883 /* Unknown non-error status */
891 enum bt_message_iterator_status
bt_port_output_message_iterator_next(
892 struct bt_port_output_message_iterator
*iterator
,
893 bt_message_array_const
*msgs_to_user
,
894 uint64_t *count_to_user
)
896 enum bt_message_iterator_status status
;
897 enum bt_graph_status graph_status
;
899 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
900 BT_ASSERT_PRE_NON_NULL(msgs_to_user
, "Message array (output)");
901 BT_ASSERT_PRE_NON_NULL(count_to_user
, "Message count (output)");
902 BT_LIB_LOGD("Getting next output port message iterator's messages: "
904 graph_status
= bt_graph_consume_sink_no_check(iterator
->graph
,
906 switch (graph_status
) {
907 case BT_GRAPH_STATUS_CANCELED
:
908 case BT_GRAPH_STATUS_AGAIN
:
909 case BT_GRAPH_STATUS_END
:
910 case BT_GRAPH_STATUS_NOMEM
:
911 status
= (int) graph_status
;
913 case BT_GRAPH_STATUS_OK
:
914 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
917 * On success, the colander sink moves the messages
918 * to this iterator's array and sets this iterator's
919 * message count: move them to the user.
921 *msgs_to_user
= (void *) iterator
->base
.msgs
->pdata
;
922 *count_to_user
= iterator
->count
;
926 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
932 struct bt_component
*
933 bt_self_component_port_input_message_iterator_borrow_component(
934 struct bt_self_component_port_input_message_iterator
*iterator
)
936 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
937 return iterator
->upstream_component
;
940 const struct bt_component
*
941 bt_self_component_port_input_message_iterator_borrow_component_const(
942 const struct bt_self_component_port_input_message_iterator
*iterator
)
944 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
945 return iterator
->upstream_component
;
948 struct bt_self_component
*bt_self_message_iterator_borrow_component(
949 struct bt_self_message_iterator
*self_iterator
)
951 struct bt_self_component_port_input_message_iterator
*iterator
=
952 (void *) self_iterator
;
954 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
955 return (void *) iterator
->upstream_component
;
958 struct bt_self_port_output
*bt_self_message_iterator_borrow_port(
959 struct bt_self_message_iterator
*self_iterator
)
961 struct bt_self_component_port_input_message_iterator
*iterator
=
962 (void *) self_iterator
;
964 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
965 return (void *) iterator
->upstream_port
;
969 void bt_port_output_message_iterator_destroy(struct bt_object
*obj
)
971 struct bt_port_output_message_iterator
*iterator
= (void *) obj
;
973 BT_LIB_LOGI("Destroying output port message iterator object: %!+i",
975 BT_LOGD_STR("Putting graph.");
976 BT_OBJECT_PUT_REF_AND_RESET(iterator
->graph
);
977 BT_LOGD_STR("Putting colander sink component.");
978 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
979 destroy_base_message_iterator(obj
);
982 struct bt_port_output_message_iterator
*
983 bt_port_output_message_iterator_create(struct bt_graph
*graph
,
984 const struct bt_port_output
*output_port
)
986 struct bt_port_output_message_iterator
*iterator
= NULL
;
987 struct bt_component_class_sink
*colander_comp_cls
= NULL
;
988 struct bt_component
*output_port_comp
= NULL
;
989 struct bt_component_sink
*colander_comp
;
990 enum bt_graph_status graph_status
;
991 struct bt_port_input
*colander_in_port
= NULL
;
992 struct bt_component_class_sink_colander_data colander_data
;
995 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
996 BT_ASSERT_PRE_NON_NULL(output_port
, "Output port");
997 output_port_comp
= bt_port_borrow_component_inline(
998 (const void *) output_port
);
999 BT_ASSERT_PRE(output_port_comp
,
1000 "Output port has no component: %!+p", output_port
);
1001 BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp
) ==
1003 "Output port is not part of graph: %![graph-]+g, %![port-]+p",
1004 graph
, output_port
);
1005 BT_ASSERT_PRE(!graph
->has_sink
,
1006 "Graph already has a sink component: %![graph-]+g");
1008 /* Create message iterator */
1009 BT_LIB_LOGI("Creating message iterator on output port: "
1010 "%![port-]+p, %![comp-]+c", output_port
, output_port_comp
);
1011 iterator
= g_new0(struct bt_port_output_message_iterator
, 1);
1013 BT_LOGE_STR("Failed to allocate one output port message iterator.");
1017 ret
= init_message_iterator((void *) iterator
,
1018 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
,
1019 bt_port_output_message_iterator_destroy
);
1021 /* init_message_iterator() logs errors */
1022 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
1026 /* Create colander component */
1027 colander_comp_cls
= bt_component_class_sink_colander_get();
1028 if (!colander_comp_cls
) {
1029 BT_LOGW("Cannot get colander sink component class.");
1033 iterator
->graph
= graph
;
1034 bt_object_get_no_null_check(iterator
->graph
);
1035 colander_data
.msgs
= (void *) iterator
->base
.msgs
->pdata
;
1036 colander_data
.count_addr
= &iterator
->count
;
1039 * Hope that nobody uses this very unique name.
1041 * We pass `BT_LOGGING_LEVEL_NONE` but the colander component
1042 * class module does not use this level anyway since it belongs
1046 bt_graph_add_sink_component_with_init_method_data(
1047 (void *) graph
, colander_comp_cls
,
1048 "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
1049 NULL
, &colander_data
, BT_LOGGING_LEVEL_NONE
,
1050 (void *) &iterator
->colander
);
1051 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1052 BT_LIB_LOGW("Cannot add colander sink component to graph: "
1053 "%1[graph-]+g, status=%s", graph
,
1054 bt_graph_status_string(graph_status
));
1059 * Connect provided output port to the colander component's
1063 (void *) bt_component_sink_borrow_input_port_by_index_const(
1064 (void *) iterator
->colander
, 0);
1065 BT_ASSERT(colander_in_port
);
1066 graph_status
= bt_graph_connect_ports(graph
,
1067 output_port
, colander_in_port
, NULL
);
1068 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1069 BT_LIB_LOGW("Cannot add colander sink component to graph: "
1070 "%![graph-]+g, %![comp-]+c, status=%s", graph
,
1072 bt_graph_status_string(graph_status
));
1077 * At this point everything went fine. Make the graph
1078 * nonconsumable forever so that only this message iterator
1079 * can consume (thanks to bt_graph_consume_sink_no_check()).
1080 * This avoids leaking the message created by the colander
1081 * sink and moved to the message iterator's message
1084 bt_graph_set_can_consume(iterator
->graph
, false);
1086 /* Also set the graph as being configured. */
1087 graph_status
= bt_graph_configure(graph
);
1088 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
1089 BT_LIB_LOGW("Cannot configure graph after having added colander: "
1090 "%![graph-]+g, status=%s", graph
,
1091 bt_graph_status_string(graph_status
));
1097 if (iterator
&& iterator
->graph
&& iterator
->colander
) {
1100 /* Remove created colander component from graph if any */
1101 colander_comp
= iterator
->colander
;
1102 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
1105 * At this point the colander component's reference
1106 * count is 0 because iterator->colander was the only
1107 * owner. We also know that it is not connected because
1108 * this is the last operation before this function
1111 * Since we honor the preconditions here,
1112 * bt_graph_remove_unconnected_component() always
1115 ret
= bt_graph_remove_unconnected_component(iterator
->graph
,
1116 (void *) colander_comp
);
1117 BT_ASSERT(ret
== 0);
1120 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
1123 bt_object_put_ref(colander_comp_cls
);
1124 return (void *) iterator
;
1127 bt_bool
bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1128 struct bt_self_component_port_input_message_iterator
*iterator
,
1129 int64_t ns_from_origin
)
1131 bt_bool can
= BT_FALSE
;
1133 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1134 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1136 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1137 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1138 "Graph is not configured: %!+g",
1139 bt_component_borrow_graph(iterator
->upstream_component
));
1141 if (iterator
->methods
.can_seek_ns_from_origin
) {
1142 can
= iterator
->methods
.can_seek_ns_from_origin(iterator
,
1148 * Automatic seeking fall back: if we can seek to the beginning,
1149 * then we can automatically seek to any message.
1151 if (iterator
->methods
.can_seek_beginning
) {
1152 can
= iterator
->methods
.can_seek_beginning(iterator
);
1159 bt_bool
bt_self_component_port_input_message_iterator_can_seek_beginning(
1160 struct bt_self_component_port_input_message_iterator
*iterator
)
1162 bt_bool can
= BT_FALSE
;
1164 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1165 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1167 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1168 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1169 "Graph is not configured: %!+g",
1170 bt_component_borrow_graph(iterator
->upstream_component
));
1172 if (iterator
->methods
.can_seek_beginning
) {
1173 can
= iterator
->methods
.can_seek_beginning(iterator
);
1180 void set_iterator_state_after_seeking(
1181 struct bt_self_component_port_input_message_iterator
*iterator
,
1182 enum bt_message_iterator_status status
)
1184 enum bt_self_component_port_input_message_iterator_state new_state
= 0;
1186 /* Set iterator's state depending on seeking status */
1188 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1189 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
;
1191 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1192 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
;
1194 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1195 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1196 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
;
1198 case BT_MESSAGE_ITERATOR_STATUS_END
:
1199 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
;
1205 set_self_comp_port_input_msg_iterator_state(iterator
, new_state
);
1209 void reset_iterator_expectations(
1210 struct bt_self_component_port_input_message_iterator
*iterator
)
1212 iterator
->last_ns_from_origin
= INT64_MIN
;
1213 iterator
->clock_expectation
.type
= CLOCK_EXPECTATION_UNSET
;
1216 enum bt_message_iterator_status
1217 bt_self_component_port_input_message_iterator_seek_beginning(
1218 struct bt_self_component_port_input_message_iterator
*iterator
)
1222 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1223 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1225 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1226 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1227 "Graph is not configured: %!+g",
1228 bt_component_borrow_graph(iterator
->upstream_component
));
1230 bt_self_component_port_input_message_iterator_can_seek_beginning(
1232 "Message iterator cannot seek beginning: %!+i", iterator
);
1235 * We are seeking, reset our expectations about how the following
1236 * messages should look like.
1238 reset_iterator_expectations(iterator
);
1240 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator
);
1241 set_self_comp_port_input_msg_iterator_state(iterator
,
1242 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1243 status
= iterator
->methods
.seek_beginning(iterator
);
1244 BT_LOGD("User method returned: status=%s",
1245 bt_message_iterator_status_string(status
));
1246 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1247 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1248 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1249 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1250 "Unexpected status: %![iter-]+i, status=%s",
1251 iterator
, bt_common_self_message_iterator_status_string(status
));
1252 set_iterator_state_after_seeking(iterator
, status
);
1258 * Structure used to record the state of a given stream during the fast-forward
1259 * phase of an auto-seek.
1261 struct auto_seek_stream_state
{
1263 * Value representing which step of this timeline we are at.
1266 * [SB] 1 [SAB] 2 [PB] 3 [PE] 2 [SAE] 1 [SE]
1268 * At each point in the timeline, the messages we need to replicate are:
1270 * 1: Stream beginning
1271 * 2: Stream beginning, stream activity beginning
1272 * 3: Stream beginning, stream activity beginning, packet beginning
1274 * Before "Stream beginning" and after "Stream end", we don't need to
1275 * replicate anything as the stream doesn't exist.
1278 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
,
1279 AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
,
1280 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
,
1284 * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
1285 * in. This is a weak reference, since the packet will always be
1286 * alive by the time we use it.
1288 struct bt_packet
*packet
;
1292 struct auto_seek_stream_state
*create_auto_seek_stream_state(void)
1294 return g_new0(struct auto_seek_stream_state
, 1);
1298 void destroy_auto_seek_stream_state(void *ptr
)
1304 GHashTable
*create_auto_seek_stream_states(void)
1306 return g_hash_table_new_full(g_direct_hash
, g_direct_equal
, NULL
,
1307 destroy_auto_seek_stream_state
);
1311 void destroy_auto_seek_stream_states(GHashTable
*stream_states
)
1313 g_hash_table_destroy(stream_states
);
1317 * Handle one message while we are in the fast-forward phase of an auto-seek.
1319 * Sets `*got_first` to true if the message's timestamp is greater or equal to
1320 * `ns_from_origin`. In other words, if this is the first message after our
1323 * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1324 * `struct auto_seek_stream_state` used to keep the state of each stream
1325 * during the fast-forward.
1329 enum bt_message_iterator_status
auto_seek_handle_message(
1330 struct bt_self_component_port_input_message_iterator
*iterator
,
1331 int64_t ns_from_origin
, const struct bt_message
*msg
,
1332 bool *got_first
, GHashTable
*stream_states
)
1334 enum bt_message_iterator_status status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1335 int64_t msg_ns_from_origin
;
1336 const struct bt_clock_snapshot
*clk_snapshot
= NULL
;
1340 BT_ASSERT(got_first
);
1342 switch (msg
->type
) {
1343 case BT_MESSAGE_TYPE_EVENT
:
1345 const struct bt_message_event
*event_msg
=
1348 clk_snapshot
= event_msg
->default_cs
;
1349 BT_ASSERT_PRE(clk_snapshot
,
1350 "Event message has no default clock snapshot: %!+n",
1354 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1356 const struct bt_message_message_iterator_inactivity
*inactivity_msg
=
1359 clk_snapshot
= inactivity_msg
->default_cs
;
1360 BT_ASSERT(clk_snapshot
);
1363 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1364 case BT_MESSAGE_TYPE_PACKET_END
:
1366 const struct bt_message_packet
*packet_msg
=
1369 clk_snapshot
= packet_msg
->default_cs
;
1370 BT_ASSERT_PRE(clk_snapshot
,
1371 "Packet message has no default clock snapshot: %!+n",
1375 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1376 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1378 struct bt_message_discarded_items
*msg_disc_items
=
1381 BT_ASSERT_PRE(msg_disc_items
->default_begin_cs
&&
1382 msg_disc_items
->default_end_cs
,
1383 "Discarded events/packets message has no default clock snapshots: %!+n",
1385 ret
= bt_clock_snapshot_get_ns_from_origin(
1386 msg_disc_items
->default_begin_cs
,
1387 &msg_ns_from_origin
);
1389 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1393 if (msg_ns_from_origin
>= ns_from_origin
) {
1398 ret
= bt_clock_snapshot_get_ns_from_origin(
1399 msg_disc_items
->default_end_cs
,
1400 &msg_ns_from_origin
);
1402 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1406 if (msg_ns_from_origin
>= ns_from_origin
) {
1408 * The discarded items message's beginning time
1409 * is before the requested seeking time, but its
1410 * end time is after. Modify the message so as
1411 * to set its beginning time to the requested
1412 * seeking time, and make its item count unknown
1413 * as we don't know if items were really
1414 * discarded within the new time range.
1416 uint64_t new_begin_raw_value
;
1418 ret
= bt_clock_class_clock_value_from_ns_from_origin(
1419 msg_disc_items
->default_end_cs
->clock_class
,
1420 ns_from_origin
, &new_begin_raw_value
);
1422 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1426 bt_clock_snapshot_set_raw_value(
1427 msg_disc_items
->default_begin_cs
,
1428 new_begin_raw_value
);
1429 msg_disc_items
->count
.base
.avail
=
1430 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
1433 * It is safe to push it because its beginning
1434 * time is exactly the requested seeking time.
1441 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1443 const struct bt_message_stream_activity
*stream_act_msg
=
1446 switch (stream_act_msg
->default_cs_state
) {
1447 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1448 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1450 * -inf is always less than any requested time,
1451 * and we can't assume any specific time for an
1452 * unknown clock snapshot, so skip this.
1455 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1456 clk_snapshot
= stream_act_msg
->default_cs
;
1457 BT_ASSERT(clk_snapshot
);
1465 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1467 const struct bt_message_stream_activity
*stream_act_msg
=
1470 switch (stream_act_msg
->default_cs_state
) {
1471 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1473 * We can't assume any specific time for an
1474 * unknown clock snapshot, so skip this.
1477 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1479 * +inf is always greater than any requested
1484 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1485 clk_snapshot
= stream_act_msg
->default_cs
;
1486 BT_ASSERT(clk_snapshot
);
1494 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1495 case BT_MESSAGE_TYPE_STREAM_END
:
1502 BT_ASSERT(clk_snapshot
);
1503 ret
= bt_clock_snapshot_get_ns_from_origin(clk_snapshot
,
1504 &msg_ns_from_origin
);
1506 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1510 if (msg_ns_from_origin
>= ns_from_origin
) {
1516 /* This message won't be sent downstream. */
1517 switch (msg
->type
) {
1518 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1520 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1521 struct auto_seek_stream_state
*stream_state
;
1523 /* Update stream's state: stream began. */
1524 stream_state
= create_auto_seek_stream_state();
1525 if (!stream_state
) {
1526 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1530 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1532 BT_ASSERT(!bt_g_hash_table_contains(stream_states
, stream_msg
->stream
));
1533 g_hash_table_insert(stream_states
, stream_msg
->stream
, stream_state
);
1536 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1538 const struct bt_message_stream_activity
*stream_act_msg
=
1540 struct auto_seek_stream_state
*stream_state
;
1542 /* Update stream's state: stream activity began. */
1543 stream_state
= g_hash_table_lookup(stream_states
, stream_act_msg
->stream
);
1544 BT_ASSERT(stream_state
);
1546 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1547 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
;
1548 BT_ASSERT(!stream_state
->packet
);
1551 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1553 const struct bt_message_packet
*packet_msg
=
1555 struct auto_seek_stream_state
*stream_state
;
1557 /* Update stream's state: packet began. */
1558 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1559 BT_ASSERT(stream_state
);
1561 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
);
1562 stream_state
->state
= AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
;
1563 BT_ASSERT(!stream_state
->packet
);
1564 stream_state
->packet
= packet_msg
->packet
;
1567 case BT_MESSAGE_TYPE_PACKET_END
:
1569 const struct bt_message_packet
*packet_msg
=
1571 struct auto_seek_stream_state
*stream_state
;
1573 /* Update stream's state: packet ended. */
1574 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1575 BT_ASSERT(stream_state
);
1577 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
);
1578 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
;
1579 BT_ASSERT(stream_state
->packet
);
1580 stream_state
->packet
= NULL
;
1583 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1585 const struct bt_message_stream_activity
*stream_act_msg
=
1587 struct auto_seek_stream_state
*stream_state
;
1589 /* Update stream's state: stream activity ended. */
1590 stream_state
= g_hash_table_lookup(stream_states
, stream_act_msg
->stream
);
1591 BT_ASSERT(stream_state
);
1593 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
);
1594 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1595 BT_ASSERT(!stream_state
->packet
);
1598 case BT_MESSAGE_TYPE_STREAM_END
:
1600 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1601 struct auto_seek_stream_state
*stream_state
;
1603 stream_state
= g_hash_table_lookup(stream_states
, stream_msg
->stream
);
1604 BT_ASSERT(stream_state
);
1605 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1606 BT_ASSERT(!stream_state
->packet
);
1608 /* Update stream's state: this stream doesn't exist anymore. */
1609 g_hash_table_remove(stream_states
, stream_msg
->stream
);
1616 bt_object_put_no_null_check(msg
);
1621 g_queue_push_tail(iterator
->auto_seek
.msgs
, (void *) msg
);
1625 BT_ASSERT(!msg
|| status
!= BT_MESSAGE_ITERATOR_STATUS_OK
);
1630 enum bt_message_iterator_status
find_message_ge_ns_from_origin(
1631 struct bt_self_component_port_input_message_iterator
*iterator
,
1632 int64_t ns_from_origin
, GHashTable
*stream_states
)
1635 enum bt_self_component_port_input_message_iterator_state init_state
=
1637 const struct bt_message
*messages
[MSG_BATCH_SIZE
];
1638 uint64_t user_count
= 0;
1640 bool got_first
= false;
1642 BT_ASSERT(iterator
);
1643 memset(&messages
[0], 0, sizeof(messages
[0]) * MSG_BATCH_SIZE
);
1646 * Make this iterator temporarily active (not seeking) to call
1647 * the "next" method.
1649 set_self_comp_port_input_msg_iterator_state(iterator
,
1650 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1652 BT_ASSERT(iterator
->methods
.next
);
1654 while (!got_first
) {
1656 * Call the user's "next" method to get the next
1657 * messages and status.
1659 status
= call_iterator_next_method(iterator
,
1660 &messages
[0], MSG_BATCH_SIZE
, &user_count
);
1661 BT_LOGD("User method returned: status=%s",
1662 bt_message_iterator_status_string(status
));
1665 * The user's "next" method must not do any action which
1666 * would change the iterator's state.
1668 BT_ASSERT(iterator
->state
==
1669 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1672 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1673 BT_ASSERT_PRE(user_count
<= MSG_BATCH_SIZE
,
1674 "Invalid returned message count: greater than "
1675 "batch size: count=%" PRIu64
", batch-size=%u",
1676 user_count
, MSG_BATCH_SIZE
);
1678 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1679 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1680 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1681 case BT_MESSAGE_ITERATOR_STATUS_END
:
1687 for (i
= 0; i
< user_count
; i
++) {
1689 g_queue_push_tail(iterator
->auto_seek
.msgs
,
1690 (void *) messages
[i
]);
1695 status
= auto_seek_handle_message(iterator
,
1696 ns_from_origin
, messages
[i
], &got_first
,
1698 if (status
== BT_MESSAGE_ITERATOR_STATUS_OK
) {
1699 /* Message was either pushed or moved */
1708 for (i
= 0; i
< user_count
; i
++) {
1710 bt_object_put_no_null_check(messages
[i
]);
1714 set_self_comp_port_input_msg_iterator_state(iterator
, init_state
);
1719 * This function is installed as the iterator's next callback after we have
1720 * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1721 * messages saved in iterator->auto_seek.msgs. Once this is done, the original
1722 * next callback is put back.
1726 enum bt_self_message_iterator_status
post_auto_seek_next(
1727 struct bt_self_component_port_input_message_iterator
*iterator
,
1728 bt_message_array_const msgs
, uint64_t capacity
,
1731 BT_ASSERT(!g_queue_is_empty(iterator
->auto_seek
.msgs
));
1735 * Move auto-seek messages to the output array (which is this
1736 * iterator's base message array).
1738 while (capacity
> 0 && !g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1739 msgs
[*count
] = g_queue_pop_head(iterator
->auto_seek
.msgs
);
1744 BT_ASSERT(*count
> 0);
1746 if (g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1747 /* No more auto-seek messages, restore user's next callback. */
1748 BT_ASSERT(iterator
->auto_seek
.original_next_callback
);
1749 iterator
->methods
.next
= iterator
->auto_seek
.original_next_callback
;
1750 iterator
->auto_seek
.original_next_callback
= NULL
;
1753 return BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
1757 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1758 int64_t ns_from_origin
, uint64_t *raw_value
)
1761 int64_t cc_offset_s
= clock_class
->offset_seconds
;
1762 uint64_t cc_offset_cycles
= clock_class
->offset_cycles
;
1763 uint64_t cc_freq
= clock_class
->frequency
;
1765 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1766 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1770 enum bt_message_iterator_status
1771 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1772 struct bt_self_component_port_input_message_iterator
*iterator
,
1773 int64_t ns_from_origin
)
1776 GHashTable
*stream_states
= NULL
;
1778 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1779 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1781 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1782 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1783 "Graph is not configured: %!+g",
1784 bt_component_borrow_graph(iterator
->upstream_component
));
1786 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1787 iterator
, ns_from_origin
),
1788 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1789 "ns-from-origin=%" PRId64
, iterator
, ns_from_origin
);
1790 set_self_comp_port_input_msg_iterator_state(iterator
,
1791 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1794 * We are seeking, reset our expectations about how the following
1795 * messages should look like.
1797 reset_iterator_expectations(iterator
);
1799 if (iterator
->methods
.seek_ns_from_origin
) {
1800 /* The iterator knows how to seek to a particular time, let it handle this. */
1801 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1802 "%![iter-]+i, ns=%" PRId64
, iterator
, ns_from_origin
);
1803 status
= iterator
->methods
.seek_ns_from_origin(iterator
,
1805 BT_LOGD("User method returned: status=%s",
1806 bt_message_iterator_status_string(status
));
1807 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1808 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1809 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1810 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1811 "Unexpected status: %![iter-]+i, status=%s",
1813 bt_common_self_message_iterator_status_string(status
));
1816 * The iterator doesn't know how to seek to a particular time. We will
1817 * seek to the beginning and fast forward to the right place.
1819 BT_ASSERT(iterator
->methods
.can_seek_beginning(iterator
));
1820 BT_ASSERT(iterator
->methods
.seek_beginning
);
1821 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1823 status
= iterator
->methods
.seek_beginning(iterator
);
1824 BT_LOGD("User method returned: status=%s",
1825 bt_message_iterator_status_string(status
));
1826 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1827 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1828 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1829 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1830 "Unexpected status: %![iter-]+i, status=%s",
1832 bt_common_self_message_iterator_status_string(status
));
1834 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1836 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1837 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1838 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1845 * Find the first message which has a default clock
1846 * snapshot greater than or equal to the requested
1847 * seeking time, and move the received messages from
1848 * this point in the batch to this iterator's auto-seek
1851 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1852 bt_object_put_no_null_check(
1853 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
1856 stream_states
= create_auto_seek_stream_states();
1857 if (!stream_states
) {
1858 BT_LOGE_STR("Failed to allocate one GHashTable.");
1859 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1863 status
= find_message_ge_ns_from_origin(iterator
,
1864 ns_from_origin
, stream_states
);
1866 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1867 case BT_MESSAGE_ITERATOR_STATUS_END
:
1869 GHashTableIter iter
;
1870 gpointer key
, value
;
1873 * If some streams exist at the seek time, prepend the
1874 * required messages to put those streams in the right
1877 g_hash_table_iter_init(&iter
, stream_states
);
1878 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
1879 const bt_stream
*stream
= key
;
1880 struct auto_seek_stream_state
*stream_state
=
1881 (struct auto_seek_stream_state
*) value
;
1883 const bt_clock_class
*clock_class
= bt_stream_class_borrow_default_clock_class_const(
1884 bt_stream_borrow_class_const(stream
));
1887 if (clock_raw_value_from_ns_from_origin(clock_class
, ns_from_origin
, &raw_value
) != 0) {
1888 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64
", %![cc-]+K",
1889 ns_from_origin
, clock_class
);
1890 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1894 switch (stream_state
->state
) {
1895 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
:
1896 BT_ASSERT(stream_state
->packet
);
1897 BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state
->packet
);
1898 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1899 (bt_self_message_iterator
*) iterator
, stream_state
->packet
, raw_value
);
1901 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1905 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1908 case AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
:
1909 msg
= bt_message_stream_activity_beginning_create(
1910 (bt_self_message_iterator
*) iterator
, stream
);
1912 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1916 bt_message_stream_activity_beginning_set_default_clock_snapshot(msg
, raw_value
);
1918 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1921 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
:
1922 msg
= bt_message_stream_beginning_create(
1923 (bt_self_message_iterator
*) iterator
, stream
);
1925 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1929 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1936 * If there are messages in the auto-seek
1937 * message queue, replace the user's "next"
1938 * method with a custom, temporary "next" method
1939 * which returns them.
1941 if (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1942 BT_ASSERT(!iterator
->auto_seek
.original_next_callback
);
1943 iterator
->auto_seek
.original_next_callback
= iterator
->methods
.next
;
1945 iterator
->methods
.next
=
1946 (bt_self_component_port_input_message_iterator_next_method
)
1947 post_auto_seek_next
;
1951 * `BT_MESSAGE_ITERATOR_STATUS_END` becomes
1952 * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next
1953 * time this iterator's "next" method is called,
1955 * `BT_MESSAGE_ITERATOR_STATUS_END`.
1957 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1960 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1961 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1962 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1970 * The following messages returned by the next method (including
1971 * post_auto_seek_next) must be after (or at) `ns_from_origin`.
1973 iterator
->last_ns_from_origin
= ns_from_origin
;
1976 if (stream_states
) {
1977 destroy_auto_seek_stream_states(stream_states
);
1978 stream_states
= NULL
;
1980 set_iterator_state_after_seeking(iterator
, status
);
1985 bt_self_component_port_input_message_iterator
*
1986 borrow_output_port_message_iterator_upstream_iterator(
1987 struct bt_port_output_message_iterator
*iterator
)
1989 struct bt_component_class_sink_colander_priv_data
*colander_data
;
1991 BT_ASSERT(iterator
);
1992 colander_data
= (void *) iterator
->colander
->parent
.user_data
;
1993 BT_ASSERT(colander_data
);
1994 BT_ASSERT(colander_data
->msg_iter
);
1995 return colander_data
->msg_iter
;
1998 bt_bool
bt_port_output_message_iterator_can_seek_ns_from_origin(
1999 struct bt_port_output_message_iterator
*iterator
,
2000 int64_t ns_from_origin
)
2002 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2003 return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
2004 borrow_output_port_message_iterator_upstream_iterator(
2005 iterator
), ns_from_origin
);
2008 bt_bool
bt_port_output_message_iterator_can_seek_beginning(
2009 struct bt_port_output_message_iterator
*iterator
)
2011 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2012 return bt_self_component_port_input_message_iterator_can_seek_beginning(
2013 borrow_output_port_message_iterator_upstream_iterator(
2017 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_ns_from_origin(
2018 struct bt_port_output_message_iterator
*iterator
,
2019 int64_t ns_from_origin
)
2021 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2022 return bt_self_component_port_input_message_iterator_seek_ns_from_origin(
2023 borrow_output_port_message_iterator_upstream_iterator(iterator
),
2027 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_beginning(
2028 struct bt_port_output_message_iterator
*iterator
)
2030 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
2031 return bt_self_component_port_input_message_iterator_seek_beginning(
2032 borrow_output_port_message_iterator_upstream_iterator(
2036 void bt_port_output_message_iterator_get_ref(
2037 const struct bt_port_output_message_iterator
*iterator
)
2039 bt_object_get_ref(iterator
);
2042 void bt_port_output_message_iterator_put_ref(
2043 const struct bt_port_output_message_iterator
*iterator
)
2045 bt_object_put_ref(iterator
);
2048 void bt_self_component_port_input_message_iterator_get_ref(
2049 const struct bt_self_component_port_input_message_iterator
*iterator
)
2051 bt_object_get_ref(iterator
);
2054 void bt_self_component_port_input_message_iterator_put_ref(
2055 const struct bt_self_component_port_input_message_iterator
*iterator
)
2057 bt_object_put_ref(iterator
);