Add assert to UploadBufferHandler to prevent usage during the Render functions

Add assert to UploadBufferHandler to prevent usage during the Render functions

Author: Pursche

Source/Renderer/Renderer/Renderer.h

@@ -207,6 +207,9 @@ namespace Renderer
         virtual bool ShouldWaitForUpload() = 0;
         virtual void SetHasWaitedForUpload() = 0;
         virtual SemaphoreID GetUploadFinishedSemaphore() = 0;
+        // Re-opens staging uploads for the new frame's Update phase. Call before any uploads, after
+        // the previous frame's FlipFrame locked them. Uploads requested while locked assert.
+        virtual void UnlockUploads() = 0;
 
         [[nodiscard]] BufferID CreateBuffer(BufferID bufferID, BufferDesc& desc);
         [[nodiscard]] BufferID CreateAndFillBuffer(BufferID bufferID, BufferDesc desc, void* data, size_t dataSize); // Deletes the current BufferID if it's not invalid

Source/Renderer/Renderer/Renderers/Vulkan/Backend/UploadBufferHandlerVK.cpp

@@ -115,6 +115,11 @@ namespace Renderer
             std::mutex submitMutex;
             SemaphoreID uploadFinishedSemaphore;
 
+            // An upload on the render-loop thread while locked would land a frame late, so it asserts.
+            // Worker-thread (async streaming) uploads are exempt.
+            std::atomic<bool> uploadsLocked = false;
+            std::thread::id renderThreadID;
+
             // These are copies of the barriers which needs to run on the main commandlist
             moodycamel::ConcurrentQueue<VkBufferMemoryBarrier> bufferMemoryBarriers;
         };
@@ -168,6 +173,11 @@ namespace Renderer
         {
             UploadBufferHandlerVKData* data = static_cast<UploadBufferHandlerVKData*>(_data);
 
+            // Per-frame submit point: lock until UnlockUploads() at the end of Render, and capture the
+            // render-loop thread so the assert is scoped to it.
+            data->renderThreadID = std::this_thread::get_id();
+            data->uploadsLocked = true;
+
             for (u32 i = 0; i < data->stagingBuffers.Num; i++)
             {
                 StagingBuffer& stagingBuffer = data->stagingBuffers.Get(i);
@@ -293,6 +303,10 @@ namespace Renderer
 
             UploadBufferHandlerVKData* data = static_cast<UploadBufferHandlerVKData*>(_data);
 
+            // Thread check first so worker-thread (async streaming) uploads short-circuit out.
+            NC_ASSERT(!(std::this_thread::get_id() == data->renderThreadID && data->uploadsLocked),
+                "UploadBufferHandlerVK : Staging upload requested after this frame's uploads were submitted (FlipFrame). Move it to the Update phase, before Render.");
+
             void* mappedMemory = nullptr;
             StagingBufferID stagingBufferID;
 
@@ -356,6 +370,10 @@ namespace Renderer
 
             UploadBufferHandlerVKData* data = static_cast<UploadBufferHandlerVKData*>(_data);
 
+            // Thread check first so worker-thread (async streaming) uploads short-circuit out.
+            NC_ASSERT(!(std::this_thread::get_id() == data->renderThreadID && data->uploadsLocked),
+                "UploadBufferHandlerVK : Staging upload requested after this frame's uploads were submitted (FlipFrame). Move it to the Update phase, before Render.");
+
             void* mappedMemory = nullptr;
             StagingBufferID stagingBufferID;
             size_t offset = Allocate(size, stagingBufferID, mappedMemory);
@@ -483,6 +501,13 @@ namespace Renderer
             data->needsWait = false;
         }
 
+        void UploadBufferHandlerVK::UnlockUploads()
+        {
+            // Called at the end of Render; the next frame's Update phase may upload again.
+            UploadBufferHandlerVKData* data = static_cast<UploadBufferHandlerVKData*>(_data);
+            data->uploadsLocked = false;
+        }
+
         size_t UploadBufferHandlerVK::Allocate(size_t size, StagingBufferID& stagingBufferID, void*& mappedMemory)
         {
             UploadBufferHandlerVKData* data = static_cast<UploadBufferHandlerVKData*>(_data);

Source/Renderer/Renderer/Renderers/Vulkan/Backend/UploadBufferHandlerVK.h

@@ -46,6 +46,7 @@ namespace Renderer
             SemaphoreID GetUploadFinishedSemaphore();
             bool ShouldWaitForUpload();
             void SetHasWaitedForUpload();
+            void UnlockUploads();
         private:
             size_t Allocate(size_t size, StagingBufferID& stagingBufferID, void*& mappedMemory);
             void ExecuteStagingBuffer(VkCommandBuffer commandBuffer, StagingBuffer& stagingBuffer);

Source/Renderer/Renderer/Renderers/Vulkan/RendererVK.cpp

@@ -1997,6 +1997,11 @@ namespace Renderer
         return _uploadBufferHandler->GetUploadFinishedSemaphore();
     }
 
+    void RendererVK::UnlockUploads()
+    {
+        _uploadBufferHandler->UnlockUploads();
+    }
+
     void RendererVK::CopyBuffer(BufferID dstBuffer, u64 dstOffset, BufferID srcBuffer, u64 srcOffset, u64 range)
     {
         _uploadBufferHandler->CopyBufferToBuffer(dstBuffer, dstOffset, srcBuffer, srcOffset, range);

Source/Renderer/Renderer/Renderers/Vulkan/RendererVK.h

@@ -175,6 +175,7 @@ namespace Renderer
         [[nodiscard]] bool ShouldWaitForUpload() override;
         void SetHasWaitedForUpload() override;
         [[nodiscard]] SemaphoreID GetUploadFinishedSemaphore() override;
+        void UnlockUploads() override;
 
         // Uses the upload handler to schedule it for next frames command list
         void CopyBuffer(BufferID dstBuffer, u64 dstOffset, BufferID srcBuffer, u64 srcOffset, u64 range) override;