formats/ctf/ctf.c

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