git.cworth.org Git - apitrace/blob - common/trace_model.cpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2010 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26
  27 #include "formatter.hpp"
  28 #include "trace_model.hpp"
  29
  30
  31 namespace trace {
  32
  33
  34 Call::~Call() {
  35     for (unsigned i = 0; i < args.size(); ++i) {
  36         delete args[i];
  37     }
  38
  39     if (ret) {
  40         delete ret;
  41     }
  42 }
  43
  44
  45 String::~String() {
  46     delete [] value;
  47 }
  48
  49
  50 Struct::~Struct() {
  51     for (std::vector<Value *>::iterator it = members.begin(); it != members.end(); ++it) {
  52         delete *it;
  53     }
  54 }
  55
  56
  57 Array::~Array() {
  58     for (std::vector<Value *>::iterator it = values.begin(); it != values.end(); ++it) {
  59         delete *it;
  60     }
  61 }
  62
  63 Blob::~Blob() {
  64     // Blobs are often bound and referred during many calls, so we can't delete
  65     // them here in that case.
  66     //
  67     // Once bound there is no way to know when they were unbound, which
  68     // effectively means we have to leak them.  A better solution would be to
  69     // keep a list of bound pointers, and defer the destruction to when the
  70     // trace in question has been fully processed.
  71     if (!bound) {
  72         delete [] buf;
  73     }
  74 }
  75
  76
  77 // bool cast
  78 bool Null   ::toBool(void) const { return false; }
  79 bool Bool   ::toBool(void) const { return value; }
  80 bool SInt   ::toBool(void) const { return value != 0; }
  81 bool UInt   ::toBool(void) const { return value != 0; }
  82 bool Float  ::toBool(void) const { return value != 0; }
  83 bool String ::toBool(void) const { return true; }
  84 bool Enum   ::toBool(void) const { return sig->value != 0; }
  85 bool Struct ::toBool(void) const { return true; }
  86 bool Array  ::toBool(void) const { return true; }
  87 bool Blob   ::toBool(void) const { return true; }
  88 bool Pointer::toBool(void) const { return value != 0; }
  89
  90
  91 // signed integer cast
  92 signed long long Value  ::toSInt(void) const { assert(0); return 0; }
  93 signed long long Null   ::toSInt(void) const { return 0; }
  94 signed long long Bool   ::toSInt(void) const { return static_cast<signed long long>(value); }
  95 signed long long SInt   ::toSInt(void) const { return value; }
  96 signed long long UInt   ::toSInt(void) const { assert(static_cast<signed long long>(value) >= 0); return static_cast<signed long long>(value); }
  97 signed long long Float  ::toSInt(void) const { return static_cast<signed long long>(value); }
  98 signed long long Enum   ::toSInt(void) const { return sig->value; }
  99
 100
 101 // unsigned integer cast
 102 unsigned long long Value  ::toUInt(void) const { assert(0); return 0; }
 103 unsigned long long Null   ::toUInt(void) const { return 0; }
 104 unsigned long long Bool   ::toUInt(void) const { return static_cast<unsigned long long>(value); }
 105 unsigned long long SInt   ::toUInt(void) const { assert(value >= 0); return static_cast<signed long long>(value); }
 106 unsigned long long UInt   ::toUInt(void) const { return value; }
 107 unsigned long long Float  ::toUInt(void) const { return static_cast<unsigned long long>(value); }
 108 unsigned long long Enum   ::toUInt(void) const { assert(sig->value >= 0); return sig->value; }
 109
 110
 111 // floating point cast
 112 float Value  ::toFloat(void) const { assert(0); return 0; }
 113 float Null   ::toFloat(void) const { return 0; }
 114 float Bool   ::toFloat(void) const { return static_cast<float>(value); }
 115 float SInt   ::toFloat(void) const { return static_cast<float>(value); }
 116 float UInt   ::toFloat(void) const { return static_cast<float>(value); }
 117 float Float  ::toFloat(void) const { return value; }
 118 float Enum   ::toFloat(void) const { return static_cast<float>(sig->value); }
 119
 120
 121 // floating point cast
 122 double Value  ::toDouble(void) const { assert(0); return 0; }
 123 double Null   ::toDouble(void) const { return 0; }
 124 double Bool   ::toDouble(void) const { return static_cast<double>(value); }
 125 double SInt   ::toDouble(void) const { return static_cast<double>(value); }
 126 double UInt   ::toDouble(void) const { return static_cast<double>(value); }
 127 double Float  ::toDouble(void) const { return value; }
 128 double Enum   ::toDouble(void) const { return static_cast<double>(sig->value); }
 129
 130
 131 // pointer cast
 132 void * Value  ::toPointer(void) const { assert(0); return NULL; }
 133 void * Null   ::toPointer(void) const { return NULL; }
 134 void * Blob   ::toPointer(void) const { return buf; }
 135 void * Pointer::toPointer(void) const { return (void *)value; }
 136
 137 void * Value  ::toPointer(bool bind) { assert(0); return NULL; }
 138 void * Null   ::toPointer(bool bind) { return NULL; }
 139 void * Blob   ::toPointer(bool bind) { if (bind) bound = true; return buf; }
 140 void * Pointer::toPointer(bool bind) { return (void *)value; }
 141
 142
 143 // pointer cast
 144 unsigned long long Value  ::toUIntPtr(void) const { assert(0); return 0; }
 145 unsigned long long Null   ::toUIntPtr(void) const { return 0; }
 146 unsigned long long Pointer::toUIntPtr(void) const { return value; }
 147
 148
 149 // string cast
 150 const char * Value ::toString(void) const { assert(0); return NULL; }
 151 const char * Null  ::toString(void) const { return NULL; }
 152 const char * String::toString(void) const { return value; }
 153
 154
 155 // virtual Value::visit()
 156 void Null   ::visit(Visitor &visitor) { visitor.visit(this); }
 157 void Bool   ::visit(Visitor &visitor) { visitor.visit(this); }
 158 void SInt   ::visit(Visitor &visitor) { visitor.visit(this); }
 159 void UInt   ::visit(Visitor &visitor) { visitor.visit(this); }
 160 void Float  ::visit(Visitor &visitor) { visitor.visit(this); }
 161 void String ::visit(Visitor &visitor) { visitor.visit(this); }
 162 void Enum   ::visit(Visitor &visitor) { visitor.visit(this); }
 163 void Bitmask::visit(Visitor &visitor) { visitor.visit(this); }
 164 void Struct ::visit(Visitor &visitor) { visitor.visit(this); }
 165 void Array  ::visit(Visitor &visitor) { visitor.visit(this); }
 166 void Blob   ::visit(Visitor &visitor) { visitor.visit(this); }
 167 void Pointer::visit(Visitor &visitor) { visitor.visit(this); }
 168
 169
 170 void Visitor::visit(Null *) { assert(0); }
 171 void Visitor::visit(Bool *) { assert(0); }
 172 void Visitor::visit(SInt *) { assert(0); }
 173 void Visitor::visit(UInt *) { assert(0); }
 174 void Visitor::visit(Float *) { assert(0); }
 175 void Visitor::visit(String *) { assert(0); }
 176 void Visitor::visit(Enum *node) { assert(0); }
 177 void Visitor::visit(Bitmask *node) { visit(static_cast<UInt *>(node)); }
 178 void Visitor::visit(Struct *) { assert(0); }
 179 void Visitor::visit(Array *) { assert(0); }
 180 void Visitor::visit(Blob *) { assert(0); }
 181 void Visitor::visit(Pointer *) { assert(0); }
 182
 183
 184 class Dumper : public Visitor
 185 {
 186 protected:
 187     std::ostream &os;
 188     formatter::Formatter *formatter;
 189     formatter::Attribute *normal;
 190     formatter::Attribute *bold;
 191     formatter::Attribute *italic;
 192     formatter::Attribute *red;
 193     formatter::Attribute *pointer;
 194     formatter::Attribute *literal;
 195
 196 public:
 197     Dumper(std::ostream &_os, bool color) : os(_os) {
 198         formatter = formatter::defaultFormatter(color);
 199         normal = formatter->normal();
 200         bold = formatter->bold();
 201         italic = formatter->italic();
 202         red = formatter->color(formatter::RED);
 203         pointer = formatter->color(formatter::GREEN);
 204         literal = formatter->color(formatter::BLUE);
 205     }
 206
 207     ~Dumper() {
 208         delete normal;
 209         delete bold;
 210         delete italic;
 211         delete red;
 212         delete pointer;
 213         delete literal;
 214         delete formatter;
 215     }
 216
 217     void visit(Null *) {
 218         os << "NULL";
 219     }
 220
 221     void visit(Bool *node) {
 222         os << literal << (node->value ? "true" : "false") << normal;
 223     }
 224
 225     void visit(SInt *node) {
 226         os << literal << node->value << normal;
 227     }
 228
 229     void visit(UInt *node) {
 230         os << literal << node->value << normal;
 231     }
 232
 233     void visit(Float *node) {
 234         os << literal << node->value << normal;
 235     }
 236
 237     void visit(String *node) {
 238         os << literal << "\"";
 239         for (const char *it = node->value; *it; ++it) {
 240             unsigned char c = (unsigned char) *it;
 241             if (c == '\"')
 242                 os << "\\\"";
 243             else if (c == '\\')
 244                 os << "\\\\";
 245             else if (c >= 0x20 && c <= 0x7e)
 246                 os << c;
 247             else if (c == '\t') {
 248                 os << "\t";
 249             } else if (c == '\r') {
 250                 // Ignore carriage-return
 251             } else if (c == '\n') {
 252                 // Reset formatting so that it looks correct with 'less -R'
 253                 os << normal << '\n' << literal;
 254             } else {
 255                 unsigned octal0 = c & 0x7;
 256                 unsigned octal1 = (c >> 3) & 0x7;
 257                 unsigned octal2 = (c >> 3) & 0x7;
 258                 os << "\\";
 259                 if (octal2)
 260                     os << octal2;
 261                 if (octal1)
 262                     os << octal1;
 263                 os << octal0;
 264             }
 265         }
 266         os << "\"" << normal;
 267     }
 268
 269     void visit(Enum *node) {
 270         os << literal << node->sig->name << normal;
 271     }
 272
 273     void visit(Bitmask *bitmask) {
 274         unsigned long long value = bitmask->value;
 275         const BitmaskSig *sig = bitmask->sig;
 276         bool first = true;
 277         for (const BitmaskFlag *it = sig->flags; value != 0 && it != sig->flags + sig->num_flags; ++it) {
 278             if ((it->value && (value & it->value) == it->value) ||
 279                 (!it->value && value == 0)) {
 280                 if (!first) {
 281                     os << " | ";
 282                 }
 283                 os << literal << it->name << normal;
 284                 value &= ~it->value;
 285                 first = false;
 286             }
 287         }
 288         if (value || first) {
 289             if (!first) {
 290                 os << " | ";
 291             }
 292             os << literal << "0x" << std::hex << value << std::dec << normal;
 293         }
 294     }
 295
 296     void visit(Struct *s) {
 297         const char *sep = "";
 298         os << "{";
 299         for (unsigned i = 0; i < s->members.size(); ++i) {
 300             os << sep << italic << s->sig->member_names[i] << normal << " = ";
 301             _visit(s->members[i]);
 302             sep = ", ";
 303         }
 304         os << "}";
 305     }
 306
 307     void visit(Array *array) {
 308         if (array->values.size() == 1) {
 309             os << "&";
 310             _visit(array->values[0]);
 311         }
 312         else {
 313             const char *sep = "";
 314             os << "{";
 315             for (std::vector<Value *>::iterator it = array->values.begin(); it != array->values.end(); ++it) {
 316                 os << sep;
 317                 _visit(*it);
 318                 sep = ", ";
 319             }
 320             os << "}";
 321         }
 322     }
 323
 324     void visit(Blob *blob) {
 325         os << pointer << "blob(" << blob->size << ")" << normal;
 326     }
 327
 328     void visit(Pointer *p) {
 329         os << pointer << "0x" << std::hex << p->value << std::dec << normal;
 330     }
 331
 332     void visit(Call *call) {
 333         const char *sep = "";
 334         os << bold << call->sig->name << normal << "(";
 335         for (unsigned i = 0; i < call->args.size(); ++i) {
 336             os << sep << italic << call->sig->arg_names[i] << normal << " = ";
 337             if (call->args[i]) {
 338                 _visit(call->args[i]);
 339             } else {
 340                os << "?";
 341             }
 342             sep = ", ";
 343         }
 344         os << ")";
 345         if (call->ret) {
 346             os << " = ";
 347             _visit(call->ret);
 348         }
 349         os << "\n";
 350     }
 351 };
 352
 353
 354 void Value::dump(std::ostream &os, bool color) {
 355     Dumper d(os, color);
 356     visit(d);
 357 }
 358
 359
 360 static Null null;
 361
 362 const Value & Value::operator[](size_t index) const {
 363     const Array *array = dynamic_cast<const Array *>(this);
 364     if (array) {
 365         if (index < array->values.size()) {
 366             return *array->values[index];
 367         }
 368     }
 369     return null;
 370 }
 371
 372 void Call::dump(std::ostream &os, bool color) {
 373     Dumper d(os, color);
 374     os << no << " ";
 375     d.visit(this);
 376 }
 377
 378
 379 } /* namespace trace */