blob: 41eaebfa5d5d07add09dcec25376b206bd4ad78a [file] [log] [blame]
Nathaniel Cesario56a96652020-12-30 13:23:42 -07001/* Copyright (c) 2015-2021 The Khronos Group Inc.
2 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 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
Mark Lobodzinski57b8ae82020-02-20 16:37:14 -070020#include "best_practices_validation.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"
Sam Wallsd7ab6db2020-06-19 20:41:54 +010023#include "shader_validation.h"
Jeremy Gebbena3705f42021-01-19 16:47:43 -070024#include "sync_utils.h"
Camden5b184be2019-08-13 07:50:19 -060025
26#include <string>
Sam Walls8e77e4f2020-03-16 20:47:40 +000027#include <bitset>
Sam Wallsd7ab6db2020-06-19 20:41:54 +010028#include <memory>
Camden5b184be2019-08-13 07:50:19 -060029
Attilio Provenzano19d6a982020-02-27 12:41:41 +000030struct VendorSpecificInfo {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060031 EnableFlags vendor_id;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000032 std::string name;
33};
34
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070035const std::map<BPVendorFlagBits, VendorSpecificInfo> kVendorInfo = {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060036 {kBPVendorArm, {vendor_specific_arm, "Arm"}},
Attilio Provenzano19d6a982020-02-27 12:41:41 +000037};
38
39bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070040 for (const auto& vendor : kVendorInfo) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060041 if (vendors & vendor.first && enabled[vendor.second.vendor_id]) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000042 return true;
43 }
44 }
45 return false;
46}
47
48const char* VendorSpecificTag(BPVendorFlags vendors) {
49 // Cache built vendor tags in a map
Jeremy Gebbencbf22862021-03-03 12:01:22 -070050 static layer_data::unordered_map<BPVendorFlags, std::string> tag_map;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000051
52 auto res = tag_map.find(vendors);
53 if (res == tag_map.end()) {
54 // Build the vendor tag string
55 std::stringstream vendor_tag;
56
57 vendor_tag << "[";
58 bool first_vendor = true;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070059 for (const auto& vendor : kVendorInfo) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000060 if (vendors & vendor.first) {
61 if (!first_vendor) {
62 vendor_tag << ", ";
63 }
64 vendor_tag << vendor.second.name;
65 first_vendor = false;
66 }
67 }
68 vendor_tag << "]";
69
70 tag_map[vendors] = vendor_tag.str();
71 res = tag_map.find(vendors);
72 }
73
74 return res->second.c_str();
75}
76
Mark Lobodzinski6167e102020-02-24 17:03:55 -070077const char* DepReasonToString(ExtDeprecationReason reason) {
78 switch (reason) {
79 case kExtPromoted:
80 return "promoted to";
81 break;
82 case kExtObsoleted:
83 return "obsoleted by";
84 break;
85 case kExtDeprecated:
86 return "deprecated by";
87 break;
88 default:
89 return "";
90 break;
91 }
92}
93
94bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version,
95 const char* vuid) const {
96 bool skip = false;
97 auto dep_info_it = deprecated_extensions.find(extension_name);
98 if (dep_info_it != deprecated_extensions.end()) {
99 auto dep_info = dep_info_it->second;
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600100 if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) ||
101 ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2))) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700102 skip |=
103 LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
104 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600105 } else if (dep_info.target.find("VK_VERSION") == std::string::npos) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700106 if (dep_info.target.length() == 0) {
107 skip |= LogWarning(instance, vuid,
108 "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated "
109 "without replacement.",
110 api_name, extension_name);
111 } else {
112 skip |= LogWarning(instance, vuid,
113 "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
114 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
115 }
116 }
117 }
118 return skip;
119}
120
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700121bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const char* vuid) const {
122 bool skip = false;
123 auto dep_info_it = special_use_extensions.find(extension_name);
124
125 if (dep_info_it != special_use_extensions.end()) {
126 auto special_uses = dep_info_it->second;
127 std::string message("is intended to support the following uses: ");
128 if (special_uses.find("cadsupport") != std::string::npos) {
129 message.append("specialized functionality used by CAD/CAM applications, ");
130 }
131 if (special_uses.find("d3demulation") != std::string::npos) {
132 message.append("D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D, ");
133 }
134 if (special_uses.find("devtools") != std::string::npos) {
135 message.append(" developer tools such as capture-replay libraries, ");
136 }
137 if (special_uses.find("debugging") != std::string::npos) {
138 message.append("use by applications when debugging, ");
139 }
140 if (special_uses.find("glemulation") != std::string::npos) {
141 message.append(
142 "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality "
143 "specific to those APIs, ");
144 }
145 message.append("and it is strongly recommended that they be otherwise avoided");
146
147 skip |= LogWarning(instance, vuid, "%s(): Attempting to enable extension %s, but this extension %s.", api_name,
148 extension_name, message.c_str());
149 }
150 return skip;
151}
152
Camden5b184be2019-08-13 07:50:19 -0600153bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500154 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600155 bool skip = false;
156
157 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
158 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800159 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700160 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
161 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600162 }
Mark Lobodzinski17d8dc62020-06-03 08:48:58 -0600163 uint32_t specified_version =
164 (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0);
165 skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700166 kVUID_BestPractices_CreateInstance_DeprecatedExtension);
Mark Lobodzinskia431b772020-11-10 08:12:13 -0700167 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i],
168 kVUID_BestPractices_CreateInstance_SpecialUseExtension);
Camden5b184be2019-08-13 07:50:19 -0600169 }
170
171 return skip;
172}
173
174void BestPractices::PreCallRecordCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
175 VkInstance* pInstance) {
Mark Lobodzinski97484d62020-03-03 11:57:41 -0700176 ValidationStateTracker::PreCallRecordCreateInstance(pCreateInfo, pAllocator, pInstance);
Sam Walls53bf7652020-04-21 17:35:15 +0100177
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700178 if (pCreateInfo != nullptr && pCreateInfo->pApplicationInfo != nullptr) {
Sam Walls53bf7652020-04-21 17:35:15 +0100179 instance_api_version = pCreateInfo->pApplicationInfo->apiVersion;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700180 } else {
Sam Walls53bf7652020-04-21 17:35:15 +0100181 instance_api_version = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700182 }
Camden5b184be2019-08-13 07:50:19 -0600183}
184
185bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500186 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -0600187 bool skip = false;
188
189 // get API version of physical device passed when creating device.
190 VkPhysicalDeviceProperties physical_device_properties{};
191 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500192 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -0600193
194 // check api versions and warn if instance api Version is higher than version on device.
195 if (instance_api_version > device_api_version) {
Mark Lobodzinski60880782020-08-11 08:02:07 -0600196 std::string inst_api_name = StringAPIVersion(instance_api_version);
197 std::string dev_api_name = StringAPIVersion(device_api_version);
Camden5b184be2019-08-13 07:50:19 -0600198
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700199 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
200 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
201 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600202 }
203
204 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
205 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800206 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700207 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
208 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600209 }
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700210 skip |= ValidateDeprecatedExtensions("CreateDevice", pCreateInfo->ppEnabledExtensionNames[i], instance_api_version,
211 kVUID_BestPractices_CreateDevice_DeprecatedExtension);
Mark Lobodzinskia431b772020-11-10 08:12:13 -0700212 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i],
213 kVUID_BestPractices_CreateDevice_SpecialUseExtension);
Camden5b184be2019-08-13 07:50:19 -0600214 }
215
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600216 const auto bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
217 if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700218 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
219 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600220 }
221
Szilard Papp7d2c7952020-06-22 14:38:13 +0100222 if ((VendorCheckEnabled(kBPVendorArm)) && (pCreateInfo->pEnabledFeatures != nullptr) &&
223 (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
224 skip |= LogPerformanceWarning(
225 device, kVUID_BestPractices_CreateDevice_RobustBufferAccess,
226 "%s vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during "
227 "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage "
228 "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case "
229 "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.",
230 VendorSpecificTag(kBPVendorArm));
231 }
232
Camden5b184be2019-08-13 07:50:19 -0600233 return skip;
234}
235
236bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500237 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600238 bool skip = false;
239
240 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700241 std::stringstream buffer_hex;
242 buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer);
Camden5b184be2019-08-13 07:50:19 -0600243
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700244 skip |= LogWarning(
245 device, kVUID_BestPractices_SharingModeExclusive,
246 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
247 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700248 buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600249 }
250
251 return skip;
252}
253
254bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500255 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600256 bool skip = false;
257
258 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700259 std::stringstream image_hex;
260 image_hex << "0x" << std::hex << HandleToUint64(pImage);
Camden5b184be2019-08-13 07:50:19 -0600261
262 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700263 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
264 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
265 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700266 image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600267 }
268
Attilio Provenzano02859b22020-02-27 14:17:28 +0000269 if (VendorCheckEnabled(kBPVendorArm)) {
270 if (pCreateInfo->samples > kMaxEfficientSamplesArm) {
271 skip |= LogPerformanceWarning(
272 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
273 "%s vkCreateImage(): Trying to create an image with %u samples. "
274 "The hardware revision may not have full throughput for framebuffers with more than %u samples.",
275 VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm);
276 }
277
278 if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
279 skip |= LogPerformanceWarning(
280 device, kVUID_BestPractices_CreateImage_NonTransientMSImage,
281 "%s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have "
282 "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, "
283 "and do not need to be backed by physical storage. "
284 "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.",
285 VendorSpecificTag(kBPVendorArm));
286 }
287 }
288
Camden5b184be2019-08-13 07:50:19 -0600289 return skip;
290}
291
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +0100292void BestPractices::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
293 ValidationStateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
294 ReleaseImageUsageState(image);
295}
296
Hans-Kristian Arntzen92664eb2021-03-29 12:19:48 +0200297void BestPractices::PreCallRecordDestroySwapchainKHR(VkDevice device, VkSwapchainKHR swapchain, const VkAllocationCallbacks* pAllocator) {
298 SWAPCHAIN_NODE* chain = GetSwapchainState(swapchain);
299 for (auto& image : chain->images) {
300 ReleaseImageUsageState(image.image_state->image());
301 }
302 ValidationStateTracker::PreCallRecordDestroySwapchainKHR(device, swapchain, pAllocator);
303}
304
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +0100305IMAGE_STATE_BP* BestPractices::GetImageUsageState(VkImage vk_image) {
306 auto itr = imageUsageMap.find(vk_image);
307 if (itr != imageUsageMap.end()) {
308 return &itr->second;
309 } else {
310 auto& state = imageUsageMap[vk_image];
311 IMAGE_STATE* image = GetImageState(vk_image);
312 state.image = image;
313 state.usages.resize(image->createInfo.arrayLayers);
314 for (auto& mips : state.usages) {
315 mips.resize(image->createInfo.mipLevels, IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED);
316 }
317 return &state;
318 }
319}
320
321void BestPractices::ReleaseImageUsageState(VkImage image) {
322 auto itr = imageUsageMap.find(image);
323 if (itr != imageUsageMap.end()) {
324 imageUsageMap.erase(itr);
325 }
326}
327
Camden5b184be2019-08-13 07:50:19 -0600328bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500329 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600330 bool skip = false;
331
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600332 const auto* bp_pd_state = GetPhysicalDeviceStateBP();
333 if (bp_pd_state) {
334 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
335 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
336 "vkCreateSwapchainKHR() called before getting surface capabilities from "
337 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
338 }
Camden83a9c372019-08-14 11:41:38 -0600339
Shannon McPherson73e58c82021-03-05 17:14:26 -0700340 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
341 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600342 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
343 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
344 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
345 }
Camden83a9c372019-08-14 11:41:38 -0600346
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600347 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
348 skip |= LogWarning(
349 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
350 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
351 }
Camden83a9c372019-08-14 11:41:38 -0600352 }
353
Camden5b184be2019-08-13 07:50:19 -0600354 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700355 skip |=
356 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600357 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700358 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
359 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600360 }
361
Szilard Papp48a6da32020-06-10 14:41:59 +0100362 if (pCreateInfo->minImageCount == 2) {
363 skip |= LogPerformanceWarning(
364 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
365 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
366 ", which means double buffering is going "
367 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
368 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
369 "3 to use triple buffering to maximize performance in such cases.",
370 pCreateInfo->minImageCount);
371 }
372
Szilard Pappd5f0f812020-06-22 09:01:29 +0100373 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
374 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
375 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
376 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
377 "Presentation modes which are not FIFO will present the latest available frame and discard other "
378 "frame(s) if any.",
379 VendorSpecificTag(kBPVendorArm));
380 }
381
Camden5b184be2019-08-13 07:50:19 -0600382 return skip;
383}
384
385bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
386 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500387 const VkAllocationCallbacks* pAllocator,
388 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600389 bool skip = false;
390
391 for (uint32_t i = 0; i < swapchainCount; i++) {
392 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700393 skip |= LogWarning(
394 device, kVUID_BestPractices_SharingModeExclusive,
395 "Warning: A shared swapchain (index %" PRIu32
396 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
397 "queues (queueFamilyIndexCount of %" PRIu32 ").",
398 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600399 }
400 }
401
402 return skip;
403}
404
405bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500406 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600407 bool skip = false;
408
409 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
410 VkFormat format = pCreateInfo->pAttachments[i].format;
411 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
412 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
413 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700414 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
415 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
416 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
417 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
418 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600419 }
420 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700421 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
422 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
423 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
424 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
425 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600426 }
427 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000428
429 const auto& attachment = pCreateInfo->pAttachments[i];
430 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
431 bool access_requires_memory =
432 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
433
434 if (FormatHasStencil(format)) {
435 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
436 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
437 }
438
439 if (access_requires_memory) {
440 skip |= LogPerformanceWarning(
441 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
442 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
443 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
444 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
445 i, static_cast<uint32_t>(attachment.samples));
446 }
447 }
Camden5b184be2019-08-13 07:50:19 -0600448 }
449
450 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
451 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
452 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
453 }
454
455 return skip;
456}
457
Tony-LunarG767180f2020-04-23 14:03:59 -0600458bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
459 const VkImageView* image_views) const {
460 bool skip = false;
461
462 // Check for non-transient attachments that should be transient and vice versa
463 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200464 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600465 bool attachment_should_be_transient =
466 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
467
468 if (FormatHasStencil(attachment.format)) {
469 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
470 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
471 }
472
473 auto view_state = GetImageViewState(image_views[i]);
474 if (view_state) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200475 const auto& ivci = view_state->create_info;
476 const auto& ici = GetImageState(ivci.image)->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600477
478 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
479
480 // The check for an image that should not be transient applies to all GPUs
481 if (!attachment_should_be_transient && image_is_transient) {
482 skip |= LogPerformanceWarning(
483 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
484 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
485 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
486 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
487 i);
488 }
489
490 bool supports_lazy = false;
491 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
492 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
493 supports_lazy = true;
494 }
495 }
496
497 // The check for an image that should be transient only applies to GPUs supporting
498 // lazily allocated memory
499 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
500 skip |= LogPerformanceWarning(
501 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
502 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
503 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
504 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
505 i);
506 }
507 }
508 }
509 return skip;
510}
511
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000512bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
513 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
514 bool skip = false;
515
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000516 auto rp_state = GetRenderPassState(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800517 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600518 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000519 }
520
521 return skip;
522}
523
Sam Wallse746d522020-03-16 21:20:23 +0000524bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
525 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
526 bool skip = false;
527 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
528
529 if (!skip) {
530 const auto& pool_handle = pAllocateInfo->descriptorPool;
531 auto iter = descriptor_pool_freed_count.find(pool_handle);
532 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
533 // this warning is specific to Arm
534 if (VendorCheckEnabled(kBPVendorArm) && iter != descriptor_pool_freed_count.end() && iter->second > 0) {
535 skip |= LogPerformanceWarning(
536 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
537 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
538 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
539 VendorSpecificTag(kBPVendorArm));
540 }
541 }
542
543 return skip;
544}
545
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600546void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
547 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000548 if (result == VK_SUCCESS) {
549 // find the free count for the pool we allocated into
550 auto iter = descriptor_pool_freed_count.find(pAllocateInfo->descriptorPool);
551 if (iter != descriptor_pool_freed_count.end()) {
552 // we record successful allocations by subtracting the allocation count from the last recorded free count
553 const auto alloc_count = pAllocateInfo->descriptorSetCount;
554 // clamp the unsigned subtraction to the range [0, last_free_count]
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700555 if (iter->second > alloc_count) {
Sam Wallse746d522020-03-16 21:20:23 +0000556 iter->second -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700557 } else {
Sam Wallse746d522020-03-16 21:20:23 +0000558 iter->second = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700559 }
Sam Wallse746d522020-03-16 21:20:23 +0000560 }
561 }
562}
563
564void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
565 const VkDescriptorSet* pDescriptorSets, VkResult result) {
566 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
567 if (result == VK_SUCCESS) {
568 // we want to track frees because we're interested in suggesting re-use
569 auto iter = descriptor_pool_freed_count.find(descriptorPool);
570 if (iter == descriptor_pool_freed_count.end()) {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700571 descriptor_pool_freed_count.emplace(descriptorPool, descriptorSetCount);
Sam Wallse746d522020-03-16 21:20:23 +0000572 } else {
573 iter->second += descriptorSetCount;
574 }
575 }
576}
577
Camden5b184be2019-08-13 07:50:19 -0600578bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500579 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600580 bool skip = false;
581
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500582 if (num_mem_objects + 1 > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700583 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
584 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600585 }
586
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000587 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
588 skip |= LogPerformanceWarning(
589 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600590 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
591 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000592 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
593 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
594 }
595
Camden83a9c372019-08-14 11:41:38 -0600596 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
597
598 return skip;
599}
600
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600601void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
602 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
603 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700604 if (result != VK_SUCCESS) {
605 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
606 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800607 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700608 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600609 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700610 return;
611 }
612 num_mem_objects++;
613}
Camden Stocker9738af92019-10-16 13:54:03 -0700614
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600615void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
616 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700617 auto error = std::find(error_codes.begin(), error_codes.end(), result);
618 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000619 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
620 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
621
622 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
623 if (common_failure != common_failure_codes.end()) {
624 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
625 } else {
626 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
627 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700628 return;
629 }
630 auto success = std::find(success_codes.begin(), success_codes.end(), result);
631 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600632 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
633 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500634 }
635}
636
Jeff Bolz5c801d12019-10-09 10:38:45 -0500637bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
638 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700639 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600640 bool skip = false;
641
Camden Stocker9738af92019-10-16 13:54:03 -0700642 const DEVICE_MEMORY_STATE* mem_info = ValidationStateTracker::GetDevMemState(memory);
Camden83a9c372019-08-14 11:41:38 -0600643
Jeremy Gebben5570abe2021-05-16 18:35:13 -0600644 for (const auto& node: mem_info->ObjectBindings()) {
645 const auto& obj = node->Handle();
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600646 LogObjectList objlist(device);
647 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600648 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600649 skip |= LogWarning(objlist, layer_name.c_str(), "VK Object %s still has a reference to mem obj %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600650 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600651 }
652
Camden5b184be2019-08-13 07:50:19 -0600653 return skip;
654}
655
656void BestPractices::PreCallRecordFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks* pAllocator) {
Mark Lobodzinski97484d62020-03-03 11:57:41 -0700657 ValidationStateTracker::PreCallRecordFreeMemory(device, memory, pAllocator);
Camden5b184be2019-08-13 07:50:19 -0600658 if (memory != VK_NULL_HANDLE) {
659 num_mem_objects--;
660 }
661}
662
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000663bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600664 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500665 const BUFFER_STATE* buffer_state = GetBufferState(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600666
sfricke-samsunge2441192019-11-06 14:07:57 -0800667 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700668 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
669 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
670 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600671 }
672
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000673 const DEVICE_MEMORY_STATE* mem_state = GetDevMemState(memory);
674
675 if (mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
676 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
677 skip |= LogPerformanceWarning(
678 device, kVUID_BestPractices_SmallDedicatedAllocation,
679 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600680 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
681 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000682 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
683 }
684
Camden Stockerb603cc82019-09-03 10:09:02 -0600685 return skip;
686}
687
688bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500689 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600690 bool skip = false;
691 const char* api_name = "BindBufferMemory()";
692
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000693 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600694
695 return skip;
696}
697
698bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500699 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600700 char api_name[64];
701 bool skip = false;
702
703 for (uint32_t i = 0; i < bindInfoCount; i++) {
704 sprintf(api_name, "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000705 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600706 }
707
708 return skip;
709}
Camden Stockerb603cc82019-09-03 10:09:02 -0600710
711bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500712 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600713 char api_name[64];
714 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600715
Camden Stocker8b798ab2019-09-03 10:33:28 -0600716 for (uint32_t i = 0; i < bindInfoCount; i++) {
717 sprintf(api_name, "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000718 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600719 }
720
721 return skip;
722}
723
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000724bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600725 bool skip = false;
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500726 const IMAGE_STATE* image_state = GetImageState(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600727
sfricke-samsung71bc6572020-04-29 15:49:43 -0700728 if (image_state->disjoint == false) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700729 if (!image_state->memory_requirements_checked && !image_state->external_memory_handle) {
730 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
731 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
732 api_name, report_data->FormatHandle(image).c_str());
733 }
734 } else {
735 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
736 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600737 }
738
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000739 const DEVICE_MEMORY_STATE* mem_state = GetDevMemState(memory);
740
741 if (mem_state->alloc_info.allocationSize == image_state->requirements.size &&
742 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
743 skip |= LogPerformanceWarning(
744 device, kVUID_BestPractices_SmallDedicatedAllocation,
745 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600746 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
747 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000748 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
749 }
750
751 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
752 // make sure this type is actually used.
753 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
754 // (i.e.most tile - based renderers)
755 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
756 bool supports_lazy = false;
757 uint32_t suggested_type = 0;
758
759 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
760 if ((1u << i) & image_state->requirements.memoryTypeBits) {
761 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
762 supports_lazy = true;
763 suggested_type = i;
764 break;
765 }
766 }
767 }
768
769 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
770
771 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
772 skip |= LogPerformanceWarning(
773 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600774 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000775 "but this memory type is not LAZILY_ALLOCATED_BIT. You should use memory type %u here instead to save "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600776 "%" PRIu64 " bytes of physical memory.",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000777 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements.size);
778 }
779 }
780
Camden Stocker8b798ab2019-09-03 10:33:28 -0600781 return skip;
782}
783
784bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500785 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600786 bool skip = false;
787 const char* api_name = "vkBindImageMemory()";
788
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000789 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600790
791 return skip;
792}
793
794bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500795 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600796 char api_name[64];
797 bool skip = false;
798
799 for (uint32_t i = 0; i < bindInfoCount; i++) {
800 sprintf(api_name, "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700801 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -0600802 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
803 }
Camden Stocker8b798ab2019-09-03 10:33:28 -0600804 }
805
806 return skip;
807}
808
809bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500810 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600811 char api_name[64];
812 bool skip = false;
813
814 for (uint32_t i = 0; i < bindInfoCount; i++) {
815 sprintf(api_name, "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000816 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600817 }
818
819 return skip;
820}
Camden83a9c372019-08-14 11:41:38 -0600821
Attilio Provenzano02859b22020-02-27 14:17:28 +0000822static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
823 switch (format) {
824 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
825 case VK_FORMAT_R16_SFLOAT:
826 case VK_FORMAT_R16G16_SFLOAT:
827 case VK_FORMAT_R16G16B16_SFLOAT:
828 case VK_FORMAT_R16G16B16A16_SFLOAT:
829 case VK_FORMAT_R32_SFLOAT:
830 case VK_FORMAT_R32G32_SFLOAT:
831 case VK_FORMAT_R32G32B32_SFLOAT:
832 case VK_FORMAT_R32G32B32A32_SFLOAT:
833 return false;
834
835 default:
836 return true;
837 }
838}
839
840bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
841 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
842 bool skip = false;
843
844 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700845 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000846
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700847 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
848 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
849 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000850 return skip;
851 }
852
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700853 auto rp_state = GetRenderPassState(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200854 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000855
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700856 for (uint32_t j = 0; j < create_info->pColorBlendState->attachmentCount; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200857 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000858 uint32_t att = subpass.pColorAttachments[j].attachment;
859
860 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
861 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
862 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
863 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
864 "color attachment #%u makes use "
865 "of a format which cannot be blended at full throughput when using MSAA.",
866 VendorSpecificTag(kBPVendorArm), i, j);
867 }
868 }
869 }
870 }
871
872 return skip;
873}
874
Camden5b184be2019-08-13 07:50:19 -0600875bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
876 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600877 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500878 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600879 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
880 pAllocator, pPipelines, cgpl_state_data);
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600881 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600882
883 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700884 skip |= LogPerformanceWarning(
885 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
886 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
887 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600888 }
889
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000890 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200891 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000892
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600893 if (!(cgpl_state->pipe_state[i]->active_shaders & VK_SHADER_STAGE_MESH_BIT_NV)) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200894 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600895 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700896 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
897 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600898 count++;
899 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000900 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600901 if (count > kMaxInstancedVertexBuffers) {
902 skip |= LogPerformanceWarning(
903 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
904 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
905 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
906 count, kMaxInstancedVertexBuffers);
907 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000908 }
Attilio Provenzano02859b22020-02-27 14:17:28 +0000909
Szilard Pappaaf2da32020-06-22 10:37:35 +0100910 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
911 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +0200912 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
913 VendorCheckEnabled(kBPVendorArm)) {
914 skip |= LogPerformanceWarning(
915 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
916 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
917 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
918 "efficiency during rasterization. Consider disabling depthBias or increasing either "
919 "depthBiasConstantFactor or depthBiasSlopeFactor.",
920 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +0100921 }
922
Attilio Provenzano02859b22020-02-27 14:17:28 +0000923 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000924 }
925
Camden5b184be2019-08-13 07:50:19 -0600926 return skip;
927}
928
Sam Walls0961ec02020-03-31 16:39:15 +0100929void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
930 const VkGraphicsPipelineCreateInfo* pCreateInfos,
931 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
932 VkResult result, void* cgpl_state_data) {
933 for (size_t i = 0; i < count; i++) {
934 const auto* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
935 const VkPipeline pipeline_handle = pPipelines[i];
936
937 // record depth stencil state and color blend states for depth pre-pass tracking purposes
938 auto gp_cis = graphicsPipelineCIs.find(pipeline_handle);
939
940 // add the tracking state if it doesn't exist
941 if (gp_cis == graphicsPipelineCIs.end()) {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700942 auto result = graphicsPipelineCIs.emplace(pipeline_handle, GraphicsPipelineCIs{});
Sam Walls0961ec02020-03-31 16:39:15 +0100943
944 if (!result.second) continue;
945
946 gp_cis = result.first;
947 }
948
Tony-LunarG412b1b72020-07-15 10:30:13 -0600949 gp_cis->second.colorBlendStateCI =
950 cgpl_state->pCreateInfos[i].pColorBlendState
951 ? new safe_VkPipelineColorBlendStateCreateInfo(cgpl_state->pCreateInfos[i].pColorBlendState)
952 : nullptr;
953 gp_cis->second.depthStencilStateCI =
954 cgpl_state->pCreateInfos[i].pDepthStencilState
955 ? new safe_VkPipelineDepthStencilStateCreateInfo(cgpl_state->pCreateInfos[i].pDepthStencilState)
956 : nullptr;
Sam Walls0961ec02020-03-31 16:39:15 +0100957 }
958}
959
Camden5b184be2019-08-13 07:50:19 -0600960bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
961 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600962 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500963 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600964 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
965 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600966
967 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700968 skip |= LogPerformanceWarning(
969 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
970 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
971 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600972 }
973
Sam Wallsd7ab6db2020-06-19 20:41:54 +0100974 if (VendorCheckEnabled(kBPVendorArm)) {
975 for (size_t i = 0; i < createInfoCount; i++) {
976 skip |= ValidateCreateComputePipelineArm(pCreateInfos[i]);
977 }
978 }
979
980 return skip;
981}
982
983bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
984 bool skip = false;
985 auto* module = GetShaderModuleState(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -0800986 // Generate warnings about work group sizes based on active resources.
sfricke-samsung962cad92021-04-13 00:46:29 -0700987 auto entrypoint = module->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
sfricke-samsung8a7341a2021-02-28 07:30:21 -0800988 if (entrypoint == module->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +0100989
990 uint32_t x = 1, y = 1, z = 1;
sfricke-samsung962cad92021-04-13 00:46:29 -0700991 module->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +0100992
993 uint32_t thread_count = x * y * z;
994
995 // Generate a priori warnings about work group sizes.
996 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
997 skip |= LogPerformanceWarning(
998 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
999 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1000 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1001 "groups with less than %u threads, especially when using barrier() or shared memory.",
1002 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1003 }
1004
1005 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1006 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1007 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1008 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1009 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1010 "%u, %u) is not aligned to %u "
1011 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1012 "leave threads idle on the shader "
1013 "core.",
1014 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1015 kThreadGroupDispatchCountAlignmentArm);
1016 }
1017
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001018 bool has_writeable_descriptors = false;
locke-lunarg63e4daf2020-08-17 17:53:25 -06001019 bool has_atomic_descriptors = false;
sfricke-samsung962cad92021-04-13 00:46:29 -07001020 auto accessible_ids = module->MarkAccessibleIds(entrypoint);
locke-lunarg63e4daf2020-08-17 17:53:25 -06001021 auto descriptor_uses =
sfricke-samsung962cad92021-04-13 00:46:29 -07001022 module->CollectInterfaceByDescriptorSlot(accessible_ids, &has_writeable_descriptors, &has_atomic_descriptors);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001023
1024 unsigned dimensions = 0;
1025 if (x > 1) dimensions++;
1026 if (y > 1) dimensions++;
1027 if (z > 1) dimensions++;
1028 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1029 dimensions = std::max(dimensions, 1u);
1030
1031 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1032 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1033 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1034 bool accesses_2d = false;
1035 for (const auto& usage : descriptor_uses) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001036 auto dim = module->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001037 if (dim < 0) continue;
1038 auto spvdim = spv::Dim(dim);
1039 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1040 }
1041
1042 if (accesses_2d && dimensions < 2) {
1043 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1044 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1045 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1046 "exhibiting poor spatial locality with respect to one or more shader resources.",
1047 VendorSpecificTag(kBPVendorArm), x, y, z);
1048 }
1049
Camden5b184be2019-08-13 07:50:19 -06001050 return skip;
1051}
1052
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001053bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001054 bool skip = false;
1055
1056 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001057 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1058 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001059 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001060 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1061 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001062 }
1063
1064 return skip;
1065}
1066
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001067bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1068 bool skip = false;
1069
1070 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1071 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1072 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1073 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1074 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1075 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1076 }
1077
1078 return skip;
1079}
1080
1081bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1082 bool skip = false;
1083 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1084
1085 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1086 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1087
1088 return skip;
1089}
1090
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001091void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001092 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1093 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1094 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1095 LogPerformanceWarning(
1096 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1097 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1098 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1099 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1100 "convenient opportunity.",
1101 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1102 }
1103 }
1104}
1105
Jeff Bolz5c801d12019-10-09 10:38:45 -05001106bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1107 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001108 bool skip = false;
1109
1110 for (uint32_t submit = 0; submit < submitCount; submit++) {
1111 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1112 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1113 }
1114 }
1115
1116 return skip;
1117}
1118
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001119bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1120 VkFence fence) const {
1121 bool skip = false;
1122
1123 for (uint32_t submit = 0; submit < submitCount; submit++) {
1124 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1125 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1126 }
1127 }
1128
1129 return skip;
1130}
1131
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001132bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1133 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1134 bool skip = false;
1135
1136 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1137 skip |= LogPerformanceWarning(
1138 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1139 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1140 "pool instead.");
1141 }
1142
1143 return skip;
1144}
1145
1146bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1147 const VkCommandBufferBeginInfo* pBeginInfo) const {
1148 bool skip = false;
1149
1150 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1151 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1152 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1153 }
1154
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001155 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1156 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001157 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1158 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1159 VendorSpecificTag(kBPVendorArm));
1160 }
1161
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001162 return skip;
1163}
1164
Jeff Bolz5c801d12019-10-09 10:38:45 -05001165bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001166 bool skip = false;
1167
1168 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1169
1170 return skip;
1171}
1172
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001173bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1174 const VkDependencyInfoKHR* pDependencyInfo) const {
1175 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1176}
1177
Jeff Bolz5c801d12019-10-09 10:38:45 -05001178bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1179 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001180 bool skip = false;
1181
1182 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1183
1184 return skip;
1185}
1186
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001187bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1188 VkPipelineStageFlags2KHR stageMask) const {
1189 bool skip = false;
1190
1191 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1192
1193 return skip;
1194}
1195
Camden5b184be2019-08-13 07:50:19 -06001196bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1197 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1198 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1199 uint32_t bufferMemoryBarrierCount,
1200 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1201 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001202 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001203 bool skip = false;
1204
1205 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1206 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1207
1208 return skip;
1209}
1210
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001211bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1212 const VkDependencyInfoKHR* pDependencyInfos) const {
1213 bool skip = false;
1214 for (uint32_t i = 0; i < eventCount; i++) {
1215 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1216 }
1217
1218 return skip;
1219}
1220
Camden5b184be2019-08-13 07:50:19 -06001221bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1222 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1223 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1224 uint32_t bufferMemoryBarrierCount,
1225 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1226 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001227 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001228 bool skip = false;
1229
1230 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1231 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1232
1233 return skip;
1234}
1235
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001236bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1237 const VkDependencyInfoKHR* pDependencyInfo) const {
1238 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1239}
1240
Camden5b184be2019-08-13 07:50:19 -06001241bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001242 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001243 bool skip = false;
1244
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001245 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1246
1247 return skip;
1248}
1249
1250bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1251 VkQueryPool queryPool, uint32_t query) const {
1252 bool skip = false;
1253
1254 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001255
1256 return skip;
1257}
1258
Sam Walls0961ec02020-03-31 16:39:15 +01001259void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1260 VkPipeline pipeline) {
1261 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1262
1263 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
1264 // check for depth/blend state tracking
1265 auto gp_cis = graphicsPipelineCIs.find(pipeline);
1266 if (gp_cis != graphicsPipelineCIs.end()) {
1267 auto prepass_state = cbDepthPrePassStates.find(commandBuffer);
1268 if (prepass_state == cbDepthPrePassStates.end()) {
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001269 auto result = cbDepthPrePassStates.emplace(commandBuffer, DepthPrePassState{});
Sam Walls0961ec02020-03-31 16:39:15 +01001270
1271 if (!result.second) return;
1272
1273 prepass_state = result.first;
1274 }
1275
1276 const auto* blend_state = gp_cis->second.colorBlendStateCI;
1277 const auto* stencil_state = gp_cis->second.depthStencilStateCI;
1278
1279 if (blend_state) {
1280 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
1281 prepass_state->second.depthOnly = true;
1282 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1283 if (blend_state->pAttachments[i].colorWriteMask != 0) {
1284 prepass_state->second.depthOnly = false;
1285 }
1286 }
1287 }
1288
1289 // check for depth value usage
1290 prepass_state->second.depthEqualComparison = false;
1291
1292 if (stencil_state && stencil_state->depthTestEnable) {
1293 switch (stencil_state->depthCompareOp) {
1294 case VK_COMPARE_OP_EQUAL:
1295 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1296 case VK_COMPARE_OP_LESS_OR_EQUAL:
1297 prepass_state->second.depthEqualComparison = true;
1298 break;
1299 default:
1300 break;
1301 }
1302 }
1303 } else {
1304 // reset depth pre-pass tracking
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001305 cbDepthPrePassStates.emplace(commandBuffer, DepthPrePassState{});
Sam Walls0961ec02020-03-31 16:39:15 +01001306 }
1307 }
1308}
1309
Attilio Provenzano02859b22020-02-27 14:17:28 +00001310static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1311 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001312 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001313
1314 // If an attachment is ever used as a color attachment,
1315 // resolve attachment or depth stencil attachment,
1316 // it needs to exist on tile at some point.
1317
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001318 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1319 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001320 }
1321
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001322 if (subpass_info.pResolveAttachments) {
1323 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1324 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1325 }
1326 }
1327
1328 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001329 }
1330
1331 return false;
1332}
1333
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001334static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1335 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1336 return false;
1337 }
1338
1339 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001340 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001341
1342 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1343 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1344 return true;
1345 }
1346 }
1347 }
1348
1349 return false;
1350}
1351
Attilio Provenzano02859b22020-02-27 14:17:28 +00001352bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1353 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1354 bool skip = false;
1355
1356 if (!pRenderPassBegin) {
1357 return skip;
1358 }
1359
1360 auto rp_state = GetRenderPassState(pRenderPassBegin->renderPass);
1361 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001362 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001363 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001364 if (rpabi) {
1365 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1366 }
1367 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001368 // Check if any attachments have LOAD operation on them
1369 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001370 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001371
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001372 bool attachment_has_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001373 if (!FormatHasStencil(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001374 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001375 }
1376
1377 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001378 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001379 }
1380
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001381 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001382
1383 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001384 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1385 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001386 }
1387
1388 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001389 if (attachment_needs_readback && VendorCheckEnabled(kBPVendorArm)) {
1390 skip |= LogPerformanceWarning(
1391 device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
1392 "%s Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
1393 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
1394 "which will copy in total %u pixels (renderArea = { %d, %d, %u, %u }) to the tile buffer.",
1395 VendorSpecificTag(kBPVendorArm), att,
1396 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1397 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1398 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001399 }
1400 }
1401 }
1402
1403 return skip;
1404}
1405
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001406void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001407 if (view) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001408 QueueValidateImage(funcs, GetImageUsageState(view->create_info.image), usage, view->create_info.subresourceRange);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001409 }
1410}
1411
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001412void BestPractices::QueueValidateImage(QueueCallbacks &funcs, IMAGE_STATE_BP* state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001413 const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001414 IMAGE_STATE* image = state->image;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001415 const uint32_t max_layers = image->createInfo.arrayLayers - subresource_range.baseArrayLayer;
1416 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
1417 const uint32_t max_levels = image->createInfo.mipLevels - subresource_range.baseMipLevel;
1418 const uint32_t mip_levels = std::min(image->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001419
1420 for (uint32_t layer = 0; layer < array_layers; layer++) {
1421 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001422 QueueValidateImage(funcs, state, usage, layer + subresource_range.baseArrayLayer, level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001423 }
1424 }
1425}
1426
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001427void BestPractices::QueueValidateImage(QueueCallbacks &funcs, IMAGE_STATE_BP* state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001428 const VkImageSubresourceLayers& subresource_layers) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001429 IMAGE_STATE* image = state->image;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001430 const uint32_t max_layers = image->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
1431 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001432
1433 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001434 QueueValidateImage(funcs, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001435 }
1436}
1437
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001438void BestPractices::QueueValidateImage(QueueCallbacks &funcs, IMAGE_STATE_BP* state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001439 uint32_t array_layer, uint32_t mip_level) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001440 funcs.push_back([this, state, usage, array_layer, mip_level](const ValidationStateTracker*, const QUEUE_STATE*) -> bool {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001441 ValidateImageInQueue(state, usage, array_layer, mip_level);
1442 return false;
1443 });
1444}
1445
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001446void BestPractices::ValidateImageInQueueArm(IMAGE_STATE* image,
1447 IMAGE_SUBRESOURCE_USAGE_BP last_usage,
1448 IMAGE_SUBRESOURCE_USAGE_BP usage,
1449 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001450 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001451 if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED && last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED &&
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001452 !image->is_swapchain_image) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001453 LogPerformanceWarning(
1454 device, kVUID_BestPractices_RenderPass_RedundantStore,
1455 "%s Subresource (arrayLayer: %u, mipLevel: %u) of image was cleared as part of LOAD_OP_CLEAR, but last time "
1456 "image was used, it was written to with STORE_OP_STORE. "
1457 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1458 "architectures.",
1459 VendorSpecificTag(kBPVendorArm), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001460 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED && last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001461 LogPerformanceWarning(
1462 device, kVUID_BestPractices_RenderPass_RedundantClear,
1463 "%s Subresource (arrayLayer: %u, mipLevel: %u) of image was cleared as part of LOAD_OP_CLEAR, but last time "
1464 "image was used, it was written to with vkCmdClear*Image(). "
1465 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1466 "tile-based architectures."
1467 "architectures.",
1468 VendorSpecificTag(kBPVendorArm), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001469 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
1470 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE ||
1471 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1472 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE ||
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001473 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001474 const char *last_cmd = nullptr;
1475 const char *vuid = nullptr;
1476 const char *suggestion = nullptr;
1477
1478 switch (last_usage) {
1479 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1480 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1481 last_cmd = "vkCmdBlitImage";
1482 suggestion =
1483 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1484 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1485 "which avoids the memory roundtrip.";
1486 break;
1487 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1488 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1489 last_cmd = "vkCmdClear*Image";
1490 suggestion =
1491 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1492 "tile-based architectures. "
1493 "Use LOAD_OP_CLEAR instead to clear the image for free.";
1494 break;
1495 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
1496 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
1497 last_cmd = "vkCmdCopy*Image";
1498 suggestion =
1499 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1500 "Rather than copying, just render the source image in a fragment shader in this render pass, "
1501 "which avoids the memory roundtrip.";
1502 break;
1503 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
1504 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
1505 last_cmd = "vkCmdResolveImage";
1506 suggestion =
1507 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
1508 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
1509 "which avoids the memory roundtrip.";
1510 break;
1511 default:
1512 break;
1513 }
1514
1515 LogPerformanceWarning(
1516 device, vuid,
1517 "%s Subresource (arrayLayer: %u, mipLevel: %u) of image was loaded to tile as part of LOAD_OP_LOAD, but last "
1518 "time image was used, it was written to with %s. %s",
1519 VendorSpecificTag(kBPVendorArm), array_layer, mip_level, last_cmd, suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001520 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001521}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001522
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001523void BestPractices::ValidateImageInQueue(IMAGE_STATE_BP* state,
1524 IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer,
1525 uint32_t mip_level) {
1526 IMAGE_STATE* image = state->image;
1527 IMAGE_SUBRESOURCE_USAGE_BP last_usage = state->usages[array_layer][mip_level];
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001528 state->usages[array_layer][mip_level] = usage;
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001529 if (VendorCheckEnabled(kBPVendorArm)) {
1530 ValidateImageInQueueArm(image, last_usage, usage, array_layer, mip_level);
1531 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001532}
1533
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001534void BestPractices::AddDeferredQueueOperations(CMD_BUFFER_STATE* cb) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001535 cb->queue_submit_functions.insert(cb->queue_submit_functions.end(),
1536 queue_submit_functions_after_render_pass.begin(),
1537 queue_submit_functions_after_render_pass.end());
1538 queue_submit_functions_after_render_pass.clear();
1539}
1540
1541void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
1542 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001543 AddDeferredQueueOperations(GetCBState(commandBuffer));
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001544}
1545
1546void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
1547 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001548 AddDeferredQueueOperations(GetCBState(commandBuffer));
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001549}
1550
1551void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
1552 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001553 AddDeferredQueueOperations(GetCBState(commandBuffer));
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001554}
1555
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001556void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1557 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001558 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1559
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001560 if (!pRenderPassBegin) {
1561 return;
1562 }
1563
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001564 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
1565
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001566 auto rp_state = GetRenderPassState(pRenderPassBegin->renderPass);
1567 if (rp_state) {
1568 // Check load ops
1569 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001570 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001571
1572 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
1573 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1574 continue;
1575 }
1576
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001577 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001578
1579 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
1580 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001581 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001582 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
1583 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001584 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001585 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001586 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001587 }
1588
1589 auto framebuffer = GetFramebufferState(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001590 IMAGE_VIEW_STATE* image_view = nullptr;
1591
1592 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
1593 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1594 if (rpabi) {
1595 image_view = GetImageViewState(rpabi->pAttachments[att]);
1596 }
1597 } else {
1598 image_view = GetImageViewState(framebuffer->createInfo.pAttachments[att]);
1599 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001600
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001601 QueueValidateImageView(cb->queue_submit_functions, image_view, usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001602 }
1603
1604 // Check store ops
1605 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001606 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001607
1608 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1609 continue;
1610 }
1611
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001612 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001613
1614 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
1615 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001616 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001617 }
1618
1619 auto framebuffer = GetFramebufferState(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001620
1621 IMAGE_VIEW_STATE* image_view = nullptr;
1622 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
1623 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1624 if (rpabi) {
1625 image_view = GetImageViewState(rpabi->pAttachments[att]);
1626 }
1627 } else {
1628 image_view = GetImageViewState(framebuffer->createInfo.pAttachments[att]);
1629 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001630
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001631 QueueValidateImageView(queue_submit_functions_after_render_pass, image_view, usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001632 }
1633 }
1634}
1635
Attilio Provenzano02859b22020-02-27 14:17:28 +00001636bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1637 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001638 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1639 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001640 return skip;
1641}
1642
1643bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1644 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001645 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001646 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1647 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001648 return skip;
1649}
1650
1651bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001652 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001653 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1654 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001655 return skip;
1656}
1657
Sam Walls0961ec02020-03-31 16:39:15 +01001658void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1659 const VkRenderPassBeginInfo* pRenderPassBegin) {
1660 auto prepass_state = cbDepthPrePassStates.find(commandBuffer);
1661
1662 // add the tracking state if it doesn't exist
1663 if (prepass_state == cbDepthPrePassStates.end()) {
Jeremy Gebbencbf22862021-03-03 12:01:22 -07001664 auto result = cbDepthPrePassStates.emplace(commandBuffer, DepthPrePassState{});
Sam Walls0961ec02020-03-31 16:39:15 +01001665
1666 if (!result.second) return;
1667
1668 prepass_state = result.first;
1669 }
1670
1671 // reset the renderpass state
1672 prepass_state->second = {};
1673
Hans-Kristian Arntzena1a92cc2021-03-17 13:09:33 +01001674 const auto* rp_state = GetRenderPassState(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01001675
1676 // track depth / color attachment usage within the renderpass
1677 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
1678 // record if depth/color attachments are in use for this renderpass
1679 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) prepass_state->second.depthAttachment = true;
1680
1681 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) prepass_state->second.colorAttachment = true;
1682 }
1683}
1684
1685void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1686 VkSubpassContents contents) {
1687 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1688 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
1689}
1690
1691void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1692 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1693 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1694 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
1695}
1696
1697void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1698 const VkRenderPassBeginInfo* pRenderPassBegin,
1699 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1700 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1701 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
1702}
1703
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001704// Generic function to handle validation for all CmdDraw* type functions
1705bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
1706 bool skip = false;
1707 const CMD_BUFFER_STATE* cb_state = GetCBState(cmd_buffer);
1708 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001709 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
1710 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001711 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001712
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001713 // Verify vertex binding
1714 if (pipeline_state->vertex_binding_descriptions_.size() <= 0) {
1715 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001716 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001717 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001718 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
1719 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001720 }
1721 }
1722 }
1723 return skip;
1724}
1725
Sam Walls0961ec02020-03-31 16:39:15 +01001726void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
1727 if (VendorCheckEnabled(kBPVendorArm)) {
1728 RecordCmdDrawTypeArm(cmd_buffer, draw_count, caller);
1729 }
1730}
1731
1732void BestPractices::RecordCmdDrawTypeArm(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
1733 auto prepass_state = cbDepthPrePassStates.find(cmd_buffer);
1734 if (prepass_state != cbDepthPrePassStates.end() && draw_count >= kDepthPrePassMinDrawCountArm) {
1735 if (prepass_state->second.depthOnly) prepass_state->second.numDrawCallsDepthOnly++;
1736
1737 if (prepass_state->second.depthEqualComparison) prepass_state->second.numDrawCallsDepthEqualCompare++;
1738 }
1739}
1740
Camden5b184be2019-08-13 07:50:19 -06001741bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001742 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06001743 bool skip = false;
1744
1745 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001746 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
1747 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001748 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06001749 }
1750
1751 return skip;
1752}
1753
Sam Walls0961ec02020-03-31 16:39:15 +01001754void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
1755 uint32_t firstVertex, uint32_t firstInstance) {
1756 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
1757 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
1758}
1759
Camden5b184be2019-08-13 07:50:19 -06001760bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001761 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06001762 bool skip = false;
1763
1764 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001765 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
1766 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06001767 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001768 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
1769
Attilio Provenzano02859b22020-02-27 14:17:28 +00001770 // Check if we reached the limit for small indexed draw calls.
1771 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
1772 const CMD_BUFFER_STATE* cmd_state = GetCBState(commandBuffer);
1773 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001774 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
1775 VendorCheckEnabled(kBPVendorArm)) {
1776 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06001777 "%s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00001778 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
1779 "You can try batching drawcalls or instancing when applicable.",
1780 VendorSpecificTag(kBPVendorArm), kMaxSmallIndexedDrawcalls, kSmallIndexedDrawcallIndices);
1781 }
1782
Sam Walls8e77e4f2020-03-16 20:47:40 +00001783 if (VendorCheckEnabled(kBPVendorArm)) {
1784 ValidateIndexBufferArm(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
1785 }
1786
1787 return skip;
1788}
1789
1790bool BestPractices::ValidateIndexBufferArm(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
1791 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
1792 bool skip = false;
1793
1794 // check for sparse/underutilised index buffer, and post-transform cache thrashing
1795 const auto* cmd_state = GetCBState(commandBuffer);
1796 if (cmd_state == nullptr) return skip;
1797
locke-lunarg1ae57d62020-11-18 10:49:19 -07001798 const auto* ib_state = cmd_state->index_buffer_binding.buffer_state.get();
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06001799 if (ib_state == nullptr || cmd_state->index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00001800
1801 const VkIndexType ib_type = cmd_state->index_buffer_binding.index_type;
1802 const auto& ib_mem_state = *ib_state->binding.mem_state;
1803 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
1804 const void* ib_mem = ib_mem_state.p_driver_data;
1805 bool primitive_restart_enable = false;
1806
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001807 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
1808 const auto& pipeline_binding_iter = cmd_state->lastBound[lv_bind_point];
1809 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00001810
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001811 if (pipeline_state != nullptr && pipeline_state->graphicsPipelineCI.pInputAssemblyState != nullptr) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001812 primitive_restart_enable = pipeline_state->graphicsPipelineCI.pInputAssemblyState->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001813 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00001814
1815 // no point checking index buffer if the memory is nonexistant/unmapped, or if there is no graphics pipeline bound to this CB
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001816 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00001817 uint32_t scan_stride;
1818 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
1819 scan_stride = sizeof(uint8_t);
1820 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
1821 scan_stride = sizeof(uint16_t);
1822 } else {
1823 scan_stride = sizeof(uint32_t);
1824 }
1825
1826 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
1827 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
1828
1829 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
1830 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
1831 // irrespective of whether or not they're part of the draw call.
1832
1833 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
1834 uint32_t min_index = ~0u;
1835 // start with maximum as 0 and adjust to indices in the buffer
1836 uint32_t max_index = 0u;
1837
1838 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
1839 // for the given index buffer
1840 uint32_t vertex_shade_count = 0;
1841
1842 PostTransformLRUCacheModel post_transform_cache;
1843
1844 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
1845 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
1846 // target architecture.
1847 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
1848 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
1849 post_transform_cache.resize(32);
1850
1851 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
1852 uint32_t scan_index;
1853 uint32_t primitive_restart_value;
1854 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
1855 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
1856 primitive_restart_value = 0xFF;
1857 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
1858 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
1859 primitive_restart_value = 0xFFFF;
1860 } else {
1861 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
1862 primitive_restart_value = 0xFFFFFFFF;
1863 }
1864
1865 max_index = std::max(max_index, scan_index);
1866 min_index = std::min(min_index, scan_index);
1867
1868 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
1869 bool in_cache = post_transform_cache.query_cache(scan_index);
1870 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
1871 if (!in_cache) vertex_shade_count++;
1872 }
1873 }
1874
1875 // if the max and min values were not set, then we either have no indices, or all primitive restarts, exit...
Sam Walls61b06892020-07-23 16:20:50 +01001876 // if the max and min are the same, then it implies all the indices are the same, then we don't need to do anything
1877 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00001878
1879 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07001880 skip |=
1881 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
1882 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
1883 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
1884 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
1885 "maximum would be loaded, and possibly shaded, whether or not they are used.",
1886 VendorSpecificTag(kBPVendorArm),
1887 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00001888 return skip;
1889 }
1890
1891 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
1892 // each bit of the n-th bucket contains the inclusion information for indices (n*n_buckets) to ((n+1)*n_buckets)
Sam Walls61b06892020-07-23 16:20:50 +01001893 const size_t refs_per_bucket = 64;
1894 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
1895
1896 const uint32_t n_indices = max_index - min_index + 1;
1897 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
1898 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
1899
1900 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
1901 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00001902
1903 // To avoid using too much memory, we run over the indices again.
1904 // Knowing the size from the last scan allows us to record index usage with bitsets
1905 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
1906 uint32_t scan_index;
1907 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
1908 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
1909 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
1910 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
1911 } else {
1912 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
1913 }
1914 // keep track of the set of all indices used to reference vertices in the draw call
1915 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01001916 size_t bitset_bucket_index = index_offset / refs_per_bucket;
1917 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00001918 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
1919 }
1920
1921 uint32_t vertex_reference_count = 0;
1922 for (const auto& bitset : vertex_reference_buckets) {
1923 vertex_reference_count += static_cast<uint32_t>(bitset.count());
1924 }
1925
1926 // low index buffer utilization implies that: of the vertices available to the draw call, not all are utilized
Mark Young0ec6b062020-11-19 15:32:17 -07001927 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00001928 // low hit rate (high miss rate) implies the order of indices in the draw call may be possible to improve
Mark Young0ec6b062020-11-19 15:32:17 -07001929 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00001930
1931 if (utilization < 0.5f) {
1932 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
1933 "%s The indices which were specified for the draw call only utilise approximately "
1934 "%.02f%% of the bound vertex buffer.",
1935 VendorSpecificTag(kBPVendorArm), utilization);
1936 }
1937
1938 if (cache_hit_rate <= 0.5f) {
1939 skip |=
1940 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
1941 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
1942 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
1943 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
1944 "recently shaded vertices.",
1945 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
1946 }
1947 }
1948
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001949 return skip;
1950}
1951
Attilio Provenzano02859b22020-02-27 14:17:28 +00001952void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
1953 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
1954 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
1955 firstInstance);
1956
1957 CMD_BUFFER_STATE* cmd_state = GetCBState(commandBuffer);
1958 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
1959 cmd_state->small_indexed_draw_call_count++;
1960 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001961
1962 ValidateBoundDescriptorSets(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001963}
1964
Sam Walls0961ec02020-03-31 16:39:15 +01001965void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
1966 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
1967 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
1968 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
1969}
1970
sfricke-samsung681ab7b2020-10-29 01:53:35 -07001971bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
1972 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
1973 uint32_t maxDrawCount, uint32_t stride) const {
1974 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
1975
1976 return skip;
1977}
1978
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001979bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
1980 VkDeviceSize offset, VkBuffer countBuffer,
1981 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
1982 uint32_t stride) const {
1983 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06001984
1985 return skip;
1986}
1987
1988bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001989 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06001990 bool skip = false;
1991
1992 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001993 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
1994 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001995 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06001996 }
1997
1998 return skip;
1999}
2000
Sam Walls0961ec02020-03-31 16:39:15 +01002001void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2002 uint32_t count, uint32_t stride) {
2003 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2004 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2005}
2006
Camden5b184be2019-08-13 07:50:19 -06002007bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002008 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002009 bool skip = false;
2010
2011 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002012 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2013 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002014 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002015 }
2016
2017 return skip;
2018}
2019
Sam Walls0961ec02020-03-31 16:39:15 +01002020void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2021 uint32_t count, uint32_t stride) {
2022 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2023 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2024}
2025
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002026void BestPractices::ValidateBoundDescriptorSets(VkCommandBuffer commandBuffer) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002027 CMD_BUFFER_STATE* cb_state = GetCBState(commandBuffer);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002028
2029 if (cb_state) {
2030 for (auto descriptor_set : cb_state->validated_descriptor_sets) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002031 const auto& layout = *descriptor_set->GetLayout();
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002032
2033 for (uint32_t index = 0; index < descriptor_set->GetBindingCount(); ++index) {
2034 // For bindless scenarios, we should not attempt to track descriptor set state.
2035 // It is highly uncertain which resources are actually bound.
2036 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
2037 VkDescriptorBindingFlags flags = layout.GetDescriptorBindingFlagsFromIndex(index);
2038 if (flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT |
2039 VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2040 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
2041 continue;
2042 }
2043
2044 auto index_range = layout.GetGlobalIndexRangeFromIndex(index);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002045 for (uint32_t i = index_range.start; i < index_range.end; ++i) {
ZandroFargnoliacf12f02020-06-18 16:50:00 +01002046 VkImageView image_view{VK_NULL_HANDLE};
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002047
2048 auto descriptor = descriptor_set->GetDescriptorFromGlobalIndex(i);
2049 switch (descriptor->GetClass()) {
2050 case cvdescriptorset::DescriptorClass::Image: {
2051 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2052 image_view = image_descriptor->GetImageView();
2053 }
Hans-Kristian Arntzenbc3a6152021-03-22 13:05:43 +01002054 break;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002055 }
2056 case cvdescriptorset::DescriptorClass::ImageSampler: {
2057 if (const auto image_sampler_descriptor =
2058 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2059 image_view = image_sampler_descriptor->GetImageView();
2060 }
Hans-Kristian Arntzenbc3a6152021-03-22 13:05:43 +01002061 break;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002062 }
ZandroFargnoliacf12f02020-06-18 16:50:00 +01002063 default:
Hans-Kristian Arntzenbc3a6152021-03-22 13:05:43 +01002064 break;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002065 }
2066
2067 if (image_view) {
2068 IMAGE_VIEW_STATE* image_view_state = GetImageViewState(image_view);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002069 QueueValidateImageView(cb_state->queue_submit_functions, image_view_state, IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002070 }
2071 }
2072 }
2073 }
2074 }
2075}
2076
2077void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2078 uint32_t firstVertex, uint32_t firstInstance) {
2079 ValidateBoundDescriptorSets(commandBuffer);
2080}
2081
2082void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2083 uint32_t drawCount, uint32_t stride) {
2084 ValidateBoundDescriptorSets(commandBuffer);
2085}
2086
2087void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2088 uint32_t drawCount, uint32_t stride) {
2089 ValidateBoundDescriptorSets(commandBuffer);
2090}
2091
Camden5b184be2019-08-13 07:50:19 -06002092bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002093 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002094 bool skip = false;
2095
2096 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002097 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2098 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2099 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2100 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002101 }
2102
2103 return skip;
2104}
Camden83a9c372019-08-14 11:41:38 -06002105
Sam Walls0961ec02020-03-31 16:39:15 +01002106bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2107 bool skip = false;
2108
2109 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
2110
2111 auto prepass_state = cbDepthPrePassStates.find(commandBuffer);
2112
2113 if (prepass_state == cbDepthPrePassStates.end()) return skip;
2114
2115 bool uses_depth = (prepass_state->second.depthAttachment || prepass_state->second.colorAttachment) &&
2116 prepass_state->second.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2117 prepass_state->second.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
2118 if (uses_depth) {
2119 skip |= LogPerformanceWarning(
2120 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
2121 "%s Depth pre-passes may be in use. In general, this is not recommended, as in Arm Mali GPUs since "
2122 "Mali-T620, Forward Pixel Killing (FPK) can already perform automatic hidden surface removal; in which "
2123 "case, using depth pre-passes for hidden surface removal may worsen performance.",
2124 VendorSpecificTag(kBPVendorArm));
2125 }
2126
2127 return skip;
2128}
2129
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002130void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
2131 ValidateBoundDescriptorSets(commandBuffer);
2132}
2133
2134void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
2135 ValidateBoundDescriptorSets(commandBuffer);
2136}
2137
Camden Stocker9c051442019-11-06 14:28:43 -08002138bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
2139 const char* api_name) const {
2140 bool skip = false;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002141 const auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08002142
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002143 if (bp_pd_state) {
2144 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
2145 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
2146 "Potential problem with calling %s() without first retrieving properties from "
2147 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
2148 api_name);
2149 }
Camden Stocker9c051442019-11-06 14:28:43 -08002150 }
2151
2152 return skip;
2153}
2154
Camden83a9c372019-08-14 11:41:38 -06002155bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002156 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06002157 bool skip = false;
2158
Camden Stocker9c051442019-11-06 14:28:43 -08002159 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06002160
Camden Stocker9c051442019-11-06 14:28:43 -08002161 return skip;
2162}
2163
2164bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
2165 uint32_t planeIndex,
2166 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
2167 bool skip = false;
2168
2169 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
2170
2171 return skip;
2172}
2173
2174bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
2175 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
2176 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
2177 bool skip = false;
2178
2179 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06002180
2181 return skip;
2182}
Camden05de2d42019-08-19 10:23:56 -06002183
2184bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002185 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06002186 bool skip = false;
2187
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002188 auto swapchain_state_itr = swapchain_bp_state_map.find(swapchain);
Camden05de2d42019-08-19 10:23:56 -06002189
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002190 if ((swapchain_state_itr != swapchain_bp_state_map.cend()) && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06002191 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002192 if (swapchain_state_itr->second.vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002193 skip |=
2194 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
2195 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
2196 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06002197 }
2198 }
2199
2200 return skip;
2201}
2202
2203// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002204bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* pd_state,
2205 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002206 const CALL_STATE call_state,
2207 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06002208 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002209 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
2210 if (UNCALLED == call_state) {
2211 skip |= LogWarning(
2212 pd_state->phys_device, kVUID_Core_DevLimit_MissingQueryCount,
2213 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
2214 "recommended "
2215 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
2216 caller_name, caller_name);
2217 // Then verify that pCount that is passed in on second call matches what was returned
2218 } else if (pd_state->queue_family_known_count != requested_queue_family_property_count) {
2219 skip |= LogWarning(pd_state->phys_device, kVUID_Core_DevLimit_CountMismatch,
2220 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
2221 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
2222 ". It is recommended to instead receive all the properties by calling %s with "
2223 "pQueueFamilyPropertyCount that was "
2224 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
2225 caller_name, requested_queue_family_property_count, pd_state->queue_family_known_count, caller_name,
2226 caller_name);
Camden05de2d42019-08-19 10:23:56 -06002227 }
2228
2229 return skip;
2230}
2231
Jeff Bolz5c801d12019-10-09 10:38:45 -05002232bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
2233 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06002234 bool skip = false;
2235
2236 for (uint32_t i = 0; i < bindInfoCount; i++) {
sourav parmarcd5fb182020-07-17 12:58:44 -07002237 const ACCELERATION_STRUCTURE_STATE* as_state = GetAccelerationStructureStateNV(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06002238 if (!as_state->memory_requirements_checked) {
2239 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
2240 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
2241 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002242 skip |= LogWarning(
2243 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06002244 "vkBindAccelerationStructureMemoryNV(): "
2245 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
2246 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
2247 }
2248 }
2249
2250 return skip;
2251}
2252
Camden05de2d42019-08-19 10:23:56 -06002253bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
2254 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002255 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Camden05de2d42019-08-19 10:23:56 -06002256 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
2257 assert(physical_device_state);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002258 const auto* bp_pd_state = GetPhysicalDeviceStateBP(physical_device_state->phys_device);
2259 if (pQueueFamilyProperties && bp_pd_state) {
2260 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(physical_device_state, *pQueueFamilyPropertyCount,
2261 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
2262 "vkGetPhysicalDeviceQueueFamilyProperties()");
2263 }
2264 return false;
Camden05de2d42019-08-19 10:23:56 -06002265}
2266
Mike Schuchardt2df08912020-12-15 16:28:09 -08002267bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
2268 uint32_t* pQueueFamilyPropertyCount,
2269 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Camden05de2d42019-08-19 10:23:56 -06002270 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
2271 assert(physical_device_state);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002272 const auto* bp_pd_state = GetPhysicalDeviceStateBP(physical_device_state->phys_device);
2273 if (pQueueFamilyProperties && bp_pd_state) {
2274 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(physical_device_state, *pQueueFamilyPropertyCount,
2275 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
2276 "vkGetPhysicalDeviceQueueFamilyProperties2()");
2277 }
2278 return false;
Camden05de2d42019-08-19 10:23:56 -06002279}
2280
Jeff Bolz5c801d12019-10-09 10:38:45 -05002281bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08002282 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Camden05de2d42019-08-19 10:23:56 -06002283 auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
2284 assert(physical_device_state);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002285 const auto* bp_pd_state = GetPhysicalDeviceStateBP(physical_device_state->phys_device);
2286 if (pQueueFamilyProperties && bp_pd_state) {
2287 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(physical_device_state, *pQueueFamilyPropertyCount,
2288 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
2289 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
2290 }
2291 return false;
Camden05de2d42019-08-19 10:23:56 -06002292}
2293
2294bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
2295 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002296 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06002297 if (!pSurfaceFormats) return false;
2298 const auto physical_device_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002299 const auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2300 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06002301 bool skip = false;
2302 if (call_state == UNCALLED) {
2303 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
2304 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002305 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
2306 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
2307 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06002308 } else {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002309 auto prev_format_count = static_cast<uint32_t>(physical_device_state->surface_formats.size());
Peter Chene191bd72019-09-16 13:04:37 -04002310 if (*pSurfaceFormatCount > prev_format_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002311 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
2312 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
2313 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
2314 "when pSurfaceFormatCount was NULL.",
2315 *pSurfaceFormatCount, prev_format_count);
Camden05de2d42019-08-19 10:23:56 -06002316 }
2317 }
2318 return skip;
2319}
Camden Stocker23cc47d2019-09-03 14:53:57 -06002320
2321bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002322 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002323 bool skip = false;
2324
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002325 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2326 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06002327 // Store sparse binding image_state and after binding is complete make sure that any requiring metadata have it bound
Jeremy Gebbencbf22862021-03-03 12:01:22 -07002328 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002329 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
2330 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07002331 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06002332 // If we're binding sparse image memory make sure reqs were queried and note if metadata is required and bound
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002333 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
2334 const auto& image_bind = bind_info.pImageBinds[i];
Camden Stocker23cc47d2019-09-03 14:53:57 -06002335 auto image_state = GetImageState(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002336 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002337 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002338 }
Camden Stocker23cc47d2019-09-03 14:53:57 -06002339 sparse_images.insert(image_state);
2340 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2341 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2342 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002343 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002344 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2345 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002346 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002347 }
2348 }
2349 if (!image_state->memory_requirements_checked) {
2350 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002351 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002352 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2353 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002354 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002355 }
2356 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002357 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2358 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
2359 auto image_state = GetImageState(bind_info.pImageOpaqueBinds[i].image);
2360 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002361 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002362 }
Camden Stocker23cc47d2019-09-03 14:53:57 -06002363 sparse_images.insert(image_state);
2364 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2365 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2366 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002367 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002368 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2369 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002370 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002371 }
2372 }
2373 if (!image_state->memory_requirements_checked) {
2374 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002375 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002376 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2377 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002378 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002379 }
2380 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2381 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002382 sparse_images_with_metadata.insert(image_state);
Camden Stocker23cc47d2019-09-03 14:53:57 -06002383 }
2384 }
2385 }
2386 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002387 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
2388 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002389 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002390 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002391 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
2392 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002393 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002394 }
2395 }
2396 }
2397
2398 return skip;
2399}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002400
Mark Lobodzinski84101d72020-04-24 09:43:48 -06002401void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
2402 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07002403 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07002404 return;
2405 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002406
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002407 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2408 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
2409 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2410 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
2411 auto image_state = GetImageState(bind_info.pImageOpaqueBinds[i].image);
2412 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002413 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002414 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002415 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2416 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
2417 image_state->sparse_metadata_bound = true;
2418 }
2419 }
2420 }
2421 }
2422}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002423
2424bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06002425 const VkClearAttachment* pAttachments, uint32_t rectCount,
2426 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002427 bool skip = false;
2428 const CMD_BUFFER_STATE* cb_node = GetCBState(commandBuffer);
2429 if (!cb_node) return skip;
2430
Camden Stockerf55721f2019-09-09 11:04:49 -06002431 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002432 if (!cb_node->hasDrawCmd && (cb_node->activeRenderPassBeginInfo.renderArea.extent.width == pRects[0].rect.extent.width) &&
2433 (cb_node->activeRenderPassBeginInfo.renderArea.extent.height == pRects[0].rect.extent.height)) {
2434 // There are times where app needs to use ClearAttachments (generally when reusing a buffer inside of a render pass)
2435 // This warning should be made more specific. It'd be best to avoid triggering this test if it's a use that must call
2436 // CmdClearAttachments.
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002437 skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
2438 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds. It is recommended you "
2439 "use RenderPass LOAD_OP_CLEAR on Attachments prior to any Draw.",
2440 report_data->FormatHandle(commandBuffer).c_str());
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002441 }
2442
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00002443 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
2444 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06002445 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00002446 if (rp) {
2447 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
2448
2449 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002450 const auto& attachment = pAttachments[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00002451 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
2452 uint32_t color_attachment = attachment.colorAttachment;
2453 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
2454
2455 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2456 if (rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2457 skip |= LogPerformanceWarning(
2458 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
2459 "vkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
2460 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
2461 "it is more efficient.",
2462 report_data->FormatHandle(commandBuffer).c_str(), color_attachment);
2463 }
2464 }
2465 }
2466
2467 if (subpass.pDepthStencilAttachment && attachment.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
2468 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
2469
2470 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2471 if (rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2472 skip |= LogPerformanceWarning(
2473 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
2474 "vkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
2475 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
2476 "it is more efficient.",
2477 report_data->FormatHandle(commandBuffer).c_str());
2478 }
2479 }
2480 }
2481
2482 if (subpass.pDepthStencilAttachment && attachment.aspectMask & VK_IMAGE_ASPECT_STENCIL_BIT) {
2483 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
2484
2485 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2486 if (rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
2487 skip |= LogPerformanceWarning(
2488 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
2489 "vkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
2490 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
2491 "it is more efficient.",
2492 report_data->FormatHandle(commandBuffer).c_str());
2493 }
2494 }
2495 }
2496 }
2497 }
2498
Camden Stockerf55721f2019-09-09 11:04:49 -06002499 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002500}
Attilio Provenzano02859b22020-02-27 14:17:28 +00002501
2502bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2503 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2504 const VkImageResolve* pRegions) const {
2505 bool skip = false;
2506
2507 skip |= VendorCheckEnabled(kBPVendorArm) &&
2508 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
2509 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
2510 "This is a very slow and extremely bandwidth intensive path. "
2511 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
2512 VendorSpecificTag(kBPVendorArm));
2513
2514 return skip;
2515}
2516
Jeff Leger178b1e52020-10-05 12:22:23 -04002517bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
2518 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
2519 bool skip = false;
2520
2521 skip |= VendorCheckEnabled(kBPVendorArm) &&
2522 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
2523 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
2524 "This is a very slow and extremely bandwidth intensive path. "
2525 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
2526 VendorSpecificTag(kBPVendorArm));
2527
2528 return skip;
2529}
2530
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002531void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2532 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2533 const VkImageResolve* pRegions) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002534 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002535 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002536 auto* src = GetImageUsageState(srcImage);
2537 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002538
2539 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002540 QueueValidateImage(funcs, src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
2541 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002542 }
2543}
2544
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01002545void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
2546 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002547 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002548 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002549 auto* src = GetImageUsageState(pResolveImageInfo->srcImage);
2550 auto* dst = GetImageUsageState(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01002551 uint32_t regionCount = pResolveImageInfo->regionCount;
2552
2553 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002554 QueueValidateImage(funcs, src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
2555 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01002556 }
2557}
2558
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002559void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2560 const VkClearColorValue* pColor, uint32_t rangeCount,
2561 const VkImageSubresourceRange* pRanges) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002562 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002563 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002564 auto* dst = GetImageUsageState(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002565
2566 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002567 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002568 }
2569}
2570
2571void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
2572 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
2573 const VkImageSubresourceRange* pRanges) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002574 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002575 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002576 auto* dst = GetImageUsageState(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002577
2578 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002579 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002580 }
2581}
2582
2583void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2584 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2585 const VkImageCopy* pRegions) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002586 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002587 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002588 auto* src = GetImageUsageState(srcImage);
2589 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002590
2591 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002592 QueueValidateImage(funcs, src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
2593 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002594 }
2595}
2596
2597void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
2598 VkImageLayout dstImageLayout, uint32_t regionCount,
2599 const VkBufferImageCopy* pRegions) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002600 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002601 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002602 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002603
2604 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002605 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002606 }
2607}
2608
2609void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2610 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002611 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002612 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002613 auto* src = GetImageUsageState(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002614
2615 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002616 QueueValidateImage(funcs, src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002617 }
2618}
2619
2620void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
2621 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
2622 const VkImageBlit* pRegions, VkFilter filter) {
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002623 CMD_BUFFER_STATE* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002624 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002625 auto* src = GetImageUsageState(srcImage);
2626 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002627
2628 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002629 QueueValidateImage(funcs, src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
2630 QueueValidateImage(funcs, dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002631 }
2632}
2633
Attilio Provenzano02859b22020-02-27 14:17:28 +00002634bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
2635 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
2636 bool skip = false;
2637
2638 if (VendorCheckEnabled(kBPVendorArm)) {
2639 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
2640 skip |= LogPerformanceWarning(
2641 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
2642 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
2643 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
2644 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06002645 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002646 }
2647
2648 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
2649 skip |= LogPerformanceWarning(
2650 device, kVUID_BestPractices_CreateSampler_LodClamping,
2651 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
2652 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
2653 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
2654 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
2655 }
2656
2657 if (pCreateInfo->mipLodBias != 0.0f) {
2658 skip |=
2659 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
2660 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
2661 "descriptors being created and may cause reduced performance.",
2662 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
2663 }
2664
2665 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
2666 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
2667 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
2668 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
2669 skip |= LogPerformanceWarning(
2670 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
2671 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
2672 "This will lead to less efficient descriptors being created and may cause reduced performance. "
2673 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
2674 VendorSpecificTag(kBPVendorArm));
2675 }
2676
2677 if (pCreateInfo->unnormalizedCoordinates) {
2678 skip |= LogPerformanceWarning(
2679 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
2680 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
2681 "descriptors being created and may cause reduced performance.",
2682 VendorSpecificTag(kBPVendorArm));
2683 }
2684
2685 if (pCreateInfo->anisotropyEnable) {
2686 skip |= LogPerformanceWarning(
2687 device, kVUID_BestPractices_CreateSampler_Anisotropy,
2688 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
2689 "and may cause reduced performance.",
2690 VendorSpecificTag(kBPVendorArm));
2691 }
2692 }
2693
2694 return skip;
2695}
Sam Walls8e77e4f2020-03-16 20:47:40 +00002696
2697void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
2698
2699bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
2700 // look for a cache hit
2701 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
2702 if (hit != _entries.end()) {
2703 // mark the cache hit as being most recently used
2704 hit->age = iteration++;
2705 return true;
2706 }
2707
2708 // if there's no cache hit, we need to model the entry being inserted into the cache
2709 CacheEntry new_entry = {value, iteration};
2710 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
2711 // if there is still space left in the cache, use the next available slot
2712 *(_entries.begin() + iteration) = new_entry;
2713 } else {
2714 // otherwise replace the least recently used cache entry
2715 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
2716 *lru = new_entry;
2717 }
2718 iteration++;
2719 return false;
2720}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002721
2722bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
2723 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
2724 const auto swapchain_data = GetSwapchainState(swapchain);
2725 bool skip = false;
2726 if (swapchain_data && swapchain_data->images.size() == 0) {
2727 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
2728 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
2729 "vkGetSwapchainImagesKHR after swapchain creation.");
2730 }
2731 return skip;
2732}
2733
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002734void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
2735 if (no_pointer) {
2736 if (UNCALLED == call_state) {
2737 call_state = QUERY_COUNT;
2738 }
2739 } else { // Save queue family properties
2740 call_state = QUERY_DETAILS;
2741 }
2742}
2743
Nathaniel Cesariof121d122020-10-08 13:09:46 -06002744void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
2745 uint32_t* pQueueFamilyPropertyCount,
2746 VkQueueFamilyProperties* pQueueFamilyProperties) {
2747 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
2748 pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002749 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002750 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002751 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
2752 nullptr == pQueueFamilyProperties);
2753 }
2754}
2755
2756void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
2757 uint32_t* pQueueFamilyPropertyCount,
2758 VkQueueFamilyProperties2* pQueueFamilyProperties) {
2759 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
2760 pQueueFamilyProperties);
2761 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2762 if (bp_pd_state) {
2763 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
2764 nullptr == pQueueFamilyProperties);
2765 }
2766}
2767
2768void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
2769 uint32_t* pQueueFamilyPropertyCount,
2770 VkQueueFamilyProperties2* pQueueFamilyProperties) {
2771 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
2772 pQueueFamilyProperties);
2773 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2774 if (bp_pd_state) {
2775 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
2776 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002777 }
2778}
2779
Nathaniel Cesariof121d122020-10-08 13:09:46 -06002780void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
2781 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002782 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2783 if (bp_pd_state) {
2784 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
2785 }
2786}
2787
Nathaniel Cesariof121d122020-10-08 13:09:46 -06002788void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
2789 VkPhysicalDeviceFeatures2* pFeatures) {
2790 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002791 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2792 if (bp_pd_state) {
2793 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
2794 }
2795}
2796
Nathaniel Cesariof121d122020-10-08 13:09:46 -06002797void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
2798 VkPhysicalDeviceFeatures2* pFeatures) {
2799 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002800 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2801 if (bp_pd_state) {
2802 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
2803 }
2804}
2805
2806void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
2807 VkSurfaceKHR surface,
2808 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
2809 VkResult result) {
2810 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2811 if (bp_pd_state) {
2812 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
2813 }
2814}
2815
2816void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
2817 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
2818 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
2819 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2820 if (bp_pd_state) {
2821 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
2822 }
2823}
2824
2825void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
2826 VkSurfaceKHR surface,
2827 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
2828 VkResult result) {
2829 auto* bp_pd_state = GetPhysicalDeviceStateBP(physicalDevice);
2830 if (bp_pd_state) {
2831 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
2832 }
2833}
2834
2835void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
2836 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
2837 VkPresentModeKHR* pPresentModes, VkResult result) {
2838 auto* bp_pd_data = GetPhysicalDeviceStateBP(physicalDevice);
2839 if (bp_pd_data) {
2840 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
2841
2842 if (*pPresentModeCount) {
2843 if (call_state < QUERY_COUNT) {
2844 call_state = QUERY_COUNT;
2845 }
2846 }
2847 if (pPresentModes) {
2848 if (call_state < QUERY_DETAILS) {
2849 call_state = QUERY_DETAILS;
2850 }
2851 }
2852 }
2853}
2854
2855void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
2856 uint32_t* pSurfaceFormatCount,
2857 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
2858 auto* bp_pd_data = GetPhysicalDeviceStateBP(physicalDevice);
2859 if (bp_pd_data) {
2860 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
2861
2862 if (*pSurfaceFormatCount) {
2863 if (call_state < QUERY_COUNT) {
2864 call_state = QUERY_COUNT;
2865 }
2866 }
2867 if (pSurfaceFormats) {
2868 if (call_state < QUERY_DETAILS) {
2869 call_state = QUERY_DETAILS;
2870 }
2871 }
2872 }
2873}
2874
2875void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
2876 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
2877 uint32_t* pSurfaceFormatCount,
2878 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
2879 auto* bp_pd_data = GetPhysicalDeviceStateBP(physicalDevice);
2880 if (bp_pd_data) {
2881 if (*pSurfaceFormatCount) {
2882 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
2883 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
2884 }
2885 }
2886 if (pSurfaceFormats) {
2887 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
2888 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
2889 }
2890 }
2891 }
2892}
2893
2894void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
2895 uint32_t* pPropertyCount,
2896 VkDisplayPlanePropertiesKHR* pProperties,
2897 VkResult result) {
2898 auto* bp_pd_data = GetPhysicalDeviceStateBP(physicalDevice);
2899 if (bp_pd_data) {
2900 if (*pPropertyCount) {
2901 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
2902 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
2903 }
2904 }
2905 if (pProperties) {
2906 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
2907 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
2908 }
2909 }
2910 }
2911}
2912
2913void BestPractices::ManualPostCallRecordCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
2914 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain,
2915 VkResult result) {
2916 if (VK_SUCCESS == result) {
2917 swapchain_bp_state_map.emplace(*pSwapchain, SWAPCHAIN_STATE_BP{});
2918 }
2919}
2920
Nathaniel Cesariof121d122020-10-08 13:09:46 -06002921void BestPractices::PostCallRecordDestroySwapchainKHR(VkDevice device, VkSwapchainKHR swapchain,
2922 const VkAllocationCallbacks* pAllocator) {
2923 ValidationStateTracker::PostCallRecordDestroySwapchainKHR(device, swapchain, pAllocator);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002924 auto swapchain_state_itr = swapchain_bp_state_map.find(swapchain);
2925 if (swapchain_state_itr != swapchain_bp_state_map.cend()) {
2926 swapchain_bp_state_map.erase(swapchain_state_itr);
2927 }
2928}
2929
2930void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
2931 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
2932 VkResult result) {
2933 auto swapchain_state_itr = swapchain_bp_state_map.find(swapchain);
2934 assert(swapchain_state_itr != swapchain_bp_state_map.cend());
2935 auto& swapchain_state = swapchain_state_itr->second;
2936 if (pSwapchainImages || *pSwapchainImageCount) {
2937 if (swapchain_state.vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
2938 swapchain_state.vkGetSwapchainImagesKHRState = QUERY_DETAILS;
2939 }
2940 }
2941}
2942
2943void BestPractices::ManualPostCallRecordEnumeratePhysicalDevices(VkInstance instance, uint32_t* pPhysicalDeviceCount,
2944 VkPhysicalDevice* pPhysicalDevices, VkResult result) {
2945 if ((nullptr != pPhysicalDevices) && ((result == VK_SUCCESS || result == VK_INCOMPLETE))) {
2946 for (uint32_t i = 0; i < *pPhysicalDeviceCount; i++) {
2947 phys_device_bp_state_map.emplace(pPhysicalDevices[i], PHYSICAL_DEVICE_STATE_BP{});
2948 }
2949 }
2950}
2951
2952void BestPractices::ManualPostCallRecordCreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo*, const VkAllocationCallbacks*,
2953 VkDevice*, VkResult result) {
2954 if (VK_SUCCESS == result) {
2955 instance_device_bp_state = &phys_device_bp_state_map[gpu];
2956 }
2957}
2958
2959PHYSICAL_DEVICE_STATE_BP* BestPractices::GetPhysicalDeviceStateBP(const VkPhysicalDevice& phys_device) {
2960 if (phys_device_bp_state_map.count(phys_device) > 0) {
2961 return &phys_device_bp_state_map.at(phys_device);
2962 } else {
2963 return nullptr;
2964 }
2965}
2966
2967const PHYSICAL_DEVICE_STATE_BP* BestPractices::GetPhysicalDeviceStateBP(const VkPhysicalDevice& phys_device) const {
2968 if (phys_device_bp_state_map.count(phys_device) > 0) {
2969 return &phys_device_bp_state_map.at(phys_device);
2970 } else {
2971 return nullptr;
2972 }
2973}
2974
2975PHYSICAL_DEVICE_STATE_BP* BestPractices::GetPhysicalDeviceStateBP() {
2976 auto bp_state = (reinterpret_cast<BestPractices*>(instance_state))->instance_device_bp_state;
2977 if (bp_state) {
2978 return bp_state;
2979 } else if (!bp_state && phys_device_bp_state_map.count(physical_device_state->phys_device) > 0) {
2980 return &phys_device_bp_state_map.at(physical_device_state->phys_device);
2981 } else {
2982 return nullptr;
2983 }
2984}
2985
2986const PHYSICAL_DEVICE_STATE_BP* BestPractices::GetPhysicalDeviceStateBP() const {
2987 auto bp_state = (reinterpret_cast<BestPractices*>(instance_state))->instance_device_bp_state;
2988 if (bp_state) {
2989 return bp_state;
2990 } else if (!bp_state && phys_device_bp_state_map.count(physical_device_state->phys_device) > 0) {
2991 return &phys_device_bp_state_map.at(physical_device_state->phys_device);
2992 } else {
2993 return nullptr;
2994 }
2995}
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002996
2997void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
2998 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
2999
3000 QUEUE_STATE* queue_state = GetQueueState(queue);
3001 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003002 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003003 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
3004 CMD_BUFFER_STATE* cb = GetCBState(submit_info.pCommandBuffers[cb_index]);
3005 for (auto &func : cb->queue_submit_functions) {
3006 func(this, queue_state);
3007 }
3008 }
3009 }
3010}
Hans-Kristian Arntzen7a5fdc52021-03-29 11:39:51 +02003011
3012void BestPractices::PreCallRecordBeginCommandBuffer(VkCommandBuffer commandBuffer, const VkCommandBufferBeginInfo* pBeginInfo) {
3013 ValidationStateTracker::PreCallRecordBeginCommandBuffer(commandBuffer, pBeginInfo);
3014 // This should not be required, but guards against buggy applications which do not call EndRenderPass correctly.
3015 queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02003016}