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."""
32 from retrace import Retracer
35 class GlRetracer(Retracer):
37 def retrace_function(self, function):
38 Retracer.retrace_function(self, function)
40 array_pointer_function_names = set((
48 "glSecondaryColorPointer",
50 "glInterleavedArrays",
56 "glTexCoordPointerEXT",
57 "glEdgeFlagPointerEXT",
58 "glFogCoordPointerEXT",
59 "glSecondaryColorPointerEXT",
61 "glVertexAttribPointer",
62 "glVertexAttribPointerARB",
63 "glVertexAttribPointerNV",
64 "glVertexAttribIPointer",
65 "glVertexAttribIPointerEXT",
66 "glVertexAttribLPointer",
67 "glVertexAttribLPointerEXT",
69 #"glMatrixIndexPointerARB",
72 draw_array_function_names = set([
75 "glDrawArraysIndirect",
76 "glDrawArraysInstanced",
77 "glDrawArraysInstancedARB",
78 "glDrawArraysInstancedEXT",
79 "glDrawMeshArraysSUN",
81 "glMultiDrawArraysEXT",
82 "glMultiModeDrawArraysIBM",
85 draw_elements_function_names = set([
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",
102 def retrace_function_body(self, function):
103 is_array_pointer = function.name in self.array_pointer_function_names
104 is_draw_array = function.name in self.draw_array_function_names
105 is_draw_elements = function.name in self.draw_elements_function_names
107 if is_array_pointer or is_draw_array or is_draw_elements:
108 print ' if (glretrace::parser.version < 1) {'
110 if is_array_pointer or is_draw_array:
111 print ' GLint __array_buffer = 0;'
112 print ' glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
113 print ' if (!__array_buffer) {'
114 self.fail_function(function)
118 print ' GLint __element_array_buffer = 0;'
119 print ' glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
120 print ' if (!__element_array_buffer) {'
121 self.fail_function(function)
126 Retracer.retrace_function_body(self, function)
128 if function.name in ('glFlush', 'glFinish'):
129 print ' if (!glretrace::double_buffer) {'
130 print ' glretrace::frame_complete(call.no);'
133 if function.name == 'glReadPixels':
135 print ' glretrace::snapshot(call.no);'
137 def call_function(self, function):
138 if function.name == "glViewport":
139 print ' if (glretrace::drawable) {'
140 print ' int drawable_width = x + width;'
141 print ' int drawable_height = y + height;'
142 print ' if (drawable_width > (int)glretrace::drawable->width ||'
143 print ' drawable_height > (int)glretrace::drawable->height) {'
144 print ' glretrace::drawable->resize(drawable_width, drawable_height);'
145 print ' if (!glretrace::drawable->visible) {'
146 print ' glretrace::drawable->show();'
148 print ' glScissor(0, 0, drawable_width, drawable_height);'
152 if function.name == "glEnd":
153 print ' glretrace::insideGlBeginEnd = false;'
155 if function.name == 'memcpy':
156 print ' if (!dest || !src || !n) return;'
158 Retracer.call_function(self, function)
161 if function.name == "glBegin":
162 print ' glretrace::insideGlBeginEnd = true;'
163 elif function.name.startswith('gl'):
164 # glGetError is not allowed inside glBegin/glEnd
165 print ' if (!glretrace::benchmark && !glretrace::insideGlBeginEnd) {'
166 print ' glretrace::checkGlError(call);'
167 if function.name in ('glProgramStringARB', 'glProgramStringNV'):
168 print r' GLint error_position = -1;'
169 print r' glGetIntegerv(GL_PROGRAM_ERROR_POSITION_ARB, &error_position);'
170 print r' if (error_position != -1) {'
171 print r' const char *error_string = (const char *)glGetString(GL_PROGRAM_ERROR_STRING_ARB);'
172 print r' std::cerr << call.no << ": warning: " << error_string << "\n";'
174 if function.name == 'glCompileShader':
175 print r' GLint compile_status = 0;'
176 print r' glGetShaderiv(shader, GL_COMPILE_STATUS, &compile_status);'
177 print r' if (!compile_status) {'
178 print r' GLint info_log_length = 0;'
179 print r' glGetShaderiv(shader, GL_INFO_LOG_LENGTH, &info_log_length);'
180 print r' GLchar *infoLog = new GLchar[info_log_length];'
181 print r' glGetShaderInfoLog(shader, info_log_length, NULL, infoLog);'
182 print r' std::cerr << call.no << ": warning: " << infoLog << "\n";'
183 print r' delete [] infoLog;'
185 if function.name == 'glLinkProgram':
186 print r' GLint link_status = 0;'
187 print r' glGetProgramiv(program, GL_LINK_STATUS, &link_status);'
188 print r' if (!link_status) {'
189 print r' GLint info_log_length = 0;'
190 print r' glGetProgramiv(program, GL_INFO_LOG_LENGTH, &info_log_length);'
191 print r' GLchar *infoLog = new GLchar[info_log_length];'
192 print r' glGetProgramInfoLog(program, info_log_length, NULL, infoLog);'
193 print r' std::cerr << call.no << ": warning: " << infoLog << "\n";'
194 print r' delete [] infoLog;'
196 if function.name == 'glCompileShaderARB':
197 print r' GLint compile_status = 0;'
198 print r' glGetObjectParameterivARB(shaderObj, GL_OBJECT_COMPILE_STATUS_ARB, &compile_status);'
199 print r' if (!compile_status) {'
200 print r' GLint info_log_length = 0;'
201 print r' glGetObjectParameterivARB(shaderObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
202 print r' GLchar *infoLog = new GLchar[info_log_length];'
203 print r' glGetInfoLogARB(shaderObj, info_log_length, NULL, infoLog);'
204 print r' std::cerr << call.no << ": warning: " << infoLog << "\n";'
205 print r' delete [] infoLog;'
207 if function.name == 'glLinkProgramARB':
208 print r' GLint link_status = 0;'
209 print r' glGetObjectParameterivARB(programObj, GL_OBJECT_LINK_STATUS_ARB, &link_status);'
210 print r' if (!link_status) {'
211 print r' GLint info_log_length = 0;'
212 print r' glGetObjectParameterivARB(programObj, GL_OBJECT_INFO_LOG_LENGTH_ARB, &info_log_length);'
213 print r' GLchar *infoLog = new GLchar[info_log_length];'
214 print r' glGetInfoLogARB(programObj, info_log_length, NULL, infoLog);'
215 print r' std::cerr << call.no << ": warning: " << infoLog << "\n";'
216 print r' delete [] infoLog;'
218 if function.name in ('glMapBuffer', 'glMapBufferARB', 'glMapBufferRange', 'glMapNamedBufferEXT', 'glMapNamedBufferRangeEXT'):
219 print r' if (!__result) {'
220 print r' std::cerr << call.no << ": warning: failed to map buffer\n";'
222 if function.name in ('glGetAttribLocation', 'glGetAttribLocationARB'):
223 print r' GLint __orig_result = call.ret->toSInt();'
224 print r' if (__result != __orig_result) {'
225 print r' std::cerr << call.no << ": warning vertex attrib location mismatch " << __orig_result << " -> " << __result << "\n";'
229 def extract_arg(self, function, arg, arg_type, lvalue, rvalue):
230 if function.name in self.array_pointer_function_names and arg.name == 'pointer':
231 print ' %s = static_cast<%s>(%s.toPointer());' % (lvalue, arg_type, rvalue)
234 if function.name in self.draw_elements_function_names and arg.name == 'indices':
235 print ' %s = %s.toPointer();' % (lvalue, rvalue)
238 if arg.type is glapi.GLlocation \
239 and 'program' not in [arg.name for arg in function.args]:
240 print ' GLint program = -1;'
241 print ' glGetIntegerv(GL_CURRENT_PROGRAM, &program);'
243 if arg.type is glapi.GLlocationARB \
244 and 'programObj' not in [arg.name for arg in function.args]:
245 print ' GLhandleARB programObj = glGetHandleARB(GL_PROGRAM_OBJECT_ARB);'
247 Retracer.extract_arg(self, function, arg, arg_type, lvalue, rvalue)
249 # Don't try to use more samples than the implementation supports
250 if arg.name == 'samples':
251 assert arg.type is glapi.GLsizei
252 print ' GLint max_samples = 0;'
253 print ' glGetIntegerv(GL_MAX_SAMPLES, &max_samples);'
254 print ' if (samples > max_samples) {'
255 print ' samples = max_samples;'
259 if __name__ == '__main__':
263 #include "glproc.hpp"
264 #include "glretrace.hpp"
269 api.add_function(glapi.memcpy)
270 retracer = GlRetracer()
271 retracer.retrace_api(api)