blob: d2f144d35c0ab770f8dfd0bab18ad2e2a3b5ca1f [file] [log] [blame]
#!/usr/bin/env python3
#
# Vulkan
#
# Copyright (C) 2015-2016 Valve Corporation
# Copyright (C) 2015-2016 LunarG, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Author: Jon Ashburn <jon@lunarg.com>
# Author: Tobin Ehlis <tobin@lunarg.com>
# Author: Peter Lohrmann <peterl@valvesoftware.com>
#
import os, sys
# add main repo directory so vulkan.py can be imported. This needs to be a complete path.
vktrace_scripts_path = os.path.dirname(os.path.abspath(__file__))
main_path = os.path.abspath(vktrace_scripts_path + "/../")
sys.path.append(main_path)
from source_line_info import sourcelineinfo
import vulkan
# vulkan.py doesn't include all the extensions (debug_report missing)
headers = []
objects = []
protos = []
proto_exclusions = [ 'CreateWaylandSurfaceKHR', 'CreateMirSurfaceKHR',
'GetPhysicalDeviceWaylandPresentationSupportKHR', 'GetPhysicalDeviceMirPresentationSupportKHR',
'GetPhysicalDeviceDisplayPropertiesKHR', 'GetPhysicalDeviceDisplayPlanePropertiesKHR',
'GetDisplayPlaneSupportedDisplaysKHR', 'GetDisplayModePropertiesKHR',
'CreateDisplayModeKHR', 'GetDisplayPlaneCapabilitiesKHR', 'CreateDisplayPlaneSurfaceKHR']
for ext in vulkan.extensions_all:
headers.extend(ext.headers)
objects.extend(ext.objects)
protos.extend(ext.protos)
# Add parameters we need to remap, along with their type, in pairs
additional_remap_dict = {}
additional_remap_dict['pImageIndex'] = "uint32_t"
class Subcommand(object):
def __init__(self, argv):
self.argv = argv
self.extensionName = argv
self.headers = headers
self.objects = objects
self.protos = protos
self.lineinfo = sourcelineinfo()
def run(self):
print(self.generate(self.extensionName))
def generate(self, extensionName):
copyright = self.generate_copyright()
header = self.generate_header(extensionName)
body = self.generate_body()
footer = self.generate_footer()
contents = []
if copyright:
contents.append(copyright)
if header:
contents.append(header)
if body:
contents.append(body)
if footer:
contents.append(footer)
return "\n\n".join(contents)
def generate_copyright(self):
return """/* THIS FILE IS GENERATED. DO NOT EDIT. */
/*
*
* Copyright (C) 2015-2016 Valve Corporation
* Copyright (C) 2015-2016 LunarG, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Author: Jon Ashburn <jon@lunarg.com>
* Author: Tobin Ehlis <tobin@lunarg.com>
* Author: Peter Lohrmann <peterl@valvesoftware.com>
*/"""
def generate_header(self, extensionName):
return "\n".join(["#include <" + h + ">" for h in self.headers])
def generate_body(self):
pass
def generate_footer(self):
pass
def _generate_trace_func_protos(self):
func_protos = []
func_protos.append('#ifdef __cplusplus')
func_protos.append('extern"C" {')
func_protos.append('#endif')
func_protos.append('// Hooked function prototypes\n')
for ext in vulkan.extensions_all:
if ext.ifdef:
func_protos.append('#ifdef %s' % ext.ifdef)
for proto in ext.protos:
if proto.name not in proto_exclusions:
func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
# LoaderLayerInterface V0
if proto.name in [ 'GetInstanceProcAddr', 'GetDeviceProcAddr']:
func_protos.append('VK_LAYER_EXPORT %s;' % proto.c_func(prefix="VK_LAYER_LUNARG_vktrace", attr="VKAPI"))
if proto.name in [ 'EnumerateInstanceLayerProperties', 'EnumerateInstanceExtensionProperties',
'EnumerateDeviceLayerProperties', 'EnumerateDeviceExtensionProperties' ]:
func_protos.append('VK_LAYER_EXPORT %s;' % proto.c_func(prefix="vk", attr="VKAPI"))
if ext.ifdef:
func_protos.append('#endif /* %s */' % ext.ifdef)
func_protos.append('#ifdef __cplusplus')
func_protos.append('}')
func_protos.append('#endif')
return "\n".join(func_protos)
def _generate_trace_func_protos_ext(self, extensionName):
func_protos = []
func_protos.append('// Hooked function prototypes\n')
for ext in vulkan.extensions_all:
if (extensionName.lower() == ext.name.lower()):
if ext.ifdef:
func_protos.append('#ifdef %s' % ext.ifdef)
for proto in ext.protos:
if proto.name not in proto_exclusions:
func_protos.append('VKTRACER_EXPORT %s;' % proto.c_func(prefix="__HOOKED_vk", attr="VKAPI"))
# LoaderLayerInterface V0
if proto.name in [ 'GetInstanceProcAddr', 'GetDeviceProcAddr']:
func_protos.append('VK_LAYER_EXPORT %s;' % proto.c_func(prefix="VK_LAYER_LUNARG_vktrace", attr="VKAPI"))
if proto.name in [ 'EnumerateInstanceLayerProperties', 'EnumerateInstanceExtensionProperties',
'EnumerateDeviceLayerProperties', 'EnumerateDeviceExtensionProperties' ]:
func_protos.append('VK_LAYER_EXPORT %s;' % proto.c_func(prefix="vk", attr="VKAPI"))
if ext.ifdef:
func_protos.append('#endif /* %s */' % ext.ifdef)
return "\n".join(func_protos)
# Return set of printf '%' qualifier, input to that qualifier, and any dereference
def _get_printf_params(self, vk_type, name, output_param):
deref = ""
# TODO : Need ENUM and STRUCT checks here
if "VkImageLayout" in vk_type:
return ("%s", "string_%s(%s)" % (vk_type.replace('const ', '').strip('*'), name), deref)
if "VkClearColor" in vk_type:
return ("%p", "(void*)&%s" % name, deref)
if "_type" in vk_type.lower(): # TODO : This should be generic ENUM check
return ("%s", "string_%s(%s)" % (vk_type.replace('const ', '').strip('*'), name), deref)
if "char*" in vk_type:
return ("\\\"%s\\\"", name, "*")
if "uint64_t" in vk_type:
if '*' in vk_type:
return ("%\" PRIu64 \"", "(%s == NULL) ? 0 : *(%s)" % (name, name), "*")
return ("%\" PRIu64 \"", name, deref)
if "uint32_t" in vk_type:
if '*' in vk_type:
return ("%u", "(%s == NULL) ? 0 : *(%s)" % (name, name), "*")
return ("%u", name, deref)
if "xcb_visualid_t" in vk_type:
if '*' in vk_type:
return ("%u", "(%s == NULL) ? 0 : *(%s)" % (name, name), "*")
return ("%u", name, deref)
if "VisualID" in vk_type:
return ("%\" PRIu64 \"", "(uint64_t)%s" % name, deref)
if "VkBool32" in vk_type:
if '*' in vk_type:
return ("%s", "(*%s == VK_TRUE) ? \"VK_TRUE\" : \"VK_FALSE\"" % (name), "*")
return ("%s", "(%s == VK_TRUE) ? \"VK_TRUE\" : \"VK_FALSE\"" %(name), deref)
if "size_t" in vk_type:
if '*' in vk_type:
return ("\" VK_SIZE_T_SPECIFIER \"", "(%s == NULL) ? 0 : *(%s)" % (name, name), "*")
return ("\" VK_SIZE_T_SPECIFIER \"", name, deref)
if "float" in vk_type:
if '[' in vk_type: # handle array, current hard-coded to 4 (TODO: Make this dynamic)
return ("[%f, %f, %f, %f]", "%s[0], %s[1], %s[2], %s[3]" % (name, name, name, name), deref)
return ("%f", name, deref)
if "bool" in vk_type or 'xcb_randr_crtc_t' in vk_type:
return ("%u", name, deref)
if True in [t in vk_type.lower() for t in ["int", "flags", "mask", "xcb_window_t"]]:
if '[' in vk_type: # handle array, current hard-coded to 4 (TODO: Make this dynamic)
return ("[%i, %i, %i, %i]", "%s[0], %s[1], %s[2], %s[3]" % (name, name, name, name), deref)
if '*' in vk_type:
return ("%i", "(%s == NULL) ? 0 : *(%s)" % (name, name), "*")
return ("%i", name, deref)
if output_param:
return ("%p {%\" PRIx64 \"}", "(void*)%s, (%s == NULL) ? 0 : (uint64_t)*(%s)" % (name, name, name), deref)
return ("%p", "(void*)(%s)" % name, deref)
def _generate_init_funcs(self):
init_tracer = []
init_tracer.append('void send_vk_api_version_packet()\n{')
init_tracer.append(' packet_vkApiVersion* pPacket;')
init_tracer.append(' vktrace_trace_packet_header* pHeader;')
init_tracer.append(' pHeader = vktrace_create_trace_packet(VKTRACE_TID_VULKAN, VKTRACE_TPI_VK_vkApiVersion, sizeof(packet_vkApiVersion), 0);')
init_tracer.append(' pPacket = interpret_body_as_vkApiVersion(pHeader);')
init_tracer.append(' pPacket->version = VK_MAKE_VERSION(1, 0, VK_HEADER_VERSION);')
init_tracer.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
init_tracer.append(' FINISH_TRACE_PACKET();\n}\n')
init_tracer.append('extern VKTRACE_CRITICAL_SECTION g_memInfoLock;')
init_tracer.append('#ifdef WIN32\n')
init_tracer.append('BOOL CALLBACK InitTracer(_Inout_ PINIT_ONCE initOnce, _Inout_opt_ PVOID param, _Out_opt_ PVOID *lpContext)\n{')
init_tracer.append('#elif defined(PLATFORM_LINUX)\n')
init_tracer.append('void InitTracer(void)\n{')
init_tracer.append('#endif\n')
init_tracer.append(' const char *ipAddr = vktrace_get_global_var("VKTRACE_LIB_IPADDR");')
init_tracer.append(' if (ipAddr == NULL)')
init_tracer.append(' ipAddr = "127.0.0.1";')
init_tracer.append(' gMessageStream = vktrace_MessageStream_create(FALSE, ipAddr, VKTRACE_BASE_PORT + VKTRACE_TID_VULKAN);')
init_tracer.append(' vktrace_trace_set_trace_file(vktrace_FileLike_create_msg(gMessageStream));')
init_tracer.append(' vktrace_tracelog_set_tracer_id(VKTRACE_TID_VULKAN);')
init_tracer.append(' vktrace_create_critical_section(&g_memInfoLock);')
init_tracer.append(' if (gMessageStream != NULL)')
init_tracer.append(' send_vk_api_version_packet();\n')
init_tracer.append('#ifdef WIN32\n')
init_tracer.append(' return true;\n}\n')
init_tracer.append('#elif defined(PLATFORM_LINUX)\n')
init_tracer.append(' return;\n}\n')
init_tracer.append('#endif\n')
return "\n".join(init_tracer)
# Take a list of params and return a list of dicts w/ ptr param details
def _get_packet_ptr_param_list(self, params):
ptr_param_list = []
# TODO : This is a slightly nicer way to handle custom cases than initial code, however
# this can still be further generalized to eliminate more custom code
# big case to handle is when ptrs to structs have embedded data that needs to be accounted for in packet
custom_ptr_dict = {'VkDeviceCreateInfo': {'add_txt': 'add_VkDeviceCreateInfo_to_packet(pHeader, (VkDeviceCreateInfo**) &(pPacket->pCreateInfo), pCreateInfo)',
'finalize_txt': ''},
'VkApplicationInfo': {'add_txt': 'add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&(pPacket->pApplicationInfo), pApplicationInfo)',
'finalize_txt': ''},
'VkPhysicalDevice': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pGpus), *pGpuCount*sizeof(VkPhysicalDevice), pGpus)',
'finalize_txt': 'default'},
'VkImageCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkImageCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pQueueFamilyIndices), sizeof(uint32_t) * pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pQueueFamilyIndices));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'VkBufferCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkBufferCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pQueueFamilyIndices), sizeof(uint32_t) * pCreateInfo->queueFamilyIndexCount, pCreateInfo->pQueueFamilyIndices)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pQueueFamilyIndices));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'pDataSize': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDataSize), sizeof(size_t), &_dataSize)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pDataSize))'},
'pData': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pData), _dataSize, pData)',
'finalize_txt': 'default'},
'pName': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pName), ((pName != NULL) ? ROUNDUP_TO_4(strlen(pName) + 1) : 0), pName)',
'finalize_txt': 'default'},
'pMarker': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pMarker), ((pMarker != NULL) ? ROUNDUP_TO_4(strlen(pMarker) + 1) : 0), pMarker)',
'finalize_txt': 'default'},
'pExtName': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pExtName), ((pExtName != NULL) ? ROUNDUP_TO_4(strlen(pExtName) + 1) : 0), pExtName)',
'finalize_txt': 'default'},
'pDescriptorSets': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pDescriptorSets), customSize, pDescriptorSets)',
'finalize_txt': 'default'},
'pSparseMemoryRequirements': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pSparseMemoryRequirements), (*pSparseMemoryRequirementCount) * sizeof(VkSparseImageMemoryRequirements), pSparseMemoryRequirements)',
'finalize_txt': 'default'},
'pAllocator': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pAllocator), sizeof(VkAllocationCallbacks), NULL)',
'finalize_txt': 'default'},
'VkSparseImageFormatProperties': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pProperties), (*pPropertyCount) * sizeof(VkSparseImageFormatProperties), pProperties)',
'finalize_txt': 'default'},
'VkSparseMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseMemoryBindInfo), pBindInfo)',
'finalize_txt': 'default'},
'VkSparseImageMemoryBindInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pBindInfo), numBindings * sizeof(VkSparseImageMemoryBindInfo), pBindInfo)',
'finalize_txt': 'default'},
'VkFramebufferCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkFramebufferCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments), colorCount * sizeof(VkColorAttachmentBindInfo), pCreateInfo->pColorAttachments);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment), dsSize, pCreateInfo->pDepthStencilAttachment)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorAttachments));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pDepthStencilAttachment));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'VkRenderPassCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkRenderPassCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats), colorCount * sizeof(VkFormat), pCreateInfo->pColorFormats);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts), colorCount * sizeof(VkImageLayout), pCreateInfo->pColorLayouts);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps), colorCount * sizeof(VkAttachmentLoadOp), pCreateInfo->pColorLoadOps);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps), colorCount * sizeof(VkAttachmentStoreOp), pCreateInfo->pColorStoreOps);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues), colorCount * sizeof(VkClearColor), pCreateInfo->pColorLoadClearValues)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorFormats));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLayouts));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadOps));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorStoreOps));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pColorLoadClearValues));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'VkPipelineLayoutCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkPipelineLayoutCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts), pCreateInfo->setLayoutCount * sizeof(VkDescriptorSetLayout), pCreateInfo->pSetLayouts);'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pPushConstantRanges), pCreateInfo->pushConstantRangeCount * sizeof(VkPushConstantRange), pCreateInfo->pPushConstantRanges);',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pSetLayouts));\n'
'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pPushConstantRanges));\n'
'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'VkMemoryAllocateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo), sizeof(VkMemoryAllocateInfo), pAllocateInfo);\n'
' add_alloc_memory_to_trace_packet(pHeader, (void**)&(pPacket->pAllocateInfo->pNext), pAllocateInfo->pNext)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pAllocateInfo))'},
# 'VkGraphicsPipelineCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfos), count*sizeof(VkGraphicsPipelineCreateInfo), pCreateInfos);\n'
# ' add_VkGraphicsPipelineCreateInfos_to_trace_packet(pHeader, (VkGraphicsPipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
# 'VkComputePipelineCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfos), count*sizeof(VkComputePipelineCreateInfo), pCreateInfos);\n'
# ' add_VkComputePipelineCreateInfos_to_trace_packet(pHeader, (VkComputePipelineCreateInfo*)pPacket->pCreateInfos, pCreateInfos, count)',
# 'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfos))'},
'VkDescriptorPoolCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkDescriptorPoolCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes), pCreateInfo->poolSizeCount * sizeof(VkDescriptorPoolSize), pCreateInfo->pPoolSizes)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pPoolSizes));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'VkDescriptorSetLayoutCreateInfo': {'add_txt': 'add_create_ds_layout_to_trace_packet(pHeader, &pPacket->pCreateInfo, pCreateInfo)',
'finalize_txt': '// pCreateInfo finalized in add_create_ds_layout_to_trace_packet'},
'VkSwapchainCreateInfoKHR': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkSwapchainCreateInfoKHR), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pQueueFamilyIndices), pPacket->pCreateInfo->queueFamilyIndexCount * sizeof(uint32_t), pCreateInfo->pQueueFamilyIndices)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pQueueFamilyIndices));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
'VkShaderModuleCreateInfo': {'add_txt': 'vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo), sizeof(VkShaderModuleCreateInfo), pCreateInfo);\n'
' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(pPacket->pCreateInfo->pCode), pPacket->pCreateInfo->codeSize, pCreateInfo->pCode)',
'finalize_txt': 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo->pCode));\n'
' vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->pCreateInfo))'},
}
for p in params:
pp_dict = {}
if '*' in p.ty and p.name not in ['pTag', 'pUserData']:
if 'const' in p.ty.lower() and 'count' in params[params.index(p)-1].name.lower():
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)
elif 'pOffsets' == p.name: # TODO : This is a custom case for BindVertexBuffers last param, need to clean this up
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)
elif p.ty.strip('*').replace('const ', '') in custom_ptr_dict:
pp_dict['add_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['add_txt']
pp_dict['finalize_txt'] = custom_ptr_dict[p.ty.strip('*').replace('const ', '')]['finalize_txt']
elif p.name in custom_ptr_dict:
pp_dict['add_txt'] = custom_ptr_dict[p.name]['add_txt']
pp_dict['finalize_txt'] = custom_ptr_dict[p.name]['finalize_txt']
# TODO : This is custom hack to account for 2 pData items with dataSize param for sizing
if 'pData' == p.name and 'dataSize' == params[params.index(p)-1].name:
pp_dict['add_txt'] = pp_dict['add_txt'].replace('_dataSize', 'dataSize')
elif 'void' in p.ty and (p.name == 'pData' or p.name == 'pValues'):
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)
pp_dict['finalize_txt'] = '//TODO FIXME vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
else:
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)
if 'finalize_txt' not in pp_dict or 'default' == pp_dict['finalize_txt']:
pp_dict['finalize_txt'] = 'vktrace_finalize_buffer_address(pHeader, (void**)&(pPacket->%s))' % (p.name)
pp_dict['index'] = params.index(p)
ptr_param_list.append(pp_dict)
return ptr_param_list
# Take a list of params and return a list of packet size elements
def _get_packet_size(self, extensionName, params):
ps = [] # List of elements to be added together to account for packet size for given params
skip_list = [] # store params that are already accounted for so we don't count them twice
# Dict of specific params with unique custom sizes
# TODO: Now using bitfields for all stages, need pSetBindPoints to accommodate that.
custom_size_dict = {'pSetBindPoints': '(VK_SHADER_STAGE_COMPUTE * sizeof(uint32_t))', # Accounting for largest possible array
'VkSwapchainCreateInfoKHR' : 'vk_size_vkswapchaincreateinfokhr(pCreateInfo)',
}
size_func_suffix = ''
if extensionName.lower() != "vk_version_1_0":
size_func_suffix = '_%s' % extensionName.lower()
for p in params:
#First handle custom cases
if p.name in ['pCreateInfo', 'pSetLayoutInfoList', 'pBeginInfo', 'pAllocateInfo'] and 'khr' not in p.ty.lower() and 'lunarg' not in p.ty.lower() and 'ext' not in p.ty.lower():
ps.append('get_struct_chain_size%s((void*)%s)' % (size_func_suffix, p.name))
skip_list.append(p.name)
elif p.name in custom_size_dict:
ps.append(custom_size_dict[p.name])
skip_list.append(p.name)
elif p.ty.strip('*').replace('const ', '') in custom_size_dict:
tmp_ty = p.ty.strip('*').replace('const ', '')
ps.append(custom_size_dict[tmp_ty])
skip_list.append(p.name)
# Skip any params already handled
if p.name in skip_list:
continue
# Now check to identify dynamic arrays which depend on two params
if 'count' in p.name.lower():
next_idx = params.index(p)+1
# If next element is a const *, then multiply count and array type
if next_idx < len(params) and '*' in params[next_idx].ty and 'const' in params[next_idx].ty.lower():
if '*' in p.ty:
ps.append('*%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
else:
ps.append('%s*sizeof(%s)' % (p.name, params[next_idx].ty.strip('*').replace('const ', '')))
skip_list.append(params[next_idx].name)
if 'bindingCount' == p.name: # TODO : This is custom case for CmdBindVertexBuffers, need to clean it up
ps.append('%s*sizeof(%s)' % (p.name, params[next_idx+1].ty.strip('*').replace('const ', '')))
skip_list.append(params[next_idx+1].name)
elif '*' in p.ty: # Not a custom array size we're aware of, but ptr so need to account for its size
ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
elif '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
if 'pData' == p.name:
if 'dataSize' == params[params.index(p)-1].name:
ps.append('dataSize')
elif 'counterCount' == params[params.index(p)-1].name:
ps.append('sizeof(%s)' % p.ty.strip('*').replace('const ', ''))
else:
#ps.append('((pDataSize != NULL && pData != NULL) ? *pDataSize : 0)')
ps.append('sizeof(void*)')
elif '**' in p.ty and 'void' in p.ty:
ps.append('sizeof(void*)')
elif 'void' in p.ty:
ps.append('sizeof(%s)' % p.name)
elif 'char' in p.ty:
ps.append('((%s != NULL) ? ROUNDUP_TO_4(strlen(%s) + 1) : 0)' % (p.name, p.name))
elif 'pDataSize' in p.name:
ps.append('((pDataSize != NULL) ? sizeof(size_t) : 0)')
elif 'IMAGE_SUBRESOURCE' in p.ty and 'pSubresource' == p.name:
ps.append('((pSubresource != NULL) ? sizeof(VkImage_SUBRESOURCE) : 0)')
else:
ps.append('sizeof(%s)' % (p.ty.strip('*').replace('const ', '')))
return ps
# Generate functions used to trace API calls and store the input and result data into a packet
# Here's the general flow of code insertion w/ option items flagged w/ "?"
# Result decl?
# Packet struct decl
# ?Special case : setup call to function first and do custom API call time tracking
# CREATE_PACKET
# call real entrypoint and get return value (if there is one)
# Assign packet values
# FINISH packet
# return result if needed
def _generate_trace_funcs(self, extensionName):
func_body = []
manually_written_hooked_funcs = ['AllocateCommandBuffers',
'AllocateMemory',
'AllocateDescriptorSets',
'BeginCommandBuffer',
'CreateDescriptorPool',
'CreateDevice',
'CreateFramebuffer',
'CreateInstance',
'CreatePipelineCache',
'CreateRenderPass',
'GetPipelineCacheData',
'CreateGraphicsPipelines',
'CreateComputePipelines',
'CmdPipelineBarrier',
'CmdWaitEvents',
'CmdBeginRenderPass',
'CmdPushConstants',
'DestroyInstance',
'EnumeratePhysicalDevices',
'FreeMemory',
'FreeDescriptorSets',
'QueueSubmit',
'QueueBindSparse',
'FlushMappedMemoryRanges',
'InvalidateMappedMemoryRanges',
'GetDeviceProcAddr',
'GetInstanceProcAddr',
'EnumerateInstanceExtensionProperties',
'EnumerateDeviceExtensionProperties',
'EnumerateInstanceLayerProperties',
'EnumerateDeviceLayerProperties',
'GetPhysicalDeviceQueueFamilyProperties',
'GetQueryPoolResults',
'MapMemory',
'UnmapMemory',
'UpdateDescriptorSets',
'GetPhysicalDeviceSurfaceCapabilitiesKHR',
'GetPhysicalDeviceSurfaceFormatsKHR',
'GetPhysicalDeviceSurfacePresentModesKHR',
'CreateSwapchainKHR',
'GetSwapchainImagesKHR',
'QueuePresentKHR',
#TODO add Wayland, Mir
'CreateXcbSurfaceKHR',
'CreateXlibSurfaceKHR',
'GetPhysicalDeviceXcbPresentationSupportKHR',
'GetPhysicalDeviceXlibPresentationSupportKHR',
'CreateWin32SurfaceKHR',
'GetPhysicalDeviceWin32PresentationSupportKHR',
'CreateAndroidSurfaceKHR',
]
# validate the manually_written_hooked_funcs list
protoFuncs = [proto.name for proto in self.protos]
wsi_platform_manual_funcs = ['CreateWin32SurfaceKHR', 'CreateXcbSurfaceKHR', 'CreateXlibSurfaceKHR', 'CreateAndroidSurfaceKHR',
'GetPhysicalDeviceXcbPresentationSupportKHR','GetPhysicalDeviceXlibPresentationSupportKHR', 'GetPhysicalDeviceWin32PresentationSupportKHR']
for func in manually_written_hooked_funcs:
if (func not in protoFuncs) and (func not in wsi_platform_manual_funcs):
sys.exit("Entry '%s' in manually_written_hooked_funcs list is not in the vulkan function prototypes" % func)
# process each of the entrypoint prototypes
approved_ext = ['vk_khr_surface', 'vk_khr_swapchain', 'vk_khr_win32_surface', 'vk_khr_xcb_surface', 'vk_ext_debug_report']
for ext in vulkan.extensions_all:
if (ext.name.lower() == extensionName.lower()) or ((extensionName.lower() == 'vk_version_1_0') and (ext.name.lower() in approved_ext)):
for proto in ext.protos:
if proto.name in manually_written_hooked_funcs:
func_body.append( '// __HOOKED_vk%s is manually written. Look in vktrace_lib_trace.cpp\n' % proto.name)
elif proto.name not in proto_exclusions:
raw_packet_update_list = [] # non-ptr elements placed directly into packet
ptr_packet_update_list = [] # ptr elements to be updated into packet
return_txt = ''
packet_size = []
in_data_size = False # flag when we need to capture local input size variable for in/out size
func_body.append('%s' % self.lineinfo.get())
func_body.append('VKTRACER_EXPORT VKAPI_ATTR %s VKAPI_CALL __HOOKED_vk%s(' % (proto.ret, proto.name))
for p in proto.params: # TODO : For all of the ptr types, check them for NULL and return 0 if NULL
func_body.append(' %s,' % p.c())
if '*' in p.ty and p.name not in ['pSysMem', 'pReserved']:
if 'pDataSize' in p.name:
in_data_size = True;
elif 'pfnMsgCallback' == p.name:
raw_packet_update_list.append(' PFN_vkDebugReportCallbackEXT* pNonConstCallback = (PFN_vkDebugReportCallbackEXT*)&pPacket->pfnMsgCallback;')
raw_packet_update_list.append(' *pNonConstCallback = pfnMsgCallback;')
elif '[' in p.ty:
raw_packet_update_list.append(' memcpy((void *) pPacket->%s, %s, sizeof(pPacket->%s));' % (p.name, p.name, p.name))
else:
raw_packet_update_list.append(' pPacket->%s = %s;' % (p.name, p.name))
# Get list of packet size modifiers due to ptr params
packet_size = self._get_packet_size(extensionName, proto.params)
ptr_packet_update_list = self._get_packet_ptr_param_list(proto.params)
func_body[-1] = func_body[-1].replace(',', ')')
# End of function declaration portion, begin function body
func_body.append('{\n vktrace_trace_packet_header* pHeader;')
if 'void' not in proto.ret or '*' in proto.ret:
func_body.append(' %s result;' % proto.ret)
return_txt = 'result = '
if in_data_size:
func_body.append(' size_t _dataSize;')
func_body.append(' packet_vk%s* pPacket = NULL;' % proto.name)
if proto.name == "DestroyInstance" or proto.name == "DestroyDevice":
func_body.append(' dispatch_key key = get_dispatch_key(%s);' % proto.params[0].name)
if (0 == len(packet_size)):
func_body.append(' CREATE_TRACE_PACKET(vk%s, 0);' % (proto.name))
else:
func_body.append(' CREATE_TRACE_PACKET(vk%s, %s);' % (proto.name, ' + '.join(packet_size)))
# call down the layer chain and get return value (if there is one)
# Note: this logic doesn't work for CreateInstance or CreateDevice but those are handwritten
if extensionName == 'vk_lunarg_debug_marker':
table_txt = 'mdd(%s)->debugMarkerTable' % proto.params[0].name
elif proto.params[0].ty in ['VkInstance', 'VkPhysicalDevice']:
table_txt = 'mid(%s)->instTable' % proto.params[0].name
else:
table_txt = 'mdd(%s)->devTable' % proto.params[0].name
func_body.append(' %s%s.%s;' % (return_txt, table_txt, proto.c_call()))
func_body.append(' vktrace_set_packet_entrypoint_end_time(pHeader);')
if in_data_size:
func_body.append(' _dataSize = (pDataSize == NULL || pData == NULL) ? 0 : *pDataSize;')
func_body.append(' pPacket = interpret_body_as_vk%s(pHeader);' % proto.name)
func_body.append('\n'.join(raw_packet_update_list))
for pp_dict in ptr_packet_update_list: #buff_ptr_indices:
func_body.append(' %s;' % (pp_dict['add_txt']))
if 'void' not in proto.ret or '*' in proto.ret:
func_body.append(' pPacket->result = result;')
for pp_dict in ptr_packet_update_list:
if ('DeviceCreateInfo' not in proto.params[pp_dict['index']].ty):
func_body.append(' %s;' % (pp_dict['finalize_txt']))
# All buffers should be finalized by now, and the trace packet can be finished (which sends it over the socket)
func_body.append(' FINISH_TRACE_PACKET();')
if proto.name == "DestroyInstance":
func_body.append(' g_instanceDataMap.erase(key);')
elif proto.name == "DestroyDevice":
func_body.append(' g_deviceDataMap.erase(key);')
# return result if needed
if 'void' not in proto.ret or '*' in proto.ret:
func_body.append(' return result;')
func_body.append('}\n')
return "\n".join(func_body)
def _generate_packet_id_enum(self):
pid_enum = []
pid_enum.append('enum VKTRACE_TRACE_PACKET_ID_VK')
pid_enum.append('{')
first_func = True
for proto in self.protos:
if proto.name in proto_exclusions:
continue
if first_func:
first_func = False
pid_enum.append(' VKTRACE_TPI_VK_vkApiVersion = VKTRACE_TPI_BEGIN_API_HERE,')
pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
else:
pid_enum.append(' VKTRACE_TPI_VK_vk%s,' % proto.name)
pid_enum.append('};\n')
return "\n".join(pid_enum)
def _generate_packet_id_name_func(self):
func_body = []
func_body.append('static const char *vktrace_vk_packet_id_name(const enum VKTRACE_TRACE_PACKET_ID_VK id)')
func_body.append('{')
func_body.append(' switch(id) {')
func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
func_body.append(' {')
func_body.append(' return "vkApiVersion";')
func_body.append(' }')
for proto in self.protos:
if proto.name in proto_exclusions:
continue
func_body.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
func_body.append(' {')
func_body.append(' return "vk%s";' % proto.name)
func_body.append(' }')
func_body.append(' default:')
func_body.append(' return NULL;')
func_body.append(' }')
func_body.append('}\n')
return "\n".join(func_body)
def _generate_stringify_func(self):
func_body = []
func_body.append('static const char *vktrace_stringify_vk_packet_id(const enum VKTRACE_TRACE_PACKET_ID_VK id, const vktrace_trace_packet_header* pHeader)')
func_body.append('{')
func_body.append(' static char str[1024];')
func_body.append(' switch(id) {')
func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
func_body.append(' {')
func_body.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)(pHeader->pBody);')
func_body.append(' snprintf(str, 1024, "vkApiVersion = 0x%x", pPacket->version);')
func_body.append(' return str;')
func_body.append(' }')
for proto in self.protos:
if proto.name in proto_exclusions:
continue
func_body.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
func_body.append(' {')
func_str = 'vk%s(' % proto.name
print_vals = ''
create_func = False
if 'Create' in proto.name or 'Alloc' in proto.name or 'MapMemory' in proto.name:
create_func = True
for p in proto.params:
last_param = False
if (p.name == proto.params[-1].name):
last_param = True
if last_param and create_func: # last param of create func
(pft, pfi, ptr) = self._get_printf_params(p.ty,'pPacket->%s' % p.name, True)
else:
(pft, pfi, ptr) = self._get_printf_params(p.ty, 'pPacket->%s' % p.name, False)
if last_param == True:
func_str += '%s%s = %s)' % (ptr, p.name, pft)
print_vals += ', %s' % (pfi)
else:
func_str += '%s%s = %s, ' % (ptr, p.name, pft)
print_vals += ', %s' % (pfi)
func_body.append(' packet_vk%s* pPacket = (packet_vk%s*)(pHeader->pBody);' % (proto.name, proto.name))
func_body.append(' snprintf(str, 1024, "%s"%s);' % (func_str, print_vals))
func_body.append(' return str;')
func_body.append(' }')
func_body.append(' default:')
func_body.append(' return NULL;')
func_body.append(' }')
func_body.append('};\n')
return "\n".join(func_body)
def _generate_interp_func(self):
interp_func_body = []
interp_func_body.append('%s' % self.lineinfo.get())
interp_func_body.append('static vktrace_trace_packet_header* interpret_trace_packet_vk(vktrace_trace_packet_header* pHeader)')
interp_func_body.append('{')
interp_func_body.append(' if (pHeader == NULL)')
interp_func_body.append(' {')
interp_func_body.append(' return NULL;')
interp_func_body.append(' }')
interp_func_body.append(' switch (pHeader->packet_id)')
interp_func_body.append(' {')
interp_func_body.append(' case VKTRACE_TPI_VK_vkApiVersion:')
interp_func_body.append(' {')
interp_func_body.append(' return interpret_body_as_vkApiVersion(pHeader)->header;')
interp_func_body.append(' }')
for proto in self.protos:
if proto.name in proto_exclusions:
continue
interp_func_body.append(' case VKTRACE_TPI_VK_vk%s:\n {' % proto.name)
header_prefix = 'h'
if 'Dbg' in proto.name :
header_prefix = 'pH'
interp_func_body.append('%s' % self.lineinfo.get())
interp_func_body.append(' return interpret_body_as_vk%s(pHeader)->%seader;\n }' % (proto.name, header_prefix))
interp_func_body.append(' default:')
interp_func_body.append(' return NULL;')
interp_func_body.append(' }')
interp_func_body.append(' return NULL;')
interp_func_body.append('}')
return "\n".join(interp_func_body)
def _generate_struct_util_funcs(self):
lineinfo = self.lineinfo
pid_enum = []
pid_enum.append('%s' % lineinfo.get())
pid_enum.append('//=============================================================================')
pid_enum.append('static void add_VkApplicationInfo_to_packet(vktrace_trace_packet_header* pHeader, VkApplicationInfo** ppStruct, const VkApplicationInfo *pInStruct)')
pid_enum.append('{')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkApplicationInfo), pInStruct);')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->pApplicationName), (pInStruct->pApplicationName != NULL) ? ROUNDUP_TO_4(strlen(pInStruct->pApplicationName) + 1) : 0, pInStruct->pApplicationName);')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->pEngineName), (pInStruct->pEngineName != NULL) ? ROUNDUP_TO_4(strlen(pInStruct->pEngineName) + 1) : 0, pInStruct->pEngineName);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pApplicationName));')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&((*ppStruct)->pEngineName));')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&*ppStruct);')
pid_enum.append('};\n')
pid_enum.append('%s' % lineinfo.get())
pid_enum.append('static void add_VkInstanceCreateInfo_to_packet(vktrace_trace_packet_header* pHeader, VkInstanceCreateInfo** ppStruct, VkInstanceCreateInfo *pInStruct)')
pid_enum.append('{')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkInstanceCreateInfo), pInStruct);')
pid_enum.append(' if (pInStruct->pApplicationInfo) add_VkApplicationInfo_to_packet(pHeader, (VkApplicationInfo**)&((*ppStruct)->pApplicationInfo), pInStruct->pApplicationInfo);')
# TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
pid_enum.append(' uint32_t i, siz = 0;')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
pid_enum.append(' if (pInStruct->enabledLayerCount > 0) ')
pid_enum.append(' {')
pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerCount; i++) {')
pid_enum.append(' siz = (uint32_t) ROUNDUP_TO_4(1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
pid_enum.append(' if (pInStruct->enabledExtensionCount > 0) ')
pid_enum.append(' {')
pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionCount; i++) {')
pid_enum.append(' siz = (uint32_t) ROUNDUP_TO_4(1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
pid_enum.append('}\n')
pid_enum.append('%s' % lineinfo.get())
pid_enum.append('static void add_VkDeviceCreateInfo_to_packet(vktrace_trace_packet_header* pHeader, VkDeviceCreateInfo** ppStruct, const VkDeviceCreateInfo *pInStruct)')
pid_enum.append('{')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)ppStruct, sizeof(VkDeviceCreateInfo), pInStruct);')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pQueueCreateInfos, pInStruct->queueCreateInfoCount*sizeof(VkDeviceQueueCreateInfo), pInStruct->pQueueCreateInfos);')
pid_enum.append(' for (uint32_t i = 0; i < pInStruct->queueCreateInfoCount; i++) {')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pQueueCreateInfos[i].pQueuePriorities,')
pid_enum.append(' pInStruct->pQueueCreateInfos[i].queueCount*sizeof(float),')
pid_enum.append(' pInStruct->pQueueCreateInfos[i].pQueuePriorities);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pQueueCreateInfos[i].pQueuePriorities);')
pid_enum.append(' }')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pQueueCreateInfos);')
# TODO138 : This is an initial pass at getting the extension/layer arrays correct, needs to be validated.
pid_enum.append(' uint32_t i, siz = 0;')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledLayerNames), pInStruct->enabledLayerCount * sizeof(char*), pInStruct->ppEnabledLayerNames);')
pid_enum.append(' if (pInStruct->enabledLayerCount > 0) ')
pid_enum.append(' {')
pid_enum.append(' for (i = 0; i < pInStruct->enabledLayerCount; i++) {')
pid_enum.append(' siz = (uint32_t) ROUNDUP_TO_4(1 + strlen(pInStruct->ppEnabledLayerNames[i]));')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledLayerNames[i]), siz, pInStruct->ppEnabledLayerNames[i]);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledLayerNames);')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&((*ppStruct)->ppEnabledExtensionNames), pInStruct->enabledExtensionCount * sizeof(char*), pInStruct->ppEnabledExtensionNames);')
pid_enum.append(' if (pInStruct->enabledExtensionCount > 0) ')
pid_enum.append(' {')
pid_enum.append(' for (i = 0; i < pInStruct->enabledExtensionCount; i++) {')
pid_enum.append(' siz = (uint32_t) ROUNDUP_TO_4(1 + strlen(pInStruct->ppEnabledExtensionNames[i]));')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)(&(*ppStruct)->ppEnabledExtensionNames[i]), siz, pInStruct->ppEnabledExtensionNames[i]);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void **)&(*ppStruct)->ppEnabledExtensionNames);')
pid_enum.append(' vktrace_add_buffer_to_trace_packet(pHeader, (void**)&(*ppStruct)->pEnabledFeatures, sizeof(VkPhysicalDeviceFeatures), pInStruct->pEnabledFeatures);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)&(*ppStruct)->pEnabledFeatures);')
pid_enum.append(' vktrace_finalize_buffer_address(pHeader, (void**)ppStruct);')
pid_enum.append('}\n')
pid_enum.append('%s' % lineinfo.get())
pid_enum.append('//=============================================================================\n')
pid_enum.append('static VkInstanceCreateInfo* interpret_VkInstanceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
pid_enum.append('{')
pid_enum.append(' VkInstanceCreateInfo* pVkInstanceCreateInfo = (VkInstanceCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)ptr_variable);\n')
pid_enum.append(' uint32_t i;')
pid_enum.append(' if (pVkInstanceCreateInfo != NULL)')
pid_enum.append(' {')
pid_enum.append(' pVkInstanceCreateInfo->pApplicationInfo = (VkApplicationInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo);')
pid_enum.append(' VkApplicationInfo** ppApplicationInfo = (VkApplicationInfo**) &pVkInstanceCreateInfo->pApplicationInfo;')
pid_enum.append(' if (pVkInstanceCreateInfo->pApplicationInfo)')
pid_enum.append(' {')
pid_enum.append(' (*ppApplicationInfo)->pApplicationName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo->pApplicationName);')
pid_enum.append(' (*ppApplicationInfo)->pEngineName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->pApplicationInfo->pEngineName);')
pid_enum.append(' }')
pid_enum.append(' if (pVkInstanceCreateInfo->enabledLayerCount > 0)')
pid_enum.append(' {')
pid_enum.append(' pVkInstanceCreateInfo->ppEnabledLayerNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledLayerNames);')
pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledLayerCount; i++) {')
pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledLayerNames[i];')
pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledLayerNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' if (pVkInstanceCreateInfo->enabledExtensionCount > 0)')
pid_enum.append(' {')
pid_enum.append(' pVkInstanceCreateInfo->ppEnabledExtensionNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledExtensionNames);')
pid_enum.append(' for (i = 0; i < pVkInstanceCreateInfo->enabledExtensionCount; i++) {')
pid_enum.append(' char** ppTmp = (char**)&pVkInstanceCreateInfo->ppEnabledExtensionNames[i];')
pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkInstanceCreateInfo->ppEnabledExtensionNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' }\n')
pid_enum.append(' return pVkInstanceCreateInfo;')
pid_enum.append('}\n')
pid_enum.append('%s' % lineinfo.get())
pid_enum.append('static VkDeviceCreateInfo* interpret_VkDeviceCreateInfo(vktrace_trace_packet_header* pHeader, intptr_t ptr_variable)')
pid_enum.append('{')
pid_enum.append(' VkDeviceCreateInfo* pVkDeviceCreateInfo = (VkDeviceCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)ptr_variable);\n')
pid_enum.append(' uint32_t i;')
pid_enum.append(' if (pVkDeviceCreateInfo != NULL)')
pid_enum.append(' {')
pid_enum.append(' if (pVkDeviceCreateInfo->queueCreateInfoCount > 0)')
pid_enum.append(' {')
pid_enum.append(' pVkDeviceCreateInfo->pQueueCreateInfos = (const VkDeviceQueueCreateInfo *)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->pQueueCreateInfos);')
pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->queueCreateInfoCount; i++) {')
pid_enum.append(' float** ppQueuePriority = (float**)&pVkDeviceCreateInfo->pQueueCreateInfos[i].pQueuePriorities;')
pid_enum.append(' *ppQueuePriority = (float*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->pQueueCreateInfos[i].pQueuePriorities);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' if (pVkDeviceCreateInfo->enabledLayerCount > 0)')
pid_enum.append(' {')
pid_enum.append(' pVkDeviceCreateInfo->ppEnabledLayerNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledLayerNames);')
pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledLayerCount; i++) {')
pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledLayerNames[i];')
pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledLayerNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' if (pVkDeviceCreateInfo->enabledExtensionCount > 0)')
pid_enum.append(' {')
pid_enum.append(' pVkDeviceCreateInfo->ppEnabledExtensionNames = (const char* const*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledExtensionNames);')
pid_enum.append(' for (i = 0; i < pVkDeviceCreateInfo->enabledExtensionCount; i++) {')
pid_enum.append(' char** ppTmp = (char**)&pVkDeviceCreateInfo->ppEnabledExtensionNames[i];')
pid_enum.append(' *ppTmp = (char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->ppEnabledExtensionNames[i]);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append(' pVkDeviceCreateInfo->pEnabledFeatures = (const VkPhysicalDeviceFeatures*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pVkDeviceCreateInfo->pEnabledFeatures);\n')
pid_enum.append(' }\n')
pid_enum.append(' return pVkDeviceCreateInfo;')
pid_enum.append('}\n')
pid_enum.append('%s' % lineinfo.get())
pid_enum.append('static void interpret_VkPipelineShaderStageCreateInfo(vktrace_trace_packet_header* pHeader, VkPipelineShaderStageCreateInfo* pShader)')
pid_enum.append('{')
pid_enum.append(' if (pShader != NULL)')
pid_enum.append(' {')
pid_enum.append(' pShader->pName = (const char*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pName);')
pid_enum.append(' // specialization info')
pid_enum.append(' pShader->pSpecializationInfo = (const VkSpecializationInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pSpecializationInfo);')
pid_enum.append(' if (pShader->pSpecializationInfo != NULL)')
pid_enum.append(' {')
pid_enum.append(' VkSpecializationInfo* pInfo = (VkSpecializationInfo*)pShader->pSpecializationInfo;')
pid_enum.append(' pInfo->pMapEntries = (const VkSpecializationMapEntry*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pSpecializationInfo->pMapEntries);')
pid_enum.append(' pInfo->pData = (const void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pShader->pSpecializationInfo->pData);')
pid_enum.append(' }')
pid_enum.append(' }')
pid_enum.append('}\n')
pid_enum.append('//=============================================================================')
return "\n".join(pid_enum)
# Interpret functions used on replay to read in packets and interpret their contents
# This code gets generated into vktrace_vk_vk_packets.h file
def _generate_interp_funcs(self):
# Custom txt for given function and parameter. First check if param is NULL, then insert txt if not
# First some common code used by both CmdWaitEvents & CmdPipelineBarrier
mem_barrier_interp = ['uint32_t i = 0;\n',
'for (i = 0; i < pPacket->memoryBarrierCount; i++) {\n',
' void** ppMB = (void**)&(pPacket->ppMemoryBarriers[i]);\n',
' *ppMB = vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppMemoryBarriers[i]);\n',
' //VkMemoryBarrier* pBarr = (VkMemoryBarrier*)pPacket->ppMemoryBarriers[i];\n',
' // TODO : Could fix up the pNext ptrs here if they were finalized and if we cared by switching on Barrier type and remapping\n',
'}']
create_rp_interp = ['VkRenderPassCreateInfo* pInfo = (VkRenderPassCreateInfo*)pPacket->pCreateInfo;\n',
'uint32_t i = 0;\n',
'VkAttachmentDescription **ppAD = (VkAttachmentDescription **)&(pInfo->pAttachments);\n',
'*ppAD = (VkAttachmentDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pAttachments);\n',
'VkSubpassDescription** ppSP = (VkSubpassDescription**)&(pInfo->pSubpasses);\n',
'*ppSP = (VkSubpassDescription*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses);\n',
'for (i=0; i<pInfo->subpassCount; i++) {\n',
' VkAttachmentReference** pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pInputAttachments);\n',
' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pInputAttachments);\n',
' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pColorAttachments);\n',
' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pColorAttachments);\n',
' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pResolveAttachments);\n',
' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pResolveAttachments);\n',
' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pDepthStencilAttachment);\n',
' pAR = (VkAttachmentReference**)&(pInfo->pSubpasses[i].pPreserveAttachments);\n',
' *pAR = (VkAttachmentReference*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pSubpasses[i].pPreserveAttachments);\n',
'}\n',
'VkSubpassDependency** ppSD = (VkSubpassDependency**)&(pInfo->pDependencies);\n',
'*ppSD = (VkSubpassDependency*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pInfo->pDependencies);\n']
create_gfx_pipe = ['uint32_t i;\n',
'uint32_t j;\n',
'for (i=0; i<pPacket->createInfoCount; i++) {\n',
'if (pPacket->pCreateInfos[i].sType == VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO) {\n',
'// need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
'VkGraphicsPipelineCreateInfo* pNonConst = (VkGraphicsPipelineCreateInfo*)&(pPacket->pCreateInfos[i]);\n',
'// shader stages array\n',
'pNonConst->pStages = (VkPipelineShaderStageCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pStages);\n',
'for (j = 0; j < pPacket->pCreateInfos[i].stageCount; j++)\n',
'{\n',
' interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)&pPacket->pCreateInfos[i].pStages[j]);\n',
'}\n',
'// Vertex Input State\n',
'pNonConst->pVertexInputState = (VkPipelineVertexInputStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState);\n',
'VkPipelineVertexInputStateCreateInfo* pNonConstVIState = (VkPipelineVertexInputStateCreateInfo*)pNonConst->pVertexInputState;\n',
'if (pNonConstVIState) {\n',
' pNonConstVIState->pVertexBindingDescriptions = (const VkVertexInputBindingDescription*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState->pVertexBindingDescriptions);\n',
' pNonConstVIState->pVertexAttributeDescriptions = (const VkVertexInputAttributeDescription*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pVertexInputState->pVertexAttributeDescriptions);\n',
'}\n',
'// Input Assembly State\n',
'pNonConst->pInputAssemblyState = (const VkPipelineInputAssemblyStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pInputAssemblyState);\n',
'// Tesselation State\n',
'pNonConst->pTessellationState = (const VkPipelineTessellationStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pTessellationState);\n',
'// Viewport State\n',
'pNonConst->pViewportState = (const VkPipelineViewportStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pViewportState);\n',
'// Raster State\n',
'pNonConst->pRasterizationState = (const VkPipelineRasterizationStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pRasterizationState);\n',
'// MultiSample State\n',
'pNonConst->pMultisampleState = (const VkPipelineMultisampleStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pMultisampleState);\n',
'// DepthStencil State\n',
'pNonConst->pDepthStencilState = (const VkPipelineDepthStencilStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDepthStencilState);\n',
'// DynamicState State\n',
'pNonConst->pDynamicState = (const VkPipelineDynamicStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState);\n',
'VkPipelineDynamicStateCreateInfo* pNonConstDyState = (VkPipelineDynamicStateCreateInfo*)pNonConst->pDynamicState;\n',
'if (pNonConstDyState) {\n',
' pNonConstDyState->pDynamicStates = (const VkDynamicState*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pDynamicState->pDynamicStates);\n',
'}\n',
'// ColorBuffer State\n',
'pNonConst->pColorBlendState = (const VkPipelineColorBlendStateCreateInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pColorBlendState);\n',
'VkPipelineColorBlendStateCreateInfo* pNonConstCbState = (VkPipelineColorBlendStateCreateInfo*)pNonConst->pColorBlendState;\n',
'if (pNonConstCbState)\n',
' pNonConstCbState->pAttachments = (const VkPipelineColorBlendAttachmentState*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfos[i].pColorBlendState->pAttachments);\n',
'} else {\n',
' // This is unexpected.\n',
' vktrace_LogError("CreateGraphicsPipelines must have CreateInfo stype of VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO.");\n',
' pPacket->header = NULL;\n',
'}\n',
'}\n']
# 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
# 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
custom_case_dict = { #'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkFramebufferCreateInfo* pInfo = (VkFramebufferCreateInfo*)pPacket->pCreateInfo;\n',
# 'pInfo->pColorAttachments = (VkColorAttachmentBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pColorAttachments);\n',
# 'pInfo->pDepthStencilAttachment = (VkDepthStencilBindInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pDepthStencilAttachment);\n']},
'CreateRenderPass' : {'param': 'pCreateInfo', 'txt': create_rp_interp},
'CreatePipelineCache' : {'param': 'pCreateInfo', 'txt': [
'((VkPipelineCacheCreateInfo *)pPacket->pCreateInfo)->pInitialData = (const void*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pInitialData);\n']},
'CreatePipelineLayout' : {'param': 'pCreateInfo', 'txt': ['VkPipelineLayoutCreateInfo* pInfo = (VkPipelineLayoutCreateInfo*)pPacket->pCreateInfo;\n',
'pInfo->pSetLayouts = (VkDescriptorSetLayout*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pSetLayouts);\n',
'pInfo->pPushConstantRanges = (VkPushConstantRange*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pPushConstantRanges);\n']},
'CreateDescriptorPool' : {'param': 'pCreateInfo', 'txt': ['VkDescriptorPoolCreateInfo* pInfo = (VkDescriptorPoolCreateInfo*)pPacket->pCreateInfo;\n',
'pInfo->pPoolSizes = (VkDescriptorPoolSize*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pPoolSizes);\n']},
'CmdWaitEvents' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
'CmdPipelineBarrier' : {'param': 'ppMemoryBarriers', 'txt': mem_barrier_interp},
'CreateDescriptorSetLayout' : {'param': 'pCreateInfo', 'txt': ['if (pPacket->pCreateInfo->sType == VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO) {\n',
' VkDescriptorSetLayoutCreateInfo* pNext = (VkDescriptorSetLayoutCreateInfo*)pPacket->pCreateInfo;\n',
' do\n',' {\n',
' // need to make a non-const pointer to the pointer so that we can properly change the original pointer to the interpretted one\n',
' void** ppNextVoidPtr = (void**)&(pNext->pNext);\n',
' *ppNextVoidPtr = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pNext);\n',
' switch(pNext->sType)\n', ' {\n',
' case VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO:\n',
' {\n' ,
' unsigned int i = 0;\n',
' pNext->pBindings = (VkDescriptorSetLayoutBinding*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBindings);\n',
' for (i = 0; i < pNext->bindingCount; i++)\n',' {\n',
' VkSampler** ppSamplers = (VkSampler**)&(pNext->pBindings[i].pImmutableSamplers);\n',
' *ppSamplers = (VkSampler*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pNext->pBindings[i].pImmutableSamplers);\n',
' }\n',
' break;\n',
' }\n',
' default:\n',
' {\n',
' vktrace_LogError("Encountered an unexpected type in descriptor set layout create list.");\n',
' pPacket->header = NULL;\n',
' pNext->pNext = NULL;\n',
' }\n',
' }\n',
' pNext = (VkDescriptorSetLayoutCreateInfo*)pNext->pNext;\n',
' } while (NULL != pNext);\n',
'} else {\n',
' // This is unexpected.\n',
' vktrace_LogError("CreateDescriptorSetLayout must have pCreateInfo->stype of VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO.");\n',
' pPacket->header = NULL;\n',
'}']},
'BeginCommandBuffer' : {'param': 'pBeginInfo', 'txt': [
'VkCommandBufferBeginInfo* pInfo = (VkCommandBufferBeginInfo*) pPacket->pBeginInfo;\n',
'pInfo->pInheritanceInfo = (VkCommandBufferInheritanceInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pBeginInfo->pInheritanceInfo);\n']},
'AllocateMemory' : {'param': 'pAllocateInfo', 'txt': ['if (pPacket->pAllocateInfo->sType == VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO) {\n',
' VkMemoryAllocateInfo** ppNext = (VkMemoryAllocateInfo**) &(pPacket->pAllocateInfo->pNext);\n',
' *ppNext = (VkMemoryAllocateInfo*) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pAllocateInfo->pNext);\n',
'} else {\n',
' // This is unexpected.\n',
' vktrace_LogError("AllocateMemory must have AllocInfo stype of VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO.");\n',
' pPacket->header = NULL;\n',
'}']},
'AllocateDescriptorSets' : {'param': 'pAllocateInfo', 'txt':
['VkDescriptorSetLayout **ppDescSetLayout = (VkDescriptorSetLayout **) &pPacket->pAllocateInfo->pSetLayouts;\n'
' *ppDescSetLayout = (VkDescriptorSetLayout *) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pAllocateInfo->pSetLayouts));']},
'UpdateDescriptorSets' : {'param': 'pDescriptorWrites', 'txt':
[ 'uint32_t i;\n',
'for (i = 0; i < pPacket->descriptorWriteCount; i++) {\n',
' switch (pPacket->pDescriptorWrites[i].descriptorType) {',
' case VK_DESCRIPTOR_TYPE_SAMPLER:',
' case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:',
' case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:',
' case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:',
' case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:',
' {',
' VkDescriptorImageInfo** ppImageInfo = (VkDescriptorImageInfo**)&pPacket->pDescriptorWrites[i].pImageInfo;\n',
' *ppImageInfo = (VkDescriptorImageInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pImageInfo);\n',
' }',
' break;',
' case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:',
' case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:',
' {',
' VkBufferView** ppTexelBufferView = (VkBufferView**)&pPacket->pDescriptorWrites[i].pTexelBufferView;\n',
' *ppTexelBufferView = (VkBufferView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pTexelBufferView);\n',
' }',
' break;',
' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:',
' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:',
' case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:',
' case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:',
' {',
' VkDescriptorBufferInfo** ppBufferInfo = (VkDescriptorBufferInfo**)&pPacket->pDescriptorWrites[i].pBufferInfo;\n',
' *ppBufferInfo = (VkDescriptorBufferInfo*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pDescriptorWrites[i].pBufferInfo);\n',
' }',
' break;',
' default:',
' break;',
' }',
'}'
]},
'QueueSubmit' : {'param': 'pSubmits', 'txt':
[ 'uint32_t i;\n',
'for (i = 0; i < pPacket->submitCount; i++) {\n',
' VkCommandBuffer** ppCBs = (VkCommandBuffer**)&pPacket->pSubmits[i].pCommandBuffers;\n',
' *ppCBs = (VkCommandBuffer*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pCommandBuffers);\n',
' VkSemaphore** ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pWaitSemaphores;\n',
' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pWaitSemaphores);\n',
' ppSems = (VkSemaphore**)&pPacket->pSubmits[i].pSignalSemaphores;\n',
' *ppSems = (VkSemaphore*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pSignalSemaphores);\n',
' VkPipelineStageFlags** ppStageMask = (VkPipelineStageFlags**)&pPacket->pSubmits[i].pWaitDstStageMask;\n',
' *ppStageMask = (VkPipelineStageFlags*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pSubmits[i].pWaitDstStageMask);\n',
'}'
]},
'CreateGraphicsPipelines' : {'param': 'pCreateInfos', 'txt': create_gfx_pipe},
'CreateComputePipeline' : {'param': 'pCreateInfo', 'txt': ['interpret_VkPipelineShaderStageCreateInfo(pHeader, (VkPipelineShaderStageCreateInfo*)(&pPacket->pCreateInfo->cs));']},
'CreateFramebuffer' : {'param': 'pCreateInfo', 'txt': ['VkImageView** ppAV = (VkImageView**)&(pPacket->pCreateInfo->pAttachments);\n',
'*ppAV = (VkImageView*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pAttachments));']},
'CmdBeginRenderPass' : {'param': 'pRenderPassBegin', 'txt': ['VkClearValue** ppCV = (VkClearValue**)&(pPacket->pRenderPassBegin->pClearValues);\n',
'*ppCV = (VkClearValue*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pRenderPassBegin->pClearValues));']},
'CreateShaderModule' : {'param': 'pCreateInfo', 'txt': ['void** ppCode = (void**)&(pPacket->pCreateInfo->pCode);\n',
'*ppCode = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pCode);']},
'CreateImage' : {'param': 'pCreateInfo', 'txt': ['uint32_t** ppQueueFamilyIndices = (uint32_t**)&(pPacket->pCreateInfo->pQueueFamilyIndices);\n',
'*ppQueueFamilyIndices = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pQueueFamilyIndices);']},
'CreateBuffer' : {'param': 'pCreateInfo', 'txt': ['uint32_t** ppQueueFamilyIndices = (uint32_t**)&(pPacket->pCreateInfo->pQueueFamilyIndices);\n',
'*ppQueueFamilyIndices = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->pCreateInfo->pQueueFamilyIndices);']},
'FlushMappedMemoryRanges' : {'param': 'ppData', 'txt': ['uint32_t i = 0;\n',
'for (i = 0; i < pPacket->memoryRangeCount; i++)\n',
'{\n',
' pPacket->ppData[i] = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppData[i]);\n',
'}']},
'InvalidateMappedMemoryRanges' : {'param': 'ppData', 'txt': ['uint32_t i = 0;\n',
'for (i = 0; i < pPacket->memoryRangeCount; i++)\n',
'{\n',
' pPacket->ppData[i] = (void*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->ppData[i]);\n',
'}']},
'QueuePresentKHR' : {'param': 'pPresentInfo', 'txt': ['VkSwapchainKHR **ppSC = (VkSwapchainKHR **)& pPacket->pPresentInfo->pSwapchains;\n',
'*ppSC = (VkSwapchainKHR*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->pSwapchains));\n',
'VkSemaphore **ppS = (VkSemaphore **) &pPacket->pPresentInfo->pWaitSemaphores;\n',
'*ppS = (VkSemaphore *) vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->pWaitSemaphores));\n',
'uint32_t **ppII = (uint32_t **) &pPacket->pPresentInfo->pImageIndices;\n',
'*ppII = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->pImageIndices));\n',
'if (pPacket->pPresentInfo->pResults != NULL) {\n',
' VkResult **ppR = (VkResult **) &pPacket->pPresentInfo->pResults;\n',
' *ppR = (VkResult*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pPresentInfo->pResults));\n',
'}']},
'CreateSwapchainKHR' : {'param': 'pCreateInfo', 'txt': ['uint32_t **ppQFI = (uint32_t**)&pPacket->pCreateInfo->pQueueFamilyIndices;\n',
'(*ppQFI) = (uint32_t*)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)(pPacket->pCreateInfo->pQueueFamilyIndices));']},
}
if_body = []
if_body.append('typedef struct packet_vkApiVersion {')
if_body.append(' vktrace_trace_packet_header* header;')
if_body.append(' uint32_t version;')
if_body.append('} packet_vkApiVersion;\n')
if_body.append('static packet_vkApiVersion* interpret_body_as_vkApiVersion(vktrace_trace_packet_header* pHeader)')
if_body.append('{')
if_body.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)pHeader->pBody;')
if_body.append(' pPacket->header = pHeader;')
if_body.append(' return pPacket;')
if_body.append('}\n')
for proto in self.protos:
if proto.name not in proto_exclusions:
if 'UnmapMemory' == proto.name:
proto.params.append(vulkan.Param("void*", "pData"))
elif 'FlushMappedMemoryRanges' == proto.name:
proto.params.append(vulkan.Param("void**", "ppData"))
elif 'InvalidateMappedMemoryRanges' == proto.name:
proto.params.append(vulkan.Param("void**", "ppData"))
if_body.append('%s' % self.lineinfo.get())
if_body.append('typedef struct packet_vk%s {' % proto.name)
if_body.append(' vktrace_trace_packet_header* header;')
for p in proto.params:
if_body.append(' %s;' % p.c())
if 'void' != proto.ret:
if_body.append(' %s result;' % proto.ret)
if_body.append('} packet_vk%s;\n' % proto.name)
if_body.append('static packet_vk%s* interpret_body_as_vk%s(vktrace_trace_packet_header* pHeader)' % (proto.name, proto.name))
if_body.append('{')
if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
if_body.append(' pPacket->header = pHeader;')
for p in proto.params:
if '*' in p.ty:
if 'DeviceCreateInfo' in p.ty:
if_body.append(' pPacket->%s = interpret_VkDeviceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
elif 'InstanceCreateInfo' in p.ty:
if_body.append(' pPacket->%s = interpret_VkInstanceCreateInfo(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.name))
else:
if_body.append(' pPacket->%s = (%s)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.ty, p.name))
# TODO : Generalize this custom code to kill dict data struct above.
# Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
if_body.append(' {')
if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
if_body.append(' }')
if_body.append(' return pPacket;')
if_body.append('}\n')
return "\n".join(if_body)
def _generate_interp_funcs_ext(self, extensionName):
if_body = []
custom_case_dict = { }
for ext in vulkan.extensions_all:
if ext.name.lower() == extensionName.lower():
if ext.ifdef:
if_body.append('#ifdef %s' % ext.ifdef)
for proto in ext.protos:
if_body.append('typedef struct packet_vk%s {' % proto.name)
if_body.append(' vktrace_trace_packet_header* pHeader;')
for p in proto.params:
if_body.append(' %s;' % p.c())
if 'void' != proto.ret:
if_body.append(' %s result;' % proto.ret)
if_body.append('} packet_vk%s;\n' % proto.name)
if_body.append('static packet_vk%s* interpret_body_as_vk%s(vktrace_trace_packet_header* pHeader)' % (proto.name, proto.name))
if_body.append('{')
if_body.append(' packet_vk%s* pPacket = (packet_vk%s*)pHeader->pBody;' % (proto.name, proto.name))
if_body.append(' pPacket->pHeader = pHeader;')
for p in proto.params:
if '*' in p.ty:
if_body.append(' pPacket->%s = (%s)vktrace_trace_packet_interpret_buffer_pointer(pHeader, (intptr_t)pPacket->%s);' % (p.name, p.ty, p.name))
# TODO : Generalize this custom code to kill dict data struct above.
# Really the point of this block is to catch params w/ embedded ptrs to structs and chains of structs
if proto.name in custom_case_dict and p.name == custom_case_dict[proto.name]['param']:
if_body.append(' if (pPacket->%s != NULL)' % custom_case_dict[proto.name]['param'])
if_body.append(' {')
if_body.append(' %s' % " ".join(custom_case_dict[proto.name]['txt']))
if_body.append(' }')
if_body.append(' return pPacket;')
if_body.append('}\n')
if ext.ifdef:
if_body.append('#endif /* %s */' % ext.ifdef)
return "\n".join(if_body)
def _generate_replay_func_ptrs(self):
xf_body = []
xf_body.append('struct vkFuncs {')
xf_body.append(' void init_funcs(void * libHandle);')
xf_body.append(' void *m_libHandle;\n')
for ext in vulkan.extensions_all:
if ext.ifdef:
xf_body.append('#ifdef %s' % ext.ifdef)
for proto in ext.protos:
if proto.name in proto_exclusions:
continue
xf_body.append(' typedef %s( VKAPI_PTR * type_vk%s)(' % (proto.ret, proto.name))
for p in proto.params:
xf_body.append(' %s,' % p.c())
xf_body[-1] = xf_body[-1].replace(',', ');')
xf_body.append(' type_vk%s real_vk%s;' % (proto.name, proto.name))
if ext.ifdef:
xf_body.append('#endif /* %s */' % ext.ifdef)
xf_body.append('};')
return "\n".join(xf_body)
def _map_decl(self, type1, type2, name):
return ' std::map<%s, %s> %s;' % (type1, type2, name)
def _add_to_map_decl(self, type1, type2, name):
txt = ' void add_to_%s_map(%s pTraceVal, %s pReplayVal)\n {\n' % (name[2:], type1, type2)
#TODO138 : These checks need to vary between disp & non-disp objects
#txt += ' assert(pTraceVal != 0);\n'
#txt += ' assert(pReplayVal != 0);\n'
txt += ' %s[pTraceVal] = pReplayVal;\n }\n' % name
return txt
def _rm_from_map_decl(self, ty, name):
txt = ' void rm_from_%s_map(const %s& key)\n {\n' % (name[2:], ty)
txt += ' %s.erase(key);\n }\n' % name
return txt
def _remap_decl(self, ty, name):
txt = ' %s remap_%s(const %s& value)\n {\n' % (ty, name[2:], ty)
txt += ' if (value == 0) { return 0; }\n'
txt += ' std::map<%s, %s>::const_iterator q = %s.find(value);\n' % (ty, ty, name)
txt += ' if (q == %s.end()) { vktrace_LogError("Failed to remap %s."); return VK_NULL_HANDLE; }\n' % (name, ty)
txt += ' return q->second;\n }\n'
return txt
def _generate_replay_objMemory_funcs(self):
rof_body = []
# Custom code for memory mapping functions for app writes into mapped memory
rof_body.append('// memory mapping functions for app writes into mapped memory')
rof_body.append(' bool isPendingAlloc()')
rof_body.append(' {')
rof_body.append(' return m_pendingAlloc;')
rof_body.append(' }')
rof_body.append('')
rof_body.append(' void setAllocInfo(const VkMemoryAllocateInfo *info, const bool pending)')
rof_body.append(' {')
rof_body.append(' m_pendingAlloc = pending;')
rof_body.append(' m_allocInfo = *info;')
rof_body.append(' }')
rof_body.append('')
rof_body.append(' void setMemoryDataAddr(void *pBuf)')
rof_body.append(' {')
rof_body.append(' if (m_mapRange.empty())')
rof_body.append(' {')
rof_body.append(' vktrace_LogError("gpuMemory::setMemoryDataAddr() m_mapRange is empty.");')
rof_body.append(' return;')
rof_body.append(' }')
rof_body.append(' MapRange mr = m_mapRange.back();')
rof_body.append(' if (mr.pData != NULL)')
rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() data already mapped overwrite old mapping.");')
rof_body.append(' else if (pBuf == NULL)')
rof_body.append(' vktrace_LogWarning("gpuMemory::setMemoryDataAddr() adding NULL pointer.");')
rof_body.append(' mr.pData = (uint8_t *) pBuf;')
rof_body.append(' }')
rof_body.append('')
# add for page guard optimization
rof_body.append(' void copyMappingDataPageGuard(const void* pSrcData)')
rof_body.append(' {')
rof_body.append(' if (m_mapRange.empty())')
rof_body.append(' {')
rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() m_mapRange is empty.");')
rof_body.append(' return;')
rof_body.append(' }')
rof_body.append(' MapRange mr = m_mapRange.back();')
rof_body.append(' if (!pSrcData || !mr.pData)')
rof_body.append(' {')
rof_body.append(' if (!pSrcData)')
rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null src pointer.");')
rof_body.append(' else')
rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null dest pointer totalSize=%u.", m_allocInfo.allocationSize);')
rof_body.append(' m_mapRange.pop_back();')
rof_body.append(' return;')
rof_body.append(' }')
rof_body.append('')
rof_body.append(' PageGuardChangedBlockInfo *pChangedInfoArray = (PageGuardChangedBlockInfo *)pSrcData;')
rof_body.append(' if (pChangedInfoArray[0].length)')
rof_body.append(' {')
rof_body.append(' PBYTE pChangedData = (PBYTE)(pSrcData)+sizeof(PageGuardChangedBlockInfo)*(pChangedInfoArray[0].offset + 1);')
rof_body.append(' DWORD CurrentOffset = 0;')
rof_body.append(' for (DWORD i = 0; i < pChangedInfoArray[0].offset; i++)')
rof_body.append(' {')
rof_body.append(' if ((size_t)pChangedInfoArray[i + 1].length)')
rof_body.append(' {')
rof_body.append(' memcpy(mr.pData + (size_t)pChangedInfoArray[i + 1].offset, pChangedData + CurrentOffset, (size_t)pChangedInfoArray[i + 1].length);')
rof_body.append(' }')
rof_body.append(' CurrentOffset += pChangedInfoArray[i + 1].length;')
rof_body.append(' }')
rof_body.append(' }')
rof_body.append(' }')
rof_body.append('')
# add for page guard optimization end
rof_body.append(' void setMemoryMapRange(void *pBuf, const size_t size, const size_t offset, const bool pending)')
rof_body.append(' {')
rof_body.append(' MapRange mr;')
rof_body.append(' mr.pData = (uint8_t *) pBuf;')
rof_body.append(' if (size == 0)')
rof_body.append(' mr.size = (size_t)m_allocInfo.allocationSize - offset;')
rof_body.append(' else')
rof_body.append(' mr.size = size;')
rof_body.append(' mr.offset = offset;')
rof_body.append(' mr.pending = pending;')
rof_body.append(' m_mapRange.push_back(mr);')
rof_body.append(' assert((size_t)m_allocInfo.allocationSize >= (size + offset));')
rof_body.append(' }')
rof_body.append('')
rof_body.append(' void copyMappingData(const void* pSrcData, bool entire_map, size_t size, size_t offset)')
rof_body.append(' {')
rof_body.append(' if (m_mapRange.empty())')
rof_body.append(' {')
rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() m_mapRange is empty.");')
rof_body.append(' return;')
rof_body.append(' }')
rof_body.append(' MapRange mr = m_mapRange.back();')
rof_body.append(' if (!pSrcData || !mr.pData)')
rof_body.append(' {')
rof_body.append(' if (!pSrcData)')
rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null src pointer.");')
rof_body.append(' else')
rof_body.append(' vktrace_LogError("gpuMemory::copyMappingData() null dest pointer totalSize=%u.", m_allocInfo.allocationSize);')
rof_body.append(' m_mapRange.pop_back();')
rof_body.append(' return;')
rof_body.append(' }')
rof_body.append(' if (entire_map)')
rof_body.append(' {')
rof_body.append(' size = mr.size;')
rof_body.append(' offset = 0; // pointer to mapped buffer is from offset 0')
rof_body.append(' }')
rof_body.append(' else')
rof_body.append(' {')
rof_body.append(' assert(offset >= mr.offset);')
rof_body.append(' assert(size <= mr.size && (size + offset) <= (size_t)m_allocInfo.allocationSize);')
rof_body.append(' }')
rof_body.append(' memcpy(mr.pData + offset, pSrcData, size);')
rof_body.append(' if (!mr.pending && entire_map)')
rof_body.append(' m_mapRange.pop_back();')
rof_body.append(' }')
rof_body.append('')
rof_body.append(' size_t getMemoryMapSize()')
rof_body.append(' {')
rof_body.append(' return (!m_mapRange.empty()) ? m_mapRange.back().size : 0;')
rof_body.append(' }\n')
return "\n".join(rof_body)
def _generate_replay_objmapper_class(self):
# Create dict mapping member var names to VK type (i.e. 'm_imageViews' : 'VkImage_VIEW')
obj_map_dict = {}
for obj in vulkan.object_type_list:
if (obj.startswith('Vk')):
mem_var = obj.replace('Vk', '').lower()
mem_var_list = mem_var.split('_')
mem_var = 'm_%s%ss' % (mem_var_list[0], "".join([m.title() for m in mem_var_list[1:]]))
obj_map_dict[mem_var] = obj
rc_body = []
rc_body.append('#define VKTRACE_VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN (VkObjectType)-1')
rc_body.append('')
rc_body.append('typedef struct _VKAllocInfo {')
rc_body.append(' VkDeviceSize size;')
rc_body.append(' uint8_t *pData;')
rc_body.append(' bool rangeUpdated;')
rc_body.append('} VKAllocInfo;')
rc_body.append('')
rc_body.append('class objMemory {')
rc_body.append('public:')
rc_body.append(' objMemory() : m_numAllocations(0), m_pMemReqs(NULL) {}')
rc_body.append(' ~objMemory() { free(m_pMemReqs);}')
rc_body.append(' void setCount(const uint32_t num)')
rc_body.append(' {')
rc_body.append(' m_numAllocations = num;')
rc_body.append(' }\n')
rc_body.append(' void setReqs(const VkMemoryRequirements *pReqs, const uint32_t num)')
rc_body.append(' {')
rc_body.append(' if (m_numAllocations != num && m_numAllocations != 0)')
rc_body.append(' vktrace_LogError("objMemory::setReqs, internal mismatch on number of allocations.");')
rc_body.append(' if (m_pMemReqs == NULL && pReqs != NULL)')
rc_body.append(' {')
rc_body.append(' m_pMemReqs = (VkMemoryRequirements *) vktrace_malloc(num * sizeof(VkMemoryRequirements));')
rc_body.append(' if (m_pMemReqs == NULL)')
rc_body.append(' {')
rc_body.append(' vktrace_LogError("objMemory::setReqs out of memory.");')
rc_body.append(' return;')
rc_body.append(' }')
rc_body.append(' memcpy(m_pMemReqs, pReqs, num * sizeof(VkMemoryRequirements));')
rc_body.append(' }')
rc_body.append(' }\n')
rc_body.append('private:')
rc_body.append(' uint32_t m_numAllocations;')
rc_body.append(' VkMemoryRequirements *m_pMemReqs;')
rc_body.append('};')
rc_body.append('')
rc_body.append('class gpuMemory {')
rc_body.append('public:')
rc_body.append(' gpuMemory() : m_pendingAlloc(false) {m_allocInfo.allocationSize = 0;}')
rc_body.append(' ~gpuMemory() {}')
rc_body.append(self._generate_replay_objMemory_funcs())
rc_body.append('private:')
rc_body.append(' bool m_pendingAlloc;')
rc_body.append(' struct MapRange {')
rc_body.append(' bool pending;')
rc_body.append(' size_t size;')
rc_body.append(' size_t offset;')
rc_body.append(' uint8_t* pData;')
rc_body.append(' };')
rc_body.append(' std::vector<MapRange> m_mapRange;')
rc_body.append(' VkMemoryAllocateInfo m_allocInfo;')
rc_body.append('};')
rc_body.append('')
rc_body.append('typedef struct _imageObj {')
rc_body.append(' objMemory imageMem;')
rc_body.append(' VkImage replayImage;')
rc_body.append(' } imageObj;')
rc_body.append('')
rc_body.append('typedef struct _bufferObj {')
rc_body.append(' objMemory bufferMem;')
rc_body.append(' VkBuffer replayBuffer;')
rc_body.append(' } bufferObj;')
rc_body.append('')
rc_body.append('typedef struct _gpuMemObj {')
rc_body.append(' gpuMemory *pGpuMem;')
rc_body.append(' VkDeviceMemory replayGpuMem;')
rc_body.append(' } gpuMemObj;')
rc_body.append('')
rc_body.append('')
rc_body.append('class vkReplayObjMapper {')
rc_body.append('public:')
rc_body.append(' vkReplayObjMapper() {}')
rc_body.append(' ~vkReplayObjMapper() {}')
rc_body.append('')
rc_body.append(' bool m_adjustForGPU; // true if replay adjusts behavior based on GPU')
# Code for memory objects for handling replay GPU != trace GPU object memory requirements
rc_body.append('void init_objMemCount(const uint64_t handle, const VkDebugReportObjectTypeEXT objectType, const uint32_t &num)\n {')
rc_body.append(' switch (objectType) {')
rc_body.append(' case VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT:')
rc_body.append(' {')
rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
rc_body.append(' if (it != m_buffers.end()) {')
rc_body.append(' objMemory obj = it->second.bufferMem;')
rc_body.append(' obj.setCount(num);')
rc_body.append(' return;')
rc_body.append(' }')
rc_body.append(' break;')
rc_body.append(' }')
rc_body.append(' case VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT:')
rc_body.append(' {')
rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
rc_body.append(' if (it != m_images.end()) {')
rc_body.append(' objMemory obj = it->second.imageMem;')
rc_body.append(' obj.setCount(num);')
rc_body.append(' return;')
rc_body.append(' }')
rc_body.append(' break;')
rc_body.append(' }')
rc_body.append(' default:')
rc_body.append(' break;')
rc_body.append(' }')
rc_body.append(' return;')
rc_body.append('}\n')
rc_body.append('void init_objMemReqs(const uint64_t handle, const VkDebugReportObjectTypeEXT objectType, const VkMemoryRequirements *pMemReqs, const unsigned int num)\n {')
rc_body.append(' switch (objectType) {')
rc_body.append(' case VK_DEBUG_REPORT_OBJECT_TYPE_BUFFER_EXT:')
rc_body.append(' {')
rc_body.append(' std::map<VkBuffer, bufferObj>::iterator it = m_buffers.find((VkBuffer) handle);')
rc_body.append(' if (it != m_buffers.end()) {')
rc_body.append(' objMemory obj = it->second.bufferMem;')
rc_body.append(' obj.setReqs(pMemReqs, num);')
rc_body.append(' return;')
rc_body.append(' }')
rc_body.append(' break;')
rc_body.append(' }')
rc_body.append(' case VK_DEBUG_REPORT_OBJECT_TYPE_IMAGE_EXT:')
rc_body.append(' {')
rc_body.append(' std::map<VkImage, imageObj>::iterator it = m_images.find((VkImage) handle);')
rc_body.append(' if (it != m_images.end()) {')
rc_body.append(' objMemory obj = it->second.imageMem;')
rc_body.append(' obj.setReqs(pMemReqs, num);')
rc_body.append(' return;')
rc_body.append(' }')
rc_body.append(' break;')
rc_body.append(' }')
rc_body.append(' default:')
rc_body.append(' break;')
rc_body.append(' }')
rc_body.append(' return;')
rc_body.append(' }')
rc_body.append('')
rc_body.append(' void clear_all_map_handles()\n {')
for var in sorted(obj_map_dict):
rc_body.append(' %s.clear();' % var)
for var in additional_remap_dict:
rc_body.append(' m_%s.clear();' %var)
rc_body.append(' }\n')
disp_obj_types = [obj for obj in vulkan.object_dispatch_list]
for var in sorted(obj_map_dict):
if obj_map_dict[var] == 'VkImage':
rc_body.append(self._map_decl('VkImage', 'imageObj', var))
rc_body.append(self._add_to_map_decl('VkImage', 'imageObj', var))
rc_body.append(self._rm_from_map_decl('VkImage', var))
rc_body.append(' VkImage remap_images(const VkImage& value)')
rc_body.append(' {')
rc_body.append(' if (value == 0) { return 0; }')
rc_body.append('')
rc_body.append(' std::map<VkImage, imageObj>::const_iterator q = m_images.find(value);')
rc_body.append(' if (q == m_images.end()) { vktrace_LogError("Failed to remap VkImage."); return VK_NULL_HANDLE; }\n')
rc_body.append(' return q->second.replayImage;')
rc_body.append(' }\n')
elif obj_map_dict[var] == 'VkBuffer':
rc_body.append(self._map_decl('VkBuffer', 'bufferObj', var))
rc_body.append(self._add_to_map_decl('VkBuffer', 'bufferObj', var))
rc_body.append(self._rm_from_map_decl('VkBuffer', var))
rc_body.append(' VkBuffer remap_buffers(const VkBuffer& value)')
rc_body.append(' {')
rc_body.append(' if (value == 0) { return 0; }')
rc_body.append('')
rc_body.append(' std::map<VkBuffer, bufferObj>::const_iterator q = m_buffers.find(value);')
rc_body.append(' if (q == m_buffers.end()) { vktrace_LogError("Failed to remap VkBuffer."); return VK_NULL_HANDLE; }\n')
rc_body.append(' return q->second.replayBuffer;')
rc_body.append(' }\n')
elif obj_map_dict[var] == 'VkDeviceMemory':
rc_body.append(self._map_decl('VkDeviceMemory', 'gpuMemObj', var))
rc_body.append(self._add_to_map_decl('VkDeviceMemory', 'gpuMemObj', var))
rc_body.append(self._rm_from_map_decl('VkDeviceMemory', var))
rc_body.append(' VkDeviceMemory remap_devicememorys(const VkDeviceMemory& value)')
rc_body.append(' {')
rc_body.append(' if (value == 0) { return 0; }')
rc_body.append('')
rc_body.append(' std::map<VkDeviceMemory, gpuMemObj>::const_iterator q = m_devicememorys.find(value);')
rc_body.append(' if (q == m_devicememorys.end()) { vktrace_LogError("Failed to remap VkDeviceMemory."); return VK_NULL_HANDLE; }')
rc_body.append(' return q->second.replayGpuMem;')
rc_body.append(' }\n')
else:
rc_body.append(self._map_decl(obj_map_dict[var], obj_map_dict[var], var))
rc_body.append(self._add_to_map_decl(obj_map_dict[var], obj_map_dict[var], var))
rc_body.append(self._rm_from_map_decl(obj_map_dict[var], var))
rc_body.append(self._remap_decl(obj_map_dict[var], var))
for var in additional_remap_dict:
rc_body.append(' std::map<%s, %s> m_%s;' % (additional_remap_dict[var], additional_remap_dict[var], var))
rc_body.append(' void add_to_%s_map(%s traceVal, %s replayVal)' % (var, additional_remap_dict[var], additional_remap_dict[var]))
rc_body.append(' {')
rc_body.append(' m_%s[traceVal] = replayVal;' % var)
rc_body.append(' }')
rc_body.append('')
rc_body.append(' void rm_from_%s_map(const %s& key)' % (var, additional_remap_dict[var]))
rc_body.append(' {')
rc_body.append(' m_%s.erase(key);' % var)
rc_body.append(' }')
rc_body.append('')
rc_body.append(' %s remap_%s(const %s& value)' % (additional_remap_dict[var], var, additional_remap_dict[var]))
rc_body.append(' {')
rc_body.append(' std::map<%s, %s>::const_iterator q = m_%s.find(value);' % (additional_remap_dict[var], additional_remap_dict[var], var))
rc_body.append(' if (q == m_%s.end()) { vktrace_LogError("Failed to remap %s."); return UINT32_MAX; }' % (var, var))
rc_body.append(' return q->second;')
rc_body.append(' }')
# VkDynamicStateObject code
# TODO138 : Each dynamic state object is now unique so need to make sure their re-mapping is being handled correctly
# state_obj_remap_types = vulkan.object_dynamic_state_list
# state_obj_bindings = vulkan.object_dynamic_state_bind_point_list
# rc_body.append(' VkDynamicStateObject remap(const VkDynamicStateObject& state, const VkStateBindPoint& bindPoint)\n {')
# rc_body.append(' VkDynamicStateObject obj;')
# index = 0
# while index < len(state_obj_remap_types):
# obj = state_obj_remap_types[index]
# type = state_obj_bindings[index]
# rc_body.append(' if (bindPoint == %s) {' % type)
# rc_body.append(' if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
# rc_body.append(' return obj;')
# rc_body.append(' }')
# index += 1
# for obj in state_obj_remap_types:
# rc_body.append('// if ((obj = remap(static_cast <%s> (state))) != VK_NULL_HANDLE)' % obj.type)
# rc_body.append('// return obj;')
# rc_body.append(' vktrace_LogWarning("Failed to remap VkDynamicStateObject.");')
# rc_body.append(' return VK_NULL_HANDLE;\n }')
# rc_body.append(' void rm_from_map(const VkDynamicStateObject& state)\n {')
# for obj in state_obj_remap_types:
# rc_body.append(' rm_from_map(static_cast <%s> (state));' % obj.type)
# rc_body.append(' }')
# rc_body.append('')
rc_body.append('};')
return "\n".join(rc_body)
def _generate_replay_init_funcs(self):
rif_body = []
rif_body.append('void vkFuncs::init_funcs(void * handle)\n{\n m_libHandle = handle;')
for ext in vulkan.extensions_all:
if ext.ifdef:
rif_body.append('#ifdef %s' % ext.ifdef)
for proto in ext.protos:
if proto.name in proto_exclusions:
continue
if 'DebugReport' not in proto.name:
rif_body.append(' real_vk%s = (type_vk%s)(vktrace_platform_get_library_entrypoint(handle, "vk%s"));' % (proto.name, proto.name, proto.name))
else: # These func ptrs get assigned at GetProcAddr time
rif_body.append(' real_vk%s = (type_vk%s)NULL;' % (proto.name, proto.name))
if ext.ifdef:
rif_body.append('#endif /* %s */' % ext.ifdef)
rif_body.append('}')
return "\n".join(rif_body)
def _remap_packet_param(self, funcName, paramType, paramName, lastName):
remap_list = vulkan.object_type_list
param_exclude_list = ['pDescriptorSets', 'pFences']
cleanParamType = paramType.strip('*').replace('const ', '')
VulkNonDispObjects = [o for o in vulkan.object_non_dispatch_list]
for obj in remap_list:
if obj == cleanParamType and paramName not in param_exclude_list:
objectTypeRemapParam = ''
if 'VkDynamicStateObject' == cleanParamType:
objectTypeRemapParam = ', pPacket->stateBindPoint'
elif 'object' == paramName:
if 'DbgSetObjectTag' == funcName:
objectTypeRemapParam = ', VKTRACE_VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN'
else:
objectTypeRemapParam = ', pPacket->objType'
elif 'srcObject' == paramName and 'Callback' in funcName:
objectTypeRemapParam = ', pPacket->objType'
pArray = ''
if '*' in paramType:
if 'const' not in paramType:
result = ' %s remapped%s = m_objMapper.remap_%ss(*pPacket->%s%s);\n' % (cleanParamType, paramName, paramName.lower(), paramName, objectTypeRemapParam)
result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
result += ' {\n'
result += ' vktrace_LogError("Error detected in %s() due to invalid remapped %s.");\n' % (funcName, cleanParamType)
result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
result += ' }\n'
return result
else:
if lastName == '':
return ' // pPacket->%s should have been remapped with special case code' % (paramName)
pArray = '[pPacket->%s]' % lastName
result = ' %s *remapped%s = new %s%s;\n' % (cleanParamType, paramName, cleanParamType, pArray)
result += '%s\n' % self.lineinfo.get()
result += ' for (uint32_t i = 0; i < pPacket->%s; i++) {\n' % lastName
result += ' remapped%s[i] = m_objMapper.remap_%ss(pPacket->%s[i]%s);\n' % (paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
result += ' if (pPacket->%s[i] != VK_NULL_HANDLE && remapped%s[i] == VK_NULL_HANDLE)\n' % (paramName, paramName)
result += ' {\n'
result += ' vktrace_LogError("Error detected in %s() due to invalid remapped %s.");\n' % (funcName, cleanParamType)
result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
result += ' }\n'
result += ' }\n'
return result
result = ' %s remapped%s = m_objMapper.remap_%ss(pPacket->%s%s);\n' % (paramType, paramName, cleanParamType.lower()[2:], paramName, objectTypeRemapParam)
result += '%s\n' % self.lineinfo.get()
result += ' if (pPacket->%s != VK_NULL_HANDLE && remapped%s == VK_NULL_HANDLE)\n' % (paramName, paramName)
result += ' {\n'
result += ' vktrace_LogError("Error detected in %s() due to invalid remapped %s.");\n' % (funcName, cleanParamType)
result += ' return vktrace_replay::VKTRACE_REPLAY_ERROR;\n'
result += ' }\n'
return result
return ' // No need to remap %s' % (paramName)
def _get_packet_param(self, funcName, paramType, paramName):
# list of types that require remapping
remap_list = vulkan.object_type_list
param_exclude_list = ['pDescriptorSets', 'pFences']
cleanParamType = paramType.strip('*').replace('const ', '')
for obj in remap_list:
if obj == cleanParamType and paramName not in param_exclude_list:
objectTypeRemapParam = ''
if 'object' == paramName:
if 'DbgSetObjectTag' == funcName:
objectTypeRemapParam = ', VKTRACE_VK_DEBUG_REPORT_OBJECT_TYPE_UNKNOWN'
else:
objectTypeRemapParam = ', pPacket->objType'
return 'remapped%s' % (paramName)
return 'pPacket->%s' % (paramName)
def _gen_replay_create_instance(self):
cb_body = []
cb_body.append(' replayResult = manually_replay_vkCreateInstance(pPacket);')
cb_body.append(' CHECK_RETURN_VALUE(vkCreateInstance);')
cb_body.append(' if (replayResult == VK_SUCCESS) {')
cb_body.append(' VkInstance remappedInstance = m_objMapper.remap_instances(*pPacket->pInstance);')
cb_body.append(' if (remappedInstance == VK_NULL_HANDLE) {')
cb_body.append(' vktrace_LogError("Error detected in vkCreateInstance() due to invalid remapped VkInstance.");')
cb_body.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_ERROR;')
cb_body.append(' break;')
cb_body.append(' }')
cb_body.append(' VkFlags reportFlags = VK_DEBUG_REPORT_INFORMATION_BIT_EXT | VK_DEBUG_REPORT_WARNING_BIT_EXT | VK_DEBUG_REPORT_PERFORMANCE_WARNING_BIT_EXT | VK_DEBUG_REPORT_ERROR_BIT_EXT | VK_DEBUG_REPORT_DEBUG_BIT_EXT;')
cb_body.append(' PFN_vkCreateDebugReportCallbackEXT callback = (PFN_vkCreateDebugReportCallbackEXT)vkGetInstanceProcAddr(remappedInstance, "vkCreateDebugReportCallbackEXT");')
cb_body.append(' if (callback != NULL) {')
cb_body.append(' VkDebugReportCallbackCreateInfoEXT dbgCreateInfo;')
cb_body.append(' memset(&dbgCreateInfo, 0, sizeof(dbgCreateInfo));')
cb_body.append(' dbgCreateInfo.sType = VK_STRUCTURE_TYPE_DEBUG_REPORT_CREATE_INFO_EXT;')
cb_body.append(' dbgCreateInfo.flags = reportFlags;')
cb_body.append(' dbgCreateInfo.pfnCallback = g_fpDbgMsgCallback;')
cb_body.append(' dbgCreateInfo.pUserData = NULL;')
cb_body.append(' if (callback(remappedInstance, &dbgCreateInfo, NULL, &m_dbgMsgCallbackObj) != VK_SUCCESS) {')
cb_body.append(' vktrace_LogWarning("Failed to register vulkan callback for replayer error handling.");')
cb_body.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_ERROR;')
cb_body.append(' break;')
cb_body.append(' }')
cb_body.append(' }')
cb_body.append(' }')
return "\n".join(cb_body)
# These are customized because they are the only entry points returning VkBool32
def _gen_replay_GetPhysicalDeviceXcbPresentationSupportKHR (self):
cb_body = []
cb_body.append(' VkBool32 rval = manually_replay_vkGetPhysicalDeviceXcbPresentationSupportKHR(pPacket);')
cb_body.append(' if (rval != pPacket->result)')
cb_body.append(' {')
cb_body.append(' vktrace_LogError("Return value %d from API call (vkGetPhysicalDeviceXcbPresentationSupportKHR) does not match return value from trace file %d.",')
cb_body.append(' rval, pPacket->result);')
cb_body.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_BAD_RETURN;')
cb_body.append(' }')
return "\n".join(cb_body)
def _gen_replay_GetPhysicalDeviceXlibPresentationSupportKHR (self):
cb_body = []
cb_body.append(' VkBool32 rval = manually_replay_vkGetPhysicalDeviceXlibPresentationSupportKHR(pPacket);')
cb_body.append(' if (rval != pPacket->result)')
cb_body.append(' {')
cb_body.append(' vktrace_LogError("Return value %d from API call (vkGetPhysicalDeviceXlibPresentationSupportKHR) does not match return value from trace file %d.",')
cb_body.append(' rval, pPacket->result);')
cb_body.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_BAD_RETURN;')
cb_body.append(' }')
return "\n".join(cb_body)
def _gen_replay_GetPhysicalDeviceWin32PresentationSupportKHR (self):
cb_body = []
cb_body.append(' VkBool32 rval = manually_replay_vkGetPhysicalDeviceWin32PresentationSupportKHR(pPacket);')
cb_body.append(' if (rval != pPacket->result)')
cb_body.append(' {')
cb_body.append(' vktrace_LogError("Return value %d from API call (vkGetPhysicalDeviceWin32PresentationSupportKHR) does not match return value from trace file %d.",')
cb_body.append(' rval, pPacket->result);')
cb_body.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_BAD_RETURN;')
cb_body.append(' }')
return "\n".join(cb_body)
# Generate main replay case statements where actual replay API call is dispatched based on input packet data
def _generate_replay(self):
manually_replay_funcs = ['AllocateMemory',
'BeginCommandBuffer',
'CreateDescriptorSetLayout',
'CreateDevice',
'CreateBuffer',
'CreateImage',
'CreateCommandPool',
'CreateFramebuffer',
'GetPipelineCacheData',
'CreateGraphicsPipelines',
'CreateComputePipelines',
#'CreateInstance',
'CreatePipelineLayout',
'CreateRenderPass',
'CmdBeginRenderPass',
'CmdBindDescriptorSets',
'CmdBindVertexBuffers',
'CmdPipelineBarrier',
'QueuePresentKHR',
'CmdWaitEvents',
#'DestroyObject',
'EnumeratePhysicalDevices',
'FreeMemory',
'FreeDescriptorSets',
'FlushMappedMemoryRanges',
'InvalidateMappedMemoryRanges',
#'GetGlobalExtensionInfo',
#'GetImageSubresourceInfo',
#'GetObjectInfo',
#'GetPhysicalDeviceExtensionInfo',
'GetPhysicalDeviceMemoryProperties',
'GetPhysicalDeviceQueueFamilyProperties',
'GetPhysicalDeviceSurfaceSupportKHR',
'GetPhysicalDeviceSurfaceCapabilitiesKHR',
'GetPhysicalDeviceSurfaceFormatsKHR',
'GetPhysicalDeviceSurfacePresentModesKHR',
'CreateSwapchainKHR',
'GetSwapchainImagesKHR',
'CreateXcbSurfaceKHR',
'CreateXlibSurfaceKHR',
'GetPhysicalDeviceXcbPresentationSupportKHR',
'GetPhysicalDeviceXlibPresentationSupportKHR',
'CreateWin32SurfaceKHR',
'GetPhysicalDeviceWin32PresentationSupportKHR',
'CreateAndroidSurfaceKHR',
#TODO Wayland, Mir, Xlib
#'GetPhysicalDeviceInfo',
'MapMemory',
'QueueSubmit',
'QueueBindSparse',
#'StorePipeline',
'UnmapMemory',
'UpdateDescriptorSets',
'WaitForFences',
'CreateDebugReportCallbackEXT',
'DestroyDebugReportCallbackEXT',
'AllocateCommandBuffers',
]
# validate the manually_replay_funcs list
protoFuncs = [proto.name for proto in self.protos]
wsi_platform_manual_funcs = ['CreateWin32SurfaceKHR', 'CreateXcbSurfaceKHR', 'CreateXlibSurfaceKHR', 'CreateAndroidSurfaceKHR']
for func in manually_replay_funcs:
if (func not in protoFuncs) and (func not in wsi_platform_manual_funcs):
sys.exit("Entry '%s' in manually_replay_funcs list is not in the vulkan function prototypes" % func)
# map protos to custom functions if body is fully custom
custom_body_dict = {'CreateInstance': self._gen_replay_create_instance,
'GetPhysicalDeviceXcbPresentationSupportKHR': self._gen_replay_GetPhysicalDeviceXcbPresentationSupportKHR,
'GetPhysicalDeviceXlibPresentationSupportKHR': self._gen_replay_GetPhysicalDeviceXlibPresentationSupportKHR,
'GetPhysicalDeviceWin32PresentationSupportKHR': self._gen_replay_GetPhysicalDeviceWin32PresentationSupportKHR }
# multi-gpu Open funcs w/ list of local params to create
custom_open_params = {'OpenSharedMemory': (-1,),
'OpenSharedSemaphore': (-1,),
'OpenPeerMemory': (-1,),
'OpenPeerImage': (-1, -2,)}
# Functions that create views are unique from other create functions
create_view_list = ['CreateBufferView', 'CreateImageView', 'CreateComputePipeline']
# Functions to treat as "Create' that don't have 'Create' in the name
special_create_list = ['LoadPipeline', 'LoadPipelineDerivative', 'AllocateMemory', 'GetDeviceQueue', 'PinSystemMemory', 'AllocateDescriptorSets', 'AcquireNextImageKHR']
# A couple funcs use do while loops
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', 'GetQueryPoolResults': 'pPacket->result == VK_SUCCESS && replayResult != pPacket->result'}
rbody = []
rbody.append('%s' % self.lineinfo.get())
rbody.append('vktrace_replay::VKTRACE_REPLAY_RESULT vkReplay::replay(vktrace_trace_packet_header *packet)')
rbody.append('{')
rbody.append(' vktrace_replay::VKTRACE_REPLAY_RESULT returnValue = vktrace_replay::VKTRACE_REPLAY_SUCCESS;')
rbody.append(' VkResult replayResult = VK_ERROR_VALIDATION_FAILED_EXT;')
rbody.append(' switch (packet->packet_id)')
rbody.append(' {')
rbody.append(' case VKTRACE_TPI_VK_vkApiVersion:')
rbody.append(' {')
rbody.append(' packet_vkApiVersion* pPacket = (packet_vkApiVersion*)(packet->pBody);')
rbody.append(' if (VK_VERSION_MAJOR(pPacket->version) != 1 || VK_VERSION_MINOR (pPacket->version) != 0)')
rbody.append(' {')
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_MAKE_VERSION(1, 0, VK_HEADER_VERSION), ((VK_MAKE_VERSION(1, 0, VK_HEADER_VERSION)) & 0xFFC00000) >> 22, ((VK_MAKE_VERSION(1, 0, VK_HEADER_VERSION)) & 0x003FF000) >> 12, ((VK_MAKE_VERSION(1, 0, VK_HEADER_VERSION)) & 0x00000FFF));')
rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
rbody.append(' break;')
rbody.append(' }')
for proto in self.protos:
if proto.name in proto_exclusions:
continue
# TODO : This is an O(N^4) way of finding if this proto is guarded by an ifdef.
# If the concept of an ifdef field is ok, rewrite the outer loop to already have the ext.ifdef value ready:
# for ext in vulkan.extensions_all:
# if ext.ifdef: if_body.append('#ifdef') # wrap all the protos in a single #ifdef block instead of repeating #ifdef for each proto
# for proto in ext.protos:
proto_ext_ifdef = None
for ext in vulkan.extensions_all:
if ext.ifdef:
for ext_proto in ext.protos:
if proto.name == ext_proto.name:
proto_ext_ifdef = ext.ifdef
if proto_ext_ifdef:
rbody.append('#ifdef %s' % proto_ext_ifdef)
ret_value = False
create_view = False
create_func = False
# TODO : How to handle void* return of GetProcAddr?
#TODO make sure vkDestroy object functions really do clean up the object maps
if ('void' not in proto.ret.lower()) and ('size_t' not in proto.ret) and (proto.name not in custom_body_dict):
ret_value = True
if proto.name in create_view_list:
create_view = True
elif 'Create' in proto.name or proto.name in special_create_list:
create_func = True
rbody.append(' case VKTRACE_TPI_VK_vk%s:' % proto.name)
rbody.append(' {')
rbody.append(' packet_vk%s* pPacket = (packet_vk%s*)(packet->pBody);' % (proto.name, proto.name))
if proto.name in manually_replay_funcs:
if ret_value == True:
rbody.append(' replayResult = manually_replay_vk%s(pPacket);' % proto.name)
else:
rbody.append(' manually_replay_vk%s(pPacket);' % proto.name)
elif proto.name in custom_body_dict:
rbody.append(custom_body_dict[proto.name]())
else:
if proto.name in custom_open_params:
for pidx in custom_open_params[proto.name]:
rbody.append(' %s local_%s;' % (proto.params[pidx].ty.replace('const ', '').strip('*'), proto.params[pidx].name))
elif create_view:
rbody.append(' %s createInfo;' % (proto.params[1].ty.strip('*').replace('const ', '')))
rbody.append(' memcpy(&createInfo, pPacket->pCreateInfo, sizeof(%s));' % (proto.params[1].ty.strip('*').replace('const ', '')))
if 'CreateComputePipeline' == proto.name:
rbody.append(' createInfo.cs.shader = m_objMapper.remap_shaders(pPacket->pCreateInfo->cs.shader);')
rbody.append(' if (createInfo.cs.shader == VK_NULL_HANDLE && pPacket->pCreateInfo->cs.shader != VK_NULL_HANDLE)')
rbody.append(' {')
rbody.append(' vktrace_LogError("Error detected in vkCreateComputePipelines() due to invalid remapped VkShader.");')
rbody.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
elif 'CreateBufferView' == proto.name:
rbody.append(' createInfo.buffer = m_objMapper.remap_buffers(pPacket->pCreateInfo->buffer);')
rbody.append(' if (createInfo.buffer == VK_NULL_HANDLE && pPacket->pCreateInfo->buffer != VK_NULL_HANDLE)')
rbody.append(' {')
rbody.append(' vktrace_LogError("Error detected in vkCreateBufferView() due to invalid remapped VkBuffer.");')
rbody.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
else:
rbody.append(' createInfo.image = m_objMapper.remap_images(pPacket->pCreateInfo->image);')
rbody.append(' if (createInfo.image == VK_NULL_HANDLE && pPacket->pCreateInfo->image != VK_NULL_HANDLE)')
rbody.append(' {')
rbody.append(' vktrace_LogError("Error detected in vkCreateImageView() due to invalid remapped VkImage.");')
rbody.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
elif create_func: # Declare local var to store created handle into
if 'AllocateDescriptorSets' == proto.name:
p_ty = proto.params[-1].ty.strip('*').replace('const ', '')
rbody.append(' %s* local_%s = (%s*)malloc(pPacket->pAllocateInfo->descriptorSetCount * sizeof(%s));' % (p_ty, proto.params[-1].name, p_ty, p_ty))
rbody.append(' VkDescriptorSetLayout* local_pSetLayouts = (VkDescriptorSetLayout*)malloc(pPacket->pAllocateInfo->descriptorSetCount * sizeof(VkDescriptorSetLayout));')
rbody.append(' VkDescriptorSetAllocateInfo local_AllocInfo, *local_pAllocateInfo = &local_AllocInfo;')
rbody.append(' VkDescriptorPool local_descPool;')
rbody.append(' local_descPool = m_objMapper.remap_descriptorpools(pPacket->pAllocateInfo->descriptorPool);')
rbody.append(' if (local_descPool == VK_NULL_HANDLE)')
rbody.append(' {')
rbody.append(' vktrace_LogError("Error detected in vkAllocateDescriptorSets() due to invalid remapped VkDescriptorPool.");')
rbody.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->descriptorSetCount; i++)')
rbody.append(' {')
rbody.append(' local_pSetLayouts[i] = m_objMapper.remap_descriptorsetlayouts(pPacket->%s->pSetLayouts[i]);' % (proto.params[-2].name))
rbody.append(' if (local_pSetLayouts[i] == VK_NULL_HANDLE)')
rbody.append(' {')
rbody.append(' vktrace_LogError("Error detected in vkAllocateDescriptorSets() due to invalid remapped VkDescriptorSetLayout.");')
rbody.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
rbody.append(' }')
rbody.append(' memcpy(local_pAllocateInfo, pPacket->pAllocateInfo, sizeof(VkDescriptorSetAllocateInfo));')
rbody.append(' local_pAllocateInfo->pSetLayouts = local_pSetLayouts;')
rbody.append(' local_pAllocateInfo->descriptorPool = local_descPool;')
else:
rbody.append(' %s local_%s;' % (proto.params[-1].ty.strip('*').replace('const ', ''), proto.params[-1].name))
elif proto.name == 'ResetFences':
rbody.append(' VkFence* fences = VKTRACE_NEW_ARRAY(VkFence, pPacket->fenceCount);')
rbody.append(' for (uint32_t i = 0; i < pPacket->fenceCount; i++)')
rbody.append(' {')
rbody.append(' fences[i] = m_objMapper.remap_fences(pPacket->%s[i]);' % (proto.params[-1].name))
rbody.append(' if (fences[i] == VK_NULL_HANDLE)')
rbody.append(' {')
rbody.append(' vktrace_LogError("Error detected in vkResetFences() due to invalid remapped VkFence.");')
rbody.append(' return vktrace_replay::VKTRACE_REPLAY_ERROR;')
rbody.append(' }')
rbody.append(' }')
elif proto.name in do_while_dict:
rbody.append(' do {')
last_name = ''
for p in proto.params:
if create_func or create_view:
if p.name != proto.params[-1].name:
rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
else:
rbody.append(self._remap_packet_param(proto.name, p.ty, p.name, last_name))
last_name = p.name
if proto.name == 'DestroyInstance':
rbody.append(' if (m_vkFuncs.real_vkDestroyDebugReportCallbackEXT != NULL)')
rbody.append(' {')
rbody.append(' m_vkFuncs.real_vkDestroyDebugReportCallbackEXT(remappedinstance, m_dbgMsgCallbackObj, pPacket->pAllocator);')
rbody.append(' }')
# TODO: need a better way to indicate which extensions should be mapped to which Get*ProcAddr
elif proto.name == 'GetInstanceProcAddr':
for iExt in vulkan.extensions_all:
if iExt.ifdef:
rbody.append('#ifdef %s' % iExt.ifdef)
for iProto in iExt.protos:
if iProto.name in proto_exclusions:
continue
if 'DebugReport' in iProto.name:
rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (iProto.name))
rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappedinstance, pPacket->pName);' % (iProto.name, iProto.name, proto.name))
rbody.append(' }')
elif (iProto.params[0].ty == 'VkInstance' or iProto.params[0].ty != 'VkPhysicalDevice') and 'KHR' in iProto.name:
rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (iProto.name))
rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappedinstance, pPacket->pName);' % (iProto.name, iProto.name, proto.name))
rbody.append(' }')
if iExt.ifdef:
rbody.append('#endif /* %s */' % iExt.ifdef)
elif proto.name == 'GetDeviceProcAddr':
for dProto in self.protos:
if dProto.name in proto_exclusions:
continue
if 'KHR' in dProto.name and dProto.params[0].ty != 'VkInstance' and dProto.params[0].ty != 'VkPhysicalDevice':
# if 'KHR' in dProto.name:
rbody.append(' if (strcmp(pPacket->pName, "vk%s") == 0) {' % (dProto.name))
rbody.append(' m_vkFuncs.real_vk%s = (PFN_vk%s)vk%s(remappeddevice, pPacket->pName);' % (dProto.name, dProto.name, proto.name))
rbody.append(' }')
# build the call to the "real_" entrypoint
rr_string = ' '
if ret_value:
if proto.ret != 'VkResult':
ret_value = False
else:
rr_string = ' replayResult = '
rr_string += 'm_vkFuncs.real_vk%s(' % proto.name
for p in proto.params:
# For last param of Create funcs, pass address of param
if create_func:
if proto.name == 'AllocateDescriptorSets' and ((p.name == proto.params[-2].name) or (p.name == proto.params[-1].name)):
rr_string += 'local_%s, ' % p.name
elif p.name == proto.params[-1].name:
rr_string += '&local_%s, ' % p.name
else:
rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
else:
rr_string += '%s, ' % self._get_packet_param(proto.name, p.ty, p.name)
rr_string = '%s);' % rr_string[:-2]
if proto.name in custom_open_params:
rr_list = rr_string.split(', ')
for pidx in custom_open_params[proto.name]:
rr_list[pidx] = '&local_%s' % proto.params[pidx].name
rr_string = ', '.join(rr_list)
rr_string += ');'
elif create_view:
rr_list = rr_string.split(', ')
rr_list[-3] = '&createInfo'
rr_list[-2] = 'NULL'
rr_list[-1] = '&local_%s);' % proto.params[-1].name
rr_string = ', '.join(rr_list)
# this is a sneaky shortcut to use generic create code below to add_to_map
create_func = True
elif proto.name == 'AllocateDescriptorSets':
rr_string = rr_string.replace('pPacket->pSetLayouts', 'pLocalDescSetLayouts')
elif proto.name == 'ResetFences':
rr_string = rr_string.replace('pPacket->pFences', 'fences')
# insert the real_*(..) call
rbody.append(rr_string)
# handle return values or anything that needs to happen after the real_*(..) call
get_ext_layers_proto = ['EnumerateInstanceExtensionProperties', 'EnumerateDeviceExtensionProperties','EnumerateInstanceLayerProperties', 'EnumerateDeviceLayerProperties']
if 'DestroyDevice' in proto.name:
rbody.append(' if (replayResult == VK_SUCCESS)')
rbody.append(' {')
rbody.append(' m_pCBDump = NULL;')
rbody.append(' m_pDSDump = NULL;')
#TODO138 : disabling snapshot
#rbody.append(' m_pVktraceSnapshotPrint = NULL;')
rbody.append(' m_objMapper.rm_from_devices_map(pPacket->device);')
rbody.append(' m_display->m_initedVK = false;')
rbody.append(' }')
elif proto.name in get_ext_layers_proto:
rbody.append(' if (replayResult == VK_ERROR_LAYER_NOT_PRESENT || replayResult == VK_INCOMPLETE)')
rbody.append(' { // ignore errors caused by trace config != replay config')
rbody.append(' replayResult = VK_SUCCESS;')
rbody.append(' }')
elif 'DestroySwapchainKHR' in proto.name:
rbody.append(' if (replayResult == VK_SUCCESS)')
rbody.append(' {')
rbody.append(' m_objMapper.rm_from_swapchainkhrs_map(pPacket->swapchain);')
rbody.append(' }')
elif 'AcquireNextImageKHR' in proto.name:
rbody.append(' m_objMapper.add_to_pImageIndex_map(*(pPacket->pImageIndex), local_pImageIndex);')
elif 'DestroyInstance' in proto.name:
rbody.append(' if (replayResult == VK_SUCCESS)')
rbody.append(' {')
rbody.append(' // TODO need to handle multiple instances and only clearing maps within an instance.')
rbody.append(' // TODO this only works with a single instance used at any given time.')
rbody.append(' m_objMapper.clear_all_map_handles();')
rbody.append(' }')
elif 'MergePipelineCaches' in proto.name:
rbody.append(' delete[] remappedpSrcCaches;')
elif 'FreeCommandBuffers' in proto.name:
rbody.append(' delete[] remappedpCommandBuffers;')
elif 'CmdExecuteCommands' in proto.name:
rbody.append(' delete[] remappedpCommandBuffers;')
elif 'AllocateDescriptorSets' in proto.name:
rbody.append(' if (replayResult == VK_SUCCESS)')
rbody.append(' {')
rbody.append(' for (uint32_t i = 0; i < pPacket->pAllocateInfo->descriptorSetCount; i++) {')
rbody.append(' m_objMapper.add_to_descriptorsets_map(pPacket->%s[i], local_%s[i]);' % (proto.params[-1].name, proto.params[-1].name))
rbody.append(' }')
rbody.append(' }')
rbody.append(' free(local_pSetLayouts);')
rbody.append(' free(local_pDescriptorSets);')
elif proto.name == 'ResetFences':
rbody.append(' VKTRACE_DELETE(fences);')
elif create_func: # save handle mapping if create successful
if ret_value:
rbody.append(' if (replayResult == VK_SUCCESS)')
rbody.append(' {')
clean_type = proto.params[-1].ty.strip('*').replace('const ', '')
VkNonDispObjType = [o for o in vulkan.object_non_dispatch_list]
rbody.append(' m_objMapper.add_to_%ss_map(*(pPacket->%s), local_%s);' % (clean_type.lower()[2:], proto.params[-1].name, proto.params[-1].name))
if 'AllocateMemory' == proto.name:
rbody.append(' m_objMapper.add_entry_to_mapData(local_%s, pPacket->pAllocateInfo->allocationSize);' % (proto.params[-1].name))
if ret_value:
rbody.append(' }')
elif proto.name in do_while_dict:
rbody[-1] = ' %s' % rbody[-1]
rbody.append(' } while (%s);' % do_while_dict[proto.name])
rbody.append(' if (pPacket->result != VK_NOT_READY || replayResult != VK_SUCCESS)')
if ret_value:
rbody.append(' CHECK_RETURN_VALUE(vk%s);' % proto.name)
rbody.append(' break;')
rbody.append(' }')
if proto_ext_ifdef:
rbody.append('#endif /* %s */' % proto_ext_ifdef)
rbody.append(' default:')
rbody.append(' vktrace_LogWarning("Unrecognized packet_id %u, skipping.", packet->packet_id);')
rbody.append(' returnValue = vktrace_replay::VKTRACE_REPLAY_INVALID_ID;')
rbody.append(' break;')
rbody.append(' }')
rbody.append(' return returnValue;')
rbody.append('}')
return "\n".join(rbody)
class VktraceTraceHeader(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#include "vktrace_vk_vk_packets.h"')
header_txt.append('#include "vktrace_vk_packet_id.h"')
header_txt.append('#include "vulkan/vk_layer.h"\n\n')
header_txt.append('void InitTracer(void);\n\n')
header_txt.append('#ifdef WIN32')
header_txt.append('BOOL CALLBACK InitTracer(_Inout_ PINIT_ONCE initOnce, _Inout_opt_ PVOID param, _Out_opt_ PVOID *lpContext);')
header_txt.append('extern INIT_ONCE gInitOnce;')
header_txt.append('\n#elif defined(PLATFORM_LINUX)')
header_txt.append('void InitTracer(void);')
header_txt.append('extern pthread_once_t gInitOnce;')
header_txt.append('#endif\n')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_trace_func_protos()]
return "\n".join(body)
class VktraceTraceC(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#include "vktrace_platform.h"')
header_txt.append('#include "vktrace_common.h"')
header_txt.append('#include "vktrace_lib_helpers.h"')
header_txt.append('#include "vktrace_vk_vk.h"')
#header_txt.append('#include "vktrace_vk_vk_lunarg_debug_marker.h"')
header_txt.append('#include "vktrace_interconnect.h"')
header_txt.append('#include "vktrace_filelike.h"')
header_txt.append('#include "vk_struct_size_helper.h"')
header_txt.append('#ifdef PLATFORM_LINUX')
header_txt.append('#include <pthread.h>')
header_txt.append('#endif')
header_txt.append('#include "vktrace_trace_packet_utils.h"')
header_txt.append('#include <stdio.h>\n')
header_txt.append('#include <string.h>\n')
header_txt.append('#ifdef WIN32')
header_txt.append('INIT_ONCE gInitOnce = INIT_ONCE_STATIC_INIT;')
header_txt.append('#elif defined(PLATFORM_LINUX)')
header_txt.append('pthread_once_t gInitOnce = PTHREAD_ONCE_INIT;')
header_txt.append('#endif')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_init_funcs(),
self._generate_trace_funcs(self.extensionName)]
return "\n".join(body)
class VktracePacketID(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#pragma once\n')
header_txt.append('#include "vktrace_vk_vk_packets.h"')
header_txt.append('#include "vktrace_trace_packet_utils.h"')
header_txt.append('#include "vktrace_trace_packet_identifiers.h"')
header_txt.append('#include "vktrace_interconnect.h"')
header_txt.append("#include <inttypes.h>")
#header_txt.append('#include "vktrace_vk_vk_lunarg_debug_marker_packets.h"')
header_txt.append('#include "vk_enum_string_helper.h"')
header_txt.append('#ifndef _WIN32')
header_txt.append(' #pragma GCC diagnostic ignored "-Wwrite-strings"')
header_txt.append('#endif')
#header_txt.append('#include "vk_struct_string_helper.h"')
header_txt.append('#ifndef _WIN32')
header_txt.append(' #pragma GCC diagnostic warning "-Wwrite-strings"')
header_txt.append('#endif')
header_txt.append('#if defined(WIN32)')
header_txt.append('#define snprintf _snprintf')
header_txt.append('#endif')
header_txt.append('#if defined(WIN32)')
header_txt.append('#define VK_SIZE_T_SPECIFIER "%Iu"')
header_txt.append('#else')
header_txt.append('#define VK_SIZE_T_SPECIFIER "%zu"')
header_txt.append('#endif')
header_txt.append('#define SEND_ENTRYPOINT_ID(entrypoint) ;')
header_txt.append('//#define SEND_ENTRYPOINT_ID(entrypoint) vktrace_TraceInfo(#entrypoint);\n')
header_txt.append('#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) ;')
header_txt.append('//#define SEND_ENTRYPOINT_PARAMS(entrypoint, ...) vktrace_TraceInfo(entrypoint, __VA_ARGS__);\n')
header_txt.append('#define CREATE_TRACE_PACKET(entrypoint, buffer_bytes_needed) \\')
header_txt.append(' pHeader = vktrace_create_trace_packet(VKTRACE_TID_VULKAN, VKTRACE_TPI_VK_##entrypoint, sizeof(packet_##entrypoint), buffer_bytes_needed);\n')
header_txt.append('#define FINISH_TRACE_PACKET() \\')
header_txt.append(' vktrace_finalize_trace_packet(pHeader); \\')
header_txt.append(' vktrace_write_trace_packet(pHeader, vktrace_trace_get_trace_file()); \\')
header_txt.append(' vktrace_delete_trace_packet(&pHeader);')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_packet_id_enum(),
self._generate_packet_id_name_func(),
self._generate_stringify_func(),
self._generate_interp_func()]
return "\n".join(body)
class VktraceCoreTracePackets(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#pragma once\n')
header_txt.append('#include "vulkan/vulkan.h"')
header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_struct_util_funcs(),
self._generate_interp_funcs()]
return "\n".join(body)
class VktraceExtTraceHeader(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#pragma once\n')
header_txt.append('#include "vulkan/vulkan.h"')
header_txt.append('#include "%s.h"' % extensionName.lower())
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_trace_func_protos_ext(self.extensionName)]
return "\n".join(body)
class VktraceExtTraceC(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#include "vktrace_vk_packet_id.h"')
header_txt.append('#include "vktrace_platform.h"')
header_txt.append('#include "vktrace_common.h"')
header_txt.append('#include "vktrace_vk_%s.h"' % extensionName.lower())
header_txt.append('#include "vktrace_vk_%s_packets.h"' % extensionName.lower())
header_txt.append('#include "vk_struct_size_helper.h"')
header_txt.append('#include "%s_struct_size_helper.h"' % extensionName.lower())
#if extensionName == 'vk_lunarg_debug_marker':
# header_txt.append('#include "vk_debug_marker_layer.h"\n')
header_txt.append('#include "vktrace_lib_helpers.h"')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_trace_funcs(self.extensionName)]
return "\n".join(body)
class VktraceExtTracePackets(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#pragma once\n')
header_txt.append('#include "%s.h"' % extensionName.lower())
header_txt.append('#include "vktrace_trace_packet_utils.h"\n')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_interp_funcs_ext(self.extensionName)]
return "\n".join(body)
class VktraceReplayVkFuncPtrs(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#pragma once\n')
header_txt.append('#if defined(PLATFORM_LINUX) || defined(XCB_NVIDIA)')
header_txt.append('#if !defined(ANDROID)')
header_txt.append('#include <xcb/xcb.h>\n')
header_txt.append('#endif')
header_txt.append('#endif')
header_txt.append('#include "vulkan/vulkan.h"')
#header_txt.append('#include "vulkan/vk_lunarg_debug_marker.h"')
def generate_body(self):
body = [self._generate_replay_func_ptrs()]
return "\n".join(body)
class VktraceReplayObjMapperHeader(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#pragma once\n')
header_txt.append('#include <set>')
header_txt.append('#include <map>')
header_txt.append('#include <vector>')
header_txt.append('#include <string>')
header_txt.append('#include "vulkan/vulkan.h"')
header_txt.append('#include "vktrace_pageguard_memorycopy.h"')
#header_txt.append('#include "vulkan/vk_lunarg_debug_marker.h"')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_replay_objmapper_class()]
return "\n".join(body)
class VktraceReplayC(Subcommand):
def generate_header(self, extensionName):
header_txt = []
header_txt.append('#include "vkreplay_vkreplay.h"\n')
header_txt.append('#include "vkreplay.h"\n')
header_txt.append('#include "vkreplay_main.h"\n')
header_txt.append('#include <algorithm>')
header_txt.append('#include <queue>')
header_txt.append('\n')
header_txt.append('extern "C" {')
header_txt.append('#include "vktrace_vk_vk_packets.h"')
#header_txt.append('#include "vktrace_vk_vk_lunarg_debug_marker_packets.h"')
header_txt.append('#include "vktrace_vk_packet_id.h"')
#header_txt.append('#include "vk_enum_string_helper.h"\n}\n')
return "\n".join(header_txt)
def generate_body(self):
body = [self._generate_replay_init_funcs(),
self._generate_replay()]
body.append("}")
return "\n".join(body)
def main():
subcommands = {
"vktrace-trace-h" : VktraceTraceHeader,
"vktrace-trace-c" : VktraceTraceC,
"vktrace-packet-id" : VktracePacketID,
"vktrace-core-trace-packets" : VktraceCoreTracePackets,
"vktrace-ext-trace-h" : VktraceExtTraceHeader,
"vktrace-ext-trace-c" : VktraceExtTraceC,
"vktrace-ext-trace-packets" : VktraceExtTracePackets,
"vktrace-replay-vk-funcs" : VktraceReplayVkFuncPtrs,
"vktrace-replay-obj-mapper-h" : VktraceReplayObjMapperHeader,
"vktrace-replay-c" : VktraceReplayC,
}
if len(sys.argv) < 3 or sys.argv[2] not in subcommands:
print("Available subcommands are: %s" % " ".join(subcommands))
exit(1)
subcmd = subcommands[sys.argv[2]](sys.argv[3])
subcmd.run()
if __name__ == "__main__":
main()