git.cworth.org Git - apitrace/blob - retrace/glretrace.py

   1 ##########################################################################
   2 #
   3 # Copyright 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 retracer generator."""
  28
  29
  30 from retrace import Retracer
  31 import specs.stdapi as stdapi
  32 import specs.glapi as glapi
  33 import specs.glesapi as glesapi
  34
  35
  36 class GlRetracer(Retracer):
  37
  38     table_name = 'glretrace::gl_callbacks'
  39
  40     def retraceFunction(self, function):
  41         Retracer.retraceFunction(self, function)
  42
  43     array_pointer_function_names = set((
  44         "glVertexPointer",
  45         "glNormalPointer",
  46         "glColorPointer",
  47         "glIndexPointer",
  48         "glTexCoordPointer",
  49         "glEdgeFlagPointer",
  50         "glFogCoordPointer",
  51         "glSecondaryColorPointer",
  52
  53         "glInterleavedArrays",
  54
  55         "glVertexPointerEXT",
  56         "glNormalPointerEXT",
  57         "glColorPointerEXT",
  58         "glIndexPointerEXT",
  59         "glTexCoordPointerEXT",
  60         "glEdgeFlagPointerEXT",
  61         "glFogCoordPointerEXT",
  62         "glSecondaryColorPointerEXT",
  63
  64         "glVertexAttribPointer",
  65         "glVertexAttribPointerARB",
  66         "glVertexAttribPointerNV",
  67         "glVertexAttribIPointer",
  68         "glVertexAttribIPointerEXT",
  69         "glVertexAttribLPointer",
  70         "glVertexAttribLPointerEXT",
  71
  72         #"glMatrixIndexPointerARB",
  73     ))
  74
  75     draw_array_function_names = set([
  76         "glDrawArrays",
  77         "glDrawArraysEXT",
  78         "glDrawArraysIndirect",
  79         "glDrawArraysInstanced",
  80         "glDrawArraysInstancedARB",
  81         "glDrawArraysInstancedEXT",
  82         "glDrawArraysInstancedBaseInstance",
  83         "glDrawMeshArraysSUN",
  84         "glMultiDrawArrays",
  85         "glMultiDrawArraysEXT",
  86         "glMultiModeDrawArraysIBM",
  87     ])
  88
  89     draw_elements_function_names = set([
  90         "glDrawElements",
  91         "glDrawElementsBaseVertex",
  92         "glDrawElementsIndirect",
  93         "glDrawElementsInstanced",
  94         "glDrawElementsInstancedARB",
  95         "glDrawElementsInstancedEXT",
  96         "glDrawElementsInstancedBaseVertex",
  97         "glDrawElementsInstancedBaseInstance",
  98         "glDrawElementsInstancedBaseVertexBaseInstance",
  99         "glDrawRangeElements",
 100         "glDrawRangeElementsEXT",
 101         "glDrawRangeElementsBaseVertex",
 102         "glMultiDrawElements",
 103         "glMultiDrawElementsBaseVertex",
 104         "glMultiDrawElementsEXT",
 105         "glMultiModeDrawElementsIBM",
 106     ])
 107
 108     draw_indirect_function_names = set([
 109         "glDrawArraysIndirect",
 110         "glDrawElementsIndirect",
 111     ])
 112
 113     misc_draw_function_names = set([
 114         "glCallList",
 115         "glCallLists",
 116         "glClear",
 117         "glEnd",
 118         "glDrawPixels",
 119         "glBlitFramebuffer",
 120         "glBlitFramebufferEXT",
 121     ])
 122
 123     bind_framebuffer_function_names = set([
 124         "glBindFramebuffer",
 125         "glBindFramebufferEXT",
 126         "glBindFramebufferOES",
 127     ])
 128
 129     # Names of the functions that can pack into the current pixel buffer
 130     # object.  See also the ARB_pixel_buffer_object specification.
 131     pack_function_names = set([
 132         'glGetCompressedTexImage',
 133         'glGetConvolutionFilter',
 134         'glGetHistogram',
 135         'glGetMinmax',
 136         'glGetPixelMapfv',
 137         'glGetPixelMapuiv',
 138         'glGetPixelMapusv',
 139         'glGetPolygonStipple',
 140         'glGetSeparableFilter',
 141         'glGetTexImage',
 142         'glReadPixels',
 143         'glGetnCompressedTexImageARB',
 144         'glGetnConvolutionFilterARB',
 145         'glGetnHistogramARB',
 146         'glGetnMinmaxARB',
 147         'glGetnPixelMapfvARB',
 148         'glGetnPixelMapuivARB',
 149         'glGetnPixelMapusvARB',
 150         'glGetnPolygonStippleARB',
 151         'glGetnSeparableFilterARB',
 152         'glGetnTexImageARB',
 153         'glReadnPixelsARB',
 154     ])
 155
 156     map_function_names = set([
 157         'glMapBuffer',
 158         'glMapBufferARB',
 159         'glMapBufferOES',
 160         'glMapBufferRange',
 161         'glMapNamedBufferEXT',
 162         'glMapNamedBufferRangeEXT',
 163         'glMapObjectBufferATI',
 164     ])
 165
 166     unmap_function_names = set([
 167         'glUnmapBuffer',
 168         'glUnmapBufferARB',
 169         'glUnmapBufferOES',
 170         'glUnmapNamedBufferEXT',
 171         'glUnmapObjectBufferATI',
 172     ])
 173
 174     def retraceFunctionBody(self, function):
 175         is_array_pointer = function.name in self.array_pointer_function_names
 176         is_draw_array = function.name in self.draw_array_function_names
 177         is_draw_elements = function.name in self.draw_elements_function_names
 178         is_misc_draw = function.name in self.misc_draw_function_names
 179
 180         if is_array_pointer or is_draw_array or is_draw_elements:
 181             print '    if (retrace::parser.version < 1) {'
 182
 183             if is_array_pointer or is_draw_array:
 184                 print '        GLint _array_buffer = 0;'
 185                 print '        glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &_array_buffer);'
 186                 print '        if (!_array_buffer) {'
 187                 self.failFunction(function)
 188                 print '        }'
 189
 190             if is_draw_elements:
 191                 print '        GLint _element_array_buffer = 0;'
 192                 print '        glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &_element_array_buffer);'
 193                 print '        if (!_element_array_buffer) {'
 194                 self.failFunction(function)
 195                 print '        }'
 196
 197             print '    }'
 198
 199         # When no pack buffer object is bound, the pack functions are no-ops.
 200         if function.name in self.pack_function_names:
 201             print '    GLint _pack_buffer = 0;'
 202             print '    glGetIntegerv(GL_PIXEL_PACK_BUFFER_BINDING, &_pack_buffer);'
 203             print '    if (!_pack_buffer) {'
 204             print '        return;'
 205             print '    }'
 206
 207         # Pre-snapshots
 208         if function.name in self.bind_framebuffer_function_names:
 209             print '    assert(call.flags & trace::CALL_FLAG_SWAP_RENDERTARGET);'
 210         if function.name == 'glFrameTerminatorGREMEDY':
 211             print '    glretrace::frame_complete(call);'
 212             return
 213
 214         Retracer.retraceFunctionBody(self, function)
 215
 216         # Post-snapshots
 217         if function.name in ('glFlush', 'glFinish'):
 218             print '    if (!retrace::doubleBuffer) {'
 219             print '        glretrace::frame_complete(call);'
 220             print '    }'
 221         if is_draw_array or is_draw_elements or is_misc_draw:
 222             print '    assert(call.flags & trace::CALL_FLAG_RENDER);'
 223
 224
 225     def invokeFunction(self, function):
 226         # Infer the drawable size from GL calls
 227         if function.name == "glViewport":
 228             print '    glretrace::updateDrawable(x + width, y + height);'
 229         if function.name == "glViewportArray":
 230             # We are concerned about drawables so only care for the first viewport
 231             print '    if (first == 0 && count > 0) {'
 232             print '        GLfloat x = v[0], y = v[1], w = v[2], h = v[3];'
 233             print '        glretrace::updateDrawable(x + w, y + h);'
 234             print '    }'
 235         if function.name == "glViewportIndexedf":
 236             print '    if (index == 0) {'
 237             print '        glretrace::updateDrawable(x + w, y + h);'
 238             print '    }'
 239         if function.name == "glViewportIndexedfv":
 240             print '    if (index == 0) {'
 241             print '        GLfloat x = v[0], y = v[1], w = v[2], h = v[3];'
 242             print '        glretrace::updateDrawable(x + w, y + h);'
 243             print '    }'
 244         if function.name in ('glBlitFramebuffer', 'glBlitFramebufferEXT'):
 245             # Some applications do all their rendering in a framebuffer, and
 246             # then just blit to the drawable without ever calling glViewport.
 247             print '    glretrace::updateDrawable(std::max(dstX0, dstX1), std::max(dstY0, dstY1));'
 248
 249         if function.name == "glEnd":
 250             print '    glretrace::insideGlBeginEnd = false;'
 251
 252         if function.name.startswith('gl') and not function.name.startswith('glX'):
 253             print r'    if (retrace::debug && !glretrace::currentContext) {'
 254             print r'        retrace::warning(call) << "no current context\n";'
 255             print r'    }'
 256
 257         if function.name == 'memcpy':
 258             print '    if (!dest || !src || !n) return;'
 259
 260         # Skip glEnable/Disable(GL_DEBUG_OUTPUT_SYNCHRONOUS_ARB) as we don't
 261         # faithfully set the CONTEXT_DEBUG_BIT_ARB flags on context creation.
 262         if function.name in ('glEnable', 'glDisable'):
 263             print '    if (cap == GL_DEBUG_OUTPUT_SYNCHRONOUS_ARB) return;'
 264
 265         # Destroy the buffer mapping
 266         if function.name in self.unmap_function_names:
 267             print r'        GLvoid *ptr = NULL;'
 268             if function.name == 'glUnmapBuffer':
 269                 print r'            glGetBufferPointerv(target, GL_BUFFER_MAP_POINTER, &ptr);'
 270             elif function.name == 'glUnmapBufferARB':
 271                 print r'            glGetBufferPointervARB(target, GL_BUFFER_MAP_POINTER_ARB, &ptr);'
 272             elif function.name == 'glUnmapBufferOES':
 273                 print r'            glGetBufferPointervOES(target, GL_BUFFER_MAP_POINTER_OES, &ptr);'
 274             elif function.name == 'glUnmapNamedBufferEXT':
 275                 print r'            glGetNamedBufferPointervEXT(buffer, GL_BUFFER_MAP_POINTER, &ptr);'
 276             elif function.name == 'glUnmapObjectBufferATI':
 277                 # TODO
 278                 pass
 279             else:
 280                 assert False
 281             print r'        if (ptr) {'
 282             print r'            retrace::delRegionByPointer(ptr);'
 283             print r'        } else {'
 284             print r'            retrace::warning(call) << "no current context\n";'
 285             print r'        }'
 286
 287         if function.name in ('glBindProgramPipeline', 'glBindProgramPipelineEXT'):
 288             # Note if glBindProgramPipeline has ever been called
 289             print r'    if (pipeline) {'
 290             print r'        _pipelineHasBeenBound = true;'
 291             print r'    }'
 292
 293         profileDraw = (
 294             function.name in self.draw_array_function_names or
 295             function.name in self.draw_elements_function_names or
 296             function.name in self.draw_indirect_function_names or
 297             function.name in self.misc_draw_function_names
 298         )
 299
 300         # Only profile if not inside a list as the queries get inserted into lsit
 301         if function.name == 'glNewList':
 302             print r'    glretrace::insideList = true;';
 303
 304         if function.name == 'glEndList':
 305             print r'    glretrace::insideList = false;';
 306
 307         if profileDraw:
 308             print r'    if (!glretrace::insideList && retrace::profileGPU) {'
 309             print r'        glretrace::beginProfileGPU(call);'
 310             print r'    }'
 311
 312         if function.name == 'glCreateShaderProgramv':
 313             # When dumping state, break down glCreateShaderProgramv so that the
 314             # shader source can be recovered.
 315             print r'    if (retrace::dumpingState) {'
 316             print r'        GLuint _shader = glCreateShader(type);'
 317             print r'        if (_shader) {'
 318             print r'            glShaderSource(_shader, count, strings, NULL);'
 319             print r'            glCompileShader(_shader);'
 320             print r'            const GLuint _program = glCreateProgram();'
 321             print r'            if (_program) {'
 322             print r'                GLint compiled = GL_FALSE;'
 323             print r'                glGetShaderiv(_shader, GL_COMPILE_STATUS, &compiled);'
 324             print r'                glProgramParameteri(_program, GL_PROGRAM_SEPARABLE, GL_TRUE);'
 325             print r'                if (compiled) {'
 326             print r'                    glAttachShader(_program, _shader);'
 327             print r'                    glLinkProgram(_program);'
 328             print r'                    //glDetachShader(_program, _shader);'
 329             print r'                }'
 330             print r'                //append-shader-info-log-to-program-info-log'
 331             print r'            }'
 332             print r'            //glDeleteShader(_shader);'
 333             print r'            _result = _program;'
 334             print r'        } else {'
 335             print r'            _result = 0;'
 336             print r'        }'
 337             print r'    } else {'
 338             Retracer.invokeFunction(self, function)
 339             print r'    }'
 340         else:
 341             Retracer.invokeFunction(self, function)
 342
 343         if profileDraw:
 344             print r'    if (!glretrace::insideList && retrace::profileGPU) {'
 345             print r'        glretrace::endProfileGPU(call);'
 346             print r'    }'
 347
 348         # Error checking
 349         if function.name == "glBegin":
 350             print '    glretrace::insideGlBeginEnd = true;'
 351         elif function.name.startswith('gl'):
 352             # glGetError is not allowed inside glBegin/glEnd
 353             print '    if (retrace::debug && !glretrace::insideGlBeginEnd) {'
 354             print '        glretrace::checkGlError(call);'
 355             if function.name in ('glProgramStringARB', 'glProgramStringNV'):
 356                 print r'        GLint error_position = -1;'
 357                 print r'        glGetIntegerv(GL_PROGRAM_ERROR_POSITION_ARB, &error_position);'
 358                 print r'        if (error_position != -1) {'
 359                 print r'            const char *error_string = (const char *)glGetString(GL_PROGRAM_ERROR_STRING_ARB);'
 360                 print r'            retrace::warning(call) << error_string << "\n";'
 361                 print r'        }'
 362             if function.name == 'glCompileShader':
 363                 print r'        GLint compile_status = 0;'
 364                 print r'        glGetShaderiv(shader, GL_COMPILE_STATUS, &compile_status);'
 365                 print r'        if (!compile_status) {'
 366                 print r'             GLint info_log_length = 0;'
 367                 print r'             glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &info_log_length);'
 368                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 369                 print r'             glGetShaderInfoLog(shader, info_log_length, NULL, infoLog);'
 370                 print r'             retrace::warning(call) << infoLog << "\n";'
 371                 print r'             delete [] infoLog;'
 372                 print r'        }'
 373             if function.name in ('glLinkProgram', 'glCreateShaderProgramv', 'glCreateShaderProgramEXT'):
 374                 if function.name != 'glLinkProgram':
 375                     print r'        GLuint program = _result;'
 376                 print r'        GLint link_status = 0;'
 377                 print r'        glGetProgramiv(program, GL_LINK_STATUS, &link_status);'
 378                 print r'        if (!link_status) {'
 379                 print r'             GLint info_log_length = 0;'
 380                 print r'             glGetProgramiv(program, GL_INFO_LOG_LENGTH, &info_log_length);'
 381                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 382                 print r'             glGetProgramInfoLog(program, info_log_length, NULL, infoLog);'
 383                 print r'             retrace::warning(call) << infoLog << "\n";'
 384                 print r'             delete [] infoLog;'
 385                 print r'        }'
 386             if function.name == 'glCompileShaderARB':
 387                 print r'        GLint compile_status = 0;'
 388                 print r'        glGetObjectParameterivARB(shaderObj, GL_OBJECT_COMPILE_STATUS_ARB, &compile_status);'
 389                 print r'        if (!compile_status) {'
 390                 print r'             GLint info_log_length = 0;'
 391                 print r'             glGetObjectParameterivARB(shaderObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
 392                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 393                 print r'             glGetInfoLogARB(shaderObj, info_log_length, NULL, infoLog);'
 394                 print r'             retrace::warning(call) << infoLog << "\n";'
 395                 print r'             delete [] infoLog;'
 396                 print r'        }'
 397             if function.name == 'glLinkProgramARB':
 398                 print r'        GLint link_status = 0;'
 399                 print r'        glGetObjectParameterivARB(programObj, GL_OBJECT_LINK_STATUS_ARB, &link_status);'
 400                 print r'        if (!link_status) {'
 401                 print r'             GLint info_log_length = 0;'
 402                 print r'             glGetObjectParameterivARB(programObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
 403                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 404                 print r'             glGetInfoLogARB(programObj, info_log_length, NULL, infoLog);'
 405                 print r'             retrace::warning(call) << infoLog << "\n";'
 406                 print r'             delete [] infoLog;'
 407                 print r'        }'
 408             if function.name in self.map_function_names:
 409                 print r'        if (!_result) {'
 410                 print r'             retrace::warning(call) << "failed to map buffer\n";'
 411                 print r'        }'
 412             if function.name in self.unmap_function_names and function.type is not stdapi.Void:
 413                 print r'        if (!_result) {'
 414                 print r'             retrace::warning(call) << "failed to unmap buffer\n";'
 415                 print r'        }'
 416             if function.name in ('glGetAttribLocation', 'glGetAttribLocationARB'):
 417                 print r'    GLint _origResult = call.ret->toSInt();'
 418                 print r'    if (_result != _origResult) {'
 419                 print r'        retrace::warning(call) << "vertex attrib location mismatch " << _origResult << " -> " << _result << "\n";'
 420                 print r'    }'
 421             if function.name in ('glCheckFramebufferStatus', 'glCheckFramebufferStatusEXT', 'glCheckNamedFramebufferStatusEXT'):
 422                 print r'    GLint _origResult = call.ret->toSInt();'
 423                 print r'    if (_origResult == GL_FRAMEBUFFER_COMPLETE &&'
 424                 print r'        _result != GL_FRAMEBUFFER_COMPLETE) {'
 425                 print r'        retrace::warning(call) << "incomplete framebuffer (" << glstate::enumToString(_result) << ")\n";'
 426                 print r'    }'
 427             print '    }'
 428
 429         # Query the buffer length for whole buffer mappings
 430         if function.name in self.map_function_names:
 431             if 'length' in function.argNames():
 432                 assert 'BufferRange' in function.name
 433             else:
 434                 assert 'BufferRange' not in function.name
 435                 print r'    GLint length = 0;'
 436                 if function.name in ('glMapBuffer', 'glMapBufferOES'):
 437                     print r'    glGetBufferParameteriv(target, GL_BUFFER_SIZE, &length);'
 438                 elif function.name == 'glMapBufferARB':
 439                     print r'    glGetBufferParameterivARB(target, GL_BUFFER_SIZE_ARB, &length);'
 440                 elif function.name == 'glMapNamedBufferEXT':
 441                     print r'    glGetNamedBufferParameterivEXT(buffer, GL_BUFFER_SIZE, &length);'
 442                 elif function.name == 'glMapObjectBufferATI':
 443                     print r'    glGetObjectBufferivATI(buffer, GL_OBJECT_BUFFER_SIZE_ATI, &length);'
 444                 else:
 445                     assert False
 446
 447     def extractArg(self, function, arg, arg_type, lvalue, rvalue):
 448         if function.name in self.array_pointer_function_names and arg.name == 'pointer':
 449             print '    %s = static_cast<%s>(retrace::toPointer(%s, true));' % (lvalue, arg_type, rvalue)
 450             return
 451
 452         if function.name in self.draw_elements_function_names and arg.name == 'indices' or\
 453            function.name in self.draw_indirect_function_names and arg.name == 'indirect':
 454             self.extractOpaqueArg(function, arg, arg_type, lvalue, rvalue)
 455             return
 456
 457         # Handle pointer with offsets into the current pack pixel buffer
 458         # object.
 459         if function.name in self.pack_function_names and arg.output:
 460             assert isinstance(arg_type, (stdapi.Pointer, stdapi.Array, stdapi.Blob, stdapi.Opaque))
 461             print '    %s = static_cast<%s>((%s).toPointer());' % (lvalue, arg_type, rvalue)
 462             return
 463
 464         if arg.type is glapi.GLlocation \
 465            and 'program' not in function.argNames():
 466             # Determine the active program for uniforms swizzling
 467             print '    GLint program = -1;'
 468             print '    GLint pipeline = 0;'
 469             print '    if (_pipelineHasBeenBound) {'
 470             print '        glGetIntegerv(GL_PROGRAM_PIPELINE_BINDING, &pipeline);'
 471             print '    }'
 472             print '    if (pipeline) {'
 473             print '        glGetProgramPipelineiv(pipeline, GL_ACTIVE_PROGRAM, &program);'
 474             print '    } else {'
 475             print '        glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
 476             print '    }'
 477             print
 478
 479         if arg.type is glapi.GLlocationARB \
 480            and 'programObj' not in function.argNames():
 481             print '    GLhandleARB programObj = glGetHandleARB(GL_PROGRAM_OBJECT_ARB);'
 482
 483         Retracer.extractArg(self, function, arg, arg_type, lvalue, rvalue)
 484
 485         # Don't try to use more samples than the implementation supports
 486         if arg.name == 'samples':
 487             assert arg.type is glapi.GLsizei
 488             print '    GLint max_samples = 0;'
 489             print '    glGetIntegerv(GL_MAX_SAMPLES, &max_samples);'
 490             print '    if (samples > max_samples) {'
 491             print '        samples = max_samples;'
 492             print '    }'
 493
 494         # These parameters are referred beyond the call life-time
 495         # TODO: Replace ad-hoc solution for bindable parameters with general one
 496         if function.name in ('glFeedbackBuffer', 'glSelectBuffer') and arg.output:
 497             print '    _allocator.bind(%s);' % arg.name
 498
 499
 500
 501 if __name__ == '__main__':
 502     print r'''
 503 #include <string.h>
 504
 505 #include "glproc.hpp"
 506 #include "glretrace.hpp"
 507 #include "glstate.hpp"
 508
 509
 510 static bool _pipelineHasBeenBound = false;
 511 '''
 512     api = glapi.glapi
 513     api.addApi(glesapi.glesapi)
 514     retracer = GlRetracer()
 515     retracer.retraceApi(api)