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