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_valid_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("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s",
67 ds_file
->mmap_addr
, ds_file
->mmap_len
,
68 ds_file
->file
->path
->str
, ds_file
->file
->fp
,
74 ds_file
->mmap_addr
= NULL
;
81 enum bt_ctf_notif_iter_medium_status
ds_file_mmap_next(
82 struct ctf_fs_ds_file
*ds_file
)
84 const size_t page_size
= bt_common_get_page_size();
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
)) {
94 ds_file
->mmap_offset
+= ds_file
->mmap_valid_len
;
95 ds_file
->request_offset
= 0;
98 ds_file
->mmap_valid_len
= MIN(ds_file
->file
->size
- ds_file
->mmap_offset
,
99 ds_file
->mmap_max_len
);
100 if (ds_file
->mmap_valid_len
== 0) {
101 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
104 /* Round up to next page, assuming page size being a power of 2. */
105 ds_file
->mmap_len
= (ds_file
->mmap_valid_len
+ page_size
- 1)
108 assert(ds_file
->mmap_len
);
109 ds_file
->mmap_addr
= bt_mmap((void *) 0, ds_file
->mmap_len
,
110 PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
111 ds_file
->mmap_offset
);
112 if (ds_file
->mmap_addr
== MAP_FAILED
) {
113 BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s",
114 ds_file
->mmap_len
, ds_file
->file
->path
->str
,
115 ds_file
->file
->fp
, ds_file
->mmap_offset
,
122 ds_file_munmap(ds_file
);
123 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
129 enum bt_ctf_notif_iter_medium_status
medop_request_bytes(
130 size_t request_sz
, uint8_t **buffer_addr
,
131 size_t *buffer_sz
, void *data
)
133 enum bt_ctf_notif_iter_medium_status status
=
134 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
135 struct ctf_fs_ds_file
*ds_file
= data
;
137 if (request_sz
== 0) {
141 /* Check if we have at least one memory-mapped byte left */
142 if (remaining_mmap_bytes(ds_file
) == 0) {
143 /* Are we at the end of the file? */
144 if (ds_file
->mmap_offset
>= ds_file
->file
->size
) {
145 BT_LOGD("Reached end of file \"%s\" (%p)",
146 ds_file
->file
->path
->str
, ds_file
->file
->fp
);
147 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
151 status
= ds_file_mmap_next(ds_file
);
153 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
:
155 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
:
158 BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
159 ds_file
->file
->path
->str
,
165 *buffer_sz
= MIN(remaining_mmap_bytes(ds_file
), request_sz
);
166 *buffer_addr
= ((uint8_t *) ds_file
->mmap_addr
) + ds_file
->request_offset
;
167 ds_file
->request_offset
+= *buffer_sz
;
171 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
178 struct bt_ctf_stream
*medop_get_stream(
179 struct bt_ctf_stream_class
*stream_class
, void *data
)
181 struct ctf_fs_ds_file
*ds_file
= data
;
182 struct bt_ctf_stream_class
*ds_file_stream_class
;
183 struct bt_ctf_stream
*stream
= NULL
;
185 ds_file_stream_class
= bt_ctf_stream_get_class(ds_file
->stream
);
186 bt_put(ds_file_stream_class
);
188 if (stream_class
!= ds_file_stream_class
) {
190 * Not supported: two packets described by two different
191 * stream classes within the same data stream file.
196 stream
= ds_file
->stream
;
203 struct bt_ctf_notif_iter_medium_ops ctf_fs_ds_file_medops
= {
204 .request_bytes
= medop_request_bytes
,
205 .get_stream
= medop_get_stream
,
209 struct ctf_fs_ds_index
*ctf_fs_ds_index_create(size_t length
)
211 struct ctf_fs_ds_index
*index
= g_new0(struct ctf_fs_ds_index
, 1);
214 BT_LOGE_STR("Failed to allocate index");
218 index
->entries
= g_array_sized_new(FALSE
, TRUE
,
219 sizeof(struct ctf_fs_ds_index_entry
), length
);
220 if (!index
->entries
) {
221 BT_LOGE("Failed to allocate %zu index entries.", length
);
224 g_array_set_size(index
->entries
, length
);
228 ctf_fs_ds_index_destroy(index
);
233 struct bt_ctf_clock_class
*get_field_mapped_clock_class(
234 struct bt_ctf_field
*field
)
236 struct bt_ctf_field_type
*field_type
;
237 struct bt_ctf_clock_class
*clock_class
= NULL
;
239 field_type
= bt_ctf_field_get_type(field
);
244 clock_class
= bt_ctf_field_type_integer_get_mapped_clock_class(
255 int get_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file
*ds_file
,
256 struct bt_ctf_clock_class
**_timestamp_begin_cc
,
257 struct bt_ctf_clock_class
**_timestamp_end_cc
)
260 struct bt_ctf_field
*timestamp_field
= NULL
;
261 struct bt_ctf_field
*packet_context_field
= NULL
;
262 struct bt_ctf_clock_class
*timestamp_begin_cc
= NULL
;
263 struct bt_ctf_clock_class
*timestamp_end_cc
= NULL
;
265 ret
= ctf_fs_ds_file_get_packet_header_context_fields(ds_file
,
266 NULL
, &packet_context_field
);
267 if (ret
|| !packet_context_field
) {
268 BT_LOGD("Cannot retrieve packet context field of stream \'%s\'",
269 ds_file
->file
->path
->str
);
274 timestamp_field
= bt_ctf_field_structure_get_field_by_name(
275 packet_context_field
, "timestamp_begin");
276 if (!timestamp_field
) {
277 BT_LOGD("Cannot retrieve timestamp_begin field in packet context of stream \'%s\'",
278 ds_file
->file
->path
->str
);
283 timestamp_begin_cc
= get_field_mapped_clock_class(timestamp_field
);
284 if (!timestamp_begin_cc
) {
285 BT_LOGD("Cannot retrieve the clock mapped to timestamp_begin of stream \'%s\'",
286 ds_file
->file
->path
->str
);
288 BT_PUT(timestamp_field
);
290 timestamp_field
= bt_ctf_field_structure_get_field_by_name(
291 packet_context_field
, "timestamp_end");
292 if (!timestamp_field
) {
293 BT_LOGD("Cannot retrieve timestamp_end field in packet context of stream \'%s\'",
294 ds_file
->file
->path
->str
);
299 timestamp_end_cc
= get_field_mapped_clock_class(timestamp_field
);
300 if (!timestamp_end_cc
) {
301 BT_LOGD("Cannot retrieve the clock mapped to timestamp_end in stream \'%s\'",
302 ds_file
->file
->path
->str
);
305 if (_timestamp_begin_cc
) {
306 *_timestamp_begin_cc
= bt_get(timestamp_begin_cc
);
308 if (_timestamp_end_cc
) {
309 *_timestamp_end_cc
= bt_get(timestamp_end_cc
);
312 bt_put(packet_context_field
);
313 bt_put(timestamp_field
);
314 bt_put(timestamp_begin_cc
);
315 bt_put(timestamp_end_cc
);
320 int convert_cycles_to_ns(struct bt_ctf_clock_class
*clock_class
,
321 uint64_t cycles
, int64_t *ns
)
324 struct bt_ctf_clock_value
*clock_value
;
327 clock_value
= bt_ctf_clock_value_create(clock_class
, cycles
);
333 ret
= bt_ctf_clock_value_get_value_ns_from_epoch(clock_value
, ns
);
343 struct ctf_fs_ds_index
*build_index_from_idx_file(
344 struct ctf_fs_ds_file
*ds_file
)
347 gchar
*directory
= NULL
;
348 gchar
*basename
= NULL
;
349 GString
*index_basename
= NULL
;
350 gchar
*index_file_path
= NULL
;
351 GMappedFile
*mapped_file
= NULL
;
353 const char *mmap_begin
= NULL
, *file_pos
= NULL
;
354 const struct ctf_packet_index_file_hdr
*header
= NULL
;
355 struct ctf_fs_ds_index
*index
= NULL
;
356 struct ctf_fs_ds_index_entry
*index_entry
= NULL
;
357 uint64_t total_packets_size
= 0;
358 size_t file_index_entry_size
;
359 size_t file_entry_count
;
361 struct bt_ctf_clock_class
*timestamp_begin_cc
= NULL
;
362 struct bt_ctf_clock_class
*timestamp_end_cc
= NULL
;
364 BT_LOGD("Building index from .idx file of stream file %s",
365 ds_file
->file
->path
->str
);
367 ret
= get_ds_file_packet_bounds_clock_classes(ds_file
,
368 ×tamp_begin_cc
, ×tamp_end_cc
);
370 BT_LOGD("Cannot get clock classes of \"timestamp_begin\" and \"timestamp_end\" fields");
374 /* Look for index file in relative path index/name.idx. */
375 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
377 BT_LOGE("Cannot get the basename of datastream file %s",
378 ds_file
->file
->path
->str
);
382 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
384 BT_LOGE("Cannot get dirname of datastream file %s",
385 ds_file
->file
->path
->str
);
389 index_basename
= g_string_new(basename
);
390 if (!index_basename
) {
391 BT_LOGE("Cannot allocate index file basename string");
395 g_string_append(index_basename
, ".idx");
396 index_file_path
= g_build_filename(directory
, "index",
397 index_basename
->str
, NULL
);
398 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
400 BT_LOGD("Cannot create new mapped file %s",
406 * The g_mapped_file API limits us to 4GB files on 32-bit.
407 * Traces with such large indexes have never been seen in the wild,
408 * but this would need to be adjusted to support them.
410 filesize
= g_mapped_file_get_length(mapped_file
);
411 if (filesize
< sizeof(*header
)) {
412 BT_LOGW("Invalid LTTng trace index file: "
413 "file size (%zu bytes) < header size (%zu bytes)",
414 filesize
, sizeof(*header
));
418 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
419 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
421 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
422 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
423 BT_LOGW("Invalid LTTng trace index: \"magic\" field validation failed");
427 file_index_entry_size
= be32toh(header
->packet_index_len
);
428 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
429 if ((filesize
- sizeof(*header
)) % file_index_entry_size
) {
430 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
431 "(%zu bytes) is not a multiple of the index entry size "
432 "(%zu bytes)", (filesize
- sizeof(*header
)),
437 index
= ctf_fs_ds_index_create(file_entry_count
);
442 index_entry
= (struct ctf_fs_ds_index_entry
*) &g_array_index(
443 index
->entries
, struct ctf_fs_ds_index_entry
, 0);
444 for (i
= 0; i
< file_entry_count
; i
++) {
445 struct ctf_packet_index
*file_index
=
446 (struct ctf_packet_index
*) file_pos
;
447 uint64_t packet_size
= be64toh(file_index
->packet_size
);
449 if (packet_size
% CHAR_BIT
) {
450 BT_LOGW("Invalid packet size encountered in LTTng trace index file");
454 /* Convert size in bits to bytes. */
455 packet_size
/= CHAR_BIT
;
456 index_entry
->packet_size
= packet_size
;
458 index_entry
->offset
= be64toh(file_index
->offset
);
459 if (i
!= 0 && index_entry
->offset
< (index_entry
- 1)->offset
) {
460 BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
461 "previous offset=%" PRIu64
", current offset=%" PRIu64
,
462 (index_entry
- 1)->offset
, index_entry
->offset
);
466 index_entry
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
467 index_entry
->timestamp_end
= be64toh(file_index
->timestamp_end
);
468 if (index_entry
->timestamp_end
< index_entry
->timestamp_begin
) {
469 BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
470 "timestamp_begin=%" PRIu64
"timestamp_end=%" PRIu64
,
471 index_entry
->timestamp_begin
,
472 index_entry
->timestamp_end
);
476 /* Convert the packet's bound to nanoseconds since Epoch. */
477 ret
= convert_cycles_to_ns(timestamp_begin_cc
,
478 index_entry
->timestamp_begin
,
479 &index_entry
->timestamp_begin_ns
);
481 BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
484 ret
= convert_cycles_to_ns(timestamp_end_cc
,
485 index_entry
->timestamp_end
,
486 &index_entry
->timestamp_end_ns
);
488 BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
492 total_packets_size
+= packet_size
;
493 file_pos
+= file_index_entry_size
;
497 /* Validate that the index addresses the complete stream. */
498 if (ds_file
->file
->size
!= total_packets_size
) {
499 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
500 "file_size=%" PRIu64
", total_packets_size=%" PRIu64
,
501 ds_file
->file
->size
, total_packets_size
);
507 g_free(index_file_path
);
508 if (index_basename
) {
509 g_string_free(index_basename
, TRUE
);
512 g_mapped_file_unref(mapped_file
);
514 bt_put(timestamp_begin_cc
);
515 bt_put(timestamp_end_cc
);
518 ctf_fs_ds_index_destroy(index
);
524 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
525 struct ctf_fs_trace
*ctf_fs_trace
,
526 struct bt_ctf_notif_iter
*notif_iter
,
527 struct bt_ctf_stream
*stream
, const char *path
)
530 const size_t page_size
= bt_common_get_page_size();
531 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
537 ds_file
->file
= ctf_fs_file_create();
538 if (!ds_file
->file
) {
542 ds_file
->stream
= bt_get(stream
);
543 ds_file
->cc_prio_map
= bt_get(ctf_fs_trace
->cc_prio_map
);
544 g_string_assign(ds_file
->file
->path
, path
);
545 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
550 ds_file
->notif_iter
= notif_iter
;
551 bt_ctf_notif_iter_set_medops_data(ds_file
->notif_iter
, ds_file
);
552 if (!ds_file
->notif_iter
) {
556 ds_file
->mmap_max_len
= page_size
* 2048;
561 /* Do not touch "borrowed" file. */
562 ctf_fs_ds_file_destroy(ds_file
);
570 struct ctf_fs_ds_index
*ctf_fs_ds_file_build_index(
571 struct ctf_fs_ds_file
*ds_file
)
573 return build_index_from_idx_file(ds_file
);
577 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
583 bt_put(ds_file
->cc_prio_map
);
584 bt_put(ds_file
->stream
);
585 (void) ds_file_munmap(ds_file
);
588 ctf_fs_file_destroy(ds_file
->file
);
595 struct bt_notification_iterator_next_return
ctf_fs_ds_file_next(
596 struct ctf_fs_ds_file
*ds_file
)
598 enum bt_ctf_notif_iter_status notif_iter_status
;
599 struct bt_notification_iterator_next_return ret
= {
600 .status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
,
601 .notification
= NULL
,
604 notif_iter_status
= bt_ctf_notif_iter_get_next_notification(
605 ds_file
->notif_iter
, ds_file
->cc_prio_map
, &ret
.notification
);
607 switch (notif_iter_status
) {
608 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
609 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
611 case BT_CTF_NOTIF_ITER_STATUS_OK
:
612 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
614 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
616 * Should not make it this far as this is
617 * medium-specific; there is nothing for the user to do
618 * and it should have been handled upstream.
621 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
622 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
624 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
632 int ctf_fs_ds_file_get_packet_header_context_fields(
633 struct ctf_fs_ds_file
*ds_file
,
634 struct bt_ctf_field
**packet_header_field
,
635 struct bt_ctf_field
**packet_context_field
)
637 enum bt_ctf_notif_iter_status notif_iter_status
;
641 notif_iter_status
= bt_ctf_notif_iter_get_packet_header_context_fields(
642 ds_file
->notif_iter
, packet_header_field
, packet_context_field
);
643 switch (notif_iter_status
) {
644 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
645 case BT_CTF_NOTIF_ITER_STATUS_OK
:
647 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
649 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
650 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
661 if (packet_header_field
) {
662 bt_put(*packet_header_field
);
665 if (packet_context_field
) {
666 bt_put(*packet_context_field
);
674 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index
*index
)
680 if (index
->entries
) {
681 g_array_free(index
->entries
, TRUE
);