struct bt_self_component_port_input_message_iterator *iterator,
enum bt_self_component_port_input_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));
iterator->state = state;
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));
}
}
static
-bt_bool can_seek_ns_from_origin_true(
+enum bt_message_iterator_can_seek_beginning_status can_seek_ns_from_origin_true(
struct bt_self_component_port_input_message_iterator *iterator,
- int64_t ns_from_origin)
+ 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_self_component_port_input_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 *self_port,
struct bt_self_component_port_input_message_iterator **message_iterator)
{
- typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t)(
- void *, void *, void *);
+ typedef enum bt_component_class_message_iterator_initialize_method_status (*init_method_t)(
+ void *, void *, void *, void *);
init_method_t init_method = NULL;
struct bt_self_component_port_input_message_iterator *iterator =
(void *) upstream_comp_cls;
init_method =
- (init_method_t) src_comp_cls->methods.msg_iter_init;
+ (init_method_t) src_comp_cls->methods.msg_iter_initialize;
break;
}
case BT_COMPONENT_CLASS_TYPE_FILTER:
(void *) upstream_comp_cls;
init_method =
- (init_method_t) flt_comp_cls->methods.msg_iter_init;
+ (init_method_t) flt_comp_cls->methods.msg_iter_initialize;
break;
}
default:
}
if (init_method) {
- enum bt_component_class_message_iterator_init_method_status iter_status;
+ enum bt_component_class_message_iterator_initialize_method_status iter_status;
BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator);
- iter_status = init_method(iterator, upstream_comp,
+ iter_status = init_method(iterator, &iterator->config, upstream_comp,
upstream_port);
BT_LOGD("User method returned: status=%s",
bt_common_func_status_string(iter_status));
status = iter_status;
goto error;
}
+
+ iterator->config.frozen = true;
}
if (downstream_msg_iter) {
"%!+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(config, "Message iterator configuration");
+ BT_ASSERT_PRE_DEV_HOT(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.
{
enum bt_component_class_message_iterator_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_SELF_COMPONENT_PORT_INPUT_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_DBG(iterator->upstream_component);
+ BT_ASSERT_DBG(iterator->upstream_component->class);
BT_ASSERT_PRE_DEV(
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
* 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_ASSERT_DBG(iterator->state ==
BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
switch (status) {
return (void *) iterator->upstream_port;
}
-bt_bool bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
+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,
- int64_t ns_from_origin)
+ 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_NON_NULL(can_seek, "Result (output)");
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
BT_ASSERT_PRE(
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
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);
+
+ 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 == 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_self_component_port_input_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)
+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_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_NON_NULL(can_seek, "Result (output)");
BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
BT_ASSERT_PRE(
bt_component_borrow_graph(iterator->upstream_component)->config_state !=
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(
+ 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);
+ } else {
+ *can_seek = BT_FALSE;
+ status = BT_FUNC_STATUS_OK;
}
- return can;
+ return status;
}
static inline
iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET;
}
+static
+bool message_iterator_can_seek_beginning(
+ struct bt_self_component_port_input_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(
+ iterator, &can_seek);
+ if (status != BT_FUNC_STATUS_OK) {
+ can_seek = BT_FALSE;
+ }
+
+ return can_seek;
+}
+
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_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(message_iterator_can_seek_beginning(iterator),
"Message iterator cannot seek beginning: %!+i", iterator);
/*
return status;
}
+bt_bool
+bt_self_component_port_input_message_iterator_can_seek_forward(
+ bt_self_component_port_input_message_iterator *iterator)
+{
+ BT_ASSERT_PRE_NON_NULL(iterator, "Message 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.
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 = inactivity_msg->default_cs;
- BT_ASSERT(clk_snapshot);
+ BT_ASSERT_DBG(clk_snapshot);
break;
}
case BT_MESSAGE_TYPE_PACKET_BEGINNING:
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) {
stream_state = g_hash_table_lookup(stream_states,
event_msg->event->packet->stream);
- BT_ASSERT(stream_state);
+ 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;
}
struct bt_self_component_port_input_message_iterator *iterator,
int64_t ns_from_origin, GHashTable *stream_states)
{
- int status;
+ int status = BT_FUNC_STATUS_OK;
enum bt_self_component_port_input_message_iterator_state init_state =
iterator->state;
const struct bt_message *messages[MSG_BATCH_SIZE];
uint64_t i;
bool got_first = false;
- BT_ASSERT(iterator);
+ BT_ASSERT_DBG(iterator);
memset(&messages[0], 0, sizeof(messages[0]) * MSG_BATCH_SIZE);
/*
set_self_comp_port_input_msg_iterator_state(iterator,
BT_SELF_COMPONENT_PORT_INPUT_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_ASSERT_DBG(iterator->state ==
BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
switch (status) {
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]);
}
}
cc_offset_cycles, cc_freq, ns_from_origin, raw_value);
}
+static
+bool message_iterator_can_seek_ns_from_origin(
+ struct bt_self_component_port_input_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(
+ iterator, ns_from_origin, &can_seek);
+ if (status != BT_FUNC_STATUS_OK) {
+ can_seek = BT_FALSE;
+ }
+
+ return can_seek;
+}
enum bt_message_iterator_seek_ns_from_origin_status
bt_self_component_port_input_message_iterator_seek_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_ITER_HAS_STATE_TO_SEEK(iterator);
BT_GRAPH_CONFIGURATION_STATE_CONFIGURING,
"Graph is not configured: %!+g",
bt_component_borrow_graph(iterator->upstream_component));
+ /* The iterator must be able to seek ns from origin one way or another. */
BT_ASSERT_PRE(
- bt_self_component_port_input_message_iterator_can_seek_ns_from_origin(
- iterator, 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,
*/
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_component_class_message_iterator_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,
}
} 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_component_class_message_iterator_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);
* 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));
}