src/plugins/ctf/fs-src/data-stream-file.c

   1 /*
   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
   5  *
   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
  25 #define BT_COMP_LOG_SELF_COMP (self_comp)
  26 #define BT_LOG_OUTPUT_LEVEL (log_level)
  27 #define BT_LOG_TAG "PLUGIN/SRC.CTF.FS/DS"
  28 #include "logging/comp-logging.h"
  29
  30 #include <stdlib.h>
  31 #include <stdio.h>
  32 #include <stdint.h>
  33 #include <stdlib.h>
  34 #include <glib.h>
  35 #include <inttypes.h>
  36 #include "compat/mman.h"
  37 #include "compat/endian.h"
  38 #include <babeltrace2/babeltrace.h>
  39 #include "common/common.h"
  40 #include "file.h"
  41 #include "metadata.h"
  42 #include "../common/msg-iter/msg-iter.h"
  43 #include "common/assert.h"
  44 #include "data-stream-file.h"
  45 #include <string.h>
  46
  47 static inline
  48 size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file)
  49 {
  50         BT_ASSERT_DBG(ds_file->mmap_len >= ds_file->request_offset_in_mapping);
  51         return ds_file->mmap_len - ds_file->request_offset_in_mapping;
  52 }
  53
  54 static
  55 int ds_file_munmap(struct ctf_fs_ds_file *ds_file)
  56 {
  57         int ret = 0;
  58         bt_self_component *self_comp = ds_file->self_comp;
  59         bt_logging_level log_level = ds_file->log_level;
  60
  61         BT_ASSERT(ds_file);
  62
  63         if (!ds_file->mmap_addr) {
  64                 goto end;
  65         }
  66
  67         if (bt_munmap(ds_file->mmap_addr, ds_file->mmap_len)) {
  68                 BT_COMP_LOGE_ERRNO("Cannot memory-unmap file",
  69                         ": address=%p, size=%zu, file_path=\"%s\", file=%p",
  70                         ds_file->mmap_addr, ds_file->mmap_len,
  71                         ds_file->file ? ds_file->file->path->str : "NULL",
  72                         ds_file->file ? ds_file->file->fp : NULL);
  73                 ret = -1;
  74                 goto end;
  75         }
  76
  77         ds_file->mmap_addr = NULL;
  78
  79 end:
  80         return ret;
  81 }
  82
  83 static
  84 enum ctf_msg_iter_medium_status ds_file_mmap_next(
  85                 struct ctf_fs_ds_file *ds_file)
  86 {
  87         enum ctf_msg_iter_medium_status ret =
  88                         CTF_MSG_ITER_MEDIUM_STATUS_OK;
  89         bt_self_component *self_comp = ds_file->self_comp;
  90         bt_logging_level log_level = ds_file->log_level;
  91
  92         /* Unmap old region */
  93         if (ds_file->mmap_addr) {
  94                 if (ds_file_munmap(ds_file)) {
  95                         goto error;
  96                 }
  97
  98                 /*
  99                  * mmap_len is guaranteed to be page-aligned except on the
 100                  * last mapping where it may not be possible (since the file's
 101                  * size itself may not be a page multiple).
 102                  */
 103                 ds_file->mmap_offset_in_file += ds_file->mmap_len;
 104                 ds_file->request_offset_in_mapping = 0;
 105         }
 106
 107         ds_file->mmap_len = MIN(ds_file->file->size - ds_file->mmap_offset_in_file,
 108                         ds_file->mmap_max_len);
 109         if (ds_file->mmap_len == 0) {
 110                 ret = CTF_MSG_ITER_MEDIUM_STATUS_EOF;
 111                 goto end;
 112         }
 113         /* Map new region */
 114         BT_ASSERT(ds_file->mmap_len);
 115         ds_file->mmap_addr = bt_mmap((void *) 0, ds_file->mmap_len,
 116                         PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp),
 117                         ds_file->mmap_offset_in_file, ds_file->log_level);
 118         if (ds_file->mmap_addr == MAP_FAILED) {
 119                 BT_COMP_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
 120                                 ds_file->mmap_len, ds_file->file->path->str,
 121                                 ds_file->file->fp, (intmax_t) ds_file->mmap_offset_in_file,
 122                                 strerror(errno));
 123                 goto error;
 124         }
 125
 126         goto end;
 127 error:
 128         ret = CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
 129 end:
 130         return ret;
 131 }
 132
 133 static
 134 enum ctf_msg_iter_medium_status medop_request_bytes(
 135                 size_t request_sz, uint8_t **buffer_addr,
 136                 size_t *buffer_sz, void *data)
 137 {
 138         enum ctf_msg_iter_medium_status status =
 139                 CTF_MSG_ITER_MEDIUM_STATUS_OK;
 140         struct ctf_fs_ds_file *ds_file = data;
 141         bt_self_component *self_comp = ds_file->self_comp;
 142         bt_logging_level log_level = ds_file->log_level;
 143
 144         if (request_sz == 0) {
 145                 goto end;
 146         }
 147
 148         /*
 149          * Check if we have at least one memory-mapped byte left. If we don't,
 150          * mmap the next file.
 151          */
 152         if (remaining_mmap_bytes(ds_file) == 0) {
 153                 /* Are we at the end of the file? */
 154                 if (ds_file->mmap_offset_in_file >= ds_file->file->size) {
 155                         BT_COMP_LOGD("Reached end of file \"%s\" (%p)",
 156                                 ds_file->file->path->str, ds_file->file->fp);
 157                         status = CTF_MSG_ITER_MEDIUM_STATUS_EOF;
 158                         goto end;
 159                 }
 160
 161                 status = ds_file_mmap_next(ds_file);
 162                 switch (status) {
 163                 case CTF_MSG_ITER_MEDIUM_STATUS_OK:
 164                         break;
 165                 case CTF_MSG_ITER_MEDIUM_STATUS_EOF:
 166                         goto end;
 167                 default:
 168                         BT_COMP_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
 169                                         ds_file->file->path->str,
 170                                         ds_file->file->fp);
 171                         goto error;
 172                 }
 173         }
 174
 175         *buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz);
 176         BT_ASSERT(ds_file->mmap_addr);
 177         *buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset_in_mapping;
 178         ds_file->request_offset_in_mapping += *buffer_sz;
 179         goto end;
 180
 181 error:
 182         status = CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
 183
 184 end:
 185         return status;
 186 }
 187
 188 static
 189 bt_stream *medop_borrow_stream(bt_stream_class *stream_class, int64_t stream_id,
 190                 void *data)
 191 {
 192         struct ctf_fs_ds_file *ds_file = data;
 193         bt_stream_class *ds_file_stream_class;
 194         bt_stream *stream = NULL;
 195
 196         ds_file_stream_class = bt_stream_borrow_class(
 197                 ds_file->stream);
 198
 199         if (stream_class != ds_file_stream_class) {
 200                 /*
 201                  * Not supported: two packets described by two different
 202                  * stream classes within the same data stream file.
 203                  */
 204                 goto end;
 205         }
 206
 207         stream = ds_file->stream;
 208
 209 end:
 210         return stream;
 211 }
 212
 213 static
 214 enum ctf_msg_iter_medium_status medop_seek(enum ctf_msg_iter_seek_whence whence,
 215                 off_t offset, void *data)
 216 {
 217         enum ctf_msg_iter_medium_status ret =
 218                         CTF_MSG_ITER_MEDIUM_STATUS_OK;
 219         struct ctf_fs_ds_file *ds_file = data;
 220         off_t offset_in_mapping, file_size = ds_file->file->size;
 221         bt_self_component *self_comp = ds_file->self_comp;
 222         bt_logging_level log_level = ds_file->log_level;
 223
 224         if (whence != CTF_MSG_ITER_SEEK_WHENCE_SET ||
 225                 offset < 0 || offset > file_size) {
 226                 BT_COMP_LOGE("Invalid medium seek request: whence=%d, offset=%jd, "
 227                                 "file-size=%jd", (int) whence, (intmax_t) offset,
 228                                 (intmax_t) file_size);
 229                 ret = CTF_MSG_ITER_MEDIUM_STATUS_INVAL;
 230                 goto end;
 231         }
 232
 233         /* If there is no current mapping, map the right file directly. */
 234         if (!ds_file->mmap_addr) {
 235                 goto map_requested_offset;
 236         }
 237
 238         /*
 239          * Determine whether or not the destination is contained within the
 240          * current mapping.
 241          */
 242         if (offset < ds_file->mmap_offset_in_file ||
 243                         offset >= ds_file->mmap_offset_in_file + ds_file->mmap_len) {
 244                 int unmap_ret;
 245                 BT_COMP_LOGD("Medium seek request cannot be accomodated by the current "
 246                                 "file mapping: offset=%jd, mmap-offset=%jd, "
 247                                 "mmap-len=%zu", (intmax_t) offset, (intmax_t) ds_file->mmap_offset_in_file,
 248                                 ds_file->mmap_len);
 249                 unmap_ret = ds_file_munmap(ds_file);
 250                 if (unmap_ret) {
 251                         ret = CTF_MSG_ITER_MEDIUM_STATUS_ERROR;
 252                         goto end;
 253                 }
 254                 goto map_requested_offset;
 255         } else {
 256                 ds_file->request_offset_in_mapping = offset - ds_file->mmap_offset_in_file;
 257                 goto test_end;
 258         }
 259
 260 map_requested_offset:
 261         offset_in_mapping = offset %
 262                 bt_mmap_get_offset_align_size(ds_file->log_level);
 263
 264         ds_file->mmap_offset_in_file = offset - offset_in_mapping;
 265         ds_file->request_offset_in_mapping = offset_in_mapping;
 266         ret = ds_file_mmap_next(ds_file);
 267         if (ret != CTF_MSG_ITER_MEDIUM_STATUS_OK) {
 268                 goto end;
 269         }
 270
 271 test_end:
 272         ds_file->end_reached = (offset == file_size);
 273 end:
 274         return ret;
 275 }
 276
 277 BT_HIDDEN
 278 struct ctf_msg_iter_medium_ops ctf_fs_ds_file_medops = {
 279         .request_bytes = medop_request_bytes,
 280         .borrow_stream = medop_borrow_stream,
 281         .seek = medop_seek,
 282 };
 283
 284 static
 285 struct ctf_fs_ds_index_entry *ctf_fs_ds_index_entry_create(
 286                 bt_self_component *self_comp, bt_logging_level log_level)
 287 {
 288         struct ctf_fs_ds_index_entry *entry;
 289
 290         entry = g_new0(struct ctf_fs_ds_index_entry, 1);
 291         if (!entry) {
 292                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to allocate a ctf_fs_ds_index_entry.");
 293                 goto end;
 294         }
 295
 296         entry->packet_seq_num = UINT64_MAX;
 297
 298 end:
 299         return entry;
 300 }
 301
 302 static
 303 int convert_cycles_to_ns(struct ctf_clock_class *clock_class,
 304                 uint64_t cycles, int64_t *ns)
 305 {
 306         return bt_util_clock_cycles_to_ns_from_origin(cycles,
 307                         clock_class->frequency, clock_class->offset_seconds,
 308                         clock_class->offset_cycles, ns);
 309 }
 310
 311 static
 312 struct ctf_fs_ds_index *build_index_from_idx_file(
 313                 struct ctf_fs_ds_file *ds_file,
 314                 struct ctf_fs_ds_file_info *file_info,
 315                 struct ctf_msg_iter *msg_iter)
 316 {
 317         int ret;
 318         gchar *directory = NULL;
 319         gchar *basename = NULL;
 320         GString *index_basename = NULL;
 321         gchar *index_file_path = NULL;
 322         GMappedFile *mapped_file = NULL;
 323         gsize filesize;
 324         const char *mmap_begin = NULL, *file_pos = NULL;
 325         const struct ctf_packet_index_file_hdr *header = NULL;
 326         struct ctf_fs_ds_index *index = NULL;
 327         struct ctf_fs_ds_index_entry *index_entry = NULL, *prev_index_entry = NULL;
 328         uint64_t total_packets_size = 0;
 329         size_t file_index_entry_size;
 330         size_t file_entry_count;
 331         size_t i;
 332         struct ctf_stream_class *sc;
 333         struct ctf_msg_iter_packet_properties props;
 334         uint32_t version_major, version_minor;
 335         bt_self_component *self_comp = ds_file->self_comp;
 336         bt_logging_level log_level = ds_file->log_level;
 337
 338         BT_COMP_LOGI("Building index from .idx file of stream file %s",
 339                         ds_file->file->path->str);
 340         ret = ctf_msg_iter_get_packet_properties(msg_iter, &props);
 341         if (ret) {
 342                 BT_COMP_LOGI_STR("Cannot read first packet's header and context fields.");
 343                 goto error;
 344         }
 345
 346         sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
 347                 props.stream_class_id);
 348         BT_ASSERT(sc);
 349         if (!sc->default_clock_class) {
 350                 BT_COMP_LOGI_STR("Cannot find stream class's default clock class.");
 351                 goto error;
 352         }
 353
 354         /* Look for index file in relative path index/name.idx. */
 355         basename = g_path_get_basename(ds_file->file->path->str);
 356         if (!basename) {
 357                 BT_COMP_LOGE("Cannot get the basename of datastream file %s",
 358                                 ds_file->file->path->str);
 359                 goto error;
 360         }
 361
 362         directory = g_path_get_dirname(ds_file->file->path->str);
 363         if (!directory) {
 364                 BT_COMP_LOGE("Cannot get dirname of datastream file %s",
 365                                 ds_file->file->path->str);
 366                 goto error;
 367         }
 368
 369         index_basename = g_string_new(basename);
 370         if (!index_basename) {
 371                 BT_COMP_LOGE_STR("Cannot allocate index file basename string");
 372                 goto error;
 373         }
 374
 375         g_string_append(index_basename, ".idx");
 376         index_file_path = g_build_filename(directory, "index",
 377                         index_basename->str, NULL);
 378         mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
 379         if (!mapped_file) {
 380                 BT_COMP_LOGD("Cannot create new mapped file %s",
 381                                 index_file_path);
 382                 goto error;
 383         }
 384
 385         /*
 386          * The g_mapped_file API limits us to 4GB files on 32-bit.
 387          * Traces with such large indexes have never been seen in the wild,
 388          * but this would need to be adjusted to support them.
 389          */
 390         filesize = g_mapped_file_get_length(mapped_file);
 391         if (filesize < sizeof(*header)) {
 392                 BT_COMP_LOGW("Invalid LTTng trace index file: "
 393                         "file size (%zu bytes) < header size (%zu bytes)",
 394                         filesize, sizeof(*header));
 395                 goto error;
 396         }
 397
 398         mmap_begin = g_mapped_file_get_contents(mapped_file);
 399         header = (struct ctf_packet_index_file_hdr *) mmap_begin;
 400
 401         file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
 402         if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
 403                 BT_COMP_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
 404                 goto error;
 405         }
 406
 407         version_major = be32toh(header->index_major);
 408         version_minor = be32toh(header->index_minor);
 409         if (version_major != 1) {
 410                 BT_COMP_LOGW(
 411                         "Unknown LTTng trace index version: "
 412                         "major=%" PRIu32 ", minor=%" PRIu32,
 413                         version_major, version_minor);
 414                 goto error;
 415         }
 416
 417         file_index_entry_size = be32toh(header->packet_index_len);
 418         file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
 419         if ((filesize - sizeof(*header)) % file_index_entry_size) {
 420                 BT_COMP_LOGW("Invalid LTTng trace index: the index's size after the header "
 421                         "(%zu bytes) is not a multiple of the index entry size "
 422                         "(%zu bytes)", (filesize - sizeof(*header)),
 423                         sizeof(*header));
 424                 goto error;
 425         }
 426
 427         index = ctf_fs_ds_index_create(ds_file->log_level, ds_file->self_comp);
 428         if (!index) {
 429                 goto error;
 430         }
 431
 432         for (i = 0; i < file_entry_count; i++) {
 433                 struct ctf_packet_index *file_index =
 434                                 (struct ctf_packet_index *) file_pos;
 435                 uint64_t packet_size = be64toh(file_index->packet_size);
 436
 437                 if (packet_size % CHAR_BIT) {
 438                         BT_COMP_LOGW("Invalid packet size encountered in LTTng trace index file");
 439                         goto error;
 440                 }
 441
 442                 index_entry = ctf_fs_ds_index_entry_create(
 443                         ds_file->self_comp, ds_file->log_level);
 444                 if (!index_entry) {
 445                         BT_COMP_LOGE_APPEND_CAUSE(ds_file->self_comp,
 446                                 "Failed to create a ctf_fs_ds_index_entry.");
 447                         goto error;
 448                 }
 449
 450                 /* Set path to stream file. */
 451                 index_entry->path = file_info->path->str;
 452
 453                 /* Convert size in bits to bytes. */
 454                 packet_size /= CHAR_BIT;
 455                 index_entry->packet_size = packet_size;
 456
 457                 index_entry->offset = be64toh(file_index->offset);
 458                 if (i != 0 && index_entry->offset < prev_index_entry->offset) {
 459                         BT_COMP_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
 460                                 "previous offset=%" PRIu64 ", current offset=%" PRIu64,
 461                                 prev_index_entry->offset, index_entry->offset);
 462                         goto error;
 463                 }
 464
 465                 index_entry->timestamp_begin = be64toh(file_index->timestamp_begin);
 466                 index_entry->timestamp_end = be64toh(file_index->timestamp_end);
 467                 if (index_entry->timestamp_end < index_entry->timestamp_begin) {
 468                         BT_COMP_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
 469                                 "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64,
 470                                 index_entry->timestamp_begin,
 471                                 index_entry->timestamp_end);
 472                         goto error;
 473                 }
 474
 475                 /* Convert the packet's bound to nanoseconds since Epoch. */
 476                 ret = convert_cycles_to_ns(sc->default_clock_class,
 477                                 index_entry->timestamp_begin,
 478                                 &index_entry->timestamp_begin_ns);
 479                 if (ret) {
 480                         BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
 481                         goto error;
 482                 }
 483                 ret = convert_cycles_to_ns(sc->default_clock_class,
 484                                 index_entry->timestamp_end,
 485                                 &index_entry->timestamp_end_ns);
 486                 if (ret) {
 487                         BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
 488                         goto error;
 489                 }
 490
 491                 if (version_minor >= 1) {
 492                         index_entry->packet_seq_num = be64toh(file_index->packet_seq_num);
 493                 }
 494
 495                 total_packets_size += packet_size;
 496                 file_pos += file_index_entry_size;
 497
 498                 prev_index_entry = index_entry;
 499
 500                 /* Give ownership of `index_entry` to `index->entries`. */
 501                 g_ptr_array_add(index->entries, index_entry);
 502                 index_entry = NULL;
 503         }
 504
 505         /* Validate that the index addresses the complete stream. */
 506         if (ds_file->file->size != total_packets_size) {
 507                 BT_COMP_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
 508                         "file-size=%" PRIu64 ", total-packets-size=%" PRIu64,
 509                         ds_file->file->size, total_packets_size);
 510                 goto error;
 511         }
 512 end:
 513         g_free(directory);
 514         g_free(basename);
 515         g_free(index_file_path);
 516         if (index_basename) {
 517                 g_string_free(index_basename, TRUE);
 518         }
 519         if (mapped_file) {
 520                 g_mapped_file_unref(mapped_file);
 521         }
 522         return index;
 523 error:
 524         ctf_fs_ds_index_destroy(index);
 525         g_free(index_entry);
 526         index = NULL;
 527         goto end;
 528 }
 529
 530 static
 531 int init_index_entry(struct ctf_fs_ds_index_entry *entry,
 532                 struct ctf_fs_ds_file *ds_file,
 533                 struct ctf_msg_iter_packet_properties *props,
 534                 off_t packet_size, off_t packet_offset)
 535 {
 536         int ret = 0;
 537         struct ctf_stream_class *sc;
 538         bt_self_component *self_comp = ds_file->self_comp;
 539         bt_logging_level log_level = ds_file->log_level;
 540
 541         sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
 542                 props->stream_class_id);
 543         BT_ASSERT(sc);
 544         BT_ASSERT(packet_offset >= 0);
 545         entry->offset = packet_offset;
 546         BT_ASSERT(packet_size >= 0);
 547         entry->packet_size = packet_size;
 548
 549         if (props->snapshots.beginning_clock != UINT64_C(-1)) {
 550                 entry->timestamp_begin = props->snapshots.beginning_clock;
 551
 552                 /* Convert the packet's bound to nanoseconds since Epoch. */
 553                 ret = convert_cycles_to_ns(sc->default_clock_class,
 554                                            props->snapshots.beginning_clock,
 555                                            &entry->timestamp_begin_ns);
 556                 if (ret) {
 557                         BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
 558                         goto end;
 559                 }
 560         } else {
 561                 entry->timestamp_begin = UINT64_C(-1);
 562                 entry->timestamp_begin_ns = UINT64_C(-1);
 563         }
 564
 565         if (props->snapshots.end_clock != UINT64_C(-1)) {
 566                 entry->timestamp_end = props->snapshots.end_clock;
 567
 568                 /* Convert the packet's bound to nanoseconds since Epoch. */
 569                 ret = convert_cycles_to_ns(sc->default_clock_class,
 570                                            props->snapshots.end_clock,
 571                                            &entry->timestamp_end_ns);
 572                 if (ret) {
 573                         BT_COMP_LOGI_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
 574                         goto end;
 575                 }
 576         } else {
 577                 entry->timestamp_end = UINT64_C(-1);
 578                 entry->timestamp_end_ns = UINT64_C(-1);
 579         }
 580
 581 end:
 582         return ret;
 583 }
 584
 585 static
 586 struct ctf_fs_ds_index *build_index_from_stream_file(
 587                 struct ctf_fs_ds_file *ds_file,
 588                 struct ctf_fs_ds_file_info *file_info,
 589                 struct ctf_msg_iter *msg_iter)
 590 {
 591         int ret;
 592         struct ctf_fs_ds_index *index = NULL;
 593         enum ctf_msg_iter_status iter_status = CTF_MSG_ITER_STATUS_OK;
 594         off_t current_packet_offset_bytes = 0;
 595         bt_self_component *self_comp = ds_file->self_comp;
 596         bt_logging_level log_level = ds_file->log_level;
 597
 598         BT_COMP_LOGI("Indexing stream file %s", ds_file->file->path->str);
 599
 600         index = ctf_fs_ds_index_create(ds_file->log_level, ds_file->self_comp);
 601         if (!index) {
 602                 goto error;
 603         }
 604
 605         while (true) {
 606                 off_t current_packet_size_bytes;
 607                 struct ctf_fs_ds_index_entry *index_entry;
 608                 struct ctf_msg_iter_packet_properties props;
 609
 610                 if (current_packet_offset_bytes < 0) {
 611                         BT_COMP_LOGE_STR("Cannot get the current packet's offset.");
 612                         goto error;
 613                 } else if (current_packet_offset_bytes > ds_file->file->size) {
 614                         BT_COMP_LOGE_STR("Unexpected current packet's offset (larger than file).");
 615                         goto error;
 616                 } else if (current_packet_offset_bytes == ds_file->file->size) {
 617                         /* No more data */
 618                         break;
 619                 }
 620
 621                 iter_status = ctf_msg_iter_seek(msg_iter,
 622                                 current_packet_offset_bytes);
 623                 if (iter_status != CTF_MSG_ITER_STATUS_OK) {
 624                         goto error;
 625                 }
 626
 627                 iter_status = ctf_msg_iter_get_packet_properties(
 628                         msg_iter, &props);
 629                 if (iter_status != CTF_MSG_ITER_STATUS_OK) {
 630                         goto error;
 631                 }
 632
 633                 if (props.exp_packet_total_size >= 0) {
 634                         current_packet_size_bytes =
 635                                 (uint64_t) props.exp_packet_total_size / 8;
 636                 } else {
 637                         current_packet_size_bytes = ds_file->file->size;
 638                 }
 639
 640                 if (current_packet_offset_bytes + current_packet_size_bytes >
 641                                 ds_file->file->size) {
 642                         BT_COMP_LOGW("Invalid packet size reported in file: stream=\"%s\", "
 643                                         "packet-offset=%jd, packet-size-bytes=%jd, "
 644                                         "file-size=%jd",
 645                                         ds_file->file->path->str,
 646                                         (intmax_t) current_packet_offset_bytes,
 647                                         (intmax_t) current_packet_size_bytes,
 648                                         (intmax_t) ds_file->file->size);
 649                         goto error;
 650                 }
 651
 652                 index_entry = ctf_fs_ds_index_entry_create(
 653                         ds_file->self_comp, ds_file->log_level);
 654                 if (!index_entry) {
 655                         BT_COMP_LOGE_APPEND_CAUSE(ds_file->self_comp,
 656                                 "Failed to create a ctf_fs_ds_index_entry.");
 657                         goto error;
 658                 }
 659
 660                 /* Set path to stream file. */
 661                 index_entry->path = file_info->path->str;
 662
 663                 ret = init_index_entry(index_entry, ds_file, &props,
 664                         current_packet_size_bytes, current_packet_offset_bytes);
 665                 if (ret) {
 666                         g_free(index_entry);
 667                         goto error;
 668                 }
 669
 670                 g_ptr_array_add(index->entries, index_entry);
 671
 672                 current_packet_offset_bytes += current_packet_size_bytes;
 673                 BT_COMP_LOGD("Seeking to next packet: current-packet-offset=%jd, "
 674                         "next-packet-offset=%jd",
 675                         (intmax_t) (current_packet_offset_bytes - current_packet_size_bytes),
 676                         (intmax_t) current_packet_offset_bytes);
 677         }
 678
 679 end:
 680         return index;
 681
 682 error:
 683         ctf_fs_ds_index_destroy(index);
 684         index = NULL;
 685         goto end;
 686 }
 687
 688 BT_HIDDEN
 689 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
 690                 struct ctf_fs_trace *ctf_fs_trace,
 691                 bt_self_message_iterator *self_msg_iter,
 692                 bt_stream *stream, const char *path,
 693                 bt_logging_level log_level)
 694 {
 695         int ret;
 696         const size_t offset_align = bt_mmap_get_offset_align_size(log_level);
 697         struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
 698
 699         if (!ds_file) {
 700                 goto error;
 701         }
 702
 703         ds_file->log_level = log_level;
 704         ds_file->self_comp = ctf_fs_trace->self_comp;
 705         ds_file->self_msg_iter = self_msg_iter;
 706         ds_file->file = ctf_fs_file_create(log_level, ds_file->self_comp);
 707         if (!ds_file->file) {
 708                 goto error;
 709         }
 710
 711         ds_file->stream = stream;
 712         bt_stream_get_ref(ds_file->stream);
 713         ds_file->metadata = ctf_fs_trace->metadata;
 714         g_string_assign(ds_file->file->path, path);
 715         ret = ctf_fs_file_open(ds_file->file, "rb");
 716         if (ret) {
 717                 goto error;
 718         }
 719
 720         ds_file->mmap_max_len = offset_align * 2048;
 721
 722         goto end;
 723
 724 error:
 725         /* Do not touch "borrowed" file. */
 726         ctf_fs_ds_file_destroy(ds_file);
 727         ds_file = NULL;
 728
 729 end:
 730         return ds_file;
 731 }
 732
 733 BT_HIDDEN
 734 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
 735                 struct ctf_fs_ds_file *ds_file,
 736                 struct ctf_fs_ds_file_info *file_info,
 737                 struct ctf_msg_iter *msg_iter)
 738 {
 739         struct ctf_fs_ds_index *index;
 740         bt_self_component *self_comp = ds_file->self_comp;
 741         bt_logging_level log_level = ds_file->log_level;
 742
 743         index = build_index_from_idx_file(ds_file, file_info, msg_iter);
 744         if (index) {
 745                 goto end;
 746         }
 747
 748         BT_COMP_LOGI("Failed to build index from .index file; "
 749                 "falling back to stream indexing.");
 750         index = build_index_from_stream_file(ds_file, file_info, msg_iter);
 751 end:
 752         return index;
 753 }
 754
 755 BT_HIDDEN
 756 struct ctf_fs_ds_index *ctf_fs_ds_index_create(bt_logging_level log_level,
 757                 bt_self_component *self_comp)
 758 {
 759         struct ctf_fs_ds_index *index = g_new0(struct ctf_fs_ds_index, 1);
 760
 761         if (!index) {
 762                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
 763                         "Failed to allocate index");
 764                 goto error;
 765         }
 766
 767         index->entries = g_ptr_array_new_with_free_func((GDestroyNotify) g_free);
 768         if (!index->entries) {
 769                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
 770                         "Failed to allocate index entries.");
 771                 goto error;
 772         }
 773
 774         goto end;
 775
 776 error:
 777         ctf_fs_ds_index_destroy(index);
 778         index = NULL;
 779 end:
 780         return index;
 781 }
 782
 783 BT_HIDDEN
 784 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
 785 {
 786         if (!ds_file) {
 787                 return;
 788         }
 789
 790         bt_stream_put_ref(ds_file->stream);
 791         (void) ds_file_munmap(ds_file);
 792
 793         if (ds_file->file) {
 794                 ctf_fs_file_destroy(ds_file->file);
 795         }
 796
 797         g_free(ds_file);
 798 }
 799
 800 BT_HIDDEN
 801 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
 802 {
 803         if (!index) {
 804                 return;
 805         }
 806
 807         if (index->entries) {
 808                 g_ptr_array_free(index->entries, TRUE);
 809         }
 810         g_free(index);
 811 }