blob: 27ffb697531d151dd00624f84c4e5d7c6e41b143 [file] [log] [blame]
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -07001/* Copyright (c) 2015-2020 The Khronos Group Inc.
2 * Copyright (c) 2015-2020 Valve Corporation
3 * Copyright (c) 2015-2020 LunarG, Inc.
Camdeneaa86ea2019-07-26 11:00:09 -06004 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 * Author: Camden Stocker <camden@lunarg.com>
18 */
19
Camden3231dcc2019-08-05 11:28:57 -060020#include "best_practices.h"
Camden5b184be2019-08-13 07:50:19 -060021#include "layer_chassis_dispatch.h"
Camden Stocker0a660ce2019-08-27 15:30:40 -060022#include "best_practices_error_enums.h"
Camden5b184be2019-08-13 07:50:19 -060023
24#include <string>
25#include <iomanip>
26
27// get the API name is proper format
Jeff Bolz46c0ea02019-10-09 13:06:29 -050028std::string BestPractices::GetAPIVersionName(uint32_t version) const {
Camden5b184be2019-08-13 07:50:19 -060029 std::stringstream version_name;
30 uint32_t major = VK_VERSION_MAJOR(version);
31 uint32_t minor = VK_VERSION_MINOR(version);
32 uint32_t patch = VK_VERSION_PATCH(version);
33
34 version_name << major << "." << minor << "." << patch << " (0x" << std::setfill('0') << std::setw(8) << std::hex << version
35 << ")";
36
37 return version_name.str();
38}
39
40bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -050041 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -060042 bool skip = false;
43
44 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
45 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -080046 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -070047 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
48 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -060049 }
Camden Stocker11ecf512020-01-21 16:06:49 -080050
51 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeprecatedExtensionNames)) {
52 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_DeprecatedExtension,
53 "vkCreateInstance(): Attempting to enable Deprecated Extension %s at CreateInstance time.",
54 pCreateInfo->ppEnabledExtensionNames[i]);
55 }
Camden5b184be2019-08-13 07:50:19 -060056 }
57
58 return skip;
59}
60
61void BestPractices::PreCallRecordCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
62 VkInstance* pInstance) {
63 instance_api_version = pCreateInfo->pApplicationInfo->apiVersion;
64}
65
66bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -050067 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -060068 bool skip = false;
69
70 // get API version of physical device passed when creating device.
71 VkPhysicalDeviceProperties physical_device_properties{};
72 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -050073 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -060074
75 // check api versions and warn if instance api Version is higher than version on device.
76 if (instance_api_version > device_api_version) {
77 std::string inst_api_name = GetAPIVersionName(instance_api_version);
78 std::string dev_api_name = GetAPIVersionName(device_api_version);
79
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -070080 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
81 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
82 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -060083 }
84
85 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
86 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -080087 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -070088 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
89 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -060090 }
Camden Stocker11ecf512020-01-21 16:06:49 -080091 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeprecatedExtensionNames)) {
92 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_DeprecatedExtension,
93 "vkCreateDevice(): Attempting to enable Deprecated Extension %s at CreateDevice time.",
94 pCreateInfo->ppEnabledExtensionNames[i]);
95 }
Camden5b184be2019-08-13 07:50:19 -060096 }
97
Camden83a9c372019-08-14 11:41:38 -060098 auto pd_state = GetPhysicalDeviceState(physicalDevice);
Corta48da1d2019-09-20 18:59:07 +020099 if ((pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700100 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
101 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600102 }
103
Camden5b184be2019-08-13 07:50:19 -0600104 return skip;
105}
106
107bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500108 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600109 bool skip = false;
110
111 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
112 std::stringstream bufferHex;
113 bufferHex << "0x" << std::hex << HandleToUint64(pBuffer);
114
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700115 skip |= LogWarning(
116 device, kVUID_BestPractices_SharingModeExclusive,
117 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
118 "(queueFamilyIndexCount of %" PRIu32 ").",
119 bufferHex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600120 }
121
122 return skip;
123}
124
125bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500126 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600127 bool skip = false;
128
129 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
130 std::stringstream imageHex;
131 imageHex << "0x" << std::hex << HandleToUint64(pImage);
132
133 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700134 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
135 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
136 "(queueFamilyIndexCount of %" PRIu32 ").",
137 imageHex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600138 }
139
140 return skip;
141}
142
143bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500144 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600145 bool skip = false;
146
Camden83a9c372019-08-14 11:41:38 -0600147 auto physical_device_state = GetPhysicalDeviceState();
148
149 if (physical_device_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700150 skip |= LogWarning(
151 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
Camden83a9c372019-08-14 11:41:38 -0600152 "vkCreateSwapchainKHR() called before getting surface capabilities from vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
153 }
154
155 if (physical_device_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700156 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
157 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
158 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
Camden83a9c372019-08-14 11:41:38 -0600159 }
160
161 if (physical_device_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700162 skip |= LogWarning(
163 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
164 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
Camden83a9c372019-08-14 11:41:38 -0600165 }
166
Camden5b184be2019-08-13 07:50:19 -0600167 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700168 skip |=
169 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
170 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCULSIVE while "
171 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
172 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600173 }
174
175 return skip;
176}
177
178bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
179 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500180 const VkAllocationCallbacks* pAllocator,
181 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600182 bool skip = false;
183
184 for (uint32_t i = 0; i < swapchainCount; i++) {
185 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700186 skip |= LogWarning(
187 device, kVUID_BestPractices_SharingModeExclusive,
188 "Warning: A shared swapchain (index %" PRIu32
189 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
190 "queues (queueFamilyIndexCount of %" PRIu32 ").",
191 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600192 }
193 }
194
195 return skip;
196}
197
198bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500199 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600200 bool skip = false;
201
202 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
203 VkFormat format = pCreateInfo->pAttachments[i].format;
204 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
205 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
206 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700207 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
208 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
209 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
210 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
211 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600212 }
213 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700214 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
215 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
216 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
217 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
218 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600219 }
220 }
221 }
222
223 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
224 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
225 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
226 }
227
228 return skip;
229}
230
231bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500232 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600233 bool skip = false;
234
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500235 if (num_mem_objects + 1 > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700236 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
237 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600238 }
239
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000240 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
241 skip |= LogPerformanceWarning(
242 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
243 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %llu. This is a very small allocation (current "
244 "threshold is %llu bytes). "
245 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
246 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
247 }
248
Camden83a9c372019-08-14 11:41:38 -0600249 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
250
251 return skip;
252}
253
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500254void BestPractices::PostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
255 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
256 VkResult result) {
Camden Stocker9738af92019-10-16 13:54:03 -0700257 ValidationStateTracker::PostCallRecordAllocateMemory(device, pAllocateInfo, pAllocator, pMemory, result);
258
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500259 if (VK_SUCCESS == result) {
260 num_mem_objects++;
261 }
262}
263
Jeff Bolz5c801d12019-10-09 10:38:45 -0500264bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
265 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700266 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600267 bool skip = false;
268
Camden Stocker9738af92019-10-16 13:54:03 -0700269 const DEVICE_MEMORY_STATE* mem_info = ValidationStateTracker::GetDevMemState(memory);
Camden83a9c372019-08-14 11:41:38 -0600270
271 for (auto& obj : mem_info->obj_bindings) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700272 skip |= LogWarning(device, layer_name.c_str(), "VK Object %s still has a reference to mem obj %s.",
273 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem).c_str());
Camden83a9c372019-08-14 11:41:38 -0600274 }
275
Camden5b184be2019-08-13 07:50:19 -0600276 return skip;
277}
278
279void BestPractices::PreCallRecordFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks* pAllocator) {
280 if (memory != VK_NULL_HANDLE) {
281 num_mem_objects--;
282 }
283}
284
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000285bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600286 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500287 const BUFFER_STATE* buffer_state = GetBufferState(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600288
sfricke-samsunge2441192019-11-06 14:07:57 -0800289 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700290 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
291 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
292 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600293 }
294
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000295 const DEVICE_MEMORY_STATE* mem_state = GetDevMemState(memory);
296
297 if (mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
298 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
299 skip |= LogPerformanceWarning(
300 device, kVUID_BestPractices_SmallDedicatedAllocation,
301 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
302 "The required size of the allocation is %llu, but smaller buffers like this should be sub-allocated from "
303 "larger memory blocks. (Current threshold is %llu bytes.)",
304 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
305 }
306
Camden Stockerb603cc82019-09-03 10:09:02 -0600307 return skip;
308}
309
310bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500311 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600312 bool skip = false;
313 const char* api_name = "BindBufferMemory()";
314
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000315 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600316
317 return skip;
318}
319
320bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500321 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600322 char api_name[64];
323 bool skip = false;
324
325 for (uint32_t i = 0; i < bindInfoCount; i++) {
326 sprintf(api_name, "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000327 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600328 }
329
330 return skip;
331}
Camden Stockerb603cc82019-09-03 10:09:02 -0600332
333bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500334 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600335 char api_name[64];
336 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600337
Camden Stocker8b798ab2019-09-03 10:33:28 -0600338 for (uint32_t i = 0; i < bindInfoCount; i++) {
339 sprintf(api_name, "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000340 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600341 }
342
343 return skip;
344}
345
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000346bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600347 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500348 const IMAGE_STATE* image_state = GetImageState(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600349
sfricke-samsunge2441192019-11-06 14:07:57 -0800350 if (!image_state->memory_requirements_checked && !image_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700351 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
352 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
353 api_name, report_data->FormatHandle(image).c_str());
Camden Stocker8b798ab2019-09-03 10:33:28 -0600354 }
355
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000356 const DEVICE_MEMORY_STATE* mem_state = GetDevMemState(memory);
357
358 if (mem_state->alloc_info.allocationSize == image_state->requirements.size &&
359 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
360 skip |= LogPerformanceWarning(
361 device, kVUID_BestPractices_SmallDedicatedAllocation,
362 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
363 "The required size of the allocation is %llu, but smaller images like this should be sub-allocated from "
364 "larger memory blocks. (Current threshold is %llu bytes.)",
365 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
366 }
367
368 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
369 // make sure this type is actually used.
370 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
371 // (i.e.most tile - based renderers)
372 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
373 bool supports_lazy = false;
374 uint32_t suggested_type = 0;
375
376 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
377 if ((1u << i) & image_state->requirements.memoryTypeBits) {
378 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
379 supports_lazy = true;
380 suggested_type = i;
381 break;
382 }
383 }
384 }
385
386 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
387
388 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
389 skip |= LogPerformanceWarning(
390 device, kVUID_BestPractices_NonLazyTransientImage,
391 "%s: Attempting to bind memory type % u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
392 "but this memory type is not LAZILY_ALLOCATED_BIT. You should use memory type %u here instead to save "
393 "%llu bytes of physical memory.",
394 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements.size);
395 }
396 }
397
Camden Stocker8b798ab2019-09-03 10:33:28 -0600398 return skip;
399}
400
401bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500402 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600403 bool skip = false;
404 const char* api_name = "vkBindImageMemory()";
405
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000406 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600407
408 return skip;
409}
410
411bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500412 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600413 char api_name[64];
414 bool skip = false;
415
416 for (uint32_t i = 0; i < bindInfoCount; i++) {
417 sprintf(api_name, "vkBindImageMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000418 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600419 }
420
421 return skip;
422}
423
424bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500425 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600426 char api_name[64];
427 bool skip = false;
428
429 for (uint32_t i = 0; i < bindInfoCount; i++) {
430 sprintf(api_name, "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000431 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600432 }
433
434 return skip;
435}
Camden83a9c372019-08-14 11:41:38 -0600436
Camden5b184be2019-08-13 07:50:19 -0600437bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
438 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600439 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500440 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600441 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
442 pAllocator, pPipelines, cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600443
444 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700445 skip |= LogPerformanceWarning(
446 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
447 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
448 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600449 }
450
451 return skip;
452}
453
454bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
455 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600456 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500457 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600458 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
459 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600460
461 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700462 skip |= LogPerformanceWarning(
463 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
464 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
465 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600466 }
467
468 return skip;
469}
470
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500471bool BestPractices::CheckPipelineStageFlags(std::string api_name, const VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -0600472 bool skip = false;
473
474 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700475 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
476 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600477 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700478 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
479 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600480 }
481
482 return skip;
483}
484
Jeff Bolz5c801d12019-10-09 10:38:45 -0500485bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
486 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -0600487 bool skip = false;
488
489 for (uint32_t submit = 0; submit < submitCount; submit++) {
490 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
491 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
492 }
493 }
494
495 return skip;
496}
497
Attilio Provenzano746e43e2020-02-27 11:23:50 +0000498bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
499 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
500 bool skip = false;
501
502 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
503 skip |= LogPerformanceWarning(
504 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
505 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
506 "pool instead.");
507 }
508
509 return skip;
510}
511
512bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
513 const VkCommandBufferBeginInfo* pBeginInfo) const {
514 bool skip = false;
515
516 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
517 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
518 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
519 }
520
521 return skip;
522}
523
Jeff Bolz5c801d12019-10-09 10:38:45 -0500524bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -0600525 bool skip = false;
526
527 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
528
529 return skip;
530}
531
Jeff Bolz5c801d12019-10-09 10:38:45 -0500532bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
533 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -0600534 bool skip = false;
535
536 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
537
538 return skip;
539}
540
541bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
542 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
543 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
544 uint32_t bufferMemoryBarrierCount,
545 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
546 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500547 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -0600548 bool skip = false;
549
550 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
551 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
552
553 return skip;
554}
555
556bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
557 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
558 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
559 uint32_t bufferMemoryBarrierCount,
560 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
561 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500562 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -0600563 bool skip = false;
564
565 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
566 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
567
568 return skip;
569}
570
571bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500572 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -0600573 bool skip = false;
574
575 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", pipelineStage);
576
577 return skip;
578}
579
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -0700580// Generic function to handle validation for all CmdDraw* type functions
581bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
582 bool skip = false;
583 const CMD_BUFFER_STATE* cb_state = GetCBState(cmd_buffer);
584 if (cb_state) {
585 const auto last_bound_it = cb_state->lastBound.find(VK_PIPELINE_BIND_POINT_GRAPHICS);
586 const PIPELINE_STATE* pipeline_state = nullptr;
587 if (last_bound_it != cb_state->lastBound.cend()) {
588 pipeline_state = last_bound_it->second.pipeline_state;
589 }
590 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
591 // Verify vertex binding
592 if (pipeline_state->vertex_binding_descriptions_.size() <= 0) {
593 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700594 skip |= LogPerformanceWarning(cb_state->commandBuffer, kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
595 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
596 report_data->FormatHandle(cb_state->commandBuffer).c_str(),
597 report_data->FormatHandle(pipeline_state->pipeline).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -0700598 }
599 }
600 }
601 return skip;
602}
603
Camden5b184be2019-08-13 07:50:19 -0600604bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500605 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600606 bool skip = false;
607
608 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700609 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
610 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -0700611 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -0600612 }
613
614 return skip;
615}
616
617bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500618 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600619 bool skip = false;
620
621 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700622 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
623 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -0600624 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -0700625 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
626
627 return skip;
628}
629
630bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
631 VkDeviceSize offset, VkBuffer countBuffer,
632 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
633 uint32_t stride) const {
634 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -0600635
636 return skip;
637}
638
639bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500640 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -0600641 bool skip = false;
642
643 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700644 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
645 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -0700646 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -0600647 }
648
649 return skip;
650}
651
652bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500653 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -0600654 bool skip = false;
655
656 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700657 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
658 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -0700659 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -0600660 }
661
662 return skip;
663}
664
665bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500666 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -0600667 bool skip = false;
668
669 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700670 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
671 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
672 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
673 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -0600674 }
675
676 return skip;
677}
Camden83a9c372019-08-14 11:41:38 -0600678
Camden Stocker9c051442019-11-06 14:28:43 -0800679bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
680 const char* api_name) const {
681 bool skip = false;
682 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
683
684 if (physical_device_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700685 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
686 "Potential problem with calling %s() without first retrieving properties from "
687 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
688 api_name);
Camden Stocker9c051442019-11-06 14:28:43 -0800689 }
690
691 return skip;
692}
693
Camden83a9c372019-08-14 11:41:38 -0600694bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500695 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -0600696 bool skip = false;
697
Camden Stocker9c051442019-11-06 14:28:43 -0800698 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -0600699
Camden Stocker9c051442019-11-06 14:28:43 -0800700 return skip;
701}
702
703bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
704 uint32_t planeIndex,
705 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
706 bool skip = false;
707
708 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
709
710 return skip;
711}
712
713bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
714 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
715 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
716 bool skip = false;
717
718 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -0600719
720 return skip;
721}
Camden05de2d42019-08-19 10:23:56 -0600722
723bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500724 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -0600725 bool skip = false;
726
727 auto swapchain_state = GetSwapchainState(swapchain);
728
729 if (swapchain_state && pSwapchainImages) {
730 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
731 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700732 skip |=
733 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
734 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
735 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -0600736 }
737 }
738
739 return skip;
740}
741
742// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700743bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* pd_state,
744 uint32_t requested_queue_family_property_count,
745 bool qfp_null, const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -0600746 bool skip = false;
747 if (!qfp_null) {
748 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
749 if (UNCALLED == pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700750 skip |= LogWarning(
751 pd_state->phys_device, kVUID_Core_DevLimit_MissingQueryCount,
Camden05de2d42019-08-19 10:23:56 -0600752 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is recommended "
753 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
754 caller_name, caller_name);
755 // Then verify that pCount that is passed in on second call matches what was returned
756 } else if (pd_state->queue_family_known_count != requested_queue_family_property_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700757 skip |= LogWarning(
758 pd_state->phys_device, kVUID_Core_DevLimit_CountMismatch,
Camden05de2d42019-08-19 10:23:56 -0600759 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
760 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
761 ". It is recommended to instead receive all the properties by calling %s with pQueueFamilyPropertyCount that was "
762 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
763 caller_name, requested_queue_family_property_count, pd_state->queue_family_known_count, caller_name, caller_name);
764 }
765 }
766
767 return skip;
768}
769
Jeff Bolz5c801d12019-10-09 10:38:45 -0500770bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
771 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -0600772 bool skip = false;
773
774 for (uint32_t i = 0; i < bindInfoCount; i++) {
775 const ACCELERATION_STRUCTURE_STATE* as_state = GetAccelerationStructureState(pBindInfos[i].accelerationStructure);
776 if (!as_state->memory_requirements_checked) {
777 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
778 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
779 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700780 skip |= LogWarning(
781 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -0600782 "vkBindAccelerationStructureMemoryNV(): "
783 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
784 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
785 }
786 }
787
788 return skip;
789}
790
Camden05de2d42019-08-19 10:23:56 -0600791bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
792 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500793 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Camden05de2d42019-08-19 10:23:56 -0600794 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
795 assert(physical_device_state);
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700796 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(physical_device_state, *pQueueFamilyPropertyCount,
Camden05de2d42019-08-19 10:23:56 -0600797 (nullptr == pQueueFamilyProperties),
798 "vkGetPhysicalDeviceQueueFamilyProperties()");
799}
800
Jeff Bolz5c801d12019-10-09 10:38:45 -0500801bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(
802 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount,
803 VkQueueFamilyProperties2KHR* pQueueFamilyProperties) const {
Camden05de2d42019-08-19 10:23:56 -0600804 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
805 assert(physical_device_state);
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700806 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(physical_device_state, *pQueueFamilyPropertyCount,
Camden05de2d42019-08-19 10:23:56 -0600807 (nullptr == pQueueFamilyProperties),
808 "vkGetPhysicalDeviceQueueFamilyProperties2()");
809}
810
Jeff Bolz5c801d12019-10-09 10:38:45 -0500811bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
812 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount,
813 VkQueueFamilyProperties2KHR* pQueueFamilyProperties) const {
Camden05de2d42019-08-19 10:23:56 -0600814 auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
815 assert(physical_device_state);
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700816 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(physical_device_state, *pQueueFamilyPropertyCount,
Camden05de2d42019-08-19 10:23:56 -0600817 (nullptr == pQueueFamilyProperties),
818 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
819}
820
821bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
822 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500823 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -0600824 if (!pSurfaceFormats) return false;
825 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
826 const auto& call_state = physical_device_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
827 bool skip = false;
828 if (call_state == UNCALLED) {
829 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
830 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700831 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
832 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
833 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -0600834 } else {
835 auto prev_format_count = (uint32_t)physical_device_state->surface_formats.size();
Peter Chene191bd72019-09-16 13:04:37 -0400836 if (*pSurfaceFormatCount > prev_format_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700837 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
838 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
839 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
840 "when pSurfaceFormatCount was NULL.",
841 *pSurfaceFormatCount, prev_format_count);
Camden05de2d42019-08-19 10:23:56 -0600842 }
843 }
844 return skip;
845}
Camden Stocker23cc47d2019-09-03 14:53:57 -0600846
847bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500848 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -0600849 bool skip = false;
850
851 for (uint32_t bindIdx = 0; bindIdx < bindInfoCount; bindIdx++) {
852 const VkBindSparseInfo& bindInfo = pBindInfo[bindIdx];
853 // Store sparse binding image_state and after binding is complete make sure that any requiring metadata have it bound
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500854 std::unordered_set<const IMAGE_STATE*> sparse_images;
855 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
856 // in RecordQueueBindSparse.
857 std::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -0600858 // If we're binding sparse image memory make sure reqs were queried and note if metadata is required and bound
859 for (uint32_t i = 0; i < bindInfo.imageBindCount; ++i) {
860 const auto& image_bind = bindInfo.pImageBinds[i];
861 auto image_state = GetImageState(image_bind.image);
862 if (!image_state)
863 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
864 sparse_images.insert(image_state);
865 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
866 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
867 // For now just warning if sparse image binding occurs without calling to get reqs first
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700868 skip |= LogWarning(image_state->image, kVUID_Core_MemTrack_InvalidState,
869 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
870 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
871 report_data->FormatHandle(image_state->image).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -0600872 }
873 }
874 if (!image_state->memory_requirements_checked) {
875 // For now just warning if sparse image binding occurs without calling to get reqs first
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700876 skip |= LogWarning(image_state->image, kVUID_Core_MemTrack_InvalidState,
877 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
878 "vkGetImageMemoryRequirements() to retrieve requirements.",
879 report_data->FormatHandle(image_state->image).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -0600880 }
881 }
882 for (uint32_t i = 0; i < bindInfo.imageOpaqueBindCount; ++i) {
883 const auto& image_opaque_bind = bindInfo.pImageOpaqueBinds[i];
884 auto image_state = GetImageState(bindInfo.pImageOpaqueBinds[i].image);
885 if (!image_state)
886 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
887 sparse_images.insert(image_state);
888 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
889 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
890 // For now just warning if sparse image binding occurs without calling to get reqs first
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700891 skip |= LogWarning(image_state->image, kVUID_Core_MemTrack_InvalidState,
892 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
893 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
894 report_data->FormatHandle(image_state->image).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -0600895 }
896 }
897 if (!image_state->memory_requirements_checked) {
898 // For now just warning if sparse image binding occurs without calling to get reqs first
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700899 skip |= LogWarning(image_state->image, kVUID_Core_MemTrack_InvalidState,
900 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
901 "vkGetImageMemoryRequirements() to retrieve requirements.",
902 report_data->FormatHandle(image_state->image).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -0600903 }
904 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
905 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500906 sparse_images_with_metadata.insert(image_state);
Camden Stocker23cc47d2019-09-03 14:53:57 -0600907 }
908 }
909 }
910 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500911 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
912 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -0600913 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700914 skip |= LogWarning(sparse_image_state->image, kVUID_Core_MemTrack_InvalidState,
915 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
916 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
917 report_data->FormatHandle(sparse_image_state->image).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -0600918 }
919 }
920 }
921
922 return skip;
923}
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500924
925void BestPractices::PostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
926 VkFence fence, VkResult result) {
927 if (result != VK_SUCCESS) return;
928
929 for (uint32_t bindIdx = 0; bindIdx < bindInfoCount; bindIdx++) {
930 const VkBindSparseInfo& bindInfo = pBindInfo[bindIdx];
931 for (uint32_t i = 0; i < bindInfo.imageOpaqueBindCount; ++i) {
932 const auto& image_opaque_bind = bindInfo.pImageOpaqueBinds[i];
933 auto image_state = GetImageState(bindInfo.pImageOpaqueBinds[i].image);
934 if (!image_state)
935 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
936 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
937 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
938 image_state->sparse_metadata_bound = true;
939 }
940 }
941 }
942 }
943}
Camden Stocker0e0f89b2019-10-16 12:24:31 -0700944
945bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -0600946 const VkClearAttachment* pAttachments, uint32_t rectCount,
947 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -0700948 bool skip = false;
949 const CMD_BUFFER_STATE* cb_node = GetCBState(commandBuffer);
950 if (!cb_node) return skip;
951
Camden Stockerf55721f2019-09-09 11:04:49 -0600952 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Camden Stocker0e0f89b2019-10-16 12:24:31 -0700953 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
954 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
955 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
956 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
957 // CmdClearAttachments.
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700958 skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
959 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
960 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
961 report_data->FormatHandle(commandBuffer).c_str());
Camden Stocker0e0f89b2019-10-16 12:24:31 -0700962 }
963
Camden Stockerf55721f2019-09-09 11:04:49 -0600964 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -0700965}