git.cworth.org Git - apitrace/blob - gltrace.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
  27 """GL tracing generator."""
  28
  29
  30 import stdapi
  31 import glapi
  32 from glxapi import glxapi
  33 from trace import Tracer, dump_instance
  34
  35
  36 class TypeGetter(stdapi.Visitor):
  37     '''Determine which glGet*v function that matches the specified type.'''
  38
  39     def __init__(self, prefix = 'glGet', long_suffix = True):
  40         self.prefix = prefix
  41         self.long_suffix = long_suffix
  42
  43     def visit_const(self, const):
  44         return self.visit(const.type)
  45
  46     def visit_alias(self, alias):
  47         if alias.expr == 'GLboolean':
  48             if self.long_suffix:
  49                 return self.prefix + 'Booleanv', alias.expr
  50             else:
  51                 return self.prefix + 'iv', 'GLint'
  52         elif alias.expr == 'GLdouble':
  53             if self.long_suffix:
  54                 return self.prefix + 'Doublev', alias.expr
  55             else:
  56                 return self.prefix + 'dv', alias.expr
  57         elif alias.expr == 'GLfloat':
  58             if self.long_suffix:
  59                 return self.prefix + 'Floatv', alias.expr
  60             else:
  61                 return self.prefix + 'fv', alias.expr
  62         elif alias.expr in ('GLint', 'GLuint', 'GLsizei'):
  63             if self.long_suffix:
  64                 return self.prefix + 'Integerv', 'GLint'
  65             else:
  66                 return self.prefix + 'iv', 'GLint'
  67         else:
  68             print alias.expr
  69             assert False
  70
  71     def visit_enum(self, enum):
  72         return self.visit(glapi.GLint)
  73
  74     def visit_bitmask(self, bitmask):
  75         return self.visit(glapi.GLint)
  76
  77     def visit_opaque(self, pointer):
  78         return self.prefix + 'Pointerv', 'GLvoid *'
  79
  80
  81 class GlTracer(Tracer):
  82
  83     def header(self, api):
  84         Tracer.header(self, api)
  85         self.state_tracker_decl(api)
  86
  87     def footer(self, api):
  88         Tracer.footer(self, api)
  89         self.state_tracker_impl(api)
  90
  91     arrays = [
  92         ("Vertex", "VERTEX"),
  93         ("Normal", "NORMAL"),
  94         ("Color", "COLOR"),
  95         ("Index", "INDEX"),
  96         ("TexCoord", "TEXTURE_COORD"),
  97         ("EdgeFlag", "EDGE_FLAG"),
  98         ("FogCoord", "FOG_COORD"),
  99         ("SecondaryColor", "SECONDARY_COLOR"),
 100     ]
 101     arrays.reverse()
 102
 103     def state_tracker_decl(self, api):
 104         print '// Whether user arrays were used'
 105         print 'static bool __user_arrays = false;'
 106         print
 107         # Whether we need user arrays
 108         print 'static inline bool __need_user_arrays(void)'
 109         print '{'
 110         print '    if (!__user_arrays) {'
 111         print '        return false;'
 112         print '    }'
 113         print
 114
 115         for camelcase_name, uppercase_name in self.arrays:
 116             function_name = 'gl%sPointer' % camelcase_name
 117             enable_name = 'GL_%s_ARRAY' % uppercase_name
 118             binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
 119             print '    // %s' % function_name
 120             self.array_prolog(api, uppercase_name)
 121             print '    if (__glIsEnabled(%s)) {' % enable_name
 122             print '        GLint __binding = 0;'
 123             print '        __glGetIntegerv(%s, &__binding);' % binding_name
 124             print '        if (!__binding) {'
 125             self.array_cleanup(api, uppercase_name)
 126             print '            return true;'
 127             print '        }'
 128             print '    }'
 129             self.array_epilog(api, uppercase_name)
 130             print
 131
 132         print '    // glVertexAttribPointer'
 133         print '    GLint __max_vertex_attribs = 0;'
 134         print '    __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
 135         print '    for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
 136         print '        GLint __enabled = 0;'
 137         print '        __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
 138         print '        if (__enabled) {'
 139         print '            GLint __binding = 0;'
 140         print '            __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
 141         print '            if (!__binding) {'
 142         print '                return true;'
 143         print '            }'
 144         print '        }'
 145         print '    }'
 146         print
 147
 148         print '    return false;'
 149         print '}'
 150         print
 151
 152         print 'static void __trace_user_arrays(GLuint maxindex);'
 153         print
 154
 155     array_pointer_function_names = set((
 156         "glVertexPointer",
 157         "glNormalPointer",
 158         "glColorPointer",
 159         "glIndexPointer",
 160         "glTexCoordPointer",
 161         "glEdgeFlagPointer",
 162         "glFogCoordPointer",
 163         "glSecondaryColorPointer",
 164
 165         #"glVertexPointerEXT",
 166         #"glNormalPointerEXT",
 167         #"glColorPointerEXT",
 168         #"glIndexPointerEXT",
 169         #"glTexCoordPointerEXT",
 170         #"glEdgeFlagPointerEXT",
 171         #"glFogCoordPointerEXT",
 172         #"glSecondaryColorPointerEXT",
 173
 174         "glVertexAttribPointer",
 175         "glVertexAttribPointerARB",
 176         "glVertexAttribPointerNV",
 177         "glVertexAttribLPointer",
 178         "glVertexAttribLPointerEXT",
 179
 180         #"glMatrixIndexPointerARB",
 181     ))
 182
 183     draw_function_names = set((
 184         'glDrawArrays',
 185         'glDrawElements',
 186         'glDrawRangeElements',
 187     ))
 188
 189     interleaved_formats = [
 190          'GL_V2F',
 191          'GL_V3F',
 192          'GL_C4UB_V2F',
 193          'GL_C4UB_V3F',
 194          'GL_C3F_V3F',
 195          'GL_N3F_V3F',
 196          'GL_C4F_N3F_V3F',
 197          'GL_T2F_V3F',
 198          'GL_T4F_V4F',
 199          'GL_T2F_C4UB_V3F',
 200          'GL_T2F_C3F_V3F',
 201          'GL_T2F_N3F_V3F',
 202          'GL_T2F_C4F_N3F_V3F',
 203          'GL_T4F_C4F_N3F_V4F',
 204     ]
 205
 206     def trace_function_impl_body(self, function):
 207         # Defer tracing of user array pointers...
 208         if function.name in self.array_pointer_function_names:
 209             print '    GLint __array_buffer = 0;'
 210             print '    __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
 211             print '    if (!__array_buffer) {'
 212             print '        __user_arrays = true;'
 213             self.dispatch_function(function)
 214             print '        return;'
 215             print '    }'
 216
 217         # ... to the draw calls
 218         if function.name in self.draw_function_names:
 219             print '    if (__need_user_arrays()) {'
 220             arg_names = ', '.join([arg.name for arg in function.args[1:]])
 221             print '        GLuint maxindex = __%s_maxindex(%s);' % (function.name, arg_names)
 222             print '        __trace_user_arrays(maxindex);'
 223             print '    }'
 224
 225         # And also break down glInterleavedArrays into the individual calls
 226         if function.name == 'glInterleavedArrays':
 227             print '    GLint __array_buffer = 0;'
 228             print '    __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
 229             print '    if (!__array_buffer) {'
 230             print '        __user_arrays = true;'
 231             self.dispatch_function(function)
 232             print
 233
 234             # Initialize the enable flags
 235             for camelcase_name, uppercase_name in self.arrays:
 236                 flag_name = '__' + uppercase_name.lower()
 237                 print '        GLboolean %s = GL_FALSE;' % flag_name
 238             print
 239
 240             # Swicth for the interleaved formats
 241             print '        switch (format) {'
 242             for format in self.interleaved_formats:
 243                 print '            case %s:' % format
 244                 for camelcase_name, uppercase_name in self.arrays:
 245                     flag_name = '__' + uppercase_name.lower()
 246                     if format.find('_' + uppercase_name[0]) >= 0:
 247                         print '                %s = GL_TRUE;' % flag_name
 248                 print '                break;'
 249             print '            default:'
 250             print '               return;'
 251             print '        }'
 252             print
 253
 254             # Emit fake glEnableClientState/glDisableClientState flags
 255             for camelcase_name, uppercase_name in self.arrays:
 256                 flag_name = '__' + uppercase_name.lower()
 257                 enable_name = 'GL_%s_ARRAY' % uppercase_name
 258
 259                 # Emit a fake function
 260                 print '        {'
 261                 print '            static const Trace::FunctionSig &__sig = %s ? __glEnableClientState_sig : __glDisableClientState_sig;' % flag_name
 262                 print '            unsigned __call = Trace::BeginEnter(__sig);'
 263                 print '            Trace::BeginArg(0);'
 264                 dump_instance(glapi.GLenum, enable_name)
 265                 print '            Trace::EndArg();'
 266                 print '            Trace::EndEnter();'
 267                 print '            Trace::BeginLeave(__call);'
 268                 print '            Trace::EndLeave();'
 269                 print '        }'
 270
 271             print '        return;'
 272             print '    }'
 273
 274         Tracer.trace_function_impl_body(self, function)
 275
 276     boolean_names = [
 277         'GL_FALSE',
 278         'GL_TRUE',
 279     ]
 280
 281     def gl_boolean(self, value):
 282         return self.boolean_names[int(bool(value))]
 283
 284     def dump_arg_instance(self, function, arg):
 285         if function.name in self.draw_function_names and arg.name == 'indices':
 286             print '    GLint __element_array_buffer = 0;'
 287             print '    __glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
 288             print '    if (!__element_array_buffer) {'
 289             print '        Trace::LiteralBlob((const void *)%s, count*__gl_type_size(type));' % (arg.name)
 290             print '    } else {'
 291             print '        Trace::LiteralOpaque((const void *)%s);' % (arg.name)
 292             print '    }'
 293             return
 294
 295         Tracer.dump_arg_instance(self, function, arg)
 296
 297     def state_tracker_impl(self, api):
 298         # A simple state tracker to track the pointer values
 299
 300         # update the state
 301         print 'static void __trace_user_arrays(GLuint maxindex)'
 302         print '{'
 303
 304         for camelcase_name, uppercase_name in self.arrays:
 305             function_name = 'gl%sPointer' % camelcase_name
 306             enable_name = 'GL_%s_ARRAY' % uppercase_name
 307             binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
 308             function = api.get_function_by_name(function_name)
 309
 310             print '    // %s' % function.name
 311             self.array_trace_prolog(api, uppercase_name)
 312             self.array_prolog(api, uppercase_name)
 313             print '    if (__glIsEnabled(%s)) {' % enable_name
 314             print '        GLint __binding = 0;'
 315             print '        __glGetIntegerv(%s, &__binding);' % binding_name
 316             print '        if (!__binding) {'
 317
 318             # Get the arguments via glGet*
 319             for arg in function.args:
 320                 arg_get_enum = 'GL_%s_ARRAY_%s' % (uppercase_name, arg.name.upper())
 321                 arg_get_function, arg_type = TypeGetter().visit(arg.type)
 322                 print '            %s %s = 0;' % (arg_type, arg.name)
 323                 print '            __%s(%s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
 324
 325             arg_names = ', '.join([arg.name for arg in function.args[:-1]])
 326             print '            size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
 327
 328             # Emit a fake function
 329             self.array_trace_intermezzo(api, uppercase_name)
 330             print '            unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
 331             for arg in function.args:
 332                 assert not arg.output
 333                 print '            Trace::BeginArg(%u);' % (arg.index,)
 334                 if arg.name != 'pointer':
 335                     dump_instance(arg.type, arg.name)
 336                 else:
 337                     print '            Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
 338                 print '            Trace::EndArg();'
 339
 340             print '            Trace::EndEnter();'
 341             print '            Trace::BeginLeave(__call);'
 342             print '            Trace::EndLeave();'
 343             print '        }'
 344             print '    }'
 345             self.array_epilog(api, uppercase_name)
 346             self.array_trace_epilog(api, uppercase_name)
 347             print
 348
 349         # Samething, but for glVertexAttribPointer
 350         print '    // glVertexAttribPointer'
 351         print '    GLint __max_vertex_attribs = 0;'
 352         print '    __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
 353         print '    for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
 354         print '        GLint __enabled = 0;'
 355         print '        __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
 356         print '        if (__enabled) {'
 357         print '            GLint __binding = 0;'
 358         print '            __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
 359         print '            if (!__binding) {'
 360
 361         function = api.get_function_by_name('glVertexAttribPointer')
 362
 363         # Get the arguments via glGet*
 364         for arg in function.args[1:]:
 365             arg_get_enum = 'GL_VERTEX_ATTRIB_ARRAY_%s' % (arg.name.upper(),)
 366             arg_get_function, arg_type = TypeGetter('glGetVertexAttrib', False).visit(arg.type)
 367             print '                %s %s = 0;' % (arg_type, arg.name)
 368             print '                __%s(index, %s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
 369
 370         arg_names = ', '.join([arg.name for arg in function.args[1:-1]])
 371         print '                size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
 372
 373         # Emit a fake function
 374         print '                unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
 375         for arg in function.args:
 376             assert not arg.output
 377             print '                Trace::BeginArg(%u);' % (arg.index,)
 378             if arg.name != 'pointer':
 379                 dump_instance(arg.type, arg.name)
 380             else:
 381                 print '                Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
 382             print '                Trace::EndArg();'
 383
 384         print '                Trace::EndEnter();'
 385         print '                Trace::BeginLeave(__call);'
 386         print '                Trace::EndLeave();'
 387         print '            }'
 388         print '        }'
 389         print '    }'
 390         print
 391
 392         print '}'
 393         print
 394
 395     #
 396     # Hooks for glTexCoordPointer, which is identical to the other array
 397     # pointers except the fact that it is indexed by glClientActiveTexture.
 398     #
 399
 400     def array_prolog(self, api, uppercase_name):
 401         if uppercase_name == 'TEXTURE_COORD':
 402             print '    GLint client_active_texture = 0;'
 403             print '    __glGetIntegerv(GL_CLIENT_ACTIVE_TEXTURE, &client_active_texture);'
 404             print '    GLint max_texture_coords = 0;'
 405             print '    __glGetIntegerv(GL_MAX_TEXTURE_COORDS, &max_texture_coords);'
 406             print '    for (GLint unit = 0; unit < max_texture_coords; ++unit) {'
 407             print '        GLenum texture = GL_TEXTURE0 + unit;'
 408             print '        __glClientActiveTexture(texture);'
 409
 410     def array_trace_prolog(self, api, uppercase_name):
 411         if uppercase_name == 'TEXTURE_COORD':
 412             print '    bool client_active_texture_dirty = false;'
 413
 414     def array_epilog(self, api, uppercase_name):
 415         if uppercase_name == 'TEXTURE_COORD':
 416             print '    }'
 417         self.array_cleanup(api, uppercase_name)
 418
 419     def array_cleanup(self, api, uppercase_name):
 420         if uppercase_name == 'TEXTURE_COORD':
 421             print '    __glClientActiveTexture(client_active_texture);'
 422
 423     def array_trace_intermezzo(self, api, uppercase_name):
 424         if uppercase_name == 'TEXTURE_COORD':
 425             print '    if (texture != client_active_texture || client_active_texture_dirty) {'
 426             print '        client_active_texture_dirty = true;'
 427             self.fake_glClientActiveTexture_call(api, "texture");
 428             print '    }'
 429
 430     def array_trace_epilog(self, api, uppercase_name):
 431         if uppercase_name == 'TEXTURE_COORD':
 432             print '    if (client_active_texture_dirty) {'
 433             self.fake_glClientActiveTexture_call(api, "client_active_texture");
 434             print '    }'
 435
 436     def fake_glClientActiveTexture_call(self, api, texture):
 437         function = api.get_function_by_name('glClientActiveTexture')
 438         self.fake_call(function, [texture])
 439
 440     def fake_call(self, function, args):
 441         print '            unsigned __fake_call = Trace::BeginEnter(__%s_sig);' % (function.name,)
 442         for arg, instance in zip(function.args, args):
 443             assert not arg.output
 444             print '            Trace::BeginArg(%u);' % (arg.index,)
 445             dump_instance(arg.type, instance)
 446             print '            Trace::EndArg();'
 447         print '            Trace::EndEnter();'
 448         print '            Trace::BeginLeave(__fake_call);'
 449         print '            Trace::EndLeave();'
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460