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