/*
+ * SPDX-License-Identifier: MIT
+ *
* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * 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"
#include "lib/trace-ir/clock-class.h"
#include "lib/trace-ir/clock-snapshot.h"
#include <babeltrace2/trace-ir/field.h>
-#include <babeltrace2/trace-ir/event-const.h>
+#include <babeltrace2/trace-ir/event.h>
#include "lib/trace-ir/event.h"
-#include <babeltrace2/trace-ir/packet-const.h>
+#include <babeltrace2/trace-ir/packet.h>
#include "lib/trace-ir/packet.h"
#include "lib/trace-ir/stream.h"
-#include <babeltrace2/trace-ir/clock-class-const.h>
-#include <babeltrace2/trace-ir/stream-class-const.h>
-#include <babeltrace2/trace-ir/stream-const.h>
-#include <babeltrace2/graph/connection-const.h>
-#include <babeltrace2/graph/component-const.h>
-#include <babeltrace2/graph/component-sink-const.h>
-#include <babeltrace2/graph/message-const.h>
-#include <babeltrace2/graph/message-iterator.h>
-#include <babeltrace2/graph/self-component-port-input-message-iterator.h>
-#include <babeltrace2/graph/message-event-const.h>
-#include <babeltrace2/graph/message-message-iterator-inactivity-const.h>
-#include <babeltrace2/graph/message-packet-beginning.h>
-#include <babeltrace2/graph/message-packet-beginning-const.h>
-#include <babeltrace2/graph/message-packet-end-const.h>
-#include <babeltrace2/graph/message-stream-beginning.h>
-#include <babeltrace2/graph/message-stream-beginning-const.h>
-#include <babeltrace2/graph/message-stream-end-const.h>
-#include <babeltrace2/graph/port-const.h>
+#include <babeltrace2/trace-ir/clock-class.h>
+#include <babeltrace2/trace-ir/stream-class.h>
+#include <babeltrace2/trace-ir/stream.h>
+#include <babeltrace2/graph/connection.h>
+#include <babeltrace2/graph/component.h>
+#include <babeltrace2/graph/message.h>
+#include <babeltrace2/graph/self-component.h>
+#include <babeltrace2/graph/port.h>
#include <babeltrace2/graph/graph.h>
-#include <babeltrace2/graph/graph-const.h>
+#include <babeltrace2/graph/message-iterator.h>
#include <babeltrace2/types.h>
#include "common/assert.h"
-#include "lib/assert-pre.h"
-#include "lib/assert-post.h"
+#include "lib/assert-cond.h"
#include <stdint.h>
#include <inttypes.h>
+#include <stdbool.h>
#include <stdlib.h>
#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 "message-iterator-class.h"
#include "message/discarded-items.h"
#include "message/event.h"
#include "message/iterator.h"
#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);
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) {
/*
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));
}
}
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;
+ 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;
- 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;
+ 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;
- method = (method_t) flt_comp_cls->methods.msg_iter_finalize;
- break;
- }
- default:
- /* Unreachable */
- abort();
- }
+ if (method) {
+ const bt_error *saved_error;
- if (method) {
- BT_LIB_LOGD("Calling user's finalization method: %!+i",
- iterator);
- method(iterator);
+ saved_error = bt_current_thread_take_error();
+
+ BT_LIB_LOGD("Calling user's finalization method: %!+i",
+ iterator);
+ method(iterator);
+
+ 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;
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:
}
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);
}
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_ns_from_origin_true(
+ struct bt_message_iterator *iterator,
+ int64_t ns_from_origin, bt_bool *can_seek)
{
- return BT_TRUE;
+ *can_seek = BT_TRUE;
+
+ return BT_FUNC_STATUS_OK;
}
static
-bt_bool can_seek_beginning_true(
- struct bt_self_component_port_input_message_iterator *iterator)
+enum bt_message_iterator_can_seek_beginning_status can_seek_beginning_true(
+ struct bt_message_iterator *iterator,
+ bt_bool *can_seek)
{
- return BT_TRUE;
+ *can_seek = BT_TRUE;
+
+ return BT_FUNC_STATUS_OK;
}
static
-struct bt_self_component_port_input_message_iterator *
-create_self_component_input_port_message_iterator(
+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 *self_port,
+ 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 *);
-
- 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(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 ==
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;
}
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.");
+ status = BT_FUNC_STATUS_MEMORY_ERROR;
goto error;
}
iterator->auto_seek.msgs = g_queue_new();
if (!iterator->auto_seek.msgs) {
BT_LIB_LOGE_APPEND_CAUSE("Failed to allocate a GQueue.");
+ 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_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;
}
- 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) {
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;
}
-struct bt_self_component_port_input_message_iterator *
-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 *input_port,
+ 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);
+ input_port, message_iterator, __func__);
}
-struct bt_self_component_port_input_message_iterator *
-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 *input_port,
+ 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);
+ 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);
}
+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_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;
{
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:
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;
}
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;
* 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);
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;
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;
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;
}
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;
}
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);
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;
}
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;
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;
* 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",
* 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);
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:
}
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_port_output *bt_self_message_iterator_borrow_port(
+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;
}
-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)
+#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_message_iterator_can_seek_ns_from_origin(
+ struct bt_message_iterator *iterator,
+ int64_t ns_from_origin, bt_bool *can_seek)
{
- bt_bool can = BT_FALSE;
+ enum bt_message_iterator_can_seek_ns_from_origin_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_ns_from_origin) {
- can = iterator->methods.can_seek_ns_from_origin(iterator,
- ns_from_origin);
- goto end;
+ /*
+ * Initialize to an invalid value, so we can post-assert that
+ * the method returned a valid value.
+ */
+ *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_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);
+
+ 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"
+
+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"
+
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);
/*
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: "
return status;
}
+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.
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)
{
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:
(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;
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:
(const void *) 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;
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,
+ 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(
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) {
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;
}
/* 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) {
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;
/* 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) {
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);
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)) {
break;
}
- bt_object_put_no_null_check(msg);
+ bt_object_put_ref_no_null_check(msg);
msg = NULL;
goto end;
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) {
/*
* 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);
case BT_FUNC_STATUS_END:
goto end;
default:
- abort();
+ bt_common_abort();
}
for (i = 0; i < user_count; i++) {
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;
}
*/
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)
{
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"
+
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
*/
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: "
}
} 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,
case BT_FUNC_STATUS_AGAIN:
goto end;
default:
- abort();
+ bt_common_abort();
}
/*
* 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));
}
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;
}
case BT_FUNC_STATUS_AGAIN:
goto end;
default:
- abort();
+ bt_common_abort();
}
}
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);
}