git.cworth.org Git - apitrace/blob - trace_parser.cpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2011 Jose Fonseca
   4  * Copyright 2010 VMware, Inc.
   5  * All Rights Reserved.
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  *
  25  **************************************************************************/
  26
  27
  28 #include <assert.h>
  29 #include <stdlib.h>
  30
  31 #include "trace_file.hpp"
  32 #include "trace_snappyfile.hpp"
  33 #include "trace_parser.hpp"
  34
  35
  36 #define TRACE_VERBOSE 0
  37
  38
  39 namespace Trace {
  40
  41
  42 Parser::Parser() {
  43     file = NULL;
  44     next_call_no = 0;
  45     version = 0;
  46 }
  47
  48
  49 Parser::~Parser() {
  50     close();
  51 }
  52
  53
  54 bool Parser::open(const char *filename) {
  55     assert(!file);
  56     if (File::isZLibCompressed(filename)) {
  57         file = new ZLibFile;
  58     } else {
  59         file = new SnappyFile;
  60     }
  61
  62     if (!file->open(filename, File::Read)) {
  63         return false;
  64     }
  65
  66     version = read_uint();
  67     if (version > TRACE_VERSION) {
  68         std::cerr << "error: unsupported trace format version " << version << "\n";
  69         return false;
  70     }
  71
  72     return true;
  73 }
  74
  75 template <typename Iter>
  76 inline void
  77 deleteAll(Iter begin, Iter end)
  78 {
  79     while (begin != end) {
  80         delete *begin;
  81         ++begin;
  82     }
  83 }
  84
  85 template <typename Container>
  86 inline void
  87 deleteAll(Container &c)
  88 {
  89     deleteAll(c.begin(), c.end());
  90     c.clear();
  91 }
  92
  93 void Parser::close(void) {
  94     if (file) {
  95         file->close();
  96         delete file;
  97         file = NULL;
  98     }
  99
 100     deleteAll(calls);
 101     deleteAll(functions);
 102     deleteAll(structs);
 103     deleteAll(enums);
 104     deleteAll(bitmasks);
 105 }
 106
 107
 108 void Parser::getBookmark(ParseBookmark &bookmark) {
 109     bookmark.offset = file->currentOffset();
 110     bookmark.next_call_no = next_call_no;
 111 }
 112
 113
 114 void Parser::setBookmark(const ParseBookmark &bookmark) {
 115     file->setCurrentOffset(bookmark.offset);
 116     next_call_no = bookmark.next_call_no;
 117
 118     // Simply ignore all pending calls
 119     deleteAll(calls);
 120 }
 121
 122
 123 Call *Parser::parse_call(Mode mode) {
 124     do {
 125         int c = read_byte();
 126         switch(c) {
 127         case Trace::EVENT_ENTER:
 128             parse_enter(mode);
 129             break;
 130         case Trace::EVENT_LEAVE:
 131             return parse_leave(mode);
 132         default:
 133             std::cerr << "error: unknown event " << c << "\n";
 134             exit(1);
 135         case -1:
 136             for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 137                 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
 138                 std::cerr << **it << "\n";
 139             }
 140             return NULL;
 141         }
 142     } while(true);
 143 }
 144
 145
 146 /**
 147  * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
 148  */
 149 template<class T>
 150 T *lookup(std::vector<T *> &map, size_t index) {
 151     if (index >= map.size()) {
 152         map.resize(index + 1);
 153         return NULL;
 154     } else {
 155         return map[index];
 156     }
 157 }
 158
 159
 160 FunctionSig *Parser::parse_function_sig(void) {
 161     size_t id = read_uint();
 162
 163     FunctionSigState *sig = lookup(functions, id);
 164
 165     if (!sig) {
 166         /* parse the signature */
 167         sig = new FunctionSigState;
 168         sig->id = id;
 169         sig->name = read_string();
 170         sig->num_args = read_uint();
 171         const char **arg_names = new const char *[sig->num_args];
 172         for (unsigned i = 0; i < sig->num_args; ++i) {
 173             arg_names[i] = read_string();
 174         }
 175         sig->arg_names = arg_names;
 176         sig->offset = file->currentOffset();
 177         functions[id] = sig;
 178     } else if (file->currentOffset() < sig->offset) {
 179         /* skip over the signature */
 180         skip_string(); /* name */
 181         int num_args = read_uint();
 182         for (unsigned i = 0; i < num_args; ++i) {
 183              skip_string(); /*arg_name*/
 184         }
 185     }
 186
 187     assert(sig);
 188     return sig;
 189 }
 190
 191
 192 StructSig *Parser::parse_struct_sig() {
 193     size_t id = read_uint();
 194
 195     StructSigState *sig = lookup(structs, id);
 196
 197     if (!sig) {
 198         /* parse the signature */
 199         sig = new StructSigState;
 200         sig->id = id;
 201         sig->name = read_string();
 202         sig->num_members = read_uint();
 203         const char **member_names = new const char *[sig->num_members];
 204         for (unsigned i = 0; i < sig->num_members; ++i) {
 205             member_names[i] = read_string();
 206         }
 207         sig->member_names = member_names;
 208         sig->offset = file->currentOffset();
 209         structs[id] = sig;
 210     } else if (file->currentOffset() < sig->offset) {
 211         /* skip over the signature */
 212         skip_string(); /* name */
 213         unsigned num_members = read_uint();
 214         for (unsigned i = 0; i < num_members; ++i) {
 215             skip_string(); /* member_name */
 216         }
 217     }
 218
 219     assert(sig);
 220     return sig;
 221 }
 222
 223
 224 EnumSig *Parser::parse_enum_sig() {
 225     size_t id = read_uint();
 226
 227     EnumSigState *sig = lookup(enums, id);
 228
 229     if (!sig) {
 230         /* parse the signature */
 231         sig = new EnumSigState;
 232         sig->id = id;
 233         sig->name = read_string();
 234         Value *value = parse_value();
 235         sig->value = value->toSInt();
 236         delete value;
 237         sig->offset = file->currentOffset();
 238         enums[id] = sig;
 239     } else if (file->currentOffset() < sig->offset) {
 240         /* skip over the signature */
 241         skip_string(); /*name*/
 242         scan_value();
 243     }
 244
 245     assert(sig);
 246     return sig;
 247 }
 248
 249
 250 BitmaskSig *Parser::parse_bitmask_sig() {
 251     size_t id = read_uint();
 252
 253     BitmaskSigState *sig = lookup(bitmasks, id);
 254
 255     if (!sig) {
 256         /* parse the signature */
 257         sig = new BitmaskSigState;
 258         sig->id = id;
 259         sig->num_flags = read_uint();
 260         BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
 261         for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
 262             it->name = read_string();
 263             it->value = read_uint();
 264             if (it->value == 0 && it != flags) {
 265                 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
 266             }
 267         }
 268         sig->flags = flags;
 269         sig->offset = file->currentOffset();
 270         bitmasks[id] = sig;
 271     } else if (file->currentOffset() < sig->offset) {
 272         /* skip over the signature */
 273         int num_flags = read_uint();
 274         for (int i = 0; i < num_flags; ++i) {
 275             skip_string(); /*name */
 276             skip_uint(); /* value */
 277         }
 278     }
 279
 280     assert(sig);
 281     return sig;
 282 }
 283
 284
 285 void Parser::parse_enter(Mode mode) {
 286     FunctionSig *sig = parse_function_sig();
 287
 288     Call *call = new Call(sig);
 289
 290     call->no = next_call_no++;
 291
 292     if (parse_call_details(call, mode)) {
 293         calls.push_back(call);
 294     } else {
 295         delete call;
 296     }
 297 }
 298
 299
 300 Call *Parser::parse_leave(Mode mode) {
 301     unsigned call_no = read_uint();
 302     Call *call = NULL;
 303     for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 304         if ((*it)->no == call_no) {
 305             call = *it;
 306             calls.erase(it);
 307             break;
 308         }
 309     }
 310     if (!call) {
 311         return NULL;
 312     }
 313
 314     if (parse_call_details(call, mode)) {
 315         return call;
 316     } else {
 317         delete call;
 318         return NULL;
 319     }
 320 }
 321
 322
 323 bool Parser::parse_call_details(Call *call, Mode mode) {
 324     do {
 325         int c = read_byte();
 326         switch(c) {
 327         case Trace::CALL_END:
 328             return true;
 329         case Trace::CALL_ARG:
 330             parse_arg(call, mode);
 331             break;
 332         case Trace::CALL_RET:
 333             call->ret = parse_value(mode);
 334             break;
 335         default:
 336             std::cerr << "error: ("<<call->name()<< ") unknown call detail "
 337                       << c << "\n";
 338             exit(1);
 339         case -1:
 340             return false;
 341         }
 342     } while(true);
 343 }
 344
 345
 346 void Parser::parse_arg(Call *call, Mode mode) {
 347     unsigned index = read_uint();
 348     Value *value = parse_value(mode);
 349     if (value) {
 350         if (index >= call->args.size()) {
 351             call->args.resize(index + 1);
 352         }
 353         call->args[index] = value;
 354     }
 355 }
 356
 357
 358 Value *Parser::parse_value(void) {
 359     int c;
 360     Value *value;
 361     c = read_byte();
 362     switch(c) {
 363     case Trace::TYPE_NULL:
 364         value = new Null;
 365         break;
 366     case Trace::TYPE_FALSE:
 367         value = new Bool(false);
 368         break;
 369     case Trace::TYPE_TRUE:
 370         value = new Bool(true);
 371         break;
 372     case Trace::TYPE_SINT:
 373         value = parse_sint();
 374         break;
 375     case Trace::TYPE_UINT:
 376         value = parse_uint();
 377         break;
 378     case Trace::TYPE_FLOAT:
 379         value = parse_float();
 380         break;
 381     case Trace::TYPE_DOUBLE:
 382         value = parse_double();
 383         break;
 384     case Trace::TYPE_STRING:
 385         value = parse_string();
 386         break;
 387     case Trace::TYPE_ENUM:
 388         value = parse_enum();
 389         break;
 390     case Trace::TYPE_BITMASK:
 391         value = parse_bitmask();
 392         break;
 393     case Trace::TYPE_ARRAY:
 394         value = parse_array();
 395         break;
 396     case Trace::TYPE_STRUCT:
 397         value = parse_struct();
 398         break;
 399     case Trace::TYPE_BLOB:
 400         value = parse_blob();
 401         break;
 402     case Trace::TYPE_OPAQUE:
 403         value = parse_opaque();
 404         break;
 405     default:
 406         std::cerr << "error: unknown type " << c << "\n";
 407         exit(1);
 408     case -1:
 409         value = NULL;
 410         break;
 411     }
 412 #if TRACE_VERBOSE
 413     if (value) {
 414         std::cerr << "\tVALUE " << value << "\n";
 415     }
 416 #endif
 417     return value;
 418 }
 419
 420
 421 void Parser::scan_value(void) {
 422     int c = read_byte();
 423     switch(c) {
 424     case Trace::TYPE_NULL:
 425     case Trace::TYPE_FALSE:
 426     case Trace::TYPE_TRUE:
 427         break;
 428     case Trace::TYPE_SINT:
 429         scan_sint();
 430         break;
 431     case Trace::TYPE_UINT:
 432         scan_uint();
 433         break;
 434     case Trace::TYPE_FLOAT:
 435         scan_float();
 436         break;
 437     case Trace::TYPE_DOUBLE:
 438         scan_double();
 439         break;
 440     case Trace::TYPE_STRING:
 441         scan_string();
 442         break;
 443     case Trace::TYPE_ENUM:
 444         scan_enum();
 445         break;
 446     case Trace::TYPE_BITMASK:
 447         scan_bitmask();
 448         break;
 449     case Trace::TYPE_ARRAY:
 450         scan_array();
 451         break;
 452     case Trace::TYPE_STRUCT:
 453         scan_struct();
 454         break;
 455     case Trace::TYPE_BLOB:
 456         scan_blob();
 457         break;
 458     case Trace::TYPE_OPAQUE:
 459         scan_opaque();
 460         break;
 461     default:
 462         std::cerr << "error: unknown type " << c << "\n";
 463         exit(1);
 464     case -1:
 465         break;
 466     }
 467 }
 468
 469
 470 Value *Parser::parse_sint() {
 471     return new SInt(-(signed long long)read_uint());
 472 }
 473
 474
 475 void Parser::scan_sint() {
 476     skip_uint();
 477 }
 478
 479
 480 Value *Parser::parse_uint() {
 481     return new UInt(read_uint());
 482 }
 483
 484
 485 void Parser::scan_uint() {
 486     skip_uint();
 487 }
 488
 489
 490 Value *Parser::parse_float() {
 491     float value;
 492     file->read(&value, sizeof value);
 493     return new Float(value);
 494 }
 495
 496
 497 void Parser::scan_float() {
 498     file->skip(sizeof(float));
 499 }
 500
 501
 502 Value *Parser::parse_double() {
 503     double value;
 504     file->read(&value, sizeof value);
 505     return new Float(value);
 506 }
 507
 508
 509 void Parser::scan_double() {
 510     file->skip(sizeof(double));
 511 }
 512
 513
 514 Value *Parser::parse_string() {
 515     return new String(read_string());
 516 }
 517
 518
 519 void Parser::scan_string() {
 520     skip_string();
 521 }
 522
 523
 524 Value *Parser::parse_enum() {
 525     EnumSig *sig = parse_enum_sig();
 526     return new Enum(sig);
 527 }
 528
 529
 530 void Parser::scan_enum() {
 531     parse_enum_sig();
 532 }
 533
 534
 535 Value *Parser::parse_bitmask() {
 536     BitmaskSig *sig = parse_bitmask_sig();
 537
 538     unsigned long long value = read_uint();
 539
 540     return new Bitmask(sig, value);
 541 }
 542
 543
 544 void Parser::scan_bitmask() {
 545     parse_bitmask_sig();
 546     skip_uint(); /* value */
 547 }
 548
 549
 550 Value *Parser::parse_array(void) {
 551     size_t len = read_uint();
 552     Array *array = new Array(len);
 553     for (size_t i = 0; i < len; ++i) {
 554         array->values[i] = parse_value();
 555     }
 556     return array;
 557 }
 558
 559
 560 void Parser::scan_array(void) {
 561     size_t len = read_uint();
 562     for (size_t i = 0; i < len; ++i) {
 563         scan_value();
 564     }
 565 }
 566
 567
 568 Value *Parser::parse_blob(void) {
 569     size_t size = read_uint();
 570     Blob *blob = new Blob(size);
 571     if (size) {
 572         file->read(blob->buf, (unsigned)size);
 573     }
 574     return blob;
 575 }
 576
 577
 578 void Parser::scan_blob(void) {
 579     size_t size = read_uint();
 580     if (size) {
 581         file->skip(size);
 582     }
 583 }
 584
 585
 586 Value *Parser::parse_struct() {
 587     StructSig *sig = parse_struct_sig();
 588     Struct *value = new Struct(sig);
 589
 590     for (size_t i = 0; i < sig->num_members; ++i) {
 591         value->members[i] = parse_value();
 592     }
 593
 594     return value;
 595 }
 596
 597
 598 void Parser::scan_struct() {
 599     StructSig *sig = parse_struct_sig();
 600     for (size_t i = 0; i < sig->num_members; ++i) {
 601         scan_value();
 602     }
 603 }
 604
 605
 606 Value *Parser::parse_opaque() {
 607     unsigned long long addr;
 608     addr = read_uint();
 609     return new Pointer(addr);
 610 }
 611
 612
 613 void Parser::scan_opaque() {
 614     skip_uint();
 615 }
 616
 617
 618 const char * Parser::read_string(void) {
 619     size_t len = read_uint();
 620     char * value = new char[len + 1];
 621     if (len) {
 622         file->read(value, (unsigned)len);
 623     }
 624     value[len] = 0;
 625 #if TRACE_VERBOSE
 626     std::cerr << "\tSTRING \"" << value << "\"\n";
 627 #endif
 628     return value;
 629 }
 630
 631
 632 void Parser::skip_string(void) {
 633     size_t len = read_uint();
 634     file->skip(len);
 635 }
 636
 637
 638 unsigned long long Parser::read_uint(void) {
 639     unsigned long long value = 0;
 640     int c;
 641     unsigned shift = 0;
 642     do {
 643         c = file->getc();
 644         if (c == -1) {
 645             break;
 646         }
 647         value |= (unsigned long long)(c & 0x7f) << shift;
 648         shift += 7;
 649     } while(c & 0x80);
 650 #if TRACE_VERBOSE
 651     std::cerr << "\tUINT " << value << "\n";
 652 #endif
 653     return value;
 654 }
 655
 656
 657 void Parser::skip_uint(void) {
 658     int c;
 659     do {
 660         c = file->getc();
 661         if (c == -1) {
 662             break;
 663         }
 664     } while(c & 0x80);
 665 }
 666
 667
 668 inline int Parser::read_byte(void) {
 669     int c = file->getc();
 670 #if TRACE_VERBOSE
 671     if (c < 0)
 672         std::cerr << "\tEOF" << "\n";
 673     else
 674         std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
 675 #endif
 676     return c;
 677 }
 678
 679
 680 inline void Parser::skip_byte(void) {
 681     file->skip(1);
 682 }
 683
 684
 685 } /* namespace Trace */