Skip to content

RenderStateCache: reuse archived pipelines with non-default SRB granularity or context mask #822

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
hzqst wants to merge 2 commits into
base: master
Choose a base branch
from
Open

RenderStateCache: reuse archived pipelines with non-default SRB granularity or context mask #822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da62ad3
RenderStateCache: unpack archived pipelines with their SRB granularit…
hzqst Oct 29, 2026
f6ee3d2
RenderStateCache: accept the context mask the device keeps for an unp…
hzqst Oct 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Graphics/GraphicsTools/src/RenderStateCacheImpl.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -849,6 +849,8 @@ bool RenderStateCacheImpl::CreatePipelineStateInternal(const CreateInfoType& PSO
UnpackInfo.PipelineType = PSOCreateInfo.PSODesc.PipelineType;
UnpackInfo.Name = HashStr.c_str();
UnpackInfo.pDevice = m_pDevice;
UnpackInfo.SRBAllocationGranularity = PSOCreateInfo.PSODesc.SRBAllocationGranularity;
UnpackInfo.ImmediateContextMask = PSOCreateInfo.PSODesc.ImmediateContextMask;
UnpackInfo.pCache = PSOCreateInfo.pPSOCache;
UnpackInfo.ModifyPipelineStateCreateInfo = Callback;
UnpackInfo.pUserData = Callback;
Expand All @@ -859,7 +861,11 @@ bool RenderStateCacheImpl::CreatePipelineStateInternal(const CreateInfoType& PSO
const PIPELINE_STATE_STATUS Status = pPSO->GetStatus();
if (Status == PIPELINE_STATE_STATUS_READY)
{
if (pPSO->GetDesc() == PSOCreateInfo.PSODesc)
// The device clears the bits of the immediate context mask that have no command queue,
// so the unpacked pipeline may hold a subset of the requested mask.
PipelineStateDesc ExpectedDesc = PSOCreateInfo.PSODesc;
ExpectedDesc.ImmediateContextMask &= pPSO->GetDesc().ImmediateContextMask;
if (pPSO->GetDesc() == ExpectedDesc)
{
*ppPipelineState = pPSO.Detach();
FoundInCache = true;
Expand Down
53 changes: 53 additions & 0 deletions Tests/DiligentCoreAPITest/src/RenderStateCacheTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1345,6 +1345,59 @@ TEST(RenderStateCacheTest, CreateComputePSO_Sign_Async)
TestComputePSO(/*UseSignature = */ true, /*CompileAsync = */ true);
}

// The archive does not store SRBAllocationGranularity and ImmediateContextMask; the dearchiver takes them from the
// unpack info. A pipeline created with non-default values must be found in a loaded cache and keep those values; the
// device reduces the mask to its immediate contexts, which must not make the unpacked pipeline look different.
TEST(RenderStateCacheTest, ArchivedPSOKeepsDescription)
{
GPUTestingEnvironment* pEnv = GPUTestingEnvironment::GetInstance();
IRenderDevice* pDevice = pEnv->GetDevice();
if (!pDevice->GetDeviceInfo().Features.ComputeShaders)
GTEST_SKIP() << "Compute shaders are not supported by this device";

GPUTestingEnvironment::ScopedReset AutoReset;

RefCntAutoPtr<IShaderSourceInputStreamFactory> pShaderSourceFactory;
pDevice->GetEngineFactory()->CreateDefaultShaderSourceStreamFactory("shaders/RenderStateCache", &pShaderSourceFactory);
ASSERT_NE(nullptr, pShaderSourceFactory);

constexpr Uint32 SRBAllocationGranularity = 4;
// All bits: not the default mask on any device, and the device reduces it to its immediate contexts.
constexpr Uint64 RequestedContextMask = ~Uint64{0};
const Uint64 DeviceContextMask = (Uint64{1} << pEnv->GetNumImmediateContexts()) - 1;

RefCntAutoPtr<IDataBlob> pArchiveData;
for (Uint32 Pass = 0; Pass < 2; ++Pass)
{
SCOPED_TRACE(Pass);
auto pCache = CreateCache(pDevice, false, pArchiveData);
ASSERT_NE(nullptr, pCache);

RefCntAutoPtr<IShader> pCS;
CreateComputeShader(pCache, pShaderSourceFactory, SHADER_COMPILE_FLAG_NONE, pCS, Pass != 0);
ASSERT_NE(nullptr, pCS);

ComputePipelineStateCreateInfo PSOCI;
PSOCI.PSODesc.Name = "Archived pipeline description";
PSOCI.PSODesc.SRBAllocationGranularity = SRBAllocationGranularity;
PSOCI.PSODesc.ImmediateContextMask = RequestedContextMask;
PSOCI.PSODesc.ResourceLayout.DefaultVariableType = SHADER_RESOURCE_VARIABLE_TYPE_MUTABLE;
PSOCI.pCS = pCS;
RefCntAutoPtr<IPipelineState> pPSO;
EXPECT_EQ(Pass != 0, pCache->CreateComputePipelineState(PSOCI, &pPSO));
ASSERT_NE(nullptr, pPSO);
ASSERT_EQ(PIPELINE_STATE_STATUS_READY, pPSO->GetStatus());
PipelineStateDesc ExpectedDesc = PSOCI.PSODesc;
ExpectedDesc.ImmediateContextMask = DeviceContextMask;
EXPECT_EQ(ExpectedDesc, pPSO->GetDesc());
VerifyComputePSO(pPSO, /*UseSignature = */ true);

pArchiveData.Release();
ASSERT_TRUE(pCache->WriteToBlob(ContentVersion, &pArchiveData));
ASSERT_NE(nullptr, pArchiveData);
}
}


TEST(RenderStateCacheTest, CacheByFileName)
{
Expand Down
Loading