Memfault Firmware SDK 1.1.0 (Build 2706)

Author: Memfault Inc

.cyignore

@@ -9,6 +9,8 @@ ports/dialog
 ports/emlib
 ports/esp8266_sdk
 ports/esp_idf
+ports/freertos/src/memfault_sdk_metrics_freertos.c
+ports/lwip
 ports/mbedtls
 ports/mynewt
 ports/nrf5_sdk

CHANGES.md

@@ -1,3 +1,44 @@
+### Changes between Memfault SDK 1.0.1 and 1.1.0 - June 29, 2023
+
+#### :chart_with_upwards_trend: Improvements
+
+- New built-in metrics 🎉 !
+
+  - FreeRTOS Idle Task runtime percentage metric: `idle_task_run_time_percent`.
+    This is automatically enabled for FreeRTOS builds with the correct tracing
+    options enabled, see
+    [ports/include/memfault/ports/freertos/metrics.h](ports/include/memfault/ports/freertos/metrics.h)
+    for details on how to enable or disable this metric.
+  - MbedTLS metrics for maximum and current memory used: `mbedtls_mem_max_bytes`
+    and `mbedtls_mem_used_bytes`. These are automatically enabled for ESP-IDF
+    projects, see
+    [ports/mbedtls/memfault_mbedtls_metrics.c](ports/mbedtls/memfault_mbedtls_metrics.c)
+    for usage details
+  - Renamed the built-in LwIP metrics added in SDK version 1.0.1 from
+    `Tcp_Drop_Count`/`Tcp_Rx_Count`/`Tcp_Tx_Count`,
+    `Udp_Drop_Count`/`Udp_Rx_Count`/`Udp_Tx_Count` to be all lowercase
+    `tcp_drop_count`/`tcp_rx_count`/`tcp_tx_count`,
+    `udp_drop_count`/`udp_rx_count`/`udp_tx_count`
+  - Add the following automatically enabled WiFi performance metrics to the
+    ESP-IDF port:
+    - `wifi_connected_time_ms`
+    - `wifi_disconnect_count`
+    - `wifi_sta_min_rssi`
+
+- Fix a bug in the [mbedtls port](ports/mbedtls/) causing an infinite loop under
+  certain error conditions on TLS handshake
+
+- Zephyr:
+
+  - Improve log flushing in the Memfault log backend during fault when deferred
+    logging is enabled. This ensures the latest log statements are included in
+    the coredump log data, when the `CONFIG_MEMFAULT_LOGGING_ENABLE=y`
+
+- ESP-IDF:
+
+  - `ESP_ERROR_CHECK()` assert coredumps will now correctly show as assert in
+    the Memfault coredump analysis view, instead of "Hard Fault"
+
 ### Changes between Memfault SDK 1.0.1 and 1.0.0 - June 9, 2023
 
 #### :chart_with_upwards_trend: Improvements

VERSION

@@ -1,2 +1,2 @@
-BUILD ID: 2436
-GIT COMMIT: 6273359e7
+BUILD ID: 2706
+GIT COMMIT: 81c373788

components/core/src/memfault_log.c

@@ -374,18 +374,18 @@ void memfault_log_save(eMemfaultPlatformLogLevel level, const char *fmt, ...) {
   va_end(args);
 }
 
-static void prv_log_save(eMemfaultPlatformLogLevel level,
-                         const void *log, size_t log_len,
-                         eMemfaultLogRecordType log_type) {
-
+static void prv_log_save(eMemfaultPlatformLogLevel level, const void *log, size_t log_len,
+                         eMemfaultLogRecordType log_type, bool should_lock) {
   if (!prv_should_log(level)) {
     return;
   }
 
   bool log_written = false;
   const size_t truncated_log_len = MEMFAULT_MIN(log_len, MEMFAULT_LOG_MAX_LINE_SAVE_LEN);
   const size_t bytes_needed = sizeof(sMfltRamLogEntry) + truncated_log_len;
-  memfault_lock();
+  if (should_lock) {
+    memfault_lock();
+  }
   {
     sMfltCircularBuffer *circ_bufp = &s_memfault_ram_logger.circ_buffer;
     const bool space_free = prv_try_free_space(circ_bufp, (int)bytes_needed);
@@ -399,7 +399,9 @@ static void prv_log_save(eMemfaultPlatformLogLevel level,
         log_written = true;
     }
   }
-  memfault_unlock();
+  if (should_lock) {
+    memfault_unlock();
+  }
 
   if (log_written) {
     memfault_log_handle_saved_callback();
@@ -426,15 +428,20 @@ void memfault_compact_log_save(eMemfaultPlatformLogLevel level, uint32_t log_id,
   }
 
   const size_t bytes_written = memfault_cbor_encoder_deinit(&encoder);
-  prv_log_save(level, log_buf, bytes_written, kMemfaultLogRecordType_Compact);
+  prv_log_save(level, log_buf, bytes_written, kMemfaultLogRecordType_Compact, true);
 }
 
 #endif /* MEMFAULT_COMPACT_LOG_ENABLE */
 
 
 void memfault_log_save_preformatted(eMemfaultPlatformLogLevel level,
                                     const char *log, size_t log_len) {
-  prv_log_save(level, log, log_len, kMemfaultLogRecordType_Preformatted);
+  prv_log_save(level, log, log_len, kMemfaultLogRecordType_Preformatted, true);
+}
+
+void memfault_log_save_preformatted_nolock(eMemfaultPlatformLogLevel level, const char *log,
+                                           size_t log_len) {
+  prv_log_save(level, log, log_len, kMemfaultLogRecordType_Preformatted, false);
 }
 
 bool memfault_log_boot(void *storage_buffer, size_t buffer_len) {

components/include/memfault/core/compiler_gcc.h

@@ -38,6 +38,7 @@ extern "C" {
 #define MEMFAULT_USED __attribute__((used))
 #define MEMFAULT_WEAK __attribute__((weak))
 #define MEMFAULT_PRINTF_LIKE_FUNC(a, b) __attribute__ ((format (__printf__, a, b)))
+#define MEMFAULT_ALIGNOF(x) (__alignof__(x))
 
 //! From https://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html,
 //!  If x is 0, the result is undefined.

components/include/memfault/core/log.h

@@ -121,6 +121,10 @@ void memfault_compact_log_save(eMemfaultPlatformLogLevel level, uint32_t log_id,
 void memfault_log_save_preformatted(eMemfaultPlatformLogLevel level, const char *log,
                                     size_t log_len);
 
+//! As above, but do not acquire a lock internally.
+void memfault_log_save_preformatted_nolock(eMemfaultPlatformLogLevel level, const char *log,
+                                           size_t log_len);
+
 typedef enum {
   kMemfaultLogRecordType_Preformatted = 0,
   kMemfaultLogRecordType_Compact = 1,

components/include/memfault/util/align.h

@@ -0,0 +1,44 @@
+//! @file
+//!
+//! Copyright (c) Memfault, Inc.
+//! See License.txt for details
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <stddef.h>
+#include <stdint.h>
+
+#include "memfault/core/compiler.h"
+#include "memfault/core/math.h"
+#include "memfault/core/sdk_assert.h"
+
+// C99 does not have a max_align_t type, so we use a union
+// of types with the largest alignments to determine max align
+// Taken from
+// https://github.com/zephyrproject-rtos/zephyr/blob/bfa0a87277c31d9e1b36104a29b17f3fc1a47444/include/zephyr/types.h#L22-L30
+typedef union {
+  long long thelonglong;
+  long double thelongdouble;
+  uintmax_t theuintmax_t;
+  size_t thesize_t;
+  uintptr_t theuintptr_t;
+  void *thepvoid;
+  void (*thepfunc)(void);
+} uMemfaultMaxAlignType;
+
+#if !defined(MEMFAULT_ALIGNOF)
+  #error \
+    "Compiler has no __alignof__ or equivalent extension. Please disable MEMFAULT_MBEDTLS_METRICS or contact support"
+#endif  // !defined(MEMFAULT_ALIGN)
+
+// Allow override for tests
+#if !defined(MEMFAULT_MAX_ALIGN_SIZE)
+  #define MEMFAULT_MAX_ALIGN_SIZE (MEMFAULT_ALIGNOF(uMemfaultMaxAlignType))
+#endif  // !defined(MEMFAULT_MAX_ALIGN_SIZE)
+
+#ifdef __cplusplus
+}
+#endif

components/include/memfault/version.h

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

examples/esp32/README.md

@@ -1,9 +1,9 @@
 # Memfault for ESP32
 
-This example application shows an integration with the ESP-IDF v4.2.2 SDK where
+This example application shows an integration with the ESP-IDF v5.0.2 SDK where
 a saved coredump is posted to the Memfault cloud for analysis.
 
-If you already have an ESP-IDF project based on the v4.x or v3.x SDK, a step by
+If you already have an ESP-IDF project based on the v5.x, v4.x, or v3.x SDK, a step by
 step getting started guide can be found [here](https://mflt.io/esp-tutorial).
 
 The Memfault SDK has been tested to be compatible with these versions of
@@ -43,24 +43,24 @@ Make sure you have read the instructions in the `README.md` in the root of the
 SDK and performed the installation steps that are mentioned there.
 
 We assume you have a working setup for the
-[v4.2.2 SDK](https://docs.espressif.com/projects/esp-idf/en/v4.2.2/):
+[v5.0.2 SDK](https://docs.espressif.com/projects/esp-idf/en/v5.0.2/):
 
 - have a version of CMAKE installed
 - installed the xtensa
-  [toolchain](https://docs.espressif.com/projects/esp-idf/en/v4.2.2/get-started/index.html#setup-toolchain)
+  [toolchain](https://docs.espressif.com/projects/esp-idf/en/v5.0.2/get-started/index.html#setup-toolchain)
   and added it to your path
 
 <a name="adding-memfault"></a>
 
 ### Adding Memfault to the ESP-IDF SDK
 
 1. Delete the dummy esp-idf directory (if present) and clone a copy of the
-   v4.2.2 SDK.
+   v5.0.2 SDK.
 
    ```bash
    cd examples/esp32/
    rm -rf esp-idf
-   git clone -b v4.2.4 --recursive https://github.com/espressif/esp-idf.git esp-idf
+   git clone -b v5.0.2 --recursive https://github.com/espressif/esp-idf.git esp-idf
    cd esp-idf
    export IDF_TOOLS_PATH=$(pwd)
    # you may need to install the sdk tools by running ./install.sh here

examples/esp32/apps/memfault_demo_app/main/cmd_wifi.c

@@ -97,7 +97,7 @@ bool wifi_join(const char *ssid, const char *pass) {
 
     ESP_ERROR_CHECK(esp_netif_init());
 
-    ESP_ERROR_CHECK(esp_event_loop_create_default());
+    ESP_ERROR_CHECK_WITHOUT_ABORT(esp_event_loop_create_default());
     esp_netif_create_default_wifi_sta();
 
     wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
@@ -151,6 +151,10 @@ bool wifi_join(const char *ssid, const char *pass) {
   return false;
 }
 
+static int wifi_disconnect() {
+  return esp_wifi_disconnect();
+}
+
 /** Arguments used by 'join' function */
 static struct {
   struct arg_str *ssid;
@@ -355,4 +359,11 @@ void register_wifi(void) {
                                         .func = &wifi_creds_set,
                                         .argtable = &wifi_creds_args};
   ESP_ERROR_CHECK(esp_console_cmd_register(&config_cmd));
+
+  const esp_console_cmd_t disconnect_cmd = {.command = "wifi_disconnect",
+                                            .help = "Disconnect from WiFi AP",
+                                            .hint = NULL,
+                                            .func = &wifi_disconnect,
+                                            .argtable = NULL};
+  ESP_ERROR_CHECK(esp_console_cmd_register(&disconnect_cmd));
 }