1 ##########################################################################
3 # Copyright 2008-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 tracing generator."""
33 from glxapi import glxapi
34 from trace import Tracer, dump_instance
37 class TypeGetter(stdapi.Visitor):
38 '''Determine which glGet*v function that matches the specified type.'''
40 def __init__(self, prefix = 'glGet', long_suffix = True):
42 self.long_suffix = long_suffix
44 def visit_const(self, const):
45 return self.visit(const.type)
47 def visit_alias(self, alias):
48 if alias.expr == 'GLboolean':
50 return self.prefix + 'Booleanv', alias.expr
52 return self.prefix + 'iv', 'GLint'
53 elif alias.expr == 'GLdouble':
55 return self.prefix + 'Doublev', alias.expr
57 return self.prefix + 'dv', alias.expr
58 elif alias.expr == 'GLfloat':
60 return self.prefix + 'Floatv', alias.expr
62 return self.prefix + 'fv', alias.expr
63 elif alias.expr in ('GLint', 'GLuint', 'GLsizei'):
65 return self.prefix + 'Integerv', 'GLint'
67 return self.prefix + 'iv', 'GLint'
72 def visit_enum(self, enum):
73 return self.visit(glapi.GLint)
75 def visit_bitmask(self, bitmask):
76 return self.visit(glapi.GLint)
78 def visit_opaque(self, pointer):
79 return self.prefix + 'Pointerv', 'GLvoid *'
82 class GlTracer(Tracer):
89 ("TexCoord", "TEXTURE_COORD"),
90 ("EdgeFlag", "EDGE_FLAG"),
91 ("FogCoord", "FOG_COORD"),
92 ("SecondaryColor", "SECONDARY_COLOR"),
96 def header(self, api):
97 Tracer.header(self, api)
99 print '// Whether user arrays were used'
100 print 'static bool __user_arrays = false;'
102 # Whether we need user arrays
103 print 'static inline bool __need_user_arrays(void)'
105 print ' if (!__user_arrays) {'
106 print ' return false;'
110 for camelcase_name, uppercase_name in self.arrays:
111 function_name = 'gl%sPointer' % camelcase_name
112 enable_name = 'GL_%s_ARRAY' % uppercase_name
113 binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
114 print ' // %s' % function_name
115 self.array_prolog(api, uppercase_name)
116 print ' if (__glIsEnabled(%s)) {' % enable_name
117 print ' GLint __binding = 0;'
118 print ' __glGetIntegerv(%s, &__binding);' % binding_name
119 print ' if (!__binding) {'
120 self.array_cleanup(api, uppercase_name)
121 print ' return true;'
124 self.array_epilog(api, uppercase_name)
127 print ' // glVertexAttribPointer'
128 print ' GLint __max_vertex_attribs = 0;'
129 print ' __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
130 print ' for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
131 print ' GLint __enabled = 0;'
132 print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
133 print ' if (__enabled) {'
134 print ' GLint __binding = 0;'
135 print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
136 print ' if (!__binding) {'
137 print ' return true;'
143 print ' return false;'
147 print 'static void __trace_user_arrays(GLuint maxindex);'
150 print 'struct buffer_mapping {'
152 print ' GLint length;'
154 print ' bool explicit_flush;'
157 for target in self.buffer_targets:
158 print 'struct buffer_mapping __%s_mapping;' % target.lower();
160 print 'static inline struct buffer_mapping *'
161 print 'get_buffer_mapping(GLenum target) {'
162 print ' switch(target) {'
163 for target in self.buffer_targets:
164 print ' case GL_%s:' % target
165 print ' return & __%s_mapping;' % target.lower()
167 print ' OS::DebugMessage("warning: unknown buffer target 0x%04X\\n", target);'
168 print ' return NULL;'
173 # Generate memcpy's signature
174 self.trace_function_decl(glapi.memcpy)
176 # Generate a helper function to determine whether a parameter name
177 # refers to a symbolic value or not
179 print 'is_symbolic_pname(GLenum pname) {'
180 print ' switch(pname) {'
181 for function, type, count, name in glparams.parameters:
182 if type is glapi.GLenum:
183 print ' case %s:' % name
184 print ' return true;'
186 print ' return false;'
191 # Generate a helper function to determine whether a parameter value is
192 # potentially symbolic or not; i.e., if the value can be represented in
194 print 'template<class T>'
195 print 'static inline bool'
196 print 'is_symbolic_param(T param) {'
197 print ' return static_cast<T>(static_cast<GLenum>(param)) == param;'
201 # Generate a helper function to know how many elements a parameter has
202 print 'static size_t'
203 print '__gl_param_size(GLenum pname) {'
204 print ' switch(pname) {'
205 for function, type, count, name in glparams.parameters:
207 print ' case %s: return %u;' % (name, count)
208 print ' case GL_COMPRESSED_TEXTURE_FORMATS: {'
209 print ' GLint num_compressed_texture_formats = 0;'
210 print ' __glGetIntegerv(GL_NUM_COMPRESSED_TEXTURE_FORMATS, &num_compressed_texture_formats);'
211 print ' return num_compressed_texture_formats;'
214 print r' OS::DebugMessage("warning: %s: unknown GLenum 0x%04X\n", __FUNCTION__, pname);'
220 array_pointer_function_names = set((
228 "glSecondaryColorPointer",
230 "glInterleavedArrays",
232 "glVertexPointerEXT",
233 "glNormalPointerEXT",
236 "glTexCoordPointerEXT",
237 "glEdgeFlagPointerEXT",
238 "glFogCoordPointerEXT",
239 "glSecondaryColorPointerEXT",
241 "glVertexAttribPointer",
242 "glVertexAttribPointerARB",
243 "glVertexAttribPointerNV",
244 "glVertexAttribIPointer",
245 "glVertexAttribIPointerEXT",
246 "glVertexAttribLPointer",
247 "glVertexAttribLPointerEXT",
249 #"glMatrixIndexPointerARB",
252 draw_function_names = set((
255 'glDrawRangeElements',
257 'glMultiDrawElements',
258 'glDrawArraysInstanced',
259 'glDrawElementsInstanced',
260 'glDrawArraysInstancedARB',
261 'glDrawElementsInstancedARB',
262 'glDrawElementsBaseVertex',
263 'glDrawRangeElementsBaseVertex',
264 'glDrawElementsInstancedBaseVertex',
265 'glMultiDrawElementsBaseVertex',
266 'glDrawArraysIndirect',
267 'glDrawElementsIndirect',
269 'glDrawRangeElementsEXT',
270 'glDrawRangeElementsEXT_size',
271 'glMultiDrawArraysEXT',
272 'glMultiDrawElementsEXT',
273 'glMultiModeDrawArraysIBM',
274 'glMultiModeDrawElementsIBM',
275 'glDrawArraysInstancedEXT',
276 'glDrawElementsInstancedEXT',
279 interleaved_formats = [
292 'GL_T2F_C4F_N3F_V3F',
293 'GL_T4F_C4F_N3F_V4F',
296 def trace_function_impl_body(self, function):
297 # Defer tracing of user array pointers...
298 if function.name in self.array_pointer_function_names:
299 print ' GLint __array_buffer = 0;'
300 print ' __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
301 print ' if (!__array_buffer) {'
302 print ' __user_arrays = true;'
303 self.dispatch_function(function)
305 # And also break down glInterleavedArrays into the individual calls
306 if function.name == 'glInterleavedArrays':
309 # Initialize the enable flags
310 for camelcase_name, uppercase_name in self.arrays:
311 flag_name = '__' + uppercase_name.lower()
312 print ' GLboolean %s = GL_FALSE;' % flag_name
315 # Switch for the interleaved formats
316 print ' switch (format) {'
317 for format in self.interleaved_formats:
318 print ' case %s:' % format
319 for camelcase_name, uppercase_name in self.arrays:
320 flag_name = '__' + uppercase_name.lower()
321 if format.find('_' + uppercase_name[0]) >= 0:
322 print ' %s = GL_TRUE;' % flag_name
329 # Emit fake glEnableClientState/glDisableClientState flags
330 for camelcase_name, uppercase_name in self.arrays:
331 flag_name = '__' + uppercase_name.lower()
332 enable_name = 'GL_%s_ARRAY' % uppercase_name
334 # Emit a fake function
336 print ' static const Trace::FunctionSig &__sig = %s ? __glEnableClientState_sig : __glDisableClientState_sig;' % flag_name
337 print ' unsigned __call = Trace::BeginEnter(__sig);'
338 print ' Trace::BeginArg(0);'
339 dump_instance(glapi.GLenum, enable_name)
340 print ' Trace::EndArg();'
341 print ' Trace::EndEnter();'
342 print ' Trace::BeginLeave(__call);'
343 print ' Trace::EndLeave();'
349 # ... to the draw calls
350 if function.name in self.draw_function_names:
351 print ' if (__need_user_arrays()) {'
352 arg_names = ', '.join([arg.name for arg in function.args[1:]])
353 print ' GLuint maxindex = __%s_maxindex(%s);' % (function.name, arg_names)
354 print ' __trace_user_arrays(maxindex);'
357 # Emit a fake memcpy on buffer uploads
358 if function.name in ('glUnmapBuffer', 'glUnmapBufferARB', ):
359 print ' struct buffer_mapping *mapping = get_buffer_mapping(target);'
360 print ' if (mapping && mapping->write && !mapping->explicit_flush) {'
361 self.emit_memcpy('mapping->map', 'mapping->map', 'mapping->length')
363 if function.name in ('glFlushMappedBufferRange', 'glFlushMappedBufferRangeAPPLE'):
364 # TODO: avoid copying [0, offset] bytes
365 print ' struct buffer_mapping *mapping = get_buffer_mapping(target);'
366 print ' if (mapping) {'
367 if function.name.endswith('APPLE'):
368 print ' GLsizeiptr length = size;'
369 print ' mapping->explicit_flush = true;'
370 print ' //assert(offset + length <= mapping->length);'
371 self.emit_memcpy('mapping->map', 'mapping->map', 'offset + length')
373 # FIXME: glFlushMappedNamedBufferRangeEXT
375 Tracer.trace_function_impl_body(self, function)
377 def emit_memcpy(self, dest, src, length):
378 print ' unsigned __call = Trace::BeginEnter(__memcpy_sig);'
379 print ' Trace::BeginArg(0);'
380 print ' Trace::LiteralOpaque(%s);' % dest
381 print ' Trace::EndArg();'
382 print ' Trace::BeginArg(1);'
383 print ' Trace::LiteralBlob(%s, %s);' % (src, length)
384 print ' Trace::EndArg();'
385 print ' Trace::BeginArg(2);'
386 print ' Trace::LiteralUInt(%s);' % length
387 print ' Trace::EndArg();'
388 print ' Trace::EndEnter();'
389 print ' Trace::BeginLeave(__call);'
390 print ' Trace::EndLeave();'
394 'ELEMENT_ARRAY_BUFFER',
396 'PIXEL_UNPACK_BUFFER',
399 def wrap_ret(self, function, instance):
400 Tracer.wrap_ret(self, function, instance)
402 if function.name in ('glMapBuffer', 'glMapBufferARB'):
403 print ' struct buffer_mapping *mapping = get_buffer_mapping(target);'
404 print ' if (mapping) {'
405 print ' mapping->map = %s;' % (instance)
406 print ' mapping->length = 0;'
407 print ' __glGetBufferParameteriv(target, GL_BUFFER_SIZE, &mapping->length);'
408 print ' mapping->write = (access != GL_READ_ONLY);'
409 print ' mapping->explicit_flush = false;'
412 if function.name == 'glMapBufferRange':
413 print ' struct buffer_mapping *mapping = get_buffer_mapping(target);'
414 print ' if (mapping) {'
415 print ' mapping->map = %s;' % (instance)
416 print ' mapping->length = length;'
417 print ' mapping->write = access & GL_MAP_WRITE_BIT;'
418 print ' mapping->explicit_flush = access & GL_MAP_FLUSH_EXPLICIT_BIT;'
426 def gl_boolean(self, value):
427 return self.boolean_names[int(bool(value))]
429 def dump_arg_instance(self, function, arg):
430 if function.name in self.draw_function_names and arg.name == 'indices':
431 print ' GLint __element_array_buffer = 0;'
432 print ' __glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
433 print ' if (!__element_array_buffer) {'
434 if isinstance(arg.type, stdapi.Array):
435 Tracer.dump_arg_instance(self, function, arg)
436 print ' Trace::BeginArray(%s);' % arg.type.length
437 print ' for(GLsizei i = 0; i < %s; ++i) {' % arg.type.length
438 print ' Trace::BeginElement();'
439 print ' Trace::LiteralBlob((const void *)%s, count[i]*__gl_type_size(type));' % (arg.name)
440 print ' Trace::EndElement();'
442 print ' Trace::EndArray();'
444 print ' Trace::LiteralBlob((const void *)%s, count*__gl_type_size(type));' % (arg.name)
446 Tracer.dump_arg_instance(self, function, arg)
450 # Several GL state functions take GLenum symbolic names as
451 # integer/floats; so dump the symbolic name whenever possible
452 if arg.type in (glapi.GLint, glapi.GLfloat) and arg.name == 'param':
454 assert function.args[arg.index - 1].name == 'pname'
455 assert function.args[arg.index - 1].type == glapi.GLenum
456 print ' if (is_symbolic_pname(pname) && is_symbolic_param(%s)) {' % arg.name
457 dump_instance(glapi.GLenum, arg.name)
459 Tracer.dump_arg_instance(self, function, arg)
463 Tracer.dump_arg_instance(self, function, arg)
465 def footer(self, api):
466 Tracer.footer(self, api)
468 # A simple state tracker to track the pointer values
470 print 'static void __trace_user_arrays(GLuint maxindex)'
473 for camelcase_name, uppercase_name in self.arrays:
474 function_name = 'gl%sPointer' % camelcase_name
475 enable_name = 'GL_%s_ARRAY' % uppercase_name
476 binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
477 function = api.get_function_by_name(function_name)
479 print ' // %s' % function.name
480 self.array_trace_prolog(api, uppercase_name)
481 self.array_prolog(api, uppercase_name)
482 print ' if (__glIsEnabled(%s)) {' % enable_name
483 print ' GLint __binding = 0;'
484 print ' __glGetIntegerv(%s, &__binding);' % binding_name
485 print ' if (!__binding) {'
487 # Get the arguments via glGet*
488 for arg in function.args:
489 arg_get_enum = 'GL_%s_ARRAY_%s' % (uppercase_name, arg.name.upper())
490 arg_get_function, arg_type = TypeGetter().visit(arg.type)
491 print ' %s %s = 0;' % (arg_type, arg.name)
492 print ' __%s(%s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
494 arg_names = ', '.join([arg.name for arg in function.args[:-1]])
495 print ' size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
497 # Emit a fake function
498 self.array_trace_intermezzo(api, uppercase_name)
499 print ' unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
500 for arg in function.args:
501 assert not arg.output
502 print ' Trace::BeginArg(%u);' % (arg.index,)
503 if arg.name != 'pointer':
504 dump_instance(arg.type, arg.name)
506 print ' Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
507 print ' Trace::EndArg();'
509 print ' Trace::EndEnter();'
510 print ' Trace::BeginLeave(__call);'
511 print ' Trace::EndLeave();'
514 self.array_epilog(api, uppercase_name)
515 self.array_trace_epilog(api, uppercase_name)
518 # Samething, but for glVertexAttribPointer
519 print ' // glVertexAttribPointer'
520 print ' GLint __max_vertex_attribs = 0;'
521 print ' __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
522 print ' for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
523 print ' GLint __enabled = 0;'
524 print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
525 print ' if (__enabled) {'
526 print ' GLint __binding = 0;'
527 print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
528 print ' if (!__binding) {'
530 function = api.get_function_by_name('glVertexAttribPointer')
532 # Get the arguments via glGet*
533 for arg in function.args[1:]:
534 arg_get_enum = 'GL_VERTEX_ATTRIB_ARRAY_%s' % (arg.name.upper(),)
535 arg_get_function, arg_type = TypeGetter('glGetVertexAttrib', False).visit(arg.type)
536 print ' %s %s = 0;' % (arg_type, arg.name)
537 print ' __%s(index, %s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
539 arg_names = ', '.join([arg.name for arg in function.args[1:-1]])
540 print ' size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
542 # Emit a fake function
543 print ' unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
544 for arg in function.args:
545 assert not arg.output
546 print ' Trace::BeginArg(%u);' % (arg.index,)
547 if arg.name != 'pointer':
548 dump_instance(arg.type, arg.name)
550 print ' Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
551 print ' Trace::EndArg();'
553 print ' Trace::EndEnter();'
554 print ' Trace::BeginLeave(__call);'
555 print ' Trace::EndLeave();'
565 # Hooks for glTexCoordPointer, which is identical to the other array
566 # pointers except the fact that it is indexed by glClientActiveTexture.
569 def array_prolog(self, api, uppercase_name):
570 if uppercase_name == 'TEXTURE_COORD':
571 print ' GLint client_active_texture = 0;'
572 print ' __glGetIntegerv(GL_CLIENT_ACTIVE_TEXTURE, &client_active_texture);'
573 print ' GLint max_texture_coords = 0;'
574 print ' __glGetIntegerv(GL_MAX_TEXTURE_COORDS, &max_texture_coords);'
575 print ' for (GLint unit = 0; unit < max_texture_coords; ++unit) {'
576 print ' GLenum texture = GL_TEXTURE0 + unit;'
577 print ' __glClientActiveTexture(texture);'
579 def array_trace_prolog(self, api, uppercase_name):
580 if uppercase_name == 'TEXTURE_COORD':
581 print ' bool client_active_texture_dirty = false;'
583 def array_epilog(self, api, uppercase_name):
584 if uppercase_name == 'TEXTURE_COORD':
586 self.array_cleanup(api, uppercase_name)
588 def array_cleanup(self, api, uppercase_name):
589 if uppercase_name == 'TEXTURE_COORD':
590 print ' __glClientActiveTexture(client_active_texture);'
592 def array_trace_intermezzo(self, api, uppercase_name):
593 if uppercase_name == 'TEXTURE_COORD':
594 print ' if (texture != client_active_texture || client_active_texture_dirty) {'
595 print ' client_active_texture_dirty = true;'
596 self.fake_glClientActiveTexture_call(api, "texture");
599 def array_trace_epilog(self, api, uppercase_name):
600 if uppercase_name == 'TEXTURE_COORD':
601 print ' if (client_active_texture_dirty) {'
602 self.fake_glClientActiveTexture_call(api, "client_active_texture");
605 def fake_glClientActiveTexture_call(self, api, texture):
606 function = api.get_function_by_name('glClientActiveTexture')
607 self.fake_call(function, [texture])
609 def fake_call(self, function, args):
610 print ' unsigned __fake_call = Trace::BeginEnter(__%s_sig);' % (function.name,)
611 for arg, instance in zip(function.args, args):
612 assert not arg.output
613 print ' Trace::BeginArg(%u);' % (arg.index,)
614 dump_instance(arg.type, instance)
615 print ' Trace::EndArg();'
616 print ' Trace::EndEnter();'
617 print ' Trace::BeginLeave(__fake_call);'
618 print ' Trace::EndLeave();'