layers: Upstream misc DebugDescriptor

Author: spencer-lunarg

layers/gpu_dump/gpu_dump_descriptor.cpp

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-#include "containers/custom_containers.h"
 #include "containers/limits.h"
 #include "gpu_dump_state.h"
 #include "gpu_dump.h"
@@ -36,66 +35,10 @@
 #include "state_tracker/shader_object_state.h"
 #include "state_tracker/shader_stage_state.h"
 #include "state_tracker/state_tracker.h"
+#include "utils/vk_api_utils.h"
 
 namespace gpudump {
 
-static size_t GetDescriptorBufferSize(const VkPhysicalDeviceDescriptorBufferPropertiesEXT& props, bool robust,
-                                      VkDescriptorType type) {
-    switch (type) {
-        case VK_DESCRIPTOR_TYPE_SAMPLER:
-            return props.samplerDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
-            return props.combinedImageSamplerDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
-            return props.sampledImageDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
-            return props.storageImageDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
-            return robust ? props.robustUniformTexelBufferDescriptorSize : props.uniformTexelBufferDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
-            return robust ? props.robustStorageTexelBufferDescriptorSize : props.storageTexelBufferDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
-            return robust ? props.robustUniformBufferDescriptorSize : props.uniformBufferDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
-            return robust ? props.robustStorageBufferDescriptorSize : props.storageBufferDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
-            return props.inputAttachmentDescriptorSize;
-        case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
-            return props.accelerationStructureDescriptorSize;
-        default:
-            break;
-    }
-    return 0;
-}
-
-static const char* DescribeDescriptorBufferSize(bool robust, VkDescriptorType type) {
-    switch (type) {
-        case VK_DESCRIPTOR_TYPE_SAMPLER:
-            return "samplerDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
-            return "combinedImageSamplerDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
-            return "sampledImageDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
-            return "storageImageDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
-            return robust ? "robustUniformTexelBufferDescriptorSize" : "uniformTexelBufferDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
-            return robust ? "robustStorageTexelBufferDescriptorSize" : "storageTexelBufferDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
-            return robust ? "robustUniformBufferDescriptorSize" : "uniformBufferDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
-            return robust ? "robustStorageBufferDescriptorSize" : "storageBufferDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
-            return "inputAttachmentDescriptorSize";
-        case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
-            return "accelerationStructureDescriptorSize";
-        default:
-            break;
-    }
-    return "[Unknown]";
-}
-
 void CommandBufferSubState::DumpDescriptorBuffer(std::ostringstream& ss, const LastBound& last_bound) const {
     const vvl::CommandBuffer& cb_state = last_bound.cb_state;
     ss << "vkCmdBindDescriptorBuffersEXT last bound the following descriptor buffers:\n";

layers/gpuav/core/gpuav_setup.cpp

@@ -438,6 +438,17 @@ struct RayTracingBuffersConsistency : public Setting {
                "gpuav_ray_tracing_buffers_consistency]\n";
     }
 };
+
+struct DebugDescriptor : public Setting {
+    bool IsEnabled(const GpuAVSettings& settings) { return settings.debug_descriptor_enabled; }
+    bool HasRequiredFeatures(const DeviceFeatures& features) { return features.shaderInt64; }
+    void Disable(GpuAVSettings& settings) { settings.debug_descriptor_enabled = false; }
+    std::string DisableMessage() {
+        return "\tDebug Descriptor option was enabled, but the shaderInt64 feature is not supported. [Disabling "
+               "debug_descriptor]\n";
+    }
+};
+
 }  // namespace setting
 
 // At this point extensions/features may have been turned on by us in PreCallRecord.
@@ -451,8 +462,10 @@ void Validator::InitSettings(const Location& loc) {
     setting::BufferContent buffer_content;
     setting::AccelerationStructuresBuild as_builds;
     setting::RayTracingBuffersConsistency rt_buffers_consistency;
-    std::array<setting::Setting*, 8> all_settings = {&buffer_device_address, &ray_query,      &trace_ray, &mesh_shading,
-                                                     &buffer_copies,         &buffer_content, &as_builds, &rt_buffers_consistency};
+    setting::DebugDescriptor debug_descriptor;
+    std::array<setting::Setting*, 9> all_settings = {&buffer_device_address, &ray_query,      &trace_ray, &mesh_shading,
+                                                     &buffer_copies,         &buffer_content, &as_builds, &rt_buffers_consistency,
+                                                     &debug_descriptor};
 
     std::string adjustment_warnings;
     for (auto& setting_object : all_settings) {

layers/gpuav/spirv/debug_descriptor_pass.cpp

@@ -50,6 +50,11 @@ void DebugDescriptorPass::CreateFunctionCall(BasicBlock& block, InstructionIt* i
 }
 
 bool DebugDescriptorPass::Instrument() {
+    if (module_.interface_.descriptor_mode != vvl::DescriptorModeBuffer &&
+        module_.interface_.descriptor_mode != vvl::DescriptorModeHeap) {
+        return false;
+    }
+
     for (const auto& inst : module_.ext_inst_imports_) {
         const char* import_string = inst->GetAsString(2);
         if (strcmp(import_string, "NonSemantic.DebugDescriptor") == 0) {

layers/utils/vk_api_utils.h

@@ -21,6 +21,7 @@
 
 // This file should not need to include anything else, the goal of this file is utils that "could" be in the Vulkan-Headers
 #include <vulkan/vulkan_core.h>
+#include <vulkan/utility/vk_struct_helper.hpp>
 
 // It is very rare to have more than 3 stages (really only geo/tess) and better to save memory/time for the 99% use cases
 static const uint32_t kCommonMaxGraphicsShaderStages = 3;
@@ -209,3 +210,60 @@ static constexpr bool IsDescriptorHeapImage(const VkDescriptorType type) {
 static constexpr bool IsDescriptorHeapTensor(const VkDescriptorType type) {
     return (type == VK_DESCRIPTOR_TYPE_TENSOR_ARM);
 }
+
+static inline size_t GetDescriptorBufferSize(const VkPhysicalDeviceDescriptorBufferPropertiesEXT& props, bool robust,
+                                             VkDescriptorType type) {
+    switch (type) {
+        case VK_DESCRIPTOR_TYPE_SAMPLER:
+            return props.samplerDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
+            return props.combinedImageSamplerDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
+            return props.sampledImageDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
+            return props.storageImageDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
+            return robust ? props.robustUniformTexelBufferDescriptorSize : props.uniformTexelBufferDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
+            return robust ? props.robustStorageTexelBufferDescriptorSize : props.storageTexelBufferDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
+            return robust ? props.robustUniformBufferDescriptorSize : props.uniformBufferDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
+            return robust ? props.robustStorageBufferDescriptorSize : props.storageBufferDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
+            return props.inputAttachmentDescriptorSize;
+        case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
+            return props.accelerationStructureDescriptorSize;
+        default:
+            break;
+    }
+    return 0;
+}
+
+static inline const char* DescribeDescriptorBufferSize(bool robust, VkDescriptorType type) {
+    switch (type) {
+        case VK_DESCRIPTOR_TYPE_SAMPLER:
+            return "samplerDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER:
+            return "combinedImageSamplerDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE:
+            return "sampledImageDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_STORAGE_IMAGE:
+            return "storageImageDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER:
+            return robust ? "robustUniformTexelBufferDescriptorSize" : "uniformTexelBufferDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER:
+            return robust ? "robustStorageTexelBufferDescriptorSize" : "storageTexelBufferDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER:
+            return robust ? "robustUniformBufferDescriptorSize" : "uniformBufferDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_STORAGE_BUFFER:
+            return robust ? "robustStorageBufferDescriptorSize" : "storageBufferDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT:
+            return "inputAttachmentDescriptorSize";
+        case VK_DESCRIPTOR_TYPE_ACCELERATION_STRUCTURE_KHR:
+            return "accelerationStructureDescriptorSize";
+        default:
+            break;
+    }
+    return "[Unknown]";
+}