git.cworth.org Git - apitrace/blob - wrappers/trace.py

   1 ##########################################################################
   2 #
   3 # Copyright 2008-2010 VMware, Inc.
   4 # All Rights Reserved.
   5 #
   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:
  12 #
  13 # The above copyright notice and this permission notice shall be included in
  14 # all copies or substantial portions of the Software.
  15 #
  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
  22 # THE SOFTWARE.
  23 #
  24 ##########################################################################/
  25
  26 """Common trace code generation."""
  27
  28
  29 # Adjust path
  30 import os.path
  31 import sys
  32 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
  33
  34
  35 import specs.stdapi as stdapi
  36
  37
  38 def getWrapperInterfaceName(interface):
  39     return "Wrap" + interface.expr
  40
  41
  42
  43 class ComplexValueSerializer(stdapi.OnceVisitor):
  44     '''Type visitors which generates serialization functions for
  45     complex types.
  46
  47     Simple types are serialized inline.
  48     '''
  49
  50     def __init__(self, serializer):
  51         stdapi.OnceVisitor.__init__(self)
  52         self.serializer = serializer
  53
  54     def visitVoid(self, literal):
  55         pass
  56
  57     def visitLiteral(self, literal):
  58         pass
  59
  60     def visitString(self, string):
  61         pass
  62
  63     def visitConst(self, const):
  64         self.visit(const.type)
  65
  66     def visitStruct(self, struct):
  67         print 'static const char * _struct%s_members[%u] = {' % (struct.tag, len(struct.members))
  68         for type, name,  in struct.members:
  69             if name is None:
  70                 print '    "",'
  71             else:
  72                 print '    "%s",' % (name,)
  73         print '};'
  74         print 'static const trace::StructSig _struct%s_sig = {' % (struct.tag,)
  75         if struct.name is None:
  76             structName = '""'
  77         else:
  78             structName = '"%s"' % struct.name
  79         print '    %u, %s, %u, _struct%s_members' % (struct.id, structName, len(struct.members), struct.tag)
  80         print '};'
  81         print
  82
  83     def visitArray(self, array):
  84         self.visit(array.type)
  85
  86     def visitBlob(self, array):
  87         pass
  88
  89     def visitEnum(self, enum):
  90         print 'static const trace::EnumValue _enum%s_values[] = {' % (enum.tag)
  91         for value in enum.values:
  92             print '    {"%s", %s},' % (value, value)
  93         print '};'
  94         print
  95         print 'static const trace::EnumSig _enum%s_sig = {' % (enum.tag)
  96         print '    %u, %u, _enum%s_values' % (enum.id, len(enum.values), enum.tag)
  97         print '};'
  98         print
  99
 100     def visitBitmask(self, bitmask):
 101         print 'static const trace::BitmaskFlag _bitmask%s_flags[] = {' % (bitmask.tag)
 102         for value in bitmask.values:
 103             print '    {"%s", %s},' % (value, value)
 104         print '};'
 105         print
 106         print 'static const trace::BitmaskSig _bitmask%s_sig = {' % (bitmask.tag)
 107         print '    %u, %u, _bitmask%s_flags' % (bitmask.id, len(bitmask.values), bitmask.tag)
 108         print '};'
 109         print
 110
 111     def visitPointer(self, pointer):
 112         self.visit(pointer.type)
 113
 114     def visitIntPointer(self, pointer):
 115         pass
 116
 117     def visitObjPointer(self, pointer):
 118         self.visit(pointer.type)
 119
 120     def visitLinearPointer(self, pointer):
 121         self.visit(pointer.type)
 122
 123     def visitHandle(self, handle):
 124         self.visit(handle.type)
 125
 126     def visitReference(self, reference):
 127         self.visit(reference.type)
 128
 129     def visitAlias(self, alias):
 130         self.visit(alias.type)
 131
 132     def visitOpaque(self, opaque):
 133         pass
 134
 135     def visitInterface(self, interface):
 136         pass
 137
 138     def visitPolymorphic(self, polymorphic):
 139         if not polymorphic.contextLess:
 140             return
 141         print 'static void _write__%s(int selector, %s const & value) {' % (polymorphic.tag, polymorphic.expr)
 142         print '    switch (selector) {'
 143         for cases, type in polymorphic.iterSwitch():
 144             for case in cases:
 145                 print '    %s:' % case
 146             self.serializer.visit(type, 'static_cast<%s>(value)' % (type,))
 147             print '        break;'
 148         print '    }'
 149         print '}'
 150         print
 151
 152
 153 class ValueSerializer(stdapi.Visitor, stdapi.ExpanderMixin):
 154     '''Visitor which generates code to serialize any type.
 155
 156     Simple types are serialized inline here, whereas the serialization of
 157     complex types is dispatched to the serialization functions generated by
 158     ComplexValueSerializer visitor above.
 159     '''
 160
 161     def visitLiteral(self, literal, instance):
 162         print '    trace::localWriter.write%s(%s);' % (literal.kind, instance)
 163
 164     def visitString(self, string, instance):
 165         if not string.wide:
 166             cast = 'const char *'
 167             suffix = 'String'
 168         else:
 169             cast = 'const wchar_t *'
 170             suffix = 'WString'
 171         if cast != string.expr:
 172             # reinterpret_cast is necessary for GLubyte * <=> char *
 173             instance = 'reinterpret_cast<%s>(%s)' % (cast, instance)
 174         if string.length is not None:
 175             length = ', %s' % self.expand(string.length)
 176         else:
 177             length = ''
 178         print '    trace::localWriter.write%s(%s%s);' % (suffix, instance, length)
 179
 180     def visitConst(self, const, instance):
 181         self.visit(const.type, instance)
 182
 183     def visitStruct(self, struct, instance):
 184         print '    trace::localWriter.beginStruct(&_struct%s_sig);' % (struct.tag,)
 185         for member in struct.members:
 186             self.visitMember(member, instance)
 187         print '    trace::localWriter.endStruct();'
 188
 189     def visitArray(self, array, instance):
 190         length = '_c' + array.type.tag
 191         index = '_i' + array.type.tag
 192         array_length = self.expand(array.length)
 193         print '    if (%s) {' % instance
 194         print '        size_t %s = %s > 0 ? %s : 0;' % (length, array_length, array_length)
 195         print '        trace::localWriter.beginArray(%s);' % length
 196         print '        for (size_t %s = 0; %s < %s; ++%s) {' % (index, index, length, index)
 197         print '            trace::localWriter.beginElement();'
 198         self.visitElement(index, array.type, '(%s)[%s]' % (instance, index))
 199         print '            trace::localWriter.endElement();'
 200         print '        }'
 201         print '        trace::localWriter.endArray();'
 202         print '    } else {'
 203         print '        trace::localWriter.writeNull();'
 204         print '    }'
 205
 206     def visitBlob(self, blob, instance):
 207         print '    trace::localWriter.writeBlob(%s, %s);' % (instance, self.expand(blob.size))
 208
 209     def visitEnum(self, enum, instance):
 210         print '    trace::localWriter.writeEnum(&_enum%s_sig, %s);' % (enum.tag, instance)
 211
 212     def visitBitmask(self, bitmask, instance):
 213         print '    trace::localWriter.writeBitmask(&_bitmask%s_sig, %s);' % (bitmask.tag, instance)
 214
 215     def visitPointer(self, pointer, instance):
 216         print '    if (%s) {' % instance
 217         print '        trace::localWriter.beginArray(1);'
 218         print '        trace::localWriter.beginElement();'
 219         self.visit(pointer.type, "*" + instance)
 220         print '        trace::localWriter.endElement();'
 221         print '        trace::localWriter.endArray();'
 222         print '    } else {'
 223         print '        trace::localWriter.writeNull();'
 224         print '    }'
 225
 226     def visitIntPointer(self, pointer, instance):
 227         print '    trace::localWriter.writePointer((uintptr_t)%s);' % instance
 228
 229     def visitObjPointer(self, pointer, instance):
 230         print '    trace::localWriter.writePointer((uintptr_t)%s);' % instance
 231
 232     def visitLinearPointer(self, pointer, instance):
 233         print '    trace::localWriter.writePointer((uintptr_t)%s);' % instance
 234
 235     def visitReference(self, reference, instance):
 236         self.visit(reference.type, instance)
 237
 238     def visitHandle(self, handle, instance):
 239         self.visit(handle.type, instance)
 240
 241     def visitAlias(self, alias, instance):
 242         self.visit(alias.type, instance)
 243
 244     def visitOpaque(self, opaque, instance):
 245         print '    trace::localWriter.writePointer((uintptr_t)%s);' % instance
 246
 247     def visitInterface(self, interface, instance):
 248         assert False
 249
 250     def visitPolymorphic(self, polymorphic, instance):
 251         if polymorphic.contextLess:
 252             print '    _write__%s(%s, %s);' % (polymorphic.tag, polymorphic.switchExpr, instance)
 253         else:
 254             switchExpr = self.expand(polymorphic.switchExpr)
 255             print '    switch (%s) {' % switchExpr
 256             for cases, type in polymorphic.iterSwitch():
 257                 for case in cases:
 258                     print '    %s:' % case
 259                 caseInstance = instance
 260                 if type.expr is not None:
 261                     caseInstance = 'static_cast<%s>(%s)' % (type, caseInstance)
 262                 self.visit(type, caseInstance)
 263                 print '        break;'
 264             if polymorphic.defaultType is None:
 265                 print r'    default:'
 266                 print r'        os::log("apitrace: warning: %%s: unexpected polymorphic case %%i\n", __FUNCTION__, (int)%s);' % (switchExpr,)
 267                 print r'        trace::localWriter.writeNull();'
 268                 print r'        break;'
 269             print '    }'
 270
 271
 272 class WrapDecider(stdapi.Traverser):
 273     '''Type visitor which will decide wheter this type will need wrapping or not.
 274
 275     For complex types (arrays, structures), we need to know this before hand.
 276     '''
 277
 278     def __init__(self):
 279         self.needsWrapping = False
 280
 281     def visitLinearPointer(self, void):
 282         pass
 283
 284     def visitInterface(self, interface):
 285         self.needsWrapping = True
 286
 287
 288 class ValueWrapper(stdapi.Traverser, stdapi.ExpanderMixin):
 289     '''Type visitor which will generate the code to wrap an instance.
 290
 291     Wrapping is necessary mostly for interfaces, however interface pointers can
 292     appear anywhere inside complex types.
 293     '''
 294
 295     def visitStruct(self, struct, instance):
 296         for member in struct.members:
 297             self.visitMember(member, instance)
 298
 299     def visitArray(self, array, instance):
 300         array_length = self.expand(array.length)
 301         print "    if (%s) {" % instance
 302         print "        for (size_t _i = 0, _s = %s; _i < _s; ++_i) {" % array_length
 303         self.visitElement('_i', array.type, instance + "[_i]")
 304         print "        }"
 305         print "    }"
 306
 307     def visitPointer(self, pointer, instance):
 308         print "    if (%s) {" % instance
 309         self.visit(pointer.type, "*" + instance)
 310         print "    }"
 311
 312     def visitObjPointer(self, pointer, instance):
 313         elem_type = pointer.type.mutable()
 314         if isinstance(elem_type, stdapi.Interface):
 315             self.visitInterfacePointer(elem_type, instance)
 316         elif isinstance(elem_type, stdapi.Alias) and isinstance(elem_type.type, stdapi.Interface):
 317             self.visitInterfacePointer(elem_type.type, instance)
 318         else:
 319             self.visitPointer(pointer, instance)
 320
 321     def visitInterface(self, interface, instance):
 322         raise NotImplementedError
 323
 324     def visitInterfacePointer(self, interface, instance):
 325         print "    if (%s) {" % instance
 326         print "        %s = %s::_Create(__FUNCTION__, %s);" % (instance, getWrapperInterfaceName(interface), instance)
 327         print "    }"
 328
 329     def visitPolymorphic(self, type, instance):
 330         # XXX: There might be polymorphic values that need wrapping in the future
 331         raise NotImplementedError
 332
 333
 334 class ValueUnwrapper(ValueWrapper):
 335     '''Reverse of ValueWrapper.'''
 336
 337     allocated = False
 338
 339     def visitStruct(self, struct, instance):
 340         if not self.allocated:
 341             # Argument is constant. We need to create a non const
 342             print '    {'
 343             print "        %s * _t = static_cast<%s *>(alloca(sizeof *_t));" % (struct, struct)
 344             print '        *_t = %s;' % (instance,)
 345             assert instance.startswith('*')
 346             print '        %s = _t;' % (instance[1:],)
 347             instance = '*_t'
 348             self.allocated = True
 349             try:
 350                 return ValueWrapper.visitStruct(self, struct, instance)
 351             finally:
 352                 print '    }'
 353         else:
 354             return ValueWrapper.visitStruct(self, struct, instance)
 355
 356     def visitArray(self, array, instance):
 357         if self.allocated or isinstance(instance, stdapi.Interface):
 358             return ValueWrapper.visitArray(self, array, instance)
 359         array_length = self.expand(array.length)
 360         elem_type = array.type.mutable()
 361         print "    if (%s && %s) {" % (instance, array_length)
 362         print "        %s * _t = static_cast<%s *>(alloca(%s * sizeof *_t));" % (elem_type, elem_type, array_length)
 363         print "        for (size_t _i = 0, _s = %s; _i < _s; ++_i) {" % array_length
 364         print "            _t[_i] = %s[_i];" % instance
 365         self.allocated = True
 366         self.visit(array.type, "_t[_i]")
 367         print "        }"
 368         print "        %s = _t;" % instance
 369         print "    }"
 370
 371     def visitInterfacePointer(self, interface, instance):
 372         print r'    if (%s) {' % instance
 373         print r'        const %s *pWrapper = static_cast<const %s*>(%s);' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), instance)
 374         print r'        if (pWrapper && pWrapper->m_dwMagic == 0xd8365d6c) {'
 375         print r'            %s = pWrapper->m_pInstance;' % (instance,)
 376         print r'        } else {'
 377         print r'            os::log("apitrace: warning: %%s: unexpected %%s pointer\n", __FUNCTION__, "%s");' % interface.name
 378         print r'        }'
 379         print r'    }'
 380
 381
 382 class Tracer:
 383     '''Base class to orchestrate the code generation of API tracing.'''
 384
 385     # 0-3 are reserved to memcpy, malloc, free, and realloc
 386     __id = 4
 387
 388     def __init__(self):
 389         self.api = None
 390
 391     def serializerFactory(self):
 392         '''Create a serializer.
 393
 394         Can be overriden by derived classes to inject their own serialzer.
 395         '''
 396
 397         return ValueSerializer()
 398
 399     def traceApi(self, api):
 400         self.api = api
 401
 402         self.header(api)
 403
 404         # Includes
 405         for module in api.modules:
 406             for header in module.headers:
 407                 print header
 408         print
 409
 410         # Generate the serializer functions
 411         types = api.getAllTypes()
 412         visitor = ComplexValueSerializer(self.serializerFactory())
 413         map(visitor.visit, types)
 414         print
 415
 416         # Interfaces wrapers
 417         self.traceInterfaces(api)
 418
 419         # Function wrappers
 420         self.interface = None
 421         self.base = None
 422         for function in api.getAllFunctions():
 423             self.traceFunctionDecl(function)
 424         for function in api.getAllFunctions():
 425             self.traceFunctionImpl(function)
 426         print
 427
 428         self.footer(api)
 429
 430     def header(self, api):
 431         print '#ifdef _WIN32'
 432         print '#  include <malloc.h> // alloca'
 433         print '#  ifndef alloca'
 434         print '#    define alloca _alloca'
 435         print '#  endif'
 436         print '#else'
 437         print '#  include <alloca.h> // alloca'
 438         print '#endif'
 439         print
 440         print '#include "trace.hpp"'
 441         print
 442         print 'static std::map<void *, void *> g_WrappedObjects;'
 443
 444     def footer(self, api):
 445         pass
 446
 447     def traceFunctionDecl(self, function):
 448         # Per-function declarations
 449
 450         if not function.internal:
 451             if function.args:
 452                 print 'static const char * _%s_args[%u] = {%s};' % (function.name, len(function.args), ', '.join(['"%s"' % arg.name for arg in function.args]))
 453             else:
 454                 print 'static const char ** _%s_args = NULL;' % (function.name,)
 455             print 'static const trace::FunctionSig _%s_sig = {%u, "%s", %u, _%s_args};' % (function.name, self.getFunctionSigId(), function.name, len(function.args), function.name)
 456             print
 457
 458     def getFunctionSigId(self):
 459         id = Tracer.__id
 460         Tracer.__id += 1
 461         return id
 462
 463     def isFunctionPublic(self, function):
 464         return True
 465
 466     def traceFunctionImpl(self, function):
 467         if self.isFunctionPublic(function):
 468             print 'extern "C" PUBLIC'
 469         else:
 470             print 'extern "C" PRIVATE'
 471         print function.prototype() + ' {'
 472         if function.type is not stdapi.Void:
 473             print '    %s _result;' % function.type
 474
 475         # No-op if tracing is disabled
 476         print '    if (!trace::isTracingEnabled()) {'
 477         self.doInvokeFunction(function)
 478         if function.type is not stdapi.Void:
 479             print '        return _result;'
 480         else:
 481             print '        return;'
 482         print '    }'
 483
 484         self.traceFunctionImplBody(function)
 485         if function.type is not stdapi.Void:
 486             print '    return _result;'
 487         print '}'
 488         print
 489
 490     def traceFunctionImplBody(self, function):
 491         if not function.internal:
 492             print '    unsigned _call = trace::localWriter.beginEnter(&_%s_sig);' % (function.name,)
 493             for arg in function.args:
 494                 if not arg.output:
 495                     self.unwrapArg(function, arg)
 496             for arg in function.args:
 497                 if not arg.output:
 498                     self.serializeArg(function, arg)
 499             print '    trace::localWriter.endEnter();'
 500         self.invokeFunction(function)
 501         if not function.internal:
 502             print '    trace::localWriter.beginLeave(_call);'
 503             print '    if (%s) {' % self.wasFunctionSuccessful(function)
 504             for arg in function.args:
 505                 if arg.output:
 506                     self.serializeArg(function, arg)
 507                     self.wrapArg(function, arg)
 508             print '    }'
 509             if function.type is not stdapi.Void:
 510                 self.serializeRet(function, "_result")
 511             if function.type is not stdapi.Void:
 512                 self.wrapRet(function, "_result")
 513             print '    trace::localWriter.endLeave();'
 514
 515     def invokeFunction(self, function):
 516         self.doInvokeFunction(function)
 517
 518     def doInvokeFunction(self, function, prefix='_', suffix=''):
 519         # Same as invokeFunction() but called both when trace is enabled or disabled.
 520         if function.type is stdapi.Void:
 521             result = ''
 522         else:
 523             result = '_result = '
 524         dispatch = prefix + function.name + suffix
 525         print '    %s%s(%s);' % (result, dispatch, ', '.join([str(arg.name) for arg in function.args]))
 526
 527     def wasFunctionSuccessful(self, function):
 528         if function.type is stdapi.Void:
 529             return 'true'
 530         if str(function.type) == 'HRESULT':
 531             return 'SUCCEEDED(_result)'
 532         return 'true'
 533
 534     def serializeArg(self, function, arg):
 535         print '    trace::localWriter.beginArg(%u);' % (arg.index,)
 536         self.serializeArgValue(function, arg)
 537         print '    trace::localWriter.endArg();'
 538
 539     def serializeArgValue(self, function, arg):
 540         self.serializeValue(arg.type, arg.name)
 541
 542     def wrapArg(self, function, arg):
 543         assert not isinstance(arg.type, stdapi.ObjPointer)
 544
 545         from specs.winapi import REFIID
 546         riid = None
 547         for other_arg in function.args:
 548             if not other_arg.output and other_arg.type is REFIID:
 549                 riid = other_arg
 550         if riid is not None \
 551            and isinstance(arg.type, stdapi.Pointer) \
 552            and isinstance(arg.type.type, stdapi.ObjPointer):
 553             self.wrapIid(function, riid, arg)
 554             return
 555
 556         self.wrapValue(arg.type, arg.name)
 557
 558     def unwrapArg(self, function, arg):
 559         self.unwrapValue(arg.type, arg.name)
 560
 561     def serializeRet(self, function, instance):
 562         print '    trace::localWriter.beginReturn();'
 563         self.serializeValue(function.type, instance)
 564         print '    trace::localWriter.endReturn();'
 565
 566     def serializeValue(self, type, instance):
 567         serializer = self.serializerFactory()
 568         serializer.visit(type, instance)
 569
 570     def wrapRet(self, function, instance):
 571         self.wrapValue(function.type, instance)
 572
 573     def needsWrapping(self, type):
 574         visitor = WrapDecider()
 575         visitor.visit(type)
 576         return visitor.needsWrapping
 577
 578     def wrapValue(self, type, instance):
 579         if self.needsWrapping(type):
 580             visitor = ValueWrapper()
 581             visitor.visit(type, instance)
 582
 583     def unwrapValue(self, type, instance):
 584         if self.needsWrapping(type):
 585             visitor = ValueUnwrapper()
 586             visitor.visit(type, instance)
 587
 588     def traceInterfaces(self, api):
 589         interfaces = api.getAllInterfaces()
 590         if not interfaces:
 591             return
 592         map(self.declareWrapperInterface, interfaces)
 593         self.implementIidWrapper(api)
 594         map(self.implementWrapperInterface, interfaces)
 595         print
 596
 597     def declareWrapperInterface(self, interface):
 598         print "class %s : public %s " % (getWrapperInterfaceName(interface), interface.name)
 599         print "{"
 600         print "private:"
 601         print "    %s(%s * pInstance);" % (getWrapperInterfaceName(interface), interface.name)
 602         print "    virtual ~%s();" % getWrapperInterfaceName(interface)
 603         print "public:"
 604         print "    static %s* _Create(const char *functionName, %s * pInstance);" % (getWrapperInterfaceName(interface), interface.name)
 605         print
 606         for method in interface.iterMethods():
 607             print "    " + method.prototype() + ";"
 608         print
 609         #print "private:"
 610         for type, name, value in self.enumWrapperInterfaceVariables(interface):
 611             print '    %s %s;' % (type, name)
 612         for i in range(64):
 613             print r'    virtual void _dummy%i(void) const {' % i
 614             print r'        os::log("error: %s: unexpected virtual method\n");' % interface.name
 615             print r'        os::abort();'
 616             print r'    }'
 617         print "};"
 618         print
 619
 620     def enumWrapperInterfaceVariables(self, interface):
 621         return [
 622             ("DWORD", "m_dwMagic", "0xd8365d6c"),
 623             ("%s *" % interface.name, "m_pInstance", "pInstance"),
 624             ("void *", "m_pVtbl", "*(void **)pInstance"),
 625             ("UINT", "m_NumMethods", len(list(interface.iterBaseMethods()))),
 626         ]
 627
 628     def implementWrapperInterface(self, interface):
 629         self.interface = interface
 630
 631         # Private constructor
 632         print '%s::%s(%s * pInstance) {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), interface.name)
 633         for type, name, value in self.enumWrapperInterfaceVariables(interface):
 634             if value is not None:
 635                 print '    %s = %s;' % (name, value)
 636         print '}'
 637         print
 638
 639         # Public constructor
 640         print '%s *%s::_Create(const char *functionName, %s * pInstance) {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface), interface.name)
 641         print r'    std::map<void *, void *>::const_iterator it = g_WrappedObjects.find(pInstance);'
 642         print r'    if (it != g_WrappedObjects.end()) {'
 643         print r'        Wrap%s *pWrapper = (Wrap%s *)it->second;' % (interface.name, interface.name)
 644         print r'        assert(pWrapper);'
 645         print r'        assert(pWrapper->m_dwMagic == 0xd8365d6c);'
 646         print r'        assert(pWrapper->m_pInstance == pInstance);'
 647         print r'        if (pWrapper->m_pVtbl == *(void **)pInstance &&'
 648         print r'            pWrapper->m_NumMethods >= %s) {' % len(list(interface.iterBaseMethods()))
 649         #print r'            os::log("%s: fetched pvObj=%p pWrapper=%p pVtbl=%p\n", functionName, pInstance, pWrapper, pWrapper->m_pVtbl);'
 650         print r'            return pWrapper;'
 651         print r'        }'
 652         print r'    }'
 653         print r'    Wrap%s *pWrapper = new Wrap%s(pInstance);' % (interface.name, interface.name)
 654         #print r'    os::log("%%s: created %s pvObj=%%p pWrapper=%%p pVtbl=%%p\n", functionName, pInstance, pWrapper, pWrapper->m_pVtbl);' % interface.name
 655         print r'    g_WrappedObjects[pInstance] = pWrapper;'
 656         print r'    return pWrapper;'
 657         print '}'
 658         print
 659
 660         # Destructor
 661         print '%s::~%s() {' % (getWrapperInterfaceName(interface), getWrapperInterfaceName(interface))
 662         #print r'        os::log("%s::Release: deleted pvObj=%%p pWrapper=%%p pVtbl=%%p\n", m_pInstance, this, m_pVtbl);' % interface.name
 663         print r'        g_WrappedObjects.erase(m_pInstance);'
 664         print '}'
 665         print
 666
 667         for base, method in interface.iterBaseMethods():
 668             self.base = base
 669             self.implementWrapperInterfaceMethod(interface, base, method)
 670
 671         print
 672
 673     def implementWrapperInterfaceMethod(self, interface, base, method):
 674         print method.prototype(getWrapperInterfaceName(interface) + '::' + method.name) + ' {'
 675
 676         if False:
 677             print r'    os::log("%%s(%%p -> %%p)\n", "%s", this, m_pInstance);' % (getWrapperInterfaceName(interface) + '::' + method.name)
 678
 679         if method.type is not stdapi.Void:
 680             print '    %s _result;' % method.type
 681
 682         self.implementWrapperInterfaceMethodBody(interface, base, method)
 683
 684         if method.type is not stdapi.Void:
 685             print '    return _result;'
 686         print '}'
 687         print
 688
 689     def implementWrapperInterfaceMethodBody(self, interface, base, method):
 690         assert not method.internal
 691
 692         print '    static const char * _args[%u] = {%s};' % (len(method.args) + 1, ', '.join(['"this"'] + ['"%s"' % arg.name for arg in method.args]))
 693         print '    static const trace::FunctionSig _sig = {%u, "%s", %u, _args};' % (self.getFunctionSigId(), interface.name + '::' + method.name, len(method.args) + 1)
 694
 695         print '    %s *_this = static_cast<%s *>(m_pInstance);' % (base, base)
 696
 697         print '    unsigned _call = trace::localWriter.beginEnter(&_sig);'
 698         print '    trace::localWriter.beginArg(0);'
 699         print '    trace::localWriter.writePointer((uintptr_t)m_pInstance);'
 700         print '    trace::localWriter.endArg();'
 701         for arg in method.args:
 702             if not arg.output:
 703                 self.unwrapArg(method, arg)
 704         for arg in method.args:
 705             if not arg.output:
 706                 self.serializeArg(method, arg)
 707         print '    trace::localWriter.endEnter();'
 708
 709         self.invokeMethod(interface, base, method)
 710
 711         print '    trace::localWriter.beginLeave(_call);'
 712
 713         print '    if (%s) {' % self.wasFunctionSuccessful(method)
 714         for arg in method.args:
 715             if arg.output:
 716                 self.serializeArg(method, arg)
 717                 self.wrapArg(method, arg)
 718         print '    }'
 719
 720         if method.type is not stdapi.Void:
 721             self.serializeRet(method, '_result')
 722         if method.type is not stdapi.Void:
 723             self.wrapRet(method, '_result')
 724
 725         if method.name == 'Release':
 726             assert method.type is not stdapi.Void
 727             print r'    if (!_result) {'
 728             print r'        delete this;'
 729             print r'    }'
 730
 731         print '    trace::localWriter.endLeave();'
 732
 733     def implementIidWrapper(self, api):
 734         print r'static void'
 735         print r'warnIID(const char *functionName, REFIID riid, const char *reason) {'
 736         print r'    os::log("apitrace: warning: %s: %s IID {0x%08lX,0x%04X,0x%04X,{0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X,0x%02X}}\n",'
 737         print r'            functionName, reason,'
 738         print r'            riid.Data1, riid.Data2, riid.Data3,'
 739         print r'            riid.Data4[0], riid.Data4[1], riid.Data4[2], riid.Data4[3], riid.Data4[4], riid.Data4[5], riid.Data4[6], riid.Data4[7]);'
 740         print r'}'
 741         print
 742         print r'static void'
 743         print r'wrapIID(const char *functionName, REFIID riid, void * * ppvObj) {'
 744         print r'    if (!ppvObj || !*ppvObj) {'
 745         print r'        return;'
 746         print r'    }'
 747         else_ = ''
 748         for iface in api.getAllInterfaces():
 749             print r'    %sif (riid == IID_%s) {' % (else_, iface.name)
 750             print r'        *ppvObj = Wrap%s::_Create(functionName, (%s *) *ppvObj);' % (iface.name, iface.name)
 751             print r'    }'
 752             else_ = 'else '
 753         print r'    %s{' % else_
 754         print r'        warnIID(functionName, riid, "unknown");'
 755         print r'    }'
 756         print r'}'
 757         print
 758
 759     def wrapIid(self, function, riid, out):
 760         # Cast output arg to `void **` if necessary
 761         out_name = out.name
 762         obj_type = out.type.type.type
 763         if not obj_type is stdapi.Void:
 764             assert isinstance(obj_type, stdapi.Interface)
 765             out_name = 'reinterpret_cast<void * *>(%s)' % out_name
 766
 767         print r'    if (%s && *%s) {' % (out.name, out.name)
 768         functionName = function.name
 769         else_ = ''
 770         if self.interface is not None:
 771             functionName = self.interface.name + '::' + functionName
 772             print r'        if (*%s == m_pInstance &&' % (out_name,)
 773             print r'            (%s)) {' % ' || '.join('%s == IID_%s' % (riid.name, iface.name) for iface in self.interface.iterBases())
 774             print r'            *%s = this;' % (out_name,)
 775             print r'        }'
 776             else_ = 'else '
 777         print r'        %s{' % else_
 778         print r'             wrapIID("%s", %s, %s);' % (functionName, riid.name, out_name)
 779         print r'        }'
 780         print r'    }'
 781
 782     def invokeMethod(self, interface, base, method):
 783         if method.type is stdapi.Void:
 784             result = ''
 785         else:
 786             result = '_result = '
 787         print '    %s_this->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args]))
 788
 789     def emit_memcpy(self, dest, src, length):
 790         print '        unsigned _call = trace::localWriter.beginEnter(&trace::memcpy_sig, true);'
 791         print '        trace::localWriter.beginArg(0);'
 792         print '        trace::localWriter.writePointer((uintptr_t)%s);' % dest
 793         print '        trace::localWriter.endArg();'
 794         print '        trace::localWriter.beginArg(1);'
 795         print '        trace::localWriter.writeBlob(%s, %s);' % (src, length)
 796         print '        trace::localWriter.endArg();'
 797         print '        trace::localWriter.beginArg(2);'
 798         print '        trace::localWriter.writeUInt(%s);' % length
 799         print '        trace::localWriter.endArg();'
 800         print '        trace::localWriter.endEnter();'
 801         print '        trace::localWriter.beginLeave(_call);'
 802         print '        trace::localWriter.endLeave();'
 803
 804     def fake_call(self, function, args):
 805         print '            unsigned _fake_call = trace::localWriter.beginEnter(&_%s_sig);' % (function.name,)
 806         for arg, instance in zip(function.args, args):
 807             assert not arg.output
 808             print '            trace::localWriter.beginArg(%u);' % (arg.index,)
 809             self.serializeValue(arg.type, instance)
 810             print '            trace::localWriter.endArg();'
 811         print '            trace::localWriter.endEnter();'
 812         print '            trace::localWriter.beginLeave(_fake_call);'
 813         print '            trace::localWriter.endLeave();'
 814