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