blob: a89b4d312046d0b69850568a0075b294407d1602 [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
LawG4db16f802022-03-21 17:33:39 +0000343 if (VendorCheckEnabled(kBPVendorIMG) && (pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG ||
344 pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG ||
345 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG ||
346 pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG ||
347 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG ||
348 pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG ||
349 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG ||
350 pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG)) {
351 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Texture_Format_PVRTC_Outdated,
352 "%s vkCreateImage(): Trying to create an image with a PVRTC format. Both PVRTC1 and PVRTC2 "
353 "are slower than standard image formats on PowerVR GPUs, prefer ETC, BC, ASTC, etc.",
354 VendorSpecificTag(kBPVendorIMG));
355 }
356
Nadav Gevaf0808442021-05-21 13:51:25 -0400357 if (VendorCheckEnabled(kBPVendorAMD)) {
358 std::stringstream image_hex;
359 image_hex << "0x" << std::hex << HandleToUint64(pImage);
360
361 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
362 (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) {
363 skip |= LogPerformanceWarning(device,
364 kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets,
365 "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. "
366 "Using a SHARING_MODE_CONCURRENT "
367 "is not recommended with color and depth targets",
368 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
369 }
370
371 if ((pCreateInfo->usage &
372 (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
373 (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
374 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets,
375 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. "
376 "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets",
377 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
378 }
379
380 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
381 (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
382 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets,
383 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a "
384 "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets",
385 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
386 }
387 }
388
Camden5b184be2019-08-13 07:50:19 -0600389 return skip;
390}
391
392bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500393 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600394 bool skip = false;
395
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600396 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600397 if (bp_pd_state) {
398 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
399 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
400 "vkCreateSwapchainKHR() called before getting surface capabilities from "
401 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
402 }
Camden83a9c372019-08-14 11:41:38 -0600403
Shannon McPherson73e58c82021-03-05 17:14:26 -0700404 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
405 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600406 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
407 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
408 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
409 }
Camden83a9c372019-08-14 11:41:38 -0600410
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600411 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
412 skip |= LogWarning(
413 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
414 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
415 }
Camden83a9c372019-08-14 11:41:38 -0600416 }
417
Camden5b184be2019-08-13 07:50:19 -0600418 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700419 skip |=
420 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600421 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700422 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
423 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600424 }
425
ziga-lunarg79beba62022-03-30 01:17:30 +0200426 const auto present_mode = pCreateInfo->presentMode;
427 if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) &&
428 (pCreateInfo->minImageCount == 2)) {
Szilard Papp48a6da32020-06-10 14:41:59 +0100429 skip |= LogPerformanceWarning(
430 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
431 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
432 ", which means double buffering is going "
433 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
434 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
435 "3 to use triple buffering to maximize performance in such cases.",
436 pCreateInfo->minImageCount);
437 }
438
Szilard Pappd5f0f812020-06-22 09:01:29 +0100439 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
440 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
441 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
442 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
443 "Presentation modes which are not FIFO will present the latest available frame and discard other "
444 "frame(s) if any.",
445 VendorSpecificTag(kBPVendorArm));
446 }
447
Camden5b184be2019-08-13 07:50:19 -0600448 return skip;
449}
450
451bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
452 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500453 const VkAllocationCallbacks* pAllocator,
454 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600455 bool skip = false;
456
457 for (uint32_t i = 0; i < swapchainCount; i++) {
458 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700459 skip |= LogWarning(
460 device, kVUID_BestPractices_SharingModeExclusive,
461 "Warning: A shared swapchain (index %" PRIu32
462 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
463 "queues (queueFamilyIndexCount of %" PRIu32 ").",
464 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600465 }
466 }
467
468 return skip;
469}
470
471bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500472 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600473 bool skip = false;
474
475 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
476 VkFormat format = pCreateInfo->pAttachments[i].format;
477 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
478 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
479 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700480 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
481 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
482 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
483 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
484 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600485 }
486 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700487 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
488 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
489 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
490 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
491 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600492 }
493 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000494
495 const auto& attachment = pCreateInfo->pAttachments[i];
496 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
497 bool access_requires_memory =
498 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
499
500 if (FormatHasStencil(format)) {
501 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
502 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
503 }
504
505 if (access_requires_memory) {
506 skip |= LogPerformanceWarning(
507 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
508 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
509 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
510 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
511 i, static_cast<uint32_t>(attachment.samples));
512 }
513 }
Camden5b184be2019-08-13 07:50:19 -0600514 }
515
516 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
517 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
518 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
519 }
520
521 return skip;
522}
523
Tony-LunarG767180f2020-04-23 14:03:59 -0600524bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
525 const VkImageView* image_views) const {
526 bool skip = false;
527
528 // Check for non-transient attachments that should be transient and vice versa
529 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200530 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600531 bool attachment_should_be_transient =
532 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
533
534 if (FormatHasStencil(attachment.format)) {
535 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
536 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
537 }
538
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600539 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600540 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600541 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600542
543 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
544
545 // The check for an image that should not be transient applies to all GPUs
546 if (!attachment_should_be_transient && image_is_transient) {
547 skip |= LogPerformanceWarning(
548 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
549 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
550 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
551 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
552 i);
553 }
554
555 bool supports_lazy = false;
556 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
557 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
558 supports_lazy = true;
559 }
560 }
561
562 // The check for an image that should be transient only applies to GPUs supporting
563 // lazily allocated memory
564 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
565 skip |= LogPerformanceWarning(
566 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
567 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
568 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
569 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
570 i);
571 }
572 }
573 }
574 return skip;
575}
576
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000577bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
578 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
579 bool skip = false;
580
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600581 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800582 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600583 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000584 }
585
586 return skip;
587}
588
Sam Wallse746d522020-03-16 21:20:23 +0000589bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
590 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
591 bool skip = false;
592 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
593
594 if (!skip) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700595 const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000596 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
597 // this warning is specific to Arm
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700598 if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) {
Sam Wallse746d522020-03-16 21:20:23 +0000599 skip |= LogPerformanceWarning(
600 device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse,
601 "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the "
602 "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.",
603 VendorSpecificTag(kBPVendorArm));
604 }
ziga-lunarg5a76c442022-04-17 18:04:08 +0200605
606 if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) {
607 // Track number of descriptorSets allowable in this pool
608 if (pool_state->GetAvailableSets() < pAllocateInfo->descriptorSetCount) {
609 skip |= LogWarning(pool_state->Handle(), kVUID_BestPractices_EmptyDescriptorPool,
610 "vkAllocateDescriptorSets(): Unable to allocate %" PRIu32 " descriptorSets from %s"
611 ". This pool only has %" PRIu32 " descriptorSets remaining.",
612 pAllocateInfo->descriptorSetCount, report_data->FormatHandle(pool_state->Handle()).c_str(),
613 pool_state->GetAvailableSets());
614 }
615 }
Sam Wallse746d522020-03-16 21:20:23 +0000616 }
617
618 return skip;
619}
620
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600621void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
622 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000623 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700624 auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool);
625 if (pool_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000626 // we record successful allocations by subtracting the allocation count from the last recorded free count
627 const auto alloc_count = pAllocateInfo->descriptorSetCount;
628 // clamp the unsigned subtraction to the range [0, last_free_count]
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700629 if (pool_state->freed_count > alloc_count) {
630 pool_state->freed_count -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700631 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700632 pool_state->freed_count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700633 }
Sam Wallse746d522020-03-16 21:20:23 +0000634 }
635 }
636}
637
638void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
639 const VkDescriptorSet* pDescriptorSets, VkResult result) {
640 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
641 if (result == VK_SUCCESS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700642 auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool);
Sam Wallse746d522020-03-16 21:20:23 +0000643 // we want to track frees because we're interested in suggesting re-use
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700644 if (pool_state) {
645 pool_state->freed_count += descriptorSetCount;
Sam Wallse746d522020-03-16 21:20:23 +0000646 }
647 }
648}
649
Camden5b184be2019-08-13 07:50:19 -0600650bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500651 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600652 bool skip = false;
653
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700654 if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700655 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
656 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600657 }
658
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000659 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
660 skip |= LogPerformanceWarning(
661 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600662 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
663 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000664 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
665 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
666 }
667
Camden83a9c372019-08-14 11:41:38 -0600668 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
669
670 return skip;
671}
672
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600673void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
674 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
675 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700676 if (result != VK_SUCCESS) {
677 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
678 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800679 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700680 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600681 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700682 return;
683 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700684}
Camden Stocker9738af92019-10-16 13:54:03 -0700685
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600686void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
687 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700688 auto error = std::find(error_codes.begin(), error_codes.end(), result);
689 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000690 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
691 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
692
693 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
694 if (common_failure != common_failure_codes.end()) {
695 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
696 } else {
697 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
698 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700699 return;
700 }
701 auto success = std::find(success_codes.begin(), success_codes.end(), result);
702 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600703 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
704 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500705 }
706}
707
Jeff Bolz5c801d12019-10-09 10:38:45 -0500708bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
709 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700710 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600711 bool skip = false;
712
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700713 auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600714
Jeremy Gebben610d3a62022-01-01 12:53:17 -0700715 for (const auto& item : mem_info->ObjectBindings()) {
716 const auto& obj = item.first;
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600717 LogObjectList objlist(device);
718 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600719 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600720 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 -0600721 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600722 }
723
Camden5b184be2019-08-13 07:50:19 -0600724 return skip;
725}
726
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000727bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600728 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700729 auto buffer_state = Get<BUFFER_STATE>(buffer);
Camden Stockerb603cc82019-09-03 10:09:02 -0600730
sfricke-samsunge2441192019-11-06 14:07:57 -0800731 if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700732 skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled,
733 "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.",
734 api_name, report_data->FormatHandle(buffer).c_str());
Camden Stockerb603cc82019-09-03 10:09:02 -0600735 }
736
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700737 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000738
AndreyVK_D3D0416a332021-11-02 23:22:28 +0300739 if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000740 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
741 skip |= LogPerformanceWarning(
742 device, kVUID_BestPractices_SmallDedicatedAllocation,
743 "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600744 "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from "
745 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000746 api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
747 }
748
Camden Stockerb603cc82019-09-03 10:09:02 -0600749 return skip;
750}
751
752bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500753 VkDeviceSize memoryOffset) const {
Camden Stockerb603cc82019-09-03 10:09:02 -0600754 bool skip = false;
755 const char* api_name = "BindBufferMemory()";
756
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000757 skip |= ValidateBindBufferMemory(buffer, memory, api_name);
Camden Stockerb603cc82019-09-03 10:09:02 -0600758
759 return skip;
760}
761
762bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500763 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600764 char api_name[64];
765 bool skip = false;
766
767 for (uint32_t i = 0; i < bindInfoCount; i++) {
768 sprintf(api_name, "vkBindBufferMemory2() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000769 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600770 }
771
772 return skip;
773}
Camden Stockerb603cc82019-09-03 10:09:02 -0600774
775bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500776 const VkBindBufferMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600777 char api_name[64];
778 bool skip = false;
Camden Stockerb603cc82019-09-03 10:09:02 -0600779
Camden Stocker8b798ab2019-09-03 10:33:28 -0600780 for (uint32_t i = 0; i < bindInfoCount; i++) {
781 sprintf(api_name, "vkBindBufferMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000782 skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600783 }
784
785 return skip;
786}
787
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000788bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600789 bool skip = false;
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700790 auto image_state = Get<IMAGE_STATE>(image);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600791
sfricke-samsung71bc6572020-04-29 15:49:43 -0700792 if (image_state->disjoint == false) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600793 if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) {
sfricke-samsungd7ea5de2020-04-08 09:19:18 -0700794 skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled,
795 "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.",
796 api_name, report_data->FormatHandle(image).c_str());
797 }
798 } else {
799 // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each
800 // plane.
Camden Stocker8b798ab2019-09-03 10:33:28 -0600801 }
802
Jeremy Gebbenf4449392022-01-28 10:09:10 -0700803 auto mem_state = Get<DEVICE_MEMORY_STATE>(memory);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000804
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600805 if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size &&
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000806 mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) {
807 skip |= LogPerformanceWarning(
808 device, kVUID_BestPractices_SmallDedicatedAllocation,
809 "%s: Trying to bind %s to a memory block which is fully consumed by the image. "
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600810 "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from "
811 "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)",
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000812 api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize);
813 }
814
815 // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation,
816 // make sure this type is actually used.
817 // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT
818 // (i.e.most tile - based renderers)
819 if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) {
820 bool supports_lazy = false;
821 uint32_t suggested_type = 0;
822
823 for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) {
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600824 if ((1u << i) & image_state->requirements[0].memoryTypeBits) {
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000825 if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
826 supports_lazy = true;
827 suggested_type = i;
828 break;
829 }
830 }
831 }
832
833 uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags;
834
835 if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) {
836 skip |= LogPerformanceWarning(
837 device, kVUID_BestPractices_NonLazyTransientImage,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600838 "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT,"
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000839 "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 -0600840 "%" PRIu64 " bytes of physical memory.",
Jeremy Gebben6fbf8242021-06-21 09:14:46 -0600841 api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000842 }
843 }
844
Camden Stocker8b798ab2019-09-03 10:33:28 -0600845 return skip;
846}
847
848bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500849 VkDeviceSize memoryOffset) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600850 bool skip = false;
851 const char* api_name = "vkBindImageMemory()";
852
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000853 skip |= ValidateBindImageMemory(image, memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600854
855 return skip;
856}
857
858bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500859 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600860 char api_name[64];
861 bool skip = false;
862
863 for (uint32_t i = 0; i < bindInfoCount; i++) {
864 sprintf(api_name, "vkBindImageMemory2() pBindInfos[%u]", i);
Mark Lobodzinski1f887d32020-12-30 15:31:33 -0700865 if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) {
Tony-LunarG5e60b852020-04-27 11:27:54 -0600866 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
867 }
Camden Stocker8b798ab2019-09-03 10:33:28 -0600868 }
869
870 return skip;
871}
872
873bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500874 const VkBindImageMemoryInfo* pBindInfos) const {
Camden Stocker8b798ab2019-09-03 10:33:28 -0600875 char api_name[64];
876 bool skip = false;
877
878 for (uint32_t i = 0; i < bindInfoCount; i++) {
879 sprintf(api_name, "vkBindImageMemory2KHR() pBindInfos[%u]", i);
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000880 skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name);
Camden Stocker8b798ab2019-09-03 10:33:28 -0600881 }
882
883 return skip;
884}
Camden83a9c372019-08-14 11:41:38 -0600885
Attilio Provenzano02859b22020-02-27 14:17:28 +0000886static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) {
887 switch (format) {
888 case VK_FORMAT_B10G11R11_UFLOAT_PACK32:
889 case VK_FORMAT_R16_SFLOAT:
890 case VK_FORMAT_R16G16_SFLOAT:
891 case VK_FORMAT_R16G16B16_SFLOAT:
892 case VK_FORMAT_R16G16B16A16_SFLOAT:
893 case VK_FORMAT_R32_SFLOAT:
894 case VK_FORMAT_R32G32_SFLOAT:
895 case VK_FORMAT_R32G32B32_SFLOAT:
896 case VK_FORMAT_R32G32B32A32_SFLOAT:
897 return false;
898
899 default:
900 return true;
901 }
902}
903
904bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount,
905 const VkGraphicsPipelineCreateInfo* pCreateInfos) const {
906 bool skip = false;
907
908 for (uint32_t i = 0; i < createInfoCount; i++) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700909 auto create_info = &pCreateInfos[i];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000910
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700911 if (!create_info->pColorBlendState || !create_info->pMultisampleState ||
912 create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT ||
913 create_info->pMultisampleState->sampleShadingEnable) {
Attilio Provenzano02859b22020-02-27 14:17:28 +0000914 return skip;
915 }
916
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600917 auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass);
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200918 const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000919
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +0200920 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
921 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount);
922
923 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200924 const auto& blend_att = create_info->pColorBlendState->pAttachments[j];
Attilio Provenzano02859b22020-02-27 14:17:28 +0000925 uint32_t att = subpass.pColorAttachments[j].attachment;
926
927 if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) {
928 if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) {
929 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending,
930 "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and "
931 "color attachment #%u makes use "
932 "of a format which cannot be blended at full throughput when using MSAA.",
933 VendorSpecificTag(kBPVendorArm), i, j);
934 }
935 }
936 }
937 }
938
939 return skip;
940}
941
Nadav Gevaf0808442021-05-21 13:51:25 -0400942void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
943 const VkComputePipelineCreateInfo* pCreateInfos,
944 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
945 VkResult result, void* pipe_state) {
946 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -0700947 pipeline_cache_ = pipelineCache;
Nadav Gevaf0808442021-05-21 13:51:25 -0400948}
949
Camden5b184be2019-08-13 07:50:19 -0600950bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
951 const VkGraphicsPipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -0600952 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500953 void* cgpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -0600954 bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos,
955 pAllocator, pPipelines, cgpl_state_data);
ziga-lunarg08c81582022-03-08 17:33:45 +0100956 if (skip) {
957 return skip;
958 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600959 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600960
961 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700962 skip |= LogPerformanceWarning(
963 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
964 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
965 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600966 }
967
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000968 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200969 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000970
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600971 if (!(cgpl_state->pipe_state[i]->active_shaders & VK_SHADER_STAGE_MESH_BIT_NV)) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200972 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600973 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700974 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
975 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600976 count++;
977 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000978 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600979 if (count > kMaxInstancedVertexBuffers) {
980 skip |= LogPerformanceWarning(
981 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
982 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
983 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
984 count, kMaxInstancedVertexBuffers);
985 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000986 }
Attilio Provenzano02859b22020-02-27 14:17:28 +0000987
Szilard Pappaaf2da32020-06-22 10:37:35 +0100988 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
989 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +0200990 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
991 VendorCheckEnabled(kBPVendorArm)) {
992 skip |= LogPerformanceWarning(
993 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
994 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
995 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
996 "efficiency during rasterization. Consider disabling depthBias or increasing either "
997 "depthBiasConstantFactor or depthBiasSlopeFactor.",
998 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +0100999 }
1000
Attilio Provenzano02859b22020-02-27 14:17:28 +00001001 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001002 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001003 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001004 auto prev_pipeline = pipeline_cache_.load();
1005 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001006 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
1007 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
1008 "improve cache hit rate", VendorSpecificTag(kBPVendorAMD));
1009 }
1010
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001011 if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001012 skip |=
1013 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
1014 "%s Performance warning: Too many pipelines created, consider consolidation",
1015 VendorSpecificTag(kBPVendorAMD));
1016 }
1017
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -06001018 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001019 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
1020 "%s Performance warning: Use of primitive restart is not recommended",
1021 VendorSpecificTag(kBPVendorAMD));
1022 }
1023
1024 // TODO: this might be too aggressive of a check
1025 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1026 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1027 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1028 VendorSpecificTag(kBPVendorAMD));
1029 }
1030 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001031
Camden5b184be2019-08-13 07:50:19 -06001032 return skip;
1033}
1034
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001035static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info,
1036 std::shared_ptr<const RENDER_PASS_STATE>& rp) {
1037 std::vector<bp_state::AttachmentInfo> result;
Tony-LunarG5e1dbcd2022-03-29 08:19:58 -06001038 if (!rp || rp->use_dynamic_rendering || rp->use_dynamic_rendering_inherited) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001039 return result;
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001040 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001041
1042 const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1043
1044 // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState
1045 // are only non-null if they are enabled.
1046 if (create_info.pColorBlendState) {
1047 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1048 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount);
1049 for (uint32_t j = 0; j < num_color_attachments; j++) {
1050 if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) {
1051 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1052 if (attachment != VK_ATTACHMENT_UNUSED) {
1053 result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT});
1054 }
1055 }
1056 }
1057 }
1058
1059 if (create_info.pDepthStencilState &&
1060 (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable ||
1061 create_info.pDepthStencilState->stencilTestEnable)) {
1062 uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED;
1063 if (attachment != VK_ATTACHMENT_UNUSED) {
1064 VkImageAspectFlags aspects = 0;
1065 if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) {
1066 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1067 }
1068 if (create_info.pDepthStencilState->stencilTestEnable) {
1069 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1070 }
1071 result.push_back({attachment, aspects});
1072 }
1073 }
1074 return result;
1075}
1076
1077bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo,
1078 std::shared_ptr<const RENDER_PASS_STATE>&& rpstate,
1079 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout)
1080 : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)),
1081 access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {}
1082
1083std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState(
1084 const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass,
1085 std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const {
1086 return std::static_pointer_cast<PIPELINE_STATE>(
1087 std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout)));
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001088}
1089
Sam Walls0961ec02020-03-31 16:39:15 +01001090void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1091 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1092 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1093 VkResult result, void* cgpl_state_data) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001094 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001095 pipeline_cache_ = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001096}
1097
Camden5b184be2019-08-13 07:50:19 -06001098bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1099 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001100 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001101 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001102 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1103 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001104
1105 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001106 skip |= LogPerformanceWarning(
1107 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1108 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1109 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001110 }
1111
Nadav Gevaf0808442021-05-21 13:51:25 -04001112 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001113 auto prev_pipeline = pipeline_cache_.load();
1114 if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) {
1115 skip |= LogPerformanceWarning(
1116 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1117 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
Nadav Gevaf0808442021-05-21 13:51:25 -04001118 "improve cache hit rate",
1119 VendorSpecificTag(kBPVendorAMD));
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001120 }
1121 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001122
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001123 for (uint32_t i = 0; i < createInfoCount; i++) {
1124 const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i];
1125 if (VendorCheckEnabled(kBPVendorArm)) {
1126 skip |= ValidateCreateComputePipelineArm(createInfo);
1127 }
sfricke-samsung86d055a2022-02-11 14:43:50 -08001128
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001129 if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) {
1130 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
1131 for (const auto& builtin : module_state->static_data_.builtin_decoration_list) {
1132 if (builtin.builtin == spv::BuiltInWorkgroupSize) {
1133 skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize,
1134 "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32
1135 "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 "
1136 "extension exposes a new LocalSizeId execution mode that should be used instead.",
1137 i);
sfricke-samsung86d055a2022-02-11 14:43:50 -08001138 }
1139 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001140 }
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001141 }
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001142
1143 return skip;
1144}
1145
1146bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1147 bool skip = false;
sfricke-samsungef15e482022-01-26 11:32:49 -08001148 auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001149 // Generate warnings about work group sizes based on active resources.
sfricke-samsungef15e482022-01-26 11:32:49 -08001150 auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
1151 if (entrypoint == module_state->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001152
1153 uint32_t x = 1, y = 1, z = 1;
sfricke-samsungef15e482022-01-26 11:32:49 -08001154 module_state->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001155
1156 uint32_t thread_count = x * y * z;
1157
1158 // Generate a priori warnings about work group sizes.
1159 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1160 skip |= LogPerformanceWarning(
1161 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1162 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1163 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1164 "groups with less than %u threads, especially when using barrier() or shared memory.",
1165 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1166 }
1167
1168 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1169 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1170 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1171 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1172 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1173 "%u, %u) is not aligned to %u "
1174 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1175 "leave threads idle on the shader "
1176 "core.",
1177 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1178 kThreadGroupDispatchCountAlignmentArm);
1179 }
1180
sfricke-samsungef15e482022-01-26 11:32:49 -08001181 auto accessible_ids = module_state->MarkAccessibleIds(entrypoint);
1182 auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001183
1184 unsigned dimensions = 0;
1185 if (x > 1) dimensions++;
1186 if (y > 1) dimensions++;
1187 if (z > 1) dimensions++;
1188 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1189 dimensions = std::max(dimensions, 1u);
1190
1191 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1192 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1193 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1194 bool accesses_2d = false;
1195 for (const auto& usage : descriptor_uses) {
sfricke-samsungef15e482022-01-26 11:32:49 -08001196 auto dim = module_state->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001197 if (dim < 0) continue;
1198 auto spvdim = spv::Dim(dim);
1199 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1200 }
1201
1202 if (accesses_2d && dimensions < 2) {
1203 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1204 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1205 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1206 "exhibiting poor spatial locality with respect to one or more shader resources.",
1207 VendorSpecificTag(kBPVendorArm), x, y, z);
1208 }
1209
Camden5b184be2019-08-13 07:50:19 -06001210 return skip;
1211}
1212
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001213bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001214 bool skip = false;
1215
1216 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001217 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1218 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001219 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001220 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1221 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001222 }
1223
1224 return skip;
1225}
1226
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001227bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1228 bool skip = false;
1229
1230 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1231 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1232 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1233 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1234 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1235 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1236 }
1237
1238 return skip;
1239}
1240
1241bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1242 bool skip = false;
1243 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1244
1245 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1246 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1247
1248 return skip;
1249}
1250
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001251void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001252 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1253 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1254 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1255 LogPerformanceWarning(
1256 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1257 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1258 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1259 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1260 "convenient opportunity.",
1261 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1262 }
1263 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001264
1265 // AMD best practice
1266 // end-of-frame cleanup
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001267 num_queue_submissions_ = 0;
1268 num_barriers_objects_ = 0;
1269 ClearPipelinesUsedInFrame();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001270}
1271
Jeff Bolz5c801d12019-10-09 10:38:45 -05001272bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1273 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001274 bool skip = false;
1275
1276 for (uint32_t submit = 0; submit < submitCount; submit++) {
1277 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1278 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1279 }
1280 }
1281
1282 return skip;
1283}
1284
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001285bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1286 VkFence fence) const {
1287 bool skip = false;
1288
1289 for (uint32_t submit = 0; submit < submitCount; submit++) {
1290 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1291 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1292 }
1293 }
1294
1295 return skip;
1296}
1297
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001298bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits,
1299 VkFence fence) const {
1300 bool skip = false;
1301
1302 for (uint32_t submit = 0; submit < submitCount; submit++) {
1303 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1304 skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1305 }
1306 }
1307
1308 return skip;
1309}
1310
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001311bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1312 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1313 bool skip = false;
1314
1315 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1316 skip |= LogPerformanceWarning(
1317 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1318 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1319 "pool instead.");
1320 }
1321
1322 return skip;
1323}
1324
1325bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1326 const VkCommandBufferBeginInfo* pBeginInfo) const {
1327 bool skip = false;
1328
1329 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1330 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1331 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1332 }
1333
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001334 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1335 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001336 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1337 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1338 VendorSpecificTag(kBPVendorArm));
1339 }
1340
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001341 return skip;
1342}
1343
Jeff Bolz5c801d12019-10-09 10:38:45 -05001344bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001345 bool skip = false;
1346
1347 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1348
1349 return skip;
1350}
1351
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001352bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1353 const VkDependencyInfoKHR* pDependencyInfo) const {
1354 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1355}
1356
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001357bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1358 const VkDependencyInfo* pDependencyInfo) const {
1359 return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo);
1360}
1361
Jeff Bolz5c801d12019-10-09 10:38:45 -05001362bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1363 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001364 bool skip = false;
1365
1366 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1367
1368 return skip;
1369}
1370
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001371bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1372 VkPipelineStageFlags2KHR stageMask) const {
1373 bool skip = false;
1374
1375 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1376
1377 return skip;
1378}
1379
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001380bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event,
1381 VkPipelineStageFlags2 stageMask) const {
1382 bool skip = false;
1383
1384 skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask);
1385
1386 return skip;
1387}
1388
Camden5b184be2019-08-13 07:50:19 -06001389bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1390 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1391 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1392 uint32_t bufferMemoryBarrierCount,
1393 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1394 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001395 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001396 bool skip = false;
1397
1398 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1399 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1400
1401 return skip;
1402}
1403
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001404bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1405 const VkDependencyInfoKHR* pDependencyInfos) const {
1406 bool skip = false;
1407 for (uint32_t i = 0; i < eventCount; i++) {
1408 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1409 }
1410
1411 return skip;
1412}
1413
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001414bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1415 const VkDependencyInfo* pDependencyInfos) const {
1416 bool skip = false;
1417 for (uint32_t i = 0; i < eventCount; i++) {
1418 skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]);
1419 }
1420
1421 return skip;
1422}
1423
Camden5b184be2019-08-13 07:50:19 -06001424bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1425 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1426 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1427 uint32_t bufferMemoryBarrierCount,
1428 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1429 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001430 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001431 bool skip = false;
1432
1433 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1434 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1435
ziga-lunargb65dbfb2022-03-19 18:45:09 +01001436 for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) {
1437 if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED &&
1438 IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) {
1439 skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly,
1440 "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents "
1441 "may be discarded, but the newLayout is %s, which is read only.",
1442 string_VkImageLayout(pImageMemoryBarriers[i].newLayout));
1443 }
1444 }
1445
Nadav Gevaf0808442021-05-21 13:51:25 -04001446 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001447 auto num = num_barriers_objects_.load();
1448 if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001449 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001450 "%s Performance warning: In this frame, %" PRIu32
1451 " barriers were already submitted. Barriers have a high cost and can "
1452 "stall the GPU. "
1453 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1454 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04001455 }
1456
1457 std::array<VkImageLayout, 3> read_layouts = {
1458 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1459 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1460 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1461 };
1462
1463 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1464 // read to read barriers
1465 auto found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].oldLayout);
1466 bool old_is_read_layout = found != read_layouts.end();
1467 found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].newLayout);
1468 bool new_is_read_layout = found != read_layouts.end();
1469 if (old_is_read_layout && new_is_read_layout) {
1470 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
1471 "%s Performance warning: Don't issue read-to-read barriers. Get the resource in the right state the first "
1472 "time you use it.",
1473 VendorSpecificTag(kBPVendorAMD));
1474 }
1475
1476 // general with no storage
1477 if (pImageMemoryBarriers[i].newLayout == VK_IMAGE_LAYOUT_GENERAL) {
1478 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1479 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1480 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1481 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1482 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1483 VendorSpecificTag(kBPVendorAMD));
1484 }
1485 }
1486 }
1487 }
1488
Camden5b184be2019-08-13 07:50:19 -06001489 return skip;
1490}
1491
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001492bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1493 const VkDependencyInfoKHR* pDependencyInfo) const {
1494 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1495}
1496
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001497bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer,
1498 const VkDependencyInfo* pDependencyInfo) const {
1499 return CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo);
1500}
1501
Camden5b184be2019-08-13 07:50:19 -06001502bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001503 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001504 bool skip = false;
1505
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001506 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1507
1508 return skip;
1509}
1510
1511bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1512 VkQueryPool queryPool, uint32_t query) const {
1513 bool skip = false;
1514
1515 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001516
1517 return skip;
1518}
1519
Tony-LunarGd36f5f32022-01-20 11:49:59 -07001520bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage,
1521 VkQueryPool queryPool, uint32_t query) const {
1522 bool skip = false;
1523
1524 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage);
1525
1526 return skip;
1527}
1528
Sam Walls0961ec02020-03-31 16:39:15 +01001529void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1530 VkPipeline pipeline) {
1531 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1532
Nadav Gevaf0808442021-05-21 13:51:25 -04001533 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001534 PipelineUsedInFrame(pipeline);
Nadav Gevaf0808442021-05-21 13:51:25 -04001535
Sam Walls0961ec02020-03-31 16:39:15 +01001536 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001537 auto pipeline_state = Get<bp_state::Pipeline>(pipeline);
Sam Walls0961ec02020-03-31 16:39:15 +01001538 // check for depth/blend state tracking
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001539 if (pipeline_state) {
1540 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001541 assert(cb_node);
1542 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001543
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001544 render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments;
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001545 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001546
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07001547 const auto* blend_state = pipeline_state->ColorBlendState();
1548 const auto* stencil_state = pipeline_state->DepthStencilState();
Sam Walls0961ec02020-03-31 16:39:15 +01001549
1550 if (blend_state) {
1551 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001552 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001553 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1554 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001555 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001556 }
1557 }
1558 }
1559
1560 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001561 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001562
1563 if (stencil_state && stencil_state->depthTestEnable) {
1564 switch (stencil_state->depthCompareOp) {
1565 case VK_COMPARE_OP_EQUAL:
1566 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1567 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001568 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001569 break;
1570 default:
1571 break;
1572 }
1573 }
Sam Walls0961ec02020-03-31 16:39:15 +01001574 }
1575 }
1576}
1577
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02001578static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1579 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
1580 const auto& subpass_info = createInfo.pSubpasses[subpass];
1581 if (subpass_info.pResolveAttachments) {
1582 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1583 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1584 }
1585 }
1586 }
1587
1588 return false;
1589}
1590
Attilio Provenzano02859b22020-02-27 14:17:28 +00001591static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1592 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001593 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001594
1595 // If an attachment is ever used as a color attachment,
1596 // resolve attachment or depth stencil attachment,
1597 // it needs to exist on tile at some point.
1598
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001599 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1600 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001601 }
1602
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001603 if (subpass_info.pResolveAttachments) {
1604 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1605 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1606 }
1607 }
1608
1609 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001610 }
1611
1612 return false;
1613}
1614
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001615static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1616 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1617 return false;
1618 }
1619
1620 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001621 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001622
1623 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1624 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1625 return true;
1626 }
1627 }
1628 }
1629
1630 return false;
1631}
1632
Attilio Provenzano02859b22020-02-27 14:17:28 +00001633bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1634 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1635 bool skip = false;
1636
1637 if (!pRenderPassBegin) {
1638 return skip;
1639 }
1640
Gareth Webbdc6549a2021-06-16 03:52:24 +01001641 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
1642 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
1643 "This render pass has a zero-size render area. It cannot write to any attachments, "
1644 "and can only be used for side effects such as layout transitions.");
1645 }
1646
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001647 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001648 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001649 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001650 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001651 if (rpabi) {
1652 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1653 }
1654 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001655 // Check if any attachments have LOAD operation on them
1656 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001657 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001658
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001659 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02001660 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001661 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001662 }
1663
1664 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001665 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001666 }
1667
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001668 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001669
1670 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001671 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1672 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001673 }
1674
1675 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
LawG47747b322022-02-23 16:12:10 +00001676 if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
1677 skip |=
1678 LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
LawG4015be1c2022-03-01 10:37:52 +00001679 "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
LawG47747b322022-02-23 16:12:10 +00001680 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04001681 "which will copy in total %u pixels (renderArea = "
LawG47747b322022-02-23 16:12:10 +00001682 "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.",
1683 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att,
1684 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1685 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1686 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001687 }
1688 }
1689 }
1690
1691 return skip;
1692}
1693
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001694void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
1695 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001696 if (view) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001697 auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state);
1698 QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001699 }
1700}
1701
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001702void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1703 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001704 // If we're viewing a 3D slice, ignore base array layer.
1705 // The entire 3D subresource is accessed as one atomic unit.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001706 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 +02001707
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001708 const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001709 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001710 const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel;
1711 const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001712
1713 for (uint32_t layer = 0; layer < array_layers; layer++) {
1714 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001715 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
1716 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001717 }
1718 }
1719}
1720
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001721void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state,
1722 IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) {
1723 const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001724 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001725
1726 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001727 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001728 }
1729}
1730
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001731void BestPractices::QueueValidateImage(QueueCallbacks &funcs, const char* function_name,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001732 std::shared_ptr<bp_state::Image> &state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001733 uint32_t array_layer, uint32_t mip_level) {
Jeremy Gebben7fd238f2022-03-04 10:32:24 -07001734 if (VendorCheckEnabled(kBPVendorArm)) {
1735 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](
1736 const ValidationStateTracker&, const QUEUE_STATE&, const CMD_BUFFER_STATE&) -> bool {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001737 ValidateImageInQueue(function_name, *state, usage, array_layer, mip_level);
Jeremy Gebben7fd238f2022-03-04 10:32:24 -07001738 return false;
1739 });
1740 }
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001741}
1742
LawG44d414ba2022-02-23 15:35:41 +00001743void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image,
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001744 IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001745 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001746 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001747 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 -07001748 !image.IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001749 LogPerformanceWarning(
1750 device, kVUID_BestPractices_RenderPass_RedundantStore,
LawG4015be1c2022-03-01 10:37:52 +00001751 "%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 +02001752 "image was used, it was written to with STORE_OP_STORE. "
1753 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1754 "architectures.",
LawG44d414ba2022-02-23 15:35:41 +00001755 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001756 } 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 +02001757 LogPerformanceWarning(
1758 device, kVUID_BestPractices_RenderPass_RedundantClear,
LawG4015be1c2022-03-01 10:37:52 +00001759 "%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 +02001760 "image was used, it was written to with vkCmdClear*Image(). "
1761 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
LawG44d414ba2022-02-23 15:35:41 +00001762 "tile-based architectures.",
1763 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001764 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001765 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1766 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001767 const char *last_cmd = nullptr;
1768 const char *vuid = nullptr;
1769 const char *suggestion = nullptr;
1770
1771 switch (last_usage) {
1772 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1773 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1774 last_cmd = "vkCmdBlitImage";
1775 suggestion =
1776 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1777 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1778 "which avoids the memory roundtrip.";
1779 break;
1780 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1781 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1782 last_cmd = "vkCmdClear*Image";
1783 suggestion =
1784 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1785 "tile-based architectures. "
1786 "Use LOAD_OP_CLEAR instead to clear the image for free.";
1787 break;
1788 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
1789 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
1790 last_cmd = "vkCmdCopy*Image";
1791 suggestion =
1792 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1793 "Rather than copying, just render the source image in a fragment shader in this render pass, "
1794 "which avoids the memory roundtrip.";
1795 break;
1796 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
1797 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
1798 last_cmd = "vkCmdResolveImage";
1799 suggestion =
1800 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
1801 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
1802 "which avoids the memory roundtrip.";
1803 break;
1804 default:
1805 break;
1806 }
1807
1808 LogPerformanceWarning(
1809 device, vuid,
LawG4015be1c2022-03-01 10:37:52 +00001810 "%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 +01001811 "time image was used, it was written to with %s. %s",
LawG44d414ba2022-02-23 15:35:41 +00001812 function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd,
1813 suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001814 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001815}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001816
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001817void BestPractices::ValidateImageInQueue(const char* function_name, bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage,
1818 uint32_t array_layer, uint32_t mip_level) {
1819 auto last_usage = state.UpdateUsage(array_layer, mip_level, usage);
LawG44d414ba2022-02-23 15:35:41 +00001820 if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) {
1821 ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001822 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001823}
1824
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001825void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) {
1826 cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(),
1827 cb.queue_submit_functions_after_render_pass.end());
1828 cb.queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001829}
1830
1831void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
1832 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001833 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1834 if (cb_node) {
1835 AddDeferredQueueOperations(*cb_node);
1836 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001837}
1838
1839void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
1840 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001841 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1842 if (cb_node) {
1843 AddDeferredQueueOperations(*cb_node);
1844 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001845}
1846
1847void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
1848 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001849 auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
1850 if (cb_node) {
1851 AddDeferredQueueOperations(*cb_node);
1852 }
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001853}
1854
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001855void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
1856 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001857 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001858 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001859 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1860}
1861
1862void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
1863 const VkRenderPassBeginInfo* pRenderPassBegin,
1864 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1865 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1866 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1867}
1868
1869void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1870 const VkRenderPassBeginInfo* pRenderPassBegin,
1871 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1872 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1873 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1874}
1875
1876void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001877
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001878 if (!pRenderPassBegin) {
1879 return;
1880 }
1881
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001882 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001883
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001884 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001885 if (rp_state) {
1886 // Check load ops
1887 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001888 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001889
1890 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
1891 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1892 continue;
1893 }
1894
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001895 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001896
1897 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
1898 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001899 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001900 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
1901 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001902 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001903 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001904 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001905 }
1906
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001907 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Jeremy Gebben9f537102021-10-05 16:37:12 -06001908 std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr;
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001909
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001910 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001911 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1912 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001913 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001914 }
1915 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001916 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001917 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001918
Jeremy Gebben9f537102021-10-05 16:37:12 -06001919 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001920 }
1921
1922 // Check store ops
1923 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001924 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001925
1926 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1927 continue;
1928 }
1929
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001930 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001931
1932 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
1933 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001934 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001935 }
1936
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001937 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001938
Jeremy Gebben9f537102021-10-05 16:37:12 -06001939 std::shared_ptr<IMAGE_VIEW_STATE> image_view;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001940 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001941 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1942 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001943 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001944 }
1945 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001946 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001947 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001948
Jeremy Gebben9f537102021-10-05 16:37:12 -06001949 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001950 }
1951 }
1952}
1953
Attilio Provenzano02859b22020-02-27 14:17:28 +00001954bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1955 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001956 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1957 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001958 return skip;
1959}
1960
1961bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1962 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001963 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001964 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1965 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001966 return skip;
1967}
1968
1969bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001970 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001971 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1972 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001973 return skip;
1974}
1975
Sam Walls0961ec02020-03-31 16:39:15 +01001976void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1977 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001978 // Reset the renderpass state
Jeremy Gebben20da7a12022-02-25 14:07:46 -07001979 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001980 cb->hasDrawCmd = false;
1981 assert(cb);
1982 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02001983 render_pass_state.touchesAttachments.clear();
1984 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001985 render_pass_state.numDrawCallsDepthOnly = 0;
1986 render_pass_state.numDrawCallsDepthEqualCompare = 0;
1987 render_pass_state.colorAttachment = false;
1988 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001989 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001990 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01001991
Jeremy Gebbenf4449392022-01-28 10:09:10 -07001992 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01001993
1994 // track depth / color attachment usage within the renderpass
1995 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
1996 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001997 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001998
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001999 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01002000 }
2001}
2002
2003void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2004 VkSubpassContents contents) {
2005 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
2006 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
2007}
2008
2009void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
2010 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2011 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2012 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2013}
2014
2015void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
2016 const VkRenderPassBeginInfo* pRenderPassBegin,
2017 const VkSubpassBeginInfo* pSubpassBeginInfo) {
2018 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
2019 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
2020}
2021
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002022// Generic function to handle validation for all CmdDraw* type functions
2023bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
2024 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002025 const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002026 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002027 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2028 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002029 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002030
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002031 // Verify vertex binding
Tony-LunarG2ffe1f52022-04-11 15:13:30 -06002032 if (pipeline_state && pipeline_state->vertex_input_state &&
2033 pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) {
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002034 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002035 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07002036 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002037 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
2038 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002039 }
2040 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002041
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06002042 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002043 if (pipe) {
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002044 const auto& rp_state = pipe->RenderPassState();
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002045 if (rp_state) {
2046 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
2047 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002048 const auto* ds_state = pipe->DepthStencilState();
Jeremy Gebben11af9792021-08-20 10:20:09 -06002049 const uint32_t depth_stencil_attachment =
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002050 GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment);
2051 const auto* raster_state = pipe->RasterizationState();
2052 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state &&
2053 raster_state->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002054 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
2055 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
2056 }
2057 }
2058 }
2059 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002060 }
2061 return skip;
2062}
2063
Sam Walls0961ec02020-03-31 16:39:15 +01002064void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002065 auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002066 assert(cb_node);
Sam Walls0961ec02020-03-31 16:39:15 +01002067 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002068 RecordCmdDrawTypeArm(*cb_node, draw_count, caller);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002069 }
2070
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002071 if (cb_node->render_pass_state.drawTouchAttachments) {
2072 for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) {
2073 RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002074 }
2075 // No need to touch the same attachments over and over.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002076 cb_node->render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002077 }
2078}
2079
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002080void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) {
2081 auto& render_pass_state = cb_node.render_pass_state;
LawG4b21485c2022-02-28 13:46:48 +00002082 // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards
2083 // depth prepass warnings First find the lowest enabled draw count
2084 uint32_t lowestEnabledMinDrawCount = 0;
2085 lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm;
2086 if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount)
2087 lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG;
2088
2089 if (draw_count >= lowestEnabledMinDrawCount) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002090 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
2091 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01002092 }
2093}
2094
Camden5b184be2019-08-13 07:50:19 -06002095bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002096 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002097 bool skip = false;
2098
2099 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002100 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2101 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002102 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002103 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06002104
2105 return skip;
2106}
2107
Sam Walls0961ec02020-03-31 16:39:15 +01002108void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2109 uint32_t firstVertex, uint32_t firstInstance) {
2110 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
2111 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
2112}
2113
Camden5b184be2019-08-13 07:50:19 -06002114bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002115 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002116 bool skip = false;
2117
2118 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002119 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2120 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002121 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002122 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
2123
Attilio Provenzano02859b22020-02-27 14:17:28 +00002124 // Check if we reached the limit for small indexed draw calls.
2125 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002126 const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002127 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002128 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
LawG4ff42d722022-03-01 10:28:25 +00002129 (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002130 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
LawG4ff42d722022-03-01 10:28:25 +00002131 "%s %s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00002132 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
2133 "You can try batching drawcalls or instancing when applicable.",
LawG4ff42d722022-03-01 10:28:25 +00002134 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls,
2135 kSmallIndexedDrawcallIndices);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002136 }
2137
Sam Walls8e77e4f2020-03-16 20:47:40 +00002138 if (VendorCheckEnabled(kBPVendorArm)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002139 ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002140 }
2141
2142 return skip;
2143}
2144
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002145bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount,
Sam Walls8e77e4f2020-03-16 20:47:40 +00002146 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
2147 bool skip = false;
2148
2149 // check for sparse/underutilised index buffer, and post-transform cache thrashing
Sam Walls8e77e4f2020-03-16 20:47:40 +00002150
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002151 const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get();
2152 if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002153
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002154 const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002155 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00002156 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
2157 const void* ib_mem = ib_mem_state.p_driver_data;
2158 bool primitive_restart_enable = false;
2159
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002160 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002161 const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point];
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002162 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002163
Nathaniel Cesario3fd4f762022-02-16 16:07:06 -07002164 const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr;
2165 if (ia_state) {
2166 primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002167 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00002168
2169 // 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 -06002170 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00002171 uint32_t scan_stride;
2172 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2173 scan_stride = sizeof(uint8_t);
2174 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2175 scan_stride = sizeof(uint16_t);
2176 } else {
2177 scan_stride = sizeof(uint32_t);
2178 }
2179
2180 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
2181 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
2182
2183 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
2184 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
2185 // irrespective of whether or not they're part of the draw call.
2186
2187 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
2188 uint32_t min_index = ~0u;
2189 // start with maximum as 0 and adjust to indices in the buffer
2190 uint32_t max_index = 0u;
2191
2192 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
2193 // for the given index buffer
2194 uint32_t vertex_shade_count = 0;
2195
2196 PostTransformLRUCacheModel post_transform_cache;
2197
2198 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
2199 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
2200 // target architecture.
2201 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
2202 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
2203 post_transform_cache.resize(32);
2204
2205 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2206 uint32_t scan_index;
2207 uint32_t primitive_restart_value;
2208 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2209 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2210 primitive_restart_value = 0xFF;
2211 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2212 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2213 primitive_restart_value = 0xFFFF;
2214 } else {
2215 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2216 primitive_restart_value = 0xFFFFFFFF;
2217 }
2218
2219 max_index = std::max(max_index, scan_index);
2220 min_index = std::min(min_index, scan_index);
2221
2222 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
2223 bool in_cache = post_transform_cache.query_cache(scan_index);
2224 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
2225 if (!in_cache) vertex_shade_count++;
2226 }
2227 }
2228
2229 // 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 +01002230 // 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
2231 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002232
2233 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07002234 skip |=
2235 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2236 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
2237 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
2238 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
2239 "maximum would be loaded, and possibly shaded, whether or not they are used.",
2240 VendorSpecificTag(kBPVendorArm),
2241 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002242 return skip;
2243 }
2244
2245 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
2246 // 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 +01002247 const size_t refs_per_bucket = 64;
2248 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
2249
2250 const uint32_t n_indices = max_index - min_index + 1;
2251 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
2252 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
2253
2254 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
2255 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00002256
2257 // To avoid using too much memory, we run over the indices again.
2258 // Knowing the size from the last scan allows us to record index usage with bitsets
2259 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2260 uint32_t scan_index;
2261 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2262 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2263 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2264 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2265 } else {
2266 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2267 }
2268 // keep track of the set of all indices used to reference vertices in the draw call
2269 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01002270 size_t bitset_bucket_index = index_offset / refs_per_bucket;
2271 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002272 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
2273 }
2274
2275 uint32_t vertex_reference_count = 0;
2276 for (const auto& bitset : vertex_reference_buckets) {
2277 vertex_reference_count += static_cast<uint32_t>(bitset.count());
2278 }
2279
2280 // 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 -07002281 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002282 // 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 -07002283 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002284
2285 if (utilization < 0.5f) {
2286 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2287 "%s The indices which were specified for the draw call only utilise approximately "
2288 "%.02f%% of the bound vertex buffer.",
2289 VendorSpecificTag(kBPVendorArm), utilization);
2290 }
2291
2292 if (cache_hit_rate <= 0.5f) {
2293 skip |=
2294 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
2295 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
2296 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
2297 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
2298 "recently shaded vertices.",
2299 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
2300 }
2301 }
2302
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002303 return skip;
2304}
2305
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002306bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2307 const VkCommandBuffer* pCommandBuffers) const {
2308 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002309 const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002310 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002311 const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002312 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002313 continue;
2314 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002315 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002316 for (auto& clear : secondary.earlyClearAttachments) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002317 if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) {
2318 skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002319 }
2320 }
2321 }
Nadav Gevaf0808442021-05-21 13:51:25 -04002322
2323 if (VendorCheckEnabled(kBPVendorAMD)) {
2324 if (commandBufferCount > 0) {
2325 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
2326 "%s Performance warning: Use of secondary command buffers is not recommended. ",
2327 VendorSpecificTag(kBPVendorAMD));
2328 }
2329 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002330 return skip;
2331}
2332
2333void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2334 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002335 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
2336
2337 auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2338 if (!primary) {
2339 return;
2340 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002341
2342 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002343 auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]);
2344 if (!secondary) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002345 continue;
2346 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002347
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002348 for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) {
2349 if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
2350 RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment,
2351 early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002352 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002353 RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002354 }
2355 }
2356
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002357 for (auto& touch : secondary->render_pass_state.touchesAttachments) {
2358 RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002359 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02002360
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002361 primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare;
2362 primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly;
Hans-Kristian Arntzenaf81dca2021-06-18 11:14:28 +02002363
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002364 if (secondary->hasDrawCmd) {
Hans-Kristian Arntzenaf81dca2021-06-18 11:14:28 +02002365 primary->hasDrawCmd = true;
2366 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002367 }
2368
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002369}
2370
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002371void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
2372 auto& state = cb_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002373 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002374 auto itr =
2375 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2376 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002377
2378 if (itr != state.touchesAttachments.end()) {
2379 itr->aspects |= aspects;
2380 } else {
2381 state.touchesAttachments.push_back({ fb_attachment, aspects });
2382 }
2383}
2384
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002385void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002386 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
2387 const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002388 auto& state = cmd_state.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002389 // If we observe a full clear before any other access to a frame buffer attachment,
2390 // we have candidate for redundant clear attachments.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002391 auto itr =
2392 std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
2393 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002394
2395 uint32_t new_aspects = aspects;
2396 if (itr != state.touchesAttachments.end()) {
2397 new_aspects = aspects & ~itr->aspects;
2398 itr->aspects |= aspects;
2399 } else {
2400 state.touchesAttachments.push_back({ fb_attachment, aspects });
2401 }
2402
2403 if (new_aspects == 0) {
2404 return;
2405 }
2406
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002407 if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002408 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
2409 // CmdExecuteCommands.
2410 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
2411 std::vector<VkClearRect>{pRects, pRects + rectCount} });
2412 }
2413}
2414
2415void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
2416 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
2417 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002418 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects);
2419
2420 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2421 auto* rp_state = cmd_state->activeRenderPass.get();
2422 auto* fb_state = cmd_state->activeFramebuffer.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002423 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
2424
2425 if (rectCount == 0 || !rp_state) {
2426 return;
2427 }
2428
2429 if (!is_secondary && !fb_state) {
2430 return;
2431 }
2432
2433 // 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 -07002434 bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002435
ziga-lunarg885c6542022-03-07 01:08:25 +01002436 if (!rp_state->use_dynamic_rendering && !rp_state->use_dynamic_rendering_inherited) {
2437 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
2438 for (uint32_t i = 0; i < attachmentCount; i++) {
2439 auto& attachment = pClearAttachments[i];
2440 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2441 VkImageAspectFlags aspects = attachment.aspectMask;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002442
ziga-lunarg885c6542022-03-07 01:08:25 +01002443 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
2444 if (subpass.pDepthStencilAttachment) {
2445 fb_attachment = subpass.pDepthStencilAttachment->attachment;
2446 }
2447 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
2448 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002449 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002450
ziga-lunarg885c6542022-03-07 01:08:25 +01002451 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2452 if (full_clear) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002453 RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment,
ziga-lunarg885c6542022-03-07 01:08:25 +01002454 aspects, rectCount, pRects);
2455 } else {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002456 RecordAttachmentAccess(*cmd_state, fb_attachment, aspects);
ziga-lunarg885c6542022-03-07 01:08:25 +01002457 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002458 }
2459 }
2460 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002461}
2462
Attilio Provenzano02859b22020-02-27 14:17:28 +00002463void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2464 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2465 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
2466 firstInstance);
2467
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002468 auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002469 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
2470 cmd_state->small_indexed_draw_call_count++;
2471 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002472
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002473 ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00002474}
2475
Sam Walls0961ec02020-03-31 16:39:15 +01002476void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2477 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2478 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2479 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
2480}
2481
sfricke-samsung681ab7b2020-10-29 01:53:35 -07002482bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2483 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
2484 uint32_t maxDrawCount, uint32_t stride) const {
2485 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
2486
2487 return skip;
2488}
2489
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002490bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
2491 VkDeviceSize offset, VkBuffer countBuffer,
2492 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
2493 uint32_t stride) const {
2494 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06002495
2496 return skip;
2497}
2498
2499bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002500 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002501 bool skip = false;
2502
2503 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002504 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2505 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002506 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002507 }
2508
2509 return skip;
2510}
2511
Sam Walls0961ec02020-03-31 16:39:15 +01002512void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2513 uint32_t count, uint32_t stride) {
2514 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2515 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2516}
2517
Camden5b184be2019-08-13 07:50:19 -06002518bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002519 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002520 bool skip = false;
2521
2522 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002523 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2524 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002525 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002526 }
2527
2528 return skip;
2529}
2530
Sam Walls0961ec02020-03-31 16:39:15 +01002531void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2532 uint32_t count, uint32_t stride) {
2533 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2534 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2535}
2536
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002537void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) {
2538 for (auto descriptor_set : cb_state.validated_descriptor_sets) {
2539 const auto& layout = *descriptor_set->GetLayout();
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002540
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002541 for (uint32_t index = 0; index < descriptor_set->GetBindingCount(); ++index) {
2542 // For bindless scenarios, we should not attempt to track descriptor set state.
2543 // It is highly uncertain which resources are actually bound.
2544 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
2545 VkDescriptorBindingFlags flags = layout.GetDescriptorBindingFlagsFromIndex(index);
2546 if (flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2547 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
2548 continue;
2549 }
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002550
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002551 auto index_range = layout.GetGlobalIndexRangeFromIndex(index);
2552 for (uint32_t i = index_range.start; i < index_range.end; ++i) {
2553 VkImageView image_view{VK_NULL_HANDLE};
2554
2555 auto descriptor = descriptor_set->GetDescriptorFromGlobalIndex(i);
2556 switch (descriptor->GetClass()) {
2557 case cvdescriptorset::DescriptorClass::Image: {
2558 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2559 image_view = image_descriptor->GetImageView();
2560 }
2561 break;
2562 }
2563 case cvdescriptorset::DescriptorClass::ImageSampler: {
2564 if (const auto image_sampler_descriptor =
2565 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2566 image_view = image_sampler_descriptor->GetImageView();
2567 }
2568 break;
2569 }
2570 default:
2571 break;
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002572 }
2573
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002574 if (image_view) {
2575 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
2576 QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(),
2577 IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002578 }
2579 }
2580 }
2581 }
2582}
2583
2584void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2585 uint32_t firstVertex, uint32_t firstInstance) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002586 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2587 ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002588}
2589
2590void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2591 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002592 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2593 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002594}
2595
2596void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2597 uint32_t drawCount, uint32_t stride) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002598 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2599 ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002600}
2601
Camden5b184be2019-08-13 07:50:19 -06002602bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002603 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002604 bool skip = false;
2605
2606 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002607 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2608 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2609 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2610 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002611 }
2612
2613 return skip;
2614}
Camden83a9c372019-08-14 11:41:38 -06002615
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002616bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2617 bool skip = false;
2618 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
2619 skip |= ValidateCmdEndRenderPass(commandBuffer);
2620 return skip;
2621}
2622
2623bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2624 bool skip = false;
2625 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
2626 skip |= ValidateCmdEndRenderPass(commandBuffer);
2627 return skip;
2628}
2629
Sam Walls0961ec02020-03-31 16:39:15 +01002630bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2631 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002632 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002633 skip |= ValidateCmdEndRenderPass(commandBuffer);
2634 return skip;
2635}
2636
2637bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2638 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002639 const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01002640
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002641 if (cmd == nullptr) return skip;
2642 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01002643
LawG4b21485c2022-02-28 13:46:48 +00002644 // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor
2645 bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2646 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
2647 bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG &&
2648 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG;
2649
2650 // Only send the warning when the vendor is enabled and a depth prepass is detected
LawG498ec4502022-04-05 09:08:25 +01002651 bool uses_depth =
2652 (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
LawG45507e142022-04-08 09:36:54 +01002653 ((depth_only_arm && VendorCheckEnabled(kBPVendorArm)) || (depth_only_img && VendorCheckEnabled(kBPVendorIMG)));
LawG4b21485c2022-02-28 13:46:48 +00002654
Sam Walls0961ec02020-03-31 16:39:15 +01002655 if (uses_depth) {
2656 skip |= LogPerformanceWarning(
2657 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
LawG4015be1c2022-03-01 10:37:52 +00002658 "%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 +00002659 "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry "
2660 "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface "
2661 "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.",
2662 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG));
Sam Walls0961ec02020-03-31 16:39:15 +01002663 }
2664
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002665 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2666
LawG40da9c3d2022-03-01 09:51:01 +00002667 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002668 // If we use an attachment on-tile, we should access it in some way. Otherwise,
2669 // it is redundant to have it be part of the render pass.
2670 // Only consider it redundant if it will actually consume bandwidth, i.e.
2671 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
2672 // as is using pure input attachments.
2673 // CLEAR -> STORE might be considered a "useful" thing to do, but
2674 // the optimal thing to do is to defer the clear until you're actually
2675 // going to render to the image.
2676
2677 uint32_t num_attachments = rp->createInfo.attachmentCount;
2678 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002679 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
2680 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002681 continue;
2682 }
2683
2684 auto& attachment = rp->createInfo.pAttachments[i];
2685
2686 VkImageAspectFlags bandwidth_aspects = 0;
2687
2688 if (!FormatIsStencilOnly(attachment.format) &&
2689 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2690 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2691 if (FormatHasDepth(attachment.format)) {
2692 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
2693 } else {
2694 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
2695 }
2696 }
2697
2698 if (FormatHasStencil(attachment.format) &&
2699 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2700 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2701 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
2702 }
2703
2704 if (!bandwidth_aspects) {
2705 continue;
2706 }
2707
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002708 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002709 [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002710 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002711 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002712 untouched_aspects &= ~itr->aspects;
2713 }
2714
2715 if (untouched_aspects) {
2716 skip |= LogPerformanceWarning(
2717 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
LawG4015be1c2022-03-01 10:37:52 +00002718 "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002719 "was never accessed by a pipeline or clear command. "
LawG40da9c3d2022-03-01 09:51:01 +00002720 "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 +00002721 "render pass if the attachments are not intended to be accessed.",
LawG40da9c3d2022-03-01 09:51:01 +00002722 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects);
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002723 }
2724 }
2725 }
2726
Sam Walls0961ec02020-03-31 16:39:15 +01002727 return skip;
2728}
2729
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002730void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002731 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2732 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002733}
2734
2735void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002736 const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer);
2737 ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002738}
2739
Camden Stocker9c051442019-11-06 14:28:43 -08002740bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
2741 const char* api_name) const {
2742 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002743 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08002744
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002745 if (bp_pd_state) {
2746 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
2747 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
2748 "Potential problem with calling %s() without first retrieving properties from "
2749 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
2750 api_name);
2751 }
Camden Stocker9c051442019-11-06 14:28:43 -08002752 }
2753
2754 return skip;
2755}
2756
Camden83a9c372019-08-14 11:41:38 -06002757bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002758 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06002759 bool skip = false;
2760
Camden Stocker9c051442019-11-06 14:28:43 -08002761 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06002762
Camden Stocker9c051442019-11-06 14:28:43 -08002763 return skip;
2764}
2765
2766bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
2767 uint32_t planeIndex,
2768 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
2769 bool skip = false;
2770
2771 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
2772
2773 return skip;
2774}
2775
2776bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
2777 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
2778 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
2779 bool skip = false;
2780
2781 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06002782
2783 return skip;
2784}
Camden05de2d42019-08-19 10:23:56 -06002785
2786bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002787 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06002788 bool skip = false;
2789
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002790 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Camden05de2d42019-08-19 10:23:56 -06002791
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002792 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06002793 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002794 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002795 skip |=
2796 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
2797 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
2798 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06002799 }
Camden05de2d42019-08-19 10:23:56 -06002800
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002801 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
2802 skip |= LogWarning(
2803 device, kVUID_BestPractices_Swapchain_InvalidCount,
2804 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04002805 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002806 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
2807 }
2808 }
2809
Camden05de2d42019-08-19 10:23:56 -06002810 return skip;
2811}
2812
2813// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002814bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002815 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002816 const CALL_STATE call_state,
2817 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06002818 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002819 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
2820 if (UNCALLED == call_state) {
2821 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002822 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002823 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
2824 "recommended "
2825 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
2826 caller_name, caller_name);
2827 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002828 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
2829 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002830 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
2831 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
2832 ". It is recommended to instead receive all the properties by calling %s with "
2833 "pQueueFamilyPropertyCount that was "
2834 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002835 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002836 caller_name);
Camden05de2d42019-08-19 10:23:56 -06002837 }
2838
2839 return skip;
2840}
2841
Jeff Bolz5c801d12019-10-09 10:38:45 -05002842bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
2843 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06002844 bool skip = false;
2845
2846 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07002847 auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06002848 if (!as_state->memory_requirements_checked) {
2849 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
2850 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
2851 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002852 skip |= LogWarning(
2853 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06002854 "vkBindAccelerationStructureMemoryNV(): "
2855 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
2856 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
2857 }
2858 }
2859
2860 return skip;
2861}
2862
Camden05de2d42019-08-19 10:23:56 -06002863bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
2864 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002865 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002866 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002867 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002868 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002869 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
2870 "vkGetPhysicalDeviceQueueFamilyProperties()");
2871 }
2872 return false;
Camden05de2d42019-08-19 10:23:56 -06002873}
2874
Mike Schuchardt2df08912020-12-15 16:28:09 -08002875bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
2876 uint32_t* pQueueFamilyPropertyCount,
2877 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002878 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002879 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002880 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002881 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
2882 "vkGetPhysicalDeviceQueueFamilyProperties2()");
2883 }
2884 return false;
Camden05de2d42019-08-19 10:23:56 -06002885}
2886
Jeff Bolz5c801d12019-10-09 10:38:45 -05002887bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08002888 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002889 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002890 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002891 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002892 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
2893 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
2894 }
2895 return false;
Camden05de2d42019-08-19 10:23:56 -06002896}
2897
2898bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
2899 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002900 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06002901 if (!pSurfaceFormats) return false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07002902 const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002903 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06002904 bool skip = false;
2905 if (call_state == UNCALLED) {
2906 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
2907 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002908 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
2909 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
2910 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06002911 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002912 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002913 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
2914 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
2915 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
2916 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002917 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06002918 }
2919 }
2920 return skip;
2921}
Camden Stocker23cc47d2019-09-03 14:53:57 -06002922
2923bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002924 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002925 bool skip = false;
2926
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002927 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2928 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06002929 // 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 -07002930 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002931 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
2932 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07002933 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06002934 // 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 -07002935 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
2936 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002937 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002938 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002939 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002940 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002941 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002942 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2943 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2944 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002945 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002946 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2947 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002948 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002949 }
2950 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002951 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002952 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002953 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002954 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2955 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002956 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002957 }
2958 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002959 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2960 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002961 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002962 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002963 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002964 }
Jeremy Gebben9f537102021-10-05 16:37:12 -06002965 sparse_images.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002966 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2967 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2968 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002969 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002970 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2971 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002972 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002973 }
2974 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002975 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002976 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002977 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002978 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2979 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002980 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002981 }
2982 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2983 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06002984 sparse_images_with_metadata.insert(image_state.get());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002985 }
2986 }
2987 }
2988 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002989 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
2990 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002991 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002992 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002993 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
2994 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002995 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002996 }
2997 }
2998 }
2999
3000 return skip;
3001}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003002
Mark Lobodzinski84101d72020-04-24 09:43:48 -06003003void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
3004 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003005 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07003006 return;
3007 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003008
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003009 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
3010 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
3011 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
3012 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04003013 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003014 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003015 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07003016 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05003017 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
3018 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
3019 image_state->sparse_metadata_bound = true;
3020 }
3021 }
3022 }
3023 }
3024}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003025
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003026bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount,
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003027 const VkClearRect* pRects) const {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003028 if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003029 // We don't know the accurate render area in a secondary,
3030 // so assume we clear the entire frame buffer.
3031 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
3032 return true;
3033 }
3034
3035 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
3036 for (uint32_t i = 0; i < rectCount; i++) {
3037 auto& rect = pRects[i];
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003038 auto& render_area = cmd.activeRenderPassBeginInfo.renderArea;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003039 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
3040 return true;
3041 }
3042 }
3043
3044 return false;
3045}
3046
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003047bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment,
3048 VkImageAspectFlags aspects, bool secondary) const {
3049 const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get();
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003050 bool skip = false;
3051
3052 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
3053 return skip;
3054 }
3055
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003056 const auto& rp_state = cmd.render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003057
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003058 auto attachment_itr =
3059 std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
3060 [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; });
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003061
3062 // Only report aspects which haven't been touched yet.
3063 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003064 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003065 new_aspects &= ~attachment_itr->aspects;
3066 }
3067
3068 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003069 if (!cmd.hasDrawCmd) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003070 skip |= LogPerformanceWarning(
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003071 cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02003072 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
3073 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003074 report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003075 }
3076
3077 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
3078 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3079 skip |= LogPerformanceWarning(
3080 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3081 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
3082 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3083 "it is more efficient.",
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003084 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003085 }
3086
3087 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
3088 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003089 skip |=
3090 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3091 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
3092 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3093 "it is more efficient.",
3094 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003095 }
3096
3097 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
3098 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003099 skip |=
3100 LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3101 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
3102 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3103 "it is more efficient.",
3104 secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003105 }
3106
3107 return skip;
3108}
3109
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003110bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06003111 const VkClearAttachment* pAttachments, uint32_t rectCount,
3112 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003113 bool skip = false;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003114 const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003115 if (!cb_node) return skip;
3116
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003117 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
3118 // Defer checks to ExecuteCommands.
3119 return skip;
3120 }
3121
3122 // Only care about full clears, partial clears might have legitimate uses.
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003123 if (!ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects)) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003124 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003125 }
3126
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003127 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
3128 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06003129 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003130 if (rp) {
3131 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
3132
3133 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003134 const auto& attachment = pAttachments[i];
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003135
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003136 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3137 uint32_t color_attachment = attachment.colorAttachment;
3138 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003139 skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003140 }
3141
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003142 if (subpass.pDepthStencilAttachment &&
3143 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003144 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003145 skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003146 }
3147 }
3148 }
3149
Nadav Gevaf0808442021-05-21 13:51:25 -04003150 if (VendorCheckEnabled(kBPVendorAMD)) {
3151 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
3152 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
3153 bool black_check = false;
3154 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
3155 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
3156 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
3157 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3158 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3159
3160 bool white_check = false;
3161 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
3162 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
3163 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
3164 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3165 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3166
3167 if (black_check && white_check) {
3168 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3169 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
3170 "Consider changing to one of the following:"
3171 "RGBA(0, 0, 0, 0) "
3172 "RGBA(0, 0, 0, 1) "
3173 "RGBA(1, 1, 1, 0) "
3174 "RGBA(1, 1, 1, 1)",
3175 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3176 }
3177 } else {
3178 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
3179 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
3180 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
3181 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3182 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
3183 "attachment %" PRId32 " is not a fast clear value."
3184 "Consider changing to one of the following:"
3185 "D=0.0f, S=0"
3186 "D=1.0f, S=0",
3187 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3188 }
3189 }
3190 }
3191 }
3192
Camden Stockerf55721f2019-09-09 11:04:49 -06003193 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003194}
Attilio Provenzano02859b22020-02-27 14:17:28 +00003195
3196bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3197 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3198 const VkImageResolve* pRegions) const {
3199 bool skip = false;
3200
3201 skip |= VendorCheckEnabled(kBPVendorArm) &&
3202 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
3203 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
3204 "This is a very slow and extremely bandwidth intensive path. "
3205 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3206 VendorSpecificTag(kBPVendorArm));
3207
3208 return skip;
3209}
3210
Jeff Leger178b1e52020-10-05 12:22:23 -04003211bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3212 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
3213 bool skip = false;
3214
3215 skip |= VendorCheckEnabled(kBPVendorArm) &&
3216 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
3217 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
3218 "This is a very slow and extremely bandwidth intensive path. "
3219 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3220 VendorSpecificTag(kBPVendorArm));
3221
3222 return skip;
3223}
3224
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003225bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer,
3226 const VkResolveImageInfo2* pResolveImageInfo) const {
3227 bool skip = false;
3228
3229 skip |= VendorCheckEnabled(kBPVendorArm) &&
3230 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage,
3231 "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. "
3232 "This is a very slow and extremely bandwidth intensive path. "
3233 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3234 VendorSpecificTag(kBPVendorArm));
3235
3236 return skip;
3237}
3238
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003239void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3240 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3241 const VkImageResolve* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003242 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003243 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003244 auto src = Get<bp_state::Image>(srcImage);
3245 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003246
3247 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003248 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
3249 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003250 }
3251}
3252
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003253void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3254 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003255 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003256 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003257 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3258 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003259 uint32_t regionCount = pResolveImageInfo->regionCount;
3260
3261 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003262 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
3263 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003264 }
3265}
3266
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003267void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer,
3268 const VkResolveImageInfo2* pResolveImageInfo) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003269 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003270 auto& funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003271 auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage);
3272 auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage);
Tony-LunarGd36f5f32022-01-20 11:49:59 -07003273 uint32_t regionCount = pResolveImageInfo->regionCount;
3274
3275 for (uint32_t i = 0; i < regionCount; i++) {
3276 QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ,
3277 pResolveImageInfo->pRegions[i].srcSubresource);
3278 QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE,
3279 pResolveImageInfo->pRegions[i].dstSubresource);
3280 }
3281}
3282
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003283void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3284 const VkClearColorValue* pColor, uint32_t rangeCount,
3285 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003286 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003287 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003288 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003289
3290 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003291 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003292 }
3293}
3294
3295void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3296 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3297 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003298 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003299 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003300 auto dst = Get<bp_state::Image>(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003301
3302 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003303 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003304 }
3305}
3306
3307void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3308 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3309 const VkImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003310 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003311 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003312 auto src = Get<bp_state::Image>(srcImage);
3313 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003314
3315 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003316 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
3317 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003318 }
3319}
3320
3321void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
3322 VkImageLayout dstImageLayout, uint32_t regionCount,
3323 const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003324 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003325 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003326 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003327
3328 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003329 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003330 }
3331}
3332
3333void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3334 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003335 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003336 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003337 auto src = Get<bp_state::Image>(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003338
3339 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003340 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003341 }
3342}
3343
3344void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3345 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3346 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003347 auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003348 auto &funcs = cb->queue_submit_functions;
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003349 auto src = Get<bp_state::Image>(srcImage);
3350 auto dst = Get<bp_state::Image>(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003351
3352 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003353 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
3354 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003355 }
3356}
3357
Attilio Provenzano02859b22020-02-27 14:17:28 +00003358bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
3359 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
3360 bool skip = false;
3361
3362 if (VendorCheckEnabled(kBPVendorArm)) {
3363 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
3364 skip |= LogPerformanceWarning(
3365 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
3366 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
3367 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
3368 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003369 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003370 }
3371
3372 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
3373 skip |= LogPerformanceWarning(
3374 device, kVUID_BestPractices_CreateSampler_LodClamping,
3375 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
3376 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
3377 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
3378 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
3379 }
3380
3381 if (pCreateInfo->mipLodBias != 0.0f) {
3382 skip |=
3383 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
3384 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
3385 "descriptors being created and may cause reduced performance.",
3386 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
3387 }
3388
3389 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3390 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3391 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
3392 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
3393 skip |= LogPerformanceWarning(
3394 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
3395 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
3396 "This will lead to less efficient descriptors being created and may cause reduced performance. "
3397 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
3398 VendorSpecificTag(kBPVendorArm));
3399 }
3400
3401 if (pCreateInfo->unnormalizedCoordinates) {
3402 skip |= LogPerformanceWarning(
3403 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
3404 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
3405 "descriptors being created and may cause reduced performance.",
3406 VendorSpecificTag(kBPVendorArm));
3407 }
3408
3409 if (pCreateInfo->anisotropyEnable) {
3410 skip |= LogPerformanceWarning(
3411 device, kVUID_BestPractices_CreateSampler_Anisotropy,
3412 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
3413 "and may cause reduced performance.",
3414 VendorSpecificTag(kBPVendorArm));
3415 }
3416 }
3417
3418 return skip;
3419}
Sam Walls8e77e4f2020-03-16 20:47:40 +00003420
Nadav Gevaf0808442021-05-21 13:51:25 -04003421void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
3422 const VkGraphicsPipelineCreateInfo* pCreateInfos,
3423 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
3424 void* cgpl_state) {
3425 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
3426 pPipelines);
3427 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003428 num_pso_ += createInfoCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003429}
3430
3431bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
3432 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
3433 const VkCopyDescriptorSet* pDescriptorCopies) const {
3434 bool skip = false;
3435 if (VendorCheckEnabled(kBPVendorAMD)) {
3436 if (descriptorCopyCount > 0) {
3437 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
3438 "%s Performance warning: copying descriptor sets is not recommended",
3439 VendorSpecificTag(kBPVendorAMD));
3440 }
3441 }
3442
3443 return skip;
3444}
3445
3446bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
3447 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
3448 const VkAllocationCallbacks* pAllocator,
3449 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
3450 bool skip = false;
3451 if (VendorCheckEnabled(kBPVendorAMD)) {
3452 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
3453 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
3454 "vkUpdateDescriptorSet instead",
3455 VendorSpecificTag(kBPVendorAMD));
3456 }
3457
3458 return skip;
3459}
3460
3461bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3462 const VkClearColorValue* pColor, uint32_t rangeCount,
3463 const VkImageSubresourceRange* pRanges) const {
3464 bool skip = false;
3465 if (VendorCheckEnabled(kBPVendorAMD)) {
sfricke-samsungef15e482022-01-26 11:32:49 -08003466 skip |= LogPerformanceWarning(
3467 device, kVUID_BestPractices_ClearAttachment_ClearImage,
Nadav Gevaf0808442021-05-21 13:51:25 -04003468 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3469 "vkCmdClearAttachments instead",
3470 VendorSpecificTag(kBPVendorAMD));
3471 }
3472
3473 return skip;
3474}
3475
3476bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
3477 VkImageLayout imageLayout,
3478 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3479 const VkImageSubresourceRange* pRanges) const {
3480 bool skip = false;
3481 if (VendorCheckEnabled(kBPVendorAMD)) {
3482 skip |= LogPerformanceWarning(
3483 device, kVUID_BestPractices_ClearAttachment_ClearImage,
3484 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3485 "vkCmdClearAttachments instead",
3486 VendorSpecificTag(kBPVendorAMD));
3487 }
3488
3489 return skip;
3490}
3491
3492bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
3493 const VkAllocationCallbacks* pAllocator,
3494 VkPipelineLayout* pPipelineLayout) const {
3495 bool skip = false;
3496 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003497 uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2;
Nadav Gevaf0808442021-05-21 13:51:25 -04003498 // Descriptor sets cost 1 DWORD each.
3499 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
3500 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
3501 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
3502 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
3503 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebben9f537102021-10-05 16:37:12 -06003504 auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003505 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size;
Nadav Gevaf0808442021-05-21 13:51:25 -04003506 }
3507
3508 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
3509 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
3510 }
3511
3512 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
3513 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
3514 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
3515 "Descriptor sets cost 1 DWORD each. "
3516 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
3517 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
3518 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
3519 VendorSpecificTag(kBPVendorAMD));
3520 }
3521 }
3522
3523 return skip;
3524}
3525
3526bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3527 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3528 const VkImageCopy* pRegions) const {
3529 bool skip = false;
3530 std::stringstream src_image_hex;
3531 std::stringstream dst_image_hex;
3532 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
3533 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
3534
3535 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003536 auto src_state = Get<IMAGE_STATE>(srcImage);
3537 auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04003538
3539 if (src_state && dst_state) {
3540 VkImageTiling src_Tiling = src_state->createInfo.tiling;
3541 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
3542 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
3543 skip |=
3544 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
3545 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
3546 "image (vkCmdCopyImageToBuffer) "
3547 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
3548 "copies when converting between linear and optimal images",
3549 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
3550 }
3551 }
3552 }
3553
3554 return skip;
3555}
3556
3557bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
3558 VkPipeline pipeline) const {
3559 bool skip = false;
3560
3561 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003562 if (IsPipelineUsedInFrame(pipeline)) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003563 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
3564 "%s Performance warning: Pipeline %s was bound twice in the frame. Keep pipeline state changes to a minimum,"
3565 "for example, by sorting draw calls by pipeline.",
3566 VendorSpecificTag(kBPVendorAMD), report_data->FormatHandle(pipeline).c_str());
3567 }
3568 }
3569
3570 return skip;
3571}
3572
3573void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
3574 VkFence fence, VkResult result) {
3575 // AMD best practice
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003576 num_queue_submissions_ += submitCount;
Nadav Gevaf0808442021-05-21 13:51:25 -04003577}
3578
3579bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
3580 bool skip = false;
3581
3582 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003583 auto num = num_queue_submissions_.load();
3584 if (num > kNumberOfSubmissionWarningLimitAMD) {
3585 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
3586 "%s Performance warning: command buffers submitted %" PRId32
3587 " times this frame. Submitting command buffers has a CPU "
3588 "and GPU overhead. Submit fewer times to incur less overhead.",
3589 VendorSpecificTag(kBPVendorAMD), num);
Nadav Gevaf0808442021-05-21 13:51:25 -04003590 }
3591 }
3592
3593 return skip;
3594}
3595
3596void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
3597 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
3598 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
3599 uint32_t bufferMemoryBarrierCount,
3600 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
3601 uint32_t imageMemoryBarrierCount,
3602 const VkImageMemoryBarrier* pImageMemoryBarriers) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003603 num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount);
Nadav Gevaf0808442021-05-21 13:51:25 -04003604}
3605
3606bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3607 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
3608 bool skip = false;
3609 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003610 if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003611 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
3612 "%s Performance warning: High number of vkSemaphore objects created."
3613 "Minimize the amount of queue synchronization that is used. "
3614 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
3615 VendorSpecificTag(kBPVendorAMD));
3616 }
3617 }
3618
3619 return skip;
3620}
3621
3622bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3623 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
3624 bool skip = false;
3625 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003626 if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003627 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
3628 "%s Performance warning: High number of VkFence objects created."
3629 "Minimize the amount of CPU-GPU synchronization that is used. "
3630 "Semaphores and fences have overhead.Each fence has a CPU and GPU cost with it.",
3631 VendorSpecificTag(kBPVendorAMD));
3632 }
3633 }
3634
3635 return skip;
3636}
3637
Sam Walls8e77e4f2020-03-16 20:47:40 +00003638void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
3639
3640bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
3641 // look for a cache hit
3642 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
3643 if (hit != _entries.end()) {
3644 // mark the cache hit as being most recently used
3645 hit->age = iteration++;
3646 return true;
3647 }
3648
3649 // if there's no cache hit, we need to model the entry being inserted into the cache
3650 CacheEntry new_entry = {value, iteration};
3651 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
3652 // if there is still space left in the cache, use the next available slot
3653 *(_entries.begin() + iteration) = new_entry;
3654 } else {
3655 // otherwise replace the least recently used cache entry
3656 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
3657 *lru = new_entry;
3658 }
3659 iteration++;
3660 return false;
3661}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003662
3663bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
3664 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenf4449392022-01-28 10:09:10 -07003665 auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003666 bool skip = false;
3667 if (swapchain_data && swapchain_data->images.size() == 0) {
3668 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
3669 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
3670 "vkGetSwapchainImagesKHR after swapchain creation.");
3671 }
3672 return skip;
3673}
3674
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003675void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
3676 if (no_pointer) {
3677 if (UNCALLED == call_state) {
3678 call_state = QUERY_COUNT;
3679 }
3680 } else { // Save queue family properties
3681 call_state = QUERY_DETAILS;
3682 }
3683}
3684
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003685void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3686 uint32_t* pQueueFamilyPropertyCount,
3687 VkQueueFamilyProperties* pQueueFamilyProperties) {
3688 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
3689 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003690 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003691 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003692 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3693 nullptr == pQueueFamilyProperties);
3694 }
3695}
3696
3697void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3698 uint32_t* pQueueFamilyPropertyCount,
3699 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3700 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
3701 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003702 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003703 if (bp_pd_state) {
3704 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3705 nullptr == pQueueFamilyProperties);
3706 }
3707}
3708
3709void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
3710 uint32_t* pQueueFamilyPropertyCount,
3711 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3712 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
3713 pQueueFamilyProperties);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003714 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003715 if (bp_pd_state) {
3716 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3717 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003718 }
3719}
3720
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003721void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
3722 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003723 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003724 if (bp_pd_state) {
3725 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3726 }
3727}
3728
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003729void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
3730 VkPhysicalDeviceFeatures2* pFeatures) {
3731 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003732 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003733 if (bp_pd_state) {
3734 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3735 }
3736}
3737
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003738void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
3739 VkPhysicalDeviceFeatures2* pFeatures) {
3740 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003741 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003742 if (bp_pd_state) {
3743 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3744 }
3745}
3746
3747void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
3748 VkSurfaceKHR surface,
3749 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
3750 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003751 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003752 if (bp_pd_state) {
3753 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3754 }
3755}
3756
3757void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
3758 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3759 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003760 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003761 if (bp_pd_state) {
3762 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3763 }
3764}
3765
3766void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
3767 VkSurfaceKHR surface,
3768 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
3769 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003770 auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003771 if (bp_pd_state) {
3772 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3773 }
3774}
3775
3776void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
3777 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
3778 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003779 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003780 if (bp_pd_data) {
3781 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
3782
3783 if (*pPresentModeCount) {
3784 if (call_state < QUERY_COUNT) {
3785 call_state = QUERY_COUNT;
3786 }
3787 }
3788 if (pPresentModes) {
3789 if (call_state < QUERY_DETAILS) {
3790 call_state = QUERY_DETAILS;
3791 }
3792 }
3793 }
3794}
3795
3796void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
3797 uint32_t* pSurfaceFormatCount,
3798 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003799 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003800 if (bp_pd_data) {
3801 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
3802
3803 if (*pSurfaceFormatCount) {
3804 if (call_state < QUERY_COUNT) {
3805 call_state = QUERY_COUNT;
3806 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003807 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003808 }
3809 if (pSurfaceFormats) {
3810 if (call_state < QUERY_DETAILS) {
3811 call_state = QUERY_DETAILS;
3812 }
3813 }
3814 }
3815}
3816
3817void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
3818 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3819 uint32_t* pSurfaceFormatCount,
3820 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003821 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003822 if (bp_pd_data) {
3823 if (*pSurfaceFormatCount) {
3824 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
3825 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
3826 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003827 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003828 }
3829 if (pSurfaceFormats) {
3830 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
3831 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
3832 }
3833 }
3834 }
3835}
3836
3837void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
3838 uint32_t* pPropertyCount,
3839 VkDisplayPlanePropertiesKHR* pProperties,
3840 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003841 auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003842 if (bp_pd_data) {
3843 if (*pPropertyCount) {
3844 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
3845 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
3846 }
3847 }
3848 if (pProperties) {
3849 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
3850 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
3851 }
3852 }
3853 }
3854}
3855
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003856void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
3857 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
3858 VkResult result) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003859 auto swapchain_state = Get<bp_state::Swapchain>(swapchain);
Nathaniel Cesario39152e62021-07-02 13:04:16 -06003860 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
3861 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
3862 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003863 }
3864 }
3865}
3866
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003867void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
3868 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
3869
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003870 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003871 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003872 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003873 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben20da7a12022-02-25 14:07:46 -07003874 auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003875 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07003876 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003877 }
3878 }
3879 }
3880}