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/ctf-ir/stream.h>
34 #include <babeltrace/graph/notification-iterator.h>
35 #include <babeltrace/graph/notification-stream.h>
36 #include <babeltrace/graph/notification-event.h>
37 #include <babeltrace/graph/notification-packet.h>
40 #include "../common/notif-iter/notif-iter.h"
42 #include "data-stream-file.h"
44 #define PRINT_ERR_STREAM ctf_fs->error_fp
45 #define PRINT_PREFIX "ctf-fs-data-stream"
46 #define PRINT_DBG_CHECK ctf_fs_debug
50 size_t remaining_mmap_bytes(struct ctf_fs_ds_file
*ds_file
)
52 return ds_file
->mmap_valid_len
- ds_file
->request_offset
;
56 int ds_file_munmap(struct ctf_fs_ds_file
*ds_file
)
59 struct ctf_fs_component
*ctf_fs
;
61 if (!ds_file
|| !ds_file
->mmap_addr
) {
65 ctf_fs
= ds_file
->file
->ctf_fs
;
66 if (munmap(ds_file
->mmap_addr
, ds_file
->mmap_len
)) {
67 PERR("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s\n",
68 ds_file
->mmap_addr
, ds_file
->mmap_len
,
69 ds_file
->file
->path
->str
, ds_file
->file
->fp
,
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
;
87 struct ctf_fs_component
*ctf_fs
= ds_file
->file
->ctf_fs
;
89 /* Unmap old region */
90 if (ds_file
->mmap_addr
) {
91 if (ds_file_munmap(ds_file
)) {
95 ds_file
->mmap_offset
+= ds_file
->mmap_valid_len
;
96 ds_file
->request_offset
= 0;
99 ds_file
->mmap_valid_len
= MIN(ds_file
->file
->size
- ds_file
->mmap_offset
,
100 ds_file
->mmap_max_len
);
101 if (ds_file
->mmap_valid_len
== 0) {
102 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
105 /* Round up to next page, assuming page size being a power of 2. */
106 ds_file
->mmap_len
= (ds_file
->mmap_valid_len
+ ctf_fs
->page_size
- 1)
107 & ~(ctf_fs
->page_size
- 1);
109 assert(ds_file
->mmap_len
);
110 ds_file
->mmap_addr
= mmap((void *) 0, ds_file
->mmap_len
,
111 PROT_READ
, MAP_PRIVATE
, fileno(ds_file
->file
->fp
),
112 ds_file
->mmap_offset
);
113 if (ds_file
->mmap_addr
== MAP_FAILED
) {
114 PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
115 ds_file
->mmap_len
, ds_file
->file
->path
->str
,
116 ds_file
->file
->fp
, ds_file
->mmap_offset
,
123 ds_file_munmap(ds_file
);
124 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
130 enum bt_ctf_notif_iter_medium_status
medop_request_bytes(
131 size_t request_sz
, uint8_t **buffer_addr
,
132 size_t *buffer_sz
, void *data
)
134 enum bt_ctf_notif_iter_medium_status status
=
135 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
136 struct ctf_fs_ds_file
*ds_file
= data
;
137 struct ctf_fs_component
*ctf_fs
= ds_file
->file
->ctf_fs
;
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 PDBG("Reached end of file \"%s\" (%p)\n",
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 PERR("Cannot memory-map next region of file \"%s\" (%p)\n",
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
, void *data
)
183 struct ctf_fs_ds_file
*ds_file
= data
;
184 struct bt_ctf_stream_class
*ds_file_stream_class
;
185 struct bt_ctf_stream
*stream
= NULL
;
187 ds_file_stream_class
= bt_ctf_stream_get_class(ds_file
->stream
);
188 bt_put(ds_file_stream_class
);
190 if (stream_class
!= ds_file_stream_class
) {
192 * Not supported: two packets described by two different
193 * stream classes within the same data stream file.
198 stream
= ds_file
->stream
;
204 static struct bt_ctf_notif_iter_medium_ops medops
= {
205 .request_bytes
= medop_request_bytes
,
206 .get_stream
= medop_get_stream
,
210 int build_index_from_idx_file(struct ctf_fs_ds_file
*ds_file
)
213 gchar
*directory
= NULL
;
214 gchar
*basename
= NULL
;
215 GString
*index_basename
= NULL
;
216 gchar
*index_file_path
= NULL
;
217 GMappedFile
*mapped_file
= NULL
;
219 const struct ctf_packet_index_file_hdr
*header
;
220 const char *mmap_begin
, *file_pos
;
221 struct index_entry
*index
;
222 uint64_t total_packets_size
= 0;
223 size_t file_index_entry_size
;
224 size_t file_entry_count
;
227 /* Look for index file in relative path index/name.idx. */
228 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
234 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
240 index_basename
= g_string_new(basename
);
241 if (!index_basename
) {
246 g_string_append(index_basename
, ".idx");
247 index_file_path
= g_build_filename(directory
, "index",
248 index_basename
->str
, NULL
);
249 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
254 filesize
= g_mapped_file_get_length(mapped_file
);
255 if (filesize
< sizeof(*header
)) {
256 printf_error("Invalid LTTng trace index: file size < header size");
261 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
262 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
264 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
265 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
266 printf_error("Invalid LTTng trace index: \"magic\" validation failed");
271 file_index_entry_size
= be32toh(header
->packet_index_len
);
272 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
273 if ((filesize
- sizeof(*header
)) % (file_entry_count
* file_index_entry_size
)) {
274 printf_error("Invalid index file size; not a multiple of index entry size");
279 ds_file
->index
.entries
= g_array_sized_new(FALSE
, TRUE
,
280 sizeof(struct index_entry
), file_entry_count
);
281 if (!ds_file
->index
.entries
) {
285 index
= (struct index_entry
*) ds_file
->index
.entries
->data
;
286 for (i
= 0; i
< file_entry_count
; i
++) {
287 struct ctf_packet_index
*file_index
=
288 (struct ctf_packet_index
*) file_pos
;
289 uint64_t packet_size
= be64toh(file_index
->packet_size
);
291 if (packet_size
% CHAR_BIT
) {
293 printf_error("Invalid packet size encountered in index file");
297 /* Convert size in bits to bytes. */
298 packet_size
/= CHAR_BIT
;
299 index
->packet_size
= packet_size
;
301 index
->offset
= be64toh(file_index
->offset
);
302 if (i
!= 0 && index
->offset
< (index
- 1)->offset
) {
303 printf_error("Invalid, non-monotonic, packet offset encountered in index file");
308 index
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
309 index
->timestamp_end
= be64toh(file_index
->timestamp_end
);
310 if (index
->timestamp_end
< index
->timestamp_begin
) {
311 printf_error("Invalid packet time bounds encountered in index file");
316 total_packets_size
+= packet_size
;
317 file_pos
+= file_index_entry_size
;
321 /* Validate that the index addresses the complete stream. */
322 if (ds_file
->file
->size
!= total_packets_size
) {
323 printf_error("Invalid index; indexed size != stream file size");
330 g_free(index_file_path
);
331 if (index_basename
) {
332 g_string_free(index_basename
, TRUE
);
335 g_mapped_file_unref(mapped_file
);
339 g_array_free(ds_file
->index
.entries
, TRUE
);
344 int build_index_from_data_stream_file(struct ctf_fs_ds_file
*stream
)
350 int init_stream_index(struct ctf_fs_ds_file
*ds_file
)
354 ret
= build_index_from_idx_file(ds_file
);
359 ret
= build_index_from_data_stream_file(ds_file
);
365 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
366 struct ctf_fs_trace
*ctf_fs_trace
,
367 struct bt_ctf_stream
*stream
, const char *path
,
371 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
377 ds_file
->file
= ctf_fs_file_create(ctf_fs_trace
->ctf_fs
);
378 if (!ds_file
->file
) {
382 ds_file
->stream
= bt_get(stream
);
383 ds_file
->cc_prio_map
= bt_get(ctf_fs_trace
->cc_prio_map
);
384 g_string_assign(ds_file
->file
->path
, path
);
385 ret
= ctf_fs_file_open(ctf_fs_trace
->ctf_fs
, ds_file
->file
, "rb");
390 ds_file
->notif_iter
= bt_ctf_notif_iter_create(
391 ctf_fs_trace
->metadata
->trace
,
392 ctf_fs_trace
->ctf_fs
->page_size
, medops
, ds_file
,
393 ctf_fs_trace
->ctf_fs
->error_fp
);
394 if (!ds_file
->notif_iter
) {
398 ds_file
->mmap_max_len
= ctf_fs_trace
->ctf_fs
->page_size
* 2048;
401 ret
= init_stream_index(ds_file
);
410 /* Do not touch "borrowed" file. */
411 ctf_fs_ds_file_destroy(ds_file
);
419 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
425 bt_put(ds_file
->cc_prio_map
);
426 bt_put(ds_file
->stream
);
427 (void) ds_file_munmap(ds_file
);
430 ctf_fs_file_destroy(ds_file
->file
);
433 if (ds_file
->notif_iter
) {
434 bt_ctf_notif_iter_destroy(ds_file
->notif_iter
);
437 if (ds_file
->index
.entries
) {
438 g_array_free(ds_file
->index
.entries
, TRUE
);
445 struct bt_notification_iterator_next_return
ctf_fs_ds_file_next(
446 struct ctf_fs_ds_file
*ds_file
)
448 enum bt_ctf_notif_iter_status notif_iter_status
;
449 struct bt_notification_iterator_next_return ret
= {
450 .status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
,
451 .notification
= NULL
,
454 notif_iter_status
= bt_ctf_notif_iter_get_next_notification(
455 ds_file
->notif_iter
, ds_file
->cc_prio_map
, &ret
.notification
);
457 switch (notif_iter_status
) {
458 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
459 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
461 case BT_CTF_NOTIF_ITER_STATUS_OK
:
462 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
464 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
466 * Should not make it this far as this is
467 * medium-specific; there is nothing for the user to do
468 * and it should have been handled upstream.
471 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
472 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
474 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
482 int ctf_fs_ds_file_get_packet_header_context_fields(
483 struct ctf_fs_trace
*ctf_fs_trace
, const char *path
,
484 struct bt_ctf_field
**packet_header_field
,
485 struct bt_ctf_field
**packet_context_field
)
487 enum bt_ctf_notif_iter_status notif_iter_status
;
488 struct ctf_fs_ds_file
*ds_file
;
491 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, false);
496 notif_iter_status
= bt_ctf_notif_iter_get_packet_header_context_fields(
497 ds_file
->notif_iter
, packet_header_field
, packet_context_field
);
498 switch (notif_iter_status
) {
499 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
500 case BT_CTF_NOTIF_ITER_STATUS_OK
:
502 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
504 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
505 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
516 if (packet_header_field
) {
517 bt_put(*packet_header_field
);
520 if (packet_context_field
) {
521 bt_put(*packet_context_field
);
525 ctf_fs_ds_file_destroy(ds_file
);