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 <babeltrace/compat/mman-internal.h>
  33 #include <babeltrace/endian-internal.h>
  34 #include <babeltrace/babeltrace.h>
  35 #include <babeltrace/common-internal.h>
  36 #include "file.h"
  37 #include "metadata.h"
  38 #include "../common/msg-iter/msg-iter.h"
  39 #include <babeltrace/assert-internal.h>
  40 #include "data-stream-file.h"
  41 #include <string.h>
  42
  43 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC-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(
 177                 bt_stream_class *stream_class, int64_t stream_id,
 178                 void *data)
 179 {
 180         struct ctf_fs_ds_file *ds_file = data;
 181         bt_stream_class *ds_file_stream_class;
 182         bt_stream *stream = NULL;
 183
 184         ds_file_stream_class = bt_stream_borrow_class(
 185                 ds_file->stream);
 186
 187         if (stream_class != ds_file_stream_class) {
 188                 /*
 189                  * Not supported: two packets described by two different
 190                  * stream classes within the same data stream file.
 191                  */
 192                 goto end;
 193         }
 194
 195         stream = ds_file->stream;
 196
 197 end:
 198         return stream;
 199 }
 200
 201 static
 202 enum bt_msg_iter_medium_status medop_seek(
 203                 enum bt_msg_iter_seek_whence whence, off_t offset,
 204                 void *data)
 205 {
 206         enum bt_msg_iter_medium_status ret =
 207                         BT_MSG_ITER_MEDIUM_STATUS_OK;
 208         struct ctf_fs_ds_file *ds_file = data;
 209         off_t file_size = ds_file->file->size;
 210
 211         if (whence != BT_MSG_ITER_SEEK_WHENCE_SET ||
 212                 offset < 0 || offset > file_size) {
 213                 BT_LOGE("Invalid medium seek request: whence=%d, offset=%jd, "
 214                                 "file-size=%jd", (int) whence, offset,
 215                                 file_size);
 216                 ret = BT_MSG_ITER_MEDIUM_STATUS_INVAL;
 217                 goto end;
 218         }
 219
 220         /*
 221          * Determine whether or not the destination is contained within the
 222          * current mapping.
 223          */
 224         if (ds_file->mmap_addr && (offset < ds_file->mmap_offset ||
 225                         offset >= ds_file->mmap_offset + ds_file->mmap_len)) {
 226                 int unmap_ret;
 227                 off_t offset_in_mapping = offset % bt_common_get_page_size();
 228
 229                 BT_LOGD("Medium seek request cannot be accomodated by the current "
 230                                 "file mapping: offset=%jd, mmap-offset=%jd, "
 231                                 "mmap-len=%zu", offset, ds_file->mmap_offset,
 232                                 ds_file->mmap_len);
 233                 unmap_ret = ds_file_munmap(ds_file);
 234                 if (unmap_ret) {
 235                         ret = BT_MSG_ITER_MEDIUM_STATUS_ERROR;
 236                         goto end;
 237                 }
 238
 239                 ds_file->mmap_offset = offset - offset_in_mapping;
 240                 ds_file->request_offset = offset_in_mapping;
 241                 ret = ds_file_mmap_next(ds_file);
 242                 if (ret != BT_MSG_ITER_MEDIUM_STATUS_OK) {
 243                         goto end;
 244                 }
 245         } else {
 246                 ds_file->request_offset = offset - ds_file->mmap_offset;
 247         }
 248
 249         ds_file->end_reached = (offset == file_size);
 250 end:
 251         return ret;
 252 }
 253
 254 BT_HIDDEN
 255 struct bt_msg_iter_medium_ops ctf_fs_ds_file_medops = {
 256         .request_bytes = medop_request_bytes,
 257         .borrow_stream = medop_borrow_stream,
 258         .seek = medop_seek,
 259 };
 260
 261 static
 262 struct ctf_fs_ds_index *ctf_fs_ds_index_create(size_t length)
 263 {
 264         struct ctf_fs_ds_index *index = g_new0(struct ctf_fs_ds_index, 1);
 265
 266         if (!index) {
 267                 BT_LOGE_STR("Failed to allocate index");
 268                 goto error;
 269         }
 270
 271         index->entries = g_array_sized_new(FALSE, TRUE,
 272                         sizeof(struct ctf_fs_ds_index_entry), length);
 273         if (!index->entries) {
 274                 BT_LOGE("Failed to allocate %zu index entries.", length);
 275                 goto error;
 276         }
 277         g_array_set_size(index->entries, length);
 278 end:
 279         return index;
 280 error:
 281         ctf_fs_ds_index_destroy(index);
 282         goto end;
 283 }
 284
 285 /* Returns a new, zeroed, index entry. */
 286 static
 287 struct ctf_fs_ds_index_entry *ctf_fs_ds_index_add_new_entry(
 288                 struct ctf_fs_ds_index *index)
 289 {
 290         g_array_set_size(index->entries, index->entries->len + 1);
 291         return &g_array_index(index->entries, struct ctf_fs_ds_index_entry,
 292                         index->entries->len - 1);
 293 }
 294
 295 static
 296 int convert_cycles_to_ns(bt_clock_class *clock_class,
 297                 uint64_t cycles, int64_t *ns)
 298 {
 299         return bt_clock_class_cycles_to_ns_from_origin(clock_class, cycles,
 300                                                        ns);
 301 }
 302
 303 static
 304 struct ctf_fs_ds_index *build_index_from_idx_file(
 305                 struct ctf_fs_ds_file *ds_file)
 306 {
 307         int ret;
 308         gchar *directory = NULL;
 309         gchar *basename = NULL;
 310         GString *index_basename = NULL;
 311         gchar *index_file_path = NULL;
 312         GMappedFile *mapped_file = NULL;
 313         gsize filesize;
 314         const char *mmap_begin = NULL, *file_pos = NULL;
 315         const struct ctf_packet_index_file_hdr *header = NULL;
 316         struct ctf_fs_ds_index *index = NULL;
 317         struct ctf_fs_ds_index_entry *index_entry = NULL;
 318         uint64_t total_packets_size = 0;
 319         size_t file_index_entry_size;
 320         size_t file_entry_count;
 321         size_t i;
 322         struct ctf_stream_class *sc;
 323         struct bt_msg_iter_packet_properties props;
 324
 325         BT_LOGD("Building index from .idx file of stream file %s",
 326                         ds_file->file->path->str);
 327         ret = bt_msg_iter_get_packet_properties(ds_file->msg_iter, &props);
 328         if (ret) {
 329                 BT_LOGD_STR("Cannot read first packet's header and context fields.");
 330                 goto error;
 331         }
 332
 333         sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
 334                 props.stream_class_id);
 335         BT_ASSERT(sc);
 336         if (!sc->default_clock_class) {
 337                 BT_LOGD_STR("Cannot find stream class's default clock class.");
 338                 goto error;
 339         }
 340
 341         /* Look for index file in relative path index/name.idx. */
 342         basename = g_path_get_basename(ds_file->file->path->str);
 343         if (!basename) {
 344                 BT_LOGE("Cannot get the basename of datastream file %s",
 345                                 ds_file->file->path->str);
 346                 goto error;
 347         }
 348
 349         directory = g_path_get_dirname(ds_file->file->path->str);
 350         if (!directory) {
 351                 BT_LOGE("Cannot get dirname of datastream file %s",
 352                                 ds_file->file->path->str);
 353                 goto error;
 354         }
 355
 356         index_basename = g_string_new(basename);
 357         if (!index_basename) {
 358                 BT_LOGE_STR("Cannot allocate index file basename string");
 359                 goto error;
 360         }
 361
 362         g_string_append(index_basename, ".idx");
 363         index_file_path = g_build_filename(directory, "index",
 364                         index_basename->str, NULL);
 365         mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
 366         if (!mapped_file) {
 367                 BT_LOGD("Cannot create new mapped file %s",
 368                                 index_file_path);
 369                 goto error;
 370         }
 371
 372         /*
 373          * The g_mapped_file API limits us to 4GB files on 32-bit.
 374          * Traces with such large indexes have never been seen in the wild,
 375          * but this would need to be adjusted to support them.
 376          */
 377         filesize = g_mapped_file_get_length(mapped_file);
 378         if (filesize < sizeof(*header)) {
 379                 BT_LOGW("Invalid LTTng trace index file: "
 380                         "file size (%zu bytes) < header size (%zu bytes)",
 381                         filesize, sizeof(*header));
 382                 goto error;
 383         }
 384
 385         mmap_begin = g_mapped_file_get_contents(mapped_file);
 386         header = (struct ctf_packet_index_file_hdr *) mmap_begin;
 387
 388         file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
 389         if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
 390                 BT_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
 391                 goto error;
 392         }
 393
 394         file_index_entry_size = be32toh(header->packet_index_len);
 395         file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
 396         if ((filesize - sizeof(*header)) % file_index_entry_size) {
 397                 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
 398                         "(%zu bytes) is not a multiple of the index entry size "
 399                         "(%zu bytes)", (filesize - sizeof(*header)),
 400                         sizeof(*header));
 401                 goto error;
 402         }
 403
 404         index = ctf_fs_ds_index_create(file_entry_count);
 405         if (!index) {
 406                 goto error;
 407         }
 408
 409         index_entry = (struct ctf_fs_ds_index_entry *) &g_array_index(
 410                         index->entries, struct ctf_fs_ds_index_entry, 0);
 411         for (i = 0; i < file_entry_count; i++) {
 412                 struct ctf_packet_index *file_index =
 413                                 (struct ctf_packet_index *) file_pos;
 414                 uint64_t packet_size = be64toh(file_index->packet_size);
 415
 416                 if (packet_size % CHAR_BIT) {
 417                         BT_LOGW("Invalid packet size encountered in LTTng trace index file");
 418                         goto error;
 419                 }
 420
 421                 /* Convert size in bits to bytes. */
 422                 packet_size /= CHAR_BIT;
 423                 index_entry->packet_size = packet_size;
 424
 425                 index_entry->offset = be64toh(file_index->offset);
 426                 if (i != 0 && index_entry->offset < (index_entry - 1)->offset) {
 427                         BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
 428                                 "previous offset=%" PRIu64 ", current offset=%" PRIu64,
 429                                 (index_entry - 1)->offset, index_entry->offset);
 430                         goto error;
 431                 }
 432
 433                 index_entry->timestamp_begin = be64toh(file_index->timestamp_begin);
 434                 index_entry->timestamp_end = be64toh(file_index->timestamp_end);
 435                 if (index_entry->timestamp_end < index_entry->timestamp_begin) {
 436                         BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
 437                                 "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64,
 438                                 index_entry->timestamp_begin,
 439                                 index_entry->timestamp_end);
 440                         goto error;
 441                 }
 442
 443                 /* Convert the packet's bound to nanoseconds since Epoch. */
 444                 ret = convert_cycles_to_ns(sc->default_clock_class,
 445                                 index_entry->timestamp_begin,
 446                                 &index_entry->timestamp_begin_ns);
 447                 if (ret) {
 448                         BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
 449                         goto error;
 450                 }
 451                 ret = convert_cycles_to_ns(sc->default_clock_class,
 452                                 index_entry->timestamp_end,
 453                                 &index_entry->timestamp_end_ns);
 454                 if (ret) {
 455                         BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
 456                         goto error;
 457                 }
 458
 459                 total_packets_size += packet_size;
 460                 file_pos += file_index_entry_size;
 461                 index_entry++;
 462         }
 463
 464         /* Validate that the index addresses the complete stream. */
 465         if (ds_file->file->size != total_packets_size) {
 466                 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
 467                         "file-size=%" PRIu64 ", total-packets-size=%" PRIu64,
 468                         ds_file->file->size, total_packets_size);
 469                 goto error;
 470         }
 471 end:
 472         g_free(directory);
 473         g_free(basename);
 474         g_free(index_file_path);
 475         if (index_basename) {
 476                 g_string_free(index_basename, TRUE);
 477         }
 478         if (mapped_file) {
 479                 g_mapped_file_unref(mapped_file);
 480         }
 481         return index;
 482 error:
 483         ctf_fs_ds_index_destroy(index);
 484         index = NULL;
 485         goto end;
 486 }
 487
 488 static
 489 int init_index_entry(struct ctf_fs_ds_index_entry *entry,
 490                 struct ctf_fs_ds_file *ds_file,
 491                 struct bt_msg_iter_packet_properties *props,
 492                 off_t packet_size, off_t packet_offset)
 493 {
 494         int ret;
 495         struct ctf_stream_class *sc;
 496
 497         sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
 498                 props->stream_class_id);
 499         BT_ASSERT(sc);
 500         BT_ASSERT(packet_offset >= 0);
 501         entry->offset = packet_offset;
 502         BT_ASSERT(packet_size >= 0);
 503         entry->packet_size = packet_size;
 504
 505         /* Convert the packet's bound to nanoseconds since Epoch. */
 506         ret = convert_cycles_to_ns(sc->default_clock_class,
 507                                    props->snapshots.beginning_clock,
 508                                    &entry->timestamp_begin_ns);
 509         if (ret) {
 510                 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
 511                 goto end;
 512         }
 513
 514         ret = convert_cycles_to_ns(sc->default_clock_class,
 515                                    props->snapshots.end_clock,
 516                                    &entry->timestamp_end_ns);
 517         if (ret) {
 518                 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
 519                 goto end;
 520         }
 521
 522 end:
 523         return ret;
 524 }
 525
 526 static
 527 struct ctf_fs_ds_index *build_index_from_stream_file(
 528                 struct ctf_fs_ds_file *ds_file)
 529 {
 530         int ret;
 531         struct ctf_fs_ds_index *index = NULL;
 532         enum bt_msg_iter_status iter_status;
 533
 534         BT_LOGD("Indexing stream file %s", ds_file->file->path->str);
 535
 536         index = ctf_fs_ds_index_create(0);
 537         if (!index) {
 538                 goto error;
 539         }
 540
 541         do {
 542                 off_t current_packet_offset;
 543                 off_t next_packet_offset;
 544                 off_t current_packet_size_bytes;
 545                 struct ctf_fs_ds_index_entry *entry;
 546                 struct bt_msg_iter_packet_properties props;
 547
 548                 iter_status = bt_msg_iter_get_packet_properties(
 549                         ds_file->msg_iter, &props);
 550                 if (iter_status != BT_MSG_ITER_STATUS_OK) {
 551                         if (iter_status == BT_MSG_ITER_STATUS_EOF) {
 552                                 break;
 553                         }
 554                         goto error;
 555                 }
 556
 557                 current_packet_offset =
 558                         bt_msg_iter_get_current_packet_offset(
 559                                 ds_file->msg_iter);
 560                 if (current_packet_offset < 0) {
 561                         BT_LOGE_STR("Cannot get the current packet's offset.");
 562                         goto error;
 563                 }
 564
 565                 current_packet_size_bytes =
 566                         ((props.exp_packet_total_size + 7) & ~7) / CHAR_BIT;
 567
 568                 if (current_packet_offset + current_packet_size_bytes >
 569                                 ds_file->file->size) {
 570                         BT_LOGW("Invalid packet size reported in file: stream=\"%s\", "
 571                                         "packet-offset=%jd, packet-size-bytes=%jd, "
 572                                         "file-size=%jd",
 573                                         ds_file->file->path->str,
 574                                         current_packet_offset,
 575                                         current_packet_size_bytes,
 576                                         ds_file->file->size);
 577                         goto error;
 578                 }
 579
 580                 next_packet_offset = current_packet_offset +
 581                         current_packet_size_bytes;
 582                 BT_LOGD("Seeking to next packet: current-packet-offset=%jd, "
 583                         "next-packet-offset=%jd", current_packet_offset,
 584                         next_packet_offset);
 585
 586                 entry = ctf_fs_ds_index_add_new_entry(index);
 587                 if (!entry) {
 588                         BT_LOGE_STR("Failed to allocate a new index entry.");
 589                         goto error;
 590                 }
 591
 592                 ret = init_index_entry(entry, ds_file, &props,
 593                         current_packet_size_bytes, current_packet_offset);
 594                 if (ret) {
 595                         goto error;
 596                 }
 597
 598                 iter_status = bt_msg_iter_seek(ds_file->msg_iter,
 599                                 next_packet_offset);
 600         } while (iter_status == BT_MSG_ITER_STATUS_OK);
 601
 602         if (iter_status != BT_MSG_ITER_STATUS_EOF) {
 603                 goto error;
 604         }
 605
 606 end:
 607         return index;
 608
 609 error:
 610         ctf_fs_ds_index_destroy(index);
 611         index = NULL;
 612         goto end;
 613 }
 614
 615 BT_HIDDEN
 616 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
 617                 struct ctf_fs_trace *ctf_fs_trace,
 618                 bt_self_message_iterator *pc_msg_iter,
 619                 struct bt_msg_iter *msg_iter,
 620                 bt_stream *stream, const char *path)
 621 {
 622         int ret;
 623         const size_t page_size = bt_common_get_page_size();
 624         struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
 625
 626         if (!ds_file) {
 627                 goto error;
 628         }
 629
 630         ds_file->pc_msg_iter = pc_msg_iter;
 631         ds_file->file = ctf_fs_file_create();
 632         if (!ds_file->file) {
 633                 goto error;
 634         }
 635
 636         ds_file->stream = stream;
 637         bt_stream_get_ref(ds_file->stream);
 638         ds_file->metadata = ctf_fs_trace->metadata;
 639         g_string_assign(ds_file->file->path, path);
 640         ret = ctf_fs_file_open(ds_file->file, "rb");
 641         if (ret) {
 642                 goto error;
 643         }
 644
 645         ds_file->msg_iter = msg_iter;
 646         bt_msg_iter_set_medops_data(ds_file->msg_iter, ds_file);
 647         if (!ds_file->msg_iter) {
 648                 goto error;
 649         }
 650
 651         ds_file->mmap_max_len = page_size * 2048;
 652
 653         goto end;
 654
 655 error:
 656         /* Do not touch "borrowed" file. */
 657         ctf_fs_ds_file_destroy(ds_file);
 658         ds_file = NULL;
 659
 660 end:
 661         return ds_file;
 662 }
 663
 664 BT_HIDDEN
 665 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
 666                 struct ctf_fs_ds_file *ds_file)
 667 {
 668         struct ctf_fs_ds_index *index;
 669
 670         index = build_index_from_idx_file(ds_file);
 671         if (index) {
 672                 goto end;
 673         }
 674
 675         BT_LOGD("Failed to build index from .index file; "
 676                 "falling back to stream indexing.");
 677         index = build_index_from_stream_file(ds_file);
 678 end:
 679         return index;
 680 }
 681
 682 BT_HIDDEN
 683 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
 684 {
 685         if (!ds_file) {
 686                 return;
 687         }
 688
 689         bt_stream_put_ref(ds_file->stream);
 690         (void) ds_file_munmap(ds_file);
 691
 692         if (ds_file->file) {
 693                 ctf_fs_file_destroy(ds_file->file);
 694         }
 695
 696         g_free(ds_file);
 697 }
 698
 699 BT_HIDDEN
 700 bt_message_iterator_status ctf_fs_ds_file_next(
 701                 struct ctf_fs_ds_file *ds_file,
 702                 bt_message **msg)
 703 {
 704         enum bt_msg_iter_status msg_iter_status;
 705         bt_message_iterator_status status;
 706
 707         msg_iter_status = bt_msg_iter_get_next_message(
 708                 ds_file->msg_iter, ds_file->pc_msg_iter, msg);
 709
 710         switch (msg_iter_status) {
 711         case BT_MSG_ITER_STATUS_EOF:
 712                 status = BT_MESSAGE_ITERATOR_STATUS_END;
 713                 break;
 714         case BT_MSG_ITER_STATUS_OK:
 715                 status = BT_MESSAGE_ITERATOR_STATUS_OK;
 716                 break;
 717         case BT_MSG_ITER_STATUS_AGAIN:
 718                 /*
 719                  * Should not make it this far as this is
 720                  * medium-specific; there is nothing for the user to do
 721                  * and it should have been handled upstream.
 722                  */
 723                 abort();
 724         case BT_MSG_ITER_STATUS_INVAL:
 725         case BT_MSG_ITER_STATUS_ERROR:
 726         default:
 727                 status = BT_MESSAGE_ITERATOR_STATUS_ERROR;
 728                 break;
 729         }
 730         return status;
 731 }
 732
 733 BT_HIDDEN
 734 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
 735 {
 736         if (!index) {
 737                 return;
 738         }
 739
 740         if (index->entries) {
 741                 g_array_free(index->entries, TRUE);
 742         }
 743         g_free(index);
 744 }