Palloc
Portable linked-list allocator for embedded / baremetal systems.
Using the crate
Include this in the [dependencies] section of Cargo.toml
palloc = "0.1.0"
This crate uses unstable features of Rust, so it requires the nightly update channel. Update the toolchain for your project folder with:
rustup override set nightly
Crate features
spin(default): provides a GlobalAllocator implementation using a spin lock.allocator_api(default): enables the Allocator trait and implements it on all global allocators.
Example
#![no_std]
use core::ptr::NonNull;
use palloc::{GlobalPalloc, SpinPalloc};
// the allocator is initialized using a const empty function, but it is
// not ready yet, we must initialize it first in main.
#[global_allocator]
static mut ALLOCATOR: SpinPalloc = SpinPalloc::empty();
fn main() {
// First of all we must define the bounds of our heap. Check
// Palloc or GlobalPalloc documentation for informations.
// Heap starting address
let heap_start = 0x8000 as *mut u8;
// Heap size
let heap_size = 0xF000;
// accessing statics is an unsafe operation
// so it must be sorrounded by an unsafe block
unsafe { ALLOCATOR.init(NonNull::new(heap_start).unwrap(), heap_size) };
// we can now use the heap!
// ...
}
Documentation
Everything you need to know is already written in the rustdocs. Click on the badge under the readme's title or click here to read the full documentation.
16 Nov 22, 2022
18 Apr 17, 2023
6 Feb 9, 2022
44 Dec 27, 2022
6 Dec 25, 2022
7 Jan 10, 2023
27 Mar 22, 2023
243 Sep 6, 2023
4 Oct 13, 2023
6 Sep 12, 2023
2.4k Jan 3, 2023
8 Feb 1, 2023
587 Dec 26, 2022
2.2k Jan 9, 2023
20 Dec 26, 2022
8 Dec 8, 2021
1.1k Jan 9, 2023
0 Sep 14, 2022