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         print "    if (%s) {" % instance
 242         self.visit(pointer.type, "*" + instance)
 243         print "    }"
 244
 245     def visit_handle(self, handle, instance):
 246         self.visit(handle.type, instance)
 247
 248     def visit_alias(self, alias, instance):
 249         self.visit(alias.type, instance)
 250
 251     def visit_opaque(self, opaque, instance):
 252         pass
 253
 254     def visit_interface(self, interface, instance):
 255         assert instance.startswith('*')
 256         instance = instance[1:]
 257         print "    if (%s) {" % instance
 258         print "        %s = new %s(%s);" % (instance, interface_wrap_name(interface), instance)
 259         print "    }"
 260
 261
 262 class Unwrapper(Wrapper):
 263
 264     def visit_interface(self, interface, instance):
 265         assert instance.startswith('*')
 266         instance = instance[1:]
 267         print "    if (%s) {" % instance
 268         print "        %s = static_cast<%s *>(%s)->m_pInstance;" % (instance, interface_wrap_name(interface), instance)
 269         print "    }"
 270
 271
 272 wrap_instance = Wrapper().visit
 273 unwrap_instance = Unwrapper().visit
 274
 275
 276 class Tracer:
 277
 278     def __init__(self):
 279         self.api = None
 280
 281     def trace_api(self, api):
 282         self.api = api
 283
 284         self.header(api)
 285
 286         # Includes
 287         for header in api.headers:
 288             print header
 289         print
 290
 291         # Type dumpers
 292         types = api.all_types()
 293         visitor = DumpDeclarator()
 294         map(visitor.visit, types)
 295         print
 296
 297         # Interfaces wrapers
 298         interfaces = [type for type in types if isinstance(type, stdapi.Interface)]
 299         map(self.interface_wrap_impl, interfaces)
 300         print
 301
 302         # Function wrappers
 303         map(self.trace_function_decl, api.functions)
 304         map(self.trace_function_impl, api.functions)
 305         print
 306
 307         self.footer(api)
 308
 309     def header(self, api):
 310         pass
 311
 312     def footer(self, api):
 313         pass
 314
 315     def trace_function_decl(self, function):
 316         # Per-function declarations
 317
 318         if function.args:
 319             print 'static const char * __%s_args[%u] = {%s};' % (function.name, len(function.args), ', '.join(['"%s"' % arg.name for arg in function.args]))
 320         else:
 321             print 'static const char ** __%s_args = NULL;' % (function.name,)
 322         print 'static const Trace::FunctionSig __%s_sig = {%u, "%s", %u, __%s_args};' % (function.name, int(function.id), function.name, len(function.args), function.name)
 323         print
 324
 325     def get_dispatch_function(self, function):
 326         return '__' + function.name
 327
 328     def is_public_function(self, function):
 329         return True
 330
 331     def trace_function_impl(self, function):
 332         if self.is_public_function(function):
 333             print 'extern "C" PUBLIC'
 334         else:
 335             print 'extern "C" PRIVATE'
 336         print function.prototype() + ' {'
 337         if function.type is not stdapi.Void:
 338             print '    %s __result;' % function.type
 339         self.trace_function_impl_body(function)
 340         if function.type is not stdapi.Void:
 341             self.wrap_ret(function, "__result")
 342             print '    return __result;'
 343         print '}'
 344         print
 345
 346     def trace_function_impl_body(self, function):
 347         print '    unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
 348         for arg in function.args:
 349             if not arg.output:
 350                 self.unwrap_arg(function, arg)
 351                 self.dump_arg(function, arg)
 352         print '    Trace::EndEnter();'
 353         self.dispatch_function(function)
 354         print '    Trace::BeginLeave(__call);'
 355         for arg in function.args:
 356             if arg.output:
 357                 self.dump_arg(function, arg)
 358                 self.wrap_arg(function, arg)
 359         if function.type is not stdapi.Void:
 360             self.dump_ret(function, "__result")
 361         print '    Trace::EndLeave();'
 362
 363     def dispatch_function(self, function):
 364         if function.type is stdapi.Void:
 365             result = ''
 366         else:
 367             result = '__result = '
 368         dispatch = self.get_dispatch_function(function)
 369         print '    %s%s(%s);' % (result, dispatch, ', '.join([str(arg.name) for arg in function.args]))
 370
 371     def dump_arg(self, function, arg):
 372         print '    Trace::BeginArg(%u);' % (arg.index,)
 373         self.dump_arg_instance(function, arg)
 374         print '    Trace::EndArg();'
 375
 376     def dump_arg_instance(self, function, arg):
 377         dump_instance(arg.type, arg.name)
 378
 379     def wrap_arg(self, function, arg):
 380         wrap_instance(arg.type, arg.name)
 381
 382     def unwrap_arg(self, function, arg):
 383         unwrap_instance(arg.type, arg.name)
 384
 385     def dump_ret(self, function, instance):
 386         print '    Trace::BeginReturn();'
 387         dump_instance(function.type, instance)
 388         print '    Trace::EndReturn();'
 389
 390     def wrap_ret(self, function, instance):
 391         wrap_instance(function.type, instance)
 392
 393     def unwrap_ret(self, function, instance):
 394         unwrap_instance(function.type, instance)
 395
 396     def interface_wrap_impl(self, interface):
 397         print '%s::%s(%s * pInstance) {' % (interface_wrap_name(interface), interface_wrap_name(interface), interface.name)
 398         print '    m_pInstance = pInstance;'
 399         print '}'
 400         print
 401         print '%s::~%s() {' % (interface_wrap_name(interface), interface_wrap_name(interface))
 402         print '}'
 403         print
 404         for method in interface.itermethods():
 405             self.trace_method(interface, method)
 406         print
 407
 408     def trace_method(self, interface, method):
 409         print method.prototype(interface_wrap_name(interface) + '::' + method.name) + ' {'
 410         print '    static const char * __args[%u] = {%s};' % (len(method.args) + 1, ', '.join(['"this"'] + ['"%s"' % arg.name for arg in method.args]))
 411         print '    static const Trace::FunctionSig __sig = {%u, "%s", %u, __args};' % (int(method.id), interface.name + '::' + method.name, len(method.args) + 1)
 412         print '    unsigned __call = Trace::BeginEnter(__sig);'
 413         print '    Trace::BeginArg(0);'
 414         print '    Trace::LiteralOpaque((const void *)m_pInstance);'
 415         print '    Trace::EndArg();'
 416         for arg in method.args:
 417             if not arg.output:
 418                 self.unwrap_arg(method, arg)
 419                 self.dump_arg(method, arg)
 420         if method.type is stdapi.Void:
 421             result = ''
 422         else:
 423             print '    %s __result;' % method.type
 424             result = '__result = '
 425         print '    Trace::EndEnter();'
 426         print '    %sm_pInstance->%s(%s);' % (result, method.name, ', '.join([str(arg.name) for arg in method.args]))
 427         print '    Trace::BeginLeave(__call);'
 428         for arg in method.args:
 429             if arg.output:
 430                 self.dump_arg(method, arg)
 431                 self.wrap_arg(method, arg)
 432         if method.type is not stdapi.Void:
 433             print '    Trace::BeginReturn();'
 434             dump_instance(method.type, "__result")
 435             print '    Trace::EndReturn();'
 436             wrap_instance(method.type, '__result')
 437         print '    Trace::EndLeave();'
 438         if method.name == 'QueryInterface':
 439             print '    if (ppvObj && *ppvObj) {'
 440             print '        if (*ppvObj == m_pInstance) {'
 441             print '            *ppvObj = this;'
 442             print '        }'
 443             for iface in self.api.interfaces:
 444                 print '        else if (riid == IID_%s) {' % iface.name
 445                 print '            *ppvObj = new Wrap%s((%s *) *ppvObj);' % (iface.name, iface.name)
 446                 print '        }'
 447             print '    }'
 448         if method.name == 'Release':
 449             assert method.type is not stdapi.Void
 450             print '    if (!__result)'
 451             print '        delete this;'
 452         if method.type is not stdapi.Void:
 453             print '    return __result;'
 454         print '}'
 455         print
 456
 457
 458 class DllTracer(Tracer):
 459
 460     def __init__(self, dllname):
 461         self.dllname = dllname
 462
 463     def header(self, api):
 464         print '''
 465 static HINSTANCE g_hDll = NULL;
 466
 467 static PROC
 468 __getPublicProcAddress(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 #define __abort() OS::Abort()
 489 ''' % self.dllname
 490
 491         dispatcher = Dispatcher()
 492         dispatcher.dispatch_api(api)
 493
 494         Tracer.header(self, api)
 495