X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=src%2Flib%2Fgraph%2Fiterator.c;h=fd49c27ef15ebb03511b65a65d68781f74a3b174;hb=867eb7632255f6a84234542198bd7edaac1bce12;hp=8af6166a0dd47d5759219c2c4a1d96220a780ffe;hpb=8d8b141db4c46135a35be19e4a1c192f6a36d67b;p=babeltrace.git diff --git a/src/lib/graph/iterator.c b/src/lib/graph/iterator.c index 8af6166a..fd49c27e 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,37 +13,27 @@ #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 +#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" @@ -68,6 +42,7 @@ #include "component-source.h" #include "connection.h" #include "graph.h" +#include "message-iterator-class.h" #include "message/discarded-items.h" #include "message/event.h" #include "message/iterator.h" @@ -84,27 +59,27 @@ #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)) 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) +void set_msg_iterator_state(struct bt_message_iterator *iterator, + enum bt_message_iterator_state state) { - BT_ASSERT(iterator); + BT_ASSERT_DBG(iterator); BT_LIB_LOGD("Updating message iterator's state: new-state=%s", - bt_self_component_port_input_message_iterator_state_string(state)); + 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); @@ -123,7 +98,7 @@ 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->connection) { /* @@ -137,7 +112,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)); } @@ -164,75 +139,79 @@ void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj } 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) { uint64_t i; - typedef void (*method_t)(void *); - - struct bt_component_class *comp_class = NULL; - method_t method = NULL; + 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; - } - 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(); - } - - if (method) { - BT_LIB_LOGD("Calling user's finalization method: %!+i", - iterator); - method(iterator); + 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); + } + } } /* Detach upstream message iterators */ for (i = 0; i < iterator->upstream_msg_iters->len; i++) { - struct bt_self_component_port_input_message_iterator *upstream_msg_iter = + struct bt_message_iterator *upstream_msg_iter = iterator->upstream_msg_iters->pdata[i]; upstream_msg_iter->downstream_msg_iter = NULL; @@ -253,8 +232,8 @@ void bt_self_component_port_input_message_iterator_try_finalize( 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: @@ -262,8 +241,8 @@ end: } 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); @@ -274,7 +253,7 @@ void bt_self_component_port_input_message_iterator_set_connection( static enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, int64_t ns_from_origin, bt_bool *can_seek) { *can_seek = BT_TRUE; @@ -284,7 +263,7 @@ enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true( static enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true( - struct bt_self_component_port_input_message_iterator *iterator, + struct bt_message_iterator *iterator, bt_bool *can_seek) { *can_seek = BT_TRUE; @@ -296,36 +275,39 @@ static 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_self_component_port_input_message_iterator **message_iterator) + struct bt_message_iterator **message_iterator, + const char *api_func) { - typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t)( - void *, void *, void *, void *); - - init_method_t init_method = NULL; - struct bt_self_component_port_input_message_iterator *iterator = + bt_message_iterator_class_initialize_method init_method = NULL; + struct bt_message_iterator *iterator = NULL; - struct bt_self_component_port_input_message_iterator *downstream_msg_iter = + 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_PRE_NON_NULL(message_iterator, "Created message iterator"); - BT_ASSERT_PRE_NON_NULL(port, "Input port"); + 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(bt_port_is_connected(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(comp, "Input port is not part of a component: %![port-]+p", + 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); upstream_comp = bt_port_borrow_component_inline(upstream_port); BT_ASSERT(upstream_comp); - BT_ASSERT_PRE( + 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 == @@ -340,7 +322,7 @@ int create_self_component_input_port_message_iterator( 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 " @@ -350,7 +332,7 @@ int create_self_component_input_port_message_iterator( } bt_object_init_shared(&iterator->base, - bt_self_component_port_input_message_iterator_destroy); + bt_message_iterator_destroy); iterator->msgs = g_ptr_array_new(); if (!iterator->msgs) { BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GPtrArray."); @@ -378,104 +360,60 @@ int create_self_component_input_port_message_iterator( 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_can_seek_beginning_method) + (bt_message_iterator_can_seek_beginning_method) can_seek_beginning_true; } - 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, &iterator->config, 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: " @@ -501,8 +439,8 @@ int create_self_component_input_port_message_iterator( 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", @@ -519,45 +457,47 @@ end: return status; } -bt_self_component_port_input_message_iterator_create_from_message_iterator_status -bt_self_component_port_input_message_iterator_create_from_message_iterator( +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_self_component_port_input_message_iterator **message_iterator) + struct bt_message_iterator **message_iterator) { - BT_ASSERT_PRE_NON_NULL(self_msg_iter, "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); + input_port, message_iterator, __func__); } -bt_self_component_port_input_message_iterator_create_from_sink_component_status -bt_self_component_port_input_message_iterator_create_from_sink_component( +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_self_component_port_input_message_iterator **message_iterator) + struct bt_message_iterator **message_iterator) { - BT_ASSERT_PRE_NON_NULL(self_comp, "Sink component"); + 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); + input_port, message_iterator, __func__); } 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_DEV_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return iterator->user_data; } 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_DEV_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); @@ -567,8 +507,10 @@ 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(config, "Message iterator configuration"); - BT_ASSERT_PRE_DEV_HOT(config, "Message iterator configuration", ""); + 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; } @@ -578,10 +520,10 @@ void bt_self_message_iterator_configuration_set_can_seek_forward( * time. */ -BT_ASSERT_POST_DEV_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; @@ -606,7 +548,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: @@ -642,8 +584,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; } @@ -653,10 +602,10 @@ end: return result; } -BT_ASSERT_POST_DEV_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; @@ -680,9 +629,9 @@ end: * stream is compatible with what we've seen before. */ -BT_ASSERT_POST_DEV_FUNC +BT_ASSERT_COND_DEV_FUNC static -bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator *iterator, +bool 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); @@ -720,7 +669,7 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag case CLOCK_EXPECTATION_NONE: if (clock_class) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting no clock class, got one: %![cc-]+K", clock_class); result = false; @@ -731,14 +680,14 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag case CLOCK_EXPECTATION_ORIGIN_UNIX: if (!clock_class) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class, got none."); result = false; goto end; } if (!bt_clock_class_origin_is_unix_epoch(clock_class)) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class with Unix epoch origin: %![cc-]+K", clock_class); result = false; @@ -748,14 +697,14 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID: if (!clock_class) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class, got none."); result = false; goto end; } if (bt_clock_class_origin_is_unix_epoch(clock_class)) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class without Unix epoch origin: %![cc-]+K", clock_class); result = false; @@ -763,7 +712,7 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag } if (!clock_class_uuid) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class with UUID: %![cc-]+K", clock_class); result = false; @@ -771,7 +720,7 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag } if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class with UUID, got one " "with a different UUID: %![cc-]+K, expected-uuid=%!u", clock_class, iterator->clock_expectation.uuid); @@ -782,14 +731,14 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID: if (!clock_class) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class, got none."); result = false; goto end; } if (bt_clock_class_origin_is_unix_epoch(clock_class)) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class without Unix epoch origin: %![cc-]+K", clock_class); result = false; @@ -797,7 +746,7 @@ bool clock_classes_are_compatible_one(struct bt_self_component_port_input_messag } if (clock_class_uuid) { - BT_ASSERT_POST_DEV_MSG( + BT_ASSERT_COND_DEV_MSG( "Expecting a clock class without UUID: %![cc-]+K", clock_class); result = false; @@ -813,10 +762,10 @@ end: return result; } -BT_ASSERT_POST_DEV_FUNC +BT_ASSERT_COND_DEV_FUNC static bool clock_classes_are_compatible( - 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; @@ -840,47 +789,61 @@ end: * messages. */ +#define NEXT_METHOD_NAME "bt_message_iterator_class_next_method" + 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_DEV(clock_classes_are_compatible(iterator, msgs, *user_count), + BT_ASSERT_POST_DEV(NEXT_METHOD_NAME, + "message-clock-classes-are-compatible", + clock_classes_are_compatible(iterator, msgs, + *user_count), "Clocks are not compatible"); - BT_ASSERT_POST_DEV(clock_snapshots_are_monotonic(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"); } + BT_ASSERT_POST_DEV_NO_ERROR_IF_NO_ERROR_STATUS(NEXT_METHOD_NAME, + status); + return status; } 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_DEV_NON_NULL(iterator, "Message iterator"); - BT_ASSERT_PRE_DEV_NON_NULL(msgs, "Message array (output)"); - BT_ASSERT_PRE_DEV_NON_NULL(user_count, "Message count (output)"); - BT_ASSERT_PRE_DEV(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_DEV( + 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", @@ -916,12 +879,13 @@ bt_self_component_port_input_message_iterator_next( * 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); + BT_ASSERT_DBG(iterator->state == + BT_MESSAGE_ITERATOR_STATE_ACTIVE); switch (status) { case BT_FUNC_STATUS_OK: - BT_ASSERT_POST_DEV(*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); @@ -930,12 +894,12 @@ bt_self_component_port_input_message_iterator_next( 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); + set_msg_iterator_state(iterator, + BT_MESSAGE_ITERATOR_STATE_ENDED); goto end; default: /* Unknown non-error status */ - abort(); + bt_common_abort(); } end: @@ -943,52 +907,48 @@ end: } struct bt_component * -bt_self_component_port_input_message_iterator_borrow_component( - struct bt_self_component_port_input_message_iterator *iterator) +bt_message_iterator_borrow_component( + struct bt_message_iterator *iterator) { - BT_ASSERT_PRE_DEV_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_ASSERT_PRE_DEV_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return iterator->upstream_component; } 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_DEV_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return (void *) iterator->upstream_component; } 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_DEV_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_DEV_MSG_ITER_NON_NULL(iterator); return (void *) iterator->upstream_port; } +#define CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME \ + "bt_message_iterator_class_can_seek_ns_from_origin_method" + enum bt_message_iterator_can_seek_ns_from_origin_status -bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( - struct bt_self_component_port_input_message_iterator *iterator, +bt_message_iterator_can_seek_ns_from_origin( + struct bt_message_iterator *iterator, int64_t ns_from_origin, bt_bool *can_seek) { enum bt_message_iterator_can_seek_ns_from_origin_status status; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)"); + 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", @@ -1001,41 +961,71 @@ bt_self_component_port_input_message_iterator_can_seek_ns_from_origin( */ *can_seek = -1; + BT_LIB_LOGD("Calling user's \"can seek nanoseconds from origin\" method: %!+i", + iterator); + status = (int) iterator->methods.can_seek_ns_from_origin(iterator, ns_from_origin, can_seek); - BT_ASSERT_POST( - status != BT_FUNC_STATUS_OK || - *can_seek == BT_TRUE || - *can_seek == BT_FALSE, + BT_ASSERT_POST_NO_ERROR_IF_NO_ERROR_STATUS( + CAN_SEEK_NS_FROM_ORIGIN_METHOD_NAME, status); + + 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; + } + + 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); - goto end; + 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. */ - status = (int) bt_self_component_port_input_message_iterator_can_seek_beginning( + 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 status; } +#define CAN_SEEK_BEGINNING_METHOD_NAME \ + "bt_message_iterator_class_can_seek_beginning" + enum bt_message_iterator_can_seek_beginning_status -bt_self_component_port_input_message_iterator_can_seek_beginning( - struct bt_self_component_port_input_message_iterator *iterator, +bt_message_iterator_can_seek_beginning( + struct bt_message_iterator *iterator, bt_bool *can_seek) { enum bt_message_iterator_can_seek_beginning_status status; - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); - BT_ASSERT_PRE_NON_NULL(can_seek, "Result (output)"); + 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", @@ -1050,12 +1040,15 @@ bt_self_component_port_input_message_iterator_can_seek_beginning( status = (int) iterator->methods.can_seek_beginning(iterator, can_seek); - BT_ASSERT_POST( + 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; @@ -1066,36 +1059,36 @@ bt_self_component_port_input_message_iterator_can_seek_beginning( 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; @@ -1103,12 +1096,12 @@ void reset_iterator_expectations( static bool message_iterator_can_seek_beginning( - struct bt_self_component_port_input_message_iterator *iterator) + struct bt_message_iterator *iterator) { enum bt_message_iterator_can_seek_beginning_status status; bt_bool can_seek; - status = bt_self_component_port_input_message_iterator_can_seek_beginning( + status = bt_message_iterator_can_seek_beginning( iterator, &can_seek); if (status != BT_FUNC_STATUS_OK) { can_seek = BT_FALSE; @@ -1117,20 +1110,24 @@ bool message_iterator_can_seek_beginning( return can_seek; } +#define SEEK_BEGINNING_METHOD_NAME \ + "bt_message_iterator_class_seek_beginning_method" + 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(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); /* @@ -1140,17 +1137,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: " @@ -1163,10 +1163,10 @@ bt_self_component_port_input_message_iterator_seek_beginning( } bt_bool -bt_self_component_port_input_message_iterator_can_seek_forward( - bt_self_component_port_input_message_iterator *iterator) +bt_message_iterator_can_seek_forward( + bt_message_iterator *iterator) { - BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator"); + BT_ASSERT_PRE_MSG_ITER_NON_NULL(iterator); return iterator->config.can_seek_forward; } @@ -1245,7 +1245,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) { @@ -1254,8 +1254,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: @@ -1264,7 +1264,9 @@ int auto_seek_handle_message( (const void *) msg; clk_snapshot = event_msg->default_cs; - BT_ASSERT_POST_DEV(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; @@ -1274,8 +1276,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: @@ -1284,8 +1286,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_DEV(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; @@ -1296,8 +1310,20 @@ int auto_seek_handle_message( struct bt_message_discarded_items *msg_disc_items = (void *) msg; - BT_ASSERT_POST_DEV(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( @@ -1371,10 +1397,10 @@ int auto_seek_handle_message( break; } 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) { @@ -1408,7 +1434,7 @@ skip_msg: stream_state->seen_clock_snapshot = true; } - BT_ASSERT(!bt_g_hash_table_contains(stream_states, stream_msg->stream)); + 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; } @@ -1420,11 +1446,10 @@ skip_msg: /* Update stream's state: packet began. */ 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_STREAM_BEGAN); + 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(!stream_state->packet); + BT_ASSERT_DBG(!stream_state->packet); stream_state->packet = packet_msg->packet; if (packet_msg->packet->stream->class->packets_have_beginning_default_clock_snapshot) { @@ -1439,8 +1464,8 @@ skip_msg: struct auto_seek_stream_state *stream_state; stream_state = g_hash_table_lookup(stream_states, - event_msg->event->packet->stream); - BT_ASSERT(stream_state); + 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; @@ -1455,11 +1480,10 @@ 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); + 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(stream_state->packet); + BT_ASSERT_DBG(stream_state->packet); stream_state->packet = NULL; if (packet_msg->packet->stream->class->packets_have_end_default_clock_snapshot) { @@ -1474,9 +1498,9 @@ 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); @@ -1490,7 +1514,7 @@ skip_msg: struct auto_seek_stream_state *stream_state; stream_state = g_hash_table_lookup(stream_states, discarded_msg->stream); - BT_ASSERT(stream_state); + 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)) { @@ -1503,7 +1527,7 @@ skip_msg: break; } - bt_object_put_no_null_check(msg); + bt_object_put_ref_no_null_check(msg); msg = NULL; goto end; @@ -1512,34 +1536,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) { /* @@ -1561,12 +1585,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_DEV(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); @@ -1577,7 +1603,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++) { @@ -1603,11 +1629,11 @@ 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; } @@ -1619,8 +1645,8 @@ end: */ 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) { @@ -1664,13 +1690,13 @@ int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class, static bool message_iterator_can_seek_ns_from_origin( - struct bt_self_component_port_input_message_iterator *iterator, + 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_self_component_port_input_message_iterator_can_seek_ns_from_origin( + 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; @@ -1679,27 +1705,34 @@ bool message_iterator_can_seek_ns_from_origin( return can_seek; } +#define SEEK_NS_FROM_ORIGIN_METHOD_NAME \ + "bt_message_iterator_class_seek_ns_from_origin_method" + + 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( + /* 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 @@ -1707,20 +1740,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: " @@ -1729,25 +1782,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. */ - enum bt_component_class_message_iterator_can_seek_beginning_method_status - can_seek_status; + 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, @@ -1768,7 +1821,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( case BT_FUNC_STATUS_AGAIN: goto end; default: - abort(); + bt_common_abort(); } /* @@ -1779,7 +1832,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)); } @@ -1893,7 +1946,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; } @@ -1912,7 +1965,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin( case BT_FUNC_STATUS_AGAIN: goto end; default: - abort(); + bt_common_abort(); } } @@ -1935,21 +1988,21 @@ end: bt_bool bt_self_message_iterator_is_interrupted( const struct bt_self_message_iterator *self_msg_iter) { - const struct bt_self_component_port_input_message_iterator *iterator = + const struct bt_message_iterator *iterator = (const void *) self_msg_iter; - BT_ASSERT_PRE_NON_NULL(iterator, "Message 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) +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) +void bt_message_iterator_put_ref( + const struct bt_message_iterator *iterator) { bt_object_put_ref(iterator); }