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 "MSG-ITER"
25 #include <babeltrace/lib-logging-internal.h>
27 #include <babeltrace/compiler-internal.h>
28 #include <babeltrace/trace-ir/clock-class-internal.h>
29 #include <babeltrace/trace-ir/clock-snapshot-internal.h>
30 #include <babeltrace/trace-ir/field.h>
31 #include <babeltrace/trace-ir/event-const.h>
32 #include <babeltrace/trace-ir/event-internal.h>
33 #include <babeltrace/trace-ir/packet-const.h>
34 #include <babeltrace/trace-ir/packet-internal.h>
35 #include <babeltrace/trace-ir/stream-internal.h>
36 #include <babeltrace/graph/connection-const.h>
37 #include <babeltrace/graph/connection-internal.h>
38 #include <babeltrace/graph/component-const.h>
39 #include <babeltrace/graph/component-internal.h>
40 #include <babeltrace/graph/component-source-internal.h>
41 #include <babeltrace/graph/component-class-internal.h>
42 #include <babeltrace/graph/component-class-sink-colander-internal.h>
43 #include <babeltrace/graph/component-sink-const.h>
44 #include <babeltrace/graph/component-sink-internal.h>
45 #include <babeltrace/graph/message-const.h>
46 #include <babeltrace/graph/message-iterator-const.h>
47 #include <babeltrace/graph/message-iterator-internal.h>
48 #include <babeltrace/graph/self-component-port-input-message-iterator.h>
49 #include <babeltrace/graph/port-output-message-iterator.h>
50 #include <babeltrace/graph/message-internal.h>
51 #include <babeltrace/graph/message-event-const.h>
52 #include <babeltrace/graph/message-event-internal.h>
53 #include <babeltrace/graph/message-packet-beginning-const.h>
54 #include <babeltrace/graph/message-packet-end-const.h>
55 #include <babeltrace/graph/message-packet-internal.h>
56 #include <babeltrace/graph/message-stream-beginning-const.h>
57 #include <babeltrace/graph/message-stream-end-const.h>
58 #include <babeltrace/graph/message-stream-internal.h>
59 #include <babeltrace/graph/message-message-iterator-inactivity-internal.h>
60 #include <babeltrace/graph/message-discarded-items-internal.h>
61 #include <babeltrace/graph/message-stream-activity-internal.h>
62 #include <babeltrace/graph/port-const.h>
63 #include <babeltrace/graph/graph.h>
64 #include <babeltrace/graph/graph-const.h>
65 #include <babeltrace/graph/graph-internal.h>
66 #include <babeltrace/types.h>
67 #include <babeltrace/assert-internal.h>
68 #include <babeltrace/assert-pre-internal.h>
74 * TODO: Use graph's state (number of active iterators, etc.) and
75 * possibly system specifications to make a better guess than this.
77 #define MSG_BATCH_SIZE 15
79 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \
80 BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \
81 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \
82 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \
83 (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \
84 "Message iterator is in the wrong state: %!+i", _iter)
88 void _set_self_comp_port_input_msg_iterator_state(
89 struct bt_self_component_port_input_message_iterator
*iterator
,
90 enum bt_self_component_port_input_message_iterator_state state
)
93 BT_LIB_LOGD("Updating message iterator's state: new-state=%s",
94 bt_self_component_port_input_message_iterator_state_string(state
));
95 iterator
->state
= state
;
99 # define set_self_comp_port_input_msg_iterator_state _set_self_comp_port_input_msg_iterator_state
101 # define set_self_comp_port_input_msg_iterator_state(_a, _b) ((void) _a); ((void) _b);
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_LOGD("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_LOGV("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_LOGD("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_LOGD("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_LOGD("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_LOGV("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", iterator
);
555 * Call the user's "next" method to get the next messages
558 BT_ASSERT(iterator
->methods
.next
);
559 BT_LOGD_STR("Calling user's \"next\" method.");
560 status
= iterator
->methods
.next(iterator
,
561 (void *) iterator
->base
.msgs
->pdata
, MSG_BATCH_SIZE
,
563 BT_LOGD("User method returned: status=%s",
564 bt_message_iterator_status_string(status
));
566 BT_LOGW_STR("User method failed.");
572 * There is no way that this iterator could have been finalized
573 * during its "next" method, as the only way to do this is to
574 * put the last iterator's reference, and this can only be done
575 * by its downstream owner.
577 * For the same reason, there is no way that this iterator could
578 * have seeked (cannot seek a self message iterator).
580 BT_ASSERT(iterator
->state
==
581 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_LOGD("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_LOGD("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
;
754 /* Hope that nobody uses this very unique name */
756 bt_graph_add_sink_component_with_init_method_data(
757 (void *) graph
, colander_comp_cls
,
758 "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
759 NULL
, &colander_data
, (void *) &iterator
->colander
);
760 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
761 BT_LIB_LOGW("Cannot add colander sink component to graph: "
762 "%1[graph-]+g, status=%s", graph
,
763 bt_graph_status_string(graph_status
));
768 * Connect provided output port to the colander component's
772 (void *) bt_component_sink_borrow_input_port_by_index_const(
773 (void *) iterator
->colander
, 0);
774 BT_ASSERT(colander_in_port
);
775 graph_status
= bt_graph_connect_ports(graph
,
776 output_port
, colander_in_port
, NULL
);
777 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
778 BT_LIB_LOGW("Cannot add colander sink component to graph: "
779 "%![graph-]+g, %![comp-]+c, status=%s", graph
,
781 bt_graph_status_string(graph_status
));
786 * At this point everything went fine. Make the graph
787 * nonconsumable forever so that only this message iterator
788 * can consume (thanks to bt_graph_consume_sink_no_check()).
789 * This avoids leaking the message created by the colander
790 * sink and moved to the message iterator's message
793 bt_graph_set_can_consume(iterator
->graph
, false);
795 /* Also set the graph as being configured. */
796 graph_status
= bt_graph_configure(graph
);
797 if (graph_status
!= BT_GRAPH_STATUS_OK
) {
798 BT_LIB_LOGW("Cannot configure graph after having added colander: "
799 "%![graph-]+g, status=%s", graph
,
800 bt_graph_status_string(graph_status
));
806 if (iterator
&& iterator
->graph
&& iterator
->colander
) {
809 /* Remove created colander component from graph if any */
810 colander_comp
= iterator
->colander
;
811 BT_OBJECT_PUT_REF_AND_RESET(iterator
->colander
);
814 * At this point the colander component's reference
815 * count is 0 because iterator->colander was the only
816 * owner. We also know that it is not connected because
817 * this is the last operation before this function
820 * Since we honor the preconditions here,
821 * bt_graph_remove_unconnected_component() always
824 ret
= bt_graph_remove_unconnected_component(iterator
->graph
,
825 (void *) colander_comp
);
829 BT_OBJECT_PUT_REF_AND_RESET(iterator
);
832 bt_object_put_ref(colander_comp_cls
);
833 return (void *) iterator
;
836 bt_bool
bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
837 struct bt_self_component_port_input_message_iterator
*iterator
,
838 int64_t ns_from_origin
)
840 bt_bool can
= BT_FALSE
;
842 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
843 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
845 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
846 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
847 "Graph is not configured: %!+g",
848 bt_component_borrow_graph(iterator
->upstream_component
));
850 if (iterator
->methods
.can_seek_ns_from_origin
) {
851 can
= iterator
->methods
.can_seek_ns_from_origin(iterator
,
857 * Automatic seeking fall back: if we can seek to the beginning,
858 * then we can automatically seek to any message.
860 if (iterator
->methods
.can_seek_beginning
) {
861 can
= iterator
->methods
.can_seek_beginning(iterator
);
868 bt_bool
bt_self_component_port_input_message_iterator_can_seek_beginning(
869 struct bt_self_component_port_input_message_iterator
*iterator
)
871 bt_bool can
= BT_FALSE
;
873 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
874 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
876 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
877 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
878 "Graph is not configured: %!+g",
879 bt_component_borrow_graph(iterator
->upstream_component
));
881 if (iterator
->methods
.can_seek_beginning
) {
882 can
= iterator
->methods
.can_seek_beginning(iterator
);
890 void _set_iterator_state_after_seeking(
891 struct bt_self_component_port_input_message_iterator
*iterator
,
892 enum bt_message_iterator_status status
)
894 enum bt_self_component_port_input_message_iterator_state new_state
= 0;
896 /* Set iterator's state depending on seeking status */
898 case BT_MESSAGE_ITERATOR_STATUS_OK
:
899 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
;
901 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
902 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN
;
904 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
905 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
906 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR
;
908 case BT_MESSAGE_ITERATOR_STATUS_END
:
909 new_state
= BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED
;
915 set_self_comp_port_input_msg_iterator_state(iterator
, new_state
);
919 # define set_iterator_state_after_seeking _set_iterator_state_after_seeking
921 # define set_iterator_state_after_seeking(_iter, _status) ((void) _iter); ((void) _status);
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
);
958 enum bt_message_iterator_status
auto_seek_handle_message(
959 struct bt_self_component_port_input_message_iterator
*iterator
,
960 int64_t ns_from_origin
, const struct bt_message
*msg
,
963 enum bt_message_iterator_status status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
964 int64_t msg_ns_from_origin
;
965 const struct bt_clock_snapshot
*clk_snapshot
= NULL
;
969 BT_ASSERT(got_first
);
972 case BT_MESSAGE_TYPE_EVENT
:
974 const struct bt_message_event
*event_msg
=
977 clk_snapshot
= event_msg
->default_cs
;
978 BT_ASSERT_PRE(clk_snapshot
,
979 "Event message has no default clock snapshot: %!+n",
983 case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY
:
985 const struct bt_message_message_iterator_inactivity
*inactivity_msg
=
988 clk_snapshot
= inactivity_msg
->default_cs
;
989 BT_ASSERT(clk_snapshot
);
992 case BT_MESSAGE_TYPE_PACKET_BEGINNING
:
993 case BT_MESSAGE_TYPE_PACKET_END
:
995 const struct bt_message_packet
*packet_msg
=
998 clk_snapshot
= packet_msg
->default_cs
;
999 BT_ASSERT_PRE(clk_snapshot
,
1000 "Packet message has no default clock snapshot: %!+n",
1004 case BT_MESSAGE_TYPE_DISCARDED_EVENTS
:
1005 case BT_MESSAGE_TYPE_DISCARDED_PACKETS
:
1007 struct bt_message_discarded_items
*msg_disc_items
=
1010 BT_ASSERT_PRE(msg_disc_items
->default_begin_cs
&&
1011 msg_disc_items
->default_end_cs
,
1012 "Discarded events/packets message has no default clock snapshots: %!+n",
1014 ret
= bt_clock_snapshot_get_ns_from_origin(
1015 msg_disc_items
->default_begin_cs
,
1016 &msg_ns_from_origin
);
1018 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1022 if (msg_ns_from_origin
>= ns_from_origin
) {
1027 ret
= bt_clock_snapshot_get_ns_from_origin(
1028 msg_disc_items
->default_end_cs
,
1029 &msg_ns_from_origin
);
1031 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1035 if (msg_ns_from_origin
>= ns_from_origin
) {
1037 * The discarded items message's beginning time
1038 * is before the requested seeking time, but its
1039 * end time is after. Modify the message so as
1040 * to set its beginning time to the requested
1041 * seeking time, and make its item count unknown
1042 * as we don't know if items were really
1043 * discarded within the new time range.
1045 uint64_t new_begin_raw_value
;
1047 ret
= bt_clock_class_clock_value_from_ns_from_origin(
1048 msg_disc_items
->default_end_cs
->clock_class
,
1049 ns_from_origin
, &new_begin_raw_value
);
1051 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1055 bt_clock_snapshot_set_raw_value(
1056 msg_disc_items
->default_begin_cs
,
1057 new_begin_raw_value
);
1058 msg_disc_items
->count
.base
.avail
=
1059 BT_PROPERTY_AVAILABILITY_NOT_AVAILABLE
;
1062 * It is safe to push it because its beginning
1063 * time is exactly the requested seeking time.
1070 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING
:
1072 const struct bt_message_stream_activity
*stream_act_msg
=
1075 switch (stream_act_msg
->default_cs_state
) {
1076 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1077 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1079 * -inf is always less than any requested time,
1080 * and we can't assume any specific time for an
1081 * unknown clock snapshot, so skip this.
1084 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1085 clk_snapshot
= stream_act_msg
->default_cs
;
1086 BT_ASSERT(clk_snapshot
);
1094 case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END
:
1096 const struct bt_message_stream_activity
*stream_act_msg
=
1099 switch (stream_act_msg
->default_cs_state
) {
1100 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN
:
1102 * We can't assume any specific time for an
1103 * unknown clock snapshot, so skip this.
1106 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE
:
1108 * +inf is always greater than any requested
1113 case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN
:
1114 clk_snapshot
= stream_act_msg
->default_cs
;
1115 BT_ASSERT(clk_snapshot
);
1123 case BT_MESSAGE_TYPE_STREAM_BEGINNING
:
1124 case BT_MESSAGE_TYPE_STREAM_END
:
1131 BT_ASSERT(clk_snapshot
);
1132 ret
= bt_clock_snapshot_get_ns_from_origin(clk_snapshot
,
1133 &msg_ns_from_origin
);
1135 status
= BT_MESSAGE_ITERATOR_STATUS_ERROR
;
1139 if (msg_ns_from_origin
>= ns_from_origin
) {
1145 bt_object_put_no_null_check(msg
);
1150 g_queue_push_head(iterator
->auto_seek_msgs
, (void *) msg
);
1154 BT_ASSERT(!msg
|| status
!= BT_MESSAGE_ITERATOR_STATUS_OK
);
1159 enum bt_message_iterator_status
find_message_ge_ns_from_origin(
1160 struct bt_self_component_port_input_message_iterator
*iterator
,
1161 int64_t ns_from_origin
)
1164 enum bt_self_component_port_input_message_iterator_state init_state
=
1166 const struct bt_message
*messages
[MSG_BATCH_SIZE
];
1167 uint64_t user_count
= 0;
1169 bool got_first
= false;
1171 BT_ASSERT(iterator
);
1172 memset(&messages
[0], 0, sizeof(messages
[0]) * MSG_BATCH_SIZE
);
1175 * Make this iterator temporarily active (not seeking) to call
1176 * the "next" method.
1178 set_self_comp_port_input_msg_iterator_state(iterator
,
1179 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1181 BT_ASSERT(iterator
->methods
.next
);
1183 while (!got_first
) {
1185 * Call the user's "next" method to get the next
1186 * messages and status.
1188 BT_LOGD_STR("Calling user's \"next\" method.");
1189 status
= iterator
->methods
.next(iterator
,
1190 &messages
[0], MSG_BATCH_SIZE
, &user_count
);
1191 BT_LOGD("User method returned: status=%s",
1192 bt_message_iterator_status_string(status
));
1196 * The user's "next" method must not do any action which
1197 * would change the iterator's state.
1199 BT_ASSERT(iterator
->state
==
1200 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE
);
1204 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1205 BT_ASSERT_PRE(user_count
<= MSG_BATCH_SIZE
,
1206 "Invalid returned message count: greater than "
1207 "batch size: count=%" PRIu64
", batch-size=%u",
1208 user_count
, MSG_BATCH_SIZE
);
1210 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1211 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1212 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1213 case BT_MESSAGE_ITERATOR_STATUS_END
:
1219 for (i
= 0; i
< user_count
; i
++) {
1221 g_queue_push_head(iterator
->auto_seek_msgs
,
1222 (void *) messages
[i
]);
1227 status
= auto_seek_handle_message(iterator
,
1228 ns_from_origin
, messages
[i
], &got_first
);
1229 if (status
== BT_MESSAGE_ITERATOR_STATUS_OK
) {
1230 /* Message was either pushed or moved */
1239 for (i
= 0; i
< user_count
; i
++) {
1241 bt_object_put_no_null_check(messages
[i
]);
1245 set_self_comp_port_input_msg_iterator_state(iterator
, init_state
);
1250 enum bt_self_message_iterator_status
post_auto_seek_next(
1251 struct bt_self_component_port_input_message_iterator
*iterator
,
1252 bt_message_array_const msgs
, uint64_t capacity
,
1255 BT_ASSERT(!g_queue_is_empty(iterator
->auto_seek_msgs
));
1259 * Move auto-seek messages to the output array (which is this
1260 * iterator's base message array).
1262 while (capacity
> 0 && !g_queue_is_empty(iterator
->auto_seek_msgs
)) {
1263 msgs
[*count
] = g_queue_pop_tail(iterator
->auto_seek_msgs
);
1268 BT_ASSERT(*count
> 0);
1270 if (g_queue_is_empty(iterator
->auto_seek_msgs
)) {
1271 /* No more auto-seek messages */
1272 switch (iterator
->upstream_component
->class->type
) {
1273 case BT_COMPONENT_CLASS_TYPE_SOURCE
:
1275 struct bt_component_class_source
*src_comp_cls
=
1276 (void *) iterator
->upstream_component
->class;
1278 iterator
->methods
.next
=
1279 (bt_self_component_port_input_message_iterator_next_method
)
1280 src_comp_cls
->methods
.msg_iter_next
;
1283 case BT_COMPONENT_CLASS_TYPE_FILTER
:
1285 struct bt_component_class_filter
*flt_comp_cls
=
1286 (void *) iterator
->upstream_component
->class;
1288 iterator
->methods
.next
=
1289 (bt_self_component_port_input_message_iterator_next_method
)
1290 flt_comp_cls
->methods
.msg_iter_next
;
1298 return BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
1301 enum bt_message_iterator_status
1302 bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1303 struct bt_self_component_port_input_message_iterator
*iterator
,
1304 int64_t ns_from_origin
)
1308 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1309 BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator
);
1311 bt_component_borrow_graph(iterator
->upstream_component
)->config_state
!=
1312 BT_GRAPH_CONFIGURATION_STATE_CONFIGURING
,
1313 "Graph is not configured: %!+g",
1314 bt_component_borrow_graph(iterator
->upstream_component
));
1316 bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1317 iterator
, ns_from_origin
),
1318 "Message iterator cannot seek nanoseconds from origin: %!+i, "
1319 "ns-from-origin=%" PRId64
, iterator
, ns_from_origin
);
1320 set_self_comp_port_input_msg_iterator_state(iterator
,
1321 BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING
);
1323 if (iterator
->methods
.seek_ns_from_origin
) {
1324 BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
1325 "%![iter-]+i, ns=%" PRId64
, iterator
, ns_from_origin
);
1326 status
= iterator
->methods
.seek_ns_from_origin(iterator
,
1328 BT_LOGD("User method returned: status=%s",
1329 bt_message_iterator_status_string(status
));
1330 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1331 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1332 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1333 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1334 "Unexpected status: %![iter-]+i, status=%s",
1336 bt_common_self_message_iterator_status_string(status
));
1338 /* Start automatic seeking: seek beginning first */
1339 BT_ASSERT(iterator
->methods
.can_seek_beginning(iterator
));
1340 BT_ASSERT(iterator
->methods
.seek_beginning
);
1341 BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
1343 status
= iterator
->methods
.seek_beginning(iterator
);
1344 BT_LOGD("User method returned: status=%s",
1345 bt_message_iterator_status_string(status
));
1346 BT_ASSERT_PRE(status
== BT_MESSAGE_ITERATOR_STATUS_OK
||
1347 status
== BT_MESSAGE_ITERATOR_STATUS_ERROR
||
1348 status
== BT_MESSAGE_ITERATOR_STATUS_NOMEM
||
1349 status
== BT_MESSAGE_ITERATOR_STATUS_AGAIN
,
1350 "Unexpected status: %![iter-]+i, status=%s",
1352 bt_common_self_message_iterator_status_string(status
));
1354 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1356 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1357 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1358 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1365 * Find the first message which has a default clock
1366 * snapshot greater than or equal to the requested
1367 * seeking time, and move the received messages from
1368 * this point in the batch to this iterator's auto-seek
1371 while (!g_queue_is_empty(iterator
->auto_seek_msgs
)) {
1372 bt_object_put_no_null_check(
1373 g_queue_pop_tail(iterator
->auto_seek_msgs
));
1376 status
= find_message_ge_ns_from_origin(iterator
,
1379 case BT_MESSAGE_ITERATOR_STATUS_OK
:
1380 case BT_MESSAGE_ITERATOR_STATUS_END
:
1382 * If there are messages in the auto-seek
1383 * message queue, replace the user's "next"
1384 * method with a custom, temporary "next" method
1385 * which returns them.
1387 if (!g_queue_is_empty(iterator
->auto_seek_msgs
)) {
1388 iterator
->methods
.next
=
1389 (bt_self_component_port_input_message_iterator_next_method
)
1390 post_auto_seek_next
;
1394 * `BT_MESSAGE_ITERATOR_STATUS_END` becomes
1395 * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next
1396 * time this iterator's "next" method is called,
1398 * `BT_MESSAGE_ITERATOR_STATUS_END`.
1400 status
= BT_MESSAGE_ITERATOR_STATUS_OK
;
1402 case BT_MESSAGE_ITERATOR_STATUS_ERROR
:
1403 case BT_MESSAGE_ITERATOR_STATUS_NOMEM
:
1404 case BT_MESSAGE_ITERATOR_STATUS_AGAIN
:
1412 set_iterator_state_after_seeking(iterator
, status
);
1417 bt_self_component_port_input_message_iterator
*
1418 borrow_output_port_message_iterator_upstream_iterator(
1419 struct bt_port_output_message_iterator
*iterator
)
1421 struct bt_component_class_sink_colander_priv_data
*colander_data
;
1423 BT_ASSERT(iterator
);
1424 colander_data
= (void *) iterator
->colander
->parent
.user_data
;
1425 BT_ASSERT(colander_data
);
1426 BT_ASSERT(colander_data
->msg_iter
);
1427 return colander_data
->msg_iter
;
1430 bt_bool
bt_port_output_message_iterator_can_seek_ns_from_origin(
1431 struct bt_port_output_message_iterator
*iterator
,
1432 int64_t ns_from_origin
)
1434 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1435 return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
1436 borrow_output_port_message_iterator_upstream_iterator(
1437 iterator
), ns_from_origin
);
1440 bt_bool
bt_port_output_message_iterator_can_seek_beginning(
1441 struct bt_port_output_message_iterator
*iterator
)
1443 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1444 return bt_self_component_port_input_message_iterator_can_seek_beginning(
1445 borrow_output_port_message_iterator_upstream_iterator(
1449 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_ns_from_origin(
1450 struct bt_port_output_message_iterator
*iterator
,
1451 int64_t ns_from_origin
)
1453 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1454 return bt_self_component_port_input_message_iterator_seek_ns_from_origin(
1455 borrow_output_port_message_iterator_upstream_iterator(iterator
),
1459 enum bt_message_iterator_status
bt_port_output_message_iterator_seek_beginning(
1460 struct bt_port_output_message_iterator
*iterator
)
1462 BT_ASSERT_PRE_NON_NULL(iterator
, "Message iterator");
1463 return bt_self_component_port_input_message_iterator_seek_beginning(
1464 borrow_output_port_message_iterator_upstream_iterator(
1468 void bt_port_output_message_iterator_get_ref(
1469 const struct bt_port_output_message_iterator
*iterator
)
1471 bt_object_get_ref(iterator
);
1474 void bt_port_output_message_iterator_put_ref(
1475 const struct bt_port_output_message_iterator
*iterator
)
1477 bt_object_put_ref(iterator
);
1480 void bt_self_component_port_input_message_iterator_get_ref(
1481 const struct bt_self_component_port_input_message_iterator
*iterator
)
1483 bt_object_get_ref(iterator
);
1486 void bt_self_component_port_input_message_iterator_put_ref(
1487 const struct bt_self_component_port_input_message_iterator
*iterator
)
1489 bt_object_put_ref(iterator
);