Memfault Firmware SDK 1.4.1 (Build 4232)

Author: Memfault Inc

CHANGES.md

@@ -1,5 +1,50 @@
 # Memfault Firmware SDK Changelog
 
+## [1.4.1] - 2023-10-31
+
+#### :rocket: New Features
+
+- ESP-IDF:
+
+  - Add the following built-in heap allocation metrics by default. These can be
+    disabled with the `CONFIG_MEMFAULT_ESP_HEAP_METRICS` Kconfig flag.
+
+    - `heap_free_bytes`
+    - `heap_largest_free_block_bytes`
+    - `heap_allocated_blocks_count`
+    - `heap_min_free_bytes`
+
+- Zephyr:
+
+  - Enable capturing [Memfault-style compact logs](https://mflt.io/compact-logs)
+    on Zephyr systems. Note that this does not enable decoding
+    [Zephyr "dictionary logs"](https://docs.zephyrproject.org/3.5.0/services/logging/index.html#dictionary-based-logging),
+    but requires using the Memfault logging APIs directly (i.e.
+    `MEMFAULT_LOG_INFO("...")` instead of `LOG_INF("...")`).
+
+- General:
+
+  - Add a `coredump_size` CLI command to the Zephyr, ESP-IDF, and demo CLI
+    implementations. This command will print the computed size of the coredump
+    and the available storage space. Can be used to tune coredump size.
+
+  - Enable providing the Memfault HTTP Client with a custom
+    `memfault_platform_get_device_info()` callback, for when the device is
+    uploading data for a downstream device, with different device info.
+
+  - When [compact logging](https://mflt.io/compact-logs) is enabled, route all
+    `MEMFAULT_LOG_x()` statements through the compact serializer
+    (`MEMFAULT_COMPACT_LOG_SAVE`). Previously, logs had to explicitly use the
+    `MEMFAULT_COMPACT_LOG_SAVE` API to store in the compact form.
+
+  - Capture C stdlib `assert.h` asserts, by implementing the correct assert
+    hooks for Newlib/Picolibc and IAR libc's. This can be disabled with the
+    Memfault platform config `MEMFAULT_ASSERT_CSTDLIB_HOOK_ENABLED`. This should
+    improve the Trace quality for systems that are using the C stdlib
+    `assert(x)` functions.
+
+### :chart_with_upwards_trend: Improvements
+
 ## [1.4.0] - 2023-10-23
 
 #### :rocket: New Features

VERSION

@@ -1,3 +1,3 @@
-BUILD ID: 4099
-GIT COMMIT: bb1ba895f
-VERSION: 1.4.0
+BUILD ID: 4232
+GIT COMMIT: 3f7cda509f
+VERSION: 1.4.1

components/demo/src/memfault_demo_shell_commands.c

@@ -49,7 +49,7 @@ static const sMemfaultShellCommand s_memfault_shell_commands[] = {
    "Export base64-encoded chunks. To upload data see https://mflt.io/chunk-data-export"},
   {"get_core", memfault_demo_cli_cmd_get_core, "Get coredump info"},
   {"get_device_info", memfault_demo_cli_cmd_get_device_info, "Get device info"},
-
+  {"coredump_size", memfault_demo_cli_cmd_coredump_size, "Print the coredump storage capacity"},
   //
   // Test commands for validating SDK functionality: https://mflt.io/mcu-test-commands
   //

components/demo/src/panics/memfault_demo_panics.c

@@ -112,6 +112,14 @@ int memfault_demo_cli_cmd_clear_core(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED c
   return 0;
 }
 
+int memfault_demo_cli_cmd_coredump_size(MEMFAULT_UNUSED int argc, MEMFAULT_UNUSED char *argv[]) {
+  size_t total_size = 0;
+  size_t capacity = 0;
+  memfault_coredump_size_and_storage_capacity(&total_size, &capacity);
+  MEMFAULT_LOG_INFO("Coredump size: %d, capacity: %d", (int)total_size, (int)capacity);
+  return 0;
+}
+
 int memfault_demo_cli_cmd_assert(int argc, char *argv[]) {
   // permit running with a user-provided "extra" value for testing that path
   if (argc > 1) {

components/http/src/memfault_http_client.c

@@ -16,10 +16,11 @@
 #include "memfault/core/errors.h"
 #include "memfault/core/platform/device_info.h"
 #include "memfault/http/platform/http_client.h"
+#include "memfault/http/utils.h"
 
 bool memfault_http_build_url(char url_buffer[MEMFAULT_HTTP_URL_BUFFER_SIZE], const char *subpath) {
   sMemfaultDeviceInfo device_info;
-  memfault_platform_get_device_info(&device_info);
+  memfault_http_get_device_info(&device_info);
 
 
   const int rv = snprintf(url_buffer, MEMFAULT_HTTP_URL_BUFFER_SIZE, "%s://%s" MEMFAULT_HTTP_CHUNKS_API_PREFIX "%s/%s",

components/http/src/memfault_http_utils.c

@@ -95,7 +95,7 @@ bool memfault_http_start_chunk_post(
   //  \r\n
 
   sMemfaultDeviceInfo device_info;
-  memfault_platform_get_device_info(&device_info);
+  memfault_http_get_device_info(&device_info);
 
   char buffer[100];
   const size_t max_msg_len = sizeof(buffer);
@@ -156,7 +156,7 @@ bool memfault_http_get_latest_ota_payload_url(MfltHttpClientSendCb write_callbac
   }
 
   sMemfaultDeviceInfo device_info = { 0 };
-  memfault_platform_get_device_info(&device_info);
+  memfault_http_get_device_info(&device_info);
 
   #define DEVICE_SERIAL_QPARAM "device_serial"
   #define HARDWARE_VERSION_QPARAM "hardware_version"
@@ -708,3 +708,13 @@ int memfault_http_urlencode(const char *inbuf, size_t inbuf_len, char *outbuf, s
 
   return 0;
 }
+
+void memfault_http_get_device_info(sMemfaultDeviceInfo *info) {
+  // Use the user provided callback if available, otherwise use the standard
+  // platform implementation
+  if (g_mflt_http_client_config.get_device_info != NULL) {
+    g_mflt_http_client_config.get_device_info(info);
+    return;
+  }
+  memfault_platform_get_device_info(info);  // note: HTTP functions should always call this
+}

components/include/memfault/core/log.h

@@ -64,7 +64,9 @@ bool memfault_log_boot(void *buffer, size_t buf_len);
 //! By default, any logs >= kMemfaultPlatformLogLevel_Info can be saved
 void memfault_log_set_min_save_level(eMemfaultPlatformLogLevel min_log_level);
 
-//! Macro which can be called from a platforms pre-existing logging macro.
+//! The MEMFAULT_LOG_SAVE macro backs the built-in SDK MEMFAULT_LOG_x logging
+//! macros, but can also be called from a platforms pre-existing logging
+//! macro.
 //!
 //! For example, if your platform already has something like this
 //!
@@ -79,7 +81,9 @@ void memfault_log_set_min_save_level(eMemfaultPlatformLogLevel min_log_level);
 //!    MEMFAULT_LOG_SAVE(kMemfaultPlatformLogLevel_Error, __VA_ARGS__);
 //!    your_platform_log_error(__VA_ARGS__)
 //! } while (0)
-#define MEMFAULT_LOG_SAVE(_level, ...) memfault_log_save(_level, __VA_ARGS__)
+//!
+//! The macro will save the log data in the normal or compact form depending on
+//! SDK configuration.
 
 #if MEMFAULT_COMPACT_LOG_ENABLE
 
@@ -96,13 +100,16 @@ void memfault_log_set_min_save_level(eMemfaultPlatformLogLevel min_log_level);
                               ## __VA_ARGS__);                          \
   } while (0)
 
+  #define MEMFAULT_LOG_SAVE MEMFAULT_COMPACT_LOG_SAVE
 
 //! Serializes the provided compact log and saves it to backing storage
 //!
 //! @note: Should only be called via MEMFAULT_COMPACT_LOG_SAVE macro
 void memfault_compact_log_save(eMemfaultPlatformLogLevel level, uint32_t log_id,
                                uint32_t compressed_fmt, ...);
 
+#else  // !MEMFAULT_COMPACT_LOG_ENABLE
+  #define MEMFAULT_LOG_SAVE(_level, ...) memfault_log_save(_level, __VA_ARGS__)
 #endif /* MEMFAULT_COMPACT_LOG_ENABLE */
 
 //! Function which can be called to save a log after it has been formatted

components/include/memfault/default_config.h

@@ -52,6 +52,12 @@ extern "C" {
 #define MEMFAULT_ASSERT_HALT_IF_DEBUGGING_ENABLED 0
 #endif
 
+//! Install a low-level hook into the C stdlib assert() library call, to capture
+//! coredumps when asserts occur.
+#ifndef MEMFAULT_ASSERT_CSTDLIB_HOOK_ENABLED
+#define MEMFAULT_ASSERT_CSTDLIB_HOOK_ENABLED 1
+#endif
+
 //! Controls whether or not device serial is encoded in events
 //!
 //! When disabled (default), the device serial is derived from the API route

components/include/memfault/demo/cli.h

@@ -84,6 +84,9 @@ int memfault_demo_cli_cmd_post_core(int argc, char *argv[]);
 //! It takes no arguments.
 int memfault_demo_cli_cmd_clear_core(int argc, char *argv[]);
 
+//! Print coredump size and storage capacity
+int memfault_demo_cli_cmd_coredump_size(int argc, char *argv[]);
+
 //! Command to print device info, as obtained through memfault_platform_get_device_info().
 //! It takes no arguments.
 int memfault_demo_cli_cmd_get_device_info(int argc, char *argv[]);

components/include/memfault/http/http_client.h

@@ -14,6 +14,7 @@
 
 #include "memfault/config.h"
 #include "memfault/core/compiler.h"
+#include "memfault/core/platform/device_info.h"
 
 #define MEMFAULT_HTTP_URL_BUFFER_SIZE (128)
 
@@ -45,12 +46,28 @@ typedef struct MfltHttpClientConfig {
   //! Route used to get information from the Memfault cloud pertaining to a device in your fleet.
   //! For example, the latest firmware release available.
   sMemfaultHttpApi device_api;
+  //! Callback for fetching device info for the OTA'ing device. Typically this callback can be left unset, but
+  //! if the request is on behalf of a downstream device, can be substituted with the downstream
+  //! device's information.
+  //! The function signature is the same as memfault_platform_get_device_info().
+  //! If NULL, memfault_platform_get_device_info() will be used.
+  void (*get_device_info)(sMemfaultDeviceInfo *info);
 } sMfltHttpClientConfig;
 
 //! Global configuration of the Memfault HTTP client.
 //! See @ref sMfltHttpClientConfig for information about each of the fields.
 extern sMfltHttpClientConfig g_mflt_http_client_config;
 
+//! If on a GNUC-compatible compiler, perform a type-compatibility check with
+//! the get_device_info callback. This will fail to compile if the callback
+//! signature does not match the expected signature.
+#if defined(__GNUC__) && !defined(__cplusplus)
+MEMFAULT_STATIC_ASSERT(
+  __builtin_types_compatible_p(__typeof__(g_mflt_http_client_config.get_device_info),
+                               __typeof__(&memfault_platform_get_device_info)),
+  "get_device_info callback signature does not match expected signature");
+#endif
+
 //! Convenience macros to get the currently configured Chunks API hostname & Port
 #define MEMFAULT_HTTP_GET_CHUNKS_API_HOST() \
   (g_mflt_http_client_config.chunks_api.host ? g_mflt_http_client_config.chunks_api.host : \