Memfault Firmware SDK 1.3.5 (Build 3944)

Memfault Inc · Memfault Inc · commit bfc51680f260 · 2023-10-16T18:57:08.000Z
diff --git a/.circleci/Dockerfile b/.circleci/Dockerfile
@@ -24,6 +24,8 @@ ENV DEBIAN_FRONTEND=noninteractive \
 ARG MEMFAULT_SDK_APT_DEPS="\
     build-essential \
     cpputest \
+    gcc-12 \
+    g++-12 \
     git \
     python3.10 \
     python3.10-venv\
@@ -32,7 +34,7 @@ ARG MEMFAULT_SDK_APT_DEPS="\
 # Run commands and tests as circleci user
 RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci && \
     echo 'DPkg::Options "--force-confnew";' >> /etc/apt/apt.conf.d/90circleci && \
-    apt-get update && apt-get install -y \
+    apt-get update && apt-get install -y --no-install-recommends \
         locales \
         sudo \
         wget \
@@ -47,11 +49,33 @@ RUN echo 'APT::Get::Assume-Yes "true";' > /etc/apt/apt.conf.d/90circleci && \
     sudo -u circleci mkdir /home/circleci/project && \
     sudo -u circleci mkdir /home/circleci/bin
 
+# Select gcc-12 as the default gcc/g++ version
+RUN sudo update-alternatives --install \
+    /usr/bin/gcc gcc /usr/bin/gcc-12 60 \
+    --slave /usr/bin/g++ g++ /usr/bin/g++-12 \
+    --slave /usr/bin/gcov gcov /usr/bin/gcov-12
+
 ENV PATH=/home/circleci/bin:/home/circleci/.local/bin:$PATH \
     LANG=en_US.UTF-8 \
     LANGUAGE=en_US:en \
     LC_ALL=en_US.UTF-8
 
+# Install lcov and add to PATH
+ARG LCOV_VERSION=1.16
+ARG LCOV_SHA256SUM=987031ad5528c8a746d4b52b380bc1bffe412de1f2b9c2ba5224995668e3240b
+RUN \
+    cd /tmp && \
+    wget https://github.com/linux-test-project/lcov/releases/download/v${LCOV_VERSION}/lcov-${LCOV_VERSION}.tar.gz -O lcov.tar.gz && \
+    echo "${LCOV_SHA256SUM}  lcov.tar.gz" | shasum --algorithm=256 --check && \
+    tar zvxf lcov.tar.gz && \
+    cd lcov-${LCOV_VERSION} && sudo make install && \
+    cd .. && \
+    rm -rf ./lcov* && \
+    lcov --version && \
+    genhtml --version
+
+ENV PATH=/home/circleci/lcov-${LCOV_VERSION}/bin:$PATH
+
 USER circleci
 
 # Match the default CircleCI working directory
@@ -60,18 +84,6 @@ WORKDIR /home/circleci/project
 # Create the virtualenv
 RUN python3 -m venv ~/venv
 
-# Install lcov and add to PATH
-ARG LCOV_VERSION=1.14
-ARG LCOV_SHA256SUM=14995699187440e0ae4da57fe3a64adc0a3c5cf14feab971f8db38fb7d8f071a
-RUN \
-    cd ~ && \
-    wget https://github.com/linux-test-project/lcov/releases/download/v${LCOV_VERSION}/lcov-${LCOV_VERSION}.tar.gz -O ~/lcov.tar.gz && \
-    echo "${LCOV_SHA256SUM}  ${HOME}/lcov.tar.gz" | shasum --algorithm=256 --check && \
-    cd ~ && tar zvxf ~/lcov.tar.gz && \
-    rm ~/lcov.tar.gz
-
-ENV PATH=/home/circleci/lcov-${LCOV_VERSION}/bin:$PATH
-
 # Auto-activate the virtualenv in the container
 RUN sudo mkdir -p /circleci/ && \
     sudo bash -c "echo 'source ~/venv/bin/activate' >> /circleci/.bashrc_circleci" && \
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -15,7 +15,7 @@ version: 2.1
 executors:
   memfault-ci:
     docker:
-      - image: memfault/memfault-firmware-sdk-ci:0.0.1
+      - image: memfault/memfault-firmware-sdk-ci:2023-10-13
     working_directory: ~/repo
 
 commands:
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,26 @@
 # Memfault Firmware SDK Changelog
 
+## [1.3.5] - 2023-10-14
+
+### :chart_with_upwards_trend: Improvements
+
+- ESP-IDF:
+
+  - Fix build errors when building the [ESP32 example app](examples/esp32)
+    project on ESP-IDF versions earlier than v5. This was a regression in
+    **1.3.4**.
+
+  - Conditionally remove a redundant call to `esp_timer_init()` during the
+    `memfault_boot()` sequence, which was causing a runtime error message. This
+    call was originally required when `memfault_boot()` was called as part of
+    ESP-IDF system init, which was disabled by default in **0.31.4** and
+    deprecated in **0.40.0**. The redundant call was harmless but generated a
+    nuisance error message.
+
+- Fix another build error in the public unit tests caused by the `-fanalyzer`
+  flag. The `-fanalyzer` static analyzer was generating a false positive on
+  GCC 11. Updating the GCC version to 12 removes the false positive.
+
 ## [1.3.4] - 2023-10-12
 
 ### :chart_with_upwards_trend: Improvements
diff --git a/VERSION b/VERSION
@@ -1,3 +1,3 @@
-BUILD ID: 3914
-GIT COMMIT: 18179b7fb
-VERSION: 1.3.4
+BUILD ID: 3944
+GIT COMMIT: 429f30930
+VERSION: 1.3.5
diff --git a/components/include/memfault/version.h b/components/include/memfault/version.h
@@ -19,8 +19,8 @@ typedef struct {
   uint8_t patch;
 } sMfltSdkVersion;
 
-#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 3, .patch = 4 }
-#define MEMFAULT_SDK_VERSION_STR "1.3.4"
+#define MEMFAULT_SDK_VERSION   { .major = 1, .minor = 3, .patch = 5 }
+#define MEMFAULT_SDK_VERSION_STR "1.3.5"
 
 #ifdef __cplusplus
 }
diff --git a/examples/esp32/apps/memfault_demo_app/main/CMakeLists.txt b/examples/esp32/apps/memfault_demo_app/main/CMakeLists.txt
@@ -4,7 +4,6 @@ list(APPEND
    cmd_system.c
    console_example_main.c
    led.c
-   settings.c
 )
 
 if (CONFIG_APP_MEMFAULT_TRANSPORT_HTTP)
@@ -26,6 +25,14 @@ else()
    )
 endif()
 
+# include settings.c only on idf >= 4
+if("${IDF_VERSION_MAJOR}" VERSION_GREATER_EQUAL 4)
+   list(APPEND
+      COMPONENT_SRCS
+      settings.c
+   )
+endif()
+
 set(COMPONENT_ADD_INCLUDEDIRS
    .
    memfault
diff --git a/examples/esp32/apps/memfault_demo_app/main/cmd_decl.h b/examples/esp32/apps/memfault_demo_app/main/cmd_decl.h
@@ -22,9 +22,16 @@ bool wifi_join(const char* ssid, const char* pass);
 void wifi_load_creds(char** ssid, char** password);
 
 #define MEMFAULT_PROJECT_KEY_LEN 32
+// if gcc < 11, disable -Wattributes, "access" attribute is not supported
+#if __GNUC__ < 11
+  #pragma GCC diagnostic push
+  #pragma GCC diagnostic ignored "-Wattributes"
+#endif
 __attribute__((access(write_only, 1, 2))) int wifi_get_project_key(char* project_key,
                                                                    size_t project_key_len);
-
+#if __GNUC__ < 11
+  #pragma GCC diagnostic pop
+#endif
 // Register app-specific console commands
 void register_app(void);
 
diff --git a/examples/esp32/apps/memfault_demo_app/main/cmd_wifi_legacy.c b/examples/esp32/apps/memfault_demo_app/main/cmd_wifi_legacy.c
@@ -40,8 +40,7 @@ const int CONNECTED_BIT = BIT0;
 typedef nvs_handle nvs_handle_t;
 #endif
 
-__attribute__((access(write_only, 1, 2))) int wifi_get_project_key(char* project_key,
-                                                                   size_t project_key_len) {
+int wifi_get_project_key(char* project_key, size_t project_key_len) {
   // Configurable project key not supported, project key must be compiled in via
   // CONFIG_MEMFAULT_PROJECT_KEY
   return 1;
diff --git a/examples/esp32/apps/memfault_demo_app/main/settings.c b/examples/esp32/apps/memfault_demo_app/main/settings.c
@@ -8,6 +8,7 @@
 #include "settings.h"
 
 #include <inttypes.h>
+#include <stdint.h>
 #include <string.h>
 
 #include "argtable3/argtable3.h"
@@ -103,7 +104,10 @@ static esp_err_t prv_open_nvs(nvs_handle_t *nvs_handle) {
   return ESP_OK;
 }
 
-__attribute__((access(write_only, 2))) int settings_get(enum settings_key key, void *value,
+#if __GNUC__ >= 11
+__attribute__((access(write_only, 2)))
+#endif
+int settings_get(enum settings_key key, void *value,
                                                         size_t *len) {
   if (!prv_settings_key_is_valid(key)) {
     ESP_LOGE(__func__, "Invalid key: %d", key);
@@ -163,8 +167,10 @@ __attribute__((access(write_only, 2))) int settings_get(enum settings_key key, v
   return err;
 }
 
-__attribute__((access(read_only, 2, 3))) int settings_set(enum settings_key key, const void *value,
-                                                          size_t len) {
+#if __GNUC__ >= 11
+__attribute__((access(read_only, 2, 3)))
+#endif
+int settings_set(enum settings_key key, const void *value, size_t len) {
   if (!prv_settings_key_is_valid(key)) {
     ESP_LOGE(__func__, "Invalid key: %d", key);
     return ESP_ERR_INVALID_ARG;
@@ -316,12 +322,14 @@ static int prv_set_cmd(int argc, char **argv) {
       break;
     case kSettingsTypeI32:
       // convert string to int
-      int32_t i32;
-      if (sscanf(s_set_args.value->sval[0], "%" SCNi32, &i32) != 1) {
-        ESP_LOGE(__func__, "Invalid value: %s", s_set_args.value->sval[0]);
-        return 1;
+      {
+        int32_t i32;
+        if (sscanf(s_set_args.value->sval[0], "%" SCNi32, &i32) != 1) {
+          ESP_LOGE(__func__, "Invalid value: %s", s_set_args.value->sval[0]);
+          return 1;
+        }
+        err = settings_set(key, &i32, sizeof(i32));
       }
-      err = settings_set(key, &i32, sizeof(i32));
       break;
     default:
       return 1;
diff --git a/examples/esp32/apps/memfault_demo_app/main/settings.h b/examples/esp32/apps/memfault_demo_app/main/settings.h
@@ -9,6 +9,8 @@
 
 #include <stddef.h>
 
+#include "memfault/esp_port/version.h"
+
 enum settings_key {
   kSettingsWifiSsid,
   kSettingsWifiPassword,
@@ -17,8 +19,23 @@ enum settings_key {
   kSettingsLedBlinkIntervalMs,
 };
 
-__attribute__((access(write_only, 2))) int settings_get(enum settings_key key, void *value,
-                                                        size_t *len);
-__attribute__((access(read_only, 2, 3))) int settings_set(enum settings_key key, const void *value,
-                                                          size_t len);
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 0, 0)
+  #if __GNUC__ >= 11
+__attribute__((access(write_only, 2)))
+  #endif
+  int settings_get(enum settings_key key, void *value, size_t *len);
+  #if __GNUC__ >= 11
+__attribute__((access(read_only, 2, 3)))
+  #endif
+  int settings_set(enum settings_key key, const void *value, size_t len);
 void settings_register_shell_commands(void);
+#else   // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 0, 0)
+// stub definitions that always fail
+static inline int settings_get(enum settings_key key, void *value, size_t *len) {
+  return -1;
+}
+static inline int settings_set(enum settings_key key, const void *value, size_t len) {
+  return -1;
+}
+static inline void settings_register_shell_commands(void) {}
+#endif  // ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 0, 0)
diff --git a/ports/esp_idf/memfault/common/memfault_platform_core.c b/ports/esp_idf/memfault/common/memfault_platform_core.c
@@ -175,13 +175,13 @@ void memfault_boot(void) {
 
   memfault_build_info_dump();
 
-#if CONFIG_MEMFAULT_CLI_ENABLED
+#if defined(CONFIG_MEMFAULT_CLI_ENABLED)
   // register CLI for easily testing Memfault
   memfault_register_cli();
 #endif
 }
 
-#if CONFIG_MEMFAULT_AUTOMATIC_INIT
+#if defined(CONFIG_MEMFAULT_AUTOMATIC_INIT)
 // register an initialization routine that will be run from do_global_ctors()
 static void __attribute__((constructor)) prv_memfault_boot(void) {
   memfault_boot();
diff --git a/ports/esp_idf/memfault/common/memfault_platform_metrics.c b/ports/esp_idf/memfault/common/memfault_platform_metrics.c
@@ -129,11 +129,18 @@ bool memfault_platform_metrics_timer_boot(uint32_t period_sec,
     .name = "mflt",
   };
 
+#if defined(CONFIG_MEMFAULT_AUTOMATIC_INIT)
+  // This is only needed if CONFIG_MEMFAULT_AUTOMATIC_INIT is enabled. Normally
+  // esp_timer_init() is called during the system init sequence, before
+  // app_main(), but if memfault_boot() is running in the system init stage, it
+  // can potentially run before esp_timer_init() has been called.
+  //
   // Ignore return value; this function should be safe to call multiple times
   // during system init, but needs to called before we create any timers.
   // See implementation here (may change by esp-idf version!):
   // https://github.com/espressif/esp-idf/blob/master/components/esp_timer/src/esp_timer.c#L431-L460
   (void)esp_timer_init();
+#endif
 
   esp_timer_handle_t periodic_timer;
   ESP_ERROR_CHECK(esp_timer_create(&periodic_timer_args, &periodic_timer));
diff --git a/tests/MakefileWorkerOverrides.mk b/tests/MakefileWorkerOverrides.mk
@@ -98,9 +98,12 @@ else
 COMPILER_SPECIFIC_WARNINGS += \
   -Wformat-signedness \
 
-# Enable gcc static analyzer
-CPPUTEST_C_WARNINGFLAGS += \
-  -fanalyzer \
+# Only enable -fanalyzer if GCC version is >= 12
+GCC_VERSION_GTEQ_12 := $(shell expr $$($(CC) -dumpversion | cut -f1 -d.) \>= 12)
+ifeq "$(GCC_VERSION_GTEQ_12)" "1"
+CFLAGS += \
+  -fanalyzer
+endif
 
 # Permit disabling the sanitizers via environment variable
 ifneq ($(MEMFAULT_DISABLE_ASAN),1)

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ typedef struct {`
`19`	`19`	`uint8_t patch;`
`20`	`20`	`} sMfltSdkVersion;`
`21`	`21`
`22`		`-#define MEMFAULT_SDK_VERSION { .major = 1, .minor = 3, .patch = 4 }`
`23`		`-#define MEMFAULT_SDK_VERSION_STR "1.3.4"`
	`22`	`+#define MEMFAULT_SDK_VERSION { .major = 1, .minor = 3, .patch = 5 }`
	`23`	`+#define MEMFAULT_SDK_VERSION_STR "1.3.5"`
`24`	`24`
`25`	`25`	`#ifdef __cplusplus`
`26`	`26`	`}`