xref: /aosp_15_r20/external/vulkan-validation-layers/layers/gpu_validation.cpp (revision b7893ccf7851cd6a48cc5a1e965257d8a5cdcc70)
1*b7893ccfSSadaf Ebrahimi /* Copyright (c) 2018-2019 The Khronos Group Inc.
2*b7893ccfSSadaf Ebrahimi  * Copyright (c) 2018-2019 Valve Corporation
3*b7893ccfSSadaf Ebrahimi  * Copyright (c) 2018-2019 LunarG, Inc.
4*b7893ccfSSadaf Ebrahimi  * Copyright (C) 2018-2019 Google Inc.
5*b7893ccfSSadaf Ebrahimi  *
6*b7893ccfSSadaf Ebrahimi  * Licensed under the Apache License, Version 2.0 (the "License");
7*b7893ccfSSadaf Ebrahimi  * you may not use this file except in compliance with the License.
8*b7893ccfSSadaf Ebrahimi  * You may obtain a copy of the License at
9*b7893ccfSSadaf Ebrahimi  *
10*b7893ccfSSadaf Ebrahimi  *     http://www.apache.org/licenses/LICENSE-2.0
11*b7893ccfSSadaf Ebrahimi  *
12*b7893ccfSSadaf Ebrahimi  * Unless required by applicable law or agreed to in writing, software
13*b7893ccfSSadaf Ebrahimi  * distributed under the License is distributed on an "AS IS" BASIS,
14*b7893ccfSSadaf Ebrahimi  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15*b7893ccfSSadaf Ebrahimi  * See the License for the specific language governing permissions and
16*b7893ccfSSadaf Ebrahimi  * limitations under the License.
17*b7893ccfSSadaf Ebrahimi  *
18*b7893ccfSSadaf Ebrahimi  */
19*b7893ccfSSadaf Ebrahimi 
20*b7893ccfSSadaf Ebrahimi // Allow use of STL min and max functions in Windows
21*b7893ccfSSadaf Ebrahimi #define NOMINMAX
22*b7893ccfSSadaf Ebrahimi 
23*b7893ccfSSadaf Ebrahimi #include "chassis.h"
24*b7893ccfSSadaf Ebrahimi #include "core_validation.h"
25*b7893ccfSSadaf Ebrahimi // This define indicates to build the VMA routines themselves
26*b7893ccfSSadaf Ebrahimi #define VMA_IMPLEMENTATION
27*b7893ccfSSadaf Ebrahimi // This define indicates that we will supply Vulkan function pointers at initialization
28*b7893ccfSSadaf Ebrahimi #define VMA_STATIC_VULKAN_FUNCTIONS 0
29*b7893ccfSSadaf Ebrahimi #include "gpu_validation.h"
30*b7893ccfSSadaf Ebrahimi #include "shader_validation.h"
31*b7893ccfSSadaf Ebrahimi #include "spirv-tools/libspirv.h"
32*b7893ccfSSadaf Ebrahimi #include "spirv-tools/optimizer.hpp"
33*b7893ccfSSadaf Ebrahimi #include "spirv-tools/instrument.hpp"
34*b7893ccfSSadaf Ebrahimi #include <SPIRV/spirv.hpp>
35*b7893ccfSSadaf Ebrahimi #include <algorithm>
36*b7893ccfSSadaf Ebrahimi #include <regex>
37*b7893ccfSSadaf Ebrahimi 
38*b7893ccfSSadaf Ebrahimi // This is the number of bindings in the debug descriptor set.
39*b7893ccfSSadaf Ebrahimi static const uint32_t kNumBindingsInSet = 2;
40*b7893ccfSSadaf Ebrahimi 
41*b7893ccfSSadaf Ebrahimi static const VkShaderStageFlags kShaderStageAllRayTracing =
42*b7893ccfSSadaf Ebrahimi     VK_SHADER_STAGE_ANY_HIT_BIT_NV | VK_SHADER_STAGE_CALLABLE_BIT_NV | VK_SHADER_STAGE_CLOSEST_HIT_BIT_NV |
43*b7893ccfSSadaf Ebrahimi     VK_SHADER_STAGE_INTERSECTION_BIT_NV | VK_SHADER_STAGE_MISS_BIT_NV | VK_SHADER_STAGE_RAYGEN_BIT_NV;
44*b7893ccfSSadaf Ebrahimi 
45*b7893ccfSSadaf Ebrahimi // Implementation for Descriptor Set Manager class
GpuDescriptorSetManager(CoreChecks * dev_data)46*b7893ccfSSadaf Ebrahimi GpuDescriptorSetManager::GpuDescriptorSetManager(CoreChecks *dev_data) { dev_data_ = dev_data; }
47*b7893ccfSSadaf Ebrahimi 
~GpuDescriptorSetManager()48*b7893ccfSSadaf Ebrahimi GpuDescriptorSetManager::~GpuDescriptorSetManager() {
49*b7893ccfSSadaf Ebrahimi     for (auto &pool : desc_pool_map_) {
50*b7893ccfSSadaf Ebrahimi         DispatchDestroyDescriptorPool(dev_data_->device, pool.first, NULL);
51*b7893ccfSSadaf Ebrahimi     }
52*b7893ccfSSadaf Ebrahimi     desc_pool_map_.clear();
53*b7893ccfSSadaf Ebrahimi }
54*b7893ccfSSadaf Ebrahimi 
GetDescriptorSets(uint32_t count,VkDescriptorPool * pool,std::vector<VkDescriptorSet> * desc_sets)55*b7893ccfSSadaf Ebrahimi VkResult GpuDescriptorSetManager::GetDescriptorSets(uint32_t count, VkDescriptorPool *pool,
56*b7893ccfSSadaf Ebrahimi                                                     std::vector<VkDescriptorSet> *desc_sets) {
57*b7893ccfSSadaf Ebrahimi     const uint32_t default_pool_size = kItemsPerChunk;
58*b7893ccfSSadaf Ebrahimi     VkResult result = VK_SUCCESS;
59*b7893ccfSSadaf Ebrahimi     VkDescriptorPool pool_to_use = VK_NULL_HANDLE;
60*b7893ccfSSadaf Ebrahimi 
61*b7893ccfSSadaf Ebrahimi     if (0 == count) {
62*b7893ccfSSadaf Ebrahimi         return result;
63*b7893ccfSSadaf Ebrahimi     }
64*b7893ccfSSadaf Ebrahimi     desc_sets->clear();
65*b7893ccfSSadaf Ebrahimi     desc_sets->resize(count);
66*b7893ccfSSadaf Ebrahimi 
67*b7893ccfSSadaf Ebrahimi     for (auto &pool : desc_pool_map_) {
68*b7893ccfSSadaf Ebrahimi         if (pool.second.used + count < pool.second.size) {
69*b7893ccfSSadaf Ebrahimi             pool_to_use = pool.first;
70*b7893ccfSSadaf Ebrahimi             break;
71*b7893ccfSSadaf Ebrahimi         }
72*b7893ccfSSadaf Ebrahimi     }
73*b7893ccfSSadaf Ebrahimi     if (VK_NULL_HANDLE == pool_to_use) {
74*b7893ccfSSadaf Ebrahimi         uint32_t pool_count = default_pool_size;
75*b7893ccfSSadaf Ebrahimi         if (count > default_pool_size) {
76*b7893ccfSSadaf Ebrahimi             pool_count = count;
77*b7893ccfSSadaf Ebrahimi         }
78*b7893ccfSSadaf Ebrahimi         const VkDescriptorPoolSize size_counts = {
79*b7893ccfSSadaf Ebrahimi             VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
80*b7893ccfSSadaf Ebrahimi             pool_count * kNumBindingsInSet,
81*b7893ccfSSadaf Ebrahimi         };
82*b7893ccfSSadaf Ebrahimi         VkDescriptorPoolCreateInfo desc_pool_info = {};
83*b7893ccfSSadaf Ebrahimi         desc_pool_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO;
84*b7893ccfSSadaf Ebrahimi         desc_pool_info.pNext = NULL;
85*b7893ccfSSadaf Ebrahimi         desc_pool_info.flags = VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT;
86*b7893ccfSSadaf Ebrahimi         desc_pool_info.maxSets = pool_count;
87*b7893ccfSSadaf Ebrahimi         desc_pool_info.poolSizeCount = 1;
88*b7893ccfSSadaf Ebrahimi         desc_pool_info.pPoolSizes = &size_counts;
89*b7893ccfSSadaf Ebrahimi         result = DispatchCreateDescriptorPool(dev_data_->device, &desc_pool_info, NULL, &pool_to_use);
90*b7893ccfSSadaf Ebrahimi         assert(result == VK_SUCCESS);
91*b7893ccfSSadaf Ebrahimi         if (result != VK_SUCCESS) {
92*b7893ccfSSadaf Ebrahimi             return result;
93*b7893ccfSSadaf Ebrahimi         }
94*b7893ccfSSadaf Ebrahimi         desc_pool_map_[pool_to_use].size = desc_pool_info.maxSets;
95*b7893ccfSSadaf Ebrahimi         desc_pool_map_[pool_to_use].used = 0;
96*b7893ccfSSadaf Ebrahimi     }
97*b7893ccfSSadaf Ebrahimi     std::vector<VkDescriptorSetLayout> desc_layouts(count, dev_data_->gpu_validation_state->debug_desc_layout);
98*b7893ccfSSadaf Ebrahimi 
99*b7893ccfSSadaf Ebrahimi     VkDescriptorSetAllocateInfo alloc_info = {VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO, NULL, pool_to_use, count,
100*b7893ccfSSadaf Ebrahimi                                               desc_layouts.data()};
101*b7893ccfSSadaf Ebrahimi 
102*b7893ccfSSadaf Ebrahimi     result = DispatchAllocateDescriptorSets(dev_data_->device, &alloc_info, desc_sets->data());
103*b7893ccfSSadaf Ebrahimi     assert(result == VK_SUCCESS);
104*b7893ccfSSadaf Ebrahimi     if (result != VK_SUCCESS) {
105*b7893ccfSSadaf Ebrahimi         return result;
106*b7893ccfSSadaf Ebrahimi     }
107*b7893ccfSSadaf Ebrahimi     *pool = pool_to_use;
108*b7893ccfSSadaf Ebrahimi     desc_pool_map_[pool_to_use].used += count;
109*b7893ccfSSadaf Ebrahimi     return result;
110*b7893ccfSSadaf Ebrahimi }
111*b7893ccfSSadaf Ebrahimi 
PutBackDescriptorSet(VkDescriptorPool desc_pool,VkDescriptorSet desc_set)112*b7893ccfSSadaf Ebrahimi void GpuDescriptorSetManager::PutBackDescriptorSet(VkDescriptorPool desc_pool, VkDescriptorSet desc_set) {
113*b7893ccfSSadaf Ebrahimi     auto iter = desc_pool_map_.find(desc_pool);
114*b7893ccfSSadaf Ebrahimi     if (iter != desc_pool_map_.end()) {
115*b7893ccfSSadaf Ebrahimi         VkResult result = DispatchFreeDescriptorSets(dev_data_->device, desc_pool, 1, &desc_set);
116*b7893ccfSSadaf Ebrahimi         assert(result == VK_SUCCESS);
117*b7893ccfSSadaf Ebrahimi         if (result != VK_SUCCESS) {
118*b7893ccfSSadaf Ebrahimi             return;
119*b7893ccfSSadaf Ebrahimi         }
120*b7893ccfSSadaf Ebrahimi         desc_pool_map_[desc_pool].used--;
121*b7893ccfSSadaf Ebrahimi         if (0 == desc_pool_map_[desc_pool].used) {
122*b7893ccfSSadaf Ebrahimi             DispatchDestroyDescriptorPool(dev_data_->device, desc_pool, NULL);
123*b7893ccfSSadaf Ebrahimi             desc_pool_map_.erase(desc_pool);
124*b7893ccfSSadaf Ebrahimi         }
125*b7893ccfSSadaf Ebrahimi     }
126*b7893ccfSSadaf Ebrahimi     return;
127*b7893ccfSSadaf Ebrahimi }
128*b7893ccfSSadaf Ebrahimi 
129*b7893ccfSSadaf Ebrahimi // Trampolines to make VMA call Dispatch for Vulkan calls
gpuVkGetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,VkPhysicalDeviceProperties * pProperties)130*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkGetPhysicalDeviceProperties(VkPhysicalDevice physicalDevice,
131*b7893ccfSSadaf Ebrahimi                                                                    VkPhysicalDeviceProperties *pProperties) {
132*b7893ccfSSadaf Ebrahimi     DispatchGetPhysicalDeviceProperties(physicalDevice, pProperties);
133*b7893ccfSSadaf Ebrahimi }
gpuVkGetPhysicalDeviceMemoryProperties(VkPhysicalDevice physicalDevice,VkPhysicalDeviceMemoryProperties * pMemoryProperties)134*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkGetPhysicalDeviceMemoryProperties(VkPhysicalDevice physicalDevice,
135*b7893ccfSSadaf Ebrahimi                                                                          VkPhysicalDeviceMemoryProperties *pMemoryProperties) {
136*b7893ccfSSadaf Ebrahimi     DispatchGetPhysicalDeviceMemoryProperties(physicalDevice, pMemoryProperties);
137*b7893ccfSSadaf Ebrahimi }
gpuVkAllocateMemory(VkDevice device,const VkMemoryAllocateInfo * pAllocateInfo,const VkAllocationCallbacks * pAllocator,VkDeviceMemory * pMemory)138*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkAllocateMemory(VkDevice device, const VkMemoryAllocateInfo *pAllocateInfo,
139*b7893ccfSSadaf Ebrahimi                                                           const VkAllocationCallbacks *pAllocator, VkDeviceMemory *pMemory) {
140*b7893ccfSSadaf Ebrahimi     return DispatchAllocateMemory(device, pAllocateInfo, pAllocator, pMemory);
141*b7893ccfSSadaf Ebrahimi }
gpuVkFreeMemory(VkDevice device,VkDeviceMemory memory,const VkAllocationCallbacks * pAllocator)142*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks *pAllocator) {
143*b7893ccfSSadaf Ebrahimi     DispatchFreeMemory(device, memory, pAllocator);
144*b7893ccfSSadaf Ebrahimi }
gpuVkMapMemory(VkDevice device,VkDeviceMemory memory,VkDeviceSize offset,VkDeviceSize size,VkMemoryMapFlags flags,void ** ppData)145*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkMapMemory(VkDevice device, VkDeviceMemory memory, VkDeviceSize offset, VkDeviceSize size,
146*b7893ccfSSadaf Ebrahimi                                                      VkMemoryMapFlags flags, void **ppData) {
147*b7893ccfSSadaf Ebrahimi     return DispatchMapMemory(device, memory, offset, size, flags, ppData);
148*b7893ccfSSadaf Ebrahimi }
gpuVkUnmapMemory(VkDevice device,VkDeviceMemory memory)149*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkUnmapMemory(VkDevice device, VkDeviceMemory memory) { DispatchUnmapMemory(device, memory); }
gpuVkFlushMappedMemoryRanges(VkDevice device,uint32_t memoryRangeCount,const VkMappedMemoryRange * pMemoryRanges)150*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkFlushMappedMemoryRanges(VkDevice device, uint32_t memoryRangeCount,
151*b7893ccfSSadaf Ebrahimi                                                                    const VkMappedMemoryRange *pMemoryRanges) {
152*b7893ccfSSadaf Ebrahimi     return DispatchFlushMappedMemoryRanges(device, memoryRangeCount, pMemoryRanges);
153*b7893ccfSSadaf Ebrahimi }
gpuVkInvalidateMappedMemoryRanges(VkDevice device,uint32_t memoryRangeCount,const VkMappedMemoryRange * pMemoryRanges)154*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkInvalidateMappedMemoryRanges(VkDevice device, uint32_t memoryRangeCount,
155*b7893ccfSSadaf Ebrahimi                                                                         const VkMappedMemoryRange *pMemoryRanges) {
156*b7893ccfSSadaf Ebrahimi     return DispatchInvalidateMappedMemoryRanges(device, memoryRangeCount, pMemoryRanges);
157*b7893ccfSSadaf Ebrahimi }
gpuVkBindBufferMemory(VkDevice device,VkBuffer buffer,VkDeviceMemory memory,VkDeviceSize memoryOffset)158*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
159*b7893ccfSSadaf Ebrahimi                                                             VkDeviceSize memoryOffset) {
160*b7893ccfSSadaf Ebrahimi     return DispatchBindBufferMemory(device, buffer, memory, memoryOffset);
161*b7893ccfSSadaf Ebrahimi }
gpuVkBindImageMemory(VkDevice device,VkImage image,VkDeviceMemory memory,VkDeviceSize memoryOffset)162*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
163*b7893ccfSSadaf Ebrahimi                                                            VkDeviceSize memoryOffset) {
164*b7893ccfSSadaf Ebrahimi     return DispatchBindImageMemory(device, image, memory, memoryOffset);
165*b7893ccfSSadaf Ebrahimi }
gpuVkGetBufferMemoryRequirements(VkDevice device,VkBuffer buffer,VkMemoryRequirements * pMemoryRequirements)166*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkGetBufferMemoryRequirements(VkDevice device, VkBuffer buffer,
167*b7893ccfSSadaf Ebrahimi                                                                    VkMemoryRequirements *pMemoryRequirements) {
168*b7893ccfSSadaf Ebrahimi     DispatchGetBufferMemoryRequirements(device, buffer, pMemoryRequirements);
169*b7893ccfSSadaf Ebrahimi }
gpuVkGetImageMemoryRequirements(VkDevice device,VkImage image,VkMemoryRequirements * pMemoryRequirements)170*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkGetImageMemoryRequirements(VkDevice device, VkImage image,
171*b7893ccfSSadaf Ebrahimi                                                                   VkMemoryRequirements *pMemoryRequirements) {
172*b7893ccfSSadaf Ebrahimi     DispatchGetImageMemoryRequirements(device, image, pMemoryRequirements);
173*b7893ccfSSadaf Ebrahimi }
gpuVkCreateBuffer(VkDevice device,const VkBufferCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkBuffer * pBuffer)174*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkCreateBuffer(VkDevice device, const VkBufferCreateInfo *pCreateInfo,
175*b7893ccfSSadaf Ebrahimi                                                         const VkAllocationCallbacks *pAllocator, VkBuffer *pBuffer) {
176*b7893ccfSSadaf Ebrahimi     return DispatchCreateBuffer(device, pCreateInfo, pAllocator, pBuffer);
177*b7893ccfSSadaf Ebrahimi }
gpuVkDestroyBuffer(VkDevice device,VkBuffer buffer,const VkAllocationCallbacks * pAllocator)178*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkDestroyBuffer(VkDevice device, VkBuffer buffer, const VkAllocationCallbacks *pAllocator) {
179*b7893ccfSSadaf Ebrahimi     return DispatchDestroyBuffer(device, buffer, pAllocator);
180*b7893ccfSSadaf Ebrahimi }
gpuVkCreateImage(VkDevice device,const VkImageCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkImage * pImage)181*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR VkResult VKAPI_CALL gpuVkCreateImage(VkDevice device, const VkImageCreateInfo *pCreateInfo,
182*b7893ccfSSadaf Ebrahimi                                                        const VkAllocationCallbacks *pAllocator, VkImage *pImage) {
183*b7893ccfSSadaf Ebrahimi     return DispatchCreateImage(device, pCreateInfo, pAllocator, pImage);
184*b7893ccfSSadaf Ebrahimi }
gpuVkDestroyImage(VkDevice device,VkImage image,const VkAllocationCallbacks * pAllocator)185*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
186*b7893ccfSSadaf Ebrahimi     DispatchDestroyImage(device, image, pAllocator);
187*b7893ccfSSadaf Ebrahimi }
gpuVkCmdCopyBuffer(VkCommandBuffer commandBuffer,VkBuffer srcBuffer,VkBuffer dstBuffer,uint32_t regionCount,const VkBufferCopy * pRegions)188*b7893ccfSSadaf Ebrahimi static VKAPI_ATTR void VKAPI_CALL gpuVkCmdCopyBuffer(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkBuffer dstBuffer,
189*b7893ccfSSadaf Ebrahimi                                                      uint32_t regionCount, const VkBufferCopy *pRegions) {
190*b7893ccfSSadaf Ebrahimi     DispatchCmdCopyBuffer(commandBuffer, srcBuffer, dstBuffer, regionCount, pRegions);
191*b7893ccfSSadaf Ebrahimi }
192*b7893ccfSSadaf Ebrahimi 
GpuInitializeVma()193*b7893ccfSSadaf Ebrahimi VkResult CoreChecks::GpuInitializeVma() {
194*b7893ccfSSadaf Ebrahimi     VmaVulkanFunctions functions;
195*b7893ccfSSadaf Ebrahimi     VmaAllocatorCreateInfo allocatorInfo = {};
196*b7893ccfSSadaf Ebrahimi     allocatorInfo.device = device;
197*b7893ccfSSadaf Ebrahimi     ValidationObject *device_object = GetLayerDataPtr(get_dispatch_key(allocatorInfo.device), layer_data_map);
198*b7893ccfSSadaf Ebrahimi     ValidationObject *validation_data =
199*b7893ccfSSadaf Ebrahimi         ValidationObject::GetValidationObject(device_object->object_dispatch, LayerObjectTypeCoreValidation);
200*b7893ccfSSadaf Ebrahimi     CoreChecks *core_checks = static_cast<CoreChecks *>(validation_data);
201*b7893ccfSSadaf Ebrahimi     allocatorInfo.physicalDevice = core_checks->physical_device;
202*b7893ccfSSadaf Ebrahimi 
203*b7893ccfSSadaf Ebrahimi     functions.vkGetPhysicalDeviceProperties = (PFN_vkGetPhysicalDeviceProperties)gpuVkGetPhysicalDeviceProperties;
204*b7893ccfSSadaf Ebrahimi     functions.vkGetPhysicalDeviceMemoryProperties = (PFN_vkGetPhysicalDeviceMemoryProperties)gpuVkGetPhysicalDeviceMemoryProperties;
205*b7893ccfSSadaf Ebrahimi     functions.vkAllocateMemory = (PFN_vkAllocateMemory)gpuVkAllocateMemory;
206*b7893ccfSSadaf Ebrahimi     functions.vkFreeMemory = (PFN_vkFreeMemory)gpuVkFreeMemory;
207*b7893ccfSSadaf Ebrahimi     functions.vkMapMemory = (PFN_vkMapMemory)gpuVkMapMemory;
208*b7893ccfSSadaf Ebrahimi     functions.vkUnmapMemory = (PFN_vkUnmapMemory)gpuVkUnmapMemory;
209*b7893ccfSSadaf Ebrahimi     functions.vkFlushMappedMemoryRanges = (PFN_vkFlushMappedMemoryRanges)gpuVkFlushMappedMemoryRanges;
210*b7893ccfSSadaf Ebrahimi     functions.vkInvalidateMappedMemoryRanges = (PFN_vkInvalidateMappedMemoryRanges)gpuVkInvalidateMappedMemoryRanges;
211*b7893ccfSSadaf Ebrahimi     functions.vkBindBufferMemory = (PFN_vkBindBufferMemory)gpuVkBindBufferMemory;
212*b7893ccfSSadaf Ebrahimi     functions.vkBindImageMemory = (PFN_vkBindImageMemory)gpuVkBindImageMemory;
213*b7893ccfSSadaf Ebrahimi     functions.vkGetBufferMemoryRequirements = (PFN_vkGetBufferMemoryRequirements)gpuVkGetBufferMemoryRequirements;
214*b7893ccfSSadaf Ebrahimi     functions.vkGetImageMemoryRequirements = (PFN_vkGetImageMemoryRequirements)gpuVkGetImageMemoryRequirements;
215*b7893ccfSSadaf Ebrahimi     functions.vkCreateBuffer = (PFN_vkCreateBuffer)gpuVkCreateBuffer;
216*b7893ccfSSadaf Ebrahimi     functions.vkDestroyBuffer = (PFN_vkDestroyBuffer)gpuVkDestroyBuffer;
217*b7893ccfSSadaf Ebrahimi     functions.vkCreateImage = (PFN_vkCreateImage)gpuVkCreateImage;
218*b7893ccfSSadaf Ebrahimi     functions.vkDestroyImage = (PFN_vkDestroyImage)gpuVkDestroyImage;
219*b7893ccfSSadaf Ebrahimi     functions.vkCmdCopyBuffer = (PFN_vkCmdCopyBuffer)gpuVkCmdCopyBuffer;
220*b7893ccfSSadaf Ebrahimi     allocatorInfo.pVulkanFunctions = &functions;
221*b7893ccfSSadaf Ebrahimi 
222*b7893ccfSSadaf Ebrahimi     return vmaCreateAllocator(&allocatorInfo, &gpu_validation_state->vmaAllocator);
223*b7893ccfSSadaf Ebrahimi }
224*b7893ccfSSadaf Ebrahimi 
225*b7893ccfSSadaf Ebrahimi // Convenience function for reporting problems with setting up GPU Validation.
ReportSetupProblem(VkDebugReportObjectTypeEXT object_type,uint64_t object_handle,const char * const specific_message)226*b7893ccfSSadaf Ebrahimi void CoreChecks::ReportSetupProblem(VkDebugReportObjectTypeEXT object_type, uint64_t object_handle,
227*b7893ccfSSadaf Ebrahimi                                     const char *const specific_message) {
228*b7893ccfSSadaf Ebrahimi     log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, object_type, object_handle, "UNASSIGNED-GPU-Assisted Validation Error. ",
229*b7893ccfSSadaf Ebrahimi             "Detail: (%s)", specific_message);
230*b7893ccfSSadaf Ebrahimi }
231*b7893ccfSSadaf Ebrahimi 
232*b7893ccfSSadaf Ebrahimi // Turn on necessary device features.
GpuPreCallRecordCreateDevice(VkPhysicalDevice gpu,safe_VkDeviceCreateInfo * modified_create_info,VkPhysicalDeviceFeatures * supported_features)233*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPreCallRecordCreateDevice(VkPhysicalDevice gpu, safe_VkDeviceCreateInfo *modified_create_info,
234*b7893ccfSSadaf Ebrahimi                                               VkPhysicalDeviceFeatures *supported_features) {
235*b7893ccfSSadaf Ebrahimi     if (supported_features->fragmentStoresAndAtomics || supported_features->vertexPipelineStoresAndAtomics) {
236*b7893ccfSSadaf Ebrahimi         VkPhysicalDeviceFeatures *features = nullptr;
237*b7893ccfSSadaf Ebrahimi         if (modified_create_info->pEnabledFeatures) {
238*b7893ccfSSadaf Ebrahimi             // If pEnabledFeatures, VkPhysicalDeviceFeatures2 in pNext chain is not allowed
239*b7893ccfSSadaf Ebrahimi             features = const_cast<VkPhysicalDeviceFeatures *>(modified_create_info->pEnabledFeatures);
240*b7893ccfSSadaf Ebrahimi         } else {
241*b7893ccfSSadaf Ebrahimi             VkPhysicalDeviceFeatures2 *features2 = nullptr;
242*b7893ccfSSadaf Ebrahimi             features2 =
243*b7893ccfSSadaf Ebrahimi                 const_cast<VkPhysicalDeviceFeatures2 *>(lvl_find_in_chain<VkPhysicalDeviceFeatures2>(modified_create_info->pNext));
244*b7893ccfSSadaf Ebrahimi             if (features2) features = &features2->features;
245*b7893ccfSSadaf Ebrahimi         }
246*b7893ccfSSadaf Ebrahimi         if (features) {
247*b7893ccfSSadaf Ebrahimi             features->fragmentStoresAndAtomics = supported_features->fragmentStoresAndAtomics;
248*b7893ccfSSadaf Ebrahimi             features->vertexPipelineStoresAndAtomics = supported_features->vertexPipelineStoresAndAtomics;
249*b7893ccfSSadaf Ebrahimi         } else {
250*b7893ccfSSadaf Ebrahimi             VkPhysicalDeviceFeatures new_features = {};
251*b7893ccfSSadaf Ebrahimi             new_features.fragmentStoresAndAtomics = supported_features->fragmentStoresAndAtomics;
252*b7893ccfSSadaf Ebrahimi             new_features.vertexPipelineStoresAndAtomics = supported_features->vertexPipelineStoresAndAtomics;
253*b7893ccfSSadaf Ebrahimi             delete modified_create_info->pEnabledFeatures;
254*b7893ccfSSadaf Ebrahimi             modified_create_info->pEnabledFeatures = new VkPhysicalDeviceFeatures(new_features);
255*b7893ccfSSadaf Ebrahimi         }
256*b7893ccfSSadaf Ebrahimi     }
257*b7893ccfSSadaf Ebrahimi }
258*b7893ccfSSadaf Ebrahimi 
259*b7893ccfSSadaf Ebrahimi // Perform initializations that can be done at Create Device time.
GpuPostCallRecordCreateDevice(const CHECK_ENABLED * enables,const VkDeviceCreateInfo * pCreateInfo)260*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallRecordCreateDevice(const CHECK_ENABLED *enables, const VkDeviceCreateInfo *pCreateInfo) {
261*b7893ccfSSadaf Ebrahimi     // Set instance-level enables in device-enable data structure if using legacy settings
262*b7893ccfSSadaf Ebrahimi     enabled.gpu_validation = enables->gpu_validation;
263*b7893ccfSSadaf Ebrahimi     enabled.gpu_validation_reserve_binding_slot = enables->gpu_validation_reserve_binding_slot;
264*b7893ccfSSadaf Ebrahimi 
265*b7893ccfSSadaf Ebrahimi     gpu_validation_state = std::unique_ptr<GpuValidationState>(new GpuValidationState);
266*b7893ccfSSadaf Ebrahimi     gpu_validation_state->reserve_binding_slot = enables->gpu_validation_reserve_binding_slot;
267*b7893ccfSSadaf Ebrahimi 
268*b7893ccfSSadaf Ebrahimi     if (phys_dev_props.apiVersion < VK_API_VERSION_1_1) {
269*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
270*b7893ccfSSadaf Ebrahimi                            "GPU-Assisted validation requires Vulkan 1.1 or later.  GPU-Assisted Validation disabled.");
271*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
272*b7893ccfSSadaf Ebrahimi         return;
273*b7893ccfSSadaf Ebrahimi     }
274*b7893ccfSSadaf Ebrahimi 
275*b7893ccfSSadaf Ebrahimi     // If api version 1.1 or later, SetDeviceLoaderData will be in the loader
276*b7893ccfSSadaf Ebrahimi     auto chain_info = get_chain_info(pCreateInfo, VK_LOADER_DATA_CALLBACK);
277*b7893ccfSSadaf Ebrahimi     assert(chain_info->u.pfnSetDeviceLoaderData);
278*b7893ccfSSadaf Ebrahimi     gpu_validation_state->vkSetDeviceLoaderData = chain_info->u.pfnSetDeviceLoaderData;
279*b7893ccfSSadaf Ebrahimi 
280*b7893ccfSSadaf Ebrahimi     // Some devices have extremely high limits here, so set a reasonable max because we have to pad
281*b7893ccfSSadaf Ebrahimi     // the pipeline layout with dummy descriptor set layouts.
282*b7893ccfSSadaf Ebrahimi     gpu_validation_state->adjusted_max_desc_sets = phys_dev_props.limits.maxBoundDescriptorSets;
283*b7893ccfSSadaf Ebrahimi     gpu_validation_state->adjusted_max_desc_sets = std::min(33U, gpu_validation_state->adjusted_max_desc_sets);
284*b7893ccfSSadaf Ebrahimi 
285*b7893ccfSSadaf Ebrahimi     // We can't do anything if there is only one.
286*b7893ccfSSadaf Ebrahimi     // Device probably not a legit Vulkan device, since there should be at least 4. Protect ourselves.
287*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->adjusted_max_desc_sets == 1) {
288*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
289*b7893ccfSSadaf Ebrahimi                            "Device can bind only a single descriptor set.  GPU-Assisted Validation disabled.");
290*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
291*b7893ccfSSadaf Ebrahimi         return;
292*b7893ccfSSadaf Ebrahimi     }
293*b7893ccfSSadaf Ebrahimi     gpu_validation_state->desc_set_bind_index = gpu_validation_state->adjusted_max_desc_sets - 1;
294*b7893ccfSSadaf Ebrahimi     log_msg(report_data, VK_DEBUG_REPORT_INFORMATION_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
295*b7893ccfSSadaf Ebrahimi             "UNASSIGNED-GPU-Assisted Validation. ", "Shaders using descriptor set at index %d. ",
296*b7893ccfSSadaf Ebrahimi             gpu_validation_state->desc_set_bind_index);
297*b7893ccfSSadaf Ebrahimi 
298*b7893ccfSSadaf Ebrahimi     gpu_validation_state->output_buffer_size = sizeof(uint32_t) * (spvtools::kInstMaxOutCnt + 1);
299*b7893ccfSSadaf Ebrahimi     VkResult result = GpuInitializeVma();
300*b7893ccfSSadaf Ebrahimi     assert(result == VK_SUCCESS);
301*b7893ccfSSadaf Ebrahimi     std::unique_ptr<GpuDescriptorSetManager> desc_set_manager(new GpuDescriptorSetManager(this));
302*b7893ccfSSadaf Ebrahimi 
303*b7893ccfSSadaf Ebrahimi     // The descriptor indexing checks require only the first "output" binding.
304*b7893ccfSSadaf Ebrahimi     const VkDescriptorSetLayoutBinding debug_desc_layout_bindings[kNumBindingsInSet] = {
305*b7893ccfSSadaf Ebrahimi         {
306*b7893ccfSSadaf Ebrahimi             0,  // output
307*b7893ccfSSadaf Ebrahimi             VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
308*b7893ccfSSadaf Ebrahimi             1,
309*b7893ccfSSadaf Ebrahimi             VK_SHADER_STAGE_ALL_GRAPHICS | VK_SHADER_STAGE_COMPUTE_BIT | kShaderStageAllRayTracing,
310*b7893ccfSSadaf Ebrahimi             NULL,
311*b7893ccfSSadaf Ebrahimi         },
312*b7893ccfSSadaf Ebrahimi         {
313*b7893ccfSSadaf Ebrahimi             1,  // input
314*b7893ccfSSadaf Ebrahimi             VK_DESCRIPTOR_TYPE_STORAGE_BUFFER,
315*b7893ccfSSadaf Ebrahimi             1,
316*b7893ccfSSadaf Ebrahimi             VK_SHADER_STAGE_ALL_GRAPHICS | VK_SHADER_STAGE_COMPUTE_BIT | kShaderStageAllRayTracing,
317*b7893ccfSSadaf Ebrahimi             NULL,
318*b7893ccfSSadaf Ebrahimi         },
319*b7893ccfSSadaf Ebrahimi     };
320*b7893ccfSSadaf Ebrahimi 
321*b7893ccfSSadaf Ebrahimi     const VkDescriptorSetLayoutCreateInfo debug_desc_layout_info = {VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO, NULL, 0,
322*b7893ccfSSadaf Ebrahimi                                                                     kNumBindingsInSet, debug_desc_layout_bindings};
323*b7893ccfSSadaf Ebrahimi 
324*b7893ccfSSadaf Ebrahimi     const VkDescriptorSetLayoutCreateInfo dummy_desc_layout_info = {VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO, NULL, 0, 0,
325*b7893ccfSSadaf Ebrahimi                                                                     NULL};
326*b7893ccfSSadaf Ebrahimi 
327*b7893ccfSSadaf Ebrahimi     result = DispatchCreateDescriptorSetLayout(device, &debug_desc_layout_info, NULL, &gpu_validation_state->debug_desc_layout);
328*b7893ccfSSadaf Ebrahimi 
329*b7893ccfSSadaf Ebrahimi     // This is a layout used to "pad" a pipeline layout to fill in any gaps to the selected bind index.
330*b7893ccfSSadaf Ebrahimi     VkResult result2 =
331*b7893ccfSSadaf Ebrahimi         DispatchCreateDescriptorSetLayout(device, &dummy_desc_layout_info, NULL, &gpu_validation_state->dummy_desc_layout);
332*b7893ccfSSadaf Ebrahimi     assert((result == VK_SUCCESS) && (result2 == VK_SUCCESS));
333*b7893ccfSSadaf Ebrahimi     if ((result != VK_SUCCESS) || (result2 != VK_SUCCESS)) {
334*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
335*b7893ccfSSadaf Ebrahimi                            "Unable to create descriptor set layout.  GPU-Assisted Validation disabled.");
336*b7893ccfSSadaf Ebrahimi         if (result == VK_SUCCESS) {
337*b7893ccfSSadaf Ebrahimi             DispatchDestroyDescriptorSetLayout(device, gpu_validation_state->debug_desc_layout, NULL);
338*b7893ccfSSadaf Ebrahimi         }
339*b7893ccfSSadaf Ebrahimi         if (result2 == VK_SUCCESS) {
340*b7893ccfSSadaf Ebrahimi             DispatchDestroyDescriptorSetLayout(device, gpu_validation_state->dummy_desc_layout, NULL);
341*b7893ccfSSadaf Ebrahimi         }
342*b7893ccfSSadaf Ebrahimi         gpu_validation_state->debug_desc_layout = VK_NULL_HANDLE;
343*b7893ccfSSadaf Ebrahimi         gpu_validation_state->dummy_desc_layout = VK_NULL_HANDLE;
344*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
345*b7893ccfSSadaf Ebrahimi         return;
346*b7893ccfSSadaf Ebrahimi     }
347*b7893ccfSSadaf Ebrahimi     gpu_validation_state->desc_set_manager = std::move(desc_set_manager);
348*b7893ccfSSadaf Ebrahimi }
349*b7893ccfSSadaf Ebrahimi 
350*b7893ccfSSadaf Ebrahimi // Clean up device-related resources
GpuPreCallRecordDestroyDevice()351*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPreCallRecordDestroyDevice() {
352*b7893ccfSSadaf Ebrahimi     for (auto &queue_barrier_command_info_kv : gpu_validation_state->queue_barrier_command_infos) {
353*b7893ccfSSadaf Ebrahimi         GpuQueueBarrierCommandInfo &queue_barrier_command_info = queue_barrier_command_info_kv.second;
354*b7893ccfSSadaf Ebrahimi 
355*b7893ccfSSadaf Ebrahimi         DispatchFreeCommandBuffers(device, queue_barrier_command_info.barrier_command_pool, 1,
356*b7893ccfSSadaf Ebrahimi                                    &queue_barrier_command_info.barrier_command_buffer);
357*b7893ccfSSadaf Ebrahimi         queue_barrier_command_info.barrier_command_buffer = VK_NULL_HANDLE;
358*b7893ccfSSadaf Ebrahimi 
359*b7893ccfSSadaf Ebrahimi         DispatchDestroyCommandPool(device, queue_barrier_command_info.barrier_command_pool, NULL);
360*b7893ccfSSadaf Ebrahimi         queue_barrier_command_info.barrier_command_pool = VK_NULL_HANDLE;
361*b7893ccfSSadaf Ebrahimi     }
362*b7893ccfSSadaf Ebrahimi     gpu_validation_state->queue_barrier_command_infos.clear();
363*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->debug_desc_layout) {
364*b7893ccfSSadaf Ebrahimi         DispatchDestroyDescriptorSetLayout(device, gpu_validation_state->debug_desc_layout, NULL);
365*b7893ccfSSadaf Ebrahimi         gpu_validation_state->debug_desc_layout = VK_NULL_HANDLE;
366*b7893ccfSSadaf Ebrahimi     }
367*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->dummy_desc_layout) {
368*b7893ccfSSadaf Ebrahimi         DispatchDestroyDescriptorSetLayout(device, gpu_validation_state->dummy_desc_layout, NULL);
369*b7893ccfSSadaf Ebrahimi         gpu_validation_state->dummy_desc_layout = VK_NULL_HANDLE;
370*b7893ccfSSadaf Ebrahimi     }
371*b7893ccfSSadaf Ebrahimi     gpu_validation_state->desc_set_manager.reset();
372*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->vmaAllocator) {
373*b7893ccfSSadaf Ebrahimi         vmaDestroyAllocator(gpu_validation_state->vmaAllocator);
374*b7893ccfSSadaf Ebrahimi     }
375*b7893ccfSSadaf Ebrahimi }
376*b7893ccfSSadaf Ebrahimi 
377*b7893ccfSSadaf Ebrahimi // Modify the pipeline layout to include our debug descriptor set and any needed padding with the dummy descriptor set.
GpuPreCallCreatePipelineLayout(const VkPipelineLayoutCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkPipelineLayout * pPipelineLayout,std::vector<VkDescriptorSetLayout> * new_layouts,VkPipelineLayoutCreateInfo * modified_create_info)378*b7893ccfSSadaf Ebrahimi bool CoreChecks::GpuPreCallCreatePipelineLayout(const VkPipelineLayoutCreateInfo *pCreateInfo,
379*b7893ccfSSadaf Ebrahimi                                                 const VkAllocationCallbacks *pAllocator, VkPipelineLayout *pPipelineLayout,
380*b7893ccfSSadaf Ebrahimi                                                 std::vector<VkDescriptorSetLayout> *new_layouts,
381*b7893ccfSSadaf Ebrahimi                                                 VkPipelineLayoutCreateInfo *modified_create_info) {
382*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->aborted) {
383*b7893ccfSSadaf Ebrahimi         return false;
384*b7893ccfSSadaf Ebrahimi     }
385*b7893ccfSSadaf Ebrahimi 
386*b7893ccfSSadaf Ebrahimi     if (modified_create_info->setLayoutCount >= gpu_validation_state->adjusted_max_desc_sets) {
387*b7893ccfSSadaf Ebrahimi         std::ostringstream strm;
388*b7893ccfSSadaf Ebrahimi         strm << "Pipeline Layout conflict with validation's descriptor set at slot " << gpu_validation_state->desc_set_bind_index
389*b7893ccfSSadaf Ebrahimi              << ". "
390*b7893ccfSSadaf Ebrahimi              << "Application has too many descriptor sets in the pipeline layout to continue with gpu validation. "
391*b7893ccfSSadaf Ebrahimi              << "Validation is not modifying the pipeline layout. "
392*b7893ccfSSadaf Ebrahimi              << "Instrumented shaders are replaced with non-instrumented shaders.";
393*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device), strm.str().c_str());
394*b7893ccfSSadaf Ebrahimi     } else {
395*b7893ccfSSadaf Ebrahimi         // Modify the pipeline layout by:
396*b7893ccfSSadaf Ebrahimi         // 1. Copying the caller's descriptor set desc_layouts
397*b7893ccfSSadaf Ebrahimi         // 2. Fill in dummy descriptor layouts up to the max binding
398*b7893ccfSSadaf Ebrahimi         // 3. Fill in with the debug descriptor layout at the max binding slot
399*b7893ccfSSadaf Ebrahimi         new_layouts->reserve(gpu_validation_state->adjusted_max_desc_sets);
400*b7893ccfSSadaf Ebrahimi         new_layouts->insert(new_layouts->end(), &pCreateInfo->pSetLayouts[0],
401*b7893ccfSSadaf Ebrahimi                             &pCreateInfo->pSetLayouts[pCreateInfo->setLayoutCount]);
402*b7893ccfSSadaf Ebrahimi         for (uint32_t i = pCreateInfo->setLayoutCount; i < gpu_validation_state->adjusted_max_desc_sets - 1; ++i) {
403*b7893ccfSSadaf Ebrahimi             new_layouts->push_back(gpu_validation_state->dummy_desc_layout);
404*b7893ccfSSadaf Ebrahimi         }
405*b7893ccfSSadaf Ebrahimi         new_layouts->push_back(gpu_validation_state->debug_desc_layout);
406*b7893ccfSSadaf Ebrahimi         modified_create_info->pSetLayouts = new_layouts->data();
407*b7893ccfSSadaf Ebrahimi         modified_create_info->setLayoutCount = gpu_validation_state->adjusted_max_desc_sets;
408*b7893ccfSSadaf Ebrahimi     }
409*b7893ccfSSadaf Ebrahimi     return true;
410*b7893ccfSSadaf Ebrahimi }
411*b7893ccfSSadaf Ebrahimi 
412*b7893ccfSSadaf Ebrahimi // Clean up GPU validation after the CreatePipelineLayout call is made
GpuPostCallCreatePipelineLayout(VkResult result)413*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallCreatePipelineLayout(VkResult result) {
414*b7893ccfSSadaf Ebrahimi     // Clean up GPU validation
415*b7893ccfSSadaf Ebrahimi     if (result != VK_SUCCESS) {
416*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
417*b7893ccfSSadaf Ebrahimi                            "Unable to create pipeline layout.  Device could become unstable.");
418*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
419*b7893ccfSSadaf Ebrahimi     }
420*b7893ccfSSadaf Ebrahimi }
421*b7893ccfSSadaf Ebrahimi 
422*b7893ccfSSadaf Ebrahimi // Free the device memory and descriptor set associated with a command buffer.
GpuResetCommandBuffer(const VkCommandBuffer commandBuffer)423*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuResetCommandBuffer(const VkCommandBuffer commandBuffer) {
424*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->aborted) {
425*b7893ccfSSadaf Ebrahimi         return;
426*b7893ccfSSadaf Ebrahimi     }
427*b7893ccfSSadaf Ebrahimi     auto gpu_buffer_list = gpu_validation_state->GetGpuBufferInfo(commandBuffer);
428*b7893ccfSSadaf Ebrahimi     for (auto buffer_info : gpu_buffer_list) {
429*b7893ccfSSadaf Ebrahimi         vmaDestroyBuffer(gpu_validation_state->vmaAllocator, buffer_info.output_mem_block.buffer,
430*b7893ccfSSadaf Ebrahimi                          buffer_info.output_mem_block.allocation);
431*b7893ccfSSadaf Ebrahimi         if (buffer_info.input_mem_block.buffer) {
432*b7893ccfSSadaf Ebrahimi             vmaDestroyBuffer(gpu_validation_state->vmaAllocator, buffer_info.input_mem_block.buffer,
433*b7893ccfSSadaf Ebrahimi                              buffer_info.input_mem_block.allocation);
434*b7893ccfSSadaf Ebrahimi         }
435*b7893ccfSSadaf Ebrahimi         if (buffer_info.desc_set != VK_NULL_HANDLE) {
436*b7893ccfSSadaf Ebrahimi             gpu_validation_state->desc_set_manager->PutBackDescriptorSet(buffer_info.desc_pool, buffer_info.desc_set);
437*b7893ccfSSadaf Ebrahimi         }
438*b7893ccfSSadaf Ebrahimi     }
439*b7893ccfSSadaf Ebrahimi     gpu_validation_state->command_buffer_map.erase(commandBuffer);
440*b7893ccfSSadaf Ebrahimi }
441*b7893ccfSSadaf Ebrahimi 
442*b7893ccfSSadaf Ebrahimi // Just gives a warning about a possible deadlock.
GpuPreCallValidateCmdWaitEvents(VkPipelineStageFlags sourceStageMask)443*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPreCallValidateCmdWaitEvents(VkPipelineStageFlags sourceStageMask) {
444*b7893ccfSSadaf Ebrahimi     if (sourceStageMask & VK_PIPELINE_STAGE_HOST_BIT) {
445*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
446*b7893ccfSSadaf Ebrahimi                            "CmdWaitEvents recorded with VK_PIPELINE_STAGE_HOST_BIT set. "
447*b7893ccfSSadaf Ebrahimi                            "GPU_Assisted validation waits on queue completion. "
448*b7893ccfSSadaf Ebrahimi                            "This wait could block the host's signaling of this event, resulting in deadlock.");
449*b7893ccfSSadaf Ebrahimi     }
450*b7893ccfSSadaf Ebrahimi }
451*b7893ccfSSadaf Ebrahimi 
GpuPreCallRecordCreateGraphicsPipelines(VkPipelineCache pipelineCache,uint32_t count,const VkGraphicsPipelineCreateInfo * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines,std::vector<std::unique_ptr<PIPELINE_STATE>> & pipe_state)452*b7893ccfSSadaf Ebrahimi std::vector<safe_VkGraphicsPipelineCreateInfo> CoreChecks::GpuPreCallRecordCreateGraphicsPipelines(
453*b7893ccfSSadaf Ebrahimi     VkPipelineCache pipelineCache, uint32_t count, const VkGraphicsPipelineCreateInfo *pCreateInfos,
454*b7893ccfSSadaf Ebrahimi     const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines, std::vector<std::unique_ptr<PIPELINE_STATE>> &pipe_state) {
455*b7893ccfSSadaf Ebrahimi     std::vector<safe_VkGraphicsPipelineCreateInfo> new_pipeline_create_infos;
456*b7893ccfSSadaf Ebrahimi     GpuPreCallRecordPipelineCreations(count, pCreateInfos, pAllocator, pPipelines, pipe_state, &new_pipeline_create_infos,
457*b7893ccfSSadaf Ebrahimi                                       VK_PIPELINE_BIND_POINT_GRAPHICS);
458*b7893ccfSSadaf Ebrahimi     return new_pipeline_create_infos;
459*b7893ccfSSadaf Ebrahimi }
GpuPreCallRecordCreateComputePipelines(VkPipelineCache pipelineCache,uint32_t count,const VkComputePipelineCreateInfo * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines,std::vector<std::unique_ptr<PIPELINE_STATE>> & pipe_state)460*b7893ccfSSadaf Ebrahimi std::vector<safe_VkComputePipelineCreateInfo> CoreChecks::GpuPreCallRecordCreateComputePipelines(
461*b7893ccfSSadaf Ebrahimi     VkPipelineCache pipelineCache, uint32_t count, const VkComputePipelineCreateInfo *pCreateInfos,
462*b7893ccfSSadaf Ebrahimi     const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines, std::vector<std::unique_ptr<PIPELINE_STATE>> &pipe_state) {
463*b7893ccfSSadaf Ebrahimi     std::vector<safe_VkComputePipelineCreateInfo> new_pipeline_create_infos;
464*b7893ccfSSadaf Ebrahimi     GpuPreCallRecordPipelineCreations(count, pCreateInfos, pAllocator, pPipelines, pipe_state, &new_pipeline_create_infos,
465*b7893ccfSSadaf Ebrahimi                                       VK_PIPELINE_BIND_POINT_COMPUTE);
466*b7893ccfSSadaf Ebrahimi     return new_pipeline_create_infos;
467*b7893ccfSSadaf Ebrahimi }
GpuPreCallRecordCreateRayTracingPipelinesNV(VkPipelineCache pipelineCache,uint32_t count,const VkRayTracingPipelineCreateInfoNV * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines,std::vector<std::unique_ptr<PIPELINE_STATE>> & pipe_state)468*b7893ccfSSadaf Ebrahimi std::vector<safe_VkRayTracingPipelineCreateInfoNV> CoreChecks::GpuPreCallRecordCreateRayTracingPipelinesNV(
469*b7893ccfSSadaf Ebrahimi     VkPipelineCache pipelineCache, uint32_t count, const VkRayTracingPipelineCreateInfoNV *pCreateInfos,
470*b7893ccfSSadaf Ebrahimi     const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines, std::vector<std::unique_ptr<PIPELINE_STATE>> &pipe_state) {
471*b7893ccfSSadaf Ebrahimi     std::vector<safe_VkRayTracingPipelineCreateInfoNV> new_pipeline_create_infos;
472*b7893ccfSSadaf Ebrahimi     GpuPreCallRecordPipelineCreations(count, pCreateInfos, pAllocator, pPipelines, pipe_state, &new_pipeline_create_infos,
473*b7893ccfSSadaf Ebrahimi                                       VK_PIPELINE_BIND_POINT_RAY_TRACING_NV);
474*b7893ccfSSadaf Ebrahimi     return new_pipeline_create_infos;
475*b7893ccfSSadaf Ebrahimi }
476*b7893ccfSSadaf Ebrahimi template <typename CreateInfo>
477*b7893ccfSSadaf Ebrahimi struct CreatePipelineTraits {};
478*b7893ccfSSadaf Ebrahimi template <>
479*b7893ccfSSadaf Ebrahimi struct CreatePipelineTraits<VkGraphicsPipelineCreateInfo> {
480*b7893ccfSSadaf Ebrahimi     using SafeType = safe_VkGraphicsPipelineCreateInfo;
GetPipelineCICreatePipelineTraits481*b7893ccfSSadaf Ebrahimi     static const SafeType &GetPipelineCI(const PIPELINE_STATE *pipeline_state) { return pipeline_state->graphicsPipelineCI; }
GetStageCountCreatePipelineTraits482*b7893ccfSSadaf Ebrahimi     static uint32_t GetStageCount(const VkGraphicsPipelineCreateInfo &createInfo) { return createInfo.stageCount; }
GetShaderModuleCreatePipelineTraits483*b7893ccfSSadaf Ebrahimi     static VkShaderModule GetShaderModule(const VkGraphicsPipelineCreateInfo &createInfo, uint32_t stage) {
484*b7893ccfSSadaf Ebrahimi         return createInfo.pStages[stage].module;
485*b7893ccfSSadaf Ebrahimi     }
SetShaderModuleCreatePipelineTraits486*b7893ccfSSadaf Ebrahimi     static void SetShaderModule(SafeType *createInfo, VkShaderModule shader_module, uint32_t stage) {
487*b7893ccfSSadaf Ebrahimi         createInfo->pStages[stage].module = shader_module;
488*b7893ccfSSadaf Ebrahimi     }
489*b7893ccfSSadaf Ebrahimi };
490*b7893ccfSSadaf Ebrahimi 
491*b7893ccfSSadaf Ebrahimi template <>
492*b7893ccfSSadaf Ebrahimi struct CreatePipelineTraits<VkComputePipelineCreateInfo> {
493*b7893ccfSSadaf Ebrahimi     using SafeType = safe_VkComputePipelineCreateInfo;
GetPipelineCICreatePipelineTraits494*b7893ccfSSadaf Ebrahimi     static const SafeType &GetPipelineCI(const PIPELINE_STATE *pipeline_state) { return pipeline_state->computePipelineCI; }
GetStageCountCreatePipelineTraits495*b7893ccfSSadaf Ebrahimi     static uint32_t GetStageCount(const VkComputePipelineCreateInfo &createInfo) { return 1; }
GetShaderModuleCreatePipelineTraits496*b7893ccfSSadaf Ebrahimi     static VkShaderModule GetShaderModule(const VkComputePipelineCreateInfo &createInfo, uint32_t stage) {
497*b7893ccfSSadaf Ebrahimi         return createInfo.stage.module;
498*b7893ccfSSadaf Ebrahimi     }
SetShaderModuleCreatePipelineTraits499*b7893ccfSSadaf Ebrahimi     static void SetShaderModule(SafeType *createInfo, VkShaderModule shader_module, uint32_t stage) {
500*b7893ccfSSadaf Ebrahimi         assert(stage == 0);
501*b7893ccfSSadaf Ebrahimi         createInfo->stage.module = shader_module;
502*b7893ccfSSadaf Ebrahimi     }
503*b7893ccfSSadaf Ebrahimi };
504*b7893ccfSSadaf Ebrahimi template <>
505*b7893ccfSSadaf Ebrahimi struct CreatePipelineTraits<VkRayTracingPipelineCreateInfoNV> {
506*b7893ccfSSadaf Ebrahimi     using SafeType = safe_VkRayTracingPipelineCreateInfoNV;
GetPipelineCICreatePipelineTraits507*b7893ccfSSadaf Ebrahimi     static const SafeType &GetPipelineCI(const PIPELINE_STATE *pipeline_state) { return pipeline_state->raytracingPipelineCI; }
GetStageCountCreatePipelineTraits508*b7893ccfSSadaf Ebrahimi     static uint32_t GetStageCount(const VkRayTracingPipelineCreateInfoNV &createInfo) { return createInfo.stageCount; }
GetShaderModuleCreatePipelineTraits509*b7893ccfSSadaf Ebrahimi     static VkShaderModule GetShaderModule(const VkRayTracingPipelineCreateInfoNV &createInfo, uint32_t stage) {
510*b7893ccfSSadaf Ebrahimi         return createInfo.pStages[stage].module;
511*b7893ccfSSadaf Ebrahimi     }
SetShaderModuleCreatePipelineTraits512*b7893ccfSSadaf Ebrahimi     static void SetShaderModule(SafeType *createInfo, VkShaderModule shader_module, uint32_t stage) {
513*b7893ccfSSadaf Ebrahimi         createInfo->pStages[stage].module = shader_module;
514*b7893ccfSSadaf Ebrahimi     }
515*b7893ccfSSadaf Ebrahimi };
516*b7893ccfSSadaf Ebrahimi 
517*b7893ccfSSadaf Ebrahimi // Examine the pipelines to see if they use the debug descriptor set binding index.
518*b7893ccfSSadaf Ebrahimi // If any do, create new non-instrumented shader modules and use them to replace the instrumented
519*b7893ccfSSadaf Ebrahimi // shaders in the pipeline.  Return the (possibly) modified create infos to the caller.
520*b7893ccfSSadaf Ebrahimi template <typename CreateInfo, typename SafeCreateInfo>
GpuPreCallRecordPipelineCreations(uint32_t count,const CreateInfo * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines,std::vector<std::unique_ptr<PIPELINE_STATE>> & pipe_state,std::vector<SafeCreateInfo> * new_pipeline_create_infos,const VkPipelineBindPoint bind_point)521*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPreCallRecordPipelineCreations(uint32_t count, const CreateInfo *pCreateInfos,
522*b7893ccfSSadaf Ebrahimi                                                    const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines,
523*b7893ccfSSadaf Ebrahimi                                                    std::vector<std::unique_ptr<PIPELINE_STATE>> &pipe_state,
524*b7893ccfSSadaf Ebrahimi                                                    std::vector<SafeCreateInfo> *new_pipeline_create_infos,
525*b7893ccfSSadaf Ebrahimi                                                    const VkPipelineBindPoint bind_point) {
526*b7893ccfSSadaf Ebrahimi     using Accessor = CreatePipelineTraits<CreateInfo>;
527*b7893ccfSSadaf Ebrahimi     if (bind_point != VK_PIPELINE_BIND_POINT_GRAPHICS && bind_point != VK_PIPELINE_BIND_POINT_COMPUTE &&
528*b7893ccfSSadaf Ebrahimi         bind_point != VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
529*b7893ccfSSadaf Ebrahimi         return;
530*b7893ccfSSadaf Ebrahimi     }
531*b7893ccfSSadaf Ebrahimi 
532*b7893ccfSSadaf Ebrahimi     // Walk through all the pipelines, make a copy of each and flag each pipeline that contains a shader that uses the debug
533*b7893ccfSSadaf Ebrahimi     // descriptor set index.
534*b7893ccfSSadaf Ebrahimi     for (uint32_t pipeline = 0; pipeline < count; ++pipeline) {
535*b7893ccfSSadaf Ebrahimi         uint32_t stageCount = Accessor::GetStageCount(pCreateInfos[pipeline]);
536*b7893ccfSSadaf Ebrahimi         new_pipeline_create_infos->push_back(Accessor::GetPipelineCI(pipe_state[pipeline].get()));
537*b7893ccfSSadaf Ebrahimi 
538*b7893ccfSSadaf Ebrahimi         bool replace_shaders = false;
539*b7893ccfSSadaf Ebrahimi         if (pipe_state[pipeline]->active_slots.find(gpu_validation_state->desc_set_bind_index) !=
540*b7893ccfSSadaf Ebrahimi             pipe_state[pipeline]->active_slots.end()) {
541*b7893ccfSSadaf Ebrahimi             replace_shaders = true;
542*b7893ccfSSadaf Ebrahimi         }
543*b7893ccfSSadaf Ebrahimi         // If the app requests all available sets, the pipeline layout was not modified at pipeline layout creation and the already
544*b7893ccfSSadaf Ebrahimi         // instrumented shaders need to be replaced with uninstrumented shaders
545*b7893ccfSSadaf Ebrahimi         if (pipe_state[pipeline]->pipeline_layout.set_layouts.size() >= gpu_validation_state->adjusted_max_desc_sets) {
546*b7893ccfSSadaf Ebrahimi             replace_shaders = true;
547*b7893ccfSSadaf Ebrahimi         }
548*b7893ccfSSadaf Ebrahimi 
549*b7893ccfSSadaf Ebrahimi         if (replace_shaders) {
550*b7893ccfSSadaf Ebrahimi             for (uint32_t stage = 0; stage < stageCount; ++stage) {
551*b7893ccfSSadaf Ebrahimi                 const SHADER_MODULE_STATE *shader = GetShaderModuleState(Accessor::GetShaderModule(pCreateInfos[pipeline], stage));
552*b7893ccfSSadaf Ebrahimi 
553*b7893ccfSSadaf Ebrahimi                 VkShaderModuleCreateInfo create_info = {};
554*b7893ccfSSadaf Ebrahimi                 VkShaderModule shader_module;
555*b7893ccfSSadaf Ebrahimi                 create_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
556*b7893ccfSSadaf Ebrahimi                 create_info.pCode = shader->words.data();
557*b7893ccfSSadaf Ebrahimi                 create_info.codeSize = shader->words.size() * sizeof(uint32_t);
558*b7893ccfSSadaf Ebrahimi                 VkResult result = DispatchCreateShaderModule(device, &create_info, pAllocator, &shader_module);
559*b7893ccfSSadaf Ebrahimi                 if (result == VK_SUCCESS) {
560*b7893ccfSSadaf Ebrahimi                     Accessor::SetShaderModule(new_pipeline_create_infos[pipeline].data(), shader_module, stage);
561*b7893ccfSSadaf Ebrahimi                 } else {
562*b7893ccfSSadaf Ebrahimi                     uint64_t moduleHandle = HandleToUint64(Accessor::GetShaderModule(pCreateInfos[pipeline], stage));
563*b7893ccfSSadaf Ebrahimi                     ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT, moduleHandle,
564*b7893ccfSSadaf Ebrahimi                                        "Unable to replace instrumented shader with non-instrumented one.  "
565*b7893ccfSSadaf Ebrahimi                                        "Device could become unstable.");
566*b7893ccfSSadaf Ebrahimi                 }
567*b7893ccfSSadaf Ebrahimi             }
568*b7893ccfSSadaf Ebrahimi         }
569*b7893ccfSSadaf Ebrahimi     }
570*b7893ccfSSadaf Ebrahimi }
571*b7893ccfSSadaf Ebrahimi 
GpuPostCallRecordCreateGraphicsPipelines(const uint32_t count,const VkGraphicsPipelineCreateInfo * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines)572*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallRecordCreateGraphicsPipelines(const uint32_t count, const VkGraphicsPipelineCreateInfo *pCreateInfos,
573*b7893ccfSSadaf Ebrahimi                                                           const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines) {
574*b7893ccfSSadaf Ebrahimi     GpuPostCallRecordPipelineCreations(count, pCreateInfos, pAllocator, pPipelines, VK_PIPELINE_BIND_POINT_GRAPHICS);
575*b7893ccfSSadaf Ebrahimi }
GpuPostCallRecordCreateComputePipelines(const uint32_t count,const VkComputePipelineCreateInfo * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines)576*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallRecordCreateComputePipelines(const uint32_t count, const VkComputePipelineCreateInfo *pCreateInfos,
577*b7893ccfSSadaf Ebrahimi                                                          const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines) {
578*b7893ccfSSadaf Ebrahimi     GpuPostCallRecordPipelineCreations(count, pCreateInfos, pAllocator, pPipelines, VK_PIPELINE_BIND_POINT_COMPUTE);
579*b7893ccfSSadaf Ebrahimi }
GpuPostCallRecordCreateRayTracingPipelinesNV(const uint32_t count,const VkRayTracingPipelineCreateInfoNV * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines)580*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallRecordCreateRayTracingPipelinesNV(const uint32_t count,
581*b7893ccfSSadaf Ebrahimi                                                               const VkRayTracingPipelineCreateInfoNV *pCreateInfos,
582*b7893ccfSSadaf Ebrahimi                                                               const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines) {
583*b7893ccfSSadaf Ebrahimi     GpuPostCallRecordPipelineCreations(count, pCreateInfos, pAllocator, pPipelines, VK_PIPELINE_BIND_POINT_RAY_TRACING_NV);
584*b7893ccfSSadaf Ebrahimi }
585*b7893ccfSSadaf Ebrahimi 
586*b7893ccfSSadaf Ebrahimi // For every pipeline:
587*b7893ccfSSadaf Ebrahimi // - For every shader in a pipeline:
588*b7893ccfSSadaf Ebrahimi //   - If the shader had to be replaced in PreCallRecord (because the pipeline is using the debug desc set index):
589*b7893ccfSSadaf Ebrahimi //     - Destroy it since it has been bound into the pipeline by now.  This is our only chance to delete it.
590*b7893ccfSSadaf Ebrahimi //   - Track the shader in the shader_map
591*b7893ccfSSadaf Ebrahimi //   - Save the shader binary if it contains debug code
592*b7893ccfSSadaf Ebrahimi template <typename CreateInfo>
GpuPostCallRecordPipelineCreations(const uint32_t count,const CreateInfo * pCreateInfos,const VkAllocationCallbacks * pAllocator,VkPipeline * pPipelines,const VkPipelineBindPoint bind_point)593*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallRecordPipelineCreations(const uint32_t count, const CreateInfo *pCreateInfos,
594*b7893ccfSSadaf Ebrahimi                                                     const VkAllocationCallbacks *pAllocator, VkPipeline *pPipelines,
595*b7893ccfSSadaf Ebrahimi                                                     const VkPipelineBindPoint bind_point) {
596*b7893ccfSSadaf Ebrahimi     using Accessor = CreatePipelineTraits<CreateInfo>;
597*b7893ccfSSadaf Ebrahimi     if (bind_point != VK_PIPELINE_BIND_POINT_GRAPHICS && bind_point != VK_PIPELINE_BIND_POINT_COMPUTE &&
598*b7893ccfSSadaf Ebrahimi         bind_point != VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
599*b7893ccfSSadaf Ebrahimi         return;
600*b7893ccfSSadaf Ebrahimi     }
601*b7893ccfSSadaf Ebrahimi     for (uint32_t pipeline = 0; pipeline < count; ++pipeline) {
602*b7893ccfSSadaf Ebrahimi         auto pipeline_state = ValidationStateTracker::GetPipelineState(pPipelines[pipeline]);
603*b7893ccfSSadaf Ebrahimi         if (nullptr == pipeline_state) continue;
604*b7893ccfSSadaf Ebrahimi 
605*b7893ccfSSadaf Ebrahimi         uint32_t stageCount = 0;
606*b7893ccfSSadaf Ebrahimi         if (bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
607*b7893ccfSSadaf Ebrahimi             stageCount = pipeline_state->graphicsPipelineCI.stageCount;
608*b7893ccfSSadaf Ebrahimi         } else if (bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
609*b7893ccfSSadaf Ebrahimi             stageCount = 1;
610*b7893ccfSSadaf Ebrahimi         } else if (bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
611*b7893ccfSSadaf Ebrahimi             stageCount = pipeline_state->raytracingPipelineCI.stageCount;
612*b7893ccfSSadaf Ebrahimi         } else {
613*b7893ccfSSadaf Ebrahimi             assert(false);
614*b7893ccfSSadaf Ebrahimi         }
615*b7893ccfSSadaf Ebrahimi 
616*b7893ccfSSadaf Ebrahimi         for (uint32_t stage = 0; stage < stageCount; ++stage) {
617*b7893ccfSSadaf Ebrahimi             if (pipeline_state->active_slots.find(gpu_validation_state->desc_set_bind_index) !=
618*b7893ccfSSadaf Ebrahimi                 pipeline_state->active_slots.end()) {
619*b7893ccfSSadaf Ebrahimi                 DispatchDestroyShaderModule(device, Accessor::GetShaderModule(pCreateInfos[pipeline], stage), pAllocator);
620*b7893ccfSSadaf Ebrahimi             }
621*b7893ccfSSadaf Ebrahimi 
622*b7893ccfSSadaf Ebrahimi             const SHADER_MODULE_STATE *shader_state = nullptr;
623*b7893ccfSSadaf Ebrahimi             if (bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
624*b7893ccfSSadaf Ebrahimi                 shader_state = GetShaderModuleState(pipeline_state->graphicsPipelineCI.pStages[stage].module);
625*b7893ccfSSadaf Ebrahimi             } else if (bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
626*b7893ccfSSadaf Ebrahimi                 assert(stage == 0);
627*b7893ccfSSadaf Ebrahimi                 shader_state = GetShaderModuleState(pipeline_state->computePipelineCI.stage.module);
628*b7893ccfSSadaf Ebrahimi             } else if (bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
629*b7893ccfSSadaf Ebrahimi                 shader_state = GetShaderModuleState(pipeline_state->raytracingPipelineCI.pStages[stage].module);
630*b7893ccfSSadaf Ebrahimi             } else {
631*b7893ccfSSadaf Ebrahimi                 assert(false);
632*b7893ccfSSadaf Ebrahimi             }
633*b7893ccfSSadaf Ebrahimi 
634*b7893ccfSSadaf Ebrahimi             std::vector<unsigned int> code;
635*b7893ccfSSadaf Ebrahimi             // Save the shader binary if debug info is present.
636*b7893ccfSSadaf Ebrahimi             // The core_validation ShaderModule tracker saves the binary too, but discards it when the ShaderModule
637*b7893ccfSSadaf Ebrahimi             // is destroyed.  Applications may destroy ShaderModules after they are placed in a pipeline and before
638*b7893ccfSSadaf Ebrahimi             // the pipeline is used, so we have to keep another copy.
639*b7893ccfSSadaf Ebrahimi             if (shader_state && shader_state->has_valid_spirv) {  // really checking for presense of SPIR-V code.
640*b7893ccfSSadaf Ebrahimi                 for (auto insn : *shader_state) {
641*b7893ccfSSadaf Ebrahimi                     if (insn.opcode() == spv::OpLine) {
642*b7893ccfSSadaf Ebrahimi                         code = shader_state->words;
643*b7893ccfSSadaf Ebrahimi                         break;
644*b7893ccfSSadaf Ebrahimi                     }
645*b7893ccfSSadaf Ebrahimi                 }
646*b7893ccfSSadaf Ebrahimi             }
647*b7893ccfSSadaf Ebrahimi             gpu_validation_state->shader_map[shader_state->gpu_validation_shader_id].pipeline = pipeline_state->pipeline;
648*b7893ccfSSadaf Ebrahimi             // Be careful to use the originally bound (instrumented) shader here, even if PreCallRecord had to back it
649*b7893ccfSSadaf Ebrahimi             // out with a non-instrumented shader.  The non-instrumented shader (found in pCreateInfo) was destroyed above.
650*b7893ccfSSadaf Ebrahimi             VkShaderModule shader_module = VK_NULL_HANDLE;
651*b7893ccfSSadaf Ebrahimi             if (bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
652*b7893ccfSSadaf Ebrahimi                 shader_module = pipeline_state->graphicsPipelineCI.pStages[stage].module;
653*b7893ccfSSadaf Ebrahimi             } else if (bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
654*b7893ccfSSadaf Ebrahimi                 assert(stage == 0);
655*b7893ccfSSadaf Ebrahimi                 shader_module = pipeline_state->computePipelineCI.stage.module;
656*b7893ccfSSadaf Ebrahimi             } else if (bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
657*b7893ccfSSadaf Ebrahimi                 shader_module = pipeline_state->raytracingPipelineCI.pStages[stage].module;
658*b7893ccfSSadaf Ebrahimi             } else {
659*b7893ccfSSadaf Ebrahimi                 assert(false);
660*b7893ccfSSadaf Ebrahimi             }
661*b7893ccfSSadaf Ebrahimi             gpu_validation_state->shader_map[shader_state->gpu_validation_shader_id].shader_module = shader_module;
662*b7893ccfSSadaf Ebrahimi             gpu_validation_state->shader_map[shader_state->gpu_validation_shader_id].pgm = std::move(code);
663*b7893ccfSSadaf Ebrahimi         }
664*b7893ccfSSadaf Ebrahimi     }
665*b7893ccfSSadaf Ebrahimi }
666*b7893ccfSSadaf Ebrahimi 
667*b7893ccfSSadaf Ebrahimi // Remove all the shader trackers associated with this destroyed pipeline.
GpuPreCallRecordDestroyPipeline(const VkPipeline pipeline)668*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPreCallRecordDestroyPipeline(const VkPipeline pipeline) {
669*b7893ccfSSadaf Ebrahimi     for (auto it = gpu_validation_state->shader_map.begin(); it != gpu_validation_state->shader_map.end();) {
670*b7893ccfSSadaf Ebrahimi         if (it->second.pipeline == pipeline) {
671*b7893ccfSSadaf Ebrahimi             it = gpu_validation_state->shader_map.erase(it);
672*b7893ccfSSadaf Ebrahimi         } else {
673*b7893ccfSSadaf Ebrahimi             ++it;
674*b7893ccfSSadaf Ebrahimi         }
675*b7893ccfSSadaf Ebrahimi     }
676*b7893ccfSSadaf Ebrahimi }
677*b7893ccfSSadaf Ebrahimi 
678*b7893ccfSSadaf Ebrahimi // Call the SPIR-V Optimizer to run the instrumentation pass on the shader.
GpuInstrumentShader(const VkShaderModuleCreateInfo * pCreateInfo,std::vector<unsigned int> & new_pgm,uint32_t * unique_shader_id)679*b7893ccfSSadaf Ebrahimi bool CoreChecks::GpuInstrumentShader(const VkShaderModuleCreateInfo *pCreateInfo, std::vector<unsigned int> &new_pgm,
680*b7893ccfSSadaf Ebrahimi                                      uint32_t *unique_shader_id) {
681*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->aborted) return false;
682*b7893ccfSSadaf Ebrahimi     if (pCreateInfo->pCode[0] != spv::MagicNumber) return false;
683*b7893ccfSSadaf Ebrahimi 
684*b7893ccfSSadaf Ebrahimi     // Load original shader SPIR-V
685*b7893ccfSSadaf Ebrahimi     uint32_t num_words = static_cast<uint32_t>(pCreateInfo->codeSize / 4);
686*b7893ccfSSadaf Ebrahimi     new_pgm.clear();
687*b7893ccfSSadaf Ebrahimi     new_pgm.reserve(num_words);
688*b7893ccfSSadaf Ebrahimi     new_pgm.insert(new_pgm.end(), &pCreateInfo->pCode[0], &pCreateInfo->pCode[num_words]);
689*b7893ccfSSadaf Ebrahimi 
690*b7893ccfSSadaf Ebrahimi     // Call the optimizer to instrument the shader.
691*b7893ccfSSadaf Ebrahimi     // Use the unique_shader_module_id as a shader ID so we can look up its handle later in the shader_map.
692*b7893ccfSSadaf Ebrahimi     // If descriptor indexing is enabled, enable length checks and updated descriptor checks
693*b7893ccfSSadaf Ebrahimi     const bool descriptor_indexing = device_extensions.vk_ext_descriptor_indexing;
694*b7893ccfSSadaf Ebrahimi     using namespace spvtools;
695*b7893ccfSSadaf Ebrahimi     spv_target_env target_env = SPV_ENV_VULKAN_1_1;
696*b7893ccfSSadaf Ebrahimi     Optimizer optimizer(target_env);
697*b7893ccfSSadaf Ebrahimi     optimizer.RegisterPass(CreateInstBindlessCheckPass(gpu_validation_state->desc_set_bind_index,
698*b7893ccfSSadaf Ebrahimi                                                        gpu_validation_state->unique_shader_module_id, descriptor_indexing,
699*b7893ccfSSadaf Ebrahimi                                                        descriptor_indexing));
700*b7893ccfSSadaf Ebrahimi     optimizer.RegisterPass(CreateAggressiveDCEPass());
701*b7893ccfSSadaf Ebrahimi     bool pass = optimizer.Run(new_pgm.data(), new_pgm.size(), &new_pgm);
702*b7893ccfSSadaf Ebrahimi     if (!pass) {
703*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_SHADER_MODULE_EXT, VK_NULL_HANDLE,
704*b7893ccfSSadaf Ebrahimi                            "Failure to instrument shader.  Proceeding with non-instrumented shader.");
705*b7893ccfSSadaf Ebrahimi     }
706*b7893ccfSSadaf Ebrahimi     *unique_shader_id = gpu_validation_state->unique_shader_module_id++;
707*b7893ccfSSadaf Ebrahimi     return pass;
708*b7893ccfSSadaf Ebrahimi }
709*b7893ccfSSadaf Ebrahimi 
710*b7893ccfSSadaf Ebrahimi // Create the instrumented shader data to provide to the driver.
GpuPreCallCreateShaderModule(const VkShaderModuleCreateInfo * pCreateInfo,const VkAllocationCallbacks * pAllocator,VkShaderModule * pShaderModule,uint32_t * unique_shader_id,VkShaderModuleCreateInfo * instrumented_create_info,std::vector<unsigned int> * instrumented_pgm)711*b7893ccfSSadaf Ebrahimi bool CoreChecks::GpuPreCallCreateShaderModule(const VkShaderModuleCreateInfo *pCreateInfo, const VkAllocationCallbacks *pAllocator,
712*b7893ccfSSadaf Ebrahimi                                               VkShaderModule *pShaderModule, uint32_t *unique_shader_id,
713*b7893ccfSSadaf Ebrahimi                                               VkShaderModuleCreateInfo *instrumented_create_info,
714*b7893ccfSSadaf Ebrahimi                                               std::vector<unsigned int> *instrumented_pgm) {
715*b7893ccfSSadaf Ebrahimi     bool pass = GpuInstrumentShader(pCreateInfo, *instrumented_pgm, unique_shader_id);
716*b7893ccfSSadaf Ebrahimi     if (pass) {
717*b7893ccfSSadaf Ebrahimi         instrumented_create_info->pCode = instrumented_pgm->data();
718*b7893ccfSSadaf Ebrahimi         instrumented_create_info->codeSize = instrumented_pgm->size() * sizeof(unsigned int);
719*b7893ccfSSadaf Ebrahimi     }
720*b7893ccfSSadaf Ebrahimi     return pass;
721*b7893ccfSSadaf Ebrahimi }
722*b7893ccfSSadaf Ebrahimi 
723*b7893ccfSSadaf Ebrahimi // Generate the stage-specific part of the message.
GenerateStageMessage(const uint32_t * debug_record,std::string & msg)724*b7893ccfSSadaf Ebrahimi static void GenerateStageMessage(const uint32_t *debug_record, std::string &msg) {
725*b7893ccfSSadaf Ebrahimi     using namespace spvtools;
726*b7893ccfSSadaf Ebrahimi     std::ostringstream strm;
727*b7893ccfSSadaf Ebrahimi     switch (debug_record[kInstCommonOutStageIdx]) {
728*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelVertex: {
729*b7893ccfSSadaf Ebrahimi             strm << "Stage = Vertex. Vertex Index = " << debug_record[kInstVertOutVertexIndex]
730*b7893ccfSSadaf Ebrahimi                  << " Instance Index = " << debug_record[kInstVertOutInstanceIndex] << ". ";
731*b7893ccfSSadaf Ebrahimi         } break;
732*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelTessellationControl: {
733*b7893ccfSSadaf Ebrahimi             strm << "Stage = Tessellation Control.  Invocation ID = " << debug_record[kInstTessCtlOutInvocationId] << ". ";
734*b7893ccfSSadaf Ebrahimi         } break;
735*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelTessellationEvaluation: {
736*b7893ccfSSadaf Ebrahimi             strm << "Stage = Tessellation Eval.  Invocation ID = " << debug_record[kInstTessCtlOutInvocationId] << ". ";
737*b7893ccfSSadaf Ebrahimi         } break;
738*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelGeometry: {
739*b7893ccfSSadaf Ebrahimi             strm << "Stage = Geometry.  Primitive ID = " << debug_record[kInstGeomOutPrimitiveId]
740*b7893ccfSSadaf Ebrahimi                  << " Invocation ID = " << debug_record[kInstGeomOutInvocationId] << ". ";
741*b7893ccfSSadaf Ebrahimi         } break;
742*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelFragment: {
743*b7893ccfSSadaf Ebrahimi             strm << "Stage = Fragment.  Fragment coord (x,y) = ("
744*b7893ccfSSadaf Ebrahimi                  << *reinterpret_cast<const float *>(&debug_record[kInstFragOutFragCoordX]) << ", "
745*b7893ccfSSadaf Ebrahimi                  << *reinterpret_cast<const float *>(&debug_record[kInstFragOutFragCoordY]) << "). ";
746*b7893ccfSSadaf Ebrahimi         } break;
747*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelGLCompute: {
748*b7893ccfSSadaf Ebrahimi             strm << "Stage = Compute.  Global invocation ID = " << debug_record[kInstCompOutGlobalInvocationIdX] << ". ";
749*b7893ccfSSadaf Ebrahimi         } break;
750*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelRayGenerationNV: {
751*b7893ccfSSadaf Ebrahimi             strm << "Stage = Ray Generation.  Global Launch ID (x,y,z) = (" << debug_record[kInstRayTracingOutLaunchIdX] << ", "
752*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstRayTracingOutLaunchIdY] << ", " << debug_record[kInstRayTracingOutLaunchIdZ] << "). ";
753*b7893ccfSSadaf Ebrahimi         } break;
754*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelIntersectionNV: {
755*b7893ccfSSadaf Ebrahimi             strm << "Stage = Intersection.  Global Launch ID (x,y,z) = (" << debug_record[kInstRayTracingOutLaunchIdX] << ", "
756*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstRayTracingOutLaunchIdY] << ", " << debug_record[kInstRayTracingOutLaunchIdZ] << "). ";
757*b7893ccfSSadaf Ebrahimi         } break;
758*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelAnyHitNV: {
759*b7893ccfSSadaf Ebrahimi             strm << "Stage = Any Hit.  Global Launch ID (x,y,z) = (" << debug_record[kInstRayTracingOutLaunchIdX] << ", "
760*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstRayTracingOutLaunchIdY] << ", " << debug_record[kInstRayTracingOutLaunchIdZ] << "). ";
761*b7893ccfSSadaf Ebrahimi         } break;
762*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelClosestHitNV: {
763*b7893ccfSSadaf Ebrahimi             strm << "Stage = Closest Hit.  Global Launch ID (x,y,z) = (" << debug_record[kInstRayTracingOutLaunchIdX] << ", "
764*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstRayTracingOutLaunchIdY] << ", " << debug_record[kInstRayTracingOutLaunchIdZ] << "). ";
765*b7893ccfSSadaf Ebrahimi         } break;
766*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelMissNV: {
767*b7893ccfSSadaf Ebrahimi             strm << "Stage = Miss.  Global Launch ID (x,y,z) = (" << debug_record[kInstRayTracingOutLaunchIdX] << ", "
768*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstRayTracingOutLaunchIdY] << ", " << debug_record[kInstRayTracingOutLaunchIdZ] << "). ";
769*b7893ccfSSadaf Ebrahimi         } break;
770*b7893ccfSSadaf Ebrahimi         case spv::ExecutionModelCallableNV: {
771*b7893ccfSSadaf Ebrahimi             strm << "Stage = Callable.  Global Launch ID (x,y,z) = (" << debug_record[kInstRayTracingOutLaunchIdX] << ", "
772*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstRayTracingOutLaunchIdY] << ", " << debug_record[kInstRayTracingOutLaunchIdZ] << "). ";
773*b7893ccfSSadaf Ebrahimi         } break;
774*b7893ccfSSadaf Ebrahimi         default: {
775*b7893ccfSSadaf Ebrahimi             strm << "Internal Error (unexpected stage = " << debug_record[kInstCommonOutStageIdx] << "). ";
776*b7893ccfSSadaf Ebrahimi             assert(false);
777*b7893ccfSSadaf Ebrahimi         } break;
778*b7893ccfSSadaf Ebrahimi     }
779*b7893ccfSSadaf Ebrahimi     msg = strm.str();
780*b7893ccfSSadaf Ebrahimi }
781*b7893ccfSSadaf Ebrahimi 
782*b7893ccfSSadaf Ebrahimi // Generate the part of the message describing the violation.
GenerateValidationMessage(const uint32_t * debug_record,std::string & msg,std::string & vuid_msg)783*b7893ccfSSadaf Ebrahimi static void GenerateValidationMessage(const uint32_t *debug_record, std::string &msg, std::string &vuid_msg) {
784*b7893ccfSSadaf Ebrahimi     using namespace spvtools;
785*b7893ccfSSadaf Ebrahimi     std::ostringstream strm;
786*b7893ccfSSadaf Ebrahimi     switch (debug_record[kInstValidationOutError]) {
787*b7893ccfSSadaf Ebrahimi         case 0: {
788*b7893ccfSSadaf Ebrahimi             strm << "Index of " << debug_record[kInstBindlessBoundsOutDescIndex] << " used to index descriptor array of length "
789*b7893ccfSSadaf Ebrahimi                  << debug_record[kInstBindlessBoundsOutDescBound] << ". ";
790*b7893ccfSSadaf Ebrahimi             vuid_msg = "UNASSIGNED-Descriptor index out of bounds";
791*b7893ccfSSadaf Ebrahimi         } break;
792*b7893ccfSSadaf Ebrahimi         case 1: {
793*b7893ccfSSadaf Ebrahimi             strm << "Descriptor index " << debug_record[kInstBindlessBoundsOutDescIndex] << " is uninitialized. ";
794*b7893ccfSSadaf Ebrahimi             vuid_msg = "UNASSIGNED-Descriptor uninitialized";
795*b7893ccfSSadaf Ebrahimi         } break;
796*b7893ccfSSadaf Ebrahimi         default: {
797*b7893ccfSSadaf Ebrahimi             strm << "Internal Error (unexpected error type = " << debug_record[kInstValidationOutError] << "). ";
798*b7893ccfSSadaf Ebrahimi             vuid_msg = "UNASSIGNED-Internal Error";
799*b7893ccfSSadaf Ebrahimi             assert(false);
800*b7893ccfSSadaf Ebrahimi         } break;
801*b7893ccfSSadaf Ebrahimi     }
802*b7893ccfSSadaf Ebrahimi     msg = strm.str();
803*b7893ccfSSadaf Ebrahimi }
804*b7893ccfSSadaf Ebrahimi 
LookupDebugUtilsName(const debug_report_data * report_data,const uint64_t object)805*b7893ccfSSadaf Ebrahimi static std::string LookupDebugUtilsName(const debug_report_data *report_data, const uint64_t object) {
806*b7893ccfSSadaf Ebrahimi     auto object_label = report_data->DebugReportGetUtilsObjectName(object);
807*b7893ccfSSadaf Ebrahimi     if (object_label != "") {
808*b7893ccfSSadaf Ebrahimi         object_label = "(" + object_label + ")";
809*b7893ccfSSadaf Ebrahimi     }
810*b7893ccfSSadaf Ebrahimi     return object_label;
811*b7893ccfSSadaf Ebrahimi }
812*b7893ccfSSadaf Ebrahimi 
813*b7893ccfSSadaf Ebrahimi // Generate message from the common portion of the debug report record.
GenerateCommonMessage(const debug_report_data * report_data,const CMD_BUFFER_STATE * cb_node,const uint32_t * debug_record,const VkShaderModule shader_module_handle,const VkPipeline pipeline_handle,const VkPipelineBindPoint pipeline_bind_point,const uint32_t operation_index,std::string & msg)814*b7893ccfSSadaf Ebrahimi static void GenerateCommonMessage(const debug_report_data *report_data, const CMD_BUFFER_STATE *cb_node,
815*b7893ccfSSadaf Ebrahimi                                   const uint32_t *debug_record, const VkShaderModule shader_module_handle,
816*b7893ccfSSadaf Ebrahimi                                   const VkPipeline pipeline_handle, const VkPipelineBindPoint pipeline_bind_point,
817*b7893ccfSSadaf Ebrahimi                                   const uint32_t operation_index, std::string &msg) {
818*b7893ccfSSadaf Ebrahimi     using namespace spvtools;
819*b7893ccfSSadaf Ebrahimi     std::ostringstream strm;
820*b7893ccfSSadaf Ebrahimi     if (shader_module_handle == VK_NULL_HANDLE) {
821*b7893ccfSSadaf Ebrahimi         strm << std::hex << std::showbase << "Internal Error: Unable to locate information for shader used in command buffer "
822*b7893ccfSSadaf Ebrahimi              << LookupDebugUtilsName(report_data, HandleToUint64(cb_node->commandBuffer)) << "("
823*b7893ccfSSadaf Ebrahimi              << HandleToUint64(cb_node->commandBuffer) << "). ";
824*b7893ccfSSadaf Ebrahimi         assert(true);
825*b7893ccfSSadaf Ebrahimi     } else {
826*b7893ccfSSadaf Ebrahimi         strm << std::hex << std::showbase << "Command buffer "
827*b7893ccfSSadaf Ebrahimi              << LookupDebugUtilsName(report_data, HandleToUint64(cb_node->commandBuffer)) << "("
828*b7893ccfSSadaf Ebrahimi              << HandleToUint64(cb_node->commandBuffer) << "). ";
829*b7893ccfSSadaf Ebrahimi         if (pipeline_bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
830*b7893ccfSSadaf Ebrahimi             strm << "Draw ";
831*b7893ccfSSadaf Ebrahimi         } else if (pipeline_bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
832*b7893ccfSSadaf Ebrahimi             strm << "Compute ";
833*b7893ccfSSadaf Ebrahimi         } else if (pipeline_bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
834*b7893ccfSSadaf Ebrahimi             strm << "Ray Trace ";
835*b7893ccfSSadaf Ebrahimi         } else {
836*b7893ccfSSadaf Ebrahimi             assert(false);
837*b7893ccfSSadaf Ebrahimi             strm << "Unknown Pipeline Operation ";
838*b7893ccfSSadaf Ebrahimi         }
839*b7893ccfSSadaf Ebrahimi         strm << "Index " << operation_index << ". "
840*b7893ccfSSadaf Ebrahimi              << "Pipeline " << LookupDebugUtilsName(report_data, HandleToUint64(pipeline_handle)) << "("
841*b7893ccfSSadaf Ebrahimi              << HandleToUint64(pipeline_handle) << "). "
842*b7893ccfSSadaf Ebrahimi              << "Shader Module " << LookupDebugUtilsName(report_data, HandleToUint64(shader_module_handle)) << "("
843*b7893ccfSSadaf Ebrahimi              << HandleToUint64(shader_module_handle) << "). ";
844*b7893ccfSSadaf Ebrahimi     }
845*b7893ccfSSadaf Ebrahimi     strm << std::dec << std::noshowbase;
846*b7893ccfSSadaf Ebrahimi     strm << "Shader Instruction Index = " << debug_record[kInstCommonOutInstructionIdx] << ". ";
847*b7893ccfSSadaf Ebrahimi     msg = strm.str();
848*b7893ccfSSadaf Ebrahimi }
849*b7893ccfSSadaf Ebrahimi 
850*b7893ccfSSadaf Ebrahimi // Read the contents of the SPIR-V OpSource instruction and any following continuation instructions.
851*b7893ccfSSadaf Ebrahimi // Split the single string into a vector of strings, one for each line, for easier processing.
ReadOpSource(const SHADER_MODULE_STATE & shader,const uint32_t reported_file_id,std::vector<std::string> & opsource_lines)852*b7893ccfSSadaf Ebrahimi static void ReadOpSource(const SHADER_MODULE_STATE &shader, const uint32_t reported_file_id,
853*b7893ccfSSadaf Ebrahimi                          std::vector<std::string> &opsource_lines) {
854*b7893ccfSSadaf Ebrahimi     for (auto insn : shader) {
855*b7893ccfSSadaf Ebrahimi         if ((insn.opcode() == spv::OpSource) && (insn.len() >= 5) && (insn.word(3) == reported_file_id)) {
856*b7893ccfSSadaf Ebrahimi             std::istringstream in_stream;
857*b7893ccfSSadaf Ebrahimi             std::string cur_line;
858*b7893ccfSSadaf Ebrahimi             in_stream.str((char *)&insn.word(4));
859*b7893ccfSSadaf Ebrahimi             while (std::getline(in_stream, cur_line)) {
860*b7893ccfSSadaf Ebrahimi                 opsource_lines.push_back(cur_line);
861*b7893ccfSSadaf Ebrahimi             }
862*b7893ccfSSadaf Ebrahimi             while ((++insn).opcode() == spv::OpSourceContinued) {
863*b7893ccfSSadaf Ebrahimi                 in_stream.str((char *)&insn.word(1));
864*b7893ccfSSadaf Ebrahimi                 while (std::getline(in_stream, cur_line)) {
865*b7893ccfSSadaf Ebrahimi                     opsource_lines.push_back(cur_line);
866*b7893ccfSSadaf Ebrahimi                 }
867*b7893ccfSSadaf Ebrahimi             }
868*b7893ccfSSadaf Ebrahimi             break;
869*b7893ccfSSadaf Ebrahimi         }
870*b7893ccfSSadaf Ebrahimi     }
871*b7893ccfSSadaf Ebrahimi }
872*b7893ccfSSadaf Ebrahimi 
873*b7893ccfSSadaf Ebrahimi // The task here is to search the OpSource content to find the #line directive with the
874*b7893ccfSSadaf Ebrahimi // line number that is closest to, but still prior to the reported error line number and
875*b7893ccfSSadaf Ebrahimi // still within the reported filename.
876*b7893ccfSSadaf Ebrahimi // From this known position in the OpSource content we can add the difference between
877*b7893ccfSSadaf Ebrahimi // the #line line number and the reported error line number to determine the location
878*b7893ccfSSadaf Ebrahimi // in the OpSource content of the reported error line.
879*b7893ccfSSadaf Ebrahimi //
880*b7893ccfSSadaf Ebrahimi // Considerations:
881*b7893ccfSSadaf Ebrahimi // - Look only at #line directives that specify the reported_filename since
882*b7893ccfSSadaf Ebrahimi //   the reported error line number refers to its location in the reported filename.
883*b7893ccfSSadaf Ebrahimi // - If a #line directive does not have a filename, the file is the reported filename, or
884*b7893ccfSSadaf Ebrahimi //   the filename found in a prior #line directive.  (This is C-preprocessor behavior)
885*b7893ccfSSadaf Ebrahimi // - It is possible (e.g., inlining) for blocks of code to get shuffled out of their
886*b7893ccfSSadaf Ebrahimi //   original order and the #line directives are used to keep the numbering correct.  This
887*b7893ccfSSadaf Ebrahimi //   is why we need to examine the entire contents of the source, instead of leaving early
888*b7893ccfSSadaf Ebrahimi //   when finding a #line line number larger than the reported error line number.
889*b7893ccfSSadaf Ebrahimi //
890*b7893ccfSSadaf Ebrahimi 
891*b7893ccfSSadaf Ebrahimi // GCC 4.8 has a problem with std::regex that is fixed in GCC 4.9.  Provide fallback code for 4.8
892*b7893ccfSSadaf Ebrahimi #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
893*b7893ccfSSadaf Ebrahimi 
894*b7893ccfSSadaf Ebrahimi #if defined(__GNUC__) && GCC_VERSION < 40900
GetLineAndFilename(const std::string string,uint32_t * linenumber,std::string & filename)895*b7893ccfSSadaf Ebrahimi static bool GetLineAndFilename(const std::string string, uint32_t *linenumber, std::string &filename) {
896*b7893ccfSSadaf Ebrahimi     // # line <linenumber> "<filename>" or
897*b7893ccfSSadaf Ebrahimi     // #line <linenumber> "<filename>"
898*b7893ccfSSadaf Ebrahimi     std::vector<std::string> tokens;
899*b7893ccfSSadaf Ebrahimi     std::stringstream stream(string);
900*b7893ccfSSadaf Ebrahimi     std::string temp;
901*b7893ccfSSadaf Ebrahimi     uint32_t line_index = 0;
902*b7893ccfSSadaf Ebrahimi 
903*b7893ccfSSadaf Ebrahimi     while (stream >> temp) tokens.push_back(temp);
904*b7893ccfSSadaf Ebrahimi     auto size = tokens.size();
905*b7893ccfSSadaf Ebrahimi     if (size > 1) {
906*b7893ccfSSadaf Ebrahimi         if (tokens[0] == "#" && tokens[1] == "line") {
907*b7893ccfSSadaf Ebrahimi             line_index = 2;
908*b7893ccfSSadaf Ebrahimi         } else if (tokens[0] == "#line") {
909*b7893ccfSSadaf Ebrahimi             line_index = 1;
910*b7893ccfSSadaf Ebrahimi         }
911*b7893ccfSSadaf Ebrahimi     }
912*b7893ccfSSadaf Ebrahimi     if (0 == line_index) return false;
913*b7893ccfSSadaf Ebrahimi     *linenumber = std::stoul(tokens[line_index]);
914*b7893ccfSSadaf Ebrahimi     uint32_t filename_index = line_index + 1;
915*b7893ccfSSadaf Ebrahimi     // Remove enclosing double quotes around filename
916*b7893ccfSSadaf Ebrahimi     if (size > filename_index) filename = tokens[filename_index].substr(1, tokens[filename_index].size() - 2);
917*b7893ccfSSadaf Ebrahimi     return true;
918*b7893ccfSSadaf Ebrahimi }
919*b7893ccfSSadaf Ebrahimi #else
GetLineAndFilename(const std::string string,uint32_t * linenumber,std::string & filename)920*b7893ccfSSadaf Ebrahimi static bool GetLineAndFilename(const std::string string, uint32_t *linenumber, std::string &filename) {
921*b7893ccfSSadaf Ebrahimi     static const std::regex line_regex(  // matches #line directives
922*b7893ccfSSadaf Ebrahimi         "^"                              // beginning of line
923*b7893ccfSSadaf Ebrahimi         "\\s*"                           // optional whitespace
924*b7893ccfSSadaf Ebrahimi         "#"                              // required text
925*b7893ccfSSadaf Ebrahimi         "\\s*"                           // optional whitespace
926*b7893ccfSSadaf Ebrahimi         "line"                           // required text
927*b7893ccfSSadaf Ebrahimi         "\\s+"                           // required whitespace
928*b7893ccfSSadaf Ebrahimi         "([0-9]+)"                       // required first capture - line number
929*b7893ccfSSadaf Ebrahimi         "(\\s+)?"                        // optional second capture - whitespace
930*b7893ccfSSadaf Ebrahimi         "(\".+\")?"                      // optional third capture - quoted filename with at least one char inside
931*b7893ccfSSadaf Ebrahimi         ".*");                           // rest of line (needed when using std::regex_match since the entire line is tested)
932*b7893ccfSSadaf Ebrahimi 
933*b7893ccfSSadaf Ebrahimi     std::smatch captures;
934*b7893ccfSSadaf Ebrahimi 
935*b7893ccfSSadaf Ebrahimi     bool found_line = std::regex_match(string, captures, line_regex);
936*b7893ccfSSadaf Ebrahimi     if (!found_line) return false;
937*b7893ccfSSadaf Ebrahimi 
938*b7893ccfSSadaf Ebrahimi     // filename is optional and considered found only if the whitespace and the filename are captured
939*b7893ccfSSadaf Ebrahimi     if (captures[2].matched && captures[3].matched) {
940*b7893ccfSSadaf Ebrahimi         // Remove enclosing double quotes.  The regex guarantees the quotes and at least one char.
941*b7893ccfSSadaf Ebrahimi         filename = captures[3].str().substr(1, captures[3].str().size() - 2);
942*b7893ccfSSadaf Ebrahimi     }
943*b7893ccfSSadaf Ebrahimi     *linenumber = std::stoul(captures[1]);
944*b7893ccfSSadaf Ebrahimi     return true;
945*b7893ccfSSadaf Ebrahimi }
946*b7893ccfSSadaf Ebrahimi #endif  // GCC_VERSION
947*b7893ccfSSadaf Ebrahimi 
948*b7893ccfSSadaf Ebrahimi // Extract the filename, line number, and column number from the correct OpLine and build a message string from it.
949*b7893ccfSSadaf Ebrahimi // Scan the source (from OpSource) to find the line of source at the reported line number and place it in another message string.
GenerateSourceMessages(const std::vector<unsigned int> & pgm,const uint32_t * debug_record,std::string & filename_msg,std::string & source_msg)950*b7893ccfSSadaf Ebrahimi static void GenerateSourceMessages(const std::vector<unsigned int> &pgm, const uint32_t *debug_record, std::string &filename_msg,
951*b7893ccfSSadaf Ebrahimi                                    std::string &source_msg) {
952*b7893ccfSSadaf Ebrahimi     using namespace spvtools;
953*b7893ccfSSadaf Ebrahimi     std::ostringstream filename_stream;
954*b7893ccfSSadaf Ebrahimi     std::ostringstream source_stream;
955*b7893ccfSSadaf Ebrahimi     SHADER_MODULE_STATE shader;
956*b7893ccfSSadaf Ebrahimi     shader.words = pgm;
957*b7893ccfSSadaf Ebrahimi     // Find the OpLine just before the failing instruction indicated by the debug info.
958*b7893ccfSSadaf Ebrahimi     // SPIR-V can only be iterated in the forward direction due to its opcode/length encoding.
959*b7893ccfSSadaf Ebrahimi     uint32_t instruction_index = 0;
960*b7893ccfSSadaf Ebrahimi     uint32_t reported_file_id = 0;
961*b7893ccfSSadaf Ebrahimi     uint32_t reported_line_number = 0;
962*b7893ccfSSadaf Ebrahimi     uint32_t reported_column_number = 0;
963*b7893ccfSSadaf Ebrahimi     if (shader.words.size() > 0) {
964*b7893ccfSSadaf Ebrahimi         for (auto insn : shader) {
965*b7893ccfSSadaf Ebrahimi             if (insn.opcode() == spv::OpLine) {
966*b7893ccfSSadaf Ebrahimi                 reported_file_id = insn.word(1);
967*b7893ccfSSadaf Ebrahimi                 reported_line_number = insn.word(2);
968*b7893ccfSSadaf Ebrahimi                 reported_column_number = insn.word(3);
969*b7893ccfSSadaf Ebrahimi             }
970*b7893ccfSSadaf Ebrahimi             if (instruction_index == debug_record[kInstCommonOutInstructionIdx]) {
971*b7893ccfSSadaf Ebrahimi                 break;
972*b7893ccfSSadaf Ebrahimi             }
973*b7893ccfSSadaf Ebrahimi             instruction_index++;
974*b7893ccfSSadaf Ebrahimi         }
975*b7893ccfSSadaf Ebrahimi     }
976*b7893ccfSSadaf Ebrahimi     // Create message with file information obtained from the OpString pointed to by the discovered OpLine.
977*b7893ccfSSadaf Ebrahimi     std::string reported_filename;
978*b7893ccfSSadaf Ebrahimi     if (reported_file_id == 0) {
979*b7893ccfSSadaf Ebrahimi         filename_stream
980*b7893ccfSSadaf Ebrahimi             << "Unable to find SPIR-V OpLine for source information.  Build shader with debug info to get source information.";
981*b7893ccfSSadaf Ebrahimi     } else {
982*b7893ccfSSadaf Ebrahimi         bool found_opstring = false;
983*b7893ccfSSadaf Ebrahimi         for (auto insn : shader) {
984*b7893ccfSSadaf Ebrahimi             if ((insn.opcode() == spv::OpString) && (insn.len() >= 3) && (insn.word(1) == reported_file_id)) {
985*b7893ccfSSadaf Ebrahimi                 found_opstring = true;
986*b7893ccfSSadaf Ebrahimi                 reported_filename = (char *)&insn.word(2);
987*b7893ccfSSadaf Ebrahimi                 if (reported_filename.empty()) {
988*b7893ccfSSadaf Ebrahimi                     filename_stream << "Shader validation error occurred at line " << reported_line_number;
989*b7893ccfSSadaf Ebrahimi                 } else {
990*b7893ccfSSadaf Ebrahimi                     filename_stream << "Shader validation error occurred in file: " << reported_filename << " at line "
991*b7893ccfSSadaf Ebrahimi                                     << reported_line_number;
992*b7893ccfSSadaf Ebrahimi                 }
993*b7893ccfSSadaf Ebrahimi                 if (reported_column_number > 0) {
994*b7893ccfSSadaf Ebrahimi                     filename_stream << ", column " << reported_column_number;
995*b7893ccfSSadaf Ebrahimi                 }
996*b7893ccfSSadaf Ebrahimi                 filename_stream << ".";
997*b7893ccfSSadaf Ebrahimi                 break;
998*b7893ccfSSadaf Ebrahimi             }
999*b7893ccfSSadaf Ebrahimi         }
1000*b7893ccfSSadaf Ebrahimi         if (!found_opstring) {
1001*b7893ccfSSadaf Ebrahimi             filename_stream << "Unable to find SPIR-V OpString for file id " << reported_file_id << " from OpLine instruction.";
1002*b7893ccfSSadaf Ebrahimi         }
1003*b7893ccfSSadaf Ebrahimi     }
1004*b7893ccfSSadaf Ebrahimi     filename_msg = filename_stream.str();
1005*b7893ccfSSadaf Ebrahimi 
1006*b7893ccfSSadaf Ebrahimi     // Create message to display source code line containing error.
1007*b7893ccfSSadaf Ebrahimi     if ((reported_file_id != 0)) {
1008*b7893ccfSSadaf Ebrahimi         // Read the source code and split it up into separate lines.
1009*b7893ccfSSadaf Ebrahimi         std::vector<std::string> opsource_lines;
1010*b7893ccfSSadaf Ebrahimi         ReadOpSource(shader, reported_file_id, opsource_lines);
1011*b7893ccfSSadaf Ebrahimi         // Find the line in the OpSource content that corresponds to the reported error file and line.
1012*b7893ccfSSadaf Ebrahimi         if (!opsource_lines.empty()) {
1013*b7893ccfSSadaf Ebrahimi             uint32_t saved_line_number = 0;
1014*b7893ccfSSadaf Ebrahimi             std::string current_filename = reported_filename;  // current "preprocessor" filename state.
1015*b7893ccfSSadaf Ebrahimi             std::vector<std::string>::size_type saved_opsource_offset = 0;
1016*b7893ccfSSadaf Ebrahimi             bool found_best_line = false;
1017*b7893ccfSSadaf Ebrahimi             for (auto it = opsource_lines.begin(); it != opsource_lines.end(); ++it) {
1018*b7893ccfSSadaf Ebrahimi                 uint32_t parsed_line_number;
1019*b7893ccfSSadaf Ebrahimi                 std::string parsed_filename;
1020*b7893ccfSSadaf Ebrahimi                 bool found_line = GetLineAndFilename(*it, &parsed_line_number, parsed_filename);
1021*b7893ccfSSadaf Ebrahimi                 if (!found_line) continue;
1022*b7893ccfSSadaf Ebrahimi 
1023*b7893ccfSSadaf Ebrahimi                 bool found_filename = parsed_filename.size() > 0;
1024*b7893ccfSSadaf Ebrahimi                 if (found_filename) {
1025*b7893ccfSSadaf Ebrahimi                     current_filename = parsed_filename;
1026*b7893ccfSSadaf Ebrahimi                 }
1027*b7893ccfSSadaf Ebrahimi                 if ((!found_filename) || (current_filename == reported_filename)) {
1028*b7893ccfSSadaf Ebrahimi                     // Update the candidate best line directive, if the current one is prior and closer to the reported line
1029*b7893ccfSSadaf Ebrahimi                     if (reported_line_number >= parsed_line_number) {
1030*b7893ccfSSadaf Ebrahimi                         if (!found_best_line ||
1031*b7893ccfSSadaf Ebrahimi                             (reported_line_number - parsed_line_number <= reported_line_number - saved_line_number)) {
1032*b7893ccfSSadaf Ebrahimi                             saved_line_number = parsed_line_number;
1033*b7893ccfSSadaf Ebrahimi                             saved_opsource_offset = std::distance(opsource_lines.begin(), it);
1034*b7893ccfSSadaf Ebrahimi                             found_best_line = true;
1035*b7893ccfSSadaf Ebrahimi                         }
1036*b7893ccfSSadaf Ebrahimi                     }
1037*b7893ccfSSadaf Ebrahimi                 }
1038*b7893ccfSSadaf Ebrahimi             }
1039*b7893ccfSSadaf Ebrahimi             if (found_best_line) {
1040*b7893ccfSSadaf Ebrahimi                 assert(reported_line_number >= saved_line_number);
1041*b7893ccfSSadaf Ebrahimi                 std::vector<std::string>::size_type opsource_index =
1042*b7893ccfSSadaf Ebrahimi                     (reported_line_number - saved_line_number) + 1 + saved_opsource_offset;
1043*b7893ccfSSadaf Ebrahimi                 if (opsource_index < opsource_lines.size()) {
1044*b7893ccfSSadaf Ebrahimi                     source_stream << "\n" << reported_line_number << ": " << opsource_lines[opsource_index].c_str();
1045*b7893ccfSSadaf Ebrahimi                 } else {
1046*b7893ccfSSadaf Ebrahimi                     source_stream << "Internal error: calculated source line of " << opsource_index << " for source size of "
1047*b7893ccfSSadaf Ebrahimi                                   << opsource_lines.size() << " lines.";
1048*b7893ccfSSadaf Ebrahimi                 }
1049*b7893ccfSSadaf Ebrahimi             } else {
1050*b7893ccfSSadaf Ebrahimi                 source_stream << "Unable to find suitable #line directive in SPIR-V OpSource.";
1051*b7893ccfSSadaf Ebrahimi             }
1052*b7893ccfSSadaf Ebrahimi         } else {
1053*b7893ccfSSadaf Ebrahimi             source_stream << "Unable to find SPIR-V OpSource.";
1054*b7893ccfSSadaf Ebrahimi         }
1055*b7893ccfSSadaf Ebrahimi     }
1056*b7893ccfSSadaf Ebrahimi     source_msg = source_stream.str();
1057*b7893ccfSSadaf Ebrahimi }
1058*b7893ccfSSadaf Ebrahimi 
1059*b7893ccfSSadaf Ebrahimi // Pull together all the information from the debug record to build the error message strings,
1060*b7893ccfSSadaf Ebrahimi // and then assemble them into a single message string.
1061*b7893ccfSSadaf Ebrahimi // Retrieve the shader program referenced by the unique shader ID provided in the debug record.
1062*b7893ccfSSadaf Ebrahimi // We had to keep a copy of the shader program with the same lifecycle as the pipeline to make
1063*b7893ccfSSadaf Ebrahimi // sure it is available when the pipeline is submitted.  (The ShaderModule tracking object also
1064*b7893ccfSSadaf Ebrahimi // keeps a copy, but it can be destroyed after the pipeline is created and before it is submitted.)
1065*b7893ccfSSadaf Ebrahimi //
AnalyzeAndReportError(CMD_BUFFER_STATE * cb_node,VkQueue queue,VkPipelineBindPoint pipeline_bind_point,uint32_t operation_index,uint32_t * const debug_output_buffer)1066*b7893ccfSSadaf Ebrahimi void CoreChecks::AnalyzeAndReportError(CMD_BUFFER_STATE *cb_node, VkQueue queue, VkPipelineBindPoint pipeline_bind_point,
1067*b7893ccfSSadaf Ebrahimi                                        uint32_t operation_index, uint32_t *const debug_output_buffer) {
1068*b7893ccfSSadaf Ebrahimi     using namespace spvtools;
1069*b7893ccfSSadaf Ebrahimi     const uint32_t total_words = debug_output_buffer[0];
1070*b7893ccfSSadaf Ebrahimi     // A zero here means that the shader instrumentation didn't write anything.
1071*b7893ccfSSadaf Ebrahimi     // If you have nothing to say, don't say it here.
1072*b7893ccfSSadaf Ebrahimi     if (0 == total_words) {
1073*b7893ccfSSadaf Ebrahimi         return;
1074*b7893ccfSSadaf Ebrahimi     }
1075*b7893ccfSSadaf Ebrahimi     // The first word in the debug output buffer is the number of words that would have
1076*b7893ccfSSadaf Ebrahimi     // been written by the shader instrumentation, if there was enough room in the buffer we provided.
1077*b7893ccfSSadaf Ebrahimi     // The number of words actually written by the shaders is determined by the size of the buffer
1078*b7893ccfSSadaf Ebrahimi     // we provide via the descriptor.  So, we process only the number of words that can fit in the
1079*b7893ccfSSadaf Ebrahimi     // buffer.
1080*b7893ccfSSadaf Ebrahimi     // Each "report" written by the shader instrumentation is considered a "record".  This function
1081*b7893ccfSSadaf Ebrahimi     // is hard-coded to process only one record because it expects the buffer to be large enough to
1082*b7893ccfSSadaf Ebrahimi     // hold only one record.  If there is a desire to process more than one record, this function needs
1083*b7893ccfSSadaf Ebrahimi     // to be modified to loop over records and the buffer size increased.
1084*b7893ccfSSadaf Ebrahimi     std::string validation_message;
1085*b7893ccfSSadaf Ebrahimi     std::string stage_message;
1086*b7893ccfSSadaf Ebrahimi     std::string common_message;
1087*b7893ccfSSadaf Ebrahimi     std::string filename_message;
1088*b7893ccfSSadaf Ebrahimi     std::string source_message;
1089*b7893ccfSSadaf Ebrahimi     std::string vuid_msg;
1090*b7893ccfSSadaf Ebrahimi     VkShaderModule shader_module_handle = VK_NULL_HANDLE;
1091*b7893ccfSSadaf Ebrahimi     VkPipeline pipeline_handle = VK_NULL_HANDLE;
1092*b7893ccfSSadaf Ebrahimi     std::vector<unsigned int> pgm;
1093*b7893ccfSSadaf Ebrahimi     // The first record starts at this offset after the total_words.
1094*b7893ccfSSadaf Ebrahimi     const uint32_t *debug_record = &debug_output_buffer[kDebugOutputDataOffset];
1095*b7893ccfSSadaf Ebrahimi     // Lookup the VkShaderModule handle and SPIR-V code used to create the shader, using the unique shader ID value returned
1096*b7893ccfSSadaf Ebrahimi     // by the instrumented shader.
1097*b7893ccfSSadaf Ebrahimi     auto it = gpu_validation_state->shader_map.find(debug_record[kInstCommonOutShaderId]);
1098*b7893ccfSSadaf Ebrahimi     if (it != gpu_validation_state->shader_map.end()) {
1099*b7893ccfSSadaf Ebrahimi         shader_module_handle = it->second.shader_module;
1100*b7893ccfSSadaf Ebrahimi         pipeline_handle = it->second.pipeline;
1101*b7893ccfSSadaf Ebrahimi         pgm = it->second.pgm;
1102*b7893ccfSSadaf Ebrahimi     }
1103*b7893ccfSSadaf Ebrahimi     GenerateValidationMessage(debug_record, validation_message, vuid_msg);
1104*b7893ccfSSadaf Ebrahimi     GenerateStageMessage(debug_record, stage_message);
1105*b7893ccfSSadaf Ebrahimi     GenerateCommonMessage(report_data, cb_node, debug_record, shader_module_handle, pipeline_handle, pipeline_bind_point,
1106*b7893ccfSSadaf Ebrahimi                           operation_index, common_message);
1107*b7893ccfSSadaf Ebrahimi     GenerateSourceMessages(pgm, debug_record, filename_message, source_message);
1108*b7893ccfSSadaf Ebrahimi     log_msg(report_data, VK_DEBUG_REPORT_ERROR_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_QUEUE_EXT, HandleToUint64(queue),
1109*b7893ccfSSadaf Ebrahimi             vuid_msg.c_str(), "%s %s %s %s%s", validation_message.c_str(), common_message.c_str(), stage_message.c_str(),
1110*b7893ccfSSadaf Ebrahimi             filename_message.c_str(), source_message.c_str());
1111*b7893ccfSSadaf Ebrahimi     // The debug record at word kInstCommonOutSize is the number of words in the record
1112*b7893ccfSSadaf Ebrahimi     // written by the shader.  Clear the entire record plus the total_words word at the start.
1113*b7893ccfSSadaf Ebrahimi     const uint32_t words_to_clear = 1 + std::min(debug_record[kInstCommonOutSize], (uint32_t)kInstMaxOutCnt);
1114*b7893ccfSSadaf Ebrahimi     memset(debug_output_buffer, 0, sizeof(uint32_t) * words_to_clear);
1115*b7893ccfSSadaf Ebrahimi }
1116*b7893ccfSSadaf Ebrahimi 
1117*b7893ccfSSadaf Ebrahimi // For the given command buffer, map its debug data buffers and read their contents for analysis.
ProcessInstrumentationBuffer(VkQueue queue,CMD_BUFFER_STATE * cb_node)1118*b7893ccfSSadaf Ebrahimi void CoreChecks::ProcessInstrumentationBuffer(VkQueue queue, CMD_BUFFER_STATE *cb_node) {
1119*b7893ccfSSadaf Ebrahimi     auto gpu_buffer_list = gpu_validation_state->GetGpuBufferInfo(cb_node->commandBuffer);
1120*b7893ccfSSadaf Ebrahimi     if (cb_node && (cb_node->hasDrawCmd || cb_node->hasTraceRaysCmd || cb_node->hasDispatchCmd) && gpu_buffer_list.size() > 0) {
1121*b7893ccfSSadaf Ebrahimi         VkResult result;
1122*b7893ccfSSadaf Ebrahimi         char *pData;
1123*b7893ccfSSadaf Ebrahimi         uint32_t draw_index = 0;
1124*b7893ccfSSadaf Ebrahimi         uint32_t compute_index = 0;
1125*b7893ccfSSadaf Ebrahimi         uint32_t ray_trace_index = 0;
1126*b7893ccfSSadaf Ebrahimi 
1127*b7893ccfSSadaf Ebrahimi         for (auto &buffer_info : gpu_buffer_list) {
1128*b7893ccfSSadaf Ebrahimi             result = vmaMapMemory(gpu_validation_state->vmaAllocator, buffer_info.output_mem_block.allocation, (void **)&pData);
1129*b7893ccfSSadaf Ebrahimi             // Analyze debug output buffer
1130*b7893ccfSSadaf Ebrahimi             if (result == VK_SUCCESS) {
1131*b7893ccfSSadaf Ebrahimi                 uint32_t operation_index = 0;
1132*b7893ccfSSadaf Ebrahimi                 if (buffer_info.pipeline_bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
1133*b7893ccfSSadaf Ebrahimi                     operation_index = draw_index;
1134*b7893ccfSSadaf Ebrahimi                 } else if (buffer_info.pipeline_bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
1135*b7893ccfSSadaf Ebrahimi                     operation_index = compute_index;
1136*b7893ccfSSadaf Ebrahimi                 } else if (buffer_info.pipeline_bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
1137*b7893ccfSSadaf Ebrahimi                     operation_index = ray_trace_index;
1138*b7893ccfSSadaf Ebrahimi                 } else {
1139*b7893ccfSSadaf Ebrahimi                     assert(false);
1140*b7893ccfSSadaf Ebrahimi                 }
1141*b7893ccfSSadaf Ebrahimi 
1142*b7893ccfSSadaf Ebrahimi                 AnalyzeAndReportError(cb_node, queue, buffer_info.pipeline_bind_point, operation_index, (uint32_t *)pData);
1143*b7893ccfSSadaf Ebrahimi                 vmaUnmapMemory(gpu_validation_state->vmaAllocator, buffer_info.output_mem_block.allocation);
1144*b7893ccfSSadaf Ebrahimi             }
1145*b7893ccfSSadaf Ebrahimi 
1146*b7893ccfSSadaf Ebrahimi             if (buffer_info.pipeline_bind_point == VK_PIPELINE_BIND_POINT_GRAPHICS) {
1147*b7893ccfSSadaf Ebrahimi                 draw_index++;
1148*b7893ccfSSadaf Ebrahimi             } else if (buffer_info.pipeline_bind_point == VK_PIPELINE_BIND_POINT_COMPUTE) {
1149*b7893ccfSSadaf Ebrahimi                 compute_index++;
1150*b7893ccfSSadaf Ebrahimi             } else if (buffer_info.pipeline_bind_point == VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
1151*b7893ccfSSadaf Ebrahimi                 ray_trace_index++;
1152*b7893ccfSSadaf Ebrahimi             } else {
1153*b7893ccfSSadaf Ebrahimi                 assert(false);
1154*b7893ccfSSadaf Ebrahimi             }
1155*b7893ccfSSadaf Ebrahimi         }
1156*b7893ccfSSadaf Ebrahimi     }
1157*b7893ccfSSadaf Ebrahimi }
1158*b7893ccfSSadaf Ebrahimi 
1159*b7893ccfSSadaf Ebrahimi // For the given command buffer, map its debug data buffers and update the status of any update after bind descriptors
UpdateInstrumentationBuffer(CMD_BUFFER_STATE * cb_node)1160*b7893ccfSSadaf Ebrahimi void CoreChecks::UpdateInstrumentationBuffer(CMD_BUFFER_STATE *cb_node) {
1161*b7893ccfSSadaf Ebrahimi     auto gpu_buffer_list = gpu_validation_state->GetGpuBufferInfo(cb_node->commandBuffer);
1162*b7893ccfSSadaf Ebrahimi     uint32_t *pData;
1163*b7893ccfSSadaf Ebrahimi     for (auto &buffer_info : gpu_buffer_list) {
1164*b7893ccfSSadaf Ebrahimi         if (buffer_info.input_mem_block.update_at_submit.size() > 0) {
1165*b7893ccfSSadaf Ebrahimi             VkResult result =
1166*b7893ccfSSadaf Ebrahimi                 vmaMapMemory(gpu_validation_state->vmaAllocator, buffer_info.input_mem_block.allocation, (void **)&pData);
1167*b7893ccfSSadaf Ebrahimi             if (result == VK_SUCCESS) {
1168*b7893ccfSSadaf Ebrahimi                 for (auto update : buffer_info.input_mem_block.update_at_submit) {
1169*b7893ccfSSadaf Ebrahimi                     if (update.second->updated) pData[update.first] = 1;
1170*b7893ccfSSadaf Ebrahimi                 }
1171*b7893ccfSSadaf Ebrahimi                 vmaUnmapMemory(gpu_validation_state->vmaAllocator, buffer_info.input_mem_block.allocation);
1172*b7893ccfSSadaf Ebrahimi             }
1173*b7893ccfSSadaf Ebrahimi         }
1174*b7893ccfSSadaf Ebrahimi     }
1175*b7893ccfSSadaf Ebrahimi }
1176*b7893ccfSSadaf Ebrahimi 
1177*b7893ccfSSadaf Ebrahimi // Submit a memory barrier on graphics queues.
1178*b7893ccfSSadaf Ebrahimi // Lazy-create and record the needed command buffer.
SubmitBarrier(VkQueue queue)1179*b7893ccfSSadaf Ebrahimi void CoreChecks::SubmitBarrier(VkQueue queue) {
1180*b7893ccfSSadaf Ebrahimi     auto queue_barrier_command_info_it =
1181*b7893ccfSSadaf Ebrahimi         gpu_validation_state->queue_barrier_command_infos.emplace(queue, GpuQueueBarrierCommandInfo{});
1182*b7893ccfSSadaf Ebrahimi     if (queue_barrier_command_info_it.second) {
1183*b7893ccfSSadaf Ebrahimi         GpuQueueBarrierCommandInfo &quere_barrier_command_info = queue_barrier_command_info_it.first->second;
1184*b7893ccfSSadaf Ebrahimi 
1185*b7893ccfSSadaf Ebrahimi         uint32_t queue_family_index = 0;
1186*b7893ccfSSadaf Ebrahimi 
1187*b7893ccfSSadaf Ebrahimi         auto queue_state_it = queueMap.find(queue);
1188*b7893ccfSSadaf Ebrahimi         if (queue_state_it != queueMap.end()) {
1189*b7893ccfSSadaf Ebrahimi             queue_family_index = queue_state_it->second.queueFamilyIndex;
1190*b7893ccfSSadaf Ebrahimi         }
1191*b7893ccfSSadaf Ebrahimi 
1192*b7893ccfSSadaf Ebrahimi         VkResult result = VK_SUCCESS;
1193*b7893ccfSSadaf Ebrahimi 
1194*b7893ccfSSadaf Ebrahimi         VkCommandPoolCreateInfo pool_create_info = {};
1195*b7893ccfSSadaf Ebrahimi         pool_create_info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
1196*b7893ccfSSadaf Ebrahimi         pool_create_info.queueFamilyIndex = queue_family_index;
1197*b7893ccfSSadaf Ebrahimi         result = DispatchCreateCommandPool(device, &pool_create_info, nullptr, &quere_barrier_command_info.barrier_command_pool);
1198*b7893ccfSSadaf Ebrahimi         if (result != VK_SUCCESS) {
1199*b7893ccfSSadaf Ebrahimi             ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
1200*b7893ccfSSadaf Ebrahimi                                "Unable to create command pool for barrier CB.");
1201*b7893ccfSSadaf Ebrahimi             quere_barrier_command_info.barrier_command_pool = VK_NULL_HANDLE;
1202*b7893ccfSSadaf Ebrahimi             return;
1203*b7893ccfSSadaf Ebrahimi         }
1204*b7893ccfSSadaf Ebrahimi 
1205*b7893ccfSSadaf Ebrahimi         VkCommandBufferAllocateInfo buffer_alloc_info = {};
1206*b7893ccfSSadaf Ebrahimi         buffer_alloc_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
1207*b7893ccfSSadaf Ebrahimi         buffer_alloc_info.commandPool = quere_barrier_command_info.barrier_command_pool;
1208*b7893ccfSSadaf Ebrahimi         buffer_alloc_info.commandBufferCount = 1;
1209*b7893ccfSSadaf Ebrahimi         buffer_alloc_info.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
1210*b7893ccfSSadaf Ebrahimi         result = DispatchAllocateCommandBuffers(device, &buffer_alloc_info, &quere_barrier_command_info.barrier_command_buffer);
1211*b7893ccfSSadaf Ebrahimi         if (result != VK_SUCCESS) {
1212*b7893ccfSSadaf Ebrahimi             ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
1213*b7893ccfSSadaf Ebrahimi                                "Unable to create barrier command buffer.");
1214*b7893ccfSSadaf Ebrahimi             DispatchDestroyCommandPool(device, quere_barrier_command_info.barrier_command_pool, nullptr);
1215*b7893ccfSSadaf Ebrahimi             quere_barrier_command_info.barrier_command_pool = VK_NULL_HANDLE;
1216*b7893ccfSSadaf Ebrahimi             quere_barrier_command_info.barrier_command_buffer = VK_NULL_HANDLE;
1217*b7893ccfSSadaf Ebrahimi             return;
1218*b7893ccfSSadaf Ebrahimi         }
1219*b7893ccfSSadaf Ebrahimi 
1220*b7893ccfSSadaf Ebrahimi         // Hook up command buffer dispatch
1221*b7893ccfSSadaf Ebrahimi         gpu_validation_state->vkSetDeviceLoaderData(device, quere_barrier_command_info.barrier_command_buffer);
1222*b7893ccfSSadaf Ebrahimi 
1223*b7893ccfSSadaf Ebrahimi         // Record a global memory barrier to force availability of device memory operations to the host domain.
1224*b7893ccfSSadaf Ebrahimi         VkCommandBufferBeginInfo command_buffer_begin_info = {};
1225*b7893ccfSSadaf Ebrahimi         command_buffer_begin_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
1226*b7893ccfSSadaf Ebrahimi         result = DispatchBeginCommandBuffer(quere_barrier_command_info.barrier_command_buffer, &command_buffer_begin_info);
1227*b7893ccfSSadaf Ebrahimi         if (result == VK_SUCCESS) {
1228*b7893ccfSSadaf Ebrahimi             VkMemoryBarrier memory_barrier = {};
1229*b7893ccfSSadaf Ebrahimi             memory_barrier.sType = VK_STRUCTURE_TYPE_MEMORY_BARRIER;
1230*b7893ccfSSadaf Ebrahimi             memory_barrier.srcAccessMask = VK_ACCESS_MEMORY_WRITE_BIT;
1231*b7893ccfSSadaf Ebrahimi             memory_barrier.dstAccessMask = VK_ACCESS_HOST_READ_BIT;
1232*b7893ccfSSadaf Ebrahimi 
1233*b7893ccfSSadaf Ebrahimi             DispatchCmdPipelineBarrier(quere_barrier_command_info.barrier_command_buffer, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT,
1234*b7893ccfSSadaf Ebrahimi                                        VK_PIPELINE_STAGE_HOST_BIT, 0, 1, &memory_barrier, 0, nullptr, 0, nullptr);
1235*b7893ccfSSadaf Ebrahimi             DispatchEndCommandBuffer(quere_barrier_command_info.barrier_command_buffer);
1236*b7893ccfSSadaf Ebrahimi         }
1237*b7893ccfSSadaf Ebrahimi     }
1238*b7893ccfSSadaf Ebrahimi 
1239*b7893ccfSSadaf Ebrahimi     GpuQueueBarrierCommandInfo &quere_barrier_command_info = queue_barrier_command_info_it.first->second;
1240*b7893ccfSSadaf Ebrahimi     if (quere_barrier_command_info.barrier_command_buffer != VK_NULL_HANDLE) {
1241*b7893ccfSSadaf Ebrahimi         VkSubmitInfo submit_info = {};
1242*b7893ccfSSadaf Ebrahimi         submit_info.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
1243*b7893ccfSSadaf Ebrahimi         submit_info.commandBufferCount = 1;
1244*b7893ccfSSadaf Ebrahimi         submit_info.pCommandBuffers = &quere_barrier_command_info.barrier_command_buffer;
1245*b7893ccfSSadaf Ebrahimi         DispatchQueueSubmit(queue, 1, &submit_info, VK_NULL_HANDLE);
1246*b7893ccfSSadaf Ebrahimi     }
1247*b7893ccfSSadaf Ebrahimi }
1248*b7893ccfSSadaf Ebrahimi 
GpuPreCallRecordQueueSubmit(VkQueue queue,uint32_t submitCount,const VkSubmitInfo * pSubmits,VkFence fence)1249*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo *pSubmits, VkFence fence) {
1250*b7893ccfSSadaf Ebrahimi     for (uint32_t submit_idx = 0; submit_idx < submitCount; submit_idx++) {
1251*b7893ccfSSadaf Ebrahimi         const VkSubmitInfo *submit = &pSubmits[submit_idx];
1252*b7893ccfSSadaf Ebrahimi         for (uint32_t i = 0; i < submit->commandBufferCount; i++) {
1253*b7893ccfSSadaf Ebrahimi             auto cb_node = GetCBState(submit->pCommandBuffers[i]);
1254*b7893ccfSSadaf Ebrahimi             UpdateInstrumentationBuffer(cb_node);
1255*b7893ccfSSadaf Ebrahimi             for (auto secondaryCmdBuffer : cb_node->linkedCommandBuffers) {
1256*b7893ccfSSadaf Ebrahimi                 UpdateInstrumentationBuffer(secondaryCmdBuffer);
1257*b7893ccfSSadaf Ebrahimi             }
1258*b7893ccfSSadaf Ebrahimi         }
1259*b7893ccfSSadaf Ebrahimi     }
1260*b7893ccfSSadaf Ebrahimi }
1261*b7893ccfSSadaf Ebrahimi 
1262*b7893ccfSSadaf Ebrahimi // Issue a memory barrier to make GPU-written data available to host.
1263*b7893ccfSSadaf Ebrahimi // Wait for the queue to complete execution.
1264*b7893ccfSSadaf Ebrahimi // Check the debug buffers for all the command buffers that were submitted.
GpuPostCallQueueSubmit(VkQueue queue,uint32_t submitCount,const VkSubmitInfo * pSubmits,VkFence fence)1265*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuPostCallQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo *pSubmits, VkFence fence) {
1266*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->aborted) return;
1267*b7893ccfSSadaf Ebrahimi 
1268*b7893ccfSSadaf Ebrahimi     SubmitBarrier(queue);
1269*b7893ccfSSadaf Ebrahimi 
1270*b7893ccfSSadaf Ebrahimi     DispatchQueueWaitIdle(queue);
1271*b7893ccfSSadaf Ebrahimi 
1272*b7893ccfSSadaf Ebrahimi     for (uint32_t submit_idx = 0; submit_idx < submitCount; submit_idx++) {
1273*b7893ccfSSadaf Ebrahimi         const VkSubmitInfo *submit = &pSubmits[submit_idx];
1274*b7893ccfSSadaf Ebrahimi         for (uint32_t i = 0; i < submit->commandBufferCount; i++) {
1275*b7893ccfSSadaf Ebrahimi             auto cb_node = GetCBState(submit->pCommandBuffers[i]);
1276*b7893ccfSSadaf Ebrahimi             ProcessInstrumentationBuffer(queue, cb_node);
1277*b7893ccfSSadaf Ebrahimi             for (auto secondaryCmdBuffer : cb_node->linkedCommandBuffers) {
1278*b7893ccfSSadaf Ebrahimi                 ProcessInstrumentationBuffer(queue, secondaryCmdBuffer);
1279*b7893ccfSSadaf Ebrahimi             }
1280*b7893ccfSSadaf Ebrahimi         }
1281*b7893ccfSSadaf Ebrahimi     }
1282*b7893ccfSSadaf Ebrahimi }
1283*b7893ccfSSadaf Ebrahimi 
GpuAllocateValidationResources(const VkCommandBuffer cmd_buffer,const VkPipelineBindPoint bind_point)1284*b7893ccfSSadaf Ebrahimi void CoreChecks::GpuAllocateValidationResources(const VkCommandBuffer cmd_buffer, const VkPipelineBindPoint bind_point) {
1285*b7893ccfSSadaf Ebrahimi     if (bind_point != VK_PIPELINE_BIND_POINT_GRAPHICS && bind_point != VK_PIPELINE_BIND_POINT_COMPUTE &&
1286*b7893ccfSSadaf Ebrahimi         bind_point != VK_PIPELINE_BIND_POINT_RAY_TRACING_NV) {
1287*b7893ccfSSadaf Ebrahimi         return;
1288*b7893ccfSSadaf Ebrahimi     }
1289*b7893ccfSSadaf Ebrahimi     VkResult result;
1290*b7893ccfSSadaf Ebrahimi 
1291*b7893ccfSSadaf Ebrahimi     if (!(enabled.gpu_validation)) return;
1292*b7893ccfSSadaf Ebrahimi 
1293*b7893ccfSSadaf Ebrahimi     if (gpu_validation_state->aborted) return;
1294*b7893ccfSSadaf Ebrahimi 
1295*b7893ccfSSadaf Ebrahimi     std::vector<VkDescriptorSet> desc_sets;
1296*b7893ccfSSadaf Ebrahimi     VkDescriptorPool desc_pool = VK_NULL_HANDLE;
1297*b7893ccfSSadaf Ebrahimi     result = gpu_validation_state->desc_set_manager->GetDescriptorSets(1, &desc_pool, &desc_sets);
1298*b7893ccfSSadaf Ebrahimi     assert(result == VK_SUCCESS);
1299*b7893ccfSSadaf Ebrahimi     if (result != VK_SUCCESS) {
1300*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
1301*b7893ccfSSadaf Ebrahimi                            "Unable to allocate descriptor sets.  Device could become unstable.");
1302*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
1303*b7893ccfSSadaf Ebrahimi         return;
1304*b7893ccfSSadaf Ebrahimi     }
1305*b7893ccfSSadaf Ebrahimi 
1306*b7893ccfSSadaf Ebrahimi     VkDescriptorBufferInfo output_desc_buffer_info = {};
1307*b7893ccfSSadaf Ebrahimi     output_desc_buffer_info.range = gpu_validation_state->output_buffer_size;
1308*b7893ccfSSadaf Ebrahimi 
1309*b7893ccfSSadaf Ebrahimi     auto cb_node = GetCBState(cmd_buffer);
1310*b7893ccfSSadaf Ebrahimi     if (!cb_node) {
1311*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device), "Unrecognized command buffer");
1312*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
1313*b7893ccfSSadaf Ebrahimi         return;
1314*b7893ccfSSadaf Ebrahimi     }
1315*b7893ccfSSadaf Ebrahimi 
1316*b7893ccfSSadaf Ebrahimi     // Allocate memory for the output block that the gpu will use to return any error information
1317*b7893ccfSSadaf Ebrahimi     GpuDeviceMemoryBlock output_block = {};
1318*b7893ccfSSadaf Ebrahimi     VkBufferCreateInfo bufferInfo = {VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO};
1319*b7893ccfSSadaf Ebrahimi     bufferInfo.size = gpu_validation_state->output_buffer_size;
1320*b7893ccfSSadaf Ebrahimi     bufferInfo.usage = VK_BUFFER_USAGE_STORAGE_BUFFER_BIT;
1321*b7893ccfSSadaf Ebrahimi     VmaAllocationCreateInfo allocInfo = {};
1322*b7893ccfSSadaf Ebrahimi     allocInfo.usage = VMA_MEMORY_USAGE_GPU_TO_CPU;
1323*b7893ccfSSadaf Ebrahimi     result = vmaCreateBuffer(gpu_validation_state->vmaAllocator, &bufferInfo, &allocInfo, &output_block.buffer,
1324*b7893ccfSSadaf Ebrahimi                              &output_block.allocation, nullptr);
1325*b7893ccfSSadaf Ebrahimi     if (result != VK_SUCCESS) {
1326*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
1327*b7893ccfSSadaf Ebrahimi                            "Unable to allocate device memory.  Device could become unstable.");
1328*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
1329*b7893ccfSSadaf Ebrahimi         return;
1330*b7893ccfSSadaf Ebrahimi     }
1331*b7893ccfSSadaf Ebrahimi 
1332*b7893ccfSSadaf Ebrahimi     // Clear the output block to zeros so that only error information from the gpu will be present
1333*b7893ccfSSadaf Ebrahimi     uint32_t *pData;
1334*b7893ccfSSadaf Ebrahimi     result = vmaMapMemory(gpu_validation_state->vmaAllocator, output_block.allocation, (void **)&pData);
1335*b7893ccfSSadaf Ebrahimi     if (result == VK_SUCCESS) {
1336*b7893ccfSSadaf Ebrahimi         memset(pData, 0, gpu_validation_state->output_buffer_size);
1337*b7893ccfSSadaf Ebrahimi         vmaUnmapMemory(gpu_validation_state->vmaAllocator, output_block.allocation);
1338*b7893ccfSSadaf Ebrahimi     }
1339*b7893ccfSSadaf Ebrahimi 
1340*b7893ccfSSadaf Ebrahimi     GpuDeviceMemoryBlock input_block = {};
1341*b7893ccfSSadaf Ebrahimi     VkWriteDescriptorSet desc_writes[2] = {};
1342*b7893ccfSSadaf Ebrahimi     uint32_t desc_count = 1;
1343*b7893ccfSSadaf Ebrahimi     auto const &state = cb_node->lastBound[bind_point];
1344*b7893ccfSSadaf Ebrahimi     uint32_t number_of_sets = (uint32_t)state.per_set.size();
1345*b7893ccfSSadaf Ebrahimi 
1346*b7893ccfSSadaf Ebrahimi     // Figure out how much memory we need for the input block based on how many sets and bindings there are
1347*b7893ccfSSadaf Ebrahimi     // and how big each of the bindings is
1348*b7893ccfSSadaf Ebrahimi     if (number_of_sets > 0 && device_extensions.vk_ext_descriptor_indexing) {
1349*b7893ccfSSadaf Ebrahimi         uint32_t descriptor_count = 0;  // Number of descriptors, including all array elements
1350*b7893ccfSSadaf Ebrahimi         uint32_t binding_count = 0;     // Number of bindings based on the max binding number used
1351*b7893ccfSSadaf Ebrahimi         for (auto s : state.per_set) {
1352*b7893ccfSSadaf Ebrahimi             auto desc = s.bound_descriptor_set;
1353*b7893ccfSSadaf Ebrahimi             auto bindings = desc->GetLayout()->GetSortedBindingSet();
1354*b7893ccfSSadaf Ebrahimi             if (bindings.size() > 0) {
1355*b7893ccfSSadaf Ebrahimi                 binding_count += desc->GetLayout()->GetMaxBinding() + 1;
1356*b7893ccfSSadaf Ebrahimi                 for (auto binding : bindings) {
1357*b7893ccfSSadaf Ebrahimi                     // Shader instrumentation is tracking inline uniform blocks as scalers. Don't try to validate inline uniform
1358*b7893ccfSSadaf Ebrahimi                     // blocks
1359*b7893ccfSSadaf Ebrahimi                     if (VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT == desc->GetLayout()->GetTypeFromBinding(binding)) {
1360*b7893ccfSSadaf Ebrahimi                         descriptor_count++;
1361*b7893ccfSSadaf Ebrahimi                         log_msg(report_data, VK_DEBUG_REPORT_WARNING_BIT_EXT, VK_DEBUG_REPORT_OBJECT_TYPE_DESCRIPTOR_SET_EXT,
1362*b7893ccfSSadaf Ebrahimi                                 VK_NULL_HANDLE, "UNASSIGNED-GPU-Assisted Validation Warning",
1363*b7893ccfSSadaf Ebrahimi                                 "VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT descriptors will not be validated by GPU assisted "
1364*b7893ccfSSadaf Ebrahimi                                 "validation");
1365*b7893ccfSSadaf Ebrahimi                     } else if (binding == desc->GetLayout()->GetMaxBinding() && desc->IsVariableDescriptorCount(binding)) {
1366*b7893ccfSSadaf Ebrahimi                         descriptor_count += desc->GetVariableDescriptorCount();
1367*b7893ccfSSadaf Ebrahimi                     } else {
1368*b7893ccfSSadaf Ebrahimi                         descriptor_count += desc->GetDescriptorCountFromBinding(binding);
1369*b7893ccfSSadaf Ebrahimi                     }
1370*b7893ccfSSadaf Ebrahimi                 }
1371*b7893ccfSSadaf Ebrahimi             }
1372*b7893ccfSSadaf Ebrahimi         }
1373*b7893ccfSSadaf Ebrahimi 
1374*b7893ccfSSadaf Ebrahimi         // Note that the size of the input buffer is dependent on the maximum binding number, which
1375*b7893ccfSSadaf Ebrahimi         // can be very large.  This is because for (set = s, binding = b, index = i), the validation
1376*b7893ccfSSadaf Ebrahimi         // code is going to dereference Input[ i + Input[ b + Input[ s + Input[ Input[0] ] ] ] ] to
1377*b7893ccfSSadaf Ebrahimi         // see if descriptors have been written. In gpu_validation.md, we note this and advise
1378*b7893ccfSSadaf Ebrahimi         // using densely packed bindings as a best practice when using gpu-av with descriptor indexing
1379*b7893ccfSSadaf Ebrahimi         uint32_t words_needed = 1 + (number_of_sets * 2) + (binding_count * 2) + descriptor_count;
1380*b7893ccfSSadaf Ebrahimi         allocInfo.usage = VMA_MEMORY_USAGE_CPU_TO_GPU;
1381*b7893ccfSSadaf Ebrahimi         bufferInfo.size = words_needed * 4;
1382*b7893ccfSSadaf Ebrahimi         result = vmaCreateBuffer(gpu_validation_state->vmaAllocator, &bufferInfo, &allocInfo, &input_block.buffer,
1383*b7893ccfSSadaf Ebrahimi                                  &input_block.allocation, nullptr);
1384*b7893ccfSSadaf Ebrahimi         if (result != VK_SUCCESS) {
1385*b7893ccfSSadaf Ebrahimi             ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device),
1386*b7893ccfSSadaf Ebrahimi                                "Unable to allocate device memory.  Device could become unstable.");
1387*b7893ccfSSadaf Ebrahimi             gpu_validation_state->aborted = true;
1388*b7893ccfSSadaf Ebrahimi             return;
1389*b7893ccfSSadaf Ebrahimi         }
1390*b7893ccfSSadaf Ebrahimi 
1391*b7893ccfSSadaf Ebrahimi         // Populate input buffer first with the sizes of every descriptor in every set, then with whether
1392*b7893ccfSSadaf Ebrahimi         // each element of each descriptor has been written or not.  See gpu_validation.md for a more thourough
1393*b7893ccfSSadaf Ebrahimi         // outline of the input buffer format
1394*b7893ccfSSadaf Ebrahimi         result = vmaMapMemory(gpu_validation_state->vmaAllocator, input_block.allocation, (void **)&pData);
1395*b7893ccfSSadaf Ebrahimi         memset(pData, 0, static_cast<size_t>(bufferInfo.size));
1396*b7893ccfSSadaf Ebrahimi         // Pointer to a sets array that points into the sizes array
1397*b7893ccfSSadaf Ebrahimi         uint32_t *sets_to_sizes = pData + 1;
1398*b7893ccfSSadaf Ebrahimi         // Pointer to the sizes array that contains the array size of the descriptor at each binding
1399*b7893ccfSSadaf Ebrahimi         uint32_t *sizes = sets_to_sizes + number_of_sets;
1400*b7893ccfSSadaf Ebrahimi         // Pointer to another sets array that points into the bindings array that points into the written array
1401*b7893ccfSSadaf Ebrahimi         uint32_t *sets_to_bindings = sizes + binding_count;
1402*b7893ccfSSadaf Ebrahimi         // Pointer to the bindings array that points at the start of the writes in the writes array for each binding
1403*b7893ccfSSadaf Ebrahimi         uint32_t *bindings_to_written = sets_to_bindings + number_of_sets;
1404*b7893ccfSSadaf Ebrahimi         // Index of the next entry in the written array to be updated
1405*b7893ccfSSadaf Ebrahimi         uint32_t written_index = 1 + (number_of_sets * 2) + (binding_count * 2);
1406*b7893ccfSSadaf Ebrahimi         uint32_t bindCounter = number_of_sets + 1;
1407*b7893ccfSSadaf Ebrahimi         // Index of the start of the sets_to_bindings array
1408*b7893ccfSSadaf Ebrahimi         pData[0] = number_of_sets + binding_count + 1;
1409*b7893ccfSSadaf Ebrahimi 
1410*b7893ccfSSadaf Ebrahimi         for (auto s : state.per_set) {
1411*b7893ccfSSadaf Ebrahimi             auto desc = s.bound_descriptor_set;
1412*b7893ccfSSadaf Ebrahimi             auto layout = desc->GetLayout();
1413*b7893ccfSSadaf Ebrahimi             auto bindings = layout->GetSortedBindingSet();
1414*b7893ccfSSadaf Ebrahimi             if (bindings.size() > 0) {
1415*b7893ccfSSadaf Ebrahimi                 // For each set, fill in index of its bindings sizes in the sizes array
1416*b7893ccfSSadaf Ebrahimi                 *sets_to_sizes++ = bindCounter;
1417*b7893ccfSSadaf Ebrahimi                 // For each set, fill in the index of its bindings in the bindings_to_written array
1418*b7893ccfSSadaf Ebrahimi                 *sets_to_bindings++ = bindCounter + number_of_sets + binding_count;
1419*b7893ccfSSadaf Ebrahimi                 for (auto binding : bindings) {
1420*b7893ccfSSadaf Ebrahimi                     // For each binding, fill in its size in the sizes array
1421*b7893ccfSSadaf Ebrahimi                     // Shader instrumentation is tracking inline uniform blocks as scalers. Don't try to validate inline uniform
1422*b7893ccfSSadaf Ebrahimi                     // blocks
1423*b7893ccfSSadaf Ebrahimi                     if (VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT == desc->GetLayout()->GetTypeFromBinding(binding)) {
1424*b7893ccfSSadaf Ebrahimi                         sizes[binding] = 1;
1425*b7893ccfSSadaf Ebrahimi                     } else if (binding == layout->GetMaxBinding() && desc->IsVariableDescriptorCount(binding)) {
1426*b7893ccfSSadaf Ebrahimi                         sizes[binding] = desc->GetVariableDescriptorCount();
1427*b7893ccfSSadaf Ebrahimi                     } else {
1428*b7893ccfSSadaf Ebrahimi                         sizes[binding] = desc->GetDescriptorCountFromBinding(binding);
1429*b7893ccfSSadaf Ebrahimi                     }
1430*b7893ccfSSadaf Ebrahimi                     // Fill in the starting index for this binding in the written array in the bindings_to_written array
1431*b7893ccfSSadaf Ebrahimi                     bindings_to_written[binding] = written_index;
1432*b7893ccfSSadaf Ebrahimi 
1433*b7893ccfSSadaf Ebrahimi                     // Shader instrumentation is tracking inline uniform blocks as scalers. Don't try to validate inline uniform
1434*b7893ccfSSadaf Ebrahimi                     // blocks
1435*b7893ccfSSadaf Ebrahimi                     if (VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK_EXT == desc->GetLayout()->GetTypeFromBinding(binding)) {
1436*b7893ccfSSadaf Ebrahimi                         pData[written_index++] = 1;
1437*b7893ccfSSadaf Ebrahimi                         continue;
1438*b7893ccfSSadaf Ebrahimi                     }
1439*b7893ccfSSadaf Ebrahimi 
1440*b7893ccfSSadaf Ebrahimi                     auto index_range = desc->GetGlobalIndexRangeFromBinding(binding, true);
1441*b7893ccfSSadaf Ebrahimi                     // For each array element in the binding, update the written array with whether it has been written
1442*b7893ccfSSadaf Ebrahimi                     for (uint32_t i = index_range.start; i < index_range.end; ++i) {
1443*b7893ccfSSadaf Ebrahimi                         auto *descriptor = desc->GetDescriptorFromGlobalIndex(i);
1444*b7893ccfSSadaf Ebrahimi                         if (descriptor->updated) {
1445*b7893ccfSSadaf Ebrahimi                             pData[written_index] = 1;
1446*b7893ccfSSadaf Ebrahimi                         } else if (desc->IsUpdateAfterBind(binding)) {
1447*b7893ccfSSadaf Ebrahimi                             // If it hasn't been written now and it's update after bind, put it in a list to check at QueueSubmit
1448*b7893ccfSSadaf Ebrahimi                             input_block.update_at_submit[written_index] = descriptor;
1449*b7893ccfSSadaf Ebrahimi                         }
1450*b7893ccfSSadaf Ebrahimi                         written_index++;
1451*b7893ccfSSadaf Ebrahimi                     }
1452*b7893ccfSSadaf Ebrahimi                 }
1453*b7893ccfSSadaf Ebrahimi                 auto last = desc->GetLayout()->GetMaxBinding();
1454*b7893ccfSSadaf Ebrahimi                 bindings_to_written += last + 1;
1455*b7893ccfSSadaf Ebrahimi                 bindCounter += last + 1;
1456*b7893ccfSSadaf Ebrahimi                 sizes += last + 1;
1457*b7893ccfSSadaf Ebrahimi             } else {
1458*b7893ccfSSadaf Ebrahimi                 *sets_to_sizes++ = 0;
1459*b7893ccfSSadaf Ebrahimi                 *sets_to_bindings++ = 0;
1460*b7893ccfSSadaf Ebrahimi             }
1461*b7893ccfSSadaf Ebrahimi         }
1462*b7893ccfSSadaf Ebrahimi         vmaUnmapMemory(gpu_validation_state->vmaAllocator, input_block.allocation);
1463*b7893ccfSSadaf Ebrahimi 
1464*b7893ccfSSadaf Ebrahimi         VkDescriptorBufferInfo input_desc_buffer_info = {};
1465*b7893ccfSSadaf Ebrahimi         input_desc_buffer_info.range = (words_needed * 4);
1466*b7893ccfSSadaf Ebrahimi         input_desc_buffer_info.buffer = input_block.buffer;
1467*b7893ccfSSadaf Ebrahimi         input_desc_buffer_info.offset = 0;
1468*b7893ccfSSadaf Ebrahimi 
1469*b7893ccfSSadaf Ebrahimi         desc_writes[1].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1470*b7893ccfSSadaf Ebrahimi         desc_writes[1].dstBinding = 1;
1471*b7893ccfSSadaf Ebrahimi         desc_writes[1].descriptorCount = 1;
1472*b7893ccfSSadaf Ebrahimi         desc_writes[1].descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
1473*b7893ccfSSadaf Ebrahimi         desc_writes[1].pBufferInfo = &input_desc_buffer_info;
1474*b7893ccfSSadaf Ebrahimi         desc_writes[1].dstSet = desc_sets[0];
1475*b7893ccfSSadaf Ebrahimi 
1476*b7893ccfSSadaf Ebrahimi         desc_count = 2;
1477*b7893ccfSSadaf Ebrahimi     }
1478*b7893ccfSSadaf Ebrahimi 
1479*b7893ccfSSadaf Ebrahimi     // Write the descriptor
1480*b7893ccfSSadaf Ebrahimi     output_desc_buffer_info.buffer = output_block.buffer;
1481*b7893ccfSSadaf Ebrahimi     output_desc_buffer_info.offset = 0;
1482*b7893ccfSSadaf Ebrahimi 
1483*b7893ccfSSadaf Ebrahimi     desc_writes[0].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
1484*b7893ccfSSadaf Ebrahimi     desc_writes[0].descriptorCount = 1;
1485*b7893ccfSSadaf Ebrahimi     desc_writes[0].descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
1486*b7893ccfSSadaf Ebrahimi     desc_writes[0].pBufferInfo = &output_desc_buffer_info;
1487*b7893ccfSSadaf Ebrahimi     desc_writes[0].dstSet = desc_sets[0];
1488*b7893ccfSSadaf Ebrahimi     DispatchUpdateDescriptorSets(device, desc_count, desc_writes, 0, NULL);
1489*b7893ccfSSadaf Ebrahimi 
1490*b7893ccfSSadaf Ebrahimi     auto iter = cb_node->lastBound.find(bind_point);  // find() allows read-only access to cb_state
1491*b7893ccfSSadaf Ebrahimi     if (iter != cb_node->lastBound.end()) {
1492*b7893ccfSSadaf Ebrahimi         auto pipeline_state = iter->second.pipeline_state;
1493*b7893ccfSSadaf Ebrahimi         if (pipeline_state && (pipeline_state->pipeline_layout.set_layouts.size() <= gpu_validation_state->desc_set_bind_index)) {
1494*b7893ccfSSadaf Ebrahimi             DispatchCmdBindDescriptorSets(cmd_buffer, bind_point, pipeline_state->pipeline_layout.layout,
1495*b7893ccfSSadaf Ebrahimi                                           gpu_validation_state->desc_set_bind_index, 1, desc_sets.data(), 0, nullptr);
1496*b7893ccfSSadaf Ebrahimi         }
1497*b7893ccfSSadaf Ebrahimi         // Record buffer and memory info in CB state tracking
1498*b7893ccfSSadaf Ebrahimi         gpu_validation_state->GetGpuBufferInfo(cmd_buffer)
1499*b7893ccfSSadaf Ebrahimi             .emplace_back(output_block, input_block, desc_sets[0], desc_pool, bind_point);
1500*b7893ccfSSadaf Ebrahimi     } else {
1501*b7893ccfSSadaf Ebrahimi         ReportSetupProblem(VK_DEBUG_REPORT_OBJECT_TYPE_DEVICE_EXT, HandleToUint64(device), "Unable to find pipeline state");
1502*b7893ccfSSadaf Ebrahimi         vmaDestroyBuffer(gpu_validation_state->vmaAllocator, input_block.buffer, input_block.allocation);
1503*b7893ccfSSadaf Ebrahimi         vmaDestroyBuffer(gpu_validation_state->vmaAllocator, output_block.buffer, output_block.allocation);
1504*b7893ccfSSadaf Ebrahimi         gpu_validation_state->aborted = true;
1505*b7893ccfSSadaf Ebrahimi         return;
1506*b7893ccfSSadaf Ebrahimi     }
1507*b7893ccfSSadaf Ebrahimi }
1508