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
9 #define BT_COMP_LOG_SELF_COMP (self_comp)
10 #define BT_LOG_OUTPUT_LEVEL (log_level)
11 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/DS"
12 #include "logging/comp-logging.h"
20 #include "compat/mman.h"
21 #include "compat/endian.h"
22 #include <babeltrace2/babeltrace.h>
23 #include "common/common.h"
25 #include "metadata.hpp"
26 #include "../common/msg-iter/msg-iter.hpp"
27 #include "common/assert.h"
28 #include "data-stream-file.hpp"
32 size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
34 BT_ASSERT_DBG(ds_file
->mmap_len
>= ds_file
->request_offset_in_mapping
);
35 return ds_file
->mmap_len
- ds_file
->request_offset_in_mapping
;
39 * Return true if `offset_in_file` is in the current mapping.
43 bool offset_ist_mapped(struct ctf_fs_ds_file
*ds_file
, off_t offset_in_file
)
45 return offset_in_file
>= ds_file
->mmap_offset_in_file
&&
46 offset_in_file
< (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
50 enum ctf_msg_iter_medium_status
ds_file_munmap(
51 struct ctf_fs_ds_file
*ds_file
)
53 enum ctf_msg_iter_medium_status status
;
54 bt_self_component
*self_comp
= ds_file
->self_comp
;
55 bt_logging_level log_level
= ds_file
->log_level
;
59 if (!ds_file
->mmap_addr
) {
60 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
64 if (bt_munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
65 BT_COMP_LOGE_ERRNO("Cannot memory-unmap file",
66 ": address=%p, size=%zu, file_path=\"%s\", file=%p",
67 ds_file
->mmap_addr
, ds_file
->mmap_len
,
68 ds_file
->file
? ds_file
->file
->path
->str
: "NULL",
69 ds_file
->file
? ds_file
->file
->fp
: NULL
);
70 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
74 ds_file
->mmap_addr
= NULL
;
76 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
82 * mmap a region of `ds_file` such that `requested_offset_in_file` is in the
83 * mapping. If the currently mmap-ed region already contains
84 * `requested_offset_in_file`, the mapping is kept.
86 * Set `ds_file->requested_offset_in_mapping` based on `request_offset_in_file`,
87 * such that the next call to `request_bytes` will return bytes starting at that
90 * `requested_offset_in_file` must be a valid offset in the file.
93 enum ctf_msg_iter_medium_status
ds_file_mmap(
94 struct ctf_fs_ds_file
*ds_file
, off_t requested_offset_in_file
)
96 enum ctf_msg_iter_medium_status status
;
97 bt_self_component
*self_comp
= ds_file
->self_comp
;
98 bt_logging_level log_level
= ds_file
->log_level
;
100 /* Ensure the requested offset is in the file range. */
101 BT_ASSERT(requested_offset_in_file
>= 0);
102 BT_ASSERT(requested_offset_in_file
< ds_file
->file
->size
);
105 * If the mapping already contains the requested offset, just adjust
106 * requested_offset_in_mapping.
108 if (offset_ist_mapped(ds_file
, requested_offset_in_file
)) {
109 ds_file
->request_offset_in_mapping
=
110 requested_offset_in_file
- ds_file
->mmap_offset_in_file
;
111 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
115 /* Unmap old region */
116 status
= ds_file_munmap(ds_file
);
117 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
122 * Compute a mapping that has the required alignment properties and
123 * contains `requested_offset_in_file`.
125 ds_file
->request_offset_in_mapping
=
126 requested_offset_in_file
% bt_mmap_get_offset_align_size(ds_file
->log_level
);
127 ds_file
->mmap_offset_in_file
=
128 requested_offset_in_file
- ds_file
->request_offset_in_mapping
;
129 ds_file
->mmap_len
= MIN(ds_file
->file
->size
- ds_file
->mmap_offset_in_file
,
130 ds_file
->mmap_max_len
);
132 BT_ASSERT(ds_file
->mmap_len
> 0);
134 ds_file
->mmap_addr
= bt_mmap((void *) 0, ds_file
->mmap_len
,
135 PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
136 ds_file
->mmap_offset_in_file
, ds_file
->log_level
);
137 if (ds_file
->mmap_addr
== MAP_FAILED
) {
138 BT_COMP_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
139 ds_file
->mmap_len
, ds_file
->file
->path
->str
,
140 ds_file
->file
->fp
, (intmax_t) ds_file
->mmap_offset_in_file
,
142 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
146 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
153 * Change the mapping of the file to read the region that follows the current
156 * If the file hasn't been mapped yet, then everything (mmap_offset_in_file,
157 * mmap_len, request_offset_in_mapping) should have the value 0, which will
158 * result in the beginning of the file getting mapped.
160 * return _EOF if the current mapping is the end of the file.
164 enum ctf_msg_iter_medium_status
ds_file_mmap_next(
165 struct ctf_fs_ds_file
*ds_file
)
167 enum ctf_msg_iter_medium_status status
;
170 * If we're called, it's because more bytes are requested but we have
171 * given all the bytes of the current mapping.
173 BT_ASSERT(ds_file
->request_offset_in_mapping
== ds_file
->mmap_len
);
176 * If the current mapping coincides with the end of the file, there is
179 if (ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
== ds_file
->file
->size
) {
180 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
184 status
= ds_file_mmap(ds_file
,
185 ds_file
->mmap_offset_in_file
+ ds_file
->mmap_len
);
192 enum ctf_msg_iter_medium_status
medop_request_bytes(
193 size_t request_sz
, uint8_t **buffer_addr
,
194 size_t *buffer_sz
, void *data
)
196 enum ctf_msg_iter_medium_status status
=
197 CTF_MSG_ITER_MEDIUM_STATUS_OK
;
198 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
199 bt_self_component
*self_comp
= ds_file
->self_comp
;
200 bt_logging_level log_level
= ds_file
->log_level
;
202 BT_ASSERT(request_sz
> 0);
205 * Check if we have at least one memory-mapped byte left. If we don't,
206 * mmap the next file.
208 if (remaining_mmap_bytes(ds_file
) == 0) {
209 /* Are we at the end of the file? */
210 if (ds_file
->mmap_offset_in_file
>= ds_file
->file
->size
) {
211 BT_COMP_LOGD("Reached end of file \"%s\" (%p)",
212 ds_file
->file
->path
->str
, ds_file
->file
->fp
);
213 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
217 status
= ds_file_mmap_next(ds_file
);
219 case CTF_MSG_ITER_MEDIUM_STATUS_OK
:
221 case CTF_MSG_ITER_MEDIUM_STATUS_EOF
:
224 BT_COMP_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
225 ds_file
->file
->path
->str
,
231 BT_ASSERT(remaining_mmap_bytes(ds_file
) > 0);
232 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
234 BT_ASSERT(ds_file
->mmap_addr
);
235 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset_in_mapping
;
237 ds_file
->request_offset_in_mapping
+= *buffer_sz
;
241 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
248 bt_stream
*medop_borrow_stream(bt_stream_class
*stream_class
, int64_t stream_id
,
251 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
252 bt_stream_class
*ds_file_stream_class
;
253 bt_stream
*stream
= NULL
;
255 ds_file_stream_class
= bt_stream_borrow_class(
258 if (stream_class
!= ds_file_stream_class
) {
260 * Not supported: two packets described by two different
261 * stream classes within the same data stream file.
266 stream
= ds_file
->stream
;
273 enum ctf_msg_iter_medium_status
medop_seek(off_t offset
, void *data
)
275 struct ctf_fs_ds_file
*ds_file
= (struct ctf_fs_ds_file
*) data
;
277 BT_ASSERT(offset
>= 0);
278 BT_ASSERT(offset
< ds_file
->file
->size
);
280 return ds_file_mmap(ds_file
, offset
);
284 struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops
= {
291 struct ctf_fs_ds_group_medops_data
{
292 /* Weak, set once at creation time. */
293 struct ctf_fs_ds_file_group
*ds_file_group
;
296 * Index (as in element rank) of the index entry of ds_file_groups'
297 * index we will read next (so, the one after the one we are reading
300 guint next_index_entry_index
;
303 * File we are currently reading. Changes whenever we switch to
304 * reading another data file.
308 struct ctf_fs_ds_file
*file
;
310 /* Weak, for context / logging / appending causes. */
311 bt_self_message_iterator
*self_msg_iter
;
312 bt_logging_level log_level
;
316 enum ctf_msg_iter_medium_status
medop_group_request_bytes(
318 uint8_t **buffer_addr
,
322 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
324 /* Return bytes from the current file. */
325 return medop_request_bytes(request_sz
, buffer_addr
, buffer_sz
, data
->file
);
329 bt_stream
*medop_group_borrow_stream(
330 bt_stream_class
*stream_class
,
334 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
336 return medop_borrow_stream(stream_class
, stream_id
, data
->file
);
340 * Set `data->file` to prepare it to read the packet described
345 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_set_file(
346 struct ctf_fs_ds_group_medops_data
*data
,
347 struct ctf_fs_ds_index_entry
*index_entry
,
348 bt_self_message_iterator
*self_msg_iter
,
349 bt_logging_level log_level
)
351 enum ctf_msg_iter_medium_status status
;
354 BT_ASSERT(index_entry
);
356 /* Check if that file is already the one mapped. */
357 if (!data
->file
|| strcmp(index_entry
->path
, data
->file
->file
->path
->str
) != 0) {
358 /* Destroy the previously used file. */
359 ctf_fs_ds_file_destroy(data
->file
);
361 /* Create the new file. */
362 data
->file
= ctf_fs_ds_file_create(
363 data
->ds_file_group
->ctf_fs_trace
,
365 data
->ds_file_group
->stream
,
369 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
,
370 "failed to create ctf_fs_ds_file.");
371 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
377 * Ensure the right portion of the file will be returned on the next
378 * request_bytes call.
380 status
= ds_file_mmap(data
->file
, index_entry
->offset
);
381 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
385 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
392 enum ctf_msg_iter_medium_status
medop_group_switch_packet(void *void_data
)
394 struct ctf_fs_ds_group_medops_data
*data
= (struct ctf_fs_ds_group_medops_data
*) void_data
;
395 struct ctf_fs_ds_index_entry
*index_entry
;
396 enum ctf_msg_iter_medium_status status
;
398 /* If we have gone through all index entries, we are done. */
399 if (data
->next_index_entry_index
>=
400 data
->ds_file_group
->index
->entries
->len
) {
401 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
406 * Otherwise, look up the next index entry / packet and prepare it
409 index_entry
= (struct ctf_fs_ds_index_entry
*) g_ptr_array_index(
410 data
->ds_file_group
->index
->entries
,
411 data
->next_index_entry_index
);
413 status
= ctf_fs_ds_group_medops_set_file(
414 data
, index_entry
, data
->self_msg_iter
, data
->log_level
);
415 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
419 data
->next_index_entry_index
++;
421 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
427 void ctf_fs_ds_group_medops_data_destroy(
428 struct ctf_fs_ds_group_medops_data
*data
)
434 ctf_fs_ds_file_destroy(data
->file
);
442 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_data_create(
443 struct ctf_fs_ds_file_group
*ds_file_group
,
444 bt_self_message_iterator
*self_msg_iter
,
445 bt_logging_level log_level
,
446 struct ctf_fs_ds_group_medops_data
**out
)
448 struct ctf_fs_ds_group_medops_data
*data
;
449 enum ctf_msg_iter_medium_status status
;
451 BT_ASSERT(self_msg_iter
);
452 BT_ASSERT(ds_file_group
);
453 BT_ASSERT(ds_file_group
->index
);
454 BT_ASSERT(ds_file_group
->index
->entries
->len
> 0);
456 data
= g_new0(struct ctf_fs_ds_group_medops_data
, 1);
458 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
,
459 "Failed to allocate a struct ctf_fs_ds_group_medops_data");
460 status
= CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
;
464 data
->ds_file_group
= ds_file_group
;
465 data
->self_msg_iter
= self_msg_iter
;
466 data
->log_level
= log_level
;
469 * No need to prepare the first file. ctf_msg_iter will call
470 * switch_packet before reading the first packet, it will be
475 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
479 ctf_fs_ds_group_medops_data_destroy(data
);
485 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data
*data
)
487 data
->next_index_entry_index
= 0;
490 struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops
= {
491 .request_bytes
= medop_group_request_bytes
,
494 * We don't support seeking using this medops. It would probably be
495 * possible, but it's not needed at the moment.
499 .switch_packet
= medop_group_switch_packet
,
500 .borrow_stream
= medop_group_borrow_stream
,
504 struct ctf_fs_ds_index_entry
*ctf_fs_ds_index_entry_create(
505 bt_self_component
*self_comp
, bt_logging_level log_level
)
507 struct ctf_fs_ds_index_entry
*entry
;
509 entry
= g_new0(struct ctf_fs_ds_index_entry
, 1);
511 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to allocate a ctf_fs_ds_index_entry.");
515 entry
->packet_seq_num
= UINT64_MAX
;
522 int convert_cycles_to_ns(struct ctf_clock_class
*clock_class
,
523 uint64_t cycles
, int64_t *ns
)
525 return bt_util_clock_cycles_to_ns_from_origin(cycles
,
526 clock_class
->frequency
, clock_class
->offset_seconds
,
527 clock_class
->offset_cycles
, ns
);
531 struct ctf_fs_ds_index
*build_index_from_idx_file(
532 struct ctf_fs_ds_file
*ds_file
,
533 struct ctf_fs_ds_file_info
*file_info
,
534 struct ctf_msg_iter
*msg_iter
)
537 gchar
*directory
= NULL
;
538 gchar
*basename
= NULL
;
539 GString
*index_basename
= NULL
;
540 gchar
*index_file_path
= NULL
;
541 GMappedFile
*mapped_file
= NULL
;
543 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
544 const struct ctf_packet_index_file_hdr
*header
= NULL
;
545 struct ctf_fs_ds_index
*index
= NULL
;
546 struct ctf_fs_ds_index_entry
*index_entry
= NULL
, *prev_index_entry
= NULL
;
547 uint64_t total_packets_size
= 0;
548 size_t file_index_entry_size
;
549 size_t file_entry_count
;
551 struct ctf_stream_class
*sc
;
552 struct ctf_msg_iter_packet_properties props
;
553 uint32_t version_major
, version_minor
;
554 bt_self_component
*self_comp
= ds_file
->self_comp
;
555 bt_logging_level log_level
= ds_file
->log_level
;
557 BT_COMP_LOGI("Building index from .idx file of stream file %s",
558 ds_file
->file
->path
->str
);
559 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
561 BT_COMP_LOGI_STR("Cannot read first packet's header and context fields.");
565 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
566 props
.stream_class_id
);
568 if (!sc
->default_clock_class
) {
569 BT_COMP_LOGI_STR("Cannot find stream class's default clock class.");
573 /* Look for index file in relative path index/name.idx. */
574 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
576 BT_COMP_LOGE("Cannot get the basename of datastream file %s",
577 ds_file
->file
->path
->str
);
581 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
583 BT_COMP_LOGE("Cannot get dirname of datastream file %s",
584 ds_file
->file
->path
->str
);
588 index_basename
= g_string_new(basename
);
589 if (!index_basename
) {
590 BT_COMP_LOGE_STR("Cannot allocate index file basename string");
594 g_string_append(index_basename
, ".idx");
595 index_file_path
= g_build_filename(directory
, "index",
596 index_basename
->str
, NULL
);
597 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
599 BT_COMP_LOGD("Cannot create new mapped file %s",
605 * The g_mapped_file API limits us to 4GB files on 32-bit.
606 * Traces with such large indexes have never been seen in the wild,
607 * but this would need to be adjusted to support them.
609 filesize
= g_mapped_file_get_length(mapped_file
);
610 if (filesize
< sizeof(*header
)) {
611 BT_COMP_LOGW("Invalid LTTng trace index file: "
612 "file size (%zu bytes) < header size (%zu bytes)",
613 filesize
, sizeof(*header
));
617 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
618 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
620 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
621 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
622 BT_COMP_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
626 version_major
= be32toh(header
->index_major
);
627 version_minor
= be32toh(header
->index_minor
);
628 if (version_major
!= 1) {
630 "Unknown LTTng trace index version: "
631 "major=%" PRIu32
", minor=%" PRIu32
,
632 version_major
, version_minor
);
636 file_index_entry_size
= be32toh(header
->packet_index_len
);
637 if (file_index_entry_size
< CTF_INDEX_1_0_SIZE
) {
638 BT_COMP_LOGW("Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): "
639 "packet_index_len=%zu, CTF_INDEX_1_0_SIZE=%zu",
640 file_index_entry_size
, CTF_INDEX_1_0_SIZE
);
644 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
645 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
646 BT_COMP_LOGW("Invalid LTTng trace index: the index's size after the header "
647 "(%zu bytes) is not a multiple of the index entry size "
648 "(%zu bytes)", (filesize
- sizeof(*header
)),
653 index
= ctf_fs_ds_index_create(ds_file
->log_level
, ds_file
->self_comp
);
658 for (i
= 0; i
< file_entry_count
; i
++) {
659 struct ctf_packet_index
*file_index
=
660 (struct ctf_packet_index
*) file_pos
;
661 uint64_t packet_size
= be64toh(file_index
->packet_size
);
663 if (packet_size
% CHAR_BIT
) {
664 BT_COMP_LOGW("Invalid packet size encountered in LTTng trace index file");
668 index_entry
= ctf_fs_ds_index_entry_create(
669 ds_file
->self_comp
, ds_file
->log_level
);
671 BT_COMP_LOGE_APPEND_CAUSE(ds_file
->self_comp
,
672 "Failed to create a ctf_fs_ds_index_entry.");
676 /* Set path to stream file. */
677 index_entry
->path
= file_info
->path
->str
;
679 /* Convert size in bits to bytes. */
680 packet_size
/= CHAR_BIT
;
681 index_entry
->packet_size
= packet_size
;
683 index_entry
->offset
= be64toh(file_index
->offset
);
684 if (i
!= 0 && index_entry
->offset
< prev_index_entry
->offset
) {
685 BT_COMP_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
686 "previous offset=%" PRIu64
", current offset=%" PRIu64
,
687 prev_index_entry
->offset
, index_entry
->offset
);
691 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
692 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
693 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
694 BT_COMP_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
695 "timestamp_begin=%" PRIu64
"timestamp_end=%" PRIu64
,
696 index_entry
->timestamp_begin
,
697 index_entry
->timestamp_end
);
701 /* Convert the packet's bound to nanoseconds since Epoch. */
702 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
703 index_entry
->timestamp_begin
,
704 &index_entry
->timestamp_begin_ns
);
706 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
709 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
710 index_entry
->timestamp_end
,
711 &index_entry
->timestamp_end_ns
);
713 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
717 if (version_minor
>= 1) {
718 index_entry
->packet_seq_num
= be64toh(file_index
->packet_seq_num
);
721 total_packets_size
+= packet_size
;
722 file_pos
+= file_index_entry_size
;
724 prev_index_entry
= index_entry
;
726 /* Give ownership of `index_entry` to `index->entries`. */
727 g_ptr_array_add(index
->entries
, index_entry
);
731 /* Validate that the index addresses the complete stream. */
732 if (ds_file
->file
->size
!= total_packets_size
) {
733 BT_COMP_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
734 "file-size=%" PRIu64
", total-packets-size=%" PRIu64
,
735 ds_file
->file
->size
, total_packets_size
);
741 g_free(index_file_path
);
742 if (index_basename
) {
743 g_string_free(index_basename
, TRUE
);
746 g_mapped_file_unref(mapped_file
);
750 ctf_fs_ds_index_destroy(index
);
757 int init_index_entry(struct ctf_fs_ds_index_entry
*entry
,
758 struct ctf_fs_ds_file
*ds_file
,
759 struct ctf_msg_iter_packet_properties
*props
,
760 off_t packet_size
, off_t packet_offset
)
763 struct ctf_stream_class
*sc
;
764 bt_self_component
*self_comp
= ds_file
->self_comp
;
765 bt_logging_level log_level
= ds_file
->log_level
;
767 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
768 props
->stream_class_id
);
770 BT_ASSERT(packet_offset
>= 0);
771 entry
->offset
= packet_offset
;
772 BT_ASSERT(packet_size
>= 0);
773 entry
->packet_size
= packet_size
;
775 if (props
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
776 entry
->timestamp_begin
= props
->snapshots
.beginning_clock
;
778 /* Convert the packet's bound to nanoseconds since Epoch. */
779 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
780 props
->snapshots
.beginning_clock
,
781 &entry
->timestamp_begin_ns
);
783 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
787 entry
->timestamp_begin
= UINT64_C(-1);
788 entry
->timestamp_begin_ns
= UINT64_C(-1);
791 if (props
->snapshots
.end_clock
!= UINT64_C(-1)) {
792 entry
->timestamp_end
= props
->snapshots
.end_clock
;
794 /* Convert the packet's bound to nanoseconds since Epoch. */
795 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
796 props
->snapshots
.end_clock
,
797 &entry
->timestamp_end_ns
);
799 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
803 entry
->timestamp_end
= UINT64_C(-1);
804 entry
->timestamp_end_ns
= UINT64_C(-1);
812 struct ctf_fs_ds_index
*build_index_from_stream_file(
813 struct ctf_fs_ds_file
*ds_file
,
814 struct ctf_fs_ds_file_info
*file_info
,
815 struct ctf_msg_iter
*msg_iter
)
818 struct ctf_fs_ds_index
*index
= NULL
;
819 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
820 off_t current_packet_offset_bytes
= 0;
821 bt_self_component
*self_comp
= ds_file
->self_comp
;
822 bt_logging_level log_level
= ds_file
->log_level
;
824 BT_COMP_LOGI("Indexing stream file %s", ds_file
->file
->path
->str
);
826 index
= ctf_fs_ds_index_create(ds_file
->log_level
, ds_file
->self_comp
);
832 off_t current_packet_size_bytes
;
833 struct ctf_fs_ds_index_entry
*index_entry
;
834 struct ctf_msg_iter_packet_properties props
;
836 if (current_packet_offset_bytes
< 0) {
837 BT_COMP_LOGE_STR("Cannot get the current packet's offset.");
839 } else if (current_packet_offset_bytes
> ds_file
->file
->size
) {
840 BT_COMP_LOGE_STR("Unexpected current packet's offset (larger than file).");
842 } else if (current_packet_offset_bytes
== ds_file
->file
->size
) {
847 iter_status
= ctf_msg_iter_seek(msg_iter
,
848 current_packet_offset_bytes
);
849 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
853 iter_status
= ctf_msg_iter_get_packet_properties(
855 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
859 if (props
.exp_packet_total_size
>= 0) {
860 current_packet_size_bytes
=
861 (uint64_t) props
.exp_packet_total_size
/ 8;
863 current_packet_size_bytes
= ds_file
->file
->size
;
866 if (current_packet_offset_bytes
+ current_packet_size_bytes
>
867 ds_file
->file
->size
) {
868 BT_COMP_LOGW("Invalid packet size reported in file: stream=\"%s\", "
869 "packet-offset=%jd, packet-size-bytes=%jd, "
871 ds_file
->file
->path
->str
,
872 (intmax_t) current_packet_offset_bytes
,
873 (intmax_t) current_packet_size_bytes
,
874 (intmax_t) ds_file
->file
->size
);
878 index_entry
= ctf_fs_ds_index_entry_create(
879 ds_file
->self_comp
, ds_file
->log_level
);
881 BT_COMP_LOGE_APPEND_CAUSE(ds_file
->self_comp
,
882 "Failed to create a ctf_fs_ds_index_entry.");
886 /* Set path to stream file. */
887 index_entry
->path
= file_info
->path
->str
;
889 ret
= init_index_entry(index_entry
, ds_file
, &props
,
890 current_packet_size_bytes
, current_packet_offset_bytes
);
896 g_ptr_array_add(index
->entries
, index_entry
);
898 current_packet_offset_bytes
+= current_packet_size_bytes
;
899 BT_COMP_LOGD("Seeking to next packet: current-packet-offset=%jd, "
900 "next-packet-offset=%jd",
901 (intmax_t) (current_packet_offset_bytes
- current_packet_size_bytes
),
902 (intmax_t) current_packet_offset_bytes
);
909 ctf_fs_ds_index_destroy(index
);
915 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
916 struct ctf_fs_trace
*ctf_fs_trace
,
917 bt_self_message_iterator
*self_msg_iter
,
918 bt_stream
*stream
, const char *path
,
919 bt_logging_level log_level
)
922 const size_t offset_align
= bt_mmap_get_offset_align_size(log_level
);
923 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
929 ds_file
->log_level
= log_level
;
930 ds_file
->self_comp
= ctf_fs_trace
->self_comp
;
931 ds_file
->self_msg_iter
= self_msg_iter
;
932 ds_file
->file
= ctf_fs_file_create(log_level
, ds_file
->self_comp
);
933 if (!ds_file
->file
) {
937 ds_file
->stream
= stream
;
938 bt_stream_get_ref(ds_file
->stream
);
939 ds_file
->metadata
= ctf_fs_trace
->metadata
;
940 g_string_assign(ds_file
->file
->path
, path
);
941 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
946 ds_file
->mmap_max_len
= offset_align
* 2048;
951 /* Do not touch "borrowed" file. */
952 ctf_fs_ds_file_destroy(ds_file
);
960 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
961 struct ctf_fs_ds_file
*ds_file
,
962 struct ctf_fs_ds_file_info
*file_info
,
963 struct ctf_msg_iter
*msg_iter
)
965 struct ctf_fs_ds_index
*index
;
966 bt_self_component
*self_comp
= ds_file
->self_comp
;
967 bt_logging_level log_level
= ds_file
->log_level
;
969 index
= build_index_from_idx_file(ds_file
, file_info
, msg_iter
);
974 BT_COMP_LOGI("Failed to build index from .index file; "
975 "falling back to stream indexing.");
976 index
= build_index_from_stream_file(ds_file
, file_info
, msg_iter
);
982 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(bt_logging_level log_level
,
983 bt_self_component
*self_comp
)
985 struct ctf_fs_ds_index
*index
= g_new0(struct ctf_fs_ds_index
, 1);
988 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
989 "Failed to allocate index");
993 index
->entries
= g_ptr_array_new_with_free_func((GDestroyNotify
) g_free
);
994 if (!index
->entries
) {
995 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
996 "Failed to allocate index entries.");
1003 ctf_fs_ds_index_destroy(index
);
1010 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
1016 bt_stream_put_ref(ds_file
->stream
);
1017 (void) ds_file_munmap(ds_file
);
1019 if (ds_file
->file
) {
1020 ctf_fs_file_destroy(ds_file
->file
);
1027 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
1033 if (index
->entries
) {
1034 g_ptr_array_free(index
->entries
, TRUE
);