esp-alloc 0.11.0

A heap allocator for Espressif devices
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

[package]
name          = "esp-alloc"
version       = "0.11.0"
edition       = "2024"
rust-version  = "1.95.0"
description   = "A heap allocator for Espressif devices"
documentation = "https://docs.espressif.com/projects/rust/esp-alloc/latest/"
keywords      = ["allocator", "embedded", "esp32", "espressif", "memory"]
categories    = ["embedded", "memory-management", "no-std"]
repository    = "https://github.com/esp-rs/esp-hal"
license       = "MIT OR Apache-2.0"

[package.metadata.espressif]
# FIXME: enable doc tests by removing this once the docs are fixed up.
skip-doctests = true
doc-config = { features = ["defmt"] }
check-configs = [
    { features = [] },
    { features = ["defmt"] },
    { features = ["alloc-hooks"] },
    { features = ["internal-heap-stats"] },
    { features = ["defmt", "internal-heap-stats"] },
]
clippy-configs = [
    { features = ["defmt", "internal-heap-stats", "alloc-hooks"] },
]

[package.metadata.docs.rs]
default-target = "riscv32imc-unknown-none-elf"
features       = ["esp32c6", "nightly"]

[lib]
bench = false
test = false

[dependencies]
allocator-api2        = { version = "0.3.0", default-features = false }
defmt                 = { version = "1.1", optional = true }
enumset               = "1"
esp-sync              = { version = "0.3.0", path = "../esp-sync" }
document-features     = "0.2"

linked_list_allocator = { version = "0.10.5", default-features = false, features = ["const_mut_refs"] }
rlsf = { version = "0.2", features = ["unstable"] }

[build-dependencies]
esp-config             = { version = "0.8.0", path = "../esp-config", features = ["build"] }
esp-metadata-generated = { version = "0.5.0", path = "../esp-metadata-generated", features = ["build-script"] }

[features]
default = ["compat", "global-allocator"]

## Enable nightly rustc-only features, like `feature(allocator_api)`.
nightly = []

## Implement `defmt::Format` on certain types.
defmt = ["dep:defmt", "enumset/defmt"]

## Enable this feature if you want to keep stats about the internal heap usage such as:
## - Max memory usage since initialization of the heap
## - Total allocated memory since initialization of the heap
## - Total freed memory since initialization of the heap
##
## ⚠️ Note: Enabling this feature will require extra computation every time alloc/dealloc is called.
internal-heap-stats = []

## Provide C-compatibility functions (malloc, free, ...)
##
## Note that allocated memory returned by all these functions is 4-byte aligned.
## This is in-line with e.g. ESP-IDF and the supported CPU architectures and usually
## not a problem.
##
## Strictly speaking it violates `malloc`s contract saying
## > "...  functions return a pointer to the allocated memory, which is suitably
## > aligned for any type that fits into the requested size or less."
##
## However this _can_ cause problems when using the allocated memory from Rust
## where alignment checks are in place. So special caution might be needed in this case.
compat = []

## Enable the `#[global_allocator]` attribute for `EspHeap`.
global-allocator = []

## Enable observing allocation events via hook functions.
##
## This option requires the following functions to be implemented:
##
## ```rust,no_run
## use esp_alloc::{EspHeap, MemoryCapability};
## use enumset::EnumSet; // from `enumset = "1"`
##
## #[unsafe(no_mangle)]
## unsafe extern "Rust" fn _esp_alloc_alloc(
##     _heap: &EspHeap,
##     _caps: EnumSet<MemoryCapability>,
##     ptr: usize,
##     size: usize,
## ) {
##     todo!()
## }
##
## #[unsafe(no_mangle)]
## unsafe extern "Rust" fn _esp_alloc_dealloc(_heap: &EspHeap, ptr: usize, size: usize) {
##     todo!()
## }
## ```
alloc-hooks = []

#! ### Chip selection
#! One of the following features must be enabled to select the target chip:

##
esp32c2  = ["esp-sync/esp32c2", "esp-metadata-generated/esp32c2"]
##
esp32c3  = ["esp-sync/esp32c3", "esp-metadata-generated/esp32c3"]
##
esp32c5  = ["esp-sync/esp32c5", "esp-metadata-generated/esp32c5"]
##
esp32c6  = ["esp-sync/esp32c6", "esp-metadata-generated/esp32c6"]
##
esp32c61 = ["esp-sync/esp32c61", "esp-metadata-generated/esp32c61"]
##
esp32h2  = ["esp-sync/esp32h2", "esp-metadata-generated/esp32h2"]
##
esp32p4  = ["esp-sync/esp32p4", "esp-metadata-generated/esp32p4"]
##
esp32s31 = ["esp-sync/esp32s31", "esp-metadata-generated/esp32s31"]
##
esp32    = ["esp-sync/esp32", "esp-metadata-generated/esp32"]
##
esp32s2  = ["esp-sync/esp32s2", "esp-metadata-generated/esp32s2"]
##
esp32s3  = ["esp-sync/esp32s3", "esp-metadata-generated/esp32s3"]