lib: add internal object pool API and use it; adapt plugins/tests
[babeltrace.git] / plugins / ctf / fs-src / data-stream-file.c
index 94f2b9b3edfb1c563eaeb4d35801a71b5cd2cf89..2b97ca3a2c556b8c1f4e611fa997ac8f1b9a2d53 100644 (file)
 #include <stdbool.h>
 #include <glib.h>
 #include <inttypes.h>
-#include <sys/mman.h>
-#include <babeltrace/ctf-ir/stream.h>
-#include <babeltrace/graph/notification-iterator.h>
-#include <babeltrace/graph/notification-stream.h>
-#include <babeltrace/graph/notification-event.h>
-#include <babeltrace/graph/notification-packet.h>
+#include <babeltrace/compat/mman-internal.h>
+#include <babeltrace/endian-internal.h>
+#include <babeltrace/babeltrace.h>
+#include <babeltrace/common-internal.h>
 #include "file.h"
 #include "metadata.h"
 #include "../common/notif-iter/notif-iter.h"
-#include <assert.h>
+#include <babeltrace/assert-internal.h>
 #include "data-stream-file.h"
+#include <string.h>
 
-#define PRINT_ERR_STREAM       ctf_fs->error_fp
-#define PRINT_PREFIX           "ctf-fs-data-stream"
-#define PRINT_DBG_CHECK                ctf_fs_debug
-#include "../print.h"
+#define BT_LOG_TAG "PLUGIN-CTF-FS-SRC-DS"
+#include "logging.h"
 
 static inline
 size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file)
 {
-       return ds_file->mmap_valid_len - ds_file->request_offset;
+       return ds_file->mmap_len - ds_file->request_offset;
 }
 
 static
 int ds_file_munmap(struct ctf_fs_ds_file *ds_file)
 {
        int ret = 0;
-       struct ctf_fs_component *ctf_fs;
 
        if (!ds_file || !ds_file->mmap_addr) {
                goto end;
        }
 
-       ctf_fs = ds_file->file->ctf_fs;
-       if (munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
-               PERR("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s\n",
+       if (bt_munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
+               BT_LOGE_ERRNO("Cannot memory-unmap file",
+                       ": address=%p, size=%zu, file_path=\"%s\", file=%p",
                        ds_file->mmap_addr, ds_file->mmap_len,
-                       ds_file->file->path->str, ds_file->file->fp,
-                       strerror(errno));
+                       ds_file->file ? ds_file->file->path->str : "NULL",
+                       ds_file->file ? ds_file->file->fp : NULL);
                ret = -1;
                goto end;
        }
@@ -79,12 +75,11 @@ end:
 }
 
 static
-enum bt_ctf_notif_iter_medium_status ds_file_mmap_next(
+enum bt_notif_iter_medium_status ds_file_mmap_next(
                struct ctf_fs_ds_file *ds_file)
 {
-       enum bt_ctf_notif_iter_medium_status ret =
-                       BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
-       struct ctf_fs_component *ctf_fs = ds_file->file->ctf_fs;
+       enum bt_notif_iter_medium_status ret =
+                       BT_NOTIF_ITER_MEDIUM_STATUS_OK;
 
        /* Unmap old region */
        if (ds_file->mmap_addr) {
@@ -92,28 +87,30 @@ enum bt_ctf_notif_iter_medium_status ds_file_mmap_next(
                        goto error;
                }
 
-               ds_file->mmap_offset += ds_file->mmap_valid_len;
+               /*
+                * mmap_len is guaranteed to be page-aligned except on the
+                * last mapping where it may not be possible (since the file's
+                * size itself may not be a page multiple).
+                */
+               ds_file->mmap_offset += ds_file->mmap_len;
                ds_file->request_offset = 0;
        }
 
-       ds_file->mmap_valid_len = MIN(ds_file->file->size - ds_file->mmap_offset,
+       ds_file->mmap_len = MIN(ds_file->file->size - ds_file->mmap_offset,
                        ds_file->mmap_max_len);
-       if (ds_file->mmap_valid_len == 0) {
-               ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
+       if (ds_file->mmap_len == 0) {
+               ret = BT_NOTIF_ITER_MEDIUM_STATUS_EOF;
                goto end;
        }
-       /* Round up to next page, assuming page size being a power of 2. */
-       ds_file->mmap_len = (ds_file->mmap_valid_len + ctf_fs->page_size - 1)
-                       & ~(ctf_fs->page_size - 1);
        /* Map new region */
-       assert(ds_file->mmap_len);
-       ds_file->mmap_addr = mmap((void *) 0, ds_file->mmap_len,
+       BT_ASSERT(ds_file->mmap_len);
+       ds_file->mmap_addr = bt_mmap((void *) 0, ds_file->mmap_len,
                        PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp),
                        ds_file->mmap_offset);
        if (ds_file->mmap_addr == MAP_FAILED) {
-               PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
+               BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
                                ds_file->mmap_len, ds_file->file->path->str,
-                               ds_file->file->fp, ds_file->mmap_offset,
+                               ds_file->file->fp, (intmax_t) ds_file->mmap_offset,
                                strerror(errno));
                goto error;
        }
@@ -121,20 +118,19 @@ enum bt_ctf_notif_iter_medium_status ds_file_mmap_next(
        goto end;
 error:
        ds_file_munmap(ds_file);
-       ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
+       ret = BT_NOTIF_ITER_MEDIUM_STATUS_ERROR;
 end:
        return ret;
 }
 
 static
-enum bt_ctf_notif_iter_medium_status medop_request_bytes(
+enum bt_notif_iter_medium_status medop_request_bytes(
                size_t request_sz, uint8_t **buffer_addr,
                size_t *buffer_sz, void *data)
 {
-       enum bt_ctf_notif_iter_medium_status status =
-               BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
+       enum bt_notif_iter_medium_status status =
+               BT_NOTIF_ITER_MEDIUM_STATUS_OK;
        struct ctf_fs_ds_file *ds_file = data;
-       struct ctf_fs_component *ctf_fs = ds_file->file->ctf_fs;
 
        if (request_sz == 0) {
                goto end;
@@ -144,20 +140,20 @@ enum bt_ctf_notif_iter_medium_status medop_request_bytes(
        if (remaining_mmap_bytes(ds_file) == 0) {
                /* Are we at the end of the file? */
                if (ds_file->mmap_offset >= ds_file->file->size) {
-                       PDBG("Reached end of file \"%s\" (%p)\n",
+                       BT_LOGD("Reached end of file \"%s\" (%p)",
                                ds_file->file->path->str, ds_file->file->fp);
-                       status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
+                       status = BT_NOTIF_ITER_MEDIUM_STATUS_EOF;
                        goto end;
                }
 
                status = ds_file_mmap_next(ds_file);
                switch (status) {
-               case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK:
+               case BT_NOTIF_ITER_MEDIUM_STATUS_OK:
                        break;
-               case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF:
+               case BT_NOTIF_ITER_MEDIUM_STATUS_EOF:
                        goto end;
                default:
-                       PERR("Cannot memory-map next region of file \"%s\" (%p)\n",
+                       BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
                                        ds_file->file->path->str,
                                        ds_file->file->fp);
                        goto error;
@@ -170,23 +166,22 @@ enum bt_ctf_notif_iter_medium_status medop_request_bytes(
        goto end;
 
 error:
-       status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
+       status = BT_NOTIF_ITER_MEDIUM_STATUS_ERROR;
 
 end:
        return status;
 }
 
 static
-struct bt_ctf_stream *medop_get_stream(
-               struct bt_ctf_stream_class *stream_class, void *data)
+struct bt_stream *medop_borrow_stream(
+               struct bt_stream_class *stream_class, uint64_t stream_id,
+               void *data)
 {
        struct ctf_fs_ds_file *ds_file = data;
-       struct bt_ctf_stream_class *ds_file_stream_class;
-       struct bt_ctf_stream *stream = NULL;
-
-       ds_file_stream_class = bt_ctf_stream_get_class(ds_file->stream);
-       bt_put(ds_file_stream_class);
+       struct bt_stream_class *ds_file_stream_class;
+       struct bt_stream *stream = NULL;
 
+       ds_file_stream_class = bt_stream_borrow_class(ds_file->stream);
        if (stream_class != ds_file_stream_class) {
                /*
                 * Not supported: two packets described by two different
@@ -201,46 +196,261 @@ end:
        return stream;
 }
 
-static struct bt_ctf_notif_iter_medium_ops medops = {
+static
+enum bt_notif_iter_medium_status medop_seek(
+               enum bt_notif_iter_seek_whence whence, off_t offset,
+               void *data)
+{
+       enum bt_notif_iter_medium_status ret =
+                       BT_NOTIF_ITER_MEDIUM_STATUS_OK;
+       struct ctf_fs_ds_file *ds_file = data;
+       off_t file_size = ds_file->file->size;
+
+       if (whence != BT_NOTIF_ITER_SEEK_WHENCE_SET ||
+               offset < 0 || offset > file_size) {
+               BT_LOGE("Invalid medium seek request: whence=%d, offset=%jd, "
+                               "file-size=%jd", (int) whence, offset,
+                               file_size);
+               ret = BT_NOTIF_ITER_MEDIUM_STATUS_INVAL;
+               goto end;
+       }
+
+       /*
+        * Determine whether or not the destination is contained within the
+        * current mapping.
+        */
+       if (ds_file->mmap_addr && (offset < ds_file->mmap_offset ||
+                       offset >= ds_file->mmap_offset + ds_file->mmap_len)) {
+               int unmap_ret;
+               off_t offset_in_mapping = offset % bt_common_get_page_size();
+
+               BT_LOGD("Medium seek request cannot be accomodated by the current "
+                               "file mapping: offset=%jd, mmap-offset=%jd, "
+                               "mmap-len=%zu", offset, ds_file->mmap_offset,
+                               ds_file->mmap_len);
+               unmap_ret = ds_file_munmap(ds_file);
+               if (unmap_ret) {
+                       ret = BT_NOTIF_ITER_MEDIUM_STATUS_ERROR;
+                       goto end;
+               }
+
+               ds_file->mmap_offset = offset - offset_in_mapping;
+               ds_file->request_offset = offset_in_mapping;
+               ret = ds_file_mmap_next(ds_file);
+               if (ret != BT_NOTIF_ITER_MEDIUM_STATUS_OK) {
+                       goto end;
+               }
+       } else {
+               ds_file->request_offset = offset - ds_file->mmap_offset;
+       }
+
+       ds_file->end_reached = (offset == file_size);
+end:
+       return ret;
+}
+
+BT_HIDDEN
+struct bt_notif_iter_medium_ops ctf_fs_ds_file_medops = {
        .request_bytes = medop_request_bytes,
-       .get_stream = medop_get_stream,
+       .borrow_stream = medop_borrow_stream,
+       .seek = medop_seek,
 };
 
 static
-int build_index_from_idx_file(struct ctf_fs_ds_file *ds_file)
+struct ctf_fs_ds_index *ctf_fs_ds_index_create(size_t length)
+{
+       struct ctf_fs_ds_index *index = g_new0(struct ctf_fs_ds_index, 1);
+
+       if (!index) {
+               BT_LOGE_STR("Failed to allocate index");
+               goto error;
+       }
+
+       index->entries = g_array_sized_new(FALSE, TRUE,
+                       sizeof(struct ctf_fs_ds_index_entry), length);
+       if (!index->entries) {
+               BT_LOGE("Failed to allocate %zu index entries.", length);
+               goto error;
+       }
+       g_array_set_size(index->entries, length);
+end:
+       return index;
+error:
+       ctf_fs_ds_index_destroy(index);
+       goto end;
+}
+
+/* Returns a new, zeroed, index entry. */
+static
+struct ctf_fs_ds_index_entry *ctf_fs_ds_index_add_new_entry(
+               struct ctf_fs_ds_index *index)
+{
+       g_array_set_size(index->entries, index->entries->len + 1);
+       return &g_array_index(index->entries, struct ctf_fs_ds_index_entry,
+                       index->entries->len - 1);
+}
+
+static
+struct bt_clock_class *borrow_field_mapped_clock_class(
+               struct bt_field *field)
+{
+       struct bt_field_type *field_type;
+       struct bt_clock_class *clock_class = NULL;
+
+       field_type = bt_field_borrow_type(field);
+       if (!field_type) {
+               goto end;
+       }
+
+       clock_class = bt_field_type_integer_borrow_mapped_clock_class(
+               field_type);
+       if (!clock_class) {
+               goto end;
+       }
+
+end:
+       return clock_class;
+}
+
+static
+int borrow_packet_bounds_from_packet_context(
+               struct bt_field *packet_context,
+               struct bt_clock_class **_timestamp_begin_cc,
+               struct bt_field **_timestamp_begin,
+               struct bt_clock_class **_timestamp_end_cc,
+               struct bt_field **_timestamp_end)
 {
        int ret = 0;
+       struct bt_clock_class *timestamp_begin_cc = NULL;
+       struct bt_clock_class *timestamp_end_cc = NULL;
+       struct bt_field *timestamp_begin = NULL;
+       struct bt_field *timestamp_end = NULL;
+
+       timestamp_begin = bt_field_structure_borrow_field_by_name(
+                       packet_context, "timestamp_begin");
+       if (!timestamp_begin) {
+               BT_LOGD_STR("Cannot retrieve timestamp_begin field in packet context.");
+               ret = -1;
+               goto end;
+       }
+
+       timestamp_begin_cc = borrow_field_mapped_clock_class(timestamp_begin);
+       if (!timestamp_begin_cc) {
+               BT_LOGD_STR("Cannot retrieve the clock mapped to timestamp_begin.");
+       }
+
+       timestamp_end = bt_field_structure_borrow_field_by_name(
+                       packet_context, "timestamp_end");
+       if (!timestamp_end) {
+               BT_LOGD_STR("Cannot retrieve timestamp_end field in packet context.");
+               ret = -1;
+               goto end;
+       }
+
+       timestamp_end_cc = borrow_field_mapped_clock_class(timestamp_end);
+       if (!timestamp_end_cc) {
+               BT_LOGD_STR("Cannot retrieve the clock mapped to timestamp_end.");
+       }
+
+       if (_timestamp_begin_cc) {
+               *_timestamp_begin_cc = timestamp_begin_cc;
+       }
+       if (_timestamp_begin) {
+               *_timestamp_begin = timestamp_begin;
+       }
+       if (_timestamp_end_cc) {
+               *_timestamp_end_cc = timestamp_end_cc;
+       }
+       if (_timestamp_end) {
+               *_timestamp_end = timestamp_end;
+       }
+end:
+       return ret;
+}
+
+static
+int borrow_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file *ds_file,
+               struct bt_clock_class **timestamp_begin_cc,
+               struct bt_clock_class **timestamp_end_cc)
+{
+       struct bt_field *packet_context = NULL;
+       int ret = ctf_fs_ds_file_borrow_packet_header_context_fields(ds_file,
+               NULL, &packet_context);
+
+       if (ret || !packet_context) {
+               BT_LOGD("Cannot retrieve packet context field: ds-file-path=\"%s\"",
+                       ds_file->file->path->str);
+               ret = -1;
+               goto end;
+       }
+
+       ret = borrow_packet_bounds_from_packet_context(packet_context,
+                       timestamp_begin_cc, NULL,
+                       timestamp_end_cc, NULL);
+
+end:
+       return ret;
+}
+
+static
+int convert_cycles_to_ns(struct bt_clock_class *clock_class,
+               uint64_t cycles, int64_t *ns)
+{
+       return bt_clock_class_cycles_to_ns(clock_class, cycles, ns);
+}
+
+static
+struct ctf_fs_ds_index *build_index_from_idx_file(
+               struct ctf_fs_ds_file *ds_file)
+{
+       int ret;
        gchar *directory = NULL;
        gchar *basename = NULL;
        GString *index_basename = NULL;
        gchar *index_file_path = NULL;
        GMappedFile *mapped_file = NULL;
        gsize filesize;
-       const struct ctf_packet_index_file_hdr *header;
-       const char *mmap_begin, *file_pos;
-       struct index_entry *index;
+       const char *mmap_begin = NULL, *file_pos = NULL;
+       const struct ctf_packet_index_file_hdr *header = NULL;
+       struct ctf_fs_ds_index *index = NULL;
+       struct ctf_fs_ds_index_entry *index_entry = NULL;
        uint64_t total_packets_size = 0;
        size_t file_index_entry_size;
        size_t file_entry_count;
        size_t i;
+       struct bt_clock_class *timestamp_begin_cc = NULL;
+       struct bt_clock_class *timestamp_end_cc = NULL;
+
+       BT_LOGD("Building index from .idx file of stream file %s",
+                       ds_file->file->path->str);
+
+       ret = borrow_ds_file_packet_bounds_clock_classes(ds_file,
+                       &timestamp_begin_cc, &timestamp_end_cc);
+       if (ret) {
+               BT_LOGD_STR("Cannot get clock classes of \"timestamp_begin\" "
+                               "and \"timestamp_end\" fields");
+               goto error;
+       }
 
        /* Look for index file in relative path index/name.idx. */
        basename = g_path_get_basename(ds_file->file->path->str);
        if (!basename) {
-               ret = -1;
-               goto end;
+               BT_LOGE("Cannot get the basename of datastream file %s",
+                               ds_file->file->path->str);
+               goto error;
        }
 
        directory = g_path_get_dirname(ds_file->file->path->str);
        if (!directory) {
-               ret = -1;
-               goto end;
+               BT_LOGE("Cannot get dirname of datastream file %s",
+                               ds_file->file->path->str);
+               goto error;
        }
 
        index_basename = g_string_new(basename);
        if (!index_basename) {
-               ret = -1;
-               goto end;
+               BT_LOGE_STR("Cannot allocate index file basename string");
+               goto error;
        }
 
        g_string_append(index_basename, ".idx");
@@ -248,14 +458,22 @@ int build_index_from_idx_file(struct ctf_fs_ds_file *ds_file)
                        index_basename->str, NULL);
        mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
        if (!mapped_file) {
-               ret = -1;
-               goto end;
+               BT_LOGD("Cannot create new mapped file %s",
+                               index_file_path);
+               goto error;
        }
+
+       /*
+        * The g_mapped_file API limits us to 4GB files on 32-bit.
+        * Traces with such large indexes have never been seen in the wild,
+        * but this would need to be adjusted to support them.
+        */
        filesize = g_mapped_file_get_length(mapped_file);
        if (filesize < sizeof(*header)) {
-               printf_error("Invalid LTTng trace index: file size < header size");
-               ret = -1;
-               goto end;
+               BT_LOGW("Invalid LTTng trace index file: "
+                       "file size (%zu bytes) < header size (%zu bytes)",
+                       filesize, sizeof(*header));
+               goto error;
        }
 
        mmap_begin = g_mapped_file_get_contents(mapped_file);
@@ -263,66 +481,86 @@ int build_index_from_idx_file(struct ctf_fs_ds_file *ds_file)
 
        file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
        if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
-               printf_error("Invalid LTTng trace index: \"magic\" validation failed");
-               ret = -1;
-               goto end;
+               BT_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
+               goto error;
        }
 
        file_index_entry_size = be32toh(header->packet_index_len);
        file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
-       if ((filesize - sizeof(*header)) % (file_entry_count * file_index_entry_size)) {
-               printf_error("Invalid index file size; not a multiple of index entry size");
-               ret = -1;
-               goto end;
+       if ((filesize - sizeof(*header)) % file_index_entry_size) {
+               BT_LOGW("Invalid LTTng trace index: the index's size after the header "
+                       "(%zu bytes) is not a multiple of the index entry size "
+                       "(%zu bytes)", (filesize - sizeof(*header)),
+                       sizeof(*header));
+               goto error;
        }
 
-       ds_file->index.entries = g_array_sized_new(FALSE, TRUE,
-                       sizeof(struct index_entry), file_entry_count);
-       if (!ds_file->index.entries) {
-               ret = -1;
-               goto end;
+       index = ctf_fs_ds_index_create(file_entry_count);
+       if (!index) {
+               goto error;
        }
-       index = (struct index_entry *) ds_file->index.entries->data;
+
+       index_entry = (struct ctf_fs_ds_index_entry *) &g_array_index(
+                       index->entries, struct ctf_fs_ds_index_entry, 0);
        for (i = 0; i < file_entry_count; i++) {
                struct ctf_packet_index *file_index =
                                (struct ctf_packet_index *) file_pos;
                uint64_t packet_size = be64toh(file_index->packet_size);
 
                if (packet_size % CHAR_BIT) {
-                       ret = -1;
-                       printf_error("Invalid packet size encountered in index file");
-                       goto invalid_index;
+                       BT_LOGW("Invalid packet size encountered in LTTng trace index file");
+                       goto error;
                }
 
                /* Convert size in bits to bytes. */
                packet_size /= CHAR_BIT;
-               index->packet_size = packet_size;
+               index_entry->packet_size = packet_size;
 
-               index->offset = be64toh(file_index->offset);
-               if (i != 0 && index->offset < (index - 1)->offset) {
-                       printf_error("Invalid, non-monotonic, packet offset encountered in index file");
-                       ret = -1;
-                       goto invalid_index;
+               index_entry->offset = be64toh(file_index->offset);
+               if (i != 0 && index_entry->offset < (index_entry - 1)->offset) {
+                       BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
+                               "previous offset=%" PRIu64 ", current offset=%" PRIu64,
+                               (index_entry - 1)->offset, index_entry->offset);
+                       goto error;
                }
 
-               index->timestamp_begin = be64toh(file_index->timestamp_begin);
-               index->timestamp_end = be64toh(file_index->timestamp_end);
-               if (index->timestamp_end < index->timestamp_begin) {
-                       printf_error("Invalid packet time bounds encountered in index file");
-                       ret = -1;
-                       goto invalid_index;
+               index_entry->timestamp_begin = be64toh(file_index->timestamp_begin);
+               index_entry->timestamp_end = be64toh(file_index->timestamp_end);
+               if (index_entry->timestamp_end < index_entry->timestamp_begin) {
+                       BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
+                               "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64,
+                               index_entry->timestamp_begin,
+                               index_entry->timestamp_end);
+                       goto error;
+               }
+
+               /* Convert the packet's bound to nanoseconds since Epoch. */
+               ret = convert_cycles_to_ns(timestamp_begin_cc,
+                               index_entry->timestamp_begin,
+                               &index_entry->timestamp_begin_ns);
+               if (ret) {
+                       BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
+                       goto error;
+               }
+               ret = convert_cycles_to_ns(timestamp_end_cc,
+                               index_entry->timestamp_end,
+                               &index_entry->timestamp_end_ns);
+               if (ret) {
+                       BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
+                       goto error;
                }
 
                total_packets_size += packet_size;
                file_pos += file_index_entry_size;
-               index++;
+               index_entry++;
        }
 
        /* Validate that the index addresses the complete stream. */
        if (ds_file->file->size != total_packets_size) {
-               printf_error("Invalid index; indexed size != stream file size");
-               ret = -1;
-               goto invalid_index;
+               BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
+                       "file-size=%" PRIu64 ", total-packets-size=%" PRIu64,
+                       ds_file->file->size, total_packets_size);
+               goto error;
        }
 end:
        g_free(directory);
@@ -334,47 +572,183 @@ end:
        if (mapped_file) {
                g_mapped_file_unref(mapped_file);
        }
-       return ret;
-invalid_index:
-       g_array_free(ds_file->index.entries, TRUE);
+       return index;
+error:
+       ctf_fs_ds_index_destroy(index);
+       index = NULL;
        goto end;
 }
 
 static
-int build_index_from_data_stream_file(struct ctf_fs_ds_file *stream)
+int init_index_entry(struct ctf_fs_ds_index_entry *entry,
+               struct bt_field *packet_context, off_t packet_size,
+               off_t packet_offset)
 {
-       return 0;
+       int ret;
+       struct bt_field *timestamp_begin = NULL;
+       struct bt_field *timestamp_end = NULL;
+       struct bt_clock_class *timestamp_begin_cc = NULL;
+       struct bt_clock_class *timestamp_end_cc = NULL;
+
+       ret = borrow_packet_bounds_from_packet_context(packet_context,
+                       &timestamp_begin_cc, &timestamp_begin,
+                       &timestamp_end_cc, &timestamp_end);
+       if (ret || !timestamp_begin_cc || !timestamp_begin ||
+                       !timestamp_end_cc || ! timestamp_end) {
+               BT_LOGD_STR("Failed to determine time bound fields of packet.");
+               goto end;
+       }
+
+       BT_ASSERT(packet_offset >= 0);
+       entry->offset = packet_offset;
+
+       BT_ASSERT(packet_size >= 0);
+       entry->packet_size = packet_size;
+
+       ret = bt_field_integer_unsigned_get_value(timestamp_begin,
+                       &entry->timestamp_begin);
+       if (ret) {
+               goto end;
+       }
+       ret = bt_field_integer_unsigned_get_value(timestamp_end,
+                       &entry->timestamp_end);
+       if (ret) {
+               goto end;
+       }
+
+       /* Convert the packet's bound to nanoseconds since Epoch. */
+       ret = convert_cycles_to_ns(timestamp_begin_cc,
+                                  entry->timestamp_begin,
+                                  &entry->timestamp_begin_ns);
+       if (ret) {
+               BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
+               goto end;
+       }
+
+       ret = convert_cycles_to_ns(timestamp_end_cc,
+                                  entry->timestamp_end,
+                                  &entry->timestamp_end_ns);
+       if (ret) {
+               BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
+               goto end;
+       }
+
+end:
+       return ret;
 }
 
 static
-int init_stream_index(struct ctf_fs_ds_file *ds_file)
+struct ctf_fs_ds_index *build_index_from_stream_file(
+               struct ctf_fs_ds_file *ds_file)
 {
        int ret;
+       struct ctf_fs_ds_index *index = NULL;
+       enum bt_notif_iter_status iter_status;
 
-       ret = build_index_from_idx_file(ds_file);
-       if (!ret) {
-               goto end;
+       BT_LOGD("Indexing stream file %s", ds_file->file->path->str);
+
+       index = ctf_fs_ds_index_create(0);
+       if (!index) {
+               goto error;
+       }
+
+       do {
+               off_t current_packet_offset;
+               off_t next_packet_offset;
+               off_t current_packet_size, current_packet_size_bytes;
+               struct ctf_fs_ds_index_entry *entry;
+               struct bt_field *packet_context = NULL;
+
+               iter_status = bt_notif_iter_borrow_packet_header_context_fields(
+                       ds_file->notif_iter, NULL, &packet_context);
+               if (iter_status != BT_NOTIF_ITER_STATUS_OK) {
+                       if (iter_status == BT_NOTIF_ITER_STATUS_EOF) {
+                               break;
+                       }
+                       goto error;
+               }
+
+               current_packet_offset =
+                       bt_notif_iter_get_current_packet_offset(
+                               ds_file->notif_iter);
+               if (current_packet_offset < 0) {
+                       BT_LOGE_STR("Cannot get the current packet's offset.");
+                       goto error;
+               }
+
+               current_packet_size = bt_notif_iter_get_current_packet_size(
+                       ds_file->notif_iter);
+               if (current_packet_size < 0) {
+                       BT_LOGE("Cannot get packet size: packet-offset=%jd",
+                                       current_packet_offset);
+                       goto error;
+               }
+               current_packet_size_bytes =
+                       ((current_packet_size + 7) & ~7) / CHAR_BIT;
+
+               if (current_packet_offset + current_packet_size_bytes >
+                               ds_file->file->size) {
+                       BT_LOGW("Invalid packet size reported in file: stream=\"%s\", "
+                                       "packet-offset=%jd, packet-size-bytes=%jd, "
+                                       "file-size=%jd",
+                                       ds_file->file->path->str,
+                                       current_packet_offset,
+                                       current_packet_size_bytes,
+                                       ds_file->file->size);
+                       goto error;
+               }
+
+               next_packet_offset = current_packet_offset +
+                       current_packet_size_bytes;
+               BT_LOGD("Seeking to next packet: current-packet-offset=%jd, "
+                       "next-packet-offset=%jd", current_packet_offset,
+                       next_packet_offset);
+
+               entry = ctf_fs_ds_index_add_new_entry(index);
+               if (!entry) {
+                       BT_LOGE_STR("Failed to allocate a new index entry.");
+                       goto error;
+               }
+
+               ret = init_index_entry(entry, packet_context,
+                       current_packet_size_bytes,
+                       current_packet_offset);
+               if (ret) {
+                       goto error;
+               }
+
+               iter_status = bt_notif_iter_seek(ds_file->notif_iter,
+                               next_packet_offset);
+       } while (iter_status == BT_NOTIF_ITER_STATUS_OK);
+
+       if (iter_status != BT_NOTIF_ITER_STATUS_EOF) {
+               goto error;
        }
 
-       ret = build_index_from_data_stream_file(ds_file);
 end:
-       return ret;
+       return index;
+
+error:
+       ctf_fs_ds_index_destroy(index);
+       index = NULL;
+       goto end;
 }
 
 BT_HIDDEN
 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
                struct ctf_fs_trace *ctf_fs_trace,
-               struct bt_ctf_stream *stream, const char *path,
-               bool build_index)
+               struct bt_notif_iter *notif_iter,
+               struct bt_stream *stream, const char *path)
 {
        int ret;
+       const size_t page_size = bt_common_get_page_size();
        struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
 
        if (!ds_file) {
                goto error;
        }
 
-       ds_file->file = ctf_fs_file_create(ctf_fs_trace->ctf_fs);
+       ds_file->file = ctf_fs_file_create();
        if (!ds_file->file) {
                goto error;
        }
@@ -382,27 +756,18 @@ struct ctf_fs_ds_file *ctf_fs_ds_file_create(
        ds_file->stream = bt_get(stream);
        ds_file->cc_prio_map = bt_get(ctf_fs_trace->cc_prio_map);
        g_string_assign(ds_file->file->path, path);
-       ret = ctf_fs_file_open(ctf_fs_trace->ctf_fs, ds_file->file, "rb");
+       ret = ctf_fs_file_open(ds_file->file, "rb");
        if (ret) {
                goto error;
        }
 
-       ds_file->notif_iter = bt_ctf_notif_iter_create(
-               ctf_fs_trace->metadata->trace,
-               ctf_fs_trace->ctf_fs->page_size, medops, ds_file,
-               ctf_fs_trace->ctf_fs->error_fp);
+       ds_file->notif_iter = notif_iter;
+       bt_notif_iter_set_medops_data(ds_file->notif_iter, ds_file);
        if (!ds_file->notif_iter) {
                goto error;
        }
 
-       ds_file->mmap_max_len = ctf_fs_trace->ctf_fs->page_size * 2048;
-
-       if (build_index) {
-               ret = init_stream_index(ds_file);
-               if (ret) {
-                       goto error;
-               }
-       }
+       ds_file->mmap_max_len = page_size * 2048;
 
        goto end;
 
@@ -415,6 +780,24 @@ end:
        return ds_file;
 }
 
+BT_HIDDEN
+struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
+               struct ctf_fs_ds_file *ds_file)
+{
+       struct ctf_fs_ds_index *index;
+
+       index = build_index_from_idx_file(ds_file);
+       if (index) {
+               goto end;
+       }
+
+       BT_LOGD("Failed to build index from .index file; "
+               "falling back to stream indexing.");
+       index = build_index_from_stream_file(ds_file);
+end:
+       return index;
+}
+
 BT_HIDDEN
 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
 {
@@ -430,46 +813,38 @@ void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
                ctf_fs_file_destroy(ds_file->file);
        }
 
-       if (ds_file->notif_iter) {
-               bt_ctf_notif_iter_destroy(ds_file->notif_iter);
-       }
-
-       if (ds_file->index.entries) {
-               g_array_free(ds_file->index.entries, TRUE);
-       }
-
        g_free(ds_file);
 }
 
 BT_HIDDEN
-struct bt_notification_iterator_next_return ctf_fs_ds_file_next(
+struct bt_notification_iterator_next_method_return ctf_fs_ds_file_next(
                struct ctf_fs_ds_file *ds_file)
 {
-       enum bt_ctf_notif_iter_status notif_iter_status;
-       struct bt_notification_iterator_next_return ret = {
+       enum bt_notif_iter_status notif_iter_status;
+       struct bt_notification_iterator_next_method_return ret = {
                .status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
                .notification = NULL,
        };
 
-       notif_iter_status = bt_ctf_notif_iter_get_next_notification(
+       notif_iter_status = bt_notif_iter_get_next_notification(
                ds_file->notif_iter, ds_file->cc_prio_map, &ret.notification);
 
        switch (notif_iter_status) {
-       case BT_CTF_NOTIF_ITER_STATUS_EOF:
+       case BT_NOTIF_ITER_STATUS_EOF:
                ret.status = BT_NOTIFICATION_ITERATOR_STATUS_END;
                break;
-       case BT_CTF_NOTIF_ITER_STATUS_OK:
+       case BT_NOTIF_ITER_STATUS_OK:
                ret.status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
                break;
-       case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
+       case BT_NOTIF_ITER_STATUS_AGAIN:
                /*
                 * Should not make it this far as this is
                 * medium-specific; there is nothing for the user to do
                 * and it should have been handled upstream.
                 */
                abort();
-       case BT_CTF_NOTIF_ITER_STATUS_INVAL:
-       case BT_CTF_NOTIF_ITER_STATUS_ERROR:
+       case BT_NOTIF_ITER_STATUS_INVAL:
+       case BT_NOTIF_ITER_STATUS_ERROR:
        default:
                ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
                break;
@@ -479,30 +854,25 @@ struct bt_notification_iterator_next_return ctf_fs_ds_file_next(
 }
 
 BT_HIDDEN
-int ctf_fs_ds_file_get_packet_header_context_fields(
-               struct ctf_fs_trace *ctf_fs_trace, const char *path,
-               struct bt_ctf_field **packet_header_field,
-               struct bt_ctf_field **packet_context_field)
+int ctf_fs_ds_file_borrow_packet_header_context_fields(
+               struct ctf_fs_ds_file *ds_file,
+               struct bt_field **packet_header_field,
+               struct bt_field **packet_context_field)
 {
-       enum bt_ctf_notif_iter_status notif_iter_status;
-       struct ctf_fs_ds_file *ds_file;
+       enum bt_notif_iter_status notif_iter_status;
        int ret = 0;
 
-       ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, path, false);
-       if (!ds_file) {
-               goto error;
-       }
-
-       notif_iter_status = bt_ctf_notif_iter_get_packet_header_context_fields(
+       BT_ASSERT(ds_file);
+       notif_iter_status = bt_notif_iter_borrow_packet_header_context_fields(
                ds_file->notif_iter, packet_header_field, packet_context_field);
        switch (notif_iter_status) {
-       case BT_CTF_NOTIF_ITER_STATUS_EOF:
-       case BT_CTF_NOTIF_ITER_STATUS_OK:
+       case BT_NOTIF_ITER_STATUS_EOF:
+       case BT_NOTIF_ITER_STATUS_OK:
                break;
-       case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
+       case BT_NOTIF_ITER_STATUS_AGAIN:
                abort();
-       case BT_CTF_NOTIF_ITER_STATUS_INVAL:
-       case BT_CTF_NOTIF_ITER_STATUS_ERROR:
+       case BT_NOTIF_ITER_STATUS_INVAL:
+       case BT_NOTIF_ITER_STATUS_ERROR:
        default:
                goto error;
                break;
@@ -513,15 +883,19 @@ int ctf_fs_ds_file_get_packet_header_context_fields(
 error:
        ret = -1;
 
-       if (packet_header_field) {
-               bt_put(*packet_header_field);
-       }
+end:
+       return ret;
+}
 
-       if (packet_context_field) {
-               bt_put(*packet_context_field);
+BT_HIDDEN
+void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
+{
+       if (!index) {
+               return;
        }
 
-end:
-       ctf_fs_ds_file_destroy(ds_file);
-       return ret;
+       if (index->entries) {
+               g_array_free(index->entries, TRUE);
+       }
+       g_free(index);
 }
This page took 0.044414 seconds and 4 git commands to generate.