pw_thread/thread_analyzer: explicitly mark max stack as est
Updates the thread_analyzer output to explicitly mark the max
stack used as estimated max stack used to be explicit that
watermarking is not exact and some native APIs cannot differentiate
the last stack word being used versus going past the last stack
word.
No-Docs-Update-Reason: Minor output format change.
Change-Id: I2928a95830e324ae952b0a99a397546a7971b054
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/62648
Reviewed-by: Armando Montanez <amontanez@google.com>
Pigweed-Auto-Submit: Ewout van Bekkum <ewout@google.com>
Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com>
diff --git a/pw_thread/py/pw_thread/thread_analyzer.py b/pw_thread/py/pw_thread/thread_analyzer.py
index 1bd8a38..45614fe 100644
--- a/pw_thread/py/pw_thread/thread_analyzer.py
+++ b/pw_thread/py/pw_thread/thread_analyzer.py
@@ -156,8 +156,8 @@
def __str__(self) -> str:
output = [
'Stack info',
- f' Stack cur used: {self._stack_used_range_str()}',
- f' Stack max used: {self._stack_pointer_est_peak_str()}',
+ f' Current usage: {self._stack_used_range_str()}',
+ f' Est peak usage: {self._stack_pointer_est_peak_str()}',
f' Stack limits: {self._stack_limit_range_str()}',
]
return '\n'.join(output)
diff --git a/pw_thread/py/thread_analyzer_test.py b/pw_thread/py/thread_analyzer_test.py
index 59918fe..96bf391 100644
--- a/pw_thread/py/thread_analyzer_test.py
+++ b/pw_thread/py/thread_analyzer_test.py
@@ -25,8 +25,8 @@
stack_info = StackInfo(thread_pb2.Thread())
expected = '\n'.join(
('Stack info',
- ' Stack cur used: 0x???????? - 0x???????? (size unknown)',
- ' Stack max used: size unknown',
+ ' Current usage: 0x???????? - 0x???????? (size unknown)',
+ ' Est peak usage: size unknown',
' Stack limits: 0x???????? - 0x???????? (size unknown)'))
self.assertFalse(stack_info.has_stack_size_limit())
self.assertFalse(stack_info.has_stack_used())
@@ -39,8 +39,8 @@
expected = '\n'.join(
('Stack info',
- ' Stack cur used: 0x???????? - 0x5ac6a86c (size unknown)',
- ' Stack max used: size unknown',
+ ' Current usage: 0x???????? - 0x5ac6a86c (size unknown)',
+ ' Est peak usage: size unknown',
' Stack limits: 0x???????? - 0x???????? (size unknown)'))
self.assertFalse(stack_info.has_stack_size_limit())
self.assertFalse(stack_info.has_stack_used())
@@ -54,8 +54,8 @@
expected = '\n'.join(
('Stack info',
- ' Stack cur used: 0x5ac6b86c - 0x5ac6a86c (4096 bytes)',
- ' Stack max used: size unknown',
+ ' Current usage: 0x5ac6b86c - 0x5ac6a86c (4096 bytes)',
+ ' Est peak usage: size unknown',
' Stack limits: 0x5ac6b86c - 0x???????? (size unknown)'))
self.assertFalse(stack_info.has_stack_size_limit())
self.assertTrue(stack_info.has_stack_used())
@@ -70,8 +70,8 @@
expected = '\n'.join(
('Stack info',
- ' Stack cur used: 0x5ac6b86c - 0x5ac6a86c (4096 bytes, 50.00%)',
- ' Stack max used: size unknown',
+ ' Current usage: 0x5ac6b86c - 0x5ac6a86c (4096 bytes, 50.00%)',
+ ' Est peak usage: size unknown',
' Stack limits: 0x5ac6b86c - 0x5ac6986c (8192 bytes)'))
self.assertTrue(stack_info.has_stack_size_limit())
self.assertTrue(stack_info.has_stack_used())
@@ -93,8 +93,8 @@
'',
'Thread (UNKNOWN): [unnamed thread]',
'Stack info',
- ' Stack cur used: 0x???????? - 0x???????? (size unknown)',
- ' Stack max used: size unknown',
+ ' Current usage: 0x???????? - 0x???????? (size unknown)',
+ ' Est peak usage: size unknown',
' Stack limits: 0x???????? - 0x???????? (size unknown)',
'',
))
@@ -128,14 +128,14 @@
'',
'Thread (READY): Idle',
'Stack info',
- ' Stack cur used: 0x2001ac00 - 0x2001ab0c (244 bytes, 47.66%)',
- ' Stack max used: 512 bytes, 100.00%',
+ ' Current usage: 0x2001ac00 - 0x2001ab0c (244 bytes, 47.66%)',
+ ' Est peak usage: 512 bytes, 100.00%',
' Stack limits: 0x2001ac00 - 0x2001aa00 (512 bytes)',
'',
'Thread (INTERRUPT_HANDLER): Main/Handler',
'Stack info',
- ' Stack cur used: 0x2001b000 - 0x2001ae20 (480 bytes)',
- ' Stack max used: size unknown',
+ ' Current usage: 0x2001b000 - 0x2001ae20 (480 bytes)',
+ ' Est peak usage: size unknown',
' Stack limits: 0x2001b000 - 0x???????? (size unknown)',
'',
))
@@ -173,14 +173,14 @@
# Ensure the active thread is moved to the top of the list.
'Thread (INTERRUPT_HANDLER): Main/Handler <-- [ACTIVE]',
'Stack info',
- ' Stack cur used: 0x2001b000 - 0x2001ae20 (480 bytes)',
- ' Stack max used: 512 bytes',
+ ' Current usage: 0x2001b000 - 0x2001ae20 (480 bytes)',
+ ' Est peak usage: 512 bytes',
' Stack limits: 0x2001b000 - 0x???????? (size unknown)',
'',
'Thread (READY): Idle',
'Stack info',
- ' Stack cur used: 0x2001ac00 - 0x2001ab0c (244 bytes, 47.66%)',
- ' Stack max used: 256 bytes, 50.00%',
+ ' Current usage: 0x2001ac00 - 0x2001ab0c (244 bytes, 47.66%)',
+ ' Est peak usage: 256 bytes, 50.00%',
' Stack limits: 0x2001ac00 - 0x2001aa00 (512 bytes)',
'',
))
