Struct good_memory_allocator::SpinLockedAllocator

pub struct SpinLockedAllocator<const SMALLBINS_AMOUNT: usize = DEFAULT_SMALLBINS_AMOUNT, const ALIGNMENT_SUB_BINS_AMOUNT: usize = DEFAULT_ALIGNMENT_SUB_BINS_AMOUNT>(_)
where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait;

A spin locked memory allocator that can be used as the global allocator.

Implementations

impl<const SMALLBINS_AMOUNT: usize, const ALIGNMENT_SUB_BINS_AMOUNT: usize> SpinLockedAllocator<SMALLBINS_AMOUNT, ALIGNMENT_SUB_BINS_AMOUNT>where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait,

pub const fn empty() -> Self

Creates an empty locked heap allocator without any heap memory region, which will always return null on allocation requests.

To intiialize this allocator, use the init method.

pub unsafe fn init(&self, heap_start_addr: usize, heap_size: usize)

Initializes the heap allocator with the given memory region.

Safety

If the allocator was already initialized, this function will panic.

The SpinLockedAllocator on which this was called must not be moved, and its address in memory must not change, otherwise undefined behaviour will occur. This is because the heap region now contains pointers to fields of this struct, and if this struct will move, the address of its fields will change, and those pointers will now be invalid.

The provided memory region must be valid and non-null, and must not be used by anything else.

If after aligning the start and end addresses, the size of the heap is 0, the function panics.

pub fn was_initialized(&self) -> bool

Checks if the heap memory region was already initialized by calling init.

Trait Implementations

impl<const SMALLBINS_AMOUNT: usize, const ALIGNMENT_SUB_BINS_AMOUNT: usize> GlobalAlloc for SpinLockedAllocator<SMALLBINS_AMOUNT, ALIGNMENT_SUB_BINS_AMOUNT>where
    SmallestTypeWhichHasAtLeastNBitsStruct<ALIGNMENT_SUB_BINS_AMOUNT>: SmallestTypeWhichHasAtLeastNBitsTrait,

unsafe fn alloc(&self, layout: Layout) -> *mut u8

Allocate memory as described by the given layout.

unsafe fn dealloc(&self, ptr: *mut u8, _layout: Layout)

Deallocate the block of memory at the given ptr pointer with the given layout.

unsafe fn realloc(&self, ptr: *mut u8, layout: Layout, new_size: usize) -> *mut u8

Shrink or grow a block of memory to the given new_size. The block is described by the given ptr pointer and layout.

unsafe fn alloc_zeroed(&self, layout: Layout) -> *mut u8

Behaves like alloc, but also ensures that the contents are set to zero before being returned.