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