1 ##########################################################################
3 # Copyright 2010 VMware, Inc.
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:
13 # The above copyright notice and this permission notice shall be included in
14 # all copies or substantial portions of the Software.
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
24 ##########################################################################/
27 """GL retracer generator."""
30 import specs.stdapi as stdapi
31 import specs.glapi as glapi
32 import specs.glesapi as glesapi
33 from retrace import Retracer
36 class GlRetracer(Retracer):
38 table_name = 'glretrace::gl_callbacks'
40 def retraceFunction(self, function):
41 Retracer.retraceFunction(self, function)
43 array_pointer_function_names = set((
51 "glSecondaryColorPointer",
53 "glInterleavedArrays",
59 "glTexCoordPointerEXT",
60 "glEdgeFlagPointerEXT",
61 "glFogCoordPointerEXT",
62 "glSecondaryColorPointerEXT",
64 "glVertexAttribPointer",
65 "glVertexAttribPointerARB",
66 "glVertexAttribPointerNV",
67 "glVertexAttribIPointer",
68 "glVertexAttribIPointerEXT",
69 "glVertexAttribLPointer",
70 "glVertexAttribLPointerEXT",
72 #"glMatrixIndexPointerARB",
75 draw_array_function_names = set([
78 "glDrawArraysIndirect",
79 "glDrawArraysInstanced",
80 "glDrawArraysInstancedARB",
81 "glDrawArraysInstancedEXT",
82 "glDrawArraysInstancedBaseInstance",
83 "glDrawMeshArraysSUN",
85 "glMultiDrawArraysEXT",
86 "glMultiModeDrawArraysIBM",
89 draw_elements_function_names = set([
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",
108 draw_indirect_function_names = set([
109 "glDrawArraysIndirect",
110 "glDrawElementsIndirect",
113 misc_draw_function_names = set([
120 "glBlitFramebufferEXT",
123 bind_framebuffer_function_names = set([
125 "glBindFramebufferEXT",
126 "glBindFramebufferOES",
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',
139 'glGetPolygonStipple',
140 'glGetSeparableFilter',
143 'glGetnCompressedTexImageARB',
144 'glGetnConvolutionFilterARB',
145 'glGetnHistogramARB',
147 'glGetnPixelMapfvARB',
148 'glGetnPixelMapuivARB',
149 'glGetnPixelMapusvARB',
150 'glGetnPolygonStippleARB',
151 'glGetnSeparableFilterARB',
156 map_function_names = set([
161 'glMapNamedBufferEXT',
162 'glMapNamedBufferRangeEXT'
165 unmap_function_names = set([
169 'glUnmapNamedBufferEXT',
172 def retraceFunctionBody(self, function):
173 is_array_pointer = function.name in self.array_pointer_function_names
174 is_draw_array = function.name in self.draw_array_function_names
175 is_draw_elements = function.name in self.draw_elements_function_names
176 is_misc_draw = function.name in self.misc_draw_function_names
178 if is_array_pointer or is_draw_array or is_draw_elements:
179 print ' if (glretrace::parser.version < 1) {'
181 if is_array_pointer or is_draw_array:
182 print ' GLint __array_buffer = 0;'
183 print ' glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
184 print ' if (!__array_buffer) {'
185 self.failFunction(function)
189 print ' GLint __element_array_buffer = 0;'
190 print ' glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
191 print ' if (!__element_array_buffer) {'
192 self.failFunction(function)
197 # When no pack buffer object is bound, the pack functions are no-ops.
198 if function.name in self.pack_function_names:
199 print ' GLint __pack_buffer = 0;'
200 print ' glGetIntegerv(GL_PIXEL_PACK_BUFFER_BINDING, &__pack_buffer);'
201 print ' if (!__pack_buffer) {'
206 if function.name in self.bind_framebuffer_function_names:
207 print ' assert(call.flags & trace::CALL_FLAG_SWAP_RENDERTARGET);'
208 if function.name == 'glFrameTerminatorGREMEDY':
209 print ' glretrace::frame_complete(call);'
212 Retracer.retraceFunctionBody(self, function)
215 if function.name in ('glFlush', 'glFinish'):
216 print ' if (!glretrace::double_buffer) {'
217 print ' glretrace::frame_complete(call);'
219 if is_draw_array or is_draw_elements or is_misc_draw:
220 print ' assert(call.flags & trace::CALL_FLAG_RENDER);'
223 def invokeFunction(self, function):
224 # Infer the drawable size from GL calls
225 if function.name == "glViewport":
226 print ' glretrace::updateDrawable(x + width, y + height);'
227 if function.name == "glViewportArray":
228 # We are concerned about drawables so only care for the first viewport
229 print ' if (first == 0 && count > 0) {'
230 print ' GLfloat x = v[0], y = v[1], w = v[2], h = v[3];'
231 print ' glretrace::updateDrawable(x + w, y + h);'
233 if function.name == "glViewportIndexedf":
234 print ' if (index == 0) {'
235 print ' glretrace::updateDrawable(x + w, y + h);'
237 if function.name == "glViewportIndexedfv":
238 print ' if (index == 0) {'
239 print ' GLfloat x = v[0], y = v[1], w = v[2], h = v[3];'
240 print ' glretrace::updateDrawable(x + w, y + h);'
242 if function.name in ('glBlitFramebuffer', 'glBlitFramebufferEXT'):
243 # Some applications do all their rendering in a framebuffer, and
244 # then just blit to the drawable without ever calling glViewport.
245 print ' glretrace::updateDrawable(std::max(dstX0, dstX1), std::max(dstY0, dstY1));'
247 if function.name == "glEnd":
248 print ' glretrace::insideGlBeginEnd = false;'
250 if function.name.startswith('gl') and not function.name.startswith('glX'):
251 print r' if (!glretrace::context && !glretrace::benchmark && !retrace::profiling) {'
252 print r' retrace::warning(call) << "no current context\n";'
255 if function.name == 'memcpy':
256 print ' if (!dest || !src || !n) return;'
258 # Destroy the buffer mapping
259 if function.name in self.unmap_function_names:
260 print r' GLvoid *ptr = NULL;'
261 if function.name == 'glUnmapBuffer':
262 print r' glGetBufferPointerv(target, GL_BUFFER_MAP_POINTER, &ptr);'
263 elif function.name == 'glUnmapBufferARB':
264 print r' glGetBufferPointervARB(target, GL_BUFFER_MAP_POINTER_ARB, &ptr);'
265 elif function.name == 'glUnmapBufferOES':
266 print r' glGetBufferPointervOES(target, GL_BUFFER_MAP_POINTER_OES, &ptr);'
267 elif function.name == 'glUnmapNamedBufferEXT':
268 print r' glGetNamedBufferPointervEXT(buffer, GL_BUFFER_MAP_POINTER, &ptr);'
272 print r' retrace::delRegionByPointer(ptr);'
274 print r' retrace::warning(call) << "no current context\n";'
277 Retracer.invokeFunction(self, function)
280 if function.name == "glBegin":
281 print ' glretrace::insideGlBeginEnd = true;'
282 elif function.name.startswith('gl'):
283 # glGetError is not allowed inside glBegin/glEnd
284 print ' if (!glretrace::benchmark && !retrace::profiling && !glretrace::insideGlBeginEnd) {'
285 print ' glretrace::checkGlError(call);'
286 if function.name in ('glProgramStringARB', 'glProgramStringNV'):
287 print r' GLint error_position = -1;'
288 print r' glGetIntegerv(GL_PROGRAM_ERROR_POSITION_ARB, &error_position);'
289 print r' if (error_position != -1) {'
290 print r' const char *error_string = (const char *)glGetString(GL_PROGRAM_ERROR_STRING_ARB);'
291 print r' retrace::warning(call) << error_string << "\n";'
293 if function.name == 'glCompileShader':
294 print r' GLint compile_status = 0;'
295 print r' glGetShaderiv(shader, GL_COMPILE_STATUS, &compile_status);'
296 print r' if (!compile_status) {'
297 print r' GLint info_log_length = 0;'
298 print r' glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &info_log_length);'
299 print r' GLchar *infoLog = new GLchar[info_log_length];'
300 print r' glGetShaderInfoLog(shader, info_log_length, NULL, infoLog);'
301 print r' retrace::warning(call) << infoLog << "\n";'
302 print r' delete [] infoLog;'
304 if function.name == 'glLinkProgram':
305 print r' GLint link_status = 0;'
306 print r' glGetProgramiv(program, GL_LINK_STATUS, &link_status);'
307 print r' if (!link_status) {'
308 print r' GLint info_log_length = 0;'
309 print r' glGetProgramiv(program, GL_INFO_LOG_LENGTH, &info_log_length);'
310 print r' GLchar *infoLog = new GLchar[info_log_length];'
311 print r' glGetProgramInfoLog(program, info_log_length, NULL, infoLog);'
312 print r' retrace::warning(call) << infoLog << "\n";'
313 print r' delete [] infoLog;'
315 if function.name == 'glCompileShaderARB':
316 print r' GLint compile_status = 0;'
317 print r' glGetObjectParameterivARB(shaderObj, GL_OBJECT_COMPILE_STATUS_ARB, &compile_status);'
318 print r' if (!compile_status) {'
319 print r' GLint info_log_length = 0;'
320 print r' glGetObjectParameterivARB(shaderObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
321 print r' GLchar *infoLog = new GLchar[info_log_length];'
322 print r' glGetInfoLogARB(shaderObj, info_log_length, NULL, infoLog);'
323 print r' retrace::warning(call) << infoLog << "\n";'
324 print r' delete [] infoLog;'
326 if function.name == 'glLinkProgramARB':
327 print r' GLint link_status = 0;'
328 print r' glGetObjectParameterivARB(programObj, GL_OBJECT_LINK_STATUS_ARB, &link_status);'
329 print r' if (!link_status) {'
330 print r' GLint info_log_length = 0;'
331 print r' glGetObjectParameterivARB(programObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
332 print r' GLchar *infoLog = new GLchar[info_log_length];'
333 print r' glGetInfoLogARB(programObj, info_log_length, NULL, infoLog);'
334 print r' retrace::warning(call) << infoLog << "\n";'
335 print r' delete [] infoLog;'
337 if function.name in self.map_function_names:
338 print r' if (!__result) {'
339 print r' retrace::warning(call) << "failed to map buffer\n";'
341 if function.name in self.unmap_function_names:
342 print r' if (!__result) {'
343 print r' retrace::warning(call) << "failed to unmap buffer\n";'
345 if function.name in ('glGetAttribLocation', 'glGetAttribLocationARB'):
346 print r' GLint __orig_result = call.ret->toSInt();'
347 print r' if (__result != __orig_result) {'
348 print r' retrace::warning(call) << "vertex attrib location mismatch " << __orig_result << " -> " << __result << "\n";'
350 if function.name in ('glCheckFramebufferStatus', 'glCheckFramebufferStatusEXT', 'glCheckNamedFramebufferStatusEXT'):
351 print r' GLint __orig_result = call.ret->toSInt();'
352 print r' if (__orig_result == GL_FRAMEBUFFER_COMPLETE &&'
353 print r' __result != GL_FRAMEBUFFER_COMPLETE) {'
354 print r' retrace::warning(call) << "incomplete framebuffer (" << glstate::enumToString(__result) << ")\n";'
358 # Query the buffer length for whole buffer mappings
359 if function.name in self.map_function_names:
360 if 'length' in function.argNames():
361 assert 'BufferRange' in function.name
363 assert 'BufferRange' not in function.name
364 print r' GLint length = 0;'
365 if function.name in ('glMapBuffer', 'glMapBufferOES'):
366 print r' glGetBufferParameteriv(target, GL_BUFFER_SIZE, &length);'
367 elif function.name == 'glMapBufferARB':
368 print r' glGetBufferParameterivARB(target, GL_BUFFER_SIZE_ARB, &length);'
369 elif function.name == 'glMapNamedBufferEXT':
370 print r' glGetNamedBufferParameterivEXT(buffer, GL_BUFFER_SIZE, &length);'
374 def extractArg(self, function, arg, arg_type, lvalue, rvalue):
375 if function.name in self.array_pointer_function_names and arg.name == 'pointer':
376 print ' %s = static_cast<%s>(retrace::toPointer(%s, true));' % (lvalue, arg_type, rvalue)
379 if function.name in self.draw_elements_function_names and arg.name == 'indices' or\
380 function.name in self.draw_indirect_function_names and arg.name == 'indirect':
381 self.extractOpaqueArg(function, arg, arg_type, lvalue, rvalue)
384 # Handle pointer with offsets into the current pack pixel buffer
386 if function.name in self.pack_function_names and arg.output:
387 self.extractOpaqueArg(function, arg, arg_type, lvalue, rvalue)
390 if arg.type is glapi.GLlocation \
391 and 'program' not in function.argNames():
392 print ' GLint program = -1;'
393 print ' glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
395 if arg.type is glapi.GLlocationARB \
396 and 'programObj' not in function.argNames():
397 print ' GLhandleARB programObj = glGetHandleARB(GL_PROGRAM_OBJECT_ARB);'
399 Retracer.extractArg(self, function, arg, arg_type, lvalue, rvalue)
401 # Don't try to use more samples than the implementation supports
402 if arg.name == 'samples':
403 assert arg.type is glapi.GLsizei
404 print ' GLint max_samples = 0;'
405 print ' glGetIntegerv(GL_MAX_SAMPLES, &max_samples);'
406 print ' if (samples > max_samples) {'
407 print ' samples = max_samples;'
411 if __name__ == '__main__':
415 #include "glproc.hpp"
416 #include "glretrace.hpp"
417 #include "glstate.hpp"
422 api.addApi(glesapi.glesapi)
423 retracer = GlRetracer()
424 retracer.retraceApi(api)