2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
13 #include "compat/endian.h" /* IWYU pragma: keep */
14 #include "compat/mman.h" /* IWYU: pragma keep */
15 #include "cpp-common/bt2c/glib-up.hpp"
16 #include "cpp-common/bt2s/make-unique.hpp"
17 #include "cpp-common/vendor/fmt/format.h"
19 #include "../common/src/msg-iter/msg-iter.hpp"
20 #include "data-stream-file.hpp"
23 #include "lttng-index.hpp"
25 static inline size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
27 BT_ASSERT_DBG(ds_file
->mmap_len
>= ds_file
->request_offset_in_mapping
);
28 return ds_file
->mmap_len
- ds_file
->request_offset_in_mapping
;
32 * Return true if `offset_in_file` is in the current mapping.
35 static bool offset_ist_mapped(struct ctf_fs_ds_file
*ds_file
, off_t offset_in_file
)
37 return offset_in_file
>= ds_file
->mmap_offset_in_file
&&
38 offset_in_file
< (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
41 static enum ctf_msg_iter_medium_status
ds_file_munmap(struct ctf_fs_ds_file
*ds_file
)
43 enum ctf_msg_iter_medium_status status
;
47 if (!ds_file
->mmap_addr
) {
48 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
52 if (bt_munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
53 BT_CPPLOGE_ERRNO_SPEC(ds_file
->logger
, "Cannot memory-unmap file",
54 ": address={}, size={}, file_path=\"{}\", file={}",
55 fmt::ptr(ds_file
->mmap_addr
), ds_file
->mmap_len
,
56 ds_file
->file
? ds_file
->file
->path
: "NULL",
57 ds_file
->file
? fmt::ptr(ds_file
->file
->fp
) : NULL
);
58 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
62 ds_file
->mmap_addr
= NULL
;
64 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
70 * mmap a region of `ds_file` such that `requested_offset_in_file` is in the
71 * mapping. If the currently mmap-ed region already contains
72 * `requested_offset_in_file`, the mapping is kept.
74 * Set `ds_file->requested_offset_in_mapping` based on `request_offset_in_file`,
75 * such that the next call to `request_bytes` will return bytes starting at that
78 * `requested_offset_in_file` must be a valid offset in the file.
80 static enum ctf_msg_iter_medium_status
ds_file_mmap(struct ctf_fs_ds_file
*ds_file
,
81 off_t requested_offset_in_file
)
83 enum ctf_msg_iter_medium_status status
;
85 /* Ensure the requested offset is in the file range. */
86 BT_ASSERT(requested_offset_in_file
>= 0);
87 BT_ASSERT(requested_offset_in_file
< ds_file
->file
->size
);
90 * If the mapping already contains the requested offset, just adjust
91 * requested_offset_in_mapping.
93 if (offset_ist_mapped(ds_file
, requested_offset_in_file
)) {
94 ds_file
->request_offset_in_mapping
=
95 requested_offset_in_file
- ds_file
->mmap_offset_in_file
;
96 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
100 /* Unmap old region */
101 status
= ds_file_munmap(ds_file
);
102 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
107 * Compute a mapping that has the required alignment properties and
108 * contains `requested_offset_in_file`.
110 ds_file
->request_offset_in_mapping
=
111 requested_offset_in_file
%
112 bt_mmap_get_offset_align_size(static_cast<int>(ds_file
->logger
.level()));
113 ds_file
->mmap_offset_in_file
= requested_offset_in_file
- ds_file
->request_offset_in_mapping
;
115 MIN(ds_file
->file
->size
- ds_file
->mmap_offset_in_file
, ds_file
->mmap_max_len
);
117 BT_ASSERT(ds_file
->mmap_len
> 0);
120 bt_mmap(ds_file
->mmap_len
, PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
.get()),
121 ds_file
->mmap_offset_in_file
, static_cast<int>(ds_file
->logger
.level()));
122 if (ds_file
->mmap_addr
== MAP_FAILED
) {
123 BT_CPPLOGE_SPEC(ds_file
->logger
,
124 "Cannot memory-map address (size {}) of file \"{}\" ({}) at offset {}: {}",
125 ds_file
->mmap_len
, ds_file
->file
->path
, fmt::ptr(ds_file
->file
->fp
),
126 (intmax_t) ds_file
->mmap_offset_in_file
, strerror(errno
));
127 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
131 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
138 * Change the mapping of the file to read the region that follows the current
141 * If the file hasn't been mapped yet, then everything (mmap_offset_in_file,
142 * mmap_len, request_offset_in_mapping) should have the value 0, which will
143 * result in the beginning of the file getting mapped.
145 * return _EOF if the current mapping is the end of the file.
148 static enum ctf_msg_iter_medium_status
ds_file_mmap_next(struct ctf_fs_ds_file
*ds_file
)
150 enum ctf_msg_iter_medium_status status
;
153 * If we're called, it's because more bytes are requested but we have
154 * given all the bytes of the current mapping.
156 BT_ASSERT(ds_file
->request_offset_in_mapping
== ds_file
->mmap_len
);
159 * If the current mapping coincides with the end of the file, there is
162 if (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
== ds_file
->file
->size
) {
163 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
167 status
= ds_file_mmap(ds_file
, ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
173 static enum ctf_msg_iter_medium_status
medop_request_bytes(size_t request_sz
, uint8_t **buffer_addr
,
174 size_t *buffer_sz
, void *data
)
176 enum ctf_msg_iter_medium_status status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
177 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
179 BT_ASSERT(request_sz
> 0);
182 * Check if we have at least one memory-mapped byte left. If we don't,
183 * mmap the next file.
185 if (remaining_mmap_bytes(ds_file
) == 0) {
186 /* Are we at the end of the file? */
187 if (ds_file
->mmap_offset_in_file
>= ds_file
->file
->size
) {
188 BT_CPPLOGD_SPEC(ds_file
->logger
, "Reached end of file \"{}\" ({})", ds_file
->file
->path
,
189 fmt::ptr(ds_file
->file
->fp
));
190 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
194 status
= ds_file_mmap_next(ds_file
);
196 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
198 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
201 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot memory-map next region of file \"{}\" ({})",
202 ds_file
->file
->path
, fmt::ptr(ds_file
->file
->fp
));
207 BT_ASSERT(remaining_mmap_bytes(ds_file
) > 0);
208 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
210 BT_ASSERT(ds_file
->mmap_addr
);
211 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset_in_mapping
;
213 ds_file
->request_offset_in_mapping
+= *buffer_sz
;
217 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
223 static bt_stream
*medop_borrow_stream(bt_stream_class
*stream_class
, int64_t, void *data
)
225 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
226 bt_stream_class
*ds_file_stream_class
;
227 bt_stream
*stream
= NULL
;
229 ds_file_stream_class
= ds_file
->stream
->cls().libObjPtr();
231 if (stream_class
!= ds_file_stream_class
) {
233 * Not supported: two packets described by two different
234 * stream classes within the same data stream file.
239 stream
= ds_file
->stream
->libObjPtr();
245 static enum ctf_msg_iter_medium_status
medop_seek(off_t offset
, void *data
)
247 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
249 BT_ASSERT(offset
>= 0);
250 BT_ASSERT(offset
< ds_file
->file
->size
);
252 return ds_file_mmap(ds_file
, offset
);
255 struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops
= {
262 struct ctf_fs_ds_group_medops_data
264 explicit ctf_fs_ds_group_medops_data(const bt2c::Logger
& parentLogger
) :
265 logger
{parentLogger
, "PLUGIN/SRC.CTF.FS/DS-GROUP-MEDOPS"}
271 /* Weak, set once at creation time. */
272 struct ctf_fs_ds_file_group
*ds_file_group
= nullptr;
275 * Index (as in element rank) of the index entry of ds_file_groups'
276 * index we will read next (so, the one after the one we are reading
279 guint next_index_entry_index
= 0;
282 * File we are currently reading. Changes whenever we switch to
283 * reading another data file.
285 ctf_fs_ds_file::UP file
;
287 /* Weak, for context / logging / appending causes. */
288 bt_self_message_iterator
*self_msg_iter
= nullptr;
291 static enum ctf_msg_iter_medium_status
medop_group_request_bytes(size_t request_sz
,
292 uint8_t **buffer_addr
,
293 size_t *buffer_sz
, void *void_data
)
295 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
297 /* Return bytes from the current file. */
298 return medop_request_bytes(request_sz
, buffer_addr
, buffer_sz
, data
->file
.get());
301 static bt_stream
*medop_group_borrow_stream(bt_stream_class
*stream_class
, int64_t stream_id
,
304 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
306 return medop_borrow_stream(stream_class
, stream_id
, data
->file
.get());
310 * Set `data->file` to prepare it to read the packet described
314 static enum ctf_msg_iter_medium_status
315 ctf_fs_ds_group_medops_set_file(struct ctf_fs_ds_group_medops_data
*data
,
316 struct ctf_fs_ds_index_entry
*index_entry
)
318 enum ctf_msg_iter_medium_status status
;
321 BT_ASSERT(index_entry
);
323 /* Check if that file is already the one mapped. */
324 if (!data
->file
|| data
->file
->file
->path
!= index_entry
->path
) {
325 /* Create the new file. */
327 ctf_fs_ds_file_create(data
->ds_file_group
->ctf_fs_trace
, data
->ds_file_group
->stream
,
328 index_entry
->path
, data
->logger
);
330 BT_CPPLOGE_APPEND_CAUSE_SPEC(data
->logger
, "failed to create ctf_fs_ds_file.");
331 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
337 * Ensure the right portion of the file will be returned on the next
338 * request_bytes call.
340 status
= ds_file_mmap(data
->file
.get(), index_entry
->offset
.bytes());
341 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
345 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
351 static enum ctf_msg_iter_medium_status
medop_group_switch_packet(void *void_data
)
353 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
354 struct ctf_fs_ds_index_entry
*index_entry
;
355 enum ctf_msg_iter_medium_status status
;
357 /* If we have gone through all index entries, we are done. */
358 if (data
->next_index_entry_index
>= data
->ds_file_group
->index
->entries
.size()) {
359 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
364 * Otherwise, look up the next index entry / packet and prepare it
367 index_entry
= data
->ds_file_group
->index
->entries
[data
->next_index_entry_index
].get();
369 status
= ctf_fs_ds_group_medops_set_file(data
, index_entry
);
370 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
374 data
->next_index_entry_index
++;
376 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
381 void ctf_fs_ds_group_medops_data_deleter::operator()(ctf_fs_ds_group_medops_data
*data
) noexcept
386 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_data_create(
387 struct ctf_fs_ds_file_group
*ds_file_group
, bt_self_message_iterator
*self_msg_iter
,
388 const bt2c::Logger
& parentLogger
, ctf_fs_ds_group_medops_data_up
& out
)
390 BT_ASSERT(self_msg_iter
);
391 BT_ASSERT(ds_file_group
);
392 BT_ASSERT(ds_file_group
->index
);
393 BT_ASSERT(!ds_file_group
->index
->entries
.empty());
395 out
.reset(new ctf_fs_ds_group_medops_data
{parentLogger
});
397 out
->ds_file_group
= ds_file_group
;
398 out
->self_msg_iter
= self_msg_iter
;
401 * No need to prepare the first file. ctf_msg_iter will call
402 * switch_packet before reading the first packet, it will be
406 return CTF_MSG_ITER_MEDIUM_STATUS_OK
;
409 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data
*data
)
411 data
->next_index_entry_index
= 0;
414 struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops
= {
415 .request_bytes
= medop_group_request_bytes
,
418 * We don't support seeking using this medops. It would probably be
419 * possible, but it's not needed at the moment.
423 .switch_packet
= medop_group_switch_packet
,
424 .borrow_stream
= medop_group_borrow_stream
,
427 static ctf_fs_ds_index_entry::UP
ctf_fs_ds_index_entry_create(const bt2c::DataLen offset
,
428 const bt2c::DataLen packetSize
)
430 ctf_fs_ds_index_entry::UP entry
= bt2s::make_unique
<ctf_fs_ds_index_entry
>(offset
, packetSize
);
432 entry
->packet_seq_num
= UINT64_MAX
;
437 static int convert_cycles_to_ns(struct ctf_clock_class
*clock_class
, uint64_t cycles
, int64_t *ns
)
439 return bt_util_clock_cycles_to_ns_from_origin(cycles
, clock_class
->frequency
,
440 clock_class
->offset_seconds
,
441 clock_class
->offset_cycles
, ns
);
444 static ctf_fs_ds_index::UP
build_index_from_idx_file(struct ctf_fs_ds_file
*ds_file
,
445 struct ctf_fs_ds_file_info
*file_info
,
446 struct ctf_msg_iter
*msg_iter
)
449 bt2c::GCharUP directory
;
450 bt2c::GCharUP basename
;
451 std::string index_basename
;
452 bt2c::GCharUP index_file_path
;
453 bt2c::GMappedFileUP mapped_file
;
455 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
456 const struct ctf_packet_index_file_hdr
*header
= NULL
;
457 ctf_fs_ds_index::UP index
;
458 ctf_fs_ds_index_entry::UP index_entry
;
459 ctf_fs_ds_index_entry
*prev_index_entry
= NULL
;
460 auto totalPacketsSize
= bt2c::DataLen::fromBytes(0);
461 size_t file_index_entry_size
;
462 size_t file_entry_count
;
464 struct ctf_stream_class
*sc
;
465 struct ctf_msg_iter_packet_properties props
;
466 uint32_t version_major
, version_minor
;
468 BT_CPPLOGI_SPEC(ds_file
->logger
, "Building index from .idx file of stream file {}",
469 ds_file
->file
->path
);
470 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
472 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
473 "Cannot read first packet's header and context fields.");
477 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
479 if (!sc
->default_clock_class
) {
480 BT_CPPLOGI_STR_SPEC(ds_file
->logger
, "Cannot find stream class's default clock class.");
484 /* Look for index file in relative path index/name.idx. */
485 basename
.reset(g_path_get_basename(ds_file
->file
->path
.c_str()));
487 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot get the basename of datastream file {}",
488 ds_file
->file
->path
);
492 directory
.reset(g_path_get_dirname(ds_file
->file
->path
.c_str()));
494 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot get dirname of datastream file {}",
495 ds_file
->file
->path
);
499 index_basename
= fmt::format("{}.idx", basename
.get());
500 index_file_path
.reset(g_build_filename(directory
.get(), "index", index_basename
.c_str(), NULL
));
501 mapped_file
.reset(g_mapped_file_new(index_file_path
.get(), FALSE
, NULL
));
503 BT_CPPLOGD_SPEC(ds_file
->logger
, "Cannot create new mapped file {}", index_file_path
.get());
508 * The g_mapped_file API limits us to 4GB files on 32-bit.
509 * Traces with such large indexes have never been seen in the wild,
510 * but this would need to be adjusted to support them.
512 filesize
= g_mapped_file_get_length(mapped_file
.get());
513 if (filesize
< sizeof(*header
)) {
514 BT_CPPLOGW_SPEC(ds_file
->logger
,
515 "Invalid LTTng trace index file: "
516 "file size ({} bytes) < header size ({} bytes)",
517 filesize
, sizeof(*header
));
521 mmap_begin
= g_mapped_file_get_contents(mapped_file
.get());
522 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
524 file_pos
= g_mapped_file_get_contents(mapped_file
.get()) + sizeof(*header
);
525 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
526 BT_CPPLOGW_STR_SPEC(ds_file
->logger
,
527 "Invalid LTTng trace index: \"magic\" field validation failed");
531 version_major
= be32toh(header
->index_major
);
532 version_minor
= be32toh(header
->index_minor
);
533 if (version_major
!= 1) {
534 BT_CPPLOGW_SPEC(ds_file
->logger
, "Unknown LTTng trace index version: major={}, minor={}",
535 version_major
, version_minor
);
539 file_index_entry_size
= be32toh(header
->packet_index_len
);
540 if (file_index_entry_size
< CTF_INDEX_1_0_SIZE
) {
543 "Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): "
544 "packet_index_len={}, CTF_INDEX_1_0_SIZE={}",
545 file_index_entry_size
, CTF_INDEX_1_0_SIZE
);
549 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
550 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
551 BT_CPPLOGW_SPEC(ds_file
->logger
,
552 "Invalid LTTng trace index: the index's size after the header "
553 "({} bytes) is not a multiple of the index entry size "
555 (filesize
- sizeof(*header
)), sizeof(*header
));
559 index
= bt2s::make_unique
<ctf_fs_ds_index
>();
561 for (i
= 0; i
< file_entry_count
; i
++) {
562 struct ctf_packet_index
*file_index
= (struct ctf_packet_index
*) file_pos
;
563 const auto packetSize
= bt2c::DataLen::fromBits(be64toh(file_index
->packet_size
));
565 if (packetSize
.hasExtraBits()) {
566 BT_CPPLOGW_SPEC(ds_file
->logger
,
567 "Invalid packet size encountered in LTTng trace index file");
571 const auto offset
= bt2c::DataLen::fromBytes(be64toh(file_index
->offset
));
573 if (i
!= 0 && offset
< prev_index_entry
->offset
) {
576 "Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
577 "previous offset={} bytes, current offset={} bytes",
578 prev_index_entry
->offset
.bytes(), offset
.bytes());
582 index_entry
= ctf_fs_ds_index_entry_create(offset
, packetSize
);
584 BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file
->logger
,
585 "Failed to create a ctf_fs_ds_index_entry.");
589 /* Set path to stream file. */
590 index_entry
->path
= file_info
->path
.c_str();
592 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
593 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
594 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
597 "Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
598 "timestamp_begin={}, timestamp_end={}",
599 index_entry
->timestamp_begin
, index_entry
->timestamp_end
);
603 /* Convert the packet's bound to nanoseconds since Epoch. */
604 ret
= convert_cycles_to_ns(sc
->default_clock_class
, index_entry
->timestamp_begin
,
605 &index_entry
->timestamp_begin_ns
);
609 "Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
612 ret
= convert_cycles_to_ns(sc
->default_clock_class
, index_entry
->timestamp_end
,
613 &index_entry
->timestamp_end_ns
);
617 "Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
621 if (version_minor
>= 1) {
622 index_entry
->packet_seq_num
= be64toh(file_index
->packet_seq_num
);
625 totalPacketsSize
+= packetSize
;
626 file_pos
+= file_index_entry_size
;
628 prev_index_entry
= index_entry
.get();
630 index
->entries
.emplace_back(std::move(index_entry
));
633 /* Validate that the index addresses the complete stream. */
634 if (ds_file
->file
->size
!= totalPacketsSize
.bytes()) {
635 BT_CPPLOGW_SPEC(ds_file
->logger
,
636 "Invalid LTTng trace index file; indexed size != stream file size: "
637 "file-size={} bytes, total-packets-size={} bytes",
638 ds_file
->file
->size
, totalPacketsSize
.bytes());
648 static int init_index_entry(struct ctf_fs_ds_index_entry
*entry
, struct ctf_fs_ds_file
*ds_file
,
649 struct ctf_msg_iter_packet_properties
*props
)
652 struct ctf_stream_class
*sc
;
654 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
->stream_class_id
);
657 if (props
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
658 entry
->timestamp_begin
= props
->snapshots
.beginning_clock
;
660 /* Convert the packet's bound to nanoseconds since Epoch. */
661 ret
= convert_cycles_to_ns(sc
->default_clock_class
, props
->snapshots
.beginning_clock
,
662 &entry
->timestamp_begin_ns
);
664 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
665 "Failed to convert raw timestamp to nanoseconds since Epoch.");
669 entry
->timestamp_begin
= UINT64_C(-1);
670 entry
->timestamp_begin_ns
= UINT64_C(-1);
673 if (props
->snapshots
.end_clock
!= UINT64_C(-1)) {
674 entry
->timestamp_end
= props
->snapshots
.end_clock
;
676 /* Convert the packet's bound to nanoseconds since Epoch. */
677 ret
= convert_cycles_to_ns(sc
->default_clock_class
, props
->snapshots
.end_clock
,
678 &entry
->timestamp_end_ns
);
680 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
681 "Failed to convert raw timestamp to nanoseconds since Epoch.");
685 entry
->timestamp_end
= UINT64_C(-1);
686 entry
->timestamp_end_ns
= UINT64_C(-1);
693 static ctf_fs_ds_index::UP
build_index_from_stream_file(struct ctf_fs_ds_file
*ds_file
,
694 struct ctf_fs_ds_file_info
*file_info
,
695 struct ctf_msg_iter
*msg_iter
)
698 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
699 auto currentPacketOffset
= bt2c::DataLen::fromBytes(0);
701 BT_CPPLOGI_SPEC(ds_file
->logger
, "Indexing stream file {}", ds_file
->file
->path
);
703 ctf_fs_ds_index::UP index
= bt2s::make_unique
<ctf_fs_ds_index
>();
706 struct ctf_msg_iter_packet_properties props
;
708 if (currentPacketOffset
.bytes() > ds_file
->file
->size
) {
709 BT_CPPLOGE_STR_SPEC(ds_file
->logger
,
710 "Unexpected current packet's offset (larger than file).");
712 } else if (currentPacketOffset
.bytes() == ds_file
->file
->size
) {
717 iter_status
= ctf_msg_iter_seek(msg_iter
, currentPacketOffset
.bytes());
718 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
722 iter_status
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
723 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
728 * Get the current packet size from the packet header, if set. Else,
729 * assume there is a single packet in the file, so take the file size
730 * as the packet size.
732 const auto currentPacketSize
= props
.exp_packet_total_size
>= 0 ?
733 bt2c::DataLen::fromBits(props
.exp_packet_total_size
) :
734 bt2c::DataLen::fromBytes(ds_file
->file
->size
);
736 if ((currentPacketOffset
+ currentPacketSize
).bytes() > ds_file
->file
->size
) {
737 BT_CPPLOGW_SPEC(ds_file
->logger
,
738 "Invalid packet size reported in file: stream=\"{}\", "
739 "packet-offset-bytes={}, packet-size-bytes={}, "
740 "file-size-bytes={}",
741 ds_file
->file
->path
, currentPacketOffset
.bytes(),
742 currentPacketSize
.bytes(), ds_file
->file
->size
);
746 auto index_entry
= ctf_fs_ds_index_entry_create(currentPacketOffset
, currentPacketSize
);
748 BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file
->logger
,
749 "Failed to create a ctf_fs_ds_index_entry.");
753 /* Set path to stream file. */
754 index_entry
->path
= file_info
->path
.c_str();
756 ret
= init_index_entry(index_entry
.get(), ds_file
, &props
);
761 index
->entries
.emplace_back(std::move(index_entry
));
763 currentPacketOffset
+= currentPacketSize
;
764 BT_CPPLOGD_SPEC(ds_file
->logger
,
765 "Seeking to next packet: current-packet-offset-bytes={}, "
766 "next-packet-offset-bytes={}",
767 (currentPacketOffset
- currentPacketSize
).bytes(),
768 currentPacketOffset
.bytes());
779 ctf_fs_ds_file::UP
ctf_fs_ds_file_create(struct ctf_fs_trace
*ctf_fs_trace
,
780 bt2::Stream::Shared stream
, const char *path
,
781 const bt2c::Logger
& parentLogger
)
784 auto ds_file
= bt2s::make_unique
<ctf_fs_ds_file
>(parentLogger
);
787 ds_file
->file
= bt2s::make_unique
<ctf_fs_file
>(parentLogger
);
788 ds_file
->stream
= std::move(stream
);
789 ds_file
->metadata
= ctf_fs_trace
->metadata
.get();
790 ds_file
->file
->path
= path
;
791 ret
= ctf_fs_file_open(ds_file
->file
.get(), "rb");
796 offset_align
= bt_mmap_get_offset_align_size(static_cast<int>(ds_file
->logger
.level()));
797 ds_file
->mmap_max_len
= offset_align
* 2048;
802 /* Do not touch "borrowed" file. */
809 ctf_fs_ds_index::UP
ctf_fs_ds_file_build_index(struct ctf_fs_ds_file
*ds_file
,
810 struct ctf_fs_ds_file_info
*file_info
,
811 struct ctf_msg_iter
*msg_iter
)
813 auto index
= build_index_from_idx_file(ds_file
, file_info
, msg_iter
);
818 BT_CPPLOGI_SPEC(ds_file
->logger
, "Failed to build index from .index file; "
819 "falling back to stream indexing.");
820 index
= build_index_from_stream_file(ds_file
, file_info
, msg_iter
);
825 ctf_fs_ds_file::~ctf_fs_ds_file()
827 (void) ds_file_munmap(this);
830 ctf_fs_ds_file_info::UP
ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
832 ctf_fs_ds_file_info::UP ds_file_info
= bt2s::make_unique
<ctf_fs_ds_file_info
>();
834 ds_file_info
->path
= path
;
835 ds_file_info
->begin_ns
= begin_ns
;
839 ctf_fs_ds_file_group::UP
ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
840 struct ctf_stream_class
*sc
,
841 uint64_t stream_instance_id
,
842 ctf_fs_ds_index::UP index
)
844 ctf_fs_ds_file_group::UP ds_file_group
{new ctf_fs_ds_file_group
};
846 ds_file_group
->index
= std::move(index
);
848 ds_file_group
->stream_id
= stream_instance_id
;
850 ds_file_group
->sc
= sc
;
851 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
853 return ds_file_group
;