Files
renderdoc/util/test/tests/Vulkan/VK_Resource_Usage.py
T
Jake Turner bf6fe56c5b VK_Resource_Usage improvements
- add secondary commands buffers to Submit() calls so they get put back into the command buffer pool
- fix validation error about renderEndSemaphore
- fix sync validation errors
- add more names to objects
- fix some incorrect names
- move the pipeline bind to after marker "DrawIndirect: Single"
- add marker to start and end of EIDS which should be tracked for resource usage
- add a per frame update descriptorset
- bind compute descriptor sets before binding compute pipelines

- Remove hard coded EIDs from VK_Resource_Usage python
2026-11-03 10:52:15 +00:00

401 lines
24 KiB
Python

from typing import Dict, List, Tuple
import renderdoc as rd
import rdtest
class VK_Resource_Usage(rdtest.TestCase):
demos_test_name = 'VK_Resource_Usage'
resourceUsages: Dict[rd.ResourceId, List[rd.EventUsage]] = {}
eids: List[int] = []
markerStart = 0
markerEnd = 0
def add_action(self, action: rd.ActionDescription):
self.eids.append(action.eventId)
for c in action.children:
self.add_action(c)
for e in action.events:
self.eids.append(e.eventId)
def check_resource_usage(self, res: rd.ResourceDescription, expectedUsages: List[Tuple[int,rd.ResourceUsage]]):
usages = self.resourceUsages[res.resourceId]
if len(usages) == 1 and usages[0].eventId == 0 and usages[0].usage == rd.ResourceUsage.Unused:
resUsages = usages
else:
resUsages = [u for u in usages if u.eventId >= self.markerStart and u.eventId <= self.markerEnd]
rdtest.log.print(f"Resource '{res.name}' type:{res.type.name} {res.resourceId} usages:{len(resUsages)} expectedUsages:{len(expectedUsages)}")
if len(resUsages) != len(expectedUsages):
rdtest.log.print(f"Usages for Resource '{res.name}' {res.resourceId}")
for u in resUsages:
rdtest.log.print(f"EID:{u.eventId} usage:{u.usage.name}")
rdtest.log.print(f"Expected Usages for Resource '{res.name}' {res.resourceId}")
for u in expectedUsages:
eid, usage = u
rdtest.log.print(f"EID:{eid} usage:{usage.name}")
raise rdtest.TestFailureException(f"'{res.name}' {res.resourceId} Incorrect resource usages count expected:{len(expectedUsages)} actual:{len(resUsages)}")
for i, u in enumerate(resUsages):
eid, usage = expectedUsages[i]
if u.usage != usage:
raise rdtest.TestFailureException(f"'{res.name}' {res.resourceId} EID:{u.eventId} Incorrect resource usage expected:{usage.name} actual:{u.usage.name}")
if u.eventId != eid:
raise rdtest.TestFailureException(f"'{res.name}' {res.resourceId} usage:{u.usage.name} Incorrect resource usage EID expected:{eid} actual:{u.eventId}")
def check_capture(self):
assert self.controller is not None
# Cache the resource usage before running any replay i.e. without calling SetFrameEvent
resources = self.controller.GetResources()
for res in resources:
self.resourceUsages[res.resourceId] = self.controller.GetUsage(res.resourceId)
drawIndirectCount = self.find_action("Draw Indirect Count") is not None
rdtest.log.print(f"Has Draw Indirect Count: {'Yes' if drawIndirectCount else 'No'}")
nestedSecondaries = self.find_action("Nested Secondary Command Buffer") is not None
rdtest.log.print(f"Has Nested Secondary Command Buffer: {'Yes' if nestedSecondaries else 'No'}")
descBuffer = self.find_action("Descriptor Buffer") is not None
rdtest.log.print(f"Has Descriptor Buffer: {'Yes' if descBuffer else 'No'}")
meshShader = self.find_action("Mesh Shader") is not None
rdtest.log.print(f"Has Mesh Shader: {'Yes' if meshShader else 'No'}")
# Walk the actions finding all the Dispatch, Draw, DrawIndexed, DrawIndirect, DrawIndirectCount
sdfile = self.controller.GetStructuredFile()
actions = self.controller.GetRootActions().copy()
drawEIDs: List[int] = []
meshDispatchEIDs: List[int] = []
indexedEIDs: List[int] = []
indexedSpecialEIDs: List[int] = []
dispatchEIDs: List[int] = []
indirectEIDs: List[int] = []
multiEIDs: List[int] = []
indirectCountEIDs: List[int] = []
submitEIDs: List[int] = []
waitFencesEIDs: List[int] = []
resetFencesEIDs: List[int] = []
descSetDrawEIDs: List[int] = []
descBufferDrawEIDs: List[int] = []
cmdDrawIndirectEIDs: List[int] = []
cmdMeshDispatchIndirectEIDs: List[int] = []
endRenderPassEIDs : List[int] = []
fillBufferEIDs: List[int] = []
copyBufferEIDs: List[int] = []
markerGraphics = 0
markerGraphicsNoDescriptorSet = 0
markerGraphicsDescriptorSet = 0
markerGraphicsSecondaryCommandBuffer = 0
markerIndirect = 0
markerIndirectWriteIndirectDispatchData = 0
markerIndirectDispatchWriteIndirectDrawData = 0
markerIndirectIndirectDraws = 0
markerIndirectSecondaryCommandBuffer = 0
markerIndirectSecondaryCommandBufferDispatchIndirect = 0
markerIndirectEnd = 0
markerNestedSecondaryCommandBuffer = 0
markerNestedSecondaryCommandBufferDispatch = 0
markerDescriptorBuffer = 0
markerBarrierCommandSubmitFence = 0
markerCompute = 0
markerComputeDescriptorSet = 0
markerComputeSecondaryCommandBuffer = 0
markerLooseEventsAfterIndirectDrawsDrawIndirectSingle = 0
markerMultipleCommandBufferSubmits = 0
markerMultipleSecondaryCommandBufferExecutes = 0
self.markerStart = self.find_action("Resource Usage: Start").eventId
self.markerEnd = self.find_action("Resource Usage: End").eventId
markerIndirectWriteIndirectDispatchData = self.find_action("Indirect Write IndirectDispatch Data").eventId
markerGraphics = self.find_action("Graphics").eventId
markerGraphicsNoDescriptorSet = self.find_action("No Descriptor Set", markerGraphics).eventId
markerGraphicsDescriptorSet = self.find_action("Descriptor Set", markerGraphicsNoDescriptorSet+1).eventId
markerGraphicsSecondaryCommandBuffer = self.find_action("Secondary Command Buffer").eventId
if nestedSecondaries:
markerNestedSecondaryCommandBuffer = self.find_action("Nested Secondary Command Buffer").eventId
markerNestedSecondaryCommandBufferDispatch = self.find_action("Dispatch", markerNestedSecondaryCommandBuffer).eventId
if descBuffer:
markerDescriptorBuffer = self.find_action("Descriptor Buffer").eventId
markerBarrierCommandSubmitFence = self.find_action("Barrier Command Submit Fence").eventId
markerCompute = self.find_action("Compute").eventId
markerComputeSecondaryCommandBuffer = self.find_action("Secondary Command Buffer", markerCompute).eventId
markerLooseEventsAfterIndirectDraws = self.find_action("Loose Events After Indirect Draws").eventId
markerLooseEventsAfterIndirectDrawsDrawIndirectSingle = self.find_action("DrawIndirect: Single", markerLooseEventsAfterIndirectDraws).eventId
markerMultipleCommandBufferSubmits = self.find_action("Multiple Command Buffer Submits").eventId
markerMultipleSecondaryCommandBufferExecutes = self.find_action("Multiple Secondary Command Buffer Executes").eventId
while len(actions) > 0:
action = actions.pop(0)
actions += action.children
flags = action.flags
if flags & rd.ActionFlags.Drawcall:
drawEIDs.append(action.eventId)
if flags & rd.ActionFlags.Indexed:
# Special case remove this from the indexed list
# vkCmdDrawIndexedIndirect(1) => <3, 1>
if action.customName.endswith("<3, 1>"):
indexedSpecialEIDs.append(action.eventId)
else:
indexedEIDs.append(action.eventId)
if flags & rd.ActionFlags.Dispatch:
dispatchEIDs.append(action.eventId)
if flags & rd.ActionFlags.Indirect:
indirectEIDs.append(action.eventId)
if "Count" in action.customName:
indirectCountEIDs.append(action.eventId)
if flags & rd.ActionFlags.MeshDispatch:
meshDispatchEIDs.append(action.eventId)
if flags & rd.ActionFlags.MultiAction:
multiEIDs.append(action.eventId)
if "Count" in action.customName:
if not action.eventId in indirectCountEIDs:
indirectCountEIDs.append(action.eventId)
if flags & rd.ActionFlags.PushMarker:
parentName = action.parent.customName if action.parent is not None else None
markerPath = parentName + "." + action.customName if parentName is not None else action.customName
if not markerIndirect and markerPath == "Indirect":
markerIndirect = action.eventId
markerIndirectEnd = action.children[-1].eventId
if not markerComputeDescriptorSet and markerPath == "Compute.Descriptor Set":
markerComputeDescriptorSet = action.eventId
if "vkCmdDrawIndirect(" in action.customName:
cmdDrawIndirectEIDs.append(action.eventId)
if "vkCmdDrawIndexedIndirect(" in action.customName:
cmdDrawIndirectEIDs.append(action.eventId)
if "vkCmdDrawMeshTasksIndirectEXT(" in action.customName:
cmdMeshDispatchIndirectEIDs.append(action.eventId)
for e in action.events:
eventName = sdfile.chunks[e.chunkIndex].name
if "vkQueueSubmit" in eventName:
submitEIDs.append(e.eventId)
if "vkWaitForFences" in eventName:
waitFencesEIDs.append(e.eventId)
if "vkResetFences" in eventName:
resetFencesEIDs.append(e.eventId)
if "vkCmdCopyBuffer" in eventName:
copyBufferEIDs.append(e.eventId)
if "vkCmdFillBuffer" in eventName:
fillBufferEIDs.append(e.eventId)
if "vkCmdEndRenderPass" in eventName:
endRenderPassEIDs.append(e.eventId)
markerIndirectDispatchWriteIndirectDrawData = self.find_action("Indirect Dispatch Write IndirectDraw Data", markerIndirect).eventId
markerIndirectIndirectDraws = self.find_action("Indirect Draws", markerIndirectDispatchWriteIndirectDrawData).eventId
markerIndirectSecondaryCommandBuffer = self.find_action("Secondary Command Buffer", markerIndirect).eventId
markerIndirectSecondaryCommandBufferDispatchIndirect = self.find_action("DispatchIndirect", markerIndirectSecondaryCommandBuffer).eventId
descSetDrawEIDs += [eid for eid in drawEIDs
if (eid > markerGraphicsDescriptorSet and eid < markerGraphicsSecondaryCommandBuffer) or
(eid > markerIndirect and (not nestedSecondaries or eid < markerNestedSecondaryCommandBuffer))]
descBufferDrawEIDs += [eid for eid in drawEIDs if descBuffer and eid > markerDescriptorBuffer]
drawEIDs.sort()
indexedEIDs.sort()
indexedSpecialEIDs.sort()
dispatchEIDs.sort()
multiEIDs.sort()
indirectEIDs.sort()
meshDispatchEIDs.sort()
indirectCountEIDs.sort()
submitEIDs.sort()
waitFencesEIDs.sort()
resetFencesEIDs.sort()
descSetDrawEIDs.sort()
descBufferDrawEIDs.sort()
fillBufferEIDs.sort()
copyBufferEIDs.sort()
endRenderPassEIDs.sort()
cmdDrawIndirectEIDs.sort()
cmdMeshDispatchIndirectEIDs.sort()
action = self.find_action("Draw")
self.set_event(action.eventId, False)
swapImage = self.controller.GetPipelineState().GetOutputTargets()[0].resource
with rdtest.log.auto_section("Checking Resource Usage"):
for res in resources:
expectedUsage: List[Tuple[int,rd.ResourceUsage]] = []
if res.type == rd.ResourceType.Device:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Queue:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Pool:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.SwapchainImage:
# the swap chain image has usage, anything else does not
if res.resourceId == swapImage:
expectedUsage = [
(self.markerStart + 1,rd.ResourceUsage.Barrier),
(self.markerStart + 1,rd.ResourceUsage.Discard),
(self.markerStart + 2,rd.ResourceUsage.Clear),
(self.markerStart + 3,rd.ResourceUsage.Barrier)]
expectedUsage += [(eid,rd.ResourceUsage.ColorTarget) for eid in drawEIDs]
expectedUsage += [(eid,rd.ResourceUsage.ColorTarget) for eid in meshDispatchEIDs]
expectedUsage += [(markerBarrierCommandSubmitFence - 1, rd.ResourceUsage.Barrier)]
else:
expectedUsage = []
elif res.type == rd.ResourceType.RenderPass:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Sync:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.View:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Memory:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.ShaderBinding:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Shader:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.PipelineState:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Buffer:
if res.name == "Vertex Buffer":
expectedUsage += [(eid,rd.ResourceUsage.VertexBuffer) for eid in drawEIDs]
if res.name == "Index Buffer":
expectedUsage += [(eid,rd.ResourceUsage.IndexBuffer) for eid in indexedEIDs]
if res.name == "Compute Buffer In":
# All dispatches within "Compute" region
# All dispatches within "Nested Secondary Command Buffer" region
expectedUsage += [(eid,rd.ResourceUsage.CS_Constants) for eid in dispatchEIDs
if (eid > markerComputeDescriptorSet and eid < markerIndirect) or
(nestedSecondaries and eid > markerNestedSecondaryCommandBuffer)]
if res.name == "Compute Buffer Out":
# All dispatches within "Compute" region
# All dispatches within "Nested Secondary Command Buffer" region
expectedUsage += [(eid,rd.ResourceUsage.CS_RWResource) for eid in dispatchEIDs
if (eid > markerComputeDescriptorSet and eid < markerIndirect) or
(nestedSecondaries and eid > markerNestedSecondaryCommandBuffer)]
if res.name == "Indirect Data":
expectedUsage += [(markerIndirectWriteIndirectDispatchData + 1,rd.ResourceUsage.Barrier),
(markerIndirectWriteIndirectDispatchData + 2,rd.ResourceUsage.Clear),
(markerIndirectWriteIndirectDispatchData + 3,rd.ResourceUsage.Barrier)]
expectedUsage += [(markerIndirectSecondaryCommandBuffer - 2,rd.ResourceUsage.Barrier),
(markerIndirectSecondaryCommandBuffer + 3,rd.ResourceUsage.Barrier),
(markerIndirectSecondaryCommandBuffer + 5,rd.ResourceUsage.Barrier)]
expectedUsage += [(markerIndirectIndirectDraws - 2,rd.ResourceUsage.Barrier)]
expectedUsage += [(markerIndirectSecondaryCommandBufferDispatchIndirect - 1,rd.ResourceUsage.Barrier),
(markerIndirectSecondaryCommandBufferDispatchIndirect + 3,rd.ResourceUsage.Barrier),
(markerIndirectSecondaryCommandBufferDispatchIndirect + 5,rd.ResourceUsage.Barrier)]
for eid in dispatchEIDs:
if eid in indirectEIDs:
continue
if eid in indirectCountEIDs:
continue
if eid in multiEIDs:
continue
if eid in indexedSpecialEIDs:
continue
if eid > markerIndirectWriteIndirectDispatchData and eid < markerGraphics:
expectedUsage.append((eid,rd.ResourceUsage.CS_RWResource))
expectedUsage.append((eid+1,rd.ResourceUsage.Barrier))
if eid > markerComputeSecondaryCommandBuffer and eid < markerIndirect:
expectedUsage.append((eid+1,rd.ResourceUsage.Barrier))
if eid > markerIndirectSecondaryCommandBuffer and eid < markerIndirectEnd:
expectedUsage.append((eid,rd.ResourceUsage.CS_RWResource))
for eid in cmdDrawIndirectEIDs:
if eid in indirectCountEIDs:
continue
if eid in multiEIDs:
continue
if eid in indexedSpecialEIDs:
continue
if eid > markerIndirectIndirectDraws and eid < markerIndirectEnd:
expectedUsage.append((eid,rd.ResourceUsage.Indirect))
if eid > markerLooseEventsAfterIndirectDrawsDrawIndirectSingle and eid < markerDescriptorBuffer:
expectedUsage.append((eid,rd.ResourceUsage.Indirect))
expectedUsage += [(eid,rd.ResourceUsage.Clear) for eid in fillBufferEIDs
if eid > markerIndirect and eid < markerIndirectEnd]
expectedUsage += [(eid,rd.ResourceUsage.CS_RWResource) for eid in indirectEIDs if eid in dispatchEIDs]
expectedUsage += [(eid,rd.ResourceUsage.Indirect) for eid in indirectEIDs if eid in dispatchEIDs]
expectedUsage += [(eid,rd.ResourceUsage.Indirect) for eid in multiEIDs if not eid in indirectCountEIDs]
expectedUsage += [(eid,rd.ResourceUsage.Indirect) for eid in indirectCountEIDs]
expectedUsage += [(eid,rd.ResourceUsage.Indirect) for eid in indirectCountEIDs]
expectedUsage += [(eid,rd.ResourceUsage.IndexBuffer) for eid in indexedSpecialEIDs if not eid in indirectCountEIDs]
expectedUsage += [(eid,rd.ResourceUsage.Indirect) for eid in indexedSpecialEIDs if not eid in indirectCountEIDs]
expectedUsage += [(eid,rd.ResourceUsage.Indirect) for eid in cmdMeshDispatchIndirectEIDs if not eid in multiEIDs]
for eid in endRenderPassEIDs:
if eid > markerLooseEventsAfterIndirectDraws:
expectedUsage.append((eid+2,rd.ResourceUsage.Barrier))
break
for eid in dispatchEIDs:
if nestedSecondaries and eid > markerNestedSecondaryCommandBufferDispatch:
expectedUsage.append((eid + 1,rd.ResourceUsage.Barrier))
break
if res.name == "Barrier Buffer":
expectedUsage += [(eid,rd.ResourceUsage.Barrier)
for eid in range(markerMultipleCommandBufferSubmits + 1, markerMultipleCommandBufferSubmits + 1 + 10*8, 8)]
if res.name == "Barrier2 Buffer":
expectedUsage += [(eid,rd.ResourceUsage.Barrier)
for eid in range(markerMultipleSecondaryCommandBufferExecutes + 3, markerMultipleSecondaryCommandBufferExecutes + 3 + 4*5, 5)]
if res.name == "Descriptor Buffer":
first = True
for eid in copyBufferEIDs:
if eid > markerLooseEventsAfterIndirectDraws:
expectedUsage.append((eid-1,rd.ResourceUsage.Barrier))
if first:
expectedUsage.append((eid,rd.ResourceUsage.CopySrc))
first = False
else:
expectedUsage.append((eid,rd.ResourceUsage.CopyDst))
for eid in fillBufferEIDs:
if eid > markerLooseEventsAfterIndirectDraws:
expectedUsage.append((eid-1,rd.ResourceUsage.Barrier))
expectedUsage.append((eid,rd.ResourceUsage.Clear))
break
if res.name == "Descriptor Backup Buffer":
first = True
for eid in copyBufferEIDs:
if eid > markerLooseEventsAfterIndirectDraws:
expectedUsage.append((eid-1,rd.ResourceUsage.Barrier))
if first:
expectedUsage.append((eid,rd.ResourceUsage.CopyDst))
first = False
else:
expectedUsage.append((eid,rd.ResourceUsage.CopySrc))
break
elif res.type == rd.ResourceType.Texture:
if res.name == "Offscreen MSAA Image":
expectedUsage = [(self.markerStart + 6,rd.ResourceUsage.Barrier),
(self.markerStart + 6,rd.ResourceUsage.Discard),
(self.markerStart + 7,rd.ResourceUsage.Clear)]
if res.name == "Offscreen Image":
expectedUsage = [(self.markerStart + 4,rd.ResourceUsage.Barrier),
(self.markerStart + 4,rd.ResourceUsage.Discard),
(self.markerStart + 5,rd.ResourceUsage.Clear)]
expectedUsage += [(eid,rd.ResourceUsage.PS_Resource) for eid in descSetDrawEIDs]
expectedUsage += [(eid,rd.ResourceUsage.PS_Resource) for eid in descBufferDrawEIDs]
elif res.type == rd.ResourceType.CommandBuffer:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.DescriptorStore:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
elif res.type == rd.ResourceType.Sampler:
expectedUsage = [(0,rd.ResourceUsage.Unused)]
else:
raise rdtest.TestFailureException(f"'{res.name}' {res.resourceId} Unexpected resource type {res.type.name}")
expectedUsage.sort(key=lambda x: x[0])
self.check_resource_usage(res, expectedUsage)
actions = self.controller.GetRootActions()
for a in actions:
self.add_action(a)
# Select every event of the resource usage to ensure the EID is valid
with rdtest.log.auto_section("Checking Resource Usage Events can be replayed"):
for res in resources:
rdtest.log.print(f"Resource '{res.name}' type:{res.type.name} {res.resourceId}")
usages = self.resourceUsages[res.resourceId]
for u in usages:
eid = u.eventId
if eid == 0:
continue
self.set_event(eid, True)
if eid not in self.eids:
raise rdtest.TestFailureException(f"'{res.name}' {res.resourceId} Missing EID:{eid}")
with rdtest.log.auto_section("Checking Indirect Action Names"):
if not self.check_indirect_action_name_consistency(self.controller):
raise rdtest.TestFailureException("Indirect action parameters do not match its event parameters")