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