blob: ae0cff0efa248c5313add0d0d82b7347d39b090a [file] [log] [blame]
Gareth Webbdc6549a2021-06-16 03:52:24 +01001/* Copyright (c) 2015-2021 The Khronos Group Inc.
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002 * Copyright (c) 2015-2021 Valve Corporation
3 * Copyright (c) 2015-2021 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
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070040const std::map<BPVendorFlagBits, VendorSpecificInfo> kVendorInfo = {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060041 {kBPVendorArm, {vendor_specific_arm, "Arm"}},
Nadav Geva41c12a22021-05-21 13:14:05 -040042 {kBPVendorAMD, {vendor_specific_amd, "AMD"}},
Attilio Provenzano19d6a982020-02-27 12:41:41 +000043};
44
Hannes Harnisch607d1d92021-07-10 18:44:56 +020045const SpecialUseVUIDs kSpecialUseInstanceVUIDs {
46 kVUID_BestPractices_CreateInstance_SpecialUseExtension_CADSupport,
47 kVUID_BestPractices_CreateInstance_SpecialUseExtension_D3DEmulation,
48 kVUID_BestPractices_CreateInstance_SpecialUseExtension_DevTools,
49 kVUID_BestPractices_CreateInstance_SpecialUseExtension_Debugging,
50 kVUID_BestPractices_CreateInstance_SpecialUseExtension_GLEmulation,
51};
52
53const SpecialUseVUIDs kSpecialUseDeviceVUIDs {
54 kVUID_BestPractices_CreateDevice_SpecialUseExtension_CADSupport,
55 kVUID_BestPractices_CreateDevice_SpecialUseExtension_D3DEmulation,
56 kVUID_BestPractices_CreateDevice_SpecialUseExtension_DevTools,
57 kVUID_BestPractices_CreateDevice_SpecialUseExtension_Debugging,
58 kVUID_BestPractices_CreateDevice_SpecialUseExtension_GLEmulation,
59};
60
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060061std::shared_ptr<CMD_BUFFER_STATE> BestPractices::CreateCmdBufferState(VkCommandBuffer cb,
62 const VkCommandBufferAllocateInfo* pCreateInfo,
Jeremy Gebbencd7fa282021-10-27 10:25:32 -060063 const COMMAND_POOL_STATE* pool) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060064 return std::static_pointer_cast<CMD_BUFFER_STATE>(std::make_shared<CMD_BUFFER_STATE_BP>(this, cb, pCreateInfo, pool));
65}
66
67CMD_BUFFER_STATE_BP::CMD_BUFFER_STATE_BP(BestPractices* bp, VkCommandBuffer cb, const VkCommandBufferAllocateInfo* pCreateInfo,
Jeremy Gebbencd7fa282021-10-27 10:25:32 -060068 const COMMAND_POOL_STATE* pool)
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -060069 : CMD_BUFFER_STATE(bp, cb, pCreateInfo, pool) {}
70
Attilio Provenzano19d6a982020-02-27 12:41:41 +000071bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070072 for (const auto& vendor : kVendorInfo) {
Mark Lobodzinski90eea5b2020-05-15 12:54:00 -060073 if (vendors & vendor.first && enabled[vendor.second.vendor_id]) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000074 return true;
75 }
76 }
77 return false;
78}
79
80const char* VendorSpecificTag(BPVendorFlags vendors) {
81 // Cache built vendor tags in a map
Jeremy Gebbencbf22862021-03-03 12:01:22 -070082 static layer_data::unordered_map<BPVendorFlags, std::string> tag_map;
Attilio Provenzano19d6a982020-02-27 12:41:41 +000083
84 auto res = tag_map.find(vendors);
85 if (res == tag_map.end()) {
86 // Build the vendor tag string
87 std::stringstream vendor_tag;
88
89 vendor_tag << "[";
90 bool first_vendor = true;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -070091 for (const auto& vendor : kVendorInfo) {
Attilio Provenzano19d6a982020-02-27 12:41:41 +000092 if (vendors & vendor.first) {
93 if (!first_vendor) {
94 vendor_tag << ", ";
95 }
96 vendor_tag << vendor.second.name;
97 first_vendor = false;
98 }
99 }
100 vendor_tag << "]";
101
102 tag_map[vendors] = vendor_tag.str();
103 res = tag_map.find(vendors);
104 }
105
106 return res->second.c_str();
107}
108
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700109const char* DepReasonToString(ExtDeprecationReason reason) {
110 switch (reason) {
111 case kExtPromoted:
112 return "promoted to";
113 break;
114 case kExtObsoleted:
115 return "obsoleted by";
116 break;
117 case kExtDeprecated:
118 return "deprecated by";
119 break;
120 default:
121 return "";
122 break;
123 }
124}
125
126bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version,
127 const char* vuid) const {
128 bool skip = false;
129 auto dep_info_it = deprecated_extensions.find(extension_name);
130 if (dep_info_it != deprecated_extensions.end()) {
131 auto dep_info = dep_info_it->second;
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600132 if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) ||
133 ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2))) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700134 skip |=
135 LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
136 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
Mark Lobodzinski6a149702020-05-14 12:21:34 -0600137 } else if (dep_info.target.find("VK_VERSION") == std::string::npos) {
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700138 if (dep_info.target.length() == 0) {
139 skip |= LogWarning(instance, vuid,
140 "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated "
141 "without replacement.",
142 api_name, extension_name);
143 } else {
144 skip |= LogWarning(instance, vuid,
145 "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.",
146 api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str());
147 }
148 }
149 }
150 return skip;
151}
152
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200153bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const SpecialUseVUIDs& special_use_vuids) const
154{
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700155 bool skip = false;
156 auto dep_info_it = special_use_extensions.find(extension_name);
157
158 if (dep_info_it != special_use_extensions.end()) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200159 const char* const format = "%s(): Attempting to enable extension %s, but this extension is intended to support %s "
160 "and it is strongly recommended that it be otherwise avoided.";
161 auto& special_uses = dep_info_it->second;
162
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700163 if (special_uses.find("cadsupport") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200164 skip |= LogWarning(instance, special_use_vuids.cadsupport, format, api_name, extension_name,
165 "specialized functionality used by CAD/CAM applications");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700166 }
167 if (special_uses.find("d3demulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200168 skip |= LogWarning(instance, special_use_vuids.d3demulation, format, api_name, extension_name,
169 "D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700170 }
171 if (special_uses.find("devtools") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200172 skip |= LogWarning(instance, special_use_vuids.devtools, format, api_name, extension_name,
173 "developer tools such as capture-replay libraries");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700174 }
175 if (special_uses.find("debugging") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200176 skip |= LogWarning(instance, special_use_vuids.debugging, format, api_name, extension_name,
177 "use by applications when debugging");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700178 }
179 if (special_uses.find("glemulation") != std::string::npos) {
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200180 skip |= LogWarning(instance, special_use_vuids.glemulation, format, api_name, extension_name,
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700181 "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality "
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200182 "specific to those APIs");
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700183 }
Mark Lobodzinski057724a2020-11-09 17:13:18 -0700184 }
185 return skip;
186}
187
Nadav Gevaf0808442021-05-21 13:51:25 -0400188void BestPractices::InitDeviceValidationObject(bool add_obj, ValidationObject* inst_obj, ValidationObject* dev_obj) {
189 if (add_obj) {
190 ValidationStateTracker::InitDeviceValidationObject(add_obj, inst_obj, dev_obj);
191 }
192}
193
194
Camden5b184be2019-08-13 07:50:19 -0600195bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500196 VkInstance* pInstance) const {
Camden5b184be2019-08-13 07:50:19 -0600197 bool skip = false;
198
199 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
200 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800201 skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700202 "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.",
203 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600204 }
Mark Lobodzinski17d8dc62020-06-03 08:48:58 -0600205 uint32_t specified_version =
206 (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0);
207 skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700208 kVUID_BestPractices_CreateInstance_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200209 skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseInstanceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600210 }
211
212 return skip;
213}
214
Camden5b184be2019-08-13 07:50:19 -0600215bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500216 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const {
Camden5b184be2019-08-13 07:50:19 -0600217 bool skip = false;
218
219 // get API version of physical device passed when creating device.
220 VkPhysicalDeviceProperties physical_device_properties{};
221 DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties);
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500222 auto device_api_version = physical_device_properties.apiVersion;
Camden5b184be2019-08-13 07:50:19 -0600223
224 // check api versions and warn if instance api Version is higher than version on device.
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600225 if (api_version > device_api_version) {
226 std::string inst_api_name = StringAPIVersion(api_version);
Mark Lobodzinski60880782020-08-11 08:02:07 -0600227 std::string dev_api_name = StringAPIVersion(device_api_version);
Camden5b184be2019-08-13 07:50:19 -0600228
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700229 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch,
230 "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s",
231 inst_api_name.c_str(), dev_api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -0600232 }
233
234 for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) {
235 if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kInstanceExtensionNames)) {
Camden Stocker11ecf512020-01-21 16:06:49 -0800236 skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700237 "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.",
238 pCreateInfo->ppEnabledExtensionNames[i]);
Camden5b184be2019-08-13 07:50:19 -0600239 }
Jeremy Gebben404f6ac2021-10-28 12:33:28 -0600240 skip |= ValidateDeprecatedExtensions("CreateDevice", pCreateInfo->ppEnabledExtensionNames[i], api_version,
Mark Lobodzinski6167e102020-02-24 17:03:55 -0700241 kVUID_BestPractices_CreateDevice_DeprecatedExtension);
Hannes Harnisch607d1d92021-07-10 18:44:56 +0200242 skip |= ValidateSpecialUseExtensions("CreateDevice", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseDeviceVUIDs);
Camden5b184be2019-08-13 07:50:19 -0600243 }
244
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600245 const auto bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600246 if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700247 skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled,
248 "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures().");
Camden83a9c372019-08-14 11:41:38 -0600249 }
250
Nadav Gevaf0808442021-05-21 13:51:25 -0400251 if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorAMD)) && (pCreateInfo->pEnabledFeatures != nullptr) &&
Szilard Papp7d2c7952020-06-22 14:38:13 +0100252 (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
253 skip |= LogPerformanceWarning(
254 device, kVUID_BestPractices_CreateDevice_RobustBufferAccess,
Nadav Gevaf0808442021-05-21 13:51:25 -0400255 "%s %s vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during "
Szilard Papp7d2c7952020-06-22 14:38:13 +0100256 "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage "
257 "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case "
258 "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.",
Nadav Gevaf0808442021-05-21 13:51:25 -0400259 VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorAMD));
Szilard Papp7d2c7952020-06-22 14:38:13 +0100260 }
261
Camden5b184be2019-08-13 07:50:19 -0600262 return skip;
263}
264
265bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500266 const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const {
Camden5b184be2019-08-13 07:50:19 -0600267 bool skip = false;
268
269 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700270 std::stringstream buffer_hex;
271 buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer);
Camden5b184be2019-08-13 07:50:19 -0600272
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700273 skip |= LogWarning(
274 device, kVUID_BestPractices_SharingModeExclusive,
275 "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
276 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700277 buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600278 }
279
280 return skip;
281}
282
283bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500284 const VkAllocationCallbacks* pAllocator, VkImage* pImage) const {
Camden5b184be2019-08-13 07:50:19 -0600285 bool skip = false;
286
287 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700288 std::stringstream image_hex;
289 image_hex << "0x" << std::hex << HandleToUint64(pImage);
Camden5b184be2019-08-13 07:50:19 -0600290
291 skip |=
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700292 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
293 "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues "
294 "(queueFamilyIndexCount of %" PRIu32 ").",
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700295 image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600296 }
297
Attilio Provenzano02859b22020-02-27 14:17:28 +0000298 if (VendorCheckEnabled(kBPVendorArm)) {
299 if (pCreateInfo->samples > kMaxEfficientSamplesArm) {
300 skip |= LogPerformanceWarning(
301 device, kVUID_BestPractices_CreateImage_TooLargeSampleCount,
302 "%s vkCreateImage(): Trying to create an image with %u samples. "
303 "The hardware revision may not have full throughput for framebuffers with more than %u samples.",
304 VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm);
305 }
306
307 if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) {
308 skip |= LogPerformanceWarning(
309 device, kVUID_BestPractices_CreateImage_NonTransientMSImage,
310 "%s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have "
311 "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, "
312 "and do not need to be backed by physical storage. "
313 "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.",
314 VendorSpecificTag(kBPVendorArm));
315 }
316 }
317
Nadav Gevaf0808442021-05-21 13:51:25 -0400318 if (VendorCheckEnabled(kBPVendorAMD)) {
319 std::stringstream image_hex;
320 image_hex << "0x" << std::hex << HandleToUint64(pImage);
321
322 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
323 (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) {
324 skip |= LogPerformanceWarning(device,
325 kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets,
326 "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. "
327 "Using a SHARING_MODE_CONCURRENT "
328 "is not recommended with color and depth targets",
329 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
330 }
331
332 if ((pCreateInfo->usage &
333 (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
334 (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) {
335 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets,
336 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. "
337 "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets",
338 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
339 }
340
341 if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) &&
342 (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
343 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets,
344 "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a "
345 "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets",
346 VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str());
347 }
348 }
349
Camden5b184be2019-08-13 07:50:19 -0600350 return skip;
351}
352
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +0100353void BestPractices::PreCallRecordDestroyImage(VkDevice device, VkImage image, const VkAllocationCallbacks *pAllocator) {
354 ValidationStateTracker::PreCallRecordDestroyImage(device, image, pAllocator);
355 ReleaseImageUsageState(image);
356}
357
Hans-Kristian Arntzen92664eb2021-03-29 12:19:48 +0200358void BestPractices::PreCallRecordDestroySwapchainKHR(VkDevice device, VkSwapchainKHR swapchain, const VkAllocationCallbacks* pAllocator) {
Tony-LunarG299187b2021-05-28 09:29:12 -0600359 if (VK_NULL_HANDLE != swapchain) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600360 auto chain = Get<SWAPCHAIN_NODE>(swapchain);
Tony-LunarG299187b2021-05-28 09:29:12 -0600361 for (auto& image : chain->images) {
362 if (image.image_state) {
363 ReleaseImageUsageState(image.image_state->image());
364 }
365 }
Hans-Kristian Arntzen92664eb2021-03-29 12:19:48 +0200366 }
367 ValidationStateTracker::PreCallRecordDestroySwapchainKHR(device, swapchain, pAllocator);
368}
369
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +0100370IMAGE_STATE_BP* BestPractices::GetImageUsageState(VkImage vk_image) {
371 auto itr = imageUsageMap.find(vk_image);
372 if (itr != imageUsageMap.end()) {
373 return &itr->second;
374 } else {
375 auto& state = imageUsageMap[vk_image];
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600376 auto image = Get<IMAGE_STATE>(vk_image);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +0100377 state.image = image;
378 state.usages.resize(image->createInfo.arrayLayers);
379 for (auto& mips : state.usages) {
380 mips.resize(image->createInfo.mipLevels, IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED);
381 }
382 return &state;
383 }
384}
385
386void BestPractices::ReleaseImageUsageState(VkImage image) {
387 auto itr = imageUsageMap.find(image);
388 if (itr != imageUsageMap.end()) {
389 imageUsageMap.erase(itr);
390 }
391}
392
Camden5b184be2019-08-13 07:50:19 -0600393bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500394 const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const {
Camden5b184be2019-08-13 07:50:19 -0600395 bool skip = false;
396
Jeremy Gebben383b9a32021-09-08 16:31:33 -0600397 const auto* bp_pd_state = GetPhysicalDeviceState();
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600398 if (bp_pd_state) {
399 if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) {
400 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
401 "vkCreateSwapchainKHR() called before getting surface capabilities from "
402 "vkGetPhysicalDeviceSurfaceCapabilitiesKHR().");
403 }
Camden83a9c372019-08-14 11:41:38 -0600404
Shannon McPherson73e58c82021-03-05 17:14:26 -0700405 if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) &&
406 (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600407 skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
408 "vkCreateSwapchainKHR() called before getting surface present mode(s) from "
409 "vkGetPhysicalDeviceSurfacePresentModesKHR().");
410 }
Camden83a9c372019-08-14 11:41:38 -0600411
Nathaniel Cesario24184fe2020-10-06 12:46:12 -0600412 if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) {
413 skip |= LogWarning(
414 device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled,
415 "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR().");
416 }
Camden83a9c372019-08-14 11:41:38 -0600417 }
418
Camden5b184be2019-08-13 07:50:19 -0600419 if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700420 skip |=
421 LogWarning(device, kVUID_BestPractices_SharingModeExclusive,
Mark Lobodzinski019f4e32020-04-13 11:01:35 -0600422 "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while "
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700423 "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").",
424 pCreateInfo->queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600425 }
426
Szilard Papp48a6da32020-06-10 14:41:59 +0100427 if (pCreateInfo->minImageCount == 2) {
428 skip |= LogPerformanceWarning(
429 device, kVUID_BestPractices_SuboptimalSwapchainImageCount,
430 "Warning: A Swapchain is being created with minImageCount set to %" PRIu32
431 ", which means double buffering is going "
432 "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, "
433 "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to "
434 "3 to use triple buffering to maximize performance in such cases.",
435 pCreateInfo->minImageCount);
436 }
437
Szilard Pappd5f0f812020-06-22 09:01:29 +0100438 if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) {
439 skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode,
440 "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". "
441 "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. "
442 "Presentation modes which are not FIFO will present the latest available frame and discard other "
443 "frame(s) if any.",
444 VendorSpecificTag(kBPVendorArm));
445 }
446
Camden5b184be2019-08-13 07:50:19 -0600447 return skip;
448}
449
450bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount,
451 const VkSwapchainCreateInfoKHR* pCreateInfos,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500452 const VkAllocationCallbacks* pAllocator,
453 VkSwapchainKHR* pSwapchains) const {
Camden5b184be2019-08-13 07:50:19 -0600454 bool skip = false;
455
456 for (uint32_t i = 0; i < swapchainCount; i++) {
457 if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700458 skip |= LogWarning(
459 device, kVUID_BestPractices_SharingModeExclusive,
460 "Warning: A shared swapchain (index %" PRIu32
461 ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple "
462 "queues (queueFamilyIndexCount of %" PRIu32 ").",
463 i, pCreateInfos[i].queueFamilyIndexCount);
Camden5b184be2019-08-13 07:50:19 -0600464 }
465 }
466
467 return skip;
468}
469
470bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500471 const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const {
Camden5b184be2019-08-13 07:50:19 -0600472 bool skip = false;
473
474 for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) {
475 VkFormat format = pCreateInfo->pAttachments[i].format;
476 if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) {
477 if ((FormatIsColor(format) || FormatHasDepth(format)) &&
478 pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700479 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
480 "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and "
481 "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
482 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
483 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600484 }
485 if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -0700486 skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment,
487 "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD "
488 "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you "
489 "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the "
490 "image truely is undefined at the start of the render pass.");
Camden5b184be2019-08-13 07:50:19 -0600491 }
492 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000493
494 const auto& attachment = pCreateInfo->pAttachments[i];
495 if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) {
496 bool access_requires_memory =
497 attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE;
498
499 if (FormatHasStencil(format)) {
500 access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
501 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE;
502 }
503
504 if (access_requires_memory) {
505 skip |= LogPerformanceWarning(
506 device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory,
507 "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp "
508 "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, "
509 "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.",
510 i, static_cast<uint32_t>(attachment.samples));
511 }
512 }
Camden5b184be2019-08-13 07:50:19 -0600513 }
514
515 for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) {
516 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask);
517 skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask);
518 }
519
520 return skip;
521}
522
Tony-LunarG767180f2020-04-23 14:03:59 -0600523bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount,
524 const VkImageView* image_views) const {
525 bool skip = false;
526
527 // Check for non-transient attachments that should be transient and vice versa
528 for (uint32_t i = 0; i < attachmentCount; ++i) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200529 const auto& attachment = rpci->pAttachments[i];
Tony-LunarG767180f2020-04-23 14:03:59 -0600530 bool attachment_should_be_transient =
531 (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE);
532
533 if (FormatHasStencil(attachment.format)) {
534 attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD &&
535 attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE);
536 }
537
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600538 auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]);
Tony-LunarG767180f2020-04-23 14:03:59 -0600539 if (view_state) {
Jeremy Gebben057f9d52021-11-05 14:12:31 -0600540 const auto& ici = view_state->image_state->createInfo;
Tony-LunarG767180f2020-04-23 14:03:59 -0600541
542 bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0;
543
544 // The check for an image that should not be transient applies to all GPUs
545 if (!attachment_should_be_transient && image_is_transient) {
546 skip |= LogPerformanceWarning(
547 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient,
548 "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, "
549 "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
550 "Physical memory will need to be backed lazily to this image, potentially causing stalls.",
551 i);
552 }
553
554 bool supports_lazy = false;
555 for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) {
556 if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) {
557 supports_lazy = true;
558 }
559 }
560
561 // The check for an image that should be transient only applies to GPUs supporting
562 // lazily allocated memory
563 if (supports_lazy && attachment_should_be_transient && !image_is_transient) {
564 skip |= LogPerformanceWarning(
565 device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient,
566 "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, "
567 "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. "
568 "You can save physical memory by using transient attachment backed by lazily allocated memory here.",
569 i);
570 }
571 }
572 }
573 return skip;
574}
575
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000576bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo,
577 const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const {
578 bool skip = false;
579
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600580 auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass);
Mike Schuchardt2df08912020-12-15 16:28:09 -0800581 if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) {
Tony-LunarG767180f2020-04-23 14:03:59 -0600582 skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000583 }
584
585 return skip;
586}
587
Sam Wallse746d522020-03-16 21:20:23 +0000588bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
589 VkDescriptorSet* pDescriptorSets, void* ads_state_data) const {
590 bool skip = false;
591 skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data);
592
593 if (!skip) {
594 const auto& pool_handle = pAllocateInfo->descriptorPool;
595 auto iter = descriptor_pool_freed_count.find(pool_handle);
596 // if the number of freed sets > 0, it implies they could be recycled instead if desirable
597 // this warning is specific to Arm
598 if (VendorCheckEnabled(kBPVendorArm) && iter != descriptor_pool_freed_count.end() && iter->second > 0) {
599 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 }
605 }
606
607 return skip;
608}
609
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600610void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo,
611 VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) {
Sam Wallse746d522020-03-16 21:20:23 +0000612 if (result == VK_SUCCESS) {
613 // find the free count for the pool we allocated into
614 auto iter = descriptor_pool_freed_count.find(pAllocateInfo->descriptorPool);
615 if (iter != descriptor_pool_freed_count.end()) {
616 // we record successful allocations by subtracting the allocation count from the last recorded free count
617 const auto alloc_count = pAllocateInfo->descriptorSetCount;
618 // clamp the unsigned subtraction to the range [0, last_free_count]
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700619 if (iter->second > alloc_count) {
Sam Wallse746d522020-03-16 21:20:23 +0000620 iter->second -= alloc_count;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700621 } else {
Sam Wallse746d522020-03-16 21:20:23 +0000622 iter->second = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700623 }
Sam Wallse746d522020-03-16 21:20:23 +0000624 }
625 }
626}
627
628void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount,
629 const VkDescriptorSet* pDescriptorSets, VkResult result) {
630 ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result);
631 if (result == VK_SUCCESS) {
632 // we want to track frees because we're interested in suggesting re-use
633 auto iter = descriptor_pool_freed_count.find(descriptorPool);
634 if (iter == descriptor_pool_freed_count.end()) {
Jeremy Gebbencbf22862021-03-03 12:01:22 -0700635 descriptor_pool_freed_count.emplace(descriptorPool, descriptorSetCount);
Sam Wallse746d522020-03-16 21:20:23 +0000636 } else {
637 iter->second += descriptorSetCount;
638 }
639 }
640}
641
Camden5b184be2019-08-13 07:50:19 -0600642bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -0500643 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const {
Camden5b184be2019-08-13 07:50:19 -0600644 bool skip = false;
645
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500646 if (num_mem_objects + 1 > kMemoryObjectWarningLimit) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700647 skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects,
648 "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit);
Camden5b184be2019-08-13 07:50:19 -0600649 }
650
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000651 if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) {
652 skip |= LogPerformanceWarning(
653 device, kVUID_BestPractices_AllocateMemory_SmallAllocation,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -0600654 "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current "
655 "threshold is %" PRIu64 " bytes). "
Attilio Provenzanof31788e2020-02-27 12:00:36 +0000656 "You should make large allocations and sub-allocate from one large VkDeviceMemory.",
657 pAllocateInfo->allocationSize, kMinDeviceAllocationSize);
658 }
659
Camden83a9c372019-08-14 11:41:38 -0600660 // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker
661
662 return skip;
663}
664
Mark Lobodzinski84101d72020-04-24 09:43:48 -0600665void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo,
666 const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory,
667 VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700668 if (result != VK_SUCCESS) {
669 static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY,
670 VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE,
Mike Schuchardt2df08912020-12-15 16:28:09 -0800671 VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS};
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700672 static std::vector<VkResult> success_codes = {};
Nathaniel Cesariodb3f43f2021-05-12 09:08:23 -0600673 ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes);
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700674 return;
675 }
676 num_mem_objects++;
677}
Camden Stocker9738af92019-10-16 13:54:03 -0700678
Mark Lobodzinskide15e582020-04-29 08:06:00 -0600679void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes,
680 const std::vector<VkResult>& success_codes) const {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700681 auto error = std::find(error_codes.begin(), error_codes.end(), result);
682 if (error != error_codes.end()) {
Gareth Webb586c46b2021-01-13 11:17:22 +0000683 static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR,
684 VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT};
685
686 auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result);
687 if (common_failure != common_failure_codes.end()) {
688 LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
689 } else {
690 LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result));
691 }
Mark Lobodzinski205b7a02020-02-21 13:23:17 -0700692 return;
693 }
694 auto success = std::find(success_codes.begin(), success_codes.end(), result);
695 if (success != success_codes.end()) {
Mark Lobodzinskie7215152020-05-11 08:21:23 -0600696 LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name,
697 string_VkResult(result));
Jeff Bolz46c0ea02019-10-09 13:06:29 -0500698 }
699}
700
Jeff Bolz5c801d12019-10-09 10:38:45 -0500701bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory,
702 const VkAllocationCallbacks* pAllocator) const {
Mark Lobodzinski91e50bf2020-01-14 09:55:11 -0700703 if (memory == VK_NULL_HANDLE) return false;
Camden83a9c372019-08-14 11:41:38 -0600704 bool skip = false;
705
Jeremy Gebbenb20a8242021-11-05 15:14:43 -0600706 const auto mem_info = Get<DEVICE_MEMORY_STATE>(memory);
Camden83a9c372019-08-14 11:41:38 -0600707
Jeremy Gebben5570abe2021-05-16 18:35:13 -0600708 for (const auto& node: mem_info->ObjectBindings()) {
709 const auto& obj = node->Handle();
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600710 LogObjectList objlist(device);
711 objlist.add(obj);
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -0600712 objlist.add(mem_info->mem());
Mark Lobodzinski818425a2020-03-16 18:19:03 -0600713 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 -0600714 report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str());
Camden83a9c372019-08-14 11:41:38 -0600715 }
716
Camden5b184be2019-08-13 07:50:19 -0600717 return skip;
718}
719
720void BestPractices::PreCallRecordFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks* pAllocator) {
Mark Lobodzinski97484d62020-03-03 11:57:41 -0700721 ValidationStateTracker::PreCallRecordFreeMemory(device, memory, pAllocator);
Camden5b184be2019-08-13 07:50:19 -0600722 if (memory != VK_NULL_HANDLE) {
723 num_mem_objects--;
724 }
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 Gebbenb20a8242021-11-05 15:14:43 -0600729 const 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 Gebbenb20a8242021-11-05 15:14:43 -0600737 const 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 Gebbenb20a8242021-11-05 15:14:43 -0600790 const 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 Gebbenb20a8242021-11-05 15:14:43 -0600803 const 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
947 pipeline_cache = pipelineCache;
948}
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);
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600956 create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
Camden5b184be2019-08-13 07:50:19 -0600957
958 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -0700959 skip |= LogPerformanceWarning(
960 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
961 "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a "
962 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -0600963 }
964
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000965 for (uint32_t i = 0; i < createInfoCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200966 const auto& create_info = pCreateInfos[i];
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000967
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600968 if (!(cgpl_state->pipe_state[i]->active_shaders & VK_SHADER_STAGE_MESH_BIT_NV)) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +0200969 const auto& vertex_input = *create_info.pVertexInputState;
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600970 uint32_t count = 0;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -0700971 for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) {
972 if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) {
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600973 count++;
974 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000975 }
Mark Lobodzinski8dd14d82020-04-10 14:16:33 -0600976 if (count > kMaxInstancedVertexBuffers) {
977 skip |= LogPerformanceWarning(
978 device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers,
979 "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the "
980 "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.",
981 count, kMaxInstancedVertexBuffers);
982 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000983 }
Attilio Provenzano02859b22020-02-27 14:17:28 +0000984
Szilard Pappaaf2da32020-06-22 10:37:35 +0100985 if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) &&
986 (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +0200987 (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) &&
988 VendorCheckEnabled(kBPVendorArm)) {
989 skip |= LogPerformanceWarning(
990 device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero,
991 "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true "
992 "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced "
993 "efficiency during rasterization. Consider disabling depthBias or increasing either "
994 "depthBiasConstantFactor or depthBiasSlopeFactor.",
995 VendorSpecificTag(kBPVendorArm));
Szilard Pappaaf2da32020-06-22 10:37:35 +0100996 }
997
Attilio Provenzano02859b22020-02-27 14:17:28 +0000998 skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +0000999 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001000 if (VendorCheckEnabled(kBPVendorAMD)) {
1001 if (pipelineCache && pipeline_cache && pipelineCache != pipeline_cache) {
1002 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches,
1003 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
1004 "improve cache hit rate", VendorSpecificTag(kBPVendorAMD));
1005 }
1006
1007 if (num_pso > kMaxRecommendedNumberOfPSOAMD) {
1008 skip |=
1009 LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines,
1010 "%s Performance warning: Too many pipelines created, consider consolidation",
1011 VendorSpecificTag(kBPVendorAMD));
1012 }
1013
Nathaniel Cesario1a7e1a92021-08-30 14:34:20 -06001014 if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) {
Nadav Gevaf0808442021-05-21 13:51:25 -04001015 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart,
1016 "%s Performance warning: Use of primitive restart is not recommended",
1017 VendorSpecificTag(kBPVendorAMD));
1018 }
1019
1020 // TODO: this might be too aggressive of a check
1021 if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) {
1022 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates,
1023 "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed",
1024 VendorSpecificTag(kBPVendorAMD));
1025 }
1026 }
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00001027
Camden5b184be2019-08-13 07:50:19 -06001028 return skip;
1029}
1030
Hans-Kristian Arntzenb033ab12021-06-16 11:16:59 +02001031void BestPractices::PreCallRecordDestroyPipeline(VkDevice device, VkPipeline pipeline, const VkAllocationCallbacks *pAllocator)
1032{
1033 auto itr = graphicsPipelineCIs.find(pipeline);
1034 if (itr != graphicsPipelineCIs.end()) {
1035 graphicsPipelineCIs.erase(itr);
1036 }
1037 ValidationStateTracker::PreCallRecordDestroyPipeline(device, pipeline, pAllocator);
1038}
1039
Sam Walls0961ec02020-03-31 16:39:15 +01001040void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count,
1041 const VkGraphicsPipelineCreateInfo* pCreateInfos,
1042 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
1043 VkResult result, void* cgpl_state_data) {
1044 for (size_t i = 0; i < count; i++) {
1045 const auto* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data);
1046 const VkPipeline pipeline_handle = pPipelines[i];
1047
1048 // record depth stencil state and color blend states for depth pre-pass tracking purposes
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001049 GraphicsPipelineCIs& cis = graphicsPipelineCIs[pipeline_handle];
Sam Walls0961ec02020-03-31 16:39:15 +01001050
Hans-Kristian Arntzen42c0ef52021-06-14 14:46:25 +02001051 auto& create_info = cgpl_state->pCreateInfos[i];
Hans-Kristian Arntzen42c0ef52021-06-14 14:46:25 +02001052
Jeremy Gebben396d06a2021-08-12 11:03:04 -06001053 if (create_info.pColorBlendState) {
1054 cis.colorBlendStateCI.emplace(create_info.pColorBlendState);
1055 }
1056
1057 if (create_info.pDepthStencilState) {
1058 cis.depthStencilStateCI.emplace(create_info.pDepthStencilState);
1059 }
Jeremy Gebben81b5b792021-11-11 14:54:53 -07001060 if (create_info.renderPass == VK_NULL_HANDLE) {
1061 // TODO: this is necessary to avoid crashing
1062 LogWarning(device, kVUID_BestPractices_DynamicRendering_NotSupported,
1063 "vkCreateGraphicsPipelines: pCreateInfos[%" PRIu32 "].renderPass is VK_NULL_HANDLE, VK_KHR_dynamic_rendering is not supported.\n",
1064 static_cast<uint32_t>(i));
1065 continue;
1066 }
Hans-Kristian Arntzen42c0ef52021-06-14 14:46:25 +02001067 // Record which frame buffer attachments we should consider to be accessed when a draw call is performed.
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001068 auto rp = Get<RENDER_PASS_STATE>(create_info.renderPass);
Hans-Kristian Arntzen42c0ef52021-06-14 14:46:25 +02001069 auto& subpass = rp->createInfo.pSubpasses[create_info.subpass];
1070 cis.accessFramebufferAttachments.clear();
1071
1072 if (cis.colorBlendStateCI) {
Hans-Kristian Arntzenc2742e72021-07-01 14:31:06 +02001073 // According to spec, pColorBlendState must be ignored if subpass does not have color attachments.
1074 uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, cis.colorBlendStateCI->attachmentCount);
1075 for (uint32_t j = 0; j < num_color_attachments; j++) {
Hans-Kristian Arntzen42c0ef52021-06-14 14:46:25 +02001076 if (cis.colorBlendStateCI->pAttachments[j].colorWriteMask != 0) {
1077 uint32_t attachment = subpass.pColorAttachments[j].attachment;
1078 if (attachment != VK_ATTACHMENT_UNUSED) {
1079 cis.accessFramebufferAttachments.push_back({ attachment, VK_IMAGE_ASPECT_COLOR_BIT });
1080 }
1081 }
1082 }
1083 }
1084
1085 if (cis.depthStencilStateCI && (cis.depthStencilStateCI->depthTestEnable ||
1086 cis.depthStencilStateCI->depthBoundsTestEnable ||
1087 cis.depthStencilStateCI->stencilTestEnable)) {
1088 uint32_t attachment = subpass.pDepthStencilAttachment ?
1089 subpass.pDepthStencilAttachment->attachment :
1090 VK_ATTACHMENT_UNUSED;
1091 if (attachment != VK_ATTACHMENT_UNUSED) {
1092 VkImageAspectFlags aspects = 0;
1093 if (cis.depthStencilStateCI->depthTestEnable || cis.depthStencilStateCI->depthBoundsTestEnable) {
1094 aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
1095 }
1096 if (cis.depthStencilStateCI->stencilTestEnable) {
1097 aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
1098 }
1099 cis.accessFramebufferAttachments.push_back({ attachment, aspects });
1100 }
1101 }
Sam Walls0961ec02020-03-31 16:39:15 +01001102 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001103
1104 // AMD best practice
1105 pipeline_cache = pipelineCache;
Sam Walls0961ec02020-03-31 16:39:15 +01001106}
1107
Camden5b184be2019-08-13 07:50:19 -06001108bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
1109 const VkComputePipelineCreateInfo* pCreateInfos,
Mark Lobodzinski2a162a02019-09-06 11:02:12 -06001110 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001111 void* ccpl_state_data) const {
Mark Lobodzinski8317a3e2019-09-20 10:07:08 -06001112 bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos,
1113 pAllocator, pPipelines, ccpl_state_data);
Camden5b184be2019-08-13 07:50:19 -06001114
1115 if ((createInfoCount > 1) && (!pipelineCache)) {
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001116 skip |= LogPerformanceWarning(
1117 device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1118 "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a "
1119 "pipeline cache, which may help with performance");
Camden5b184be2019-08-13 07:50:19 -06001120 }
1121
Nadav Gevaf0808442021-05-21 13:51:25 -04001122 if (VendorCheckEnabled(kBPVendorAMD)) {
1123 if (pipelineCache && pipeline_cache && pipelineCache != pipeline_cache) {
1124 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelines,
1125 "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to "
1126 "improve cache hit rate",
1127 VendorSpecificTag(kBPVendorAMD));
1128 }
1129 }
1130
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001131 if (VendorCheckEnabled(kBPVendorArm)) {
1132 for (size_t i = 0; i < createInfoCount; i++) {
1133 skip |= ValidateCreateComputePipelineArm(pCreateInfos[i]);
1134 }
1135 }
1136
1137 return skip;
1138}
1139
1140bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const {
1141 bool skip = false;
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001142 auto module = Get<SHADER_MODULE_STATE>(createInfo.stage.module);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001143 // Generate warnings about work group sizes based on active resources.
sfricke-samsung962cad92021-04-13 00:46:29 -07001144 auto entrypoint = module->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage);
sfricke-samsung8a7341a2021-02-28 07:30:21 -08001145 if (entrypoint == module->end()) return false;
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001146
1147 uint32_t x = 1, y = 1, z = 1;
sfricke-samsung962cad92021-04-13 00:46:29 -07001148 module->FindLocalSize(entrypoint, x, y, z);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001149
1150 uint32_t thread_count = x * y * z;
1151
1152 // Generate a priori warnings about work group sizes.
1153 if (thread_count > kMaxEfficientWorkGroupThreadCountArm) {
1154 skip |= LogPerformanceWarning(
1155 device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize,
1156 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, "
1157 "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work "
1158 "groups with less than %u threads, especially when using barrier() or shared memory.",
1159 VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm);
1160 }
1161
1162 if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1163 ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) ||
1164 ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) {
1165 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment,
1166 "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, "
1167 "%u, %u) is not aligned to %u "
1168 "threads. On Arm Mali architectures, not aligning work group sizes to %u may "
1169 "leave threads idle on the shader "
1170 "core.",
1171 VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm,
1172 kThreadGroupDispatchCountAlignmentArm);
1173 }
1174
sfricke-samsung962cad92021-04-13 00:46:29 -07001175 auto accessible_ids = module->MarkAccessibleIds(entrypoint);
Jeremy Gebben84b838b2021-08-23 08:41:39 -06001176 auto descriptor_uses = module->CollectInterfaceByDescriptorSlot(accessible_ids);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001177
1178 unsigned dimensions = 0;
1179 if (x > 1) dimensions++;
1180 if (y > 1) dimensions++;
1181 if (z > 1) dimensions++;
1182 // Here the dimension will really depend on the dispatch grid, but assume it's 1D.
1183 dimensions = std::max(dimensions, 1u);
1184
1185 // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons.
1186 // There are some false positives here. We could simply have a shader that does this within a 1D grid,
1187 // or we may have a linearly tiled image, but these cases are quite unlikely in practice.
1188 bool accesses_2d = false;
1189 for (const auto& usage : descriptor_uses) {
sfricke-samsung962cad92021-04-13 00:46:29 -07001190 auto dim = module->GetShaderResourceDimensionality(usage.second);
Sam Wallsd7ab6db2020-06-19 20:41:54 +01001191 if (dim < 0) continue;
1192 auto spvdim = spv::Dim(dim);
1193 if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true;
1194 }
1195
1196 if (accesses_2d && dimensions < 2) {
1197 LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality,
1198 "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which "
1199 "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be "
1200 "exhibiting poor spatial locality with respect to one or more shader resources.",
1201 VendorSpecificTag(kBPVendorArm), x, y, z);
1202 }
1203
Camden5b184be2019-08-13 07:50:19 -06001204 return skip;
1205}
1206
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001207bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const {
Camden5b184be2019-08-13 07:50:19 -06001208 bool skip = false;
1209
1210 if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001211 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1212 "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001213 } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07001214 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1215 "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str());
Camden5b184be2019-08-13 07:50:19 -06001216 }
1217
1218 return skip;
1219}
1220
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001221bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const {
1222 bool skip = false;
1223
1224 if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) {
1225 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1226 "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str());
1227 } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) {
1228 skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags,
1229 "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str());
1230 }
1231
1232 return skip;
1233}
1234
1235bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const {
1236 bool skip = false;
1237 auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info);
1238
1239 skip |= CheckPipelineStageFlags(api_name, stage_masks.src);
1240 skip |= CheckPipelineStageFlags(api_name, stage_masks.dst);
1241
1242 return skip;
1243}
1244
Mark Lobodzinski84101d72020-04-24 09:43:48 -06001245void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) {
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001246 for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) {
1247 auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result;
1248 if (swapchains_result == VK_SUBOPTIMAL_KHR) {
1249 LogPerformanceWarning(
1250 pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain,
1251 "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, "
1252 "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it "
1253 "targets. Applications should query updated surface information and recreate their swapchain at the next "
1254 "convenient opportunity.",
1255 report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str());
1256 }
1257 }
Nadav Gevaf0808442021-05-21 13:51:25 -04001258
1259 // AMD best practice
1260 // end-of-frame cleanup
1261 num_queue_submissions = 0;
1262 num_barriers_objects = 0;
1263 pipelines_used_in_frame.clear();
Mark Lobodzinski9b133c12020-03-10 10:42:56 -06001264}
1265
Jeff Bolz5c801d12019-10-09 10:38:45 -05001266bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
1267 VkFence fence) const {
Camden5b184be2019-08-13 07:50:19 -06001268 bool skip = false;
1269
1270 for (uint32_t submit = 0; submit < submitCount; submit++) {
1271 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) {
1272 skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]);
1273 }
1274 }
1275
1276 return skip;
1277}
1278
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001279bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits,
1280 VkFence fence) const {
1281 bool skip = false;
1282
1283 for (uint32_t submit = 0; submit < submitCount; submit++) {
1284 for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) {
1285 skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask);
1286 }
1287 }
1288
1289 return skip;
1290}
1291
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001292bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo,
1293 const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const {
1294 bool skip = false;
1295
1296 if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) {
1297 skip |= LogPerformanceWarning(
1298 device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset,
1299 "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire "
1300 "pool instead.");
1301 }
1302
1303 return skip;
1304}
1305
1306bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer,
1307 const VkCommandBufferBeginInfo* pBeginInfo) const {
1308 bool skip = false;
1309
1310 if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) {
1311 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse,
1312 "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set.");
1313 }
1314
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001315 if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) {
1316 skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit,
Attilio Provenzano02859b22020-02-27 14:17:28 +00001317 "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. "
1318 "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.",
1319 VendorSpecificTag(kBPVendorArm));
1320 }
1321
Attilio Provenzano746e43e2020-02-27 11:23:50 +00001322 return skip;
1323}
1324
Jeff Bolz5c801d12019-10-09 10:38:45 -05001325bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001326 bool skip = false;
1327
1328 skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask);
1329
1330 return skip;
1331}
1332
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001333bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1334 const VkDependencyInfoKHR* pDependencyInfo) const {
1335 return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo);
1336}
1337
Jeff Bolz5c801d12019-10-09 10:38:45 -05001338bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event,
1339 VkPipelineStageFlags stageMask) const {
Camden5b184be2019-08-13 07:50:19 -06001340 bool skip = false;
1341
1342 skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask);
1343
1344 return skip;
1345}
1346
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001347bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event,
1348 VkPipelineStageFlags2KHR stageMask) const {
1349 bool skip = false;
1350
1351 skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask);
1352
1353 return skip;
1354}
1355
Camden5b184be2019-08-13 07:50:19 -06001356bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1357 VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask,
1358 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1359 uint32_t bufferMemoryBarrierCount,
1360 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1361 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001362 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001363 bool skip = false;
1364
1365 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask);
1366 skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask);
1367
1368 return skip;
1369}
1370
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001371bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents,
1372 const VkDependencyInfoKHR* pDependencyInfos) const {
1373 bool skip = false;
1374 for (uint32_t i = 0; i < eventCount; i++) {
1375 skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]);
1376 }
1377
1378 return skip;
1379}
1380
Camden5b184be2019-08-13 07:50:19 -06001381bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
1382 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
1383 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
1384 uint32_t bufferMemoryBarrierCount,
1385 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
1386 uint32_t imageMemoryBarrierCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001387 const VkImageMemoryBarrier* pImageMemoryBarriers) const {
Camden5b184be2019-08-13 07:50:19 -06001388 bool skip = false;
1389
1390 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask);
1391 skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask);
1392
Nadav Gevaf0808442021-05-21 13:51:25 -04001393 if (VendorCheckEnabled(kBPVendorAMD)) {
1394 if (num_barriers_objects + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) {
1395 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount,
1396 "%s Performance warning: In this frame, %" PRIu32 " barriers were already submitted. Barriers have a high cost and can "
1397 "stall the GPU. "
1398 "Consider consolidating and re-organizing the frame to use fewer barriers.",
1399 VendorSpecificTag(kBPVendorAMD), num_barriers_objects);
1400 }
1401
1402 std::array<VkImageLayout, 3> read_layouts = {
1403 VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL,
1404 VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL,
1405 VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL,
1406 };
1407
1408 for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) {
1409 // read to read barriers
1410 auto found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].oldLayout);
1411 bool old_is_read_layout = found != read_layouts.end();
1412 found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].newLayout);
1413 bool new_is_read_layout = found != read_layouts.end();
1414 if (old_is_read_layout && new_is_read_layout) {
1415 skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier,
1416 "%s Performance warning: Don't issue read-to-read barriers. Get the resource in the right state the first "
1417 "time you use it.",
1418 VendorSpecificTag(kBPVendorAMD));
1419 }
1420
1421 // general with no storage
1422 if (pImageMemoryBarriers[i].newLayout == VK_IMAGE_LAYOUT_GENERAL) {
1423 auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image);
1424 if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) {
1425 skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral,
1426 "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with "
1427 "VK_IMAGE_USAGE_STORAGE_BIT images.",
1428 VendorSpecificTag(kBPVendorAMD));
1429 }
1430 }
1431 }
1432 }
1433
Camden5b184be2019-08-13 07:50:19 -06001434 return skip;
1435}
1436
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001437bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer,
1438 const VkDependencyInfoKHR* pDependencyInfo) const {
1439 return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo);
1440}
1441
Camden5b184be2019-08-13 07:50:19 -06001442bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage,
Jeff Bolz5c801d12019-10-09 10:38:45 -05001443 VkQueryPool queryPool, uint32_t query) const {
Camden5b184be2019-08-13 07:50:19 -06001444 bool skip = false;
1445
Jeremy Gebbena3705f42021-01-19 16:47:43 -07001446 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage));
1447
1448 return skip;
1449}
1450
1451bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage,
1452 VkQueryPool queryPool, uint32_t query) const {
1453 bool skip = false;
1454
1455 skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage);
Camden5b184be2019-08-13 07:50:19 -06001456
1457 return skip;
1458}
1459
Sam Walls0961ec02020-03-31 16:39:15 +01001460void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
1461 VkPipeline pipeline) {
1462 StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline);
1463
Nadav Gevaf0808442021-05-21 13:51:25 -04001464 // AMD best practice
1465 pipelines_used_in_frame.emplace(pipeline);
1466
Sam Walls0961ec02020-03-31 16:39:15 +01001467 if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) {
1468 // check for depth/blend state tracking
1469 auto gp_cis = graphicsPipelineCIs.find(pipeline);
1470 if (gp_cis != graphicsPipelineCIs.end()) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001471 auto cb_node = GetCBState(commandBuffer);
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001472 assert(cb_node);
1473 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001474
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001475 render_pass_state.nextDrawTouchesAttachments = gp_cis->second.accessFramebufferAttachments;
1476 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001477
Jeremy Gebben396d06a2021-08-12 11:03:04 -06001478 const auto& blend_state = gp_cis->second.colorBlendStateCI;
1479 const auto& stencil_state = gp_cis->second.depthStencilStateCI;
Sam Walls0961ec02020-03-31 16:39:15 +01001480
1481 if (blend_state) {
1482 // assume the pipeline is depth-only unless any of the attachments have color writes enabled
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001483 render_pass_state.depthOnly = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001484 for (size_t i = 0; i < blend_state->attachmentCount; i++) {
1485 if (blend_state->pAttachments[i].colorWriteMask != 0) {
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001486 render_pass_state.depthOnly = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001487 }
1488 }
1489 }
1490
1491 // check for depth value usage
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001492 render_pass_state.depthEqualComparison = false;
Sam Walls0961ec02020-03-31 16:39:15 +01001493
1494 if (stencil_state && stencil_state->depthTestEnable) {
1495 switch (stencil_state->depthCompareOp) {
1496 case VK_COMPARE_OP_EQUAL:
1497 case VK_COMPARE_OP_GREATER_OR_EQUAL:
1498 case VK_COMPARE_OP_LESS_OR_EQUAL:
Hans-Kristian Arntzen56232b92021-06-16 14:37:48 +02001499 render_pass_state.depthEqualComparison = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001500 break;
1501 default:
1502 break;
1503 }
1504 }
Sam Walls0961ec02020-03-31 16:39:15 +01001505 }
1506 }
1507}
1508
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02001509static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1510 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
1511 const auto& subpass_info = createInfo.pSubpasses[subpass];
1512 if (subpass_info.pResolveAttachments) {
1513 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1514 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1515 }
1516 }
1517 }
1518
1519 return false;
1520}
1521
Attilio Provenzano02859b22020-02-27 14:17:28 +00001522static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1523 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001524 const auto& subpass_info = createInfo.pSubpasses[subpass];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001525
1526 // If an attachment is ever used as a color attachment,
1527 // resolve attachment or depth stencil attachment,
1528 // it needs to exist on tile at some point.
1529
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001530 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1531 if (subpass_info.pColorAttachments[i].attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001532 }
1533
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001534 if (subpass_info.pResolveAttachments) {
1535 for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) {
1536 if (subpass_info.pResolveAttachments[i].attachment == attachment) return true;
1537 }
1538 }
1539
1540 if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001541 }
1542
1543 return false;
1544}
1545
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001546static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) {
1547 if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) {
1548 return false;
1549 }
1550
1551 for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001552 const auto& subpassInfo = createInfo.pSubpasses[subpass];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001553
1554 for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) {
1555 if (subpassInfo.pInputAttachments[i].attachment == attachment) {
1556 return true;
1557 }
1558 }
1559 }
1560
1561 return false;
1562}
1563
Attilio Provenzano02859b22020-02-27 14:17:28 +00001564bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1565 const VkRenderPassBeginInfo* pRenderPassBegin) const {
1566 bool skip = false;
1567
1568 if (!pRenderPassBegin) {
1569 return skip;
1570 }
1571
Gareth Webbdc6549a2021-06-16 03:52:24 +01001572 if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) {
1573 skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea,
1574 "This render pass has a zero-size render area. It cannot write to any attachments, "
1575 "and can only be used for side effects such as layout transitions.");
1576 }
1577
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001578 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001579 if (rp_state) {
Mike Schuchardt2df08912020-12-15 16:28:09 -08001580 if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Mark Lobodzinski1f887d32020-12-30 15:31:33 -07001581 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
Tony-LunarG767180f2020-04-23 14:03:59 -06001582 if (rpabi) {
1583 skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments);
1584 }
1585 }
Attilio Provenzano02859b22020-02-27 14:17:28 +00001586 // Check if any attachments have LOAD operation on them
1587 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001588 const auto& attachment = rp_state->createInfo.pAttachments[att];
Attilio Provenzano02859b22020-02-27 14:17:28 +00001589
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001590 bool attachment_has_readback = false;
Hans-Kristian Arntzen4afb59b2021-06-18 12:41:36 +02001591 if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001592 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001593 }
1594
1595 if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001596 attachment_has_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001597 }
1598
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001599 bool attachment_needs_readback = false;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001600
1601 // Check if the attachment is actually used in any subpass on-tile
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07001602 if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1603 attachment_needs_readback = true;
Attilio Provenzano02859b22020-02-27 14:17:28 +00001604 }
1605
1606 // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001607 if (attachment_needs_readback && VendorCheckEnabled(kBPVendorArm)) {
1608 skip |= LogPerformanceWarning(
1609 device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback,
1610 "%s Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n"
1611 "Submitting this renderpass will cause the driver to inject a readback of the attachment "
Nadav Gevaf0808442021-05-21 13:51:25 -04001612 "which will copy in total %u pixels (renderArea = "
1613 "{ %" PRId32 ", %" PRId32 ", %" PRIu32", %" PRIu32 " }) to the tile buffer.",
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001614 VendorSpecificTag(kBPVendorArm), att,
1615 pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height,
1616 pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y,
1617 pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001618 }
1619 }
1620 }
1621
1622 return skip;
1623}
1624
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001625void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name,
1626 IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001627 if (view) {
Jeremy Gebbenb4d17012021-07-08 13:18:15 -06001628 QueueValidateImage(funcs, function_name, GetImageUsageState(view->create_info.image), usage,
1629 view->normalized_subresource_range);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001630 }
1631}
1632
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001633void BestPractices::QueueValidateImage(QueueCallbacks &funcs, const char* function_name,
1634 IMAGE_STATE_BP* state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001635 const VkImageSubresourceRange& subresource_range) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001636 IMAGE_STATE* image = state->image;
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001637
1638 // If we're viewing a 3D slice, ignore base array layer.
1639 // The entire 3D subresource is accessed as one atomic unit.
1640 const uint32_t base_array_layer = image->createInfo.imageType == VK_IMAGE_TYPE_3D ? 0 : subresource_range.baseArrayLayer;
1641
1642 const uint32_t max_layers = image->createInfo.arrayLayers - base_array_layer;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001643 const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers);
1644 const uint32_t max_levels = image->createInfo.mipLevels - subresource_range.baseMipLevel;
1645 const uint32_t mip_levels = std::min(image->createInfo.mipLevels, max_levels);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001646
1647 for (uint32_t layer = 0; layer < array_layers; layer++) {
1648 for (uint32_t level = 0; level < mip_levels; level++) {
Hans-Kristian Arntzen93264202021-05-21 17:07:46 +02001649 QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer,
1650 level + subresource_range.baseMipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001651 }
1652 }
1653}
1654
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001655void BestPractices::QueueValidateImage(QueueCallbacks &funcs, const char* function_name,
1656 IMAGE_STATE_BP* state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001657 const VkImageSubresourceLayers& subresource_layers) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001658 IMAGE_STATE* image = state->image;
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001659 const uint32_t max_layers = image->createInfo.arrayLayers - subresource_layers.baseArrayLayer;
1660 const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001661
1662 for (uint32_t layer = 0; layer < array_layers; layer++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001663 QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001664 }
1665}
1666
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001667void BestPractices::QueueValidateImage(QueueCallbacks &funcs, const char* function_name,
1668 IMAGE_STATE_BP* state, IMAGE_SUBRESOURCE_USAGE_BP usage,
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001669 uint32_t array_layer, uint32_t mip_level) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07001670 funcs.push_back([this, function_name, state, usage, array_layer, mip_level](const ValidationStateTracker&, const QUEUE_STATE&,
1671 const CMD_BUFFER_STATE&) -> bool {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001672 ValidateImageInQueue(function_name, state, usage, array_layer, mip_level);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001673 return false;
1674 });
1675}
1676
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001677void BestPractices::ValidateImageInQueueArm(const char* function_name, IMAGE_STATE* image,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001678 IMAGE_SUBRESOURCE_USAGE_BP last_usage,
1679 IMAGE_SUBRESOURCE_USAGE_BP usage,
1680 uint32_t array_layer, uint32_t mip_level) {
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001681 // Swapchain images are implicitly read so clear after store is expected.
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001682 if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED && last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED &&
Jeremy Gebben82e11d52021-07-26 09:19:37 -06001683 !image->IsSwapchainImage()) {
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001684 LogPerformanceWarning(
1685 device, kVUID_BestPractices_RenderPass_RedundantStore,
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001686 "%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 +02001687 "image was used, it was written to with STORE_OP_STORE. "
1688 "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based "
1689 "architectures.",
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001690 function_name, VendorSpecificTag(kBPVendorArm), array_layer, mip_level);
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001691 } 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 +02001692 LogPerformanceWarning(
1693 device, kVUID_BestPractices_RenderPass_RedundantClear,
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001694 "%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 +02001695 "image was used, it was written to with vkCmdClear*Image(). "
1696 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1697 "tile-based architectures."
1698 "architectures.",
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001699 function_name, VendorSpecificTag(kBPVendorArm), array_layer, mip_level);
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001700 } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE &&
1701 (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE ||
1702 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED ||
1703 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE ||
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001704 last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) {
Hans-Kristian Arntzen44f9d862021-03-22 13:56:39 +01001705 const char *last_cmd = nullptr;
1706 const char *vuid = nullptr;
1707 const char *suggestion = nullptr;
1708
1709 switch (last_usage) {
1710 case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE:
1711 vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad;
1712 last_cmd = "vkCmdBlitImage";
1713 suggestion =
1714 "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1715 "Rather than blitting, just render the source image in a fragment shader in this render pass, "
1716 "which avoids the memory roundtrip.";
1717 break;
1718 case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED:
1719 vuid = kVUID_BestPractices_RenderPass_InefficientClear;
1720 last_cmd = "vkCmdClear*Image";
1721 suggestion =
1722 "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on "
1723 "tile-based architectures. "
1724 "Use LOAD_OP_CLEAR instead to clear the image for free.";
1725 break;
1726 case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE:
1727 vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad;
1728 last_cmd = "vkCmdCopy*Image";
1729 suggestion =
1730 "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. "
1731 "Rather than copying, just render the source image in a fragment shader in this render pass, "
1732 "which avoids the memory roundtrip.";
1733 break;
1734 case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE:
1735 vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad;
1736 last_cmd = "vkCmdResolveImage";
1737 suggestion =
1738 "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. "
1739 "Rather than resolving, and then loading, try to keep rendering in the same render pass, "
1740 "which avoids the memory roundtrip.";
1741 break;
1742 default:
1743 break;
1744 }
1745
1746 LogPerformanceWarning(
1747 device, vuid,
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001748 "%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 +01001749 "time image was used, it was written to with %s. %s",
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001750 function_name, VendorSpecificTag(kBPVendorArm), array_layer, mip_level, last_cmd, suggestion);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001751 }
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001752}
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001753
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001754void BestPractices::ValidateImageInQueue(const char* function_name, IMAGE_STATE_BP* state,
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001755 IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer,
1756 uint32_t mip_level) {
1757 IMAGE_STATE* image = state->image;
1758 IMAGE_SUBRESOURCE_USAGE_BP last_usage = state->usages[array_layer][mip_level];
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001759 state->usages[array_layer][mip_level] = usage;
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001760 if (VendorCheckEnabled(kBPVendorArm)) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001761 ValidateImageInQueueArm(function_name, image, last_usage, usage, array_layer, mip_level);
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02001762 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001763}
1764
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001765void BestPractices::AddDeferredQueueOperations(CMD_BUFFER_STATE_BP* cb) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001766 cb->queue_submit_functions.insert(cb->queue_submit_functions.end(),
Hans-Kristian Arntzenf44df192021-06-14 11:42:08 +02001767 cb->queue_submit_functions_after_render_pass.begin(),
1768 cb->queue_submit_functions_after_render_pass.end());
1769 cb->queue_submit_functions_after_render_pass.clear();
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001770}
1771
1772void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) {
1773 ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001774 AddDeferredQueueOperations(GetCBState(commandBuffer));
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001775}
1776
1777void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) {
1778 ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo);
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001779 AddDeferredQueueOperations(GetCBState(commandBuffer));
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001780}
1781
1782void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) {
1783 ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo);
Hans-Kristian Arntzenb8336ad2021-04-28 14:54:09 +02001784 AddDeferredQueueOperations(GetCBState(commandBuffer));
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001785}
1786
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001787void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer,
1788 const VkRenderPassBeginInfo* pRenderPassBegin,
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001789 VkSubpassContents contents) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001790 ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02001791 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1792}
1793
1794void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer,
1795 const VkRenderPassBeginInfo* pRenderPassBegin,
1796 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1797 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1798 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1799}
1800
1801void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1802 const VkRenderPassBeginInfo* pRenderPassBegin,
1803 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1804 ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1805 RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin);
1806}
1807
1808void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001809
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001810 if (!pRenderPassBegin) {
1811 return;
1812 }
1813
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001814 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01001815
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001816 auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001817 if (rp_state) {
1818 // Check load ops
1819 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001820 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001821
1822 if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) &&
1823 !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1824 continue;
1825 }
1826
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001827 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001828
1829 if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) ||
1830 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001831 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001832 } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) ||
1833 (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001834 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED;
Hans-Kristian Arntzen5e56e552021-03-29 11:45:20 +02001835 } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) {
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01001836 usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001837 }
1838
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001839 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001840 IMAGE_VIEW_STATE* image_view = nullptr;
1841
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001842 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001843 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1844 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001845 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001846 }
1847 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001848 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001849 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001850
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02001851 QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view, usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001852 }
1853
1854 // Check store ops
1855 for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02001856 const auto& attachment = rp_state->createInfo.pAttachments[att];
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001857
1858 if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) {
1859 continue;
1860 }
1861
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001862 IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001863
1864 if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) ||
1865 (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01001866 usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001867 }
1868
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001869 auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001870
1871 IMAGE_VIEW_STATE* image_view = nullptr;
Tony-LunarGb3ab3572021-07-02 09:45:17 -06001872 if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) {
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001873 const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext);
1874 if (rpabi) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001875 image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001876 }
1877 } else {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001878 image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]);
Hans-Kristian Arntzen9710e142021-03-18 12:19:02 +01001879 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001880
Hans-Kristian Arntzenf44df192021-06-14 11:42:08 +02001881 QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view, usage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01001882 }
1883 }
1884}
1885
Attilio Provenzano02859b22020-02-27 14:17:28 +00001886bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1887 VkSubpassContents contents) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001888 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1889 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001890 return skip;
1891}
1892
1893bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1894 const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001895 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001896 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1897 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001898 return skip;
1899}
1900
1901bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
Mike Schuchardt2df08912020-12-15 16:28:09 -08001902 const VkSubpassBeginInfo* pSubpassBeginInfo) const {
Sam Walls0961ec02020-03-31 16:39:15 +01001903 bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1904 skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
Attilio Provenzano02859b22020-02-27 14:17:28 +00001905 return skip;
1906}
1907
Sam Walls0961ec02020-03-31 16:39:15 +01001908void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version,
1909 const VkRenderPassBeginInfo* pRenderPassBegin) {
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001910 // Reset the renderpass state
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001911 auto* cb = GetCBState(commandBuffer);
1912 cb->hasDrawCmd = false;
1913 assert(cb);
1914 auto& render_pass_state = cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02001915 render_pass_state.touchesAttachments.clear();
1916 render_pass_state.earlyClearAttachments.clear();
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001917 render_pass_state.numDrawCallsDepthOnly = 0;
1918 render_pass_state.numDrawCallsDepthEqualCompare = 0;
1919 render_pass_state.colorAttachment = false;
1920 render_pass_state.depthAttachment = false;
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001921 render_pass_state.drawTouchAttachments = true;
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001922 // Don't reset state related to pipeline state.
Sam Walls0961ec02020-03-31 16:39:15 +01001923
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06001924 const auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass);
Sam Walls0961ec02020-03-31 16:39:15 +01001925
1926 // track depth / color attachment usage within the renderpass
1927 for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) {
1928 // record if depth/color attachments are in use for this renderpass
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001929 if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001930
Hans-Kristian Arntzena900f5d2021-06-14 15:09:31 +02001931 if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true;
Sam Walls0961ec02020-03-31 16:39:15 +01001932 }
1933}
1934
1935void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1936 VkSubpassContents contents) {
1937 StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents);
1938 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin);
1939}
1940
1941void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin,
1942 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1943 StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1944 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
1945}
1946
1947void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer,
1948 const VkRenderPassBeginInfo* pRenderPassBegin,
1949 const VkSubpassBeginInfo* pSubpassBeginInfo) {
1950 StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo);
1951 RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin);
1952}
1953
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001954// Generic function to handle validation for all CmdDraw* type functions
1955bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const {
1956 bool skip = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001957 const auto* cb_state = GetCBState(cmd_buffer);
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001958 if (cb_state) {
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001959 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
1960 const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state;
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001961 const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings;
locke-lunargb8d7a7a2020-10-25 16:01:52 -06001962
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001963 // Verify vertex binding
1964 if (pipeline_state->vertex_binding_descriptions_.size() <= 0) {
1965 if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) {
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001966 skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds,
Mark Lobodzinskif95a2662020-01-29 15:43:32 -07001967 "Vertex buffers are bound to %s but no vertex buffers are attached to %s.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06001968 report_data->FormatHandle(cb_state->commandBuffer()).c_str(),
1969 report_data->FormatHandle(pipeline_state->pipeline()).c_str());
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001970 }
1971 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06001972
Jeremy Gebben159b3cc2021-06-03 09:09:03 -06001973 const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS);
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06001974 if (pipe) {
1975 const auto* rp_state = pipe->rp_state.get();
1976 if (rp_state) {
1977 for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) {
1978 const auto& subpass = rp_state->createInfo.pSubpasses[i];
Jeremy Gebben11af9792021-08-20 10:20:09 -06001979 const auto& create_info = pipe->create_info.graphics;
1980 const uint32_t depth_stencil_attachment =
1981 GetSubpassDepthStencilAttachmentIndex(create_info.pDepthStencilState, subpass.pDepthStencilAttachment);
1982 if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && create_info.pRasterizationState &&
1983 create_info.pRasterizationState->depthBiasEnable == VK_TRUE) {
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06001984 skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment,
1985 "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller);
1986 }
1987 }
1988 }
1989 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07001990 }
1991 return skip;
1992}
1993
Sam Walls0961ec02020-03-31 16:39:15 +01001994void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06001995 auto* cb_node = GetCBState(cmd_buffer);
1996 assert(cb_node);
1997 auto& render_pass_state = cb_node->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01001998 if (VendorCheckEnabled(kBPVendorArm)) {
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02001999 RecordCmdDrawTypeArm(render_pass_state, draw_count, caller);
2000 }
2001
2002 if (render_pass_state.drawTouchAttachments) {
2003 for (auto& touch : render_pass_state.nextDrawTouchesAttachments) {
2004 RecordAttachmentAccess(render_pass_state, touch.framebufferAttachment, touch.aspects);
2005 }
2006 // No need to touch the same attachments over and over.
2007 render_pass_state.drawTouchAttachments = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002008 }
2009}
2010
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002011void BestPractices::RecordCmdDrawTypeArm(RenderPassState& render_pass_state, uint32_t draw_count, const char* caller) {
2012 if (draw_count >= kDepthPrePassMinDrawCountArm) {
2013 if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++;
2014 if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++;
Sam Walls0961ec02020-03-31 16:39:15 +01002015 }
2016}
2017
Camden5b184be2019-08-13 07:50:19 -06002018bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002019 uint32_t firstVertex, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002020 bool skip = false;
2021
2022 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002023 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2024 "Warning: You are calling vkCmdDraw() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002025 }
Nathaniel Cesariof7b732a2021-06-03 14:08:27 -06002026 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()");
Camden5b184be2019-08-13 07:50:19 -06002027
2028 return skip;
2029}
2030
Sam Walls0961ec02020-03-31 16:39:15 +01002031void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2032 uint32_t firstVertex, uint32_t firstInstance) {
2033 StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance);
2034 RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()");
2035}
2036
Camden5b184be2019-08-13 07:50:19 -06002037bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002038 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
Camden5b184be2019-08-13 07:50:19 -06002039 bool skip = false;
2040
2041 if (instanceCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002042 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero,
2043 "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero.");
Camden5b184be2019-08-13 07:50:19 -06002044 }
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002045 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()");
2046
Attilio Provenzano02859b22020-02-27 14:17:28 +00002047 // Check if we reached the limit for small indexed draw calls.
2048 // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed.
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002049 const auto* cmd_state = GetCBState(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002050 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices &&
Hans-Kristian Arntzenb2147952021-04-28 14:32:00 +02002051 (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) &&
2052 VendorCheckEnabled(kBPVendorArm)) {
2053 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls,
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06002054 "%s: The command buffer contains many small indexed drawcalls "
Attilio Provenzano02859b22020-02-27 14:17:28 +00002055 "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. "
2056 "You can try batching drawcalls or instancing when applicable.",
2057 VendorSpecificTag(kBPVendorArm), kMaxSmallIndexedDrawcalls, kSmallIndexedDrawcallIndices);
2058 }
2059
Sam Walls8e77e4f2020-03-16 20:47:40 +00002060 if (VendorCheckEnabled(kBPVendorArm)) {
2061 ValidateIndexBufferArm(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2062 }
2063
2064 return skip;
2065}
2066
2067bool BestPractices::ValidateIndexBufferArm(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2068 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const {
2069 bool skip = false;
2070
2071 // check for sparse/underutilised index buffer, and post-transform cache thrashing
2072 const auto* cmd_state = GetCBState(commandBuffer);
2073 if (cmd_state == nullptr) return skip;
2074
locke-lunarg1ae57d62020-11-18 10:49:19 -07002075 const auto* ib_state = cmd_state->index_buffer_binding.buffer_state.get();
Jeremy Gebben9efe1cf2021-05-15 20:05:09 -06002076 if (ib_state == nullptr || cmd_state->index_buffer_binding.buffer_state->Destroyed()) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002077
2078 const VkIndexType ib_type = cmd_state->index_buffer_binding.index_type;
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002079 const auto& ib_mem_state = *ib_state->MemState();
Sam Walls8e77e4f2020-03-16 20:47:40 +00002080 const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset;
2081 const void* ib_mem = ib_mem_state.p_driver_data;
2082 bool primitive_restart_enable = false;
2083
locke-lunargb8d7a7a2020-10-25 16:01:52 -06002084 const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS);
2085 const auto& pipeline_binding_iter = cmd_state->lastBound[lv_bind_point];
2086 const auto* pipeline_state = pipeline_binding_iter.pipeline_state;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002087
Jeremy Gebben11af9792021-08-20 10:20:09 -06002088 if (pipeline_state != nullptr && pipeline_state->create_info.graphics.pInputAssemblyState != nullptr) {
2089 primitive_restart_enable = pipeline_state->create_info.graphics.pInputAssemblyState->primitiveRestartEnable == VK_TRUE;
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002090 }
Sam Walls8e77e4f2020-03-16 20:47:40 +00002091
2092 // 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 -06002093 if (ib_mem && pipeline_binding_iter.IsUsing()) {
Sam Walls8e77e4f2020-03-16 20:47:40 +00002094 uint32_t scan_stride;
2095 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2096 scan_stride = sizeof(uint8_t);
2097 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2098 scan_stride = sizeof(uint16_t);
2099 } else {
2100 scan_stride = sizeof(uint32_t);
2101 }
2102
2103 const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride;
2104 const uint8_t* scan_end = scan_begin + indexCount * scan_stride;
2105
2106 // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all
2107 // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded,
2108 // irrespective of whether or not they're part of the draw call.
2109
2110 // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer
2111 uint32_t min_index = ~0u;
2112 // start with maximum as 0 and adjust to indices in the buffer
2113 uint32_t max_index = 0u;
2114
2115 // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded
2116 // for the given index buffer
2117 uint32_t vertex_shade_count = 0;
2118
2119 PostTransformLRUCacheModel post_transform_cache;
2120
2121 // The size of the cache being modelled positively correlates with how much behaviour it can capture about
2122 // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the
2123 // target architecture.
2124 // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice.
2125 // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html
2126 post_transform_cache.resize(32);
2127
2128 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2129 uint32_t scan_index;
2130 uint32_t primitive_restart_value;
2131 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2132 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2133 primitive_restart_value = 0xFF;
2134 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2135 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2136 primitive_restart_value = 0xFFFF;
2137 } else {
2138 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2139 primitive_restart_value = 0xFFFFFFFF;
2140 }
2141
2142 max_index = std::max(max_index, scan_index);
2143 min_index = std::min(min_index, scan_index);
2144
2145 if (!primitive_restart_enable || scan_index != primitive_restart_value) {
2146 bool in_cache = post_transform_cache.query_cache(scan_index);
2147 // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again
2148 if (!in_cache) vertex_shade_count++;
2149 }
2150 }
2151
2152 // 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 +01002153 // 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
2154 if (max_index < min_index || max_index == min_index) return skip;
Sam Walls8e77e4f2020-03-16 20:47:40 +00002155
2156 if (max_index - min_index >= indexCount) {
Mark Young0ec6b062020-11-19 15:32:17 -07002157 skip |=
2158 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2159 "%s The indices which were specified for the draw call only utilise approximately %.02f%% of "
2160 "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven "
2161 "Vertex Shading), meaning all vertices corresponding to indices between the minimum and "
2162 "maximum would be loaded, and possibly shaded, whether or not they are used.",
2163 VendorSpecificTag(kBPVendorArm),
2164 (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002165 return skip;
2166 }
2167
2168 // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call
2169 // 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 +01002170 const size_t refs_per_bucket = 64;
2171 std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets;
2172
2173 const uint32_t n_indices = max_index - min_index + 1;
2174 const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) +
2175 ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0);
2176
2177 // there needs to be at least one bitset to store a set of indices smaller than n_buckets
2178 vertex_reference_buckets.resize(std::max(1u, n_buckets));
Sam Walls8e77e4f2020-03-16 20:47:40 +00002179
2180 // To avoid using too much memory, we run over the indices again.
2181 // Knowing the size from the last scan allows us to record index usage with bitsets
2182 for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) {
2183 uint32_t scan_index;
2184 if (ib_type == VK_INDEX_TYPE_UINT8_EXT) {
2185 scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr);
2186 } else if (ib_type == VK_INDEX_TYPE_UINT16) {
2187 scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr);
2188 } else {
2189 scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr);
2190 }
2191 // keep track of the set of all indices used to reference vertices in the draw call
2192 size_t index_offset = scan_index - min_index;
Sam Walls61b06892020-07-23 16:20:50 +01002193 size_t bitset_bucket_index = index_offset / refs_per_bucket;
2194 uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002195 vertex_reference_buckets[bitset_bucket_index] |= used_indices;
2196 }
2197
2198 uint32_t vertex_reference_count = 0;
2199 for (const auto& bitset : vertex_reference_buckets) {
2200 vertex_reference_count += static_cast<uint32_t>(bitset.count());
2201 }
2202
2203 // 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 -07002204 float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002205 // 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 -07002206 float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count);
Sam Walls8e77e4f2020-03-16 20:47:40 +00002207
2208 if (utilization < 0.5f) {
2209 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer,
2210 "%s The indices which were specified for the draw call only utilise approximately "
2211 "%.02f%% of the bound vertex buffer.",
2212 VendorSpecificTag(kBPVendorArm), utilization);
2213 }
2214
2215 if (cache_hit_rate <= 0.5f) {
2216 skip |=
2217 LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing,
2218 "%s The indices which were specified for the draw call are estimated to cause thrashing of "
2219 "the post-transform vertex cache, with a hit-rate of %.02f%%. "
2220 "I.e. the ordering of the index buffer may not make optimal use of indices associated with "
2221 "recently shaded vertices.",
2222 VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f);
2223 }
2224 }
2225
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002226 return skip;
2227}
2228
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002229bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2230 const VkCommandBuffer* pCommandBuffers) const {
2231 bool skip = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002232 const auto* primary = GetCBState(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002233 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002234 const auto* secondary_cb = GetCBState(pCommandBuffers[i]);
2235 if (secondary_cb == nullptr) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002236 continue;
2237 }
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002238 const auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002239 for (auto& clear : secondary.earlyClearAttachments) {
Hans-Kristian Arntzenfa8ef9f2021-06-29 12:07:59 +02002240 if (ClearAttachmentsIsFullClear(primary, uint32_t(clear.rects.size()), clear.rects.data())) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002241 skip |= ValidateClearAttachment(commandBuffer, primary,
2242 clear.framebufferAttachment, clear.colorAttachment,
2243 clear.aspects, true);
2244 }
2245 }
2246 }
Nadav Gevaf0808442021-05-21 13:51:25 -04002247
2248 if (VendorCheckEnabled(kBPVendorAMD)) {
2249 if (commandBufferCount > 0) {
2250 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers,
2251 "%s Performance warning: Use of secondary command buffers is not recommended. ",
2252 VendorSpecificTag(kBPVendorAMD));
2253 }
2254 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002255 return skip;
2256}
2257
2258void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount,
2259 const VkCommandBuffer* pCommandBuffers) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002260 auto* primary = GetCBState(commandBuffer);
2261 auto& primary_state = primary->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002262
2263 for (uint32_t i = 0; i < commandBufferCount; i++) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002264 auto* secondary_cb = GetCBState(pCommandBuffers[i]);
2265 if (secondary_cb == nullptr) {
2266 continue;
2267 }
2268 auto& secondary = secondary_cb->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002269
2270 for (auto& early_clear : secondary.earlyClearAttachments) {
Hans-Kristian Arntzenfa8ef9f2021-06-29 12:07:59 +02002271 if (ClearAttachmentsIsFullClear(primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002272 RecordAttachmentClearAttachments(primary, primary_state, early_clear.framebufferAttachment,
2273 early_clear.colorAttachment, early_clear.aspects,
Hans-Kristian Arntzenfa8ef9f2021-06-29 12:07:59 +02002274 uint32_t(early_clear.rects.size()), early_clear.rects.data());
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002275 } else {
2276 RecordAttachmentAccess(primary_state, early_clear.framebufferAttachment,
2277 early_clear.aspects);
2278 }
2279 }
2280
2281 for (auto& touch : secondary.touchesAttachments) {
2282 RecordAttachmentAccess(primary_state, touch.framebufferAttachment,
2283 touch.aspects);
2284 }
Hans-Kristian Arntzenc7eb82a2021-06-16 13:57:18 +02002285
2286 primary_state.numDrawCallsDepthEqualCompare += secondary.numDrawCallsDepthEqualCompare;
2287 primary_state.numDrawCallsDepthOnly += secondary.numDrawCallsDepthOnly;
Hans-Kristian Arntzenaf81dca2021-06-18 11:14:28 +02002288
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002289 auto* second_state = GetCBState(pCommandBuffers[i]);
Hans-Kristian Arntzenaf81dca2021-06-18 11:14:28 +02002290 if (second_state->hasDrawCmd) {
2291 primary->hasDrawCmd = true;
2292 }
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002293 }
2294
2295 ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers);
2296}
2297
2298void BestPractices::RecordAttachmentAccess(RenderPassState& state, uint32_t fb_attachment, VkImageAspectFlags aspects) {
2299 // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment.
2300 auto itr = std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002301 [&](const AttachmentInfo& info) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002302 return info.framebufferAttachment == fb_attachment;
2303 });
2304
2305 if (itr != state.touchesAttachments.end()) {
2306 itr->aspects |= aspects;
2307 } else {
2308 state.touchesAttachments.push_back({ fb_attachment, aspects });
2309 }
2310}
2311
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002312void BestPractices::RecordAttachmentClearAttachments(CMD_BUFFER_STATE_BP* cmd_state, RenderPassState& state, uint32_t fb_attachment,
2313 uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount,
2314 const VkClearRect* pRects) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002315 // If we observe a full clear before any other access to a frame buffer attachment,
2316 // we have candidate for redundant clear attachments.
2317 auto itr = std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(),
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002318 [&](const AttachmentInfo& info) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002319 return info.framebufferAttachment == fb_attachment;
2320 });
2321
2322 uint32_t new_aspects = aspects;
2323 if (itr != state.touchesAttachments.end()) {
2324 new_aspects = aspects & ~itr->aspects;
2325 itr->aspects |= aspects;
2326 } else {
2327 state.touchesAttachments.push_back({ fb_attachment, aspects });
2328 }
2329
2330 if (new_aspects == 0) {
2331 return;
2332 }
2333
2334 if (cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
2335 // The first command might be a clear, but might not be the first in the render pass, defer any checks until
2336 // CmdExecuteCommands.
2337 state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects,
2338 std::vector<VkClearRect>{pRects, pRects + rectCount} });
2339 }
2340}
2341
2342void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer,
2343 uint32_t attachmentCount, const VkClearAttachment* pClearAttachments,
2344 uint32_t rectCount, const VkClearRect* pRects) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002345 auto* cmd_state = GetCBState(commandBuffer);
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002346 RENDER_PASS_STATE* rp_state = cmd_state->activeRenderPass.get();
2347 FRAMEBUFFER_STATE* fb_state = cmd_state->activeFramebuffer.get();
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002348 RenderPassState& tracking_state = cmd_state->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002349 bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY;
2350
2351 if (rectCount == 0 || !rp_state) {
2352 return;
2353 }
2354
2355 if (!is_secondary && !fb_state) {
2356 return;
2357 }
2358
2359 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
2360 bool full_clear = ClearAttachmentsIsFullClear(cmd_state, rectCount, pRects);
2361
2362 auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass];
2363 for (uint32_t i = 0; i < attachmentCount; i++) {
2364 auto& attachment = pClearAttachments[i];
2365 uint32_t fb_attachment = VK_ATTACHMENT_UNUSED;
2366 VkImageAspectFlags aspects = attachment.aspectMask;
2367
2368 if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) {
2369 if (subpass.pDepthStencilAttachment) {
2370 fb_attachment = subpass.pDepthStencilAttachment->attachment;
2371 }
2372 } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) {
2373 fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment;
2374 }
2375
2376 if (fb_attachment != VK_ATTACHMENT_UNUSED) {
2377 if (full_clear) {
2378 RecordAttachmentClearAttachments(cmd_state, tracking_state,
2379 fb_attachment, attachment.colorAttachment, aspects,
2380 rectCount, pRects);
2381 } else {
2382 RecordAttachmentAccess(tracking_state, fb_attachment, aspects);
2383 }
2384 }
2385 }
2386
2387 ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments,
2388 rectCount, pRects);
2389}
2390
Attilio Provenzano02859b22020-02-27 14:17:28 +00002391void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2392 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2393 ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset,
2394 firstInstance);
2395
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002396 auto* cmd_state = GetCBState(commandBuffer);
Attilio Provenzano02859b22020-02-27 14:17:28 +00002397 if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) {
2398 cmd_state->small_indexed_draw_call_count++;
2399 }
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002400
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002401 ValidateBoundDescriptorSets(commandBuffer, "vkCmdDrawIndexed()");
Attilio Provenzano02859b22020-02-27 14:17:28 +00002402}
2403
Sam Walls0961ec02020-03-31 16:39:15 +01002404void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount,
2405 uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) {
2406 StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance);
2407 RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()");
2408}
2409
sfricke-samsung681ab7b2020-10-29 01:53:35 -07002410bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2411 VkBuffer countBuffer, VkDeviceSize countBufferOffset,
2412 uint32_t maxDrawCount, uint32_t stride) const {
2413 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()");
2414
2415 return skip;
2416}
2417
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002418bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer,
2419 VkDeviceSize offset, VkBuffer countBuffer,
2420 VkDeviceSize countBufferOffset, uint32_t maxDrawCount,
2421 uint32_t stride) const {
2422 bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()");
Camden5b184be2019-08-13 07:50:19 -06002423
2424 return skip;
2425}
2426
2427bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002428 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002429 bool skip = false;
2430
2431 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002432 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2433 "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002434 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002435 }
2436
2437 return skip;
2438}
2439
Sam Walls0961ec02020-03-31 16:39:15 +01002440void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2441 uint32_t count, uint32_t stride) {
2442 StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride);
2443 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()");
2444}
2445
Camden5b184be2019-08-13 07:50:19 -06002446bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002447 uint32_t drawCount, uint32_t stride) const {
Camden5b184be2019-08-13 07:50:19 -06002448 bool skip = false;
2449
2450 if (drawCount == 0) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002451 skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero,
2452 "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero.");
Mark Lobodzinski4c4cf942019-12-20 11:09:51 -07002453 skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()");
Camden5b184be2019-08-13 07:50:19 -06002454 }
2455
2456 return skip;
2457}
2458
Sam Walls0961ec02020-03-31 16:39:15 +01002459void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2460 uint32_t count, uint32_t stride) {
2461 StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride);
2462 RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()");
2463}
2464
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002465void BestPractices::ValidateBoundDescriptorSets(VkCommandBuffer commandBuffer, const char* function_name) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002466 auto* cb_state = GetCBState(commandBuffer);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002467
2468 if (cb_state) {
2469 for (auto descriptor_set : cb_state->validated_descriptor_sets) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02002470 const auto& layout = *descriptor_set->GetLayout();
Hans-Kristian Arntzena8199012021-03-22 12:10:07 +01002471
2472 for (uint32_t index = 0; index < descriptor_set->GetBindingCount(); ++index) {
2473 // For bindless scenarios, we should not attempt to track descriptor set state.
2474 // It is highly uncertain which resources are actually bound.
2475 // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state.
2476 VkDescriptorBindingFlags flags = layout.GetDescriptorBindingFlagsFromIndex(index);
2477 if (flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT |
2478 VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT |
2479 VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) {
2480 continue;
2481 }
2482
2483 auto index_range = layout.GetGlobalIndexRangeFromIndex(index);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002484 for (uint32_t i = index_range.start; i < index_range.end; ++i) {
ZandroFargnoliacf12f02020-06-18 16:50:00 +01002485 VkImageView image_view{VK_NULL_HANDLE};
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002486
2487 auto descriptor = descriptor_set->GetDescriptorFromGlobalIndex(i);
2488 switch (descriptor->GetClass()) {
2489 case cvdescriptorset::DescriptorClass::Image: {
2490 if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) {
2491 image_view = image_descriptor->GetImageView();
2492 }
Hans-Kristian Arntzenbc3a6152021-03-22 13:05:43 +01002493 break;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002494 }
2495 case cvdescriptorset::DescriptorClass::ImageSampler: {
2496 if (const auto image_sampler_descriptor =
2497 static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) {
2498 image_view = image_sampler_descriptor->GetImageView();
2499 }
Hans-Kristian Arntzenbc3a6152021-03-22 13:05:43 +01002500 break;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002501 }
ZandroFargnoliacf12f02020-06-18 16:50:00 +01002502 default:
Hans-Kristian Arntzenbc3a6152021-03-22 13:05:43 +01002503 break;
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002504 }
2505
2506 if (image_view) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002507 auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view);
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002508 QueueValidateImageView(cb_state->queue_submit_functions, function_name,
2509 image_view_state, IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002510 }
2511 }
2512 }
2513 }
2514 }
2515}
2516
2517void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount,
2518 uint32_t firstVertex, uint32_t firstInstance) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002519 ValidateBoundDescriptorSets(commandBuffer, "vkCmdDraw()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002520}
2521
2522void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2523 uint32_t drawCount, uint32_t stride) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002524 ValidateBoundDescriptorSets(commandBuffer, "vkCmdDrawIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002525}
2526
2527void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset,
2528 uint32_t drawCount, uint32_t stride) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002529 ValidateBoundDescriptorSets(commandBuffer, "vkCmdDrawIndexedIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002530}
2531
Camden5b184be2019-08-13 07:50:19 -06002532bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002533 uint32_t groupCountZ) const {
Camden5b184be2019-08-13 07:50:19 -06002534 bool skip = false;
2535
2536 if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002537 skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero,
2538 "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32
2539 ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").",
2540 groupCountX, groupCountY, groupCountZ);
Camden5b184be2019-08-13 07:50:19 -06002541 }
2542
2543 return skip;
2544}
Camden83a9c372019-08-14 11:41:38 -06002545
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002546bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2547 bool skip = false;
2548 skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo);
2549 skip |= ValidateCmdEndRenderPass(commandBuffer);
2550 return skip;
2551}
2552
2553bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const {
2554 bool skip = false;
2555 skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo);
2556 skip |= ValidateCmdEndRenderPass(commandBuffer);
2557 return skip;
2558}
2559
Sam Walls0961ec02020-03-31 16:39:15 +01002560bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2561 bool skip = false;
Sam Walls0961ec02020-03-31 16:39:15 +01002562 skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer);
Hans-Kristian Arntzend9941a92021-06-18 12:31:30 +02002563 skip |= ValidateCmdEndRenderPass(commandBuffer);
2564 return skip;
2565}
2566
2567bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const {
2568 bool skip = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002569 const auto* cmd = GetCBState(commandBuffer);
Sam Walls0961ec02020-03-31 16:39:15 +01002570
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002571 if (cmd == nullptr) return skip;
2572 auto &render_pass_state = cmd->render_pass_state;
Sam Walls0961ec02020-03-31 16:39:15 +01002573
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002574 bool uses_depth = (render_pass_state.depthAttachment || render_pass_state.colorAttachment) &&
2575 render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm &&
2576 render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm;
Sam Walls0961ec02020-03-31 16:39:15 +01002577 if (uses_depth) {
2578 skip |= LogPerformanceWarning(
2579 device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage,
2580 "%s Depth pre-passes may be in use. In general, this is not recommended, as in Arm Mali GPUs since "
2581 "Mali-T620, Forward Pixel Killing (FPK) can already perform automatic hidden surface removal; in which "
2582 "case, using depth pre-passes for hidden surface removal may worsen performance.",
2583 VendorSpecificTag(kBPVendorArm));
2584 }
2585
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002586 RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2587
2588 if (VendorCheckEnabled(kBPVendorArm) && rp) {
2589
2590 // If we use an attachment on-tile, we should access it in some way. Otherwise,
2591 // it is redundant to have it be part of the render pass.
2592 // Only consider it redundant if it will actually consume bandwidth, i.e.
2593 // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign,
2594 // as is using pure input attachments.
2595 // CLEAR -> STORE might be considered a "useful" thing to do, but
2596 // the optimal thing to do is to defer the clear until you're actually
2597 // going to render to the image.
2598
2599 uint32_t num_attachments = rp->createInfo.attachmentCount;
2600 for (uint32_t i = 0; i < num_attachments; i++) {
Hans-Kristian Arntzen237663c2021-07-01 14:36:40 +02002601 if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) ||
2602 RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002603 continue;
2604 }
2605
2606 auto& attachment = rp->createInfo.pAttachments[i];
2607
2608 VkImageAspectFlags bandwidth_aspects = 0;
2609
2610 if (!FormatIsStencilOnly(attachment.format) &&
2611 (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2612 attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2613 if (FormatHasDepth(attachment.format)) {
2614 bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT;
2615 } else {
2616 bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT;
2617 }
2618 }
2619
2620 if (FormatHasStencil(attachment.format) &&
2621 (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD ||
2622 attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) {
2623 bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT;
2624 }
2625
2626 if (!bandwidth_aspects) {
2627 continue;
2628 }
2629
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002630 auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(),
2631 [&](const AttachmentInfo& info) { return info.framebufferAttachment == i; });
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002632 uint32_t untouched_aspects = bandwidth_aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002633 if (itr != render_pass_state.touchesAttachments.end()) {
Hans-Kristian Arntzen808bfa12021-06-18 13:52:45 +02002634 untouched_aspects &= ~itr->aspects;
2635 }
2636
2637 if (untouched_aspects) {
2638 skip |= LogPerformanceWarning(
2639 device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile,
2640 "%s Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) "
2641 "was never accessed by a pipeline or clear command. "
2642 "On tile-based architectures, LOAD_OP_LOAD and STORE_OP_STORE consume bandwidth and should not be part of the render pass "
2643 "if the attachments are not intended to be accessed.",
2644 VendorSpecificTag(kBPVendorArm), i, attachment.format, untouched_aspects);
2645 }
2646 }
2647 }
2648
Sam Walls0961ec02020-03-31 16:39:15 +01002649 return skip;
2650}
2651
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002652void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002653 ValidateBoundDescriptorSets(commandBuffer, "vkCmdDispatch()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002654}
2655
2656void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02002657 ValidateBoundDescriptorSets(commandBuffer, "vkCmdDispatchIndirect()");
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01002658}
2659
Camden Stocker9c051442019-11-06 14:28:43 -08002660bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice,
2661 const char* api_name) const {
2662 bool skip = false;
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002663 const auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Camden Stocker9c051442019-11-06 14:28:43 -08002664
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002665 if (bp_pd_state) {
2666 if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) {
2667 skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled,
2668 "Potential problem with calling %s() without first retrieving properties from "
2669 "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.",
2670 api_name);
2671 }
Camden Stocker9c051442019-11-06 14:28:43 -08002672 }
2673
2674 return skip;
2675}
2676
Camden83a9c372019-08-14 11:41:38 -06002677bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002678 uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const {
Camden83a9c372019-08-14 11:41:38 -06002679 bool skip = false;
2680
Camden Stocker9c051442019-11-06 14:28:43 -08002681 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR");
Camden83a9c372019-08-14 11:41:38 -06002682
Camden Stocker9c051442019-11-06 14:28:43 -08002683 return skip;
2684}
2685
2686bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode,
2687 uint32_t planeIndex,
2688 VkDisplayPlaneCapabilitiesKHR* pCapabilities) const {
2689 bool skip = false;
2690
2691 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR");
2692
2693 return skip;
2694}
2695
2696bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice,
2697 const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo,
2698 VkDisplayPlaneCapabilities2KHR* pCapabilities) const {
2699 bool skip = false;
2700
2701 skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR");
Camden83a9c372019-08-14 11:41:38 -06002702
2703 return skip;
2704}
Camden05de2d42019-08-19 10:23:56 -06002705
2706bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002707 VkImage* pSwapchainImages) const {
Camden05de2d42019-08-19 10:23:56 -06002708 bool skip = false;
2709
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002710 const auto swapchain_state = static_cast<SWAPCHAIN_STATE_BP*>(Get<SWAPCHAIN_NODE>(swapchain));
Camden05de2d42019-08-19 10:23:56 -06002711
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002712 if (swapchain_state && pSwapchainImages) {
Camden05de2d42019-08-19 10:23:56 -06002713 // Compare the preliminary value of *pSwapchainImageCount with the value this time:
Nathaniel Cesario39152e62021-07-02 13:04:16 -06002714 if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002715 skip |=
2716 LogWarning(device, kVUID_Core_Swapchain_PriorCount,
2717 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has "
2718 "been seen for pSwapchainImages.");
Camden05de2d42019-08-19 10:23:56 -06002719 }
Camden05de2d42019-08-19 10:23:56 -06002720
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002721 if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) {
2722 skip |= LogWarning(
2723 device, kVUID_BestPractices_Swapchain_InvalidCount,
2724 "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a "
Nadav Gevaf0808442021-05-21 13:51:25 -04002725 "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.",
Nathaniel Cesario4ce98382021-05-28 11:33:20 -06002726 *pSwapchainImageCount, swapchain_state->get_swapchain_image_count);
2727 }
2728 }
2729
Camden05de2d42019-08-19 10:23:56 -06002730 return skip;
2731}
2732
2733// Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002734bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002735 uint32_t requested_queue_family_property_count,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002736 const CALL_STATE call_state,
2737 const char* caller_name) const {
Camden05de2d42019-08-19 10:23:56 -06002738 bool skip = false;
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002739 // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count
2740 if (UNCALLED == call_state) {
2741 skip |= LogWarning(
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002742 bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002743 "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is "
2744 "recommended "
2745 "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.",
2746 caller_name, caller_name);
2747 // Then verify that pCount that is passed in on second call matches what was returned
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002748 } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) {
2749 skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002750 "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32
2751 ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32
2752 ". It is recommended to instead receive all the properties by calling %s with "
2753 "pQueueFamilyPropertyCount that was "
2754 "previously obtained by calling %s with NULL pQueueFamilyProperties.",
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002755 caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002756 caller_name);
Camden05de2d42019-08-19 10:23:56 -06002757 }
2758
2759 return skip;
2760}
2761
Jeff Bolz5c801d12019-10-09 10:38:45 -05002762bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV(
2763 VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const {
Camden Stocker82510582019-09-03 14:00:16 -06002764 bool skip = false;
2765
2766 for (uint32_t i = 0; i < bindInfoCount; i++) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06002767 const auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure);
Camden Stocker82510582019-09-03 14:00:16 -06002768 if (!as_state->memory_requirements_checked) {
2769 // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling
2770 // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with
2771 // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002772 skip |= LogWarning(
2773 device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery,
Camden Stocker82510582019-09-03 14:00:16 -06002774 "vkBindAccelerationStructureMemoryNV(): "
2775 "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.",
2776 report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str());
2777 }
2778 }
2779
2780 return skip;
2781}
2782
Camden05de2d42019-08-19 10:23:56 -06002783bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
2784 uint32_t* pQueueFamilyPropertyCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002785 VkQueueFamilyProperties* pQueueFamilyProperties) const {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002786 const auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002787 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002788 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state, *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002789 bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
2790 "vkGetPhysicalDeviceQueueFamilyProperties()");
2791 }
2792 return false;
Camden05de2d42019-08-19 10:23:56 -06002793}
2794
Mike Schuchardt2df08912020-12-15 16:28:09 -08002795bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
2796 uint32_t* pQueueFamilyPropertyCount,
2797 VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002798 const auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002799 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002800 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state, *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002801 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
2802 "vkGetPhysicalDeviceQueueFamilyProperties2()");
2803 }
2804 return false;
Camden05de2d42019-08-19 10:23:56 -06002805}
2806
Jeff Bolz5c801d12019-10-09 10:38:45 -05002807bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR(
Mike Schuchardt2df08912020-12-15 16:28:09 -08002808 VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002809 const auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002810 if (pQueueFamilyProperties && bp_pd_state) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002811 return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state, *pQueueFamilyPropertyCount,
Nathaniel Cesario56a96652020-12-30 13:23:42 -07002812 bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
2813 "vkGetPhysicalDeviceQueueFamilyProperties2KHR()");
2814 }
2815 return false;
Camden05de2d42019-08-19 10:23:56 -06002816}
2817
2818bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
2819 uint32_t* pSurfaceFormatCount,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002820 VkSurfaceFormatKHR* pSurfaceFormats) const {
Camden05de2d42019-08-19 10:23:56 -06002821 if (!pSurfaceFormats) return false;
Jeremy Gebben383b9a32021-09-08 16:31:33 -06002822 const auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06002823 const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState;
Camden05de2d42019-08-19 10:23:56 -06002824 bool skip = false;
2825 if (call_state == UNCALLED) {
2826 // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't
2827 // previously call this function with a NULL value of pSurfaceFormats:
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002828 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount,
2829 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior "
2830 "positive value has been seen for pSurfaceFormats.");
Camden05de2d42019-08-19 10:23:56 -06002831 } else {
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002832 if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) {
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002833 skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch,
2834 "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with "
2835 "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned "
2836 "when pSurfaceFormatCount was NULL.",
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06002837 *pSurfaceFormatCount, bp_pd_state->surface_formats_count);
Camden05de2d42019-08-19 10:23:56 -06002838 }
2839 }
2840 return skip;
2841}
Camden Stocker23cc47d2019-09-03 14:53:57 -06002842
2843bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
Jeff Bolz5c801d12019-10-09 10:38:45 -05002844 VkFence fence) const {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002845 bool skip = false;
2846
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002847 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2848 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
Camden Stocker23cc47d2019-09-03 14:53:57 -06002849 // 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 -07002850 layer_data::unordered_set<const IMAGE_STATE*> sparse_images;
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002851 // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state
2852 // in RecordQueueBindSparse.
Jeremy Gebbencbf22862021-03-03 12:01:22 -07002853 layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata;
Camden Stocker23cc47d2019-09-03 14:53:57 -06002854 // 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 -07002855 for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) {
2856 const auto& image_bind = bind_info.pImageBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002857 auto image_state = Get<IMAGE_STATE>(image_bind.image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002858 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002859 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002860 }
Camden Stocker23cc47d2019-09-03 14:53:57 -06002861 sparse_images.insert(image_state);
2862 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2863 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2864 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002865 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002866 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2867 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002868 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002869 }
2870 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002871 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002872 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002873 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002874 "vkQueueBindSparse(): Binding sparse memory to %s without first calling "
2875 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002876 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002877 }
2878 }
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002879 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2880 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002881 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002882 if (!image_state) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002883 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002884 }
Camden Stocker23cc47d2019-09-03 14:53:57 -06002885 sparse_images.insert(image_state);
2886 if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) {
2887 if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) {
2888 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002889 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002890 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2891 "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002892 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002893 }
2894 }
Jeremy Gebben6fbf8242021-06-21 09:14:46 -06002895 if (!image_state->memory_requirements_checked[0]) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002896 // For now just warning if sparse image binding occurs without calling to get reqs first
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002897 skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002898 "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling "
2899 "vkGetImageMemoryRequirements() to retrieve requirements.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002900 report_data->FormatHandle(image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002901 }
2902 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2903 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002904 sparse_images_with_metadata.insert(image_state);
Camden Stocker23cc47d2019-09-03 14:53:57 -06002905 }
2906 }
2907 }
2908 for (const auto& sparse_image_state : sparse_images) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002909 if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound &&
2910 sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) {
Camden Stocker23cc47d2019-09-03 14:53:57 -06002911 // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002912 skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState,
Mark Lobodzinskib6e2a282020-01-29 16:03:26 -07002913 "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no "
2914 "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.",
Jeremy Gebben14b0d1a2021-05-15 20:15:41 -06002915 report_data->FormatHandle(sparse_image_state->image()).c_str());
Camden Stocker23cc47d2019-09-03 14:53:57 -06002916 }
2917 }
2918 }
2919
2920 return skip;
2921}
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002922
Mark Lobodzinski84101d72020-04-24 09:43:48 -06002923void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo,
2924 VkFence fence, VkResult result) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07002925 if (result != VK_SUCCESS) {
Mark Lobodzinski205b7a02020-02-21 13:23:17 -07002926 return;
2927 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002928
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002929 for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) {
2930 const VkBindSparseInfo& bind_info = pBindInfo[bind_idx];
2931 for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) {
2932 const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i];
Nadav Gevaf0808442021-05-21 13:51:25 -04002933 auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image);
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002934 if (!image_state) {
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002935 continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here.
Nathaniel Cesarioce9b4812020-12-17 08:55:28 -07002936 }
Jeff Bolz46c0ea02019-10-09 13:06:29 -05002937 for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) {
2938 if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) {
2939 image_state->sparse_metadata_bound = true;
2940 }
2941 }
2942 }
2943 }
2944}
Camden Stocker0e0f89b2019-10-16 12:24:31 -07002945
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002946bool BestPractices::ClearAttachmentsIsFullClear(const CMD_BUFFER_STATE_BP* cmd, uint32_t rectCount,
2947 const VkClearRect* pRects) const {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002948 if (cmd->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
2949 // We don't know the accurate render area in a secondary,
2950 // so assume we clear the entire frame buffer.
2951 // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear.
2952 return true;
2953 }
2954
2955 // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command.
2956 for (uint32_t i = 0; i < rectCount; i++) {
2957 auto& rect = pRects[i];
2958 auto& render_area = cmd->activeRenderPassBeginInfo.renderArea;
2959 if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) {
2960 return true;
2961 }
2962 }
2963
2964 return false;
2965}
2966
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002967bool BestPractices::ValidateClearAttachment(VkCommandBuffer commandBuffer, const CMD_BUFFER_STATE_BP* cmd, uint32_t fb_attachment,
2968 uint32_t color_attachment, VkImageAspectFlags aspects, bool secondary) const {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002969 const RENDER_PASS_STATE* rp = cmd->activeRenderPass.get();
2970 bool skip = false;
2971
2972 if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) {
2973 return skip;
2974 }
2975
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002976 const auto& rp_state = cmd->render_pass_state;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002977
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002978 auto attachment_itr = std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(),
Hans-Kristian Arntzen8abca1e2021-06-16 13:57:45 +02002979 [&](const AttachmentInfo& info) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002980 return info.framebufferAttachment == fb_attachment;
2981 });
2982
2983 // Only report aspects which haven't been touched yet.
2984 VkImageAspectFlags new_aspects = aspects;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06002985 if (attachment_itr != rp_state.touchesAttachments.end()) {
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002986 new_aspects &= ~attachment_itr->aspects;
2987 }
2988
2989 // Warn if this is issued prior to Draw Cmd and clearing the entire attachment
2990 if (!cmd->hasDrawCmd) {
2991 skip |= LogPerformanceWarning(
2992 commandBuffer, kVUID_BestPractices_DrawState_ClearCmdBeforeDraw,
Hans-Kristian Arntzen4ddd6182021-06-18 12:16:33 +02002993 "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you "
2994 "use RenderPass LOAD_OP_CLEAR on attachments instead.",
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02002995 report_data->FormatHandle(commandBuffer).c_str());
2996 }
2997
2998 if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) &&
2999 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3000 skip |= LogPerformanceWarning(
3001 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3002 "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, "
3003 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3004 "it is more efficient.",
3005 secondary ? "vkCmdExecuteCommands(): " : "",
3006 report_data->FormatHandle(commandBuffer).c_str(), color_attachment);
3007 }
3008
3009 if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
3010 rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3011 skip |= LogPerformanceWarning(
3012 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3013 "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, "
3014 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3015 "it is more efficient.",
3016 secondary ? "vkCmdExecuteCommands(): " : "",
3017 report_data->FormatHandle(commandBuffer).c_str());
3018 }
3019
3020 if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) &&
3021 rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) {
3022 skip |= LogPerformanceWarning(
3023 device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad,
3024 "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, "
3025 "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as "
3026 "it is more efficient.",
3027 secondary ? "vkCmdExecuteCommands(): " : "",
3028 report_data->FormatHandle(commandBuffer).c_str());
3029 }
3030
3031 return skip;
3032}
3033
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003034bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount,
Camden Stockerf55721f2019-09-09 11:04:49 -06003035 const VkClearAttachment* pAttachments, uint32_t rectCount,
3036 const VkClearRect* pRects) const {
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003037 bool skip = false;
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003038 const auto* cb_node = GetCBState(commandBuffer);
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003039 if (!cb_node) return skip;
3040
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003041 if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) {
3042 // Defer checks to ExecuteCommands.
3043 return skip;
3044 }
3045
3046 // Only care about full clears, partial clears might have legitimate uses.
3047 if (!ClearAttachmentsIsFullClear(cb_node, rectCount, pRects)) {
3048 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003049 }
3050
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003051 // Check for uses of ClearAttachments along with LOAD_OP_LOAD,
3052 // as it can be more efficient to just use LOAD_OP_CLEAR
locke-lunargaecf2152020-05-12 17:15:41 -06003053 const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get();
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003054 if (rp) {
3055 const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass];
3056
3057 for (uint32_t i = 0; i < attachmentCount; i++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003058 const auto& attachment = pAttachments[i];
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003059
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003060 if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) {
3061 uint32_t color_attachment = attachment.colorAttachment;
3062 uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003063 skip |= ValidateClearAttachment(commandBuffer, cb_node,
3064 fb_attachment, color_attachment,
3065 attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003066 }
3067
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003068 if (subpass.pDepthStencilAttachment &&
3069 (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) {
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003070 uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment;
Hans-Kristian Arntzenb6586312021-07-05 11:43:39 +02003071 skip |= ValidateClearAttachment(commandBuffer, cb_node,
3072 fb_attachment, VK_ATTACHMENT_UNUSED,
3073 attachment.aspectMask, false);
Attilio Provenzano1d9a8362020-02-27 12:23:51 +00003074 }
3075 }
3076 }
3077
Nadav Gevaf0808442021-05-21 13:51:25 -04003078 if (VendorCheckEnabled(kBPVendorAMD)) {
3079 for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) {
3080 if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) {
3081 bool black_check = false;
3082 black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f;
3083 black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f;
3084 black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f;
3085 black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3086 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3087
3088 bool white_check = false;
3089 white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f;
3090 white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f;
3091 white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f;
3092 white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f &&
3093 pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f;
3094
3095 if (black_check && white_check) {
3096 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3097 "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value."
3098 "Consider changing to one of the following:"
3099 "RGBA(0, 0, 0, 0) "
3100 "RGBA(0, 0, 0, 1) "
3101 "RGBA(1, 1, 1, 0) "
3102 "RGBA(1, 1, 1, 1)",
3103 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3104 }
3105 } else {
3106 if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 &&
3107 pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) &&
3108 pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) {
3109 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues,
3110 "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil "
3111 "attachment %" PRId32 " is not a fast clear value."
3112 "Consider changing to one of the following:"
3113 "D=0.0f, S=0"
3114 "D=1.0f, S=0",
3115 VendorSpecificTag(kBPVendorAMD), attachment_idx);
3116 }
3117 }
3118 }
3119 }
3120
Camden Stockerf55721f2019-09-09 11:04:49 -06003121 return skip;
Camden Stocker0e0f89b2019-10-16 12:24:31 -07003122}
Attilio Provenzano02859b22020-02-27 14:17:28 +00003123
3124bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3125 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3126 const VkImageResolve* pRegions) const {
3127 bool skip = false;
3128
3129 skip |= VendorCheckEnabled(kBPVendorArm) &&
3130 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage,
3131 "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. "
3132 "This is a very slow and extremely bandwidth intensive path. "
3133 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3134 VendorSpecificTag(kBPVendorArm));
3135
3136 return skip;
3137}
3138
Jeff Leger178b1e52020-10-05 12:22:23 -04003139bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3140 const VkResolveImageInfo2KHR* pResolveImageInfo) const {
3141 bool skip = false;
3142
3143 skip |= VendorCheckEnabled(kBPVendorArm) &&
3144 LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage,
3145 "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. "
3146 "This is a very slow and extremely bandwidth intensive path. "
3147 "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.",
3148 VendorSpecificTag(kBPVendorArm));
3149
3150 return skip;
3151}
3152
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003153void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3154 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3155 const VkImageResolve* pRegions) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003156 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003157 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003158 auto* src = GetImageUsageState(srcImage);
3159 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003160
3161 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003162 QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource);
3163 QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003164 }
3165}
3166
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003167void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer,
3168 const VkResolveImageInfo2KHR* pResolveImageInfo) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003169 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003170 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003171 auto* src = GetImageUsageState(pResolveImageInfo->srcImage);
3172 auto* dst = GetImageUsageState(pResolveImageInfo->dstImage);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003173 uint32_t regionCount = pResolveImageInfo->regionCount;
3174
3175 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003176 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource);
3177 QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource);
Hans-Kristian Arntzen9e030f12021-03-17 13:09:30 +01003178 }
3179}
3180
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003181void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3182 const VkClearColorValue* pColor, uint32_t rangeCount,
3183 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003184 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003185 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003186 auto* dst = GetImageUsageState(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003187
3188 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003189 QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003190 }
3191}
3192
3193void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3194 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3195 const VkImageSubresourceRange* pRanges) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003196 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003197 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003198 auto* dst = GetImageUsageState(image);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003199
3200 for (uint32_t i = 0; i < rangeCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003201 QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003202 }
3203}
3204
3205void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3206 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3207 const VkImageCopy* pRegions) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003208 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003209 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003210 auto* src = GetImageUsageState(srcImage);
3211 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003212
3213 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003214 QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource);
3215 QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003216 }
3217}
3218
3219void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage,
3220 VkImageLayout dstImageLayout, uint32_t regionCount,
3221 const VkBufferImageCopy* pRegions) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003222 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003223 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003224 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003225
3226 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003227 QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003228 }
3229}
3230
3231void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3232 VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003233 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003234 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003235 auto* src = GetImageUsageState(srcImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003236
3237 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003238 QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003239 }
3240}
3241
3242void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3243 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3244 const VkImageBlit* pRegions, VkFilter filter) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003245 auto* cb = GetCBState(commandBuffer);
Hans-Kristian Arntzendd8acbb2021-03-22 13:41:47 +01003246 auto &funcs = cb->queue_submit_functions;
Hans-Kristian Arntzen5b466db2021-03-18 13:59:46 +01003247 auto* src = GetImageUsageState(srcImage);
3248 auto* dst = GetImageUsageState(dstImage);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003249
3250 for (uint32_t i = 0; i < regionCount; i++) {
Hans-Kristian Arntzenc8b831c2021-04-28 15:29:49 +02003251 QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource);
3252 QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource);
ZandroFargnoli1ced2b62020-06-18 16:49:34 +01003253 }
3254}
3255
Attilio Provenzano02859b22020-02-27 14:17:28 +00003256bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo,
3257 const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const {
3258 bool skip = false;
3259
3260 if (VendorCheckEnabled(kBPVendorArm)) {
3261 if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) {
3262 skip |= LogPerformanceWarning(
3263 device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes,
3264 "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). "
3265 "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D "
3266 "image) are actually used. If you need different wrapping modes, disregard this warning.",
Jeremy Gebbenda6b48f2021-05-13 10:46:18 -06003267 VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW);
Attilio Provenzano02859b22020-02-27 14:17:28 +00003268 }
3269
3270 if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) {
3271 skip |= LogPerformanceWarning(
3272 device, kVUID_BestPractices_CreateSampler_LodClamping,
3273 "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. "
3274 "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod "
3275 "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.",
3276 VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod);
3277 }
3278
3279 if (pCreateInfo->mipLodBias != 0.0f) {
3280 skip |=
3281 LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias,
3282 "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient "
3283 "descriptors being created and may cause reduced performance.",
3284 VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias);
3285 }
3286
3287 if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3288 pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER ||
3289 pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) &&
3290 (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) {
3291 skip |= LogPerformanceWarning(
3292 device, kVUID_BestPractices_CreateSampler_BorderClampColor,
3293 "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. "
3294 "This will lead to less efficient descriptors being created and may cause reduced performance. "
3295 "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.",
3296 VendorSpecificTag(kBPVendorArm));
3297 }
3298
3299 if (pCreateInfo->unnormalizedCoordinates) {
3300 skip |= LogPerformanceWarning(
3301 device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates,
3302 "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient "
3303 "descriptors being created and may cause reduced performance.",
3304 VendorSpecificTag(kBPVendorArm));
3305 }
3306
3307 if (pCreateInfo->anisotropyEnable) {
3308 skip |= LogPerformanceWarning(
3309 device, kVUID_BestPractices_CreateSampler_Anisotropy,
3310 "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created "
3311 "and may cause reduced performance.",
3312 VendorSpecificTag(kBPVendorArm));
3313 }
3314 }
3315
3316 return skip;
3317}
Sam Walls8e77e4f2020-03-16 20:47:40 +00003318
Nadav Gevaf0808442021-05-21 13:51:25 -04003319void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount,
3320 const VkGraphicsPipelineCreateInfo* pCreateInfos,
3321 const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines,
3322 void* cgpl_state) {
3323 ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator,
3324 pPipelines);
3325 // AMD best practice
3326 num_pso += createInfoCount;
3327}
3328
3329bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount,
3330 const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount,
3331 const VkCopyDescriptorSet* pDescriptorCopies) const {
3332 bool skip = false;
3333 if (VendorCheckEnabled(kBPVendorAMD)) {
3334 if (descriptorCopyCount > 0) {
3335 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors,
3336 "%s Performance warning: copying descriptor sets is not recommended",
3337 VendorSpecificTag(kBPVendorAMD));
3338 }
3339 }
3340
3341 return skip;
3342}
3343
3344bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device,
3345 const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo,
3346 const VkAllocationCallbacks* pAllocator,
3347 VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const {
3348 bool skip = false;
3349 if (VendorCheckEnabled(kBPVendorAMD)) {
3350 skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate,
3351 "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using "
3352 "vkUpdateDescriptorSet instead",
3353 VendorSpecificTag(kBPVendorAMD));
3354 }
3355
3356 return skip;
3357}
3358
3359bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout,
3360 const VkClearColorValue* pColor, uint32_t rangeCount,
3361 const VkImageSubresourceRange* pRanges) const {
3362 bool skip = false;
3363 if (VendorCheckEnabled(kBPVendorAMD)) {
3364 skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_ClearImage,
3365 "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3366 "vkCmdClearAttachments instead",
3367 VendorSpecificTag(kBPVendorAMD));
3368 }
3369
3370 return skip;
3371}
3372
3373bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image,
3374 VkImageLayout imageLayout,
3375 const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount,
3376 const VkImageSubresourceRange* pRanges) const {
3377 bool skip = false;
3378 if (VendorCheckEnabled(kBPVendorAMD)) {
3379 skip |= LogPerformanceWarning(
3380 device, kVUID_BestPractices_ClearAttachment_ClearImage,
3381 "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or "
3382 "vkCmdClearAttachments instead",
3383 VendorSpecificTag(kBPVendorAMD));
3384 }
3385
3386 return skip;
3387}
3388
3389bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo,
3390 const VkAllocationCallbacks* pAllocator,
3391 VkPipelineLayout* pPipelineLayout) const {
3392 bool skip = false;
3393 if (VendorCheckEnabled(kBPVendorAMD)) {
3394 // Descriptor sets cost 1 DWORD each.
3395 // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF.
3396 // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON.
3397 // Push constants cost 1 DWORD per 4 bytes in the Push constant range.
3398 uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS
3399 for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003400 auto descriptor_set_layout_state = GetShared<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]);
Nadav Gevaf0808442021-05-21 13:51:25 -04003401 pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * (robust_buffer_access ? 4 : 2);
3402 }
3403
3404 for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) {
3405 pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4;
3406 }
3407
3408 if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) {
3409 skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall,
3410 "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts."
3411 "Descriptor sets cost 1 DWORD each. "
3412 "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. "
3413 "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. "
3414 "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ",
3415 VendorSpecificTag(kBPVendorAMD));
3416 }
3417 }
3418
3419 return skip;
3420}
3421
3422bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout,
3423 VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount,
3424 const VkImageCopy* pRegions) const {
3425 bool skip = false;
3426 std::stringstream src_image_hex;
3427 std::stringstream dst_image_hex;
3428 src_image_hex << "0x" << std::hex << HandleToUint64(srcImage);
3429 dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage);
3430
3431 if (VendorCheckEnabled(kBPVendorAMD)) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003432 const auto src_state = Get<IMAGE_STATE>(srcImage);
3433 const auto dst_state = Get<IMAGE_STATE>(dstImage);
Nadav Gevaf0808442021-05-21 13:51:25 -04003434
3435 if (src_state && dst_state) {
3436 VkImageTiling src_Tiling = src_state->createInfo.tiling;
3437 VkImageTiling dst_Tiling = dst_state->createInfo.tiling;
3438 if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) {
3439 skip |=
3440 LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy,
3441 "%s Performance warning: image %s and image %s have differing tilings. Use buffer to "
3442 "image (vkCmdCopyImageToBuffer) "
3443 "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image "
3444 "copies when converting between linear and optimal images",
3445 VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str());
3446 }
3447 }
3448 }
3449
3450 return skip;
3451}
3452
3453bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint,
3454 VkPipeline pipeline) const {
3455 bool skip = false;
3456
3457 if (VendorCheckEnabled(kBPVendorAMD)) {
3458 if (pipelines_used_in_frame.find(pipeline) != pipelines_used_in_frame.end()) {
3459 skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind,
3460 "%s Performance warning: Pipeline %s was bound twice in the frame. Keep pipeline state changes to a minimum,"
3461 "for example, by sorting draw calls by pipeline.",
3462 VendorSpecificTag(kBPVendorAMD), report_data->FormatHandle(pipeline).c_str());
3463 }
3464 }
3465
3466 return skip;
3467}
3468
3469void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits,
3470 VkFence fence, VkResult result) {
3471 // AMD best practice
3472 num_queue_submissions += submitCount;
3473}
3474
3475bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const {
3476 bool skip = false;
3477
3478 if (VendorCheckEnabled(kBPVendorAMD)) {
3479 if (num_queue_submissions > kNumberOfSubmissionWarningLimitAMD) {
3480 skip |= LogPerformanceWarning(
3481 device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions,
3482 "%s Performance warning: command buffers submitted %" PRId32 " times this frame. Submitting command buffers has a CPU "
3483 "and GPU overhead. Submit fewer times to incur less overhead.",
3484 VendorSpecificTag(kBPVendorAMD), num_queue_submissions);
3485 }
3486 }
3487
3488 return skip;
3489}
3490
3491void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask,
3492 VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags,
3493 uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers,
3494 uint32_t bufferMemoryBarrierCount,
3495 const VkBufferMemoryBarrier* pBufferMemoryBarriers,
3496 uint32_t imageMemoryBarrierCount,
3497 const VkImageMemoryBarrier* pImageMemoryBarriers) {
3498 num_barriers_objects += memoryBarrierCount;
3499 num_barriers_objects += imageMemoryBarrierCount;
3500 num_barriers_objects += bufferMemoryBarrierCount;
3501}
3502
3503void BestPractices::ManualPostCallRecordCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3504 const VkAllocationCallbacks* pAllocator, VkFence* pFence, VkResult result) {
3505 // AMD best practice
3506 if (result == VK_SUCCESS) {
3507 num_fence_objects++;
3508 }
3509}
3510
3511void BestPractices::ManualPostCallRecordCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3512 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore,
3513 VkResult result) {
3514 // AMD best practice
3515 if (result == VK_SUCCESS) {
3516 num_semaphore_objects++;
3517 }
3518}
3519
3520bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo,
3521 const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const {
3522 bool skip = false;
3523 if (VendorCheckEnabled(kBPVendorAMD)) {
3524 if (num_semaphore_objects > kMaxRecommendedSemaphoreObjectsSizeAMD) {
3525 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores,
3526 "%s Performance warning: High number of vkSemaphore objects created."
3527 "Minimize the amount of queue synchronization that is used. "
3528 "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.",
3529 VendorSpecificTag(kBPVendorAMD));
3530 }
3531 }
3532
3533 return skip;
3534}
3535
3536bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo,
3537 const VkAllocationCallbacks* pAllocator, VkFence* pFence) const {
3538 bool skip = false;
3539 if (VendorCheckEnabled(kBPVendorAMD)) {
3540 if (num_fence_objects > kMaxRecommendedFenceObjectsSizeAMD) {
3541 skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences,
3542 "%s Performance warning: High number of VkFence objects created."
3543 "Minimize the amount of CPU-GPU synchronization that is used. "
3544 "Semaphores and fences have overhead.Each fence has a CPU and GPU cost with it.",
3545 VendorSpecificTag(kBPVendorAMD));
3546 }
3547 }
3548
3549 return skip;
3550}
3551
Sam Walls8e77e4f2020-03-16 20:47:40 +00003552void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); }
3553
3554bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) {
3555 // look for a cache hit
3556 auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; });
3557 if (hit != _entries.end()) {
3558 // mark the cache hit as being most recently used
3559 hit->age = iteration++;
3560 return true;
3561 }
3562
3563 // if there's no cache hit, we need to model the entry being inserted into the cache
3564 CacheEntry new_entry = {value, iteration};
3565 if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) {
3566 // if there is still space left in the cache, use the next available slot
3567 *(_entries.begin() + iteration) = new_entry;
3568 } else {
3569 // otherwise replace the least recently used cache entry
3570 auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; });
3571 *lru = new_entry;
3572 }
3573 iteration++;
3574 return false;
3575}
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003576
3577bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout,
3578 VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003579 const auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003580 bool skip = false;
3581 if (swapchain_data && swapchain_data->images.size() == 0) {
3582 skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound,
3583 "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call "
3584 "vkGetSwapchainImagesKHR after swapchain creation.");
3585 }
3586 return skip;
3587}
3588
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003589void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) {
3590 if (no_pointer) {
3591 if (UNCALLED == call_state) {
3592 call_state = QUERY_COUNT;
3593 }
3594 } else { // Save queue family properties
3595 call_state = QUERY_DETAILS;
3596 }
3597}
3598
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003599void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice,
3600 uint32_t* pQueueFamilyPropertyCount,
3601 VkQueueFamilyProperties* pQueueFamilyProperties) {
3602 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount,
3603 pQueueFamilyProperties);
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003604 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003605 if (bp_pd_state) {
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003606 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState,
3607 nullptr == pQueueFamilyProperties);
3608 }
3609}
3610
3611void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice,
3612 uint32_t* pQueueFamilyPropertyCount,
3613 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3614 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount,
3615 pQueueFamilyProperties);
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003616 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003617 if (bp_pd_state) {
3618 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State,
3619 nullptr == pQueueFamilyProperties);
3620 }
3621}
3622
3623void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice,
3624 uint32_t* pQueueFamilyPropertyCount,
3625 VkQueueFamilyProperties2* pQueueFamilyProperties) {
3626 ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount,
3627 pQueueFamilyProperties);
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003628 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario56a96652020-12-30 13:23:42 -07003629 if (bp_pd_state) {
3630 CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState,
3631 nullptr == pQueueFamilyProperties);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003632 }
3633}
3634
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003635void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) {
3636 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures);
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003637 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003638 if (bp_pd_state) {
3639 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3640 }
3641}
3642
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003643void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice,
3644 VkPhysicalDeviceFeatures2* pFeatures) {
3645 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures);
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003646 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003647 if (bp_pd_state) {
3648 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3649 }
3650}
3651
Nathaniel Cesariof121d122020-10-08 13:09:46 -06003652void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice,
3653 VkPhysicalDeviceFeatures2* pFeatures) {
3654 ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures);
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003655 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003656 if (bp_pd_state) {
3657 bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS;
3658 }
3659}
3660
3661void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice,
3662 VkSurfaceKHR surface,
3663 VkSurfaceCapabilitiesKHR* pSurfaceCapabilities,
3664 VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003665 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003666 if (bp_pd_state) {
3667 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3668 }
3669}
3670
3671void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR(
3672 VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3673 VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003674 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003675 if (bp_pd_state) {
3676 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3677 }
3678}
3679
3680void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice,
3681 VkSurfaceKHR surface,
3682 VkSurfaceCapabilities2EXT* pSurfaceCapabilities,
3683 VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003684 auto* bp_pd_state = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003685 if (bp_pd_state) {
3686 bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS;
3687 }
3688}
3689
3690void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice,
3691 VkSurfaceKHR surface, uint32_t* pPresentModeCount,
3692 VkPresentModeKHR* pPresentModes, VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003693 auto* bp_pd_data = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003694 if (bp_pd_data) {
3695 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState;
3696
3697 if (*pPresentModeCount) {
3698 if (call_state < QUERY_COUNT) {
3699 call_state = QUERY_COUNT;
3700 }
3701 }
3702 if (pPresentModes) {
3703 if (call_state < QUERY_DETAILS) {
3704 call_state = QUERY_DETAILS;
3705 }
3706 }
3707 }
3708}
3709
3710void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface,
3711 uint32_t* pSurfaceFormatCount,
3712 VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003713 auto* bp_pd_data = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003714 if (bp_pd_data) {
3715 auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState;
3716
3717 if (*pSurfaceFormatCount) {
3718 if (call_state < QUERY_COUNT) {
3719 call_state = QUERY_COUNT;
3720 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003721 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003722 }
3723 if (pSurfaceFormats) {
3724 if (call_state < QUERY_DETAILS) {
3725 call_state = QUERY_DETAILS;
3726 }
3727 }
3728 }
3729}
3730
3731void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice,
3732 const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo,
3733 uint32_t* pSurfaceFormatCount,
3734 VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003735 auto* bp_pd_data = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003736 if (bp_pd_data) {
3737 if (*pSurfaceFormatCount) {
3738 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) {
3739 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT;
3740 }
Jeremy Gebbenc7a834a2021-09-08 18:39:30 -06003741 bp_pd_data->surface_formats_count = *pSurfaceFormatCount;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003742 }
3743 if (pSurfaceFormats) {
3744 if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) {
3745 bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS;
3746 }
3747 }
3748 }
3749}
3750
3751void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice,
3752 uint32_t* pPropertyCount,
3753 VkDisplayPlanePropertiesKHR* pProperties,
3754 VkResult result) {
Jeremy Gebben383b9a32021-09-08 16:31:33 -06003755 auto* bp_pd_data = GetPhysicalDeviceState(physicalDevice);
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003756 if (bp_pd_data) {
3757 if (*pPropertyCount) {
3758 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) {
3759 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT;
3760 }
3761 }
3762 if (pProperties) {
3763 if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) {
3764 bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS;
3765 }
3766 }
3767 }
3768}
3769
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003770void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain,
3771 uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages,
3772 VkResult result) {
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003773 auto swapchain_state = static_cast<SWAPCHAIN_STATE_BP*>(Get<SWAPCHAIN_NODE>(swapchain));
Nathaniel Cesario39152e62021-07-02 13:04:16 -06003774 if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) {
3775 if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) {
3776 swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS;
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003777 }
3778 }
3779}
3780
Nadav Gevaf0808442021-05-21 13:51:25 -04003781void BestPractices::ManualPostCallRecordCreateDevice(VkPhysicalDevice gpu, const VkDeviceCreateInfo* pCreateInfo,
3782 const VkAllocationCallbacks* pAllocator, VkDevice* pDevice, VkResult result) {
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003783 if (VK_SUCCESS == result) {
Nadav Gevaf0808442021-05-21 13:51:25 -04003784 if ((pCreateInfo->pEnabledFeatures != nullptr) && (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) {
3785 robust_buffer_access = true;
3786 }
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003787 }
Nathaniel Cesario24184fe2020-10-06 12:46:12 -06003788}
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003789
3790void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) {
3791 ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence);
3792
Jeremy Gebbenb20a8242021-11-05 15:14:43 -06003793 auto queue_state = Get<QUEUE_STATE>(queue);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003794 for (uint32_t submit = 0; submit < submitCount; submit++) {
Hans-Kristian Arntzen69ace7d2021-04-28 14:17:19 +02003795 const auto& submit_info = pSubmits[submit];
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003796 for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) {
Jeremy Gebben7c2cd8b2021-08-11 15:40:38 -06003797 auto* cb = GetCBState(submit_info.pCommandBuffers[cb_index]);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003798 for (auto &func : cb->queue_submit_functions) {
Jeremy Gebbene5361dd2021-11-18 14:23:56 -07003799 func(*this, *queue_state, *cb);
Hans-Kristian Arntzen66f4b522021-03-22 11:35:58 +01003800 }
3801 }
3802 }
3803}