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 "lib/trace-ir/clock-class.h"
29 #include "lib/trace-ir/clock-snapshot.h"
30 #include <babeltrace2/trace-ir/field.h>
31 #include <babeltrace2/trace-ir/event-const.h>
32 #include "lib/trace-ir/event.h"
33 #include <babeltrace2/trace-ir/packet-const.h>
34 #include "lib/trace-ir/packet.h"
35 #include "lib/trace-ir/stream.h"
36 #include <babeltrace2/graph/connection-const.h>
37 #include <babeltrace2/graph/component-const.h>
38 #include <babeltrace2/graph/component-sink-const.h>
39 #include <babeltrace2/graph/message-const.h>
40 #include <babeltrace2/graph/message-iterator-const.h>
41 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
42 #include <babeltrace2/graph/port-output-message-iterator.h>
43 #include <babeltrace2/graph/message-event-const.h>
44 #include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
45 #include <babeltrace2/graph/message-packet-beginning.h>
46 #include <babeltrace2/graph/message-packet-beginning-const.h>
47 #include <babeltrace2/graph/message-packet-end-const.h>
48 #include <babeltrace2/graph/message-stream-activity-beginning.h>
49 #include <babeltrace2/graph/message-stream-activity-beginning-const.h>
50 #include <babeltrace2/graph/message-stream-activity-end-const.h>
51 #include <babeltrace2/graph/message-stream-beginning.h>
52 #include <babeltrace2/graph/message-stream-beginning-const.h>
53 #include <babeltrace2/graph/message-stream-end-const.h>
54 #include <babeltrace2/graph/port-const.h>
55 #include <babeltrace2/graph/graph.h>
56 #include <babeltrace2/graph/graph-const.h>
57 #include <babeltrace2/types.h>
58 #include "common/assert.h"
59 #include "lib/assert-pre.h"
64 #include "component-class.h"
65 #include "component-class-sink-colander.h"
66 #include "component.h"
67 #include "component-sink.h"
68 #include "component-source.h"
69 #include "connection.h"
71 #include "message/discarded-items.h"
72 #include "message/event.h"
73 #include "message/iterator.h"
74 #include "message/message.h"
75 #include "message/message-iterator-inactivity.h"
76 #include "message/stream.h"
77 #include "message/packet.h"
78 #include "message/stream-activity.h"
81 * TODO: Use graph's state (number of active iterators, etc.) and
82 * possibly system specifications to make a better guess than this.
84 #define MSG_BATCH_SIZE 15
86 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
87 BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
88 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
89 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
90 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
91 "Message iterator is in the wrong state: %!+i", _iter)
94 void set_self_comp_port_input_msg_iterator_state(
95 struct bt_self_component_port_input_message_iterator
*iterator
,
96 enum bt_self_component_port_input_message_iterator_state state
)
99 BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
100 bt_self_component_port_input_message_iterator_state_string(state
));
101 iterator
->state
= state
;
105 void destroy_base_message_iterator(struct bt_object
*obj
)
107 struct bt_message_iterator
*iterator
= (void *) obj
;
111 if (iterator
->msgs
) {
112 g_ptr_array_free(iterator
->msgs
, TRUE
);
113 iterator
->msgs
= NULL
;
120 void bt_self_component_port_input_message_iterator_destroy(struct bt_object
*obj
)
122 struct bt_self_component_port_input_message_iterator
*iterator
;
127 * The message iterator's reference count is 0 if we're
128 * here. Increment it to avoid a double-destroy (possibly
129 * infinitely recursive). This could happen for example if the
130 * message iterator's finalization function does
131 * bt_object_get_ref() (or anything that causes
132 * bt_object_get_ref() to be called) on itself (ref. count goes
133 * from 0 to 1), and then bt_object_put_ref(): the reference
134 * count would go from 1 to 0 again and this function would be
138 iterator
= (void *) obj
;
139 BT_LIB_LOGI("Destroying self component input port message iterator object: "
141 bt_self_component_port_input_message_iterator_try_finalize(iterator
);
143 if (iterator
->connection
) {
145 * Remove ourself from the originating connection so
146 * that it does not try to finalize a dangling pointer
149 bt_connection_remove_iterator(iterator
->connection
, iterator
);
150 iterator
->connection
= NULL
;
153 if (iterator
->auto_seek
.msgs
) {
154 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
155 bt_object_put_no_null_check(
156 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
159 g_queue_free(iterator
->auto_seek
.msgs
);
160 iterator
->auto_seek
.msgs
= NULL
;
163 destroy_base_message_iterator(obj
);
167 void bt_self_component_port_input_message_iterator_try_finalize(
168 struct bt_self_component_port_input_message_iterator
*iterator
)
170 typedef void (*method_t
)(void *);
172 struct bt_component_class
*comp_class
= NULL
;
173 method_t method
= NULL
;
177 switch (iterator
->state
) {
178 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
:
179 /* Skip user finalization if user initialization failed */
180 BT_LIB_LOGD("Not finalizing non-initialized message iterator: "
183 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
:
184 /* Already finalized */
185 BT_LIB_LOGD("Not finalizing message iterator: already finalized: "
188 case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
:
189 /* Already finalized */
190 BT_LIB_LOGF("Message iterator is already being finalized: "
197 BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator
);
198 set_self_comp_port_input_msg_iterator_state(iterator
,
199 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING
);
200 BT_ASSERT(iterator
->upstream_component
);
201 comp_class
= iterator
->upstream_component
->class;
203 /* Call user-defined destroy method */
204 switch (comp_class
->type
) {
205 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
207 struct bt_component_class_source
*src_comp_cls
=
210 method
= (method_t
) src_comp_cls
->methods
.msg_iter_finalize
;
213 case BT_COMPONENT_CLASS_TYPE_FILTER
:
215 struct bt_component_class_filter
*flt_comp_cls
=
218 method
= (method_t
) flt_comp_cls
->methods
.msg_iter_finalize
;
227 BT_LIB_LOGD("Calling user's finalization method: %!+i",
232 iterator
->upstream_component
= NULL
;
233 iterator
->upstream_port
= NULL
;
234 set_self_comp_port_input_msg_iterator_state(iterator
,
235 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED
);
236 BT_LIB_LOGD("Finalized message iterator: %!+i", iterator
);
243 void bt_self_component_port_input_message_iterator_set_connection(
244 struct bt_self_component_port_input_message_iterator
*iterator
,
245 struct bt_connection
*connection
)
248 iterator
->connection
= connection
;
249 BT_LIB_LOGI("Set message iterator's connection: "
250 "%![iter-]+i, %![conn-]+x", iterator
, connection
);
254 int init_message_iterator(struct bt_message_iterator
*iterator
,
255 enum bt_message_iterator_type type
,
256 bt_object_release_func destroy
)
260 bt_object_init_shared(&iterator
->base
, destroy
);
261 iterator
->type
= type
;
262 iterator
->msgs
= g_ptr_array_new();
263 if (!iterator
->msgs
) {
264 BT_LOGE_STR("Failed to allocate a GPtrArray.");
269 g_ptr_array_set_size(iterator
->msgs
, MSG_BATCH_SIZE
);
276 bt_bool
can_seek_ns_from_origin_true(
277 struct bt_self_component_port_input_message_iterator
*iterator
,
278 int64_t ns_from_origin
)
284 bt_bool
can_seek_beginning_true(
285 struct bt_self_component_port_input_message_iterator
*iterator
)
291 struct bt_self_component_port_input_message_iterator
*
292 bt_self_component_port_input_message_iterator_create_initial(
293 struct bt_component
*upstream_comp
,
294 struct bt_port
*upstream_port
)
297 struct bt_self_component_port_input_message_iterator
*iterator
= NULL
;
299 BT_ASSERT(upstream_comp
);
300 BT_ASSERT(upstream_port
);
301 BT_ASSERT(bt_port_is_connected(upstream_port
));
302 BT_LIB_LOGI("Creating initial message iterator on self component input port: "
303 "%![up-comp-]+c, %![up-port-]+p", upstream_comp
, upstream_port
);
304 BT_ASSERT(bt_component_get_class_type(upstream_comp
) ==
305 BT_COMPONENT_CLASS_TYPE_SOURCE
||
306 bt_component_get_class_type(upstream_comp
) ==
307 BT_COMPONENT_CLASS_TYPE_FILTER
);
309 struct bt_self_component_port_input_message_iterator
, 1);
311 BT_LOGE_STR("Failed to allocate one self component input port "
312 "message iterator.");
316 ret
= init_message_iterator((void *) iterator
,
317 BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT
,
318 bt_self_component_port_input_message_iterator_destroy
);
320 /* init_message_iterator() logs errors */
321 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
325 iterator
->auto_seek
.msgs
= g_queue_new();
326 if (!iterator
->auto_seek
.msgs
) {
327 BT_LOGE_STR("Failed to allocate a GQueue.");
332 iterator
->upstream_component
= upstream_comp
;
333 iterator
->upstream_port
= upstream_port
;
334 iterator
->connection
= iterator
->upstream_port
->connection
;
335 iterator
->graph
= bt_component_borrow_graph(upstream_comp
);
336 set_self_comp_port_input_msg_iterator_state(iterator
,
337 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
);
339 switch (iterator
->upstream_component
->class->type
) {
340 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
342 struct bt_component_class_source
*src_comp_cls
=
343 (void *) iterator
->upstream_component
->class;
345 iterator
->methods
.next
=
346 (bt_self_component_port_input_message_iterator_next_method
)
347 src_comp_cls
->methods
.msg_iter_next
;
348 iterator
->methods
.seek_ns_from_origin
=
349 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
350 src_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
351 iterator
->methods
.seek_beginning
=
352 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
353 src_comp_cls
->methods
.msg_iter_seek_beginning
;
354 iterator
->methods
.can_seek_ns_from_origin
=
355 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
356 src_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
357 iterator
->methods
.can_seek_beginning
=
358 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
359 src_comp_cls
->methods
.msg_iter_can_seek_beginning
;
362 case BT_COMPONENT_CLASS_TYPE_FILTER
:
364 struct bt_component_class_filter
*flt_comp_cls
=
365 (void *) iterator
->upstream_component
->class;
367 iterator
->methods
.next
=
368 (bt_self_component_port_input_message_iterator_next_method
)
369 flt_comp_cls
->methods
.msg_iter_next
;
370 iterator
->methods
.seek_ns_from_origin
=
371 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
372 flt_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
373 iterator
->methods
.seek_beginning
=
374 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
375 flt_comp_cls
->methods
.msg_iter_seek_beginning
;
376 iterator
->methods
.can_seek_ns_from_origin
=
377 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
378 flt_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
379 iterator
->methods
.can_seek_beginning
=
380 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
381 flt_comp_cls
->methods
.msg_iter_can_seek_beginning
;
388 if (iterator
->methods
.seek_ns_from_origin
&&
389 !iterator
->methods
.can_seek_ns_from_origin
) {
390 iterator
->methods
.can_seek_ns_from_origin
=
391 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
392 can_seek_ns_from_origin_true
;
395 if (iterator
->methods
.seek_beginning
&&
396 !iterator
->methods
.can_seek_beginning
) {
397 iterator
->methods
.can_seek_beginning
=
398 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
399 can_seek_beginning_true
;
402 BT_LIB_LOGI("Created initial message iterator on self component input port: "
403 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
404 upstream_port
, upstream_comp
, iterator
);
410 struct bt_self_component_port_input_message_iterator
*
411 bt_self_component_port_input_message_iterator_create(
412 struct bt_self_component_port_input
*self_port
)
414 typedef enum bt_self_message_iterator_status (*init_method_t
)(
415 void *, void *, void *);
417 init_method_t init_method
= NULL
;
418 struct bt_self_component_port_input_message_iterator
*iterator
=
420 struct bt_port
*port
= (void *) self_port
;
421 struct bt_port
*upstream_port
;
422 struct bt_component
*comp
;
423 struct bt_component
*upstream_comp
;
424 struct bt_component_class
*upstream_comp_cls
;
426 BT_ASSERT_PRE_NON_NULL(port
, "Port");
427 comp
= bt_port_borrow_component_inline(port
);
428 BT_ASSERT_PRE(bt_port_is_connected(port
),
429 "Port is not connected: %![port-]+p", port
);
430 BT_ASSERT_PRE(comp
, "Port is not part of a component: %![port-]+p",
432 BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp
),
433 "Port's component's graph is canceled: "
434 "%![port-]+p, %![comp-]+c", port
, comp
);
435 BT_ASSERT(port
->connection
);
436 upstream_port
= port
->connection
->upstream_port
;
437 BT_ASSERT(upstream_port
);
438 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
439 BT_ASSERT(upstream_comp
);
441 bt_component_borrow_graph(upstream_comp
)->config_state
!=
442 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
443 "Graph is not configured: %!+g",
444 bt_component_borrow_graph(upstream_comp
));
445 upstream_comp_cls
= upstream_comp
->class;
446 BT_ASSERT(upstream_comp
->class->type
==
447 BT_COMPONENT_CLASS_TYPE_SOURCE
||
448 upstream_comp
->class->type
==
449 BT_COMPONENT_CLASS_TYPE_FILTER
);
450 iterator
= bt_self_component_port_input_message_iterator_create_initial(
451 upstream_comp
, upstream_port
);
453 BT_LOGW_STR("Cannot create self component input port "
454 "message iterator.");
458 switch (upstream_comp_cls
->type
) {
459 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
461 struct bt_component_class_source
*src_comp_cls
=
462 (void *) upstream_comp_cls
;
465 (init_method_t
) src_comp_cls
->methods
.msg_iter_init
;
468 case BT_COMPONENT_CLASS_TYPE_FILTER
:
470 struct bt_component_class_filter
*flt_comp_cls
=
471 (void *) upstream_comp_cls
;
474 (init_method_t
) flt_comp_cls
->methods
.msg_iter_init
;
485 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator
);
486 iter_status
= init_method(iterator
, upstream_comp
,
488 BT_LOGD("User method returned: status=%s",
489 bt_message_iterator_status_string(iter_status
));
490 if (iter_status
!= BT_MESSAGE_ITERATOR_STATUS_OK
) {
491 BT_LOGW_STR("Initialization method failed.");
492 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
497 set_self_comp_port_input_msg_iterator_state(iterator
,
498 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
499 g_ptr_array_add(port
->connection
->iterators
, iterator
);
500 BT_LIB_LOGI("Created message iterator on self component input port: "
501 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
502 upstream_port
, upstream_comp
, iterator
);
508 void *bt_self_message_iterator_get_data(
509 const struct bt_self_message_iterator
*self_iterator
)
511 struct bt_self_component_port_input_message_iterator
*iterator
=
512 (void *) self_iterator
;
514 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
515 return iterator
->user_data
;
518 void bt_self_message_iterator_set_data(
519 struct bt_self_message_iterator
*self_iterator
, void *data
)
521 struct bt_self_component_port_input_message_iterator
*iterator
=
522 (void *) self_iterator
;
524 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
525 iterator
->user_data
= data
;
526 BT_LIB_LOGD("Set message iterator's user data: "
527 "%!+i, user-data-addr=%p", iterator
, data
);
530 enum bt_message_iterator_status
531 bt_self_component_port_input_message_iterator_next(
532 struct bt_self_component_port_input_message_iterator
*iterator
,
533 bt_message_array_const
*msgs
, uint64_t *user_count
)
535 int status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
537 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
538 BT_ASSERT_PRE_NON_NULL(msgs
, "Message array (output)");
539 BT_ASSERT_PRE_NON_NULL(user_count
, "Message count (output)");
540 BT_ASSERT_PRE(iterator
->state
==
541 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
542 "Message iterator's \"next\" called, but "
543 "message iterator is in the wrong state: %!+i", iterator
);
544 BT_ASSERT(iterator
->upstream_component
);
545 BT_ASSERT(iterator
->upstream_component
->class);
547 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
548 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
549 "Graph is not configured: %!+g",
550 bt_component_borrow_graph(iterator
->upstream_component
));
551 BT_LIB_LOGD("Getting next self component input port "
552 "message iterator's messages: %!+i, batch-size=%u",
553 iterator
, MSG_BATCH_SIZE
);
556 * Call the user's "next" method to get the next messages
559 BT_ASSERT(iterator
->methods
.next
);
560 BT_LOGD_STR("Calling user's \"next\" method.");
562 status
= iterator
->methods
.next(iterator
,
563 (void *) iterator
->base
.msgs
->pdata
, MSG_BATCH_SIZE
,
565 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
566 bt_message_iterator_status_string(status
), *user_count
);
568 BT_LOGW_STR("User method failed.");
573 * There is no way that this iterator could have been finalized
574 * during its "next" method, as the only way to do this is to
575 * put the last iterator's reference, and this can only be done
576 * by its downstream owner.
578 * For the same reason, there is no way that this iterator could
579 * have seeked (cannot seek a self message iterator).
581 BT_ASSERT(iterator
->state
==
582 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
585 case BT_MESSAGE_ITERATOR_STATUS_OK
:
586 BT_ASSERT_PRE(*user_count
<= MSG_BATCH_SIZE
,
587 "Invalid returned message count: greater than "
588 "batch size: count=%" PRIu64
", batch-size=%u",
589 *user_count
, MSG_BATCH_SIZE
);
590 *msgs
= (void *) iterator
->base
.msgs
->pdata
;
592 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
594 case BT_MESSAGE_ITERATOR_STATUS_END
:
595 set_self_comp_port_input_msg_iterator_state(iterator
,
596 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
);
599 /* Unknown non-error status */
607 enum bt_message_iterator_status
bt_port_output_message_iterator_next(
608 struct bt_port_output_message_iterator
*iterator
,
609 bt_message_array_const
*msgs_to_user
,
610 uint64_t *count_to_user
)
612 enum bt_message_iterator_status status
;
613 enum bt_graph_status graph_status
;
615 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
616 BT_ASSERT_PRE_NON_NULL(msgs_to_user
, "Message array (output)");
617 BT_ASSERT_PRE_NON_NULL(count_to_user
, "Message count (output)");
618 BT_LIB_LOGD("Getting next output port message iterator's messages: "
620 graph_status
= bt_graph_consume_sink_no_check(iterator
->graph
,
622 switch (graph_status
) {
623 case BT_GRAPH_STATUS_CANCELED
:
624 case BT_GRAPH_STATUS_AGAIN
:
625 case BT_GRAPH_STATUS_END
:
626 case BT_GRAPH_STATUS_NOMEM
:
627 status
= (int) graph_status
;
629 case BT_GRAPH_STATUS_OK
:
630 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
633 * On success, the colander sink moves the messages
634 * to this iterator's array and sets this iterator's
635 * message count: move them to the user.
637 *msgs_to_user
= (void *) iterator
->base
.msgs
->pdata
;
638 *count_to_user
= iterator
->count
;
642 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
648 struct bt_component
*
649 bt_self_component_port_input_message_iterator_borrow_component(
650 struct bt_self_component_port_input_message_iterator
*iterator
)
652 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
653 return iterator
->upstream_component
;
656 const struct bt_component
*
657 bt_self_component_port_input_message_iterator_borrow_component_const(
658 const struct bt_self_component_port_input_message_iterator
*iterator
)
660 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
661 return iterator
->upstream_component
;
664 struct bt_self_component
*bt_self_message_iterator_borrow_component(
665 struct bt_self_message_iterator
*self_iterator
)
667 struct bt_self_component_port_input_message_iterator
*iterator
=
668 (void *) self_iterator
;
670 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
671 return (void *) iterator
->upstream_component
;
674 struct bt_self_port_output
*bt_self_message_iterator_borrow_port(
675 struct bt_self_message_iterator
*self_iterator
)
677 struct bt_self_component_port_input_message_iterator
*iterator
=
678 (void *) self_iterator
;
680 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
681 return (void *) iterator
->upstream_port
;
685 void bt_port_output_message_iterator_destroy(struct bt_object
*obj
)
687 struct bt_port_output_message_iterator
*iterator
= (void *) obj
;
689 BT_LIB_LOGI("Destroying output port message iterator object: %!+i",
691 BT_LOGD_STR("Putting graph.");
692 BT_OBJECT_PUT_REF_AND_RESET(iterator
->graph
);
693 BT_LOGD_STR("Putting colander sink component.");
694 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
695 destroy_base_message_iterator(obj
);
698 struct bt_port_output_message_iterator
*
699 bt_port_output_message_iterator_create(struct bt_graph
*graph
,
700 const struct bt_port_output
*output_port
)
702 struct bt_port_output_message_iterator
*iterator
= NULL
;
703 struct bt_component_class_sink
*colander_comp_cls
= NULL
;
704 struct bt_component
*output_port_comp
= NULL
;
705 struct bt_component_sink
*colander_comp
;
706 enum bt_graph_status graph_status
;
707 struct bt_port_input
*colander_in_port
= NULL
;
708 struct bt_component_class_sink_colander_data colander_data
;
711 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
712 BT_ASSERT_PRE_NON_NULL(output_port
, "Output port");
713 output_port_comp
= bt_port_borrow_component_inline(
714 (const void *) output_port
);
715 BT_ASSERT_PRE(output_port_comp
,
716 "Output port has no component: %!+p", output_port
);
717 BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp
) ==
719 "Output port is not part of graph: %![graph-]+g, %![port-]+p",
721 BT_ASSERT_PRE(!graph
->has_sink
,
722 "Graph already has a sink component: %![graph-]+g");
724 /* Create message iterator */
725 BT_LIB_LOGI("Creating message iterator on output port: "
726 "%![port-]+p, %![comp-]+c", output_port
, output_port_comp
);
727 iterator
= g_new0(struct bt_port_output_message_iterator
, 1);
729 BT_LOGE_STR("Failed to allocate one output port message iterator.");
733 ret
= init_message_iterator((void *) iterator
,
734 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
,
735 bt_port_output_message_iterator_destroy
);
737 /* init_message_iterator() logs errors */
738 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
742 /* Create colander component */
743 colander_comp_cls
= bt_component_class_sink_colander_get();
744 if (!colander_comp_cls
) {
745 BT_LOGW("Cannot get colander sink component class.");
749 iterator
->graph
= graph
;
750 bt_object_get_no_null_check(iterator
->graph
);
751 colander_data
.msgs
= (void *) iterator
->base
.msgs
->pdata
;
752 colander_data
.count_addr
= &iterator
->count
;
755 * Hope that nobody uses this very unique name.
757 * We pass `BT_LOGGING_LEVEL_NONE` but the colander component
758 * class module does not use this level anyway since it belongs
762 bt_graph_add_sink_component_with_init_method_data(
763 (void *) graph
, colander_comp_cls
,
764 "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
765 NULL
, &colander_data
, BT_LOGGING_LEVEL_NONE
,
766 (void *) &iterator
->colander
);
767 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
768 BT_LIB_LOGW("Cannot add colander sink component to graph: "
769 "%1[graph-]+g, status=%s", graph
,
770 bt_graph_status_string(graph_status
));
775 * Connect provided output port to the colander component's
779 (void *) bt_component_sink_borrow_input_port_by_index_const(
780 (void *) iterator
->colander
, 0);
781 BT_ASSERT(colander_in_port
);
782 graph_status
= bt_graph_connect_ports(graph
,
783 output_port
, colander_in_port
, NULL
);
784 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
785 BT_LIB_LOGW("Cannot add colander sink component to graph: "
786 "%![graph-]+g, %![comp-]+c, status=%s", graph
,
788 bt_graph_status_string(graph_status
));
793 * At this point everything went fine. Make the graph
794 * nonconsumable forever so that only this message iterator
795 * can consume (thanks to bt_graph_consume_sink_no_check()).
796 * This avoids leaking the message created by the colander
797 * sink and moved to the message iterator's message
800 bt_graph_set_can_consume(iterator
->graph
, false);
802 /* Also set the graph as being configured. */
803 graph_status
= bt_graph_configure(graph
);
804 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
805 BT_LIB_LOGW("Cannot configure graph after having added colander: "
806 "%![graph-]+g, status=%s", graph
,
807 bt_graph_status_string(graph_status
));
813 if (iterator
&& iterator
->graph
&& iterator
->colander
) {
816 /* Remove created colander component from graph if any */
817 colander_comp
= iterator
->colander
;
818 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
821 * At this point the colander component's reference
822 * count is 0 because iterator->colander was the only
823 * owner. We also know that it is not connected because
824 * this is the last operation before this function
827 * Since we honor the preconditions here,
828 * bt_graph_remove_unconnected_component() always
831 ret
= bt_graph_remove_unconnected_component(iterator
->graph
,
832 (void *) colander_comp
);
836 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
839 bt_object_put_ref(colander_comp_cls
);
840 return (void *) iterator
;
843 bt_bool
bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
844 struct bt_self_component_port_input_message_iterator
*iterator
,
845 int64_t ns_from_origin
)
847 bt_bool can
= BT_FALSE
;
849 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
850 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
852 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
853 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
854 "Graph is not configured: %!+g",
855 bt_component_borrow_graph(iterator
->upstream_component
));
857 if (iterator
->methods
.can_seek_ns_from_origin
) {
858 can
= iterator
->methods
.can_seek_ns_from_origin(iterator
,
864 * Automatic seeking fall back: if we can seek to the beginning,
865 * then we can automatically seek to any message.
867 if (iterator
->methods
.can_seek_beginning
) {
868 can
= iterator
->methods
.can_seek_beginning(iterator
);
875 bt_bool
bt_self_component_port_input_message_iterator_can_seek_beginning(
876 struct bt_self_component_port_input_message_iterator
*iterator
)
878 bt_bool can
= BT_FALSE
;
880 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
881 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
883 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
884 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
885 "Graph is not configured: %!+g",
886 bt_component_borrow_graph(iterator
->upstream_component
));
888 if (iterator
->methods
.can_seek_beginning
) {
889 can
= iterator
->methods
.can_seek_beginning(iterator
);
896 void set_iterator_state_after_seeking(
897 struct bt_self_component_port_input_message_iterator
*iterator
,
898 enum bt_message_iterator_status status
)
900 enum bt_self_component_port_input_message_iterator_state new_state
= 0;
902 /* Set iterator's state depending on seeking status */
904 case BT_MESSAGE_ITERATOR_STATUS_OK
:
905 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
;
907 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
908 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
;
910 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
911 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
912 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
;
914 case BT_MESSAGE_ITERATOR_STATUS_END
:
915 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
;
921 set_self_comp_port_input_msg_iterator_state(iterator
, new_state
);
924 enum bt_message_iterator_status
925 bt_self_component_port_input_message_iterator_seek_beginning(
926 struct bt_self_component_port_input_message_iterator
*iterator
)
930 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
931 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
933 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
934 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
935 "Graph is not configured: %!+g",
936 bt_component_borrow_graph(iterator
->upstream_component
));
938 bt_self_component_port_input_message_iterator_can_seek_beginning(
940 "Message iterator cannot seek beginning: %!+i", iterator
);
941 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator
);
942 set_self_comp_port_input_msg_iterator_state(iterator
,
943 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
944 status
= iterator
->methods
.seek_beginning(iterator
);
945 BT_LOGD("User method returned: status=%s",
946 bt_message_iterator_status_string(status
));
947 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
948 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
949 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
950 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
951 "Unexpected status: %![iter-]+i, status=%s",
952 iterator
, bt_common_self_message_iterator_status_string(status
));
953 set_iterator_state_after_seeking(iterator
, status
);
959 * Structure used to record the state of a given stream during the fast-forward
960 * phase of an auto-seek.
962 struct auto_seek_stream_state
{
964 * Value representing which step of this timeline we are at.
967 * [SB] 1 [SAB] 2 [PB] 3 [PE] 2 [SAE] 1 [SE]
969 * At each point in the timeline, the messages we need to replicate are:
971 * 1: Stream beginning
972 * 2: Stream beginning, stream activity beginning
973 * 3: Stream beginning, stream activity beginning, packet beginning
975 * Before "Stream beginning" and after "Stream end", we don't need to
976 * replicate anything as the stream doesn't exist.
979 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
,
980 AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
,
981 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
,
985 * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
986 * in. This is a weak reference, since the packet will always be
987 * alive by the time we use it.
989 struct bt_packet
*packet
;
993 struct auto_seek_stream_state
*create_auto_seek_stream_state(void)
995 return g_new0(struct auto_seek_stream_state
, 1);
999 void destroy_auto_seek_stream_state(void *ptr
)
1005 GHashTable
*create_auto_seek_stream_states(void)
1007 return g_hash_table_new_full(g_direct_hash
, g_direct_equal
, NULL
,
1008 destroy_auto_seek_stream_state
);
1012 void destroy_auto_seek_stream_states(GHashTable
*stream_states
)
1014 g_hash_table_destroy(stream_states
);
1018 * Handle one message while we are in the fast-forward phase of an auto-seek.
1020 * Sets `*got_first` to true if the message's timestamp is greater or equal to
1021 * `ns_from_origin`. In other words, if this is the first message after our
1024 * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1025 * `struct auto_seek_stream_state` used to keep the state of each stream
1026 * during the fast-forward.
1030 enum bt_message_iterator_status
auto_seek_handle_message(
1031 struct bt_self_component_port_input_message_iterator
*iterator
,
1032 int64_t ns_from_origin
, const struct bt_message
*msg
,
1033 bool *got_first
, GHashTable
*stream_states
)
1035 enum bt_message_iterator_status status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1036 int64_t msg_ns_from_origin
;
1037 const struct bt_clock_snapshot
*clk_snapshot
= NULL
;
1041 BT_ASSERT(got_first
);
1043 switch (msg
->type
) {
1044 case BT_MESSAGE_TYPE_EVENT
:
1046 const struct bt_message_event
*event_msg
=
1049 clk_snapshot
= event_msg
->default_cs
;
1050 BT_ASSERT_PRE(clk_snapshot
,
1051 "Event message has no default clock snapshot: %!+n",
1055 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1057 const struct bt_message_message_iterator_inactivity
*inactivity_msg
=
1060 clk_snapshot
= inactivity_msg
->default_cs
;
1061 BT_ASSERT(clk_snapshot
);
1064 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1065 case BT_MESSAGE_TYPE_PACKET_END
:
1067 const struct bt_message_packet
*packet_msg
=
1070 clk_snapshot
= packet_msg
->default_cs
;
1071 BT_ASSERT_PRE(clk_snapshot
,
1072 "Packet message has no default clock snapshot: %!+n",
1076 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1077 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1079 struct bt_message_discarded_items
*msg_disc_items
=
1082 BT_ASSERT_PRE(msg_disc_items
->default_begin_cs
&&
1083 msg_disc_items
->default_end_cs
,
1084 "Discarded events/packets message has no default clock snapshots: %!+n",
1086 ret
= bt_clock_snapshot_get_ns_from_origin(
1087 msg_disc_items
->default_begin_cs
,
1088 &msg_ns_from_origin
);
1090 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1094 if (msg_ns_from_origin
>= ns_from_origin
) {
1099 ret
= bt_clock_snapshot_get_ns_from_origin(
1100 msg_disc_items
->default_end_cs
,
1101 &msg_ns_from_origin
);
1103 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1107 if (msg_ns_from_origin
>= ns_from_origin
) {
1109 * The discarded items message's beginning time
1110 * is before the requested seeking time, but its
1111 * end time is after. Modify the message so as
1112 * to set its beginning time to the requested
1113 * seeking time, and make its item count unknown
1114 * as we don't know if items were really
1115 * discarded within the new time range.
1117 uint64_t new_begin_raw_value
;
1119 ret
= bt_clock_class_clock_value_from_ns_from_origin(
1120 msg_disc_items
->default_end_cs
->clock_class
,
1121 ns_from_origin
, &new_begin_raw_value
);
1123 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1127 bt_clock_snapshot_set_raw_value(
1128 msg_disc_items
->default_begin_cs
,
1129 new_begin_raw_value
);
1130 msg_disc_items
->count
.base
.avail
=
1131 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
1134 * It is safe to push it because its beginning
1135 * time is exactly the requested seeking time.
1142 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1144 const struct bt_message_stream_activity
*stream_act_msg
=
1147 switch (stream_act_msg
->default_cs_state
) {
1148 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1149 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1151 * -inf is always less than any requested time,
1152 * and we can't assume any specific time for an
1153 * unknown clock snapshot, so skip this.
1156 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1157 clk_snapshot
= stream_act_msg
->default_cs
;
1158 BT_ASSERT(clk_snapshot
);
1166 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1168 const struct bt_message_stream_activity
*stream_act_msg
=
1171 switch (stream_act_msg
->default_cs_state
) {
1172 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1174 * We can't assume any specific time for an
1175 * unknown clock snapshot, so skip this.
1178 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1180 * +inf is always greater than any requested
1185 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1186 clk_snapshot
= stream_act_msg
->default_cs
;
1187 BT_ASSERT(clk_snapshot
);
1195 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1196 case BT_MESSAGE_TYPE_STREAM_END
:
1203 BT_ASSERT(clk_snapshot
);
1204 ret
= bt_clock_snapshot_get_ns_from_origin(clk_snapshot
,
1205 &msg_ns_from_origin
);
1207 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1211 if (msg_ns_from_origin
>= ns_from_origin
) {
1217 /* This message won't be sent downstream. */
1218 switch (msg
->type
) {
1219 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1221 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1222 struct auto_seek_stream_state
*stream_state
;
1223 gboolean did_not_exist
;
1225 /* Update stream's state: stream began. */
1226 stream_state
= create_auto_seek_stream_state();
1227 if (!stream_state
) {
1228 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1232 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1233 did_not_exist
= g_hash_table_insert(stream_states
, stream_msg
->stream
, stream_state
);
1234 BT_ASSERT(did_not_exist
);
1237 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1239 const struct bt_message_stream_activity
*stream_act_msg
=
1241 struct auto_seek_stream_state
*stream_state
;
1243 /* Update stream's state: stream activity began. */
1244 stream_state
= g_hash_table_lookup(stream_states
, stream_act_msg
->stream
);
1245 BT_ASSERT(stream_state
);
1247 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1248 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
;
1249 BT_ASSERT(!stream_state
->packet
);
1252 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1254 const struct bt_message_packet
*packet_msg
=
1256 struct auto_seek_stream_state
*stream_state
;
1258 /* Update stream's state: packet began. */
1259 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1260 BT_ASSERT(stream_state
);
1262 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
);
1263 stream_state
->state
= AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
;
1264 BT_ASSERT(!stream_state
->packet
);
1265 stream_state
->packet
= packet_msg
->packet
;
1268 case BT_MESSAGE_TYPE_PACKET_END
:
1270 const struct bt_message_packet
*packet_msg
=
1272 struct auto_seek_stream_state
*stream_state
;
1274 /* Update stream's state: packet ended. */
1275 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1276 BT_ASSERT(stream_state
);
1278 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
);
1279 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
;
1280 BT_ASSERT(stream_state
->packet
);
1281 stream_state
->packet
= NULL
;
1284 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1286 const struct bt_message_stream_activity
*stream_act_msg
=
1288 struct auto_seek_stream_state
*stream_state
;
1290 /* Update stream's state: stream activity ended. */
1291 stream_state
= g_hash_table_lookup(stream_states
, stream_act_msg
->stream
);
1292 BT_ASSERT(stream_state
);
1294 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
);
1295 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1296 BT_ASSERT(!stream_state
->packet
);
1299 case BT_MESSAGE_TYPE_STREAM_END
:
1301 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1302 struct auto_seek_stream_state
*stream_state
;
1304 stream_state
= g_hash_table_lookup(stream_states
, stream_msg
->stream
);
1305 BT_ASSERT(stream_state
);
1306 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1307 BT_ASSERT(!stream_state
->packet
);
1309 /* Update stream's state: this stream doesn't exist anymore. */
1310 g_hash_table_remove(stream_states
, stream_msg
->stream
);
1317 bt_object_put_no_null_check(msg
);
1322 g_queue_push_tail(iterator
->auto_seek
.msgs
, (void *) msg
);
1326 BT_ASSERT(!msg
|| status
!= BT_MESSAGE_ITERATOR_STATUS_OK
);
1331 enum bt_message_iterator_status
find_message_ge_ns_from_origin(
1332 struct bt_self_component_port_input_message_iterator
*iterator
,
1333 int64_t ns_from_origin
, GHashTable
*stream_states
)
1336 enum bt_self_component_port_input_message_iterator_state init_state
=
1338 const struct bt_message
*messages
[MSG_BATCH_SIZE
];
1339 uint64_t user_count
= 0;
1341 bool got_first
= false;
1343 BT_ASSERT(iterator
);
1344 memset(&messages
[0], 0, sizeof(messages
[0]) * MSG_BATCH_SIZE
);
1347 * Make this iterator temporarily active (not seeking) to call
1348 * the "next" method.
1350 set_self_comp_port_input_msg_iterator_state(iterator
,
1351 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1353 BT_ASSERT(iterator
->methods
.next
);
1355 while (!got_first
) {
1357 * Call the user's "next" method to get the next
1358 * messages and status.
1360 BT_LOGD_STR("Calling user's \"next\" method.");
1361 status
= iterator
->methods
.next(iterator
,
1362 &messages
[0], MSG_BATCH_SIZE
, &user_count
);
1363 BT_LOGD("User method returned: status=%s",
1364 bt_message_iterator_status_string(status
));
1367 * The user's "next" method must not do any action which
1368 * would change the iterator's state.
1370 BT_ASSERT(iterator
->state
==
1371 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1374 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1375 BT_ASSERT_PRE(user_count
<= MSG_BATCH_SIZE
,
1376 "Invalid returned message count: greater than "
1377 "batch size: count=%" PRIu64
", batch-size=%u",
1378 user_count
, MSG_BATCH_SIZE
);
1380 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1381 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1382 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1383 case BT_MESSAGE_ITERATOR_STATUS_END
:
1389 for (i
= 0; i
< user_count
; i
++) {
1391 g_queue_push_tail(iterator
->auto_seek
.msgs
,
1392 (void *) messages
[i
]);
1397 status
= auto_seek_handle_message(iterator
,
1398 ns_from_origin
, messages
[i
], &got_first
,
1400 if (status
== BT_MESSAGE_ITERATOR_STATUS_OK
) {
1401 /* Message was either pushed or moved */
1410 for (i
= 0; i
< user_count
; i
++) {
1412 bt_object_put_no_null_check(messages
[i
]);
1416 set_self_comp_port_input_msg_iterator_state(iterator
, init_state
);
1421 * This function is installed as the iterator's next callback after we have
1422 * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1423 * messages saved in iterator->auto_seek.msgs. Once this is done, the original
1424 * next callback is put back.
1428 enum bt_self_message_iterator_status
post_auto_seek_next(
1429 struct bt_self_component_port_input_message_iterator
*iterator
,
1430 bt_message_array_const msgs
, uint64_t capacity
,
1433 BT_ASSERT(!g_queue_is_empty(iterator
->auto_seek
.msgs
));
1437 * Move auto-seek messages to the output array (which is this
1438 * iterator's base message array).
1440 while (capacity
> 0 && !g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1441 msgs
[*count
] = g_queue_pop_head(iterator
->auto_seek
.msgs
);
1446 BT_ASSERT(*count
> 0);
1448 if (g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1449 /* No more auto-seek messages, restore user's next callback. */
1450 BT_ASSERT(iterator
->auto_seek
.original_next_callback
);
1451 iterator
->methods
.next
= iterator
->auto_seek
.original_next_callback
;
1452 iterator
->auto_seek
.original_next_callback
= NULL
;
1455 return BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
1459 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1460 int64_t ns_from_origin
, uint64_t *raw_value
)
1463 int64_t cc_offset_s
= clock_class
->offset_seconds
;
1464 uint64_t cc_offset_cycles
= clock_class
->offset_cycles
;
1465 uint64_t cc_freq
= clock_class
->frequency
;
1467 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1468 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1472 enum bt_message_iterator_status
1473 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1474 struct bt_self_component_port_input_message_iterator
*iterator
,
1475 int64_t ns_from_origin
)
1478 GHashTable
*stream_states
= NULL
;
1480 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1481 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1483 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1484 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1485 "Graph is not configured: %!+g",
1486 bt_component_borrow_graph(iterator
->upstream_component
));
1488 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1489 iterator
, ns_from_origin
),
1490 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1491 "ns-from-origin=%" PRId64
, iterator
, ns_from_origin
);
1492 set_self_comp_port_input_msg_iterator_state(iterator
,
1493 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1495 if (iterator
->methods
.seek_ns_from_origin
) {
1496 /* The iterator knows how to seek to a particular time, let it handle this. */
1497 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1498 "%![iter-]+i, ns=%" PRId64
, iterator
, ns_from_origin
);
1499 status
= iterator
->methods
.seek_ns_from_origin(iterator
,
1501 BT_LOGD("User method returned: status=%s",
1502 bt_message_iterator_status_string(status
));
1503 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1504 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1505 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1506 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1507 "Unexpected status: %![iter-]+i, status=%s",
1509 bt_common_self_message_iterator_status_string(status
));
1512 * The iterator doesn't know how to seek to a particular time. We will
1513 * seek to the beginning and fast forward to the right place.
1515 BT_ASSERT(iterator
->methods
.can_seek_beginning(iterator
));
1516 BT_ASSERT(iterator
->methods
.seek_beginning
);
1517 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1519 status
= iterator
->methods
.seek_beginning(iterator
);
1520 BT_LOGD("User method returned: status=%s",
1521 bt_message_iterator_status_string(status
));
1522 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1523 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1524 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1525 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1526 "Unexpected status: %![iter-]+i, status=%s",
1528 bt_common_self_message_iterator_status_string(status
));
1530 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1532 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1533 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1534 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1541 * Find the first message which has a default clock
1542 * snapshot greater than or equal to the requested
1543 * seeking time, and move the received messages from
1544 * this point in the batch to this iterator's auto-seek
1547 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1548 bt_object_put_no_null_check(
1549 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
1552 stream_states
= create_auto_seek_stream_states();
1553 if (!stream_states
) {
1554 BT_LOGE_STR("Failed to allocate one GHashTable.");
1555 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1559 status
= find_message_ge_ns_from_origin(iterator
,
1560 ns_from_origin
, stream_states
);
1562 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1563 case BT_MESSAGE_ITERATOR_STATUS_END
:
1565 GHashTableIter iter
;
1566 gpointer key
, value
;
1569 * If some streams exist at the seek time, prepend the
1570 * required messages to put those streams in the right
1573 g_hash_table_iter_init(&iter
, stream_states
);
1574 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
1575 const bt_stream
*stream
= key
;
1576 struct auto_seek_stream_state
*stream_state
=
1577 (struct auto_seek_stream_state
*) value
;
1579 const bt_clock_class
*clock_class
= bt_stream_class_borrow_default_clock_class_const(
1580 bt_stream_borrow_class_const(stream
));
1583 if (clock_raw_value_from_ns_from_origin(clock_class
, ns_from_origin
, &raw_value
) != 0) {
1584 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64
", %![cc-]+K",
1585 ns_from_origin
, clock_class
);
1586 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1590 switch (stream_state
->state
) {
1591 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
:
1592 BT_ASSERT(stream_state
->packet
);
1593 BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state
->packet
);
1594 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1595 (bt_self_message_iterator
*) iterator
, stream_state
->packet
, raw_value
);
1597 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1601 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1604 case AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
:
1605 msg
= bt_message_stream_activity_beginning_create(
1606 (bt_self_message_iterator
*) iterator
, stream
);
1608 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1612 bt_message_stream_activity_beginning_set_default_clock_snapshot(msg
, raw_value
);
1614 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1617 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
:
1618 msg
= bt_message_stream_beginning_create(
1619 (bt_self_message_iterator
*) iterator
, stream
);
1621 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1625 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1632 * If there are messages in the auto-seek
1633 * message queue, replace the user's "next"
1634 * method with a custom, temporary "next" method
1635 * which returns them.
1637 if (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1638 BT_ASSERT(!iterator
->auto_seek
.original_next_callback
);
1639 iterator
->auto_seek
.original_next_callback
= iterator
->methods
.next
;
1641 iterator
->methods
.next
=
1642 (bt_self_component_port_input_message_iterator_next_method
)
1643 post_auto_seek_next
;
1647 * `BT_MESSAGE_ITERATOR_STATUS_END` becomes
1648 * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next
1649 * time this iterator's "next" method is called,
1651 * `BT_MESSAGE_ITERATOR_STATUS_END`.
1653 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1656 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1657 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1658 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1666 if (stream_states
) {
1667 destroy_auto_seek_stream_states(stream_states
);
1668 stream_states
= NULL
;
1670 set_iterator_state_after_seeking(iterator
, status
);
1675 bt_self_component_port_input_message_iterator
*
1676 borrow_output_port_message_iterator_upstream_iterator(
1677 struct bt_port_output_message_iterator
*iterator
)
1679 struct bt_component_class_sink_colander_priv_data
*colander_data
;
1681 BT_ASSERT(iterator
);
1682 colander_data
= (void *) iterator
->colander
->parent
.user_data
;
1683 BT_ASSERT(colander_data
);
1684 BT_ASSERT(colander_data
->msg_iter
);
1685 return colander_data
->msg_iter
;
1688 bt_bool
bt_port_output_message_iterator_can_seek_ns_from_origin(
1689 struct bt_port_output_message_iterator
*iterator
,
1690 int64_t ns_from_origin
)
1692 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1693 return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1694 borrow_output_port_message_iterator_upstream_iterator(
1695 iterator
), ns_from_origin
);
1698 bt_bool
bt_port_output_message_iterator_can_seek_beginning(
1699 struct bt_port_output_message_iterator
*iterator
)
1701 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1702 return bt_self_component_port_input_message_iterator_can_seek_beginning(
1703 borrow_output_port_message_iterator_upstream_iterator(
1707 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_ns_from_origin(
1708 struct bt_port_output_message_iterator
*iterator
,
1709 int64_t ns_from_origin
)
1711 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1712 return bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1713 borrow_output_port_message_iterator_upstream_iterator(iterator
),
1717 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_beginning(
1718 struct bt_port_output_message_iterator
*iterator
)
1720 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1721 return bt_self_component_port_input_message_iterator_seek_beginning(
1722 borrow_output_port_message_iterator_upstream_iterator(
1726 void bt_port_output_message_iterator_get_ref(
1727 const struct bt_port_output_message_iterator
*iterator
)
1729 bt_object_get_ref(iterator
);
1732 void bt_port_output_message_iterator_put_ref(
1733 const struct bt_port_output_message_iterator
*iterator
)
1735 bt_object_put_ref(iterator
);
1738 void bt_self_component_port_input_message_iterator_get_ref(
1739 const struct bt_self_component_port_input_message_iterator
*iterator
)
1741 bt_object_get_ref(iterator
);
1744 void bt_self_component_port_input_message_iterator_put_ref(
1745 const struct bt_self_component_port_input_message_iterator
*iterator
)
1747 bt_object_put_ref(iterator
);