Breaking change: IMemoryChunkAllocator.FreeChunk using MemoryChunkId …

…chunk. Propagates ChunkId to TlfsAllocation.
XenoAtom · Jul 6, 2024 · f9be58e · f9be58e
1 parent 331649f
commit f9be58e
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 12 deletions.
diff --git a/doc/readme.md b/doc/readme.md
@@ -40,10 +40,12 @@ public unsafe class BasicChunkAllocator : IMemoryChunkAllocator
         return true;
     }
 
-    public void FreeChunk(in MemoryChunk chunk)
+    public void FreeChunk(MemoryChunkId chunkId)
     {
+        var index = (int)chunkId.Value;
+        var chunk = _chunks[index];
         NativeMemory.AlignedFree((void*)(ulong)chunk.BaseAddress);
-        _chunks.Remove((int)chunk.Id.Value);
+        _chunks.Remove(index);
     }
 }
 ```

diff --git a/src/XenoAtom.Allocators.Bench/BenchAllocator.cs b/src/XenoAtom.Allocators.Bench/BenchAllocator.cs
@@ -94,10 +94,11 @@ public bool TryAllocateChunk(MemorySize minSize, out MemoryChunk chunk)
             return true;
         }
 
-        public void FreeChunk(in MemoryChunk chunk)
+        public void FreeChunk(MemoryChunkId chunkId)
         {
+            var chunk = _chunks[(int)chunkId.Value];
             NativeMemory.AlignedFree((void*)(ulong)chunk.BaseAddress);
-            _chunks.Remove((int)chunk.Id.Value);
+            _chunks.Remove((int)chunkId.Value);
         }
     }
 }
diff --git a/src/XenoAtom.Allocators.Tests/BasicTests.cs b/src/XenoAtom.Allocators.Tests/BasicTests.cs
@@ -554,11 +554,11 @@ public bool TryAllocateChunk(MemorySize size, out MemoryChunk chunk)
             return true;
         }
 
-        public void FreeChunk(in MemoryChunk chunk)
+        public void FreeChunk(MemoryChunkId chunkId)
         {
             for (var i = 0; i < RequestedChunkAllocations.Count; i++)
             {
-                if (RequestedChunkAllocations[i].Id == chunk.Id)
+                if (RequestedChunkAllocations[i].Id == chunkId)
                 {
                     RequestedChunkAllocations.RemoveAt(i);
                     return;

diff --git a/src/XenoAtom.Allocators/IMemoryChunkAllocator.cs b/src/XenoAtom.Allocators/IMemoryChunkAllocator.cs
@@ -21,5 +21,5 @@ public interface IMemoryChunkAllocator
     /// Frees a chunk of memory.
     /// </summary>
     /// <param name="chunk">The original chunk that was allocated.</param>
-    void FreeChunk(in MemoryChunk chunk);
+    void FreeChunk(MemoryChunkId chunk);
 }
diff --git a/src/XenoAtom.Allocators/TlsfAllocation.cs b/src/XenoAtom.Allocators/TlsfAllocation.cs
@@ -9,9 +9,10 @@ namespace XenoAtom.Allocators;
 /// </summary>
 public readonly record struct TlsfAllocation
 {
-    internal TlsfAllocation(TlsfAllocationToken token, MemoryAddress address, MemorySize size)
+    internal TlsfAllocation(TlsfAllocationToken token, MemoryChunkId chunkId, MemoryAddress address, MemorySize size)
     {
         Token = token;
+        ChunkId = chunkId;
         Address = address;
         Size = size;
     }
@@ -21,6 +22,11 @@ internal TlsfAllocation(TlsfAllocationToken token, MemoryAddress address, Memory
     /// </summary>
     public readonly TlsfAllocationToken Token;
 
+    /// <summary>
+    /// Gets the chunk id of this allocated block belongs to.
+    /// </summary>
+    public readonly MemoryChunkId ChunkId;
+
     /// <summary>
     /// Gets the address of the allocated block.
     /// </summary>

diff --git a/src/XenoAtom.Allocators/TlsfAllocator.cs b/src/XenoAtom.Allocators/TlsfAllocator.cs
@@ -157,7 +157,7 @@ public bool TryAllocate(MemorySize size, out TlsfAllocation allocation)
                 ref var previousBlock = ref GetBlockAt(freeBlock.PhysicalLink.Previous);
                 previousBlock.PhysicalLink.Next = usedBlockIndex;
                 Debug.Assert(previousBlock.OffsetIntoChunk + previousBlock.Size == offsetIntoChunk);
-            }
+            } 
 
             Debug.Assert(usedBlock.OffsetIntoChunk + size == freeBlock.OffsetIntoChunk);
             freeBlock.PhysicalLink.Previous = usedBlockIndex;
@@ -170,7 +170,7 @@ public bool TryAllocate(MemorySize size, out TlsfAllocation allocation)
                 InsertBlockIntoFreeList(ref freeBlock, freeBlockIndex, newFirstLevelIndex, newSecondLevelIndex);
             }
 
-            allocation = new TlsfAllocation(new((uint)usedBlockIndex), (ulong)chunk.Info.BaseAddress + offsetIntoChunk, size);
+            allocation = new TlsfAllocation(new((uint)usedBlockIndex), chunk.Info.Id, (ulong)chunk.Info.BaseAddress + offsetIntoChunk, size);
         }
         else
         {
@@ -184,7 +184,7 @@ public bool TryAllocate(MemorySize size, out TlsfAllocation allocation)
             chunk.FreeBlockCount--;
             Debug.Assert(chunk.FreeBlockCount >= 0);
 
-            allocation = new TlsfAllocation(new((uint)freeBlockIndex), (ulong)chunk.Info.BaseAddress + offsetIntoChunk, size);
+            allocation = new TlsfAllocation(new((uint)freeBlockIndex), chunk.Info.Id, (ulong)chunk.Info.BaseAddress + offsetIntoChunk, size);
         }
 
         return true;
@@ -285,7 +285,7 @@ public void Reset()
     {
         for (int i = 0; i < _chunks.Count; i++)
         {
-            _context.FreeChunk(_chunks[i].Info);
+            _context.FreeChunk(_chunks[i].Info.Id);
         }
         _chunks.Clear();
         _blockCount = 0;