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/bt2s/make-unique.hpp"
16 #include "cpp-common/vendor/fmt/format.h"
18 #include "../common/src/msg-iter/msg-iter.hpp"
19 #include "data-stream-file.hpp"
22 #include "lttng-index.hpp"
24 static inline size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
26 BT_ASSERT_DBG(ds_file
->mmap_len
>= ds_file
->request_offset_in_mapping
);
27 return ds_file
->mmap_len
- ds_file
->request_offset_in_mapping
;
31 * Return true if `offset_in_file` is in the current mapping.
34 static bool offset_ist_mapped(struct ctf_fs_ds_file
*ds_file
, off_t offset_in_file
)
36 return offset_in_file
>= ds_file
->mmap_offset_in_file
&&
37 offset_in_file
< (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
40 static enum ctf_msg_iter_medium_status
ds_file_munmap(struct ctf_fs_ds_file
*ds_file
)
42 enum ctf_msg_iter_medium_status status
;
46 if (!ds_file
->mmap_addr
) {
47 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
51 if (bt_munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
52 BT_CPPLOGE_ERRNO_SPEC(ds_file
->logger
, "Cannot memory-unmap file",
53 ": address={}, size={}, file_path=\"{}\", file={}",
54 fmt::ptr(ds_file
->mmap_addr
), ds_file
->mmap_len
,
55 ds_file
->file
? ds_file
->file
->path
->str
: "NULL",
56 ds_file
->file
? fmt::ptr(ds_file
->file
->fp
) : NULL
);
57 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
61 ds_file
->mmap_addr
= NULL
;
63 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
69 * mmap a region of `ds_file` such that `requested_offset_in_file` is in the
70 * mapping. If the currently mmap-ed region already contains
71 * `requested_offset_in_file`, the mapping is kept.
73 * Set `ds_file->requested_offset_in_mapping` based on `request_offset_in_file`,
74 * such that the next call to `request_bytes` will return bytes starting at that
77 * `requested_offset_in_file` must be a valid offset in the file.
79 static enum ctf_msg_iter_medium_status
ds_file_mmap(struct ctf_fs_ds_file
*ds_file
,
80 off_t requested_offset_in_file
)
82 enum ctf_msg_iter_medium_status status
;
84 /* Ensure the requested offset is in the file range. */
85 BT_ASSERT(requested_offset_in_file
>= 0);
86 BT_ASSERT(requested_offset_in_file
< ds_file
->file
->size
);
89 * If the mapping already contains the requested offset, just adjust
90 * requested_offset_in_mapping.
92 if (offset_ist_mapped(ds_file
, requested_offset_in_file
)) {
93 ds_file
->request_offset_in_mapping
=
94 requested_offset_in_file
- ds_file
->mmap_offset_in_file
;
95 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
99 /* Unmap old region */
100 status
= ds_file_munmap(ds_file
);
101 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
106 * Compute a mapping that has the required alignment properties and
107 * contains `requested_offset_in_file`.
109 ds_file
->request_offset_in_mapping
=
110 requested_offset_in_file
%
111 bt_mmap_get_offset_align_size(static_cast<int>(ds_file
->logger
.level()));
112 ds_file
->mmap_offset_in_file
= requested_offset_in_file
- ds_file
->request_offset_in_mapping
;
114 MIN(ds_file
->file
->size
- ds_file
->mmap_offset_in_file
, ds_file
->mmap_max_len
);
116 BT_ASSERT(ds_file
->mmap_len
> 0);
119 bt_mmap(ds_file
->mmap_len
, PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
120 ds_file
->mmap_offset_in_file
, static_cast<int>(ds_file
->logger
.level()));
121 if (ds_file
->mmap_addr
== MAP_FAILED
) {
122 BT_CPPLOGE_SPEC(ds_file
->logger
,
123 "Cannot memory-map address (size {}) of file \"{}\" ({}) at offset {}: {}",
124 ds_file
->mmap_len
, ds_file
->file
->path
->str
, fmt::ptr(ds_file
->file
->fp
),
125 (intmax_t) ds_file
->mmap_offset_in_file
, strerror(errno
));
126 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
130 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
137 * Change the mapping of the file to read the region that follows the current
140 * If the file hasn't been mapped yet, then everything (mmap_offset_in_file,
141 * mmap_len, request_offset_in_mapping) should have the value 0, which will
142 * result in the beginning of the file getting mapped.
144 * return _EOF if the current mapping is the end of the file.
147 static enum ctf_msg_iter_medium_status
ds_file_mmap_next(struct ctf_fs_ds_file
*ds_file
)
149 enum ctf_msg_iter_medium_status status
;
152 * If we're called, it's because more bytes are requested but we have
153 * given all the bytes of the current mapping.
155 BT_ASSERT(ds_file
->request_offset_in_mapping
== ds_file
->mmap_len
);
158 * If the current mapping coincides with the end of the file, there is
161 if (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
== ds_file
->file
->size
) {
162 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
166 status
= ds_file_mmap(ds_file
, ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
172 static enum ctf_msg_iter_medium_status
medop_request_bytes(size_t request_sz
, uint8_t **buffer_addr
,
173 size_t *buffer_sz
, void *data
)
175 enum ctf_msg_iter_medium_status status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
176 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
178 BT_ASSERT(request_sz
> 0);
181 * Check if we have at least one memory-mapped byte left. If we don't,
182 * mmap the next file.
184 if (remaining_mmap_bytes(ds_file
) == 0) {
185 /* Are we at the end of the file? */
186 if (ds_file
->mmap_offset_in_file
>= ds_file
->file
->size
) {
187 BT_CPPLOGD_SPEC(ds_file
->logger
, "Reached end of file \"{}\" ({})",
188 ds_file
->file
->path
->str
, fmt::ptr(ds_file
->file
->fp
));
189 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
193 status
= ds_file_mmap_next(ds_file
);
195 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
197 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
200 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot memory-map next region of file \"{}\" ({})",
201 ds_file
->file
->path
->str
, fmt::ptr(ds_file
->file
->fp
));
206 BT_ASSERT(remaining_mmap_bytes(ds_file
) > 0);
207 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
209 BT_ASSERT(ds_file
->mmap_addr
);
210 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset_in_mapping
;
212 ds_file
->request_offset_in_mapping
+= *buffer_sz
;
216 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
222 static bt_stream
*medop_borrow_stream(bt_stream_class
*stream_class
, int64_t, void *data
)
224 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
225 bt_stream_class
*ds_file_stream_class
;
226 bt_stream
*stream
= NULL
;
228 ds_file_stream_class
= bt_stream_borrow_class(ds_file
->stream
);
230 if (stream_class
!= ds_file_stream_class
) {
232 * Not supported: two packets described by two different
233 * stream classes within the same data stream file.
238 stream
= ds_file
->stream
;
244 static enum ctf_msg_iter_medium_status
medop_seek(off_t offset
, void *data
)
246 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
248 BT_ASSERT(offset
>= 0);
249 BT_ASSERT(offset
< ds_file
->file
->size
);
251 return ds_file_mmap(ds_file
, offset
);
254 struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops
= {
261 struct ctf_fs_ds_group_medops_data
263 explicit ctf_fs_ds_group_medops_data(const bt2c::Logger
& parentLogger
) :
264 logger
{parentLogger
, "PLUGIN/SRC.CTF.FS/DS-GROUP-MEDOPS"}
270 /* Weak, set once at creation time. */
271 struct ctf_fs_ds_file_group
*ds_file_group
= nullptr;
274 * Index (as in element rank) of the index entry of ds_file_groups'
275 * index we will read next (so, the one after the one we are reading
278 guint next_index_entry_index
= 0;
281 * File we are currently reading. Changes whenever we switch to
282 * reading another data file.
286 struct ctf_fs_ds_file
*file
= nullptr;
288 /* Weak, for context / logging / appending causes. */
289 bt_self_message_iterator
*self_msg_iter
= nullptr;
292 static enum ctf_msg_iter_medium_status
medop_group_request_bytes(size_t request_sz
,
293 uint8_t **buffer_addr
,
294 size_t *buffer_sz
, void *void_data
)
296 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
298 /* Return bytes from the current file. */
299 return medop_request_bytes(request_sz
, buffer_addr
, buffer_sz
, data
->file
);
302 static bt_stream
*medop_group_borrow_stream(bt_stream_class
*stream_class
, int64_t stream_id
,
305 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
307 return medop_borrow_stream(stream_class
, stream_id
, data
->file
);
311 * Set `data->file` to prepare it to read the packet described
315 static enum ctf_msg_iter_medium_status
316 ctf_fs_ds_group_medops_set_file(struct ctf_fs_ds_group_medops_data
*data
,
317 struct ctf_fs_ds_index_entry
*index_entry
)
319 enum ctf_msg_iter_medium_status status
;
322 BT_ASSERT(index_entry
);
324 /* Check if that file is already the one mapped. */
325 if (!data
->file
|| strcmp(index_entry
->path
, data
->file
->file
->path
->str
) != 0) {
326 /* Destroy the previously used file. */
327 ctf_fs_ds_file_destroy(data
->file
);
329 /* Create the new file. */
331 ctf_fs_ds_file_create(data
->ds_file_group
->ctf_fs_trace
, data
->ds_file_group
->stream
,
332 index_entry
->path
, data
->logger
);
334 BT_CPPLOGE_APPEND_CAUSE_SPEC(data
->logger
, "failed to create ctf_fs_ds_file.");
335 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
341 * Ensure the right portion of the file will be returned on the next
342 * request_bytes call.
344 status
= ds_file_mmap(data
->file
, index_entry
->offset
.bytes());
345 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
349 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
355 static enum ctf_msg_iter_medium_status
medop_group_switch_packet(void *void_data
)
357 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
358 struct ctf_fs_ds_index_entry
*index_entry
;
359 enum ctf_msg_iter_medium_status status
;
361 /* If we have gone through all index entries, we are done. */
362 if (data
->next_index_entry_index
>= data
->ds_file_group
->index
->entries
->len
) {
363 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
368 * Otherwise, look up the next index entry / packet and prepare it
371 index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
372 data
->ds_file_group
->index
->entries
, data
->next_index_entry_index
);
374 status
= ctf_fs_ds_group_medops_set_file(data
, index_entry
);
375 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
379 data
->next_index_entry_index
++;
381 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
386 void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data
*data
)
392 ctf_fs_ds_file_destroy(data
->file
);
400 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_data_create(
401 struct ctf_fs_ds_file_group
*ds_file_group
, bt_self_message_iterator
*self_msg_iter
,
402 const bt2c::Logger
& parentLogger
, struct ctf_fs_ds_group_medops_data
**out
)
404 BT_ASSERT(self_msg_iter
);
405 BT_ASSERT(ds_file_group
);
406 BT_ASSERT(ds_file_group
->index
);
407 BT_ASSERT(ds_file_group
->index
->entries
->len
> 0);
409 ctf_fs_ds_group_medops_data
*data
= new ctf_fs_ds_group_medops_data
{parentLogger
};
410 data
->ds_file_group
= ds_file_group
;
411 data
->self_msg_iter
= self_msg_iter
;
414 * No need to prepare the first file. ctf_msg_iter will call
415 * switch_packet before reading the first packet, it will be
420 return CTF_MSG_ITER_MEDIUM_STATUS_OK
;
423 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data
*data
)
425 data
->next_index_entry_index
= 0;
428 struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops
= {
429 .request_bytes
= medop_group_request_bytes
,
432 * We don't support seeking using this medops. It would probably be
433 * possible, but it's not needed at the moment.
437 .switch_packet
= medop_group_switch_packet
,
438 .borrow_stream
= medop_group_borrow_stream
,
441 static void ctf_fs_ds_index_entry_destroy(ctf_fs_ds_index_entry
*entry
)
446 static struct ctf_fs_ds_index_entry
*ctf_fs_ds_index_entry_create(const bt2c::DataLen offset
,
447 const bt2c::DataLen packetSize
)
449 ctf_fs_ds_index_entry
*entry
= new ctf_fs_ds_index_entry
{offset
, packetSize
};
451 entry
->packet_seq_num
= UINT64_MAX
;
456 static int convert_cycles_to_ns(struct ctf_clock_class
*clock_class
, uint64_t cycles
, int64_t *ns
)
458 return bt_util_clock_cycles_to_ns_from_origin(cycles
, clock_class
->frequency
,
459 clock_class
->offset_seconds
,
460 clock_class
->offset_cycles
, ns
);
463 static struct ctf_fs_ds_index
*build_index_from_idx_file(struct ctf_fs_ds_file
*ds_file
,
464 struct ctf_fs_ds_file_info
*file_info
,
465 struct ctf_msg_iter
*msg_iter
)
468 gchar
*directory
= NULL
;
469 gchar
*basename
= NULL
;
470 GString
*index_basename
= NULL
;
471 gchar
*index_file_path
= NULL
;
472 GMappedFile
*mapped_file
= NULL
;
474 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
475 const struct ctf_packet_index_file_hdr
*header
= NULL
;
476 struct ctf_fs_ds_index
*index
= NULL
;
477 struct ctf_fs_ds_index_entry
*index_entry
= NULL
, *prev_index_entry
= NULL
;
478 auto totalPacketsSize
= bt2c::DataLen::fromBytes(0);
479 size_t file_index_entry_size
;
480 size_t file_entry_count
;
482 struct ctf_stream_class
*sc
;
483 struct ctf_msg_iter_packet_properties props
;
484 uint32_t version_major
, version_minor
;
486 BT_CPPLOGI_SPEC(ds_file
->logger
, "Building index from .idx file of stream file {}",
487 ds_file
->file
->path
->str
);
488 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
490 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
491 "Cannot read first packet's header and context fields.");
495 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
497 if (!sc
->default_clock_class
) {
498 BT_CPPLOGI_STR_SPEC(ds_file
->logger
, "Cannot find stream class's default clock class.");
502 /* Look for index file in relative path index/name.idx. */
503 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
505 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot get the basename of datastream file {}",
506 ds_file
->file
->path
->str
);
510 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
512 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot get dirname of datastream file {}",
513 ds_file
->file
->path
->str
);
517 index_basename
= g_string_new(basename
);
518 if (!index_basename
) {
519 BT_CPPLOGE_STR_SPEC(ds_file
->logger
, "Cannot allocate index file basename string");
523 g_string_append(index_basename
, ".idx");
524 index_file_path
= g_build_filename(directory
, "index", index_basename
->str
, NULL
);
525 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
527 BT_CPPLOGD_SPEC(ds_file
->logger
, "Cannot create new mapped file {}", index_file_path
);
532 * The g_mapped_file API limits us to 4GB files on 32-bit.
533 * Traces with such large indexes have never been seen in the wild,
534 * but this would need to be adjusted to support them.
536 filesize
= g_mapped_file_get_length(mapped_file
);
537 if (filesize
< sizeof(*header
)) {
538 BT_CPPLOGW_SPEC(ds_file
->logger
,
539 "Invalid LTTng trace index file: "
540 "file size ({} bytes) < header size ({} bytes)",
541 filesize
, sizeof(*header
));
545 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
546 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
548 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
549 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
550 BT_CPPLOGW_STR_SPEC(ds_file
->logger
,
551 "Invalid LTTng trace index: \"magic\" field validation failed");
555 version_major
= be32toh(header
->index_major
);
556 version_minor
= be32toh(header
->index_minor
);
557 if (version_major
!= 1) {
558 BT_CPPLOGW_SPEC(ds_file
->logger
, "Unknown LTTng trace index version: major={}, minor={}",
559 version_major
, version_minor
);
563 file_index_entry_size
= be32toh(header
->packet_index_len
);
564 if (file_index_entry_size
< CTF_INDEX_1_0_SIZE
) {
567 "Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): "
568 "packet_index_len={}, CTF_INDEX_1_0_SIZE={}",
569 file_index_entry_size
, CTF_INDEX_1_0_SIZE
);
573 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
574 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
575 BT_CPPLOGW_SPEC(ds_file
->logger
,
576 "Invalid LTTng trace index: the index's size after the header "
577 "({} bytes) is not a multiple of the index entry size "
579 (filesize
- sizeof(*header
)), sizeof(*header
));
583 index
= ctf_fs_ds_index_create(ds_file
->logger
);
588 for (i
= 0; i
< file_entry_count
; i
++) {
589 struct ctf_packet_index
*file_index
= (struct ctf_packet_index
*) file_pos
;
590 const auto packetSize
= bt2c::DataLen::fromBits(be64toh(file_index
->packet_size
));
592 if (packetSize
.hasExtraBits()) {
593 BT_CPPLOGW_SPEC(ds_file
->logger
,
594 "Invalid packet size encountered in LTTng trace index file");
598 const auto offset
= bt2c::DataLen::fromBytes(be64toh(file_index
->offset
));
600 if (i
!= 0 && offset
< prev_index_entry
->offset
) {
603 "Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
604 "previous offset={} bytes, current offset={} bytes",
605 prev_index_entry
->offset
.bytes(), offset
.bytes());
609 index_entry
= ctf_fs_ds_index_entry_create(offset
, packetSize
);
611 BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file
->logger
,
612 "Failed to create a ctf_fs_ds_index_entry.");
616 /* Set path to stream file. */
617 index_entry
->path
= file_info
->path
.c_str();
619 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
620 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
621 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
624 "Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
625 "timestamp_begin={}, timestamp_end={}",
626 index_entry
->timestamp_begin
, index_entry
->timestamp_end
);
630 /* Convert the packet's bound to nanoseconds since Epoch. */
631 ret
= convert_cycles_to_ns(sc
->default_clock_class
, index_entry
->timestamp_begin
,
632 &index_entry
->timestamp_begin_ns
);
636 "Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
639 ret
= convert_cycles_to_ns(sc
->default_clock_class
, index_entry
->timestamp_end
,
640 &index_entry
->timestamp_end_ns
);
644 "Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
648 if (version_minor
>= 1) {
649 index_entry
->packet_seq_num
= be64toh(file_index
->packet_seq_num
);
652 totalPacketsSize
+= packetSize
;
653 file_pos
+= file_index_entry_size
;
655 prev_index_entry
= index_entry
;
657 /* Give ownership of `index_entry` to `index->entries`. */
658 g_ptr_array_add(index
->entries
, index_entry
);
662 /* Validate that the index addresses the complete stream. */
663 if (ds_file
->file
->size
!= totalPacketsSize
.bytes()) {
664 BT_CPPLOGW_SPEC(ds_file
->logger
,
665 "Invalid LTTng trace index file; indexed size != stream file size: "
666 "file-size={} bytes, total-packets-size={} bytes",
667 ds_file
->file
->size
, totalPacketsSize
.bytes());
673 g_free(index_file_path
);
674 if (index_basename
) {
675 g_string_free(index_basename
, TRUE
);
678 g_mapped_file_unref(mapped_file
);
682 ctf_fs_ds_index_destroy(index
);
683 ctf_fs_ds_index_entry_destroy(index_entry
);
688 static int init_index_entry(struct ctf_fs_ds_index_entry
*entry
, struct ctf_fs_ds_file
*ds_file
,
689 struct ctf_msg_iter_packet_properties
*props
)
692 struct ctf_stream_class
*sc
;
694 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
->stream_class_id
);
697 if (props
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
698 entry
->timestamp_begin
= props
->snapshots
.beginning_clock
;
700 /* Convert the packet's bound to nanoseconds since Epoch. */
701 ret
= convert_cycles_to_ns(sc
->default_clock_class
, props
->snapshots
.beginning_clock
,
702 &entry
->timestamp_begin_ns
);
704 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
705 "Failed to convert raw timestamp to nanoseconds since Epoch.");
709 entry
->timestamp_begin
= UINT64_C(-1);
710 entry
->timestamp_begin_ns
= UINT64_C(-1);
713 if (props
->snapshots
.end_clock
!= UINT64_C(-1)) {
714 entry
->timestamp_end
= props
->snapshots
.end_clock
;
716 /* Convert the packet's bound to nanoseconds since Epoch. */
717 ret
= convert_cycles_to_ns(sc
->default_clock_class
, props
->snapshots
.end_clock
,
718 &entry
->timestamp_end_ns
);
720 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
721 "Failed to convert raw timestamp to nanoseconds since Epoch.");
725 entry
->timestamp_end
= UINT64_C(-1);
726 entry
->timestamp_end_ns
= UINT64_C(-1);
733 static struct ctf_fs_ds_index
*build_index_from_stream_file(struct ctf_fs_ds_file
*ds_file
,
734 struct ctf_fs_ds_file_info
*file_info
,
735 struct ctf_msg_iter
*msg_iter
)
738 struct ctf_fs_ds_index
*index
= NULL
;
739 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
740 auto currentPacketOffset
= bt2c::DataLen::fromBytes(0);
742 BT_CPPLOGI_SPEC(ds_file
->logger
, "Indexing stream file {}", ds_file
->file
->path
->str
);
744 index
= ctf_fs_ds_index_create(ds_file
->logger
);
750 struct ctf_msg_iter_packet_properties props
;
752 if (currentPacketOffset
.bytes() > ds_file
->file
->size
) {
753 BT_CPPLOGE_STR_SPEC(ds_file
->logger
,
754 "Unexpected current packet's offset (larger than file).");
756 } else if (currentPacketOffset
.bytes() == ds_file
->file
->size
) {
761 iter_status
= ctf_msg_iter_seek(msg_iter
, currentPacketOffset
.bytes());
762 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
766 iter_status
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
767 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
772 * Get the current packet size from the packet header, if set. Else,
773 * assume there is a single packet in the file, so take the file size
774 * as the packet size.
776 const auto currentPacketSize
= props
.exp_packet_total_size
>= 0 ?
777 bt2c::DataLen::fromBits(props
.exp_packet_total_size
) :
778 bt2c::DataLen::fromBytes(ds_file
->file
->size
);
780 if ((currentPacketOffset
+ currentPacketSize
).bytes() > ds_file
->file
->size
) {
781 BT_CPPLOGW_SPEC(ds_file
->logger
,
782 "Invalid packet size reported in file: stream=\"{}\", "
783 "packet-offset-bytes={}, packet-size-bytes={}, "
784 "file-size-bytes={}",
785 ds_file
->file
->path
->str
, currentPacketOffset
.bytes(),
786 currentPacketSize
.bytes(), ds_file
->file
->size
);
790 const auto index_entry
=
791 ctf_fs_ds_index_entry_create(currentPacketOffset
, currentPacketSize
);
793 BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file
->logger
,
794 "Failed to create a ctf_fs_ds_index_entry.");
798 /* Set path to stream file. */
799 index_entry
->path
= file_info
->path
.c_str();
801 ret
= init_index_entry(index_entry
, ds_file
, &props
);
803 ctf_fs_ds_index_entry_destroy(index_entry
);
807 g_ptr_array_add(index
->entries
, index_entry
);
809 currentPacketOffset
+= currentPacketSize
;
810 BT_CPPLOGD_SPEC(ds_file
->logger
,
811 "Seeking to next packet: current-packet-offset-bytes={}, "
812 "next-packet-offset-bytes={}",
813 (currentPacketOffset
- currentPacketSize
).bytes(),
814 currentPacketOffset
.bytes());
821 ctf_fs_ds_index_destroy(index
);
826 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(struct ctf_fs_trace
*ctf_fs_trace
, bt_stream
*stream
,
827 const char *path
, const bt2c::Logger
& parentLogger
)
831 ctf_fs_ds_file
*ds_file
= new ctf_fs_ds_file
{parentLogger
};
837 ds_file
->file
= ctf_fs_file_create(parentLogger
);
838 if (!ds_file
->file
) {
842 ds_file
->stream
= stream
;
843 bt_stream_get_ref(ds_file
->stream
);
844 ds_file
->metadata
= ctf_fs_trace
->metadata
;
845 g_string_assign(ds_file
->file
->path
, path
);
846 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
851 offset_align
= bt_mmap_get_offset_align_size(static_cast<int>(ds_file
->logger
.level()));
852 ds_file
->mmap_max_len
= offset_align
* 2048;
857 /* Do not touch "borrowed" file. */
858 ctf_fs_ds_file_destroy(ds_file
);
865 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(struct ctf_fs_ds_file
*ds_file
,
866 struct ctf_fs_ds_file_info
*file_info
,
867 struct ctf_msg_iter
*msg_iter
)
869 struct ctf_fs_ds_index
*index
;
871 index
= build_index_from_idx_file(ds_file
, file_info
, msg_iter
);
876 BT_CPPLOGI_SPEC(ds_file
->logger
, "Failed to build index from .index file; "
877 "falling back to stream indexing.");
878 index
= build_index_from_stream_file(ds_file
, file_info
, msg_iter
);
883 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(const bt2c::Logger
& logger
)
885 ctf_fs_ds_index
*index
= new ctf_fs_ds_index
;
886 index
->entries
= g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_index_entry_destroy
);
887 if (!index
->entries
) {
888 BT_CPPLOGE_SPEC(logger
, "Failed to allocate index entries.");
895 ctf_fs_ds_index_destroy(index
);
901 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
907 bt_stream_put_ref(ds_file
->stream
);
908 (void) ds_file_munmap(ds_file
);
911 ctf_fs_file_destroy(ds_file
->file
);
917 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
923 if (index
->entries
) {
924 g_ptr_array_free(index
->entries
, TRUE
);
930 ctf_fs_ds_file_info::UP
ctf_fs_ds_file_info_create(const char *path
, int64_t begin_ns
)
932 ctf_fs_ds_file_info::UP ds_file_info
= bt2s::make_unique
<ctf_fs_ds_file_info
>();
934 ds_file_info
->path
= path
;
935 ds_file_info
->begin_ns
= begin_ns
;
939 static void ctf_fs_ds_file_group_destroy(struct ctf_fs_ds_file_group
*ds_file_group
)
941 if (!ds_file_group
) {
945 ctf_fs_ds_index_destroy(ds_file_group
->index
);
947 bt_stream_put_ref(ds_file_group
->stream
);
948 delete ds_file_group
;
951 void ctf_fs_ds_file_group_deleter::operator()(ctf_fs_ds_file_group
*group
) noexcept
953 ctf_fs_ds_file_group_destroy(group
);
956 ctf_fs_ds_file_group::UP
ctf_fs_ds_file_group_create(struct ctf_fs_trace
*ctf_fs_trace
,
957 struct ctf_stream_class
*sc
,
958 uint64_t stream_instance_id
,
959 struct ctf_fs_ds_index
*index
)
961 ctf_fs_ds_file_group::UP ds_file_group
{new ctf_fs_ds_file_group
};
963 ds_file_group
->index
= index
;
965 ds_file_group
->stream_id
= stream_instance_id
;
967 ds_file_group
->sc
= sc
;
968 ds_file_group
->ctf_fs_trace
= ctf_fs_trace
;
970 return ds_file_group
;