mesa/src/freedreno/vulkan/tu_tracepoints.py
2025-11-07 17:50:03 +00:00

215 lines
12 KiB
Python

# Copyright © 2021 Igalia S.L.
# SPDX-License-Identifier: MIT
import argparse
import sys
#
# TODO can we do this with less boilerplate?
#
parser = argparse.ArgumentParser()
parser.add_argument('-p', '--import-path', required=True)
parser.add_argument('--utrace-src', required=True)
parser.add_argument('--utrace-hdr', required=True)
parser.add_argument('--perfetto-hdr', required=True)
args = parser.parse_args()
sys.path.insert(0, args.import_path)
from u_trace import Header, HeaderScope
from u_trace import ForwardDecl
from u_trace import Tracepoint
from u_trace import TracepointArg as Arg
from u_trace import TracepointArgStruct as ArgStruct
from u_trace import utrace_generate
from u_trace import utrace_generate_perfetto_utils
Header('vk_enum_to_str.h', scope=HeaderScope.SOURCE|HeaderScope.PERFETTO)
Header('vk_format.h')
Header('util/sha1/sha1.h')
Header('tu_cmd_buffer.h', scope=HeaderScope.SOURCE)
Header('tu_device.h', scope=HeaderScope.SOURCE)
Header('common/freedreno_lrz.h')
Header('vulkan/vulkan_core.h', scope=HeaderScope.SOURCE|HeaderScope.PERFETTO)
# we can't use tu_common.h because it includes ir3 headers which are not
# compatible with C++
ForwardDecl('struct tu_cmd_buffer')
ForwardDecl('struct tu_device')
ForwardDecl('struct tu_framebuffer')
ForwardDecl('struct tu_tiling_config')
ForwardDecl('typedef char tu_sha1_str[SHA1_DIGEST_STRING_LENGTH]')
# List of the default tracepoints enabled. By default tracepoints are enabled,
# set tp_default_enabled=False to disable them by default.
tu_default_tps = []
#
# Tracepoint definitions:
#
command_buffer_arg = ArgStruct(type='struct tu_cmd_buffer *', var='cmd')
command_buffer_struct = Arg(type='VkCommandBuffer', name='command_buffer_handle', var='vk_command_buffer_to_handle(&cmd->vk)', c_format='%" PRIu64 "', to_prim_type='(uint64_t){}', perfetto_field=True)
def begin_end_tp(name, args=[], tp_struct=None, tp_print=None,
end_args=[], end_tp_struct=None, end_tp_print=None,
tp_default_enabled=True, marker_tp=True,
queue_tp=True):
global tu_default_tps
if tp_default_enabled:
tu_default_tps.append(name)
# Make all the GPU render stage events take a cmdbuf, so that the
# command_buffer field can be set appropriately in the UI.
tp_struct = [command_buffer_struct] + (tp_struct if tp_struct else [])
args = [command_buffer_arg] + (args if args else [])
Tracepoint('start_{0}'.format(name),
toggle_name=name,
args=args,
tp_struct=tp_struct,
tp_perfetto='tu_perfetto_start_{0}'.format(name) if queue_tp else None,
tp_print=tp_print if queue_tp else None,
tp_markers='tu_cs_trace_start' if marker_tp else None)
Tracepoint('end_{0}'.format(name),
toggle_name=name,
args=end_args,
tp_struct=end_tp_struct,
tp_perfetto='tu_perfetto_end_{0}'.format(name),
tp_print=end_tp_print if queue_tp else None,
tp_markers='tu_cs_trace_end' if marker_tp else None)
begin_end_tp('cmd_buffer',
args=[Arg(type='str', var='TUdebugFlags', c_format='%s', length_arg='96', copy_func='strncpy'),
Arg(type='str', var='IR3debugFlags', c_format='%s', length_arg='96', copy_func='strncpy')],
tp_struct=[Arg(type='const char *', name='appName', var='cmd->device->instance->vk.app_info.app_name ? cmd->device->instance->vk.app_info.app_name : "Unknown"', c_format='%s'),
Arg(type='const char *', name='engineName', var='cmd->device->instance->vk.app_info.engine_name ? cmd->device->instance->vk.app_info.engine_name : "Unknown"', c_format='%s'),
Arg(type='uint8_t', name='oneTimeSubmit', var='(cmd->usage_flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT)', c_format='%u'),
Arg(type='uint8_t', name='simultaneousUse', var='(cmd->usage_flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT)', c_format='%u')],
end_args=[ArgStruct(type='const struct tu_cmd_buffer *', var='cmd')],
end_tp_struct=[Arg(type='uint32_t', name='renderpasses', var='cmd->state.total_renderpasses', c_format='%u'),
Arg(type='uint32_t', name='dispatches', var='cmd->state.total_dispatches', c_format='%u')])
begin_end_tp('secondary_cmd_buffer', tp_default_enabled=False,
tp_struct=[Arg(type='uint8_t', name='render_pass_continue', var='!!(cmd->usage_flags & VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT)', c_format='%u')])
begin_end_tp('render_pass',
args=[ArgStruct(type='const struct tu_framebuffer *', var='fb'),
ArgStruct(type='const struct tu_tiling_config *', var='tiling'),
Arg(type='uint8_t', var='maxSamples', c_format='%u'),
Arg(type='uint8_t', var='clearCPP', c_format='%u'),
Arg(type='uint8_t', var='loadCPP', c_format='%u'),
Arg(type='uint8_t', var='storeCPP', c_format='%u'),
Arg(type='bool', var='hasDepth', c_format='%s', to_prim_type='({} ? "true" : "false")'),
Arg(type='str', var='ubwc', c_format='%s', length_arg='11', copy_func='strncpy'),
Arg(type='const char *', var='cbDisableReason', c_format='%s'),],
tp_struct=[Arg(type='uint16_t', name='width', var='fb->width', c_format='%u'),
Arg(type='uint16_t', name='height', var='fb->height', c_format='%u'),
Arg(type='uint8_t', name='attachment_count', var='fb->attachment_count', c_format='%u'),
Arg(type='uint16_t', name='numberOfBins', var='tiling->vsc.tile_count.width * tiling->vsc.tile_count.height', c_format='%u'),
Arg(type='uint16_t', name='binWidth', var='tiling->tile0.width', c_format='%u'),
Arg(type='uint16_t', name='binHeight', var='tiling->tile0.height', c_format='%u'),],
# Args known only at the end of the renderpass:
end_args=[Arg(type='bool', var='tiledRender', c_format='%s', to_prim_type='({} ? "true" : "false")'),
Arg(type='const char *', var='tilingDisableReason', c_format='%s'),
Arg(type='uint32_t', var='drawCount', c_format='%u'),
Arg(type='uint32_t', var='avgPerSampleBandwidth', c_format='%u'),
Arg(type='bool', var='lrz', c_format='%s', to_prim_type='({} ? "true" : "false")'),
Arg(type='const char *', var='lrzDisableReason', c_format='%s'),
Arg(type='int32_t', var='lrzDisabledAtDraw', c_format='%d'),
Arg(type='int32_t', var='lrzWriteDisabledAtDraw', c_format='%d'),
Arg(type='uint32_t', var='lrzStatus', c_format='%s', to_prim_type='(fd_lrz_gpu_dir_to_str((enum fd_lrz_gpu_dir)({} & 0xff)))', is_indirect=True),])
begin_end_tp('draw',
[Arg(type='uint32_t', var='count', c_format='%u'),
Arg(type='tu_sha1_str', var='vs_sha1', c_format='%s',
copy_func='strcpy'),
Arg(type='tu_sha1_str', var='tcs_sha1', c_format='%s',
copy_func='strcpy'),
Arg(type='tu_sha1_str', var='tes_sha1', c_format='%s',
copy_func='strcpy'),
Arg(type='tu_sha1_str', var='gs_sha1', c_format='%s',
copy_func='strcpy'),
Arg(type='tu_sha1_str', var='fs_sha1', c_format='%s',
copy_func='strcpy'),
], tp_default_enabled=False)
begin_end_tp('binning_ib')
begin_end_tp('concurrent_binning_ib')
begin_end_tp('draw_ib_sysmem')
begin_end_tp('draw_ib_gmem')
begin_end_tp('concurrent_binning_barrier')
begin_end_tp('generic_clear',
args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='bool', var='ubwc', c_format='%s', to_prim_type='({} ? "true" : "false")'),
Arg(type='uint8_t', var='samples', c_format='%u')])
begin_end_tp('gmem_clear',
args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='uint8_t', var='samples', c_format='%u')])
begin_end_tp('sysmem_clear',
args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='uint8_t', var='uses_3d_ops', c_format='%u'),
Arg(type='uint8_t', var='samples', c_format='%u')])
begin_end_tp('sysmem_clear_all',
args=[Arg(type='uint8_t', var='mrt_count', c_format='%u'),
Arg(type='uint8_t', var='rect_count', c_format='%u')])
begin_end_tp('gmem_load',
args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='uint8_t', var='force_load', c_format='%u')])
begin_end_tp('gmem_store',
args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='uint8_t', var='fast_path', c_format='%u'),
Arg(type='uint8_t', var='unaligned', c_format='%u')])
begin_end_tp('sysmem_resolve',
args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name')])
begin_end_tp('blit',
# TODO: add source megapixels count and target megapixels count arguments
args=[Arg(type='uint8_t', var='uses_3d_blit', c_format='%u'),
Arg(type='enum VkFormat', var='src_format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='enum VkFormat', var='dst_format', c_format='%s', to_prim_type='vk_format_description({})->short_name'),
Arg(type='uint8_t', var='layers', c_format='%u')])
begin_end_tp('compute',
args=[Arg(type='uint8_t', var='indirect', c_format='%u'),
Arg(type='uint8_t', var='unaligned', c_format='%u'),
Arg(type='uint16_t', var='local_size_x', c_format='%u'),
Arg(type='uint16_t', var='local_size_y', c_format='%u'),
Arg(type='uint16_t', var='local_size_z', c_format='%u'),
Arg(type='uint16_t', var='num_groups_x', c_format='%u'),
Arg(type='uint16_t', var='num_groups_y', c_format='%u'),
Arg(type='uint16_t', var='num_groups_z', c_format='%u'),
Arg(type='tu_sha1_str', var='cs_sha1',
c_format='%s', copy_func='strcpy'),
])
begin_end_tp('compute_indirect',
args=[Arg(type='uint8_t', var='unaligned', c_format='%u'),
Arg(type='tu_sha1_str', var='cs_sha1',
c_format='%s', copy_func='strcpy'),
],
end_args=[ArgStruct(type='VkDispatchIndirectCommand', var='size',
is_indirect=True, c_format="%ux%ux%u",
fields=['x', 'y', 'z'])])
# Annotations for Cmd(Begin|End)DebugUtilsLabelEXT
for suffix in ["", "_rp"]:
begin_end_tp('cmd_buffer_annotation' + suffix,
args=[Arg(type='unsigned', var='len'),
Arg(type='str', var='str', c_format='%s', length_arg='len + 1', copy_func='strncpy'),],
tp_struct=[Arg(type='uint8_t', name='dummy', var='0'),])
utrace_generate(cpath=args.utrace_src,
hpath=args.utrace_hdr,
ctx_param='struct tu_device *dev',
trace_toggle_name='tu_gpu_tracepoint',
trace_toggle_defaults=tu_default_tps)
utrace_generate_perfetto_utils(hpath=args.perfetto_hdr)