Allocation failure handling

Author: Przemog1

include/nbl/asset/utils/CCPUMeshPackerV1.h

@@ -9,10 +9,6 @@
 #include <nbl/asset/utils/IMeshPacker.h>
 #include <nbl/core/math/intutil.h>
 
-//AFTER SAFE SHRINK FIX TODO LIST:
-//1. extendend tests
-//2. test `getPackerCreationParamsFromMeshBufferRange`
-
 namespace nbl 
 { 
 namespace asset
@@ -103,7 +99,6 @@ class CCPUMeshPackerV1 final : public IMeshPacker<ICPUMeshBuffer, MDIStructType>
 
 	inline PackerDataStore& getPackerDataStore() { return m_output; };
 
-	//TODO: update comment
 	// returns number of distinct mesh packers needed to pack the meshes and a sorted list of meshes by the meshpacker ID they should be packed into, as well as the parameters for the packers
 	// `packerParamsOut` should be big enough to fit `std::distance(begin,end)` entries, the return value will tell you how many were actually written
 	template<typename Iterator>
@@ -191,21 +186,16 @@ CCPUMeshPackerV1<MDIStructType>::CCPUMeshPackerV1(const SVertexInputParams& preD
 	);
 }
 
-// TODO: why cant this implementation of `alloc` be common to both CPU and CPU?
 template <typename MDIStructType>
 //`Iterator` may be only an Iterator or pointer to pointer
+//allocation should be happening even if processed mesh buffer doesn't have attribute that was declared in pre defined `SVertexInputParams`, if mesh buffer has any attributes that are not declared in pre defined `SVertexInputParams` then these should be always ignored
+/*
+	Requirements for input mesh buffers:
+		- attributes bound to the same binding must have identical format
+*/
 template <typename MeshBufferIterator>
 typename CCPUMeshPackerV1<MDIStructType>::ReservedAllocationMeshBuffers CCPUMeshPackerV1<MDIStructType>::alloc(const MeshBufferIterator mbBegin, const MeshBufferIterator mbEnd)
 {
-	/*
-	Requirements for input mesh buffers:
-		- attributes bound to the same binding must have identical format
-	*/
-
-	//TODO:
-	//allocation should be happening even if processed mesh buffer doesn't have attribute that was declared in pre defined `SVertexInputParams`, if mesh buffer has any attributes that are not declared in pre defined `SVertexInputParams` then these should be always ignored
-	//include it in the ducumentation? YES
-
 	//validation
 	for (auto it = mbBegin; it != mbEnd; it++)
 	{

include/nbl/asset/utils/IMeshPacker.h

@@ -76,7 +76,6 @@ class IMeshPackerBase : public virtual core::IReferenceCounted
             size_t MDIDataBuffMinAllocCnt = 32ull;
         };
 
-        // TODO: make a function which initializes allocators as a copy (incl resized copy)
         void initializeCommonAllocators(const AllocationParamsCommon& allocParams)
         {
             if (allocParams.indexBuffSupportedCnt)

include/nbl/asset/utils/IMeshPackerV2.h

@@ -591,7 +591,40 @@ class IMeshPackerV2 : public IMeshPacker<MeshBufferType,MDIStructType>, public I
 	template <typename MeshBufferIterator>
 	bool alloc(ReservedAllocationMeshBuffers* rambOut, const MeshBufferIterator mbBegin, const MeshBufferIterator mbEnd);
 
-    //TODO: test (free only part of the scene)
+    template <typename MeshBufferIterator>
+    void freeAllocatedAddressesOnAllocFail(ReservedAllocationMeshBuffers* rambOut, const MeshBufferIterator mbBegin, const MeshBufferIterator mbEnd)
+    {
+        size_t i = 0ull;
+        for (auto it = mbBegin; it != mbEnd; it++)
+        {
+            ReservedAllocationMeshBuffers& ramb = *(rambOut + i);
+
+            if (ramb.indexAllocationOffset == INVALID_ADDRESS)
+                return;
+
+            m_idxBuffAlctr.free_addr(ramb.indexAllocationOffset, ramb.indexAllocationReservedCnt);
+
+            const auto& mbVtxInputParams = (*it)->getPipeline()->getVertexInputParams();
+            for (uint16_t attrBit = 0x0001, location = 0; location < SVertexInputParams::MAX_ATTR_BUF_BINDING_COUNT; attrBit <<= 1, location++)
+            {
+                if (!(attrBit & mbVtxInputParams.enabledAttribFlags))
+                    continue;
+
+                if (ramb.attribAllocParams[location].offset == INVALID_ADDRESS)
+                    return;
+
+                m_vtxBuffAlctr.free_addr(ramb.attribAllocParams[location].offset, ramb.attribAllocParams[location].size);
+            }
+
+            if (ramb.mdiAllocationOffset == INVALID_ADDRESS)
+                return;
+
+            m_MDIDataAlctr.free_addr(ramb.mdiAllocationOffset, ramb.mdiAllocationReservedCnt);
+
+            i++;
+        }
+    }
+
     void free(const ReservedAllocationMeshBuffers* rambIn, uint32_t meshBuffersToFreeCnt)
     {
         for (uint32_t i = 0u; i < meshBuffersToFreeCnt; i++)
@@ -657,7 +690,10 @@ bool IMeshPackerV2<BufferType,DescriptorSetType,MeshBufferType,MDIStructType>::a
         //allocate indices
         ramb.indexAllocationOffset = m_idxBuffAlctr.alloc_addr(idxCnt, 1u);
         if (ramb.indexAllocationOffset == INVALID_ADDRESS)
+        {
+            freeAllocatedAddressesOnAllocFail(rambOut, mbBegin, mbEnd);
             return false;
+        }
         ramb.indexAllocationReservedCnt = idxCnt;
 
         //allocate vertices
@@ -681,12 +717,24 @@ bool IMeshPackerV2<BufferType,DescriptorSetType,MeshBufferType,MDIStructType>::a
                 const uint32_t allocByteSize = maxVtxCnt * attribSize;
                 ramb.attribAllocParams[location].offset = m_vtxBuffAlctr.alloc_addr(allocByteSize, attribSize);
                 ramb.attribAllocParams[location].size = allocByteSize;
+
+                if(ramb.attribAllocParams[location].offset == INVALID_ADDRESS)
+                {
+                    freeAllocatedAddressesOnAllocFail(rambOut, mbBegin, mbEnd);
+                    return false;
+                }
             }
             else if (inputRate == EVIR_PER_INSTANCE)
             {
                 const uint32_t allocByteSize = insCnt * attribSize;
                 ramb.attribAllocParams[location].offset = m_vtxBuffAlctr.alloc_addr(allocByteSize, attribSize);
                 ramb.attribAllocParams[location].size = allocByteSize;
+
+                if (ramb.attribAllocParams[location].offset == INVALID_ADDRESS)
+                {
+                    freeAllocatedAddressesOnAllocFail(rambOut, mbBegin, mbEnd);
+                    return false;
+                }
             }
 
             if (ramb.attribAllocParams[location].offset == INVALID_ADDRESS)
@@ -701,7 +749,10 @@ bool IMeshPackerV2<BufferType,DescriptorSetType,MeshBufferType,MDIStructType>::a
 
         ramb.mdiAllocationOffset = m_MDIDataAlctr.alloc_addr(possibleMDIStructsNeededCnt, 1u);
         if (ramb.mdiAllocationOffset == INVALID_ADDRESS)
+        {
+            freeAllocatedAddressesOnAllocFail(rambOut, mbBegin, mbEnd);
             return false;
+        }
         ramb.mdiAllocationReservedCnt = possibleMDIStructsNeededCnt;
 
         i++;