blob: ec2e903264f89e87fb82540bc695784ffe8ca9d8 [file] [log] [blame]
Jeremy Gebben610d3a62022-01-01 12:53:17 -07001/* Copyright (c) 2015-2022 The Khronos Group Inc.
2 * Copyright (c) 2015-2022 Valve Corporation
3 * Copyright (c) 2015-2022 LunarG, Inc.
Nadav Geva41c12a22021-05-21 13:14:05 -04004 * Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
Camdeneaa86ea2019-07-26 11:00:09 -06005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Camden Stocker <camden@lunarg.com>
Nadav Geva41c12a22021-05-21 13:14:05 -040019 * Author: Nadav Geva <nadav.geva@amd.com>
Camdeneaa86ea2019-07-26 11:00:09 -060020 */
21
Mark Lobodzinski57b8ae82020-02-20 16:37:14 -070022#include "best_practices_validation.h"
Camden5b184be2019-08-13 07:50:19 -060023#include "layer_chassis_dispatch.h"
Camden Stocker0a660ce2019-08-27 15:30:40 -060024#include "best_practices_error_enums.h"
Sam Wallsd7ab6db2020-06-19 20:41:54 +010025#include "shader_validation.h"
Jeremy Gebbena3705f42021-01-19 16:47:43 -070026#include "sync_utils.h"
Jeremy Gebben159b3cc2021-06-03 09:09:03 -060027#include "cmd_buffer_state.h"
28#include "device_state.h"
29#include "render_pass_state.h"
Camden5b184be2019-08-13 07:50:19 -060030
31#include <string>
Sam Walls8e77e4f2020-03-16 20:47:40 +000032#include <bitset>
Sam Wallsd7ab6db2020-06-19 20:41:54 +010033#include <memory>
Camden5b184be2019-08-13 07:50:19 -060034
Attilio Provenzano19d6a982020-02-27 12:41:41 +000035struct VendorSpecificInfo {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060036 EnableFlags vendor_id;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000037 std::string name;
38};
39
LawG475463092022-02-22 10:45:54 +000040const std::map<BPVendorFlagBits, VendorSpecificInfo> kVendorInfo = {{kBPVendorArm, {vendor_specific_arm, "Arm"}},
41 {kBPVendorAMD, {vendor_specific_amd, "AMD"}},
Rodrigo Locattic779cb32022-02-25 19:26:31 -030042 {kBPVendorIMG, {vendor_specific_img, "IMG"}},
43 {kBPVendorNVIDIA, {vendor_specific_nvidia, "NVIDIA"}}};
Attilio Provenzano19d6a982020-02-27 12:41:41 +000044
Hannes Harnisch607d1d92021-07-10 18:44:56 +020045const SpecialUseVUIDs kSpecialUseInstanceVUIDs {
46 kVUID_BestPractices_CreateInstance_SpecialUseExtension_CADSupport,
47 kVUID_BestPractices_CreateInstance_SpecialUseExtension_D3DEmulation,
48 kVUID_BestPractices_CreateInstance_SpecialUseExtension_DevTools,
49 kVUID_BestPractices_CreateInstance_SpecialUseExtension_Debugging,
50 kVUID_BestPractices_CreateInstance_SpecialUseExtension_GLEmulation,
51};
52
53const SpecialUseVUIDs kSpecialUseDeviceVUIDs {
54 kVUID_BestPractices_CreateDevice_SpecialUseExtension_CADSupport,
55 kVUID_BestPractices_CreateDevice_SpecialUseExtension_D3DEmulation,
56 kVUID_BestPractices_CreateDevice_SpecialUseExtension_DevTools,
57 kVUID_BestPractices_CreateDevice_SpecialUseExtension_Debugging,
58 kVUID_BestPractices_CreateDevice_SpecialUseExtension_GLEmulation,
59};
60
Jeremy Gebben20da7a12022-02-25 14:07:46 -070061ReadLockGuard BestPractices::ReadLock() {
62 if (fine_grained_locking) {
63 return ReadLockGuard(validation_object_mutex, std::defer_lock);
64 } else {
65 return ReadLockGuard(validation_object_mutex);
66 }
67}
68
69WriteLockGuard BestPractices::WriteLock() {
70 if (fine_grained_locking) {
71 return WriteLockGuard(validation_object_mutex, std::defer_lock);
72 } else {
73 return WriteLockGuard(validation_object_mutex);
74 }
75}
76
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060077std::shared_ptr<CMD_BUFFER_STATE> BestPractices::CreateCmdBufferState(VkCommandBuffer cb,
78 const VkCommandBufferAllocateInfo* pCreateInfo,
Jeremy Gebbencd7fa282021-10-27 10:25:32 -060079 const COMMAND_POOL_STATE* pool) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -070080 return std::static_pointer_cast<CMD_BUFFER_STATE>(std::make_shared<bp_state::CommandBuffer>(this, cb, pCreateInfo, pool));
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060081}
82
Jeremy Gebben20da7a12022-02-25 14:07:46 -070083bp_state::CommandBuffer::CommandBuffer(BestPractices* bp, VkCommandBuffer cb, const VkCommandBufferAllocateInfo* pCreateInfo,
84 const COMMAND_POOL_STATE* pool)
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060085 : CMD_BUFFER_STATE(bp, cb, pCreateInfo, pool) {}
86
Attilio Provenzano19d6a982020-02-27 12:41:41 +000087bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070088 for (const auto& vendor : kVendorInfo) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060089 if (vendors & vendor.first && enabled[vendor.second.vendor_id]) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000090 return true;
91 }
92 }
93 return false;
94}
95
96const char* VendorSpecificTag(BPVendorFlags vendors) {
97 // Cache built vendor tags in a map
Jeremy Gebbencbf22862021-03-03 12:01:22 -070098 static layer_data::unordered_map<BPVendorFlags, std::string> tag_map;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000099
100 auto res = tag_map.find(vendors);
101 if (res == tag_map.end()) {
102 // Build the vendor tag string
103 std::stringstream vendor_tag;
104
105 vendor_tag << "[";
106 bool first_vendor = true;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700107 for (const auto& vendor : kVendorInfo) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +0000108 if (vendors & vendor.first) {
109 if (!first_vendor) {
110 vendor_tag << ", ";
111 }
112 vendor_tag << vendor.second.name;
113 first_vendor = false;
114 }
115 }
116 vendor_tag << "]";
117
118 tag_map[vendors] = vendor_tag.str();
119 res = tag_map.find(vendors);
120 }
121
122 return res->second.c_str();
123}
124
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700125const char* DepReasonToString(ExtDeprecationReason reason) {
126 switch (reason) {
127 case kExtPromoted:
128 return "promoted to";
129 break;
130 case kExtObsoleted:
131 return "obsoleted by";
132 break;
133 case kExtDeprecated:
134 return "deprecated by";
135 break;
136 default:
137 return "";
138 break;
139 }
140}
141
142bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version,
143 const char* vuid) const {
144 bool skip = false;
145 auto dep_info_it = deprecated_extensions.find(extension_name);
146 if (dep_info_it != deprecated_extensions.end()) {
147 auto dep_info = dep_info_it->second;
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600148 if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) ||
Tony-LunarGc30b59f2022-02-15 11:02:36 -0700149 ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2)) ||
150 ((dep_info.target.compare("VK_VERSION_1_3") == 0) && (version >= VK_API_VERSION_1_3))) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700151 skip |=
152 LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
153 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600154 } else if (dep_info.target.find("VK_VERSION") == std::string::npos) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700155 if (dep_info.target.length() == 0) {
156 skip |= LogWarning(instance, vuid,
157 "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated "
158 "without replacement.",
159 api_name, extension_name);
160 } else {
161 skip |= LogWarning(instance, vuid,
162 "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
163 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
164 }
165 }
166 }
167 return skip;
168}
169
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200170bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const SpecialUseVUIDs& special_use_vuids) const
171{
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700172 bool skip = false;
173 auto dep_info_it = special_use_extensions.find(extension_name);
174
175 if (dep_info_it != special_use_extensions.end()) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200176 const char* const format = "%s(): Attempting to enable extension %s, but this extension is intended to support %s "
177 "and it is strongly recommended that it be otherwise avoided.";
178 auto& special_uses = dep_info_it->second;
sfricke-samsungef15e482022-01-26 11:32:49 -0800179
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700180 if (special_uses.find("cadsupport") != std::string::npos) {
sfricke-samsungef15e482022-01-26 11:32:49 -0800181 skip |= LogWarning(instance, special_use_vuids.cadsupport, format, api_name, extension_name,
182 "specialized functionality used by CAD/CAM applications");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700183 }
184 if (special_uses.find("d3demulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200185 skip |= LogWarning(instance, special_use_vuids.d3demulation, format, api_name, extension_name,
186 "D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700187 }
188 if (special_uses.find("devtools") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200189 skip |= LogWarning(instance, special_use_vuids.devtools, format, api_name, extension_name,
190 "developer tools such as capture-replay libraries");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700191 }
192 if (special_uses.find("debugging") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200193 skip |= LogWarning(instance, special_use_vuids.debugging, format, api_name, extension_name,
194 "use by applications when debugging");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700195 }
196 if (special_uses.find("glemulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200197 skip |= LogWarning(instance, special_use_vuids.glemulation, format, api_name, extension_name,
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700198 "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality "
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200199 "specific to those APIs");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700200 }
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700201 }
202 return skip;
203}
204
Camden5b184be2019-08-13 07:50:19 -0600205bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500206 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600207 bool skip = false;
208
209 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
210 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800211 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700212 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
213 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600214 }
Mark Lobodzinski17d8dc62020-06-03 08:48:58 -0600215 uint32_t specified_version =
216 (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0);
217 skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700218 kVUID_BestPractices_CreateInstance_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200219 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseInstanceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600220 }
221
222 return skip;
223}
224
Camden5b184be2019-08-13 07:50:19 -0600225bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500226 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -0600227 bool skip = false;
228
229 // get API version of physical device passed when creating device.
230 VkPhysicalDeviceProperties physical_device_properties{};
231 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500232 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -0600233
234 // check api versions and warn if instance api Version is higher than version on device.
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600235 if (api_version > device_api_version) {
236 std::string inst_api_name = StringAPIVersion(api_version);
Mark Lobodzinski60880782020-08-11 08:02:07 -0600237 std::string dev_api_name = StringAPIVersion(device_api_version);
Camden5b184be2019-08-13 07:50:19 -0600238
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700239 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
240 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
241 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600242 }
243
Rodrigo Locattic2d5cf42022-03-01 18:05:26 -0300244 std::vector<std::string> extensions;
245 {
246 uint32_t property_count = 0;
247 if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, nullptr) == VK_SUCCESS) {
248 std::vector<VkExtensionProperties> property_list(property_count);
249 if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, property_list.data()) == VK_SUCCESS) {
250 extensions.reserve(property_list.size());
251 for (const VkExtensionProperties& properties : property_list) {
252 extensions.push_back(properties.extensionName);
253 }
254 }
255 }
256 }
257
Camden5b184be2019-08-13 07:50:19 -0600258 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300259 const char *extension_name = pCreateInfo->ppEnabledExtensionNames[i];
260
261 if (white_list(extension_name, kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800262 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700263 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300264 extension_name);
Camden5b184be2019-08-13 07:50:19 -0600265 }
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300266
267 skip |= ValidateDeprecatedExtensions("CreateDevice", extension_name, api_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700268 kVUID_BestPractices_CreateDevice_DeprecatedExtension);
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300269 skip |= ValidateSpecialUseExtensions("CreateDevice", extension_name, kSpecialUseDeviceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600270 }
271
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700272 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600273 if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700274 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
275 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600276 }
277
LawG43f848c72022-02-23 09:35:21 +0000278 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorIMG)) &&
279 (pCreateInfo->pEnabledFeatures != nullptr) && (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
Szilard Papp7d2c7952020-06-22 14:38:13 +0100280 skip |= LogPerformanceWarning(
281 device, kVUID_BestPractices_CreateDevice_RobustBufferAccess,
LawG4015be1c2022-03-01 10:37:52 +0000282 "%s %s %s: vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during "
Szilard Papp7d2c7952020-06-22 14:38:13 +0100283 "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage "
284 "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case "
285 "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.",
LawG43f848c72022-02-23 09:35:21 +0000286 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorIMG));
Szilard Papp7d2c7952020-06-22 14:38:13 +0100287 }
288
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300289 const bool enabled_pageable_device_local_memory = IsExtEnabled(device_extensions.vk_ext_pageable_device_local_memory);
290 if (VendorCheckEnabled(kBPVendorNVIDIA) && !enabled_pageable_device_local_memory &&
291 std::find(extensions.begin(), extensions.end(), VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME) != extensions.end()) {
292 skip |= LogPerformanceWarning(
293 device, kVUID_BestPractices_CreateDevice_PageableDeviceLocalMemory,
294 "%s vkCreateDevice() called without pageable device local memory. "
295 "Use pageableDeviceLocalMemory from VK_EXT_pageable_device_local_memory when it is available.",
296 VendorSpecificTag(kBPVendorNVIDIA));
297 }
298
Camden5b184be2019-08-13 07:50:19 -0600299 return skip;
300}
301
302bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500303 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600304 bool skip = false;
305
306 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700307 std::stringstream buffer_hex;
308 buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer);
Camden5b184be2019-08-13 07:50:19 -0600309
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700310 skip |= LogWarning(
311 device, kVUID_BestPractices_SharingModeExclusive,
312 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
313 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700314 buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600315 }
316
317 return skip;
318}
319
320bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500321 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600322 bool skip = false;
323
324 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700325 std::stringstream image_hex;
326 image_hex << "0x" << std::hex << HandleToUint64(pImage);
Camden5b184be2019-08-13 07:50:19 -0600327
328 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700329 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
330 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
331 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700332 image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600333 }
334
ziga-lunarg6df3d102022-03-18 17:02:14 +0100335 if ((pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT) && !(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
336 skip |= LogWarning(device, kVUID_BestPractices_ImageCreateFlags,
337 "vkCreateImage(): pCreateInfo->flags has VK_IMAGE_CREATE_EXTENDED_USAGE_BIT set, but not "
338 "VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, therefore image views created from this image will have to use the "
339 "same format and VK_IMAGE_CREATE_EXTENDED_USAGE_BIT will not have any effect.");
340 }
341
LawG4655f59c2022-02-23 13:55:55 +0000342 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000343 if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
344 skip |= LogPerformanceWarning(
345 device, kVUID_BestPractices_CreateImage_NonTransientMSImage,
LawG4655f59c2022-02-23 13:55:55 +0000346 "%s %s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have "
Attilio Provenzano02859b22020-02-27 14:17:28 +0000347 "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, "
348 "and do not need to be backed by physical storage. "
349 "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.",
LawG4655f59c2022-02-23 13:55:55 +0000350 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Attilio Provenzano02859b22020-02-27 14:17:28 +0000351 }
352 }
353
LawG4ba113892022-02-23 14:39:02 +0000354 if (VendorCheckEnabled(kBPVendorArm) && pCreateInfo->samples > kMaxEfficientSamplesArm) {
355 skip |= LogPerformanceWarning(
356 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
357 "%s vkCreateImage(): Trying to create an image with %u samples. "
358 "The hardware revision may not have full throughput for framebuffers with more than %u samples.",
359 VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm);
360 }
361
362 if (VendorCheckEnabled(kBPVendorIMG) && pCreateInfo->samples > kMaxEfficientSamplesImg) {
363 skip |= LogPerformanceWarning(
364 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
365 "%s vkCreateImage(): Trying to create an image with %u samples. "
366 "The device may not have full support for true multisampling for images with more than %u samples. "
367 "XT devices support up to 8 samples, XE up to 4 samples.",
368 VendorSpecificTag(kBPVendorIMG), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesImg);
369 }
370
LawG4db16f802022-03-21 17:33:39 +0000371 if (VendorCheckEnabled(kBPVendorIMG) && (pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG ||
372 pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG ||
373 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG ||
374 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG ||
375 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG ||
376 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG ||
377 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG ||
378 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG)) {
379 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Texture_Format_PVRTC_Outdated,
380 "%s vkCreateImage(): Trying to create an image with a PVRTC format. Both PVRTC1 and PVRTC2 "
381 "are slower than standard image formats on PowerVR GPUs, prefer ETC, BC, ASTC, etc.",
382 VendorSpecificTag(kBPVendorIMG));
383 }
384
Nadav Gevaf0808442021-05-21 13:51:25 -0400385 if (VendorCheckEnabled(kBPVendorAMD)) {
386 std::stringstream image_hex;
387 image_hex << "0x" << std::hex << HandleToUint64(pImage);
388
389 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
390 (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) {
391 skip |= LogPerformanceWarning(device,
392 kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets,
393 "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. "
394 "Using a SHARING_MODE_CONCURRENT "
395 "is not recommended with color and depth targets",
396 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
397 }
398
399 if ((pCreateInfo->usage &
400 (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
401 (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
402 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets,
403 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. "
404 "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets",
405 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
406 }
407
408 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
409 (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
410 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets,
411 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a "
412 "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets",
413 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
414 }
415 }
416
Rodrigo Locatti5466f9d2022-03-09 18:20:38 -0300417 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
418 std::stringstream image_hex;
419 image_hex << "0x" << std::hex << HandleToUint64(pImage);
420
421 if (pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) {
422 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateImage_TilingLinear,
423 "%s Performance warning: image (%s) is created with tiling VK_IMAGE_TILING_LINEAR. "
424 "Use VK_IMAGE_TILING_OPTIMAL instead.",
425 VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str());
426 }
Rodrigo Locatti3290c2b2022-03-09 18:25:56 -0300427
428 if (pCreateInfo->format == VK_FORMAT_D32_SFLOAT || pCreateInfo->format == VK_FORMAT_D32_SFLOAT_S8_UINT) {
429 skip |= LogPerformanceWarning(
430 device, kVUID_BestPractices_CreateImage_Depth32Format,
431 "%s Performance warning: image (%s) is created with a 32-bit depth format. Use VK_FORMAT_D24_UNORM_S8_UINT or "
432 "VK_FORMAT_D16_UNORM instead, unless the extra precision is needed.",
433 VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str());
434 }
Rodrigo Locatti5466f9d2022-03-09 18:20:38 -0300435 }
436
Camden5b184be2019-08-13 07:50:19 -0600437 return skip;
438}
439
440bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500441 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600442 bool skip = false;
443
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600444 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600445 if (bp_pd_state) {
446 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
447 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
448 "vkCreateSwapchainKHR() called before getting surface capabilities from "
449 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
450 }
Camden83a9c372019-08-14 11:41:38 -0600451
Shannon McPherson73e58c82021-03-05 17:14:26 -0700452 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
453 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600454 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
455 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
456 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
457 }
Camden83a9c372019-08-14 11:41:38 -0600458
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600459 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
460 skip |= LogWarning(
461 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
462 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
463 }
Camden83a9c372019-08-14 11:41:38 -0600464 }
465
Camden5b184be2019-08-13 07:50:19 -0600466 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700467 skip |=
468 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600469 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700470 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
471 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600472 }
473
ziga-lunarg79beba62022-03-30 01:17:30 +0200474 const auto present_mode = pCreateInfo->presentMode;
475 if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) &&
476 (pCreateInfo->minImageCount == 2)) {
Szilard Papp48a6da32020-06-10 14:41:59 +0100477 skip |= LogPerformanceWarning(
478 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
479 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
480 ", which means double buffering is going "
481 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
482 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
483 "3 to use triple buffering to maximize performance in such cases.",
484 pCreateInfo->minImageCount);
485 }
486
Szilard Pappd5f0f812020-06-22 09:01:29 +0100487 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
488 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
489 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
490 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
491 "Presentation modes which are not FIFO will present the latest available frame and discard other "
492 "frame(s) if any.",
493 VendorSpecificTag(kBPVendorArm));
494 }
495
Camden5b184be2019-08-13 07:50:19 -0600496 return skip;
497}
498
499bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
500 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500501 const VkAllocationCallbacks* pAllocator,
502 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600503 bool skip = false;
504
505 for (uint32_t i = 0; i < swapchainCount; i++) {
506 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700507 skip |= LogWarning(
508 device, kVUID_BestPractices_SharingModeExclusive,
509 "Warning: A shared swapchain (index %" PRIu32
510 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
511 "queues (queueFamilyIndexCount of %" PRIu32 ").",
512 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600513 }
514 }
515
516 return skip;
517}
518
519bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500520 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600521 bool skip = false;
522
523 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
524 VkFormat format = pCreateInfo->pAttachments[i].format;
525 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
526 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
527 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700528 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
529 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
530 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
531 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
532 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600533 }
534 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700535 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
536 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
537 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
538 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
539 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600540 }
541 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000542
543 const auto& attachment = pCreateInfo->pAttachments[i];
544 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
545 bool access_requires_memory =
546 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
547
548 if (FormatHasStencil(format)) {
549 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
550 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
551 }
552
553 if (access_requires_memory) {
554 skip |= LogPerformanceWarning(
555 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
556 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
557 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
558 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
559 i, static_cast<uint32_t>(attachment.samples));
560 }
561 }
Camden5b184be2019-08-13 07:50:19 -0600562 }
563
564 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
565 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
566 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
567 }
568
569 return skip;
570}
571
Tony-LunarG767180f2020-04-23 14:03:59 -0600572bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
573 const VkImageView* image_views) const {
574 bool skip = false;
575
576 // Check for non-transient attachments that should be transient and vice versa
577 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200578 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600579 bool attachment_should_be_transient =
580 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
581
582 if (FormatHasStencil(attachment.format)) {
583 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
584 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
585 }
586
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600587 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600588 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600589 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600590
591 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
592
593 // The check for an image that should not be transient applies to all GPUs
594 if (!attachment_should_be_transient && image_is_transient) {
595 skip |= LogPerformanceWarning(
596 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
597 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
598 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
599 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
600 i);
601 }
602
603 bool supports_lazy = false;
604 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
605 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
606 supports_lazy = true;
607 }
608 }
609
610 // The check for an image that should be transient only applies to GPUs supporting
611 // lazily allocated memory
612 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
613 skip |= LogPerformanceWarning(
614 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
615 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
616 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
617 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
618 i);
619 }
620 }
621 }
622 return skip;
623}
624
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000625bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
626 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
627 bool skip = false;
628
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600629 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800630 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600631 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000632 }
633
634 return skip;
635}
636
Sam Wallse746d522020-03-16 21:20:23 +0000637bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
638 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
639 bool skip = false;
640 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
641
642 if (!skip) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700643 const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000644 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
645 // this warning is specific to Arm
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700646 if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) {
Sam Wallse746d522020-03-16 21:20:23 +0000647 skip |= LogPerformanceWarning(
648 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
649 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
650 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
651 VendorSpecificTag(kBPVendorArm));
652 }
ziga-lunarg5a76c442022-04-17 18:04:08 +0200653
654 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
655 // Track number of descriptorSets allowable in this pool
656 if (pool_state->GetAvailableSets() < pAllocateInfo->descriptorSetCount) {
657 skip |= LogWarning(pool_state->Handle(), kVUID_BestPractices_EmptyDescriptorPool,
658 "vkAllocateDescriptorSets(): Unable to allocate %" PRIu32 " descriptorSets from %s"
659 ". This pool only has %" PRIu32 " descriptorSets remaining.",
660 pAllocateInfo->descriptorSetCount, report_data->FormatHandle(pool_state->Handle()).c_str(),
661 pool_state->GetAvailableSets());
662 }
663 }
Sam Wallse746d522020-03-16 21:20:23 +0000664 }
665
666 return skip;
667}
668
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600669void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
670 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000671 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700672 auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
673 if (pool_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000674 // we record successful allocations by subtracting the allocation count from the last recorded free count
675 const auto alloc_count = pAllocateInfo->descriptorSetCount;
676 // clamp the unsigned subtraction to the range [0, last_free_count]
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700677 if (pool_state->freed_count > alloc_count) {
678 pool_state->freed_count -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700679 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700680 pool_state->freed_count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700681 }
Sam Wallse746d522020-03-16 21:20:23 +0000682 }
683 }
684}
685
686void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
687 const VkDescriptorSet* pDescriptorSets, VkResult result) {
688 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
689 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700690 auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000691 // we want to track frees because we're interested in suggesting re-use
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700692 if (pool_state) {
693 pool_state->freed_count += descriptorSetCount;
Sam Wallse746d522020-03-16 21:20:23 +0000694 }
695 }
696}
697
Rodrigo Locattid5b54f52022-03-16 19:12:45 -0300698void BestPractices::PreCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
699 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) {
700 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
701 WriteLockGuard guard{memory_free_events_lock_};
702
703 // Release old allocations to avoid overpopulating the container
704 const auto now = std::chrono::high_resolution_clock::now();
705 const auto last_old = std::find_if(memory_free_events_.rbegin(), memory_free_events_.rend(), [now](const MemoryFreeEvent& event) {
706 return now - event.time > kAllocateMemoryReuseTimeThresholdNVIDIA;
707 });
708 memory_free_events_.erase(memory_free_events_.begin(), last_old.base());
709 }
710}
711
Camden5b184be2019-08-13 07:50:19 -0600712bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500713 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600714 bool skip = false;
715
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700716 if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700717 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
718 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600719 }
720
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000721 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
722 skip |= LogPerformanceWarning(
723 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600724 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
725 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000726 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
727 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
728 }
729
Rodrigo Locattid5b54f52022-03-16 19:12:45 -0300730 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
731 if (!device_extensions.vk_ext_pageable_device_local_memory &&
732 !LvlFindInChain<VkMemoryPriorityAllocateInfoEXT>(pAllocateInfo->pNext)) {
733 skip |= LogPerformanceWarning(
734 device, kVUID_BestPractices_AllocateMemory_SetPriority,
735 "%s Use VkMemoryPriorityAllocateInfoEXT to provide the operating system information on the allocations that "
736 "should stay in video memory and which should be demoted first when video memory is limited. "
737 "The highest priority should be given to GPU-written resources like color attachments, depth attachments, "
738 "storage images, and buffers written from the GPU.",
739 VendorSpecificTag(kBPVendorNVIDIA));
740 }
741
742 {
743 // Size in bytes for an allocation to be considered "compatible"
744 static constexpr VkDeviceSize size_threshold = VkDeviceSize{1} << 20;
745
746 ReadLockGuard guard{memory_free_events_lock_};
747
748 const auto now = std::chrono::high_resolution_clock::now();
749 const VkDeviceSize alloc_size = pAllocateInfo->allocationSize;
750 const uint32_t memory_type_index = pAllocateInfo->memoryTypeIndex;
751 const auto latest_event = std::find_if(memory_free_events_.rbegin(), memory_free_events_.rend(), [&](const MemoryFreeEvent& event) {
752 return (memory_type_index == event.memory_type_index) && (alloc_size <= event.allocation_size) &&
753 (alloc_size - event.allocation_size <= size_threshold) && (now - event.time < kAllocateMemoryReuseTimeThresholdNVIDIA);
754 });
755
756 if (latest_event != memory_free_events_.rend()) {
757 const auto time_delta = std::chrono::duration_cast<std::chrono::milliseconds>(now - latest_event->time);
758 if (time_delta < std::chrono::milliseconds{5}) {
759 skip |=
760 LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_ReuseAllocations,
761 "%s Reuse memory allocations instead of releasing and reallocating. A memory allocation "
762 "has just been released, and it could have been reused in place of this allocation.",
763 VendorSpecificTag(kBPVendorNVIDIA));
764 } else {
765 const uint32_t seconds = static_cast<uint32_t>(time_delta.count() / 1000);
766 const uint32_t milliseconds = static_cast<uint32_t>(time_delta.count() % 1000);
767
768 skip |= LogPerformanceWarning(
769 device, kVUID_BestPractices_AllocateMemory_ReuseAllocations,
770 "%s Reuse memory allocations instead of releasing and reallocating. A memory allocation has been released "
771 "%" PRIu32 ".%03" PRIu32 " seconds ago, and it could have been reused in place of this allocation.",
772 VendorSpecificTag(kBPVendorNVIDIA), seconds, milliseconds);
773 }
774 }
775 }
Rodrigo Locattie4f8d522022-03-15 16:30:49 -0300776 }
777
Camden83a9c372019-08-14 11:41:38 -0600778 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
779
780 return skip;
781}
782
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600783void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
784 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
785 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700786 if (result != VK_SUCCESS) {
787 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
788 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800789 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700790 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600791 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700792 return;
793 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700794}
Camden Stocker9738af92019-10-16 13:54:03 -0700795
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600796void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
797 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700798 auto error = std::find(error_codes.begin(), error_codes.end(), result);
799 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000800 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
801 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
802
803 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
804 if (common_failure != common_failure_codes.end()) {
805 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
806 } else {
807 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
808 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700809 return;
810 }
811 auto success = std::find(success_codes.begin(), success_codes.end(), result);
812 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600813 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
814 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500815 }
816}
817
Rodrigo Locattid5b54f52022-03-16 19:12:45 -0300818void BestPractices::PreCallRecordFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks* pAllocator) {
819 if (memory != VK_NULL_HANDLE && VendorCheckEnabled(kBPVendorNVIDIA)) {
820 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
821
822 // Exclude memory free events on dedicated allocations, or imported/exported allocations.
823 if (!mem_info->IsDedicatedBuffer() && !mem_info->IsDedicatedImage() && !mem_info->IsExport() && !mem_info->IsImport()) {
824 MemoryFreeEvent event;
825 event.time = std::chrono::high_resolution_clock::now();
826 event.memory_type_index = mem_info->alloc_info.memoryTypeIndex;
827 event.allocation_size = mem_info->alloc_info.allocationSize;
828
829 WriteLockGuard guard{memory_free_events_lock_};
830 memory_free_events_.push_back(event);
831 }
832 }
833
834 ValidationStateTracker::PreCallRecordFreeMemory(device, memory, pAllocator);
835}
836
Jeff Bolz5c801d12019-10-09 10:38:45 -0500837bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
838 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700839 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600840 bool skip = false;
841
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700842 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600843
Jeremy Gebben610d3a62022-01-01 12:53:17 -0700844 for (const auto& item : mem_info->ObjectBindings()) {
845 const auto& obj = item.first;
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600846 LogObjectList objlist(device);
847 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600848 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600849 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 -0600850 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600851 }
852
Camden5b184be2019-08-13 07:50:19 -0600853 return skip;
854}
855
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000856bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600857 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700858 auto buffer_state = Get<BUFFER_STATE>(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600859
sfricke-samsunge2441192019-11-06 14:07:57 -0800860 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700861 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
862 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
863 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600864 }
865
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700866 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000867
AndreyVK_D3D0416a332021-11-02 23:22:28 +0300868 if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000869 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
870 skip |= LogPerformanceWarning(
871 device, kVUID_BestPractices_SmallDedicatedAllocation,
872 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600873 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
874 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000875 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
876 }
877
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300878 skip |= ValidateBindMemory(device, memory);
879
Camden Stockerb603cc82019-09-03 10:09:02 -0600880 return skip;
881}
882
883bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500884 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600885 bool skip = false;
886 const char* api_name = "BindBufferMemory()";
887
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000888 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600889
890 return skip;
891}
892
893bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500894 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600895 char api_name[64];
896 bool skip = false;
897
898 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200899 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000900 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600901 }
902
903 return skip;
904}
Camden Stockerb603cc82019-09-03 10:09:02 -0600905
906bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500907 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600908 char api_name[64];
909 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600910
Camden Stocker8b798ab2019-09-03 10:33:28 -0600911 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200912 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000913 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600914 }
915
916 return skip;
917}
918
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000919bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600920 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700921 auto image_state = Get<IMAGE_STATE>(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600922
sfricke-samsung71bc6572020-04-29 15:49:43 -0700923 if (image_state->disjoint == false) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600924 if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700925 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
926 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
927 api_name, report_data->FormatHandle(image).c_str());
928 }
929 } else {
930 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
931 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600932 }
933
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700934 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000935
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600936 if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000937 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
938 skip |= LogPerformanceWarning(
939 device, kVUID_BestPractices_SmallDedicatedAllocation,
940 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600941 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
942 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000943 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
944 }
945
946 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
947 // make sure this type is actually used.
948 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
949 // (i.e.most tile - based renderers)
950 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
951 bool supports_lazy = false;
952 uint32_t suggested_type = 0;
953
954 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600955 if ((1u << i) & image_state->requirements[0].memoryTypeBits) {
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000956 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
957 supports_lazy = true;
958 suggested_type = i;
959 break;
960 }
961 }
962 }
963
964 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
965
966 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
967 skip |= LogPerformanceWarning(
968 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600969 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000970 "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 -0600971 "%" PRIu64 " bytes of physical memory.",
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600972 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000973 }
974 }
975
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300976 skip |= ValidateBindMemory(device, memory);
977
Camden Stocker8b798ab2019-09-03 10:33:28 -0600978 return skip;
979}
980
981bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500982 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600983 bool skip = false;
984 const char* api_name = "vkBindImageMemory()";
985
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000986 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600987
988 return skip;
989}
990
991bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500992 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600993 char api_name[64];
994 bool skip = false;
995
996 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200997 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700998 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -0600999 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
1000 }
Camden Stocker8b798ab2019-09-03 10:33:28 -06001001 }
1002
1003 return skip;
1004}
1005
1006bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001007 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -06001008 char api_name[64];
1009 bool skip = false;
1010
1011 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +02001012 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +00001013 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -06001014 }
1015
1016 return skip;
1017}
Camden83a9c372019-08-14 11:41:38 -06001018
Rodrigo Locatti66b23352022-03-15 17:28:32 -03001019void BestPractices::PreCallRecordSetDeviceMemoryPriorityEXT(VkDevice device, VkDeviceMemory memory, float priority) {
1020 auto mem_info = std::static_pointer_cast<bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory));
1021 mem_info->dynamic_priority.emplace(priority);
1022}
1023
Attilio Provenzano02859b22020-02-27 14:17:28 +00001024static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
1025 switch (format) {
1026 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
1027 case VK_FORMAT_R16_SFLOAT:
1028 case VK_FORMAT_R16G16_SFLOAT:
1029 case VK_FORMAT_R16G16B16_SFLOAT:
1030 case VK_FORMAT_R16G16B16A16_SFLOAT:
1031 case VK_FORMAT_R32_SFLOAT:
1032 case VK_FORMAT_R32G32_SFLOAT:
1033 case VK_FORMAT_R32G32B32_SFLOAT:
1034 case VK_FORMAT_R32G32B32A32_SFLOAT:
1035 return false;
1036
1037 default:
1038 return true;
1039 }
1040}
1041
1042bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
1043 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
1044 bool skip = false;
1045
1046 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001047 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001048
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001049 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
1050 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
1051 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +00001052 return skip;
1053 }
1054
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001055 auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001056 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001057
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +02001058 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1059 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount);
1060
1061 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001062 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001063 uint32_t att = subpass.pColorAttachments[j].attachment;
1064
1065 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
1066 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
1067 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
1068 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
1069 "color attachment #%u makes use "
1070 "of a format which cannot be blended at full throughput when using MSAA.",
1071 VendorSpecificTag(kBPVendorArm), i, j);
1072 }
1073 }
1074 }
1075 }
1076
1077 return skip;
1078}
1079
Nadav Gevaf0808442021-05-21 13:51:25 -04001080void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1081 const VkComputePipelineCreateInfo* pCreateInfos,
1082 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1083 VkResult result, void* pipe_state) {
1084 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001085 pipeline_cache_ = pipelineCache;
Nadav Gevaf0808442021-05-21 13:51:25 -04001086}
1087
Camden5b184be2019-08-13 07:50:19 -06001088bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1089 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001090 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001091 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001092 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1093 pAllocator, pPipelines, cgpl_state_data);
ziga-lunarg08c81582022-03-08 17:33:45 +01001094 if (skip) {
1095 return skip;
1096 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001097 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001098
1099 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001100 skip |= LogPerformanceWarning(
1101 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1102 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
1103 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001104 }
1105
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001106 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001107 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001108
Tony-LunarGb6a2daf2022-07-29 11:30:55 -06001109 if (!(cgpl_state->pipe_state[i]->active_shaders & VK_SHADER_STAGE_MESH_BIT_NV) && create_info.pVertexInputState) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001110 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001111 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001112 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
1113 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001114 count++;
1115 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001116 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001117 if (count > kMaxInstancedVertexBuffers) {
1118 skip |= LogPerformanceWarning(
1119 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
1120 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
1121 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
1122 count, kMaxInstancedVertexBuffers);
1123 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001124 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001125
Szilard Pappaaf2da32020-06-22 10:37:35 +01001126 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
1127 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001128 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
1129 VendorCheckEnabled(kBPVendorArm)) {
1130 skip |= LogPerformanceWarning(
1131 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
1132 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
1133 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
1134 "efficiency during rasterization. Consider disabling depthBias or increasing either "
1135 "depthBiasConstantFactor or depthBiasSlopeFactor.",
1136 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +01001137 }
1138
Attilio Provenzano02859b22020-02-27 14:17:28 +00001139 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001140 }
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001141 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001142 auto prev_pipeline = pipeline_cache_.load();
1143 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001144 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001145 "%s %s Performance Warning: A second pipeline cache is in use. "
1146 "Consider using only one pipeline cache to improve cache hit rate.",
1147 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04001148 }
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001149 }
1150 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001151 if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001152 skip |=
1153 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
1154 "%s Performance warning: Too many pipelines created, consider consolidation",
1155 VendorSpecificTag(kBPVendorAMD));
1156 }
1157
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -06001158 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001159 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
1160 "%s Performance warning: Use of primitive restart is not recommended",
1161 VendorSpecificTag(kBPVendorAMD));
1162 }
1163
1164 // TODO: this might be too aggressive of a check
1165 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1166 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1167 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1168 VendorSpecificTag(kBPVendorAMD));
1169 }
1170 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001171
Camden5b184be2019-08-13 07:50:19 -06001172 return skip;
1173}
1174
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001175static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info,
1176 std::shared_ptr<const RENDER_PASS_STATE>& rp) {
1177 std::vector<bp_state::AttachmentInfo> result;
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06001178 if (!rp || rp->UsesDynamicRendering()) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001179 return result;
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001180 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001181
1182 const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1183
1184 // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState
1185 // are only non-null if they are enabled.
1186 if (create_info.pColorBlendState) {
1187 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1188 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount);
1189 for (uint32_t j = 0; j < num_color_attachments; j++) {
1190 if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) {
1191 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1192 if (attachment != VK_ATTACHMENT_UNUSED) {
1193 result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT});
1194 }
1195 }
1196 }
1197 }
1198
1199 if (create_info.pDepthStencilState &&
1200 (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable ||
1201 create_info.pDepthStencilState->stencilTestEnable)) {
1202 uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED;
1203 if (attachment != VK_ATTACHMENT_UNUSED) {
1204 VkImageAspectFlags aspects = 0;
1205 if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) {
1206 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1207 }
1208 if (create_info.pDepthStencilState->stencilTestEnable) {
1209 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1210 }
1211 result.push_back({attachment, aspects});
1212 }
1213 }
1214 return result;
1215}
1216
1217bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo,
1218 std::shared_ptr<const RENDER_PASS_STATE>&& rpstate,
1219 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout)
1220 : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)),
1221 access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {}
1222
1223std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState(
1224 const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass,
1225 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const {
1226 return std::static_pointer_cast<PIPELINE_STATE>(
1227 std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout)));
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001228}
1229
Sam Walls0961ec02020-03-31 16:39:15 +01001230void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1231 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1232 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1233 VkResult result, void* cgpl_state_data) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001234 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001235 pipeline_cache_ = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001236}
1237
Camden5b184be2019-08-13 07:50:19 -06001238bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1239 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001240 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001241 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001242 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1243 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001244
1245 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001246 skip |= LogPerformanceWarning(
1247 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1248 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1249 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001250 }
1251
Nadav Gevaf0808442021-05-21 13:51:25 -04001252 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001253 auto prev_pipeline = pipeline_cache_.load();
1254 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
1255 skip |= LogPerformanceWarning(
1256 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1257 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
Nadav Gevaf0808442021-05-21 13:51:25 -04001258 "improve cache hit rate",
1259 VendorSpecificTag(kBPVendorAMD));
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001260 }
1261 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001262
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001263 for (uint32_t i = 0; i < createInfoCount; i++) {
1264 const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i];
1265 if (VendorCheckEnabled(kBPVendorArm)) {
1266 skip |= ValidateCreateComputePipelineArm(createInfo);
1267 }
sfricke-samsung86d055a2022-02-11 14:43:50 -08001268
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001269 if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) {
1270 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
1271 for (const auto& builtin : module_state->static_data_.builtin_decoration_list) {
1272 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1273 skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize,
1274 "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32
1275 "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 "
1276 "extension exposes a new LocalSizeId execution mode that should be used instead.",
1277 i);
sfricke-samsung86d055a2022-02-11 14:43:50 -08001278 }
1279 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001280 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001281 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001282
1283 return skip;
1284}
1285
1286bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1287 bool skip = false;
sfricke-samsungef15e482022-01-26 11:32:49 -08001288 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001289 // Generate warnings about work group sizes based on active resources.
sfricke-samsungef15e482022-01-26 11:32:49 -08001290 auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
1291 if (entrypoint == module_state->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001292
1293 uint32_t x = 1, y = 1, z = 1;
sfricke-samsungef15e482022-01-26 11:32:49 -08001294 module_state->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001295
1296 uint32_t thread_count = x * y * z;
1297
1298 // Generate a priori warnings about work group sizes.
1299 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1300 skip |= LogPerformanceWarning(
1301 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1302 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1303 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1304 "groups with less than %u threads, especially when using barrier() or shared memory.",
1305 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1306 }
1307
1308 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1309 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1310 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1311 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1312 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1313 "%u, %u) is not aligned to %u "
1314 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1315 "leave threads idle on the shader "
1316 "core.",
1317 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1318 kThreadGroupDispatchCountAlignmentArm);
1319 }
1320
sfricke-samsungef15e482022-01-26 11:32:49 -08001321 auto accessible_ids = module_state->MarkAccessibleIds(entrypoint);
1322 auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001323
1324 unsigned dimensions = 0;
1325 if (x > 1) dimensions++;
1326 if (y > 1) dimensions++;
1327 if (z > 1) dimensions++;
1328 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1329 dimensions = std::max(dimensions, 1u);
1330
1331 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1332 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1333 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1334 bool accesses_2d = false;
1335 for (const auto& usage : descriptor_uses) {
sfricke-samsungef15e482022-01-26 11:32:49 -08001336 auto dim = module_state->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001337 if (dim < 0) continue;
1338 auto spvdim = spv::Dim(dim);
1339 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1340 }
1341
1342 if (accesses_2d && dimensions < 2) {
1343 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1344 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1345 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1346 "exhibiting poor spatial locality with respect to one or more shader resources.",
1347 VendorSpecificTag(kBPVendorArm), x, y, z);
1348 }
1349
Camden5b184be2019-08-13 07:50:19 -06001350 return skip;
1351}
1352
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001353bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001354 bool skip = false;
1355
1356 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001357 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1358 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001359 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001360 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1361 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001362 }
1363
1364 return skip;
1365}
1366
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001367bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1368 bool skip = false;
1369
1370 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1371 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1372 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1373 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1374 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1375 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1376 }
1377
1378 return skip;
1379}
1380
1381bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1382 bool skip = false;
1383 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1384
1385 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1386 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1387
1388 return skip;
1389}
1390
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001391void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001392 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1393 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1394 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1395 LogPerformanceWarning(
1396 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1397 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1398 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1399 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1400 "convenient opportunity.",
1401 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1402 }
1403 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001404
1405 // AMD best practice
1406 // end-of-frame cleanup
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001407 num_queue_submissions_ = 0;
1408 num_barriers_objects_ = 0;
1409 ClearPipelinesUsedInFrame();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001410}
1411
Jeff Bolz5c801d12019-10-09 10:38:45 -05001412bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1413 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001414 bool skip = false;
1415
1416 for (uint32_t submit = 0; submit < submitCount; submit++) {
1417 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1418 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1419 }
ziga-lunargc77f0c02022-04-18 00:15:16 +02001420 if (pSubmits[submit].signalSemaphoreCount == 0 && pSubmits[submit].pSignalSemaphores != nullptr) {
1421 skip |=
1422 LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1423 "pSubmits[%" PRIu32 "].pSignalSemaphores is set, but pSubmits[%" PRIu32 "].signalSemaphoreCount is 0.",
1424 submit, submit);
1425 }
1426 if (pSubmits[submit].waitSemaphoreCount == 0 && pSubmits[submit].pWaitSemaphores != nullptr) {
1427 skip |= LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1428 "pSubmits[%" PRIu32 "].pWaitSemaphores is set, but pSubmits[%" PRIu32 "].waitSemaphoreCount is 0.",
1429 submit, submit);
1430 }
Camden5b184be2019-08-13 07:50:19 -06001431 }
1432
1433 return skip;
1434}
1435
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001436bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1437 VkFence fence) const {
1438 bool skip = false;
1439
1440 for (uint32_t submit = 0; submit < submitCount; submit++) {
1441 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1442 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1443 }
1444 }
1445
1446 return skip;
1447}
1448
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001449bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits,
1450 VkFence fence) const {
1451 bool skip = false;
1452
1453 for (uint32_t submit = 0; submit < submitCount; submit++) {
1454 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1455 skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1456 }
1457 }
1458
1459 return skip;
1460}
1461
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001462bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1463 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1464 bool skip = false;
1465
1466 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1467 skip |= LogPerformanceWarning(
1468 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1469 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1470 "pool instead.");
1471 }
1472
1473 return skip;
1474}
1475
1476bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1477 const VkCommandBufferBeginInfo* pBeginInfo) const {
1478 bool skip = false;
1479
1480 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1481 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1482 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1483 }
1484
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001485 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1486 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001487 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1488 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1489 VendorSpecificTag(kBPVendorArm));
1490 }
1491
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001492 return skip;
1493}
1494
Jeff Bolz5c801d12019-10-09 10:38:45 -05001495bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001496 bool skip = false;
1497
1498 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1499
1500 return skip;
1501}
1502
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001503bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1504 const VkDependencyInfoKHR* pDependencyInfo) const {
1505 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1506}
1507
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001508bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1509 const VkDependencyInfo* pDependencyInfo) const {
1510 return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo);
1511}
1512
Jeff Bolz5c801d12019-10-09 10:38:45 -05001513bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1514 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001515 bool skip = false;
1516
1517 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1518
1519 return skip;
1520}
1521
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001522bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1523 VkPipelineStageFlags2KHR stageMask) const {
1524 bool skip = false;
1525
1526 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1527
1528 return skip;
1529}
1530
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001531bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1532 VkPipelineStageFlags2 stageMask) const {
1533 bool skip = false;
1534
1535 skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask);
1536
1537 return skip;
1538}
1539
Camden5b184be2019-08-13 07:50:19 -06001540bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1541 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1542 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1543 uint32_t bufferMemoryBarrierCount,
1544 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1545 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001546 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001547 bool skip = false;
1548
1549 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1550 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1551
1552 return skip;
1553}
1554
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001555bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1556 const VkDependencyInfoKHR* pDependencyInfos) const {
1557 bool skip = false;
1558 for (uint32_t i = 0; i < eventCount; i++) {
1559 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1560 }
1561
1562 return skip;
1563}
1564
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001565bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1566 const VkDependencyInfo* pDependencyInfos) const {
1567 bool skip = false;
1568 for (uint32_t i = 0; i < eventCount; i++) {
1569 skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]);
1570 }
1571
1572 return skip;
1573}
1574
Camden5b184be2019-08-13 07:50:19 -06001575bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1576 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1577 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1578 uint32_t bufferMemoryBarrierCount,
1579 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1580 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001581 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001582 bool skip = false;
1583
1584 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1585 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1586
ziga-lunargb65dbfb2022-03-19 18:45:09 +01001587 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1588 if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED &&
1589 IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) {
1590 skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly,
1591 "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents "
1592 "may be discarded, but the newLayout is %s, which is read only.",
1593 string_VkImageLayout(pImageMemoryBarriers[i].newLayout));
1594 }
1595 }
1596
Nadav Gevaf0808442021-05-21 13:51:25 -04001597 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001598 auto num = num_barriers_objects_.load();
1599 if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001600 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001601 "%s Performance warning: In this frame, %" PRIu32
1602 " barriers were already submitted. Barriers have a high cost and can "
1603 "stall the GPU. "
1604 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1605 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04001606 }
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001607 }
1608 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
1609 static constexpr std::array<VkImageLayout, 3> read_layouts = {
Nadav Gevaf0808442021-05-21 13:51:25 -04001610 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1611 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1612 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1613 };
1614
1615 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1616 // read to read barriers
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001617 const auto &image_barrier = pImageMemoryBarriers[i];
1618 bool old_is_read_layout = std::find(read_layouts.begin(), read_layouts.end(), image_barrier.oldLayout) != read_layouts.end();
1619 bool new_is_read_layout = std::find(read_layouts.begin(), read_layouts.end(), image_barrier.newLayout) != read_layouts.end();
1620
Nadav Gevaf0808442021-05-21 13:51:25 -04001621 if (old_is_read_layout && new_is_read_layout) {
1622 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001623 "%s %s Performance warning: Don't issue read-to-read barriers. "
1624 "Get the resource in the right state the first time you use it.",
1625 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04001626 }
1627
1628 // general with no storage
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001629 if (VendorCheckEnabled(kBPVendorAMD) && image_barrier.newLayout == VK_IMAGE_LAYOUT_GENERAL) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001630 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1631 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1632 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1633 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1634 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1635 VendorSpecificTag(kBPVendorAMD));
1636 }
1637 }
1638 }
1639 }
1640
Camden5b184be2019-08-13 07:50:19 -06001641 return skip;
1642}
1643
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001644bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1645 const VkDependencyInfoKHR* pDependencyInfo) const {
1646 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1647}
1648
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001649bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer,
1650 const VkDependencyInfo* pDependencyInfo) const {
1651 return CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo);
1652}
1653
Camden5b184be2019-08-13 07:50:19 -06001654bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001655 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001656 bool skip = false;
1657
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001658 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1659
1660 return skip;
1661}
1662
1663bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1664 VkQueryPool queryPool, uint32_t query) const {
1665 bool skip = false;
1666
1667 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001668
1669 return skip;
1670}
1671
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001672bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage,
1673 VkQueryPool queryPool, uint32_t query) const {
1674 bool skip = false;
1675
1676 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage);
1677
1678 return skip;
1679}
1680
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03001681void BestPractices::PreCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1682 VkPipeline pipeline) {
1683 StateTracker::PreCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1684
1685 auto pipeline_info = Get<PIPELINE_STATE>(pipeline);
1686 auto cb = Get<bp_state::CommandBuffer>(commandBuffer);
1687
1688 assert(pipeline_info);
1689 assert(cb);
1690
1691 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS && VendorCheckEnabled(kBPVendorNVIDIA)) {
1692 using TessGeometryMeshState = bp_state::CommandBufferStateNV::TessGeometryMesh::State;
1693 auto& tgm = cb->nv.tess_geometry_mesh;
1694
1695 // Make sure the message is only signaled once per command buffer
1696 tgm.threshold_signaled = tgm.num_switches >= kNumBindPipelineTessGeometryMeshSwitchesThresholdNVIDIA;
1697
1698 // Track pipeline switches with tessellation, geometry, and/or mesh shaders enabled, and disabled
1699 auto tgm_stages = VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT | VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT |
1700 VK_SHADER_STAGE_GEOMETRY_BIT | VK_SHADER_STAGE_TASK_BIT_NV | VK_SHADER_STAGE_MESH_BIT_NV;
1701 auto new_tgm_state = (pipeline_info->active_shaders & tgm_stages) != 0
1702 ? TessGeometryMeshState::Enabled
1703 : TessGeometryMeshState::Disabled;
1704 if (tgm.state != new_tgm_state && tgm.state != TessGeometryMeshState::Unknown) {
1705 tgm.num_switches++;
1706 }
1707 tgm.state = new_tgm_state;
1708 }
1709}
1710
Sam Walls0961ec02020-03-31 16:39:15 +01001711void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1712 VkPipeline pipeline) {
1713 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1714
Nadav Gevaf0808442021-05-21 13:51:25 -04001715 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001716 PipelineUsedInFrame(pipeline);
Nadav Gevaf0808442021-05-21 13:51:25 -04001717
Sam Walls0961ec02020-03-31 16:39:15 +01001718 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001719 auto pipeline_state = Get<bp_state::Pipeline>(pipeline);
Sam Walls0961ec02020-03-31 16:39:15 +01001720 // check for depth/blend state tracking
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001721 if (pipeline_state) {
1722 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001723 assert(cb_node);
1724 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001725
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001726 render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments;
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001727 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001728
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07001729 const auto* blend_state = pipeline_state->ColorBlendState();
1730 const auto* stencil_state = pipeline_state->DepthStencilState();
Sam Walls0961ec02020-03-31 16:39:15 +01001731
1732 if (blend_state) {
1733 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001734 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001735 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1736 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001737 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001738 }
1739 }
1740 }
1741
1742 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001743 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001744
1745 if (stencil_state && stencil_state->depthTestEnable) {
1746 switch (stencil_state->depthCompareOp) {
1747 case VK_COMPARE_OP_EQUAL:
1748 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1749 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001750 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001751 break;
1752 default:
1753 break;
1754 }
1755 }
Sam Walls0961ec02020-03-31 16:39:15 +01001756 }
1757 }
1758}
1759
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02001760static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1761 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
1762 const auto& subpass_info = createInfo.pSubpasses[subpass];
1763 if (subpass_info.pResolveAttachments) {
1764 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1765 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1766 }
1767 }
1768 }
1769
1770 return false;
1771}
1772
Attilio Provenzano02859b22020-02-27 14:17:28 +00001773static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1774 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001775 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001776
1777 // If an attachment is ever used as a color attachment,
1778 // resolve attachment or depth stencil attachment,
1779 // it needs to exist on tile at some point.
1780
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001781 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1782 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001783 }
1784
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001785 if (subpass_info.pResolveAttachments) {
1786 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1787 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1788 }
1789 }
1790
1791 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001792 }
1793
1794 return false;
1795}
1796
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001797static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1798 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1799 return false;
1800 }
1801
1802 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001803 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001804
1805 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1806 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1807 return true;
1808 }
1809 }
1810 }
1811
1812 return false;
1813}
1814
Attilio Provenzano02859b22020-02-27 14:17:28 +00001815bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1816 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1817 bool skip = false;
1818
1819 if (!pRenderPassBegin) {
1820 return skip;
1821 }
1822
Gareth Webbdc6549a2021-06-16 03:52:24 +01001823 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
1824 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
1825 "This render pass has a zero-size render area. It cannot write to any attachments, "
1826 "and can only be used for side effects such as layout transitions.");
1827 }
1828
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001829 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001830 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001831 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001832 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001833 if (rpabi) {
1834 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1835 }
1836 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001837 // Check if any attachments have LOAD operation on them
1838 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001839 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001840
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001841 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02001842 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001843 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001844 }
1845
1846 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001847 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001848 }
1849
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001850 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001851
1852 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001853 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1854 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001855 }
1856
1857 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
LawG47747b322022-02-23 16:12:10 +00001858 if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
1859 skip |=
1860 LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
LawG4015be1c2022-03-01 10:37:52 +00001861 "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
LawG47747b322022-02-23 16:12:10 +00001862 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04001863 "which will copy in total %u pixels (renderArea = "
LawG47747b322022-02-23 16:12:10 +00001864 "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.",
1865 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att,
1866 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1867 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1868 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001869 }
1870 }
paul-lunarg7089e272022-06-20 22:19:37 +02001871
1872 // Check if renderpass has at least one VK_ATTACHMENT_LOAD_OP_CLEAR
1873
1874 bool clearing = false;
1875
1876 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
1877 const auto& attachment = rp_state->createInfo.pAttachments[att];
1878
1879 if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1880 clearing = true;
1881 break;
1882 }
1883 }
1884
1885 // Check if there are ClearValues passed to BeginRenderPass even though no attachments will be cleared
1886 if (!clearing && pRenderPassBegin->clearValueCount > 0) {
1887 // Flag as warning because nothing will happen per spec, and pClearValues will be ignored
1888 skip |= LogWarning(
1889 device, kVUID_BestPractices_ClearValueWithoutLoadOpClear,
1890 "This render pass does not have VkRenderPassCreateInfo.pAttachments->loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR "
1891 "but VkRenderPassBeginInfo.clearValueCount > 0. VkRenderPassBeginInfo.pClearValues will be ignored and no "
paul-lunarga0a149c2022-06-23 16:18:51 +02001892 "attachments will be cleared.");
paul-lunarg7089e272022-06-20 22:19:37 +02001893 }
paul-lunarga0a149c2022-06-23 16:18:51 +02001894
1895 // Check if there are more clearValues than attachments
1896 if(pRenderPassBegin->clearValueCount > rp_state->createInfo.attachmentCount) {
1897 // Flag as warning because the overflowing clearValues will be ignored and could even be undefined on certain platforms.
1898 // This could signal a bug and there seems to be no reason for this to happen on purpose.
1899 skip |= LogWarning(
1900 device, kVUID_BestPractices_ClearValueCountHigherThanAttachmentCount,
1901 "This render pass has VkRenderPassBeginInfo.clearValueCount > VkRenderPassCreateInfo.attachmentCount "
1902 "(%" PRIu32 " > %" PRIu32 ") and as such the clearValues that do not have a corresponding attachment will be ignored.",
1903 pRenderPassBegin->clearValueCount, rp_state->createInfo.attachmentCount);
1904 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001905 }
1906
1907 return skip;
1908}
1909
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001910void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
1911 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001912 if (view) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001913 auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state);
1914 QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001915 }
1916}
1917
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001918void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1919 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001920 // If we're viewing a 3D slice, ignore base array layer.
1921 // The entire 3D subresource is accessed as one atomic unit.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001922 const uint32_t base_array_layer = state->createInfo.imageType == VK_IMAGE_TYPE_3D ? 0 : subresource_range.baseArrayLayer;
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001923
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001924 const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001925 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001926 const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel;
1927 const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001928
1929 for (uint32_t layer = 0; layer < array_layers; layer++) {
1930 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001931 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
1932 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001933 }
1934 }
1935}
1936
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001937void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1938 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) {
1939 const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001940 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001941
1942 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001943 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001944 }
1945}
1946
paul-lunarg5eb52062022-06-27 18:57:15 +02001947void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1948 IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer, uint32_t mip_level) {
1949 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](const ValidationStateTracker&, const QUEUE_STATE&,
1950 const CMD_BUFFER_STATE&) -> bool {
1951 ValidateImageInQueue(function_name, *state, usage, array_layer, mip_level);
1952 return false;
1953 });
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001954}
1955
LawG44d414ba2022-02-23 15:35:41 +00001956void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001957 IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001958 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001959 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001960 if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED && last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001961 !image.IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001962 LogPerformanceWarning(
1963 device, kVUID_BestPractices_RenderPass_RedundantStore,
LawG4015be1c2022-03-01 10:37:52 +00001964 "%s %s: %s Subresource (arrayLayer: %u, mipLevel: %u) of image was cleared as part of LOAD_OP_CLEAR, but last time "
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001965 "image was used, it was written to with STORE_OP_STORE. "
1966 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1967 "architectures.",
LawG44d414ba2022-02-23 15:35:41 +00001968 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001969 } 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 +02001970 LogPerformanceWarning(
1971 device, kVUID_BestPractices_RenderPass_RedundantClear,
LawG4015be1c2022-03-01 10:37:52 +00001972 "%s %s: %s Subresource (arrayLayer: %u, mipLevel: %u) of image was cleared as part of LOAD_OP_CLEAR, but last time "
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001973 "image was used, it was written to with vkCmdClear*Image(). "
1974 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
LawG44d414ba2022-02-23 15:35:41 +00001975 "tile-based architectures.",
1976 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001977 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001978 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1979 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001980 const char *last_cmd = nullptr;
1981 const char *vuid = nullptr;
1982 const char *suggestion = nullptr;
1983
1984 switch (last_usage) {
1985 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1986 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1987 last_cmd = "vkCmdBlitImage";
1988 suggestion =
1989 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1990 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1991 "which avoids the memory roundtrip.";
1992 break;
1993 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1994 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1995 last_cmd = "vkCmdClear*Image";
1996 suggestion =
1997 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1998 "tile-based architectures. "
1999 "Use LOAD_OP_CLEAR instead to clear the image for free.";
2000 break;
2001 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
2002 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
2003 last_cmd = "vkCmdCopy*Image";
2004 suggestion =
2005 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
2006 "Rather than copying, just render the source image in a fragment shader in this render pass, "
2007 "which avoids the memory roundtrip.";
2008 break;
2009 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
2010 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
2011 last_cmd = "vkCmdResolveImage";
2012 suggestion =
2013 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
2014 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
2015 "which avoids the memory roundtrip.";
2016 break;
2017 default:
2018 break;
2019 }
2020
2021 LogPerformanceWarning(
2022 device, vuid,
LawG4015be1c2022-03-01 10:37:52 +00002023 "%s %s: %s Subresource (arrayLayer: %u, mipLevel: %u) of image was loaded to tile as part of LOAD_OP_LOAD, but last "
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01002024 "time image was used, it was written to with %s. %s",
LawG44d414ba2022-02-23 15:35:41 +00002025 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd,
2026 suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002027 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002028}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002029
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002030void BestPractices::ValidateImageInQueue(const char* function_name, bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage,
2031 uint32_t array_layer, uint32_t mip_level) {
2032 auto last_usage = state.UpdateUsage(array_layer, mip_level, usage);
paul-lunarg5eb52062022-06-27 18:57:15 +02002033
2034 // When image was discarded with StoreOpDontCare but is now being read with LoadOpLoad
2035 if (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED &&
2036 usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE) {
2037 LogWarning(device, kVUID_BestPractices_StoreOpDontCareThenLoadOpLoad,
2038 "Trying to load an attachment with LOAD_OP_LOAD that was previously stored with STORE_OP_DONT_CARE. This may "
2039 "result in undefined behaviour.");
2040 }
2041
LawG44d414ba2022-02-23 15:35:41 +00002042 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
2043 ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002044 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002045}
2046
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002047void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) {
2048 cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(),
2049 cb.queue_submit_functions_after_render_pass.end());
2050 cb.queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002051}
2052
2053void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
2054 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002055 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2056 if (cb_node) {
2057 AddDeferredQueueOperations(*cb_node);
2058 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002059}
2060
2061void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
2062 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002063 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2064 if (cb_node) {
2065 AddDeferredQueueOperations(*cb_node);
2066 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002067}
2068
2069void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
2070 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002071 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2072 if (cb_node) {
2073 AddDeferredQueueOperations(*cb_node);
2074 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002075}
2076
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002077void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
2078 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002079 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002080 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002081 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
2082}
2083
2084void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
2085 const VkRenderPassBeginInfo* pRenderPassBegin,
2086 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2087 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2088 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
2089}
2090
2091void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2092 const VkRenderPassBeginInfo* pRenderPassBegin,
2093 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2094 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2095 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
2096}
2097
2098void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002099
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002100 if (!pRenderPassBegin) {
2101 return;
2102 }
2103
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002104 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002105
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002106 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002107 if (rp_state) {
2108 // Check load ops
2109 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002110 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002111
2112 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
2113 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2114 continue;
2115 }
2116
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002117 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002118
2119 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
2120 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002121 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02002122 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
2123 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002124 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02002125 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002126 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002127 }
2128
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002129 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Jeremy Gebben9f537102021-10-05 16:37:12 -06002130 std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr;
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002131
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002132 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002133 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2134 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002135 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002136 }
2137 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002138 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002139 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002140
Jeremy Gebben9f537102021-10-05 16:37:12 -06002141 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002142 }
2143
2144 // Check store ops
2145 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002146 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002147
2148 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2149 continue;
2150 }
2151
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002152 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002153
2154 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
2155 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002156 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002157 }
2158
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002159 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002160
Jeremy Gebben9f537102021-10-05 16:37:12 -06002161 std::shared_ptr<IMAGE_VIEW_STATE> image_view;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002162 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002163 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2164 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002165 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002166 }
2167 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002168 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002169 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002170
Jeremy Gebben9f537102021-10-05 16:37:12 -06002171 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002172 }
2173 }
2174}
2175
Attilio Provenzano02859b22020-02-27 14:17:28 +00002176bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2177 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002178 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2179 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002180 return skip;
2181}
2182
2183bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2184 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002185 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002186 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2187 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002188 return skip;
2189}
2190
2191bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002192 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002193 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2194 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002195 return skip;
2196}
2197
Sam Walls0961ec02020-03-31 16:39:15 +01002198void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
2199 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002200 // Reset the renderpass state
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002201 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
sjfricke52defd42022-08-08 16:37:46 +09002202 // TODO - move this logic to the Render Pass state as cb->has_draw_cmd should stay true for lifetime of command buffer
2203 cb->has_draw_cmd = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002204 assert(cb);
2205 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002206 render_pass_state.touchesAttachments.clear();
2207 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002208 render_pass_state.numDrawCallsDepthOnly = 0;
2209 render_pass_state.numDrawCallsDepthEqualCompare = 0;
2210 render_pass_state.colorAttachment = false;
2211 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002212 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002213 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01002214
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03002215 // Reset NV state
2216 cb->nv = {};
2217
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002218 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01002219
2220 // track depth / color attachment usage within the renderpass
2221 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
2222 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002223 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002224
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002225 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002226 }
2227}
2228
2229void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2230 VkSubpassContents contents) {
2231 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2232 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
2233}
2234
2235void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2236 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2237 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2238 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2239}
2240
2241void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2242 const VkRenderPassBeginInfo* pRenderPassBegin,
2243 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2244 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2245 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2246}
2247
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002248// Generic function to handle validation for all CmdDraw* type functions
2249bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
2250 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002251 const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002252 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002253 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2254 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002255 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002256
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002257 // Verify vertex binding
Tony-LunarG2ffe1f52022-04-11 15:13:30 -06002258 if (pipeline_state && pipeline_state->vertex_input_state &&
2259 pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) {
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002260 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002261 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002262 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002263 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
2264 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002265 }
2266 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002267
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002268 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002269 if (pipe) {
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002270 const auto& rp_state = pipe->RenderPassState();
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002271 if (rp_state) {
2272 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
2273 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002274 const auto* ds_state = pipe->DepthStencilState();
Jeremy Gebben11af9792021-08-20 10:20:09 -06002275 const uint32_t depth_stencil_attachment =
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002276 GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment);
2277 const auto* raster_state = pipe->RasterizationState();
2278 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state &&
2279 raster_state->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002280 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
2281 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
2282 }
2283 }
2284 }
2285 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002286 }
2287 return skip;
2288}
2289
Sam Walls0961ec02020-03-31 16:39:15 +01002290void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002291 auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002292 assert(cb_node);
Sam Walls0961ec02020-03-31 16:39:15 +01002293 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002294 RecordCmdDrawTypeArm(*cb_node, draw_count, caller);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002295 }
2296
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002297 if (cb_node->render_pass_state.drawTouchAttachments) {
2298 for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) {
2299 RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002300 }
2301 // No need to touch the same attachments over and over.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002302 cb_node->render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002303 }
2304}
2305
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002306void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) {
2307 auto& render_pass_state = cb_node.render_pass_state;
LawG4b21485c2022-02-28 13:46:48 +00002308 // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards
2309 // depth prepass warnings First find the lowest enabled draw count
2310 uint32_t lowestEnabledMinDrawCount = 0;
2311 lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm;
2312 if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount)
2313 lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG;
2314
2315 if (draw_count >= lowestEnabledMinDrawCount) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002316 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
2317 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01002318 }
2319}
2320
Camden5b184be2019-08-13 07:50:19 -06002321bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002322 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002323 bool skip = false;
2324
2325 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002326 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2327 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002328 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002329 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06002330
2331 return skip;
2332}
2333
Sam Walls0961ec02020-03-31 16:39:15 +01002334void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2335 uint32_t firstVertex, uint32_t firstInstance) {
2336 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
2337 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
2338}
2339
Camden5b184be2019-08-13 07:50:19 -06002340bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002341 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002342 bool skip = false;
2343
2344 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002345 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2346 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002347 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002348 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
2349
Attilio Provenzano02859b22020-02-27 14:17:28 +00002350 // Check if we reached the limit for small indexed draw calls.
2351 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002352 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002353 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002354 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
LawG4ff42d722022-03-01 10:28:25 +00002355 (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002356 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
LawG4ff42d722022-03-01 10:28:25 +00002357 "%s %s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00002358 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
2359 "You can try batching drawcalls or instancing when applicable.",
LawG4ff42d722022-03-01 10:28:25 +00002360 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls,
2361 kSmallIndexedDrawcallIndices);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002362 }
2363
Sam Walls8e77e4f2020-03-16 20:47:40 +00002364 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002365 ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002366 }
2367
2368 return skip;
2369}
2370
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002371bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount,
Sam Walls8e77e4f2020-03-16 20:47:40 +00002372 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
2373 bool skip = false;
2374
2375 // check for sparse/underutilised index buffer, and post-transform cache thrashing
Sam Walls8e77e4f2020-03-16 20:47:40 +00002376
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002377 const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get();
2378 if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002379
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002380 const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002381 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00002382 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
2383 const void* ib_mem = ib_mem_state.p_driver_data;
2384 bool primitive_restart_enable = false;
2385
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002386 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002387 const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point];
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002388 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002389
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002390 const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr;
2391 if (ia_state) {
2392 primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002393 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00002394
2395 // 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 -06002396 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00002397 uint32_t scan_stride;
2398 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2399 scan_stride = sizeof(uint8_t);
2400 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2401 scan_stride = sizeof(uint16_t);
2402 } else {
2403 scan_stride = sizeof(uint32_t);
2404 }
2405
2406 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
2407 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
2408
2409 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
2410 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
2411 // irrespective of whether or not they're part of the draw call.
2412
2413 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
2414 uint32_t min_index = ~0u;
2415 // start with maximum as 0 and adjust to indices in the buffer
2416 uint32_t max_index = 0u;
2417
2418 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
2419 // for the given index buffer
2420 uint32_t vertex_shade_count = 0;
2421
2422 PostTransformLRUCacheModel post_transform_cache;
2423
2424 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
2425 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
2426 // target architecture.
2427 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
2428 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
2429 post_transform_cache.resize(32);
2430
2431 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2432 uint32_t scan_index;
2433 uint32_t primitive_restart_value;
2434 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2435 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2436 primitive_restart_value = 0xFF;
2437 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2438 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2439 primitive_restart_value = 0xFFFF;
2440 } else {
2441 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2442 primitive_restart_value = 0xFFFFFFFF;
2443 }
2444
2445 max_index = std::max(max_index, scan_index);
2446 min_index = std::min(min_index, scan_index);
2447
2448 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
2449 bool in_cache = post_transform_cache.query_cache(scan_index);
2450 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
2451 if (!in_cache) vertex_shade_count++;
2452 }
2453 }
2454
2455 // 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 +01002456 // 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
2457 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002458
2459 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07002460 skip |=
2461 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2462 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
2463 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
2464 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
2465 "maximum would be loaded, and possibly shaded, whether or not they are used.",
2466 VendorSpecificTag(kBPVendorArm),
2467 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002468 return skip;
2469 }
2470
2471 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
2472 // 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 +01002473 const size_t refs_per_bucket = 64;
2474 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
2475
2476 const uint32_t n_indices = max_index - min_index + 1;
2477 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
2478 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
2479
2480 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
2481 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00002482
2483 // To avoid using too much memory, we run over the indices again.
2484 // Knowing the size from the last scan allows us to record index usage with bitsets
2485 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2486 uint32_t scan_index;
2487 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2488 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2489 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2490 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2491 } else {
2492 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2493 }
2494 // keep track of the set of all indices used to reference vertices in the draw call
2495 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01002496 size_t bitset_bucket_index = index_offset / refs_per_bucket;
2497 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002498 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
2499 }
2500
2501 uint32_t vertex_reference_count = 0;
2502 for (const auto& bitset : vertex_reference_buckets) {
2503 vertex_reference_count += static_cast<uint32_t>(bitset.count());
2504 }
2505
2506 // 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 -07002507 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002508 // 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 -07002509 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002510
2511 if (utilization < 0.5f) {
2512 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2513 "%s The indices which were specified for the draw call only utilise approximately "
2514 "%.02f%% of the bound vertex buffer.",
2515 VendorSpecificTag(kBPVendorArm), utilization);
2516 }
2517
2518 if (cache_hit_rate <= 0.5f) {
2519 skip |=
2520 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
2521 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
2522 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
2523 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
2524 "recently shaded vertices.",
2525 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
2526 }
2527 }
2528
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002529 return skip;
2530}
2531
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002532bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2533 const VkCommandBuffer* pCommandBuffers) const {
2534 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002535 const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002536 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002537 const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002538 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002539 continue;
2540 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002541 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002542 for (auto& clear : secondary.earlyClearAttachments) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002543 if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) {
2544 skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002545 }
2546 }
2547 }
Nadav Gevaf0808442021-05-21 13:51:25 -04002548
2549 if (VendorCheckEnabled(kBPVendorAMD)) {
2550 if (commandBufferCount > 0) {
2551 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
2552 "%s Performance warning: Use of secondary command buffers is not recommended. ",
2553 VendorSpecificTag(kBPVendorAMD));
2554 }
2555 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002556 return skip;
2557}
2558
2559void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2560 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002561 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
2562
2563 auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2564 if (!primary) {
2565 return;
2566 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002567
2568 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002569 auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]);
2570 if (!secondary) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002571 continue;
2572 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002573
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002574 for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) {
2575 if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
2576 RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment,
2577 early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002578 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002579 RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002580 }
2581 }
2582
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002583 for (auto& touch : secondary->render_pass_state.touchesAttachments) {
2584 RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002585 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02002586
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002587 primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare;
2588 primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002589 }
2590
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002591}
2592
Rodrigo Locatti7d716e12022-03-09 19:15:17 -03002593bool BestPractices::PreCallValidateCmdBuildAccelerationStructureNV(VkCommandBuffer commandBuffer,
2594 const VkAccelerationStructureInfoNV* pInfo,
2595 VkBuffer instanceData, VkDeviceSize instanceOffset,
2596 VkBool32 update, VkAccelerationStructureNV dst,
2597 VkAccelerationStructureNV src, VkBuffer scratch,
2598 VkDeviceSize scratchOffset) const {
2599 return ValidateBuildAccelerationStructure(commandBuffer);
2600}
2601
2602bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresIndirectKHR(
2603 VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
2604 const VkDeviceAddress* pIndirectDeviceAddresses, const uint32_t* pIndirectStrides,
2605 const uint32_t* const* ppMaxPrimitiveCounts) const {
2606 return ValidateBuildAccelerationStructure(commandBuffer);
2607}
2608
2609bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresKHR(
2610 VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
2611 const VkAccelerationStructureBuildRangeInfoKHR* const* ppBuildRangeInfos) const {
2612 return ValidateBuildAccelerationStructure(commandBuffer);
2613}
2614
2615bool BestPractices::ValidateBuildAccelerationStructure(VkCommandBuffer commandBuffer) const {
2616 bool skip = false;
2617 auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
2618 assert(cb_node);
2619
2620 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
2621 if ((cb_node->GetQueueFlags() & VK_QUEUE_GRAPHICS_BIT) != 0) {
2622 skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_AccelerationStructure_NotAsync,
2623 "%s Performance warning: Prefer building acceleration structures on an asynchronous "
2624 "compute queue, instead of using the universal graphics queue.",
2625 VendorSpecificTag(kBPVendorNVIDIA));
2626 }
2627 }
2628
2629 return skip;
2630}
2631
Rodrigo Locatti66b23352022-03-15 17:28:32 -03002632bool BestPractices::ValidateBindMemory(VkDevice device, VkDeviceMemory memory) const {
2633 bool skip = false;
2634
2635 if (VendorCheckEnabled(kBPVendorNVIDIA) && device_extensions.vk_ext_pageable_device_local_memory) {
2636 auto mem_info = std::static_pointer_cast<const bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory));
2637 if (!mem_info->dynamic_priority) {
2638 skip |=
2639 LogPerformanceWarning(device, kVUID_BestPractices_BindMemory_NoPriority,
2640 "%s Use vkSetDeviceMemoryPriorityEXT to provide the OS with information on which allocations "
2641 "should stay in memory and which should be demoted first when video memory is limited. The "
2642 "highest priority should be given to GPU-written resources like color attachments, depth "
2643 "attachments, storage images, and buffers written from the GPU.",
2644 VendorSpecificTag(kBPVendorNVIDIA));
2645 }
2646 }
2647
2648 return skip;
2649}
2650
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002651void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
2652 auto& state = cb_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002653 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002654 auto itr =
2655 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2656 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002657
2658 if (itr != state.touchesAttachments.end()) {
2659 itr->aspects |= aspects;
2660 } else {
2661 state.touchesAttachments.push_back({ fb_attachment, aspects });
2662 }
2663}
2664
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002665void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002666 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
2667 const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002668 auto& state = cmd_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002669 // If we observe a full clear before any other access to a frame buffer attachment,
2670 // we have candidate for redundant clear attachments.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002671 auto itr =
2672 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2673 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002674
2675 uint32_t new_aspects = aspects;
2676 if (itr != state.touchesAttachments.end()) {
2677 new_aspects = aspects & ~itr->aspects;
2678 itr->aspects |= aspects;
2679 } else {
2680 state.touchesAttachments.push_back({ fb_attachment, aspects });
2681 }
2682
2683 if (new_aspects == 0) {
2684 return;
2685 }
2686
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002687 if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002688 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
2689 // CmdExecuteCommands.
2690 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
2691 std::vector<VkClearRect>{pRects, pRects + rectCount} });
2692 }
2693}
2694
2695void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
2696 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
2697 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002698 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects);
2699
2700 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2701 auto* rp_state = cmd_state->activeRenderPass.get();
2702 auto* fb_state = cmd_state->activeFramebuffer.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002703 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
2704
2705 if (rectCount == 0 || !rp_state) {
2706 return;
2707 }
2708
2709 if (!is_secondary && !fb_state) {
2710 return;
2711 }
2712
2713 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002714 bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002715
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06002716 if (!rp_state->UsesDynamicRendering()) {
ziga-lunarg885c6542022-03-07 01:08:25 +01002717 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
2718 for (uint32_t i = 0; i < attachmentCount; i++) {
2719 auto& attachment = pClearAttachments[i];
2720 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2721 VkImageAspectFlags aspects = attachment.aspectMask;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002722
ziga-lunarg885c6542022-03-07 01:08:25 +01002723 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
2724 if (subpass.pDepthStencilAttachment) {
2725 fb_attachment = subpass.pDepthStencilAttachment->attachment;
2726 }
2727 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
2728 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002729 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002730
ziga-lunarg885c6542022-03-07 01:08:25 +01002731 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2732 if (full_clear) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002733 RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment,
ziga-lunarg885c6542022-03-07 01:08:25 +01002734 aspects, rectCount, pRects);
2735 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002736 RecordAttachmentAccess(*cmd_state, fb_attachment, aspects);
ziga-lunarg885c6542022-03-07 01:08:25 +01002737 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002738 }
2739 }
2740 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002741}
2742
Attilio Provenzano02859b22020-02-27 14:17:28 +00002743void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2744 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2745 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
2746 firstInstance);
2747
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002748 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002749 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
2750 cmd_state->small_indexed_draw_call_count++;
2751 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002752
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002753 ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00002754}
2755
Sam Walls0961ec02020-03-31 16:39:15 +01002756void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2757 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2758 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2759 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
2760}
2761
sfricke-samsung681ab7b2020-10-29 01:53:35 -07002762bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2763 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
2764 uint32_t maxDrawCount, uint32_t stride) const {
2765 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
2766
2767 return skip;
2768}
2769
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002770bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
2771 VkDeviceSize offset, VkBuffer countBuffer,
2772 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
2773 uint32_t stride) const {
2774 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06002775
2776 return skip;
2777}
2778
2779bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002780 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002781 bool skip = false;
2782
2783 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002784 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2785 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002786 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002787 }
2788
2789 return skip;
2790}
2791
Sam Walls0961ec02020-03-31 16:39:15 +01002792void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2793 uint32_t count, uint32_t stride) {
2794 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2795 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2796}
2797
Camden5b184be2019-08-13 07:50:19 -06002798bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002799 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002800 bool skip = false;
2801
2802 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002803 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2804 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002805 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002806 }
2807
2808 return skip;
2809}
2810
Sam Walls0961ec02020-03-31 16:39:15 +01002811void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2812 uint32_t count, uint32_t stride) {
2813 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2814 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2815}
2816
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002817void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) {
2818 for (auto descriptor_set : cb_state.validated_descriptor_sets) {
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002819 for (const auto& binding : *descriptor_set) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002820 // For bindless scenarios, we should not attempt to track descriptor set state.
2821 // It is highly uncertain which resources are actually bound.
2822 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002823 if (binding->binding_flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2824 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002825 continue;
2826 }
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002827
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002828 for (uint32_t i = 0; i < binding->count; ++i) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002829 VkImageView image_view{VK_NULL_HANDLE};
2830
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002831 auto descriptor = binding->GetDescriptor(i);
ziga-lunarg33d806c2022-05-05 17:00:52 +02002832 if (!descriptor) {
2833 continue;
2834 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002835 switch (descriptor->GetClass()) {
2836 case cvdescriptorset::DescriptorClass::Image: {
2837 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2838 image_view = image_descriptor->GetImageView();
2839 }
2840 break;
2841 }
2842 case cvdescriptorset::DescriptorClass::ImageSampler: {
2843 if (const auto image_sampler_descriptor =
2844 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2845 image_view = image_sampler_descriptor->GetImageView();
2846 }
2847 break;
2848 }
2849 default:
2850 break;
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002851 }
2852
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002853 if (image_view) {
2854 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
2855 QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(),
2856 IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002857 }
2858 }
2859 }
2860 }
2861}
2862
2863void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2864 uint32_t firstVertex, uint32_t firstInstance) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002865 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2866 ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002867}
2868
2869void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2870 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002871 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2872 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002873}
2874
2875void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2876 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002877 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2878 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002879}
2880
Camden5b184be2019-08-13 07:50:19 -06002881bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002882 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002883 bool skip = false;
2884
2885 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002886 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2887 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2888 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2889 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002890 }
2891
2892 return skip;
2893}
Camden83a9c372019-08-14 11:41:38 -06002894
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002895bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2896 bool skip = false;
2897 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
2898 skip |= ValidateCmdEndRenderPass(commandBuffer);
2899 return skip;
2900}
2901
2902bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2903 bool skip = false;
2904 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
2905 skip |= ValidateCmdEndRenderPass(commandBuffer);
2906 return skip;
2907}
2908
Sam Walls0961ec02020-03-31 16:39:15 +01002909bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2910 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002911 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002912 skip |= ValidateCmdEndRenderPass(commandBuffer);
2913 return skip;
2914}
2915
2916bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2917 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002918 const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01002919
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002920 if (cmd == nullptr) return skip;
2921 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01002922
LawG4b21485c2022-02-28 13:46:48 +00002923 // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor
2924 bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2925 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
2926 bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG &&
2927 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG;
2928
2929 // Only send the warning when the vendor is enabled and a depth prepass is detected
LawG498ec4502022-04-05 09:08:25 +01002930 bool uses_depth =
2931 (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
LawG45507e142022-04-08 09:36:54 +01002932 ((depth_only_arm && VendorCheckEnabled(kBPVendorArm)) || (depth_only_img && VendorCheckEnabled(kBPVendorIMG)));
LawG4b21485c2022-02-28 13:46:48 +00002933
Sam Walls0961ec02020-03-31 16:39:15 +01002934 if (uses_depth) {
2935 skip |= LogPerformanceWarning(
2936 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
LawG4015be1c2022-03-01 10:37:52 +00002937 "%s %s: Depth pre-passes may be in use. In general, this is not recommended in tile-based deferred "
LawG4b21485c2022-02-28 13:46:48 +00002938 "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry "
2939 "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface "
2940 "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.",
2941 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Sam Walls0961ec02020-03-31 16:39:15 +01002942 }
2943
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002944 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2945
LawG40da9c3d2022-03-01 09:51:01 +00002946 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002947 // If we use an attachment on-tile, we should access it in some way. Otherwise,
2948 // it is redundant to have it be part of the render pass.
2949 // Only consider it redundant if it will actually consume bandwidth, i.e.
2950 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
2951 // as is using pure input attachments.
2952 // CLEAR -> STORE might be considered a "useful" thing to do, but
2953 // the optimal thing to do is to defer the clear until you're actually
2954 // going to render to the image.
2955
2956 uint32_t num_attachments = rp->createInfo.attachmentCount;
2957 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002958 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
2959 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002960 continue;
2961 }
2962
2963 auto& attachment = rp->createInfo.pAttachments[i];
2964
2965 VkImageAspectFlags bandwidth_aspects = 0;
2966
2967 if (!FormatIsStencilOnly(attachment.format) &&
2968 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2969 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2970 if (FormatHasDepth(attachment.format)) {
2971 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
2972 } else {
2973 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
2974 }
2975 }
2976
2977 if (FormatHasStencil(attachment.format) &&
2978 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2979 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2980 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
2981 }
2982
2983 if (!bandwidth_aspects) {
2984 continue;
2985 }
2986
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002987 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002988 [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002989 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002990 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002991 untouched_aspects &= ~itr->aspects;
2992 }
2993
2994 if (untouched_aspects) {
2995 skip |= LogPerformanceWarning(
2996 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
LawG4015be1c2022-03-01 10:37:52 +00002997 "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002998 "was never accessed by a pipeline or clear command. "
LawG40da9c3d2022-03-01 09:51:01 +00002999 "On tile-based architectures, LOAD_OP_LOAD and STORE_OP_STORE consume bandwidth and should not be part of the "
LawG4015be1c2022-03-01 10:37:52 +00003000 "render pass if the attachments are not intended to be accessed.",
LawG40da9c3d2022-03-01 09:51:01 +00003001 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects);
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003002 }
3003 }
3004 }
3005
Sam Walls0961ec02020-03-31 16:39:15 +01003006 return skip;
3007}
3008
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003009void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003010 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3011 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003012}
3013
3014void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003015 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3016 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003017}
3018
Camden Stocker9c051442019-11-06 14:28:43 -08003019bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
3020 const char* api_name) const {
3021 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003022 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08003023
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003024 if (bp_pd_state) {
3025 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
3026 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
3027 "Potential problem with calling %s() without first retrieving properties from "
3028 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
3029 api_name);
3030 }
Camden Stocker9c051442019-11-06 14:28:43 -08003031 }
3032
3033 return skip;
3034}
3035
Camden83a9c372019-08-14 11:41:38 -06003036bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003037 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06003038 bool skip = false;
3039
Camden Stocker9c051442019-11-06 14:28:43 -08003040 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06003041
Camden Stocker9c051442019-11-06 14:28:43 -08003042 return skip;
3043}
3044
3045bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
3046 uint32_t planeIndex,
3047 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
3048 bool skip = false;
3049
3050 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
3051
3052 return skip;
3053}
3054
3055bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
3056 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
3057 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
3058 bool skip = false;
3059
3060 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06003061
3062 return skip;
3063}
Camden05de2d42019-08-19 10:23:56 -06003064
3065bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003066 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06003067 bool skip = false;
3068
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003069 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Camden05de2d42019-08-19 10:23:56 -06003070
Nathaniel Cesario39152e62021-07-02 13:04:16 -06003071 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06003072 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06003073 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003074 skip |=
3075 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
3076 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
3077 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06003078 }
Camden05de2d42019-08-19 10:23:56 -06003079
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06003080 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
3081 skip |= LogWarning(
3082 device, kVUID_BestPractices_Swapchain_InvalidCount,
3083 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04003084 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06003085 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
3086 }
3087 }
3088
Camden05de2d42019-08-19 10:23:56 -06003089 return skip;
3090}
3091
3092// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003093bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003094 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003095 const CALL_STATE call_state,
3096 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06003097 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003098 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
3099 if (UNCALLED == call_state) {
3100 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003101 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003102 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
3103 "recommended "
3104 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
3105 caller_name, caller_name);
3106 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003107 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
3108 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003109 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
3110 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
3111 ". It is recommended to instead receive all the properties by calling %s with "
3112 "pQueueFamilyPropertyCount that was "
3113 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003114 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003115 caller_name);
Camden05de2d42019-08-19 10:23:56 -06003116 }
3117
3118 return skip;
3119}
3120
Jeff Bolz5c801d12019-10-09 10:38:45 -05003121bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
3122 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06003123 bool skip = false;
3124
3125 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003126 auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06003127 if (!as_state->memory_requirements_checked) {
3128 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
3129 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
3130 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003131 skip |= LogWarning(
3132 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06003133 "vkBindAccelerationStructureMemoryNV(): "
3134 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
3135 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
3136 }
3137 }
3138
3139 return skip;
3140}
3141
Camden05de2d42019-08-19 10:23:56 -06003142bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3143 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003144 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003145 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003146 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003147 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003148 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3149 "vkGetPhysicalDeviceQueueFamilyProperties()");
3150 }
3151 return false;
Camden05de2d42019-08-19 10:23:56 -06003152}
3153
Mike Schuchardt2df08912020-12-15 16:28:09 -08003154bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3155 uint32_t* pQueueFamilyPropertyCount,
3156 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003157 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003158 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003159 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003160 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3161 "vkGetPhysicalDeviceQueueFamilyProperties2()");
3162 }
3163 return false;
Camden05de2d42019-08-19 10:23:56 -06003164}
3165
Jeff Bolz5c801d12019-10-09 10:38:45 -05003166bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08003167 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003168 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003169 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003170 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003171 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3172 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
3173 }
3174 return false;
Camden05de2d42019-08-19 10:23:56 -06003175}
3176
3177bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
3178 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003179 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06003180 if (!pSurfaceFormats) return false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003181 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003182 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06003183 bool skip = false;
3184 if (call_state == UNCALLED) {
3185 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
3186 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003187 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
3188 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
3189 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06003190 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003191 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003192 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
3193 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
3194 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
3195 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003196 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06003197 }
3198 }
3199 return skip;
3200}
Camden Stocker23cc47d2019-09-03 14:53:57 -06003201
3202bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003203 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003204 bool skip = false;
3205
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003206 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3207 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06003208 // 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 -07003209 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003210 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
3211 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07003212 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06003213 // 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 -07003214 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
3215 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003216 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003217 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003218 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003219 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003220 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003221 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
3222 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
3223 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003224 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003225 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
3226 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003227 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003228 }
3229 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003230 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003231 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003232 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003233 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
3234 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003235 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003236 }
3237 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003238 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3239 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003240 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003241 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003242 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003243 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003244 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003245 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
3246 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
3247 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003248 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003249 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
3250 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003251 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003252 }
3253 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003254 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003255 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003256 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003257 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
3258 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003259 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003260 }
3261 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3262 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003263 sparse_images_with_metadata.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003264 }
3265 }
3266 }
3267 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003268 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
3269 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003270 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003271 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003272 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
3273 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003274 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003275 }
3276 }
3277 }
3278
Rodrigo Locatti7ab778d2022-03-09 18:57:15 -03003279 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3280 auto queue_state = Get<QUEUE_STATE>(queue);
3281 if (queue_state && queue_state->queueFamilyProperties.queueFlags != (VK_QUEUE_TRANSFER_BIT | VK_QUEUE_SPARSE_BINDING_BIT)) {
3282 skip |= LogPerformanceWarning(queue, kVUID_BestPractices_QueueBindSparse_NotAsync,
3283 "vkQueueBindSparse() issued on queue %s. All binds should happen on an asynchronous copy "
3284 "queue to hide the OS scheduling and submit costs.",
3285 report_data->FormatHandle(queue).c_str());
3286 }
3287 }
3288
Camden Stocker23cc47d2019-09-03 14:53:57 -06003289 return skip;
3290}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003291
Mark Lobodzinski84101d72020-04-24 09:43:48 -06003292void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
3293 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003294 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003295 return;
3296 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003297
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003298 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3299 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
3300 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3301 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003302 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003303 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003304 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003305 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003306 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3307 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
3308 image_state->sparse_metadata_bound = true;
3309 }
3310 }
3311 }
3312 }
3313}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003314
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003315bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003316 const VkClearRect* pRects) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003317 if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003318 // We don't know the accurate render area in a secondary,
3319 // so assume we clear the entire frame buffer.
3320 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
3321 return true;
3322 }
3323
3324 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
3325 for (uint32_t i = 0; i < rectCount; i++) {
3326 auto& rect = pRects[i];
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003327 auto& render_area = cmd.activeRenderPassBeginInfo.renderArea;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003328 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
3329 return true;
3330 }
3331 }
3332
3333 return false;
3334}
3335
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003336bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment,
3337 VkImageAspectFlags aspects, bool secondary) const {
3338 const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003339 bool skip = false;
3340
3341 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
3342 return skip;
3343 }
3344
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003345 const auto& rp_state = cmd.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003346
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003347 auto attachment_itr =
3348 std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
3349 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003350
3351 // Only report aspects which haven't been touched yet.
3352 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003353 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003354 new_aspects &= ~attachment_itr->aspects;
3355 }
3356
3357 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
sjfricke52defd42022-08-08 16:37:46 +09003358 if (!cmd.has_draw_cmd) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003359 skip |= LogPerformanceWarning(
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003360 cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02003361 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
3362 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003363 report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003364 }
3365
3366 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
3367 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3368 skip |= LogPerformanceWarning(
3369 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3370 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
3371 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3372 "it is more efficient.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003373 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003374 }
3375
3376 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
3377 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003378 skip |=
3379 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3380 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
3381 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3382 "it is more efficient.",
3383 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003384 }
3385
3386 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
3387 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003388 skip |=
3389 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3390 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
3391 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3392 "it is more efficient.",
3393 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003394 }
3395
3396 return skip;
3397}
3398
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003399bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06003400 const VkClearAttachment* pAttachments, uint32_t rectCount,
3401 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003402 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003403 const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003404 if (!cb_node) return skip;
3405
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003406 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
3407 // Defer checks to ExecuteCommands.
3408 return skip;
3409 }
3410
3411 // Only care about full clears, partial clears might have legitimate uses.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003412 if (!ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects)) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003413 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003414 }
3415
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003416 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
3417 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06003418 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003419 if (rp) {
3420 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
3421
3422 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003423 const auto& attachment = pAttachments[i];
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003424
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003425 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3426 uint32_t color_attachment = attachment.colorAttachment;
3427 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003428 skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003429 }
3430
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003431 if (subpass.pDepthStencilAttachment &&
3432 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003433 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003434 skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003435 }
3436 }
3437 }
3438
Nadav Gevaf0808442021-05-21 13:51:25 -04003439 if (VendorCheckEnabled(kBPVendorAMD)) {
3440 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
3441 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
3442 bool black_check = false;
3443 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
3444 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
3445 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
3446 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3447 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3448
3449 bool white_check = false;
3450 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
3451 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
3452 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
3453 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3454 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3455
3456 if (black_check && white_check) {
3457 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3458 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
3459 "Consider changing to one of the following:"
3460 "RGBA(0, 0, 0, 0) "
3461 "RGBA(0, 0, 0, 1) "
3462 "RGBA(1, 1, 1, 0) "
3463 "RGBA(1, 1, 1, 1)",
3464 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3465 }
3466 } else {
3467 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
3468 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
3469 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
3470 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3471 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
3472 "attachment %" PRId32 " is not a fast clear value."
3473 "Consider changing to one of the following:"
3474 "D=0.0f, S=0"
3475 "D=1.0f, S=0",
3476 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3477 }
3478 }
3479 }
3480 }
3481
Camden Stockerf55721f2019-09-09 11:04:49 -06003482 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003483}
Attilio Provenzano02859b22020-02-27 14:17:28 +00003484
3485bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3486 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3487 const VkImageResolve* pRegions) const {
3488 bool skip = false;
3489
3490 skip |= VendorCheckEnabled(kBPVendorArm) &&
3491 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
3492 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
3493 "This is a very slow and extremely bandwidth intensive path. "
3494 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3495 VendorSpecificTag(kBPVendorArm));
3496
3497 return skip;
3498}
3499
Jeff Leger178b1e52020-10-05 12:22:23 -04003500bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3501 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
3502 bool skip = false;
3503
3504 skip |= VendorCheckEnabled(kBPVendorArm) &&
3505 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
3506 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
3507 "This is a very slow and extremely bandwidth intensive path. "
3508 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3509 VendorSpecificTag(kBPVendorArm));
3510
3511 return skip;
3512}
3513
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003514bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3515 const VkResolveImageInfo2* pResolveImageInfo) const {
3516 bool skip = false;
3517
3518 skip |= VendorCheckEnabled(kBPVendorArm) &&
3519 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage,
3520 "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. "
3521 "This is a very slow and extremely bandwidth intensive path. "
3522 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3523 VendorSpecificTag(kBPVendorArm));
3524
3525 return skip;
3526}
3527
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003528void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3529 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3530 const VkImageResolve* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003531 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003532 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003533 auto src = Get<bp_state::Image>(srcImage);
3534 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003535
3536 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003537 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
3538 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003539 }
3540}
3541
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003542void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3543 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003544 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003545 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003546 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3547 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003548 uint32_t regionCount = pResolveImageInfo->regionCount;
3549
3550 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003551 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
3552 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003553 }
3554}
3555
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003556void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer,
3557 const VkResolveImageInfo2* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003558 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003559 auto& funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003560 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3561 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003562 uint32_t regionCount = pResolveImageInfo->regionCount;
3563
3564 for (uint32_t i = 0; i < regionCount; i++) {
3565 QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ,
3566 pResolveImageInfo->pRegions[i].srcSubresource);
3567 QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE,
3568 pResolveImageInfo->pRegions[i].dstSubresource);
3569 }
3570}
3571
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003572void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3573 const VkClearColorValue* pColor, uint32_t rangeCount,
3574 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003575 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003576 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003577 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003578
3579 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003580 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003581 }
3582}
3583
3584void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3585 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3586 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003587 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003588 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003589 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003590
3591 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003592 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003593 }
3594}
3595
3596void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3597 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3598 const VkImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003599 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003600 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003601 auto src = Get<bp_state::Image>(srcImage);
3602 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003603
3604 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003605 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
3606 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003607 }
3608}
3609
3610void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
3611 VkImageLayout dstImageLayout, uint32_t regionCount,
3612 const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003613 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003614 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003615 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003616
3617 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003618 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003619 }
3620}
3621
3622void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3623 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003624 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003625 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003626 auto src = Get<bp_state::Image>(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003627
3628 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003629 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003630 }
3631}
3632
3633void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3634 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3635 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003636 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003637 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003638 auto src = Get<bp_state::Image>(srcImage);
3639 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003640
3641 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003642 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
3643 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003644 }
3645}
3646
Attilio Provenzano02859b22020-02-27 14:17:28 +00003647bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
3648 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
3649 bool skip = false;
3650
3651 if (VendorCheckEnabled(kBPVendorArm)) {
3652 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
3653 skip |= LogPerformanceWarning(
3654 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
3655 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
3656 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
3657 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003658 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003659 }
3660
3661 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
3662 skip |= LogPerformanceWarning(
3663 device, kVUID_BestPractices_CreateSampler_LodClamping,
3664 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
3665 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
3666 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
3667 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
3668 }
3669
3670 if (pCreateInfo->mipLodBias != 0.0f) {
3671 skip |=
3672 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
3673 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
3674 "descriptors being created and may cause reduced performance.",
3675 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
3676 }
3677
3678 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3679 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3680 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
3681 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
3682 skip |= LogPerformanceWarning(
3683 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
3684 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
3685 "This will lead to less efficient descriptors being created and may cause reduced performance. "
3686 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
3687 VendorSpecificTag(kBPVendorArm));
3688 }
3689
3690 if (pCreateInfo->unnormalizedCoordinates) {
3691 skip |= LogPerformanceWarning(
3692 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
3693 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
3694 "descriptors being created and may cause reduced performance.",
3695 VendorSpecificTag(kBPVendorArm));
3696 }
3697
3698 if (pCreateInfo->anisotropyEnable) {
3699 skip |= LogPerformanceWarning(
3700 device, kVUID_BestPractices_CreateSampler_Anisotropy,
3701 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
3702 "and may cause reduced performance.",
3703 VendorSpecificTag(kBPVendorArm));
3704 }
3705 }
3706
3707 return skip;
3708}
Sam Walls8e77e4f2020-03-16 20:47:40 +00003709
Nadav Gevaf0808442021-05-21 13:51:25 -04003710void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
3711 const VkGraphicsPipelineCreateInfo* pCreateInfos,
3712 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
3713 void* cgpl_state) {
3714 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
3715 pPipelines);
3716 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003717 num_pso_ += createInfoCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003718}
3719
3720bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
3721 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
3722 const VkCopyDescriptorSet* pDescriptorCopies) const {
3723 bool skip = false;
3724 if (VendorCheckEnabled(kBPVendorAMD)) {
3725 if (descriptorCopyCount > 0) {
3726 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
3727 "%s Performance warning: copying descriptor sets is not recommended",
3728 VendorSpecificTag(kBPVendorAMD));
3729 }
3730 }
3731
3732 return skip;
3733}
3734
3735bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
3736 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
3737 const VkAllocationCallbacks* pAllocator,
3738 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
3739 bool skip = false;
3740 if (VendorCheckEnabled(kBPVendorAMD)) {
3741 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
3742 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
3743 "vkUpdateDescriptorSet instead",
3744 VendorSpecificTag(kBPVendorAMD));
3745 }
3746
3747 return skip;
3748}
3749
3750bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3751 const VkClearColorValue* pColor, uint32_t rangeCount,
3752 const VkImageSubresourceRange* pRanges) const {
3753 bool skip = false;
3754 if (VendorCheckEnabled(kBPVendorAMD)) {
sfricke-samsungef15e482022-01-26 11:32:49 -08003755 skip |= LogPerformanceWarning(
3756 device, kVUID_BestPractices_ClearAttachment_ClearImage,
Nadav Gevaf0808442021-05-21 13:51:25 -04003757 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3758 "vkCmdClearAttachments instead",
3759 VendorSpecificTag(kBPVendorAMD));
3760 }
3761
3762 return skip;
3763}
3764
3765bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
3766 VkImageLayout imageLayout,
3767 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3768 const VkImageSubresourceRange* pRanges) const {
3769 bool skip = false;
3770 if (VendorCheckEnabled(kBPVendorAMD)) {
3771 skip |= LogPerformanceWarning(
3772 device, kVUID_BestPractices_ClearAttachment_ClearImage,
3773 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3774 "vkCmdClearAttachments instead",
3775 VendorSpecificTag(kBPVendorAMD));
3776 }
3777
3778 return skip;
3779}
3780
3781bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
3782 const VkAllocationCallbacks* pAllocator,
3783 VkPipelineLayout* pPipelineLayout) const {
3784 bool skip = false;
3785 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003786 uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2;
Nadav Gevaf0808442021-05-21 13:51:25 -04003787 // Descriptor sets cost 1 DWORD each.
3788 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
3789 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
3790 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
3791 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
3792 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003793 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003794 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size;
Nadav Gevaf0808442021-05-21 13:51:25 -04003795 }
3796
3797 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
3798 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
3799 }
3800
3801 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
3802 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
3803 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
3804 "Descriptor sets cost 1 DWORD each. "
3805 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
3806 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
3807 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
3808 VendorSpecificTag(kBPVendorAMD));
3809 }
3810 }
3811
Rodrigo Locatti65b33832022-03-15 17:57:30 -03003812 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3813 bool has_separate_sampler = false;
Rodrigo Locatti12f6ffc2022-03-15 18:29:11 -03003814 size_t fast_space_usage = 0;
Rodrigo Locatti65b33832022-03-15 17:57:30 -03003815
3816 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; ++i) {
3817 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
3818 for (const auto& binding : descriptor_set_layout_state->GetBindings()) {
3819 if (binding.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) {
3820 has_separate_sampler = true;
3821 }
Rodrigo Locatti12f6ffc2022-03-15 18:29:11 -03003822
3823 if ((descriptor_set_layout_state->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT) == 0U) {
3824 size_t descriptor_type_size = 0;
3825
3826 switch (binding.descriptorType) {
3827 case VK_DESCRIPTOR_TYPE_SAMPLER:
3828 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
3829 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
3830 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
3831 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
3832 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
3833 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
3834 descriptor_type_size = 4;
3835 break;
3836 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
3837 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
3838 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
3839 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
3840 descriptor_type_size = 8;
3841 break;
3842 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
3843 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
3844 case VK_DESCRIPTOR_TYPE_MUTABLE_VALVE:
3845 descriptor_type_size = 16;
3846 break;
3847 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK:
3848 descriptor_type_size = 1;
3849 default:
3850 // Unknown type.
3851 break;
3852 }
3853
3854 size_t descriptor_size = descriptor_type_size * binding.descriptorCount;
3855 fast_space_usage += descriptor_size;
3856 }
Rodrigo Locatti65b33832022-03-15 17:57:30 -03003857 }
3858 }
3859
3860 if (has_separate_sampler) {
3861 skip |= LogPerformanceWarning(
3862 device, kVUID_BestPractices_CreatePipelineLayout_SeparateSampler,
3863 "%s Consider using combined image samplers instead of separate samplers for marginally better performance.",
3864 VendorSpecificTag(kBPVendorNVIDIA));
3865 }
Rodrigo Locatti12f6ffc2022-03-15 18:29:11 -03003866
3867 if (fast_space_usage > kPipelineLayoutFastDescriptorSpaceNVIDIA) {
3868 skip |= LogPerformanceWarning(
3869 device, kVUID_BestPractices_CreatePipelinesLayout_LargePipelineLayout,
3870 "%s Pipeline layout size is too large, prefer using pipeline-specific descriptor set layouts. "
3871 "Aim for consuming less than %" PRIu32 " bytes to allow fast reads for all non-bindless descriptors. "
3872 "Samplers, textures, texel buffers, and combined image samplers consume 4 bytes each. "
3873 "Uniform buffers and acceleration structures consume 8 bytes. "
3874 "Storage buffers consume 16 bytes. "
3875 "Push constants do not consume space.",
3876 VendorSpecificTag(kBPVendorNVIDIA), kPipelineLayoutFastDescriptorSpaceNVIDIA);
3877 }
Rodrigo Locatti65b33832022-03-15 17:57:30 -03003878 }
3879
Nadav Gevaf0808442021-05-21 13:51:25 -04003880 return skip;
3881}
3882
3883bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3884 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3885 const VkImageCopy* pRegions) const {
3886 bool skip = false;
3887 std::stringstream src_image_hex;
3888 std::stringstream dst_image_hex;
3889 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
3890 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
3891
3892 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003893 auto src_state = Get<IMAGE_STATE>(srcImage);
3894 auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04003895
3896 if (src_state && dst_state) {
3897 VkImageTiling src_Tiling = src_state->createInfo.tiling;
3898 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
3899 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
3900 skip |=
3901 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
3902 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
3903 "image (vkCmdCopyImageToBuffer) "
3904 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
3905 "copies when converting between linear and optimal images",
3906 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
3907 }
3908 }
3909 }
3910
3911 return skip;
3912}
3913
3914bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
3915 VkPipeline pipeline) const {
3916 bool skip = false;
3917
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03003918 auto cb = Get<bp_state::CommandBuffer>(commandBuffer);
3919
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003920 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003921 if (IsPipelineUsedInFrame(pipeline)) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003922 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003923 "%s %s Performance warning: Pipeline %s was bound twice in the frame. "
3924 "Keep pipeline state changes to a minimum, for example, by sorting draw calls by pipeline.",
3925 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA),
3926 report_data->FormatHandle(pipeline).c_str());
Nadav Gevaf0808442021-05-21 13:51:25 -04003927 }
3928 }
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03003929 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3930 const auto& tgm = cb->nv.tess_geometry_mesh;
3931 if (tgm.num_switches >= kNumBindPipelineTessGeometryMeshSwitchesThresholdNVIDIA && !tgm.threshold_signaled) {
3932 LogPerformanceWarning(commandBuffer, kVUID_BestPractices_BindPipeline_SwitchTessGeometryMesh,
3933 "%s Avoid switching between pipelines with and without tessellation, geometry, task, "
3934 "and/or mesh shaders. Group draw calls using these shader stages together.",
3935 VendorSpecificTag(kBPVendorNVIDIA));
3936 // Do not set 'skip' so the number of switches gets properly counted after the message.
3937 }
3938 }
3939
Nadav Gevaf0808442021-05-21 13:51:25 -04003940 return skip;
3941}
3942
3943void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
3944 VkFence fence, VkResult result) {
3945 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003946 num_queue_submissions_ += submitCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003947}
3948
3949bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
3950 bool skip = false;
3951
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003952 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003953 auto num = num_queue_submissions_.load();
3954 if (num > kNumberOfSubmissionWarningLimitAMD) {
3955 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003956 "%s %s Performance warning: command buffers submitted %" PRId32
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003957 " times this frame. Submitting command buffers has a CPU "
3958 "and GPU overhead. Submit fewer times to incur less overhead.",
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003959 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04003960 }
3961 }
3962
3963 return skip;
3964}
3965
3966void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
3967 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
3968 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
3969 uint32_t bufferMemoryBarrierCount,
3970 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
3971 uint32_t imageMemoryBarrierCount,
3972 const VkImageMemoryBarrier* pImageMemoryBarriers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003973 num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount);
Nadav Gevaf0808442021-05-21 13:51:25 -04003974}
3975
3976bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3977 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
3978 bool skip = false;
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003979 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003980 if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003981 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003982 "%s %s Performance warning: High number of vkSemaphore objects created. "
Nadav Gevaf0808442021-05-21 13:51:25 -04003983 "Minimize the amount of queue synchronization that is used. "
3984 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003985 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04003986 }
3987 }
3988
3989 return skip;
3990}
3991
3992bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3993 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
3994 bool skip = false;
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003995 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003996 if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003997 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03003998 "%s %s Performance warning: High number of VkFence objects created."
Nadav Gevaf0808442021-05-21 13:51:25 -04003999 "Minimize the amount of CPU-GPU synchronization that is used. "
Rodrigo Locatti494e4482022-03-30 16:37:40 -03004000 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
4001 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04004002 }
4003 }
4004
4005 return skip;
4006}
4007
Sam Walls8e77e4f2020-03-16 20:47:40 +00004008void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
4009
4010bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
4011 // look for a cache hit
4012 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
4013 if (hit != _entries.end()) {
4014 // mark the cache hit as being most recently used
4015 hit->age = iteration++;
4016 return true;
4017 }
4018
4019 // if there's no cache hit, we need to model the entry being inserted into the cache
4020 CacheEntry new_entry = {value, iteration};
4021 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
4022 // if there is still space left in the cache, use the next available slot
4023 *(_entries.begin() + iteration) = new_entry;
4024 } else {
4025 // otherwise replace the least recently used cache entry
4026 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
4027 *lru = new_entry;
4028 }
4029 iteration++;
4030 return false;
4031}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004032
4033bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
4034 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004035 auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004036 bool skip = false;
4037 if (swapchain_data && swapchain_data->images.size() == 0) {
4038 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
4039 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
4040 "vkGetSwapchainImagesKHR after swapchain creation.");
4041 }
4042 return skip;
4043}
4044
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004045void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
4046 if (no_pointer) {
4047 if (UNCALLED == call_state) {
4048 call_state = QUERY_COUNT;
4049 }
4050 } else { // Save queue family properties
4051 call_state = QUERY_DETAILS;
4052 }
4053}
4054
Nathaniel Cesariof121d122020-10-08 13:09:46 -06004055void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
4056 uint32_t* pQueueFamilyPropertyCount,
4057 VkQueueFamilyProperties* pQueueFamilyProperties) {
4058 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
4059 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004060 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004061 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004062 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
4063 nullptr == pQueueFamilyProperties);
4064 }
4065}
4066
4067void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
4068 uint32_t* pQueueFamilyPropertyCount,
4069 VkQueueFamilyProperties2* pQueueFamilyProperties) {
4070 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
4071 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004072 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004073 if (bp_pd_state) {
4074 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
4075 nullptr == pQueueFamilyProperties);
4076 }
4077}
4078
4079void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
4080 uint32_t* pQueueFamilyPropertyCount,
4081 VkQueueFamilyProperties2* pQueueFamilyProperties) {
4082 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
4083 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004084 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004085 if (bp_pd_state) {
4086 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
4087 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004088 }
4089}
4090
Nathaniel Cesariof121d122020-10-08 13:09:46 -06004091void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
4092 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004093 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004094 if (bp_pd_state) {
4095 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
4096 }
4097}
4098
Nathaniel Cesariof121d122020-10-08 13:09:46 -06004099void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
4100 VkPhysicalDeviceFeatures2* pFeatures) {
4101 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004102 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004103 if (bp_pd_state) {
4104 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
4105 }
4106}
4107
Nathaniel Cesariof121d122020-10-08 13:09:46 -06004108void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
4109 VkPhysicalDeviceFeatures2* pFeatures) {
4110 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004111 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004112 if (bp_pd_state) {
4113 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
4114 }
4115}
4116
4117void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
4118 VkSurfaceKHR surface,
4119 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
4120 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004121 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004122 if (bp_pd_state) {
4123 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
4124 }
4125}
4126
4127void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
4128 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
4129 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004130 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004131 if (bp_pd_state) {
4132 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
4133 }
4134}
4135
4136void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
4137 VkSurfaceKHR surface,
4138 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
4139 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004140 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004141 if (bp_pd_state) {
4142 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
4143 }
4144}
4145
4146void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
4147 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
4148 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004149 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004150 if (bp_pd_data) {
4151 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
4152
4153 if (*pPresentModeCount) {
4154 if (call_state < QUERY_COUNT) {
4155 call_state = QUERY_COUNT;
4156 }
4157 }
4158 if (pPresentModes) {
4159 if (call_state < QUERY_DETAILS) {
4160 call_state = QUERY_DETAILS;
4161 }
4162 }
4163 }
4164}
4165
4166void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
4167 uint32_t* pSurfaceFormatCount,
4168 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004169 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004170 if (bp_pd_data) {
4171 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
4172
4173 if (*pSurfaceFormatCount) {
4174 if (call_state < QUERY_COUNT) {
4175 call_state = QUERY_COUNT;
4176 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06004177 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004178 }
4179 if (pSurfaceFormats) {
4180 if (call_state < QUERY_DETAILS) {
4181 call_state = QUERY_DETAILS;
4182 }
4183 }
4184 }
4185}
4186
4187void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
4188 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
4189 uint32_t* pSurfaceFormatCount,
4190 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004191 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004192 if (bp_pd_data) {
4193 if (*pSurfaceFormatCount) {
4194 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
4195 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
4196 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06004197 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004198 }
4199 if (pSurfaceFormats) {
4200 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
4201 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
4202 }
4203 }
4204 }
4205}
4206
4207void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
4208 uint32_t* pPropertyCount,
4209 VkDisplayPlanePropertiesKHR* pProperties,
4210 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004211 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004212 if (bp_pd_data) {
4213 if (*pPropertyCount) {
4214 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
4215 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
4216 }
4217 }
4218 if (pProperties) {
4219 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
4220 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
4221 }
4222 }
4223 }
4224}
4225
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004226void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
4227 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
4228 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004229 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Nathaniel Cesario39152e62021-07-02 13:04:16 -06004230 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
4231 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
4232 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004233 }
4234 }
4235}
4236
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004237void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
4238 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
4239
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004240 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004241 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02004242 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004243 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004244 auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004245 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07004246 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004247 }
4248 }
4249 }
4250}