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