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