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