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             read_string(); /* name */
 167             int num_args = read_uint();
 168             for (unsigned i = 0; i < num_args; ++i) {
 169                  read_string(); /*arg_name*/
 170             }
 171         }
 172     }
 173     assert(sig);
 174
 175     Call *call = new Call(sig);
 176
 177     if (hasCallBeenParsed(offset)) {
 178         call->no = callNumForOffset(offset);
 179     } else {
 180         call->no = next_call_no++;
 181         m_callNumOffsets.insert(
 182                     std::pair<File::Offset, unsigned>(offset, call->no));
 183     }
 184
 185     if (parse_call_details(call)) {
 186         calls.push_back(call);
 187     } else {
 188         delete call;
 189     }
 190 }
 191
 192
 193 Call *Parser::parse_leave(void) {
 194     unsigned call_no = read_uint();
 195     Call *call = NULL;
 196     for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 197         if ((*it)->no == call_no) {
 198             call = *it;
 199             calls.erase(it);
 200             break;
 201         }
 202     }
 203     if (!call) {
 204         return NULL;
 205     }
 206
 207     if (parse_call_details(call)) {
 208         return call;
 209     } else {
 210         delete call;
 211         return NULL;
 212     }
 213 }
 214
 215
 216 bool Parser::parse_call_details(Call *call) {
 217     do {
 218         int c = read_byte();
 219         switch(c) {
 220         case Trace::CALL_END:
 221             return true;
 222         case Trace::CALL_ARG:
 223             parse_arg(call);
 224             break;
 225         case Trace::CALL_RET:
 226             call->ret = parse_value();
 227             break;
 228         default:
 229             std::cerr << "error: ("<<call->name()<< ") unknown call detail "
 230                       << c << "\n";
 231             exit(1);
 232         case -1:
 233             return false;
 234         }
 235     } while(true);
 236 }
 237
 238
 239 void Parser::parse_arg(Call *call) {
 240     unsigned index = read_uint();
 241     Value *value = parse_value();
 242     if (index >= call->args.size()) {
 243         call->args.resize(index + 1);
 244     }
 245     call->args[index] = value;
 246 }
 247
 248
 249 Value *Parser::parse_value(void) {
 250     int c;
 251     Value *value;
 252     c = read_byte();
 253     switch(c) {
 254     case Trace::TYPE_NULL:
 255         value = new Null;
 256         break;
 257     case Trace::TYPE_FALSE:
 258         value = new Bool(false);
 259         break;
 260     case Trace::TYPE_TRUE:
 261         value = new Bool(true);
 262         break;
 263     case Trace::TYPE_SINT:
 264         value = parse_sint();
 265         break;
 266     case Trace::TYPE_UINT:
 267         value = parse_uint();
 268         break;
 269     case Trace::TYPE_FLOAT:
 270         value = parse_float();
 271         break;
 272     case Trace::TYPE_DOUBLE:
 273         value = parse_double();
 274         break;
 275     case Trace::TYPE_STRING:
 276         value = parse_string();
 277         break;
 278     case Trace::TYPE_ENUM:
 279         value = parse_enum();
 280         break;
 281     case Trace::TYPE_BITMASK:
 282         value = parse_bitmask();
 283         break;
 284     case Trace::TYPE_ARRAY:
 285         value = parse_array();
 286         break;
 287     case Trace::TYPE_STRUCT:
 288         value = parse_struct();
 289         break;
 290     case Trace::TYPE_BLOB:
 291         value = parse_blob();
 292         break;
 293     case Trace::TYPE_OPAQUE:
 294         value = parse_opaque();
 295         break;
 296     default:
 297         std::cerr << "error: unknown type " << c << "\n";
 298         exit(1);
 299     case -1:
 300         value = NULL;
 301         break;
 302     }
 303 #if TRACE_VERBOSE
 304     if (value) {
 305         std::cerr << "\tVALUE " << value << "\n";
 306     }
 307 #endif
 308     return value;
 309 }
 310
 311
 312 Value *Parser::parse_sint() {
 313     return new SInt(-(signed long long)read_uint());
 314 }
 315
 316
 317 Value *Parser::parse_uint() {
 318     return new UInt(read_uint());
 319 }
 320
 321
 322 Value *Parser::parse_float() {
 323     float value;
 324     file->read(&value, sizeof value);
 325     return new Float(value);
 326 }
 327
 328
 329 Value *Parser::parse_double() {
 330     double value;
 331     file->read(&value, sizeof value);
 332     return new Float(value);
 333 }
 334
 335
 336 Value *Parser::parse_string() {
 337     return new String(read_string());
 338 }
 339
 340
 341 Value *Parser::parse_enum() {
 342     size_t id = read_uint();
 343     EnumSig *sig = lookup(enums, id);
 344     const File::Offset offset = file->currentOffset();
 345     bool enumWithSig = enumWithSignature(offset);
 346     if (!sig || enumWithSig) {
 347         if (!sig) {
 348             sig = new EnumSig;
 349             sig->id = id;
 350             sig->name = read_string();
 351             Value *value = parse_value();
 352             sig->value = value->toSInt();
 353             delete value;
 354             enums[id] = sig;
 355             m_enumSigOffsets.insert(offset);
 356         } else {
 357             read_string(); /*name*/
 358             Value *value = parse_value();
 359             delete value;
 360         }
 361     }
 362     assert(sig);
 363     return new Enum(sig);
 364 }
 365
 366
 367 Value *Parser::parse_bitmask() {
 368     size_t id = read_uint();
 369     BitmaskSig *sig = lookup(bitmasks, id);
 370     const File::Offset offset = file->currentOffset();
 371     bool bitmaskWithSig = bitmaskWithSignature(offset);
 372     if (!sig || bitmaskWithSig) {
 373         if (!sig) {
 374             sig = new BitmaskSig;
 375             sig->id = id;
 376             sig->num_flags = read_uint();
 377             BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
 378             for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
 379                 it->name = read_string();
 380                 it->value = read_uint();
 381                 if (it->value == 0 && it != flags) {
 382                     std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
 383                 }
 384             }
 385             sig->flags = flags;
 386             bitmasks[id] = sig;
 387             m_bitmaskSigOffsets.insert(offset);
 388         } else {
 389             int num_flags = read_uint();
 390             for (int i = 0; i < num_flags; ++i) {
 391                 read_string(); /*name */
 392                 read_uint(); /* value */
 393             }
 394         }
 395     }
 396     assert(sig);
 397
 398     unsigned long long value = read_uint();
 399
 400     return new Bitmask(sig, value);
 401 }
 402
 403
 404 Value *Parser::parse_array(void) {
 405     size_t len = read_uint();
 406     Array *array = new Array(len);
 407     for (size_t i = 0; i < len; ++i) {
 408         array->values[i] = parse_value();
 409     }
 410     return array;
 411 }
 412
 413
 414 Value *Parser::parse_blob(void) {
 415     size_t size = read_uint();
 416     Blob *blob = new Blob(size);
 417     if (size) {
 418         file->read(blob->buf, (unsigned)size);
 419     }
 420     return blob;
 421 }
 422
 423
 424 Value *Parser::parse_struct() {
 425     size_t id = read_uint();
 426
 427     StructSig *sig = lookup(structs, id);
 428     const File::Offset offset = file->currentOffset();
 429     bool structWithSig = structWithSignature(offset);
 430     if (!sig || structWithSig) {
 431         if (!sig) {
 432             sig = new StructSig;
 433             sig->id = id;
 434             sig->name = read_string();
 435             sig->num_members = read_uint();
 436             const char **member_names = new const char *[sig->num_members];
 437             for (unsigned i = 0; i < sig->num_members; ++i) {
 438                 member_names[i] = read_string();
 439             }
 440             sig->member_names = member_names;
 441             structs[id] = sig;
 442             m_structSigOffsets.insert(offset);
 443         } else {
 444             read_string(); /* name */
 445             unsigned num_members = read_uint();
 446             for (unsigned i = 0; i < num_members; ++i) {
 447                 read_string(); /* member_name */
 448             }
 449         }
 450     }
 451     assert(sig);
 452
 453     Struct *value = new Struct(sig);
 454
 455     for (size_t i = 0; i < sig->num_members; ++i) {
 456         value->members[i] = parse_value();
 457     }
 458
 459     return value;
 460 }
 461
 462
 463 Value *Parser::parse_opaque() {
 464     unsigned long long addr;
 465     addr = read_uint();
 466     return new Pointer(addr);
 467 }
 468
 469
 470 const char * Parser::read_string(void) {
 471     size_t len = read_uint();
 472     char * value = new char[len + 1];
 473     if (len) {
 474         file->read(value, (unsigned)len);
 475     }
 476     value[len] = 0;
 477 #if TRACE_VERBOSE
 478     std::cerr << "\tSTRING \"" << value << "\"\n";
 479 #endif
 480     return value;
 481 }
 482
 483
 484 unsigned long long Parser::read_uint(void) {
 485     unsigned long long value = 0;
 486     int c;
 487     unsigned shift = 0;
 488     do {
 489         c = file->getc();
 490         if (c == -1) {
 491             break;
 492         }
 493         value |= (unsigned long long)(c & 0x7f) << shift;
 494         shift += 7;
 495     } while(c & 0x80);
 496 #if TRACE_VERBOSE
 497     std::cerr << "\tUINT " << value << "\n";
 498 #endif
 499     return value;
 500 }
 501
 502
 503 inline int Parser::read_byte(void) {
 504     int c = file->getc();
 505 #if TRACE_VERBOSE
 506     if (c < 0)
 507         std::cerr << "\tEOF" << "\n";
 508     else
 509         std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
 510 #endif
 511     return c;
 512 }
 513
 514
 515 inline bool Parser::callWithSignature(const File::Offset &offset) const
 516 {
 517     return m_callSigOffsets.find(offset) != m_callSigOffsets.end();
 518 }
 519
 520 inline bool Parser::structWithSignature(const File::Offset &offset) const
 521 {
 522     return m_structSigOffsets.find(offset) != m_structSigOffsets.end();
 523 }
 524
 525 inline bool Parser::enumWithSignature(const File::Offset &offset) const
 526 {
 527     return m_enumSigOffsets.find(offset) != m_enumSigOffsets.end();
 528 }
 529
 530 inline bool Parser::bitmaskWithSignature(const File::Offset &offset) const
 531 {
 532     return m_bitmaskSigOffsets.find(offset) != m_bitmaskSigOffsets.end();
 533 }
 534
 535 bool Parser::hasCallBeenParsed(const File::Offset &offset) const
 536 {
 537     return m_callNumOffsets.find(offset) != m_callNumOffsets.end();
 538 }
 539
 540 unsigned Parser::callNumForOffset(const File::Offset &offset) const
 541 {
 542     CallNumOffsets::const_iterator itr = m_callNumOffsets.find(offset);
 543     assert(itr != m_callNumOffsets.end());
 544     return itr->second;
 545 }
 546
 547 } /* namespace Trace */