feat(alloc): collect heap statistics (#269)

tosc-rs · Sep 13, 2023 · 34cfc07 · 34cfc07
1 parent efbc428
commit 34cfc07
Show file tree

Hide file tree

Showing 6 changed files with 325 additions and 9 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/platforms/allwinner-d1/boards/src/lib.rs b/platforms/allwinner-d1/boards/src/lib.rs
@@ -18,7 +18,9 @@ static AHEAP: MnemosAlloc<SingleThreadedLinkedListAllocator> = MnemosAlloc::new(
 ///
 /// Only call this once!
 pub unsafe fn initialize_heap<const HEAP_SIZE: usize>(buf: &'static Ram<HEAP_SIZE>) {
-    AHEAP.init(NonNull::new(buf.as_ptr()).unwrap(), HEAP_SIZE);
+    AHEAP
+        .init(NonNull::new(buf.as_ptr()).unwrap(), HEAP_SIZE)
+        .expect("heap should only be initialized once!");
 }
 
 #[panic_handler]

diff --git a/platforms/esp32c3-buddy/src/heap.rs b/platforms/esp32c3-buddy/src/heap.rs
@@ -27,7 +27,9 @@ pub unsafe fn init() {
     };
 
     unsafe {
-        AHEAP.init(heap_start, HEAP_SIZE);
+        AHEAP
+            .init(heap_start, HEAP_SIZE)
+            .expect("heap initialized more than once!")
     }
 }
 

diff --git a/source/alloc/Cargo.toml b/source/alloc/Cargo.toml
@@ -33,6 +33,16 @@ features = ["defmt-impl"]
 version = "0.10.1"
 default-features = false
 
+[dependencies.portable-atomic]
+version = "1.3.3"
+default-features = false
+
 [features]
 default = []
 use-std = []
+# enables tracking heap allocation statistics.
+stats = []
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]