1 /**************************************************************************
3 * Copyright 2010 VMware, Inc.
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 **************************************************************************/
27 * Object hierarchy for describing the traces in memory.
30 #ifndef _TRACE_MODEL_HPP_
31 #define _TRACE_MODEL_HPP_
51 const char **arg_names;
59 const char **member_names;
66 signed long long value;
72 unsigned long long value;
79 const BitmaskFlag *flags;
90 virtual void visit(Visitor &visitor) = 0;
92 virtual bool toBool(void) const = 0;
93 virtual signed long long toSInt(void) const;
94 virtual unsigned long long toUInt(void) const;
95 virtual float toFloat(void) const;
96 virtual double toDouble(void) const;
98 virtual void *toPointer(void) const;
99 virtual void *toPointer(bool bind);
100 virtual unsigned long long toUIntPtr(void) const;
101 virtual const char *toString(void) const;
103 const Value & operator[](size_t index) const;
105 void dump(std::ostream &os, bool color=true);
109 class Null : public Value
112 bool toBool(void) const;
113 signed long long toSInt(void) const;
114 unsigned long long toUInt(void) const;
115 virtual float toFloat(void) const;
116 virtual double toDouble(void) const;
117 void *toPointer(void) const;
118 void *toPointer(bool bind);
119 unsigned long long toUIntPtr(void) const;
120 const char *toString(void) const;
121 void visit(Visitor &visitor);
125 class Bool : public Value
128 Bool(bool _value) : value(_value) {}
130 bool toBool(void) const;
131 signed long long toSInt(void) const;
132 unsigned long long toUInt(void) const;
133 virtual float toFloat(void) const;
134 virtual double toDouble(void) const;
135 void visit(Visitor &visitor);
141 class SInt : public Value
144 SInt(signed long long _value) : value(_value) {}
146 bool toBool(void) const;
147 signed long long toSInt(void) const;
148 unsigned long long toUInt(void) const;
149 virtual float toFloat(void) const;
150 virtual double toDouble(void) const;
151 void visit(Visitor &visitor);
153 signed long long value;
157 class UInt : public Value
160 UInt(unsigned long long _value) : value(_value) {}
162 bool toBool(void) const;
163 signed long long toSInt(void) const;
164 unsigned long long toUInt(void) const;
165 virtual float toFloat(void) const;
166 virtual double toDouble(void) const;
167 void visit(Visitor &visitor);
169 unsigned long long value;
173 class Float : public Value
176 Float(float _value) : value(_value) {}
178 bool toBool(void) const;
179 signed long long toSInt(void) const;
180 unsigned long long toUInt(void) const;
181 virtual float toFloat(void) const;
182 virtual double toDouble(void) const;
183 void visit(Visitor &visitor);
189 class Double : public Value
192 Double(double _value) : value(_value) {}
194 bool toBool(void) const;
195 signed long long toSInt(void) const;
196 unsigned long long toUInt(void) const;
197 virtual float toFloat(void) const;
198 virtual double toDouble(void) const;
199 void visit(Visitor &visitor);
205 class String : public Value
208 String(const char * _value) : value(_value) {}
211 bool toBool(void) const;
212 const char *toString(void) const;
213 void visit(Visitor &visitor);
219 class Enum : public Value
222 Enum(const EnumSig *_sig) : sig(_sig) {}
224 bool toBool(void) const;
225 signed long long toSInt(void) const;
226 unsigned long long toUInt(void) const;
227 virtual float toFloat(void) const;
228 virtual double toDouble(void) const;
229 void visit(Visitor &visitor);
235 class Bitmask : public UInt
238 Bitmask(const BitmaskSig *_sig, unsigned long long _value) : UInt(_value), sig(_sig) {}
240 void visit(Visitor &visitor);
242 const BitmaskSig *sig;
246 class Struct : public Value
249 Struct(StructSig *_sig) : sig(_sig), members(_sig->num_members) { }
252 bool toBool(void) const;
253 void visit(Visitor &visitor);
255 const StructSig *sig;
256 std::vector<Value *> members;
260 class Array : public Value
263 Array(size_t len) : values(len) {}
266 bool toBool(void) const;
267 void visit(Visitor &visitor);
269 std::vector<Value *> values;
273 class Blob : public Value
278 buf = new char[_size];
284 bool toBool(void) const;
285 void *toPointer(void) const;
286 void *toPointer(bool bind);
287 void visit(Visitor &visitor);
295 class Pointer : public UInt
298 Pointer(unsigned long long value) : UInt(value) {}
300 bool toBool(void) const;
301 void *toPointer(void) const;
302 void *toPointer(bool bind);
303 unsigned long long toUIntPtr(void) const;
304 void visit(Visitor &visitor);
311 virtual void visit(Null *);
312 virtual void visit(Bool *);
313 virtual void visit(SInt *);
314 virtual void visit(UInt *);
315 virtual void visit(Float *);
316 virtual void visit(Double *);
317 virtual void visit(String *);
318 virtual void visit(Enum *);
319 virtual void visit(Bitmask *);
320 virtual void visit(Struct *);
321 virtual void visit(Array *);
322 virtual void visit(Blob *);
323 virtual void visit(Pointer *);
326 inline void _visit(Value *value) {
334 inline std::ostream & operator <<(std::ostream &os, Value *value) {
342 typedef unsigned CallFlags;
347 * TODO: It might be better to to record some of these (but not all) into the
353 * Whether a call was really done by the application or not.
355 * This flag is set for fake calls -- calls not truly done by the application
356 * but emitted and recorded for completeness, to provide contextual information
357 * necessary for retracing, that would not be available through other ways.
359 * XXX: This one definetely needs to go into the trace file.
361 CALL_FLAG_FAKE = (1 << 0),
364 * Whether this call should be retraced or ignored.
366 * This flag is set for calls which can't be safely replayed (due to incomplete
367 * information) or that have no sideffects.
369 * Some incomplete calls are unreproduceable, but not all.
371 CALL_FLAG_NON_REPRODUCIBLE = (1 << 1),
374 * Whether this call has no side-effects, therefore don't need to be
377 * This flag is set for calls that merely query information which is not
378 * needed for posterior calls.
380 CALL_FLAG_NO_SIDE_EFFECTS = (1 << 2),
383 * Whether this call renders into the bound rendertargets.
385 CALL_FLAG_RENDER = (1 << 3),
388 * Whether this call causes render target to be swapped.
390 * This does not mark frame termination by itself -- that's solely the
391 * responsibility of `endOfFrame` bit.
393 * This mean that snapshots should be take prior to the call, and not
396 CALL_FLAG_SWAP_RENDERTARGET = (1 << 4),
399 * Whether this call terminates a frame.
401 * XXX: This can't always be determined by the function name, so it should also
402 * go into the trace file eventually.
404 CALL_FLAG_END_FRAME = (1 << 5),
407 * Whether this call is incomplete, i.e., it never returned.
409 CALL_FLAG_INCOMPLETE = (1 << 6),
412 * Whether this call is verbose (i.e., not usually interesting).
414 CALL_FLAG_VERBOSE = (1 << 7),
423 const FunctionSig *sig;
424 std::vector<Value *> args;
429 Call(FunctionSig *_sig, const CallFlags &_flags) :
431 args(_sig->num_args),
438 inline const char * name(void) const {
442 inline Value & arg(unsigned index) {
443 assert(index < args.size());
444 return *(args[index]);
447 void dump(std::ostream &os, bool color=true);
451 inline std::ostream & operator <<(std::ostream &os, Call &call) {
457 } /* namespace trace */
459 #endif /* _TRACE_MODEL_HPP_ */