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, int64_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 int convert_cycles_to_ns(struct bt_clock_class *clock_class,
 295                 uint64_t cycles, int64_t *ns)
 296 {
 297         return bt_clock_class_cycles_to_ns_from_origin(clock_class, cycles, ns);
 298 }
 299
 300 static
 301 struct ctf_fs_ds_index *build_index_from_idx_file(
 302                 struct ctf_fs_ds_file *ds_file)
 303 {
 304         int ret;
 305         gchar *directory = NULL;
 306         gchar *basename = NULL;
 307         GString *index_basename = NULL;
 308         gchar *index_file_path = NULL;
 309         GMappedFile *mapped_file = NULL;
 310         gsize filesize;
 311         const char *mmap_begin = NULL, *file_pos = NULL;
 312         const struct ctf_packet_index_file_hdr *header = NULL;
 313         struct ctf_fs_ds_index *index = NULL;
 314         struct ctf_fs_ds_index_entry *index_entry = NULL;
 315         uint64_t total_packets_size = 0;
 316         size_t file_index_entry_size;
 317         size_t file_entry_count;
 318         size_t i;
 319         struct ctf_stream_class *sc;
 320         struct bt_notif_iter_packet_properties props;
 321
 322         BT_LOGD("Building index from .idx file of stream file %s",
 323                         ds_file->file->path->str);
 324
 325         ret = bt_notif_iter_borrow_packet_header_context_fields(
 326                 ds_file->notif_iter, NULL, NULL);
 327         if (ret) {
 328                 BT_LOGD_STR("Cannot borrow first packet's header and context "
 329                         "fields.");
 330                 goto error;
 331         }
 332
 333         ret = bt_notif_iter_get_packet_properties(ds_file->notif_iter, &props);
 334         BT_ASSERT(ret == 0);
 335         sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
 336                 props.stream_class_id);
 337         BT_ASSERT(sc);
 338         if (!sc->default_clock_class) {
 339                 BT_LOGD_STR("Cannot find stream class's default clock class.");
 340                 goto error;
 341         }
 342
 343         /* Look for index file in relative path index/name.idx. */
 344         basename = g_path_get_basename(ds_file->file->path->str);
 345         if (!basename) {
 346                 BT_LOGE("Cannot get the basename of datastream file %s",
 347                                 ds_file->file->path->str);
 348                 goto error;
 349         }
 350
 351         directory = g_path_get_dirname(ds_file->file->path->str);
 352         if (!directory) {
 353                 BT_LOGE("Cannot get dirname of datastream file %s",
 354                                 ds_file->file->path->str);
 355                 goto error;
 356         }
 357
 358         index_basename = g_string_new(basename);
 359         if (!index_basename) {
 360                 BT_LOGE_STR("Cannot allocate index file basename string");
 361                 goto error;
 362         }
 363
 364         g_string_append(index_basename, ".idx");
 365         index_file_path = g_build_filename(directory, "index",
 366                         index_basename->str, NULL);
 367         mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
 368         if (!mapped_file) {
 369                 BT_LOGD("Cannot create new mapped file %s",
 370                                 index_file_path);
 371                 goto error;
 372         }
 373
 374         /*
 375          * The g_mapped_file API limits us to 4GB files on 32-bit.
 376          * Traces with such large indexes have never been seen in the wild,
 377          * but this would need to be adjusted to support them.
 378          */
 379         filesize = g_mapped_file_get_length(mapped_file);
 380         if (filesize < sizeof(*header)) {
 381                 BT_LOGW("Invalid LTTng trace index file: "
 382                         "file size (%zu bytes) < header size (%zu bytes)",
 383                         filesize, sizeof(*header));
 384                 goto error;
 385         }
 386
 387         mmap_begin = g_mapped_file_get_contents(mapped_file);
 388         header = (struct ctf_packet_index_file_hdr *) mmap_begin;
 389
 390         file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
 391         if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
 392                 BT_LOGW_STR("Invalid LTTng trace index: \"magic\" field validation failed");
 393                 goto error;
 394         }
 395
 396         file_index_entry_size = be32toh(header->packet_index_len);
 397         file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
 398         if ((filesize - sizeof(*header)) % file_index_entry_size) {
 399                 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
 400                         "(%zu bytes) is not a multiple of the index entry size "
 401                         "(%zu bytes)", (filesize - sizeof(*header)),
 402                         sizeof(*header));
 403                 goto error;
 404         }
 405
 406         index = ctf_fs_ds_index_create(file_entry_count);
 407         if (!index) {
 408                 goto error;
 409         }
 410
 411         index_entry = (struct ctf_fs_ds_index_entry *) &g_array_index(
 412                         index->entries, struct ctf_fs_ds_index_entry, 0);
 413         for (i = 0; i < file_entry_count; i++) {
 414                 struct ctf_packet_index *file_index =
 415                                 (struct ctf_packet_index *) file_pos;
 416                 uint64_t packet_size = be64toh(file_index->packet_size);
 417
 418                 if (packet_size % CHAR_BIT) {
 419                         BT_LOGW("Invalid packet size encountered in LTTng trace index file");
 420                         goto error;
 421                 }
 422
 423                 /* Convert size in bits to bytes. */
 424                 packet_size /= CHAR_BIT;
 425                 index_entry->packet_size = packet_size;
 426
 427                 index_entry->offset = be64toh(file_index->offset);
 428                 if (i != 0 && index_entry->offset < (index_entry - 1)->offset) {
 429                         BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
 430                                 "previous offset=%" PRIu64 ", current offset=%" PRIu64,
 431                                 (index_entry - 1)->offset, index_entry->offset);
 432                         goto error;
 433                 }
 434
 435                 index_entry->timestamp_begin = be64toh(file_index->timestamp_begin);
 436                 index_entry->timestamp_end = be64toh(file_index->timestamp_end);
 437                 if (index_entry->timestamp_end < index_entry->timestamp_begin) {
 438                         BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
 439                                 "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64,
 440                                 index_entry->timestamp_begin,
 441                                 index_entry->timestamp_end);
 442                         goto error;
 443                 }
 444
 445                 /* Convert the packet's bound to nanoseconds since Epoch. */
 446                 ret = convert_cycles_to_ns(sc->default_clock_class,
 447                                 index_entry->timestamp_begin,
 448                                 &index_entry->timestamp_begin_ns);
 449                 if (ret) {
 450                         BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
 451                         goto error;
 452                 }
 453                 ret = convert_cycles_to_ns(sc->default_clock_class,
 454                                 index_entry->timestamp_end,
 455                                 &index_entry->timestamp_end_ns);
 456                 if (ret) {
 457                         BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
 458                         goto error;
 459                 }
 460
 461                 total_packets_size += packet_size;
 462                 file_pos += file_index_entry_size;
 463                 index_entry++;
 464         }
 465
 466         /* Validate that the index addresses the complete stream. */
 467         if (ds_file->file->size != total_packets_size) {
 468                 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
 469                         "file-size=%" PRIu64 ", total-packets-size=%" PRIu64,
 470                         ds_file->file->size, total_packets_size);
 471                 goto error;
 472         }
 473 end:
 474         g_free(directory);
 475         g_free(basename);
 476         g_free(index_file_path);
 477         if (index_basename) {
 478                 g_string_free(index_basename, TRUE);
 479         }
 480         if (mapped_file) {
 481                 g_mapped_file_unref(mapped_file);
 482         }
 483         return index;
 484 error:
 485         ctf_fs_ds_index_destroy(index);
 486         index = NULL;
 487         goto end;
 488 }
 489
 490 static
 491 int init_index_entry(struct ctf_fs_ds_index_entry *entry,
 492                 struct ctf_fs_ds_file *ds_file,
 493                 struct bt_notif_iter_packet_properties *props,
 494                 off_t packet_size, off_t packet_offset)
 495 {
 496         int ret;
 497         struct ctf_stream_class *sc;
 498
 499         sc = ctf_trace_class_borrow_stream_class_by_id(ds_file->metadata->tc,
 500                 props->stream_class_id);
 501         BT_ASSERT(sc);
 502         BT_ASSERT(packet_offset >= 0);
 503         entry->offset = packet_offset;
 504         BT_ASSERT(packet_size >= 0);
 505         entry->packet_size = packet_size;
 506
 507         /* Convert the packet's bound to nanoseconds since Epoch. */
 508         ret = convert_cycles_to_ns(sc->default_clock_class,
 509                                    props->snapshots.beginning_clock,
 510                                    &entry->timestamp_begin_ns);
 511         if (ret) {
 512                 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
 513                 goto end;
 514         }
 515
 516         ret = convert_cycles_to_ns(sc->default_clock_class,
 517                                    props->snapshots.end_clock,
 518                                    &entry->timestamp_end_ns);
 519         if (ret) {
 520                 BT_LOGD_STR("Failed to convert raw timestamp to nanoseconds since Epoch.");
 521                 goto end;
 522         }
 523
 524 end:
 525         return ret;
 526 }
 527
 528 static
 529 struct ctf_fs_ds_index *build_index_from_stream_file(
 530                 struct ctf_fs_ds_file *ds_file)
 531 {
 532         int ret;
 533         struct ctf_fs_ds_index *index = NULL;
 534         enum bt_notif_iter_status iter_status;
 535
 536         BT_LOGD("Indexing stream file %s", ds_file->file->path->str);
 537
 538         index = ctf_fs_ds_index_create(0);
 539         if (!index) {
 540                 goto error;
 541         }
 542
 543         do {
 544                 off_t current_packet_offset;
 545                 off_t next_packet_offset;
 546                 off_t current_packet_size_bytes;
 547                 struct ctf_fs_ds_index_entry *entry;
 548                 struct bt_notif_iter_packet_properties props;
 549
 550                 iter_status = bt_notif_iter_borrow_packet_header_context_fields(
 551                         ds_file->notif_iter, NULL, NULL);
 552                 if (iter_status != BT_NOTIF_ITER_STATUS_OK) {
 553                         if (iter_status == BT_NOTIF_ITER_STATUS_EOF) {
 554                                 break;
 555                         }
 556                         goto error;
 557                 }
 558
 559                 ret = bt_notif_iter_get_packet_properties(ds_file->notif_iter,
 560                         &props);
 561                 BT_ASSERT(ret == 0);
 562
 563                 current_packet_offset =
 564                         bt_notif_iter_get_current_packet_offset(
 565                                 ds_file->notif_iter);
 566                 if (current_packet_offset < 0) {
 567                         BT_LOGE_STR("Cannot get the current packet's offset.");
 568                         goto error;
 569                 }
 570
 571                 current_packet_size_bytes =
 572                         ((props.exp_packet_total_size + 7) & ~7) / CHAR_BIT;
 573
 574                 if (current_packet_offset + current_packet_size_bytes >
 575                                 ds_file->file->size) {
 576                         BT_LOGW("Invalid packet size reported in file: stream=\"%s\", "
 577                                         "packet-offset=%jd, packet-size-bytes=%jd, "
 578                                         "file-size=%jd",
 579                                         ds_file->file->path->str,
 580                                         current_packet_offset,
 581                                         current_packet_size_bytes,
 582                                         ds_file->file->size);
 583                         goto error;
 584                 }
 585
 586                 next_packet_offset = current_packet_offset +
 587                         current_packet_size_bytes;
 588                 BT_LOGD("Seeking to next packet: current-packet-offset=%jd, "
 589                         "next-packet-offset=%jd", current_packet_offset,
 590                         next_packet_offset);
 591
 592                 entry = ctf_fs_ds_index_add_new_entry(index);
 593                 if (!entry) {
 594                         BT_LOGE_STR("Failed to allocate a new index entry.");
 595                         goto error;
 596                 }
 597
 598                 ret = init_index_entry(entry, ds_file, &props,
 599                         current_packet_size_bytes, current_packet_offset);
 600                 if (ret) {
 601                         goto error;
 602                 }
 603
 604                 iter_status = bt_notif_iter_seek(ds_file->notif_iter,
 605                                 next_packet_offset);
 606         } while (iter_status == BT_NOTIF_ITER_STATUS_OK);
 607
 608         if (iter_status != BT_NOTIF_ITER_STATUS_EOF) {
 609                 goto error;
 610         }
 611
 612 end:
 613         return index;
 614
 615 error:
 616         ctf_fs_ds_index_destroy(index);
 617         index = NULL;
 618         goto end;
 619 }
 620
 621 BT_HIDDEN
 622 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
 623                 struct ctf_fs_trace *ctf_fs_trace,
 624                 struct bt_private_connection_private_notification_iterator *pc_notif_iter,
 625                 struct bt_notif_iter *notif_iter,
 626                 struct bt_stream *stream, const char *path)
 627 {
 628         int ret;
 629         const size_t page_size = bt_common_get_page_size();
 630         struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
 631
 632         if (!ds_file) {
 633                 goto error;
 634         }
 635
 636         ds_file->pc_notif_iter = pc_notif_iter;
 637         ds_file->file = ctf_fs_file_create();
 638         if (!ds_file->file) {
 639                 goto error;
 640         }
 641
 642         ds_file->stream = bt_get(stream);
 643         ds_file->metadata = ctf_fs_trace->metadata;
 644         g_string_assign(ds_file->file->path, path);
 645         ret = ctf_fs_file_open(ds_file->file, "rb");
 646         if (ret) {
 647                 goto error;
 648         }
 649
 650         ds_file->notif_iter = notif_iter;
 651         bt_notif_iter_set_medops_data(ds_file->notif_iter, ds_file);
 652         if (!ds_file->notif_iter) {
 653                 goto error;
 654         }
 655
 656         ds_file->mmap_max_len = page_size * 2048;
 657
 658         goto end;
 659
 660 error:
 661         /* Do not touch "borrowed" file. */
 662         ctf_fs_ds_file_destroy(ds_file);
 663         ds_file = NULL;
 664
 665 end:
 666         return ds_file;
 667 }
 668
 669 BT_HIDDEN
 670 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
 671                 struct ctf_fs_ds_file *ds_file)
 672 {
 673         struct ctf_fs_ds_index *index;
 674
 675         index = build_index_from_idx_file(ds_file);
 676         if (index) {
 677                 goto end;
 678         }
 679
 680         BT_LOGD("Failed to build index from .index file; "
 681                 "falling back to stream indexing.");
 682         index = build_index_from_stream_file(ds_file);
 683 end:
 684         return index;
 685 }
 686
 687 BT_HIDDEN
 688 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
 689 {
 690         if (!ds_file) {
 691                 return;
 692         }
 693
 694         bt_put(ds_file->cc_prio_map);
 695         bt_put(ds_file->stream);
 696         (void) ds_file_munmap(ds_file);
 697
 698         if (ds_file->file) {
 699                 ctf_fs_file_destroy(ds_file->file);
 700         }
 701
 702         g_free(ds_file);
 703 }
 704
 705 BT_HIDDEN
 706 enum bt_notification_iterator_status ctf_fs_ds_file_next(
 707                 struct ctf_fs_ds_file *ds_file,
 708                 struct bt_notification **notif)
 709 {
 710         enum bt_notif_iter_status notif_iter_status;
 711         enum bt_notification_iterator_status status;
 712
 713         notif_iter_status = bt_notif_iter_get_next_notification(
 714                 ds_file->notif_iter, ds_file->pc_notif_iter, notif);
 715
 716         switch (notif_iter_status) {
 717         case BT_NOTIF_ITER_STATUS_EOF:
 718                 status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 719                 break;
 720         case BT_NOTIF_ITER_STATUS_OK:
 721                 status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
 722                 break;
 723         case BT_NOTIF_ITER_STATUS_AGAIN:
 724                 /*
 725                  * Should not make it this far as this is
 726                  * medium-specific; there is nothing for the user to do
 727                  * and it should have been handled upstream.
 728                  */
 729                 abort();
 730         case BT_NOTIF_ITER_STATUS_INVAL:
 731         case BT_NOTIF_ITER_STATUS_ERROR:
 732         default:
 733                 status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 734                 break;
 735         }
 736         return status;
 737 }
 738
 739 BT_HIDDEN
 740 int ctf_fs_ds_file_borrow_packet_header_context_fields(
 741                 struct ctf_fs_ds_file *ds_file,
 742                 struct bt_field **packet_header_field,
 743                 struct bt_field **packet_context_field)
 744 {
 745         enum bt_notif_iter_status notif_iter_status;
 746         int ret = 0;
 747
 748         BT_ASSERT(ds_file);
 749         notif_iter_status = bt_notif_iter_borrow_packet_header_context_fields(
 750                 ds_file->notif_iter, packet_header_field, packet_context_field);
 751         switch (notif_iter_status) {
 752         case BT_NOTIF_ITER_STATUS_EOF:
 753         case BT_NOTIF_ITER_STATUS_OK:
 754                 break;
 755         case BT_NOTIF_ITER_STATUS_AGAIN:
 756                 abort();
 757         case BT_NOTIF_ITER_STATUS_INVAL:
 758         case BT_NOTIF_ITER_STATUS_ERROR:
 759         default:
 760                 goto error;
 761                 break;
 762         }
 763
 764         goto end;
 765
 766 error:
 767         ret = -1;
 768
 769 end:
 770         return ret;
 771 }
 772
 773 BT_HIDDEN
 774 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
 775 {
 776         if (!index) {
 777                 return;
 778         }
 779
 780         if (index->entries) {
 781                 g_array_free(index->entries, TRUE);
 782         }
 783         g_free(index);
 784 }