commonware-allocator 2026.9.0

Allocate and manage memory.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

//! Nondefault process-wide configuration.

#![cfg(feature = "mimalloc")]

use commonware_allocator::mimalloc::{
    ARENA_CHUNK_SIZE, Config, Effective, MiMalloc, Purge, Reserve, ReserveOutcome, Stats, Status,
    is_global_allocator,
};

#[global_allocator]
static GLOBAL: MiMalloc = MiMalloc::new(Config {
    purge: Purge::Never,
    reserve: Some(Reserve::unpinned(ARENA_CHUNK_SIZE + 1)),
    allow_large_os_pages: Some(true),
    arena_eager_commit: Some(false),
    arena_reserve: Some(ARENA_CHUNK_SIZE + 1),
    ..Config::DEFAULT
});

#[test]
fn configured_options_are_effective() {
    assert!(is_global_allocator());
    let status = Status::read();
    assert!(status.configured);
    assert_eq!(status.reserve, ReserveOutcome::Reserved);
    let stats = Stats::read().expect("stats must be available");
    assert!(stats.reserved_bytes >= ARENA_CHUNK_SIZE as u64);
    let effective = Effective::read();
    assert_eq!(effective.purge, None);
    assert_eq!(effective.arena_eager_commit, 0);
    assert!(effective.allow_large_os_pages);
    assert_eq!(effective.arena_reserve, ARENA_CHUNK_SIZE + 1024);
}