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
->auto_seek
.msgs
= g_queue_new();
327 if (!iterator
->auto_seek
.msgs
) {
328 BT_LOGE_STR("Failed to allocate a GQueue.");
333 iterator
->upstream_component
= upstream_comp
;
334 iterator
->upstream_port
= upstream_port
;
335 iterator
->connection
= iterator
->upstream_port
->connection
;
336 iterator
->graph
= bt_component_borrow_graph(upstream_comp
);
337 set_self_comp_port_input_msg_iterator_state(iterator
,
338 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED
);
340 switch (iterator
->upstream_component
->class->type
) {
341 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
343 struct bt_component_class_source
*src_comp_cls
=
344 (void *) iterator
->upstream_component
->class;
346 iterator
->methods
.next
=
347 (bt_self_component_port_input_message_iterator_next_method
)
348 src_comp_cls
->methods
.msg_iter_next
;
349 iterator
->methods
.seek_ns_from_origin
=
350 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
351 src_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
352 iterator
->methods
.seek_beginning
=
353 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
354 src_comp_cls
->methods
.msg_iter_seek_beginning
;
355 iterator
->methods
.can_seek_ns_from_origin
=
356 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
357 src_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
358 iterator
->methods
.can_seek_beginning
=
359 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
360 src_comp_cls
->methods
.msg_iter_can_seek_beginning
;
363 case BT_COMPONENT_CLASS_TYPE_FILTER
:
365 struct bt_component_class_filter
*flt_comp_cls
=
366 (void *) iterator
->upstream_component
->class;
368 iterator
->methods
.next
=
369 (bt_self_component_port_input_message_iterator_next_method
)
370 flt_comp_cls
->methods
.msg_iter_next
;
371 iterator
->methods
.seek_ns_from_origin
=
372 (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method
)
373 flt_comp_cls
->methods
.msg_iter_seek_ns_from_origin
;
374 iterator
->methods
.seek_beginning
=
375 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
376 flt_comp_cls
->methods
.msg_iter_seek_beginning
;
377 iterator
->methods
.can_seek_ns_from_origin
=
378 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
379 flt_comp_cls
->methods
.msg_iter_can_seek_ns_from_origin
;
380 iterator
->methods
.can_seek_beginning
=
381 (bt_self_component_port_input_message_iterator_can_seek_beginning_method
)
382 flt_comp_cls
->methods
.msg_iter_can_seek_beginning
;
389 if (iterator
->methods
.seek_ns_from_origin
&&
390 !iterator
->methods
.can_seek_ns_from_origin
) {
391 iterator
->methods
.can_seek_ns_from_origin
=
392 (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method
)
393 can_seek_ns_from_origin_true
;
396 if (iterator
->methods
.seek_beginning
&&
397 !iterator
->methods
.can_seek_beginning
) {
398 iterator
->methods
.can_seek_beginning
=
399 (bt_self_component_port_input_message_iterator_seek_beginning_method
)
400 can_seek_beginning_true
;
403 BT_LIB_LOGI("Created initial message iterator on self component input port: "
404 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
405 upstream_port
, upstream_comp
, iterator
);
411 struct bt_self_component_port_input_message_iterator
*
412 bt_self_component_port_input_message_iterator_create(
413 struct bt_self_component_port_input
*self_port
)
415 typedef enum bt_self_message_iterator_status (*init_method_t
)(
416 void *, void *, void *);
418 init_method_t init_method
= NULL
;
419 struct bt_self_component_port_input_message_iterator
*iterator
=
421 struct bt_port
*port
= (void *) self_port
;
422 struct bt_port
*upstream_port
;
423 struct bt_component
*comp
;
424 struct bt_component
*upstream_comp
;
425 struct bt_component_class
*upstream_comp_cls
;
427 BT_ASSERT_PRE_NON_NULL(port
, "Port");
428 comp
= bt_port_borrow_component_inline(port
);
429 BT_ASSERT_PRE(bt_port_is_connected(port
),
430 "Port is not connected: %![port-]+p", port
);
431 BT_ASSERT_PRE(comp
, "Port is not part of a component: %![port-]+p",
433 BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp
),
434 "Port's component's graph is canceled: "
435 "%![port-]+p, %![comp-]+c", port
, comp
);
436 BT_ASSERT(port
->connection
);
437 upstream_port
= port
->connection
->upstream_port
;
438 BT_ASSERT(upstream_port
);
439 upstream_comp
= bt_port_borrow_component_inline(upstream_port
);
440 BT_ASSERT(upstream_comp
);
442 bt_component_borrow_graph(upstream_comp
)->config_state
!=
443 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
444 "Graph is not configured: %!+g",
445 bt_component_borrow_graph(upstream_comp
));
446 upstream_comp_cls
= upstream_comp
->class;
447 BT_ASSERT(upstream_comp
->class->type
==
448 BT_COMPONENT_CLASS_TYPE_SOURCE
||
449 upstream_comp
->class->type
==
450 BT_COMPONENT_CLASS_TYPE_FILTER
);
451 iterator
= bt_self_component_port_input_message_iterator_create_initial(
452 upstream_comp
, upstream_port
);
454 BT_LOGW_STR("Cannot create self component input port "
455 "message iterator.");
459 switch (upstream_comp_cls
->type
) {
460 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
462 struct bt_component_class_source
*src_comp_cls
=
463 (void *) upstream_comp_cls
;
466 (init_method_t
) src_comp_cls
->methods
.msg_iter_init
;
469 case BT_COMPONENT_CLASS_TYPE_FILTER
:
471 struct bt_component_class_filter
*flt_comp_cls
=
472 (void *) upstream_comp_cls
;
475 (init_method_t
) flt_comp_cls
->methods
.msg_iter_init
;
486 BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator
);
487 iter_status
= init_method(iterator
, upstream_comp
,
489 BT_LOGD("User method returned: status=%s",
490 bt_message_iterator_status_string(iter_status
));
491 if (iter_status
!= BT_MESSAGE_ITERATOR_STATUS_OK
) {
492 BT_LOGW_STR("Initialization method failed.");
493 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
498 set_self_comp_port_input_msg_iterator_state(iterator
,
499 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
500 g_ptr_array_add(port
->connection
->iterators
, iterator
);
501 BT_LIB_LOGI("Created message iterator on self component input port: "
502 "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i",
503 upstream_port
, upstream_comp
, iterator
);
509 void *bt_self_message_iterator_get_data(
510 const struct bt_self_message_iterator
*self_iterator
)
512 struct bt_self_component_port_input_message_iterator
*iterator
=
513 (void *) self_iterator
;
515 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
516 return iterator
->user_data
;
519 void bt_self_message_iterator_set_data(
520 struct bt_self_message_iterator
*self_iterator
, void *data
)
522 struct bt_self_component_port_input_message_iterator
*iterator
=
523 (void *) self_iterator
;
525 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
526 iterator
->user_data
= data
;
527 BT_LIB_LOGD("Set message iterator's user data: "
528 "%!+i, user-data-addr=%p", iterator
, data
);
531 enum bt_message_iterator_status
532 bt_self_component_port_input_message_iterator_next(
533 struct bt_self_component_port_input_message_iterator
*iterator
,
534 bt_message_array_const
*msgs
, uint64_t *user_count
)
536 int status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
538 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
539 BT_ASSERT_PRE_NON_NULL(msgs
, "Message array (output)");
540 BT_ASSERT_PRE_NON_NULL(user_count
, "Message count (output)");
541 BT_ASSERT_PRE(iterator
->state
==
542 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
,
543 "Message iterator's \"next\" called, but "
544 "message iterator is in the wrong state: %!+i", iterator
);
545 BT_ASSERT(iterator
->upstream_component
);
546 BT_ASSERT(iterator
->upstream_component
->class);
548 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
549 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
550 "Graph is not configured: %!+g",
551 bt_component_borrow_graph(iterator
->upstream_component
));
552 BT_LIB_LOGD("Getting next self component input port "
553 "message iterator's messages: %!+i, batch-size=%u",
554 iterator
, MSG_BATCH_SIZE
);
557 * Call the user's "next" method to get the next messages
560 BT_ASSERT(iterator
->methods
.next
);
561 BT_LOGD_STR("Calling user's \"next\" method.");
563 status
= iterator
->methods
.next(iterator
,
564 (void *) iterator
->base
.msgs
->pdata
, MSG_BATCH_SIZE
,
566 BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64
,
567 bt_message_iterator_status_string(status
), *user_count
);
569 BT_LOGW_STR("User method failed.");
574 * There is no way that this iterator could have been finalized
575 * during its "next" method, as the only way to do this is to
576 * put the last iterator's reference, and this can only be done
577 * by its downstream owner.
579 * For the same reason, there is no way that this iterator could
580 * have seeked (cannot seek a self message iterator).
582 BT_ASSERT(iterator
->state
==
583 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
586 case BT_MESSAGE_ITERATOR_STATUS_OK
:
587 BT_ASSERT_PRE(*user_count
<= MSG_BATCH_SIZE
,
588 "Invalid returned message count: greater than "
589 "batch size: count=%" PRIu64
", batch-size=%u",
590 *user_count
, MSG_BATCH_SIZE
);
591 *msgs
= (void *) iterator
->base
.msgs
->pdata
;
593 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
595 case BT_MESSAGE_ITERATOR_STATUS_END
:
596 set_self_comp_port_input_msg_iterator_state(iterator
,
597 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
);
600 /* Unknown non-error status */
608 enum bt_message_iterator_status
bt_port_output_message_iterator_next(
609 struct bt_port_output_message_iterator
*iterator
,
610 bt_message_array_const
*msgs_to_user
,
611 uint64_t *count_to_user
)
613 enum bt_message_iterator_status status
;
614 enum bt_graph_status graph_status
;
616 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
617 BT_ASSERT_PRE_NON_NULL(msgs_to_user
, "Message array (output)");
618 BT_ASSERT_PRE_NON_NULL(count_to_user
, "Message count (output)");
619 BT_LIB_LOGD("Getting next output port message iterator's messages: "
621 graph_status
= bt_graph_consume_sink_no_check(iterator
->graph
,
623 switch (graph_status
) {
624 case BT_GRAPH_STATUS_CANCELED
:
625 case BT_GRAPH_STATUS_AGAIN
:
626 case BT_GRAPH_STATUS_END
:
627 case BT_GRAPH_STATUS_NOMEM
:
628 status
= (int) graph_status
;
630 case BT_GRAPH_STATUS_OK
:
631 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
634 * On success, the colander sink moves the messages
635 * to this iterator's array and sets this iterator's
636 * message count: move them to the user.
638 *msgs_to_user
= (void *) iterator
->base
.msgs
->pdata
;
639 *count_to_user
= iterator
->count
;
643 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
649 struct bt_component
*
650 bt_self_component_port_input_message_iterator_borrow_component(
651 struct bt_self_component_port_input_message_iterator
*iterator
)
653 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
654 return iterator
->upstream_component
;
657 const struct bt_component
*
658 bt_self_component_port_input_message_iterator_borrow_component_const(
659 const struct bt_self_component_port_input_message_iterator
*iterator
)
661 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
662 return iterator
->upstream_component
;
665 struct bt_self_component
*bt_self_message_iterator_borrow_component(
666 struct bt_self_message_iterator
*self_iterator
)
668 struct bt_self_component_port_input_message_iterator
*iterator
=
669 (void *) self_iterator
;
671 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
672 return (void *) iterator
->upstream_component
;
675 struct bt_self_port_output
*bt_self_message_iterator_borrow_port(
676 struct bt_self_message_iterator
*self_iterator
)
678 struct bt_self_component_port_input_message_iterator
*iterator
=
679 (void *) self_iterator
;
681 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
682 return (void *) iterator
->upstream_port
;
686 void bt_port_output_message_iterator_destroy(struct bt_object
*obj
)
688 struct bt_port_output_message_iterator
*iterator
= (void *) obj
;
690 BT_LIB_LOGI("Destroying output port message iterator object: %!+i",
692 BT_LOGD_STR("Putting graph.");
693 BT_OBJECT_PUT_REF_AND_RESET(iterator
->graph
);
694 BT_LOGD_STR("Putting colander sink component.");
695 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
696 destroy_base_message_iterator(obj
);
699 struct bt_port_output_message_iterator
*
700 bt_port_output_message_iterator_create(struct bt_graph
*graph
,
701 const struct bt_port_output
*output_port
)
703 struct bt_port_output_message_iterator
*iterator
= NULL
;
704 struct bt_component_class_sink
*colander_comp_cls
= NULL
;
705 struct bt_component
*output_port_comp
= NULL
;
706 struct bt_component_sink
*colander_comp
;
707 enum bt_graph_status graph_status
;
708 struct bt_port_input
*colander_in_port
= NULL
;
709 struct bt_component_class_sink_colander_data colander_data
;
712 BT_ASSERT_PRE_NON_NULL(graph
, "Graph");
713 BT_ASSERT_PRE_NON_NULL(output_port
, "Output port");
714 output_port_comp
= bt_port_borrow_component_inline(
715 (const void *) output_port
);
716 BT_ASSERT_PRE(output_port_comp
,
717 "Output port has no component: %!+p", output_port
);
718 BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp
) ==
720 "Output port is not part of graph: %![graph-]+g, %![port-]+p",
722 BT_ASSERT_PRE(!graph
->has_sink
,
723 "Graph already has a sink component: %![graph-]+g");
725 /* Create message iterator */
726 BT_LIB_LOGI("Creating message iterator on output port: "
727 "%![port-]+p, %![comp-]+c", output_port
, output_port_comp
);
728 iterator
= g_new0(struct bt_port_output_message_iterator
, 1);
730 BT_LOGE_STR("Failed to allocate one output port message iterator.");
734 ret
= init_message_iterator((void *) iterator
,
735 BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT
,
736 bt_port_output_message_iterator_destroy
);
738 /* init_message_iterator() logs errors */
739 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
743 /* Create colander component */
744 colander_comp_cls
= bt_component_class_sink_colander_get();
745 if (!colander_comp_cls
) {
746 BT_LOGW("Cannot get colander sink component class.");
750 iterator
->graph
= graph
;
751 bt_object_get_no_null_check(iterator
->graph
);
752 colander_data
.msgs
= (void *) iterator
->base
.msgs
->pdata
;
753 colander_data
.count_addr
= &iterator
->count
;
756 * Hope that nobody uses this very unique name.
758 * We pass `BT_LOGGING_LEVEL_NONE` but the colander component
759 * class module does not use this level anyway since it belongs
763 bt_graph_add_sink_component_with_init_method_data(
764 (void *) graph
, colander_comp_cls
,
765 "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
766 NULL
, &colander_data
, BT_LOGGING_LEVEL_NONE
,
767 (void *) &iterator
->colander
);
768 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
769 BT_LIB_LOGW("Cannot add colander sink component to graph: "
770 "%1[graph-]+g, status=%s", graph
,
771 bt_graph_status_string(graph_status
));
776 * Connect provided output port to the colander component's
780 (void *) bt_component_sink_borrow_input_port_by_index_const(
781 (void *) iterator
->colander
, 0);
782 BT_ASSERT(colander_in_port
);
783 graph_status
= bt_graph_connect_ports(graph
,
784 output_port
, colander_in_port
, NULL
);
785 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
786 BT_LIB_LOGW("Cannot add colander sink component to graph: "
787 "%![graph-]+g, %![comp-]+c, status=%s", graph
,
789 bt_graph_status_string(graph_status
));
794 * At this point everything went fine. Make the graph
795 * nonconsumable forever so that only this message iterator
796 * can consume (thanks to bt_graph_consume_sink_no_check()).
797 * This avoids leaking the message created by the colander
798 * sink and moved to the message iterator's message
801 bt_graph_set_can_consume(iterator
->graph
, false);
803 /* Also set the graph as being configured. */
804 graph_status
= bt_graph_configure(graph
);
805 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
806 BT_LIB_LOGW("Cannot configure graph after having added colander: "
807 "%![graph-]+g, status=%s", graph
,
808 bt_graph_status_string(graph_status
));
814 if (iterator
&& iterator
->graph
&& iterator
->colander
) {
817 /* Remove created colander component from graph if any */
818 colander_comp
= iterator
->colander
;
819 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
822 * At this point the colander component's reference
823 * count is 0 because iterator->colander was the only
824 * owner. We also know that it is not connected because
825 * this is the last operation before this function
828 * Since we honor the preconditions here,
829 * bt_graph_remove_unconnected_component() always
832 ret
= bt_graph_remove_unconnected_component(iterator
->graph
,
833 (void *) colander_comp
);
837 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
840 bt_object_put_ref(colander_comp_cls
);
841 return (void *) iterator
;
844 bt_bool
bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
845 struct bt_self_component_port_input_message_iterator
*iterator
,
846 int64_t ns_from_origin
)
848 bt_bool can
= BT_FALSE
;
850 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
851 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
853 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
854 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
855 "Graph is not configured: %!+g",
856 bt_component_borrow_graph(iterator
->upstream_component
));
858 if (iterator
->methods
.can_seek_ns_from_origin
) {
859 can
= iterator
->methods
.can_seek_ns_from_origin(iterator
,
865 * Automatic seeking fall back: if we can seek to the beginning,
866 * then we can automatically seek to any message.
868 if (iterator
->methods
.can_seek_beginning
) {
869 can
= iterator
->methods
.can_seek_beginning(iterator
);
876 bt_bool
bt_self_component_port_input_message_iterator_can_seek_beginning(
877 struct bt_self_component_port_input_message_iterator
*iterator
)
879 bt_bool can
= BT_FALSE
;
881 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
882 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
884 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
885 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
886 "Graph is not configured: %!+g",
887 bt_component_borrow_graph(iterator
->upstream_component
));
889 if (iterator
->methods
.can_seek_beginning
) {
890 can
= iterator
->methods
.can_seek_beginning(iterator
);
897 void set_iterator_state_after_seeking(
898 struct bt_self_component_port_input_message_iterator
*iterator
,
899 enum bt_message_iterator_status status
)
901 enum bt_self_component_port_input_message_iterator_state new_state
= 0;
903 /* Set iterator's state depending on seeking status */
905 case BT_MESSAGE_ITERATOR_STATUS_OK
:
906 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
;
908 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
909 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
;
911 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
912 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
913 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
;
915 case BT_MESSAGE_ITERATOR_STATUS_END
:
916 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
;
922 set_self_comp_port_input_msg_iterator_state(iterator
, new_state
);
925 enum bt_message_iterator_status
926 bt_self_component_port_input_message_iterator_seek_beginning(
927 struct bt_self_component_port_input_message_iterator
*iterator
)
931 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
932 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
934 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
935 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
936 "Graph is not configured: %!+g",
937 bt_component_borrow_graph(iterator
->upstream_component
));
939 bt_self_component_port_input_message_iterator_can_seek_beginning(
941 "Message iterator cannot seek beginning: %!+i", iterator
);
942 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator
);
943 set_self_comp_port_input_msg_iterator_state(iterator
,
944 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
945 status
= iterator
->methods
.seek_beginning(iterator
);
946 BT_LOGD("User method returned: status=%s",
947 bt_message_iterator_status_string(status
));
948 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
949 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
950 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
951 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
952 "Unexpected status: %![iter-]+i, status=%s",
953 iterator
, bt_common_self_message_iterator_status_string(status
));
954 set_iterator_state_after_seeking(iterator
, status
);
960 * Structure used to record the state of a given stream during the fast-forward
961 * phase of an auto-seek.
963 struct auto_seek_stream_state
{
965 * Value representing which step of this timeline we are at.
968 * [SB] 1 [SAB] 2 [PB] 3 [PE] 2 [SAE] 1 [SE]
970 * At each point in the timeline, the messages we need to replicate are:
972 * 1: Stream beginning
973 * 2: Stream beginning, stream activity beginning
974 * 3: Stream beginning, stream activity beginning, packet beginning
976 * Before "Stream beginning" and after "Stream end", we don't need to
977 * replicate anything as the stream doesn't exist.
980 AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
,
981 AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
,
982 AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
,
986 * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
987 * in. This is a weak reference, since the packet will always be
988 * alive by the time we use it.
990 struct bt_packet
*packet
;
994 struct auto_seek_stream_state
*create_auto_seek_stream_state(void)
996 return g_new0(struct auto_seek_stream_state
, 1);
1000 void destroy_auto_seek_stream_state(void *ptr
)
1006 GHashTable
*create_auto_seek_stream_states(void)
1008 return g_hash_table_new_full(g_direct_hash
, g_direct_equal
, NULL
,
1009 destroy_auto_seek_stream_state
);
1013 void destroy_auto_seek_stream_states(GHashTable
*stream_states
)
1015 g_hash_table_destroy(stream_states
);
1019 * Handle one message while we are in the fast-forward phase of an auto-seek.
1021 * Sets `*got_first` to true if the message's timestamp is greater or equal to
1022 * `ns_from_origin`. In other words, if this is the first message after our
1025 * `stream_states` is an hash table of `bt_stream *` (weak reference) to
1026 * `struct auto_seek_stream_state` used to keep the state of each stream
1027 * during the fast-forward.
1031 enum bt_message_iterator_status
auto_seek_handle_message(
1032 struct bt_self_component_port_input_message_iterator
*iterator
,
1033 int64_t ns_from_origin
, const struct bt_message
*msg
,
1034 bool *got_first
, GHashTable
*stream_states
)
1036 enum bt_message_iterator_status status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1037 int64_t msg_ns_from_origin
;
1038 const struct bt_clock_snapshot
*clk_snapshot
= NULL
;
1042 BT_ASSERT(got_first
);
1044 switch (msg
->type
) {
1045 case BT_MESSAGE_TYPE_EVENT
:
1047 const struct bt_message_event
*event_msg
=
1050 clk_snapshot
= event_msg
->default_cs
;
1051 BT_ASSERT_PRE(clk_snapshot
,
1052 "Event message has no default clock snapshot: %!+n",
1056 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
1058 const struct bt_message_message_iterator_inactivity
*inactivity_msg
=
1061 clk_snapshot
= inactivity_msg
->default_cs
;
1062 BT_ASSERT(clk_snapshot
);
1065 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1066 case BT_MESSAGE_TYPE_PACKET_END
:
1068 const struct bt_message_packet
*packet_msg
=
1071 clk_snapshot
= packet_msg
->default_cs
;
1072 BT_ASSERT_PRE(clk_snapshot
,
1073 "Packet message has no default clock snapshot: %!+n",
1077 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1078 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1080 struct bt_message_discarded_items
*msg_disc_items
=
1083 BT_ASSERT_PRE(msg_disc_items
->default_begin_cs
&&
1084 msg_disc_items
->default_end_cs
,
1085 "Discarded events/packets message has no default clock snapshots: %!+n",
1087 ret
= bt_clock_snapshot_get_ns_from_origin(
1088 msg_disc_items
->default_begin_cs
,
1089 &msg_ns_from_origin
);
1091 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1095 if (msg_ns_from_origin
>= ns_from_origin
) {
1100 ret
= bt_clock_snapshot_get_ns_from_origin(
1101 msg_disc_items
->default_end_cs
,
1102 &msg_ns_from_origin
);
1104 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1108 if (msg_ns_from_origin
>= ns_from_origin
) {
1110 * The discarded items message's beginning time
1111 * is before the requested seeking time, but its
1112 * end time is after. Modify the message so as
1113 * to set its beginning time to the requested
1114 * seeking time, and make its item count unknown
1115 * as we don't know if items were really
1116 * discarded within the new time range.
1118 uint64_t new_begin_raw_value
;
1120 ret
= bt_clock_class_clock_value_from_ns_from_origin(
1121 msg_disc_items
->default_end_cs
->clock_class
,
1122 ns_from_origin
, &new_begin_raw_value
);
1124 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1128 bt_clock_snapshot_set_raw_value(
1129 msg_disc_items
->default_begin_cs
,
1130 new_begin_raw_value
);
1131 msg_disc_items
->count
.base
.avail
=
1132 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
1135 * It is safe to push it because its beginning
1136 * time is exactly the requested seeking time.
1143 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1145 const struct bt_message_stream_activity
*stream_act_msg
=
1148 switch (stream_act_msg
->default_cs_state
) {
1149 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1150 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1152 * -inf is always less than any requested time,
1153 * and we can't assume any specific time for an
1154 * unknown clock snapshot, so skip this.
1157 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1158 clk_snapshot
= stream_act_msg
->default_cs
;
1159 BT_ASSERT(clk_snapshot
);
1167 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1169 const struct bt_message_stream_activity
*stream_act_msg
=
1172 switch (stream_act_msg
->default_cs_state
) {
1173 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1175 * We can't assume any specific time for an
1176 * unknown clock snapshot, so skip this.
1179 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1181 * +inf is always greater than any requested
1186 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1187 clk_snapshot
= stream_act_msg
->default_cs
;
1188 BT_ASSERT(clk_snapshot
);
1196 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1197 case BT_MESSAGE_TYPE_STREAM_END
:
1204 BT_ASSERT(clk_snapshot
);
1205 ret
= bt_clock_snapshot_get_ns_from_origin(clk_snapshot
,
1206 &msg_ns_from_origin
);
1208 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1212 if (msg_ns_from_origin
>= ns_from_origin
) {
1218 /* This message won't be sent downstream. */
1219 switch (msg
->type
) {
1220 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1222 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1223 struct auto_seek_stream_state
*stream_state
;
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
;
1234 BT_ASSERT(!bt_g_hash_table_contains(stream_states
, stream_msg
->stream
));
1235 g_hash_table_insert(stream_states
, stream_msg
->stream
, stream_state
);
1238 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1240 const struct bt_message_stream_activity
*stream_act_msg
=
1242 struct auto_seek_stream_state
*stream_state
;
1244 /* Update stream's state: stream activity began. */
1245 stream_state
= g_hash_table_lookup(stream_states
, stream_act_msg
->stream
);
1246 BT_ASSERT(stream_state
);
1248 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1249 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
;
1250 BT_ASSERT(!stream_state
->packet
);
1253 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
1255 const struct bt_message_packet
*packet_msg
=
1257 struct auto_seek_stream_state
*stream_state
;
1259 /* Update stream's state: packet began. */
1260 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1261 BT_ASSERT(stream_state
);
1263 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
);
1264 stream_state
->state
= AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
;
1265 BT_ASSERT(!stream_state
->packet
);
1266 stream_state
->packet
= packet_msg
->packet
;
1269 case BT_MESSAGE_TYPE_PACKET_END
:
1271 const struct bt_message_packet
*packet_msg
=
1273 struct auto_seek_stream_state
*stream_state
;
1275 /* Update stream's state: packet ended. */
1276 stream_state
= g_hash_table_lookup(stream_states
, packet_msg
->packet
->stream
);
1277 BT_ASSERT(stream_state
);
1279 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
);
1280 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
;
1281 BT_ASSERT(stream_state
->packet
);
1282 stream_state
->packet
= NULL
;
1285 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1287 const struct bt_message_stream_activity
*stream_act_msg
=
1289 struct auto_seek_stream_state
*stream_state
;
1291 /* Update stream's state: stream activity ended. */
1292 stream_state
= g_hash_table_lookup(stream_states
, stream_act_msg
->stream
);
1293 BT_ASSERT(stream_state
);
1295 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
);
1296 stream_state
->state
= AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
;
1297 BT_ASSERT(!stream_state
->packet
);
1300 case BT_MESSAGE_TYPE_STREAM_END
:
1302 const struct bt_message_stream
*stream_msg
= (const void *) msg
;
1303 struct auto_seek_stream_state
*stream_state
;
1305 stream_state
= g_hash_table_lookup(stream_states
, stream_msg
->stream
);
1306 BT_ASSERT(stream_state
);
1307 BT_ASSERT(stream_state
->state
== AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
);
1308 BT_ASSERT(!stream_state
->packet
);
1310 /* Update stream's state: this stream doesn't exist anymore. */
1311 g_hash_table_remove(stream_states
, stream_msg
->stream
);
1318 bt_object_put_no_null_check(msg
);
1323 g_queue_push_tail(iterator
->auto_seek
.msgs
, (void *) msg
);
1327 BT_ASSERT(!msg
|| status
!= BT_MESSAGE_ITERATOR_STATUS_OK
);
1332 enum bt_message_iterator_status
find_message_ge_ns_from_origin(
1333 struct bt_self_component_port_input_message_iterator
*iterator
,
1334 int64_t ns_from_origin
, GHashTable
*stream_states
)
1337 enum bt_self_component_port_input_message_iterator_state init_state
=
1339 const struct bt_message
*messages
[MSG_BATCH_SIZE
];
1340 uint64_t user_count
= 0;
1342 bool got_first
= false;
1344 BT_ASSERT(iterator
);
1345 memset(&messages
[0], 0, sizeof(messages
[0]) * MSG_BATCH_SIZE
);
1348 * Make this iterator temporarily active (not seeking) to call
1349 * the "next" method.
1351 set_self_comp_port_input_msg_iterator_state(iterator
,
1352 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1354 BT_ASSERT(iterator
->methods
.next
);
1356 while (!got_first
) {
1358 * Call the user's "next" method to get the next
1359 * messages and status.
1361 BT_LOGD_STR("Calling user's \"next\" method.");
1362 status
= iterator
->methods
.next(iterator
,
1363 &messages
[0], MSG_BATCH_SIZE
, &user_count
);
1364 BT_LOGD("User method returned: status=%s",
1365 bt_message_iterator_status_string(status
));
1368 * The user's "next" method must not do any action which
1369 * would change the iterator's state.
1371 BT_ASSERT(iterator
->state
==
1372 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1375 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1376 BT_ASSERT_PRE(user_count
<= MSG_BATCH_SIZE
,
1377 "Invalid returned message count: greater than "
1378 "batch size: count=%" PRIu64
", batch-size=%u",
1379 user_count
, MSG_BATCH_SIZE
);
1381 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1382 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1383 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1384 case BT_MESSAGE_ITERATOR_STATUS_END
:
1390 for (i
= 0; i
< user_count
; i
++) {
1392 g_queue_push_tail(iterator
->auto_seek
.msgs
,
1393 (void *) messages
[i
]);
1398 status
= auto_seek_handle_message(iterator
,
1399 ns_from_origin
, messages
[i
], &got_first
,
1401 if (status
== BT_MESSAGE_ITERATOR_STATUS_OK
) {
1402 /* Message was either pushed or moved */
1411 for (i
= 0; i
< user_count
; i
++) {
1413 bt_object_put_no_null_check(messages
[i
]);
1417 set_self_comp_port_input_msg_iterator_state(iterator
, init_state
);
1422 * This function is installed as the iterator's next callback after we have
1423 * auto-seeked (seeked to the beginning and fast-forwarded) to send the
1424 * messages saved in iterator->auto_seek.msgs. Once this is done, the original
1425 * next callback is put back.
1429 enum bt_self_message_iterator_status
post_auto_seek_next(
1430 struct bt_self_component_port_input_message_iterator
*iterator
,
1431 bt_message_array_const msgs
, uint64_t capacity
,
1434 BT_ASSERT(!g_queue_is_empty(iterator
->auto_seek
.msgs
));
1438 * Move auto-seek messages to the output array (which is this
1439 * iterator's base message array).
1441 while (capacity
> 0 && !g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1442 msgs
[*count
] = g_queue_pop_head(iterator
->auto_seek
.msgs
);
1447 BT_ASSERT(*count
> 0);
1449 if (g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1450 /* No more auto-seek messages, restore user's next callback. */
1451 BT_ASSERT(iterator
->auto_seek
.original_next_callback
);
1452 iterator
->methods
.next
= iterator
->auto_seek
.original_next_callback
;
1453 iterator
->auto_seek
.original_next_callback
= NULL
;
1456 return BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
1460 int clock_raw_value_from_ns_from_origin(const bt_clock_class
*clock_class
,
1461 int64_t ns_from_origin
, uint64_t *raw_value
)
1464 int64_t cc_offset_s
= clock_class
->offset_seconds
;
1465 uint64_t cc_offset_cycles
= clock_class
->offset_cycles
;
1466 uint64_t cc_freq
= clock_class
->frequency
;
1468 return bt_common_clock_value_from_ns_from_origin(cc_offset_s
,
1469 cc_offset_cycles
, cc_freq
, ns_from_origin
, raw_value
);
1473 enum bt_message_iterator_status
1474 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1475 struct bt_self_component_port_input_message_iterator
*iterator
,
1476 int64_t ns_from_origin
)
1479 GHashTable
*stream_states
= NULL
;
1481 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1482 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1484 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1485 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1486 "Graph is not configured: %!+g",
1487 bt_component_borrow_graph(iterator
->upstream_component
));
1489 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1490 iterator
, ns_from_origin
),
1491 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1492 "ns-from-origin=%" PRId64
, iterator
, ns_from_origin
);
1493 set_self_comp_port_input_msg_iterator_state(iterator
,
1494 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1496 if (iterator
->methods
.seek_ns_from_origin
) {
1497 /* The iterator knows how to seek to a particular time, let it handle this. */
1498 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1499 "%![iter-]+i, ns=%" PRId64
, iterator
, ns_from_origin
);
1500 status
= iterator
->methods
.seek_ns_from_origin(iterator
,
1502 BT_LOGD("User method returned: status=%s",
1503 bt_message_iterator_status_string(status
));
1504 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1505 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1506 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1507 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1508 "Unexpected status: %![iter-]+i, status=%s",
1510 bt_common_self_message_iterator_status_string(status
));
1513 * The iterator doesn't know how to seek to a particular time. We will
1514 * seek to the beginning and fast forward to the right place.
1516 BT_ASSERT(iterator
->methods
.can_seek_beginning(iterator
));
1517 BT_ASSERT(iterator
->methods
.seek_beginning
);
1518 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1520 status
= iterator
->methods
.seek_beginning(iterator
);
1521 BT_LOGD("User method returned: status=%s",
1522 bt_message_iterator_status_string(status
));
1523 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1524 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1525 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1526 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1527 "Unexpected status: %![iter-]+i, status=%s",
1529 bt_common_self_message_iterator_status_string(status
));
1531 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1533 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1534 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1535 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1542 * Find the first message which has a default clock
1543 * snapshot greater than or equal to the requested
1544 * seeking time, and move the received messages from
1545 * this point in the batch to this iterator's auto-seek
1548 while (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1549 bt_object_put_no_null_check(
1550 g_queue_pop_tail(iterator
->auto_seek
.msgs
));
1553 stream_states
= create_auto_seek_stream_states();
1554 if (!stream_states
) {
1555 BT_LOGE_STR("Failed to allocate one GHashTable.");
1556 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1560 status
= find_message_ge_ns_from_origin(iterator
,
1561 ns_from_origin
, stream_states
);
1563 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1564 case BT_MESSAGE_ITERATOR_STATUS_END
:
1566 GHashTableIter iter
;
1567 gpointer key
, value
;
1570 * If some streams exist at the seek time, prepend the
1571 * required messages to put those streams in the right
1574 g_hash_table_iter_init(&iter
, stream_states
);
1575 while (g_hash_table_iter_next (&iter
, &key
, &value
)) {
1576 const bt_stream
*stream
= key
;
1577 struct auto_seek_stream_state
*stream_state
=
1578 (struct auto_seek_stream_state
*) value
;
1580 const bt_clock_class
*clock_class
= bt_stream_class_borrow_default_clock_class_const(
1581 bt_stream_borrow_class_const(stream
));
1584 if (clock_raw_value_from_ns_from_origin(clock_class
, ns_from_origin
, &raw_value
) != 0) {
1585 BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64
", %![cc-]+K",
1586 ns_from_origin
, clock_class
);
1587 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1591 switch (stream_state
->state
) {
1592 case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN
:
1593 BT_ASSERT(stream_state
->packet
);
1594 BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state
->packet
);
1595 msg
= bt_message_packet_beginning_create_with_default_clock_snapshot(
1596 (bt_self_message_iterator
*) iterator
, stream_state
->packet
, raw_value
);
1598 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1602 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1605 case AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN
:
1606 msg
= bt_message_stream_activity_beginning_create(
1607 (bt_self_message_iterator
*) iterator
, stream
);
1609 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1613 bt_message_stream_activity_beginning_set_default_clock_snapshot(msg
, raw_value
);
1615 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1618 case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN
:
1619 msg
= bt_message_stream_beginning_create(
1620 (bt_self_message_iterator
*) iterator
, stream
);
1622 status
= BT_MESSAGE_ITERATOR_STATUS_NOMEM
;
1626 g_queue_push_head(iterator
->auto_seek
.msgs
, msg
);
1633 * If there are messages in the auto-seek
1634 * message queue, replace the user's "next"
1635 * method with a custom, temporary "next" method
1636 * which returns them.
1638 if (!g_queue_is_empty(iterator
->auto_seek
.msgs
)) {
1639 BT_ASSERT(!iterator
->auto_seek
.original_next_callback
);
1640 iterator
->auto_seek
.original_next_callback
= iterator
->methods
.next
;
1642 iterator
->methods
.next
=
1643 (bt_self_component_port_input_message_iterator_next_method
)
1644 post_auto_seek_next
;
1648 * `BT_MESSAGE_ITERATOR_STATUS_END` becomes
1649 * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next
1650 * time this iterator's "next" method is called,
1652 * `BT_MESSAGE_ITERATOR_STATUS_END`.
1654 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1657 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1658 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1659 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1667 if (stream_states
) {
1668 destroy_auto_seek_stream_states(stream_states
);
1669 stream_states
= NULL
;
1671 set_iterator_state_after_seeking(iterator
, status
);
1676 bt_self_component_port_input_message_iterator
*
1677 borrow_output_port_message_iterator_upstream_iterator(
1678 struct bt_port_output_message_iterator
*iterator
)
1680 struct bt_component_class_sink_colander_priv_data
*colander_data
;
1682 BT_ASSERT(iterator
);
1683 colander_data
= (void *) iterator
->colander
->parent
.user_data
;
1684 BT_ASSERT(colander_data
);
1685 BT_ASSERT(colander_data
->msg_iter
);
1686 return colander_data
->msg_iter
;
1689 bt_bool
bt_port_output_message_iterator_can_seek_ns_from_origin(
1690 struct bt_port_output_message_iterator
*iterator
,
1691 int64_t ns_from_origin
)
1693 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1694 return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1695 borrow_output_port_message_iterator_upstream_iterator(
1696 iterator
), ns_from_origin
);
1699 bt_bool
bt_port_output_message_iterator_can_seek_beginning(
1700 struct bt_port_output_message_iterator
*iterator
)
1702 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1703 return bt_self_component_port_input_message_iterator_can_seek_beginning(
1704 borrow_output_port_message_iterator_upstream_iterator(
1708 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_ns_from_origin(
1709 struct bt_port_output_message_iterator
*iterator
,
1710 int64_t ns_from_origin
)
1712 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1713 return bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1714 borrow_output_port_message_iterator_upstream_iterator(iterator
),
1718 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_beginning(
1719 struct bt_port_output_message_iterator
*iterator
)
1721 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1722 return bt_self_component_port_input_message_iterator_seek_beginning(
1723 borrow_output_port_message_iterator_upstream_iterator(
1727 void bt_port_output_message_iterator_get_ref(
1728 const struct bt_port_output_message_iterator
*iterator
)
1730 bt_object_get_ref(iterator
);
1733 void bt_port_output_message_iterator_put_ref(
1734 const struct bt_port_output_message_iterator
*iterator
)
1736 bt_object_put_ref(iterator
);
1739 void bt_self_component_port_input_message_iterator_get_ref(
1740 const struct bt_self_component_port_input_message_iterator
*iterator
)
1742 bt_object_get_ref(iterator
);
1745 void bt_self_component_port_input_message_iterator_put_ref(
1746 const struct bt_self_component_port_input_message_iterator
*iterator
)
1748 bt_object_put_ref(iterator
);