#include <glib.h>
#include <stdint.h>
#include <stdio.h>
+#include <sys/stat.h>
#include "compat/endian.h" /* IWYU pragma: keep */
#include "compat/mman.h" /* IWYU: pragma keep */
#include "cpp-common/bt2s/make-unique.hpp"
#include "cpp-common/vendor/fmt/format.h"
-#include "../common/src/msg-iter/msg-iter.hpp"
+#include "../common/src/pkt-props.hpp"
#include "data-stream-file.hpp"
#include "file.hpp"
-#include "fs.hpp"
#include "lttng-index.hpp"
-static inline size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file)
+using namespace bt2c::literals::datalen;
+
+static bt2c::DataLen getFileSize(const char * const path, const bt2c::Logger& logger)
+{
+ struct stat st;
+ if (stat(path, &st) != 0) {
+ BT_CPPLOGE_ERRNO_APPEND_CAUSE_AND_THROW_SPEC(logger, bt2::Error,
+ "Failed to stat stream file", "path={}", path);
+ }
+
+ return bt2c::DataLen::fromBytes(st.st_size);
+}
+
+ctf_fs_ds_file_info::ctf_fs_ds_file_info(std::string pathParam, const bt2c::Logger& parentLogger) :
+ logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS-FILE-INFO"}, path(std::move(pathParam)),
+ size(getFileSize(path.c_str(), logger))
{
- BT_ASSERT_DBG(ds_file->mmap_len >= ds_file->request_offset_in_mapping);
- return ds_file->mmap_len - ds_file->request_offset_in_mapping;
}
/*
static bool offset_ist_mapped(struct ctf_fs_ds_file *ds_file, off_t offset_in_file)
{
+ if (!ds_file->mmap_addr)
+ return false;
+
return offset_in_file >= ds_file->mmap_offset_in_file &&
offset_in_file < (ds_file->mmap_offset_in_file + ds_file->mmap_len);
}
-static enum ctf_msg_iter_medium_status ds_file_munmap(struct ctf_fs_ds_file *ds_file)
+enum ds_file_status
+{
+ DS_FILE_STATUS_OK = 0,
+ DS_FILE_STATUS_ERROR = -1,
+ DS_FILE_STATUS_EOF = 1,
+};
+
+static ds_file_status ds_file_munmap(struct ctf_fs_ds_file *ds_file)
{
BT_ASSERT(ds_file);
if (!ds_file->mmap_addr) {
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
+ return DS_FILE_STATUS_OK;
}
if (bt_munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
": address={}, size={}, file_path=\"{}\", file={}",
fmt::ptr(ds_file->mmap_addr), ds_file->mmap_len,
ds_file->file ? ds_file->file->path : "NULL",
- ds_file->file ? fmt::ptr(ds_file->file->fp) : NULL);
- return CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
+ ds_file->file ? fmt::ptr(ds_file->file->fp) : nullptr);
+ return DS_FILE_STATUS_ERROR;
}
ds_file->mmap_addr = NULL;
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
+ return DS_FILE_STATUS_OK;
}
/*
* mapping. If the currently mmap-ed region already contains
* `requested_offset_in_file`, the mapping is kept.
*
- * Set `ds_file->requested_offset_in_mapping` based on `request_offset_in_file`,
- * such that the next call to `request_bytes` will return bytes starting at that
- * position.
- *
* `requested_offset_in_file` must be a valid offset in the file.
*/
-static enum ctf_msg_iter_medium_status ds_file_mmap(struct ctf_fs_ds_file *ds_file,
- off_t requested_offset_in_file)
+static ds_file_status ds_file_mmap(struct ctf_fs_ds_file *ds_file, off_t requested_offset_in_file)
{
/* Ensure the requested offset is in the file range. */
BT_ASSERT(requested_offset_in_file >= 0);
BT_ASSERT(requested_offset_in_file < ds_file->file->size);
/*
- * If the mapping already contains the requested offset, just adjust
- * requested_offset_in_mapping.
+ * If the mapping already contains the requested range, we have nothing to
+ * do.
*/
if (offset_ist_mapped(ds_file, requested_offset_in_file)) {
- ds_file->request_offset_in_mapping =
- requested_offset_in_file - ds_file->mmap_offset_in_file;
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
+ return DS_FILE_STATUS_OK;
}
/* Unmap old region */
- ctf_msg_iter_medium_status status = ds_file_munmap(ds_file);
- if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) {
+ ds_file_status status = ds_file_munmap(ds_file);
+ if (status != DS_FILE_STATUS_OK) {
return status;
}
* Compute a mapping that has the required alignment properties and
* contains `requested_offset_in_file`.
*/
- ds_file->request_offset_in_mapping =
- requested_offset_in_file %
- bt_mmap_get_offset_align_size(static_cast<int>(ds_file->logger.level()));
- ds_file->mmap_offset_in_file = requested_offset_in_file - ds_file->request_offset_in_mapping;
+ size_t alignment = bt_mmap_get_offset_align_size(static_cast<int>(ds_file->logger.level()));
+ ds_file->mmap_offset_in_file =
+ requested_offset_in_file - (requested_offset_in_file % alignment);
ds_file->mmap_len =
MIN(ds_file->file->size - ds_file->mmap_offset_in_file, ds_file->mmap_max_len);
BT_ASSERT(ds_file->mmap_len > 0);
+ BT_ASSERT(requested_offset_in_file >= ds_file->mmap_offset_in_file);
+ BT_ASSERT(requested_offset_in_file < (ds_file->mmap_offset_in_file + ds_file->mmap_len));
ds_file->mmap_addr =
bt_mmap(ds_file->mmap_len, PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp.get()),
"Cannot memory-map address (size {}) of file \"{}\" ({}) at offset {}: {}",
ds_file->mmap_len, ds_file->file->path, fmt::ptr(ds_file->file->fp),
(intmax_t) ds_file->mmap_offset_in_file, strerror(errno));
- return CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
- }
-
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
-}
-
-/*
- * Change the mapping of the file to read the region that follows the current
- * mapping.
- *
- * If the file hasn't been mapped yet, then everything (mmap_offset_in_file,
- * mmap_len, request_offset_in_mapping) should have the value 0, which will
- * result in the beginning of the file getting mapped.
- *
- * return _EOF if the current mapping is the end of the file.
- */
-
-static enum ctf_msg_iter_medium_status ds_file_mmap_next(struct ctf_fs_ds_file *ds_file)
-{
- /*
- * If we're called, it's because more bytes are requested but we have
- * given all the bytes of the current mapping.
- */
- BT_ASSERT(ds_file->request_offset_in_mapping == ds_file->mmap_len);
-
- /*
- * If the current mapping coincides with the end of the file, there is
- * no next mapping.
- */
- if (ds_file->mmap_offset_in_file + ds_file->mmap_len == ds_file->file->size) {
- return CTF_MSG_ITER_MEDIUM_STATUS_EOF;
+ return DS_FILE_STATUS_ERROR;
}
- return ds_file_mmap(ds_file, ds_file->mmap_offset_in_file + ds_file->mmap_len);
+ return DS_FILE_STATUS_OK;
}
-static enum ctf_msg_iter_medium_status medop_request_bytes(size_t request_sz, uint8_t **buffer_addr,
- size_t *buffer_sz, void *data)
+void ctf_fs_ds_index::updateOffsetsInStream()
{
- struct ctf_fs_ds_file *ds_file = (struct ctf_fs_ds_file *) data;
+ auto offsetInStream = 0_bytes;
- BT_ASSERT(request_sz > 0);
-
- /*
- * Check if we have at least one memory-mapped byte left. If we don't,
- * mmap the next file.
- */
- if (remaining_mmap_bytes(ds_file) == 0) {
- /* Are we at the end of the file? */
- if (ds_file->mmap_offset_in_file >= ds_file->file->size) {
- BT_CPPLOGD_SPEC(ds_file->logger, "Reached end of file \"{}\" ({})", ds_file->file->path,
- fmt::ptr(ds_file->file->fp));
- return CTF_MSG_ITER_MEDIUM_STATUS_EOF;
- }
-
- ctf_msg_iter_medium_status status = ds_file_mmap_next(ds_file);
- switch (status) {
- case CTF_MSG_ITER_MEDIUM_STATUS_OK:
- break;
- case CTF_MSG_ITER_MEDIUM_STATUS_EOF:
- return CTF_MSG_ITER_MEDIUM_STATUS_EOF;
- default:
- BT_CPPLOGE_SPEC(ds_file->logger, "Cannot memory-map next region of file \"{}\" ({})",
- ds_file->file->path, fmt::ptr(ds_file->file->fp));
- return status;
- }
- }
-
- BT_ASSERT(remaining_mmap_bytes(ds_file) > 0);
- *buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz);
-
- BT_ASSERT(ds_file->mmap_addr);
- *buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset_in_mapping;
-
- ds_file->request_offset_in_mapping += *buffer_sz;
-
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
-}
-
-static bt_stream *medop_borrow_stream(bt_stream_class *stream_class, int64_t, void *data)
-{
- struct ctf_fs_ds_file *ds_file = (struct ctf_fs_ds_file *) data;
- bt_stream_class *ds_file_stream_class;
-
- ds_file_stream_class = ds_file->stream->cls().libObjPtr();
-
- if (stream_class != ds_file_stream_class) {
- /*
- * Not supported: two packets described by two different
- * stream classes within the same data stream file.
- */
- return nullptr;
+ for (ctf_fs_ds_index_entry& entry : this->entries) {
+ entry.offsetInStream = offsetInStream;
+ offsetInStream += entry.packetSize;
}
-
- return ds_file->stream->libObjPtr();
}
-static enum ctf_msg_iter_medium_status medop_seek(off_t offset, void *data)
+static int convert_cycles_to_ns(const ctf::src::ClkCls& clockClass, uint64_t cycles, int64_t *ns)
{
- struct ctf_fs_ds_file *ds_file = (struct ctf_fs_ds_file *) data;
-
- BT_ASSERT(offset >= 0);
- BT_ASSERT(offset < ds_file->file->size);
-
- return ds_file_mmap(ds_file, offset);
-}
-
-struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops = {
- medop_request_bytes,
- medop_seek,
- nullptr,
- medop_borrow_stream,
-};
-
-struct ctf_fs_ds_group_medops_data
-{
- explicit ctf_fs_ds_group_medops_data(const bt2c::Logger& parentLogger) :
- logger {parentLogger, "PLUGIN/SRC.CTF.FS/DS-GROUP-MEDOPS"}
- {
- }
-
- bt2c::Logger logger;
-
- /* Weak, set once at creation time. */
- struct ctf_fs_ds_file_group *ds_file_group = nullptr;
-
- /*
- * Index (as in element rank) of the index entry of ds_file_groups'
- * index we will read next (so, the one after the one we are reading
- * right now).
- */
- guint next_index_entry_index = 0;
-
- /*
- * File we are currently reading. Changes whenever we switch to
- * reading another data file.
- */
- ctf_fs_ds_file::UP file;
-
- /* Weak, for context / logging / appending causes. */
- bt_self_message_iterator *self_msg_iter = nullptr;
-};
-
-static enum ctf_msg_iter_medium_status medop_group_request_bytes(size_t request_sz,
- uint8_t **buffer_addr,
- size_t *buffer_sz, void *void_data)
-{
- struct ctf_fs_ds_group_medops_data *data = (struct ctf_fs_ds_group_medops_data *) void_data;
-
- /* Return bytes from the current file. */
- return medop_request_bytes(request_sz, buffer_addr, buffer_sz, data->file.get());
-}
-
-static bt_stream *medop_group_borrow_stream(bt_stream_class *stream_class, int64_t stream_id,
- void *void_data)
-{
- struct ctf_fs_ds_group_medops_data *data = (struct ctf_fs_ds_group_medops_data *) void_data;
-
- return medop_borrow_stream(stream_class, stream_id, data->file.get());
-}
-
-/*
- * Set `data->file` to prepare it to read the packet described
- * by `index_entry`.
- */
-
-static enum ctf_msg_iter_medium_status
-ctf_fs_ds_group_medops_set_file(struct ctf_fs_ds_group_medops_data *data,
- struct ctf_fs_ds_index_entry *index_entry)
-{
- BT_ASSERT(data);
- BT_ASSERT(index_entry);
-
- /* Check if that file is already the one mapped. */
- if (!data->file || data->file->file->path != index_entry->path) {
- /* Create the new file. */
- data->file =
- ctf_fs_ds_file_create(data->ds_file_group->ctf_fs_trace, data->ds_file_group->stream,
- index_entry->path, data->logger);
- if (!data->file) {
- BT_CPPLOGE_APPEND_CAUSE_SPEC(data->logger, "failed to create ctf_fs_ds_file.");
- return CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
- }
- }
-
- /*
- * Ensure the right portion of the file will be returned on the next
- * request_bytes call.
- */
- return ds_file_mmap(data->file.get(), index_entry->offset.bytes());
-}
-
-static enum ctf_msg_iter_medium_status medop_group_switch_packet(void *void_data)
-{
- struct ctf_fs_ds_group_medops_data *data = (struct ctf_fs_ds_group_medops_data *) void_data;
-
- /* If we have gone through all index entries, we are done. */
- if (data->next_index_entry_index >= data->ds_file_group->index.entries.size()) {
- return CTF_MSG_ITER_MEDIUM_STATUS_EOF;
- }
-
- /*
- * Otherwise, look up the next index entry / packet and prepare it
- * for reading.
- */
- ctf_msg_iter_medium_status status = ctf_fs_ds_group_medops_set_file(
- data, &data->ds_file_group->index.entries[data->next_index_entry_index]);
- if (status != CTF_MSG_ITER_MEDIUM_STATUS_OK) {
- return status;
- }
-
- data->next_index_entry_index++;
-
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
-}
-
-void ctf_fs_ds_group_medops_data_deleter::operator()(ctf_fs_ds_group_medops_data *data) noexcept
-{
- delete data;
-}
-
-enum ctf_msg_iter_medium_status ctf_fs_ds_group_medops_data_create(
- struct ctf_fs_ds_file_group *ds_file_group, bt_self_message_iterator *self_msg_iter,
- const bt2c::Logger& parentLogger, ctf_fs_ds_group_medops_data_up& out)
-{
- BT_ASSERT(self_msg_iter);
- BT_ASSERT(ds_file_group);
- BT_ASSERT(!ds_file_group->index.entries.empty());
-
- out.reset(new ctf_fs_ds_group_medops_data {parentLogger});
-
- out->ds_file_group = ds_file_group;
- out->self_msg_iter = self_msg_iter;
-
- /*
- * No need to prepare the first file. ctf_msg_iter will call
- * switch_packet before reading the first packet, it will be
- * done then.
- */
-
- return CTF_MSG_ITER_MEDIUM_STATUS_OK;
-}
-
-void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data *data)
-{
- data->next_index_entry_index = 0;
-}
-
-struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops = {
- .request_bytes = medop_group_request_bytes,
-
- /*
- * We don't support seeking using this medops. It would probably be
- * possible, but it's not needed at the moment.
- */
- .seek = NULL,
-
- .switch_packet = medop_group_switch_packet,
- .borrow_stream = medop_group_borrow_stream,
-};
-
-static int convert_cycles_to_ns(struct ctf_clock_class *clock_class, uint64_t cycles, int64_t *ns)
-{
- return bt_util_clock_cycles_to_ns_from_origin(cycles, clock_class->frequency,
- clock_class->offset_seconds,
- clock_class->offset_cycles, ns);
+ return bt_util_clock_cycles_to_ns_from_origin(cycles, clockClass.freq(),
+ clockClass.offsetFromOrigin().seconds(),
+ clockClass.offsetFromOrigin().cycles(), ns);
}
static bt2s::optional<ctf_fs_ds_index>
-build_index_from_idx_file(struct ctf_fs_ds_file *ds_file, struct ctf_fs_ds_file_info *file_info,
- struct ctf_msg_iter *msg_iter)
+build_index_from_idx_file(const ctf_fs_ds_file_info& fileInfo, const ctf::src::TraceCls& traceCls)
{
- BT_CPPLOGI_SPEC(ds_file->logger, "Building index from .idx file of stream file {}",
- ds_file->file->path);
- ctf_msg_iter_packet_properties props;
- int ret = ctf_msg_iter_get_packet_properties(msg_iter, &props);
- if (ret) {
- BT_CPPLOGI_STR_SPEC(ds_file->logger,
- "Cannot read first packet's header and context fields.");
- return bt2s::nullopt;
- }
-
- ctf_stream_class *sc =
- ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, props.stream_class_id);
- BT_ASSERT(sc);
- if (!sc->default_clock_class) {
- BT_CPPLOGI_STR_SPEC(ds_file->logger, "Cannot find stream class's default clock class.");
- return bt2s::nullopt;
- }
+ const char *path = fileInfo.path.c_str();
+ BT_CPPLOGI_SPEC(fileInfo.logger, "Building index from .idx file of stream file {}", path);
/* Look for index file in relative path index/name.idx. */
- bt2c::GCharUP basename {g_path_get_basename(ds_file->file->path.c_str())};
+ bt2c::GCharUP basename {g_path_get_basename(path)};
if (!basename) {
- BT_CPPLOGE_SPEC(ds_file->logger, "Cannot get the basename of datastream file {}",
- ds_file->file->path);
+ BT_CPPLOGE_SPEC(fileInfo.logger, "Cannot get the basename of datastream file {}", path);
return bt2s::nullopt;
}
- bt2c::GCharUP directory {g_path_get_dirname(ds_file->file->path.c_str())};
+ bt2c::GCharUP directory {g_path_get_dirname(path)};
if (!directory) {
- BT_CPPLOGE_SPEC(ds_file->logger, "Cannot get dirname of datastream file {}",
- ds_file->file->path);
+ BT_CPPLOGE_SPEC(fileInfo.logger, "Cannot get dirname of datastream file {}", path);
return bt2s::nullopt;
}
g_build_filename(directory.get(), "index", index_basename.c_str(), NULL)};
bt2c::GMappedFileUP mapped_file {g_mapped_file_new(index_file_path.get(), FALSE, NULL)};
if (!mapped_file) {
- BT_CPPLOGD_SPEC(ds_file->logger, "Cannot create new mapped file {}", index_file_path.get());
+ BT_CPPLOGD_SPEC(fileInfo.logger, "Cannot create new mapped file {}", index_file_path.get());
return bt2s::nullopt;
}
*/
gsize filesize = g_mapped_file_get_length(mapped_file.get());
if (filesize < sizeof(ctf_packet_index_file_hdr)) {
- BT_CPPLOGW_SPEC(ds_file->logger,
+ BT_CPPLOGW_SPEC(fileInfo.logger,
"Invalid LTTng trace index file: "
"file size ({} bytes) < header size ({} bytes)",
filesize, sizeof(ctf_packet_index_file_hdr));
const char *file_pos = g_mapped_file_get_contents(mapped_file.get()) + sizeof(*header);
if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
- BT_CPPLOGW_STR_SPEC(ds_file->logger,
- "Invalid LTTng trace index: \"magic\" field validation failed");
+ BT_CPPLOGW_SPEC(fileInfo.logger,
+ "Invalid LTTng trace index: \"magic\" field validation failed");
return bt2s::nullopt;
}
uint32_t version_major = be32toh(header->index_major);
uint32_t version_minor = be32toh(header->index_minor);
if (version_major != 1) {
- BT_CPPLOGW_SPEC(ds_file->logger, "Unknown LTTng trace index version: major={}, minor={}",
+ BT_CPPLOGW_SPEC(fileInfo.logger, "Unknown LTTng trace index version: major={}, minor={}",
version_major, version_minor);
return bt2s::nullopt;
}
size_t file_index_entry_size = be32toh(header->packet_index_len);
if (file_index_entry_size < CTF_INDEX_1_0_SIZE) {
BT_CPPLOGW_SPEC(
- ds_file->logger,
+ fileInfo.logger,
"Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): "
"packet_index_len={}, CTF_INDEX_1_0_SIZE={}",
file_index_entry_size, CTF_INDEX_1_0_SIZE);
size_t file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
if ((filesize - sizeof(*header)) % file_index_entry_size) {
- BT_CPPLOGW_SPEC(ds_file->logger,
+ BT_CPPLOGW_SPEC(fileInfo.logger,
"Invalid LTTng trace index: the index's size after the header "
"({} bytes) is not a multiple of the index entry size "
"({} bytes)",
return bt2s::nullopt;
}
+ /*
+ * We need the clock class to convert cycles to ns. For that, we need the
+ * stream class. Read the stream class id from the first packet's header.
+ * We don't know the size of that packet yet, so pretend that it spans the
+ * whole file (the reader will only read the header anyway).
+ */
+ ctf_fs_ds_index_entry tempIndexEntry {path, 0_bits, fileInfo.size};
+ ctf_fs_ds_index tempIndex;
+ tempIndex.entries.emplace_back(tempIndexEntry);
+
+ ctf::src::fs::Medium::UP medium =
+ bt2s::make_unique<ctf::src::fs::Medium>(tempIndex, fileInfo.logger);
+ ctf::src::PktProps props =
+ ctf::src::readPktProps(traceCls, std::move(medium), 0_bytes, fileInfo.logger);
+
+ const ctf::src::DataStreamCls *sc = props.dataStreamCls;
+ BT_ASSERT(sc);
+ if (!sc->defClkCls()) {
+ BT_CPPLOGI_SPEC(fileInfo.logger, "Cannot find stream class's default clock class.");
+ return bt2s::nullopt;
+ }
+
ctf_fs_ds_index index;
ctf_fs_ds_index_entry *prev_index_entry = nullptr;
- auto totalPacketsSize = bt2c::DataLen::fromBytes(0);
+ auto totalPacketsSize = 0_bytes;
for (size_t i = 0; i < file_entry_count; i++) {
struct ctf_packet_index *file_index = (struct ctf_packet_index *) file_pos;
const auto packetSize = bt2c::DataLen::fromBits(be64toh(file_index->packet_size));
if (packetSize.hasExtraBits()) {
- BT_CPPLOGW_SPEC(ds_file->logger,
+ BT_CPPLOGW_SPEC(fileInfo.logger,
"Invalid packet size encountered in LTTng trace index file");
return bt2s::nullopt;
}
const auto offset = bt2c::DataLen::fromBytes(be64toh(file_index->offset));
- if (i != 0 && offset < prev_index_entry->offset) {
+ if (i != 0 && offset < prev_index_entry->offsetInFile) {
BT_CPPLOGW_SPEC(
- ds_file->logger,
+ fileInfo.logger,
"Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
"previous offset={} bytes, current offset={} bytes",
- prev_index_entry->offset.bytes(), offset.bytes());
+ prev_index_entry->offsetInFile.bytes(), offset.bytes());
return bt2s::nullopt;
}
- ctf_fs_ds_index_entry index_entry {offset, packetSize};
-
- /* Set path to stream file. */
- index_entry.path = file_info->path.c_str();
-
+ ctf_fs_ds_index_entry index_entry {path, offset, packetSize};
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_CPPLOGW_SPEC(
- ds_file->logger,
+ fileInfo.logger,
"Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
"timestamp_begin={}, timestamp_end={}",
index_entry.timestamp_begin, index_entry.timestamp_end);
}
/* Convert the packet's bound to nanoseconds since Epoch. */
- ret = convert_cycles_to_ns(sc->default_clock_class, index_entry.timestamp_begin,
- &index_entry.timestamp_begin_ns);
+ int ret = convert_cycles_to_ns(*sc->defClkCls(), index_entry.timestamp_begin,
+ &index_entry.timestamp_begin_ns);
if (ret) {
- BT_CPPLOGI_STR_SPEC(
- ds_file->logger,
+ BT_CPPLOGI_SPEC(
+ fileInfo.logger,
"Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
return bt2s::nullopt;
}
- ret = convert_cycles_to_ns(sc->default_clock_class, index_entry.timestamp_end,
+ ret = convert_cycles_to_ns(*sc->defClkCls(), index_entry.timestamp_end,
&index_entry.timestamp_end_ns);
if (ret) {
- BT_CPPLOGI_STR_SPEC(
- ds_file->logger,
+ BT_CPPLOGI_SPEC(
+ fileInfo.logger,
"Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
return bt2s::nullopt;
}
}
/* Validate that the index addresses the complete stream. */
- if (ds_file->file->size != totalPacketsSize.bytes()) {
- BT_CPPLOGW_SPEC(ds_file->logger,
+ if (fileInfo.size != totalPacketsSize) {
+ BT_CPPLOGW_SPEC(fileInfo.logger,
"Invalid LTTng trace index file; indexed size != stream file size: "
- "file-size={} bytes, total-packets-size={} bytes",
- ds_file->file->size, totalPacketsSize.bytes());
+ "stream-file-size-bytes={}, total-packets-size-bytes={}",
+ fileInfo.size.bytes(), totalPacketsSize.bytes());
return bt2s::nullopt;
}
return index;
}
-static int init_index_entry(ctf_fs_ds_index_entry& entry, struct ctf_fs_ds_file *ds_file,
- struct ctf_msg_iter_packet_properties *props)
+static int init_index_entry(ctf_fs_ds_index_entry& entry, ctf::src::PktProps *props,
+ const ctf::src::DataStreamCls& dataStreamCls,
+ const bt2c::Logger& logger)
{
- ctf_stream_class *sc =
- ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc, props->stream_class_id);
- BT_ASSERT(sc);
-
- if (props->snapshots.beginning_clock != UINT64_C(-1)) {
- entry.timestamp_begin = props->snapshots.beginning_clock;
+ if (props->snapshots.beginDefClk) {
+ entry.timestamp_begin = *props->snapshots.beginDefClk;
/* Convert the packet's bound to nanoseconds since Epoch. */
- int ret = convert_cycles_to_ns(sc->default_clock_class, props->snapshots.beginning_clock,
+ int ret = convert_cycles_to_ns(*dataStreamCls.defClkCls(), *props->snapshots.beginDefClk,
&entry.timestamp_begin_ns);
if (ret) {
- BT_CPPLOGI_STR_SPEC(ds_file->logger,
- "Failed to convert raw timestamp to nanoseconds since Epoch.");
+ BT_CPPLOGI_SPEC(logger, "Failed to convert raw timestamp to nanoseconds since Epoch.");
return ret;
}
} else {
entry.timestamp_begin_ns = UINT64_C(-1);
}
- if (props->snapshots.end_clock != UINT64_C(-1)) {
- entry.timestamp_end = props->snapshots.end_clock;
+ if (props->snapshots.endDefClk) {
+ entry.timestamp_end = *props->snapshots.endDefClk;
/* Convert the packet's bound to nanoseconds since Epoch. */
- int ret = convert_cycles_to_ns(sc->default_clock_class, props->snapshots.end_clock,
+ int ret = convert_cycles_to_ns(*dataStreamCls.defClkCls(), *props->snapshots.endDefClk,
&entry.timestamp_end_ns);
if (ret) {
- BT_CPPLOGI_STR_SPEC(ds_file->logger,
- "Failed to convert raw timestamp to nanoseconds since Epoch.");
+ BT_CPPLOGI_SPEC(logger, "Failed to convert raw timestamp to nanoseconds since Epoch.");
return ret;
}
} else {
}
static bt2s::optional<ctf_fs_ds_index>
-build_index_from_stream_file(struct ctf_fs_ds_file *ds_file, struct ctf_fs_ds_file_info *file_info,
- struct ctf_msg_iter *msg_iter)
+build_index_from_stream_file(const ctf_fs_ds_file_info& fileInfo,
+ const ctf::src::TraceCls& traceCls)
{
- BT_CPPLOGI_SPEC(ds_file->logger, "Indexing stream file {}", ds_file->file->path);
+ const char *path = fileInfo.path.c_str();
+
+ BT_CPPLOGI_SPEC(fileInfo.logger, "Indexing stream file {}", path);
ctf_fs_ds_index index;
- auto currentPacketOffset = bt2c::DataLen::fromBytes(0);
+ auto currentPacketOffset = 0_bytes;
while (true) {
- struct ctf_msg_iter_packet_properties props;
-
- if (currentPacketOffset.bytes() > ds_file->file->size) {
- BT_CPPLOGE_STR_SPEC(ds_file->logger,
- "Unexpected current packet's offset (larger than file).");
+ if (currentPacketOffset > fileInfo.size) {
+ BT_CPPLOGE_SPEC(fileInfo.logger,
+ "Unexpected current packet's offset (larger than file).");
return bt2s::nullopt;
- } else if (currentPacketOffset.bytes() == ds_file->file->size) {
+ } else if (currentPacketOffset == fileInfo.size) {
/* No more data */
break;
}
- ctf_msg_iter_status iter_status = ctf_msg_iter_seek(msg_iter, currentPacketOffset.bytes());
- if (iter_status != CTF_MSG_ITER_STATUS_OK) {
- return bt2s::nullopt;
- }
-
- iter_status = ctf_msg_iter_get_packet_properties(msg_iter, &props);
- if (iter_status != CTF_MSG_ITER_STATUS_OK) {
- return bt2s::nullopt;
- }
+ /*
+ * Create a temporary index and medium to read the properties of the
+ * current packet. We don't know yet the size of the packet (that's
+ * one of the things we want to find out), so pretend it spans the rest
+ * of the file.
+ */
+ ctf_fs_ds_index_entry tempIndexEntry {path, currentPacketOffset,
+ fileInfo.size - currentPacketOffset};
+ ctf_fs_ds_index tempIndex;
+ tempIndex.entries.emplace_back(tempIndexEntry);
+ ctf::src::fs::Medium::UP medium =
+ bt2s::make_unique<ctf::src::fs::Medium>(tempIndex, fileInfo.logger);
+ ctf::src::PktProps props = ctf::src::readPktProps(traceCls, std::move(medium),
+ currentPacketOffset, fileInfo.logger);
/*
* Get the current packet size from the packet header, if set. Else,
* assume there is a single packet in the file, so take the file size
* as the packet size.
*/
- const auto currentPacketSize = props.exp_packet_total_size >= 0 ?
- bt2c::DataLen::fromBits(props.exp_packet_total_size) :
- bt2c::DataLen::fromBytes(ds_file->file->size);
+ const auto currentPacketSize =
+ props.expectedTotalLen ? *props.expectedTotalLen : fileInfo.size;
+
+ BT_CPPLOGI_SPEC(fileInfo.logger,
+ "Packet: offset-bytes={}, len-bytes={}, begin-clk={}, end-clk={}",
+ currentPacketOffset.bytes(), currentPacketSize.bytes(),
+ props.snapshots.beginDefClk ? *props.snapshots.beginDefClk : -1,
+ props.snapshots.endDefClk ? *props.snapshots.endDefClk : -1);
- if ((currentPacketOffset + currentPacketSize).bytes() > ds_file->file->size) {
- BT_CPPLOGW_SPEC(ds_file->logger,
+ if (currentPacketOffset + currentPacketSize > fileInfo.size) {
+ BT_CPPLOGW_SPEC(fileInfo.logger,
"Invalid packet size reported in file: stream=\"{}\", "
"packet-offset-bytes={}, packet-size-bytes={}, "
"file-size-bytes={}",
- ds_file->file->path, currentPacketOffset.bytes(),
- currentPacketSize.bytes(), ds_file->file->size);
+ path, currentPacketOffset.bytes(), currentPacketSize.bytes(),
+ fileInfo.size.bytes());
return bt2s::nullopt;
}
- ctf_fs_ds_index_entry index_entry {currentPacketOffset, currentPacketSize};
+ ctf_fs_ds_index_entry index_entry {path, currentPacketOffset, currentPacketSize};
- /* Set path to stream file. */
- index_entry.path = file_info->path.c_str();
-
- int ret = init_index_entry(index_entry, ds_file, &props);
- if (ret) {
+ if (init_index_entry(index_entry, &props, *props.dataStreamCls, fileInfo.logger)) {
return bt2s::nullopt;
}
index.entries.emplace_back(index_entry);
currentPacketOffset += currentPacketSize;
- BT_CPPLOGD_SPEC(ds_file->logger,
+ BT_CPPLOGD_SPEC(fileInfo.logger,
"Seeking to next packet: current-packet-offset-bytes={}, "
"next-packet-offset-bytes={}",
(currentPacketOffset - currentPacketSize).bytes(),
return index;
}
-ctf_fs_ds_file::UP ctf_fs_ds_file_create(struct ctf_fs_trace *ctf_fs_trace,
- bt2::Stream::Shared stream, const char *path,
- const bt2c::Logger& parentLogger)
+ctf_fs_ds_file::UP ctf_fs_ds_file_create(const char *path, const bt2c::Logger& parentLogger)
{
- auto ds_file = bt2s::make_unique<ctf_fs_ds_file>(parentLogger);
+ const auto offset_align = bt_mmap_get_offset_align_size(static_cast<int>(parentLogger.level()));
+ auto ds_file = bt2s::make_unique<ctf_fs_ds_file>(parentLogger, offset_align * 2048);
- ds_file->file = bt2s::make_unique<ctf_fs_file>(parentLogger);
- ds_file->stream = std::move(stream);
- ds_file->metadata = ctf_fs_trace->metadata.get();
+ ds_file->file = bt2s::make_unique<ctf_fs_file>(ds_file->logger);
ds_file->file->path = path;
int ret = ctf_fs_file_open(ds_file->file.get(), "rb");
if (ret) {
return nullptr;
}
- const size_t offset_align =
- bt_mmap_get_offset_align_size(static_cast<int>(ds_file->logger.level()));
- ds_file->mmap_max_len = offset_align * 2048;
-
return ds_file;
}
-bt2s::optional<ctf_fs_ds_index> ctf_fs_ds_file_build_index(struct ctf_fs_ds_file *ds_file,
- struct ctf_fs_ds_file_info *file_info,
- struct ctf_msg_iter *msg_iter)
+namespace ctf {
+namespace src {
+namespace fs {
+
+Medium::Medium(const ctf_fs_ds_index& index, const bt2c::Logger& parentLogger) :
+ _mIndex(index), _mLogger {parentLogger, "PLUGIN/SRC.CTF.FS/DS-MEDIUM"}
+{
+ BT_ASSERT(!_mIndex.entries.empty());
+}
+
+ctf_fs_ds_index::EntriesT::const_iterator
+Medium::_mFindIndexEntryForOffset(bt2c::DataLen offsetInStream) const noexcept
+{
+ return std::lower_bound(
+ _mIndex.entries.begin(), _mIndex.entries.end(), offsetInStream,
+ [](const ctf_fs_ds_index_entry& entry, bt2c::DataLen offsetInStreamLambda) {
+ return (entry.offsetInStream + entry.packetSize - 1_bytes) < offsetInStreamLambda;
+ });
+}
+
+ctf::src::Buf Medium::buf(const bt2c::DataLen requestedOffsetInStream, const bt2c::DataLen minSize)
{
- auto index = build_index_from_idx_file(ds_file, file_info, msg_iter);
+ BT_CPPLOGD("buf called: offset-bytes={}, min-size-bytes={}", requestedOffsetInStream.bytes(),
+ minSize.bytes());
+
+ /* The medium only gets asked about whole byte offsets and min sizes. */
+ BT_ASSERT_DBG(requestedOffsetInStream.extraBitCount() == 0);
+ BT_ASSERT_DBG(minSize.extraBitCount() == 0);
+
+ /*
+ * +-file 1-----+ +-file 2-----+------------+------------+
+ * | | | | | |
+ * | packet 1 | | packet 2 | packet 3 | packet 4 |
+ * | | | | | |
+ * +------------+ +------------+------v-----+------------+
+ * ^-----------------------------------^ requestedOffsetInStream (passed as parameter)
+ * ^----------------------------^ indexEntry.offsetInStream (known)
+ * ^------------^ indexEntry.offsetInFile (known)
+ * ^---------------^ fileStartInStream (computed)
+ * ^-------------------^ requestedOffsetInFile (computed)
+ *
+ * Then, assuming mmap maps this region:
+ * ^------------^
+ *
+ * ^-------------------^ startOfMappingInFile
+ * ^----------------^ requestedOffsetInMapping
+ * ^--------------------------------^ endOfMappingInFile
+ */
+ const ctf_fs_ds_index::EntriesT::const_iterator indexEntryIt =
+ this->_mFindIndexEntryForOffset(requestedOffsetInStream);
+ if (indexEntryIt == _mIndex.entries.end()) {
+ BT_CPPLOGD("no index entry containing this offset");
+ throw NoData();
+ }
+
+ const ctf_fs_ds_index_entry& indexEntry = *indexEntryIt;
+
+ _mCurrentDsFile = ctf_fs_ds_file_create(indexEntry.path, _mLogger);
+ if (!_mCurrentDsFile) {
+ BT_CPPLOGE_APPEND_CAUSE_AND_THROW(bt2::Error, "Failed to create ctf_fs_ds_file");
+ }
+
+ const auto fileStartInStream = indexEntry.offsetInStream - indexEntry.offsetInFile;
+ const auto requestedOffsetInFile = requestedOffsetInStream - fileStartInStream;
+
+ ds_file_status status = ds_file_mmap(_mCurrentDsFile.get(), requestedOffsetInFile.bytes());
+ if (status != DS_FILE_STATUS_OK) {
+ throw bt2::Error("Failed to mmap file");
+ }
+
+ const auto startOfMappingInFile =
+ bt2c::DataLen::fromBytes(_mCurrentDsFile->mmap_offset_in_file);
+ const auto requestedOffsetInMapping = requestedOffsetInFile - startOfMappingInFile;
+ const auto exclEndOfMappingInFile =
+ startOfMappingInFile + bt2c::DataLen::fromBytes(_mCurrentDsFile->mmap_len);
+
+ /*
+ * Find where to end the mapping. We can map the following entries as long as
+ *
+ * 1) there are following entries
+ * 2) they are located in the same file as our starting entry
+ * 3) they are (at least partially) within the mapping
+ */
+
+ ctf_fs_ds_index::EntriesT::const_iterator endIndexEntryIt = indexEntryIt;
+ while (true) {
+ ctf_fs_ds_index::EntriesT::const_iterator nextIndexEntryIt = endIndexEntryIt + 1;
+
+ if (nextIndexEntryIt == _mIndex.entries.end()) {
+ break;
+ }
+
+ if (nextIndexEntryIt->path != indexEntryIt->path) {
+ break;
+ }
+
+ if (nextIndexEntryIt->offsetInFile >= exclEndOfMappingInFile) {
+ break;
+ }
+
+ endIndexEntryIt = nextIndexEntryIt;
+ }
+
+ /*
+ * It's possible the mapping ends in the middle of our end entry. Choose
+ * the end of the mapping or the end of the end entry, whichever comes
+ * first, as the end of the returned buffer.
+ */
+ const auto exclEndOfEndEntryInFile =
+ endIndexEntryIt->offsetInFile + endIndexEntryIt->packetSize;
+ const auto bufEndInFile = std::min(exclEndOfMappingInFile, exclEndOfEndEntryInFile);
+ const auto bufLen = bufEndInFile - requestedOffsetInFile;
+ const uint8_t *bufStart =
+ (const uint8_t *) _mCurrentDsFile->mmap_addr + requestedOffsetInMapping.bytes();
+
+ if (bufLen < minSize) {
+ BT_CPPLOGE_APPEND_CAUSE_AND_THROW(
+ bt2::Error,
+ "Insufficient data in file to fulfill request: path=\"{}\", requested-offset-in-file-bytes={}, "
+ "remaining-data-len-in-file-bytes={}, min-size-bytes={}",
+ indexEntry.path, requestedOffsetInFile.bytes(), bufLen.bytes(), minSize.bytes());
+ }
+
+ ctf::src::Buf buf {bufStart, bufLen};
+
+ BT_CPPLOGD("CtfFsMedium::buf returns: buf-addr={}, buf-size-bytes={}\n", fmt::ptr(buf.addr()),
+ buf.size().bytes());
+
+ return buf;
+}
+
+} /* namespace fs */
+} /* namespace src */
+} /* namespace ctf */
+
+bt2s::optional<ctf_fs_ds_index> ctf_fs_ds_file_build_index(const ctf_fs_ds_file_info& fileInfo,
+ const ctf::src::TraceCls& traceCls)
+{
+ auto index = build_index_from_idx_file(fileInfo, traceCls);
if (index) {
return index;
}
- BT_CPPLOGI_SPEC(ds_file->logger, "Failed to build index from .index file; "
+ BT_CPPLOGI_SPEC(fileInfo.logger, "Failed to build index from .index file; "
"falling back to stream indexing.");
- return build_index_from_stream_file(ds_file, file_info, msg_iter);
+ return build_index_from_stream_file(fileInfo, traceCls);
}
ctf_fs_ds_file::~ctf_fs_ds_file()
(void) ds_file_munmap(this);
}
-ctf_fs_ds_file_info::UP ctf_fs_ds_file_info_create(const char *path, int64_t begin_ns)
-{
- ctf_fs_ds_file_info::UP ds_file_info = bt2s::make_unique<ctf_fs_ds_file_info>();
-
- ds_file_info->path = path;
- ds_file_info->begin_ns = begin_ns;
- return ds_file_info;
-}
-
-ctf_fs_ds_file_group::UP ctf_fs_ds_file_group_create(struct ctf_fs_trace *ctf_fs_trace,
- struct ctf_stream_class *sc,
- uint64_t stream_instance_id,
- ctf_fs_ds_index index)
+void ctf_fs_ds_file_group::insert_ds_file_info_sorted(ctf_fs_ds_file_info::UP ds_file_info)
{
- ctf_fs_ds_file_group::UP ds_file_group {new ctf_fs_ds_file_group};
+ /* Find the spot where to insert this ds_file_info. */
+ auto it = this->ds_file_infos.begin();
- ds_file_group->index = std::move(index);
+ for (; it != this->ds_file_infos.end(); ++it) {
+ const ctf_fs_ds_file_info& other_ds_file_info = **it;
- ds_file_group->stream_id = stream_instance_id;
- BT_ASSERT(sc);
- ds_file_group->sc = sc;
- ds_file_group->ctf_fs_trace = ctf_fs_trace;
+ if (ds_file_info->begin_ns < other_ds_file_info.begin_ns) {
+ break;
+ }
+ }
- return ds_file_group;
+ this->ds_file_infos.insert(it, std::move(ds_file_info));
}