Skip to content

Commit 080581e

Browse files
committed
Add a macro to make initialization easier
1 parent 8437c09 commit 080581e

File tree

6 files changed

+55
-21
lines changed

6 files changed

+55
-21
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](http://keepachangelog.com/)
66
and this project adheres to [Semantic Versioning](http://semver.org/).
77

8+
## [Unreleased]
9+
10+
### Added
11+
12+
- Added a `init` macro to make initialization easier.
13+
814
## [v0.6.0] - 2024-09-01
915

1016
### Added

README.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,7 @@ static HEAP: Heap = Heap::empty();
3131
#[entry]
3232
fn main() -> ! {
3333
// Initialize the allocator BEFORE you use it
34-
{
35-
use core::mem::MaybeUninit;
36-
const HEAP_SIZE: usize = 1024;
37-
static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
38-
unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
39-
}
34+
embedded_alloc::init!(HEAP, 1024);
4035

4136
// now the allocator is ready types like Box, Vec can be used.
4237

examples/global_alloc.rs

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,7 @@ static HEAP: Heap = Heap::empty();
1717
#[entry]
1818
fn main() -> ! {
1919
// Initialize the allocator BEFORE you use it
20-
{
21-
use core::mem::MaybeUninit;
22-
const HEAP_SIZE: usize = 1024;
23-
static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
24-
unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
25-
}
20+
embedded_alloc::init!(HEAP, 1024);
2621

2722
let mut xs = Vec::new();
2823
xs.push(1);

examples/llff_integration_test.rs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,7 @@ fn test_allocator_api() {
6363

6464
#[entry]
6565
fn main() -> ! {
66-
{
67-
const HEAP_SIZE: usize = 1024;
68-
static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
69-
unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
70-
}
66+
embedded_alloc::init!(HEAP, 1024);
7167

7268
#[allow(clippy::type_complexity)]
7369
let tests: &[(fn() -> (), &'static str)] = &[

examples/tlsf_integration_test.rs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,7 @@ fn test_allocator_api() {
8181

8282
#[entry]
8383
fn main() -> ! {
84-
{
85-
static mut HEAP_MEM: [MaybeUninit<u8>; HEAP_SIZE] = [MaybeUninit::uninit(); HEAP_SIZE];
86-
unsafe { HEAP.init(&raw mut HEAP_MEM as usize, HEAP_SIZE) }
87-
}
84+
embedded_alloc::init!(HEAP, HEAP_SIZE);
8885

8986
#[allow(clippy::type_complexity)]
9087
let tests: &[(fn() -> (), &'static str)] = &[

src/lib.rs

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,48 @@ mod tlsf;
1212
pub use llff::Heap as LlffHeap;
1313
#[cfg(feature = "tlsf")]
1414
pub use tlsf::Heap as TlsfHeap;
15+
16+
/// Initialize the global heap.
17+
///
18+
/// This macro creates a static, uninitialized memory buffer of the specified size and
19+
/// initializes the heap instance with that buffer.
20+
///
21+
/// # Parameters
22+
///
23+
/// - `$heap:ident`: The identifier of the global heap instance to initialize.
24+
/// - `$size:expr`: An expression evaluating to a `usize` that specifies the size of the
25+
/// static memory buffer in bytes. It must be **greater than zero**.
26+
///
27+
/// # Safety
28+
///
29+
/// This macro must be called first, before any operations on the heap, and **only once**.
30+
///
31+
/// # Example
32+
///
33+
/// ```rust
34+
/// use cortex_m_rt::entry;
35+
/// use embedded_alloc::LlffHeap as Heap;
36+
///
37+
/// #[global_allocator]
38+
/// static HEAP: Heap = Heap::empty();
39+
///
40+
/// #[entry]
41+
/// fn main() -> ! {
42+
/// // Initialize the allocator BEFORE you use it
43+
/// embedded_alloc::init!(HEAP, 1024);
44+
/// let mut xs = Vec::new();
45+
/// // ...
46+
/// }
47+
/// ```
48+
#[macro_export]
49+
macro_rules! init {
50+
($heap:ident, $size:expr) => {
51+
assert!($size > 0);
52+
static mut HEAP_MEM: [core::mem::MaybeUninit<u8>; $size] =
53+
[core::mem::MaybeUninit::uninit(); $size];
54+
#[allow(static_mut_refs)]
55+
unsafe {
56+
$heap.init(&raw mut HEAP_MEM as usize, $size)
57+
}
58+
};
59+
}

0 commit comments

Comments
 (0)