"""GL tracing generator."""
+import stdapi
+import glapi
from glxapi import glxapi
from trace import Tracer, dump_instance
-class GlTracer(Tracer):
+class TypeGetter(stdapi.Visitor):
+ '''Determine which glGet*v function that matches the specified type.'''
+
+ def __init__(self, prefix = 'glGet', long_suffix = True):
+ self.prefix = prefix
+ self.long_suffix = long_suffix
+
+ def visit_const(self, const):
+ return self.visit(const.type)
+
+ def visit_alias(self, alias):
+ if alias.expr == 'GLboolean':
+ if self.long_suffix:
+ return self.prefix + 'Booleanv', alias.expr
+ else:
+ return self.prefix + 'iv', 'GLint'
+ elif alias.expr == 'GLdouble':
+ if self.long_suffix:
+ return self.prefix + 'Doublev', alias.expr
+ else:
+ return self.prefix + 'dv', alias.expr
+ elif alias.expr == 'GLfloat':
+ if self.long_suffix:
+ return self.prefix + 'Floatv', alias.expr
+ else:
+ return self.prefix + 'fv', alias.expr
+ elif alias.expr in ('GLint', 'GLuint', 'GLsizei'):
+ if self.long_suffix:
+ return self.prefix + 'Integerv', 'GLint'
+ else:
+ return self.prefix + 'iv', 'GLint'
+ else:
+ print alias.expr
+ assert False
+
+ def visit_enum(self, enum):
+ return self.visit(glapi.GLint)
+
+ def visit_bitmask(self, bitmask):
+ return self.visit(glapi.GLint)
+
+ def visit_opaque(self, pointer):
+ return self.prefix + 'Pointerv', 'GLvoid *'
- pointer_function_names = {
- "glVertexPointer": "VertexPointer",
- "glVertexPointerEXT": "VertexPointer",
- "glNormalPointer": "NormalPointer",
- "glNormalPointerEXT": "NormalPointer",
- "glColorPointer": "ColorPointer",
- "glColorPointerEXT": "ColorPointer",
- "glIndexPointer": "IndexPointer",
- "glIndexPointerEXT": "IndexPointer",
- "glTexCoordPointer": "TexCoordPointer",
- "glTexCoordPointerEXT": "TexCoordPointer",
- "glEdgeFlagPointer": "EdgeFlagPointer",
- "glEdgeFlagPointerEXT": "EdgeFlagPointer",
- "glFogCoordPointer": "FogCoordPointer",
- "glFogCoordPointerEXT": "FogCoordPointer",
- "glSecondaryColorPointer": "SecondaryColorPointer",
- "glSecondaryColorPointerEXT": "SecondaryColorPointer",
- "glInterleavedArrays": "InterleavedArrays",
-
- #"glVertexAttribPointer": "VertexAttribPointer",
- #"glVertexAttribPointerARB": "VertexAttribPointer",
- #"glVertexAttribPointerNV": "VertexAttribPointer",
- #"glVertexAttribLPointer": "VertexAttribLPointer",
-
- #"glMatrixIndexPointerARB": "MatrixIndexPointer",
- }
+
+class GlTracer(Tracer):
def header(self, api):
Tracer.header(self, api)
Tracer.footer(self, api)
self.state_tracker_impl(api)
+ arrays = [
+ ("Vertex", "VERTEX"),
+ ("Normal", "NORMAL"),
+ ("Color", "COLOR"),
+ ("Index", "INDEX"),
+ ("TexCoord", "TEXTURE_COORD"),
+ ("EdgeFlag", "EDGE_FLAG"),
+ ("FogCoord", "FOG_COORD"),
+ ("SecondaryColor", "SECONDARY_COLOR"),
+ ]
+ arrays.reverse()
+
def state_tracker_decl(self, api):
- # A simple state tracker to track the pointer values
+ # Whether we need user arrays
+ print 'static inline bool __need_user_arrays(void)'
+ print '{'
- atoms = list(set(self.pointer_function_names.itervalues()))
- atoms.sort()
+ for camelcase_name, uppercase_name in self.arrays:
+ function_name = 'gl%sPointer' % camelcase_name
+ enable_name = 'GL_%s_ARRAY' % uppercase_name
+ binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
+ print ' // %s' % function_name
+ print ' if (__glIsEnabled(%s)) {' % enable_name
+ print ' GLint __binding = 0;'
+ print ' __glGetIntegerv(%s, &__binding);' % binding_name
+ print ' if (!__binding) {'
+ print ' return true;'
+ print ' }'
+ print ' }'
+ print
- # define the NEW_XXXX dirty flags
- for i in range(len(atoms)):
- atom = atoms[i]
- dirtyflag = "NEW_%s" % atom.upper()
- print '#define %s 0x%x' % (dirtyflag, 1 << i)
+ print ' // glVertexAttribPointer'
+ print ' GLint __max_vertex_attribs = 0;'
+ print ' __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
+ print ' for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
+ print ' GLint __enabled = 0;'
+ print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
+ print ' if (__enabled) {'
+ print ' GLint __binding = 0;'
+ print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
+ print ' if (!__binding) {'
+ print ' return true;'
+ print ' }'
+ print ' }'
+ print ' }'
print
- # declare the state structure
- print 'struct {'
- for atom in atoms:
- function = api.get_function_by_name('gl%s' % atom)
- print ' struct {'
- for arg in function.args:
- print ' %s %s;' % (arg.type, arg.name)
- print ' } %s;' % atom
- print ' unsigned dirty;'
- print '} __state;'
+ print ' return false;'
+ print '}'
+ print
+
+ print 'static void __trace_user_arrays(GLuint maxindex);'
print
+
+ array_pointer_function_names = set((
+ "glVertexPointer",
+ "glNormalPointer",
+ "glColorPointer",
+ "glIndexPointer",
+ "glTexCoordPointer",
+ "glEdgeFlagPointer",
+ "glFogCoordPointer",
+ "glSecondaryColorPointer",
+
+ #"glVertexPointerEXT",
+ #"glNormalPointerEXT",
+ #"glColorPointerEXT",
+ #"glIndexPointerEXT",
+ #"glTexCoordPointerEXT",
+ #"glEdgeFlagPointerEXT",
+ #"glFogCoordPointerEXT",
+ #"glSecondaryColorPointerEXT",
+
+ "glVertexAttribPointer",
+ "glVertexAttribPointerARB",
+ "glVertexAttribPointerNV",
+ "glVertexAttribLPointer",
+ "glVertexAttribLPointerEXT",
+
+ #"glMatrixIndexPointerARB",
+ ))
+
+ draw_function_names = set((
+ 'glDrawArrays',
+ 'glDrawElements',
+ 'glDrawRangeElements',
+ ))
+
+ interleaved_formats = [
+ 'GL_V2F',
+ 'GL_V3F',
+ 'GL_C4UB_V2F',
+ 'GL_C4UB_V3F',
+ 'GL_C3F_V3F',
+ 'GL_N3F_V3F',
+ 'GL_C4F_N3F_V3F',
+ 'GL_T2F_V3F',
+ 'GL_T4F_V4F',
+ 'GL_T2F_C4UB_V3F',
+ 'GL_T2F_C3F_V3F',
+ 'GL_T2F_N3F_V3F',
+ 'GL_T2F_C4F_N3F_V3F',
+ 'GL_T4F_C4F_N3F_V4F',
+ ]
+
+ def trace_function_impl_body(self, function):
+ # Defer tracing of user array pointers...
+ if function.name in self.array_pointer_function_names:
+ print ' GLint __array_buffer = 0;'
+ print ' __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
+ print ' if (!__array_buffer) {'
+ self.dispatch_function(function)
+ print ' return;'
+ print ' }'
+
+ # ... to the draw calls
+ if function.name in self.draw_function_names:
+ print ' if (__need_user_arrays()) {'
+ arg_names = ', '.join([arg.name for arg in function.args[1:]])
+ print ' GLuint maxindex = __%s_maxindex(%s);' % (function.name, arg_names)
+ print ' __trace_user_arrays(maxindex);'
+ print ' }'
+
+ # And also break down glInterleavedArrays into the individual calls
+ if function.name == 'glInterleavedArrays':
+ print ' GLint __array_buffer = 0;'
+ print ' __glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
+ print ' if (!__array_buffer) {'
+ self.dispatch_function(function)
+ print
+
+ # Initialize the enable flags
+ for camelcase_name, uppercase_name in self.arrays:
+ flag_name = '__' + uppercase_name.lower()
+ print ' GLboolean %s = GL_FALSE;' % flag_name
+ print
+
+ # Swicth for the interleaved formats
+ print ' switch (format) {'
+ for format in self.interleaved_formats:
+ print ' case %s:' % format
+ for camelcase_name, uppercase_name in self.arrays:
+ flag_name = '__' + uppercase_name.lower()
+ if format.find('_' + uppercase_name[0]) >= 0:
+ print ' %s = GL_TRUE;' % flag_name
+ print ' break;'
+ print ' default:'
+ print ' return;'
+ print ' }'
+ print
+
+ # Emit fake glEnableClientState/glDisableClientState flags
+ for camelcase_name, uppercase_name in self.arrays:
+ flag_name = '__' + uppercase_name.lower()
+ enable_name = 'GL_%s_ARRAY' % uppercase_name
+
+ # Emit a fake function
+ print ' {'
+ print ' static const Trace::FunctionSig &__sig = %s ? __glEnableClientState_sig : __glDisableClientState_sig;' % flag_name
+ print ' unsigned __call = Trace::BeginEnter(__sig);'
+ print ' Trace::BeginArg(0);'
+ dump_instance(glapi.GLenum, enable_name)
+ print ' Trace::EndArg();'
+ print ' Trace::EndEnter();'
+ print ' Trace::BeginLeave(__call);'
+ print ' Trace::EndLeave();'
+ print ' }'
+
+ print ' return;'
+ print ' }'
+
+ Tracer.trace_function_impl_body(self, function)
+
+ boolean_names = [
+ 'GL_FALSE',
+ 'GL_TRUE',
+ ]
+
+ def gl_boolean(self, value):
+ return self.boolean_names[int(bool(value))]
+
+ def dump_arg_instance(self, function, arg):
+ if function.name in self.draw_function_names and arg.name == 'indices':
+ print ' GLint __element_array_buffer = 0;'
+ print ' __glGetIntegerv(GL_ELEMENT_ARRAY_BUFFER_BINDING, &__element_array_buffer);'
+ print ' if (!__element_array_buffer) {'
+ print ' Trace::LiteralBlob((const void *)%s, count*__gl_type_size(type));' % (arg.name)
+ print ' } else {'
+ print ' Trace::LiteralOpaque((const void *)%s);' % (arg.name)
+ print ' }'
+ return
+
+ Tracer.dump_arg_instance(self, function, arg)
def state_tracker_impl(self, api):
# A simple state tracker to track the pointer values
- atoms = list(set(self.pointer_function_names.itervalues()))
- atoms.sort()
-
# update the state
- print 'void __state_update(GLsizei )'
+ print 'static void __trace_user_arrays(GLuint maxindex)'
print '{'
- print ' GLint __array_buffer = 0;'
- print ' glGetIntegerv(GL_ARRAY_BUFFER_BINDING, &__array_buffer);'
- for atom in atoms:
- function = api.get_function_by_name('gl%s' % atom)
- dirtyflag = "NEW_%s" % atom.upper()
- print ' if (__state.dirty & %s) {' % dirtyflag
- print ' unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
+
+ for camelcase_name, uppercase_name in self.arrays:
+ function_name = 'gl%sPointer' % camelcase_name
+ enable_name = 'GL_%s_ARRAY' % uppercase_name
+ binding_name = 'GL_%s_ARRAY_BUFFER_BINDING' % uppercase_name
+ function = api.get_function_by_name(function_name)
+
+ print ' // %s' % function.name
+ print ' if (__glIsEnabled(%s)) {;' % enable_name
+ print ' GLint __binding = 0;'
+ print ' __glGetIntegerv(%s, &__binding);' % binding_name
+ print ' if (!__binding) {'
+
+ # Get the arguments via glGet*
+ for arg in function.args:
+ arg_get_enum = 'GL_%s_ARRAY_%s' % (uppercase_name, arg.name.upper())
+ arg_get_function, arg_type = TypeGetter().visit(arg.type)
+ print ' %s %s = 0;' % (arg_type, arg.name)
+ print ' __%s(%s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
+
+ arg_names = ', '.join([arg.name for arg in function.args[:-1]])
+ print ' size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
+
+ # Emit a fake function
+ print ' unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
for arg in function.args:
assert not arg.output
- print ' Trace::BeginArg(%u);' % (arg.index,)
- dump_instance(arg.type, '__state.%s.%s' % (atom, arg.name))
- print ' Trace::EndArg();'
- print ' Trace::EndEnter();'
- print ' Trace::BeginLeave(__call);'
- print ' Trace::EndLeave();'
+ print ' Trace::BeginArg(%u);' % (arg.index,)
+ if arg.name != 'pointer':
+ dump_instance(arg.type, arg.name)
+ else:
+ print ' Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
+ print ' Trace::EndArg();'
+
+ print ' Trace::EndEnter();'
+ print ' Trace::BeginLeave(__call);'
+ print ' Trace::EndLeave();'
+ print ' }'
print ' }'
+ print
+
+ # Samething, but for glVertexAttribPointer
+ print ' // glVertexAttribPointer'
+ print ' GLint __max_vertex_attribs = 0;'
+ print ' __glGetIntegerv(GL_MAX_VERTEX_ATTRIBS, &__max_vertex_attribs);'
+ print ' for (GLint index = 0; index < __max_vertex_attribs; ++index) {'
+ print ' GLint __enabled = 0;'
+ print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_ENABLED, &__enabled);'
+ print ' if (__enabled) {'
+ print ' GLint __binding = 0;'
+ print ' __glGetVertexAttribiv(index, GL_VERTEX_ATTRIB_ARRAY_BUFFER_BINDING, &__binding);'
+ print ' if (!__binding) {'
+
+ function = api.get_function_by_name('glVertexAttribPointer')
+
+ # Get the arguments via glGet*
+ for arg in function.args[1:]:
+ arg_get_enum = 'GL_VERTEX_ATTRIB_ARRAY_%s' % (arg.name.upper(),)
+ arg_get_function, arg_type = TypeGetter('glGetVertexAttrib', False).visit(arg.type)
+ print ' %s %s = 0;' % (arg_type, arg.name)
+ print ' __%s(index, %s, &%s);' % (arg_get_function, arg_get_enum, arg.name)
+
+ arg_names = ', '.join([arg.name for arg in function.args[1:-1]])
+ print ' size_t __size = __%s_size(%s, maxindex);' % (function.name, arg_names)
+
+ # Emit a fake function
+ print ' unsigned __call = Trace::BeginEnter(__%s_sig);' % (function.name,)
+ for arg in function.args:
+ assert not arg.output
+ print ' Trace::BeginArg(%u);' % (arg.index,)
+ if arg.name != 'pointer':
+ dump_instance(arg.type, arg.name)
+ else:
+ print ' Trace::LiteralBlob((const void *)%s, __size);' % (arg.name)
+ print ' Trace::EndArg();'
+
+ print ' Trace::EndEnter();'
+ print ' Trace::BeginLeave(__call);'
+ print ' Trace::EndLeave();'
+ print ' }'
+ print ' }'
+ print ' }'
+ print
+
print '}'
print