Fix: Use the bt_iter_set_pos function to set the begin_pos
[babeltrace.git] / lib / iterator.c
index bcb77d8843b2eca392ebb0517bafd934e3f5bcea..966a00010e3e82a8393987f72f78b9e4d820c70f 100644 (file)
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
 #include <stdlib.h>
@@ -65,16 +73,24 @@ static int stream_read_event(struct ctf_file_stream *sin)
 }
 
 /*
- * returns true if a < b, false otherwise.
+ * Return true if a < b, false otherwise.
+ * If time stamps are exactly the same, compare by stream path. This
+ * ensures we get the same result between runs on the same trace
+ * collection on different environments.
+ * The result will be random for memory-mapped traces since there is no
+ * fixed path leading to those (they have empty path string).
  */
-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.real_timestamp < s_b->parent.real_timestamp)
+       if (s_a->parent.real_timestamp < s_b->parent.real_timestamp) {
                return 1;
-       else
+       } else if (likely(s_a->parent.real_timestamp > s_b->parent.real_timestamp)) {
                return 0;
+       } else {
+               return strcmp(s_a->parent.path, s_b->parent.path);
+       }
 }
 
 void bt_iter_free_pos(struct bt_iter_pos *iter_pos)
@@ -103,6 +119,10 @@ void bt_iter_free_pos(struct bt_iter_pos *iter_pos)
  *
  * Return 0 if the seek succeded, EOF if we didn't find any packet
  * containing the timestamp, or a positive integer for error.
+ *
+ * TODO: this should be turned into a binary search! It is currently
+ * doing a linear search in the packets. This is a O(n) operation on a
+ * very frequent code path.
  */
 static int seek_file_stream_by_timestamp(struct ctf_file_stream *cfs,
                uint64_t timestamp)
@@ -168,7 +188,7 @@ static int seek_ctf_trace_by_timestamp(struct ctf_trace *tin,
                        ret = seek_file_stream_by_timestamp(cfs, timestamp);
                        if (ret == 0) {
                                /* Add to heap */
-                               ret = heap_insert(stream_heap, cfs);
+                               ret = bt_heap_insert(stream_heap, cfs);
                                if (ret) {
                                        /* Return positive error. */
                                        return -ret;
@@ -187,18 +207,167 @@ static int seek_ctf_trace_by_timestamp(struct ctf_trace *tin,
        return found ? 0 : EOF;
 }
 
+/*
+ * Find timestamp of last event in the stream.
+ *
+ * Return value: 0 if OK, positive error value on error, EOF if no
+ * events were found.
+ */
+static int find_max_timestamp_ctf_file_stream(struct ctf_file_stream *cfs,
+               uint64_t *timestamp_end)
+{
+       int ret, count = 0, i;
+       uint64_t timestamp = 0;
+       struct ctf_stream_pos *stream_pos;
+
+       stream_pos = &cfs->pos;
+       /*
+        * We start by the last packet, and iterate backwards until we
+        * either find at least one event, or we reach the first packet
+        * (some packets can be empty).
+        */
+       for (i = stream_pos->packet_real_index->len - 1; i >= 0; i--) {
+               stream_pos->packet_seek(&stream_pos->parent, i, SEEK_SET);
+               count = 0;
+               /* read each event until we reach the end of the stream */
+               do {
+                       ret = stream_read_event(cfs);
+                       if (ret == 0) {
+                               count++;
+                               timestamp = cfs->parent.real_timestamp;
+                       }
+               } while (ret == 0);
+
+               /* Error */
+               if (ret > 0)
+                       goto end;
+               assert(ret == EOF);
+               if (count)
+                       break;
+       }
+
+       if (count) {
+               *timestamp_end = timestamp;
+               ret = 0;
+       } else {
+               /* Return EOF if no events were found */
+               ret = EOF;
+       }
+end:
+       return ret;
+}
+
+/*
+ * Find the stream within a stream class that contains the event with
+ * the largest timestamp, and save that timestamp.
+ *
+ * Return 0 if OK, EOF if no events were found in the streams, or
+ * positive value on error.
+ */
+static int find_max_timestamp_ctf_stream_class(
+               struct ctf_stream_declaration *stream_class,
+               struct ctf_file_stream **cfsp,
+               uint64_t *max_timestamp)
+{
+       int ret = EOF, i, found = 0;
+
+       for (i = 0; i < stream_class->streams->len; i++) {
+               struct ctf_stream_definition *stream;
+               struct ctf_file_stream *cfs;
+               uint64_t current_max_ts = 0;
+
+               stream = g_ptr_array_index(stream_class->streams, i);
+               if (!stream)
+                       continue;
+               cfs = container_of(stream, struct ctf_file_stream, parent);
+               ret = find_max_timestamp_ctf_file_stream(cfs, &current_max_ts);
+               if (ret == EOF)
+                       continue;
+               if (ret != 0)
+                       break;
+               if (current_max_ts >= *max_timestamp) {
+                       *max_timestamp = current_max_ts;
+                       *cfsp = cfs;
+                       found = 1;
+               }
+       }
+       assert(ret >= 0 || ret == EOF);
+       if (found) {
+               return 0;
+       }
+       return ret;
+}
+
+/*
+ * seek_last_ctf_trace_collection: seek trace collection to last event.
+ *
+ * Return 0 if OK, EOF if no events were found, or positive error value
+ * on error.
+ */
+static int seek_last_ctf_trace_collection(struct trace_collection *tc,
+               struct ctf_file_stream **cfsp)
+{
+       int i, j, ret;
+       int found = 0;
+       uint64_t max_timestamp = 0;
+
+       if (!tc)
+               return 1;
+
+       /* For each trace in the trace_collection */
+       for (i = 0; i < tc->array->len; i++) {
+               struct ctf_trace *tin;
+               struct bt_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 each stream_class in the trace */
+               for (j = 0; j < tin->streams->len; j++) {
+                       struct ctf_stream_declaration *stream_class;
+
+                       stream_class = g_ptr_array_index(tin->streams, j);
+                       if (!stream_class)
+                               continue;
+                       ret = find_max_timestamp_ctf_stream_class(stream_class,
+                                       cfsp, &max_timestamp);
+                       if (ret > 0)
+                               goto end;
+                       if (ret == 0)
+                               found = 1;
+                       assert(ret == EOF || ret == 0);
+               }
+       }
+       /*
+        * Now we know in which file stream the last event is located,
+        * and we know its timestamp.
+        */
+       if (!found) {
+               ret = EOF;
+       } else {
+               ret = seek_file_stream_by_timestamp(*cfsp, max_timestamp);
+               assert(ret == 0);
+       }
+end:
+       return ret;
+}
+
 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)
                        return -EINVAL;
 
-               heap_free(iter->stream_heap);
-               ret = heap_init(iter->stream_heap, 0, stream_compare);
+               bt_heap_free(iter->stream_heap);
+               ret = bt_heap_init(iter->stream_heap, 0, stream_compare);
                if (ret < 0)
                        goto error_heap_init;
 
@@ -232,15 +401,18 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                        stream->prev_cycles_timestamp = 0;
                        stream->prev_cycles_timestamp_end = 0;
 
-                       printf_debug("restored to cur_index = %zd and "
-                               "offset = %zd, timestamp = %" PRIu64 "\n",
+                       printf_debug("restored to cur_index = %" PRId64 " and "
+                               "offset = %" PRId64 ", timestamp = %" PRIu64 "\n",
                                stream_pos->cur_index,
                                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,
+                       ret = bt_heap_insert(iter->stream_heap,
                                        saved_pos->file_stream);
                        if (ret)
                                goto error;
@@ -249,15 +421,15 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
        case BT_SEEK_TIME:
                tc = iter->ctx->tc;
 
-               heap_free(iter->stream_heap);
-               ret = heap_init(iter->stream_heap, 0, stream_compare);
+               bt_heap_free(iter->stream_heap);
+               ret = bt_heap_init(iter->stream_heap, 0, stream_compare);
                if (ret < 0)
                        goto error_heap_init;
 
                /* for each trace in the trace_collection */
                for (i = 0; i < tc->array->len; i++) {
                        struct ctf_trace *tin;
-                       struct trace_descriptor *td_read;
+                       struct bt_trace_descriptor *td_read;
 
                        td_read = g_ptr_array_index(tc->array, i);
                        if (!td_read)
@@ -280,14 +452,14 @@ 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);
+               bt_heap_free(iter->stream_heap);
+               ret = bt_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;
+                       struct bt_trace_descriptor *td_read;
                        int stream_id;
 
                        td_read = g_ptr_array_index(tc->array, i);
@@ -319,13 +491,37 @@ 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 == EOF) {
+                                               /* Do not add EOF streams */
+                                               continue;
+                                       }
+                                       ret = bt_heap_insert(iter->stream_heap, file_stream);
                                        if (ret)
                                                goto error;
                                }
                        }
                }
                break;
+       case BT_SEEK_LAST:
+       {
+               struct ctf_file_stream *cfs = NULL;
+
+               tc = iter->ctx->tc;
+               ret = seek_last_ctf_trace_collection(tc, &cfs);
+               if (ret != 0 || !cfs)
+                       goto error;
+               /* remove all streams from the heap */
+               bt_heap_free(iter->stream_heap);
+               /* Create a new empty heap */
+               ret = bt_heap_init(iter->stream_heap, 0, stream_compare);
+               if (ret < 0)
+                       goto error;
+               /* Insert the stream that contains the last event */
+               ret = bt_heap_insert(iter->stream_heap, cfs);
+               if (ret)
+                       goto error;
+               break;
+       }
        default:
                /* not implemented */
                return -EINVAL;
@@ -334,10 +530,10 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
        return 0;
 
 error:
-       heap_free(iter->stream_heap);
+       bt_heap_free(iter->stream_heap);
 error_heap_init:
-       if (heap_init(iter->stream_heap, 0, stream_compare) < 0) {
-               heap_free(iter->stream_heap);
+       if (bt_heap_init(iter->stream_heap, 0, stream_compare) < 0) {
+               bt_heap_free(iter->stream_heap);
                g_free(iter->stream_heap);
                iter->stream_heap = NULL;
                ret = -ENOMEM;
@@ -349,11 +545,15 @@ error_heap_init:
 struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter)
 {
        struct bt_iter_pos *pos;
-       struct trace_collection *tc = iter->ctx->tc;
+       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);
@@ -363,12 +563,12 @@ struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter)
        if (!pos->u.restore->stream_saved_pos)
                goto error;
 
-       ret = heap_copy(&iter_heap_copy, iter->stream_heap);
+       ret = bt_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);
+       file_stream = bt_heap_maximum(&iter_heap_copy);
        while (file_stream != NULL) {
                struct stream_saved_pos saved_pos;
 
@@ -392,12 +592,12 @@ struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter)
                                saved_pos.current_real_timestamp);
 
                /* remove the stream from the heap copy */
-               removed = heap_remove(&iter_heap_copy);
+               removed = bt_heap_remove(&iter_heap_copy);
                assert(removed == file_stream);
 
-               file_stream = heap_maximum(&iter_heap_copy);
+               file_stream = bt_heap_maximum(&iter_heap_copy);
        }
-       heap_free(&iter_heap_copy);
+       bt_heap_free(&iter_heap_copy);
        return pos;
 
 error_heap:
@@ -412,6 +612,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;
@@ -429,6 +632,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:
                /*
@@ -443,7 +649,6 @@ static int babeltrace_filestream_seek(struct ctf_file_stream *file_stream,
                break;
        case BT_SEEK_TIME:
        case BT_SEEK_RESTORE:
-       case BT_SEEK_END:
        default:
                assert(0); /* Not yet defined */
        }
@@ -459,6 +664,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;
@@ -469,13 +677,13 @@ int bt_iter_init(struct bt_iter *iter,
        bt_context_get(ctx);
        iter->ctx = ctx;
 
-       ret = heap_init(iter->stream_heap, 0, stream_compare);
+       ret = bt_heap_init(iter->stream_heap, 0, stream_compare);
        if (ret < 0)
                goto error_heap_init;
 
        for (i = 0; i < ctx->tc->array->len; i++) {
                struct ctf_trace *tin;
-               struct trace_descriptor *td_read;
+               struct bt_trace_descriptor *td_read;
 
                td_read = g_ptr_array_index(ctx->tc->array, i);
                if (!td_read)
@@ -494,23 +702,17 @@ int bt_iter_init(struct bt_iter *iter,
                        for (filenr = 0; filenr < stream->streams->len;
                                        filenr++) {
                                struct ctf_file_stream *file_stream;
+                               struct bt_iter_pos pos;
 
                                file_stream = g_ptr_array_index(stream->streams,
                                                filenr);
                                if (!file_stream)
                                        continue;
-                               if (begin_pos) {
-                                       ret = babeltrace_filestream_seek(
-                                                       file_stream,
-                                                       begin_pos,
-                                                       stream_id);
-                               } else {
-                                       struct bt_iter_pos pos;
-                                       pos.type = BT_SEEK_BEGIN;
-                                       ret = babeltrace_filestream_seek(
-                                                       file_stream, &pos,
-                                                       stream_id);
-                               }
+
+                               pos.type = BT_SEEK_BEGIN;
+                               ret = babeltrace_filestream_seek(file_stream,
+                                       &pos, stream_id);
+
                                if (ret == EOF) {
                                        ret = 0;
                                        continue;
@@ -518,7 +720,7 @@ int bt_iter_init(struct bt_iter *iter,
                                        goto error;
                                }
                                /* Add to heap */
-                               ret = heap_insert(iter->stream_heap, file_stream);
+                               ret = bt_heap_insert(iter->stream_heap, file_stream);
                                if (ret)
                                        goto error;
                        }
@@ -526,10 +728,14 @@ int bt_iter_init(struct bt_iter *iter,
        }
 
        ctx->current_iterator = iter;
-       return 0;
+       if (begin_pos && begin_pos->type != BT_SEEK_BEGIN) {
+               ret = bt_iter_set_pos(iter, begin_pos);
+       }
+
+       return ret;
 
 error:
-       heap_free(iter->stream_heap);
+       bt_heap_free(iter->stream_heap);
 error_heap_init:
        g_free(iter->stream_heap);
        iter->stream_heap = NULL;
@@ -544,6 +750,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) {
@@ -555,8 +764,9 @@ 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);
+               bt_heap_free(iter->stream_heap);
                g_free(iter->stream_heap);
        }
        iter->ctx->current_iterator = NULL;
@@ -565,6 +775,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);
 }
@@ -574,7 +785,10 @@ int bt_iter_next(struct bt_iter *iter)
        struct ctf_file_stream *file_stream, *removed;
        int ret;
 
-       file_stream = heap_maximum(iter->stream_heap);
+       if (!iter)
+               return -EINVAL;
+
+       file_stream = bt_heap_maximum(iter->stream_heap);
        if (!file_stream) {
                /* end of file for all streams */
                ret = 0;
@@ -583,7 +797,7 @@ int bt_iter_next(struct bt_iter *iter)
 
        ret = stream_read_event(file_stream);
        if (ret == EOF) {
-               removed = heap_remove(iter->stream_heap);
+               removed = bt_heap_remove(iter->stream_heap);
                assert(removed == file_stream);
                ret = 0;
                goto end;
@@ -591,7 +805,7 @@ int bt_iter_next(struct bt_iter *iter)
                goto end;
        }
        /* Reinsert the file stream into the heap, and rebalance. */
-       removed = heap_replace_max(iter->stream_heap, file_stream);
+       removed = bt_heap_replace_max(iter->stream_heap, file_stream);
        assert(removed == file_stream);
 
 end:
This page took 0.030697 seconds and 4 git commands to generate.