########################################################################## # # Copyright 2008-2010 VMware, Inc. # All Rights Reserved. # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. # ##########################################################################/ """Common trace code generation.""" import specs.stdapi as stdapi from dispatch import Dispatcher def interface_wrap_name(interface): return "Wrap" + interface.expr class DumpDeclarator(stdapi.OnceVisitor): '''Declare helper functions to dump complex types.''' def visit_void(self, literal): pass def visit_literal(self, literal): pass def visit_string(self, string): pass def visit_const(self, const): self.visit(const.type) def visit_struct(self, struct): for type, name in struct.members: self.visit(type) print 'static void _write__%s(const %s &value) {' % (struct.tag, struct.expr) print ' static const char * members[%u] = {' % (len(struct.members),) for type, name, in struct.members: print ' "%s",' % (name,) print ' };' print ' static const Trace::StructSig sig = {' print ' %u, "%s", %u, members' % (struct.id, struct.name, len(struct.members)) print ' };' print ' Trace::localWriter.beginStruct(&sig);' for type, name in struct.members: dump_instance(type, 'value.%s' % (name,)) print ' Trace::localWriter.endStruct();' print '}' print def visit_array(self, array): self.visit(array.type) def visit_blob(self, array): pass __enum_id = 0 def visit_enum(self, enum): print 'static void _write__%s(const %s value) {' % (enum.tag, enum.expr) n = len(enum.values) for i in range(n): value = enum.values[i] print ' static const Trace::EnumSig sig%u = {%u, "%s", %s};' % (i, DumpDeclarator.__enum_id, value, value) DumpDeclarator.__enum_id += 1 print ' const Trace::EnumSig *sig;' print ' switch (value) {' for i in range(n): value = enum.values[i] print ' case %s:' % value print ' sig = &sig%u;' % i print ' break;' print ' default:' print ' Trace::localWriter.writeSInt(value);' print ' return;' print ' }' print ' Trace::localWriter.writeEnum(sig);' print '}' print def visit_bitmask(self, bitmask): print 'static const Trace::BitmaskFlag __bitmask%s_flags[] = {' % (bitmask.tag) for value in bitmask.values: print ' {"%s", %s},' % (value, value) print '};' print print 'static const Trace::BitmaskSig __bitmask%s_sig = {' % (bitmask.tag) print ' %u, %u, __bitmask%s_flags' % (bitmask.id, len(bitmask.values), bitmask.tag) print '};' print def visit_pointer(self, pointer): self.visit(pointer.type) def visit_handle(self, handle): self.visit(handle.type) def visit_alias(self, alias): self.visit(alias.type) def visit_opaque(self, opaque): pass def visit_interface(self, interface): print "class %s : public %s " % (interface_wrap_name(interface), interface.name) print "{" print "public:" print " %s(%s * pInstance);" % (interface_wrap_name(interface), interface.name) print " virtual ~%s();" % interface_wrap_name(interface) print for method in interface.itermethods(): print " " + method.prototype() + ";" print #print "private:" print " %s * m_pInstance;" % (interface.name,) print "};" print def visit_polymorphic(self, polymorphic): print 'static void _write__%s(int selector, const %s & value) {' % (polymorphic.tag, polymorphic.expr) print ' switch (selector) {' for cases, type in polymorphic.iterswitch(): for case in cases: print ' %s:' % case dump_instance(type, 'static_cast<%s>(value)' % (type,)) print ' break;' print ' }' print '}' print class DumpImplementer(stdapi.Visitor): '''Dump an instance.''' def visit_literal(self, literal, instance): print ' Trace::localWriter.write%s(%s);' % (literal.kind, instance) def visit_string(self, string, instance): if string.length is not None: print ' Trace::localWriter.writeString((const char *)%s, %s);' % (instance, string.length) else: print ' Trace::localWriter.writeString((const char *)%s);' % instance def visit_const(self, const, instance): self.visit(const.type, instance) def visit_struct(self, struct, instance): print ' _write__%s(%s);' % (struct.tag, instance) def visit_array(self, array, instance): length = '__c' + array.type.tag index = '__i' + array.type.tag print ' if (%s) {' % instance print ' size_t %s = %s;' % (length, array.length) print ' Trace::localWriter.beginArray(%s);' % length print ' for (size_t %s = 0; %s < %s; ++%s) {' % (index, index, length, index) print ' Trace::localWriter.beginElement();' self.visit(array.type, '(%s)[%s]' % (instance, index)) print ' Trace::localWriter.endElement();' print ' }' print ' Trace::localWriter.endArray();' print ' } else {' print ' Trace::localWriter.writeNull();' print ' }' def visit_blob(self, blob, instance): print ' Trace::localWriter.writeBlob(%s, %s);' % (instance, blob.size) def visit_enum(self, enum, instance): print ' _write__%s(%s);' % (enum.tag, instance) def visit_bitmask(self, bitmask, instance): print ' Trace::localWriter.writeBitmask(&__bitmask%s_sig, %s);' % (bitmask.tag, instance) def visit_pointer(self, pointer, instance): print ' if (%s) {' % instance print ' Trace::localWriter.beginArray(1);' print ' Trace::localWriter.beginElement();' dump_instance(pointer.type, "*" + instance) print ' Trace::localWriter.endElement();' print ' Trace::localWriter.endArray();' print ' } else {' print ' Trace::localWriter.writeNull();' print ' }' def visit_handle(self, handle, instance): self.visit(handle.type, instance) def visit_alias(self, alias, instance): self.visit(alias.type, instance) def visit_opaque(self, opaque, instance): print ' Trace::localWriter.writeOpaque((const void *)%s);' % instance def visit_interface(self, interface, instance): print ' Trace::localWriter.writeOpaque((const void *)&%s);' % instance def visit_polymorphic(self, polymorphic, instance): print ' _write__%s(%s, %s);' % (polymorphic.tag, polymorphic.switch_expr, instance) dump_instance = DumpImplementer().visit class Wrapper(stdapi.Visitor): '''Wrap an instance.''' def visit_void(self, type, instance): raise NotImplementedError def visit_literal(self, type, instance): pass def visit_string(self, type, instance): pass def visit_const(self, type, instance): pass def visit_struct(self, struct, instance): for type, name in struct.members: self.visit(type, "(%s).%s" % (instance, name)) def visit_array(self, array, instance): # XXX: actually it is possible to return an array of pointers pass def visit_blob(self, blob, instance): pass def visit_enum(self, enum, instance): pass def visit_bitmask(self, bitmask, instance): pass def visit_pointer(self, pointer, instance): print " if (%s) {" % instance self.visit(pointer.type, "*" + instance) print " }" def visit_handle(self, handle, instance): self.visit(handle.type, instance) def visit_alias(self, alias, instance): self.visit(alias.type, instance) def visit_opaque(self, opaque, instance): pass def visit_interface(self, interface, instance): assert instance.startswith('*') instance = instance[1:] print " if (%s) {" % instance print " %s = new %s(%s);" % (instance, interface_wrap_name(interface), instance) print " }" def visit_polymorphic(self, type, instance): # XXX: There might be polymorphic values that need wrapping in the future pass class Unwrapper(Wrapper): def visit_interface(self, interface, instance): assert instance.startswith('*') instance = instance[1:] print " if (%s) {" % instance print " %s = static_cast<%s *>(%s)->m_pInstance;" % (instance, interface_wrap_name(interface), instance) print " }" wrap_instance = Wrapper().visit unwrap_instance = Unwrapper().visit class Tracer: def __init__(self): self.api = None def trace_api(self, api): self.api = api self.header(api) # Includes for header in api.headers: print header print # Type dumpers types = api.all_types() visitor = DumpDeclarator() map(visitor.visit, types) print # Interfaces wrapers interfaces = [type for type in types if isinstance(type, stdapi.Interface)] map(self.interface_wrap_impl, interfaces) print # Function wrappers map(self.trace_function_decl, api.functions) map(self.trace_function_impl, api.functions) print self.footer(api) def header(self, api): pass def footer(self, api): pass def trace_function_decl(self, function): # Per-function declarations if function.args: print 'static const char * __%s_args[%u] = {%s};' % (function.name, len(function.args), ', '.join(['"%s"' % arg.name for arg in function.args])) else: print 'static const char ** __%s_args = NULL;' % (function.name,) print 'static const Trace::FunctionSig __%s_sig = {%u, "%s", %u, __%s_args};' % (function.name, function.id, function.name, len(function.args), function.name) print def is_public_function(self, function): return True def trace_function_impl(self, function): if self.is_public_function(function): print 'extern "C" PUBLIC' else: print 'extern "C" PRIVATE' print function.prototype() + ' {' if function.type is not stdapi.Void: print ' %s __result;' % function.type self.trace_function_impl_body(function) if function.type is not stdapi.Void: self.wrap_ret(function, "__result") print ' return __result;' print '}' print def trace_function_impl_body(self, function): print ' unsigned __call = Trace::localWriter.beginEnter(&__%s_sig);' % (function.name,) for arg in function.args: if not arg.output: self.unwrap_arg(function, arg) self.dump_arg(function, arg) print ' Trace::localWriter.endEnter();' self.dispatch_function(function) print ' Trace::localWriter.beginLeave(__call);' for arg in function.args: if arg.output: self.dump_arg(function, arg) self.wrap_arg(function, arg) if function.type is not stdapi.Void: self.dump_ret(function, "__result") print ' Trace::localWriter.endLeave();' def dispatch_function(self, function, prefix='__', suffix=''): if function.type is stdapi.Void: result = '' else: result = '__result = ' dispatch = prefix + function.name + suffix print ' %s%s(%s);' % (result, dispatch, ', '.join([str(arg.name) for arg in function.args])) def dump_arg(self, function, arg): print ' Trace::localWriter.beginArg(%u);' % (arg.index,) self.dump_arg_instance(function, arg) print ' Trace::localWriter.endArg();' def dump_arg_instance(self, function, arg): dump_instance(arg.type, arg.name) def wrap_arg(self, function, arg): wrap_instance(arg.type, arg.name) def unwrap_arg(self, function, arg): unwrap_instance(arg.type, arg.name) def dump_ret(self, function, instance): print ' Trace::localWriter.beginReturn();' dump_instance(function.type, instance) print ' Trace::localWriter.endReturn();' def wrap_ret(self, function, instance): wrap_instance(function.type, instance) def unwrap_ret(self, function, instance): unwrap_instance(function.type, instance) def interface_wrap_impl(self, interface): print '%s::%s(%s * pInstance) {' % (interface_wrap_name(interface), interface_wrap_name(interface), interface.name) print ' m_pInstance = pInstance;' print '}' print print '%s::~%s() {' % (interface_wrap_name(interface), interface_wrap_name(interface)) print '}' print for method in interface.itermethods(): self.trace_method(interface, method) print def trace_method(self, interface, method): print method.prototype(interface_wrap_name(interface) + '::' + method.name) + ' {' print ' static const char * __args[%u] = {%s};' % (len(method.args) + 1, ', '.join(['"this"'] + ['"%s"' % arg.name for arg in method.args])) print ' static const Trace::FunctionSig __sig = {%u, "%s", %u, __args};' % (method.id, interface.name + '::' + method.name, len(method.args) + 1) print ' unsigned __call = Trace::localWriter.beginEnter(&__sig);' print ' Trace::localWriter.beginArg(0);' print ' Trace::localWriter.writeOpaque((const void *)m_pInstance);' print ' Trace::localWriter.endArg();' for arg in method.args: if not arg.output: self.unwrap_arg(method, arg) self.dump_arg(method, arg) if method.type is stdapi.Void: result = '' else: print ' %s __result;' % method.type result = '__result = ' print ' Trace::localWriter.endEnter();' print ' %sm_pInstance->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args])) print ' Trace::localWriter.beginLeave(__call);' for arg in method.args: if arg.output: self.dump_arg(method, arg) self.wrap_arg(method, arg) if method.type is not stdapi.Void: print ' Trace::localWriter.beginReturn();' dump_instance(method.type, "__result") print ' Trace::localWriter.endReturn();' wrap_instance(method.type, '__result') print ' Trace::localWriter.endLeave();' if method.name == 'QueryInterface': print ' if (ppvObj && *ppvObj) {' print ' if (*ppvObj == m_pInstance) {' print ' *ppvObj = this;' print ' }' for iface in self.api.interfaces: print ' else if (riid == IID_%s) {' % iface.name print ' *ppvObj = new Wrap%s((%s *) *ppvObj);' % (iface.name, iface.name) print ' }' print ' }' if method.name == 'Release': assert method.type is not stdapi.Void print ' if (!__result)' print ' delete this;' if method.type is not stdapi.Void: print ' return __result;' print '}' print class DllTracer(Tracer): def __init__(self, dllname): self.dllname = dllname def header(self, api): print ''' static HINSTANCE g_hDll = NULL; static PROC __getPublicProcAddress(LPCSTR lpProcName) { if (!g_hDll) { char szDll[MAX_PATH] = {0}; if (!GetSystemDirectoryA(szDll, MAX_PATH)) { return NULL; } strcat(szDll, "\\\\%s"); g_hDll = LoadLibraryA(szDll); if (!g_hDll) { return NULL; } } return GetProcAddress(g_hDll, lpProcName); } ''' % self.dllname dispatcher = Dispatcher() dispatcher.dispatch_api(api) Tracer.header(self, api)