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