using System.Runtime.CompilerServices;
namespace Misaki.HighPerformance.LowLevel.Buffer;
///
/// Provides a stack-based memory allocator for unmanaged memory, enabling fast allocation and deallocation of memory
/// blocks within a preallocated buffer.
///
/// This is not a thread-safe implementation.
public unsafe partial struct Stack : IMemoryAllocator
{
public struct CreationOpts
{
public nuint size;
}
public static Stack Create(in CreationOpts opts)
{
return new Stack(opts.size);
}
public readonly ref struct Scope : IDisposable
{
private readonly Stack* _allocator;
private readonly AllocationHandle _handle;
private readonly nuint _originalOffset;
public readonly AllocationHandle AllocationHandle => _handle;
internal Scope(Stack* allocator, AllocationHandle handle)
{
_allocator = allocator;
_handle = handle;
_originalOffset = allocator->_offset;
#if MHP_ENABLE_SAFETY_CHECKS
_allocator->_activeScopeCount++;
#endif
}
public void Dispose()
{
if (_allocator != null)
{
_allocator->_offset = _allocator->_offset > _originalOffset ? _originalOffset : _allocator->_offset;
#if MHP_ENABLE_SAFETY_CHECKS
_allocator->_activeScopeCount--;
#endif
}
}
}
private byte* _buffer;
private nuint _size;
private nuint _offset;
#if MHP_ENABLE_SAFETY_CHECKS
private uint _activeScopeCount;
#endif
internal readonly byte* Buffer => _buffer;
internal nuint Offset
{
readonly get => _offset;
set => _offset = value;
}
///
/// Initializes a new instance of the StackAllocator class with a buffer of the specified size.
///
/// The size, in bytes, of the memory buffer to allocate for stack-based allocations. Must be greater than zero.
public Stack(nuint size)
{
ArgumentOutOfRangeException.ThrowIfNegative(size);
_buffer = (byte*)Malloc(size);
_size = size;
_offset = 0;
#if MHP_ENABLE_SAFETY_CHECKS
_activeScopeCount = 0;
#endif
}
///
/// Creates a new scope instance associated with the current stack context.
///
///
/// The instance of must be pinned or allocated on the native heap to ensure that the pointer remains valid for the lifetime of the scope.
///
/// A object that represents a scope tied to this stack.
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public Scope CreateScope(AllocationHandle handle)
{
return new Scope((Stack*)Unsafe.AsPointer(ref this), handle);
}
///
/// Allocates a block of memory of the specified size and alignment from the buffer.
///
/// The number of bytes to allocate. Must be greater than zero and less than or equal to the remaining buffer size.
/// The alignment, in bytes, for the allocated memory block. Must be a power of two and greater than zero.
/// An option specifying additional allocation behavior, such as whether the allocated memory should be cleared. The
/// default is .
/// A pointer to the beginning of the allocated memory block if successful; otherwise, if
/// there is insufficient space in the buffer.
public void* Allocate(nuint size, nuint alignment, AllocationOption allocationOption = AllocationOption.None)
{
#if MHP_ENABLE_SAFETY_CHECKS
if (_activeScopeCount == 0)
{
throw new InvalidOperationException("Allocations can only be made within an active memory scope.");
}
#endif
if (size == 0)
{
return null;
}
if ((alignment & (alignment - 1)) != 0)
{
throw new ArgumentException("Alignment must be a power of two.", nameof(alignment));
}
var alignedOffset = (_offset + alignment - 1) & ~(alignment - 1);
var newOffset = alignedOffset + size;
if (newOffset > _size)
{
throw new OutOfMemoryException("Insufficient memory in stack allocator.");
}
var ptr = _buffer + alignedOffset;
_offset = newOffset;
if (allocationOption.HasFlag(AllocationOption.Clear))
{
MemClear(ptr, size);
}
return ptr;
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public readonly void Free(void* ptr)
{
}
///
/// Resets the internal offset to its initial position.
///
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public void Reset()
{
_offset = 0;
}
public void Dispose()
{
if (_buffer == null)
{
return;
}
Free(_buffer);
_buffer = null;
_size = 0;
_offset = 0;
}
}