source.ctf.fs: implement the trace-info query
[babeltrace.git] / plugins / ctf / fs-src / data-stream-file.c
index 16977d9d71368a441bdcb28872f4a5cf83748ed4..51908e0a8dfb2c70fceff85920a81415f7ba496d 100644 (file)
@@ -203,47 +203,191 @@ static struct bt_ctf_notif_iter_medium_ops medops = {
        .request_bytes = medop_request_bytes,
        .get_stream = medop_get_stream,
 };
+static
+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;
+}
 
 static
-int build_index_from_idx_file(struct ctf_fs_ds_file *ds_file)
+struct bt_ctf_clock_class *get_field_mapped_clock_class(
+               struct bt_ctf_field *field)
+{
+       struct bt_ctf_field_type *field_type;
+       struct bt_ctf_clock_class *clock_class = NULL;
+
+       field_type = bt_ctf_field_get_type(field);
+       if (!field_type) {
+               goto end;
+       }
+
+       clock_class = bt_ctf_field_type_integer_get_mapped_clock_class(
+                       field_type);
+       if (!clock_class) {
+               goto end;
+       }
+end:
+       bt_put(field_type);
+       return clock_class;
+}
+
+static
+int get_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file *ds_file,
+               struct bt_ctf_clock_class **_timestamp_begin_cc,
+               struct bt_ctf_clock_class **_timestamp_end_cc)
+{
+       int ret;
+       struct bt_ctf_field *timestamp_field;
+       struct bt_ctf_field *packet_context_field = NULL;
+       struct bt_ctf_clock_class *timestamp_begin_cc = NULL;
+       struct bt_ctf_clock_class *timestamp_end_cc = NULL;
+
+       ret = ctf_fs_ds_file_get_packet_header_context_fields(ds_file,
+               NULL, &packet_context_field);
+       if (ret || !packet_context_field) {
+               BT_LOGD("Cannot retrieve packet context field of stream \'%s\'",
+                               ds_file->file->path->str);
+               ret = -1;
+               goto end;
+       }
+
+       timestamp_field = bt_ctf_field_structure_get_field_by_name(
+                       packet_context_field, "timestamp_begin");
+       if (!timestamp_field) {
+               BT_LOGD("Cannot retrieve timestamp_begin field in packet context of stream \'%s\'",
+                               ds_file->file->path->str);
+               ret = -1;
+               goto end;
+       }
+
+       timestamp_begin_cc = get_field_mapped_clock_class(timestamp_field);
+       if (!timestamp_begin_cc) {
+               BT_LOGD("Cannot retrieve the clock mapped to timestamp_begin of stream \'%s\'",
+                               ds_file->file->path->str);
+       }
+       bt_put(timestamp_field);
+
+       timestamp_field = bt_ctf_field_structure_get_field_by_name(
+                       packet_context_field, "timestamp_end");
+       if (!timestamp_field) {
+               BT_LOGD("Cannot retrieve timestamp_end field in packet context of stream \'%s\'",
+                               ds_file->file->path->str);
+               ret = -1;
+               goto end;
+       }
+
+       timestamp_end_cc = get_field_mapped_clock_class(timestamp_field);
+       if (!timestamp_end_cc) {
+               BT_LOGD("Cannot retrieve the clock mapped to timestamp_end in stream \'%s\'",
+                               ds_file->file->path->str);
+       }
+
+       if (_timestamp_begin_cc) {
+               *_timestamp_begin_cc = bt_get(timestamp_begin_cc);
+       }
+       if (_timestamp_end_cc) {
+               *_timestamp_end_cc = bt_get(timestamp_end_cc);
+       }
+end:
+       bt_put(packet_context_field);
+       bt_put(timestamp_field);
+       bt_put(timestamp_begin_cc);
+       bt_put(timestamp_end_cc);
+       return ret;
+}
+
+static
+int convert_cycles_to_ns(struct bt_ctf_clock_class *clock_class,
+               uint64_t cycles, int64_t *ns)
 {
        int ret = 0;
+       struct bt_ctf_clock_value *clock_value;
+
+       assert(ns);
+       clock_value = bt_ctf_clock_value_create(clock_class, cycles);
+       if (!clock_value) {
+               ret = -1;
+               goto end;
+       }
+
+       ret = bt_ctf_clock_value_get_value_ns_from_epoch(clock_value, ns);
+       if (ret) {
+               goto end;
+       }
+end:
+       bt_put(clock_value);
+       return ret;
+}
+
+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_ctf_clock_class *timestamp_begin_cc = NULL;
+       struct bt_ctf_clock_class *timestamp_end_cc = NULL;
+
+       BT_LOGD("Building index from .idx file of stream file %s",
+                       ds_file->file->path->str);
+
+       ret = get_ds_file_packet_bounds_clock_classes(ds_file,
+                       &timestamp_begin_cc, &timestamp_end_cc);
+       if (ret) {
+               BT_LOGD("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) {
-               BT_LOGE("Failed to get the  basename of datastream file %s",
+               BT_LOGE("Cannot get the basename of datastream file %s",
                                ds_file->file->path->str);
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        directory = g_path_get_dirname(ds_file->file->path->str);
        if (!directory) {
-               BT_LOGE("Failed to get dirname of datastream file %s",
+               BT_LOGE("Cannot get dirname of datastream file %s",
                                ds_file->file->path->str);
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        index_basename = g_string_new(basename);
        if (!index_basename) {
-               BT_LOGE("Failed to allocate index file basename string");
-               ret = -1;
-               goto end;
+               BT_LOGE("Cannot allocate index file basename string");
+               goto error;
        }
 
        g_string_append(index_basename, ".idx");
@@ -251,16 +395,14 @@ 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) {
-               BT_LOGD("Failed to create new mapped file %s",
+               BT_LOGD("Cannot create new mapped file %s",
                                index_file_path);
-               ret = -1;
-               goto end;
+               goto error;
        }
        filesize = g_mapped_file_get_length(mapped_file);
        if (filesize < sizeof(*header)) {
                BT_LOGW("Invalid LTTng trace index file: file size < header size");
-               ret = -1;
-               goto end;
+               goto error;
        }
 
        mmap_begin = g_mapped_file_get_contents(mapped_file);
@@ -269,65 +411,73 @@ 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) {
                BT_LOGW("Invalid LTTng trace index: \"magic\" validation failed");
-               ret = -1;
-               goto end;
+               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)) {
+       if ((filesize - sizeof(*header)) % file_index_entry_size) {
                BT_LOGW("Invalid index file size; not a multiple of index entry size");
-               ret = -1;
-               goto end;
+               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;
                        BT_LOGW("Invalid packet size encountered in index file");
-                       goto invalid_index;
+                       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) {
+               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 index file");
-                       ret = -1;
-                       goto invalid_index;
+                       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) {
+               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 index file");
-                       ret = -1;
-                       goto invalid_index;
+                       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) {
+                       goto error;
+               }
+               ret = convert_cycles_to_ns(timestamp_end_cc,
+                               index_entry->timestamp_end,
+                               &index_entry->timestamp_end_ns);
+               if (ret) {
+                       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) {
                BT_LOGW("Invalid index; indexed size != stream file size");
-               ret = -1;
-               goto invalid_index;
+               goto error;
        }
 end:
        g_free(directory);
@@ -339,38 +489,19 @@ end:
        if (mapped_file) {
                g_mapped_file_unref(mapped_file);
        }
-       return ret;
-invalid_index:
-       g_array_free(ds_file->index.entries, TRUE);
+       bt_put(timestamp_begin_cc);
+       bt_put(timestamp_end_cc);
+       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)
-{
-       return 0;
-}
-
-static
-int init_stream_index(struct ctf_fs_ds_file *ds_file)
-{
-       int ret;
-
-       ret = build_index_from_idx_file(ds_file);
-       if (!ret) {
-               goto end;
-       }
-
-       ret = build_index_from_data_stream_file(ds_file);
-end:
-       return ret;
-}
-
 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_ctf_stream *stream, const char *path)
 {
        int ret;
        const size_t page_size = bt_common_get_page_size();
@@ -401,13 +532,6 @@ struct ctf_fs_ds_file *ctf_fs_ds_file_create(
 
        ds_file->mmap_max_len = page_size * 2048;
 
-       if (build_index) {
-               ret = init_stream_index(ds_file);
-               if (ret) {
-                       goto error;
-               }
-       }
-
        goto end;
 
 error:
@@ -419,6 +543,13 @@ end:
        return ds_file;
 }
 
+BT_HIDDEN
+struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
+               struct ctf_fs_ds_file *ds_file)
+{
+       return build_index_from_idx_file(ds_file);
+}
+
 BT_HIDDEN
 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
 {
@@ -438,10 +569,6 @@ void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
                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);
 }
 
@@ -484,19 +611,14 @@ 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 ctf_fs_ds_file *ds_file,
                struct bt_ctf_field **packet_header_field,
                struct bt_ctf_field **packet_context_field)
 {
        enum bt_ctf_notif_iter_status notif_iter_status;
-       struct ctf_fs_ds_file *ds_file;
        int ret = 0;
 
-       ds_file = ctf_fs_ds_file_create(ctf_fs_trace, NULL, path, false);
-       if (!ds_file) {
-               goto error;
-       }
-
+       assert(ds_file);
        notif_iter_status = bt_ctf_notif_iter_get_packet_header_context_fields(
                ds_file->notif_iter, packet_header_field, packet_context_field);
        switch (notif_iter_status) {
@@ -526,6 +648,18 @@ error:
        }
 
 end:
-       ctf_fs_ds_file_destroy(ds_file);
        return ret;
 }
+
+BT_HIDDEN
+void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
+{
+       if (!index) {
+               return;
+       }
+
+       if (index->entries) {
+               g_array_free(index->entries, TRUE);
+       }
+       g_free(index);
+}
This page took 0.028978 seconds and 4 git commands to generate.