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/vendor/fmt/format.h"
17 #include "../common/src/msg-iter/msg-iter.hpp"
18 #include "data-stream-file.hpp"
21 #include "lttng-index.hpp"
23 static inline size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
25 BT_ASSERT_DBG(ds_file
->mmap_len
>= ds_file
->request_offset_in_mapping
);
26 return ds_file
->mmap_len
- ds_file
->request_offset_in_mapping
;
30 * Return true if `offset_in_file` is in the current mapping.
33 static bool offset_ist_mapped(struct ctf_fs_ds_file
*ds_file
, off_t offset_in_file
)
35 return offset_in_file
>= ds_file
->mmap_offset_in_file
&&
36 offset_in_file
< (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
39 static enum ctf_msg_iter_medium_status
ds_file_munmap(struct ctf_fs_ds_file
*ds_file
)
41 enum ctf_msg_iter_medium_status status
;
45 if (!ds_file
->mmap_addr
) {
46 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
50 if (bt_munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
51 BT_CPPLOGE_ERRNO_SPEC(ds_file
->logger
, "Cannot memory-unmap file",
52 ": address={}, size={}, file_path=\"{}\", file={}",
53 fmt::ptr(ds_file
->mmap_addr
), ds_file
->mmap_len
,
54 ds_file
->file
? ds_file
->file
->path
->str
: "NULL",
55 ds_file
->file
? fmt::ptr(ds_file
->file
->fp
) : NULL
);
56 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
60 ds_file
->mmap_addr
= NULL
;
62 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
68 * mmap a region of `ds_file` such that `requested_offset_in_file` is in the
69 * mapping. If the currently mmap-ed region already contains
70 * `requested_offset_in_file`, the mapping is kept.
72 * Set `ds_file->requested_offset_in_mapping` based on `request_offset_in_file`,
73 * such that the next call to `request_bytes` will return bytes starting at that
76 * `requested_offset_in_file` must be a valid offset in the file.
78 static enum ctf_msg_iter_medium_status
ds_file_mmap(struct ctf_fs_ds_file
*ds_file
,
79 off_t requested_offset_in_file
)
81 enum ctf_msg_iter_medium_status status
;
83 /* Ensure the requested offset is in the file range. */
84 BT_ASSERT(requested_offset_in_file
>= 0);
85 BT_ASSERT(requested_offset_in_file
< ds_file
->file
->size
);
88 * If the mapping already contains the requested offset, just adjust
89 * requested_offset_in_mapping.
91 if (offset_ist_mapped(ds_file
, requested_offset_in_file
)) {
92 ds_file
->request_offset_in_mapping
=
93 requested_offset_in_file
- ds_file
->mmap_offset_in_file
;
94 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
98 /* Unmap old region */
99 status
= ds_file_munmap(ds_file
);
100 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
105 * Compute a mapping that has the required alignment properties and
106 * contains `requested_offset_in_file`.
108 ds_file
->request_offset_in_mapping
=
109 requested_offset_in_file
%
110 bt_mmap_get_offset_align_size(static_cast<int>(ds_file
->logger
.level()));
111 ds_file
->mmap_offset_in_file
= requested_offset_in_file
- ds_file
->request_offset_in_mapping
;
113 MIN(ds_file
->file
->size
- ds_file
->mmap_offset_in_file
, ds_file
->mmap_max_len
);
115 BT_ASSERT(ds_file
->mmap_len
> 0);
118 bt_mmap(ds_file
->mmap_len
, PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
119 ds_file
->mmap_offset_in_file
, static_cast<int>(ds_file
->logger
.level()));
120 if (ds_file
->mmap_addr
== MAP_FAILED
) {
121 BT_CPPLOGE_SPEC(ds_file
->logger
,
122 "Cannot memory-map address (size {}) of file \"{}\" ({}) at offset {}: {}",
123 ds_file
->mmap_len
, ds_file
->file
->path
->str
, fmt::ptr(ds_file
->file
->fp
),
124 (intmax_t) ds_file
->mmap_offset_in_file
, strerror(errno
));
125 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
129 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
136 * Change the mapping of the file to read the region that follows the current
139 * If the file hasn't been mapped yet, then everything (mmap_offset_in_file,
140 * mmap_len, request_offset_in_mapping) should have the value 0, which will
141 * result in the beginning of the file getting mapped.
143 * return _EOF if the current mapping is the end of the file.
146 static enum ctf_msg_iter_medium_status
ds_file_mmap_next(struct ctf_fs_ds_file
*ds_file
)
148 enum ctf_msg_iter_medium_status status
;
151 * If we're called, it's because more bytes are requested but we have
152 * given all the bytes of the current mapping.
154 BT_ASSERT(ds_file
->request_offset_in_mapping
== ds_file
->mmap_len
);
157 * If the current mapping coincides with the end of the file, there is
160 if (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
== ds_file
->file
->size
) {
161 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
165 status
= ds_file_mmap(ds_file
, ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
171 static enum ctf_msg_iter_medium_status
medop_request_bytes(size_t request_sz
, uint8_t **buffer_addr
,
172 size_t *buffer_sz
, void *data
)
174 enum ctf_msg_iter_medium_status status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
175 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
177 BT_ASSERT(request_sz
> 0);
180 * Check if we have at least one memory-mapped byte left. If we don't,
181 * mmap the next file.
183 if (remaining_mmap_bytes(ds_file
) == 0) {
184 /* Are we at the end of the file? */
185 if (ds_file
->mmap_offset_in_file
>= ds_file
->file
->size
) {
186 BT_CPPLOGD_SPEC(ds_file
->logger
, "Reached end of file \"{}\" ({})",
187 ds_file
->file
->path
->str
, fmt::ptr(ds_file
->file
->fp
));
188 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
192 status
= ds_file_mmap_next(ds_file
);
194 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
196 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
199 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot memory-map next region of file \"{}\" ({})",
200 ds_file
->file
->path
->str
, fmt::ptr(ds_file
->file
->fp
));
205 BT_ASSERT(remaining_mmap_bytes(ds_file
) > 0);
206 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
208 BT_ASSERT(ds_file
->mmap_addr
);
209 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset_in_mapping
;
211 ds_file
->request_offset_in_mapping
+= *buffer_sz
;
215 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
221 static bt_stream
*medop_borrow_stream(bt_stream_class
*stream_class
, int64_t, void *data
)
223 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
224 bt_stream_class
*ds_file_stream_class
;
225 bt_stream
*stream
= NULL
;
227 ds_file_stream_class
= bt_stream_borrow_class(ds_file
->stream
);
229 if (stream_class
!= ds_file_stream_class
) {
231 * Not supported: two packets described by two different
232 * stream classes within the same data stream file.
237 stream
= ds_file
->stream
;
243 static enum ctf_msg_iter_medium_status
medop_seek(off_t offset
, void *data
)
245 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
247 BT_ASSERT(offset
>= 0);
248 BT_ASSERT(offset
< ds_file
->file
->size
);
250 return ds_file_mmap(ds_file
, offset
);
253 struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops
= {
260 struct ctf_fs_ds_group_medops_data
262 explicit ctf_fs_ds_group_medops_data(const bt2c::Logger
& parentLogger
) :
263 logger
{parentLogger
, "PLUGIN/SRC.CTF.FS/DS-GROUP-MEDOPS"}
269 /* Weak, set once at creation time. */
270 struct ctf_fs_ds_file_group
*ds_file_group
= nullptr;
273 * Index (as in element rank) of the index entry of ds_file_groups'
274 * index we will read next (so, the one after the one we are reading
277 guint next_index_entry_index
= 0;
280 * File we are currently reading. Changes whenever we switch to
281 * reading another data file.
285 struct ctf_fs_ds_file
*file
= nullptr;
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
);
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
);
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
|| strcmp(index_entry
->path
, data
->file
->file
->path
->str
) != 0) {
325 /* Destroy the previously used file. */
326 ctf_fs_ds_file_destroy(data
->file
);
328 /* Create the new file. */
330 ctf_fs_ds_file_create(data
->ds_file_group
->ctf_fs_trace
, data
->ds_file_group
->stream
,
331 index_entry
->path
, data
->logger
);
333 BT_CPPLOGE_APPEND_CAUSE_SPEC(data
->logger
, "failed to create ctf_fs_ds_file.");
334 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
340 * Ensure the right portion of the file will be returned on the next
341 * request_bytes call.
343 status
= ds_file_mmap(data
->file
, index_entry
->offset
);
344 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
348 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
354 static enum ctf_msg_iter_medium_status
medop_group_switch_packet(void *void_data
)
356 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
357 struct ctf_fs_ds_index_entry
*index_entry
;
358 enum ctf_msg_iter_medium_status status
;
360 /* If we have gone through all index entries, we are done. */
361 if (data
->next_index_entry_index
>= data
->ds_file_group
->index
->entries
->len
) {
362 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
367 * Otherwise, look up the next index entry / packet and prepare it
370 index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
371 data
->ds_file_group
->index
->entries
, data
->next_index_entry_index
);
373 status
= ctf_fs_ds_group_medops_set_file(data
, index_entry
);
374 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
378 data
->next_index_entry_index
++;
380 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
385 void ctf_fs_ds_group_medops_data_destroy(struct ctf_fs_ds_group_medops_data
*data
)
391 ctf_fs_ds_file_destroy(data
->file
);
399 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_data_create(
400 struct ctf_fs_ds_file_group
*ds_file_group
, bt_self_message_iterator
*self_msg_iter
,
401 const bt2c::Logger
& parentLogger
, struct ctf_fs_ds_group_medops_data
**out
)
403 BT_ASSERT(self_msg_iter
);
404 BT_ASSERT(ds_file_group
);
405 BT_ASSERT(ds_file_group
->index
);
406 BT_ASSERT(ds_file_group
->index
->entries
->len
> 0);
408 ctf_fs_ds_group_medops_data
*data
= new ctf_fs_ds_group_medops_data
{parentLogger
};
409 data
->ds_file_group
= ds_file_group
;
410 data
->self_msg_iter
= self_msg_iter
;
413 * No need to prepare the first file. ctf_msg_iter will call
414 * switch_packet before reading the first packet, it will be
419 return CTF_MSG_ITER_MEDIUM_STATUS_OK
;
422 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data
*data
)
424 data
->next_index_entry_index
= 0;
427 struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops
= {
428 .request_bytes
= medop_group_request_bytes
,
431 * We don't support seeking using this medops. It would probably be
432 * possible, but it's not needed at the moment.
436 .switch_packet
= medop_group_switch_packet
,
437 .borrow_stream
= medop_group_borrow_stream
,
440 static void ctf_fs_ds_index_entry_destroy(ctf_fs_ds_index_entry
*entry
)
445 static struct ctf_fs_ds_index_entry
*ctf_fs_ds_index_entry_create()
447 ctf_fs_ds_index_entry
*entry
= new ctf_fs_ds_index_entry
;
448 entry
->packet_seq_num
= UINT64_MAX
;
453 static int convert_cycles_to_ns(struct ctf_clock_class
*clock_class
, uint64_t cycles
, int64_t *ns
)
455 return bt_util_clock_cycles_to_ns_from_origin(cycles
, clock_class
->frequency
,
456 clock_class
->offset_seconds
,
457 clock_class
->offset_cycles
, ns
);
460 static struct ctf_fs_ds_index
*build_index_from_idx_file(struct ctf_fs_ds_file
*ds_file
,
461 struct ctf_fs_ds_file_info
*file_info
,
462 struct ctf_msg_iter
*msg_iter
)
465 gchar
*directory
= NULL
;
466 gchar
*basename
= NULL
;
467 GString
*index_basename
= NULL
;
468 gchar
*index_file_path
= NULL
;
469 GMappedFile
*mapped_file
= NULL
;
471 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
472 const struct ctf_packet_index_file_hdr
*header
= NULL
;
473 struct ctf_fs_ds_index
*index
= NULL
;
474 struct ctf_fs_ds_index_entry
*index_entry
= NULL
, *prev_index_entry
= NULL
;
475 uint64_t total_packets_size
= 0;
476 size_t file_index_entry_size
;
477 size_t file_entry_count
;
479 struct ctf_stream_class
*sc
;
480 struct ctf_msg_iter_packet_properties props
;
481 uint32_t version_major
, version_minor
;
483 BT_CPPLOGI_SPEC(ds_file
->logger
, "Building index from .idx file of stream file {}",
484 ds_file
->file
->path
->str
);
485 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
487 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
488 "Cannot read first packet's header and context fields.");
492 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
.stream_class_id
);
494 if (!sc
->default_clock_class
) {
495 BT_CPPLOGI_STR_SPEC(ds_file
->logger
, "Cannot find stream class's default clock class.");
499 /* Look for index file in relative path index/name.idx. */
500 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
502 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot get the basename of datastream file {}",
503 ds_file
->file
->path
->str
);
507 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
509 BT_CPPLOGE_SPEC(ds_file
->logger
, "Cannot get dirname of datastream file {}",
510 ds_file
->file
->path
->str
);
514 index_basename
= g_string_new(basename
);
515 if (!index_basename
) {
516 BT_CPPLOGE_STR_SPEC(ds_file
->logger
, "Cannot allocate index file basename string");
520 g_string_append(index_basename
, ".idx");
521 index_file_path
= g_build_filename(directory
, "index", index_basename
->str
, NULL
);
522 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
524 BT_CPPLOGD_SPEC(ds_file
->logger
, "Cannot create new mapped file {}", index_file_path
);
529 * The g_mapped_file API limits us to 4GB files on 32-bit.
530 * Traces with such large indexes have never been seen in the wild,
531 * but this would need to be adjusted to support them.
533 filesize
= g_mapped_file_get_length(mapped_file
);
534 if (filesize
< sizeof(*header
)) {
535 BT_CPPLOGW_SPEC(ds_file
->logger
,
536 "Invalid LTTng trace index file: "
537 "file size ({} bytes) < header size ({} bytes)",
538 filesize
, sizeof(*header
));
542 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
543 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
545 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
546 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
547 BT_CPPLOGW_STR_SPEC(ds_file
->logger
,
548 "Invalid LTTng trace index: \"magic\" field validation failed");
552 version_major
= be32toh(header
->index_major
);
553 version_minor
= be32toh(header
->index_minor
);
554 if (version_major
!= 1) {
555 BT_CPPLOGW_SPEC(ds_file
->logger
, "Unknown LTTng trace index version: major={}, minor={}",
556 version_major
, version_minor
);
560 file_index_entry_size
= be32toh(header
->packet_index_len
);
561 if (file_index_entry_size
< CTF_INDEX_1_0_SIZE
) {
564 "Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): "
565 "packet_index_len={}, CTF_INDEX_1_0_SIZE={}",
566 file_index_entry_size
, CTF_INDEX_1_0_SIZE
);
570 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
571 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
572 BT_CPPLOGW_SPEC(ds_file
->logger
,
573 "Invalid LTTng trace index: the index's size after the header "
574 "({} bytes) is not a multiple of the index entry size "
576 (filesize
- sizeof(*header
)), sizeof(*header
));
580 index
= ctf_fs_ds_index_create(ds_file
->logger
);
585 for (i
= 0; i
< file_entry_count
; i
++) {
586 struct ctf_packet_index
*file_index
= (struct ctf_packet_index
*) file_pos
;
587 uint64_t packet_size
= be64toh(file_index
->packet_size
);
589 if (packet_size
% CHAR_BIT
) {
590 BT_CPPLOGW_SPEC(ds_file
->logger
,
591 "Invalid packet size encountered in LTTng trace index file");
595 index_entry
= ctf_fs_ds_index_entry_create();
597 BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file
->logger
,
598 "Failed to create a ctf_fs_ds_index_entry.");
602 /* Set path to stream file. */
603 index_entry
->path
= file_info
->path
->str
;
605 /* Convert size in bits to bytes. */
606 packet_size
/= CHAR_BIT
;
607 index_entry
->packet_size
= packet_size
;
609 index_entry
->offset
= be64toh(file_index
->offset
);
610 if (i
!= 0 && index_entry
->offset
< prev_index_entry
->offset
) {
613 "Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
614 "previous offset={}, current offset={}",
615 prev_index_entry
->offset
, index_entry
->offset
);
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 total_packets_size
+= packet_size
;
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
!= total_packets_size
) {
664 BT_CPPLOGW_SPEC(ds_file
->logger
,
665 "Invalid LTTng trace index file; indexed size != stream file size: "
666 "file-size={}, total-packets-size={}",
667 ds_file
->file
->size
, total_packets_size
);
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
, off_t packet_size
,
693 struct ctf_stream_class
*sc
;
695 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
, props
->stream_class_id
);
697 BT_ASSERT(packet_offset
>= 0);
698 entry
->offset
= packet_offset
;
699 BT_ASSERT(packet_size
>= 0);
700 entry
->packet_size
= packet_size
;
702 if (props
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
703 entry
->timestamp_begin
= props
->snapshots
.beginning_clock
;
705 /* Convert the packet's bound to nanoseconds since Epoch. */
706 ret
= convert_cycles_to_ns(sc
->default_clock_class
, props
->snapshots
.beginning_clock
,
707 &entry
->timestamp_begin_ns
);
709 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
710 "Failed to convert raw timestamp to nanoseconds since Epoch.");
714 entry
->timestamp_begin
= UINT64_C(-1);
715 entry
->timestamp_begin_ns
= UINT64_C(-1);
718 if (props
->snapshots
.end_clock
!= UINT64_C(-1)) {
719 entry
->timestamp_end
= props
->snapshots
.end_clock
;
721 /* Convert the packet's bound to nanoseconds since Epoch. */
722 ret
= convert_cycles_to_ns(sc
->default_clock_class
, props
->snapshots
.end_clock
,
723 &entry
->timestamp_end_ns
);
725 BT_CPPLOGI_STR_SPEC(ds_file
->logger
,
726 "Failed to convert raw timestamp to nanoseconds since Epoch.");
730 entry
->timestamp_end
= UINT64_C(-1);
731 entry
->timestamp_end_ns
= UINT64_C(-1);
738 static struct ctf_fs_ds_index
*build_index_from_stream_file(struct ctf_fs_ds_file
*ds_file
,
739 struct ctf_fs_ds_file_info
*file_info
,
740 struct ctf_msg_iter
*msg_iter
)
743 struct ctf_fs_ds_index
*index
= NULL
;
744 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
745 off_t current_packet_offset_bytes
= 0;
747 BT_CPPLOGI_SPEC(ds_file
->logger
, "Indexing stream file {}", ds_file
->file
->path
->str
);
749 index
= ctf_fs_ds_index_create(ds_file
->logger
);
755 off_t current_packet_size_bytes
;
756 struct ctf_fs_ds_index_entry
*index_entry
;
757 struct ctf_msg_iter_packet_properties props
;
759 if (current_packet_offset_bytes
< 0) {
760 BT_CPPLOGE_STR_SPEC(ds_file
->logger
, "Cannot get the current packet's offset.");
762 } else if (current_packet_offset_bytes
> ds_file
->file
->size
) {
763 BT_CPPLOGE_STR_SPEC(ds_file
->logger
,
764 "Unexpected current packet's offset (larger than file).");
766 } else if (current_packet_offset_bytes
== ds_file
->file
->size
) {
771 iter_status
= ctf_msg_iter_seek(msg_iter
, current_packet_offset_bytes
);
772 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
776 iter_status
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
777 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
781 if (props
.exp_packet_total_size
>= 0) {
782 current_packet_size_bytes
= (uint64_t) props
.exp_packet_total_size
/ 8;
784 current_packet_size_bytes
= ds_file
->file
->size
;
787 if (current_packet_offset_bytes
+ current_packet_size_bytes
> ds_file
->file
->size
) {
788 BT_CPPLOGW_SPEC(ds_file
->logger
,
789 "Invalid packet size reported in file: stream=\"{}\", "
790 "packet-offset={}, packet-size-bytes={}, "
792 ds_file
->file
->path
->str
, (intmax_t) current_packet_offset_bytes
,
793 (intmax_t) current_packet_size_bytes
, (intmax_t) ds_file
->file
->size
);
797 index_entry
= ctf_fs_ds_index_entry_create();
799 BT_CPPLOGE_APPEND_CAUSE_SPEC(ds_file
->logger
,
800 "Failed to create a ctf_fs_ds_index_entry.");
804 /* Set path to stream file. */
805 index_entry
->path
= file_info
->path
->str
;
807 ret
= init_index_entry(index_entry
, ds_file
, &props
, current_packet_size_bytes
,
808 current_packet_offset_bytes
);
810 ctf_fs_ds_index_entry_destroy(index_entry
);
814 g_ptr_array_add(index
->entries
, index_entry
);
816 current_packet_offset_bytes
+= current_packet_size_bytes
;
817 BT_CPPLOGD_SPEC(ds_file
->logger
,
818 "Seeking to next packet: current-packet-offset={}, "
819 "next-packet-offset={}",
820 (intmax_t) (current_packet_offset_bytes
- current_packet_size_bytes
),
821 (intmax_t) current_packet_offset_bytes
);
828 ctf_fs_ds_index_destroy(index
);
833 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(struct ctf_fs_trace
*ctf_fs_trace
, bt_stream
*stream
,
834 const char *path
, const bt2c::Logger
& parentLogger
)
838 ctf_fs_ds_file
*ds_file
= new ctf_fs_ds_file
{parentLogger
};
844 ds_file
->file
= ctf_fs_file_create(parentLogger
);
845 if (!ds_file
->file
) {
849 ds_file
->stream
= stream
;
850 bt_stream_get_ref(ds_file
->stream
);
851 ds_file
->metadata
= ctf_fs_trace
->metadata
;
852 g_string_assign(ds_file
->file
->path
, path
);
853 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
858 offset_align
= bt_mmap_get_offset_align_size(static_cast<int>(ds_file
->logger
.level()));
859 ds_file
->mmap_max_len
= offset_align
* 2048;
864 /* Do not touch "borrowed" file. */
865 ctf_fs_ds_file_destroy(ds_file
);
872 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(struct ctf_fs_ds_file
*ds_file
,
873 struct ctf_fs_ds_file_info
*file_info
,
874 struct ctf_msg_iter
*msg_iter
)
876 struct ctf_fs_ds_index
*index
;
878 index
= build_index_from_idx_file(ds_file
, file_info
, msg_iter
);
883 BT_CPPLOGI_SPEC(ds_file
->logger
, "Failed to build index from .index file; "
884 "falling back to stream indexing.");
885 index
= build_index_from_stream_file(ds_file
, file_info
, msg_iter
);
890 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(const bt2c::Logger
& logger
)
892 ctf_fs_ds_index
*index
= new ctf_fs_ds_index
;
893 index
->entries
= g_ptr_array_new_with_free_func((GDestroyNotify
) ctf_fs_ds_index_entry_destroy
);
894 if (!index
->entries
) {
895 BT_CPPLOGE_SPEC(logger
, "Failed to allocate index entries.");
902 ctf_fs_ds_index_destroy(index
);
908 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
914 bt_stream_put_ref(ds_file
->stream
);
915 (void) ds_file_munmap(ds_file
);
918 ctf_fs_file_destroy(ds_file
->file
);
924 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
930 if (index
->entries
) {
931 g_ptr_array_free(index
->entries
, TRUE
);