Memfault Firmware SDK 0.31.2 (Build 464682)

Author: Memfault Inc

CHANGES.md

@@ -1,3 +1,14 @@
+### Changes between Memfault SDK 0.31.2 and SDK 0.31.1 - June 24, 2022
+
+#### :chart_with_upwards_trend: Improvements
+
+- Fixed a :bug: in the
+  [Zephyr port HTTP implementation](ports/zephyr/common/memfault_platform_http.c),
+  where a socket file descriptor was leaked. This caused every HTTP operation
+  after the first to fail on Zephyr platforms.
+- Added an update to improve the quality of stack traces when using
+  `MEMFAULT_ASSERT` with the TI ARM Clang Compiler
+
 ### Changes between Memfault SDK 0.31.1 and SDK 0.31.0 - June 16, 2022
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 458093
-GIT COMMIT: b7d0794c4
+BUILD ID: 464682
+GIT COMMIT: 5b8557d55

components/include/memfault/panics/fault_handling.h

@@ -82,9 +82,9 @@ MEMFAULT_NAKED_FUNC void MEMFAULT_EXC_HANDLER_WATCHDOG(void);
 //! @param lr The return address
 //! @see MEMFAULT_ASSERT_RECORD
 //! @see MEMFAULT_ASSERT
-#if defined(__CC_ARM)
-//! ARMCC will optimize away link register stores from callsites which makes it impossible for a
-//! reliable backtrace to be resolved so we don't use the NORETURN attribute
+#if defined(__CC_ARM) || (defined(__clang__) && defined(__ti__))
+//! ARMCC and tiarmclang will optimize away link register stores from callsites which makes it
+//! impossible for a reliable backtrace to be resolved so we don't use the NORETURN attribute
 #else
 MEMFAULT_NORETURN
 #endif
@@ -97,9 +97,9 @@ void memfault_fault_handling_assert(void *pc, void *lr);
 //! @param extra_info Additional information used by the assert handler
 //! @see MEMFAULT_ASSERT_RECORD
 //! @see MEMFAULT_ASSERT
-#if defined(__CC_ARM)
-//! ARMCC will optimize away link register stores from callsites which makes it impossible for a
-//! reliable backtrace to be resolved so we don't use the NORETURN attribute
+#if defined(__CC_ARM) || (defined(__clang__) && defined(__ti__))
+//! ARMCC and tiarmclang optimize away link register stores from callsites which makes it
+//! impossible for a reliable backtrace to be resolved so we don't use the NORETURN attribute
 #else
 MEMFAULT_NORETURN
 #endif

components/include/memfault/version.h

@@ -19,7 +19,7 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 31, .patch = 1 }
+#define MEMFAULT_SDK_VERSION   { .major = 0, .minor = 31, .patch = 2 }
 
 #ifdef __cplusplus
 }

components/panics/src/memfault_fault_handling_arm.c

@@ -565,12 +565,24 @@ static void prv_fault_handling_assert(void *pc, void *lr, eMemfaultRebootReason
 MEMFAULT_NO_OPT
 void memfault_fault_handling_assert(void *pc, void *lr) {
   prv_fault_handling_assert(pc, lr, kMfltRebootReason_Assert);
-  MEMFAULT_UNREACHABLE;
+
+#if (defined(__clang__) && defined(__ti__))
+  //! tiarmclang does not respect the no optimization request and will
+  //! strip the pushing callee saved registers making it impossible to recover
+  //! an accurate backtrace so we skip over providing the unreachable hint.
+#else
+    MEMFAULT_UNREACHABLE;
+#endif
 }
 MEMFAULT_NO_OPT
 void memfault_fault_handling_assert_extra(void *pc, void *lr, sMemfaultAssertInfo *extra_info) {
   prv_fault_handling_assert(pc, lr, extra_info->assert_reason);
-  MEMFAULT_UNREACHABLE;
+
+#if (defined(__clang__) && defined(__ti__))
+  //! See comment in memfault_fault_handling_assert for more context
+#else
+    MEMFAULT_UNREACHABLE;
+#endif
 }
 
 #endif /* MEMFAULT_COMPILER_ARM */

examples/zephyr/README.md

@@ -26,55 +26,64 @@ Step-by-step instructions can be found in the
 
 1. Clone the repo
 
-```bash
-$ git clone [email protected]:zephyrproject-rtos/zephyr.git --branch v2.5-branch zephyr
-```
+   ```bash
+   $ git clone [email protected]:zephyrproject-rtos/zephyr.git --branch v2.5-branch zephyr
+   ```
 
 2. Create a virtual environment
 
-```bash
-python3 -m venv .venv
-source .venv/bin/activate
-pip install -r zephyr/scripts/requirements.txt
-```
+   ```bash
+   python3 -m venv .venv
+   source .venv/bin/activate
+   pip install -r zephyr/scripts/requirements.txt
+   ```
 
 3. Initialize a new build environment:
 
-```bash
-$ west init -l zephyr/
-$ west update
-```
+   ```bash
+   $ west init -l zephyr/
+   $ west update
+   ```
 
 4. When using the STM32L4 discovery board, the following patch is also needed
    due to bugs in the stack:
 
-```diff
-diff --git a/drivers/wifi/eswifi/Kconfig.eswifi b/drivers/wifi/eswifi/Kconfig.eswifi
-index 6468b98113..5f80c918cd 100644
---- a/drivers/wifi/eswifi/Kconfig.eswifi
-+++ b/drivers/wifi/eswifi/Kconfig.eswifi
-@@ -9,7 +9,7 @@ menuconfig WIFI_ESWIFI
-        select WIFI_OFFLOAD
-        select NET_OFFLOAD
-        select NET_SOCKETS
--       select NET_SOCKETS_OFFLOAD
-+       imply NET_SOCKETS_OFFLOAD
-        select GPIO
-
- if WIFI_ESWIFI
-diff --git a/drivers/wifi/eswifi/eswifi_socket.c b/drivers/wifi/eswifi/eswifi_socket.c
-index e31ca0eecd..119f55778d 100644
---- a/drivers/wifi/eswifi/eswifi_socket.c
-+++ b/drivers/wifi/eswifi/eswifi_socket.c
-@@ -301,6 +301,6 @@ int __eswifi_socket_new(struct eswifi_dev *eswifi, int family, int type,
-        k_delayed_work_init(&socket->read_work, eswifi_off_read_work);
-        socket->usage = 1;
-        LOG_DBG("Socket index %d", socket->index);
--
-+       net_context_set_state(socket->context, NET_CONTEXT_CONNECTED);
-        return socket->index;
- }
-```
+   ```diff
+   diff --git a/drivers/wifi/eswifi/Kconfig.eswifi b/drivers/wifi/eswifi/Kconfig.eswifi
+   index 6468b98113..5f80c918cd 100644
+   --- a/drivers/wifi/eswifi/Kconfig.eswifi
+   +++ b/drivers/wifi/eswifi/Kconfig.eswifi
+   @@ -9,7 +9,7 @@ menuconfig WIFI_ESWIFI
+           select WIFI_OFFLOAD
+           select NET_OFFLOAD
+           select NET_SOCKETS
+   -       select NET_SOCKETS_OFFLOAD
+   +       imply NET_SOCKETS_OFFLOAD
+           select GPIO
+
+    if WIFI_ESWIFI
+   diff --git a/drivers/wifi/eswifi/eswifi_socket.c b/drivers/wifi/eswifi/eswifi_socket.c
+   index e31ca0eecd..119f55778d 100644
+   --- a/drivers/wifi/eswifi/eswifi_socket.c
+   +++ b/drivers/wifi/eswifi/eswifi_socket.c
+   @@ -301,6 +301,6 @@ int __eswifi_socket_new(struct eswifi_dev *eswifi, int family, int type,
+           k_delayed_work_init(&socket->read_work, eswifi_off_read_work);
+           socket->usage = 1;
+           LOG_DBG("Socket index %d", socket->index);
+   -
+   +       net_context_set_state(socket->context, NET_CONTEXT_CONNECTED);
+           return socket->index;
+    }
+   ```
+
+   You can find this patch at
+   [`stm32l4_disco_zephyr2.5_wifi.patch`](./stm32l4_disco_zephyr2.5_wifi.patch),
+   which can be applied by this command (assuming the `zephyr` repo is in the
+   current working directory):
+
+   ```bash
+   git -C zephyr apply < stm32l4_disco_zephyr2.5_wifi.patch
+   ```
 
 ### Memfault Project Key
 
@@ -87,7 +96,7 @@ https://app.memfault.com/, navigate to the project you want to use and select
 
 ### Building
 
-```
+```bash
 $ cd $MEMFAULT_SDK/examples/zephyr/
 $ west build -b disco_l475_iot1 apps/memfault_demo_app
 [...]
@@ -119,7 +128,7 @@ arm-none-eabi-gdb-py --eval-command="target remote localhost:2331"  --ex="mon re
 
 At this point, the application should be running and you can open a console:
 
-```
+```bash
 $ miniterm.py /dev/cu.usbmodem* 115200 --raw
 *** Booting Zephyr OS build zephyr-v2.5.0-56-gec0aa8331a65  ***
 <inf> <mflt>: GNU Build ID: c20cef04e29e3ae7784002c3650d48f3a0b7b07d

examples/zephyr/stm32l4_disco_zephyr2.5_wifi.patch

@@ -0,0 +1,40 @@
+From 4a4a13fa00ef0d04d9be239d145ddeb173ac72a1 Mon Sep 17 00:00:00 2001
+From: Memfault Inc <[email protected]>
+Date: Thu, 23 Jun 2022 10:45:20 -0400
+Subject: [PATCH] Patch for stm32l4_disco wifi on Zephyr 2.5.1
+
+This patch is for Zephyr v2.5-branch
+(52e06334fbeabd5d764935c1fc47d7225216fff4), and fixes the
+eswifi driver for the Memfault demo app.
+---
+ drivers/wifi/eswifi/Kconfig.eswifi  | 2 +-
+ drivers/wifi/eswifi/eswifi_socket.c | 1 +
+ 2 files changed, 2 insertions(+), 1 deletion(-)
+
+diff --git a/drivers/wifi/eswifi/Kconfig.eswifi b/drivers/wifi/eswifi/Kconfig.eswifi
+index 6468b98113..5f80c918cd 100644
+--- a/drivers/wifi/eswifi/Kconfig.eswifi
++++ b/drivers/wifi/eswifi/Kconfig.eswifi
+@@ -9,7 +9,7 @@ menuconfig WIFI_ESWIFI
+ 	select WIFI_OFFLOAD
+ 	select NET_OFFLOAD
+ 	select NET_SOCKETS
+-	select NET_SOCKETS_OFFLOAD
++	imply NET_SOCKETS_OFFLOAD
+ 	select GPIO
+ 
+ if WIFI_ESWIFI
+diff --git a/drivers/wifi/eswifi/eswifi_socket.c b/drivers/wifi/eswifi/eswifi_socket.c
+index e31ca0eecd..a3705535ab 100644
+--- a/drivers/wifi/eswifi/eswifi_socket.c
++++ b/drivers/wifi/eswifi/eswifi_socket.c
+@@ -302,5 +302,6 @@ int __eswifi_socket_new(struct eswifi_dev *eswifi, int family, int type,
+ 	socket->usage = 1;
+ 	LOG_DBG("Socket index %d", socket->index);
+ 
++	net_context_set_state(socket->context, NET_CONTEXT_CONNECTED);
+ 	return socket->index;
+ }
+-- 
+2.36.1
+

ports/zephyr/common/memfault_platform_http.c

@@ -191,8 +191,8 @@ static bool prv_try_send(int sock_fd, const uint8_t *buf, size_t buf_len) {
   return true;
 }
 
-static int prv_open_socket(struct addrinfo **res, const char *host, int port_num) {
-  struct addrinfo hints = {
+static int prv_open_socket(struct zsock_addrinfo **res, const char *host, int port_num) {
+  struct zsock_addrinfo hints = {
     .ai_family = AF_INET,
     .ai_socktype = SOCK_STREAM,
   };
@@ -559,6 +559,7 @@ int memfault_zephyr_port_ota_update(const sMemfaultOtaUpdateHandler *handler) {
 
 int memfault_zephyr_port_post_data(void) {
   sMemfaultHttpContext ctx = {0};
+  ctx.sock_fd = -1;
 
   int rv = memfault_zephyr_port_http_open_socket(&ctx);
   if (rv < 0) {
@@ -589,18 +590,18 @@ int memfault_zephyr_port_http_open_socket(sMemfaultHttpContext *ctx) {
 }
 
 void memfault_zephyr_port_http_close_socket(sMemfaultHttpContext *ctx) {
-  if (ctx->sock_fd > 0) {
+  if (ctx->sock_fd >= 0) {
     close(ctx->sock_fd);
   }
-  ctx->sock_fd = 0;
+  ctx->sock_fd = -1;
 
   if (ctx->res != NULL) {
     freeaddrinfo(ctx->res);
     ctx->res = NULL;
   }
 }
 
-bool memfault_zephyr_port_http_is_connected(sMemfaultHttpContext *ctx) { return ctx->sock_fd > 0; }
+bool memfault_zephyr_port_http_is_connected(sMemfaultHttpContext *ctx) { return ctx->sock_fd >= 0; }
 
 void memfault_zephyr_port_http_upload_sdk_data(sMemfaultHttpContext *ctx) {
   int max_messages_to_send = 5;
@@ -630,11 +631,11 @@ int memfault_zephyr_port_http_post_chunk(sMemfaultHttpContext *ctx, void *p_data
   memfault_http_start_chunk_post(prv_send_data, &(ctx->sock_fd), data_len);
 
   if (!prv_try_send(ctx->sock_fd, p_data, data_len)) {
-    return -1;
+    return -2;
   }
 
   if (!prv_wait_for_http_response(ctx->sock_fd)) {
-    return -1;
+    return -3;
   }
 
   return 0;

ports/zephyr/include/memfault/ports/zephyr/http.h

@@ -96,7 +96,7 @@ int memfault_zephyr_port_release_download_url(char **download_url);
 //! Context structure used to carry state information about the HTTP connection
 typedef struct {
   int sock_fd;
-  struct addrinfo *res;
+  struct zsock_addrinfo *res;
 } sMemfaultHttpContext;
 
 //! Open a socket to the Memfault chunks upload server