src.ctf.fs: bubble up `ctf_fs_ds_file_group_create()` error
[babeltrace.git] / plugins / ctf / fs-src / data-stream-file.c
CommitLineData
e98a2d6e 1/*
94cf822e 2 * Copyright 2016-2017 - Philippe Proulx <pproulx@efficios.com>
fc9a526c 3 * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
e98a2d6e
PP
4 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
5 *
e98a2d6e
PP
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:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
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
22 * SOFTWARE.
23 */
24
0fbb9a9f 25#include <stdlib.h>
e98a2d6e
PP
26#include <stdio.h>
27#include <stdint.h>
28#include <stdlib.h>
29#include <stdbool.h>
30#include <glib.h>
31#include <inttypes.h>
8f76831a 32#include <babeltrace/compat/mman-internal.h>
e9383dfd 33#include <babeltrace/endian-internal.h>
9d408fca 34#include <babeltrace/babeltrace.h>
55314f2a 35#include <babeltrace/common-internal.h>
78586d8a
JG
36#include "file.h"
37#include "metadata.h"
d6e69534 38#include "../common/msg-iter/msg-iter.h"
f6ccaed9 39#include <babeltrace/assert-internal.h>
94cf822e 40#include "data-stream-file.h"
e9383dfd 41#include <string.h>
e98a2d6e 42
55314f2a
JG
43#define BT_LOG_TAG "PLUGIN-CTF-FS-SRC-DS"
44#include "logging.h"
e98a2d6e 45
4f1f88a6 46static inline
94cf822e 47size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file)
e98a2d6e 48{
2c701ca6 49 return ds_file->mmap_len - ds_file->request_offset;
e98a2d6e
PP
50}
51
5b29e799 52static
94cf822e 53int ds_file_munmap(struct ctf_fs_ds_file *ds_file)
e98a2d6e 54{
fc9a526c 55 int ret = 0;
e98a2d6e 56
d238196d 57 if (!ds_file || !ds_file->mmap_addr) {
94cf822e
PP
58 goto end;
59 }
60
04394229 61 if (bt_munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
cd232764
JG
62 BT_LOGE_ERRNO("Cannot memory-unmap file",
63 ": address=%p, size=%zu, file_path=\"%s\", file=%p",
94cf822e 64 ds_file->mmap_addr, ds_file->mmap_len,
9e0c8dbb 65 ds_file->file ? ds_file->file->path->str : "NULL",
cd232764 66 ds_file->file ? ds_file->file->fp : NULL);
fc9a526c
JG
67 ret = -1;
68 goto end;
e98a2d6e 69 }
94cf822e
PP
70
71 ds_file->mmap_addr = NULL;
72
fc9a526c
JG
73end:
74 return ret;
e98a2d6e
PP
75}
76
5b29e799 77static
d6e69534 78enum bt_msg_iter_medium_status ds_file_mmap_next(
94cf822e 79 struct ctf_fs_ds_file *ds_file)
e98a2d6e 80{
d6e69534
PP
81 enum bt_msg_iter_medium_status ret =
82 BT_MSG_ITER_MEDIUM_STATUS_OK;
e98a2d6e
PP
83
84 /* Unmap old region */
94cf822e
PP
85 if (ds_file->mmap_addr) {
86 if (ds_file_munmap(ds_file)) {
e98a2d6e
PP
87 goto error;
88 }
89
2f5a009b 90 /*
2c701ca6 91 * mmap_len is guaranteed to be page-aligned except on the
2f5a009b
JG
92 * last mapping where it may not be possible (since the file's
93 * size itself may not be a page multiple).
94 */
2c701ca6 95 ds_file->mmap_offset += ds_file->mmap_len;
94cf822e 96 ds_file->request_offset = 0;
e98a2d6e
PP
97 }
98
2c701ca6 99 ds_file->mmap_len = MIN(ds_file->file->size - ds_file->mmap_offset,
94cf822e 100 ds_file->mmap_max_len);
2c701ca6 101 if (ds_file->mmap_len == 0) {
d6e69534 102 ret = BT_MSG_ITER_MEDIUM_STATUS_EOF;
e0f6a64a
JG
103 goto end;
104 }
e98a2d6e 105 /* Map new region */
f6ccaed9 106 BT_ASSERT(ds_file->mmap_len);
04394229 107 ds_file->mmap_addr = bt_mmap((void *) 0, ds_file->mmap_len,
94cf822e
PP
108 PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp),
109 ds_file->mmap_offset);
110 if (ds_file->mmap_addr == MAP_FAILED) {
1974687e 111 BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
94cf822e 112 ds_file->mmap_len, ds_file->file->path->str,
1974687e 113 ds_file->file->fp, (intmax_t) ds_file->mmap_offset,
78586d8a 114 strerror(errno));
e98a2d6e
PP
115 goto error;
116 }
117
118 goto end;
e98a2d6e 119error:
94cf822e 120 ds_file_munmap(ds_file);
d6e69534 121 ret = BT_MSG_ITER_MEDIUM_STATUS_ERROR;
e98a2d6e
PP
122end:
123 return ret;
124}
125
5b29e799 126static
d6e69534 127enum bt_msg_iter_medium_status medop_request_bytes(
e98a2d6e
PP
128 size_t request_sz, uint8_t **buffer_addr,
129 size_t *buffer_sz, void *data)
130{
d6e69534
PP
131 enum bt_msg_iter_medium_status status =
132 BT_MSG_ITER_MEDIUM_STATUS_OK;
94cf822e 133 struct ctf_fs_ds_file *ds_file = data;
e98a2d6e
PP
134
135 if (request_sz == 0) {
136 goto end;
137 }
138
e98a2d6e 139 /* Check if we have at least one memory-mapped byte left */
94cf822e 140 if (remaining_mmap_bytes(ds_file) == 0) {
e98a2d6e 141 /* Are we at the end of the file? */
94cf822e 142 if (ds_file->mmap_offset >= ds_file->file->size) {
55314f2a 143 BT_LOGD("Reached end of file \"%s\" (%p)",
94cf822e 144 ds_file->file->path->str, ds_file->file->fp);
d6e69534 145 status = BT_MSG_ITER_MEDIUM_STATUS_EOF;
e98a2d6e
PP
146 goto end;
147 }
148
94cf822e 149 status = ds_file_mmap_next(ds_file);
e0f6a64a 150 switch (status) {
d6e69534 151 case BT_MSG_ITER_MEDIUM_STATUS_OK:
e0f6a64a 152 break;
d6e69534 153 case BT_MSG_ITER_MEDIUM_STATUS_EOF:
e0f6a64a
JG
154 goto end;
155 default:
55314f2a 156 BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
94cf822e
PP
157 ds_file->file->path->str,
158 ds_file->file->fp);
e98a2d6e
PP
159 goto error;
160 }
161 }
162
94cf822e
PP
163 *buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz);
164 *buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset;
165 ds_file->request_offset += *buffer_sz;
e98a2d6e
PP
166 goto end;
167
168error:
d6e69534 169 status = BT_MSG_ITER_MEDIUM_STATUS_ERROR;
e98a2d6e
PP
170
171end:
172 return status;
173}
174
5b29e799 175static
fc917f65 176bt_stream *medop_borrow_stream(bt_stream_class *stream_class, int64_t stream_id,
b92735af 177 void *data)
e98a2d6e 178{
94cf822e 179 struct ctf_fs_ds_file *ds_file = data;
b19ff26f
PP
180 bt_stream_class *ds_file_stream_class;
181 bt_stream *stream = NULL;
e5be10ef 182
40f4ba76 183 ds_file_stream_class = bt_stream_borrow_class(
e5be10ef 184 ds_file->stream);
94cf822e 185
94cf822e
PP
186 if (stream_class != ds_file_stream_class) {
187 /*
188 * Not supported: two packets described by two different
189 * stream classes within the same data stream file.
190 */
191 goto end;
e98a2d6e
PP
192 }
193
94cf822e
PP
194 stream = ds_file->stream;
195
196end:
197 return stream;
e98a2d6e
PP
198}
199
9e0c8dbb 200static
fc917f65
PP
201enum bt_msg_iter_medium_status medop_seek(enum bt_msg_iter_seek_whence whence,
202 off_t offset, void *data)
9e0c8dbb 203{
d6e69534
PP
204 enum bt_msg_iter_medium_status ret =
205 BT_MSG_ITER_MEDIUM_STATUS_OK;
9e0c8dbb
JG
206 struct ctf_fs_ds_file *ds_file = data;
207 off_t file_size = ds_file->file->size;
208
d6e69534 209 if (whence != BT_MSG_ITER_SEEK_WHENCE_SET ||
9e0c8dbb
JG
210 offset < 0 || offset > file_size) {
211 BT_LOGE("Invalid medium seek request: whence=%d, offset=%jd, "
212 "file-size=%jd", (int) whence, offset,
213 file_size);
d6e69534 214 ret = BT_MSG_ITER_MEDIUM_STATUS_INVAL;
9e0c8dbb
JG
215 goto end;
216 }
217
218 /*
219 * Determine whether or not the destination is contained within the
220 * current mapping.
221 */
222 if (ds_file->mmap_addr && (offset < ds_file->mmap_offset ||
223 offset >= ds_file->mmap_offset + ds_file->mmap_len)) {
224 int unmap_ret;
225 off_t offset_in_mapping = offset % bt_common_get_page_size();
226
227 BT_LOGD("Medium seek request cannot be accomodated by the current "
63489ca2 228 "file mapping: offset=%jd, mmap-offset=%jd, "
9e0c8dbb
JG
229 "mmap-len=%zu", offset, ds_file->mmap_offset,
230 ds_file->mmap_len);
231 unmap_ret = ds_file_munmap(ds_file);
232 if (unmap_ret) {
d6e69534 233 ret = BT_MSG_ITER_MEDIUM_STATUS_ERROR;
9e0c8dbb
JG
234 goto end;
235 }
236
237 ds_file->mmap_offset = offset - offset_in_mapping;
238 ds_file->request_offset = offset_in_mapping;
239 ret = ds_file_mmap_next(ds_file);
d6e69534 240 if (ret != BT_MSG_ITER_MEDIUM_STATUS_OK) {
9e0c8dbb
JG
241 goto end;
242 }
243 } else {
244 ds_file->request_offset = offset - ds_file->mmap_offset;
245 }
246
247 ds_file->end_reached = (offset == file_size);
248end:
249 return ret;
250}
251
6de92955 252BT_HIDDEN
d6e69534 253struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops = {
e98a2d6e 254 .request_bytes = medop_request_bytes,
312c056a 255 .borrow_stream = medop_borrow_stream,
9e0c8dbb 256 .seek = medop_seek,
e98a2d6e 257};
6de92955 258
97ade20b
JG
259static
260struct ctf_fs_ds_index *ctf_fs_ds_index_create(size_t length)
261{
262 struct ctf_fs_ds_index *index = g_new0(struct ctf_fs_ds_index, 1);
263
264 if (!index) {
265 BT_LOGE_STR("Failed to allocate index");
266 goto error;
267 }
268
269 index->entries = g_array_sized_new(FALSE, TRUE,
270 sizeof(struct ctf_fs_ds_index_entry), length);
271 if (!index->entries) {
272 BT_LOGE("Failed to allocate %zu index entries.", length);
273 goto error;
274 }
275 g_array_set_size(index->entries, length);
276end:
277 return index;
278error:
279 ctf_fs_ds_index_destroy(index);
280 goto end;
281}
e98a2d6e 282
9e0c8dbb
JG
283/* Returns a new, zeroed, index entry. */
284static
285struct ctf_fs_ds_index_entry *ctf_fs_ds_index_add_new_entry(
286 struct ctf_fs_ds_index *index)
287{
288 g_array_set_size(index->entries, index->entries->len + 1);
289 return &g_array_index(index->entries, struct ctf_fs_ds_index_entry,
290 index->entries->len - 1);
291}
292
97ade20b 293static
0f2d58c9 294int convert_cycles_to_ns(struct ctf_clock_class *clock_class,
97ade20b 295 uint64_t cycles, int64_t *ns)
b6c3dcb2 296{
0f2d58c9
PP
297 return bt_util_clock_cycles_to_ns_from_origin(cycles,
298 clock_class->frequency, clock_class->offset_seconds,
299 clock_class->offset_cycles, ns);
97ade20b
JG
300}
301
302static
303struct ctf_fs_ds_index *build_index_from_idx_file(
304 struct ctf_fs_ds_file *ds_file)
305{
306 int ret;
b6c3dcb2
JG
307 gchar *directory = NULL;
308 gchar *basename = NULL;
309 GString *index_basename = NULL;
310 gchar *index_file_path = NULL;
311 GMappedFile *mapped_file = NULL;
312 gsize filesize;
97ade20b
JG
313 const char *mmap_begin = NULL, *file_pos = NULL;
314 const struct ctf_packet_index_file_hdr *header = NULL;
315 struct ctf_fs_ds_index *index = NULL;
316 struct ctf_fs_ds_index_entry *index_entry = NULL;
b6c3dcb2
JG
317 uint64_t total_packets_size = 0;
318 size_t file_index_entry_size;
319 size_t file_entry_count;
320 size_t i;
44c440bc 321 struct ctf_stream_class *sc;
d6e69534 322 struct bt_msg_iter_packet_properties props;
97ade20b
JG
323
324 BT_LOGD("Building index from .idx file of stream file %s",
325 ds_file->file->path->str);
41693723 326 ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props);
97ade20b 327 if (ret) {
41693723 328 BT_LOGD_STR("Cannot read first packet's header and context fields.");
44c440bc
PP
329 goto error;
330 }
331
44c440bc
PP
332 sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
333 props.stream_class_id);
334 BT_ASSERT(sc);
335 if (!sc->default_clock_class) {
336 BT_LOGD_STR("Cannot find stream class's default clock class.");
97ade20b
JG
337 goto error;
338 }
b6c3dcb2
JG
339
340 /* Look for index file in relative path index/name.idx. */
94cf822e 341 basename = g_path_get_basename(ds_file->file->path->str);
b6c3dcb2 342 if (!basename) {
97ade20b 343 BT_LOGE("Cannot get the basename of datastream file %s",
55314f2a 344 ds_file->file->path->str);
97ade20b 345 goto error;
b6c3dcb2
JG
346 }
347
94cf822e 348 directory = g_path_get_dirname(ds_file->file->path->str);
b6c3dcb2 349 if (!directory) {
97ade20b 350 BT_LOGE("Cannot get dirname of datastream file %s",
55314f2a 351 ds_file->file->path->str);
97ade20b 352 goto error;
b6c3dcb2
JG
353 }
354
355 index_basename = g_string_new(basename);
356 if (!index_basename) {
9e0c8dbb 357 BT_LOGE_STR("Cannot allocate index file basename string");
97ade20b 358 goto error;
b6c3dcb2
JG
359 }
360
361 g_string_append(index_basename, ".idx");
362 index_file_path = g_build_filename(directory, "index",
363 index_basename->str, NULL);
364 mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
06367fa3 365 if (!mapped_file) {
97ade20b 366 BT_LOGD("Cannot create new mapped file %s",
55314f2a 367 index_file_path);
97ade20b 368 goto error;
06367fa3 369 }
d14940a7
JG
370
371 /*
372 * The g_mapped_file API limits us to 4GB files on 32-bit.
373 * Traces with such large indexes have never been seen in the wild,
374 * but this would need to be adjusted to support them.
375 */
b6c3dcb2
JG
376 filesize = g_mapped_file_get_length(mapped_file);
377 if (filesize < sizeof(*header)) {
d14940a7
JG
378 BT_LOGW("Invalid LTTng trace index file: "
379 "file size (%zu bytes) < header size (%zu bytes)",
380 filesize, sizeof(*header));
97ade20b 381 goto error;
b6c3dcb2
JG
382 }
383
384 mmap_begin = g_mapped_file_get_contents(mapped_file);
385 header = (struct ctf_packet_index_file_hdr *) mmap_begin;
386
387 file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
388 if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
9e0c8dbb 389 BT_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
97ade20b 390 goto error;
b6c3dcb2 391 }
b6c3dcb2
JG
392
393 file_index_entry_size = be32toh(header->packet_index_len);
394 file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
97ade20b 395 if ((filesize - sizeof(*header)) % file_index_entry_size) {
d14940a7
JG
396 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
397 "(%zu bytes) is not a multiple of the index entry size "
398 "(%zu bytes)", (filesize - sizeof(*header)),
399 sizeof(*header));
97ade20b 400 goto error;
b6c3dcb2
JG
401 }
402
97ade20b
JG
403 index = ctf_fs_ds_index_create(file_entry_count);
404 if (!index) {
405 goto error;
b6c3dcb2 406 }
97ade20b
JG
407
408 index_entry = (struct ctf_fs_ds_index_entry *) &g_array_index(
409 index->entries, struct ctf_fs_ds_index_entry, 0);
b6c3dcb2
JG
410 for (i = 0; i < file_entry_count; i++) {
411 struct ctf_packet_index *file_index =
412 (struct ctf_packet_index *) file_pos;
413 uint64_t packet_size = be64toh(file_index->packet_size);
414
415 if (packet_size % CHAR_BIT) {
d14940a7 416 BT_LOGW("Invalid packet size encountered in LTTng trace index file");
97ade20b 417 goto error;
b6c3dcb2
JG
418 }
419
420 /* Convert size in bits to bytes. */
421 packet_size /= CHAR_BIT;
97ade20b 422 index_entry->packet_size = packet_size;
b6c3dcb2 423
97ade20b
JG
424 index_entry->offset = be64toh(file_index->offset);
425 if (i != 0 && index_entry->offset < (index_entry - 1)->offset) {
d14940a7
JG
426 BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
427 "previous offset=%" PRIu64 ", current offset=%" PRIu64,
428 (index_entry - 1)->offset, index_entry->offset);
97ade20b 429 goto error;
b6c3dcb2
JG
430 }
431
97ade20b
JG
432 index_entry->timestamp_begin = be64toh(file_index->timestamp_begin);
433 index_entry->timestamp_end = be64toh(file_index->timestamp_end);
434 if (index_entry->timestamp_end < index_entry->timestamp_begin) {
d14940a7
JG
435 BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
436 "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64,
437 index_entry->timestamp_begin,
438 index_entry->timestamp_end);
97ade20b
JG
439 goto error;
440 }
441
442 /* Convert the packet's bound to nanoseconds since Epoch. */
44c440bc 443 ret = convert_cycles_to_ns(sc->default_clock_class,
97ade20b
JG
444 index_entry->timestamp_begin,
445 &index_entry->timestamp_begin_ns);
446 if (ret) {
9e0c8dbb 447 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
97ade20b
JG
448 goto error;
449 }
44c440bc 450 ret = convert_cycles_to_ns(sc->default_clock_class,
97ade20b
JG
451 index_entry->timestamp_end,
452 &index_entry->timestamp_end_ns);
453 if (ret) {
9e0c8dbb 454 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
97ade20b 455 goto error;
b6c3dcb2
JG
456 }
457
458 total_packets_size += packet_size;
459 file_pos += file_index_entry_size;
97ade20b 460 index_entry++;
b6c3dcb2
JG
461 }
462
463 /* Validate that the index addresses the complete stream. */
94cf822e 464 if (ds_file->file->size != total_packets_size) {
d14940a7 465 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
9e0c8dbb 466 "file-size=%" PRIu64 ", total-packets-size=%" PRIu64,
d14940a7 467 ds_file->file->size, total_packets_size);
97ade20b 468 goto error;
b6c3dcb2
JG
469 }
470end:
471 g_free(directory);
472 g_free(basename);
473 g_free(index_file_path);
06367fa3
JG
474 if (index_basename) {
475 g_string_free(index_basename, TRUE);
476 }
477 if (mapped_file) {
478 g_mapped_file_unref(mapped_file);
479 }
97ade20b
JG
480 return index;
481error:
482 ctf_fs_ds_index_destroy(index);
483 index = NULL;
b6c3dcb2
JG
484 goto end;
485}
486
9e0c8dbb
JG
487static
488int init_index_entry(struct ctf_fs_ds_index_entry *entry,
44c440bc 489 struct ctf_fs_ds_file *ds_file,
d6e69534 490 struct bt_msg_iter_packet_properties *props,
44c440bc 491 off_t packet_size, off_t packet_offset)
9e0c8dbb 492{
ca79a87c 493 int ret = 0;
44c440bc 494 struct ctf_stream_class *sc;
9e0c8dbb 495
44c440bc
PP
496 sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
497 props->stream_class_id);
498 BT_ASSERT(sc);
f6ccaed9 499 BT_ASSERT(packet_offset >= 0);
9e0c8dbb 500 entry->offset = packet_offset;
f6ccaed9 501 BT_ASSERT(packet_size >= 0);
9e0c8dbb
JG
502 entry->packet_size = packet_size;
503
83ebb7f1
PP
504 if (props->snapshots.beginning_clock != UINT64_C(-1)) {
505 /* Convert the packet's bound to nanoseconds since Epoch. */
506 ret = convert_cycles_to_ns(sc->default_clock_class,
507 props->snapshots.beginning_clock,
508 &entry->timestamp_begin_ns);
509 if (ret) {
510 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
511 goto end;
512 }
513 } else {
514 entry->timestamp_begin_ns = UINT64_C(-1);
9e0c8dbb
JG
515 }
516
83ebb7f1
PP
517 if (props->snapshots.end_clock != UINT64_C(-1)) {
518 ret = convert_cycles_to_ns(sc->default_clock_class,
519 props->snapshots.end_clock,
520 &entry->timestamp_end_ns);
521 if (ret) {
522 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
523 goto end;
524 }
525 } else {
526 entry->timestamp_end_ns = UINT64_C(-1);
9e0c8dbb 527 }
0b29603d 528
9e0c8dbb 529end:
9e0c8dbb
JG
530 return ret;
531}
532
533static
534struct ctf_fs_ds_index *build_index_from_stream_file(
535 struct ctf_fs_ds_file *ds_file)
536{
537 int ret;
538 struct ctf_fs_ds_index *index = NULL;
9eb4d33d 539 enum bt_msg_iter_status iter_status = BT_MSG_ITER_STATUS_OK;
fc917f65 540 off_t current_packet_offset_bytes = 0;
9e0c8dbb
JG
541
542 BT_LOGD("Indexing stream file %s", ds_file->file->path->str);
543
544 index = ctf_fs_ds_index_create(0);
545 if (!index) {
546 goto error;
547 }
548
549 do {
44c440bc 550 off_t current_packet_size_bytes;
9e0c8dbb 551 struct ctf_fs_ds_index_entry *entry;
d6e69534 552 struct bt_msg_iter_packet_properties props;
9e0c8dbb 553
fc917f65
PP
554 if (current_packet_offset_bytes < 0) {
555 BT_LOGE_STR("Cannot get the current packet's offset.");
556 goto error;
557 } else if (current_packet_offset_bytes > ds_file->file->size) {
558 BT_LOGE_STR("Unexpected current packet's offset (larger than file).");
559 goto error;
560 } else if (current_packet_offset_bytes == ds_file->file->size) {
561 /* No more data */
562 break;
563 }
564
565 iter_status = bt_msg_iter_seek(ds_file->msg_iter,
566 current_packet_offset_bytes);
d6e69534 567 if (iter_status != BT_MSG_ITER_STATUS_OK) {
9e0c8dbb
JG
568 goto error;
569 }
312c056a 570
fc917f65
PP
571 iter_status = bt_msg_iter_get_packet_properties(
572 ds_file->msg_iter, &props);
573 if (iter_status != BT_MSG_ITER_STATUS_OK) {
9e0c8dbb
JG
574 goto error;
575 }
576
fc917f65
PP
577 if (props.exp_packet_total_size >= 0) {
578 current_packet_size_bytes =
579 (uint64_t) props.exp_packet_total_size / 8;
580 } else {
581 current_packet_size_bytes = ds_file->file->size;
582 }
9e0c8dbb 583
fc917f65 584 if (current_packet_offset_bytes + current_packet_size_bytes >
9e0c8dbb
JG
585 ds_file->file->size) {
586 BT_LOGW("Invalid packet size reported in file: stream=\"%s\", "
587 "packet-offset=%jd, packet-size-bytes=%jd, "
588 "file-size=%jd",
589 ds_file->file->path->str,
fc917f65 590 current_packet_offset_bytes,
9e0c8dbb
JG
591 current_packet_size_bytes,
592 ds_file->file->size);
593 goto error;
594 }
595
fc917f65 596 current_packet_offset_bytes += current_packet_size_bytes;
9e0c8dbb 597 BT_LOGD("Seeking to next packet: current-packet-offset=%jd, "
fc917f65
PP
598 "next-packet-offset=%jd",
599 current_packet_offset_bytes - current_packet_size_bytes,
600 current_packet_offset_bytes);
9e0c8dbb
JG
601 entry = ctf_fs_ds_index_add_new_entry(index);
602 if (!entry) {
603 BT_LOGE_STR("Failed to allocate a new index entry.");
604 goto error;
605 }
606
44c440bc 607 ret = init_index_entry(entry, ds_file, &props,
fc917f65 608 current_packet_size_bytes, current_packet_offset_bytes);
9e0c8dbb
JG
609 if (ret) {
610 goto error;
611 }
d6e69534 612 } while (iter_status == BT_MSG_ITER_STATUS_OK);
9e0c8dbb 613
60363f2f 614 if (iter_status != BT_MSG_ITER_STATUS_OK) {
9e0c8dbb
JG
615 goto error;
616 }
312c056a 617
9e0c8dbb 618end:
9e0c8dbb 619 return index;
312c056a 620
9e0c8dbb
JG
621error:
622 ctf_fs_ds_index_destroy(index);
623 index = NULL;
624 goto end;
625}
626
e7a4393b 627BT_HIDDEN
94cf822e
PP
628struct ctf_fs_ds_file *ctf_fs_ds_file_create(
629 struct ctf_fs_trace *ctf_fs_trace,
d6e69534
PP
630 bt_self_message_iterator *pc_msg_iter,
631 struct bt_msg_iter *msg_iter,
b19ff26f 632 bt_stream *stream, const char *path)
e98a2d6e 633{
b6c3dcb2 634 int ret;
55314f2a 635 const size_t page_size = bt_common_get_page_size();
94cf822e 636 struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
e98a2d6e 637
94cf822e 638 if (!ds_file) {
e98a2d6e
PP
639 goto error;
640 }
641
d6e69534 642 ds_file->pc_msg_iter = pc_msg_iter;
55314f2a 643 ds_file->file = ctf_fs_file_create();
94cf822e 644 if (!ds_file->file) {
4f1f88a6
PP
645 goto error;
646 }
647
398454ed 648 ds_file->stream = stream;
c5b9b441 649 bt_stream_get_ref(ds_file->stream);
44c440bc 650 ds_file->metadata = ctf_fs_trace->metadata;
94cf822e 651 g_string_assign(ds_file->file->path, path);
55314f2a 652 ret = ctf_fs_file_open(ds_file->file, "rb");
4f1f88a6
PP
653 if (ret) {
654 goto error;
655 }
656
d6e69534
PP
657 ds_file->msg_iter = msg_iter;
658 bt_msg_iter_set_medops_data(ds_file->msg_iter, ds_file);
659 if (!ds_file->msg_iter) {
e98a2d6e
PP
660 goto error;
661 }
5b29e799 662
55314f2a 663 ds_file->mmap_max_len = page_size * 2048;
94cf822e 664
e98a2d6e 665 goto end;
1a9f7075 666
e98a2d6e 667error:
78586d8a 668 /* Do not touch "borrowed" file. */
94cf822e
PP
669 ctf_fs_ds_file_destroy(ds_file);
670 ds_file = NULL;
1a9f7075 671
e98a2d6e 672end:
94cf822e 673 return ds_file;
e98a2d6e
PP
674}
675
97ade20b
JG
676BT_HIDDEN
677struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
678 struct ctf_fs_ds_file *ds_file)
679{
9e0c8dbb
JG
680 struct ctf_fs_ds_index *index;
681
682 index = build_index_from_idx_file(ds_file);
683 if (index) {
684 goto end;
685 }
686
687 BT_LOGD("Failed to build index from .index file; "
688 "falling back to stream indexing.");
689 index = build_index_from_stream_file(ds_file);
690end:
691 return index;
97ade20b
JG
692}
693
5b29e799 694BT_HIDDEN
94cf822e 695void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
e98a2d6e 696{
94cf822e 697 if (!ds_file) {
5b29e799 698 return;
043e2020
JG
699 }
700
c5b9b441 701 bt_stream_put_ref(ds_file->stream);
94cf822e 702 (void) ds_file_munmap(ds_file);
0982a26d 703
94cf822e
PP
704 if (ds_file->file) {
705 ctf_fs_file_destroy(ds_file->file);
e98a2d6e
PP
706 }
707
94cf822e 708 g_free(ds_file);
e98a2d6e 709}
4f1f88a6
PP
710
711BT_HIDDEN
13d42859 712bt_self_message_iterator_status ctf_fs_ds_file_next(
d4393e08 713 struct ctf_fs_ds_file *ds_file,
d6e69534 714 bt_message **msg)
4f1f88a6 715{
d6e69534 716 enum bt_msg_iter_status msg_iter_status;
13d42859 717 bt_self_message_iterator_status status;
4f1f88a6 718
d6e69534
PP
719 msg_iter_status = bt_msg_iter_get_next_message(
720 ds_file->msg_iter, ds_file->pc_msg_iter, msg);
4f1f88a6 721
d6e69534
PP
722 switch (msg_iter_status) {
723 case BT_MSG_ITER_STATUS_EOF:
13d42859 724 status = BT_SELF_MESSAGE_ITERATOR_STATUS_END;
4f1f88a6 725 break;
d6e69534 726 case BT_MSG_ITER_STATUS_OK:
13d42859 727 status = BT_SELF_MESSAGE_ITERATOR_STATUS_OK;
4f1f88a6 728 break;
d6e69534 729 case BT_MSG_ITER_STATUS_AGAIN:
4f1f88a6
PP
730 /*
731 * Should not make it this far as this is
732 * medium-specific; there is nothing for the user to do
733 * and it should have been handled upstream.
734 */
0fbb9a9f 735 abort();
d6e69534
PP
736 case BT_MSG_ITER_STATUS_INVAL:
737 case BT_MSG_ITER_STATUS_ERROR:
4f1f88a6 738 default:
13d42859 739 status = BT_SELF_MESSAGE_ITERATOR_STATUS_ERROR;
4f1f88a6
PP
740 break;
741 }
d4393e08 742 return status;
4f1f88a6 743}
94cf822e 744
97ade20b
JG
745BT_HIDDEN
746void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
747{
748 if (!index) {
749 return;
750 }
751
752 if (index->entries) {
753 g_array_free(index->entries, TRUE);
754 }
755 g_free(index);
756}
This page took 0.084576 seconds and 4 git commands to generate.