git.cworth.org Git - apitrace/blob - 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 import stdapi
  31 import glapi
  32 from retrace import Retracer
  33
  34
  35 class GlRetracer(Retracer):
  36
  37     def retrace_function(self, function):
  38         Retracer.retrace_function(self, function)
  39
  40     array_pointer_function_names = set((
  41         "glVertexPointer",
  42         "glNormalPointer",
  43         "glColorPointer",
  44         "glIndexPointer",
  45         "glTexCoordPointer",
  46         "glEdgeFlagPointer",
  47         "glFogCoordPointer",
  48         "glSecondaryColorPointer",
  49
  50         "glInterleavedArrays",
  51
  52         "glVertexPointerEXT",
  53         "glNormalPointerEXT",
  54         "glColorPointerEXT",
  55         "glIndexPointerEXT",
  56         "glTexCoordPointerEXT",
  57         "glEdgeFlagPointerEXT",
  58         "glFogCoordPointerEXT",
  59         "glSecondaryColorPointerEXT",
  60
  61         "glVertexAttribPointer",
  62         "glVertexAttribPointerARB",
  63         "glVertexAttribPointerNV",
  64         "glVertexAttribIPointer",
  65         "glVertexAttribIPointerEXT",
  66         "glVertexAttribLPointer",
  67         "glVertexAttribLPointerEXT",
  68
  69         #"glMatrixIndexPointerARB",
  70     ))
  71
  72     draw_array_function_names = set([
  73         "glDrawArrays",
  74         "glDrawArraysEXT",
  75         "glDrawArraysIndirect",
  76         "glDrawArraysInstanced",
  77         "glDrawArraysInstancedARB",
  78         "glDrawArraysInstancedEXT",
  79         "glDrawMeshArraysSUN",
  80         "glMultiDrawArrays",
  81         "glMultiDrawArraysEXT",
  82         "glMultiModeDrawArraysIBM",
  83     ])
  84
  85     draw_elements_function_names = set([
  86         "glDrawElements",
  87         "glDrawElementsBaseVertex",
  88         "glDrawElementsIndirect",
  89         "glDrawElementsInstanced",
  90         "glDrawElementsInstancedARB",
  91         "glDrawElementsInstancedBaseVertex",
  92         "glDrawElementsInstancedEXT",
  93         "glDrawRangeElements",
  94         "glDrawRangeElementsBaseVertex",
  95         "glDrawRangeElementsEXT",
  96         "glMultiDrawElements",
  97         "glMultiDrawElementsBaseVertex",
  98         "glMultiDrawElementsEXT",
  99         "glMultiModeDrawElementsIBM",
 100     ])
 101
 102     misc_draw_function_names = set([
 103         "glClear",
 104         "glEnd",
 105         "glDrawPixels",
 106         "glBlitFramebuffer",
 107         "glBlitFramebufferEXT",
 108     ])
 109
 110     bind_framebuffer_function_names = set([
 111         "glBindFramebuffer",
 112         "glBindFramebufferARB",
 113         "glBindFramebufferEXT",
 114     ])
 115
 116     # Names of the functions that can pack into the current pixel buffer
 117     # object.  See also the ARB_pixel_buffer_object specification.
 118     pack_function_names = set([
 119         'glGetCompressedTexImage',
 120         'glGetConvolutionFilter',
 121         'glGetHistogram',
 122         'glGetMinmax',
 123         'glGetPixelMapfv',
 124         'glGetPixelMapuiv',
 125         'glGetPixelMapusv',
 126         'glGetPolygonStipple',
 127         'glGetSeparableFilter,',
 128         'glGetTexImage',
 129         'glReadPixels',
 130         'glGetnCompressedTexImageARB',
 131         'glGetnConvolutionFilterARB',
 132         'glGetnHistogramARB',
 133         'glGetnMinmaxARB',
 134         'glGetnPixelMapfvARB',
 135         'glGetnPixelMapuivARB',
 136         'glGetnPixelMapusvARB',
 137         'glGetnPolygonStippleARB',
 138         'glGetnSeparableFilterARB',
 139         'glGetnTexImageARB',
 140         'glReadnPixelsARB',
 141     ])
 142
 143     def retrace_function_body(self, function):
 144         is_array_pointer = function.name in self.array_pointer_function_names
 145         is_draw_array = function.name in self.draw_array_function_names
 146         is_draw_elements = function.name in self.draw_elements_function_names
 147         is_misc_draw = function.name in self.misc_draw_function_names
 148
 149         if is_array_pointer or is_draw_array or is_draw_elements:
 150             print '    if (glretrace::parser.version < 1) {'
 151
 152             if is_array_pointer or is_draw_array:
 153                 print '        GLint __array_buffer = 0;'
 154                 print '        glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
 155                 print '        if (!__array_buffer) {'
 156                 self.fail_function(function)
 157                 print '        }'
 158
 159             if is_draw_elements:
 160                 print '        GLint __element_array_buffer = 0;'
 161                 print '        glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
 162                 print '        if (!__element_array_buffer) {'
 163                 self.fail_function(function)
 164                 print '        }'
 165
 166             print '    }'
 167
 168         # When no pack buffer object is bound, the pack functions are no-ops.
 169         if function.name in self.pack_function_names:
 170             print '    GLint __pack_buffer = 0;'
 171             print '    glGetIntegerv(GL_PIXEL_PACK_BUFFER_BINDING, &__pack_buffer);'
 172             print '    if (!__pack_buffer) {'
 173             print '        return;'
 174             print '    }'
 175
 176         # Pre-snapshots
 177         if function.name in self.bind_framebuffer_function_names:
 178             print '    if (glretrace::snapshot_frequency == glretrace::FREQUENCY_FRAMEBUFFER) {'
 179             print '        glretrace::snapshot(call.no - 1);'
 180             print '    }'
 181         if function.name == 'glFrameTerminatorGREMEDY':
 182             print '    glretrace::frame_complete(call.no);'
 183             return
 184
 185         Retracer.retrace_function_body(self, function)
 186
 187         # Post-snapshots
 188         if function.name in ('glFlush', 'glFinish'):
 189             print '    if (!glretrace::double_buffer) {'
 190             print '        glretrace::frame_complete(call.no);'
 191             print '    }'
 192         if function.name == 'glReadPixels':
 193             print '    glFinish();'
 194             print '    if (glretrace::snapshot_frequency == glretrace::FREQUENCY_FRAME ||'
 195             print '        glretrace::snapshot_frequency == glretrace::FREQUENCY_FRAMEBUFFER) {'
 196             print '        glretrace::snapshot(call.no);'
 197             print '    }'
 198         if is_draw_array or is_draw_elements or is_misc_draw:
 199             print '    if (glretrace::snapshot_frequency == glretrace::FREQUENCY_DRAW) {'
 200             print '        glretrace::snapshot(call.no);'
 201             print '    }'
 202
 203
 204     def call_function(self, function):
 205         if function.name == "glViewport":
 206             print '    GLint draw_framebuffer = 0;'
 207             print '    glGetIntegerv(GL_DRAW_FRAMEBUFFER_BINDING, &draw_framebuffer);'
 208             print '    if (draw_framebuffer == 0) {'
 209             print '        if (glretrace::drawable) {'
 210             print '            int drawable_width  = x + width;'
 211             print '            int drawable_height = y + height;'
 212             print '            if (drawable_width  > (int)glretrace::drawable->width ||'
 213             print '                drawable_height > (int)glretrace::drawable->height) {'
 214             print '                glretrace::drawable->resize(drawable_width, drawable_height);'
 215             print '                if (!glretrace::drawable->visible) {'
 216             print '                    glretrace::drawable->show();'
 217             print '                }'
 218             print '                glScissor(0, 0, drawable_width, drawable_height);'
 219             print '            }'
 220             print '        }'
 221             print '    }'
 222
 223         if function.name == "glEnd":
 224             print '    glretrace::insideGlBeginEnd = false;'
 225
 226         if function.name == 'memcpy':
 227             print '    if (!dest || !src || !n) return;'
 228
 229         Retracer.call_function(self, function)
 230
 231         # Error checking
 232         if function.name == "glBegin":
 233             print '    glretrace::insideGlBeginEnd = true;'
 234         elif function.name.startswith('gl'):
 235             # glGetError is not allowed inside glBegin/glEnd
 236             print '    if (!glretrace::benchmark && !glretrace::insideGlBeginEnd) {'
 237             print '        glretrace::checkGlError(call);'
 238             if function.name in ('glProgramStringARB', 'glProgramStringNV'):
 239                 print r'        GLint error_position = -1;'
 240                 print r'        glGetIntegerv(GL_PROGRAM_ERROR_POSITION_ARB, &error_position);'
 241                 print r'        if (error_position != -1) {'
 242                 print r'            const char *error_string = (const char *)glGetString(GL_PROGRAM_ERROR_STRING_ARB);'
 243                 print r'            std::cerr << call.no << ": warning: " << error_string << "\n";'
 244                 print r'        }'
 245             if function.name == 'glCompileShader':
 246                 print r'        GLint compile_status = 0;'
 247                 print r'        glGetShaderiv(shader, GL_COMPILE_STATUS, &compile_status);'
 248                 print r'        if (!compile_status) {'
 249                 print r'             GLint info_log_length = 0;'
 250                 print r'             glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &info_log_length);'
 251                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 252                 print r'             glGetShaderInfoLog(shader, info_log_length, NULL, infoLog);'
 253                 print r'             std::cerr << call.no << ": warning: " << infoLog << "\n";'
 254                 print r'             delete [] infoLog;'
 255                 print r'        }'
 256             if function.name == 'glLinkProgram':
 257                 print r'        GLint link_status = 0;'
 258                 print r'        glGetProgramiv(program, GL_LINK_STATUS, &link_status);'
 259                 print r'        if (!link_status) {'
 260                 print r'             GLint info_log_length = 0;'
 261                 print r'             glGetProgramiv(program, GL_INFO_LOG_LENGTH, &info_log_length);'
 262                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 263                 print r'             glGetProgramInfoLog(program, info_log_length, NULL, infoLog);'
 264                 print r'             std::cerr << call.no << ": warning: " << infoLog << "\n";'
 265                 print r'             delete [] infoLog;'
 266                 print r'        }'
 267             if function.name == 'glCompileShaderARB':
 268                 print r'        GLint compile_status = 0;'
 269                 print r'        glGetObjectParameterivARB(shaderObj, GL_OBJECT_COMPILE_STATUS_ARB, &compile_status);'
 270                 print r'        if (!compile_status) {'
 271                 print r'             GLint info_log_length = 0;'
 272                 print r'             glGetObjectParameterivARB(shaderObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
 273                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 274                 print r'             glGetInfoLogARB(shaderObj, info_log_length, NULL, infoLog);'
 275                 print r'             std::cerr << call.no << ": warning: " << infoLog << "\n";'
 276                 print r'             delete [] infoLog;'
 277                 print r'        }'
 278             if function.name == 'glLinkProgramARB':
 279                 print r'        GLint link_status = 0;'
 280                 print r'        glGetObjectParameterivARB(programObj, GL_OBJECT_LINK_STATUS_ARB, &link_status);'
 281                 print r'        if (!link_status) {'
 282                 print r'             GLint info_log_length = 0;'
 283                 print r'             glGetObjectParameterivARB(programObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
 284                 print r'             GLchar *infoLog = new GLchar[info_log_length];'
 285                 print r'             glGetInfoLogARB(programObj, info_log_length, NULL, infoLog);'
 286                 print r'             std::cerr << call.no << ": warning: " << infoLog << "\n";'
 287                 print r'             delete [] infoLog;'
 288                 print r'        }'
 289             if function.name in ('glMapBuffer', 'glMapBufferARB', 'glMapBufferRange', 'glMapNamedBufferEXT', 'glMapNamedBufferRangeEXT'):
 290                 print r'        if (!__result) {'
 291                 print r'             std::cerr << call.no << ": warning: failed to map buffer\n";'
 292                 print r'        }'
 293             if function.name in ('glGetAttribLocation', 'glGetAttribLocationARB'):
 294                 print r'    GLint __orig_result = call.ret->toSInt();'
 295                 print r'    if (__result != __orig_result) {'
 296                 print r'        std::cerr << call.no << ": warning vertex attrib location mismatch " << __orig_result << " -> " << __result << "\n";'
 297                 print r'    }'
 298             if function.name in ('glCheckFramebufferStatus', 'glCheckFramebufferStatusEXT', 'glCheckNamedFramebufferStatusEXT'):
 299                 print r'    GLint __orig_result = call.ret->toSInt();'
 300                 print r'    if (__orig_result == GL_FRAMEBUFFER_COMPLETE &&'
 301                 print r'        __result != GL_FRAMEBUFFER_COMPLETE) {'
 302                 print r'        std::cerr << call.no << ": incomplete framebuffer (" << __result << ")\n";'
 303                 print r'    }'
 304             print '    }'
 305
 306     def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
 307         if function.name in self.array_pointer_function_names and arg.name == 'pointer':
 308             print '    %s = static_cast<%s>(%s.toPointer(true));' % (lvalue, arg_type, rvalue)
 309             return
 310
 311         if function.name in self.draw_elements_function_names and arg.name == 'indices':
 312             self.extract_opaque_arg(function, arg, arg_type, lvalue, rvalue)
 313             return
 314
 315         # Handle pointer with offsets into the current pack pixel buffer
 316         # object.
 317         if function.name in self.pack_function_names and arg.output:
 318             self.extract_opaque_arg(function, arg, arg_type, lvalue, rvalue)
 319             return
 320
 321         if arg.type is glapi.GLlocation \
 322            and 'program' not in [arg.name for arg in function.args]:
 323             print '    GLint program = -1;'
 324             print '    glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
 325
 326         if arg.type is glapi.GLlocationARB \
 327            and 'programObj' not in [arg.name for arg in function.args]:
 328             print '    GLhandleARB programObj = glGetHandleARB(GL_PROGRAM_OBJECT_ARB);'
 329
 330         Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
 331
 332         # Don't try to use more samples than the implementation supports
 333         if arg.name == 'samples':
 334             assert arg.type is glapi.GLsizei
 335             print '    GLint max_samples = 0;'
 336             print '    glGetIntegerv(GL_MAX_SAMPLES, &max_samples);'
 337             print '    if (samples > max_samples) {'
 338             print '        samples = max_samples;'
 339             print '    }'
 340
 341
 342 if __name__ == '__main__':
 343     print r'''
 344 #include <string.h>
 345
 346 #include "glproc.hpp"
 347 #include "glretrace.hpp"
 348
 349
 350 '''
 351     api = glapi.glapi
 352     api.add_function(glapi.memcpy)
 353     retracer = GlRetracer()
 354     retracer.retrace_api(api)