blob: f99ced166c5956e9167cf6f5c8ab77806d1c7769 [file] [log] [blame]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001#!/usr/bin/env python3
2#
3# Vulkan
4#
Courtney Goeltzenleuchter8a17da52015-10-29 13:50:34 -06005# Copyright (C) 2015 Valve Corporation
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06006#
7# Permission is hereby granted, free of charge, to any person obtaining a
8# copy of this software and associated documentation files (the "Software"),
9# to deal in the Software without restriction, including without limitation
10# the rights to use, copy, modify, merge, publish, distribute, sublicense,
11# and/or sell copies of the Software, and to permit persons to whom the
12# Software is furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included
15# in all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23# DEALINGS IN THE SOFTWARE.
24#
25
26import os, sys
Jon Ashburncb622a12015-08-06 17:22:53 -060027
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060028
29# add main repo directory so vulkan.py can be imported. This needs to be a complete path.
Mark Lobodzinski87220f82015-08-27 15:30:29 -060030vktrace_scripts_path = os.path.dirname(os.path.abspath(__file__))
31main_path = os.path.abspath(vktrace_scripts_path + "/../")
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060032sys.path.append(main_path)
Jon Ashburncb622a12015-08-06 17:22:53 -060033from source_line_info import sourcelineinfo
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060034
Jon Ashburncb622a12015-08-06 17:22:53 -060035import vulkan
36
37# vulkan.py doesn't include all the extensions (debug_report missing)
38headers = []
39objects = []
40protos = []
41for ext in vulkan.extensions_all:
42 headers.extend(ext.headers)
43 objects.extend(ext.objects)
44 protos.extend(ext.protos)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060045
46class Subcommand(object):
47 def __init__(self, argv):
48 self.argv = argv
Chia-I Wu1f851912015-10-27 18:04:07 +080049 self.extensionName = argv
Jon Ashburncb622a12015-08-06 17:22:53 -060050 self.headers = headers
51 self.objects = objects
52 self.protos = protos
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060053 self.lineinfo = sourcelineinfo()
54
55 def run(self):
Chia-I Wu1f851912015-10-27 18:04:07 +080056 print(self.generate(self.extensionName))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060057
Chia-I Wu1f851912015-10-27 18:04:07 +080058 def generate(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060059 copyright = self.generate_copyright()
Chia-I Wu1f851912015-10-27 18:04:07 +080060 header = self.generate_header(extensionName)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060061 body = self.generate_body()
62 footer = self.generate_footer()
63 contents = []
64 if copyright:
65 contents.append(copyright)
66 if header:
67 contents.append(header)
68 if body:
69 contents.append(body)
70 if footer:
71 contents.append(footer)
72
73 return "\n\n".join(contents)
74
75 def generate_copyright(self):
76 return """/* THIS FILE IS GENERATED. DO NOT EDIT. */
77
78/*
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060079 *
Courtney Goeltzenleuchter8a17da52015-10-29 13:50:34 -060080 * Copyright (C) 2015 Valve Corporation
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060081 *
82 * Permission is hereby granted, free of charge, to any person obtaining a
83 * copy of this software and associated documentation files (the "Software"),
84 * to deal in the Software without restriction, including without limitation
85 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
86 * and/or sell copies of the Software, and to permit persons to whom the
87 * Software is furnished to do so, subject to the following conditions:
88 *
89 * The above copyright notice and this permission notice shall be included
90 * in all copies or substantial portions of the Software.
91 *
92 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
93 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
94 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
95 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
96 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
97 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
98 * DEALINGS IN THE SOFTWARE.
99 */"""
100
Chia-I Wu1f851912015-10-27 18:04:07 +0800101 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600102 return "\n".join(["#include <" + h + ">" for h in self.headers])
103
104 def generate_body(self):
105 pass
106
107 def generate_footer(self):
108 pass
109
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600110 def _generate_trace_func_protos(self):
111 func_protos = []
Jon Ashburn4278f642015-09-11 13:12:02 -0600112 func_protos.append('#ifdef __cplusplus')
113 func_protos.append('extern"C" {')
114 func_protos.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600115 func_protos.append('// Hooked function prototypes\n')
116 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -0600117 if 'Dbg' not in proto.name and 'KHR' not in proto.name:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600118 func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600119
Jon Ashburn4278f642015-09-11 13:12:02 -0600120 func_protos.append('#ifdef __cplusplus')
121 func_protos.append('}')
122 func_protos.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600123 return "\n".join(func_protos)
124
Chia-I Wu1f851912015-10-27 18:04:07 +0800125 def _generate_trace_func_protos_ext(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600126 func_protos = []
127 func_protos.append('// Hooked function prototypes\n')
Jon Ashburncb622a12015-08-06 17:22:53 -0600128 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800129 if (extensionName.lower() == ext.name.lower()):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600130 for proto in ext.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600131 func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600132
133 return "\n".join(func_protos)
134
135
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600136 def _generate_init_funcs(self):
137 init_tracer = []
138 init_tracer.append('void send_vk_api_version_packet()\n{')
139 init_tracer.append(' packet_vkApiVersion* pPacket;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600140 init_tracer.append(' vktrace_trace_packet_header* pHeader;')
141 init_tracer.append(' pHeader = vktrace_create_trace_packet(VKTRACE_TID_VULKAN, VKTRACE_TPI_VK_vkApiVersion, sizeof(packet_vkApiVersion), 0);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600142 init_tracer.append(' pPacket = interpret_body_as_vkApiVersion(pHeader);')
143 init_tracer.append(' pPacket->version = VK_API_VERSION;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600144 init_tracer.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600145 init_tracer.append(' FINISH_TRACE_PACKET();\n}\n')
146
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600147 init_tracer.append('extern VKTRACE_CRITICAL_SECTION g_memInfoLock;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600148 init_tracer.append('void InitTracer(void)\n{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600149 init_tracer.append(' const char *ipAddr = vktrace_get_global_var("VKTRACE_LIB_IPADDR");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600150 init_tracer.append(' if (ipAddr == NULL)')
151 init_tracer.append(' ipAddr = "127.0.0.1";')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600152 init_tracer.append(' gMessageStream = vktrace_MessageStream_create(FALSE, ipAddr, VKTRACE_BASE_PORT + VKTRACE_TID_VULKAN);')
153 init_tracer.append(' vktrace_trace_set_trace_file(vktrace_FileLike_create_msg(gMessageStream));')
154 init_tracer.append(' vktrace_tracelog_set_tracer_id(VKTRACE_TID_VULKAN);')
155 init_tracer.append(' vktrace_create_critical_section(&g_memInfoLock);')
Mark Lobodzinski48837d12015-09-28 12:08:57 -0600156 init_tracer.append(' if (gMessageStream != NULL)')
157 init_tracer.append(' send_vk_api_version_packet();\n}\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600158 return "\n".join(init_tracer)
159
160 # Take a list of params and return a list of dicts w/ ptr param details
161 def _get_packet_ptr_param_list(self, params):
162 ptr_param_list = []
163 # TODO : This is a slightly nicer way to handle custom cases than initial code, however
164 # this can still be further generalized to eliminate more custom code
165 # big case to handle is when ptrs to structs have embedded data that needs to be accounted for in packet
166 custom_ptr_dict = {'VkDeviceCreateInfo': {'add_txt': 'add_VkDeviceCreateInfo_to_packet(pHeader, (VkDeviceCreateInfo**) &(pPacket->pCreateInfo), pCreateInfo)',
167 'finalize_txt': ''},
Chia-I Wu1f851912015-10-27 18:04:07 +0800168 'VkApplicationInfo': {'add_txt': 'add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&(pPacket->pApplicationInfo), pApplicationInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600169 'finalize_txt': ''},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600170 'VkPhysicalDevice': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pGpus), *pGpuCount*sizeof(VkPhysicalDevice), pGpus)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600171 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600172 'pDataSize': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDataSize), sizeof(size_t), &_dataSize)',
173 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pDataSize))'},
174# 'pData': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pData), _dataSize, pData)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600175# 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600176 'pName': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pName), ((pName != NULL) ? strlen(pName) + 1 : 0), pName)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600177 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600178 'pMarker': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pMarker), ((pMarker != NULL) ? strlen(pMarker) + 1 : 0), pMarker)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600179 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600180 'pExtName': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pExtName), ((pExtName != NULL) ? strlen(pExtName) + 1 : 0), pExtName)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600181 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600182 'pDescriptorSets': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDescriptorSets), customSize, pDescriptorSets)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600183 'finalize_txt': 'default'},
Chia-I Wu763a7492015-10-26 20:48:51 +0800184 'pSparseMemoryRequirements': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pSparseMemoryRequirements), (*pSparseMemoryRequirementCount) * sizeof(VkSparseImageMemoryRequirements), pSparseMemoryRequirements)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600185 'finalize_txt': 'default'},
Chia-I Wu763a7492015-10-26 20:48:51 +0800186 'VkSparseImageFormatProperties': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pProperties), (*pPropertyCount) * sizeof(VkSparseImageFormatProperties), pProperties)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600187 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600188 'VkSparseMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseMemoryBindInfo), pBindInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600189 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600190 'VkSparseImageMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseImageMemoryBindInfo), pBindInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600191 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600192 'VkFramebufferCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkFramebufferCreateInfo), pCreateInfo);\n'
193 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments), colorCount * sizeof(VkColorAttachmentBindInfo), pCreateInfo->pColorAttachments);\n'
194 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment), dsSize, pCreateInfo->pDepthStencilAttachment)',
195 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments));\n'
196 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment));\n'
197 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
198 'VkRenderPassCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkRenderPassCreateInfo), pCreateInfo);\n'
199 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats), colorCount * sizeof(VkFormat), pCreateInfo->pColorFormats);\n'
200 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts), colorCount * sizeof(VkImageLayout), pCreateInfo->pColorLayouts);\n'
201 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps), colorCount * sizeof(VkAttachmentLoadOp), pCreateInfo->pColorLoadOps);\n'
202 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps), colorCount * sizeof(VkAttachmentStoreOp), pCreateInfo->pColorStoreOps);\n'
203 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues), colorCount * sizeof(VkClearColor), pCreateInfo->pColorLoadClearValues)',
204 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats));\n'
205 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts));\n'
206 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps));\n'
207 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps));\n'
208 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues));\n'
209 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
210 'VkPipelineLayoutCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkPipelineLayoutCreateInfo), pCreateInfo);\n'
Chia-I Wu763a7492015-10-26 20:48:51 +0800211 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts), pCreateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout), pCreateInfo->pSetLayouts);',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600212 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts));\n'
213 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Chia-I Wu1f851912015-10-27 18:04:07 +0800214 'VkMemoryAllocateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo), sizeof(VkMemoryAllocateInfo), pAllocateInfo);\n'
215 ' add_alloc_memory_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo->pNext), pAllocateInfo->pNext)',
216 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pAllocateInfo))'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600217# 'VkGraphicsPipelineCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfos), count*sizeof(VkGraphicsPipelineCreateInfo), pCreateInfos);\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600218# ' add_VkGraphicsPipelineCreateInfos_to_trace_packet(pHeader, (VkGraphicsPipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600219# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
220# 'VkComputePipelineCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfos), count*sizeof(VkComputePipelineCreateInfo), pCreateInfos);\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600221# ' add_VkComputePipelineCreateInfos_to_trace_packet(pHeader, (VkComputePipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600222# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
223 'VkDescriptorPoolCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkDescriptorPoolCreateInfo), pCreateInfo);\n'
Chia-I Wuc51b1212015-10-27 19:25:11 +0800224 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes), pCreateInfo->poolSizeCount * sizeof(VkDescriptorPoolSize), pCreateInfo->pPoolSizes)',
225 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes));\n'
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600226 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600227 'VkDescriptorSetLayoutCreateInfo': {'add_txt': 'add_create_ds_layout_to_trace_packet(pHeader, &pPacket->pCreateInfo, pCreateInfo)',
228 'finalize_txt': '// pCreateInfo finalized in add_create_ds_layout_to_trace_packet'},
Ian Elliott338dedb2015-08-21 15:09:33 -0600229 'VkSwapchainCreateInfoKHR': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkSwapchainCreateInfoKHR), pCreateInfo);\n'
230 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSurfaceDescription), sizeof(VkSurfaceDescriptionKHR), pCreateInfo->pSurfaceDescription)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600231 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSurfaceDescription));\n'
232 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
233 'VkShaderModuleCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkShaderModuleCreateInfo), pCreateInfo);\n'
234 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pCode), pPacket->pCreateInfo->codeSize, pCreateInfo->pCode)',
235 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pCode));\n'
236 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600237 }
238
239 for p in params:
240 pp_dict = {}
Jon Ashburnbb4e7c12015-09-14 17:30:20 -0600241 if '*' in p.ty and p.name not in ['pTag', 'pUserData']:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600242 if 'const' in p.ty.lower() and 'count' in params[params.index(p)-1].name.lower():
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600243 pp_dict['add_txt'] = 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->%s), %s*sizeof(%s), %s)' % (p.name, params[params.index(p)-1].name, p.ty.strip('*').replace('const ', ''), p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600244 elif 'pOffsets' == p.name: # TODO : This is a custom case for BindVertexBuffers last param, need to clean this up
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600245 pp_dict['add_txt'] = 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->%s), %s*sizeof(%s), %s)' % (p.name, params[params.index(p)-2].name, p.ty.strip('*').replace('const ', ''), p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600246 elif p.ty.strip('*').replace('const ', '') in custom_ptr_dict:
247 pp_dict['add_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['add_txt']
248 pp_dict['finalize_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['finalize_txt']
249 elif p.name in custom_ptr_dict:
250 pp_dict['add_txt'] = custom_ptr_dict[p.name]['add_txt']
251 pp_dict['finalize_txt'] = custom_ptr_dict[p.name]['finalize_txt']
252 # TODO : This is custom hack to account for 2 pData items with dataSize param for sizing
253 if 'pData' == p.name and 'dataSize' == params[params.index(p)-1].name:
254 pp_dict['add_txt'] = pp_dict['add_txt'].replace('_dataSize', 'dataSize')
Jon Ashburnbb4e7c12015-09-14 17:30:20 -0600255 elif 'void' in p.ty and (p.name == 'pData' or p.name == 'values'):
256 pp_dict['add_txt'] = '//TODO FIXME vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->%s), sizeof(%s), %s)' % (p.name, p.ty.strip('*').replace('const ', ''), p.name)
257 pp_dict['finalize_txt'] = '//TODO FIXME vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600258 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600259 pp_dict['add_txt'] = 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->%s), sizeof(%s), %s)' % (p.name, p.ty.strip('*').replace('const ', ''), p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600260 if 'finalize_txt' not in pp_dict or 'default' == pp_dict['finalize_txt']:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600261 pp_dict['finalize_txt'] = 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600262 pp_dict['index'] = params.index(p)
263 ptr_param_list.append(pp_dict)
264 return ptr_param_list
265
266 # Take a list of params and return a list of packet size elements
Chia-I Wu1f851912015-10-27 18:04:07 +0800267 def _get_packet_size(self, extensionName, params):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600268 ps = [] # List of elements to be added together to account for packet size for given params
269 skip_list = [] # store params that are already accounted for so we don't count them twice
270 # Dict of specific params with unique custom sizes
Courtney Goeltzenleuchter8e2f0972015-10-21 17:08:06 -0600271 # TODO: Now using bitfields for all stages, need pSetBindPoints to accomodate that.
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600272 custom_size_dict = {'pSetBindPoints': '(VK_SHADER_STAGE_COMPUTE * sizeof(uint32_t))', # Accounting for largest possible array
Ian Elliott338dedb2015-08-21 15:09:33 -0600273 'VkSwapchainCreateInfoKHR' : 'vk_ext_khr_device_swapchain_size_vkswapchaincreateinfokhr(pCreateInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600274 }
275 size_func_suffix = ''
Chia-I Wu1f851912015-10-27 18:04:07 +0800276 if extensionName.lower() != "vk_core":
277 size_func_suffix = '_%s' % extensionName.lower()
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600278 for p in params:
279 #First handle custom cases
Chia-I Wu1f851912015-10-27 18:04:07 +0800280 if p.name in ['pCreateInfo', 'pSetLayoutInfoList', 'pBeginInfo', 'pAllocateInfo'] and 'khr' not in p.ty.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600281 ps.append('get_struct_chain_size%s((void*)%s)' % (size_func_suffix, p.name))
282 skip_list.append(p.name)
283 elif p.name in custom_size_dict:
284 ps.append(custom_size_dict[p.name])
285 skip_list.append(p.name)
286 elif p.ty.strip('*').replace('const ', '') in custom_size_dict:
287 tmp_ty = p.ty.strip('*').replace('const ', '')
288 ps.append(custom_size_dict[tmp_ty])
289 skip_list.append(p.name)
290 # Skip any params already handled
291 if p.name in skip_list:
292 continue
293 # Now check to identify dynamic arrays which depend on two params
294 if 'count' in p.name.lower():
295 next_idx = params.index(p)+1
296 # If next element is a const *, then multiply count and array type
297 if next_idx < len(params) and '*' in params[next_idx].ty and 'const' in params[next_idx].ty.lower():
298 if '*' in p.ty:
299 ps.append('*%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
300 else:
301 ps.append('%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
302 skip_list.append(params[next_idx].name)
303 if 'bindingCount' == p.name: # TODO : This is custom case for CmdBindVertexBuffers, need to clean it up
304 ps.append('%s*sizeof(%s)' % (p.name, params[next_idx+1].ty.strip('*').replace('const ', '')))
305 skip_list.append(params[next_idx+1].name)
306 elif '*' in p.ty: # Not a custom array size we're aware of, but ptr so need to account for its size
307 ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
308 elif '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
309 if 'pData' == p.name:
310 if 'dataSize' == params[params.index(p)-1].name:
311 ps.append('dataSize')
312 elif 'counterCount' == params[params.index(p)-1].name:
313 ps.append('sizeof(%s)' % p.ty.strip('*').replace('const ', ''))
314 else:
315 #ps.append('((pDataSize != NULL && pData != NULL) ? *pDataSize : 0)')
316 ps.append('sizeof(void*)')
317 elif '**' in p.ty and 'void' in p.ty:
318 ps.append('sizeof(void*)')
319 elif 'void' in p.ty:
320 ps.append('sizeof(%s)' % p.name)
321 elif 'char' in p.ty:
322 ps.append('((%s != NULL) ? strlen(%s) + 1 : 0)' % (p.name, p.name))
323 elif 'pDataSize' in p.name:
324 ps.append('((pDataSize != NULL) ? sizeof(size_t) : 0)')
325 elif 'IMAGE_SUBRESOURCE' in p.ty and 'pSubresource' == p.name:
326 ps.append('((pSubresource != NULL) ? sizeof(VkImage_SUBRESOURCE) : 0)')
327 else:
328 ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
329 return ps
330
331 # Generate functions used to trace API calls and store the input and result data into a packet
332 # Here's the general flow of code insertion w/ option items flagged w/ "?"
333 # Result decl?
334 # Packet struct decl
335 # ?Special case : setup call to function first and do custom API call time tracking
336 # CREATE_PACKET
337 # call real entrypoint and get return value (if there is one)
338 # Assign packet values
339 # FINISH packet
340 # return result if needed
Chia-I Wu1f851912015-10-27 18:04:07 +0800341 def _generate_trace_funcs(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600342 func_body = []
Chia-I Wu1f851912015-10-27 18:04:07 +0800343 manually_written_hooked_funcs = ['AllocateMemory',
344 'AllocateDescriptorSets',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600345 'CreateDescriptorPool',
Jon Ashburne70884b2015-08-25 13:33:39 -0600346 'CreateDevice',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600347 'CreateFramebuffer',
348 'CreateInstance',
349 'CreateRenderPass',
350 'CreateGraphicsPipelines',
351 'CreateComputePipelines',
352 'CmdPipelineBarrier',
353 'CmdWaitEvents',
354 'CmdBeginRenderPass',
355 'EnumeratePhysicalDevices',
356 'FreeMemory',
357 'FreeDescriptorSets',
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600358 'QueueSubmit',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600359 'FlushMappedMemoryRanges',
Jon Ashburn71654fd2015-09-11 09:18:44 -0600360 'GetDeviceProcAddr',
Jon Ashburn71654fd2015-09-11 09:18:44 -0600361 'GetInstanceProcAddr',
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -0600362 'EnumerateInstanceExtensionProperties',
363 'EnumerateDeviceExtensionProperties',
364 'EnumerateInstanceLayerProperties',
365 'EnumerateDeviceLayerProperties',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600366 'GetPhysicalDeviceQueueFamilyProperties',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600367 'GetQueryPoolResults',
368 'MapMemory',
369 'UnmapMemory',
370 'UpdateDescriptorSets',
Ian Elliott338dedb2015-08-21 15:09:33 -0600371 'GetSurfacePropertiesKHR',
372 'GetSurfaceFormatsKHR',
373 'GetSurfacePresentModesKHR',
374 'CreateSwapchainKHR',
375 'GetSwapchainImagesKHR',
376 'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600377 ]
378
379 # validate the manually_written_hooked_funcs list
380 protoFuncs = [proto.name for proto in self.protos]
381 for func in manually_written_hooked_funcs:
382 if func not in protoFuncs:
383 sys.exit("Entry '%s' in manually_written_hooked_funcs list is not in the vulkan function prototypes" % func)
384
385 # process each of the entrypoint prototypes
Jon Ashburncb622a12015-08-06 17:22:53 -0600386 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800387 if ext.name.lower() == extensionName.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600388 for proto in ext.protos:
389 if proto.name in manually_written_hooked_funcs:
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600390 func_body.append( '// __HOOKED_vk%s is manually written. Look in vktrace_lib_trace.cpp\n' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600391 else:
392 raw_packet_update_list = [] # non-ptr elements placed directly into packet
393 ptr_packet_update_list = [] # ptr elements to be updated into packet
394 return_txt = ''
395 packet_size = []
396 in_data_size = False # flag when we need to capture local input size variable for in/out size
397 func_body.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600398 func_body.append('VKTRACER_EXPORT %s VKAPI __HOOKED_vk%s(' % (proto.ret, proto.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600399 for p in proto.params: # TODO : For all of the ptr types, check them for NULL and return 0 if NULL
Chia-I Wua5cd6532015-10-28 18:31:57 +0800400 func_body.append(' %s,' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600401 if '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
402 if 'pDataSize' in p.name:
403 in_data_size = True;
404 elif 'pfnMsgCallback' == p.name:
405 raw_packet_update_list.append(' PFN_vkDbgMsgCallback* pNonConstCallback = (PFN_vkDbgMsgCallback*)&pPacket->pfnMsgCallback;')
406 raw_packet_update_list.append(' *pNonConstCallback = pfnMsgCallback;')
Chia-I Wua5cd6532015-10-28 18:31:57 +0800407 elif '[' in p.ty:
408 raw_packet_update_list.append(' memcpy((void *) pPacket->%s, %s, sizeof(pPacket->%s));' % (p.name, p.name, p.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600409 else:
410 raw_packet_update_list.append(' pPacket->%s = %s;' % (p.name, p.name))
411 # Get list of packet size modifiers due to ptr params
Chia-I Wu1f851912015-10-27 18:04:07 +0800412 packet_size = self._get_packet_size(extensionName, proto.params)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600413 ptr_packet_update_list = self._get_packet_ptr_param_list(proto.params)
414 func_body[-1] = func_body[-1].replace(',', ')')
415 # End of function declaration portion, begin function body
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600416 func_body.append('{\n vktrace_trace_packet_header* pHeader;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600417 if 'void' not in proto.ret or '*' in proto.ret:
418 func_body.append(' %s result;' % proto.ret)
419 return_txt = 'result = '
420 if in_data_size:
421 func_body.append(' size_t _dataSize;')
422 func_body.append(' packet_vk%s* pPacket = NULL;' % proto.name)
Jon Ashburnf6754d42015-09-14 16:48:31 -0600423 if proto.name == "DestroyInstance" or proto.name == "DestroyDevice":
424 func_body.append(' dispatch_key key = get_dispatch_key(%s);' % proto.params[0].name)
425
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600426 if (0 == len(packet_size)):
427 func_body.append(' CREATE_TRACE_PACKET(vk%s, 0);' % (proto.name))
428 else:
429 func_body.append(' CREATE_TRACE_PACKET(vk%s, %s);' % (proto.name, ' + '.join(packet_size)))
430
Jon Ashburn71654fd2015-09-11 09:18:44 -0600431 # call down the layer chain and get return value (if there is one)
432 # Note: this logic doesn't work for CreateInstance or CreateDevice but those are handwritten
Chia-I Wu1f851912015-10-27 18:04:07 +0800433 if extensionName == 'vk_debug_marker_lunarg':
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600434 table_txt = 'mdd(%s)->debugMarkerTable' % proto.params[0].name
Jon Ashburn71654fd2015-09-11 09:18:44 -0600435 elif proto.params[0].ty in ['VkInstance', 'VkPhysicalDevice']:
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600436 table_txt = 'mid(%s)->instTable' % proto.params[0].name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600437 else:
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600438 table_txt = 'mdd(%s)->devTable' % proto.params[0].name
Jon Ashburn71654fd2015-09-11 09:18:44 -0600439 func_body.append(' %s%s.%s;' % (return_txt, table_txt, proto.c_call()))
440 func_body.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600441
442 if in_data_size:
443 func_body.append(' _dataSize = (pDataSize == NULL || pData == NULL) ? 0 : *pDataSize;')
444 func_body.append(' pPacket = interpret_body_as_vk%s(pHeader);' % proto.name)
445 func_body.append('\n'.join(raw_packet_update_list))
446 for pp_dict in ptr_packet_update_list: #buff_ptr_indices:
447 func_body.append(' %s;' % (pp_dict['add_txt']))
448 if 'void' not in proto.ret or '*' in proto.ret:
449 func_body.append(' pPacket->result = result;')
450 for pp_dict in ptr_packet_update_list:
451 if ('DeviceCreateInfo' not in proto.params[pp_dict['index']].ty):
452 func_body.append(' %s;' % (pp_dict['finalize_txt']))
453 # All buffers should be finalized by now, and the trace packet can be finished (which sends it over the socket)
454 func_body.append(' FINISH_TRACE_PACKET();')
Jon Ashburnf6754d42015-09-14 16:48:31 -0600455 if proto.name == "DestroyInstance":
456 func_body.append(' g_instanceDataMap.erase(key);')
457 elif proto.name == "DestroyDevice":
458 func_body.append(' g_deviceDataMap.erase(key);')
459
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600460 # return result if needed
461 if 'void' not in proto.ret or '*' in proto.ret:
462 func_body.append(' return result;')
463 func_body.append('}\n')
464 return "\n".join(func_body)
465
466 def _generate_packet_id_enum(self):
467 pid_enum = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600468 pid_enum.append('enum VKTRACE_TRACE_PACKET_ID_VK')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600469 pid_enum.append('{')
470 first_func = True
471 for proto in self.protos:
472 if first_func:
473 first_func = False
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600474 pid_enum.append(' VKTRACE_TPI_VK_vkApiVersion = VKTRACE_TPI_BEGIN_API_HERE,')
475 pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600476 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600477 pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600478 pid_enum.append('};\n')
479 return "\n".join(pid_enum)
480
481 def _generate_packet_id_name_func(self):
482 func_body = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600483 func_body.append('static const char *vktrace_vk_packet_id_name(const enum VKTRACE_TRACE_PACKET_ID_VK id)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600484 func_body.append('{')
485 func_body.append(' switch(id) {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600486 func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600487 func_body.append(' {')
488 func_body.append(' return "vkApiVersion";')
489 func_body.append(' }')
490 for proto in self.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600491 func_body.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600492 func_body.append(' {')
493 func_body.append(' return "vk%s";' % proto.name)
494 func_body.append(' }')
495 func_body.append(' default:')
496 func_body.append(' return NULL;')
497 func_body.append(' }')
498 func_body.append('}\n')
499 return "\n".join(func_body)
500
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600501 def _generate_interp_func(self):
502 interp_func_body = []
503 interp_func_body.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600504 interp_func_body.append('static vktrace_trace_packet_header* interpret_trace_packet_vk(vktrace_trace_packet_header* pHeader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600505 interp_func_body.append('{')
506 interp_func_body.append(' if (pHeader == NULL)')
507 interp_func_body.append(' {')
508 interp_func_body.append(' return NULL;')
509 interp_func_body.append(' }')
510 interp_func_body.append(' switch (pHeader->packet_id)')
511 interp_func_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600512 interp_func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600513 interp_func_body.append(' {')
514 interp_func_body.append(' return interpret_body_as_vkApiVersion(pHeader)->header;')
515 interp_func_body.append(' }')
516 for proto in self.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600517 interp_func_body.append(' case VKTRACE_TPI_VK_vk%s:\n {' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600518 header_prefix = 'h'
Ian Elliott338dedb2015-08-21 15:09:33 -0600519 if 'KHR' in proto.name or 'Dbg' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600520 header_prefix = 'pH'
521 interp_func_body.append(' return interpret_body_as_vk%s(pHeader)->%seader;\n }' % (proto.name, header_prefix))
522 interp_func_body.append(' default:')
523 interp_func_body.append(' return NULL;')
524 interp_func_body.append(' }')
525 interp_func_body.append(' return NULL;')
526 interp_func_body.append('}')
527 return "\n".join(interp_func_body)
528
529 def _generate_struct_util_funcs(self):
530 lineinfo = self.lineinfo
531 pid_enum = []
532 pid_enum.append('%s' % lineinfo.get())
533 pid_enum.append('//=============================================================================')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600534 pid_enum.append('static void add_VkApplicationInfo_to_packet(vktrace_trace_packet_header* pHeader, VkApplicationInfo** ppStruct, const VkApplicationInfo *pInStruct)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600535 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600536 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkApplicationInfo), pInStruct);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800537 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->pApplicationName), strlen(pInStruct->pApplicationName) + 1, pInStruct->pApplicationName);')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600538 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->pEngineName), strlen(pInStruct->pEngineName) + 1, pInStruct->pEngineName);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800539 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pApplicationName));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600540 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pEngineName));')
541 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&*ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600542 pid_enum.append('};\n')
543 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600544 pid_enum.append('static void add_VkInstanceCreateInfo_to_packet(vktrace_trace_packet_header* pHeader, VkInstanceCreateInfo** ppStruct, VkInstanceCreateInfo *pInStruct)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600545 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600546 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkInstanceCreateInfo), pInStruct);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800547 pid_enum.append(' add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&((*ppStruct)->pApplicationInfo), pInStruct->pApplicationInfo);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600548 # TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
549 pid_enum.append(' uint32_t i, siz = 0;')
Chia-I Wu763a7492015-10-26 20:48:51 +0800550 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerNameCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
551 pid_enum.append(' if (pInStruct->enabledLayerNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600552 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800553 pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600554 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600555 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
556 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600557 pid_enum.append(' }')
558 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600559 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800560 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionNameCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
561 pid_enum.append(' if (pInStruct->enabledExtensionNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600562 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800563 pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600564 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600565 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
566 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600567 pid_enum.append(' }')
568 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600569 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
570 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600571 pid_enum.append('}\n')
572 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600573 pid_enum.append('static void add_VkDeviceCreateInfo_to_packet(vktrace_trace_packet_header* pHeader, VkDeviceCreateInfo** ppStruct, const VkDeviceCreateInfo *pInStruct)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600574 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600575 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkDeviceCreateInfo), pInStruct);')
Courtney Goeltzenleuchterdfd53f52015-10-15 16:58:44 -0600576 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pRequestedQueues, pInStruct->requestedQueueCount*sizeof(VkDeviceQueueCreateInfo), pInStruct->pRequestedQueues);')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600577 pid_enum.append(' for (uint32_t i = 0; i < pInStruct->requestedQueueCount; i++) {')
578 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pRequestedQueues[i].pQueuePriorities,')
Chia-I Wu763a7492015-10-26 20:48:51 +0800579 pid_enum.append(' pInStruct->pRequestedQueues[i].queuePriorityCount*sizeof(float),')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600580 pid_enum.append(' pInStruct->pRequestedQueues[i].pQueuePriorities);')
Jon Ashburne27a9182015-10-16 17:50:47 -0600581 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pRequestedQueues[i].pQueuePriorities);')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600582 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600583 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pRequestedQueues);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600584 # TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
585 pid_enum.append(' uint32_t i, siz = 0;')
Chia-I Wu763a7492015-10-26 20:48:51 +0800586 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerNameCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
587 pid_enum.append(' if (pInStruct->enabledLayerNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600588 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800589 pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600590 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600591 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
592 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600593 pid_enum.append(' }')
594 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600595 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800596 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionNameCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
597 pid_enum.append(' if (pInStruct->enabledExtensionNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600598 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800599 pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600600 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600601 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
602 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600603 pid_enum.append(' }')
604 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600605 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
606 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pEnabledFeatures, sizeof(VkPhysicalDeviceFeatures), pInStruct->pEnabledFeatures);')
607 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pEnabledFeatures);')
608 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600609 pid_enum.append('}\n')
610 pid_enum.append('%s' % lineinfo.get())
611 pid_enum.append('//=============================================================================\n')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600612 pid_enum.append('static VkInstanceCreateInfo* interpret_VkInstanceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600613 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600614 pid_enum.append(' VkInstanceCreateInfo* pVkInstanceCreateInfo = (VkInstanceCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)ptr_variable);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600615 pid_enum.append(' uint32_t i;')
616 pid_enum.append(' if (pVkInstanceCreateInfo != NULL)')
617 pid_enum.append(' {')
Chia-I Wu1f851912015-10-27 18:04:07 +0800618 pid_enum.append(' pVkInstanceCreateInfo->pApplicationInfo = (VkApplicationInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo);')
619 pid_enum.append(' VkApplicationInfo** ppApplicationInfo = (VkApplicationInfo**) &pVkInstanceCreateInfo->pApplicationInfo;')
620 pid_enum.append(' (*ppApplicationInfo)->pApplicationName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo->pApplicationName);')
621 pid_enum.append(' (*ppApplicationInfo)->pEngineName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo->pEngineName);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800622 pid_enum.append(' if (pVkInstanceCreateInfo->enabledLayerNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600623 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600624 pid_enum.append(' pVkInstanceCreateInfo->ppEnabledLayerNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800625 pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledLayerNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600626 pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledLayerNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600627 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600628 pid_enum.append(' }')
629 pid_enum.append(' }')
Chia-I Wu763a7492015-10-26 20:48:51 +0800630 pid_enum.append(' if (pVkInstanceCreateInfo->enabledExtensionNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600631 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600632 pid_enum.append(' pVkInstanceCreateInfo->ppEnabledExtensionNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledExtensionNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800633 pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledExtensionNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600634 pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledExtensionNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600635 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600636 pid_enum.append(' }')
637 pid_enum.append(' }')
638 pid_enum.append(' }\n')
639 pid_enum.append(' return pVkInstanceCreateInfo;')
640 pid_enum.append('}\n')
641 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600642 pid_enum.append('static VkDeviceCreateInfo* interpret_VkDeviceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600643 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600644 pid_enum.append(' VkDeviceCreateInfo* pVkDeviceCreateInfo = (VkDeviceCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)ptr_variable);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600645 pid_enum.append(' uint32_t i;')
646 pid_enum.append(' if (pVkDeviceCreateInfo != NULL)')
647 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600648 pid_enum.append(' pVkDeviceCreateInfo->pRequestedQueues = (const VkDeviceQueueCreateInfo *)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->pRequestedQueues);\n')
Chia-I Wu763a7492015-10-26 20:48:51 +0800649 pid_enum.append(' if (pVkDeviceCreateInfo->enabledLayerNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600650 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600651 pid_enum.append(' pVkDeviceCreateInfo->ppEnabledLayerNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800652 pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledLayerNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600653 pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledLayerNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600654 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600655 pid_enum.append(' }')
656 pid_enum.append(' }')
Chia-I Wu763a7492015-10-26 20:48:51 +0800657 pid_enum.append(' if (pVkDeviceCreateInfo->enabledExtensionNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600658 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600659 pid_enum.append(' pVkDeviceCreateInfo->ppEnabledExtensionNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledExtensionNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800660 pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledExtensionNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600661 pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledExtensionNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600662 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600663 pid_enum.append(' }')
664 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600665 pid_enum.append(' pVkDeviceCreateInfo->pEnabledFeatures = (const VkPhysicalDeviceFeatures*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->pEnabledFeatures);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600666 pid_enum.append(' }\n')
667 pid_enum.append(' return pVkDeviceCreateInfo;')
668 pid_enum.append('}\n')
669 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600670 pid_enum.append('static void interpret_VkPipelineShaderStageCreateInfo(vktrace_trace_packet_header* pHeader, VkPipelineShaderStageCreateInfo* pShader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600671 pid_enum.append('{')
672 pid_enum.append(' if (pShader != NULL)')
673 pid_enum.append(' {')
Chia-I Wu062ad152015-10-31 00:31:16 +0800674 pid_enum.append(' pShader->pName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pName);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600675 pid_enum.append(' // specialization info')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600676 pid_enum.append(' pShader->pSpecializationInfo = (const VkSpecializationInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pSpecializationInfo);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600677 pid_enum.append(' if (pShader->pSpecializationInfo != NULL)')
678 pid_enum.append(' {')
679 pid_enum.append(' VkSpecializationInfo* pInfo = (VkSpecializationInfo*)pShader->pSpecializationInfo;')
Chia-I Wu483e7702015-10-26 17:20:32 +0800680 pid_enum.append(' pInfo->pMapEntries = (const VkSpecializationMapEntry*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pSpecializationInfo->pMapEntries);')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600681 pid_enum.append(' pInfo->pData = (const void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pSpecializationInfo->pData);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600682 pid_enum.append(' }')
683 pid_enum.append(' }')
684 pid_enum.append('}\n')
685 pid_enum.append('//=============================================================================')
686 return "\n".join(pid_enum)
687
688 # Interpret functions used on replay to read in packets and interpret their contents
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -0600689 # This code gets generated into vktrace_vk_vk_packets.h file
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600690 def _generate_interp_funcs(self):
691 # Custom txt for given function and parameter. First check if param is NULL, then insert txt if not
692 # First some common code used by both CmdWaitEvents & CmdPipelineBarrier
693 mem_barrier_interp = ['uint32_t i = 0;\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800694 'for (i = 0; i < pPacket->memoryBarrierCount; i++) {\n',
695 ' void** ppMB = (void**)&(pPacket->ppMemoryBarriers[i]);\n',
696 ' *ppMB = vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppMemoryBarriers[i]);\n',
697 ' //VkMemoryBarrier* pBarr = (VkMemoryBarrier*)pPacket->ppMemoryBarriers[i];\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600698 ' // TODO : Could fix up the pNext ptrs here if they were finalized and if we cared by switching on Barrier type and remapping\n',
699 '}']
700 create_rp_interp = ['VkRenderPassCreateInfo* pInfo = (VkRenderPassCreateInfo*)pPacket->pCreateInfo;\n',
701 'uint32_t i = 0;\n',
702 'VkAttachmentDescription **ppAD = (VkAttachmentDescription **)&(pInfo->pAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600703 '*ppAD = (VkAttachmentDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600704 'VkSubpassDescription** ppSP = (VkSubpassDescription**)&(pInfo->pSubpasses);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600705 '*ppSP = (VkSubpassDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600706 'for (i=0; i<pInfo->subpassCount; i++) {\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600707 ' VkAttachmentReference** pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pInputAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600708 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pInputAttachments);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600709 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pColorAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600710 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pColorAttachments);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600711 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pResolveAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600712 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pResolveAttachments);\n',
Chia-I Wuce532f72015-10-26 17:32:47 +0800713 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
714 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600715 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pPreserveAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600716 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pPreserveAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600717 '}\n',
718 'VkSubpassDependency** ppSD = (VkSubpassDependency**)&(pInfo->pDependencies);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600719 '*ppSD = (VkSubpassDependency*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pDependencies);\n']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600720 create_gfx_pipe = ['uint32_t i;\n',
721 'uint32_t j;\n',
Chia-I Wu763a7492015-10-26 20:48:51 +0800722 'for (i=0; i<pPacket->createInfoCount; i++) {\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600723 'if (pPacket->pCreateInfos[i].sType == VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO) {\n',
724 '// need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
725 'VkGraphicsPipelineCreateInfo* pNonConst = (VkGraphicsPipelineCreateInfo*)&(pPacket->pCreateInfos[i]);\n',
726 '// shader stages array\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600727 'pNonConst->pStages = (VkPipelineShaderStageCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pStages);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600728 'for (j = 0; j < pPacket->pCreateInfos[i].stageCount; j++)\n',
729 '{\n',
730 ' interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)&pPacket->pCreateInfos[i].pStages[j]);\n',
731 '}\n',
732 '// Vertex Input State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600733 'pNonConst->pVertexInputState = (VkPipelineVertexInputStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600734 'VkPipelineVertexInputStateCreateInfo* pNonConstVIState = (VkPipelineVertexInputStateCreateInfo*)pNonConst->pVertexInputState;\n',
735 'if (pNonConstVIState) {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600736 ' pNonConstVIState->pVertexBindingDescriptions = (const VkVertexInputBindingDescription*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState->pVertexBindingDescriptions);\n',
737 ' pNonConstVIState->pVertexAttributeDescriptions = (const VkVertexInputAttributeDescription*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState->pVertexAttributeDescriptions);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600738 '}\n',
739 '// Input Assembly State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600740 'pNonConst->pInputAssemblyState = (const VkPipelineInputAssemblyStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pInputAssemblyState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600741 '// Tesselation State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600742 'pNonConst->pTessellationState = (const VkPipelineTessellationStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pTessellationState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600743 '// Viewport State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600744 'pNonConst->pViewportState = (const VkPipelineViewportStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pViewportState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600745 '// Raster State\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800746 'pNonConst->pRasterizationState = (const VkPipelineRasterizationStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pRasterizationState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600747 '// MultiSample State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600748 'pNonConst->pMultisampleState = (const VkPipelineMultisampleStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pMultisampleState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600749 '// DepthStencil State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600750 'pNonConst->pDepthStencilState = (const VkPipelineDepthStencilStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDepthStencilState);\n',
Courtney Goeltzenleuchter1c9f9892015-09-30 16:08:38 -0600751 '// DynamicState State\n',
752 'pNonConst->pDynamicState = (const VkPipelineDynamicStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState);\n',
753 'VkPipelineDynamicStateCreateInfo* pNonConstDyState = (VkPipelineDynamicStateCreateInfo*)pNonConst->pDynamicState;\n',
754 'if (pNonConstDyState) {\n',
755 ' pNonConstDyState->pDynamicStates = (const VkDynamicState*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState->pDynamicStates);\n',
756 '}\n',
757
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600758 '// ColorBuffer State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600759 'pNonConst->pColorBlendState = (const VkPipelineColorBlendStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pColorBlendState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600760 'VkPipelineColorBlendStateCreateInfo* pNonConstCbState = (VkPipelineColorBlendStateCreateInfo*)pNonConst->pColorBlendState;\n',
761 'if (pNonConstCbState)\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600762 ' pNonConstCbState->pAttachments = (const VkPipelineColorBlendAttachmentState*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pColorBlendState->pAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600763 '} else {\n',
764 ' // This is unexpected.\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600765 ' vktrace_LogError("CreateGraphicsPipelines must have CreateInfo stype of VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600766 ' pPacket->header = NULL;\n',
767 '}\n',
768 '}\n']
769 # TODO : This code is now too large and complex, need to make codegen smarter for pointers embedded in struct params to handle those cases automatically
770 # TODO138 : Just ripped out a bunch of custom code here that was out of date. Need to scrub these function and verify they're correct
Chia-I Wu062ad152015-10-31 00:31:16 +0800771 custom_case_dict = { #'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkFramebufferCreateInfo* pInfo = (VkFramebufferCreateInfo*)pPacket->pCreateInfo;\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600772 # 'pInfo->pColorAttachments = (VkColorAttachmentBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pColorAttachments);\n',
773 # 'pInfo->pDepthStencilAttachment = (VkDepthStencilBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pDepthStencilAttachment);\n']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600774 'CreateRenderPass' : {'param': 'pCreateInfo', 'txt': create_rp_interp},
775 'CreatePipelineLayout' : {'param': 'pCreateInfo', 'txt': ['VkPipelineLayoutCreateInfo* pInfo = (VkPipelineLayoutCreateInfo*)pPacket->pCreateInfo;\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600776 'pInfo->pSetLayouts = (VkDescriptorSetLayout*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pSetLayouts);\n']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600777 'CreateDescriptorPool' : {'param': 'pCreateInfo', 'txt': ['VkDescriptorPoolCreateInfo* pInfo = (VkDescriptorPoolCreateInfo*)pPacket->pCreateInfo;\n',
Chia-I Wuc51b1212015-10-27 19:25:11 +0800778 'pInfo->pPoolSizes = (VkDescriptorPoolSize*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pPoolSizes);\n']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800779 'CmdWaitEvents' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
780 'CmdPipelineBarrier' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600781 'CreateDescriptorSetLayout' : {'param': 'pCreateInfo', 'txt': ['if (pPacket->pCreateInfo->sType == VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO) {\n',
782 ' VkDescriptorSetLayoutCreateInfo* pNext = (VkDescriptorSetLayoutCreateInfo*)pPacket->pCreateInfo;\n',
783 ' do\n',' {\n',
784 ' // need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
785 ' void** ppNextVoidPtr = (void**)&(pNext->pNext);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600786 ' *ppNextVoidPtr = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600787 ' switch(pNext->sType)\n', ' {\n',
788 ' case VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO:\n',
789 ' {\n' ,
790 ' unsigned int i = 0;\n',
Chia-I Wuf03cbf72015-10-31 00:31:16 +0800791 ' pNext->pBinding = (VkDescriptorSetLayoutBinding*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBinding);\n',
Chia-I Wu763a7492015-10-26 20:48:51 +0800792 ' for (i = 0; i < pNext->bindingCount; i++)\n',' {\n',
Chia-I Wuf03cbf72015-10-31 00:31:16 +0800793 ' VkSampler** ppSamplers = (VkSampler**)&(pNext->pBinding[i].pImmutableSamplers);\n',
794 ' *ppSamplers = (VkSampler*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBinding[i].pImmutableSamplers);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600795 ' }\n',
796 ' break;\n',
797 ' }\n',
798 ' default:\n',
799 ' {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600800 ' vktrace_LogError("Encountered an unexpected type in descriptor set layout create list.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600801 ' pPacket->header = NULL;\n',
802 ' pNext->pNext = NULL;\n',
803 ' }\n',
804 ' }\n',
805 ' pNext = (VkDescriptorSetLayoutCreateInfo*)pNext->pNext;\n',
806 ' } while (NULL != pNext);\n',
807 '} else {\n',
808 ' // This is unexpected.\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600809 ' vktrace_LogError("CreateDescriptorSetLayout must have pCreateInfo->stype of VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600810 ' pPacket->header = NULL;\n',
811 '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800812# 'BeginCommandBuffer' : {'param': 'pBeginInfo', 'txt': ['if (pPacket->pBeginInfo->sType == VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO) {\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600813# ' // need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800814# ' VkCommandBufferGraphicsBeginInfo** ppNext = (VkCommandBufferGraphicsBeginInfo**)&(pPacket->pBeginInfo->pNext);\n',
815# ' *ppNext = (VkCommandBufferGraphicsBeginInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pBeginInfo->pNext);\n',
816# ' VkCommandBufferGraphicsBeginInfo* pNext = *ppNext;\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600817# ' while (NULL != pNext)\n', ' {\n',
818# ' switch(pNext->sType)\n', ' {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800819# ' case VK_STRUCTURE_TYPE_COMMAND_BUFFER_GRAPHICS_BEGIN_INFO:\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600820# ' {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800821# ' ppNext = (VkCommandBufferGraphicsBeginInfo**) &pNext->pNext;\n',
822# ' *ppNext = (VkCommandBufferGraphicsBeginInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600823# ' break;\n',
824# ' }\n',
825# ' default:\n',
826# ' {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600827# ' vktrace_LogError("Encountered an unexpected type in begin command buffer list.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600828# ' pPacket->header = NULL;\n',
829# ' pNext->pNext = NULL;\n',
830# ' }\n',
831# ' }\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800832# ' pNext = (VkCommandBufferGraphicsBeginInfo*)pNext->pNext;\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600833# ' }\n',
834# '} else {\n',
835# ' // This is unexpected.\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800836# ' vktrace_LogError("BeginCommandBuffer must have BeginInfo stype of VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600837# ' pPacket->header = NULL;\n',
838# '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800839 'AllocateMemory' : {'param': 'pAllocateInfo', 'txt': ['if (pPacket->pAllocateInfo->sType == VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO) {\n',
840 ' VkMemoryAllocateInfo** ppNext = (VkMemoryAllocateInfo**) &(pPacket->pAllocateInfo->pNext);\n',
841 ' *ppNext = (VkMemoryAllocateInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pAllocateInfo->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600842 '} else {\n',
843 ' // This is unexpected.\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800844 ' vktrace_LogError("AllocateMemory must have AllocInfo stype of VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600845 ' pPacket->header = NULL;\n',
846 '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800847 'AllocateDescriptorSets' : {'param': 'pAllocateInfo', 'txt':
848 ['VkDescriptorSetLayout **ppDescSetLayout = (VkDescriptorSetLayout **) &pPacket->pAllocateInfo->pSetLayouts;\n'
849 ' *ppDescSetLayout = (VkDescriptorSetLayout *) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pAllocateInfo->pSetLayouts));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600850 'UpdateDescriptorSets' : {'param': 'pDescriptorWrites', 'txt':
851 [ 'uint32_t i;\n',
Chia-I Wu483e7702015-10-26 17:20:32 +0800852 'for (i = 0; i < pPacket->descriptorWriteCount; i++) {\n',
Courtney Goeltzenleuchter34aa5c82015-10-23 13:38:14 -0600853 ' switch (pPacket->pDescriptorWrites[i].descriptorType) {',
854 ' case VK_DESCRIPTOR_TYPE_SAMPLER:',
855 ' case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:',
856 ' case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:',
857 ' case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:',
858 ' {',
859 ' VkDescriptorImageInfo** ppImageInfo = (VkDescriptorImageInfo**)&pPacket->pDescriptorWrites[i].pImageInfo;\n',
860 ' *ppImageInfo = (VkDescriptorImageInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pImageInfo);\n',
861 ' }',
862 ' break;',
863 ' case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:',
864 ' case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:',
865 ' {',
866 ' VkBufferView** ppTexelBufferView = (VkBufferView**)&pPacket->pDescriptorWrites[i].pTexelBufferView;\n',
867 ' *ppTexelBufferView = (VkBufferView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pTexelBufferView);\n',
868 ' }',
869 ' break;',
870 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:',
871 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:',
872 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:',
873 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:',
874 ' {',
875 ' VkDescriptorBufferInfo** ppBufferInfo = (VkDescriptorBufferInfo**)&pPacket->pDescriptorWrites[i].pBufferInfo;\n',
876 ' *ppBufferInfo = (VkDescriptorBufferInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pBufferInfo);\n',
877 ' }',
878 ' break;',
879 ' default:',
880 ' break;',
881 ' }',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600882 '}'
883 ]},
Chia-I Wu483e7702015-10-26 17:20:32 +0800884 'QueueSubmit' : {'param': 'pSubmits', 'txt':
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600885 [ 'uint32_t i;\n',
886 'for (i = 0; i < pPacket->submitCount; i++) {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800887 ' VkCommandBuffer** ppCBs = (VkCommandBuffer**)&pPacket->pSubmits[i].pCommandBuffers;\n',
888 ' *ppCBs = (VkCommandBuffer*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pCommandBuffers);\n',
Chia-I Wu483e7702015-10-26 17:20:32 +0800889 ' VkSemaphore** ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pWaitSemaphores;\n',
890 ' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pWaitSemaphores);\n',
891 ' ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pSignalSemaphores;\n',
892 ' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pSignalSemaphores);\n',
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600893 '}'
894 ]},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600895 'CreateGraphicsPipelines' : {'param': 'pCreateInfos', 'txt': create_gfx_pipe},
896 'CreateComputePipeline' : {'param': 'pCreateInfo', 'txt': ['interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)(&pPacket->pCreateInfo->cs));']},
Courtney Goeltzenleuchter1856d6f2015-09-01 17:30:39 -0600897 'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkImageView** ppAV = (VkImageView**)&(pPacket->pCreateInfo->pAttachments);\n',
898 '*ppAV = (VkImageView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pAttachments));']},
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600899 'CmdBeginRenderPass' : {'param': 'pRenderPassBegin', 'txt': ['VkClearValue** ppCV = (VkClearValue**)&(pPacket->pRenderPassBegin->pClearValues);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600900 '*ppCV = (VkClearValue*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pRenderPassBegin->pClearValues));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600901 'CreateShaderModule' : {'param': 'pCreateInfo', 'txt': ['void** ppCode = (void**)&(pPacket->pCreateInfo->pCode);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600902 '*ppCode = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pCode);']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600903 'FlushMappedMemoryRanges' : {'param': 'ppData', 'txt': ['uint32_t i = 0;\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800904 'for (i = 0; i < pPacket->memoryRangeCount; i++)\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600905 '{\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600906 ' pPacket->ppData[i] = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppData[i]);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600907 '}']}}
908 if_body = []
909 if_body.append('typedef struct packet_vkApiVersion {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600910 if_body.append(' vktrace_trace_packet_header* header;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600911 if_body.append(' uint32_t version;')
912 if_body.append('} packet_vkApiVersion;\n')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600913 if_body.append('static packet_vkApiVersion* interpret_body_as_vkApiVersion(vktrace_trace_packet_header* pHeader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600914 if_body.append('{')
915 if_body.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)pHeader->pBody;')
916 if_body.append(' pPacket->header = pHeader;')
917 if_body.append(' return pPacket;')
918 if_body.append('}\n')
919 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -0600920 if 'KHR' not in proto.name and 'Dbg' not in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600921 if 'UnmapMemory' == proto.name:
922 proto.params.append(vulkan.Param("void*", "pData"))
923 elif 'FlushMappedMemoryRanges' == proto.name:
924 proto.params.append(vulkan.Param("void**", "ppData"))
925 if_body.append('%s' % self.lineinfo.get())
926 if_body.append('typedef struct packet_vk%s {' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600927 if_body.append(' vktrace_trace_packet_header* header;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600928 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +0800929 if_body.append(' %s;' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600930 if 'void' != proto.ret:
931 if_body.append(' %s result;' % proto.ret)
932 if_body.append('} packet_vk%s;\n' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600933 if_body.append('static packet_vk%s* interpret_body_as_vk%s(vktrace_trace_packet_header* pHeader)' % (proto.name, proto.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600934 if_body.append('{')
935 if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
936 if_body.append(' pPacket->header = pHeader;')
937 for p in proto.params:
938 if '*' in p.ty:
939 if 'DeviceCreateInfo' in p.ty:
940 if_body.append(' pPacket->%s = interpret_VkDeviceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
941 elif 'InstanceCreateInfo' in p.ty:
942 if_body.append(' pPacket->%s = interpret_VkInstanceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
943 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600944 if_body.append(' pPacket->%s = (%s)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.ty, p.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600945 # TODO : Generalize this custom code to kill dict data struct above.
946 # Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
947 if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
948 if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
949 if_body.append(' {')
950 if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
951 if_body.append(' }')
952 if_body.append(' return pPacket;')
953 if_body.append('}\n')
954 return "\n".join(if_body)
955
Chia-I Wu1f851912015-10-27 18:04:07 +0800956 def _generate_interp_funcs_ext(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600957 if_body = []
Ian Elliott338dedb2015-08-21 15:09:33 -0600958 custom_case_dict = { 'QueuePresentKHR' : {'param': 'pPresentInfo', 'txt': ['pPacket->pPresentInfo->swapchains = (VkSwapchainKHR*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->swapchains));\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600959 'pPacket->pPresentInfo->imageIndices = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->imageIndices));']},
Ian Elliott338dedb2015-08-21 15:09:33 -0600960 'CreateSwapchainKHR' : {'param': 'pCreateInfo', 'txt': ['VkSurfaceDescriptionKHR **ppSurfDescp = (VkSurfaceDescriptionKHR**)&pPacket->pCreateInfo->pSurfaceDescription;\n',
Jon Ashburnc51afc72015-08-11 16:01:35 -0600961 'uint32_t **ppQFI = (uint32_t**)&pPacket->pCreateInfo->pQueueFamilyIndices;\n',
Ian Elliott338dedb2015-08-21 15:09:33 -0600962 '(*ppSurfDescp) = (VkSurfaceDescriptionKHR*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pSurfaceDescription));\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600963 '(*ppQFI) = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pQueueFamilyIndices));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600964 }
Jon Ashburncb622a12015-08-06 17:22:53 -0600965 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800966 if ext.name.lower() == extensionName.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600967 for proto in ext.protos:
968 if_body.append('typedef struct packet_vk%s {' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600969 if_body.append(' vktrace_trace_packet_header* pHeader;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600970 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +0800971 if_body.append(' %s;' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600972 if 'void' != proto.ret:
973 if_body.append(' %s result;' % proto.ret)
974 if_body.append('} packet_vk%s;\n' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600975 if_body.append('static packet_vk%s* interpret_body_as_vk%s(vktrace_trace_packet_header* pHeader)' % (proto.name, proto.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600976 if_body.append('{')
977 if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
978 if_body.append(' pPacket->pHeader = pHeader;')
979 for p in proto.params:
980 if '*' in p.ty:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600981 if_body.append(' pPacket->%s = (%s)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.ty, p.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600982 # TODO : Generalize this custom code to kill dict data struct above.
983 # Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
984 if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
985 if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
986 if_body.append(' {')
987 if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
988 if_body.append(' }')
989 if_body.append(' return pPacket;')
990 if_body.append('}\n')
991 return "\n".join(if_body)
992
993 def _generate_replay_func_ptrs(self):
994 xf_body = []
995 xf_body.append('struct vkFuncs {')
996 xf_body.append(' void init_funcs(void * libHandle);')
997 xf_body.append(' void *m_libHandle;\n')
998 for proto in self.protos:
999 xf_body.append(' typedef %s( VKAPI * type_vk%s)(' % (proto.ret, proto.name))
1000 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +08001001 xf_body.append(' %s,' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001002 xf_body[-1] = xf_body[-1].replace(',', ');')
1003 xf_body.append(' type_vk%s real_vk%s;' % (proto.name, proto.name))
1004 xf_body.append('};')
1005 return "\n".join(xf_body)
1006
1007 def _map_decl(self, type1, type2, name):
1008 return ' std::map<%s, %s> %s;' % (type1, type2, name)
1009
1010 def _add_to_map_decl(self, type1, type2, name):
1011 txt = ' void add_to_%s_map(%s pTraceVal, %s pReplayVal)\n {\n' % (name[2:], type1, type2)
1012 #TODO138 : These checks need to vary between disp & non-disp objects
1013 #txt += ' assert(pTraceVal != 0);\n'
1014 #txt += ' assert(pReplayVal != 0);\n'
1015 txt += ' %s[pTraceVal] = pReplayVal;\n }\n' % name
1016 return txt
1017
1018 def _rm_from_map_decl(self, ty, name):
1019 txt = ' void rm_from_%s_map(const %s& key)\n {\n' % (name[2:], ty)
1020 txt += ' %s.erase(key);\n }\n' % name
1021 return txt
1022
1023 def _remap_decl(self, ty, name):
1024 txt = ' %s remap_%s(const %s& value)\n {\n' % (ty, name[2:], ty)
1025 txt += ' if (value == 0) { return 0; }\n'
1026 txt += ' std::map<%s, %s>::const_iterator q = %s.find(value);\n' % (ty, ty, name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001027 txt += ' if (q == %s.end()) { vktrace_LogError("Failed to remap %s."); return value; }\n' % (name, ty)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001028 txt += ' return q->second;\n }\n'
1029 return txt
1030
1031 def _generate_replay_objMemory_funcs(self):
1032 rof_body = []
1033 # Custom code for memory mapping functions for app writes into mapped memory
1034 rof_body.append('// memory mapping functions for app writes into mapped memory')
1035 rof_body.append(' bool isPendingAlloc()')
1036 rof_body.append(' {')
1037 rof_body.append(' return m_pendingAlloc;')
1038 rof_body.append(' }')
1039 rof_body.append('')
Chia-I Wu1f851912015-10-27 18:04:07 +08001040 rof_body.append(' void setAllocInfo(const VkMemoryAllocateInfo *info, const bool pending)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001041 rof_body.append(' {')
1042 rof_body.append(' m_pendingAlloc = pending;')
1043 rof_body.append(' m_allocInfo = *info;')
1044 rof_body.append(' }')
1045 rof_body.append('')
1046 rof_body.append(' void setMemoryDataAddr(void *pBuf)')
1047 rof_body.append(' {')
1048 rof_body.append(' if (m_mapRange.empty())')
1049 rof_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001050 rof_body.append(' vktrace_LogError("gpuMemory::setMemoryDataAddr() m_mapRange is empty.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001051 rof_body.append(' return;')
1052 rof_body.append(' }')
1053 rof_body.append(' MapRange mr = m_mapRange.back();')
1054 rof_body.append(' if (mr.pData != NULL)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001055 rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() data already mapped overwrite old mapping.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001056 rof_body.append(' else if (pBuf == NULL)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001057 rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() adding NULL pointer.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001058 rof_body.append(' mr.pData = (uint8_t *) pBuf;')
1059 rof_body.append(' }')
1060 rof_body.append('')
1061 rof_body.append(' void setMemoryMapRange(void *pBuf, const size_t size, const size_t offset, const bool pending)')
1062 rof_body.append(' {')
1063 rof_body.append(' MapRange mr;')
1064 rof_body.append(' mr.pData = (uint8_t *) pBuf;')
1065 rof_body.append(' if (size == 0)')
1066 rof_body.append(' mr.size = m_allocInfo.allocationSize - offset;')
1067 rof_body.append(' else')
1068 rof_body.append(' mr.size = size;')
1069 rof_body.append(' mr.offset = offset;')
1070 rof_body.append(' mr.pending = pending;')
1071 rof_body.append(' m_mapRange.push_back(mr);')
1072 rof_body.append(' assert(m_allocInfo.allocationSize >= (size + offset));')
1073 rof_body.append(' }')
1074 rof_body.append('')
1075 rof_body.append(' void copyMappingData(const void* pSrcData, bool entire_map, size_t size, size_t offset)')
1076 rof_body.append(' {')
1077 rof_body.append(' if (m_mapRange.empty())')
1078 rof_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001079 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() m_mapRange is empty.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001080 rof_body.append(' return;')
1081 rof_body.append(' }')
1082 rof_body.append(' MapRange mr = m_mapRange.back();')
1083 rof_body.append(' if (!pSrcData || !mr.pData)')
1084 rof_body.append(' {')
1085 rof_body.append(' if (!pSrcData)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001086 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null src pointer.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001087 rof_body.append(' else')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001088 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null dest pointer totalSize=%u.", m_allocInfo.allocationSize);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001089 rof_body.append(' m_mapRange.pop_back();')
1090 rof_body.append(' return;')
1091 rof_body.append(' }')
1092 rof_body.append(' if (entire_map)')
1093 rof_body.append(' {')
1094 rof_body.append(' size = mr.size;')
1095 rof_body.append(' offset = mr.offset;')
1096 rof_body.append(' }')
1097 rof_body.append(' else')
1098 rof_body.append(' {')
1099 rof_body.append(' assert(offset >= mr.offset);')
1100 rof_body.append(' assert(size <= mr.size && (size + offset) <= mr.size);')
1101 rof_body.append(' }')
1102 rof_body.append(' memcpy(mr.pData + offset, pSrcData, size);')
1103 rof_body.append(' if (!mr.pending && entire_map)')
1104 rof_body.append(' m_mapRange.pop_back();')
1105 rof_body.append(' }')
1106 rof_body.append('')
1107 rof_body.append(' size_t getMemoryMapSize()')
1108 rof_body.append(' {')
1109 rof_body.append(' return (!m_mapRange.empty()) ? m_mapRange.back().size : 0;')
1110 rof_body.append(' }\n')
1111 return "\n".join(rof_body)
1112
1113 def _generate_replay_objmapper_class(self):
1114 # Create dict mapping member var names to VK type (i.e. 'm_imageViews' : 'VkImage_VIEW')
1115 obj_map_dict = {}
1116 for obj in vulkan.object_type_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001117 if (obj.startswith('Vk')):
1118 mem_var = obj.replace('Vk', '').lower()
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001119 mem_var_list = mem_var.split('_')
1120 mem_var = 'm_%s%ss' % (mem_var_list[0], "".join([m.title() for m in mem_var_list[1:]]))
Jon Ashburncb622a12015-08-06 17:22:53 -06001121 obj_map_dict[mem_var] = obj
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001122 rc_body = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001123 rc_body.append('#define VKTRACE_VK_OBJECT_TYPE_UNKNOWN (VkObjectType)-1')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001124 rc_body.append('')
1125 rc_body.append('typedef struct _VKAllocInfo {')
1126 rc_body.append(' VkDeviceSize size;')
1127 rc_body.append(' uint8_t *pData;')
1128 rc_body.append(' bool rangeUpdated;')
1129 rc_body.append('} VKAllocInfo;')
1130 rc_body.append('')
1131 rc_body.append('class objMemory {')
1132 rc_body.append('public:')
1133 rc_body.append(' objMemory() : m_numAllocations(0), m_pMemReqs(NULL) {}')
1134 rc_body.append(' ~objMemory() { free(m_pMemReqs);}')
1135 rc_body.append(' void setCount(const uint32_t num)')
1136 rc_body.append(' {')
1137 rc_body.append(' m_numAllocations = num;')
1138 rc_body.append(' }\n')
1139 rc_body.append(' void setReqs(const VkMemoryRequirements *pReqs, const uint32_t num)')
1140 rc_body.append(' {')
1141 rc_body.append(' if (m_numAllocations != num && m_numAllocations != 0)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001142 rc_body.append(' vktrace_LogError("objMemory::setReqs, internal mismatch on number of allocations.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001143 rc_body.append(' if (m_pMemReqs == NULL && pReqs != NULL)')
1144 rc_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001145 rc_body.append(' m_pMemReqs = (VkMemoryRequirements *) vktrace_malloc(num * sizeof(VkMemoryRequirements));')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001146 rc_body.append(' if (m_pMemReqs == NULL)')
1147 rc_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001148 rc_body.append(' vktrace_LogError("objMemory::setReqs out of memory.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001149 rc_body.append(' return;')
1150 rc_body.append(' }')
1151 rc_body.append(' memcpy(m_pMemReqs, pReqs, num * sizeof(VkMemoryRequirements));')
1152 rc_body.append(' }')
1153 rc_body.append(' }\n')
1154 rc_body.append('private:')
1155 rc_body.append(' uint32_t m_numAllocations;')
1156 rc_body.append(' VkMemoryRequirements *m_pMemReqs;')
1157 rc_body.append('};')
1158 rc_body.append('')
1159 rc_body.append('class gpuMemory {')
1160 rc_body.append('public:')
1161 rc_body.append(' gpuMemory() : m_pendingAlloc(false) {m_allocInfo.allocationSize = 0;}')
1162 rc_body.append(' ~gpuMemory() {}')
1163 rc_body.append(self._generate_replay_objMemory_funcs())
1164 rc_body.append('private:')
1165 rc_body.append(' bool m_pendingAlloc;')
1166 rc_body.append(' struct MapRange {')
1167 rc_body.append(' bool pending;')
1168 rc_body.append(' size_t size;')
1169 rc_body.append(' size_t offset;')
1170 rc_body.append(' uint8_t* pData;')
1171 rc_body.append(' };')
1172 rc_body.append(' std::vector<MapRange> m_mapRange;')
Chia-I Wu1f851912015-10-27 18:04:07 +08001173 rc_body.append(' VkMemoryAllocateInfo m_allocInfo;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001174 rc_body.append('};')
1175 rc_body.append('')
1176 rc_body.append('typedef struct _imageObj {')
1177 rc_body.append(' objMemory imageMem;')
1178 rc_body.append(' VkImage replayImage;')
1179 rc_body.append(' } imageObj;')
1180 rc_body.append('')
1181 rc_body.append('typedef struct _bufferObj {')
1182 rc_body.append(' objMemory bufferMem;')
1183 rc_body.append(' VkBuffer replayBuffer;')
1184 rc_body.append(' } bufferObj;')
1185 rc_body.append('')
1186 rc_body.append('typedef struct _gpuMemObj {')
1187 rc_body.append(' gpuMemory *pGpuMem;')
1188 rc_body.append(' VkDeviceMemory replayGpuMem;')
1189 rc_body.append(' } gpuMemObj;')
1190 rc_body.append('')
1191 rc_body.append('')
1192 rc_body.append('class vkReplayObjMapper {')
1193 rc_body.append('public:')
1194 rc_body.append(' vkReplayObjMapper() {}')
1195 rc_body.append(' ~vkReplayObjMapper() {}')
1196 rc_body.append('')
1197 rc_body.append(' bool m_adjustForGPU; // true if replay adjusts behavior based on GPU')
1198 # Code for memory objects for handling replay GPU != trace GPU object memory requirements
1199 rc_body.append('void init_objMemCount(const uint64_t handle, const VkDbgObjectType objectType, const uint32_t &num)\n {')
1200 rc_body.append(' switch (objectType) {')
1201 rc_body.append(' case VK_OBJECT_TYPE_BUFFER:')
1202 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001203 rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001204 rc_body.append(' if (it != m_buffers.end()) {')
1205 rc_body.append(' objMemory obj = it->second.bufferMem;')
1206 rc_body.append(' obj.setCount(num);')
1207 rc_body.append(' return;')
1208 rc_body.append(' }')
1209 rc_body.append(' break;')
1210 rc_body.append(' }')
1211 rc_body.append(' case VK_OBJECT_TYPE_IMAGE:')
1212 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001213 rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001214 rc_body.append(' if (it != m_images.end()) {')
1215 rc_body.append(' objMemory obj = it->second.imageMem;')
1216 rc_body.append(' obj.setCount(num);')
1217 rc_body.append(' return;')
1218 rc_body.append(' }')
1219 rc_body.append(' break;')
1220 rc_body.append(' }')
1221 rc_body.append(' default:')
1222 rc_body.append(' break;')
1223 rc_body.append(' }')
1224 rc_body.append(' return;')
1225 rc_body.append('}\n')
1226 rc_body.append('void init_objMemReqs(const uint64_t handle, const VkDbgObjectType objectType, const VkMemoryRequirements *pMemReqs, const unsigned int num)\n {')
1227 rc_body.append(' switch (objectType) {')
1228 rc_body.append(' case VK_OBJECT_TYPE_BUFFER:')
1229 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001230 rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001231 rc_body.append(' if (it != m_buffers.end()) {')
1232 rc_body.append(' objMemory obj = it->second.bufferMem;')
1233 rc_body.append(' obj.setReqs(pMemReqs, num);')
1234 rc_body.append(' return;')
1235 rc_body.append(' }')
1236 rc_body.append(' break;')
1237 rc_body.append(' }')
1238 rc_body.append(' case VK_OBJECT_TYPE_IMAGE:')
1239 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001240 rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001241 rc_body.append(' if (it != m_images.end()) {')
1242 rc_body.append(' objMemory obj = it->second.imageMem;')
1243 rc_body.append(' obj.setReqs(pMemReqs, num);')
1244 rc_body.append(' return;')
1245 rc_body.append(' }')
1246 rc_body.append(' break;')
1247 rc_body.append(' }')
1248 rc_body.append(' default:')
1249 rc_body.append(' break;')
1250 rc_body.append(' }')
1251 rc_body.append(' return;')
1252 rc_body.append(' }')
1253 rc_body.append('')
1254 rc_body.append(' void clear_all_map_handles()\n {')
1255 for var in sorted(obj_map_dict):
1256 rc_body.append(' %s.clear();' % var)
1257 rc_body.append(' }\n')
Jon Ashburncb622a12015-08-06 17:22:53 -06001258 disp_obj_types = [obj for obj in vulkan.object_dispatch_list]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001259 for var in sorted(obj_map_dict):
Chia-I Wue420a332015-10-26 20:04:44 +08001260 if obj_map_dict[var] == 'VkImage':
1261 rc_body.append(self._map_decl('VkImage', 'imageObj', var))
1262 rc_body.append(self._add_to_map_decl('VkImage', 'imageObj', var))
1263 rc_body.append(self._rm_from_map_decl('VkImage', var))
1264 rc_body.append(' VkImage remap_images(const VkImage& value)')
1265 rc_body.append(' {')
1266 rc_body.append(' if (value == 0) { return 0; }')
1267 rc_body.append('')
1268 rc_body.append(' std::map<VkImage, imageObj>::const_iterator q = m_images.find(value);')
1269 rc_body.append(' if (q == m_images.end()) { vktrace_LogError("Failed to remap VkImage."); return value; }\n')
1270 rc_body.append(' return q->second.replayImage;')
1271 rc_body.append(' }\n')
1272 elif obj_map_dict[var] == 'VkBuffer':
1273 rc_body.append(self._map_decl('VkBuffer', 'bufferObj', var))
1274 rc_body.append(self._add_to_map_decl('VkBuffer', 'bufferObj', var))
1275 rc_body.append(self._rm_from_map_decl('VkBuffer', var))
1276 rc_body.append(' VkBuffer remap_buffers(const VkBuffer& value)')
1277 rc_body.append(' {')
1278 rc_body.append(' if (value == 0) { return 0; }')
1279 rc_body.append('')
1280 rc_body.append(' std::map<VkBuffer, bufferObj>::const_iterator q = m_buffers.find(value);')
1281 rc_body.append(' if (q == m_buffers.end()) { vktrace_LogError("Failed to remap VkBuffer."); return value; }\n')
1282 rc_body.append(' return q->second.replayBuffer;')
1283 rc_body.append(' }\n')
1284 elif obj_map_dict[var] == 'VkDeviceMemory':
1285 rc_body.append(self._map_decl('VkDeviceMemory', 'gpuMemObj', var))
1286 rc_body.append(self._add_to_map_decl('VkDeviceMemory', 'gpuMemObj', var))
1287 rc_body.append(self._rm_from_map_decl('VkDeviceMemory', var))
1288 rc_body.append(' VkDeviceMemory remap_devicememorys(const VkDeviceMemory& value)')
1289 rc_body.append(' {')
1290 rc_body.append(' if (value == 0) { return 0; }')
1291 rc_body.append('')
1292 rc_body.append(' std::map<VkDeviceMemory, gpuMemObj>::const_iterator q = m_devicememorys.find(value);')
1293 rc_body.append(' if (q == m_devicememorys.end()) { vktrace_LogError("Failed to remap VkDeviceMemory."); return value; }')
1294 rc_body.append(' return q->second.replayGpuMem;')
1295 rc_body.append(' }\n')
1296 else:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001297 rc_body.append(self._map_decl(obj_map_dict[var], obj_map_dict[var], var))
1298 rc_body.append(self._add_to_map_decl(obj_map_dict[var], obj_map_dict[var], var))
1299 rc_body.append(self._rm_from_map_decl(obj_map_dict[var], var))
1300 rc_body.append(self._remap_decl(obj_map_dict[var], var))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001301 # VkDynamicStateObject code
1302# TODO138 : Each dynamic state object is now unique so need to make sure their re-mapping is being handled correctly
1303# state_obj_remap_types = vulkan.object_dynamic_state_list
1304# state_obj_bindings = vulkan.object_dynamic_state_bind_point_list
1305# rc_body.append(' VkDynamicStateObject remap(const VkDynamicStateObject& state, const VkStateBindPoint& bindPoint)\n {')
1306# rc_body.append(' VkDynamicStateObject obj;')
1307# index = 0
1308# while index < len(state_obj_remap_types):
1309# obj = state_obj_remap_types[index]
1310# type = state_obj_bindings[index]
1311# rc_body.append(' if (bindPoint == %s) {' % type)
1312# rc_body.append(' if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
1313# rc_body.append(' return obj;')
1314# rc_body.append(' }')
1315# index += 1
1316# for obj in state_obj_remap_types:
1317# rc_body.append('// if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
1318# rc_body.append('// return obj;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001319# rc_body.append(' vktrace_LogWarning("Failed to remap VkDynamicStateObject.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001320# rc_body.append(' return VK_NULL_HANDLE;\n }')
1321# rc_body.append(' void rm_from_map(const VkDynamicStateObject& state)\n {')
1322# for obj in state_obj_remap_types:
1323# rc_body.append(' rm_from_map(static_cast <%s> (state));' % obj.type)
1324# rc_body.append(' }')
1325# rc_body.append('')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001326 rc_body.append('};')
1327 return "\n".join(rc_body)
1328
1329 def _generate_replay_init_funcs(self):
1330 rif_body = []
1331 rif_body.append('void vkFuncs::init_funcs(void * handle)\n{\n m_libHandle = handle;')
1332 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001333 if 'KHR' not in proto.name and 'Dbg' not in proto.name:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001334 rif_body.append(' real_vk%s = (type_vk%s)(vktrace_platform_get_library_entrypoint(handle, "vk%s"));' % (proto.name, proto.name, proto.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001335 else: # These func ptrs get assigned at GetProcAddr time
1336 rif_body.append(' real_vk%s = (type_vk%s)NULL;' % (proto.name, proto.name))
1337 rif_body.append('}')
1338 return "\n".join(rif_body)
1339
Jon Ashburnc736c002015-10-25 20:24:57 -06001340 def _remap_packet_param(self, funcName, paramType, paramName, lastName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001341 remap_list = vulkan.object_type_list
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001342 param_exclude_list = ['pDescriptorSets', 'pFences']
1343 cleanParamType = paramType.strip('*').replace('const ', '')
Jon Ashburncb622a12015-08-06 17:22:53 -06001344 VulkNonDispObjects = [o for o in vulkan.object_non_dispatch_list]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001345 for obj in remap_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001346 if obj == cleanParamType and paramName not in param_exclude_list:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001347 objectTypeRemapParam = ''
1348 if 'VkDynamicStateObject' == cleanParamType:
1349 objectTypeRemapParam = ', pPacket->stateBindPoint'
1350 elif 'object' == paramName:
1351 if 'DbgSetObjectTag' == funcName:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001352 objectTypeRemapParam = ', VKTRACE_VK_OBJECT_TYPE_UNKNOWN'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001353 else:
1354 objectTypeRemapParam = ', pPacket->objType'
1355 elif 'srcObject' == paramName and 'Callback' in funcName:
1356 objectTypeRemapParam = ', pPacket->objType'
Jon Ashburnc736c002015-10-25 20:24:57 -06001357 pArray = ''
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001358 if '*' in paramType:
Jon Ashburnc736c002015-10-25 20:24:57 -06001359 if 'const' not in paramType:
1360 result = ' %s remapped%s = m_objMapper.remap_%ss(*pPacket->%s%s);\n' % (cleanParamType, paramName, paramName.lower(), paramName, objectTypeRemapParam)
1361 result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
1362 result += ' {\n'
1363 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1364 result += ' }\n'
1365 return result
1366 else:
1367 if lastName == '':
1368 return ' // pPacket->%s should have been remapped with special case code' % (paramName)
1369 pArray = '[pPacket->%s]' % lastName
Courtney Goeltzenleuchter5970b252015-10-27 11:32:31 -06001370 result = ' %s *remapped%s = new %s%s;\n' % (cleanParamType, paramName, cleanParamType, pArray)
Jon Ashburnc736c002015-10-25 20:24:57 -06001371 result += '%s\n' % self.lineinfo.get()
1372 result += ' for (uint32_t i = 0; i < pPacket->%s; i++) {\n' % lastName
Chia-I Wue420a332015-10-26 20:04:44 +08001373 result += ' remapped%s[i] = m_objMapper.remap_%ss(pPacket->%s[i]%s);\n' % (paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
1374 result += ' if (pPacket->%s[i] != VK_NULL_HANDLE && remapped%s[i] == VK_NULL_HANDLE)\n' % (paramName, paramName)
Jon Ashburnc736c002015-10-25 20:24:57 -06001375 result += ' {\n'
1376 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1377 result += ' }\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001378 result += ' }\n'
1379 return result
Jon Ashburnc736c002015-10-25 20:24:57 -06001380
Chia-I Wue420a332015-10-26 20:04:44 +08001381 result = ' %s remapped%s = m_objMapper.remap_%ss(pPacket->%s%s);\n' % (paramType, paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
1382 result += '%s\n' % self.lineinfo.get()
1383 result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
1384 result += ' {\n'
1385 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1386 result += ' }\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001387 return result
1388 return ' // No need to remap %s' % (paramName)
1389
1390 def _get_packet_param(self, funcName, paramType, paramName):
1391 # list of types that require remapping
1392 remap_list = vulkan.object_type_list
1393 param_exclude_list = ['pDescriptorSets', 'pFences']
1394 cleanParamType = paramType.strip('*').replace('const ', '')
1395 for obj in remap_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001396 if obj == cleanParamType and paramName not in param_exclude_list:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001397 objectTypeRemapParam = ''
1398 if 'object' == paramName:
1399 if 'DbgSetObjectTag' == funcName:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001400 objectTypeRemapParam = ', VKTRACE_VK_OBJECT_TYPE_UNKNOWN'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001401 else:
1402 objectTypeRemapParam = ', pPacket->objType'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001403 return 'remapped%s' % (paramName)
1404 return 'pPacket->%s' % (paramName)
1405
1406 def _gen_replay_create_image(self):
1407 ci_body = []
1408 ci_body.append(' imageObj local_imageObj;')
1409 ci_body.append(' VkDevice remappedDevice = m_objMapper.remap_devices(pPacket->device);')
1410 ci_body.append(' if (remappedDevice == VK_NULL_HANDLE)')
1411 ci_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001412 ci_body.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001413 ci_body.append(' }')
Chia-I Wu69f40122015-10-26 21:10:41 +08001414 ci_body.append(' replayResult = m_vkFuncs.real_vkCreateImage(remappedDevice, pPacket->pCreateInfo, NULL, &local_imageObj.replayImage);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001415 ci_body.append(' if (replayResult == VK_SUCCESS)')
1416 ci_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001417 ci_body.append(' m_objMapper.add_to_images_map(*(pPacket->pImage), local_imageObj);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001418 ci_body.append(' }')
1419 return "\n".join(ci_body)
1420
1421 def _gen_replay_create_buffer(self):
1422 cb_body = []
1423 cb_body.append(' bufferObj local_bufferObj;')
1424 cb_body.append(' VkDevice remappedDevice = m_objMapper.remap_devices(pPacket->device);')
1425 cb_body.append(' if (remappedDevice == VK_NULL_HANDLE)')
1426 cb_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001427 cb_body.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001428 cb_body.append(' }')
Chia-I Wu69f40122015-10-26 21:10:41 +08001429 cb_body.append(' replayResult = m_vkFuncs.real_vkCreateBuffer(remappedDevice, pPacket->pCreateInfo, NULL, &local_bufferObj.replayBuffer);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001430 cb_body.append(' if (replayResult == VK_SUCCESS)')
1431 cb_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001432 cb_body.append(' m_objMapper.add_to_buffers_map(*(pPacket->pBuffer), local_bufferObj);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001433 cb_body.append(' }')
1434 return "\n".join(cb_body)
1435
1436 # Generate main replay case statements where actual replay API call is dispatched based on input packet data
1437 def _generate_replay(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001438 manually_replay_funcs = ['AllocateMemory',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001439 'BeginCommandBuffer',
1440 'CreateDescriptorSetLayout',
1441 'CreateDevice',
1442 'CreateFramebuffer',
1443 'CreateGraphicsPipelines',
1444 'CreateInstance',
1445 'CreatePipelineLayout',
1446 'CreateRenderPass',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001447 'CmdBeginRenderPass',
1448 'CmdBindDescriptorSets',
1449 'CmdBindVertexBuffers',
1450 'CmdPipelineBarrier',
Ian Elliott338dedb2015-08-21 15:09:33 -06001451 'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001452 'CmdWaitEvents',
1453 #'DestroyObject',
1454 'EnumeratePhysicalDevices',
1455 'FreeMemory',
1456 'FreeDescriptorSets',
1457 'FlushMappedMemoryRanges',
1458 #'GetGlobalExtensionInfo',
1459 #'GetImageSubresourceInfo',
1460 #'GetObjectInfo',
1461 #'GetPhysicalDeviceExtensionInfo',
Ian Elliott338dedb2015-08-21 15:09:33 -06001462 'GetPhysicalDeviceSurfaceSupportKHR',
1463 'GetSurfacePropertiesKHR',
1464 'GetSurfaceFormatsKHR',
1465 'GetSurfacePresentModesKHR',
1466 'CreateSwapchainKHR',
1467 'GetSwapchainImagesKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001468 #'GetPhysicalDeviceInfo',
1469 'MapMemory',
Ian Elliott338dedb2015-08-21 15:09:33 -06001470 #'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001471 'QueueSubmit',
1472 #'StorePipeline',
1473 'UnmapMemory',
1474 'UpdateDescriptorSets',
1475 'WaitForFences',
Jon Ashburncaae0492015-08-13 16:49:08 -06001476 'DbgCreateMsgCallback',
1477 'DbgDestroyMsgCallback',
Chia-I Wu1f851912015-10-27 18:04:07 +08001478 'AllocateCommandBuffers',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001479 ]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001480
1481 # validate the manually_replay_funcs list
1482 protoFuncs = [proto.name for proto in self.protos]
1483 for func in manually_replay_funcs:
1484 if func not in protoFuncs:
1485 sys.exit("Entry '%s' in manually_replay_funcs list is not in the vulkan function prototypes" % func)
1486
1487 # map protos to custom functions if body is fully custom
1488 custom_body_dict = {'CreateImage': self._gen_replay_create_image,
1489 'CreateBuffer': self._gen_replay_create_buffer }
1490 # multi-gpu Open funcs w/ list of local params to create
1491 custom_open_params = {'OpenSharedMemory': (-1,),
1492 'OpenSharedSemaphore': (-1,),
1493 'OpenPeerMemory': (-1,),
1494 'OpenPeerImage': (-1, -2,)}
1495 # Functions that create views are unique from other create functions
Courtney Goeltzenleuchter1856d6f2015-09-01 17:30:39 -06001496 create_view_list = ['CreateBufferView', 'CreateImageView', 'CreateComputePipeline']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001497 # Functions to treat as "Create' that don't have 'Create' in the name
Chia-I Wu1f851912015-10-27 18:04:07 +08001498 special_create_list = ['LoadPipeline', 'LoadPipelineDerivative', 'AllocateMemory', 'GetDeviceQueue', 'PinSystemMemory', 'AllocateDescriptorSets']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001499 # A couple funcs use do while loops
1500 do_while_dict = {'GetFenceStatus': 'replayResult != pPacket->result && pPacket->result == VK_SUCCESS', 'GetEventStatus': '(pPacket->result == VK_EVENT_SET || pPacket->result == VK_EVENT_RESET) && replayResult != pPacket->result'}
1501 rbody = []
1502 rbody.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001503 rbody.append('vktrace_replay::VKTRACE_REPLAY_RESULT vkReplay::replay(vktrace_trace_packet_header *packet)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001504 rbody.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001505 rbody.append(' vktrace_replay::VKTRACE_REPLAY_RESULT returnValue = vktrace_replay::VKTRACE_REPLAY_SUCCESS;')
Courtney Goeltzenleuchterac544f32015-09-14 18:01:17 -06001506 rbody.append(' VkResult replayResult = VK_ERROR_VALIDATION_FAILED;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001507 rbody.append(' switch (packet->packet_id)')
1508 rbody.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001509 rbody.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001510 rbody.append(' {')
1511 rbody.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)(packet->pBody);')
1512 rbody.append(' if (pPacket->version != VK_API_VERSION)')
1513 rbody.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001514 rbody.append(' vktrace_LogError("Trace file is from Vulkan version 0x%x (%u.%u.%u), but the vktrace plugin only supports version 0x%x (%u.%u.%u).", pPacket->version, (pPacket->version & 0xFFC00000) >> 22, (pPacket->version & 0x003FF000) >> 12, (pPacket->version & 0x00000FFF), VK_API_VERSION, (VK_API_VERSION & 0xFFC00000) >> 22, (VK_API_VERSION & 0x003FF000) >> 12, (VK_API_VERSION & 0x00000FFF));')
1515 rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001516 rbody.append(' }')
1517 rbody.append(' break;')
1518 rbody.append(' }')
1519 for proto in self.protos:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001520 ret_value = False
1521 create_view = False
1522 create_func = False
1523 # TODO : How to handle void* return of GetProcAddr?
Jon Ashburnd7770ed2015-09-30 13:41:02 -06001524#TODO make sure vkDestroy object functions really do clean up the object maps
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001525 if ('void' not in proto.ret.lower()) and ('size_t' not in proto.ret) and (proto.name not in custom_body_dict):
1526 ret_value = True
1527 if proto.name in create_view_list:
1528 create_view = True
1529 elif 'Create' in proto.name or proto.name in special_create_list:
1530 create_func = True
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001531 rbody.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001532 rbody.append(' {')
1533 rbody.append(' packet_vk%s* pPacket = (packet_vk%s*)(packet->pBody);' % (proto.name, proto.name))
1534 if proto.name in manually_replay_funcs:
1535 if ret_value == True:
1536 rbody.append(' replayResult = manually_replay_vk%s(pPacket);' % proto.name)
1537 else:
1538 rbody.append(' manually_replay_vk%s(pPacket);' % proto.name)
1539 elif proto.name in custom_body_dict:
1540 rbody.append(custom_body_dict[proto.name]())
1541 else:
1542 if proto.name in custom_open_params:
1543 for pidx in custom_open_params[proto.name]:
1544 rbody.append(' %s local_%s;' % (proto.params[pidx].ty.replace('const ', '').strip('*'), proto.params[pidx].name))
1545 elif create_view:
1546 rbody.append(' %s createInfo;' % (proto.params[1].ty.strip('*').replace('const ', '')))
1547 rbody.append(' memcpy(&createInfo, pPacket->pCreateInfo, sizeof(%s));' % (proto.params[1].ty.strip('*').replace('const ', '')))
1548 if 'CreateComputePipeline' == proto.name:
Chia-I Wue420a332015-10-26 20:04:44 +08001549 rbody.append(' createInfo.cs.shader = m_objMapper.remap_shaders(pPacket->pCreateInfo->cs.shader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001550 elif 'CreateBufferView' == proto.name:
Chia-I Wue420a332015-10-26 20:04:44 +08001551 rbody.append(' createInfo.buffer = m_objMapper.remap_buffers(pPacket->pCreateInfo->buffer);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001552 else:
Chia-I Wue420a332015-10-26 20:04:44 +08001553 rbody.append(' createInfo.image = m_objMapper.remap_images(pPacket->pCreateInfo->image);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001554 rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
1555 elif create_func: # Declare local var to store created handle into
Chia-I Wu1f851912015-10-27 18:04:07 +08001556 if 'AllocateDescriptorSets' == proto.name:
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001557 p_ty = proto.params[-1].ty.strip('*').replace('const ', '')
Chia-I Wu1f851912015-10-27 18:04:07 +08001558 rbody.append(' %s* local_%s = (%s*)malloc(pPacket->pAllocateInfo->setLayoutCount * sizeof(%s));' % (p_ty, proto.params[-1].name, p_ty, p_ty))
1559 rbody.append(' VkDescriptorSetLayout* local_pSetLayouts = (VkDescriptorSetLayout*)malloc(pPacket->pAllocateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout));')
1560 rbody.append(' VkDescriptorSetAllocateInfo local_AllocInfo, *local_pAllocateInfo = &local_AllocInfo;')
Jon Ashburne27a9182015-10-16 17:50:47 -06001561 rbody.append(' VkDescriptorPool local_descPool;')
Chia-I Wu1f851912015-10-27 18:04:07 +08001562 rbody.append(' local_descPool = m_objMapper.remap_descriptorpools(pPacket->pAllocateInfo->descriptorPool);')
1563 rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->setLayoutCount; i++)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001564 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001565 rbody.append(' local_pSetLayouts[i] = m_objMapper.remap_descriptorsetlayouts(pPacket->%s->pSetLayouts[i]);' % (proto.params[-2].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001566 rbody.append(' }')
Chia-I Wu1f851912015-10-27 18:04:07 +08001567 rbody.append(' memcpy(local_pAllocateInfo, pPacket->pAllocateInfo, sizeof(VkDescriptorSetAllocateInfo));')
1568 rbody.append(' local_pAllocateInfo->pSetLayouts = local_pSetLayouts;')
1569 rbody.append(' local_pAllocateInfo->descriptorPool = local_descPool;')
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001570 else:
1571 rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001572 elif proto.name == 'ResetFences':
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001573 rbody.append(' VkFence* fences = VKTRACE_NEW_ARRAY(VkFence, pPacket->fenceCount);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001574 rbody.append(' for (uint32_t i = 0; i < pPacket->fenceCount; i++)')
1575 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001576 rbody.append(' fences[i] = m_objMapper.remap_fences(pPacket->%s[i]);' % (proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001577 rbody.append(' }')
1578 elif proto.name in do_while_dict:
1579 rbody.append(' do {')
Jon Ashburnc736c002015-10-25 20:24:57 -06001580 last_name = ''
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001581 for p in proto.params:
1582 if create_func or create_view:
1583 if p.name != proto.params[-1].name:
Jon Ashburnc736c002015-10-25 20:24:57 -06001584 rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001585 else:
Jon Ashburnc736c002015-10-25 20:24:57 -06001586 rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
1587 last_name = p.name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001588
1589 if proto.name == 'DestroyInstance':
1590 rbody.append(' if (m_vkFuncs.real_vkDbgDestroyMsgCallback != NULL)')
1591 rbody.append(' {')
1592 rbody.append(' m_vkFuncs.real_vkDbgDestroyMsgCallback(remappedinstance, m_dbgMsgCallbackObj);')
1593 rbody.append(' }')
1594 # TODO: need a better way to indicate which extensions should be mapped to which Get*ProcAddr
1595 elif proto.name == 'GetInstanceProcAddr':
1596 for iProto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001597 if 'Dbg' in iProto.name or 'GetPhysicalDeviceSurfaceSupportKHR' in iProto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001598 rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (iProto.name))
1599 rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappedinstance, pPacket->pName);' % (iProto.name, iProto.name, proto.name))
1600 rbody.append(' }')
1601 elif proto.name == 'GetDeviceProcAddr':
1602 for dProto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001603 if 'KHR' in dProto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001604 rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (dProto.name))
1605 rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappeddevice, pPacket->pName);' % (dProto.name, dProto.name, proto.name))
1606 rbody.append(' }')
1607
1608 # build the call to the "real_" entrypoint
1609 rr_string = ' '
1610 if ret_value:
1611 rr_string = ' replayResult = '
1612 rr_string += 'm_vkFuncs.real_vk%s(' % proto.name
1613 for p in proto.params:
1614 # For last param of Create funcs, pass address of param
1615 if create_func:
Chia-I Wu1f851912015-10-27 18:04:07 +08001616 if proto.name == 'AllocateDescriptorSets' and ((p.name == proto.params[-2].name) or (p.name == proto.params[-1].name)):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001617 rr_string += 'local_%s, ' % p.name
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001618 elif p.name == proto.params[-1].name:
1619 rr_string += '&local_%s, ' % p.name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001620 else:
1621 rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
1622 else:
1623 rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
1624 rr_string = '%s);' % rr_string[:-2]
1625 if proto.name in custom_open_params:
1626 rr_list = rr_string.split(', ')
1627 for pidx in custom_open_params[proto.name]:
1628 rr_list[pidx] = '&local_%s' % proto.params[pidx].name
1629 rr_string = ', '.join(rr_list)
1630 rr_string += ');'
1631 elif create_view:
1632 rr_list = rr_string.split(', ')
Chia-I Wu69f40122015-10-26 21:10:41 +08001633 rr_list[-3] = '&createInfo'
1634 rr_list[-2] = 'NULL'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001635 rr_list[-1] = '&local_%s);' % proto.params[-1].name
1636 rr_string = ', '.join(rr_list)
1637 # this is a sneaky shortcut to use generic create code below to add_to_map
1638 create_func = True
Chia-I Wu1f851912015-10-27 18:04:07 +08001639 elif proto.name == 'AllocateDescriptorSets':
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001640 rr_string = rr_string.replace('pPacket->pSetLayouts', 'pLocalDescSetLayouts')
1641 elif proto.name == 'ResetFences':
1642 rr_string = rr_string.replace('pPacket->pFences', 'fences')
1643
1644 # insert the real_*(..) call
1645 rbody.append(rr_string)
1646
1647 # handle return values or anything that needs to happen after the real_*(..) call
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -06001648 get_ext_layers_proto = ['EnumerateInstanceExtensionProperties', 'EnumerateDeviceExtensionProperties','EnumerateInstanceLayerProperties', 'EnumerateDeviceLayerProperties']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001649 if 'DestroyDevice' in proto.name:
1650 rbody.append(' if (replayResult == VK_SUCCESS)')
1651 rbody.append(' {')
1652 rbody.append(' m_pCBDump = NULL;')
1653 rbody.append(' m_pDSDump = NULL;')
1654 #TODO138 : disabling snapshot
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001655 #rbody.append(' m_pVktraceSnapshotPrint = NULL;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001656 rbody.append(' m_objMapper.rm_from_devices_map(pPacket->device);')
1657 rbody.append(' m_display->m_initedVK = false;')
1658 rbody.append(' }')
Jon Ashburnc30315e2015-09-07 14:39:30 -06001659 elif proto.name in get_ext_layers_proto:
Courtney Goeltzenleuchterac544f32015-09-14 18:01:17 -06001660 rbody.append(' if (replayResult == VK_ERROR_LAYER_NOT_PRESENT || replayResult == VK_INCOMPLETE)')
Jon Ashburnc30315e2015-09-07 14:39:30 -06001661 rbody.append(' { // ignore errors caused by trace config != replay config')
1662 rbody.append(' replayResult = VK_SUCCESS;')
1663 rbody.append(' }')
Ian Elliott338dedb2015-08-21 15:09:33 -06001664 elif 'DestroySwapchainKHR' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001665 rbody.append(' if (replayResult == VK_SUCCESS)')
1666 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001667 rbody.append(' m_objMapper.rm_from_swapchainkhrs_map(pPacket->swapchain);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001668 rbody.append(' }')
1669 elif 'DestroyInstance' in proto.name:
1670 rbody.append(' if (replayResult == VK_SUCCESS)')
1671 rbody.append(' {')
1672 rbody.append(' // TODO need to handle multiple instances and only clearing maps within an instance.')
1673 rbody.append(' // TODO this only works with a single instance used at any given time.')
1674 rbody.append(' m_objMapper.clear_all_map_handles();')
1675 rbody.append(' }')
Courtney Goeltzenleuchter5970b252015-10-27 11:32:31 -06001676 elif 'MergePipelineCaches' in proto.name:
1677 rbody.append(' delete remappedpSrcCaches;')
1678 elif 'FreeCommandBuffers' in proto.name:
1679 rbody.append(' delete remappedpCommandBuffers;')
1680 elif 'CmdExecuteCommands' in proto.name:
Chia-I Wu1f851912015-10-27 18:04:07 +08001681 rbody.append(' delete remappedpCommandBuffers;')
1682 elif 'AllocateDescriptorSets' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001683 rbody.append(' if (replayResult == VK_SUCCESS)')
1684 rbody.append(' {')
Chia-I Wu1f851912015-10-27 18:04:07 +08001685 rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->setLayoutCount; i++) {')
Chia-I Wue420a332015-10-26 20:04:44 +08001686 rbody.append(' m_objMapper.add_to_descriptorsets_map(pPacket->%s[i], local_%s[i]);' % (proto.params[-1].name, proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001687 rbody.append(' }')
1688 rbody.append(' }')
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001689 rbody.append(' free(local_pSetLayouts);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001690 rbody.append(' free(local_pDescriptorSets);')
1691 elif proto.name == 'ResetFences':
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001692 rbody.append(' VKTRACE_DELETE(fences);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001693 elif create_func: # save handle mapping if create successful
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -06001694 if ret_value:
1695 rbody.append(' if (replayResult == VK_SUCCESS)')
1696 rbody.append(' {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001697 clean_type = proto.params[-1].ty.strip('*').replace('const ', '')
Jon Ashburncb622a12015-08-06 17:22:53 -06001698 VkNonDispObjType = [o for o in vulkan.object_non_dispatch_list]
Chia-I Wue420a332015-10-26 20:04:44 +08001699 rbody.append(' m_objMapper.add_to_%ss_map(*(pPacket->%s), local_%s);' % (clean_type.lower()[2:], proto.params[-1].name, proto.params[-1].name))
Chia-I Wu1f851912015-10-27 18:04:07 +08001700 if 'AllocateMemory' == proto.name:
1701 rbody.append(' m_objMapper.add_entry_to_mapData(local_%s, pPacket->pAllocateInfo->allocationSize);' % (proto.params[-1].name))
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -06001702 if ret_value:
1703 rbody.append(' }')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001704 elif proto.name in do_while_dict:
1705 rbody[-1] = ' %s' % rbody[-1]
1706 rbody.append(' } while (%s);' % do_while_dict[proto.name])
1707 rbody.append(' if (pPacket->result != VK_NOT_READY || replayResult != VK_SUCCESS)')
1708 if ret_value:
1709 rbody.append(' CHECK_RETURN_VALUE(vk%s);' % proto.name)
1710 rbody.append(' break;')
1711 rbody.append(' }')
1712 rbody.append(' default:')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001713 rbody.append(' vktrace_LogWarning("Unrecognized packet_id %u, skipping.", packet->packet_id);')
1714 rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_INVALID_ID;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001715 rbody.append(' break;')
1716 rbody.append(' }')
1717 rbody.append(' return returnValue;')
1718 rbody.append('}')
1719 return "\n".join(rbody)
1720
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001721class VktraceTraceHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001722 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001723 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001724 header_txt.append('#include "vktrace_vk_vk_packets.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001725 header_txt.append('#include "vktrace_vk_packet_id.h"\n\n')
1726 header_txt.append('void InitTracer(void);\n\n')
1727 header_txt.append('#ifdef WIN32')
1728 header_txt.append('extern INIT_ONCE gInitOnce;')
1729 header_txt.append('\n#elif defined(PLATFORM_LINUX)')
1730 header_txt.append('extern pthread_once_t gInitOnce;')
1731 header_txt.append('#endif\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001732 return "\n".join(header_txt)
1733
1734 def generate_body(self):
Jon Ashburn71654fd2015-09-11 09:18:44 -06001735 body = [self._generate_trace_func_protos()]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001736
1737 return "\n".join(body)
1738
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001739class VktraceTraceC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001740 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001741 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001742 header_txt.append('#include "vktrace_platform.h"')
1743 header_txt.append('#include "vktrace_common.h"')
1744 header_txt.append('#include "vktrace_lib_helpers.h"')
1745 header_txt.append('#include "vktrace_vk_vk.h"')
1746 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001747 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001748 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain.h"')
1749 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001750 header_txt.append('#include "vktrace_interconnect.h"')
1751 header_txt.append('#include "vktrace_filelike.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001752 header_txt.append('#include "vk_struct_size_helper.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001753 header_txt.append('#ifdef PLATFORM_LINUX')
1754 header_txt.append('#include <pthread.h>')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001755 header_txt.append('#endif')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001756 header_txt.append('#include "vktrace_trace_packet_utils.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001757 header_txt.append('#include <stdio.h>\n')
Chia-I Wua5cd6532015-10-28 18:31:57 +08001758 header_txt.append('#include <string.h>\n')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001759 header_txt.append('#ifdef WIN32')
1760 header_txt.append('INIT_ONCE gInitOnce = INIT_ONCE_STATIC_INIT;')
1761 header_txt.append('#elif defined(PLATFORM_LINUX)')
1762 header_txt.append('pthread_once_t gInitOnce = PTHREAD_ONCE_INIT;')
1763 header_txt.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001764 return "\n".join(header_txt)
1765
1766 def generate_body(self):
Jon Ashburn71654fd2015-09-11 09:18:44 -06001767 body = [self._generate_init_funcs(),
Chia-I Wu1f851912015-10-27 18:04:07 +08001768 self._generate_trace_funcs(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001769
1770 return "\n".join(body)
1771
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001772class VktracePacketID(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001773 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001774 header_txt = []
1775 header_txt.append('#pragma once\n')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001776 header_txt.append('#include "vktrace_trace_packet_utils.h"')
1777 header_txt.append('#include "vktrace_trace_packet_identifiers.h"')
1778 header_txt.append('#include "vktrace_interconnect.h"')
1779 header_txt.append('#include "vktrace_vk_vk_packets.h"')
1780 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg_packets.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001781 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg_packets.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001782 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain_packets.h"')
1783 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain_packets.h"')
Jon Ashburncb622a12015-08-06 17:22:53 -06001784 #header_txt.append('#include "vk_enum_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001785 header_txt.append('#ifndef _WIN32')
1786 header_txt.append(' #pragma GCC diagnostic ignored "-Wwrite-strings"')
1787 header_txt.append('#endif')
Jon Ashburncb622a12015-08-06 17:22:53 -06001788 #header_txt.append('#include "vk_struct_string_helper.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001789 #header_txt.append('#include "vk_ext_khr_swapchain_struct_string_helper.h"')
1790 #header_txt.append('#include "vk_ext_khr_device_swapchain_struct_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001791 header_txt.append('#ifndef _WIN32')
1792 header_txt.append(' #pragma GCC diagnostic warning "-Wwrite-strings"')
1793 header_txt.append('#endif')
Ian Elliott338dedb2015-08-21 15:09:33 -06001794 #header_txt.append('#include "vk_ext_khr_swapchain_enum_string_helper.h"')
1795 #header_txt.append('#include "vk_ext_khr_device_swapchain_enum_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001796 header_txt.append('#if defined(WIN32)')
1797 header_txt.append('#define snprintf _snprintf')
1798 header_txt.append('#endif')
1799 header_txt.append('#define SEND_ENTRYPOINT_ID(entrypoint) ;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001800 header_txt.append('//#define SEND_ENTRYPOINT_ID(entrypoint) vktrace_TraceInfo(#entrypoint);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001801 header_txt.append('#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) ;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001802 header_txt.append('//#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) vktrace_TraceInfo(entrypoint, __VA_ARGS__);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001803 header_txt.append('#define CREATE_TRACE_PACKET(entrypoint, buffer_bytes_needed) \\')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001804 header_txt.append(' pHeader = vktrace_create_trace_packet(VKTRACE_TID_VULKAN, VKTRACE_TPI_VK_##entrypoint, sizeof(packet_##entrypoint), buffer_bytes_needed);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001805 header_txt.append('#define FINISH_TRACE_PACKET() \\')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001806 header_txt.append(' vktrace_finalize_trace_packet(pHeader); \\')
1807 header_txt.append(' vktrace_write_trace_packet(pHeader, vktrace_trace_get_trace_file()); \\')
1808 header_txt.append(' vktrace_delete_trace_packet(&pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001809 return "\n".join(header_txt)
1810
1811 def generate_body(self):
1812 body = [self._generate_packet_id_enum(),
1813 self._generate_packet_id_name_func(),
Jon Ashburncb622a12015-08-06 17:22:53 -06001814# self._generate_stringify_func(),
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001815 self._generate_interp_func()]
1816
1817 return "\n".join(body)
1818
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001819class VktraceCoreTracePackets(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001820 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001821 header_txt = []
1822 header_txt.append('#pragma once\n')
1823 header_txt.append('#include "vulkan.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001824 header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001825 return "\n".join(header_txt)
1826
1827 def generate_body(self):
1828 body = [self._generate_struct_util_funcs(),
1829 self._generate_interp_funcs()]
1830
1831 return "\n".join(body)
1832
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001833class VktraceExtTraceHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001834 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001835 header_txt = []
1836 header_txt.append('#pragma once\n')
1837 header_txt.append('#include "vulkan.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001838 header_txt.append('#include "%s.h"' % extensionName.lower())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001839 return "\n".join(header_txt)
1840
1841 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001842 body = [self._generate_trace_func_protos_ext(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001843
1844 return "\n".join(body)
1845
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001846class VktraceExtTraceC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001847 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001848 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001849 header_txt.append('#include "vktrace_platform.h"')
1850 header_txt.append('#include "vktrace_common.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001851 if extensionName == "vk_ext_khr_device_swapchain":
Ian Elliott338dedb2015-08-21 15:09:33 -06001852 header_txt.append('#include "vk_ext_khr_swapchain.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001853 header_txt.append('#include "vktrace_vk_%s.h"' % extensionName.lower())
1854 header_txt.append('#include "vktrace_vk_%s_packets.h"' % extensionName.lower())
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001855 header_txt.append('#include "vktrace_vk_packet_id.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001856 header_txt.append('#include "vk_struct_size_helper.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001857 header_txt.append('#include "%s_struct_size_helper.h"' % extensionName.lower())
1858 if extensionName == 'vk_debug_marker_lunarg':
Jon Ashburn71654fd2015-09-11 09:18:44 -06001859 header_txt.append('#include "vk_debug_marker_layer.h"\n')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001860
Jon Ashburn5afdcf62015-09-14 15:17:36 -06001861 header_txt.append('#include "vktrace_lib_helpers.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001862 return "\n".join(header_txt)
1863
1864 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001865 body = [self._generate_trace_funcs(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001866
1867 return "\n".join(body)
1868
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001869class VktraceExtTracePackets(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001870 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001871 header_txt = []
1872 header_txt.append('#pragma once\n')
Chia-I Wu1f851912015-10-27 18:04:07 +08001873 header_txt.append('#include "%s.h"' % extensionName.lower())
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001874 header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001875 return "\n".join(header_txt)
1876
1877 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001878 body = [self._generate_interp_funcs_ext(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001879
1880 return "\n".join(body)
1881
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001882class VktraceReplayVkFuncPtrs(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001883 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001884 header_txt = []
1885 header_txt.append('#pragma once\n')
1886 header_txt.append('#if defined(PLATFORM_LINUX) || defined(XCB_NVIDIA)')
1887 header_txt.append('#include <xcb/xcb.h>\n')
1888 header_txt.append('#endif')
1889 header_txt.append('#include "vulkan.h"')
1890 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001891 header_txt.append('#include "vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001892 header_txt.append('#include "vk_ext_khr_swapchain.h"')
1893 header_txt.append('#include "vk_ext_khr_device_swapchain.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001894
1895 def generate_body(self):
1896 body = [self._generate_replay_func_ptrs()]
1897 return "\n".join(body)
1898
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001899class VktraceReplayObjMapperHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001900 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001901 header_txt = []
1902 header_txt.append('#pragma once\n')
1903 header_txt.append('#include <set>')
1904 header_txt.append('#include <map>')
1905 header_txt.append('#include <vector>')
1906 header_txt.append('#include <string>')
1907 header_txt.append('#include "vulkan.h"')
1908 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001909 header_txt.append('#include "vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001910 header_txt.append('#include "vk_ext_khr_swapchain.h"')
1911 header_txt.append('#include "vk_ext_khr_device_swapchain.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001912 return "\n".join(header_txt)
1913
1914 def generate_body(self):
1915 body = [self._generate_replay_objmapper_class()]
1916 return "\n".join(body)
1917
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001918class VktraceReplayC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001919 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001920 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001921 header_txt.append('#include "vkreplay_vkreplay.h"\n')
1922 header_txt.append('#include "vkreplay.h"\n')
1923 header_txt.append('#include "vkreplay_main.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001924 header_txt.append('#include <algorithm>')
1925 header_txt.append('#include <queue>')
1926 header_txt.append('\n')
1927 header_txt.append('extern "C" {')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001928 header_txt.append('#include "vktrace_vk_vk_packets.h"')
1929 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg_packets.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001930 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg_packets.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001931 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain_packets.h"')
1932 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain_packets.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001933 header_txt.append('#include "vktrace_vk_packet_id.h"')
Jon Ashburncb622a12015-08-06 17:22:53 -06001934 #header_txt.append('#include "vk_enum_string_helper.h"\n}\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001935
1936 return "\n".join(header_txt)
1937
1938 def generate_body(self):
1939 body = [self._generate_replay_init_funcs(),
1940 self._generate_replay()]
Jon Ashburncb622a12015-08-06 17:22:53 -06001941 body.append("}")
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001942 return "\n".join(body)
1943
1944def main():
1945 subcommands = {
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001946 "vktrace-trace-h" : VktraceTraceHeader,
1947 "vktrace-trace-c" : VktraceTraceC,
1948 "vktrace-packet-id" : VktracePacketID,
1949 "vktrace-core-trace-packets" : VktraceCoreTracePackets,
1950 "vktrace-ext-trace-h" : VktraceExtTraceHeader,
1951 "vktrace-ext-trace-c" : VktraceExtTraceC,
1952 "vktrace-ext-trace-packets" : VktraceExtTracePackets,
1953 "vktrace-replay-vk-funcs" : VktraceReplayVkFuncPtrs,
1954 "vktrace-replay-obj-mapper-h" : VktraceReplayObjMapperHeader,
1955 "vktrace-replay-c" : VktraceReplayC,
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001956 }
1957
1958 if len(sys.argv) < 2 or sys.argv[1] not in subcommands:
1959 print("Usage: %s <subcommand> [options]" % sys.argv[0])
1960 print
1961 print("Available subcommands are: %s" % " ".join(subcommands))
1962 exit(1)
1963
1964 subcmd = subcommands[sys.argv[1]](sys.argv[2])
1965 subcmd.run()
1966
1967if __name__ == "__main__":
1968 main()