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

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