trace: Additional support for GL_KHR_debug, GL_ARB_debug_output, and GL_AMD_debug_output.

[apitrace] / wrappers / gltrace.py

diff --git a/wrappers/gltrace.py b/wrappers/gltrace.py
index c40fbb36de62aaac143a13ab1acf9b4e894f659f..7bf2a3507a4169dec9b56c8ef5cdcf055fb09408 100644 (file)
--- a/wrappers/gltrace.py
+++ b/wrappers/gltrace.py
@@ -329,9 +329,21 @@ class GlTracer(Tracer):
             Tracer.traceApi(self, api)
             
             print 'static %s _wrapProcAddress(%s procName, %s procPtr) {' % (retType, argType, retType)
+
+            # Provide fallback functions to missing debug functions
             print '    if (!procPtr) {'
-            print '        return procPtr;'
+            else_ = ''
+            for function_name in self.debug_functions:
+                if self.api.getFunctionByName(function_name):
+                    print '        %sif (strcmp("%s", (const char *)procName) == 0) {' % (else_, function_name)
+                    print '            return (%s)&%s;' % (retType, function_name)
+                    print '        }'
+                else_ = 'else '
+            print '        %s{' % else_
+            print '            return NULL;'
+            print '        }'
             print '    }'
+
             for function in api.getAllFunctions():
                 ptype = function_pointer_type(function)
                 pvalue = function_pointer_value(function)
@@ -357,7 +369,7 @@ class GlTracer(Tracer):
         print '    }'
         print
         print '    GLint buffer_binding = 0;'
-        print '    _glGetIntegerv(target, &buffer_binding);'
+        print '    _glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &buffer_binding);'
         print '    if (buffer_binding > 0) {'
         print '        gltrace::Buffer & buf = ctx->buffers[buffer_binding];'
         print '        buf.getSubData(offset, size, data);'
@@ -684,6 +696,8 @@ class GlTracer(Tracer):
 
         Tracer.traceFunctionImplBody(self, function)
 
+    # These entrypoints are only expected to be implemented by tools;
+    # drivers will probably not implement them.
     marker_functions = [
         # GL_GREMEDY_string_marker
         'glStringMarkerGREMEDY',
@@ -695,17 +709,55 @@ class GlTracer(Tracer):
         'glPopGroupMarkerEXT',
     ]
 
+    # These entrypoints may be implemented by drivers, but are also very useful
+    # for debugging / analysis tools.
+    debug_functions = [
+        # GL_KHR_debug
+        'glDebugMessageControl',
+        'glDebugMessageInsert',
+        'glDebugMessageCallback',
+        'glGetDebugMessageLog',
+        'glPushDebugGroup',
+        'glPopDebugGroup',
+        'glObjectLabel',
+        'glGetObjectLabel',
+        'glObjectPtrLabel',
+        'glGetObjectPtrLabel',
+        # GL_ARB_debug_output
+        'glDebugMessageControlARB',
+        'glDebugMessageInsertARB',
+        'glDebugMessageCallbackARB',
+        'glGetDebugMessageLogARB',
+        # GL_AMD_debug_output
+        'glDebugMessageEnableAMD',
+        'glDebugMessageInsertAMD',
+        'glDebugMessageCallbackAMD',
+        'glGetDebugMessageLogAMD',
+    ]
+
     def invokeFunction(self, function):
         if function.name in ('glLinkProgram', 'glLinkProgramARB'):
             # These functions have been dispatched already
             return
 
+        Tracer.invokeFunction(self, function)
+
+    def doInvokeFunction(self, function):
+        # Same as invokeFunction() but called both when trace is enabled or disabled.
+        #
+        # Used to modify the behavior of GL entry-points.
+
+        # Override GL extensions
+        if function.name in ('glGetString', 'glGetIntegerv', 'glGetStringi'):
+            Tracer.doInvokeFunction(self, function, prefix = 'gltrace::_', suffix = '_override')
+            return
+
         # We implement GL_EXT_debug_marker, GL_GREMEDY_*, etc., and not the
         # driver
         if function.name in self.marker_functions:
             return
 
-        if function.name in ('glXGetProcAddress', 'glXGetProcAddressARB', 'wglGetProcAddress'):
+        if function.name in self.getProcAddressFunctionNames:
             else_ = ''
             for marker_function in self.marker_functions:
                 if self.api.getFunctionByName(marker_function):
@@ -714,16 +766,19 @@ class GlTracer(Tracer):
                     print '    }'
                 else_ = 'else '
             print '    %s{' % else_
-            Tracer.invokeFunction(self, function)
-            print '    }'
-            return
+            Tracer.doInvokeFunction(self, function)
 
-        # Override GL extensions
-        if function.name in ('glGetString', 'glGetIntegerv', 'glGetStringi'):
-            Tracer.invokeFunction(self, function, prefix = 'gltrace::_', suffix = '_override')
+            # Replace function addresses with ours
+            # XXX: Doing this here instead of wrapRet means that the trace will
+            # contain the addresses of the wrapper functions, and not the real
+            # functions, but in practice this should make no difference.
+            if function.name in self.getProcAddressFunctionNames:
+                print '    _result = _wrapProcAddress(%s, _result);' % (function.args[0].name,)
+
+            print '    }'
             return
 
-        Tracer.invokeFunction(self, function)
+        Tracer.doInvokeFunction(self, function)
 
     buffer_targets = [
         'ARRAY_BUFFER',
@@ -742,10 +797,6 @@ class GlTracer(Tracer):
     def wrapRet(self, function, instance):
         Tracer.wrapRet(self, function, instance)
 
-        # Replace function addresses with ours
-        if function.name in self.getProcAddressFunctionNames:
-            print '    %s = _wrapProcAddress(%s, %s);' % (instance, function.args[0].name, instance)
-
         # Keep track of buffer mappings
         if function.name in ('glMapBuffer', 'glMapBufferARB'):
             print '    struct buffer_mapping *mapping = get_buffer_mapping(target);'
@@ -1059,6 +1110,16 @@ class GlTracer(Tracer):
         function = api.getFunctionByName('glClientActiveTexture')
         self.fake_call(function, [texture])
 
+    def emitFakeTexture2D(self):
+        function = glapi.glapi.getFunctionByName('glTexImage2D')
+        instances = function.argNames()
+        print '        unsigned _fake_call = trace::localWriter.beginEnter(&_%s_sig);' % (function.name,)
+        for arg in function.args:
+            assert not arg.output
+            self.serializeArg(function, arg)
+        print '        trace::localWriter.endEnter();'
+        print '        trace::localWriter.beginLeave(_fake_call);'
+        print '        trace::localWriter.endLeave();'