mnemosyne-memory 0.9.0

Concurrent user-space memory allocator facade
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47

# mnemosyne-memory

The public shell of [Mnemosyne](https://github.com/ryancinsight/mnemosyne), a
concurrent user-space memory allocator written entirely in Rust. The library
name is `mnemosyne`; the crates.io package is `mnemosyne-memory`.

```toml
[dependencies]
mnemosyne-memory = "0.9"
```

```rust
use mnemosyne::Mnemosyne;

#[global_allocator]
static ALLOCATOR: Mnemosyne = Mnemosyne;
```

## What this crate provides

- `Mnemosyne` — the global allocator, routed to `StandardPolicy`.
- `MnemosyneAllocator<P: AllocPolicy>` — the same allocator with a compile-time
  policy injected. `SecurePolicy` adds zero-initialization on allocation and
  `0xDE` poisoning at the deallocation boundary; because the policy is a
  zero-sized type, the unused branch is eliminated at compile time.
- `memory_stats()` / `backend_memory_stats()` — mapping, purge, and thread-cache
  telemetry.
- `configure()` / `get_options()` — runtime tuning of segment retention and
  purge cadence.
- `usable_size(ptr)` — the allocator's actual reservation for a pointer, the
  equivalent of `mi_usable_size` / `malloc_usable_size`.
- `reset()` / `purge()` — RSS reduction, with and without surrendering address
  space.
- `scratch` — aligned scratch lanes for `f32`, `f64`, and `u8`.
- `counting` — `CountingAllocator<A>`, a `GlobalAlloc` wrapper that counts
  allocations, reallocations, deallocations, and bytes per thread, and
  `measure`, which returns a closure's value with the counts its thread
  produced, for allocation-budget tests that must not see other threads.
- Branded heap re-exports (`branded_scope`, `BrandedBox`, `BrandedVec`,
  `BrandedCell`) behind the `branded` feature.

The design follows mimalloc's free-list sharding and segment/page geometry and
snmalloc's message-passing cross-thread frees. See the
[repository README](https://github.com/ryancinsight/mnemosyne#readme) for the
mechanism-to-source-paper table.

Licensed under MIT OR Apache-2.0.