blob: 2874523219d7747aafd302488e9fcfb7c1b4e8fd [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"}},
42 {kBPVendorIMG, {vendor_specific_img, "IMG"}}};
Attilio Provenzano19d6a982020-02-27 12:41:41 +000043
Hannes Harnisch607d1d92021-07-10 18:44:56 +020044const SpecialUseVUIDs kSpecialUseInstanceVUIDs {
45 kVUID_BestPractices_CreateInstance_SpecialUseExtension_CADSupport,
46 kVUID_BestPractices_CreateInstance_SpecialUseExtension_D3DEmulation,
47 kVUID_BestPractices_CreateInstance_SpecialUseExtension_DevTools,
48 kVUID_BestPractices_CreateInstance_SpecialUseExtension_Debugging,
49 kVUID_BestPractices_CreateInstance_SpecialUseExtension_GLEmulation,
50};
51
52const SpecialUseVUIDs kSpecialUseDeviceVUIDs {
53 kVUID_BestPractices_CreateDevice_SpecialUseExtension_CADSupport,
54 kVUID_BestPractices_CreateDevice_SpecialUseExtension_D3DEmulation,
55 kVUID_BestPractices_CreateDevice_SpecialUseExtension_DevTools,
56 kVUID_BestPractices_CreateDevice_SpecialUseExtension_Debugging,
57 kVUID_BestPractices_CreateDevice_SpecialUseExtension_GLEmulation,
58};
59
Jeremy Gebben20da7a12022-02-25 14:07:46 -070060ReadLockGuard BestPractices::ReadLock() {
61 if (fine_grained_locking) {
62 return ReadLockGuard(validation_object_mutex, std::defer_lock);
63 } else {
64 return ReadLockGuard(validation_object_mutex);
65 }
66}
67
68WriteLockGuard BestPractices::WriteLock() {
69 if (fine_grained_locking) {
70 return WriteLockGuard(validation_object_mutex, std::defer_lock);
71 } else {
72 return WriteLockGuard(validation_object_mutex);
73 }
74}
75
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060076std::shared_ptr<CMD_BUFFER_STATE> BestPractices::CreateCmdBufferState(VkCommandBuffer cb,
77 const VkCommandBufferAllocateInfo* pCreateInfo,
Jeremy Gebbencd7fa282021-10-27 10:25:32 -060078 const COMMAND_POOL_STATE* pool) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -070079 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 -060080}
81
Jeremy Gebben20da7a12022-02-25 14:07:46 -070082bp_state::CommandBuffer::CommandBuffer(BestPractices* bp, VkCommandBuffer cb, const VkCommandBufferAllocateInfo* pCreateInfo,
83 const COMMAND_POOL_STATE* pool)
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060084 : CMD_BUFFER_STATE(bp, cb, pCreateInfo, pool) {}
85
Attilio Provenzano19d6a982020-02-27 12:41:41 +000086bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070087 for (const auto& vendor : kVendorInfo) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060088 if (vendors & vendor.first && enabled[vendor.second.vendor_id]) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000089 return true;
90 }
91 }
92 return false;
93}
94
95const char* VendorSpecificTag(BPVendorFlags vendors) {
96 // Cache built vendor tags in a map
Jeremy Gebbencbf22862021-03-03 12:01:22 -070097 static layer_data::unordered_map<BPVendorFlags, std::string> tag_map;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000098
99 auto res = tag_map.find(vendors);
100 if (res == tag_map.end()) {
101 // Build the vendor tag string
102 std::stringstream vendor_tag;
103
104 vendor_tag << "[";
105 bool first_vendor = true;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700106 for (const auto& vendor : kVendorInfo) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +0000107 if (vendors & vendor.first) {
108 if (!first_vendor) {
109 vendor_tag << ", ";
110 }
111 vendor_tag << vendor.second.name;
112 first_vendor = false;
113 }
114 }
115 vendor_tag << "]";
116
117 tag_map[vendors] = vendor_tag.str();
118 res = tag_map.find(vendors);
119 }
120
121 return res->second.c_str();
122}
123
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700124const char* DepReasonToString(ExtDeprecationReason reason) {
125 switch (reason) {
126 case kExtPromoted:
127 return "promoted to";
128 break;
129 case kExtObsoleted:
130 return "obsoleted by";
131 break;
132 case kExtDeprecated:
133 return "deprecated by";
134 break;
135 default:
136 return "";
137 break;
138 }
139}
140
141bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version,
142 const char* vuid) const {
143 bool skip = false;
144 auto dep_info_it = deprecated_extensions.find(extension_name);
145 if (dep_info_it != deprecated_extensions.end()) {
146 auto dep_info = dep_info_it->second;
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600147 if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) ||
Tony-LunarGc30b59f2022-02-15 11:02:36 -0700148 ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2)) ||
149 ((dep_info.target.compare("VK_VERSION_1_3") == 0) && (version >= VK_API_VERSION_1_3))) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700150 skip |=
151 LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
152 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600153 } else if (dep_info.target.find("VK_VERSION") == std::string::npos) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700154 if (dep_info.target.length() == 0) {
155 skip |= LogWarning(instance, vuid,
156 "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated "
157 "without replacement.",
158 api_name, extension_name);
159 } else {
160 skip |= LogWarning(instance, vuid,
161 "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
162 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
163 }
164 }
165 }
166 return skip;
167}
168
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200169bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const SpecialUseVUIDs& special_use_vuids) const
170{
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700171 bool skip = false;
172 auto dep_info_it = special_use_extensions.find(extension_name);
173
174 if (dep_info_it != special_use_extensions.end()) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200175 const char* const format = "%s(): Attempting to enable extension %s, but this extension is intended to support %s "
176 "and it is strongly recommended that it be otherwise avoided.";
177 auto& special_uses = dep_info_it->second;
sfricke-samsungef15e482022-01-26 11:32:49 -0800178
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700179 if (special_uses.find("cadsupport") != std::string::npos) {
sfricke-samsungef15e482022-01-26 11:32:49 -0800180 skip |= LogWarning(instance, special_use_vuids.cadsupport, format, api_name, extension_name,
181 "specialized functionality used by CAD/CAM applications");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700182 }
183 if (special_uses.find("d3demulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200184 skip |= LogWarning(instance, special_use_vuids.d3demulation, format, api_name, extension_name,
185 "D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700186 }
187 if (special_uses.find("devtools") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200188 skip |= LogWarning(instance, special_use_vuids.devtools, format, api_name, extension_name,
189 "developer tools such as capture-replay libraries");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700190 }
191 if (special_uses.find("debugging") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200192 skip |= LogWarning(instance, special_use_vuids.debugging, format, api_name, extension_name,
193 "use by applications when debugging");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700194 }
195 if (special_uses.find("glemulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200196 skip |= LogWarning(instance, special_use_vuids.glemulation, format, api_name, extension_name,
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700197 "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality "
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200198 "specific to those APIs");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700199 }
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700200 }
201 return skip;
202}
203
Camden5b184be2019-08-13 07:50:19 -0600204bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500205 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600206 bool skip = false;
207
208 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
209 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800210 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700211 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
212 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600213 }
Mark Lobodzinski17d8dc62020-06-03 08:48:58 -0600214 uint32_t specified_version =
215 (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0);
216 skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700217 kVUID_BestPractices_CreateInstance_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200218 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseInstanceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600219 }
220
221 return skip;
222}
223
Camden5b184be2019-08-13 07:50:19 -0600224bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500225 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -0600226 bool skip = false;
227
228 // get API version of physical device passed when creating device.
229 VkPhysicalDeviceProperties physical_device_properties{};
230 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500231 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -0600232
233 // check api versions and warn if instance api Version is higher than version on device.
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600234 if (api_version > device_api_version) {
235 std::string inst_api_name = StringAPIVersion(api_version);
Mark Lobodzinski60880782020-08-11 08:02:07 -0600236 std::string dev_api_name = StringAPIVersion(device_api_version);
Camden5b184be2019-08-13 07:50:19 -0600237
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700238 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
239 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
240 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600241 }
242
243 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
244 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800245 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700246 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
247 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600248 }
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600249 skip |= ValidateDeprecatedExtensions("CreateDevice", pCreateInfo->ppEnabledExtensionNames[i], api_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700250 kVUID_BestPractices_CreateDevice_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200251 skip |= ValidateSpecialUseExtensions("CreateDevice", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseDeviceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600252 }
253
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700254 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600255 if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700256 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
257 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600258 }
259
LawG43f848c72022-02-23 09:35:21 +0000260 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorIMG)) &&
261 (pCreateInfo->pEnabledFeatures != nullptr) && (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
Szilard Papp7d2c7952020-06-22 14:38:13 +0100262 skip |= LogPerformanceWarning(
263 device, kVUID_BestPractices_CreateDevice_RobustBufferAccess,
LawG4015be1c2022-03-01 10:37:52 +0000264 "%s %s %s: vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during "
Szilard Papp7d2c7952020-06-22 14:38:13 +0100265 "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage "
266 "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case "
267 "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.",
LawG43f848c72022-02-23 09:35:21 +0000268 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorIMG));
Szilard Papp7d2c7952020-06-22 14:38:13 +0100269 }
270
Camden5b184be2019-08-13 07:50:19 -0600271 return skip;
272}
273
274bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500275 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600276 bool skip = false;
277
278 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700279 std::stringstream buffer_hex;
280 buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer);
Camden5b184be2019-08-13 07:50:19 -0600281
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700282 skip |= LogWarning(
283 device, kVUID_BestPractices_SharingModeExclusive,
284 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
285 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700286 buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600287 }
288
289 return skip;
290}
291
292bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500293 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600294 bool skip = false;
295
296 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700297 std::stringstream image_hex;
298 image_hex << "0x" << std::hex << HandleToUint64(pImage);
Camden5b184be2019-08-13 07:50:19 -0600299
300 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700301 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
302 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
303 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700304 image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600305 }
306
ziga-lunarg6df3d102022-03-18 17:02:14 +0100307 if ((pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT) && !(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
308 skip |= LogWarning(device, kVUID_BestPractices_ImageCreateFlags,
309 "vkCreateImage(): pCreateInfo->flags has VK_IMAGE_CREATE_EXTENDED_USAGE_BIT set, but not "
310 "VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, therefore image views created from this image will have to use the "
311 "same format and VK_IMAGE_CREATE_EXTENDED_USAGE_BIT will not have any effect.");
312 }
313
LawG4655f59c2022-02-23 13:55:55 +0000314 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000315 if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
316 skip |= LogPerformanceWarning(
317 device, kVUID_BestPractices_CreateImage_NonTransientMSImage,
LawG4655f59c2022-02-23 13:55:55 +0000318 "%s %s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have "
Attilio Provenzano02859b22020-02-27 14:17:28 +0000319 "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, "
320 "and do not need to be backed by physical storage. "
321 "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.",
LawG4655f59c2022-02-23 13:55:55 +0000322 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Attilio Provenzano02859b22020-02-27 14:17:28 +0000323 }
324 }
325
LawG4ba113892022-02-23 14:39:02 +0000326 if (VendorCheckEnabled(kBPVendorArm) && pCreateInfo->samples > kMaxEfficientSamplesArm) {
327 skip |= LogPerformanceWarning(
328 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
329 "%s vkCreateImage(): Trying to create an image with %u samples. "
330 "The hardware revision may not have full throughput for framebuffers with more than %u samples.",
331 VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm);
332 }
333
334 if (VendorCheckEnabled(kBPVendorIMG) && pCreateInfo->samples > kMaxEfficientSamplesImg) {
335 skip |= LogPerformanceWarning(
336 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
337 "%s vkCreateImage(): Trying to create an image with %u samples. "
338 "The device may not have full support for true multisampling for images with more than %u samples. "
339 "XT devices support up to 8 samples, XE up to 4 samples.",
340 VendorSpecificTag(kBPVendorIMG), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesImg);
341 }
342
Nadav Gevaf0808442021-05-21 13:51:25 -0400343 if (VendorCheckEnabled(kBPVendorAMD)) {
344 std::stringstream image_hex;
345 image_hex << "0x" << std::hex << HandleToUint64(pImage);
346
347 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
348 (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) {
349 skip |= LogPerformanceWarning(device,
350 kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets,
351 "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. "
352 "Using a SHARING_MODE_CONCURRENT "
353 "is not recommended with color and depth targets",
354 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
355 }
356
357 if ((pCreateInfo->usage &
358 (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
359 (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
360 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets,
361 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. "
362 "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets",
363 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
364 }
365
366 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
367 (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
368 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets,
369 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a "
370 "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets",
371 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
372 }
373 }
374
Camden5b184be2019-08-13 07:50:19 -0600375 return skip;
376}
377
378bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500379 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600380 bool skip = false;
381
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600382 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600383 if (bp_pd_state) {
384 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
385 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
386 "vkCreateSwapchainKHR() called before getting surface capabilities from "
387 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
388 }
Camden83a9c372019-08-14 11:41:38 -0600389
Shannon McPherson73e58c82021-03-05 17:14:26 -0700390 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
391 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600392 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
393 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
394 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
395 }
Camden83a9c372019-08-14 11:41:38 -0600396
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600397 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
398 skip |= LogWarning(
399 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
400 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
401 }
Camden83a9c372019-08-14 11:41:38 -0600402 }
403
Camden5b184be2019-08-13 07:50:19 -0600404 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700405 skip |=
406 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600407 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700408 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
409 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600410 }
411
ziga-lunarg79beba62022-03-30 01:17:30 +0200412 const auto present_mode = pCreateInfo->presentMode;
413 if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) &&
414 (pCreateInfo->minImageCount == 2)) {
Szilard Papp48a6da32020-06-10 14:41:59 +0100415 skip |= LogPerformanceWarning(
416 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
417 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
418 ", which means double buffering is going "
419 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
420 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
421 "3 to use triple buffering to maximize performance in such cases.",
422 pCreateInfo->minImageCount);
423 }
424
Szilard Pappd5f0f812020-06-22 09:01:29 +0100425 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
426 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
427 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
428 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
429 "Presentation modes which are not FIFO will present the latest available frame and discard other "
430 "frame(s) if any.",
431 VendorSpecificTag(kBPVendorArm));
432 }
433
Camden5b184be2019-08-13 07:50:19 -0600434 return skip;
435}
436
437bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
438 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500439 const VkAllocationCallbacks* pAllocator,
440 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600441 bool skip = false;
442
443 for (uint32_t i = 0; i < swapchainCount; i++) {
444 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700445 skip |= LogWarning(
446 device, kVUID_BestPractices_SharingModeExclusive,
447 "Warning: A shared swapchain (index %" PRIu32
448 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
449 "queues (queueFamilyIndexCount of %" PRIu32 ").",
450 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600451 }
452 }
453
454 return skip;
455}
456
457bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500458 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600459 bool skip = false;
460
461 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
462 VkFormat format = pCreateInfo->pAttachments[i].format;
463 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
464 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
465 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700466 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
467 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
468 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
469 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
470 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600471 }
472 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700473 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
474 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
475 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
476 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
477 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600478 }
479 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000480
481 const auto& attachment = pCreateInfo->pAttachments[i];
482 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
483 bool access_requires_memory =
484 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
485
486 if (FormatHasStencil(format)) {
487 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
488 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
489 }
490
491 if (access_requires_memory) {
492 skip |= LogPerformanceWarning(
493 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
494 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
495 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
496 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
497 i, static_cast<uint32_t>(attachment.samples));
498 }
499 }
Camden5b184be2019-08-13 07:50:19 -0600500 }
501
502 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
503 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
504 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
505 }
506
507 return skip;
508}
509
Tony-LunarG767180f2020-04-23 14:03:59 -0600510bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
511 const VkImageView* image_views) const {
512 bool skip = false;
513
514 // Check for non-transient attachments that should be transient and vice versa
515 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200516 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600517 bool attachment_should_be_transient =
518 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
519
520 if (FormatHasStencil(attachment.format)) {
521 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
522 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
523 }
524
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600525 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600526 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600527 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600528
529 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
530
531 // The check for an image that should not be transient applies to all GPUs
532 if (!attachment_should_be_transient && image_is_transient) {
533 skip |= LogPerformanceWarning(
534 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
535 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
536 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
537 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
538 i);
539 }
540
541 bool supports_lazy = false;
542 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
543 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
544 supports_lazy = true;
545 }
546 }
547
548 // The check for an image that should be transient only applies to GPUs supporting
549 // lazily allocated memory
550 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
551 skip |= LogPerformanceWarning(
552 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
553 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
554 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
555 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
556 i);
557 }
558 }
559 }
560 return skip;
561}
562
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000563bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
564 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
565 bool skip = false;
566
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600567 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800568 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600569 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000570 }
571
572 return skip;
573}
574
Sam Wallse746d522020-03-16 21:20:23 +0000575bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
576 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
577 bool skip = false;
578 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
579
580 if (!skip) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700581 const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000582 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
583 // this warning is specific to Arm
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700584 if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) {
Sam Wallse746d522020-03-16 21:20:23 +0000585 skip |= LogPerformanceWarning(
586 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
587 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
588 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
589 VendorSpecificTag(kBPVendorArm));
590 }
591 }
592
593 return skip;
594}
595
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600596void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
597 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000598 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700599 auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
600 if (pool_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000601 // we record successful allocations by subtracting the allocation count from the last recorded free count
602 const auto alloc_count = pAllocateInfo->descriptorSetCount;
603 // clamp the unsigned subtraction to the range [0, last_free_count]
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700604 if (pool_state->freed_count > alloc_count) {
605 pool_state->freed_count -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700606 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700607 pool_state->freed_count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700608 }
Sam Wallse746d522020-03-16 21:20:23 +0000609 }
610 }
611}
612
613void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
614 const VkDescriptorSet* pDescriptorSets, VkResult result) {
615 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
616 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700617 auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000618 // we want to track frees because we're interested in suggesting re-use
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700619 if (pool_state) {
620 pool_state->freed_count += descriptorSetCount;
Sam Wallse746d522020-03-16 21:20:23 +0000621 }
622 }
623}
624
Camden5b184be2019-08-13 07:50:19 -0600625bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500626 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600627 bool skip = false;
628
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700629 if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700630 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
631 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600632 }
633
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000634 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
635 skip |= LogPerformanceWarning(
636 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600637 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
638 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000639 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
640 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
641 }
642
Camden83a9c372019-08-14 11:41:38 -0600643 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
644
645 return skip;
646}
647
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600648void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
649 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
650 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700651 if (result != VK_SUCCESS) {
652 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
653 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800654 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700655 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600656 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700657 return;
658 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700659}
Camden Stocker9738af92019-10-16 13:54:03 -0700660
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600661void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
662 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700663 auto error = std::find(error_codes.begin(), error_codes.end(), result);
664 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000665 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
666 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
667
668 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
669 if (common_failure != common_failure_codes.end()) {
670 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
671 } else {
672 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
673 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700674 return;
675 }
676 auto success = std::find(success_codes.begin(), success_codes.end(), result);
677 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600678 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
679 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500680 }
681}
682
Jeff Bolz5c801d12019-10-09 10:38:45 -0500683bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
684 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700685 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600686 bool skip = false;
687
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700688 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600689
Jeremy Gebben610d3a62022-01-01 12:53:17 -0700690 for (const auto& item : mem_info->ObjectBindings()) {
691 const auto& obj = item.first;
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600692 LogObjectList objlist(device);
693 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600694 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600695 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 -0600696 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600697 }
698
Camden5b184be2019-08-13 07:50:19 -0600699 return skip;
700}
701
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000702bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600703 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700704 auto buffer_state = Get<BUFFER_STATE>(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600705
sfricke-samsunge2441192019-11-06 14:07:57 -0800706 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700707 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
708 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
709 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600710 }
711
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700712 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000713
AndreyVK_D3D0416a332021-11-02 23:22:28 +0300714 if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000715 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
716 skip |= LogPerformanceWarning(
717 device, kVUID_BestPractices_SmallDedicatedAllocation,
718 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600719 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
720 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000721 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
722 }
723
Camden Stockerb603cc82019-09-03 10:09:02 -0600724 return skip;
725}
726
727bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500728 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600729 bool skip = false;
730 const char* api_name = "BindBufferMemory()";
731
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000732 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600733
734 return skip;
735}
736
737bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500738 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600739 char api_name[64];
740 bool skip = false;
741
742 for (uint32_t i = 0; i < bindInfoCount; i++) {
743 sprintf(api_name, "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000744 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600745 }
746
747 return skip;
748}
Camden Stockerb603cc82019-09-03 10:09:02 -0600749
750bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500751 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600752 char api_name[64];
753 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600754
Camden Stocker8b798ab2019-09-03 10:33:28 -0600755 for (uint32_t i = 0; i < bindInfoCount; i++) {
756 sprintf(api_name, "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000757 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600758 }
759
760 return skip;
761}
762
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000763bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600764 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700765 auto image_state = Get<IMAGE_STATE>(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600766
sfricke-samsung71bc6572020-04-29 15:49:43 -0700767 if (image_state->disjoint == false) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600768 if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700769 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
770 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
771 api_name, report_data->FormatHandle(image).c_str());
772 }
773 } else {
774 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
775 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600776 }
777
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700778 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000779
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600780 if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000781 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
782 skip |= LogPerformanceWarning(
783 device, kVUID_BestPractices_SmallDedicatedAllocation,
784 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600785 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
786 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000787 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
788 }
789
790 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
791 // make sure this type is actually used.
792 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
793 // (i.e.most tile - based renderers)
794 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
795 bool supports_lazy = false;
796 uint32_t suggested_type = 0;
797
798 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600799 if ((1u << i) & image_state->requirements[0].memoryTypeBits) {
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000800 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
801 supports_lazy = true;
802 suggested_type = i;
803 break;
804 }
805 }
806 }
807
808 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
809
810 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
811 skip |= LogPerformanceWarning(
812 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600813 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000814 "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 -0600815 "%" PRIu64 " bytes of physical memory.",
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600816 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000817 }
818 }
819
Camden Stocker8b798ab2019-09-03 10:33:28 -0600820 return skip;
821}
822
823bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500824 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600825 bool skip = false;
826 const char* api_name = "vkBindImageMemory()";
827
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000828 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600829
830 return skip;
831}
832
833bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500834 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600835 char api_name[64];
836 bool skip = false;
837
838 for (uint32_t i = 0; i < bindInfoCount; i++) {
839 sprintf(api_name, "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700840 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -0600841 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
842 }
Camden Stocker8b798ab2019-09-03 10:33:28 -0600843 }
844
845 return skip;
846}
847
848bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500849 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600850 char api_name[64];
851 bool skip = false;
852
853 for (uint32_t i = 0; i < bindInfoCount; i++) {
854 sprintf(api_name, "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000855 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600856 }
857
858 return skip;
859}
Camden83a9c372019-08-14 11:41:38 -0600860
Attilio Provenzano02859b22020-02-27 14:17:28 +0000861static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
862 switch (format) {
863 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
864 case VK_FORMAT_R16_SFLOAT:
865 case VK_FORMAT_R16G16_SFLOAT:
866 case VK_FORMAT_R16G16B16_SFLOAT:
867 case VK_FORMAT_R16G16B16A16_SFLOAT:
868 case VK_FORMAT_R32_SFLOAT:
869 case VK_FORMAT_R32G32_SFLOAT:
870 case VK_FORMAT_R32G32B32_SFLOAT:
871 case VK_FORMAT_R32G32B32A32_SFLOAT:
872 return false;
873
874 default:
875 return true;
876 }
877}
878
879bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
880 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
881 bool skip = false;
882
883 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700884 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000885
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700886 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
887 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
888 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000889 return skip;
890 }
891
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600892 auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200893 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000894
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +0200895 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
896 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount);
897
898 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200899 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000900 uint32_t att = subpass.pColorAttachments[j].attachment;
901
902 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
903 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
904 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
905 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
906 "color attachment #%u makes use "
907 "of a format which cannot be blended at full throughput when using MSAA.",
908 VendorSpecificTag(kBPVendorArm), i, j);
909 }
910 }
911 }
912 }
913
914 return skip;
915}
916
Nadav Gevaf0808442021-05-21 13:51:25 -0400917void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
918 const VkComputePipelineCreateInfo* pCreateInfos,
919 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
920 VkResult result, void* pipe_state) {
921 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700922 pipeline_cache_ = pipelineCache;
Nadav Gevaf0808442021-05-21 13:51:25 -0400923}
924
Camden5b184be2019-08-13 07:50:19 -0600925bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
926 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600927 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500928 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600929 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
930 pAllocator, pPipelines, cgpl_state_data);
ziga-lunarg08c81582022-03-08 17:33:45 +0100931 if (skip) {
932 return skip;
933 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600934 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600935
936 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700937 skip |= LogPerformanceWarning(
938 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
939 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
940 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600941 }
942
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000943 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200944 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000945
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600946 if (!(cgpl_state->pipe_state[i]->active_shaders & VK_SHADER_STAGE_MESH_BIT_NV)) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200947 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600948 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700949 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
950 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600951 count++;
952 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000953 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600954 if (count > kMaxInstancedVertexBuffers) {
955 skip |= LogPerformanceWarning(
956 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
957 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
958 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
959 count, kMaxInstancedVertexBuffers);
960 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000961 }
Attilio Provenzano02859b22020-02-27 14:17:28 +0000962
Szilard Pappaaf2da32020-06-22 10:37:35 +0100963 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
964 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +0200965 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
966 VendorCheckEnabled(kBPVendorArm)) {
967 skip |= LogPerformanceWarning(
968 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
969 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
970 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
971 "efficiency during rasterization. Consider disabling depthBias or increasing either "
972 "depthBiasConstantFactor or depthBiasSlopeFactor.",
973 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +0100974 }
975
Attilio Provenzano02859b22020-02-27 14:17:28 +0000976 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000977 }
Nadav Gevaf0808442021-05-21 13:51:25 -0400978 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700979 auto prev_pipeline = pipeline_cache_.load();
980 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
Nadav Gevaf0808442021-05-21 13:51:25 -0400981 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
982 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
983 "improve cache hit rate", VendorSpecificTag(kBPVendorAMD));
984 }
985
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700986 if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -0400987 skip |=
988 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
989 "%s Performance warning: Too many pipelines created, consider consolidation",
990 VendorSpecificTag(kBPVendorAMD));
991 }
992
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -0600993 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -0400994 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
995 "%s Performance warning: Use of primitive restart is not recommended",
996 VendorSpecificTag(kBPVendorAMD));
997 }
998
999 // TODO: this might be too aggressive of a check
1000 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1001 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1002 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1003 VendorSpecificTag(kBPVendorAMD));
1004 }
1005 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001006
Camden5b184be2019-08-13 07:50:19 -06001007 return skip;
1008}
1009
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001010static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info,
1011 std::shared_ptr<const RENDER_PASS_STATE>& rp) {
1012 std::vector<bp_state::AttachmentInfo> result;
Tony-LunarG5e1dbcd2022-03-29 08:19:58 -06001013 if (!rp || rp->use_dynamic_rendering || rp->use_dynamic_rendering_inherited) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001014 return result;
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001015 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001016
1017 const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1018
1019 // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState
1020 // are only non-null if they are enabled.
1021 if (create_info.pColorBlendState) {
1022 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1023 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount);
1024 for (uint32_t j = 0; j < num_color_attachments; j++) {
1025 if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) {
1026 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1027 if (attachment != VK_ATTACHMENT_UNUSED) {
1028 result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT});
1029 }
1030 }
1031 }
1032 }
1033
1034 if (create_info.pDepthStencilState &&
1035 (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable ||
1036 create_info.pDepthStencilState->stencilTestEnable)) {
1037 uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED;
1038 if (attachment != VK_ATTACHMENT_UNUSED) {
1039 VkImageAspectFlags aspects = 0;
1040 if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) {
1041 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1042 }
1043 if (create_info.pDepthStencilState->stencilTestEnable) {
1044 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1045 }
1046 result.push_back({attachment, aspects});
1047 }
1048 }
1049 return result;
1050}
1051
1052bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo,
1053 std::shared_ptr<const RENDER_PASS_STATE>&& rpstate,
1054 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout)
1055 : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)),
1056 access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {}
1057
1058std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState(
1059 const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass,
1060 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const {
1061 return std::static_pointer_cast<PIPELINE_STATE>(
1062 std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout)));
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001063}
1064
Sam Walls0961ec02020-03-31 16:39:15 +01001065void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1066 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1067 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1068 VkResult result, void* cgpl_state_data) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001069 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001070 pipeline_cache_ = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001071}
1072
Camden5b184be2019-08-13 07:50:19 -06001073bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1074 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001075 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001076 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001077 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1078 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001079
1080 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001081 skip |= LogPerformanceWarning(
1082 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1083 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1084 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001085 }
1086
Nadav Gevaf0808442021-05-21 13:51:25 -04001087 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001088 auto prev_pipeline = pipeline_cache_.load();
1089 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
1090 skip |= LogPerformanceWarning(
1091 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1092 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
Nadav Gevaf0808442021-05-21 13:51:25 -04001093 "improve cache hit rate",
1094 VendorSpecificTag(kBPVendorAMD));
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001095 }
1096 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001097
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001098 for (uint32_t i = 0; i < createInfoCount; i++) {
1099 const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i];
1100 if (VendorCheckEnabled(kBPVendorArm)) {
1101 skip |= ValidateCreateComputePipelineArm(createInfo);
1102 }
sfricke-samsung86d055a2022-02-11 14:43:50 -08001103
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001104 if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) {
1105 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
1106 for (const auto& builtin : module_state->static_data_.builtin_decoration_list) {
1107 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1108 skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize,
1109 "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32
1110 "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 "
1111 "extension exposes a new LocalSizeId execution mode that should be used instead.",
1112 i);
sfricke-samsung86d055a2022-02-11 14:43:50 -08001113 }
1114 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001115 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001116 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001117
1118 return skip;
1119}
1120
1121bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1122 bool skip = false;
sfricke-samsungef15e482022-01-26 11:32:49 -08001123 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001124 // Generate warnings about work group sizes based on active resources.
sfricke-samsungef15e482022-01-26 11:32:49 -08001125 auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
1126 if (entrypoint == module_state->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001127
1128 uint32_t x = 1, y = 1, z = 1;
sfricke-samsungef15e482022-01-26 11:32:49 -08001129 module_state->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001130
1131 uint32_t thread_count = x * y * z;
1132
1133 // Generate a priori warnings about work group sizes.
1134 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1135 skip |= LogPerformanceWarning(
1136 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1137 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1138 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1139 "groups with less than %u threads, especially when using barrier() or shared memory.",
1140 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1141 }
1142
1143 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1144 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1145 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1146 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1147 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1148 "%u, %u) is not aligned to %u "
1149 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1150 "leave threads idle on the shader "
1151 "core.",
1152 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1153 kThreadGroupDispatchCountAlignmentArm);
1154 }
1155
sfricke-samsungef15e482022-01-26 11:32:49 -08001156 auto accessible_ids = module_state->MarkAccessibleIds(entrypoint);
1157 auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001158
1159 unsigned dimensions = 0;
1160 if (x > 1) dimensions++;
1161 if (y > 1) dimensions++;
1162 if (z > 1) dimensions++;
1163 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1164 dimensions = std::max(dimensions, 1u);
1165
1166 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1167 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1168 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1169 bool accesses_2d = false;
1170 for (const auto& usage : descriptor_uses) {
sfricke-samsungef15e482022-01-26 11:32:49 -08001171 auto dim = module_state->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001172 if (dim < 0) continue;
1173 auto spvdim = spv::Dim(dim);
1174 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1175 }
1176
1177 if (accesses_2d && dimensions < 2) {
1178 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1179 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1180 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1181 "exhibiting poor spatial locality with respect to one or more shader resources.",
1182 VendorSpecificTag(kBPVendorArm), x, y, z);
1183 }
1184
Camden5b184be2019-08-13 07:50:19 -06001185 return skip;
1186}
1187
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001188bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001189 bool skip = false;
1190
1191 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001192 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1193 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001194 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001195 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1196 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001197 }
1198
1199 return skip;
1200}
1201
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001202bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1203 bool skip = false;
1204
1205 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1206 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1207 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1208 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1209 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1210 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1211 }
1212
1213 return skip;
1214}
1215
1216bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1217 bool skip = false;
1218 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1219
1220 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1221 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1222
1223 return skip;
1224}
1225
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001226void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001227 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1228 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1229 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1230 LogPerformanceWarning(
1231 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1232 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1233 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1234 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1235 "convenient opportunity.",
1236 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1237 }
1238 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001239
1240 // AMD best practice
1241 // end-of-frame cleanup
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001242 num_queue_submissions_ = 0;
1243 num_barriers_objects_ = 0;
1244 ClearPipelinesUsedInFrame();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001245}
1246
Jeff Bolz5c801d12019-10-09 10:38:45 -05001247bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1248 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001249 bool skip = false;
1250
1251 for (uint32_t submit = 0; submit < submitCount; submit++) {
1252 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1253 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1254 }
1255 }
1256
1257 return skip;
1258}
1259
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001260bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1261 VkFence fence) const {
1262 bool skip = false;
1263
1264 for (uint32_t submit = 0; submit < submitCount; submit++) {
1265 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1266 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1267 }
1268 }
1269
1270 return skip;
1271}
1272
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001273bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits,
1274 VkFence fence) const {
1275 bool skip = false;
1276
1277 for (uint32_t submit = 0; submit < submitCount; submit++) {
1278 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1279 skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1280 }
1281 }
1282
1283 return skip;
1284}
1285
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001286bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1287 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1288 bool skip = false;
1289
1290 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1291 skip |= LogPerformanceWarning(
1292 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1293 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1294 "pool instead.");
1295 }
1296
1297 return skip;
1298}
1299
1300bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1301 const VkCommandBufferBeginInfo* pBeginInfo) const {
1302 bool skip = false;
1303
1304 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1305 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1306 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1307 }
1308
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001309 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1310 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001311 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1312 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1313 VendorSpecificTag(kBPVendorArm));
1314 }
1315
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001316 return skip;
1317}
1318
Jeff Bolz5c801d12019-10-09 10:38:45 -05001319bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001320 bool skip = false;
1321
1322 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1323
1324 return skip;
1325}
1326
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001327bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1328 const VkDependencyInfoKHR* pDependencyInfo) const {
1329 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1330}
1331
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001332bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1333 const VkDependencyInfo* pDependencyInfo) const {
1334 return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo);
1335}
1336
Jeff Bolz5c801d12019-10-09 10:38:45 -05001337bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1338 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001339 bool skip = false;
1340
1341 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1342
1343 return skip;
1344}
1345
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001346bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1347 VkPipelineStageFlags2KHR stageMask) const {
1348 bool skip = false;
1349
1350 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1351
1352 return skip;
1353}
1354
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001355bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1356 VkPipelineStageFlags2 stageMask) const {
1357 bool skip = false;
1358
1359 skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask);
1360
1361 return skip;
1362}
1363
Camden5b184be2019-08-13 07:50:19 -06001364bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1365 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1366 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1367 uint32_t bufferMemoryBarrierCount,
1368 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1369 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001370 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001371 bool skip = false;
1372
1373 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1374 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1375
1376 return skip;
1377}
1378
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001379bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1380 const VkDependencyInfoKHR* pDependencyInfos) const {
1381 bool skip = false;
1382 for (uint32_t i = 0; i < eventCount; i++) {
1383 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1384 }
1385
1386 return skip;
1387}
1388
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001389bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1390 const VkDependencyInfo* pDependencyInfos) const {
1391 bool skip = false;
1392 for (uint32_t i = 0; i < eventCount; i++) {
1393 skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]);
1394 }
1395
1396 return skip;
1397}
1398
Camden5b184be2019-08-13 07:50:19 -06001399bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1400 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1401 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1402 uint32_t bufferMemoryBarrierCount,
1403 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1404 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001405 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001406 bool skip = false;
1407
1408 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1409 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1410
ziga-lunargb65dbfb2022-03-19 18:45:09 +01001411 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1412 if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED &&
1413 IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) {
1414 skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly,
1415 "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents "
1416 "may be discarded, but the newLayout is %s, which is read only.",
1417 string_VkImageLayout(pImageMemoryBarriers[i].newLayout));
1418 }
1419 }
1420
Nadav Gevaf0808442021-05-21 13:51:25 -04001421 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001422 auto num = num_barriers_objects_.load();
1423 if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001424 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001425 "%s Performance warning: In this frame, %" PRIu32
1426 " barriers were already submitted. Barriers have a high cost and can "
1427 "stall the GPU. "
1428 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1429 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04001430 }
1431
1432 std::array<VkImageLayout, 3> read_layouts = {
1433 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1434 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1435 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1436 };
1437
1438 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1439 // read to read barriers
1440 auto found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].oldLayout);
1441 bool old_is_read_layout = found != read_layouts.end();
1442 found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].newLayout);
1443 bool new_is_read_layout = found != read_layouts.end();
1444 if (old_is_read_layout && new_is_read_layout) {
1445 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
1446 "%s Performance warning: Don't issue read-to-read barriers. Get the resource in the right state the first "
1447 "time you use it.",
1448 VendorSpecificTag(kBPVendorAMD));
1449 }
1450
1451 // general with no storage
1452 if (pImageMemoryBarriers[i].newLayout == VK_IMAGE_LAYOUT_GENERAL) {
1453 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1454 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1455 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1456 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1457 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1458 VendorSpecificTag(kBPVendorAMD));
1459 }
1460 }
1461 }
1462 }
1463
Camden5b184be2019-08-13 07:50:19 -06001464 return skip;
1465}
1466
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001467bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1468 const VkDependencyInfoKHR* pDependencyInfo) const {
1469 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1470}
1471
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001472bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer,
1473 const VkDependencyInfo* pDependencyInfo) const {
1474 return CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo);
1475}
1476
Camden5b184be2019-08-13 07:50:19 -06001477bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001478 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001479 bool skip = false;
1480
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001481 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1482
1483 return skip;
1484}
1485
1486bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1487 VkQueryPool queryPool, uint32_t query) const {
1488 bool skip = false;
1489
1490 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001491
1492 return skip;
1493}
1494
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001495bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage,
1496 VkQueryPool queryPool, uint32_t query) const {
1497 bool skip = false;
1498
1499 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage);
1500
1501 return skip;
1502}
1503
Sam Walls0961ec02020-03-31 16:39:15 +01001504void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1505 VkPipeline pipeline) {
1506 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1507
Nadav Gevaf0808442021-05-21 13:51:25 -04001508 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001509 PipelineUsedInFrame(pipeline);
Nadav Gevaf0808442021-05-21 13:51:25 -04001510
Sam Walls0961ec02020-03-31 16:39:15 +01001511 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001512 auto pipeline_state = Get<bp_state::Pipeline>(pipeline);
Sam Walls0961ec02020-03-31 16:39:15 +01001513 // check for depth/blend state tracking
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001514 if (pipeline_state) {
1515 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001516 assert(cb_node);
1517 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001518
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001519 render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments;
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001520 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001521
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07001522 const auto* blend_state = pipeline_state->ColorBlendState();
1523 const auto* stencil_state = pipeline_state->DepthStencilState();
Sam Walls0961ec02020-03-31 16:39:15 +01001524
1525 if (blend_state) {
1526 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001527 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001528 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1529 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001530 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001531 }
1532 }
1533 }
1534
1535 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001536 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001537
1538 if (stencil_state && stencil_state->depthTestEnable) {
1539 switch (stencil_state->depthCompareOp) {
1540 case VK_COMPARE_OP_EQUAL:
1541 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1542 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001543 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001544 break;
1545 default:
1546 break;
1547 }
1548 }
Sam Walls0961ec02020-03-31 16:39:15 +01001549 }
1550 }
1551}
1552
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02001553static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1554 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
1555 const auto& subpass_info = createInfo.pSubpasses[subpass];
1556 if (subpass_info.pResolveAttachments) {
1557 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1558 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1559 }
1560 }
1561 }
1562
1563 return false;
1564}
1565
Attilio Provenzano02859b22020-02-27 14:17:28 +00001566static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1567 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001568 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001569
1570 // If an attachment is ever used as a color attachment,
1571 // resolve attachment or depth stencil attachment,
1572 // it needs to exist on tile at some point.
1573
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001574 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1575 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001576 }
1577
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001578 if (subpass_info.pResolveAttachments) {
1579 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1580 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1581 }
1582 }
1583
1584 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001585 }
1586
1587 return false;
1588}
1589
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001590static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1591 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1592 return false;
1593 }
1594
1595 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001596 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001597
1598 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1599 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1600 return true;
1601 }
1602 }
1603 }
1604
1605 return false;
1606}
1607
Attilio Provenzano02859b22020-02-27 14:17:28 +00001608bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1609 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1610 bool skip = false;
1611
1612 if (!pRenderPassBegin) {
1613 return skip;
1614 }
1615
Gareth Webbdc6549a2021-06-16 03:52:24 +01001616 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
1617 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
1618 "This render pass has a zero-size render area. It cannot write to any attachments, "
1619 "and can only be used for side effects such as layout transitions.");
1620 }
1621
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001622 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001623 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001624 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001625 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001626 if (rpabi) {
1627 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1628 }
1629 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001630 // Check if any attachments have LOAD operation on them
1631 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001632 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001633
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001634 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02001635 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001636 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001637 }
1638
1639 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001640 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001641 }
1642
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001643 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001644
1645 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001646 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1647 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001648 }
1649
1650 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
LawG47747b322022-02-23 16:12:10 +00001651 if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
1652 skip |=
1653 LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
LawG4015be1c2022-03-01 10:37:52 +00001654 "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
LawG47747b322022-02-23 16:12:10 +00001655 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04001656 "which will copy in total %u pixels (renderArea = "
LawG47747b322022-02-23 16:12:10 +00001657 "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.",
1658 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att,
1659 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1660 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1661 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001662 }
1663 }
1664 }
1665
1666 return skip;
1667}
1668
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001669void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
1670 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001671 if (view) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001672 auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state);
1673 QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001674 }
1675}
1676
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001677void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1678 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001679 // If we're viewing a 3D slice, ignore base array layer.
1680 // The entire 3D subresource is accessed as one atomic unit.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001681 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 +02001682
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001683 const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001684 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001685 const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel;
1686 const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001687
1688 for (uint32_t layer = 0; layer < array_layers; layer++) {
1689 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001690 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
1691 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001692 }
1693 }
1694}
1695
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001696void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1697 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) {
1698 const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001699 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001700
1701 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001702 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001703 }
1704}
1705
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001706void BestPractices::QueueValidateImage(QueueCallbacks &funcs, const char* function_name,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001707 std::shared_ptr<bp_state::Image> &state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001708 uint32_t array_layer, uint32_t mip_level) {
Jeremy Gebben7fd238f2022-03-04 10:32:24 -07001709 if (VendorCheckEnabled(kBPVendorArm)) {
1710 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](
1711 const ValidationStateTracker&, const QUEUE_STATE&, const CMD_BUFFER_STATE&) -> bool {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001712 ValidateImageInQueue(function_name, *state, usage, array_layer, mip_level);
Jeremy Gebben7fd238f2022-03-04 10:32:24 -07001713 return false;
1714 });
1715 }
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001716}
1717
LawG44d414ba2022-02-23 15:35:41 +00001718void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001719 IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001720 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001721 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001722 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 -07001723 !image.IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001724 LogPerformanceWarning(
1725 device, kVUID_BestPractices_RenderPass_RedundantStore,
LawG4015be1c2022-03-01 10:37:52 +00001726 "%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 +02001727 "image was used, it was written to with STORE_OP_STORE. "
1728 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1729 "architectures.",
LawG44d414ba2022-02-23 15:35:41 +00001730 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001731 } 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 +02001732 LogPerformanceWarning(
1733 device, kVUID_BestPractices_RenderPass_RedundantClear,
LawG4015be1c2022-03-01 10:37:52 +00001734 "%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 +02001735 "image was used, it was written to with vkCmdClear*Image(). "
1736 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
LawG44d414ba2022-02-23 15:35:41 +00001737 "tile-based architectures.",
1738 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001739 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001740 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1741 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001742 const char *last_cmd = nullptr;
1743 const char *vuid = nullptr;
1744 const char *suggestion = nullptr;
1745
1746 switch (last_usage) {
1747 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1748 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1749 last_cmd = "vkCmdBlitImage";
1750 suggestion =
1751 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1752 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1753 "which avoids the memory roundtrip.";
1754 break;
1755 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1756 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1757 last_cmd = "vkCmdClear*Image";
1758 suggestion =
1759 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1760 "tile-based architectures. "
1761 "Use LOAD_OP_CLEAR instead to clear the image for free.";
1762 break;
1763 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
1764 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
1765 last_cmd = "vkCmdCopy*Image";
1766 suggestion =
1767 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1768 "Rather than copying, just render the source image in a fragment shader in this render pass, "
1769 "which avoids the memory roundtrip.";
1770 break;
1771 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
1772 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
1773 last_cmd = "vkCmdResolveImage";
1774 suggestion =
1775 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
1776 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
1777 "which avoids the memory roundtrip.";
1778 break;
1779 default:
1780 break;
1781 }
1782
1783 LogPerformanceWarning(
1784 device, vuid,
LawG4015be1c2022-03-01 10:37:52 +00001785 "%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 +01001786 "time image was used, it was written to with %s. %s",
LawG44d414ba2022-02-23 15:35:41 +00001787 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd,
1788 suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001789 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001790}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001791
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001792void BestPractices::ValidateImageInQueue(const char* function_name, bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage,
1793 uint32_t array_layer, uint32_t mip_level) {
1794 auto last_usage = state.UpdateUsage(array_layer, mip_level, usage);
LawG44d414ba2022-02-23 15:35:41 +00001795 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
1796 ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001797 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001798}
1799
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001800void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) {
1801 cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(),
1802 cb.queue_submit_functions_after_render_pass.end());
1803 cb.queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001804}
1805
1806void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
1807 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001808 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1809 if (cb_node) {
1810 AddDeferredQueueOperations(*cb_node);
1811 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001812}
1813
1814void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
1815 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001816 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1817 if (cb_node) {
1818 AddDeferredQueueOperations(*cb_node);
1819 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001820}
1821
1822void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
1823 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001824 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1825 if (cb_node) {
1826 AddDeferredQueueOperations(*cb_node);
1827 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001828}
1829
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001830void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
1831 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001832 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001833 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001834 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1835}
1836
1837void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
1838 const VkRenderPassBeginInfo* pRenderPassBegin,
1839 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1840 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1841 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1842}
1843
1844void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1845 const VkRenderPassBeginInfo* pRenderPassBegin,
1846 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1847 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1848 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1849}
1850
1851void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001852
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001853 if (!pRenderPassBegin) {
1854 return;
1855 }
1856
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001857 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001858
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001859 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001860 if (rp_state) {
1861 // Check load ops
1862 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001863 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001864
1865 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
1866 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1867 continue;
1868 }
1869
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001870 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001871
1872 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
1873 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001874 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001875 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
1876 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001877 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001878 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001879 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001880 }
1881
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001882 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Jeremy Gebben9f537102021-10-05 16:37:12 -06001883 std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr;
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001884
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001885 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001886 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1887 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001888 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001889 }
1890 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001891 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001892 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001893
Jeremy Gebben9f537102021-10-05 16:37:12 -06001894 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001895 }
1896
1897 // Check store ops
1898 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001899 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001900
1901 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1902 continue;
1903 }
1904
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001905 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001906
1907 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
1908 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001909 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001910 }
1911
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001912 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001913
Jeremy Gebben9f537102021-10-05 16:37:12 -06001914 std::shared_ptr<IMAGE_VIEW_STATE> image_view;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001915 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001916 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1917 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001918 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001919 }
1920 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001921 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001922 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001923
Jeremy Gebben9f537102021-10-05 16:37:12 -06001924 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001925 }
1926 }
1927}
1928
Attilio Provenzano02859b22020-02-27 14:17:28 +00001929bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1930 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001931 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1932 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001933 return skip;
1934}
1935
1936bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1937 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001938 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001939 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1940 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001941 return skip;
1942}
1943
1944bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001945 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001946 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1947 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001948 return skip;
1949}
1950
Sam Walls0961ec02020-03-31 16:39:15 +01001951void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1952 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001953 // Reset the renderpass state
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001954 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001955 cb->hasDrawCmd = false;
1956 assert(cb);
1957 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02001958 render_pass_state.touchesAttachments.clear();
1959 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001960 render_pass_state.numDrawCallsDepthOnly = 0;
1961 render_pass_state.numDrawCallsDepthEqualCompare = 0;
1962 render_pass_state.colorAttachment = false;
1963 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001964 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001965 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01001966
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001967 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01001968
1969 // track depth / color attachment usage within the renderpass
1970 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
1971 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001972 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001973
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001974 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001975 }
1976}
1977
1978void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1979 VkSubpassContents contents) {
1980 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1981 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
1982}
1983
1984void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1985 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1986 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1987 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
1988}
1989
1990void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1991 const VkRenderPassBeginInfo* pRenderPassBegin,
1992 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1993 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1994 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
1995}
1996
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001997// Generic function to handle validation for all CmdDraw* type functions
1998bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
1999 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002000 const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002001 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002002 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2003 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002004 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002005
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002006 // Verify vertex binding
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002007 if (pipeline_state->vertex_input_state && pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) {
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002008 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002009 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002010 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002011 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
2012 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002013 }
2014 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002015
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002016 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002017 if (pipe) {
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002018 const auto& rp_state = pipe->RenderPassState();
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002019 if (rp_state) {
2020 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
2021 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002022 const auto* ds_state = pipe->DepthStencilState();
Jeremy Gebben11af9792021-08-20 10:20:09 -06002023 const uint32_t depth_stencil_attachment =
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002024 GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment);
2025 const auto* raster_state = pipe->RasterizationState();
2026 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state &&
2027 raster_state->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002028 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
2029 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
2030 }
2031 }
2032 }
2033 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002034 }
2035 return skip;
2036}
2037
Sam Walls0961ec02020-03-31 16:39:15 +01002038void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002039 auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002040 assert(cb_node);
Sam Walls0961ec02020-03-31 16:39:15 +01002041 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002042 RecordCmdDrawTypeArm(*cb_node, draw_count, caller);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002043 }
2044
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002045 if (cb_node->render_pass_state.drawTouchAttachments) {
2046 for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) {
2047 RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002048 }
2049 // No need to touch the same attachments over and over.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002050 cb_node->render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002051 }
2052}
2053
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002054void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) {
2055 auto& render_pass_state = cb_node.render_pass_state;
LawG4b21485c2022-02-28 13:46:48 +00002056 // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards
2057 // depth prepass warnings First find the lowest enabled draw count
2058 uint32_t lowestEnabledMinDrawCount = 0;
2059 lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm;
2060 if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount)
2061 lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG;
2062
2063 if (draw_count >= lowestEnabledMinDrawCount) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002064 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
2065 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01002066 }
2067}
2068
Camden5b184be2019-08-13 07:50:19 -06002069bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002070 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002071 bool skip = false;
2072
2073 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002074 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2075 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002076 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002077 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06002078
2079 return skip;
2080}
2081
Sam Walls0961ec02020-03-31 16:39:15 +01002082void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2083 uint32_t firstVertex, uint32_t firstInstance) {
2084 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
2085 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
2086}
2087
Camden5b184be2019-08-13 07:50:19 -06002088bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002089 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002090 bool skip = false;
2091
2092 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002093 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2094 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002095 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002096 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
2097
Attilio Provenzano02859b22020-02-27 14:17:28 +00002098 // Check if we reached the limit for small indexed draw calls.
2099 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002100 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002101 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002102 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
LawG4ff42d722022-03-01 10:28:25 +00002103 (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002104 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
LawG4ff42d722022-03-01 10:28:25 +00002105 "%s %s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00002106 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
2107 "You can try batching drawcalls or instancing when applicable.",
LawG4ff42d722022-03-01 10:28:25 +00002108 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls,
2109 kSmallIndexedDrawcallIndices);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002110 }
2111
Sam Walls8e77e4f2020-03-16 20:47:40 +00002112 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002113 ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002114 }
2115
2116 return skip;
2117}
2118
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002119bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount,
Sam Walls8e77e4f2020-03-16 20:47:40 +00002120 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
2121 bool skip = false;
2122
2123 // check for sparse/underutilised index buffer, and post-transform cache thrashing
Sam Walls8e77e4f2020-03-16 20:47:40 +00002124
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002125 const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get();
2126 if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002127
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002128 const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002129 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00002130 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
2131 const void* ib_mem = ib_mem_state.p_driver_data;
2132 bool primitive_restart_enable = false;
2133
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002134 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002135 const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point];
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002136 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002137
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002138 const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr;
2139 if (ia_state) {
2140 primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002141 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00002142
2143 // 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 -06002144 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00002145 uint32_t scan_stride;
2146 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2147 scan_stride = sizeof(uint8_t);
2148 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2149 scan_stride = sizeof(uint16_t);
2150 } else {
2151 scan_stride = sizeof(uint32_t);
2152 }
2153
2154 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
2155 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
2156
2157 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
2158 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
2159 // irrespective of whether or not they're part of the draw call.
2160
2161 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
2162 uint32_t min_index = ~0u;
2163 // start with maximum as 0 and adjust to indices in the buffer
2164 uint32_t max_index = 0u;
2165
2166 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
2167 // for the given index buffer
2168 uint32_t vertex_shade_count = 0;
2169
2170 PostTransformLRUCacheModel post_transform_cache;
2171
2172 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
2173 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
2174 // target architecture.
2175 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
2176 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
2177 post_transform_cache.resize(32);
2178
2179 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2180 uint32_t scan_index;
2181 uint32_t primitive_restart_value;
2182 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2183 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2184 primitive_restart_value = 0xFF;
2185 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2186 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2187 primitive_restart_value = 0xFFFF;
2188 } else {
2189 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2190 primitive_restart_value = 0xFFFFFFFF;
2191 }
2192
2193 max_index = std::max(max_index, scan_index);
2194 min_index = std::min(min_index, scan_index);
2195
2196 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
2197 bool in_cache = post_transform_cache.query_cache(scan_index);
2198 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
2199 if (!in_cache) vertex_shade_count++;
2200 }
2201 }
2202
2203 // 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 +01002204 // 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
2205 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002206
2207 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07002208 skip |=
2209 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2210 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
2211 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
2212 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
2213 "maximum would be loaded, and possibly shaded, whether or not they are used.",
2214 VendorSpecificTag(kBPVendorArm),
2215 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002216 return skip;
2217 }
2218
2219 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
2220 // 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 +01002221 const size_t refs_per_bucket = 64;
2222 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
2223
2224 const uint32_t n_indices = max_index - min_index + 1;
2225 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
2226 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
2227
2228 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
2229 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00002230
2231 // To avoid using too much memory, we run over the indices again.
2232 // Knowing the size from the last scan allows us to record index usage with bitsets
2233 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2234 uint32_t scan_index;
2235 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2236 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2237 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2238 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2239 } else {
2240 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2241 }
2242 // keep track of the set of all indices used to reference vertices in the draw call
2243 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01002244 size_t bitset_bucket_index = index_offset / refs_per_bucket;
2245 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002246 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
2247 }
2248
2249 uint32_t vertex_reference_count = 0;
2250 for (const auto& bitset : vertex_reference_buckets) {
2251 vertex_reference_count += static_cast<uint32_t>(bitset.count());
2252 }
2253
2254 // 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 -07002255 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002256 // 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 -07002257 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002258
2259 if (utilization < 0.5f) {
2260 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2261 "%s The indices which were specified for the draw call only utilise approximately "
2262 "%.02f%% of the bound vertex buffer.",
2263 VendorSpecificTag(kBPVendorArm), utilization);
2264 }
2265
2266 if (cache_hit_rate <= 0.5f) {
2267 skip |=
2268 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
2269 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
2270 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
2271 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
2272 "recently shaded vertices.",
2273 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
2274 }
2275 }
2276
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002277 return skip;
2278}
2279
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002280bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2281 const VkCommandBuffer* pCommandBuffers) const {
2282 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002283 const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002284 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002285 const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002286 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002287 continue;
2288 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002289 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002290 for (auto& clear : secondary.earlyClearAttachments) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002291 if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) {
2292 skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002293 }
2294 }
2295 }
Nadav Gevaf0808442021-05-21 13:51:25 -04002296
2297 if (VendorCheckEnabled(kBPVendorAMD)) {
2298 if (commandBufferCount > 0) {
2299 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
2300 "%s Performance warning: Use of secondary command buffers is not recommended. ",
2301 VendorSpecificTag(kBPVendorAMD));
2302 }
2303 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002304 return skip;
2305}
2306
2307void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2308 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002309 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
2310
2311 auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2312 if (!primary) {
2313 return;
2314 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002315
2316 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002317 auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]);
2318 if (!secondary) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002319 continue;
2320 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002321
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002322 for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) {
2323 if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
2324 RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment,
2325 early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002326 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002327 RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002328 }
2329 }
2330
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002331 for (auto& touch : secondary->render_pass_state.touchesAttachments) {
2332 RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002333 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02002334
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002335 primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare;
2336 primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly;
Hans-Kristian Arntzenaf81dca2021-06-18 11:14:28 +02002337
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002338 if (secondary->hasDrawCmd) {
Hans-Kristian Arntzenaf81dca2021-06-18 11:14:28 +02002339 primary->hasDrawCmd = true;
2340 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002341 }
2342
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002343}
2344
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002345void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
2346 auto& state = cb_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002347 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002348 auto itr =
2349 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2350 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002351
2352 if (itr != state.touchesAttachments.end()) {
2353 itr->aspects |= aspects;
2354 } else {
2355 state.touchesAttachments.push_back({ fb_attachment, aspects });
2356 }
2357}
2358
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002359void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002360 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
2361 const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002362 auto& state = cmd_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002363 // If we observe a full clear before any other access to a frame buffer attachment,
2364 // we have candidate for redundant clear attachments.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002365 auto itr =
2366 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2367 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002368
2369 uint32_t new_aspects = aspects;
2370 if (itr != state.touchesAttachments.end()) {
2371 new_aspects = aspects & ~itr->aspects;
2372 itr->aspects |= aspects;
2373 } else {
2374 state.touchesAttachments.push_back({ fb_attachment, aspects });
2375 }
2376
2377 if (new_aspects == 0) {
2378 return;
2379 }
2380
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002381 if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002382 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
2383 // CmdExecuteCommands.
2384 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
2385 std::vector<VkClearRect>{pRects, pRects + rectCount} });
2386 }
2387}
2388
2389void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
2390 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
2391 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002392 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects);
2393
2394 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2395 auto* rp_state = cmd_state->activeRenderPass.get();
2396 auto* fb_state = cmd_state->activeFramebuffer.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002397 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
2398
2399 if (rectCount == 0 || !rp_state) {
2400 return;
2401 }
2402
2403 if (!is_secondary && !fb_state) {
2404 return;
2405 }
2406
2407 // 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 -07002408 bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002409
ziga-lunarg885c6542022-03-07 01:08:25 +01002410 if (!rp_state->use_dynamic_rendering && !rp_state->use_dynamic_rendering_inherited) {
2411 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
2412 for (uint32_t i = 0; i < attachmentCount; i++) {
2413 auto& attachment = pClearAttachments[i];
2414 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2415 VkImageAspectFlags aspects = attachment.aspectMask;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002416
ziga-lunarg885c6542022-03-07 01:08:25 +01002417 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
2418 if (subpass.pDepthStencilAttachment) {
2419 fb_attachment = subpass.pDepthStencilAttachment->attachment;
2420 }
2421 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
2422 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002423 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002424
ziga-lunarg885c6542022-03-07 01:08:25 +01002425 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2426 if (full_clear) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002427 RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment,
ziga-lunarg885c6542022-03-07 01:08:25 +01002428 aspects, rectCount, pRects);
2429 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002430 RecordAttachmentAccess(*cmd_state, fb_attachment, aspects);
ziga-lunarg885c6542022-03-07 01:08:25 +01002431 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002432 }
2433 }
2434 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002435}
2436
Attilio Provenzano02859b22020-02-27 14:17:28 +00002437void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2438 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2439 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
2440 firstInstance);
2441
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002442 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002443 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
2444 cmd_state->small_indexed_draw_call_count++;
2445 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002446
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002447 ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00002448}
2449
Sam Walls0961ec02020-03-31 16:39:15 +01002450void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2451 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2452 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2453 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
2454}
2455
sfricke-samsung681ab7b2020-10-29 01:53:35 -07002456bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2457 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
2458 uint32_t maxDrawCount, uint32_t stride) const {
2459 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
2460
2461 return skip;
2462}
2463
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002464bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
2465 VkDeviceSize offset, VkBuffer countBuffer,
2466 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
2467 uint32_t stride) const {
2468 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06002469
2470 return skip;
2471}
2472
2473bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002474 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002475 bool skip = false;
2476
2477 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002478 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2479 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002480 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002481 }
2482
2483 return skip;
2484}
2485
Sam Walls0961ec02020-03-31 16:39:15 +01002486void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2487 uint32_t count, uint32_t stride) {
2488 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2489 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2490}
2491
Camden5b184be2019-08-13 07:50:19 -06002492bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002493 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002494 bool skip = false;
2495
2496 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002497 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2498 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002499 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002500 }
2501
2502 return skip;
2503}
2504
Sam Walls0961ec02020-03-31 16:39:15 +01002505void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2506 uint32_t count, uint32_t stride) {
2507 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2508 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2509}
2510
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002511void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) {
2512 for (auto descriptor_set : cb_state.validated_descriptor_sets) {
2513 const auto& layout = *descriptor_set->GetLayout();
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002514
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002515 for (uint32_t index = 0; index < descriptor_set->GetBindingCount(); ++index) {
2516 // For bindless scenarios, we should not attempt to track descriptor set state.
2517 // It is highly uncertain which resources are actually bound.
2518 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
2519 VkDescriptorBindingFlags flags = layout.GetDescriptorBindingFlagsFromIndex(index);
2520 if (flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2521 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
2522 continue;
2523 }
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002524
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002525 auto index_range = layout.GetGlobalIndexRangeFromIndex(index);
2526 for (uint32_t i = index_range.start; i < index_range.end; ++i) {
2527 VkImageView image_view{VK_NULL_HANDLE};
2528
2529 auto descriptor = descriptor_set->GetDescriptorFromGlobalIndex(i);
2530 switch (descriptor->GetClass()) {
2531 case cvdescriptorset::DescriptorClass::Image: {
2532 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2533 image_view = image_descriptor->GetImageView();
2534 }
2535 break;
2536 }
2537 case cvdescriptorset::DescriptorClass::ImageSampler: {
2538 if (const auto image_sampler_descriptor =
2539 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2540 image_view = image_sampler_descriptor->GetImageView();
2541 }
2542 break;
2543 }
2544 default:
2545 break;
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002546 }
2547
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002548 if (image_view) {
2549 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
2550 QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(),
2551 IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002552 }
2553 }
2554 }
2555 }
2556}
2557
2558void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2559 uint32_t firstVertex, uint32_t firstInstance) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002560 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2561 ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002562}
2563
2564void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2565 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002566 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2567 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002568}
2569
2570void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2571 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002572 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2573 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002574}
2575
Camden5b184be2019-08-13 07:50:19 -06002576bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002577 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002578 bool skip = false;
2579
2580 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002581 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2582 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2583 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2584 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002585 }
2586
2587 return skip;
2588}
Camden83a9c372019-08-14 11:41:38 -06002589
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002590bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2591 bool skip = false;
2592 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
2593 skip |= ValidateCmdEndRenderPass(commandBuffer);
2594 return skip;
2595}
2596
2597bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2598 bool skip = false;
2599 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
2600 skip |= ValidateCmdEndRenderPass(commandBuffer);
2601 return skip;
2602}
2603
Sam Walls0961ec02020-03-31 16:39:15 +01002604bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2605 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002606 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002607 skip |= ValidateCmdEndRenderPass(commandBuffer);
2608 return skip;
2609}
2610
2611bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2612 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002613 const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01002614
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002615 if (cmd == nullptr) return skip;
2616 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01002617
LawG4b21485c2022-02-28 13:46:48 +00002618 // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor
2619 bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2620 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
2621 bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG &&
2622 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG;
2623
2624 // Only send the warning when the vendor is enabled and a depth prepass is detected
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002625 bool uses_depth = (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
LawG4b21485c2022-02-28 13:46:48 +00002626 (depth_only_arm && VendorCheckEnabled(kBPVendorAMD) || depth_only_img && VendorCheckEnabled(kBPVendorIMG));
2627
Sam Walls0961ec02020-03-31 16:39:15 +01002628 if (uses_depth) {
2629 skip |= LogPerformanceWarning(
2630 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
LawG4015be1c2022-03-01 10:37:52 +00002631 "%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 +00002632 "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry "
2633 "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface "
2634 "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.",
2635 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Sam Walls0961ec02020-03-31 16:39:15 +01002636 }
2637
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002638 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2639
LawG40da9c3d2022-03-01 09:51:01 +00002640 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002641 // If we use an attachment on-tile, we should access it in some way. Otherwise,
2642 // it is redundant to have it be part of the render pass.
2643 // Only consider it redundant if it will actually consume bandwidth, i.e.
2644 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
2645 // as is using pure input attachments.
2646 // CLEAR -> STORE might be considered a "useful" thing to do, but
2647 // the optimal thing to do is to defer the clear until you're actually
2648 // going to render to the image.
2649
2650 uint32_t num_attachments = rp->createInfo.attachmentCount;
2651 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002652 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
2653 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002654 continue;
2655 }
2656
2657 auto& attachment = rp->createInfo.pAttachments[i];
2658
2659 VkImageAspectFlags bandwidth_aspects = 0;
2660
2661 if (!FormatIsStencilOnly(attachment.format) &&
2662 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2663 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2664 if (FormatHasDepth(attachment.format)) {
2665 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
2666 } else {
2667 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
2668 }
2669 }
2670
2671 if (FormatHasStencil(attachment.format) &&
2672 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2673 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2674 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
2675 }
2676
2677 if (!bandwidth_aspects) {
2678 continue;
2679 }
2680
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002681 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002682 [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002683 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002684 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002685 untouched_aspects &= ~itr->aspects;
2686 }
2687
2688 if (untouched_aspects) {
2689 skip |= LogPerformanceWarning(
2690 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
LawG4015be1c2022-03-01 10:37:52 +00002691 "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002692 "was never accessed by a pipeline or clear command. "
LawG40da9c3d2022-03-01 09:51:01 +00002693 "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 +00002694 "render pass if the attachments are not intended to be accessed.",
LawG40da9c3d2022-03-01 09:51:01 +00002695 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects);
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002696 }
2697 }
2698 }
2699
Sam Walls0961ec02020-03-31 16:39:15 +01002700 return skip;
2701}
2702
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002703void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002704 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2705 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002706}
2707
2708void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002709 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2710 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002711}
2712
Camden Stocker9c051442019-11-06 14:28:43 -08002713bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
2714 const char* api_name) const {
2715 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002716 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08002717
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002718 if (bp_pd_state) {
2719 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
2720 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
2721 "Potential problem with calling %s() without first retrieving properties from "
2722 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
2723 api_name);
2724 }
Camden Stocker9c051442019-11-06 14:28:43 -08002725 }
2726
2727 return skip;
2728}
2729
Camden83a9c372019-08-14 11:41:38 -06002730bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002731 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06002732 bool skip = false;
2733
Camden Stocker9c051442019-11-06 14:28:43 -08002734 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06002735
Camden Stocker9c051442019-11-06 14:28:43 -08002736 return skip;
2737}
2738
2739bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
2740 uint32_t planeIndex,
2741 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
2742 bool skip = false;
2743
2744 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
2745
2746 return skip;
2747}
2748
2749bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
2750 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
2751 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
2752 bool skip = false;
2753
2754 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06002755
2756 return skip;
2757}
Camden05de2d42019-08-19 10:23:56 -06002758
2759bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002760 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06002761 bool skip = false;
2762
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002763 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Camden05de2d42019-08-19 10:23:56 -06002764
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002765 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06002766 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002767 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002768 skip |=
2769 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
2770 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
2771 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06002772 }
Camden05de2d42019-08-19 10:23:56 -06002773
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002774 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
2775 skip |= LogWarning(
2776 device, kVUID_BestPractices_Swapchain_InvalidCount,
2777 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04002778 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002779 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
2780 }
2781 }
2782
Camden05de2d42019-08-19 10:23:56 -06002783 return skip;
2784}
2785
2786// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002787bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002788 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002789 const CALL_STATE call_state,
2790 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06002791 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002792 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
2793 if (UNCALLED == call_state) {
2794 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002795 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002796 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
2797 "recommended "
2798 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
2799 caller_name, caller_name);
2800 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002801 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
2802 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002803 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
2804 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
2805 ". It is recommended to instead receive all the properties by calling %s with "
2806 "pQueueFamilyPropertyCount that was "
2807 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002808 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002809 caller_name);
Camden05de2d42019-08-19 10:23:56 -06002810 }
2811
2812 return skip;
2813}
2814
Jeff Bolz5c801d12019-10-09 10:38:45 -05002815bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
2816 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06002817 bool skip = false;
2818
2819 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002820 auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06002821 if (!as_state->memory_requirements_checked) {
2822 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
2823 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
2824 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002825 skip |= LogWarning(
2826 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06002827 "vkBindAccelerationStructureMemoryNV(): "
2828 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
2829 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
2830 }
2831 }
2832
2833 return skip;
2834}
2835
Camden05de2d42019-08-19 10:23:56 -06002836bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
2837 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002838 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002839 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002840 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002841 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002842 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
2843 "vkGetPhysicalDeviceQueueFamilyProperties()");
2844 }
2845 return false;
Camden05de2d42019-08-19 10:23:56 -06002846}
2847
Mike Schuchardt2df08912020-12-15 16:28:09 -08002848bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
2849 uint32_t* pQueueFamilyPropertyCount,
2850 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002851 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002852 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002853 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002854 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
2855 "vkGetPhysicalDeviceQueueFamilyProperties2()");
2856 }
2857 return false;
Camden05de2d42019-08-19 10:23:56 -06002858}
2859
Jeff Bolz5c801d12019-10-09 10:38:45 -05002860bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08002861 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002862 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002863 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002864 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002865 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
2866 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
2867 }
2868 return false;
Camden05de2d42019-08-19 10:23:56 -06002869}
2870
2871bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
2872 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002873 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06002874 if (!pSurfaceFormats) return false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002875 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002876 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06002877 bool skip = false;
2878 if (call_state == UNCALLED) {
2879 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
2880 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002881 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
2882 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
2883 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06002884 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002885 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002886 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
2887 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
2888 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
2889 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002890 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06002891 }
2892 }
2893 return skip;
2894}
Camden Stocker23cc47d2019-09-03 14:53:57 -06002895
2896bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002897 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002898 bool skip = false;
2899
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002900 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2901 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06002902 // 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 -07002903 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002904 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
2905 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07002906 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06002907 // 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 -07002908 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
2909 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002910 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002911 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002912 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002913 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002914 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002915 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2916 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2917 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002918 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002919 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2920 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002921 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002922 }
2923 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002924 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002925 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002926 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002927 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2928 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002929 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002930 }
2931 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002932 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2933 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002934 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002935 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002936 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002937 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002938 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002939 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2940 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2941 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002942 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002943 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2944 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002945 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002946 }
2947 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002948 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002949 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002950 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002951 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2952 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002953 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002954 }
2955 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2956 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002957 sparse_images_with_metadata.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002958 }
2959 }
2960 }
2961 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002962 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
2963 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002964 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002965 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002966 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
2967 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002968 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002969 }
2970 }
2971 }
2972
2973 return skip;
2974}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002975
Mark Lobodzinski84101d72020-04-24 09:43:48 -06002976void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
2977 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07002978 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07002979 return;
2980 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002981
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002982 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2983 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
2984 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2985 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002986 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002987 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002988 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002989 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002990 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2991 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
2992 image_state->sparse_metadata_bound = true;
2993 }
2994 }
2995 }
2996 }
2997}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002998
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002999bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003000 const VkClearRect* pRects) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003001 if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003002 // We don't know the accurate render area in a secondary,
3003 // so assume we clear the entire frame buffer.
3004 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
3005 return true;
3006 }
3007
3008 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
3009 for (uint32_t i = 0; i < rectCount; i++) {
3010 auto& rect = pRects[i];
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003011 auto& render_area = cmd.activeRenderPassBeginInfo.renderArea;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003012 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
3013 return true;
3014 }
3015 }
3016
3017 return false;
3018}
3019
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003020bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment,
3021 VkImageAspectFlags aspects, bool secondary) const {
3022 const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003023 bool skip = false;
3024
3025 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
3026 return skip;
3027 }
3028
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003029 const auto& rp_state = cmd.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003030
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003031 auto attachment_itr =
3032 std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
3033 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003034
3035 // Only report aspects which haven't been touched yet.
3036 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003037 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003038 new_aspects &= ~attachment_itr->aspects;
3039 }
3040
3041 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003042 if (!cmd.hasDrawCmd) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003043 skip |= LogPerformanceWarning(
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003044 cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02003045 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
3046 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003047 report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003048 }
3049
3050 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
3051 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3052 skip |= LogPerformanceWarning(
3053 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3054 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
3055 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3056 "it is more efficient.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003057 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003058 }
3059
3060 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
3061 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003062 skip |=
3063 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3064 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
3065 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3066 "it is more efficient.",
3067 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003068 }
3069
3070 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
3071 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003072 skip |=
3073 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3074 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
3075 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3076 "it is more efficient.",
3077 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003078 }
3079
3080 return skip;
3081}
3082
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003083bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06003084 const VkClearAttachment* pAttachments, uint32_t rectCount,
3085 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003086 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003087 const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003088 if (!cb_node) return skip;
3089
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003090 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
3091 // Defer checks to ExecuteCommands.
3092 return skip;
3093 }
3094
3095 // Only care about full clears, partial clears might have legitimate uses.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003096 if (!ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects)) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003097 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003098 }
3099
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003100 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
3101 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06003102 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003103 if (rp) {
3104 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
3105
3106 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003107 const auto& attachment = pAttachments[i];
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003108
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003109 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3110 uint32_t color_attachment = attachment.colorAttachment;
3111 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003112 skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003113 }
3114
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003115 if (subpass.pDepthStencilAttachment &&
3116 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003117 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003118 skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003119 }
3120 }
3121 }
3122
Nadav Gevaf0808442021-05-21 13:51:25 -04003123 if (VendorCheckEnabled(kBPVendorAMD)) {
3124 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
3125 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
3126 bool black_check = false;
3127 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
3128 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
3129 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
3130 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3131 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3132
3133 bool white_check = false;
3134 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
3135 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
3136 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
3137 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3138 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3139
3140 if (black_check && white_check) {
3141 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3142 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
3143 "Consider changing to one of the following:"
3144 "RGBA(0, 0, 0, 0) "
3145 "RGBA(0, 0, 0, 1) "
3146 "RGBA(1, 1, 1, 0) "
3147 "RGBA(1, 1, 1, 1)",
3148 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3149 }
3150 } else {
3151 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
3152 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
3153 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
3154 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3155 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
3156 "attachment %" PRId32 " is not a fast clear value."
3157 "Consider changing to one of the following:"
3158 "D=0.0f, S=0"
3159 "D=1.0f, S=0",
3160 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3161 }
3162 }
3163 }
3164 }
3165
Camden Stockerf55721f2019-09-09 11:04:49 -06003166 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003167}
Attilio Provenzano02859b22020-02-27 14:17:28 +00003168
3169bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3170 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3171 const VkImageResolve* pRegions) const {
3172 bool skip = false;
3173
3174 skip |= VendorCheckEnabled(kBPVendorArm) &&
3175 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
3176 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
3177 "This is a very slow and extremely bandwidth intensive path. "
3178 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3179 VendorSpecificTag(kBPVendorArm));
3180
3181 return skip;
3182}
3183
Jeff Leger178b1e52020-10-05 12:22:23 -04003184bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3185 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
3186 bool skip = false;
3187
3188 skip |= VendorCheckEnabled(kBPVendorArm) &&
3189 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
3190 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
3191 "This is a very slow and extremely bandwidth intensive path. "
3192 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3193 VendorSpecificTag(kBPVendorArm));
3194
3195 return skip;
3196}
3197
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003198bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3199 const VkResolveImageInfo2* pResolveImageInfo) const {
3200 bool skip = false;
3201
3202 skip |= VendorCheckEnabled(kBPVendorArm) &&
3203 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage,
3204 "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. "
3205 "This is a very slow and extremely bandwidth intensive path. "
3206 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3207 VendorSpecificTag(kBPVendorArm));
3208
3209 return skip;
3210}
3211
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003212void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3213 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3214 const VkImageResolve* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003215 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003216 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003217 auto src = Get<bp_state::Image>(srcImage);
3218 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003219
3220 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003221 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
3222 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003223 }
3224}
3225
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003226void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3227 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003228 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003229 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003230 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3231 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003232 uint32_t regionCount = pResolveImageInfo->regionCount;
3233
3234 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003235 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
3236 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003237 }
3238}
3239
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003240void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer,
3241 const VkResolveImageInfo2* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003242 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003243 auto& funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003244 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3245 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003246 uint32_t regionCount = pResolveImageInfo->regionCount;
3247
3248 for (uint32_t i = 0; i < regionCount; i++) {
3249 QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ,
3250 pResolveImageInfo->pRegions[i].srcSubresource);
3251 QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE,
3252 pResolveImageInfo->pRegions[i].dstSubresource);
3253 }
3254}
3255
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003256void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3257 const VkClearColorValue* pColor, uint32_t rangeCount,
3258 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003259 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003260 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003261 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003262
3263 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003264 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003265 }
3266}
3267
3268void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3269 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3270 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003271 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003272 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003273 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003274
3275 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003276 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003277 }
3278}
3279
3280void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3281 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3282 const VkImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003283 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003284 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003285 auto src = Get<bp_state::Image>(srcImage);
3286 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003287
3288 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003289 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
3290 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003291 }
3292}
3293
3294void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
3295 VkImageLayout dstImageLayout, uint32_t regionCount,
3296 const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003297 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003298 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003299 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003300
3301 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003302 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003303 }
3304}
3305
3306void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3307 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003308 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003309 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003310 auto src = Get<bp_state::Image>(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003311
3312 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003313 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003314 }
3315}
3316
3317void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3318 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3319 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003320 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003321 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003322 auto src = Get<bp_state::Image>(srcImage);
3323 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003324
3325 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003326 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
3327 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003328 }
3329}
3330
Attilio Provenzano02859b22020-02-27 14:17:28 +00003331bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
3332 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
3333 bool skip = false;
3334
3335 if (VendorCheckEnabled(kBPVendorArm)) {
3336 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
3337 skip |= LogPerformanceWarning(
3338 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
3339 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
3340 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
3341 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003342 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003343 }
3344
3345 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
3346 skip |= LogPerformanceWarning(
3347 device, kVUID_BestPractices_CreateSampler_LodClamping,
3348 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
3349 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
3350 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
3351 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
3352 }
3353
3354 if (pCreateInfo->mipLodBias != 0.0f) {
3355 skip |=
3356 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
3357 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
3358 "descriptors being created and may cause reduced performance.",
3359 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
3360 }
3361
3362 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3363 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3364 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
3365 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
3366 skip |= LogPerformanceWarning(
3367 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
3368 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
3369 "This will lead to less efficient descriptors being created and may cause reduced performance. "
3370 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
3371 VendorSpecificTag(kBPVendorArm));
3372 }
3373
3374 if (pCreateInfo->unnormalizedCoordinates) {
3375 skip |= LogPerformanceWarning(
3376 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
3377 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
3378 "descriptors being created and may cause reduced performance.",
3379 VendorSpecificTag(kBPVendorArm));
3380 }
3381
3382 if (pCreateInfo->anisotropyEnable) {
3383 skip |= LogPerformanceWarning(
3384 device, kVUID_BestPractices_CreateSampler_Anisotropy,
3385 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
3386 "and may cause reduced performance.",
3387 VendorSpecificTag(kBPVendorArm));
3388 }
3389 }
3390
3391 return skip;
3392}
Sam Walls8e77e4f2020-03-16 20:47:40 +00003393
Nadav Gevaf0808442021-05-21 13:51:25 -04003394void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
3395 const VkGraphicsPipelineCreateInfo* pCreateInfos,
3396 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
3397 void* cgpl_state) {
3398 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
3399 pPipelines);
3400 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003401 num_pso_ += createInfoCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003402}
3403
3404bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
3405 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
3406 const VkCopyDescriptorSet* pDescriptorCopies) const {
3407 bool skip = false;
3408 if (VendorCheckEnabled(kBPVendorAMD)) {
3409 if (descriptorCopyCount > 0) {
3410 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
3411 "%s Performance warning: copying descriptor sets is not recommended",
3412 VendorSpecificTag(kBPVendorAMD));
3413 }
3414 }
3415
3416 return skip;
3417}
3418
3419bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
3420 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
3421 const VkAllocationCallbacks* pAllocator,
3422 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
3423 bool skip = false;
3424 if (VendorCheckEnabled(kBPVendorAMD)) {
3425 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
3426 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
3427 "vkUpdateDescriptorSet instead",
3428 VendorSpecificTag(kBPVendorAMD));
3429 }
3430
3431 return skip;
3432}
3433
3434bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3435 const VkClearColorValue* pColor, uint32_t rangeCount,
3436 const VkImageSubresourceRange* pRanges) const {
3437 bool skip = false;
3438 if (VendorCheckEnabled(kBPVendorAMD)) {
sfricke-samsungef15e482022-01-26 11:32:49 -08003439 skip |= LogPerformanceWarning(
3440 device, kVUID_BestPractices_ClearAttachment_ClearImage,
Nadav Gevaf0808442021-05-21 13:51:25 -04003441 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3442 "vkCmdClearAttachments instead",
3443 VendorSpecificTag(kBPVendorAMD));
3444 }
3445
3446 return skip;
3447}
3448
3449bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
3450 VkImageLayout imageLayout,
3451 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3452 const VkImageSubresourceRange* pRanges) const {
3453 bool skip = false;
3454 if (VendorCheckEnabled(kBPVendorAMD)) {
3455 skip |= LogPerformanceWarning(
3456 device, kVUID_BestPractices_ClearAttachment_ClearImage,
3457 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3458 "vkCmdClearAttachments instead",
3459 VendorSpecificTag(kBPVendorAMD));
3460 }
3461
3462 return skip;
3463}
3464
3465bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
3466 const VkAllocationCallbacks* pAllocator,
3467 VkPipelineLayout* pPipelineLayout) const {
3468 bool skip = false;
3469 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003470 uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2;
Nadav Gevaf0808442021-05-21 13:51:25 -04003471 // Descriptor sets cost 1 DWORD each.
3472 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
3473 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
3474 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
3475 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
3476 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003477 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003478 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size;
Nadav Gevaf0808442021-05-21 13:51:25 -04003479 }
3480
3481 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
3482 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
3483 }
3484
3485 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
3486 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
3487 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
3488 "Descriptor sets cost 1 DWORD each. "
3489 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
3490 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
3491 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
3492 VendorSpecificTag(kBPVendorAMD));
3493 }
3494 }
3495
3496 return skip;
3497}
3498
3499bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3500 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3501 const VkImageCopy* pRegions) const {
3502 bool skip = false;
3503 std::stringstream src_image_hex;
3504 std::stringstream dst_image_hex;
3505 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
3506 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
3507
3508 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003509 auto src_state = Get<IMAGE_STATE>(srcImage);
3510 auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04003511
3512 if (src_state && dst_state) {
3513 VkImageTiling src_Tiling = src_state->createInfo.tiling;
3514 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
3515 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
3516 skip |=
3517 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
3518 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
3519 "image (vkCmdCopyImageToBuffer) "
3520 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
3521 "copies when converting between linear and optimal images",
3522 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
3523 }
3524 }
3525 }
3526
3527 return skip;
3528}
3529
3530bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
3531 VkPipeline pipeline) const {
3532 bool skip = false;
3533
3534 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003535 if (IsPipelineUsedInFrame(pipeline)) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003536 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
3537 "%s Performance warning: Pipeline %s was bound twice in the frame. Keep pipeline state changes to a minimum,"
3538 "for example, by sorting draw calls by pipeline.",
3539 VendorSpecificTag(kBPVendorAMD), report_data->FormatHandle(pipeline).c_str());
3540 }
3541 }
3542
3543 return skip;
3544}
3545
3546void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
3547 VkFence fence, VkResult result) {
3548 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003549 num_queue_submissions_ += submitCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003550}
3551
3552bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
3553 bool skip = false;
3554
3555 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003556 auto num = num_queue_submissions_.load();
3557 if (num > kNumberOfSubmissionWarningLimitAMD) {
3558 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
3559 "%s Performance warning: command buffers submitted %" PRId32
3560 " times this frame. Submitting command buffers has a CPU "
3561 "and GPU overhead. Submit fewer times to incur less overhead.",
3562 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04003563 }
3564 }
3565
3566 return skip;
3567}
3568
3569void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
3570 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
3571 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
3572 uint32_t bufferMemoryBarrierCount,
3573 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
3574 uint32_t imageMemoryBarrierCount,
3575 const VkImageMemoryBarrier* pImageMemoryBarriers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003576 num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount);
Nadav Gevaf0808442021-05-21 13:51:25 -04003577}
3578
3579bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3580 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
3581 bool skip = false;
3582 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003583 if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003584 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
3585 "%s Performance warning: High number of vkSemaphore objects created."
3586 "Minimize the amount of queue synchronization that is used. "
3587 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
3588 VendorSpecificTag(kBPVendorAMD));
3589 }
3590 }
3591
3592 return skip;
3593}
3594
3595bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3596 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
3597 bool skip = false;
3598 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003599 if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003600 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
3601 "%s Performance warning: High number of VkFence objects created."
3602 "Minimize the amount of CPU-GPU synchronization that is used. "
3603 "Semaphores and fences have overhead.Each fence has a CPU and GPU cost with it.",
3604 VendorSpecificTag(kBPVendorAMD));
3605 }
3606 }
3607
3608 return skip;
3609}
3610
Sam Walls8e77e4f2020-03-16 20:47:40 +00003611void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
3612
3613bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
3614 // look for a cache hit
3615 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
3616 if (hit != _entries.end()) {
3617 // mark the cache hit as being most recently used
3618 hit->age = iteration++;
3619 return true;
3620 }
3621
3622 // if there's no cache hit, we need to model the entry being inserted into the cache
3623 CacheEntry new_entry = {value, iteration};
3624 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
3625 // if there is still space left in the cache, use the next available slot
3626 *(_entries.begin() + iteration) = new_entry;
3627 } else {
3628 // otherwise replace the least recently used cache entry
3629 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
3630 *lru = new_entry;
3631 }
3632 iteration++;
3633 return false;
3634}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003635
3636bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
3637 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003638 auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003639 bool skip = false;
3640 if (swapchain_data && swapchain_data->images.size() == 0) {
3641 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
3642 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
3643 "vkGetSwapchainImagesKHR after swapchain creation.");
3644 }
3645 return skip;
3646}
3647
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003648void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
3649 if (no_pointer) {
3650 if (UNCALLED == call_state) {
3651 call_state = QUERY_COUNT;
3652 }
3653 } else { // Save queue family properties
3654 call_state = QUERY_DETAILS;
3655 }
3656}
3657
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003658void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3659 uint32_t* pQueueFamilyPropertyCount,
3660 VkQueueFamilyProperties* pQueueFamilyProperties) {
3661 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
3662 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003663 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003664 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003665 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3666 nullptr == pQueueFamilyProperties);
3667 }
3668}
3669
3670void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3671 uint32_t* pQueueFamilyPropertyCount,
3672 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3673 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
3674 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003675 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003676 if (bp_pd_state) {
3677 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3678 nullptr == pQueueFamilyProperties);
3679 }
3680}
3681
3682void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
3683 uint32_t* pQueueFamilyPropertyCount,
3684 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3685 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
3686 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003687 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003688 if (bp_pd_state) {
3689 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3690 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003691 }
3692}
3693
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003694void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
3695 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003696 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003697 if (bp_pd_state) {
3698 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3699 }
3700}
3701
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003702void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
3703 VkPhysicalDeviceFeatures2* pFeatures) {
3704 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003705 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003706 if (bp_pd_state) {
3707 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3708 }
3709}
3710
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003711void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
3712 VkPhysicalDeviceFeatures2* pFeatures) {
3713 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003714 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003715 if (bp_pd_state) {
3716 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3717 }
3718}
3719
3720void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
3721 VkSurfaceKHR surface,
3722 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
3723 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003724 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003725 if (bp_pd_state) {
3726 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3727 }
3728}
3729
3730void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
3731 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3732 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003733 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003734 if (bp_pd_state) {
3735 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3736 }
3737}
3738
3739void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
3740 VkSurfaceKHR surface,
3741 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
3742 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003743 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003744 if (bp_pd_state) {
3745 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3746 }
3747}
3748
3749void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
3750 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
3751 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003752 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003753 if (bp_pd_data) {
3754 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
3755
3756 if (*pPresentModeCount) {
3757 if (call_state < QUERY_COUNT) {
3758 call_state = QUERY_COUNT;
3759 }
3760 }
3761 if (pPresentModes) {
3762 if (call_state < QUERY_DETAILS) {
3763 call_state = QUERY_DETAILS;
3764 }
3765 }
3766 }
3767}
3768
3769void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
3770 uint32_t* pSurfaceFormatCount,
3771 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003772 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003773 if (bp_pd_data) {
3774 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
3775
3776 if (*pSurfaceFormatCount) {
3777 if (call_state < QUERY_COUNT) {
3778 call_state = QUERY_COUNT;
3779 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003780 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003781 }
3782 if (pSurfaceFormats) {
3783 if (call_state < QUERY_DETAILS) {
3784 call_state = QUERY_DETAILS;
3785 }
3786 }
3787 }
3788}
3789
3790void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
3791 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3792 uint32_t* pSurfaceFormatCount,
3793 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003794 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003795 if (bp_pd_data) {
3796 if (*pSurfaceFormatCount) {
3797 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
3798 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
3799 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003800 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003801 }
3802 if (pSurfaceFormats) {
3803 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
3804 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
3805 }
3806 }
3807 }
3808}
3809
3810void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
3811 uint32_t* pPropertyCount,
3812 VkDisplayPlanePropertiesKHR* pProperties,
3813 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003814 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003815 if (bp_pd_data) {
3816 if (*pPropertyCount) {
3817 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
3818 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
3819 }
3820 }
3821 if (pProperties) {
3822 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
3823 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
3824 }
3825 }
3826 }
3827}
3828
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003829void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
3830 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
3831 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003832 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Nathaniel Cesario39152e62021-07-02 13:04:16 -06003833 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
3834 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
3835 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003836 }
3837 }
3838}
3839
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003840void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
3841 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
3842
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003843 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003844 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003845 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003846 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003847 auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003848 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07003849 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003850 }
3851 }
3852 }
3853}