X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=trace.py;h=626f2ddf767ca577549de2887d83eb9ec933ef80;hb=f682e19bee94eb69a5cfc8b2db17d7f1ebb10c2b;hp=b50d0a6734a5bbf5272b4e97310a6547e70999a4;hpb=dce84c4cbc8176d627c5e7801c2acbd0e2027b86;p=apitrace diff --git a/trace.py b/trace.py index b50d0a6..626f2dd 100644 --- a/trace.py +++ b/trace.py @@ -23,16 +23,18 @@ # ##########################################################################/ -"""C basic types""" +"""Common trace code generation.""" -import base +import stdapi +from dispatch import Dispatcher -all_types = {} +def interface_wrap_name(interface): + return "Wrap" + interface.expr -class DumpDeclarator(base.OnceVisitor): +class DumpDeclarator(stdapi.OnceVisitor): '''Declare helper functions to dump complex types.''' def visit_void(self, literal): @@ -51,12 +53,17 @@ class DumpDeclarator(base.OnceVisitor): for type, name in struct.members: self.visit(type) print 'static void __traceStruct%s(const %s &value) {' % (struct.id, struct.expr) - print ' Log::BeginStruct("%s");' % struct.name + 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' % (int(struct.id), struct.name, len(struct.members)) + print ' };' + print ' Trace::localWriter.beginStruct(&sig);' for type, name in struct.members: - print ' Log::BeginMember("%s");' % (name,) dump_instance(type, 'value.%s' % (name,)) - print ' Log::EndMember();' - print ' Log::EndStruct();' + print ' Trace::localWriter.endStruct();' print '}' print @@ -66,33 +73,39 @@ class DumpDeclarator(base.OnceVisitor): def visit_blob(self, array): pass + __enum_id = 0 + def visit_enum(self, enum): print 'static void __traceEnum%s(const %s value) {' % (enum.id, 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 value in enum.values: + for i in range(n): + value = enum.values[i] print ' case %s:' % value - print ' Log::LiteralNamedConstant("%s", %s);' % (value, value) + print ' sig = &sig%u;' % i print ' break;' print ' default:' - print ' Log::LiteralSInt(value);' - print ' break;' + print ' Trace::localWriter.writeSInt(value);' + print ' return;' print ' }' + print ' Trace::localWriter.writeEnum(sig);' print '}' print def visit_bitmask(self, bitmask): - print 'static void __traceBitmask%s(%s value) {' % (bitmask.id, bitmask.type) - print ' Log::BeginBitmask();' + print 'static const Trace::BitmaskFlag __bitmask%s_flags[] = {' % (bitmask.id) for value in bitmask.values: - print ' if((value & %s) == %s) {' % (value, value) - print ' Log::LiteralNamedConstant("%s", %s);' % (value, value) - print ' value &= ~%s;' % value - print ' }' - print ' if(value) {' - dump_instance(bitmask.type, "value"); - print ' }' - print ' Log::EndBitmask();' - print '}' + print ' {"%s", %s},' % (value, value) + print '};' + print + print 'static const Trace::BitmaskSig __bitmask%s_sig = {' % (bitmask.id) + print ' %u, %u, __bitmask%s_flags' % (int(bitmask.id), len(bitmask.values), bitmask.id) + print '};' print def visit_pointer(self, pointer): @@ -108,20 +121,32 @@ class DumpDeclarator(base.OnceVisitor): pass def visit_interface(self, interface): - pass + 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 -class DumpImplementer(base.Visitor): +class DumpImplementer(stdapi.Visitor): '''Dump an instance.''' def visit_literal(self, literal, instance): - print ' Log::Literal%s(%s);' % (literal.format, instance) + print ' Trace::localWriter.write%s(%s);' % (literal.format, instance) def visit_string(self, string, instance): if string.length is not None: - print ' Log::LiteralString((const char *)%s, %s);' % (instance, string.length) + print ' Trace::localWriter.writeString((const char *)%s, %s);' % (instance, string.length) else: - print ' Log::LiteralString((const char *)%s);' % instance + print ' Trace::localWriter.writeString((const char *)%s);' % instance def visit_const(self, const, instance): self.visit(const.type, instance) @@ -130,38 +155,40 @@ class DumpImplementer(base.Visitor): print ' __traceStruct%s(%s);' % (struct.id, instance) def visit_array(self, array, instance): - print ' if(%s) {' % instance + length = '__c' + array.type.id index = '__i' + array.type.id - print ' Log::BeginArray(%s);' % (array.length,) - print ' for (int %s = 0; %s < %s; ++%s) {' % (index, index, array.length, index) - print ' Log::BeginElement();' + 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 ' Log::EndElement();' + print ' Trace::localWriter.endElement();' print ' }' - print ' Log::EndArray();' + print ' Trace::localWriter.endArray();' + print ' } else {' + print ' Trace::localWriter.writeNull();' print ' }' - print ' else' - print ' Log::LiteralNull();' def visit_blob(self, blob, instance): - print ' Log::LiteralBlob(%s, %s);' % (instance, blob.size) + print ' Trace::localWriter.writeBlob(%s, %s);' % (instance, blob.size) def visit_enum(self, enum, instance): print ' __traceEnum%s(%s);' % (enum.id, instance) def visit_bitmask(self, bitmask, instance): - print ' __traceBitmask%s(%s);' % (bitmask.id, instance) + print ' Trace::localWriter.writeBitmask(&__bitmask%s_sig, %s);' % (bitmask.id, instance) def visit_pointer(self, pointer, instance): - print ' if(%s) {' % instance - print ' Log::BeginArray(1);' - print ' Log::BeginElement();' + print ' if (%s) {' % instance + print ' Trace::localWriter.beginArray(1);' + print ' Trace::localWriter.beginElement();' dump_instance(pointer.type, "*" + instance) - print ' Log::EndElement();' - print ' Log::EndArray();' + print ' Trace::localWriter.endElement();' + print ' Trace::localWriter.endArray();' + print ' } else {' + print ' Trace::localWriter.writeNull();' print ' }' - print ' else' - print ' Log::LiteralNull();' def visit_handle(self, handle, instance): self.visit(handle.type, instance) @@ -170,17 +197,17 @@ class DumpImplementer(base.Visitor): self.visit(alias.type, instance) def visit_opaque(self, opaque, instance): - print ' Log::LiteralOpaque((const void *)%s);' % instance + print ' Trace::localWriter.writeOpaque((const void *)%s);' % instance def visit_interface(self, interface, instance): - print ' Log::LiteralOpaque((const void *)%s);' % instance + print ' Trace::localWriter.writeOpaque((const void *)&%s);' % instance dump_instance = DumpImplementer().visit -class Wrapper(base.Visitor): +class Wrapper(stdapi.Visitor): '''Wrap an instance.''' def visit_void(self, type, instance): @@ -213,7 +240,9 @@ class Wrapper(base.Visitor): 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) @@ -225,15 +254,22 @@ class Wrapper(base.Visitor): pass def visit_interface(self, interface, instance): - print " if(%s)" % instance - print " %s = new %s(%s);" % (instance, interface.type.wrap_name(), instance) + assert instance.startswith('*') + instance = instance[1:] + print " if (%s) {" % instance + print " %s = new %s(%s);" % (instance, interface_wrap_name(interface), instance) + print " }" class Unwrapper(Wrapper): def visit_interface(self, interface, instance): - print " if(%s)" % instance - print " %s = static_cast<%s *>(%s)->m_pInstance;" % (instance, interface.type.wrap_name(), 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 @@ -241,7 +277,12 @@ unwrap_instance = Unwrapper().visit class Tracer: + def __init__(self): + self.api = None + def trace_api(self, api): + self.api = api + self.header(api) # Includes @@ -256,10 +297,8 @@ class Tracer: print # Interfaces wrapers - map(self.interface_wrap_name, api.interfaces) - map(self.interface_pre_decl, api.interfaces) - map(self.interface_decl, api.interfaces) - map(self.interface_wrap_impl, api.interfaces) + interfaces = [type for type in types if isinstance(type, stdapi.Interface)] + map(self.interface_wrap_impl, interfaces) print # Function wrappers @@ -275,74 +314,66 @@ class Tracer: def footer(self, api): pass - def function_pointer_type(self, function): - return 'P' + function.name - - def function_pointer_value(self, function): - return 'p' + function.name - def trace_function_decl(self, function): - ptype = self.function_pointer_type(function) - pvalue = self.function_pointer_value(function) - print 'typedef ' + function.prototype('* %s' % ptype) + ';' - print 'static %s %s = NULL;' % (ptype, pvalue) - print + # Per-function declarations - def trace_function_fail(self, function): - if function.fail is not None: - if function.type is base.Void: - assert function.fail == '' - print ' return;' - else: - assert function.fail != '' - print ' return %s;' % function.fail + 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 ' Log::Abort();' - - def get_function_address(self, function): - raise NotImplementedError + print 'static const char ** __%s_args = NULL;' % (function.name,) + print 'static const Trace::FunctionSig __%s_sig = {%u, "%s", %u, __%s_args};' % (function.name, int(function.id), function.name, len(function.args), function.name) + print - def _get_true_pointer(self, function): - ptype = self.function_pointer_type(function) - pvalue = self.function_pointer_value(function) - print ' if(!%s) {' % (pvalue,) - print ' %s = (%s)%s;' % (pvalue, ptype, self.get_function_address(function)) - print ' if(!%s)' % (pvalue,) - self.trace_function_fail(function) - print ' }' + def is_public_function(self, function): + return True def trace_function_impl(self, function): - pvalue = self.function_pointer_value(function) - print function.prototype() + ' {' - if function.type is base.Void: - result = '' + 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 - result = '__result = ' - self._get_true_pointer(function) - print ' Log::BeginCall("%s");' % (function.name) + 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 ' %s%s(%s);' % (result, pvalue, ', '.join([str(arg.name) for arg in function.args])) + 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 base.Void: + if function.type is not stdapi.Void: self.dump_ret(function, "__result") - print ' Log::EndCall();' - if function.type is not base.Void: - self.wrap_ret(function, "__result") - print ' return __result;' - print '}' - print + 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 ' Log::BeginArg(%u, "%s");' % (arg.index, arg.name,) + 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) - print ' Log::EndArg();' def wrap_arg(self, function, arg): wrap_instance(arg.type, arg.name) @@ -351,9 +382,9 @@ class Tracer: unwrap_instance(arg.type, arg.name) def dump_ret(self, function, instance): - print ' Log::BeginReturn();' + print ' Trace::localWriter.beginReturn();' dump_instance(function.type, instance) - print ' Log::EndReturn();' + print ' Trace::localWriter.endReturn();' def wrap_ret(self, function, instance): wrap_instance(function.type, instance) @@ -361,33 +392,12 @@ class Tracer: def unwrap_ret(self, function, instance): unwrap_instance(function.type, instance) - def interface_wrap_name(self, interface): - return "Wrap" + interface.expr - - def interface_pre_decl(self, interface): - print "class %s;" % interface.wrap_name() - - def interface_decl(self, interface): - print "class %s : public %s " % (interface.wrap_name(), interface.name) - print "{" - print "public:" - print " %s(%s * pInstance);" % (interface.wrap_name(), interface.name) - print " virtual ~%s();" % interface.wrap_name() - print - for method in interface.itermethods(): - print " " + method.prototype() + ";" - print - #print "private:" - print " %s * m_pInstance;" % (interface.name,) - print "};" - print - def interface_wrap_impl(self, interface): - print '%s::%s(%s * pInstance) {' % (interface.wrap_name(), interface.wrap_name(), interface.name) + 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.wrap_name()) + print '%s::~%s() {' % (interface_wrap_name(interface), interface_wrap_name(interface)) print '}' print for method in interface.itermethods(): @@ -395,41 +405,89 @@ class Tracer: print def trace_method(self, interface, method): - print method.prototype(interface.wrap_name() + '::' + method.name) + ' {' - if method.type is Void: - result = '' - else: - print ' %s __result;' % method.type - result = '__result = ' - print ' Log::BeginCall("%s");' % (interface.name + '::' + method.name) - print ' Log::BeginArg(0, "this");' - print ' Log::LiteralOpaque((const void *)m_pInstance);' - print ' Log::EndArg();' + 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};' % (int(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 Void: - print ' Log::BeginReturn("%s");' % method.type + if method.type is not stdapi.Void: + print ' Trace::localWriter.beginReturn();' dump_instance(method.type, "__result") - print ' Log::EndReturn();' + print ' Trace::localWriter.endReturn();' wrap_instance(method.type, '__result') - print ' Log::EndCall();' + print ' Trace::localWriter.endLeave();' if method.name == 'QueryInterface': - print ' if (*ppvObj == m_pInstance)' - print ' *ppvObj = this;' + 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 Void + assert method.type is not stdapi.Void print ' if (!__result)' print ' delete this;' - if method.type is not Void: + 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) +