X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=trace.py;h=bb209e408f197d3046e60b41c2685ee58379a30c;hb=54f304ad1c3ec54649f83ddf769746d433cd612d;hp=ee276532821c08d53a4f8974abcf1171cc16d956;hpb=b4a3d1495a5e92ba23bf463bcea34a6e75b55294;p=apitrace diff --git a/trace.py b/trace.py index ee27653..bb209e4 100644 --- a/trace.py +++ b/trace.py @@ -27,29 +27,36 @@ 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.''' +class ComplexValueSerializer(stdapi.OnceVisitor): + '''Type visitors which generates serialization functions for + complex types. + + Simple types are serialized inline. + ''' + + def __init__(self, serializer): + stdapi.OnceVisitor.__init__(self) + self.serializer = serializer - def visit_void(self, literal): + def visitVoid(self, literal): pass - def visit_literal(self, literal): + def visitLiteral(self, literal): pass - def visit_string(self, string): + def visitString(self, string): pass - def visit_const(self, const): + def visitConst(self, const): self.visit(const.type) - def visit_struct(self, struct): + def visitStruct(self, struct): for type, name in struct.members: self.visit(type) print 'static void _write__%s(const %s &value) {' % (struct.tag, struct.expr) @@ -62,42 +69,29 @@ class DumpDeclarator(stdapi.OnceVisitor): print ' };' print ' trace::localWriter.beginStruct(&sig);' for type, name in struct.members: - dump_instance(type, 'value.%s' % (name,)) + self.serializer.visit(type, 'value.%s' % (name,)) print ' trace::localWriter.endStruct();' print '}' print - def visit_array(self, array): + def visitArray(self, array): self.visit(array.type) - def visit_blob(self, array): + def visitBlob(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 '}' + def visitEnum(self, enum): + print 'static const trace::EnumValue __enum%s_values[] = {' % (enum.tag) + for value in enum.values: + print ' {"%s", %s},' % (value, value) + print '};' + print + print 'static const trace::EnumSig __enum%s_sig = {' % (enum.tag) + print ' %u, %u, __enum%s_values' % (enum.id, len(enum.values), enum.tag) + print '};' print - def visit_bitmask(self, bitmask): + def visitBitmask(self, bitmask): print 'static const trace::BitmaskFlag __bitmask%s_flags[] = {' % (bitmask.tag) for value in bitmask.values: print ' {"%s", %s},' % (value, value) @@ -108,26 +102,26 @@ class DumpDeclarator(stdapi.OnceVisitor): print '};' print - def visit_pointer(self, pointer): + def visitPointer(self, pointer): self.visit(pointer.type) - def visit_handle(self, handle): + def visitHandle(self, handle): self.visit(handle.type) - def visit_alias(self, alias): + def visitAlias(self, alias): self.visit(alias.type) - def visit_opaque(self, opaque): + def visitOpaque(self, opaque): pass - def visit_interface(self, interface): + def visitInterface(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(): + for method in interface.iterMethods(): print " " + method.prototype() + ";" print #print "private:" @@ -135,38 +129,43 @@ class DumpDeclarator(stdapi.OnceVisitor): print "};" print - def visit_polymorphic(self, polymorphic): + def visitPolymorphic(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 cases, type in polymorphic.iterSwitch(): for case in cases: print ' %s:' % case - dump_instance(type, 'static_cast<%s>(value)' % (type,)) + self.serializer.visit(type, 'static_cast<%s>(value)' % (type,)) print ' break;' print ' }' print '}' print -class DumpImplementer(stdapi.Visitor): - '''Dump an instance.''' +class ValueSerializer(stdapi.Visitor): + '''Visitor which generates code to serialize any type. + + Simple types are serialized inline here, whereas the serialization of + complex types is dispatched to the serialization functions generated by + ComplexValueSerializer visitor above. + ''' - def visit_literal(self, literal, instance): + def visitLiteral(self, literal, instance): print ' trace::localWriter.write%s(%s);' % (literal.kind, instance) - def visit_string(self, string, instance): + def visitString(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): + def visitConst(self, const, instance): self.visit(const.type, instance) - def visit_struct(self, struct, instance): + def visitStruct(self, struct, instance): print ' _write__%s(%s);' % (struct.tag, instance) - def visit_array(self, array, instance): + def visitArray(self, array, instance): length = '__c' + array.type.tag index = '__i' + array.type.tag print ' if (%s) {' % instance @@ -182,107 +181,108 @@ class DumpImplementer(stdapi.Visitor): print ' trace::localWriter.writeNull();' print ' }' - def visit_blob(self, blob, instance): + def visitBlob(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 visitEnum(self, enum, instance): + print ' trace::localWriter.writeEnum(&__enum%s_sig, %s);' % (enum.tag, instance) - def visit_bitmask(self, bitmask, instance): + def visitBitmask(self, bitmask, instance): print ' trace::localWriter.writeBitmask(&__bitmask%s_sig, %s);' % (bitmask.tag, instance) - def visit_pointer(self, pointer, instance): + def visitPointer(self, pointer, instance): print ' if (%s) {' % instance print ' trace::localWriter.beginArray(1);' print ' trace::localWriter.beginElement();' - dump_instance(pointer.type, "*" + instance) + self.visit(pointer.type, "*" + instance) print ' trace::localWriter.endElement();' print ' trace::localWriter.endArray();' print ' } else {' print ' trace::localWriter.writeNull();' print ' }' - def visit_handle(self, handle, instance): + def visitHandle(self, handle, instance): self.visit(handle.type, instance) - def visit_alias(self, alias, instance): + def visitAlias(self, alias, instance): self.visit(alias.type, instance) - def visit_opaque(self, opaque, instance): + def visitOpaque(self, opaque, instance): print ' trace::localWriter.writeOpaque((const void *)%s);' % instance - def visit_interface(self, interface, instance): + def visitInterface(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 - + def visitPolymorphic(self, polymorphic, instance): + print ' _write__%s(%s, %s);' % (polymorphic.tag, polymorphic.switchExpr, instance) -class Wrapper(stdapi.Visitor): - '''Wrap an instance.''' +class ValueWrapper(stdapi.Visitor): + '''Type visitor which will generate the code to wrap an instance. + + Wrapping is necessary mostly for interfaces, however interface pointers can + appear anywhere inside complex types. + ''' - def visit_void(self, type, instance): + def visitVoid(self, type, instance): raise NotImplementedError - def visit_literal(self, type, instance): + def visitLiteral(self, type, instance): pass - def visit_string(self, type, instance): + def visitString(self, type, instance): pass - def visit_const(self, type, instance): + def visitConst(self, type, instance): pass - def visit_struct(self, struct, instance): + def visitStruct(self, struct, instance): for type, name in struct.members: self.visit(type, "(%s).%s" % (instance, name)) - def visit_array(self, array, instance): + def visitArray(self, array, instance): # XXX: actually it is possible to return an array of pointers pass - def visit_blob(self, blob, instance): + def visitBlob(self, blob, instance): pass - def visit_enum(self, enum, instance): + def visitEnum(self, enum, instance): pass - def visit_bitmask(self, bitmask, instance): + def visitBitmask(self, bitmask, instance): pass - def visit_pointer(self, pointer, instance): + def visitPointer(self, pointer, instance): print " if (%s) {" % instance self.visit(pointer.type, "*" + instance) print " }" - def visit_handle(self, handle, instance): + def visitHandle(self, handle, instance): self.visit(handle.type, instance) - def visit_alias(self, alias, instance): + def visitAlias(self, alias, instance): self.visit(alias.type, instance) - def visit_opaque(self, opaque, instance): + def visitOpaque(self, opaque, instance): pass - def visit_interface(self, interface, instance): + def visitInterface(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): + def visitPolymorphic(self, type, instance): # XXX: There might be polymorphic values that need wrapping in the future pass -class Unwrapper(Wrapper): +class ValueUnwrapper(ValueWrapper): + '''Reverse of ValueWrapper.''' - def visit_interface(self, interface, instance): + def visitInterface(self, interface, instance): assert instance.startswith('*') instance = instance[1:] print " if (%s) {" % instance @@ -290,15 +290,20 @@ class Unwrapper(Wrapper): print " }" -wrap_instance = Wrapper().visit -unwrap_instance = Unwrapper().visit - - class Tracer: + '''Base class to orchestrate the code generation of API tracing.''' def __init__(self): self.api = None + def serializerFactory(self): + '''Create a serializer. + + Can be overriden by derived classes to inject their own serialzer. + ''' + + return ValueSerializer() + def trace_api(self, api): self.api = api @@ -309,20 +314,20 @@ class Tracer: print header print - # Type dumpers + # Generate the serializer functions types = api.all_types() - visitor = DumpDeclarator() + visitor = ComplexValueSerializer(self.serializerFactory()) map(visitor.visit, types) print # Interfaces wrapers interfaces = [type for type in types if isinstance(type, stdapi.Interface)] - map(self.interface_wrap_impl, interfaces) + map(self.traceInterfaceImpl, interfaces) print # Function wrappers - map(self.trace_function_decl, api.functions) - map(self.trace_function_impl, api.functions) + map(self.traceFunctionDecl, api.functions) + map(self.traceFunctionImpl, api.functions) print self.footer(api) @@ -333,7 +338,7 @@ class Tracer: def footer(self, api): pass - def trace_function_decl(self, function): + def traceFunctionDecl(self, function): # Per-function declarations if function.args: @@ -343,42 +348,42 @@ class Tracer: 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): + def isFunctionPublic(self, function): return True - def trace_function_impl(self, function): - if self.is_public_function(function): + def traceFunctionImpl(self, function): + if self.isFunctionPublic(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) + self.traceFunctionImplBody(function) if function.type is not stdapi.Void: - self.wrap_ret(function, "__result") + self.wrapRet(function, "__result") print ' return __result;' print '}' print - def trace_function_impl_body(self, function): + def traceFunctionImplBody(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) + self.unwrapArg(function, arg) + self.serializeArg(function, arg) print ' trace::localWriter.endEnter();' - self.dispatch_function(function) + self.invokeFunction(function) print ' trace::localWriter.beginLeave(__call);' for arg in function.args: if arg.output: - self.dump_arg(function, arg) - self.wrap_arg(function, arg) + self.serializeArg(function, arg) + self.wrapArg(function, arg) if function.type is not stdapi.Void: - self.dump_ret(function, "__result") + self.serializeRet(function, "__result") print ' trace::localWriter.endLeave();' - def dispatch_function(self, function, prefix='__', suffix=''): + def invokeFunction(self, function, prefix='__', suffix=''): if function.type is stdapi.Void: result = '' else: @@ -386,32 +391,44 @@ class Tracer: 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): + def serializeArg(self, function, arg): print ' trace::localWriter.beginArg(%u);' % (arg.index,) - self.dump_arg_instance(function, arg) + self.serializeArgValue(function, arg) print ' trace::localWriter.endArg();' - def dump_arg_instance(self, function, arg): - dump_instance(arg.type, arg.name) + def serializeArgValue(self, function, arg): + self.serializeValue(arg.type, arg.name) - def wrap_arg(self, function, arg): - wrap_instance(arg.type, arg.name) + def wrapArg(self, function, arg): + self.wrapValue(arg.type, arg.name) - def unwrap_arg(self, function, arg): - unwrap_instance(arg.type, arg.name) + def unwrapArg(self, function, arg): + self.unwrapValue(arg.type, arg.name) - def dump_ret(self, function, instance): + def serializeRet(self, function, instance): print ' trace::localWriter.beginReturn();' - dump_instance(function.type, instance) + self.serializeValue(function.type, instance) print ' trace::localWriter.endReturn();' - def wrap_ret(self, function, instance): - wrap_instance(function.type, instance) + def serializeValue(self, type, instance): + serializer = self.serializerFactory() + serializer.visit(type, instance) + + def wrapRet(self, function, instance): + self.wrapValue(function.type, instance) + + def unwrapRet(self, function, instance): + self.unwrapValue(function.type, instance) + + def wrapValue(self, type, instance): + visitor = ValueWrapper() + visitor.visit(type, instance) - def unwrap_ret(self, function, instance): - unwrap_instance(function.type, instance) + def unwrapValue(self, type, instance): + visitor = ValueUnwrapper() + visitor.visit(type, instance) - def interface_wrap_impl(self, interface): + def traceInterfaceImpl(self, interface): print '%s::%s(%s * pInstance) {' % (interface_wrap_name(interface), interface_wrap_name(interface), interface.name) print ' m_pInstance = pInstance;' print '}' @@ -419,11 +436,11 @@ class Tracer: print '%s::~%s() {' % (interface_wrap_name(interface), interface_wrap_name(interface)) print '}' print - for method in interface.itermethods(): - self.trace_method(interface, method) + for method in interface.iterMethods(): + self.traceMethod(interface, method) print - def trace_method(self, interface, method): + def traceMethod(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) @@ -433,8 +450,8 @@ class Tracer: print ' trace::localWriter.endArg();' for arg in method.args: if not arg.output: - self.unwrap_arg(method, arg) - self.dump_arg(method, arg) + self.unwrapArg(method, arg) + self.serializeArg(method, arg) if method.type is stdapi.Void: result = '' else: @@ -445,13 +462,13 @@ class Tracer: print ' trace::localWriter.beginLeave(__call);' for arg in method.args: if arg.output: - self.dump_arg(method, arg) - self.wrap_arg(method, arg) + self.serializeArg(method, arg) + self.wrapArg(method, arg) if method.type is not stdapi.Void: print ' trace::localWriter.beginReturn();' - dump_instance(method.type, "__result") + self.serializeValue(method.type, "__result") print ' trace::localWriter.endReturn();' - wrap_instance(method.type, '__result') + self.wrapValue(method.type, '__result') print ' trace::localWriter.endLeave();' if method.name == 'QueryInterface': print ' if (ppvObj && *ppvObj) {' @@ -459,9 +476,21 @@ class Tracer: 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 r' else if (riid == IID_%s) {' % iface.name + print r' *ppvObj = new Wrap%s((%s *) *ppvObj);' % (iface.name, iface.name) + print r' }' + print r' else {' + print r' os::log("apitrace: warning: unknown REFIID {0x%08lX,0x%04X,0x%04X,{0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X}}\n",' + print r' riid.Data1, riid.Data2, riid.Data3,' + print r' riid.Data4[0],' + print r' riid.Data4[1],' + print r' riid.Data4[2],' + print r' riid.Data4[3],' + print r' riid.Data4[4],' + print r' riid.Data4[5],' + print r' riid.Data4[6],' + print r' riid.Data4[7]);' + print r' }' print ' }' if method.name == 'Release': assert method.type is not stdapi.Void @@ -472,41 +501,3 @@ class Tracer: 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) -