Memfault BORT SDK 5.4.0 (Build 3192053)

Author: Memfault Inc.

Android.mk

@@ -8,14 +8,6 @@ bort-sepolicy-canary-check: selinux_policy $(shell test $(PLATFORM_SDK_VERSION)
 					echo "       that definitions from vendor/memfault/bort/BoardConfig.mk" 1>&2; \
 					echo "       are correctly included and not overwritten." 1>&2; \
 					echo "See https://mflt.io/android-sepolicy" 1>&2; \
-					exit 1; ) \
-                && grep bort_app_data_file $(TARGET_OUT_INTERMEDIATES)/ETC/*_seapp_contexts_intermediates/*_seapp_contexts > /dev/null || ( \
-					echo "==========" 1>&2; \
-					echo "ERROR: bort_app_data_file not found in sepolicy contexts" 1>&2; \
-					echo "       this usually indicates an integration issue. Please ensure" 1>&2; \
-					echo "       that definitions from vendor/memfault/bort/BoardConfig.mk" 1>&2; \
-					echo "       are correctly included and not overwritten." 1>&2; \
-					echo "See https://mflt.io/android-sepolicy" 1>&2; \
 					exit 1; ))
 
 .PHONY: bort-sepolicy-canary-check

BoardConfig.mk

@@ -1,19 +1,13 @@
 BORT_PATH := vendor/memfault/bort
 
-BORT_BOARD_SEPOLICY_DIR := $(BORT_PATH)/sepolicy
+
+ifeq ($(shell test $(PLATFORM_SDK_VERSION) -eq 27 && echo true),true)
+BORT_BOARD_SEPOLICY_DIR := $(BORT_PATH)/sepolicy/common
 ifeq (,$(findstring $(BORT_BOARD_SEPOLICY_DIR),$(BOARD_SEPOLICY_DIRS)))
   BOARD_SEPOLICY_DIRS += $(BORT_BOARD_SEPOLICY_DIR)
 endif
-
-BORT_SEPOLICY_VENDOR_DIR := $(BORT_PATH)/sepolicy/vendor-$(PLATFORM_SDK_VERSION)
-ifneq (,$(wildcard $(BORT_SEPOLICY_VENDOR_DIR)))
-  ifeq (,$(findstring $(BORT_SEPOLICY_VENDOR_DIR),$(BOARD_SEPOLICY_DIRS)))
-    BOARD_SEPOLICY_DIRS += $(BORT_SEPOLICY_VENDOR_DIR)
-  endif
 endif
 
-
-
 BORT_BOARD_SEPOLICY_M4DEF := memfault_platform_sdk_version=${PLATFORM_SDK_VERSION}
 ifeq (,$(findstring $(BORT_BOARD_SEPOLICY_M4DEF),$(BOARD_SEPOLICY_M4DEFS)))
   BOARD_SEPOLICY_M4DEFS += $(BORT_BOARD_SEPOLICY_M4DEF)

CHANGELOG.md

@@ -6,6 +6,98 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 This project currently does not attempt to adhere to Semantic Versioning, but
 breaking changes are avoided unless absolutely necessary.
 
+## [Unreleased]
+
+### :rocket: New Features
+
+- Added 3 more logs-to-metrics parser types.
+  - `sum_matching` captures 1 integer, and sums all captured values in the
+    heartbeat.
+  - `distribution_minmeanmax` captures 1 double, and generates a min/mean/max
+    distribution for all captured values in the heartbeat.
+  - `string_property` captures 1 string, and reports the latest value for that
+    string.
+- Added tracking of the metered, temporarily unmetered, and roaming network
+  capabilities in HRT.
+  - Added a `connectivity.metered.latest` heartbeat metric for tracking metered
+    network usage.
+- Added new disk wear and disk write Device Vital heartbeat metrics. eMMC/UFS
+  lifetime estimation and version stats are collected from the Health HAL
+  implementation, falling back to a hardcoded UFS or eMMC filepath if not
+  implemented. Bytes written each heartbeat is collected by reading the sectors
+  written value from `/proc/diskstats` for matching physical devices in
+  `/sys/block` multiplied by the sector size to get a value in bytes.
+  - `disk_wear.<source>.lifetime_remaining_pct.latest` captures the lifetime
+    remaining estimation for type A flash in increments of 10%. The source can
+    be one of: "mmc0", "624000.ufshc", or "HealthHAL".
+  - `disk_wear.<source>.lifetime_b_remaining_pct.latest` captures the lifetime
+    remaining estimation for type B flash in increments of 10%. The source can
+    be one of: "mmc0", "624000.ufshc", or "HealthHAL".
+  - `disk_wear.pre_eol.latest` captures the pre-EOL status of consumed reserved
+    blocks, as "Normal", "Warning", or "Urgent".
+  - `disk_wear.version.latest` captures the version as described from the vendor
+    implementation of the Health HAL.
+  - `disk_wear.vdc.bytes_written` captures the bytes written for that heartbeat.
+- Added per-app CPU usage metrics. The CPU usage percentage for each heartbeat
+  is collected by parsing `/proc/<pid>/stat/` for system and user time
+  (`stime` + `utime`) divided by the total usage (sum of all fields from
+  `/proc/stat`).
+  - By default, the SDK will only create heartbeat metrics for a defined set of
+    "interesting" processes. Please reach out to customer support to configure
+    this set.
+  - Otherwise, the top 10 processes exceeding the 50% CPU usage threshold will
+    also be recorded. Please reach out to customer support to configure these
+    thresholds.
+- Added support for Android 15.
+
+### :chart_with_upwards_trend: Improvements
+
+- Added parsers for more HRT batterystats data.
+  - `screen_doze` captures whether the display is dozing in a low power state
+    ([link](https://cs.android.com/android/platform/superproject/main/+/main:frameworks/base/core/java/android/view/Display.java;l=491;drc=61197364367c9e404c7da6900658f1b16c42d0da;bpv=1;bpt=1?q=isDozeState)).
+  - `flashlight` captures whether the flashlight was turned on.
+  - `bluetooth` captures whether Bluetooth was enabled.
+  - `usb_data` captures whether a USB connection was established (as reported by
+    `android.hardware.usb.action.USB_STATE`).
+  - `cellular_high_tx_power` captures whether the modem spent more of its time
+    at the highest power level versus any other level.
+  - `nr_state` captures the service level of the 5G network that's connected
+    ([link](https://cs.android.com/android/platform/superproject/main/+/main:frameworks/base/telephony/java/android/telephony/NetworkRegistrationInfo.java;l=147)).
+- Updated comments on various batterystats fields. More improvements to come in
+  clarifying the name and use of batterystats metrics!
+- Dumped any existing logs when continuous logging starts, to retain logs
+  captured from before a reboot.
+- Added control over the maximum age of sampled data, to match the controls over
+  unsampled data.
+- Added support for parsing the binary log buffers (events, security, stats)
+  with continuous logs.
+- Modified dumpstate to write bugreports to /data/misc/MemfaultBugReports
+  instead of to Bort's app dir. This is necessary for Android 15 support and CTS
+  compliance to work around neverallow sepolicy rules. This also allowed
+  deleting the custom `bort_app_data_file` app label for the Bort app.
+
+### :construction: Fixes
+
+- Added explicit Android System AID mappings for more consistent system UID
+  attribution in tombstone and network stats parsing.
+- Added VPN and USB as explicitly defined network types using
+  `connectivity.network`.
+- Fixed a bug in PhoneState where the unknown `???` state was reported as
+  `null`.
+- Added exponential backoff for EAGAIN errors in continuous logs. Each write is
+  fsync'd immediately after write to reduce the likelihood of data loss.
+- Added missing ignore.cil files for SDKs 32, 33, and 34.
+
+### :house: Internal
+
+- Stopped running unit tests on release sources.
+- Migrated the SDK to communicate over a named domain (\*.memfault.test) rather
+  than localhost for local development.
+- Removed unneeded mockk init calls.
+- Added some tests for unknown fields in device config.
+- Refactored the unsampled holding area logic into a single class.
+- Differentiated some continuous logging logs for easier debugging.
+
 ## v5.3.0 - February 14, 2025
 
 ### :rocket: New Features

MemfaultDumpstateRunner/MemfaultDumpstateRunner.cpp

@@ -56,7 +56,7 @@
 #define TARGET_APP_ID STRINGIFY(BORT_APPLICATION_ID)
 #define TARGET_COMPONENT_CLASS "com.memfault.bort.receivers.BugReportReceiver"
 #define TARGET_COMPONENT TARGET_APP_ID "/" TARGET_COMPONENT_CLASS
-#define TARGET_DIR "/data/data/" TARGET_APP_ID "/files/bugreports/"
+#define TARGET_DIR "/data/misc/MemfaultBugReports/"
 
 using android::os::dumpstate::CommandOptions;
 using android::os::dumpstate::RunCommandToFd;
@@ -283,54 +283,12 @@ void CleanupDumpstateLogs(void) {
     free(log_files);
 }
 
-// Based on https://cs.android.com/android/_/android/platform/frameworks/native/+/0f58ab624b96f7f2e49a606ee8ce0cedeb10004d:cmds/dumpstate/dumpstate.cpp;l=3650;drc=f2a15e8742cf33e37e6c96f4731c298c6749bb68
-bool createParentDirs(uint32_t targetUid) {
-    char path[sizeof(TARGET_DIR)];
-    memcpy(path, TARGET_DIR, sizeof(TARGET_DIR));
-
-    char *chp = const_cast<char *> (path);
-    bool success = true;
-
-    /* skip initial slash */
-    if (chp[0] == '/') {
-        chp++;
-    }
-
-    /* create leading directories, if necessary */
-    struct stat dir_stat;
-    while (chp && chp[0]) {
-        chp = strchr(chp, '/');
-        if (chp) {
-            *chp = 0;
-            if (stat(path, &dir_stat) == -1 || !S_ISDIR(dir_stat.st_mode)) {
-                ALOGD("Creating directory %s\n", path);
-                if (mkdir(path, 0770)) { /* drwxrwx--- */
-                    ALOGE("Unable to create directory %s: %s\n", path, strerror(errno));
-                    success = false;
-                } else if (chown(path, targetUid, targetUid)) {
-                    ALOGE("Unable to change ownership of dir %s: %s\n", path, strerror(errno));
-                    success = false;
-                }
-            }
-            *chp++ = '/';
-        }
-    }
-
-    return success;
-}
-
-
 }  // namespace
 
 int main(void) {
     const uint32_t targetUid = GetTargetUid();
     ALOGI("Target UID: %d", targetUid);
 
-    if (!createParentDirs(targetUid)) {
-        ALOGE("Failed to create output directories. ");
-        return EXIT_FAILURE;
-    }
-
     ALOGI("Starting bugreport collecting service");
 
     auto t0 = std::chrono::steady_clock::now();
@@ -366,7 +324,7 @@ int main(void) {
         goto cleanup;
     }
 
-    if (chown(targetPath.c_str(), targetUid, targetUid)) {
+    if (chown(targetPath.c_str(), targetUid, -1)) {
         ALOGE("Unable to change ownership to system of %s: %s\n",
               targetPath.c_str(), strerror(errno));
         goto cleanup;

MemfaultDumpstateRunner/memfault_init.rc

@@ -20,9 +20,13 @@ service memfault_dumpstatez /system/bin/dumpstate -S -d -z -q \
 # it to complete and copy the bugreport.zip into a location that can be accessed by Bort.
 # It runs as root and in the "dumpstate" sepolicy domain, because it needs
 # to access both the shell-owned bugreport output of dumpstate and it needs to be able to copy it
-# into Bort's filesystem sandboxed location. See MemfaultDumpstateRunner.cpp for
+# into the bugreport folder in /data/misc/MemfaultBugReports. See MemfaultDumpstateRunner.cpp for
 # the source code of the program itself.
 
+on post-fs-data
+    mkdir /data/misc/MemfaultBugReports/ 0771 system system
+    wait /data/misc/MemfaultBugReports/
+
 service memfault_dumpstate_runner /system_ext/bin/MemfaultDumpstateRunner
     class core
     disabled

MemfaultDumpster/Android.mk

@@ -24,8 +24,56 @@ LOCAL_SHARED_LIBRARIES := \
   libservices \
   libprotobuf-cpp-full \
   libmflt-reporting
-LOCAL_PROTOC_OPTIMIZE_TYPE := full
 LOCAL_STATIC_LIBRARIES := liblog
+
+# Support for storage wear info from HAL is available from 11+ on
+# devices that support it
+ifeq ($(call math_gt_or_eq, $(PLATFORM_SDK_VERSION), 30), true)
+  LOCAL_SHARED_LIBRARIES += \
+    android.hardware.health@1.0 \
+    android.hardware.health@2.0
+  LOCAL_STATIC_LIBRARIES += \
+    libhealthhalutils \
+    libhidlbase
+
+  # Android 13 and up support AIDL and can wrap HIDL hals in a backward compatible way,
+  # others are HIDL only
+  ifeq ($(call math_gt_or_eq, $(PLATFORM_SDK_VERSION), 33), true)
+    LOCAL_CFLAGS += -DSTORAGE_INFO_PREFER_AIDL
+    LOCAL_SHARED_LIBRARIES += \
+      libbinder_ndk \
+      libvndksupport
+    LOCAL_STATIC_LIBRARIES += \
+      android.hardware.health-translate-ndk \
+      libhealthshim
+
+    # Health HAL NDK is used to wrap HIDL health HALs, but has different versions depending on the
+    # platform release ids
+    ifeq ($(call math_gt_or_eq, $(PLATFORM_SDK_VERSION), 35), true)
+      # Android 15 has three point releases (AP3A, AP4A and BP1A) and the health hal NDK
+      # version differs between them
+      ifeq ($(findstring BP1A,$(BUILD_ID)),BP1A)
+        LOCAL_SHARED_LIBRARIES += android.hardware.health-V4-ndk
+      else
+        LOCAL_SHARED_LIBRARIES += android.hardware.health-V3-ndk
+      endif
+    else ifeq ($(call math_gt_or_eq, $(PLATFORM_SDK_VERSION), 34), true)
+      # Android 14 has three point releases (UP1A, AP1A and AP2A) and the health hal NDK
+      # version differs between them
+      ifeq ($(findstring UP1A,$(BUILD_ID)),UP1A)
+        LOCAL_SHARED_LIBRARIES += android.hardware.health-V2-ndk
+      else
+        LOCAL_SHARED_LIBRARIES += android.hardware.health-V3-ndk
+      endif
+    else
+      LOCAL_SHARED_LIBRARIES += android.hardware.health-V1-ndk
+    endif
+  else
+    LOCAL_CFLAGS += -DSTORAGE_INFO_PREFER_HIDL
+  endif
+endif
+
+LOCAL_PROTOC_OPTIMIZE_TYPE := full
 LOCAL_INIT_RC := memfault_dumpster.rc
 LOCAL_SYSTEM_EXT_MODULE := true
 include $(BUILD_EXECUTABLE)