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 (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
= 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
;
202 static struct bt_ctf_notif_iter_medium_ops medops
= {
203 .request_bytes
= medop_request_bytes
,
204 .get_stream
= medop_get_stream
,
208 int build_index_from_idx_file(struct ctf_fs_ds_file
*ds_file
)
211 gchar
*directory
= NULL
;
212 gchar
*basename
= NULL
;
213 GString
*index_basename
= NULL
;
214 gchar
*index_file_path
= NULL
;
215 GMappedFile
*mapped_file
= NULL
;
217 const struct ctf_packet_index_file_hdr
*header
;
218 const char *mmap_begin
, *file_pos
;
219 struct index_entry
*index
;
220 uint64_t total_packets_size
= 0;
221 size_t file_index_entry_size
;
222 size_t file_entry_count
;
225 /* Look for index file in relative path index/name.idx. */
226 basename
= g_path_get_basename(ds_file
->file
->path
->str
);
228 BT_LOGE("Failed to get the basename of datastream file %s",
229 ds_file
->file
->path
->str
);
234 directory
= g_path_get_dirname(ds_file
->file
->path
->str
);
236 BT_LOGE("Failed to get dirname of datastream file %s",
237 ds_file
->file
->path
->str
);
242 index_basename
= g_string_new(basename
);
243 if (!index_basename
) {
244 BT_LOGE("Failed to allocate index file basename string");
249 g_string_append(index_basename
, ".idx");
250 index_file_path
= g_build_filename(directory
, "index",
251 index_basename
->str
, NULL
);
252 mapped_file
= g_mapped_file_new(index_file_path
, FALSE
, NULL
);
254 BT_LOGD("Failed to create new mapped file %s",
259 filesize
= g_mapped_file_get_length(mapped_file
);
260 if (filesize
< sizeof(*header
)) {
261 BT_LOGW("Invalid LTTng trace index file: file size < header size");
266 mmap_begin
= g_mapped_file_get_contents(mapped_file
);
267 header
= (struct ctf_packet_index_file_hdr
*) mmap_begin
;
269 file_pos
= g_mapped_file_get_contents(mapped_file
) + sizeof(*header
);
270 if (be32toh(header
->magic
) != CTF_INDEX_MAGIC
) {
271 BT_LOGW("Invalid LTTng trace index: \"magic\" validation failed");
276 file_index_entry_size
= be32toh(header
->packet_index_len
);
277 file_entry_count
= (filesize
- sizeof(*header
)) / file_index_entry_size
;
278 if ((filesize
- sizeof(*header
)) % (file_entry_count
* file_index_entry_size
)) {
279 BT_LOGW("Invalid index file size; not a multiple of index entry size");
284 ds_file
->index
.entries
= g_array_sized_new(FALSE
, TRUE
,
285 sizeof(struct index_entry
), file_entry_count
);
286 if (!ds_file
->index
.entries
) {
290 index
= (struct index_entry
*) ds_file
->index
.entries
->data
;
291 for (i
= 0; i
< file_entry_count
; i
++) {
292 struct ctf_packet_index
*file_index
=
293 (struct ctf_packet_index
*) file_pos
;
294 uint64_t packet_size
= be64toh(file_index
->packet_size
);
296 if (packet_size
% CHAR_BIT
) {
298 BT_LOGW("Invalid packet size encountered in index file");
302 /* Convert size in bits to bytes. */
303 packet_size
/= CHAR_BIT
;
304 index
->packet_size
= packet_size
;
306 index
->offset
= be64toh(file_index
->offset
);
307 if (i
!= 0 && index
->offset
< (index
- 1)->offset
) {
308 BT_LOGW("Invalid, non-monotonic, packet offset encountered in index file");
313 index
->timestamp_begin
= be64toh(file_index
->timestamp_begin
);
314 index
->timestamp_end
= be64toh(file_index
->timestamp_end
);
315 if (index
->timestamp_end
< index
->timestamp_begin
) {
316 BT_LOGW("Invalid packet time bounds encountered in index file");
321 total_packets_size
+= packet_size
;
322 file_pos
+= file_index_entry_size
;
326 /* Validate that the index addresses the complete stream. */
327 if (ds_file
->file
->size
!= total_packets_size
) {
328 BT_LOGW("Invalid index; indexed size != stream file size");
335 g_free(index_file_path
);
336 if (index_basename
) {
337 g_string_free(index_basename
, TRUE
);
340 g_mapped_file_unref(mapped_file
);
344 g_array_free(ds_file
->index
.entries
, TRUE
);
349 int build_index_from_data_stream_file(struct ctf_fs_ds_file
*stream
)
355 int init_stream_index(struct ctf_fs_ds_file
*ds_file
)
359 ret
= build_index_from_idx_file(ds_file
);
364 ret
= build_index_from_data_stream_file(ds_file
);
370 struct ctf_fs_ds_file
*ctf_fs_ds_file_create(
371 struct ctf_fs_trace
*ctf_fs_trace
,
372 struct bt_ctf_stream
*stream
, const char *path
,
376 const size_t page_size
= bt_common_get_page_size();
377 struct ctf_fs_ds_file
*ds_file
= g_new0(struct ctf_fs_ds_file
, 1);
383 ds_file
->file
= ctf_fs_file_create();
384 if (!ds_file
->file
) {
388 ds_file
->stream
= bt_get(stream
);
389 ds_file
->cc_prio_map
= bt_get(ctf_fs_trace
->cc_prio_map
);
390 g_string_assign(ds_file
->file
->path
, path
);
391 ret
= ctf_fs_file_open(ds_file
->file
, "rb");
396 ds_file
->notif_iter
= bt_ctf_notif_iter_create(
397 ctf_fs_trace
->metadata
->trace
, page_size
, medops
, ds_file
);
398 if (!ds_file
->notif_iter
) {
402 ds_file
->mmap_max_len
= page_size
* 2048;
405 ret
= init_stream_index(ds_file
);
414 /* Do not touch "borrowed" file. */
415 ctf_fs_ds_file_destroy(ds_file
);
423 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file
*ds_file
)
429 bt_put(ds_file
->cc_prio_map
);
430 bt_put(ds_file
->stream
);
431 (void) ds_file_munmap(ds_file
);
434 ctf_fs_file_destroy(ds_file
->file
);
437 if (ds_file
->notif_iter
) {
438 bt_ctf_notif_iter_destroy(ds_file
->notif_iter
);
441 if (ds_file
->index
.entries
) {
442 g_array_free(ds_file
->index
.entries
, TRUE
);
449 struct bt_notification_iterator_next_return
ctf_fs_ds_file_next(
450 struct ctf_fs_ds_file
*ds_file
)
452 enum bt_ctf_notif_iter_status notif_iter_status
;
453 struct bt_notification_iterator_next_return ret
= {
454 .status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
,
455 .notification
= NULL
,
458 notif_iter_status
= bt_ctf_notif_iter_get_next_notification(
459 ds_file
->notif_iter
, ds_file
->cc_prio_map
, &ret
.notification
);
461 switch (notif_iter_status
) {
462 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
463 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_END
;
465 case BT_CTF_NOTIF_ITER_STATUS_OK
:
466 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_OK
;
468 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
470 * Should not make it this far as this is
471 * medium-specific; there is nothing for the user to do
472 * and it should have been handled upstream.
475 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
476 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
478 ret
.status
= BT_NOTIFICATION_ITERATOR_STATUS_ERROR
;
486 int ctf_fs_ds_file_get_packet_header_context_fields(
487 struct ctf_fs_trace
*ctf_fs_trace
, const char *path
,
488 struct bt_ctf_field
**packet_header_field
,
489 struct bt_ctf_field
**packet_context_field
)
491 enum bt_ctf_notif_iter_status notif_iter_status
;
492 struct ctf_fs_ds_file
*ds_file
;
495 ds_file
= ctf_fs_ds_file_create(ctf_fs_trace
, NULL
, path
, false);
500 notif_iter_status
= bt_ctf_notif_iter_get_packet_header_context_fields(
501 ds_file
->notif_iter
, packet_header_field
, packet_context_field
);
502 switch (notif_iter_status
) {
503 case BT_CTF_NOTIF_ITER_STATUS_EOF
:
504 case BT_CTF_NOTIF_ITER_STATUS_OK
:
506 case BT_CTF_NOTIF_ITER_STATUS_AGAIN
:
508 case BT_CTF_NOTIF_ITER_STATUS_INVAL
:
509 case BT_CTF_NOTIF_ITER_STATUS_ERROR
:
520 if (packet_header_field
) {
521 bt_put(*packet_header_field
);
524 if (packet_context_field
) {
525 bt_put(*packet_context_field
);
529 ctf_fs_ds_file_destroy(ds_file
);