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 Call *Parser::parse_call(void) {
 109     do {
 110         int c = read_byte();
 111         switch(c) {
 112         case Trace::EVENT_ENTER:
 113             parse_enter();
 114             break;
 115         case Trace::EVENT_LEAVE:
 116             return parse_leave();
 117         default:
 118             std::cerr << "error: unknown event " << c << "\n";
 119             exit(1);
 120         case -1:
 121             for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 122                 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
 123                 std::cerr << **it << "\n";
 124             }
 125             return NULL;
 126         }
 127     } while(true);
 128 }
 129
 130
 131 /**
 132  * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
 133  */
 134 template<class T>
 135 T *lookup(std::vector<T *> &map, size_t index) {
 136     if (index >= map.size()) {
 137         map.resize(index + 1);
 138         return NULL;
 139     } else {
 140         return map[index];
 141     }
 142 }
 143
 144
 145 void Parser::parse_enter(void) {
 146     size_t id = read_uint();
 147
 148     FunctionSig *sig = lookup(functions, id);
 149     const File::Offset offset = file->currentOffset();
 150     bool callWithSig = callWithSignature(offset);
 151     if (!sig || callWithSig) {
 152         if (!sig) {
 153             sig = new FunctionSig;
 154             sig->id = id;
 155             sig->name = read_string();
 156             sig->num_args = read_uint();
 157             const char **arg_names = new const char *[sig->num_args];
 158             for (unsigned i = 0; i < sig->num_args; ++i) {
 159                 arg_names[i] = read_string();
 160             }
 161             sig->arg_names = arg_names;
 162             functions[id] = sig;
 163             m_callSigOffsets.insert(offset);
 164         } else {
 165             /* skip over the signature */
 166             skip_string(); /* name */
 167             int num_args = read_uint();
 168             for (unsigned i = 0; i < num_args; ++i) {
 169                  skip_string(); /*arg_name*/
 170             }
 171         }
 172     }
 173     assert(sig);
 174
 175     Call *call = new Call(sig);
 176
 177
 178     call->no = next_call_no++;
 179
 180     if (parse_call_details(call)) {
 181         calls.push_back(call);
 182     } else {
 183         delete call;
 184     }
 185 }
 186
 187
 188 Call *Parser::parse_leave(void) {
 189     unsigned call_no = read_uint();
 190     Call *call = NULL;
 191     for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 192         if ((*it)->no == call_no) {
 193             call = *it;
 194             calls.erase(it);
 195             break;
 196         }
 197     }
 198     if (!call) {
 199         return NULL;
 200     }
 201
 202     if (parse_call_details(call)) {
 203         return call;
 204     } else {
 205         delete call;
 206         return NULL;
 207     }
 208 }
 209
 210
 211 bool Parser::parse_call_details(Call *call) {
 212     do {
 213         int c = read_byte();
 214         switch(c) {
 215         case Trace::CALL_END:
 216             return true;
 217         case Trace::CALL_ARG:
 218             parse_arg(call);
 219             break;
 220         case Trace::CALL_RET:
 221             call->ret = parse_value();
 222             break;
 223         default:
 224             std::cerr << "error: ("<<call->name()<< ") unknown call detail "
 225                       << c << "\n";
 226             exit(1);
 227         case -1:
 228             return false;
 229         }
 230     } while(true);
 231 }
 232
 233
 234 void Parser::parse_arg(Call *call) {
 235     unsigned index = read_uint();
 236     Value *value = parse_value();
 237     if (index >= call->args.size()) {
 238         call->args.resize(index + 1);
 239     }
 240     call->args[index] = value;
 241 }
 242
 243
 244 Value *Parser::parse_value(void) {
 245     int c;
 246     Value *value;
 247     c = read_byte();
 248     switch(c) {
 249     case Trace::TYPE_NULL:
 250         value = new Null;
 251         break;
 252     case Trace::TYPE_FALSE:
 253         value = new Bool(false);
 254         break;
 255     case Trace::TYPE_TRUE:
 256         value = new Bool(true);
 257         break;
 258     case Trace::TYPE_SINT:
 259         value = parse_sint();
 260         break;
 261     case Trace::TYPE_UINT:
 262         value = parse_uint();
 263         break;
 264     case Trace::TYPE_FLOAT:
 265         value = parse_float();
 266         break;
 267     case Trace::TYPE_DOUBLE:
 268         value = parse_double();
 269         break;
 270     case Trace::TYPE_STRING:
 271         value = parse_string();
 272         break;
 273     case Trace::TYPE_ENUM:
 274         value = parse_enum();
 275         break;
 276     case Trace::TYPE_BITMASK:
 277         value = parse_bitmask();
 278         break;
 279     case Trace::TYPE_ARRAY:
 280         value = parse_array();
 281         break;
 282     case Trace::TYPE_STRUCT:
 283         value = parse_struct();
 284         break;
 285     case Trace::TYPE_BLOB:
 286         value = parse_blob();
 287         break;
 288     case Trace::TYPE_OPAQUE:
 289         value = parse_opaque();
 290         break;
 291     default:
 292         std::cerr << "error: unknown type " << c << "\n";
 293         exit(1);
 294     case -1:
 295         value = NULL;
 296         break;
 297     }
 298 #if TRACE_VERBOSE
 299     if (value) {
 300         std::cerr << "\tVALUE " << value << "\n";
 301     }
 302 #endif
 303     return value;
 304 }
 305
 306
 307 Value *Parser::parse_sint() {
 308     return new SInt(-(signed long long)read_uint());
 309 }
 310
 311
 312 Value *Parser::parse_uint() {
 313     return new UInt(read_uint());
 314 }
 315
 316
 317 Value *Parser::parse_float() {
 318     float value;
 319     file->read(&value, sizeof value);
 320     return new Float(value);
 321 }
 322
 323
 324 Value *Parser::parse_double() {
 325     double value;
 326     file->read(&value, sizeof value);
 327     return new Float(value);
 328 }
 329
 330
 331 Value *Parser::parse_string() {
 332     return new String(read_string());
 333 }
 334
 335
 336 Value *Parser::parse_enum() {
 337     size_t id = read_uint();
 338     EnumSig *sig = lookup(enums, id);
 339     const File::Offset offset = file->currentOffset();
 340     bool enumWithSig = enumWithSignature(offset);
 341     if (!sig || enumWithSig) {
 342         if (!sig) {
 343             sig = new EnumSig;
 344             sig->id = id;
 345             sig->name = read_string();
 346             Value *value = parse_value();
 347             sig->value = value->toSInt();
 348             delete value;
 349             enums[id] = sig;
 350             m_enumSigOffsets.insert(offset);
 351         } else {
 352             skip_string(); /*name*/
 353             scan_value();
 354         }
 355     }
 356     assert(sig);
 357     return new Enum(sig);
 358 }
 359
 360
 361 Value *Parser::parse_bitmask() {
 362     size_t id = read_uint();
 363     BitmaskSig *sig = lookup(bitmasks, id);
 364     const File::Offset offset = file->currentOffset();
 365     bool bitmaskWithSig = bitmaskWithSignature(offset);
 366     if (!sig || bitmaskWithSig) {
 367         if (!sig) {
 368             sig = new BitmaskSig;
 369             sig->id = id;
 370             sig->num_flags = read_uint();
 371             BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
 372             for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
 373                 it->name = read_string();
 374                 it->value = read_uint();
 375                 if (it->value == 0 && it != flags) {
 376                     std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
 377                 }
 378             }
 379             sig->flags = flags;
 380             bitmasks[id] = sig;
 381             m_bitmaskSigOffsets.insert(offset);
 382         } else {
 383             int num_flags = read_uint();
 384             for (int i = 0; i < num_flags; ++i) {
 385                 skip_string(); /*name */
 386                 skip_uint(); /* value */
 387             }
 388         }
 389     }
 390     assert(sig);
 391
 392     unsigned long long value = read_uint();
 393
 394     return new Bitmask(sig, value);
 395 }
 396
 397
 398 Value *Parser::parse_array(void) {
 399     size_t len = read_uint();
 400     Array *array = new Array(len);
 401     for (size_t i = 0; i < len; ++i) {
 402         array->values[i] = parse_value();
 403     }
 404     return array;
 405 }
 406
 407
 408 Value *Parser::parse_blob(void) {
 409     size_t size = read_uint();
 410     Blob *blob = new Blob(size);
 411     if (size) {
 412         file->read(blob->buf, (unsigned)size);
 413     }
 414     return blob;
 415 }
 416
 417
 418 Value *Parser::parse_struct() {
 419     size_t id = read_uint();
 420
 421     StructSig *sig = lookup(structs, id);
 422     const File::Offset offset = file->currentOffset();
 423     bool structWithSig = structWithSignature(offset);
 424     if (!sig || structWithSig) {
 425         if (!sig) {
 426             sig = new StructSig;
 427             sig->id = id;
 428             sig->name = read_string();
 429             sig->num_members = read_uint();
 430             const char **member_names = new const char *[sig->num_members];
 431             for (unsigned i = 0; i < sig->num_members; ++i) {
 432                 member_names[i] = read_string();
 433             }
 434             sig->member_names = member_names;
 435             structs[id] = sig;
 436             m_structSigOffsets.insert(offset);
 437         } else {
 438             skip_string(); /* name */
 439             unsigned num_members = read_uint();
 440             for (unsigned i = 0; i < num_members; ++i) {
 441                 skip_string(); /* member_name */
 442             }
 443         }
 444     }
 445     assert(sig);
 446
 447     Struct *value = new Struct(sig);
 448
 449     for (size_t i = 0; i < sig->num_members; ++i) {
 450         value->members[i] = parse_value();
 451     }
 452
 453     return value;
 454 }
 455
 456
 457 Value *Parser::parse_opaque() {
 458     unsigned long long addr;
 459     addr = read_uint();
 460     return new Pointer(addr);
 461 }
 462
 463
 464 const char * Parser::read_string(void) {
 465     size_t len = read_uint();
 466     char * value = new char[len + 1];
 467     if (len) {
 468         file->read(value, (unsigned)len);
 469     }
 470     value[len] = 0;
 471 #if TRACE_VERBOSE
 472     std::cerr << "\tSTRING \"" << value << "\"\n";
 473 #endif
 474     return value;
 475 }
 476
 477
 478 unsigned long long Parser::read_uint(void) {
 479     unsigned long long value = 0;
 480     int c;
 481     unsigned shift = 0;
 482     do {
 483         c = file->getc();
 484         if (c == -1) {
 485             break;
 486         }
 487         value |= (unsigned long long)(c & 0x7f) << shift;
 488         shift += 7;
 489     } while(c & 0x80);
 490 #if TRACE_VERBOSE
 491     std::cerr << "\tUINT " << value << "\n";
 492 #endif
 493     return value;
 494 }
 495
 496
 497 inline int Parser::read_byte(void) {
 498     int c = file->getc();
 499 #if TRACE_VERBOSE
 500     if (c < 0)
 501         std::cerr << "\tEOF" << "\n";
 502     else
 503         std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
 504 #endif
 505     return c;
 506 }
 507
 508
 509 inline bool Parser::callWithSignature(const File::Offset &offset) const
 510 {
 511     return m_callSigOffsets.find(offset) != m_callSigOffsets.end();
 512 }
 513
 514 inline bool Parser::structWithSignature(const File::Offset &offset) const
 515 {
 516     return m_structSigOffsets.find(offset) != m_structSigOffsets.end();
 517 }
 518
 519 inline bool Parser::enumWithSignature(const File::Offset &offset) const
 520 {
 521     return m_enumSigOffsets.find(offset) != m_enumSigOffsets.end();
 522 }
 523
 524 inline bool Parser::bitmaskWithSignature(const File::Offset &offset) const
 525 {
 526     return m_bitmaskSigOffsets.find(offset) != m_bitmaskSigOffsets.end();
 527 }
 528
 529 Call * Parser::scan_call()
 530 {
 531     do {
 532         int c = read_byte();
 533         switch(c) {
 534         case Trace::EVENT_ENTER:
 535             scan_enter();
 536             break;
 537         case Trace::EVENT_LEAVE:
 538             return scan_leave();
 539         default:
 540             std::cerr << "error: unknown event " << c << "\n";
 541             exit(1);
 542         case -1:
 543             for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 544                 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
 545                 std::cerr << **it << "\n";
 546             }
 547             return NULL;
 548         }
 549     } while (true);
 550 }
 551
 552 void Parser::scan_enter(void) {
 553     size_t id = read_uint();
 554
 555     FunctionSig *sig = lookup(functions, id);
 556     const File::Offset offset = file->currentOffset();
 557     if (!sig) {
 558         sig = new FunctionSig;
 559         sig->id = id;
 560         sig->name = read_string();
 561         sig->num_args = read_uint();
 562         const char **arg_names = new const char *[sig->num_args];
 563         for (unsigned i = 0; i < sig->num_args; ++i) {
 564             arg_names[i] = read_string();
 565         }
 566         sig->arg_names = arg_names;
 567         functions[id] = sig;
 568         m_callSigOffsets.insert(offset);
 569     }
 570     assert(sig);
 571
 572     Call *call = new Call(sig);
 573     call->no = next_call_no++;
 574
 575     if (scan_call_details(call)) {
 576         calls.push_back(call);
 577     } else {
 578         delete call;
 579     }
 580 }
 581
 582 Call *Parser::scan_leave(void) {
 583     unsigned call_no = read_uint();
 584     Call *call = NULL;
 585     for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 586         if ((*it)->no == call_no) {
 587             call = *it;
 588             calls.erase(it);
 589             break;
 590         }
 591     }
 592     if (!call) {
 593         return NULL;
 594     }
 595
 596     if (scan_call_details(call)) {
 597         return call;
 598     } else {
 599         delete call;
 600         return NULL;
 601     }
 602 }
 603
 604 bool Parser::scan_call_details(Call *call) {
 605     do {
 606         int c = read_byte();
 607         switch(c) {
 608         case Trace::CALL_END:
 609             return true;
 610         case Trace::CALL_ARG:
 611             scan_arg(call);
 612             break;
 613         case Trace::CALL_RET:
 614             scan_value();
 615             break;
 616         default:
 617             std::cerr << "error: ("<<call->name()<< ") unknown call detail "
 618                       << c << "\n";
 619             exit(1);
 620         case -1:
 621             return false;
 622         }
 623     } while(true);
 624 }
 625
 626 void Parser::scan_arg(Call *call) {
 627     skip_uint(); /* index */
 628     scan_value(); /* value */
 629 }
 630
 631
 632 void Parser::scan_value(void) {
 633     int c = read_byte();
 634     switch(c) {
 635     case Trace::TYPE_NULL:
 636     case Trace::TYPE_FALSE:
 637     case Trace::TYPE_TRUE:
 638         break;
 639     case Trace::TYPE_SINT:
 640         scan_sint();
 641         break;
 642     case Trace::TYPE_UINT:
 643         scan_uint();
 644         break;
 645     case Trace::TYPE_FLOAT:
 646         scan_float();
 647         break;
 648     case Trace::TYPE_DOUBLE:
 649         scan_double();
 650         break;
 651     case Trace::TYPE_STRING:
 652         scan_string();
 653         break;
 654     case Trace::TYPE_ENUM:
 655         scan_enum();
 656         break;
 657     case Trace::TYPE_BITMASK:
 658         scan_bitmask();
 659         break;
 660     case Trace::TYPE_ARRAY:
 661         scan_array();
 662         break;
 663     case Trace::TYPE_STRUCT:
 664         scan_struct();
 665         break;
 666     case Trace::TYPE_BLOB:
 667         scan_blob();
 668         break;
 669     case Trace::TYPE_OPAQUE:
 670         scan_opaque();
 671         break;
 672     default:
 673         std::cerr << "error: unknown type " << c << "\n";
 674         exit(1);
 675     case -1:
 676         break;
 677     }
 678 }
 679
 680
 681 void Parser::scan_sint() {
 682     skip_uint();
 683 }
 684
 685
 686 void Parser::scan_uint() {
 687     skip_uint();
 688 }
 689
 690
 691 void Parser::scan_float() {
 692     file->skip(sizeof(float));
 693 }
 694
 695
 696 void Parser::scan_double() {
 697     file->skip(sizeof(double));
 698 }
 699
 700
 701 void Parser::scan_string() {
 702     skip_string();
 703 }
 704
 705
 706 void Parser::scan_enum() {
 707     size_t id = read_uint();
 708     EnumSig *sig = lookup(enums, id);
 709     const File::Offset offset = file->currentOffset();
 710     if (!sig) {
 711         sig = new EnumSig;
 712         sig->id = id;
 713         sig->name = read_string();
 714         Value *value = parse_value();
 715         sig->value = value->toSInt();
 716         delete value;
 717         enums[id] = sig;
 718         m_enumSigOffsets.insert(offset);
 719     }
 720     assert(sig);
 721 }
 722
 723
 724 void Parser::scan_bitmask() {
 725     size_t id = read_uint();
 726     BitmaskSig *sig = lookup(bitmasks, id);
 727     const File::Offset offset = file->currentOffset();
 728     if (!sig) {
 729         sig = new BitmaskSig;
 730         sig->id = id;
 731         sig->num_flags = read_uint();
 732         BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
 733         for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
 734             it->name = read_string();
 735             it->value = read_uint();
 736             if (it->value == 0 && it != flags) {
 737                 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
 738             }
 739         }
 740         sig->flags = flags;
 741         bitmasks[id] = sig;
 742         m_bitmaskSigOffsets.insert(offset);
 743     }
 744     assert(sig);
 745
 746     skip_uint(); /* value */
 747 }
 748
 749
 750 void Parser::scan_array(void) {
 751     size_t len = read_uint();
 752     for (size_t i = 0; i < len; ++i) {
 753         scan_value();
 754     }
 755 }
 756
 757
 758 void Parser::scan_blob(void) {
 759     size_t size = read_uint();
 760     if (size) {
 761         file->skip((unsigned)size);
 762     }
 763 }
 764
 765
 766 void Parser::scan_struct() {
 767     size_t id = read_uint();
 768
 769     StructSig *sig = lookup(structs, id);
 770     const File::Offset offset = file->currentOffset();
 771     if (!sig) {
 772         sig = new StructSig;
 773         sig->id = id;
 774         sig->name = read_string();
 775         sig->num_members = read_uint();
 776         const char **member_names = new const char *[sig->num_members];
 777         for (unsigned i = 0; i < sig->num_members; ++i) {
 778             member_names[i] = read_string();
 779         }
 780         sig->member_names = member_names;
 781         structs[id] = sig;
 782         m_structSigOffsets.insert(offset);
 783     }
 784     assert(sig);
 785
 786     for (size_t i = 0; i < sig->num_members; ++i) {
 787         scan_value();
 788     }
 789 }
 790
 791
 792 void Parser::scan_opaque() {
 793     skip_uint();
 794 }
 795
 796
 797 void Parser::skip_string(void) {
 798     size_t len = read_uint();
 799     file->skip((unsigned)len);
 800 }
 801
 802
 803 void Parser::skip_uint(void) {
 804     int c;
 805     do {
 806         c = file->getc();
 807         if (c == -1) {
 808             break;
 809         }
 810     } while(c & 0x80);
 811 }
 812
 813
 814 inline void Parser::skip_byte(void) {
 815     file->skip(1);
 816 }
 817
 818
 819 } /* namespace Trace */