Memfault Firmware SDK 0.41.1 (Build 1633)

Memfault Inc · Memfault Inc · commit dbdeb48eb09f · 2023-03-02T14:12:58.000Z
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,3 +1,21 @@
+### Changes between Memfault SDK 0.41.1 and SDK 0.41.0 - Mar 1, 2023
+
+#### :chart_with_upwards_trend: Improvements
+
+- Zephyr / nRF-Connect SDk:
+
+  - Fix a bug 🐛 in the Memfault Logging backend, that causes coredump saving to
+    fail when building with Zephyr versions before 3.0 (nRF-Connect SDK < 2.0).
+    This regression was introduced in Memfault Firmware SDK **0.33.3**.
+
+- ESP-IDF:
+  - Updated the [ESP32 example app](examples/esp32) for the ESP32-C3 on ESP-IDF
+    v5.0.1 to use size optimizations, to more closely mirror real world
+    environments and codesize.
+  - Fix a compilation error in the [ESP32 example app](examples/esp32) when
+    targeting ESP-IDF >=4.4,<4.4.3 . This regression was introduced in Memfault
+    Firmware SDK **0.39.1**.
+
 ### Changes between Memfault SDK 0.41.0 and SDK 0.40.0 - Feb 22, 2023
 
 #### :rocket: New Features
@@ -7,7 +25,7 @@
     for your work on this in
     [#42](https://github.com/memfault/memfault-firmware-sdk/pull/42) 🎉!
 
-### Changes between Memfault SDK 0.40.1 and SDK 0.39.1 - Feb 15, 2023
+### Changes between Memfault SDK 0.40.0 and SDK 0.39.1 - Feb 15, 2023
 
 #### :bomb: Breaking Changes
 
@@ -18,7 +36,7 @@
     in a build error. For more information please see
     https://docs.memfault.com/docs/mcu/esp32-guide#initializing-memfault
 
-### Changes between Memfault SDK 0.39.1 and SDK 0.38.0 - Feb 3, 2023
+### Changes between Memfault SDK 0.39.1 and SDK 0.39.0 - Feb 3, 2023
 
 #### :rocket: New Features
 
diff --git a/VERSION b/VERSION
@@ -1,2 +1,2 @@
-BUILD ID: 1575
-GIT COMMIT: cacbe4d5d
+BUILD ID: 1633
+GIT COMMIT: 12ef0db7f
diff --git a/components/include/memfault/version.h b/components/include/memfault/version.h
@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 41, .patch = 0 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 41, .patch = 1 }
 
 #ifdef __cplusplus
 }
diff --git a/examples/esp32/apps/memfault_demo_app/main/Kconfig.projbuild b/examples/esp32/apps/memfault_demo_app/main/Kconfig.projbuild
@@ -67,4 +67,15 @@ config BLINK_GPIO
         GPIO number (IOxx) to blink on and off or the RMT signal for the addressable LED.
         Some GPIOs are used for other purposes (flash connections, etc.) and cannot be used to blink.
 
+# esp32c3 specific settings
+if IDF_TARGET_ESP32C3
+    # Default optimize for size due to increase in binary size
+    # This can be changed in root -> Compiler Options
+    # The choice and prompt lines are required and must match the esp-idf definition
+    choice COMPILER_OPTIMIZATION
+        prompt "Optimization Level"
+        default COMPILER_OPTIMIZATION_SIZE
+    endchoice
+endif
+
 endmenu
diff --git a/examples/nrf-connect-sdk/nrf5/memfault_demo_app/prj.conf b/examples/nrf-connect-sdk/nrf5/memfault_demo_app/prj.conf
@@ -47,3 +47,6 @@ CONFIG_IMG_MANAGER=y
 CONFIG_FLASH=y
 
 CONFIG_WATCHDOG=y
+
+# Enable Zephyr runtime asserts
+CONFIG_ASSERT=y
diff --git a/examples/nrf-connect-sdk/nrf9160/memfault_demo_app/prj.conf b/examples/nrf-connect-sdk/nrf9160/memfault_demo_app/prj.conf
@@ -59,6 +59,9 @@ CONFIG_LTE_AUTO_INIT_AND_CONNECT=n
 
 CONFIG_WATCHDOG=y
 
+# Enable Zephyr runtime asserts
+CONFIG_ASSERT=y
+
 # Note: See ./CMakeLists.txt for additional Kconfig variables settings as not all variables can be
 # set in a single prj.conf for backward compatibility with older versions of the nRF Connect SDK /
 # Zephyr
diff --git a/examples/zephyr/qemu/README.md b/examples/zephyr/qemu/README.md
@@ -3,6 +3,10 @@
 Based on https://github.com/zephyrproject-rtos/example-application , this
 provides a minimal reference for Memfault integration.
 
+> Note: this example can also target other boards and should work normally- for
+> example `nrf52840dk_nrf52840`. It's primarily tested on the `qemu_cortex_m3`
+> board, which is also the default.
+
 ## Usage
 
 After setting up a zephyr development environment
@@ -11,12 +15,12 @@ the following commands to test the application:
 
 ```shell
 # initialize this project
-❯ west init -l qemu-app
+❯ west init --local qemu-app
 ❯ west update
 
-# build the target program
-❯ west build -b qemu_cortex_m3 --pristine=always qemu-app
-❯ west build -t run
+# build and run the target program
+❯ west build qemu-app
+❯ west build --target run
 
 *** Booting Zephyr OS build zephyr-v3.2.0  ***
 [00:00:00.000,000] <inf> mflt: GNU Build ID: 4ffb5879ed5923582035133086015bbf65504364
diff --git a/examples/zephyr/qemu/qemu-app/CMakeLists.txt b/examples/zephyr/qemu/qemu-app/CMakeLists.txt
@@ -2,6 +2,10 @@
 
 cmake_minimum_required(VERSION 3.20.0)
 
+# The default board for this example is the qemu_cortex_m3, but can be
+# overridden by passing --board=<board> to west or -DBOARD=<board> to cmake
+set(BOARD qemu_cortex_m3)
+
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
 
 target_sources(app PRIVATE src/main.c)
diff --git a/examples/zephyr/qemu/qemu-app/prj.conf b/examples/zephyr/qemu/qemu-app/prj.conf
@@ -23,5 +23,10 @@ CONFIG_LOG_BACKEND_UART=y
 CONFIG_SHELL_LOG_BACKEND=n
 
 CONFIG_SYS_HEAP_RUNTIME_STATS=y
+
+# Increase the heap pool and main stack sizes for the example app
 CONFIG_HEAP_MEM_POOL_SIZE=4096
 CONFIG_MAIN_STACK_SIZE=4096
+
+# Enable Zephyr runtime asserts
+CONFIG_ASSERT=y
diff --git a/examples/zephyr/qemu/qemu-app/west.yml b/examples/zephyr/qemu/qemu-app/west.yml
@@ -13,7 +13,7 @@ manifest:
   projects:
     - name: zephyr
       remote: zephyrproject-rtos
-      revision: zephyr-v3.2.0
+      revision: v3.3.0
       import: true
 
     - name: memfault-firmware-sdk
diff --git a/ports/esp_idf/memfault/CMakeLists.txt b/ports/esp_idf/memfault/CMakeLists.txt
@@ -85,14 +85,14 @@ list(APPEND MEMFAULT_COMPONENTS_INC_FOLDERS
    $ENV{MEMFAULT_PLATFORM_EXTRA_INCLUDES}
 )
 
-# For version >= 4.4.0, we can collect smaller coredumps by default
-# by prioritizing active stack and FreeRTOS regions first. ESP-IDF <= 4.4.0
+# For version >= 4.4.3, we can collect smaller coredumps by default
+# by prioritizing active stack and FreeRTOS regions first. ESP-IDF < 4.4.3
 # uses a simpler scheme collecting all of DRAM. See
 # common/memfault_platform_coredump.c for more info.
 # Note: CMake does not short-circuit logic statements, nested ifs required
-# Note: ENV{IDF_VERSION} added in esp-idf 4.4.0
+# Note: ENV{IDF_VERSION} added in esp-idf 4.4.3
 if (DEFINED ENV{IDF_VERSION})
-  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "4.4.0")
+  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "4.4.3")
     list(APPEND MEMFAULT_COMPONENTS_SRCS
       ${MEMFAULT_SDK_ROOT}/ports/freertos/src/memfault_freertos_ram_regions.c
     )
@@ -151,10 +151,10 @@ target_link_libraries(
 )
 
 # Link required libraries and add compiler flags to enable FreeRTOS region collection
-# in >= 4.4.0. Note: CMake does not short-circuit logic statements, nested ifs required
+# in >= 4.4.3. Note: CMake does not short-circuit logic statements, nested ifs required
 # Note: ENV{IDF_VERSION} added in esp-idf 4.4.0
 if(DEFINED ENV{IDF_VERSION})
-  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "4.4.0")
+  if ($ENV{IDF_VERSION} VERSION_GREATER_EQUAL "4.4.3")
     # Policy change requires CMake v3.13+
     cmake_minimum_required(VERSION 3.13)
 
diff --git a/ports/esp_idf/memfault/common/memfault_platform_coredump.c b/ports/esp_idf/memfault/common/memfault_platform_coredump.c
@@ -37,8 +37,8 @@
 #include "memfault/esp_port/uart.h"
 #include "memfault/util/crc16_ccitt.h"
 
-// Needed for >= v4.4.0 default coredump collection
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+// Needed for >= v4.4.3 default coredump collection
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
   #include "memfault/ports/freertos_coredump.h"
 #endif
 
@@ -65,16 +65,16 @@
   esp_partition_find_first(ESP_PARTITION_TYPE_DATA, ESP_PARTITION_SUBTYPE_DATA_COREDUMP, NULL)
 #endif
 
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
-  // Memory regions used for esp-idf >= 4.4.0
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
+  // Memory regions used for esp-idf >= 4.4.3
   // Active stack (1) + task/timer and bss/common regions (4) +
   // freertos tasks (MEMFAULT_PLATFORM_MAX_TASK_REGIONS) + bss(1) + data(1) + heap(1)
   #define MEMFAULT_ESP_PORT_NUM_REGIONS (1 + 4 + MEMFAULT_PLATFORM_MAX_TASK_REGIONS + 1 + 1 + 1)
-#else  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
-  // Memory regions for esp-idf < 4.4.0
+#else  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
+  // Memory regions for esp-idf < 4.4.3
   // Active stack (1) + bss(1) + data(1) + heap(1)
   #define MEMFAULT_ESP_PORT_NUM_REGIONS (1 + 1 + 1 + 1)
-#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
 
 typedef struct {
   uint32_t magic;
@@ -102,8 +102,8 @@ static const esp_partition_t *prv_get_core_partition(void) {
 
 // We use two different default coredump collection methods
 // due to differences in esp-idf versions. The following helper
-// is only used for esp-idf >= 4.4.0
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+// is only used for esp-idf >= 4.4.3
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
 //! Helper function to get bss and common sections of task and timer objects
 size_t prv_get_freertos_bss_common(sMfltCoredumpRegion *regions, size_t num_regions) {
   if (regions == NULL || num_regions == 0) {
@@ -144,7 +144,7 @@ size_t prv_get_freertos_bss_common(sMfltCoredumpRegion *regions, size_t num_regi
 
   return region_index;
 }
-#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
 
 //! Simple implementation to ensure address is in SRAM range.
 //!
@@ -169,7 +169,7 @@ MEMFAULT_WEAK size_t memfault_platform_sanitize_address_range(void *start_addr,
 
 //! By default we prioritize collecting active stack, bss, data, and heap.
 //!
-//! In esp-idf >= 4.4.0, we additionally collect bss and stack regions for
+//! In esp-idf >= 4.4.3, we additionally collect bss and stack regions for
 //! FreeRTOS tasks.
 //!
 //! @note The function is intentionally defined as weak so someone can
@@ -188,15 +188,15 @@ const sMfltCoredumpRegion *memfault_platform_coredump_get_regions(
   s_coredump_regions[region_idx++] =
     MEMFAULT_COREDUMP_MEMORY_REGION_INIT(crash_info->stack_address, stack_size);
 
-  // Second, capture the task regions, if esp-idf >= 4.4.0
-#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+  // Second, capture the task regions, if esp-idf >= 4.4.3
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
   region_idx += memfault_freertos_get_task_regions(
     &s_coredump_regions[region_idx], MEMFAULT_ARRAY_SIZE(s_coredump_regions) - region_idx);
 
   // Third, capture the FreeRTOS-specific bss regions
   region_idx += prv_get_freertos_bss_common(&s_coredump_regions[region_idx],
                                             MEMFAULT_ARRAY_SIZE(s_coredump_regions) - region_idx);
-#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)
+#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 3)
 
   // Next, capture all of .bss + .data that we can fit.
   extern uint32_t _data_start;
diff --git a/ports/zephyr/common/memfault_demo_cli.c b/ports/zephyr/common/memfault_demo_cli.c
@@ -198,6 +198,19 @@ static int prv_zephyr_load_32bit_address(const struct shell *shell, size_t argc,
   return memfault_demo_cli_loadaddr(argc, argv);
 }
 
+static int prv_cli_cmd_double_free(const struct shell *shell, size_t argc, char **argv) {
+  (void)shell;
+  (void)argc;
+  (void)argv;
+
+  uint8_t *ptr = k_malloc(100);
+  k_free(ptr);
+  k_free(ptr);
+
+  shell_print(shell, "Double free should have crashed the app! 🤯 Make sure CONFIG_ASSERT=y");
+
+  return -1;
+}
 
 SHELL_STATIC_SUBCMD_SET_CREATE(
   sub_memfault_crash_cmds,
@@ -210,6 +223,7 @@ SHELL_STATIC_SUBCMD_SET_CREATE(
   SHELL_CMD(usagefault, NULL, "trigger a usage fault", prv_usagefault_example),
   SHELL_CMD(zassert, NULL, "trigger a zephyr assert", prv_zephyr_assert_example),
   SHELL_CMD(loadaddr, NULL, "test a 32 bit load from an address", prv_zephyr_load_32bit_address),
+  SHELL_CMD(double_free, NULL, "Trigger a double free error", prv_cli_cmd_double_free),
 
   //! user initiated reboot
   SHELL_CMD(reboot, NULL, "trigger a reboot and record it using memfault", prv_test_reboot),
diff --git a/ports/zephyr/common/memfault_logging_legacy.c b/ports/zephyr/common/memfault_logging_legacy.c
@@ -69,6 +69,11 @@ LOG_BACKEND_DEFINE(log_backend_mflt, log_backend_mflt_api, true);
 
 // Tie Memfault's log function to the Zephyr buffer sender. This is *the* connection to Memfault.
 static int prv_log_out(uint8_t *data, size_t length, void *ctx) {
+  if (memfault_arch_is_inside_isr()) {
+    // We can't safely log from an ISR, so just drop the message
+    return (int)length;
+  }
+
   // Note: Context should always be populated. If it is not, flag the log as an _Error
   const eMemfaultPlatformLogLevel log_level = ctx != NULL ? *(eMemfaultPlatformLogLevel*)ctx :
                                                             kMemfaultPlatformLogLevel_Error;

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ typedef struct {`
`19`	`19`	`uint8_t patch;`
`20`	`20`	`} sMfltSdkVersion;`
`21`	`21`
`22`		`-#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 41, .patch = 0 }`
	`22`	`+#define MEMFAULT_SDK_VERSION { .major = 0, .minor = 41, .patch = 1 }`
`23`	`23`
`24`	`24`	`#ifdef __cplusplus`
`25`	`25`	`}`