git.cworth.org Git - apitrace/blob - 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 import stdapi
  30 from dispatch import Dispatcher
  31
  32
  33 def interface_wrap_name(interface):
  34     return "Wrap" + interface.expr
  35
  36
  37 class DumpDeclarator(stdapi.OnceVisitor):
  38     '''Declare helper functions to dump complex types.'''
  39
  40     def visit_void(self, literal):
  41         pass
  42
  43     def visit_literal(self, literal):
  44         pass
  45
  46     def visit_string(self, string):
  47         pass
  48
  49     def visit_const(self, const):
  50         self.visit(const.type)
  51
  52     def visit_struct(self, struct):
  53         for type, name in struct.members:
  54             self.visit(type)
  55         print 'static void __traceStruct%s(const %s &value) {' % (struct.id, struct.expr)
  56         print '    static const char * members[%u] = {' % (len(struct.members),)
  57         for type, name,  in struct.members:
  58             print '        "%s",' % (name,)
  59         print '    };'
  60         print '    static const Trace::StructSig sig = {'
  61         print '       %u, "%s", %u, members' % (int(struct.id), struct.name, len(struct.members))
  62         print '    };'
  63         print '    Trace::BeginStruct(&sig);'
  64         for type, name in struct.members:
  65             dump_instance(type, 'value.%s' % (name,))
  66         print '    Trace::EndStruct();'
  67         print '}'
  68         print
  69
  70     def visit_array(self, array):
  71         self.visit(array.type)
  72
  73     def visit_blob(self, array):
  74         pass
  75
  76     __enum_id = 0
  77
  78     def visit_enum(self, enum):
  79         print 'static void __traceEnum%s(const %s value) {' % (enum.id, enum.expr)
  80         n = len(enum.values)
  81         for i in range(n):
  82             value = enum.values[i]
  83             print '    static const Trace::EnumSig sig%u = {%u, "%s", %s};' % (i, DumpDeclarator.__enum_id, value, value)
  84             DumpDeclarator.__enum_id += 1
  85         print '    const Trace::EnumSig *sig;'
  86         print '    switch(value) {'
  87         for i in range(n):
  88             value = enum.values[i]
  89             print '    case %s:' % value
  90             print '        sig = &sig%u;' % i
  91             print '        break;'
  92         print '    default:'
  93         print '        Trace::LiteralSInt(value);'
  94         print '        return;'
  95         print '    }'
  96         print '    Trace::LiteralEnum(sig);'
  97         print '}'
  98         print
  99
 100     def visit_bitmask(self, bitmask):
 101         print 'static const Trace::BitmaskVal __bitmask%s_vals[] = {' % (bitmask.id)
 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.id)
 107         print '   %u, %u, __bitmask%s_vals' % (int(bitmask.id), len(bitmask.values), bitmask.id)
 108         print '};'
 109         print
 110
 111     def visit_pointer(self, pointer):
 112         self.visit(pointer.type)
 113
 114     def visit_handle(self, handle):
 115         self.visit(handle.type)
 116
 117     def visit_alias(self, alias):
 118         self.visit(alias.type)
 119
 120     def visit_opaque(self, opaque):
 121         pass
 122
 123     def visit_interface(self, interface):
 124         print "class %s : public %s " % (interface_wrap_name(interface), interface.name)
 125         print "{"
 126         print "public:"
 127         print "    %s(%s * pInstance);" % (interface_wrap_name(interface), interface.name)
 128         print "    virtual ~%s();" % interface_wrap_name(interface)
 129         print
 130         for method in interface.itermethods():
 131             print "    " + method.prototype() + ";"
 132         print
 133         #print "private:"
 134         print "    %s * m_pInstance;" % (interface.name,)
 135         print "};"
 136         print
 137
 138
 139 class DumpImplementer(stdapi.Visitor):
 140     '''Dump an instance.'''
 141
 142     def visit_literal(self, literal, instance):
 143         print '    Trace::Literal%s(%s);' % (literal.format, instance)
 144
 145     def visit_string(self, string, instance):
 146         if string.length is not None:
 147             print '    Trace::LiteralString((const char *)%s, %s);' % (instance, string.length)
 148         else:
 149             print '    Trace::LiteralString((const char *)%s);' % instance
 150
 151     def visit_const(self, const, instance):
 152         self.visit(const.type, instance)
 153
 154     def visit_struct(self, struct, instance):
 155         print '    __traceStruct%s(%s);' % (struct.id, instance)
 156
 157     def visit_array(self, array, instance):
 158         print '    if (%s) {' % instance
 159         index = '__i' + array.type.id
 160         print '        Trace::BeginArray(%s);' % (array.length,)
 161         print '        for (int %s = 0; %s < %s; ++%s) {' % (index, index, array.length, index)
 162         print '            Trace::BeginElement();'
 163         self.visit(array.type, '(%s)[%s]' % (instance, index))
 164         print '            Trace::EndElement();'
 165         print '        }'
 166         print '        Trace::EndArray();'
 167         print '    }'
 168         print '    else'
 169         print '        Trace::LiteralNull();'
 170
 171     def visit_blob(self, blob, instance):
 172         print '    Trace::LiteralBlob(%s, %s);' % (instance, blob.size)
 173
 174     def visit_enum(self, enum, instance):
 175         print '    __traceEnum%s(%s);' % (enum.id, instance)
 176
 177     def visit_bitmask(self, bitmask, instance):
 178         print '    Trace::LiteralBitmask(__bitmask%s_sig, %s);' % (bitmask.id, instance)
 179
 180     def visit_pointer(self, pointer, instance):
 181         print '    if (%s) {' % instance
 182         print '        Trace::BeginArray(1);'
 183         print '        Trace::BeginElement();'
 184         dump_instance(pointer.type, "*" + instance)
 185         print '        Trace::EndElement();'
 186         print '        Trace::EndArray();'
 187         print '    }'
 188         print '    else'
 189         print '        Trace::LiteralNull();'
 190
 191     def visit_handle(self, handle, instance):
 192         self.visit(handle.type, instance)
 193
 194     def visit_alias(self, alias, instance):
 195         self.visit(alias.type, instance)
 196
 197     def visit_opaque(self, opaque, instance):
 198         print '    Trace::LiteralOpaque((const void *)%s);' % instance
 199
 200     def visit_interface(self, interface, instance):
 201         print '    Trace::LiteralOpaque((const void *)&%s);' % instance
 202
 203
 204 dump_instance = DumpImplementer().visit
 205
 206
 207
 208 class Wrapper(stdapi.Visitor):
 209     '''Wrap an instance.'''
 210
 211     def visit_void(self, type, instance):
 212         raise NotImplementedError
 213
 214     def visit_literal(self, type, instance):
 215         pass
 216
 217     def visit_string(self, type, instance):
 218         pass
 219
 220     def visit_const(self, type, instance):
 221         pass
 222
 223     def visit_struct(self, struct, instance):
 224         for type, name in struct.members:
 225             self.visit(type, "(%s).%s" % (instance, name))
 226
 227     def visit_array(self, array, instance):
 228         # XXX: actually it is possible to return an array of pointers
 229         pass
 230
 231     def visit_blob(self, blob, instance):
 232         pass
 233
 234     def visit_enum(self, enum, instance):
 235         pass
 236
 237     def visit_bitmask(self, bitmask, instance):
 238         pass
 239
 240     def visit_pointer(self, pointer, instance):
 241         self.visit(pointer.type, "*" + instance)
 242
 243     def visit_handle(self, handle, instance):
 244         self.visit(handle.type, instance)
 245
 246     def visit_alias(self, alias, instance):
 247         self.visit(alias.type, instance)
 248
 249     def visit_opaque(self, opaque, instance):
 250         pass
 251
 252     def visit_interface(self, interface, instance):
 253         assert instance.startswith('*')
 254         instance = instance[1:]
 255         print "    if (%s)" % instance
 256         print "        %s = new %s(%s);" % (instance, interface_wrap_name(interface), instance)
 257
 258
 259 class Unwrapper(Wrapper):
 260
 261     def visit_interface(self, interface, instance):
 262         assert instance.startswith('*')
 263         instance = instance[1:]
 264         print "    if (%s)" % instance
 265         print "        %s = static_cast<%s *>(%s)->m_pInstance;" % (instance, interface_wrap_name(interface), instance)
 266
 267
 268 wrap_instance = Wrapper().visit
 269 unwrap_instance = Unwrapper().visit
 270
 271
 272 class Tracer:
 273
 274     def __init__(self):
 275         self.api = None
 276
 277     def trace_api(self, api):
 278         self.api = api
 279
 280         self.header(api)
 281
 282         # Includes
 283         for header in api.headers:
 284             print header
 285         print
 286
 287         # Type dumpers
 288         types = api.all_types()
 289         visitor = DumpDeclarator()
 290         map(visitor.visit, types)
 291         print
 292
 293         # Interfaces wrapers
 294         interfaces = [type for type in types if isinstance(type, stdapi.Interface)]
 295         map(self.interface_wrap_impl, interfaces)
 296         print
 297
 298         # Function wrappers
 299         map(self.trace_function_decl, api.functions)
 300         map(self.trace_function_impl, api.functions)
 301         print
 302
 303         self.footer(api)
 304
 305     def header(self, api):
 306         pass
 307
 308     def footer(self, api):
 309         pass
 310
 311     def trace_function_decl(self, function):
 312         # Per-function declarations
 313
 314         if function.args:
 315             print 'static const char * __%s_args[%u] = {%s};' % (function.name, len(function.args), ', '.join(['"%s"' % arg.name for arg in function.args]))
 316         else:
 317             print 'static const char ** __%s_args = NULL;' % (function.name,)
 318         print 'static const Trace::FunctionSig __%s_sig = {%u, "%s", %u, __%s_args};' % (function.name, int(function.id), function.name, len(function.args), function.name)
 319         print
 320
 321     def get_dispatch_function(self, function):
 322         return '__' + function.name
 323
 324     def is_public_function(self, function):
 325         return True
 326
 327     def trace_function_impl(self, function):
 328         if self.is_public_function(function):
 329             print 'extern "C" PUBLIC'
 330         else:
 331             print 'extern "C" PRIVATE'
 332         print function.prototype() + ' {'
 333         if function.type is not stdapi.Void:
 334             print '    %s __result;' % function.type
 335         self.trace_function_impl_body(function)
 336         if function.type is not stdapi.Void:
 337             self.wrap_ret(function, "__result")
 338             print '    return __result;'
 339         print '}'
 340         print
 341
 342     def trace_function_impl_body(self, function):
 343         print '    unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
 344         for arg in function.args:
 345             if not arg.output:
 346                 self.unwrap_arg(function, arg)
 347                 self.dump_arg(function, arg)
 348         print '    Trace::EndEnter();'
 349         self.dispatch_function(function)
 350         print '    Trace::BeginLeave(__call);'
 351         for arg in function.args:
 352             if arg.output:
 353                 self.dump_arg(function, arg)
 354                 self.wrap_arg(function, arg)
 355         if function.type is not stdapi.Void:
 356             self.dump_ret(function, "__result")
 357         print '    Trace::EndLeave();'
 358
 359     def dispatch_function(self, function):
 360         if function.type is stdapi.Void:
 361             result = ''
 362         else:
 363             result = '__result = '
 364         dispatch = self.get_dispatch_function(function)
 365         print '    %s%s(%s);' % (result, dispatch, ', '.join([str(arg.name) for arg in function.args]))
 366
 367     def dump_arg(self, function, arg):
 368         print '    Trace::BeginArg(%u);' % (arg.index,)
 369         self.dump_arg_instance(function, arg)
 370         print '    Trace::EndArg();'
 371
 372     def dump_arg_instance(self, function, arg):
 373         dump_instance(arg.type, arg.name)
 374
 375     def wrap_arg(self, function, arg):
 376         wrap_instance(arg.type, arg.name)
 377
 378     def unwrap_arg(self, function, arg):
 379         unwrap_instance(arg.type, arg.name)
 380
 381     def dump_ret(self, function, instance):
 382         print '    Trace::BeginReturn();'
 383         dump_instance(function.type, instance)
 384         print '    Trace::EndReturn();'
 385
 386     def wrap_ret(self, function, instance):
 387         wrap_instance(function.type, instance)
 388
 389     def unwrap_ret(self, function, instance):
 390         unwrap_instance(function.type, instance)
 391
 392     def interface_wrap_impl(self, interface):
 393         print '%s::%s(%s * pInstance) {' % (interface_wrap_name(interface), interface_wrap_name(interface), interface.name)
 394         print '    m_pInstance = pInstance;'
 395         print '}'
 396         print
 397         print '%s::~%s() {' % (interface_wrap_name(interface), interface_wrap_name(interface))
 398         print '}'
 399         print
 400         for method in interface.itermethods():
 401             self.trace_method(interface, method)
 402         print
 403
 404     def trace_method(self, interface, method):
 405         print method.prototype(interface_wrap_name(interface) + '::' + method.name) + ' {'
 406         print '    static const char * __args[%u] = {%s};' % (len(method.args) + 1, ', '.join(['"this"'] + ['"%s"' % arg.name for arg in method.args]))
 407         print '    static const Trace::FunctionSig __sig = {%u, "%s", %u, __args};' % (int(method.id), interface.name + '::' + method.name, len(method.args) + 1)
 408         print '    unsigned __call = Trace::BeginEnter(__sig);'
 409         print '    Trace::BeginArg(0);'
 410         print '    Trace::LiteralOpaque((const void *)m_pInstance);'
 411         print '    Trace::EndArg();'
 412         for arg in method.args:
 413             if not arg.output:
 414                 self.unwrap_arg(method, arg)
 415                 self.dump_arg(method, arg)
 416         if method.type is stdapi.Void:
 417             result = ''
 418         else:
 419             print '    %s __result;' % method.type
 420             result = '__result = '
 421         print '    Trace::EndEnter();'
 422         print '    %sm_pInstance->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args]))
 423         print '    Trace::BeginLeave(__call);'
 424         for arg in method.args:
 425             if arg.output:
 426                 self.dump_arg(method, arg)
 427                 self.wrap_arg(method, arg)
 428         if method.type is not stdapi.Void:
 429             print '    Trace::BeginReturn();'
 430             dump_instance(method.type, "__result")
 431             print '    Trace::EndReturn();'
 432             wrap_instance(method.type, '__result')
 433         print '    Trace::EndLeave();'
 434         if method.name == 'QueryInterface':
 435             print '    if (ppvObj && *ppvObj) {'
 436             print '        if (*ppvObj == m_pInstance) {'
 437             print '            *ppvObj = this;'
 438             print '        }'
 439             for iface in self.api.interfaces:
 440                 print '        else if (riid == IID_%s) {' % iface.name
 441                 print '            *ppvObj = new Wrap%s((%s *) *ppvObj);' % (iface.name, iface.name)
 442                 print '        }'
 443             print '    }'
 444         if method.name == 'Release':
 445             assert method.type is not stdapi.Void
 446             print '    if (!__result)'
 447             print '        delete this;'
 448         if method.type is not stdapi.Void:
 449             print '    return __result;'
 450         print '}'
 451         print
 452
 453
 454 class DllTracer(Tracer):
 455
 456     def __init__(self, dllname):
 457         self.dllname = dllname
 458
 459     def header(self, api):
 460         print '''
 461 static HINSTANCE g_hDll = NULL;
 462
 463 static PROC
 464 __getPublicProcAddress(LPCSTR lpProcName)
 465 {
 466     if (!g_hDll) {
 467         char szDll[MAX_PATH] = {0};
 468
 469         if (!GetSystemDirectoryA(szDll, MAX_PATH)) {
 470             return NULL;
 471         }
 472
 473         strcat(szDll, "\\\\%s");
 474
 475         g_hDll = LoadLibraryA(szDll);
 476         if (!g_hDll) {
 477             return NULL;
 478         }
 479     }
 480
 481     return GetProcAddress(g_hDll, lpProcName);
 482 }
 483
 484 #define __abort() OS::Abort()
 485 ''' % self.dllname
 486
 487         dispatcher = Dispatcher()
 488         dispatcher.dispatch_api(api)
 489
 490         Tracer.header(self, api)
 491