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