]> git.cworth.org Git - apitrace/blobdiff - gltrace.py
Fix a few more arrays args in D3D9.
[apitrace] / gltrace.py
index 3e3a2be817b54e3ff99b84c537702c9a3889308a..3113f258efdcfeaf40e98f8f7b95fe3ffbf8ff5b 100644 (file)
 """GL tracing generator."""
 
 
+import stdapi
+import glapi
 from glxapi import glxapi
 from trace import Tracer, dump_instance
 
 
+class TypeGetter(stdapi.Visitor):
+    '''Determine which glGet*v function that matches the specified type.'''
+
+    def __init__(self, prefix = 'glGet', long_suffix = True):
+        self.prefix = prefix
+        self.long_suffix = long_suffix
+
+    def visit_const(self, const):
+        return self.visit(const.type)
+
+    def visit_alias(self, alias):
+        if alias.expr == 'GLboolean':
+            if self.long_suffix:
+                return self.prefix + 'Booleanv', alias.expr
+            else:
+                return self.prefix + 'iv', 'GLint'
+        elif alias.expr == 'GLdouble':
+            if self.long_suffix:
+                return self.prefix + 'Doublev', alias.expr
+            else:
+                return self.prefix + 'dv', alias.expr
+        elif alias.expr == 'GLfloat':
+            if self.long_suffix:
+                return self.prefix + 'Floatv', alias.expr
+            else:
+                return self.prefix + 'fv', alias.expr
+        elif alias.expr in ('GLint', 'GLuint', 'GLsizei'):
+            if self.long_suffix:
+                return self.prefix + 'Integerv', 'GLint'
+            else:
+                return self.prefix + 'iv', 'GLint'
+        else:
+            print alias.expr
+            assert False
+    
+    def visit_enum(self, enum):
+        return self.visit(glapi.GLint)
+
+    def visit_bitmask(self, bitmask):
+        return self.visit(glapi.GLint)
+
+    def visit_opaque(self, pointer):
+        return self.prefix + 'Pointerv', 'GLvoid *'
+
+
 class GlTracer(Tracer):
 
     def header(self, api):
@@ -41,181 +88,290 @@ class GlTracer(Tracer):
         Tracer.footer(self, api)
         self.state_tracker_impl(api)
 
-    array_names = {
-        "VERTEX": "glVertexPointer",
-        "NORMAL": "glNormalPointer",
-        "COLOR": "glColorPointer",
-        "INDEX": "glIndexPointer",
-        "TEX_COORD": "glTexCoordPointer",
-        "EDGE_FLAG": "glEdgeFlagPointer",
-        "FOG_COORD": "glFogCoordPointer",
-        "SECONDARY_COLOR": "glSecondaryColorPointer",
-    }
-
-    pointer_function_names = {
-        "glVertexPointer": "VERTEX",
-        "glNormalPointer": "NORMAL",
-        "glColorPointer": "COLOR",
-        "glIndexPointer": "INDEX",
-        "glTexCoordPointer": "TEX_COORD",
-        "glEdgeFlagPointer": "EDGE_FLAG",
-        "glFogCoordPointer": "FOG_COORD",
-        "glSecondaryColorPointer": "SECONDARY_COLOR",
-        #"glInterleavedArrays": ("InterleavedArrays", None)
-        #"glVertexPointerEXT": "VERTEX",
-        #"glNormalPointerEXT": "NORMAL",
-        #"glColorPointerEXT": "COLOR",
-        #"glIndexPointerEXT": "INDEX",
-        #"glTexCoordPointerEXT": "TEX_COORD",
-        #"glEdgeFlagPointerEXT": "EDGE_FLAG",
-        #"glFogCoordPointerEXT": "FOG_COORD",
-        #"glSecondaryColorPointerEXT": "SECONDARY_COLOR",
-
-        #"glVertexAttribPointer": "VertexAttribPointer",
-        #"glVertexAttribPointerARB": "VertexAttribPointer",
-        #"glVertexAttribPointerNV": "VertexAttribPointer",
-        #"glVertexAttribLPointer": "VertexAttribLPointer",
-        
-        #"glMatrixIndexPointerARB": "MatrixIndexPointer",
-    }
-
-    bind_buffer_enums = [
-        'ARRAY_BUFFER',
-        'ELEMENT_ARRAY_BUFFER',
-        'PIXEL_PACK_BUFFER',
-        'PIXEL_UNPACK_BUFFER',
-    ]
-
-    client_state_enums = [
-         'COLOR_ARRAY',
-         'EDGE_FLAG_ARRAY', 
-         'FOG_COORD_ARRAY', 
-         'INDEX_ARRAY', 
-         'NORMAL_ARRAY', 
-         'SECONDARY_COLOR_ARRAY', 
-         'TEXTURE_COORD_ARRAY', 
-         'VERTEX_ARRAY',
+    arrays = [
+        ("Vertex", "VERTEX"),
+        ("Normal", "NORMAL"),
+        ("Color", "COLOR"),
+        ("Index", "INDEX"),
+        ("TexCoord", "TEXTURE_COORD"),
+        ("EdgeFlag", "EDGE_FLAG"),
+        ("FogCoord", "FOG_COORD"),
+        ("SecondaryColor", "SECONDARY_COLOR"),
     ]
+    arrays.reverse()
 
     def state_tracker_decl(self, api):
-        # A simple state tracker to track the pointer values
+        # Whether we need user arrays
+        print 'static inline bool __need_user_arrays(void)'
+        print '{'
+
+        for camelcase_name, uppercase_name in self.arrays:
+            function_name = 'gl%sPointer' % camelcase_name
+            enable_name = 'GL_%s_ARRAY' % uppercase_name
+            binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
+            print '    // %s' % function_name
+            print '    if (__glIsEnabled(%s)) {' % enable_name
+            print '        GLint __binding = 0;'
+            print '        __glGetIntegerv(%s, &__binding);' % binding_name
+            print '        if (!__binding) {'
+            print '            return true;'
+            print '        }'
+            print '    }'
+            print
 
-        # define the NEW_XXXX dirty flags
-        value = 1
-        for array_name in self.array_names.iterkeys():
-            dirtyflag = "NEW_%s" % array_name.upper()
-            print '#define %s 0x%x' % (dirtyflag, value)
-            value <<= 1
+        print '    // glVertexAttribPointer'
+        print '    GLint __max_vertex_attribs = 0;'
+        print '    __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
+        print '    for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
+        print '        GLint __enabled = 0;'
+        print '        __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
+        print '        if (__enabled) {'
+        print '            GLint __binding = 0;'
+        print '            __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
+        print '            if (!__binding) {'
+        print '                return true;'
+        print '            }'
+        print '        }'
+        print '    }'
         print
 
-        # declare the state structure
-        print 'struct {'
-        for enum in self.bind_buffer_enums:
-            print '    GLuint %s;' % (enum.lower(),)
-        for enum in self.client_state_enums:
-            print '    GLboolean %s;' % (enum.lower(),)
-        for array_name, function_name in self.array_names.iteritems():
-            function = api.get_function_by_name(function_name)
-            print '    struct {'
-            for arg in function.args:
-                print '        %s %s;' % (arg.type, arg.name)
-            print '    } %s;' % array_name.lower()
-        print '    unsigned dirty;'
-        print '} __state;'
+        print '    return false;'
+        print '}'
         print
-        print 'static void __state_update(GLsizei maxIndex);'
+
+        print 'static void __trace_user_arrays(GLuint maxindex);'
         print
     
+    array_pointer_function_names = set((
+        "glVertexPointer",
+        "glNormalPointer",
+        "glColorPointer",
+        "glIndexPointer",
+        "glTexCoordPointer",
+        "glEdgeFlagPointer",
+        "glFogCoordPointer",
+        "glSecondaryColorPointer",
+        
+        #"glVertexPointerEXT",
+        #"glNormalPointerEXT",
+        #"glColorPointerEXT",
+        #"glIndexPointerEXT",
+        #"glTexCoordPointerEXT",
+        #"glEdgeFlagPointerEXT",
+        #"glFogCoordPointerEXT",
+        #"glSecondaryColorPointerEXT",
+
+        "glVertexAttribPointer",
+        "glVertexAttribPointerARB",
+        "glVertexAttribPointerNV",
+        "glVertexAttribLPointer",
+        "glVertexAttribLPointerEXT",
+        
+        #"glMatrixIndexPointerARB",
+    ))
+
+    draw_function_names = set((
+        'glDrawArrays',
+        'glDrawElements',
+        'glDrawRangeElements',
+    ))
+
+    interleaved_formats = [
+         'GL_V2F',
+         'GL_V3F',
+         'GL_C4UB_V2F',
+         'GL_C4UB_V3F',
+         'GL_C3F_V3F',
+         'GL_N3F_V3F',
+         'GL_C4F_N3F_V3F',
+         'GL_T2F_V3F',
+         'GL_T4F_V4F',
+         'GL_T2F_C4UB_V3F',
+         'GL_T2F_C3F_V3F',
+         'GL_T2F_N3F_V3F',
+         'GL_T2F_C4F_N3F_V3F',
+         'GL_T4F_C4F_N3F_V4F',
+    ]
+
     def trace_function_impl_body(self, function):
-        # Track bound VBOs
-        if function.name in ('glBindBuffer', 'glBindBufferARB'):
-            print '    switch(%s) {' % function.args[0].name
-            for enum in self.bind_buffer_enums:
-                print '    case GL_%s:' % enum
-                print '        __state.%s = %s;' % (enum.lower(), function.args[1].name)
-                print '        break;'
+        # Defer tracing of user array pointers...
+        if function.name in self.array_pointer_function_names:
+            print '    GLint __array_buffer = 0;'
+            print '    __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
+            print '    if (!__array_buffer) {'
+            self.dispatch_function(function)
+            print '        return;'
             print '    }'
 
-        # Track enabled arrays
-        if function.name == 'glEnableClientState':
-            print '    switch(%s) {' % function.args[0].name
-            for enum in self.client_state_enums:
-                print '    case GL_%s:' % enum
-                print '        __state.%s = GL_TRUE;' % (enum.lower(),)
-                print '        break;'
+        # ... to the draw calls
+        if function.name in self.draw_function_names:
+            print '    if (__need_user_arrays()) {'
+            arg_names = ', '.join([arg.name for arg in function.args[1:]])
+            print '        GLuint maxindex = __%s_maxindex(%s);' % (function.name, arg_names)
+            print '        __trace_user_arrays(maxindex);'
             print '    }'
-        if function.name == 'glDisableClientState':
-            print '    switch(%s) {' % function.args[0].name
-            for enum in self.client_state_enums:
-                print '    case GL_%s:' % enum
-                print '        __state.%s = GL_FALSE;' % (enum.lower(),)
-                print '        break;'
+        
+        # And also break down glInterleavedArrays into the individual calls
+        if function.name == 'glInterleavedArrays':
+            print '    GLint __array_buffer = 0;'
+            print '    __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
+            print '    if (!__array_buffer) {'
+            self.dispatch_function(function)
+            print
+
+            # Initialize the enable flags
+            for camelcase_name, uppercase_name in self.arrays:
+                flag_name = '__' + uppercase_name.lower()
+                print '        GLboolean %s = GL_FALSE;' % flag_name
+            print
+
+            # Swicth for the interleaved formats
+            print '        switch (format) {'
+            for format in self.interleaved_formats:
+                print '            case %s:' % format
+                for camelcase_name, uppercase_name in self.arrays:
+                    flag_name = '__' + uppercase_name.lower()
+                    if format.find('_' + uppercase_name[0]) >= 0:
+                        print '                %s = GL_TRUE;' % flag_name
+                print '                break;'
+            print '            default:'
+            print '               return;'
+            print '        }'
+            print
+
+            # Emit fake glEnableClientState/glDisableClientState flags
+            for camelcase_name, uppercase_name in self.arrays:
+                flag_name = '__' + uppercase_name.lower()
+                enable_name = 'GL_%s_ARRAY' % uppercase_name
+
+                # Emit a fake function
+                print '        {'
+                print '            static const Trace::FunctionSig &__sig = %s ? __glEnableClientState_sig : __glDisableClientState_sig;' % flag_name
+                print '            unsigned __call = Trace::BeginEnter(__sig);'
+                print '            Trace::BeginArg(0);'
+                dump_instance(glapi.GLenum, enable_name)
+                print '            Trace::EndArg();'
+                print '            Trace::EndEnter();'
+                print '            Trace::BeginLeave(__call);'
+                print '            Trace::EndLeave();'
+                print '        }'
+
+            print '        return;'
             print '    }'
 
-        # Track array pointers
-        if function.name in self.pointer_function_names:
-            array_name = self.pointer_function_names[function.name]
-            dirtyflag = "NEW_%s" % array_name.upper()
-            for arg in function.args:
-                assert not arg.output
-                print '    __state.%s.%s = %s;' % (array_name.lower(), arg.name, arg.name)
-            print '    __state.dirty |= %s; ' % dirtyflag
+        Tracer.trace_function_impl_body(self, function)
 
-            # Defer tracing
-            self.dispatch_function(function)
+    boolean_names = [
+        'GL_FALSE',
+        'GL_TRUE',
+    ]
+
+    def gl_boolean(self, value):
+        return self.boolean_names[int(bool(value))]
+
+    def dump_arg_instance(self, function, arg):
+        if function.name in self.draw_function_names and arg.name == 'indices':
+            print '    GLint __element_array_buffer = 0;'
+            print '    __glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
+            print '    if (!__element_array_buffer) {'
+            print '        Trace::LiteralBlob((const void *)%s, count*__gl_type_size(type));' % (arg.name)
+            print '    } else {'
+            print '        Trace::LiteralOpaque((const void *)%s);' % (arg.name)
+            print '    }'
             return
 
-        if function.name == 'glDrawArrays':
-            print '   __state_update(first + count - 1);'
-        
-        Tracer.trace_function_impl_body(self, function)
+        Tracer.dump_arg_instance(self, function, arg)
 
     def state_tracker_impl(self, api):
         # A simple state tracker to track the pointer values
 
         # update the state
-        print 'static void __state_update(GLsizei maxIndex)'
+        print 'static void __trace_user_arrays(GLuint maxindex)'
         print '{'
-        print '    GLint __array_buffer = 0;'
-        print '    __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
-        for array_name, function_name in self.array_names.iteritems():
+
+        for camelcase_name, uppercase_name in self.arrays:
+            function_name = 'gl%sPointer' % camelcase_name
+            enable_name = 'GL_%s_ARRAY' % uppercase_name
+            binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
             function = api.get_function_by_name(function_name)
-            dirtyflag = "NEW_%s" % array_name.upper()
-            if array_name == 'TEX_COORD':
-                enableflag = 'TEXTURE_COORD_ARRAY'.lower()
-            else:
-                enableflag = '%s_array' % array_name.lower()
-            print '    if (__state.%s && (__state.dirty & %s)) {' % (enableflag, dirtyflag)
-            print '        unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
+
+            print '    // %s' % function.name
+            print '    if (__glIsEnabled(%s)) {;' % enable_name
+            print '        GLint __binding = 0;'
+            print '        __glGetIntegerv(%s, &__binding);' % binding_name
+            print '        if (!__binding) {'
+
+            # Get the arguments via glGet*
+            for arg in function.args:
+                arg_get_enum = 'GL_%s_ARRAY_%s' % (uppercase_name, arg.name.upper())
+                arg_get_function, arg_type = TypeGetter().visit(arg.type)
+                print '            %s %s = 0;' % (arg_type, arg.name)
+                print '            __%s(%s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
+            
+            arg_names = ', '.join([arg.name for arg in function.args[:-1]])
+            print '            size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
+
+            # Emit a fake function
+            print '            unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
             for arg in function.args:
                 assert not arg.output
-                value = '__state.%s.%s' % (array_name.lower(), arg.name)
-                print '        Trace::BeginArg(%u);' % (arg.index,)
+                print '            Trace::BeginArg(%u);' % (arg.index,)
                 if arg.name != 'pointer':
-                    dump_instance(arg.type, value)
+                    dump_instance(arg.type, arg.name)
                 else:
-                    print '        if (__state.array_buffer) {'
-                    print '            Trace::LiteralOpaque((const void *)%s);' % value
-                    print '            __state.dirty &= ~%s;' % dirtyflag
-                    print '        } else {'
-                    if array_name in ('INDEX', 'EDGE_FLAG', 'FOG_COORD'):
-                        size = '1'
-                    elif array_name == 'NORMAL':
-                        size = '3'
-                    else:
-                        size = '__state.%s.size' % array_name.lower()
-                    if array_name == 'EDGE_FLAG':
-                        type = 'GL_BOOL'
-                    else:
-                        type = '__state.%s.type' % array_name.lower()
-                    stride = '__state.%s.stride' % array_name.lower()
-                    print '            Trace::LiteralBlob((const void *)%s, __glArrayPointer_size(%s, %s, %s, maxIndex));' % (value, size, type, stride)
-                    print '        }'
-                    print '        Trace::EndArg();'
-            print '        Trace::EndEnter();'
-            print '        Trace::BeginLeave(__call);'
-            print '        Trace::EndLeave();'
+                    print '            Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
+                print '            Trace::EndArg();'
+            
+            print '            Trace::EndEnter();'
+            print '            Trace::BeginLeave(__call);'
+            print '            Trace::EndLeave();'
+            print '        }'
             print '    }'
+            print
+
+        # Samething, but for glVertexAttribPointer
+        print '    // glVertexAttribPointer'
+        print '    GLint __max_vertex_attribs = 0;'
+        print '    __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
+        print '    for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
+        print '        GLint __enabled = 0;'
+        print '        __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
+        print '        if (__enabled) {'
+        print '            GLint __binding = 0;'
+        print '            __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
+        print '            if (!__binding) {'
+
+        function = api.get_function_by_name('glVertexAttribPointer')
+
+        # Get the arguments via glGet*
+        for arg in function.args[1:]:
+            arg_get_enum = 'GL_VERTEX_ATTRIB_ARRAY_%s' % (arg.name.upper(),)
+            arg_get_function, arg_type = TypeGetter('glGetVertexAttrib', False).visit(arg.type)
+            print '                %s %s = 0;' % (arg_type, arg.name)
+            print '                __%s(index, %s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
+        
+        arg_names = ', '.join([arg.name for arg in function.args[1:-1]])
+        print '                size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
+
+        # Emit a fake function
+        print '                unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
+        for arg in function.args:
+            assert not arg.output
+            print '                Trace::BeginArg(%u);' % (arg.index,)
+            if arg.name != 'pointer':
+                dump_instance(arg.type, arg.name)
+            else:
+                print '                Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
+            print '                Trace::EndArg();'
+        
+        print '                Trace::EndEnter();'
+        print '                Trace::BeginLeave(__call);'
+        print '                Trace::EndLeave();'
+        print '            }'
+        print '        }'
+        print '    }'
+        print
+
         print '}'
         print