"""GL retracer generator."""
-import stdapi
-import glapi
+import specs.stdapi as stdapi
+import specs.glapi as glapi
from retrace import Retracer
class GlRetracer(Retracer):
+ table_name = 'glretrace::gl_callbacks'
+
def retrace_function(self, function):
Retracer.retrace_function(self, function)
"glDrawArraysInstanced",
"glDrawArraysInstancedARB",
"glDrawArraysInstancedEXT",
+ "glDrawArraysInstancedBaseInstance",
"glDrawMeshArraysSUN",
"glMultiDrawArrays",
"glMultiDrawArraysEXT",
"glDrawElementsIndirect",
"glDrawElementsInstanced",
"glDrawElementsInstancedARB",
- "glDrawElementsInstancedBaseVertex",
"glDrawElementsInstancedEXT",
+ "glDrawElementsInstancedBaseVertex",
+ "glDrawElementsInstancedBaseInstance",
+ "glDrawElementsInstancedBaseVertexBaseInstance",
"glDrawRangeElements",
- "glDrawRangeElementsBaseVertex",
"glDrawRangeElementsEXT",
- #"glMultiDrawElements",
- #"glMultiDrawElementsBaseVertex",
- #"glMultiDrawElementsEXT",
- #"glMultiModeDrawElementsIBM",
+ "glDrawRangeElementsBaseVertex",
+ "glMultiDrawElements",
+ "glMultiDrawElementsBaseVertex",
+ "glMultiDrawElementsEXT",
+ "glMultiModeDrawElementsIBM",
+ ])
+
+ draw_indirect_function_names = set([
+ "glDrawArraysIndirect",
+ "glDrawElementsIndirect",
+ ])
+
+ misc_draw_function_names = set([
+ "glClear",
+ "glEnd",
+ "glDrawPixels",
+ "glBlitFramebuffer",
+ "glBlitFramebufferEXT",
+ ])
+
+ bind_framebuffer_function_names = set([
+ "glBindFramebuffer",
+ "glBindFramebufferARB",
+ "glBindFramebufferEXT",
+ ])
+
+ # Names of the functions that can pack into the current pixel buffer
+ # object. See also the ARB_pixel_buffer_object specification.
+ pack_function_names = set([
+ 'glGetCompressedTexImage',
+ 'glGetConvolutionFilter',
+ 'glGetHistogram',
+ 'glGetMinmax',
+ 'glGetPixelMapfv',
+ 'glGetPixelMapuiv',
+ 'glGetPixelMapusv',
+ 'glGetPolygonStipple',
+ 'glGetSeparableFilter',
+ 'glGetTexImage',
+ 'glReadPixels',
+ 'glGetnCompressedTexImageARB',
+ 'glGetnConvolutionFilterARB',
+ 'glGetnHistogramARB',
+ 'glGetnMinmaxARB',
+ 'glGetnPixelMapfvARB',
+ 'glGetnPixelMapuivARB',
+ 'glGetnPixelMapusvARB',
+ 'glGetnPolygonStippleARB',
+ 'glGetnSeparableFilterARB',
+ 'glGetnTexImageARB',
+ 'glReadnPixelsARB',
+ ])
+
+ map_function_names = set([
+ 'glMapBuffer',
+ 'glMapBufferARB',
+ 'glMapBufferRange',
+ 'glMapNamedBufferEXT',
+ 'glMapNamedBufferRangeEXT'
+ ])
+
+ unmap_function_names = set([
+ 'glUnmapBuffer',
+ 'glUnmapBufferARB',
+ 'glUnmapNamedBufferEXT',
])
def retrace_function_body(self, function):
is_array_pointer = function.name in self.array_pointer_function_names
is_draw_array = function.name in self.draw_array_function_names
is_draw_elements = function.name in self.draw_elements_function_names
+ is_misc_draw = function.name in self.misc_draw_function_names
if is_array_pointer or is_draw_array or is_draw_elements:
print ' if (glretrace::parser.version < 1) {'
print ' }'
- Retracer.retrace_function_body(self, function)
+ # When no pack buffer object is bound, the pack functions are no-ops.
+ if function.name in self.pack_function_names:
+ print ' GLint __pack_buffer = 0;'
+ print ' glGetIntegerv(GL_PIXEL_PACK_BUFFER_BINDING, &__pack_buffer);'
+ print ' if (!__pack_buffer) {'
+ if function.name == 'glReadPixels':
+ print ' glFinish();'
+ print ' if (glretrace::snapshot_frequency == glretrace::FREQUENCY_FRAME ||'
+ print ' glretrace::snapshot_frequency == glretrace::FREQUENCY_FRAMEBUFFER) {'
+ print ' glretrace::snapshot(call.no);'
+ print ' }'
+ print ' return;'
+ print ' }'
- def call_function(self, function):
- if function.name == "glViewport":
- print ' bool reshape_window = false;'
- print ' if (x + width > glretrace::window_width) {'
- print ' glretrace::window_width = x + width;'
- print ' reshape_window = true;'
+ # Pre-snapshots
+ if function.name in self.bind_framebuffer_function_names:
+ print ' if (glretrace::snapshot_frequency == glretrace::FREQUENCY_FRAMEBUFFER) {'
+ print ' glretrace::snapshot(call.no - 1);'
print ' }'
- print ' if (y + height > glretrace::window_height) {'
- print ' glretrace::window_height = y + height;'
- print ' reshape_window = true;'
+ if function.name == 'glFrameTerminatorGREMEDY':
+ print ' glretrace::frame_complete(call);'
+ return
+
+ Retracer.retrace_function_body(self, function)
+
+ # Post-snapshots
+ if function.name in ('glFlush', 'glFinish'):
+ print ' if (!glretrace::double_buffer) {'
+ print ' glretrace::frame_complete(call);'
print ' }'
- print ' if (reshape_window) {'
- print ' // XXX: does not always work'
- print ' glretrace::drawable->resize(glretrace::window_width, glretrace::window_height);'
- print ' reshape_window = false;'
+ if is_draw_array or is_draw_elements or is_misc_draw:
+ print ' if (glretrace::snapshot_frequency == glretrace::FREQUENCY_DRAW) {'
+ print ' glretrace::snapshot(call.no);'
print ' }'
+
+ def call_function(self, function):
+ # Infer the drawable size from GL calls
+ if function.name == "glViewport":
+ print ' glretrace::updateDrawable(x + width, y + height);'
+ if function.name in ('glBlitFramebuffer', 'glBlitFramebufferEXT'):
+ # Some applications do all their rendering in a framebuffer, and
+ # then just blit to the drawable without ever calling glViewport.
+ print ' glretrace::updateDrawable(std::max(dstX0, dstX1), std::max(dstY0, dstY1));'
+
if function.name == "glEnd":
print ' glretrace::insideGlBeginEnd = false;'
+
+ if function.name == 'memcpy':
+ print ' if (!dest || !src || !n) return;'
Retracer.call_function(self, function)
+ # Error checking
if function.name == "glBegin":
print ' glretrace::insideGlBeginEnd = true;'
- else:
+ elif function.name.startswith('gl'):
# glGetError is not allowed inside glBegin/glEnd
- print ' glretrace::checkGlError(call.no);'
-
- if function.name == 'glFlush':
- print ' if (!glretrace::double_buffer) {'
- print ' glretrace::frame_complete(call.no);'
+ print ' if (!glretrace::benchmark && !glretrace::insideGlBeginEnd) {'
+ print ' glretrace::checkGlError(call);'
+ if function.name in ('glProgramStringARB', 'glProgramStringNV'):
+ print r' GLint error_position = -1;'
+ print r' glGetIntegerv(GL_PROGRAM_ERROR_POSITION_ARB, &error_position);'
+ print r' if (error_position != -1) {'
+ print r' const char *error_string = (const char *)glGetString(GL_PROGRAM_ERROR_STRING_ARB);'
+ print r' retrace::warning(call) << error_string << "\n";'
+ print r' }'
+ if function.name == 'glCompileShader':
+ print r' GLint compile_status = 0;'
+ print r' glGetShaderiv(shader, GL_COMPILE_STATUS, &compile_status);'
+ print r' if (!compile_status) {'
+ print r' GLint info_log_length = 0;'
+ print r' glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &info_log_length);'
+ print r' GLchar *infoLog = new GLchar[info_log_length];'
+ print r' glGetShaderInfoLog(shader, info_log_length, NULL, infoLog);'
+ print r' retrace::warning(call) << infoLog << "\n";'
+ print r' delete [] infoLog;'
+ print r' }'
+ if function.name == 'glLinkProgram':
+ print r' GLint link_status = 0;'
+ print r' glGetProgramiv(program, GL_LINK_STATUS, &link_status);'
+ print r' if (!link_status) {'
+ print r' GLint info_log_length = 0;'
+ print r' glGetProgramiv(program, GL_INFO_LOG_LENGTH, &info_log_length);'
+ print r' GLchar *infoLog = new GLchar[info_log_length];'
+ print r' glGetProgramInfoLog(program, info_log_length, NULL, infoLog);'
+ print r' retrace::warning(call) << infoLog << "\n";'
+ print r' delete [] infoLog;'
+ print r' }'
+ if function.name == 'glCompileShaderARB':
+ print r' GLint compile_status = 0;'
+ print r' glGetObjectParameterivARB(shaderObj, GL_OBJECT_COMPILE_STATUS_ARB, &compile_status);'
+ print r' if (!compile_status) {'
+ print r' GLint info_log_length = 0;'
+ print r' glGetObjectParameterivARB(shaderObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
+ print r' GLchar *infoLog = new GLchar[info_log_length];'
+ print r' glGetInfoLogARB(shaderObj, info_log_length, NULL, infoLog);'
+ print r' retrace::warning(call) << infoLog << "\n";'
+ print r' delete [] infoLog;'
+ print r' }'
+ if function.name == 'glLinkProgramARB':
+ print r' GLint link_status = 0;'
+ print r' glGetObjectParameterivARB(programObj, GL_OBJECT_LINK_STATUS_ARB, &link_status);'
+ print r' if (!link_status) {'
+ print r' GLint info_log_length = 0;'
+ print r' glGetObjectParameterivARB(programObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
+ print r' GLchar *infoLog = new GLchar[info_log_length];'
+ print r' glGetInfoLogARB(programObj, info_log_length, NULL, infoLog);'
+ print r' retrace::warning(call) << infoLog << "\n";'
+ print r' delete [] infoLog;'
+ print r' }'
+ if function.name in self.map_function_names:
+ print r' if (!__result) {'
+ print r' retrace::warning(call) << "failed to map buffer\n";'
+ print r' }'
+ if function.name in ('glGetAttribLocation', 'glGetAttribLocationARB'):
+ print r' GLint __orig_result = call.ret->toSInt();'
+ print r' if (__result != __orig_result) {'
+ print r' retrace::warning(call) << "vertex attrib location mismatch " << __orig_result << " -> " << __result << "\n";'
+ print r' }'
+ if function.name in ('glCheckFramebufferStatus', 'glCheckFramebufferStatusEXT', 'glCheckNamedFramebufferStatusEXT'):
+ print r' GLint __orig_result = call.ret->toSInt();'
+ print r' if (__orig_result == GL_FRAMEBUFFER_COMPLETE &&'
+ print r' __result != GL_FRAMEBUFFER_COMPLETE) {'
+ print r' retrace::warning(call) << "incomplete framebuffer (" << glstate::enumToString(__result) << ")\n";'
+ print r' }'
print ' }'
+ # Update buffer mappings
+ if function.name in self.map_function_names:
+ print r' if (__result) {'
+ print r' unsigned long long __address = call.ret->toUIntPtr();'
+ if 'BufferRange' not in function.name:
+ print r' GLint length = 0;'
+ if function.name == 'glMapBuffer':
+ print r' glGetBufferParameteriv(target, GL_BUFFER_SIZE, &length);'
+ elif function.name == 'glMapBufferARB':
+ print r' glGetBufferParameterivARB(target, GL_BUFFER_SIZE_ARB, &length);'
+ elif function.name == 'glMapNamedBufferEXT':
+ print r' glGetNamedBufferParameterivEXT(buffer, GL_BUFFER_SIZE, &length);'
+ else:
+ assert False
+ print r' retrace::addRegion(__address, __result, length);'
+ print r' }'
+ if function.name in self.unmap_function_names:
+ print r' GLvoid *ptr = NULL;'
+ if function.name == 'glUnmapBuffer':
+ print r' glGetBufferPointerv(target, GL_BUFFER_MAP_POINTER, &ptr);'
+ elif function.name == 'glUnmapBufferARB':
+ print r' glGetBufferPointervARB(target, GL_BUFFER_MAP_POINTER_ARB, &ptr);'
+ elif function.name == 'glUnmapNamedBufferEXT':
+ print r' glGetNamedBufferPointervEXT(buffer, GL_BUFFER_MAP_POINTER, &ptr);'
+ else:
+ assert False
+ print r' if (ptr) {'
+ print r' retrace::delRegionByPointer(ptr);'
+ print r' }'
+
def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
if function.name in self.array_pointer_function_names and arg.name == 'pointer':
- print ' %s = static_cast<%s>(%s.blob());' % (lvalue, arg_type, rvalue)
+ print ' %s = static_cast<%s>(retrace::toPointer(%s, true));' % (lvalue, arg_type, rvalue)
return
- if function.name in self.draw_elements_function_names and arg.name == 'indices':
- print ' %s = %s.blob();' % (lvalue, rvalue)
+ if function.name in self.draw_elements_function_names and arg.name == 'indices' or\
+ function.name in self.draw_indirect_function_names and arg.name == 'indirect':
+ self.extract_opaque_arg(function, arg, arg_type, lvalue, rvalue)
return
- if function.name.startswith('glUniform') and function.args[0].name == arg.name == 'location':
+ # Handle pointer with offsets into the current pack pixel buffer
+ # object.
+ if function.name in self.pack_function_names and arg.output:
+ self.extract_opaque_arg(function, arg, arg_type, lvalue, rvalue)
+ return
+
+ if arg.type is glapi.GLlocation \
+ and 'program' not in [arg.name for arg in function.args]:
print ' GLint program = -1;'
print ' glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
+
+ if arg.type is glapi.GLlocationARB \
+ and 'programObj' not in [arg.name for arg in function.args]:
+ print ' GLhandleARB programObj = glGetHandleARB(GL_PROGRAM_OBJECT_ARB);'
Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
+ # Don't try to use more samples than the implementation supports
+ if arg.name == 'samples':
+ assert arg.type is glapi.GLsizei
+ print ' GLint max_samples = 0;'
+ print ' glGetIntegerv(GL_MAX_SAMPLES, &max_samples);'
+ print ' if (samples > max_samples) {'
+ print ' samples = max_samples;'
+ print ' }'
+
if __name__ == '__main__':
print r'''
#include "glproc.hpp"
#include "glretrace.hpp"
+#include "glstate.hpp"
'''
api = glapi.glapi
- api.add_function(glapi.memcpy)
retracer = GlRetracer()
- retracer.retrace_api(glapi.glapi)
+ retracer.retrace_api(api)
projects / apitrace / blobdiff