lib: strictly type function return status enumerations
[babeltrace.git] / src / lib / graph / iterator.c
index 31c4ec3ffc24da8be54f30b8b25f96aa9a3d7bd6..b1d57b592c1fdee2f6b9e34e8144236dbba85a33 100644 (file)
 #include <babeltrace2/trace-ir/packet-const.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-const.h>
+#include <babeltrace2/graph/message-iterator.h>
 #include <babeltrace2/graph/self-component-port-input-message-iterator.h>
 #include <babeltrace2/graph/port-output-message-iterator.h>
 #include <babeltrace2/graph/message-event-const.h>
@@ -58,6 +61,7 @@
 #include <babeltrace2/types.h>
 #include "common/assert.h"
 #include "lib/assert-pre.h"
+#include "lib/assert-post.h"
 #include <stdint.h>
 #include <inttypes.h>
 #include <stdlib.h>
@@ -77,6 +81,7 @@
 #include "message/stream.h"
 #include "message/packet.h"
 #include "message/stream-activity.h"
+#include "lib/func-status.h"
 
 /*
  * TODO: Use graph's state (number of active iterators, etc.) and
@@ -323,6 +328,8 @@ bt_self_component_port_input_message_iterator_create_initial(
                goto end;
        }
 
+       iterator->last_ns_from_origin = INT64_MIN;
+
        iterator->auto_seek.msgs = g_queue_new();
        if (!iterator->auto_seek.msgs) {
                BT_LOGE_STR("Failed to allocate a GQueue.");
@@ -412,7 +419,7 @@ struct bt_self_component_port_input_message_iterator *
 bt_self_component_port_input_message_iterator_create(
                struct bt_self_component_port_input *self_port)
 {
-       typedef enum bt_self_message_iterator_status (*init_method_t)(
+       typedef enum bt_component_class_message_iterator_init_method_status (*init_method_t)(
                        void *, void *, void *);
 
        init_method_t init_method = NULL;
@@ -481,14 +488,14 @@ bt_self_component_port_input_message_iterator_create(
        }
 
        if (init_method) {
-               int iter_status;
+               enum bt_component_class_message_iterator_init_method_status iter_status;
 
                BT_LIB_LOGD("Calling user's initialization method: %!+i", iterator);
                iter_status = init_method(iterator, upstream_comp,
                        upstream_port);
                BT_LOGD("User method returned: status=%s",
-                       bt_message_iterator_status_string(iter_status));
-               if (iter_status != BT_MESSAGE_ITERATOR_STATUS_OK) {
+                       bt_common_func_status_string(iter_status));
+               if (iter_status != BT_FUNC_STATUS_OK) {
                        BT_LOGW_STR("Initialization method failed.");
                        BT_OBJECT_PUT_REF_AND_RESET(iterator);
                        goto end;
@@ -528,12 +535,297 @@ void bt_self_message_iterator_set_data(
                "%!+i, user-data-addr=%p", iterator, data);
 }
 
-enum bt_message_iterator_status
+/*
+ * Validate that the default clock snapshot in `msg` doesn't make us go back in
+ * time.
+ */
+
+BT_ASSERT_POST_FUNC
+static
+bool clock_snapshots_are_monotonic_one(
+               struct bt_self_component_port_input_message_iterator *iterator,
+               const bt_message *msg)
+{
+       const struct bt_clock_snapshot *clock_snapshot = NULL;
+       bt_message_type message_type = bt_message_get_type(msg);
+       int64_t ns_from_origin;
+       enum bt_clock_snapshot_get_ns_from_origin_status clock_snapshot_status;
+
+       /*
+        * The default is true: if we can't figure out the clock snapshot
+        * (or there is none), assume it is fine.
+        */
+       bool result = true;
+
+       switch (message_type) {
+       case BT_MESSAGE_TYPE_EVENT:
+       {
+               struct bt_message_event *event_msg = (struct bt_message_event *) msg;
+               clock_snapshot = event_msg->default_cs;
+               break;
+       }
+       case BT_MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY:
+       {
+               struct bt_message_message_iterator_inactivity *inactivity_msg =
+                       (struct bt_message_message_iterator_inactivity *) msg;
+               clock_snapshot = inactivity_msg->default_cs;
+               break;
+       }
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+       case BT_MESSAGE_TYPE_PACKET_END:
+       {
+               struct bt_message_packet *packet_msg = (struct bt_message_packet *) msg;
+               clock_snapshot = packet_msg->default_cs;
+               break;
+       }
+       case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
+       case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
+       {
+               struct bt_message_stream_activity *str_act_msg =
+                       (struct bt_message_stream_activity *) msg;
+
+               if (str_act_msg->default_cs_state == BT_MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN) {
+                       clock_snapshot = str_act_msg->default_cs;
+               }
+               break;
+       }
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+       case BT_MESSAGE_TYPE_STREAM_END:
+               /* These messages don't have clock snapshots. */
+               goto end;
+       case BT_MESSAGE_TYPE_DISCARDED_EVENTS:
+       case BT_MESSAGE_TYPE_DISCARDED_PACKETS:
+       {
+               struct bt_message_discarded_items *discarded_msg =
+                       (struct bt_message_discarded_items *) msg;
+
+               clock_snapshot = discarded_msg->default_begin_cs;
+               break;
+       }
+       }
+
+       if (!clock_snapshot) {
+               goto end;
+       }
+
+       clock_snapshot_status = bt_clock_snapshot_get_ns_from_origin(clock_snapshot, &ns_from_origin);
+       if (clock_snapshot_status != BT_FUNC_STATUS_OK) {
+               goto end;
+       }
+
+       result = ns_from_origin >= iterator->last_ns_from_origin;
+       iterator->last_ns_from_origin = ns_from_origin;
+end:
+       return result;
+}
+
+BT_ASSERT_POST_FUNC
+static
+bool clock_snapshots_are_monotonic(
+               struct bt_self_component_port_input_message_iterator *iterator,
+               bt_message_array_const msgs, uint64_t msg_count)
+{
+       uint64_t i;
+       bool result;
+
+       for (i = 0; i < msg_count; i++) {
+               if (!clock_snapshots_are_monotonic_one(iterator, msgs[i])) {
+                       result = false;
+                       goto end;
+               }
+       }
+
+       result = true;
+
+end:
+       return result;
+}
+
+/*
+ * When a new stream begins, verify that the clock class tied to this
+ * stream is compatible with what we've seen before.
+ */
+
+BT_ASSERT_POST_FUNC
+static
+bool clock_classes_are_compatible_one(struct bt_self_component_port_input_message_iterator *iterator,
+               const struct bt_message *msg)
+{
+       enum bt_message_type message_type = bt_message_get_type(msg);
+       bool result;
+
+       if (message_type == BT_MESSAGE_TYPE_STREAM_BEGINNING) {
+               const struct bt_message_stream *stream_msg = (struct bt_message_stream *) msg;
+               const struct bt_clock_class *clock_class = stream_msg->stream->class->default_clock_class;
+               bt_uuid clock_class_uuid = NULL;
+
+               if (clock_class) {
+                       clock_class_uuid = bt_clock_class_get_uuid(clock_class);
+               }
+
+               switch (iterator->clock_expectation.type) {
+               case CLOCK_EXPECTATION_UNSET:
+                       /*
+                        * This is the first time we see a message with a clock
+                        * snapshot: record the properties of that clock, against
+                        * which we'll compare the clock properties of the following
+                        * messages.
+                        */
+
+                       if (!clock_class) {
+                               iterator->clock_expectation.type = CLOCK_EXPECTATION_NONE;
+                       } else if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_UNIX;
+                       } else if (clock_class_uuid) {
+                               iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_UUID;
+                               memcpy(iterator->clock_expectation.uuid, clock_class_uuid, BABELTRACE_UUID_LEN);
+                       } else {
+                               iterator->clock_expectation.type = CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID;
+                       }
+                       break;
+
+               case CLOCK_EXPECTATION_NONE:
+                       if (clock_class) {
+                               BT_ASSERT_POST_MSG("Expecting no clock class, got one: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+
+                       break;
+
+               case CLOCK_EXPECTATION_ORIGIN_UNIX:
+                       if (!clock_class) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class, got none.");
+                               result = false;
+                               goto end;
+                       }
+
+                       if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class with Unix epoch origin: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+                       break;
+
+               case CLOCK_EXPECTATION_ORIGIN_OTHER_UUID:
+                       if (!clock_class) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class, got none.");
+                               result = false;
+                               goto end;
+                       }
+
+                       if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+
+                       if (!clock_class_uuid) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class with UUID: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+
+                       if (bt_uuid_compare(iterator->clock_expectation.uuid, clock_class_uuid)) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class with UUID, got one "
+                                       "with a different UUID: %![cc-]+K, expected-uuid=%!u",
+                                       clock_class, iterator->clock_expectation.uuid);
+                               result = false;
+                               goto end;
+                       }
+                       break;
+
+               case CLOCK_EXPECTATION_ORIGIN_OTHER_NO_UUID:
+                       if (!clock_class) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class, got none.");
+                               result = false;
+                               goto end;
+                       }
+
+                       if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+
+                       if (clock_class_uuid) {
+                               BT_ASSERT_POST_MSG("Expecting a clock class without UUID: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+                       break;
+               }
+       }
+
+       result = true;
+
+end:
+       return result;
+}
+
+BT_ASSERT_POST_FUNC
+static
+bool clock_classes_are_compatible(
+               struct bt_self_component_port_input_message_iterator *iterator,
+               bt_message_array_const msgs, uint64_t msg_count)
+{
+       uint64_t i;
+       bool result;
+
+       for (i = 0; i < msg_count; i++) {
+               if (!clock_classes_are_compatible_one(iterator, msgs[i])) {
+                       result = false;
+                       goto end;
+               }
+       }
+
+       result = true;
+
+end:
+       return result;
+}
+
+/*
+ * Call the `next` method of the iterator.  Do some validation on the returned
+ * messages.
+ */
+
+static
+enum bt_component_class_message_iterator_next_method_status
+call_iterator_next_method(
+               struct bt_self_component_port_input_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;
+
+       BT_ASSERT(iterator->methods.next);
+       BT_LOGD_STR("Calling user's \"next\" method.");
+       status = iterator->methods.next(iterator, msgs, capacity, user_count);
+       BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64,
+               bt_common_func_status_string(status), *user_count);
+
+       if (status == BT_FUNC_STATUS_OK) {
+               BT_ASSERT_POST(clock_classes_are_compatible(iterator, msgs, *user_count),
+                       "Clocks are not compatible");
+               BT_ASSERT_POST(clock_snapshots_are_monotonic(iterator, msgs, *user_count),
+                       "Clock snapshots are not monotonic");
+       }
+
+       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_array_const *msgs, uint64_t *user_count)
 {
-       int status = BT_MESSAGE_ITERATOR_STATUS_OK;
+       enum bt_message_iterator_next_status status = BT_FUNC_STATUS_OK;
 
        BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
        BT_ASSERT_PRE_NON_NULL(msgs, "Message array (output)");
@@ -557,14 +849,10 @@ bt_self_component_port_input_message_iterator_next(
         * Call the user's "next" method to get the next messages
         * and status.
         */
-       BT_ASSERT(iterator->methods.next);
-       BT_LOGD_STR("Calling user's \"next\" method.");
        *user_count = 0;
-       status = iterator->methods.next(iterator,
+       status = (int) call_iterator_next_method(iterator,
                (void *) iterator->base.msgs->pdata, MSG_BATCH_SIZE,
                user_count);
-       BT_LOGD("User method returned: status=%s, msg-count=%" PRIu64,
-               bt_message_iterator_status_string(status), *user_count);
        if (status < 0) {
                BT_LOGW_STR("User method failed.");
                goto end;
@@ -583,16 +871,16 @@ bt_self_component_port_input_message_iterator_next(
                BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
 
        switch (status) {
-       case BT_MESSAGE_ITERATOR_STATUS_OK:
-               BT_ASSERT_PRE(*user_count <= MSG_BATCH_SIZE,
+       case BT_FUNC_STATUS_OK:
+               BT_ASSERT_POST(*user_count <= MSG_BATCH_SIZE,
                        "Invalid returned message count: greater than "
                        "batch size: count=%" PRIu64 ", batch-size=%u",
                        *user_count, MSG_BATCH_SIZE);
                *msgs = (void *) iterator->base.msgs->pdata;
                break;
-       case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
+       case BT_FUNC_STATUS_AGAIN:
                goto end;
-       case BT_MESSAGE_ITERATOR_STATUS_END:
+       case BT_FUNC_STATUS_END:
                set_self_comp_port_input_msg_iterator_state(iterator,
                        BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED);
                goto end;
@@ -605,13 +893,13 @@ end:
        return status;
 }
 
-enum bt_message_iterator_status bt_port_output_message_iterator_next(
+enum bt_message_iterator_next_status bt_port_output_message_iterator_next(
                struct bt_port_output_message_iterator *iterator,
                bt_message_array_const *msgs_to_user,
                uint64_t *count_to_user)
 {
-       enum bt_message_iterator_status status;
-       enum bt_graph_status graph_status;
+       enum bt_message_iterator_next_status status;
+       int graph_status;
 
        BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
        BT_ASSERT_PRE_NON_NULL(msgs_to_user, "Message array (output)");
@@ -621,14 +909,14 @@ enum bt_message_iterator_status bt_port_output_message_iterator_next(
        graph_status = bt_graph_consume_sink_no_check(iterator->graph,
                iterator->colander);
        switch (graph_status) {
-       case BT_GRAPH_STATUS_CANCELED:
-       case BT_GRAPH_STATUS_AGAIN:
-       case BT_GRAPH_STATUS_END:
-       case BT_GRAPH_STATUS_NOMEM:
+       case BT_FUNC_STATUS_CANCELED:
+       case BT_FUNC_STATUS_AGAIN:
+       case BT_FUNC_STATUS_END:
+       case BT_FUNC_STATUS_MEMORY_ERROR:
                status = (int) graph_status;
                break;
-       case BT_GRAPH_STATUS_OK:
-               status = BT_MESSAGE_ITERATOR_STATUS_OK;
+       case BT_FUNC_STATUS_OK:
+               status = BT_FUNC_STATUS_OK;
 
                /*
                 * On success, the colander sink moves the messages
@@ -640,7 +928,7 @@ enum bt_message_iterator_status bt_port_output_message_iterator_next(
                break;
        default:
                /* Other errors */
-               status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
+               status = BT_FUNC_STATUS_ERROR;
        }
 
        return status;
@@ -704,7 +992,7 @@ bt_port_output_message_iterator_create(struct bt_graph *graph,
        struct bt_component_class_sink *colander_comp_cls = NULL;
        struct bt_component *output_port_comp = NULL;
        struct bt_component_sink *colander_comp;
-       enum bt_graph_status graph_status;
+       int graph_status;
        struct bt_port_input *colander_in_port = NULL;
        struct bt_component_class_sink_colander_data colander_data;
        int ret;
@@ -759,16 +1047,15 @@ bt_port_output_message_iterator_create(struct bt_graph *graph,
         * class module does not use this level anyway since it belongs
         * to the library.
         */
-       graph_status =
-               bt_graph_add_sink_component_with_init_method_data(
+       graph_status = bt_graph_add_sink_component_with_init_method_data(
                        (void *) graph, colander_comp_cls,
                        "colander-36ac3409-b1a8-4d60-ab1f-4fdf341a8fb1",
                        NULL, &colander_data, BT_LOGGING_LEVEL_NONE,
                        (void *) &iterator->colander);
-       if (graph_status != BT_GRAPH_STATUS_OK) {
+       if (graph_status != BT_FUNC_STATUS_OK) {
                BT_LIB_LOGW("Cannot add colander sink component to graph: "
                        "%1[graph-]+g, status=%s", graph,
-                       bt_graph_status_string(graph_status));
+                       bt_common_func_status_string(graph_status));
                goto error;
        }
 
@@ -782,11 +1069,11 @@ bt_port_output_message_iterator_create(struct bt_graph *graph,
        BT_ASSERT(colander_in_port);
        graph_status = bt_graph_connect_ports(graph,
                output_port, colander_in_port, NULL);
-       if (graph_status != BT_GRAPH_STATUS_OK) {
+       if (graph_status != BT_FUNC_STATUS_OK) {
                BT_LIB_LOGW("Cannot add colander sink component to graph: "
                        "%![graph-]+g, %![comp-]+c, status=%s", graph,
                        iterator->colander,
-                       bt_graph_status_string(graph_status));
+                       bt_common_func_status_string(graph_status));
                goto error;
        }
 
@@ -802,10 +1089,10 @@ bt_port_output_message_iterator_create(struct bt_graph *graph,
 
        /* Also set the graph as being configured. */
        graph_status = bt_graph_configure(graph);
-       if (graph_status != BT_GRAPH_STATUS_OK) {
+       if (graph_status != BT_FUNC_STATUS_OK) {
                BT_LIB_LOGW("Cannot configure graph after having added colander: "
                        "%![graph-]+g, status=%s", graph,
-                       bt_graph_status_string(graph_status));
+                       bt_common_func_status_string(graph_status));
                goto error;
        }
        goto end;
@@ -896,23 +1183,23 @@ bt_bool 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,
-               enum bt_message_iterator_status status)
+               int status)
 {
        enum bt_self_component_port_input_message_iterator_state new_state = 0;
 
        /* Set iterator's state depending on seeking status */
        switch (status) {
-       case BT_MESSAGE_ITERATOR_STATUS_OK:
+       case BT_FUNC_STATUS_OK:
                new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE;
                break;
-       case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
+       case BT_FUNC_STATUS_AGAIN:
                new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_LAST_SEEKING_RETURNED_AGAIN;
                break;
-       case BT_MESSAGE_ITERATOR_STATUS_ERROR:
-       case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
+       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;
                break;
-       case BT_MESSAGE_ITERATOR_STATUS_END:
+       case BT_FUNC_STATUS_END:
                new_state = BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ENDED;
                break;
        default:
@@ -922,11 +1209,19 @@ void set_iterator_state_after_seeking(
        set_self_comp_port_input_msg_iterator_state(iterator, new_state);
 }
 
-enum bt_message_iterator_status
+static
+void reset_iterator_expectations(
+               struct bt_self_component_port_input_message_iterator *iterator)
+{
+       iterator->last_ns_from_origin = INT64_MIN;
+       iterator->clock_expectation.type = CLOCK_EXPECTATION_UNSET;
+}
+
+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)
 {
-       int status;
+       enum bt_message_iterator_seek_beginning_status status;
 
        BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
        BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
@@ -939,23 +1234,29 @@ bt_self_component_port_input_message_iterator_seek_beginning(
                bt_self_component_port_input_message_iterator_can_seek_beginning(
                        iterator),
                "Message iterator cannot seek beginning: %!+i", iterator);
+
+       /*
+        * We are seeking, reset our expectations about how the following
+        * messages should look like.
+        */
+       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);
        status = iterator->methods.seek_beginning(iterator);
        BT_LOGD("User method returned: status=%s",
-               bt_message_iterator_status_string(status));
-       BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK ||
-               status == BT_MESSAGE_ITERATOR_STATUS_ERROR ||
-               status == BT_MESSAGE_ITERATOR_STATUS_NOMEM ||
-               status == BT_MESSAGE_ITERATOR_STATUS_AGAIN,
+               bt_common_func_status_string(status));
+       BT_ASSERT_POST(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_self_message_iterator_status_string(status));
+               iterator, bt_common_func_status_string(status));
        set_iterator_state_after_seeking(iterator, status);
        return status;
 }
 
-
 /*
  * Structure used to record the state of a given stream during the fast-forward
  * phase of an auto-seek.
@@ -1028,12 +1329,12 @@ void destroy_auto_seek_stream_states(GHashTable *stream_states)
  */
 
 static inline
-enum bt_message_iterator_status auto_seek_handle_message(
+int auto_seek_handle_message(
                struct bt_self_component_port_input_message_iterator *iterator,
                int64_t ns_from_origin, const struct bt_message *msg,
                bool *got_first, GHashTable *stream_states)
 {
-       enum bt_message_iterator_status status = BT_MESSAGE_ITERATOR_STATUS_OK;
+       int status = BT_FUNC_STATUS_OK;
        int64_t msg_ns_from_origin;
        const struct bt_clock_snapshot *clk_snapshot = NULL;
        int ret;
@@ -1048,7 +1349,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
                        (const void *) msg;
 
                clk_snapshot = event_msg->default_cs;
-               BT_ASSERT_PRE(clk_snapshot,
+               BT_ASSERT_POST(clk_snapshot,
                        "Event message has no default clock snapshot: %!+n",
                        event_msg);
                break;
@@ -1069,7 +1370,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
                        (const void *) msg;
 
                clk_snapshot = packet_msg->default_cs;
-               BT_ASSERT_PRE(clk_snapshot,
+               BT_ASSERT_POST(clk_snapshot,
                        "Packet message has no default clock snapshot: %!+n",
                        packet_msg);
                break;
@@ -1080,7 +1381,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
                struct bt_message_discarded_items *msg_disc_items =
                        (void *) msg;
 
-               BT_ASSERT_PRE(msg_disc_items->default_begin_cs &&
+               BT_ASSERT_POST(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);
@@ -1088,7 +1389,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
                        msg_disc_items->default_begin_cs,
                        &msg_ns_from_origin);
                if (ret) {
-                       status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
+                       status = BT_FUNC_STATUS_ERROR;
                        goto end;
                }
 
@@ -1101,7 +1402,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
                        msg_disc_items->default_end_cs,
                        &msg_ns_from_origin);
                if (ret) {
-                       status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
+                       status = BT_FUNC_STATUS_ERROR;
                        goto end;
                }
 
@@ -1121,7 +1422,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
                                msg_disc_items->default_end_cs->clock_class,
                                ns_from_origin, &new_begin_raw_value);
                        if (ret) {
-                               status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
+                               status = BT_FUNC_STATUS_ERROR;
                                goto end;
                        }
 
@@ -1205,7 +1506,7 @@ enum bt_message_iterator_status auto_seek_handle_message(
        ret = bt_clock_snapshot_get_ns_from_origin(clk_snapshot,
                &msg_ns_from_origin);
        if (ret) {
-               status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
+               status = BT_FUNC_STATUS_ERROR;
                goto end;
        }
 
@@ -1225,7 +1526,7 @@ skip_msg:
                /* Update stream's state: stream began. */
                stream_state = create_auto_seek_stream_state();
                if (!stream_state) {
-                       status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                       status = BT_FUNC_STATUS_MEMORY_ERROR;
                        goto end;
                }
 
@@ -1324,12 +1625,12 @@ push_msg:
        msg = NULL;
 
 end:
-       BT_ASSERT(!msg || status != BT_MESSAGE_ITERATOR_STATUS_OK);
+       BT_ASSERT(!msg || status != BT_FUNC_STATUS_OK);
        return status;
 }
 
 static
-enum bt_message_iterator_status find_message_ge_ns_from_origin(
+int find_message_ge_ns_from_origin(
                struct bt_self_component_port_input_message_iterator *iterator,
                int64_t ns_from_origin, GHashTable *stream_states)
 {
@@ -1358,11 +1659,8 @@ enum bt_message_iterator_status find_message_ge_ns_from_origin(
                 * Call the user's "next" method to get the next
                 * messages and status.
                 */
-               BT_LOGD_STR("Calling user's \"next\" method.");
-               status = iterator->methods.next(iterator,
+               status = call_iterator_next_method(iterator,
                        &messages[0], MSG_BATCH_SIZE, &user_count);
-               BT_LOGD("User method returned: status=%s",
-                       bt_message_iterator_status_string(status));
 
                /*
                 * The user's "next" method must not do any action which
@@ -1372,16 +1670,16 @@ enum bt_message_iterator_status find_message_ge_ns_from_origin(
                        BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_ACTIVE);
 
                switch (status) {
-               case BT_MESSAGE_ITERATOR_STATUS_OK:
-                       BT_ASSERT_PRE(user_count <= MSG_BATCH_SIZE,
+               case BT_FUNC_STATUS_OK:
+                       BT_ASSERT_POST(user_count <= MSG_BATCH_SIZE,
                                "Invalid returned message count: greater than "
                                "batch size: count=%" PRIu64 ", batch-size=%u",
                                user_count, MSG_BATCH_SIZE);
                        break;
-               case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
-               case BT_MESSAGE_ITERATOR_STATUS_ERROR:
-               case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
-               case BT_MESSAGE_ITERATOR_STATUS_END:
+               case BT_FUNC_STATUS_AGAIN:
+               case BT_FUNC_STATUS_ERROR:
+               case BT_FUNC_STATUS_MEMORY_ERROR:
+               case BT_FUNC_STATUS_END:
                        goto end;
                default:
                        abort();
@@ -1398,7 +1696,7 @@ enum bt_message_iterator_status find_message_ge_ns_from_origin(
                        status = auto_seek_handle_message(iterator,
                                ns_from_origin, messages[i], &got_first,
                                stream_states);
-                       if (status == BT_MESSAGE_ITERATOR_STATUS_OK) {
+                       if (status == BT_FUNC_STATUS_OK) {
                                /* Message was either pushed or moved */
                                messages[i] = NULL;
                        } else {
@@ -1426,7 +1724,7 @@ end:
  */
 
 static
-enum bt_self_message_iterator_status post_auto_seek_next(
+enum bt_component_class_message_iterator_next_method_status post_auto_seek_next(
                struct bt_self_component_port_input_message_iterator *iterator,
                bt_message_array_const msgs, uint64_t capacity,
                uint64_t *count)
@@ -1453,7 +1751,7 @@ enum bt_self_message_iterator_status post_auto_seek_next(
                iterator->auto_seek.original_next_callback = NULL;
        }
 
-       return BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
+       return BT_FUNC_STATUS_OK;
 }
 
 static inline
@@ -1470,7 +1768,7 @@ int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class,
 }
 
 
-enum bt_message_iterator_status
+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,
                int64_t ns_from_origin)
@@ -1493,6 +1791,12 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
        set_self_comp_port_input_msg_iterator_state(iterator,
                BT_SELF_COMPONENT_PORT_INPUT_MESSAGE_ITERATOR_STATE_SEEKING);
 
+       /*
+        * We are seeking, reset our expectations about how the following
+        * messages should look like.
+        */
+       reset_iterator_expectations(iterator);
+
        if (iterator->methods.seek_ns_from_origin) {
                /* The iterator knows how to seek to a particular time, let it handle this. */
                BT_LIB_LOGD("Calling user's \"seek nanoseconds from origin\" method: "
@@ -1500,14 +1804,13 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                status = iterator->methods.seek_ns_from_origin(iterator,
                        ns_from_origin);
                BT_LOGD("User method returned: status=%s",
-                       bt_message_iterator_status_string(status));
-               BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK ||
-                       status == BT_MESSAGE_ITERATOR_STATUS_ERROR ||
-                       status == BT_MESSAGE_ITERATOR_STATUS_NOMEM ||
-                       status == BT_MESSAGE_ITERATOR_STATUS_AGAIN,
+                       bt_common_func_status_string(status));
+               BT_ASSERT_POST(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_self_message_iterator_status_string(status));
+                       iterator, bt_common_func_status_string(status));
        } else {
                /*
                 * The iterator doesn't know how to seek to a particular time.  We will
@@ -1519,20 +1822,19 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                        iterator);
                status = iterator->methods.seek_beginning(iterator);
                BT_LOGD("User method returned: status=%s",
-                       bt_message_iterator_status_string(status));
-               BT_ASSERT_PRE(status == BT_MESSAGE_ITERATOR_STATUS_OK ||
-                       status == BT_MESSAGE_ITERATOR_STATUS_ERROR ||
-                       status == BT_MESSAGE_ITERATOR_STATUS_NOMEM ||
-                       status == BT_MESSAGE_ITERATOR_STATUS_AGAIN,
+                       bt_common_func_status_string(status));
+               BT_ASSERT_POST(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_self_message_iterator_status_string(status));
+                       iterator, bt_common_func_status_string(status));
                switch (status) {
-               case BT_MESSAGE_ITERATOR_STATUS_OK:
+               case BT_FUNC_STATUS_OK:
                        break;
-               case BT_MESSAGE_ITERATOR_STATUS_ERROR:
-               case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
-               case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
+               case BT_FUNC_STATUS_ERROR:
+               case BT_FUNC_STATUS_MEMORY_ERROR:
+               case BT_FUNC_STATUS_AGAIN:
                        goto end;
                default:
                        abort();
@@ -1553,15 +1855,15 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                stream_states = create_auto_seek_stream_states();
                if (!stream_states) {
                        BT_LOGE_STR("Failed to allocate one GHashTable.");
-                       status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                       status = BT_FUNC_STATUS_MEMORY_ERROR;
                        goto end;
                }
 
                status = find_message_ge_ns_from_origin(iterator,
                        ns_from_origin, stream_states);
                switch (status) {
-               case BT_MESSAGE_ITERATOR_STATUS_OK:
-               case BT_MESSAGE_ITERATOR_STATUS_END:
+               case BT_FUNC_STATUS_OK:
+               case BT_FUNC_STATUS_END:
                {
                        GHashTableIter iter;
                        gpointer key, value;
@@ -1584,7 +1886,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                                if (clock_raw_value_from_ns_from_origin(clock_class, ns_from_origin, &raw_value) != 0) {
                                        BT_LIB_LOGW("Could not convert nanoseconds from origin to clock value: ns-from-origin=%" PRId64 ", %![cc-]+K",
                                                ns_from_origin, clock_class);
-                                       status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
+                                       status = BT_FUNC_STATUS_ERROR;
                                        goto end;
                                }
 
@@ -1595,7 +1897,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                                        msg = bt_message_packet_beginning_create_with_default_clock_snapshot(
                                                (bt_self_message_iterator *) iterator, stream_state->packet, raw_value);
                                        if (!msg) {
-                                               status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                                               status = BT_FUNC_STATUS_MEMORY_ERROR;
                                                goto end;
                                        }
 
@@ -1606,7 +1908,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                                        msg = bt_message_stream_activity_beginning_create(
                                                (bt_self_message_iterator *) iterator, stream);
                                        if (!msg) {
-                                               status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                                               status = BT_FUNC_STATUS_MEMORY_ERROR;
                                                goto end;
                                        }
 
@@ -1619,7 +1921,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                                        msg = bt_message_stream_beginning_create(
                                                (bt_self_message_iterator *) iterator, stream);
                                        if (!msg) {
-                                               status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                                               status = BT_FUNC_STATUS_MEMORY_ERROR;
                                                goto end;
                                        }
 
@@ -1645,24 +1947,30 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                        }
 
                        /*
-                        * `BT_MESSAGE_ITERATOR_STATUS_END` becomes
-                        * `BT_MESSAGE_ITERATOR_STATUS_OK`: the next
+                        * `BT_FUNC_STATUS_END` becomes
+                        * `BT_FUNC_STATUS_OK`: the next
                         * time this iterator's "next" method is called,
                         * it will return
-                        * `BT_MESSAGE_ITERATOR_STATUS_END`.
+                        * `BT_FUNC_STATUS_END`.
                         */
-                       status = BT_MESSAGE_ITERATOR_STATUS_OK;
+                       status = BT_FUNC_STATUS_OK;
                        break;
                }
-               case BT_MESSAGE_ITERATOR_STATUS_ERROR:
-               case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
-               case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
+               case BT_FUNC_STATUS_ERROR:
+               case BT_FUNC_STATUS_MEMORY_ERROR:
+               case BT_FUNC_STATUS_AGAIN:
                        goto end;
                default:
                        abort();
                }
        }
 
+       /*
+        * The following messages returned by the next method (including
+        * post_auto_seek_next) must be after (or at) `ns_from_origin`.
+        */
+       iterator->last_ns_from_origin = ns_from_origin;
+
 end:
        if (stream_states) {
                destroy_auto_seek_stream_states(stream_states);
@@ -1705,7 +2013,8 @@ bt_bool bt_port_output_message_iterator_can_seek_beginning(
                        iterator));
 }
 
-enum bt_message_iterator_status bt_port_output_message_iterator_seek_ns_from_origin(
+enum bt_message_iterator_seek_ns_from_origin_status
+bt_port_output_message_iterator_seek_ns_from_origin(
                struct bt_port_output_message_iterator *iterator,
                int64_t ns_from_origin)
 {
@@ -1715,7 +2024,8 @@ enum bt_message_iterator_status bt_port_output_message_iterator_seek_ns_from_ori
                ns_from_origin);
 }
 
-enum bt_message_iterator_status bt_port_output_message_iterator_seek_beginning(
+enum bt_message_iterator_seek_beginning_status
+bt_port_output_message_iterator_seek_beginning(
                struct bt_port_output_message_iterator *iterator)
 {
        BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
This page took 0.038214 seconds and 4 git commands to generate.