Fix: iterator.c BT_SEEK_RESTORE: check return value
[babeltrace.git] / lib / iterator.c
index 6b1a6d2ad1668a42d7a6f1e268d71f0b3d8e1193..2dbd77c0df1ee1de769401f5e05e7102fd2b7142 100644 (file)
@@ -41,7 +41,8 @@ struct stream_saved_pos {
        struct ctf_file_stream *file_stream;
        size_t cur_index;       /* current index in packet index */
        ssize_t offset;         /* offset from base, in bits. EOF for end of file. */
-       uint64_t current_timestamp;
+       uint64_t current_real_timestamp;
+       uint64_t current_cycles_timestamp;
 };
 
 struct bt_saved_pos {
@@ -66,11 +67,11 @@ static int stream_read_event(struct ctf_file_stream *sin)
 /*
  * returns true if a < b, false otherwise.
  */
-int stream_compare(void *a, void *b)
+static int stream_compare(void *a, void *b)
 {
        struct ctf_file_stream *s_a = a, *s_b = b;
 
-       if (s_a->parent.timestamp < s_b->parent.timestamp)
+       if (s_a->parent.real_timestamp < s_b->parent.real_timestamp)
                return 1;
        else
                return 0;
@@ -111,8 +112,8 @@ static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs,
        int i, ret;
 
        stream_pos = &cfs->pos;
-       for (i = 0; i < stream_pos->packet_index->len; i++) {
-               index = &g_array_index(stream_pos->packet_index,
+       for (i = 0; i < stream_pos->packet_real_index->len; i++) {
+               index = &g_array_index(stream_pos->packet_real_index,
                                struct packet_index, i);
                if (index->timestamp_end < timestamp)
                        continue;
@@ -120,7 +121,7 @@ static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs,
                stream_pos->packet_seek(&stream_pos->parent, i, SEEK_SET);
                do {
                        ret = stream_read_event(cfs);
-               } while (cfs->parent.timestamp < timestamp && ret == 0);
+               } while (cfs->parent.real_timestamp < timestamp && ret == 0);
 
                /* Can return either EOF, 0, or error (> 0). */
                return ret;
@@ -191,6 +192,9 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
        struct trace_collection *tc;
        int i, ret;
 
+       if (!iter || !iter_pos)
+               return -EINVAL;
+
        switch (iter_pos->type) {
        case BT_SEEK_RESTORE:
                if (!iter_pos->u.restore)
@@ -199,7 +203,7 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                heap_free(iter->stream_heap);
                ret = heap_init(iter->stream_heap, 0, stream_compare);
                if (ret < 0)
-                       goto error;
+                       goto error_heap_init;
 
                for (i = 0; i < iter_pos->u.restore->stream_saved_pos->len;
                                i++) {
@@ -221,20 +225,25 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                         * packet_seek, because this function resets
                         * the timestamp to the beginning of the packet
                         */
-                       stream->timestamp = saved_pos->current_timestamp;
+                       stream->real_timestamp = saved_pos->current_real_timestamp;
+                       stream->cycles_timestamp = saved_pos->current_cycles_timestamp;
                        stream_pos->offset = saved_pos->offset;
-                       stream_pos->last_offset = saved_pos->offset;
+                       stream_pos->last_offset = LAST_OFFSET_POISON;
 
-                       stream->prev_timestamp = 0;
-                       stream->prev_timestamp_end = 0;
-                       stream->consumed = 0;
+                       stream->prev_real_timestamp = 0;
+                       stream->prev_real_timestamp_end = 0;
+                       stream->prev_cycles_timestamp = 0;
+                       stream->prev_cycles_timestamp_end = 0;
 
                        printf_debug("restored to cur_index = %zd and "
                                "offset = %zd, timestamp = %" PRIu64 "\n",
                                stream_pos->cur_index,
-                               stream_pos->offset, stream->timestamp);
+                               stream_pos->offset, stream->real_timestamp);
 
-                       stream_read_event(saved_pos->file_stream);
+                       ret = stream_read_event(saved_pos->file_stream);
+                       if (ret != 0) {
+                               goto error;
+                       }
 
                        /* Add to heap */
                        ret = heap_insert(iter->stream_heap,
@@ -249,7 +258,7 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                heap_free(iter->stream_heap);
                ret = heap_init(iter->stream_heap, 0, stream_compare);
                if (ret < 0)
-                       goto error;
+                       goto error_heap_init;
 
                /* for each trace in the trace_collection */
                for (i = 0; i < tc->array->len; i++) {
@@ -277,6 +286,11 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                return 0;
        case BT_SEEK_BEGIN:
                tc = iter->ctx->tc;
+               heap_free(iter->stream_heap);
+               ret = heap_init(iter->stream_heap, 0, stream_compare);
+               if (ret < 0)
+                       goto error_heap_init;
+
                for (i = 0; i < tc->array->len; i++) {
                        struct ctf_trace *tin;
                        struct trace_descriptor *td_read;
@@ -311,6 +325,9 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                                        if (ret != 0 && ret != EOF) {
                                                goto error;
                                        }
+                                       ret = heap_insert(iter->stream_heap, file_stream);
+                                       if (ret)
+                                               goto error;
                                }
                        }
                }
@@ -324,21 +341,29 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
 
 error:
        heap_free(iter->stream_heap);
+error_heap_init:
        if (heap_init(iter->stream_heap, 0, stream_compare) < 0) {
                heap_free(iter->stream_heap);
                g_free(iter->stream_heap);
                iter->stream_heap = NULL;
                ret = -ENOMEM;
        }
+
        return ret;
 }
 
 struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter)
 {
        struct bt_iter_pos *pos;
-       struct trace_collection *tc = iter->ctx->tc;
-       int i, stream_class_id, stream_id;
+       struct trace_collection *tc;
+       struct ctf_file_stream *file_stream = NULL, *removed;
+       struct ptr_heap iter_heap_copy;
+       int ret;
+
+       if (!iter)
+               return NULL;
 
+       tc = iter->ctx->tc;
        pos = g_new0(struct bt_iter_pos, 1);
        pos->type = BT_SEEK_RESTORE;
        pos->u.restore = g_new0(struct bt_saved_pos, 1);
@@ -348,73 +373,47 @@ struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter)
        if (!pos->u.restore->stream_saved_pos)
                goto error;
 
-       for (i = 0; i < tc->array->len; i++) {
-               struct ctf_trace *tin;
-               struct trace_descriptor *td_read;
-
-               td_read = g_ptr_array_index(tc->array, i);
-               if (!td_read)
-                       continue;
-               tin = container_of(td_read, struct ctf_trace, parent);
-
-               for (stream_class_id = 0; stream_class_id < tin->streams->len;
-                               stream_class_id++) {
-                       struct ctf_stream_declaration *stream_class;
-
-                       stream_class = g_ptr_array_index(tin->streams,
-                                       stream_class_id);
-                       if (!stream_class)
-                               continue;
-                       for (stream_id = 0;
-                                       stream_id < stream_class->streams->len;
-                                       stream_id++) {
-                               struct ctf_stream_definition *stream;
-                               struct ctf_file_stream *cfs;
-                               struct stream_saved_pos saved_pos;
-
-                               stream = g_ptr_array_index(
-                                               stream_class->streams,
-                                               stream_id);
-                               if (!stream)
-                                       continue;
-                               cfs = container_of(stream,
-                                               struct ctf_file_stream,
-                                               parent);
-
-                               saved_pos.file_stream = cfs;
-                               saved_pos.cur_index = cfs->pos.cur_index;
+       ret = heap_copy(&iter_heap_copy, iter->stream_heap);
+       if (ret < 0)
+               goto error_heap;
+
+       /* iterate over each stream in the heap */
+       file_stream = heap_maximum(&iter_heap_copy);
+       while (file_stream != NULL) {
+               struct stream_saved_pos saved_pos;
+
+               assert(file_stream->pos.last_offset != LAST_OFFSET_POISON);
+               saved_pos.offset = file_stream->pos.last_offset;
+               saved_pos.file_stream = file_stream;
+               saved_pos.cur_index = file_stream->pos.cur_index;
+
+               saved_pos.current_real_timestamp = file_stream->parent.real_timestamp;
+               saved_pos.current_cycles_timestamp = file_stream->parent.cycles_timestamp;
+
+               g_array_append_val(
+                               pos->u.restore->stream_saved_pos,
+                               saved_pos);
+
+               printf_debug("stream : %" PRIu64 ", cur_index : %zd, "
+                               "offset : %zd, "
+                               "timestamp = %" PRIu64 "\n",
+                               file_stream->parent.stream_id,
+                               saved_pos.cur_index, saved_pos.offset,
+                               saved_pos.current_real_timestamp);
+
+               /* remove the stream from the heap copy */
+               removed = heap_remove(&iter_heap_copy);
+               assert(removed == file_stream);
 
-                               /*
-                                * It is possible that an event was read during
-                                * the last restore, never consumed and its
-                                * position saved again.  For this case, we
-                                * need to check if the event really was
-                                * consumed by the caller otherwise it is lost.
-                                */
-                               if (stream->consumed)
-                                       saved_pos.offset = cfs->pos.offset;
-                               else
-                                       saved_pos.offset = cfs->pos.last_offset;
-
-                               saved_pos.current_timestamp = stream->timestamp;
-
-                               g_array_append_val(
-                                       pos->u.restore->stream_saved_pos,
-                                       saved_pos);
-
-                               printf_debug("stream : %" PRIu64 ", cur_index : %zd, "
-                                       "offset : %zd, "
-                                       "timestamp = %" PRIu64 "\n",
-                                       stream->stream_id, saved_pos.cur_index,
-                                       saved_pos.offset,
-                                       saved_pos.current_timestamp);
-                       }
-               }
+               file_stream = heap_maximum(&iter_heap_copy);
        }
-
+       heap_free(&iter_heap_copy);
        return pos;
 
+error_heap:
+       g_array_free(pos->u.restore->stream_saved_pos, TRUE);
 error:
+       g_free(pos);
        return NULL;
 }
 
@@ -423,6 +422,9 @@ struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter,
 {
        struct bt_iter_pos *pos;
 
+       if (!iter)
+               return NULL;
+
        pos = g_new0(struct bt_iter_pos, 1);
        pos->type = BT_SEEK_TIME;
        pos->u.seek_time = timestamp;
@@ -440,6 +442,9 @@ static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream,
 {
        int ret = 0;
 
+       if (!file_stream || !begin_pos)
+               return -EINVAL;
+
        switch (begin_pos->type) {
        case BT_SEEK_CUR:
                /*
@@ -462,53 +467,6 @@ static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream,
        return ret;
 }
 
-/*
- * bt_iter_seek: seek iterator to given position.
- */
-int bt_iter_seek(struct bt_iter *iter,
-               const struct bt_iter_pos *begin_pos)
-{
-       int i, stream_id;
-       int ret = 0;
-       struct trace_collection *tc = iter->ctx->tc;
-
-       for (i = 0; i < tc->array->len; i++) {
-               struct ctf_trace *tin;
-               struct trace_descriptor *td_read;
-
-               td_read = g_ptr_array_index(tc->array, i);
-               if (!td_read)
-                       continue;
-               tin = container_of(td_read, struct ctf_trace, parent);
-
-               /* Populate heap with each stream */
-               for (stream_id = 0; stream_id < tin->streams->len;
-                               stream_id++) {
-                       struct ctf_stream_declaration *stream;
-                       int filenr;
-
-                       stream = g_ptr_array_index(tin->streams, stream_id);
-                       if (!stream)
-                               continue;
-                       for (filenr = 0; filenr < stream->streams->len;
-                                       filenr++) {
-                               struct ctf_file_stream *file_stream;
-
-                               file_stream = g_ptr_array_index(stream->streams,
-                                               filenr);
-                               if (!file_stream)
-                                       continue;
-                               ret = babeltrace_filestream_seek(file_stream, begin_pos,
-                                               stream_id);
-                               if (ret < 0)
-                                       goto end;
-                       }
-               }
-       }
-end:
-       return ret;
-}
-
 int bt_iter_init(struct bt_iter *iter,
                struct bt_context *ctx,
                const struct bt_iter_pos *begin_pos,
@@ -517,6 +475,9 @@ int bt_iter_init(struct bt_iter *iter,
        int i, stream_id;
        int ret = 0;
 
+       if (!iter || !ctx)
+               return -EINVAL;
+
        if (ctx->current_iterator) {
                ret = -1;
                goto error_ctx;
@@ -590,6 +551,7 @@ error:
        heap_free(iter->stream_heap);
 error_heap_init:
        g_free(iter->stream_heap);
+       iter->stream_heap = NULL;
 error_ctx:
        return ret;
 }
@@ -601,6 +563,9 @@ struct bt_iter *bt_iter_create(struct bt_context *ctx,
        struct bt_iter *iter;
        int ret;
 
+       if (!ctx)
+               return NULL;
+
        iter = g_new0(struct bt_iter, 1);
        ret = bt_iter_init(iter, ctx, begin_pos, end_pos);
        if (ret) {
@@ -612,6 +577,7 @@ struct bt_iter *bt_iter_create(struct bt_context *ctx,
 
 void bt_iter_fini(struct bt_iter *iter)
 {
+       assert(iter);
        if (iter->stream_heap) {
                heap_free(iter->stream_heap);
                g_free(iter->stream_heap);
@@ -622,6 +588,7 @@ void bt_iter_fini(struct bt_iter *iter)
 
 void bt_iter_destroy(struct bt_iter *iter)
 {
+       assert(iter);
        bt_iter_fini(iter);
        g_free(iter);
 }
@@ -631,6 +598,9 @@ int bt_iter_next(struct bt_iter *iter)
        struct ctf_file_stream *file_stream, *removed;
        int ret;
 
+       if (!iter)
+               return -EINVAL;
+
        file_stream = heap_maximum(iter->stream_heap);
        if (!file_stream) {
                /* end of file for all streams */
This page took 0.029375 seconds and 4 git commands to generate.