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