X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fiterator.c;h=39746df3dcac71fa3f9779b96a87f9fb363be792;hb=217fd08c67b8c038176241aef4bb658297d8beae;hp=2e2ab405667e684768928df02cffff6b3d3ec67a;hpb=870631a2db01676b476dbee615aade0a22926bcd;p=babeltrace.git diff --git a/src/lib/graph/iterator.c b/src/lib/graph/iterator.c index 2e2ab405..39746df3 100644 --- a/src/lib/graph/iterator.c +++ b/src/lib/graph/iterator.c @@ -1,24 +1,8 @@ /* + * SPDX-License-Identifier: MIT + * * Copyright 2017-2018 Philippe Proulx * Copyright 2015 Jérémie Galarneau - * - * Permission is hereby granted, free of charge, to any person obtaining a copy - * of this software and associated documentation files (the "Software"), to deal - * in the Software without restriction, including without limitation the rights - * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - * copies of the Software, and to permit persons to whom the Software is - * furnished to do so, subject to the following conditions: - * - * The above copyright notice and this permission notice shall be included in - * all copies or substantial portions of the Software. - * - * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - * SOFTWARE. */ #define BT_LOG_TAG "LIB/MSG-ITER" @@ -29,58 +13,42 @@ #include "lib/trace-ir/clock-class.h" #include "lib/trace-ir/clock-snapshot.h" #include -#include +#include #include "lib/trace-ir/event.h" -#include +#include #include "lib/trace-ir/packet.h" #include "lib/trace-ir/stream.h" -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include +#include "lib/trace-ir/stream-class.h" +#include +#include +#include +#include +#include +#include +#include +#include #include -#include +#include #include #include "common/assert.h" -#include "lib/assert-pre.h" -#include "lib/assert-post.h" +#include "lib/assert-cond.h" #include #include +#include #include #include "component-class.h" -#include "component-class-sink-colander.h" #include "component.h" -#include "component-sink.h" -#include "component-source.h" #include "connection.h" #include "graph.h" +#include "iterator.h" +#include "message-iterator-class.h" #include "message/discarded-items.h" #include "message/event.h" -#include "message/iterator.h" #include "message/message.h" #include "message/message-iterator-inactivity.h" #include "message/stream.h" #include "message/packet.h" -#include "message/stream-activity.h" #include "lib/func-status.h" /* @@ -90,42 +58,47 @@ #define MSG_BATCH_SIZE 15 #define BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(_iter) \ - BT_ASSERT_PRE((_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE || \ - (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED || \ - (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \ - (_iter)->state == BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \ - "Message iterator is in the wrong state: %!+i", _iter) + BT_ASSERT_PRE("has-state-to-seek", \ + (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE || \ + (_iter)->state == BT_MESSAGE_ITERATOR_STATE_ENDED || \ + (_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN || \ + (_iter)->state == BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR, \ + "Message iterator is in the wrong state: %!+i", (_iter)) + +#ifdef BT_DEV_MODE +struct per_stream_state +{ + bt_packet *cur_packet; -static inline -void set_self_comp_port_input_msg_iterator_state( - struct bt_self_component_port_input_message_iterator *iterator, - enum bt_self_component_port_input_message_iterator_state state) + /* Bit mask of expected message types. */ + guint expected_msg_types; +}; +#endif + +static void +clear_per_stream_state (struct bt_message_iterator *iterator) { - BT_ASSERT(iterator); - BT_LIB_LOGD("Updating message iterator's state: new-state=%s", - bt_self_component_port_input_message_iterator_state_string(state)); - iterator->state = state; +#ifdef BT_DEV_MODE + g_hash_table_remove_all(iterator->per_stream_state); +#else + BT_USE_EXPR(iterator); +#endif } -static -void destroy_base_message_iterator(struct bt_object *obj) +static inline +void set_msg_iterator_state(struct bt_message_iterator *iterator, + enum bt_message_iterator_state state) { - struct bt_message_iterator *iterator = (void *) obj; - - BT_ASSERT(iterator); - - if (iterator->msgs) { - g_ptr_array_free(iterator->msgs, TRUE); - iterator->msgs = NULL; - } - - g_free(iterator); + BT_ASSERT_DBG(iterator); + BT_LIB_LOGD("Updating message iterator's state: new-state=%s", + bt_message_iterator_state_string(state)); + iterator->state = state; } static -void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj) +void bt_message_iterator_destroy(struct bt_object *obj) { - struct bt_self_component_port_input_message_iterator *iterator; + struct bt_message_iterator *iterator; BT_ASSERT(obj); @@ -144,7 +117,13 @@ void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj iterator = (void *) obj; BT_LIB_LOGI("Destroying self component input port message iterator object: " "%!+i", iterator); - bt_self_component_port_input_message_iterator_try_finalize(iterator); + bt_message_iterator_try_finalize(iterator); + + if (iterator->clock_expectation.type == + CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID) { + BT_CLOCK_CLASS_PUT_REF_AND_RESET( + iterator->clock_expectation.clock_class); + } if (iterator->connection) { /* @@ -158,7 +137,7 @@ void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj if (iterator->auto_seek.msgs) { while (!g_queue_is_empty(iterator->auto_seek.msgs)) { - bt_object_put_no_null_check( + bt_object_put_ref_no_null_check( g_queue_pop_tail(iterator->auto_seek.msgs)); } @@ -166,88 +145,131 @@ void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj iterator->auto_seek.msgs = NULL; } - destroy_base_message_iterator(obj); + if (iterator->upstream_msg_iters) { + /* + * At this point the message iterator is finalized, so + * it's detached from any upstream message iterator. + */ + BT_ASSERT(iterator->upstream_msg_iters->len == 0); + g_ptr_array_free(iterator->upstream_msg_iters, TRUE); + iterator->upstream_msg_iters = NULL; + } + + if (iterator->msgs) { + g_ptr_array_free(iterator->msgs, TRUE); + iterator->msgs = NULL; + } + +#ifdef BT_DEV_MODE + g_hash_table_destroy(iterator->per_stream_state); +#endif + + g_free(iterator); } -BT_HIDDEN -void bt_self_component_port_input_message_iterator_try_finalize( - struct bt_self_component_port_input_message_iterator *iterator) +void bt_message_iterator_try_finalize( + struct bt_message_iterator *iterator) { - typedef void (*method_t)(void *); - - struct bt_component_class *comp_class = NULL; - method_t method = NULL; + uint64_t i; + bool call_user_finalize = true; BT_ASSERT(iterator); switch (iterator->state) { - case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED: - /* Skip user finalization if user initialization failed */ - BT_LIB_LOGD("Not finalizing non-initialized message iterator: " - "%!+i", iterator); - goto end; - case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED: + case BT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED: + /* + * If this function is called while the iterator is in the + * NON_INITIALIZED state, it means the user initialization + * method has either not been called, or has failed. We + * therefore don't want to call the user finalization method. + * However, the initialization method might have created some + * upstream message iterators before failing, so we want to + * execute the rest of this function, which unlinks the related + * iterators. + */ + call_user_finalize = false; + break; + case BT_MESSAGE_ITERATOR_STATE_FINALIZED: /* Already finalized */ BT_LIB_LOGD("Not finalizing message iterator: already finalized: " "%!+i", iterator); goto end; - case BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING: + case BT_MESSAGE_ITERATOR_STATE_FINALIZING: /* Finalizing */ BT_LIB_LOGF("Message iterator is already being finalized: " "%!+i", iterator); - abort(); + bt_common_abort(); default: break; } BT_LIB_LOGD("Finalizing message iterator: %!+i", iterator); - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZING); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_FINALIZING); BT_ASSERT(iterator->upstream_component); - comp_class = iterator->upstream_component->class; /* Call user-defined destroy method */ - switch (comp_class->type) { - case BT_COMPONENT_CLASS_TYPE_SOURCE: - { - struct bt_component_class_source *src_comp_cls = - (void *) comp_class; - - method = (method_t) src_comp_cls->methods.msg_iter_finalize; - break; + if (call_user_finalize) { + typedef void (*method_t)(void *); + method_t method; + struct bt_component_class *comp_class = + iterator->upstream_component->class; + struct bt_component_class_with_iterator_class *class_with_iter_class; + + BT_ASSERT(bt_component_class_has_message_iterator_class(comp_class)); + class_with_iter_class = container_of(comp_class, + struct bt_component_class_with_iterator_class, parent); + method = (method_t) class_with_iter_class->msg_iter_cls->methods.finalize; + + if (method) { + const bt_error *saved_error; + + saved_error = bt_current_thread_take_error(); + + BT_LIB_LOGD("Calling user's finalization method: %!+i", + iterator); + method(iterator); + BT_ASSERT_POST_NO_ERROR("bt_message_iterator_class_finalize_method"); + + if (saved_error) { + BT_CURRENT_THREAD_MOVE_ERROR_AND_RESET(saved_error); + } + } } - case BT_COMPONENT_CLASS_TYPE_FILTER: - { - struct bt_component_class_filter *flt_comp_cls = - (void *) comp_class; - method = (method_t) flt_comp_cls->methods.msg_iter_finalize; - break; - } - default: - /* Unreachable */ - abort(); + /* Detach upstream message iterators */ + for (i = 0; i < iterator->upstream_msg_iters->len; i++) { + struct bt_message_iterator *upstream_msg_iter = + iterator->upstream_msg_iters->pdata[i]; + + upstream_msg_iter->downstream_msg_iter = NULL; } - if (method) { - BT_LIB_LOGD("Calling user's finalization method: %!+i", + g_ptr_array_set_size(iterator->upstream_msg_iters, 0); + + /* Detach downstream message iterator */ + if (iterator->downstream_msg_iter) { + gboolean existed; + + BT_ASSERT(iterator->downstream_msg_iter->upstream_msg_iters); + existed = g_ptr_array_remove_fast( + iterator->downstream_msg_iter->upstream_msg_iters, iterator); - method(iterator); + BT_ASSERT(existed); } iterator->upstream_component = NULL; iterator->upstream_port = NULL; - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_FINALIZED); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_FINALIZED); BT_LIB_LOGD("Finalized message iterator: %!+i", iterator); end: return; } -BT_HIDDEN -void bt_self_component_port_input_message_iterator_set_connection( - struct bt_self_component_port_input_message_iterator *iterator, +void bt_message_iterator_set_connection( + struct bt_message_iterator *iterator, struct bt_connection *connection) { BT_ASSERT(iterator); @@ -257,304 +279,294 @@ void bt_self_component_port_input_message_iterator_set_connection( } static -int init_message_iterator(struct bt_message_iterator *iterator, - enum bt_message_iterator_type type, - bt_object_release_func destroy) +enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true( + struct bt_message_iterator *iterator __attribute__((unused)), + int64_t ns_from_origin __attribute__((unused)), + bt_bool *can_seek) { - int ret = 0; - - bt_object_init_shared(&iterator->base, destroy); - iterator->type = type; - iterator->msgs = g_ptr_array_new(); - if (!iterator->msgs) { - BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); - ret = -1; - goto end; - } - - g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE); + *can_seek = BT_TRUE; -end: - return ret; + return BT_FUNC_STATUS_OK; } static -bt_bool can_seek_ns_from_origin_true( - struct bt_self_component_port_input_message_iterator *iterator, - int64_t ns_from_origin) +enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true( + struct bt_message_iterator *iterator __attribute__((unused)), + bt_bool *can_seek) { - return BT_TRUE; -} + *can_seek = BT_TRUE; -static -bt_bool can_seek_beginning_true( - struct bt_self_component_port_input_message_iterator *iterator) -{ - return BT_TRUE; + return BT_FUNC_STATUS_OK; } static -struct bt_self_component_port_input_message_iterator * -bt_self_component_port_input_message_iterator_create_initial( - struct bt_component *upstream_comp, - struct bt_port *upstream_port) +int create_self_component_input_port_message_iterator( + struct bt_self_message_iterator *self_downstream_msg_iter, + struct bt_self_component_port_input *self_port, + struct bt_message_iterator **message_iterator, + const char *api_func) { - int ret; - struct bt_self_component_port_input_message_iterator *iterator = NULL; + bt_message_iterator_class_initialize_method init_method = NULL; + struct bt_message_iterator *iterator = + NULL; + struct bt_message_iterator *downstream_msg_iter = + (void *) self_downstream_msg_iter; + struct bt_port *port = (void *) self_port; + struct bt_port *upstream_port; + struct bt_component *comp; + struct bt_component *upstream_comp; + struct bt_component_class *upstream_comp_cls; + struct bt_component_class_with_iterator_class *upstream_comp_cls_with_iter_cls; + int status; - BT_ASSERT(upstream_comp); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "message-iterator-output", + message_iterator, "Created message iterator (output)"); + BT_ASSERT_PRE_NON_NULL_FROM_FUNC(api_func, "input-port", port, + "Input port"); + comp = bt_port_borrow_component_inline(port); + BT_ASSERT_PRE_FROM_FUNC(api_func, "input-port-is-connected", + bt_port_is_connected(port), + "Input port is not connected: %![port-]+p", port); + BT_ASSERT_PRE_FROM_FUNC(api_func, "input-port-has-component", + comp, "Input port is not part of a component: %![port-]+p", + port); + BT_ASSERT(port->connection); + upstream_port = port->connection->upstream_port; BT_ASSERT(upstream_port); - BT_ASSERT(bt_port_is_connected(upstream_port)); - BT_LIB_LOGI("Creating initial message iterator on self component input port: " - "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port); - BT_ASSERT(bt_component_get_class_type(upstream_comp) == + upstream_comp = bt_port_borrow_component_inline(upstream_port); + BT_ASSERT(upstream_comp); + BT_ASSERT_PRE_FROM_FUNC(api_func, "graph-is-configured", + bt_component_borrow_graph(upstream_comp)->config_state == + BT_GRAPH_CONFIGURATION_STATE_PARTIALLY_CONFIGURED || + bt_component_borrow_graph(upstream_comp)->config_state == + BT_GRAPH_CONFIGURATION_STATE_CONFIGURED, + "Graph is not configured: %!+g", + bt_component_borrow_graph(upstream_comp)); + upstream_comp_cls = upstream_comp->class; + BT_ASSERT(upstream_comp->class->type == BT_COMPONENT_CLASS_TYPE_SOURCE || - bt_component_get_class_type(upstream_comp) == + upstream_comp->class->type == BT_COMPONENT_CLASS_TYPE_FILTER); + BT_LIB_LOGI("Creating message iterator on self component input port: " + "%![up-comp-]+c, %![up-port-]+p", upstream_comp, upstream_port); iterator = g_new0( - struct bt_self_component_port_input_message_iterator, 1); + struct bt_message_iterator, 1); if (!iterator) { BT_LIB_LOGE_APPEND_CAUSE( "Failed to allocate one self component input port " "message iterator."); + status = BT_FUNC_STATUS_MEMORY_ERROR; goto error; } - ret = init_message_iterator((void *) iterator, - BT_MESSAGE_ITERATOR_TYPE_SELF_COMPONENT_PORT_INPUT, - bt_self_component_port_input_message_iterator_destroy); - if (ret) { - /* init_message_iterator() logs errors */ + bt_object_init_shared(&iterator->base, + bt_message_iterator_destroy); + iterator->msgs = g_ptr_array_new(); + if (!iterator->msgs) { + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); + status = BT_FUNC_STATUS_MEMORY_ERROR; goto error; } + g_ptr_array_set_size(iterator->msgs, MSG_BATCH_SIZE); iterator->last_ns_from_origin = INT64_MIN; +#ifdef BT_DEV_MODE + /* The per-stream state is only used for dev assertions right now. */ + iterator->per_stream_state = g_hash_table_new_full( + g_direct_hash, + g_direct_equal, + NULL, + g_free); +#endif + iterator->auto_seek.msgs = g_queue_new(); if (!iterator->auto_seek.msgs) { BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue."); - ret = -1; - goto end; + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto error; + } + + iterator->upstream_msg_iters = g_ptr_array_new(); + if (!iterator->upstream_msg_iters) { + BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); + status = BT_FUNC_STATUS_MEMORY_ERROR; + goto error; } iterator->upstream_component = upstream_comp; iterator->upstream_port = upstream_port; iterator->connection = iterator->upstream_port->connection; iterator->graph = bt_component_borrow_graph(upstream_comp); - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED); - - switch (iterator->upstream_component->class->type) { - case BT_COMPONENT_CLASS_TYPE_SOURCE: - { - struct bt_component_class_source *src_comp_cls = - (void *) iterator->upstream_component->class; - - iterator->methods.next = - (bt_self_component_port_input_message_iterator_next_method) - src_comp_cls->methods.msg_iter_next; - iterator->methods.seek_ns_from_origin = - (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method) - src_comp_cls->methods.msg_iter_seek_ns_from_origin; - iterator->methods.seek_beginning = - (bt_self_component_port_input_message_iterator_seek_beginning_method) - src_comp_cls->methods.msg_iter_seek_beginning; - iterator->methods.can_seek_ns_from_origin = - (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method) - src_comp_cls->methods.msg_iter_can_seek_ns_from_origin; - iterator->methods.can_seek_beginning = - (bt_self_component_port_input_message_iterator_can_seek_beginning_method) - src_comp_cls->methods.msg_iter_can_seek_beginning; - break; - } - case BT_COMPONENT_CLASS_TYPE_FILTER: - { - struct bt_component_class_filter *flt_comp_cls = - (void *) iterator->upstream_component->class; - - iterator->methods.next = - (bt_self_component_port_input_message_iterator_next_method) - flt_comp_cls->methods.msg_iter_next; - iterator->methods.seek_ns_from_origin = - (bt_self_component_port_input_message_iterator_seek_ns_from_origin_method) - flt_comp_cls->methods.msg_iter_seek_ns_from_origin; - iterator->methods.seek_beginning = - (bt_self_component_port_input_message_iterator_seek_beginning_method) - flt_comp_cls->methods.msg_iter_seek_beginning; - iterator->methods.can_seek_ns_from_origin = - (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method) - flt_comp_cls->methods.msg_iter_can_seek_ns_from_origin; - iterator->methods.can_seek_beginning = - (bt_self_component_port_input_message_iterator_can_seek_beginning_method) - flt_comp_cls->methods.msg_iter_can_seek_beginning; - break; - } - default: - abort(); - } + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_NON_INITIALIZED); + + /* Copy methods from the message iterator class to the message iterator. */ + BT_ASSERT(bt_component_class_has_message_iterator_class(upstream_comp_cls)); + upstream_comp_cls_with_iter_cls = container_of(upstream_comp_cls, + struct bt_component_class_with_iterator_class, parent); + + iterator->methods.next = + (bt_message_iterator_next_method) + upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.next; + iterator->methods.seek_ns_from_origin = + (bt_message_iterator_seek_ns_from_origin_method) + upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.seek_ns_from_origin; + iterator->methods.seek_beginning = + (bt_message_iterator_seek_beginning_method) + upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.seek_beginning; + iterator->methods.can_seek_ns_from_origin = + (bt_message_iterator_can_seek_ns_from_origin_method) + upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.can_seek_ns_from_origin; + iterator->methods.can_seek_beginning = + (bt_message_iterator_can_seek_beginning_method) + upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.can_seek_beginning; if (iterator->methods.seek_ns_from_origin && !iterator->methods.can_seek_ns_from_origin) { iterator->methods.can_seek_ns_from_origin = - (bt_self_component_port_input_message_iterator_can_seek_ns_from_origin_method) + (bt_message_iterator_can_seek_ns_from_origin_method) can_seek_ns_from_origin_true; } if (iterator->methods.seek_beginning && !iterator->methods.can_seek_beginning) { iterator->methods.can_seek_beginning = - (bt_self_component_port_input_message_iterator_seek_beginning_method) + (bt_message_iterator_can_seek_beginning_method) can_seek_beginning_true; } - BT_LIB_LOGI("Created initial message iterator on self component input port: " - "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i", - upstream_port, upstream_comp, iterator); - goto end; - -error: - BT_OBJECT_PUT_REF_AND_RESET(iterator); - -end: - return iterator; -} - -struct bt_self_component_port_input_message_iterator * -bt_self_component_port_input_message_iterator_create( - struct bt_self_component_port_input *self_port) -{ - typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t)( - void *, void *, void *); - - init_method_t init_method = NULL; - struct bt_self_component_port_input_message_iterator *iterator = - NULL; - struct bt_port *port = (void *) self_port; - struct bt_port *upstream_port; - struct bt_component *comp; - struct bt_component *upstream_comp; - struct bt_component_class *upstream_comp_cls; - - BT_ASSERT_PRE_NON_NULL(port, "Port"); - comp = bt_port_borrow_component_inline(port); - BT_ASSERT_PRE(bt_port_is_connected(port), - "Port is not connected: %![port-]+p", port); - BT_ASSERT_PRE(comp, "Port is not part of a component: %![port-]+p", - port); - BT_ASSERT_PRE(!bt_component_graph_is_canceled(comp), - "Port's component's graph is canceled: " - "%![port-]+p, %![comp-]+c", port, comp); - BT_ASSERT(port->connection); - upstream_port = port->connection->upstream_port; - BT_ASSERT(upstream_port); - upstream_comp = bt_port_borrow_component_inline(upstream_port); - BT_ASSERT(upstream_comp); - BT_ASSERT_PRE( - bt_component_borrow_graph(upstream_comp)->config_state != - BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, - "Graph is not configured: %!+g", - bt_component_borrow_graph(upstream_comp)); - upstream_comp_cls = upstream_comp->class; - BT_ASSERT(upstream_comp->class->type == - BT_COMPONENT_CLASS_TYPE_SOURCE || - upstream_comp->class->type == - BT_COMPONENT_CLASS_TYPE_FILTER); - iterator = bt_self_component_port_input_message_iterator_create_initial( - upstream_comp, upstream_port); - if (!iterator) { - BT_LIB_LOGE_APPEND_CAUSE( - "Cannot create self component input port message iterator."); - goto error; - } - - switch (upstream_comp_cls->type) { - case BT_COMPONENT_CLASS_TYPE_SOURCE: - { - struct bt_component_class_source *src_comp_cls = - (void *) upstream_comp_cls; - - init_method = - (init_method_t) src_comp_cls->methods.msg_iter_init; - break; - } - case BT_COMPONENT_CLASS_TYPE_FILTER: - { - struct bt_component_class_filter *flt_comp_cls = - (void *) upstream_comp_cls; - - init_method = - (init_method_t) flt_comp_cls->methods.msg_iter_init; - break; - } - default: - /* Unreachable */ - abort(); - } + /* Call iterator's init method. */ + init_method = upstream_comp_cls_with_iter_cls->msg_iter_cls->methods.initialize; if (init_method) { - enum bt_component_class_message_iterator_init_method_status iter_status; + enum bt_message_iterator_class_initialize_method_status iter_status; BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator); - iter_status = init_method(iterator, upstream_comp, - upstream_port); + iter_status = init_method( + (struct bt_self_message_iterator *) iterator, + &iterator->config, + (struct bt_self_component_port_output *) upstream_port); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(iter_status)); + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS( + "bt_message_iterator_class_initialize_method", + iter_status); if (iter_status != BT_FUNC_STATUS_OK) { BT_LIB_LOGW_APPEND_CAUSE( "Component input port message iterator initialization method failed: " "%![iter-]+i, status=%s", iterator, bt_common_func_status_string(iter_status)); + status = iter_status; goto error; } + + iterator->config.frozen = true; + } + + if (downstream_msg_iter) { + /* Set this message iterator's downstream message iterator */ + iterator->downstream_msg_iter = downstream_msg_iter; + + /* + * Add this message iterator to the downstream message + * iterator's array of upstream message iterators. + */ + g_ptr_array_add(downstream_msg_iter->upstream_msg_iters, + iterator); } - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_ACTIVE); g_ptr_array_add(port->connection->iterators, iterator); BT_LIB_LOGI("Created message iterator on self component input port: " "%![up-port-]+p, %![up-comp-]+c, %![iter-]+i", upstream_port, upstream_comp, iterator); + + *message_iterator = iterator; + status = BT_FUNC_STATUS_OK; goto end; error: BT_OBJECT_PUT_REF_AND_RESET(iterator); end: - return iterator; + return status; +} + +BT_EXPORT +bt_message_iterator_create_from_message_iterator_status +bt_message_iterator_create_from_message_iterator( + struct bt_self_message_iterator *self_msg_iter, + struct bt_self_component_port_input *input_port, + struct bt_message_iterator **message_iterator) +{ + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(self_msg_iter); + return create_self_component_input_port_message_iterator(self_msg_iter, + input_port, message_iterator, __func__); +} + +BT_EXPORT +bt_message_iterator_create_from_sink_component_status +bt_message_iterator_create_from_sink_component( + struct bt_self_component_sink *self_comp, + struct bt_self_component_port_input *input_port, + struct bt_message_iterator **message_iterator) +{ + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_NON_NULL("sink-component", self_comp, "Sink component"); + return create_self_component_input_port_message_iterator(NULL, + input_port, message_iterator, __func__); } +BT_EXPORT void *bt_self_message_iterator_get_data( const struct bt_self_message_iterator *self_iterator) { - struct bt_self_component_port_input_message_iterator *iterator = + struct bt_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return iterator->user_data; } +BT_EXPORT void bt_self_message_iterator_set_data( struct bt_self_message_iterator *self_iterator, void *data) { - struct bt_self_component_port_input_message_iterator *iterator = + struct bt_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); iterator->user_data = data; BT_LIB_LOGD("Set message iterator's user data: " "%!+i, user-data-addr=%p", iterator, data); } +BT_EXPORT +void bt_self_message_iterator_configuration_set_can_seek_forward( + bt_self_message_iterator_configuration *config, + bt_bool can_seek_forward) +{ + BT_ASSERT_PRE_NON_NULL("message-iterator-configuration", config, + "Message iterator configuration"); + BT_ASSERT_PRE_DEV_HOT("message-iterator-configuration", config, + "Message iterator configuration", ""); + + config->can_seek_forward = can_seek_forward; +} + /* * Validate that the default clock snapshot in `msg` doesn't make us go back in * time. */ -BT_ASSERT_POST_FUNC +BT_ASSERT_COND_DEV_FUNC static bool clock_snapshots_are_monotonic_one( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, const bt_message *msg) { const struct bt_clock_snapshot *clock_snapshot = NULL; @@ -579,7 +591,7 @@ bool clock_snapshots_are_monotonic_one( { struct bt_message_message_iterator_inactivity *inactivity_msg = (struct bt_message_message_iterator_inactivity *) msg; - clock_snapshot = inactivity_msg->default_cs; + clock_snapshot = inactivity_msg->cs; break; } case BT_MESSAGE_TYPE_PACKET_BEGINNING: @@ -589,21 +601,17 @@ bool clock_snapshots_are_monotonic_one( clock_snapshot = packet_msg->default_cs; break; } - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + case BT_MESSAGE_TYPE_STREAM_END: { - struct bt_message_stream_activity *str_act_msg = - (struct bt_message_stream_activity *) msg; - - if (str_act_msg->default_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN) { - clock_snapshot = str_act_msg->default_cs; + struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg; + if (stream_msg->default_cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { + goto end; } + + clock_snapshot = stream_msg->default_cs; break; } - case BT_MESSAGE_TYPE_STREAM_BEGINNING: - case BT_MESSAGE_TYPE_STREAM_END: - /* These messages don't have clock snapshots. */ - goto end; case BT_MESSAGE_TYPE_DISCARDED_EVENTS: case BT_MESSAGE_TYPE_DISCARDED_PACKETS: { @@ -619,8 +627,15 @@ bool clock_snapshots_are_monotonic_one( goto end; } - clock_snapshot_status = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, &ns_from_origin); + clock_snapshot_status = bt_clock_snapshot_get_ns_from_origin( + clock_snapshot, &ns_from_origin); if (clock_snapshot_status != BT_FUNC_STATUS_OK) { + /* + * bt_clock_snapshot_get_ns_from_origin can return + * OVERFLOW_ERROR. We don't really want to report an error to + * our caller, so just clear it. + */ + bt_current_thread_clear_error(); goto end; } @@ -630,10 +645,10 @@ end: return result; } -BT_ASSERT_POST_FUNC +BT_ASSERT_COND_DEV_FUNC static bool clock_snapshots_are_monotonic( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, bt_message_array_const msgs, uint64_t msg_count) { uint64_t i; @@ -652,18 +667,21 @@ end: return result; } +#define NEXT_METHOD_NAME "bt_message_iterator_class_next_method" + +#ifdef BT_DEV_MODE + /* * When a new stream begins, verify that the clock class tied to this * stream is compatible with what we've seen before. */ -BT_ASSERT_POST_FUNC static -bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator *iterator, +void assert_post_dev_clock_classes_are_compatible_one( + struct bt_message_iterator *iterator, const struct bt_message *msg) { enum bt_message_type message_type = bt_message_get_type(msg); - bool result; if (message_type == BT_MESSAGE_TYPE_STREAM_BEGINNING) { const struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg; @@ -689,118 +707,419 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_UNIX; } else if (clock_class_uuid) { iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_UUID; - memcpy(iterator->clock_expectation.uuid, clock_class_uuid, BABELTRACE_UUID_LEN); + bt_uuid_copy(iterator->clock_expectation.uuid, clock_class_uuid); } else { iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID; + iterator->clock_expectation.clock_class = clock_class; + bt_clock_class_get_ref(iterator->clock_expectation.clock_class); } break; case CLOCK_EXPECTATION_NONE: - if (clock_class) { - BT_ASSERT_POST_MSG("Expecting no clock class, got one: %![cc-]+K", - clock_class); - result = false; - goto end; - } - + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "stream-class-has-no-clock-class", !clock_class, + "Expecting no clock class, got one: %![cc-]+K", + clock_class); break; case CLOCK_EXPECTATION_ORIGIN_UNIX: - if (!clock_class) { - BT_ASSERT_POST_MSG("Expecting a clock class, got none."); - result = false; - goto end; - } - - if (!bt_clock_class_origin_is_unix_epoch(clock_class)) { - BT_ASSERT_POST_MSG("Expecting a clock class with Unix epoch origin: %![cc-]+K", - clock_class); - result = false; - goto end; - } + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "stream-class-has-clock-class-with-unix-epoch-origin", clock_class, + "Expecting a clock class with Unix epoch origin, got none."); + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "clock-class-has-unix-epoch-origin", + bt_clock_class_origin_is_unix_epoch(clock_class), + "Expecting a clock class with Unix epoch origin: %![cc-]+K", + clock_class); break; case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID: - if (!clock_class) { - BT_ASSERT_POST_MSG("Expecting a clock class, got none."); - result = false; - goto end; - } - - if (bt_clock_class_origin_is_unix_epoch(clock_class)) { - BT_ASSERT_POST_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K", - clock_class); - result = false; - goto end; - } - - if (!clock_class_uuid) { - BT_ASSERT_POST_MSG("Expecting a clock class with UUID: %![cc-]+K", - clock_class); - result = false; - goto end; - } - - if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) { - BT_ASSERT_POST_MSG("Expecting a clock class with UUID, got one " + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "stream-class-has-clock-class-with-uuid", clock_class, + "Expecting a clock class with UUID, got none."); + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "clock-class-has-non-unix-epoch-origin", + !bt_clock_class_origin_is_unix_epoch(clock_class), + "Expecting a clock class without Unix epoch origin: %![cc-]+K", + clock_class); + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "clock-class-has-uuid", + clock_class_uuid, + "Expecting a clock class with UUID, got one without UUID: %![cc-]+K", + clock_class); + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "clock-class-has-expected-uuid", + !bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid), + "Expecting a clock class with UUID, got one " "with a different UUID: %![cc-]+K, expected-uuid=%!u", clock_class, iterator->clock_expectation.uuid); - result = false; - goto end; - } break; case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID: - if (!clock_class) { - BT_ASSERT_POST_MSG("Expecting a clock class, got none."); - result = false; - goto end; + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "stream-class-has-clock-class", clock_class, + "Expecting a clock class, got none."); + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "clock-class-is-expected", + clock_class == iterator->clock_expectation.clock_class, + "Expecting clock class %![cc-]+K, got %![cc-]+K.", + iterator->clock_expectation.clock_class, + clock_class); + break; + } + } +} + +static +void assert_post_dev_clock_classes_are_compatible( + struct bt_message_iterator *iterator, + bt_message_array_const msgs, uint64_t msg_count) +{ + uint64_t i; + + for (i = 0; i < msg_count; i++) { + assert_post_dev_clock_classes_are_compatible_one(iterator, msgs[i]); + } +} + +static +const bt_stream *get_stream_from_msg(const struct bt_message *msg) +{ + struct bt_stream *stream; + + switch (msg->type) { + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + case BT_MESSAGE_TYPE_STREAM_END: + { + struct bt_message_stream *msg_stream = + (struct bt_message_stream *) msg; + stream = msg_stream->stream; + break; + } + case BT_MESSAGE_TYPE_EVENT: + { + struct bt_message_event *msg_event = + (struct bt_message_event *) msg; + stream = msg_event->event->stream; + break; + } + case BT_MESSAGE_TYPE_PACKET_BEGINNING: + case BT_MESSAGE_TYPE_PACKET_END: + { + struct bt_message_packet *msg_packet = + (struct bt_message_packet *) msg; + stream = msg_packet->packet->stream; + break; + } + case BT_MESSAGE_TYPE_DISCARDED_EVENTS: + case BT_MESSAGE_TYPE_DISCARDED_PACKETS: + { + struct bt_message_discarded_items *msg_discarded = + (struct bt_message_discarded_items *) msg; + stream = msg_discarded->stream; + break; + } + case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: + stream = NULL; + break; + default: + bt_common_abort(); + } + + return stream; +} + +static +GString *message_types_to_string(guint msg_types) +{ + GString *str = g_string_new(""); + + for (int msg_type = 1; msg_type <= BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY; + msg_type <<= 1) { + if (msg_type & msg_types) { + if (str->len > 0) { + g_string_append_c(str, '|'); } - if (bt_clock_class_origin_is_unix_epoch(clock_class)) { - BT_ASSERT_POST_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K", - clock_class); - result = false; - goto end; + g_string_append(str, + bt_common_message_type_string(msg_type)); + } + } + + return str; +} + +static +void update_expected_msg_type(const struct bt_stream *stream, + struct per_stream_state *state, + const struct bt_message *msg) +{ + switch (msg->type) { + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + state->expected_msg_types = BT_MESSAGE_TYPE_STREAM_END; + + if (stream->class->supports_packets) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_PACKET_BEGINNING; + + if (stream->class->supports_discarded_packets) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_PACKETS; } + } else { + state->expected_msg_types |= BT_MESSAGE_TYPE_EVENT; + } - if (clock_class_uuid) { - BT_ASSERT_POST_MSG("Expecting a clock class without UUID: %![cc-]+K", - clock_class); - result = false; - goto end; + if (stream->class->supports_discarded_events) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_EVENTS; + } + + break; + case BT_MESSAGE_TYPE_STREAM_END: + state->expected_msg_types = 0; + break; + case BT_MESSAGE_TYPE_EVENT: + { + state->expected_msg_types = BT_MESSAGE_TYPE_EVENT; + + if (stream->class->supports_packets) { + state->expected_msg_types |= BT_MESSAGE_TYPE_PACKET_END; + } else { + state->expected_msg_types |= BT_MESSAGE_TYPE_STREAM_END; + } + + if (stream->class->supports_discarded_events) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_EVENTS; + } + + break; + } + case BT_MESSAGE_TYPE_PACKET_BEGINNING: + { + state->expected_msg_types = BT_MESSAGE_TYPE_EVENT | + BT_MESSAGE_TYPE_PACKET_END; + + if (stream->class->supports_discarded_events) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_EVENTS; + } + + break; + } + case BT_MESSAGE_TYPE_PACKET_END: + { + state->expected_msg_types = BT_MESSAGE_TYPE_PACKET_BEGINNING | + BT_MESSAGE_TYPE_STREAM_END; + + if (stream->class->supports_discarded_events) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_EVENTS; + } + + if (stream->class->supports_discarded_packets) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_PACKETS; + } + + break; + } + case BT_MESSAGE_TYPE_DISCARDED_EVENTS: + state->expected_msg_types = BT_MESSAGE_TYPE_DISCARDED_EVENTS; + + if (state->cur_packet) { + state->expected_msg_types |= BT_MESSAGE_TYPE_EVENT | + BT_MESSAGE_TYPE_PACKET_END; + } else { + state->expected_msg_types |= BT_MESSAGE_TYPE_STREAM_END; + + if (stream->class->supports_packets) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_PACKET_BEGINNING; + + if (stream->class->supports_discarded_packets) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_PACKETS; + } + } else { + state->expected_msg_types |= + BT_MESSAGE_TYPE_EVENT; } - break; } + + break; + case BT_MESSAGE_TYPE_DISCARDED_PACKETS: + state->expected_msg_types = BT_MESSAGE_TYPE_DISCARDED_PACKETS | + BT_MESSAGE_TYPE_PACKET_BEGINNING | + BT_MESSAGE_TYPE_STREAM_END; + + if (stream->class->supports_discarded_events) { + state->expected_msg_types |= + BT_MESSAGE_TYPE_DISCARDED_EVENTS; + } + break; + default: + /* + * Other message types are not associated to a stream, so we + * should not get them here. + */ + bt_common_abort(); + } +} + +static +struct per_stream_state *get_per_stream_state( + struct bt_message_iterator *iterator, + const struct bt_stream *stream) +{ + struct per_stream_state *state = g_hash_table_lookup( + iterator->per_stream_state, stream); + + if (!state) { + state = g_new0(struct per_stream_state, 1); + state->expected_msg_types = BT_MESSAGE_TYPE_STREAM_BEGINNING; + g_hash_table_insert(iterator->per_stream_state, + (gpointer) stream, state); } - result = true; + return state; +} + +static +void assert_post_dev_expected_sequence(struct bt_message_iterator *iterator, + const struct bt_message *msg) +{ + const bt_stream *stream = get_stream_from_msg(msg); + struct per_stream_state *state; + + if (!stream) { + goto end; + } + + state = get_per_stream_state(iterator, stream); + + /* + * We don't free the return value of message_types_to_string(), but + * that's because we know the program is going to abort anyway, and + * we don't want to call it if the assertion holds. + */ + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "message-type-is-expected", + msg->type & state->expected_msg_types, + "Unexpected message type: %![stream-]s, %![iterator-]i, " + "%![message-]n, expected-msg-types=%s", + stream, iterator, msg, + message_types_to_string(state->expected_msg_types)->str); + + update_expected_msg_type(stream, state, msg); end: - return result; + return; } -BT_ASSERT_POST_FUNC static -bool clock_classes_are_compatible( - struct bt_self_component_port_input_message_iterator *iterator, - bt_message_array_const msgs, uint64_t msg_count) +void assert_post_dev_expected_packet(struct bt_message_iterator *iterator, + const struct bt_message *msg) { - uint64_t i; - bool result; + const bt_stream *stream = get_stream_from_msg(msg); + struct per_stream_state *state; + const bt_packet *actual_packet = NULL; + const bt_packet *expected_packet = NULL; - for (i = 0; i < msg_count; i++) { - if (!clock_classes_are_compatible_one(iterator, msgs[i])) { - result = false; - goto end; - } + if (!stream) { + goto end; } - result = true; + state = get_per_stream_state(iterator, stream); + + switch (msg->type) { + case BT_MESSAGE_TYPE_EVENT: + { + const struct bt_message_event *msg_event = + (const struct bt_message_event *) msg; + + actual_packet = msg_event->event->packet; + expected_packet = state->cur_packet; + break; + } + case BT_MESSAGE_TYPE_PACKET_BEGINNING: + { + const struct bt_message_packet *msg_packet = + (const struct bt_message_packet *) msg; + + BT_ASSERT(!state->cur_packet); + state->cur_packet = msg_packet->packet; + break; + } + case BT_MESSAGE_TYPE_PACKET_END: + { + const struct bt_message_packet *msg_packet = + (const struct bt_message_packet *) msg; + + actual_packet = msg_packet->packet; + expected_packet = state->cur_packet; + BT_ASSERT(state->cur_packet); + state->cur_packet = NULL; + break; + } + default: + break; + } + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "message-packet-is-expected", + actual_packet == expected_packet, + "Message's packet is not expected: %![stream-]s, %![iterator-]i, " + "%![message-]n, %![received-packet-]a, %![expected-packet-]a", + stream, iterator, msg, actual_packet, expected_packet); end: - return result; + return; +} + +static +void assert_post_dev_next( + struct bt_message_iterator *iterator, + bt_message_iterator_class_next_method_status status, + bt_message_array_const msgs, uint64_t msg_count) +{ + if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_OK) { + uint64_t i; + + for (i = 0; i < msg_count; i++) { + assert_post_dev_expected_sequence(iterator, msgs[i]); + assert_post_dev_expected_packet(iterator, msgs[i]); + } + } else if (status == BT_MESSAGE_ITERATOR_CLASS_NEXT_METHOD_STATUS_END) { + GHashTableIter iter; + + gpointer stream_v, stream_state_v; + + g_hash_table_iter_init(&iter, iterator->per_stream_state); + while (g_hash_table_iter_next(&iter, &stream_v, + &stream_state_v)) { + struct bt_stream *stream = stream_v; + struct per_stream_state *stream_state = stream_state_v; + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "stream-is-ended", + stream_state->expected_msg_types == 0, + "Stream is not ended: %![stream-]s, " + "%![iterator-]i, expected-msg-types=%s", + stream, iterator, + message_types_to_string( + stream_state->expected_msg_types)->str); + } + + } } +#endif /* * Call the `next` method of the iterator. Do some validation on the returned @@ -808,46 +1127,61 @@ end: */ static -enum bt_component_class_message_iterator_next_method_status +enum bt_message_iterator_class_next_method_status call_iterator_next_method( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, bt_message_array_const msgs, uint64_t capacity, uint64_t *user_count) { - enum bt_component_class_message_iterator_next_method_status status; + enum bt_message_iterator_class_next_method_status status; - BT_ASSERT(iterator->methods.next); + BT_ASSERT_DBG(iterator->methods.next); BT_LOGD_STR("Calling user's \"next\" method."); status = iterator->methods.next(iterator, msgs, capacity, user_count); BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64, bt_common_func_status_string(status), *user_count); if (status == BT_FUNC_STATUS_OK) { - BT_ASSERT_POST(clock_classes_are_compatible(iterator, msgs, *user_count), - "Clocks are not compatible"); - BT_ASSERT_POST(clock_snapshots_are_monotonic(iterator, msgs, *user_count), + BT_IF_DEV_MODE(assert_post_dev_clock_classes_are_compatible( + iterator, msgs, *user_count)); + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "message-clock-snapshots-are-monotonic", + clock_snapshots_are_monotonic(iterator, msgs, + *user_count), "Clock snapshots are not monotonic"); } +#ifdef BT_DEV_MODE + assert_post_dev_next(iterator, status, msgs, *user_count); +#endif + + BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(NEXT_METHOD_NAME, + status); + return status; } +BT_EXPORT enum bt_message_iterator_next_status -bt_self_component_port_input_message_iterator_next( - struct bt_self_component_port_input_message_iterator *iterator, +bt_message_iterator_next( + struct bt_message_iterator *iterator, bt_message_array_const *msgs, uint64_t *user_count) { enum bt_message_iterator_next_status status = BT_FUNC_STATUS_OK; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - BT_ASSERT_PRE_NON_NULL(msgs, "Message array (output)"); - BT_ASSERT_PRE_NON_NULL(user_count, "Message count (output)"); - BT_ASSERT_PRE(iterator->state == - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE, + BT_ASSERT_PRE_DEV_NO_ERROR(); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); + BT_ASSERT_PRE_DEV_NON_NULL("message-array-output", msgs, + "Message array (output)"); + BT_ASSERT_PRE_DEV_NON_NULL("user-count-output", user_count, + "Message count (output)"); + BT_ASSERT_PRE_DEV("message-iterator-is-active", + iterator->state == BT_MESSAGE_ITERATOR_STATE_ACTIVE, "Message iterator's \"next\" called, but " "message iterator is in the wrong state: %!+i", iterator); - BT_ASSERT(iterator->upstream_component); - BT_ASSERT(iterator->upstream_component->class); - BT_ASSERT_PRE( + BT_ASSERT_DBG(iterator->upstream_component); + BT_ASSERT_DBG(iterator->upstream_component->class); + BT_ASSERT_PRE_DEV("graph-is-configured", bt_component_borrow_graph(iterator->upstream_component)->config_state != BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not configured: %!+g", @@ -862,7 +1196,7 @@ bt_self_component_port_input_message_iterator_next( */ *user_count = 0; status = (int) call_iterator_next_method(iterator, - (void *) iterator->base.msgs->pdata, MSG_BATCH_SIZE, + (void *) iterator->msgs->pdata, MSG_BATCH_SIZE, user_count); BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64, bt_common_func_status_string(status), *user_count); @@ -877,386 +1211,267 @@ bt_self_component_port_input_message_iterator_next( /* * There is no way that this iterator could have been finalized * during its "next" method, as the only way to do this is to - * put the last iterator's reference, and this can only be done - * by its downstream owner. - * - * For the same reason, there is no way that this iterator could - * have seeked (cannot seek a self message iterator). - */ - BT_ASSERT(iterator->state == - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); - - switch (status) { - case BT_FUNC_STATUS_OK: - BT_ASSERT_POST(*user_count <= MSG_BATCH_SIZE, - "Invalid returned message count: greater than " - "batch size: count=%" PRIu64 ", batch-size=%u", - *user_count, MSG_BATCH_SIZE); - *msgs = (void *) iterator->base.msgs->pdata; - break; - case BT_FUNC_STATUS_AGAIN: - goto end; - case BT_FUNC_STATUS_END: - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED); - goto end; - default: - /* Unknown non-error status */ - abort(); - } - -end: - return status; -} - -enum bt_message_iterator_next_status bt_port_output_message_iterator_next( - struct bt_port_output_message_iterator *iterator, - bt_message_array_const *msgs_to_user, - uint64_t *count_to_user) -{ - enum bt_message_iterator_next_status status; - int graph_status; - - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - BT_ASSERT_PRE_NON_NULL(msgs_to_user, "Message array (output)"); - BT_ASSERT_PRE_NON_NULL(count_to_user, "Message count (output)"); - BT_LIB_LOGD("Getting next output port message iterator's messages: " - "%!+i", iterator); - graph_status = bt_graph_consume_sink_no_check(iterator->graph, - iterator->colander); - switch (graph_status) { - case BT_FUNC_STATUS_CANCELED: - case BT_FUNC_STATUS_AGAIN: - case BT_FUNC_STATUS_END: - case BT_FUNC_STATUS_MEMORY_ERROR: - status = (int) graph_status; - break; - case BT_FUNC_STATUS_OK: - status = BT_FUNC_STATUS_OK; + * put the last iterator's reference, and this can only be done + * by its downstream owner. + * + * For the same reason, there is no way that this iterator could + * have sought (cannot seek a self message iterator). + */ + BT_ASSERT_DBG(iterator->state == + BT_MESSAGE_ITERATOR_STATE_ACTIVE); - /* - * On success, the colander sink moves the messages - * to this iterator's array and sets this iterator's - * message count: move them to the user. - */ - *msgs_to_user = (void *) iterator->base.msgs->pdata; - *count_to_user = iterator->count; + switch (status) { + case BT_FUNC_STATUS_OK: + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, "count-lteq-capacity", + *user_count <= MSG_BATCH_SIZE, + "Invalid returned message count: greater than " + "batch size: count=%" PRIu64 ", batch-size=%u", + *user_count, MSG_BATCH_SIZE); + *msgs = (void *) iterator->msgs->pdata; break; + case BT_FUNC_STATUS_AGAIN: + goto end; + case BT_FUNC_STATUS_END: + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_ENDED); + goto end; default: - /* Other errors */ - status = BT_FUNC_STATUS_ERROR; + /* Unknown non-error status */ + bt_common_abort(); } +end: return status; } +BT_EXPORT struct bt_component * -bt_self_component_port_input_message_iterator_borrow_component( - struct bt_self_component_port_input_message_iterator *iterator) -{ - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - return iterator->upstream_component; -} - -const struct bt_component * -bt_self_component_port_input_message_iterator_borrow_component_const( - const struct bt_self_component_port_input_message_iterator *iterator) +bt_message_iterator_borrow_component( + struct bt_message_iterator *iterator) { - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return iterator->upstream_component; } +BT_EXPORT struct bt_self_component *bt_self_message_iterator_borrow_component( struct bt_self_message_iterator *self_iterator) { - struct bt_self_component_port_input_message_iterator *iterator = + struct bt_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return (void *) iterator->upstream_component; } -struct bt_self_port_output *bt_self_message_iterator_borrow_port( +BT_EXPORT +struct bt_self_component_port_output *bt_self_message_iterator_borrow_port( struct bt_self_message_iterator *self_iterator) { - struct bt_self_component_port_input_message_iterator *iterator = + struct bt_message_iterator *iterator = (void *) self_iterator; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return (void *) iterator->upstream_port; } -static -void bt_port_output_message_iterator_destroy(struct bt_object *obj) -{ - struct bt_port_output_message_iterator *iterator = (void *) obj; - - BT_LIB_LOGI("Destroying output port message iterator object: %!+i", - iterator); - BT_LOGD_STR("Putting graph."); - BT_OBJECT_PUT_REF_AND_RESET(iterator->graph); - BT_LOGD_STR("Putting colander sink component."); - BT_OBJECT_PUT_REF_AND_RESET(iterator->colander); - destroy_base_message_iterator(obj); -} +#define CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME \ + "bt_message_iterator_class_can_seek_ns_from_origin_method" -struct bt_port_output_message_iterator * -bt_port_output_message_iterator_create(struct bt_graph *graph, - const struct bt_port_output *output_port) +BT_EXPORT +enum bt_message_iterator_can_seek_ns_from_origin_status +bt_message_iterator_can_seek_ns_from_origin( + struct bt_message_iterator *iterator, + int64_t ns_from_origin, bt_bool *can_seek) { - struct bt_port_output_message_iterator *iterator = NULL; - struct bt_component_class_sink *colander_comp_cls = NULL; - struct bt_component *output_port_comp = NULL; - struct bt_component_sink *colander_comp; - int graph_status; - struct bt_port_input *colander_in_port = NULL; - struct bt_component_class_sink_colander_data colander_data; - int ret; - - BT_ASSERT_PRE_NON_NULL(graph, "Graph"); - BT_ASSERT_PRE_NON_NULL(output_port, "Output port"); - output_port_comp = bt_port_borrow_component_inline( - (const void *) output_port); - BT_ASSERT_PRE(output_port_comp, - "Output port has no component: %!+p", output_port); - BT_ASSERT_PRE(bt_component_borrow_graph(output_port_comp) == - (void *) graph, - "Output port is not part of graph: %![graph-]+g, %![port-]+p", - graph, output_port); - BT_ASSERT_PRE(!graph->has_sink, - "Graph already has a sink component: %![graph-]+g"); - - /* Create message iterator */ - BT_LIB_LOGI("Creating message iterator on output port: " - "%![port-]+p, %![comp-]+c", output_port, output_port_comp); - iterator = g_new0(struct bt_port_output_message_iterator, 1); - if (!iterator) { - BT_LIB_LOGE_APPEND_CAUSE( - "Failed to allocate one output port message iterator."); - goto error; - } - - ret = init_message_iterator((void *) iterator, - BT_MESSAGE_ITERATOR_TYPE_PORT_OUTPUT, - bt_port_output_message_iterator_destroy); - if (ret) { - /* init_message_iterator() logs errors */ - BT_OBJECT_PUT_REF_AND_RESET(iterator); - goto end; - } - - /* Create colander component */ - colander_comp_cls = bt_component_class_sink_colander_get(); - if (!colander_comp_cls) { - /* bt_component_class_sink_colander_get() logs errors */ - BT_LIB_LOGE_APPEND_CAUSE( - "Cannot get colander sink component class."); - goto error; - } - - iterator->graph = graph; - bt_object_get_no_null_check(iterator->graph); - colander_data.msgs = (void *) iterator->base.msgs->pdata; - colander_data.count_addr = &iterator->count; - - /* - * Hope that nobody uses this very unique name. - * - * We pass `BT_LOGGING_LEVEL_NONE` but the colander component - * class module does not use this level anyway since it belongs - * to the library. - */ - graph_status = bt_graph_add_sink_component_with_init_method_data( - (void *) graph, colander_comp_cls, - "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1", - NULL, &colander_data, BT_LOGGING_LEVEL_NONE, - (void *) &iterator->colander); - if (graph_status != BT_FUNC_STATUS_OK) { - BT_LIB_LOGE_APPEND_CAUSE( - "Cannot add colander sink component to graph: " - "%![graph-]+g, status=%s", graph, - bt_common_func_status_string(graph_status)); - goto error; - } - - /* - * Connect provided output port to the colander component's - * input port. - */ - colander_in_port = - (void *) bt_component_sink_borrow_input_port_by_index_const( - (void *) iterator->colander, 0); - BT_ASSERT(colander_in_port); - graph_status = bt_graph_connect_ports(graph, - output_port, colander_in_port, NULL); - if (graph_status != BT_FUNC_STATUS_OK) { - BT_LIB_LOGW_APPEND_CAUSE( - "Cannot connect colander sink's port: " - "%![graph-]+g, %![comp-]+c, status=%s", graph, - iterator->colander, - bt_common_func_status_string(graph_status)); - goto error; - } - - /* - * At this point everything went fine. Make the graph - * nonconsumable forever so that only this message iterator - * can consume (thanks to bt_graph_consume_sink_no_check()). - * This avoids leaking the message created by the colander - * sink and moved to the message iterator's message - * member. - */ - bt_graph_set_can_consume(iterator->graph, false); - - /* Also set the graph as being configured. */ - graph_status = bt_graph_configure(graph); - if (graph_status != BT_FUNC_STATUS_OK) { - BT_LIB_LOGW_APPEND_CAUSE( - "Cannot configure graph after having " - "added and connected colander sink: " - "%![graph-]+g, %![comp-]+c, status=%s", graph, - iterator->colander, - bt_common_func_status_string(graph_status)); - goto error; - } - goto end; - -error: - if (iterator && iterator->graph && iterator->colander) { - int ret; + enum bt_message_iterator_can_seek_ns_from_origin_status status; - /* Remove created colander component from graph if any */ - colander_comp = iterator->colander; - BT_OBJECT_PUT_REF_AND_RESET(iterator->colander); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); + BT_ASSERT_PRE_RES_OUT_NON_NULL(can_seek); + BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); + BT_ASSERT_PRE("graph-is-configured", + bt_component_borrow_graph(iterator->upstream_component)->config_state != + BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, + "Graph is not configured: %!+g", + bt_component_borrow_graph(iterator->upstream_component)); + if (iterator->methods.can_seek_ns_from_origin) { /* - * At this point the colander component's reference - * count is 0 because iterator->colander was the only - * owner. We also know that it is not connected because - * this is the last operation before this function - * succeeds. - * - * Since we honor the preconditions here, - * bt_graph_remove_unconnected_component() always - * succeeds. + * Initialize to an invalid value, so we can post-assert that + * the method returned a valid value. */ - ret = bt_graph_remove_unconnected_component(iterator->graph, - (void *) colander_comp); - BT_ASSERT(ret == 0); - } + *can_seek = -1; - BT_OBJECT_PUT_REF_AND_RESET(iterator); + BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i", + iterator); -end: - bt_object_put_ref(colander_comp_cls); - return (void *) iterator; -} + status = (int) iterator->methods.can_seek_ns_from_origin(iterator, + ns_from_origin, can_seek); -bt_bool bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( - struct bt_self_component_port_input_message_iterator *iterator, - int64_t ns_from_origin) -{ - bt_bool can = BT_FALSE; + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS( + CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME, status); - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); - BT_ASSERT_PRE( - bt_component_borrow_graph(iterator->upstream_component)->config_state != - BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, - "Graph is not configured: %!+g", - bt_component_borrow_graph(iterator->upstream_component)); + if (status != BT_FUNC_STATUS_OK) { + BT_LIB_LOGW_APPEND_CAUSE( + "Component input port message iterator's \"can seek nanoseconds from origin\" method failed: " + "%![iter-]+i, status=%s", + iterator, bt_common_func_status_string(status)); + goto end; + } - if (iterator->methods.can_seek_ns_from_origin) { - can = iterator->methods.can_seek_ns_from_origin(iterator, - ns_from_origin); - goto end; + BT_ASSERT_POST(CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME, + "valid-return-value", + *can_seek == BT_TRUE || *can_seek == BT_FALSE, + "Unexpected boolean value returned from user's \"can seek ns from origin\" method: val=%d, %![iter-]+i", + *can_seek, iterator); + + BT_LIB_LOGD( + "User's \"can seek nanoseconds from origin\" returned successfully: " + "%![iter-]+i, can-seek=%d", + iterator, *can_seek); + + if (*can_seek) { + goto end; + } } /* - * Automatic seeking fall back: if we can seek to the beginning, - * then we can automatically seek to any message. + * Automatic seeking fall back: if we can seek to the beginning and the + * iterator supports forward seeking then we can automatically seek to + * any timestamp. */ - if (iterator->methods.can_seek_beginning) { - can = iterator->methods.can_seek_beginning(iterator); + status = (int) bt_message_iterator_can_seek_beginning( + iterator, can_seek); + if (status != BT_FUNC_STATUS_OK) { + goto end; } + *can_seek = *can_seek && iterator->config.can_seek_forward; + end: - return can; + return status; } -bt_bool bt_self_component_port_input_message_iterator_can_seek_beginning( - struct bt_self_component_port_input_message_iterator *iterator) +#define CAN_SEEK_BEGINNING_METHOD_NAME \ + "bt_message_iterator_class_can_seek_beginning" + +BT_EXPORT +enum bt_message_iterator_can_seek_beginning_status +bt_message_iterator_can_seek_beginning( + struct bt_message_iterator *iterator, + bt_bool *can_seek) { - bt_bool can = BT_FALSE; + enum bt_message_iterator_can_seek_beginning_status status; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); + BT_ASSERT_PRE_RES_OUT_NON_NULL(can_seek); BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); - BT_ASSERT_PRE( + BT_ASSERT_PRE("graph-is-configured", bt_component_borrow_graph(iterator->upstream_component)->config_state != BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not configured: %!+g", bt_component_borrow_graph(iterator->upstream_component)); if (iterator->methods.can_seek_beginning) { - can = iterator->methods.can_seek_beginning(iterator); + /* + * Initialize to an invalid value, so we can post-assert that + * the method returned a valid value. + */ + *can_seek = -1; + + status = (int) iterator->methods.can_seek_beginning(iterator, can_seek); + + BT_ASSERT_POST(CAN_SEEK_BEGINNING_METHOD_NAME, + "valid-return-value", + status != BT_FUNC_STATUS_OK || + *can_seek == BT_TRUE || + *can_seek == BT_FALSE, + "Unexpected boolean value returned from user's \"can seek beginning\" method: val=%d, %![iter-]+i", + *can_seek, iterator); + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS( + CAN_SEEK_BEGINNING_METHOD_NAME, status); + } else { + *can_seek = BT_FALSE; + status = BT_FUNC_STATUS_OK; } - return can; + return status; } static inline void set_iterator_state_after_seeking( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, int status) { - enum bt_self_component_port_input_message_iterator_state new_state = 0; + enum bt_message_iterator_state new_state = 0; /* Set iterator's state depending on seeking status */ switch (status) { case BT_FUNC_STATUS_OK: - new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE; + new_state = BT_MESSAGE_ITERATOR_STATE_ACTIVE; break; case BT_FUNC_STATUS_AGAIN: - new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN; + new_state = BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN; break; case BT_FUNC_STATUS_ERROR: case BT_FUNC_STATUS_MEMORY_ERROR: - new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR; + new_state = BT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_ERROR; break; case BT_FUNC_STATUS_END: - new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED; + new_state = BT_MESSAGE_ITERATOR_STATE_ENDED; break; default: - abort(); + bt_common_abort(); } - set_self_comp_port_input_msg_iterator_state(iterator, new_state); + set_msg_iterator_state(iterator, new_state); } static void reset_iterator_expectations( - struct bt_self_component_port_input_message_iterator *iterator) + struct bt_message_iterator *iterator) { iterator->last_ns_from_origin = INT64_MIN; iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET; } +static +bool message_iterator_can_seek_beginning( + struct bt_message_iterator *iterator) +{ + enum bt_message_iterator_can_seek_beginning_status status; + bt_bool can_seek; + + status = bt_message_iterator_can_seek_beginning( + iterator, &can_seek); + if (status != BT_FUNC_STATUS_OK) { + can_seek = BT_FALSE; + } + + return can_seek; +} + +#define SEEK_BEGINNING_METHOD_NAME \ + "bt_message_iterator_class_seek_beginning_method" + +BT_EXPORT enum bt_message_iterator_seek_beginning_status -bt_self_component_port_input_message_iterator_seek_beginning( - struct bt_self_component_port_input_message_iterator *iterator) +bt_message_iterator_seek_beginning(struct bt_message_iterator *iterator) { int status; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); - BT_ASSERT_PRE( + BT_ASSERT_PRE("graph-is-configured", bt_component_borrow_graph(iterator->upstream_component)->config_state != BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not configured: %!+g", bt_component_borrow_graph(iterator->upstream_component)); - BT_ASSERT_PRE( - bt_self_component_port_input_message_iterator_can_seek_beginning( - iterator), + BT_ASSERT_PRE("can-seek-beginning", + message_iterator_can_seek_beginning(iterator), "Message iterator cannot seek beginning: %!+i", iterator); /* @@ -1266,17 +1481,20 @@ bt_self_component_port_input_message_iterator_seek_beginning( reset_iterator_expectations(iterator); BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator); - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_SEEKING); status = iterator->methods.seek_beginning(iterator); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(status)); - BT_ASSERT_POST(status == BT_FUNC_STATUS_OK || + BT_ASSERT_POST(SEEK_BEGINNING_METHOD_NAME, "valid-status", + status == BT_FUNC_STATUS_OK || status == BT_FUNC_STATUS_ERROR || status == BT_FUNC_STATUS_MEMORY_ERROR || status == BT_FUNC_STATUS_AGAIN, "Unexpected status: %![iter-]+i, status=%s", iterator, bt_common_func_status_string(status)); + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS(SEEK_BEGINNING_METHOD_NAME, + status); if (status < 0) { BT_LIB_LOGW_APPEND_CAUSE( "Component input port message iterator's \"seek beginning\" method failed: " @@ -1284,10 +1502,22 @@ bt_self_component_port_input_message_iterator_seek_beginning( iterator, bt_common_func_status_string(status)); } + clear_per_stream_state(iterator); + set_iterator_state_after_seeking(iterator, status); return status; } +BT_EXPORT +bt_bool +bt_message_iterator_can_seek_forward( + bt_message_iterator *iterator) +{ + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); + + return iterator->config.can_seek_forward; +} + /* * Structure used to record the state of a given stream during the fast-forward * phase of an auto-seek. @@ -1297,20 +1527,18 @@ struct auto_seek_stream_state { * Value representing which step of this timeline we are at. * * time ---> - * [SB] 1 [SAB] 2 [PB] 3 [PE] 2 [SAE] 1 [SE] + * [SB] 1 [PB] 2 [PE] 1 [SE] * * At each point in the timeline, the messages we need to replicate are: * * 1: Stream beginning - * 2: Stream beginning, stream activity beginning - * 3: Stream beginning, stream activity beginning, packet beginning + * 2: Stream beginning, packet beginning * * Before "Stream beginning" and after "Stream end", we don't need to * replicate anything as the stream doesn't exist. */ enum { AUTO_SEEK_STREAM_STATE_STREAM_BEGAN, - AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN, AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, } state; @@ -1320,6 +1548,9 @@ struct auto_seek_stream_state { * alive by the time we use it. */ struct bt_packet *packet; + + /* Have we see a message with a clock snapshot yet? */ + bool seen_clock_snapshot; }; static @@ -1361,7 +1592,7 @@ void destroy_auto_seek_stream_states(GHashTable *stream_states) static inline int auto_seek_handle_message( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, int64_t ns_from_origin, const struct bt_message *msg, bool *got_first, GHashTable *stream_states) { @@ -1370,8 +1601,8 @@ int auto_seek_handle_message( const struct bt_clock_snapshot *clk_snapshot = NULL; int ret; - BT_ASSERT(msg); - BT_ASSERT(got_first); + BT_ASSERT_DBG(msg); + BT_ASSERT_DBG(got_first); switch (msg->type) { case BT_MESSAGE_TYPE_EVENT: @@ -1380,7 +1611,9 @@ int auto_seek_handle_message( (const void *) msg; clk_snapshot = event_msg->default_cs; - BT_ASSERT_POST(clk_snapshot, + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "event-message-has-default-clock-snapshot", + clk_snapshot, "Event message has no default clock snapshot: %!+n", event_msg); break; @@ -1390,8 +1623,8 @@ int auto_seek_handle_message( const struct bt_message_message_iterator_inactivity *inactivity_msg = (const void *) msg; - clk_snapshot = inactivity_msg->default_cs; - BT_ASSERT(clk_snapshot); + clk_snapshot = inactivity_msg->cs; + BT_ASSERT_DBG(clk_snapshot); break; } case BT_MESSAGE_TYPE_PACKET_BEGINNING: @@ -1400,8 +1633,20 @@ int auto_seek_handle_message( const struct bt_message_packet *packet_msg = (const void *) msg; + if (msg->type == BT_MESSAGE_TYPE_PACKET_BEGINNING + && !packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) { + goto skip_msg; + } + + if (msg->type == BT_MESSAGE_TYPE_PACKET_END + && !packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) { + goto skip_msg; + } + clk_snapshot = packet_msg->default_cs; - BT_ASSERT_POST(clk_snapshot, + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "packet-message-has-default-clock-snapshot", + clk_snapshot, "Packet message has no default clock snapshot: %!+n", packet_msg); break; @@ -1412,8 +1657,20 @@ int auto_seek_handle_message( struct bt_message_discarded_items *msg_disc_items = (void *) msg; - BT_ASSERT_POST(msg_disc_items->default_begin_cs && - msg_disc_items->default_end_cs, + if (msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS && + !msg_disc_items->stream->class->discarded_events_have_default_clock_snapshots) { + goto skip_msg; + } + + if (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS && + !msg_disc_items->stream->class->discarded_packets_have_default_clock_snapshots) { + goto skip_msg; + } + + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "discarded-events-packets-message-has-default-clock-snapshot", + msg_disc_items->default_begin_cs && + msg_disc_items->default_end_cs, "Discarded events/packets message has no default clock snapshots: %!+n", msg_disc_items); ret = bt_clock_snapshot_get_ns_from_origin( @@ -1447,7 +1704,7 @@ int auto_seek_handle_message( * as we don't know if items were really * discarded within the new time range. */ - uint64_t new_begin_raw_value; + uint64_t new_begin_raw_value = 0; ret = bt_clock_class_clock_value_from_ns_from_origin( msg_disc_items->default_end_cs->clock_class, @@ -1472,68 +1729,25 @@ int auto_seek_handle_message( goto skip_msg; } } - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: - { - const struct bt_message_stream_activity *stream_act_msg = - (const void *) msg; - - switch (stream_act_msg->default_cs_state) { - case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN: - case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE: - /* - * -inf is always less than any requested time, - * and we can't assume any specific time for an - * unknown clock snapshot, so skip this. - */ - goto skip_msg; - case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN: - clk_snapshot = stream_act_msg->default_cs; - BT_ASSERT(clk_snapshot); - break; - default: - abort(); - } - - break; - } - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: + case BT_MESSAGE_TYPE_STREAM_BEGINNING: + case BT_MESSAGE_TYPE_STREAM_END: { - const struct bt_message_stream_activity *stream_act_msg = - (const void *) msg; + struct bt_message_stream *stream_msg = + (struct bt_message_stream *) msg; - switch (stream_act_msg->default_cs_state) { - case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN: - /* - * We can't assume any specific time for an - * unknown clock snapshot, so skip this. - */ + if (stream_msg->default_cs_state != BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { + /* Ignore */ goto skip_msg; - case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE: - /* - * +inf is always greater than any requested - * time. - */ - *got_first = true; - goto push_msg; - case BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN: - clk_snapshot = stream_act_msg->default_cs; - BT_ASSERT(clk_snapshot); - break; - default: - abort(); } + clk_snapshot = stream_msg->default_cs; break; } - case BT_MESSAGE_TYPE_STREAM_BEGINNING: - case BT_MESSAGE_TYPE_STREAM_END: - /* Ignore */ - goto skip_msg; default: - abort(); + bt_common_abort(); } - BT_ASSERT(clk_snapshot); + BT_ASSERT_DBG(clk_snapshot); ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot, &msg_ns_from_origin); if (ret) { @@ -1563,39 +1777,46 @@ skip_msg: stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN; - BT_ASSERT(!bt_g_hash_table_contains(stream_states, stream_msg->stream)); + if (stream_msg->default_cs_state == BT_MESSAGE_STREAM_CLOCK_SNAPSHOT_STATE_KNOWN) { + stream_state->seen_clock_snapshot = true; + } + + BT_ASSERT_DBG(!bt_g_hash_table_contains(stream_states, stream_msg->stream)); g_hash_table_insert(stream_states, stream_msg->stream, stream_state); break; } - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: + case BT_MESSAGE_TYPE_PACKET_BEGINNING: { - const struct bt_message_stream_activity *stream_act_msg = + const struct bt_message_packet *packet_msg = (const void *) msg; struct auto_seek_stream_state *stream_state; - /* Update stream's state: stream activity began. */ - stream_state = g_hash_table_lookup(stream_states, stream_act_msg->stream); - BT_ASSERT(stream_state); + /* Update stream's state: packet began. */ + stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream); + BT_ASSERT_DBG(stream_state); + BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); + stream_state->state = AUTO_SEEK_STREAM_STATE_PACKET_BEGAN; + BT_ASSERT_DBG(!stream_state->packet); + stream_state->packet = packet_msg->packet; + + if (packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) { + stream_state->seen_clock_snapshot = true; + } - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); - stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN; - BT_ASSERT(!stream_state->packet); break; } - case BT_MESSAGE_TYPE_PACKET_BEGINNING: + case BT_MESSAGE_TYPE_EVENT: { - const struct bt_message_packet *packet_msg = - (const void *) msg; + const struct bt_message_event *event_msg = (const void *) msg; struct auto_seek_stream_state *stream_state; - /* Update stream's state: packet began. */ - stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream); - BT_ASSERT(stream_state); + stream_state = g_hash_table_lookup(stream_states, + event_msg->event->stream); + BT_ASSERT_DBG(stream_state); + + // HELPME: are we sure that event messages have clock snapshots at this point? + stream_state->seen_clock_snapshot = true; - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN); - stream_state->state = AUTO_SEEK_STREAM_STATE_PACKET_BEGAN; - BT_ASSERT(!stream_state->packet); - stream_state->packet = packet_msg->packet; break; } case BT_MESSAGE_TYPE_PACKET_END: @@ -1606,27 +1827,16 @@ skip_msg: /* Update stream's state: packet ended. */ stream_state = g_hash_table_lookup(stream_states, packet_msg->packet->stream); - BT_ASSERT(stream_state); - - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_PACKET_BEGAN); - stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN; - BT_ASSERT(stream_state->packet); + BT_ASSERT_DBG(stream_state); + BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_PACKET_BEGAN); + stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN; + BT_ASSERT_DBG(stream_state->packet); stream_state->packet = NULL; - break; - } - case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END: - { - const struct bt_message_stream_activity *stream_act_msg = - (const void *) msg; - struct auto_seek_stream_state *stream_state; - /* Update stream's state: stream activity ended. */ - stream_state = g_hash_table_lookup(stream_states, stream_act_msg->stream); - BT_ASSERT(stream_state); + if (packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) { + stream_state->seen_clock_snapshot = true; + } - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN); - stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN; - BT_ASSERT(!stream_state->packet); break; } case BT_MESSAGE_TYPE_STREAM_END: @@ -1635,19 +1845,36 @@ skip_msg: struct auto_seek_stream_state *stream_state; stream_state = g_hash_table_lookup(stream_states, stream_msg->stream); - BT_ASSERT(stream_state); - BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); - BT_ASSERT(!stream_state->packet); + BT_ASSERT_DBG(stream_state); + BT_ASSERT_DBG(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN); + BT_ASSERT_DBG(!stream_state->packet); /* Update stream's state: this stream doesn't exist anymore. */ g_hash_table_remove(stream_states, stream_msg->stream); break; } + case BT_MESSAGE_TYPE_DISCARDED_EVENTS: + case BT_MESSAGE_TYPE_DISCARDED_PACKETS: + { + const struct bt_message_discarded_items *discarded_msg = + (const void *) msg; + struct auto_seek_stream_state *stream_state; + + stream_state = g_hash_table_lookup(stream_states, discarded_msg->stream); + BT_ASSERT_DBG(stream_state); + + if ((msg->type == BT_MESSAGE_TYPE_DISCARDED_EVENTS && discarded_msg->stream->class->discarded_events_have_default_clock_snapshots) || + (msg->type == BT_MESSAGE_TYPE_DISCARDED_PACKETS && discarded_msg->stream->class->discarded_packets_have_default_clock_snapshots)) { + stream_state->seen_clock_snapshot = true; + } + + break; + } default: break; } - bt_object_put_no_null_check(msg); + bt_object_put_ref_no_null_check(msg); msg = NULL; goto end; @@ -1656,34 +1883,34 @@ push_msg: msg = NULL; end: - BT_ASSERT(!msg || status != BT_FUNC_STATUS_OK); + BT_ASSERT_DBG(!msg || status != BT_FUNC_STATUS_OK); return status; } static int find_message_ge_ns_from_origin( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, int64_t ns_from_origin, GHashTable *stream_states) { - int status; - enum bt_self_component_port_input_message_iterator_state init_state = + int status = BT_FUNC_STATUS_OK; + enum bt_message_iterator_state init_state = iterator->state; const struct bt_message *messages[MSG_BATCH_SIZE]; uint64_t user_count = 0; uint64_t i; bool got_first = false; - BT_ASSERT(iterator); + BT_ASSERT_DBG(iterator); memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE); /* * Make this iterator temporarily active (not seeking) to call * the "next" method. */ - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_ACTIVE); - BT_ASSERT(iterator->methods.next); + BT_ASSERT_DBG(iterator->methods.next); while (!got_first) { /* @@ -1705,12 +1932,14 @@ int find_message_ge_ns_from_origin( * The user's "next" method must not do any action which * would change the iterator's state. */ - BT_ASSERT(iterator->state == - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE); + BT_ASSERT_DBG(iterator->state == + BT_MESSAGE_ITERATOR_STATE_ACTIVE); switch (status) { case BT_FUNC_STATUS_OK: - BT_ASSERT_POST(user_count <= MSG_BATCH_SIZE, + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "count-lteq-capacity", + user_count <= MSG_BATCH_SIZE, "Invalid returned message count: greater than " "batch size: count=%" PRIu64 ", batch-size=%u", user_count, MSG_BATCH_SIZE); @@ -1721,7 +1950,7 @@ int find_message_ge_ns_from_origin( case BT_FUNC_STATUS_END: goto end; default: - abort(); + bt_common_abort(); } for (i = 0; i < user_count; i++) { @@ -1747,24 +1976,24 @@ int find_message_ge_ns_from_origin( end: for (i = 0; i < user_count; i++) { if (messages[i]) { - bt_object_put_no_null_check(messages[i]); + bt_object_put_ref_no_null_check(messages[i]); } } - set_self_comp_port_input_msg_iterator_state(iterator, init_state); + set_msg_iterator_state(iterator, init_state); return status; } /* * This function is installed as the iterator's next callback after we have - * auto-seeked (seeked to the beginning and fast-forwarded) to send the + * auto-sought (sought to the beginning and fast-forwarded) to send the * messages saved in iterator->auto_seek.msgs. Once this is done, the original * next callback is put back. */ static -enum bt_component_class_message_iterator_next_method_status post_auto_seek_next( - struct bt_self_component_port_input_message_iterator *iterator, +enum bt_message_iterator_class_next_method_status post_auto_seek_next( + struct bt_message_iterator *iterator, bt_message_array_const msgs, uint64_t capacity, uint64_t *count) { @@ -1806,29 +2035,52 @@ int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class, cc_offset_cycles, cc_freq, ns_from_origin, raw_value); } +static +bool message_iterator_can_seek_ns_from_origin( + struct bt_message_iterator *iterator, + int64_t ns_from_origin) +{ + enum bt_message_iterator_can_seek_ns_from_origin_status status; + bt_bool can_seek; + + status = bt_message_iterator_can_seek_ns_from_origin( + iterator, ns_from_origin, &can_seek); + if (status != BT_FUNC_STATUS_OK) { + can_seek = BT_FALSE; + } + + return can_seek; +} + +#define SEEK_NS_FROM_ORIGIN_METHOD_NAME \ + "bt_message_iterator_class_seek_ns_from_origin_method" + +BT_EXPORT enum bt_message_iterator_seek_ns_from_origin_status -bt_self_component_port_input_message_iterator_seek_ns_from_origin( - struct bt_self_component_port_input_message_iterator *iterator, +bt_message_iterator_seek_ns_from_origin( + struct bt_message_iterator *iterator, int64_t ns_from_origin) { int status; GHashTable *stream_states = NULL; + bt_bool can_seek_by_itself; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_NO_ERROR(); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator); - BT_ASSERT_PRE( + BT_ASSERT_PRE("graph-is-configured", bt_component_borrow_graph(iterator->upstream_component)->config_state != BT_GRAPH_CONFIGURATION_STATE_CONFIGURING, "Graph is not configured: %!+g", bt_component_borrow_graph(iterator->upstream_component)); - BT_ASSERT_PRE( - bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( - iterator, ns_from_origin), + /* The iterator must be able to seek ns from origin one way or another. */ + BT_ASSERT_PRE("can-seek-ns-from-origin", + message_iterator_can_seek_ns_from_origin(iterator, ns_from_origin), "Message iterator cannot seek nanoseconds from origin: %!+i, " "ns-from-origin=%" PRId64, iterator, ns_from_origin); - set_self_comp_port_input_msg_iterator_state(iterator, - BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_SEEKING); /* * We are seeking, reset our expectations about how the following @@ -1836,20 +2088,40 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( */ reset_iterator_expectations(iterator); - if (iterator->methods.seek_ns_from_origin) { + /* Check if the iterator can seek by itself. If not we'll use autoseek. */ + if (iterator->methods.can_seek_ns_from_origin) { + bt_message_iterator_class_can_seek_ns_from_origin_method_status + can_seek_status; + + can_seek_status = + iterator->methods.can_seek_ns_from_origin( + iterator, ns_from_origin, &can_seek_by_itself); + if (can_seek_status != BT_FUNC_STATUS_OK) { + status = can_seek_status; + goto end; + } + } else { + can_seek_by_itself = false; + } + + if (can_seek_by_itself) { /* The iterator knows how to seek to a particular time, let it handle this. */ + BT_ASSERT(iterator->methods.seek_ns_from_origin); BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: " "%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin); status = iterator->methods.seek_ns_from_origin(iterator, ns_from_origin); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(status)); - BT_ASSERT_POST(status == BT_FUNC_STATUS_OK || + BT_ASSERT_POST(SEEK_NS_FROM_ORIGIN_METHOD_NAME, "valid-status", + status == BT_FUNC_STATUS_OK || status == BT_FUNC_STATUS_ERROR || status == BT_FUNC_STATUS_MEMORY_ERROR || status == BT_FUNC_STATUS_AGAIN, "Unexpected status: %![iter-]+i, status=%s", iterator, bt_common_func_status_string(status)); + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS( + SEEK_NS_FROM_ORIGIN_METHOD_NAME, status); if (status < 0) { BT_LIB_LOGW_APPEND_CAUSE( "Component input port message iterator's \"seek nanoseconds from origin\" method failed: " @@ -1858,17 +2130,25 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( } } else { /* - * The iterator doesn't know how to seek to a particular time. We will - * seek to the beginning and fast forward to the right place. + * The iterator doesn't know how to seek by itself to a + * particular time. We will seek to the beginning and fast + * forward to the right place. */ - BT_ASSERT(iterator->methods.can_seek_beginning(iterator)); + enum bt_message_iterator_class_can_seek_beginning_method_status can_seek_status; + bt_bool can_seek_beginning; + + can_seek_status = iterator->methods.can_seek_beginning(iterator, + &can_seek_beginning); + BT_ASSERT(can_seek_status == BT_FUNC_STATUS_OK); + BT_ASSERT(can_seek_beginning); BT_ASSERT(iterator->methods.seek_beginning); BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i", iterator); status = iterator->methods.seek_beginning(iterator); BT_LOGD("User method returned: status=%s", bt_common_func_status_string(status)); - BT_ASSERT_POST(status == BT_FUNC_STATUS_OK || + BT_ASSERT_POST(SEEK_BEGINNING_METHOD_NAME, "valid-status", + status == BT_FUNC_STATUS_OK || status == BT_FUNC_STATUS_ERROR || status == BT_FUNC_STATUS_MEMORY_ERROR || status == BT_FUNC_STATUS_AGAIN, @@ -1881,6 +2161,8 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( iterator, bt_common_func_status_string(status)); } + clear_per_stream_state(iterator); + switch (status) { case BT_FUNC_STATUS_OK: break; @@ -1889,7 +2171,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( case BT_FUNC_STATUS_AGAIN: goto end; default: - abort(); + bt_common_abort(); } /* @@ -1900,7 +2182,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( * message queue. */ while (!g_queue_is_empty(iterator->auto_seek.msgs)) { - bt_object_put_no_null_check( + bt_object_put_ref_no_null_check( g_queue_pop_tail(iterator->auto_seek.msgs)); } @@ -1934,44 +2216,57 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( bt_message *msg; const bt_clock_class *clock_class = bt_stream_class_borrow_default_clock_class_const( bt_stream_borrow_class_const(stream)); - uint64_t raw_value; - - if (clock_raw_value_from_ns_from_origin(clock_class, ns_from_origin, &raw_value) != 0) { - BT_LIB_LOGW_APPEND_CAUSE( - "Could not convert nanoseconds from origin to clock value: " - "ns-from-origin=%" PRId64 ", %![cc-]+K", - ns_from_origin, clock_class); - status = BT_FUNC_STATUS_ERROR; - goto end; + /* Initialize to silence maybe-uninitialized warning. */ + uint64_t raw_value = 0; + + /* + * If we haven't seen a message with a clock snapshot, we don't know if our seek time is within + * the clock's range, so it wouldn't be safe to try to convert ns_from_origin to a clock value. + * + * Also, it would be a bit of a lie to generate a stream begin message with the seek time as its + * clock snapshot, because we don't really know if the stream existed at that time. If we have + * seen a message with a clock snapshot in our seeking, then we are sure that the + * seek time is not below the clock range, and we know the stream was active at that + * time (and that we cut it short). + */ + if (stream_state->seen_clock_snapshot) { + if (clock_raw_value_from_ns_from_origin(clock_class, ns_from_origin, &raw_value) != 0) { + BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64 ", %![cc-]+K", + ns_from_origin, clock_class); + status = BT_FUNC_STATUS_ERROR; + goto end; + } } switch (stream_state->state) { case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN: BT_ASSERT(stream_state->packet); BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state->packet); - msg = bt_message_packet_beginning_create_with_default_clock_snapshot( - (bt_self_message_iterator *) iterator, stream_state->packet, raw_value); - if (!msg) { - status = BT_FUNC_STATUS_MEMORY_ERROR; - goto end; + + if (stream->class->packets_have_beginning_default_clock_snapshot) { + /* + * If we are in the PACKET_BEGAN state, it means we have seen a "packet beginning" + * message. If "packet beginning" packets have clock snapshots, then we must have + * seen a clock snapshot. + */ + BT_ASSERT(stream_state->seen_clock_snapshot); + + msg = bt_message_packet_beginning_create_with_default_clock_snapshot( + (bt_self_message_iterator *) iterator, stream_state->packet, raw_value); + } else { + msg = bt_message_packet_beginning_create((bt_self_message_iterator *) iterator, + stream_state->packet); } - g_queue_push_head(iterator->auto_seek.msgs, msg); - msg = NULL; - /* fall-thru */ - case AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN: - msg = bt_message_stream_activity_beginning_create( - (bt_self_message_iterator *) iterator, stream); if (!msg) { status = BT_FUNC_STATUS_MEMORY_ERROR; goto end; } - bt_message_stream_activity_beginning_set_default_clock_snapshot(msg, raw_value); - g_queue_push_head(iterator->auto_seek.msgs, msg); msg = NULL; /* fall-thru */ + case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN: msg = bt_message_stream_beginning_create( (bt_self_message_iterator *) iterator, stream); @@ -1980,6 +2275,10 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( goto end; } + if (stream_state->seen_clock_snapshot) { + bt_message_stream_beginning_set_default_clock_snapshot(msg, raw_value); + } + g_queue_push_head(iterator->auto_seek.msgs, msg); msg = NULL; break; @@ -1997,7 +2296,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( iterator->auto_seek.original_next_callback = iterator->methods.next; iterator->methods.next = - (bt_self_component_port_input_message_iterator_next_method) + (bt_message_iterator_next_method) post_auto_seek_next; } @@ -2016,10 +2315,12 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( case BT_FUNC_STATUS_AGAIN: goto end; default: - abort(); + bt_common_abort(); } } + clear_per_stream_state(iterator); + /* * The following messages returned by the next method (including * post_auto_seek_next) must be after (or at) `ns_from_origin`. @@ -2036,80 +2337,27 @@ end: return status; } -static inline -bt_self_component_port_input_message_iterator * -borrow_output_port_message_iterator_upstream_iterator( - struct bt_port_output_message_iterator *iterator) -{ - struct bt_component_class_sink_colander_priv_data *colander_data; - - BT_ASSERT(iterator); - colander_data = (void *) iterator->colander->parent.user_data; - BT_ASSERT(colander_data); - BT_ASSERT(colander_data->msg_iter); - return colander_data->msg_iter; -} - -bt_bool bt_port_output_message_iterator_can_seek_ns_from_origin( - struct bt_port_output_message_iterator *iterator, - int64_t ns_from_origin) -{ - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - return bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( - borrow_output_port_message_iterator_upstream_iterator( - iterator), ns_from_origin); -} - -bt_bool bt_port_output_message_iterator_can_seek_beginning( - struct bt_port_output_message_iterator *iterator) +BT_EXPORT +bt_bool bt_self_message_iterator_is_interrupted( + const struct bt_self_message_iterator *self_msg_iter) { - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - return bt_self_component_port_input_message_iterator_can_seek_beginning( - borrow_output_port_message_iterator_upstream_iterator( - iterator)); -} - -enum bt_message_iterator_seek_ns_from_origin_status -bt_port_output_message_iterator_seek_ns_from_origin( - struct bt_port_output_message_iterator *iterator, - int64_t ns_from_origin) -{ - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - return bt_self_component_port_input_message_iterator_seek_ns_from_origin( - borrow_output_port_message_iterator_upstream_iterator(iterator), - ns_from_origin); -} - -enum bt_message_iterator_seek_beginning_status -bt_port_output_message_iterator_seek_beginning( - struct bt_port_output_message_iterator *iterator) -{ - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - return bt_self_component_port_input_message_iterator_seek_beginning( - borrow_output_port_message_iterator_upstream_iterator( - iterator)); -} - -void bt_port_output_message_iterator_get_ref( - const struct bt_port_output_message_iterator *iterator) -{ - bt_object_get_ref(iterator); -} + const struct bt_message_iterator *iterator = + (const void *) self_msg_iter; -void bt_port_output_message_iterator_put_ref( - const struct bt_port_output_message_iterator *iterator) -{ - bt_object_put_ref(iterator); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); + return (bt_bool) bt_graph_is_interrupted(iterator->graph); } -void bt_self_component_port_input_message_iterator_get_ref( - const struct bt_self_component_port_input_message_iterator *iterator) +BT_EXPORT +void bt_message_iterator_get_ref( + const struct bt_message_iterator *iterator) { bt_object_get_ref(iterator); } -void bt_self_component_port_input_message_iterator_put_ref( - const struct bt_self_component_port_input_message_iterator *iterator) +BT_EXPORT +void bt_message_iterator_put_ref( + const struct bt_message_iterator *iterator) { bt_object_put_ref(iterator); }