1# Copyright © 2021 Igalia S.L. 2# SPDX-License-Identifier: MIT 3 4import argparse 5import sys 6 7# 8# TODO can we do this with less boilerplate? 9# 10parser = argparse.ArgumentParser() 11parser.add_argument('-p', '--import-path', required=True) 12parser.add_argument('--utrace-src', required=True) 13parser.add_argument('--utrace-hdr', required=True) 14parser.add_argument('--perfetto-hdr', required=True) 15args = parser.parse_args() 16sys.path.insert(0, args.import_path) 17 18 19from u_trace import Header, HeaderScope 20from u_trace import ForwardDecl 21from u_trace import Tracepoint 22from u_trace import TracepointArg as Arg 23from u_trace import TracepointArgStruct as ArgStruct 24from u_trace import utrace_generate 25from u_trace import utrace_generate_perfetto_utils 26 27Header('vk_enum_to_str.h', scope=HeaderScope.SOURCE|HeaderScope.PERFETTO) 28Header('vk_format.h') 29Header('tu_cmd_buffer.h', scope=HeaderScope.SOURCE) 30Header('tu_device.h', scope=HeaderScope.SOURCE) 31Header('common/freedreno_lrz.h') 32Header('vulkan/vulkan_core.h', scope=HeaderScope.SOURCE|HeaderScope.PERFETTO) 33 34# we can't use tu_common.h because it includes ir3 headers which are not 35# compatible with C++ 36ForwardDecl('struct tu_cmd_buffer') 37ForwardDecl('struct tu_device') 38ForwardDecl('struct tu_framebuffer') 39ForwardDecl('struct tu_tiling_config') 40 41# List of the default tracepoints enabled. By default tracepoints are enabled, 42# set tp_default_enabled=False to disable them by default. 43tu_default_tps = [] 44 45# 46# Tracepoint definitions: 47# 48 49def begin_end_tp(name, args=[], tp_struct=None, tp_print=None, 50 end_args=[], end_tp_struct=None, end_tp_print=None, 51 tp_default_enabled=True, marker_tp=True, 52 queue_tp=True): 53 global tu_default_tps 54 if tp_default_enabled: 55 tu_default_tps.append(name) 56 Tracepoint('start_{0}'.format(name), 57 toggle_name=name, 58 args=args, 59 tp_struct=tp_struct, 60 tp_perfetto='tu_perfetto_start_{0}'.format(name) if queue_tp else None, 61 tp_print=tp_print if queue_tp else None, 62 tp_markers='tu_cs_trace_start' if marker_tp else None) 63 Tracepoint('end_{0}'.format(name), 64 toggle_name=name, 65 args=end_args, 66 tp_struct=end_tp_struct, 67 tp_perfetto='tu_perfetto_end_{0}'.format(name), 68 tp_print=end_tp_print if queue_tp else None, 69 tp_markers='tu_cs_trace_end' if marker_tp else None) 70 71begin_end_tp('cmd_buffer', 72 args=[ArgStruct(type='const struct tu_cmd_buffer *', var='cmd')], 73 tp_struct=[Arg(type='const char *', name='appName', var='cmd->device->instance->vk.app_info.app_name', c_format='%s'), 74 Arg(type='const char *', name='engineName', var='cmd->device->instance->vk.app_info.engine_name', c_format='%s'), 75 Arg(type='VkCommandBufferLevel', name='level', var='cmd->vk.level', c_format='%s', to_prim_type='vk_CommandBufferLevel_to_str({})'), 76 Arg(type='uint8_t', name='render_pass_continue', var='!!(cmd->usage_flags & VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT)', c_format='%u')]) 77 78begin_end_tp('render_pass', 79 args=[ArgStruct(type='const struct tu_framebuffer *', var='fb'), 80 ArgStruct(type='const struct tu_tiling_config *', var='tiling'), 81 Arg(type='uint8_t', var='maxSamples', c_format='%u'), 82 Arg(type='uint8_t', var='clearCPP', c_format='%u'), 83 Arg(type='uint8_t', var='loadCPP', c_format='%u'), 84 Arg(type='uint8_t', var='storeCPP', c_format='%u'), 85 Arg(type='bool', var='hasDepth', c_format='%s', to_prim_type='({} ? "true" : "false")'), 86 Arg(type='str', var='ubwc', c_format='%s', length_arg='11', copy_func='strncpy'),], 87 tp_struct=[Arg(type='uint16_t', name='width', var='fb->width', c_format='%u'), 88 Arg(type='uint16_t', name='height', var='fb->height', c_format='%u'), 89 Arg(type='uint8_t', name='attachment_count', var='fb->attachment_count', c_format='%u'), 90 Arg(type='uint16_t', name='numberOfBins', var='tiling->tile_count.width * tiling->tile_count.height', c_format='%u'), 91 Arg(type='uint16_t', name='binWidth', var='tiling->tile0.width', c_format='%u'), 92 Arg(type='uint16_t', name='binHeight', var='tiling->tile0.height', c_format='%u'),], 93 # Args known only at the end of the renderpass: 94 end_args=[Arg(type='bool', var='tiledRender', c_format='%s', to_prim_type='({} ? "true" : "false")'), 95 Arg(type='uint32_t', var='drawCount', c_format='%u'), 96 Arg(type='uint32_t', var='avgPerSampleBandwidth', c_format='%u'), 97 Arg(type='bool', var='lrz', c_format='%s', to_prim_type='({} ? "true" : "false")'), 98 Arg(type='const char *', var='lrzDisableReason', c_format='%s'), 99 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),]) 100 101 102begin_end_tp('binning_ib') 103begin_end_tp('draw_ib_sysmem') 104begin_end_tp('draw_ib_gmem') 105 106begin_end_tp('generic_clear', 107 args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 108 Arg(type='bool', var='ubwc', c_format='%s', to_prim_type='({} ? "true" : "false")'), 109 Arg(type='uint8_t', var='samples', c_format='%u')]) 110 111begin_end_tp('gmem_clear', 112 args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 113 Arg(type='uint8_t', var='samples', c_format='%u')]) 114 115begin_end_tp('sysmem_clear', 116 args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 117 Arg(type='uint8_t', var='uses_3d_ops', c_format='%u'), 118 Arg(type='uint8_t', var='samples', c_format='%u')]) 119 120begin_end_tp('sysmem_clear_all', 121 args=[Arg(type='uint8_t', var='mrt_count', c_format='%u'), 122 Arg(type='uint8_t', var='rect_count', c_format='%u')]) 123 124begin_end_tp('gmem_load', 125 args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 126 Arg(type='uint8_t', var='force_load', c_format='%u')]) 127 128begin_end_tp('gmem_store', 129 args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 130 Arg(type='uint8_t', var='fast_path', c_format='%u'), 131 Arg(type='uint8_t', var='unaligned', c_format='%u')]) 132 133begin_end_tp('sysmem_resolve', 134 args=[Arg(type='enum VkFormat', var='format', c_format='%s', to_prim_type='vk_format_description({})->short_name')]) 135 136begin_end_tp('blit', 137 # TODO: add source megapixels count and target megapixels count arguments 138 args=[Arg(type='uint8_t', var='uses_3d_blit', c_format='%u'), 139 Arg(type='enum VkFormat', var='src_format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 140 Arg(type='enum VkFormat', var='dst_format', c_format='%s', to_prim_type='vk_format_description({})->short_name'), 141 Arg(type='uint8_t', var='layers', c_format='%u')]) 142 143begin_end_tp('compute', 144 args=[Arg(type='uint8_t', var='indirect', c_format='%u'), 145 Arg(type='uint16_t', var='local_size_x', c_format='%u'), 146 Arg(type='uint16_t', var='local_size_y', c_format='%u'), 147 Arg(type='uint16_t', var='local_size_z', c_format='%u'), 148 Arg(type='uint16_t', var='num_groups_x', c_format='%u'), 149 Arg(type='uint16_t', var='num_groups_y', c_format='%u'), 150 Arg(type='uint16_t', var='num_groups_z', c_format='%u')]) 151 152begin_end_tp('compute_indirect', 153 end_args=[ArgStruct(type='VkDispatchIndirectCommand', var='size', 154 is_indirect=True, c_format="%ux%ux%u", 155 fields=['x', 'y', 'z'])]) 156 157# Annotations for Cmd(Begin|End)DebugUtilsLabelEXT 158for suffix in ["", "_rp"]: 159 begin_end_tp('cmd_buffer_annotation' + suffix, 160 args=[Arg(type='unsigned', var='len'), 161 Arg(type='str', var='str', c_format='%s', length_arg='len + 1', copy_func='strncpy'),], 162 tp_struct=[Arg(type='uint8_t', name='dummy', var='0'),]) 163 164utrace_generate(cpath=args.utrace_src, 165 hpath=args.utrace_hdr, 166 ctx_param='struct tu_device *dev', 167 trace_toggle_name='tu_gpu_tracepoint', 168 trace_toggle_defaults=tu_default_tps) 169utrace_generate_perfetto_utils(hpath=args.perfetto_hdr) 170