blob: 5f31b5dedfd1067f3d2d0663c462d6660bb93912 [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
Rodrigo Locattie4c08a02022-04-04 18:12:18 -030061static constexpr std::array<VkFormat, 12> kCustomClearColorCompressedFormatsNVIDIA = {
62 VK_FORMAT_R8G8B8A8_UNORM, VK_FORMAT_B8G8R8A8_UNORM, VK_FORMAT_A8B8G8R8_UNORM_PACK32,
63 VK_FORMAT_A2R10G10B10_UNORM_PACK32, VK_FORMAT_A2B10G10R10_UNORM_PACK32, VK_FORMAT_R16G16B16A16_UNORM,
64 VK_FORMAT_R16G16B16A16_SNORM, VK_FORMAT_R16G16B16A16_UINT, VK_FORMAT_R16G16B16A16_SINT,
65 VK_FORMAT_R16G16B16A16_SFLOAT, VK_FORMAT_R32G32B32A32_SFLOAT, VK_FORMAT_B10G11R11_UFLOAT_PACK32,
66};
67
Jeremy Gebben20da7a12022-02-25 14:07:46 -070068ReadLockGuard BestPractices::ReadLock() {
69 if (fine_grained_locking) {
70 return ReadLockGuard(validation_object_mutex, std::defer_lock);
71 } else {
72 return ReadLockGuard(validation_object_mutex);
73 }
74}
75
76WriteLockGuard BestPractices::WriteLock() {
77 if (fine_grained_locking) {
78 return WriteLockGuard(validation_object_mutex, std::defer_lock);
79 } else {
80 return WriteLockGuard(validation_object_mutex);
81 }
82}
83
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060084std::shared_ptr<CMD_BUFFER_STATE> BestPractices::CreateCmdBufferState(VkCommandBuffer cb,
85 const VkCommandBufferAllocateInfo* pCreateInfo,
Jeremy Gebbencd7fa282021-10-27 10:25:32 -060086 const COMMAND_POOL_STATE* pool) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -070087 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 -060088}
89
Jeremy Gebben20da7a12022-02-25 14:07:46 -070090bp_state::CommandBuffer::CommandBuffer(BestPractices* bp, VkCommandBuffer cb, const VkCommandBufferAllocateInfo* pCreateInfo,
91 const COMMAND_POOL_STATE* pool)
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060092 : CMD_BUFFER_STATE(bp, cb, pCreateInfo, pool) {}
93
Attilio Provenzano19d6a982020-02-27 12:41:41 +000094bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070095 for (const auto& vendor : kVendorInfo) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060096 if (vendors & vendor.first && enabled[vendor.second.vendor_id]) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000097 return true;
98 }
99 }
100 return false;
101}
102
103const char* VendorSpecificTag(BPVendorFlags vendors) {
104 // Cache built vendor tags in a map
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700105 static layer_data::unordered_map<BPVendorFlags, std::string> tag_map;
Attilio Provenzano19d6a982020-02-27 12:41:41 +0000106
107 auto res = tag_map.find(vendors);
108 if (res == tag_map.end()) {
109 // Build the vendor tag string
110 std::stringstream vendor_tag;
111
112 vendor_tag << "[";
113 bool first_vendor = true;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700114 for (const auto& vendor : kVendorInfo) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +0000115 if (vendors & vendor.first) {
116 if (!first_vendor) {
117 vendor_tag << ", ";
118 }
119 vendor_tag << vendor.second.name;
120 first_vendor = false;
121 }
122 }
123 vendor_tag << "]";
124
125 tag_map[vendors] = vendor_tag.str();
126 res = tag_map.find(vendors);
127 }
128
129 return res->second.c_str();
130}
131
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700132const char* DepReasonToString(ExtDeprecationReason reason) {
133 switch (reason) {
134 case kExtPromoted:
135 return "promoted to";
136 break;
137 case kExtObsoleted:
138 return "obsoleted by";
139 break;
140 case kExtDeprecated:
141 return "deprecated by";
142 break;
143 default:
144 return "";
145 break;
146 }
147}
148
149bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version,
150 const char* vuid) const {
151 bool skip = false;
152 auto dep_info_it = deprecated_extensions.find(extension_name);
153 if (dep_info_it != deprecated_extensions.end()) {
154 auto dep_info = dep_info_it->second;
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600155 if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) ||
Tony-LunarGc30b59f2022-02-15 11:02:36 -0700156 ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2)) ||
157 ((dep_info.target.compare("VK_VERSION_1_3") == 0) && (version >= VK_API_VERSION_1_3))) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700158 skip |=
159 LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
160 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600161 } else if (dep_info.target.find("VK_VERSION") == std::string::npos) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700162 if (dep_info.target.length() == 0) {
163 skip |= LogWarning(instance, vuid,
164 "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated "
165 "without replacement.",
166 api_name, extension_name);
167 } else {
168 skip |= LogWarning(instance, vuid,
169 "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
170 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
171 }
172 }
173 }
174 return skip;
175}
176
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200177bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const SpecialUseVUIDs& special_use_vuids) const
178{
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700179 bool skip = false;
180 auto dep_info_it = special_use_extensions.find(extension_name);
181
182 if (dep_info_it != special_use_extensions.end()) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200183 const char* const format = "%s(): Attempting to enable extension %s, but this extension is intended to support %s "
184 "and it is strongly recommended that it be otherwise avoided.";
185 auto& special_uses = dep_info_it->second;
sfricke-samsungef15e482022-01-26 11:32:49 -0800186
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700187 if (special_uses.find("cadsupport") != std::string::npos) {
sfricke-samsungef15e482022-01-26 11:32:49 -0800188 skip |= LogWarning(instance, special_use_vuids.cadsupport, format, api_name, extension_name,
189 "specialized functionality used by CAD/CAM applications");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700190 }
191 if (special_uses.find("d3demulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200192 skip |= LogWarning(instance, special_use_vuids.d3demulation, format, api_name, extension_name,
193 "D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700194 }
195 if (special_uses.find("devtools") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200196 skip |= LogWarning(instance, special_use_vuids.devtools, format, api_name, extension_name,
197 "developer tools such as capture-replay libraries");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700198 }
199 if (special_uses.find("debugging") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200200 skip |= LogWarning(instance, special_use_vuids.debugging, format, api_name, extension_name,
201 "use by applications when debugging");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700202 }
203 if (special_uses.find("glemulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200204 skip |= LogWarning(instance, special_use_vuids.glemulation, format, api_name, extension_name,
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700205 "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality "
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200206 "specific to those APIs");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700207 }
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700208 }
209 return skip;
210}
211
Camden5b184be2019-08-13 07:50:19 -0600212bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500213 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600214 bool skip = false;
215
216 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
217 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800218 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700219 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
220 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600221 }
Mark Lobodzinski17d8dc62020-06-03 08:48:58 -0600222 uint32_t specified_version =
223 (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0);
224 skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700225 kVUID_BestPractices_CreateInstance_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200226 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseInstanceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600227 }
228
229 return skip;
230}
231
Camden5b184be2019-08-13 07:50:19 -0600232bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500233 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -0600234 bool skip = false;
235
236 // get API version of physical device passed when creating device.
237 VkPhysicalDeviceProperties physical_device_properties{};
238 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500239 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -0600240
241 // check api versions and warn if instance api Version is higher than version on device.
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600242 if (api_version > device_api_version) {
243 std::string inst_api_name = StringAPIVersion(api_version);
Mark Lobodzinski60880782020-08-11 08:02:07 -0600244 std::string dev_api_name = StringAPIVersion(device_api_version);
Camden5b184be2019-08-13 07:50:19 -0600245
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700246 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
247 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
248 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600249 }
250
Rodrigo Locattic2d5cf42022-03-01 18:05:26 -0300251 std::vector<std::string> extensions;
252 {
253 uint32_t property_count = 0;
254 if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, nullptr) == VK_SUCCESS) {
255 std::vector<VkExtensionProperties> property_list(property_count);
256 if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, property_list.data()) == VK_SUCCESS) {
257 extensions.reserve(property_list.size());
258 for (const VkExtensionProperties& properties : property_list) {
259 extensions.push_back(properties.extensionName);
260 }
261 }
262 }
263 }
264
Camden5b184be2019-08-13 07:50:19 -0600265 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300266 const char *extension_name = pCreateInfo->ppEnabledExtensionNames[i];
267
paul-lunargd8c78082022-08-31 20:00:02 +0200268 uint32_t extension_api_version = std::min(api_version, device_api_version);
paul-lunarg4e0e1df2022-08-31 18:46:21 +0200269
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300270 if (white_list(extension_name, kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800271 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700272 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300273 extension_name);
paul-lunarg4e0e1df2022-08-31 18:46:21 +0200274 extension_api_version = api_version;
Camden5b184be2019-08-13 07:50:19 -0600275 }
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300276
paul-lunarg4e0e1df2022-08-31 18:46:21 +0200277 skip |= ValidateDeprecatedExtensions("CreateDevice", extension_name, extension_api_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700278 kVUID_BestPractices_CreateDevice_DeprecatedExtension);
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300279 skip |= ValidateSpecialUseExtensions("CreateDevice", extension_name, kSpecialUseDeviceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600280 }
281
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700282 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600283 if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700284 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
285 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600286 }
287
LawG43f848c72022-02-23 09:35:21 +0000288 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorIMG)) &&
289 (pCreateInfo->pEnabledFeatures != nullptr) && (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
Szilard Papp7d2c7952020-06-22 14:38:13 +0100290 skip |= LogPerformanceWarning(
291 device, kVUID_BestPractices_CreateDevice_RobustBufferAccess,
LawG4015be1c2022-03-01 10:37:52 +0000292 "%s %s %s: vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during "
Szilard Papp7d2c7952020-06-22 14:38:13 +0100293 "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage "
294 "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case "
295 "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.",
LawG43f848c72022-02-23 09:35:21 +0000296 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorIMG));
Szilard Papp7d2c7952020-06-22 14:38:13 +0100297 }
298
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300299 const bool enabled_pageable_device_local_memory = IsExtEnabled(device_extensions.vk_ext_pageable_device_local_memory);
300 if (VendorCheckEnabled(kBPVendorNVIDIA) && !enabled_pageable_device_local_memory &&
301 std::find(extensions.begin(), extensions.end(), VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME) != extensions.end()) {
302 skip |= LogPerformanceWarning(
303 device, kVUID_BestPractices_CreateDevice_PageableDeviceLocalMemory,
304 "%s vkCreateDevice() called without pageable device local memory. "
305 "Use pageableDeviceLocalMemory from VK_EXT_pageable_device_local_memory when it is available.",
306 VendorSpecificTag(kBPVendorNVIDIA));
307 }
308
Camden5b184be2019-08-13 07:50:19 -0600309 return skip;
310}
311
312bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500313 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600314 bool skip = false;
315
316 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700317 std::stringstream buffer_hex;
318 buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer);
Camden5b184be2019-08-13 07:50:19 -0600319
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700320 skip |= LogWarning(
321 device, kVUID_BestPractices_SharingModeExclusive,
322 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
323 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700324 buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600325 }
326
327 return skip;
328}
329
330bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500331 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600332 bool skip = false;
333
334 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700335 std::stringstream image_hex;
336 image_hex << "0x" << std::hex << HandleToUint64(pImage);
Camden5b184be2019-08-13 07:50:19 -0600337
338 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700339 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
340 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
341 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700342 image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600343 }
344
ziga-lunarg6df3d102022-03-18 17:02:14 +0100345 if ((pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT) && !(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
346 skip |= LogWarning(device, kVUID_BestPractices_ImageCreateFlags,
347 "vkCreateImage(): pCreateInfo->flags has VK_IMAGE_CREATE_EXTENDED_USAGE_BIT set, but not "
348 "VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, therefore image views created from this image will have to use the "
349 "same format and VK_IMAGE_CREATE_EXTENDED_USAGE_BIT will not have any effect.");
350 }
351
LawG4655f59c2022-02-23 13:55:55 +0000352 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000353 if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
354 skip |= LogPerformanceWarning(
355 device, kVUID_BestPractices_CreateImage_NonTransientMSImage,
LawG4655f59c2022-02-23 13:55:55 +0000356 "%s %s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have "
Attilio Provenzano02859b22020-02-27 14:17:28 +0000357 "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, "
358 "and do not need to be backed by physical storage. "
359 "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.",
LawG4655f59c2022-02-23 13:55:55 +0000360 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Attilio Provenzano02859b22020-02-27 14:17:28 +0000361 }
362 }
363
LawG4ba113892022-02-23 14:39:02 +0000364 if (VendorCheckEnabled(kBPVendorArm) && pCreateInfo->samples > kMaxEfficientSamplesArm) {
365 skip |= LogPerformanceWarning(
366 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
367 "%s vkCreateImage(): Trying to create an image with %u samples. "
368 "The hardware revision may not have full throughput for framebuffers with more than %u samples.",
369 VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm);
370 }
371
372 if (VendorCheckEnabled(kBPVendorIMG) && pCreateInfo->samples > kMaxEfficientSamplesImg) {
373 skip |= LogPerformanceWarning(
374 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
375 "%s vkCreateImage(): Trying to create an image with %u samples. "
376 "The device may not have full support for true multisampling for images with more than %u samples. "
377 "XT devices support up to 8 samples, XE up to 4 samples.",
378 VendorSpecificTag(kBPVendorIMG), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesImg);
379 }
380
LawG4db16f802022-03-21 17:33:39 +0000381 if (VendorCheckEnabled(kBPVendorIMG) && (pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG ||
382 pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG ||
383 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG ||
384 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG ||
385 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG ||
386 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG ||
387 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG ||
388 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG)) {
389 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Texture_Format_PVRTC_Outdated,
390 "%s vkCreateImage(): Trying to create an image with a PVRTC format. Both PVRTC1 and PVRTC2 "
391 "are slower than standard image formats on PowerVR GPUs, prefer ETC, BC, ASTC, etc.",
392 VendorSpecificTag(kBPVendorIMG));
393 }
394
Nadav Gevaf0808442021-05-21 13:51:25 -0400395 if (VendorCheckEnabled(kBPVendorAMD)) {
396 std::stringstream image_hex;
397 image_hex << "0x" << std::hex << HandleToUint64(pImage);
398
399 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
400 (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) {
401 skip |= LogPerformanceWarning(device,
402 kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets,
403 "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. "
404 "Using a SHARING_MODE_CONCURRENT "
405 "is not recommended with color and depth targets",
406 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
407 }
408
409 if ((pCreateInfo->usage &
410 (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
411 (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
412 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets,
413 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. "
414 "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets",
415 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
416 }
417
418 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
419 (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
420 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets,
421 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a "
422 "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets",
423 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
424 }
425 }
426
Rodrigo Locatti5466f9d2022-03-09 18:20:38 -0300427 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
428 std::stringstream image_hex;
429 image_hex << "0x" << std::hex << HandleToUint64(pImage);
430
431 if (pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) {
432 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateImage_TilingLinear,
433 "%s Performance warning: image (%s) is created with tiling VK_IMAGE_TILING_LINEAR. "
434 "Use VK_IMAGE_TILING_OPTIMAL instead.",
435 VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str());
436 }
Rodrigo Locatti3290c2b2022-03-09 18:25:56 -0300437
438 if (pCreateInfo->format == VK_FORMAT_D32_SFLOAT || pCreateInfo->format == VK_FORMAT_D32_SFLOAT_S8_UINT) {
439 skip |= LogPerformanceWarning(
440 device, kVUID_BestPractices_CreateImage_Depth32Format,
441 "%s Performance warning: image (%s) is created with a 32-bit depth format. Use VK_FORMAT_D24_UNORM_S8_UINT or "
442 "VK_FORMAT_D16_UNORM instead, unless the extra precision is needed.",
443 VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str());
444 }
Rodrigo Locatti5466f9d2022-03-09 18:20:38 -0300445 }
446
Camden5b184be2019-08-13 07:50:19 -0600447 return skip;
448}
449
450bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500451 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600452 bool skip = false;
453
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600454 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600455 if (bp_pd_state) {
456 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
457 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
458 "vkCreateSwapchainKHR() called before getting surface capabilities from "
459 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
460 }
Camden83a9c372019-08-14 11:41:38 -0600461
Shannon McPherson73e58c82021-03-05 17:14:26 -0700462 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
463 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600464 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
465 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
466 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
467 }
Camden83a9c372019-08-14 11:41:38 -0600468
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600469 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
470 skip |= LogWarning(
471 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
472 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
473 }
Camden83a9c372019-08-14 11:41:38 -0600474 }
475
Camden5b184be2019-08-13 07:50:19 -0600476 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700477 skip |=
478 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600479 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700480 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
481 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600482 }
483
ziga-lunarg79beba62022-03-30 01:17:30 +0200484 const auto present_mode = pCreateInfo->presentMode;
485 if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) &&
486 (pCreateInfo->minImageCount == 2)) {
Szilard Papp48a6da32020-06-10 14:41:59 +0100487 skip |= LogPerformanceWarning(
488 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
489 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
490 ", which means double buffering is going "
491 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
492 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
493 "3 to use triple buffering to maximize performance in such cases.",
494 pCreateInfo->minImageCount);
495 }
496
Szilard Pappd5f0f812020-06-22 09:01:29 +0100497 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
498 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
499 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
500 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
501 "Presentation modes which are not FIFO will present the latest available frame and discard other "
502 "frame(s) if any.",
503 VendorSpecificTag(kBPVendorArm));
504 }
505
Camden5b184be2019-08-13 07:50:19 -0600506 return skip;
507}
508
509bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
510 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500511 const VkAllocationCallbacks* pAllocator,
512 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600513 bool skip = false;
514
515 for (uint32_t i = 0; i < swapchainCount; i++) {
516 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700517 skip |= LogWarning(
518 device, kVUID_BestPractices_SharingModeExclusive,
519 "Warning: A shared swapchain (index %" PRIu32
520 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
521 "queues (queueFamilyIndexCount of %" PRIu32 ").",
522 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600523 }
524 }
525
526 return skip;
527}
528
529bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500530 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600531 bool skip = false;
532
533 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
534 VkFormat format = pCreateInfo->pAttachments[i].format;
535 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
536 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
537 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700538 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
539 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
540 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
541 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
542 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600543 }
544 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700545 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
546 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
547 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
548 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
549 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600550 }
551 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000552
553 const auto& attachment = pCreateInfo->pAttachments[i];
554 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
555 bool access_requires_memory =
556 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
557
558 if (FormatHasStencil(format)) {
559 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
560 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
561 }
562
563 if (access_requires_memory) {
564 skip |= LogPerformanceWarning(
565 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
566 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
567 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
568 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
569 i, static_cast<uint32_t>(attachment.samples));
570 }
571 }
Camden5b184be2019-08-13 07:50:19 -0600572 }
573
574 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
575 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
576 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
577 }
578
579 return skip;
580}
581
Tony-LunarG767180f2020-04-23 14:03:59 -0600582bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
583 const VkImageView* image_views) const {
584 bool skip = false;
585
586 // Check for non-transient attachments that should be transient and vice versa
587 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200588 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600589 bool attachment_should_be_transient =
590 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
591
592 if (FormatHasStencil(attachment.format)) {
593 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
594 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
595 }
596
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600597 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600598 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600599 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600600
601 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
602
603 // The check for an image that should not be transient applies to all GPUs
604 if (!attachment_should_be_transient && image_is_transient) {
605 skip |= LogPerformanceWarning(
606 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
607 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
608 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
609 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
610 i);
611 }
612
613 bool supports_lazy = false;
614 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
615 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
616 supports_lazy = true;
617 }
618 }
619
620 // The check for an image that should be transient only applies to GPUs supporting
621 // lazily allocated memory
622 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
623 skip |= LogPerformanceWarning(
624 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
625 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
626 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
627 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
628 i);
629 }
630 }
631 }
632 return skip;
633}
634
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000635bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
636 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
637 bool skip = false;
638
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600639 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800640 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600641 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000642 }
643
644 return skip;
645}
646
Sam Wallse746d522020-03-16 21:20:23 +0000647bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
648 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
649 bool skip = false;
650 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
651
652 if (!skip) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700653 const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000654 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
655 // this warning is specific to Arm
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700656 if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) {
Sam Wallse746d522020-03-16 21:20:23 +0000657 skip |= LogPerformanceWarning(
658 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
659 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
660 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
661 VendorSpecificTag(kBPVendorArm));
662 }
ziga-lunarg5a76c442022-04-17 18:04:08 +0200663
664 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
665 // Track number of descriptorSets allowable in this pool
666 if (pool_state->GetAvailableSets() < pAllocateInfo->descriptorSetCount) {
667 skip |= LogWarning(pool_state->Handle(), kVUID_BestPractices_EmptyDescriptorPool,
668 "vkAllocateDescriptorSets(): Unable to allocate %" PRIu32 " descriptorSets from %s"
669 ". This pool only has %" PRIu32 " descriptorSets remaining.",
670 pAllocateInfo->descriptorSetCount, report_data->FormatHandle(pool_state->Handle()).c_str(),
671 pool_state->GetAvailableSets());
672 }
673 }
Sam Wallse746d522020-03-16 21:20:23 +0000674 }
675
676 return skip;
677}
678
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600679void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
680 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000681 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700682 auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
683 if (pool_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000684 // we record successful allocations by subtracting the allocation count from the last recorded free count
685 const auto alloc_count = pAllocateInfo->descriptorSetCount;
686 // clamp the unsigned subtraction to the range [0, last_free_count]
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700687 if (pool_state->freed_count > alloc_count) {
688 pool_state->freed_count -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700689 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700690 pool_state->freed_count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700691 }
Sam Wallse746d522020-03-16 21:20:23 +0000692 }
693 }
694}
695
696void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
697 const VkDescriptorSet* pDescriptorSets, VkResult result) {
698 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
699 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700700 auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000701 // we want to track frees because we're interested in suggesting re-use
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700702 if (pool_state) {
703 pool_state->freed_count += descriptorSetCount;
Sam Wallse746d522020-03-16 21:20:23 +0000704 }
705 }
706}
707
Rodrigo Locattid5b54f52022-03-16 19:12:45 -0300708void BestPractices::PreCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
709 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) {
710 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
711 WriteLockGuard guard{memory_free_events_lock_};
712
713 // Release old allocations to avoid overpopulating the container
714 const auto now = std::chrono::high_resolution_clock::now();
715 const auto last_old = std::find_if(memory_free_events_.rbegin(), memory_free_events_.rend(), [now](const MemoryFreeEvent& event) {
716 return now - event.time > kAllocateMemoryReuseTimeThresholdNVIDIA;
717 });
718 memory_free_events_.erase(memory_free_events_.begin(), last_old.base());
719 }
720}
721
Camden5b184be2019-08-13 07:50:19 -0600722bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500723 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600724 bool skip = false;
725
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700726 if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700727 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
728 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600729 }
730
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000731 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
732 skip |= LogPerformanceWarning(
733 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600734 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
735 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000736 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
737 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
738 }
739
Rodrigo Locattid5b54f52022-03-16 19:12:45 -0300740 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
741 if (!device_extensions.vk_ext_pageable_device_local_memory &&
742 !LvlFindInChain<VkMemoryPriorityAllocateInfoEXT>(pAllocateInfo->pNext)) {
743 skip |= LogPerformanceWarning(
744 device, kVUID_BestPractices_AllocateMemory_SetPriority,
745 "%s Use VkMemoryPriorityAllocateInfoEXT to provide the operating system information on the allocations that "
746 "should stay in video memory and which should be demoted first when video memory is limited. "
747 "The highest priority should be given to GPU-written resources like color attachments, depth attachments, "
748 "storage images, and buffers written from the GPU.",
749 VendorSpecificTag(kBPVendorNVIDIA));
750 }
751
752 {
753 // Size in bytes for an allocation to be considered "compatible"
754 static constexpr VkDeviceSize size_threshold = VkDeviceSize{1} << 20;
755
756 ReadLockGuard guard{memory_free_events_lock_};
757
758 const auto now = std::chrono::high_resolution_clock::now();
759 const VkDeviceSize alloc_size = pAllocateInfo->allocationSize;
760 const uint32_t memory_type_index = pAllocateInfo->memoryTypeIndex;
761 const auto latest_event = std::find_if(memory_free_events_.rbegin(), memory_free_events_.rend(), [&](const MemoryFreeEvent& event) {
762 return (memory_type_index == event.memory_type_index) && (alloc_size <= event.allocation_size) &&
763 (alloc_size - event.allocation_size <= size_threshold) && (now - event.time < kAllocateMemoryReuseTimeThresholdNVIDIA);
764 });
765
766 if (latest_event != memory_free_events_.rend()) {
767 const auto time_delta = std::chrono::duration_cast<std::chrono::milliseconds>(now - latest_event->time);
768 if (time_delta < std::chrono::milliseconds{5}) {
769 skip |=
770 LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_ReuseAllocations,
771 "%s Reuse memory allocations instead of releasing and reallocating. A memory allocation "
772 "has just been released, and it could have been reused in place of this allocation.",
773 VendorSpecificTag(kBPVendorNVIDIA));
774 } else {
775 const uint32_t seconds = static_cast<uint32_t>(time_delta.count() / 1000);
776 const uint32_t milliseconds = static_cast<uint32_t>(time_delta.count() % 1000);
777
778 skip |= LogPerformanceWarning(
779 device, kVUID_BestPractices_AllocateMemory_ReuseAllocations,
780 "%s Reuse memory allocations instead of releasing and reallocating. A memory allocation has been released "
781 "%" PRIu32 ".%03" PRIu32 " seconds ago, and it could have been reused in place of this allocation.",
782 VendorSpecificTag(kBPVendorNVIDIA), seconds, milliseconds);
783 }
784 }
785 }
Rodrigo Locattie4f8d522022-03-15 16:30:49 -0300786 }
787
Camden83a9c372019-08-14 11:41:38 -0600788 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
789
790 return skip;
791}
792
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600793void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
794 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
795 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700796 if (result != VK_SUCCESS) {
797 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
798 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800799 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700800 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600801 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700802 return;
803 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700804}
Camden Stocker9738af92019-10-16 13:54:03 -0700805
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600806void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
807 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700808 auto error = std::find(error_codes.begin(), error_codes.end(), result);
809 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000810 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
811 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
812
813 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
814 if (common_failure != common_failure_codes.end()) {
815 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
816 } else {
817 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
818 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700819 return;
820 }
821 auto success = std::find(success_codes.begin(), success_codes.end(), result);
822 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600823 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
824 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500825 }
826}
827
Rodrigo Locattid5b54f52022-03-16 19:12:45 -0300828void BestPractices::PreCallRecordFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks* pAllocator) {
829 if (memory != VK_NULL_HANDLE && VendorCheckEnabled(kBPVendorNVIDIA)) {
830 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
831
832 // Exclude memory free events on dedicated allocations, or imported/exported allocations.
833 if (!mem_info->IsDedicatedBuffer() && !mem_info->IsDedicatedImage() && !mem_info->IsExport() && !mem_info->IsImport()) {
834 MemoryFreeEvent event;
835 event.time = std::chrono::high_resolution_clock::now();
836 event.memory_type_index = mem_info->alloc_info.memoryTypeIndex;
837 event.allocation_size = mem_info->alloc_info.allocationSize;
838
839 WriteLockGuard guard{memory_free_events_lock_};
840 memory_free_events_.push_back(event);
841 }
842 }
843
844 ValidationStateTracker::PreCallRecordFreeMemory(device, memory, pAllocator);
845}
846
Jeff Bolz5c801d12019-10-09 10:38:45 -0500847bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
848 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700849 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600850 bool skip = false;
851
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700852 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600853
Jeremy Gebben610d3a62022-01-01 12:53:17 -0700854 for (const auto& item : mem_info->ObjectBindings()) {
855 const auto& obj = item.first;
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600856 LogObjectList objlist(device);
857 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600858 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600859 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 -0600860 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600861 }
862
Camden5b184be2019-08-13 07:50:19 -0600863 return skip;
864}
865
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000866bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600867 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700868 auto buffer_state = Get<BUFFER_STATE>(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600869
sfricke-samsunge2441192019-11-06 14:07:57 -0800870 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700871 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
872 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
873 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600874 }
875
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700876 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000877
AndreyVK_D3D0416a332021-11-02 23:22:28 +0300878 if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000879 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
880 skip |= LogPerformanceWarning(
881 device, kVUID_BestPractices_SmallDedicatedAllocation,
882 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600883 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
884 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000885 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
886 }
887
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300888 skip |= ValidateBindMemory(device, memory);
889
Camden Stockerb603cc82019-09-03 10:09:02 -0600890 return skip;
891}
892
893bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500894 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600895 bool skip = false;
896 const char* api_name = "BindBufferMemory()";
897
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000898 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600899
900 return skip;
901}
902
903bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500904 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600905 char api_name[64];
906 bool skip = false;
907
908 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200909 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000910 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600911 }
912
913 return skip;
914}
Camden Stockerb603cc82019-09-03 10:09:02 -0600915
916bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500917 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600918 char api_name[64];
919 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600920
Camden Stocker8b798ab2019-09-03 10:33:28 -0600921 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200922 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000923 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600924 }
925
926 return skip;
927}
928
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000929bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600930 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700931 auto image_state = Get<IMAGE_STATE>(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600932
sfricke-samsung71bc6572020-04-29 15:49:43 -0700933 if (image_state->disjoint == false) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600934 if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700935 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
936 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
937 api_name, report_data->FormatHandle(image).c_str());
938 }
939 } else {
940 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
941 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600942 }
943
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700944 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000945
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600946 if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000947 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
948 skip |= LogPerformanceWarning(
949 device, kVUID_BestPractices_SmallDedicatedAllocation,
950 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600951 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
952 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000953 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
954 }
955
956 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
957 // make sure this type is actually used.
958 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
959 // (i.e.most tile - based renderers)
960 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
961 bool supports_lazy = false;
962 uint32_t suggested_type = 0;
963
964 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600965 if ((1u << i) & image_state->requirements[0].memoryTypeBits) {
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000966 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
967 supports_lazy = true;
968 suggested_type = i;
969 break;
970 }
971 }
972 }
973
974 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
975
976 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
977 skip |= LogPerformanceWarning(
978 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600979 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000980 "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 -0600981 "%" PRIu64 " bytes of physical memory.",
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600982 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000983 }
984 }
985
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300986 skip |= ValidateBindMemory(device, memory);
987
Camden Stocker8b798ab2019-09-03 10:33:28 -0600988 return skip;
989}
990
991bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500992 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600993 bool skip = false;
994 const char* api_name = "vkBindImageMemory()";
995
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000996 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600997
998 return skip;
999}
1000
1001bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001002 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -06001003 char api_name[64];
1004 bool skip = false;
1005
1006 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +02001007 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001008 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -06001009 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
1010 }
Camden Stocker8b798ab2019-09-03 10:33:28 -06001011 }
1012
1013 return skip;
1014}
1015
1016bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001017 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -06001018 char api_name[64];
1019 bool skip = false;
1020
1021 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +02001022 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +00001023 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -06001024 }
1025
1026 return skip;
1027}
Camden83a9c372019-08-14 11:41:38 -06001028
Rodrigo Locatti66b23352022-03-15 17:28:32 -03001029void BestPractices::PreCallRecordSetDeviceMemoryPriorityEXT(VkDevice device, VkDeviceMemory memory, float priority) {
1030 auto mem_info = std::static_pointer_cast<bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory));
1031 mem_info->dynamic_priority.emplace(priority);
1032}
1033
Attilio Provenzano02859b22020-02-27 14:17:28 +00001034static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
1035 switch (format) {
1036 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
1037 case VK_FORMAT_R16_SFLOAT:
1038 case VK_FORMAT_R16G16_SFLOAT:
1039 case VK_FORMAT_R16G16B16_SFLOAT:
1040 case VK_FORMAT_R16G16B16A16_SFLOAT:
1041 case VK_FORMAT_R32_SFLOAT:
1042 case VK_FORMAT_R32G32_SFLOAT:
1043 case VK_FORMAT_R32G32B32_SFLOAT:
1044 case VK_FORMAT_R32G32B32A32_SFLOAT:
1045 return false;
1046
1047 default:
1048 return true;
1049 }
1050}
1051
1052bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
1053 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
1054 bool skip = false;
1055
1056 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001057 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001058
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001059 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
1060 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
1061 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +00001062 return skip;
1063 }
1064
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001065 auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001066 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001067
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +02001068 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1069 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount);
1070
1071 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001072 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001073 uint32_t att = subpass.pColorAttachments[j].attachment;
1074
1075 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
1076 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
1077 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
1078 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
1079 "color attachment #%u makes use "
1080 "of a format which cannot be blended at full throughput when using MSAA.",
1081 VendorSpecificTag(kBPVendorArm), i, j);
1082 }
1083 }
1084 }
1085 }
1086
1087 return skip;
1088}
1089
Nadav Gevaf0808442021-05-21 13:51:25 -04001090void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1091 const VkComputePipelineCreateInfo* pCreateInfos,
1092 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1093 VkResult result, void* pipe_state) {
1094 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001095 pipeline_cache_ = pipelineCache;
Nadav Gevaf0808442021-05-21 13:51:25 -04001096}
1097
Camden5b184be2019-08-13 07:50:19 -06001098bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1099 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001100 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001101 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001102 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1103 pAllocator, pPipelines, cgpl_state_data);
ziga-lunarg08c81582022-03-08 17:33:45 +01001104 if (skip) {
1105 return skip;
1106 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001107 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001108
1109 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001110 skip |= LogPerformanceWarning(
1111 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1112 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
1113 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001114 }
1115
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001116 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001117 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001118
Tony-LunarGb6a2daf2022-07-29 11:30:55 -06001119 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 +02001120 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001121 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001122 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
1123 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001124 count++;
1125 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001126 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001127 if (count > kMaxInstancedVertexBuffers) {
1128 skip |= LogPerformanceWarning(
1129 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
1130 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
1131 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
1132 count, kMaxInstancedVertexBuffers);
1133 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001134 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001135
Szilard Pappaaf2da32020-06-22 10:37:35 +01001136 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
1137 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001138 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
1139 VendorCheckEnabled(kBPVendorArm)) {
1140 skip |= LogPerformanceWarning(
1141 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
1142 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
1143 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
1144 "efficiency during rasterization. Consider disabling depthBias or increasing either "
1145 "depthBiasConstantFactor or depthBiasSlopeFactor.",
1146 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +01001147 }
1148
Attilio Provenzano02859b22020-02-27 14:17:28 +00001149 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001150 }
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001151 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001152 auto prev_pipeline = pipeline_cache_.load();
1153 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001154 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001155 "%s %s Performance Warning: A second pipeline cache is in use. "
1156 "Consider using only one pipeline cache to improve cache hit rate.",
1157 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04001158 }
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001159 }
1160 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001161 if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001162 skip |=
1163 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
1164 "%s Performance warning: Too many pipelines created, consider consolidation",
1165 VendorSpecificTag(kBPVendorAMD));
1166 }
1167
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -06001168 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001169 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
1170 "%s Performance warning: Use of primitive restart is not recommended",
1171 VendorSpecificTag(kBPVendorAMD));
1172 }
1173
1174 // TODO: this might be too aggressive of a check
1175 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1176 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1177 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1178 VendorSpecificTag(kBPVendorAMD));
1179 }
1180 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001181
Camden5b184be2019-08-13 07:50:19 -06001182 return skip;
1183}
1184
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001185static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info,
1186 std::shared_ptr<const RENDER_PASS_STATE>& rp) {
1187 std::vector<bp_state::AttachmentInfo> result;
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06001188 if (!rp || rp->UsesDynamicRendering()) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001189 return result;
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001190 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001191
1192 const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1193
1194 // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState
1195 // are only non-null if they are enabled.
1196 if (create_info.pColorBlendState) {
1197 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1198 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount);
1199 for (uint32_t j = 0; j < num_color_attachments; j++) {
1200 if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) {
1201 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1202 if (attachment != VK_ATTACHMENT_UNUSED) {
1203 result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT});
1204 }
1205 }
1206 }
1207 }
1208
1209 if (create_info.pDepthStencilState &&
1210 (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable ||
1211 create_info.pDepthStencilState->stencilTestEnable)) {
1212 uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED;
1213 if (attachment != VK_ATTACHMENT_UNUSED) {
1214 VkImageAspectFlags aspects = 0;
1215 if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) {
1216 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1217 }
1218 if (create_info.pDepthStencilState->stencilTestEnable) {
1219 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1220 }
1221 result.push_back({attachment, aspects});
1222 }
1223 }
1224 return result;
1225}
1226
1227bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo,
1228 std::shared_ptr<const RENDER_PASS_STATE>&& rpstate,
1229 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout)
1230 : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)),
1231 access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {}
1232
1233std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState(
1234 const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass,
1235 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const {
1236 return std::static_pointer_cast<PIPELINE_STATE>(
1237 std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout)));
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001238}
1239
Sam Walls0961ec02020-03-31 16:39:15 +01001240void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1241 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1242 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1243 VkResult result, void* cgpl_state_data) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001244 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001245 pipeline_cache_ = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001246}
1247
Camden5b184be2019-08-13 07:50:19 -06001248bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1249 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001250 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001251 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001252 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1253 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001254
1255 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001256 skip |= LogPerformanceWarning(
1257 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1258 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1259 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001260 }
1261
Nadav Gevaf0808442021-05-21 13:51:25 -04001262 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001263 auto prev_pipeline = pipeline_cache_.load();
1264 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
1265 skip |= LogPerformanceWarning(
1266 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1267 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
Nadav Gevaf0808442021-05-21 13:51:25 -04001268 "improve cache hit rate",
1269 VendorSpecificTag(kBPVendorAMD));
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001270 }
1271 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001272
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001273 for (uint32_t i = 0; i < createInfoCount; i++) {
1274 const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i];
1275 if (VendorCheckEnabled(kBPVendorArm)) {
1276 skip |= ValidateCreateComputePipelineArm(createInfo);
1277 }
sfricke-samsung86d055a2022-02-11 14:43:50 -08001278
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001279 if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) {
1280 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
1281 for (const auto& builtin : module_state->static_data_.builtin_decoration_list) {
1282 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1283 skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize,
1284 "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32
1285 "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 "
1286 "extension exposes a new LocalSizeId execution mode that should be used instead.",
1287 i);
sfricke-samsung86d055a2022-02-11 14:43:50 -08001288 }
1289 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001290 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001291 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001292
1293 return skip;
1294}
1295
1296bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1297 bool skip = false;
sfricke-samsungef15e482022-01-26 11:32:49 -08001298 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001299 // Generate warnings about work group sizes based on active resources.
sfricke-samsungef15e482022-01-26 11:32:49 -08001300 auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
1301 if (entrypoint == module_state->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001302
1303 uint32_t x = 1, y = 1, z = 1;
sfricke-samsungef15e482022-01-26 11:32:49 -08001304 module_state->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001305
1306 uint32_t thread_count = x * y * z;
1307
1308 // Generate a priori warnings about work group sizes.
1309 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1310 skip |= LogPerformanceWarning(
1311 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1312 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1313 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1314 "groups with less than %u threads, especially when using barrier() or shared memory.",
1315 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1316 }
1317
1318 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1319 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1320 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1321 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1322 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1323 "%u, %u) is not aligned to %u "
1324 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1325 "leave threads idle on the shader "
1326 "core.",
1327 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1328 kThreadGroupDispatchCountAlignmentArm);
1329 }
1330
sfricke-samsungef15e482022-01-26 11:32:49 -08001331 auto accessible_ids = module_state->MarkAccessibleIds(entrypoint);
1332 auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001333
1334 unsigned dimensions = 0;
1335 if (x > 1) dimensions++;
1336 if (y > 1) dimensions++;
1337 if (z > 1) dimensions++;
1338 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1339 dimensions = std::max(dimensions, 1u);
1340
1341 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1342 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1343 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1344 bool accesses_2d = false;
1345 for (const auto& usage : descriptor_uses) {
sfricke-samsungef15e482022-01-26 11:32:49 -08001346 auto dim = module_state->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001347 if (dim < 0) continue;
1348 auto spvdim = spv::Dim(dim);
1349 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1350 }
1351
1352 if (accesses_2d && dimensions < 2) {
1353 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1354 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1355 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1356 "exhibiting poor spatial locality with respect to one or more shader resources.",
1357 VendorSpecificTag(kBPVendorArm), x, y, z);
1358 }
1359
Camden5b184be2019-08-13 07:50:19 -06001360 return skip;
1361}
1362
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001363bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001364 bool skip = false;
1365
1366 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001367 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1368 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001369 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001370 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1371 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001372 }
1373
1374 return skip;
1375}
1376
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001377bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1378 bool skip = false;
1379
1380 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1381 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1382 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1383 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1384 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1385 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1386 }
1387
1388 return skip;
1389}
1390
1391bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1392 bool skip = false;
1393 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1394
1395 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1396 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1397
1398 return skip;
1399}
1400
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001401void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001402 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1403 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1404 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1405 LogPerformanceWarning(
1406 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1407 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1408 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1409 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1410 "convenient opportunity.",
1411 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1412 }
1413 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001414
1415 // AMD best practice
1416 // end-of-frame cleanup
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001417 num_queue_submissions_ = 0;
1418 num_barriers_objects_ = 0;
1419 ClearPipelinesUsedInFrame();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001420}
1421
Jeff Bolz5c801d12019-10-09 10:38:45 -05001422bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1423 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001424 bool skip = false;
1425
1426 for (uint32_t submit = 0; submit < submitCount; submit++) {
1427 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1428 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1429 }
ziga-lunargc77f0c02022-04-18 00:15:16 +02001430 if (pSubmits[submit].signalSemaphoreCount == 0 && pSubmits[submit].pSignalSemaphores != nullptr) {
1431 skip |=
1432 LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1433 "pSubmits[%" PRIu32 "].pSignalSemaphores is set, but pSubmits[%" PRIu32 "].signalSemaphoreCount is 0.",
1434 submit, submit);
1435 }
1436 if (pSubmits[submit].waitSemaphoreCount == 0 && pSubmits[submit].pWaitSemaphores != nullptr) {
1437 skip |= LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1438 "pSubmits[%" PRIu32 "].pWaitSemaphores is set, but pSubmits[%" PRIu32 "].waitSemaphoreCount is 0.",
1439 submit, submit);
1440 }
Camden5b184be2019-08-13 07:50:19 -06001441 }
1442
1443 return skip;
1444}
1445
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001446bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1447 VkFence fence) const {
1448 bool skip = false;
1449
1450 for (uint32_t submit = 0; submit < submitCount; submit++) {
1451 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1452 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1453 }
1454 }
1455
1456 return skip;
1457}
1458
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001459bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits,
1460 VkFence fence) const {
1461 bool skip = false;
1462
1463 for (uint32_t submit = 0; submit < submitCount; submit++) {
1464 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1465 skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1466 }
1467 }
1468
1469 return skip;
1470}
1471
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001472bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1473 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1474 bool skip = false;
1475
1476 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1477 skip |= LogPerformanceWarning(
1478 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1479 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1480 "pool instead.");
1481 }
1482
1483 return skip;
1484}
1485
Rodrigo Locattic789fe82022-07-06 17:42:19 -03001486void BestPractices::PreCallRecordBeginCommandBuffer(VkCommandBuffer commandBuffer,
1487 const VkCommandBufferBeginInfo* pBeginInfo) {
1488 StateTracker::PreCallRecordBeginCommandBuffer(commandBuffer, pBeginInfo);
1489
1490 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
paul-lunarg093c1762022-08-23 18:52:10 +02001491 if (!cb) return;
Rodrigo Locattic789fe82022-07-06 17:42:19 -03001492
1493 cb->num_submits = 0;
1494 cb->is_one_time_submit = (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) != 0;
1495}
1496
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001497bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1498 const VkCommandBufferBeginInfo* pBeginInfo) const {
1499 bool skip = false;
1500
1501 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1502 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1503 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1504 }
1505
Rodrigo Locattic789fe82022-07-06 17:42:19 -03001506 if (VendorCheckEnabled(kBPVendorArm)) {
Rodrigo Locattife5172b2022-03-22 18:49:29 -03001507 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT)) {
1508 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Rodrigo Locattic789fe82022-07-06 17:42:19 -03001509 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1510 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1511 VendorSpecificTag(kBPVendorArm));
1512 }
1513 }
1514 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1515 auto cb = GetRead<bp_state::CommandBuffer>(commandBuffer);
1516 if (cb->num_submits == 1 && !cb->is_one_time_submit) {
1517 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
1518 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT was not set "
1519 "and the command buffer has only been submitted once. "
1520 "For best performance on NVIDIA GPUs, use ONE_TIME_SUBMIT.",
1521 VendorSpecificTag(kBPVendorNVIDIA));
Rodrigo Locattife5172b2022-03-22 18:49:29 -03001522 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001523 }
1524
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001525 return skip;
1526}
1527
Jeff Bolz5c801d12019-10-09 10:38:45 -05001528bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001529 bool skip = false;
1530
1531 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1532
1533 return skip;
1534}
1535
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001536bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1537 const VkDependencyInfoKHR* pDependencyInfo) const {
1538 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1539}
1540
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001541bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1542 const VkDependencyInfo* pDependencyInfo) const {
1543 return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo);
1544}
1545
Jeff Bolz5c801d12019-10-09 10:38:45 -05001546bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1547 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001548 bool skip = false;
1549
1550 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1551
1552 return skip;
1553}
1554
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001555bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1556 VkPipelineStageFlags2KHR stageMask) const {
1557 bool skip = false;
1558
1559 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1560
1561 return skip;
1562}
1563
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001564bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1565 VkPipelineStageFlags2 stageMask) const {
1566 bool skip = false;
1567
1568 skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask);
1569
1570 return skip;
1571}
1572
Camden5b184be2019-08-13 07:50:19 -06001573bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1574 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1575 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1576 uint32_t bufferMemoryBarrierCount,
1577 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1578 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001579 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001580 bool skip = false;
1581
1582 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1583 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1584
1585 return skip;
1586}
1587
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001588bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1589 const VkDependencyInfoKHR* pDependencyInfos) const {
1590 bool skip = false;
1591 for (uint32_t i = 0; i < eventCount; i++) {
1592 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1593 }
1594
1595 return skip;
1596}
1597
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001598bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1599 const VkDependencyInfo* pDependencyInfos) const {
1600 bool skip = false;
1601 for (uint32_t i = 0; i < eventCount; i++) {
1602 skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]);
1603 }
1604
1605 return skip;
1606}
1607
Camden5b184be2019-08-13 07:50:19 -06001608bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1609 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1610 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1611 uint32_t bufferMemoryBarrierCount,
1612 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1613 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001614 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001615 bool skip = false;
1616
1617 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1618 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1619
ziga-lunargb65dbfb2022-03-19 18:45:09 +01001620 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1621 if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED &&
1622 IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) {
1623 skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly,
1624 "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents "
1625 "may be discarded, but the newLayout is %s, which is read only.",
1626 string_VkImageLayout(pImageMemoryBarriers[i].newLayout));
1627 }
1628 }
1629
Nadav Gevaf0808442021-05-21 13:51:25 -04001630 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001631 auto num = num_barriers_objects_.load();
1632 if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001633 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001634 "%s Performance warning: In this frame, %" PRIu32
1635 " barriers were already submitted. Barriers have a high cost and can "
1636 "stall the GPU. "
1637 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1638 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04001639 }
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001640 }
1641 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
1642 static constexpr std::array<VkImageLayout, 3> read_layouts = {
Nadav Gevaf0808442021-05-21 13:51:25 -04001643 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1644 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1645 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1646 };
1647
1648 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1649 // read to read barriers
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001650 const auto &image_barrier = pImageMemoryBarriers[i];
1651 bool old_is_read_layout = std::find(read_layouts.begin(), read_layouts.end(), image_barrier.oldLayout) != read_layouts.end();
1652 bool new_is_read_layout = std::find(read_layouts.begin(), read_layouts.end(), image_barrier.newLayout) != read_layouts.end();
1653
Nadav Gevaf0808442021-05-21 13:51:25 -04001654 if (old_is_read_layout && new_is_read_layout) {
1655 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001656 "%s %s Performance warning: Don't issue read-to-read barriers. "
1657 "Get the resource in the right state the first time you use it.",
1658 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04001659 }
1660
1661 // general with no storage
Rodrigo Locatti494e4482022-03-30 16:37:40 -03001662 if (VendorCheckEnabled(kBPVendorAMD) && image_barrier.newLayout == VK_IMAGE_LAYOUT_GENERAL) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001663 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1664 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1665 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1666 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1667 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1668 VendorSpecificTag(kBPVendorAMD));
1669 }
1670 }
1671 }
1672 }
1673
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001674 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1675 skip |= ValidateCmdPipelineBarrierImageBarrier(commandBuffer, pImageMemoryBarriers[i]);
1676 }
1677
Camden5b184be2019-08-13 07:50:19 -06001678 return skip;
1679}
1680
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001681bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1682 const VkDependencyInfoKHR* pDependencyInfo) const {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001683 bool skip = false;
1684
1685 skip |= CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1686
1687 for (uint32_t i = 0; i < pDependencyInfo->imageMemoryBarrierCount; ++i) {
1688 skip |= ValidateCmdPipelineBarrierImageBarrier(commandBuffer, pDependencyInfo->pImageMemoryBarriers[i]);
1689 }
1690
1691 return skip;
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001692}
1693
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001694bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer,
1695 const VkDependencyInfo* pDependencyInfo) const {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001696 bool skip = false;
1697
1698 skip |= CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo);
1699
1700 for (uint32_t i = 0; i < pDependencyInfo->imageMemoryBarrierCount; ++i) {
1701 skip |= ValidateCmdPipelineBarrierImageBarrier(commandBuffer, pDependencyInfo->pImageMemoryBarriers[i]);
1702 }
1703
1704 return skip;
1705}
1706
1707template <typename ImageMemoryBarrier>
1708bool BestPractices::ValidateCmdPipelineBarrierImageBarrier(VkCommandBuffer commandBuffer,
1709 const ImageMemoryBarrier& barrier) const {
1710
1711 bool skip = false;
1712
Mark Young0a6b48f2022-08-18 11:17:02 -06001713 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
1714 assert(cmd_state);
1715
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001716 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1717 if (barrier.oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && barrier.newLayout != VK_IMAGE_LAYOUT_UNDEFINED) {
Mark Young0a6b48f2022-08-18 11:17:02 -06001718 skip |= ValidateZcull(*cmd_state, barrier.image, barrier.subresourceRange);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001719 }
1720 }
1721
1722 return skip;
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001723}
1724
Camden5b184be2019-08-13 07:50:19 -06001725bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001726 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001727 bool skip = false;
1728
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001729 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1730
1731 return skip;
1732}
1733
1734bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1735 VkQueryPool queryPool, uint32_t query) const {
1736 bool skip = false;
1737
1738 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001739
1740 return skip;
1741}
1742
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001743bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage,
1744 VkQueryPool queryPool, uint32_t query) const {
1745 bool skip = false;
1746
1747 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage);
1748
1749 return skip;
1750}
1751
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03001752void BestPractices::PreCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1753 VkPipeline pipeline) {
1754 StateTracker::PreCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1755
1756 auto pipeline_info = Get<PIPELINE_STATE>(pipeline);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001757 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03001758
1759 assert(pipeline_info);
1760 assert(cb);
1761
1762 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS && VendorCheckEnabled(kBPVendorNVIDIA)) {
1763 using TessGeometryMeshState = bp_state::CommandBufferStateNV::TessGeometryMesh::State;
1764 auto& tgm = cb->nv.tess_geometry_mesh;
1765
1766 // Make sure the message is only signaled once per command buffer
1767 tgm.threshold_signaled = tgm.num_switches >= kNumBindPipelineTessGeometryMeshSwitchesThresholdNVIDIA;
1768
1769 // Track pipeline switches with tessellation, geometry, and/or mesh shaders enabled, and disabled
1770 auto tgm_stages = VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT | VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT |
1771 VK_SHADER_STAGE_GEOMETRY_BIT | VK_SHADER_STAGE_TASK_BIT_NV | VK_SHADER_STAGE_MESH_BIT_NV;
1772 auto new_tgm_state = (pipeline_info->active_shaders & tgm_stages) != 0
1773 ? TessGeometryMeshState::Enabled
1774 : TessGeometryMeshState::Disabled;
1775 if (tgm.state != new_tgm_state && tgm.state != TessGeometryMeshState::Unknown) {
1776 tgm.num_switches++;
1777 }
1778 tgm.state = new_tgm_state;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001779
1780 // Track depthTestEnable and depthCompareOp
1781 auto &pipeline_create_info = pipeline_info->GetCreateInfo<VkGraphicsPipelineCreateInfo>();
1782 auto depth_stencil_state = pipeline_create_info.pDepthStencilState;
1783 auto dynamic_state = pipeline_create_info.pDynamicState;
1784 if (depth_stencil_state && dynamic_state) {
1785 auto dynamic_state_begin = dynamic_state->pDynamicStates;
1786 auto dynamic_state_end = dynamic_state->pDynamicStates + dynamic_state->dynamicStateCount;
1787
1788 bool dynamic_depth_test_enable = std::find(dynamic_state_begin, dynamic_state_end, VK_DYNAMIC_STATE_DEPTH_TEST_ENABLE) != dynamic_state_end;
1789 bool dynamic_depth_func = std::find(dynamic_state_begin, dynamic_state_end, VK_DYNAMIC_STATE_DEPTH_COMPARE_OP) != dynamic_state_end;
1790
1791 if (!dynamic_depth_test_enable) {
1792 RecordSetDepthTestState(*cb, cb->nv.depth_compare_op, depth_stencil_state->depthTestEnable != VK_FALSE);
1793 }
1794 if (!dynamic_depth_func) {
1795 RecordSetDepthTestState(*cb, depth_stencil_state->depthCompareOp, cb->nv.depth_test_enable);
1796 }
1797 }
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03001798 }
1799}
1800
Sam Walls0961ec02020-03-31 16:39:15 +01001801void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1802 VkPipeline pipeline) {
1803 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1804
Nadav Gevaf0808442021-05-21 13:51:25 -04001805 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001806 PipelineUsedInFrame(pipeline);
Nadav Gevaf0808442021-05-21 13:51:25 -04001807
Sam Walls0961ec02020-03-31 16:39:15 +01001808 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001809 auto pipeline_state = Get<bp_state::Pipeline>(pipeline);
Sam Walls0961ec02020-03-31 16:39:15 +01001810 // check for depth/blend state tracking
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001811 if (pipeline_state) {
1812 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001813 assert(cb_node);
1814 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001815
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001816 render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments;
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001817 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001818
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07001819 const auto* blend_state = pipeline_state->ColorBlendState();
1820 const auto* stencil_state = pipeline_state->DepthStencilState();
Sam Walls0961ec02020-03-31 16:39:15 +01001821
1822 if (blend_state) {
1823 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001824 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001825 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1826 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001827 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001828 }
1829 }
1830 }
1831
1832 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001833 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001834
1835 if (stencil_state && stencil_state->depthTestEnable) {
1836 switch (stencil_state->depthCompareOp) {
1837 case VK_COMPARE_OP_EQUAL:
1838 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1839 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001840 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001841 break;
1842 default:
1843 break;
1844 }
1845 }
Sam Walls0961ec02020-03-31 16:39:15 +01001846 }
1847 }
1848}
1849
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001850void BestPractices::PreCallRecordCmdSetDepthCompareOp(VkCommandBuffer commandBuffer, VkCompareOp depthCompareOp) {
1851 StateTracker::PreCallRecordCmdSetDepthCompareOp(commandBuffer, depthCompareOp);
1852
1853 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1854 assert(cb);
1855
1856 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1857 RecordSetDepthTestState(*cb, depthCompareOp, cb->nv.depth_test_enable);
1858 }
1859}
1860
1861void BestPractices::PreCallRecordCmdSetDepthCompareOpEXT(VkCommandBuffer commandBuffer, VkCompareOp depthCompareOp) {
1862 StateTracker::PreCallRecordCmdSetDepthCompareOpEXT(commandBuffer, depthCompareOp);
1863
1864 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1865 assert(cb);
1866
1867 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1868 RecordSetDepthTestState(*cb, depthCompareOp, cb->nv.depth_test_enable);
1869 }
1870}
1871
1872void BestPractices::PreCallRecordCmdSetDepthTestEnable(VkCommandBuffer commandBuffer, VkBool32 depthTestEnable) {
1873 StateTracker::PreCallRecordCmdSetDepthTestEnable(commandBuffer, depthTestEnable);
1874
1875 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1876 assert(cb);
1877
1878 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1879 RecordSetDepthTestState(*cb, cb->nv.depth_compare_op, depthTestEnable != VK_FALSE);
1880 }
1881}
1882
1883void BestPractices::PreCallRecordCmdSetDepthTestEnableEXT(VkCommandBuffer commandBuffer, VkBool32 depthTestEnable) {
1884 StateTracker::PreCallRecordCmdSetDepthTestEnableEXT(commandBuffer, depthTestEnable);
1885
1886 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1887 assert(cb);
1888
1889 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1890 RecordSetDepthTestState(*cb, cb->nv.depth_compare_op, depthTestEnable != VK_FALSE);
1891 }
1892}
1893
1894void BestPractices::RecordSetDepthTestState(bp_state::CommandBuffer& cmd_state, VkCompareOp new_depth_compare_op, bool new_depth_test_enable) {
1895 assert(VendorCheckEnabled(kBPVendorNVIDIA));
1896
1897 if (cmd_state.nv.depth_compare_op != new_depth_compare_op) {
1898 switch (new_depth_compare_op) {
1899 case VK_COMPARE_OP_LESS:
1900 case VK_COMPARE_OP_LESS_OR_EQUAL:
1901 cmd_state.nv.zcull_direction = bp_state::CommandBufferStateNV::ZcullDirection::Less;
1902 break;
1903 case VK_COMPARE_OP_GREATER:
1904 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1905 cmd_state.nv.zcull_direction = bp_state::CommandBufferStateNV::ZcullDirection::Greater;
1906 break;
1907 default:
1908 // The other ops carry over the previous state.
1909 break;
1910 }
1911 }
1912 cmd_state.nv.depth_compare_op = new_depth_compare_op;
1913 cmd_state.nv.depth_test_enable = new_depth_test_enable;
1914}
1915
1916void BestPractices::RecordCmdBeginRenderingCommon(VkCommandBuffer commandBuffer) {
1917 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1918 assert(cmd_state);
1919
1920 auto rp = cmd_state->activeRenderPass.get();
1921 assert(rp);
1922
1923 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1924 std::shared_ptr<IMAGE_VIEW_STATE> depth_image_view_shared_ptr;
1925 IMAGE_VIEW_STATE* depth_image_view = nullptr;
1926 layer_data::optional<VkAttachmentLoadOp> load_op;
1927
1928 if (rp->use_dynamic_rendering || rp->use_dynamic_rendering_inherited) {
1929 const auto depth_attachment = rp->dynamic_rendering_begin_rendering_info.pDepthAttachment;
1930 if (depth_attachment) {
1931 load_op.emplace(depth_attachment->loadOp);
1932 depth_image_view_shared_ptr = Get<IMAGE_VIEW_STATE>(depth_attachment->imageView);
1933 depth_image_view = depth_image_view_shared_ptr.get();
1934 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03001935
1936 for (uint32_t i = 0; i < rp->dynamic_rendering_begin_rendering_info.colorAttachmentCount; ++i) {
1937 const auto& color_attachment = rp->dynamic_rendering_begin_rendering_info.pColorAttachments[i];
1938 if (color_attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1939 const VkFormat format = Get<IMAGE_VIEW_STATE>(color_attachment.imageView)->create_info.format;
1940 RecordClearColor(format, color_attachment.clearValue.color);
1941 }
1942 }
1943
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001944 } else {
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03001945 if (rp->createInfo.pAttachments) {
1946 if (rp->createInfo.subpassCount > 0) {
1947 const auto depth_attachment = rp->createInfo.pSubpasses[0].pDepthStencilAttachment;
1948 if (depth_attachment) {
1949 const uint32_t attachment_index = depth_attachment->attachment;
1950 if (attachment_index != VK_ATTACHMENT_UNUSED) {
1951 load_op.emplace(rp->createInfo.pAttachments[attachment_index].loadOp);
1952 depth_image_view = (*cmd_state->active_attachments)[attachment_index];
1953 }
1954 }
1955 }
1956 for (uint32_t i = 0; i < cmd_state->activeRenderPassBeginInfo.clearValueCount; ++i) {
1957 const auto& attachment = rp->createInfo.pAttachments[i];
1958 if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1959 const auto& clear_color = cmd_state->activeRenderPassBeginInfo.pClearValues[i].color;
1960 RecordClearColor(attachment.format, clear_color);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03001961 }
1962 }
1963 }
1964 }
1965 if (depth_image_view && (depth_image_view->create_info.subresourceRange.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0U) {
1966 const VkImage depth_image = depth_image_view->image_state->image();
1967 const VkImageSubresourceRange& subresource_range = depth_image_view->create_info.subresourceRange;
1968 RecordBindZcullScope(*cmd_state, depth_image, subresource_range);
1969 } else {
1970 RecordUnbindZcullScope(*cmd_state);
1971 }
1972 if (load_op) {
1973 if (*load_op == VK_ATTACHMENT_LOAD_OP_CLEAR || *load_op == VK_ATTACHMENT_LOAD_OP_DONT_CARE) {
1974 RecordResetScopeZcullDirection(*cmd_state);
1975 }
1976 }
1977 }
1978}
1979
1980void BestPractices::RecordCmdEndRenderingCommon(VkCommandBuffer commandBuffer) {
1981 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1982 assert(cmd_state);
1983
1984 auto rp = cmd_state->activeRenderPass.get();
1985 assert(rp);
1986
1987 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
1988 layer_data::optional<VkAttachmentStoreOp> store_op;
1989
1990 if (rp->use_dynamic_rendering || rp->use_dynamic_rendering_inherited) {
1991 const auto depth_attachment = rp->dynamic_rendering_begin_rendering_info.pDepthAttachment;
1992 if (depth_attachment) {
1993 store_op.emplace(depth_attachment->storeOp);
1994 }
1995 } else {
1996 if (rp->createInfo.subpassCount > 0) {
1997 const uint32_t last_subpass = rp->createInfo.subpassCount - 1;
1998 const auto depth_attachment = rp->createInfo.pSubpasses[last_subpass].pDepthStencilAttachment;
1999 if (depth_attachment) {
2000 const uint32_t attachment = depth_attachment->attachment;
2001 if (attachment != VK_ATTACHMENT_UNUSED) {
2002 store_op.emplace(rp->createInfo.pAttachments[attachment].storeOp);
2003 }
2004 }
2005 }
2006 }
2007
2008 if (store_op) {
2009 if (*store_op == VK_ATTACHMENT_STORE_OP_DONT_CARE || *store_op == VK_ATTACHMENT_STORE_OP_NONE) {
2010 RecordResetScopeZcullDirection(*cmd_state);
2011 }
2012 }
2013
2014 RecordUnbindZcullScope(*cmd_state);
2015 }
2016}
2017
2018void BestPractices::RecordBindZcullScope(bp_state::CommandBuffer& cmd_state, VkImage depth_attachment, const VkImageSubresourceRange& subresource_range) {
2019 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2020
2021 if (depth_attachment == VK_NULL_HANDLE) {
2022 cmd_state.nv.zcull_scope = {};
2023 return;
2024 }
2025
2026 assert((subresource_range.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0U);
2027
2028 auto image_state = Get<IMAGE_STATE>(depth_attachment);
2029 assert(image_state);
2030
2031 const uint32_t mip_levels = image_state->createInfo.mipLevels;
2032 const uint32_t array_layers = image_state->createInfo.arrayLayers;
2033
2034 auto& tree = cmd_state.nv.zcull_per_image[depth_attachment];
2035 if (tree.states.empty()) {
2036 tree.mip_levels = mip_levels;
2037 tree.array_layers = array_layers;
2038 tree.states.resize(array_layers * mip_levels);
2039 }
2040
2041 cmd_state.nv.zcull_scope.image = depth_attachment;
2042 cmd_state.nv.zcull_scope.range = subresource_range;
2043 cmd_state.nv.zcull_scope.tree = &tree;
2044}
2045
2046void BestPractices::RecordUnbindZcullScope(bp_state::CommandBuffer& cmd_state) {
2047 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2048
2049 RecordBindZcullScope(cmd_state, VK_NULL_HANDLE, VkImageSubresourceRange{});
2050}
2051
2052void BestPractices::RecordResetScopeZcullDirection(bp_state::CommandBuffer& cmd_state) {
2053 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2054
2055 auto& scope = cmd_state.nv.zcull_scope;
2056 RecordResetZcullDirection(cmd_state, scope.image, scope.range);
2057}
2058
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002059template <typename Func>
2060static void ForEachSubresource(const IMAGE_STATE& image, const VkImageSubresourceRange& range, Func&& func)
2061{
paul-lunarg0ec95562022-09-08 16:02:53 +02002062 const uint32_t layerCount =
2063 (range.layerCount == VK_REMAINING_ARRAY_LAYERS) ? (image.full_range.layerCount - range.baseArrayLayer) : range.layerCount;
2064 const uint32_t levelCount =
2065 (range.levelCount == VK_REMAINING_MIP_LEVELS) ? (image.full_range.levelCount - range.baseMipLevel) : range.levelCount;
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002066
2067 for (uint32_t i = 0; i < layerCount; ++i) {
2068 const uint32_t layer = range.baseArrayLayer + i;
2069 for (uint32_t j = 0; j < levelCount; ++j) {
2070 const uint32_t level = range.baseMipLevel + j;
2071 func(layer, level);
2072 }
2073 }
2074}
2075
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002076void BestPractices::RecordResetZcullDirection(bp_state::CommandBuffer& cmd_state, VkImage depth_image,
2077 const VkImageSubresourceRange& subresource_range) {
2078 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2079
2080 RecordSetZcullDirection(cmd_state, depth_image, subresource_range, bp_state::CommandBufferStateNV::ZcullDirection::Unknown);
2081
2082 const auto image_it = cmd_state.nv.zcull_per_image.find(depth_image);
2083 if (image_it == cmd_state.nv.zcull_per_image.end()) {
2084 return;
2085 }
2086 auto& tree = image_it->second;
2087
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002088 auto image = Get<IMAGE_STATE>(depth_image);
2089 if (!image) return;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002090
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002091 ForEachSubresource(*image, subresource_range, [&tree](uint32_t layer, uint32_t level) {
2092 auto& subresource = tree.GetState(layer, level);
2093 subresource.num_less_draws = 0;
2094 subresource.num_greater_draws = 0;
2095 });
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002096}
2097
2098void BestPractices::RecordSetScopeZcullDirection(bp_state::CommandBuffer& cmd_state, bp_state::CommandBufferStateNV::ZcullDirection mode) {
2099 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2100
2101 auto& scope = cmd_state.nv.zcull_scope;
2102 RecordSetZcullDirection(cmd_state, scope.image, scope.range, mode);
2103}
2104
2105void BestPractices::RecordSetZcullDirection(bp_state::CommandBuffer& cmd_state, VkImage depth_image,
2106 const VkImageSubresourceRange& subresource_range,
2107 bp_state::CommandBufferStateNV::ZcullDirection mode) {
2108 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2109
2110 const auto image_it = cmd_state.nv.zcull_per_image.find(depth_image);
2111 if (image_it == cmd_state.nv.zcull_per_image.end()) {
2112 return;
2113 }
2114 auto& tree = image_it->second;
2115
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002116 auto image = Get<IMAGE_STATE>(depth_image);
2117 if (!image) return;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002118
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002119 ForEachSubresource(*image, subresource_range, [&tree, &cmd_state](uint32_t layer, uint32_t level) {
2120 tree.GetState(layer, level).direction = cmd_state.nv.zcull_direction;
2121 });
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002122}
2123
2124void BestPractices::RecordZcullDraw(bp_state::CommandBuffer& cmd_state) {
2125 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2126
2127 // Add one draw to each subresource depending on the current Z-cull direction
2128 auto& scope = cmd_state.nv.zcull_scope;
2129
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002130 auto image = Get<IMAGE_STATE>(scope.image);
2131 if (!image) return;
2132
2133 ForEachSubresource(*image, scope.range, [&scope](uint32_t layer, uint32_t level) {
2134 auto& subresource = scope.tree->GetState(layer, level);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002135
2136 switch (subresource.direction) {
2137 case bp_state::CommandBufferStateNV::ZcullDirection::Unknown:
2138 // Unreachable
2139 assert(0);
2140 break;
2141 case bp_state::CommandBufferStateNV::ZcullDirection::Less:
2142 ++subresource.num_less_draws;
2143 break;
2144 case bp_state::CommandBufferStateNV::ZcullDirection::Greater:
2145 ++subresource.num_greater_draws;
2146 break;
2147 }
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002148 });
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002149}
2150
Mark Young0a6b48f2022-08-18 11:17:02 -06002151bool BestPractices::ValidateZcullScope(const bp_state::CommandBuffer& cmd_state) const {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002152 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2153
2154 bool skip = false;
2155
Mark Young0a6b48f2022-08-18 11:17:02 -06002156 if (cmd_state.nv.depth_test_enable) {
2157 auto& scope = cmd_state.nv.zcull_scope;
2158 skip |= ValidateZcull(cmd_state, scope.image, scope.range);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002159 }
2160
2161 return skip;
2162}
2163
Mark Young0a6b48f2022-08-18 11:17:02 -06002164bool BestPractices::ValidateZcull(const bp_state::CommandBuffer& cmd_state, VkImage image,
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002165 const VkImageSubresourceRange& subresource_range) const {
2166 bool skip = false;
2167
2168 const char* good_mode = nullptr;
2169 const char* bad_mode = nullptr;
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002170 bool is_balanced = false;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002171
Mark Young0a6b48f2022-08-18 11:17:02 -06002172 const auto image_it = cmd_state.nv.zcull_per_image.find(image);
2173 if (image_it == cmd_state.nv.zcull_per_image.end()) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002174 return skip;
2175 }
2176 const auto& tree = image_it->second;
2177
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002178 auto image_state = Get<IMAGE_STATE>(image);
2179 if (!image_state) {
2180 return skip;
2181 }
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002182
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002183 ForEachSubresource(*image_state, subresource_range, [&](uint32_t layer, uint32_t level) {
2184 if (is_balanced) {
2185 return;
2186 }
2187 const auto& resource = tree.GetState(layer, level);
2188 const uint64_t num_draws = resource.num_less_draws + resource.num_greater_draws;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002189
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002190 if (num_draws == 0) {
2191 return;
2192 }
2193 const uint64_t less_ratio = (resource.num_less_draws * 100) / num_draws;
2194 const uint64_t greater_ratio = (resource.num_greater_draws * 100) / num_draws;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002195
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002196 if ((less_ratio > kZcullDirectionBalanceRatioNVIDIA) && (greater_ratio > kZcullDirectionBalanceRatioNVIDIA)) {
2197 is_balanced = true;
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002198
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002199 if (greater_ratio > less_ratio) {
2200 good_mode = "GREATER";
2201 bad_mode = "LESS";
2202 } else {
2203 good_mode = "LESS";
2204 bad_mode = "GREATER";
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002205 }
2206 }
Rodrigo Locattic94a5cd2022-08-24 18:33:07 -03002207 });
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002208
2209 if (is_balanced) {
2210 skip |= LogPerformanceWarning(
Mark Young0a6b48f2022-08-18 11:17:02 -06002211 cmd_state.commandBuffer(), kVUID_BestPractices_Zcull_LessGreaterRatio,
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002212 "%s Depth attachment %s is primarily rendered with depth compare op %s, but some draws use %s. "
2213 "Z-cull is disabled for the least used direction, which harms depth testing performance. "
2214 "The Z-cull direction can be reset by clearing the depth attachment, transitioning from VK_IMAGE_LAYOUT_UNDEFINED, "
2215 "using VK_ATTACHMENT_LOAD_OP_DONT_CARE, or using VK_ATTACHMENT_STORE_OP_DONT_CARE.",
Mark Young0a6b48f2022-08-18 11:17:02 -06002216 VendorSpecificTag(kBPVendorNVIDIA), report_data->FormatHandle(cmd_state.nv.zcull_scope.image).c_str(), good_mode,
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002217 bad_mode);
2218 }
2219
2220 return skip;
2221}
2222
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03002223static std::array<uint32_t, 4> GetRawClearColor(VkFormat format, const VkClearColorValue& clear_value) {
2224 std::array<uint32_t, 4> raw_color{};
2225 std::copy_n(clear_value.uint32, raw_color.size(), raw_color.data());
2226
2227 // Zero out unused components to avoid polluting the cache with garbage
2228 if (!FormatHasRed(format)) raw_color[0] = 0;
2229 if (!FormatHasGreen(format)) raw_color[1] = 0;
2230 if (!FormatHasBlue(format)) raw_color[2] = 0;
2231 if (!FormatHasAlpha(format)) raw_color[3] = 0;
2232
2233 return raw_color;
2234}
2235
2236static bool IsClearColorZeroOrOne(VkFormat format, const std::array<uint32_t, 4> clear_color) {
2237 static_assert(sizeof(float) == sizeof(uint32_t), "Mismatching float <-> uint32 sizes");
2238 const float one = 1.0f;
2239 const float zero = 0.0f;
2240 uint32_t raw_one{};
2241 uint32_t raw_zero{};
2242 memcpy(&raw_one, &one, sizeof(one));
2243 memcpy(&raw_zero, &zero, sizeof(zero));
2244
2245 const bool is_one = (!FormatHasRed(format) || (clear_color[0] == raw_one)) &&
2246 (!FormatHasGreen(format) || (clear_color[1] == raw_one)) &&
2247 (!FormatHasBlue(format) || (clear_color[2] == raw_one)) &&
2248 (!FormatHasAlpha(format) || (clear_color[3] == raw_one));
2249 const bool is_zero = (!FormatHasRed(format) || (clear_color[0] == raw_zero)) &&
2250 (!FormatHasGreen(format) || (clear_color[1] == raw_zero)) &&
2251 (!FormatHasBlue(format) || (clear_color[2] == raw_zero)) &&
2252 (!FormatHasAlpha(format) || (clear_color[3] == raw_zero));
2253 return is_one || is_zero;
2254}
2255
2256static std::string MakeCompressedFormatListNVIDIA() {
2257 std::string format_list;
2258 for (VkFormat compressed_format : kCustomClearColorCompressedFormatsNVIDIA) {
2259 if (compressed_format == kCustomClearColorCompressedFormatsNVIDIA.back()) {
2260 format_list += "or ";
2261 }
2262 format_list += string_VkFormat(compressed_format);
2263 if (compressed_format != kCustomClearColorCompressedFormatsNVIDIA.back()) {
2264 format_list += ", ";
2265 }
2266 }
2267 return format_list;
2268}
2269
2270void BestPractices::RecordClearColor(VkFormat format, const VkClearColorValue& clear_value) {
2271 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2272
2273 const std::array<uint32_t, 4> raw_color = GetRawClearColor(format, clear_value);
2274 if (IsClearColorZeroOrOne(format, raw_color)) {
2275 // These colors are always compressed
2276 return;
2277 }
2278
2279 const auto it = std::find(kCustomClearColorCompressedFormatsNVIDIA.begin(), kCustomClearColorCompressedFormatsNVIDIA.end(), format);
2280 if (it == kCustomClearColorCompressedFormatsNVIDIA.end()) {
2281 // The format cannot be compressed with a custom color
2282 return;
2283 }
2284
2285 // Record custom clear color
2286 WriteLockGuard guard{clear_colors_lock_};
2287 if (clear_colors_.size() < kMaxRecommendedNumberOfClearColorsNVIDIA) {
2288 clear_colors_.insert(raw_color);
2289 }
2290}
2291
2292bool BestPractices::ValidateClearColor(VkCommandBuffer commandBuffer, VkFormat format, const VkClearColorValue& clear_value) const {
2293 assert(VendorCheckEnabled(kBPVendorNVIDIA));
2294
2295 bool skip = false;
2296
2297 const std::array<uint32_t, 4> raw_color = GetRawClearColor(format, clear_value);
2298 if (IsClearColorZeroOrOne(format, raw_color)) {
2299 return skip;
2300 }
2301
2302 const auto it = std::find(kCustomClearColorCompressedFormatsNVIDIA.begin(), kCustomClearColorCompressedFormatsNVIDIA.end(), format);
2303 if (it == kCustomClearColorCompressedFormatsNVIDIA.end()) {
2304 // The format is not compressible
2305 static const std::string format_list = MakeCompressedFormatListNVIDIA();
2306
2307 skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_ClearColor_NotCompressed,
2308 "%s Clearing image with format %s without a 1.0f or 0.0f clear color. "
2309 "The clear will not get compressed in the GPU, harming performance. "
2310 "This can be fixed using a clear color of VkClearColorValue{0.0f, 0.0f, 0.0f, 0.0f}, or "
2311 "VkClearColorValue{1.0f, 1.0f, 1.0f, 1.0f}. Alternatively, use %s.",
2312 VendorSpecificTag(kBPVendorNVIDIA), string_VkFormat(format), format_list.c_str());
2313 } else {
2314 // The format is compressible
2315 bool registered = false;
2316 {
2317 ReadLockGuard guard{clear_colors_lock_};
2318 registered = clear_colors_.find(raw_color) != clear_colors_.end();
2319
2320 if (!registered) {
2321 // If it's not in the list, it might be new. Check if there's still space for new entries.
2322 registered = clear_colors_.size() < kMaxRecommendedNumberOfClearColorsNVIDIA;
2323 }
2324 }
2325 if (!registered) {
2326 std::string clear_color_str;
2327
2328 if (FormatIsUINT(format)) {
2329 clear_color_str = std::to_string(clear_value.uint32[0]) + ", " + std::to_string(clear_value.uint32[1]) + ", " +
2330 std::to_string(clear_value.uint32[2]) + ", " + std::to_string(clear_value.uint32[3]);
2331 } else if (FormatIsSINT(format)) {
2332 clear_color_str = std::to_string(clear_value.int32[0]) + ", " + std::to_string(clear_value.int32[1]) + ", " +
2333 std::to_string(clear_value.int32[2]) + ", " + std::to_string(clear_value.int32[3]);
2334 } else {
2335 clear_color_str = std::to_string(clear_value.float32[0]) + ", " + std::to_string(clear_value.float32[1]) + ", " +
2336 std::to_string(clear_value.float32[2]) + ", " + std::to_string(clear_value.float32[3]);
2337 }
2338
2339 skip |= LogPerformanceWarning(
2340 commandBuffer, kVUID_BestPractices_ClearColor_NotCompressed,
2341 "%s Clearing image with unregistered VkClearColorValue{%s}. "
2342 "This clear will not get compressed in the GPU, harming performance. "
2343 "The clear color is not registered because too many unique colors have been used. "
2344 "Select a discrete set of clear colors and stick to those. "
2345 "VkClearColorValue{0, 0, 0, 0} and VkClearColorValue{1.0f, 1.0f, 1.0f, 1.0f} are always registered.",
2346 VendorSpecificTag(kBPVendorNVIDIA), clear_color_str.c_str());
2347 }
2348 }
2349
2350 return skip;
2351}
2352
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002353static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
2354 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
2355 const auto& subpass_info = createInfo.pSubpasses[subpass];
2356 if (subpass_info.pResolveAttachments) {
2357 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
2358 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
2359 }
2360 }
2361 }
2362
2363 return false;
2364}
2365
Attilio Provenzano02859b22020-02-27 14:17:28 +00002366static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
2367 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002368 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00002369
2370 // If an attachment is ever used as a color attachment,
2371 // resolve attachment or depth stencil attachment,
2372 // it needs to exist on tile at some point.
2373
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002374 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
2375 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00002376 }
2377
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002378 if (subpass_info.pResolveAttachments) {
2379 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
2380 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
2381 }
2382 }
2383
2384 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00002385 }
2386
2387 return false;
2388}
2389
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002390static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
2391 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
2392 return false;
2393 }
2394
2395 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002396 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002397
2398 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
2399 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
2400 return true;
2401 }
2402 }
2403 }
2404
2405 return false;
2406}
2407
Attilio Provenzano02859b22020-02-27 14:17:28 +00002408bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
2409 const VkRenderPassBeginInfo* pRenderPassBegin) const {
2410 bool skip = false;
2411
2412 if (!pRenderPassBegin) {
2413 return skip;
2414 }
2415
Gareth Webbdc6549a2021-06-16 03:52:24 +01002416 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
2417 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
2418 "This render pass has a zero-size render area. It cannot write to any attachments, "
2419 "and can only be used for side effects such as layout transitions.");
2420 }
2421
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002422 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002423 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08002424 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07002425 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06002426 if (rpabi) {
2427 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
2428 }
2429 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00002430 // Check if any attachments have LOAD operation on them
2431 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002432 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00002433
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002434 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02002435 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002436 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00002437 }
2438
2439 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002440 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00002441 }
2442
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002443 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00002444
2445 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002446 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2447 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00002448 }
2449
2450 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
LawG47747b322022-02-23 16:12:10 +00002451 if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
2452 skip |=
2453 LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
LawG4015be1c2022-03-01 10:37:52 +00002454 "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
LawG47747b322022-02-23 16:12:10 +00002455 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04002456 "which will copy in total %u pixels (renderArea = "
LawG47747b322022-02-23 16:12:10 +00002457 "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.",
2458 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att,
2459 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
2460 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
2461 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002462 }
2463 }
paul-lunarg7089e272022-06-20 22:19:37 +02002464
2465 // Check if renderpass has at least one VK_ATTACHMENT_LOAD_OP_CLEAR
2466
2467 bool clearing = false;
2468
2469 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
2470 const auto& attachment = rp_state->createInfo.pAttachments[att];
2471
2472 if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2473 clearing = true;
2474 break;
2475 }
2476 }
2477
2478 // Check if there are ClearValues passed to BeginRenderPass even though no attachments will be cleared
2479 if (!clearing && pRenderPassBegin->clearValueCount > 0) {
2480 // Flag as warning because nothing will happen per spec, and pClearValues will be ignored
2481 skip |= LogWarning(
2482 device, kVUID_BestPractices_ClearValueWithoutLoadOpClear,
2483 "This render pass does not have VkRenderPassCreateInfo.pAttachments->loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR "
2484 "but VkRenderPassBeginInfo.clearValueCount > 0. VkRenderPassBeginInfo.pClearValues will be ignored and no "
paul-lunarga0a149c2022-06-23 16:18:51 +02002485 "attachments will be cleared.");
paul-lunarg7089e272022-06-20 22:19:37 +02002486 }
paul-lunarga0a149c2022-06-23 16:18:51 +02002487
2488 // Check if there are more clearValues than attachments
2489 if(pRenderPassBegin->clearValueCount > rp_state->createInfo.attachmentCount) {
2490 // Flag as warning because the overflowing clearValues will be ignored and could even be undefined on certain platforms.
2491 // This could signal a bug and there seems to be no reason for this to happen on purpose.
2492 skip |= LogWarning(
2493 device, kVUID_BestPractices_ClearValueCountHigherThanAttachmentCount,
2494 "This render pass has VkRenderPassBeginInfo.clearValueCount > VkRenderPassCreateInfo.attachmentCount "
2495 "(%" PRIu32 " > %" PRIu32 ") and as such the clearValues that do not have a corresponding attachment will be ignored.",
2496 pRenderPassBegin->clearValueCount, rp_state->createInfo.attachmentCount);
2497 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03002498
2499 if (VendorCheckEnabled(kBPVendorNVIDIA) && rp_state->createInfo.pAttachments) {
2500 for (uint32_t i = 0; i < pRenderPassBegin->clearValueCount; ++i) {
2501 const auto& attachment = rp_state->createInfo.pAttachments[i];
2502 if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2503 const auto& clear_color = pRenderPassBegin->pClearValues[i].color;
2504 skip |= ValidateClearColor(commandBuffer, attachment.format, clear_color);
2505 }
2506 }
2507 }
2508 }
2509
2510 return skip;
2511}
2512
2513bool BestPractices::ValidateCmdBeginRendering(VkCommandBuffer commandBuffer, const VkRenderingInfo* pRenderingInfo) const {
2514 bool skip = false;
2515
2516 auto cmd_state = Get<bp_state::CommandBuffer>(commandBuffer);
2517 assert(cmd_state);
2518
2519 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
2520 for (uint32_t i = 0; i < pRenderingInfo->colorAttachmentCount; ++i) {
2521 const auto& color_attachment = pRenderingInfo->pColorAttachments[i];
2522 if (color_attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
2523 const VkFormat format = Get<IMAGE_VIEW_STATE>(color_attachment.imageView)->create_info.format;
2524 skip |= ValidateClearColor(commandBuffer, format, color_attachment.clearValue.color);
2525 }
2526 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00002527 }
2528
2529 return skip;
2530}
2531
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002532void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
2533 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002534 if (view) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002535 auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state);
2536 QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002537 }
2538}
2539
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002540void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
2541 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02002542 // If we're viewing a 3D slice, ignore base array layer.
2543 // The entire 3D subresource is accessed as one atomic unit.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002544 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 +02002545
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002546 const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002547 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002548 const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel;
2549 const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002550
2551 for (uint32_t layer = 0; layer < array_layers; layer++) {
2552 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02002553 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
2554 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002555 }
2556 }
2557}
2558
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002559void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
2560 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) {
2561 const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002562 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002563
2564 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002565 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002566 }
2567}
2568
paul-lunarg5eb52062022-06-27 18:57:15 +02002569void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
2570 IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer, uint32_t mip_level) {
paul-lunarg5e5d7402022-09-07 16:23:10 +02002571 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](
2572 const ValidationStateTracker& vst, const QUEUE_STATE& qs, const CMD_BUFFER_STATE& cbs) -> bool {
paul-lunarg670a5622022-09-09 13:48:22 +02002573 ValidateImageInQueue(qs, cbs, function_name, *state, usage, array_layer, mip_level);
paul-lunarg5eb52062022-06-27 18:57:15 +02002574 return false;
2575 });
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002576}
2577
LawG44d414ba2022-02-23 15:35:41 +00002578void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002579 IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002580 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002581 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002582 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 -07002583 !image.IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002584 LogPerformanceWarning(
2585 device, kVUID_BestPractices_RenderPass_RedundantStore,
LawG4015be1c2022-03-01 10:37:52 +00002586 "%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 +02002587 "image was used, it was written to with STORE_OP_STORE. "
2588 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
2589 "architectures.",
LawG44d414ba2022-02-23 15:35:41 +00002590 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002591 } 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 +02002592 LogPerformanceWarning(
2593 device, kVUID_BestPractices_RenderPass_RedundantClear,
LawG4015be1c2022-03-01 10:37:52 +00002594 "%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 +02002595 "image was used, it was written to with vkCmdClear*Image(). "
2596 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
LawG44d414ba2022-02-23 15:35:41 +00002597 "tile-based architectures.",
2598 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01002599 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002600 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
2601 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01002602 const char *last_cmd = nullptr;
2603 const char *vuid = nullptr;
2604 const char *suggestion = nullptr;
2605
2606 switch (last_usage) {
2607 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
2608 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
2609 last_cmd = "vkCmdBlitImage";
2610 suggestion =
2611 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
2612 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
2613 "which avoids the memory roundtrip.";
2614 break;
2615 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
2616 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
2617 last_cmd = "vkCmdClear*Image";
2618 suggestion =
2619 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
2620 "tile-based architectures. "
2621 "Use LOAD_OP_CLEAR instead to clear the image for free.";
2622 break;
2623 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
2624 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
2625 last_cmd = "vkCmdCopy*Image";
2626 suggestion =
2627 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
2628 "Rather than copying, just render the source image in a fragment shader in this render pass, "
2629 "which avoids the memory roundtrip.";
2630 break;
2631 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
2632 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
2633 last_cmd = "vkCmdResolveImage";
2634 suggestion =
2635 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
2636 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
2637 "which avoids the memory roundtrip.";
2638 break;
2639 default:
2640 break;
2641 }
2642
2643 LogPerformanceWarning(
2644 device, vuid,
LawG4015be1c2022-03-01 10:37:52 +00002645 "%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 +01002646 "time image was used, it was written to with %s. %s",
LawG44d414ba2022-02-23 15:35:41 +00002647 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd,
2648 suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002649 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002650}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002651
paul-lunarg670a5622022-09-09 13:48:22 +02002652void BestPractices::ValidateImageInQueue(const QUEUE_STATE& qs, const CMD_BUFFER_STATE& cbs, const char* function_name,
2653 bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer,
2654 uint32_t mip_level) {
2655 auto last_queue_family = state.GetLastQueueFamily(array_layer, mip_level);
2656 auto queue_family = qs.queueFamilyIndex;
2657 auto last_usage = state.UpdateUsage(array_layer, mip_level, usage, queue_family);
2658
2659 // Concurrent sharing usage of image with exclusive sharing mode
2660 if (state.createInfo.sharingMode == VK_SHARING_MODE_EXCLUSIVE && last_queue_family != queue_family) {
2661 // if UNDEFINED then first use/acquisition of subresource
2662 if (last_usage != IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED) {
2663 // If usage might read from the subresource, as contents are undefined
2664 // so write only is fine
2665 if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE || usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ ||
2666 usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ || usage == IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS) {
2667 LogWarning(
2668 state.Handle().Cast<VkImage>(), kVUID_BestPractices_ConcurrentUsageOfExclusiveImage,
2669 "%s : Subresource (arrayLayer: %u, mipLevel: %u) of image is used on queue family index %u after being used on "
2670 "queue family index %u, "
2671 "but has VK_SHARING_MODE_EXCLUSIVE, and has not been acquired and released with a ownership transfer operation",
2672 function_name, array_layer, mip_level, queue_family, last_queue_family);
2673 }
2674 }
2675 }
paul-lunarg5eb52062022-06-27 18:57:15 +02002676
2677 // When image was discarded with StoreOpDontCare but is now being read with LoadOpLoad
2678 if (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED &&
2679 usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE) {
2680 LogWarning(device, kVUID_BestPractices_StoreOpDontCareThenLoadOpLoad,
2681 "Trying to load an attachment with LOAD_OP_LOAD that was previously stored with STORE_OP_DONT_CARE. This may "
2682 "result in undefined behaviour.");
2683 }
2684
LawG44d414ba2022-02-23 15:35:41 +00002685 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
2686 ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002687 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002688}
2689
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002690void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) {
2691 cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(),
2692 cb.queue_submit_functions_after_render_pass.end());
2693 cb.queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002694}
2695
2696void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002697 RecordCmdEndRenderingCommon(commandBuffer);
2698
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002699 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002700 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2701 if (cb_node) {
2702 AddDeferredQueueOperations(*cb_node);
2703 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002704}
2705
2706void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002707 RecordCmdEndRenderingCommon(commandBuffer);
2708
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002709 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002710 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2711 if (cb_node) {
2712 AddDeferredQueueOperations(*cb_node);
2713 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002714}
2715
2716void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002717 RecordCmdEndRenderingCommon(commandBuffer);
2718
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002719 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002720 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2721 if (cb_node) {
2722 AddDeferredQueueOperations(*cb_node);
2723 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002724}
2725
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002726void BestPractices::PreCallRecordCmdEndRendering(VkCommandBuffer commandBuffer) {
2727 RecordCmdEndRenderingCommon(commandBuffer);
2728
2729 ValidationStateTracker::PreCallRecordCmdEndRendering(commandBuffer);
2730}
2731
2732void BestPractices::PreCallRecordCmdEndRenderingKHR(VkCommandBuffer commandBuffer) {
2733 RecordCmdEndRenderingCommon(commandBuffer);
2734
2735 ValidationStateTracker::PreCallRecordCmdEndRenderingKHR(commandBuffer);
2736}
2737
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002738void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
2739 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002740 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002741 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002742 RecordCmdBeginRenderingCommon(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002743 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
2744}
2745
2746void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
2747 const VkRenderPassBeginInfo* pRenderPassBegin,
2748 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2749 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002750 RecordCmdBeginRenderingCommon(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002751 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
2752}
2753
2754void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2755 const VkRenderPassBeginInfo* pRenderPassBegin,
2756 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2757 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002758 RecordCmdBeginRenderingCommon(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002759 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
2760}
2761
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03002762void BestPractices::PreCallRecordCmdBeginRendering(VkCommandBuffer commandBuffer, const VkRenderingInfo* pRenderingInfo) {
2763 ValidationStateTracker::PreCallRecordCmdBeginRendering(commandBuffer, pRenderingInfo);
2764 RecordCmdBeginRenderingCommon(commandBuffer);
2765}
2766
2767void BestPractices::PreCallRecordCmdBeginRenderingKHR(VkCommandBuffer commandBuffer, const VkRenderingInfo* pRenderingInfo) {
2768 ValidationStateTracker::PreCallRecordCmdBeginRenderingKHR(commandBuffer, pRenderingInfo);
2769 RecordCmdBeginRenderingCommon(commandBuffer);
2770}
2771
2772void BestPractices::PostCallRecordCmdNextSubpass(VkCommandBuffer commandBuffer, VkSubpassContents contents) {
2773 ValidationStateTracker::PostCallRecordCmdNextSubpass(commandBuffer, contents);
2774
2775 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2776 auto rp = cmd_state->activeRenderPass.get();
2777 assert(rp);
2778
2779 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
2780 IMAGE_VIEW_STATE* depth_image_view = nullptr;
2781
2782 const auto depth_attachment = rp->createInfo.pSubpasses[cmd_state->activeSubpass].pDepthStencilAttachment;
2783 if (depth_attachment) {
2784 const uint32_t attachment_index = depth_attachment->attachment;
2785 if (attachment_index != VK_ATTACHMENT_UNUSED) {
2786 depth_image_view = (*cmd_state->active_attachments)[attachment_index];
2787 }
2788 }
2789 if (depth_image_view && (depth_image_view->create_info.subresourceRange.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) != 0U) {
2790 const VkImage depth_image = depth_image_view->image_state->image();
2791 const VkImageSubresourceRange& subresource_range = depth_image_view->create_info.subresourceRange;
2792 RecordBindZcullScope(*cmd_state, depth_image, subresource_range);
2793 } else {
2794 RecordUnbindZcullScope(*cmd_state);
2795 }
2796 }
2797}
2798
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002799void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002800
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002801 if (!pRenderPassBegin) {
2802 return;
2803 }
2804
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002805 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002806
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002807 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002808 if (rp_state) {
2809 // Check load ops
2810 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002811 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002812
2813 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
2814 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2815 continue;
2816 }
2817
paul-lunargce0a2062022-09-09 15:22:51 +02002818 // If renderpass doesn't load attachment, no need to validate image in queue
2819 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_NONE_EXT) ||
2820 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_NONE_EXT)) {
2821 continue;
2822 }
2823
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002824 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002825
2826 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
2827 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002828 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02002829 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
2830 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002831 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02002832 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002833 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002834 }
2835
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002836 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Jeremy Gebben9f537102021-10-05 16:37:12 -06002837 std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr;
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002838
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002839 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002840 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2841 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002842 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002843 }
2844 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002845 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002846 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002847
Jeremy Gebben9f537102021-10-05 16:37:12 -06002848 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002849 }
2850
2851 // Check store ops
2852 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002853 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002854
2855 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2856 continue;
2857 }
2858
paul-lunargce0a2062022-09-09 15:22:51 +02002859 // If renderpass doesn't store attachment, no need to validate image in queue
2860 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_NONE) ||
2861 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_NONE)) {
2862 continue;
2863 }
2864
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002865 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002866
2867 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
2868 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002869 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002870 }
2871
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002872 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002873
Jeremy Gebben9f537102021-10-05 16:37:12 -06002874 std::shared_ptr<IMAGE_VIEW_STATE> image_view;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002875 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002876 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2877 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002878 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002879 }
2880 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002881 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002882 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002883
Jeremy Gebben9f537102021-10-05 16:37:12 -06002884 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002885 }
2886 }
2887}
2888
Attilio Provenzano02859b22020-02-27 14:17:28 +00002889bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2890 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002891 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2892 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002893 return skip;
2894}
2895
2896bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2897 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002898 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002899 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2900 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002901 return skip;
2902}
2903
2904bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002905 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002906 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2907 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002908 return skip;
2909}
2910
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03002911bool BestPractices::PreCallValidateCmdBeginRendering(VkCommandBuffer commandBuffer, const VkRenderingInfo* pRenderingInfo) const {
2912 bool skip = StateTracker::PreCallValidateCmdBeginRendering(commandBuffer, pRenderingInfo);
2913 skip |= ValidateCmdBeginRendering(commandBuffer, pRenderingInfo);
2914 return skip;
2915}
2916
2917bool BestPractices::PreCallValidateCmdBeginRenderingKHR(VkCommandBuffer commandBuffer, const VkRenderingInfo* pRenderingInfo) const {
2918 bool skip = StateTracker::PreCallValidateCmdBeginRenderingKHR(commandBuffer, pRenderingInfo);
2919 skip |= ValidateCmdBeginRendering(commandBuffer, pRenderingInfo);
2920 return skip;
2921}
2922
Sam Walls0961ec02020-03-31 16:39:15 +01002923void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
2924 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002925 // Reset the renderpass state
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002926 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
sjfricke52defd42022-08-08 16:37:46 +09002927 // TODO - move this logic to the Render Pass state as cb->has_draw_cmd should stay true for lifetime of command buffer
2928 cb->has_draw_cmd = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002929 assert(cb);
2930 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002931 render_pass_state.touchesAttachments.clear();
2932 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002933 render_pass_state.numDrawCallsDepthOnly = 0;
2934 render_pass_state.numDrawCallsDepthEqualCompare = 0;
2935 render_pass_state.colorAttachment = false;
2936 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002937 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002938 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01002939
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03002940 // Reset NV state
2941 cb->nv = {};
2942
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002943 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01002944
2945 // track depth / color attachment usage within the renderpass
2946 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
2947 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002948 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002949
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002950 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002951 }
2952}
2953
2954void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2955 VkSubpassContents contents) {
2956 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2957 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
2958}
2959
2960void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2961 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2962 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2963 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2964}
2965
2966void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2967 const VkRenderPassBeginInfo* pRenderPassBegin,
2968 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2969 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2970 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2971}
2972
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002973// Generic function to handle validation for all CmdDraw* type functions
2974bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
2975 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002976 const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002977 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002978 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2979 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002980 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002981
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002982 // Verify vertex binding
Tony-LunarG2ffe1f52022-04-11 15:13:30 -06002983 if (pipeline_state && pipeline_state->vertex_input_state &&
2984 pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) {
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002985 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002986 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002987 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002988 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
2989 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002990 }
2991 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002992
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002993 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002994 if (pipe) {
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002995 const auto& rp_state = pipe->RenderPassState();
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002996 if (rp_state) {
2997 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
2998 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002999 const auto* ds_state = pipe->DepthStencilState();
Jeremy Gebben11af9792021-08-20 10:20:09 -06003000 const uint32_t depth_stencil_attachment =
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07003001 GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment);
3002 const auto* raster_state = pipe->RasterizationState();
3003 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state &&
3004 raster_state->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06003005 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
3006 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
3007 }
3008 }
3009 }
3010 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07003011 }
3012 return skip;
3013}
3014
Sam Walls0961ec02020-03-31 16:39:15 +01003015void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003016 auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003017 assert(cb_node);
Sam Walls0961ec02020-03-31 16:39:15 +01003018 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003019 RecordCmdDrawTypeArm(*cb_node, draw_count, caller);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02003020 }
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003021 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3022 RecordCmdDrawTypeNVIDIA(*cb_node);
3023 }
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02003024
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003025 if (cb_node->render_pass_state.drawTouchAttachments) {
3026 for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) {
3027 RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02003028 }
3029 // No need to touch the same attachments over and over.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003030 cb_node->render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01003031 }
3032}
3033
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003034void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) {
3035 auto& render_pass_state = cb_node.render_pass_state;
LawG4b21485c2022-02-28 13:46:48 +00003036 // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards
3037 // depth prepass warnings First find the lowest enabled draw count
3038 uint32_t lowestEnabledMinDrawCount = 0;
3039 lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm;
3040 if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount)
3041 lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG;
3042
3043 if (draw_count >= lowestEnabledMinDrawCount) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02003044 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
3045 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01003046 }
3047}
3048
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003049void BestPractices::RecordCmdDrawTypeNVIDIA(bp_state::CommandBuffer& cmd_state) {
3050 assert(VendorCheckEnabled(kBPVendorNVIDIA));
3051
3052 if (cmd_state.nv.depth_test_enable && cmd_state.nv.zcull_direction != bp_state::CommandBufferStateNV::ZcullDirection::Unknown) {
3053 RecordSetScopeZcullDirection(cmd_state, cmd_state.nv.zcull_direction);
3054 RecordZcullDraw(cmd_state);
3055 }
3056}
3057
Camden5b184be2019-08-13 07:50:19 -06003058bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003059 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06003060 bool skip = false;
3061
3062 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003063 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
3064 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06003065 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06003066 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06003067
3068 return skip;
3069}
3070
Sam Walls0961ec02020-03-31 16:39:15 +01003071void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
3072 uint32_t firstVertex, uint32_t firstInstance) {
3073 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
3074 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
3075}
3076
Camden5b184be2019-08-13 07:50:19 -06003077bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003078 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06003079 bool skip = false;
3080
3081 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003082 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
3083 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06003084 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07003085 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
3086
Attilio Provenzano02859b22020-02-27 14:17:28 +00003087 // Check if we reached the limit for small indexed draw calls.
3088 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003089 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003090 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02003091 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
LawG4ff42d722022-03-01 10:28:25 +00003092 (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02003093 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
LawG4ff42d722022-03-01 10:28:25 +00003094 "%s %s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00003095 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
3096 "You can try batching drawcalls or instancing when applicable.",
LawG4ff42d722022-03-01 10:28:25 +00003097 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls,
3098 kSmallIndexedDrawcallIndices);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003099 }
3100
Sam Walls8e77e4f2020-03-16 20:47:40 +00003101 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003102 ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
Sam Walls8e77e4f2020-03-16 20:47:40 +00003103 }
3104
3105 return skip;
3106}
3107
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003108bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount,
Sam Walls8e77e4f2020-03-16 20:47:40 +00003109 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
3110 bool skip = false;
3111
3112 // check for sparse/underutilised index buffer, and post-transform cache thrashing
Sam Walls8e77e4f2020-03-16 20:47:40 +00003113
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003114 const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get();
3115 if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00003116
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003117 const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003118 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00003119 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
3120 const void* ib_mem = ib_mem_state.p_driver_data;
3121 bool primitive_restart_enable = false;
3122
locke-lunargb8d7a7a2020-10-25 16:01:52 -06003123 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003124 const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point];
locke-lunargb8d7a7a2020-10-25 16:01:52 -06003125 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00003126
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07003127 const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr;
3128 if (ia_state) {
3129 primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003130 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00003131
3132 // 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 -06003133 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00003134 uint32_t scan_stride;
3135 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
3136 scan_stride = sizeof(uint8_t);
3137 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
3138 scan_stride = sizeof(uint16_t);
3139 } else {
3140 scan_stride = sizeof(uint32_t);
3141 }
3142
3143 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
3144 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
3145
3146 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
3147 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
3148 // irrespective of whether or not they're part of the draw call.
3149
3150 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
3151 uint32_t min_index = ~0u;
3152 // start with maximum as 0 and adjust to indices in the buffer
3153 uint32_t max_index = 0u;
3154
3155 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
3156 // for the given index buffer
3157 uint32_t vertex_shade_count = 0;
3158
3159 PostTransformLRUCacheModel post_transform_cache;
3160
3161 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
3162 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
3163 // target architecture.
3164 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
3165 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
3166 post_transform_cache.resize(32);
3167
3168 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
3169 uint32_t scan_index;
3170 uint32_t primitive_restart_value;
3171 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
3172 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
3173 primitive_restart_value = 0xFF;
3174 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
3175 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
3176 primitive_restart_value = 0xFFFF;
3177 } else {
3178 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
3179 primitive_restart_value = 0xFFFFFFFF;
3180 }
3181
3182 max_index = std::max(max_index, scan_index);
3183 min_index = std::min(min_index, scan_index);
3184
3185 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
3186 bool in_cache = post_transform_cache.query_cache(scan_index);
3187 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
3188 if (!in_cache) vertex_shade_count++;
3189 }
3190 }
3191
3192 // 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 +01003193 // 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
3194 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00003195
3196 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07003197 skip |=
3198 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
3199 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
3200 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
3201 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
3202 "maximum would be loaded, and possibly shaded, whether or not they are used.",
3203 VendorSpecificTag(kBPVendorArm),
3204 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00003205 return skip;
3206 }
3207
3208 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
3209 // 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 +01003210 const size_t refs_per_bucket = 64;
3211 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
3212
3213 const uint32_t n_indices = max_index - min_index + 1;
3214 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
3215 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
3216
3217 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
3218 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00003219
3220 // To avoid using too much memory, we run over the indices again.
3221 // Knowing the size from the last scan allows us to record index usage with bitsets
3222 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
3223 uint32_t scan_index;
3224 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
3225 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
3226 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
3227 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
3228 } else {
3229 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
3230 }
3231 // keep track of the set of all indices used to reference vertices in the draw call
3232 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01003233 size_t bitset_bucket_index = index_offset / refs_per_bucket;
3234 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00003235 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
3236 }
3237
3238 uint32_t vertex_reference_count = 0;
3239 for (const auto& bitset : vertex_reference_buckets) {
3240 vertex_reference_count += static_cast<uint32_t>(bitset.count());
3241 }
3242
3243 // 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 -07003244 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00003245 // 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 -07003246 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00003247
3248 if (utilization < 0.5f) {
3249 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
3250 "%s The indices which were specified for the draw call only utilise approximately "
3251 "%.02f%% of the bound vertex buffer.",
3252 VendorSpecificTag(kBPVendorArm), utilization);
3253 }
3254
3255 if (cache_hit_rate <= 0.5f) {
3256 skip |=
3257 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
3258 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
3259 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
3260 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
3261 "recently shaded vertices.",
3262 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
3263 }
3264 }
3265
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07003266 return skip;
3267}
3268
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003269bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
3270 const VkCommandBuffer* pCommandBuffers) const {
3271 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003272 const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003273 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003274 const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003275 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003276 continue;
3277 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003278 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003279 for (auto& clear : secondary.earlyClearAttachments) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003280 if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) {
3281 skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003282 }
3283 }
3284 }
Nadav Gevaf0808442021-05-21 13:51:25 -04003285
3286 if (VendorCheckEnabled(kBPVendorAMD)) {
3287 if (commandBufferCount > 0) {
3288 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
3289 "%s Performance warning: Use of secondary command buffers is not recommended. ",
3290 VendorSpecificTag(kBPVendorAMD));
3291 }
3292 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003293 return skip;
3294}
3295
3296void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
3297 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003298 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
3299
3300 auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3301 if (!primary) {
3302 return;
3303 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003304
3305 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003306 auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]);
3307 if (!secondary) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003308 continue;
3309 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003310
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003311 for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) {
3312 if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
3313 RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment,
3314 early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003315 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003316 RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003317 }
3318 }
3319
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003320 for (auto& touch : secondary->render_pass_state.touchesAttachments) {
3321 RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003322 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02003323
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003324 primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare;
3325 primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003326 }
3327
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003328}
3329
Rodrigo Locatti7d716e12022-03-09 19:15:17 -03003330bool BestPractices::PreCallValidateCmdBuildAccelerationStructureNV(VkCommandBuffer commandBuffer,
3331 const VkAccelerationStructureInfoNV* pInfo,
3332 VkBuffer instanceData, VkDeviceSize instanceOffset,
3333 VkBool32 update, VkAccelerationStructureNV dst,
3334 VkAccelerationStructureNV src, VkBuffer scratch,
3335 VkDeviceSize scratchOffset) const {
3336 return ValidateBuildAccelerationStructure(commandBuffer);
3337}
3338
3339bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresIndirectKHR(
3340 VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
3341 const VkDeviceAddress* pIndirectDeviceAddresses, const uint32_t* pIndirectStrides,
3342 const uint32_t* const* ppMaxPrimitiveCounts) const {
3343 return ValidateBuildAccelerationStructure(commandBuffer);
3344}
3345
3346bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresKHR(
3347 VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
3348 const VkAccelerationStructureBuildRangeInfoKHR* const* ppBuildRangeInfos) const {
3349 return ValidateBuildAccelerationStructure(commandBuffer);
3350}
3351
3352bool BestPractices::ValidateBuildAccelerationStructure(VkCommandBuffer commandBuffer) const {
3353 bool skip = false;
3354 auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
3355 assert(cb_node);
3356
3357 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3358 if ((cb_node->GetQueueFlags() & VK_QUEUE_GRAPHICS_BIT) != 0) {
3359 skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_AccelerationStructure_NotAsync,
3360 "%s Performance warning: Prefer building acceleration structures on an asynchronous "
3361 "compute queue, instead of using the universal graphics queue.",
3362 VendorSpecificTag(kBPVendorNVIDIA));
3363 }
3364 }
3365
3366 return skip;
3367}
3368
Rodrigo Locatti66b23352022-03-15 17:28:32 -03003369bool BestPractices::ValidateBindMemory(VkDevice device, VkDeviceMemory memory) const {
3370 bool skip = false;
3371
3372 if (VendorCheckEnabled(kBPVendorNVIDIA) && device_extensions.vk_ext_pageable_device_local_memory) {
3373 auto mem_info = std::static_pointer_cast<const bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory));
3374 if (!mem_info->dynamic_priority) {
3375 skip |=
3376 LogPerformanceWarning(device, kVUID_BestPractices_BindMemory_NoPriority,
3377 "%s Use vkSetDeviceMemoryPriorityEXT to provide the OS with information on which allocations "
3378 "should stay in memory and which should be demoted first when video memory is limited. The "
3379 "highest priority should be given to GPU-written resources like color attachments, depth "
3380 "attachments, storage images, and buffers written from the GPU.",
3381 VendorSpecificTag(kBPVendorNVIDIA));
3382 }
3383 }
3384
3385 return skip;
3386}
3387
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003388void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
3389 auto& state = cb_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003390 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003391 auto itr =
3392 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
3393 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003394
3395 if (itr != state.touchesAttachments.end()) {
3396 itr->aspects |= aspects;
3397 } else {
3398 state.touchesAttachments.push_back({ fb_attachment, aspects });
3399 }
3400}
3401
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003402void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003403 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
3404 const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003405 auto& state = cmd_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003406 // If we observe a full clear before any other access to a frame buffer attachment,
3407 // we have candidate for redundant clear attachments.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003408 auto itr =
3409 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
3410 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003411
3412 uint32_t new_aspects = aspects;
3413 if (itr != state.touchesAttachments.end()) {
3414 new_aspects = aspects & ~itr->aspects;
3415 itr->aspects |= aspects;
3416 } else {
3417 state.touchesAttachments.push_back({ fb_attachment, aspects });
3418 }
3419
3420 if (new_aspects == 0) {
3421 return;
3422 }
3423
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003424 if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003425 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
3426 // CmdExecuteCommands.
3427 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
3428 std::vector<VkClearRect>{pRects, pRects + rectCount} });
3429 }
3430}
3431
3432void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
3433 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
3434 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003435 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects);
3436
3437 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3438 auto* rp_state = cmd_state->activeRenderPass.get();
3439 auto* fb_state = cmd_state->activeFramebuffer.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003440 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
3441
3442 if (rectCount == 0 || !rp_state) {
3443 return;
3444 }
3445
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003446 if (!is_secondary && !fb_state && !rp_state->use_dynamic_rendering && !rp_state->use_dynamic_rendering_inherited) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003447 return;
3448 }
3449
3450 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003451 const bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003452
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003453 if (rp_state->UsesDynamicRendering()) {
3454 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03003455 auto pColorAttachments = rp_state->dynamic_rendering_begin_rendering_info.pColorAttachments;
3456
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003457 for (uint32_t i = 0; i < attachmentCount; i++) {
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03003458 auto& clear_attachment = pClearAttachments[i];
3459
3460 if (clear_attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003461 RecordResetScopeZcullDirection(*cmd_state);
3462 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03003463 if ((clear_attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) &&
3464 clear_attachment.colorAttachment != VK_ATTACHMENT_UNUSED &&
3465 pColorAttachments) {
3466 const auto& attachment = pColorAttachments[clear_attachment.colorAttachment];
3467 if (attachment.imageView) {
3468 auto image_view_state = Get<IMAGE_VIEW_STATE>(attachment.imageView);
3469 const VkFormat format = image_view_state->create_info.format;
3470 RecordClearColor(format, clear_attachment.clearValue.color);
3471 }
3472 }
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003473 }
3474 }
3475
3476 // TODO: Implement other best practices for dynamic rendering
3477
3478 } else {
ziga-lunarg885c6542022-03-07 01:08:25 +01003479 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
3480 for (uint32_t i = 0; i < attachmentCount; i++) {
3481 auto& attachment = pClearAttachments[i];
3482 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
3483 VkImageAspectFlags aspects = attachment.aspectMask;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003484
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003485 if (aspects & VK_IMAGE_ASPECT_DEPTH_BIT) {
3486 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3487 RecordResetScopeZcullDirection(*cmd_state);
3488 }
3489 }
ziga-lunarg885c6542022-03-07 01:08:25 +01003490 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
3491 if (subpass.pDepthStencilAttachment) {
3492 fb_attachment = subpass.pDepthStencilAttachment->attachment;
3493 }
3494 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
3495 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003496 }
ziga-lunarg885c6542022-03-07 01:08:25 +01003497 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
3498 if (full_clear) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003499 RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment,
ziga-lunarg885c6542022-03-07 01:08:25 +01003500 aspects, rectCount, pRects);
3501 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003502 RecordAttachmentAccess(*cmd_state, fb_attachment, aspects);
ziga-lunarg885c6542022-03-07 01:08:25 +01003503 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03003504 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3505 const VkFormat format = rp_state->createInfo.pAttachments[fb_attachment].format;
3506 RecordClearColor(format, attachment.clearValue.color);
3507 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003508 }
3509 }
3510 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003511}
3512
Attilio Provenzano02859b22020-02-27 14:17:28 +00003513void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
3514 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
3515 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
3516 firstInstance);
3517
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003518 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003519 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
3520 cmd_state->small_indexed_draw_call_count++;
3521 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003522
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003523 ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00003524}
3525
Sam Walls0961ec02020-03-31 16:39:15 +01003526void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
3527 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
3528 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
3529 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
3530}
3531
Camden5b184be2019-08-13 07:50:19 -06003532bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003533 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06003534 bool skip = false;
3535
3536 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003537 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
3538 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06003539 }
3540
Rodrigo Locatti8419cde2022-03-30 18:45:13 -03003541 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
3542
Camden5b184be2019-08-13 07:50:19 -06003543 return skip;
3544}
3545
Sam Walls0961ec02020-03-31 16:39:15 +01003546void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3547 uint32_t count, uint32_t stride) {
3548 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
3549 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
3550}
3551
Camden5b184be2019-08-13 07:50:19 -06003552bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003553 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06003554 bool skip = false;
3555
3556 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003557 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
3558 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06003559 }
3560
Rodrigo Locatti8419cde2022-03-30 18:45:13 -03003561 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
3562
Camden5b184be2019-08-13 07:50:19 -06003563 return skip;
3564}
3565
Sam Walls0961ec02020-03-31 16:39:15 +01003566void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3567 uint32_t count, uint32_t stride) {
3568 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
3569 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
3570}
3571
Rodrigo Locatti467344a2022-03-30 18:48:13 -03003572bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3573 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
3574 uint32_t maxDrawCount, uint32_t stride) const {
3575 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
3576
3577 return skip;
3578}
3579
3580void BestPractices::PostCallRecordCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3581 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
3582 uint32_t maxDrawCount, uint32_t stride) {
3583 StateTracker::PostCallRecordCmdDrawIndexedIndirectCount(commandBuffer, buffer, offset, countBuffer, countBufferOffset,
3584 maxDrawCount, stride);
3585 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndexedIndirectCount()");
3586}
3587
3588bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer,
3589 VkDeviceSize offset, VkBuffer countBuffer,
3590 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3591 uint32_t stride) const {
3592 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountAMD");
3593
3594 return skip;
3595}
3596
3597void BestPractices::PostCallRecordCmdDrawIndexedIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer,
3598 VkDeviceSize offset, VkBuffer countBuffer,
3599 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3600 uint32_t stride) {
3601 StateTracker::PostCallRecordCmdDrawIndexedIndirectCountAMD(commandBuffer, buffer, offset, countBuffer, countBufferOffset,
3602 maxDrawCount, stride);
3603 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndexedIndirectCountAMD()");
3604}
3605
3606bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
3607 VkDeviceSize offset, VkBuffer countBuffer,
3608 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3609 uint32_t stride) const {
3610 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR");
3611
3612 return skip;
3613}
3614
3615void BestPractices::PostCallRecordCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
3616 VkDeviceSize offset, VkBuffer countBuffer,
3617 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3618 uint32_t stride) {
3619 StateTracker::PostCallRecordCmdDrawIndexedIndirectCountKHR(commandBuffer, buffer, offset, countBuffer, countBufferOffset,
3620 maxDrawCount, stride);
3621 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndexedIndirectCountKHR()");
3622}
3623
3624bool BestPractices::PreCallValidateCmdDrawIndirectByteCountEXT(VkCommandBuffer commandBuffer, uint32_t instanceCount,
3625 uint32_t firstInstance, VkBuffer counterBuffer,
3626 VkDeviceSize counterBufferOffset, uint32_t counterOffset,
3627 uint32_t vertexStride) const {
3628 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirectByteCountEXT");
3629
3630 return skip;
3631}
3632
3633void BestPractices::PostCallRecordCmdDrawIndirectByteCountEXT(VkCommandBuffer commandBuffer, uint32_t instanceCount,
3634 uint32_t firstInstance, VkBuffer counterBuffer,
3635 VkDeviceSize counterBufferOffset, uint32_t counterOffset,
3636 uint32_t vertexStride) {
3637 StateTracker::PostCallRecordCmdDrawIndirectByteCountEXT(commandBuffer, instanceCount, firstInstance, counterBuffer,
3638 counterBufferOffset, counterOffset, vertexStride);
3639 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndirectByteCountEXT()");
3640}
3641
3642bool BestPractices::PreCallValidateCmdDrawIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3643 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3644 uint32_t stride) const {
3645 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirectCount");
3646
3647 return skip;
3648}
3649
3650void BestPractices::PostCallRecordCmdDrawIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3651 VkBuffer countBuffer, VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3652 uint32_t stride) {
3653 StateTracker::PostCallRecordCmdDrawIndirectCount(commandBuffer, buffer, offset, countBuffer, countBufferOffset, maxDrawCount,
3654 stride);
3655 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndirectCount()");
3656}
3657
3658bool BestPractices::PreCallValidateCmdDrawIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3659 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
3660 uint32_t maxDrawCount, uint32_t stride) const {
3661 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirectCountAMD");
3662
3663 return skip;
3664}
3665
3666void BestPractices::PostCallRecordCmdDrawIndirectCountAMD(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3667 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
3668 uint32_t maxDrawCount, uint32_t stride) {
3669 StateTracker::PostCallRecordCmdDrawIndirectCountAMD(commandBuffer, buffer, offset, countBuffer, countBufferOffset, maxDrawCount,
3670 stride);
3671 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndirectCountAMD()");
3672}
3673
3674bool BestPractices::PreCallValidateCmdDrawIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3675 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
3676 uint32_t maxDrawCount, uint32_t stride) const {
3677 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirectCountKHR");
3678
3679 return skip;
3680}
3681
3682void BestPractices::PostCallRecordCmdDrawIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3683 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
3684 uint32_t maxDrawCount, uint32_t stride) {
3685 StateTracker::PostCallRecordCmdDrawIndirectCountKHR(commandBuffer, buffer, offset, countBuffer, countBufferOffset, maxDrawCount,
3686 stride);
3687 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawIndirectCountKHR()");
3688}
3689
3690bool BestPractices::PreCallValidateCmdDrawMeshTasksIndirectCountNV(VkCommandBuffer commandBuffer, VkBuffer buffer,
3691 VkDeviceSize offset, VkBuffer countBuffer,
3692 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3693 uint32_t stride) const {
3694 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawMeshTasksIndirectCountNV");
3695
3696 return skip;
3697}
3698
3699void BestPractices::PostCallRecordCmdDrawMeshTasksIndirectCountNV(VkCommandBuffer commandBuffer, VkBuffer buffer,
3700 VkDeviceSize offset, VkBuffer countBuffer,
3701 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
3702 uint32_t stride) {
3703 StateTracker::PostCallRecordCmdDrawMeshTasksIndirectCountNV(commandBuffer, buffer, offset, countBuffer, countBufferOffset,
3704 maxDrawCount, stride);
3705 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawMeshTasksIndirectCountNV()");
3706}
3707
3708bool BestPractices::PreCallValidateCmdDrawMeshTasksIndirectNV(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3709 uint32_t drawCount, uint32_t stride) const {
3710 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawMeshTasksIndirectNV");
3711
3712 return skip;
3713}
3714
3715void BestPractices::PostCallRecordCmdDrawMeshTasksIndirectNV(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3716 uint32_t drawCount, uint32_t stride) {
3717 StateTracker::PostCallRecordCmdDrawMeshTasksIndirectNV(commandBuffer, buffer, offset, drawCount, stride);
3718 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawMeshTasksIndirectNV()");
3719}
3720
3721bool BestPractices::PreCallValidateCmdDrawMeshTasksNV(VkCommandBuffer commandBuffer, uint32_t taskCount, uint32_t firstTask) const {
3722 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawMeshTasksNV");
3723
3724 return skip;
3725}
3726
3727void BestPractices::PostCallRecordCmdDrawMeshTasksNV(VkCommandBuffer commandBuffer, uint32_t taskCount, uint32_t firstTask) {
3728 StateTracker::PostCallRecordCmdDrawMeshTasksNV(commandBuffer, taskCount, firstTask);
3729 RecordCmdDrawType(commandBuffer, 0, "vkCmdDrawMeshTasksNV()");
3730}
3731
3732bool BestPractices::PreCallValidateCmdDrawMultiIndexedEXT(VkCommandBuffer commandBuffer, uint32_t drawCount,
3733 const VkMultiDrawIndexedInfoEXT* pIndexInfo, uint32_t instanceCount,
3734 uint32_t firstInstance, uint32_t stride,
3735 const int32_t* pVertexOffset) const {
3736 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawMultiIndexedEXT");
3737
3738 return skip;
3739}
3740
3741void BestPractices::PostCallRecordCmdDrawMultiIndexedEXT(VkCommandBuffer commandBuffer, uint32_t drawCount,
3742 const VkMultiDrawIndexedInfoEXT* pIndexInfo, uint32_t instanceCount,
3743 uint32_t firstInstance, uint32_t stride, const int32_t* pVertexOffset) {
3744 StateTracker::PostCallRecordCmdDrawMultiIndexedEXT(commandBuffer, drawCount, pIndexInfo, instanceCount, firstInstance, stride,
3745 pVertexOffset);
3746 uint32_t count = 0;
3747 for (uint32_t i = 0; i < drawCount; ++i) {
3748 count += pIndexInfo[i].indexCount;
3749 }
3750 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawMultiIndexedEXT()");
3751}
3752
3753bool BestPractices::PreCallValidateCmdDrawMultiEXT(VkCommandBuffer commandBuffer, uint32_t drawCount, const VkMultiDrawInfoEXT* pVertexInfo,
3754 uint32_t instanceCount, uint32_t firstInstance, uint32_t stride) const {
3755 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawMultiEXT");
3756
3757 return skip;
3758}
3759
3760void BestPractices::PostCallRecordCmdDrawMultiEXT(VkCommandBuffer commandBuffer, uint32_t drawCount,
3761 const VkMultiDrawInfoEXT* pVertexInfo, uint32_t instanceCount,
3762 uint32_t firstInstance, uint32_t stride) {
3763 StateTracker::PostCallRecordCmdDrawMultiEXT(commandBuffer, drawCount, pVertexInfo, instanceCount, firstInstance, stride);
3764 uint32_t count = 0;
3765 for (uint32_t i = 0; i < drawCount; ++i) {
3766 count += pVertexInfo[i].vertexCount;
3767 }
3768 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawMultiEXT()");
3769}
3770
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003771void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) {
3772 for (auto descriptor_set : cb_state.validated_descriptor_sets) {
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06003773 for (const auto& binding : *descriptor_set) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003774 // For bindless scenarios, we should not attempt to track descriptor set state.
3775 // It is highly uncertain which resources are actually bound.
3776 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06003777 if (binding->binding_flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
3778 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003779 continue;
3780 }
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01003781
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06003782 for (uint32_t i = 0; i < binding->count; ++i) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003783 VkImageView image_view{VK_NULL_HANDLE};
3784
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06003785 auto descriptor = binding->GetDescriptor(i);
ziga-lunarg33d806c2022-05-05 17:00:52 +02003786 if (!descriptor) {
3787 continue;
3788 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003789 switch (descriptor->GetClass()) {
3790 case cvdescriptorset::DescriptorClass::Image: {
3791 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
3792 image_view = image_descriptor->GetImageView();
3793 }
3794 break;
3795 }
3796 case cvdescriptorset::DescriptorClass::ImageSampler: {
3797 if (const auto image_sampler_descriptor =
3798 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
3799 image_view = image_sampler_descriptor->GetImageView();
3800 }
3801 break;
3802 }
3803 default:
3804 break;
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01003805 }
3806
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003807 if (image_view) {
3808 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
3809 QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(),
3810 IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003811 }
3812 }
3813 }
3814 }
3815}
3816
3817void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
3818 uint32_t firstVertex, uint32_t firstInstance) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003819 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3820 ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003821}
3822
3823void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3824 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003825 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3826 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003827}
3828
3829void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
3830 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003831 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
3832 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003833}
3834
Camden5b184be2019-08-13 07:50:19 -06003835bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003836 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06003837 bool skip = false;
3838
3839 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003840 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
3841 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
3842 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
3843 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06003844 }
3845
3846 return skip;
3847}
Camden83a9c372019-08-14 11:41:38 -06003848
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02003849bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
3850 bool skip = false;
3851 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
3852 skip |= ValidateCmdEndRenderPass(commandBuffer);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003853 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Mark Young0a6b48f2022-08-18 11:17:02 -06003854 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
3855 assert(cmd_state);
3856 skip |= ValidateZcullScope(*cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003857 }
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02003858 return skip;
3859}
3860
3861bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
3862 bool skip = false;
3863 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
3864 skip |= ValidateCmdEndRenderPass(commandBuffer);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003865 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Mark Young0a6b48f2022-08-18 11:17:02 -06003866 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
3867 assert(cmd_state);
3868 skip |= ValidateZcullScope(*cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003869 }
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02003870 return skip;
3871}
3872
Sam Walls0961ec02020-03-31 16:39:15 +01003873bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
3874 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01003875 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02003876 skip |= ValidateCmdEndRenderPass(commandBuffer);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003877 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Mark Young0a6b48f2022-08-18 11:17:02 -06003878 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
3879 assert(cmd_state);
3880 skip |= ValidateZcullScope(*cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003881 }
3882 return skip;
3883}
3884
3885bool BestPractices::PreCallValidateCmdEndRendering(VkCommandBuffer commandBuffer) const {
3886 bool skip = false;
3887 skip |= StateTracker::PreCallValidateCmdEndRendering(commandBuffer);
3888 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Mark Young0a6b48f2022-08-18 11:17:02 -06003889 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
3890 assert(cmd_state);
3891 skip |= ValidateZcullScope(*cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003892 }
3893 return skip;
3894}
3895
3896bool BestPractices::PreCallValidateCmdEndRenderingKHR(VkCommandBuffer commandBuffer) const {
3897 bool skip = false;
3898 skip |= StateTracker::PreCallValidateCmdEndRenderingKHR(commandBuffer);
3899 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Mark Young0a6b48f2022-08-18 11:17:02 -06003900 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
3901 assert(cmd_state);
3902 skip |= ValidateZcullScope(*cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03003903 }
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02003904 return skip;
3905}
3906
3907bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
3908 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003909 const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01003910
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003911 if (cmd == nullptr) return skip;
3912 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01003913
LawG4b21485c2022-02-28 13:46:48 +00003914 // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor
3915 bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
3916 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
3917 bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG &&
3918 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG;
3919
3920 // Only send the warning when the vendor is enabled and a depth prepass is detected
LawG498ec4502022-04-05 09:08:25 +01003921 bool uses_depth =
3922 (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
LawG45507e142022-04-08 09:36:54 +01003923 ((depth_only_arm && VendorCheckEnabled(kBPVendorArm)) || (depth_only_img && VendorCheckEnabled(kBPVendorIMG)));
LawG4b21485c2022-02-28 13:46:48 +00003924
Sam Walls0961ec02020-03-31 16:39:15 +01003925 if (uses_depth) {
3926 skip |= LogPerformanceWarning(
3927 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
LawG4015be1c2022-03-01 10:37:52 +00003928 "%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 +00003929 "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry "
3930 "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface "
3931 "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.",
3932 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Sam Walls0961ec02020-03-31 16:39:15 +01003933 }
3934
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003935 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
3936
LawG40da9c3d2022-03-01 09:51:01 +00003937 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003938 // If we use an attachment on-tile, we should access it in some way. Otherwise,
3939 // it is redundant to have it be part of the render pass.
3940 // Only consider it redundant if it will actually consume bandwidth, i.e.
3941 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
3942 // as is using pure input attachments.
3943 // CLEAR -> STORE might be considered a "useful" thing to do, but
3944 // the optimal thing to do is to defer the clear until you're actually
3945 // going to render to the image.
3946
3947 uint32_t num_attachments = rp->createInfo.attachmentCount;
3948 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02003949 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
3950 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003951 continue;
3952 }
3953
3954 auto& attachment = rp->createInfo.pAttachments[i];
3955
3956 VkImageAspectFlags bandwidth_aspects = 0;
3957
3958 if (!FormatIsStencilOnly(attachment.format) &&
3959 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
3960 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
3961 if (FormatHasDepth(attachment.format)) {
3962 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
3963 } else {
3964 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
3965 }
3966 }
3967
3968 if (FormatHasStencil(attachment.format) &&
3969 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
3970 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
3971 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
3972 }
3973
3974 if (!bandwidth_aspects) {
3975 continue;
3976 }
3977
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003978 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003979 [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003980 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003981 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003982 untouched_aspects &= ~itr->aspects;
3983 }
3984
3985 if (untouched_aspects) {
3986 skip |= LogPerformanceWarning(
3987 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
LawG4015be1c2022-03-01 10:37:52 +00003988 "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003989 "was never accessed by a pipeline or clear command. "
LawG40da9c3d2022-03-01 09:51:01 +00003990 "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 +00003991 "render pass if the attachments are not intended to be accessed.",
LawG40da9c3d2022-03-01 09:51:01 +00003992 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects);
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02003993 }
3994 }
3995 }
3996
Sam Walls0961ec02020-03-31 16:39:15 +01003997 return skip;
3998}
3999
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004000void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004001 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
4002 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004003}
4004
4005void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004006 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
4007 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004008}
4009
Camden Stocker9c051442019-11-06 14:28:43 -08004010bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
4011 const char* api_name) const {
4012 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004013 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08004014
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004015 if (bp_pd_state) {
4016 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
4017 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
4018 "Potential problem with calling %s() without first retrieving properties from "
4019 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
4020 api_name);
4021 }
Camden Stocker9c051442019-11-06 14:28:43 -08004022 }
4023
4024 return skip;
4025}
4026
Camden83a9c372019-08-14 11:41:38 -06004027bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004028 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06004029 bool skip = false;
4030
Camden Stocker9c051442019-11-06 14:28:43 -08004031 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06004032
Camden Stocker9c051442019-11-06 14:28:43 -08004033 return skip;
4034}
4035
4036bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
4037 uint32_t planeIndex,
4038 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
4039 bool skip = false;
4040
4041 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
4042
4043 return skip;
4044}
4045
4046bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
4047 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
4048 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
4049 bool skip = false;
4050
4051 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06004052
4053 return skip;
4054}
Camden05de2d42019-08-19 10:23:56 -06004055
4056bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004057 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06004058 bool skip = false;
4059
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004060 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Camden05de2d42019-08-19 10:23:56 -06004061
Nathaniel Cesario39152e62021-07-02 13:04:16 -06004062 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06004063 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06004064 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004065 skip |=
4066 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
4067 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
4068 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06004069 }
Camden05de2d42019-08-19 10:23:56 -06004070
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06004071 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
4072 skip |= LogWarning(
4073 device, kVUID_BestPractices_Swapchain_InvalidCount,
4074 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04004075 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06004076 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
4077 }
4078 }
4079
Camden05de2d42019-08-19 10:23:56 -06004080 return skip;
4081}
4082
4083// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06004084bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004085 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004086 const CALL_STATE call_state,
4087 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06004088 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004089 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
4090 if (UNCALLED == call_state) {
4091 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06004092 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004093 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
4094 "recommended "
4095 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
4096 caller_name, caller_name);
4097 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06004098 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
4099 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004100 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
4101 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
4102 ". It is recommended to instead receive all the properties by calling %s with "
4103 "pQueueFamilyPropertyCount that was "
4104 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06004105 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004106 caller_name);
Camden05de2d42019-08-19 10:23:56 -06004107 }
4108
4109 return skip;
4110}
4111
Jeff Bolz5c801d12019-10-09 10:38:45 -05004112bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
4113 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06004114 bool skip = false;
4115
4116 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004117 auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06004118 if (!as_state->memory_requirements_checked) {
4119 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
4120 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
4121 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004122 skip |= LogWarning(
4123 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06004124 "vkBindAccelerationStructureMemoryNV(): "
4125 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
4126 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
4127 }
4128 }
4129
4130 return skip;
4131}
4132
Camden05de2d42019-08-19 10:23:56 -06004133bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
4134 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004135 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004136 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004137 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004138 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004139 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
4140 "vkGetPhysicalDeviceQueueFamilyProperties()");
4141 }
4142 return false;
Camden05de2d42019-08-19 10:23:56 -06004143}
4144
Mike Schuchardt2df08912020-12-15 16:28:09 -08004145bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
4146 uint32_t* pQueueFamilyPropertyCount,
4147 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004148 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004149 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004150 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004151 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
4152 "vkGetPhysicalDeviceQueueFamilyProperties2()");
4153 }
4154 return false;
Camden05de2d42019-08-19 10:23:56 -06004155}
4156
Jeff Bolz5c801d12019-10-09 10:38:45 -05004157bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08004158 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004159 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004160 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004161 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07004162 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
4163 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
4164 }
4165 return false;
Camden05de2d42019-08-19 10:23:56 -06004166}
4167
4168bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
4169 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004170 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06004171 if (!pSurfaceFormats) return false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004172 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004173 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06004174 bool skip = false;
4175 if (call_state == UNCALLED) {
4176 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
4177 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004178 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
4179 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
4180 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06004181 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06004182 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004183 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
4184 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
4185 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
4186 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06004187 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06004188 }
4189 }
4190 return skip;
4191}
Camden Stocker23cc47d2019-09-03 14:53:57 -06004192
4193bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05004194 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06004195 bool skip = false;
4196
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004197 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
4198 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06004199 // 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 -07004200 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004201 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
4202 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07004203 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06004204 // 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 -07004205 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
4206 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04004207 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004208 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06004209 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004210 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06004211 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004212 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
4213 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
4214 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004215 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004216 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
4217 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004218 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004219 }
4220 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06004221 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06004222 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004223 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004224 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
4225 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004226 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004227 }
4228 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004229 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
4230 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04004231 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004232 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06004233 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004234 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06004235 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004236 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
4237 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
4238 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004239 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004240 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
4241 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004242 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004243 }
4244 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06004245 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06004246 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004247 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004248 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
4249 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004250 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004251 }
4252 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
4253 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004254 sparse_images_with_metadata.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004255 }
4256 }
4257 }
4258 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004259 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
4260 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06004261 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004262 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07004263 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
4264 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06004265 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06004266 }
4267 }
4268 }
4269
Rodrigo Locatti7ab778d2022-03-09 18:57:15 -03004270 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4271 auto queue_state = Get<QUEUE_STATE>(queue);
4272 if (queue_state && queue_state->queueFamilyProperties.queueFlags != (VK_QUEUE_TRANSFER_BIT | VK_QUEUE_SPARSE_BINDING_BIT)) {
4273 skip |= LogPerformanceWarning(queue, kVUID_BestPractices_QueueBindSparse_NotAsync,
4274 "vkQueueBindSparse() issued on queue %s. All binds should happen on an asynchronous copy "
4275 "queue to hide the OS scheduling and submit costs.",
4276 report_data->FormatHandle(queue).c_str());
4277 }
4278 }
4279
Camden Stocker23cc47d2019-09-03 14:53:57 -06004280 return skip;
4281}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004282
Mark Lobodzinski84101d72020-04-24 09:43:48 -06004283void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
4284 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07004285 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07004286 return;
4287 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004288
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004289 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
4290 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
4291 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
4292 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04004293 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004294 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004295 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07004296 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05004297 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
4298 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
4299 image_state->sparse_metadata_bound = true;
4300 }
4301 }
4302 }
4303 }
4304}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07004305
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004306bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06004307 const VkClearRect* pRects) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004308 if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004309 // We don't know the accurate render area in a secondary,
4310 // so assume we clear the entire frame buffer.
4311 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
4312 return true;
4313 }
4314
4315 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
4316 for (uint32_t i = 0; i < rectCount; i++) {
4317 auto& rect = pRects[i];
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004318 auto& render_area = cmd.activeRenderPassBeginInfo.renderArea;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004319 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
4320 return true;
4321 }
4322 }
4323
4324 return false;
4325}
4326
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004327bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment,
4328 VkImageAspectFlags aspects, bool secondary) const {
4329 const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004330 bool skip = false;
4331
4332 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
4333 return skip;
4334 }
4335
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004336 const auto& rp_state = cmd.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004337
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004338 auto attachment_itr =
4339 std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
4340 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004341
4342 // Only report aspects which haven't been touched yet.
4343 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06004344 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004345 new_aspects &= ~attachment_itr->aspects;
4346 }
4347
4348 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
sjfricke52defd42022-08-08 16:37:46 +09004349 if (!cmd.has_draw_cmd) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004350 skip |= LogPerformanceWarning(
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004351 cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02004352 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
4353 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004354 report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004355 }
4356
4357 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
4358 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
4359 skip |= LogPerformanceWarning(
4360 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
4361 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
4362 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
4363 "it is more efficient.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004364 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004365 }
4366
4367 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
4368 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004369 skip |=
4370 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
4371 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
4372 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
4373 "it is more efficient.",
4374 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004375
4376 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
Mark Young0a6b48f2022-08-18 11:17:02 -06004377 const auto cmd_state = GetRead<bp_state::CommandBuffer>(cmd.commandBuffer());
4378 assert(cmd_state);
4379 skip |= ValidateZcullScope(*cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004380 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004381 }
4382
4383 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
4384 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004385 skip |=
4386 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
4387 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
4388 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
4389 "it is more efficient.",
4390 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004391 }
4392
4393 return skip;
4394}
4395
Camden Stocker0e0f89b2019-10-16 12:24:31 -07004396bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06004397 const VkClearAttachment* pAttachments, uint32_t rectCount,
4398 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07004399 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004400 const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07004401 if (!cb_node) return skip;
4402
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02004403 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
4404 // Defer checks to ExecuteCommands.
4405 return skip;
4406 }
4407
4408 // Only care about full clears, partial clears might have legitimate uses.
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004409 const bool is_full_clear = ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07004410
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00004411 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
4412 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06004413 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00004414 if (rp) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004415 if (rp->use_dynamic_rendering || rp->use_dynamic_rendering_inherited) {
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004416 const auto pColorAttachments = rp->dynamic_rendering_begin_rendering_info.pColorAttachments;
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00004417
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004418 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4419 for (uint32_t i = 0; i < attachmentCount; i++) {
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004420 const auto& attachment = pAttachments[i];
4421 if (attachment.aspectMask & VK_IMAGE_ASPECT_DEPTH_BIT) {
Mark Young0a6b48f2022-08-18 11:17:02 -06004422 skip |= ValidateZcullScope(*cb_node);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004423 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004424 if ((attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) && attachment.colorAttachment != VK_ATTACHMENT_UNUSED) {
4425 const auto& color_attachment = pColorAttachments[attachment.colorAttachment];
4426 if (color_attachment.imageView) {
4427 auto image_view_state = Get<IMAGE_VIEW_STATE>(color_attachment.imageView);
4428 const VkFormat format = image_view_state->create_info.format;
4429 skip |= ValidateClearColor(commandBuffer, format, attachment.clearValue.color);
4430 }
4431 }
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004432 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00004433 }
4434
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004435 if (is_full_clear) {
4436 // TODO: Implement ValidateClearAttachment for dynamic rendering
4437 }
4438
4439 } else {
4440 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
4441
4442 if (is_full_clear) {
4443 for (uint32_t i = 0; i < attachmentCount; i++) {
4444 const auto& attachment = pAttachments[i];
4445
4446 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4447 uint32_t color_attachment = attachment.colorAttachment;
4448 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
4449 skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false);
4450 }
4451
4452 if (subpass.pDepthStencilAttachment &&
4453 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
4454 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
4455 skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false);
4456 }
4457 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00004458 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004459 if (VendorCheckEnabled(kBPVendorNVIDIA) && rp->createInfo.pAttachments) {
4460 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; ++attachment_idx) {
4461 const auto& attachment = pAttachments[attachment_idx];
4462
4463 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
4464 const uint32_t fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
4465 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
4466 const VkFormat format = rp->createInfo.pAttachments[fb_attachment].format;
4467 skip |= ValidateClearColor(commandBuffer, format, attachment.clearValue.color);
4468 }
4469 }
4470 }
4471 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00004472 }
4473 }
4474
Nadav Gevaf0808442021-05-21 13:51:25 -04004475 if (VendorCheckEnabled(kBPVendorAMD)) {
4476 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
4477 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
4478 bool black_check = false;
4479 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
4480 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
4481 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
4482 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
4483 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
4484
4485 bool white_check = false;
4486 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
4487 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
4488 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
4489 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
4490 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
4491
4492 if (black_check && white_check) {
4493 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
4494 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
4495 "Consider changing to one of the following:"
4496 "RGBA(0, 0, 0, 0) "
4497 "RGBA(0, 0, 0, 1) "
4498 "RGBA(1, 1, 1, 0) "
4499 "RGBA(1, 1, 1, 1)",
4500 VendorSpecificTag(kBPVendorAMD), attachment_idx);
4501 }
4502 } else {
4503 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
4504 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
4505 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
4506 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
4507 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
4508 "attachment %" PRId32 " is not a fast clear value."
4509 "Consider changing to one of the following:"
4510 "D=0.0f, S=0"
4511 "D=1.0f, S=0",
4512 VendorSpecificTag(kBPVendorAMD), attachment_idx);
4513 }
4514 }
4515 }
4516 }
4517
Camden Stockerf55721f2019-09-09 11:04:49 -06004518 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07004519}
Attilio Provenzano02859b22020-02-27 14:17:28 +00004520
4521bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4522 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4523 const VkImageResolve* pRegions) const {
4524 bool skip = false;
4525
4526 skip |= VendorCheckEnabled(kBPVendorArm) &&
4527 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
4528 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
4529 "This is a very slow and extremely bandwidth intensive path. "
4530 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
4531 VendorSpecificTag(kBPVendorArm));
4532
4533 return skip;
4534}
4535
Jeff Leger178b1e52020-10-05 12:22:23 -04004536bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4537 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
4538 bool skip = false;
4539
4540 skip |= VendorCheckEnabled(kBPVendorArm) &&
4541 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
4542 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
4543 "This is a very slow and extremely bandwidth intensive path. "
4544 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
4545 VendorSpecificTag(kBPVendorArm));
4546
4547 return skip;
4548}
4549
Tony-LunarGd36f5f32022-01-20 11:49:59 -07004550bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
4551 const VkResolveImageInfo2* pResolveImageInfo) const {
4552 bool skip = false;
4553
4554 skip |= VendorCheckEnabled(kBPVendorArm) &&
4555 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage,
4556 "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. "
4557 "This is a very slow and extremely bandwidth intensive path. "
4558 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
4559 VendorSpecificTag(kBPVendorArm));
4560
4561 return skip;
4562}
4563
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004564void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4565 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4566 const VkImageResolve* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004567 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004568 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004569 auto src = Get<bp_state::Image>(srcImage);
4570 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004571
4572 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004573 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
4574 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004575 }
4576}
4577
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01004578void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
4579 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004580 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004581 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004582 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
4583 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01004584 uint32_t regionCount = pResolveImageInfo->regionCount;
4585
4586 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004587 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
4588 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01004589 }
4590}
4591
Tony-LunarGd36f5f32022-01-20 11:49:59 -07004592void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer,
4593 const VkResolveImageInfo2* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004594 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07004595 auto& funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004596 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
4597 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07004598 uint32_t regionCount = pResolveImageInfo->regionCount;
4599
4600 for (uint32_t i = 0; i < regionCount; i++) {
4601 QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ,
4602 pResolveImageInfo->pRegions[i].srcSubresource);
4603 QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE,
4604 pResolveImageInfo->pRegions[i].dstSubresource);
4605 }
4606}
4607
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004608void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
4609 const VkClearColorValue* pColor, uint32_t rangeCount,
4610 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004611 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004612 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004613 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004614
4615 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004616 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004617 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004618
4619 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4620 RecordClearColor(dst->createInfo.format, *pColor);
4621 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004622}
4623
4624void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
4625 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
4626 const VkImageSubresourceRange* pRanges) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004627 ValidationStateTracker::PreCallRecordCmdClearDepthStencilImage(commandBuffer, image, imageLayout, pDepthStencil, rangeCount,
4628 pRanges);
4629
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004630 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004631 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004632 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004633
4634 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004635 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004636 }
Rodrigo Locatti6c4c2662022-08-18 14:20:04 -03004637 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4638 for (uint32_t i = 0; i < rangeCount; i++) {
4639 RecordResetZcullDirection(*cb, image, pRanges[i]);
4640 }
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004641 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004642}
4643
4644void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4645 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4646 const VkImageCopy* pRegions) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004647 ValidationStateTracker::PreCallRecordCmdCopyImage(commandBuffer, srcImage, srcImageLayout, dstImage, dstImageLayout,
4648 regionCount, pRegions);
4649
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004650 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004651 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004652 auto src = Get<bp_state::Image>(srcImage);
4653 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004654
4655 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004656 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
4657 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004658 }
4659}
4660
4661void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
4662 VkImageLayout dstImageLayout, uint32_t regionCount,
4663 const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004664 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004665 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004666 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004667
4668 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004669 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004670 }
4671}
4672
4673void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4674 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004675 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004676 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004677 auto src = Get<bp_state::Image>(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004678
4679 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004680 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004681 }
4682}
4683
4684void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4685 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4686 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004687 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01004688 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004689 auto src = Get<bp_state::Image>(srcImage);
4690 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004691
4692 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02004693 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
4694 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01004695 }
4696}
4697
Attilio Provenzano02859b22020-02-27 14:17:28 +00004698bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
4699 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
4700 bool skip = false;
4701
4702 if (VendorCheckEnabled(kBPVendorArm)) {
4703 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
4704 skip |= LogPerformanceWarning(
4705 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
4706 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
4707 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
4708 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06004709 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00004710 }
4711
4712 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
4713 skip |= LogPerformanceWarning(
4714 device, kVUID_BestPractices_CreateSampler_LodClamping,
4715 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
4716 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
4717 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
4718 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
4719 }
4720
4721 if (pCreateInfo->mipLodBias != 0.0f) {
4722 skip |=
4723 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
4724 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
4725 "descriptors being created and may cause reduced performance.",
4726 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
4727 }
4728
4729 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
4730 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
4731 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
4732 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
4733 skip |= LogPerformanceWarning(
4734 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
4735 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
4736 "This will lead to less efficient descriptors being created and may cause reduced performance. "
4737 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
4738 VendorSpecificTag(kBPVendorArm));
4739 }
4740
4741 if (pCreateInfo->unnormalizedCoordinates) {
4742 skip |= LogPerformanceWarning(
4743 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
4744 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
4745 "descriptors being created and may cause reduced performance.",
4746 VendorSpecificTag(kBPVendorArm));
4747 }
4748
4749 if (pCreateInfo->anisotropyEnable) {
4750 skip |= LogPerformanceWarning(
4751 device, kVUID_BestPractices_CreateSampler_Anisotropy,
4752 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
4753 "and may cause reduced performance.",
4754 VendorSpecificTag(kBPVendorArm));
4755 }
4756 }
4757
4758 return skip;
4759}
Sam Walls8e77e4f2020-03-16 20:47:40 +00004760
Nadav Gevaf0808442021-05-21 13:51:25 -04004761void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
4762 const VkGraphicsPipelineCreateInfo* pCreateInfos,
4763 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
4764 void* cgpl_state) {
4765 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
4766 pPipelines);
4767 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004768 num_pso_ += createInfoCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04004769}
4770
4771bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
4772 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
4773 const VkCopyDescriptorSet* pDescriptorCopies) const {
4774 bool skip = false;
4775 if (VendorCheckEnabled(kBPVendorAMD)) {
4776 if (descriptorCopyCount > 0) {
4777 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
4778 "%s Performance warning: copying descriptor sets is not recommended",
4779 VendorSpecificTag(kBPVendorAMD));
4780 }
4781 }
4782
4783 return skip;
4784}
4785
4786bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
4787 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
4788 const VkAllocationCallbacks* pAllocator,
4789 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
4790 bool skip = false;
4791 if (VendorCheckEnabled(kBPVendorAMD)) {
4792 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
4793 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
4794 "vkUpdateDescriptorSet instead",
4795 VendorSpecificTag(kBPVendorAMD));
4796 }
4797
4798 return skip;
4799}
4800
4801bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
4802 const VkClearColorValue* pColor, uint32_t rangeCount,
4803 const VkImageSubresourceRange* pRanges) const {
4804 bool skip = false;
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004805
4806 auto dst = Get<bp_state::Image>(image);
4807
Nadav Gevaf0808442021-05-21 13:51:25 -04004808 if (VendorCheckEnabled(kBPVendorAMD)) {
sfricke-samsungef15e482022-01-26 11:32:49 -08004809 skip |= LogPerformanceWarning(
4810 device, kVUID_BestPractices_ClearAttachment_ClearImage,
Nadav Gevaf0808442021-05-21 13:51:25 -04004811 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
4812 "vkCmdClearAttachments instead",
4813 VendorSpecificTag(kBPVendorAMD));
4814 }
Rodrigo Locattie4c08a02022-04-04 18:12:18 -03004815 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4816 skip |= ValidateClearColor(commandBuffer, dst->createInfo.format, *pColor);
4817 }
Nadav Gevaf0808442021-05-21 13:51:25 -04004818
4819 return skip;
4820}
4821
4822bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
4823 VkImageLayout imageLayout,
4824 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
4825 const VkImageSubresourceRange* pRanges) const {
4826 bool skip = false;
4827 if (VendorCheckEnabled(kBPVendorAMD)) {
4828 skip |= LogPerformanceWarning(
4829 device, kVUID_BestPractices_ClearAttachment_ClearImage,
4830 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
4831 "vkCmdClearAttachments instead",
4832 VendorSpecificTag(kBPVendorAMD));
4833 }
Mark Young0a6b48f2022-08-18 11:17:02 -06004834 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
4835 assert(cmd_state);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004836 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4837 for (uint32_t i = 0; i < rangeCount; i++) {
Mark Young0a6b48f2022-08-18 11:17:02 -06004838 skip |= ValidateZcull(*cmd_state, image, pRanges[i]);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03004839 }
4840 }
Nadav Gevaf0808442021-05-21 13:51:25 -04004841
4842 return skip;
4843}
4844
4845bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
4846 const VkAllocationCallbacks* pAllocator,
4847 VkPipelineLayout* pPipelineLayout) const {
4848 bool skip = false;
4849 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004850 uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2;
Nadav Gevaf0808442021-05-21 13:51:25 -04004851 // Descriptor sets cost 1 DWORD each.
4852 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
4853 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
4854 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
4855 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
4856 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06004857 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004858 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size;
Nadav Gevaf0808442021-05-21 13:51:25 -04004859 }
4860
4861 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
4862 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
4863 }
4864
4865 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
4866 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
4867 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
4868 "Descriptor sets cost 1 DWORD each. "
4869 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
4870 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
4871 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
4872 VendorSpecificTag(kBPVendorAMD));
4873 }
4874 }
4875
Rodrigo Locatti65b33832022-03-15 17:57:30 -03004876 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4877 bool has_separate_sampler = false;
Rodrigo Locatti12f6ffc2022-03-15 18:29:11 -03004878 size_t fast_space_usage = 0;
Rodrigo Locatti65b33832022-03-15 17:57:30 -03004879
4880 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; ++i) {
4881 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
4882 for (const auto& binding : descriptor_set_layout_state->GetBindings()) {
4883 if (binding.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) {
4884 has_separate_sampler = true;
4885 }
Rodrigo Locatti12f6ffc2022-03-15 18:29:11 -03004886
4887 if ((descriptor_set_layout_state->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT) == 0U) {
4888 size_t descriptor_type_size = 0;
4889
4890 switch (binding.descriptorType) {
4891 case VK_DESCRIPTOR_TYPE_SAMPLER:
4892 case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
4893 case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
4894 case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
4895 case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
4896 case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
4897 case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
4898 descriptor_type_size = 4;
4899 break;
4900 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
4901 case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC:
4902 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
4903 case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV:
4904 descriptor_type_size = 8;
4905 break;
4906 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
4907 case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC:
4908 case VK_DESCRIPTOR_TYPE_MUTABLE_VALVE:
4909 descriptor_type_size = 16;
4910 break;
4911 case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK:
4912 descriptor_type_size = 1;
4913 default:
4914 // Unknown type.
4915 break;
4916 }
4917
4918 size_t descriptor_size = descriptor_type_size * binding.descriptorCount;
4919 fast_space_usage += descriptor_size;
4920 }
Rodrigo Locatti65b33832022-03-15 17:57:30 -03004921 }
4922 }
4923
4924 if (has_separate_sampler) {
4925 skip |= LogPerformanceWarning(
4926 device, kVUID_BestPractices_CreatePipelineLayout_SeparateSampler,
4927 "%s Consider using combined image samplers instead of separate samplers for marginally better performance.",
4928 VendorSpecificTag(kBPVendorNVIDIA));
4929 }
Rodrigo Locatti12f6ffc2022-03-15 18:29:11 -03004930
4931 if (fast_space_usage > kPipelineLayoutFastDescriptorSpaceNVIDIA) {
4932 skip |= LogPerformanceWarning(
4933 device, kVUID_BestPractices_CreatePipelinesLayout_LargePipelineLayout,
4934 "%s Pipeline layout size is too large, prefer using pipeline-specific descriptor set layouts. "
4935 "Aim for consuming less than %" PRIu32 " bytes to allow fast reads for all non-bindless descriptors. "
4936 "Samplers, textures, texel buffers, and combined image samplers consume 4 bytes each. "
4937 "Uniform buffers and acceleration structures consume 8 bytes. "
4938 "Storage buffers consume 16 bytes. "
4939 "Push constants do not consume space.",
4940 VendorSpecificTag(kBPVendorNVIDIA), kPipelineLayoutFastDescriptorSpaceNVIDIA);
4941 }
Rodrigo Locatti65b33832022-03-15 17:57:30 -03004942 }
4943
Nadav Gevaf0808442021-05-21 13:51:25 -04004944 return skip;
4945}
4946
4947bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
4948 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
4949 const VkImageCopy* pRegions) const {
4950 bool skip = false;
4951 std::stringstream src_image_hex;
4952 std::stringstream dst_image_hex;
4953 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
4954 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
4955
4956 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07004957 auto src_state = Get<IMAGE_STATE>(srcImage);
4958 auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04004959
4960 if (src_state && dst_state) {
4961 VkImageTiling src_Tiling = src_state->createInfo.tiling;
4962 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
4963 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
4964 skip |=
4965 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
4966 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
4967 "image (vkCmdCopyImageToBuffer) "
4968 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
4969 "copies when converting between linear and optimal images",
4970 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
4971 }
4972 }
4973 }
4974
4975 return skip;
4976}
4977
4978bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
4979 VkPipeline pipeline) const {
4980 bool skip = false;
4981
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03004982 auto cb = Get<bp_state::CommandBuffer>(commandBuffer);
4983
Rodrigo Locatti494e4482022-03-30 16:37:40 -03004984 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004985 if (IsPipelineUsedInFrame(pipeline)) {
Nadav Gevaf0808442021-05-21 13:51:25 -04004986 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03004987 "%s %s Performance warning: Pipeline %s was bound twice in the frame. "
4988 "Keep pipeline state changes to a minimum, for example, by sorting draw calls by pipeline.",
4989 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA),
4990 report_data->FormatHandle(pipeline).c_str());
Nadav Gevaf0808442021-05-21 13:51:25 -04004991 }
4992 }
Rodrigo Locattia5eaf6e2022-04-01 18:05:23 -03004993 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
4994 const auto& tgm = cb->nv.tess_geometry_mesh;
4995 if (tgm.num_switches >= kNumBindPipelineTessGeometryMeshSwitchesThresholdNVIDIA && !tgm.threshold_signaled) {
4996 LogPerformanceWarning(commandBuffer, kVUID_BestPractices_BindPipeline_SwitchTessGeometryMesh,
4997 "%s Avoid switching between pipelines with and without tessellation, geometry, task, "
4998 "and/or mesh shaders. Group draw calls using these shader stages together.",
4999 VendorSpecificTag(kBPVendorNVIDIA));
5000 // Do not set 'skip' so the number of switches gets properly counted after the message.
5001 }
5002 }
5003
Nadav Gevaf0808442021-05-21 13:51:25 -04005004 return skip;
5005}
5006
5007void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
5008 VkFence fence, VkResult result) {
5009 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005010 num_queue_submissions_ += submitCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04005011}
5012
5013bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
5014 bool skip = false;
5015
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005016 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005017 auto num = num_queue_submissions_.load();
5018 if (num > kNumberOfSubmissionWarningLimitAMD) {
5019 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005020 "%s %s Performance warning: command buffers submitted %" PRId32
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005021 " times this frame. Submitting command buffers has a CPU "
5022 "and GPU overhead. Submit fewer times to incur less overhead.",
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005023 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04005024 }
5025 }
5026
5027 return skip;
5028}
5029
5030void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
5031 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
5032 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
5033 uint32_t bufferMemoryBarrierCount,
5034 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
5035 uint32_t imageMemoryBarrierCount,
5036 const VkImageMemoryBarrier* pImageMemoryBarriers) {
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03005037 ValidationStateTracker::PostCallRecordCmdPipelineBarrier(commandBuffer, srcStageMask, dstStageMask, dependencyFlags,
5038 memoryBarrierCount, pMemoryBarriers, bufferMemoryBarrierCount,
5039 pBufferMemoryBarriers, imageMemoryBarrierCount, pImageMemoryBarriers);
5040
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005041 num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount);
Rodrigo Locatti0b16cda2022-04-01 17:59:53 -03005042
5043 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
5044 RecordCmdPipelineBarrierImageBarrier(commandBuffer, pImageMemoryBarriers[i]);
5045 }
5046}
5047
5048void BestPractices::PostCallRecordCmdPipelineBarrier2(VkCommandBuffer commandBuffer, const VkDependencyInfo *pDependencyInfo) {
5049 ValidationStateTracker::PostCallRecordCmdPipelineBarrier2(commandBuffer, pDependencyInfo);
5050
5051 for (uint32_t i = 0; i < pDependencyInfo->imageMemoryBarrierCount; ++i) {
5052 RecordCmdPipelineBarrierImageBarrier(commandBuffer, pDependencyInfo->pImageMemoryBarriers[i]);
5053 }
5054}
5055
5056void BestPractices::PostCallRecordCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer, const VkDependencyInfo *pDependencyInfo) {
5057 ValidationStateTracker::PostCallRecordCmdPipelineBarrier2KHR(commandBuffer, pDependencyInfo);
5058
5059 for (uint32_t i = 0; i < pDependencyInfo->imageMemoryBarrierCount; ++i) {
5060 RecordCmdPipelineBarrierImageBarrier(commandBuffer, pDependencyInfo->pImageMemoryBarriers[i]);
5061 }
5062}
5063
5064template <typename ImageMemoryBarrier>
5065void BestPractices::RecordCmdPipelineBarrierImageBarrier(VkCommandBuffer commandBuffer, const ImageMemoryBarrier& barrier) {
5066 auto cb = Get<bp_state::CommandBuffer>(commandBuffer);
5067 assert(cb);
5068
5069 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
5070 RecordResetZcullDirection(*cb, barrier.image, barrier.subresourceRange);
5071 }
Nadav Gevaf0808442021-05-21 13:51:25 -04005072}
5073
5074bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
5075 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
5076 bool skip = false;
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005077 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005078 if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04005079 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005080 "%s %s Performance warning: High number of vkSemaphore objects created. "
Nadav Gevaf0808442021-05-21 13:51:25 -04005081 "Minimize the amount of queue synchronization that is used. "
5082 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005083 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04005084 }
5085 }
5086
5087 return skip;
5088}
5089
5090bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
5091 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
5092 bool skip = false;
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005093 if (VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorNVIDIA)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005094 if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04005095 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005096 "%s %s Performance warning: High number of VkFence objects created."
Nadav Gevaf0808442021-05-21 13:51:25 -04005097 "Minimize the amount of CPU-GPU synchronization that is used. "
Rodrigo Locatti494e4482022-03-30 16:37:40 -03005098 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
5099 VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorNVIDIA));
Nadav Gevaf0808442021-05-21 13:51:25 -04005100 }
5101 }
5102
5103 return skip;
5104}
5105
Sam Walls8e77e4f2020-03-16 20:47:40 +00005106void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
5107
5108bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
5109 // look for a cache hit
5110 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
5111 if (hit != _entries.end()) {
5112 // mark the cache hit as being most recently used
5113 hit->age = iteration++;
5114 return true;
5115 }
5116
5117 // if there's no cache hit, we need to model the entry being inserted into the cache
5118 CacheEntry new_entry = {value, iteration};
5119 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
5120 // if there is still space left in the cache, use the next available slot
5121 *(_entries.begin() + iteration) = new_entry;
5122 } else {
5123 // otherwise replace the least recently used cache entry
5124 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
5125 *lru = new_entry;
5126 }
5127 iteration++;
5128 return false;
5129}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005130
5131bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
5132 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07005133 auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005134 bool skip = false;
5135 if (swapchain_data && swapchain_data->images.size() == 0) {
5136 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
5137 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
5138 "vkGetSwapchainImagesKHR after swapchain creation.");
5139 }
5140 return skip;
5141}
5142
Nathaniel Cesario56a96652020-12-30 13:23:42 -07005143void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
5144 if (no_pointer) {
5145 if (UNCALLED == call_state) {
5146 call_state = QUERY_COUNT;
5147 }
5148 } else { // Save queue family properties
5149 call_state = QUERY_DETAILS;
5150 }
5151}
5152
Nathaniel Cesariof121d122020-10-08 13:09:46 -06005153void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
5154 uint32_t* pQueueFamilyPropertyCount,
5155 VkQueueFamilyProperties* pQueueFamilyProperties) {
5156 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
5157 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005158 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005159 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07005160 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
5161 nullptr == pQueueFamilyProperties);
5162 }
5163}
5164
5165void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
5166 uint32_t* pQueueFamilyPropertyCount,
5167 VkQueueFamilyProperties2* pQueueFamilyProperties) {
5168 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
5169 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005170 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07005171 if (bp_pd_state) {
5172 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
5173 nullptr == pQueueFamilyProperties);
5174 }
5175}
5176
5177void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
5178 uint32_t* pQueueFamilyPropertyCount,
5179 VkQueueFamilyProperties2* pQueueFamilyProperties) {
5180 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
5181 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005182 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07005183 if (bp_pd_state) {
5184 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
5185 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005186 }
5187}
5188
Nathaniel Cesariof121d122020-10-08 13:09:46 -06005189void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
5190 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005191 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005192 if (bp_pd_state) {
5193 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
5194 }
5195}
5196
Nathaniel Cesariof121d122020-10-08 13:09:46 -06005197void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
5198 VkPhysicalDeviceFeatures2* pFeatures) {
5199 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005200 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005201 if (bp_pd_state) {
5202 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
5203 }
5204}
5205
Nathaniel Cesariof121d122020-10-08 13:09:46 -06005206void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
5207 VkPhysicalDeviceFeatures2* pFeatures) {
5208 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005209 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005210 if (bp_pd_state) {
5211 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
5212 }
5213}
5214
5215void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
5216 VkSurfaceKHR surface,
5217 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
5218 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005219 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005220 if (bp_pd_state) {
5221 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
5222 }
5223}
5224
5225void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
5226 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
5227 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005228 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005229 if (bp_pd_state) {
5230 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
5231 }
5232}
5233
5234void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
5235 VkSurfaceKHR surface,
5236 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
5237 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005238 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005239 if (bp_pd_state) {
5240 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
5241 }
5242}
5243
5244void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
5245 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
5246 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005247 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005248 if (bp_pd_data) {
5249 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
5250
5251 if (*pPresentModeCount) {
5252 if (call_state < QUERY_COUNT) {
5253 call_state = QUERY_COUNT;
5254 }
5255 }
5256 if (pPresentModes) {
5257 if (call_state < QUERY_DETAILS) {
5258 call_state = QUERY_DETAILS;
5259 }
5260 }
5261 }
5262}
5263
5264void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
5265 uint32_t* pSurfaceFormatCount,
5266 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005267 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005268 if (bp_pd_data) {
5269 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
5270
5271 if (*pSurfaceFormatCount) {
5272 if (call_state < QUERY_COUNT) {
5273 call_state = QUERY_COUNT;
5274 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06005275 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005276 }
5277 if (pSurfaceFormats) {
5278 if (call_state < QUERY_DETAILS) {
5279 call_state = QUERY_DETAILS;
5280 }
5281 }
5282 }
5283}
5284
5285void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
5286 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
5287 uint32_t* pSurfaceFormatCount,
5288 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005289 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005290 if (bp_pd_data) {
5291 if (*pSurfaceFormatCount) {
5292 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
5293 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
5294 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06005295 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005296 }
5297 if (pSurfaceFormats) {
5298 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
5299 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
5300 }
5301 }
5302 }
5303}
5304
5305void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
5306 uint32_t* pPropertyCount,
5307 VkDisplayPlanePropertiesKHR* pProperties,
5308 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005309 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005310 if (bp_pd_data) {
5311 if (*pPropertyCount) {
5312 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
5313 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
5314 }
5315 }
5316 if (pProperties) {
5317 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
5318 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
5319 }
5320 }
5321 }
5322}
5323
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005324void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
5325 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
5326 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005327 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Nathaniel Cesario39152e62021-07-02 13:04:16 -06005328 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
5329 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
5330 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06005331 }
5332 }
5333}
5334
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01005335void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
5336 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
5337
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06005338 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01005339 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02005340 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01005341 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07005342 auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01005343 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07005344 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01005345 }
Rodrigo Locattic789fe82022-07-06 17:42:19 -03005346 cb->num_submits++;
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01005347 }
5348 }
5349}