lib: internal: add BT_ASSERT_POST()
[babeltrace.git] / src / lib / graph / iterator.c
index 1303003f4963d7dbcc6f67963f89004590d2c0b8..08a49cfeee34136967256f7cbb2e4848e07692af 100644 (file)
  */
 
 #define BT_LOG_TAG "LIB/MSG-ITER"
-#include "lib/lib-logging.h"
+#include "lib/logging.h"
 
 #include "compat/compiler.h"
+#include "compat/glib.h"
 #include "lib/trace-ir/clock-class.h"
 #include "lib/trace-ir/clock-snapshot.h"
 #include <babeltrace2/trace-ir/field.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>
+#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-activity-beginning.h>
+#include <babeltrace2/graph/message-stream-activity-beginning-const.h>
+#include <babeltrace2/graph/message-stream-activity-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>
@@ -144,14 +151,14 @@ void bt_self_component_port_input_message_iterator_destroy(struct bt_object *obj
                iterator->connection = NULL;
        }
 
-       if (iterator->auto_seek_msgs) {
-               while (!g_queue_is_empty(iterator->auto_seek_msgs)) {
+       if (iterator->auto_seek.msgs) {
+               while (!g_queue_is_empty(iterator->auto_seek.msgs)) {
                        bt_object_put_no_null_check(
-                               g_queue_pop_tail(iterator->auto_seek_msgs));
+                               g_queue_pop_tail(iterator->auto_seek.msgs));
                }
 
-               g_queue_free(iterator->auto_seek_msgs);
-               iterator->auto_seek_msgs = NULL;
+               g_queue_free(iterator->auto_seek.msgs);
+               iterator->auto_seek.msgs = NULL;
        }
 
        destroy_base_message_iterator(obj);
@@ -316,8 +323,10 @@ bt_self_component_port_input_message_iterator_create_initial(
                goto end;
        }
 
-       iterator->auto_seek_msgs = g_queue_new();
-       if (!iterator->auto_seek_msgs) {
+       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.");
                ret = -1;
                goto end;
@@ -521,6 +530,289 @@ void bt_self_message_iterator_set_data(
                "%!+i, user-data-addr=%p", iterator, data);
 }
 
+/*
+ * Validate that the default clock snapshot in `msg` doesn't make us go back in
+ * time.
+ */
+
+BT_ASSERT_PRE_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_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_CLOCK_SNAPSHOT_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_PRE_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_PRE_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_PRE_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_PRE_MSG("Expecting a clock class, got none.");
+                               result = false;
+                               goto end;
+                       }
+
+                       if (!bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               BT_ASSERT_PRE_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_PRE_MSG("Expecting a clock class, got none.");
+                               result = false;
+                               goto end;
+                       }
+
+                       if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               BT_ASSERT_PRE_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+
+                       if (!clock_class_uuid) {
+                               BT_ASSERT_PRE_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_PRE_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_PRE_MSG("Expecting a clock class, got none.");
+                               result = false;
+                               goto end;
+                       }
+
+                       if (bt_clock_class_origin_is_unix_epoch(clock_class)) {
+                               BT_ASSERT_PRE_MSG("Expecting a clock class without Unix epoch origin: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+
+                       if (clock_class_uuid) {
+                               BT_ASSERT_PRE_MSG("Expecting a clock class without UUID: %![cc-]+K",
+                                       clock_class);
+                               result = false;
+                               goto end;
+                       }
+                       break;
+               }
+       }
+
+       result = true;
+
+end:
+       return result;
+}
+
+BT_ASSERT_PRE_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
+bt_message_iterator_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)
+{
+       bt_message_iterator_status status;
+
+       BT_ASSERT(iterator->methods.next);
+       BT_LOGD_STR("Calling user's \"next\" method.");
+
+       status = iterator->methods.next(iterator, msgs, capacity, user_count);
+
+       if (status == BT_MESSAGE_ITERATOR_STATUS_OK) {
+               BT_ASSERT_PRE(clock_classes_are_compatible(iterator, msgs, *user_count),
+                       "Clocks are not compatible");
+               BT_ASSERT_PRE(clock_snapshots_are_monotonic(iterator, msgs, *user_count),
+                       "Clock snapshots are not monotonic");
+       }
+
+       return status;
+}
+
 enum bt_message_iterator_status
 bt_self_component_port_input_message_iterator_next(
                struct bt_self_component_port_input_message_iterator *iterator,
@@ -550,10 +842,8 @@ 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 = 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,
@@ -915,6 +1205,14 @@ void set_iterator_state_after_seeking(
        set_self_comp_port_input_msg_iterator_state(iterator, new_state);
 }
 
+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_status
 bt_self_component_port_input_message_iterator_seek_beginning(
                struct bt_self_component_port_input_message_iterator *iterator)
@@ -932,6 +1230,13 @@ 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);
@@ -948,11 +1253,83 @@ bt_self_component_port_input_message_iterator_seek_beginning(
        return status;
 }
 
+
+/*
+ * Structure used to record the state of a given stream during the fast-forward
+ * phase of an auto-seek.
+ */
+struct auto_seek_stream_state {
+       /*
+        * Value representing which step of this timeline we are at.
+        *
+        *      time --->
+        *   [SB]  1  [SAB]  2  [PB]  3  [PE]  2  [SAE]  1  [SE]
+        *
+        * At each point in the timeline, the messages we need to replicate are:
+        *
+        *   1: Stream beginning
+        *   2: Stream beginning, stream activity beginning
+        *   3: Stream beginning, stream activity beginning, packet beginning
+        *
+        * Before "Stream beginning" and after "Stream end", we don't need to
+        * replicate anything as the stream doesn't exist.
+        */
+       enum {
+               AUTO_SEEK_STREAM_STATE_STREAM_BEGAN,
+               AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN,
+               AUTO_SEEK_STREAM_STATE_PACKET_BEGAN,
+       } state;
+
+       /*
+        * If `state` is AUTO_SEEK_STREAM_STATE_PACKET_BEGAN, the packet we are
+        * in.  This is a weak reference, since the packet will always be
+        * alive by the time we use it.
+        */
+       struct bt_packet *packet;
+};
+
+static
+struct auto_seek_stream_state *create_auto_seek_stream_state(void)
+{
+       return g_new0(struct auto_seek_stream_state, 1);
+}
+
+static
+void destroy_auto_seek_stream_state(void *ptr)
+{
+       g_free(ptr);
+}
+
+static
+GHashTable *create_auto_seek_stream_states(void)
+{
+       return g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL,
+               destroy_auto_seek_stream_state);
+}
+
+static
+void destroy_auto_seek_stream_states(GHashTable *stream_states)
+{
+       g_hash_table_destroy(stream_states);
+}
+
+/*
+ * Handle one message while we are in the fast-forward phase of an auto-seek.
+ *
+ * Sets `*got_first` to true if the message's timestamp is greater or equal to
+ * `ns_from_origin`.  In other words, if this is the first message after our
+ * seek point.
+ *
+ * `stream_states` is an hash table of `bt_stream *` (weak reference) to
+ * `struct auto_seek_stream_state` used to keep the state of each stream
+ * during the fast-forward.
+ */
+
 static inline
 enum bt_message_iterator_status 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)
+               bool *got_first, GHashTable *stream_states)
 {
        enum bt_message_iterator_status status = BT_MESSAGE_ITERATOR_STATUS_OK;
        int64_t msg_ns_from_origin;
@@ -1136,12 +1513,112 @@ enum bt_message_iterator_status auto_seek_handle_message(
        }
 
 skip_msg:
+       /* This message won't be sent downstream. */
+       switch (msg->type) {
+       case BT_MESSAGE_TYPE_STREAM_BEGINNING:
+       {
+               const struct bt_message_stream *stream_msg = (const void *) msg;
+               struct auto_seek_stream_state *stream_state;
+
+               /* Update stream's state: stream began. */
+               stream_state = create_auto_seek_stream_state();
+               if (!stream_state) {
+                       status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                       goto end;
+               }
+
+               stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN;
+
+               BT_ASSERT(!bt_g_hash_table_contains(stream_states, stream_msg->stream));
+               g_hash_table_insert(stream_states, stream_msg->stream, stream_state);
+               break;
+       }
+       case BT_MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING:
+       {
+               const struct bt_message_stream_activity *stream_act_msg =
+                       (const void *) msg;
+               struct auto_seek_stream_state *stream_state;
+
+               /* Update stream's state: stream activity began. */
+               stream_state = g_hash_table_lookup(stream_states, stream_act_msg->stream);
+               BT_ASSERT(stream_state);
+
+               BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN);
+               stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN;
+               BT_ASSERT(!stream_state->packet);
+               break;
+       }
+       case BT_MESSAGE_TYPE_PACKET_BEGINNING:
+       {
+               const struct bt_message_packet *packet_msg =
+                       (const void *) msg;
+               struct auto_seek_stream_state *stream_state;
+
+               /* 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_ACTIVITY_BEGAN);
+               stream_state->state = AUTO_SEEK_STREAM_STATE_PACKET_BEGAN;
+               BT_ASSERT(!stream_state->packet);
+               stream_state->packet = packet_msg->packet;
+               break;
+       }
+       case BT_MESSAGE_TYPE_PACKET_END:
+       {
+               const struct bt_message_packet *packet_msg =
+                       (const void *) msg;
+               struct auto_seek_stream_state *stream_state;
+
+               /* 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);
+               stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN;
+               BT_ASSERT(stream_state->packet);
+               stream_state->packet = NULL;
+               break;
+       }
+       case BT_MESSAGE_TYPE_STREAM_ACTIVITY_END:
+       {
+               const struct bt_message_stream_activity *stream_act_msg =
+                       (const void *) msg;
+               struct auto_seek_stream_state *stream_state;
+
+               /* Update stream's state: stream activity ended. */
+               stream_state = g_hash_table_lookup(stream_states, stream_act_msg->stream);
+               BT_ASSERT(stream_state);
+
+               BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN);
+               stream_state->state = AUTO_SEEK_STREAM_STATE_STREAM_BEGAN;
+               BT_ASSERT(!stream_state->packet);
+               break;
+       }
+       case BT_MESSAGE_TYPE_STREAM_END:
+       {
+               const struct bt_message_stream *stream_msg = (const void *) msg;
+               struct auto_seek_stream_state *stream_state;
+
+               stream_state = g_hash_table_lookup(stream_states, stream_msg->stream);
+               BT_ASSERT(stream_state);
+               BT_ASSERT(stream_state->state == AUTO_SEEK_STREAM_STATE_STREAM_BEGAN);
+               BT_ASSERT(!stream_state->packet);
+
+               /* Update stream's state: this stream doesn't exist anymore. */
+               g_hash_table_remove(stream_states, stream_msg->stream);
+               break;
+       }
+       default:
+               break;
+       }
+
        bt_object_put_no_null_check(msg);
        msg = NULL;
        goto end;
 
 push_msg:
-       g_queue_push_head(iterator->auto_seek_msgs, (void *) msg);
+       g_queue_push_tail(iterator->auto_seek.msgs, (void *) msg);
        msg = NULL;
 
 end:
@@ -1152,7 +1629,7 @@ end:
 static
 enum bt_message_iterator_status find_message_ge_ns_from_origin(
                struct bt_self_component_port_input_message_iterator *iterator,
-               int64_t ns_from_origin)
+               int64_t ns_from_origin, GHashTable *stream_states)
 {
        int status;
        enum bt_self_component_port_input_message_iterator_state init_state =
@@ -1179,8 +1656,7 @@ 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));
@@ -1210,14 +1686,15 @@ enum bt_message_iterator_status find_message_ge_ns_from_origin(
 
                for (i = 0; i < user_count; i++) {
                        if (got_first) {
-                               g_queue_push_head(iterator->auto_seek_msgs,
+                               g_queue_push_tail(iterator->auto_seek.msgs,
                                        (void *) messages[i]);
                                messages[i] = NULL;
                                continue;
                        }
 
                        status = auto_seek_handle_message(iterator,
-                               ns_from_origin, messages[i], &got_first);
+                               ns_from_origin, messages[i], &got_first,
+                               stream_states);
                        if (status == BT_MESSAGE_ITERATOR_STATUS_OK) {
                                /* Message was either pushed or moved */
                                messages[i] = NULL;
@@ -1238,64 +1715,65 @@ end:
        return status;
 }
 
+/*
+ * This function is installed as the iterator's next callback after we have
+ * auto-seeked (seeked to the beginning and fast-forwarded) to send the
+ * messages saved in iterator->auto_seek.msgs.  Once this is done, the original
+ * next callback is put back.
+ */
+
 static
 enum bt_self_message_iterator_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)
 {
-       BT_ASSERT(!g_queue_is_empty(iterator->auto_seek_msgs));
+       BT_ASSERT(!g_queue_is_empty(iterator->auto_seek.msgs));
        *count = 0;
 
        /*
         * Move auto-seek messages to the output array (which is this
         * iterator's base message array).
         */
-       while (capacity > 0 && !g_queue_is_empty(iterator->auto_seek_msgs)) {
-               msgs[*count] = g_queue_pop_tail(iterator->auto_seek_msgs);
+       while (capacity > 0 && !g_queue_is_empty(iterator->auto_seek.msgs)) {
+               msgs[*count] = g_queue_pop_head(iterator->auto_seek.msgs);
                capacity--;
                (*count)++;
        }
 
        BT_ASSERT(*count > 0);
 
-       if (g_queue_is_empty(iterator->auto_seek_msgs)) {
-               /* No more auto-seek messages */
-               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;
-                       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;
-                       break;
-               }
-               default:
-                       abort();
-               }
+       if (g_queue_is_empty(iterator->auto_seek.msgs)) {
+               /* No more auto-seek messages, restore user's next callback. */
+               BT_ASSERT(iterator->auto_seek.original_next_callback);
+               iterator->methods.next = iterator->auto_seek.original_next_callback;
+               iterator->auto_seek.original_next_callback = NULL;
        }
 
        return BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
 }
 
+static inline
+int clock_raw_value_from_ns_from_origin(const bt_clock_class *clock_class,
+               int64_t ns_from_origin, uint64_t *raw_value)
+{
+
+       int64_t cc_offset_s = clock_class->offset_seconds;
+       uint64_t cc_offset_cycles = clock_class->offset_cycles;
+       uint64_t cc_freq = clock_class->frequency;
+
+       return bt_common_clock_value_from_ns_from_origin(cc_offset_s,
+               cc_offset_cycles, cc_freq, ns_from_origin, raw_value);
+}
+
+
 enum bt_message_iterator_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)
 {
        int status;
+       GHashTable *stream_states = NULL;
 
        BT_ASSERT_PRE_NON_NULL(iterator, "Message iterator");
        BT_ASSERT_PRE_ITER_HAS_STATE_TO_SEEK(iterator);
@@ -1312,7 +1790,14 @@ 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: "
                        "%![iter-]+i, ns=%" PRId64, iterator, ns_from_origin);
                status = iterator->methods.seek_ns_from_origin(iterator,
@@ -1327,7 +1812,10 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                        iterator,
                        bt_common_self_message_iterator_status_string(status));
        } else {
-               /* Start automatic seeking: seek beginning first */
+               /*
+                * 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.
+                */
                BT_ASSERT(iterator->methods.can_seek_beginning(iterator));
                BT_ASSERT(iterator->methods.seek_beginning);
                BT_LIB_LOGD("Calling user's \"seek beginning\" method: %!+i",
@@ -1360,23 +1848,100 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                 * this point in the batch to this iterator's auto-seek
                 * message queue.
                 */
-               while (!g_queue_is_empty(iterator->auto_seek_msgs)) {
+               while (!g_queue_is_empty(iterator->auto_seek.msgs)) {
                        bt_object_put_no_null_check(
-                               g_queue_pop_tail(iterator->auto_seek_msgs));
+                               g_queue_pop_tail(iterator->auto_seek.msgs));
+               }
+
+               stream_states = create_auto_seek_stream_states();
+               if (!stream_states) {
+                       BT_LOGE_STR("Failed to allocate one GHashTable.");
+                       status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                       goto end;
                }
 
                status = find_message_ge_ns_from_origin(iterator,
-                       ns_from_origin);
+                       ns_from_origin, stream_states);
                switch (status) {
                case BT_MESSAGE_ITERATOR_STATUS_OK:
                case BT_MESSAGE_ITERATOR_STATUS_END:
+               {
+                       GHashTableIter iter;
+                       gpointer key, value;
+
+                       /*
+                        * If some streams exist at the seek time, prepend the
+                        * required messages to put those streams in the right
+                        * state.
+                        */
+                       g_hash_table_iter_init(&iter, stream_states);
+                       while (g_hash_table_iter_next (&iter, &key, &value)) {
+                               const bt_stream *stream = key;
+                               struct auto_seek_stream_state *stream_state =
+                                       (struct auto_seek_stream_state *) value;
+                               bt_message *msg;
+                               const bt_clock_class *clock_class = bt_stream_class_borrow_default_clock_class_const(
+                                       bt_stream_borrow_class_const(stream));
+                               uint64_t raw_value;
+
+                               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;
+                                       goto end;
+                               }
+
+                               switch (stream_state->state) {
+                               case AUTO_SEEK_STREAM_STATE_PACKET_BEGAN:
+                                       BT_ASSERT(stream_state->packet);
+                                       BT_LIB_LOGD("Creating packet message: %![packet-]+a", stream_state->packet);
+                                       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;
+                                               goto end;
+                                       }
+
+                                       g_queue_push_head(iterator->auto_seek.msgs, msg);
+                                       msg = NULL;
+                                       /* fall-thru */
+                               case AUTO_SEEK_STREAM_STATE_STREAM_ACTIVITY_BEGAN:
+                                       msg = bt_message_stream_activity_beginning_create(
+                                               (bt_self_message_iterator *) iterator, stream);
+                                       if (!msg) {
+                                               status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                                               goto end;
+                                       }
+
+                                       bt_message_stream_activity_beginning_set_default_clock_snapshot(msg, raw_value);
+
+                                       g_queue_push_head(iterator->auto_seek.msgs, msg);
+                                       msg = NULL;
+                                       /* fall-thru */
+                               case AUTO_SEEK_STREAM_STATE_STREAM_BEGAN:
+                                       msg = bt_message_stream_beginning_create(
+                                               (bt_self_message_iterator *) iterator, stream);
+                                       if (!msg) {
+                                               status = BT_MESSAGE_ITERATOR_STATUS_NOMEM;
+                                               goto end;
+                                       }
+
+                                       g_queue_push_head(iterator->auto_seek.msgs, msg);
+                                       msg = NULL;
+                                       break;
+                               }
+                       }
+
                        /*
                         * If there are messages in the auto-seek
                         * message queue, replace the user's "next"
                         * method with a custom, temporary "next" method
                         * which returns them.
                         */
-                       if (!g_queue_is_empty(iterator->auto_seek_msgs)) {
+                       if (!g_queue_is_empty(iterator->auto_seek.msgs)) {
+                               BT_ASSERT(!iterator->auto_seek.original_next_callback);
+                               iterator->auto_seek.original_next_callback = iterator->methods.next;
+
                                iterator->methods.next =
                                        (bt_self_component_port_input_message_iterator_next_method)
                                                post_auto_seek_next;
@@ -1391,6 +1956,7 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                         */
                        status = BT_MESSAGE_ITERATOR_STATUS_OK;
                        break;
+               }
                case BT_MESSAGE_ITERATOR_STATUS_ERROR:
                case BT_MESSAGE_ITERATOR_STATUS_NOMEM:
                case BT_MESSAGE_ITERATOR_STATUS_AGAIN:
@@ -1400,7 +1966,17 @@ bt_self_component_port_input_message_iterator_seek_ns_from_origin(
                }
        }
 
+       /*
+        * 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);
+               stream_states = NULL;
+       }
        set_iterator_state_after_seeking(iterator, status);
        return status;
 }
This page took 0.032682 seconds and 4 git commands to generate.