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
goto end;
}
- if (munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
- BT_LOGE("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s",
+ 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;
}
enum bt_ctf_notif_iter_medium_status ds_file_mmap_next(
struct ctf_fs_ds_file *ds_file)
{
- const size_t page_size = bt_common_get_page_size();
enum bt_ctf_notif_iter_medium_status ret =
BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
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) {
+ if (ds_file->mmap_len == 0) {
ret = BT_CTF_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 + page_size - 1)
- & ~(page_size - 1);
/* Map new region */
assert(ds_file->mmap_len);
- ds_file->mmap_addr = mmap((void *) 0, 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) {
- BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s",
+ 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;
}
static
struct bt_ctf_stream *medop_get_stream(
- struct bt_ctf_stream_class *stream_class, void *data)
+ struct bt_ctf_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;
return stream;
}
-static struct bt_ctf_notif_iter_medium_ops medops = {
+static
+enum bt_ctf_notif_iter_medium_status medop_seek(
+ enum bt_ctf_notif_iter_seek_whence whence, off_t offset,
+ void *data)
+{
+ enum bt_ctf_notif_iter_medium_status ret =
+ BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
+ struct ctf_fs_ds_file *ds_file = data;
+ off_t file_size = ds_file->file->size;
+
+ if (whence != BT_CTF_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_CTF_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=%zu, "
+ "mmap-len=%zu", offset, ds_file->mmap_offset,
+ ds_file->mmap_len);
+ unmap_ret = ds_file_munmap(ds_file);
+ if (unmap_ret) {
+ ret = BT_CTF_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_CTF_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_ctf_notif_iter_medium_ops ctf_fs_ds_file_medops = {
.request_bytes = medop_request_bytes,
.get_stream = medop_get_stream,
+ .seek = medop_seek,
};
+
static
struct ctf_fs_ds_index *ctf_fs_ds_index_create(size_t length)
{
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_ctf_clock_class *get_field_mapped_clock_class(
struct bt_ctf_field *field)
}
static
-int get_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file *ds_file,
+int get_packet_bounds_from_packet_context(
+ struct bt_ctf_field *packet_context,
struct bt_ctf_clock_class **_timestamp_begin_cc,
- struct bt_ctf_clock_class **_timestamp_end_cc)
+ struct bt_ctf_field **_timestamp_begin,
+ struct bt_ctf_clock_class **_timestamp_end_cc,
+ struct bt_ctf_field **_timestamp_end)
{
- int ret;
- struct bt_ctf_field *timestamp_field = NULL;
- struct bt_ctf_field *packet_context_field = NULL;
+ int ret = 0;
struct bt_ctf_clock_class *timestamp_begin_cc = NULL;
struct bt_ctf_clock_class *timestamp_end_cc = NULL;
+ struct bt_ctf_field *timestamp_begin = NULL;
+ struct bt_ctf_field *timestamp_end = 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);
+ timestamp_begin = bt_ctf_field_structure_get_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 = get_field_mapped_clock_class(timestamp_field);
+ timestamp_begin_cc = get_field_mapped_clock_class(timestamp_begin);
if (!timestamp_begin_cc) {
- BT_LOGD("Cannot retrieve the clock mapped to timestamp_begin of stream \'%s\'",
- ds_file->file->path->str);
+ BT_LOGD_STR("Cannot retrieve the clock mapped to timestamp_begin.");
}
- 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);
+ timestamp_end = bt_ctf_field_structure_get_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 = get_field_mapped_clock_class(timestamp_field);
+ timestamp_end_cc = get_field_mapped_clock_class(timestamp_end);
if (!timestamp_end_cc) {
- BT_LOGD("Cannot retrieve the clock mapped to timestamp_end in stream \'%s\'",
- ds_file->file->path->str);
+ BT_LOGD_STR("Cannot retrieve the clock mapped to timestamp_end.");
}
if (_timestamp_begin_cc) {
*_timestamp_begin_cc = bt_get(timestamp_begin_cc);
}
+ if (_timestamp_begin) {
+ *_timestamp_begin = bt_get(timestamp_begin);
+ }
if (_timestamp_end_cc) {
*_timestamp_end_cc = bt_get(timestamp_end_cc);
}
+ if (_timestamp_end) {
+ *_timestamp_end = bt_get(timestamp_end);
+ }
end:
- bt_put(packet_context_field);
- bt_put(timestamp_field);
bt_put(timestamp_begin_cc);
bt_put(timestamp_end_cc);
+ bt_put(timestamp_begin);
+ bt_put(timestamp_end);
+ return ret;
+}
+
+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)
+{
+ struct bt_ctf_field *packet_context = NULL;
+ int ret = ctf_fs_ds_file_get_packet_header_context_fields(ds_file,
+ NULL, &packet_context);
+
+ if (ret || !packet_context) {
+ BT_LOGD("Cannot retrieve packet context field of stream \'%s\'",
+ ds_file->file->path->str);
+ ret = -1;
+ goto end;
+ }
+
+ ret = get_packet_bounds_from_packet_context(packet_context,
+ timestamp_begin_cc, NULL,
+ timestamp_end_cc, NULL);
+end:
+ bt_put(packet_context);
return ret;
}
ret = get_ds_file_packet_bounds_clock_classes(ds_file,
×tamp_begin_cc, ×tamp_end_cc);
if (ret) {
- BT_LOGD("Cannot get clock classes of \"timestamp_begin\" and \"timestamp_end\" fields");
+ BT_LOGD_STR("Cannot get clock classes of \"timestamp_begin\" "
+ "and \"timestamp_end\" fields");
goto error;
}
index_basename = g_string_new(basename);
if (!index_basename) {
- BT_LOGE("Cannot allocate index file basename string");
+ BT_LOGE_STR("Cannot allocate index file basename string");
goto error;
}
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)) {
- BT_LOGW("Invalid LTTng trace index file: file size < header size");
+ BT_LOGW("Invalid LTTng trace index file: "
+ "file size (%zu bytes) < header size (%zu bytes)",
+ filesize, sizeof(*header));
goto error;
}
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");
+ 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_index_entry_size) {
- BT_LOGW("Invalid index file size; not a multiple of 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;
}
uint64_t packet_size = be64toh(file_index->packet_size);
if (packet_size % CHAR_BIT) {
- BT_LOGW("Invalid packet size encountered in index file");
+ BT_LOGW("Invalid packet size encountered in LTTng trace index file");
goto error;
}
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");
+ 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_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");
+ 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;
}
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;
}
/* 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");
+ 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:
goto end;
}
+static
+int init_index_entry(struct ctf_fs_ds_index_entry *entry,
+ struct bt_ctf_field *packet_context, off_t packet_size,
+ off_t packet_offset)
+{
+ int ret;
+ struct bt_ctf_field *timestamp_begin = NULL;
+ struct bt_ctf_field *timestamp_end = NULL;
+ struct bt_ctf_clock_class *timestamp_begin_cc = NULL;
+ struct bt_ctf_clock_class *timestamp_end_cc = NULL;
+
+ ret = get_packet_bounds_from_packet_context(packet_context,
+ ×tamp_begin_cc, ×tamp_begin,
+ ×tamp_end_cc, ×tamp_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;
+ }
+
+ assert(packet_offset >= 0);
+ entry->offset = packet_offset;
+
+ assert(packet_size >= 0);
+ entry->packet_size = packet_size;
+
+ ret = bt_ctf_field_unsigned_integer_get_value(timestamp_begin,
+ &entry->timestamp_begin);
+ if (ret) {
+ goto end;
+ }
+ ret = bt_ctf_field_unsigned_integer_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:
+ bt_put(timestamp_begin);
+ bt_put(timestamp_begin_cc);
+ bt_put(timestamp_end);
+ bt_put(timestamp_end_cc);
+ return ret;
+}
+
+static
+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_ctf_notif_iter_status iter_status;
+ struct bt_ctf_field *packet_context = NULL;
+
+ 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;
+
+ iter_status = bt_ctf_notif_iter_get_packet_header_context_fields(
+ ds_file->notif_iter, NULL, &packet_context);
+ if (iter_status != BT_CTF_NOTIF_ITER_STATUS_OK) {
+ if (iter_status == BT_CTF_NOTIF_ITER_STATUS_EOF) {
+ break;
+ }
+ goto error;
+ }
+ current_packet_offset =
+ bt_ctf_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_ctf_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_ctf_notif_iter_seek(ds_file->notif_iter,
+ next_packet_offset);
+ BT_PUT(packet_context);
+ } while (iter_status == BT_CTF_NOTIF_ITER_STATUS_OK);
+
+ if (iter_status != BT_CTF_NOTIF_ITER_STATUS_EOF) {
+ goto error;
+ }
+end:
+ bt_put(packet_context);
+ 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_notif_iter *notif_iter,
struct bt_ctf_stream *stream, const char *path)
{
int ret;
goto error;
}
- ds_file->notif_iter = bt_ctf_notif_iter_create(
- ctf_fs_trace->metadata->trace, page_size, medops, ds_file);
+ ds_file->notif_iter = notif_iter;
+ bt_ctf_notif_iter_set_medops_data(ds_file->notif_iter, ds_file);
if (!ds_file->notif_iter) {
goto error;
}
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);
+ 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
ctf_fs_file_destroy(ds_file->file);
}
- if (ds_file->notif_iter) {
- bt_ctf_notif_iter_destroy(ds_file->notif_iter);
- }
-
g_free(ds_file);
}
projects / babeltrace.git / blobdiff