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"
26 #include "../common/msg-iter/msg-iter.h"
27 #include "common/assert.h"
28 #include "data-stream-file.h"
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
= 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
= 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
= 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
= {
285 .request_bytes
= medop_request_bytes
,
286 .borrow_stream
= medop_borrow_stream
,
290 struct ctf_fs_ds_group_medops_data
{
291 /* Weak, set once at creation time. */
292 struct ctf_fs_ds_file_group
*ds_file_group
;
295 * Index (as in element rank) of the index entry of ds_file_groups'
296 * index we will read next (so, the one after the one we are reading
299 guint next_index_entry_index
;
302 * File we are currently reading. Changes whenever we switch to
303 * reading another data file.
307 struct ctf_fs_ds_file
*file
;
309 /* Weak, for context / logging / appending causes. */
310 bt_self_message_iterator
*self_msg_iter
;
311 bt_logging_level log_level
;
315 enum ctf_msg_iter_medium_status
medop_group_request_bytes(
317 uint8_t **buffer_addr
,
321 struct ctf_fs_ds_group_medops_data
*data
= void_data
;
323 /* Return bytes from the current file. */
324 return medop_request_bytes(request_sz
, buffer_addr
, buffer_sz
, data
->file
);
328 bt_stream
*medop_group_borrow_stream(
329 bt_stream_class
*stream_class
,
333 struct ctf_fs_ds_group_medops_data
*data
= void_data
;
335 return medop_borrow_stream(stream_class
, stream_id
, data
->file
);
339 * Set `data->file` to prepare it to read the packet described
344 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_set_file(
345 struct ctf_fs_ds_group_medops_data
*data
,
346 struct ctf_fs_ds_index_entry
*index_entry
,
347 bt_self_message_iterator
*self_msg_iter
,
348 bt_logging_level log_level
)
350 enum ctf_msg_iter_medium_status status
;
353 BT_ASSERT(index_entry
);
355 /* Check if that file is already the one mapped. */
356 if (!data
->file
|| strcmp(index_entry
->path
, data
->file
->file
->path
->str
) != 0) {
357 /* Destroy the previously used file. */
358 ctf_fs_ds_file_destroy(data
->file
);
360 /* Create the new file. */
361 data
->file
= ctf_fs_ds_file_create(
362 data
->ds_file_group
->ctf_fs_trace
,
364 data
->ds_file_group
->stream
,
368 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
,
369 "failed to create ctf_fs_ds_file.");
370 status
= CTF_MSG_ITER_MEDIUM_STATUS_ERROR
;
376 * Ensure the right portion of the file will be returned on the next
377 * request_bytes call.
379 status
= ds_file_mmap(data
->file
, index_entry
->offset
);
380 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
384 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
391 enum ctf_msg_iter_medium_status
medop_group_switch_packet(void *void_data
)
393 struct ctf_fs_ds_group_medops_data
*data
= void_data
;
394 struct ctf_fs_ds_index_entry
*index_entry
;
395 enum ctf_msg_iter_medium_status status
;
397 /* If we have gone through all index entries, we are done. */
398 if (data
->next_index_entry_index
>=
399 data
->ds_file_group
->index
->entries
->len
) {
400 status
= CTF_MSG_ITER_MEDIUM_STATUS_EOF
;
405 * Otherwise, look up the next index entry / packet and prepare it
408 index_entry
= g_ptr_array_index(
409 data
->ds_file_group
->index
->entries
,
410 data
->next_index_entry_index
);
412 status
= ctf_fs_ds_group_medops_set_file(
413 data
, index_entry
, data
->self_msg_iter
, data
->log_level
);
414 if (status
!= CTF_MSG_ITER_MEDIUM_STATUS_OK
) {
418 data
->next_index_entry_index
++;
420 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
426 void ctf_fs_ds_group_medops_data_destroy(
427 struct ctf_fs_ds_group_medops_data
*data
)
433 ctf_fs_ds_file_destroy(data
->file
);
441 enum ctf_msg_iter_medium_status
ctf_fs_ds_group_medops_data_create(
442 struct ctf_fs_ds_file_group
*ds_file_group
,
443 bt_self_message_iterator
*self_msg_iter
,
444 bt_logging_level log_level
,
445 struct ctf_fs_ds_group_medops_data
**out
)
447 struct ctf_fs_ds_group_medops_data
*data
;
448 enum ctf_msg_iter_medium_status status
;
450 BT_ASSERT(self_msg_iter
);
451 BT_ASSERT(ds_file_group
);
452 BT_ASSERT(ds_file_group
->index
);
453 BT_ASSERT(ds_file_group
->index
->entries
->len
> 0);
455 data
= g_new0(struct ctf_fs_ds_group_medops_data
, 1);
457 BT_MSG_ITER_LOGE_APPEND_CAUSE(self_msg_iter
,
458 "Failed to allocate a struct ctf_fs_ds_group_medops_data");
459 status
= CTF_MSG_ITER_MEDIUM_STATUS_MEMORY_ERROR
;
463 data
->ds_file_group
= ds_file_group
;
464 data
->self_msg_iter
= self_msg_iter
;
465 data
->log_level
= log_level
;
468 * No need to prepare the first file. ctf_msg_iter will call
469 * switch_packet before reading the first packet, it will be
474 status
= CTF_MSG_ITER_MEDIUM_STATUS_OK
;
478 ctf_fs_ds_group_medops_data_destroy(data
);
484 void ctf_fs_ds_group_medops_data_reset(struct ctf_fs_ds_group_medops_data
*data
)
486 data
->next_index_entry_index
= 0;
489 struct ctf_msg_iter_medium_ops ctf_fs_ds_group_medops
= {
490 .request_bytes
= medop_group_request_bytes
,
491 .borrow_stream
= medop_group_borrow_stream
,
492 .switch_packet
= medop_group_switch_packet
,
495 * We don't support seeking using this medops. It would probably be
496 * possible, but it's not needed at the moment.
502 struct ctf_fs_ds_index_entry
*ctf_fs_ds_index_entry_create(
503 bt_self_component
*self_comp
, bt_logging_level log_level
)
505 struct ctf_fs_ds_index_entry
*entry
;
507 entry
= g_new0(struct ctf_fs_ds_index_entry
, 1);
509 BT_COMP_LOGE_APPEND_CAUSE(self_comp
, "Failed to allocate a ctf_fs_ds_index_entry.");
513 entry
->packet_seq_num
= UINT64_MAX
;
520 int convert_cycles_to_ns(struct ctf_clock_class
*clock_class
,
521 uint64_t cycles
, int64_t *ns
)
523 return bt_util_clock_cycles_to_ns_from_origin(cycles
,
524 clock_class
->frequency
, clock_class
->offset_seconds
,
525 clock_class
->offset_cycles
, ns
);
529 struct ctf_fs_ds_index
*build_index_from_idx_file(
530 struct ctf_fs_ds_file
*ds_file
,
531 struct ctf_fs_ds_file_info
*file_info
,
532 struct ctf_msg_iter
*msg_iter
)
535 gchar
*directory
= NULL
;
536 gchar
*basename
= NULL
;
537 GString
*index_basename
= NULL
;
538 gchar
*index_file_path
= NULL
;
539 GMappedFile
*mapped_file
= NULL
;
541 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
542 const struct ctf_packet_index_file_hdr
*header
= NULL
;
543 struct ctf_fs_ds_index
*index
= NULL
;
544 struct ctf_fs_ds_index_entry
*index_entry
= NULL
, *prev_index_entry
= NULL
;
545 uint64_t total_packets_size
= 0;
546 size_t file_index_entry_size
;
547 size_t file_entry_count
;
549 struct ctf_stream_class
*sc
;
550 struct ctf_msg_iter_packet_properties props
;
551 uint32_t version_major
, version_minor
;
552 bt_self_component
*self_comp
= ds_file
->self_comp
;
553 bt_logging_level log_level
= ds_file
->log_level
;
555 BT_COMP_LOGI("Building index from .idx file of stream file %s",
556 ds_file
->file
->path
->str
);
557 ret
= ctf_msg_iter_get_packet_properties(msg_iter
, &props
);
559 BT_COMP_LOGI_STR("Cannot read first packet's header and context fields.");
563 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
564 props
.stream_class_id
);
566 if (!sc
->default_clock_class
) {
567 BT_COMP_LOGI_STR("Cannot find stream class's default clock class.");
571 /* Look for index file in relative path index/name.idx. */
572 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
574 BT_COMP_LOGE("Cannot get the basename of datastream file %s",
575 ds_file
->file
->path
->str
);
579 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
581 BT_COMP_LOGE("Cannot get dirname of datastream file %s",
582 ds_file
->file
->path
->str
);
586 index_basename
= g_string_new(basename
);
587 if (!index_basename
) {
588 BT_COMP_LOGE_STR("Cannot allocate index file basename string");
592 g_string_append(index_basename
, ".idx");
593 index_file_path
= g_build_filename(directory
, "index",
594 index_basename
->str
, NULL
);
595 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
597 BT_COMP_LOGD("Cannot create new mapped file %s",
603 * The g_mapped_file API limits us to 4GB files on 32-bit.
604 * Traces with such large indexes have never been seen in the wild,
605 * but this would need to be adjusted to support them.
607 filesize
= g_mapped_file_get_length(mapped_file
);
608 if (filesize
< sizeof(*header
)) {
609 BT_COMP_LOGW("Invalid LTTng trace index file: "
610 "file size (%zu bytes) < header size (%zu bytes)",
611 filesize
, sizeof(*header
));
615 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
616 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
618 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
619 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
620 BT_COMP_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
624 version_major
= be32toh(header
->index_major
);
625 version_minor
= be32toh(header
->index_minor
);
626 if (version_major
!= 1) {
628 "Unknown LTTng trace index version: "
629 "major=%" PRIu32
", minor=%" PRIu32
,
630 version_major
, version_minor
);
634 file_index_entry_size
= be32toh(header
->packet_index_len
);
635 if (file_index_entry_size
< CTF_INDEX_1_0_SIZE
) {
636 BT_COMP_LOGW("Invalid `packet_index_len` in LTTng trace index file (`packet_index_len` < CTF index 1.0 index entry size): "
637 "packet_index_len=%zu, CTF_INDEX_1_0_SIZE=%zu",
638 file_index_entry_size
, CTF_INDEX_1_0_SIZE
);
642 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
643 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
644 BT_COMP_LOGW("Invalid LTTng trace index: the index's size after the header "
645 "(%zu bytes) is not a multiple of the index entry size "
646 "(%zu bytes)", (filesize
- sizeof(*header
)),
651 index
= ctf_fs_ds_index_create(ds_file
->log_level
, ds_file
->self_comp
);
656 for (i
= 0; i
< file_entry_count
; i
++) {
657 struct ctf_packet_index
*file_index
=
658 (struct ctf_packet_index
*) file_pos
;
659 uint64_t packet_size
= be64toh(file_index
->packet_size
);
661 if (packet_size
% CHAR_BIT
) {
662 BT_COMP_LOGW("Invalid packet size encountered in LTTng trace index file");
666 index_entry
= ctf_fs_ds_index_entry_create(
667 ds_file
->self_comp
, ds_file
->log_level
);
669 BT_COMP_LOGE_APPEND_CAUSE(ds_file
->self_comp
,
670 "Failed to create a ctf_fs_ds_index_entry.");
674 /* Set path to stream file. */
675 index_entry
->path
= file_info
->path
->str
;
677 /* Convert size in bits to bytes. */
678 packet_size
/= CHAR_BIT
;
679 index_entry
->packet_size
= packet_size
;
681 index_entry
->offset
= be64toh(file_index
->offset
);
682 if (i
!= 0 && index_entry
->offset
< prev_index_entry
->offset
) {
683 BT_COMP_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
684 "previous offset=%" PRIu64
", current offset=%" PRIu64
,
685 prev_index_entry
->offset
, index_entry
->offset
);
689 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
690 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
691 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
692 BT_COMP_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
693 "timestamp_begin=%" PRIu64
"timestamp_end=%" PRIu64
,
694 index_entry
->timestamp_begin
,
695 index_entry
->timestamp_end
);
699 /* Convert the packet's bound to nanoseconds since Epoch. */
700 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
701 index_entry
->timestamp_begin
,
702 &index_entry
->timestamp_begin_ns
);
704 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
707 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
708 index_entry
->timestamp_end
,
709 &index_entry
->timestamp_end_ns
);
711 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
715 if (version_minor
>= 1) {
716 index_entry
->packet_seq_num
= be64toh(file_index
->packet_seq_num
);
719 total_packets_size
+= packet_size
;
720 file_pos
+= file_index_entry_size
;
722 prev_index_entry
= index_entry
;
724 /* Give ownership of `index_entry` to `index->entries`. */
725 g_ptr_array_add(index
->entries
, index_entry
);
729 /* Validate that the index addresses the complete stream. */
730 if (ds_file
->file
->size
!= total_packets_size
) {
731 BT_COMP_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
732 "file-size=%" PRIu64
", total-packets-size=%" PRIu64
,
733 ds_file
->file
->size
, total_packets_size
);
739 g_free(index_file_path
);
740 if (index_basename
) {
741 g_string_free(index_basename
, TRUE
);
744 g_mapped_file_unref(mapped_file
);
748 ctf_fs_ds_index_destroy(index
);
755 int init_index_entry(struct ctf_fs_ds_index_entry
*entry
,
756 struct ctf_fs_ds_file
*ds_file
,
757 struct ctf_msg_iter_packet_properties
*props
,
758 off_t packet_size
, off_t packet_offset
)
761 struct ctf_stream_class
*sc
;
762 bt_self_component
*self_comp
= ds_file
->self_comp
;
763 bt_logging_level log_level
= ds_file
->log_level
;
765 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
766 props
->stream_class_id
);
768 BT_ASSERT(packet_offset
>= 0);
769 entry
->offset
= packet_offset
;
770 BT_ASSERT(packet_size
>= 0);
771 entry
->packet_size
= packet_size
;
773 if (props
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
774 entry
->timestamp_begin
= props
->snapshots
.beginning_clock
;
776 /* Convert the packet's bound to nanoseconds since Epoch. */
777 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
778 props
->snapshots
.beginning_clock
,
779 &entry
->timestamp_begin_ns
);
781 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
785 entry
->timestamp_begin
= UINT64_C(-1);
786 entry
->timestamp_begin_ns
= UINT64_C(-1);
789 if (props
->snapshots
.end_clock
!= UINT64_C(-1)) {
790 entry
->timestamp_end
= props
->snapshots
.end_clock
;
792 /* Convert the packet's bound to nanoseconds since Epoch. */
793 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
794 props
->snapshots
.end_clock
,
795 &entry
->timestamp_end_ns
);
797 BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
801 entry
->timestamp_end
= UINT64_C(-1);
802 entry
->timestamp_end_ns
= UINT64_C(-1);
810 struct ctf_fs_ds_index
*build_index_from_stream_file(
811 struct ctf_fs_ds_file
*ds_file
,
812 struct ctf_fs_ds_file_info
*file_info
,
813 struct ctf_msg_iter
*msg_iter
)
816 struct ctf_fs_ds_index
*index
= NULL
;
817 enum ctf_msg_iter_status iter_status
= CTF_MSG_ITER_STATUS_OK
;
818 off_t current_packet_offset_bytes
= 0;
819 bt_self_component
*self_comp
= ds_file
->self_comp
;
820 bt_logging_level log_level
= ds_file
->log_level
;
822 BT_COMP_LOGI("Indexing stream file %s", ds_file
->file
->path
->str
);
824 index
= ctf_fs_ds_index_create(ds_file
->log_level
, ds_file
->self_comp
);
830 off_t current_packet_size_bytes
;
831 struct ctf_fs_ds_index_entry
*index_entry
;
832 struct ctf_msg_iter_packet_properties props
;
834 if (current_packet_offset_bytes
< 0) {
835 BT_COMP_LOGE_STR("Cannot get the current packet's offset.");
837 } else if (current_packet_offset_bytes
> ds_file
->file
->size
) {
838 BT_COMP_LOGE_STR("Unexpected current packet's offset (larger than file).");
840 } else if (current_packet_offset_bytes
== ds_file
->file
->size
) {
845 iter_status
= ctf_msg_iter_seek(msg_iter
,
846 current_packet_offset_bytes
);
847 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
851 iter_status
= ctf_msg_iter_get_packet_properties(
853 if (iter_status
!= CTF_MSG_ITER_STATUS_OK
) {
857 if (props
.exp_packet_total_size
>= 0) {
858 current_packet_size_bytes
=
859 (uint64_t) props
.exp_packet_total_size
/ 8;
861 current_packet_size_bytes
= ds_file
->file
->size
;
864 if (current_packet_offset_bytes
+ current_packet_size_bytes
>
865 ds_file
->file
->size
) {
866 BT_COMP_LOGW("Invalid packet size reported in file: stream=\"%s\", "
867 "packet-offset=%jd, packet-size-bytes=%jd, "
869 ds_file
->file
->path
->str
,
870 (intmax_t) current_packet_offset_bytes
,
871 (intmax_t) current_packet_size_bytes
,
872 (intmax_t) ds_file
->file
->size
);
876 index_entry
= ctf_fs_ds_index_entry_create(
877 ds_file
->self_comp
, ds_file
->log_level
);
879 BT_COMP_LOGE_APPEND_CAUSE(ds_file
->self_comp
,
880 "Failed to create a ctf_fs_ds_index_entry.");
884 /* Set path to stream file. */
885 index_entry
->path
= file_info
->path
->str
;
887 ret
= init_index_entry(index_entry
, ds_file
, &props
,
888 current_packet_size_bytes
, current_packet_offset_bytes
);
894 g_ptr_array_add(index
->entries
, index_entry
);
896 current_packet_offset_bytes
+= current_packet_size_bytes
;
897 BT_COMP_LOGD("Seeking to next packet: current-packet-offset=%jd, "
898 "next-packet-offset=%jd",
899 (intmax_t) (current_packet_offset_bytes
- current_packet_size_bytes
),
900 (intmax_t) current_packet_offset_bytes
);
907 ctf_fs_ds_index_destroy(index
);
913 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
914 struct ctf_fs_trace
*ctf_fs_trace
,
915 bt_self_message_iterator
*self_msg_iter
,
916 bt_stream
*stream
, const char *path
,
917 bt_logging_level log_level
)
920 const size_t offset_align
= bt_mmap_get_offset_align_size(log_level
);
921 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
927 ds_file
->log_level
= log_level
;
928 ds_file
->self_comp
= ctf_fs_trace
->self_comp
;
929 ds_file
->self_msg_iter
= self_msg_iter
;
930 ds_file
->file
= ctf_fs_file_create(log_level
, ds_file
->self_comp
);
931 if (!ds_file
->file
) {
935 ds_file
->stream
= stream
;
936 bt_stream_get_ref(ds_file
->stream
);
937 ds_file
->metadata
= ctf_fs_trace
->metadata
;
938 g_string_assign(ds_file
->file
->path
, path
);
939 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
944 ds_file
->mmap_max_len
= offset_align
* 2048;
949 /* Do not touch "borrowed" file. */
950 ctf_fs_ds_file_destroy(ds_file
);
958 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
959 struct ctf_fs_ds_file
*ds_file
,
960 struct ctf_fs_ds_file_info
*file_info
,
961 struct ctf_msg_iter
*msg_iter
)
963 struct ctf_fs_ds_index
*index
;
964 bt_self_component
*self_comp
= ds_file
->self_comp
;
965 bt_logging_level log_level
= ds_file
->log_level
;
967 index
= build_index_from_idx_file(ds_file
, file_info
, msg_iter
);
972 BT_COMP_LOGI("Failed to build index from .index file; "
973 "falling back to stream indexing.");
974 index
= build_index_from_stream_file(ds_file
, file_info
, msg_iter
);
980 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(bt_logging_level log_level
,
981 bt_self_component
*self_comp
)
983 struct ctf_fs_ds_index
*index
= g_new0(struct ctf_fs_ds_index
, 1);
986 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
987 "Failed to allocate index");
991 index
->entries
= g_ptr_array_new_with_free_func((GDestroyNotify
) g_free
);
992 if (!index
->entries
) {
993 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, log_level
, self_comp
,
994 "Failed to allocate index entries.");
1001 ctf_fs_ds_index_destroy(index
);
1008 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
1014 bt_stream_put_ref(ds_file
->stream
);
1015 (void) ds_file_munmap(ds_file
);
1017 if (ds_file
->file
) {
1018 ctf_fs_file_destroy(ds_file
->file
);
1025 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
1031 if (index
->entries
) {
1032 g_ptr_array_free(index
->entries
, TRUE
);