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