2 * Copyright 2016-2017 - Philippe Proulx <pproulx@efficios.com>
3 * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 #define BT_LOG_OUTPUT_LEVEL (ds_file->log_level)
26 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/DS"
27 #include "logging/log.h"
36 #include "compat/mman.h"
37 #include "compat/endian.h"
38 #include <babeltrace2/babeltrace.h>
39 #include "common/common.h"
42 #include "../common/msg-iter/msg-iter.h"
43 #include "common/assert.h"
44 #include "data-stream-file.h"
48 size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
50 return ds_file
->mmap_len
- ds_file
->request_offset
;
54 int ds_file_munmap(struct ctf_fs_ds_file
*ds_file
)
58 if (!ds_file
|| !ds_file
->mmap_addr
) {
62 if (bt_munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
63 BT_LOGE_ERRNO("Cannot memory-unmap file",
64 ": address=%p, size=%zu, file_path=\"%s\", file=%p",
65 ds_file
->mmap_addr
, ds_file
->mmap_len
,
66 ds_file
->file
? ds_file
->file
->path
->str
: "NULL",
67 ds_file
->file
? ds_file
->file
->fp
: NULL
);
72 ds_file
->mmap_addr
= NULL
;
79 enum bt_msg_iter_medium_status
ds_file_mmap_next(
80 struct ctf_fs_ds_file
*ds_file
)
82 enum bt_msg_iter_medium_status ret
=
83 BT_MSG_ITER_MEDIUM_STATUS_OK
;
85 /* Unmap old region */
86 if (ds_file
->mmap_addr
) {
87 if (ds_file_munmap(ds_file
)) {
92 * mmap_len is guaranteed to be page-aligned except on the
93 * last mapping where it may not be possible (since the file's
94 * size itself may not be a page multiple).
96 ds_file
->mmap_offset
+= ds_file
->mmap_len
;
97 ds_file
->request_offset
= 0;
100 ds_file
->mmap_len
= MIN(ds_file
->file
->size
- ds_file
->mmap_offset
,
101 ds_file
->mmap_max_len
);
102 if (ds_file
->mmap_len
== 0) {
103 ret
= BT_MSG_ITER_MEDIUM_STATUS_EOF
;
107 BT_ASSERT(ds_file
->mmap_len
);
108 ds_file
->mmap_addr
= bt_mmap((void *) 0, ds_file
->mmap_len
,
109 PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
110 ds_file
->mmap_offset
);
111 if (ds_file
->mmap_addr
== MAP_FAILED
) {
112 BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
113 ds_file
->mmap_len
, ds_file
->file
->path
->str
,
114 ds_file
->file
->fp
, (intmax_t) ds_file
->mmap_offset
,
121 ds_file_munmap(ds_file
);
122 ret
= BT_MSG_ITER_MEDIUM_STATUS_ERROR
;
128 enum bt_msg_iter_medium_status
medop_request_bytes(
129 size_t request_sz
, uint8_t **buffer_addr
,
130 size_t *buffer_sz
, void *data
)
132 enum bt_msg_iter_medium_status status
=
133 BT_MSG_ITER_MEDIUM_STATUS_OK
;
134 struct ctf_fs_ds_file
*ds_file
= data
;
136 if (request_sz
== 0) {
140 /* Check if we have at least one memory-mapped byte left */
141 if (remaining_mmap_bytes(ds_file
) == 0) {
142 /* Are we at the end of the file? */
143 if (ds_file
->mmap_offset
>= ds_file
->file
->size
) {
144 BT_LOGD("Reached end of file \"%s\" (%p)",
145 ds_file
->file
->path
->str
, ds_file
->file
->fp
);
146 status
= BT_MSG_ITER_MEDIUM_STATUS_EOF
;
150 status
= ds_file_mmap_next(ds_file
);
152 case BT_MSG_ITER_MEDIUM_STATUS_OK
:
154 case BT_MSG_ITER_MEDIUM_STATUS_EOF
:
157 BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
158 ds_file
->file
->path
->str
,
164 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
165 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset
;
166 ds_file
->request_offset
+= *buffer_sz
;
170 status
= BT_MSG_ITER_MEDIUM_STATUS_ERROR
;
177 bt_stream
*medop_borrow_stream(bt_stream_class
*stream_class
, int64_t stream_id
,
180 struct ctf_fs_ds_file
*ds_file
= data
;
181 bt_stream_class
*ds_file_stream_class
;
182 bt_stream
*stream
= NULL
;
184 ds_file_stream_class
= bt_stream_borrow_class(
187 if (stream_class
!= ds_file_stream_class
) {
189 * Not supported: two packets described by two different
190 * stream classes within the same data stream file.
195 stream
= ds_file
->stream
;
202 enum bt_msg_iter_medium_status
medop_seek(enum bt_msg_iter_seek_whence whence
,
203 off_t offset
, void *data
)
205 enum bt_msg_iter_medium_status ret
=
206 BT_MSG_ITER_MEDIUM_STATUS_OK
;
207 struct ctf_fs_ds_file
*ds_file
= data
;
208 off_t file_size
= ds_file
->file
->size
;
210 if (whence
!= BT_MSG_ITER_SEEK_WHENCE_SET
||
211 offset
< 0 || offset
> file_size
) {
212 BT_LOGE("Invalid medium seek request: whence=%d, offset=%jd, "
213 "file-size=%jd", (int) whence
, offset
,
215 ret
= BT_MSG_ITER_MEDIUM_STATUS_INVAL
;
220 * Determine whether or not the destination is contained within the
223 if (ds_file
->mmap_addr
&& (offset
< ds_file
->mmap_offset
||
224 offset
>= ds_file
->mmap_offset
+ ds_file
->mmap_len
)) {
226 off_t offset_in_mapping
= offset
%
227 bt_common_get_page_size(ds_file
->log_level
);
229 BT_LOGD("Medium seek request cannot be accomodated by the current "
230 "file mapping: offset=%jd, mmap-offset=%jd, "
231 "mmap-len=%zu", offset
, ds_file
->mmap_offset
,
233 unmap_ret
= ds_file_munmap(ds_file
);
235 ret
= BT_MSG_ITER_MEDIUM_STATUS_ERROR
;
239 ds_file
->mmap_offset
= offset
- offset_in_mapping
;
240 ds_file
->request_offset
= offset_in_mapping
;
241 ret
= ds_file_mmap_next(ds_file
);
242 if (ret
!= BT_MSG_ITER_MEDIUM_STATUS_OK
) {
246 ds_file
->request_offset
= offset
- ds_file
->mmap_offset
;
249 ds_file
->end_reached
= (offset
== file_size
);
255 struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops
= {
256 .request_bytes
= medop_request_bytes
,
257 .borrow_stream
= medop_borrow_stream
,
262 int convert_cycles_to_ns(struct ctf_clock_class
*clock_class
,
263 uint64_t cycles
, int64_t *ns
)
265 return bt_util_clock_cycles_to_ns_from_origin(cycles
,
266 clock_class
->frequency
, clock_class
->offset_seconds
,
267 clock_class
->offset_cycles
, ns
);
271 struct ctf_fs_ds_index
*build_index_from_idx_file(
272 struct ctf_fs_ds_file
*ds_file
)
275 gchar
*directory
= NULL
;
276 gchar
*basename
= NULL
;
277 GString
*index_basename
= NULL
;
278 gchar
*index_file_path
= NULL
;
279 GMappedFile
*mapped_file
= NULL
;
281 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
282 const struct ctf_packet_index_file_hdr
*header
= NULL
;
283 struct ctf_fs_ds_index
*index
= NULL
;
284 struct ctf_fs_ds_index_entry
*index_entry
= NULL
;
285 uint64_t total_packets_size
= 0;
286 size_t file_index_entry_size
;
287 size_t file_entry_count
;
289 struct ctf_stream_class
*sc
;
290 struct bt_msg_iter_packet_properties props
;
292 BT_LOGI("Building index from .idx file of stream file %s",
293 ds_file
->file
->path
->str
);
294 ret
= bt_msg_iter_get_packet_properties(ds_file
->msg_iter
, &props
);
296 BT_LOGI_STR("Cannot read first packet's header and context fields.");
300 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
301 props
.stream_class_id
);
303 if (!sc
->default_clock_class
) {
304 BT_LOGI_STR("Cannot find stream class's default clock class.");
308 /* Look for index file in relative path index/name.idx. */
309 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
311 BT_LOGE("Cannot get the basename of datastream file %s",
312 ds_file
->file
->path
->str
);
316 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
318 BT_LOGE("Cannot get dirname of datastream file %s",
319 ds_file
->file
->path
->str
);
323 index_basename
= g_string_new(basename
);
324 if (!index_basename
) {
325 BT_LOGE_STR("Cannot allocate index file basename string");
329 g_string_append(index_basename
, ".idx");
330 index_file_path
= g_build_filename(directory
, "index",
331 index_basename
->str
, NULL
);
332 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
334 BT_LOGD("Cannot create new mapped file %s",
340 * The g_mapped_file API limits us to 4GB files on 32-bit.
341 * Traces with such large indexes have never been seen in the wild,
342 * but this would need to be adjusted to support them.
344 filesize
= g_mapped_file_get_length(mapped_file
);
345 if (filesize
< sizeof(*header
)) {
346 BT_LOGW("Invalid LTTng trace index file: "
347 "file size (%zu bytes) < header size (%zu bytes)",
348 filesize
, sizeof(*header
));
352 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
353 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
355 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
356 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
357 BT_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
361 file_index_entry_size
= be32toh(header
->packet_index_len
);
362 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
363 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
364 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
365 "(%zu bytes) is not a multiple of the index entry size "
366 "(%zu bytes)", (filesize
- sizeof(*header
)),
371 index
= ctf_fs_ds_index_create(ds_file
->log_level
);
376 for (i
= 0; i
< file_entry_count
; i
++) {
377 struct ctf_packet_index
*file_index
=
378 (struct ctf_packet_index
*) file_pos
;
379 uint64_t packet_size
= be64toh(file_index
->packet_size
);
381 if (packet_size
% CHAR_BIT
) {
382 BT_LOGW("Invalid packet size encountered in LTTng trace index file");
386 index_entry
= g_new0(struct ctf_fs_ds_index_entry
, 1);
391 /* Convert size in bits to bytes. */
392 packet_size
/= CHAR_BIT
;
393 index_entry
->packet_size
= packet_size
;
395 index_entry
->offset
= be64toh(file_index
->offset
);
396 if (i
!= 0 && index_entry
->offset
< (index_entry
- 1)->offset
) {
397 BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
398 "previous offset=%" PRIu64
", current offset=%" PRIu64
,
399 (index_entry
- 1)->offset
, index_entry
->offset
);
403 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
404 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
405 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
406 BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
407 "timestamp_begin=%" PRIu64
"timestamp_end=%" PRIu64
,
408 index_entry
->timestamp_begin
,
409 index_entry
->timestamp_end
);
413 /* Convert the packet's bound to nanoseconds since Epoch. */
414 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
415 index_entry
->timestamp_begin
,
416 &index_entry
->timestamp_begin_ns
);
418 BT_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
421 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
422 index_entry
->timestamp_end
,
423 &index_entry
->timestamp_end_ns
);
425 BT_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
429 total_packets_size
+= packet_size
;
430 file_pos
+= file_index_entry_size
;
432 g_ptr_array_add(index
->entries
, index_entry
);
435 /* Validate that the index addresses the complete stream. */
436 if (ds_file
->file
->size
!= total_packets_size
) {
437 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
438 "file-size=%" PRIu64
", total-packets-size=%" PRIu64
,
439 ds_file
->file
->size
, total_packets_size
);
445 g_free(index_file_path
);
446 if (index_basename
) {
447 g_string_free(index_basename
, TRUE
);
450 g_mapped_file_unref(mapped_file
);
454 ctf_fs_ds_index_destroy(index
);
461 int init_index_entry(struct ctf_fs_ds_index_entry
*entry
,
462 struct ctf_fs_ds_file
*ds_file
,
463 struct bt_msg_iter_packet_properties
*props
,
464 off_t packet_size
, off_t packet_offset
)
467 struct ctf_stream_class
*sc
;
469 sc
= ctf_trace_class_borrow_stream_class_by_id(ds_file
->metadata
->tc
,
470 props
->stream_class_id
);
472 BT_ASSERT(packet_offset
>= 0);
473 entry
->offset
= packet_offset
;
474 BT_ASSERT(packet_size
>= 0);
475 entry
->packet_size
= packet_size
;
477 if (props
->snapshots
.beginning_clock
!= UINT64_C(-1)) {
478 /* Convert the packet's bound to nanoseconds since Epoch. */
479 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
480 props
->snapshots
.beginning_clock
,
481 &entry
->timestamp_begin_ns
);
483 BT_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
487 entry
->timestamp_begin_ns
= UINT64_C(-1);
490 if (props
->snapshots
.end_clock
!= UINT64_C(-1)) {
491 ret
= convert_cycles_to_ns(sc
->default_clock_class
,
492 props
->snapshots
.end_clock
,
493 &entry
->timestamp_end_ns
);
495 BT_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
499 entry
->timestamp_end_ns
= UINT64_C(-1);
507 struct ctf_fs_ds_index
*build_index_from_stream_file(
508 struct ctf_fs_ds_file
*ds_file
)
511 struct ctf_fs_ds_index
*index
= NULL
;
512 enum bt_msg_iter_status iter_status
= BT_MSG_ITER_STATUS_OK
;
513 off_t current_packet_offset_bytes
= 0;
515 BT_LOGI("Indexing stream file %s", ds_file
->file
->path
->str
);
517 index
= ctf_fs_ds_index_create(ds_file
->log_level
);
523 off_t current_packet_size_bytes
;
524 struct ctf_fs_ds_index_entry
*index_entry
;
525 struct bt_msg_iter_packet_properties props
;
527 if (current_packet_offset_bytes
< 0) {
528 BT_LOGE_STR("Cannot get the current packet's offset.");
530 } else if (current_packet_offset_bytes
> ds_file
->file
->size
) {
531 BT_LOGE_STR("Unexpected current packet's offset (larger than file).");
533 } else if (current_packet_offset_bytes
== ds_file
->file
->size
) {
538 iter_status
= bt_msg_iter_seek(ds_file
->msg_iter
,
539 current_packet_offset_bytes
);
540 if (iter_status
!= BT_MSG_ITER_STATUS_OK
) {
544 iter_status
= bt_msg_iter_get_packet_properties(
545 ds_file
->msg_iter
, &props
);
546 if (iter_status
!= BT_MSG_ITER_STATUS_OK
) {
550 if (props
.exp_packet_total_size
>= 0) {
551 current_packet_size_bytes
=
552 (uint64_t) props
.exp_packet_total_size
/ 8;
554 current_packet_size_bytes
= ds_file
->file
->size
;
557 if (current_packet_offset_bytes
+ current_packet_size_bytes
>
558 ds_file
->file
->size
) {
559 BT_LOGW("Invalid packet size reported in file: stream=\"%s\", "
560 "packet-offset=%jd, packet-size-bytes=%jd, "
562 ds_file
->file
->path
->str
,
563 current_packet_offset_bytes
,
564 current_packet_size_bytes
,
565 ds_file
->file
->size
);
569 index_entry
= g_new0(struct ctf_fs_ds_index_entry
, 1);
571 BT_LOGE_STR("Failed to allocate a new index entry.");
575 ret
= init_index_entry(index_entry
, ds_file
, &props
,
576 current_packet_size_bytes
, current_packet_offset_bytes
);
582 g_ptr_array_add(index
->entries
, index_entry
);
584 current_packet_offset_bytes
+= current_packet_size_bytes
;
585 BT_LOGD("Seeking to next packet: current-packet-offset=%jd, "
586 "next-packet-offset=%jd",
587 current_packet_offset_bytes
- current_packet_size_bytes
,
588 current_packet_offset_bytes
);
590 } while (iter_status
== BT_MSG_ITER_STATUS_OK
);
592 if (iter_status
!= BT_MSG_ITER_STATUS_OK
) {
600 ctf_fs_ds_index_destroy(index
);
606 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
607 struct ctf_fs_trace
*ctf_fs_trace
,
608 bt_self_message_iterator
*pc_msg_iter
,
609 struct bt_msg_iter
*msg_iter
,
610 bt_stream
*stream
, const char *path
,
611 bt_logging_level log_level
)
614 const size_t page_size
= bt_common_get_page_size(log_level
);
615 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
621 ds_file
->log_level
= log_level
;
622 ds_file
->pc_msg_iter
= pc_msg_iter
;
623 ds_file
->file
= ctf_fs_file_create(log_level
);
624 if (!ds_file
->file
) {
628 ds_file
->stream
= stream
;
629 bt_stream_get_ref(ds_file
->stream
);
630 ds_file
->metadata
= ctf_fs_trace
->metadata
;
631 g_string_assign(ds_file
->file
->path
, path
);
632 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
637 ds_file
->msg_iter
= msg_iter
;
638 bt_msg_iter_set_medops_data(ds_file
->msg_iter
, ds_file
);
639 if (!ds_file
->msg_iter
) {
643 ds_file
->mmap_max_len
= page_size
* 2048;
648 /* Do not touch "borrowed" file. */
649 ctf_fs_ds_file_destroy(ds_file
);
657 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
658 struct ctf_fs_ds_file
*ds_file
)
660 struct ctf_fs_ds_index
*index
;
662 index
= build_index_from_idx_file(ds_file
);
667 BT_LOGI("Failed to build index from .index file; "
668 "falling back to stream indexing.");
669 index
= build_index_from_stream_file(ds_file
);
675 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(bt_logging_level log_level
)
677 struct ctf_fs_ds_index
*index
= g_new0(struct ctf_fs_ds_index
, 1);
680 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR
, log_level
, BT_LOG_TAG
,
681 "Failed to allocate index");
685 index
->entries
= g_ptr_array_new_with_free_func((GDestroyNotify
) g_free
);
686 if (!index
->entries
) {
687 BT_LOG_WRITE_CUR_LVL(BT_LOG_ERROR
, log_level
, BT_LOG_TAG
,
688 "Failed to allocate index entries.");
695 ctf_fs_ds_index_destroy(index
);
702 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
708 bt_stream_put_ref(ds_file
->stream
);
709 (void) ds_file_munmap(ds_file
);
712 ctf_fs_file_destroy(ds_file
->file
);
719 bt_self_message_iterator_status
ctf_fs_ds_file_next(
720 struct ctf_fs_ds_file
*ds_file
,
723 enum bt_msg_iter_status msg_iter_status
;
724 bt_self_message_iterator_status status
;
726 msg_iter_status
= bt_msg_iter_get_next_message(
727 ds_file
->msg_iter
, ds_file
->pc_msg_iter
, msg
);
729 switch (msg_iter_status
) {
730 case BT_MSG_ITER_STATUS_EOF
:
731 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_END
;
733 case BT_MSG_ITER_STATUS_OK
:
734 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_OK
;
736 case BT_MSG_ITER_STATUS_AGAIN
:
738 * Should not make it this far as this is
739 * medium-specific; there is nothing for the user to do
740 * and it should have been handled upstream.
743 case BT_MSG_ITER_STATUS_INVAL
:
744 case BT_MSG_ITER_STATUS_ERROR
:
746 status
= BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR
;
753 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
759 if (index
->entries
) {
760 g_ptr_array_free(index
->entries
, TRUE
);