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
32 #include <babeltrace/compat/mman-internal.h>
33 #include <babeltrace/endian-internal.h>
34 #include <babeltrace/ctf-ir/stream.h>
35 #include <babeltrace/graph/notification-iterator.h>
36 #include <babeltrace/graph/notification-stream.h>
37 #include <babeltrace/graph/notification-event.h>
38 #include <babeltrace/graph/notification-packet.h>
39 #include <babeltrace/common-internal.h>
42 #include "../common/notif-iter/notif-iter.h"
44 #include "data-stream-file.h"
47 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC-DS"
51 size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
53 return ds_file
->mmap_len
- ds_file
->request_offset
;
57 int ds_file_munmap(struct ctf_fs_ds_file
*ds_file
)
61 if (!ds_file
|| !ds_file
->mmap_addr
) {
65 if (bt_munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
66 BT_LOGE_ERRNO("Cannot memory-unmap file",
67 ": address=%p, size=%zu, file_path=\"%s\", file=%p",
68 ds_file
->mmap_addr
, ds_file
->mmap_len
,
69 ds_file
->file
->path
->str
,
70 ds_file
->file
? ds_file
->file
->fp
: NULL
);
75 ds_file
->mmap_addr
= NULL
;
82 enum bt_ctf_notif_iter_medium_status
ds_file_mmap_next(
83 struct ctf_fs_ds_file
*ds_file
)
85 const size_t page_size
= bt_common_get_page_size();
86 enum bt_ctf_notif_iter_medium_status ret
=
87 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
89 /* Unmap old region */
90 if (ds_file
->mmap_addr
) {
91 if (ds_file_munmap(ds_file
)) {
96 * mmap_len is guaranteed to be page-aligned except on the
97 * last mapping where it may not be possible (since the file's
98 * size itself may not be a page multiple).
100 ds_file
->mmap_offset
+= ds_file
->mmap_len
;
101 ds_file
->request_offset
= 0;
104 ds_file
->mmap_len
= MIN(ds_file
->file
->size
- ds_file
->mmap_offset
,
105 ds_file
->mmap_max_len
);
106 if (ds_file
->mmap_len
== 0) {
107 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
111 assert(ds_file
->mmap_len
);
112 ds_file
->mmap_addr
= bt_mmap((void *) 0, ds_file
->mmap_len
,
113 PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
114 ds_file
->mmap_offset
);
115 if (ds_file
->mmap_addr
== MAP_FAILED
) {
116 BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
117 ds_file
->mmap_len
, ds_file
->file
->path
->str
,
118 ds_file
->file
->fp
, (intmax_t) ds_file
->mmap_offset
,
125 ds_file_munmap(ds_file
);
126 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
132 enum bt_ctf_notif_iter_medium_status
medop_request_bytes(
133 size_t request_sz
, uint8_t **buffer_addr
,
134 size_t *buffer_sz
, void *data
)
136 enum bt_ctf_notif_iter_medium_status status
=
137 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
138 struct ctf_fs_ds_file
*ds_file
= data
;
140 if (request_sz
== 0) {
144 /* Check if we have at least one memory-mapped byte left */
145 if (remaining_mmap_bytes(ds_file
) == 0) {
146 /* Are we at the end of the file? */
147 if (ds_file
->mmap_offset
>= ds_file
->file
->size
) {
148 BT_LOGD("Reached end of file \"%s\" (%p)",
149 ds_file
->file
->path
->str
, ds_file
->file
->fp
);
150 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
154 status
= ds_file_mmap_next(ds_file
);
156 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
:
158 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
:
161 BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
162 ds_file
->file
->path
->str
,
168 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
169 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset
;
170 ds_file
->request_offset
+= *buffer_sz
;
174 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
181 struct bt_ctf_stream
*medop_get_stream(
182 struct bt_ctf_stream_class
*stream_class
, uint64_t stream_id
,
185 struct ctf_fs_ds_file
*ds_file
= data
;
186 struct bt_ctf_stream_class
*ds_file_stream_class
;
187 struct bt_ctf_stream
*stream
= NULL
;
189 ds_file_stream_class
= bt_ctf_stream_get_class(ds_file
->stream
);
190 bt_put(ds_file_stream_class
);
192 if (stream_class
!= ds_file_stream_class
) {
194 * Not supported: two packets described by two different
195 * stream classes within the same data stream file.
200 stream
= ds_file
->stream
;
207 struct bt_ctf_notif_iter_medium_ops ctf_fs_ds_file_medops
= {
208 .request_bytes
= medop_request_bytes
,
209 .get_stream
= medop_get_stream
,
213 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(size_t length
)
215 struct ctf_fs_ds_index
*index
= g_new0(struct ctf_fs_ds_index
, 1);
218 BT_LOGE_STR("Failed to allocate index");
222 index
->entries
= g_array_sized_new(FALSE
, TRUE
,
223 sizeof(struct ctf_fs_ds_index_entry
), length
);
224 if (!index
->entries
) {
225 BT_LOGE("Failed to allocate %zu index entries.", length
);
228 g_array_set_size(index
->entries
, length
);
232 ctf_fs_ds_index_destroy(index
);
237 struct bt_ctf_clock_class
*get_field_mapped_clock_class(
238 struct bt_ctf_field
*field
)
240 struct bt_ctf_field_type
*field_type
;
241 struct bt_ctf_clock_class
*clock_class
= NULL
;
243 field_type
= bt_ctf_field_get_type(field
);
248 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
259 int get_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file
*ds_file
,
260 struct bt_ctf_clock_class
**_timestamp_begin_cc
,
261 struct bt_ctf_clock_class
**_timestamp_end_cc
)
264 struct bt_ctf_field
*timestamp_field
= NULL
;
265 struct bt_ctf_field
*packet_context_field
= NULL
;
266 struct bt_ctf_clock_class
*timestamp_begin_cc
= NULL
;
267 struct bt_ctf_clock_class
*timestamp_end_cc
= NULL
;
269 ret
= ctf_fs_ds_file_get_packet_header_context_fields(ds_file
,
270 NULL
, &packet_context_field
);
271 if (ret
|| !packet_context_field
) {
272 BT_LOGD("Cannot retrieve packet context field of stream \'%s\'",
273 ds_file
->file
->path
->str
);
278 timestamp_field
= bt_ctf_field_structure_get_field_by_name(
279 packet_context_field
, "timestamp_begin");
280 if (!timestamp_field
) {
281 BT_LOGD("Cannot retrieve timestamp_begin field in packet context of stream \'%s\'",
282 ds_file
->file
->path
->str
);
287 timestamp_begin_cc
= get_field_mapped_clock_class(timestamp_field
);
288 if (!timestamp_begin_cc
) {
289 BT_LOGD("Cannot retrieve the clock mapped to timestamp_begin of stream \'%s\'",
290 ds_file
->file
->path
->str
);
292 BT_PUT(timestamp_field
);
294 timestamp_field
= bt_ctf_field_structure_get_field_by_name(
295 packet_context_field
, "timestamp_end");
296 if (!timestamp_field
) {
297 BT_LOGD("Cannot retrieve timestamp_end field in packet context of stream \'%s\'",
298 ds_file
->file
->path
->str
);
303 timestamp_end_cc
= get_field_mapped_clock_class(timestamp_field
);
304 if (!timestamp_end_cc
) {
305 BT_LOGD("Cannot retrieve the clock mapped to timestamp_end in stream \'%s\'",
306 ds_file
->file
->path
->str
);
309 if (_timestamp_begin_cc
) {
310 *_timestamp_begin_cc
= bt_get(timestamp_begin_cc
);
312 if (_timestamp_end_cc
) {
313 *_timestamp_end_cc
= bt_get(timestamp_end_cc
);
316 bt_put(packet_context_field
);
317 bt_put(timestamp_field
);
318 bt_put(timestamp_begin_cc
);
319 bt_put(timestamp_end_cc
);
324 int convert_cycles_to_ns(struct bt_ctf_clock_class
*clock_class
,
325 uint64_t cycles
, int64_t *ns
)
328 struct bt_ctf_clock_value
*clock_value
;
331 clock_value
= bt_ctf_clock_value_create(clock_class
, cycles
);
337 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
347 struct ctf_fs_ds_index
*build_index_from_idx_file(
348 struct ctf_fs_ds_file
*ds_file
)
351 gchar
*directory
= NULL
;
352 gchar
*basename
= NULL
;
353 GString
*index_basename
= NULL
;
354 gchar
*index_file_path
= NULL
;
355 GMappedFile
*mapped_file
= NULL
;
357 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
358 const struct ctf_packet_index_file_hdr
*header
= NULL
;
359 struct ctf_fs_ds_index
*index
= NULL
;
360 struct ctf_fs_ds_index_entry
*index_entry
= NULL
;
361 uint64_t total_packets_size
= 0;
362 size_t file_index_entry_size
;
363 size_t file_entry_count
;
365 struct bt_ctf_clock_class
*timestamp_begin_cc
= NULL
;
366 struct bt_ctf_clock_class
*timestamp_end_cc
= NULL
;
368 BT_LOGD("Building index from .idx file of stream file %s",
369 ds_file
->file
->path
->str
);
371 ret
= get_ds_file_packet_bounds_clock_classes(ds_file
,
372 ×tamp_begin_cc
, ×tamp_end_cc
);
374 BT_LOGD("Cannot get clock classes of \"timestamp_begin\" and \"timestamp_end\" fields");
378 /* Look for index file in relative path index/name.idx. */
379 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
381 BT_LOGE("Cannot get the basename of datastream file %s",
382 ds_file
->file
->path
->str
);
386 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
388 BT_LOGE("Cannot get dirname of datastream file %s",
389 ds_file
->file
->path
->str
);
393 index_basename
= g_string_new(basename
);
394 if (!index_basename
) {
395 BT_LOGE("Cannot allocate index file basename string");
399 g_string_append(index_basename
, ".idx");
400 index_file_path
= g_build_filename(directory
, "index",
401 index_basename
->str
, NULL
);
402 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
404 BT_LOGD("Cannot create new mapped file %s",
410 * The g_mapped_file API limits us to 4GB files on 32-bit.
411 * Traces with such large indexes have never been seen in the wild,
412 * but this would need to be adjusted to support them.
414 filesize
= g_mapped_file_get_length(mapped_file
);
415 if (filesize
< sizeof(*header
)) {
416 BT_LOGW("Invalid LTTng trace index file: "
417 "file size (%zu bytes) < header size (%zu bytes)",
418 filesize
, sizeof(*header
));
422 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
423 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
425 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
426 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
427 BT_LOGW("Invalid LTTng trace index: \"magic\" field validation failed");
431 file_index_entry_size
= be32toh(header
->packet_index_len
);
432 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
433 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
434 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
435 "(%zu bytes) is not a multiple of the index entry size "
436 "(%zu bytes)", (filesize
- sizeof(*header
)),
441 index
= ctf_fs_ds_index_create(file_entry_count
);
446 index_entry
= (struct ctf_fs_ds_index_entry
*) &g_array_index(
447 index
->entries
, struct ctf_fs_ds_index_entry
, 0);
448 for (i
= 0; i
< file_entry_count
; i
++) {
449 struct ctf_packet_index
*file_index
=
450 (struct ctf_packet_index
*) file_pos
;
451 uint64_t packet_size
= be64toh(file_index
->packet_size
);
453 if (packet_size
% CHAR_BIT
) {
454 BT_LOGW("Invalid packet size encountered in LTTng trace index file");
458 /* Convert size in bits to bytes. */
459 packet_size
/= CHAR_BIT
;
460 index_entry
->packet_size
= packet_size
;
462 index_entry
->offset
= be64toh(file_index
->offset
);
463 if (i
!= 0 && index_entry
->offset
< (index_entry
- 1)->offset
) {
464 BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
465 "previous offset=%" PRIu64
", current offset=%" PRIu64
,
466 (index_entry
- 1)->offset
, index_entry
->offset
);
470 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
471 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
472 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
473 BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
474 "timestamp_begin=%" PRIu64
"timestamp_end=%" PRIu64
,
475 index_entry
->timestamp_begin
,
476 index_entry
->timestamp_end
);
480 /* Convert the packet's bound to nanoseconds since Epoch. */
481 ret
= convert_cycles_to_ns(timestamp_begin_cc
,
482 index_entry
->timestamp_begin
,
483 &index_entry
->timestamp_begin_ns
);
485 BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
488 ret
= convert_cycles_to_ns(timestamp_end_cc
,
489 index_entry
->timestamp_end
,
490 &index_entry
->timestamp_end_ns
);
492 BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
496 total_packets_size
+= packet_size
;
497 file_pos
+= file_index_entry_size
;
501 /* Validate that the index addresses the complete stream. */
502 if (ds_file
->file
->size
!= total_packets_size
) {
503 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
504 "file_size=%" PRIu64
", total_packets_size=%" PRIu64
,
505 ds_file
->file
->size
, total_packets_size
);
511 g_free(index_file_path
);
512 if (index_basename
) {
513 g_string_free(index_basename
, TRUE
);
516 g_mapped_file_unref(mapped_file
);
518 bt_put(timestamp_begin_cc
);
519 bt_put(timestamp_end_cc
);
522 ctf_fs_ds_index_destroy(index
);
528 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
529 struct ctf_fs_trace
*ctf_fs_trace
,
530 struct bt_ctf_notif_iter
*notif_iter
,
531 struct bt_ctf_stream
*stream
, const char *path
)
534 const size_t page_size
= bt_common_get_page_size();
535 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
541 ds_file
->file
= ctf_fs_file_create();
542 if (!ds_file
->file
) {
546 ds_file
->stream
= bt_get(stream
);
547 ds_file
->cc_prio_map
= bt_get(ctf_fs_trace
->cc_prio_map
);
548 g_string_assign(ds_file
->file
->path
, path
);
549 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
554 ds_file
->notif_iter
= notif_iter
;
555 bt_ctf_notif_iter_set_medops_data(ds_file
->notif_iter
, ds_file
);
556 if (!ds_file
->notif_iter
) {
560 ds_file
->mmap_max_len
= page_size
* 2048;
565 /* Do not touch "borrowed" file. */
566 ctf_fs_ds_file_destroy(ds_file
);
574 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
575 struct ctf_fs_ds_file
*ds_file
)
577 return build_index_from_idx_file(ds_file
);
581 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
587 bt_put(ds_file
->cc_prio_map
);
588 bt_put(ds_file
->stream
);
589 (void) ds_file_munmap(ds_file
);
592 ctf_fs_file_destroy(ds_file
->file
);
599 struct bt_notification_iterator_next_return
ctf_fs_ds_file_next(
600 struct ctf_fs_ds_file
*ds_file
)
602 enum bt_ctf_notif_iter_status notif_iter_status
;
603 struct bt_notification_iterator_next_return ret
= {
604 .status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
,
605 .notification
= NULL
,
608 notif_iter_status
= bt_ctf_notif_iter_get_next_notification(
609 ds_file
->notif_iter
, ds_file
->cc_prio_map
, &ret
.notification
);
611 switch (notif_iter_status
) {
612 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
613 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
615 case BT_CTF_NOTIF_ITER_STATUS_OK
:
616 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
618 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
620 * Should not make it this far as this is
621 * medium-specific; there is nothing for the user to do
622 * and it should have been handled upstream.
625 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
626 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
628 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
636 int ctf_fs_ds_file_get_packet_header_context_fields(
637 struct ctf_fs_ds_file
*ds_file
,
638 struct bt_ctf_field
**packet_header_field
,
639 struct bt_ctf_field
**packet_context_field
)
641 enum bt_ctf_notif_iter_status notif_iter_status
;
645 notif_iter_status
= bt_ctf_notif_iter_get_packet_header_context_fields(
646 ds_file
->notif_iter
, packet_header_field
, packet_context_field
);
647 switch (notif_iter_status
) {
648 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
649 case BT_CTF_NOTIF_ITER_STATUS_OK
:
651 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
653 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
654 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
665 if (packet_header_field
) {
666 bt_put(*packet_header_field
);
669 if (packet_context_field
) {
670 bt_put(*packet_context_field
);
678 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
684 if (index
->entries
) {
685 g_array_free(index
->entries
, TRUE
);