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