X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=wrappers%2Ftrace.py;h=10f71a4dc7a32362dfafe3d96d68705ed3578db8;hb=a78c14780294e326d79f3968f82de1e7bab412c2;hp=506570dca018ed9bc0dde652940cd33babd83fb6;hpb=bb23f3a0bad625e3c427b9de991d4a42fa22e5f0;p=apitrace diff --git a/wrappers/trace.py b/wrappers/trace.py index 506570d..10f71a4 100644 --- a/wrappers/trace.py +++ b/wrappers/trace.py @@ -83,6 +83,9 @@ class ComplexValueSerializer(stdapi.OnceVisitor): def visitArray(self, array): self.visit(array.type) + def visitAttribArray(self, array): + pass + def visitBlob(self, array): pass @@ -138,7 +141,7 @@ class ComplexValueSerializer(stdapi.OnceVisitor): def visitPolymorphic(self, polymorphic): if not polymorphic.contextLess: return - print 'static void _write__%s(int selector, const %s & value) {' % (polymorphic.tag, polymorphic.expr) + print 'static void _write__%s(int selector, %s const & value) {' % (polymorphic.tag, polymorphic.expr) print ' switch (selector) {' for cases, type in polymorphic.iterSwitch(): for case in cases: @@ -203,6 +206,69 @@ class ValueSerializer(stdapi.Visitor, stdapi.ExpanderMixin): print ' trace::localWriter.writeNull();' print ' }' + def visitAttribArray(self, array, instance): + # For each element, decide if it is a key or a value (which depends on the previous key). + # If it is a value, store it as the right type - usually int, some bitfield, or some enum. + # It is currently assumed that an unknown key means that it is followed by an int value. + + # determine the array length which must be passed to writeArray() up front + count = '_c' + array.keyType.tag + print ' {' + print ' int %s;' % count + print ' for (%(c)s = 0; %(array)s && %(array)s[%(c)s] != %(terminator)s; %(c)s += 2) {' \ + % {'c': count, 'array': instance, 'terminator': array.terminator} + if array.hasKeysWithoutValues: + print ' switch (int(%(array)s[%(c)s])) {' % {'array': instance, 'c': count} + for key, valueType in array.valueTypes: + if valueType is None: + print ' case %s:' % key + print ' %s--;' % count # the next value is a key again and checked if it's the terminator + print ' break;' + print ' }' + print ' }' + print ' %(c)s += %(array)s ? 1 : 0;' % {'c': count, 'array': instance} + print ' trace::localWriter.beginArray(%s);' % count + + # for each key / key-value pair write the key and the value, if the key requires one + + index = '_i' + array.keyType.tag + print ' for (int %(i)s = 0; %(i)s < %(count)s; %(i)s++) {' % {'i': index, 'count': count} + print ' trace::localWriter.beginElement();' + self.visitEnum(array.keyType, "%(array)s[%(i)s]" % {'array': instance, 'i': index}) + print ' trace::localWriter.endElement();' + print ' if (%(i)s + 1 >= %(count)s) {' % {'i': index, 'count': count} + print ' break;' + print ' }' + print ' switch (int(%(array)s[%(i)s++])) {' % {'array': instance, 'i': index} + # write generic value the usual way + for key, valueType in array.valueTypes: + if valueType is not None: + print ' case %s:' % key + print ' trace::localWriter.beginElement();' + self.visitElement(index, valueType, '(%(array)s)[%(i)s]' % {'array': instance, 'i': index}) + print ' trace::localWriter.endElement();' + print ' break;' + # known key with no value, just decrease the index so we treat the next value as a key + if array.hasKeysWithoutValues: + for key, valueType in array.valueTypes: + if valueType is None: + print ' case %s:' % key + print ' %s--;' % index + print ' break;' + # unknown key, write an int value + print ' default:' + print ' trace::localWriter.beginElement();' + print ' os::log("apitrace: warning: %s: unknown key 0x%04X, interpreting value as int\\n", ' + \ + '__FUNCTION__, int(%(array)s[%(i)s]));' % {'array': instance, 'i': index} + print ' trace::localWriter.writeSInt(%(array)s[%(i)s]);' % {'array': instance, 'i': index} + print ' trace::localWriter.endElement();' + print ' break;' + print ' }' + print ' }' + print ' trace::localWriter.endArray();' + print ' }' + + def visitBlob(self, blob, instance): print ' trace::localWriter.writeBlob(%s, %s);' % (instance, self.expand(blob.size)) @@ -323,7 +389,7 @@ class ValueWrapper(stdapi.Traverser, stdapi.ExpanderMixin): def visitInterfacePointer(self, interface, instance): print " if (%s) {" % instance - print " %s = new %s(%s);" % (instance, getWrapperInterfaceName(interface), instance) + print " %s = %s::_Create(__FUNCTION__, %s);" % (instance, getWrapperInterfaceName(interface), instance) print " }" def visitPolymorphic(self, type, instance): @@ -382,6 +448,9 @@ class ValueUnwrapper(ValueWrapper): class Tracer: '''Base class to orchestrate the code generation of API tracing.''' + # 0-3 are reserved to memcpy, malloc, free, and realloc + __id = 4 + def __init__(self): self.api = None @@ -436,6 +505,7 @@ class Tracer: print print '#include "trace.hpp"' print + print 'static std::map g_WrappedObjects;' def footer(self, api): pass @@ -448,9 +518,14 @@ class Tracer: 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 'static const trace::FunctionSig _%s_sig = {%u, "%s", %u, _%s_args};' % (function.name, self.getFunctionSigId(), function.name, len(function.args), function.name) print + def getFunctionSigId(self): + id = Tracer.__id + Tracer.__id += 1 + return id + def isFunctionPublic(self, function): return True @@ -465,7 +540,7 @@ class Tracer: # No-op if tracing is disabled print ' if (!trace::isTracingEnabled()) {' - Tracer.invokeFunction(self, function) + self.doInvokeFunction(function) if function.type is not stdapi.Void: print ' return _result;' else: @@ -484,6 +559,8 @@ class Tracer: for arg in function.args: if not arg.output: self.unwrapArg(function, arg) + for arg in function.args: + if not arg.output: self.serializeArg(function, arg) print ' trace::localWriter.endEnter();' self.invokeFunction(function) @@ -497,11 +574,15 @@ class Tracer: print ' }' if function.type is not stdapi.Void: self.serializeRet(function, "_result") - print ' trace::localWriter.endLeave();' if function.type is not stdapi.Void: self.wrapRet(function, "_result") + print ' trace::localWriter.endLeave();' + + def invokeFunction(self, function): + self.doInvokeFunction(function) - def invokeFunction(self, function, prefix='_', suffix=''): + def doInvokeFunction(self, function, prefix='_', suffix=''): + # Same as invokeFunction() but called both when trace is enabled or disabled. if function.type is stdapi.Void: result = '' else: @@ -555,9 +636,6 @@ class Tracer: def wrapRet(self, function, instance): self.wrapValue(function.type, instance) - def unwrapRet(self, function, instance): - self.unwrapValue(function.type, instance) - def needsWrapping(self, type): visitor = WrapDecider() visitor.visit(type) @@ -585,9 +663,11 @@ class Tracer: def declareWrapperInterface(self, interface): print "class %s : public %s " % (getWrapperInterfaceName(interface), interface.name) print "{" - print "public:" + print "private:" print " %s(%s * pInstance);" % (getWrapperInterfaceName(interface), interface.name) print " virtual ~%s();" % getWrapperInterfaceName(interface) + print "public:" + print " static %s* _Create(const char *functionName, %s * pInstance);" % (getWrapperInterfaceName(interface), interface.name) print for method in interface.iterMethods(): print " " + method.prototype() + ";" @@ -595,6 +675,11 @@ class Tracer: #print "private:" for type, name, value in self.enumWrapperInterfaceVariables(interface): print ' %s %s;' % (type, name) + for i in range(64): + print r' virtual void _dummy%i(void) const {' % i + print r' os::log("error: %s: unexpected virtual method\n");' % interface.name + print r' os::abort();' + print r' }' print "};" print @@ -602,17 +687,46 @@ class Tracer: return [ ("DWORD", "m_dwMagic", "0xd8365d6c"), ("%s *" % interface.name, "m_pInstance", "pInstance"), + ("void *", "m_pVtbl", "*(void **)pInstance"), + ("UINT", "m_NumMethods", len(list(interface.iterBaseMethods()))), ] def implementWrapperInterface(self, interface): self.interface = interface + # Private constructor print '%s::%s(%s * pInstance) {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), interface.name) for type, name, value in self.enumWrapperInterfaceVariables(interface): - print ' %s = %s;' % (name, value) + if value is not None: + print ' %s = %s;' % (name, value) + print '}' + print + + # Public constructor + print '%s *%s::_Create(const char *functionName, %s * pInstance) {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), interface.name) + print r' std::map::const_iterator it = g_WrappedObjects.find(pInstance);' + print r' if (it != g_WrappedObjects.end()) {' + print r' Wrap%s *pWrapper = (Wrap%s *)it->second;' % (interface.name, interface.name) + print r' assert(pWrapper);' + print r' assert(pWrapper->m_dwMagic == 0xd8365d6c);' + print r' assert(pWrapper->m_pInstance == pInstance);' + print r' if (pWrapper->m_pVtbl == *(void **)pInstance &&' + print r' pWrapper->m_NumMethods >= %s) {' % len(list(interface.iterBaseMethods())) + #print r' os::log("%s: fetched pvObj=%p pWrapper=%p pVtbl=%p\n", functionName, pInstance, pWrapper, pWrapper->m_pVtbl);' + print r' return pWrapper;' + print r' }' + print r' }' + print r' Wrap%s *pWrapper = new Wrap%s(pInstance);' % (interface.name, interface.name) + #print r' os::log("%%s: created %s pvObj=%%p pWrapper=%%p pVtbl=%%p\n", functionName, pInstance, pWrapper, pWrapper->m_pVtbl);' % interface.name + print r' g_WrappedObjects[pInstance] = pWrapper;' + print r' return pWrapper;' print '}' print + + # Destructor print '%s::~%s() {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface)) + #print r' os::log("%s::Release: deleted pvObj=%%p pWrapper=%%p pVtbl=%%p\n", m_pInstance, this, m_pVtbl);' % interface.name + print r' g_WrappedObjects.erase(m_pInstance);' print '}' print @@ -624,6 +738,10 @@ class Tracer: def implementWrapperInterfaceMethod(self, interface, base, method): print method.prototype(getWrapperInterfaceName(interface) + '::' + method.name) + ' {' + + if False: + print r' os::log("%%s(%%p -> %%p)\n", "%s", this, m_pInstance);' % (getWrapperInterfaceName(interface) + '::' + method.name) + if method.type is not stdapi.Void: print ' %s _result;' % method.type @@ -638,7 +756,7 @@ class Tracer: assert not method.internal 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 ' static const trace::FunctionSig _sig = {%u, "%s", %u, _args};' % (self.getFunctionSigId(), interface.name + '::' + method.name, len(method.args) + 1) print ' %s *_this = static_cast<%s *>(m_pInstance);' % (base, base) @@ -649,6 +767,8 @@ class Tracer: for arg in method.args: if not arg.output: self.unwrapArg(method, arg) + for arg in method.args: + if not arg.output: self.serializeArg(method, arg) print ' trace::localWriter.endEnter();' @@ -665,14 +785,16 @@ class Tracer: if method.type is not stdapi.Void: self.serializeRet(method, '_result') - print ' trace::localWriter.endLeave();' if method.type is not stdapi.Void: self.wrapRet(method, '_result') if method.name == 'Release': assert method.type is not stdapi.Void - print ' if (!_result)' - print ' delete this;' + print r' if (!_result) {' + print r' delete this;' + print r' }' + + print ' trace::localWriter.endLeave();' def implementIidWrapper(self, api): print r'static void' @@ -691,7 +813,7 @@ class Tracer: else_ = '' for iface in api.getAllInterfaces(): print r' %sif (riid == IID_%s) {' % (else_, iface.name) - print r' *ppvObj = new Wrap%s((%s *) *ppvObj);' % (iface.name, iface.name) + print r' *ppvObj = Wrap%s::_Create(functionName, (%s *) *ppvObj);' % (iface.name, iface.name) print r' }' else_ = 'else ' print r' %s{' % else_ @@ -731,7 +853,7 @@ class Tracer: print ' %s_this->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args])) def emit_memcpy(self, dest, src, length): - print ' unsigned _call = trace::localWriter.beginEnter(&trace::memcpy_sig);' + print ' unsigned _call = trace::localWriter.beginEnter(&trace::memcpy_sig, true);' print ' trace::localWriter.beginArg(0);' print ' trace::localWriter.writePointer((uintptr_t)%s);' % dest print ' trace::localWriter.endArg();'