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 <inttypes.h>
  26 #include <stdio.h>
  27 #include <uuid/uuid.h>
  28 #include <sys/mman.h>
  29 #include <errno.h>
  30 #include <endian.h>
  31 #include <sys/types.h>
  32 #include <sys/stat.h>
  33 #include <fcntl.h>
  34 #include <dirent.h>
  35 #include <glib.h>
  36 #include <unistd.h>
  37 #include <stdlib.h>
  38
  39 #include "metadata/ctf-scanner.h"
  40 #include "metadata/ctf-parser.h"
  41 #include "metadata/ctf-ast.h"
  42
  43 /*
  44  * We currently simply map a page to read the packet header and packet
  45  * context to get the packet length and content length. (in bits)
  46  */
  47 #define MAX_PACKET_HEADER_LEN   (getpagesize() * CHAR_BIT)
  48 #define WRITE_PACKET_LEN        (getpagesize() * 8 * CHAR_BIT)
  49 #define UUID_LEN 16     /* uuid by value len */
  50
  51 #ifndef min
  52 #define min(a, b)       (((a) < (b)) ? (a) : (b))
  53 #endif
  54
  55 extern int yydebug;
  56
  57 static
  58 struct trace_descriptor *ctf_open_trace(const char *path, int flags,
  59                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
  60                         int whence), FILE *metadata_fp);
  61 static
  62 struct trace_descriptor *ctf_open_mmap_trace(
  63                 struct mmap_stream_list *mmap_list,
  64                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, int whence),
  65                 FILE *metadata_fp);
  66
  67 static
  68 void ctf_close_trace(struct trace_descriptor *descriptor);
  69
  70 static
  71 rw_dispatch read_dispatch_table[] = {
  72         [ CTF_TYPE_INTEGER ] = ctf_integer_read,
  73         [ CTF_TYPE_FLOAT ] = ctf_float_read,
  74         [ CTF_TYPE_ENUM ] = ctf_enum_read,
  75         [ CTF_TYPE_STRING ] = ctf_string_read,
  76         [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
  77         [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
  78         [ CTF_TYPE_ARRAY ] = ctf_array_read,
  79         [ CTF_TYPE_SEQUENCE ] = ctf_sequence_read,
  80 };
  81
  82 static
  83 rw_dispatch write_dispatch_table[] = {
  84         [ CTF_TYPE_INTEGER ] = ctf_integer_write,
  85         [ CTF_TYPE_FLOAT ] = ctf_float_write,
  86         [ CTF_TYPE_ENUM ] = ctf_enum_write,
  87         [ CTF_TYPE_STRING ] = ctf_string_write,
  88         [ CTF_TYPE_STRUCT ] = ctf_struct_rw,
  89         [ CTF_TYPE_VARIANT ] = ctf_variant_rw,
  90         [ CTF_TYPE_ARRAY ] = ctf_array_write,
  91         [ CTF_TYPE_SEQUENCE ] = ctf_sequence_write,
  92 };
  93
  94 static
  95 struct format ctf_format = {
  96         .open_trace = ctf_open_trace,
  97         .open_mmap_trace = ctf_open_mmap_trace,
  98         .close_trace = ctf_close_trace,
  99 };
 100
 101 static
 102 void ctf_update_timestamp(struct ctf_stream *stream,
 103                           struct definition_integer *integer_definition)
 104 {
 105         struct declaration_integer *integer_declaration =
 106                 integer_definition->declaration;
 107         uint64_t oldval, newval, updateval;
 108
 109         if (unlikely(integer_declaration->len == 64)) {
 110                 stream->timestamp = integer_definition->value._unsigned;
 111                 return;
 112         }
 113         /* keep low bits */
 114         oldval = stream->timestamp;
 115         oldval &= (1ULL << integer_declaration->len) - 1;
 116         newval = integer_definition->value._unsigned;
 117         /* Test for overflow by comparing low bits */
 118         if (newval < oldval)
 119                 newval += 1ULL << integer_declaration->len;
 120         /* updateval contains old high bits, and new low bits (sum) */
 121         updateval = stream->timestamp;
 122         updateval &= ~((1ULL << integer_declaration->len) - 1);
 123         updateval += newval;
 124         stream->timestamp = updateval;
 125 }
 126
 127 static
 128 int ctf_read_event(struct stream_pos *ppos, struct ctf_stream *stream)
 129 {
 130         struct ctf_stream_pos *pos =
 131                 container_of(ppos, struct ctf_stream_pos, parent);
 132         struct ctf_stream_class *stream_class = stream->stream_class;
 133         struct ctf_stream_event *event;
 134         uint64_t id = 0;
 135         int ret;
 136
 137         /* We need to check for EOF here for empty files. */
 138         if (unlikely(pos->offset == EOF))
 139                 return EOF;
 140
 141         ctf_pos_get_event(pos);
 142
 143         /*
 144          * This is the EOF check after we've advanced the position in
 145          * ctf_pos_get_event.
 146          */
 147         if (unlikely(pos->offset == EOF))
 148                 return EOF;
 149         assert(pos->offset < pos->content_size);
 150
 151         /* Read event header */
 152         if (likely(stream->stream_event_header)) {
 153                 struct definition_integer *integer_definition;
 154                 struct definition *variant;
 155
 156                 ret = generic_rw(ppos, &stream->stream_event_header->p);
 157                 if (unlikely(ret))
 158                         goto error;
 159                 /* lookup event id */
 160                 integer_definition = lookup_integer(&stream->stream_event_header->p, "id", FALSE);
 161                 if (integer_definition) {
 162                         id = integer_definition->value._unsigned;
 163                 } else {
 164                         struct definition_enum *enum_definition;
 165
 166                         enum_definition = lookup_enum(&stream->stream_event_header->p, "id", FALSE);
 167                         if (enum_definition) {
 168                                 id = enum_definition->integer->value._unsigned;
 169                         }
 170                 }
 171
 172                 variant = lookup_variant(&stream->stream_event_header->p, "v");
 173                 if (variant) {
 174                         integer_definition = lookup_integer(variant, "id", FALSE);
 175                         if (integer_definition) {
 176                                 id = integer_definition->value._unsigned;
 177                         }
 178                 }
 179                 stream->event_id = id;
 180
 181                 /* lookup timestamp */
 182                 stream->has_timestamp = 0;
 183                 integer_definition = lookup_integer(&stream->stream_event_header->p, "timestamp", FALSE);
 184                 if (integer_definition) {
 185                         ctf_update_timestamp(stream, integer_definition);
 186                         stream->has_timestamp = 1;
 187                 } else {
 188                         if (variant) {
 189                                 integer_definition = lookup_integer(variant, "timestamp", FALSE);
 190                                 if (integer_definition) {
 191                                         ctf_update_timestamp(stream, integer_definition);
 192                                         stream->has_timestamp = 1;
 193                                 }
 194                         }
 195                 }
 196         }
 197
 198         /* Read stream-declared event context */
 199         if (stream->stream_event_context) {
 200                 ret = generic_rw(ppos, &stream->stream_event_context->p);
 201                 if (ret)
 202                         goto error;
 203         }
 204
 205         if (unlikely(id >= stream_class->events_by_id->len)) {
 206                 fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
 207                 return -EINVAL;
 208         }
 209         event = g_ptr_array_index(stream->events_by_id, id);
 210         if (unlikely(!event)) {
 211                 fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
 212                 return -EINVAL;
 213         }
 214
 215         /* Read event-declared event context */
 216         if (event->event_context) {
 217                 ret = generic_rw(ppos, &event->event_context->p);
 218                 if (ret)
 219                         goto error;
 220         }
 221
 222         /* Read event payload */
 223         if (likely(event->event_fields)) {
 224                 ret = generic_rw(ppos, &event->event_fields->p);
 225                 if (ret)
 226                         goto error;
 227         }
 228
 229         return 0;
 230
 231 error:
 232         fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
 233         return ret;
 234 }
 235
 236 static
 237 int ctf_write_event(struct stream_pos *pos, struct ctf_stream *stream)
 238 {
 239         struct ctf_stream_class *stream_class = stream->stream_class;
 240         struct ctf_stream_event *event;
 241         uint64_t id;
 242         int ret;
 243
 244         id = stream->event_id;
 245
 246         /* print event header */
 247         if (likely(stream->stream_event_header)) {
 248                 ret = generic_rw(pos, &stream->stream_event_header->p);
 249                 if (ret)
 250                         goto error;
 251         }
 252
 253         /* print stream-declared event context */
 254         if (stream->stream_event_context) {
 255                 ret = generic_rw(pos, &stream->stream_event_context->p);
 256                 if (ret)
 257                         goto error;
 258         }
 259
 260         if (unlikely(id >= stream_class->events_by_id->len)) {
 261                 fprintf(stdout, "[error] Event id %" PRIu64 " is outside range.\n", id);
 262                 return -EINVAL;
 263         }
 264         event = g_ptr_array_index(stream->events_by_id, id);
 265         if (unlikely(!event)) {
 266                 fprintf(stdout, "[error] Event id %" PRIu64 " is unknown.\n", id);
 267                 return -EINVAL;
 268         }
 269
 270         /* print event-declared event context */
 271         if (event->event_context) {
 272                 ret = generic_rw(pos, &event->event_context->p);
 273                 if (ret)
 274                         goto error;
 275         }
 276
 277         /* Read and print event payload */
 278         if (likely(event->event_fields)) {
 279                 ret = generic_rw(pos, &event->event_fields->p);
 280                 if (ret)
 281                         goto error;
 282         }
 283
 284         return 0;
 285
 286 error:
 287         fprintf(stdout, "[error] Unexpected end of stream. Either the trace data stream is corrupted or metadata description does not match data layout.\n");
 288         return ret;
 289 }
 290
 291 void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags)
 292 {
 293         pos->fd = fd;
 294         pos->mmap_offset = 0;
 295         pos->packet_size = 0;
 296         pos->content_size = 0;
 297         pos->content_size_loc = NULL;
 298         pos->base = NULL;
 299         pos->offset = 0;
 300         pos->dummy = false;
 301         pos->cur_index = 0;
 302         if (fd >= 0)
 303                 pos->packet_index = g_array_new(FALSE, TRUE,
 304                                                 sizeof(struct packet_index));
 305         else
 306                 pos->packet_index = NULL;
 307         switch (open_flags & O_ACCMODE) {
 308         case O_RDONLY:
 309                 pos->prot = PROT_READ;
 310                 pos->flags = MAP_PRIVATE;
 311                 pos->parent.rw_table = read_dispatch_table;
 312                 pos->parent.event_cb = ctf_read_event;
 313                 break;
 314         case O_RDWR:
 315                 pos->prot = PROT_WRITE; /* Write has priority */
 316                 pos->flags = MAP_SHARED;
 317                 pos->parent.rw_table = write_dispatch_table;
 318                 pos->parent.event_cb = ctf_write_event;
 319                 if (fd >= 0)
 320                         ctf_move_pos_slow(pos, 0, SEEK_SET);    /* position for write */
 321                 break;
 322         default:
 323                 assert(0);
 324         }
 325 }
 326
 327 void ctf_fini_pos(struct ctf_stream_pos *pos)
 328 {
 329         int ret;
 330
 331         if (pos->prot == PROT_WRITE && pos->content_size_loc)
 332                 *pos->content_size_loc = pos->offset;
 333         if (pos->base) {
 334                 /* unmap old base */
 335                 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
 336                 if (ret) {
 337                         fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
 338                                 strerror(errno));
 339                         assert(0);
 340                 }
 341         }
 342         (void) g_array_free(pos->packet_index, TRUE);
 343 }
 344
 345 void ctf_move_pos_slow(struct ctf_stream_pos *pos, size_t offset, int whence)
 346 {
 347         struct ctf_file_stream *file_stream =
 348                 container_of(pos, struct ctf_file_stream, pos);
 349         int ret;
 350         off_t off;
 351         struct packet_index *index;
 352
 353         if (pos->prot == PROT_WRITE && pos->content_size_loc)
 354                 *pos->content_size_loc = pos->offset;
 355
 356         if (pos->base) {
 357                 /* unmap old base */
 358                 ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
 359                 if (ret) {
 360                         fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
 361                                 strerror(errno));
 362                         assert(0);
 363                 }
 364                 pos->base = NULL;
 365         }
 366
 367         /*
 368          * The caller should never ask for ctf_move_pos across packets,
 369          * except to get exactly at the beginning of the next packet.
 370          */
 371         if (pos->prot == PROT_WRITE) {
 372                 switch (whence) {
 373                 case SEEK_CUR:
 374                         /* The writer will add padding */
 375                         assert(pos->offset + offset == pos->packet_size);
 376                         pos->mmap_offset += WRITE_PACKET_LEN / CHAR_BIT;
 377                         break;
 378                 case SEEK_SET:
 379                         assert(offset == 0);    /* only seek supported for now */
 380                         pos->cur_index = 0;
 381                         break;
 382                 default:
 383                         assert(0);
 384                 }
 385                 pos->content_size = -1U;        /* Unknown at this point */
 386                 pos->packet_size = WRITE_PACKET_LEN;
 387                 off = posix_fallocate(pos->fd, pos->mmap_offset,
 388                                       pos->packet_size / CHAR_BIT);
 389                 assert(off >= 0);
 390                 pos->offset = 0;
 391         } else {
 392         read_next_packet:
 393                 switch (whence) {
 394                 case SEEK_CUR:
 395                         if (pos->offset == EOF)
 396                                 return;
 397                         /* The reader will expect us to skip padding */
 398                         assert(pos->offset + offset == pos->content_size);
 399                         ++pos->cur_index;
 400                         break;
 401                 case SEEK_SET:
 402                         assert(offset == 0);    /* only seek supported for now */
 403                         pos->cur_index = 0;
 404                         break;
 405                 default:
 406                         assert(0);
 407                 }
 408                 if (pos->cur_index >= pos->packet_index->len) {
 409                         pos->offset = EOF;
 410                         return;
 411                 }
 412                 index = &g_array_index(pos->packet_index, struct packet_index,
 413                                        pos->cur_index);
 414                 pos->mmap_offset = index->offset;
 415
 416                 /* Lookup context/packet size in index */
 417                 file_stream->parent.timestamp = index->timestamp_begin;
 418                 pos->content_size = index->content_size;
 419                 pos->packet_size = index->packet_size;
 420                 if (index->data_offset < index->content_size) {
 421                         pos->offset = 0;        /* will read headers */
 422                 } else if (index->data_offset == index->content_size) {
 423                         /* empty packet */
 424                         pos->offset = index->data_offset;
 425                         offset = 0;
 426                         whence = SEEK_CUR;
 427                         goto read_next_packet;
 428                 } else {
 429                         pos->offset = EOF;
 430                         return;
 431                 }
 432         }
 433         /* map new base. Need mapping length from header. */
 434         pos->base = mmap(NULL, pos->packet_size / CHAR_BIT, pos->prot,
 435                          pos->flags, pos->fd, pos->mmap_offset);
 436         if (pos->base == MAP_FAILED) {
 437                 fprintf(stdout, "[error] mmap error %s.\n",
 438                         strerror(errno));
 439                 assert(0);
 440         }
 441
 442         /* update trace_packet_header and stream_packet_context */
 443         if (pos->prot != PROT_WRITE && file_stream->parent.trace_packet_header) {
 444                 /* Read packet header */
 445                 ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
 446                 assert(!ret);
 447         }
 448         if (pos->prot != PROT_WRITE && file_stream->parent.stream_packet_context) {
 449                 /* Read packet context */
 450                 ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
 451                 assert(!ret);
 452         }
 453 }
 454
 455 static
 456 int packet_metadata(struct ctf_trace *td, FILE *fp)
 457 {
 458         uint32_t magic;
 459         size_t len;
 460         int ret = 0;
 461
 462         len = fread(&magic, sizeof(magic), 1, fp);
 463         if (len != 1) {
 464                 goto end;
 465         }
 466         if (magic == TSDL_MAGIC) {
 467                 ret = 1;
 468                 td->byte_order = BYTE_ORDER;
 469                 CTF_TRACE_SET_FIELD(td, byte_order);
 470         } else if (magic == GUINT32_SWAP_LE_BE(TSDL_MAGIC)) {
 471                 ret = 1;
 472                 td->byte_order = (BYTE_ORDER == BIG_ENDIAN) ?
 473                                         LITTLE_ENDIAN : BIG_ENDIAN;
 474                 CTF_TRACE_SET_FIELD(td, byte_order);
 475         }
 476 end:
 477         rewind(fp);
 478         return ret;
 479 }
 480
 481 /*
 482  * Returns 0 on success, -1 on error.
 483  */
 484 static
 485 int check_version(unsigned int major, unsigned int minor)
 486 {
 487         switch (major) {
 488         case 1:
 489                 switch (minor) {
 490                 case 8:
 491                         return 0;
 492                 default:
 493                         goto warning;
 494                 }
 495         default:
 496                 goto warning;
 497
 498         }
 499
 500         /* eventually return an error instead of warning */
 501 warning:
 502         fprintf(stdout, "[warning] Unsupported CTF specification version %u.%u. Trying anyway.\n",
 503                 major, minor);
 504         return 0;
 505 }
 506
 507 static
 508 int ctf_open_trace_metadata_packet_read(struct ctf_trace *td, FILE *in,
 509                                         FILE *out)
 510 {
 511         struct metadata_packet_header header;
 512         size_t readlen, writelen, toread;
 513         char buf[4096 + 1];     /* + 1 for debug-mode \0 */
 514         int ret = 0;
 515
 516         readlen = fread(&header, header_sizeof(header), 1, in);
 517         if (readlen < 1)
 518                 return -EINVAL;
 519
 520         if (td->byte_order != BYTE_ORDER) {
 521                 header.magic = GUINT32_SWAP_LE_BE(header.magic);
 522                 header.checksum = GUINT32_SWAP_LE_BE(header.checksum);
 523                 header.content_size = GUINT32_SWAP_LE_BE(header.content_size);
 524                 header.packet_size = GUINT32_SWAP_LE_BE(header.packet_size);
 525         }
 526         if (header.checksum)
 527                 fprintf(stdout, "[warning] checksum verification not supported yet.\n");
 528         if (header.compression_scheme) {
 529                 fprintf(stdout, "[error] compression (%u) not supported yet.\n",
 530                         header.compression_scheme);
 531                 return -EINVAL;
 532         }
 533         if (header.encryption_scheme) {
 534                 fprintf(stdout, "[error] encryption (%u) not supported yet.\n",
 535                         header.encryption_scheme);
 536                 return -EINVAL;
 537         }
 538         if (header.checksum_scheme) {
 539                 fprintf(stdout, "[error] checksum (%u) not supported yet.\n",
 540                         header.checksum_scheme);
 541                 return -EINVAL;
 542         }
 543         if (check_version(header.major, header.minor) < 0)
 544                 return -EINVAL;
 545         if (!CTF_TRACE_FIELD_IS_SET(td, uuid)) {
 546                 memcpy(td->uuid, header.uuid, sizeof(header.uuid));
 547                 CTF_TRACE_SET_FIELD(td, uuid);
 548         } else {
 549                 if (uuid_compare(header.uuid, td->uuid))
 550                         return -EINVAL;
 551         }
 552
 553         toread = (header.content_size / CHAR_BIT) - header_sizeof(header);
 554
 555         for (;;) {
 556                 readlen = fread(buf, sizeof(char), min(sizeof(buf) - 1, toread), in);
 557                 if (ferror(in)) {
 558                         ret = -EINVAL;
 559                         break;
 560                 }
 561                 if (babeltrace_debug) {
 562                         buf[readlen] = '\0';
 563                         fprintf(stdout, "[debug] metadata packet read: %s\n",
 564                                 buf);
 565                 }
 566
 567                 writelen = fwrite(buf, sizeof(char), readlen, out);
 568                 if (writelen < readlen) {
 569                         ret = -EIO;
 570                         break;
 571                 }
 572                 if (ferror(out)) {
 573                         ret = -EINVAL;
 574                         break;
 575                 }
 576                 toread -= readlen;
 577                 if (!toread) {
 578                         ret = 0;        /* continue reading next packet */
 579                         goto read_padding;
 580                 }
 581         }
 582         return ret;
 583
 584 read_padding:
 585         toread = (header.packet_size - header.content_size) / CHAR_BIT;
 586         ret = fseek(in, toread, SEEK_CUR);
 587         if (ret < 0) {
 588                 fprintf(stdout, "[warning] Missing padding at end of file\n");
 589                 ret = 0;
 590         }
 591         return ret;
 592 }
 593
 594 static
 595 int ctf_open_trace_metadata_stream_read(struct ctf_trace *td, FILE **fp,
 596                                         char **buf)
 597 {
 598         FILE *in, *out;
 599         size_t size;
 600         int ret;
 601
 602         in = *fp;
 603         /*
 604          * Using strlen on *buf instead of size of open_memstream
 605          * because its size includes garbage at the end (after final
 606          * \0). This is the allocated size, not the actual string size.
 607          */
 608         out = open_memstream(buf, &size);
 609         if (out == NULL)
 610                 return -errno;
 611
 612         for (;;) {
 613                 ret = ctf_open_trace_metadata_packet_read(td, in, out);
 614                 if (ret) {
 615                         break;
 616                 }
 617                 if (feof(in)) {
 618                         ret = 0;
 619                         break;
 620                 }
 621         }
 622         fclose(out);    /* flush the buffer */
 623         fclose(in);
 624         /* open for reading */
 625         *fp = fmemopen(*buf, strlen(*buf), "rb");
 626         return 0;
 627 }
 628
 629 static
 630 int ctf_open_trace_metadata_read(struct ctf_trace *td,
 631                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
 632                         int whence), FILE *metadata_fp)
 633 {
 634         struct ctf_scanner *scanner;
 635         struct ctf_file_stream *metadata_stream;
 636         FILE *fp;
 637         char *buf = NULL;
 638         int ret = 0;
 639
 640         metadata_stream = g_new0(struct ctf_file_stream, 1);
 641
 642         if (move_pos_slow) {
 643                 metadata_stream->pos.move_pos_slow = move_pos_slow;
 644         } else {
 645                 fprintf(stderr, "[error] move_pos_slow function undefined.\n");
 646                 ret = -1;
 647                 goto end_stream;
 648         }
 649
 650         if (metadata_fp) {
 651                 fp = metadata_fp;
 652         } else {
 653                 td->metadata = &metadata_stream->parent;
 654                 metadata_stream->pos.fd = openat(td->dirfd, "metadata", O_RDONLY);
 655                 if (metadata_stream->pos.fd < 0) {
 656                         fprintf(stdout, "Unable to open metadata.\n");
 657                         return metadata_stream->pos.fd;
 658                 }
 659
 660                 fp = fdopen(metadata_stream->pos.fd, "r");
 661                 if (!fp) {
 662                         fprintf(stdout, "[error] Unable to open metadata stream.\n");
 663                         ret = -errno;
 664                         goto end_stream;
 665                 }
 666         }
 667         if (babeltrace_debug)
 668                 yydebug = 1;
 669
 670         if (packet_metadata(td, fp)) {
 671                 ret = ctf_open_trace_metadata_stream_read(td, &fp, &buf);
 672                 if (ret)
 673                         goto end_packet_read;
 674         } else {
 675                 unsigned int major, minor;
 676                 ssize_t nr_items;
 677
 678                 td->byte_order = BYTE_ORDER;
 679
 680                 /* Check text-only metadata header and version */
 681                 nr_items = fscanf(fp, "/* CTF %u.%u", &major, &minor);
 682                 if (nr_items < 2)
 683                         fprintf(stdout, "[warning] Ill-shapen or missing \"/* CTF x.y\" header for text-only metadata.\n");
 684                 if (check_version(major, minor) < 0) {
 685                         ret = -EINVAL;
 686                         goto end_packet_read;
 687                 }
 688                 rewind(fp);
 689         }
 690
 691         scanner = ctf_scanner_alloc(fp);
 692         if (!scanner) {
 693                 fprintf(stdout, "[error] Error allocating scanner\n");
 694                 ret = -ENOMEM;
 695                 goto end_scanner_alloc;
 696         }
 697         ret = ctf_scanner_append_ast(scanner);
 698         if (ret) {
 699                 fprintf(stdout, "[error] Error creating AST\n");
 700                 goto end;
 701         }
 702
 703         if (babeltrace_debug) {
 704                 ret = ctf_visitor_print_xml(stdout, 0, &scanner->ast->root);
 705                 if (ret) {
 706                         fprintf(stdout, "[error] Error visiting AST for XML output\n");
 707                         goto end;
 708                 }
 709         }
 710
 711         ret = ctf_visitor_semantic_check(stdout, 0, &scanner->ast->root);
 712         if (ret) {
 713                 fprintf(stdout, "[error] Error in CTF semantic validation %d\n", ret);
 714                 goto end;
 715         }
 716         ret = ctf_visitor_construct_metadata(stdout, 0, &scanner->ast->root,
 717                         td, td->byte_order);
 718         if (ret) {
 719                 fprintf(stdout, "[error] Error in CTF metadata constructor %d\n", ret);
 720                 goto end;
 721         }
 722 end:
 723         ctf_scanner_free(scanner);
 724 end_scanner_alloc:
 725 end_packet_read:
 726         fclose(fp);
 727         free(buf);
 728 end_stream:
 729         close(metadata_stream->pos.fd);
 730         if (ret)
 731                 g_free(metadata_stream);
 732         return ret;
 733 }
 734
 735 static
 736 struct ctf_stream_event *create_event_definitions(struct ctf_trace *td,
 737                                                   struct ctf_stream *stream,
 738                                                   struct ctf_event *event)
 739 {
 740         struct ctf_stream_event *stream_event = g_new0(struct ctf_stream_event, 1);
 741
 742         if (event->context_decl) {
 743                 struct definition *definition =
 744                         event->context_decl->p.definition_new(&event->context_decl->p,
 745                                 stream->parent_def_scope, 0, 0, "event.context");
 746                 if (!definition) {
 747                         goto error;
 748                 }
 749                 stream_event->event_context = container_of(definition,
 750                                         struct definition_struct, p);
 751                 stream->parent_def_scope = stream_event->event_context->p.scope;
 752         }
 753         if (event->fields_decl) {
 754                 struct definition *definition =
 755                         event->fields_decl->p.definition_new(&event->fields_decl->p,
 756                                 stream->parent_def_scope, 0, 0, "event.fields");
 757                 if (!definition) {
 758                         goto error;
 759                 }
 760                 stream_event->event_fields = container_of(definition,
 761                                         struct definition_struct, p);
 762                 stream->parent_def_scope = stream_event->event_fields->p.scope;
 763         }
 764         return stream_event;
 765
 766 error:
 767         if (stream_event->event_fields)
 768                 definition_unref(&stream_event->event_fields->p);
 769         if (stream_event->event_context)
 770                 definition_unref(&stream_event->event_context->p);
 771         return NULL;
 772 }
 773
 774 static
 775 int create_stream_definitions(struct ctf_trace *td, struct ctf_stream *stream)
 776 {
 777         struct ctf_stream_class *stream_class;
 778         int ret;
 779         int i;
 780
 781         if (stream->stream_definitions_created)
 782                 return 0;
 783
 784         stream_class = stream->stream_class;
 785
 786         if (stream_class->packet_context_decl) {
 787                 struct definition *definition =
 788                         stream_class->packet_context_decl->p.definition_new(&stream_class->packet_context_decl->p,
 789                                 stream->parent_def_scope, 0, 0, "stream.packet.context");
 790                 if (!definition) {
 791                         ret = -EINVAL;
 792                         goto error;
 793                 }
 794                 stream->stream_packet_context = container_of(definition,
 795                                                 struct definition_struct, p);
 796                 stream->parent_def_scope = stream->stream_packet_context->p.scope;
 797         }
 798         if (stream_class->event_header_decl) {
 799                 struct definition *definition =
 800                         stream_class->event_header_decl->p.definition_new(&stream_class->event_header_decl->p,
 801                                 stream->parent_def_scope, 0, 0, "stream.event.header");
 802                 if (!definition) {
 803                         ret = -EINVAL;
 804                         goto error;
 805                 }
 806                 stream->stream_event_header =
 807                         container_of(definition, struct definition_struct, p);
 808                 stream->parent_def_scope = stream->stream_event_header->p.scope;
 809         }
 810         if (stream_class->event_context_decl) {
 811                 struct definition *definition =
 812                         stream_class->event_context_decl->p.definition_new(&stream_class->event_context_decl->p,
 813                                 stream->parent_def_scope, 0, 0, "stream.event.context");
 814                 if (!definition) {
 815                         ret = -EINVAL;
 816                         goto error;
 817                 }
 818                 stream->stream_event_context =
 819                         container_of(definition, struct definition_struct, p);
 820                 stream->parent_def_scope = stream->stream_event_context->p.scope;
 821         }
 822         stream->events_by_id = g_ptr_array_new();
 823         g_ptr_array_set_size(stream->events_by_id, stream_class->events_by_id->len);
 824         for (i = 0; i < stream->events_by_id->len; i++) {
 825                 struct ctf_event *event = g_ptr_array_index(stream_class->events_by_id, i);
 826                 struct ctf_stream_event *stream_event;
 827
 828                 if (!event)
 829                         continue;
 830                 stream_event = create_event_definitions(td, stream, event);
 831                 if (!stream_event)
 832                         goto error_event;
 833                 g_ptr_array_index(stream->events_by_id, i) = stream_event;
 834         }
 835         return 0;
 836
 837 error_event:
 838         for (i = 0; i < stream->events_by_id->len; i++) {
 839                 struct ctf_stream_event *stream_event = g_ptr_array_index(stream->events_by_id, i);
 840                 if (stream_event)
 841                         g_free(stream_event);
 842         }
 843         g_ptr_array_free(stream->events_by_id, TRUE);
 844 error:
 845         if (stream->stream_event_context)
 846                 definition_unref(&stream->stream_event_context->p);
 847         if (stream->stream_event_header)
 848                 definition_unref(&stream->stream_event_header->p);
 849         if (stream->stream_packet_context)
 850                 definition_unref(&stream->stream_packet_context->p);
 851         return ret;
 852 }
 853
 854
 855 static
 856 int create_stream_packet_index(struct ctf_trace *td,
 857                                struct ctf_file_stream *file_stream)
 858 {
 859         struct ctf_stream_class *stream;
 860         int len_index;
 861         struct ctf_stream_pos *pos;
 862         struct stat filestats;
 863         struct packet_index packet_index;
 864         int first_packet = 1;
 865         int ret;
 866
 867         pos = &file_stream->pos;
 868
 869         ret = fstat(pos->fd, &filestats);
 870         if (ret < 0)
 871                 return ret;
 872
 873         if (filestats.st_size < MAX_PACKET_HEADER_LEN / CHAR_BIT)
 874                 return -EINVAL;
 875
 876         for (pos->mmap_offset = 0; pos->mmap_offset < filestats.st_size; ) {
 877                 uint64_t stream_id = 0;
 878
 879                 if (pos->base) {
 880                         /* unmap old base */
 881                         ret = munmap(pos->base, pos->packet_size / CHAR_BIT);
 882                         if (ret) {
 883                                 fprintf(stdout, "[error] Unable to unmap old base: %s.\n",
 884                                         strerror(errno));
 885                                 return ret;
 886                         }
 887                         pos->base = NULL;
 888                 }
 889                 /* map new base. Need mapping length from header. */
 890                 pos->base = mmap(NULL, MAX_PACKET_HEADER_LEN / CHAR_BIT, PROT_READ,
 891                                  MAP_PRIVATE, pos->fd, pos->mmap_offset);
 892                 pos->content_size = MAX_PACKET_HEADER_LEN;      /* Unknown at this point */
 893                 pos->packet_size = MAX_PACKET_HEADER_LEN;       /* Unknown at this point */
 894                 pos->offset = 0;        /* Position of the packet header */
 895
 896                 packet_index.offset = pos->mmap_offset;
 897                 packet_index.content_size = 0;
 898                 packet_index.packet_size = 0;
 899                 packet_index.timestamp_begin = 0;
 900                 packet_index.timestamp_end = 0;
 901
 902                 /* read and check header, set stream id (and check) */
 903                 if (file_stream->parent.trace_packet_header) {
 904                         /* Read packet header */
 905                         ret = generic_rw(&pos->parent, &file_stream->parent.trace_packet_header->p);
 906                         if (ret)
 907                                 return ret;
 908                         len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("magic"));
 909                         if (len_index >= 0) {
 910                                 struct definition *field;
 911                                 uint64_t magic;
 912
 913                                 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
 914                                 magic = get_unsigned_int(field);
 915                                 if (magic != CTF_MAGIC) {
 916                                         fprintf(stdout, "[error] Invalid magic number 0x%" PRIX64 " at packet %u (file offset %zd).\n",
 917                                                         magic,
 918                                                         file_stream->pos.packet_index->len,
 919                                                         (ssize_t) pos->mmap_offset);
 920                                         return -EINVAL;
 921                                 }
 922                         }
 923
 924                         /* check uuid */
 925                         len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("uuid"));
 926                         if (len_index >= 0) {
 927                                 struct definition_array *defarray;
 928                                 struct definition *field;
 929                                 uint64_t i;
 930                                 uint8_t uuidval[UUID_LEN];
 931
 932                                 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
 933                                 assert(field->declaration->id == CTF_TYPE_ARRAY);
 934                                 defarray = container_of(field, struct definition_array, p);
 935                                 assert(array_len(defarray) == UUID_LEN);
 936
 937                                 for (i = 0; i < UUID_LEN; i++) {
 938                                         struct definition *elem;
 939
 940                                         elem = array_index(defarray, i);
 941                                         uuidval[i] = get_unsigned_int(elem);
 942                                 }
 943                                 ret = uuid_compare(td->uuid, uuidval);
 944                                 if (ret) {
 945                                         fprintf(stdout, "[error] Unique Universal Identifiers do not match.\n");
 946                                         return -EINVAL;
 947                                 }
 948                         }
 949
 950
 951                         len_index = struct_declaration_lookup_field_index(file_stream->parent.trace_packet_header->declaration, g_quark_from_static_string("stream_id"));
 952                         if (len_index >= 0) {
 953                                 struct definition *field;
 954
 955                                 field = struct_definition_get_field_from_index(file_stream->parent.trace_packet_header, len_index);
 956                                 stream_id = get_unsigned_int(field);
 957                         }
 958                 }
 959
 960                 if (!first_packet && file_stream->parent.stream_id != stream_id) {
 961                         fprintf(stdout, "[error] Stream ID is changing within a stream.\n");
 962                         return -EINVAL;
 963                 }
 964                 if (first_packet) {
 965                         file_stream->parent.stream_id = stream_id;
 966                         if (stream_id >= td->streams->len) {
 967                                 fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
 968                                 return -EINVAL;
 969                         }
 970                         stream = g_ptr_array_index(td->streams, stream_id);
 971                         if (!stream) {
 972                                 fprintf(stdout, "[error] Stream %" PRIu64 " is not declared in metadata.\n", stream_id);
 973                                 return -EINVAL;
 974                         }
 975                         file_stream->parent.stream_class = stream;
 976                         ret = create_stream_definitions(td, &file_stream->parent);
 977                         if (ret)
 978                                 return ret;
 979                 }
 980                 first_packet = 0;
 981
 982                 if (file_stream->parent.stream_packet_context) {
 983                         /* Read packet context */
 984                         ret = generic_rw(&pos->parent, &file_stream->parent.stream_packet_context->p);
 985                         if (ret)
 986                                 return ret;
 987                         /* read content size from header */
 988                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("content_size"));
 989                         if (len_index >= 0) {
 990                                 struct definition *field;
 991
 992                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
 993                                 packet_index.content_size = get_unsigned_int(field);
 994                         } else {
 995                                 /* Use file size for packet size */
 996                                 packet_index.content_size = filestats.st_size * CHAR_BIT;
 997                         }
 998
 999                         /* read packet size from header */
1000                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("packet_size"));
1001                         if (len_index >= 0) {
1002                                 struct definition *field;
1003
1004                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1005                                 packet_index.packet_size = get_unsigned_int(field);
1006                         } else {
1007                                 /* Use content size if non-zero, else file size */
1008                                 packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
1009                         }
1010
1011                         /* read timestamp begin from header */
1012                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_begin"));
1013                         if (len_index >= 0) {
1014                                 struct definition *field;
1015
1016                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1017                                 packet_index.timestamp_begin = get_unsigned_int(field);
1018                         }
1019
1020                         /* read timestamp end from header */
1021                         len_index = struct_declaration_lookup_field_index(file_stream->parent.stream_packet_context->declaration, g_quark_from_static_string("timestamp_end"));
1022                         if (len_index >= 0) {
1023                                 struct definition *field;
1024
1025                                 field = struct_definition_get_field_from_index(file_stream->parent.stream_packet_context, len_index);
1026                                 packet_index.timestamp_end = get_unsigned_int(field);
1027                         }
1028                 } else {
1029                         /* Use file size for packet size */
1030                         packet_index.content_size = filestats.st_size * CHAR_BIT;
1031                         /* Use content size if non-zero, else file size */
1032                         packet_index.packet_size = packet_index.content_size ? : filestats.st_size * CHAR_BIT;
1033                 }
1034
1035                 /* Validate content size and packet size values */
1036                 if (packet_index.content_size > packet_index.packet_size) {
1037                         fprintf(stdout, "[error] Content size (%zu bits) is larger than packet size (%zu bits).\n",
1038                                 packet_index.content_size, packet_index.packet_size);
1039                         return -EINVAL;
1040                 }
1041
1042                 if (packet_index.packet_size > (filestats.st_size - packet_index.offset) * CHAR_BIT) {
1043                         fprintf(stdout, "[error] Packet size (%zu bits) is larger than remaining file size (%zu bits).\n",
1044                                 packet_index.content_size, (size_t) (filestats.st_size - packet_index.offset) * CHAR_BIT);
1045                         return -EINVAL;
1046                 }
1047
1048                 /* Save position after header and context */
1049                 packet_index.data_offset = pos->offset;
1050
1051                 /* add index to packet array */
1052                 g_array_append_val(file_stream->pos.packet_index, packet_index);
1053
1054                 pos->mmap_offset += packet_index.packet_size / CHAR_BIT;
1055         }
1056
1057         /* Move pos back to beginning of file */
1058         ctf_move_pos_slow(pos, 0, SEEK_SET);    /* position for write */
1059
1060         return 0;
1061 }
1062
1063 static
1064 int create_trace_definitions(struct ctf_trace *td, struct ctf_stream *stream)
1065 {
1066         int ret;
1067
1068         if (td->packet_header_decl) {
1069                 struct definition *definition =
1070                         td->packet_header_decl->p.definition_new(&td->packet_header_decl->p,
1071                                 stream->parent_def_scope, 0, 0, "trace.packet.header");
1072                 if (!definition) {
1073                         ret = -EINVAL;
1074                         goto error;
1075                 }
1076                 stream->trace_packet_header =
1077                         container_of(definition, struct definition_struct, p);
1078                 stream->parent_def_scope = stream->trace_packet_header->p.scope;
1079         }
1080
1081         return 0;
1082
1083 error:
1084         return ret;
1085 }
1086
1087 /*
1088  * Note: many file streams can inherit from the same stream class
1089  * description (metadata).
1090  */
1091 static
1092 int ctf_open_file_stream_read(struct ctf_trace *td, const char *path, int flags,
1093                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
1094                         int whence))
1095 {
1096         int ret;
1097         struct ctf_file_stream *file_stream;
1098
1099         ret = openat(td->dirfd, path, flags);
1100         if (ret < 0)
1101                 goto error;
1102         file_stream = g_new0(struct ctf_file_stream, 1);
1103
1104         if (move_pos_slow) {
1105                 file_stream->pos.move_pos_slow = move_pos_slow;
1106         } else {
1107                 fprintf(stderr, "[error] move_pos_slow function undefined.\n");
1108                 ret = -1;
1109                 goto error_def;
1110         }
1111
1112         ctf_init_pos(&file_stream->pos, ret, flags);
1113         ret = create_trace_definitions(td, &file_stream->parent);
1114         if (ret)
1115                 goto error_def;
1116         ret = create_stream_packet_index(td, file_stream);
1117         if (ret)
1118                 goto error_index;
1119         /* Add stream file to stream class */
1120         g_ptr_array_add(file_stream->parent.stream_class->streams,
1121                         &file_stream->parent);
1122         return 0;
1123
1124 error_index:
1125         if (file_stream->parent.trace_packet_header)
1126                 definition_unref(&file_stream->parent.trace_packet_header->p);
1127 error_def:
1128         ctf_fini_pos(&file_stream->pos);
1129         close(file_stream->pos.fd);
1130         g_free(file_stream);
1131 error:
1132         return ret;
1133 }
1134
1135 static
1136 int ctf_open_trace_read(struct ctf_trace *td, const char *path, int flags,
1137                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
1138                         int whence), FILE *metadata_fp)
1139 {
1140         int ret;
1141         struct dirent *dirent;
1142         struct dirent *diriter;
1143         size_t dirent_len;
1144
1145         td->flags = flags;
1146
1147         /* Open trace directory */
1148         td->dir = opendir(path);
1149         if (!td->dir) {
1150                 fprintf(stdout, "[error] Unable to open trace directory.\n");
1151                 ret = -ENOENT;
1152                 goto error;
1153         }
1154
1155         td->dirfd = open(path, 0);
1156         if (td->dirfd < 0) {
1157                 fprintf(stdout, "[error] Unable to open trace directory file descriptor.\n");
1158                 ret = -ENOENT;
1159                 goto error_dirfd;
1160         }
1161
1162         /*
1163          * Keep the metadata file separate.
1164          */
1165
1166         ret = ctf_open_trace_metadata_read(td, move_pos_slow, metadata_fp);
1167         if (ret) {
1168                 goto error_metadata;
1169         }
1170
1171         /*
1172          * Open each stream: for each file, try to open, check magic
1173          * number, and get the stream ID to add to the right location in
1174          * the stream array.
1175          */
1176
1177         dirent_len = offsetof(struct dirent, d_name) +
1178                         fpathconf(td->dirfd, _PC_NAME_MAX) + 1;
1179
1180         dirent = malloc(dirent_len);
1181
1182         for (;;) {
1183                 ret = readdir_r(td->dir, dirent, &diriter);
1184                 if (ret) {
1185                         fprintf(stdout, "[error] Readdir error.\n");
1186                         goto readdir_error;
1187                 }
1188                 if (!diriter)
1189                         break;
1190                 /* Ignore hidden files, ., .. and metadata. */
1191                 if (!strncmp(diriter->d_name, ".", 1)
1192                                 || !strcmp(diriter->d_name, "..")
1193                                 || !strcmp(diriter->d_name, "metadata"))
1194                         continue;
1195                 ret = ctf_open_file_stream_read(td, diriter->d_name, flags, move_pos_slow);
1196                 if (ret) {
1197                         fprintf(stdout, "[error] Open file stream error.\n");
1198                         goto readdir_error;
1199                 }
1200         }
1201
1202         free(dirent);
1203         return 0;
1204
1205 readdir_error:
1206         free(dirent);
1207 error_metadata:
1208         close(td->dirfd);
1209 error_dirfd:
1210         closedir(td->dir);
1211 error:
1212         return ret;
1213 }
1214
1215 static
1216 struct trace_descriptor *ctf_open_trace(const char *path, int flags,
1217                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
1218                         int whence), FILE *metadata_fp)
1219 {
1220         struct ctf_trace *td;
1221         int ret;
1222
1223         td = g_new0(struct ctf_trace, 1);
1224
1225         switch (flags & O_ACCMODE) {
1226         case O_RDONLY:
1227                 if (!path) {
1228                         fprintf(stdout, "[error] Path missing for input CTF trace.\n");
1229                         goto error;
1230                 }
1231                 ret = ctf_open_trace_read(td, path, flags, move_pos_slow, metadata_fp);
1232                 if (ret)
1233                         goto error;
1234                 break;
1235         case O_RDWR:
1236                 fprintf(stdout, "[error] Opening CTF traces for output is not supported yet.\n");
1237                 goto error;
1238         default:
1239                 fprintf(stdout, "[error] Incorrect open flags.\n");
1240                 goto error;
1241         }
1242
1243         return &td->parent;
1244 error:
1245         g_free(td);
1246         return NULL;
1247 }
1248
1249
1250 void ctf_init_mmap_pos(struct ctf_stream_pos *pos,
1251                 struct mmap_stream *mmap_info)
1252 {
1253         pos->mmap_offset = 0;
1254         pos->packet_size = 0;
1255         pos->content_size = 0;
1256         pos->content_size_loc = NULL;
1257         pos->fd = mmap_info->fd;
1258         pos->base = 0;
1259         pos->offset = 0;
1260         pos->dummy = false;
1261         pos->cur_index = 0;
1262         pos->packet_index = NULL;
1263         pos->prot = PROT_READ;
1264         pos->flags = MAP_PRIVATE;
1265         pos->parent.rw_table = read_dispatch_table;
1266         pos->parent.event_cb = ctf_read_event;
1267 }
1268
1269 static
1270 int prepare_mmap_stream_definition(struct ctf_trace *td,
1271                 struct ctf_file_stream *file_stream)
1272 {
1273         struct ctf_stream_class *stream;
1274         uint64_t stream_id = 0;
1275         int ret;
1276
1277         file_stream->parent.stream_id = stream_id;
1278         if (stream_id >= td->streams->len) {
1279                 fprintf(stdout, "[error] Stream %" PRIu64 " is not declared "
1280                                 "in metadata.\n", stream_id);
1281                 ret = -EINVAL;
1282                 goto end;
1283         }
1284         stream = g_ptr_array_index(td->streams, stream_id);
1285         if (!stream) {
1286                 fprintf(stdout, "[error] Stream %" PRIu64 " is not declared "
1287                                 "in metadata.\n", stream_id);
1288                 ret = -EINVAL;
1289                 goto end;
1290         }
1291         file_stream->parent.stream_class = stream;
1292         ret = create_stream_definitions(td, &file_stream->parent);
1293 end:
1294         return ret;
1295 }
1296
1297 static
1298 int ctf_open_mmap_stream_read(struct ctf_trace *td,
1299                 struct mmap_stream *mmap_info,
1300                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
1301                         int whence))
1302 {
1303         int ret;
1304         struct ctf_file_stream *file_stream;
1305
1306         file_stream = g_new0(struct ctf_file_stream, 1);
1307         ctf_init_mmap_pos(&file_stream->pos, mmap_info);
1308
1309         file_stream->pos.move_pos_slow = move_pos_slow;
1310
1311         ret = create_trace_definitions(td, &file_stream->parent);
1312         if (ret) {
1313                 goto error_def;
1314         }
1315
1316         ret = prepare_mmap_stream_definition(td, file_stream);
1317         if (ret)
1318                 goto error_index;
1319
1320         /* Add stream file to stream class */
1321         g_ptr_array_add(file_stream->parent.stream_class->streams,
1322                         &file_stream->parent);
1323         return 0;
1324
1325 error_index:
1326         if (file_stream->parent.trace_packet_header)
1327                 definition_unref(&file_stream->parent.trace_packet_header->p);
1328 error_def:
1329         g_free(file_stream);
1330         return ret;
1331 }
1332
1333 int ctf_open_mmap_trace_read(struct ctf_trace *td,
1334                 struct mmap_stream_list *mmap_list,
1335                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset,
1336                         int whence),
1337                 FILE *metadata_fp)
1338 {
1339         int ret;
1340         struct mmap_stream *mmap_info;
1341
1342         ret = ctf_open_trace_metadata_read(td, ctf_move_pos_slow, metadata_fp);
1343         if (ret) {
1344                 goto error;
1345         }
1346
1347         /*
1348          * for each stream, try to open, check magic number, and get the
1349          * stream ID to add to the right location in the stream array.
1350          */
1351         cds_list_for_each_entry(mmap_info, &mmap_list->head, list) {
1352                 ret = ctf_open_mmap_stream_read(td, mmap_info, move_pos_slow);
1353                 if (ret) {
1354                         fprintf(stdout, "[error] Open file mmap stream error.\n");
1355                         goto error;
1356                 }
1357         }
1358
1359         return 0;
1360
1361 error:
1362         return ret;
1363 }
1364
1365 static
1366 struct trace_descriptor *ctf_open_mmap_trace(
1367                 struct mmap_stream_list *mmap_list,
1368                 void (*move_pos_slow)(struct ctf_stream_pos *pos, size_t offset, int whence),
1369                 FILE *metadata_fp)
1370 {
1371         struct ctf_trace *td;
1372         int ret;
1373
1374         if (!metadata_fp) {
1375                 fprintf(stderr, "[error] No metadata file pointer associated, "
1376                                 "required for mmap parsing\n");
1377                 goto error;
1378         }
1379         if (!move_pos_slow) {
1380                 fprintf(stderr, "[error] move_pos_slow function undefined.\n");
1381                 goto error;
1382         }
1383         td = g_new0(struct ctf_trace, 1);
1384         ret = ctf_open_mmap_trace_read(td, mmap_list, move_pos_slow, metadata_fp);
1385         if (ret)
1386                 goto error_free;
1387
1388         return &td->parent;
1389
1390 error_free:
1391         g_free(td);
1392 error:
1393         return NULL;
1394 }
1395
1396 static
1397 void ctf_close_file_stream(struct ctf_file_stream *file_stream)
1398 {
1399         ctf_fini_pos(&file_stream->pos);
1400         close(file_stream->pos.fd);
1401 }
1402
1403 static
1404 void ctf_close_trace(struct trace_descriptor *tdp)
1405 {
1406         struct ctf_trace *td = container_of(tdp, struct ctf_trace, parent);
1407         int i;
1408
1409         if (td->streams) {
1410                 for (i = 0; i < td->streams->len; i++) {
1411                         struct ctf_stream_class *stream;
1412                         int j;
1413
1414                         stream = g_ptr_array_index(td->streams, i);
1415                         if (!stream)
1416                                 continue;
1417                         for (j = 0; j < stream->streams->len; j++) {
1418                                 struct ctf_file_stream *file_stream;
1419                                 file_stream = container_of(g_ptr_array_index(stream->streams, j), struct ctf_file_stream, parent);
1420                                 ctf_close_file_stream(file_stream);
1421                         }
1422
1423                 }
1424                 g_ptr_array_free(td->streams, TRUE);
1425         }
1426         closedir(td->dir);
1427         g_free(td);
1428 }
1429
1430 void __attribute__((constructor)) ctf_init(void)
1431 {
1432         int ret;
1433
1434         ctf_format.name = g_quark_from_static_string("ctf");
1435         ret = bt_register_format(&ctf_format);
1436         assert(!ret);
1437 }
1438
1439 /* TODO: finalize */