gpu: Fix/Improve shader error messages

Author: spencer-lunarg

BUILD.gn

@@ -191,7 +191,6 @@ vvl_sources = [
   "layers/gpu/debug_printf/debug_printf.cpp",
   "layers/gpu/debug_printf/debug_printf.h",
   "layers/gpu/error_message/gpuav_error_message.cpp",
-  "layers/gpu/error_message/gpuav_error_message.h",
   "layers/gpu/error_message/gpuav_vuids.cpp",
   "layers/gpu/error_message/gpuav_vuids.h",
   "layers/gpu/instrumentation/gpu_shader_instrumentor.cpp",

docs/gpu_validation.md

@@ -142,12 +142,16 @@ The array of combined image samplers is `tex` and has 6 samplers in the array.
 The complete validation error message issued when `tex_ind` indexes past the array is:
 
 ```terminal
-ERROR : VALIDATION - Message Id Number: 0 | Message Id Name: UNASSIGNED-Image descriptor index out of bounds
-        Index of 6 used to index descriptor array of length 6.  Command buffer (CubeDrawCommandBuf)(0xbc24b0).
-        Pipeline (0x45). Shader Module (0x43). Shader Instruction Index = 108.  Stage = Fragment.
-        Fragment coord (x,y) = (419.5, 254.5). Shader validation error occurred in file:
-        /home/user/src/Vulkan-ValidationLayers/external/Vulkan-Tools/cube/cube.frag at line 45.
-45:    uFragColor = light * texture(tex[tex_ind], texcoord.xy);
+Validation Error: [ UNASSIGNED-Image descriptor index out of bounds ] | vkCmdDrawIndexed(): Index of 6 used to index descriptor array of length 6.
+Stage = Fragment. Fragment coord (x,y) = (419.5, 254.5)
+Command buffer (CubeDrawCommandBuf)(0xbc24b0)
+	Draw Index 2
+Pipeline (0x45)
+Shader Module (0x43)
+Shader Instruction Index = 108
+Shader validation error occurred in file Vulkan-Tools/cube/cube.frag at line 45
+
+    uFragColor = light * texture(tex[tex_ind], texcoord.xy);
 ```
 The VK_EXT_descriptor_indexing extension allows a shader to declare a descriptor array without specifying its size
 ```glsl

layers/CMakeLists.txt

@@ -244,7 +244,6 @@ target_sources(vvl PRIVATE
     gpu/debug_printf/debug_printf.cpp
     gpu/debug_printf/debug_printf.h
     gpu/error_message/gpuav_error_message.cpp
-    gpu/error_message/gpuav_error_message.h
     gpu/error_message/gpuav_vuids.cpp
     gpu/error_message/gpuav_vuids.h
     gpu/instrumentation/gpu_shader_instrumentor.cpp

layers/gpu/core/gpuav.h

@@ -17,7 +17,6 @@
 
 #pragma once
 
-#include "gpu/error_message/gpuav_error_message.h"
 #include "gpu/descriptor_validation/gpuav_descriptor_set.h"
 #include "gpu/resources/gpu_resources.h"
 #include "gpu/instrumentation/gpu_shader_instrumentor.h"

layers/gpu/debug_printf/debug_printf.cpp

@@ -294,24 +294,24 @@ void Validator::AnalyzeAndGenerateMessage(VkCommandBuffer command_buffer, VkQueu
     uint32_t index = spvtools::kDebugOutputDataOffset;
     while (debug_output_buffer[index]) {
         std::stringstream shader_message;
-        VkShaderModule shader_module_handle = VK_NULL_HANDLE;
-        VkPipeline pipeline_handle = VK_NULL_HANDLE;
-        VkShaderEXT shader_object_handle = VK_NULL_HANDLE;
-        vvl::span<const uint32_t> instrumented_spirv;
 
         OutputRecord *debug_record = reinterpret_cast<OutputRecord *>(&debug_output_buffer[index]);
         // Lookup the VkShaderModule handle and SPIR-V code used to create the shader, using the unique shader ID value returned
         // by the instrumented shader.
+        const gpu::GpuAssistedShaderTracker *tracker_info = nullptr;
         auto it = shader_map_.find(debug_record->shader_id);
         if (it != shader_map_.end()) {
-            shader_module_handle = it->second.shader_module;
-            pipeline_handle = it->second.pipeline;
-            shader_object_handle = it->second.shader_object;
-            instrumented_spirv = it->second.instrumented_spirv;
+            tracker_info = &it->second;
         }
-        ASSERT_AND_RETURN(!instrumented_spirv.empty());
+
+        // without the instrumented spirv, there is nothing valuable to print out
+        if (!tracker_info || tracker_info->instrumented_spirv.empty()) {
+            InternalWarning(queue, loc, "Can't find instructions from any handles in shader_map");
+            return;
+        }
+
         std::vector<spirv::Instruction> instructions;
-        spirv::GenerateInstructions(instrumented_spirv, instructions);
+        spirv::GenerateInstructions(tracker_info->instrumented_spirv, instructions);
 
         // Search through the shader source for the printf format string for this invocation
         const std::string format_string = FindFormatString(instructions, debug_record->format_string_id);
@@ -378,20 +378,15 @@ void Validator::AnalyzeAndGenerateMessage(VkCommandBuffer command_buffer, VkQueu
         }
 
         if (verbose) {
-            std::string common_message;
-            std::string filename_message;
-            std::string source_message;
-            UtilGenerateCommonMessage(debug_report, command_buffer, &debug_output_buffer[index], shader_module_handle,
-                                      pipeline_handle, shader_object_handle, buffer_info.pipeline_bind_point, operation_index,
-                                      common_message);
-            UtilGenerateSourceMessages(instructions, &debug_output_buffer[index], true, filename_message, source_message);
+            std::string debug_info_message =
+                GenerateDebugInfoMessage(command_buffer, instructions, debug_record->instruction_position, tracker_info,
+                                         buffer_info.pipeline_bind_point, operation_index);
             if (use_stdout) {
-                std::cout << "WARNING-DEBUG-PRINTF " << shader_message.str().c_str() << "\n"
-                          << common_message.c_str() << " " << filename_message.c_str() << " " << source_message.c_str();
+                std::cout << "WARNING-DEBUG-PRINTF " << shader_message.str() << "\n" << debug_info_message;
             } else {
-                LogInfo("WARNING-DEBUG-PRINTF", queue, loc, "%s\n%s%s%s", shader_message.str().c_str(), common_message.c_str(),
-                        filename_message.c_str(), source_message.c_str());
+                LogInfo("WARNING-DEBUG-PRINTF", queue, loc, "%s\n%s", shader_message.str().c_str(), debug_info_message.c_str());
             }
+
         } else {
             if (use_stdout) {
                 std::cout << shader_message.str();

layers/gpu/debug_printf/debug_printf.h

@@ -18,7 +18,6 @@
 #pragma once
 
 #include "gpu/core/gpu_state_tracker.h"
-#include "gpu/error_message/gpuav_error_message.h"
 #include "gpu/instrumentation/gpu_shader_instrumentor.h"
 
 namespace debug_printf {