Render state cache: added test for pipeline reload

Author: TheMostDiligent

Graphics/Archiver/src/ArchiverFactory.cpp

@@ -195,7 +195,8 @@ void ArchiverFactoryImpl::CreateSerializationDevice(const SerializationDeviceCre
 
 void ArchiverFactoryImpl::CreateDefaultShaderSourceStreamFactory(const Char* SearchDirectories, struct IShaderSourceInputStreamFactory** ppShaderSourceFactory) const
 {
-    DEV_CHECK_ERR(ppShaderSourceFactory != nullptr, "ppShaderSourceFactory must not be null");
+    DEV_CHECK_ERR(ppShaderSourceFactory != nullptr, "ppShaderSourceFactory must not be null.");
+    DEV_CHECK_ERR(*ppShaderSourceFactory == nullptr, "*ppShaderSourceFactory is not null. Make sure the pointer is null to avoid memory leaks.");
     if (!ppShaderSourceFactory)
         return;
 

Graphics/GraphicsEngine/src/DefaultShaderSourceStreamFactory.cpp

@@ -123,9 +123,11 @@ void DefaultShaderSourceStreamFactory::CreateInputStream2(const Char*
 void CreateDefaultShaderSourceStreamFactory(const Char*                       SearchDirectories,
                                             IShaderSourceInputStreamFactory** ppShaderSourceStreamFactory)
 {
+    DEV_CHECK_ERR(ppShaderSourceStreamFactory != nullptr, "ppShaderSourceStreamFactory must not be null.");
+    DEV_CHECK_ERR(*ppShaderSourceStreamFactory == nullptr, "*ppShaderSourceStreamFactory is not null. Make sure the pointer is null to avoid memory leaks.");
 
-    auto&                             Allocator = GetRawAllocator();
-    DefaultShaderSourceStreamFactory* pStreamFactory =
+    auto& Allocator = GetRawAllocator();
+    auto* pStreamFactory =
         NEW_RC_OBJ(Allocator, "DefaultShaderSourceStreamFactory instance", DefaultShaderSourceStreamFactory)(SearchDirectories);
     pStreamFactory->QueryInterface(IID_IShaderSourceInputStreamFactory, reinterpret_cast<IObject**>(ppShaderSourceStreamFactory));
 }

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/PixelShaderRld.psh

@@ -0,0 +1,6 @@
+#include "GraphicsCommon.h"
+
+float4 main(in PSInput PSIn) : SV_Target
+{
+    return float4(0.0, 0.0, 0.0, PSIn.Color.r);
+}

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/Reload/PixelShaderRld.psh

@@ -0,0 +1,7 @@
+#include "GraphicsCommon.h"
+
+float4 main(in PSInput PSIn) : SV_Target
+{
+    return float4(PSIn.Color.rgb, 1.0);
+    // NB: no new line at the end of file!
+}

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/Reload/VertexShaderRld.vsh

@@ -0,0 +1,29 @@
+#include "GraphicsCommon.h"
+
+#if INTERNAL_MACROS == 1 && EXTERNAL_MACROS == 2
+void main(in  uint    VertId : SV_VertexID,
+          out PSInput PSIn)
+{
+    float4 Pos[6];
+    Pos[0] = float4(-1.0, -0.5, 0.0, 1.0);
+    Pos[1] = float4(-0.5, +0.5, 0.0, 1.0);
+    Pos[2] = float4( 0.0, -0.5, 0.0, 1.0);
+
+    Pos[3] = float4(+0.0, -0.5, 0.0, 1.0);
+    Pos[4] = float4(+0.5, +0.5, 0.0, 1.0);
+    Pos[5] = float4(+1.0, -0.5, 0.0, 1.0);
+
+    float3 Col[6];
+    Col[0] = float3(1.0, 0.0, 0.0);
+    Col[1] = float3(0.0, 1.0, 0.0);
+    Col[2] = float3(0.0, 0.0, 1.0);
+
+    Col[3] = float3(1.0, 0.0, 0.0);
+    Col[4] = float3(0.0, 1.0, 0.0);
+    Col[5] = float3(0.0, 0.0, 1.0);
+
+    PSIn.Pos   = Pos[VertId];
+    PSIn.Color = Col[VertId];
+}
+// NB: no new line at the end of file!
+#endif

Tests/DiligentCoreAPITest/assets/shaders/RenderStateCache/VertexShaderRld.vsh

@@ -0,0 +1,11 @@
+#include "GraphicsCommon.h"
+
+#if INTERNAL_MACROS == 1 && EXTERNAL_MACROS == 2
+void main(in  uint    VertId : SV_VertexID,
+          out PSInput PSIn)
+{
+    PSIn.Pos   = float4(0.0, 0.0, 0.0, 0.0);
+    PSIn.Color = float3(0.0, 0.0, 0.0);
+}
+// NB: no new line at the end of file!
+#endif

Tests/DiligentCoreAPITest/src/RenderStateCacheTest.cpp

@@ -183,9 +183,12 @@ void VerifyComputePSO(IPipelineState* pPSO, bool UseSignature = false)
     pSwapChain->Present();
 }
 
-RefCntAutoPtr<IRenderStateCache> CreateCache(IRenderDevice* pDevice, bool HotReload, IDataBlob* pCacheData = nullptr)
+RefCntAutoPtr<IRenderStateCache> CreateCache(IRenderDevice*                   pDevice,
+                                             bool                             HotReload,
+                                             IDataBlob*                       pCacheData           = nullptr,
+                                             IShaderSourceInputStreamFactory* pShaderReloadFactory = nullptr)
 {
-    RenderStateCacheCreateInfo CacheCI{pDevice, true, HotReload};
+    RenderStateCacheCreateInfo CacheCI{pDevice, true, HotReload, pShaderReloadFactory};
 
     RefCntAutoPtr<IRenderStateCache> pCache;
     CreateRenderStateCache(CacheCI, &pCache);
@@ -885,4 +888,60 @@ TEST(RenderStateCacheTest, RenderDeviceWithCache)
     }
 }
 
+
+void TestPipelineReload(bool UseRenderPass)
+{
+    auto* pEnv    = GPUTestingEnvironment::GetInstance();
+    auto* pDevice = pEnv->GetDevice();
+
+    GPUTestingEnvironment::ScopedReset AutoReset;
+
+    RefCntAutoPtr<IShaderSourceInputStreamFactory> pShaderSourceFactory;
+    pDevice->GetEngineFactory()->CreateDefaultShaderSourceStreamFactory("shaders/RenderStateCache", &pShaderSourceFactory);
+    ASSERT_TRUE(pShaderSourceFactory);
+
+    RefCntAutoPtr<IShaderSourceInputStreamFactory> pShaderReloadFactory;
+    pDevice->GetEngineFactory()->CreateDefaultShaderSourceStreamFactory("shaders/RenderStateCache/Reload;shaders/RenderStateCache", &pShaderReloadFactory);
+    ASSERT_TRUE(pShaderSourceFactory);
+
+    constexpr auto HotReload = true;
+
+    RefCntAutoPtr<IDataBlob> pData;
+    for (Uint32 pass = 0; pass < 3; ++pass)
+    {
+        // 0: empty cache
+        // 1: loaded cache
+        // 2: reloaded cache (loaded -> stored -> loaded)
+
+        auto pCache = CreateCache(pDevice, HotReload, pData, pShaderReloadFactory);
+        ASSERT_TRUE(pCache);
+
+        RefCntAutoPtr<IShader> pVS, pPS;
+        CreateGraphicsShaders(pCache, pShaderSourceFactory, pVS, pPS, pData != nullptr, "VertexShaderRld.vsh", "PixelShaderRld.psh");
+        ASSERT_NE(pVS, nullptr);
+        ASSERT_NE(pPS, nullptr);
+
+        RefCntAutoPtr<IPipelineState> pPSO;
+        CreateGraphicsPSO(pCache, pData != nullptr, pVS, pPS, UseRenderPass, &pPSO);
+        ASSERT_NE(pPSO, nullptr);
+
+        EXPECT_EQ(pCache->Reload(), pass == 0 ? 3u : 0u);
+
+        VerifyGraphicsPSO(pPSO, UseRenderPass);
+
+        pData.Release();
+        pCache->WriteToBlob(&pData);
+    }
+}
+
+TEST(RenderStateCacheTest, Reload)
+{
+    TestPipelineReload(/*UseRenderPass = */ false);
+}
+
+TEST(RenderStateCacheTest, Reload_RenderPass)
+{
+    TestPipelineReload(/*UseRenderPass = */ true);
+}
+
 } // namespace