Add Jérémie Galarneau as co-maintainer
[babeltrace.git] / lib / iterator.c
index b205a93764ddc1940db73a35365977a586314b7b..a2a7bb578adca29313b9bda620382bfe67b8248c 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>
@@ -57,6 +65,9 @@ static int stream_read_event(struct ctf_file_stream *sin)
        ret = sin->pos.parent.event_cb(&sin->pos.parent, &sin->parent);
        if (ret == EOF)
                return EOF;
+       else if (ret == EAGAIN)
+               /* Stream is inactive for now (live reading). */
+               return EAGAIN;
        else if (ret) {
                fprintf(stderr, "[error] Reading event failed.\n");
                return ret;
@@ -65,16 +76,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).
  */
 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)
@@ -172,7 +191,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;
@@ -301,7 +320,7 @@ static int seek_last_ctf_trace_collection(struct trace_collection *tc,
        /* 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)
@@ -350,8 +369,8 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                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;
 
@@ -396,7 +415,7 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                        }
 
                        /* Add to heap */
-                       ret = heap_insert(iter->stream_heap,
+                       ret = bt_heap_insert(iter->stream_heap,
                                        saved_pos->file_stream);
                        if (ret)
                                goto error;
@@ -405,15 +424,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)
@@ -436,14 +455,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);
@@ -479,7 +498,7 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                                                /* Do not add EOF streams */
                                                continue;
                                        }
-                                       ret = heap_insert(iter->stream_heap, file_stream);
+                                       ret = bt_heap_insert(iter->stream_heap, file_stream);
                                        if (ret)
                                                goto error;
                                }
@@ -495,13 +514,13 @@ int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *iter_pos)
                if (ret != 0 || !cfs)
                        goto error;
                /* remove all streams from the heap */
-               heap_free(iter->stream_heap);
+               bt_heap_free(iter->stream_heap);
                /* Create a new empty heap */
-               ret = heap_init(iter->stream_heap, 0, stream_compare);
+               ret = bt_heap_init(iter->stream_heap, 0, stream_compare);
                if (ret < 0)
                        goto error;
                /* Insert the stream that contains the last event */
-               ret = heap_insert(iter->stream_heap, cfs);
+               ret = bt_heap_insert(iter->stream_heap, cfs);
                if (ret)
                        goto error;
                break;
@@ -514,10 +533,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;
@@ -547,12 +566,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;
 
@@ -576,12 +595,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:
@@ -661,13 +680,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)
@@ -686,31 +705,25 @@ 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;
-                               } else if (ret) {
+                               } else if (ret != 0 && ret != EAGAIN) {
                                        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;
                        }
@@ -718,10 +731,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;
@@ -752,7 +769,7 @@ 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;
@@ -774,7 +791,7 @@ int bt_iter_next(struct bt_iter *iter)
        if (!iter)
                return -EINVAL;
 
-       file_stream = heap_maximum(iter->stream_heap);
+       file_stream = bt_heap_maximum(iter->stream_heap);
        if (!file_stream) {
                /* end of file for all streams */
                ret = 0;
@@ -783,17 +800,32 @@ 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;
+       } else if (ret == EAGAIN) {
+               /*
+                * The stream is inactive for now, we just updated the timestamp_end
+                * to skip over this stream up to a certain point in time.
+                */
+               goto reinsert;
        } else if (ret) {
                goto end;
        }
+
+reinsert:
        /* 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);
 
+       file_stream = bt_heap_maximum(iter->stream_heap);
+       if (file_stream->pos.content_size == 0) {
+               ret = EAGAIN;
+       } else {
+               ret = 0;
+       }
+
 end:
        return ret;
 }
This page took 0.032124 seconds and 4 git commands to generate.