Struct buddy_system_allocator::Heap

pub struct Heap<const ORDER: usize> { /* private fields */ }

A heap that uses buddy system with configurable order.

Usage

Create a heap and add a memory region to it:

use buddy_system_allocator::*;
let mut heap = Heap::<32>::empty();
unsafe {
    heap.init(begin, size);
    // or
    heap.add_to_heap(begin, end);
}

Implementations

impl<const ORDER: usize> Heap<ORDER>

pub const fn new() -> Self

Create an empty heap

pub const fn empty() -> Self

Create an empty heap

pub unsafe fn add_to_heap(&mut self, start: usize, end: usize)

Add a range of memory [start, end) to the heap

pub unsafe fn init(&mut self, start: usize, size: usize)

Add a range of memory [start, start+size) to the heap

pub fn alloc(&mut self, layout: Layout) -> Result<NonNull<u8>, ()>

Alloc a range of memory from the heap satifying layout requirements

pub fn dealloc(&mut self, ptr: NonNull<u8>, layout: Layout)

Dealloc a range of memory from the heap

pub fn stats_alloc_user(&self) -> usize

Return the number of bytes that user requests

pub fn stats_alloc_actual(&self) -> usize

Return the number of bytes that are actually allocated

pub fn stats_total_bytes(&self) -> usize

Return the total number of bytes in the heap

Trait Implementations

impl<const ORDER: usize> Debug for Heap<ORDER>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.