From 7ebd608cbe185fc2bbcdc03cc22e50ec74b8db41 Mon Sep 17 00:00:00 2001
From: Jake Turner <jake@evansturner.co.uk>
Date: Mon, 24 Feb 2025 16:35:37 +0000
Subject: [PATCH] Add basic compute shader debug test action to iter_test

Does not check any output, purely runs DebugThread on a random groupId and threadId
---
 util/test/tests/Iter_Test.py | 42 ++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/util/test/tests/Iter_Test.py b/util/test/tests/Iter_Test.py
index 8cf02fdbc..43fe94f37 100644
--- a/util/test/tests/Iter_Test.py
+++ b/util/test/tests/Iter_Test.py
@@ -50,6 +50,46 @@ class Iter_Test(rdtest.TestCase):
 
         rdtest.log.success('Successfully saved images at {}'.format(action.eventId))
 
+    def compute_debug(self, action: rd.ActionDescription):
+        pipe: rd.PipeState = self.controller.GetPipelineState()
+
+        refl: rd.ShaderReflection = pipe.GetShaderReflection(rd.ShaderStage.Compute)
+
+        if pipe.GetShader(rd.ShaderStage.Compute) == rd.ResourceId.Null():
+            rdtest.log.print(f"No compute shader bound at {action.eventId}")
+            return
+
+        if not (action.flags & rd.ActionFlags.Dispatch) and action.drawIndex == 0:
+            rdtest.log.print(f"{action.eventId} is not a debuggable action")
+            return
+
+        wgSize = action.dispatchDimension
+        if any(dim == 0 for dim in wgSize):
+            rdtest.log.print(f"Empty dispatch ({wgSize[0]}x{wgSize[1]}x{wgSize[2]}), skipping")
+            return
+
+        groupid = [0,0,0]
+        for i in range(3):
+            groupid[i] = random.randint(0, wgSize[i]-1)
+
+        threadid = [0,0,0]
+        for i in range(3):
+            threadid[i] = random.randint(0, refl.dispatchThreadsDimension[i]-1)
+
+        rdtest.log.print(f"Debug Thread Workgroup:{wgSize} groupid:{tuple(groupid)} threadid:{tuple(threadid)}")
+        trace: rd.ShaderDebugTrace = self.controller.DebugThread(tuple(groupid), tuple(threadid))
+
+        if trace.debugger is None:
+            self.controller.FreeTrace(trace)
+            rdtest.log.print("No debug result")
+            return
+
+        cycles, variables = self.process_trace(trace)
+
+        rdtest.log.success(f'Successfully debugged compute shader in {cycles} cycles {len(refl.outputSignature)}')
+
+        self.controller.FreeTrace(trace)
+
     def vert_debug(self, action: rd.ActionDescription):
         pipe: rd.PipeState = self.controller.GetPipelineState()
 
@@ -364,6 +404,7 @@ class Iter_Test(rdtest.TestCase):
 
         test_chance = 0.1       # Chance of doing anything at all
         do_image_save = 0.25    # Chance of saving images of the outputs
+        do_compute_debug = 1.0  # Chance of debugging a compute thread
         do_vert_debug = 1.0     # Chance of debugging a vertex (if valid)
         do_pixel_debug = 1.0    # Chance of doing pixel history at the current event and debugging a pixel (if valid)
         mesh_output = 1.0       # Chance of fetching mesh output data
@@ -373,6 +414,7 @@ class Iter_Test(rdtest.TestCase):
 
         event_tests = {
             'Image Save': {'chance': do_image_save, 'func': self.image_save},
+            'Compute Debug': {'chance': do_compute_debug, 'func': self.compute_debug},
             'Vertex Debug': {'chance': do_vert_debug, 'func': self.vert_debug},
             'Pixel History & Debug': {'chance': do_pixel_debug, 'func': self.pixel_debug},
             'Mesh Output': {'chance': mesh_output, 'func': self.mesh_output},