Add heap free size interface

Author: JalonWong

freertos-cargo-build/Cargo.toml

@@ -6,7 +6,7 @@
     license = "MIT"
     name = "freertos-build"
     readme = "README.md"
-    version = "0.4.3"
+    version = "0.4.4"
 
 [lib]
 

freertos-cargo-build/src/lib.rs

@@ -376,6 +376,7 @@ fn setup_all_define(cc: &mut cc::Build) {
     sync_define(cc, "INCLUDE_vTaskDelete");
     sync_define(cc, "INCLUDE_vTaskDelayUntil");
     sync_define(cc, "INCLUDE_uxTaskGetStackHighWaterMark");
+    sync_define(cc, "INCLUDE_HeapFreeSize");
     cc.define("INCLUDE_vTaskDelay", "1");
 }
 

freertos-rust/Cargo.toml

@@ -10,7 +10,7 @@ The freertos-build crate can be used to build and link FreeRTOS from source insi
     links = "freertos"
     name = "freertos-next"
     readme = "README.md"
-    version = "0.7.4"
+    version = "0.7.5"
 
 
 [lib]
@@ -34,6 +34,7 @@ The freertos-build crate can be used to build and link FreeRTOS from source insi
     critical_section_impl = ["critical-section/restore-state-u32"]
     delay_until = []
     delete_task = []
+    heap_free_size = ["allocator"]
     hooks = []
     interrupt = []
     stack_high_water = []

freertos-rust/build.rs

@@ -27,6 +27,7 @@ fn main() {
         ("delete_task", "INCLUDE_vTaskDelete"),
         ("delay_until", "INCLUDE_vTaskDelayUntil"),
         ("stack_high_water", "INCLUDE_uxTaskGetStackHighWaterMark"),
+        ("heap_free_size", "INCLUDE_HeapFreeSize"),
     ]);
 
     for (ft, def) in feature_define_map.iter() {

freertos-rust/src/allocator.rs

@@ -11,6 +11,21 @@ Use with:
 
 pub struct FreeRtosAllocator;
 
+#[cfg(feature = "heap_free_size")]
+impl FreeRtosAllocator {
+    pub fn get_free_size(&self) -> usize {
+        unsafe { freertos_rs_get_free_heap_size() }
+    }
+
+    pub fn get_min_free_size(&self) -> usize {
+        unsafe { freertos_rs_get_minimum_free_heap_size() }
+    }
+
+    pub fn reset_min_free_size(&self) {
+        unsafe { freertos_rs_reset_minimum_free_heap_size() }
+    }
+}
+
 unsafe impl GlobalAlloc for FreeRtosAllocator {
     unsafe fn alloc(&self, layout: Layout) -> *mut u8 {
         let res = unsafe { freertos_rs_pvPortMalloc(layout.size() as u32) };

freertos-rust/src/freertos/shim.c

@@ -478,3 +478,17 @@ EventBits_t freertos_rs_event_group_sync(EventGroupHandle_t event_group, const E
                                          const EventBits_t bits_to_wait_for, TickType_t ticks_to_wait) {
     return xEventGroupSync(event_group, bits_to_set, bits_to_wait_for, ticks_to_wait);
 }
+
+#if (INCLUDE_HeapFreeSize == 1)
+size_t freertos_rs_get_free_heap_size() {
+    return xPortGetFreeHeapSize();
+}
+
+size_t freertos_rs_get_minimum_free_heap_size() {
+    return xPortGetMinimumEverFreeHeapSize();
+}
+
+void freertos_rs_reset_minimum_free_heap_size() {
+    xPortResetHeapMinimumEverFreeHeapSize();
+}
+#endif

freertos-rust/src/shim.rs

@@ -198,4 +198,8 @@ unsafe extern "C" {
         bits_to_wait_for: FreeRtosEventBitsType,
         ticks_to_wait: FreeRtosTickType,
     ) -> FreeRtosEventBitsType;
+
+    pub fn freertos_rs_get_free_heap_size() -> usize;
+    pub fn freertos_rs_get_minimum_free_heap_size() -> usize;
+    pub fn freertos_rs_reset_minimum_free_heap_size();
 }

freertos-rust/src/task.rs

@@ -303,12 +303,20 @@ impl Task {
         }
     }
 
+    /// Get the minimum amount of stack that was ever left on this task in words.
     #[cfg(feature = "stack_high_water")]
-    /// Get the minimum amount of stack that was ever left on this task.
+    #[inline]
     pub fn get_stack_high_water_mark(&self) -> u32 {
         unsafe { freertos_rs_get_stack_high_water_mark(self.task_handle) as u32 }
     }
 
+    /// Get the minimum amount of stack that was ever left on this task in bytes.
+    #[cfg(feature = "stack_high_water")]
+    #[inline]
+    pub fn get_stack_high_water_mark_bytes(&self) -> u32 {
+        self.get_stack_high_water_mark() * 4
+    }
+
     pub fn get_id(&self) -> Result<FreeRtosBaseType, FreeRtosError> {
         let task_id = unsafe { freertos_rs_uxTaskGetTaskNumber(self.task_handle) };
         if task_id == 0 {
@@ -347,11 +355,19 @@ impl CurrentTask {
         unsafe { freertos_rs_task_notify_take(if clear { 1 } else { 0 }, wait_for.to_ticks()) }
     }
 
-    #[cfg(feature = "stack_high_water")]
     /// Get the minimum amount of stack that was ever left on the current task.
+    #[cfg(feature = "stack_high_water")]
+    #[inline]
     pub fn get_stack_high_water_mark() -> u32 {
         unsafe { freertos_rs_get_stack_high_water_mark(0 as FreeRtosTaskHandle) as u32 }
     }
+
+    /// Get the minimum amount of stack that was ever left on this task in bytes.
+    #[cfg(feature = "stack_high_water")]
+    #[inline]
+    pub fn get_stack_high_water_mark_bytes() -> u32 {
+        Self::get_stack_high_water_mark() * 4
+    }
 }
 
 #[derive(Debug)]