1 ##########################################################################
3 # Copyright 2008-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 ##########################################################################/
26 """Common trace code generation."""
32 def interface_wrap_name(interface):
33 return "Wrap" + interface.expr
36 class DumpDeclarator(stdapi.OnceVisitor):
37 '''Declare helper functions to dump complex types.'''
39 def visit_void(self, literal):
42 def visit_literal(self, literal):
45 def visit_string(self, string):
48 def visit_const(self, const):
49 self.visit(const.type)
51 def visit_struct(self, struct):
52 for type, name in struct.members:
54 print 'static void __traceStruct%s(const %s &value) {' % (struct.id, struct.expr)
55 print ' static const char * members[%u] = {' % (len(struct.members),)
56 for type, name, in struct.members:
57 print ' "%s",' % (name,)
59 print ' static const Trace::StructSig sig = {'
60 print ' %u, "%s", %u, members' % (int(struct.id), struct.name, len(struct.members))
62 print ' Trace::BeginStruct(&sig);'
63 for type, name in struct.members:
64 dump_instance(type, 'value.%s' % (name,))
65 print ' Trace::EndStruct();'
69 def visit_array(self, array):
70 self.visit(array.type)
72 def visit_blob(self, array):
75 def visit_enum(self, enum):
76 print 'static void __traceEnum%s(const %s value) {' % (enum.id, enum.expr)
79 value = enum.values[i]
80 print ' static const Trace::EnumSig sig%u = {%u, "%s", %s};' % (i, enum.vid + i, value, value)
81 print ' const Trace::EnumSig *sig;'
82 print ' switch(value) {'
84 value = enum.values[i]
85 print ' case %s:' % value
86 print ' sig = &sig%u;' % i
89 print ' Trace::LiteralSInt(value);'
92 print ' Trace::LiteralEnum(sig);'
96 def visit_bitmask(self, bitmask):
97 print 'static const Trace::BitmaskVal __bitmask%s_vals[] = {' % (bitmask.id)
98 for value in bitmask.values:
99 print ' {"%s", %s},' % (value, value)
102 print 'static const Trace::BitmaskSig __bitmask%s_sig = {' % (bitmask.id)
103 print ' %u, %u, __bitmask%s_vals' % (int(bitmask.id), len(bitmask.values), bitmask.id)
107 def visit_pointer(self, pointer):
108 self.visit(pointer.type)
110 def visit_handle(self, handle):
111 self.visit(handle.type)
113 def visit_alias(self, alias):
114 self.visit(alias.type)
116 def visit_opaque(self, opaque):
119 def visit_interface(self, interface):
120 print "class %s : public %s " % (interface_wrap_name(interface), interface.name)
123 print " %s(%s * pInstance);" % (interface_wrap_name(interface), interface.name)
124 print " virtual ~%s();" % interface_wrap_name(interface)
126 for method in interface.itermethods():
127 print " " + method.prototype() + ";"
130 print " %s * m_pInstance;" % (interface.name,)
135 class DumpImplementer(stdapi.Visitor):
136 '''Dump an instance.'''
138 def visit_literal(self, literal, instance):
139 print ' Trace::Literal%s(%s);' % (literal.format, instance)
141 def visit_string(self, string, instance):
142 if string.length is not None:
143 print ' Trace::LiteralString((const char *)%s, %s);' % (instance, string.length)
145 print ' Trace::LiteralString((const char *)%s);' % instance
147 def visit_const(self, const, instance):
148 self.visit(const.type, instance)
150 def visit_struct(self, struct, instance):
151 print ' __traceStruct%s(%s);' % (struct.id, instance)
153 def visit_array(self, array, instance):
154 print ' if(%s) {' % instance
155 index = '__i' + array.type.id
156 print ' Trace::BeginArray(%s);' % (array.length,)
157 print ' for (int %s = 0; %s < %s; ++%s) {' % (index, index, array.length, index)
158 print ' Trace::BeginElement();'
159 self.visit(array.type, '(%s)[%s]' % (instance, index))
160 print ' Trace::EndElement();'
162 print ' Trace::EndArray();'
165 print ' Trace::LiteralNull();'
167 def visit_blob(self, blob, instance):
168 print ' Trace::LiteralBlob(%s, %s);' % (instance, blob.size)
170 def visit_enum(self, enum, instance):
171 print ' __traceEnum%s(%s);' % (enum.id, instance)
173 def visit_bitmask(self, bitmask, instance):
174 print ' Trace::LiteralBitmask(__bitmask%s_sig, %s);' % (bitmask.id, instance)
176 def visit_pointer(self, pointer, instance):
177 print ' if(%s) {' % instance
178 print ' Trace::BeginArray(1);'
179 print ' Trace::BeginElement();'
180 dump_instance(pointer.type, "*" + instance)
181 print ' Trace::EndElement();'
182 print ' Trace::EndArray();'
185 print ' Trace::LiteralNull();'
187 def visit_handle(self, handle, instance):
188 self.visit(handle.type, instance)
190 def visit_alias(self, alias, instance):
191 self.visit(alias.type, instance)
193 def visit_opaque(self, opaque, instance):
194 print ' Trace::LiteralOpaque((const void *)%s);' % instance
196 def visit_interface(self, interface, instance):
197 print ' Trace::LiteralOpaque((const void *)&%s);' % instance
200 dump_instance = DumpImplementer().visit
204 class Wrapper(stdapi.Visitor):
205 '''Wrap an instance.'''
207 def visit_void(self, type, instance):
208 raise NotImplementedError
210 def visit_literal(self, type, instance):
213 def visit_string(self, type, instance):
216 def visit_const(self, type, instance):
219 def visit_struct(self, struct, instance):
220 for type, name in struct.members:
221 self.visit(type, "(%s).%s" % (instance, name))
223 def visit_array(self, array, instance):
224 # XXX: actually it is possible to return an array of pointers
227 def visit_blob(self, blob, instance):
230 def visit_enum(self, enum, instance):
233 def visit_bitmask(self, bitmask, instance):
236 def visit_pointer(self, pointer, instance):
237 self.visit(pointer.type, "*" + instance)
239 def visit_handle(self, handle, instance):
240 self.visit(handle.type, instance)
242 def visit_alias(self, alias, instance):
243 self.visit(alias.type, instance)
245 def visit_opaque(self, opaque, instance):
248 def visit_interface(self, interface, instance):
249 assert instance.startswith('*')
250 instance = instance[1:]
251 print " if(%s)" % instance
252 print " %s = new %s(%s);" % (instance, interface_wrap_name(interface), instance)
255 class Unwrapper(Wrapper):
257 def visit_interface(self, interface, instance):
258 assert instance.startswith('*')
259 instance = instance[1:]
260 print " if(%s)" % instance
261 print " %s = static_cast<%s *>(%s)->m_pInstance;" % (instance, interface_wrap_name(interface), instance)
264 wrap_instance = Wrapper().visit
265 unwrap_instance = Unwrapper().visit
270 def trace_api(self, api):
274 for header in api.headers:
279 types = api.all_types()
280 visitor = DumpDeclarator()
281 map(visitor.visit, types)
285 interfaces = [type for type in types if isinstance(type, stdapi.Interface)]
286 map(self.interface_wrap_impl, interfaces)
290 map(self.trace_function_decl, api.functions)
291 map(self.trace_function_impl, api.functions)
296 def header(self, api):
299 def footer(self, api):
302 def trace_function_decl(self, function):
303 # Per-function declarations
306 print 'static const char * __%s_args[%u] = {%s};' % (function.name, len(function.args), ', '.join(['"%s"' % arg.name for arg in function.args]))
308 print 'static const char ** __%s_args = NULL;' % (function.name,)
309 print 'static const Trace::FunctionSig __%s_sig = {%u, "%s", %u, __%s_args};' % (function.name, int(function.id), function.name, len(function.args), function.name)
312 def get_dispatch_function(self, function):
313 return '__' + function.name
315 def trace_function_impl(self, function):
316 print 'extern "C" ' + function.prototype() + ' {'
317 if function.type is not stdapi.Void:
318 print ' %s __result;' % function.type
319 self.trace_function_impl_body(function)
320 if function.type is not stdapi.Void:
321 self.wrap_ret(function, "__result")
322 print ' return __result;'
326 def trace_function_impl_body(self, function):
327 print ' unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
328 for arg in function.args:
330 self.unwrap_arg(function, arg)
331 self.dump_arg(function, arg)
332 print ' Trace::EndEnter();'
333 self.dispatch_function(function)
334 print ' Trace::BeginLeave(__call);'
335 for arg in function.args:
337 self.dump_arg(function, arg)
338 self.wrap_arg(function, arg)
339 if function.type is not stdapi.Void:
340 self.dump_ret(function, "__result")
341 print ' Trace::EndLeave();'
343 def dispatch_function(self, function):
344 if function.type is stdapi.Void:
347 result = '__result = '
348 dispatch = self.get_dispatch_function(function)
349 print ' %s%s(%s);' % (result, dispatch, ', '.join([str(arg.name) for arg in function.args]))
351 def dump_arg(self, function, arg):
352 print ' Trace::BeginArg(%u);' % (arg.index,)
353 dump_instance(arg.type, arg.name)
354 print ' Trace::EndArg();'
356 def wrap_arg(self, function, arg):
357 wrap_instance(arg.type, arg.name)
359 def unwrap_arg(self, function, arg):
360 unwrap_instance(arg.type, arg.name)
362 def dump_ret(self, function, instance):
363 print ' Trace::BeginReturn();'
364 dump_instance(function.type, instance)
365 print ' Trace::EndReturn();'
367 def wrap_ret(self, function, instance):
368 wrap_instance(function.type, instance)
370 def unwrap_ret(self, function, instance):
371 unwrap_instance(function.type, instance)
373 def interface_wrap_impl(self, interface):
374 print '%s::%s(%s * pInstance) {' % (interface_wrap_name(interface), interface_wrap_name(interface), interface.name)
375 print ' m_pInstance = pInstance;'
378 print '%s::~%s() {' % (interface_wrap_name(interface), interface_wrap_name(interface))
381 for method in interface.itermethods():
382 self.trace_method(interface, method)
385 def trace_method(self, interface, method):
386 print method.prototype(interface_wrap_name(interface) + '::' + method.name) + ' {'
387 print ' static const char * __args[%u] = {%s};' % (len(method.args) + 1, ', '.join(['"this"'] + ['"%s"' % arg.name for arg in method.args]))
388 print ' static const Trace::FunctionSig __sig = {%u, "%s", %u, __args};' % (int(method.id), interface.name + '::' + method.name, len(method.args) + 1)
389 print ' unsigned __call = Trace::BeginEnter(__sig);'
390 print ' Trace::BeginArg(0);'
391 print ' Trace::LiteralOpaque((const void *)m_pInstance);'
392 print ' Trace::EndArg();'
393 for arg in method.args:
395 self.unwrap_arg(method, arg)
396 self.dump_arg(method, arg)
397 if method.type is stdapi.Void:
400 print ' %s __result;' % method.type
401 result = '__result = '
402 print ' Trace::EndEnter();'
403 print ' %sm_pInstance->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args]))
404 print ' Trace::BeginLeave(__call);'
405 for arg in method.args:
407 self.dump_arg(method, arg)
408 self.wrap_arg(method, arg)
409 if method.type is not stdapi.Void:
410 print ' Trace::BeginReturn();'
411 dump_instance(method.type, "__result")
412 print ' Trace::EndReturn();'
413 wrap_instance(method.type, '__result')
414 print ' Trace::EndLeave();'
415 if method.name == 'QueryInterface':
416 print ' if (*ppvObj == m_pInstance)'
417 print ' *ppvObj = this;'
418 if method.name == 'Release':
419 assert method.type is not stdapi.Void
420 print ' if (!__result)'
421 print ' delete this;'
422 if method.type is not stdapi.Void:
423 print ' return __result;'
428 class DllTracer(Tracer):
430 def __init__(self, dllname):
431 self.dllname = dllname
433 def get_function_address(self, function):
434 return '__%s' % (function.name,)
436 def header(self, api):
437 Tracer.header(self, api)
440 static HINSTANCE g_hDll = NULL;
443 __GetProcAddress(LPCSTR lpProcName)
446 char szDll[MAX_PATH] = {0};
448 if (!GetSystemDirectoryA(szDll, MAX_PATH)) {
452 strcat(szDll, "\\\\%s");
454 g_hDll = LoadLibraryA(szDll);
460 return GetProcAddress(g_hDll, lpProcName);