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

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