blob: 5a8e01dd1ffd4fdef2f541b259041e9f9b2f17a7 [file] [log] [blame]
Jeremy Gebben610d3a62022-01-01 12:53:17 -07001/* Copyright (c) 2015-2022 The Khronos Group Inc.
2 * Copyright (c) 2015-2022 Valve Corporation
3 * Copyright (c) 2015-2022 LunarG, Inc.
Nadav Geva41c12a22021-05-21 13:14:05 -04004 * Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved.
Camdeneaa86ea2019-07-26 11:00:09 -06005 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *
18 * Author: Camden Stocker <camden@lunarg.com>
Nadav Geva41c12a22021-05-21 13:14:05 -040019 * Author: Nadav Geva <nadav.geva@amd.com>
Camdeneaa86ea2019-07-26 11:00:09 -060020 */
21
Mark Lobodzinski57b8ae82020-02-20 16:37:14 -070022#include "best_practices_validation.h"
Camden5b184be2019-08-13 07:50:19 -060023#include "layer_chassis_dispatch.h"
Camden Stocker0a660ce2019-08-27 15:30:40 -060024#include "best_practices_error_enums.h"
Sam Wallsd7ab6db2020-06-19 20:41:54 +010025#include "shader_validation.h"
Jeremy Gebbena3705f42021-01-19 16:47:43 -070026#include "sync_utils.h"
Jeremy Gebben159b3cc2021-06-03 09:09:03 -060027#include "cmd_buffer_state.h"
28#include "device_state.h"
29#include "render_pass_state.h"
Camden5b184be2019-08-13 07:50:19 -060030
31#include <string>
Sam Walls8e77e4f2020-03-16 20:47:40 +000032#include <bitset>
Sam Wallsd7ab6db2020-06-19 20:41:54 +010033#include <memory>
Camden5b184be2019-08-13 07:50:19 -060034
Attilio Provenzano19d6a982020-02-27 12:41:41 +000035struct VendorSpecificInfo {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060036 EnableFlags vendor_id;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000037 std::string name;
38};
39
LawG475463092022-02-22 10:45:54 +000040const std::map<BPVendorFlagBits, VendorSpecificInfo> kVendorInfo = {{kBPVendorArm, {vendor_specific_arm, "Arm"}},
41 {kBPVendorAMD, {vendor_specific_amd, "AMD"}},
Rodrigo Locattic779cb32022-02-25 19:26:31 -030042 {kBPVendorIMG, {vendor_specific_img, "IMG"}},
43 {kBPVendorNVIDIA, {vendor_specific_nvidia, "NVIDIA"}}};
Attilio Provenzano19d6a982020-02-27 12:41:41 +000044
Hannes Harnisch607d1d92021-07-10 18:44:56 +020045const SpecialUseVUIDs kSpecialUseInstanceVUIDs {
46 kVUID_BestPractices_CreateInstance_SpecialUseExtension_CADSupport,
47 kVUID_BestPractices_CreateInstance_SpecialUseExtension_D3DEmulation,
48 kVUID_BestPractices_CreateInstance_SpecialUseExtension_DevTools,
49 kVUID_BestPractices_CreateInstance_SpecialUseExtension_Debugging,
50 kVUID_BestPractices_CreateInstance_SpecialUseExtension_GLEmulation,
51};
52
53const SpecialUseVUIDs kSpecialUseDeviceVUIDs {
54 kVUID_BestPractices_CreateDevice_SpecialUseExtension_CADSupport,
55 kVUID_BestPractices_CreateDevice_SpecialUseExtension_D3DEmulation,
56 kVUID_BestPractices_CreateDevice_SpecialUseExtension_DevTools,
57 kVUID_BestPractices_CreateDevice_SpecialUseExtension_Debugging,
58 kVUID_BestPractices_CreateDevice_SpecialUseExtension_GLEmulation,
59};
60
Jeremy Gebben20da7a12022-02-25 14:07:46 -070061ReadLockGuard BestPractices::ReadLock() {
62 if (fine_grained_locking) {
63 return ReadLockGuard(validation_object_mutex, std::defer_lock);
64 } else {
65 return ReadLockGuard(validation_object_mutex);
66 }
67}
68
69WriteLockGuard BestPractices::WriteLock() {
70 if (fine_grained_locking) {
71 return WriteLockGuard(validation_object_mutex, std::defer_lock);
72 } else {
73 return WriteLockGuard(validation_object_mutex);
74 }
75}
76
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060077std::shared_ptr<CMD_BUFFER_STATE> BestPractices::CreateCmdBufferState(VkCommandBuffer cb,
78 const VkCommandBufferAllocateInfo* pCreateInfo,
Jeremy Gebbencd7fa282021-10-27 10:25:32 -060079 const COMMAND_POOL_STATE* pool) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -070080 return std::static_pointer_cast<CMD_BUFFER_STATE>(std::make_shared<bp_state::CommandBuffer>(this, cb, pCreateInfo, pool));
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060081}
82
Jeremy Gebben20da7a12022-02-25 14:07:46 -070083bp_state::CommandBuffer::CommandBuffer(BestPractices* bp, VkCommandBuffer cb, const VkCommandBufferAllocateInfo* pCreateInfo,
84 const COMMAND_POOL_STATE* pool)
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060085 : CMD_BUFFER_STATE(bp, cb, pCreateInfo, pool) {}
86
Attilio Provenzano19d6a982020-02-27 12:41:41 +000087bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070088 for (const auto& vendor : kVendorInfo) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060089 if (vendors & vendor.first && enabled[vendor.second.vendor_id]) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000090 return true;
91 }
92 }
93 return false;
94}
95
96const char* VendorSpecificTag(BPVendorFlags vendors) {
97 // Cache built vendor tags in a map
Jeremy Gebbencbf22862021-03-03 12:01:22 -070098 static layer_data::unordered_map<BPVendorFlags, std::string> tag_map;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000099
100 auto res = tag_map.find(vendors);
101 if (res == tag_map.end()) {
102 // Build the vendor tag string
103 std::stringstream vendor_tag;
104
105 vendor_tag << "[";
106 bool first_vendor = true;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700107 for (const auto& vendor : kVendorInfo) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +0000108 if (vendors & vendor.first) {
109 if (!first_vendor) {
110 vendor_tag << ", ";
111 }
112 vendor_tag << vendor.second.name;
113 first_vendor = false;
114 }
115 }
116 vendor_tag << "]";
117
118 tag_map[vendors] = vendor_tag.str();
119 res = tag_map.find(vendors);
120 }
121
122 return res->second.c_str();
123}
124
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700125const char* DepReasonToString(ExtDeprecationReason reason) {
126 switch (reason) {
127 case kExtPromoted:
128 return "promoted to";
129 break;
130 case kExtObsoleted:
131 return "obsoleted by";
132 break;
133 case kExtDeprecated:
134 return "deprecated by";
135 break;
136 default:
137 return "";
138 break;
139 }
140}
141
142bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version,
143 const char* vuid) const {
144 bool skip = false;
145 auto dep_info_it = deprecated_extensions.find(extension_name);
146 if (dep_info_it != deprecated_extensions.end()) {
147 auto dep_info = dep_info_it->second;
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600148 if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) ||
Tony-LunarGc30b59f2022-02-15 11:02:36 -0700149 ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2)) ||
150 ((dep_info.target.compare("VK_VERSION_1_3") == 0) && (version >= VK_API_VERSION_1_3))) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700151 skip |=
152 LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
153 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600154 } else if (dep_info.target.find("VK_VERSION") == std::string::npos) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700155 if (dep_info.target.length() == 0) {
156 skip |= LogWarning(instance, vuid,
157 "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated "
158 "without replacement.",
159 api_name, extension_name);
160 } else {
161 skip |= LogWarning(instance, vuid,
162 "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
163 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
164 }
165 }
166 }
167 return skip;
168}
169
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200170bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const SpecialUseVUIDs& special_use_vuids) const
171{
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700172 bool skip = false;
173 auto dep_info_it = special_use_extensions.find(extension_name);
174
175 if (dep_info_it != special_use_extensions.end()) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200176 const char* const format = "%s(): Attempting to enable extension %s, but this extension is intended to support %s "
177 "and it is strongly recommended that it be otherwise avoided.";
178 auto& special_uses = dep_info_it->second;
sfricke-samsungef15e482022-01-26 11:32:49 -0800179
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700180 if (special_uses.find("cadsupport") != std::string::npos) {
sfricke-samsungef15e482022-01-26 11:32:49 -0800181 skip |= LogWarning(instance, special_use_vuids.cadsupport, format, api_name, extension_name,
182 "specialized functionality used by CAD/CAM applications");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700183 }
184 if (special_uses.find("d3demulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200185 skip |= LogWarning(instance, special_use_vuids.d3demulation, format, api_name, extension_name,
186 "D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700187 }
188 if (special_uses.find("devtools") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200189 skip |= LogWarning(instance, special_use_vuids.devtools, format, api_name, extension_name,
190 "developer tools such as capture-replay libraries");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700191 }
192 if (special_uses.find("debugging") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200193 skip |= LogWarning(instance, special_use_vuids.debugging, format, api_name, extension_name,
194 "use by applications when debugging");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700195 }
196 if (special_uses.find("glemulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200197 skip |= LogWarning(instance, special_use_vuids.glemulation, format, api_name, extension_name,
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700198 "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality "
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200199 "specific to those APIs");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700200 }
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700201 }
202 return skip;
203}
204
Camden5b184be2019-08-13 07:50:19 -0600205bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500206 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600207 bool skip = false;
208
209 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
210 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800211 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700212 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
213 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600214 }
Mark Lobodzinski17d8dc62020-06-03 08:48:58 -0600215 uint32_t specified_version =
216 (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0);
217 skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700218 kVUID_BestPractices_CreateInstance_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200219 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseInstanceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600220 }
221
222 return skip;
223}
224
Camden5b184be2019-08-13 07:50:19 -0600225bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500226 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -0600227 bool skip = false;
228
229 // get API version of physical device passed when creating device.
230 VkPhysicalDeviceProperties physical_device_properties{};
231 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500232 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -0600233
234 // check api versions and warn if instance api Version is higher than version on device.
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600235 if (api_version > device_api_version) {
236 std::string inst_api_name = StringAPIVersion(api_version);
Mark Lobodzinski60880782020-08-11 08:02:07 -0600237 std::string dev_api_name = StringAPIVersion(device_api_version);
Camden5b184be2019-08-13 07:50:19 -0600238
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700239 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
240 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
241 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600242 }
243
Rodrigo Locattic2d5cf42022-03-01 18:05:26 -0300244 std::vector<std::string> extensions;
245 {
246 uint32_t property_count = 0;
247 if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, nullptr) == VK_SUCCESS) {
248 std::vector<VkExtensionProperties> property_list(property_count);
249 if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, property_list.data()) == VK_SUCCESS) {
250 extensions.reserve(property_list.size());
251 for (const VkExtensionProperties& properties : property_list) {
252 extensions.push_back(properties.extensionName);
253 }
254 }
255 }
256 }
257
Camden5b184be2019-08-13 07:50:19 -0600258 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300259 const char *extension_name = pCreateInfo->ppEnabledExtensionNames[i];
260
261 if (white_list(extension_name, kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800262 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700263 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300264 extension_name);
Camden5b184be2019-08-13 07:50:19 -0600265 }
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300266
267 skip |= ValidateDeprecatedExtensions("CreateDevice", extension_name, api_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700268 kVUID_BestPractices_CreateDevice_DeprecatedExtension);
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300269 skip |= ValidateSpecialUseExtensions("CreateDevice", extension_name, kSpecialUseDeviceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600270 }
271
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700272 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600273 if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700274 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
275 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600276 }
277
LawG43f848c72022-02-23 09:35:21 +0000278 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorIMG)) &&
279 (pCreateInfo->pEnabledFeatures != nullptr) && (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
Szilard Papp7d2c7952020-06-22 14:38:13 +0100280 skip |= LogPerformanceWarning(
281 device, kVUID_BestPractices_CreateDevice_RobustBufferAccess,
LawG4015be1c2022-03-01 10:37:52 +0000282 "%s %s %s: vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during "
Szilard Papp7d2c7952020-06-22 14:38:13 +0100283 "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage "
284 "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case "
285 "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.",
LawG43f848c72022-02-23 09:35:21 +0000286 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorIMG));
Szilard Papp7d2c7952020-06-22 14:38:13 +0100287 }
288
Rodrigo Locatti8dde2ff2022-03-01 18:06:08 -0300289 const bool enabled_pageable_device_local_memory = IsExtEnabled(device_extensions.vk_ext_pageable_device_local_memory);
290 if (VendorCheckEnabled(kBPVendorNVIDIA) && !enabled_pageable_device_local_memory &&
291 std::find(extensions.begin(), extensions.end(), VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME) != extensions.end()) {
292 skip |= LogPerformanceWarning(
293 device, kVUID_BestPractices_CreateDevice_PageableDeviceLocalMemory,
294 "%s vkCreateDevice() called without pageable device local memory. "
295 "Use pageableDeviceLocalMemory from VK_EXT_pageable_device_local_memory when it is available.",
296 VendorSpecificTag(kBPVendorNVIDIA));
297 }
298
Camden5b184be2019-08-13 07:50:19 -0600299 return skip;
300}
301
302bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500303 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600304 bool skip = false;
305
306 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700307 std::stringstream buffer_hex;
308 buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer);
Camden5b184be2019-08-13 07:50:19 -0600309
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700310 skip |= LogWarning(
311 device, kVUID_BestPractices_SharingModeExclusive,
312 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
313 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700314 buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600315 }
316
317 return skip;
318}
319
320bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500321 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600322 bool skip = false;
323
324 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700325 std::stringstream image_hex;
326 image_hex << "0x" << std::hex << HandleToUint64(pImage);
Camden5b184be2019-08-13 07:50:19 -0600327
328 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700329 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
330 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
331 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700332 image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600333 }
334
ziga-lunarg6df3d102022-03-18 17:02:14 +0100335 if ((pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT) && !(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
336 skip |= LogWarning(device, kVUID_BestPractices_ImageCreateFlags,
337 "vkCreateImage(): pCreateInfo->flags has VK_IMAGE_CREATE_EXTENDED_USAGE_BIT set, but not "
338 "VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, therefore image views created from this image will have to use the "
339 "same format and VK_IMAGE_CREATE_EXTENDED_USAGE_BIT will not have any effect.");
340 }
341
LawG4655f59c2022-02-23 13:55:55 +0000342 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000343 if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
344 skip |= LogPerformanceWarning(
345 device, kVUID_BestPractices_CreateImage_NonTransientMSImage,
LawG4655f59c2022-02-23 13:55:55 +0000346 "%s %s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have "
Attilio Provenzano02859b22020-02-27 14:17:28 +0000347 "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, "
348 "and do not need to be backed by physical storage. "
349 "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.",
LawG4655f59c2022-02-23 13:55:55 +0000350 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Attilio Provenzano02859b22020-02-27 14:17:28 +0000351 }
352 }
353
LawG4ba113892022-02-23 14:39:02 +0000354 if (VendorCheckEnabled(kBPVendorArm) && pCreateInfo->samples > kMaxEfficientSamplesArm) {
355 skip |= LogPerformanceWarning(
356 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
357 "%s vkCreateImage(): Trying to create an image with %u samples. "
358 "The hardware revision may not have full throughput for framebuffers with more than %u samples.",
359 VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm);
360 }
361
362 if (VendorCheckEnabled(kBPVendorIMG) && pCreateInfo->samples > kMaxEfficientSamplesImg) {
363 skip |= LogPerformanceWarning(
364 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
365 "%s vkCreateImage(): Trying to create an image with %u samples. "
366 "The device may not have full support for true multisampling for images with more than %u samples. "
367 "XT devices support up to 8 samples, XE up to 4 samples.",
368 VendorSpecificTag(kBPVendorIMG), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesImg);
369 }
370
LawG4db16f802022-03-21 17:33:39 +0000371 if (VendorCheckEnabled(kBPVendorIMG) && (pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG ||
372 pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG ||
373 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG ||
374 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG ||
375 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG ||
376 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG ||
377 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG ||
378 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG)) {
379 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Texture_Format_PVRTC_Outdated,
380 "%s vkCreateImage(): Trying to create an image with a PVRTC format. Both PVRTC1 and PVRTC2 "
381 "are slower than standard image formats on PowerVR GPUs, prefer ETC, BC, ASTC, etc.",
382 VendorSpecificTag(kBPVendorIMG));
383 }
384
Nadav Gevaf0808442021-05-21 13:51:25 -0400385 if (VendorCheckEnabled(kBPVendorAMD)) {
386 std::stringstream image_hex;
387 image_hex << "0x" << std::hex << HandleToUint64(pImage);
388
389 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
390 (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) {
391 skip |= LogPerformanceWarning(device,
392 kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets,
393 "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. "
394 "Using a SHARING_MODE_CONCURRENT "
395 "is not recommended with color and depth targets",
396 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
397 }
398
399 if ((pCreateInfo->usage &
400 (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
401 (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
402 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets,
403 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. "
404 "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets",
405 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
406 }
407
408 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
409 (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
410 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets,
411 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a "
412 "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets",
413 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
414 }
415 }
416
Rodrigo Locatti5466f9d2022-03-09 18:20:38 -0300417 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
418 std::stringstream image_hex;
419 image_hex << "0x" << std::hex << HandleToUint64(pImage);
420
421 if (pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) {
422 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateImage_TilingLinear,
423 "%s Performance warning: image (%s) is created with tiling VK_IMAGE_TILING_LINEAR. "
424 "Use VK_IMAGE_TILING_OPTIMAL instead.",
425 VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str());
426 }
Rodrigo Locatti3290c2b2022-03-09 18:25:56 -0300427
428 if (pCreateInfo->format == VK_FORMAT_D32_SFLOAT || pCreateInfo->format == VK_FORMAT_D32_SFLOAT_S8_UINT) {
429 skip |= LogPerformanceWarning(
430 device, kVUID_BestPractices_CreateImage_Depth32Format,
431 "%s Performance warning: image (%s) is created with a 32-bit depth format. Use VK_FORMAT_D24_UNORM_S8_UINT or "
432 "VK_FORMAT_D16_UNORM instead, unless the extra precision is needed.",
433 VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str());
434 }
Rodrigo Locatti5466f9d2022-03-09 18:20:38 -0300435 }
436
Camden5b184be2019-08-13 07:50:19 -0600437 return skip;
438}
439
440bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500441 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600442 bool skip = false;
443
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600444 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600445 if (bp_pd_state) {
446 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
447 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
448 "vkCreateSwapchainKHR() called before getting surface capabilities from "
449 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
450 }
Camden83a9c372019-08-14 11:41:38 -0600451
Shannon McPherson73e58c82021-03-05 17:14:26 -0700452 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
453 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600454 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
455 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
456 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
457 }
Camden83a9c372019-08-14 11:41:38 -0600458
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600459 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
460 skip |= LogWarning(
461 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
462 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
463 }
Camden83a9c372019-08-14 11:41:38 -0600464 }
465
Camden5b184be2019-08-13 07:50:19 -0600466 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700467 skip |=
468 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600469 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700470 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
471 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600472 }
473
ziga-lunarg79beba62022-03-30 01:17:30 +0200474 const auto present_mode = pCreateInfo->presentMode;
475 if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) &&
476 (pCreateInfo->minImageCount == 2)) {
Szilard Papp48a6da32020-06-10 14:41:59 +0100477 skip |= LogPerformanceWarning(
478 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
479 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
480 ", which means double buffering is going "
481 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
482 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
483 "3 to use triple buffering to maximize performance in such cases.",
484 pCreateInfo->minImageCount);
485 }
486
Szilard Pappd5f0f812020-06-22 09:01:29 +0100487 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
488 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
489 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
490 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
491 "Presentation modes which are not FIFO will present the latest available frame and discard other "
492 "frame(s) if any.",
493 VendorSpecificTag(kBPVendorArm));
494 }
495
Camden5b184be2019-08-13 07:50:19 -0600496 return skip;
497}
498
499bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
500 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500501 const VkAllocationCallbacks* pAllocator,
502 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600503 bool skip = false;
504
505 for (uint32_t i = 0; i < swapchainCount; i++) {
506 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700507 skip |= LogWarning(
508 device, kVUID_BestPractices_SharingModeExclusive,
509 "Warning: A shared swapchain (index %" PRIu32
510 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
511 "queues (queueFamilyIndexCount of %" PRIu32 ").",
512 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600513 }
514 }
515
516 return skip;
517}
518
519bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500520 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600521 bool skip = false;
522
523 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
524 VkFormat format = pCreateInfo->pAttachments[i].format;
525 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
526 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
527 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700528 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
529 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
530 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
531 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
532 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600533 }
534 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700535 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
536 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
537 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
538 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
539 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600540 }
541 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000542
543 const auto& attachment = pCreateInfo->pAttachments[i];
544 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
545 bool access_requires_memory =
546 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
547
548 if (FormatHasStencil(format)) {
549 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
550 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
551 }
552
553 if (access_requires_memory) {
554 skip |= LogPerformanceWarning(
555 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
556 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
557 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
558 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
559 i, static_cast<uint32_t>(attachment.samples));
560 }
561 }
Camden5b184be2019-08-13 07:50:19 -0600562 }
563
564 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
565 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
566 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
567 }
568
569 return skip;
570}
571
Tony-LunarG767180f2020-04-23 14:03:59 -0600572bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
573 const VkImageView* image_views) const {
574 bool skip = false;
575
576 // Check for non-transient attachments that should be transient and vice versa
577 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200578 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600579 bool attachment_should_be_transient =
580 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
581
582 if (FormatHasStencil(attachment.format)) {
583 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
584 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
585 }
586
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600587 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600588 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600589 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600590
591 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
592
593 // The check for an image that should not be transient applies to all GPUs
594 if (!attachment_should_be_transient && image_is_transient) {
595 skip |= LogPerformanceWarning(
596 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
597 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
598 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
599 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
600 i);
601 }
602
603 bool supports_lazy = false;
604 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
605 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
606 supports_lazy = true;
607 }
608 }
609
610 // The check for an image that should be transient only applies to GPUs supporting
611 // lazily allocated memory
612 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
613 skip |= LogPerformanceWarning(
614 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
615 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
616 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
617 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
618 i);
619 }
620 }
621 }
622 return skip;
623}
624
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000625bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
626 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
627 bool skip = false;
628
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600629 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800630 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600631 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000632 }
633
634 return skip;
635}
636
Sam Wallse746d522020-03-16 21:20:23 +0000637bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
638 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
639 bool skip = false;
640 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
641
642 if (!skip) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700643 const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000644 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
645 // this warning is specific to Arm
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700646 if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) {
Sam Wallse746d522020-03-16 21:20:23 +0000647 skip |= LogPerformanceWarning(
648 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
649 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
650 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
651 VendorSpecificTag(kBPVendorArm));
652 }
ziga-lunarg5a76c442022-04-17 18:04:08 +0200653
654 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
655 // Track number of descriptorSets allowable in this pool
656 if (pool_state->GetAvailableSets() < pAllocateInfo->descriptorSetCount) {
657 skip |= LogWarning(pool_state->Handle(), kVUID_BestPractices_EmptyDescriptorPool,
658 "vkAllocateDescriptorSets(): Unable to allocate %" PRIu32 " descriptorSets from %s"
659 ". This pool only has %" PRIu32 " descriptorSets remaining.",
660 pAllocateInfo->descriptorSetCount, report_data->FormatHandle(pool_state->Handle()).c_str(),
661 pool_state->GetAvailableSets());
662 }
663 }
Sam Wallse746d522020-03-16 21:20:23 +0000664 }
665
666 return skip;
667}
668
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600669void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
670 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000671 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700672 auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
673 if (pool_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000674 // we record successful allocations by subtracting the allocation count from the last recorded free count
675 const auto alloc_count = pAllocateInfo->descriptorSetCount;
676 // clamp the unsigned subtraction to the range [0, last_free_count]
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700677 if (pool_state->freed_count > alloc_count) {
678 pool_state->freed_count -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700679 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700680 pool_state->freed_count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700681 }
Sam Wallse746d522020-03-16 21:20:23 +0000682 }
683 }
684}
685
686void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
687 const VkDescriptorSet* pDescriptorSets, VkResult result) {
688 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
689 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700690 auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000691 // we want to track frees because we're interested in suggesting re-use
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700692 if (pool_state) {
693 pool_state->freed_count += descriptorSetCount;
Sam Wallse746d522020-03-16 21:20:23 +0000694 }
695 }
696}
697
Camden5b184be2019-08-13 07:50:19 -0600698bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500699 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600700 bool skip = false;
701
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700702 if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700703 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
704 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600705 }
706
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000707 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
708 skip |= LogPerformanceWarning(
709 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600710 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
711 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000712 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
713 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
714 }
715
Rodrigo Locattie4f8d522022-03-15 16:30:49 -0300716 if (VendorCheckEnabled(kBPVendorNVIDIA) && !device_extensions.vk_ext_pageable_device_local_memory &&
717 !LvlFindInChain<VkMemoryPriorityAllocateInfoEXT>(pAllocateInfo->pNext)) {
718 skip |= LogPerformanceWarning(
719 device, kVUID_BestPractices_AllocateMemory_SetPriority,
720 "%s Use VkMemoryPriorityAllocateInfoEXT to provide the operating system information on the allocations that "
721 "should stay in video memory and which should be demoted first when video memory is limited. "
722 "The highest priority should be given to GPU-written resources like color attachments, depth attachments, "
723 "storage images, and buffers written from the GPU.",
724 VendorSpecificTag(kBPVendorNVIDIA));
725 }
726
Camden83a9c372019-08-14 11:41:38 -0600727 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
728
729 return skip;
730}
731
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600732void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
733 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
734 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700735 if (result != VK_SUCCESS) {
736 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
737 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800738 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700739 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600740 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700741 return;
742 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700743}
Camden Stocker9738af92019-10-16 13:54:03 -0700744
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600745void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
746 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700747 auto error = std::find(error_codes.begin(), error_codes.end(), result);
748 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000749 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
750 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
751
752 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
753 if (common_failure != common_failure_codes.end()) {
754 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
755 } else {
756 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
757 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700758 return;
759 }
760 auto success = std::find(success_codes.begin(), success_codes.end(), result);
761 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600762 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
763 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500764 }
765}
766
Jeff Bolz5c801d12019-10-09 10:38:45 -0500767bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
768 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700769 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600770 bool skip = false;
771
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700772 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600773
Jeremy Gebben610d3a62022-01-01 12:53:17 -0700774 for (const auto& item : mem_info->ObjectBindings()) {
775 const auto& obj = item.first;
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600776 LogObjectList objlist(device);
777 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600778 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600779 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 -0600780 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600781 }
782
Camden5b184be2019-08-13 07:50:19 -0600783 return skip;
784}
785
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000786bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600787 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700788 auto buffer_state = Get<BUFFER_STATE>(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600789
sfricke-samsunge2441192019-11-06 14:07:57 -0800790 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700791 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
792 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
793 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600794 }
795
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700796 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000797
AndreyVK_D3D0416a332021-11-02 23:22:28 +0300798 if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000799 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
800 skip |= LogPerformanceWarning(
801 device, kVUID_BestPractices_SmallDedicatedAllocation,
802 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600803 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
804 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000805 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
806 }
807
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300808 skip |= ValidateBindMemory(device, memory);
809
Camden Stockerb603cc82019-09-03 10:09:02 -0600810 return skip;
811}
812
813bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500814 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600815 bool skip = false;
816 const char* api_name = "BindBufferMemory()";
817
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000818 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600819
820 return skip;
821}
822
823bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500824 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600825 char api_name[64];
826 bool skip = false;
827
828 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200829 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000830 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600831 }
832
833 return skip;
834}
Camden Stockerb603cc82019-09-03 10:09:02 -0600835
836bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500837 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600838 char api_name[64];
839 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600840
Camden Stocker8b798ab2019-09-03 10:33:28 -0600841 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200842 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000843 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600844 }
845
846 return skip;
847}
848
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000849bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600850 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700851 auto image_state = Get<IMAGE_STATE>(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600852
sfricke-samsung71bc6572020-04-29 15:49:43 -0700853 if (image_state->disjoint == false) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600854 if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700855 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
856 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
857 api_name, report_data->FormatHandle(image).c_str());
858 }
859 } else {
860 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
861 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600862 }
863
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700864 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000865
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600866 if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000867 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
868 skip |= LogPerformanceWarning(
869 device, kVUID_BestPractices_SmallDedicatedAllocation,
870 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600871 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
872 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000873 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
874 }
875
876 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
877 // make sure this type is actually used.
878 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
879 // (i.e.most tile - based renderers)
880 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
881 bool supports_lazy = false;
882 uint32_t suggested_type = 0;
883
884 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600885 if ((1u << i) & image_state->requirements[0].memoryTypeBits) {
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000886 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
887 supports_lazy = true;
888 suggested_type = i;
889 break;
890 }
891 }
892 }
893
894 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
895
896 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
897 skip |= LogPerformanceWarning(
898 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600899 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000900 "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 -0600901 "%" PRIu64 " bytes of physical memory.",
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600902 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000903 }
904 }
905
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300906 skip |= ValidateBindMemory(device, memory);
907
Camden Stocker8b798ab2019-09-03 10:33:28 -0600908 return skip;
909}
910
911bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500912 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600913 bool skip = false;
914 const char* api_name = "vkBindImageMemory()";
915
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000916 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600917
918 return skip;
919}
920
921bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500922 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600923 char api_name[64];
924 bool skip = false;
925
926 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200927 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700928 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -0600929 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
930 }
Camden Stocker8b798ab2019-09-03 10:33:28 -0600931 }
932
933 return skip;
934}
935
936bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500937 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600938 char api_name[64];
939 bool skip = false;
940
941 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200942 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000943 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600944 }
945
946 return skip;
947}
Camden83a9c372019-08-14 11:41:38 -0600948
Rodrigo Locatti66b23352022-03-15 17:28:32 -0300949void BestPractices::PreCallRecordSetDeviceMemoryPriorityEXT(VkDevice device, VkDeviceMemory memory, float priority) {
950 auto mem_info = std::static_pointer_cast<bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory));
951 mem_info->dynamic_priority.emplace(priority);
952}
953
Attilio Provenzano02859b22020-02-27 14:17:28 +0000954static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
955 switch (format) {
956 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
957 case VK_FORMAT_R16_SFLOAT:
958 case VK_FORMAT_R16G16_SFLOAT:
959 case VK_FORMAT_R16G16B16_SFLOAT:
960 case VK_FORMAT_R16G16B16A16_SFLOAT:
961 case VK_FORMAT_R32_SFLOAT:
962 case VK_FORMAT_R32G32_SFLOAT:
963 case VK_FORMAT_R32G32B32_SFLOAT:
964 case VK_FORMAT_R32G32B32A32_SFLOAT:
965 return false;
966
967 default:
968 return true;
969 }
970}
971
972bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
973 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
974 bool skip = false;
975
976 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700977 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000978
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700979 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
980 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
981 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000982 return skip;
983 }
984
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600985 auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200986 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000987
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +0200988 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
989 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount);
990
991 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200992 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000993 uint32_t att = subpass.pColorAttachments[j].attachment;
994
995 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
996 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
997 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
998 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
999 "color attachment #%u makes use "
1000 "of a format which cannot be blended at full throughput when using MSAA.",
1001 VendorSpecificTag(kBPVendorArm), i, j);
1002 }
1003 }
1004 }
1005 }
1006
1007 return skip;
1008}
1009
Nadav Gevaf0808442021-05-21 13:51:25 -04001010void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1011 const VkComputePipelineCreateInfo* pCreateInfos,
1012 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1013 VkResult result, void* pipe_state) {
1014 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001015 pipeline_cache_ = pipelineCache;
Nadav Gevaf0808442021-05-21 13:51:25 -04001016}
1017
Camden5b184be2019-08-13 07:50:19 -06001018bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1019 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001020 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001021 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001022 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1023 pAllocator, pPipelines, cgpl_state_data);
ziga-lunarg08c81582022-03-08 17:33:45 +01001024 if (skip) {
1025 return skip;
1026 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001027 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001028
1029 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001030 skip |= LogPerformanceWarning(
1031 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1032 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
1033 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001034 }
1035
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001036 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001037 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001038
Tony-LunarGb6a2daf2022-07-29 11:30:55 -06001039 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 +02001040 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001041 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001042 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
1043 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001044 count++;
1045 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001046 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001047 if (count > kMaxInstancedVertexBuffers) {
1048 skip |= LogPerformanceWarning(
1049 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
1050 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
1051 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
1052 count, kMaxInstancedVertexBuffers);
1053 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001054 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001055
Szilard Pappaaf2da32020-06-22 10:37:35 +01001056 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
1057 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001058 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
1059 VendorCheckEnabled(kBPVendorArm)) {
1060 skip |= LogPerformanceWarning(
1061 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
1062 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
1063 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
1064 "efficiency during rasterization. Consider disabling depthBias or increasing either "
1065 "depthBiasConstantFactor or depthBiasSlopeFactor.",
1066 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +01001067 }
1068
Attilio Provenzano02859b22020-02-27 14:17:28 +00001069 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001070 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001071 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001072 auto prev_pipeline = pipeline_cache_.load();
1073 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001074 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
1075 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
1076 "improve cache hit rate", VendorSpecificTag(kBPVendorAMD));
1077 }
1078
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001079 if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001080 skip |=
1081 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
1082 "%s Performance warning: Too many pipelines created, consider consolidation",
1083 VendorSpecificTag(kBPVendorAMD));
1084 }
1085
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -06001086 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001087 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
1088 "%s Performance warning: Use of primitive restart is not recommended",
1089 VendorSpecificTag(kBPVendorAMD));
1090 }
1091
1092 // TODO: this might be too aggressive of a check
1093 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1094 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1095 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1096 VendorSpecificTag(kBPVendorAMD));
1097 }
1098 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001099
Camden5b184be2019-08-13 07:50:19 -06001100 return skip;
1101}
1102
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001103static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info,
1104 std::shared_ptr<const RENDER_PASS_STATE>& rp) {
1105 std::vector<bp_state::AttachmentInfo> result;
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06001106 if (!rp || rp->UsesDynamicRendering()) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001107 return result;
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001108 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001109
1110 const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1111
1112 // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState
1113 // are only non-null if they are enabled.
1114 if (create_info.pColorBlendState) {
1115 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1116 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount);
1117 for (uint32_t j = 0; j < num_color_attachments; j++) {
1118 if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) {
1119 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1120 if (attachment != VK_ATTACHMENT_UNUSED) {
1121 result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT});
1122 }
1123 }
1124 }
1125 }
1126
1127 if (create_info.pDepthStencilState &&
1128 (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable ||
1129 create_info.pDepthStencilState->stencilTestEnable)) {
1130 uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED;
1131 if (attachment != VK_ATTACHMENT_UNUSED) {
1132 VkImageAspectFlags aspects = 0;
1133 if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) {
1134 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1135 }
1136 if (create_info.pDepthStencilState->stencilTestEnable) {
1137 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1138 }
1139 result.push_back({attachment, aspects});
1140 }
1141 }
1142 return result;
1143}
1144
1145bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo,
1146 std::shared_ptr<const RENDER_PASS_STATE>&& rpstate,
1147 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout)
1148 : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)),
1149 access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {}
1150
1151std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState(
1152 const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass,
1153 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const {
1154 return std::static_pointer_cast<PIPELINE_STATE>(
1155 std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout)));
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001156}
1157
Sam Walls0961ec02020-03-31 16:39:15 +01001158void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1159 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1160 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1161 VkResult result, void* cgpl_state_data) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001162 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001163 pipeline_cache_ = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001164}
1165
Camden5b184be2019-08-13 07:50:19 -06001166bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1167 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001168 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001169 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001170 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1171 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001172
1173 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001174 skip |= LogPerformanceWarning(
1175 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1176 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1177 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001178 }
1179
Nadav Gevaf0808442021-05-21 13:51:25 -04001180 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001181 auto prev_pipeline = pipeline_cache_.load();
1182 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
1183 skip |= LogPerformanceWarning(
1184 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1185 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
Nadav Gevaf0808442021-05-21 13:51:25 -04001186 "improve cache hit rate",
1187 VendorSpecificTag(kBPVendorAMD));
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001188 }
1189 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001190
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001191 for (uint32_t i = 0; i < createInfoCount; i++) {
1192 const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i];
1193 if (VendorCheckEnabled(kBPVendorArm)) {
1194 skip |= ValidateCreateComputePipelineArm(createInfo);
1195 }
sfricke-samsung86d055a2022-02-11 14:43:50 -08001196
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001197 if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) {
1198 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
1199 for (const auto& builtin : module_state->static_data_.builtin_decoration_list) {
1200 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1201 skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize,
1202 "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32
1203 "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 "
1204 "extension exposes a new LocalSizeId execution mode that should be used instead.",
1205 i);
sfricke-samsung86d055a2022-02-11 14:43:50 -08001206 }
1207 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001208 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001209 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001210
1211 return skip;
1212}
1213
1214bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1215 bool skip = false;
sfricke-samsungef15e482022-01-26 11:32:49 -08001216 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001217 // Generate warnings about work group sizes based on active resources.
sfricke-samsungef15e482022-01-26 11:32:49 -08001218 auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
1219 if (entrypoint == module_state->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001220
1221 uint32_t x = 1, y = 1, z = 1;
sfricke-samsungef15e482022-01-26 11:32:49 -08001222 module_state->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001223
1224 uint32_t thread_count = x * y * z;
1225
1226 // Generate a priori warnings about work group sizes.
1227 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1228 skip |= LogPerformanceWarning(
1229 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1230 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1231 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1232 "groups with less than %u threads, especially when using barrier() or shared memory.",
1233 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1234 }
1235
1236 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1237 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1238 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1239 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1240 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1241 "%u, %u) is not aligned to %u "
1242 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1243 "leave threads idle on the shader "
1244 "core.",
1245 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1246 kThreadGroupDispatchCountAlignmentArm);
1247 }
1248
sfricke-samsungef15e482022-01-26 11:32:49 -08001249 auto accessible_ids = module_state->MarkAccessibleIds(entrypoint);
1250 auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001251
1252 unsigned dimensions = 0;
1253 if (x > 1) dimensions++;
1254 if (y > 1) dimensions++;
1255 if (z > 1) dimensions++;
1256 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1257 dimensions = std::max(dimensions, 1u);
1258
1259 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1260 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1261 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1262 bool accesses_2d = false;
1263 for (const auto& usage : descriptor_uses) {
sfricke-samsungef15e482022-01-26 11:32:49 -08001264 auto dim = module_state->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001265 if (dim < 0) continue;
1266 auto spvdim = spv::Dim(dim);
1267 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1268 }
1269
1270 if (accesses_2d && dimensions < 2) {
1271 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1272 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1273 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1274 "exhibiting poor spatial locality with respect to one or more shader resources.",
1275 VendorSpecificTag(kBPVendorArm), x, y, z);
1276 }
1277
Camden5b184be2019-08-13 07:50:19 -06001278 return skip;
1279}
1280
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001281bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001282 bool skip = false;
1283
1284 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001285 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1286 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001287 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001288 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1289 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001290 }
1291
1292 return skip;
1293}
1294
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001295bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1296 bool skip = false;
1297
1298 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1299 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1300 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1301 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1302 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1303 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1304 }
1305
1306 return skip;
1307}
1308
1309bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1310 bool skip = false;
1311 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1312
1313 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1314 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1315
1316 return skip;
1317}
1318
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001319void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001320 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1321 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1322 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1323 LogPerformanceWarning(
1324 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1325 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1326 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1327 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1328 "convenient opportunity.",
1329 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1330 }
1331 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001332
1333 // AMD best practice
1334 // end-of-frame cleanup
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001335 num_queue_submissions_ = 0;
1336 num_barriers_objects_ = 0;
1337 ClearPipelinesUsedInFrame();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001338}
1339
Jeff Bolz5c801d12019-10-09 10:38:45 -05001340bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1341 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001342 bool skip = false;
1343
1344 for (uint32_t submit = 0; submit < submitCount; submit++) {
1345 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1346 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1347 }
ziga-lunargc77f0c02022-04-18 00:15:16 +02001348 if (pSubmits[submit].signalSemaphoreCount == 0 && pSubmits[submit].pSignalSemaphores != nullptr) {
1349 skip |=
1350 LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1351 "pSubmits[%" PRIu32 "].pSignalSemaphores is set, but pSubmits[%" PRIu32 "].signalSemaphoreCount is 0.",
1352 submit, submit);
1353 }
1354 if (pSubmits[submit].waitSemaphoreCount == 0 && pSubmits[submit].pWaitSemaphores != nullptr) {
1355 skip |= LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1356 "pSubmits[%" PRIu32 "].pWaitSemaphores is set, but pSubmits[%" PRIu32 "].waitSemaphoreCount is 0.",
1357 submit, submit);
1358 }
Camden5b184be2019-08-13 07:50:19 -06001359 }
1360
1361 return skip;
1362}
1363
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001364bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1365 VkFence fence) const {
1366 bool skip = false;
1367
1368 for (uint32_t submit = 0; submit < submitCount; submit++) {
1369 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1370 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1371 }
1372 }
1373
1374 return skip;
1375}
1376
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001377bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits,
1378 VkFence fence) const {
1379 bool skip = false;
1380
1381 for (uint32_t submit = 0; submit < submitCount; submit++) {
1382 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1383 skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1384 }
1385 }
1386
1387 return skip;
1388}
1389
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001390bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1391 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1392 bool skip = false;
1393
1394 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1395 skip |= LogPerformanceWarning(
1396 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1397 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1398 "pool instead.");
1399 }
1400
1401 return skip;
1402}
1403
1404bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1405 const VkCommandBufferBeginInfo* pBeginInfo) const {
1406 bool skip = false;
1407
1408 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1409 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1410 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1411 }
1412
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001413 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1414 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001415 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1416 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1417 VendorSpecificTag(kBPVendorArm));
1418 }
1419
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001420 return skip;
1421}
1422
Jeff Bolz5c801d12019-10-09 10:38:45 -05001423bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001424 bool skip = false;
1425
1426 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1427
1428 return skip;
1429}
1430
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001431bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1432 const VkDependencyInfoKHR* pDependencyInfo) const {
1433 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1434}
1435
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001436bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1437 const VkDependencyInfo* pDependencyInfo) const {
1438 return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo);
1439}
1440
Jeff Bolz5c801d12019-10-09 10:38:45 -05001441bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1442 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001443 bool skip = false;
1444
1445 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1446
1447 return skip;
1448}
1449
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001450bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1451 VkPipelineStageFlags2KHR stageMask) const {
1452 bool skip = false;
1453
1454 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1455
1456 return skip;
1457}
1458
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001459bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1460 VkPipelineStageFlags2 stageMask) const {
1461 bool skip = false;
1462
1463 skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask);
1464
1465 return skip;
1466}
1467
Camden5b184be2019-08-13 07:50:19 -06001468bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1469 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1470 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1471 uint32_t bufferMemoryBarrierCount,
1472 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1473 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001474 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001475 bool skip = false;
1476
1477 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1478 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1479
1480 return skip;
1481}
1482
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001483bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1484 const VkDependencyInfoKHR* pDependencyInfos) const {
1485 bool skip = false;
1486 for (uint32_t i = 0; i < eventCount; i++) {
1487 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1488 }
1489
1490 return skip;
1491}
1492
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001493bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1494 const VkDependencyInfo* pDependencyInfos) const {
1495 bool skip = false;
1496 for (uint32_t i = 0; i < eventCount; i++) {
1497 skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]);
1498 }
1499
1500 return skip;
1501}
1502
Camden5b184be2019-08-13 07:50:19 -06001503bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1504 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1505 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1506 uint32_t bufferMemoryBarrierCount,
1507 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1508 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001509 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001510 bool skip = false;
1511
1512 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1513 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1514
ziga-lunargb65dbfb2022-03-19 18:45:09 +01001515 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1516 if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED &&
1517 IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) {
1518 skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly,
1519 "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents "
1520 "may be discarded, but the newLayout is %s, which is read only.",
1521 string_VkImageLayout(pImageMemoryBarriers[i].newLayout));
1522 }
1523 }
1524
Nadav Gevaf0808442021-05-21 13:51:25 -04001525 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001526 auto num = num_barriers_objects_.load();
1527 if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001528 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001529 "%s Performance warning: In this frame, %" PRIu32
1530 " barriers were already submitted. Barriers have a high cost and can "
1531 "stall the GPU. "
1532 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1533 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04001534 }
1535
1536 std::array<VkImageLayout, 3> read_layouts = {
1537 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1538 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1539 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1540 };
1541
1542 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1543 // read to read barriers
1544 auto found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].oldLayout);
1545 bool old_is_read_layout = found != read_layouts.end();
1546 found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].newLayout);
1547 bool new_is_read_layout = found != read_layouts.end();
1548 if (old_is_read_layout && new_is_read_layout) {
1549 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
1550 "%s Performance warning: Don't issue read-to-read barriers. Get the resource in the right state the first "
1551 "time you use it.",
1552 VendorSpecificTag(kBPVendorAMD));
1553 }
1554
1555 // general with no storage
1556 if (pImageMemoryBarriers[i].newLayout == VK_IMAGE_LAYOUT_GENERAL) {
1557 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1558 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1559 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1560 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1561 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1562 VendorSpecificTag(kBPVendorAMD));
1563 }
1564 }
1565 }
1566 }
1567
Camden5b184be2019-08-13 07:50:19 -06001568 return skip;
1569}
1570
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001571bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1572 const VkDependencyInfoKHR* pDependencyInfo) const {
1573 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1574}
1575
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001576bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer,
1577 const VkDependencyInfo* pDependencyInfo) const {
1578 return CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo);
1579}
1580
Camden5b184be2019-08-13 07:50:19 -06001581bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001582 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001583 bool skip = false;
1584
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001585 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1586
1587 return skip;
1588}
1589
1590bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1591 VkQueryPool queryPool, uint32_t query) const {
1592 bool skip = false;
1593
1594 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001595
1596 return skip;
1597}
1598
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001599bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage,
1600 VkQueryPool queryPool, uint32_t query) const {
1601 bool skip = false;
1602
1603 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage);
1604
1605 return skip;
1606}
1607
Sam Walls0961ec02020-03-31 16:39:15 +01001608void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1609 VkPipeline pipeline) {
1610 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1611
Nadav Gevaf0808442021-05-21 13:51:25 -04001612 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001613 PipelineUsedInFrame(pipeline);
Nadav Gevaf0808442021-05-21 13:51:25 -04001614
Sam Walls0961ec02020-03-31 16:39:15 +01001615 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001616 auto pipeline_state = Get<bp_state::Pipeline>(pipeline);
Sam Walls0961ec02020-03-31 16:39:15 +01001617 // check for depth/blend state tracking
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001618 if (pipeline_state) {
1619 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001620 assert(cb_node);
1621 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001622
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001623 render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments;
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001624 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001625
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07001626 const auto* blend_state = pipeline_state->ColorBlendState();
1627 const auto* stencil_state = pipeline_state->DepthStencilState();
Sam Walls0961ec02020-03-31 16:39:15 +01001628
1629 if (blend_state) {
1630 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001631 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001632 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1633 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001634 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001635 }
1636 }
1637 }
1638
1639 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001640 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001641
1642 if (stencil_state && stencil_state->depthTestEnable) {
1643 switch (stencil_state->depthCompareOp) {
1644 case VK_COMPARE_OP_EQUAL:
1645 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1646 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001647 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001648 break;
1649 default:
1650 break;
1651 }
1652 }
Sam Walls0961ec02020-03-31 16:39:15 +01001653 }
1654 }
1655}
1656
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02001657static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1658 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
1659 const auto& subpass_info = createInfo.pSubpasses[subpass];
1660 if (subpass_info.pResolveAttachments) {
1661 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1662 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1663 }
1664 }
1665 }
1666
1667 return false;
1668}
1669
Attilio Provenzano02859b22020-02-27 14:17:28 +00001670static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1671 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001672 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001673
1674 // If an attachment is ever used as a color attachment,
1675 // resolve attachment or depth stencil attachment,
1676 // it needs to exist on tile at some point.
1677
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001678 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1679 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001680 }
1681
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001682 if (subpass_info.pResolveAttachments) {
1683 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1684 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1685 }
1686 }
1687
1688 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001689 }
1690
1691 return false;
1692}
1693
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001694static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1695 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1696 return false;
1697 }
1698
1699 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001700 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001701
1702 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1703 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1704 return true;
1705 }
1706 }
1707 }
1708
1709 return false;
1710}
1711
Attilio Provenzano02859b22020-02-27 14:17:28 +00001712bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1713 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1714 bool skip = false;
1715
1716 if (!pRenderPassBegin) {
1717 return skip;
1718 }
1719
Gareth Webbdc6549a2021-06-16 03:52:24 +01001720 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
1721 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
1722 "This render pass has a zero-size render area. It cannot write to any attachments, "
1723 "and can only be used for side effects such as layout transitions.");
1724 }
1725
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001726 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001727 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001728 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001729 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001730 if (rpabi) {
1731 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1732 }
1733 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001734 // Check if any attachments have LOAD operation on them
1735 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001736 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001737
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001738 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02001739 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001740 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001741 }
1742
1743 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001744 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001745 }
1746
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001747 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001748
1749 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001750 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1751 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001752 }
1753
1754 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
LawG47747b322022-02-23 16:12:10 +00001755 if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
1756 skip |=
1757 LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
LawG4015be1c2022-03-01 10:37:52 +00001758 "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
LawG47747b322022-02-23 16:12:10 +00001759 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04001760 "which will copy in total %u pixels (renderArea = "
LawG47747b322022-02-23 16:12:10 +00001761 "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.",
1762 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att,
1763 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1764 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1765 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001766 }
1767 }
paul-lunarg7089e272022-06-20 22:19:37 +02001768
1769 // Check if renderpass has at least one VK_ATTACHMENT_LOAD_OP_CLEAR
1770
1771 bool clearing = false;
1772
1773 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
1774 const auto& attachment = rp_state->createInfo.pAttachments[att];
1775
1776 if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1777 clearing = true;
1778 break;
1779 }
1780 }
1781
1782 // Check if there are ClearValues passed to BeginRenderPass even though no attachments will be cleared
1783 if (!clearing && pRenderPassBegin->clearValueCount > 0) {
1784 // Flag as warning because nothing will happen per spec, and pClearValues will be ignored
1785 skip |= LogWarning(
1786 device, kVUID_BestPractices_ClearValueWithoutLoadOpClear,
1787 "This render pass does not have VkRenderPassCreateInfo.pAttachments->loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR "
1788 "but VkRenderPassBeginInfo.clearValueCount > 0. VkRenderPassBeginInfo.pClearValues will be ignored and no "
paul-lunarga0a149c2022-06-23 16:18:51 +02001789 "attachments will be cleared.");
paul-lunarg7089e272022-06-20 22:19:37 +02001790 }
paul-lunarga0a149c2022-06-23 16:18:51 +02001791
1792 // Check if there are more clearValues than attachments
1793 if(pRenderPassBegin->clearValueCount > rp_state->createInfo.attachmentCount) {
1794 // Flag as warning because the overflowing clearValues will be ignored and could even be undefined on certain platforms.
1795 // This could signal a bug and there seems to be no reason for this to happen on purpose.
1796 skip |= LogWarning(
1797 device, kVUID_BestPractices_ClearValueCountHigherThanAttachmentCount,
1798 "This render pass has VkRenderPassBeginInfo.clearValueCount > VkRenderPassCreateInfo.attachmentCount "
1799 "(%" PRIu32 " > %" PRIu32 ") and as such the clearValues that do not have a corresponding attachment will be ignored.",
1800 pRenderPassBegin->clearValueCount, rp_state->createInfo.attachmentCount);
1801 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001802 }
1803
1804 return skip;
1805}
1806
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001807void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
1808 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001809 if (view) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001810 auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state);
1811 QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001812 }
1813}
1814
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001815void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1816 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001817 // If we're viewing a 3D slice, ignore base array layer.
1818 // The entire 3D subresource is accessed as one atomic unit.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001819 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 +02001820
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001821 const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001822 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001823 const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel;
1824 const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001825
1826 for (uint32_t layer = 0; layer < array_layers; layer++) {
1827 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001828 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
1829 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001830 }
1831 }
1832}
1833
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001834void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1835 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) {
1836 const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001837 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001838
1839 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001840 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001841 }
1842}
1843
paul-lunarg5eb52062022-06-27 18:57:15 +02001844void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1845 IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer, uint32_t mip_level) {
1846 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](const ValidationStateTracker&, const QUEUE_STATE&,
1847 const CMD_BUFFER_STATE&) -> bool {
1848 ValidateImageInQueue(function_name, *state, usage, array_layer, mip_level);
1849 return false;
1850 });
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001851}
1852
LawG44d414ba2022-02-23 15:35:41 +00001853void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001854 IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001855 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001856 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001857 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 -07001858 !image.IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001859 LogPerformanceWarning(
1860 device, kVUID_BestPractices_RenderPass_RedundantStore,
LawG4015be1c2022-03-01 10:37:52 +00001861 "%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 +02001862 "image was used, it was written to with STORE_OP_STORE. "
1863 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1864 "architectures.",
LawG44d414ba2022-02-23 15:35:41 +00001865 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001866 } 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 +02001867 LogPerformanceWarning(
1868 device, kVUID_BestPractices_RenderPass_RedundantClear,
LawG4015be1c2022-03-01 10:37:52 +00001869 "%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 +02001870 "image was used, it was written to with vkCmdClear*Image(). "
1871 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
LawG44d414ba2022-02-23 15:35:41 +00001872 "tile-based architectures.",
1873 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001874 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001875 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1876 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001877 const char *last_cmd = nullptr;
1878 const char *vuid = nullptr;
1879 const char *suggestion = nullptr;
1880
1881 switch (last_usage) {
1882 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1883 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1884 last_cmd = "vkCmdBlitImage";
1885 suggestion =
1886 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1887 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1888 "which avoids the memory roundtrip.";
1889 break;
1890 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1891 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1892 last_cmd = "vkCmdClear*Image";
1893 suggestion =
1894 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1895 "tile-based architectures. "
1896 "Use LOAD_OP_CLEAR instead to clear the image for free.";
1897 break;
1898 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
1899 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
1900 last_cmd = "vkCmdCopy*Image";
1901 suggestion =
1902 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1903 "Rather than copying, just render the source image in a fragment shader in this render pass, "
1904 "which avoids the memory roundtrip.";
1905 break;
1906 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
1907 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
1908 last_cmd = "vkCmdResolveImage";
1909 suggestion =
1910 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
1911 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
1912 "which avoids the memory roundtrip.";
1913 break;
1914 default:
1915 break;
1916 }
1917
1918 LogPerformanceWarning(
1919 device, vuid,
LawG4015be1c2022-03-01 10:37:52 +00001920 "%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 +01001921 "time image was used, it was written to with %s. %s",
LawG44d414ba2022-02-23 15:35:41 +00001922 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd,
1923 suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001924 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001925}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001926
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001927void BestPractices::ValidateImageInQueue(const char* function_name, bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage,
1928 uint32_t array_layer, uint32_t mip_level) {
1929 auto last_usage = state.UpdateUsage(array_layer, mip_level, usage);
paul-lunarg5eb52062022-06-27 18:57:15 +02001930
1931 // When image was discarded with StoreOpDontCare but is now being read with LoadOpLoad
1932 if (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED &&
1933 usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE) {
1934 LogWarning(device, kVUID_BestPractices_StoreOpDontCareThenLoadOpLoad,
1935 "Trying to load an attachment with LOAD_OP_LOAD that was previously stored with STORE_OP_DONT_CARE. This may "
1936 "result in undefined behaviour.");
1937 }
1938
LawG44d414ba2022-02-23 15:35:41 +00001939 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
1940 ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001941 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001942}
1943
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001944void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) {
1945 cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(),
1946 cb.queue_submit_functions_after_render_pass.end());
1947 cb.queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001948}
1949
1950void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
1951 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001952 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1953 if (cb_node) {
1954 AddDeferredQueueOperations(*cb_node);
1955 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001956}
1957
1958void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
1959 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001960 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1961 if (cb_node) {
1962 AddDeferredQueueOperations(*cb_node);
1963 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001964}
1965
1966void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
1967 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001968 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1969 if (cb_node) {
1970 AddDeferredQueueOperations(*cb_node);
1971 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001972}
1973
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001974void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
1975 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001976 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001977 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001978 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1979}
1980
1981void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
1982 const VkRenderPassBeginInfo* pRenderPassBegin,
1983 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1984 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1985 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1986}
1987
1988void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1989 const VkRenderPassBeginInfo* pRenderPassBegin,
1990 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1991 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1992 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1993}
1994
1995void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001996
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001997 if (!pRenderPassBegin) {
1998 return;
1999 }
2000
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002001 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01002002
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002003 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002004 if (rp_state) {
2005 // Check load ops
2006 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002007 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002008
2009 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
2010 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2011 continue;
2012 }
2013
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002014 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002015
2016 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
2017 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002018 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02002019 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
2020 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002021 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02002022 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01002023 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002024 }
2025
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002026 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Jeremy Gebben9f537102021-10-05 16:37:12 -06002027 std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr;
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002028
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002029 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002030 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2031 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002032 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002033 }
2034 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002035 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002036 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002037
Jeremy Gebben9f537102021-10-05 16:37:12 -06002038 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002039 }
2040
2041 // Check store ops
2042 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002043 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002044
2045 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2046 continue;
2047 }
2048
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002049 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002050
2051 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
2052 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002053 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002054 }
2055
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002056 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002057
Jeremy Gebben9f537102021-10-05 16:37:12 -06002058 std::shared_ptr<IMAGE_VIEW_STATE> image_view;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002059 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002060 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2061 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002062 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002063 }
2064 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002065 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002066 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002067
Jeremy Gebben9f537102021-10-05 16:37:12 -06002068 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002069 }
2070 }
2071}
2072
Attilio Provenzano02859b22020-02-27 14:17:28 +00002073bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2074 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002075 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2076 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002077 return skip;
2078}
2079
2080bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2081 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002082 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002083 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2084 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002085 return skip;
2086}
2087
2088bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002089 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002090 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2091 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002092 return skip;
2093}
2094
Sam Walls0961ec02020-03-31 16:39:15 +01002095void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
2096 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002097 // Reset the renderpass state
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002098 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
sjfricke52defd42022-08-08 16:37:46 +09002099 // TODO - move this logic to the Render Pass state as cb->has_draw_cmd should stay true for lifetime of command buffer
2100 cb->has_draw_cmd = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002101 assert(cb);
2102 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002103 render_pass_state.touchesAttachments.clear();
2104 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002105 render_pass_state.numDrawCallsDepthOnly = 0;
2106 render_pass_state.numDrawCallsDepthEqualCompare = 0;
2107 render_pass_state.colorAttachment = false;
2108 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002109 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002110 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01002111
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002112 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01002113
2114 // track depth / color attachment usage within the renderpass
2115 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
2116 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002117 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002118
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002119 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002120 }
2121}
2122
2123void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2124 VkSubpassContents contents) {
2125 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2126 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
2127}
2128
2129void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2130 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2131 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2132 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2133}
2134
2135void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2136 const VkRenderPassBeginInfo* pRenderPassBegin,
2137 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2138 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2139 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2140}
2141
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002142// Generic function to handle validation for all CmdDraw* type functions
2143bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
2144 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002145 const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002146 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002147 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2148 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002149 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002150
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002151 // Verify vertex binding
Tony-LunarG2ffe1f52022-04-11 15:13:30 -06002152 if (pipeline_state && pipeline_state->vertex_input_state &&
2153 pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) {
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002154 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002155 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002156 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002157 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
2158 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002159 }
2160 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002161
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002162 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002163 if (pipe) {
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002164 const auto& rp_state = pipe->RenderPassState();
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002165 if (rp_state) {
2166 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
2167 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002168 const auto* ds_state = pipe->DepthStencilState();
Jeremy Gebben11af9792021-08-20 10:20:09 -06002169 const uint32_t depth_stencil_attachment =
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002170 GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment);
2171 const auto* raster_state = pipe->RasterizationState();
2172 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state &&
2173 raster_state->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002174 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
2175 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
2176 }
2177 }
2178 }
2179 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002180 }
2181 return skip;
2182}
2183
Sam Walls0961ec02020-03-31 16:39:15 +01002184void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002185 auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002186 assert(cb_node);
Sam Walls0961ec02020-03-31 16:39:15 +01002187 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002188 RecordCmdDrawTypeArm(*cb_node, draw_count, caller);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002189 }
2190
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002191 if (cb_node->render_pass_state.drawTouchAttachments) {
2192 for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) {
2193 RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002194 }
2195 // No need to touch the same attachments over and over.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002196 cb_node->render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002197 }
2198}
2199
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002200void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) {
2201 auto& render_pass_state = cb_node.render_pass_state;
LawG4b21485c2022-02-28 13:46:48 +00002202 // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards
2203 // depth prepass warnings First find the lowest enabled draw count
2204 uint32_t lowestEnabledMinDrawCount = 0;
2205 lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm;
2206 if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount)
2207 lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG;
2208
2209 if (draw_count >= lowestEnabledMinDrawCount) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002210 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
2211 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01002212 }
2213}
2214
Camden5b184be2019-08-13 07:50:19 -06002215bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002216 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002217 bool skip = false;
2218
2219 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002220 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2221 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002222 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002223 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06002224
2225 return skip;
2226}
2227
Sam Walls0961ec02020-03-31 16:39:15 +01002228void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2229 uint32_t firstVertex, uint32_t firstInstance) {
2230 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
2231 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
2232}
2233
Camden5b184be2019-08-13 07:50:19 -06002234bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002235 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002236 bool skip = false;
2237
2238 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002239 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2240 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002241 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002242 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
2243
Attilio Provenzano02859b22020-02-27 14:17:28 +00002244 // Check if we reached the limit for small indexed draw calls.
2245 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002246 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002247 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002248 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
LawG4ff42d722022-03-01 10:28:25 +00002249 (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002250 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
LawG4ff42d722022-03-01 10:28:25 +00002251 "%s %s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00002252 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
2253 "You can try batching drawcalls or instancing when applicable.",
LawG4ff42d722022-03-01 10:28:25 +00002254 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls,
2255 kSmallIndexedDrawcallIndices);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002256 }
2257
Sam Walls8e77e4f2020-03-16 20:47:40 +00002258 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002259 ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002260 }
2261
2262 return skip;
2263}
2264
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002265bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount,
Sam Walls8e77e4f2020-03-16 20:47:40 +00002266 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
2267 bool skip = false;
2268
2269 // check for sparse/underutilised index buffer, and post-transform cache thrashing
Sam Walls8e77e4f2020-03-16 20:47:40 +00002270
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002271 const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get();
2272 if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002273
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002274 const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002275 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00002276 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
2277 const void* ib_mem = ib_mem_state.p_driver_data;
2278 bool primitive_restart_enable = false;
2279
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002280 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002281 const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point];
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002282 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002283
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002284 const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr;
2285 if (ia_state) {
2286 primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002287 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00002288
2289 // 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 -06002290 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00002291 uint32_t scan_stride;
2292 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2293 scan_stride = sizeof(uint8_t);
2294 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2295 scan_stride = sizeof(uint16_t);
2296 } else {
2297 scan_stride = sizeof(uint32_t);
2298 }
2299
2300 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
2301 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
2302
2303 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
2304 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
2305 // irrespective of whether or not they're part of the draw call.
2306
2307 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
2308 uint32_t min_index = ~0u;
2309 // start with maximum as 0 and adjust to indices in the buffer
2310 uint32_t max_index = 0u;
2311
2312 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
2313 // for the given index buffer
2314 uint32_t vertex_shade_count = 0;
2315
2316 PostTransformLRUCacheModel post_transform_cache;
2317
2318 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
2319 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
2320 // target architecture.
2321 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
2322 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
2323 post_transform_cache.resize(32);
2324
2325 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2326 uint32_t scan_index;
2327 uint32_t primitive_restart_value;
2328 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2329 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2330 primitive_restart_value = 0xFF;
2331 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2332 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2333 primitive_restart_value = 0xFFFF;
2334 } else {
2335 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2336 primitive_restart_value = 0xFFFFFFFF;
2337 }
2338
2339 max_index = std::max(max_index, scan_index);
2340 min_index = std::min(min_index, scan_index);
2341
2342 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
2343 bool in_cache = post_transform_cache.query_cache(scan_index);
2344 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
2345 if (!in_cache) vertex_shade_count++;
2346 }
2347 }
2348
2349 // 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 +01002350 // 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
2351 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002352
2353 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07002354 skip |=
2355 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2356 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
2357 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
2358 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
2359 "maximum would be loaded, and possibly shaded, whether or not they are used.",
2360 VendorSpecificTag(kBPVendorArm),
2361 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002362 return skip;
2363 }
2364
2365 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
2366 // 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 +01002367 const size_t refs_per_bucket = 64;
2368 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
2369
2370 const uint32_t n_indices = max_index - min_index + 1;
2371 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
2372 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
2373
2374 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
2375 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00002376
2377 // To avoid using too much memory, we run over the indices again.
2378 // Knowing the size from the last scan allows us to record index usage with bitsets
2379 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2380 uint32_t scan_index;
2381 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2382 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2383 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2384 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2385 } else {
2386 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2387 }
2388 // keep track of the set of all indices used to reference vertices in the draw call
2389 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01002390 size_t bitset_bucket_index = index_offset / refs_per_bucket;
2391 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002392 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
2393 }
2394
2395 uint32_t vertex_reference_count = 0;
2396 for (const auto& bitset : vertex_reference_buckets) {
2397 vertex_reference_count += static_cast<uint32_t>(bitset.count());
2398 }
2399
2400 // 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 -07002401 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002402 // 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 -07002403 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002404
2405 if (utilization < 0.5f) {
2406 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2407 "%s The indices which were specified for the draw call only utilise approximately "
2408 "%.02f%% of the bound vertex buffer.",
2409 VendorSpecificTag(kBPVendorArm), utilization);
2410 }
2411
2412 if (cache_hit_rate <= 0.5f) {
2413 skip |=
2414 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
2415 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
2416 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
2417 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
2418 "recently shaded vertices.",
2419 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
2420 }
2421 }
2422
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002423 return skip;
2424}
2425
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002426bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2427 const VkCommandBuffer* pCommandBuffers) const {
2428 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002429 const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002430 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002431 const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002432 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002433 continue;
2434 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002435 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002436 for (auto& clear : secondary.earlyClearAttachments) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002437 if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) {
2438 skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002439 }
2440 }
2441 }
Nadav Gevaf0808442021-05-21 13:51:25 -04002442
2443 if (VendorCheckEnabled(kBPVendorAMD)) {
2444 if (commandBufferCount > 0) {
2445 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
2446 "%s Performance warning: Use of secondary command buffers is not recommended. ",
2447 VendorSpecificTag(kBPVendorAMD));
2448 }
2449 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002450 return skip;
2451}
2452
2453void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2454 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002455 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
2456
2457 auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2458 if (!primary) {
2459 return;
2460 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002461
2462 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002463 auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]);
2464 if (!secondary) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002465 continue;
2466 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002467
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002468 for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) {
2469 if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
2470 RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment,
2471 early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002472 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002473 RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002474 }
2475 }
2476
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002477 for (auto& touch : secondary->render_pass_state.touchesAttachments) {
2478 RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002479 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02002480
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002481 primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare;
2482 primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002483 }
2484
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002485}
2486
Rodrigo Locatti7d716e12022-03-09 19:15:17 -03002487bool BestPractices::PreCallValidateCmdBuildAccelerationStructureNV(VkCommandBuffer commandBuffer,
2488 const VkAccelerationStructureInfoNV* pInfo,
2489 VkBuffer instanceData, VkDeviceSize instanceOffset,
2490 VkBool32 update, VkAccelerationStructureNV dst,
2491 VkAccelerationStructureNV src, VkBuffer scratch,
2492 VkDeviceSize scratchOffset) const {
2493 return ValidateBuildAccelerationStructure(commandBuffer);
2494}
2495
2496bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresIndirectKHR(
2497 VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
2498 const VkDeviceAddress* pIndirectDeviceAddresses, const uint32_t* pIndirectStrides,
2499 const uint32_t* const* ppMaxPrimitiveCounts) const {
2500 return ValidateBuildAccelerationStructure(commandBuffer);
2501}
2502
2503bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresKHR(
2504 VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos,
2505 const VkAccelerationStructureBuildRangeInfoKHR* const* ppBuildRangeInfos) const {
2506 return ValidateBuildAccelerationStructure(commandBuffer);
2507}
2508
2509bool BestPractices::ValidateBuildAccelerationStructure(VkCommandBuffer commandBuffer) const {
2510 bool skip = false;
2511 auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
2512 assert(cb_node);
2513
2514 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
2515 if ((cb_node->GetQueueFlags() & VK_QUEUE_GRAPHICS_BIT) != 0) {
2516 skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_AccelerationStructure_NotAsync,
2517 "%s Performance warning: Prefer building acceleration structures on an asynchronous "
2518 "compute queue, instead of using the universal graphics queue.",
2519 VendorSpecificTag(kBPVendorNVIDIA));
2520 }
2521 }
2522
2523 return skip;
2524}
2525
Rodrigo Locatti66b23352022-03-15 17:28:32 -03002526bool BestPractices::ValidateBindMemory(VkDevice device, VkDeviceMemory memory) const {
2527 bool skip = false;
2528
2529 if (VendorCheckEnabled(kBPVendorNVIDIA) && device_extensions.vk_ext_pageable_device_local_memory) {
2530 auto mem_info = std::static_pointer_cast<const bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory));
2531 if (!mem_info->dynamic_priority) {
2532 skip |=
2533 LogPerformanceWarning(device, kVUID_BestPractices_BindMemory_NoPriority,
2534 "%s Use vkSetDeviceMemoryPriorityEXT to provide the OS with information on which allocations "
2535 "should stay in memory and which should be demoted first when video memory is limited. The "
2536 "highest priority should be given to GPU-written resources like color attachments, depth "
2537 "attachments, storage images, and buffers written from the GPU.",
2538 VendorSpecificTag(kBPVendorNVIDIA));
2539 }
2540 }
2541
2542 return skip;
2543}
2544
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002545void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
2546 auto& state = cb_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002547 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002548 auto itr =
2549 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2550 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002551
2552 if (itr != state.touchesAttachments.end()) {
2553 itr->aspects |= aspects;
2554 } else {
2555 state.touchesAttachments.push_back({ fb_attachment, aspects });
2556 }
2557}
2558
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002559void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002560 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
2561 const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002562 auto& state = cmd_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002563 // If we observe a full clear before any other access to a frame buffer attachment,
2564 // we have candidate for redundant clear attachments.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002565 auto itr =
2566 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2567 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002568
2569 uint32_t new_aspects = aspects;
2570 if (itr != state.touchesAttachments.end()) {
2571 new_aspects = aspects & ~itr->aspects;
2572 itr->aspects |= aspects;
2573 } else {
2574 state.touchesAttachments.push_back({ fb_attachment, aspects });
2575 }
2576
2577 if (new_aspects == 0) {
2578 return;
2579 }
2580
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002581 if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002582 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
2583 // CmdExecuteCommands.
2584 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
2585 std::vector<VkClearRect>{pRects, pRects + rectCount} });
2586 }
2587}
2588
2589void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
2590 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
2591 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002592 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects);
2593
2594 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2595 auto* rp_state = cmd_state->activeRenderPass.get();
2596 auto* fb_state = cmd_state->activeFramebuffer.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002597 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
2598
2599 if (rectCount == 0 || !rp_state) {
2600 return;
2601 }
2602
2603 if (!is_secondary && !fb_state) {
2604 return;
2605 }
2606
2607 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002608 bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002609
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06002610 if (!rp_state->UsesDynamicRendering()) {
ziga-lunarg885c6542022-03-07 01:08:25 +01002611 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
2612 for (uint32_t i = 0; i < attachmentCount; i++) {
2613 auto& attachment = pClearAttachments[i];
2614 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2615 VkImageAspectFlags aspects = attachment.aspectMask;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002616
ziga-lunarg885c6542022-03-07 01:08:25 +01002617 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
2618 if (subpass.pDepthStencilAttachment) {
2619 fb_attachment = subpass.pDepthStencilAttachment->attachment;
2620 }
2621 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
2622 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002623 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002624
ziga-lunarg885c6542022-03-07 01:08:25 +01002625 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2626 if (full_clear) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002627 RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment,
ziga-lunarg885c6542022-03-07 01:08:25 +01002628 aspects, rectCount, pRects);
2629 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002630 RecordAttachmentAccess(*cmd_state, fb_attachment, aspects);
ziga-lunarg885c6542022-03-07 01:08:25 +01002631 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002632 }
2633 }
2634 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002635}
2636
Attilio Provenzano02859b22020-02-27 14:17:28 +00002637void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2638 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2639 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
2640 firstInstance);
2641
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002642 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002643 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
2644 cmd_state->small_indexed_draw_call_count++;
2645 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002646
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002647 ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00002648}
2649
Sam Walls0961ec02020-03-31 16:39:15 +01002650void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2651 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2652 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2653 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
2654}
2655
sfricke-samsung681ab7b2020-10-29 01:53:35 -07002656bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2657 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
2658 uint32_t maxDrawCount, uint32_t stride) const {
2659 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
2660
2661 return skip;
2662}
2663
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002664bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
2665 VkDeviceSize offset, VkBuffer countBuffer,
2666 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
2667 uint32_t stride) const {
2668 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06002669
2670 return skip;
2671}
2672
2673bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002674 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002675 bool skip = false;
2676
2677 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002678 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2679 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002680 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002681 }
2682
2683 return skip;
2684}
2685
Sam Walls0961ec02020-03-31 16:39:15 +01002686void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2687 uint32_t count, uint32_t stride) {
2688 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2689 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2690}
2691
Camden5b184be2019-08-13 07:50:19 -06002692bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002693 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002694 bool skip = false;
2695
2696 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002697 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2698 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002699 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002700 }
2701
2702 return skip;
2703}
2704
Sam Walls0961ec02020-03-31 16:39:15 +01002705void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2706 uint32_t count, uint32_t stride) {
2707 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2708 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2709}
2710
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002711void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) {
2712 for (auto descriptor_set : cb_state.validated_descriptor_sets) {
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002713 for (const auto& binding : *descriptor_set) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002714 // For bindless scenarios, we should not attempt to track descriptor set state.
2715 // It is highly uncertain which resources are actually bound.
2716 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002717 if (binding->binding_flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2718 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002719 continue;
2720 }
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002721
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002722 for (uint32_t i = 0; i < binding->count; ++i) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002723 VkImageView image_view{VK_NULL_HANDLE};
2724
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002725 auto descriptor = binding->GetDescriptor(i);
ziga-lunarg33d806c2022-05-05 17:00:52 +02002726 if (!descriptor) {
2727 continue;
2728 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002729 switch (descriptor->GetClass()) {
2730 case cvdescriptorset::DescriptorClass::Image: {
2731 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2732 image_view = image_descriptor->GetImageView();
2733 }
2734 break;
2735 }
2736 case cvdescriptorset::DescriptorClass::ImageSampler: {
2737 if (const auto image_sampler_descriptor =
2738 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2739 image_view = image_sampler_descriptor->GetImageView();
2740 }
2741 break;
2742 }
2743 default:
2744 break;
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002745 }
2746
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002747 if (image_view) {
2748 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
2749 QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(),
2750 IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002751 }
2752 }
2753 }
2754 }
2755}
2756
2757void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2758 uint32_t firstVertex, uint32_t firstInstance) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002759 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2760 ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002761}
2762
2763void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2764 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002765 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2766 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002767}
2768
2769void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2770 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002771 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2772 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002773}
2774
Camden5b184be2019-08-13 07:50:19 -06002775bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002776 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002777 bool skip = false;
2778
2779 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002780 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2781 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2782 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2783 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002784 }
2785
2786 return skip;
2787}
Camden83a9c372019-08-14 11:41:38 -06002788
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002789bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2790 bool skip = false;
2791 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
2792 skip |= ValidateCmdEndRenderPass(commandBuffer);
2793 return skip;
2794}
2795
2796bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2797 bool skip = false;
2798 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
2799 skip |= ValidateCmdEndRenderPass(commandBuffer);
2800 return skip;
2801}
2802
Sam Walls0961ec02020-03-31 16:39:15 +01002803bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2804 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002805 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002806 skip |= ValidateCmdEndRenderPass(commandBuffer);
2807 return skip;
2808}
2809
2810bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2811 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002812 const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01002813
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002814 if (cmd == nullptr) return skip;
2815 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01002816
LawG4b21485c2022-02-28 13:46:48 +00002817 // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor
2818 bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2819 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
2820 bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG &&
2821 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG;
2822
2823 // Only send the warning when the vendor is enabled and a depth prepass is detected
LawG498ec4502022-04-05 09:08:25 +01002824 bool uses_depth =
2825 (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
LawG45507e142022-04-08 09:36:54 +01002826 ((depth_only_arm && VendorCheckEnabled(kBPVendorArm)) || (depth_only_img && VendorCheckEnabled(kBPVendorIMG)));
LawG4b21485c2022-02-28 13:46:48 +00002827
Sam Walls0961ec02020-03-31 16:39:15 +01002828 if (uses_depth) {
2829 skip |= LogPerformanceWarning(
2830 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
LawG4015be1c2022-03-01 10:37:52 +00002831 "%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 +00002832 "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry "
2833 "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface "
2834 "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.",
2835 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Sam Walls0961ec02020-03-31 16:39:15 +01002836 }
2837
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002838 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2839
LawG40da9c3d2022-03-01 09:51:01 +00002840 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002841 // If we use an attachment on-tile, we should access it in some way. Otherwise,
2842 // it is redundant to have it be part of the render pass.
2843 // Only consider it redundant if it will actually consume bandwidth, i.e.
2844 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
2845 // as is using pure input attachments.
2846 // CLEAR -> STORE might be considered a "useful" thing to do, but
2847 // the optimal thing to do is to defer the clear until you're actually
2848 // going to render to the image.
2849
2850 uint32_t num_attachments = rp->createInfo.attachmentCount;
2851 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002852 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
2853 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002854 continue;
2855 }
2856
2857 auto& attachment = rp->createInfo.pAttachments[i];
2858
2859 VkImageAspectFlags bandwidth_aspects = 0;
2860
2861 if (!FormatIsStencilOnly(attachment.format) &&
2862 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2863 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2864 if (FormatHasDepth(attachment.format)) {
2865 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
2866 } else {
2867 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
2868 }
2869 }
2870
2871 if (FormatHasStencil(attachment.format) &&
2872 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2873 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2874 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
2875 }
2876
2877 if (!bandwidth_aspects) {
2878 continue;
2879 }
2880
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002881 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002882 [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002883 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002884 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002885 untouched_aspects &= ~itr->aspects;
2886 }
2887
2888 if (untouched_aspects) {
2889 skip |= LogPerformanceWarning(
2890 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
LawG4015be1c2022-03-01 10:37:52 +00002891 "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002892 "was never accessed by a pipeline or clear command. "
LawG40da9c3d2022-03-01 09:51:01 +00002893 "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 +00002894 "render pass if the attachments are not intended to be accessed.",
LawG40da9c3d2022-03-01 09:51:01 +00002895 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects);
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002896 }
2897 }
2898 }
2899
Sam Walls0961ec02020-03-31 16:39:15 +01002900 return skip;
2901}
2902
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002903void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002904 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2905 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002906}
2907
2908void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002909 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2910 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002911}
2912
Camden Stocker9c051442019-11-06 14:28:43 -08002913bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
2914 const char* api_name) const {
2915 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002916 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08002917
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002918 if (bp_pd_state) {
2919 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
2920 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
2921 "Potential problem with calling %s() without first retrieving properties from "
2922 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
2923 api_name);
2924 }
Camden Stocker9c051442019-11-06 14:28:43 -08002925 }
2926
2927 return skip;
2928}
2929
Camden83a9c372019-08-14 11:41:38 -06002930bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002931 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06002932 bool skip = false;
2933
Camden Stocker9c051442019-11-06 14:28:43 -08002934 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06002935
Camden Stocker9c051442019-11-06 14:28:43 -08002936 return skip;
2937}
2938
2939bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
2940 uint32_t planeIndex,
2941 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
2942 bool skip = false;
2943
2944 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
2945
2946 return skip;
2947}
2948
2949bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
2950 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
2951 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
2952 bool skip = false;
2953
2954 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06002955
2956 return skip;
2957}
Camden05de2d42019-08-19 10:23:56 -06002958
2959bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002960 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06002961 bool skip = false;
2962
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002963 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Camden05de2d42019-08-19 10:23:56 -06002964
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002965 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06002966 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002967 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002968 skip |=
2969 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
2970 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
2971 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06002972 }
Camden05de2d42019-08-19 10:23:56 -06002973
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002974 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
2975 skip |= LogWarning(
2976 device, kVUID_BestPractices_Swapchain_InvalidCount,
2977 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04002978 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002979 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
2980 }
2981 }
2982
Camden05de2d42019-08-19 10:23:56 -06002983 return skip;
2984}
2985
2986// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002987bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002988 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002989 const CALL_STATE call_state,
2990 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06002991 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002992 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
2993 if (UNCALLED == call_state) {
2994 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002995 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002996 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
2997 "recommended "
2998 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
2999 caller_name, caller_name);
3000 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003001 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
3002 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003003 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
3004 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
3005 ". It is recommended to instead receive all the properties by calling %s with "
3006 "pQueueFamilyPropertyCount that was "
3007 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003008 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003009 caller_name);
Camden05de2d42019-08-19 10:23:56 -06003010 }
3011
3012 return skip;
3013}
3014
Jeff Bolz5c801d12019-10-09 10:38:45 -05003015bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
3016 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06003017 bool skip = false;
3018
3019 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003020 auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06003021 if (!as_state->memory_requirements_checked) {
3022 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
3023 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
3024 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003025 skip |= LogWarning(
3026 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06003027 "vkBindAccelerationStructureMemoryNV(): "
3028 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
3029 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
3030 }
3031 }
3032
3033 return skip;
3034}
3035
Camden05de2d42019-08-19 10:23:56 -06003036bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3037 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003038 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003039 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003040 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003041 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003042 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3043 "vkGetPhysicalDeviceQueueFamilyProperties()");
3044 }
3045 return false;
Camden05de2d42019-08-19 10:23:56 -06003046}
3047
Mike Schuchardt2df08912020-12-15 16:28:09 -08003048bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3049 uint32_t* pQueueFamilyPropertyCount,
3050 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003051 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003052 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003053 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003054 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3055 "vkGetPhysicalDeviceQueueFamilyProperties2()");
3056 }
3057 return false;
Camden05de2d42019-08-19 10:23:56 -06003058}
3059
Jeff Bolz5c801d12019-10-09 10:38:45 -05003060bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08003061 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003062 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003063 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003064 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003065 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3066 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
3067 }
3068 return false;
Camden05de2d42019-08-19 10:23:56 -06003069}
3070
3071bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
3072 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003073 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06003074 if (!pSurfaceFormats) return false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003075 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003076 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06003077 bool skip = false;
3078 if (call_state == UNCALLED) {
3079 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
3080 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003081 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
3082 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
3083 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06003084 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003085 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003086 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
3087 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
3088 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
3089 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003090 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06003091 }
3092 }
3093 return skip;
3094}
Camden Stocker23cc47d2019-09-03 14:53:57 -06003095
3096bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05003097 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003098 bool skip = false;
3099
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003100 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3101 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06003102 // 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 -07003103 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003104 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
3105 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07003106 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06003107 // 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 -07003108 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
3109 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003110 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003111 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003112 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003113 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003114 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003115 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
3116 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
3117 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003118 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003119 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
3120 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003121 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003122 }
3123 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003124 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003125 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003126 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003127 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
3128 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003129 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003130 }
3131 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003132 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3133 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003134 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003135 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003136 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003137 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003138 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003139 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
3140 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
3141 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003142 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003143 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
3144 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003145 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003146 }
3147 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003148 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003149 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003150 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003151 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
3152 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003153 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003154 }
3155 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3156 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003157 sparse_images_with_metadata.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003158 }
3159 }
3160 }
3161 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003162 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
3163 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003164 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003165 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003166 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
3167 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003168 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003169 }
3170 }
3171 }
3172
Rodrigo Locatti7ab778d2022-03-09 18:57:15 -03003173 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3174 auto queue_state = Get<QUEUE_STATE>(queue);
3175 if (queue_state && queue_state->queueFamilyProperties.queueFlags != (VK_QUEUE_TRANSFER_BIT | VK_QUEUE_SPARSE_BINDING_BIT)) {
3176 skip |= LogPerformanceWarning(queue, kVUID_BestPractices_QueueBindSparse_NotAsync,
3177 "vkQueueBindSparse() issued on queue %s. All binds should happen on an asynchronous copy "
3178 "queue to hide the OS scheduling and submit costs.",
3179 report_data->FormatHandle(queue).c_str());
3180 }
3181 }
3182
Camden Stocker23cc47d2019-09-03 14:53:57 -06003183 return skip;
3184}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003185
Mark Lobodzinski84101d72020-04-24 09:43:48 -06003186void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
3187 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003188 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003189 return;
3190 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003191
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003192 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3193 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
3194 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3195 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003196 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003197 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003198 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003199 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003200 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3201 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
3202 image_state->sparse_metadata_bound = true;
3203 }
3204 }
3205 }
3206 }
3207}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003208
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003209bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003210 const VkClearRect* pRects) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003211 if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003212 // We don't know the accurate render area in a secondary,
3213 // so assume we clear the entire frame buffer.
3214 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
3215 return true;
3216 }
3217
3218 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
3219 for (uint32_t i = 0; i < rectCount; i++) {
3220 auto& rect = pRects[i];
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003221 auto& render_area = cmd.activeRenderPassBeginInfo.renderArea;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003222 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
3223 return true;
3224 }
3225 }
3226
3227 return false;
3228}
3229
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003230bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment,
3231 VkImageAspectFlags aspects, bool secondary) const {
3232 const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003233 bool skip = false;
3234
3235 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
3236 return skip;
3237 }
3238
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003239 const auto& rp_state = cmd.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003240
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003241 auto attachment_itr =
3242 std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
3243 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003244
3245 // Only report aspects which haven't been touched yet.
3246 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003247 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003248 new_aspects &= ~attachment_itr->aspects;
3249 }
3250
3251 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
sjfricke52defd42022-08-08 16:37:46 +09003252 if (!cmd.has_draw_cmd) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003253 skip |= LogPerformanceWarning(
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003254 cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02003255 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
3256 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003257 report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003258 }
3259
3260 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
3261 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3262 skip |= LogPerformanceWarning(
3263 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3264 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
3265 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3266 "it is more efficient.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003267 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003268 }
3269
3270 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
3271 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003272 skip |=
3273 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3274 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
3275 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3276 "it is more efficient.",
3277 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003278 }
3279
3280 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
3281 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003282 skip |=
3283 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3284 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
3285 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3286 "it is more efficient.",
3287 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003288 }
3289
3290 return skip;
3291}
3292
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003293bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06003294 const VkClearAttachment* pAttachments, uint32_t rectCount,
3295 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003296 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003297 const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003298 if (!cb_node) return skip;
3299
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003300 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
3301 // Defer checks to ExecuteCommands.
3302 return skip;
3303 }
3304
3305 // Only care about full clears, partial clears might have legitimate uses.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003306 if (!ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects)) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003307 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003308 }
3309
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003310 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
3311 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06003312 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003313 if (rp) {
3314 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
3315
3316 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003317 const auto& attachment = pAttachments[i];
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003318
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003319 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3320 uint32_t color_attachment = attachment.colorAttachment;
3321 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003322 skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003323 }
3324
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003325 if (subpass.pDepthStencilAttachment &&
3326 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003327 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003328 skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003329 }
3330 }
3331 }
3332
Nadav Gevaf0808442021-05-21 13:51:25 -04003333 if (VendorCheckEnabled(kBPVendorAMD)) {
3334 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
3335 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
3336 bool black_check = false;
3337 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
3338 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
3339 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
3340 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3341 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3342
3343 bool white_check = false;
3344 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
3345 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
3346 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
3347 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3348 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3349
3350 if (black_check && white_check) {
3351 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3352 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
3353 "Consider changing to one of the following:"
3354 "RGBA(0, 0, 0, 0) "
3355 "RGBA(0, 0, 0, 1) "
3356 "RGBA(1, 1, 1, 0) "
3357 "RGBA(1, 1, 1, 1)",
3358 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3359 }
3360 } else {
3361 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
3362 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
3363 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
3364 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3365 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
3366 "attachment %" PRId32 " is not a fast clear value."
3367 "Consider changing to one of the following:"
3368 "D=0.0f, S=0"
3369 "D=1.0f, S=0",
3370 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3371 }
3372 }
3373 }
3374 }
3375
Camden Stockerf55721f2019-09-09 11:04:49 -06003376 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003377}
Attilio Provenzano02859b22020-02-27 14:17:28 +00003378
3379bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3380 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3381 const VkImageResolve* pRegions) const {
3382 bool skip = false;
3383
3384 skip |= VendorCheckEnabled(kBPVendorArm) &&
3385 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
3386 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
3387 "This is a very slow and extremely bandwidth intensive path. "
3388 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3389 VendorSpecificTag(kBPVendorArm));
3390
3391 return skip;
3392}
3393
Jeff Leger178b1e52020-10-05 12:22:23 -04003394bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3395 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
3396 bool skip = false;
3397
3398 skip |= VendorCheckEnabled(kBPVendorArm) &&
3399 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
3400 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
3401 "This is a very slow and extremely bandwidth intensive path. "
3402 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3403 VendorSpecificTag(kBPVendorArm));
3404
3405 return skip;
3406}
3407
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003408bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3409 const VkResolveImageInfo2* pResolveImageInfo) const {
3410 bool skip = false;
3411
3412 skip |= VendorCheckEnabled(kBPVendorArm) &&
3413 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage,
3414 "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. "
3415 "This is a very slow and extremely bandwidth intensive path. "
3416 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3417 VendorSpecificTag(kBPVendorArm));
3418
3419 return skip;
3420}
3421
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003422void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3423 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3424 const VkImageResolve* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003425 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003426 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003427 auto src = Get<bp_state::Image>(srcImage);
3428 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003429
3430 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003431 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
3432 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003433 }
3434}
3435
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003436void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3437 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003438 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003439 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003440 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3441 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003442 uint32_t regionCount = pResolveImageInfo->regionCount;
3443
3444 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003445 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
3446 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003447 }
3448}
3449
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003450void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer,
3451 const VkResolveImageInfo2* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003452 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003453 auto& funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003454 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3455 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003456 uint32_t regionCount = pResolveImageInfo->regionCount;
3457
3458 for (uint32_t i = 0; i < regionCount; i++) {
3459 QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ,
3460 pResolveImageInfo->pRegions[i].srcSubresource);
3461 QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE,
3462 pResolveImageInfo->pRegions[i].dstSubresource);
3463 }
3464}
3465
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003466void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3467 const VkClearColorValue* pColor, uint32_t rangeCount,
3468 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003469 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003470 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003471 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003472
3473 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003474 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003475 }
3476}
3477
3478void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3479 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3480 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003481 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003482 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003483 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003484
3485 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003486 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003487 }
3488}
3489
3490void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3491 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3492 const VkImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003493 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003494 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003495 auto src = Get<bp_state::Image>(srcImage);
3496 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003497
3498 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003499 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
3500 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003501 }
3502}
3503
3504void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
3505 VkImageLayout dstImageLayout, uint32_t regionCount,
3506 const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003507 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003508 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003509 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003510
3511 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003512 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003513 }
3514}
3515
3516void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3517 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003518 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003519 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003520 auto src = Get<bp_state::Image>(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003521
3522 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003523 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003524 }
3525}
3526
3527void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3528 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3529 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003530 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003531 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003532 auto src = Get<bp_state::Image>(srcImage);
3533 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003534
3535 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003536 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
3537 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003538 }
3539}
3540
Attilio Provenzano02859b22020-02-27 14:17:28 +00003541bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
3542 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
3543 bool skip = false;
3544
3545 if (VendorCheckEnabled(kBPVendorArm)) {
3546 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
3547 skip |= LogPerformanceWarning(
3548 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
3549 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
3550 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
3551 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003552 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003553 }
3554
3555 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
3556 skip |= LogPerformanceWarning(
3557 device, kVUID_BestPractices_CreateSampler_LodClamping,
3558 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
3559 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
3560 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
3561 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
3562 }
3563
3564 if (pCreateInfo->mipLodBias != 0.0f) {
3565 skip |=
3566 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
3567 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
3568 "descriptors being created and may cause reduced performance.",
3569 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
3570 }
3571
3572 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3573 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3574 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
3575 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
3576 skip |= LogPerformanceWarning(
3577 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
3578 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
3579 "This will lead to less efficient descriptors being created and may cause reduced performance. "
3580 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
3581 VendorSpecificTag(kBPVendorArm));
3582 }
3583
3584 if (pCreateInfo->unnormalizedCoordinates) {
3585 skip |= LogPerformanceWarning(
3586 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
3587 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
3588 "descriptors being created and may cause reduced performance.",
3589 VendorSpecificTag(kBPVendorArm));
3590 }
3591
3592 if (pCreateInfo->anisotropyEnable) {
3593 skip |= LogPerformanceWarning(
3594 device, kVUID_BestPractices_CreateSampler_Anisotropy,
3595 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
3596 "and may cause reduced performance.",
3597 VendorSpecificTag(kBPVendorArm));
3598 }
3599 }
3600
3601 return skip;
3602}
Sam Walls8e77e4f2020-03-16 20:47:40 +00003603
Nadav Gevaf0808442021-05-21 13:51:25 -04003604void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
3605 const VkGraphicsPipelineCreateInfo* pCreateInfos,
3606 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
3607 void* cgpl_state) {
3608 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
3609 pPipelines);
3610 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003611 num_pso_ += createInfoCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003612}
3613
3614bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
3615 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
3616 const VkCopyDescriptorSet* pDescriptorCopies) const {
3617 bool skip = false;
3618 if (VendorCheckEnabled(kBPVendorAMD)) {
3619 if (descriptorCopyCount > 0) {
3620 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
3621 "%s Performance warning: copying descriptor sets is not recommended",
3622 VendorSpecificTag(kBPVendorAMD));
3623 }
3624 }
3625
3626 return skip;
3627}
3628
3629bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
3630 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
3631 const VkAllocationCallbacks* pAllocator,
3632 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
3633 bool skip = false;
3634 if (VendorCheckEnabled(kBPVendorAMD)) {
3635 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
3636 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
3637 "vkUpdateDescriptorSet instead",
3638 VendorSpecificTag(kBPVendorAMD));
3639 }
3640
3641 return skip;
3642}
3643
3644bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3645 const VkClearColorValue* pColor, uint32_t rangeCount,
3646 const VkImageSubresourceRange* pRanges) const {
3647 bool skip = false;
3648 if (VendorCheckEnabled(kBPVendorAMD)) {
sfricke-samsungef15e482022-01-26 11:32:49 -08003649 skip |= LogPerformanceWarning(
3650 device, kVUID_BestPractices_ClearAttachment_ClearImage,
Nadav Gevaf0808442021-05-21 13:51:25 -04003651 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3652 "vkCmdClearAttachments instead",
3653 VendorSpecificTag(kBPVendorAMD));
3654 }
3655
3656 return skip;
3657}
3658
3659bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
3660 VkImageLayout imageLayout,
3661 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3662 const VkImageSubresourceRange* pRanges) const {
3663 bool skip = false;
3664 if (VendorCheckEnabled(kBPVendorAMD)) {
3665 skip |= LogPerformanceWarning(
3666 device, kVUID_BestPractices_ClearAttachment_ClearImage,
3667 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3668 "vkCmdClearAttachments instead",
3669 VendorSpecificTag(kBPVendorAMD));
3670 }
3671
3672 return skip;
3673}
3674
3675bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
3676 const VkAllocationCallbacks* pAllocator,
3677 VkPipelineLayout* pPipelineLayout) const {
3678 bool skip = false;
3679 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003680 uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2;
Nadav Gevaf0808442021-05-21 13:51:25 -04003681 // Descriptor sets cost 1 DWORD each.
3682 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
3683 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
3684 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
3685 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
3686 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003687 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003688 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size;
Nadav Gevaf0808442021-05-21 13:51:25 -04003689 }
3690
3691 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
3692 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
3693 }
3694
3695 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
3696 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
3697 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
3698 "Descriptor sets cost 1 DWORD each. "
3699 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
3700 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
3701 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
3702 VendorSpecificTag(kBPVendorAMD));
3703 }
3704 }
3705
Rodrigo Locatti65b33832022-03-15 17:57:30 -03003706 if (VendorCheckEnabled(kBPVendorNVIDIA)) {
3707 bool has_separate_sampler = false;
3708
3709 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; ++i) {
3710 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
3711 for (const auto& binding : descriptor_set_layout_state->GetBindings()) {
3712 if (binding.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) {
3713 has_separate_sampler = true;
3714 }
3715 }
3716 }
3717
3718 if (has_separate_sampler) {
3719 skip |= LogPerformanceWarning(
3720 device, kVUID_BestPractices_CreatePipelineLayout_SeparateSampler,
3721 "%s Consider using combined image samplers instead of separate samplers for marginally better performance.",
3722 VendorSpecificTag(kBPVendorNVIDIA));
3723 }
3724 }
3725
Nadav Gevaf0808442021-05-21 13:51:25 -04003726 return skip;
3727}
3728
3729bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3730 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3731 const VkImageCopy* pRegions) const {
3732 bool skip = false;
3733 std::stringstream src_image_hex;
3734 std::stringstream dst_image_hex;
3735 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
3736 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
3737
3738 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003739 auto src_state = Get<IMAGE_STATE>(srcImage);
3740 auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04003741
3742 if (src_state && dst_state) {
3743 VkImageTiling src_Tiling = src_state->createInfo.tiling;
3744 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
3745 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
3746 skip |=
3747 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
3748 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
3749 "image (vkCmdCopyImageToBuffer) "
3750 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
3751 "copies when converting between linear and optimal images",
3752 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
3753 }
3754 }
3755 }
3756
3757 return skip;
3758}
3759
3760bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
3761 VkPipeline pipeline) const {
3762 bool skip = false;
3763
3764 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003765 if (IsPipelineUsedInFrame(pipeline)) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003766 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
3767 "%s Performance warning: Pipeline %s was bound twice in the frame. Keep pipeline state changes to a minimum,"
3768 "for example, by sorting draw calls by pipeline.",
3769 VendorSpecificTag(kBPVendorAMD), report_data->FormatHandle(pipeline).c_str());
3770 }
3771 }
3772
3773 return skip;
3774}
3775
3776void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
3777 VkFence fence, VkResult result) {
3778 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003779 num_queue_submissions_ += submitCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003780}
3781
3782bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
3783 bool skip = false;
3784
3785 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003786 auto num = num_queue_submissions_.load();
3787 if (num > kNumberOfSubmissionWarningLimitAMD) {
3788 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
3789 "%s Performance warning: command buffers submitted %" PRId32
3790 " times this frame. Submitting command buffers has a CPU "
3791 "and GPU overhead. Submit fewer times to incur less overhead.",
3792 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04003793 }
3794 }
3795
3796 return skip;
3797}
3798
3799void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
3800 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
3801 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
3802 uint32_t bufferMemoryBarrierCount,
3803 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
3804 uint32_t imageMemoryBarrierCount,
3805 const VkImageMemoryBarrier* pImageMemoryBarriers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003806 num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount);
Nadav Gevaf0808442021-05-21 13:51:25 -04003807}
3808
3809bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3810 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
3811 bool skip = false;
3812 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003813 if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003814 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
3815 "%s Performance warning: High number of vkSemaphore objects created."
3816 "Minimize the amount of queue synchronization that is used. "
3817 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
3818 VendorSpecificTag(kBPVendorAMD));
3819 }
3820 }
3821
3822 return skip;
3823}
3824
3825bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3826 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
3827 bool skip = false;
3828 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003829 if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003830 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
3831 "%s Performance warning: High number of VkFence objects created."
3832 "Minimize the amount of CPU-GPU synchronization that is used. "
3833 "Semaphores and fences have overhead.Each fence has a CPU and GPU cost with it.",
3834 VendorSpecificTag(kBPVendorAMD));
3835 }
3836 }
3837
3838 return skip;
3839}
3840
Sam Walls8e77e4f2020-03-16 20:47:40 +00003841void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
3842
3843bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
3844 // look for a cache hit
3845 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
3846 if (hit != _entries.end()) {
3847 // mark the cache hit as being most recently used
3848 hit->age = iteration++;
3849 return true;
3850 }
3851
3852 // if there's no cache hit, we need to model the entry being inserted into the cache
3853 CacheEntry new_entry = {value, iteration};
3854 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
3855 // if there is still space left in the cache, use the next available slot
3856 *(_entries.begin() + iteration) = new_entry;
3857 } else {
3858 // otherwise replace the least recently used cache entry
3859 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
3860 *lru = new_entry;
3861 }
3862 iteration++;
3863 return false;
3864}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003865
3866bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
3867 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003868 auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003869 bool skip = false;
3870 if (swapchain_data && swapchain_data->images.size() == 0) {
3871 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
3872 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
3873 "vkGetSwapchainImagesKHR after swapchain creation.");
3874 }
3875 return skip;
3876}
3877
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003878void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
3879 if (no_pointer) {
3880 if (UNCALLED == call_state) {
3881 call_state = QUERY_COUNT;
3882 }
3883 } else { // Save queue family properties
3884 call_state = QUERY_DETAILS;
3885 }
3886}
3887
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003888void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3889 uint32_t* pQueueFamilyPropertyCount,
3890 VkQueueFamilyProperties* pQueueFamilyProperties) {
3891 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
3892 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003893 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003894 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003895 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3896 nullptr == pQueueFamilyProperties);
3897 }
3898}
3899
3900void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3901 uint32_t* pQueueFamilyPropertyCount,
3902 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3903 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
3904 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003905 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003906 if (bp_pd_state) {
3907 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3908 nullptr == pQueueFamilyProperties);
3909 }
3910}
3911
3912void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
3913 uint32_t* pQueueFamilyPropertyCount,
3914 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3915 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
3916 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003917 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003918 if (bp_pd_state) {
3919 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3920 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003921 }
3922}
3923
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003924void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
3925 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003926 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003927 if (bp_pd_state) {
3928 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3929 }
3930}
3931
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003932void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
3933 VkPhysicalDeviceFeatures2* pFeatures) {
3934 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003935 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003936 if (bp_pd_state) {
3937 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3938 }
3939}
3940
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003941void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
3942 VkPhysicalDeviceFeatures2* pFeatures) {
3943 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003944 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003945 if (bp_pd_state) {
3946 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3947 }
3948}
3949
3950void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
3951 VkSurfaceKHR surface,
3952 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
3953 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003954 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003955 if (bp_pd_state) {
3956 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3957 }
3958}
3959
3960void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
3961 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3962 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003963 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003964 if (bp_pd_state) {
3965 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3966 }
3967}
3968
3969void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
3970 VkSurfaceKHR surface,
3971 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
3972 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003973 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003974 if (bp_pd_state) {
3975 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3976 }
3977}
3978
3979void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
3980 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
3981 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003982 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003983 if (bp_pd_data) {
3984 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
3985
3986 if (*pPresentModeCount) {
3987 if (call_state < QUERY_COUNT) {
3988 call_state = QUERY_COUNT;
3989 }
3990 }
3991 if (pPresentModes) {
3992 if (call_state < QUERY_DETAILS) {
3993 call_state = QUERY_DETAILS;
3994 }
3995 }
3996 }
3997}
3998
3999void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
4000 uint32_t* pSurfaceFormatCount,
4001 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004002 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004003 if (bp_pd_data) {
4004 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
4005
4006 if (*pSurfaceFormatCount) {
4007 if (call_state < QUERY_COUNT) {
4008 call_state = QUERY_COUNT;
4009 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06004010 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004011 }
4012 if (pSurfaceFormats) {
4013 if (call_state < QUERY_DETAILS) {
4014 call_state = QUERY_DETAILS;
4015 }
4016 }
4017 }
4018}
4019
4020void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
4021 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
4022 uint32_t* pSurfaceFormatCount,
4023 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004024 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004025 if (bp_pd_data) {
4026 if (*pSurfaceFormatCount) {
4027 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
4028 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
4029 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06004030 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004031 }
4032 if (pSurfaceFormats) {
4033 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
4034 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
4035 }
4036 }
4037 }
4038}
4039
4040void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
4041 uint32_t* pPropertyCount,
4042 VkDisplayPlanePropertiesKHR* pProperties,
4043 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004044 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004045 if (bp_pd_data) {
4046 if (*pPropertyCount) {
4047 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
4048 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
4049 }
4050 }
4051 if (pProperties) {
4052 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
4053 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
4054 }
4055 }
4056 }
4057}
4058
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004059void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
4060 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
4061 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004062 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Nathaniel Cesario39152e62021-07-02 13:04:16 -06004063 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
4064 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
4065 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06004066 }
4067 }
4068}
4069
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004070void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
4071 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
4072
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06004073 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004074 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02004075 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004076 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07004077 auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004078 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07004079 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01004080 }
4081 }
4082 }
4083}