blob: eaa602509e8a85f2bc613c0174184887b60b9ef9 [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
Camden5b184be2019-08-13 07:50:19 -0600417 return skip;
418}
419
420bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500421 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600422 bool skip = false;
423
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600424 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600425 if (bp_pd_state) {
426 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
427 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
428 "vkCreateSwapchainKHR() called before getting surface capabilities from "
429 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
430 }
Camden83a9c372019-08-14 11:41:38 -0600431
Shannon McPherson73e58c82021-03-05 17:14:26 -0700432 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
433 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600434 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
435 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
436 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
437 }
Camden83a9c372019-08-14 11:41:38 -0600438
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600439 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
440 skip |= LogWarning(
441 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
442 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
443 }
Camden83a9c372019-08-14 11:41:38 -0600444 }
445
Camden5b184be2019-08-13 07:50:19 -0600446 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700447 skip |=
448 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600449 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700450 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
451 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600452 }
453
ziga-lunarg79beba62022-03-30 01:17:30 +0200454 const auto present_mode = pCreateInfo->presentMode;
455 if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) &&
456 (pCreateInfo->minImageCount == 2)) {
Szilard Papp48a6da32020-06-10 14:41:59 +0100457 skip |= LogPerformanceWarning(
458 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
459 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
460 ", which means double buffering is going "
461 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
462 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
463 "3 to use triple buffering to maximize performance in such cases.",
464 pCreateInfo->minImageCount);
465 }
466
Szilard Pappd5f0f812020-06-22 09:01:29 +0100467 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
468 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
469 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
470 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
471 "Presentation modes which are not FIFO will present the latest available frame and discard other "
472 "frame(s) if any.",
473 VendorSpecificTag(kBPVendorArm));
474 }
475
Camden5b184be2019-08-13 07:50:19 -0600476 return skip;
477}
478
479bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
480 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500481 const VkAllocationCallbacks* pAllocator,
482 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600483 bool skip = false;
484
485 for (uint32_t i = 0; i < swapchainCount; i++) {
486 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700487 skip |= LogWarning(
488 device, kVUID_BestPractices_SharingModeExclusive,
489 "Warning: A shared swapchain (index %" PRIu32
490 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
491 "queues (queueFamilyIndexCount of %" PRIu32 ").",
492 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600493 }
494 }
495
496 return skip;
497}
498
499bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500500 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600501 bool skip = false;
502
503 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
504 VkFormat format = pCreateInfo->pAttachments[i].format;
505 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
506 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
507 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700508 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
509 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
510 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
511 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
512 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600513 }
514 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700515 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
516 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
517 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
518 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
519 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600520 }
521 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000522
523 const auto& attachment = pCreateInfo->pAttachments[i];
524 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
525 bool access_requires_memory =
526 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
527
528 if (FormatHasStencil(format)) {
529 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
530 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
531 }
532
533 if (access_requires_memory) {
534 skip |= LogPerformanceWarning(
535 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
536 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
537 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
538 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
539 i, static_cast<uint32_t>(attachment.samples));
540 }
541 }
Camden5b184be2019-08-13 07:50:19 -0600542 }
543
544 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
545 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
546 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
547 }
548
549 return skip;
550}
551
Tony-LunarG767180f2020-04-23 14:03:59 -0600552bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
553 const VkImageView* image_views) const {
554 bool skip = false;
555
556 // Check for non-transient attachments that should be transient and vice versa
557 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200558 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600559 bool attachment_should_be_transient =
560 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
561
562 if (FormatHasStencil(attachment.format)) {
563 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
564 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
565 }
566
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600567 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600568 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600569 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600570
571 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
572
573 // The check for an image that should not be transient applies to all GPUs
574 if (!attachment_should_be_transient && image_is_transient) {
575 skip |= LogPerformanceWarning(
576 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
577 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
578 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
579 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
580 i);
581 }
582
583 bool supports_lazy = false;
584 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
585 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
586 supports_lazy = true;
587 }
588 }
589
590 // The check for an image that should be transient only applies to GPUs supporting
591 // lazily allocated memory
592 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
593 skip |= LogPerformanceWarning(
594 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
595 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
596 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
597 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
598 i);
599 }
600 }
601 }
602 return skip;
603}
604
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000605bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
606 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
607 bool skip = false;
608
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600609 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800610 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600611 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000612 }
613
614 return skip;
615}
616
Sam Wallse746d522020-03-16 21:20:23 +0000617bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
618 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
619 bool skip = false;
620 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
621
622 if (!skip) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700623 const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000624 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
625 // this warning is specific to Arm
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700626 if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) {
Sam Wallse746d522020-03-16 21:20:23 +0000627 skip |= LogPerformanceWarning(
628 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
629 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
630 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
631 VendorSpecificTag(kBPVendorArm));
632 }
ziga-lunarg5a76c442022-04-17 18:04:08 +0200633
634 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
635 // Track number of descriptorSets allowable in this pool
636 if (pool_state->GetAvailableSets() < pAllocateInfo->descriptorSetCount) {
637 skip |= LogWarning(pool_state->Handle(), kVUID_BestPractices_EmptyDescriptorPool,
638 "vkAllocateDescriptorSets(): Unable to allocate %" PRIu32 " descriptorSets from %s"
639 ". This pool only has %" PRIu32 " descriptorSets remaining.",
640 pAllocateInfo->descriptorSetCount, report_data->FormatHandle(pool_state->Handle()).c_str(),
641 pool_state->GetAvailableSets());
642 }
643 }
Sam Wallse746d522020-03-16 21:20:23 +0000644 }
645
646 return skip;
647}
648
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600649void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
650 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000651 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700652 auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
653 if (pool_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000654 // we record successful allocations by subtracting the allocation count from the last recorded free count
655 const auto alloc_count = pAllocateInfo->descriptorSetCount;
656 // clamp the unsigned subtraction to the range [0, last_free_count]
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700657 if (pool_state->freed_count > alloc_count) {
658 pool_state->freed_count -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700659 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700660 pool_state->freed_count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700661 }
Sam Wallse746d522020-03-16 21:20:23 +0000662 }
663 }
664}
665
666void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
667 const VkDescriptorSet* pDescriptorSets, VkResult result) {
668 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
669 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700670 auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000671 // we want to track frees because we're interested in suggesting re-use
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700672 if (pool_state) {
673 pool_state->freed_count += descriptorSetCount;
Sam Wallse746d522020-03-16 21:20:23 +0000674 }
675 }
676}
677
Camden5b184be2019-08-13 07:50:19 -0600678bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500679 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600680 bool skip = false;
681
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700682 if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700683 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
684 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600685 }
686
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000687 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
688 skip |= LogPerformanceWarning(
689 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600690 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
691 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000692 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
693 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
694 }
695
Camden83a9c372019-08-14 11:41:38 -0600696 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
697
698 return skip;
699}
700
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600701void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
702 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
703 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700704 if (result != VK_SUCCESS) {
705 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
706 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800707 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700708 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600709 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700710 return;
711 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700712}
Camden Stocker9738af92019-10-16 13:54:03 -0700713
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600714void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
715 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700716 auto error = std::find(error_codes.begin(), error_codes.end(), result);
717 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000718 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
719 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
720
721 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
722 if (common_failure != common_failure_codes.end()) {
723 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
724 } else {
725 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
726 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700727 return;
728 }
729 auto success = std::find(success_codes.begin(), success_codes.end(), result);
730 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600731 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
732 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500733 }
734}
735
Jeff Bolz5c801d12019-10-09 10:38:45 -0500736bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
737 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700738 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600739 bool skip = false;
740
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700741 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600742
Jeremy Gebben610d3a62022-01-01 12:53:17 -0700743 for (const auto& item : mem_info->ObjectBindings()) {
744 const auto& obj = item.first;
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600745 LogObjectList objlist(device);
746 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600747 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600748 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 -0600749 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600750 }
751
Camden5b184be2019-08-13 07:50:19 -0600752 return skip;
753}
754
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000755bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600756 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700757 auto buffer_state = Get<BUFFER_STATE>(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600758
sfricke-samsunge2441192019-11-06 14:07:57 -0800759 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700760 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
761 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
762 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600763 }
764
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700765 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000766
AndreyVK_D3D0416a332021-11-02 23:22:28 +0300767 if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000768 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
769 skip |= LogPerformanceWarning(
770 device, kVUID_BestPractices_SmallDedicatedAllocation,
771 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600772 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
773 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000774 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
775 }
776
Camden Stockerb603cc82019-09-03 10:09:02 -0600777 return skip;
778}
779
780bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500781 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600782 bool skip = false;
783 const char* api_name = "BindBufferMemory()";
784
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000785 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600786
787 return skip;
788}
789
790bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500791 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600792 char api_name[64];
793 bool skip = false;
794
795 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200796 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000797 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600798 }
799
800 return skip;
801}
Camden Stockerb603cc82019-09-03 10:09:02 -0600802
803bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500804 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600805 char api_name[64];
806 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600807
Camden Stocker8b798ab2019-09-03 10:33:28 -0600808 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200809 snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000810 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600811 }
812
813 return skip;
814}
815
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000816bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600817 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700818 auto image_state = Get<IMAGE_STATE>(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600819
sfricke-samsung71bc6572020-04-29 15:49:43 -0700820 if (image_state->disjoint == false) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600821 if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700822 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
823 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
824 api_name, report_data->FormatHandle(image).c_str());
825 }
826 } else {
827 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
828 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600829 }
830
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700831 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000832
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600833 if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000834 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
835 skip |= LogPerformanceWarning(
836 device, kVUID_BestPractices_SmallDedicatedAllocation,
837 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600838 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
839 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000840 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
841 }
842
843 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
844 // make sure this type is actually used.
845 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
846 // (i.e.most tile - based renderers)
847 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
848 bool supports_lazy = false;
849 uint32_t suggested_type = 0;
850
851 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600852 if ((1u << i) & image_state->requirements[0].memoryTypeBits) {
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000853 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
854 supports_lazy = true;
855 suggested_type = i;
856 break;
857 }
858 }
859 }
860
861 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
862
863 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
864 skip |= LogPerformanceWarning(
865 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600866 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000867 "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 -0600868 "%" PRIu64 " bytes of physical memory.",
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600869 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000870 }
871 }
872
Camden Stocker8b798ab2019-09-03 10:33:28 -0600873 return skip;
874}
875
876bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500877 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600878 bool skip = false;
879 const char* api_name = "vkBindImageMemory()";
880
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000881 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600882
883 return skip;
884}
885
886bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500887 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600888 char api_name[64];
889 bool skip = false;
890
891 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200892 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700893 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -0600894 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
895 }
Camden Stocker8b798ab2019-09-03 10:33:28 -0600896 }
897
898 return skip;
899}
900
901bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500902 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600903 char api_name[64];
904 bool skip = false;
905
906 for (uint32_t i = 0; i < bindInfoCount; i++) {
Frédéric Wangafb89862022-06-21 16:15:29 +0200907 snprintf(api_name, sizeof(api_name), "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000908 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600909 }
910
911 return skip;
912}
Camden83a9c372019-08-14 11:41:38 -0600913
Attilio Provenzano02859b22020-02-27 14:17:28 +0000914static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
915 switch (format) {
916 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
917 case VK_FORMAT_R16_SFLOAT:
918 case VK_FORMAT_R16G16_SFLOAT:
919 case VK_FORMAT_R16G16B16_SFLOAT:
920 case VK_FORMAT_R16G16B16A16_SFLOAT:
921 case VK_FORMAT_R32_SFLOAT:
922 case VK_FORMAT_R32G32_SFLOAT:
923 case VK_FORMAT_R32G32B32_SFLOAT:
924 case VK_FORMAT_R32G32B32A32_SFLOAT:
925 return false;
926
927 default:
928 return true;
929 }
930}
931
932bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
933 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
934 bool skip = false;
935
936 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700937 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000938
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700939 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
940 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
941 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000942 return skip;
943 }
944
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600945 auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200946 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000947
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +0200948 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
949 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount);
950
951 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200952 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000953 uint32_t att = subpass.pColorAttachments[j].attachment;
954
955 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
956 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
957 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
958 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
959 "color attachment #%u makes use "
960 "of a format which cannot be blended at full throughput when using MSAA.",
961 VendorSpecificTag(kBPVendorArm), i, j);
962 }
963 }
964 }
965 }
966
967 return skip;
968}
969
Nadav Gevaf0808442021-05-21 13:51:25 -0400970void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
971 const VkComputePipelineCreateInfo* pCreateInfos,
972 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
973 VkResult result, void* pipe_state) {
974 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700975 pipeline_cache_ = pipelineCache;
Nadav Gevaf0808442021-05-21 13:51:25 -0400976}
977
Camden5b184be2019-08-13 07:50:19 -0600978bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
979 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600980 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500981 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600982 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
983 pAllocator, pPipelines, cgpl_state_data);
ziga-lunarg08c81582022-03-08 17:33:45 +0100984 if (skip) {
985 return skip;
986 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600987 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600988
989 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700990 skip |= LogPerformanceWarning(
991 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
992 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
993 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600994 }
995
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000996 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200997 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000998
Tony-LunarGb6a2daf2022-07-29 11:30:55 -0600999 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 +02001000 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001001 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001002 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
1003 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001004 count++;
1005 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001006 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -06001007 if (count > kMaxInstancedVertexBuffers) {
1008 skip |= LogPerformanceWarning(
1009 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
1010 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
1011 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
1012 count, kMaxInstancedVertexBuffers);
1013 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001014 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001015
Szilard Pappaaf2da32020-06-22 10:37:35 +01001016 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
1017 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001018 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
1019 VendorCheckEnabled(kBPVendorArm)) {
1020 skip |= LogPerformanceWarning(
1021 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
1022 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
1023 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
1024 "efficiency during rasterization. Consider disabling depthBias or increasing either "
1025 "depthBiasConstantFactor or depthBiasSlopeFactor.",
1026 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +01001027 }
1028
Attilio Provenzano02859b22020-02-27 14:17:28 +00001029 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001030 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001031 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001032 auto prev_pipeline = pipeline_cache_.load();
1033 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001034 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
1035 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
1036 "improve cache hit rate", VendorSpecificTag(kBPVendorAMD));
1037 }
1038
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001039 if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001040 skip |=
1041 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
1042 "%s Performance warning: Too many pipelines created, consider consolidation",
1043 VendorSpecificTag(kBPVendorAMD));
1044 }
1045
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -06001046 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001047 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
1048 "%s Performance warning: Use of primitive restart is not recommended",
1049 VendorSpecificTag(kBPVendorAMD));
1050 }
1051
1052 // TODO: this might be too aggressive of a check
1053 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1054 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1055 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1056 VendorSpecificTag(kBPVendorAMD));
1057 }
1058 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001059
Camden5b184be2019-08-13 07:50:19 -06001060 return skip;
1061}
1062
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001063static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info,
1064 std::shared_ptr<const RENDER_PASS_STATE>& rp) {
1065 std::vector<bp_state::AttachmentInfo> result;
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06001066 if (!rp || rp->UsesDynamicRendering()) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001067 return result;
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001068 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001069
1070 const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1071
1072 // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState
1073 // are only non-null if they are enabled.
1074 if (create_info.pColorBlendState) {
1075 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1076 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount);
1077 for (uint32_t j = 0; j < num_color_attachments; j++) {
1078 if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) {
1079 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1080 if (attachment != VK_ATTACHMENT_UNUSED) {
1081 result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT});
1082 }
1083 }
1084 }
1085 }
1086
1087 if (create_info.pDepthStencilState &&
1088 (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable ||
1089 create_info.pDepthStencilState->stencilTestEnable)) {
1090 uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED;
1091 if (attachment != VK_ATTACHMENT_UNUSED) {
1092 VkImageAspectFlags aspects = 0;
1093 if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) {
1094 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1095 }
1096 if (create_info.pDepthStencilState->stencilTestEnable) {
1097 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1098 }
1099 result.push_back({attachment, aspects});
1100 }
1101 }
1102 return result;
1103}
1104
1105bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo,
1106 std::shared_ptr<const RENDER_PASS_STATE>&& rpstate,
1107 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout)
1108 : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)),
1109 access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {}
1110
1111std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState(
1112 const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass,
1113 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const {
1114 return std::static_pointer_cast<PIPELINE_STATE>(
1115 std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout)));
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001116}
1117
Sam Walls0961ec02020-03-31 16:39:15 +01001118void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1119 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1120 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1121 VkResult result, void* cgpl_state_data) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001122 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001123 pipeline_cache_ = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001124}
1125
Camden5b184be2019-08-13 07:50:19 -06001126bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1127 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001128 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001129 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001130 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1131 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001132
1133 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001134 skip |= LogPerformanceWarning(
1135 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1136 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1137 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001138 }
1139
Nadav Gevaf0808442021-05-21 13:51:25 -04001140 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001141 auto prev_pipeline = pipeline_cache_.load();
1142 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
1143 skip |= LogPerformanceWarning(
1144 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1145 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
Nadav Gevaf0808442021-05-21 13:51:25 -04001146 "improve cache hit rate",
1147 VendorSpecificTag(kBPVendorAMD));
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001148 }
1149 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001150
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001151 for (uint32_t i = 0; i < createInfoCount; i++) {
1152 const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i];
1153 if (VendorCheckEnabled(kBPVendorArm)) {
1154 skip |= ValidateCreateComputePipelineArm(createInfo);
1155 }
sfricke-samsung86d055a2022-02-11 14:43:50 -08001156
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001157 if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) {
1158 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
1159 for (const auto& builtin : module_state->static_data_.builtin_decoration_list) {
1160 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1161 skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize,
1162 "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32
1163 "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 "
1164 "extension exposes a new LocalSizeId execution mode that should be used instead.",
1165 i);
sfricke-samsung86d055a2022-02-11 14:43:50 -08001166 }
1167 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001168 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001169 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001170
1171 return skip;
1172}
1173
1174bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1175 bool skip = false;
sfricke-samsungef15e482022-01-26 11:32:49 -08001176 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001177 // Generate warnings about work group sizes based on active resources.
sfricke-samsungef15e482022-01-26 11:32:49 -08001178 auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
1179 if (entrypoint == module_state->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001180
1181 uint32_t x = 1, y = 1, z = 1;
sfricke-samsungef15e482022-01-26 11:32:49 -08001182 module_state->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001183
1184 uint32_t thread_count = x * y * z;
1185
1186 // Generate a priori warnings about work group sizes.
1187 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1188 skip |= LogPerformanceWarning(
1189 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1190 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1191 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1192 "groups with less than %u threads, especially when using barrier() or shared memory.",
1193 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1194 }
1195
1196 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1197 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1198 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1199 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1200 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1201 "%u, %u) is not aligned to %u "
1202 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1203 "leave threads idle on the shader "
1204 "core.",
1205 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1206 kThreadGroupDispatchCountAlignmentArm);
1207 }
1208
sfricke-samsungef15e482022-01-26 11:32:49 -08001209 auto accessible_ids = module_state->MarkAccessibleIds(entrypoint);
1210 auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001211
1212 unsigned dimensions = 0;
1213 if (x > 1) dimensions++;
1214 if (y > 1) dimensions++;
1215 if (z > 1) dimensions++;
1216 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1217 dimensions = std::max(dimensions, 1u);
1218
1219 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1220 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1221 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1222 bool accesses_2d = false;
1223 for (const auto& usage : descriptor_uses) {
sfricke-samsungef15e482022-01-26 11:32:49 -08001224 auto dim = module_state->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001225 if (dim < 0) continue;
1226 auto spvdim = spv::Dim(dim);
1227 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1228 }
1229
1230 if (accesses_2d && dimensions < 2) {
1231 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1232 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1233 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1234 "exhibiting poor spatial locality with respect to one or more shader resources.",
1235 VendorSpecificTag(kBPVendorArm), x, y, z);
1236 }
1237
Camden5b184be2019-08-13 07:50:19 -06001238 return skip;
1239}
1240
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001241bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001242 bool skip = false;
1243
1244 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001245 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1246 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001247 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001248 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1249 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001250 }
1251
1252 return skip;
1253}
1254
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001255bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1256 bool skip = false;
1257
1258 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1259 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1260 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1261 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1262 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1263 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1264 }
1265
1266 return skip;
1267}
1268
1269bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1270 bool skip = false;
1271 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1272
1273 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1274 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1275
1276 return skip;
1277}
1278
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001279void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001280 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1281 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1282 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1283 LogPerformanceWarning(
1284 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1285 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1286 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1287 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1288 "convenient opportunity.",
1289 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1290 }
1291 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001292
1293 // AMD best practice
1294 // end-of-frame cleanup
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001295 num_queue_submissions_ = 0;
1296 num_barriers_objects_ = 0;
1297 ClearPipelinesUsedInFrame();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001298}
1299
Jeff Bolz5c801d12019-10-09 10:38:45 -05001300bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1301 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001302 bool skip = false;
1303
1304 for (uint32_t submit = 0; submit < submitCount; submit++) {
1305 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1306 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1307 }
ziga-lunargc77f0c02022-04-18 00:15:16 +02001308 if (pSubmits[submit].signalSemaphoreCount == 0 && pSubmits[submit].pSignalSemaphores != nullptr) {
1309 skip |=
1310 LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1311 "pSubmits[%" PRIu32 "].pSignalSemaphores is set, but pSubmits[%" PRIu32 "].signalSemaphoreCount is 0.",
1312 submit, submit);
1313 }
1314 if (pSubmits[submit].waitSemaphoreCount == 0 && pSubmits[submit].pWaitSemaphores != nullptr) {
1315 skip |= LogWarning(device, kVUID_BestPractices_SemaphoreCount,
1316 "pSubmits[%" PRIu32 "].pWaitSemaphores is set, but pSubmits[%" PRIu32 "].waitSemaphoreCount is 0.",
1317 submit, submit);
1318 }
Camden5b184be2019-08-13 07:50:19 -06001319 }
1320
1321 return skip;
1322}
1323
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001324bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1325 VkFence fence) const {
1326 bool skip = false;
1327
1328 for (uint32_t submit = 0; submit < submitCount; submit++) {
1329 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1330 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1331 }
1332 }
1333
1334 return skip;
1335}
1336
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001337bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits,
1338 VkFence fence) const {
1339 bool skip = false;
1340
1341 for (uint32_t submit = 0; submit < submitCount; submit++) {
1342 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1343 skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1344 }
1345 }
1346
1347 return skip;
1348}
1349
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001350bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1351 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1352 bool skip = false;
1353
1354 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1355 skip |= LogPerformanceWarning(
1356 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1357 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1358 "pool instead.");
1359 }
1360
1361 return skip;
1362}
1363
1364bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1365 const VkCommandBufferBeginInfo* pBeginInfo) const {
1366 bool skip = false;
1367
1368 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1369 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1370 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1371 }
1372
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001373 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1374 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001375 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1376 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1377 VendorSpecificTag(kBPVendorArm));
1378 }
1379
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001380 return skip;
1381}
1382
Jeff Bolz5c801d12019-10-09 10:38:45 -05001383bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001384 bool skip = false;
1385
1386 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1387
1388 return skip;
1389}
1390
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001391bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1392 const VkDependencyInfoKHR* pDependencyInfo) const {
1393 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1394}
1395
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001396bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1397 const VkDependencyInfo* pDependencyInfo) const {
1398 return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo);
1399}
1400
Jeff Bolz5c801d12019-10-09 10:38:45 -05001401bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1402 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001403 bool skip = false;
1404
1405 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1406
1407 return skip;
1408}
1409
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001410bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1411 VkPipelineStageFlags2KHR stageMask) const {
1412 bool skip = false;
1413
1414 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1415
1416 return skip;
1417}
1418
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001419bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1420 VkPipelineStageFlags2 stageMask) const {
1421 bool skip = false;
1422
1423 skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask);
1424
1425 return skip;
1426}
1427
Camden5b184be2019-08-13 07:50:19 -06001428bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1429 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1430 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1431 uint32_t bufferMemoryBarrierCount,
1432 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1433 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001434 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001435 bool skip = false;
1436
1437 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1438 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1439
1440 return skip;
1441}
1442
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001443bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1444 const VkDependencyInfoKHR* pDependencyInfos) const {
1445 bool skip = false;
1446 for (uint32_t i = 0; i < eventCount; i++) {
1447 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1448 }
1449
1450 return skip;
1451}
1452
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001453bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1454 const VkDependencyInfo* pDependencyInfos) const {
1455 bool skip = false;
1456 for (uint32_t i = 0; i < eventCount; i++) {
1457 skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]);
1458 }
1459
1460 return skip;
1461}
1462
Camden5b184be2019-08-13 07:50:19 -06001463bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1464 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1465 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1466 uint32_t bufferMemoryBarrierCount,
1467 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1468 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001469 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001470 bool skip = false;
1471
1472 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1473 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1474
ziga-lunargb65dbfb2022-03-19 18:45:09 +01001475 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1476 if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED &&
1477 IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) {
1478 skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly,
1479 "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents "
1480 "may be discarded, but the newLayout is %s, which is read only.",
1481 string_VkImageLayout(pImageMemoryBarriers[i].newLayout));
1482 }
1483 }
1484
Nadav Gevaf0808442021-05-21 13:51:25 -04001485 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001486 auto num = num_barriers_objects_.load();
1487 if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001488 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001489 "%s Performance warning: In this frame, %" PRIu32
1490 " barriers were already submitted. Barriers have a high cost and can "
1491 "stall the GPU. "
1492 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1493 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04001494 }
1495
1496 std::array<VkImageLayout, 3> read_layouts = {
1497 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1498 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1499 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1500 };
1501
1502 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1503 // read to read barriers
1504 auto found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].oldLayout);
1505 bool old_is_read_layout = found != read_layouts.end();
1506 found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].newLayout);
1507 bool new_is_read_layout = found != read_layouts.end();
1508 if (old_is_read_layout && new_is_read_layout) {
1509 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
1510 "%s Performance warning: Don't issue read-to-read barriers. Get the resource in the right state the first "
1511 "time you use it.",
1512 VendorSpecificTag(kBPVendorAMD));
1513 }
1514
1515 // general with no storage
1516 if (pImageMemoryBarriers[i].newLayout == VK_IMAGE_LAYOUT_GENERAL) {
1517 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1518 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1519 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1520 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1521 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1522 VendorSpecificTag(kBPVendorAMD));
1523 }
1524 }
1525 }
1526 }
1527
Camden5b184be2019-08-13 07:50:19 -06001528 return skip;
1529}
1530
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001531bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1532 const VkDependencyInfoKHR* pDependencyInfo) const {
1533 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1534}
1535
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001536bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer,
1537 const VkDependencyInfo* pDependencyInfo) const {
1538 return CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo);
1539}
1540
Camden5b184be2019-08-13 07:50:19 -06001541bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001542 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001543 bool skip = false;
1544
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001545 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1546
1547 return skip;
1548}
1549
1550bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1551 VkQueryPool queryPool, uint32_t query) const {
1552 bool skip = false;
1553
1554 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001555
1556 return skip;
1557}
1558
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001559bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage,
1560 VkQueryPool queryPool, uint32_t query) const {
1561 bool skip = false;
1562
1563 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage);
1564
1565 return skip;
1566}
1567
Sam Walls0961ec02020-03-31 16:39:15 +01001568void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1569 VkPipeline pipeline) {
1570 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1571
Nadav Gevaf0808442021-05-21 13:51:25 -04001572 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001573 PipelineUsedInFrame(pipeline);
Nadav Gevaf0808442021-05-21 13:51:25 -04001574
Sam Walls0961ec02020-03-31 16:39:15 +01001575 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001576 auto pipeline_state = Get<bp_state::Pipeline>(pipeline);
Sam Walls0961ec02020-03-31 16:39:15 +01001577 // check for depth/blend state tracking
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001578 if (pipeline_state) {
1579 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001580 assert(cb_node);
1581 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001582
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001583 render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments;
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001584 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001585
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07001586 const auto* blend_state = pipeline_state->ColorBlendState();
1587 const auto* stencil_state = pipeline_state->DepthStencilState();
Sam Walls0961ec02020-03-31 16:39:15 +01001588
1589 if (blend_state) {
1590 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001591 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001592 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1593 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001594 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001595 }
1596 }
1597 }
1598
1599 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001600 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001601
1602 if (stencil_state && stencil_state->depthTestEnable) {
1603 switch (stencil_state->depthCompareOp) {
1604 case VK_COMPARE_OP_EQUAL:
1605 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1606 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001607 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001608 break;
1609 default:
1610 break;
1611 }
1612 }
Sam Walls0961ec02020-03-31 16:39:15 +01001613 }
1614 }
1615}
1616
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02001617static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1618 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
1619 const auto& subpass_info = createInfo.pSubpasses[subpass];
1620 if (subpass_info.pResolveAttachments) {
1621 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1622 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1623 }
1624 }
1625 }
1626
1627 return false;
1628}
1629
Attilio Provenzano02859b22020-02-27 14:17:28 +00001630static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1631 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001632 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001633
1634 // If an attachment is ever used as a color attachment,
1635 // resolve attachment or depth stencil attachment,
1636 // it needs to exist on tile at some point.
1637
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001638 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1639 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001640 }
1641
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001642 if (subpass_info.pResolveAttachments) {
1643 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1644 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1645 }
1646 }
1647
1648 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001649 }
1650
1651 return false;
1652}
1653
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001654static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1655 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1656 return false;
1657 }
1658
1659 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001660 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001661
1662 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1663 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1664 return true;
1665 }
1666 }
1667 }
1668
1669 return false;
1670}
1671
Attilio Provenzano02859b22020-02-27 14:17:28 +00001672bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1673 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1674 bool skip = false;
1675
1676 if (!pRenderPassBegin) {
1677 return skip;
1678 }
1679
Gareth Webbdc6549a2021-06-16 03:52:24 +01001680 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
1681 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
1682 "This render pass has a zero-size render area. It cannot write to any attachments, "
1683 "and can only be used for side effects such as layout transitions.");
1684 }
1685
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001686 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001687 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001688 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001689 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001690 if (rpabi) {
1691 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1692 }
1693 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001694 // Check if any attachments have LOAD operation on them
1695 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001696 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001697
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001698 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02001699 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001700 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001701 }
1702
1703 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001704 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001705 }
1706
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001707 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001708
1709 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001710 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1711 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001712 }
1713
1714 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
LawG47747b322022-02-23 16:12:10 +00001715 if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
1716 skip |=
1717 LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
LawG4015be1c2022-03-01 10:37:52 +00001718 "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
LawG47747b322022-02-23 16:12:10 +00001719 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04001720 "which will copy in total %u pixels (renderArea = "
LawG47747b322022-02-23 16:12:10 +00001721 "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.",
1722 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att,
1723 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1724 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1725 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001726 }
1727 }
paul-lunarg7089e272022-06-20 22:19:37 +02001728
1729 // Check if renderpass has at least one VK_ATTACHMENT_LOAD_OP_CLEAR
1730
1731 bool clearing = false;
1732
1733 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
1734 const auto& attachment = rp_state->createInfo.pAttachments[att];
1735
1736 if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) {
1737 clearing = true;
1738 break;
1739 }
1740 }
1741
1742 // Check if there are ClearValues passed to BeginRenderPass even though no attachments will be cleared
1743 if (!clearing && pRenderPassBegin->clearValueCount > 0) {
1744 // Flag as warning because nothing will happen per spec, and pClearValues will be ignored
1745 skip |= LogWarning(
1746 device, kVUID_BestPractices_ClearValueWithoutLoadOpClear,
1747 "This render pass does not have VkRenderPassCreateInfo.pAttachments->loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR "
1748 "but VkRenderPassBeginInfo.clearValueCount > 0. VkRenderPassBeginInfo.pClearValues will be ignored and no "
paul-lunarga0a149c2022-06-23 16:18:51 +02001749 "attachments will be cleared.");
paul-lunarg7089e272022-06-20 22:19:37 +02001750 }
paul-lunarga0a149c2022-06-23 16:18:51 +02001751
1752 // Check if there are more clearValues than attachments
1753 if(pRenderPassBegin->clearValueCount > rp_state->createInfo.attachmentCount) {
1754 // Flag as warning because the overflowing clearValues will be ignored and could even be undefined on certain platforms.
1755 // This could signal a bug and there seems to be no reason for this to happen on purpose.
1756 skip |= LogWarning(
1757 device, kVUID_BestPractices_ClearValueCountHigherThanAttachmentCount,
1758 "This render pass has VkRenderPassBeginInfo.clearValueCount > VkRenderPassCreateInfo.attachmentCount "
1759 "(%" PRIu32 " > %" PRIu32 ") and as such the clearValues that do not have a corresponding attachment will be ignored.",
1760 pRenderPassBegin->clearValueCount, rp_state->createInfo.attachmentCount);
1761 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001762 }
1763
1764 return skip;
1765}
1766
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001767void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
1768 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001769 if (view) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001770 auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state);
1771 QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001772 }
1773}
1774
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001775void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1776 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001777 // If we're viewing a 3D slice, ignore base array layer.
1778 // The entire 3D subresource is accessed as one atomic unit.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001779 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 +02001780
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001781 const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001782 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001783 const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel;
1784 const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001785
1786 for (uint32_t layer = 0; layer < array_layers; layer++) {
1787 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001788 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
1789 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001790 }
1791 }
1792}
1793
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001794void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1795 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) {
1796 const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001797 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001798
1799 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001800 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001801 }
1802}
1803
paul-lunarg5eb52062022-06-27 18:57:15 +02001804void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1805 IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer, uint32_t mip_level) {
1806 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](const ValidationStateTracker&, const QUEUE_STATE&,
1807 const CMD_BUFFER_STATE&) -> bool {
1808 ValidateImageInQueue(function_name, *state, usage, array_layer, mip_level);
1809 return false;
1810 });
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001811}
1812
LawG44d414ba2022-02-23 15:35:41 +00001813void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001814 IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001815 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001816 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001817 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 -07001818 !image.IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001819 LogPerformanceWarning(
1820 device, kVUID_BestPractices_RenderPass_RedundantStore,
LawG4015be1c2022-03-01 10:37:52 +00001821 "%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 +02001822 "image was used, it was written to with STORE_OP_STORE. "
1823 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1824 "architectures.",
LawG44d414ba2022-02-23 15:35:41 +00001825 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001826 } 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 +02001827 LogPerformanceWarning(
1828 device, kVUID_BestPractices_RenderPass_RedundantClear,
LawG4015be1c2022-03-01 10:37:52 +00001829 "%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 +02001830 "image was used, it was written to with vkCmdClear*Image(). "
1831 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
LawG44d414ba2022-02-23 15:35:41 +00001832 "tile-based architectures.",
1833 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001834 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001835 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1836 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001837 const char *last_cmd = nullptr;
1838 const char *vuid = nullptr;
1839 const char *suggestion = nullptr;
1840
1841 switch (last_usage) {
1842 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1843 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1844 last_cmd = "vkCmdBlitImage";
1845 suggestion =
1846 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1847 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1848 "which avoids the memory roundtrip.";
1849 break;
1850 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1851 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1852 last_cmd = "vkCmdClear*Image";
1853 suggestion =
1854 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1855 "tile-based architectures. "
1856 "Use LOAD_OP_CLEAR instead to clear the image for free.";
1857 break;
1858 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
1859 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
1860 last_cmd = "vkCmdCopy*Image";
1861 suggestion =
1862 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1863 "Rather than copying, just render the source image in a fragment shader in this render pass, "
1864 "which avoids the memory roundtrip.";
1865 break;
1866 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
1867 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
1868 last_cmd = "vkCmdResolveImage";
1869 suggestion =
1870 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
1871 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
1872 "which avoids the memory roundtrip.";
1873 break;
1874 default:
1875 break;
1876 }
1877
1878 LogPerformanceWarning(
1879 device, vuid,
LawG4015be1c2022-03-01 10:37:52 +00001880 "%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 +01001881 "time image was used, it was written to with %s. %s",
LawG44d414ba2022-02-23 15:35:41 +00001882 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd,
1883 suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001884 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001885}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001886
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001887void BestPractices::ValidateImageInQueue(const char* function_name, bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage,
1888 uint32_t array_layer, uint32_t mip_level) {
1889 auto last_usage = state.UpdateUsage(array_layer, mip_level, usage);
paul-lunarg5eb52062022-06-27 18:57:15 +02001890
1891 // When image was discarded with StoreOpDontCare but is now being read with LoadOpLoad
1892 if (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED &&
1893 usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE) {
1894 LogWarning(device, kVUID_BestPractices_StoreOpDontCareThenLoadOpLoad,
1895 "Trying to load an attachment with LOAD_OP_LOAD that was previously stored with STORE_OP_DONT_CARE. This may "
1896 "result in undefined behaviour.");
1897 }
1898
LawG44d414ba2022-02-23 15:35:41 +00001899 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
1900 ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001901 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001902}
1903
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001904void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) {
1905 cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(),
1906 cb.queue_submit_functions_after_render_pass.end());
1907 cb.queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001908}
1909
1910void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
1911 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001912 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1913 if (cb_node) {
1914 AddDeferredQueueOperations(*cb_node);
1915 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001916}
1917
1918void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
1919 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001920 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1921 if (cb_node) {
1922 AddDeferredQueueOperations(*cb_node);
1923 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001924}
1925
1926void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
1927 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001928 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1929 if (cb_node) {
1930 AddDeferredQueueOperations(*cb_node);
1931 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001932}
1933
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001934void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
1935 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001936 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001937 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001938 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1939}
1940
1941void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
1942 const VkRenderPassBeginInfo* pRenderPassBegin,
1943 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1944 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1945 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1946}
1947
1948void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1949 const VkRenderPassBeginInfo* pRenderPassBegin,
1950 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1951 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1952 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1953}
1954
1955void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001956
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001957 if (!pRenderPassBegin) {
1958 return;
1959 }
1960
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001961 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001962
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001963 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001964 if (rp_state) {
1965 // Check load ops
1966 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001967 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001968
1969 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
1970 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1971 continue;
1972 }
1973
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001974 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001975
1976 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
1977 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001978 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001979 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
1980 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001981 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001982 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001983 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001984 }
1985
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001986 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Jeremy Gebben9f537102021-10-05 16:37:12 -06001987 std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr;
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001988
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001989 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001990 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1991 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001992 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001993 }
1994 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001995 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001996 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001997
Jeremy Gebben9f537102021-10-05 16:37:12 -06001998 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001999 }
2000
2001 // Check store ops
2002 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002003 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002004
2005 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
2006 continue;
2007 }
2008
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002009 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002010
2011 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
2012 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01002013 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002014 }
2015
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002016 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002017
Jeremy Gebben9f537102021-10-05 16:37:12 -06002018 std::shared_ptr<IMAGE_VIEW_STATE> image_view;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06002019 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002020 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
2021 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002022 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002023 }
2024 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002025 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01002026 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002027
Jeremy Gebben9f537102021-10-05 16:37:12 -06002028 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002029 }
2030 }
2031}
2032
Attilio Provenzano02859b22020-02-27 14:17:28 +00002033bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2034 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002035 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2036 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002037 return skip;
2038}
2039
2040bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2041 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002042 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002043 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2044 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002045 return skip;
2046}
2047
2048bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08002049 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01002050 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2051 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002052 return skip;
2053}
2054
Sam Walls0961ec02020-03-31 16:39:15 +01002055void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
2056 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002057 // Reset the renderpass state
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002058 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
sjfricke52defd42022-08-08 16:37:46 +09002059 // TODO - move this logic to the Render Pass state as cb->has_draw_cmd should stay true for lifetime of command buffer
2060 cb->has_draw_cmd = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002061 assert(cb);
2062 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002063 render_pass_state.touchesAttachments.clear();
2064 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002065 render_pass_state.numDrawCallsDepthOnly = 0;
2066 render_pass_state.numDrawCallsDepthEqualCompare = 0;
2067 render_pass_state.colorAttachment = false;
2068 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002069 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002070 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01002071
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002072 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01002073
2074 // track depth / color attachment usage within the renderpass
2075 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
2076 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002077 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002078
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02002079 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002080 }
2081}
2082
2083void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2084 VkSubpassContents contents) {
2085 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2086 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
2087}
2088
2089void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2090 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2091 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2092 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2093}
2094
2095void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2096 const VkRenderPassBeginInfo* pRenderPassBegin,
2097 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2098 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2099 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2100}
2101
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002102// Generic function to handle validation for all CmdDraw* type functions
2103bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
2104 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002105 const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002106 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002107 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2108 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002109 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002110
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002111 // Verify vertex binding
Tony-LunarG2ffe1f52022-04-11 15:13:30 -06002112 if (pipeline_state && pipeline_state->vertex_input_state &&
2113 pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) {
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002114 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002115 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002116 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002117 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
2118 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002119 }
2120 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002121
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002122 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002123 if (pipe) {
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002124 const auto& rp_state = pipe->RenderPassState();
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002125 if (rp_state) {
2126 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
2127 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002128 const auto* ds_state = pipe->DepthStencilState();
Jeremy Gebben11af9792021-08-20 10:20:09 -06002129 const uint32_t depth_stencil_attachment =
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002130 GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment);
2131 const auto* raster_state = pipe->RasterizationState();
2132 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state &&
2133 raster_state->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002134 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
2135 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
2136 }
2137 }
2138 }
2139 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002140 }
2141 return skip;
2142}
2143
Sam Walls0961ec02020-03-31 16:39:15 +01002144void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002145 auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002146 assert(cb_node);
Sam Walls0961ec02020-03-31 16:39:15 +01002147 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002148 RecordCmdDrawTypeArm(*cb_node, draw_count, caller);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002149 }
2150
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002151 if (cb_node->render_pass_state.drawTouchAttachments) {
2152 for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) {
2153 RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002154 }
2155 // No need to touch the same attachments over and over.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002156 cb_node->render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002157 }
2158}
2159
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002160void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) {
2161 auto& render_pass_state = cb_node.render_pass_state;
LawG4b21485c2022-02-28 13:46:48 +00002162 // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards
2163 // depth prepass warnings First find the lowest enabled draw count
2164 uint32_t lowestEnabledMinDrawCount = 0;
2165 lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm;
2166 if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount)
2167 lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG;
2168
2169 if (draw_count >= lowestEnabledMinDrawCount) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002170 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
2171 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01002172 }
2173}
2174
Camden5b184be2019-08-13 07:50:19 -06002175bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002176 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002177 bool skip = false;
2178
2179 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002180 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2181 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002182 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002183 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06002184
2185 return skip;
2186}
2187
Sam Walls0961ec02020-03-31 16:39:15 +01002188void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2189 uint32_t firstVertex, uint32_t firstInstance) {
2190 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
2191 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
2192}
2193
Camden5b184be2019-08-13 07:50:19 -06002194bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002195 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002196 bool skip = false;
2197
2198 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002199 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2200 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002201 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002202 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
2203
Attilio Provenzano02859b22020-02-27 14:17:28 +00002204 // Check if we reached the limit for small indexed draw calls.
2205 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002206 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002207 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002208 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
LawG4ff42d722022-03-01 10:28:25 +00002209 (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002210 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
LawG4ff42d722022-03-01 10:28:25 +00002211 "%s %s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00002212 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
2213 "You can try batching drawcalls or instancing when applicable.",
LawG4ff42d722022-03-01 10:28:25 +00002214 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls,
2215 kSmallIndexedDrawcallIndices);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002216 }
2217
Sam Walls8e77e4f2020-03-16 20:47:40 +00002218 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002219 ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002220 }
2221
2222 return skip;
2223}
2224
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002225bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount,
Sam Walls8e77e4f2020-03-16 20:47:40 +00002226 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
2227 bool skip = false;
2228
2229 // check for sparse/underutilised index buffer, and post-transform cache thrashing
Sam Walls8e77e4f2020-03-16 20:47:40 +00002230
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002231 const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get();
2232 if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002233
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002234 const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002235 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00002236 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
2237 const void* ib_mem = ib_mem_state.p_driver_data;
2238 bool primitive_restart_enable = false;
2239
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002240 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002241 const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point];
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002242 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002243
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002244 const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr;
2245 if (ia_state) {
2246 primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002247 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00002248
2249 // 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 -06002250 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00002251 uint32_t scan_stride;
2252 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2253 scan_stride = sizeof(uint8_t);
2254 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2255 scan_stride = sizeof(uint16_t);
2256 } else {
2257 scan_stride = sizeof(uint32_t);
2258 }
2259
2260 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
2261 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
2262
2263 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
2264 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
2265 // irrespective of whether or not they're part of the draw call.
2266
2267 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
2268 uint32_t min_index = ~0u;
2269 // start with maximum as 0 and adjust to indices in the buffer
2270 uint32_t max_index = 0u;
2271
2272 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
2273 // for the given index buffer
2274 uint32_t vertex_shade_count = 0;
2275
2276 PostTransformLRUCacheModel post_transform_cache;
2277
2278 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
2279 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
2280 // target architecture.
2281 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
2282 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
2283 post_transform_cache.resize(32);
2284
2285 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2286 uint32_t scan_index;
2287 uint32_t primitive_restart_value;
2288 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2289 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2290 primitive_restart_value = 0xFF;
2291 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2292 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2293 primitive_restart_value = 0xFFFF;
2294 } else {
2295 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2296 primitive_restart_value = 0xFFFFFFFF;
2297 }
2298
2299 max_index = std::max(max_index, scan_index);
2300 min_index = std::min(min_index, scan_index);
2301
2302 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
2303 bool in_cache = post_transform_cache.query_cache(scan_index);
2304 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
2305 if (!in_cache) vertex_shade_count++;
2306 }
2307 }
2308
2309 // 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 +01002310 // 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
2311 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002312
2313 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07002314 skip |=
2315 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2316 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
2317 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
2318 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
2319 "maximum would be loaded, and possibly shaded, whether or not they are used.",
2320 VendorSpecificTag(kBPVendorArm),
2321 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002322 return skip;
2323 }
2324
2325 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
2326 // 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 +01002327 const size_t refs_per_bucket = 64;
2328 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
2329
2330 const uint32_t n_indices = max_index - min_index + 1;
2331 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
2332 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
2333
2334 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
2335 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00002336
2337 // To avoid using too much memory, we run over the indices again.
2338 // Knowing the size from the last scan allows us to record index usage with bitsets
2339 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2340 uint32_t scan_index;
2341 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2342 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2343 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2344 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2345 } else {
2346 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2347 }
2348 // keep track of the set of all indices used to reference vertices in the draw call
2349 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01002350 size_t bitset_bucket_index = index_offset / refs_per_bucket;
2351 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002352 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
2353 }
2354
2355 uint32_t vertex_reference_count = 0;
2356 for (const auto& bitset : vertex_reference_buckets) {
2357 vertex_reference_count += static_cast<uint32_t>(bitset.count());
2358 }
2359
2360 // 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 -07002361 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002362 // 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 -07002363 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002364
2365 if (utilization < 0.5f) {
2366 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2367 "%s The indices which were specified for the draw call only utilise approximately "
2368 "%.02f%% of the bound vertex buffer.",
2369 VendorSpecificTag(kBPVendorArm), utilization);
2370 }
2371
2372 if (cache_hit_rate <= 0.5f) {
2373 skip |=
2374 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
2375 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
2376 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
2377 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
2378 "recently shaded vertices.",
2379 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
2380 }
2381 }
2382
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002383 return skip;
2384}
2385
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002386bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2387 const VkCommandBuffer* pCommandBuffers) const {
2388 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002389 const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002390 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002391 const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002392 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002393 continue;
2394 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002395 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002396 for (auto& clear : secondary.earlyClearAttachments) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002397 if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) {
2398 skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002399 }
2400 }
2401 }
Nadav Gevaf0808442021-05-21 13:51:25 -04002402
2403 if (VendorCheckEnabled(kBPVendorAMD)) {
2404 if (commandBufferCount > 0) {
2405 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
2406 "%s Performance warning: Use of secondary command buffers is not recommended. ",
2407 VendorSpecificTag(kBPVendorAMD));
2408 }
2409 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002410 return skip;
2411}
2412
2413void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2414 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002415 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
2416
2417 auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2418 if (!primary) {
2419 return;
2420 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002421
2422 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002423 auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]);
2424 if (!secondary) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002425 continue;
2426 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002427
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002428 for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) {
2429 if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
2430 RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment,
2431 early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002432 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002433 RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002434 }
2435 }
2436
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002437 for (auto& touch : secondary->render_pass_state.touchesAttachments) {
2438 RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002439 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02002440
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002441 primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare;
2442 primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002443 }
2444
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002445}
2446
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002447void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
2448 auto& state = cb_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002449 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002450 auto itr =
2451 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2452 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002453
2454 if (itr != state.touchesAttachments.end()) {
2455 itr->aspects |= aspects;
2456 } else {
2457 state.touchesAttachments.push_back({ fb_attachment, aspects });
2458 }
2459}
2460
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002461void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002462 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
2463 const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002464 auto& state = cmd_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002465 // If we observe a full clear before any other access to a frame buffer attachment,
2466 // we have candidate for redundant clear attachments.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002467 auto itr =
2468 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2469 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002470
2471 uint32_t new_aspects = aspects;
2472 if (itr != state.touchesAttachments.end()) {
2473 new_aspects = aspects & ~itr->aspects;
2474 itr->aspects |= aspects;
2475 } else {
2476 state.touchesAttachments.push_back({ fb_attachment, aspects });
2477 }
2478
2479 if (new_aspects == 0) {
2480 return;
2481 }
2482
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002483 if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002484 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
2485 // CmdExecuteCommands.
2486 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
2487 std::vector<VkClearRect>{pRects, pRects + rectCount} });
2488 }
2489}
2490
2491void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
2492 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
2493 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002494 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects);
2495
2496 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2497 auto* rp_state = cmd_state->activeRenderPass.get();
2498 auto* fb_state = cmd_state->activeFramebuffer.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002499 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
2500
2501 if (rectCount == 0 || !rp_state) {
2502 return;
2503 }
2504
2505 if (!is_secondary && !fb_state) {
2506 return;
2507 }
2508
2509 // 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 -07002510 bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002511
Jeremy Gebbenb5dda542022-08-02 14:26:20 -06002512 if (!rp_state->UsesDynamicRendering()) {
ziga-lunarg885c6542022-03-07 01:08:25 +01002513 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
2514 for (uint32_t i = 0; i < attachmentCount; i++) {
2515 auto& attachment = pClearAttachments[i];
2516 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2517 VkImageAspectFlags aspects = attachment.aspectMask;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002518
ziga-lunarg885c6542022-03-07 01:08:25 +01002519 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
2520 if (subpass.pDepthStencilAttachment) {
2521 fb_attachment = subpass.pDepthStencilAttachment->attachment;
2522 }
2523 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
2524 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002525 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002526
ziga-lunarg885c6542022-03-07 01:08:25 +01002527 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2528 if (full_clear) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002529 RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment,
ziga-lunarg885c6542022-03-07 01:08:25 +01002530 aspects, rectCount, pRects);
2531 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002532 RecordAttachmentAccess(*cmd_state, fb_attachment, aspects);
ziga-lunarg885c6542022-03-07 01:08:25 +01002533 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002534 }
2535 }
2536 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002537}
2538
Attilio Provenzano02859b22020-02-27 14:17:28 +00002539void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2540 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2541 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
2542 firstInstance);
2543
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002544 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002545 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
2546 cmd_state->small_indexed_draw_call_count++;
2547 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002548
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002549 ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00002550}
2551
Sam Walls0961ec02020-03-31 16:39:15 +01002552void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2553 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2554 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2555 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
2556}
2557
sfricke-samsung681ab7b2020-10-29 01:53:35 -07002558bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2559 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
2560 uint32_t maxDrawCount, uint32_t stride) const {
2561 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
2562
2563 return skip;
2564}
2565
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002566bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
2567 VkDeviceSize offset, VkBuffer countBuffer,
2568 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
2569 uint32_t stride) const {
2570 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06002571
2572 return skip;
2573}
2574
2575bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002576 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002577 bool skip = false;
2578
2579 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002580 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2581 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002582 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002583 }
2584
2585 return skip;
2586}
2587
Sam Walls0961ec02020-03-31 16:39:15 +01002588void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2589 uint32_t count, uint32_t stride) {
2590 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2591 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2592}
2593
Camden5b184be2019-08-13 07:50:19 -06002594bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002595 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002596 bool skip = false;
2597
2598 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002599 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2600 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002601 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002602 }
2603
2604 return skip;
2605}
2606
Sam Walls0961ec02020-03-31 16:39:15 +01002607void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2608 uint32_t count, uint32_t stride) {
2609 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2610 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2611}
2612
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002613void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) {
2614 for (auto descriptor_set : cb_state.validated_descriptor_sets) {
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002615 for (const auto& binding : *descriptor_set) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002616 // For bindless scenarios, we should not attempt to track descriptor set state.
2617 // It is highly uncertain which resources are actually bound.
2618 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002619 if (binding->binding_flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2620 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002621 continue;
2622 }
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002623
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002624 for (uint32_t i = 0; i < binding->count; ++i) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002625 VkImageView image_view{VK_NULL_HANDLE};
2626
Jeremy Gebben1b9fdb82022-06-15 15:31:32 -06002627 auto descriptor = binding->GetDescriptor(i);
ziga-lunarg33d806c2022-05-05 17:00:52 +02002628 if (!descriptor) {
2629 continue;
2630 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002631 switch (descriptor->GetClass()) {
2632 case cvdescriptorset::DescriptorClass::Image: {
2633 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2634 image_view = image_descriptor->GetImageView();
2635 }
2636 break;
2637 }
2638 case cvdescriptorset::DescriptorClass::ImageSampler: {
2639 if (const auto image_sampler_descriptor =
2640 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2641 image_view = image_sampler_descriptor->GetImageView();
2642 }
2643 break;
2644 }
2645 default:
2646 break;
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002647 }
2648
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002649 if (image_view) {
2650 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
2651 QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(),
2652 IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002653 }
2654 }
2655 }
2656 }
2657}
2658
2659void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2660 uint32_t firstVertex, uint32_t firstInstance) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002661 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2662 ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002663}
2664
2665void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2666 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002667 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2668 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002669}
2670
2671void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2672 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002673 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2674 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002675}
2676
Camden5b184be2019-08-13 07:50:19 -06002677bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002678 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002679 bool skip = false;
2680
2681 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002682 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2683 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2684 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2685 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002686 }
2687
2688 return skip;
2689}
Camden83a9c372019-08-14 11:41:38 -06002690
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002691bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2692 bool skip = false;
2693 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
2694 skip |= ValidateCmdEndRenderPass(commandBuffer);
2695 return skip;
2696}
2697
2698bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2699 bool skip = false;
2700 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
2701 skip |= ValidateCmdEndRenderPass(commandBuffer);
2702 return skip;
2703}
2704
Sam Walls0961ec02020-03-31 16:39:15 +01002705bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2706 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002707 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002708 skip |= ValidateCmdEndRenderPass(commandBuffer);
2709 return skip;
2710}
2711
2712bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2713 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002714 const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01002715
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002716 if (cmd == nullptr) return skip;
2717 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01002718
LawG4b21485c2022-02-28 13:46:48 +00002719 // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor
2720 bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2721 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
2722 bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG &&
2723 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG;
2724
2725 // Only send the warning when the vendor is enabled and a depth prepass is detected
LawG498ec4502022-04-05 09:08:25 +01002726 bool uses_depth =
2727 (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
LawG45507e142022-04-08 09:36:54 +01002728 ((depth_only_arm && VendorCheckEnabled(kBPVendorArm)) || (depth_only_img && VendorCheckEnabled(kBPVendorIMG)));
LawG4b21485c2022-02-28 13:46:48 +00002729
Sam Walls0961ec02020-03-31 16:39:15 +01002730 if (uses_depth) {
2731 skip |= LogPerformanceWarning(
2732 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
LawG4015be1c2022-03-01 10:37:52 +00002733 "%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 +00002734 "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry "
2735 "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface "
2736 "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.",
2737 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Sam Walls0961ec02020-03-31 16:39:15 +01002738 }
2739
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002740 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2741
LawG40da9c3d2022-03-01 09:51:01 +00002742 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002743 // If we use an attachment on-tile, we should access it in some way. Otherwise,
2744 // it is redundant to have it be part of the render pass.
2745 // Only consider it redundant if it will actually consume bandwidth, i.e.
2746 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
2747 // as is using pure input attachments.
2748 // CLEAR -> STORE might be considered a "useful" thing to do, but
2749 // the optimal thing to do is to defer the clear until you're actually
2750 // going to render to the image.
2751
2752 uint32_t num_attachments = rp->createInfo.attachmentCount;
2753 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002754 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
2755 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002756 continue;
2757 }
2758
2759 auto& attachment = rp->createInfo.pAttachments[i];
2760
2761 VkImageAspectFlags bandwidth_aspects = 0;
2762
2763 if (!FormatIsStencilOnly(attachment.format) &&
2764 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2765 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2766 if (FormatHasDepth(attachment.format)) {
2767 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
2768 } else {
2769 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
2770 }
2771 }
2772
2773 if (FormatHasStencil(attachment.format) &&
2774 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2775 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2776 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
2777 }
2778
2779 if (!bandwidth_aspects) {
2780 continue;
2781 }
2782
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002783 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002784 [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002785 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002786 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002787 untouched_aspects &= ~itr->aspects;
2788 }
2789
2790 if (untouched_aspects) {
2791 skip |= LogPerformanceWarning(
2792 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
LawG4015be1c2022-03-01 10:37:52 +00002793 "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002794 "was never accessed by a pipeline or clear command. "
LawG40da9c3d2022-03-01 09:51:01 +00002795 "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 +00002796 "render pass if the attachments are not intended to be accessed.",
LawG40da9c3d2022-03-01 09:51:01 +00002797 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects);
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002798 }
2799 }
2800 }
2801
Sam Walls0961ec02020-03-31 16:39:15 +01002802 return skip;
2803}
2804
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002805void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002806 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2807 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002808}
2809
2810void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002811 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2812 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002813}
2814
Camden Stocker9c051442019-11-06 14:28:43 -08002815bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
2816 const char* api_name) const {
2817 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002818 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08002819
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002820 if (bp_pd_state) {
2821 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
2822 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
2823 "Potential problem with calling %s() without first retrieving properties from "
2824 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
2825 api_name);
2826 }
Camden Stocker9c051442019-11-06 14:28:43 -08002827 }
2828
2829 return skip;
2830}
2831
Camden83a9c372019-08-14 11:41:38 -06002832bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002833 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06002834 bool skip = false;
2835
Camden Stocker9c051442019-11-06 14:28:43 -08002836 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06002837
Camden Stocker9c051442019-11-06 14:28:43 -08002838 return skip;
2839}
2840
2841bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
2842 uint32_t planeIndex,
2843 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
2844 bool skip = false;
2845
2846 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
2847
2848 return skip;
2849}
2850
2851bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
2852 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
2853 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
2854 bool skip = false;
2855
2856 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06002857
2858 return skip;
2859}
Camden05de2d42019-08-19 10:23:56 -06002860
2861bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002862 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06002863 bool skip = false;
2864
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002865 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Camden05de2d42019-08-19 10:23:56 -06002866
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002867 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06002868 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002869 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002870 skip |=
2871 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
2872 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
2873 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06002874 }
Camden05de2d42019-08-19 10:23:56 -06002875
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002876 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
2877 skip |= LogWarning(
2878 device, kVUID_BestPractices_Swapchain_InvalidCount,
2879 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04002880 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002881 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
2882 }
2883 }
2884
Camden05de2d42019-08-19 10:23:56 -06002885 return skip;
2886}
2887
2888// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002889bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002890 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002891 const CALL_STATE call_state,
2892 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06002893 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002894 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
2895 if (UNCALLED == call_state) {
2896 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002897 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002898 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
2899 "recommended "
2900 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
2901 caller_name, caller_name);
2902 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002903 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
2904 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002905 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
2906 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
2907 ". It is recommended to instead receive all the properties by calling %s with "
2908 "pQueueFamilyPropertyCount that was "
2909 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002910 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002911 caller_name);
Camden05de2d42019-08-19 10:23:56 -06002912 }
2913
2914 return skip;
2915}
2916
Jeff Bolz5c801d12019-10-09 10:38:45 -05002917bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
2918 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06002919 bool skip = false;
2920
2921 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002922 auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06002923 if (!as_state->memory_requirements_checked) {
2924 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
2925 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
2926 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002927 skip |= LogWarning(
2928 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06002929 "vkBindAccelerationStructureMemoryNV(): "
2930 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
2931 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
2932 }
2933 }
2934
2935 return skip;
2936}
2937
Camden05de2d42019-08-19 10:23:56 -06002938bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
2939 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002940 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002941 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002942 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002943 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002944 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
2945 "vkGetPhysicalDeviceQueueFamilyProperties()");
2946 }
2947 return false;
Camden05de2d42019-08-19 10:23:56 -06002948}
2949
Mike Schuchardt2df08912020-12-15 16:28:09 -08002950bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
2951 uint32_t* pQueueFamilyPropertyCount,
2952 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002953 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002954 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002955 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002956 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
2957 "vkGetPhysicalDeviceQueueFamilyProperties2()");
2958 }
2959 return false;
Camden05de2d42019-08-19 10:23:56 -06002960}
2961
Jeff Bolz5c801d12019-10-09 10:38:45 -05002962bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08002963 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002964 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002965 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002966 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002967 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
2968 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
2969 }
2970 return false;
Camden05de2d42019-08-19 10:23:56 -06002971}
2972
2973bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
2974 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002975 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06002976 if (!pSurfaceFormats) return false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002977 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002978 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06002979 bool skip = false;
2980 if (call_state == UNCALLED) {
2981 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
2982 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002983 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
2984 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
2985 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06002986 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002987 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002988 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
2989 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
2990 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
2991 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002992 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06002993 }
2994 }
2995 return skip;
2996}
Camden Stocker23cc47d2019-09-03 14:53:57 -06002997
2998bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002999 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003000 bool skip = false;
3001
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003002 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3003 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06003004 // 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 -07003005 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003006 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
3007 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07003008 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06003009 // 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 -07003010 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
3011 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003012 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003013 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003014 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003015 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003016 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003017 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
3018 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
3019 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003020 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003021 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
3022 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003023 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003024 }
3025 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003026 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003027 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003028 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003029 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
3030 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003031 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003032 }
3033 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003034 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3035 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003036 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003037 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003038 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003039 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06003040 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003041 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
3042 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
3043 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003044 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003045 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
3046 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003047 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003048 }
3049 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06003050 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003051 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003052 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003053 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
3054 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003055 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003056 }
3057 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3058 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003059 sparse_images_with_metadata.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003060 }
3061 }
3062 }
3063 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003064 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
3065 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06003066 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003067 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07003068 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
3069 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06003070 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06003071 }
3072 }
3073 }
3074
3075 return skip;
3076}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003077
Mark Lobodzinski84101d72020-04-24 09:43:48 -06003078void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
3079 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003080 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003081 return;
3082 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003083
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003084 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3085 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
3086 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3087 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003088 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003089 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003090 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003091 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003092 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3093 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
3094 image_state->sparse_metadata_bound = true;
3095 }
3096 }
3097 }
3098 }
3099}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003100
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003101bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003102 const VkClearRect* pRects) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003103 if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003104 // We don't know the accurate render area in a secondary,
3105 // so assume we clear the entire frame buffer.
3106 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
3107 return true;
3108 }
3109
3110 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
3111 for (uint32_t i = 0; i < rectCount; i++) {
3112 auto& rect = pRects[i];
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003113 auto& render_area = cmd.activeRenderPassBeginInfo.renderArea;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003114 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
3115 return true;
3116 }
3117 }
3118
3119 return false;
3120}
3121
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003122bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment,
3123 VkImageAspectFlags aspects, bool secondary) const {
3124 const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003125 bool skip = false;
3126
3127 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
3128 return skip;
3129 }
3130
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003131 const auto& rp_state = cmd.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003132
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003133 auto attachment_itr =
3134 std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
3135 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003136
3137 // Only report aspects which haven't been touched yet.
3138 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003139 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003140 new_aspects &= ~attachment_itr->aspects;
3141 }
3142
3143 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
sjfricke52defd42022-08-08 16:37:46 +09003144 if (!cmd.has_draw_cmd) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003145 skip |= LogPerformanceWarning(
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003146 cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02003147 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
3148 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003149 report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003150 }
3151
3152 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
3153 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3154 skip |= LogPerformanceWarning(
3155 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3156 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
3157 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3158 "it is more efficient.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003159 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003160 }
3161
3162 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
3163 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003164 skip |=
3165 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3166 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
3167 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3168 "it is more efficient.",
3169 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003170 }
3171
3172 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
3173 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003174 skip |=
3175 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3176 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
3177 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3178 "it is more efficient.",
3179 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003180 }
3181
3182 return skip;
3183}
3184
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003185bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06003186 const VkClearAttachment* pAttachments, uint32_t rectCount,
3187 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003188 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003189 const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003190 if (!cb_node) return skip;
3191
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003192 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
3193 // Defer checks to ExecuteCommands.
3194 return skip;
3195 }
3196
3197 // Only care about full clears, partial clears might have legitimate uses.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003198 if (!ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects)) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003199 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003200 }
3201
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003202 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
3203 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06003204 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003205 if (rp) {
3206 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
3207
3208 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003209 const auto& attachment = pAttachments[i];
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003210
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003211 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3212 uint32_t color_attachment = attachment.colorAttachment;
3213 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003214 skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003215 }
3216
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003217 if (subpass.pDepthStencilAttachment &&
3218 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003219 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003220 skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003221 }
3222 }
3223 }
3224
Nadav Gevaf0808442021-05-21 13:51:25 -04003225 if (VendorCheckEnabled(kBPVendorAMD)) {
3226 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
3227 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
3228 bool black_check = false;
3229 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
3230 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
3231 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
3232 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3233 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3234
3235 bool white_check = false;
3236 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
3237 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
3238 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
3239 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3240 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3241
3242 if (black_check && white_check) {
3243 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3244 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
3245 "Consider changing to one of the following:"
3246 "RGBA(0, 0, 0, 0) "
3247 "RGBA(0, 0, 0, 1) "
3248 "RGBA(1, 1, 1, 0) "
3249 "RGBA(1, 1, 1, 1)",
3250 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3251 }
3252 } else {
3253 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
3254 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
3255 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
3256 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3257 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
3258 "attachment %" PRId32 " is not a fast clear value."
3259 "Consider changing to one of the following:"
3260 "D=0.0f, S=0"
3261 "D=1.0f, S=0",
3262 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3263 }
3264 }
3265 }
3266 }
3267
Camden Stockerf55721f2019-09-09 11:04:49 -06003268 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003269}
Attilio Provenzano02859b22020-02-27 14:17:28 +00003270
3271bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3272 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3273 const VkImageResolve* pRegions) const {
3274 bool skip = false;
3275
3276 skip |= VendorCheckEnabled(kBPVendorArm) &&
3277 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
3278 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
3279 "This is a very slow and extremely bandwidth intensive path. "
3280 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3281 VendorSpecificTag(kBPVendorArm));
3282
3283 return skip;
3284}
3285
Jeff Leger178b1e52020-10-05 12:22:23 -04003286bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3287 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
3288 bool skip = false;
3289
3290 skip |= VendorCheckEnabled(kBPVendorArm) &&
3291 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
3292 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
3293 "This is a very slow and extremely bandwidth intensive path. "
3294 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3295 VendorSpecificTag(kBPVendorArm));
3296
3297 return skip;
3298}
3299
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003300bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3301 const VkResolveImageInfo2* pResolveImageInfo) const {
3302 bool skip = false;
3303
3304 skip |= VendorCheckEnabled(kBPVendorArm) &&
3305 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage,
3306 "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. "
3307 "This is a very slow and extremely bandwidth intensive path. "
3308 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3309 VendorSpecificTag(kBPVendorArm));
3310
3311 return skip;
3312}
3313
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003314void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3315 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3316 const VkImageResolve* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003317 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003318 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003319 auto src = Get<bp_state::Image>(srcImage);
3320 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003321
3322 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003323 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
3324 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003325 }
3326}
3327
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003328void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3329 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003330 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003331 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003332 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3333 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003334 uint32_t regionCount = pResolveImageInfo->regionCount;
3335
3336 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003337 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
3338 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003339 }
3340}
3341
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003342void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer,
3343 const VkResolveImageInfo2* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003344 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003345 auto& funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003346 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3347 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003348 uint32_t regionCount = pResolveImageInfo->regionCount;
3349
3350 for (uint32_t i = 0; i < regionCount; i++) {
3351 QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ,
3352 pResolveImageInfo->pRegions[i].srcSubresource);
3353 QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE,
3354 pResolveImageInfo->pRegions[i].dstSubresource);
3355 }
3356}
3357
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003358void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3359 const VkClearColorValue* pColor, uint32_t rangeCount,
3360 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003361 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003362 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003363 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003364
3365 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003366 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003367 }
3368}
3369
3370void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3371 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3372 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003373 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003374 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003375 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003376
3377 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003378 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003379 }
3380}
3381
3382void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3383 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3384 const VkImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003385 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003386 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003387 auto src = Get<bp_state::Image>(srcImage);
3388 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003389
3390 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003391 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
3392 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003393 }
3394}
3395
3396void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
3397 VkImageLayout dstImageLayout, uint32_t regionCount,
3398 const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003399 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003400 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003401 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003402
3403 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003404 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003405 }
3406}
3407
3408void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3409 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003410 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003411 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003412 auto src = Get<bp_state::Image>(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003413
3414 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003415 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003416 }
3417}
3418
3419void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3420 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3421 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003422 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003423 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003424 auto src = Get<bp_state::Image>(srcImage);
3425 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003426
3427 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003428 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
3429 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003430 }
3431}
3432
Attilio Provenzano02859b22020-02-27 14:17:28 +00003433bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
3434 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
3435 bool skip = false;
3436
3437 if (VendorCheckEnabled(kBPVendorArm)) {
3438 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
3439 skip |= LogPerformanceWarning(
3440 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
3441 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
3442 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
3443 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003444 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003445 }
3446
3447 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
3448 skip |= LogPerformanceWarning(
3449 device, kVUID_BestPractices_CreateSampler_LodClamping,
3450 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
3451 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
3452 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
3453 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
3454 }
3455
3456 if (pCreateInfo->mipLodBias != 0.0f) {
3457 skip |=
3458 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
3459 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
3460 "descriptors being created and may cause reduced performance.",
3461 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
3462 }
3463
3464 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3465 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3466 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
3467 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
3468 skip |= LogPerformanceWarning(
3469 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
3470 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
3471 "This will lead to less efficient descriptors being created and may cause reduced performance. "
3472 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
3473 VendorSpecificTag(kBPVendorArm));
3474 }
3475
3476 if (pCreateInfo->unnormalizedCoordinates) {
3477 skip |= LogPerformanceWarning(
3478 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
3479 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
3480 "descriptors being created and may cause reduced performance.",
3481 VendorSpecificTag(kBPVendorArm));
3482 }
3483
3484 if (pCreateInfo->anisotropyEnable) {
3485 skip |= LogPerformanceWarning(
3486 device, kVUID_BestPractices_CreateSampler_Anisotropy,
3487 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
3488 "and may cause reduced performance.",
3489 VendorSpecificTag(kBPVendorArm));
3490 }
3491 }
3492
3493 return skip;
3494}
Sam Walls8e77e4f2020-03-16 20:47:40 +00003495
Nadav Gevaf0808442021-05-21 13:51:25 -04003496void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
3497 const VkGraphicsPipelineCreateInfo* pCreateInfos,
3498 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
3499 void* cgpl_state) {
3500 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
3501 pPipelines);
3502 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003503 num_pso_ += createInfoCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003504}
3505
3506bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
3507 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
3508 const VkCopyDescriptorSet* pDescriptorCopies) const {
3509 bool skip = false;
3510 if (VendorCheckEnabled(kBPVendorAMD)) {
3511 if (descriptorCopyCount > 0) {
3512 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
3513 "%s Performance warning: copying descriptor sets is not recommended",
3514 VendorSpecificTag(kBPVendorAMD));
3515 }
3516 }
3517
3518 return skip;
3519}
3520
3521bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
3522 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
3523 const VkAllocationCallbacks* pAllocator,
3524 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
3525 bool skip = false;
3526 if (VendorCheckEnabled(kBPVendorAMD)) {
3527 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
3528 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
3529 "vkUpdateDescriptorSet instead",
3530 VendorSpecificTag(kBPVendorAMD));
3531 }
3532
3533 return skip;
3534}
3535
3536bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3537 const VkClearColorValue* pColor, uint32_t rangeCount,
3538 const VkImageSubresourceRange* pRanges) const {
3539 bool skip = false;
3540 if (VendorCheckEnabled(kBPVendorAMD)) {
sfricke-samsungef15e482022-01-26 11:32:49 -08003541 skip |= LogPerformanceWarning(
3542 device, kVUID_BestPractices_ClearAttachment_ClearImage,
Nadav Gevaf0808442021-05-21 13:51:25 -04003543 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3544 "vkCmdClearAttachments instead",
3545 VendorSpecificTag(kBPVendorAMD));
3546 }
3547
3548 return skip;
3549}
3550
3551bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
3552 VkImageLayout imageLayout,
3553 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3554 const VkImageSubresourceRange* pRanges) const {
3555 bool skip = false;
3556 if (VendorCheckEnabled(kBPVendorAMD)) {
3557 skip |= LogPerformanceWarning(
3558 device, kVUID_BestPractices_ClearAttachment_ClearImage,
3559 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3560 "vkCmdClearAttachments instead",
3561 VendorSpecificTag(kBPVendorAMD));
3562 }
3563
3564 return skip;
3565}
3566
3567bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
3568 const VkAllocationCallbacks* pAllocator,
3569 VkPipelineLayout* pPipelineLayout) const {
3570 bool skip = false;
3571 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003572 uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2;
Nadav Gevaf0808442021-05-21 13:51:25 -04003573 // Descriptor sets cost 1 DWORD each.
3574 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
3575 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
3576 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
3577 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
3578 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003579 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003580 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size;
Nadav Gevaf0808442021-05-21 13:51:25 -04003581 }
3582
3583 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
3584 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
3585 }
3586
3587 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
3588 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
3589 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
3590 "Descriptor sets cost 1 DWORD each. "
3591 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
3592 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
3593 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
3594 VendorSpecificTag(kBPVendorAMD));
3595 }
3596 }
3597
3598 return skip;
3599}
3600
3601bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3602 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3603 const VkImageCopy* pRegions) const {
3604 bool skip = false;
3605 std::stringstream src_image_hex;
3606 std::stringstream dst_image_hex;
3607 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
3608 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
3609
3610 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003611 auto src_state = Get<IMAGE_STATE>(srcImage);
3612 auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04003613
3614 if (src_state && dst_state) {
3615 VkImageTiling src_Tiling = src_state->createInfo.tiling;
3616 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
3617 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
3618 skip |=
3619 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
3620 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
3621 "image (vkCmdCopyImageToBuffer) "
3622 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
3623 "copies when converting between linear and optimal images",
3624 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
3625 }
3626 }
3627 }
3628
3629 return skip;
3630}
3631
3632bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
3633 VkPipeline pipeline) const {
3634 bool skip = false;
3635
3636 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003637 if (IsPipelineUsedInFrame(pipeline)) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003638 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
3639 "%s Performance warning: Pipeline %s was bound twice in the frame. Keep pipeline state changes to a minimum,"
3640 "for example, by sorting draw calls by pipeline.",
3641 VendorSpecificTag(kBPVendorAMD), report_data->FormatHandle(pipeline).c_str());
3642 }
3643 }
3644
3645 return skip;
3646}
3647
3648void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
3649 VkFence fence, VkResult result) {
3650 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003651 num_queue_submissions_ += submitCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003652}
3653
3654bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
3655 bool skip = false;
3656
3657 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003658 auto num = num_queue_submissions_.load();
3659 if (num > kNumberOfSubmissionWarningLimitAMD) {
3660 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
3661 "%s Performance warning: command buffers submitted %" PRId32
3662 " times this frame. Submitting command buffers has a CPU "
3663 "and GPU overhead. Submit fewer times to incur less overhead.",
3664 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04003665 }
3666 }
3667
3668 return skip;
3669}
3670
3671void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
3672 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
3673 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
3674 uint32_t bufferMemoryBarrierCount,
3675 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
3676 uint32_t imageMemoryBarrierCount,
3677 const VkImageMemoryBarrier* pImageMemoryBarriers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003678 num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount);
Nadav Gevaf0808442021-05-21 13:51:25 -04003679}
3680
3681bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3682 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
3683 bool skip = false;
3684 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003685 if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003686 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
3687 "%s Performance warning: High number of vkSemaphore objects created."
3688 "Minimize the amount of queue synchronization that is used. "
3689 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
3690 VendorSpecificTag(kBPVendorAMD));
3691 }
3692 }
3693
3694 return skip;
3695}
3696
3697bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3698 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
3699 bool skip = false;
3700 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003701 if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003702 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
3703 "%s Performance warning: High number of VkFence objects created."
3704 "Minimize the amount of CPU-GPU synchronization that is used. "
3705 "Semaphores and fences have overhead.Each fence has a CPU and GPU cost with it.",
3706 VendorSpecificTag(kBPVendorAMD));
3707 }
3708 }
3709
3710 return skip;
3711}
3712
Sam Walls8e77e4f2020-03-16 20:47:40 +00003713void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
3714
3715bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
3716 // look for a cache hit
3717 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
3718 if (hit != _entries.end()) {
3719 // mark the cache hit as being most recently used
3720 hit->age = iteration++;
3721 return true;
3722 }
3723
3724 // if there's no cache hit, we need to model the entry being inserted into the cache
3725 CacheEntry new_entry = {value, iteration};
3726 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
3727 // if there is still space left in the cache, use the next available slot
3728 *(_entries.begin() + iteration) = new_entry;
3729 } else {
3730 // otherwise replace the least recently used cache entry
3731 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
3732 *lru = new_entry;
3733 }
3734 iteration++;
3735 return false;
3736}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003737
3738bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
3739 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003740 auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003741 bool skip = false;
3742 if (swapchain_data && swapchain_data->images.size() == 0) {
3743 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
3744 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
3745 "vkGetSwapchainImagesKHR after swapchain creation.");
3746 }
3747 return skip;
3748}
3749
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003750void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
3751 if (no_pointer) {
3752 if (UNCALLED == call_state) {
3753 call_state = QUERY_COUNT;
3754 }
3755 } else { // Save queue family properties
3756 call_state = QUERY_DETAILS;
3757 }
3758}
3759
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003760void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3761 uint32_t* pQueueFamilyPropertyCount,
3762 VkQueueFamilyProperties* pQueueFamilyProperties) {
3763 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
3764 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003765 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003766 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003767 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3768 nullptr == pQueueFamilyProperties);
3769 }
3770}
3771
3772void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3773 uint32_t* pQueueFamilyPropertyCount,
3774 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3775 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
3776 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003777 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003778 if (bp_pd_state) {
3779 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3780 nullptr == pQueueFamilyProperties);
3781 }
3782}
3783
3784void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
3785 uint32_t* pQueueFamilyPropertyCount,
3786 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3787 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
3788 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003789 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003790 if (bp_pd_state) {
3791 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3792 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003793 }
3794}
3795
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003796void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
3797 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003798 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003799 if (bp_pd_state) {
3800 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3801 }
3802}
3803
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003804void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
3805 VkPhysicalDeviceFeatures2* pFeatures) {
3806 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003807 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003808 if (bp_pd_state) {
3809 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3810 }
3811}
3812
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003813void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
3814 VkPhysicalDeviceFeatures2* pFeatures) {
3815 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003816 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003817 if (bp_pd_state) {
3818 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3819 }
3820}
3821
3822void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
3823 VkSurfaceKHR surface,
3824 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
3825 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003826 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003827 if (bp_pd_state) {
3828 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3829 }
3830}
3831
3832void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
3833 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3834 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003835 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003836 if (bp_pd_state) {
3837 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3838 }
3839}
3840
3841void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
3842 VkSurfaceKHR surface,
3843 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
3844 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003845 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003846 if (bp_pd_state) {
3847 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3848 }
3849}
3850
3851void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
3852 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
3853 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003854 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003855 if (bp_pd_data) {
3856 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
3857
3858 if (*pPresentModeCount) {
3859 if (call_state < QUERY_COUNT) {
3860 call_state = QUERY_COUNT;
3861 }
3862 }
3863 if (pPresentModes) {
3864 if (call_state < QUERY_DETAILS) {
3865 call_state = QUERY_DETAILS;
3866 }
3867 }
3868 }
3869}
3870
3871void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
3872 uint32_t* pSurfaceFormatCount,
3873 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003874 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003875 if (bp_pd_data) {
3876 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
3877
3878 if (*pSurfaceFormatCount) {
3879 if (call_state < QUERY_COUNT) {
3880 call_state = QUERY_COUNT;
3881 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003882 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003883 }
3884 if (pSurfaceFormats) {
3885 if (call_state < QUERY_DETAILS) {
3886 call_state = QUERY_DETAILS;
3887 }
3888 }
3889 }
3890}
3891
3892void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
3893 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3894 uint32_t* pSurfaceFormatCount,
3895 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003896 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003897 if (bp_pd_data) {
3898 if (*pSurfaceFormatCount) {
3899 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
3900 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
3901 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003902 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003903 }
3904 if (pSurfaceFormats) {
3905 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
3906 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
3907 }
3908 }
3909 }
3910}
3911
3912void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
3913 uint32_t* pPropertyCount,
3914 VkDisplayPlanePropertiesKHR* pProperties,
3915 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003916 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003917 if (bp_pd_data) {
3918 if (*pPropertyCount) {
3919 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
3920 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
3921 }
3922 }
3923 if (pProperties) {
3924 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
3925 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
3926 }
3927 }
3928 }
3929}
3930
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003931void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
3932 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
3933 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003934 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Nathaniel Cesario39152e62021-07-02 13:04:16 -06003935 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
3936 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
3937 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003938 }
3939 }
3940}
3941
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003942void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
3943 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
3944
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003945 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003946 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003947 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003948 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003949 auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003950 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07003951 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003952 }
3953 }
3954 }
3955}