Remove trace-collection.h from include_headers
[babeltrace.git] / lib / iterator.c
index e50846f4cb6179a7cd2eb1ac1903f042d4da5f1e..bcb77d8843b2eca392ebb0517bafd934e3f5bcea 100644 (file)
 #include <babeltrace/ctf/events.h>
 #include <inttypes.h>
 
+static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream,
+               const struct bt_iter_pos *begin_pos,
+               unsigned long stream_id);
+
 struct stream_saved_pos {
        /*
         * Use file_stream pointer to check if the trace collection we
@@ -37,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,7 +71,7 @@ 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;
@@ -77,7 +82,7 @@ void bt_iter_free_pos(struct bt_iter_pos *iter_pos)
        if (!iter_pos)
                return;
 
-       if (iter_pos->u.restore) {
+       if (iter_pos->type == BT_SEEK_RESTORE && iter_pos->u.restore) {
                if (iter_pos->u.restore->stream_saved_pos) {
                        g_array_free(
                                iter_pos->u.restore->stream_saved_pos,
@@ -96,8 +101,8 @@ void bt_iter_free_pos(struct bt_iter_pos *iter_pos)
  * are looking for (either the exact timestamp or the event just after the
  * timestamp).
  *
- * Return 0 if the seek succeded and EOF if we didn't find any packet
- * containing the timestamp.
+ * Return 0 if the seek succeded, EOF if we didn't find any packet
+ * containing the timestamp, or a positive integer for error.
  */
 static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs,
                uint64_t timestamp)
@@ -107,20 +112,24 @@ 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)
+               if (index->timestamp_end < timestamp)
                        continue;
 
                stream_pos->packet_seek(&stream_pos->parent, i, SEEK_SET);
-               while (cfs->parent.timestamp < timestamp) {
+               do {
                        ret = stream_read_event(cfs);
-                       if (ret < 0)
-                               break;
-               }
-               return 0;
+               } while (cfs->parent.real_timestamp < timestamp && ret == 0);
+
+               /* Can return either EOF, 0, or error (> 0). */
+               return ret;
        }
+       /*
+        * Cannot find the timestamp within the stream packets, return
+        * EOF.
+        */
        return EOF;
 }
 
@@ -130,42 +139,52 @@ static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs,
  *
  * Return 0 on success.
  * If the timestamp is not part of any file stream, return EOF to inform the
- * user the timestamp is out of the scope
+ * user the timestamp is out of the scope.
+ * On other errors, return positive value.
  */
 static int seek_ctf_trace_by_timestamp(struct ctf_trace *tin,
                uint64_t timestamp, struct ptr_heap *stream_heap)
 {
        int i, j, ret;
-       int found = EOF;
+       int found = 0;
 
        /* for each stream_class */
        for (i = 0; i < tin->streams->len; i++) {
-               struct ctf_stream_class *stream_class;
+               struct ctf_stream_declaration *stream_class;
 
                stream_class = g_ptr_array_index(tin->streams, i);
+               if (!stream_class)
+                       continue;
                /* for each file_stream */
                for (j = 0; j < stream_class->streams->len; j++) {
-                       struct ctf_stream *stream;
+                       struct ctf_stream_definition *stream;
                        struct ctf_file_stream *cfs;
 
                        stream = g_ptr_array_index(stream_class->streams, j);
+                       if (!stream)
+                               continue;
                        cfs = container_of(stream, struct ctf_file_stream,
                                        parent);
                        ret = seek_file_stream_by_timestamp(cfs, timestamp);
                        if (ret == 0) {
                                /* Add to heap */
                                ret = heap_insert(stream_heap, cfs);
-                               if (ret)
-                                       goto error;
-                               found = 0;
+                               if (ret) {
+                                       /* Return positive error. */
+                                       return -ret;
+                               }
+                               found = 1;
+                       } else if (ret > 0) {
+                               /*
+                                * Error in seek (not EOF), failure.
+                                */
+                               return ret;
                        }
+                       /* on EOF just do not put stream into heap. */
                }
        }
 
-       return found;
-
-error:
-       return -2;
+       return found ? 0 : EOF;
 }
 
 int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
@@ -181,13 +200,13 @@ 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++) {
                        struct stream_saved_pos *saved_pos;
                        struct ctf_stream_pos *stream_pos;
-                       struct ctf_stream *stream;
+                       struct ctf_stream_definition *stream;
 
                        saved_pos = &g_array_index(
                                        iter_pos->u.restore->stream_saved_pos,
@@ -203,18 +222,20 @@ 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);
 
@@ -224,13 +245,14 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                        if (ret)
                                goto error;
                }
+               return 0;
        case BT_SEEK_TIME:
                tc = iter->ctx->tc;
 
                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++) {
@@ -238,15 +260,72 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                        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);
 
                        ret = seek_ctf_trace_by_timestamp(tin,
                                        iter_pos->u.seek_time,
                                        iter->stream_heap);
-                       if (ret < 0)
+                       /*
+                        * Positive errors are failure. Negative value
+                        * is EOF (for which we continue with other
+                        * traces). 0 is success. Note: on EOF, it just
+                        * means that no stream has been added to the
+                        * iterator for that trace, which is fine.
+                        */
+                       if (ret != 0 && ret != EOF)
                                goto error;
                }
                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;
+                       int stream_id;
+
+                       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, iter_pos,
+                                                       stream_id);
+                                       if (ret != 0 && ret != EOF) {
+                                               goto error;
+                                       }
+                                       ret = heap_insert(iter->stream_heap, file_stream);
+                                       if (ret)
+                                               goto error;
+                               }
+                       }
+               }
+               break;
        default:
                /* not implemented */
                return -EINVAL;
@@ -256,12 +335,14 @@ 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;
 }
 
@@ -269,9 +350,12 @@ 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 ctf_file_stream *file_stream = NULL, *removed;
+       struct ptr_heap iter_heap_copy;
+       int ret;
 
        pos = g_new0(struct bt_iter_pos, 1);
+       pos->type = BT_SEEK_RESTORE;
        pos->u.restore = g_new0(struct bt_saved_pos, 1);
        pos->u.restore->tc = tc;
        pos->u.restore->stream_saved_pos = g_array_new(FALSE, TRUE,
@@ -279,67 +363,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);
-               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_class *stream_class;
-
-                       stream_class = g_ptr_array_index(tin->streams,
-                                       stream_class_id);
-                       for (stream_id = 0;
-                                       stream_id < stream_class->streams->len;
-                                       stream_id++) {
-                               struct ctf_stream *stream;
-                               struct ctf_file_stream *cfs;
-                               struct stream_saved_pos saved_pos;
-
-                               stream = g_ptr_array_index(
-                                               stream_class->streams,
-                                               stream_id);
-                               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;
 }
 
@@ -387,47 +451,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);
-               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_class *stream;
-                       int filenr;
-
-                       stream = g_ptr_array_index(tin->streams, stream_id);
-                       for (filenr = 0; filenr < stream->streams->len;
-                                       filenr++) {
-                               struct ctf_file_stream *file_stream;
-
-                               file_stream = g_ptr_array_index(stream->streams,
-                                               filenr);
-                               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,
@@ -436,6 +459,11 @@ int bt_iter_init(struct bt_iter *iter,
        int i, stream_id;
        int ret = 0;
 
+       if (ctx->current_iterator) {
+               ret = -1;
+               goto error_ctx;
+       }
+
        iter->stream_heap = g_new(struct ptr_heap, 1);
        iter->end_pos = end_pos;
        bt_context_get(ctx);
@@ -450,12 +478,14 @@ int bt_iter_init(struct bt_iter *iter,
                struct trace_descriptor *td_read;
 
                td_read = g_ptr_array_index(ctx->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_class *stream;
+                       struct ctf_stream_declaration *stream;
                        int filenr;
 
                        stream = g_ptr_array_index(tin->streams, stream_id);
@@ -467,16 +497,25 @@ int bt_iter_init(struct bt_iter *iter,
 
                                file_stream = g_ptr_array_index(stream->streams,
                                                filenr);
-
+                               if (!file_stream)
+                                       continue;
                                if (begin_pos) {
-                                   ret = babeltrace_filestream_seek(file_stream, begin_pos,
+                                       ret = babeltrace_filestream_seek(
+                                                       file_stream,
+                                                       begin_pos,
                                                        stream_id);
-                                   if (ret == EOF) {
-                                          ret = 0;
-                                          continue;
-                                   } else if (ret) {
-                                          goto error;
-                                   }
+                               } else {
+                                       struct bt_iter_pos pos;
+                                       pos.type = BT_SEEK_BEGIN;
+                                       ret = babeltrace_filestream_seek(
+                                                       file_stream, &pos,
+                                                       stream_id);
+                               }
+                               if (ret == EOF) {
+                                       ret = 0;
+                                       continue;
+                               } else if (ret) {
+                                       goto error;
                                }
                                /* Add to heap */
                                ret = heap_insert(iter->stream_heap, file_stream);
@@ -486,12 +525,15 @@ int bt_iter_init(struct bt_iter *iter,
                }
        }
 
+       ctx->current_iterator = iter;
        return 0;
 
 error:
        heap_free(iter->stream_heap);
 error_heap_init:
        g_free(iter->stream_heap);
+       iter->stream_heap = NULL;
+error_ctx:
        return ret;
 }
 
@@ -517,6 +559,7 @@ void bt_iter_fini(struct bt_iter *iter)
                heap_free(iter->stream_heap);
                g_free(iter->stream_heap);
        }
+       iter->ctx->current_iterator = NULL;
        bt_context_put(iter->ctx);
 }
 
This page took 0.029905 seconds and 4 git commands to generate.