blob: 884fa4434bf64a67a2b2086364b7693abd519076 [file] [log] [blame]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001#!/usr/bin/env python3
2#
3# Vulkan
4#
5# Copyright (C) 2014 LunarG, Inc.
6#
7# Permission is hereby granted, free of charge, to any person obtaining a
8# copy of this software and associated documentation files (the "Software"),
9# to deal in the Software without restriction, including without limitation
10# the rights to use, copy, modify, merge, publish, distribute, sublicense,
11# and/or sell copies of the Software, and to permit persons to whom the
12# Software is furnished to do so, subject to the following conditions:
13#
14# The above copyright notice and this permission notice shall be included
15# in all copies or substantial portions of the Software.
16#
17# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
22# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23# DEALINGS IN THE SOFTWARE.
24#
25
26import os, sys
Jon Ashburncb622a12015-08-06 17:22:53 -060027
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060028
29# add main repo directory so vulkan.py can be imported. This needs to be a complete path.
Mark Lobodzinski87220f82015-08-27 15:30:29 -060030vktrace_scripts_path = os.path.dirname(os.path.abspath(__file__))
31main_path = os.path.abspath(vktrace_scripts_path + "/../")
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060032sys.path.append(main_path)
Jon Ashburncb622a12015-08-06 17:22:53 -060033from source_line_info import sourcelineinfo
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060034
Jon Ashburncb622a12015-08-06 17:22:53 -060035import vulkan
36
37# vulkan.py doesn't include all the extensions (debug_report missing)
38headers = []
39objects = []
40protos = []
41for ext in vulkan.extensions_all:
42 headers.extend(ext.headers)
43 objects.extend(ext.objects)
44 protos.extend(ext.protos)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060045
46class Subcommand(object):
47 def __init__(self, argv):
48 self.argv = argv
Chia-I Wu1f851912015-10-27 18:04:07 +080049 self.extensionName = argv
Jon Ashburncb622a12015-08-06 17:22:53 -060050 self.headers = headers
51 self.objects = objects
52 self.protos = protos
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060053 self.lineinfo = sourcelineinfo()
54
55 def run(self):
Chia-I Wu1f851912015-10-27 18:04:07 +080056 print(self.generate(self.extensionName))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060057
Chia-I Wu1f851912015-10-27 18:04:07 +080058 def generate(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060059 copyright = self.generate_copyright()
Chia-I Wu1f851912015-10-27 18:04:07 +080060 header = self.generate_header(extensionName)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -060061 body = self.generate_body()
62 footer = self.generate_footer()
63 contents = []
64 if copyright:
65 contents.append(copyright)
66 if header:
67 contents.append(header)
68 if body:
69 contents.append(body)
70 if footer:
71 contents.append(footer)
72
73 return "\n\n".join(contents)
74
75 def generate_copyright(self):
76 return """/* THIS FILE IS GENERATED. DO NOT EDIT. */
77
78/*
79 * Vulkan
80 *
81 * Copyright (C) 2014 LunarG, Inc.
82 *
83 * Permission is hereby granted, free of charge, to any person obtaining a
84 * copy of this software and associated documentation files (the "Software"),
85 * to deal in the Software without restriction, including without limitation
86 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
87 * and/or sell copies of the Software, and to permit persons to whom the
88 * Software is furnished to do so, subject to the following conditions:
89 *
90 * The above copyright notice and this permission notice shall be included
91 * in all copies or substantial portions of the Software.
92 *
93 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
94 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
95 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
96 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
97 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
98 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
99 * DEALINGS IN THE SOFTWARE.
100 */"""
101
Chia-I Wu1f851912015-10-27 18:04:07 +0800102 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600103 return "\n".join(["#include <" + h + ">" for h in self.headers])
104
105 def generate_body(self):
106 pass
107
108 def generate_footer(self):
109 pass
110
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600111 def _generate_trace_func_protos(self):
112 func_protos = []
Jon Ashburn4278f642015-09-11 13:12:02 -0600113 func_protos.append('#ifdef __cplusplus')
114 func_protos.append('extern"C" {')
115 func_protos.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600116 func_protos.append('// Hooked function prototypes\n')
117 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -0600118 if 'Dbg' not in proto.name and 'KHR' not in proto.name:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600119 func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600120
Jon Ashburn4278f642015-09-11 13:12:02 -0600121 func_protos.append('#ifdef __cplusplus')
122 func_protos.append('}')
123 func_protos.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600124 return "\n".join(func_protos)
125
Chia-I Wu1f851912015-10-27 18:04:07 +0800126 def _generate_trace_func_protos_ext(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600127 func_protos = []
128 func_protos.append('// Hooked function prototypes\n')
Jon Ashburncb622a12015-08-06 17:22:53 -0600129 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800130 if (extensionName.lower() == ext.name.lower()):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600131 for proto in ext.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600132 func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600133
134 return "\n".join(func_protos)
135
136
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600137 def _generate_init_funcs(self):
138 init_tracer = []
139 init_tracer.append('void send_vk_api_version_packet()\n{')
140 init_tracer.append(' packet_vkApiVersion* pPacket;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600141 init_tracer.append(' vktrace_trace_packet_header* pHeader;')
142 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 -0600143 init_tracer.append(' pPacket = interpret_body_as_vkApiVersion(pHeader);')
144 init_tracer.append(' pPacket->version = VK_API_VERSION;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600145 init_tracer.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600146 init_tracer.append(' FINISH_TRACE_PACKET();\n}\n')
147
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600148 init_tracer.append('extern VKTRACE_CRITICAL_SECTION g_memInfoLock;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600149 init_tracer.append('void InitTracer(void)\n{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600150 init_tracer.append(' const char *ipAddr = vktrace_get_global_var("VKTRACE_LIB_IPADDR");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600151 init_tracer.append(' if (ipAddr == NULL)')
152 init_tracer.append(' ipAddr = "127.0.0.1";')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600153 init_tracer.append(' gMessageStream = vktrace_MessageStream_create(FALSE, ipAddr, VKTRACE_BASE_PORT + VKTRACE_TID_VULKAN);')
154 init_tracer.append(' vktrace_trace_set_trace_file(vktrace_FileLike_create_msg(gMessageStream));')
155 init_tracer.append(' vktrace_tracelog_set_tracer_id(VKTRACE_TID_VULKAN);')
156 init_tracer.append(' vktrace_create_critical_section(&g_memInfoLock);')
Mark Lobodzinski48837d12015-09-28 12:08:57 -0600157 init_tracer.append(' if (gMessageStream != NULL)')
158 init_tracer.append(' send_vk_api_version_packet();\n}\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600159 return "\n".join(init_tracer)
160
161 # Take a list of params and return a list of dicts w/ ptr param details
162 def _get_packet_ptr_param_list(self, params):
163 ptr_param_list = []
164 # TODO : This is a slightly nicer way to handle custom cases than initial code, however
165 # this can still be further generalized to eliminate more custom code
166 # big case to handle is when ptrs to structs have embedded data that needs to be accounted for in packet
167 custom_ptr_dict = {'VkDeviceCreateInfo': {'add_txt': 'add_VkDeviceCreateInfo_to_packet(pHeader, (VkDeviceCreateInfo**) &(pPacket->pCreateInfo), pCreateInfo)',
168 'finalize_txt': ''},
Chia-I Wu1f851912015-10-27 18:04:07 +0800169 'VkApplicationInfo': {'add_txt': 'add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&(pPacket->pApplicationInfo), pApplicationInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600170 'finalize_txt': ''},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600171 'VkPhysicalDevice': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pGpus), *pGpuCount*sizeof(VkPhysicalDevice), pGpus)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600172 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600173 'pDataSize': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDataSize), sizeof(size_t), &_dataSize)',
174 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pDataSize))'},
175# 'pData': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pData), _dataSize, pData)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600176# 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600177 '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 -0600178 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600179 '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 -0600180 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600181 '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 -0600182 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600183 'pDescriptorSets': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDescriptorSets), customSize, pDescriptorSets)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600184 'finalize_txt': 'default'},
Chia-I Wu763a7492015-10-26 20:48:51 +0800185 'pSparseMemoryRequirements': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pSparseMemoryRequirements), (*pSparseMemoryRequirementCount) * sizeof(VkSparseImageMemoryRequirements), pSparseMemoryRequirements)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600186 'finalize_txt': 'default'},
Chia-I Wu763a7492015-10-26 20:48:51 +0800187 'VkSparseImageFormatProperties': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pProperties), (*pPropertyCount) * sizeof(VkSparseImageFormatProperties), pProperties)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600188 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600189 'VkSparseMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseMemoryBindInfo), pBindInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600190 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600191 'VkSparseImageMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseImageMemoryBindInfo), pBindInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600192 'finalize_txt': 'default'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600193 'VkFramebufferCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkFramebufferCreateInfo), pCreateInfo);\n'
194 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments), colorCount * sizeof(VkColorAttachmentBindInfo), pCreateInfo->pColorAttachments);\n'
195 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment), dsSize, pCreateInfo->pDepthStencilAttachment)',
196 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments));\n'
197 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment));\n'
198 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
199 'VkRenderPassCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkRenderPassCreateInfo), pCreateInfo);\n'
200 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats), colorCount * sizeof(VkFormat), pCreateInfo->pColorFormats);\n'
201 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts), colorCount * sizeof(VkImageLayout), pCreateInfo->pColorLayouts);\n'
202 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps), colorCount * sizeof(VkAttachmentLoadOp), pCreateInfo->pColorLoadOps);\n'
203 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps), colorCount * sizeof(VkAttachmentStoreOp), pCreateInfo->pColorStoreOps);\n'
204 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues), colorCount * sizeof(VkClearColor), pCreateInfo->pColorLoadClearValues)',
205 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats));\n'
206 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts));\n'
207 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps));\n'
208 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps));\n'
209 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues));\n'
210 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
211 '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 +0800212 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts), pCreateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout), pCreateInfo->pSetLayouts);',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600213 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts));\n'
214 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Chia-I Wu1f851912015-10-27 18:04:07 +0800215 'VkMemoryAllocateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo), sizeof(VkMemoryAllocateInfo), pAllocateInfo);\n'
216 ' add_alloc_memory_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo->pNext), pAllocateInfo->pNext)',
217 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pAllocateInfo))'},
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600218# '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 -0600219# ' add_VkGraphicsPipelineCreateInfos_to_trace_packet(pHeader, (VkGraphicsPipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600220# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
221# '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 -0600222# ' add_VkComputePipelineCreateInfos_to_trace_packet(pHeader, (VkComputePipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600223# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
224 '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 +0800225 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes), pCreateInfo->poolSizeCount * sizeof(VkDescriptorPoolSize), pCreateInfo->pPoolSizes)',
226 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes));\n'
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600227 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600228 'VkDescriptorSetLayoutCreateInfo': {'add_txt': 'add_create_ds_layout_to_trace_packet(pHeader, &pPacket->pCreateInfo, pCreateInfo)',
229 'finalize_txt': '// pCreateInfo finalized in add_create_ds_layout_to_trace_packet'},
Ian Elliott338dedb2015-08-21 15:09:33 -0600230 'VkSwapchainCreateInfoKHR': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkSwapchainCreateInfoKHR), pCreateInfo);\n'
231 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSurfaceDescription), sizeof(VkSurfaceDescriptionKHR), pCreateInfo->pSurfaceDescription)',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600232 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSurfaceDescription));\n'
233 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
234 'VkShaderModuleCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkShaderModuleCreateInfo), pCreateInfo);\n'
235 ' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pCode), pPacket->pCreateInfo->codeSize, pCreateInfo->pCode)',
236 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pCode));\n'
237 ' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600238 }
239
240 for p in params:
241 pp_dict = {}
Jon Ashburnbb4e7c12015-09-14 17:30:20 -0600242 if '*' in p.ty and p.name not in ['pTag', 'pUserData']:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600243 if 'const' in p.ty.lower() and 'count' in params[params.index(p)-1].name.lower():
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600244 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 -0600245 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 -0600246 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 -0600247 elif p.ty.strip('*').replace('const ', '') in custom_ptr_dict:
248 pp_dict['add_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['add_txt']
249 pp_dict['finalize_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['finalize_txt']
250 elif p.name in custom_ptr_dict:
251 pp_dict['add_txt'] = custom_ptr_dict[p.name]['add_txt']
252 pp_dict['finalize_txt'] = custom_ptr_dict[p.name]['finalize_txt']
253 # TODO : This is custom hack to account for 2 pData items with dataSize param for sizing
254 if 'pData' == p.name and 'dataSize' == params[params.index(p)-1].name:
255 pp_dict['add_txt'] = pp_dict['add_txt'].replace('_dataSize', 'dataSize')
Jon Ashburnbb4e7c12015-09-14 17:30:20 -0600256 elif 'void' in p.ty and (p.name == 'pData' or p.name == 'values'):
257 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)
258 pp_dict['finalize_txt'] = '//TODO FIXME vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600259 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600260 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 -0600261 if 'finalize_txt' not in pp_dict or 'default' == pp_dict['finalize_txt']:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600262 pp_dict['finalize_txt'] = 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600263 pp_dict['index'] = params.index(p)
264 ptr_param_list.append(pp_dict)
265 return ptr_param_list
266
267 # Take a list of params and return a list of packet size elements
Chia-I Wu1f851912015-10-27 18:04:07 +0800268 def _get_packet_size(self, extensionName, params):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600269 ps = [] # List of elements to be added together to account for packet size for given params
270 skip_list = [] # store params that are already accounted for so we don't count them twice
271 # Dict of specific params with unique custom sizes
Courtney Goeltzenleuchter8e2f0972015-10-21 17:08:06 -0600272 # TODO: Now using bitfields for all stages, need pSetBindPoints to accomodate that.
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600273 custom_size_dict = {'pSetBindPoints': '(VK_SHADER_STAGE_COMPUTE * sizeof(uint32_t))', # Accounting for largest possible array
Ian Elliott338dedb2015-08-21 15:09:33 -0600274 'VkSwapchainCreateInfoKHR' : 'vk_ext_khr_device_swapchain_size_vkswapchaincreateinfokhr(pCreateInfo)',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600275 }
276 size_func_suffix = ''
Chia-I Wu1f851912015-10-27 18:04:07 +0800277 if extensionName.lower() != "vk_core":
278 size_func_suffix = '_%s' % extensionName.lower()
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600279 for p in params:
280 #First handle custom cases
Chia-I Wu1f851912015-10-27 18:04:07 +0800281 if p.name in ['pCreateInfo', 'pSetLayoutInfoList', 'pBeginInfo', 'pAllocateInfo'] and 'khr' not in p.ty.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600282 ps.append('get_struct_chain_size%s((void*)%s)' % (size_func_suffix, p.name))
283 skip_list.append(p.name)
284 elif p.name in custom_size_dict:
285 ps.append(custom_size_dict[p.name])
286 skip_list.append(p.name)
287 elif p.ty.strip('*').replace('const ', '') in custom_size_dict:
288 tmp_ty = p.ty.strip('*').replace('const ', '')
289 ps.append(custom_size_dict[tmp_ty])
290 skip_list.append(p.name)
291 # Skip any params already handled
292 if p.name in skip_list:
293 continue
294 # Now check to identify dynamic arrays which depend on two params
295 if 'count' in p.name.lower():
296 next_idx = params.index(p)+1
297 # If next element is a const *, then multiply count and array type
298 if next_idx < len(params) and '*' in params[next_idx].ty and 'const' in params[next_idx].ty.lower():
299 if '*' in p.ty:
300 ps.append('*%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
301 else:
302 ps.append('%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
303 skip_list.append(params[next_idx].name)
304 if 'bindingCount' == p.name: # TODO : This is custom case for CmdBindVertexBuffers, need to clean it up
305 ps.append('%s*sizeof(%s)' % (p.name, params[next_idx+1].ty.strip('*').replace('const ', '')))
306 skip_list.append(params[next_idx+1].name)
307 elif '*' in p.ty: # Not a custom array size we're aware of, but ptr so need to account for its size
308 ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
309 elif '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
310 if 'pData' == p.name:
311 if 'dataSize' == params[params.index(p)-1].name:
312 ps.append('dataSize')
313 elif 'counterCount' == params[params.index(p)-1].name:
314 ps.append('sizeof(%s)' % p.ty.strip('*').replace('const ', ''))
315 else:
316 #ps.append('((pDataSize != NULL && pData != NULL) ? *pDataSize : 0)')
317 ps.append('sizeof(void*)')
318 elif '**' in p.ty and 'void' in p.ty:
319 ps.append('sizeof(void*)')
320 elif 'void' in p.ty:
321 ps.append('sizeof(%s)' % p.name)
322 elif 'char' in p.ty:
323 ps.append('((%s != NULL) ? strlen(%s) + 1 : 0)' % (p.name, p.name))
324 elif 'pDataSize' in p.name:
325 ps.append('((pDataSize != NULL) ? sizeof(size_t) : 0)')
326 elif 'IMAGE_SUBRESOURCE' in p.ty and 'pSubresource' == p.name:
327 ps.append('((pSubresource != NULL) ? sizeof(VkImage_SUBRESOURCE) : 0)')
328 else:
329 ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
330 return ps
331
332 # Generate functions used to trace API calls and store the input and result data into a packet
333 # Here's the general flow of code insertion w/ option items flagged w/ "?"
334 # Result decl?
335 # Packet struct decl
336 # ?Special case : setup call to function first and do custom API call time tracking
337 # CREATE_PACKET
338 # call real entrypoint and get return value (if there is one)
339 # Assign packet values
340 # FINISH packet
341 # return result if needed
Chia-I Wu1f851912015-10-27 18:04:07 +0800342 def _generate_trace_funcs(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600343 func_body = []
Chia-I Wu1f851912015-10-27 18:04:07 +0800344 manually_written_hooked_funcs = ['AllocateMemory',
345 'AllocateDescriptorSets',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600346 'CreateDescriptorPool',
Jon Ashburne70884b2015-08-25 13:33:39 -0600347 'CreateDevice',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600348 'CreateFramebuffer',
349 'CreateInstance',
350 'CreateRenderPass',
351 'CreateGraphicsPipelines',
352 'CreateComputePipelines',
353 'CmdPipelineBarrier',
354 'CmdWaitEvents',
355 'CmdBeginRenderPass',
356 'EnumeratePhysicalDevices',
357 'FreeMemory',
358 'FreeDescriptorSets',
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600359 'QueueSubmit',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600360 'FlushMappedMemoryRanges',
Jon Ashburn71654fd2015-09-11 09:18:44 -0600361 'GetDeviceProcAddr',
Jon Ashburn71654fd2015-09-11 09:18:44 -0600362 'GetInstanceProcAddr',
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -0600363 'EnumerateInstanceExtensionProperties',
364 'EnumerateDeviceExtensionProperties',
365 'EnumerateInstanceLayerProperties',
366 'EnumerateDeviceLayerProperties',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600367 'GetPhysicalDeviceQueueFamilyProperties',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600368 'GetQueryPoolResults',
369 'MapMemory',
370 'UnmapMemory',
371 'UpdateDescriptorSets',
Ian Elliott338dedb2015-08-21 15:09:33 -0600372 'GetSurfacePropertiesKHR',
373 'GetSurfaceFormatsKHR',
374 'GetSurfacePresentModesKHR',
375 'CreateSwapchainKHR',
376 'GetSwapchainImagesKHR',
377 'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600378 ]
379
380 # validate the manually_written_hooked_funcs list
381 protoFuncs = [proto.name for proto in self.protos]
382 for func in manually_written_hooked_funcs:
383 if func not in protoFuncs:
384 sys.exit("Entry '%s' in manually_written_hooked_funcs list is not in the vulkan function prototypes" % func)
385
386 # process each of the entrypoint prototypes
Jon Ashburncb622a12015-08-06 17:22:53 -0600387 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800388 if ext.name.lower() == extensionName.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600389 for proto in ext.protos:
390 if proto.name in manually_written_hooked_funcs:
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600391 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 -0600392 else:
393 raw_packet_update_list = [] # non-ptr elements placed directly into packet
394 ptr_packet_update_list = [] # ptr elements to be updated into packet
395 return_txt = ''
396 packet_size = []
397 in_data_size = False # flag when we need to capture local input size variable for in/out size
398 func_body.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600399 func_body.append('VKTRACER_EXPORT %s VKAPI __HOOKED_vk%s(' % (proto.ret, proto.name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600400 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 +0800401 func_body.append(' %s,' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600402 if '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
403 if 'pDataSize' in p.name:
404 in_data_size = True;
405 elif 'pfnMsgCallback' == p.name:
406 raw_packet_update_list.append(' PFN_vkDbgMsgCallback* pNonConstCallback = (PFN_vkDbgMsgCallback*)&pPacket->pfnMsgCallback;')
407 raw_packet_update_list.append(' *pNonConstCallback = pfnMsgCallback;')
Chia-I Wua5cd6532015-10-28 18:31:57 +0800408 elif '[' in p.ty:
409 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 -0600410 else:
411 raw_packet_update_list.append(' pPacket->%s = %s;' % (p.name, p.name))
412 # Get list of packet size modifiers due to ptr params
Chia-I Wu1f851912015-10-27 18:04:07 +0800413 packet_size = self._get_packet_size(extensionName, proto.params)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600414 ptr_packet_update_list = self._get_packet_ptr_param_list(proto.params)
415 func_body[-1] = func_body[-1].replace(',', ')')
416 # End of function declaration portion, begin function body
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600417 func_body.append('{\n vktrace_trace_packet_header* pHeader;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600418 if 'void' not in proto.ret or '*' in proto.ret:
419 func_body.append(' %s result;' % proto.ret)
420 return_txt = 'result = '
421 if in_data_size:
422 func_body.append(' size_t _dataSize;')
423 func_body.append(' packet_vk%s* pPacket = NULL;' % proto.name)
Jon Ashburnf6754d42015-09-14 16:48:31 -0600424 if proto.name == "DestroyInstance" or proto.name == "DestroyDevice":
425 func_body.append(' dispatch_key key = get_dispatch_key(%s);' % proto.params[0].name)
426
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600427 if (0 == len(packet_size)):
428 func_body.append(' CREATE_TRACE_PACKET(vk%s, 0);' % (proto.name))
429 else:
430 func_body.append(' CREATE_TRACE_PACKET(vk%s, %s);' % (proto.name, ' + '.join(packet_size)))
431
Jon Ashburn71654fd2015-09-11 09:18:44 -0600432 # call down the layer chain and get return value (if there is one)
433 # Note: this logic doesn't work for CreateInstance or CreateDevice but those are handwritten
Chia-I Wu1f851912015-10-27 18:04:07 +0800434 if extensionName == 'vk_debug_marker_lunarg':
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600435 table_txt = 'mdd(%s)->debugMarkerTable' % proto.params[0].name
Jon Ashburn71654fd2015-09-11 09:18:44 -0600436 elif proto.params[0].ty in ['VkInstance', 'VkPhysicalDevice']:
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600437 table_txt = 'mid(%s)->instTable' % proto.params[0].name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600438 else:
Jon Ashburn5afdcf62015-09-14 15:17:36 -0600439 table_txt = 'mdd(%s)->devTable' % proto.params[0].name
Jon Ashburn71654fd2015-09-11 09:18:44 -0600440 func_body.append(' %s%s.%s;' % (return_txt, table_txt, proto.c_call()))
441 func_body.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600442
443 if in_data_size:
444 func_body.append(' _dataSize = (pDataSize == NULL || pData == NULL) ? 0 : *pDataSize;')
445 func_body.append(' pPacket = interpret_body_as_vk%s(pHeader);' % proto.name)
446 func_body.append('\n'.join(raw_packet_update_list))
447 for pp_dict in ptr_packet_update_list: #buff_ptr_indices:
448 func_body.append(' %s;' % (pp_dict['add_txt']))
449 if 'void' not in proto.ret or '*' in proto.ret:
450 func_body.append(' pPacket->result = result;')
451 for pp_dict in ptr_packet_update_list:
452 if ('DeviceCreateInfo' not in proto.params[pp_dict['index']].ty):
453 func_body.append(' %s;' % (pp_dict['finalize_txt']))
454 # All buffers should be finalized by now, and the trace packet can be finished (which sends it over the socket)
455 func_body.append(' FINISH_TRACE_PACKET();')
Jon Ashburnf6754d42015-09-14 16:48:31 -0600456 if proto.name == "DestroyInstance":
457 func_body.append(' g_instanceDataMap.erase(key);')
458 elif proto.name == "DestroyDevice":
459 func_body.append(' g_deviceDataMap.erase(key);')
460
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600461 # return result if needed
462 if 'void' not in proto.ret or '*' in proto.ret:
463 func_body.append(' return result;')
464 func_body.append('}\n')
465 return "\n".join(func_body)
466
467 def _generate_packet_id_enum(self):
468 pid_enum = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600469 pid_enum.append('enum VKTRACE_TRACE_PACKET_ID_VK')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600470 pid_enum.append('{')
471 first_func = True
472 for proto in self.protos:
473 if first_func:
474 first_func = False
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600475 pid_enum.append(' VKTRACE_TPI_VK_vkApiVersion = VKTRACE_TPI_BEGIN_API_HERE,')
476 pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600477 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600478 pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600479 pid_enum.append('};\n')
480 return "\n".join(pid_enum)
481
482 def _generate_packet_id_name_func(self):
483 func_body = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600484 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 -0600485 func_body.append('{')
486 func_body.append(' switch(id) {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600487 func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600488 func_body.append(' {')
489 func_body.append(' return "vkApiVersion";')
490 func_body.append(' }')
491 for proto in self.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600492 func_body.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600493 func_body.append(' {')
494 func_body.append(' return "vk%s";' % proto.name)
495 func_body.append(' }')
496 func_body.append(' default:')
497 func_body.append(' return NULL;')
498 func_body.append(' }')
499 func_body.append('}\n')
500 return "\n".join(func_body)
501
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600502 def _generate_interp_func(self):
503 interp_func_body = []
504 interp_func_body.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600505 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 -0600506 interp_func_body.append('{')
507 interp_func_body.append(' if (pHeader == NULL)')
508 interp_func_body.append(' {')
509 interp_func_body.append(' return NULL;')
510 interp_func_body.append(' }')
511 interp_func_body.append(' switch (pHeader->packet_id)')
512 interp_func_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600513 interp_func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600514 interp_func_body.append(' {')
515 interp_func_body.append(' return interpret_body_as_vkApiVersion(pHeader)->header;')
516 interp_func_body.append(' }')
517 for proto in self.protos:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600518 interp_func_body.append(' case VKTRACE_TPI_VK_vk%s:\n {' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600519 header_prefix = 'h'
Ian Elliott338dedb2015-08-21 15:09:33 -0600520 if 'KHR' in proto.name or 'Dbg' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600521 header_prefix = 'pH'
522 interp_func_body.append(' return interpret_body_as_vk%s(pHeader)->%seader;\n }' % (proto.name, header_prefix))
523 interp_func_body.append(' default:')
524 interp_func_body.append(' return NULL;')
525 interp_func_body.append(' }')
526 interp_func_body.append(' return NULL;')
527 interp_func_body.append('}')
528 return "\n".join(interp_func_body)
529
530 def _generate_struct_util_funcs(self):
531 lineinfo = self.lineinfo
532 pid_enum = []
533 pid_enum.append('%s' % lineinfo.get())
534 pid_enum.append('//=============================================================================')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600535 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 -0600536 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600537 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkApplicationInfo), pInStruct);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800538 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 -0600539 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 +0800540 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pApplicationName));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600541 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pEngineName));')
542 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&*ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600543 pid_enum.append('};\n')
544 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600545 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 -0600546 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600547 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkInstanceCreateInfo), pInStruct);')
Chia-I Wu1f851912015-10-27 18:04:07 +0800548 pid_enum.append(' add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&((*ppStruct)->pApplicationInfo), pInStruct->pApplicationInfo);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600549 # TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
550 pid_enum.append(' uint32_t i, siz = 0;')
Chia-I Wu763a7492015-10-26 20:48:51 +0800551 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerNameCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
552 pid_enum.append(' if (pInStruct->enabledLayerNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600553 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800554 pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600555 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600556 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
557 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600558 pid_enum.append(' }')
559 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600560 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800561 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionNameCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
562 pid_enum.append(' if (pInStruct->enabledExtensionNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600563 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800564 pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600565 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600566 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
567 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600568 pid_enum.append(' }')
569 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600570 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
571 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600572 pid_enum.append('}\n')
573 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600574 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 -0600575 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600576 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkDeviceCreateInfo), pInStruct);')
Courtney Goeltzenleuchterdfd53f52015-10-15 16:58:44 -0600577 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 -0600578 pid_enum.append(' for (uint32_t i = 0; i < pInStruct->requestedQueueCount; i++) {')
579 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pRequestedQueues[i].pQueuePriorities,')
Chia-I Wu763a7492015-10-26 20:48:51 +0800580 pid_enum.append(' pInStruct->pRequestedQueues[i].queuePriorityCount*sizeof(float),')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600581 pid_enum.append(' pInStruct->pRequestedQueues[i].pQueuePriorities);')
Jon Ashburne27a9182015-10-16 17:50:47 -0600582 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pRequestedQueues[i].pQueuePriorities);')
Courtney Goeltzenleuchterd3a8d362015-10-23 10:37:02 -0600583 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600584 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pRequestedQueues);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600585 # TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
586 pid_enum.append(' uint32_t i, siz = 0;')
Chia-I Wu763a7492015-10-26 20:48:51 +0800587 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerNameCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
588 pid_enum.append(' if (pInStruct->enabledLayerNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600589 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800590 pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600591 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600592 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
593 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600594 pid_enum.append(' }')
595 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600596 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
Chia-I Wu763a7492015-10-26 20:48:51 +0800597 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionNameCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
598 pid_enum.append(' if (pInStruct->enabledExtensionNameCount > 0) ')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600599 pid_enum.append(' {')
Chia-I Wu763a7492015-10-26 20:48:51 +0800600 pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionNameCount; i++) {')
Jon Ashburn5bd87b92015-10-07 10:23:30 -0600601 pid_enum.append(' siz = (uint32_t) (1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600602 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
603 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600604 pid_enum.append(' }')
605 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600606 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
607 pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pEnabledFeatures, sizeof(VkPhysicalDeviceFeatures), pInStruct->pEnabledFeatures);')
608 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pEnabledFeatures);')
609 pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600610 pid_enum.append('}\n')
611 pid_enum.append('%s' % lineinfo.get())
612 pid_enum.append('//=============================================================================\n')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600613 pid_enum.append('static VkInstanceCreateInfo* interpret_VkInstanceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600614 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600615 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 -0600616 pid_enum.append(' uint32_t i;')
617 pid_enum.append(' if (pVkInstanceCreateInfo != NULL)')
618 pid_enum.append(' {')
Chia-I Wu1f851912015-10-27 18:04:07 +0800619 pid_enum.append(' pVkInstanceCreateInfo->pApplicationInfo = (VkApplicationInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo);')
620 pid_enum.append(' VkApplicationInfo** ppApplicationInfo = (VkApplicationInfo**) &pVkInstanceCreateInfo->pApplicationInfo;')
621 pid_enum.append(' (*ppApplicationInfo)->pApplicationName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo->pApplicationName);')
622 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 +0800623 pid_enum.append(' if (pVkInstanceCreateInfo->enabledLayerNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600624 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600625 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 +0800626 pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledLayerNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600627 pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledLayerNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600628 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600629 pid_enum.append(' }')
630 pid_enum.append(' }')
Chia-I Wu763a7492015-10-26 20:48:51 +0800631 pid_enum.append(' if (pVkInstanceCreateInfo->enabledExtensionNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600632 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600633 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 +0800634 pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledExtensionNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600635 pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledExtensionNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600636 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600637 pid_enum.append(' }')
638 pid_enum.append(' }')
639 pid_enum.append(' }\n')
640 pid_enum.append(' return pVkInstanceCreateInfo;')
641 pid_enum.append('}\n')
642 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600643 pid_enum.append('static VkDeviceCreateInfo* interpret_VkDeviceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600644 pid_enum.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600645 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 -0600646 pid_enum.append(' uint32_t i;')
647 pid_enum.append(' if (pVkDeviceCreateInfo != NULL)')
648 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600649 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 +0800650 pid_enum.append(' if (pVkDeviceCreateInfo->enabledLayerNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600651 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600652 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 +0800653 pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledLayerNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600654 pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledLayerNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600655 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledLayerNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600656 pid_enum.append(' }')
657 pid_enum.append(' }')
Chia-I Wu763a7492015-10-26 20:48:51 +0800658 pid_enum.append(' if (pVkDeviceCreateInfo->enabledExtensionNameCount > 0)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600659 pid_enum.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600660 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 +0800661 pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledExtensionNameCount; i++) {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600662 pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledExtensionNames[i];')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600663 pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledExtensionNames[i]);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600664 pid_enum.append(' }')
665 pid_enum.append(' }')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600666 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 -0600667 pid_enum.append(' }\n')
668 pid_enum.append(' return pVkDeviceCreateInfo;')
669 pid_enum.append('}\n')
670 pid_enum.append('%s' % lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600671 pid_enum.append('static void interpret_VkPipelineShaderStageCreateInfo(vktrace_trace_packet_header* pHeader, VkPipelineShaderStageCreateInfo* pShader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600672 pid_enum.append('{')
673 pid_enum.append(' if (pShader != NULL)')
674 pid_enum.append(' {')
Chia-I Wu062ad152015-10-31 00:31:16 +0800675 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 -0600676 pid_enum.append(' // specialization info')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600677 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 -0600678 pid_enum.append(' if (pShader->pSpecializationInfo != NULL)')
679 pid_enum.append(' {')
680 pid_enum.append(' VkSpecializationInfo* pInfo = (VkSpecializationInfo*)pShader->pSpecializationInfo;')
Chia-I Wu483e7702015-10-26 17:20:32 +0800681 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 -0600682 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 -0600683 pid_enum.append(' }')
684 pid_enum.append(' }')
685 pid_enum.append('}\n')
686 pid_enum.append('//=============================================================================')
687 return "\n".join(pid_enum)
688
689 # Interpret functions used on replay to read in packets and interpret their contents
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -0600690 # This code gets generated into vktrace_vk_vk_packets.h file
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600691 def _generate_interp_funcs(self):
692 # Custom txt for given function and parameter. First check if param is NULL, then insert txt if not
693 # First some common code used by both CmdWaitEvents & CmdPipelineBarrier
694 mem_barrier_interp = ['uint32_t i = 0;\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800695 'for (i = 0; i < pPacket->memoryBarrierCount; i++) {\n',
696 ' void** ppMB = (void**)&(pPacket->ppMemoryBarriers[i]);\n',
697 ' *ppMB = vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppMemoryBarriers[i]);\n',
698 ' //VkMemoryBarrier* pBarr = (VkMemoryBarrier*)pPacket->ppMemoryBarriers[i];\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600699 ' // TODO : Could fix up the pNext ptrs here if they were finalized and if we cared by switching on Barrier type and remapping\n',
700 '}']
701 create_rp_interp = ['VkRenderPassCreateInfo* pInfo = (VkRenderPassCreateInfo*)pPacket->pCreateInfo;\n',
702 'uint32_t i = 0;\n',
703 'VkAttachmentDescription **ppAD = (VkAttachmentDescription **)&(pInfo->pAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600704 '*ppAD = (VkAttachmentDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600705 'VkSubpassDescription** ppSP = (VkSubpassDescription**)&(pInfo->pSubpasses);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600706 '*ppSP = (VkSubpassDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600707 'for (i=0; i<pInfo->subpassCount; i++) {\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600708 ' VkAttachmentReference** pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pInputAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600709 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pInputAttachments);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600710 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pColorAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600711 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pColorAttachments);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600712 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pResolveAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600713 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pResolveAttachments);\n',
Chia-I Wuce532f72015-10-26 17:32:47 +0800714 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
715 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600716 ' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pPreserveAttachments);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600717 ' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pPreserveAttachments);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600718 '}\n',
719 'VkSubpassDependency** ppSD = (VkSubpassDependency**)&(pInfo->pDependencies);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600720 '*ppSD = (VkSubpassDependency*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pDependencies);\n']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600721 create_gfx_pipe = ['uint32_t i;\n',
722 'uint32_t j;\n',
Chia-I Wu763a7492015-10-26 20:48:51 +0800723 'for (i=0; i<pPacket->createInfoCount; i++) {\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600724 'if (pPacket->pCreateInfos[i].sType == VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO) {\n',
725 '// need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
726 'VkGraphicsPipelineCreateInfo* pNonConst = (VkGraphicsPipelineCreateInfo*)&(pPacket->pCreateInfos[i]);\n',
727 '// shader stages array\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600728 'pNonConst->pStages = (VkPipelineShaderStageCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pStages);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600729 'for (j = 0; j < pPacket->pCreateInfos[i].stageCount; j++)\n',
730 '{\n',
731 ' interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)&pPacket->pCreateInfos[i].pStages[j]);\n',
732 '}\n',
733 '// Vertex Input State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600734 'pNonConst->pVertexInputState = (VkPipelineVertexInputStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600735 'VkPipelineVertexInputStateCreateInfo* pNonConstVIState = (VkPipelineVertexInputStateCreateInfo*)pNonConst->pVertexInputState;\n',
736 'if (pNonConstVIState) {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600737 ' pNonConstVIState->pVertexBindingDescriptions = (const VkVertexInputBindingDescription*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState->pVertexBindingDescriptions);\n',
738 ' 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 -0600739 '}\n',
740 '// Input Assembly State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600741 '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 -0600742 '// Tesselation State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600743 '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 -0600744 '// Viewport State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600745 '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 -0600746 '// Raster State\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800747 '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 -0600748 '// MultiSample State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600749 '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 -0600750 '// DepthStencil State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600751 '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 -0600752 '// DynamicState State\n',
753 'pNonConst->pDynamicState = (const VkPipelineDynamicStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState);\n',
754 'VkPipelineDynamicStateCreateInfo* pNonConstDyState = (VkPipelineDynamicStateCreateInfo*)pNonConst->pDynamicState;\n',
755 'if (pNonConstDyState) {\n',
756 ' pNonConstDyState->pDynamicStates = (const VkDynamicState*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState->pDynamicStates);\n',
757 '}\n',
758
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600759 '// ColorBuffer State\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600760 '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 -0600761 'VkPipelineColorBlendStateCreateInfo* pNonConstCbState = (VkPipelineColorBlendStateCreateInfo*)pNonConst->pColorBlendState;\n',
762 'if (pNonConstCbState)\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600763 ' 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 -0600764 '} else {\n',
765 ' // This is unexpected.\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600766 ' vktrace_LogError("CreateGraphicsPipelines must have CreateInfo stype of VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600767 ' pPacket->header = NULL;\n',
768 '}\n',
769 '}\n']
770 # 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
771 # 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 +0800772 custom_case_dict = { #'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkFramebufferCreateInfo* pInfo = (VkFramebufferCreateInfo*)pPacket->pCreateInfo;\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600773 # 'pInfo->pColorAttachments = (VkColorAttachmentBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pColorAttachments);\n',
774 # 'pInfo->pDepthStencilAttachment = (VkDepthStencilBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pDepthStencilAttachment);\n']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600775 'CreateRenderPass' : {'param': 'pCreateInfo', 'txt': create_rp_interp},
776 'CreatePipelineLayout' : {'param': 'pCreateInfo', 'txt': ['VkPipelineLayoutCreateInfo* pInfo = (VkPipelineLayoutCreateInfo*)pPacket->pCreateInfo;\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600777 'pInfo->pSetLayouts = (VkDescriptorSetLayout*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pSetLayouts);\n']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600778 'CreateDescriptorPool' : {'param': 'pCreateInfo', 'txt': ['VkDescriptorPoolCreateInfo* pInfo = (VkDescriptorPoolCreateInfo*)pPacket->pCreateInfo;\n',
Chia-I Wuc51b1212015-10-27 19:25:11 +0800779 'pInfo->pPoolSizes = (VkDescriptorPoolSize*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pPoolSizes);\n']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800780 'CmdWaitEvents' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
781 'CmdPipelineBarrier' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600782 'CreateDescriptorSetLayout' : {'param': 'pCreateInfo', 'txt': ['if (pPacket->pCreateInfo->sType == VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO) {\n',
783 ' VkDescriptorSetLayoutCreateInfo* pNext = (VkDescriptorSetLayoutCreateInfo*)pPacket->pCreateInfo;\n',
784 ' do\n',' {\n',
785 ' // need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
786 ' void** ppNextVoidPtr = (void**)&(pNext->pNext);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600787 ' *ppNextVoidPtr = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600788 ' switch(pNext->sType)\n', ' {\n',
789 ' case VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO:\n',
790 ' {\n' ,
791 ' unsigned int i = 0;\n',
Chia-I Wuf03cbf72015-10-31 00:31:16 +0800792 ' pNext->pBinding = (VkDescriptorSetLayoutBinding*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBinding);\n',
Chia-I Wu763a7492015-10-26 20:48:51 +0800793 ' for (i = 0; i < pNext->bindingCount; i++)\n',' {\n',
Chia-I Wuf03cbf72015-10-31 00:31:16 +0800794 ' VkSampler** ppSamplers = (VkSampler**)&(pNext->pBinding[i].pImmutableSamplers);\n',
795 ' *ppSamplers = (VkSampler*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBinding[i].pImmutableSamplers);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600796 ' }\n',
797 ' break;\n',
798 ' }\n',
799 ' default:\n',
800 ' {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600801 ' vktrace_LogError("Encountered an unexpected type in descriptor set layout create list.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600802 ' pPacket->header = NULL;\n',
803 ' pNext->pNext = NULL;\n',
804 ' }\n',
805 ' }\n',
806 ' pNext = (VkDescriptorSetLayoutCreateInfo*)pNext->pNext;\n',
807 ' } while (NULL != pNext);\n',
808 '} else {\n',
809 ' // This is unexpected.\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600810 ' vktrace_LogError("CreateDescriptorSetLayout must have pCreateInfo->stype of VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600811 ' pPacket->header = NULL;\n',
812 '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800813# 'BeginCommandBuffer' : {'param': 'pBeginInfo', 'txt': ['if (pPacket->pBeginInfo->sType == VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO) {\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600814# ' // 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 +0800815# ' VkCommandBufferGraphicsBeginInfo** ppNext = (VkCommandBufferGraphicsBeginInfo**)&(pPacket->pBeginInfo->pNext);\n',
816# ' *ppNext = (VkCommandBufferGraphicsBeginInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pBeginInfo->pNext);\n',
817# ' VkCommandBufferGraphicsBeginInfo* pNext = *ppNext;\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600818# ' while (NULL != pNext)\n', ' {\n',
819# ' switch(pNext->sType)\n', ' {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800820# ' case VK_STRUCTURE_TYPE_COMMAND_BUFFER_GRAPHICS_BEGIN_INFO:\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600821# ' {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800822# ' ppNext = (VkCommandBufferGraphicsBeginInfo**) &pNext->pNext;\n',
823# ' *ppNext = (VkCommandBufferGraphicsBeginInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600824# ' break;\n',
825# ' }\n',
826# ' default:\n',
827# ' {\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600828# ' vktrace_LogError("Encountered an unexpected type in begin command buffer list.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600829# ' pPacket->header = NULL;\n',
830# ' pNext->pNext = NULL;\n',
831# ' }\n',
832# ' }\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800833# ' pNext = (VkCommandBufferGraphicsBeginInfo*)pNext->pNext;\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600834# ' }\n',
835# '} else {\n',
836# ' // This is unexpected.\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800837# ' vktrace_LogError("BeginCommandBuffer must have BeginInfo stype of VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600838# ' pPacket->header = NULL;\n',
839# '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800840 'AllocateMemory' : {'param': 'pAllocateInfo', 'txt': ['if (pPacket->pAllocateInfo->sType == VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO) {\n',
841 ' VkMemoryAllocateInfo** ppNext = (VkMemoryAllocateInfo**) &(pPacket->pAllocateInfo->pNext);\n',
842 ' *ppNext = (VkMemoryAllocateInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pAllocateInfo->pNext);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600843 '} else {\n',
844 ' // This is unexpected.\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800845 ' vktrace_LogError("AllocateMemory must have AllocInfo stype of VK_STRUCTURE_TYPE_MEMORY_ALLOC_INFO.");\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600846 ' pPacket->header = NULL;\n',
847 '}']},
Chia-I Wu1f851912015-10-27 18:04:07 +0800848 'AllocateDescriptorSets' : {'param': 'pAllocateInfo', 'txt':
849 ['VkDescriptorSetLayout **ppDescSetLayout = (VkDescriptorSetLayout **) &pPacket->pAllocateInfo->pSetLayouts;\n'
850 ' *ppDescSetLayout = (VkDescriptorSetLayout *) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pAllocateInfo->pSetLayouts));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600851 'UpdateDescriptorSets' : {'param': 'pDescriptorWrites', 'txt':
852 [ 'uint32_t i;\n',
Chia-I Wu483e7702015-10-26 17:20:32 +0800853 'for (i = 0; i < pPacket->descriptorWriteCount; i++) {\n',
Courtney Goeltzenleuchter34aa5c82015-10-23 13:38:14 -0600854 ' switch (pPacket->pDescriptorWrites[i].descriptorType) {',
855 ' case VK_DESCRIPTOR_TYPE_SAMPLER:',
856 ' case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:',
857 ' case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:',
858 ' case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:',
859 ' {',
860 ' VkDescriptorImageInfo** ppImageInfo = (VkDescriptorImageInfo**)&pPacket->pDescriptorWrites[i].pImageInfo;\n',
861 ' *ppImageInfo = (VkDescriptorImageInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pImageInfo);\n',
862 ' }',
863 ' break;',
864 ' case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:',
865 ' case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:',
866 ' {',
867 ' VkBufferView** ppTexelBufferView = (VkBufferView**)&pPacket->pDescriptorWrites[i].pTexelBufferView;\n',
868 ' *ppTexelBufferView = (VkBufferView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pTexelBufferView);\n',
869 ' }',
870 ' break;',
871 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:',
872 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:',
873 ' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:',
874 ' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:',
875 ' {',
876 ' VkDescriptorBufferInfo** ppBufferInfo = (VkDescriptorBufferInfo**)&pPacket->pDescriptorWrites[i].pBufferInfo;\n',
877 ' *ppBufferInfo = (VkDescriptorBufferInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pBufferInfo);\n',
878 ' }',
879 ' break;',
880 ' default:',
881 ' break;',
882 ' }',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600883 '}'
884 ]},
Chia-I Wu483e7702015-10-26 17:20:32 +0800885 'QueueSubmit' : {'param': 'pSubmits', 'txt':
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600886 [ 'uint32_t i;\n',
887 'for (i = 0; i < pPacket->submitCount; i++) {\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800888 ' VkCommandBuffer** ppCBs = (VkCommandBuffer**)&pPacket->pSubmits[i].pCommandBuffers;\n',
889 ' *ppCBs = (VkCommandBuffer*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pCommandBuffers);\n',
Chia-I Wu483e7702015-10-26 17:20:32 +0800890 ' VkSemaphore** ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pWaitSemaphores;\n',
891 ' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pWaitSemaphores);\n',
892 ' ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pSignalSemaphores;\n',
893 ' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pSignalSemaphores);\n',
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -0600894 '}'
895 ]},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600896 'CreateGraphicsPipelines' : {'param': 'pCreateInfos', 'txt': create_gfx_pipe},
897 'CreateComputePipeline' : {'param': 'pCreateInfo', 'txt': ['interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)(&pPacket->pCreateInfo->cs));']},
Courtney Goeltzenleuchter1856d6f2015-09-01 17:30:39 -0600898 'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkImageView** ppAV = (VkImageView**)&(pPacket->pCreateInfo->pAttachments);\n',
899 '*ppAV = (VkImageView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pAttachments));']},
Jon Ashburn9e8755b2015-08-10 08:53:44 -0600900 'CmdBeginRenderPass' : {'param': 'pRenderPassBegin', 'txt': ['VkClearValue** ppCV = (VkClearValue**)&(pPacket->pRenderPassBegin->pClearValues);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600901 '*ppCV = (VkClearValue*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pRenderPassBegin->pClearValues));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600902 'CreateShaderModule' : {'param': 'pCreateInfo', 'txt': ['void** ppCode = (void**)&(pPacket->pCreateInfo->pCode);\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600903 '*ppCode = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pCode);']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600904 'FlushMappedMemoryRanges' : {'param': 'ppData', 'txt': ['uint32_t i = 0;\n',
Chia-I Wu1f851912015-10-27 18:04:07 +0800905 'for (i = 0; i < pPacket->memoryRangeCount; i++)\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600906 '{\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600907 ' pPacket->ppData[i] = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppData[i]);\n',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600908 '}']}}
909 if_body = []
910 if_body.append('typedef struct packet_vkApiVersion {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600911 if_body.append(' vktrace_trace_packet_header* header;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600912 if_body.append(' uint32_t version;')
913 if_body.append('} packet_vkApiVersion;\n')
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600914 if_body.append('static packet_vkApiVersion* interpret_body_as_vkApiVersion(vktrace_trace_packet_header* pHeader)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600915 if_body.append('{')
916 if_body.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)pHeader->pBody;')
917 if_body.append(' pPacket->header = pHeader;')
918 if_body.append(' return pPacket;')
919 if_body.append('}\n')
920 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -0600921 if 'KHR' not in proto.name and 'Dbg' not in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600922 if 'UnmapMemory' == proto.name:
923 proto.params.append(vulkan.Param("void*", "pData"))
924 elif 'FlushMappedMemoryRanges' == proto.name:
925 proto.params.append(vulkan.Param("void**", "ppData"))
926 if_body.append('%s' % self.lineinfo.get())
927 if_body.append('typedef struct packet_vk%s {' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600928 if_body.append(' vktrace_trace_packet_header* header;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600929 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +0800930 if_body.append(' %s;' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600931 if 'void' != proto.ret:
932 if_body.append(' %s result;' % proto.ret)
933 if_body.append('} packet_vk%s;\n' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600934 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 -0600935 if_body.append('{')
936 if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
937 if_body.append(' pPacket->header = pHeader;')
938 for p in proto.params:
939 if '*' in p.ty:
940 if 'DeviceCreateInfo' in p.ty:
941 if_body.append(' pPacket->%s = interpret_VkDeviceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
942 elif 'InstanceCreateInfo' in p.ty:
943 if_body.append(' pPacket->%s = interpret_VkInstanceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
944 else:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600945 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 -0600946 # TODO : Generalize this custom code to kill dict data struct above.
947 # Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
948 if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
949 if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
950 if_body.append(' {')
951 if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
952 if_body.append(' }')
953 if_body.append(' return pPacket;')
954 if_body.append('}\n')
955 return "\n".join(if_body)
956
Chia-I Wu1f851912015-10-27 18:04:07 +0800957 def _generate_interp_funcs_ext(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600958 if_body = []
Ian Elliott338dedb2015-08-21 15:09:33 -0600959 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 -0600960 'pPacket->pPresentInfo->imageIndices = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->imageIndices));']},
Ian Elliott338dedb2015-08-21 15:09:33 -0600961 'CreateSwapchainKHR' : {'param': 'pCreateInfo', 'txt': ['VkSurfaceDescriptionKHR **ppSurfDescp = (VkSurfaceDescriptionKHR**)&pPacket->pCreateInfo->pSurfaceDescription;\n',
Jon Ashburnc51afc72015-08-11 16:01:35 -0600962 'uint32_t **ppQFI = (uint32_t**)&pPacket->pCreateInfo->pQueueFamilyIndices;\n',
Ian Elliott338dedb2015-08-21 15:09:33 -0600963 '(*ppSurfDescp) = (VkSurfaceDescriptionKHR*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pSurfaceDescription));\n',
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600964 '(*ppQFI) = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pQueueFamilyIndices));']},
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600965 }
Jon Ashburncb622a12015-08-06 17:22:53 -0600966 for ext in vulkan.extensions_all:
Chia-I Wu1f851912015-10-27 18:04:07 +0800967 if ext.name.lower() == extensionName.lower():
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600968 for proto in ext.protos:
969 if_body.append('typedef struct packet_vk%s {' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600970 if_body.append(' vktrace_trace_packet_header* pHeader;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600971 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +0800972 if_body.append(' %s;' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -0600973 if 'void' != proto.ret:
974 if_body.append(' %s result;' % proto.ret)
975 if_body.append('} packet_vk%s;\n' % proto.name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600976 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 -0600977 if_body.append('{')
978 if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
979 if_body.append(' pPacket->pHeader = pHeader;')
980 for p in proto.params:
981 if '*' in p.ty:
Mark Lobodzinski87220f82015-08-27 15:30:29 -0600982 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 -0600983 # TODO : Generalize this custom code to kill dict data struct above.
984 # Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
985 if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
986 if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
987 if_body.append(' {')
988 if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
989 if_body.append(' }')
990 if_body.append(' return pPacket;')
991 if_body.append('}\n')
992 return "\n".join(if_body)
993
994 def _generate_replay_func_ptrs(self):
995 xf_body = []
996 xf_body.append('struct vkFuncs {')
997 xf_body.append(' void init_funcs(void * libHandle);')
998 xf_body.append(' void *m_libHandle;\n')
999 for proto in self.protos:
1000 xf_body.append(' typedef %s( VKAPI * type_vk%s)(' % (proto.ret, proto.name))
1001 for p in proto.params:
Chia-I Wua5cd6532015-10-28 18:31:57 +08001002 xf_body.append(' %s,' % p.c())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001003 xf_body[-1] = xf_body[-1].replace(',', ');')
1004 xf_body.append(' type_vk%s real_vk%s;' % (proto.name, proto.name))
1005 xf_body.append('};')
1006 return "\n".join(xf_body)
1007
1008 def _map_decl(self, type1, type2, name):
1009 return ' std::map<%s, %s> %s;' % (type1, type2, name)
1010
1011 def _add_to_map_decl(self, type1, type2, name):
1012 txt = ' void add_to_%s_map(%s pTraceVal, %s pReplayVal)\n {\n' % (name[2:], type1, type2)
1013 #TODO138 : These checks need to vary between disp & non-disp objects
1014 #txt += ' assert(pTraceVal != 0);\n'
1015 #txt += ' assert(pReplayVal != 0);\n'
1016 txt += ' %s[pTraceVal] = pReplayVal;\n }\n' % name
1017 return txt
1018
1019 def _rm_from_map_decl(self, ty, name):
1020 txt = ' void rm_from_%s_map(const %s& key)\n {\n' % (name[2:], ty)
1021 txt += ' %s.erase(key);\n }\n' % name
1022 return txt
1023
1024 def _remap_decl(self, ty, name):
1025 txt = ' %s remap_%s(const %s& value)\n {\n' % (ty, name[2:], ty)
1026 txt += ' if (value == 0) { return 0; }\n'
1027 txt += ' std::map<%s, %s>::const_iterator q = %s.find(value);\n' % (ty, ty, name)
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001028 txt += ' if (q == %s.end()) { vktrace_LogError("Failed to remap %s."); return value; }\n' % (name, ty)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001029 txt += ' return q->second;\n }\n'
1030 return txt
1031
1032 def _generate_replay_objMemory_funcs(self):
1033 rof_body = []
1034 # Custom code for memory mapping functions for app writes into mapped memory
1035 rof_body.append('// memory mapping functions for app writes into mapped memory')
1036 rof_body.append(' bool isPendingAlloc()')
1037 rof_body.append(' {')
1038 rof_body.append(' return m_pendingAlloc;')
1039 rof_body.append(' }')
1040 rof_body.append('')
Chia-I Wu1f851912015-10-27 18:04:07 +08001041 rof_body.append(' void setAllocInfo(const VkMemoryAllocateInfo *info, const bool pending)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001042 rof_body.append(' {')
1043 rof_body.append(' m_pendingAlloc = pending;')
1044 rof_body.append(' m_allocInfo = *info;')
1045 rof_body.append(' }')
1046 rof_body.append('')
1047 rof_body.append(' void setMemoryDataAddr(void *pBuf)')
1048 rof_body.append(' {')
1049 rof_body.append(' if (m_mapRange.empty())')
1050 rof_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001051 rof_body.append(' vktrace_LogError("gpuMemory::setMemoryDataAddr() m_mapRange is empty.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001052 rof_body.append(' return;')
1053 rof_body.append(' }')
1054 rof_body.append(' MapRange mr = m_mapRange.back();')
1055 rof_body.append(' if (mr.pData != NULL)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001056 rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() data already mapped overwrite old mapping.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001057 rof_body.append(' else if (pBuf == NULL)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001058 rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() adding NULL pointer.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001059 rof_body.append(' mr.pData = (uint8_t *) pBuf;')
1060 rof_body.append(' }')
1061 rof_body.append('')
1062 rof_body.append(' void setMemoryMapRange(void *pBuf, const size_t size, const size_t offset, const bool pending)')
1063 rof_body.append(' {')
1064 rof_body.append(' MapRange mr;')
1065 rof_body.append(' mr.pData = (uint8_t *) pBuf;')
1066 rof_body.append(' if (size == 0)')
1067 rof_body.append(' mr.size = m_allocInfo.allocationSize - offset;')
1068 rof_body.append(' else')
1069 rof_body.append(' mr.size = size;')
1070 rof_body.append(' mr.offset = offset;')
1071 rof_body.append(' mr.pending = pending;')
1072 rof_body.append(' m_mapRange.push_back(mr);')
1073 rof_body.append(' assert(m_allocInfo.allocationSize >= (size + offset));')
1074 rof_body.append(' }')
1075 rof_body.append('')
1076 rof_body.append(' void copyMappingData(const void* pSrcData, bool entire_map, size_t size, size_t offset)')
1077 rof_body.append(' {')
1078 rof_body.append(' if (m_mapRange.empty())')
1079 rof_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001080 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() m_mapRange is empty.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001081 rof_body.append(' return;')
1082 rof_body.append(' }')
1083 rof_body.append(' MapRange mr = m_mapRange.back();')
1084 rof_body.append(' if (!pSrcData || !mr.pData)')
1085 rof_body.append(' {')
1086 rof_body.append(' if (!pSrcData)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001087 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null src pointer.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001088 rof_body.append(' else')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001089 rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null dest pointer totalSize=%u.", m_allocInfo.allocationSize);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001090 rof_body.append(' m_mapRange.pop_back();')
1091 rof_body.append(' return;')
1092 rof_body.append(' }')
1093 rof_body.append(' if (entire_map)')
1094 rof_body.append(' {')
1095 rof_body.append(' size = mr.size;')
1096 rof_body.append(' offset = mr.offset;')
1097 rof_body.append(' }')
1098 rof_body.append(' else')
1099 rof_body.append(' {')
1100 rof_body.append(' assert(offset >= mr.offset);')
1101 rof_body.append(' assert(size <= mr.size && (size + offset) <= mr.size);')
1102 rof_body.append(' }')
1103 rof_body.append(' memcpy(mr.pData + offset, pSrcData, size);')
1104 rof_body.append(' if (!mr.pending && entire_map)')
1105 rof_body.append(' m_mapRange.pop_back();')
1106 rof_body.append(' }')
1107 rof_body.append('')
1108 rof_body.append(' size_t getMemoryMapSize()')
1109 rof_body.append(' {')
1110 rof_body.append(' return (!m_mapRange.empty()) ? m_mapRange.back().size : 0;')
1111 rof_body.append(' }\n')
1112 return "\n".join(rof_body)
1113
1114 def _generate_replay_objmapper_class(self):
1115 # Create dict mapping member var names to VK type (i.e. 'm_imageViews' : 'VkImage_VIEW')
1116 obj_map_dict = {}
1117 for obj in vulkan.object_type_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001118 if (obj.startswith('Vk')):
1119 mem_var = obj.replace('Vk', '').lower()
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001120 mem_var_list = mem_var.split('_')
1121 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 -06001122 obj_map_dict[mem_var] = obj
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001123 rc_body = []
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001124 rc_body.append('#define VKTRACE_VK_OBJECT_TYPE_UNKNOWN (VkObjectType)-1')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001125 rc_body.append('')
1126 rc_body.append('typedef struct _VKAllocInfo {')
1127 rc_body.append(' VkDeviceSize size;')
1128 rc_body.append(' uint8_t *pData;')
1129 rc_body.append(' bool rangeUpdated;')
1130 rc_body.append('} VKAllocInfo;')
1131 rc_body.append('')
1132 rc_body.append('class objMemory {')
1133 rc_body.append('public:')
1134 rc_body.append(' objMemory() : m_numAllocations(0), m_pMemReqs(NULL) {}')
1135 rc_body.append(' ~objMemory() { free(m_pMemReqs);}')
1136 rc_body.append(' void setCount(const uint32_t num)')
1137 rc_body.append(' {')
1138 rc_body.append(' m_numAllocations = num;')
1139 rc_body.append(' }\n')
1140 rc_body.append(' void setReqs(const VkMemoryRequirements *pReqs, const uint32_t num)')
1141 rc_body.append(' {')
1142 rc_body.append(' if (m_numAllocations != num && m_numAllocations != 0)')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001143 rc_body.append(' vktrace_LogError("objMemory::setReqs, internal mismatch on number of allocations.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001144 rc_body.append(' if (m_pMemReqs == NULL && pReqs != NULL)')
1145 rc_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001146 rc_body.append(' m_pMemReqs = (VkMemoryRequirements *) vktrace_malloc(num * sizeof(VkMemoryRequirements));')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001147 rc_body.append(' if (m_pMemReqs == NULL)')
1148 rc_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001149 rc_body.append(' vktrace_LogError("objMemory::setReqs out of memory.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001150 rc_body.append(' return;')
1151 rc_body.append(' }')
1152 rc_body.append(' memcpy(m_pMemReqs, pReqs, num * sizeof(VkMemoryRequirements));')
1153 rc_body.append(' }')
1154 rc_body.append(' }\n')
1155 rc_body.append('private:')
1156 rc_body.append(' uint32_t m_numAllocations;')
1157 rc_body.append(' VkMemoryRequirements *m_pMemReqs;')
1158 rc_body.append('};')
1159 rc_body.append('')
1160 rc_body.append('class gpuMemory {')
1161 rc_body.append('public:')
1162 rc_body.append(' gpuMemory() : m_pendingAlloc(false) {m_allocInfo.allocationSize = 0;}')
1163 rc_body.append(' ~gpuMemory() {}')
1164 rc_body.append(self._generate_replay_objMemory_funcs())
1165 rc_body.append('private:')
1166 rc_body.append(' bool m_pendingAlloc;')
1167 rc_body.append(' struct MapRange {')
1168 rc_body.append(' bool pending;')
1169 rc_body.append(' size_t size;')
1170 rc_body.append(' size_t offset;')
1171 rc_body.append(' uint8_t* pData;')
1172 rc_body.append(' };')
1173 rc_body.append(' std::vector<MapRange> m_mapRange;')
Chia-I Wu1f851912015-10-27 18:04:07 +08001174 rc_body.append(' VkMemoryAllocateInfo m_allocInfo;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001175 rc_body.append('};')
1176 rc_body.append('')
1177 rc_body.append('typedef struct _imageObj {')
1178 rc_body.append(' objMemory imageMem;')
1179 rc_body.append(' VkImage replayImage;')
1180 rc_body.append(' } imageObj;')
1181 rc_body.append('')
1182 rc_body.append('typedef struct _bufferObj {')
1183 rc_body.append(' objMemory bufferMem;')
1184 rc_body.append(' VkBuffer replayBuffer;')
1185 rc_body.append(' } bufferObj;')
1186 rc_body.append('')
1187 rc_body.append('typedef struct _gpuMemObj {')
1188 rc_body.append(' gpuMemory *pGpuMem;')
1189 rc_body.append(' VkDeviceMemory replayGpuMem;')
1190 rc_body.append(' } gpuMemObj;')
1191 rc_body.append('')
1192 rc_body.append('')
1193 rc_body.append('class vkReplayObjMapper {')
1194 rc_body.append('public:')
1195 rc_body.append(' vkReplayObjMapper() {}')
1196 rc_body.append(' ~vkReplayObjMapper() {}')
1197 rc_body.append('')
1198 rc_body.append(' bool m_adjustForGPU; // true if replay adjusts behavior based on GPU')
1199 # Code for memory objects for handling replay GPU != trace GPU object memory requirements
1200 rc_body.append('void init_objMemCount(const uint64_t handle, const VkDbgObjectType objectType, const uint32_t &num)\n {')
1201 rc_body.append(' switch (objectType) {')
1202 rc_body.append(' case VK_OBJECT_TYPE_BUFFER:')
1203 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001204 rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001205 rc_body.append(' if (it != m_buffers.end()) {')
1206 rc_body.append(' objMemory obj = it->second.bufferMem;')
1207 rc_body.append(' obj.setCount(num);')
1208 rc_body.append(' return;')
1209 rc_body.append(' }')
1210 rc_body.append(' break;')
1211 rc_body.append(' }')
1212 rc_body.append(' case VK_OBJECT_TYPE_IMAGE:')
1213 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001214 rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001215 rc_body.append(' if (it != m_images.end()) {')
1216 rc_body.append(' objMemory obj = it->second.imageMem;')
1217 rc_body.append(' obj.setCount(num);')
1218 rc_body.append(' return;')
1219 rc_body.append(' }')
1220 rc_body.append(' break;')
1221 rc_body.append(' }')
1222 rc_body.append(' default:')
1223 rc_body.append(' break;')
1224 rc_body.append(' }')
1225 rc_body.append(' return;')
1226 rc_body.append('}\n')
1227 rc_body.append('void init_objMemReqs(const uint64_t handle, const VkDbgObjectType objectType, const VkMemoryRequirements *pMemReqs, const unsigned int num)\n {')
1228 rc_body.append(' switch (objectType) {')
1229 rc_body.append(' case VK_OBJECT_TYPE_BUFFER:')
1230 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001231 rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001232 rc_body.append(' if (it != m_buffers.end()) {')
1233 rc_body.append(' objMemory obj = it->second.bufferMem;')
1234 rc_body.append(' obj.setReqs(pMemReqs, num);')
1235 rc_body.append(' return;')
1236 rc_body.append(' }')
1237 rc_body.append(' break;')
1238 rc_body.append(' }')
1239 rc_body.append(' case VK_OBJECT_TYPE_IMAGE:')
1240 rc_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001241 rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001242 rc_body.append(' if (it != m_images.end()) {')
1243 rc_body.append(' objMemory obj = it->second.imageMem;')
1244 rc_body.append(' obj.setReqs(pMemReqs, num);')
1245 rc_body.append(' return;')
1246 rc_body.append(' }')
1247 rc_body.append(' break;')
1248 rc_body.append(' }')
1249 rc_body.append(' default:')
1250 rc_body.append(' break;')
1251 rc_body.append(' }')
1252 rc_body.append(' return;')
1253 rc_body.append(' }')
1254 rc_body.append('')
1255 rc_body.append(' void clear_all_map_handles()\n {')
1256 for var in sorted(obj_map_dict):
1257 rc_body.append(' %s.clear();' % var)
1258 rc_body.append(' }\n')
Jon Ashburncb622a12015-08-06 17:22:53 -06001259 disp_obj_types = [obj for obj in vulkan.object_dispatch_list]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001260 for var in sorted(obj_map_dict):
Chia-I Wue420a332015-10-26 20:04:44 +08001261 if obj_map_dict[var] == 'VkImage':
1262 rc_body.append(self._map_decl('VkImage', 'imageObj', var))
1263 rc_body.append(self._add_to_map_decl('VkImage', 'imageObj', var))
1264 rc_body.append(self._rm_from_map_decl('VkImage', var))
1265 rc_body.append(' VkImage remap_images(const VkImage& value)')
1266 rc_body.append(' {')
1267 rc_body.append(' if (value == 0) { return 0; }')
1268 rc_body.append('')
1269 rc_body.append(' std::map<VkImage, imageObj>::const_iterator q = m_images.find(value);')
1270 rc_body.append(' if (q == m_images.end()) { vktrace_LogError("Failed to remap VkImage."); return value; }\n')
1271 rc_body.append(' return q->second.replayImage;')
1272 rc_body.append(' }\n')
1273 elif obj_map_dict[var] == 'VkBuffer':
1274 rc_body.append(self._map_decl('VkBuffer', 'bufferObj', var))
1275 rc_body.append(self._add_to_map_decl('VkBuffer', 'bufferObj', var))
1276 rc_body.append(self._rm_from_map_decl('VkBuffer', var))
1277 rc_body.append(' VkBuffer remap_buffers(const VkBuffer& value)')
1278 rc_body.append(' {')
1279 rc_body.append(' if (value == 0) { return 0; }')
1280 rc_body.append('')
1281 rc_body.append(' std::map<VkBuffer, bufferObj>::const_iterator q = m_buffers.find(value);')
1282 rc_body.append(' if (q == m_buffers.end()) { vktrace_LogError("Failed to remap VkBuffer."); return value; }\n')
1283 rc_body.append(' return q->second.replayBuffer;')
1284 rc_body.append(' }\n')
1285 elif obj_map_dict[var] == 'VkDeviceMemory':
1286 rc_body.append(self._map_decl('VkDeviceMemory', 'gpuMemObj', var))
1287 rc_body.append(self._add_to_map_decl('VkDeviceMemory', 'gpuMemObj', var))
1288 rc_body.append(self._rm_from_map_decl('VkDeviceMemory', var))
1289 rc_body.append(' VkDeviceMemory remap_devicememorys(const VkDeviceMemory& value)')
1290 rc_body.append(' {')
1291 rc_body.append(' if (value == 0) { return 0; }')
1292 rc_body.append('')
1293 rc_body.append(' std::map<VkDeviceMemory, gpuMemObj>::const_iterator q = m_devicememorys.find(value);')
1294 rc_body.append(' if (q == m_devicememorys.end()) { vktrace_LogError("Failed to remap VkDeviceMemory."); return value; }')
1295 rc_body.append(' return q->second.replayGpuMem;')
1296 rc_body.append(' }\n')
1297 else:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001298 rc_body.append(self._map_decl(obj_map_dict[var], obj_map_dict[var], var))
1299 rc_body.append(self._add_to_map_decl(obj_map_dict[var], obj_map_dict[var], var))
1300 rc_body.append(self._rm_from_map_decl(obj_map_dict[var], var))
1301 rc_body.append(self._remap_decl(obj_map_dict[var], var))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001302 # VkDynamicStateObject code
1303# TODO138 : Each dynamic state object is now unique so need to make sure their re-mapping is being handled correctly
1304# state_obj_remap_types = vulkan.object_dynamic_state_list
1305# state_obj_bindings = vulkan.object_dynamic_state_bind_point_list
1306# rc_body.append(' VkDynamicStateObject remap(const VkDynamicStateObject& state, const VkStateBindPoint& bindPoint)\n {')
1307# rc_body.append(' VkDynamicStateObject obj;')
1308# index = 0
1309# while index < len(state_obj_remap_types):
1310# obj = state_obj_remap_types[index]
1311# type = state_obj_bindings[index]
1312# rc_body.append(' if (bindPoint == %s) {' % type)
1313# rc_body.append(' if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
1314# rc_body.append(' return obj;')
1315# rc_body.append(' }')
1316# index += 1
1317# for obj in state_obj_remap_types:
1318# rc_body.append('// if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
1319# rc_body.append('// return obj;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001320# rc_body.append(' vktrace_LogWarning("Failed to remap VkDynamicStateObject.");')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001321# rc_body.append(' return VK_NULL_HANDLE;\n }')
1322# rc_body.append(' void rm_from_map(const VkDynamicStateObject& state)\n {')
1323# for obj in state_obj_remap_types:
1324# rc_body.append(' rm_from_map(static_cast <%s> (state));' % obj.type)
1325# rc_body.append(' }')
1326# rc_body.append('')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001327 rc_body.append('};')
1328 return "\n".join(rc_body)
1329
1330 def _generate_replay_init_funcs(self):
1331 rif_body = []
1332 rif_body.append('void vkFuncs::init_funcs(void * handle)\n{\n m_libHandle = handle;')
1333 for proto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001334 if 'KHR' not in proto.name and 'Dbg' not in proto.name:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001335 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 -06001336 else: # These func ptrs get assigned at GetProcAddr time
1337 rif_body.append(' real_vk%s = (type_vk%s)NULL;' % (proto.name, proto.name))
1338 rif_body.append('}')
1339 return "\n".join(rif_body)
1340
Jon Ashburnc736c002015-10-25 20:24:57 -06001341 def _remap_packet_param(self, funcName, paramType, paramName, lastName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001342 remap_list = vulkan.object_type_list
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001343 param_exclude_list = ['pDescriptorSets', 'pFences']
1344 cleanParamType = paramType.strip('*').replace('const ', '')
Jon Ashburncb622a12015-08-06 17:22:53 -06001345 VulkNonDispObjects = [o for o in vulkan.object_non_dispatch_list]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001346 for obj in remap_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001347 if obj == cleanParamType and paramName not in param_exclude_list:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001348 objectTypeRemapParam = ''
1349 if 'VkDynamicStateObject' == cleanParamType:
1350 objectTypeRemapParam = ', pPacket->stateBindPoint'
1351 elif 'object' == paramName:
1352 if 'DbgSetObjectTag' == funcName:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001353 objectTypeRemapParam = ', VKTRACE_VK_OBJECT_TYPE_UNKNOWN'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001354 else:
1355 objectTypeRemapParam = ', pPacket->objType'
1356 elif 'srcObject' == paramName and 'Callback' in funcName:
1357 objectTypeRemapParam = ', pPacket->objType'
Jon Ashburnc736c002015-10-25 20:24:57 -06001358 pArray = ''
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001359 if '*' in paramType:
Jon Ashburnc736c002015-10-25 20:24:57 -06001360 if 'const' not in paramType:
1361 result = ' %s remapped%s = m_objMapper.remap_%ss(*pPacket->%s%s);\n' % (cleanParamType, paramName, paramName.lower(), paramName, objectTypeRemapParam)
1362 result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
1363 result += ' {\n'
1364 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1365 result += ' }\n'
1366 return result
1367 else:
1368 if lastName == '':
1369 return ' // pPacket->%s should have been remapped with special case code' % (paramName)
1370 pArray = '[pPacket->%s]' % lastName
Courtney Goeltzenleuchter5970b252015-10-27 11:32:31 -06001371 result = ' %s *remapped%s = new %s%s;\n' % (cleanParamType, paramName, cleanParamType, pArray)
Jon Ashburnc736c002015-10-25 20:24:57 -06001372 result += '%s\n' % self.lineinfo.get()
1373 result += ' for (uint32_t i = 0; i < pPacket->%s; i++) {\n' % lastName
Chia-I Wue420a332015-10-26 20:04:44 +08001374 result += ' remapped%s[i] = m_objMapper.remap_%ss(pPacket->%s[i]%s);\n' % (paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
1375 result += ' if (pPacket->%s[i] != VK_NULL_HANDLE && remapped%s[i] == VK_NULL_HANDLE)\n' % (paramName, paramName)
Jon Ashburnc736c002015-10-25 20:24:57 -06001376 result += ' {\n'
1377 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1378 result += ' }\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001379 result += ' }\n'
1380 return result
Jon Ashburnc736c002015-10-25 20:24:57 -06001381
Chia-I Wue420a332015-10-26 20:04:44 +08001382 result = ' %s remapped%s = m_objMapper.remap_%ss(pPacket->%s%s);\n' % (paramType, paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
1383 result += '%s\n' % self.lineinfo.get()
1384 result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
1385 result += ' {\n'
1386 result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
1387 result += ' }\n'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001388 return result
1389 return ' // No need to remap %s' % (paramName)
1390
1391 def _get_packet_param(self, funcName, paramType, paramName):
1392 # list of types that require remapping
1393 remap_list = vulkan.object_type_list
1394 param_exclude_list = ['pDescriptorSets', 'pFences']
1395 cleanParamType = paramType.strip('*').replace('const ', '')
1396 for obj in remap_list:
Jon Ashburncb622a12015-08-06 17:22:53 -06001397 if obj == cleanParamType and paramName not in param_exclude_list:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001398 objectTypeRemapParam = ''
1399 if 'object' == paramName:
1400 if 'DbgSetObjectTag' == funcName:
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001401 objectTypeRemapParam = ', VKTRACE_VK_OBJECT_TYPE_UNKNOWN'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001402 else:
1403 objectTypeRemapParam = ', pPacket->objType'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001404 return 'remapped%s' % (paramName)
1405 return 'pPacket->%s' % (paramName)
1406
1407 def _gen_replay_create_image(self):
1408 ci_body = []
1409 ci_body.append(' imageObj local_imageObj;')
1410 ci_body.append(' VkDevice remappedDevice = m_objMapper.remap_devices(pPacket->device);')
1411 ci_body.append(' if (remappedDevice == VK_NULL_HANDLE)')
1412 ci_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001413 ci_body.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001414 ci_body.append(' }')
Chia-I Wu69f40122015-10-26 21:10:41 +08001415 ci_body.append(' replayResult = m_vkFuncs.real_vkCreateImage(remappedDevice, pPacket->pCreateInfo, NULL, &local_imageObj.replayImage);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001416 ci_body.append(' if (replayResult == VK_SUCCESS)')
1417 ci_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001418 ci_body.append(' m_objMapper.add_to_images_map(*(pPacket->pImage), local_imageObj);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001419 ci_body.append(' }')
1420 return "\n".join(ci_body)
1421
1422 def _gen_replay_create_buffer(self):
1423 cb_body = []
1424 cb_body.append(' bufferObj local_bufferObj;')
1425 cb_body.append(' VkDevice remappedDevice = m_objMapper.remap_devices(pPacket->device);')
1426 cb_body.append(' if (remappedDevice == VK_NULL_HANDLE)')
1427 cb_body.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001428 cb_body.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001429 cb_body.append(' }')
Chia-I Wu69f40122015-10-26 21:10:41 +08001430 cb_body.append(' replayResult = m_vkFuncs.real_vkCreateBuffer(remappedDevice, pPacket->pCreateInfo, NULL, &local_bufferObj.replayBuffer);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001431 cb_body.append(' if (replayResult == VK_SUCCESS)')
1432 cb_body.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001433 cb_body.append(' m_objMapper.add_to_buffers_map(*(pPacket->pBuffer), local_bufferObj);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001434 cb_body.append(' }')
1435 return "\n".join(cb_body)
1436
1437 # Generate main replay case statements where actual replay API call is dispatched based on input packet data
1438 def _generate_replay(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001439 manually_replay_funcs = ['AllocateMemory',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001440 'BeginCommandBuffer',
1441 'CreateDescriptorSetLayout',
1442 'CreateDevice',
1443 'CreateFramebuffer',
1444 'CreateGraphicsPipelines',
1445 'CreateInstance',
1446 'CreatePipelineLayout',
1447 'CreateRenderPass',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001448 'CmdBeginRenderPass',
1449 'CmdBindDescriptorSets',
1450 'CmdBindVertexBuffers',
1451 'CmdPipelineBarrier',
Ian Elliott338dedb2015-08-21 15:09:33 -06001452 'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001453 'CmdWaitEvents',
1454 #'DestroyObject',
1455 'EnumeratePhysicalDevices',
1456 'FreeMemory',
1457 'FreeDescriptorSets',
1458 'FlushMappedMemoryRanges',
1459 #'GetGlobalExtensionInfo',
1460 #'GetImageSubresourceInfo',
1461 #'GetObjectInfo',
1462 #'GetPhysicalDeviceExtensionInfo',
Ian Elliott338dedb2015-08-21 15:09:33 -06001463 'GetPhysicalDeviceSurfaceSupportKHR',
1464 'GetSurfacePropertiesKHR',
1465 'GetSurfaceFormatsKHR',
1466 'GetSurfacePresentModesKHR',
1467 'CreateSwapchainKHR',
1468 'GetSwapchainImagesKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001469 #'GetPhysicalDeviceInfo',
1470 'MapMemory',
Ian Elliott338dedb2015-08-21 15:09:33 -06001471 #'QueuePresentKHR',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001472 'QueueSubmit',
1473 #'StorePipeline',
1474 'UnmapMemory',
1475 'UpdateDescriptorSets',
1476 'WaitForFences',
Jon Ashburncaae0492015-08-13 16:49:08 -06001477 'DbgCreateMsgCallback',
1478 'DbgDestroyMsgCallback',
Chia-I Wu1f851912015-10-27 18:04:07 +08001479 'AllocateCommandBuffers',
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001480 ]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001481
1482 # validate the manually_replay_funcs list
1483 protoFuncs = [proto.name for proto in self.protos]
1484 for func in manually_replay_funcs:
1485 if func not in protoFuncs:
1486 sys.exit("Entry '%s' in manually_replay_funcs list is not in the vulkan function prototypes" % func)
1487
1488 # map protos to custom functions if body is fully custom
1489 custom_body_dict = {'CreateImage': self._gen_replay_create_image,
1490 'CreateBuffer': self._gen_replay_create_buffer }
1491 # multi-gpu Open funcs w/ list of local params to create
1492 custom_open_params = {'OpenSharedMemory': (-1,),
1493 'OpenSharedSemaphore': (-1,),
1494 'OpenPeerMemory': (-1,),
1495 'OpenPeerImage': (-1, -2,)}
1496 # Functions that create views are unique from other create functions
Courtney Goeltzenleuchter1856d6f2015-09-01 17:30:39 -06001497 create_view_list = ['CreateBufferView', 'CreateImageView', 'CreateComputePipeline']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001498 # Functions to treat as "Create' that don't have 'Create' in the name
Chia-I Wu1f851912015-10-27 18:04:07 +08001499 special_create_list = ['LoadPipeline', 'LoadPipelineDerivative', 'AllocateMemory', 'GetDeviceQueue', 'PinSystemMemory', 'AllocateDescriptorSets']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001500 # A couple funcs use do while loops
1501 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'}
1502 rbody = []
1503 rbody.append('%s' % self.lineinfo.get())
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001504 rbody.append('vktrace_replay::VKTRACE_REPLAY_RESULT vkReplay::replay(vktrace_trace_packet_header *packet)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001505 rbody.append('{')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001506 rbody.append(' vktrace_replay::VKTRACE_REPLAY_RESULT returnValue = vktrace_replay::VKTRACE_REPLAY_SUCCESS;')
Courtney Goeltzenleuchterac544f32015-09-14 18:01:17 -06001507 rbody.append(' VkResult replayResult = VK_ERROR_VALIDATION_FAILED;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001508 rbody.append(' switch (packet->packet_id)')
1509 rbody.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001510 rbody.append(' case VKTRACE_TPI_VK_vkApiVersion:')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001511 rbody.append(' {')
1512 rbody.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)(packet->pBody);')
1513 rbody.append(' if (pPacket->version != VK_API_VERSION)')
1514 rbody.append(' {')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001515 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));')
1516 rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_ERROR;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001517 rbody.append(' }')
1518 rbody.append(' break;')
1519 rbody.append(' }')
1520 for proto in self.protos:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001521 ret_value = False
1522 create_view = False
1523 create_func = False
1524 # TODO : How to handle void* return of GetProcAddr?
Jon Ashburnd7770ed2015-09-30 13:41:02 -06001525#TODO make sure vkDestroy object functions really do clean up the object maps
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001526 if ('void' not in proto.ret.lower()) and ('size_t' not in proto.ret) and (proto.name not in custom_body_dict):
1527 ret_value = True
1528 if proto.name in create_view_list:
1529 create_view = True
1530 elif 'Create' in proto.name or proto.name in special_create_list:
1531 create_func = True
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001532 rbody.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001533 rbody.append(' {')
1534 rbody.append(' packet_vk%s* pPacket = (packet_vk%s*)(packet->pBody);' % (proto.name, proto.name))
1535 if proto.name in manually_replay_funcs:
1536 if ret_value == True:
1537 rbody.append(' replayResult = manually_replay_vk%s(pPacket);' % proto.name)
1538 else:
1539 rbody.append(' manually_replay_vk%s(pPacket);' % proto.name)
1540 elif proto.name in custom_body_dict:
1541 rbody.append(custom_body_dict[proto.name]())
1542 else:
1543 if proto.name in custom_open_params:
1544 for pidx in custom_open_params[proto.name]:
1545 rbody.append(' %s local_%s;' % (proto.params[pidx].ty.replace('const ', '').strip('*'), proto.params[pidx].name))
1546 elif create_view:
1547 rbody.append(' %s createInfo;' % (proto.params[1].ty.strip('*').replace('const ', '')))
1548 rbody.append(' memcpy(&createInfo, pPacket->pCreateInfo, sizeof(%s));' % (proto.params[1].ty.strip('*').replace('const ', '')))
1549 if 'CreateComputePipeline' == proto.name:
Chia-I Wue420a332015-10-26 20:04:44 +08001550 rbody.append(' createInfo.cs.shader = m_objMapper.remap_shaders(pPacket->pCreateInfo->cs.shader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001551 elif 'CreateBufferView' == proto.name:
Chia-I Wue420a332015-10-26 20:04:44 +08001552 rbody.append(' createInfo.buffer = m_objMapper.remap_buffers(pPacket->pCreateInfo->buffer);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001553 else:
Chia-I Wue420a332015-10-26 20:04:44 +08001554 rbody.append(' createInfo.image = m_objMapper.remap_images(pPacket->pCreateInfo->image);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001555 rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
1556 elif create_func: # Declare local var to store created handle into
Chia-I Wu1f851912015-10-27 18:04:07 +08001557 if 'AllocateDescriptorSets' == proto.name:
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001558 p_ty = proto.params[-1].ty.strip('*').replace('const ', '')
Chia-I Wu1f851912015-10-27 18:04:07 +08001559 rbody.append(' %s* local_%s = (%s*)malloc(pPacket->pAllocateInfo->setLayoutCount * sizeof(%s));' % (p_ty, proto.params[-1].name, p_ty, p_ty))
1560 rbody.append(' VkDescriptorSetLayout* local_pSetLayouts = (VkDescriptorSetLayout*)malloc(pPacket->pAllocateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout));')
1561 rbody.append(' VkDescriptorSetAllocateInfo local_AllocInfo, *local_pAllocateInfo = &local_AllocInfo;')
Jon Ashburne27a9182015-10-16 17:50:47 -06001562 rbody.append(' VkDescriptorPool local_descPool;')
Chia-I Wu1f851912015-10-27 18:04:07 +08001563 rbody.append(' local_descPool = m_objMapper.remap_descriptorpools(pPacket->pAllocateInfo->descriptorPool);')
1564 rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->setLayoutCount; i++)')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001565 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001566 rbody.append(' local_pSetLayouts[i] = m_objMapper.remap_descriptorsetlayouts(pPacket->%s->pSetLayouts[i]);' % (proto.params[-2].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001567 rbody.append(' }')
Chia-I Wu1f851912015-10-27 18:04:07 +08001568 rbody.append(' memcpy(local_pAllocateInfo, pPacket->pAllocateInfo, sizeof(VkDescriptorSetAllocateInfo));')
1569 rbody.append(' local_pAllocateInfo->pSetLayouts = local_pSetLayouts;')
1570 rbody.append(' local_pAllocateInfo->descriptorPool = local_descPool;')
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001571 else:
1572 rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001573 elif proto.name == 'ResetFences':
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001574 rbody.append(' VkFence* fences = VKTRACE_NEW_ARRAY(VkFence, pPacket->fenceCount);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001575 rbody.append(' for (uint32_t i = 0; i < pPacket->fenceCount; i++)')
1576 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001577 rbody.append(' fences[i] = m_objMapper.remap_fences(pPacket->%s[i]);' % (proto.params[-1].name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001578 rbody.append(' }')
1579 elif proto.name in do_while_dict:
1580 rbody.append(' do {')
Jon Ashburnc736c002015-10-25 20:24:57 -06001581 last_name = ''
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001582 for p in proto.params:
1583 if create_func or create_view:
1584 if p.name != proto.params[-1].name:
Jon Ashburnc736c002015-10-25 20:24:57 -06001585 rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001586 else:
Jon Ashburnc736c002015-10-25 20:24:57 -06001587 rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
1588 last_name = p.name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001589
1590 if proto.name == 'DestroyInstance':
1591 rbody.append(' if (m_vkFuncs.real_vkDbgDestroyMsgCallback != NULL)')
1592 rbody.append(' {')
1593 rbody.append(' m_vkFuncs.real_vkDbgDestroyMsgCallback(remappedinstance, m_dbgMsgCallbackObj);')
1594 rbody.append(' }')
1595 # TODO: need a better way to indicate which extensions should be mapped to which Get*ProcAddr
1596 elif proto.name == 'GetInstanceProcAddr':
1597 for iProto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001598 if 'Dbg' in iProto.name or 'GetPhysicalDeviceSurfaceSupportKHR' in iProto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001599 rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (iProto.name))
1600 rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappedinstance, pPacket->pName);' % (iProto.name, iProto.name, proto.name))
1601 rbody.append(' }')
1602 elif proto.name == 'GetDeviceProcAddr':
1603 for dProto in self.protos:
Ian Elliott338dedb2015-08-21 15:09:33 -06001604 if 'KHR' in dProto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001605 rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (dProto.name))
1606 rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappeddevice, pPacket->pName);' % (dProto.name, dProto.name, proto.name))
1607 rbody.append(' }')
1608
1609 # build the call to the "real_" entrypoint
1610 rr_string = ' '
1611 if ret_value:
1612 rr_string = ' replayResult = '
1613 rr_string += 'm_vkFuncs.real_vk%s(' % proto.name
1614 for p in proto.params:
1615 # For last param of Create funcs, pass address of param
1616 if create_func:
Chia-I Wu1f851912015-10-27 18:04:07 +08001617 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 -06001618 rr_string += 'local_%s, ' % p.name
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001619 elif p.name == proto.params[-1].name:
1620 rr_string += '&local_%s, ' % p.name
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001621 else:
1622 rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
1623 else:
1624 rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
1625 rr_string = '%s);' % rr_string[:-2]
1626 if proto.name in custom_open_params:
1627 rr_list = rr_string.split(', ')
1628 for pidx in custom_open_params[proto.name]:
1629 rr_list[pidx] = '&local_%s' % proto.params[pidx].name
1630 rr_string = ', '.join(rr_list)
1631 rr_string += ');'
1632 elif create_view:
1633 rr_list = rr_string.split(', ')
Chia-I Wu69f40122015-10-26 21:10:41 +08001634 rr_list[-3] = '&createInfo'
1635 rr_list[-2] = 'NULL'
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001636 rr_list[-1] = '&local_%s);' % proto.params[-1].name
1637 rr_string = ', '.join(rr_list)
1638 # this is a sneaky shortcut to use generic create code below to add_to_map
1639 create_func = True
Chia-I Wu1f851912015-10-27 18:04:07 +08001640 elif proto.name == 'AllocateDescriptorSets':
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001641 rr_string = rr_string.replace('pPacket->pSetLayouts', 'pLocalDescSetLayouts')
1642 elif proto.name == 'ResetFences':
1643 rr_string = rr_string.replace('pPacket->pFences', 'fences')
1644
1645 # insert the real_*(..) call
1646 rbody.append(rr_string)
1647
1648 # handle return values or anything that needs to happen after the real_*(..) call
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -06001649 get_ext_layers_proto = ['EnumerateInstanceExtensionProperties', 'EnumerateDeviceExtensionProperties','EnumerateInstanceLayerProperties', 'EnumerateDeviceLayerProperties']
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001650 if 'DestroyDevice' in proto.name:
1651 rbody.append(' if (replayResult == VK_SUCCESS)')
1652 rbody.append(' {')
1653 rbody.append(' m_pCBDump = NULL;')
1654 rbody.append(' m_pDSDump = NULL;')
1655 #TODO138 : disabling snapshot
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001656 #rbody.append(' m_pVktraceSnapshotPrint = NULL;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001657 rbody.append(' m_objMapper.rm_from_devices_map(pPacket->device);')
1658 rbody.append(' m_display->m_initedVK = false;')
1659 rbody.append(' }')
Jon Ashburnc30315e2015-09-07 14:39:30 -06001660 elif proto.name in get_ext_layers_proto:
Courtney Goeltzenleuchterac544f32015-09-14 18:01:17 -06001661 rbody.append(' if (replayResult == VK_ERROR_LAYER_NOT_PRESENT || replayResult == VK_INCOMPLETE)')
Jon Ashburnc30315e2015-09-07 14:39:30 -06001662 rbody.append(' { // ignore errors caused by trace config != replay config')
1663 rbody.append(' replayResult = VK_SUCCESS;')
1664 rbody.append(' }')
Ian Elliott338dedb2015-08-21 15:09:33 -06001665 elif 'DestroySwapchainKHR' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001666 rbody.append(' if (replayResult == VK_SUCCESS)')
1667 rbody.append(' {')
Chia-I Wue420a332015-10-26 20:04:44 +08001668 rbody.append(' m_objMapper.rm_from_swapchainkhrs_map(pPacket->swapchain);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001669 rbody.append(' }')
1670 elif 'DestroyInstance' in proto.name:
1671 rbody.append(' if (replayResult == VK_SUCCESS)')
1672 rbody.append(' {')
1673 rbody.append(' // TODO need to handle multiple instances and only clearing maps within an instance.')
1674 rbody.append(' // TODO this only works with a single instance used at any given time.')
1675 rbody.append(' m_objMapper.clear_all_map_handles();')
1676 rbody.append(' }')
Courtney Goeltzenleuchter5970b252015-10-27 11:32:31 -06001677 elif 'MergePipelineCaches' in proto.name:
1678 rbody.append(' delete remappedpSrcCaches;')
1679 elif 'FreeCommandBuffers' in proto.name:
1680 rbody.append(' delete remappedpCommandBuffers;')
1681 elif 'CmdExecuteCommands' in proto.name:
Chia-I Wu1f851912015-10-27 18:04:07 +08001682 rbody.append(' delete remappedpCommandBuffers;')
1683 elif 'AllocateDescriptorSets' in proto.name:
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001684 rbody.append(' if (replayResult == VK_SUCCESS)')
1685 rbody.append(' {')
Chia-I Wu1f851912015-10-27 18:04:07 +08001686 rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->setLayoutCount; i++) {')
Chia-I Wue420a332015-10-26 20:04:44 +08001687 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 -06001688 rbody.append(' }')
1689 rbody.append(' }')
Jon Ashburn9e8755b2015-08-10 08:53:44 -06001690 rbody.append(' free(local_pSetLayouts);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001691 rbody.append(' free(local_pDescriptorSets);')
1692 elif proto.name == 'ResetFences':
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001693 rbody.append(' VKTRACE_DELETE(fences);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001694 elif create_func: # save handle mapping if create successful
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -06001695 if ret_value:
1696 rbody.append(' if (replayResult == VK_SUCCESS)')
1697 rbody.append(' {')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001698 clean_type = proto.params[-1].ty.strip('*').replace('const ', '')
Jon Ashburncb622a12015-08-06 17:22:53 -06001699 VkNonDispObjType = [o for o in vulkan.object_non_dispatch_list]
Chia-I Wue420a332015-10-26 20:04:44 +08001700 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 +08001701 if 'AllocateMemory' == proto.name:
1702 rbody.append(' m_objMapper.add_entry_to_mapData(local_%s, pPacket->pAllocateInfo->allocationSize);' % (proto.params[-1].name))
Courtney Goeltzenleuchter3ec31622015-10-20 18:04:07 -06001703 if ret_value:
1704 rbody.append(' }')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001705 elif proto.name in do_while_dict:
1706 rbody[-1] = ' %s' % rbody[-1]
1707 rbody.append(' } while (%s);' % do_while_dict[proto.name])
1708 rbody.append(' if (pPacket->result != VK_NOT_READY || replayResult != VK_SUCCESS)')
1709 if ret_value:
1710 rbody.append(' CHECK_RETURN_VALUE(vk%s);' % proto.name)
1711 rbody.append(' break;')
1712 rbody.append(' }')
1713 rbody.append(' default:')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001714 rbody.append(' vktrace_LogWarning("Unrecognized packet_id %u, skipping.", packet->packet_id);')
1715 rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_INVALID_ID;')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001716 rbody.append(' break;')
1717 rbody.append(' }')
1718 rbody.append(' return returnValue;')
1719 rbody.append('}')
1720 return "\n".join(rbody)
1721
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001722class VktraceTraceHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001723 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001724 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001725 header_txt.append('#include "vktrace_vk_vk_packets.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001726 header_txt.append('#include "vktrace_vk_packet_id.h"\n\n')
1727 header_txt.append('void InitTracer(void);\n\n')
1728 header_txt.append('#ifdef WIN32')
1729 header_txt.append('extern INIT_ONCE gInitOnce;')
1730 header_txt.append('\n#elif defined(PLATFORM_LINUX)')
1731 header_txt.append('extern pthread_once_t gInitOnce;')
1732 header_txt.append('#endif\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001733 return "\n".join(header_txt)
1734
1735 def generate_body(self):
Jon Ashburn71654fd2015-09-11 09:18:44 -06001736 body = [self._generate_trace_func_protos()]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001737
1738 return "\n".join(body)
1739
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001740class VktraceTraceC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001741 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001742 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001743 header_txt.append('#include "vktrace_platform.h"')
1744 header_txt.append('#include "vktrace_common.h"')
1745 header_txt.append('#include "vktrace_lib_helpers.h"')
1746 header_txt.append('#include "vktrace_vk_vk.h"')
1747 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001748 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001749 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain.h"')
1750 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001751 header_txt.append('#include "vktrace_interconnect.h"')
1752 header_txt.append('#include "vktrace_filelike.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001753 header_txt.append('#include "vk_struct_size_helper.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001754 header_txt.append('#ifdef PLATFORM_LINUX')
1755 header_txt.append('#include <pthread.h>')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001756 header_txt.append('#endif')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001757 header_txt.append('#include "vktrace_trace_packet_utils.h"')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001758 header_txt.append('#include <stdio.h>\n')
Chia-I Wua5cd6532015-10-28 18:31:57 +08001759 header_txt.append('#include <string.h>\n')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001760 header_txt.append('#ifdef WIN32')
1761 header_txt.append('INIT_ONCE gInitOnce = INIT_ONCE_STATIC_INIT;')
1762 header_txt.append('#elif defined(PLATFORM_LINUX)')
1763 header_txt.append('pthread_once_t gInitOnce = PTHREAD_ONCE_INIT;')
1764 header_txt.append('#endif')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001765 return "\n".join(header_txt)
1766
1767 def generate_body(self):
Jon Ashburn71654fd2015-09-11 09:18:44 -06001768 body = [self._generate_init_funcs(),
Chia-I Wu1f851912015-10-27 18:04:07 +08001769 self._generate_trace_funcs(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001770
1771 return "\n".join(body)
1772
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001773class VktracePacketID(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001774 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001775 header_txt = []
1776 header_txt.append('#pragma once\n')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001777 header_txt.append('#include "vktrace_trace_packet_utils.h"')
1778 header_txt.append('#include "vktrace_trace_packet_identifiers.h"')
1779 header_txt.append('#include "vktrace_interconnect.h"')
1780 header_txt.append('#include "vktrace_vk_vk_packets.h"')
1781 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg_packets.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001782 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg_packets.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001783 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain_packets.h"')
1784 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain_packets.h"')
Jon Ashburncb622a12015-08-06 17:22:53 -06001785 #header_txt.append('#include "vk_enum_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001786 header_txt.append('#ifndef _WIN32')
1787 header_txt.append(' #pragma GCC diagnostic ignored "-Wwrite-strings"')
1788 header_txt.append('#endif')
Jon Ashburncb622a12015-08-06 17:22:53 -06001789 #header_txt.append('#include "vk_struct_string_helper.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001790 #header_txt.append('#include "vk_ext_khr_swapchain_struct_string_helper.h"')
1791 #header_txt.append('#include "vk_ext_khr_device_swapchain_struct_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001792 header_txt.append('#ifndef _WIN32')
1793 header_txt.append(' #pragma GCC diagnostic warning "-Wwrite-strings"')
1794 header_txt.append('#endif')
Ian Elliott338dedb2015-08-21 15:09:33 -06001795 #header_txt.append('#include "vk_ext_khr_swapchain_enum_string_helper.h"')
1796 #header_txt.append('#include "vk_ext_khr_device_swapchain_enum_string_helper.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001797 header_txt.append('#if defined(WIN32)')
1798 header_txt.append('#define snprintf _snprintf')
1799 header_txt.append('#endif')
1800 header_txt.append('#define SEND_ENTRYPOINT_ID(entrypoint) ;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001801 header_txt.append('//#define SEND_ENTRYPOINT_ID(entrypoint) vktrace_TraceInfo(#entrypoint);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001802 header_txt.append('#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) ;')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001803 header_txt.append('//#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) vktrace_TraceInfo(entrypoint, __VA_ARGS__);\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001804 header_txt.append('#define CREATE_TRACE_PACKET(entrypoint, buffer_bytes_needed) \\')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001805 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 -06001806 header_txt.append('#define FINISH_TRACE_PACKET() \\')
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001807 header_txt.append(' vktrace_finalize_trace_packet(pHeader); \\')
1808 header_txt.append(' vktrace_write_trace_packet(pHeader, vktrace_trace_get_trace_file()); \\')
1809 header_txt.append(' vktrace_delete_trace_packet(&pHeader);')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001810 return "\n".join(header_txt)
1811
1812 def generate_body(self):
1813 body = [self._generate_packet_id_enum(),
1814 self._generate_packet_id_name_func(),
Jon Ashburncb622a12015-08-06 17:22:53 -06001815# self._generate_stringify_func(),
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001816 self._generate_interp_func()]
1817
1818 return "\n".join(body)
1819
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001820class VktraceCoreTracePackets(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001821 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001822 header_txt = []
1823 header_txt.append('#pragma once\n')
1824 header_txt.append('#include "vulkan.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001825 header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001826 return "\n".join(header_txt)
1827
1828 def generate_body(self):
1829 body = [self._generate_struct_util_funcs(),
1830 self._generate_interp_funcs()]
1831
1832 return "\n".join(body)
1833
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001834class VktraceExtTraceHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001835 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001836 header_txt = []
1837 header_txt.append('#pragma once\n')
1838 header_txt.append('#include "vulkan.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001839 header_txt.append('#include "%s.h"' % extensionName.lower())
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001840 return "\n".join(header_txt)
1841
1842 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001843 body = [self._generate_trace_func_protos_ext(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001844
1845 return "\n".join(body)
1846
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001847class VktraceExtTraceC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001848 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001849 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001850 header_txt.append('#include "vktrace_platform.h"')
1851 header_txt.append('#include "vktrace_common.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001852 if extensionName == "vk_ext_khr_device_swapchain":
Ian Elliott338dedb2015-08-21 15:09:33 -06001853 header_txt.append('#include "vk_ext_khr_swapchain.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001854 header_txt.append('#include "vktrace_vk_%s.h"' % extensionName.lower())
1855 header_txt.append('#include "vktrace_vk_%s_packets.h"' % extensionName.lower())
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001856 header_txt.append('#include "vktrace_vk_packet_id.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001857 header_txt.append('#include "vk_struct_size_helper.h"')
Chia-I Wu1f851912015-10-27 18:04:07 +08001858 header_txt.append('#include "%s_struct_size_helper.h"' % extensionName.lower())
1859 if extensionName == 'vk_debug_marker_lunarg':
Jon Ashburn71654fd2015-09-11 09:18:44 -06001860 header_txt.append('#include "vk_debug_marker_layer.h"\n')
Jon Ashburn71654fd2015-09-11 09:18:44 -06001861
Jon Ashburn5afdcf62015-09-14 15:17:36 -06001862 header_txt.append('#include "vktrace_lib_helpers.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001863 return "\n".join(header_txt)
1864
1865 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001866 body = [self._generate_trace_funcs(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001867
1868 return "\n".join(body)
1869
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001870class VktraceExtTracePackets(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001871 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001872 header_txt = []
1873 header_txt.append('#pragma once\n')
Chia-I Wu1f851912015-10-27 18:04:07 +08001874 header_txt.append('#include "%s.h"' % extensionName.lower())
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001875 header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001876 return "\n".join(header_txt)
1877
1878 def generate_body(self):
Chia-I Wu1f851912015-10-27 18:04:07 +08001879 body = [self._generate_interp_funcs_ext(self.extensionName)]
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001880
1881 return "\n".join(body)
1882
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001883class VktraceReplayVkFuncPtrs(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001884 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001885 header_txt = []
1886 header_txt.append('#pragma once\n')
1887 header_txt.append('#if defined(PLATFORM_LINUX) || defined(XCB_NVIDIA)')
1888 header_txt.append('#include <xcb/xcb.h>\n')
1889 header_txt.append('#endif')
1890 header_txt.append('#include "vulkan.h"')
1891 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001892 header_txt.append('#include "vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001893 header_txt.append('#include "vk_ext_khr_swapchain.h"')
1894 header_txt.append('#include "vk_ext_khr_device_swapchain.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001895
1896 def generate_body(self):
1897 body = [self._generate_replay_func_ptrs()]
1898 return "\n".join(body)
1899
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001900class VktraceReplayObjMapperHeader(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001901 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001902 header_txt = []
1903 header_txt.append('#pragma once\n')
1904 header_txt.append('#include <set>')
1905 header_txt.append('#include <map>')
1906 header_txt.append('#include <vector>')
1907 header_txt.append('#include <string>')
1908 header_txt.append('#include "vulkan.h"')
1909 header_txt.append('#include "vk_debug_report_lunarg.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001910 header_txt.append('#include "vk_debug_marker_lunarg.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001911 header_txt.append('#include "vk_ext_khr_swapchain.h"')
1912 header_txt.append('#include "vk_ext_khr_device_swapchain.h"')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001913 return "\n".join(header_txt)
1914
1915 def generate_body(self):
1916 body = [self._generate_replay_objmapper_class()]
1917 return "\n".join(body)
1918
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001919class VktraceReplayC(Subcommand):
Chia-I Wu1f851912015-10-27 18:04:07 +08001920 def generate_header(self, extensionName):
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001921 header_txt = []
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001922 header_txt.append('#include "vkreplay_vkreplay.h"\n')
1923 header_txt.append('#include "vkreplay.h"\n')
1924 header_txt.append('#include "vkreplay_main.h"\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001925 header_txt.append('#include <algorithm>')
1926 header_txt.append('#include <queue>')
1927 header_txt.append('\n')
1928 header_txt.append('extern "C" {')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001929 header_txt.append('#include "vktrace_vk_vk_packets.h"')
1930 header_txt.append('#include "vktrace_vk_vk_debug_report_lunarg_packets.h"')
Tobin Ehlise973f772015-08-27 17:41:42 -06001931 header_txt.append('#include "vktrace_vk_vk_debug_marker_lunarg_packets.h"')
Ian Elliott338dedb2015-08-21 15:09:33 -06001932 header_txt.append('#include "vktrace_vk_vk_ext_khr_swapchain_packets.h"')
1933 header_txt.append('#include "vktrace_vk_vk_ext_khr_device_swapchain_packets.h"')
Mark Lobodzinskif39d70c2015-08-14 14:24:50 -06001934 header_txt.append('#include "vktrace_vk_packet_id.h"')
Jon Ashburncb622a12015-08-06 17:22:53 -06001935 #header_txt.append('#include "vk_enum_string_helper.h"\n}\n')
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001936
1937 return "\n".join(header_txt)
1938
1939 def generate_body(self):
1940 body = [self._generate_replay_init_funcs(),
1941 self._generate_replay()]
Jon Ashburncb622a12015-08-06 17:22:53 -06001942 body.append("}")
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001943 return "\n".join(body)
1944
1945def main():
1946 subcommands = {
Mark Lobodzinski87220f82015-08-27 15:30:29 -06001947 "vktrace-trace-h" : VktraceTraceHeader,
1948 "vktrace-trace-c" : VktraceTraceC,
1949 "vktrace-packet-id" : VktracePacketID,
1950 "vktrace-core-trace-packets" : VktraceCoreTracePackets,
1951 "vktrace-ext-trace-h" : VktraceExtTraceHeader,
1952 "vktrace-ext-trace-c" : VktraceExtTraceC,
1953 "vktrace-ext-trace-packets" : VktraceExtTracePackets,
1954 "vktrace-replay-vk-funcs" : VktraceReplayVkFuncPtrs,
1955 "vktrace-replay-obj-mapper-h" : VktraceReplayObjMapperHeader,
1956 "vktrace-replay-c" : VktraceReplayC,
Jon Ashburn4d9cfd22015-08-04 13:35:25 -06001957 }
1958
1959 if len(sys.argv) < 2 or sys.argv[1] not in subcommands:
1960 print("Usage: %s <subcommand> [options]" % sys.argv[0])
1961 print
1962 print("Available subcommands are: %s" % " ".join(subcommands))
1963 exit(1)
1964
1965 subcmd = subcommands[sys.argv[1]](sys.argv[2])
1966 subcmd.run()
1967
1968if __name__ == "__main__":
1969 main()