2 * Copyright 2016 - 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/ctf-ir/stream.h>
33 #include <babeltrace/graph/notification-iterator.h>
34 #include <babeltrace/graph/notification-stream.h>
35 #include <babeltrace/graph/notification-event.h>
36 #include <babeltrace/graph/notification-packet.h>
39 #include "../common/notif-iter/notif-iter.h"
41 #include "data-stream.h"
43 #define PRINT_ERR_STREAM ctf_fs->error_fp
44 #define PRINT_PREFIX "ctf-fs-data-stream"
45 #define PRINT_DBG_CHECK ctf_fs_debug
49 size_t remaining_mmap_bytes(struct ctf_fs_stream
*stream
)
51 return stream
->mmap_valid_len
- stream
->request_offset
;
55 int stream_munmap(struct ctf_fs_stream
*stream
)
58 struct ctf_fs_component
*ctf_fs
= stream
->file
->ctf_fs
;
60 if (munmap(stream
->mmap_addr
, stream
->mmap_len
)) {
61 PERR("Cannot memory-unmap address %p (size %zu) of file \"%s\" (%p): %s\n",
62 stream
->mmap_addr
, stream
->mmap_len
,
63 stream
->file
->path
->str
, stream
->file
->fp
,
73 enum bt_ctf_notif_iter_medium_status
mmap_next(struct ctf_fs_stream
*stream
)
75 enum bt_ctf_notif_iter_medium_status ret
=
76 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
77 struct ctf_fs_component
*ctf_fs
= stream
->file
->ctf_fs
;
79 /* Unmap old region */
80 if (stream
->mmap_addr
) {
81 if (stream_munmap(stream
)) {
85 stream
->mmap_offset
+= stream
->mmap_valid_len
;
86 stream
->request_offset
= 0;
89 stream
->mmap_valid_len
= MIN(stream
->file
->size
- stream
->mmap_offset
,
90 stream
->mmap_max_len
);
91 if (stream
->mmap_valid_len
== 0) {
92 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
95 /* Round up to next page, assuming page size being a power of 2. */
96 stream
->mmap_len
= (stream
->mmap_valid_len
+ ctf_fs
->page_size
- 1)
97 & ~(ctf_fs
->page_size
- 1);
99 assert(stream
->mmap_len
);
100 stream
->mmap_addr
= mmap((void *) 0, stream
->mmap_len
,
101 PROT_READ
, MAP_PRIVATE
, fileno(stream
->file
->fp
),
102 stream
->mmap_offset
);
103 if (stream
->mmap_addr
== MAP_FAILED
) {
104 PERR("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %zu: %s\n",
105 stream
->mmap_len
, stream
->file
->path
->str
,
106 stream
->file
->fp
, stream
->mmap_offset
,
113 stream_munmap(stream
);
114 ret
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
120 enum bt_ctf_notif_iter_medium_status
medop_request_bytes(
121 size_t request_sz
, uint8_t **buffer_addr
,
122 size_t *buffer_sz
, void *data
)
124 enum bt_ctf_notif_iter_medium_status status
=
125 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
;
126 struct ctf_fs_stream
*stream
= data
;
127 struct ctf_fs_component
*ctf_fs
= stream
->file
->ctf_fs
;
129 if (request_sz
== 0) {
133 /* Check if we have at least one memory-mapped byte left */
134 if (remaining_mmap_bytes(stream
) == 0) {
135 /* Are we at the end of the file? */
136 if (stream
->mmap_offset
>= stream
->file
->size
) {
137 PDBG("Reached end of file \"%s\" (%p)\n",
138 stream
->file
->path
->str
, stream
->file
->fp
);
139 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
;
143 status
= mmap_next(stream
);
145 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK
:
147 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF
:
150 PERR("Cannot memory-map next region of file \"%s\" (%p)\n",
151 stream
->file
->path
->str
,
157 *buffer_sz
= MIN(remaining_mmap_bytes(stream
), request_sz
);
158 *buffer_addr
= ((uint8_t *) stream
->mmap_addr
) + stream
->request_offset
;
159 stream
->request_offset
+= *buffer_sz
;
163 status
= BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR
;
170 struct bt_ctf_stream
*medop_get_stream(
171 struct bt_ctf_stream_class
*stream_class
, void *data
)
173 struct ctf_fs_stream
*fs_stream
= data
;
174 struct ctf_fs_component
*ctf_fs
= fs_stream
->file
->ctf_fs
;
176 if (!fs_stream
->stream
) {
177 int64_t id
= bt_ctf_stream_class_get_id(stream_class
);
179 PDBG("Creating stream out of stream class %" PRId64
"\n", id
);
180 fs_stream
->stream
= bt_ctf_stream_create(stream_class
,
181 fs_stream
->file
->path
->str
);
182 if (!fs_stream
->stream
) {
183 PERR("Cannot create stream (stream class %" PRId64
")\n",
188 return fs_stream
->stream
;
191 static struct bt_ctf_notif_iter_medium_ops medops
= {
192 .request_bytes
= medop_request_bytes
,
193 .get_stream
= medop_get_stream
,
197 int build_index_from_idx_file(struct ctf_fs_stream
*stream
)
200 gchar
*directory
= NULL
;
201 gchar
*basename
= NULL
;
202 GString
*index_basename
= NULL
;
203 gchar
*index_file_path
= NULL
;
204 GMappedFile
*mapped_file
= NULL
;
206 const struct ctf_packet_index_file_hdr
*header
;
207 const char *mmap_begin
, *file_pos
;
208 struct index_entry
*index
;
209 uint64_t total_packets_size
= 0;
210 size_t file_index_entry_size
;
211 size_t file_entry_count
;
214 /* Look for index file in relative path index/name.idx. */
215 basename
= g_path_get_basename(stream
->file
->path
->str
);
221 directory
= g_path_get_dirname(stream
->file
->path
->str
);
227 index_basename
= g_string_new(basename
);
228 if (!index_basename
) {
233 g_string_append(index_basename
, ".idx");
234 index_file_path
= g_build_filename(directory
, "index",
235 index_basename
->str
, NULL
);
236 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
241 filesize
= g_mapped_file_get_length(mapped_file
);
242 if (filesize
< sizeof(*header
)) {
243 printf_error("Invalid LTTng trace index: file size < header size");
248 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
249 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
251 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
252 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
253 printf_error("Invalid LTTng trace index: \"magic\" validation failed");
258 file_index_entry_size
= be32toh(header
->packet_index_len
);
259 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
260 if ((filesize
- sizeof(*header
)) % (file_entry_count
* file_index_entry_size
)) {
261 printf_error("Invalid index file size; not a multiple of index entry size");
266 stream
->index
.entries
= g_array_sized_new(FALSE
, TRUE
,
267 sizeof(struct index_entry
), file_entry_count
);
268 if (!stream
->index
.entries
) {
272 index
= (struct index_entry
*) stream
->index
.entries
->data
;
273 for (i
= 0; i
< file_entry_count
; i
++) {
274 struct ctf_packet_index
*file_index
=
275 (struct ctf_packet_index
*) file_pos
;
276 uint64_t packet_size
= be64toh(file_index
->packet_size
);
278 if (packet_size
% CHAR_BIT
) {
280 printf_error("Invalid packet size encountered in index file");
284 /* Convert size in bits to bytes. */
285 packet_size
/= CHAR_BIT
;
286 index
->packet_size
= packet_size
;
288 index
->offset
= be64toh(file_index
->offset
);
289 if (i
!= 0 && index
->offset
< (index
- 1)->offset
) {
290 printf_error("Invalid, non-monotonic, packet offset encountered in index file");
295 index
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
296 index
->timestamp_end
= be64toh(file_index
->timestamp_end
);
297 if (index
->timestamp_end
< index
->timestamp_begin
) {
298 printf_error("Invalid packet time bounds encountered in index file");
303 total_packets_size
+= packet_size
;
304 file_pos
+= file_index_entry_size
;
308 /* Validate that the index addresses the complete stream. */
309 if (stream
->file
->size
!= total_packets_size
) {
310 printf_error("Invalid index; indexed size != stream file size");
317 g_free(index_file_path
);
318 if (index_basename
) {
319 g_string_free(index_basename
, TRUE
);
322 g_mapped_file_unref(mapped_file
);
326 g_array_free(stream
->index
.entries
, TRUE
);
331 int build_index_from_stream(struct ctf_fs_stream
*stream
)
337 int init_stream_index(struct ctf_fs_stream
*stream
)
341 ret
= build_index_from_idx_file(stream
);
346 ret
= build_index_from_stream(stream
);
352 struct ctf_fs_stream
*ctf_fs_stream_create(
353 struct ctf_fs_component
*ctf_fs
, const char *path
)
356 struct ctf_fs_stream
*stream
= g_new0(struct ctf_fs_stream
, 1);
362 stream
->file
= ctf_fs_file_create(ctf_fs
);
367 stream
->cc_prio_map
= bt_get(ctf_fs
->cc_prio_map
);
368 g_string_assign(stream
->file
->path
, path
);
369 ret
= ctf_fs_file_open(ctf_fs
, stream
->file
, "rb");
374 stream
->notif_iter
= bt_ctf_notif_iter_create(ctf_fs
->metadata
->trace
,
375 ctf_fs
->page_size
, medops
, stream
,
377 if (!stream
->notif_iter
) {
381 stream
->mmap_max_len
= ctf_fs
->page_size
* 2048;
382 ret
= init_stream_index(stream
);
388 /* Do not touch "borrowed" file. */
389 ctf_fs_stream_destroy(stream
);
396 void ctf_fs_stream_destroy(struct ctf_fs_stream
*stream
)
402 bt_put(stream
->cc_prio_map
);
405 ctf_fs_file_destroy(stream
->file
);
408 if (stream
->stream
) {
409 BT_PUT(stream
->stream
);
412 if (stream
->notif_iter
) {
413 bt_ctf_notif_iter_destroy(stream
->notif_iter
);
416 if (stream
->index
.entries
) {
417 g_array_free(stream
->index
.entries
, TRUE
);
424 struct bt_notification_iterator_next_return
ctf_fs_stream_next(
425 struct ctf_fs_stream
*stream
)
427 enum bt_ctf_notif_iter_status notif_iter_status
;
428 struct bt_notification_iterator_next_return ret
= {
429 .status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
,
430 .notification
= NULL
,
433 if (stream
->end_reached
) {
434 notif_iter_status
= BT_CTF_NOTIF_ITER_STATUS_EOF
;
435 goto translate_status
;
438 notif_iter_status
= bt_ctf_notif_iter_get_next_notification(
439 stream
->notif_iter
, stream
->cc_prio_map
, &ret
.notification
);
440 if (notif_iter_status
!= BT_CTF_NOTIF_ITER_STATUS_OK
&&
441 notif_iter_status
!= BT_CTF_NOTIF_ITER_STATUS_EOF
) {
442 goto translate_status
;
445 /* Should be handled in bt_ctf_notif_iter_get_next_notification. */
446 if (notif_iter_status
== BT_CTF_NOTIF_ITER_STATUS_EOF
) {
447 ret
.notification
= bt_notification_stream_end_create(
449 if (!ret
.notification
) {
450 notif_iter_status
= BT_CTF_NOTIF_ITER_STATUS_ERROR
;
451 goto translate_status
;
454 notif_iter_status
= BT_CTF_NOTIF_ITER_STATUS_OK
;
455 stream
->end_reached
= true;
459 switch (notif_iter_status
) {
460 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
461 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
463 case BT_CTF_NOTIF_ITER_STATUS_OK
:
464 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
466 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
468 * Should not make it this far as this is
469 * medium-specific; there is nothing for the user to do
470 * and it should have been handled upstream.
473 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
474 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
476 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;