#include <stdlib.h>
#include "component-class.h"
-#include "component-class-sink-colander.h"
#include "component.h"
#include "component-sink.h"
#include "component-source.h"
}
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_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_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 =
struct bt_component *comp;
struct bt_component *upstream_comp;
struct bt_component_class *upstream_comp_cls;
+ int status;
+ BT_ASSERT_PRE_NON_NULL(message_iterator, "Created message iterator");
BT_ASSERT_PRE_NON_NULL(port, "Input port");
comp = bt_port_borrow_component_inline(port);
BT_ASSERT_PRE(bt_port_is_connected(port),
BT_LIB_LOGE_APPEND_CAUSE(
"Failed to allocate one self component input port "
"message iterator.");
+ status = BT_FUNC_STATUS_MEMORY_ERROR;
goto error;
}
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;
}
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_self_component_port_input_message_iterator_can_seek_beginning_method)
can_seek_beginning_true;
}
(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));
"%![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) {
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_status
bt_self_component_port_input_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_self_component_port_input_message_iterator **message_iterator)
{
BT_ASSERT_PRE_NON_NULL(self_msg_iter, "Message iterator");
return create_self_component_input_port_message_iterator(self_msg_iter,
- input_port);
+ input_port, message_iterator);
}
-struct bt_self_component_port_input_message_iterator *
+bt_self_component_port_input_message_iterator_create_from_sink_component_status
bt_self_component_port_input_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_self_component_port_input_message_iterator **message_iterator)
{
BT_ASSERT_PRE_NON_NULL(self_comp, "Sink component");
return create_self_component_input_port_message_iterator(NULL,
- input_port);
+ input_port, message_iterator);
}
void *bt_self_message_iterator_get_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(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.
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 =
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.
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];
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);