From 75befa30d8482c220f43e36ad2556a30ee701567 Mon Sep 17 00:00:00 2001
From: baldurk <baldurk@baldurk.org>
Date: Wed, 29 Apr 2020 11:42:29 +0100
Subject: [PATCH] Support workgroup private variables in debugging

* We don't simulate other threads so this will be similar to groupshared on
  D3D11 which doesn't have accurate contents.
---
 renderdoc/driver/shaders/spirv/spirv_debug.h  |  3 ++
 .../shaders/spirv/spirv_debug_setup.cpp       | 37 ++++++++++++++++---
 2 files changed, 35 insertions(+), 5 deletions(-)

diff --git a/renderdoc/driver/shaders/spirv/spirv_debug.h b/renderdoc/driver/shaders/spirv/spirv_debug.h
index 06c8158fe..3bd7d8fca 100644
--- a/renderdoc/driver/shaders/spirv/spirv_debug.h
+++ b/renderdoc/driver/shaders/spirv/spirv_debug.h
@@ -128,6 +128,9 @@ public:
   // allocated storage for opaque uniform blocks, does not change over the course of debugging
   rdcarray<ShaderVariable> constantBlocks;
 
+  // workgroup private variables
+  rdcarray<ShaderVariable> workgroups;
+
   // resources may be read-write but the variable itself doesn't change
   rdcarray<ShaderVariable> readOnlyResources;
   rdcarray<ShaderVariable> readWriteResources;
diff --git a/renderdoc/driver/shaders/spirv/spirv_debug_setup.cpp b/renderdoc/driver/shaders/spirv/spirv_debug_setup.cpp
index 2660fb891..85b80c8d6 100644
--- a/renderdoc/driver/shaders/spirv/spirv_debug_setup.cpp
+++ b/renderdoc/driver/shaders/spirv/spirv_debug_setup.cpp
@@ -444,7 +444,8 @@ ShaderDebugTrace *Debugger::BeginDebug(DebugAPIWrapper *apiWrapper, const Shader
   MakeSignatureNames(patchData.inputs, inputSigNames);
   MakeSignatureNames(patchData.outputs, outputSigNames);
 
-  rdcarray<Id> inputIDs, outputIDs, cbufferIDs, readOnlyIDs, readWriteIDs, samplerIDs, privateIDs;
+  rdcarray<Id> inputIDs, outputIDs, cbufferIDs, readOnlyIDs, readWriteIDs, samplerIDs, privateIDs,
+      workgroupIDs;
 
   // allocate storage for globals with opaque storage classes, and prepare to set up pointers to
   // them for the global variables themselves
@@ -722,9 +723,9 @@ ShaderDebugTrace *Debugger::BeginDebug(DebugAPIWrapper *apiWrapper, const Shader
 
       globalSourceVars.push_back(sourceVar);
     }
-    else if(v.storage == StorageClass::Private)
+    else if(v.storage == StorageClass::Private || v.storage == StorageClass::Workgroup)
     {
-      // private variables are allocated as globals the same as outputs
+      // private variables are allocated as globals. Similar to outputs
       ShaderVariable var;
       var.name = GetRawName(v.id);
 
@@ -739,8 +740,16 @@ ShaderDebugTrace *Debugger::BeginDebug(DebugAPIWrapper *apiWrapper, const Shader
       AllocateVariable(decorations[v.id], decorations[v.id], DebugVariableType::Variable,
                        sourceName, decorations[v.id].location, dataTypes[type.InnerType()], var);
 
-      active.privates.push_back(var);
-      privateIDs.push_back(v.id);
+      if(v.storage == StorageClass::Private)
+      {
+        active.privates.push_back(var);
+        privateIDs.push_back(v.id);
+      }
+      else if(v.storage == StorageClass::Workgroup)
+      {
+        global.workgroups.push_back(var);
+        workgroupIDs.push_back(v.id);
+      }
     }
     else
     {
@@ -750,6 +759,7 @@ ShaderDebugTrace *Debugger::BeginDebug(DebugAPIWrapper *apiWrapper, const Shader
 
   std::sort(outputIDs.begin(), outputIDs.end());
   std::sort(privateIDs.begin(), privateIDs.end());
+  std::sort(workgroupIDs.begin(), workgroupIDs.end());
 
   for(uint32_t i = 0; i < workgroupSize; i++)
   {
@@ -780,11 +790,14 @@ ShaderDebugTrace *Debugger::BeginDebug(DebugAPIWrapper *apiWrapper, const Shader
       lane.ids[samplerIDs[i]] = MakePointerVariable(samplerIDs[i], &global.samplers[i]);
     for(size_t i = 0; i < lane.privates.size(); i++)
       lane.ids[privateIDs[i]] = MakePointerVariable(privateIDs[i], &lane.privates[i]);
+    for(size_t i = 0; i < global.workgroups.size(); i++)
+      lane.ids[workgroupIDs[i]] = MakePointerVariable(workgroupIDs[i], &global.workgroups[i]);
   }
 
   // only outputs and privates are considered mutable
   liveGlobals.append(outputIDs);
   liveGlobals.append(privateIDs);
+  liveGlobals.append(workgroupIDs);
 
   for(size_t i = 0; i < globalSourceVars.size();)
   {
@@ -830,6 +843,20 @@ ShaderDebugTrace *Debugger::BeginDebug(DebugAPIWrapper *apiWrapper, const Shader
     }
   }
 
+  for(size_t o = 0; o < workgroupIDs.size(); o++)
+  {
+    rdcstr varName = GetRawName(workgroupIDs[o]);
+
+    for(size_t i = 0; i < globalSourceVars.size(); i++)
+    {
+      if(!globalSourceVars[i].variables.empty() && globalSourceVars[i].variables[0].name == varName)
+      {
+        ret->sourceVars.push_back(globalSourceVars[i]);
+        break;
+      }
+    }
+  }
+
   ret->lineInfo.resize(instructionOffsets.size());
   for(size_t i = 0; i < instructionOffsets.size(); i++)
   {