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 enum bt_ctf_notif_iter_medium_status ret
=
86 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
88 /* Unmap old region */
89 if (ds_file
->mmap_addr
) {
90 if (ds_file_munmap(ds_file
)) {
95 * mmap_len is guaranteed to be page-aligned except on the
96 * last mapping where it may not be possible (since the file's
97 * size itself may not be a page multiple).
99 ds_file
->mmap_offset
+= ds_file
->mmap_len
;
100 ds_file
->request_offset
= 0;
103 ds_file
->mmap_len
= MIN(ds_file
->file
->size
- ds_file
->mmap_offset
,
104 ds_file
->mmap_max_len
);
105 if (ds_file
->mmap_len
== 0) {
106 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
110 assert(ds_file
->mmap_len
);
111 ds_file
->mmap_addr
= bt_mmap((void *) 0, ds_file
->mmap_len
,
112 PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
113 ds_file
->mmap_offset
);
114 if (ds_file
->mmap_addr
== MAP_FAILED
) {
115 BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
116 ds_file
->mmap_len
, ds_file
->file
->path
->str
,
117 ds_file
->file
->fp
, (intmax_t) ds_file
->mmap_offset
,
124 ds_file_munmap(ds_file
);
125 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
131 enum bt_ctf_notif_iter_medium_status
medop_request_bytes(
132 size_t request_sz
, uint8_t **buffer_addr
,
133 size_t *buffer_sz
, void *data
)
135 enum bt_ctf_notif_iter_medium_status status
=
136 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
137 struct ctf_fs_ds_file
*ds_file
= data
;
139 if (request_sz
== 0) {
143 /* Check if we have at least one memory-mapped byte left */
144 if (remaining_mmap_bytes(ds_file
) == 0) {
145 /* Are we at the end of the file? */
146 if (ds_file
->mmap_offset
>= ds_file
->file
->size
) {
147 BT_LOGD("Reached end of file \"%s\" (%p)",
148 ds_file
->file
->path
->str
, ds_file
->file
->fp
);
149 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
153 status
= ds_file_mmap_next(ds_file
);
155 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
:
157 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
:
160 BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
161 ds_file
->file
->path
->str
,
167 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
168 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset
;
169 ds_file
->request_offset
+= *buffer_sz
;
173 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
180 struct bt_ctf_stream
*medop_get_stream(
181 struct bt_ctf_stream_class
*stream_class
, uint64_t stream_id
,
184 struct ctf_fs_ds_file
*ds_file
= data
;
185 struct bt_ctf_stream_class
*ds_file_stream_class
;
186 struct bt_ctf_stream
*stream
= NULL
;
188 ds_file_stream_class
= bt_ctf_stream_get_class(ds_file
->stream
);
189 bt_put(ds_file_stream_class
);
191 if (stream_class
!= ds_file_stream_class
) {
193 * Not supported: two packets described by two different
194 * stream classes within the same data stream file.
199 stream
= ds_file
->stream
;
206 struct bt_ctf_notif_iter_medium_ops ctf_fs_ds_file_medops
= {
207 .request_bytes
= medop_request_bytes
,
208 .get_stream
= medop_get_stream
,
212 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(size_t length
)
214 struct ctf_fs_ds_index
*index
= g_new0(struct ctf_fs_ds_index
, 1);
217 BT_LOGE_STR("Failed to allocate index");
221 index
->entries
= g_array_sized_new(FALSE
, TRUE
,
222 sizeof(struct ctf_fs_ds_index_entry
), length
);
223 if (!index
->entries
) {
224 BT_LOGE("Failed to allocate %zu index entries.", length
);
227 g_array_set_size(index
->entries
, length
);
231 ctf_fs_ds_index_destroy(index
);
236 struct bt_ctf_clock_class
*get_field_mapped_clock_class(
237 struct bt_ctf_field
*field
)
239 struct bt_ctf_field_type
*field_type
;
240 struct bt_ctf_clock_class
*clock_class
= NULL
;
242 field_type
= bt_ctf_field_get_type(field
);
247 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
258 int get_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file
*ds_file
,
259 struct bt_ctf_clock_class
**_timestamp_begin_cc
,
260 struct bt_ctf_clock_class
**_timestamp_end_cc
)
263 struct bt_ctf_field
*timestamp_field
= NULL
;
264 struct bt_ctf_field
*packet_context_field
= NULL
;
265 struct bt_ctf_clock_class
*timestamp_begin_cc
= NULL
;
266 struct bt_ctf_clock_class
*timestamp_end_cc
= NULL
;
268 ret
= ctf_fs_ds_file_get_packet_header_context_fields(ds_file
,
269 NULL
, &packet_context_field
);
270 if (ret
|| !packet_context_field
) {
271 BT_LOGD("Cannot retrieve packet context field of stream \'%s\'",
272 ds_file
->file
->path
->str
);
277 timestamp_field
= bt_ctf_field_structure_get_field_by_name(
278 packet_context_field
, "timestamp_begin");
279 if (!timestamp_field
) {
280 BT_LOGD("Cannot retrieve timestamp_begin field in packet context of stream \'%s\'",
281 ds_file
->file
->path
->str
);
286 timestamp_begin_cc
= get_field_mapped_clock_class(timestamp_field
);
287 if (!timestamp_begin_cc
) {
288 BT_LOGD("Cannot retrieve the clock mapped to timestamp_begin of stream \'%s\'",
289 ds_file
->file
->path
->str
);
291 BT_PUT(timestamp_field
);
293 timestamp_field
= bt_ctf_field_structure_get_field_by_name(
294 packet_context_field
, "timestamp_end");
295 if (!timestamp_field
) {
296 BT_LOGD("Cannot retrieve timestamp_end field in packet context of stream \'%s\'",
297 ds_file
->file
->path
->str
);
302 timestamp_end_cc
= get_field_mapped_clock_class(timestamp_field
);
303 if (!timestamp_end_cc
) {
304 BT_LOGD("Cannot retrieve the clock mapped to timestamp_end in stream \'%s\'",
305 ds_file
->file
->path
->str
);
308 if (_timestamp_begin_cc
) {
309 *_timestamp_begin_cc
= bt_get(timestamp_begin_cc
);
311 if (_timestamp_end_cc
) {
312 *_timestamp_end_cc
= bt_get(timestamp_end_cc
);
315 bt_put(packet_context_field
);
316 bt_put(timestamp_field
);
317 bt_put(timestamp_begin_cc
);
318 bt_put(timestamp_end_cc
);
323 int convert_cycles_to_ns(struct bt_ctf_clock_class
*clock_class
,
324 uint64_t cycles
, int64_t *ns
)
327 struct bt_ctf_clock_value
*clock_value
;
330 clock_value
= bt_ctf_clock_value_create(clock_class
, cycles
);
336 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
346 struct ctf_fs_ds_index
*build_index_from_idx_file(
347 struct ctf_fs_ds_file
*ds_file
)
350 gchar
*directory
= NULL
;
351 gchar
*basename
= NULL
;
352 GString
*index_basename
= NULL
;
353 gchar
*index_file_path
= NULL
;
354 GMappedFile
*mapped_file
= NULL
;
356 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
357 const struct ctf_packet_index_file_hdr
*header
= NULL
;
358 struct ctf_fs_ds_index
*index
= NULL
;
359 struct ctf_fs_ds_index_entry
*index_entry
= NULL
;
360 uint64_t total_packets_size
= 0;
361 size_t file_index_entry_size
;
362 size_t file_entry_count
;
364 struct bt_ctf_clock_class
*timestamp_begin_cc
= NULL
;
365 struct bt_ctf_clock_class
*timestamp_end_cc
= NULL
;
367 BT_LOGD("Building index from .idx file of stream file %s",
368 ds_file
->file
->path
->str
);
370 ret
= get_ds_file_packet_bounds_clock_classes(ds_file
,
371 ×tamp_begin_cc
, ×tamp_end_cc
);
373 BT_LOGD("Cannot get clock classes of \"timestamp_begin\" and \"timestamp_end\" fields");
377 /* Look for index file in relative path index/name.idx. */
378 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
380 BT_LOGE("Cannot get the basename of datastream file %s",
381 ds_file
->file
->path
->str
);
385 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
387 BT_LOGE("Cannot get dirname of datastream file %s",
388 ds_file
->file
->path
->str
);
392 index_basename
= g_string_new(basename
);
393 if (!index_basename
) {
394 BT_LOGE("Cannot allocate index file basename string");
398 g_string_append(index_basename
, ".idx");
399 index_file_path
= g_build_filename(directory
, "index",
400 index_basename
->str
, NULL
);
401 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
403 BT_LOGD("Cannot create new mapped file %s",
409 * The g_mapped_file API limits us to 4GB files on 32-bit.
410 * Traces with such large indexes have never been seen in the wild,
411 * but this would need to be adjusted to support them.
413 filesize
= g_mapped_file_get_length(mapped_file
);
414 if (filesize
< sizeof(*header
)) {
415 BT_LOGW("Invalid LTTng trace index file: "
416 "file size (%zu bytes) < header size (%zu bytes)",
417 filesize
, sizeof(*header
));
421 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
422 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
424 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
425 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
426 BT_LOGW("Invalid LTTng trace index: \"magic\" field validation failed");
430 file_index_entry_size
= be32toh(header
->packet_index_len
);
431 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
432 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
433 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
434 "(%zu bytes) is not a multiple of the index entry size "
435 "(%zu bytes)", (filesize
- sizeof(*header
)),
440 index
= ctf_fs_ds_index_create(file_entry_count
);
445 index_entry
= (struct ctf_fs_ds_index_entry
*) &g_array_index(
446 index
->entries
, struct ctf_fs_ds_index_entry
, 0);
447 for (i
= 0; i
< file_entry_count
; i
++) {
448 struct ctf_packet_index
*file_index
=
449 (struct ctf_packet_index
*) file_pos
;
450 uint64_t packet_size
= be64toh(file_index
->packet_size
);
452 if (packet_size
% CHAR_BIT
) {
453 BT_LOGW("Invalid packet size encountered in LTTng trace index file");
457 /* Convert size in bits to bytes. */
458 packet_size
/= CHAR_BIT
;
459 index_entry
->packet_size
= packet_size
;
461 index_entry
->offset
= be64toh(file_index
->offset
);
462 if (i
!= 0 && index_entry
->offset
< (index_entry
- 1)->offset
) {
463 BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
464 "previous offset=%" PRIu64
", current offset=%" PRIu64
,
465 (index_entry
- 1)->offset
, index_entry
->offset
);
469 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
470 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
471 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
472 BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
473 "timestamp_begin=%" PRIu64
"timestamp_end=%" PRIu64
,
474 index_entry
->timestamp_begin
,
475 index_entry
->timestamp_end
);
479 /* Convert the packet's bound to nanoseconds since Epoch. */
480 ret
= convert_cycles_to_ns(timestamp_begin_cc
,
481 index_entry
->timestamp_begin
,
482 &index_entry
->timestamp_begin_ns
);
484 BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
487 ret
= convert_cycles_to_ns(timestamp_end_cc
,
488 index_entry
->timestamp_end
,
489 &index_entry
->timestamp_end_ns
);
491 BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
495 total_packets_size
+= packet_size
;
496 file_pos
+= file_index_entry_size
;
500 /* Validate that the index addresses the complete stream. */
501 if (ds_file
->file
->size
!= total_packets_size
) {
502 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
503 "file_size=%" PRIu64
", total_packets_size=%" PRIu64
,
504 ds_file
->file
->size
, total_packets_size
);
510 g_free(index_file_path
);
511 if (index_basename
) {
512 g_string_free(index_basename
, TRUE
);
515 g_mapped_file_unref(mapped_file
);
517 bt_put(timestamp_begin_cc
);
518 bt_put(timestamp_end_cc
);
521 ctf_fs_ds_index_destroy(index
);
527 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
528 struct ctf_fs_trace
*ctf_fs_trace
,
529 struct bt_ctf_notif_iter
*notif_iter
,
530 struct bt_ctf_stream
*stream
, const char *path
)
533 const size_t page_size
= bt_common_get_page_size();
534 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
540 ds_file
->file
= ctf_fs_file_create();
541 if (!ds_file
->file
) {
545 ds_file
->stream
= bt_get(stream
);
546 ds_file
->cc_prio_map
= bt_get(ctf_fs_trace
->cc_prio_map
);
547 g_string_assign(ds_file
->file
->path
, path
);
548 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
553 ds_file
->notif_iter
= notif_iter
;
554 bt_ctf_notif_iter_set_medops_data(ds_file
->notif_iter
, ds_file
);
555 if (!ds_file
->notif_iter
) {
559 ds_file
->mmap_max_len
= page_size
* 2048;
564 /* Do not touch "borrowed" file. */
565 ctf_fs_ds_file_destroy(ds_file
);
573 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
574 struct ctf_fs_ds_file
*ds_file
)
576 return build_index_from_idx_file(ds_file
);
580 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
586 bt_put(ds_file
->cc_prio_map
);
587 bt_put(ds_file
->stream
);
588 (void) ds_file_munmap(ds_file
);
591 ctf_fs_file_destroy(ds_file
->file
);
598 struct bt_notification_iterator_next_return
ctf_fs_ds_file_next(
599 struct ctf_fs_ds_file
*ds_file
)
601 enum bt_ctf_notif_iter_status notif_iter_status
;
602 struct bt_notification_iterator_next_return ret
= {
603 .status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
,
604 .notification
= NULL
,
607 notif_iter_status
= bt_ctf_notif_iter_get_next_notification(
608 ds_file
->notif_iter
, ds_file
->cc_prio_map
, &ret
.notification
);
610 switch (notif_iter_status
) {
611 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
612 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
614 case BT_CTF_NOTIF_ITER_STATUS_OK
:
615 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
617 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
619 * Should not make it this far as this is
620 * medium-specific; there is nothing for the user to do
621 * and it should have been handled upstream.
624 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
625 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
627 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
635 int ctf_fs_ds_file_get_packet_header_context_fields(
636 struct ctf_fs_ds_file
*ds_file
,
637 struct bt_ctf_field
**packet_header_field
,
638 struct bt_ctf_field
**packet_context_field
)
640 enum bt_ctf_notif_iter_status notif_iter_status
;
644 notif_iter_status
= bt_ctf_notif_iter_get_packet_header_context_fields(
645 ds_file
->notif_iter
, packet_header_field
, packet_context_field
);
646 switch (notif_iter_status
) {
647 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
648 case BT_CTF_NOTIF_ITER_STATUS_OK
:
650 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
652 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
653 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
664 if (packet_header_field
) {
665 bt_put(*packet_header_field
);
668 if (packet_context_field
) {
669 bt_put(*packet_context_field
);
677 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
683 if (index
->entries
) {
684 g_array_free(index
->entries
, TRUE
);