Memfault Firmware SDK 1.3.1 (Build 3608)

Author: Memfault Inc

CHANGES.md

@@ -1,5 +1,14 @@
 # Memfault Firmware SDK Changelog
 
+## 1.3.1 - Sept 21, 2023
+
+### :chart_with_upwards_trend: Improvements
+
+- Zephyr:
+  - Add a new Kconfig, `CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE`, to
+    control whether thread stack usage is computed and collected on device
+    during a coredump.
+
 ## 1.3.0 - Sept 20, 2023
 
 ### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 3558
-GIT COMMIT: 597c76e06
-VERSION: 1.3.0
+BUILD ID: 3608
+GIT COMMIT: 4124d24ad
+VERSION: 1.3.1

components/include/memfault/version.h

@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 3, .patch = 0 }
-#define MEMFAULT_SDK_VERSION_STR "1.3.0"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 3, .patch = 1 }
+#define MEMFAULT_SDK_VERSION_STR "1.3.1"
 
 #ifdef __cplusplus
 }

ports/zephyr/Kconfig

@@ -101,6 +101,13 @@ config MEMFAULT_COREDUMP_COLLECT_TASKS_REGIONS
           When enabled, Zephyr thread stacks will be captured as part of the
           coredump. Disabling this will disable non-active-thread backtrace.
 
+config MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE
+        bool "Compute thread stack usage on device"
+        default y
+        depends on THREAD_STACK_INFO && !STACK_GROWS_UP && INIT_STACKS
+        help
+          Adds thread stack usage computed during fault handling into a coredump.
+
 config MEMFAULT_HEAP_STATS
         bool "Collect system heap stats with coredumps"
         default y

ports/zephyr/common/memfault_zephyr_ram_regions.c

@@ -29,9 +29,12 @@ static struct k_thread *s_task_tcbs[CONFIG_MEMFAULT_COREDUMP_MAX_TRACKED_TASKS];
       "Only full-descending stacks are supported by this implementation. Please contact [email protected]."
 #endif
 
+  #if defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
 static struct MfltTaskWatermarks {
   uint32_t high_watermark;
 } s_task_watermarks[CONFIG_MEMFAULT_COREDUMP_MAX_TRACKED_TASKS];
+  #endif  // defined(CONFIG_MEMFAULT_COMPUTE_STACK_HIGHWATER_ON_DEVICE)
+
 #endif
 
 #define EMPTY_SLOT 0
@@ -105,6 +108,7 @@ size_t memfault_platform_sanitize_address_range(void *start_addr, size_t desired
   return 0;
 }
 
+#if defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
 //! Compute the high watermark of a task's stack. This is the amount of stack
 //! that has been written to since the task was created.
 static ssize_t prv_stack_bytes_unused(uintptr_t stack_start, size_t stack_size) {
@@ -119,14 +123,15 @@ static ssize_t prv_stack_bytes_unused(uintptr_t stack_start, size_t stack_size)
   // looking for the first address that contains something other than the stack
   // painting pattern, 0xAA.
   const uint8_t *stack_max = (const uint8_t *)stack_start;
-  const uint8_t * const stack_bottom = (const uint8_t * const)(stack_start + stack_size);
+  const uint8_t *const stack_bottom = (const uint8_t *const)(stack_start + stack_size);
 
   for (; (stack_max < stack_bottom) && (*stack_max == 0xAA); stack_max++) {
   }
 
   // return the "bytes unused" count for the stack
   return (uintptr_t)stack_max - stack_start;
 }
+#endif  // defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
 
 size_t memfault_zephyr_get_task_regions(sMfltCoredumpRegion *regions, size_t num_regions) {
   if (regions == NULL || num_regions == 0) {
@@ -174,10 +179,10 @@ size_t memfault_zephyr_get_task_regions(sMfltCoredumpRegion *regions, size_t num
       // when collecting partial stacks, thread context is only valid when task
       // is _not_ running so we skip collecting it. just update the watermark
       // for the thread
-      #if CONFIG_THREAD_STACK_INFO
+    #if defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
       s_task_watermarks[i].high_watermark =
         prv_stack_bytes_unused(thread->stack_info.start, thread->stack_info.size);
-      #endif
+    #endif  // defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
       continue;
     }
 #endif
@@ -207,21 +212,21 @@ size_t memfault_zephyr_get_task_regions(sMfltCoredumpRegion *regions, size_t num
       continue;
     }
 
-#if defined(CONFIG_THREAD_STACK_INFO)
+#if defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
     // compute high watermarks for each task
     s_task_watermarks[i].high_watermark =
       prv_stack_bytes_unused(thread->stack_info.start, thread->stack_info.size);
-#endif
+#endif  // defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
 
     regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(sp, stack_size_to_collect);
     region_idx++;
   }
 
-#if defined(CONFIG_THREAD_STACK_INFO)
+#if defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
   regions[region_idx] =
     MEMFAULT_COREDUMP_MEMORY_REGION_INIT(s_task_watermarks, sizeof(s_task_watermarks));
   region_idx++;
-#endif
+#endif  // defined(CONFIG_MEMFAULT_COREDUMP_COMPUTE_THREAD_STACK_USAGE)
 
   regions[region_idx] = MEMFAULT_COREDUMP_MEMORY_REGION_INIT(s_task_tcbs, sizeof(s_task_tcbs));
   region_idx++;