2 ##########################################################################
4 # Copyright 2008-2013, VMware, Inc.
7 # Permission is hereby granted, free of charge, to any person obtaining a
8 # copy of this software and associated documentation files (the
9 # "Software"), to deal in the Software without restriction, including
10 # without limitation the rights to use, copy, modify, merge, publish,
11 # distribute, sub license, and/or sell copies of the Software, and to
12 # permit persons to whom the Software is furnished to do so, subject to
13 # the following conditions:
15 # The above copyright notice and this permission notice (including the
16 # next paragraph) shall be included in all copies or substantial portions
19 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20 # OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
22 # IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
23 # ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
24 # TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
25 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 ##########################################################################
37 import parse
as parser
41 from struct
import unpack_from
43 def unpack_from(fmt
, buf
, offset
=0):
44 size
= struct
.calcsize(fmt
)
45 return struct
.unpack(fmt
, buf
[offset
:offset
+ size
])
54 '''JSON serializer function for non-standard Python objects.'''
56 if isinstance(obj
, bytearray
):
57 # TODO: Decide on a single way of dumping blobs
59 # Don't dump full blobs, but merely a description of their size and
61 crc32
= binascii
.crc32(obj
)
64 return 'blob(size=%u,crc32=0x%08x)' % (len(obj
), crc32
)
66 # Dump blobs as an array of 16byte hexadecimals
68 for i
in range(0, len(obj
), 16):
69 res
.append(binascii
.b2a_hex(obj
[i
: i
+16]))
71 # Dump blobs as a single hexadecimal string
72 return binascii
.b2a_hex(obj
)
74 # If the object has a __json__ method, use it.
77 except AttributeError:
86 Python doesn't have C structs, but do its dynamic nature, any object is
91 '''Convert the structure to a standard Python dict, so it can be
95 for name
, value
in self
.__dict
__.items():
96 if not name
.startswith('_'):
101 class Translator(model
.Visitor
):
102 """Translate model arguments into regular Python objects"""
104 def __init__(self
, interpreter
):
105 self
.interpreter
= interpreter
108 def visit(self
, node
):
113 def visit_literal(self
, node
):
114 self
.result
= node
.value
116 def visit_blob(self
, node
):
119 def visit_named_constant(self
, node
):
120 self
.result
= node
.name
122 def visit_array(self
, node
):
124 for element
in node
.elements
:
125 array
.append(self
.visit(element
))
128 def visit_struct(self
, node
):
130 for member_name
, member_node
in node
.members
:
131 member_value
= self
.visit(member_node
)
132 setattr(struct
, member_name
, member_value
)
135 def visit_pointer(self
, node
):
136 self
.result
= self
.interpreter
.lookup_object(node
.address
)
140 '''Base class for classes whose methods can dispatch Gallium calls.'''
142 def __init__(self
, interpreter
):
143 self
.interpreter
= interpreter
146 class Global(Dispatcher
):
147 '''Global name space.
149 For calls that are not associated with objects, i.e, functions and not
153 def pipe_screen_create(self
):
154 return Screen(self
.interpreter
)
156 def pipe_context_create(self
, screen
):
157 return screen
.context_create()
163 def __init__(self
, resource
, usage
, subresource
, box
):
164 self
.resource
= resource
166 self
.subresource
= subresource
170 class Screen(Dispatcher
):
173 def __init__(self
, interpreter
):
174 Dispatcher
.__init
__(self
, interpreter
)
179 def context_create(self
):
180 return Context(self
.interpreter
)
182 def is_format_supported(self
, format
, target
, sample_count
, bind
, geom_flags
):
185 def resource_create(self
, templat
):
187 # Normalize state to avoid spurious differences
188 if resource
.nr_samples
== 0:
189 resource
.nr_samples
= 1
190 if resource
.target
== PIPE_BUFFER
:
191 # We will keep track of buffer contents
192 resource
.data
= bytearray(resource
.width
)
195 def resource_destroy(self
, resource
):
196 self
.interpreter
.unregister_object(resource
)
198 def fence_finish(self
, fence
, flags
):
201 def fence_signalled(self
, fence
):
204 def fence_reference(self
, dst
, src
):
207 def flush_frontbuffer(self
, resource
):
211 class Context(Dispatcher
):
214 # Internal methods variable should be prefixed with '_'
216 def __init__(self
, interpreter
):
217 Dispatcher
.__init
__(self
, interpreter
)
219 # Setup initial state
220 self
._state
= Struct()
221 self
._state
.scissors
= []
222 self
._state
.viewports
= []
223 self
._state
.vertex_buffers
= []
224 self
._state
.constant_buffer
= [[] for i
in range(3)]
231 def create_blend_state(self
, state
):
232 # Normalize state to avoid spurious differences
233 if not state
.logicop_enable
:
234 del state
.logicop_func
235 if not state
.rt
[0].blend_enable
:
236 del state
.rt
[0].rgb_src_factor
237 del state
.rt
[0].rgb_dst_factor
238 del state
.rt
[0].rgb_func
239 del state
.rt
[0].alpha_src_factor
240 del state
.rt
[0].alpha_dst_factor
241 del state
.rt
[0].alpha_func
244 def bind_blend_state(self
, state
):
246 self
._state
.blend
= state
248 def delete_blend_state(self
, state
):
251 def create_sampler_state(self
, state
):
254 def delete_sampler_state(self
, state
):
257 def bind_vertex_sampler_states(self
, num_states
, states
):
258 self
._state
.vertex_sampler
= states
260 def bind_geometry_sampler_states(self
, num_states
, states
):
261 self
._state
.geometry_sampler
= states
263 def bind_fragment_sampler_states(self
, num_states
, states
):
264 self
._state
.fragment_sampler
= states
266 def create_rasterizer_state(self
, state
):
269 def bind_rasterizer_state(self
, state
):
270 self
._state
.rasterizer
= state
272 def delete_rasterizer_state(self
, state
):
275 def create_depth_stencil_alpha_state(self
, state
):
276 # Normalize state to avoid spurious differences
277 if not state
.alpha
.enabled
:
279 del state
.alpha
.ref_value
281 if not state
.stencil
[i
].enabled
:
282 del state
.stencil
[i
].func
285 def bind_depth_stencil_alpha_state(self
, state
):
286 self
._state
.depth_stencil_alpha
= state
288 def delete_depth_stencil_alpha_state(self
, state
):
291 _tokenLabelRE
= re
.compile('^\s*\d+: ', re
.MULTILINE
)
293 def _create_shader_state(self
, state
):
294 # Strip the labels from the tokens
295 state
.tokens
= self
._tokenLabelRE
.sub('', state
.tokens
)
298 create_vs_state
= _create_shader_state
299 create_gs_state
= _create_shader_state
300 create_fs_state
= _create_shader_state
302 def bind_vs_state(self
, state
):
303 self
._state
.vs
= state
305 def bind_gs_state(self
, state
):
306 self
._state
.gs
= state
308 def bind_fs_state(self
, state
):
309 self
._state
.fs
= state
311 def _delete_shader_state(self
, state
):
314 delete_vs_state
= _delete_shader_state
315 delete_gs_state
= _delete_shader_state
316 delete_fs_state
= _delete_shader_state
318 def set_blend_color(self
, state
):
319 self
._state
.blend_color
= state
321 def set_stencil_ref(self
, state
):
322 self
._state
.stencil_ref
= state
324 def set_clip_state(self
, state
):
325 self
._state
.clip
= state
327 def _dump_constant_buffer(self
, buffer):
328 if not self
.interpreter
.verbosity(2):
331 data
= self
.real
.buffer_read(buffer)
334 for offset
in range(0, len(data
), struct
.calcsize(format
)):
335 x
, y
, z
, w
= unpack_from(format
, data
, offset
)
336 sys
.stdout
.write('\tCONST[%2u] = {%10.4f, %10.4f, %10.4f, %10.4f}\n' % (index
, x
, y
, z
, w
))
340 def set_constant_buffer(self
, shader
, index
, constant_buffer
):
341 self
._update
(self
._state
.constant_buffer
[shader
], index
, 1, [constant_buffer
])
343 def set_framebuffer_state(self
, state
):
344 self
._state
.fb
= state
346 def set_polygon_stipple(self
, state
):
347 self
._state
.polygon_stipple
= state
349 def _update(self
, array
, start_slot
, num_slots
, states
):
350 if not isinstance(states
, list):
351 # XXX: trace is not serializing multiple scissors/viewports properly yet
354 while len(array
) < start_slot
+ num_slots
:
356 for i
in range(num_slots
):
357 array
[start_slot
+ i
] = states
[i
]
359 def set_scissor_states(self
, start_slot
, num_scissors
, states
):
360 self
._update
(self
._state
.scissors
, start_slot
, num_scissors
, states
)
362 def set_viewport_states(self
, start_slot
, num_viewports
, states
):
363 self
._update
(self
._state
.viewports
, start_slot
, num_viewports
, states
)
365 def create_sampler_view(self
, resource
, templ
):
366 templ
.resource
= resource
369 def sampler_view_destroy(self
, view
):
372 def set_fragment_sampler_views(self
, num
, views
):
373 self
._state
.fragment_sampler_views
= views
375 def set_geometry_sampler_views(self
, num
, views
):
376 self
._state
.geometry_sampler_views
= views
378 def set_vertex_sampler_views(self
, num
, views
):
379 self
._state
.vertex_sampler_views
= views
381 def set_vertex_buffers(self
, start_slot
, num_buffers
, buffers
):
382 self
._update
(self
._state
.vertex_buffers
, start_slot
, num_buffers
, buffers
)
384 def create_vertex_elements_state(self
, num_elements
, elements
):
385 return elements
[0:num_elements
]
387 def bind_vertex_elements_state(self
, state
):
388 self
._state
.vertex_elements
= state
390 def delete_vertex_elements_state(self
, state
):
393 def set_index_buffer(self
, ib
):
394 self
._state
.index_buffer
= ib
396 # Don't dump more than this number of indices/vertices
399 def _merge_indices(self
, info
):
400 '''Merge the vertices into our state.'''
402 index_size
= self
._state
.index_buffer
.index_size
410 assert struct
.calcsize(format
) == index_size
412 data
= self
._state
.index_buffer
.buffer.data
413 max_index
, min_index
= 0, 0xffffffff
415 count
= min(info
.count
, self
.MAX_ELEMENTS
)
417 for i
in xrange(info
.start
, info
.start
+ count
):
418 offset
= self
._state
.index_buffer
.offset
+ i
*index_size
419 index
, = unpack_from(format
, data
, offset
)
420 indices
.append(index
)
421 min_index
= min(min_index
, index
)
422 max_index
= max(max_index
, index
)
424 self
._state
.indices
= indices
426 return min_index
+ info
.index_bias
, max_index
+ info
.index_bias
428 def _merge_vertices(self
, start
, count
):
429 '''Merge the vertices into our state.'''
431 count
= min(count
, self
.MAX_ELEMENTS
)
433 for index
in xrange(start
, start
+ count
):
434 if index
>= start
+ 16:
435 sys
.stdout
.write('\t...\n')
438 for velem
in self
._state
.vertex_elements
:
439 vbuf
= self
._state
.vertex_buffers
[velem
.vertex_buffer_index
]
440 if vbuf
.buffer is None:
443 data
= vbuf
.buffer.data
445 offset
= vbuf
.buffer_offset
+ velem
.src_offset
+ vbuf
.stride
*index
447 'PIPE_FORMAT_R32_UINT': 'I',
448 'PIPE_FORMAT_R32_FLOAT': 'f',
449 'PIPE_FORMAT_R32G32_FLOAT': '2f',
450 'PIPE_FORMAT_R32G32B32_FLOAT': '3f',
451 'PIPE_FORMAT_R32G32B32A32_FLOAT': '4f',
452 'PIPE_FORMAT_A8R8G8B8_UNORM': '4B',
453 'PIPE_FORMAT_R8G8B8A8_UNORM': '4B',
454 'PIPE_FORMAT_B8G8R8A8_UNORM': '4B',
455 'PIPE_FORMAT_R16G16B16_SNORM': '3h',
458 data
= vbuf
.buffer.data
459 attribute
= unpack_from(format
, data
, offset
)
460 vertex
.append(attribute
)
462 vertices
.append(vertex
)
464 self
._state
.vertices
= vertices
466 def draw_vbo(self
, info
):
469 if self
.interpreter
.call_no
< self
.interpreter
.options
.call
and \
470 self
._draw
_no
< self
.interpreter
.options
.draw
:
473 # Merge the all draw state
475 self
._state
.draw
= info
478 min_index
, max_index
= self
._merge
_indices
(info
)
480 min_index
= info
.start
481 max_index
= info
.start
+ info
.count
- 1
482 self
._merge
_vertices
(min_index
, max_index
- min_index
+ 1)
486 def _dump_state(self
):
487 '''Dump our state to JSON and terminate.'''
495 separators
= (',', ': ')
500 def resource_copy_region(self
, dst
, dst_level
, dstx
, dsty
, dstz
, src
, src_level
, src_box
):
501 if dst
.target
== PIPE_BUFFER
or src
.target
== PIPE_BUFFER
:
506 def is_resource_referenced(self
, texture
, face
, level
):
509 def get_transfer(self
, texture
, sr
, usage
, box
):
512 transfer
= Transfer(texture
, sr
, usage
, box
)
515 def tex_transfer_destroy(self
, transfer
):
516 self
.interpreter
.unregister_object(transfer
)
518 def transfer_inline_write(self
, resource
, level
, usage
, box
, stride
, layer_stride
, data
):
519 if resource
.target
== PIPE_BUFFER
:
520 data
= data
.getValue()
521 assert len(data
) == box
.width
522 assert box
.x
+ box
.width
<= len(resource
.data
)
523 resource
.data
[box
.x
: box
.x
+ box
.width
] = data
525 def flush(self
, flags
):
528 def clear(self
, buffers
, color
, depth
, stencil
):
531 def clear_render_target(self
, dst
, rgba
, dstx
, dsty
, width
, height
):
534 def clear_depth_stencil(self
, dst
, clear_flags
, depth
, stencil
, dstx
, dsty
, width
, height
):
537 def create_surface(self
, resource
, surf_tmpl
):
538 surf_tmpl
.resource
= resource
541 def surface_destroy(self
, surface
):
542 self
.interpreter
.unregister_object(surface
)
544 def create_query(self
, query_type
):
547 def destroy_query(self
, query
):
550 def create_stream_output_target(self
, res
, buffer_offset
, buffer_size
):
552 so_target
.resource
= res
553 so_target
.offset
= buffer_offset
554 so_target
.size
= buffer_size
558 class Interpreter(parser
.TraceDumper
):
559 '''Specialization of a trace parser that interprets the calls as it goes
563 ('pipe_screen', 'is_format_supported'),
564 ('pipe_screen', 'get_name'),
565 ('pipe_screen', 'get_vendor'),
566 ('pipe_screen', 'get_param'),
567 ('pipe_screen', 'get_paramf'),
568 ('pipe_screen', 'get_shader_param'),
569 ('pipe_context', 'clear_render_target'), # XXX workaround trace bugs
572 def __init__(self
, stream
, options
):
573 parser
.TraceDumper
.__init
__(self
, stream
, sys
.stderr
)
574 self
.options
= options
577 self
.globl
= Global(self
)
580 def register_object(self
, address
, object):
581 self
.objects
[address
] = object
583 def unregister_object(self
, object):
587 def lookup_object(self
, address
):
588 return self
.objects
[address
]
590 def interpret(self
, trace
):
591 for call
in trace
.calls
:
592 self
.interpret_call(call
)
594 def handle_call(self
, call
):
595 if (call
.klass
, call
.method
) in self
.ignoredCalls
:
598 self
.call_no
= call
.no
600 if self
.verbosity(1):
601 # Write the call to stderr (as stdout would corrupt the JSON output)
604 parser
.TraceDumper
.handle_call(self
, call
)
608 args
= [(str(name
), self
.interpret_arg(arg
)) for name
, arg
in call
.args
]
616 method
= getattr(obj
, call
.method
)
617 ret
= method(**dict(args
))
619 # Keep track of created pointer objects.
620 if call
.ret
and isinstance(call
.ret
, model
.Pointer
):
622 sys
.stderr
.write('warning: NULL returned\n')
623 self
.register_object(call
.ret
.address
, ret
)
627 def interpret_arg(self
, node
):
628 translator
= Translator(self
)
629 return translator
.visit(node
)
631 def verbosity(self
, level
):
632 return self
.options
.verbosity
>= level
635 class Main(parser
.Main
):
637 def get_optparser(self
):
638 '''Custom options.'''
640 optparser
= parser
.Main
.get_optparser(self
)
641 optparser
.add_option("-q", "--quiet", action
="store_const", const
=0, dest
="verbosity", help="no messages")
642 optparser
.add_option("-v", "--verbose", action
="count", dest
="verbosity", default
=0, help="increase verbosity level")
643 optparser
.add_option("-c", "--call", action
="store", type="int", dest
="call", default
=0xffffffff, help="dump on this call")
644 optparser
.add_option("-d", "--draw", action
="store", type="int", dest
="draw", default
=0xffffffff, help="dump on this draw")
647 def process_arg(self
, stream
, options
):
648 parser
= Interpreter(stream
, options
)
652 if __name__
== '__main__':