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(const Container &c)
  88 {
  89     deleteAll(c.begin(), c.end());
  90 }
  91
  92 void Parser::close(void) {
  93     if (file) {
  94         file->close();
  95         delete file;
  96         file = NULL;
  97     }
  98
  99     deleteAll(calls);
 100     deleteAll(functions);
 101     deleteAll(structs);
 102     deleteAll(enums);
 103     deleteAll(bitmasks);
 104 }
 105
 106
 107 Call *Parser::parse_call(void) {
 108     do {
 109         int c = read_byte();
 110         switch(c) {
 111         case Trace::EVENT_ENTER:
 112             parse_enter();
 113             break;
 114         case Trace::EVENT_LEAVE:
 115             return parse_leave();
 116         default:
 117             std::cerr << "error: unknown event " << c << "\n";
 118             exit(1);
 119         case -1:
 120             for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 121                 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
 122                 std::cerr << **it << "\n";
 123             }
 124             return NULL;
 125         }
 126     } while(true);
 127 }
 128
 129
 130 /**
 131  * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
 132  */
 133 template<class T>
 134 T *lookup(std::vector<T *> &map, size_t index) {
 135     if (index >= map.size()) {
 136         map.resize(index + 1);
 137         return NULL;
 138     } else {
 139         return map[index];
 140     }
 141 }
 142
 143
 144 void Parser::parse_enter(void) {
 145     size_t id = read_uint();
 146
 147     FunctionSig *sig = lookup(functions, id);
 148     if (!sig) {
 149         sig = new FunctionSig;
 150         sig->id = id;
 151         sig->name = read_string();
 152         sig->num_args = read_uint();
 153         const char **arg_names = new const char *[sig->num_args];
 154         for (unsigned i = 0; i < sig->num_args; ++i) {
 155             arg_names[i] = read_string();
 156         }
 157         sig->arg_names = arg_names;
 158         functions[id] = sig;
 159     }
 160     assert(sig);
 161
 162     Call *call = new Call(sig);
 163     call->no = next_call_no++;
 164
 165     if (parse_call_details(call)) {
 166         calls.push_back(call);
 167     } else {
 168         delete call;
 169     }
 170 }
 171
 172
 173 Call *Parser::parse_leave(void) {
 174     unsigned call_no = read_uint();
 175     Call *call = NULL;
 176     for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
 177         if ((*it)->no == call_no) {
 178             call = *it;
 179             calls.erase(it);
 180             break;
 181         }
 182     }
 183     if (!call) {
 184         return NULL;
 185     }
 186
 187     if (parse_call_details(call)) {
 188         return call;
 189     } else {
 190         delete call;
 191         return NULL;
 192     }
 193 }
 194
 195
 196 bool Parser::parse_call_details(Call *call) {
 197     do {
 198         int c = read_byte();
 199         switch(c) {
 200         case Trace::CALL_END:
 201             return true;
 202         case Trace::CALL_ARG:
 203             parse_arg(call);
 204             break;
 205         case Trace::CALL_RET:
 206             call->ret = parse_value();
 207             break;
 208         default:
 209             std::cerr << "error: ("<<call->name()<< ") unknown call detail "
 210                       << c << "\n";
 211             exit(1);
 212         case -1:
 213             return false;
 214         }
 215     } while(true);
 216 }
 217
 218
 219 void Parser::parse_arg(Call *call) {
 220     unsigned index = read_uint();
 221     Value *value = parse_value();
 222     if (index >= call->args.size()) {
 223         call->args.resize(index + 1);
 224     }
 225     call->args[index] = value;
 226 }
 227
 228
 229 Value *Parser::parse_value(void) {
 230     int c;
 231     Value *value;
 232     c = read_byte();
 233     switch(c) {
 234     case Trace::TYPE_NULL:
 235         value = new Null;
 236         break;
 237     case Trace::TYPE_FALSE:
 238         value = new Bool(false);
 239         break;
 240     case Trace::TYPE_TRUE:
 241         value = new Bool(true);
 242         break;
 243     case Trace::TYPE_SINT:
 244         value = parse_sint();
 245         break;
 246     case Trace::TYPE_UINT:
 247         value = parse_uint();
 248         break;
 249     case Trace::TYPE_FLOAT:
 250         value = parse_float();
 251         break;
 252     case Trace::TYPE_DOUBLE:
 253         value = parse_double();
 254         break;
 255     case Trace::TYPE_STRING:
 256         value = parse_string();
 257         break;
 258     case Trace::TYPE_ENUM:
 259         value = parse_enum();
 260         break;
 261     case Trace::TYPE_BITMASK:
 262         value = parse_bitmask();
 263         break;
 264     case Trace::TYPE_ARRAY:
 265         value = parse_array();
 266         break;
 267     case Trace::TYPE_STRUCT:
 268         value = parse_struct();
 269         break;
 270     case Trace::TYPE_BLOB:
 271         value = parse_blob();
 272         break;
 273     case Trace::TYPE_OPAQUE:
 274         value = parse_opaque();
 275         break;
 276     default:
 277         std::cerr << "error: unknown type " << c << "\n";
 278         exit(1);
 279     case -1:
 280         value = NULL;
 281         break;
 282     }
 283 #if TRACE_VERBOSE
 284     if (value) {
 285         std::cerr << "\tVALUE " << value << "\n";
 286     }
 287 #endif
 288     return value;
 289 }
 290
 291
 292 Value *Parser::parse_sint() {
 293     return new SInt(-(signed long long)read_uint());
 294 }
 295
 296
 297 Value *Parser::parse_uint() {
 298     return new UInt(read_uint());
 299 }
 300
 301
 302 Value *Parser::parse_float() {
 303     float value;
 304     file->read(&value, sizeof value);
 305     return new Float(value);
 306 }
 307
 308
 309 Value *Parser::parse_double() {
 310     double value;
 311     file->read(&value, sizeof value);
 312     return new Float(value);
 313 }
 314
 315
 316 Value *Parser::parse_string() {
 317     return new String(read_string());
 318 }
 319
 320
 321 Value *Parser::parse_enum() {
 322     size_t id = read_uint();
 323     EnumSig *sig = lookup(enums, id);
 324     if (!sig) {
 325         sig = new EnumSig;
 326         sig->id = id;
 327         sig->name = read_string();
 328         Value *value = parse_value();
 329         sig->value = value->toSInt();
 330         delete value;
 331         enums[id] = sig;
 332     }
 333     assert(sig);
 334     return new Enum(sig);
 335 }
 336
 337
 338 Value *Parser::parse_bitmask() {
 339     size_t id = read_uint();
 340     BitmaskSig *sig = lookup(bitmasks, id);
 341     if (!sig) {
 342         sig = new BitmaskSig;
 343         sig->id = id;
 344         sig->num_flags = read_uint();
 345         BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
 346         for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
 347             it->name = read_string();
 348             it->value = read_uint();
 349             if (it->value == 0 && it != flags) {
 350                 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
 351             }
 352         }
 353         sig->flags = flags;
 354         bitmasks[id] = sig;
 355     }
 356     assert(sig);
 357
 358     unsigned long long value = read_uint();
 359
 360     return new Bitmask(sig, value);
 361 }
 362
 363
 364 Value *Parser::parse_array(void) {
 365     size_t len = read_uint();
 366     Array *array = new Array(len);
 367     for (size_t i = 0; i < len; ++i) {
 368         array->values[i] = parse_value();
 369     }
 370     return array;
 371 }
 372
 373
 374 Value *Parser::parse_blob(void) {
 375     size_t size = read_uint();
 376     Blob *blob = new Blob(size);
 377     if (size) {
 378         file->read(blob->buf, (unsigned)size);
 379     }
 380     return blob;
 381 }
 382
 383
 384 Value *Parser::parse_struct() {
 385     size_t id = read_uint();
 386
 387     StructSig *sig = lookup(structs, id);
 388     if (!sig) {
 389         sig = new StructSig;
 390         sig->id = id;
 391         sig->name = read_string();
 392         sig->num_members = read_uint();
 393         const char **member_names = new const char *[sig->num_members];
 394         for (unsigned i = 0; i < sig->num_members; ++i) {
 395             member_names[i] = read_string();
 396         }
 397         sig->member_names = member_names;
 398         structs[id] = sig;
 399     }
 400     assert(sig);
 401
 402     Struct *value = new Struct(sig);
 403
 404     for (size_t i = 0; i < sig->num_members; ++i) {
 405         value->members[i] = parse_value();
 406     }
 407
 408     return value;
 409 }
 410
 411
 412 Value *Parser::parse_opaque() {
 413     unsigned long long addr;
 414     addr = read_uint();
 415     return new Pointer(addr);
 416 }
 417
 418
 419 const char * Parser::read_string(void) {
 420     size_t len = read_uint();
 421     char * value = new char[len + 1];
 422     if (len) {
 423         file->read(value, (unsigned)len);
 424     }
 425     value[len] = 0;
 426 #if TRACE_VERBOSE
 427     std::cerr << "\tSTRING \"" << value << "\"\n";
 428 #endif
 429     return value;
 430 }
 431
 432
 433 unsigned long long Parser::read_uint(void) {
 434     unsigned long long value = 0;
 435     int c;
 436     unsigned shift = 0;
 437     do {
 438         c = file->getc();
 439         if (c == -1) {
 440             break;
 441         }
 442         value |= (unsigned long long)(c & 0x7f) << shift;
 443         shift += 7;
 444     } while(c & 0x80);
 445 #if TRACE_VERBOSE
 446     std::cerr << "\tUINT " << value << "\n";
 447 #endif
 448     return value;
 449 }
 450
 451
 452 inline int Parser::read_byte(void) {
 453     int c = file->getc();
 454 #if TRACE_VERBOSE
 455     if (c < 0)
 456         std::cerr << "\tEOF" << "\n";
 457     else
 458         std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
 459 #endif
 460     return c;
 461 }
 462
 463
 464 } /* namespace Trace */