Jeremy Gebben | 610d3a6 | 2022-01-01 12:53:17 -0700 | [diff] [blame] | 1 | /* Copyright (c) 2015-2022 The Khronos Group Inc. |
| 2 | * Copyright (c) 2015-2022 Valve Corporation |
| 3 | * Copyright (c) 2015-2022 LunarG, Inc. |
Nadav Geva | 41c12a2 | 2021-05-21 13:14:05 -0400 | [diff] [blame] | 4 | * Modifications Copyright (C) 2020 Advanced Micro Devices, Inc. All rights reserved. |
Camden | eaa86ea | 2019-07-26 11:00:09 -0600 | [diff] [blame] | 5 | * |
| 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 Geva | 41c12a2 | 2021-05-21 13:14:05 -0400 | [diff] [blame] | 19 | * Author: Nadav Geva <nadav.geva@amd.com> |
Camden | eaa86ea | 2019-07-26 11:00:09 -0600 | [diff] [blame] | 20 | */ |
| 21 | |
Mark Lobodzinski | 57b8ae8 | 2020-02-20 16:37:14 -0700 | [diff] [blame] | 22 | #include "best_practices_validation.h" |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 23 | #include "layer_chassis_dispatch.h" |
Camden Stocker | 0a660ce | 2019-08-27 15:30:40 -0600 | [diff] [blame] | 24 | #include "best_practices_error_enums.h" |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 25 | #include "shader_validation.h" |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 26 | #include "sync_utils.h" |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 27 | #include "cmd_buffer_state.h" |
| 28 | #include "device_state.h" |
| 29 | #include "render_pass_state.h" |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 30 | |
| 31 | #include <string> |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 32 | #include <bitset> |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 33 | #include <memory> |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 34 | |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 35 | struct VendorSpecificInfo { |
Mark Lobodzinski | 90eea5b | 2020-05-15 12:54:00 -0600 | [diff] [blame] | 36 | EnableFlags vendor_id; |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 37 | std::string name; |
| 38 | }; |
| 39 | |
LawG4 | 7546309 | 2022-02-22 10:45:54 +0000 | [diff] [blame] | 40 | const std::map<BPVendorFlagBits, VendorSpecificInfo> kVendorInfo = {{kBPVendorArm, {vendor_specific_arm, "Arm"}}, |
| 41 | {kBPVendorAMD, {vendor_specific_amd, "AMD"}}, |
Rodrigo Locatti | c779cb3 | 2022-02-25 19:26:31 -0300 | [diff] [blame] | 42 | {kBPVendorIMG, {vendor_specific_img, "IMG"}}, |
| 43 | {kBPVendorNVIDIA, {vendor_specific_nvidia, "NVIDIA"}}}; |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 44 | |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 45 | const 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 | |
| 53 | const 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 Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 61 | ReadLockGuard BestPractices::ReadLock() { |
| 62 | if (fine_grained_locking) { |
| 63 | return ReadLockGuard(validation_object_mutex, std::defer_lock); |
| 64 | } else { |
| 65 | return ReadLockGuard(validation_object_mutex); |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | WriteLockGuard BestPractices::WriteLock() { |
| 70 | if (fine_grained_locking) { |
| 71 | return WriteLockGuard(validation_object_mutex, std::defer_lock); |
| 72 | } else { |
| 73 | return WriteLockGuard(validation_object_mutex); |
| 74 | } |
| 75 | } |
| 76 | |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 77 | std::shared_ptr<CMD_BUFFER_STATE> BestPractices::CreateCmdBufferState(VkCommandBuffer cb, |
| 78 | const VkCommandBufferAllocateInfo* pCreateInfo, |
Jeremy Gebben | cd7fa28 | 2021-10-27 10:25:32 -0600 | [diff] [blame] | 79 | const COMMAND_POOL_STATE* pool) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 80 | return std::static_pointer_cast<CMD_BUFFER_STATE>(std::make_shared<bp_state::CommandBuffer>(this, cb, pCreateInfo, pool)); |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 81 | } |
| 82 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 83 | bp_state::CommandBuffer::CommandBuffer(BestPractices* bp, VkCommandBuffer cb, const VkCommandBufferAllocateInfo* pCreateInfo, |
| 84 | const COMMAND_POOL_STATE* pool) |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 85 | : CMD_BUFFER_STATE(bp, cb, pCreateInfo, pool) {} |
| 86 | |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 87 | bool BestPractices::VendorCheckEnabled(BPVendorFlags vendors) const { |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 88 | for (const auto& vendor : kVendorInfo) { |
Mark Lobodzinski | 90eea5b | 2020-05-15 12:54:00 -0600 | [diff] [blame] | 89 | if (vendors & vendor.first && enabled[vendor.second.vendor_id]) { |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 90 | return true; |
| 91 | } |
| 92 | } |
| 93 | return false; |
| 94 | } |
| 95 | |
| 96 | const char* VendorSpecificTag(BPVendorFlags vendors) { |
| 97 | // Cache built vendor tags in a map |
Jeremy Gebben | cbf2286 | 2021-03-03 12:01:22 -0700 | [diff] [blame] | 98 | static layer_data::unordered_map<BPVendorFlags, std::string> tag_map; |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 99 | |
| 100 | auto res = tag_map.find(vendors); |
| 101 | if (res == tag_map.end()) { |
| 102 | // Build the vendor tag string |
| 103 | std::stringstream vendor_tag; |
| 104 | |
| 105 | vendor_tag << "["; |
| 106 | bool first_vendor = true; |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 107 | for (const auto& vendor : kVendorInfo) { |
Attilio Provenzano | 19d6a98 | 2020-02-27 12:41:41 +0000 | [diff] [blame] | 108 | if (vendors & vendor.first) { |
| 109 | if (!first_vendor) { |
| 110 | vendor_tag << ", "; |
| 111 | } |
| 112 | vendor_tag << vendor.second.name; |
| 113 | first_vendor = false; |
| 114 | } |
| 115 | } |
| 116 | vendor_tag << "]"; |
| 117 | |
| 118 | tag_map[vendors] = vendor_tag.str(); |
| 119 | res = tag_map.find(vendors); |
| 120 | } |
| 121 | |
| 122 | return res->second.c_str(); |
| 123 | } |
| 124 | |
Mark Lobodzinski | 6167e10 | 2020-02-24 17:03:55 -0700 | [diff] [blame] | 125 | const char* DepReasonToString(ExtDeprecationReason reason) { |
| 126 | switch (reason) { |
| 127 | case kExtPromoted: |
| 128 | return "promoted to"; |
| 129 | break; |
| 130 | case kExtObsoleted: |
| 131 | return "obsoleted by"; |
| 132 | break; |
| 133 | case kExtDeprecated: |
| 134 | return "deprecated by"; |
| 135 | break; |
| 136 | default: |
| 137 | return ""; |
| 138 | break; |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | bool BestPractices::ValidateDeprecatedExtensions(const char* api_name, const char* extension_name, uint32_t version, |
| 143 | const char* vuid) const { |
| 144 | bool skip = false; |
| 145 | auto dep_info_it = deprecated_extensions.find(extension_name); |
| 146 | if (dep_info_it != deprecated_extensions.end()) { |
| 147 | auto dep_info = dep_info_it->second; |
Mark Lobodzinski | 6a14970 | 2020-05-14 12:21:34 -0600 | [diff] [blame] | 148 | if (((dep_info.target.compare("VK_VERSION_1_1") == 0) && (version >= VK_API_VERSION_1_1)) || |
Tony-LunarG | c30b59f | 2022-02-15 11:02:36 -0700 | [diff] [blame] | 149 | ((dep_info.target.compare("VK_VERSION_1_2") == 0) && (version >= VK_API_VERSION_1_2)) || |
| 150 | ((dep_info.target.compare("VK_VERSION_1_3") == 0) && (version >= VK_API_VERSION_1_3))) { |
Mark Lobodzinski | 6167e10 | 2020-02-24 17:03:55 -0700 | [diff] [blame] | 151 | skip |= |
| 152 | LogWarning(instance, vuid, "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.", |
| 153 | api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str()); |
Mark Lobodzinski | 6a14970 | 2020-05-14 12:21:34 -0600 | [diff] [blame] | 154 | } else if (dep_info.target.find("VK_VERSION") == std::string::npos) { |
Mark Lobodzinski | 6167e10 | 2020-02-24 17:03:55 -0700 | [diff] [blame] | 155 | if (dep_info.target.length() == 0) { |
| 156 | skip |= LogWarning(instance, vuid, |
| 157 | "%s(): Attempting to enable deprecated extension %s, but this extension has been deprecated " |
| 158 | "without replacement.", |
| 159 | api_name, extension_name); |
| 160 | } else { |
| 161 | skip |= LogWarning(instance, vuid, |
| 162 | "%s(): Attempting to enable deprecated extension %s, but this extension has been %s %s.", |
| 163 | api_name, extension_name, DepReasonToString(dep_info.reason), (dep_info.target).c_str()); |
| 164 | } |
| 165 | } |
| 166 | } |
| 167 | return skip; |
| 168 | } |
| 169 | |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 170 | bool BestPractices::ValidateSpecialUseExtensions(const char* api_name, const char* extension_name, const SpecialUseVUIDs& special_use_vuids) const |
| 171 | { |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 172 | bool skip = false; |
| 173 | auto dep_info_it = special_use_extensions.find(extension_name); |
| 174 | |
| 175 | if (dep_info_it != special_use_extensions.end()) { |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 176 | const char* const format = "%s(): Attempting to enable extension %s, but this extension is intended to support %s " |
| 177 | "and it is strongly recommended that it be otherwise avoided."; |
| 178 | auto& special_uses = dep_info_it->second; |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 179 | |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 180 | if (special_uses.find("cadsupport") != std::string::npos) { |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 181 | skip |= LogWarning(instance, special_use_vuids.cadsupport, format, api_name, extension_name, |
| 182 | "specialized functionality used by CAD/CAM applications"); |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 183 | } |
| 184 | if (special_uses.find("d3demulation") != std::string::npos) { |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 185 | skip |= LogWarning(instance, special_use_vuids.d3demulation, format, api_name, extension_name, |
| 186 | "D3D emulation layers, and applications ported from D3D, by adding functionality specific to D3D"); |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 187 | } |
| 188 | if (special_uses.find("devtools") != std::string::npos) { |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 189 | skip |= LogWarning(instance, special_use_vuids.devtools, format, api_name, extension_name, |
| 190 | "developer tools such as capture-replay libraries"); |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 191 | } |
| 192 | if (special_uses.find("debugging") != std::string::npos) { |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 193 | skip |= LogWarning(instance, special_use_vuids.debugging, format, api_name, extension_name, |
| 194 | "use by applications when debugging"); |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 195 | } |
| 196 | if (special_uses.find("glemulation") != std::string::npos) { |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 197 | skip |= LogWarning(instance, special_use_vuids.glemulation, format, api_name, extension_name, |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 198 | "OpenGL and/or OpenGL ES emulation layers, and applications ported from those APIs, by adding functionality " |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 199 | "specific to those APIs"); |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 200 | } |
Mark Lobodzinski | 057724a | 2020-11-09 17:13:18 -0700 | [diff] [blame] | 201 | } |
| 202 | return skip; |
| 203 | } |
| 204 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 205 | bool BestPractices::PreCallValidateCreateInstance(const VkInstanceCreateInfo* pCreateInfo, const VkAllocationCallbacks* pAllocator, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 206 | VkInstance* pInstance) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 207 | bool skip = false; |
| 208 | |
| 209 | for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) { |
| 210 | if (white_list(pCreateInfo->ppEnabledExtensionNames[i], kDeviceExtensionNames)) { |
Camden Stocker | 11ecf51 | 2020-01-21 16:06:49 -0800 | [diff] [blame] | 211 | skip |= LogWarning(instance, kVUID_BestPractices_CreateInstance_ExtensionMismatch, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 212 | "vkCreateInstance(): Attempting to enable Device Extension %s at CreateInstance time.", |
| 213 | pCreateInfo->ppEnabledExtensionNames[i]); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 214 | } |
Mark Lobodzinski | 17d8dc6 | 2020-06-03 08:48:58 -0600 | [diff] [blame] | 215 | uint32_t specified_version = |
| 216 | (pCreateInfo->pApplicationInfo ? pCreateInfo->pApplicationInfo->apiVersion : VK_API_VERSION_1_0); |
| 217 | skip |= ValidateDeprecatedExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], specified_version, |
Mark Lobodzinski | 6167e10 | 2020-02-24 17:03:55 -0700 | [diff] [blame] | 218 | kVUID_BestPractices_CreateInstance_DeprecatedExtension); |
Hannes Harnisch | 607d1d9 | 2021-07-10 18:44:56 +0200 | [diff] [blame] | 219 | skip |= ValidateSpecialUseExtensions("CreateInstance", pCreateInfo->ppEnabledExtensionNames[i], kSpecialUseInstanceVUIDs); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 220 | } |
| 221 | |
| 222 | return skip; |
| 223 | } |
| 224 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 225 | bool BestPractices::PreCallValidateCreateDevice(VkPhysicalDevice physicalDevice, const VkDeviceCreateInfo* pCreateInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 226 | const VkAllocationCallbacks* pAllocator, VkDevice* pDevice) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 227 | bool skip = false; |
| 228 | |
| 229 | // get API version of physical device passed when creating device. |
| 230 | VkPhysicalDeviceProperties physical_device_properties{}; |
| 231 | DispatchGetPhysicalDeviceProperties(physicalDevice, &physical_device_properties); |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 232 | auto device_api_version = physical_device_properties.apiVersion; |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 233 | |
| 234 | // check api versions and warn if instance api Version is higher than version on device. |
Jeremy Gebben | 404f6ac | 2021-10-28 12:33:28 -0600 | [diff] [blame] | 235 | if (api_version > device_api_version) { |
| 236 | std::string inst_api_name = StringAPIVersion(api_version); |
Mark Lobodzinski | 6088078 | 2020-08-11 08:02:07 -0600 | [diff] [blame] | 237 | std::string dev_api_name = StringAPIVersion(device_api_version); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 238 | |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 239 | skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_API_Mismatch, |
| 240 | "vkCreateDevice(): API Version of current instance, %s is higher than API Version on device, %s", |
| 241 | inst_api_name.c_str(), dev_api_name.c_str()); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 242 | } |
| 243 | |
Rodrigo Locatti | c2d5cf4 | 2022-03-01 18:05:26 -0300 | [diff] [blame] | 244 | std::vector<std::string> extensions; |
| 245 | { |
| 246 | uint32_t property_count = 0; |
| 247 | if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, nullptr) == VK_SUCCESS) { |
| 248 | std::vector<VkExtensionProperties> property_list(property_count); |
| 249 | if (DispatchEnumerateDeviceExtensionProperties(physicalDevice, nullptr, &property_count, property_list.data()) == VK_SUCCESS) { |
| 250 | extensions.reserve(property_list.size()); |
| 251 | for (const VkExtensionProperties& properties : property_list) { |
| 252 | extensions.push_back(properties.extensionName); |
| 253 | } |
| 254 | } |
| 255 | } |
| 256 | } |
| 257 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 258 | for (uint32_t i = 0; i < pCreateInfo->enabledExtensionCount; i++) { |
Rodrigo Locatti | 8dde2ff | 2022-03-01 18:06:08 -0300 | [diff] [blame] | 259 | const char *extension_name = pCreateInfo->ppEnabledExtensionNames[i]; |
| 260 | |
| 261 | if (white_list(extension_name, kInstanceExtensionNames)) { |
Camden Stocker | 11ecf51 | 2020-01-21 16:06:49 -0800 | [diff] [blame] | 262 | skip |= LogWarning(instance, kVUID_BestPractices_CreateDevice_ExtensionMismatch, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 263 | "vkCreateDevice(): Attempting to enable Instance Extension %s at CreateDevice time.", |
Rodrigo Locatti | 8dde2ff | 2022-03-01 18:06:08 -0300 | [diff] [blame] | 264 | extension_name); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 265 | } |
Rodrigo Locatti | 8dde2ff | 2022-03-01 18:06:08 -0300 | [diff] [blame] | 266 | |
| 267 | skip |= ValidateDeprecatedExtensions("CreateDevice", extension_name, api_version, |
Mark Lobodzinski | 6167e10 | 2020-02-24 17:03:55 -0700 | [diff] [blame] | 268 | kVUID_BestPractices_CreateDevice_DeprecatedExtension); |
Rodrigo Locatti | 8dde2ff | 2022-03-01 18:06:08 -0300 | [diff] [blame] | 269 | skip |= ValidateSpecialUseExtensions("CreateDevice", extension_name, kSpecialUseDeviceVUIDs); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 270 | } |
| 271 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 272 | const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 273 | if ((bp_pd_state->vkGetPhysicalDeviceFeaturesState == UNCALLED) && (pCreateInfo->pEnabledFeatures != NULL)) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 274 | skip |= LogWarning(device, kVUID_BestPractices_CreateDevice_PDFeaturesNotCalled, |
| 275 | "vkCreateDevice() called before getting physical device features from vkGetPhysicalDeviceFeatures()."); |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 276 | } |
| 277 | |
LawG4 | 3f848c7 | 2022-02-23 09:35:21 +0000 | [diff] [blame] | 278 | if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorAMD) || VendorCheckEnabled(kBPVendorIMG)) && |
| 279 | (pCreateInfo->pEnabledFeatures != nullptr) && (pCreateInfo->pEnabledFeatures->robustBufferAccess == VK_TRUE)) { |
Szilard Papp | 7d2c795 | 2020-06-22 14:38:13 +0100 | [diff] [blame] | 280 | skip |= LogPerformanceWarning( |
| 281 | device, kVUID_BestPractices_CreateDevice_RobustBufferAccess, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 282 | "%s %s %s: vkCreateDevice() called with enabled robustBufferAccess. Use robustBufferAccess as a debugging tool during " |
Szilard Papp | 7d2c795 | 2020-06-22 14:38:13 +0100 | [diff] [blame] | 283 | "development. Enabling it causes loss in performance for accesses to uniform buffers and shader storage " |
| 284 | "buffers. Disable robustBufferAccess in release builds. Only leave it enabled if the application use-case " |
| 285 | "requires the additional level of reliability due to the use of unverified user-supplied draw parameters.", |
LawG4 | 3f848c7 | 2022-02-23 09:35:21 +0000 | [diff] [blame] | 286 | VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorAMD), VendorSpecificTag(kBPVendorIMG)); |
Szilard Papp | 7d2c795 | 2020-06-22 14:38:13 +0100 | [diff] [blame] | 287 | } |
| 288 | |
Rodrigo Locatti | 8dde2ff | 2022-03-01 18:06:08 -0300 | [diff] [blame] | 289 | const bool enabled_pageable_device_local_memory = IsExtEnabled(device_extensions.vk_ext_pageable_device_local_memory); |
| 290 | if (VendorCheckEnabled(kBPVendorNVIDIA) && !enabled_pageable_device_local_memory && |
| 291 | std::find(extensions.begin(), extensions.end(), VK_EXT_PAGEABLE_DEVICE_LOCAL_MEMORY_EXTENSION_NAME) != extensions.end()) { |
| 292 | skip |= LogPerformanceWarning( |
| 293 | device, kVUID_BestPractices_CreateDevice_PageableDeviceLocalMemory, |
| 294 | "%s vkCreateDevice() called without pageable device local memory. " |
| 295 | "Use pageableDeviceLocalMemory from VK_EXT_pageable_device_local_memory when it is available.", |
| 296 | VendorSpecificTag(kBPVendorNVIDIA)); |
| 297 | } |
| 298 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 299 | return skip; |
| 300 | } |
| 301 | |
| 302 | bool BestPractices::PreCallValidateCreateBuffer(VkDevice device, const VkBufferCreateInfo* pCreateInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 303 | const VkAllocationCallbacks* pAllocator, VkBuffer* pBuffer) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 304 | bool skip = false; |
| 305 | |
| 306 | if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) { |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 307 | std::stringstream buffer_hex; |
| 308 | buffer_hex << "0x" << std::hex << HandleToUint64(pBuffer); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 309 | |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 310 | skip |= LogWarning( |
| 311 | device, kVUID_BestPractices_SharingModeExclusive, |
| 312 | "Warning: Buffer (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues " |
| 313 | "(queueFamilyIndexCount of %" PRIu32 ").", |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 314 | buffer_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 315 | } |
| 316 | |
| 317 | return skip; |
| 318 | } |
| 319 | |
| 320 | bool BestPractices::PreCallValidateCreateImage(VkDevice device, const VkImageCreateInfo* pCreateInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 321 | const VkAllocationCallbacks* pAllocator, VkImage* pImage) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 322 | bool skip = false; |
| 323 | |
| 324 | if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->sharingMode == VK_SHARING_MODE_EXCLUSIVE)) { |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 325 | std::stringstream image_hex; |
| 326 | image_hex << "0x" << std::hex << HandleToUint64(pImage); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 327 | |
| 328 | skip |= |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 329 | LogWarning(device, kVUID_BestPractices_SharingModeExclusive, |
| 330 | "Warning: Image (%s) specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple queues " |
| 331 | "(queueFamilyIndexCount of %" PRIu32 ").", |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 332 | image_hex.str().c_str(), pCreateInfo->queueFamilyIndexCount); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 333 | } |
| 334 | |
ziga-lunarg | 6df3d10 | 2022-03-18 17:02:14 +0100 | [diff] [blame] | 335 | if ((pCreateInfo->flags & VK_IMAGE_CREATE_EXTENDED_USAGE_BIT) && !(pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) { |
| 336 | skip |= LogWarning(device, kVUID_BestPractices_ImageCreateFlags, |
| 337 | "vkCreateImage(): pCreateInfo->flags has VK_IMAGE_CREATE_EXTENDED_USAGE_BIT set, but not " |
| 338 | "VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT, therefore image views created from this image will have to use the " |
| 339 | "same format and VK_IMAGE_CREATE_EXTENDED_USAGE_BIT will not have any effect."); |
| 340 | } |
| 341 | |
LawG4 | 655f59c | 2022-02-23 13:55:55 +0000 | [diff] [blame] | 342 | if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) { |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 343 | if (pCreateInfo->samples > VK_SAMPLE_COUNT_1_BIT && !(pCreateInfo->usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT)) { |
| 344 | skip |= LogPerformanceWarning( |
| 345 | device, kVUID_BestPractices_CreateImage_NonTransientMSImage, |
LawG4 | 655f59c | 2022-02-23 13:55:55 +0000 | [diff] [blame] | 346 | "%s %s vkCreateImage(): Trying to create a multisampled image, but createInfo.usage did not have " |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 347 | "VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. Multisampled images may be resolved on-chip, " |
| 348 | "and do not need to be backed by physical storage. " |
| 349 | "TRANSIENT_ATTACHMENT allows tiled GPUs to not back the multisampled image with physical memory.", |
LawG4 | 655f59c | 2022-02-23 13:55:55 +0000 | [diff] [blame] | 350 | VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG)); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 351 | } |
| 352 | } |
| 353 | |
LawG4 | ba11389 | 2022-02-23 14:39:02 +0000 | [diff] [blame] | 354 | if (VendorCheckEnabled(kBPVendorArm) && pCreateInfo->samples > kMaxEfficientSamplesArm) { |
| 355 | skip |= LogPerformanceWarning( |
| 356 | device, kVUID_BestPractices_CreateImage_TooLargeSampleCount, |
| 357 | "%s vkCreateImage(): Trying to create an image with %u samples. " |
| 358 | "The hardware revision may not have full throughput for framebuffers with more than %u samples.", |
| 359 | VendorSpecificTag(kBPVendorArm), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesArm); |
| 360 | } |
| 361 | |
| 362 | if (VendorCheckEnabled(kBPVendorIMG) && pCreateInfo->samples > kMaxEfficientSamplesImg) { |
| 363 | skip |= LogPerformanceWarning( |
| 364 | device, kVUID_BestPractices_CreateImage_TooLargeSampleCount, |
| 365 | "%s vkCreateImage(): Trying to create an image with %u samples. " |
| 366 | "The device may not have full support for true multisampling for images with more than %u samples. " |
| 367 | "XT devices support up to 8 samples, XE up to 4 samples.", |
| 368 | VendorSpecificTag(kBPVendorIMG), static_cast<uint32_t>(pCreateInfo->samples), kMaxEfficientSamplesImg); |
| 369 | } |
| 370 | |
LawG4 | db16f80 | 2022-03-21 17:33:39 +0000 | [diff] [blame] | 371 | if (VendorCheckEnabled(kBPVendorIMG) && (pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_SRGB_BLOCK_IMG || |
| 372 | pCreateInfo->format == VK_FORMAT_PVRTC1_2BPP_UNORM_BLOCK_IMG || |
| 373 | pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_SRGB_BLOCK_IMG || |
| 374 | pCreateInfo->format == VK_FORMAT_PVRTC1_4BPP_UNORM_BLOCK_IMG || |
| 375 | pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_SRGB_BLOCK_IMG || |
| 376 | pCreateInfo->format == VK_FORMAT_PVRTC2_2BPP_UNORM_BLOCK_IMG || |
| 377 | pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_SRGB_BLOCK_IMG || |
| 378 | pCreateInfo->format == VK_FORMAT_PVRTC2_4BPP_UNORM_BLOCK_IMG)) { |
| 379 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_Texture_Format_PVRTC_Outdated, |
| 380 | "%s vkCreateImage(): Trying to create an image with a PVRTC format. Both PVRTC1 and PVRTC2 " |
| 381 | "are slower than standard image formats on PowerVR GPUs, prefer ETC, BC, ASTC, etc.", |
| 382 | VendorSpecificTag(kBPVendorIMG)); |
| 383 | } |
| 384 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 385 | if (VendorCheckEnabled(kBPVendorAMD)) { |
| 386 | std::stringstream image_hex; |
| 387 | image_hex << "0x" << std::hex << HandleToUint64(pImage); |
| 388 | |
| 389 | if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) && |
| 390 | (pCreateInfo->sharingMode == VK_SHARING_MODE_CONCURRENT)) { |
| 391 | skip |= LogPerformanceWarning(device, |
| 392 | kVUID_BestPractices_vkImage_AvoidConcurrentRenderTargets, |
| 393 | "%s Performance warning: image (%s) is created as a render target with VK_SHARING_MODE_CONCURRENT. " |
| 394 | "Using a SHARING_MODE_CONCURRENT " |
| 395 | "is not recommended with color and depth targets", |
| 396 | VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str()); |
| 397 | } |
| 398 | |
| 399 | if ((pCreateInfo->usage & |
| 400 | (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_STORAGE_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) && |
| 401 | (pCreateInfo->flags & VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT)) { |
| 402 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseMutableRenderTargets, |
| 403 | "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT. " |
| 404 | "Using a MUTABLE_FORMAT is not recommended with color, depth, and storage targets", |
| 405 | VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str()); |
| 406 | } |
| 407 | |
| 408 | if ((pCreateInfo->usage & (VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT | VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) && |
| 409 | (pCreateInfo->usage & VK_IMAGE_USAGE_STORAGE_BIT)) { |
| 410 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_DontUseStorageRenderTargets, |
| 411 | "%s Performance warning: image (%s) is created as a render target with VK_IMAGE_USAGE_STORAGE_BIT. Using a " |
| 412 | "VK_IMAGE_USAGE_STORAGE_BIT is not recommended with color and depth targets", |
| 413 | VendorSpecificTag(kBPVendorAMD), image_hex.str().c_str()); |
| 414 | } |
| 415 | } |
| 416 | |
Rodrigo Locatti | 5466f9d | 2022-03-09 18:20:38 -0300 | [diff] [blame] | 417 | if (VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 418 | std::stringstream image_hex; |
| 419 | image_hex << "0x" << std::hex << HandleToUint64(pImage); |
| 420 | |
| 421 | if (pCreateInfo->tiling == VK_IMAGE_TILING_LINEAR) { |
| 422 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateImage_TilingLinear, |
| 423 | "%s Performance warning: image (%s) is created with tiling VK_IMAGE_TILING_LINEAR. " |
| 424 | "Use VK_IMAGE_TILING_OPTIMAL instead.", |
| 425 | VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str()); |
| 426 | } |
Rodrigo Locatti | 3290c2b | 2022-03-09 18:25:56 -0300 | [diff] [blame] | 427 | |
| 428 | if (pCreateInfo->format == VK_FORMAT_D32_SFLOAT || pCreateInfo->format == VK_FORMAT_D32_SFLOAT_S8_UINT) { |
| 429 | skip |= LogPerformanceWarning( |
| 430 | device, kVUID_BestPractices_CreateImage_Depth32Format, |
| 431 | "%s Performance warning: image (%s) is created with a 32-bit depth format. Use VK_FORMAT_D24_UNORM_S8_UINT or " |
| 432 | "VK_FORMAT_D16_UNORM instead, unless the extra precision is needed.", |
| 433 | VendorSpecificTag(kBPVendorNVIDIA), image_hex.str().c_str()); |
| 434 | } |
Rodrigo Locatti | 5466f9d | 2022-03-09 18:20:38 -0300 | [diff] [blame] | 435 | } |
| 436 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 437 | return skip; |
| 438 | } |
| 439 | |
| 440 | bool BestPractices::PreCallValidateCreateSwapchainKHR(VkDevice device, const VkSwapchainCreateInfoKHR* pCreateInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 441 | const VkAllocationCallbacks* pAllocator, VkSwapchainKHR* pSwapchain) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 442 | bool skip = false; |
| 443 | |
Jeremy Gebben | 383b9a3 | 2021-09-08 16:31:33 -0600 | [diff] [blame] | 444 | const auto* bp_pd_state = GetPhysicalDeviceState(); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 445 | if (bp_pd_state) { |
| 446 | if (bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState == UNCALLED) { |
| 447 | skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled, |
| 448 | "vkCreateSwapchainKHR() called before getting surface capabilities from " |
| 449 | "vkGetPhysicalDeviceSurfaceCapabilitiesKHR()."); |
| 450 | } |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 451 | |
Shannon McPherson | 73e58c8 | 2021-03-05 17:14:26 -0700 | [diff] [blame] | 452 | if ((pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR) && |
| 453 | (bp_pd_state->vkGetPhysicalDeviceSurfacePresentModesKHRState != QUERY_DETAILS)) { |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 454 | skip |= LogWarning(device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled, |
| 455 | "vkCreateSwapchainKHR() called before getting surface present mode(s) from " |
| 456 | "vkGetPhysicalDeviceSurfacePresentModesKHR()."); |
| 457 | } |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 458 | |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 459 | if (bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState != QUERY_DETAILS) { |
| 460 | skip |= LogWarning( |
| 461 | device, kVUID_BestPractices_Swapchain_GetSurfaceNotCalled, |
| 462 | "vkCreateSwapchainKHR() called before getting surface format(s) from vkGetPhysicalDeviceSurfaceFormatsKHR()."); |
| 463 | } |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 464 | } |
| 465 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 466 | if ((pCreateInfo->queueFamilyIndexCount > 1) && (pCreateInfo->imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 467 | skip |= |
| 468 | LogWarning(device, kVUID_BestPractices_SharingModeExclusive, |
Mark Lobodzinski | 019f4e3 | 2020-04-13 11:01:35 -0600 | [diff] [blame] | 469 | "Warning: A Swapchain is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while " |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 470 | "specifying multiple queues (queueFamilyIndexCount of %" PRIu32 ").", |
| 471 | pCreateInfo->queueFamilyIndexCount); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 472 | } |
| 473 | |
ziga-lunarg | 79beba6 | 2022-03-30 01:17:30 +0200 | [diff] [blame] | 474 | const auto present_mode = pCreateInfo->presentMode; |
| 475 | if (((present_mode == VK_PRESENT_MODE_MAILBOX_KHR) || (present_mode == VK_PRESENT_MODE_FIFO_KHR)) && |
| 476 | (pCreateInfo->minImageCount == 2)) { |
Szilard Papp | 48a6da3 | 2020-06-10 14:41:59 +0100 | [diff] [blame] | 477 | skip |= LogPerformanceWarning( |
| 478 | device, kVUID_BestPractices_SuboptimalSwapchainImageCount, |
| 479 | "Warning: A Swapchain is being created with minImageCount set to %" PRIu32 |
| 480 | ", which means double buffering is going " |
| 481 | "to be used. Using double buffering and vsync locks rendering to an integer fraction of the vsync rate. In turn, " |
| 482 | "reducing the performance of the application if rendering is slower than vsync. Consider setting minImageCount to " |
| 483 | "3 to use triple buffering to maximize performance in such cases.", |
| 484 | pCreateInfo->minImageCount); |
| 485 | } |
| 486 | |
Szilard Papp | d5f0f81 | 2020-06-22 09:01:29 +0100 | [diff] [blame] | 487 | if (VendorCheckEnabled(kBPVendorArm) && (pCreateInfo->presentMode != VK_PRESENT_MODE_FIFO_KHR)) { |
| 488 | skip |= LogWarning(device, kVUID_BestPractices_CreateSwapchain_PresentMode, |
| 489 | "%s Warning: Swapchain is not being created with presentation mode \"VK_PRESENT_MODE_FIFO_KHR\". " |
| 490 | "Prefer using \"VK_PRESENT_MODE_FIFO_KHR\" to avoid unnecessary CPU and GPU load and save power. " |
| 491 | "Presentation modes which are not FIFO will present the latest available frame and discard other " |
| 492 | "frame(s) if any.", |
| 493 | VendorSpecificTag(kBPVendorArm)); |
| 494 | } |
| 495 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 496 | return skip; |
| 497 | } |
| 498 | |
| 499 | bool BestPractices::PreCallValidateCreateSharedSwapchainsKHR(VkDevice device, uint32_t swapchainCount, |
| 500 | const VkSwapchainCreateInfoKHR* pCreateInfos, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 501 | const VkAllocationCallbacks* pAllocator, |
| 502 | VkSwapchainKHR* pSwapchains) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 503 | bool skip = false; |
| 504 | |
| 505 | for (uint32_t i = 0; i < swapchainCount; i++) { |
| 506 | if ((pCreateInfos[i].queueFamilyIndexCount > 1) && (pCreateInfos[i].imageSharingMode == VK_SHARING_MODE_EXCLUSIVE)) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 507 | skip |= LogWarning( |
| 508 | device, kVUID_BestPractices_SharingModeExclusive, |
| 509 | "Warning: A shared swapchain (index %" PRIu32 |
| 510 | ") is being created which specifies a sharing mode of VK_SHARING_MODE_EXCLUSIVE while specifying multiple " |
| 511 | "queues (queueFamilyIndexCount of %" PRIu32 ").", |
| 512 | i, pCreateInfos[i].queueFamilyIndexCount); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 513 | } |
| 514 | } |
| 515 | |
| 516 | return skip; |
| 517 | } |
| 518 | |
| 519 | bool BestPractices::PreCallValidateCreateRenderPass(VkDevice device, const VkRenderPassCreateInfo* pCreateInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 520 | const VkAllocationCallbacks* pAllocator, VkRenderPass* pRenderPass) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 521 | bool skip = false; |
| 522 | |
| 523 | for (uint32_t i = 0; i < pCreateInfo->attachmentCount; ++i) { |
| 524 | VkFormat format = pCreateInfo->pAttachments[i].format; |
| 525 | if (pCreateInfo->pAttachments[i].initialLayout == VK_IMAGE_LAYOUT_UNDEFINED) { |
| 526 | if ((FormatIsColor(format) || FormatHasDepth(format)) && |
| 527 | pCreateInfo->pAttachments[i].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 528 | skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment, |
| 529 | "Render pass has an attachment with loadOp == VK_ATTACHMENT_LOAD_OP_LOAD and " |
| 530 | "initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you " |
| 531 | "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the " |
| 532 | "image truely is undefined at the start of the render pass."); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 533 | } |
| 534 | if (FormatHasStencil(format) && pCreateInfo->pAttachments[i].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 535 | skip |= LogWarning(device, kVUID_BestPractices_RenderPass_Attatchment, |
| 536 | "Render pass has an attachment with stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD " |
| 537 | "and initialLayout == VK_IMAGE_LAYOUT_UNDEFINED. This is probably not what you " |
| 538 | "intended. Consider using VK_ATTACHMENT_LOAD_OP_DONT_CARE instead if the " |
| 539 | "image truely is undefined at the start of the render pass."); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 540 | } |
| 541 | } |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 542 | |
| 543 | const auto& attachment = pCreateInfo->pAttachments[i]; |
| 544 | if (attachment.samples > VK_SAMPLE_COUNT_1_BIT) { |
| 545 | bool access_requires_memory = |
| 546 | attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE; |
| 547 | |
| 548 | if (FormatHasStencil(format)) { |
| 549 | access_requires_memory |= attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD || |
| 550 | attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE; |
| 551 | } |
| 552 | |
| 553 | if (access_requires_memory) { |
| 554 | skip |= LogPerformanceWarning( |
| 555 | device, kVUID_BestPractices_CreateRenderPass_ImageRequiresMemory, |
| 556 | "Attachment %u in the VkRenderPass is a multisampled image with %u samples, but it uses loadOp/storeOp " |
| 557 | "which requires accessing data from memory. Multisampled images should always be loadOp = CLEAR or DONT_CARE, " |
| 558 | "storeOp = DONT_CARE. This allows the implementation to use lazily allocated memory effectively.", |
| 559 | i, static_cast<uint32_t>(attachment.samples)); |
| 560 | } |
| 561 | } |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 562 | } |
| 563 | |
| 564 | for (uint32_t dependency = 0; dependency < pCreateInfo->dependencyCount; dependency++) { |
| 565 | skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].srcStageMask); |
| 566 | skip |= CheckPipelineStageFlags("vkCreateRenderPass", pCreateInfo->pDependencies[dependency].dstStageMask); |
| 567 | } |
| 568 | |
| 569 | return skip; |
| 570 | } |
| 571 | |
Tony-LunarG | 767180f | 2020-04-23 14:03:59 -0600 | [diff] [blame] | 572 | bool BestPractices::ValidateAttachments(const VkRenderPassCreateInfo2* rpci, uint32_t attachmentCount, |
| 573 | const VkImageView* image_views) const { |
| 574 | bool skip = false; |
| 575 | |
| 576 | // Check for non-transient attachments that should be transient and vice versa |
| 577 | for (uint32_t i = 0; i < attachmentCount; ++i) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 578 | const auto& attachment = rpci->pAttachments[i]; |
Tony-LunarG | 767180f | 2020-04-23 14:03:59 -0600 | [diff] [blame] | 579 | bool attachment_should_be_transient = |
| 580 | (attachment.loadOp != VK_ATTACHMENT_LOAD_OP_LOAD && attachment.storeOp != VK_ATTACHMENT_STORE_OP_STORE); |
| 581 | |
| 582 | if (FormatHasStencil(attachment.format)) { |
| 583 | attachment_should_be_transient &= (attachment.stencilLoadOp != VK_ATTACHMENT_LOAD_OP_LOAD && |
| 584 | attachment.stencilStoreOp != VK_ATTACHMENT_STORE_OP_STORE); |
| 585 | } |
| 586 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 587 | auto view_state = Get<IMAGE_VIEW_STATE>(image_views[i]); |
Tony-LunarG | 767180f | 2020-04-23 14:03:59 -0600 | [diff] [blame] | 588 | if (view_state) { |
Jeremy Gebben | 057f9d5 | 2021-11-05 14:12:31 -0600 | [diff] [blame] | 589 | const auto& ici = view_state->image_state->createInfo; |
Tony-LunarG | 767180f | 2020-04-23 14:03:59 -0600 | [diff] [blame] | 590 | |
| 591 | bool image_is_transient = (ici.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) != 0; |
| 592 | |
| 593 | // The check for an image that should not be transient applies to all GPUs |
| 594 | if (!attachment_should_be_transient && image_is_transient) { |
| 595 | skip |= LogPerformanceWarning( |
| 596 | device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldNotBeTransient, |
| 597 | "Attachment %u in VkFramebuffer uses loadOp/storeOps which need to access physical memory, " |
| 598 | "but the image backing the image view has VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. " |
| 599 | "Physical memory will need to be backed lazily to this image, potentially causing stalls.", |
| 600 | i); |
| 601 | } |
| 602 | |
| 603 | bool supports_lazy = false; |
| 604 | for (uint32_t j = 0; j < phys_dev_mem_props.memoryTypeCount; j++) { |
| 605 | if (phys_dev_mem_props.memoryTypes[j].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) { |
| 606 | supports_lazy = true; |
| 607 | } |
| 608 | } |
| 609 | |
| 610 | // The check for an image that should be transient only applies to GPUs supporting |
| 611 | // lazily allocated memory |
| 612 | if (supports_lazy && attachment_should_be_transient && !image_is_transient) { |
| 613 | skip |= LogPerformanceWarning( |
| 614 | device, kVUID_BestPractices_CreateFramebuffer_AttachmentShouldBeTransient, |
| 615 | "Attachment %u in VkFramebuffer uses loadOp/storeOps which never have to be backed by physical memory, " |
| 616 | "but the image backing the image view does not have VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT set. " |
| 617 | "You can save physical memory by using transient attachment backed by lazily allocated memory here.", |
| 618 | i); |
| 619 | } |
| 620 | } |
| 621 | } |
| 622 | return skip; |
| 623 | } |
| 624 | |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 625 | bool BestPractices::PreCallValidateCreateFramebuffer(VkDevice device, const VkFramebufferCreateInfo* pCreateInfo, |
| 626 | const VkAllocationCallbacks* pAllocator, VkFramebuffer* pFramebuffer) const { |
| 627 | bool skip = false; |
| 628 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 629 | auto rp_state = Get<RENDER_PASS_STATE>(pCreateInfo->renderPass); |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 630 | if (rp_state && !(pCreateInfo->flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT)) { |
Tony-LunarG | 767180f | 2020-04-23 14:03:59 -0600 | [diff] [blame] | 631 | skip = ValidateAttachments(rp_state->createInfo.ptr(), pCreateInfo->attachmentCount, pCreateInfo->pAttachments); |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 632 | } |
| 633 | |
| 634 | return skip; |
| 635 | } |
| 636 | |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 637 | bool BestPractices::PreCallValidateAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo, |
| 638 | VkDescriptorSet* pDescriptorSets, void* ads_state_data) const { |
| 639 | bool skip = false; |
| 640 | skip |= ValidationStateTracker::PreCallValidateAllocateDescriptorSets(device, pAllocateInfo, pDescriptorSets, ads_state_data); |
| 641 | |
| 642 | if (!skip) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 643 | const auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool); |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 644 | // if the number of freed sets > 0, it implies they could be recycled instead if desirable |
| 645 | // this warning is specific to Arm |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 646 | if (VendorCheckEnabled(kBPVendorArm) && pool_state && (pool_state->freed_count > 0)) { |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 647 | skip |= LogPerformanceWarning( |
| 648 | device, kVUID_BestPractices_AllocateDescriptorSets_SuboptimalReuse, |
| 649 | "%s Descriptor set memory was allocated via vkAllocateDescriptorSets() for sets which were previously freed in the " |
| 650 | "same logical device. On some drivers or architectures it may be most optimal to re-use existing descriptor sets.", |
| 651 | VendorSpecificTag(kBPVendorArm)); |
| 652 | } |
ziga-lunarg | 5a76c44 | 2022-04-17 18:04:08 +0200 | [diff] [blame] | 653 | |
| 654 | if (IsExtEnabled(device_extensions.vk_khr_maintenance1)) { |
| 655 | // Track number of descriptorSets allowable in this pool |
| 656 | if (pool_state->GetAvailableSets() < pAllocateInfo->descriptorSetCount) { |
| 657 | skip |= LogWarning(pool_state->Handle(), kVUID_BestPractices_EmptyDescriptorPool, |
| 658 | "vkAllocateDescriptorSets(): Unable to allocate %" PRIu32 " descriptorSets from %s" |
| 659 | ". This pool only has %" PRIu32 " descriptorSets remaining.", |
| 660 | pAllocateInfo->descriptorSetCount, report_data->FormatHandle(pool_state->Handle()).c_str(), |
| 661 | pool_state->GetAvailableSets()); |
| 662 | } |
| 663 | } |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 664 | } |
| 665 | |
| 666 | return skip; |
| 667 | } |
| 668 | |
Mark Lobodzinski | 84101d7 | 2020-04-24 09:43:48 -0600 | [diff] [blame] | 669 | void BestPractices::ManualPostCallRecordAllocateDescriptorSets(VkDevice device, const VkDescriptorSetAllocateInfo* pAllocateInfo, |
| 670 | VkDescriptorSet* pDescriptorSets, VkResult result, void* ads_state) { |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 671 | if (result == VK_SUCCESS) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 672 | auto pool_state = Get<bp_state::DescriptorPool>(pAllocateInfo->descriptorPool); |
| 673 | if (pool_state) { |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 674 | // we record successful allocations by subtracting the allocation count from the last recorded free count |
| 675 | const auto alloc_count = pAllocateInfo->descriptorSetCount; |
| 676 | // clamp the unsigned subtraction to the range [0, last_free_count] |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 677 | if (pool_state->freed_count > alloc_count) { |
| 678 | pool_state->freed_count -= alloc_count; |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 679 | } else { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 680 | pool_state->freed_count = 0; |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 681 | } |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 682 | } |
| 683 | } |
| 684 | } |
| 685 | |
| 686 | void BestPractices::PostCallRecordFreeDescriptorSets(VkDevice device, VkDescriptorPool descriptorPool, uint32_t descriptorSetCount, |
| 687 | const VkDescriptorSet* pDescriptorSets, VkResult result) { |
| 688 | ValidationStateTracker::PostCallRecordFreeDescriptorSets(device, descriptorPool, descriptorSetCount, pDescriptorSets, result); |
| 689 | if (result == VK_SUCCESS) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 690 | auto pool_state = Get<bp_state::DescriptorPool>(descriptorPool); |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 691 | // we want to track frees because we're interested in suggesting re-use |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 692 | if (pool_state) { |
| 693 | pool_state->freed_count += descriptorSetCount; |
Sam Walls | e746d52 | 2020-03-16 21:20:23 +0000 | [diff] [blame] | 694 | } |
| 695 | } |
| 696 | } |
| 697 | |
Rodrigo Locatti | d5b54f5 | 2022-03-16 19:12:45 -0300 | [diff] [blame^] | 698 | void BestPractices::PreCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo, |
| 699 | const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) { |
| 700 | if (VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 701 | WriteLockGuard guard{memory_free_events_lock_}; |
| 702 | |
| 703 | // Release old allocations to avoid overpopulating the container |
| 704 | const auto now = std::chrono::high_resolution_clock::now(); |
| 705 | const auto last_old = std::find_if(memory_free_events_.rbegin(), memory_free_events_.rend(), [now](const MemoryFreeEvent& event) { |
| 706 | return now - event.time > kAllocateMemoryReuseTimeThresholdNVIDIA; |
| 707 | }); |
| 708 | memory_free_events_.erase(memory_free_events_.begin(), last_old.base()); |
| 709 | } |
| 710 | } |
| 711 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 712 | bool BestPractices::PreCallValidateAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 713 | const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 714 | bool skip = false; |
| 715 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 716 | if ((Count<DEVICE_MEMORY_STATE>() + 1) > kMemoryObjectWarningLimit) { |
Mark Lobodzinski | f95a266 | 2020-01-29 15:43:32 -0700 | [diff] [blame] | 717 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_TooManyObjects, |
| 718 | "Performance Warning: This app has > %" PRIu32 " memory objects.", kMemoryObjectWarningLimit); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 719 | } |
| 720 | |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 721 | if (pAllocateInfo->allocationSize < kMinDeviceAllocationSize) { |
| 722 | skip |= LogPerformanceWarning( |
| 723 | device, kVUID_BestPractices_AllocateMemory_SmallAllocation, |
Jeremy Gebben | da6b48f | 2021-05-13 10:46:18 -0600 | [diff] [blame] | 724 | "vkAllocateMemory(): Allocating a VkDeviceMemory of size %" PRIu64 ". This is a very small allocation (current " |
| 725 | "threshold is %" PRIu64 " bytes). " |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 726 | "You should make large allocations and sub-allocate from one large VkDeviceMemory.", |
| 727 | pAllocateInfo->allocationSize, kMinDeviceAllocationSize); |
| 728 | } |
| 729 | |
Rodrigo Locatti | d5b54f5 | 2022-03-16 19:12:45 -0300 | [diff] [blame^] | 730 | if (VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 731 | if (!device_extensions.vk_ext_pageable_device_local_memory && |
| 732 | !LvlFindInChain<VkMemoryPriorityAllocateInfoEXT>(pAllocateInfo->pNext)) { |
| 733 | skip |= LogPerformanceWarning( |
| 734 | device, kVUID_BestPractices_AllocateMemory_SetPriority, |
| 735 | "%s Use VkMemoryPriorityAllocateInfoEXT to provide the operating system information on the allocations that " |
| 736 | "should stay in video memory and which should be demoted first when video memory is limited. " |
| 737 | "The highest priority should be given to GPU-written resources like color attachments, depth attachments, " |
| 738 | "storage images, and buffers written from the GPU.", |
| 739 | VendorSpecificTag(kBPVendorNVIDIA)); |
| 740 | } |
| 741 | |
| 742 | { |
| 743 | // Size in bytes for an allocation to be considered "compatible" |
| 744 | static constexpr VkDeviceSize size_threshold = VkDeviceSize{1} << 20; |
| 745 | |
| 746 | ReadLockGuard guard{memory_free_events_lock_}; |
| 747 | |
| 748 | const auto now = std::chrono::high_resolution_clock::now(); |
| 749 | const VkDeviceSize alloc_size = pAllocateInfo->allocationSize; |
| 750 | const uint32_t memory_type_index = pAllocateInfo->memoryTypeIndex; |
| 751 | const auto latest_event = std::find_if(memory_free_events_.rbegin(), memory_free_events_.rend(), [&](const MemoryFreeEvent& event) { |
| 752 | return (memory_type_index == event.memory_type_index) && (alloc_size <= event.allocation_size) && |
| 753 | (alloc_size - event.allocation_size <= size_threshold) && (now - event.time < kAllocateMemoryReuseTimeThresholdNVIDIA); |
| 754 | }); |
| 755 | |
| 756 | if (latest_event != memory_free_events_.rend()) { |
| 757 | const auto time_delta = std::chrono::duration_cast<std::chrono::milliseconds>(now - latest_event->time); |
| 758 | if (time_delta < std::chrono::milliseconds{5}) { |
| 759 | skip |= |
| 760 | LogPerformanceWarning(device, kVUID_BestPractices_AllocateMemory_ReuseAllocations, |
| 761 | "%s Reuse memory allocations instead of releasing and reallocating. A memory allocation " |
| 762 | "has just been released, and it could have been reused in place of this allocation.", |
| 763 | VendorSpecificTag(kBPVendorNVIDIA)); |
| 764 | } else { |
| 765 | const uint32_t seconds = static_cast<uint32_t>(time_delta.count() / 1000); |
| 766 | const uint32_t milliseconds = static_cast<uint32_t>(time_delta.count() % 1000); |
| 767 | |
| 768 | skip |= LogPerformanceWarning( |
| 769 | device, kVUID_BestPractices_AllocateMemory_ReuseAllocations, |
| 770 | "%s Reuse memory allocations instead of releasing and reallocating. A memory allocation has been released " |
| 771 | "%" PRIu32 ".%03" PRIu32 " seconds ago, and it could have been reused in place of this allocation.", |
| 772 | VendorSpecificTag(kBPVendorNVIDIA), seconds, milliseconds); |
| 773 | } |
| 774 | } |
| 775 | } |
Rodrigo Locatti | e4f8d52 | 2022-03-15 16:30:49 -0300 | [diff] [blame] | 776 | } |
| 777 | |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 778 | // TODO: Insert get check for GetPhysicalDeviceMemoryProperties once the state is tracked in the StateTracker |
| 779 | |
| 780 | return skip; |
| 781 | } |
| 782 | |
Mark Lobodzinski | 84101d7 | 2020-04-24 09:43:48 -0600 | [diff] [blame] | 783 | void BestPractices::ManualPostCallRecordAllocateMemory(VkDevice device, const VkMemoryAllocateInfo* pAllocateInfo, |
| 784 | const VkAllocationCallbacks* pAllocator, VkDeviceMemory* pMemory, |
| 785 | VkResult result) { |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 786 | if (result != VK_SUCCESS) { |
| 787 | static std::vector<VkResult> error_codes = {VK_ERROR_OUT_OF_HOST_MEMORY, VK_ERROR_OUT_OF_DEVICE_MEMORY, |
| 788 | VK_ERROR_TOO_MANY_OBJECTS, VK_ERROR_INVALID_EXTERNAL_HANDLE, |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 789 | VK_ERROR_INVALID_OPAQUE_CAPTURE_ADDRESS}; |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 790 | static std::vector<VkResult> success_codes = {}; |
Nathaniel Cesario | db3f43f | 2021-05-12 09:08:23 -0600 | [diff] [blame] | 791 | ValidateReturnCodes("vkAllocateMemory", result, error_codes, success_codes); |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 792 | return; |
| 793 | } |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 794 | } |
Camden Stocker | 9738af9 | 2019-10-16 13:54:03 -0700 | [diff] [blame] | 795 | |
Mark Lobodzinski | de15e58 | 2020-04-29 08:06:00 -0600 | [diff] [blame] | 796 | void BestPractices::ValidateReturnCodes(const char* api_name, VkResult result, const std::vector<VkResult>& error_codes, |
| 797 | const std::vector<VkResult>& success_codes) const { |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 798 | auto error = std::find(error_codes.begin(), error_codes.end(), result); |
| 799 | if (error != error_codes.end()) { |
Gareth Webb | 586c46b | 2021-01-13 11:17:22 +0000 | [diff] [blame] | 800 | static const std::vector<VkResult> common_failure_codes = {VK_ERROR_OUT_OF_DATE_KHR, |
| 801 | VK_ERROR_FULL_SCREEN_EXCLUSIVE_MODE_LOST_EXT}; |
| 802 | |
| 803 | auto common_failure = std::find(common_failure_codes.begin(), common_failure_codes.end(), result); |
| 804 | if (common_failure != common_failure_codes.end()) { |
| 805 | LogInfo(instance, kVUID_BestPractices_Failure_Result, "%s(): Returned error %s.", api_name, string_VkResult(result)); |
| 806 | } else { |
| 807 | LogWarning(instance, kVUID_BestPractices_Error_Result, "%s(): Returned error %s.", api_name, string_VkResult(result)); |
| 808 | } |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 809 | return; |
| 810 | } |
| 811 | auto success = std::find(success_codes.begin(), success_codes.end(), result); |
| 812 | if (success != success_codes.end()) { |
Mark Lobodzinski | e721515 | 2020-05-11 08:21:23 -0600 | [diff] [blame] | 813 | LogInfo(instance, kVUID_BestPractices_NonSuccess_Result, "%s(): Returned non-success return code %s.", api_name, |
| 814 | string_VkResult(result)); |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 815 | } |
| 816 | } |
| 817 | |
Rodrigo Locatti | d5b54f5 | 2022-03-16 19:12:45 -0300 | [diff] [blame^] | 818 | void BestPractices::PreCallRecordFreeMemory(VkDevice device, VkDeviceMemory memory, const VkAllocationCallbacks* pAllocator) { |
| 819 | if (memory != VK_NULL_HANDLE && VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 820 | auto mem_info = Get<DEVICE_MEMORY_STATE>(memory); |
| 821 | |
| 822 | // Exclude memory free events on dedicated allocations, or imported/exported allocations. |
| 823 | if (!mem_info->IsDedicatedBuffer() && !mem_info->IsDedicatedImage() && !mem_info->IsExport() && !mem_info->IsImport()) { |
| 824 | MemoryFreeEvent event; |
| 825 | event.time = std::chrono::high_resolution_clock::now(); |
| 826 | event.memory_type_index = mem_info->alloc_info.memoryTypeIndex; |
| 827 | event.allocation_size = mem_info->alloc_info.allocationSize; |
| 828 | |
| 829 | WriteLockGuard guard{memory_free_events_lock_}; |
| 830 | memory_free_events_.push_back(event); |
| 831 | } |
| 832 | } |
| 833 | |
| 834 | ValidationStateTracker::PreCallRecordFreeMemory(device, memory, pAllocator); |
| 835 | } |
| 836 | |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 837 | bool BestPractices::PreCallValidateFreeMemory(VkDevice device, VkDeviceMemory memory, |
| 838 | const VkAllocationCallbacks* pAllocator) const { |
Mark Lobodzinski | 91e50bf | 2020-01-14 09:55:11 -0700 | [diff] [blame] | 839 | if (memory == VK_NULL_HANDLE) return false; |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 840 | bool skip = false; |
| 841 | |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 842 | auto mem_info = Get<DEVICE_MEMORY_STATE>(memory); |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 843 | |
Jeremy Gebben | 610d3a6 | 2022-01-01 12:53:17 -0700 | [diff] [blame] | 844 | for (const auto& item : mem_info->ObjectBindings()) { |
| 845 | const auto& obj = item.first; |
Mark Lobodzinski | 818425a | 2020-03-16 18:19:03 -0600 | [diff] [blame] | 846 | LogObjectList objlist(device); |
| 847 | objlist.add(obj); |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 848 | objlist.add(mem_info->mem()); |
Mark Lobodzinski | 818425a | 2020-03-16 18:19:03 -0600 | [diff] [blame] | 849 | skip |= LogWarning(objlist, layer_name.c_str(), "VK Object %s still has a reference to mem obj %s.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 850 | report_data->FormatHandle(obj).c_str(), report_data->FormatHandle(mem_info->mem()).c_str()); |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 851 | } |
| 852 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 853 | return skip; |
| 854 | } |
| 855 | |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 856 | bool BestPractices::ValidateBindBufferMemory(VkBuffer buffer, VkDeviceMemory memory, const char* api_name) const { |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 857 | bool skip = false; |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 858 | auto buffer_state = Get<BUFFER_STATE>(buffer); |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 859 | |
sfricke-samsung | e244119 | 2019-11-06 14:07:57 -0800 | [diff] [blame] | 860 | if (!buffer_state->memory_requirements_checked && !buffer_state->external_memory_handle) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 861 | skip |= LogWarning(device, kVUID_BestPractices_BufferMemReqNotCalled, |
| 862 | "%s: Binding memory to %s but vkGetBufferMemoryRequirements() has not been called on that buffer.", |
| 863 | api_name, report_data->FormatHandle(buffer).c_str()); |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 864 | } |
| 865 | |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 866 | auto mem_state = Get<DEVICE_MEMORY_STATE>(memory); |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 867 | |
AndreyVK_D3D | 0416a33 | 2021-11-02 23:22:28 +0300 | [diff] [blame] | 868 | if (mem_state && mem_state->alloc_info.allocationSize == buffer_state->createInfo.size && |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 869 | mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) { |
| 870 | skip |= LogPerformanceWarning( |
| 871 | device, kVUID_BestPractices_SmallDedicatedAllocation, |
| 872 | "%s: Trying to bind %s to a memory block which is fully consumed by the buffer. " |
Jeremy Gebben | da6b48f | 2021-05-13 10:46:18 -0600 | [diff] [blame] | 873 | "The required size of the allocation is %" PRIu64 ", but smaller buffers like this should be sub-allocated from " |
| 874 | "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)", |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 875 | api_name, report_data->FormatHandle(buffer).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize); |
| 876 | } |
| 877 | |
Rodrigo Locatti | 66b2335 | 2022-03-15 17:28:32 -0300 | [diff] [blame] | 878 | skip |= ValidateBindMemory(device, memory); |
| 879 | |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 880 | return skip; |
| 881 | } |
| 882 | |
| 883 | bool BestPractices::PreCallValidateBindBufferMemory(VkDevice device, VkBuffer buffer, VkDeviceMemory memory, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 884 | VkDeviceSize memoryOffset) const { |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 885 | bool skip = false; |
| 886 | const char* api_name = "BindBufferMemory()"; |
| 887 | |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 888 | skip |= ValidateBindBufferMemory(buffer, memory, api_name); |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 889 | |
| 890 | return skip; |
| 891 | } |
| 892 | |
| 893 | bool BestPractices::PreCallValidateBindBufferMemory2(VkDevice device, uint32_t bindInfoCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 894 | const VkBindBufferMemoryInfo* pBindInfos) const { |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 895 | char api_name[64]; |
| 896 | bool skip = false; |
| 897 | |
| 898 | for (uint32_t i = 0; i < bindInfoCount; i++) { |
Frédéric Wang | afb8986 | 2022-06-21 16:15:29 +0200 | [diff] [blame] | 899 | snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2() pBindInfos[%u]", i); |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 900 | skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name); |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 901 | } |
| 902 | |
| 903 | return skip; |
| 904 | } |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 905 | |
| 906 | bool BestPractices::PreCallValidateBindBufferMemory2KHR(VkDevice device, uint32_t bindInfoCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 907 | const VkBindBufferMemoryInfo* pBindInfos) const { |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 908 | char api_name[64]; |
| 909 | bool skip = false; |
Camden Stocker | b603cc8 | 2019-09-03 10:09:02 -0600 | [diff] [blame] | 910 | |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 911 | for (uint32_t i = 0; i < bindInfoCount; i++) { |
Frédéric Wang | afb8986 | 2022-06-21 16:15:29 +0200 | [diff] [blame] | 912 | snprintf(api_name, sizeof(api_name), "vkBindBufferMemory2KHR() pBindInfos[%u]", i); |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 913 | skip |= ValidateBindBufferMemory(pBindInfos[i].buffer, pBindInfos[i].memory, api_name); |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 914 | } |
| 915 | |
| 916 | return skip; |
| 917 | } |
| 918 | |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 919 | bool BestPractices::ValidateBindImageMemory(VkImage image, VkDeviceMemory memory, const char* api_name) const { |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 920 | bool skip = false; |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 921 | auto image_state = Get<IMAGE_STATE>(image); |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 922 | |
sfricke-samsung | 71bc657 | 2020-04-29 15:49:43 -0700 | [diff] [blame] | 923 | if (image_state->disjoint == false) { |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 924 | if (!image_state->memory_requirements_checked[0] && !image_state->external_memory_handle) { |
sfricke-samsung | d7ea5de | 2020-04-08 09:19:18 -0700 | [diff] [blame] | 925 | skip |= LogWarning(device, kVUID_BestPractices_ImageMemReqNotCalled, |
| 926 | "%s: Binding memory to %s but vkGetImageMemoryRequirements() has not been called on that image.", |
| 927 | api_name, report_data->FormatHandle(image).c_str()); |
| 928 | } |
| 929 | } else { |
| 930 | // TODO If binding disjoint image then this needs to check that VkImagePlaneMemoryRequirementsInfo was called for each |
| 931 | // plane. |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 932 | } |
| 933 | |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 934 | auto mem_state = Get<DEVICE_MEMORY_STATE>(memory); |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 935 | |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 936 | if (mem_state->alloc_info.allocationSize == image_state->requirements[0].size && |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 937 | mem_state->alloc_info.allocationSize < kMinDedicatedAllocationSize) { |
| 938 | skip |= LogPerformanceWarning( |
| 939 | device, kVUID_BestPractices_SmallDedicatedAllocation, |
| 940 | "%s: Trying to bind %s to a memory block which is fully consumed by the image. " |
Jeremy Gebben | da6b48f | 2021-05-13 10:46:18 -0600 | [diff] [blame] | 941 | "The required size of the allocation is %" PRIu64 ", but smaller images like this should be sub-allocated from " |
| 942 | "larger memory blocks. (Current threshold is %" PRIu64 " bytes.)", |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 943 | api_name, report_data->FormatHandle(image).c_str(), mem_state->alloc_info.allocationSize, kMinDedicatedAllocationSize); |
| 944 | } |
| 945 | |
| 946 | // If we're binding memory to a image which was created as TRANSIENT and the image supports LAZY allocation, |
| 947 | // make sure this type is actually used. |
| 948 | // This warning will only trigger if this layer is run on a platform that supports LAZILY_ALLOCATED_BIT |
| 949 | // (i.e.most tile - based renderers) |
| 950 | if (image_state->createInfo.usage & VK_IMAGE_USAGE_TRANSIENT_ATTACHMENT_BIT) { |
| 951 | bool supports_lazy = false; |
| 952 | uint32_t suggested_type = 0; |
| 953 | |
| 954 | for (uint32_t i = 0; i < phys_dev_mem_props.memoryTypeCount; i++) { |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 955 | if ((1u << i) & image_state->requirements[0].memoryTypeBits) { |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 956 | if (phys_dev_mem_props.memoryTypes[i].propertyFlags & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) { |
| 957 | supports_lazy = true; |
| 958 | suggested_type = i; |
| 959 | break; |
| 960 | } |
| 961 | } |
| 962 | } |
| 963 | |
| 964 | uint32_t allocated_properties = phys_dev_mem_props.memoryTypes[mem_state->alloc_info.memoryTypeIndex].propertyFlags; |
| 965 | |
| 966 | if (supports_lazy && (allocated_properties & VK_MEMORY_PROPERTY_LAZILY_ALLOCATED_BIT) == 0) { |
| 967 | skip |= LogPerformanceWarning( |
| 968 | device, kVUID_BestPractices_NonLazyTransientImage, |
Jeremy Gebben | da6b48f | 2021-05-13 10:46:18 -0600 | [diff] [blame] | 969 | "%s: Attempting to bind memory type %u to VkImage which was created with TRANSIENT_ATTACHMENT_BIT," |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 970 | "but this memory type is not LAZILY_ALLOCATED_BIT. You should use memory type %u here instead to save " |
Jeremy Gebben | da6b48f | 2021-05-13 10:46:18 -0600 | [diff] [blame] | 971 | "%" PRIu64 " bytes of physical memory.", |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 972 | api_name, mem_state->alloc_info.memoryTypeIndex, suggested_type, image_state->requirements[0].size); |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 973 | } |
| 974 | } |
| 975 | |
Rodrigo Locatti | 66b2335 | 2022-03-15 17:28:32 -0300 | [diff] [blame] | 976 | skip |= ValidateBindMemory(device, memory); |
| 977 | |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 978 | return skip; |
| 979 | } |
| 980 | |
| 981 | bool BestPractices::PreCallValidateBindImageMemory(VkDevice device, VkImage image, VkDeviceMemory memory, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 982 | VkDeviceSize memoryOffset) const { |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 983 | bool skip = false; |
| 984 | const char* api_name = "vkBindImageMemory()"; |
| 985 | |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 986 | skip |= ValidateBindImageMemory(image, memory, api_name); |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 987 | |
| 988 | return skip; |
| 989 | } |
| 990 | |
| 991 | bool BestPractices::PreCallValidateBindImageMemory2(VkDevice device, uint32_t bindInfoCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 992 | const VkBindImageMemoryInfo* pBindInfos) const { |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 993 | char api_name[64]; |
| 994 | bool skip = false; |
| 995 | |
| 996 | for (uint32_t i = 0; i < bindInfoCount; i++) { |
Frédéric Wang | afb8986 | 2022-06-21 16:15:29 +0200 | [diff] [blame] | 997 | snprintf(api_name, sizeof(api_name), "vkBindImageMemory2() pBindInfos[%u]", i); |
Mark Lobodzinski | 1f887d3 | 2020-12-30 15:31:33 -0700 | [diff] [blame] | 998 | if (!LvlFindInChain<VkBindImageMemorySwapchainInfoKHR>(pBindInfos[i].pNext)) { |
Tony-LunarG | 5e60b85 | 2020-04-27 11:27:54 -0600 | [diff] [blame] | 999 | skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name); |
| 1000 | } |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 1001 | } |
| 1002 | |
| 1003 | return skip; |
| 1004 | } |
| 1005 | |
| 1006 | bool BestPractices::PreCallValidateBindImageMemory2KHR(VkDevice device, uint32_t bindInfoCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1007 | const VkBindImageMemoryInfo* pBindInfos) const { |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 1008 | char api_name[64]; |
| 1009 | bool skip = false; |
| 1010 | |
| 1011 | for (uint32_t i = 0; i < bindInfoCount; i++) { |
Frédéric Wang | afb8986 | 2022-06-21 16:15:29 +0200 | [diff] [blame] | 1012 | snprintf(api_name, sizeof(api_name), "vkBindImageMemory2KHR() pBindInfos[%u]", i); |
Attilio Provenzano | f31788e | 2020-02-27 12:00:36 +0000 | [diff] [blame] | 1013 | skip |= ValidateBindImageMemory(pBindInfos[i].image, pBindInfos[i].memory, api_name); |
Camden Stocker | 8b798ab | 2019-09-03 10:33:28 -0600 | [diff] [blame] | 1014 | } |
| 1015 | |
| 1016 | return skip; |
| 1017 | } |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 1018 | |
Rodrigo Locatti | 66b2335 | 2022-03-15 17:28:32 -0300 | [diff] [blame] | 1019 | void BestPractices::PreCallRecordSetDeviceMemoryPriorityEXT(VkDevice device, VkDeviceMemory memory, float priority) { |
| 1020 | auto mem_info = std::static_pointer_cast<bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory)); |
| 1021 | mem_info->dynamic_priority.emplace(priority); |
| 1022 | } |
| 1023 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1024 | static inline bool FormatHasFullThroughputBlendingArm(VkFormat format) { |
| 1025 | switch (format) { |
| 1026 | case VK_FORMAT_B10G11R11_UFLOAT_PACK32: |
| 1027 | case VK_FORMAT_R16_SFLOAT: |
| 1028 | case VK_FORMAT_R16G16_SFLOAT: |
| 1029 | case VK_FORMAT_R16G16B16_SFLOAT: |
| 1030 | case VK_FORMAT_R16G16B16A16_SFLOAT: |
| 1031 | case VK_FORMAT_R32_SFLOAT: |
| 1032 | case VK_FORMAT_R32G32_SFLOAT: |
| 1033 | case VK_FORMAT_R32G32B32_SFLOAT: |
| 1034 | case VK_FORMAT_R32G32B32A32_SFLOAT: |
| 1035 | return false; |
| 1036 | |
| 1037 | default: |
| 1038 | return true; |
| 1039 | } |
| 1040 | } |
| 1041 | |
| 1042 | bool BestPractices::ValidateMultisampledBlendingArm(uint32_t createInfoCount, |
| 1043 | const VkGraphicsPipelineCreateInfo* pCreateInfos) const { |
| 1044 | bool skip = false; |
| 1045 | |
| 1046 | for (uint32_t i = 0; i < createInfoCount; i++) { |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1047 | auto create_info = &pCreateInfos[i]; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1048 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1049 | if (!create_info->pColorBlendState || !create_info->pMultisampleState || |
| 1050 | create_info->pMultisampleState->rasterizationSamples == VK_SAMPLE_COUNT_1_BIT || |
| 1051 | create_info->pMultisampleState->sampleShadingEnable) { |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1052 | return skip; |
| 1053 | } |
| 1054 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 1055 | auto rp_state = Get<RENDER_PASS_STATE>(create_info->renderPass); |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1056 | const auto& subpass = rp_state->createInfo.pSubpasses[create_info->subpass]; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1057 | |
Hans-Kristian Arntzen | c2742e7 | 2021-07-01 14:31:06 +0200 | [diff] [blame] | 1058 | // According to spec, pColorBlendState must be ignored if subpass does not have color attachments. |
| 1059 | uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info->pColorBlendState->attachmentCount); |
| 1060 | |
| 1061 | for (uint32_t j = 0; j < num_color_attachments; j++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1062 | const auto& blend_att = create_info->pColorBlendState->pAttachments[j]; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1063 | uint32_t att = subpass.pColorAttachments[j].attachment; |
| 1064 | |
| 1065 | if (att != VK_ATTACHMENT_UNUSED && blend_att.blendEnable && blend_att.colorWriteMask) { |
| 1066 | if (!FormatHasFullThroughputBlendingArm(rp_state->createInfo.pAttachments[att].format)) { |
| 1067 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultisampledBlending, |
| 1068 | "%s vkCreateGraphicsPipelines() - createInfo #%u: Pipeline is multisampled and " |
| 1069 | "color attachment #%u makes use " |
| 1070 | "of a format which cannot be blended at full throughput when using MSAA.", |
| 1071 | VendorSpecificTag(kBPVendorArm), i, j); |
| 1072 | } |
| 1073 | } |
| 1074 | } |
| 1075 | } |
| 1076 | |
| 1077 | return skip; |
| 1078 | } |
| 1079 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1080 | void BestPractices::ManualPostCallRecordCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount, |
| 1081 | const VkComputePipelineCreateInfo* pCreateInfos, |
| 1082 | const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines, |
| 1083 | VkResult result, void* pipe_state) { |
| 1084 | // AMD best practice |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1085 | pipeline_cache_ = pipelineCache; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1086 | } |
| 1087 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1088 | bool BestPractices::PreCallValidateCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount, |
| 1089 | const VkGraphicsPipelineCreateInfo* pCreateInfos, |
Mark Lobodzinski | 2a162a0 | 2019-09-06 11:02:12 -0600 | [diff] [blame] | 1090 | const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1091 | void* cgpl_state_data) const { |
Mark Lobodzinski | 8317a3e | 2019-09-20 10:07:08 -0600 | [diff] [blame] | 1092 | bool skip = StateTracker::PreCallValidateCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, |
| 1093 | pAllocator, pPipelines, cgpl_state_data); |
ziga-lunarg | 08c8158 | 2022-03-08 17:33:45 +0100 | [diff] [blame] | 1094 | if (skip) { |
| 1095 | return skip; |
| 1096 | } |
Mark Lobodzinski | 8dd14d8 | 2020-04-10 14:16:33 -0600 | [diff] [blame] | 1097 | create_graphics_pipeline_api_state* cgpl_state = reinterpret_cast<create_graphics_pipeline_api_state*>(cgpl_state_data); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1098 | |
| 1099 | if ((createInfoCount > 1) && (!pipelineCache)) { |
Mark Lobodzinski | f95a266 | 2020-01-29 15:43:32 -0700 | [diff] [blame] | 1100 | skip |= LogPerformanceWarning( |
| 1101 | device, kVUID_BestPractices_CreatePipelines_MultiplePipelines, |
| 1102 | "Performance Warning: This vkCreateGraphicsPipelines call is creating multiple pipelines but is not using a " |
| 1103 | "pipeline cache, which may help with performance"); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1104 | } |
| 1105 | |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 1106 | for (uint32_t i = 0; i < createInfoCount; i++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1107 | const auto& create_info = pCreateInfos[i]; |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 1108 | |
Tony-LunarG | b6a2daf | 2022-07-29 11:30:55 -0600 | [diff] [blame] | 1109 | if (!(cgpl_state->pipe_state[i]->active_shaders & VK_SHADER_STAGE_MESH_BIT_NV) && create_info.pVertexInputState) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1110 | const auto& vertex_input = *create_info.pVertexInputState; |
Mark Lobodzinski | 8dd14d8 | 2020-04-10 14:16:33 -0600 | [diff] [blame] | 1111 | uint32_t count = 0; |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1112 | for (uint32_t j = 0; j < vertex_input.vertexBindingDescriptionCount; j++) { |
| 1113 | if (vertex_input.pVertexBindingDescriptions[j].inputRate == VK_VERTEX_INPUT_RATE_INSTANCE) { |
Mark Lobodzinski | 8dd14d8 | 2020-04-10 14:16:33 -0600 | [diff] [blame] | 1114 | count++; |
| 1115 | } |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 1116 | } |
Mark Lobodzinski | 8dd14d8 | 2020-04-10 14:16:33 -0600 | [diff] [blame] | 1117 | if (count > kMaxInstancedVertexBuffers) { |
| 1118 | skip |= LogPerformanceWarning( |
| 1119 | device, kVUID_BestPractices_CreatePipelines_TooManyInstancedVertexBuffers, |
| 1120 | "The pipeline is using %u instanced vertex buffers (current limit: %u), but this can be inefficient on the " |
| 1121 | "GPU. If using instanced vertex attributes prefer interleaving them in a single buffer.", |
| 1122 | count, kMaxInstancedVertexBuffers); |
| 1123 | } |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 1124 | } |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1125 | |
Szilard Papp | aaf2da3 | 2020-06-22 10:37:35 +0100 | [diff] [blame] | 1126 | if ((pCreateInfos[i].pRasterizationState->depthBiasEnable) && |
| 1127 | (pCreateInfos[i].pRasterizationState->depthBiasConstantFactor == 0.0f) && |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1128 | (pCreateInfos[i].pRasterizationState->depthBiasSlopeFactor == 0.0f) && |
| 1129 | VendorCheckEnabled(kBPVendorArm)) { |
| 1130 | skip |= LogPerformanceWarning( |
| 1131 | device, kVUID_BestPractices_CreatePipelines_DepthBias_Zero, |
| 1132 | "%s Performance Warning: This vkCreateGraphicsPipelines call is created with depthBiasEnable set to true " |
| 1133 | "and both depthBiasConstantFactor and depthBiasSlopeFactor are set to 0. This can cause reduced " |
| 1134 | "efficiency during rasterization. Consider disabling depthBias or increasing either " |
| 1135 | "depthBiasConstantFactor or depthBiasSlopeFactor.", |
| 1136 | VendorSpecificTag(kBPVendorArm)); |
Szilard Papp | aaf2da3 | 2020-06-22 10:37:35 +0100 | [diff] [blame] | 1137 | } |
| 1138 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1139 | skip |= VendorCheckEnabled(kBPVendorArm) && ValidateMultisampledBlendingArm(createInfoCount, pCreateInfos); |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 1140 | } |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1141 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1142 | auto prev_pipeline = pipeline_cache_.load(); |
| 1143 | if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1144 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MultiplePipelineCaches, |
| 1145 | "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to " |
| 1146 | "improve cache hit rate", VendorSpecificTag(kBPVendorAMD)); |
| 1147 | } |
| 1148 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1149 | if (num_pso_ > kMaxRecommendedNumberOfPSOAMD) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1150 | skip |= |
| 1151 | LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_TooManyPipelines, |
| 1152 | "%s Performance warning: Too many pipelines created, consider consolidation", |
| 1153 | VendorSpecificTag(kBPVendorAMD)); |
| 1154 | } |
| 1155 | |
Nathaniel Cesario | 1a7e1a9 | 2021-08-30 14:34:20 -0600 | [diff] [blame] | 1156 | if (pCreateInfos->pInputAssemblyState && pCreateInfos->pInputAssemblyState->primitiveRestartEnable) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1157 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_AvoidPrimitiveRestart, |
| 1158 | "%s Performance warning: Use of primitive restart is not recommended", |
| 1159 | VendorSpecificTag(kBPVendorAMD)); |
| 1160 | } |
| 1161 | |
| 1162 | // TODO: this might be too aggressive of a check |
| 1163 | if (pCreateInfos->pDynamicState && pCreateInfos->pDynamicState->dynamicStateCount > kDynamicStatesWarningLimitAMD) { |
| 1164 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelines_MinimizeNumDynamicStates, |
| 1165 | "%s Performance warning: Dynamic States usage incurs a performance cost. Ensure that they are truly needed", |
| 1166 | VendorSpecificTag(kBPVendorAMD)); |
| 1167 | } |
| 1168 | } |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 1169 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1170 | return skip; |
| 1171 | } |
| 1172 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1173 | static std::vector<bp_state::AttachmentInfo> GetAttachmentAccess(const safe_VkGraphicsPipelineCreateInfo& create_info, |
| 1174 | std::shared_ptr<const RENDER_PASS_STATE>& rp) { |
| 1175 | std::vector<bp_state::AttachmentInfo> result; |
Jeremy Gebben | b5dda54 | 2022-08-02 14:26:20 -0600 | [diff] [blame] | 1176 | if (!rp || rp->UsesDynamicRendering()) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1177 | return result; |
Hans-Kristian Arntzen | b033ab1 | 2021-06-16 11:16:59 +0200 | [diff] [blame] | 1178 | } |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1179 | |
| 1180 | const auto& subpass = rp->createInfo.pSubpasses[create_info.subpass]; |
| 1181 | |
| 1182 | // NOTE: see PIPELINE_LAYOUT and safe_VkGraphicsPipelineCreateInfo constructors. pColorBlendState and pDepthStencilState |
| 1183 | // are only non-null if they are enabled. |
| 1184 | if (create_info.pColorBlendState) { |
| 1185 | // According to spec, pColorBlendState must be ignored if subpass does not have color attachments. |
| 1186 | uint32_t num_color_attachments = std::min(subpass.colorAttachmentCount, create_info.pColorBlendState->attachmentCount); |
| 1187 | for (uint32_t j = 0; j < num_color_attachments; j++) { |
| 1188 | if (create_info.pColorBlendState->pAttachments[j].colorWriteMask != 0) { |
| 1189 | uint32_t attachment = subpass.pColorAttachments[j].attachment; |
| 1190 | if (attachment != VK_ATTACHMENT_UNUSED) { |
| 1191 | result.push_back({attachment, VK_IMAGE_ASPECT_COLOR_BIT}); |
| 1192 | } |
| 1193 | } |
| 1194 | } |
| 1195 | } |
| 1196 | |
| 1197 | if (create_info.pDepthStencilState && |
| 1198 | (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable || |
| 1199 | create_info.pDepthStencilState->stencilTestEnable)) { |
| 1200 | uint32_t attachment = subpass.pDepthStencilAttachment ? subpass.pDepthStencilAttachment->attachment : VK_ATTACHMENT_UNUSED; |
| 1201 | if (attachment != VK_ATTACHMENT_UNUSED) { |
| 1202 | VkImageAspectFlags aspects = 0; |
| 1203 | if (create_info.pDepthStencilState->depthTestEnable || create_info.pDepthStencilState->depthBoundsTestEnable) { |
| 1204 | aspects |= VK_IMAGE_ASPECT_DEPTH_BIT; |
| 1205 | } |
| 1206 | if (create_info.pDepthStencilState->stencilTestEnable) { |
| 1207 | aspects |= VK_IMAGE_ASPECT_STENCIL_BIT; |
| 1208 | } |
| 1209 | result.push_back({attachment, aspects}); |
| 1210 | } |
| 1211 | } |
| 1212 | return result; |
| 1213 | } |
| 1214 | |
| 1215 | bp_state::Pipeline::Pipeline(const ValidationStateTracker* state_data, const VkGraphicsPipelineCreateInfo* pCreateInfo, |
| 1216 | std::shared_ptr<const RENDER_PASS_STATE>&& rpstate, |
| 1217 | std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) |
| 1218 | : PIPELINE_STATE(state_data, pCreateInfo, std::move(rpstate), std::move(layout)), |
| 1219 | access_framebuffer_attachments(GetAttachmentAccess(create_info.graphics, rp_state)) {} |
| 1220 | |
| 1221 | std::shared_ptr<PIPELINE_STATE> BestPractices::CreateGraphicsPipelineState( |
| 1222 | const VkGraphicsPipelineCreateInfo* pCreateInfo, std::shared_ptr<const RENDER_PASS_STATE>&& render_pass, |
| 1223 | std::shared_ptr<const PIPELINE_LAYOUT_STATE>&& layout) const { |
| 1224 | return std::static_pointer_cast<PIPELINE_STATE>( |
| 1225 | std::make_shared<bp_state::Pipeline>(this, pCreateInfo, std::move(render_pass), std::move(layout))); |
Hans-Kristian Arntzen | b033ab1 | 2021-06-16 11:16:59 +0200 | [diff] [blame] | 1226 | } |
| 1227 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1228 | void BestPractices::ManualPostCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t count, |
| 1229 | const VkGraphicsPipelineCreateInfo* pCreateInfos, |
| 1230 | const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines, |
| 1231 | VkResult result, void* cgpl_state_data) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1232 | // AMD best practice |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1233 | pipeline_cache_ = pipelineCache; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1234 | } |
| 1235 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1236 | bool BestPractices::PreCallValidateCreateComputePipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount, |
| 1237 | const VkComputePipelineCreateInfo* pCreateInfos, |
Mark Lobodzinski | 2a162a0 | 2019-09-06 11:02:12 -0600 | [diff] [blame] | 1238 | const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1239 | void* ccpl_state_data) const { |
Mark Lobodzinski | 8317a3e | 2019-09-20 10:07:08 -0600 | [diff] [blame] | 1240 | bool skip = StateTracker::PreCallValidateCreateComputePipelines(device, pipelineCache, createInfoCount, pCreateInfos, |
| 1241 | pAllocator, pPipelines, ccpl_state_data); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1242 | |
| 1243 | if ((createInfoCount > 1) && (!pipelineCache)) { |
Mark Lobodzinski | f95a266 | 2020-01-29 15:43:32 -0700 | [diff] [blame] | 1244 | skip |= LogPerformanceWarning( |
| 1245 | device, kVUID_BestPractices_CreatePipelines_MultiplePipelines, |
| 1246 | "Performance Warning: This vkCreateComputePipelines call is creating multiple pipelines but is not using a " |
| 1247 | "pipeline cache, which may help with performance"); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1248 | } |
| 1249 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1250 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1251 | auto prev_pipeline = pipeline_cache_.load(); |
| 1252 | if (pipelineCache && prev_pipeline && pipelineCache != prev_pipeline) { |
| 1253 | skip |= LogPerformanceWarning( |
| 1254 | device, kVUID_BestPractices_CreatePipelines_MultiplePipelines, |
| 1255 | "%s Performance Warning: A second pipeline cache is in use. Consider using only one pipeline cache to " |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1256 | "improve cache hit rate", |
| 1257 | VendorSpecificTag(kBPVendorAMD)); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1258 | } |
| 1259 | } |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1260 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1261 | for (uint32_t i = 0; i < createInfoCount; i++) { |
| 1262 | const VkComputePipelineCreateInfo& createInfo = pCreateInfos[i]; |
| 1263 | if (VendorCheckEnabled(kBPVendorArm)) { |
| 1264 | skip |= ValidateCreateComputePipelineArm(createInfo); |
| 1265 | } |
sfricke-samsung | 86d055a | 2022-02-11 14:43:50 -0800 | [diff] [blame] | 1266 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1267 | if (IsExtEnabled(device_extensions.vk_khr_maintenance4)) { |
| 1268 | auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module); |
| 1269 | for (const auto& builtin : module_state->static_data_.builtin_decoration_list) { |
| 1270 | if (builtin.builtin == spv::BuiltInWorkgroupSize) { |
| 1271 | skip |= LogWarning(device, kVUID_BestPractices_SpirvDeprecated_WorkgroupSize, |
| 1272 | "vkCreateComputePipelines(): pCreateInfos[ %" PRIu32 |
| 1273 | "] is using the Workgroup built-in which SPIR-V 1.6 deprecated. The VK_KHR_maintenance4 " |
| 1274 | "extension exposes a new LocalSizeId execution mode that should be used instead.", |
| 1275 | i); |
sfricke-samsung | 86d055a | 2022-02-11 14:43:50 -0800 | [diff] [blame] | 1276 | } |
| 1277 | } |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 1278 | } |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1279 | } |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 1280 | |
| 1281 | return skip; |
| 1282 | } |
| 1283 | |
| 1284 | bool BestPractices::ValidateCreateComputePipelineArm(const VkComputePipelineCreateInfo& createInfo) const { |
| 1285 | bool skip = false; |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 1286 | auto module_state = Get<SHADER_MODULE_STATE>(createInfo.stage.module); |
sfricke-samsung | 8a7341a | 2021-02-28 07:30:21 -0800 | [diff] [blame] | 1287 | // Generate warnings about work group sizes based on active resources. |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 1288 | auto entrypoint = module_state->FindEntrypoint(createInfo.stage.pName, createInfo.stage.stage); |
| 1289 | if (entrypoint == module_state->end()) return false; |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 1290 | |
| 1291 | uint32_t x = 1, y = 1, z = 1; |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 1292 | module_state->FindLocalSize(entrypoint, x, y, z); |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 1293 | |
| 1294 | uint32_t thread_count = x * y * z; |
| 1295 | |
| 1296 | // Generate a priori warnings about work group sizes. |
| 1297 | if (thread_count > kMaxEfficientWorkGroupThreadCountArm) { |
| 1298 | skip |= LogPerformanceWarning( |
| 1299 | device, kVUID_BestPractices_CreateComputePipelines_ComputeWorkGroupSize, |
| 1300 | "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, %u, " |
| 1301 | "%u) (%u threads total), has more threads than advised in a single work group. It is advised to use work " |
| 1302 | "groups with less than %u threads, especially when using barrier() or shared memory.", |
| 1303 | VendorSpecificTag(kBPVendorArm), x, y, z, thread_count, kMaxEfficientWorkGroupThreadCountArm); |
| 1304 | } |
| 1305 | |
| 1306 | if (thread_count == 1 || ((x > 1) && (x & (kThreadGroupDispatchCountAlignmentArm - 1))) || |
| 1307 | ((y > 1) && (y & (kThreadGroupDispatchCountAlignmentArm - 1))) || |
| 1308 | ((z > 1) && (z & (kThreadGroupDispatchCountAlignmentArm - 1)))) { |
| 1309 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeThreadGroupAlignment, |
| 1310 | "%s vkCreateComputePipelines(): compute shader with work group dimensions (%u, " |
| 1311 | "%u, %u) is not aligned to %u " |
| 1312 | "threads. On Arm Mali architectures, not aligning work group sizes to %u may " |
| 1313 | "leave threads idle on the shader " |
| 1314 | "core.", |
| 1315 | VendorSpecificTag(kBPVendorArm), x, y, z, kThreadGroupDispatchCountAlignmentArm, |
| 1316 | kThreadGroupDispatchCountAlignmentArm); |
| 1317 | } |
| 1318 | |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 1319 | auto accessible_ids = module_state->MarkAccessibleIds(entrypoint); |
| 1320 | auto descriptor_uses = module_state->CollectInterfaceByDescriptorSlot(accessible_ids); |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 1321 | |
| 1322 | unsigned dimensions = 0; |
| 1323 | if (x > 1) dimensions++; |
| 1324 | if (y > 1) dimensions++; |
| 1325 | if (z > 1) dimensions++; |
| 1326 | // Here the dimension will really depend on the dispatch grid, but assume it's 1D. |
| 1327 | dimensions = std::max(dimensions, 1u); |
| 1328 | |
| 1329 | // If we're accessing images, we almost certainly want to have a 2D workgroup for cache reasons. |
| 1330 | // There are some false positives here. We could simply have a shader that does this within a 1D grid, |
| 1331 | // or we may have a linearly tiled image, but these cases are quite unlikely in practice. |
| 1332 | bool accesses_2d = false; |
| 1333 | for (const auto& usage : descriptor_uses) { |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 1334 | auto dim = module_state->GetShaderResourceDimensionality(usage.second); |
Sam Walls | d7ab6db | 2020-06-19 20:41:54 +0100 | [diff] [blame] | 1335 | if (dim < 0) continue; |
| 1336 | auto spvdim = spv::Dim(dim); |
| 1337 | if (spvdim != spv::Dim1D && spvdim != spv::DimBuffer) accesses_2d = true; |
| 1338 | } |
| 1339 | |
| 1340 | if (accesses_2d && dimensions < 2) { |
| 1341 | LogPerformanceWarning(device, kVUID_BestPractices_CreateComputePipelines_ComputeSpatialLocality, |
| 1342 | "%s vkCreateComputePipelines(): compute shader has work group dimensions (%u, %u, %u), which " |
| 1343 | "suggests a 1D dispatch, but the shader is accessing 2D or 3D images. The shader may be " |
| 1344 | "exhibiting poor spatial locality with respect to one or more shader resources.", |
| 1345 | VendorSpecificTag(kBPVendorArm), x, y, z); |
| 1346 | } |
| 1347 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1348 | return skip; |
| 1349 | } |
| 1350 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1351 | bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags flags) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1352 | bool skip = false; |
| 1353 | |
| 1354 | if (flags & VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 1355 | skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags, |
| 1356 | "You are using VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT when %s is called\n", api_name.c_str()); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1357 | } else if (flags & VK_PIPELINE_STAGE_ALL_COMMANDS_BIT) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 1358 | skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags, |
| 1359 | "You are using VK_PIPELINE_STAGE_ALL_COMMANDS_BIT when %s is called\n", api_name.c_str()); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1360 | } |
| 1361 | |
| 1362 | return skip; |
| 1363 | } |
| 1364 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1365 | bool BestPractices::CheckPipelineStageFlags(const std::string& api_name, VkPipelineStageFlags2KHR flags) const { |
| 1366 | bool skip = false; |
| 1367 | |
| 1368 | if (flags & VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR) { |
| 1369 | skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags, |
| 1370 | "You are using VK_PIPELINE_STAGE_2_ALL_GRAPHICS_BIT_KHR when %s is called\n", api_name.c_str()); |
| 1371 | } else if (flags & VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR) { |
| 1372 | skip |= LogWarning(device, kVUID_BestPractices_PipelineStageFlags, |
| 1373 | "You are using VK_PIPELINE_STAGE_2_ALL_COMMANDS_BIT_KHR when %s is called\n", api_name.c_str()); |
| 1374 | } |
| 1375 | |
| 1376 | return skip; |
| 1377 | } |
| 1378 | |
| 1379 | bool BestPractices::CheckDependencyInfo(const std::string& api_name, const VkDependencyInfoKHR& dep_info) const { |
| 1380 | bool skip = false; |
| 1381 | auto stage_masks = sync_utils::GetGlobalStageMasks(dep_info); |
| 1382 | |
| 1383 | skip |= CheckPipelineStageFlags(api_name, stage_masks.src); |
| 1384 | skip |= CheckPipelineStageFlags(api_name, stage_masks.dst); |
| 1385 | |
| 1386 | return skip; |
| 1387 | } |
| 1388 | |
Mark Lobodzinski | 84101d7 | 2020-04-24 09:43:48 -0600 | [diff] [blame] | 1389 | void BestPractices::ManualPostCallRecordQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo, VkResult result) { |
Mark Lobodzinski | 9b133c1 | 2020-03-10 10:42:56 -0600 | [diff] [blame] | 1390 | for (uint32_t i = 0; i < pPresentInfo->swapchainCount; ++i) { |
| 1391 | auto swapchains_result = pPresentInfo->pResults ? pPresentInfo->pResults[i] : result; |
| 1392 | if (swapchains_result == VK_SUBOPTIMAL_KHR) { |
| 1393 | LogPerformanceWarning( |
| 1394 | pPresentInfo->pSwapchains[i], kVUID_BestPractices_SuboptimalSwapchain, |
| 1395 | "vkQueuePresentKHR: %s :VK_SUBOPTIMAL_KHR was returned. VK_SUBOPTIMAL_KHR - Presentation will still succeed, " |
| 1396 | "subject to the window resize behavior, but the swapchain is no longer configured optimally for the surface it " |
| 1397 | "targets. Applications should query updated surface information and recreate their swapchain at the next " |
| 1398 | "convenient opportunity.", |
| 1399 | report_data->FormatHandle(pPresentInfo->pSwapchains[i]).c_str()); |
| 1400 | } |
| 1401 | } |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1402 | |
| 1403 | // AMD best practice |
| 1404 | // end-of-frame cleanup |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1405 | num_queue_submissions_ = 0; |
| 1406 | num_barriers_objects_ = 0; |
| 1407 | ClearPipelinesUsedInFrame(); |
Mark Lobodzinski | 9b133c1 | 2020-03-10 10:42:56 -0600 | [diff] [blame] | 1408 | } |
| 1409 | |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1410 | bool BestPractices::PreCallValidateQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, |
| 1411 | VkFence fence) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1412 | bool skip = false; |
| 1413 | |
| 1414 | for (uint32_t submit = 0; submit < submitCount; submit++) { |
| 1415 | for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreCount; semaphore++) { |
| 1416 | skip |= CheckPipelineStageFlags("vkQueueSubmit", pSubmits[submit].pWaitDstStageMask[semaphore]); |
| 1417 | } |
ziga-lunarg | c77f0c0 | 2022-04-18 00:15:16 +0200 | [diff] [blame] | 1418 | if (pSubmits[submit].signalSemaphoreCount == 0 && pSubmits[submit].pSignalSemaphores != nullptr) { |
| 1419 | skip |= |
| 1420 | LogWarning(device, kVUID_BestPractices_SemaphoreCount, |
| 1421 | "pSubmits[%" PRIu32 "].pSignalSemaphores is set, but pSubmits[%" PRIu32 "].signalSemaphoreCount is 0.", |
| 1422 | submit, submit); |
| 1423 | } |
| 1424 | if (pSubmits[submit].waitSemaphoreCount == 0 && pSubmits[submit].pWaitSemaphores != nullptr) { |
| 1425 | skip |= LogWarning(device, kVUID_BestPractices_SemaphoreCount, |
| 1426 | "pSubmits[%" PRIu32 "].pWaitSemaphores is set, but pSubmits[%" PRIu32 "].waitSemaphoreCount is 0.", |
| 1427 | submit, submit); |
| 1428 | } |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1429 | } |
| 1430 | |
| 1431 | return skip; |
| 1432 | } |
| 1433 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1434 | bool BestPractices::PreCallValidateQueueSubmit2KHR(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2KHR* pSubmits, |
| 1435 | VkFence fence) const { |
| 1436 | bool skip = false; |
| 1437 | |
| 1438 | for (uint32_t submit = 0; submit < submitCount; submit++) { |
| 1439 | for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) { |
| 1440 | skip |= CheckPipelineStageFlags("vkQueueSubmit2KHR", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask); |
| 1441 | } |
| 1442 | } |
| 1443 | |
| 1444 | return skip; |
| 1445 | } |
| 1446 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 1447 | bool BestPractices::PreCallValidateQueueSubmit2(VkQueue queue, uint32_t submitCount, const VkSubmitInfo2* pSubmits, |
| 1448 | VkFence fence) const { |
| 1449 | bool skip = false; |
| 1450 | |
| 1451 | for (uint32_t submit = 0; submit < submitCount; submit++) { |
| 1452 | for (uint32_t semaphore = 0; semaphore < pSubmits[submit].waitSemaphoreInfoCount; semaphore++) { |
| 1453 | skip |= CheckPipelineStageFlags("vkQueueSubmit2", pSubmits[submit].pWaitSemaphoreInfos[semaphore].stageMask); |
| 1454 | } |
| 1455 | } |
| 1456 | |
| 1457 | return skip; |
| 1458 | } |
| 1459 | |
Attilio Provenzano | 746e43e | 2020-02-27 11:23:50 +0000 | [diff] [blame] | 1460 | bool BestPractices::PreCallValidateCreateCommandPool(VkDevice device, const VkCommandPoolCreateInfo* pCreateInfo, |
| 1461 | const VkAllocationCallbacks* pAllocator, VkCommandPool* pCommandPool) const { |
| 1462 | bool skip = false; |
| 1463 | |
| 1464 | if (pCreateInfo->flags & VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT) { |
| 1465 | skip |= LogPerformanceWarning( |
| 1466 | device, kVUID_BestPractices_CreateCommandPool_CommandBufferReset, |
| 1467 | "vkCreateCommandPool(): VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT is set. Consider resetting entire " |
| 1468 | "pool instead."); |
| 1469 | } |
| 1470 | |
| 1471 | return skip; |
| 1472 | } |
| 1473 | |
| 1474 | bool BestPractices::PreCallValidateBeginCommandBuffer(VkCommandBuffer commandBuffer, |
| 1475 | const VkCommandBufferBeginInfo* pBeginInfo) const { |
| 1476 | bool skip = false; |
| 1477 | |
| 1478 | if (pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT) { |
| 1479 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_SimultaneousUse, |
| 1480 | "vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_SIMULTANEOUS_USE_BIT is set."); |
| 1481 | } |
| 1482 | |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1483 | if (!(pBeginInfo->flags & VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT) && VendorCheckEnabled(kBPVendorArm)) { |
| 1484 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_BeginCommandBuffer_OneTimeSubmit, |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1485 | "%s vkBeginCommandBuffer(): VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT is not set. " |
| 1486 | "For best performance on Mali GPUs, consider setting ONE_TIME_SUBMIT by default.", |
| 1487 | VendorSpecificTag(kBPVendorArm)); |
| 1488 | } |
| 1489 | |
Attilio Provenzano | 746e43e | 2020-02-27 11:23:50 +0000 | [diff] [blame] | 1490 | return skip; |
| 1491 | } |
| 1492 | |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1493 | bool BestPractices::PreCallValidateCmdSetEvent(VkCommandBuffer commandBuffer, VkEvent event, VkPipelineStageFlags stageMask) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1494 | bool skip = false; |
| 1495 | |
| 1496 | skip |= CheckPipelineStageFlags("vkCmdSetEvent", stageMask); |
| 1497 | |
| 1498 | return skip; |
| 1499 | } |
| 1500 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1501 | bool BestPractices::PreCallValidateCmdSetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event, |
| 1502 | const VkDependencyInfoKHR* pDependencyInfo) const { |
| 1503 | return CheckDependencyInfo("vkCmdSetEvent2KHR", *pDependencyInfo); |
| 1504 | } |
| 1505 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 1506 | bool BestPractices::PreCallValidateCmdSetEvent2(VkCommandBuffer commandBuffer, VkEvent event, |
| 1507 | const VkDependencyInfo* pDependencyInfo) const { |
| 1508 | return CheckDependencyInfo("vkCmdSetEvent2", *pDependencyInfo); |
| 1509 | } |
| 1510 | |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1511 | bool BestPractices::PreCallValidateCmdResetEvent(VkCommandBuffer commandBuffer, VkEvent event, |
| 1512 | VkPipelineStageFlags stageMask) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1513 | bool skip = false; |
| 1514 | |
| 1515 | skip |= CheckPipelineStageFlags("vkCmdResetEvent", stageMask); |
| 1516 | |
| 1517 | return skip; |
| 1518 | } |
| 1519 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1520 | bool BestPractices::PreCallValidateCmdResetEvent2KHR(VkCommandBuffer commandBuffer, VkEvent event, |
| 1521 | VkPipelineStageFlags2KHR stageMask) const { |
| 1522 | bool skip = false; |
| 1523 | |
| 1524 | skip |= CheckPipelineStageFlags("vkCmdResetEvent2KHR", stageMask); |
| 1525 | |
| 1526 | return skip; |
| 1527 | } |
| 1528 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 1529 | bool BestPractices::PreCallValidateCmdResetEvent2(VkCommandBuffer commandBuffer, VkEvent event, |
| 1530 | VkPipelineStageFlags2 stageMask) const { |
| 1531 | bool skip = false; |
| 1532 | |
| 1533 | skip |= CheckPipelineStageFlags("vkCmdResetEvent2", stageMask); |
| 1534 | |
| 1535 | return skip; |
| 1536 | } |
| 1537 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1538 | bool BestPractices::PreCallValidateCmdWaitEvents(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents, |
| 1539 | VkPipelineStageFlags srcStageMask, VkPipelineStageFlags dstStageMask, |
| 1540 | uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers, |
| 1541 | uint32_t bufferMemoryBarrierCount, |
| 1542 | const VkBufferMemoryBarrier* pBufferMemoryBarriers, |
| 1543 | uint32_t imageMemoryBarrierCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1544 | const VkImageMemoryBarrier* pImageMemoryBarriers) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1545 | bool skip = false; |
| 1546 | |
| 1547 | skip |= CheckPipelineStageFlags("vkCmdWaitEvents", srcStageMask); |
| 1548 | skip |= CheckPipelineStageFlags("vkCmdWaitEvents", dstStageMask); |
| 1549 | |
| 1550 | return skip; |
| 1551 | } |
| 1552 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1553 | bool BestPractices::PreCallValidateCmdWaitEvents2KHR(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents, |
| 1554 | const VkDependencyInfoKHR* pDependencyInfos) const { |
| 1555 | bool skip = false; |
| 1556 | for (uint32_t i = 0; i < eventCount; i++) { |
| 1557 | skip = CheckDependencyInfo("vkCmdWaitEvents2KHR", pDependencyInfos[i]); |
| 1558 | } |
| 1559 | |
| 1560 | return skip; |
| 1561 | } |
| 1562 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 1563 | bool BestPractices::PreCallValidateCmdWaitEvents2(VkCommandBuffer commandBuffer, uint32_t eventCount, const VkEvent* pEvents, |
| 1564 | const VkDependencyInfo* pDependencyInfos) const { |
| 1565 | bool skip = false; |
| 1566 | for (uint32_t i = 0; i < eventCount; i++) { |
| 1567 | skip = CheckDependencyInfo("vkCmdWaitEvents2", pDependencyInfos[i]); |
| 1568 | } |
| 1569 | |
| 1570 | return skip; |
| 1571 | } |
| 1572 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1573 | bool BestPractices::PreCallValidateCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask, |
| 1574 | VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags, |
| 1575 | uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers, |
| 1576 | uint32_t bufferMemoryBarrierCount, |
| 1577 | const VkBufferMemoryBarrier* pBufferMemoryBarriers, |
| 1578 | uint32_t imageMemoryBarrierCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1579 | const VkImageMemoryBarrier* pImageMemoryBarriers) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1580 | bool skip = false; |
| 1581 | |
| 1582 | skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", srcStageMask); |
| 1583 | skip |= CheckPipelineStageFlags("vkCmdPipelineBarrier", dstStageMask); |
| 1584 | |
ziga-lunarg | b65dbfb | 2022-03-19 18:45:09 +0100 | [diff] [blame] | 1585 | for (uint32_t i = 0; i < imageMemoryBarrierCount; ++i) { |
| 1586 | if (pImageMemoryBarriers[i].oldLayout == VK_IMAGE_LAYOUT_UNDEFINED && |
| 1587 | IsImageLayoutReadOnly(pImageMemoryBarriers[i].newLayout)) { |
| 1588 | skip |= LogWarning(device, kVUID_BestPractices_TransitionUndefinedToReadOnly, |
| 1589 | "VkImageMemoryBarrier is being submitted with oldLayout VK_IMAGE_LAYOUT_UNDEFINED and the contents " |
| 1590 | "may be discarded, but the newLayout is %s, which is read only.", |
| 1591 | string_VkImageLayout(pImageMemoryBarriers[i].newLayout)); |
| 1592 | } |
| 1593 | } |
| 1594 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1595 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1596 | auto num = num_barriers_objects_.load(); |
| 1597 | if (num + imageMemoryBarrierCount + bufferMemoryBarrierCount > kMaxRecommendedBarriersSizeAMD) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1598 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_highBarrierCount, |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1599 | "%s Performance warning: In this frame, %" PRIu32 |
| 1600 | " barriers were already submitted. Barriers have a high cost and can " |
| 1601 | "stall the GPU. " |
| 1602 | "Consider consolidating and re-organizing the frame to use fewer barriers.", |
| 1603 | VendorSpecificTag(kBPVendorAMD), num); |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1604 | } |
| 1605 | |
| 1606 | std::array<VkImageLayout, 3> read_layouts = { |
| 1607 | VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, |
| 1608 | VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, |
| 1609 | VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL, |
| 1610 | }; |
| 1611 | |
| 1612 | for (uint32_t i = 0; i < imageMemoryBarrierCount; i++) { |
| 1613 | // read to read barriers |
| 1614 | auto found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].oldLayout); |
| 1615 | bool old_is_read_layout = found != read_layouts.end(); |
| 1616 | found = std::find(read_layouts.begin(), read_layouts.end(), pImageMemoryBarriers[i].newLayout); |
| 1617 | bool new_is_read_layout = found != read_layouts.end(); |
| 1618 | if (old_is_read_layout && new_is_read_layout) { |
| 1619 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_PipelineBarrier_readToReadBarrier, |
| 1620 | "%s Performance warning: Don't issue read-to-read barriers. Get the resource in the right state the first " |
| 1621 | "time you use it.", |
| 1622 | VendorSpecificTag(kBPVendorAMD)); |
| 1623 | } |
| 1624 | |
| 1625 | // general with no storage |
| 1626 | if (pImageMemoryBarriers[i].newLayout == VK_IMAGE_LAYOUT_GENERAL) { |
| 1627 | auto image_state = Get<IMAGE_STATE>(pImageMemoryBarriers[i].image); |
| 1628 | if (!(image_state->createInfo.usage & VK_IMAGE_USAGE_STORAGE_BIT)) { |
| 1629 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidGeneral, |
| 1630 | "%s Performance warning: VK_IMAGE_LAYOUT_GENERAL should only be used with " |
| 1631 | "VK_IMAGE_USAGE_STORAGE_BIT images.", |
| 1632 | VendorSpecificTag(kBPVendorAMD)); |
| 1633 | } |
| 1634 | } |
| 1635 | } |
| 1636 | } |
| 1637 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1638 | return skip; |
| 1639 | } |
| 1640 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1641 | bool BestPractices::PreCallValidateCmdPipelineBarrier2KHR(VkCommandBuffer commandBuffer, |
| 1642 | const VkDependencyInfoKHR* pDependencyInfo) const { |
| 1643 | return CheckDependencyInfo("vkCmdPipelineBarrier2KHR", *pDependencyInfo); |
| 1644 | } |
| 1645 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 1646 | bool BestPractices::PreCallValidateCmdPipelineBarrier2(VkCommandBuffer commandBuffer, |
| 1647 | const VkDependencyInfo* pDependencyInfo) const { |
| 1648 | return CheckDependencyInfo("vkCmdPipelineBarrier2", *pDependencyInfo); |
| 1649 | } |
| 1650 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1651 | bool BestPractices::PreCallValidateCmdWriteTimestamp(VkCommandBuffer commandBuffer, VkPipelineStageFlagBits pipelineStage, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 1652 | VkQueryPool queryPool, uint32_t query) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1653 | bool skip = false; |
| 1654 | |
Jeremy Gebben | a3705f4 | 2021-01-19 16:47:43 -0700 | [diff] [blame] | 1655 | skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp", static_cast<VkPipelineStageFlags>(pipelineStage)); |
| 1656 | |
| 1657 | return skip; |
| 1658 | } |
| 1659 | |
| 1660 | bool BestPractices::PreCallValidateCmdWriteTimestamp2KHR(VkCommandBuffer commandBuffer, VkPipelineStageFlags2KHR pipelineStage, |
| 1661 | VkQueryPool queryPool, uint32_t query) const { |
| 1662 | bool skip = false; |
| 1663 | |
| 1664 | skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2KHR", pipelineStage); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 1665 | |
| 1666 | return skip; |
| 1667 | } |
| 1668 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 1669 | bool BestPractices::PreCallValidateCmdWriteTimestamp2(VkCommandBuffer commandBuffer, VkPipelineStageFlags2 pipelineStage, |
| 1670 | VkQueryPool queryPool, uint32_t query) const { |
| 1671 | bool skip = false; |
| 1672 | |
| 1673 | skip |= CheckPipelineStageFlags("vkCmdWriteTimestamp2", pipelineStage); |
| 1674 | |
| 1675 | return skip; |
| 1676 | } |
| 1677 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1678 | void BestPractices::PostCallRecordCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint, |
| 1679 | VkPipeline pipeline) { |
| 1680 | StateTracker::PostCallRecordCmdBindPipeline(commandBuffer, pipelineBindPoint, pipeline); |
| 1681 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1682 | // AMD best practice |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1683 | PipelineUsedInFrame(pipeline); |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1684 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1685 | if (pipelineBindPoint == VK_PIPELINE_BIND_POINT_GRAPHICS) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1686 | auto pipeline_state = Get<bp_state::Pipeline>(pipeline); |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1687 | // check for depth/blend state tracking |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1688 | if (pipeline_state) { |
| 1689 | auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 1690 | assert(cb_node); |
| 1691 | auto& render_pass_state = cb_node->render_pass_state; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1692 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1693 | render_pass_state.nextDrawTouchesAttachments = pipeline_state->access_framebuffer_attachments; |
Hans-Kristian Arntzen | 56232b9 | 2021-06-16 14:37:48 +0200 | [diff] [blame] | 1694 | render_pass_state.drawTouchAttachments = true; |
Hans-Kristian Arntzen | 8abca1e | 2021-06-16 13:57:45 +0200 | [diff] [blame] | 1695 | |
Nathaniel Cesario | 3fd4f76 | 2022-02-16 16:07:06 -0700 | [diff] [blame] | 1696 | const auto* blend_state = pipeline_state->ColorBlendState(); |
| 1697 | const auto* stencil_state = pipeline_state->DepthStencilState(); |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1698 | |
| 1699 | if (blend_state) { |
| 1700 | // assume the pipeline is depth-only unless any of the attachments have color writes enabled |
Hans-Kristian Arntzen | 56232b9 | 2021-06-16 14:37:48 +0200 | [diff] [blame] | 1701 | render_pass_state.depthOnly = true; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1702 | for (size_t i = 0; i < blend_state->attachmentCount; i++) { |
| 1703 | if (blend_state->pAttachments[i].colorWriteMask != 0) { |
Hans-Kristian Arntzen | 56232b9 | 2021-06-16 14:37:48 +0200 | [diff] [blame] | 1704 | render_pass_state.depthOnly = false; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1705 | } |
| 1706 | } |
| 1707 | } |
| 1708 | |
| 1709 | // check for depth value usage |
Hans-Kristian Arntzen | 56232b9 | 2021-06-16 14:37:48 +0200 | [diff] [blame] | 1710 | render_pass_state.depthEqualComparison = false; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1711 | |
| 1712 | if (stencil_state && stencil_state->depthTestEnable) { |
| 1713 | switch (stencil_state->depthCompareOp) { |
| 1714 | case VK_COMPARE_OP_EQUAL: |
| 1715 | case VK_COMPARE_OP_GREATER_OR_EQUAL: |
| 1716 | case VK_COMPARE_OP_LESS_OR_EQUAL: |
Hans-Kristian Arntzen | 56232b9 | 2021-06-16 14:37:48 +0200 | [diff] [blame] | 1717 | render_pass_state.depthEqualComparison = true; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1718 | break; |
| 1719 | default: |
| 1720 | break; |
| 1721 | } |
| 1722 | } |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 1723 | } |
| 1724 | } |
| 1725 | } |
| 1726 | |
Hans-Kristian Arntzen | 237663c | 2021-07-01 14:36:40 +0200 | [diff] [blame] | 1727 | static inline bool RenderPassUsesAttachmentAsResolve(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) { |
| 1728 | for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) { |
| 1729 | const auto& subpass_info = createInfo.pSubpasses[subpass]; |
| 1730 | if (subpass_info.pResolveAttachments) { |
| 1731 | for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) { |
| 1732 | if (subpass_info.pResolveAttachments[i].attachment == attachment) return true; |
| 1733 | } |
| 1734 | } |
| 1735 | } |
| 1736 | |
| 1737 | return false; |
| 1738 | } |
| 1739 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1740 | static inline bool RenderPassUsesAttachmentOnTile(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) { |
| 1741 | for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1742 | const auto& subpass_info = createInfo.pSubpasses[subpass]; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1743 | |
| 1744 | // If an attachment is ever used as a color attachment, |
| 1745 | // resolve attachment or depth stencil attachment, |
| 1746 | // it needs to exist on tile at some point. |
| 1747 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1748 | for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) { |
| 1749 | if (subpass_info.pColorAttachments[i].attachment == attachment) return true; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1750 | } |
| 1751 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1752 | if (subpass_info.pResolveAttachments) { |
| 1753 | for (uint32_t i = 0; i < subpass_info.colorAttachmentCount; i++) { |
| 1754 | if (subpass_info.pResolveAttachments[i].attachment == attachment) return true; |
| 1755 | } |
| 1756 | } |
| 1757 | |
| 1758 | if (subpass_info.pDepthStencilAttachment && subpass_info.pDepthStencilAttachment->attachment == attachment) return true; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1759 | } |
| 1760 | |
| 1761 | return false; |
| 1762 | } |
| 1763 | |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1764 | static inline bool RenderPassUsesAttachmentAsImageOnly(const safe_VkRenderPassCreateInfo2& createInfo, uint32_t attachment) { |
| 1765 | if (RenderPassUsesAttachmentOnTile(createInfo, attachment)) { |
| 1766 | return false; |
| 1767 | } |
| 1768 | |
| 1769 | for (uint32_t subpass = 0; subpass < createInfo.subpassCount; subpass++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1770 | const auto& subpassInfo = createInfo.pSubpasses[subpass]; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1771 | |
| 1772 | for (uint32_t i = 0; i < subpassInfo.inputAttachmentCount; i++) { |
| 1773 | if (subpassInfo.pInputAttachments[i].attachment == attachment) { |
| 1774 | return true; |
| 1775 | } |
| 1776 | } |
| 1777 | } |
| 1778 | |
| 1779 | return false; |
| 1780 | } |
| 1781 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1782 | bool BestPractices::ValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version, |
| 1783 | const VkRenderPassBeginInfo* pRenderPassBegin) const { |
| 1784 | bool skip = false; |
| 1785 | |
| 1786 | if (!pRenderPassBegin) { |
| 1787 | return skip; |
| 1788 | } |
| 1789 | |
Gareth Webb | dc6549a | 2021-06-16 03:52:24 +0100 | [diff] [blame] | 1790 | if (pRenderPassBegin->renderArea.extent.width == 0 || pRenderPassBegin->renderArea.extent.height == 0) { |
| 1791 | skip |= LogWarning(device, kVUID_BestPractices_BeginRenderPass_ZeroSizeRenderArea, |
| 1792 | "This render pass has a zero-size render area. It cannot write to any attachments, " |
| 1793 | "and can only be used for side effects such as layout transitions."); |
| 1794 | } |
| 1795 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 1796 | auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1797 | if (rp_state) { |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 1798 | if (rp_state->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) { |
Mark Lobodzinski | 1f887d3 | 2020-12-30 15:31:33 -0700 | [diff] [blame] | 1799 | const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext); |
Tony-LunarG | 767180f | 2020-04-23 14:03:59 -0600 | [diff] [blame] | 1800 | if (rpabi) { |
| 1801 | skip = ValidateAttachments(rp_state->createInfo.ptr(), rpabi->attachmentCount, rpabi->pAttachments); |
| 1802 | } |
| 1803 | } |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1804 | // Check if any attachments have LOAD operation on them |
| 1805 | for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1806 | const auto& attachment = rp_state->createInfo.pAttachments[att]; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1807 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1808 | bool attachment_has_readback = false; |
Hans-Kristian Arntzen | 4afb59b | 2021-06-18 12:41:36 +0200 | [diff] [blame] | 1809 | if (!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1810 | attachment_has_readback = true; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1811 | } |
| 1812 | |
| 1813 | if (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1814 | attachment_has_readback = true; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1815 | } |
| 1816 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1817 | bool attachment_needs_readback = false; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1818 | |
| 1819 | // Check if the attachment is actually used in any subpass on-tile |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 1820 | if (attachment_has_readback && RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) { |
| 1821 | attachment_needs_readback = true; |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1822 | } |
| 1823 | |
| 1824 | // Using LOAD_OP_LOAD is expensive on tiled GPUs, so flag it as a potential improvement |
LawG4 | 7747b32 | 2022-02-23 16:12:10 +0000 | [diff] [blame] | 1825 | if (attachment_needs_readback && (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) { |
| 1826 | skip |= |
| 1827 | LogPerformanceWarning(device, kVUID_BestPractices_BeginRenderPass_AttachmentNeedsReadback, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 1828 | "%s %s: Attachment #%u in render pass has begun with VK_ATTACHMENT_LOAD_OP_LOAD.\n" |
LawG4 | 7747b32 | 2022-02-23 16:12:10 +0000 | [diff] [blame] | 1829 | "Submitting this renderpass will cause the driver to inject a readback of the attachment " |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 1830 | "which will copy in total %u pixels (renderArea = " |
LawG4 | 7747b32 | 2022-02-23 16:12:10 +0000 | [diff] [blame] | 1831 | "{ %" PRId32 ", %" PRId32 ", %" PRIu32 ", %" PRIu32 " }) to the tile buffer.", |
| 1832 | VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), att, |
| 1833 | pRenderPassBegin->renderArea.extent.width * pRenderPassBegin->renderArea.extent.height, |
| 1834 | pRenderPassBegin->renderArea.offset.x, pRenderPassBegin->renderArea.offset.y, |
| 1835 | pRenderPassBegin->renderArea.extent.width, pRenderPassBegin->renderArea.extent.height); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1836 | } |
| 1837 | } |
paul-lunarg | 7089e27 | 2022-06-20 22:19:37 +0200 | [diff] [blame] | 1838 | |
| 1839 | // Check if renderpass has at least one VK_ATTACHMENT_LOAD_OP_CLEAR |
| 1840 | |
| 1841 | bool clearing = false; |
| 1842 | |
| 1843 | for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) { |
| 1844 | const auto& attachment = rp_state->createInfo.pAttachments[att]; |
| 1845 | |
| 1846 | if (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) { |
| 1847 | clearing = true; |
| 1848 | break; |
| 1849 | } |
| 1850 | } |
| 1851 | |
| 1852 | // Check if there are ClearValues passed to BeginRenderPass even though no attachments will be cleared |
| 1853 | if (!clearing && pRenderPassBegin->clearValueCount > 0) { |
| 1854 | // Flag as warning because nothing will happen per spec, and pClearValues will be ignored |
| 1855 | skip |= LogWarning( |
| 1856 | device, kVUID_BestPractices_ClearValueWithoutLoadOpClear, |
| 1857 | "This render pass does not have VkRenderPassCreateInfo.pAttachments->loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR " |
| 1858 | "but VkRenderPassBeginInfo.clearValueCount > 0. VkRenderPassBeginInfo.pClearValues will be ignored and no " |
paul-lunarg | a0a149c | 2022-06-23 16:18:51 +0200 | [diff] [blame] | 1859 | "attachments will be cleared."); |
paul-lunarg | 7089e27 | 2022-06-20 22:19:37 +0200 | [diff] [blame] | 1860 | } |
paul-lunarg | a0a149c | 2022-06-23 16:18:51 +0200 | [diff] [blame] | 1861 | |
| 1862 | // Check if there are more clearValues than attachments |
| 1863 | if(pRenderPassBegin->clearValueCount > rp_state->createInfo.attachmentCount) { |
| 1864 | // Flag as warning because the overflowing clearValues will be ignored and could even be undefined on certain platforms. |
| 1865 | // This could signal a bug and there seems to be no reason for this to happen on purpose. |
| 1866 | skip |= LogWarning( |
| 1867 | device, kVUID_BestPractices_ClearValueCountHigherThanAttachmentCount, |
| 1868 | "This render pass has VkRenderPassBeginInfo.clearValueCount > VkRenderPassCreateInfo.attachmentCount " |
| 1869 | "(%" PRIu32 " > %" PRIu32 ") and as such the clearValues that do not have a corresponding attachment will be ignored.", |
| 1870 | pRenderPassBegin->clearValueCount, rp_state->createInfo.attachmentCount); |
| 1871 | } |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 1872 | } |
| 1873 | |
| 1874 | return skip; |
| 1875 | } |
| 1876 | |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 1877 | void BestPractices::QueueValidateImageView(QueueCallbacks &funcs, const char* function_name, |
| 1878 | IMAGE_VIEW_STATE* view, IMAGE_SUBRESOURCE_USAGE_BP usage) { |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1879 | if (view) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1880 | auto image_state = std::static_pointer_cast<bp_state::Image>(view->image_state); |
| 1881 | QueueValidateImage(funcs, function_name, image_state, usage, view->normalized_subresource_range); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1882 | } |
| 1883 | } |
| 1884 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1885 | void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state, |
| 1886 | IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceRange& subresource_range) { |
Hans-Kristian Arntzen | 9326420 | 2021-05-21 17:07:46 +0200 | [diff] [blame] | 1887 | // If we're viewing a 3D slice, ignore base array layer. |
| 1888 | // The entire 3D subresource is accessed as one atomic unit. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1889 | const uint32_t base_array_layer = state->createInfo.imageType == VK_IMAGE_TYPE_3D ? 0 : subresource_range.baseArrayLayer; |
Hans-Kristian Arntzen | 9326420 | 2021-05-21 17:07:46 +0200 | [diff] [blame] | 1890 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1891 | const uint32_t max_layers = state->createInfo.arrayLayers - base_array_layer; |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1892 | const uint32_t array_layers = std::min(subresource_range.layerCount, max_layers); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1893 | const uint32_t max_levels = state->createInfo.mipLevels - subresource_range.baseMipLevel; |
| 1894 | const uint32_t mip_levels = std::min(state->createInfo.mipLevels, max_levels); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1895 | |
| 1896 | for (uint32_t layer = 0; layer < array_layers; layer++) { |
| 1897 | for (uint32_t level = 0; level < mip_levels; level++) { |
Hans-Kristian Arntzen | 9326420 | 2021-05-21 17:07:46 +0200 | [diff] [blame] | 1898 | QueueValidateImage(funcs, function_name, state, usage, layer + base_array_layer, |
| 1899 | level + subresource_range.baseMipLevel); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1900 | } |
| 1901 | } |
| 1902 | } |
| 1903 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1904 | void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state, |
| 1905 | IMAGE_SUBRESOURCE_USAGE_BP usage, const VkImageSubresourceLayers& subresource_layers) { |
| 1906 | const uint32_t max_layers = state->createInfo.arrayLayers - subresource_layers.baseArrayLayer; |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 1907 | const uint32_t array_layers = std::min(subresource_layers.layerCount, max_layers); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1908 | |
| 1909 | for (uint32_t layer = 0; layer < array_layers; layer++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 1910 | QueueValidateImage(funcs, function_name, state, usage, layer + subresource_layers.baseArrayLayer, subresource_layers.mipLevel); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1911 | } |
| 1912 | } |
| 1913 | |
paul-lunarg | 5eb5206 | 2022-06-27 18:57:15 +0200 | [diff] [blame] | 1914 | void BestPractices::QueueValidateImage(QueueCallbacks& funcs, const char* function_name, std::shared_ptr<bp_state::Image>& state, |
| 1915 | IMAGE_SUBRESOURCE_USAGE_BP usage, uint32_t array_layer, uint32_t mip_level) { |
| 1916 | funcs.push_back([this, function_name, state, usage, array_layer, mip_level](const ValidationStateTracker&, const QUEUE_STATE&, |
| 1917 | const CMD_BUFFER_STATE&) -> bool { |
| 1918 | ValidateImageInQueue(function_name, *state, usage, array_layer, mip_level); |
| 1919 | return false; |
| 1920 | }); |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 1921 | } |
| 1922 | |
LawG4 | 4d414ba | 2022-02-23 15:35:41 +0000 | [diff] [blame] | 1923 | void BestPractices::ValidateImageInQueueArmImg(const char* function_name, const bp_state::Image& image, |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1924 | IMAGE_SUBRESOURCE_USAGE_BP last_usage, IMAGE_SUBRESOURCE_USAGE_BP usage, |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1925 | uint32_t array_layer, uint32_t mip_level) { |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1926 | // Swapchain images are implicitly read so clear after store is expected. |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 1927 | if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED && last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED && |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1928 | !image.IsSwapchainImage()) { |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1929 | LogPerformanceWarning( |
| 1930 | device, kVUID_BestPractices_RenderPass_RedundantStore, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 1931 | "%s %s: %s Subresource (arrayLayer: %u, mipLevel: %u) of image was cleared as part of LOAD_OP_CLEAR, but last time " |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1932 | "image was used, it was written to with STORE_OP_STORE. " |
| 1933 | "Storing to the image is probably redundant in this case, and wastes bandwidth on tile-based " |
| 1934 | "architectures.", |
LawG4 | 4d414ba | 2022-02-23 15:35:41 +0000 | [diff] [blame] | 1935 | function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level); |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 1936 | } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED && last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED) { |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1937 | LogPerformanceWarning( |
| 1938 | device, kVUID_BestPractices_RenderPass_RedundantClear, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 1939 | "%s %s: %s Subresource (arrayLayer: %u, mipLevel: %u) of image was cleared as part of LOAD_OP_CLEAR, but last time " |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1940 | "image was used, it was written to with vkCmdClear*Image(). " |
| 1941 | "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on " |
LawG4 | 4d414ba | 2022-02-23 15:35:41 +0000 | [diff] [blame] | 1942 | "tile-based architectures.", |
| 1943 | function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level); |
Hans-Kristian Arntzen | 44f9d86 | 2021-03-22 13:56:39 +0100 | [diff] [blame] | 1944 | } else if (usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE && |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1945 | (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::CLEARED || |
| 1946 | last_usage == IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE || last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE)) { |
Hans-Kristian Arntzen | 44f9d86 | 2021-03-22 13:56:39 +0100 | [diff] [blame] | 1947 | const char *last_cmd = nullptr; |
| 1948 | const char *vuid = nullptr; |
| 1949 | const char *suggestion = nullptr; |
| 1950 | |
| 1951 | switch (last_usage) { |
| 1952 | case IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE: |
| 1953 | vuid = kVUID_BestPractices_RenderPass_BlitImage_LoadOpLoad; |
| 1954 | last_cmd = "vkCmdBlitImage"; |
| 1955 | suggestion = |
| 1956 | "The blit is probably redundant in this case, and wastes bandwidth on tile-based architectures. " |
| 1957 | "Rather than blitting, just render the source image in a fragment shader in this render pass, " |
| 1958 | "which avoids the memory roundtrip."; |
| 1959 | break; |
| 1960 | case IMAGE_SUBRESOURCE_USAGE_BP::CLEARED: |
| 1961 | vuid = kVUID_BestPractices_RenderPass_InefficientClear; |
| 1962 | last_cmd = "vkCmdClear*Image"; |
| 1963 | suggestion = |
| 1964 | "Clearing the image with vkCmdClear*Image() is probably redundant in this case, and wastes bandwidth on " |
| 1965 | "tile-based architectures. " |
| 1966 | "Use LOAD_OP_CLEAR instead to clear the image for free."; |
| 1967 | break; |
| 1968 | case IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE: |
| 1969 | vuid = kVUID_BestPractices_RenderPass_CopyImage_LoadOpLoad; |
| 1970 | last_cmd = "vkCmdCopy*Image"; |
| 1971 | suggestion = |
| 1972 | "The copy is probably redundant in this case, and wastes bandwidth on tile-based architectures. " |
| 1973 | "Rather than copying, just render the source image in a fragment shader in this render pass, " |
| 1974 | "which avoids the memory roundtrip."; |
| 1975 | break; |
| 1976 | case IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE: |
| 1977 | vuid = kVUID_BestPractices_RenderPass_ResolveImage_LoadOpLoad; |
| 1978 | last_cmd = "vkCmdResolveImage"; |
| 1979 | suggestion = |
| 1980 | "The resolve is probably redundant in this case, and wastes a lot of bandwidth on tile-based architectures. " |
| 1981 | "Rather than resolving, and then loading, try to keep rendering in the same render pass, " |
| 1982 | "which avoids the memory roundtrip."; |
| 1983 | break; |
| 1984 | default: |
| 1985 | break; |
| 1986 | } |
| 1987 | |
| 1988 | LogPerformanceWarning( |
| 1989 | device, vuid, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 1990 | "%s %s: %s Subresource (arrayLayer: %u, mipLevel: %u) of image was loaded to tile as part of LOAD_OP_LOAD, but last " |
Hans-Kristian Arntzen | 44f9d86 | 2021-03-22 13:56:39 +0100 | [diff] [blame] | 1991 | "time image was used, it was written to with %s. %s", |
LawG4 | 4d414ba | 2022-02-23 15:35:41 +0000 | [diff] [blame] | 1992 | function_name, VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), array_layer, mip_level, last_cmd, |
| 1993 | suggestion); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1994 | } |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 1995 | } |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 1996 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 1997 | void BestPractices::ValidateImageInQueue(const char* function_name, bp_state::Image& state, IMAGE_SUBRESOURCE_USAGE_BP usage, |
| 1998 | uint32_t array_layer, uint32_t mip_level) { |
| 1999 | auto last_usage = state.UpdateUsage(array_layer, mip_level, usage); |
paul-lunarg | 5eb5206 | 2022-06-27 18:57:15 +0200 | [diff] [blame] | 2000 | |
| 2001 | // When image was discarded with StoreOpDontCare but is now being read with LoadOpLoad |
| 2002 | if (last_usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED && |
| 2003 | usage == IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE) { |
| 2004 | LogWarning(device, kVUID_BestPractices_StoreOpDontCareThenLoadOpLoad, |
| 2005 | "Trying to load an attachment with LOAD_OP_LOAD that was previously stored with STORE_OP_DONT_CARE. This may " |
| 2006 | "result in undefined behaviour."); |
| 2007 | } |
| 2008 | |
LawG4 | 4d414ba | 2022-02-23 15:35:41 +0000 | [diff] [blame] | 2009 | if (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) { |
| 2010 | ValidateImageInQueueArmImg(function_name, state, last_usage, usage, array_layer, mip_level); |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 2011 | } |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2012 | } |
| 2013 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2014 | void BestPractices::AddDeferredQueueOperations(bp_state::CommandBuffer& cb) { |
| 2015 | cb.queue_submit_functions.insert(cb.queue_submit_functions.end(), cb.queue_submit_functions_after_render_pass.begin(), |
| 2016 | cb.queue_submit_functions_after_render_pass.end()); |
| 2017 | cb.queue_submit_functions_after_render_pass.clear(); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2018 | } |
| 2019 | |
| 2020 | void BestPractices::PreCallRecordCmdEndRenderPass(VkCommandBuffer commandBuffer) { |
| 2021 | ValidationStateTracker::PreCallRecordCmdEndRenderPass(commandBuffer); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2022 | auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2023 | if (cb_node) { |
| 2024 | AddDeferredQueueOperations(*cb_node); |
| 2025 | } |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2026 | } |
| 2027 | |
| 2028 | void BestPractices::PreCallRecordCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo *pSubpassInfo) { |
| 2029 | ValidationStateTracker::PreCallRecordCmdEndRenderPass2(commandBuffer, pSubpassInfo); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2030 | auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2031 | if (cb_node) { |
| 2032 | AddDeferredQueueOperations(*cb_node); |
| 2033 | } |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2034 | } |
| 2035 | |
| 2036 | void BestPractices::PreCallRecordCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfoKHR *pSubpassInfo) { |
| 2037 | ValidationStateTracker::PreCallRecordCmdEndRenderPass2KHR(commandBuffer, pSubpassInfo); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2038 | auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2039 | if (cb_node) { |
| 2040 | AddDeferredQueueOperations(*cb_node); |
| 2041 | } |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2042 | } |
| 2043 | |
Hans-Kristian Arntzen | d9941a9 | 2021-06-18 12:31:30 +0200 | [diff] [blame] | 2044 | void BestPractices::PreCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, |
| 2045 | const VkRenderPassBeginInfo* pRenderPassBegin, |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2046 | VkSubpassContents contents) { |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2047 | ValidationStateTracker::PreCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents); |
Hans-Kristian Arntzen | d9941a9 | 2021-06-18 12:31:30 +0200 | [diff] [blame] | 2048 | RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin); |
| 2049 | } |
| 2050 | |
| 2051 | void BestPractices::PreCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, |
| 2052 | const VkRenderPassBeginInfo* pRenderPassBegin, |
| 2053 | const VkSubpassBeginInfo* pSubpassBeginInfo) { |
| 2054 | ValidationStateTracker::PreCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo); |
| 2055 | RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin); |
| 2056 | } |
| 2057 | |
| 2058 | void BestPractices::PreCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer, |
| 2059 | const VkRenderPassBeginInfo* pRenderPassBegin, |
| 2060 | const VkSubpassBeginInfo* pSubpassBeginInfo) { |
| 2061 | ValidationStateTracker::PreCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo); |
| 2062 | RecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin); |
| 2063 | } |
| 2064 | |
| 2065 | void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin) { |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2066 | |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2067 | if (!pRenderPassBegin) { |
| 2068 | return; |
| 2069 | } |
| 2070 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2071 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 2072 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2073 | auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2074 | if (rp_state) { |
| 2075 | // Check load ops |
| 2076 | for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 2077 | const auto& attachment = rp_state->createInfo.pAttachments[att]; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2078 | |
| 2079 | if (!RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att) && |
| 2080 | !RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) { |
| 2081 | continue; |
| 2082 | } |
| 2083 | |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 2084 | IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::UNDEFINED; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2085 | |
| 2086 | if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) || |
| 2087 | (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD)) { |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 2088 | usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_READ_TO_TILE; |
Hans-Kristian Arntzen | 5e56e55 | 2021-03-29 11:45:20 +0200 | [diff] [blame] | 2089 | } else if ((!FormatIsStencilOnly(attachment.format) && attachment.loadOp == VK_ATTACHMENT_LOAD_OP_CLEAR) || |
| 2090 | (FormatHasStencil(attachment.format) && attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_CLEAR)) { |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 2091 | usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_CLEARED; |
Hans-Kristian Arntzen | 5e56e55 | 2021-03-29 11:45:20 +0200 | [diff] [blame] | 2092 | } else if (RenderPassUsesAttachmentAsImageOnly(rp_state->createInfo, att)) { |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 2093 | usage = IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2094 | } |
| 2095 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2096 | auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer); |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 2097 | std::shared_ptr<IMAGE_VIEW_STATE> image_view = nullptr; |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2098 | |
Tony-LunarG | b3ab357 | 2021-07-02 09:45:17 -0600 | [diff] [blame] | 2099 | if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) { |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2100 | const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext); |
| 2101 | if (rpabi) { |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2102 | image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]); |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2103 | } |
| 2104 | } else { |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2105 | image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]); |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2106 | } |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2107 | |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 2108 | QueueValidateImageView(cb->queue_submit_functions, "vkCmdBeginRenderPass()", image_view.get(), usage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2109 | } |
| 2110 | |
| 2111 | // Check store ops |
| 2112 | for (uint32_t att = 0; att < rp_state->createInfo.attachmentCount; att++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 2113 | const auto& attachment = rp_state->createInfo.pAttachments[att]; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2114 | |
| 2115 | if (!RenderPassUsesAttachmentOnTile(rp_state->createInfo, att)) { |
| 2116 | continue; |
| 2117 | } |
| 2118 | |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 2119 | IMAGE_SUBRESOURCE_USAGE_BP usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_DISCARDED; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2120 | |
| 2121 | if ((!FormatIsStencilOnly(attachment.format) && attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE) || |
| 2122 | (FormatHasStencil(attachment.format) && attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) { |
Hans-Kristian Arntzen | 5b466db | 2021-03-18 13:59:46 +0100 | [diff] [blame] | 2123 | usage = IMAGE_SUBRESOURCE_USAGE_BP::RENDER_PASS_STORED; |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2124 | } |
| 2125 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2126 | auto framebuffer = Get<FRAMEBUFFER_STATE>(pRenderPassBegin->framebuffer); |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2127 | |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 2128 | std::shared_ptr<IMAGE_VIEW_STATE> image_view; |
Tony-LunarG | b3ab357 | 2021-07-02 09:45:17 -0600 | [diff] [blame] | 2129 | if (framebuffer->createInfo.flags & VK_FRAMEBUFFER_CREATE_IMAGELESS_BIT) { |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2130 | const VkRenderPassAttachmentBeginInfo* rpabi = LvlFindInChain<VkRenderPassAttachmentBeginInfo>(pRenderPassBegin->pNext); |
| 2131 | if (rpabi) { |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2132 | image_view = Get<IMAGE_VIEW_STATE>(rpabi->pAttachments[att]); |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2133 | } |
| 2134 | } else { |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 2135 | image_view = Get<IMAGE_VIEW_STATE>(framebuffer->createInfo.pAttachments[att]); |
Hans-Kristian Arntzen | 9710e14 | 2021-03-18 12:19:02 +0100 | [diff] [blame] | 2136 | } |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2137 | |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 2138 | QueueValidateImageView(cb->queue_submit_functions_after_render_pass, "vkCmdEndRenderPass()", image_view.get(), usage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2139 | } |
| 2140 | } |
| 2141 | } |
| 2142 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2143 | bool BestPractices::PreCallValidateCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin, |
| 2144 | VkSubpassContents contents) const { |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2145 | bool skip = StateTracker::PreCallValidateCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents); |
| 2146 | skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2147 | return skip; |
| 2148 | } |
| 2149 | |
| 2150 | bool BestPractices::PreCallValidateCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer, |
| 2151 | const VkRenderPassBeginInfo* pRenderPassBegin, |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 2152 | const VkSubpassBeginInfo* pSubpassBeginInfo) const { |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2153 | bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo); |
| 2154 | skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2155 | return skip; |
| 2156 | } |
| 2157 | |
| 2158 | bool BestPractices::PreCallValidateCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin, |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 2159 | const VkSubpassBeginInfo* pSubpassBeginInfo) const { |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2160 | bool skip = StateTracker::PreCallValidateCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo); |
| 2161 | skip |= ValidateCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2162 | return skip; |
| 2163 | } |
| 2164 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2165 | void BestPractices::RecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, RenderPassCreateVersion rp_version, |
| 2166 | const VkRenderPassBeginInfo* pRenderPassBegin) { |
Hans-Kristian Arntzen | a900f5d | 2021-06-14 15:09:31 +0200 | [diff] [blame] | 2167 | // Reset the renderpass state |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2168 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
sjfricke | 52defd4 | 2022-08-08 16:37:46 +0900 | [diff] [blame] | 2169 | // TODO - move this logic to the Render Pass state as cb->has_draw_cmd should stay true for lifetime of command buffer |
| 2170 | cb->has_draw_cmd = false; |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2171 | assert(cb); |
| 2172 | auto& render_pass_state = cb->render_pass_state; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2173 | render_pass_state.touchesAttachments.clear(); |
| 2174 | render_pass_state.earlyClearAttachments.clear(); |
Hans-Kristian Arntzen | a900f5d | 2021-06-14 15:09:31 +0200 | [diff] [blame] | 2175 | render_pass_state.numDrawCallsDepthOnly = 0; |
| 2176 | render_pass_state.numDrawCallsDepthEqualCompare = 0; |
| 2177 | render_pass_state.colorAttachment = false; |
| 2178 | render_pass_state.depthAttachment = false; |
Hans-Kristian Arntzen | 8abca1e | 2021-06-16 13:57:45 +0200 | [diff] [blame] | 2179 | render_pass_state.drawTouchAttachments = true; |
Hans-Kristian Arntzen | a900f5d | 2021-06-14 15:09:31 +0200 | [diff] [blame] | 2180 | // Don't reset state related to pipeline state. |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2181 | |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 2182 | auto rp_state = Get<RENDER_PASS_STATE>(pRenderPassBegin->renderPass); |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2183 | |
| 2184 | // track depth / color attachment usage within the renderpass |
| 2185 | for (size_t i = 0; i < rp_state->createInfo.subpassCount; i++) { |
| 2186 | // record if depth/color attachments are in use for this renderpass |
Hans-Kristian Arntzen | a900f5d | 2021-06-14 15:09:31 +0200 | [diff] [blame] | 2187 | if (rp_state->createInfo.pSubpasses[i].pDepthStencilAttachment != nullptr) render_pass_state.depthAttachment = true; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2188 | |
Hans-Kristian Arntzen | a900f5d | 2021-06-14 15:09:31 +0200 | [diff] [blame] | 2189 | if (rp_state->createInfo.pSubpasses[i].colorAttachmentCount > 0) render_pass_state.colorAttachment = true; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2190 | } |
| 2191 | } |
| 2192 | |
| 2193 | void BestPractices::PostCallRecordCmdBeginRenderPass(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin, |
| 2194 | VkSubpassContents contents) { |
| 2195 | StateTracker::PostCallRecordCmdBeginRenderPass(commandBuffer, pRenderPassBegin, contents); |
| 2196 | RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_1, pRenderPassBegin); |
| 2197 | } |
| 2198 | |
| 2199 | void BestPractices::PostCallRecordCmdBeginRenderPass2(VkCommandBuffer commandBuffer, const VkRenderPassBeginInfo* pRenderPassBegin, |
| 2200 | const VkSubpassBeginInfo* pSubpassBeginInfo) { |
| 2201 | StateTracker::PostCallRecordCmdBeginRenderPass2(commandBuffer, pRenderPassBegin, pSubpassBeginInfo); |
| 2202 | RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin); |
| 2203 | } |
| 2204 | |
| 2205 | void BestPractices::PostCallRecordCmdBeginRenderPass2KHR(VkCommandBuffer commandBuffer, |
| 2206 | const VkRenderPassBeginInfo* pRenderPassBegin, |
| 2207 | const VkSubpassBeginInfo* pSubpassBeginInfo) { |
| 2208 | StateTracker::PostCallRecordCmdBeginRenderPass2KHR(commandBuffer, pRenderPassBegin, pSubpassBeginInfo); |
| 2209 | RecordCmdBeginRenderPass(commandBuffer, RENDER_PASS_VERSION_2, pRenderPassBegin); |
| 2210 | } |
| 2211 | |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2212 | // Generic function to handle validation for all CmdDraw* type functions |
| 2213 | bool BestPractices::ValidateCmdDrawType(VkCommandBuffer cmd_buffer, const char* caller) const { |
| 2214 | bool skip = false; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2215 | const auto cb_state = GetRead<bp_state::CommandBuffer>(cmd_buffer); |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2216 | if (cb_state) { |
locke-lunarg | b8d7a7a | 2020-10-25 16:01:52 -0600 | [diff] [blame] | 2217 | const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS); |
| 2218 | const auto* pipeline_state = cb_state->lastBound[lv_bind_point].pipeline_state; |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2219 | const auto& current_vtx_bfr_binding_info = cb_state->current_vertex_buffer_binding_info.vertex_buffer_bindings; |
locke-lunarg | b8d7a7a | 2020-10-25 16:01:52 -0600 | [diff] [blame] | 2220 | |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2221 | // Verify vertex binding |
Tony-LunarG | 2ffe1f5 | 2022-04-11 15:13:30 -0600 | [diff] [blame] | 2222 | if (pipeline_state && pipeline_state->vertex_input_state && |
| 2223 | pipeline_state->vertex_input_state->binding_descriptions.size() <= 0) { |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2224 | if ((!current_vtx_bfr_binding_info.empty()) && (!cb_state->vertex_buffer_used)) { |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 2225 | skip |= LogPerformanceWarning(cb_state->commandBuffer(), kVUID_BestPractices_DrawState_VtxIndexOutOfBounds, |
Mark Lobodzinski | f95a266 | 2020-01-29 15:43:32 -0700 | [diff] [blame] | 2226 | "Vertex buffers are bound to %s but no vertex buffers are attached to %s.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 2227 | report_data->FormatHandle(cb_state->commandBuffer()).c_str(), |
| 2228 | report_data->FormatHandle(pipeline_state->pipeline()).c_str()); |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2229 | } |
| 2230 | } |
Nathaniel Cesario | f7b732a | 2021-06-03 14:08:27 -0600 | [diff] [blame] | 2231 | |
Jeremy Gebben | 159b3cc | 2021-06-03 09:09:03 -0600 | [diff] [blame] | 2232 | const auto* pipe = cb_state->GetCurrentPipeline(VK_PIPELINE_BIND_POINT_GRAPHICS); |
Nathaniel Cesario | f7b732a | 2021-06-03 14:08:27 -0600 | [diff] [blame] | 2233 | if (pipe) { |
Nathaniel Cesario | 3fd4f76 | 2022-02-16 16:07:06 -0700 | [diff] [blame] | 2234 | const auto& rp_state = pipe->RenderPassState(); |
Nathaniel Cesario | f7b732a | 2021-06-03 14:08:27 -0600 | [diff] [blame] | 2235 | if (rp_state) { |
| 2236 | for (uint32_t i = 0; i < rp_state->createInfo.subpassCount; ++i) { |
| 2237 | const auto& subpass = rp_state->createInfo.pSubpasses[i]; |
Nathaniel Cesario | 3fd4f76 | 2022-02-16 16:07:06 -0700 | [diff] [blame] | 2238 | const auto* ds_state = pipe->DepthStencilState(); |
Jeremy Gebben | 11af979 | 2021-08-20 10:20:09 -0600 | [diff] [blame] | 2239 | const uint32_t depth_stencil_attachment = |
Nathaniel Cesario | 3fd4f76 | 2022-02-16 16:07:06 -0700 | [diff] [blame] | 2240 | GetSubpassDepthStencilAttachmentIndex(ds_state, subpass.pDepthStencilAttachment); |
| 2241 | const auto* raster_state = pipe->RasterizationState(); |
| 2242 | if ((depth_stencil_attachment == VK_ATTACHMENT_UNUSED) && raster_state && |
| 2243 | raster_state->depthBiasEnable == VK_TRUE) { |
Nathaniel Cesario | f7b732a | 2021-06-03 14:08:27 -0600 | [diff] [blame] | 2244 | skip |= LogWarning(cb_state->commandBuffer(), kVUID_BestPractices_DepthBiasNoAttachment, |
| 2245 | "%s: depthBiasEnable == VK_TRUE without a depth-stencil attachment.", caller); |
| 2246 | } |
| 2247 | } |
| 2248 | } |
| 2249 | } |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2250 | } |
| 2251 | return skip; |
| 2252 | } |
| 2253 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2254 | void BestPractices::RecordCmdDrawType(VkCommandBuffer cmd_buffer, uint32_t draw_count, const char* caller) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2255 | auto cb_node = GetWrite<bp_state::CommandBuffer>(cmd_buffer); |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2256 | assert(cb_node); |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2257 | if (VendorCheckEnabled(kBPVendorArm)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2258 | RecordCmdDrawTypeArm(*cb_node, draw_count, caller); |
Hans-Kristian Arntzen | 8abca1e | 2021-06-16 13:57:45 +0200 | [diff] [blame] | 2259 | } |
| 2260 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2261 | if (cb_node->render_pass_state.drawTouchAttachments) { |
| 2262 | for (auto& touch : cb_node->render_pass_state.nextDrawTouchesAttachments) { |
| 2263 | RecordAttachmentAccess(*cb_node, touch.framebufferAttachment, touch.aspects); |
Hans-Kristian Arntzen | 8abca1e | 2021-06-16 13:57:45 +0200 | [diff] [blame] | 2264 | } |
| 2265 | // No need to touch the same attachments over and over. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2266 | cb_node->render_pass_state.drawTouchAttachments = false; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2267 | } |
| 2268 | } |
| 2269 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2270 | void BestPractices::RecordCmdDrawTypeArm(bp_state::CommandBuffer& cb_node, uint32_t draw_count, const char* caller) { |
| 2271 | auto& render_pass_state = cb_node.render_pass_state; |
LawG4 | b21485c | 2022-02-28 13:46:48 +0000 | [diff] [blame] | 2272 | // Each TBDR vendor requires a depth pre-pass draw call to have a minimum number of vertices/indices before it counts towards |
| 2273 | // depth prepass warnings First find the lowest enabled draw count |
| 2274 | uint32_t lowestEnabledMinDrawCount = 0; |
| 2275 | lowestEnabledMinDrawCount = VendorCheckEnabled(kBPVendorArm) * kDepthPrePassMinDrawCountArm; |
| 2276 | if (VendorCheckEnabled(kBPVendorIMG) && kDepthPrePassMinDrawCountIMG < lowestEnabledMinDrawCount) |
| 2277 | lowestEnabledMinDrawCount = kDepthPrePassMinDrawCountIMG; |
| 2278 | |
| 2279 | if (draw_count >= lowestEnabledMinDrawCount) { |
Hans-Kristian Arntzen | 8abca1e | 2021-06-16 13:57:45 +0200 | [diff] [blame] | 2280 | if (render_pass_state.depthOnly) render_pass_state.numDrawCallsDepthOnly++; |
| 2281 | if (render_pass_state.depthEqualComparison) render_pass_state.numDrawCallsDepthEqualCompare++; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2282 | } |
| 2283 | } |
| 2284 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2285 | bool BestPractices::PreCallValidateCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 2286 | uint32_t firstVertex, uint32_t firstInstance) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2287 | bool skip = false; |
| 2288 | |
| 2289 | if (instanceCount == 0) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 2290 | skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero, |
| 2291 | "Warning: You are calling vkCmdDraw() with an instanceCount of Zero."); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2292 | } |
Nathaniel Cesario | f7b732a | 2021-06-03 14:08:27 -0600 | [diff] [blame] | 2293 | skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDraw()"); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2294 | |
| 2295 | return skip; |
| 2296 | } |
| 2297 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2298 | void BestPractices::PostCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount, |
| 2299 | uint32_t firstVertex, uint32_t firstInstance) { |
| 2300 | StateTracker::PostCallRecordCmdDraw(commandBuffer, vertexCount, instanceCount, firstVertex, firstInstance); |
| 2301 | RecordCmdDrawType(commandBuffer, vertexCount * instanceCount, "vkCmdDraw()"); |
| 2302 | } |
| 2303 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2304 | bool BestPractices::PreCallValidateCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 2305 | uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2306 | bool skip = false; |
| 2307 | |
| 2308 | if (instanceCount == 0) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 2309 | skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_InstanceCountZero, |
| 2310 | "Warning: You are calling vkCmdDrawIndexed() with an instanceCount of Zero."); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2311 | } |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2312 | skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexed()"); |
| 2313 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2314 | // Check if we reached the limit for small indexed draw calls. |
| 2315 | // Note that we cannot update the draw call count here, so we do it in PreCallRecordCmdDrawIndexed. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2316 | const auto cmd_state = GetRead<bp_state::CommandBuffer>(commandBuffer); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2317 | if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices && |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 2318 | (cmd_state->small_indexed_draw_call_count == kMaxSmallIndexedDrawcalls - 1) && |
LawG4 | ff42d72 | 2022-03-01 10:28:25 +0000 | [diff] [blame] | 2319 | (VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG))) { |
Hans-Kristian Arntzen | b214795 | 2021-04-28 14:32:00 +0200 | [diff] [blame] | 2320 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_ManySmallIndexedDrawcalls, |
LawG4 | ff42d72 | 2022-03-01 10:28:25 +0000 | [diff] [blame] | 2321 | "%s %s: The command buffer contains many small indexed drawcalls " |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2322 | "(at least %u drawcalls with less than %u indices each). This may cause pipeline bubbles. " |
| 2323 | "You can try batching drawcalls or instancing when applicable.", |
LawG4 | ff42d72 | 2022-03-01 10:28:25 +0000 | [diff] [blame] | 2324 | VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), kMaxSmallIndexedDrawcalls, |
| 2325 | kSmallIndexedDrawcallIndices); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2326 | } |
| 2327 | |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2328 | if (VendorCheckEnabled(kBPVendorArm)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2329 | ValidateIndexBufferArm(*cmd_state, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2330 | } |
| 2331 | |
| 2332 | return skip; |
| 2333 | } |
| 2334 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2335 | bool BestPractices::ValidateIndexBufferArm(const bp_state::CommandBuffer& cmd_state, uint32_t indexCount, uint32_t instanceCount, |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2336 | uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) const { |
| 2337 | bool skip = false; |
| 2338 | |
| 2339 | // check for sparse/underutilised index buffer, and post-transform cache thrashing |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2340 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2341 | const auto* ib_state = cmd_state.index_buffer_binding.buffer_state.get(); |
| 2342 | if (ib_state == nullptr || cmd_state.index_buffer_binding.buffer_state->Destroyed()) return skip; |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2343 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2344 | const VkIndexType ib_type = cmd_state.index_buffer_binding.index_type; |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 2345 | const auto& ib_mem_state = *ib_state->MemState(); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2346 | const VkDeviceSize ib_mem_offset = ib_mem_state.mapped_range.offset; |
| 2347 | const void* ib_mem = ib_mem_state.p_driver_data; |
| 2348 | bool primitive_restart_enable = false; |
| 2349 | |
locke-lunarg | b8d7a7a | 2020-10-25 16:01:52 -0600 | [diff] [blame] | 2350 | const auto lv_bind_point = ConvertToLvlBindPoint(VK_PIPELINE_BIND_POINT_GRAPHICS); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2351 | const auto& pipeline_binding_iter = cmd_state.lastBound[lv_bind_point]; |
locke-lunarg | b8d7a7a | 2020-10-25 16:01:52 -0600 | [diff] [blame] | 2352 | const auto* pipeline_state = pipeline_binding_iter.pipeline_state; |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2353 | |
Nathaniel Cesario | 3fd4f76 | 2022-02-16 16:07:06 -0700 | [diff] [blame] | 2354 | const auto* ia_state = pipeline_state ? pipeline_state->InputAssemblyState() : nullptr; |
| 2355 | if (ia_state) { |
| 2356 | primitive_restart_enable = ia_state->primitiveRestartEnable == VK_TRUE; |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 2357 | } |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2358 | |
| 2359 | // no point checking index buffer if the memory is nonexistant/unmapped, or if there is no graphics pipeline bound to this CB |
locke-lunarg | b8d7a7a | 2020-10-25 16:01:52 -0600 | [diff] [blame] | 2360 | if (ib_mem && pipeline_binding_iter.IsUsing()) { |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2361 | uint32_t scan_stride; |
| 2362 | if (ib_type == VK_INDEX_TYPE_UINT8_EXT) { |
| 2363 | scan_stride = sizeof(uint8_t); |
| 2364 | } else if (ib_type == VK_INDEX_TYPE_UINT16) { |
| 2365 | scan_stride = sizeof(uint16_t); |
| 2366 | } else { |
| 2367 | scan_stride = sizeof(uint32_t); |
| 2368 | } |
| 2369 | |
| 2370 | const uint8_t* scan_begin = static_cast<const uint8_t*>(ib_mem) + ib_mem_offset + firstIndex * scan_stride; |
| 2371 | const uint8_t* scan_end = scan_begin + indexCount * scan_stride; |
| 2372 | |
| 2373 | // Min and max are important to track for some Mali architectures. In older Mali devices without IDVS, all |
| 2374 | // vertices corresponding to indices between the minimum and maximum may be loaded, and possibly shaded, |
| 2375 | // irrespective of whether or not they're part of the draw call. |
| 2376 | |
| 2377 | // start with minimum as 0xFFFFFFFF and adjust to indices in the buffer |
| 2378 | uint32_t min_index = ~0u; |
| 2379 | // start with maximum as 0 and adjust to indices in the buffer |
| 2380 | uint32_t max_index = 0u; |
| 2381 | |
| 2382 | // first scan-through, we're looking to simulate a model LRU post-transform cache, estimating the number of vertices shaded |
| 2383 | // for the given index buffer |
| 2384 | uint32_t vertex_shade_count = 0; |
| 2385 | |
| 2386 | PostTransformLRUCacheModel post_transform_cache; |
| 2387 | |
| 2388 | // The size of the cache being modelled positively correlates with how much behaviour it can capture about |
| 2389 | // arbitrary ground-truth hardware/architecture cache behaviour. I.e. it's a good solution when we don't know the |
| 2390 | // target architecture. |
| 2391 | // However, modelling a post-transform cache with more than 32 elements gives diminishing returns in practice. |
| 2392 | // http://eelpi.gotdns.org/papers/fast_vert_cache_opt.html |
| 2393 | post_transform_cache.resize(32); |
| 2394 | |
| 2395 | for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) { |
| 2396 | uint32_t scan_index; |
| 2397 | uint32_t primitive_restart_value; |
| 2398 | if (ib_type == VK_INDEX_TYPE_UINT8_EXT) { |
| 2399 | scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr); |
| 2400 | primitive_restart_value = 0xFF; |
| 2401 | } else if (ib_type == VK_INDEX_TYPE_UINT16) { |
| 2402 | scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr); |
| 2403 | primitive_restart_value = 0xFFFF; |
| 2404 | } else { |
| 2405 | scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr); |
| 2406 | primitive_restart_value = 0xFFFFFFFF; |
| 2407 | } |
| 2408 | |
| 2409 | max_index = std::max(max_index, scan_index); |
| 2410 | min_index = std::min(min_index, scan_index); |
| 2411 | |
| 2412 | if (!primitive_restart_enable || scan_index != primitive_restart_value) { |
| 2413 | bool in_cache = post_transform_cache.query_cache(scan_index); |
| 2414 | // if the shaded vertex corresponding to the index is not in the PT-cache, we need to shade again |
| 2415 | if (!in_cache) vertex_shade_count++; |
| 2416 | } |
| 2417 | } |
| 2418 | |
| 2419 | // if the max and min values were not set, then we either have no indices, or all primitive restarts, exit... |
Sam Walls | 61b0689 | 2020-07-23 16:20:50 +0100 | [diff] [blame] | 2420 | // 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 |
| 2421 | if (max_index < min_index || max_index == min_index) return skip; |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2422 | |
| 2423 | if (max_index - min_index >= indexCount) { |
Mark Young | 0ec6b06 | 2020-11-19 15:32:17 -0700 | [diff] [blame] | 2424 | skip |= |
| 2425 | LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer, |
| 2426 | "%s The indices which were specified for the draw call only utilise approximately %.02f%% of " |
| 2427 | "index buffer value range. Arm Mali architectures before G71 do not have IDVS (Index-Driven " |
| 2428 | "Vertex Shading), meaning all vertices corresponding to indices between the minimum and " |
| 2429 | "maximum would be loaded, and possibly shaded, whether or not they are used.", |
| 2430 | VendorSpecificTag(kBPVendorArm), |
| 2431 | (static_cast<float>(indexCount) / static_cast<float>(max_index - min_index)) * 100.0f); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2432 | return skip; |
| 2433 | } |
| 2434 | |
| 2435 | // use a dynamic vector of bitsets as a memory-compact representation of which indices are included in the draw call |
| 2436 | // each bit of the n-th bucket contains the inclusion information for indices (n*n_buckets) to ((n+1)*n_buckets) |
Sam Walls | 61b0689 | 2020-07-23 16:20:50 +0100 | [diff] [blame] | 2437 | const size_t refs_per_bucket = 64; |
| 2438 | std::vector<std::bitset<refs_per_bucket>> vertex_reference_buckets; |
| 2439 | |
| 2440 | const uint32_t n_indices = max_index - min_index + 1; |
| 2441 | const uint32_t n_buckets = (n_indices / static_cast<uint32_t>(refs_per_bucket)) + |
| 2442 | ((n_indices % static_cast<uint32_t>(refs_per_bucket)) != 0 ? 1 : 0); |
| 2443 | |
| 2444 | // there needs to be at least one bitset to store a set of indices smaller than n_buckets |
| 2445 | vertex_reference_buckets.resize(std::max(1u, n_buckets)); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2446 | |
| 2447 | // To avoid using too much memory, we run over the indices again. |
| 2448 | // Knowing the size from the last scan allows us to record index usage with bitsets |
| 2449 | for (const uint8_t* scan_ptr = scan_begin; scan_ptr < scan_end; scan_ptr += scan_stride) { |
| 2450 | uint32_t scan_index; |
| 2451 | if (ib_type == VK_INDEX_TYPE_UINT8_EXT) { |
| 2452 | scan_index = *reinterpret_cast<const uint8_t*>(scan_ptr); |
| 2453 | } else if (ib_type == VK_INDEX_TYPE_UINT16) { |
| 2454 | scan_index = *reinterpret_cast<const uint16_t*>(scan_ptr); |
| 2455 | } else { |
| 2456 | scan_index = *reinterpret_cast<const uint32_t*>(scan_ptr); |
| 2457 | } |
| 2458 | // keep track of the set of all indices used to reference vertices in the draw call |
| 2459 | size_t index_offset = scan_index - min_index; |
Sam Walls | 61b0689 | 2020-07-23 16:20:50 +0100 | [diff] [blame] | 2460 | size_t bitset_bucket_index = index_offset / refs_per_bucket; |
| 2461 | uint64_t used_indices = 1ull << ((index_offset % refs_per_bucket) & 0xFFFFFFFFu); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2462 | vertex_reference_buckets[bitset_bucket_index] |= used_indices; |
| 2463 | } |
| 2464 | |
| 2465 | uint32_t vertex_reference_count = 0; |
| 2466 | for (const auto& bitset : vertex_reference_buckets) { |
| 2467 | vertex_reference_count += static_cast<uint32_t>(bitset.count()); |
| 2468 | } |
| 2469 | |
| 2470 | // low index buffer utilization implies that: of the vertices available to the draw call, not all are utilized |
Mark Young | 0ec6b06 | 2020-11-19 15:32:17 -0700 | [diff] [blame] | 2471 | float utilization = static_cast<float>(vertex_reference_count) / static_cast<float>(max_index - min_index + 1); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2472 | // low hit rate (high miss rate) implies the order of indices in the draw call may be possible to improve |
Mark Young | 0ec6b06 | 2020-11-19 15:32:17 -0700 | [diff] [blame] | 2473 | float cache_hit_rate = static_cast<float>(vertex_reference_count) / static_cast<float>(vertex_shade_count); |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 2474 | |
| 2475 | if (utilization < 0.5f) { |
| 2476 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_SparseIndexBuffer, |
| 2477 | "%s The indices which were specified for the draw call only utilise approximately " |
| 2478 | "%.02f%% of the bound vertex buffer.", |
| 2479 | VendorSpecificTag(kBPVendorArm), utilization); |
| 2480 | } |
| 2481 | |
| 2482 | if (cache_hit_rate <= 0.5f) { |
| 2483 | skip |= |
| 2484 | LogPerformanceWarning(device, kVUID_BestPractices_CmdDrawIndexed_PostTransformCacheThrashing, |
| 2485 | "%s The indices which were specified for the draw call are estimated to cause thrashing of " |
| 2486 | "the post-transform vertex cache, with a hit-rate of %.02f%%. " |
| 2487 | "I.e. the ordering of the index buffer may not make optimal use of indices associated with " |
| 2488 | "recently shaded vertices.", |
| 2489 | VendorSpecificTag(kBPVendorArm), cache_hit_rate * 100.0f); |
| 2490 | } |
| 2491 | } |
| 2492 | |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2493 | return skip; |
| 2494 | } |
| 2495 | |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2496 | bool BestPractices::PreCallValidateCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount, |
| 2497 | const VkCommandBuffer* pCommandBuffers) const { |
| 2498 | bool skip = false; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2499 | const auto primary = GetRead<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2500 | for (uint32_t i = 0; i < commandBufferCount; i++) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2501 | const auto secondary_cb = GetRead<bp_state::CommandBuffer>(pCommandBuffers[i]); |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2502 | if (secondary_cb == nullptr) { |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2503 | continue; |
| 2504 | } |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2505 | const auto& secondary = secondary_cb->render_pass_state; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2506 | for (auto& clear : secondary.earlyClearAttachments) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2507 | if (ClearAttachmentsIsFullClear(*primary, uint32_t(clear.rects.size()), clear.rects.data())) { |
| 2508 | skip |= ValidateClearAttachment(*primary, clear.framebufferAttachment, clear.colorAttachment, clear.aspects, true); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2509 | } |
| 2510 | } |
| 2511 | } |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 2512 | |
| 2513 | if (VendorCheckEnabled(kBPVendorAMD)) { |
| 2514 | if (commandBufferCount > 0) { |
| 2515 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CmdBuffer_AvoidSecondaryCmdBuffers, |
| 2516 | "%s Performance warning: Use of secondary command buffers is not recommended. ", |
| 2517 | VendorSpecificTag(kBPVendorAMD)); |
| 2518 | } |
| 2519 | } |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2520 | return skip; |
| 2521 | } |
| 2522 | |
| 2523 | void BestPractices::PreCallRecordCmdExecuteCommands(VkCommandBuffer commandBuffer, uint32_t commandBufferCount, |
| 2524 | const VkCommandBuffer* pCommandBuffers) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2525 | ValidationStateTracker::PreCallRecordCmdExecuteCommands(commandBuffer, commandBufferCount, pCommandBuffers); |
| 2526 | |
| 2527 | auto primary = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2528 | if (!primary) { |
| 2529 | return; |
| 2530 | } |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2531 | |
| 2532 | for (uint32_t i = 0; i < commandBufferCount; i++) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2533 | auto secondary = GetWrite<bp_state::CommandBuffer>(pCommandBuffers[i]); |
| 2534 | if (!secondary) { |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2535 | continue; |
| 2536 | } |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2537 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2538 | for (auto& early_clear : secondary->render_pass_state.earlyClearAttachments) { |
| 2539 | if (ClearAttachmentsIsFullClear(*primary, uint32_t(early_clear.rects.size()), early_clear.rects.data())) { |
| 2540 | RecordAttachmentClearAttachments(*primary, early_clear.framebufferAttachment, early_clear.colorAttachment, |
| 2541 | early_clear.aspects, uint32_t(early_clear.rects.size()), early_clear.rects.data()); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2542 | } else { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2543 | RecordAttachmentAccess(*primary, early_clear.framebufferAttachment, early_clear.aspects); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2544 | } |
| 2545 | } |
| 2546 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2547 | for (auto& touch : secondary->render_pass_state.touchesAttachments) { |
| 2548 | RecordAttachmentAccess(*primary, touch.framebufferAttachment, touch.aspects); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2549 | } |
Hans-Kristian Arntzen | c7eb82a | 2021-06-16 13:57:18 +0200 | [diff] [blame] | 2550 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2551 | primary->render_pass_state.numDrawCallsDepthEqualCompare += secondary->render_pass_state.numDrawCallsDepthEqualCompare; |
| 2552 | primary->render_pass_state.numDrawCallsDepthOnly += secondary->render_pass_state.numDrawCallsDepthOnly; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2553 | } |
| 2554 | |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2555 | } |
| 2556 | |
Rodrigo Locatti | 7d716e1 | 2022-03-09 19:15:17 -0300 | [diff] [blame] | 2557 | bool BestPractices::PreCallValidateCmdBuildAccelerationStructureNV(VkCommandBuffer commandBuffer, |
| 2558 | const VkAccelerationStructureInfoNV* pInfo, |
| 2559 | VkBuffer instanceData, VkDeviceSize instanceOffset, |
| 2560 | VkBool32 update, VkAccelerationStructureNV dst, |
| 2561 | VkAccelerationStructureNV src, VkBuffer scratch, |
| 2562 | VkDeviceSize scratchOffset) const { |
| 2563 | return ValidateBuildAccelerationStructure(commandBuffer); |
| 2564 | } |
| 2565 | |
| 2566 | bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresIndirectKHR( |
| 2567 | VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos, |
| 2568 | const VkDeviceAddress* pIndirectDeviceAddresses, const uint32_t* pIndirectStrides, |
| 2569 | const uint32_t* const* ppMaxPrimitiveCounts) const { |
| 2570 | return ValidateBuildAccelerationStructure(commandBuffer); |
| 2571 | } |
| 2572 | |
| 2573 | bool BestPractices::PreCallValidateCmdBuildAccelerationStructuresKHR( |
| 2574 | VkCommandBuffer commandBuffer, uint32_t infoCount, const VkAccelerationStructureBuildGeometryInfoKHR* pInfos, |
| 2575 | const VkAccelerationStructureBuildRangeInfoKHR* const* ppBuildRangeInfos) const { |
| 2576 | return ValidateBuildAccelerationStructure(commandBuffer); |
| 2577 | } |
| 2578 | |
| 2579 | bool BestPractices::ValidateBuildAccelerationStructure(VkCommandBuffer commandBuffer) const { |
| 2580 | bool skip = false; |
| 2581 | auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer); |
| 2582 | assert(cb_node); |
| 2583 | |
| 2584 | if (VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 2585 | if ((cb_node->GetQueueFlags() & VK_QUEUE_GRAPHICS_BIT) != 0) { |
| 2586 | skip |= LogPerformanceWarning(commandBuffer, kVUID_BestPractices_AccelerationStructure_NotAsync, |
| 2587 | "%s Performance warning: Prefer building acceleration structures on an asynchronous " |
| 2588 | "compute queue, instead of using the universal graphics queue.", |
| 2589 | VendorSpecificTag(kBPVendorNVIDIA)); |
| 2590 | } |
| 2591 | } |
| 2592 | |
| 2593 | return skip; |
| 2594 | } |
| 2595 | |
Rodrigo Locatti | 66b2335 | 2022-03-15 17:28:32 -0300 | [diff] [blame] | 2596 | bool BestPractices::ValidateBindMemory(VkDevice device, VkDeviceMemory memory) const { |
| 2597 | bool skip = false; |
| 2598 | |
| 2599 | if (VendorCheckEnabled(kBPVendorNVIDIA) && device_extensions.vk_ext_pageable_device_local_memory) { |
| 2600 | auto mem_info = std::static_pointer_cast<const bp_state::DeviceMemory>(Get<DEVICE_MEMORY_STATE>(memory)); |
| 2601 | if (!mem_info->dynamic_priority) { |
| 2602 | skip |= |
| 2603 | LogPerformanceWarning(device, kVUID_BestPractices_BindMemory_NoPriority, |
| 2604 | "%s Use vkSetDeviceMemoryPriorityEXT to provide the OS with information on which allocations " |
| 2605 | "should stay in memory and which should be demoted first when video memory is limited. The " |
| 2606 | "highest priority should be given to GPU-written resources like color attachments, depth " |
| 2607 | "attachments, storage images, and buffers written from the GPU.", |
| 2608 | VendorSpecificTag(kBPVendorNVIDIA)); |
| 2609 | } |
| 2610 | } |
| 2611 | |
| 2612 | return skip; |
| 2613 | } |
| 2614 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2615 | void BestPractices::RecordAttachmentAccess(bp_state::CommandBuffer& cb_state, uint32_t fb_attachment, VkImageAspectFlags aspects) { |
| 2616 | auto& state = cb_state.render_pass_state; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2617 | // Called when we have a partial clear attachment, or a normal draw call which accesses an attachment. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2618 | auto itr = |
| 2619 | std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(), |
| 2620 | [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; }); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2621 | |
| 2622 | if (itr != state.touchesAttachments.end()) { |
| 2623 | itr->aspects |= aspects; |
| 2624 | } else { |
| 2625 | state.touchesAttachments.push_back({ fb_attachment, aspects }); |
| 2626 | } |
| 2627 | } |
| 2628 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2629 | void BestPractices::RecordAttachmentClearAttachments(bp_state::CommandBuffer& cmd_state, uint32_t fb_attachment, |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2630 | uint32_t color_attachment, VkImageAspectFlags aspects, uint32_t rectCount, |
| 2631 | const VkClearRect* pRects) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2632 | auto& state = cmd_state.render_pass_state; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2633 | // If we observe a full clear before any other access to a frame buffer attachment, |
| 2634 | // we have candidate for redundant clear attachments. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2635 | auto itr = |
| 2636 | std::find_if(state.touchesAttachments.begin(), state.touchesAttachments.end(), |
| 2637 | [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; }); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2638 | |
| 2639 | uint32_t new_aspects = aspects; |
| 2640 | if (itr != state.touchesAttachments.end()) { |
| 2641 | new_aspects = aspects & ~itr->aspects; |
| 2642 | itr->aspects |= aspects; |
| 2643 | } else { |
| 2644 | state.touchesAttachments.push_back({ fb_attachment, aspects }); |
| 2645 | } |
| 2646 | |
| 2647 | if (new_aspects == 0) { |
| 2648 | return; |
| 2649 | } |
| 2650 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2651 | if (cmd_state.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) { |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2652 | // The first command might be a clear, but might not be the first in the render pass, defer any checks until |
| 2653 | // CmdExecuteCommands. |
| 2654 | state.earlyClearAttachments.push_back({ fb_attachment, color_attachment, new_aspects, |
| 2655 | std::vector<VkClearRect>{pRects, pRects + rectCount} }); |
| 2656 | } |
| 2657 | } |
| 2658 | |
| 2659 | void BestPractices::PreCallRecordCmdClearAttachments(VkCommandBuffer commandBuffer, |
| 2660 | uint32_t attachmentCount, const VkClearAttachment* pClearAttachments, |
| 2661 | uint32_t rectCount, const VkClearRect* pRects) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2662 | ValidationStateTracker::PreCallRecordCmdClearAttachments(commandBuffer, attachmentCount, pClearAttachments, rectCount, pRects); |
| 2663 | |
| 2664 | auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2665 | auto* rp_state = cmd_state->activeRenderPass.get(); |
| 2666 | auto* fb_state = cmd_state->activeFramebuffer.get(); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2667 | bool is_secondary = cmd_state->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY; |
| 2668 | |
| 2669 | if (rectCount == 0 || !rp_state) { |
| 2670 | return; |
| 2671 | } |
| 2672 | |
| 2673 | if (!is_secondary && !fb_state) { |
| 2674 | return; |
| 2675 | } |
| 2676 | |
| 2677 | // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2678 | bool full_clear = ClearAttachmentsIsFullClear(*cmd_state, rectCount, pRects); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2679 | |
Jeremy Gebben | b5dda54 | 2022-08-02 14:26:20 -0600 | [diff] [blame] | 2680 | if (!rp_state->UsesDynamicRendering()) { |
ziga-lunarg | 885c654 | 2022-03-07 01:08:25 +0100 | [diff] [blame] | 2681 | auto& subpass = rp_state->createInfo.pSubpasses[cmd_state->activeSubpass]; |
| 2682 | for (uint32_t i = 0; i < attachmentCount; i++) { |
| 2683 | auto& attachment = pClearAttachments[i]; |
| 2684 | uint32_t fb_attachment = VK_ATTACHMENT_UNUSED; |
| 2685 | VkImageAspectFlags aspects = attachment.aspectMask; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2686 | |
ziga-lunarg | 885c654 | 2022-03-07 01:08:25 +0100 | [diff] [blame] | 2687 | if (aspects & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) { |
| 2688 | if (subpass.pDepthStencilAttachment) { |
| 2689 | fb_attachment = subpass.pDepthStencilAttachment->attachment; |
| 2690 | } |
| 2691 | } else if (aspects & VK_IMAGE_ASPECT_COLOR_BIT) { |
| 2692 | fb_attachment = subpass.pColorAttachments[attachment.colorAttachment].attachment; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2693 | } |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2694 | |
ziga-lunarg | 885c654 | 2022-03-07 01:08:25 +0100 | [diff] [blame] | 2695 | if (fb_attachment != VK_ATTACHMENT_UNUSED) { |
| 2696 | if (full_clear) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2697 | RecordAttachmentClearAttachments(*cmd_state, fb_attachment, attachment.colorAttachment, |
ziga-lunarg | 885c654 | 2022-03-07 01:08:25 +0100 | [diff] [blame] | 2698 | aspects, rectCount, pRects); |
| 2699 | } else { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2700 | RecordAttachmentAccess(*cmd_state, fb_attachment, aspects); |
ziga-lunarg | 885c654 | 2022-03-07 01:08:25 +0100 | [diff] [blame] | 2701 | } |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2702 | } |
| 2703 | } |
| 2704 | } |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 2705 | } |
| 2706 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2707 | void BestPractices::PreCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount, |
| 2708 | uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) { |
| 2709 | ValidationStateTracker::PreCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, |
| 2710 | firstInstance); |
| 2711 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2712 | auto cmd_state = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2713 | if ((indexCount * instanceCount) <= kSmallIndexedDrawcallIndices) { |
| 2714 | cmd_state->small_indexed_draw_call_count++; |
| 2715 | } |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2716 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2717 | ValidateBoundDescriptorSets(*cmd_state, "vkCmdDrawIndexed()"); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 2718 | } |
| 2719 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2720 | void BestPractices::PostCallRecordCmdDrawIndexed(VkCommandBuffer commandBuffer, uint32_t indexCount, uint32_t instanceCount, |
| 2721 | uint32_t firstIndex, int32_t vertexOffset, uint32_t firstInstance) { |
| 2722 | StateTracker::PostCallRecordCmdDrawIndexed(commandBuffer, indexCount, instanceCount, firstIndex, vertexOffset, firstInstance); |
| 2723 | RecordCmdDrawType(commandBuffer, indexCount * instanceCount, "vkCmdDrawIndexed()"); |
| 2724 | } |
| 2725 | |
sfricke-samsung | 681ab7b | 2020-10-29 01:53:35 -0700 | [diff] [blame] | 2726 | bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCount(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
| 2727 | VkBuffer countBuffer, VkDeviceSize countBufferOffset, |
| 2728 | uint32_t maxDrawCount, uint32_t stride) const { |
| 2729 | bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCount()"); |
| 2730 | |
| 2731 | return skip; |
| 2732 | } |
| 2733 | |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2734 | bool BestPractices::PreCallValidateCmdDrawIndexedIndirectCountKHR(VkCommandBuffer commandBuffer, VkBuffer buffer, |
| 2735 | VkDeviceSize offset, VkBuffer countBuffer, |
| 2736 | VkDeviceSize countBufferOffset, uint32_t maxDrawCount, |
| 2737 | uint32_t stride) const { |
| 2738 | bool skip = ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirectCountKHR()"); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2739 | |
| 2740 | return skip; |
| 2741 | } |
| 2742 | |
| 2743 | bool BestPractices::PreCallValidateCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 2744 | uint32_t drawCount, uint32_t stride) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2745 | bool skip = false; |
| 2746 | |
| 2747 | if (drawCount == 0) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 2748 | skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero, |
| 2749 | "Warning: You are calling vkCmdDrawIndirect() with a drawCount of Zero."); |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2750 | skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndirect()"); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2751 | } |
| 2752 | |
| 2753 | return skip; |
| 2754 | } |
| 2755 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2756 | void BestPractices::PostCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
| 2757 | uint32_t count, uint32_t stride) { |
| 2758 | StateTracker::PostCallRecordCmdDrawIndirect(commandBuffer, buffer, offset, count, stride); |
| 2759 | RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndirect()"); |
| 2760 | } |
| 2761 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2762 | bool BestPractices::PreCallValidateCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 2763 | uint32_t drawCount, uint32_t stride) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2764 | bool skip = false; |
| 2765 | |
| 2766 | if (drawCount == 0) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 2767 | skip |= LogWarning(device, kVUID_BestPractices_CmdDraw_DrawCountZero, |
| 2768 | "Warning: You are calling vkCmdDrawIndexedIndirect() with a drawCount of Zero."); |
Mark Lobodzinski | 4c4cf94 | 2019-12-20 11:09:51 -0700 | [diff] [blame] | 2769 | skip |= ValidateCmdDrawType(commandBuffer, "vkCmdDrawIndexedIndirect()"); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2770 | } |
| 2771 | |
| 2772 | return skip; |
| 2773 | } |
| 2774 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2775 | void BestPractices::PostCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
| 2776 | uint32_t count, uint32_t stride) { |
| 2777 | StateTracker::PostCallRecordCmdDrawIndexedIndirect(commandBuffer, buffer, offset, count, stride); |
| 2778 | RecordCmdDrawType(commandBuffer, count, "vkCmdDrawIndexedIndirect()"); |
| 2779 | } |
| 2780 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2781 | void BestPractices::ValidateBoundDescriptorSets(bp_state::CommandBuffer& cb_state, const char* function_name) { |
| 2782 | for (auto descriptor_set : cb_state.validated_descriptor_sets) { |
Jeremy Gebben | 1b9fdb8 | 2022-06-15 15:31:32 -0600 | [diff] [blame] | 2783 | for (const auto& binding : *descriptor_set) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2784 | // For bindless scenarios, we should not attempt to track descriptor set state. |
| 2785 | // It is highly uncertain which resources are actually bound. |
| 2786 | // Resources which are written to such a descriptor should be marked as indeterminate w.r.t. state. |
Jeremy Gebben | 1b9fdb8 | 2022-06-15 15:31:32 -0600 | [diff] [blame] | 2787 | if (binding->binding_flags & (VK_DESCRIPTOR_BINDING_PARTIALLY_BOUND_BIT | VK_DESCRIPTOR_BINDING_UPDATE_AFTER_BIND_BIT | |
| 2788 | VK_DESCRIPTOR_BINDING_UPDATE_UNUSED_WHILE_PENDING_BIT)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2789 | continue; |
| 2790 | } |
Hans-Kristian Arntzen | a819901 | 2021-03-22 12:10:07 +0100 | [diff] [blame] | 2791 | |
Jeremy Gebben | 1b9fdb8 | 2022-06-15 15:31:32 -0600 | [diff] [blame] | 2792 | for (uint32_t i = 0; i < binding->count; ++i) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2793 | VkImageView image_view{VK_NULL_HANDLE}; |
| 2794 | |
Jeremy Gebben | 1b9fdb8 | 2022-06-15 15:31:32 -0600 | [diff] [blame] | 2795 | auto descriptor = binding->GetDescriptor(i); |
ziga-lunarg | 33d806c | 2022-05-05 17:00:52 +0200 | [diff] [blame] | 2796 | if (!descriptor) { |
| 2797 | continue; |
| 2798 | } |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2799 | switch (descriptor->GetClass()) { |
| 2800 | case cvdescriptorset::DescriptorClass::Image: { |
| 2801 | if (const auto image_descriptor = static_cast<const cvdescriptorset::ImageDescriptor*>(descriptor)) { |
| 2802 | image_view = image_descriptor->GetImageView(); |
| 2803 | } |
| 2804 | break; |
| 2805 | } |
| 2806 | case cvdescriptorset::DescriptorClass::ImageSampler: { |
| 2807 | if (const auto image_sampler_descriptor = |
| 2808 | static_cast<const cvdescriptorset::ImageSamplerDescriptor*>(descriptor)) { |
| 2809 | image_view = image_sampler_descriptor->GetImageView(); |
| 2810 | } |
| 2811 | break; |
| 2812 | } |
| 2813 | default: |
| 2814 | break; |
Hans-Kristian Arntzen | a819901 | 2021-03-22 12:10:07 +0100 | [diff] [blame] | 2815 | } |
| 2816 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2817 | if (image_view) { |
| 2818 | auto image_view_state = Get<IMAGE_VIEW_STATE>(image_view); |
| 2819 | QueueValidateImageView(cb_state.queue_submit_functions, function_name, image_view_state.get(), |
| 2820 | IMAGE_SUBRESOURCE_USAGE_BP::DESCRIPTOR_ACCESS); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2821 | } |
| 2822 | } |
| 2823 | } |
| 2824 | } |
| 2825 | } |
| 2826 | |
| 2827 | void BestPractices::PreCallRecordCmdDraw(VkCommandBuffer commandBuffer, uint32_t vertexCount, uint32_t instanceCount, |
| 2828 | uint32_t firstVertex, uint32_t firstInstance) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2829 | const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2830 | ValidateBoundDescriptorSets(*cb_node, "vkCmdDraw()"); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2831 | } |
| 2832 | |
| 2833 | void BestPractices::PreCallRecordCmdDrawIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
| 2834 | uint32_t drawCount, uint32_t stride) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2835 | const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2836 | ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndirect()"); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2837 | } |
| 2838 | |
| 2839 | void BestPractices::PreCallRecordCmdDrawIndexedIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset, |
| 2840 | uint32_t drawCount, uint32_t stride) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2841 | const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2842 | ValidateBoundDescriptorSets(*cb_node, "vkCmdDrawIndexedIndirect()"); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2843 | } |
| 2844 | |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2845 | bool BestPractices::PreCallValidateCmdDispatch(VkCommandBuffer commandBuffer, uint32_t groupCountX, uint32_t groupCountY, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 2846 | uint32_t groupCountZ) const { |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2847 | bool skip = false; |
| 2848 | |
| 2849 | if ((groupCountX == 0) || (groupCountY == 0) || (groupCountZ == 0)) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 2850 | skip |= LogWarning(device, kVUID_BestPractices_CmdDispatch_GroupCountZero, |
| 2851 | "Warning: You are calling vkCmdDispatch() while one or more groupCounts are zero (groupCountX = %" PRIu32 |
| 2852 | ", groupCountY = %" PRIu32 ", groupCountZ = %" PRIu32 ").", |
| 2853 | groupCountX, groupCountY, groupCountZ); |
Camden | 5b184be | 2019-08-13 07:50:19 -0600 | [diff] [blame] | 2854 | } |
| 2855 | |
| 2856 | return skip; |
| 2857 | } |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 2858 | |
Hans-Kristian Arntzen | d9941a9 | 2021-06-18 12:31:30 +0200 | [diff] [blame] | 2859 | bool BestPractices::PreCallValidateCmdEndRenderPass2(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const { |
| 2860 | bool skip = false; |
| 2861 | skip |= StateTracker::PreCallValidateCmdEndRenderPass2(commandBuffer, pSubpassEndInfo); |
| 2862 | skip |= ValidateCmdEndRenderPass(commandBuffer); |
| 2863 | return skip; |
| 2864 | } |
| 2865 | |
| 2866 | bool BestPractices::PreCallValidateCmdEndRenderPass2KHR(VkCommandBuffer commandBuffer, const VkSubpassEndInfo* pSubpassEndInfo) const { |
| 2867 | bool skip = false; |
| 2868 | skip |= StateTracker::PreCallValidateCmdEndRenderPass2KHR(commandBuffer, pSubpassEndInfo); |
| 2869 | skip |= ValidateCmdEndRenderPass(commandBuffer); |
| 2870 | return skip; |
| 2871 | } |
| 2872 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2873 | bool BestPractices::PreCallValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const { |
| 2874 | bool skip = false; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2875 | skip |= StateTracker::PreCallValidateCmdEndRenderPass(commandBuffer); |
Hans-Kristian Arntzen | d9941a9 | 2021-06-18 12:31:30 +0200 | [diff] [blame] | 2876 | skip |= ValidateCmdEndRenderPass(commandBuffer); |
| 2877 | return skip; |
| 2878 | } |
| 2879 | |
| 2880 | bool BestPractices::ValidateCmdEndRenderPass(VkCommandBuffer commandBuffer) const { |
| 2881 | bool skip = false; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2882 | const auto cmd = GetRead<bp_state::CommandBuffer>(commandBuffer); |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2883 | |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2884 | if (cmd == nullptr) return skip; |
| 2885 | auto &render_pass_state = cmd->render_pass_state; |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2886 | |
LawG4 | b21485c | 2022-02-28 13:46:48 +0000 | [diff] [blame] | 2887 | // Does the number of draw calls classified as depth only surpass the vendor limit for a specified vendor |
| 2888 | bool depth_only_arm = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsArm && |
| 2889 | render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsArm; |
| 2890 | bool depth_only_img = render_pass_state.numDrawCallsDepthEqualCompare >= kDepthPrePassNumDrawCallsIMG && |
| 2891 | render_pass_state.numDrawCallsDepthOnly >= kDepthPrePassNumDrawCallsIMG; |
| 2892 | |
| 2893 | // Only send the warning when the vendor is enabled and a depth prepass is detected |
LawG4 | 98ec450 | 2022-04-05 09:08:25 +0100 | [diff] [blame] | 2894 | bool uses_depth = |
| 2895 | (render_pass_state.depthAttachment || render_pass_state.colorAttachment) && |
LawG4 | 5507e14 | 2022-04-08 09:36:54 +0100 | [diff] [blame] | 2896 | ((depth_only_arm && VendorCheckEnabled(kBPVendorArm)) || (depth_only_img && VendorCheckEnabled(kBPVendorIMG))); |
LawG4 | b21485c | 2022-02-28 13:46:48 +0000 | [diff] [blame] | 2897 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2898 | if (uses_depth) { |
| 2899 | skip |= LogPerformanceWarning( |
| 2900 | device, kVUID_BestPractices_EndRenderPass_DepthPrePassUsage, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 2901 | "%s %s: Depth pre-passes may be in use. In general, this is not recommended in tile-based deferred " |
LawG4 | b21485c | 2022-02-28 13:46:48 +0000 | [diff] [blame] | 2902 | "renderering architectures; such as those in Arm Mali or PowerVR GPUs. Since they can remove geometry " |
| 2903 | "hidden by other opaque geometry. Mali has Forward Pixel Killing (FPK), PowerVR has Hiden Surface " |
| 2904 | "Remover (HSR) in which case, using depth pre-passes for hidden surface removal may worsen performance.", |
| 2905 | VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG)); |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2906 | } |
| 2907 | |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2908 | RENDER_PASS_STATE* rp = cmd->activeRenderPass.get(); |
| 2909 | |
LawG4 | 0da9c3d | 2022-03-01 09:51:01 +0000 | [diff] [blame] | 2910 | if ((VendorCheckEnabled(kBPVendorArm) || VendorCheckEnabled(kBPVendorIMG)) && rp) { |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2911 | // If we use an attachment on-tile, we should access it in some way. Otherwise, |
| 2912 | // it is redundant to have it be part of the render pass. |
| 2913 | // Only consider it redundant if it will actually consume bandwidth, i.e. |
| 2914 | // LOAD_OP_LOAD is used or STORE_OP_STORE. CLEAR -> DONT_CARE is benign, |
| 2915 | // as is using pure input attachments. |
| 2916 | // CLEAR -> STORE might be considered a "useful" thing to do, but |
| 2917 | // the optimal thing to do is to defer the clear until you're actually |
| 2918 | // going to render to the image. |
| 2919 | |
| 2920 | uint32_t num_attachments = rp->createInfo.attachmentCount; |
| 2921 | for (uint32_t i = 0; i < num_attachments; i++) { |
Hans-Kristian Arntzen | 237663c | 2021-07-01 14:36:40 +0200 | [diff] [blame] | 2922 | if (!RenderPassUsesAttachmentOnTile(rp->createInfo, i) || |
| 2923 | RenderPassUsesAttachmentAsResolve(rp->createInfo, i)) { |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2924 | continue; |
| 2925 | } |
| 2926 | |
| 2927 | auto& attachment = rp->createInfo.pAttachments[i]; |
| 2928 | |
| 2929 | VkImageAspectFlags bandwidth_aspects = 0; |
| 2930 | |
| 2931 | if (!FormatIsStencilOnly(attachment.format) && |
| 2932 | (attachment.loadOp == VK_ATTACHMENT_LOAD_OP_LOAD || |
| 2933 | attachment.storeOp == VK_ATTACHMENT_STORE_OP_STORE)) { |
| 2934 | if (FormatHasDepth(attachment.format)) { |
| 2935 | bandwidth_aspects |= VK_IMAGE_ASPECT_DEPTH_BIT; |
| 2936 | } else { |
| 2937 | bandwidth_aspects |= VK_IMAGE_ASPECT_COLOR_BIT; |
| 2938 | } |
| 2939 | } |
| 2940 | |
| 2941 | if (FormatHasStencil(attachment.format) && |
| 2942 | (attachment.stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD || |
| 2943 | attachment.stencilStoreOp == VK_ATTACHMENT_STORE_OP_STORE)) { |
| 2944 | bandwidth_aspects |= VK_IMAGE_ASPECT_STENCIL_BIT; |
| 2945 | } |
| 2946 | |
| 2947 | if (!bandwidth_aspects) { |
| 2948 | continue; |
| 2949 | } |
| 2950 | |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2951 | auto itr = std::find_if(render_pass_state.touchesAttachments.begin(), render_pass_state.touchesAttachments.end(), |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2952 | [i](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == i; }); |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2953 | uint32_t untouched_aspects = bandwidth_aspects; |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 2954 | if (itr != render_pass_state.touchesAttachments.end()) { |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2955 | untouched_aspects &= ~itr->aspects; |
| 2956 | } |
| 2957 | |
| 2958 | if (untouched_aspects) { |
| 2959 | skip |= LogPerformanceWarning( |
| 2960 | device, kVUID_BestPractices_EndRenderPass_RedundantAttachmentOnTile, |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 2961 | "%s %s: Render pass was ended, but attachment #%u (format: %u, untouched aspects 0x%x) " |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2962 | "was never accessed by a pipeline or clear command. " |
LawG4 | 0da9c3d | 2022-03-01 09:51:01 +0000 | [diff] [blame] | 2963 | "On tile-based architectures, LOAD_OP_LOAD and STORE_OP_STORE consume bandwidth and should not be part of the " |
LawG4 | 015be1c | 2022-03-01 10:37:52 +0000 | [diff] [blame] | 2964 | "render pass if the attachments are not intended to be accessed.", |
LawG4 | 0da9c3d | 2022-03-01 09:51:01 +0000 | [diff] [blame] | 2965 | VendorSpecificTag(kBPVendorArm), VendorSpecificTag(kBPVendorIMG), i, attachment.format, untouched_aspects); |
Hans-Kristian Arntzen | 808bfa1 | 2021-06-18 13:52:45 +0200 | [diff] [blame] | 2966 | } |
| 2967 | } |
| 2968 | } |
| 2969 | |
Sam Walls | 0961ec0 | 2020-03-31 16:39:15 +0100 | [diff] [blame] | 2970 | return skip; |
| 2971 | } |
| 2972 | |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2973 | void BestPractices::PreCallRecordCmdDispatch(VkCommandBuffer commandBuffer, uint32_t x, uint32_t y, uint32_t z) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2974 | const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2975 | ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatch()"); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2976 | } |
| 2977 | |
| 2978 | void BestPractices::PreCallRecordCmdDispatchIndirect(VkCommandBuffer commandBuffer, VkBuffer buffer, VkDeviceSize offset) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2979 | const auto cb_node = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
| 2980 | ValidateBoundDescriptorSets(*cb_node, "vkCmdDispatchIndirect()"); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 2981 | } |
| 2982 | |
Camden Stocker | 9c05144 | 2019-11-06 14:28:43 -0800 | [diff] [blame] | 2983 | bool BestPractices::ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(VkPhysicalDevice physicalDevice, |
| 2984 | const char* api_name) const { |
| 2985 | bool skip = false; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 2986 | const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Camden Stocker | 9c05144 | 2019-11-06 14:28:43 -0800 | [diff] [blame] | 2987 | |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 2988 | if (bp_pd_state) { |
| 2989 | if (bp_pd_state->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState == UNCALLED) { |
| 2990 | skip |= LogWarning(physicalDevice, kVUID_BestPractices_DisplayPlane_PropertiesNotCalled, |
| 2991 | "Potential problem with calling %s() without first retrieving properties from " |
| 2992 | "vkGetPhysicalDeviceDisplayPlanePropertiesKHR or vkGetPhysicalDeviceDisplayPlaneProperties2KHR.", |
| 2993 | api_name); |
| 2994 | } |
Camden Stocker | 9c05144 | 2019-11-06 14:28:43 -0800 | [diff] [blame] | 2995 | } |
| 2996 | |
| 2997 | return skip; |
| 2998 | } |
| 2999 | |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 3000 | bool BestPractices::PreCallValidateGetDisplayPlaneSupportedDisplaysKHR(VkPhysicalDevice physicalDevice, uint32_t planeIndex, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3001 | uint32_t* pDisplayCount, VkDisplayKHR* pDisplays) const { |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 3002 | bool skip = false; |
| 3003 | |
Camden Stocker | 9c05144 | 2019-11-06 14:28:43 -0800 | [diff] [blame] | 3004 | skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneSupportedDisplaysKHR"); |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 3005 | |
Camden Stocker | 9c05144 | 2019-11-06 14:28:43 -0800 | [diff] [blame] | 3006 | return skip; |
| 3007 | } |
| 3008 | |
| 3009 | bool BestPractices::PreCallValidateGetDisplayPlaneCapabilitiesKHR(VkPhysicalDevice physicalDevice, VkDisplayModeKHR mode, |
| 3010 | uint32_t planeIndex, |
| 3011 | VkDisplayPlaneCapabilitiesKHR* pCapabilities) const { |
| 3012 | bool skip = false; |
| 3013 | |
| 3014 | skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilitiesKHR"); |
| 3015 | |
| 3016 | return skip; |
| 3017 | } |
| 3018 | |
| 3019 | bool BestPractices::PreCallValidateGetDisplayPlaneCapabilities2KHR(VkPhysicalDevice physicalDevice, |
| 3020 | const VkDisplayPlaneInfo2KHR* pDisplayPlaneInfo, |
| 3021 | VkDisplayPlaneCapabilities2KHR* pCapabilities) const { |
| 3022 | bool skip = false; |
| 3023 | |
| 3024 | skip |= ValidateGetPhysicalDeviceDisplayPlanePropertiesKHRQuery(physicalDevice, "vkGetDisplayPlaneCapabilities2KHR"); |
Camden | 83a9c37 | 2019-08-14 11:41:38 -0600 | [diff] [blame] | 3025 | |
| 3026 | return skip; |
| 3027 | } |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3028 | |
| 3029 | bool BestPractices::PreCallValidateGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, uint32_t* pSwapchainImageCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3030 | VkImage* pSwapchainImages) const { |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3031 | bool skip = false; |
| 3032 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3033 | auto swapchain_state = Get<bp_state::Swapchain>(swapchain); |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3034 | |
Nathaniel Cesario | 39152e6 | 2021-07-02 13:04:16 -0600 | [diff] [blame] | 3035 | if (swapchain_state && pSwapchainImages) { |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3036 | // Compare the preliminary value of *pSwapchainImageCount with the value this time: |
Nathaniel Cesario | 39152e6 | 2021-07-02 13:04:16 -0600 | [diff] [blame] | 3037 | if (swapchain_state->vkGetSwapchainImagesKHRState == UNCALLED) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3038 | skip |= |
| 3039 | LogWarning(device, kVUID_Core_Swapchain_PriorCount, |
| 3040 | "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImageCount; but no prior positive value has " |
| 3041 | "been seen for pSwapchainImages."); |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3042 | } |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3043 | |
Nathaniel Cesario | 4ce9838 | 2021-05-28 11:33:20 -0600 | [diff] [blame] | 3044 | if (*pSwapchainImageCount > swapchain_state->get_swapchain_image_count) { |
| 3045 | skip |= LogWarning( |
| 3046 | device, kVUID_BestPractices_Swapchain_InvalidCount, |
| 3047 | "vkGetSwapchainImagesKHR() called with non-NULL pSwapchainImages, and with pSwapchainImageCount set to a " |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3048 | "value (%" PRId32 ") that is greater than the value (%" PRId32 ") that was returned when pSwapchainImages was NULL.", |
Nathaniel Cesario | 4ce9838 | 2021-05-28 11:33:20 -0600 | [diff] [blame] | 3049 | *pSwapchainImageCount, swapchain_state->get_swapchain_image_count); |
| 3050 | } |
| 3051 | } |
| 3052 | |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3053 | return skip; |
| 3054 | } |
| 3055 | |
| 3056 | // Common function to handle validation for GetPhysicalDeviceQueueFamilyProperties & 2KHR version |
Jeremy Gebben | 383b9a3 | 2021-09-08 16:31:33 -0600 | [diff] [blame] | 3057 | bool BestPractices::ValidateCommonGetPhysicalDeviceQueueFamilyProperties(const PHYSICAL_DEVICE_STATE* bp_pd_state, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3058 | uint32_t requested_queue_family_property_count, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3059 | const CALL_STATE call_state, |
| 3060 | const char* caller_name) const { |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3061 | bool skip = false; |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3062 | // Verify that for each physical device, this command is called first with NULL pQueueFamilyProperties in order to get count |
| 3063 | if (UNCALLED == call_state) { |
| 3064 | skip |= LogWarning( |
Jeremy Gebben | 383b9a3 | 2021-09-08 16:31:33 -0600 | [diff] [blame] | 3065 | bp_pd_state->Handle(), kVUID_Core_DevLimit_MissingQueryCount, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3066 | "%s is called with non-NULL pQueueFamilyProperties before obtaining pQueueFamilyPropertyCount. It is " |
| 3067 | "recommended " |
| 3068 | "to first call %s with NULL pQueueFamilyProperties in order to obtain the maximal pQueueFamilyPropertyCount.", |
| 3069 | caller_name, caller_name); |
| 3070 | // Then verify that pCount that is passed in on second call matches what was returned |
Jeremy Gebben | 383b9a3 | 2021-09-08 16:31:33 -0600 | [diff] [blame] | 3071 | } else if (bp_pd_state->queue_family_known_count != requested_queue_family_property_count) { |
| 3072 | skip |= LogWarning(bp_pd_state->Handle(), kVUID_Core_DevLimit_CountMismatch, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3073 | "%s is called with non-NULL pQueueFamilyProperties and pQueueFamilyPropertyCount value %" PRIu32 |
| 3074 | ", but the largest previously returned pQueueFamilyPropertyCount for this physicalDevice is %" PRIu32 |
| 3075 | ". It is recommended to instead receive all the properties by calling %s with " |
| 3076 | "pQueueFamilyPropertyCount that was " |
| 3077 | "previously obtained by calling %s with NULL pQueueFamilyProperties.", |
Jeremy Gebben | 383b9a3 | 2021-09-08 16:31:33 -0600 | [diff] [blame] | 3078 | caller_name, requested_queue_family_property_count, bp_pd_state->queue_family_known_count, caller_name, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3079 | caller_name); |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3080 | } |
| 3081 | |
| 3082 | return skip; |
| 3083 | } |
| 3084 | |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3085 | bool BestPractices::PreCallValidateBindAccelerationStructureMemoryNV( |
| 3086 | VkDevice device, uint32_t bindInfoCount, const VkBindAccelerationStructureMemoryInfoNV* pBindInfos) const { |
Camden Stocker | 8251058 | 2019-09-03 14:00:16 -0600 | [diff] [blame] | 3087 | bool skip = false; |
| 3088 | |
| 3089 | for (uint32_t i = 0; i < bindInfoCount; i++) { |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 3090 | auto as_state = Get<ACCELERATION_STRUCTURE_STATE>(pBindInfos[i].accelerationStructure); |
Camden Stocker | 8251058 | 2019-09-03 14:00:16 -0600 | [diff] [blame] | 3091 | if (!as_state->memory_requirements_checked) { |
| 3092 | // There's not an explicit requirement in the spec to call vkGetImageMemoryRequirements() prior to calling |
| 3093 | // BindAccelerationStructureMemoryNV but it's implied in that memory being bound must conform with |
| 3094 | // VkAccelerationStructureMemoryRequirementsInfoNV from vkGetAccelerationStructureMemoryRequirementsNV |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3095 | skip |= LogWarning( |
| 3096 | device, kVUID_BestPractices_BindAccelNV_NoMemReqQuery, |
Camden Stocker | 8251058 | 2019-09-03 14:00:16 -0600 | [diff] [blame] | 3097 | "vkBindAccelerationStructureMemoryNV(): " |
| 3098 | "Binding memory to %s but vkGetAccelerationStructureMemoryRequirementsNV() has not been called on that structure.", |
| 3099 | report_data->FormatHandle(pBindInfos[i].accelerationStructure).c_str()); |
| 3100 | } |
| 3101 | } |
| 3102 | |
| 3103 | return skip; |
| 3104 | } |
| 3105 | |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3106 | bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice, |
| 3107 | uint32_t* pQueueFamilyPropertyCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3108 | VkQueueFamilyProperties* pQueueFamilyProperties) const { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3109 | const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3110 | if (pQueueFamilyProperties && bp_pd_state) { |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3111 | return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3112 | bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState, |
| 3113 | "vkGetPhysicalDeviceQueueFamilyProperties()"); |
| 3114 | } |
| 3115 | return false; |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3116 | } |
| 3117 | |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 3118 | bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice, |
| 3119 | uint32_t* pQueueFamilyPropertyCount, |
| 3120 | VkQueueFamilyProperties2* pQueueFamilyProperties) const { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3121 | const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3122 | if (pQueueFamilyProperties && bp_pd_state) { |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3123 | return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3124 | bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State, |
| 3125 | "vkGetPhysicalDeviceQueueFamilyProperties2()"); |
| 3126 | } |
| 3127 | return false; |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3128 | } |
| 3129 | |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3130 | bool BestPractices::PreCallValidateGetPhysicalDeviceQueueFamilyProperties2KHR( |
Mike Schuchardt | 2df0891 | 2020-12-15 16:28:09 -0800 | [diff] [blame] | 3131 | VkPhysicalDevice physicalDevice, uint32_t* pQueueFamilyPropertyCount, VkQueueFamilyProperties2* pQueueFamilyProperties) const { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3132 | const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3133 | if (pQueueFamilyProperties && bp_pd_state) { |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3134 | return ValidateCommonGetPhysicalDeviceQueueFamilyProperties(bp_pd_state.get(), *pQueueFamilyPropertyCount, |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3135 | bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState, |
| 3136 | "vkGetPhysicalDeviceQueueFamilyProperties2KHR()"); |
| 3137 | } |
| 3138 | return false; |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3139 | } |
| 3140 | |
| 3141 | bool BestPractices::PreCallValidateGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface, |
| 3142 | uint32_t* pSurfaceFormatCount, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3143 | VkSurfaceFormatKHR* pSurfaceFormats) const { |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3144 | if (!pSurfaceFormats) return false; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3145 | const auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 3146 | const auto& call_state = bp_pd_state->vkGetPhysicalDeviceSurfaceFormatsKHRState; |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3147 | bool skip = false; |
| 3148 | if (call_state == UNCALLED) { |
| 3149 | // Since we haven't recorded a preliminary value of *pSurfaceFormatCount, that likely means that the application didn't |
| 3150 | // previously call this function with a NULL value of pSurfaceFormats: |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3151 | skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_MustQueryCount, |
| 3152 | "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount; but no prior " |
| 3153 | "positive value has been seen for pSurfaceFormats."); |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3154 | } else { |
Jeremy Gebben | c7a834a | 2021-09-08 18:39:30 -0600 | [diff] [blame] | 3155 | if (*pSurfaceFormatCount > bp_pd_state->surface_formats_count) { |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3156 | skip |= LogWarning(physicalDevice, kVUID_Core_DevLimit_CountMismatch, |
| 3157 | "vkGetPhysicalDeviceSurfaceFormatsKHR() called with non-NULL pSurfaceFormatCount, and with " |
| 3158 | "pSurfaceFormats set to a value (%u) that is greater than the value (%u) that was returned " |
| 3159 | "when pSurfaceFormatCount was NULL.", |
Jeremy Gebben | c7a834a | 2021-09-08 18:39:30 -0600 | [diff] [blame] | 3160 | *pSurfaceFormatCount, bp_pd_state->surface_formats_count); |
Camden | 05de2d4 | 2019-08-19 10:23:56 -0600 | [diff] [blame] | 3161 | } |
| 3162 | } |
| 3163 | return skip; |
| 3164 | } |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3165 | |
| 3166 | bool BestPractices::PreCallValidateQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo, |
Jeff Bolz | 5c801d1 | 2019-10-09 10:38:45 -0500 | [diff] [blame] | 3167 | VkFence fence) const { |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3168 | bool skip = false; |
| 3169 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3170 | for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) { |
| 3171 | const VkBindSparseInfo& bind_info = pBindInfo[bind_idx]; |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3172 | // Store sparse binding image_state and after binding is complete make sure that any requiring metadata have it bound |
Jeremy Gebben | cbf2286 | 2021-03-03 12:01:22 -0700 | [diff] [blame] | 3173 | layer_data::unordered_set<const IMAGE_STATE*> sparse_images; |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 3174 | // Track images getting metadata bound by this call in a set, it'll be recorded into the image_state |
| 3175 | // in RecordQueueBindSparse. |
Jeremy Gebben | cbf2286 | 2021-03-03 12:01:22 -0700 | [diff] [blame] | 3176 | layer_data::unordered_set<const IMAGE_STATE*> sparse_images_with_metadata; |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3177 | // If we're binding sparse image memory make sure reqs were queried and note if metadata is required and bound |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3178 | for (uint32_t i = 0; i < bind_info.imageBindCount; ++i) { |
| 3179 | const auto& image_bind = bind_info.pImageBinds[i]; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3180 | auto image_state = Get<IMAGE_STATE>(image_bind.image); |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3181 | if (!image_state) { |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3182 | continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here. |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3183 | } |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3184 | sparse_images.insert(image_state.get()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3185 | if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) { |
| 3186 | if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) { |
| 3187 | // For now just warning if sparse image binding occurs without calling to get reqs first |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3188 | skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3189 | "vkQueueBindSparse(): Binding sparse memory to %s without first calling " |
| 3190 | "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3191 | report_data->FormatHandle(image_state->image()).c_str()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3192 | } |
| 3193 | } |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 3194 | if (!image_state->memory_requirements_checked[0]) { |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3195 | // For now just warning if sparse image binding occurs without calling to get reqs first |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3196 | skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3197 | "vkQueueBindSparse(): Binding sparse memory to %s without first calling " |
| 3198 | "vkGetImageMemoryRequirements() to retrieve requirements.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3199 | report_data->FormatHandle(image_state->image()).c_str()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3200 | } |
| 3201 | } |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3202 | for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) { |
| 3203 | const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i]; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3204 | auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image); |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3205 | if (!image_state) { |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3206 | continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here. |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3207 | } |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3208 | sparse_images.insert(image_state.get()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3209 | if (image_state->createInfo.flags & VK_IMAGE_CREATE_SPARSE_RESIDENCY_BIT) { |
| 3210 | if (!image_state->get_sparse_reqs_called || image_state->sparse_requirements.empty()) { |
| 3211 | // For now just warning if sparse image binding occurs without calling to get reqs first |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3212 | skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3213 | "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling " |
| 3214 | "vkGetImageSparseMemoryRequirements[2KHR]() to retrieve requirements.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3215 | report_data->FormatHandle(image_state->image()).c_str()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3216 | } |
| 3217 | } |
Jeremy Gebben | 6fbf824 | 2021-06-21 09:14:46 -0600 | [diff] [blame] | 3218 | if (!image_state->memory_requirements_checked[0]) { |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3219 | // For now just warning if sparse image binding occurs without calling to get reqs first |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3220 | skip |= LogWarning(image_state->image(), kVUID_Core_MemTrack_InvalidState, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3221 | "vkQueueBindSparse(): Binding opaque sparse memory to %s without first calling " |
| 3222 | "vkGetImageMemoryRequirements() to retrieve requirements.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3223 | report_data->FormatHandle(image_state->image()).c_str()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3224 | } |
| 3225 | for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) { |
| 3226 | if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) { |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3227 | sparse_images_with_metadata.insert(image_state.get()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3228 | } |
| 3229 | } |
| 3230 | } |
| 3231 | for (const auto& sparse_image_state : sparse_images) { |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 3232 | if (sparse_image_state->sparse_metadata_required && !sparse_image_state->sparse_metadata_bound && |
| 3233 | sparse_images_with_metadata.find(sparse_image_state) == sparse_images_with_metadata.end()) { |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3234 | // Warn if sparse image binding metadata required for image with sparse binding, but metadata not bound |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3235 | skip |= LogWarning(sparse_image_state->image(), kVUID_Core_MemTrack_InvalidState, |
Mark Lobodzinski | b6e2a28 | 2020-01-29 16:03:26 -0700 | [diff] [blame] | 3236 | "vkQueueBindSparse(): Binding sparse memory to %s which requires a metadata aspect but no " |
| 3237 | "binding with VK_SPARSE_MEMORY_BIND_METADATA_BIT set was made.", |
Jeremy Gebben | 14b0d1a | 2021-05-15 20:15:41 -0600 | [diff] [blame] | 3238 | report_data->FormatHandle(sparse_image_state->image()).c_str()); |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3239 | } |
| 3240 | } |
| 3241 | } |
| 3242 | |
Rodrigo Locatti | 7ab778d | 2022-03-09 18:57:15 -0300 | [diff] [blame] | 3243 | if (VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 3244 | auto queue_state = Get<QUEUE_STATE>(queue); |
| 3245 | if (queue_state && queue_state->queueFamilyProperties.queueFlags != (VK_QUEUE_TRANSFER_BIT | VK_QUEUE_SPARSE_BINDING_BIT)) { |
| 3246 | skip |= LogPerformanceWarning(queue, kVUID_BestPractices_QueueBindSparse_NotAsync, |
| 3247 | "vkQueueBindSparse() issued on queue %s. All binds should happen on an asynchronous copy " |
| 3248 | "queue to hide the OS scheduling and submit costs.", |
| 3249 | report_data->FormatHandle(queue).c_str()); |
| 3250 | } |
| 3251 | } |
| 3252 | |
Camden Stocker | 23cc47d | 2019-09-03 14:53:57 -0600 | [diff] [blame] | 3253 | return skip; |
| 3254 | } |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 3255 | |
Mark Lobodzinski | 84101d7 | 2020-04-24 09:43:48 -0600 | [diff] [blame] | 3256 | void BestPractices::ManualPostCallRecordQueueBindSparse(VkQueue queue, uint32_t bindInfoCount, const VkBindSparseInfo* pBindInfo, |
| 3257 | VkFence fence, VkResult result) { |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 3258 | if (result != VK_SUCCESS) { |
Mark Lobodzinski | 205b7a0 | 2020-02-21 13:23:17 -0700 | [diff] [blame] | 3259 | return; |
| 3260 | } |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 3261 | |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3262 | for (uint32_t bind_idx = 0; bind_idx < bindInfoCount; bind_idx++) { |
| 3263 | const VkBindSparseInfo& bind_info = pBindInfo[bind_idx]; |
| 3264 | for (uint32_t i = 0; i < bind_info.imageOpaqueBindCount; ++i) { |
| 3265 | const auto& image_opaque_bind = bind_info.pImageOpaqueBinds[i]; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3266 | auto image_state = Get<IMAGE_STATE>(bind_info.pImageOpaqueBinds[i].image); |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3267 | if (!image_state) { |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 3268 | continue; // Param/Object validation should report image_bind.image handles being invalid, so just skip here. |
Nathaniel Cesario | ce9b481 | 2020-12-17 08:55:28 -0700 | [diff] [blame] | 3269 | } |
Jeff Bolz | 46c0ea0 | 2019-10-09 13:06:29 -0500 | [diff] [blame] | 3270 | for (uint32_t j = 0; j < image_opaque_bind.bindCount; ++j) { |
| 3271 | if (image_opaque_bind.pBinds[j].flags & VK_SPARSE_MEMORY_BIND_METADATA_BIT) { |
| 3272 | image_state->sparse_metadata_bound = true; |
| 3273 | } |
| 3274 | } |
| 3275 | } |
| 3276 | } |
| 3277 | } |
Camden Stocker | 0e0f89b | 2019-10-16 12:24:31 -0700 | [diff] [blame] | 3278 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3279 | bool BestPractices::ClearAttachmentsIsFullClear(const bp_state::CommandBuffer& cmd, uint32_t rectCount, |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 3280 | const VkClearRect* pRects) const { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3281 | if (cmd.createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) { |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3282 | // We don't know the accurate render area in a secondary, |
| 3283 | // so assume we clear the entire frame buffer. |
| 3284 | // This is resolved in CmdExecuteCommands where we can check if the clear is a full clear. |
| 3285 | return true; |
| 3286 | } |
| 3287 | |
| 3288 | // If we have a rect which covers the entire frame buffer, we have a LOAD_OP_CLEAR-like command. |
| 3289 | for (uint32_t i = 0; i < rectCount; i++) { |
| 3290 | auto& rect = pRects[i]; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3291 | auto& render_area = cmd.activeRenderPassBeginInfo.renderArea; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3292 | if (rect.rect.extent.width == render_area.extent.width && rect.rect.extent.height == render_area.extent.height) { |
| 3293 | return true; |
| 3294 | } |
| 3295 | } |
| 3296 | |
| 3297 | return false; |
| 3298 | } |
| 3299 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3300 | bool BestPractices::ValidateClearAttachment(const bp_state::CommandBuffer& cmd, uint32_t fb_attachment, uint32_t color_attachment, |
| 3301 | VkImageAspectFlags aspects, bool secondary) const { |
| 3302 | const RENDER_PASS_STATE* rp = cmd.activeRenderPass.get(); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3303 | bool skip = false; |
| 3304 | |
| 3305 | if (!rp || fb_attachment == VK_ATTACHMENT_UNUSED) { |
| 3306 | return skip; |
| 3307 | } |
| 3308 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3309 | const auto& rp_state = cmd.render_pass_state; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3310 | |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3311 | auto attachment_itr = |
| 3312 | std::find_if(rp_state.touchesAttachments.begin(), rp_state.touchesAttachments.end(), |
| 3313 | [fb_attachment](const bp_state::AttachmentInfo& info) { return info.framebufferAttachment == fb_attachment; }); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3314 | |
| 3315 | // Only report aspects which haven't been touched yet. |
| 3316 | VkImageAspectFlags new_aspects = aspects; |
Jeremy Gebben | 7c2cd8b | 2021-08-11 15:40:38 -0600 | [diff] [blame] | 3317 | if (attachment_itr != rp_state.touchesAttachments.end()) { |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3318 | new_aspects &= ~attachment_itr->aspects; |
| 3319 | } |
| 3320 | |
| 3321 | // Warn if this is issued prior to Draw Cmd and clearing the entire attachment |
sjfricke | 52defd4 | 2022-08-08 16:37:46 +0900 | [diff] [blame] | 3322 | if (!cmd.has_draw_cmd) { |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3323 | skip |= LogPerformanceWarning( |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3324 | cmd.Handle(), kVUID_BestPractices_DrawState_ClearCmdBeforeDraw, |
Hans-Kristian Arntzen | 4ddd618 | 2021-06-18 12:16:33 +0200 | [diff] [blame] | 3325 | "vkCmdClearAttachments() issued on %s prior to any Draw Cmds in current render pass. It is recommended you " |
| 3326 | "use RenderPass LOAD_OP_CLEAR on attachments instead.", |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3327 | report_data->FormatHandle(cmd.Handle()).c_str()); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3328 | } |
| 3329 | |
| 3330 | if ((new_aspects & VK_IMAGE_ASPECT_COLOR_BIT) && |
| 3331 | rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
| 3332 | skip |= LogPerformanceWarning( |
| 3333 | device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad, |
| 3334 | "%svkCmdClearAttachments() issued on %s for color attachment #%u in this subpass, " |
| 3335 | "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as " |
| 3336 | "it is more efficient.", |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3337 | secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str(), color_attachment); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3338 | } |
| 3339 | |
| 3340 | if ((new_aspects & VK_IMAGE_ASPECT_DEPTH_BIT) && |
| 3341 | rp->createInfo.pAttachments[fb_attachment].loadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3342 | skip |= |
| 3343 | LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad, |
| 3344 | "%svkCmdClearAttachments() issued on %s for the depth attachment in this subpass, " |
| 3345 | "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as " |
| 3346 | "it is more efficient.", |
| 3347 | secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str()); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3348 | } |
| 3349 | |
| 3350 | if ((new_aspects & VK_IMAGE_ASPECT_STENCIL_BIT) && |
| 3351 | rp->createInfo.pAttachments[fb_attachment].stencilLoadOp == VK_ATTACHMENT_LOAD_OP_LOAD) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3352 | skip |= |
| 3353 | LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachments_ClearAfterLoad, |
| 3354 | "%svkCmdClearAttachments() issued on %s for the stencil attachment in this subpass, " |
| 3355 | "but LOAD_OP_LOAD was used. If you need to clear the framebuffer, always use LOAD_OP_CLEAR as " |
| 3356 | "it is more efficient.", |
| 3357 | secondary ? "vkCmdExecuteCommands(): " : "", report_data->FormatHandle(cmd.Handle()).c_str()); |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3358 | } |
| 3359 | |
| 3360 | return skip; |
| 3361 | } |
| 3362 | |
Camden Stocker | 0e0f89b | 2019-10-16 12:24:31 -0700 | [diff] [blame] | 3363 | bool BestPractices::PreCallValidateCmdClearAttachments(VkCommandBuffer commandBuffer, uint32_t attachmentCount, |
Camden Stocker | f55721f | 2019-09-09 11:04:49 -0600 | [diff] [blame] | 3364 | const VkClearAttachment* pAttachments, uint32_t rectCount, |
| 3365 | const VkClearRect* pRects) const { |
Camden Stocker | 0e0f89b | 2019-10-16 12:24:31 -0700 | [diff] [blame] | 3366 | bool skip = false; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3367 | const auto cb_node = GetRead<bp_state::CommandBuffer>(commandBuffer); |
Camden Stocker | 0e0f89b | 2019-10-16 12:24:31 -0700 | [diff] [blame] | 3368 | if (!cb_node) return skip; |
| 3369 | |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3370 | if (cb_node->createInfo.level == VK_COMMAND_BUFFER_LEVEL_SECONDARY) { |
| 3371 | // Defer checks to ExecuteCommands. |
| 3372 | return skip; |
| 3373 | } |
| 3374 | |
| 3375 | // Only care about full clears, partial clears might have legitimate uses. |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3376 | if (!ClearAttachmentsIsFullClear(*cb_node, rectCount, pRects)) { |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3377 | return skip; |
Camden Stocker | 0e0f89b | 2019-10-16 12:24:31 -0700 | [diff] [blame] | 3378 | } |
| 3379 | |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 3380 | // Check for uses of ClearAttachments along with LOAD_OP_LOAD, |
| 3381 | // as it can be more efficient to just use LOAD_OP_CLEAR |
locke-lunarg | aecf215 | 2020-05-12 17:15:41 -0600 | [diff] [blame] | 3382 | const RENDER_PASS_STATE* rp = cb_node->activeRenderPass.get(); |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 3383 | if (rp) { |
| 3384 | const auto& subpass = rp->createInfo.pSubpasses[cb_node->activeSubpass]; |
| 3385 | |
| 3386 | for (uint32_t i = 0; i < attachmentCount; i++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 3387 | const auto& attachment = pAttachments[i]; |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3388 | |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 3389 | if (attachment.aspectMask & VK_IMAGE_ASPECT_COLOR_BIT) { |
| 3390 | uint32_t color_attachment = attachment.colorAttachment; |
| 3391 | uint32_t fb_attachment = subpass.pColorAttachments[color_attachment].attachment; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3392 | skip |= ValidateClearAttachment(*cb_node, fb_attachment, color_attachment, attachment.aspectMask, false); |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 3393 | } |
| 3394 | |
Hans-Kristian Arntzen | b658631 | 2021-07-05 11:43:39 +0200 | [diff] [blame] | 3395 | if (subpass.pDepthStencilAttachment && |
| 3396 | (attachment.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT))) { |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 3397 | uint32_t fb_attachment = subpass.pDepthStencilAttachment->attachment; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3398 | skip |= ValidateClearAttachment(*cb_node, fb_attachment, VK_ATTACHMENT_UNUSED, attachment.aspectMask, false); |
Attilio Provenzano | 1d9a836 | 2020-02-27 12:23:51 +0000 | [diff] [blame] | 3399 | } |
| 3400 | } |
| 3401 | } |
| 3402 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3403 | if (VendorCheckEnabled(kBPVendorAMD)) { |
| 3404 | for (uint32_t attachment_idx = 0; attachment_idx < attachmentCount; attachment_idx++) { |
| 3405 | if (pAttachments[attachment_idx].aspectMask == VK_IMAGE_ASPECT_COLOR_BIT) { |
| 3406 | bool black_check = false; |
| 3407 | black_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 0.0f; |
| 3408 | black_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 0.0f; |
| 3409 | black_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 0.0f; |
| 3410 | black_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f && |
| 3411 | pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f; |
| 3412 | |
| 3413 | bool white_check = false; |
| 3414 | white_check |= pAttachments[attachment_idx].clearValue.color.float32[0] != 1.0f; |
| 3415 | white_check |= pAttachments[attachment_idx].clearValue.color.float32[1] != 1.0f; |
| 3416 | white_check |= pAttachments[attachment_idx].clearValue.color.float32[2] != 1.0f; |
| 3417 | white_check |= pAttachments[attachment_idx].clearValue.color.float32[3] != 0.0f && |
| 3418 | pAttachments[attachment_idx].clearValue.color.float32[3] != 1.0f; |
| 3419 | |
| 3420 | if (black_check && white_check) { |
| 3421 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues, |
| 3422 | "%s Performance warning: vkCmdClearAttachments() clear value for color attachment %" PRId32 " is not a fast clear value." |
| 3423 | "Consider changing to one of the following:" |
| 3424 | "RGBA(0, 0, 0, 0) " |
| 3425 | "RGBA(0, 0, 0, 1) " |
| 3426 | "RGBA(1, 1, 1, 0) " |
| 3427 | "RGBA(1, 1, 1, 1)", |
| 3428 | VendorSpecificTag(kBPVendorAMD), attachment_idx); |
| 3429 | } |
| 3430 | } else { |
| 3431 | if ((pAttachments[attachment_idx].clearValue.depthStencil.depth != 0 && |
| 3432 | pAttachments[attachment_idx].clearValue.depthStencil.depth != 1) && |
| 3433 | pAttachments[attachment_idx].clearValue.depthStencil.stencil != 0) { |
| 3434 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_ClearAttachment_FastClearValues, |
| 3435 | "%s Performance warning: vkCmdClearAttachments() clear value for depth/stencil " |
| 3436 | "attachment %" PRId32 " is not a fast clear value." |
| 3437 | "Consider changing to one of the following:" |
| 3438 | "D=0.0f, S=0" |
| 3439 | "D=1.0f, S=0", |
| 3440 | VendorSpecificTag(kBPVendorAMD), attachment_idx); |
| 3441 | } |
| 3442 | } |
| 3443 | } |
| 3444 | } |
| 3445 | |
Camden Stocker | f55721f | 2019-09-09 11:04:49 -0600 | [diff] [blame] | 3446 | return skip; |
Camden Stocker | 0e0f89b | 2019-10-16 12:24:31 -0700 | [diff] [blame] | 3447 | } |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 3448 | |
| 3449 | bool BestPractices::PreCallValidateCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, |
| 3450 | VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount, |
| 3451 | const VkImageResolve* pRegions) const { |
| 3452 | bool skip = false; |
| 3453 | |
| 3454 | skip |= VendorCheckEnabled(kBPVendorArm) && |
| 3455 | LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage_ResolvingImage, |
| 3456 | "%s Attempting to use vkCmdResolveImage to resolve a multisampled image. " |
| 3457 | "This is a very slow and extremely bandwidth intensive path. " |
| 3458 | "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.", |
| 3459 | VendorSpecificTag(kBPVendorArm)); |
| 3460 | |
| 3461 | return skip; |
| 3462 | } |
| 3463 | |
Jeff Leger | 178b1e5 | 2020-10-05 12:22:23 -0400 | [diff] [blame] | 3464 | bool BestPractices::PreCallValidateCmdResolveImage2KHR(VkCommandBuffer commandBuffer, |
| 3465 | const VkResolveImageInfo2KHR* pResolveImageInfo) const { |
| 3466 | bool skip = false; |
| 3467 | |
| 3468 | skip |= VendorCheckEnabled(kBPVendorArm) && |
| 3469 | LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2KHR_ResolvingImage, |
| 3470 | "%s Attempting to use vkCmdResolveImage2KHR to resolve a multisampled image. " |
| 3471 | "This is a very slow and extremely bandwidth intensive path. " |
| 3472 | "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.", |
| 3473 | VendorSpecificTag(kBPVendorArm)); |
| 3474 | |
| 3475 | return skip; |
| 3476 | } |
| 3477 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 3478 | bool BestPractices::PreCallValidateCmdResolveImage2(VkCommandBuffer commandBuffer, |
| 3479 | const VkResolveImageInfo2* pResolveImageInfo) const { |
| 3480 | bool skip = false; |
| 3481 | |
| 3482 | skip |= VendorCheckEnabled(kBPVendorArm) && |
| 3483 | LogPerformanceWarning(device, kVUID_BestPractices_CmdResolveImage2_ResolvingImage, |
| 3484 | "%s Attempting to use vkCmdResolveImage2 to resolve a multisampled image. " |
| 3485 | "This is a very slow and extremely bandwidth intensive path. " |
| 3486 | "You should always resolve multisampled images on-tile with pResolveAttachments in VkRenderPass.", |
| 3487 | VendorSpecificTag(kBPVendorArm)); |
| 3488 | |
| 3489 | return skip; |
| 3490 | } |
| 3491 | |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3492 | void BestPractices::PreCallRecordCmdResolveImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, |
| 3493 | VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount, |
| 3494 | const VkImageResolve* pRegions) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3495 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3496 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3497 | auto src = Get<bp_state::Image>(srcImage); |
| 3498 | auto dst = Get<bp_state::Image>(dstImage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3499 | |
| 3500 | for (uint32_t i = 0; i < regionCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3501 | QueueValidateImage(funcs, "vkCmdResolveImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pRegions[i].srcSubresource); |
| 3502 | QueueValidateImage(funcs, "vkCmdResolveImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pRegions[i].dstSubresource); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3503 | } |
| 3504 | } |
| 3505 | |
Hans-Kristian Arntzen | 9e030f1 | 2021-03-17 13:09:30 +0100 | [diff] [blame] | 3506 | void BestPractices::PreCallRecordCmdResolveImage2KHR(VkCommandBuffer commandBuffer, |
| 3507 | const VkResolveImageInfo2KHR* pResolveImageInfo) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3508 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3509 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3510 | auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage); |
| 3511 | auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage); |
Hans-Kristian Arntzen | 9e030f1 | 2021-03-17 13:09:30 +0100 | [diff] [blame] | 3512 | uint32_t regionCount = pResolveImageInfo->regionCount; |
| 3513 | |
| 3514 | for (uint32_t i = 0; i < regionCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3515 | QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, pResolveImageInfo->pRegions[i].srcSubresource); |
| 3516 | QueueValidateImage(funcs, "vkCmdResolveImage2KHR()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, pResolveImageInfo->pRegions[i].dstSubresource); |
Hans-Kristian Arntzen | 9e030f1 | 2021-03-17 13:09:30 +0100 | [diff] [blame] | 3517 | } |
| 3518 | } |
| 3519 | |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 3520 | void BestPractices::PreCallRecordCmdResolveImage2(VkCommandBuffer commandBuffer, |
| 3521 | const VkResolveImageInfo2* pResolveImageInfo) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3522 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 3523 | auto& funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3524 | auto src = Get<bp_state::Image>(pResolveImageInfo->srcImage); |
| 3525 | auto dst = Get<bp_state::Image>(pResolveImageInfo->dstImage); |
Tony-LunarG | d36f5f3 | 2022-01-20 11:49:59 -0700 | [diff] [blame] | 3526 | uint32_t regionCount = pResolveImageInfo->regionCount; |
| 3527 | |
| 3528 | for (uint32_t i = 0; i < regionCount; i++) { |
| 3529 | QueueValidateImage(funcs, "vkCmdResolveImage2()", src, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_READ, |
| 3530 | pResolveImageInfo->pRegions[i].srcSubresource); |
| 3531 | QueueValidateImage(funcs, "vkCmdResolveImage2()", dst, IMAGE_SUBRESOURCE_USAGE_BP::RESOLVE_WRITE, |
| 3532 | pResolveImageInfo->pRegions[i].dstSubresource); |
| 3533 | } |
| 3534 | } |
| 3535 | |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3536 | void BestPractices::PreCallRecordCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout, |
| 3537 | const VkClearColorValue* pColor, uint32_t rangeCount, |
| 3538 | const VkImageSubresourceRange* pRanges) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3539 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3540 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3541 | auto dst = Get<bp_state::Image>(image); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3542 | |
| 3543 | for (uint32_t i = 0; i < rangeCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3544 | QueueValidateImage(funcs, "vkCmdClearColorImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3545 | } |
| 3546 | } |
| 3547 | |
| 3548 | void BestPractices::PreCallRecordCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout, |
| 3549 | const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount, |
| 3550 | const VkImageSubresourceRange* pRanges) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3551 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3552 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3553 | auto dst = Get<bp_state::Image>(image); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3554 | |
| 3555 | for (uint32_t i = 0; i < rangeCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3556 | QueueValidateImage(funcs, "vkCmdClearDepthStencilImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::CLEARED, pRanges[i]); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3557 | } |
| 3558 | } |
| 3559 | |
| 3560 | void BestPractices::PreCallRecordCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, |
| 3561 | VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount, |
| 3562 | const VkImageCopy* pRegions) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3563 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3564 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3565 | auto src = Get<bp_state::Image>(srcImage); |
| 3566 | auto dst = Get<bp_state::Image>(dstImage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3567 | |
| 3568 | for (uint32_t i = 0; i < regionCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3569 | QueueValidateImage(funcs, "vkCmdCopyImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].srcSubresource); |
| 3570 | QueueValidateImage(funcs, "vkCmdCopyImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].dstSubresource); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3571 | } |
| 3572 | } |
| 3573 | |
| 3574 | void BestPractices::PreCallRecordCmdCopyBufferToImage(VkCommandBuffer commandBuffer, VkBuffer srcBuffer, VkImage dstImage, |
| 3575 | VkImageLayout dstImageLayout, uint32_t regionCount, |
| 3576 | const VkBufferImageCopy* pRegions) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3577 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3578 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3579 | auto dst = Get<bp_state::Image>(dstImage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3580 | |
| 3581 | for (uint32_t i = 0; i < regionCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3582 | QueueValidateImage(funcs, "vkCmdCopyBufferToImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::COPY_WRITE, pRegions[i].imageSubresource); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3583 | } |
| 3584 | } |
| 3585 | |
| 3586 | void BestPractices::PreCallRecordCmdCopyImageToBuffer(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, |
| 3587 | VkBuffer dstBuffer, uint32_t regionCount, const VkBufferImageCopy* pRegions) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3588 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3589 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3590 | auto src = Get<bp_state::Image>(srcImage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3591 | |
| 3592 | for (uint32_t i = 0; i < regionCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3593 | QueueValidateImage(funcs, "vkCmdCopyImageToBuffer()", src, IMAGE_SUBRESOURCE_USAGE_BP::COPY_READ, pRegions[i].imageSubresource); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3594 | } |
| 3595 | } |
| 3596 | |
| 3597 | void BestPractices::PreCallRecordCmdBlitImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, |
| 3598 | VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount, |
| 3599 | const VkImageBlit* pRegions, VkFilter filter) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3600 | auto cb = GetWrite<bp_state::CommandBuffer>(commandBuffer); |
Hans-Kristian Arntzen | dd8acbb | 2021-03-22 13:41:47 +0100 | [diff] [blame] | 3601 | auto &funcs = cb->queue_submit_functions; |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3602 | auto src = Get<bp_state::Image>(srcImage); |
| 3603 | auto dst = Get<bp_state::Image>(dstImage); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3604 | |
| 3605 | for (uint32_t i = 0; i < regionCount; i++) { |
Hans-Kristian Arntzen | c8b831c | 2021-04-28 15:29:49 +0200 | [diff] [blame] | 3606 | QueueValidateImage(funcs, "vkCmdBlitImage()", src, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_READ, pRegions[i].srcSubresource); |
| 3607 | QueueValidateImage(funcs, "vkCmdBlitImage()", dst, IMAGE_SUBRESOURCE_USAGE_BP::BLIT_WRITE, pRegions[i].dstSubresource); |
ZandroFargnoli | 1ced2b6 | 2020-06-18 16:49:34 +0100 | [diff] [blame] | 3608 | } |
| 3609 | } |
| 3610 | |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 3611 | bool BestPractices::PreCallValidateCreateSampler(VkDevice device, const VkSamplerCreateInfo* pCreateInfo, |
| 3612 | const VkAllocationCallbacks* pAllocator, VkSampler* pSampler) const { |
| 3613 | bool skip = false; |
| 3614 | |
| 3615 | if (VendorCheckEnabled(kBPVendorArm)) { |
| 3616 | if ((pCreateInfo->addressModeU != pCreateInfo->addressModeV) || (pCreateInfo->addressModeV != pCreateInfo->addressModeW)) { |
| 3617 | skip |= LogPerformanceWarning( |
| 3618 | device, kVUID_BestPractices_CreateSampler_DifferentWrappingModes, |
| 3619 | "%s Creating a sampler object with wrapping modes which do not match (U = %u, V = %u, W = %u). " |
| 3620 | "This may cause reduced performance even if only U (1D image) or U/V wrapping modes (2D " |
| 3621 | "image) are actually used. If you need different wrapping modes, disregard this warning.", |
Jeremy Gebben | da6b48f | 2021-05-13 10:46:18 -0600 | [diff] [blame] | 3622 | VendorSpecificTag(kBPVendorArm), pCreateInfo->addressModeU, pCreateInfo->addressModeV, pCreateInfo->addressModeW); |
Attilio Provenzano | 02859b2 | 2020-02-27 14:17:28 +0000 | [diff] [blame] | 3623 | } |
| 3624 | |
| 3625 | if ((pCreateInfo->minLod != 0.0f) || (pCreateInfo->maxLod < VK_LOD_CLAMP_NONE)) { |
| 3626 | skip |= LogPerformanceWarning( |
| 3627 | device, kVUID_BestPractices_CreateSampler_LodClamping, |
| 3628 | "%s Creating a sampler object with LOD clamping (minLod = %f, maxLod = %f). This may cause reduced performance. " |
| 3629 | "Instead of clamping LOD in the sampler, consider using an VkImageView which restricts the mip-levels, set minLod " |
| 3630 | "to 0.0, and maxLod to VK_LOD_CLAMP_NONE.", |
| 3631 | VendorSpecificTag(kBPVendorArm), pCreateInfo->minLod, pCreateInfo->maxLod); |
| 3632 | } |
| 3633 | |
| 3634 | if (pCreateInfo->mipLodBias != 0.0f) { |
| 3635 | skip |= |
| 3636 | LogPerformanceWarning(device, kVUID_BestPractices_CreateSampler_LodBias, |
| 3637 | "%s Creating a sampler object with LOD bias != 0.0 (%f). This will lead to less efficient " |
| 3638 | "descriptors being created and may cause reduced performance.", |
| 3639 | VendorSpecificTag(kBPVendorArm), pCreateInfo->mipLodBias); |
| 3640 | } |
| 3641 | |
| 3642 | if ((pCreateInfo->addressModeU == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER || |
| 3643 | pCreateInfo->addressModeV == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER || |
| 3644 | pCreateInfo->addressModeW == VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER) && |
| 3645 | (pCreateInfo->borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK)) { |
| 3646 | skip |= LogPerformanceWarning( |
| 3647 | device, kVUID_BestPractices_CreateSampler_BorderClampColor, |
| 3648 | "%s Creating a sampler object with border clamping and borderColor != VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK. " |
| 3649 | "This will lead to less efficient descriptors being created and may cause reduced performance. " |
| 3650 | "If possible, use VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK as the border color.", |
| 3651 | VendorSpecificTag(kBPVendorArm)); |
| 3652 | } |
| 3653 | |
| 3654 | if (pCreateInfo->unnormalizedCoordinates) { |
| 3655 | skip |= LogPerformanceWarning( |
| 3656 | device, kVUID_BestPractices_CreateSampler_UnnormalizedCoordinates, |
| 3657 | "%s Creating a sampler object with unnormalized coordinates. This will lead to less efficient " |
| 3658 | "descriptors being created and may cause reduced performance.", |
| 3659 | VendorSpecificTag(kBPVendorArm)); |
| 3660 | } |
| 3661 | |
| 3662 | if (pCreateInfo->anisotropyEnable) { |
| 3663 | skip |= LogPerformanceWarning( |
| 3664 | device, kVUID_BestPractices_CreateSampler_Anisotropy, |
| 3665 | "%s Creating a sampler object with anisotropy. This will lead to less efficient descriptors being created " |
| 3666 | "and may cause reduced performance.", |
| 3667 | VendorSpecificTag(kBPVendorArm)); |
| 3668 | } |
| 3669 | } |
| 3670 | |
| 3671 | return skip; |
| 3672 | } |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 3673 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3674 | void BestPractices::PreCallRecordCreateGraphicsPipelines(VkDevice device, VkPipelineCache pipelineCache, uint32_t createInfoCount, |
| 3675 | const VkGraphicsPipelineCreateInfo* pCreateInfos, |
| 3676 | const VkAllocationCallbacks* pAllocator, VkPipeline* pPipelines, |
| 3677 | void* cgpl_state) { |
| 3678 | ValidationStateTracker::PreCallRecordCreateGraphicsPipelines(device, pipelineCache, createInfoCount, pCreateInfos, pAllocator, |
| 3679 | pPipelines); |
| 3680 | // AMD best practice |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3681 | num_pso_ += createInfoCount; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3682 | } |
| 3683 | |
| 3684 | bool BestPractices::PreCallValidateUpdateDescriptorSets(VkDevice device, uint32_t descriptorWriteCount, |
| 3685 | const VkWriteDescriptorSet* pDescriptorWrites, uint32_t descriptorCopyCount, |
| 3686 | const VkCopyDescriptorSet* pDescriptorCopies) const { |
| 3687 | bool skip = false; |
| 3688 | if (VendorCheckEnabled(kBPVendorAMD)) { |
| 3689 | if (descriptorCopyCount > 0) { |
| 3690 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_AvoidCopyingDescriptors, |
| 3691 | "%s Performance warning: copying descriptor sets is not recommended", |
| 3692 | VendorSpecificTag(kBPVendorAMD)); |
| 3693 | } |
| 3694 | } |
| 3695 | |
| 3696 | return skip; |
| 3697 | } |
| 3698 | |
| 3699 | bool BestPractices::PreCallValidateCreateDescriptorUpdateTemplate(VkDevice device, |
| 3700 | const VkDescriptorUpdateTemplateCreateInfo* pCreateInfo, |
| 3701 | const VkAllocationCallbacks* pAllocator, |
| 3702 | VkDescriptorUpdateTemplate* pDescriptorUpdateTemplate) const { |
| 3703 | bool skip = false; |
| 3704 | if (VendorCheckEnabled(kBPVendorAMD)) { |
| 3705 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_UpdateDescriptors_PreferNonTemplate, |
| 3706 | "%s Performance warning: using DescriptorSetWithTemplate is not recommended. Prefer using " |
| 3707 | "vkUpdateDescriptorSet instead", |
| 3708 | VendorSpecificTag(kBPVendorAMD)); |
| 3709 | } |
| 3710 | |
| 3711 | return skip; |
| 3712 | } |
| 3713 | |
| 3714 | bool BestPractices::PreCallValidateCmdClearColorImage(VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout, |
| 3715 | const VkClearColorValue* pColor, uint32_t rangeCount, |
| 3716 | const VkImageSubresourceRange* pRanges) const { |
| 3717 | bool skip = false; |
| 3718 | if (VendorCheckEnabled(kBPVendorAMD)) { |
sfricke-samsung | ef15e48 | 2022-01-26 11:32:49 -0800 | [diff] [blame] | 3719 | skip |= LogPerformanceWarning( |
| 3720 | device, kVUID_BestPractices_ClearAttachment_ClearImage, |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3721 | "%s Performance warning: using vkCmdClearColorImage is not recommended. Prefer using LOAD_OP_CLEAR or " |
| 3722 | "vkCmdClearAttachments instead", |
| 3723 | VendorSpecificTag(kBPVendorAMD)); |
| 3724 | } |
| 3725 | |
| 3726 | return skip; |
| 3727 | } |
| 3728 | |
| 3729 | bool BestPractices::PreCallValidateCmdClearDepthStencilImage(VkCommandBuffer commandBuffer, VkImage image, |
| 3730 | VkImageLayout imageLayout, |
| 3731 | const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount, |
| 3732 | const VkImageSubresourceRange* pRanges) const { |
| 3733 | bool skip = false; |
| 3734 | if (VendorCheckEnabled(kBPVendorAMD)) { |
| 3735 | skip |= LogPerformanceWarning( |
| 3736 | device, kVUID_BestPractices_ClearAttachment_ClearImage, |
| 3737 | "%s Performance warning: using vkCmdClearDepthStencilImage is not recommended. Prefer using LOAD_OP_CLEAR or " |
| 3738 | "vkCmdClearAttachments instead", |
| 3739 | VendorSpecificTag(kBPVendorAMD)); |
| 3740 | } |
| 3741 | |
| 3742 | return skip; |
| 3743 | } |
| 3744 | |
| 3745 | bool BestPractices::PreCallValidateCreatePipelineLayout(VkDevice device, const VkPipelineLayoutCreateInfo* pCreateInfo, |
| 3746 | const VkAllocationCallbacks* pAllocator, |
| 3747 | VkPipelineLayout* pPipelineLayout) const { |
| 3748 | bool skip = false; |
| 3749 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3750 | uint32_t descriptor_size = enabled_features.core.robustBufferAccess ? 4 : 2; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3751 | // Descriptor sets cost 1 DWORD each. |
| 3752 | // Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. |
| 3753 | // Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. |
| 3754 | // Push constants cost 1 DWORD per 4 bytes in the Push constant range. |
| 3755 | uint32_t pipeline_size = pCreateInfo->setLayoutCount; // in DWORDS |
| 3756 | for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; i++) { |
Jeremy Gebben | 9f53710 | 2021-10-05 16:37:12 -0600 | [diff] [blame] | 3757 | auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3758 | pipeline_size += descriptor_set_layout_state->GetDynamicDescriptorCount() * descriptor_size; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3759 | } |
| 3760 | |
| 3761 | for (uint32_t i = 0; i < pCreateInfo->pushConstantRangeCount; i++) { |
| 3762 | pipeline_size += pCreateInfo->pPushConstantRanges[i].size / 4; |
| 3763 | } |
| 3764 | |
| 3765 | if (pipeline_size > kPipelineLayoutSizeWarningLimitAMD) { |
| 3766 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_CreatePipelinesLayout_KeepLayoutSmall, |
| 3767 | "%s Performance warning: pipeline layout size is too large. Prefer smaller pipeline layouts." |
| 3768 | "Descriptor sets cost 1 DWORD each. " |
| 3769 | "Dynamic buffers cost 2 DWORDs each when robust buffer access is OFF. " |
| 3770 | "Dynamic buffers cost 4 DWORDs each when robust buffer access is ON. " |
| 3771 | "Push constants cost 1 DWORD per 4 bytes in the Push constant range. ", |
| 3772 | VendorSpecificTag(kBPVendorAMD)); |
| 3773 | } |
| 3774 | } |
| 3775 | |
Rodrigo Locatti | 65b3383 | 2022-03-15 17:57:30 -0300 | [diff] [blame] | 3776 | if (VendorCheckEnabled(kBPVendorNVIDIA)) { |
| 3777 | bool has_separate_sampler = false; |
Rodrigo Locatti | 12f6ffc | 2022-03-15 18:29:11 -0300 | [diff] [blame] | 3778 | size_t fast_space_usage = 0; |
Rodrigo Locatti | 65b3383 | 2022-03-15 17:57:30 -0300 | [diff] [blame] | 3779 | |
| 3780 | for (uint32_t i = 0; i < pCreateInfo->setLayoutCount; ++i) { |
| 3781 | auto descriptor_set_layout_state = Get<cvdescriptorset::DescriptorSetLayout>(pCreateInfo->pSetLayouts[i]); |
| 3782 | for (const auto& binding : descriptor_set_layout_state->GetBindings()) { |
| 3783 | if (binding.descriptorType == VK_DESCRIPTOR_TYPE_SAMPLER) { |
| 3784 | has_separate_sampler = true; |
| 3785 | } |
Rodrigo Locatti | 12f6ffc | 2022-03-15 18:29:11 -0300 | [diff] [blame] | 3786 | |
| 3787 | if ((descriptor_set_layout_state->GetCreateFlags() & VK_DESCRIPTOR_SET_LAYOUT_CREATE_UPDATE_AFTER_BIND_POOL_BIT) == 0U) { |
| 3788 | size_t descriptor_type_size = 0; |
| 3789 | |
| 3790 | switch (binding.descriptorType) { |
| 3791 | case VK_DESCRIPTOR_TYPE_SAMPLER: |
| 3792 | case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER: |
| 3793 | case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE: |
| 3794 | case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE: |
| 3795 | case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER: |
| 3796 | case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER: |
| 3797 | case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT: |
| 3798 | descriptor_type_size = 4; |
| 3799 | break; |
| 3800 | case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER: |
| 3801 | case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC: |
| 3802 | case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR: |
| 3803 | case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_NV: |
| 3804 | descriptor_type_size = 8; |
| 3805 | break; |
| 3806 | case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER: |
| 3807 | case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC: |
| 3808 | case VK_DESCRIPTOR_TYPE_MUTABLE_VALVE: |
| 3809 | descriptor_type_size = 16; |
| 3810 | break; |
| 3811 | case VK_DESCRIPTOR_TYPE_INLINE_UNIFORM_BLOCK: |
| 3812 | descriptor_type_size = 1; |
| 3813 | default: |
| 3814 | // Unknown type. |
| 3815 | break; |
| 3816 | } |
| 3817 | |
| 3818 | size_t descriptor_size = descriptor_type_size * binding.descriptorCount; |
| 3819 | fast_space_usage += descriptor_size; |
| 3820 | } |
Rodrigo Locatti | 65b3383 | 2022-03-15 17:57:30 -0300 | [diff] [blame] | 3821 | } |
| 3822 | } |
| 3823 | |
| 3824 | if (has_separate_sampler) { |
| 3825 | skip |= LogPerformanceWarning( |
| 3826 | device, kVUID_BestPractices_CreatePipelineLayout_SeparateSampler, |
| 3827 | "%s Consider using combined image samplers instead of separate samplers for marginally better performance.", |
| 3828 | VendorSpecificTag(kBPVendorNVIDIA)); |
| 3829 | } |
Rodrigo Locatti | 12f6ffc | 2022-03-15 18:29:11 -0300 | [diff] [blame] | 3830 | |
| 3831 | if (fast_space_usage > kPipelineLayoutFastDescriptorSpaceNVIDIA) { |
| 3832 | skip |= LogPerformanceWarning( |
| 3833 | device, kVUID_BestPractices_CreatePipelinesLayout_LargePipelineLayout, |
| 3834 | "%s Pipeline layout size is too large, prefer using pipeline-specific descriptor set layouts. " |
| 3835 | "Aim for consuming less than %" PRIu32 " bytes to allow fast reads for all non-bindless descriptors. " |
| 3836 | "Samplers, textures, texel buffers, and combined image samplers consume 4 bytes each. " |
| 3837 | "Uniform buffers and acceleration structures consume 8 bytes. " |
| 3838 | "Storage buffers consume 16 bytes. " |
| 3839 | "Push constants do not consume space.", |
| 3840 | VendorSpecificTag(kBPVendorNVIDIA), kPipelineLayoutFastDescriptorSpaceNVIDIA); |
| 3841 | } |
Rodrigo Locatti | 65b3383 | 2022-03-15 17:57:30 -0300 | [diff] [blame] | 3842 | } |
| 3843 | |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3844 | return skip; |
| 3845 | } |
| 3846 | |
| 3847 | bool BestPractices::PreCallValidateCmdCopyImage(VkCommandBuffer commandBuffer, VkImage srcImage, VkImageLayout srcImageLayout, |
| 3848 | VkImage dstImage, VkImageLayout dstImageLayout, uint32_t regionCount, |
| 3849 | const VkImageCopy* pRegions) const { |
| 3850 | bool skip = false; |
| 3851 | std::stringstream src_image_hex; |
| 3852 | std::stringstream dst_image_hex; |
| 3853 | src_image_hex << "0x" << std::hex << HandleToUint64(srcImage); |
| 3854 | dst_image_hex << "0x" << std::hex << HandleToUint64(dstImage); |
| 3855 | |
| 3856 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 3857 | auto src_state = Get<IMAGE_STATE>(srcImage); |
| 3858 | auto dst_state = Get<IMAGE_STATE>(dstImage); |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3859 | |
| 3860 | if (src_state && dst_state) { |
| 3861 | VkImageTiling src_Tiling = src_state->createInfo.tiling; |
| 3862 | VkImageTiling dst_Tiling = dst_state->createInfo.tiling; |
| 3863 | if (src_Tiling != dst_Tiling && (src_Tiling == VK_IMAGE_TILING_LINEAR || dst_Tiling == VK_IMAGE_TILING_LINEAR)) { |
| 3864 | skip |= |
| 3865 | LogPerformanceWarning(device, kVUID_BestPractices_vkImage_AvoidImageToImageCopy, |
| 3866 | "%s Performance warning: image %s and image %s have differing tilings. Use buffer to " |
| 3867 | "image (vkCmdCopyImageToBuffer) " |
| 3868 | "and image to buffer (vkCmdCopyBufferToImage) copies instead of image to image " |
| 3869 | "copies when converting between linear and optimal images", |
| 3870 | VendorSpecificTag(kBPVendorAMD), src_image_hex.str().c_str(), dst_image_hex.str().c_str()); |
| 3871 | } |
| 3872 | } |
| 3873 | } |
| 3874 | |
| 3875 | return skip; |
| 3876 | } |
| 3877 | |
| 3878 | bool BestPractices::PreCallValidateCmdBindPipeline(VkCommandBuffer commandBuffer, VkPipelineBindPoint pipelineBindPoint, |
| 3879 | VkPipeline pipeline) const { |
| 3880 | bool skip = false; |
| 3881 | |
| 3882 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3883 | if (IsPipelineUsedInFrame(pipeline)) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3884 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_Pipeline_SortAndBind, |
| 3885 | "%s Performance warning: Pipeline %s was bound twice in the frame. Keep pipeline state changes to a minimum," |
| 3886 | "for example, by sorting draw calls by pipeline.", |
| 3887 | VendorSpecificTag(kBPVendorAMD), report_data->FormatHandle(pipeline).c_str()); |
| 3888 | } |
| 3889 | } |
| 3890 | |
| 3891 | return skip; |
| 3892 | } |
| 3893 | |
| 3894 | void BestPractices::ManualPostCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, |
| 3895 | VkFence fence, VkResult result) { |
| 3896 | // AMD best practice |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3897 | num_queue_submissions_ += submitCount; |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3898 | } |
| 3899 | |
| 3900 | bool BestPractices::PreCallValidateQueuePresentKHR(VkQueue queue, const VkPresentInfoKHR* pPresentInfo) const { |
| 3901 | bool skip = false; |
| 3902 | |
| 3903 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3904 | auto num = num_queue_submissions_.load(); |
| 3905 | if (num > kNumberOfSubmissionWarningLimitAMD) { |
| 3906 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_Submission_ReduceNumberOfSubmissions, |
| 3907 | "%s Performance warning: command buffers submitted %" PRId32 |
| 3908 | " times this frame. Submitting command buffers has a CPU " |
| 3909 | "and GPU overhead. Submit fewer times to incur less overhead.", |
| 3910 | VendorSpecificTag(kBPVendorAMD), num); |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3911 | } |
| 3912 | } |
| 3913 | |
| 3914 | return skip; |
| 3915 | } |
| 3916 | |
| 3917 | void BestPractices::PostCallRecordCmdPipelineBarrier(VkCommandBuffer commandBuffer, VkPipelineStageFlags srcStageMask, |
| 3918 | VkPipelineStageFlags dstStageMask, VkDependencyFlags dependencyFlags, |
| 3919 | uint32_t memoryBarrierCount, const VkMemoryBarrier* pMemoryBarriers, |
| 3920 | uint32_t bufferMemoryBarrierCount, |
| 3921 | const VkBufferMemoryBarrier* pBufferMemoryBarriers, |
| 3922 | uint32_t imageMemoryBarrierCount, |
| 3923 | const VkImageMemoryBarrier* pImageMemoryBarriers) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3924 | num_barriers_objects_ += (memoryBarrierCount + imageMemoryBarrierCount + bufferMemoryBarrierCount); |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3925 | } |
| 3926 | |
| 3927 | bool BestPractices::PreCallValidateCreateSemaphore(VkDevice device, const VkSemaphoreCreateInfo* pCreateInfo, |
| 3928 | const VkAllocationCallbacks* pAllocator, VkSemaphore* pSemaphore) const { |
| 3929 | bool skip = false; |
| 3930 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3931 | if (Count<SEMAPHORE_STATE>() > kMaxRecommendedSemaphoreObjectsSizeAMD) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3932 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfSemaphores, |
| 3933 | "%s Performance warning: High number of vkSemaphore objects created." |
| 3934 | "Minimize the amount of queue synchronization that is used. " |
| 3935 | "Semaphores and fences have overhead. Each fence has a CPU and GPU cost with it.", |
| 3936 | VendorSpecificTag(kBPVendorAMD)); |
| 3937 | } |
| 3938 | } |
| 3939 | |
| 3940 | return skip; |
| 3941 | } |
| 3942 | |
| 3943 | bool BestPractices::PreCallValidateCreateFence(VkDevice device, const VkFenceCreateInfo* pCreateInfo, |
| 3944 | const VkAllocationCallbacks* pAllocator, VkFence* pFence) const { |
| 3945 | bool skip = false; |
| 3946 | if (VendorCheckEnabled(kBPVendorAMD)) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 3947 | if (Count<FENCE_STATE>() > kMaxRecommendedFenceObjectsSizeAMD) { |
Nadav Geva | f080844 | 2021-05-21 13:51:25 -0400 | [diff] [blame] | 3948 | skip |= LogPerformanceWarning(device, kVUID_BestPractices_SyncObjects_HighNumberOfFences, |
| 3949 | "%s Performance warning: High number of VkFence objects created." |
| 3950 | "Minimize the amount of CPU-GPU synchronization that is used. " |
| 3951 | "Semaphores and fences have overhead.Each fence has a CPU and GPU cost with it.", |
| 3952 | VendorSpecificTag(kBPVendorAMD)); |
| 3953 | } |
| 3954 | } |
| 3955 | |
| 3956 | return skip; |
| 3957 | } |
| 3958 | |
Sam Walls | 8e77e4f | 2020-03-16 20:47:40 +0000 | [diff] [blame] | 3959 | void BestPractices::PostTransformLRUCacheModel::resize(size_t size) { _entries.resize(size); } |
| 3960 | |
| 3961 | bool BestPractices::PostTransformLRUCacheModel::query_cache(uint32_t value) { |
| 3962 | // look for a cache hit |
| 3963 | auto hit = std::find_if(_entries.begin(), _entries.end(), [value](const CacheEntry& entry) { return entry.value == value; }); |
| 3964 | if (hit != _entries.end()) { |
| 3965 | // mark the cache hit as being most recently used |
| 3966 | hit->age = iteration++; |
| 3967 | return true; |
| 3968 | } |
| 3969 | |
| 3970 | // if there's no cache hit, we need to model the entry being inserted into the cache |
| 3971 | CacheEntry new_entry = {value, iteration}; |
| 3972 | if (iteration < static_cast<uint32_t>(std::distance(_entries.begin(), _entries.end()))) { |
| 3973 | // if there is still space left in the cache, use the next available slot |
| 3974 | *(_entries.begin() + iteration) = new_entry; |
| 3975 | } else { |
| 3976 | // otherwise replace the least recently used cache entry |
| 3977 | auto lru = std::min_element(_entries.begin(), hit, [](const CacheEntry& a, const CacheEntry& b) { return a.age < b.age; }); |
| 3978 | *lru = new_entry; |
| 3979 | } |
| 3980 | iteration++; |
| 3981 | return false; |
| 3982 | } |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 3983 | |
| 3984 | bool BestPractices::PreCallValidateAcquireNextImageKHR(VkDevice device, VkSwapchainKHR swapchain, uint64_t timeout, |
| 3985 | VkSemaphore semaphore, VkFence fence, uint32_t* pImageIndex) const { |
Jeremy Gebben | f444939 | 2022-01-28 10:09:10 -0700 | [diff] [blame] | 3986 | auto swapchain_data = Get<SWAPCHAIN_NODE>(swapchain); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 3987 | bool skip = false; |
| 3988 | if (swapchain_data && swapchain_data->images.size() == 0) { |
| 3989 | skip |= LogWarning(swapchain, kVUID_Core_DrawState_SwapchainImagesNotFound, |
| 3990 | "vkAcquireNextImageKHR: No images found to acquire from. Application probably did not call " |
| 3991 | "vkGetSwapchainImagesKHR after swapchain creation."); |
| 3992 | } |
| 3993 | return skip; |
| 3994 | } |
| 3995 | |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 3996 | void BestPractices::CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(CALL_STATE& call_state, bool no_pointer) { |
| 3997 | if (no_pointer) { |
| 3998 | if (UNCALLED == call_state) { |
| 3999 | call_state = QUERY_COUNT; |
| 4000 | } |
| 4001 | } else { // Save queue family properties |
| 4002 | call_state = QUERY_DETAILS; |
| 4003 | } |
| 4004 | } |
| 4005 | |
Nathaniel Cesario | f121d12 | 2020-10-08 13:09:46 -0600 | [diff] [blame] | 4006 | void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(VkPhysicalDevice physicalDevice, |
| 4007 | uint32_t* pQueueFamilyPropertyCount, |
| 4008 | VkQueueFamilyProperties* pQueueFamilyProperties) { |
| 4009 | ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties(physicalDevice, pQueueFamilyPropertyCount, |
| 4010 | pQueueFamilyProperties); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4011 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4012 | if (bp_pd_state) { |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 4013 | CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyPropertiesState, |
| 4014 | nullptr == pQueueFamilyProperties); |
| 4015 | } |
| 4016 | } |
| 4017 | |
| 4018 | void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(VkPhysicalDevice physicalDevice, |
| 4019 | uint32_t* pQueueFamilyPropertyCount, |
| 4020 | VkQueueFamilyProperties2* pQueueFamilyProperties) { |
| 4021 | ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2(physicalDevice, pQueueFamilyPropertyCount, |
| 4022 | pQueueFamilyProperties); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4023 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 4024 | if (bp_pd_state) { |
| 4025 | CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2State, |
| 4026 | nullptr == pQueueFamilyProperties); |
| 4027 | } |
| 4028 | } |
| 4029 | |
| 4030 | void BestPractices::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(VkPhysicalDevice physicalDevice, |
| 4031 | uint32_t* pQueueFamilyPropertyCount, |
| 4032 | VkQueueFamilyProperties2* pQueueFamilyProperties) { |
| 4033 | ValidationStateTracker::PostCallRecordGetPhysicalDeviceQueueFamilyProperties2KHR(physicalDevice, pQueueFamilyPropertyCount, |
| 4034 | pQueueFamilyProperties); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4035 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 56a9665 | 2020-12-30 13:23:42 -0700 | [diff] [blame] | 4036 | if (bp_pd_state) { |
| 4037 | CommonPostCallRecordGetPhysicalDeviceQueueFamilyProperties(bp_pd_state->vkGetPhysicalDeviceQueueFamilyProperties2KHRState, |
| 4038 | nullptr == pQueueFamilyProperties); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4039 | } |
| 4040 | } |
| 4041 | |
Nathaniel Cesario | f121d12 | 2020-10-08 13:09:46 -0600 | [diff] [blame] | 4042 | void BestPractices::PostCallRecordGetPhysicalDeviceFeatures(VkPhysicalDevice physicalDevice, VkPhysicalDeviceFeatures* pFeatures) { |
| 4043 | ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures(physicalDevice, pFeatures); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4044 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4045 | if (bp_pd_state) { |
| 4046 | bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS; |
| 4047 | } |
| 4048 | } |
| 4049 | |
Nathaniel Cesario | f121d12 | 2020-10-08 13:09:46 -0600 | [diff] [blame] | 4050 | void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2(VkPhysicalDevice physicalDevice, |
| 4051 | VkPhysicalDeviceFeatures2* pFeatures) { |
| 4052 | ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2(physicalDevice, pFeatures); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4053 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4054 | if (bp_pd_state) { |
| 4055 | bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS; |
| 4056 | } |
| 4057 | } |
| 4058 | |
Nathaniel Cesario | f121d12 | 2020-10-08 13:09:46 -0600 | [diff] [blame] | 4059 | void BestPractices::PostCallRecordGetPhysicalDeviceFeatures2KHR(VkPhysicalDevice physicalDevice, |
| 4060 | VkPhysicalDeviceFeatures2* pFeatures) { |
| 4061 | ValidationStateTracker::PostCallRecordGetPhysicalDeviceFeatures2KHR(physicalDevice, pFeatures); |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4062 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4063 | if (bp_pd_state) { |
| 4064 | bp_pd_state->vkGetPhysicalDeviceFeaturesState = QUERY_DETAILS; |
| 4065 | } |
| 4066 | } |
| 4067 | |
| 4068 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilitiesKHR(VkPhysicalDevice physicalDevice, |
| 4069 | VkSurfaceKHR surface, |
| 4070 | VkSurfaceCapabilitiesKHR* pSurfaceCapabilities, |
| 4071 | VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4072 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4073 | if (bp_pd_state) { |
| 4074 | bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS; |
| 4075 | } |
| 4076 | } |
| 4077 | |
| 4078 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2KHR( |
| 4079 | VkPhysicalDevice physicalDevice, const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo, |
| 4080 | VkSurfaceCapabilities2KHR* pSurfaceCapabilities, VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4081 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4082 | if (bp_pd_state) { |
| 4083 | bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS; |
| 4084 | } |
| 4085 | } |
| 4086 | |
| 4087 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceCapabilities2EXT(VkPhysicalDevice physicalDevice, |
| 4088 | VkSurfaceKHR surface, |
| 4089 | VkSurfaceCapabilities2EXT* pSurfaceCapabilities, |
| 4090 | VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4091 | auto bp_pd_state = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4092 | if (bp_pd_state) { |
| 4093 | bp_pd_state->vkGetPhysicalDeviceSurfaceCapabilitiesKHRState = QUERY_DETAILS; |
| 4094 | } |
| 4095 | } |
| 4096 | |
| 4097 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfacePresentModesKHR(VkPhysicalDevice physicalDevice, |
| 4098 | VkSurfaceKHR surface, uint32_t* pPresentModeCount, |
| 4099 | VkPresentModeKHR* pPresentModes, VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4100 | auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4101 | if (bp_pd_data) { |
| 4102 | auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfacePresentModesKHRState; |
| 4103 | |
| 4104 | if (*pPresentModeCount) { |
| 4105 | if (call_state < QUERY_COUNT) { |
| 4106 | call_state = QUERY_COUNT; |
| 4107 | } |
| 4108 | } |
| 4109 | if (pPresentModes) { |
| 4110 | if (call_state < QUERY_DETAILS) { |
| 4111 | call_state = QUERY_DETAILS; |
| 4112 | } |
| 4113 | } |
| 4114 | } |
| 4115 | } |
| 4116 | |
| 4117 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormatsKHR(VkPhysicalDevice physicalDevice, VkSurfaceKHR surface, |
| 4118 | uint32_t* pSurfaceFormatCount, |
| 4119 | VkSurfaceFormatKHR* pSurfaceFormats, VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4120 | auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4121 | if (bp_pd_data) { |
| 4122 | auto& call_state = bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState; |
| 4123 | |
| 4124 | if (*pSurfaceFormatCount) { |
| 4125 | if (call_state < QUERY_COUNT) { |
| 4126 | call_state = QUERY_COUNT; |
| 4127 | } |
Jeremy Gebben | c7a834a | 2021-09-08 18:39:30 -0600 | [diff] [blame] | 4128 | bp_pd_data->surface_formats_count = *pSurfaceFormatCount; |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4129 | } |
| 4130 | if (pSurfaceFormats) { |
| 4131 | if (call_state < QUERY_DETAILS) { |
| 4132 | call_state = QUERY_DETAILS; |
| 4133 | } |
| 4134 | } |
| 4135 | } |
| 4136 | } |
| 4137 | |
| 4138 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceSurfaceFormats2KHR(VkPhysicalDevice physicalDevice, |
| 4139 | const VkPhysicalDeviceSurfaceInfo2KHR* pSurfaceInfo, |
| 4140 | uint32_t* pSurfaceFormatCount, |
| 4141 | VkSurfaceFormat2KHR* pSurfaceFormats, VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4142 | auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4143 | if (bp_pd_data) { |
| 4144 | if (*pSurfaceFormatCount) { |
| 4145 | if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_COUNT) { |
| 4146 | bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_COUNT; |
| 4147 | } |
Jeremy Gebben | c7a834a | 2021-09-08 18:39:30 -0600 | [diff] [blame] | 4148 | bp_pd_data->surface_formats_count = *pSurfaceFormatCount; |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4149 | } |
| 4150 | if (pSurfaceFormats) { |
| 4151 | if (bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState < QUERY_DETAILS) { |
| 4152 | bp_pd_data->vkGetPhysicalDeviceSurfaceFormatsKHRState = QUERY_DETAILS; |
| 4153 | } |
| 4154 | } |
| 4155 | } |
| 4156 | } |
| 4157 | |
| 4158 | void BestPractices::ManualPostCallRecordGetPhysicalDeviceDisplayPlanePropertiesKHR(VkPhysicalDevice physicalDevice, |
| 4159 | uint32_t* pPropertyCount, |
| 4160 | VkDisplayPlanePropertiesKHR* pProperties, |
| 4161 | VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4162 | auto bp_pd_data = Get<bp_state::PhysicalDevice>(physicalDevice); |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4163 | if (bp_pd_data) { |
| 4164 | if (*pPropertyCount) { |
| 4165 | if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_COUNT) { |
| 4166 | bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_COUNT; |
| 4167 | } |
| 4168 | } |
| 4169 | if (pProperties) { |
| 4170 | if (bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState < QUERY_DETAILS) { |
| 4171 | bp_pd_data->vkGetPhysicalDeviceDisplayPlanePropertiesKHRState = QUERY_DETAILS; |
| 4172 | } |
| 4173 | } |
| 4174 | } |
| 4175 | } |
| 4176 | |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4177 | void BestPractices::ManualPostCallRecordGetSwapchainImagesKHR(VkDevice device, VkSwapchainKHR swapchain, |
| 4178 | uint32_t* pSwapchainImageCount, VkImage* pSwapchainImages, |
| 4179 | VkResult result) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4180 | auto swapchain_state = Get<bp_state::Swapchain>(swapchain); |
Nathaniel Cesario | 39152e6 | 2021-07-02 13:04:16 -0600 | [diff] [blame] | 4181 | if (swapchain_state && (pSwapchainImages || *pSwapchainImageCount)) { |
| 4182 | if (swapchain_state->vkGetSwapchainImagesKHRState < QUERY_DETAILS) { |
| 4183 | swapchain_state->vkGetSwapchainImagesKHRState = QUERY_DETAILS; |
Nathaniel Cesario | 24184fe | 2020-10-06 12:46:12 -0600 | [diff] [blame] | 4184 | } |
| 4185 | } |
| 4186 | } |
| 4187 | |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 4188 | void BestPractices::PreCallRecordQueueSubmit(VkQueue queue, uint32_t submitCount, const VkSubmitInfo* pSubmits, VkFence fence) { |
| 4189 | ValidationStateTracker::PreCallRecordQueueSubmit(queue, submitCount, pSubmits, fence); |
| 4190 | |
Jeremy Gebben | b20a824 | 2021-11-05 15:14:43 -0600 | [diff] [blame] | 4191 | auto queue_state = Get<QUEUE_STATE>(queue); |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 4192 | for (uint32_t submit = 0; submit < submitCount; submit++) { |
Hans-Kristian Arntzen | 69ace7d | 2021-04-28 14:17:19 +0200 | [diff] [blame] | 4193 | const auto& submit_info = pSubmits[submit]; |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 4194 | for (uint32_t cb_index = 0; cb_index < submit_info.commandBufferCount; cb_index++) { |
Jeremy Gebben | 20da7a1 | 2022-02-25 14:07:46 -0700 | [diff] [blame] | 4195 | auto cb = GetWrite<bp_state::CommandBuffer>(submit_info.pCommandBuffers[cb_index]); |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 4196 | for (auto &func : cb->queue_submit_functions) { |
Jeremy Gebben | e5361dd | 2021-11-18 14:23:56 -0700 | [diff] [blame] | 4197 | func(*this, *queue_state, *cb); |
Hans-Kristian Arntzen | 66f4b52 | 2021-03-22 11:35:58 +0100 | [diff] [blame] | 4198 | } |
| 4199 | } |
| 4200 | } |
| 4201 | } |