Add task stack high water mark feature

JalonWong · JalonWong · commit bc9302ea3ca9 · 2025-12-18T15:44:40.000-06:00
diff --git a/freertos-cargo-build/Cargo.toml b/freertos-cargo-build/Cargo.toml
@@ -6,7 +6,7 @@
     license = "MIT"
     name = "freertos-build"
     readme = "README.md"
-    version = "0.4.2"
+    version = "0.4.3"
 
 [lib]
 
diff --git a/freertos-cargo-build/src/lib.rs b/freertos-cargo-build/src/lib.rs
@@ -375,6 +375,7 @@ fn add_include_with_rerun<P: AsRef<Path>>(build: &mut Build, dir: P) {
 fn setup_all_define(cc: &mut cc::Build) {
     sync_define(cc, "INCLUDE_vTaskDelete");
     sync_define(cc, "INCLUDE_vTaskDelayUntil");
+    sync_define(cc, "INCLUDE_uxTaskGetStackHighWaterMark");
     cc.define("INCLUDE_vTaskDelay", "1");
 }
 
diff --git a/freertos-rust-examples/examples/linux/FreeRTOSConfig.h b/freertos-rust-examples/examples/linux/FreeRTOSConfig.h
@@ -125,7 +125,6 @@ functions anyway. */
 #define INCLUDE_uxTaskPriorityGet              1
 #define INCLUDE_vTaskCleanUpResources          0
 #define INCLUDE_vTaskSuspend                   1
-#define INCLUDE_uxTaskGetStackHighWaterMark    1
 #define INCLUDE_xTaskGetSchedulerState         1
 #define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
 #define INCLUDE_xTaskGetIdleTaskHandle         1
diff --git a/freertos-rust-examples/examples/nrf9160/FreeRTOSConfig.h b/freertos-rust-examples/examples/nrf9160/FreeRTOSConfig.h
@@ -133,18 +133,17 @@ extern void vAssertCalled(const char *file, int linenum);
  * to exclude the API function.  NOTE:  Setting an INCLUDE_ parameter to 0 is
  * only necessary if the linker does not automatically remove functions that are
  * not referenced anyway. */
-#define INCLUDE_vTaskPrioritySet            1
-#define INCLUDE_uxTaskPriorityGet           1
-#define INCLUDE_vTaskCleanUpResources       0
-#define INCLUDE_vTaskSuspend                1
-#define INCLUDE_uxTaskGetStackHighWaterMark 0
-#define INCLUDE_xTaskGetIdleTaskHandle      0
-#define INCLUDE_eTaskGetState               1
-#define INCLUDE_xTaskResumeFromISR          0
-#define INCLUDE_xTaskGetCurrentTaskHandle   1
-#define INCLUDE_xTaskGetSchedulerState      0
-#define INCLUDE_xSemaphoreGetMutexHolder    0
-#define INCLUDE_xTimerPendFunctionCall      1
+#define INCLUDE_vTaskPrioritySet          1
+#define INCLUDE_uxTaskPriorityGet         1
+#define INCLUDE_vTaskCleanUpResources     0
+#define INCLUDE_vTaskSuspend              1
+#define INCLUDE_xTaskGetIdleTaskHandle    0
+#define INCLUDE_eTaskGetState             1
+#define INCLUDE_xTaskResumeFromISR        0
+#define INCLUDE_xTaskGetCurrentTaskHandle 1
+#define INCLUDE_xTaskGetSchedulerState    0
+#define INCLUDE_xSemaphoreGetMutexHolder  0
+#define INCLUDE_xTimerPendFunctionCall    1
 
 /* This demo makes use of one or more example stats formatting functions.  These
  * format the raw data provided by the uxTaskGetSystemState() function in to
diff --git a/freertos-rust-examples/examples/stm32-cortex-m3/FreeRTOSConfig.h b/freertos-rust-examples/examples/stm32-cortex-m3/FreeRTOSConfig.h
@@ -149,12 +149,11 @@ extern void set_PA0_dbgOut(bool onOff);
 /* Set the following definitions to 1 to include the API function, or zero
 to exclude the API function. */
 
-#define INCLUDE_vTaskPrioritySet            1
-#define INCLUDE_uxTaskPriorityGet           1
-#define INCLUDE_vTaskCleanUpResources       0
-#define INCLUDE_vTaskSuspend                1
-#define INCLUDE_uxTaskGetStackHighWaterMark 1
-#define INCLUDE_eTaskGetState               1
+#define INCLUDE_vTaskPrioritySet      1
+#define INCLUDE_uxTaskPriorityGet     1
+#define INCLUDE_vTaskCleanUpResources 0
+#define INCLUDE_vTaskSuspend          1
+#define INCLUDE_eTaskGetState         1
 
 /* Use the system definition, if there is one */
 // #ifdef __NVIC_PRIO_BITS
diff --git a/freertos-rust-examples/examples/stm32-cortex-m4-blackpill/FreeRTOSConfig.h b/freertos-rust-examples/examples/stm32-cortex-m4-blackpill/FreeRTOSConfig.h
@@ -149,12 +149,11 @@ extern void set_PA0_dbgOut(bool onOff);
 /* Set the following definitions to 1 to include the API function, or zero
 to exclude the API function. */
 
-#define INCLUDE_vTaskPrioritySet            1
-#define INCLUDE_uxTaskPriorityGet           1
-#define INCLUDE_vTaskCleanUpResources       0
-#define INCLUDE_vTaskSuspend                1
-#define INCLUDE_uxTaskGetStackHighWaterMark 1
-#define INCLUDE_eTaskGetState               1
+#define INCLUDE_vTaskPrioritySet      1
+#define INCLUDE_uxTaskPriorityGet     1
+#define INCLUDE_vTaskCleanUpResources 0
+#define INCLUDE_vTaskSuspend          1
+#define INCLUDE_eTaskGetState         1
 
 /* Use the system definition, if there is one */
 // #ifdef __NVIC_PRIO_BITS
diff --git a/freertos-rust-examples/examples/win/FreeRTOSConfig.h b/freertos-rust-examples/examples/win/FreeRTOSConfig.h
@@ -101,7 +101,6 @@ functions anyway. */
 #define INCLUDE_uxTaskPriorityGet              1
 #define INCLUDE_vTaskCleanUpResources          0
 #define INCLUDE_vTaskSuspend                   1
-#define INCLUDE_uxTaskGetStackHighWaterMark    1
 #define INCLUDE_xTaskGetSchedulerState         1
 #define INCLUDE_xTimerGetTimerDaemonTaskHandle 1
 #define INCLUDE_xTaskGetIdleTaskHandle         1
diff --git a/freertos-rust/Cargo.toml b/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.3"
+    version = "0.7.4"
 
 
 [lib]
@@ -21,7 +21,13 @@ The freertos-build crate can be used to build and link FreeRTOS from source insi
     default = ["minimum"]
 
     minimum = ["allocator", "sync", "time"]
-    standard = ["minimum", "hooks", "delete_task", "critical_section_impl"]
+    standard = [
+        "minimum",
+        "hooks",
+        "delete_task",
+        "stack_high_water",
+        "critical_section_impl",
+    ]
 
     allocator = []
     cpu_clock = []
@@ -30,6 +36,7 @@ The freertos-build crate can be used to build and link FreeRTOS from source insi
     delete_task = []
     hooks = []
     interrupt = []
+    stack_high_water = []
     sync = ["interrupt"]
     time = ["interrupt"]
 
diff --git a/freertos-rust/build.rs b/freertos-rust/build.rs
@@ -26,6 +26,7 @@ fn main() {
     let feature_define_map = HashMap::from([
         ("delete_task", "INCLUDE_vTaskDelete"),
         ("delay_until", "INCLUDE_vTaskDelayUntil"),
+        ("stack_high_water", "INCLUDE_uxTaskGetStackHighWaterMark"),
     ]);
 
     for (ft, def) in feature_define_map.iter() {
diff --git a/freertos-rust/src/freertos/shim.c b/freertos-rust/src/freertos/shim.c
@@ -236,14 +236,11 @@ void freertos_rs_suspend_task(TaskHandle_t task) {
     vTaskSuspend(task);
 }
 
-UBaseType_t freertos_rs_get_stack_high_water_mark(TaskHandle_t task) {
 #if (INCLUDE_uxTaskGetStackHighWaterMark == 1)
+UBaseType_t freertos_rs_get_stack_high_water_mark(TaskHandle_t task) {
     return uxTaskGetStackHighWaterMark(task);
-#else
-    (void)task;
-    return 0;
-#endif
 }
+#endif
 
 QueueHandle_t freertos_rs_queue_create(UBaseType_t queue_length, UBaseType_t item_size) {
     return xQueueCreate(queue_length, item_size);
diff --git a/freertos-rust/src/task.rs b/freertos-rust/src/task.rs
@@ -303,6 +303,7 @@ impl Task {
         }
     }
 
+    #[cfg(feature = "stack_high_water")]
     /// Get the minimum amount of stack that was ever left on this task.
     pub fn get_stack_high_water_mark(&self) -> u32 {
         unsafe { freertos_rs_get_stack_high_water_mark(self.task_handle) as u32 }
@@ -346,6 +347,7 @@ 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.
     pub fn get_stack_high_water_mark() -> u32 {
         unsafe { freertos_rs_get_stack_high_water_mark(0 as FreeRtosTaskHandle) as u32 }

Original file line number	Diff line number	Diff line change
`@@ -375,6 +375,7 @@ fn add_include_with_rerun<P: AsRef<Path>>(build: &mut Build, dir: P) {`
`375`	`375`	`fn setup_all_define(cc: &mut cc::Build) {`
`376`	`376`	`sync_define(cc, "INCLUDE_vTaskDelete");`
`377`	`377`	`sync_define(cc, "INCLUDE_vTaskDelayUntil");`
	`378`	`+ sync_define(cc, "INCLUDE_uxTaskGetStackHighWaterMark");`
`378`	`379`	`cc.define("INCLUDE_vTaskDelay", "1");`
`379`	`380`	`}`
`380`	`381`