formats/ctf/ctf.c

   1 /*
   2  * BabelTrace - Common Trace Format (CTF)
   3  *
   4  * Format registration.
   5  *
   6  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   7  *
   8  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  */
  20
  21 #include <babeltrace/format.h>
  22 #include <babeltrace/ctf/types.h>
  23 #include <babeltrace/ctf/metadata.h>
  24 #include <babeltrace/babeltrace-internal.h>
  25 #include <babeltrace/ctf/events-internal.h>
  26 #include <babeltrace/trace-handle-internal.h>
  27 #include <babeltrace/context-internal.h>
  28 #include <babeltrace/uuid.h>
  29 #include <babeltrace/endian.h>
  30 #include <inttypes.h>
  31 #include <stdio.h>
  32 #include <sys/mman.h>
  33 #include <errno.h>
  34 #include <sys/types.h>
  35 #include <sys/stat.h>
  36 #include <fcntl.h>
  37 #include <dirent.h>
  38 #include <glib.h>
  39 #include <unistd.h>
  40 #include <stdlib.h>
  41
  42 #include "metadata/ctf-scanner.h"
  43 #include "metadata/ctf-parser.h"
  44 #include "metadata/ctf-ast.h"
  45 #include "events-private.h"
  46 #include "memstream.h"
  47
  48 /*
  49  * We currently simply map a page to read the packet header and packet
  50  * context to get the packet length and content length. (in bits)
  51  */
  52 #define MAX_PACKET_HEADER_LEN   (getpagesize() * CHAR_BIT)
  53 #define WRITE_PACKET_LEN        (getpagesize() * 8 * CHAR_BIT)
  54
  55 #ifndef min
  56 #define min(a, b)       (((a) < (b)) ? (a) : (b))
  57 #endif
  58
  59 #define NSEC_PER_SEC 1000000000ULL
  60
  61 int opt_clock_cycles,
  62         opt_clock_seconds,
  63         opt_clock_date,
  64         opt_clock_gmt;
  65
  66 uint64_t opt_clock_offset;
  67
  68 extern int yydebug;
  69
  70 static
  71 struct trace_descriptor *ctf_open_trace(const char *path, int flags,
  72                 void (*packet_seek)(struct stream_pos *pos, size_t index,
  73                         int whence),
  74                 FILE *metadata_fp);
  75 static
  76 struct trace_descriptor *ctf_open_mmap_trace(
  77                 struct mmap_stream_list *mmap_list,
  78                 void (*packet_seek)(struct stream_pos *pos, size_t index,
  79                         int whence),
  80                 FILE *metadata_fp);
  81 static
  82 void ctf_set_context(struct trace_descriptor *descriptor,
  83                 struct bt_context *ctx);
  84 static
  85 void ctf_set_handle(struct trace_descriptor *descriptor,
  86                 struct bt_trace_handle *handle);
  87
  88 static
  89 void ctf_close_trace(struct trace_descriptor *descriptor);
  90 static
  91 uint64_t ctf_timestamp_begin(struct trace_descriptor *descriptor,
  92                 struct bt_trace_handle *handle, enum bt_clock_type type);
  93 static
  94 uint64_t ctf_timestamp_end(struct trace_descriptor *descriptor,
  95                 struct bt_trace_handle *handle, enum bt_clock_type type);
  96 static
  97 int ctf_convert_index_timestamp(struct trace_descriptor *tdp);
  98
  99 static
 100 rw_dispatch read_dispatch_table[] = {
 101         [ CTF_TYPE_INTEGER ] = ctf_integer_read,
 102         [ CTF_TYPE_FLOAT ] = ctf_float_read,
 103         [ CTF_TYPE_ENUM ] = ctf_enum_read,
 104         [ CTF_TYPE_STRING ] = ctf_string_read,
 105         [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
 106         [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
 107         [ CTF_TYPE_ARRAY ] = ctf_array_read,
 108         [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read,
 109 };
 110
 111 static
 112 rw_dispatch write_dispatch_table[] = {
 113         [ CTF_TYPE_INTEGER ] = ctf_integer_write,
 114         [ CTF_TYPE_FLOAT ] = ctf_float_write,
 115         [ CTF_TYPE_ENUM ] = ctf_enum_write,
 116         [ CTF_TYPE_STRING ] = ctf_string_write,
 117         [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
 118         [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
 119         [ CTF_TYPE_ARRAY ] = ctf_array_write,
 120         [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write,
 121 };
 122
 123 static
 124 struct format ctf_format = {
 125         .open_trace = ctf_open_trace,
 126         .open_mmap_trace = ctf_open_mmap_trace,
 127         .close_trace = ctf_close_trace,
 128         .set_context = ctf_set_context,
 129         .set_handle = ctf_set_handle,
 130         .timestamp_begin = ctf_timestamp_begin,
 131         .timestamp_end = ctf_timestamp_end,
 132         .convert_index_timestamp = ctf_convert_index_timestamp,
 133 };
 134
 135 static
 136 uint64_t ctf_timestamp_begin(struct trace_descriptor *descriptor,
 137                 struct bt_trace_handle *handle, enum bt_clock_type type)
 138 {
 139         struct ctf_trace *tin;
 140         uint64_t begin = ULLONG_MAX;
 141         int i, j;
 142
 143         tin = container_of(descriptor, struct ctf_trace, parent);
 144
 145         if (!tin)
 146                 goto error;
 147
 148         /* for each stream_class */
 149         for (i = 0; i < tin->streams->len; i++) {
 150                 struct ctf_stream_declaration *stream_class;
 151
 152                 stream_class = g_ptr_array_index(tin->streams, i);
 153                 if (!stream_class)
 154                         continue;
 155                 /* for each file_stream */
 156                 for (j = 0; j < stream_class->streams->len; j++) {
 157                         struct ctf_stream_definition *stream;
 158                         struct ctf_file_stream *cfs;
 159                         struct ctf_stream_pos *stream_pos;
 160                         struct packet_index *index;
 161
 162                         stream = g_ptr_array_index(stream_class->streams, j);
 163                         cfs = container_of(stream, struct ctf_file_stream,
 164                                         parent);
 165                         stream_pos = &cfs->pos;
 166
 167                         if (!stream_pos->packet_real_index)
 168                                 goto error;
 169
 170                         if (stream_pos->packet_real_index->len <= 0)
 171                                 continue;
 172
 173                         if (type == BT_CLOCK_REAL) {
 174                                 index = &g_array_index(stream_pos->packet_real_index,
 175                                                 struct packet_index,
 176                                                 stream_pos->packet_real_index->len - 1);
 177                         } else if (type == BT_CLOCK_CYCLES) {
 178                                 index = &g_array_index(stream_pos->packet_cycles_index,
 179                                                 struct packet_index,
 180                                                 stream_pos->packet_real_index->len - 1);
 181
 182                         } else {
 183                                 goto error;
 184                         }
 185                         if (index->timestamp_begin < begin)
 186                                 begin = index->timestamp_begin;
 187                 }
 188         }
 189
 190         return begin;
 191
 192 error:
 193         return -1ULL;
 194 }
 195
 196 static
 197 uint64_t ctf_timestamp_end(struct trace_descriptor *descriptor,
 198                 struct bt_trace_handle *handle, enum bt_clock_type type)
 199 {
 200         struct ctf_trace *tin;
 201         uint64_t end = 0;
 202         int i, j;
 203
 204         tin = container_of(descriptor, struct ctf_trace, parent);
 205
 206         if (!tin)
 207                 goto error;
 208
 209         /* for each stream_class */
 210         for (i = 0; i < tin->streams->len; i++) {
 211                 struct ctf_stream_declaration *stream_class;
 212
 213                 stream_class = g_ptr_array_index(tin->streams, i);
 214                 if (!stream_class)
 215                         continue;
 216                 /* for each file_stream */
 217                 for (j = 0; j < stream_class->streams->len; j++) {
 218                         struct ctf_stream_definition *stream;
 219                         struct ctf_file_stream *cfs;
 220                         struct ctf_stream_pos *stream_pos;
 221                         struct packet_index *index;
 222
 223                         stream = g_ptr_array_index(stream_class->streams, j);
 224                         cfs = container_of(stream, struct ctf_file_stream,
 225                                         parent);
 226                         stream_pos = &cfs->pos;
 227
 228                         if (!stream_pos->packet_real_index)
 229                                 goto error;
 230
 231                         if (stream_pos->packet_real_index->len <= 0)
 232                                 continue;
 233
 234                         if (type == BT_CLOCK_REAL) {
 235                                 index = &g_array_index(stream_pos->packet_real_index,
 236                                                 struct packet_index,
 237                                                 stream_pos->packet_real_index->len - 1);
 238                         } else if (type == BT_CLOCK_CYCLES) {
 239                                 index = &g_array_index(stream_pos->packet_cycles_index,
 240                                                 struct packet_index,
 241                                                 stream_pos->packet_real_index->len - 1);
 242
 243                         } else {
 244                                 goto error;
 245                         }
 246                         if (index->timestamp_end > end)
 247                                 end = index->timestamp_end;
 248                 }
 249         }
 250
 251         return end;
 252
 253 error:
 254         return -1ULL;
 255 }
 256
 257 /*
 258  * Update stream current timestamp
 259  */
 260 static
 261 void ctf_update_timestamp(struct ctf_stream_definition *stream,
 262                           struct definition_integer *integer_definition)
 263 {
 264         struct declaration_integer *integer_declaration =
 265                 integer_definition->declaration;
 266         uint64_t oldval, newval, updateval;
 267
 268         if (unlikely(integer_declaration->len == 64)) {
 269                 stream->prev_cycles_timestamp = stream->cycles_timestamp;
 270                 stream->cycles_timestamp = integer_definition->value._unsigned;
 271                 stream->prev_real_timestamp = ctf_get_real_timestamp(stream,
 272                                 stream->prev_cycles_timestamp);
 273                 stream->real_timestamp = ctf_get_real_timestamp(stream,
 274                                 stream->cycles_timestamp);
 275                 return;
 276         }
 277         /* keep low bits */
 278         oldval = stream->cycles_timestamp;
 279         oldval &= (1ULL << integer_declaration->len) - 1;
 280         newval = integer_definition->value._unsigned;
 281         /* Test for overflow by comparing low bits */
 282         if (newval < oldval)
 283                 newval += 1ULL << integer_declaration->len;
 284         /* updateval contains old high bits, and new low bits (sum) */
 285         updateval = stream->cycles_timestamp;
 286         updateval &= ~((1ULL << integer_declaration->len) - 1);
 287         updateval += newval;
 288         stream->prev_cycles_timestamp = stream->cycles_timestamp;
 289         stream->cycles_timestamp = updateval;
 290
 291         /* convert to real timestamp */
 292         stream->prev_real_timestamp = ctf_get_real_timestamp(stream,
 293                         stream->prev_cycles_timestamp);
 294         stream->real_timestamp = ctf_get_real_timestamp(stream,
 295                         stream->cycles_timestamp);
 296 }
 297
 298 /*
 299  * Print timestamp, rescaling clock frequency to nanoseconds and
 300  * applying offsets as needed (unix time).
 301  */
 302 void ctf_print_timestamp_real(FILE *fp,
 303                         struct ctf_stream_definition *stream,
 304                         uint64_t timestamp)
 305 {
 306         uint64_t ts_sec = 0, ts_nsec;
 307
 308         ts_nsec = timestamp;
 309
 310         /* Add command-line offset */
 311         ts_sec += opt_clock_offset;
 312
 313         ts_sec += ts_nsec / NSEC_PER_SEC;
 314         ts_nsec = ts_nsec % NSEC_PER_SEC;
 315
 316         if (!opt_clock_seconds) {
 317                 struct tm tm;
 318                 time_t time_s = (time_t) ts_sec;
 319
 320                 if (!opt_clock_gmt) {
 321                         struct tm *res;
 322
 323                         res = localtime_r(&time_s, &tm);
 324                         if (!res) {
 325                                 fprintf(stderr, "[warning] Unable to get localtime.\n");
 326                                 goto seconds;
 327                         }
 328                 } else {
 329                         struct tm *res;
 330
 331                         res = gmtime_r(&time_s, &tm);
 332                         if (!res) {
 333                                 fprintf(stderr, "[warning] Unable to get gmtime.\n");
 334                                 goto seconds;
 335                         }
 336                 }
 337                 if (opt_clock_date) {
 338                         char timestr[26];
 339                         size_t res;
 340
 341                         /* Print date and time */
 342                         res = strftime(timestr, sizeof(timestr),
 343                                 "%F ", &tm);
 344                         if (!res) {
 345                                 fprintf(stderr, "[warning] Unable to print ascii time.\n");
 346                                 goto seconds;
 347                         }
 348                         fprintf(fp, "%s", timestr);
 349                 }
 350                 /* Print time in HH:MM:SS.ns */
 351                 fprintf(fp, "%02d:%02d:%02d.%09" PRIu64,
 352                         tm.tm_hour, tm.tm_min, tm.tm_sec, ts_nsec);
 353                 goto end;
 354         }
 355 seconds:
 356         fprintf(fp, "%3" PRIu64 ".%09" PRIu64,
 357                 ts_sec, ts_nsec);
 358
 359 end:
 360         return;
 361 }
 362
 363 /*
 364  * Print timestamp, in cycles
 365  */
 366 void ctf_print_timestamp_cycles(FILE *fp,
 367                 struct ctf_stream_definition *stream,
 368                 uint64_t timestamp)
 369 {
 370         fprintf(fp, "%020" PRIu64, timestamp);
 371 }
 372
 373 void ctf_print_timestamp(FILE *fp,
 374                 struct ctf_stream_definition *stream,
 375                 uint64_t timestamp)
 376 {
 377         if (opt_clock_cycles) {
 378                 ctf_print_timestamp_cycles(fp, stream, timestamp);
 379         } else {
 380                 ctf_print_timestamp_real(fp, stream, timestamp);
 381         }
 382 }
 383
 384 static
 385 int ctf_read_event(struct stream_pos *ppos, struct ctf_stream_definition *stream)
 386 {
 387         struct ctf_stream_pos *pos =
 388                 container_of(ppos, struct ctf_stream_pos, parent);
 389         struct ctf_stream_declaration *stream_class = stream->stream_class;
 390         struct ctf_event_definition *event;
 391         uint64_t id = 0;
 392         int ret;
 393
 394         /* We need to check for EOF here for empty files. */
 395         if (unlikely(pos->offset == EOF))
 396                 return EOF;
 397
 398         ctf_pos_get_event(pos);
 399
 400         /* save the current position as a restore point */
 401         pos->last_offset = pos->offset;
 402
 403         /*
 404          * This is the EOF check after we've advanced the position in
 405          * ctf_pos_get_event.
 406          */
 407         if (unlikely(pos->offset == EOF))
 408                 return EOF;
 409         assert(pos->offset < pos->content_size);
 410
 411         /* Read event header */
 412         if (likely(stream->stream_event_header)) {
 413                 struct definition_integer *integer_definition;
 414                 struct definition *variant;
 415
 416                 ret = generic_rw(ppos, &stream->stream_event_header->p);
 417                 if (unlikely(ret))
 418                         goto error;
 419                 /* lookup event id */
 420                 integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
 421                 if (integer_definition) {
 422                         id = integer_definition->value._unsigned;
 423                 } else {
 424                         struct definition_enum *enum_definition;
 425
 426                         enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE);
 427                         if (enum_definition) {
 428                                 id = enum_definition->integer->value._unsigned;
 429                         }
 430                 }
 431
 432                 variant = lookup_variant(&stream->stream_event_header->p, "v");
 433                 if (variant) {
 434                         integer_definition = lookup_integer(variant, "id", FALSE);
 435                         if (integer_definition) {
 436                                 id = integer_definition->value._unsigned;
 437                         }
 438                 }
 439                 stream->event_id = id;
 440
 441                 /* lookup timestamp */
 442                 stream->has_timestamp = 0;
 443                 integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
 444                 if (integer_definition) {
 445                         ctf_update_timestamp(stream, integer_definition);
 446                         stream->has_timestamp = 1;
 447                 } else {
 448                         if (variant) {
 449                                 integer_definition = lookup_integer(variant, "timestamp", FALSE);
 450                                 if (integer_definition) {
 451                                         ctf_update_timestamp(stream, integer_definition);
 452                                         stream->has_timestamp = 1;
 453                                 }
 454                         }
 455                 }
 456         }
 457
 458         /* Read stream-declared event context */
 459         if (stream->stream_event_context) {
 460                 ret = generic_rw(ppos, &stream->stream_event_context->p);
 461                 if (ret)
 462                         goto error;
 463         }
 464
 465         if (unlikely(id >= stream_class->events_by_id->len)) {
 466                 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
 467                 return -EINVAL;
 468         }
 469         event = g_ptr_array_index(stream->events_by_id, id);
 470         if (unlikely(!event)) {
 471                 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
 472                 return -EINVAL;
 473         }
 474
 475         /* Read event-declared event context */
 476         if (event->event_context) {
 477                 ret = generic_rw(ppos, &event->event_context->p);
 478                 if (ret)
 479                         goto error;
 480         }
 481
 482         /* Read event payload */
 483         if (likely(event->event_fields)) {
 484                 ret = generic_rw(ppos, &event->event_fields->p);
 485                 if (ret)
 486                         goto error;
 487         }
 488
 489         return 0;
 490
 491 error:
 492         fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
 493         return ret;
 494 }
 495
 496 static
 497 int ctf_write_event(struct stream_pos *pos, struct ctf_stream_definition *stream)
 498 {
 499         struct ctf_stream_declaration *stream_class = stream->stream_class;
 500         struct ctf_event_definition *event;
 501         uint64_t id;
 502         int ret;
 503
 504         id = stream->event_id;
 505
 506         /* print event header */
 507         if (likely(stream->stream_event_header)) {
 508                 ret = generic_rw(pos, &stream->stream_event_header->p);
 509                 if (ret)
 510                         goto error;
 511         }
 512
 513         /* print stream-declared event context */
 514         if (stream->stream_event_context) {
 515                 ret = generic_rw(pos, &stream->stream_event_context->p);
 516                 if (ret)
 517                         goto error;
 518         }
 519
 520         if (unlikely(id >= stream_class->events_by_id->len)) {
 521                 fprintf(stderr, "[error] Event id %" PRIu64 " is outside range.\n", id);
 522                 return -EINVAL;
 523         }
 524         event = g_ptr_array_index(stream->events_by_id, id);
 525         if (unlikely(!event)) {
 526                 fprintf(stderr, "[error] Event id %" PRIu64 " is unknown.\n", id);
 527                 return -EINVAL;
 528         }
 529
 530         /* print event-declared event context */
 531         if (event->event_context) {
 532                 ret = generic_rw(pos, &event->event_context->p);
 533                 if (ret)
 534                         goto error;
 535         }
 536
 537         /* Read and print event payload */
 538         if (likely(event->event_fields)) {
 539                 ret = generic_rw(pos, &event->event_fields->p);
 540                 if (ret)
 541                         goto error;
 542         }
 543
 544         return 0;
 545
 546 error:
 547         fprintf(stderr, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
 548         return ret;
 549 }
 550
 551 void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags)
 552 {
 553         pos->fd = fd;
 554         if (fd >= 0) {
 555                 pos->packet_cycles_index = g_array_new(FALSE, TRUE,
 556                                                 sizeof(struct packet_index));
 557                 pos->packet_real_index = g_array_new(FALSE, TRUE,
 558                                 sizeof(struct packet_index));
 559         } else {
 560                 pos->packet_cycles_index = NULL;
 561                 pos->packet_real_index = NULL;
 562         }
 563         switch (open_flags & O_ACCMODE) {
 564         case O_RDONLY:
 565                 pos->prot = PROT_READ;
 566                 pos->flags = MAP_PRIVATE;
 567                 pos->parent.rw_table = read_dispatch_table;
 568                 pos->parent.event_cb = ctf_read_event;
 569                 break;
 570         case O_RDWR:
 571                 pos->prot = PROT_WRITE; /* Write has priority */
 572                 pos->flags = MAP_SHARED;
 573                 pos->parent.rw_table = write_dispatch_table;
 574                 pos->parent.event_cb = ctf_write_event;
 575                 if (fd >= 0)
 576                         ctf_packet_seek(&pos->parent, 0, SEEK_SET);     /* position for write */
 577                 break;
 578         default:
 579                 assert(0);
 580         }
 581 }
 582
 583 void ctf_fini_pos(struct ctf_stream_pos *pos)
 584 {
 585         int ret;
 586
 587         if (pos->prot == PROT_WRITE && pos->content_size_loc)
 588                 *pos->content_size_loc = pos->offset;
 589         if (pos->base_mma) {
 590                 /* unmap old base */
 591                 ret = munmap_align(pos->base_mma);
 592                 if (ret) {
 593                         fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
 594                                 strerror(errno));
 595                         assert(0);
 596                 }
 597         }
 598         if (pos->packet_cycles_index)
 599                 (void) g_array_free(pos->packet_cycles_index, TRUE);
 600         if (pos->packet_real_index)
 601                 (void) g_array_free(pos->packet_real_index, TRUE);
 602 }
 603
 604 /*
 605  * for SEEK_CUR: go to next packet.
 606  * for SEEK_POS: go to packet numer (index).
 607  */
 608 void ctf_packet_seek(struct stream_pos *stream_pos, size_t index, int whence)
 609 {
 610         struct ctf_stream_pos *pos =
 611                 container_of(stream_pos, struct ctf_stream_pos, parent);
 612         struct ctf_file_stream *file_stream =
 613                 container_of(pos, struct ctf_file_stream, pos);
 614         int ret;
 615         off_t off;
 616         struct packet_index *packet_index;
 617
 618         if (pos->prot == PROT_WRITE && pos->content_size_loc)
 619                 *pos->content_size_loc = pos->offset;
 620
 621         if (pos->base_mma) {
 622                 /* unmap old base */
 623                 ret = munmap_align(pos->base_mma);
 624                 if (ret) {
 625                         fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
 626                                 strerror(errno));
 627                         assert(0);
 628                 }
 629                 pos->base_mma = NULL;
 630         }
 631
 632         /*
 633          * The caller should never ask for ctf_move_pos across packets,
 634          * except to get exactly at the beginning of the next packet.
 635          */
 636         if (pos->prot == PROT_WRITE) {
 637                 switch (whence) {
 638                 case SEEK_CUR:
 639                         /* The writer will add padding */
 640                         pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
 641                         break;
 642                 case SEEK_SET:
 643                         assert(index == 0);     /* only seek supported for now */
 644                         pos->cur_index = 0;
 645                         break;
 646                 default:
 647                         assert(0);
 648                 }
 649                 pos->content_size = -1U;        /* Unknown at this point */
 650                 pos->packet_size = WRITE_PACKET_LEN;
 651                 off = posix_fallocate(pos->fd, pos->mmap_offset,
 652                                       pos->packet_size / CHAR_BIT);
 653                 assert(off >= 0);
 654                 pos->offset = 0;
 655         } else {
 656         read_next_packet:
 657                 switch (whence) {
 658                 case SEEK_CUR:
 659                 {
 660                         uint64_t events_discarded_diff;
 661
 662                         if (pos->offset == EOF) {
 663                                 return;
 664                         }
 665                         /* For printing discarded event count */
 666                         packet_index = &g_array_index(pos->packet_cycles_index,
 667                                         struct packet_index, pos->cur_index);
 668                         file_stream->parent.prev_cycles_timestamp_end =
 669                                 packet_index->timestamp_end;
 670                         file_stream->parent.prev_cycles_timestamp =
 671                                 packet_index->timestamp_begin;
 672
 673                         packet_index = &g_array_index(pos->packet_real_index,
 674                                         struct packet_index, pos->cur_index);
 675                         file_stream->parent.prev_real_timestamp_end =
 676                                                 packet_index->timestamp_end;
 677                         file_stream->parent.prev_real_timestamp =
 678                                 packet_index->timestamp_begin;
 679
 680                         events_discarded_diff = packet_index->events_discarded;
 681                         if (pos->cur_index > 0) {
 682                                 packet_index = &g_array_index(pos->packet_real_index,
 683                                                 struct packet_index,
 684                                                 pos->cur_index - 1);
 685                                 events_discarded_diff -= packet_index->events_discarded;
 686                                 /*
 687                                  * Deal with 32-bit wrap-around if the
 688                                  * tracer provided a 32-bit field.
 689                                  */
 690                                 if (packet_index->events_discarded_len == 32) {
 691                                         events_discarded_diff = (uint32_t) events_discarded_diff;
 692                                 }
 693                         }
 694                         file_stream->parent.events_discarded = events_discarded_diff;
 695                         file_stream->parent.prev_real_timestamp = file_stream->parent.real_timestamp;
 696                         file_stream->parent.prev_cycles_timestamp = file_stream->parent.cycles_timestamp;
 697                         /* The reader will expect us to skip padding */
 698                         ++pos->cur_index;
 699                         break;
 700                 }
 701                 case SEEK_SET:
 702                         packet_index = &g_array_index(pos->packet_cycles_index,
 703                                         struct packet_index, index);
 704                         pos->last_events_discarded = packet_index->events_discarded;
 705                         pos->cur_index = index;
 706                         file_stream->parent.prev_real_timestamp = 0;
 707                         file_stream->parent.prev_real_timestamp_end = 0;
 708                         file_stream->parent.prev_cycles_timestamp = 0;
 709                         file_stream->parent.prev_cycles_timestamp_end = 0;
 710                         break;
 711                 default:
 712                         assert(0);
 713                 }
 714                 if (pos->cur_index >= pos->packet_real_index->len) {
 715                         /*
 716                          * When a stream reaches the end of the
 717                          * file, we need to show the number of
 718                          * events discarded ourselves, because
 719                          * there is no next event scheduled to
 720                          * be printed in the output.
 721                          */
 722                         if (file_stream->parent.events_discarded) {
 723                                 /*
 724                                  * We need to check if we are in trace
 725                                  * read or called from packet indexing.
 726                                  * In this last case, the collection is
 727                                  * not there, so we cannot print the
 728                                  * timestamps.
 729                                  */
 730                                 if ((&file_stream->parent)->stream_class->trace->collection) {
 731                                         fflush(stdout);
 732                                         fprintf(stderr, "[warning] Tracer discarded %" PRIu64 " events at end of stream between [",
 733                                                         file_stream->parent.events_discarded);
 734                                         if (opt_clock_cycles) {
 735                                                 ctf_print_timestamp(stderr,
 736                                                                 &file_stream->parent,
 737                                                                 file_stream->parent.prev_cycles_timestamp);
 738                                                 fprintf(stderr, "] and [");
 739                                                 ctf_print_timestamp(stderr, &file_stream->parent,
 740                                                                 file_stream->parent.prev_cycles_timestamp_end);
 741                                         } else {
 742                                                 ctf_print_timestamp(stderr,
 743                                                                 &file_stream->parent,
 744                                                                 file_stream->parent.prev_real_timestamp);
 745                                                 fprintf(stderr, "] and [");
 746                                                 ctf_print_timestamp(stderr, &file_stream->parent,
 747                                                                 file_stream->parent.prev_real_timestamp_end);
 748                                         }
 749                                         fprintf(stderr, "]. You should consider recording a new trace with larger buffers or with fewer events enabled.\n");
 750                                         fflush(stderr);
 751                                 }
 752                                 file_stream->parent.events_discarded = 0;
 753                         }
 754                         pos->offset = EOF;
 755                         return;
 756                 }
 757                 packet_index = &g_array_index(pos->packet_cycles_index,
 758                                 struct packet_index,
 759                                 pos->cur_index);
 760                 file_stream->parent.cycles_timestamp = packet_index->timestamp_begin;
 761
 762                 packet_index = &g_array_index(pos->packet_real_index,
 763                                 struct packet_index,
 764                                 pos->cur_index);
 765                 file_stream->parent.real_timestamp = packet_index->timestamp_begin;
 766                 pos->mmap_offset = packet_index->offset;
 767
 768                 /* Lookup context/packet size in index */
 769                 pos->content_size = packet_index->content_size;
 770                 pos->packet_size = packet_index->packet_size;
 771                 if (packet_index->data_offset < packet_index->content_size) {
 772                         pos->offset = 0;        /* will read headers */
 773                 } else if (packet_index->data_offset == packet_index->content_size) {
 774                         /* empty packet */
 775                         pos->offset = packet_index->data_offset;
 776                         whence = SEEK_CUR;
 777                         goto read_next_packet;
 778                 } else {
 779                         pos->offset = EOF;
 780                         return;
 781                 }
 782         }
 783         /* map new base. Need mapping length from header. */
 784         pos->base_mma = mmap_align(pos->packet_size / CHAR_BIT, pos->prot,
 785                         pos->flags, pos->fd, pos->mmap_offset);
 786         if (pos->base_mma == MAP_FAILED) {
 787                 fprintf(stderr, "[error] mmap error %s.\n",
 788                         strerror(errno));
 789                 assert(0);
 790         }
 791
 792         /* update trace_packet_header and stream_packet_context */
 793         if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) {
 794                 /* Read packet header */
 795                 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
 796                 assert(!ret);
 797         }
 798         if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) {
 799                 /* Read packet context */
 800                 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
 801                 assert(!ret);
 802         }
 803 }
 804
 805 static
 806 int packet_metadata(struct ctf_trace *td, FILE *fp)
 807 {
 808         uint32_t magic;
 809         size_t len;
 810         int ret = 0;
 811
 812         len = fread(&magic, sizeof(magic), 1, fp);
 813         if (len != 1) {
 814                 goto end;
 815         }
 816         if (magic == TSDL_MAGIC) {
 817                 ret = 1;
 818                 td->byte_order = BYTE_ORDER;
 819                 CTF_TRACE_SET_FIELD(td, byte_order);
 820         } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
 821                 ret = 1;
 822                 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
 823                                         LITTLE_ENDIAN : BIG_ENDIAN;
 824                 CTF_TRACE_SET_FIELD(td, byte_order);
 825         }
 826 end:
 827         rewind(fp);
 828         return ret;
 829 }
 830
 831 /*
 832  * Returns 0 on success, -1 on error.
 833  */
 834 static
 835 int check_version(unsigned int major, unsigned int minor)
 836 {
 837         switch (major) {
 838         case 1:
 839                 switch (minor) {
 840                 case 8:
 841                         return 0;
 842                 default:
 843                         goto warning;
 844                 }
 845         default:
 846                 goto warning;
 847
 848         }
 849
 850         /* eventually return an error instead of warning */
 851 warning:
 852         fprintf(stderr, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
 853                 major, minor);
 854         return 0;
 855 }
 856
 857 static
 858 int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
 859                                         FILE *out)
 860 {
 861         struct metadata_packet_header header;
 862         size_t readlen, writelen, toread;
 863         char buf[4096 + 1];     /* + 1 for debug-mode \0 */
 864         int ret = 0;
 865
 866         readlen = fread(&header, header_sizeof(header), 1, in);
 867         if (readlen < 1)
 868                 return -EINVAL;
 869
 870         if (td->byte_order != BYTE_ORDER) {
 871                 header.magic = GUINT32_SWAP_LE_BE(header.magic);
 872                 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
 873                 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
 874                 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
 875         }
 876         if (header.checksum)
 877                 fprintf(stderr, "[warning] checksum verification not supported yet.\n");
 878         if (header.compression_scheme) {
 879                 fprintf(stderr, "[error] compression (%u) not supported yet.\n",
 880                         header.compression_scheme);
 881                 return -EINVAL;
 882         }
 883         if (header.encryption_scheme) {
 884                 fprintf(stderr, "[error] encryption (%u) not supported yet.\n",
 885                         header.encryption_scheme);
 886                 return -EINVAL;
 887         }
 888         if (header.checksum_scheme) {
 889                 fprintf(stderr, "[error] checksum (%u) not supported yet.\n",
 890                         header.checksum_scheme);
 891                 return -EINVAL;
 892         }
 893         if (check_version(header.major, header.minor) < 0)
 894                 return -EINVAL;
 895         if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
 896                 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
 897                 CTF_TRACE_SET_FIELD(td, uuid);
 898         } else {
 899                 if (babeltrace_uuid_compare(header.uuid, td->uuid))
 900                         return -EINVAL;
 901         }
 902
 903         toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
 904
 905         for (;;) {
 906                 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
 907                 if (ferror(in)) {
 908                         ret = -EINVAL;
 909                         break;
 910                 }
 911                 if (babeltrace_debug) {
 912                         buf[readlen] = '\0';
 913                         fprintf(stderr, "[debug] metadata packet read: %s\n",
 914                                 buf);
 915                 }
 916
 917                 writelen = fwrite(buf, sizeof(char), readlen, out);
 918                 if (writelen < readlen) {
 919                         ret = -EIO;
 920                         break;
 921                 }
 922                 if (ferror(out)) {
 923                         ret = -EINVAL;
 924                         break;
 925                 }
 926                 toread -= readlen;
 927                 if (!toread) {
 928                         ret = 0;        /* continue reading next packet */
 929                         goto read_padding;
 930                 }
 931         }
 932         return ret;
 933
 934 read_padding:
 935         toread = (header.packet_size - header.content_size) / CHAR_BIT;
 936         ret = fseek(in, toread, SEEK_CUR);
 937         if (ret < 0) {
 938                 fprintf(stderr, "[warning] Missing padding at end of file\n");
 939                 ret = 0;
 940         }
 941         return ret;
 942 }
 943
 944 static
 945 int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
 946                                         char **buf)
 947 {
 948         FILE *in, *out;
 949         size_t size;
 950         int ret;
 951
 952         in = *fp;
 953         /*
 954          * Using strlen on *buf instead of size of open_memstream
 955          * because its size includes garbage at the end (after final
 956          * \0). This is the allocated size, not the actual string size.
 957          */
 958         out = babeltrace_open_memstream(buf, &size);
 959         if (out == NULL) {
 960                 perror("Metadata open_memstream");
 961                 return -errno;
 962         }
 963         for (;;) {
 964                 ret = ctf_open_trace_metadata_packet_read(td, in, out);
 965                 if (ret) {
 966                         break;
 967                 }
 968                 if (feof(in)) {
 969                         ret = 0;
 970                         break;
 971                 }
 972         }
 973         /* close to flush the buffer */
 974         ret = babeltrace_close_memstream(buf, &size, out);
 975         if (ret < 0) {
 976                 perror("babeltrace_flush_memstream");
 977                 fclose(in);
 978                 return -errno;
 979         }
 980         fclose(in);
 981         /* open for reading */
 982         *fp = babeltrace_fmemopen(*buf, strlen(*buf), "rb");
 983         if (!*fp) {
 984                 perror("Metadata fmemopen");
 985                 return -errno;
 986         }
 987         return 0;
 988 }
 989
 990 static
 991 int ctf_open_trace_metadata_read(struct ctf_trace *td,
 992                 void (*packet_seek)(struct stream_pos *pos, size_t index,
 993                         int whence), FILE *metadata_fp)
 994 {
 995         struct ctf_scanner *scanner;
 996         struct ctf_file_stream *metadata_stream;
 997         FILE *fp;
 998         char *buf = NULL;
 999         int ret = 0;
1000
1001         metadata_stream = g_new0(struct ctf_file_stream, 1);
1002         metadata_stream->pos.last_offset = LAST_OFFSET_POISON;
1003
1004         if (packet_seek) {
1005                 metadata_stream->pos.packet_seek = packet_seek;
1006         } else {
1007                 fprintf(stderr, "[error] packet_seek function undefined.\n");
1008                 ret = -1;
1009                 goto end_stream;
1010         }
1011
1012         if (metadata_fp) {
1013                 fp = metadata_fp;
1014                 metadata_stream->pos.fd = -1;
1015         } else {
1016                 td->metadata = &metadata_stream->parent;
1017                 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
1018                 if (metadata_stream->pos.fd < 0) {
1019                         fprintf(stderr, "Unable to open metadata.\n");
1020                         return metadata_stream->pos.fd;
1021                 }
1022
1023                 fp = fdopen(metadata_stream->pos.fd, "r");
1024                 if (!fp) {
1025                         fprintf(stderr, "[error] Unable to open metadata stream.\n");
1026                         perror("Metadata stream open");
1027                         ret = -errno;
1028                         goto end_stream;
1029                 }
1030         }
1031         if (babeltrace_debug)
1032                 yydebug = 1;
1033
1034         if (packet_metadata(td, fp)) {
1035                 ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf);
1036                 if (ret)
1037                         goto end_packet_read;
1038         } else {
1039                 unsigned int major, minor;
1040                 ssize_t nr_items;
1041
1042                 td->byte_order = BYTE_ORDER;
1043
1044                 /* Check text-only metadata header and version */
1045                 nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor);
1046                 if (nr_items < 2)
1047                         fprintf(stderr, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
1048                 if (check_version(major, minor) < 0) {
1049                         ret = -EINVAL;
1050                         goto end_packet_read;
1051                 }
1052                 rewind(fp);
1053         }
1054
1055         scanner = ctf_scanner_alloc(fp);
1056         if (!scanner) {
1057                 fprintf(stderr, "[error] Error allocating scanner\n");
1058                 ret = -ENOMEM;
1059                 goto end_scanner_alloc;
1060         }
1061         ret = ctf_scanner_append_ast(scanner);
1062         if (ret) {
1063                 fprintf(stderr, "[error] Error creating AST\n");
1064                 goto end;
1065         }
1066
1067         if (babeltrace_debug) {
1068                 ret = ctf_visitor_print_xml(stderr, 0, &scanner->ast->root);
1069                 if (ret) {
1070                         fprintf(stderr, "[error] Error visiting AST for XML output\n");
1071                         goto end;
1072                 }
1073         }
1074
1075         ret = ctf_visitor_semantic_check(stderr, 0, &scanner->ast->root);
1076         if (ret) {
1077                 fprintf(stderr, "[error] Error in CTF semantic validation %d\n", ret);
1078                 goto end;
1079         }
1080         ret = ctf_visitor_construct_metadata(stderr, 0, &scanner->ast->root,
1081                         td, td->byte_order);
1082         if (ret) {
1083                 fprintf(stderr, "[error] Error in CTF metadata constructor %d\n", ret);
1084                 goto end;
1085         }
1086 end:
1087         ctf_scanner_free(scanner);
1088 end_scanner_alloc:
1089 end_packet_read:
1090         if (fp)
1091                 fclose(fp);
1092         free(buf);
1093 end_stream:
1094         if (metadata_stream->pos.fd >= 0)
1095                 close(metadata_stream->pos.fd);
1096         if (ret)
1097                 g_free(metadata_stream);
1098         return ret;
1099 }
1100
1101 static
1102 struct ctf_event_definition *create_event_definitions(struct ctf_trace *td,
1103                                                   struct ctf_stream_definition *stream,
1104                                                   struct ctf_event_declaration *event)
1105 {
1106         struct ctf_event_definition *stream_event = g_new0(struct ctf_event_definition, 1);
1107
1108         if (event->context_decl) {
1109                 struct definition *definition =
1110                         event->context_decl->p.definition_new(&event->context_decl->p,
1111                                 stream->parent_def_scope, 0, 0, "event.context");
1112                 if (!definition) {
1113                         goto error;
1114                 }
1115                 stream_event->event_context = container_of(definition,
1116                                         struct definition_struct, p);
1117                 stream->parent_def_scope = stream_event->event_context->p.scope;
1118         }
1119         if (event->fields_decl) {
1120                 struct definition *definition =
1121                         event->fields_decl->p.definition_new(&event->fields_decl->p,
1122                                 stream->parent_def_scope, 0, 0, "event.fields");
1123                 if (!definition) {
1124                         goto error;
1125                 }
1126                 stream_event->event_fields = container_of(definition,
1127                                         struct definition_struct, p);
1128                 stream->parent_def_scope = stream_event->event_fields->p.scope;
1129         }
1130         stream_event->stream = stream;
1131         return stream_event;
1132
1133 error:
1134         if (stream_event->event_fields)
1135                 definition_unref(&stream_event->event_fields->p);
1136         if (stream_event->event_context)
1137                 definition_unref(&stream_event->event_context->p);
1138         return NULL;
1139 }
1140
1141 static
1142 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1143 {
1144         struct ctf_stream_declaration *stream_class;
1145         int ret;
1146         int i;
1147
1148         if (stream->stream_definitions_created)
1149                 return 0;
1150
1151         stream_class = stream->stream_class;
1152
1153         if (stream_class->packet_context_decl) {
1154                 struct definition *definition =
1155                         stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
1156                                 stream->parent_def_scope, 0, 0, "stream.packet.context");
1157                 if (!definition) {
1158                         ret = -EINVAL;
1159                         goto error;
1160                 }
1161                 stream->stream_packet_context = container_of(definition,
1162                                                 struct definition_struct, p);
1163                 stream->parent_def_scope = stream->stream_packet_context->p.scope;
1164         }
1165         if (stream_class->event_header_decl) {
1166                 struct definition *definition =
1167                         stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
1168                                 stream->parent_def_scope, 0, 0, "stream.event.header");
1169                 if (!definition) {
1170                         ret = -EINVAL;
1171                         goto error;
1172                 }
1173                 stream->stream_event_header =
1174                         container_of(definition, struct definition_struct, p);
1175                 stream->parent_def_scope = stream->stream_event_header->p.scope;
1176         }
1177         if (stream_class->event_context_decl) {
1178                 struct definition *definition =
1179                         stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
1180                                 stream->parent_def_scope, 0, 0, "stream.event.context");
1181                 if (!definition) {
1182                         ret = -EINVAL;
1183                         goto error;
1184                 }
1185                 stream->stream_event_context =
1186                         container_of(definition, struct definition_struct, p);
1187                 stream->parent_def_scope = stream->stream_event_context->p.scope;
1188         }
1189         stream->events_by_id = g_ptr_array_new();
1190         g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len);
1191         for (i = 0; i < stream->events_by_id->len; i++) {
1192                 struct ctf_event_declaration *event = g_ptr_array_index(stream_class->events_by_id, i);
1193                 struct ctf_event_definition *stream_event;
1194
1195                 if (!event)
1196                         continue;
1197                 stream_event = create_event_definitions(td, stream, event);
1198                 if (!stream_event)
1199                         goto error_event;
1200                 g_ptr_array_index(stream->events_by_id, i) = stream_event;
1201         }
1202         return 0;
1203
1204 error_event:
1205         for (i = 0; i < stream->events_by_id->len; i++) {
1206                 struct ctf_event_definition *stream_event = g_ptr_array_index(stream->events_by_id, i);
1207                 if (stream_event)
1208                         g_free(stream_event);
1209         }
1210         g_ptr_array_free(stream->events_by_id, TRUE);
1211 error:
1212         if (stream->stream_event_context)
1213                 definition_unref(&stream->stream_event_context->p);
1214         if (stream->stream_event_header)
1215                 definition_unref(&stream->stream_event_header->p);
1216         if (stream->stream_packet_context)
1217                 definition_unref(&stream->stream_packet_context->p);
1218         return ret;
1219 }
1220
1221
1222 static
1223 int create_stream_packet_index(struct ctf_trace *td,
1224                                struct ctf_file_stream *file_stream)
1225 {
1226         struct ctf_stream_declaration *stream;
1227         int len_index;
1228         struct ctf_stream_pos *pos;
1229         struct stat filestats;
1230         struct packet_index packet_index;
1231         int first_packet = 1;
1232         int ret;
1233
1234         pos = &file_stream->pos;
1235
1236         ret = fstat(pos->fd, &filestats);
1237         if (ret < 0)
1238                 return ret;
1239
1240         if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT)
1241                 return -EINVAL;
1242
1243         for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
1244                 uint64_t stream_id = 0;
1245
1246                 if (pos->base_mma) {
1247                         /* unmap old base */
1248                         ret = munmap_align(pos->base_mma);
1249                         if (ret) {
1250                                 fprintf(stderr, "[error] Unable to unmap old base: %s.\n",
1251                                         strerror(errno));
1252                                 return ret;
1253                         }
1254                         pos->base_mma = NULL;
1255                 }
1256                 /* map new base. Need mapping length from header. */
1257                 pos->base_mma = mmap_align(MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ,
1258                                  MAP_PRIVATE, pos->fd, pos->mmap_offset);
1259                 assert(pos->base_mma != MAP_FAILED);
1260                 pos->content_size = MAX_PACKET_HEADER_LEN;      /* Unknown at this point */
1261                 pos->packet_size = MAX_PACKET_HEADER_LEN;       /* Unknown at this point */
1262                 pos->offset = 0;        /* Position of the packet header */
1263
1264                 packet_index.offset = pos->mmap_offset;
1265                 packet_index.content_size = 0;
1266                 packet_index.packet_size = 0;
1267                 packet_index.timestamp_begin = 0;
1268                 packet_index.timestamp_end = 0;
1269                 packet_index.events_discarded = 0;
1270                 packet_index.events_discarded_len = 0;
1271
1272                 /* read and check header, set stream id (and check) */
1273                 if (file_stream->parent.trace_packet_header) {
1274                         /* Read packet header */
1275                         ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
1276                         if (ret)
1277                                 return ret;
1278                         len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
1279                         if (len_index >= 0) {
1280                                 struct definition *field;
1281                                 uint64_t magic;
1282
1283                                 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1284                                 magic = get_unsigned_int(field);
1285                                 if (magic != CTF_MAGIC) {
1286                                         fprintf(stderr, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
1287                                                         magic,
1288                                                         file_stream->pos.packet_cycles_index->len,
1289                                                         (ssize_t) pos->mmap_offset);
1290                                         return -EINVAL;
1291                                 }
1292                         }
1293
1294                         /* check uuid */
1295                         len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
1296                         if (len_index >= 0) {
1297                                 struct definition_array *defarray;
1298                                 struct definition *field;
1299                                 uint64_t i;
1300                                 uint8_t uuidval[BABELTRACE_UUID_LEN];
1301
1302                                 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1303                                 assert(field->declaration->id == CTF_TYPE_ARRAY);
1304                                 defarray = container_of(field, struct definition_array, p);
1305                                 assert(array_len(defarray) == BABELTRACE_UUID_LEN);
1306
1307                                 for (i = 0; i < BABELTRACE_UUID_LEN; i++) {
1308                                         struct definition *elem;
1309
1310                                         elem = array_index(defarray, i);
1311                                         uuidval[i] = get_unsigned_int(elem);
1312                                 }
1313                                 ret = babeltrace_uuid_compare(td->uuid, uuidval);
1314                                 if (ret) {
1315                                         fprintf(stderr, "[error] Unique Universal Identifiers do not match.\n");
1316                                         return -EINVAL;
1317                                 }
1318                         }
1319
1320
1321                         len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
1322                         if (len_index >= 0) {
1323                                 struct definition *field;
1324
1325                                 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
1326                                 stream_id = get_unsigned_int(field);
1327                         }
1328                 }
1329
1330                 if (!first_packet && file_stream->parent.stream_id != stream_id) {
1331                         fprintf(stderr, "[error] Stream ID is changing within a stream.\n");
1332                         return -EINVAL;
1333                 }
1334                 if (first_packet) {
1335                         file_stream->parent.stream_id = stream_id;
1336                         if (stream_id >= td->streams->len) {
1337                                 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1338                                 return -EINVAL;
1339                         }
1340                         stream = g_ptr_array_index(td->streams, stream_id);
1341                         if (!stream) {
1342                                 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
1343                                 return -EINVAL;
1344                         }
1345                         file_stream->parent.stream_class = stream;
1346                         ret = create_stream_definitions(td, &file_stream->parent);
1347                         if (ret)
1348                                 return ret;
1349                 }
1350                 first_packet = 0;
1351
1352                 if (file_stream->parent.stream_packet_context) {
1353                         /* Read packet context */
1354                         ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
1355                         if (ret)
1356                                 return ret;
1357                         /* read content size from header */
1358                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
1359                         if (len_index >= 0) {
1360                                 struct definition *field;
1361
1362                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1363                                 packet_index.content_size = get_unsigned_int(field);
1364                         } else {
1365                                 /* Use file size for packet size */
1366                                 packet_index.content_size = filestats.st_size * CHAR_BIT;
1367                         }
1368
1369                         /* read packet size from header */
1370                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1371                         if (len_index >= 0) {
1372                                 struct definition *field;
1373
1374                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1375                                 packet_index.packet_size = get_unsigned_int(field);
1376                         } else {
1377                                 /* Use content size if non-zero, else file size */
1378                                 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
1379                         }
1380
1381                         /* read timestamp begin from header */
1382                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1383                         if (len_index >= 0) {
1384                                 struct definition *field;
1385
1386                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1387                                 packet_index.timestamp_begin = get_unsigned_int(field);
1388                                 if (file_stream->parent.stream_class->trace->collection) {
1389                                         packet_index.timestamp_begin =
1390                                                 ctf_get_real_timestamp(
1391                                                         &file_stream->parent,
1392                                                         packet_index.timestamp_begin);
1393                                 }
1394                         }
1395
1396                         /* read timestamp end from header */
1397                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1398                         if (len_index >= 0) {
1399                                 struct definition *field;
1400
1401                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1402                                 packet_index.timestamp_end = get_unsigned_int(field);
1403                                 if (file_stream->parent.stream_class->trace->collection) {
1404                                         packet_index.timestamp_end =
1405                                                 ctf_get_real_timestamp(
1406                                                         &file_stream->parent,
1407                                                         packet_index.timestamp_end);
1408                                 }
1409                         }
1410
1411                         /* read events discarded from header */
1412                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("events_discarded"));
1413                         if (len_index >= 0) {
1414                                 struct definition *field;
1415
1416                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1417                                 packet_index.events_discarded = get_unsigned_int(field);
1418                                 packet_index.events_discarded_len = get_int_len(field);
1419                         }
1420                 } else {
1421                         /* Use file size for packet size */
1422                         packet_index.content_size = filestats.st_size * CHAR_BIT;
1423                         /* Use content size if non-zero, else file size */
1424                         packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
1425                 }
1426
1427                 /* Validate content size and packet size values */
1428                 if (packet_index.content_size > packet_index.packet_size) {
1429                         fprintf(stderr, "[error] Content size (%" PRIu64 " bits) is larger than packet size (%" PRIu64 " bits).\n",
1430                                 packet_index.content_size, packet_index.packet_size);
1431                         return -EINVAL;
1432                 }
1433
1434                 if (packet_index.packet_size > ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT) {
1435                         fprintf(stderr, "[error] Packet size (%" PRIu64 " bits) is larger than remaining file size (%" PRIu64 " bits).\n",
1436                                 packet_index.packet_size, ((uint64_t)filestats.st_size - packet_index.offset) * CHAR_BIT);
1437                         return -EINVAL;
1438                 }
1439
1440                 /* Save position after header and context */
1441                 packet_index.data_offset = pos->offset;
1442
1443                 /* add index to packet array */
1444                 g_array_append_val(file_stream->pos.packet_cycles_index, packet_index);
1445
1446                 pos->mmap_offset += packet_index.packet_size / CHAR_BIT;
1447         }
1448
1449         return 0;
1450 }
1451
1452 static
1453 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream_definition *stream)
1454 {
1455         int ret;
1456
1457         if (td->packet_header_decl) {
1458                 struct definition *definition =
1459                         td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1460                                 stream->parent_def_scope, 0, 0, "trace.packet.header");
1461                 if (!definition) {
1462                         ret = -EINVAL;
1463                         goto error;
1464                 }
1465                 stream->trace_packet_header =
1466                         container_of(definition, struct definition_struct, p);
1467                 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1468         }
1469
1470         return 0;
1471
1472 error:
1473         return ret;
1474 }
1475
1476 /*
1477  * Note: many file streams can inherit from the same stream class
1478  * description (metadata).
1479  */
1480 static
1481 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1482                 void (*packet_seek)(struct stream_pos *pos, size_t index,
1483                         int whence))
1484 {
1485         int ret, fd;
1486         struct ctf_file_stream *file_stream;
1487         struct stat statbuf;
1488
1489         fd = openat(td->dirfd, path, flags);
1490         if (fd < 0) {
1491                 perror("File stream openat()");
1492                 ret = fd;
1493                 goto error;
1494         }
1495
1496         /* Don't try to mmap subdirectories. Skip them, return success. */
1497         ret = fstat(fd, &statbuf);
1498         if (ret) {
1499                 perror("File stream fstat()");
1500                 goto fstat_error;
1501         }
1502         if (S_ISDIR(statbuf.st_mode)) {
1503                 fprintf(stderr, "[warning] Skipping directory '%s' found in trace\n", path);
1504                 ret = 0;
1505                 goto fd_is_dir_ok;
1506         }
1507
1508         file_stream = g_new0(struct ctf_file_stream, 1);
1509         file_stream->pos.last_offset = LAST_OFFSET_POISON;
1510
1511         if (packet_seek) {
1512                 file_stream->pos.packet_seek = packet_seek;
1513         } else {
1514                 fprintf(stderr, "[error] packet_seek function undefined.\n");
1515                 ret = -1;
1516                 goto error_def;
1517         }
1518
1519         ctf_init_pos(&file_stream->pos, fd, flags);
1520         ret = create_trace_definitions(td, &file_stream->parent);
1521         if (ret)
1522                 goto error_def;
1523         /*
1524          * For now, only a single clock per trace is supported.
1525          */
1526         file_stream->parent.current_clock = td->single_clock;
1527         ret = create_stream_packet_index(td, file_stream);
1528         if (ret)
1529                 goto error_index;
1530         /* Add stream file to stream class */
1531         g_ptr_array_add(file_stream->parent.stream_class->streams,
1532                         &file_stream->parent);
1533         return 0;
1534
1535 error_index:
1536         if (file_stream->parent.trace_packet_header)
1537                 definition_unref(&file_stream->parent.trace_packet_header->p);
1538 error_def:
1539         ctf_fini_pos(&file_stream->pos);
1540         g_free(file_stream);
1541 fd_is_dir_ok:
1542 fstat_error:
1543         close(fd);
1544 error:
1545         return ret;
1546 }
1547
1548 static
1549 int ctf_open_trace_read(struct ctf_trace *td,
1550                 const char *path, int flags,
1551                 void (*packet_seek)(struct stream_pos *pos, size_t index,
1552                         int whence), FILE *metadata_fp)
1553 {
1554         int ret;
1555         struct dirent *dirent;
1556         struct dirent *diriter;
1557         size_t dirent_len;
1558
1559         td->flags = flags;
1560
1561         /* Open trace directory */
1562         td->dir = opendir(path);
1563         if (!td->dir) {
1564                 fprintf(stderr, "[error] Unable to open trace directory \"%s\".\n", path);
1565                 ret = -ENOENT;
1566                 goto error;
1567         }
1568
1569         td->dirfd = open(path, 0);
1570         if (td->dirfd < 0) {
1571                 fprintf(stderr, "[error] Unable to open trace directory file descriptor for path \"%s\".\n", path);
1572                 perror("Trace directory open");
1573                 ret = -errno;
1574                 goto error_dirfd;
1575         }
1576         strncpy(td->path, path, sizeof(td->path));
1577         td->path[sizeof(td->path) - 1] = '\0';
1578
1579         /*
1580          * Keep the metadata file separate.
1581          */
1582
1583         ret = ctf_open_trace_metadata_read(td, packet_seek, metadata_fp);
1584         if (ret) {
1585                 fprintf(stderr, "[warning] Unable to open trace metadata for path \"%s\".\n", path);
1586                 goto error_metadata;
1587         }
1588
1589         /*
1590          * Open each stream: for each file, try to open, check magic
1591          * number, and get the stream ID to add to the right location in
1592          * the stream array.
1593          */
1594
1595         dirent_len = offsetof(struct dirent, d_name) +
1596                         fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
1597
1598         dirent = malloc(dirent_len);
1599
1600         for (;;) {
1601                 ret = readdir_r(td->dir, dirent, &diriter);
1602                 if (ret) {
1603                         fprintf(stderr, "[error] Readdir error.\n");
1604                         goto readdir_error;
1605                 }
1606                 if (!diriter)
1607                         break;
1608                 /* Ignore hidden files, ., .. and metadata. */
1609                 if (!strncmp(diriter->d_name, ".", 1)
1610                                 || !strcmp(diriter->d_name, "..")
1611                                 || !strcmp(diriter->d_name, "metadata"))
1612                         continue;
1613                 ret = ctf_open_file_stream_read(td, diriter->d_name,
1614                                         flags, packet_seek);
1615                 if (ret) {
1616                         fprintf(stderr, "[error] Open file stream error.\n");
1617                         goto readdir_error;
1618                 }
1619         }
1620
1621         free(dirent);
1622         return 0;
1623
1624 readdir_error:
1625         free(dirent);
1626 error_metadata:
1627         close(td->dirfd);
1628 error_dirfd:
1629         closedir(td->dir);
1630 error:
1631         return ret;
1632 }
1633
1634 /*
1635  * ctf_open_trace: Open a CTF trace and index it.
1636  * Note that the user must seek the trace after the open (using the iterator)
1637  * since the index creation read it entirely.
1638  */
1639 static
1640 struct trace_descriptor *ctf_open_trace(const char *path, int flags,
1641                 void (*packet_seek)(struct stream_pos *pos, size_t index,
1642                         int whence), FILE *metadata_fp)
1643 {
1644         struct ctf_trace *td;
1645         int ret;
1646
1647         /*
1648          * If packet_seek is NULL, we provide our default version.
1649          */
1650         if (!packet_seek)
1651                 packet_seek = ctf_packet_seek;
1652
1653         td = g_new0(struct ctf_trace, 1);
1654
1655         switch (flags & O_ACCMODE) {
1656         case O_RDONLY:
1657                 if (!path) {
1658                         fprintf(stderr, "[error] Path missing for input CTF trace.\n");
1659                         goto error;
1660                 }
1661                 ret = ctf_open_trace_read(td, path, flags, packet_seek, metadata_fp);
1662                 if (ret)
1663                         goto error;
1664                 break;
1665         case O_RDWR:
1666                 fprintf(stderr, "[error] Opening CTF traces for output is not supported yet.\n");
1667                 goto error;
1668         default:
1669                 fprintf(stderr, "[error] Incorrect open flags.\n");
1670                 goto error;
1671         }
1672
1673         return &td->parent;
1674 error:
1675         g_free(td);
1676         return NULL;
1677 }
1678
1679
1680 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
1681                 struct mmap_stream *mmap_info)
1682 {
1683         pos->mmap_offset = 0;
1684         pos->packet_size = 0;
1685         pos->content_size = 0;
1686         pos->content_size_loc = NULL;
1687         pos->fd = mmap_info->fd;
1688         pos->base_mma = NULL;
1689         pos->offset = 0;
1690         pos->dummy = false;
1691         pos->cur_index = 0;
1692         pos->packet_cycles_index = NULL;
1693         pos->packet_real_index = NULL;
1694         pos->prot = PROT_READ;
1695         pos->flags = MAP_PRIVATE;
1696         pos->parent.rw_table = read_dispatch_table;
1697         pos->parent.event_cb = ctf_read_event;
1698 }
1699
1700 static
1701 int prepare_mmap_stream_definition(struct ctf_trace *td,
1702                 struct ctf_file_stream *file_stream)
1703 {
1704         struct ctf_stream_declaration *stream;
1705         uint64_t stream_id = 0;
1706         int ret;
1707
1708         file_stream->parent.stream_id = stream_id;
1709         if (stream_id >= td->streams->len) {
1710                 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
1711                                 "in metadata.\n", stream_id);
1712                 ret = -EINVAL;
1713                 goto end;
1714         }
1715         stream = g_ptr_array_index(td->streams, stream_id);
1716         if (!stream) {
1717                 fprintf(stderr, "[error] Stream %" PRIu64 " is not declared "
1718                                 "in metadata.\n", stream_id);
1719                 ret = -EINVAL;
1720                 goto end;
1721         }
1722         file_stream->parent.stream_class = stream;
1723         ret = create_stream_definitions(td, &file_stream->parent);
1724 end:
1725         return ret;
1726 }
1727
1728 static
1729 int ctf_open_mmap_stream_read(struct ctf_trace *td,
1730                 struct mmap_stream *mmap_info,
1731                 void (*packet_seek)(struct stream_pos *pos, size_t index,
1732                         int whence))
1733 {
1734         int ret;
1735         struct ctf_file_stream *file_stream;
1736
1737         file_stream = g_new0(struct ctf_file_stream, 1);
1738         file_stream->pos.last_offset = LAST_OFFSET_POISON;
1739         ctf_init_mmap_pos(&file_stream->pos, mmap_info);
1740
1741         file_stream->pos.packet_seek = packet_seek;
1742
1743         ret = create_trace_definitions(td, &file_stream->parent);
1744         if (ret) {
1745                 goto error_def;
1746         }
1747
1748         ret = prepare_mmap_stream_definition(td, file_stream);
1749         if (ret)
1750                 goto error_index;
1751
1752         /*
1753          * For now, only a single clock per trace is supported.
1754          */
1755         file_stream->parent.current_clock = td->single_clock;
1756
1757         /* Add stream file to stream class */
1758         g_ptr_array_add(file_stream->parent.stream_class->streams,
1759                         &file_stream->parent);
1760         return 0;
1761
1762 error_index:
1763         if (file_stream->parent.trace_packet_header)
1764                 definition_unref(&file_stream->parent.trace_packet_header->p);
1765 error_def:
1766         g_free(file_stream);
1767         return ret;
1768 }
1769
1770 int ctf_open_mmap_trace_read(struct ctf_trace *td,
1771                 struct mmap_stream_list *mmap_list,
1772                 void (*packet_seek)(struct stream_pos *pos, size_t index,
1773                         int whence),
1774                 FILE *metadata_fp)
1775 {
1776         int ret;
1777         struct mmap_stream *mmap_info;
1778
1779         ret = ctf_open_trace_metadata_read(td, ctf_packet_seek, metadata_fp);
1780         if (ret) {
1781                 goto error;
1782         }
1783
1784         /*
1785          * for each stream, try to open, check magic number, and get the
1786          * stream ID to add to the right location in the stream array.
1787          */
1788         bt_list_for_each_entry(mmap_info, &mmap_list->head, list) {
1789                 ret = ctf_open_mmap_stream_read(td, mmap_info, packet_seek);
1790                 if (ret) {
1791                         fprintf(stderr, "[error] Open file mmap stream error.\n");
1792                         goto error;
1793                 }
1794         }
1795
1796         return 0;
1797
1798 error:
1799         return ret;
1800 }
1801
1802 static
1803 struct trace_descriptor *ctf_open_mmap_trace(
1804                 struct mmap_stream_list *mmap_list,
1805                 void (*packet_seek)(struct stream_pos *pos, size_t index,
1806                         int whence),
1807                 FILE *metadata_fp)
1808 {
1809         struct ctf_trace *td;
1810         int ret;
1811
1812         if (!metadata_fp) {
1813                 fprintf(stderr, "[error] No metadata file pointer associated, "
1814                                 "required for mmap parsing\n");
1815                 goto error;
1816         }
1817         if (!packet_seek) {
1818                 fprintf(stderr, "[error] packet_seek function undefined.\n");
1819                 goto error;
1820         }
1821         td = g_new0(struct ctf_trace, 1);
1822         ret = ctf_open_mmap_trace_read(td, mmap_list, packet_seek, metadata_fp);
1823         if (ret)
1824                 goto error_free;
1825
1826         return &td->parent;
1827
1828 error_free:
1829         g_free(td);
1830 error:
1831         return NULL;
1832 }
1833
1834 static
1835 int ctf_convert_index_timestamp(struct trace_descriptor *tdp)
1836 {
1837         int i, j, k;
1838         struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
1839
1840         /* for each stream_class */
1841         for (i = 0; i < td->streams->len; i++) {
1842                 struct ctf_stream_declaration *stream_class;
1843
1844                 stream_class = g_ptr_array_index(td->streams, i);
1845                 if (!stream_class)
1846                         continue;
1847                 /* for each file_stream */
1848                 for (j = 0; j < stream_class->streams->len; j++) {
1849                         struct ctf_stream_definition *stream;
1850                         struct ctf_stream_pos *stream_pos;
1851                         struct ctf_file_stream *cfs;
1852
1853                         stream = g_ptr_array_index(stream_class->streams, j);
1854                         if (!stream)
1855                                 continue;
1856                         cfs = container_of(stream, struct ctf_file_stream,
1857                                         parent);
1858                         stream_pos = &cfs->pos;
1859                         if (!stream_pos->packet_cycles_index)
1860                                 continue;
1861
1862                         for (k = 0; k < stream_pos->packet_cycles_index->len; k++) {
1863                                 struct packet_index *index;
1864                                 struct packet_index new_index;
1865
1866                                 index = &g_array_index(stream_pos->packet_cycles_index,
1867                                                 struct packet_index, k);
1868                                 memcpy(&new_index, index,
1869                                                 sizeof(struct packet_index));
1870                                 new_index.timestamp_begin =
1871                                         ctf_get_real_timestamp(stream,
1872                                                         index->timestamp_begin);
1873                                 new_index.timestamp_end =
1874                                         ctf_get_real_timestamp(stream,
1875                                                         index->timestamp_end);
1876                                 g_array_append_val(stream_pos->packet_real_index,
1877                                                 new_index);
1878                         }
1879                 }
1880         }
1881         return 0;
1882 }
1883
1884 static
1885 void ctf_close_file_stream(struct ctf_file_stream *file_stream)
1886 {
1887         ctf_fini_pos(&file_stream->pos);
1888         close(file_stream->pos.fd);
1889 }
1890
1891 static
1892 void ctf_close_trace(struct trace_descriptor *tdp)
1893 {
1894         struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
1895         int i;
1896
1897         if (td->streams) {
1898                 for (i = 0; i < td->streams->len; i++) {
1899                         struct ctf_stream_declaration *stream;
1900                         int j;
1901
1902                         stream = g_ptr_array_index(td->streams, i);
1903                         if (!stream)
1904                                 continue;
1905                         for (j = 0; j < stream->streams->len; j++) {
1906                                 struct ctf_file_stream *file_stream;
1907                                 file_stream = container_of(g_ptr_array_index(stream->streams, j),
1908                                                 struct ctf_file_stream, parent);
1909                                 ctf_close_file_stream(file_stream);
1910                         }
1911                 }
1912         }
1913         ctf_destroy_metadata(td);
1914         close(td->dirfd);
1915         closedir(td->dir);
1916         g_free(td);
1917 }
1918
1919 static
1920 void ctf_set_context(struct trace_descriptor *descriptor,
1921                 struct bt_context *ctx)
1922 {
1923         struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
1924                         parent);
1925
1926         td->ctx = ctx;
1927 }
1928
1929 static
1930 void ctf_set_handle(struct trace_descriptor *descriptor,
1931                 struct bt_trace_handle *handle)
1932 {
1933         struct ctf_trace *td = container_of(descriptor, struct ctf_trace,
1934                         parent);
1935
1936         td->handle = handle;
1937 }
1938
1939 static
1940 void __attribute__((constructor)) ctf_init(void)
1941 {
1942         int ret;
1943
1944         ctf_format.name = g_quark_from_static_string("ctf");
1945         ret = bt_register_format(&ctf_format);
1946         assert(!ret);
1947 }
1948
1949 static
1950 void __attribute__((destructor)) ctf_exit(void)
1951 {
1952         bt_unregister_format(&ctf_format);
1953 }