blob: 4b84a363a1d4fa877d7d6af1fdb3db4cc140ec73 [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#
Courtney Goeltzenleuchter96cd7952015-10-30 11:14:30 -060025# Author: Jon Ashburn <jon@lunarg.com>
26# Author: Tobin Ehlis <tobin@lunarg.com>
27#
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060028
29import os, sys
Jon Ashburncb622a12015-08-06 17:22:53 -060030
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060031
32# add main repo directory so vulkan.py can be imported. This needs to be a complete path.
Mark Lobodzinski87220f82015-08-27 15:30:29 -060033vktrace_scripts_path = os.path.dirname(os.path.abspath(__file__))
34main_path = os.path.abspath(vktrace_scripts_path + "/../")
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060035sys.path.append(main_path)
Jon Ashburncb622a12015-08-06 17:22:53 -060036from source_line_info import sourcelineinfo
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060037
Jon Ashburncb622a12015-08-06 17:22:53 -060038import vulkan
39
40# vulkan.py doesn't include all the extensions (debug_report missing)
41headers = []
42objects = []
43protos = []
44for ext in vulkan.extensions_all:
45 headers.extend(ext.headers)
46 objects.extend(ext.objects)
47 protos.extend(ext.protos)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060048
49class Subcommand(object):
50 def __init__(self, argv):
51 self.argv = argv
Chia-I Wu1f851912015-10-27 18:04:07 +080052 self.extensionName = argv
Jon Ashburncb622a12015-08-06 17:22:53 -060053 self.headers = headers
54 self.objects = objects
55 self.protos = protos
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060056 self.lineinfo = sourcelineinfo()
57
58 def run(self):
Chia-I Wu1f851912015-10-27 18:04:07 +080059 print(self.generate(self.extensionName))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060060
Chia-I Wu1f851912015-10-27 18:04:07 +080061 def generate(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060062 copyright = self.generate_copyright()
Chia-I Wu1f851912015-10-27 18:04:07 +080063 header = self.generate_header(extensionName)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060064 body = self.generate_body()
65 footer = self.generate_footer()
66 contents = []
67 if copyright:
68 contents.append(copyright)
69 if header:
70 contents.append(header)
71 if body:
72 contents.append(body)
73 if footer:
74 contents.append(footer)
75
76 return "\n\n".join(contents)
77
78 def generate_copyright(self):
79 return """/* THIS FILE IS GENERATED. DO NOT EDIT. */
80
81/*
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060082 *
Courtney Goeltzenleuchter8a17da52015-10-29 13:50:34 -060083 * Copyright (C) 2015 Valve Corporation
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060084 *
85 * Permission is hereby granted, free of charge, to any person obtaining a
86 * copy of this software and associated documentation files (the "Software"),
87 * to deal in the Software without restriction, including without limitation
88 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
89 * and/or sell copies of the Software, and to permit persons to whom the
90 * Software is furnished to do so, subject to the following conditions:
91 *
92 * The above copyright notice and this permission notice shall be included
93 * in all copies or substantial portions of the Software.
94 *
95 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
96 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
97 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
98 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
99 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
100 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
101 * DEALINGS IN THE SOFTWARE.
Courtney Goeltzenleuchter96cd7952015-10-30 11:14:30 -0600102 *
103 * Author: Jon Ashburn <jon@lunarg.com>
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600104 */"""
105
Chia-I Wu1f851912015-10-27 18:04:07 +0800106 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600107 return "\n".join(["#include <" + h + ">" for h in self.headers])
108
109 def generate_body(self):
110 pass
111
112 def generate_footer(self):
113 pass
114
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600115 def _generate_trace_func_protos(self):
116 func_protos = []
Jon Ashburn4278f642015-09-11 13:12:02 -0600117 func_protos.append('#ifdef __cplusplus')
118 func_protos.append('extern"C" {')
119 func_protos.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600120 func_protos.append('// Hooked function prototypes\n')
121 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -0600122 if 'Dbg' not in proto.name and 'KHR' not in proto.name:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600123 func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600124
Jon Ashburn4278f642015-09-11 13:12:02 -0600125 func_protos.append('#ifdef __cplusplus')
126 func_protos.append('}')
127 func_protos.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600128 return "\n".join(func_protos)
129
Chia-I Wu1f851912015-10-27 18:04:07 +0800130 def _generate_trace_func_protos_ext(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600131 func_protos = []
132 func_protos.append('// Hooked function prototypes\n')
Jon Ashburncb622a12015-08-06 17:22:53 -0600133 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800134 if (extensionName.lower() == ext.name.lower()):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600135 for proto in ext.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600136 func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600137
138 return "\n".join(func_protos)
139
140
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600141 def _generate_init_funcs(self):
142 init_tracer = []
143 init_tracer.append('void send_vk_api_version_packet()\n{')
144 init_tracer.append(' packet_vkApiVersion* pPacket;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600145 init_tracer.append(' vktrace_trace_packet_header* pHeader;')
146 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 -0600147 init_tracer.append(' pPacket = interpret_body_as_vkApiVersion(pHeader);')
148 init_tracer.append(' pPacket->version = VK_API_VERSION;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600149 init_tracer.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600150 init_tracer.append(' FINISH_TRACE_PACKET();\n}\n')
151
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600152 init_tracer.append('extern VKTRACE_CRITICAL_SECTION g_memInfoLock;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600153 init_tracer.append('void InitTracer(void)\n{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600154 init_tracer.append(' const char *ipAddr = vktrace_get_global_var("VKTRACE_LIB_IPADDR");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600155 init_tracer.append(' if (ipAddr == NULL)')
156 init_tracer.append(' ipAddr = "127.0.0.1";')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600157 init_tracer.append(' gMessageStream = vktrace_MessageStream_create(FALSE, ipAddr, VKTRACE_BASE_PORT + VKTRACE_TID_VULKAN);')
158 init_tracer.append(' vktrace_trace_set_trace_file(vktrace_FileLike_create_msg(gMessageStream));')
159 init_tracer.append(' vktrace_tracelog_set_tracer_id(VKTRACE_TID_VULKAN);')
160 init_tracer.append(' vktrace_create_critical_section(&g_memInfoLock);')
Mark Lobodzinski48837d12015-09-28 12:08:57 -0600161 init_tracer.append(' if (gMessageStream != NULL)')
162 init_tracer.append(' send_vk_api_version_packet();\n}\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600163 return "\n".join(init_tracer)
164
165 # Take a list of params and return a list of dicts w/ ptr param details
166 def _get_packet_ptr_param_list(self, params):
167 ptr_param_list = []
168 # TODO : This is a slightly nicer way to handle custom cases than initial code, however
169 # this can still be further generalized to eliminate more custom code
170 # big case to handle is when ptrs to structs have embedded data that needs to be accounted for in packet
171 custom_ptr_dict = {'VkDeviceCreateInfo': {'add_txt': 'add_VkDeviceCreateInfo_to_packet(pHeader, (VkDeviceCreateInfo**) &(pPacket->pCreateInfo), pCreateInfo)',
172 'finalize_txt': ''},
Chia-I Wu1f851912015-10-27 18:04:07 +0800173 'VkApplicationInfo': {'add_txt': 'add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&(pPacket->pApplicationInfo), pApplicationInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600174 'finalize_txt': ''},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600175 'VkPhysicalDevice': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pGpus), *pGpuCount*sizeof(VkPhysicalDevice), pGpus)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600176 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600177 'pDataSize': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDataSize), sizeof(size_t), &_dataSize)',
178 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pDataSize))'},
179# 'pData': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pData), _dataSize, pData)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600180# 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600181 '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 -0600182 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600183 '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 -0600184 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600185 '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 -0600186 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600187 'pDescriptorSets': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDescriptorSets), customSize, pDescriptorSets)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600188 'finalize_txt': 'default'},
Chia-I Wu763a7492015-10-26 20:48:51 +0800189 'pSparseMemoryRequirements': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pSparseMemoryRequirements), (*pSparseMemoryRequirementCount) * sizeof(VkSparseImageMemoryRequirements), pSparseMemoryRequirements)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600190 'finalize_txt': 'default'},
Chia-I Wu763a7492015-10-26 20:48:51 +0800191 'VkSparseImageFormatProperties': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pProperties), (*pPropertyCount) * sizeof(VkSparseImageFormatProperties), pProperties)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600192 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600193 'VkSparseMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseMemoryBindInfo), pBindInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600194 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600195 'VkSparseImageMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseImageMemoryBindInfo), pBindInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600196 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600197 'VkFramebufferCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkFramebufferCreateInfo), pCreateInfo);\n'
198 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments), colorCount * sizeof(VkColorAttachmentBindInfo), pCreateInfo->pColorAttachments);\n'
199 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment), dsSize, pCreateInfo->pDepthStencilAttachment)',
200 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments));\n'
201 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment));\n'
202 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
203 'VkRenderPassCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkRenderPassCreateInfo), pCreateInfo);\n'
204 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats), colorCount * sizeof(VkFormat), pCreateInfo->pColorFormats);\n'
205 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts), colorCount * sizeof(VkImageLayout), pCreateInfo->pColorLayouts);\n'
206 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps), colorCount * sizeof(VkAttachmentLoadOp), pCreateInfo->pColorLoadOps);\n'
207 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps), colorCount * sizeof(VkAttachmentStoreOp), pCreateInfo->pColorStoreOps);\n'
208 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues), colorCount * sizeof(VkClearColor), pCreateInfo->pColorLoadClearValues)',
209 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats));\n'
210 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts));\n'
211 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps));\n'
212 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps));\n'
213 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues));\n'
214 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
215 '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 +0800216 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts), pCreateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout), pCreateInfo->pSetLayouts);',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600217 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts));\n'
218 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Chia-I Wu1f851912015-10-27 18:04:07 +0800219 'VkMemoryAllocateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo), sizeof(VkMemoryAllocateInfo), pAllocateInfo);\n'
220 ' add_alloc_memory_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo->pNext), pAllocateInfo->pNext)',
221 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pAllocateInfo))'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600222# '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 -0600223# ' add_VkGraphicsPipelineCreateInfos_to_trace_packet(pHeader, (VkGraphicsPipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600224# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
225# '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 -0600226# ' add_VkComputePipelineCreateInfos_to_trace_packet(pHeader, (VkComputePipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600227# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
228 '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 +0800229 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes), pCreateInfo->poolSizeCount * sizeof(VkDescriptorPoolSize), pCreateInfo->pPoolSizes)',
230 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes));\n'
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600231 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600232 'VkDescriptorSetLayoutCreateInfo': {'add_txt': 'add_create_ds_layout_to_trace_packet(pHeader, &pPacket->pCreateInfo, pCreateInfo)',
233 'finalize_txt': '// pCreateInfo finalized in add_create_ds_layout_to_trace_packet'},
Ian Elliott338dedb2015-08-21 15:09:33 -0600234 'VkSwapchainCreateInfoKHR': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkSwapchainCreateInfoKHR), pCreateInfo);\n'
235 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSurfaceDescription), sizeof(VkSurfaceDescriptionKHR), pCreateInfo->pSurfaceDescription)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600236 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSurfaceDescription));\n'
237 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
238 'VkShaderModuleCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkShaderModuleCreateInfo), pCreateInfo);\n'
239 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pCode), pPacket->pCreateInfo->codeSize, pCreateInfo->pCode)',
240 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pCode));\n'
241 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600242 }
243
244 for p in params:
245 pp_dict = {}
Jon Ashburnbb4e7c12015-09-14 17:30:20 -0600246 if '*' in p.ty and p.name not in ['pTag', 'pUserData']:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600247 if 'const' in p.ty.lower() and 'count' in params[params.index(p)-1].name.lower():
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600248 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 -0600249 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 -0600250 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 -0600251 elif p.ty.strip('*').replace('const ', '') in custom_ptr_dict:
252 pp_dict['add_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['add_txt']
253 pp_dict['finalize_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['finalize_txt']
254 elif p.name in custom_ptr_dict:
255 pp_dict['add_txt'] = custom_ptr_dict[p.name]['add_txt']
256 pp_dict['finalize_txt'] = custom_ptr_dict[p.name]['finalize_txt']
257 # TODO : This is custom hack to account for 2 pData items with dataSize param for sizing
258 if 'pData' == p.name and 'dataSize' == params[params.index(p)-1].name:
259 pp_dict['add_txt'] = pp_dict['add_txt'].replace('_dataSize', 'dataSize')
Jon Ashburnbb4e7c12015-09-14 17:30:20 -0600260 elif 'void' in p.ty and (p.name == 'pData' or p.name == 'values'):
261 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)
262 pp_dict['finalize_txt'] = '//TODO FIXME vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600263 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600264 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 -0600265 if 'finalize_txt' not in pp_dict or 'default' == pp_dict['finalize_txt']:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600266 pp_dict['finalize_txt'] = 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600267 pp_dict['index'] = params.index(p)
268 ptr_param_list.append(pp_dict)
269 return ptr_param_list
270
271 # Take a list of params and return a list of packet size elements
Chia-I Wu1f851912015-10-27 18:04:07 +0800272 def _get_packet_size(self, extensionName, params):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600273 ps = [] # List of elements to be added together to account for packet size for given params
274 skip_list = [] # store params that are already accounted for so we don't count them twice
275 # Dict of specific params with unique custom sizes
Courtney Goeltzenleuchter8e2f0972015-10-21 17:08:06 -0600276 # TODO: Now using bitfields for all stages, need pSetBindPoints to accomodate that.
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600277 custom_size_dict = {'pSetBindPoints': '(VK_SHADER_STAGE_COMPUTE * sizeof(uint32_t))', # Accounting for largest possible array
Ian Elliott338dedb2015-08-21 15:09:33 -0600278 'VkSwapchainCreateInfoKHR' : 'vk_ext_khr_device_swapchain_size_vkswapchaincreateinfokhr(pCreateInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600279 }
280 size_func_suffix = ''
Chia-I Wu1f851912015-10-27 18:04:07 +0800281 if extensionName.lower() != "vk_core":
282 size_func_suffix = '_%s' % extensionName.lower()
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600283 for p in params:
284 #First handle custom cases
Chia-I Wu1f851912015-10-27 18:04:07 +0800285 if p.name in ['pCreateInfo', 'pSetLayoutInfoList', 'pBeginInfo', 'pAllocateInfo'] and 'khr' not in p.ty.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600286 ps.append('get_struct_chain_size%s((void*)%s)' % (size_func_suffix, p.name))
287 skip_list.append(p.name)
288 elif p.name in custom_size_dict:
289 ps.append(custom_size_dict[p.name])
290 skip_list.append(p.name)
291 elif p.ty.strip('*').replace('const ', '') in custom_size_dict:
292 tmp_ty = p.ty.strip('*').replace('const ', '')
293 ps.append(custom_size_dict[tmp_ty])
294 skip_list.append(p.name)
295 # Skip any params already handled
296 if p.name in skip_list:
297 continue
298 # Now check to identify dynamic arrays which depend on two params
299 if 'count' in p.name.lower():
300 next_idx = params.index(p)+1
301 # If next element is a const *, then multiply count and array type
302 if next_idx < len(params) and '*' in params[next_idx].ty and 'const' in params[next_idx].ty.lower():
303 if '*' in p.ty:
304 ps.append('*%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
305 else:
306 ps.append('%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
307 skip_list.append(params[next_idx].name)
308 if 'bindingCount' == p.name: # TODO : This is custom case for CmdBindVertexBuffers, need to clean it up
309 ps.append('%s*sizeof(%s)' % (p.name, params[next_idx+1].ty.strip('*').replace('const ', '')))
310 skip_list.append(params[next_idx+1].name)
311 elif '*' in p.ty: # Not a custom array size we're aware of, but ptr so need to account for its size
312 ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
313 elif '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
314 if 'pData' == p.name:
315 if 'dataSize' == params[params.index(p)-1].name:
316 ps.append('dataSize')
317 elif 'counterCount' == params[params.index(p)-1].name:
318 ps.append('sizeof(%s)' % p.ty.strip('*').replace('const ', ''))
319 else:
320 #ps.append('((pDataSize != NULL && pData != NULL) ? *pDataSize : 0)')
321 ps.append('sizeof(void*)')
322 elif '**' in p.ty and 'void' in p.ty:
323 ps.append('sizeof(void*)')
324 elif 'void' in p.ty:
325 ps.append('sizeof(%s)' % p.name)
326 elif 'char' in p.ty:
327 ps.append('((%s != NULL) ? strlen(%s) + 1 : 0)' % (p.name, p.name))
328 elif 'pDataSize' in p.name:
329 ps.append('((pDataSize != NULL) ? sizeof(size_t) : 0)')
330 elif 'IMAGE_SUBRESOURCE' in p.ty and 'pSubresource' == p.name:
331 ps.append('((pSubresource != NULL) ? sizeof(VkImage_SUBRESOURCE) : 0)')
332 else:
333 ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
334 return ps
335
336 # Generate functions used to trace API calls and store the input and result data into a packet
337 # Here's the general flow of code insertion w/ option items flagged w/ "?"
338 # Result decl?
339 # Packet struct decl
340 # ?Special case : setup call to function first and do custom API call time tracking
341 # CREATE_PACKET
342 # call real entrypoint and get return value (if there is one)
343 # Assign packet values
344 # FINISH packet
345 # return result if needed
Chia-I Wu1f851912015-10-27 18:04:07 +0800346 def _generate_trace_funcs(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600347 func_body = []
Chia-I Wu1f851912015-10-27 18:04:07 +0800348 manually_written_hooked_funcs = ['AllocateMemory',
349 'AllocateDescriptorSets',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600350 'CreateDescriptorPool',
Jon Ashburne70884b2015-08-25 13:33:39 -0600351 'CreateDevice',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600352 'CreateFramebuffer',
353 'CreateInstance',
354 'CreateRenderPass',
355 'CreateGraphicsPipelines',
356 'CreateComputePipelines',
357 'CmdPipelineBarrier',
358 'CmdWaitEvents',
359 'CmdBeginRenderPass',
360 'EnumeratePhysicalDevices',
361 'FreeMemory',
362 'FreeDescriptorSets',
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600363 'QueueSubmit',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600364 'FlushMappedMemoryRanges',
Jon Ashburn71654fd2015-09-11 09:18:44 -0600365 'GetDeviceProcAddr',
Jon Ashburn71654fd2015-09-11 09:18:44 -0600366 'GetInstanceProcAddr',
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -0600367 'EnumerateInstanceExtensionProperties',
368 'EnumerateDeviceExtensionProperties',
369 'EnumerateInstanceLayerProperties',
370 'EnumerateDeviceLayerProperties',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600371 'GetPhysicalDeviceQueueFamilyProperties',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600372 'GetQueryPoolResults',
373 'MapMemory',
374 'UnmapMemory',
375 'UpdateDescriptorSets',
Ian Elliott338dedb2015-08-21 15:09:33 -0600376 'GetSurfacePropertiesKHR',
377 'GetSurfaceFormatsKHR',
378 'GetSurfacePresentModesKHR',
379 'CreateSwapchainKHR',
380 'GetSwapchainImagesKHR',
381 'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600382 ]
383
384 # validate the manually_written_hooked_funcs list
385 protoFuncs = [proto.name for proto in self.protos]
386 for func in manually_written_hooked_funcs:
387 if func not in protoFuncs:
388 sys.exit("Entry '%s' in manually_written_hooked_funcs list is not in the vulkan function prototypes" % func)
389
390 # process each of the entrypoint prototypes
Jon Ashburncb622a12015-08-06 17:22:53 -0600391 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800392 if ext.name.lower() == extensionName.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600393 for proto in ext.protos:
394 if proto.name in manually_written_hooked_funcs:
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600395 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 -0600396 else:
397 raw_packet_update_list = [] # non-ptr elements placed directly into packet
398 ptr_packet_update_list = [] # ptr elements to be updated into packet
399 return_txt = ''
400 packet_size = []
401 in_data_size = False # flag when we need to capture local input size variable for in/out size
402 func_body.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600403 func_body.append('VKTRACER_EXPORT %s VKAPI __HOOKED_vk%s(' % (proto.ret, proto.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600404 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 +0800405 func_body.append(' %s,' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600406 if '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
407 if 'pDataSize' in p.name:
408 in_data_size = True;
409 elif 'pfnMsgCallback' == p.name:
410 raw_packet_update_list.append(' PFN_vkDbgMsgCallback* pNonConstCallback = (PFN_vkDbgMsgCallback*)&pPacket->pfnMsgCallback;')
411 raw_packet_update_list.append(' *pNonConstCallback = pfnMsgCallback;')
Chia-I Wua5cd6532015-10-28 18:31:57 +0800412 elif '[' in p.ty:
413 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 -0600414 else:
415 raw_packet_update_list.append(' pPacket->%s = %s;' % (p.name, p.name))
416 # Get list of packet size modifiers due to ptr params
Chia-I Wu1f851912015-10-27 18:04:07 +0800417 packet_size = self._get_packet_size(extensionName, proto.params)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600418 ptr_packet_update_list = self._get_packet_ptr_param_list(proto.params)
419 func_body[-1] = func_body[-1].replace(',', ')')
420 # End of function declaration portion, begin function body
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600421 func_body.append('{\n vktrace_trace_packet_header* pHeader;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600422 if 'void' not in proto.ret or '*' in proto.ret:
423 func_body.append(' %s result;' % proto.ret)
424 return_txt = 'result = '
425 if in_data_size:
426 func_body.append(' size_t _dataSize;')
427 func_body.append(' packet_vk%s* pPacket = NULL;' % proto.name)
Jon Ashburnf6754d42015-09-14 16:48:31 -0600428 if proto.name == "DestroyInstance" or proto.name == "DestroyDevice":
429 func_body.append(' dispatch_key key = get_dispatch_key(%s);' % proto.params[0].name)
430
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600431 if (0 == len(packet_size)):
432 func_body.append(' CREATE_TRACE_PACKET(vk%s, 0);' % (proto.name))
433 else:
434 func_body.append(' CREATE_TRACE_PACKET(vk%s, %s);' % (proto.name, ' + '.join(packet_size)))
435
Jon Ashburn71654fd2015-09-11 09:18:44 -0600436 # call down the layer chain and get return value (if there is one)
437 # Note: this logic doesn't work for CreateInstance or CreateDevice but those are handwritten
Chia-I Wu1f851912015-10-27 18:04:07 +0800438 if extensionName == 'vk_debug_marker_lunarg':
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600439 table_txt = 'mdd(%s)->debugMarkerTable' % proto.params[0].name
Jon Ashburn71654fd2015-09-11 09:18:44 -0600440 elif proto.params[0].ty in ['VkInstance', 'VkPhysicalDevice']:
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600441 table_txt = 'mid(%s)->instTable' % proto.params[0].name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600442 else:
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600443 table_txt = 'mdd(%s)->devTable' % proto.params[0].name
Jon Ashburn71654fd2015-09-11 09:18:44 -0600444 func_body.append(' %s%s.%s;' % (return_txt, table_txt, proto.c_call()))
445 func_body.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600446
447 if in_data_size:
448 func_body.append(' _dataSize = (pDataSize == NULL || pData == NULL) ? 0 : *pDataSize;')
449 func_body.append(' pPacket = interpret_body_as_vk%s(pHeader);' % proto.name)
450 func_body.append('\n'.join(raw_packet_update_list))
451 for pp_dict in ptr_packet_update_list: #buff_ptr_indices:
452 func_body.append(' %s;' % (pp_dict['add_txt']))
453 if 'void' not in proto.ret or '*' in proto.ret:
454 func_body.append(' pPacket->result = result;')
455 for pp_dict in ptr_packet_update_list:
456 if ('DeviceCreateInfo' not in proto.params[pp_dict['index']].ty):
457 func_body.append(' %s;' % (pp_dict['finalize_txt']))
458 # All buffers should be finalized by now, and the trace packet can be finished (which sends it over the socket)
459 func_body.append(' FINISH_TRACE_PACKET();')
Jon Ashburnf6754d42015-09-14 16:48:31 -0600460 if proto.name == "DestroyInstance":
461 func_body.append(' g_instanceDataMap.erase(key);')
462 elif proto.name == "DestroyDevice":
463 func_body.append(' g_deviceDataMap.erase(key);')
464
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600465 # return result if needed
466 if 'void' not in proto.ret or '*' in proto.ret:
467 func_body.append(' return result;')
468 func_body.append('}\n')
469 return "\n".join(func_body)
470
471 def _generate_packet_id_enum(self):
472 pid_enum = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600473 pid_enum.append('enum VKTRACE_TRACE_PACKET_ID_VK')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600474 pid_enum.append('{')
475 first_func = True
476 for proto in self.protos:
477 if first_func:
478 first_func = False
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600479 pid_enum.append(' VKTRACE_TPI_VK_vkApiVersion = VKTRACE_TPI_BEGIN_API_HERE,')
480 pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600481 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600482 pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600483 pid_enum.append('};\n')
484 return "\n".join(pid_enum)
485
486 def _generate_packet_id_name_func(self):
487 func_body = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600488 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 -0600489 func_body.append('{')
490 func_body.append(' switch(id) {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600491 func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600492 func_body.append(' {')
493 func_body.append(' return "vkApiVersion";')
494 func_body.append(' }')
495 for proto in self.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600496 func_body.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600497 func_body.append(' {')
498 func_body.append(' return "vk%s";' % proto.name)
499 func_body.append(' }')
500 func_body.append(' default:')
501 func_body.append(' return NULL;')
502 func_body.append(' }')
503 func_body.append('}\n')
504 return "\n".join(func_body)
505
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600506 def _generate_interp_func(self):
507 interp_func_body = []
508 interp_func_body.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600509 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 -0600510 interp_func_body.append('{')
511 interp_func_body.append(' if (pHeader == NULL)')
512 interp_func_body.append(' {')
513 interp_func_body.append(' return NULL;')
514 interp_func_body.append(' }')
515 interp_func_body.append(' switch (pHeader->packet_id)')
516 interp_func_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600517 interp_func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600518 interp_func_body.append(' {')
519 interp_func_body.append(' return interpret_body_as_vkApiVersion(pHeader)->header;')
520 interp_func_body.append(' }')
521 for proto in self.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600522 interp_func_body.append(' case VKTRACE_TPI_VK_vk%s:\n {' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600523 header_prefix = 'h'
Ian Elliott338dedb2015-08-21 15:09:33 -0600524 if 'KHR' in proto.name or 'Dbg' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600525 header_prefix = 'pH'
526 interp_func_body.append(' return interpret_body_as_vk%s(pHeader)->%seader;\n }' % (proto.name, header_prefix))
527 interp_func_body.append(' default:')
528 interp_func_body.append(' return NULL;')
529 interp_func_body.append(' }')
530 interp_func_body.append(' return NULL;')
531 interp_func_body.append('}')
532 return "\n".join(interp_func_body)
533
534 def _generate_struct_util_funcs(self):
535 lineinfo = self.lineinfo
536 pid_enum = []
537 pid_enum.append('%s' % lineinfo.get())
538 pid_enum.append('//=============================================================================')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600539 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 -0600540 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600541 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkApplicationInfo), pInStruct);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800542 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 -0600543 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 +0800544 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pApplicationName));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600545 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pEngineName));')
546 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&*ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600547 pid_enum.append('};\n')
548 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600549 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 -0600550 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600551 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkInstanceCreateInfo), pInStruct);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800552 pid_enum.append(' add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&((*ppStruct)->pApplicationInfo), pInStruct->pApplicationInfo);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600553 # TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
554 pid_enum.append(' uint32_t i, siz = 0;')
Chia-I Wu763a7492015-10-26 20:48:51 +0800555 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerNameCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
556 pid_enum.append(' if (pInStruct->enabledLayerNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600557 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800558 pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600559 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600560 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
561 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600562 pid_enum.append(' }')
563 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600564 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800565 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionNameCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
566 pid_enum.append(' if (pInStruct->enabledExtensionNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600567 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800568 pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600569 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600570 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
571 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600572 pid_enum.append(' }')
573 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600574 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
575 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600576 pid_enum.append('}\n')
577 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600578 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 -0600579 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600580 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkDeviceCreateInfo), pInStruct);')
Courtney Goeltzenleuchterdfd53f52015-10-15 16:58:44 -0600581 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 -0600582 pid_enum.append(' for (uint32_t i = 0; i < pInStruct->requestedQueueCount; i++) {')
583 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pRequestedQueues[i].pQueuePriorities,')
Chia-I Wu763a7492015-10-26 20:48:51 +0800584 pid_enum.append(' pInStruct->pRequestedQueues[i].queuePriorityCount*sizeof(float),')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600585 pid_enum.append(' pInStruct->pRequestedQueues[i].pQueuePriorities);')
Jon Ashburne27a9182015-10-16 17:50:47 -0600586 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pRequestedQueues[i].pQueuePriorities);')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600587 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600588 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pRequestedQueues);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600589 # TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
590 pid_enum.append(' uint32_t i, siz = 0;')
Chia-I Wu763a7492015-10-26 20:48:51 +0800591 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerNameCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
592 pid_enum.append(' if (pInStruct->enabledLayerNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600593 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800594 pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600595 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600596 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
597 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600598 pid_enum.append(' }')
599 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600600 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800601 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionNameCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
602 pid_enum.append(' if (pInStruct->enabledExtensionNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600603 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800604 pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600605 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600606 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
607 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600608 pid_enum.append(' }')
609 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600610 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
611 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pEnabledFeatures, sizeof(VkPhysicalDeviceFeatures), pInStruct->pEnabledFeatures);')
612 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pEnabledFeatures);')
613 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600614 pid_enum.append('}\n')
615 pid_enum.append('%s' % lineinfo.get())
616 pid_enum.append('//=============================================================================\n')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600617 pid_enum.append('static VkInstanceCreateInfo* interpret_VkInstanceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600618 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600619 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 -0600620 pid_enum.append(' uint32_t i;')
621 pid_enum.append(' if (pVkInstanceCreateInfo != NULL)')
622 pid_enum.append(' {')
Chia-I Wu1f851912015-10-27 18:04:07 +0800623 pid_enum.append(' pVkInstanceCreateInfo->pApplicationInfo = (VkApplicationInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo);')
624 pid_enum.append(' VkApplicationInfo** ppApplicationInfo = (VkApplicationInfo**) &pVkInstanceCreateInfo->pApplicationInfo;')
625 pid_enum.append(' (*ppApplicationInfo)->pApplicationName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo->pApplicationName);')
626 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 +0800627 pid_enum.append(' if (pVkInstanceCreateInfo->enabledLayerNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600628 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600629 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 +0800630 pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledLayerNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600631 pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledLayerNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600632 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600633 pid_enum.append(' }')
634 pid_enum.append(' }')
Chia-I Wu763a7492015-10-26 20:48:51 +0800635 pid_enum.append(' if (pVkInstanceCreateInfo->enabledExtensionNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600636 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600637 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 +0800638 pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledExtensionNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600639 pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledExtensionNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600640 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600641 pid_enum.append(' }')
642 pid_enum.append(' }')
643 pid_enum.append(' }\n')
644 pid_enum.append(' return pVkInstanceCreateInfo;')
645 pid_enum.append('}\n')
646 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600647 pid_enum.append('static VkDeviceCreateInfo* interpret_VkDeviceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600648 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600649 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 -0600650 pid_enum.append(' uint32_t i;')
651 pid_enum.append(' if (pVkDeviceCreateInfo != NULL)')
652 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600653 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 +0800654 pid_enum.append(' if (pVkDeviceCreateInfo->enabledLayerNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600655 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600656 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 +0800657 pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledLayerNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600658 pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledLayerNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600659 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600660 pid_enum.append(' }')
661 pid_enum.append(' }')
Chia-I Wu763a7492015-10-26 20:48:51 +0800662 pid_enum.append(' if (pVkDeviceCreateInfo->enabledExtensionNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600663 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600664 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 +0800665 pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledExtensionNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600666 pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledExtensionNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600667 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600668 pid_enum.append(' }')
669 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600670 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 -0600671 pid_enum.append(' }\n')
672 pid_enum.append(' return pVkDeviceCreateInfo;')
673 pid_enum.append('}\n')
674 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600675 pid_enum.append('static void interpret_VkPipelineShaderStageCreateInfo(vktrace_trace_packet_header* pHeader, VkPipelineShaderStageCreateInfo* pShader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600676 pid_enum.append('{')
677 pid_enum.append(' if (pShader != NULL)')
678 pid_enum.append(' {')
Chia-I Wu062ad152015-10-31 00:31:16 +0800679 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 -0600680 pid_enum.append(' // specialization info')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600681 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 -0600682 pid_enum.append(' if (pShader->pSpecializationInfo != NULL)')
683 pid_enum.append(' {')
684 pid_enum.append(' VkSpecializationInfo* pInfo = (VkSpecializationInfo*)pShader->pSpecializationInfo;')
Chia-I Wu483e7702015-10-26 17:20:32 +0800685 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 -0600686 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 -0600687 pid_enum.append(' }')
688 pid_enum.append(' }')
689 pid_enum.append('}\n')
690 pid_enum.append('//=============================================================================')
691 return "\n".join(pid_enum)
692
693 # Interpret functions used on replay to read in packets and interpret their contents
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -0600694 # This code gets generated into vktrace_vk_vk_packets.h file
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600695 def _generate_interp_funcs(self):
696 # Custom txt for given function and parameter. First check if param is NULL, then insert txt if not
697 # First some common code used by both CmdWaitEvents & CmdPipelineBarrier
698 mem_barrier_interp = ['uint32_t i = 0;\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800699 'for (i = 0; i < pPacket->memoryBarrierCount; i++) {\n',
700 ' void** ppMB = (void**)&(pPacket->ppMemoryBarriers[i]);\n',
701 ' *ppMB = vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppMemoryBarriers[i]);\n',
702 ' //VkMemoryBarrier* pBarr = (VkMemoryBarrier*)pPacket->ppMemoryBarriers[i];\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600703 ' // TODO : Could fix up the pNext ptrs here if they were finalized and if we cared by switching on Barrier type and remapping\n',
704 '}']
705 create_rp_interp = ['VkRenderPassCreateInfo* pInfo = (VkRenderPassCreateInfo*)pPacket->pCreateInfo;\n',
706 'uint32_t i = 0;\n',
707 'VkAttachmentDescription **ppAD = (VkAttachmentDescription **)&(pInfo->pAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600708 '*ppAD = (VkAttachmentDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600709 'VkSubpassDescription** ppSP = (VkSubpassDescription**)&(pInfo->pSubpasses);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600710 '*ppSP = (VkSubpassDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600711 'for (i=0; i<pInfo->subpassCount; i++) {\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600712 ' VkAttachmentReference** pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pInputAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600713 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pInputAttachments);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600714 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pColorAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600715 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pColorAttachments);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600716 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pResolveAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600717 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pResolveAttachments);\n',
Chia-I Wuce532f72015-10-26 17:32:47 +0800718 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
719 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600720 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pPreserveAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600721 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pPreserveAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600722 '}\n',
723 'VkSubpassDependency** ppSD = (VkSubpassDependency**)&(pInfo->pDependencies);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600724 '*ppSD = (VkSubpassDependency*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pDependencies);\n']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600725 create_gfx_pipe = ['uint32_t i;\n',
726 'uint32_t j;\n',
Chia-I Wu763a7492015-10-26 20:48:51 +0800727 'for (i=0; i<pPacket->createInfoCount; i++) {\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600728 'if (pPacket->pCreateInfos[i].sType == VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO) {\n',
729 '// need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
730 'VkGraphicsPipelineCreateInfo* pNonConst = (VkGraphicsPipelineCreateInfo*)&(pPacket->pCreateInfos[i]);\n',
731 '// shader stages array\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600732 'pNonConst->pStages = (VkPipelineShaderStageCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pStages);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600733 'for (j = 0; j < pPacket->pCreateInfos[i].stageCount; j++)\n',
734 '{\n',
735 ' interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)&pPacket->pCreateInfos[i].pStages[j]);\n',
736 '}\n',
737 '// Vertex Input State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600738 'pNonConst->pVertexInputState = (VkPipelineVertexInputStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600739 'VkPipelineVertexInputStateCreateInfo* pNonConstVIState = (VkPipelineVertexInputStateCreateInfo*)pNonConst->pVertexInputState;\n',
740 'if (pNonConstVIState) {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600741 ' pNonConstVIState->pVertexBindingDescriptions = (const VkVertexInputBindingDescription*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState->pVertexBindingDescriptions);\n',
742 ' 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 -0600743 '}\n',
744 '// Input Assembly State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600745 '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 -0600746 '// Tesselation State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600747 '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 -0600748 '// Viewport State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600749 '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 -0600750 '// Raster State\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800751 '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 -0600752 '// MultiSample State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600753 '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 -0600754 '// DepthStencil State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600755 '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 -0600756 '// DynamicState State\n',
757 'pNonConst->pDynamicState = (const VkPipelineDynamicStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState);\n',
758 'VkPipelineDynamicStateCreateInfo* pNonConstDyState = (VkPipelineDynamicStateCreateInfo*)pNonConst->pDynamicState;\n',
759 'if (pNonConstDyState) {\n',
760 ' pNonConstDyState->pDynamicStates = (const VkDynamicState*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState->pDynamicStates);\n',
761 '}\n',
762
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600763 '// ColorBuffer State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600764 '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 -0600765 'VkPipelineColorBlendStateCreateInfo* pNonConstCbState = (VkPipelineColorBlendStateCreateInfo*)pNonConst->pColorBlendState;\n',
766 'if (pNonConstCbState)\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600767 ' 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 -0600768 '} else {\n',
769 ' // This is unexpected.\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600770 ' vktrace_LogError("CreateGraphicsPipelines must have CreateInfo stype of VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600771 ' pPacket->header = NULL;\n',
772 '}\n',
773 '}\n']
774 # 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
775 # 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 +0800776 custom_case_dict = { #'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkFramebufferCreateInfo* pInfo = (VkFramebufferCreateInfo*)pPacket->pCreateInfo;\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600777 # 'pInfo->pColorAttachments = (VkColorAttachmentBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pColorAttachments);\n',
778 # 'pInfo->pDepthStencilAttachment = (VkDepthStencilBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pDepthStencilAttachment);\n']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600779 'CreateRenderPass' : {'param': 'pCreateInfo', 'txt': create_rp_interp},
780 'CreatePipelineLayout' : {'param': 'pCreateInfo', 'txt': ['VkPipelineLayoutCreateInfo* pInfo = (VkPipelineLayoutCreateInfo*)pPacket->pCreateInfo;\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600781 'pInfo->pSetLayouts = (VkDescriptorSetLayout*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pSetLayouts);\n']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600782 'CreateDescriptorPool' : {'param': 'pCreateInfo', 'txt': ['VkDescriptorPoolCreateInfo* pInfo = (VkDescriptorPoolCreateInfo*)pPacket->pCreateInfo;\n',
Chia-I Wuc51b1212015-10-27 19:25:11 +0800783 'pInfo->pPoolSizes = (VkDescriptorPoolSize*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pPoolSizes);\n']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800784 'CmdWaitEvents' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
785 'CmdPipelineBarrier' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600786 'CreateDescriptorSetLayout' : {'param': 'pCreateInfo', 'txt': ['if (pPacket->pCreateInfo->sType == VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO) {\n',
787 ' VkDescriptorSetLayoutCreateInfo* pNext = (VkDescriptorSetLayoutCreateInfo*)pPacket->pCreateInfo;\n',
788 ' do\n',' {\n',
789 ' // need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
790 ' void** ppNextVoidPtr = (void**)&(pNext->pNext);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600791 ' *ppNextVoidPtr = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600792 ' switch(pNext->sType)\n', ' {\n',
793 ' case VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO:\n',
794 ' {\n' ,
795 ' unsigned int i = 0;\n',
Chia-I Wuf03cbf72015-10-31 00:31:16 +0800796 ' pNext->pBinding = (VkDescriptorSetLayoutBinding*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBinding);\n',
Chia-I Wu763a7492015-10-26 20:48:51 +0800797 ' for (i = 0; i < pNext->bindingCount; i++)\n',' {\n',
Chia-I Wuf03cbf72015-10-31 00:31:16 +0800798 ' VkSampler** ppSamplers = (VkSampler**)&(pNext->pBinding[i].pImmutableSamplers);\n',
799 ' *ppSamplers = (VkSampler*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBinding[i].pImmutableSamplers);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600800 ' }\n',
801 ' break;\n',
802 ' }\n',
803 ' default:\n',
804 ' {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600805 ' vktrace_LogError("Encountered an unexpected type in descriptor set layout create list.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600806 ' pPacket->header = NULL;\n',
807 ' pNext->pNext = NULL;\n',
808 ' }\n',
809 ' }\n',
810 ' pNext = (VkDescriptorSetLayoutCreateInfo*)pNext->pNext;\n',
811 ' } while (NULL != pNext);\n',
812 '} else {\n',
813 ' // This is unexpected.\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600814 ' vktrace_LogError("CreateDescriptorSetLayout must have pCreateInfo->stype of VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600815 ' pPacket->header = NULL;\n',
816 '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800817# 'BeginCommandBuffer' : {'param': 'pBeginInfo', 'txt': ['if (pPacket->pBeginInfo->sType == VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO) {\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600818# ' // 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 +0800819# ' VkCommandBufferGraphicsBeginInfo** ppNext = (VkCommandBufferGraphicsBeginInfo**)&(pPacket->pBeginInfo->pNext);\n',
820# ' *ppNext = (VkCommandBufferGraphicsBeginInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pBeginInfo->pNext);\n',
821# ' VkCommandBufferGraphicsBeginInfo* pNext = *ppNext;\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600822# ' while (NULL != pNext)\n', ' {\n',
823# ' switch(pNext->sType)\n', ' {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800824# ' case VK_STRUCTURE_TYPE_COMMAND_BUFFER_GRAPHICS_BEGIN_INFO:\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600825# ' {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800826# ' ppNext = (VkCommandBufferGraphicsBeginInfo**) &pNext->pNext;\n',
827# ' *ppNext = (VkCommandBufferGraphicsBeginInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600828# ' break;\n',
829# ' }\n',
830# ' default:\n',
831# ' {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600832# ' vktrace_LogError("Encountered an unexpected type in begin command buffer list.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600833# ' pPacket->header = NULL;\n',
834# ' pNext->pNext = NULL;\n',
835# ' }\n',
836# ' }\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800837# ' pNext = (VkCommandBufferGraphicsBeginInfo*)pNext->pNext;\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600838# ' }\n',
839# '} else {\n',
840# ' // This is unexpected.\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800841# ' vktrace_LogError("BeginCommandBuffer must have BeginInfo stype of VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600842# ' pPacket->header = NULL;\n',
843# '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800844 'AllocateMemory' : {'param': 'pAllocateInfo', 'txt': ['if (pPacket->pAllocateInfo->sType == VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO) {\n',
845 ' VkMemoryAllocateInfo** ppNext = (VkMemoryAllocateInfo**) &(pPacket->pAllocateInfo->pNext);\n',
846 ' *ppNext = (VkMemoryAllocateInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pAllocateInfo->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600847 '} else {\n',
848 ' // This is unexpected.\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800849 ' vktrace_LogError("AllocateMemory must have AllocInfo stype of VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600850 ' pPacket->header = NULL;\n',
851 '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800852 'AllocateDescriptorSets' : {'param': 'pAllocateInfo', 'txt':
853 ['VkDescriptorSetLayout **ppDescSetLayout = (VkDescriptorSetLayout **) &pPacket->pAllocateInfo->pSetLayouts;\n'
854 ' *ppDescSetLayout = (VkDescriptorSetLayout *) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pAllocateInfo->pSetLayouts));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600855 'UpdateDescriptorSets' : {'param': 'pDescriptorWrites', 'txt':
856 [ 'uint32_t i;\n',
Chia-I Wu483e7702015-10-26 17:20:32 +0800857 'for (i = 0; i < pPacket->descriptorWriteCount; i++) {\n',
Courtney Goeltzenleuchter34aa5c82015-10-23 13:38:14 -0600858 ' switch (pPacket->pDescriptorWrites[i].descriptorType) {',
859 ' case VK_DESCRIPTOR_TYPE_SAMPLER:',
860 ' case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:',
861 ' case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:',
862 ' case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:',
863 ' {',
864 ' VkDescriptorImageInfo** ppImageInfo = (VkDescriptorImageInfo**)&pPacket->pDescriptorWrites[i].pImageInfo;\n',
865 ' *ppImageInfo = (VkDescriptorImageInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pImageInfo);\n',
866 ' }',
867 ' break;',
868 ' case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:',
869 ' case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:',
870 ' {',
871 ' VkBufferView** ppTexelBufferView = (VkBufferView**)&pPacket->pDescriptorWrites[i].pTexelBufferView;\n',
872 ' *ppTexelBufferView = (VkBufferView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pTexelBufferView);\n',
873 ' }',
874 ' break;',
875 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:',
876 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:',
877 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:',
878 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:',
879 ' {',
880 ' VkDescriptorBufferInfo** ppBufferInfo = (VkDescriptorBufferInfo**)&pPacket->pDescriptorWrites[i].pBufferInfo;\n',
881 ' *ppBufferInfo = (VkDescriptorBufferInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pBufferInfo);\n',
882 ' }',
883 ' break;',
884 ' default:',
885 ' break;',
886 ' }',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600887 '}'
888 ]},
Chia-I Wu483e7702015-10-26 17:20:32 +0800889 'QueueSubmit' : {'param': 'pSubmits', 'txt':
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600890 [ 'uint32_t i;\n',
891 'for (i = 0; i < pPacket->submitCount; i++) {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800892 ' VkCommandBuffer** ppCBs = (VkCommandBuffer**)&pPacket->pSubmits[i].pCommandBuffers;\n',
893 ' *ppCBs = (VkCommandBuffer*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pCommandBuffers);\n',
Chia-I Wu483e7702015-10-26 17:20:32 +0800894 ' VkSemaphore** ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pWaitSemaphores;\n',
895 ' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pWaitSemaphores);\n',
896 ' ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pSignalSemaphores;\n',
897 ' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pSignalSemaphores);\n',
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600898 '}'
899 ]},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600900 'CreateGraphicsPipelines' : {'param': 'pCreateInfos', 'txt': create_gfx_pipe},
901 'CreateComputePipeline' : {'param': 'pCreateInfo', 'txt': ['interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)(&pPacket->pCreateInfo->cs));']},
Courtney Goeltzenleuchter1856d6f2015-09-01 17:30:39 -0600902 'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkImageView** ppAV = (VkImageView**)&(pPacket->pCreateInfo->pAttachments);\n',
903 '*ppAV = (VkImageView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pAttachments));']},
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600904 'CmdBeginRenderPass' : {'param': 'pRenderPassBegin', 'txt': ['VkClearValue** ppCV = (VkClearValue**)&(pPacket->pRenderPassBegin->pClearValues);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600905 '*ppCV = (VkClearValue*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pRenderPassBegin->pClearValues));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600906 'CreateShaderModule' : {'param': 'pCreateInfo', 'txt': ['void** ppCode = (void**)&(pPacket->pCreateInfo->pCode);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600907 '*ppCode = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pCode);']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600908 'FlushMappedMemoryRanges' : {'param': 'ppData', 'txt': ['uint32_t i = 0;\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800909 'for (i = 0; i < pPacket->memoryRangeCount; i++)\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600910 '{\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600911 ' pPacket->ppData[i] = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppData[i]);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600912 '}']}}
913 if_body = []
914 if_body.append('typedef struct packet_vkApiVersion {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600915 if_body.append(' vktrace_trace_packet_header* header;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600916 if_body.append(' uint32_t version;')
917 if_body.append('} packet_vkApiVersion;\n')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600918 if_body.append('static packet_vkApiVersion* interpret_body_as_vkApiVersion(vktrace_trace_packet_header* pHeader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600919 if_body.append('{')
920 if_body.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)pHeader->pBody;')
921 if_body.append(' pPacket->header = pHeader;')
922 if_body.append(' return pPacket;')
923 if_body.append('}\n')
924 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -0600925 if 'KHR' not in proto.name and 'Dbg' not in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600926 if 'UnmapMemory' == proto.name:
927 proto.params.append(vulkan.Param("void*", "pData"))
928 elif 'FlushMappedMemoryRanges' == proto.name:
929 proto.params.append(vulkan.Param("void**", "ppData"))
930 if_body.append('%s' % self.lineinfo.get())
931 if_body.append('typedef struct packet_vk%s {' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600932 if_body.append(' vktrace_trace_packet_header* header;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600933 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +0800934 if_body.append(' %s;' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600935 if 'void' != proto.ret:
936 if_body.append(' %s result;' % proto.ret)
937 if_body.append('} packet_vk%s;\n' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600938 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 -0600939 if_body.append('{')
940 if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
941 if_body.append(' pPacket->header = pHeader;')
942 for p in proto.params:
943 if '*' in p.ty:
944 if 'DeviceCreateInfo' in p.ty:
945 if_body.append(' pPacket->%s = interpret_VkDeviceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
946 elif 'InstanceCreateInfo' in p.ty:
947 if_body.append(' pPacket->%s = interpret_VkInstanceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
948 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600949 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 -0600950 # TODO : Generalize this custom code to kill dict data struct above.
951 # Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
952 if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
953 if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
954 if_body.append(' {')
955 if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
956 if_body.append(' }')
957 if_body.append(' return pPacket;')
958 if_body.append('}\n')
959 return "\n".join(if_body)
960
Chia-I Wu1f851912015-10-27 18:04:07 +0800961 def _generate_interp_funcs_ext(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600962 if_body = []
Ian Elliott338dedb2015-08-21 15:09:33 -0600963 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 -0600964 'pPacket->pPresentInfo->imageIndices = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->imageIndices));']},
Ian Elliott338dedb2015-08-21 15:09:33 -0600965 'CreateSwapchainKHR' : {'param': 'pCreateInfo', 'txt': ['VkSurfaceDescriptionKHR **ppSurfDescp = (VkSurfaceDescriptionKHR**)&pPacket->pCreateInfo->pSurfaceDescription;\n',
Jon Ashburnc51afc72015-08-11 16:01:35 -0600966 'uint32_t **ppQFI = (uint32_t**)&pPacket->pCreateInfo->pQueueFamilyIndices;\n',
Ian Elliott338dedb2015-08-21 15:09:33 -0600967 '(*ppSurfDescp) = (VkSurfaceDescriptionKHR*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pSurfaceDescription));\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600968 '(*ppQFI) = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pQueueFamilyIndices));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600969 }
Jon Ashburncb622a12015-08-06 17:22:53 -0600970 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800971 if ext.name.lower() == extensionName.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600972 for proto in ext.protos:
973 if_body.append('typedef struct packet_vk%s {' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600974 if_body.append(' vktrace_trace_packet_header* pHeader;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600975 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +0800976 if_body.append(' %s;' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600977 if 'void' != proto.ret:
978 if_body.append(' %s result;' % proto.ret)
979 if_body.append('} packet_vk%s;\n' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600980 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 -0600981 if_body.append('{')
982 if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
983 if_body.append(' pPacket->pHeader = pHeader;')
984 for p in proto.params:
985 if '*' in p.ty:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600986 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 -0600987 # TODO : Generalize this custom code to kill dict data struct above.
988 # Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
989 if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
990 if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
991 if_body.append(' {')
992 if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
993 if_body.append(' }')
994 if_body.append(' return pPacket;')
995 if_body.append('}\n')
996 return "\n".join(if_body)
997
998 def _generate_replay_func_ptrs(self):
999 xf_body = []
1000 xf_body.append('struct vkFuncs {')
1001 xf_body.append(' void init_funcs(void * libHandle);')
1002 xf_body.append(' void *m_libHandle;\n')
1003 for proto in self.protos:
1004 xf_body.append(' typedef %s( VKAPI * type_vk%s)(' % (proto.ret, proto.name))
1005 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +08001006 xf_body.append(' %s,' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001007 xf_body[-1] = xf_body[-1].replace(',', ');')
1008 xf_body.append(' type_vk%s real_vk%s;' % (proto.name, proto.name))
1009 xf_body.append('};')
1010 return "\n".join(xf_body)
1011
1012 def _map_decl(self, type1, type2, name):
1013 return ' std::map<%s, %s> %s;' % (type1, type2, name)
1014
1015 def _add_to_map_decl(self, type1, type2, name):
1016 txt = ' void add_to_%s_map(%s pTraceVal, %s pReplayVal)\n {\n' % (name[2:], type1, type2)
1017 #TODO138 : These checks need to vary between disp & non-disp objects
1018 #txt += ' assert(pTraceVal != 0);\n'
1019 #txt += ' assert(pReplayVal != 0);\n'
1020 txt += ' %s[pTraceVal] = pReplayVal;\n }\n' % name
1021 return txt
1022
1023 def _rm_from_map_decl(self, ty, name):
1024 txt = ' void rm_from_%s_map(const %s& key)\n {\n' % (name[2:], ty)
1025 txt += ' %s.erase(key);\n }\n' % name
1026 return txt
1027
1028 def _remap_decl(self, ty, name):
1029 txt = ' %s remap_%s(const %s& value)\n {\n' % (ty, name[2:], ty)
1030 txt += ' if (value == 0) { return 0; }\n'
1031 txt += ' std::map<%s, %s>::const_iterator q = %s.find(value);\n' % (ty, ty, name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001032 txt += ' if (q == %s.end()) { vktrace_LogError("Failed to remap %s."); return value; }\n' % (name, ty)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001033 txt += ' return q->second;\n }\n'
1034 return txt
1035
1036 def _generate_replay_objMemory_funcs(self):
1037 rof_body = []
1038 # Custom code for memory mapping functions for app writes into mapped memory
1039 rof_body.append('// memory mapping functions for app writes into mapped memory')
1040 rof_body.append(' bool isPendingAlloc()')
1041 rof_body.append(' {')
1042 rof_body.append(' return m_pendingAlloc;')
1043 rof_body.append(' }')
1044 rof_body.append('')
Chia-I Wu1f851912015-10-27 18:04:07 +08001045 rof_body.append(' void setAllocInfo(const VkMemoryAllocateInfo *info, const bool pending)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001046 rof_body.append(' {')
1047 rof_body.append(' m_pendingAlloc = pending;')
1048 rof_body.append(' m_allocInfo = *info;')
1049 rof_body.append(' }')
1050 rof_body.append('')
1051 rof_body.append(' void setMemoryDataAddr(void *pBuf)')
1052 rof_body.append(' {')
1053 rof_body.append(' if (m_mapRange.empty())')
1054 rof_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001055 rof_body.append(' vktrace_LogError("gpuMemory::setMemoryDataAddr() m_mapRange is empty.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001056 rof_body.append(' return;')
1057 rof_body.append(' }')
1058 rof_body.append(' MapRange mr = m_mapRange.back();')
1059 rof_body.append(' if (mr.pData != NULL)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001060 rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() data already mapped overwrite old mapping.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001061 rof_body.append(' else if (pBuf == NULL)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001062 rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() adding NULL pointer.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001063 rof_body.append(' mr.pData = (uint8_t *) pBuf;')
1064 rof_body.append(' }')
1065 rof_body.append('')
1066 rof_body.append(' void setMemoryMapRange(void *pBuf, const size_t size, const size_t offset, const bool pending)')
1067 rof_body.append(' {')
1068 rof_body.append(' MapRange mr;')
1069 rof_body.append(' mr.pData = (uint8_t *) pBuf;')
1070 rof_body.append(' if (size == 0)')
1071 rof_body.append(' mr.size = m_allocInfo.allocationSize - offset;')
1072 rof_body.append(' else')
1073 rof_body.append(' mr.size = size;')
1074 rof_body.append(' mr.offset = offset;')
1075 rof_body.append(' mr.pending = pending;')
1076 rof_body.append(' m_mapRange.push_back(mr);')
1077 rof_body.append(' assert(m_allocInfo.allocationSize >= (size + offset));')
1078 rof_body.append(' }')
1079 rof_body.append('')
1080 rof_body.append(' void copyMappingData(const void* pSrcData, bool entire_map, size_t size, size_t offset)')
1081 rof_body.append(' {')
1082 rof_body.append(' if (m_mapRange.empty())')
1083 rof_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001084 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() m_mapRange is empty.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001085 rof_body.append(' return;')
1086 rof_body.append(' }')
1087 rof_body.append(' MapRange mr = m_mapRange.back();')
1088 rof_body.append(' if (!pSrcData || !mr.pData)')
1089 rof_body.append(' {')
1090 rof_body.append(' if (!pSrcData)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001091 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null src pointer.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001092 rof_body.append(' else')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001093 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null dest pointer totalSize=%u.", m_allocInfo.allocationSize);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001094 rof_body.append(' m_mapRange.pop_back();')
1095 rof_body.append(' return;')
1096 rof_body.append(' }')
1097 rof_body.append(' if (entire_map)')
1098 rof_body.append(' {')
1099 rof_body.append(' size = mr.size;')
1100 rof_body.append(' offset = mr.offset;')
1101 rof_body.append(' }')
1102 rof_body.append(' else')
1103 rof_body.append(' {')
1104 rof_body.append(' assert(offset >= mr.offset);')
1105 rof_body.append(' assert(size <= mr.size && (size + offset) <= mr.size);')
1106 rof_body.append(' }')
1107 rof_body.append(' memcpy(mr.pData + offset, pSrcData, size);')
1108 rof_body.append(' if (!mr.pending && entire_map)')
1109 rof_body.append(' m_mapRange.pop_back();')
1110 rof_body.append(' }')
1111 rof_body.append('')
1112 rof_body.append(' size_t getMemoryMapSize()')
1113 rof_body.append(' {')
1114 rof_body.append(' return (!m_mapRange.empty()) ? m_mapRange.back().size : 0;')
1115 rof_body.append(' }\n')
1116 return "\n".join(rof_body)
1117
1118 def _generate_replay_objmapper_class(self):
1119 # Create dict mapping member var names to VK type (i.e. 'm_imageViews' : 'VkImage_VIEW')
1120 obj_map_dict = {}
1121 for obj in vulkan.object_type_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001122 if (obj.startswith('Vk')):
1123 mem_var = obj.replace('Vk', '').lower()
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001124 mem_var_list = mem_var.split('_')
1125 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 -06001126 obj_map_dict[mem_var] = obj
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001127 rc_body = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001128 rc_body.append('#define VKTRACE_VK_OBJECT_TYPE_UNKNOWN (VkObjectType)-1')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001129 rc_body.append('')
1130 rc_body.append('typedef struct _VKAllocInfo {')
1131 rc_body.append(' VkDeviceSize size;')
1132 rc_body.append(' uint8_t *pData;')
1133 rc_body.append(' bool rangeUpdated;')
1134 rc_body.append('} VKAllocInfo;')
1135 rc_body.append('')
1136 rc_body.append('class objMemory {')
1137 rc_body.append('public:')
1138 rc_body.append(' objMemory() : m_numAllocations(0), m_pMemReqs(NULL) {}')
1139 rc_body.append(' ~objMemory() { free(m_pMemReqs);}')
1140 rc_body.append(' void setCount(const uint32_t num)')
1141 rc_body.append(' {')
1142 rc_body.append(' m_numAllocations = num;')
1143 rc_body.append(' }\n')
1144 rc_body.append(' void setReqs(const VkMemoryRequirements *pReqs, const uint32_t num)')
1145 rc_body.append(' {')
1146 rc_body.append(' if (m_numAllocations != num && m_numAllocations != 0)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001147 rc_body.append(' vktrace_LogError("objMemory::setReqs, internal mismatch on number of allocations.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001148 rc_body.append(' if (m_pMemReqs == NULL && pReqs != NULL)')
1149 rc_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001150 rc_body.append(' m_pMemReqs = (VkMemoryRequirements *) vktrace_malloc(num * sizeof(VkMemoryRequirements));')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001151 rc_body.append(' if (m_pMemReqs == NULL)')
1152 rc_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001153 rc_body.append(' vktrace_LogError("objMemory::setReqs out of memory.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001154 rc_body.append(' return;')
1155 rc_body.append(' }')
1156 rc_body.append(' memcpy(m_pMemReqs, pReqs, num * sizeof(VkMemoryRequirements));')
1157 rc_body.append(' }')
1158 rc_body.append(' }\n')
1159 rc_body.append('private:')
1160 rc_body.append(' uint32_t m_numAllocations;')
1161 rc_body.append(' VkMemoryRequirements *m_pMemReqs;')
1162 rc_body.append('};')
1163 rc_body.append('')
1164 rc_body.append('class gpuMemory {')
1165 rc_body.append('public:')
1166 rc_body.append(' gpuMemory() : m_pendingAlloc(false) {m_allocInfo.allocationSize = 0;}')
1167 rc_body.append(' ~gpuMemory() {}')
1168 rc_body.append(self._generate_replay_objMemory_funcs())
1169 rc_body.append('private:')
1170 rc_body.append(' bool m_pendingAlloc;')
1171 rc_body.append(' struct MapRange {')
1172 rc_body.append(' bool pending;')
1173 rc_body.append(' size_t size;')
1174 rc_body.append(' size_t offset;')
1175 rc_body.append(' uint8_t* pData;')
1176 rc_body.append(' };')
1177 rc_body.append(' std::vector<MapRange> m_mapRange;')
Chia-I Wu1f851912015-10-27 18:04:07 +08001178 rc_body.append(' VkMemoryAllocateInfo m_allocInfo;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001179 rc_body.append('};')
1180 rc_body.append('')
1181 rc_body.append('typedef struct _imageObj {')
1182 rc_body.append(' objMemory imageMem;')
1183 rc_body.append(' VkImage replayImage;')
1184 rc_body.append(' } imageObj;')
1185 rc_body.append('')
1186 rc_body.append('typedef struct _bufferObj {')
1187 rc_body.append(' objMemory bufferMem;')
1188 rc_body.append(' VkBuffer replayBuffer;')
1189 rc_body.append(' } bufferObj;')
1190 rc_body.append('')
1191 rc_body.append('typedef struct _gpuMemObj {')
1192 rc_body.append(' gpuMemory *pGpuMem;')
1193 rc_body.append(' VkDeviceMemory replayGpuMem;')
1194 rc_body.append(' } gpuMemObj;')
1195 rc_body.append('')
1196 rc_body.append('')
1197 rc_body.append('class vkReplayObjMapper {')
1198 rc_body.append('public:')
1199 rc_body.append(' vkReplayObjMapper() {}')
1200 rc_body.append(' ~vkReplayObjMapper() {}')
1201 rc_body.append('')
1202 rc_body.append(' bool m_adjustForGPU; // true if replay adjusts behavior based on GPU')
1203 # Code for memory objects for handling replay GPU != trace GPU object memory requirements
1204 rc_body.append('void init_objMemCount(const uint64_t handle, const VkDbgObjectType objectType, const uint32_t &num)\n {')
1205 rc_body.append(' switch (objectType) {')
1206 rc_body.append(' case VK_OBJECT_TYPE_BUFFER:')
1207 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001208 rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001209 rc_body.append(' if (it != m_buffers.end()) {')
1210 rc_body.append(' objMemory obj = it->second.bufferMem;')
1211 rc_body.append(' obj.setCount(num);')
1212 rc_body.append(' return;')
1213 rc_body.append(' }')
1214 rc_body.append(' break;')
1215 rc_body.append(' }')
1216 rc_body.append(' case VK_OBJECT_TYPE_IMAGE:')
1217 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001218 rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001219 rc_body.append(' if (it != m_images.end()) {')
1220 rc_body.append(' objMemory obj = it->second.imageMem;')
1221 rc_body.append(' obj.setCount(num);')
1222 rc_body.append(' return;')
1223 rc_body.append(' }')
1224 rc_body.append(' break;')
1225 rc_body.append(' }')
1226 rc_body.append(' default:')
1227 rc_body.append(' break;')
1228 rc_body.append(' }')
1229 rc_body.append(' return;')
1230 rc_body.append('}\n')
1231 rc_body.append('void init_objMemReqs(const uint64_t handle, const VkDbgObjectType objectType, const VkMemoryRequirements *pMemReqs, const unsigned int num)\n {')
1232 rc_body.append(' switch (objectType) {')
1233 rc_body.append(' case VK_OBJECT_TYPE_BUFFER:')
1234 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001235 rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001236 rc_body.append(' if (it != m_buffers.end()) {')
1237 rc_body.append(' objMemory obj = it->second.bufferMem;')
1238 rc_body.append(' obj.setReqs(pMemReqs, num);')
1239 rc_body.append(' return;')
1240 rc_body.append(' }')
1241 rc_body.append(' break;')
1242 rc_body.append(' }')
1243 rc_body.append(' case VK_OBJECT_TYPE_IMAGE:')
1244 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001245 rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001246 rc_body.append(' if (it != m_images.end()) {')
1247 rc_body.append(' objMemory obj = it->second.imageMem;')
1248 rc_body.append(' obj.setReqs(pMemReqs, num);')
1249 rc_body.append(' return;')
1250 rc_body.append(' }')
1251 rc_body.append(' break;')
1252 rc_body.append(' }')
1253 rc_body.append(' default:')
1254 rc_body.append(' break;')
1255 rc_body.append(' }')
1256 rc_body.append(' return;')
1257 rc_body.append(' }')
1258 rc_body.append('')
1259 rc_body.append(' void clear_all_map_handles()\n {')
1260 for var in sorted(obj_map_dict):
1261 rc_body.append(' %s.clear();' % var)
1262 rc_body.append(' }\n')
Jon Ashburncb622a12015-08-06 17:22:53 -06001263 disp_obj_types = [obj for obj in vulkan.object_dispatch_list]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001264 for var in sorted(obj_map_dict):
Chia-I Wue420a332015-10-26 20:04:44 +08001265 if obj_map_dict[var] == 'VkImage':
1266 rc_body.append(self._map_decl('VkImage', 'imageObj', var))
1267 rc_body.append(self._add_to_map_decl('VkImage', 'imageObj', var))
1268 rc_body.append(self._rm_from_map_decl('VkImage', var))
1269 rc_body.append(' VkImage remap_images(const VkImage& value)')
1270 rc_body.append(' {')
1271 rc_body.append(' if (value == 0) { return 0; }')
1272 rc_body.append('')
1273 rc_body.append(' std::map<VkImage, imageObj>::const_iterator q = m_images.find(value);')
1274 rc_body.append(' if (q == m_images.end()) { vktrace_LogError("Failed to remap VkImage."); return value; }\n')
1275 rc_body.append(' return q->second.replayImage;')
1276 rc_body.append(' }\n')
1277 elif obj_map_dict[var] == 'VkBuffer':
1278 rc_body.append(self._map_decl('VkBuffer', 'bufferObj', var))
1279 rc_body.append(self._add_to_map_decl('VkBuffer', 'bufferObj', var))
1280 rc_body.append(self._rm_from_map_decl('VkBuffer', var))
1281 rc_body.append(' VkBuffer remap_buffers(const VkBuffer& value)')
1282 rc_body.append(' {')
1283 rc_body.append(' if (value == 0) { return 0; }')
1284 rc_body.append('')
1285 rc_body.append(' std::map<VkBuffer, bufferObj>::const_iterator q = m_buffers.find(value);')
1286 rc_body.append(' if (q == m_buffers.end()) { vktrace_LogError("Failed to remap VkBuffer."); return value; }\n')
1287 rc_body.append(' return q->second.replayBuffer;')
1288 rc_body.append(' }\n')
1289 elif obj_map_dict[var] == 'VkDeviceMemory':
1290 rc_body.append(self._map_decl('VkDeviceMemory', 'gpuMemObj', var))
1291 rc_body.append(self._add_to_map_decl('VkDeviceMemory', 'gpuMemObj', var))
1292 rc_body.append(self._rm_from_map_decl('VkDeviceMemory', var))
1293 rc_body.append(' VkDeviceMemory remap_devicememorys(const VkDeviceMemory& value)')
1294 rc_body.append(' {')
1295 rc_body.append(' if (value == 0) { return 0; }')
1296 rc_body.append('')
1297 rc_body.append(' std::map<VkDeviceMemory, gpuMemObj>::const_iterator q = m_devicememorys.find(value);')
1298 rc_body.append(' if (q == m_devicememorys.end()) { vktrace_LogError("Failed to remap VkDeviceMemory."); return value; }')
1299 rc_body.append(' return q->second.replayGpuMem;')
1300 rc_body.append(' }\n')
1301 else:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001302 rc_body.append(self._map_decl(obj_map_dict[var], obj_map_dict[var], var))
1303 rc_body.append(self._add_to_map_decl(obj_map_dict[var], obj_map_dict[var], var))
1304 rc_body.append(self._rm_from_map_decl(obj_map_dict[var], var))
1305 rc_body.append(self._remap_decl(obj_map_dict[var], var))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001306 # VkDynamicStateObject code
1307# TODO138 : Each dynamic state object is now unique so need to make sure their re-mapping is being handled correctly
1308# state_obj_remap_types = vulkan.object_dynamic_state_list
1309# state_obj_bindings = vulkan.object_dynamic_state_bind_point_list
1310# rc_body.append(' VkDynamicStateObject remap(const VkDynamicStateObject& state, const VkStateBindPoint& bindPoint)\n {')
1311# rc_body.append(' VkDynamicStateObject obj;')
1312# index = 0
1313# while index < len(state_obj_remap_types):
1314# obj = state_obj_remap_types[index]
1315# type = state_obj_bindings[index]
1316# rc_body.append(' if (bindPoint == %s) {' % type)
1317# rc_body.append(' if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
1318# rc_body.append(' return obj;')
1319# rc_body.append(' }')
1320# index += 1
1321# for obj in state_obj_remap_types:
1322# rc_body.append('// if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
1323# rc_body.append('// return obj;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001324# rc_body.append(' vktrace_LogWarning("Failed to remap VkDynamicStateObject.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001325# rc_body.append(' return VK_NULL_HANDLE;\n }')
1326# rc_body.append(' void rm_from_map(const VkDynamicStateObject& state)\n {')
1327# for obj in state_obj_remap_types:
1328# rc_body.append(' rm_from_map(static_cast <%s> (state));' % obj.type)
1329# rc_body.append(' }')
1330# rc_body.append('')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001331 rc_body.append('};')
1332 return "\n".join(rc_body)
1333
1334 def _generate_replay_init_funcs(self):
1335 rif_body = []
1336 rif_body.append('void vkFuncs::init_funcs(void * handle)\n{\n m_libHandle = handle;')
1337 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001338 if 'KHR' not in proto.name and 'Dbg' not in proto.name:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001339 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 -06001340 else: # These func ptrs get assigned at GetProcAddr time
1341 rif_body.append(' real_vk%s = (type_vk%s)NULL;' % (proto.name, proto.name))
1342 rif_body.append('}')
1343 return "\n".join(rif_body)
1344
Jon Ashburnc736c002015-10-25 20:24:57 -06001345 def _remap_packet_param(self, funcName, paramType, paramName, lastName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001346 remap_list = vulkan.object_type_list
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001347 param_exclude_list = ['pDescriptorSets', 'pFences']
1348 cleanParamType = paramType.strip('*').replace('const ', '')
Jon Ashburncb622a12015-08-06 17:22:53 -06001349 VulkNonDispObjects = [o for o in vulkan.object_non_dispatch_list]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001350 for obj in remap_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001351 if obj == cleanParamType and paramName not in param_exclude_list:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001352 objectTypeRemapParam = ''
1353 if 'VkDynamicStateObject' == cleanParamType:
1354 objectTypeRemapParam = ', pPacket->stateBindPoint'
1355 elif 'object' == paramName:
1356 if 'DbgSetObjectTag' == funcName:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001357 objectTypeRemapParam = ', VKTRACE_VK_OBJECT_TYPE_UNKNOWN'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001358 else:
1359 objectTypeRemapParam = ', pPacket->objType'
1360 elif 'srcObject' == paramName and 'Callback' in funcName:
1361 objectTypeRemapParam = ', pPacket->objType'
Jon Ashburnc736c002015-10-25 20:24:57 -06001362 pArray = ''
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001363 if '*' in paramType:
Jon Ashburnc736c002015-10-25 20:24:57 -06001364 if 'const' not in paramType:
1365 result = ' %s remapped%s = m_objMapper.remap_%ss(*pPacket->%s%s);\n' % (cleanParamType, paramName, paramName.lower(), paramName, objectTypeRemapParam)
1366 result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
1367 result += ' {\n'
1368 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1369 result += ' }\n'
1370 return result
1371 else:
1372 if lastName == '':
1373 return ' // pPacket->%s should have been remapped with special case code' % (paramName)
1374 pArray = '[pPacket->%s]' % lastName
Courtney Goeltzenleuchter5970b252015-10-27 11:32:31 -06001375 result = ' %s *remapped%s = new %s%s;\n' % (cleanParamType, paramName, cleanParamType, pArray)
Jon Ashburnc736c002015-10-25 20:24:57 -06001376 result += '%s\n' % self.lineinfo.get()
1377 result += ' for (uint32_t i = 0; i < pPacket->%s; i++) {\n' % lastName
Chia-I Wue420a332015-10-26 20:04:44 +08001378 result += ' remapped%s[i] = m_objMapper.remap_%ss(pPacket->%s[i]%s);\n' % (paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
1379 result += ' if (pPacket->%s[i] != VK_NULL_HANDLE && remapped%s[i] == VK_NULL_HANDLE)\n' % (paramName, paramName)
Jon Ashburnc736c002015-10-25 20:24:57 -06001380 result += ' {\n'
1381 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1382 result += ' }\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001383 result += ' }\n'
1384 return result
Jon Ashburnc736c002015-10-25 20:24:57 -06001385
Chia-I Wue420a332015-10-26 20:04:44 +08001386 result = ' %s remapped%s = m_objMapper.remap_%ss(pPacket->%s%s);\n' % (paramType, paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
1387 result += '%s\n' % self.lineinfo.get()
1388 result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
1389 result += ' {\n'
1390 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1391 result += ' }\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001392 return result
1393 return ' // No need to remap %s' % (paramName)
1394
1395 def _get_packet_param(self, funcName, paramType, paramName):
1396 # list of types that require remapping
1397 remap_list = vulkan.object_type_list
1398 param_exclude_list = ['pDescriptorSets', 'pFences']
1399 cleanParamType = paramType.strip('*').replace('const ', '')
1400 for obj in remap_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001401 if obj == cleanParamType and paramName not in param_exclude_list:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001402 objectTypeRemapParam = ''
1403 if 'object' == paramName:
1404 if 'DbgSetObjectTag' == funcName:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001405 objectTypeRemapParam = ', VKTRACE_VK_OBJECT_TYPE_UNKNOWN'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001406 else:
1407 objectTypeRemapParam = ', pPacket->objType'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001408 return 'remapped%s' % (paramName)
1409 return 'pPacket->%s' % (paramName)
1410
1411 def _gen_replay_create_image(self):
1412 ci_body = []
1413 ci_body.append(' imageObj local_imageObj;')
1414 ci_body.append(' VkDevice remappedDevice = m_objMapper.remap_devices(pPacket->device);')
1415 ci_body.append(' if (remappedDevice == VK_NULL_HANDLE)')
1416 ci_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001417 ci_body.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001418 ci_body.append(' }')
Chia-I Wu69f40122015-10-26 21:10:41 +08001419 ci_body.append(' replayResult = m_vkFuncs.real_vkCreateImage(remappedDevice, pPacket->pCreateInfo, NULL, &local_imageObj.replayImage);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001420 ci_body.append(' if (replayResult == VK_SUCCESS)')
1421 ci_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001422 ci_body.append(' m_objMapper.add_to_images_map(*(pPacket->pImage), local_imageObj);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001423 ci_body.append(' }')
1424 return "\n".join(ci_body)
1425
1426 def _gen_replay_create_buffer(self):
1427 cb_body = []
1428 cb_body.append(' bufferObj local_bufferObj;')
1429 cb_body.append(' VkDevice remappedDevice = m_objMapper.remap_devices(pPacket->device);')
1430 cb_body.append(' if (remappedDevice == VK_NULL_HANDLE)')
1431 cb_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001432 cb_body.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001433 cb_body.append(' }')
Chia-I Wu69f40122015-10-26 21:10:41 +08001434 cb_body.append(' replayResult = m_vkFuncs.real_vkCreateBuffer(remappedDevice, pPacket->pCreateInfo, NULL, &local_bufferObj.replayBuffer);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001435 cb_body.append(' if (replayResult == VK_SUCCESS)')
1436 cb_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001437 cb_body.append(' m_objMapper.add_to_buffers_map(*(pPacket->pBuffer), local_bufferObj);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001438 cb_body.append(' }')
1439 return "\n".join(cb_body)
1440
1441 # Generate main replay case statements where actual replay API call is dispatched based on input packet data
1442 def _generate_replay(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001443 manually_replay_funcs = ['AllocateMemory',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001444 'BeginCommandBuffer',
1445 'CreateDescriptorSetLayout',
1446 'CreateDevice',
1447 'CreateFramebuffer',
1448 'CreateGraphicsPipelines',
1449 'CreateInstance',
1450 'CreatePipelineLayout',
1451 'CreateRenderPass',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001452 'CmdBeginRenderPass',
1453 'CmdBindDescriptorSets',
1454 'CmdBindVertexBuffers',
1455 'CmdPipelineBarrier',
Ian Elliott338dedb2015-08-21 15:09:33 -06001456 'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001457 'CmdWaitEvents',
1458 #'DestroyObject',
1459 'EnumeratePhysicalDevices',
1460 'FreeMemory',
1461 'FreeDescriptorSets',
1462 'FlushMappedMemoryRanges',
1463 #'GetGlobalExtensionInfo',
1464 #'GetImageSubresourceInfo',
1465 #'GetObjectInfo',
1466 #'GetPhysicalDeviceExtensionInfo',
Ian Elliott338dedb2015-08-21 15:09:33 -06001467 'GetPhysicalDeviceSurfaceSupportKHR',
1468 'GetSurfacePropertiesKHR',
1469 'GetSurfaceFormatsKHR',
1470 'GetSurfacePresentModesKHR',
1471 'CreateSwapchainKHR',
1472 'GetSwapchainImagesKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001473 #'GetPhysicalDeviceInfo',
1474 'MapMemory',
Ian Elliott338dedb2015-08-21 15:09:33 -06001475 #'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001476 'QueueSubmit',
1477 #'StorePipeline',
1478 'UnmapMemory',
1479 'UpdateDescriptorSets',
1480 'WaitForFences',
Jon Ashburncaae0492015-08-13 16:49:08 -06001481 'DbgCreateMsgCallback',
1482 'DbgDestroyMsgCallback',
Chia-I Wu1f851912015-10-27 18:04:07 +08001483 'AllocateCommandBuffers',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001484 ]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001485
1486 # validate the manually_replay_funcs list
1487 protoFuncs = [proto.name for proto in self.protos]
1488 for func in manually_replay_funcs:
1489 if func not in protoFuncs:
1490 sys.exit("Entry '%s' in manually_replay_funcs list is not in the vulkan function prototypes" % func)
1491
1492 # map protos to custom functions if body is fully custom
1493 custom_body_dict = {'CreateImage': self._gen_replay_create_image,
1494 'CreateBuffer': self._gen_replay_create_buffer }
1495 # multi-gpu Open funcs w/ list of local params to create
1496 custom_open_params = {'OpenSharedMemory': (-1,),
1497 'OpenSharedSemaphore': (-1,),
1498 'OpenPeerMemory': (-1,),
1499 'OpenPeerImage': (-1, -2,)}
1500 # Functions that create views are unique from other create functions
Courtney Goeltzenleuchter1856d6f2015-09-01 17:30:39 -06001501 create_view_list = ['CreateBufferView', 'CreateImageView', 'CreateComputePipeline']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001502 # Functions to treat as "Create' that don't have 'Create' in the name
Chia-I Wu1f851912015-10-27 18:04:07 +08001503 special_create_list = ['LoadPipeline', 'LoadPipelineDerivative', 'AllocateMemory', 'GetDeviceQueue', 'PinSystemMemory', 'AllocateDescriptorSets']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001504 # A couple funcs use do while loops
1505 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'}
1506 rbody = []
1507 rbody.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001508 rbody.append('vktrace_replay::VKTRACE_REPLAY_RESULT vkReplay::replay(vktrace_trace_packet_header *packet)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001509 rbody.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001510 rbody.append(' vktrace_replay::VKTRACE_REPLAY_RESULT returnValue = vktrace_replay::VKTRACE_REPLAY_SUCCESS;')
Courtney Goeltzenleuchterac544f32015-09-14 18:01:17 -06001511 rbody.append(' VkResult replayResult = VK_ERROR_VALIDATION_FAILED;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001512 rbody.append(' switch (packet->packet_id)')
1513 rbody.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001514 rbody.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001515 rbody.append(' {')
1516 rbody.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)(packet->pBody);')
1517 rbody.append(' if (pPacket->version != VK_API_VERSION)')
1518 rbody.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001519 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));')
1520 rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001521 rbody.append(' }')
1522 rbody.append(' break;')
1523 rbody.append(' }')
1524 for proto in self.protos:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001525 ret_value = False
1526 create_view = False
1527 create_func = False
1528 # TODO : How to handle void* return of GetProcAddr?
Jon Ashburnd7770ed2015-09-30 13:41:02 -06001529#TODO make sure vkDestroy object functions really do clean up the object maps
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001530 if ('void' not in proto.ret.lower()) and ('size_t' not in proto.ret) and (proto.name not in custom_body_dict):
1531 ret_value = True
1532 if proto.name in create_view_list:
1533 create_view = True
1534 elif 'Create' in proto.name or proto.name in special_create_list:
1535 create_func = True
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001536 rbody.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001537 rbody.append(' {')
1538 rbody.append(' packet_vk%s* pPacket = (packet_vk%s*)(packet->pBody);' % (proto.name, proto.name))
1539 if proto.name in manually_replay_funcs:
1540 if ret_value == True:
1541 rbody.append(' replayResult = manually_replay_vk%s(pPacket);' % proto.name)
1542 else:
1543 rbody.append(' manually_replay_vk%s(pPacket);' % proto.name)
1544 elif proto.name in custom_body_dict:
1545 rbody.append(custom_body_dict[proto.name]())
1546 else:
1547 if proto.name in custom_open_params:
1548 for pidx in custom_open_params[proto.name]:
1549 rbody.append(' %s local_%s;' % (proto.params[pidx].ty.replace('const ', '').strip('*'), proto.params[pidx].name))
1550 elif create_view:
1551 rbody.append(' %s createInfo;' % (proto.params[1].ty.strip('*').replace('const ', '')))
1552 rbody.append(' memcpy(&createInfo, pPacket->pCreateInfo, sizeof(%s));' % (proto.params[1].ty.strip('*').replace('const ', '')))
1553 if 'CreateComputePipeline' == proto.name:
Chia-I Wue420a332015-10-26 20:04:44 +08001554 rbody.append(' createInfo.cs.shader = m_objMapper.remap_shaders(pPacket->pCreateInfo->cs.shader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001555 elif 'CreateBufferView' == proto.name:
Chia-I Wue420a332015-10-26 20:04:44 +08001556 rbody.append(' createInfo.buffer = m_objMapper.remap_buffers(pPacket->pCreateInfo->buffer);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001557 else:
Chia-I Wue420a332015-10-26 20:04:44 +08001558 rbody.append(' createInfo.image = m_objMapper.remap_images(pPacket->pCreateInfo->image);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001559 rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
1560 elif create_func: # Declare local var to store created handle into
Chia-I Wu1f851912015-10-27 18:04:07 +08001561 if 'AllocateDescriptorSets' == proto.name:
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001562 p_ty = proto.params[-1].ty.strip('*').replace('const ', '')
Chia-I Wu1f851912015-10-27 18:04:07 +08001563 rbody.append(' %s* local_%s = (%s*)malloc(pPacket->pAllocateInfo->setLayoutCount * sizeof(%s));' % (p_ty, proto.params[-1].name, p_ty, p_ty))
1564 rbody.append(' VkDescriptorSetLayout* local_pSetLayouts = (VkDescriptorSetLayout*)malloc(pPacket->pAllocateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout));')
1565 rbody.append(' VkDescriptorSetAllocateInfo local_AllocInfo, *local_pAllocateInfo = &local_AllocInfo;')
Jon Ashburne27a9182015-10-16 17:50:47 -06001566 rbody.append(' VkDescriptorPool local_descPool;')
Chia-I Wu1f851912015-10-27 18:04:07 +08001567 rbody.append(' local_descPool = m_objMapper.remap_descriptorpools(pPacket->pAllocateInfo->descriptorPool);')
1568 rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->setLayoutCount; i++)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001569 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001570 rbody.append(' local_pSetLayouts[i] = m_objMapper.remap_descriptorsetlayouts(pPacket->%s->pSetLayouts[i]);' % (proto.params[-2].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001571 rbody.append(' }')
Chia-I Wu1f851912015-10-27 18:04:07 +08001572 rbody.append(' memcpy(local_pAllocateInfo, pPacket->pAllocateInfo, sizeof(VkDescriptorSetAllocateInfo));')
1573 rbody.append(' local_pAllocateInfo->pSetLayouts = local_pSetLayouts;')
1574 rbody.append(' local_pAllocateInfo->descriptorPool = local_descPool;')
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001575 else:
1576 rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001577 elif proto.name == 'ResetFences':
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001578 rbody.append(' VkFence* fences = VKTRACE_NEW_ARRAY(VkFence, pPacket->fenceCount);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001579 rbody.append(' for (uint32_t i = 0; i < pPacket->fenceCount; i++)')
1580 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001581 rbody.append(' fences[i] = m_objMapper.remap_fences(pPacket->%s[i]);' % (proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001582 rbody.append(' }')
1583 elif proto.name in do_while_dict:
1584 rbody.append(' do {')
Jon Ashburnc736c002015-10-25 20:24:57 -06001585 last_name = ''
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001586 for p in proto.params:
1587 if create_func or create_view:
1588 if p.name != proto.params[-1].name:
Jon Ashburnc736c002015-10-25 20:24:57 -06001589 rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001590 else:
Jon Ashburnc736c002015-10-25 20:24:57 -06001591 rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
1592 last_name = p.name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001593
1594 if proto.name == 'DestroyInstance':
1595 rbody.append(' if (m_vkFuncs.real_vkDbgDestroyMsgCallback != NULL)')
1596 rbody.append(' {')
1597 rbody.append(' m_vkFuncs.real_vkDbgDestroyMsgCallback(remappedinstance, m_dbgMsgCallbackObj);')
1598 rbody.append(' }')
1599 # TODO: need a better way to indicate which extensions should be mapped to which Get*ProcAddr
1600 elif proto.name == 'GetInstanceProcAddr':
1601 for iProto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001602 if 'Dbg' in iProto.name or 'GetPhysicalDeviceSurfaceSupportKHR' in iProto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001603 rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (iProto.name))
1604 rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappedinstance, pPacket->pName);' % (iProto.name, iProto.name, proto.name))
1605 rbody.append(' }')
1606 elif proto.name == 'GetDeviceProcAddr':
1607 for dProto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001608 if 'KHR' in dProto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001609 rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (dProto.name))
1610 rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappeddevice, pPacket->pName);' % (dProto.name, dProto.name, proto.name))
1611 rbody.append(' }')
1612
1613 # build the call to the "real_" entrypoint
1614 rr_string = ' '
1615 if ret_value:
1616 rr_string = ' replayResult = '
1617 rr_string += 'm_vkFuncs.real_vk%s(' % proto.name
1618 for p in proto.params:
1619 # For last param of Create funcs, pass address of param
1620 if create_func:
Chia-I Wu1f851912015-10-27 18:04:07 +08001621 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 -06001622 rr_string += 'local_%s, ' % p.name
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001623 elif p.name == proto.params[-1].name:
1624 rr_string += '&local_%s, ' % p.name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001625 else:
1626 rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
1627 else:
1628 rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
1629 rr_string = '%s);' % rr_string[:-2]
1630 if proto.name in custom_open_params:
1631 rr_list = rr_string.split(', ')
1632 for pidx in custom_open_params[proto.name]:
1633 rr_list[pidx] = '&local_%s' % proto.params[pidx].name
1634 rr_string = ', '.join(rr_list)
1635 rr_string += ');'
1636 elif create_view:
1637 rr_list = rr_string.split(', ')
Chia-I Wu69f40122015-10-26 21:10:41 +08001638 rr_list[-3] = '&createInfo'
1639 rr_list[-2] = 'NULL'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001640 rr_list[-1] = '&local_%s);' % proto.params[-1].name
1641 rr_string = ', '.join(rr_list)
1642 # this is a sneaky shortcut to use generic create code below to add_to_map
1643 create_func = True
Chia-I Wu1f851912015-10-27 18:04:07 +08001644 elif proto.name == 'AllocateDescriptorSets':
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001645 rr_string = rr_string.replace('pPacket->pSetLayouts', 'pLocalDescSetLayouts')
1646 elif proto.name == 'ResetFences':
1647 rr_string = rr_string.replace('pPacket->pFences', 'fences')
1648
1649 # insert the real_*(..) call
1650 rbody.append(rr_string)
1651
1652 # handle return values or anything that needs to happen after the real_*(..) call
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -06001653 get_ext_layers_proto = ['EnumerateInstanceExtensionProperties', 'EnumerateDeviceExtensionProperties','EnumerateInstanceLayerProperties', 'EnumerateDeviceLayerProperties']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001654 if 'DestroyDevice' in proto.name:
1655 rbody.append(' if (replayResult == VK_SUCCESS)')
1656 rbody.append(' {')
1657 rbody.append(' m_pCBDump = NULL;')
1658 rbody.append(' m_pDSDump = NULL;')
1659 #TODO138 : disabling snapshot
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001660 #rbody.append(' m_pVktraceSnapshotPrint = NULL;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001661 rbody.append(' m_objMapper.rm_from_devices_map(pPacket->device);')
1662 rbody.append(' m_display->m_initedVK = false;')
1663 rbody.append(' }')
Jon Ashburnc30315e2015-09-07 14:39:30 -06001664 elif proto.name in get_ext_layers_proto:
Courtney Goeltzenleuchterac544f32015-09-14 18:01:17 -06001665 rbody.append(' if (replayResult == VK_ERROR_LAYER_NOT_PRESENT || replayResult == VK_INCOMPLETE)')
Jon Ashburnc30315e2015-09-07 14:39:30 -06001666 rbody.append(' { // ignore errors caused by trace config != replay config')
1667 rbody.append(' replayResult = VK_SUCCESS;')
1668 rbody.append(' }')
Ian Elliott338dedb2015-08-21 15:09:33 -06001669 elif 'DestroySwapchainKHR' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001670 rbody.append(' if (replayResult == VK_SUCCESS)')
1671 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001672 rbody.append(' m_objMapper.rm_from_swapchainkhrs_map(pPacket->swapchain);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001673 rbody.append(' }')
1674 elif 'DestroyInstance' in proto.name:
1675 rbody.append(' if (replayResult == VK_SUCCESS)')
1676 rbody.append(' {')
1677 rbody.append(' // TODO need to handle multiple instances and only clearing maps within an instance.')
1678 rbody.append(' // TODO this only works with a single instance used at any given time.')
1679 rbody.append(' m_objMapper.clear_all_map_handles();')
1680 rbody.append(' }')
Courtney Goeltzenleuchter5970b252015-10-27 11:32:31 -06001681 elif 'MergePipelineCaches' in proto.name:
1682 rbody.append(' delete remappedpSrcCaches;')
1683 elif 'FreeCommandBuffers' in proto.name:
1684 rbody.append(' delete remappedpCommandBuffers;')
1685 elif 'CmdExecuteCommands' in proto.name:
Chia-I Wu1f851912015-10-27 18:04:07 +08001686 rbody.append(' delete remappedpCommandBuffers;')
1687 elif 'AllocateDescriptorSets' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001688 rbody.append(' if (replayResult == VK_SUCCESS)')
1689 rbody.append(' {')
Chia-I Wu1f851912015-10-27 18:04:07 +08001690 rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->setLayoutCount; i++) {')
Chia-I Wue420a332015-10-26 20:04:44 +08001691 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 -06001692 rbody.append(' }')
1693 rbody.append(' }')
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001694 rbody.append(' free(local_pSetLayouts);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001695 rbody.append(' free(local_pDescriptorSets);')
1696 elif proto.name == 'ResetFences':
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001697 rbody.append(' VKTRACE_DELETE(fences);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001698 elif create_func: # save handle mapping if create successful
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -06001699 if ret_value:
1700 rbody.append(' if (replayResult == VK_SUCCESS)')
1701 rbody.append(' {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001702 clean_type = proto.params[-1].ty.strip('*').replace('const ', '')
Jon Ashburncb622a12015-08-06 17:22:53 -06001703 VkNonDispObjType = [o for o in vulkan.object_non_dispatch_list]
Chia-I Wue420a332015-10-26 20:04:44 +08001704 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 +08001705 if 'AllocateMemory' == proto.name:
1706 rbody.append(' m_objMapper.add_entry_to_mapData(local_%s, pPacket->pAllocateInfo->allocationSize);' % (proto.params[-1].name))
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -06001707 if ret_value:
1708 rbody.append(' }')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001709 elif proto.name in do_while_dict:
1710 rbody[-1] = ' %s' % rbody[-1]
1711 rbody.append(' } while (%s);' % do_while_dict[proto.name])
1712 rbody.append(' if (pPacket->result != VK_NOT_READY || replayResult != VK_SUCCESS)')
1713 if ret_value:
1714 rbody.append(' CHECK_RETURN_VALUE(vk%s);' % proto.name)
1715 rbody.append(' break;')
1716 rbody.append(' }')
1717 rbody.append(' default:')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001718 rbody.append(' vktrace_LogWarning("Unrecognized packet_id %u, skipping.", packet->packet_id);')
1719 rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_INVALID_ID;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001720 rbody.append(' break;')
1721 rbody.append(' }')
1722 rbody.append(' return returnValue;')
1723 rbody.append('}')
1724 return "\n".join(rbody)
1725
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001726class VktraceTraceHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001727 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001728 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001729 header_txt.append('#include "vktrace_vk_vk_packets.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001730 header_txt.append('#include "vktrace_vk_packet_id.h"\n\n')
1731 header_txt.append('void InitTracer(void);\n\n')
1732 header_txt.append('#ifdef WIN32')
1733 header_txt.append('extern INIT_ONCE gInitOnce;')
1734 header_txt.append('\n#elif defined(PLATFORM_LINUX)')
1735 header_txt.append('extern pthread_once_t gInitOnce;')
1736 header_txt.append('#endif\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001737 return "\n".join(header_txt)
1738
1739 def generate_body(self):
Jon Ashburn71654fd2015-09-11 09:18:44 -06001740 body = [self._generate_trace_func_protos()]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001741
1742 return "\n".join(body)
1743
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001744class VktraceTraceC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001745 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001746 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001747 header_txt.append('#include "vktrace_platform.h"')
1748 header_txt.append('#include "vktrace_common.h"')
1749 header_txt.append('#include "vktrace_lib_helpers.h"')
1750 header_txt.append('#include "vktrace_vk_vk.h"')
1751 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001752 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001753 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain.h"')
1754 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001755 header_txt.append('#include "vktrace_interconnect.h"')
1756 header_txt.append('#include "vktrace_filelike.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001757 header_txt.append('#include "vk_struct_size_helper.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001758 header_txt.append('#ifdef PLATFORM_LINUX')
1759 header_txt.append('#include <pthread.h>')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001760 header_txt.append('#endif')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001761 header_txt.append('#include "vktrace_trace_packet_utils.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001762 header_txt.append('#include <stdio.h>\n')
Chia-I Wua5cd6532015-10-28 18:31:57 +08001763 header_txt.append('#include <string.h>\n')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001764 header_txt.append('#ifdef WIN32')
1765 header_txt.append('INIT_ONCE gInitOnce = INIT_ONCE_STATIC_INIT;')
1766 header_txt.append('#elif defined(PLATFORM_LINUX)')
1767 header_txt.append('pthread_once_t gInitOnce = PTHREAD_ONCE_INIT;')
1768 header_txt.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001769 return "\n".join(header_txt)
1770
1771 def generate_body(self):
Jon Ashburn71654fd2015-09-11 09:18:44 -06001772 body = [self._generate_init_funcs(),
Chia-I Wu1f851912015-10-27 18:04:07 +08001773 self._generate_trace_funcs(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001774
1775 return "\n".join(body)
1776
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001777class VktracePacketID(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001778 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001779 header_txt = []
1780 header_txt.append('#pragma once\n')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001781 header_txt.append('#include "vktrace_trace_packet_utils.h"')
1782 header_txt.append('#include "vktrace_trace_packet_identifiers.h"')
1783 header_txt.append('#include "vktrace_interconnect.h"')
1784 header_txt.append('#include "vktrace_vk_vk_packets.h"')
1785 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg_packets.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001786 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg_packets.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001787 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain_packets.h"')
1788 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain_packets.h"')
Jon Ashburncb622a12015-08-06 17:22:53 -06001789 #header_txt.append('#include "vk_enum_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001790 header_txt.append('#ifndef _WIN32')
1791 header_txt.append(' #pragma GCC diagnostic ignored "-Wwrite-strings"')
1792 header_txt.append('#endif')
Jon Ashburncb622a12015-08-06 17:22:53 -06001793 #header_txt.append('#include "vk_struct_string_helper.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001794 #header_txt.append('#include "vk_ext_khr_swapchain_struct_string_helper.h"')
1795 #header_txt.append('#include "vk_ext_khr_device_swapchain_struct_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001796 header_txt.append('#ifndef _WIN32')
1797 header_txt.append(' #pragma GCC diagnostic warning "-Wwrite-strings"')
1798 header_txt.append('#endif')
Ian Elliott338dedb2015-08-21 15:09:33 -06001799 #header_txt.append('#include "vk_ext_khr_swapchain_enum_string_helper.h"')
1800 #header_txt.append('#include "vk_ext_khr_device_swapchain_enum_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001801 header_txt.append('#if defined(WIN32)')
1802 header_txt.append('#define snprintf _snprintf')
1803 header_txt.append('#endif')
1804 header_txt.append('#define SEND_ENTRYPOINT_ID(entrypoint) ;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001805 header_txt.append('//#define SEND_ENTRYPOINT_ID(entrypoint) vktrace_TraceInfo(#entrypoint);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001806 header_txt.append('#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) ;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001807 header_txt.append('//#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) vktrace_TraceInfo(entrypoint, __VA_ARGS__);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001808 header_txt.append('#define CREATE_TRACE_PACKET(entrypoint, buffer_bytes_needed) \\')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001809 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 -06001810 header_txt.append('#define FINISH_TRACE_PACKET() \\')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001811 header_txt.append(' vktrace_finalize_trace_packet(pHeader); \\')
1812 header_txt.append(' vktrace_write_trace_packet(pHeader, vktrace_trace_get_trace_file()); \\')
1813 header_txt.append(' vktrace_delete_trace_packet(&pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001814 return "\n".join(header_txt)
1815
1816 def generate_body(self):
1817 body = [self._generate_packet_id_enum(),
1818 self._generate_packet_id_name_func(),
Jon Ashburncb622a12015-08-06 17:22:53 -06001819# self._generate_stringify_func(),
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001820 self._generate_interp_func()]
1821
1822 return "\n".join(body)
1823
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001824class VktraceCoreTracePackets(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001825 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001826 header_txt = []
1827 header_txt.append('#pragma once\n')
1828 header_txt.append('#include "vulkan.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001829 header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001830 return "\n".join(header_txt)
1831
1832 def generate_body(self):
1833 body = [self._generate_struct_util_funcs(),
1834 self._generate_interp_funcs()]
1835
1836 return "\n".join(body)
1837
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001838class VktraceExtTraceHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001839 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001840 header_txt = []
1841 header_txt.append('#pragma once\n')
1842 header_txt.append('#include "vulkan.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001843 header_txt.append('#include "%s.h"' % extensionName.lower())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001844 return "\n".join(header_txt)
1845
1846 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001847 body = [self._generate_trace_func_protos_ext(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001848
1849 return "\n".join(body)
1850
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001851class VktraceExtTraceC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001852 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001853 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001854 header_txt.append('#include "vktrace_platform.h"')
1855 header_txt.append('#include "vktrace_common.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001856 if extensionName == "vk_ext_khr_device_swapchain":
Ian Elliott338dedb2015-08-21 15:09:33 -06001857 header_txt.append('#include "vk_ext_khr_swapchain.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001858 header_txt.append('#include "vktrace_vk_%s.h"' % extensionName.lower())
1859 header_txt.append('#include "vktrace_vk_%s_packets.h"' % extensionName.lower())
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001860 header_txt.append('#include "vktrace_vk_packet_id.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001861 header_txt.append('#include "vk_struct_size_helper.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001862 header_txt.append('#include "%s_struct_size_helper.h"' % extensionName.lower())
1863 if extensionName == 'vk_debug_marker_lunarg':
Jon Ashburn71654fd2015-09-11 09:18:44 -06001864 header_txt.append('#include "vk_debug_marker_layer.h"\n')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001865
Jon Ashburn5afdcf62015-09-14 15:17:36 -06001866 header_txt.append('#include "vktrace_lib_helpers.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001867 return "\n".join(header_txt)
1868
1869 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001870 body = [self._generate_trace_funcs(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001871
1872 return "\n".join(body)
1873
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001874class VktraceExtTracePackets(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001875 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001876 header_txt = []
1877 header_txt.append('#pragma once\n')
Chia-I Wu1f851912015-10-27 18:04:07 +08001878 header_txt.append('#include "%s.h"' % extensionName.lower())
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001879 header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001880 return "\n".join(header_txt)
1881
1882 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001883 body = [self._generate_interp_funcs_ext(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001884
1885 return "\n".join(body)
1886
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001887class VktraceReplayVkFuncPtrs(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001888 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001889 header_txt = []
1890 header_txt.append('#pragma once\n')
1891 header_txt.append('#if defined(PLATFORM_LINUX) || defined(XCB_NVIDIA)')
1892 header_txt.append('#include <xcb/xcb.h>\n')
1893 header_txt.append('#endif')
1894 header_txt.append('#include "vulkan.h"')
1895 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001896 header_txt.append('#include "vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001897 header_txt.append('#include "vk_ext_khr_swapchain.h"')
1898 header_txt.append('#include "vk_ext_khr_device_swapchain.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001899
1900 def generate_body(self):
1901 body = [self._generate_replay_func_ptrs()]
1902 return "\n".join(body)
1903
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001904class VktraceReplayObjMapperHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001905 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001906 header_txt = []
1907 header_txt.append('#pragma once\n')
1908 header_txt.append('#include <set>')
1909 header_txt.append('#include <map>')
1910 header_txt.append('#include <vector>')
1911 header_txt.append('#include <string>')
1912 header_txt.append('#include "vulkan.h"')
1913 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001914 header_txt.append('#include "vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001915 header_txt.append('#include "vk_ext_khr_swapchain.h"')
1916 header_txt.append('#include "vk_ext_khr_device_swapchain.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001917 return "\n".join(header_txt)
1918
1919 def generate_body(self):
1920 body = [self._generate_replay_objmapper_class()]
1921 return "\n".join(body)
1922
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001923class VktraceReplayC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001924 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001925 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001926 header_txt.append('#include "vkreplay_vkreplay.h"\n')
1927 header_txt.append('#include "vkreplay.h"\n')
1928 header_txt.append('#include "vkreplay_main.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001929 header_txt.append('#include <algorithm>')
1930 header_txt.append('#include <queue>')
1931 header_txt.append('\n')
1932 header_txt.append('extern "C" {')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001933 header_txt.append('#include "vktrace_vk_vk_packets.h"')
1934 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg_packets.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001935 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg_packets.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001936 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain_packets.h"')
1937 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain_packets.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001938 header_txt.append('#include "vktrace_vk_packet_id.h"')
Jon Ashburncb622a12015-08-06 17:22:53 -06001939 #header_txt.append('#include "vk_enum_string_helper.h"\n}\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001940
1941 return "\n".join(header_txt)
1942
1943 def generate_body(self):
1944 body = [self._generate_replay_init_funcs(),
1945 self._generate_replay()]
Jon Ashburncb622a12015-08-06 17:22:53 -06001946 body.append("}")
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001947 return "\n".join(body)
1948
1949def main():
1950 subcommands = {
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001951 "vktrace-trace-h" : VktraceTraceHeader,
1952 "vktrace-trace-c" : VktraceTraceC,
1953 "vktrace-packet-id" : VktracePacketID,
1954 "vktrace-core-trace-packets" : VktraceCoreTracePackets,
1955 "vktrace-ext-trace-h" : VktraceExtTraceHeader,
1956 "vktrace-ext-trace-c" : VktraceExtTraceC,
1957 "vktrace-ext-trace-packets" : VktraceExtTracePackets,
1958 "vktrace-replay-vk-funcs" : VktraceReplayVkFuncPtrs,
1959 "vktrace-replay-obj-mapper-h" : VktraceReplayObjMapperHeader,
1960 "vktrace-replay-c" : VktraceReplayC,
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001961 }
1962
1963 if len(sys.argv) < 2 or sys.argv[1] not in subcommands:
1964 print("Usage: %s <subcommand> [options]" % sys.argv[0])
1965 print
1966 print("Available subcommands are: %s" % " ".join(subcommands))
1967 exit(1)
1968
1969 subcmd = subcommands[sys.argv[1]](sys.argv[2])
1970 subcmd.run()
1971
1972if __name__ == "__main__":
1973 main()