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/ctf-ir/stream.h>
  35 #include <babeltrace/graph/notification-iterator.h>
  36 #include <babeltrace/graph/notification-stream.h>
  37 #include <babeltrace/graph/notification-event.h>
  38 #include <babeltrace/graph/notification-packet.h>
  39 #include <babeltrace/common-internal.h>
  40 #include "file.h"
  41 #include "metadata.h"
  42 #include "../common/notif-iter/notif-iter.h"
  43 #include <assert.h>
  44 #include "data-stream-file.h"
  45 #include <string.h>
  46
  47 #define BT_LOG_TAG "PLUGIN-CTF-FS-SRC-DS"
  48 #include "logging.h"
  49
  50 static inline
  51 size_t remaining_mmap_bytes(struct ctf_fs_ds_file *ds_file)
  52 {
  53         return ds_file->mmap_len - ds_file->request_offset;
  54 }
  55
  56 static
  57 int ds_file_munmap(struct ctf_fs_ds_file *ds_file)
  58 {
  59         int ret = 0;
  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_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->path->str,
  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 bt_ctf_notif_iter_medium_status ds_file_mmap_next(
  83                 struct ctf_fs_ds_file *ds_file)
  84 {
  85         enum bt_ctf_notif_iter_medium_status ret =
  86                         BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
  87
  88         /* Unmap old region */
  89         if (ds_file->mmap_addr) {
  90                 if (ds_file_munmap(ds_file)) {
  91                         goto error;
  92                 }
  93
  94                 /*
  95                  * mmap_len is guaranteed to be page-aligned except on the
  96                  * last mapping where it may not be possible (since the file's
  97                  * size itself may not be a page multiple).
  98                  */
  99                 ds_file->mmap_offset += ds_file->mmap_len;
 100                 ds_file->request_offset = 0;
 101         }
 102
 103         ds_file->mmap_len = MIN(ds_file->file->size - ds_file->mmap_offset,
 104                         ds_file->mmap_max_len);
 105         if (ds_file->mmap_len == 0) {
 106                 ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
 107                 goto end;
 108         }
 109         /* Map new region */
 110         assert(ds_file->mmap_len);
 111         ds_file->mmap_addr = bt_mmap((void *) 0, ds_file->mmap_len,
 112                         PROT_READ, MAP_PRIVATE, fileno(ds_file->file->fp),
 113                         ds_file->mmap_offset);
 114         if (ds_file->mmap_addr == MAP_FAILED) {
 115                 BT_LOGE("Cannot memory-map address (size %zu) of file \"%s\" (%p) at offset %jd: %s",
 116                                 ds_file->mmap_len, ds_file->file->path->str,
 117                                 ds_file->file->fp, (intmax_t) ds_file->mmap_offset,
 118                                 strerror(errno));
 119                 goto error;
 120         }
 121
 122         goto end;
 123 error:
 124         ds_file_munmap(ds_file);
 125         ret = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
 126 end:
 127         return ret;
 128 }
 129
 130 static
 131 enum bt_ctf_notif_iter_medium_status medop_request_bytes(
 132                 size_t request_sz, uint8_t **buffer_addr,
 133                 size_t *buffer_sz, void *data)
 134 {
 135         enum bt_ctf_notif_iter_medium_status status =
 136                 BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK;
 137         struct ctf_fs_ds_file *ds_file = data;
 138
 139         if (request_sz == 0) {
 140                 goto end;
 141         }
 142
 143         /* Check if we have at least one memory-mapped byte left */
 144         if (remaining_mmap_bytes(ds_file) == 0) {
 145                 /* Are we at the end of the file? */
 146                 if (ds_file->mmap_offset >= ds_file->file->size) {
 147                         BT_LOGD("Reached end of file \"%s\" (%p)",
 148                                 ds_file->file->path->str, ds_file->file->fp);
 149                         status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF;
 150                         goto end;
 151                 }
 152
 153                 status = ds_file_mmap_next(ds_file);
 154                 switch (status) {
 155                 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_OK:
 156                         break;
 157                 case BT_CTF_NOTIF_ITER_MEDIUM_STATUS_EOF:
 158                         goto end;
 159                 default:
 160                         BT_LOGE("Cannot memory-map next region of file \"%s\" (%p)",
 161                                         ds_file->file->path->str,
 162                                         ds_file->file->fp);
 163                         goto error;
 164                 }
 165         }
 166
 167         *buffer_sz = MIN(remaining_mmap_bytes(ds_file), request_sz);
 168         *buffer_addr = ((uint8_t *) ds_file->mmap_addr) + ds_file->request_offset;
 169         ds_file->request_offset += *buffer_sz;
 170         goto end;
 171
 172 error:
 173         status = BT_CTF_NOTIF_ITER_MEDIUM_STATUS_ERROR;
 174
 175 end:
 176         return status;
 177 }
 178
 179 static
 180 struct bt_ctf_stream *medop_get_stream(
 181                 struct bt_ctf_stream_class *stream_class, uint64_t stream_id,
 182                 void *data)
 183 {
 184         struct ctf_fs_ds_file *ds_file = data;
 185         struct bt_ctf_stream_class *ds_file_stream_class;
 186         struct bt_ctf_stream *stream = NULL;
 187
 188         ds_file_stream_class = bt_ctf_stream_get_class(ds_file->stream);
 189         bt_put(ds_file_stream_class);
 190
 191         if (stream_class != ds_file_stream_class) {
 192                 /*
 193                  * Not supported: two packets described by two different
 194                  * stream classes within the same data stream file.
 195                  */
 196                 goto end;
 197         }
 198
 199         stream = ds_file->stream;
 200
 201 end:
 202         return stream;
 203 }
 204
 205 BT_HIDDEN
 206 struct bt_ctf_notif_iter_medium_ops ctf_fs_ds_file_medops = {
 207         .request_bytes = medop_request_bytes,
 208         .get_stream = medop_get_stream,
 209 };
 210
 211 static
 212 struct ctf_fs_ds_index *ctf_fs_ds_index_create(size_t length)
 213 {
 214         struct ctf_fs_ds_index *index = g_new0(struct ctf_fs_ds_index, 1);
 215
 216         if (!index) {
 217                 BT_LOGE_STR("Failed to allocate index");
 218                 goto error;
 219         }
 220
 221         index->entries = g_array_sized_new(FALSE, TRUE,
 222                         sizeof(struct ctf_fs_ds_index_entry), length);
 223         if (!index->entries) {
 224                 BT_LOGE("Failed to allocate %zu index entries.", length);
 225                 goto error;
 226         }
 227         g_array_set_size(index->entries, length);
 228 end:
 229         return index;
 230 error:
 231         ctf_fs_ds_index_destroy(index);
 232         goto end;
 233 }
 234
 235 static
 236 struct bt_ctf_clock_class *get_field_mapped_clock_class(
 237                 struct bt_ctf_field *field)
 238 {
 239         struct bt_ctf_field_type *field_type;
 240         struct bt_ctf_clock_class *clock_class = NULL;
 241
 242         field_type = bt_ctf_field_get_type(field);
 243         if (!field_type) {
 244                 goto end;
 245         }
 246
 247         clock_class = bt_ctf_field_type_integer_get_mapped_clock_class(
 248                         field_type);
 249         if (!clock_class) {
 250                 goto end;
 251         }
 252 end:
 253         bt_put(field_type);
 254         return clock_class;
 255 }
 256
 257 static
 258 int get_ds_file_packet_bounds_clock_classes(struct ctf_fs_ds_file *ds_file,
 259                 struct bt_ctf_clock_class **_timestamp_begin_cc,
 260                 struct bt_ctf_clock_class **_timestamp_end_cc)
 261 {
 262         int ret;
 263         struct bt_ctf_field *timestamp_field = NULL;
 264         struct bt_ctf_field *packet_context_field = NULL;
 265         struct bt_ctf_clock_class *timestamp_begin_cc = NULL;
 266         struct bt_ctf_clock_class *timestamp_end_cc = NULL;
 267
 268         ret = ctf_fs_ds_file_get_packet_header_context_fields(ds_file,
 269                 NULL, &packet_context_field);
 270         if (ret || !packet_context_field) {
 271                 BT_LOGD("Cannot retrieve packet context field of stream \'%s\'",
 272                                 ds_file->file->path->str);
 273                 ret = -1;
 274                 goto end;
 275         }
 276
 277         timestamp_field = bt_ctf_field_structure_get_field_by_name(
 278                         packet_context_field, "timestamp_begin");
 279         if (!timestamp_field) {
 280                 BT_LOGD("Cannot retrieve timestamp_begin field in packet context of stream \'%s\'",
 281                                 ds_file->file->path->str);
 282                 ret = -1;
 283                 goto end;
 284         }
 285
 286         timestamp_begin_cc = get_field_mapped_clock_class(timestamp_field);
 287         if (!timestamp_begin_cc) {
 288                 BT_LOGD("Cannot retrieve the clock mapped to timestamp_begin of stream \'%s\'",
 289                                 ds_file->file->path->str);
 290         }
 291         BT_PUT(timestamp_field);
 292
 293         timestamp_field = bt_ctf_field_structure_get_field_by_name(
 294                         packet_context_field, "timestamp_end");
 295         if (!timestamp_field) {
 296                 BT_LOGD("Cannot retrieve timestamp_end field in packet context of stream \'%s\'",
 297                                 ds_file->file->path->str);
 298                 ret = -1;
 299                 goto end;
 300         }
 301
 302         timestamp_end_cc = get_field_mapped_clock_class(timestamp_field);
 303         if (!timestamp_end_cc) {
 304                 BT_LOGD("Cannot retrieve the clock mapped to timestamp_end in stream \'%s\'",
 305                                 ds_file->file->path->str);
 306         }
 307
 308         if (_timestamp_begin_cc) {
 309                 *_timestamp_begin_cc = bt_get(timestamp_begin_cc);
 310         }
 311         if (_timestamp_end_cc) {
 312                 *_timestamp_end_cc = bt_get(timestamp_end_cc);
 313         }
 314 end:
 315         bt_put(packet_context_field);
 316         bt_put(timestamp_field);
 317         bt_put(timestamp_begin_cc);
 318         bt_put(timestamp_end_cc);
 319         return ret;
 320 }
 321
 322 static
 323 int convert_cycles_to_ns(struct bt_ctf_clock_class *clock_class,
 324                 uint64_t cycles, int64_t *ns)
 325 {
 326         int ret = 0;
 327         struct bt_ctf_clock_value *clock_value;
 328
 329         assert(ns);
 330         clock_value = bt_ctf_clock_value_create(clock_class, cycles);
 331         if (!clock_value) {
 332                 ret = -1;
 333                 goto end;
 334         }
 335
 336         ret = bt_ctf_clock_value_get_value_ns_from_epoch(clock_value, ns);
 337         if (ret) {
 338                 goto end;
 339         }
 340 end:
 341         bt_put(clock_value);
 342         return ret;
 343 }
 344
 345 static
 346 struct ctf_fs_ds_index *build_index_from_idx_file(
 347                 struct ctf_fs_ds_file *ds_file)
 348 {
 349         int ret;
 350         gchar *directory = NULL;
 351         gchar *basename = NULL;
 352         GString *index_basename = NULL;
 353         gchar *index_file_path = NULL;
 354         GMappedFile *mapped_file = NULL;
 355         gsize filesize;
 356         const char *mmap_begin = NULL, *file_pos = NULL;
 357         const struct ctf_packet_index_file_hdr *header = NULL;
 358         struct ctf_fs_ds_index *index = NULL;
 359         struct ctf_fs_ds_index_entry *index_entry = NULL;
 360         uint64_t total_packets_size = 0;
 361         size_t file_index_entry_size;
 362         size_t file_entry_count;
 363         size_t i;
 364         struct bt_ctf_clock_class *timestamp_begin_cc = NULL;
 365         struct bt_ctf_clock_class *timestamp_end_cc = NULL;
 366
 367         BT_LOGD("Building index from .idx file of stream file %s",
 368                         ds_file->file->path->str);
 369
 370         ret = get_ds_file_packet_bounds_clock_classes(ds_file,
 371                         &timestamp_begin_cc, &timestamp_end_cc);
 372         if (ret) {
 373                 BT_LOGD("Cannot get clock classes of \"timestamp_begin\" and \"timestamp_end\" fields");
 374                 goto error;
 375         }
 376
 377         /* Look for index file in relative path index/name.idx. */
 378         basename = g_path_get_basename(ds_file->file->path->str);
 379         if (!basename) {
 380                 BT_LOGE("Cannot get the basename of datastream file %s",
 381                                 ds_file->file->path->str);
 382                 goto error;
 383         }
 384
 385         directory = g_path_get_dirname(ds_file->file->path->str);
 386         if (!directory) {
 387                 BT_LOGE("Cannot get dirname of datastream file %s",
 388                                 ds_file->file->path->str);
 389                 goto error;
 390         }
 391
 392         index_basename = g_string_new(basename);
 393         if (!index_basename) {
 394                 BT_LOGE("Cannot allocate index file basename string");
 395                 goto error;
 396         }
 397
 398         g_string_append(index_basename, ".idx");
 399         index_file_path = g_build_filename(directory, "index",
 400                         index_basename->str, NULL);
 401         mapped_file = g_mapped_file_new(index_file_path, FALSE, NULL);
 402         if (!mapped_file) {
 403                 BT_LOGD("Cannot create new mapped file %s",
 404                                 index_file_path);
 405                 goto error;
 406         }
 407
 408         /*
 409          * The g_mapped_file API limits us to 4GB files on 32-bit.
 410          * Traces with such large indexes have never been seen in the wild,
 411          * but this would need to be adjusted to support them.
 412          */
 413         filesize = g_mapped_file_get_length(mapped_file);
 414         if (filesize < sizeof(*header)) {
 415                 BT_LOGW("Invalid LTTng trace index file: "
 416                         "file size (%zu bytes) < header size (%zu bytes)",
 417                         filesize, sizeof(*header));
 418                 goto error;
 419         }
 420
 421         mmap_begin = g_mapped_file_get_contents(mapped_file);
 422         header = (struct ctf_packet_index_file_hdr *) mmap_begin;
 423
 424         file_pos = g_mapped_file_get_contents(mapped_file) + sizeof(*header);
 425         if (be32toh(header->magic) != CTF_INDEX_MAGIC) {
 426                 BT_LOGW("Invalid LTTng trace index: \"magic\" field validation failed");
 427                 goto error;
 428         }
 429
 430         file_index_entry_size = be32toh(header->packet_index_len);
 431         file_entry_count = (filesize - sizeof(*header)) / file_index_entry_size;
 432         if ((filesize - sizeof(*header)) % file_index_entry_size) {
 433                 BT_LOGW("Invalid LTTng trace index: the index's size after the header "
 434                         "(%zu bytes) is not a multiple of the index entry size "
 435                         "(%zu bytes)", (filesize - sizeof(*header)),
 436                         sizeof(*header));
 437                 goto error;
 438         }
 439
 440         index = ctf_fs_ds_index_create(file_entry_count);
 441         if (!index) {
 442                 goto error;
 443         }
 444
 445         index_entry = (struct ctf_fs_ds_index_entry *) &g_array_index(
 446                         index->entries, struct ctf_fs_ds_index_entry, 0);
 447         for (i = 0; i < file_entry_count; i++) {
 448                 struct ctf_packet_index *file_index =
 449                                 (struct ctf_packet_index *) file_pos;
 450                 uint64_t packet_size = be64toh(file_index->packet_size);
 451
 452                 if (packet_size % CHAR_BIT) {
 453                         BT_LOGW("Invalid packet size encountered in LTTng trace index file");
 454                         goto error;
 455                 }
 456
 457                 /* Convert size in bits to bytes. */
 458                 packet_size /= CHAR_BIT;
 459                 index_entry->packet_size = packet_size;
 460
 461                 index_entry->offset = be64toh(file_index->offset);
 462                 if (i != 0 && index_entry->offset < (index_entry - 1)->offset) {
 463                         BT_LOGW("Invalid, non-monotonic, packet offset encountered in LTTng trace index file: "
 464                                 "previous offset=%" PRIu64 ", current offset=%" PRIu64,
 465                                 (index_entry - 1)->offset, index_entry->offset);
 466                         goto error;
 467                 }
 468
 469                 index_entry->timestamp_begin = be64toh(file_index->timestamp_begin);
 470                 index_entry->timestamp_end = be64toh(file_index->timestamp_end);
 471                 if (index_entry->timestamp_end < index_entry->timestamp_begin) {
 472                         BT_LOGW("Invalid packet time bounds encountered in LTTng trace index file (begin > end): "
 473                                 "timestamp_begin=%" PRIu64 "timestamp_end=%" PRIu64,
 474                                 index_entry->timestamp_begin,
 475                                 index_entry->timestamp_end);
 476                         goto error;
 477                 }
 478
 479                 /* Convert the packet's bound to nanoseconds since Epoch. */
 480                 ret = convert_cycles_to_ns(timestamp_begin_cc,
 481                                 index_entry->timestamp_begin,
 482                                 &index_entry->timestamp_begin_ns);
 483                 if (ret) {
 484                         BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during index parsing");
 485                         goto error;
 486                 }
 487                 ret = convert_cycles_to_ns(timestamp_end_cc,
 488                                 index_entry->timestamp_end,
 489                                 &index_entry->timestamp_end_ns);
 490                 if (ret) {
 491                         BT_LOGD("Failed to convert raw timestamp to nanoseconds since Epoch during LTTng trace index parsing");
 492                         goto error;
 493                 }
 494
 495                 total_packets_size += packet_size;
 496                 file_pos += file_index_entry_size;
 497                 index_entry++;
 498         }
 499
 500         /* Validate that the index addresses the complete stream. */
 501         if (ds_file->file->size != total_packets_size) {
 502                 BT_LOGW("Invalid LTTng trace index file; indexed size != stream file size: "
 503                         "file_size=%" PRIu64 ", total_packets_size=%" PRIu64,
 504                         ds_file->file->size, total_packets_size);
 505                 goto error;
 506         }
 507 end:
 508         g_free(directory);
 509         g_free(basename);
 510         g_free(index_file_path);
 511         if (index_basename) {
 512                 g_string_free(index_basename, TRUE);
 513         }
 514         if (mapped_file) {
 515                 g_mapped_file_unref(mapped_file);
 516         }
 517         bt_put(timestamp_begin_cc);
 518         bt_put(timestamp_end_cc);
 519         return index;
 520 error:
 521         ctf_fs_ds_index_destroy(index);
 522         index = NULL;
 523         goto end;
 524 }
 525
 526 BT_HIDDEN
 527 struct ctf_fs_ds_file *ctf_fs_ds_file_create(
 528                 struct ctf_fs_trace *ctf_fs_trace,
 529                 struct bt_ctf_notif_iter *notif_iter,
 530                 struct bt_ctf_stream *stream, const char *path)
 531 {
 532         int ret;
 533         const size_t page_size = bt_common_get_page_size();
 534         struct ctf_fs_ds_file *ds_file = g_new0(struct ctf_fs_ds_file, 1);
 535
 536         if (!ds_file) {
 537                 goto error;
 538         }
 539
 540         ds_file->file = ctf_fs_file_create();
 541         if (!ds_file->file) {
 542                 goto error;
 543         }
 544
 545         ds_file->stream = bt_get(stream);
 546         ds_file->cc_prio_map = bt_get(ctf_fs_trace->cc_prio_map);
 547         g_string_assign(ds_file->file->path, path);
 548         ret = ctf_fs_file_open(ds_file->file, "rb");
 549         if (ret) {
 550                 goto error;
 551         }
 552
 553         ds_file->notif_iter = notif_iter;
 554         bt_ctf_notif_iter_set_medops_data(ds_file->notif_iter, ds_file);
 555         if (!ds_file->notif_iter) {
 556                 goto error;
 557         }
 558
 559         ds_file->mmap_max_len = page_size * 2048;
 560
 561         goto end;
 562
 563 error:
 564         /* Do not touch "borrowed" file. */
 565         ctf_fs_ds_file_destroy(ds_file);
 566         ds_file = NULL;
 567
 568 end:
 569         return ds_file;
 570 }
 571
 572 BT_HIDDEN
 573 struct ctf_fs_ds_index *ctf_fs_ds_file_build_index(
 574                 struct ctf_fs_ds_file *ds_file)
 575 {
 576         return build_index_from_idx_file(ds_file);
 577 }
 578
 579 BT_HIDDEN
 580 void ctf_fs_ds_file_destroy(struct ctf_fs_ds_file *ds_file)
 581 {
 582         if (!ds_file) {
 583                 return;
 584         }
 585
 586         bt_put(ds_file->cc_prio_map);
 587         bt_put(ds_file->stream);
 588         (void) ds_file_munmap(ds_file);
 589
 590         if (ds_file->file) {
 591                 ctf_fs_file_destroy(ds_file->file);
 592         }
 593
 594         g_free(ds_file);
 595 }
 596
 597 BT_HIDDEN
 598 struct bt_notification_iterator_next_return ctf_fs_ds_file_next(
 599                 struct ctf_fs_ds_file *ds_file)
 600 {
 601         enum bt_ctf_notif_iter_status notif_iter_status;
 602         struct bt_notification_iterator_next_return ret = {
 603                 .status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR,
 604                 .notification = NULL,
 605         };
 606
 607         notif_iter_status = bt_ctf_notif_iter_get_next_notification(
 608                 ds_file->notif_iter, ds_file->cc_prio_map, &ret.notification);
 609
 610         switch (notif_iter_status) {
 611         case BT_CTF_NOTIF_ITER_STATUS_EOF:
 612                 ret.status = BT_NOTIFICATION_ITERATOR_STATUS_END;
 613                 break;
 614         case BT_CTF_NOTIF_ITER_STATUS_OK:
 615                 ret.status = BT_NOTIFICATION_ITERATOR_STATUS_OK;
 616                 break;
 617         case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
 618                 /*
 619                  * Should not make it this far as this is
 620                  * medium-specific; there is nothing for the user to do
 621                  * and it should have been handled upstream.
 622                  */
 623                 abort();
 624         case BT_CTF_NOTIF_ITER_STATUS_INVAL:
 625         case BT_CTF_NOTIF_ITER_STATUS_ERROR:
 626         default:
 627                 ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 628                 break;
 629         }
 630
 631         return ret;
 632 }
 633
 634 BT_HIDDEN
 635 int ctf_fs_ds_file_get_packet_header_context_fields(
 636                 struct ctf_fs_ds_file *ds_file,
 637                 struct bt_ctf_field **packet_header_field,
 638                 struct bt_ctf_field **packet_context_field)
 639 {
 640         enum bt_ctf_notif_iter_status notif_iter_status;
 641         int ret = 0;
 642
 643         assert(ds_file);
 644         notif_iter_status = bt_ctf_notif_iter_get_packet_header_context_fields(
 645                 ds_file->notif_iter, packet_header_field, packet_context_field);
 646         switch (notif_iter_status) {
 647         case BT_CTF_NOTIF_ITER_STATUS_EOF:
 648         case BT_CTF_NOTIF_ITER_STATUS_OK:
 649                 break;
 650         case BT_CTF_NOTIF_ITER_STATUS_AGAIN:
 651                 abort();
 652         case BT_CTF_NOTIF_ITER_STATUS_INVAL:
 653         case BT_CTF_NOTIF_ITER_STATUS_ERROR:
 654         default:
 655                 goto error;
 656                 break;
 657         }
 658
 659         goto end;
 660
 661 error:
 662         ret = -1;
 663
 664         if (packet_header_field) {
 665                 bt_put(*packet_header_field);
 666         }
 667
 668         if (packet_context_field) {
 669                 bt_put(*packet_context_field);
 670         }
 671
 672 end:
 673         return ret;
 674 }
 675
 676 BT_HIDDEN
 677 void ctf_fs_ds_index_destroy(struct ctf_fs_ds_index *index)
 678 {
 679         if (!index) {
 680                 return;
 681         }
 682
 683         if (index->entries) {
 684                 g_array_free(index->entries, TRUE);
 685         }
 686         g_free(index);
 687 }