pw_thread_freertos: Fix peak stack usage capture

Change-Id: I39ca6b4a9fb352d3fdd3a445e9e9de934bc4de39 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/108150 Reviewed-by: Armando Montanez <[email protected]> Commit-Queue: Medha Kini <[email protected]>
google · Aug 26, 2022 · fbf06e6 · fbf06e6
1 parent d5524c8
commit fbf06e6
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 7 deletions.
diff --git a/pw_thread_freertos/docs.rst b/pw_thread_freertos/docs.rst
@@ -169,10 +169,10 @@ via ``xTaskGetSchedulerState()``.
 ------------------------
 Thread Iteration Backend
 ------------------------
-A backend for ``pw::thread::thread_iteration``. This requires
-``pw_thread_freertos_TSKTCB_BACKEND`` and
-``pw_third_party_freertos_DISABLE_TASKS_STATICS`` to be enabled and configured
-properly.
+``pw_thread_freertos_TSKTCB_BACKEND`` to be configured
+properly and ``pw_third_party_freertos_DISABLE_TASKS_STATICS`` to be enabled.
+To allow for peak stack usage measurement, the FreeRTOS config
+``INCLUDE_uxTaskGetStackHighWaterMark`` should also be enabled.
 
 --------------------
 Thread Sleep Backend

diff --git a/pw_thread_freertos/thread_iteration.cc b/pw_thread_freertos/thread_iteration.cc
@@ -43,9 +43,15 @@ bool StackInfoCollector(TaskHandle_t current_thread,
   thread_info.set_stack_high_addr(
       reinterpret_cast<uintptr_t>(tcb.pxEndOfStack));
 #if INCLUDE_uxTaskGetStackHighWaterMark
-  // Walk through the stack from start to end to measure the current peak
-  // using high-water marked stack data.
-  thread_info.set_stack_peak_addr(uxTaskGetStackHighWaterMark(thread));
+// Walk through the stack from start to end to measure the current peak
+// using high-water marked stack data.
+#if (portSTACK_GROWTH > 0)
+  thread_info.set_stack_peak_addr(thread_info.stack_high_addr().value() -
+                                  uxTaskGetStackHighWaterMark(current_thread));
+#else
+  thread_info.set_stack_peak_addr(thread_info.stack_low_addr().value() +
+                                  uxTaskGetStackHighWaterMark(current_thread));
+#endif  // portSTACK_GROWTH > 0
 #endif  // INCLUDE_uxTaskGetStackHighWaterMark
 #endif  // configRECORD_STACK_HIGH_ADDRESS
 

diff --git a/targets/stm32f429i_disc1_stm32cube/config/FreeRTOSConfig.h b/targets/stm32f429i_disc1_stm32cube/config/FreeRTOSConfig.h
@@ -71,6 +71,7 @@ extern unsigned long getRunTimeCounterValue(void);
 #define INCLUDE_vTaskPrioritySet 1
 #define INCLUDE_vTaskSuspend 1
 #define INCLUDE_xTaskGetSchedulerState 1
+#define INCLUDE_uxTaskGetStackHighWaterMark 1
 
 // Instead of defining configASSERT(), include a header that provides a
 // definition that redirects to pw_assert.