From 19aca52f08156b07959da00142eab28fefdc1972 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Fri, 27 Feb 2026 10:58:21 +0800 Subject: [PATCH] feat(size_metrics): add size metrics test apps Add test apps for binary size tracking: - esp_timer size_metrics app with minimal/full sdkconfig variants - minimal_baseline app to establish the platform binary size floor --- .../test_apps/size_metrics/CMakeLists.txt | 12 +++ .../test_apps/size_metrics/README.md | 2 + .../size_metrics/main/CMakeLists.txt | 3 + .../size_metrics/main/Kconfig.projbuild | 18 ++++ .../test_apps/size_metrics/main/main.c | 85 +++++++++++++++++++ .../size_metrics/pytest_size_metrics.py | 12 +++ .../test_apps/size_metrics/sdkconfig.ci.full | 3 + .../size_metrics/sdkconfig.ci.minimal | 3 + .../test_apps/size_metrics/sdkconfig.defaults | 2 + .../hello_world/main/hello_world_main.c | 2 +- .../size_metrics/size_metrics_config.yml | 8 +- .../test_apps/configs/sdkconfig.size_metrics | 8 ++ .../size_metrics/.build-test-rules.yml | 7 ++ .../minimal_baseline/CMakeLists.txt | 12 +++ .../size_metrics/minimal_baseline/README.md | 35 ++++++++ .../minimal_baseline/main/CMakeLists.txt | 2 + .../size_metrics/minimal_baseline/main/main.c | 26 ++++++ .../pytest_minimal_baseline.py | 12 +++ .../minimal_baseline/sdkconfig.defaults | 1 + 19 files changed, 251 insertions(+), 2 deletions(-) create mode 100644 components/esp_timer/test_apps/size_metrics/CMakeLists.txt create mode 100644 components/esp_timer/test_apps/size_metrics/README.md create mode 100644 components/esp_timer/test_apps/size_metrics/main/CMakeLists.txt create mode 100644 components/esp_timer/test_apps/size_metrics/main/Kconfig.projbuild create mode 100644 components/esp_timer/test_apps/size_metrics/main/main.c create mode 100644 components/esp_timer/test_apps/size_metrics/pytest_size_metrics.py create mode 100644 components/esp_timer/test_apps/size_metrics/sdkconfig.ci.full create mode 100644 components/esp_timer/test_apps/size_metrics/sdkconfig.ci.minimal create mode 100644 components/esp_timer/test_apps/size_metrics/sdkconfig.defaults create mode 100644 tools/test_apps/configs/sdkconfig.size_metrics create mode 100644 tools/test_apps/size_metrics/.build-test-rules.yml create mode 100644 tools/test_apps/size_metrics/minimal_baseline/CMakeLists.txt create mode 100644 tools/test_apps/size_metrics/minimal_baseline/README.md create mode 100644 tools/test_apps/size_metrics/minimal_baseline/main/CMakeLists.txt create mode 100644 tools/test_apps/size_metrics/minimal_baseline/main/main.c create mode 100644 tools/test_apps/size_metrics/minimal_baseline/pytest_minimal_baseline.py create mode 100644 tools/test_apps/size_metrics/minimal_baseline/sdkconfig.defaults diff --git a/components/esp_timer/test_apps/size_metrics/CMakeLists.txt b/components/esp_timer/test_apps/size_metrics/CMakeLists.txt new file mode 100644 index 00000000000..03d1c0f2fd1 --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/CMakeLists.txt @@ -0,0 +1,12 @@ +# Size metrics test app for esp_timer component +cmake_minimum_required(VERSION 3.22) + +list(PREPEND SDKCONFIG_DEFAULTS + "$ENV{IDF_PATH}/tools/test_apps/configs/sdkconfig.size_metrics" + "sdkconfig.defaults") + +# "Trim" the build. Include the minimal set of components, main, and anything it depends on. +set(COMPONENTS main) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(size_metrics) diff --git a/components/esp_timer/test_apps/size_metrics/README.md b/components/esp_timer/test_apps/size_metrics/README.md new file mode 100644 index 00000000000..657193bcfb9 --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/README.md @@ -0,0 +1,2 @@ +| Supported Targets | ESP32 | ESP32-C6 | +| ----------------- | ----- | -------- | diff --git a/components/esp_timer/test_apps/size_metrics/main/CMakeLists.txt b/components/esp_timer/test_apps/size_metrics/main/CMakeLists.txt new file mode 100644 index 00000000000..f3bf6efd3e3 --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/main/CMakeLists.txt @@ -0,0 +1,3 @@ +idf_component_register(SRCS "main.c" + PRIV_REQUIRES esp_timer + WHOLE_ARCHIVE) diff --git a/components/esp_timer/test_apps/size_metrics/main/Kconfig.projbuild b/components/esp_timer/test_apps/size_metrics/main/Kconfig.projbuild new file mode 100644 index 00000000000..3d187ebd2fa --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/main/Kconfig.projbuild @@ -0,0 +1,18 @@ +menu "Size Metrics Test App Configuration" + + choice SIZE_METRICS_FUNCTION_SET + prompt "Function set to compile" + default SIZE_METRICS_FUNCTION_SET_MINIMAL + help + Select which set of functions to compile for size metrics comparison. + Minimal set includes only basic functions, full set includes all features. + + config SIZE_METRICS_FUNCTION_SET_MINIMAL + bool "Minimal function set" + + config SIZE_METRICS_FUNCTION_SET_FULL + bool "Full function set" + + endchoice + +endmenu diff --git a/components/esp_timer/test_apps/size_metrics/main/main.c b/components/esp_timer/test_apps/size_metrics/main/main.c new file mode 100644 index 00000000000..eba132844ac --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/main/main.c @@ -0,0 +1,85 @@ +/* + * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#include + +#include "esp_timer.h" +#include "sdkconfig.h" + +#if CONFIG_SIZE_METRICS_FUNCTION_SET_MINIMAL +// Minimal function set - basic timer operations only +static void minimal_timer_callback(void* arg) +{ + // Minimal callback implementation +} + +static void minimal_functions(void) +{ + esp_timer_handle_t timer; + esp_timer_create_args_t timer_args = { + .callback = minimal_timer_callback, + .name = "minimal_timer" + }; + esp_timer_create(&timer_args, &timer); + esp_timer_start_once(timer, 1000); + esp_timer_stop(timer); + esp_timer_delete(timer); +} +#endif // CONFIG_SIZE_METRICS_FUNCTION_SET_MINIMAL + +#if CONFIG_SIZE_METRICS_FUNCTION_SET_FULL +// Full function set - all timer features +static void full_timer_callback(void* arg) +{ + // Full callback implementation with more features +} + +static void full_periodic_timer_callback(void* arg) +{ + // Periodic timer callback +} + +static void full_functions(void) +{ + esp_timer_handle_t oneshot_timer; + esp_timer_handle_t periodic_timer; + + // One-shot timer + esp_timer_create_args_t oneshot_args = { + .callback = full_timer_callback, + .name = "oneshot_timer" + }; + esp_timer_create(&oneshot_args, &oneshot_timer); + esp_timer_start_once(oneshot_timer, 1000); + + // Periodic timer + esp_timer_create_args_t periodic_args = { + .callback = full_periodic_timer_callback, + .name = "periodic_timer" + }; + esp_timer_create(&periodic_args, &periodic_timer); + esp_timer_start_periodic(periodic_timer, 5000); + + // Timer operations + esp_timer_stop(oneshot_timer); + esp_timer_stop(periodic_timer); + esp_timer_delete(oneshot_timer); + esp_timer_delete(periodic_timer); +} +#endif // CONFIG_SIZE_METRICS_FUNCTION_SET_FULL + +void app_main(void) +{ + printf("size_metrics app_main started\n"); + +#if CONFIG_SIZE_METRICS_FUNCTION_SET_MINIMAL + minimal_functions(); +#endif + +#if CONFIG_SIZE_METRICS_FUNCTION_SET_FULL + full_functions(); +#endif +} diff --git a/components/esp_timer/test_apps/size_metrics/pytest_size_metrics.py b/components/esp_timer/test_apps/size_metrics/pytest_size_metrics.py new file mode 100644 index 00000000000..98c446511cb --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/pytest_size_metrics.py @@ -0,0 +1,12 @@ +# SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD +# SPDX-License-Identifier: Unlicense OR CC0-1.0 +import pytest +from pytest_embedded_idf.dut import IdfDut +from pytest_embedded_idf.utils import idf_parametrize + + +@pytest.mark.generic +@pytest.mark.parametrize('config', ['minimal', 'full'], indirect=True) +@idf_parametrize('target', ['esp32', 'esp32c6'], indirect=['target']) +def test_esp_timer_size_metrics_boots(dut: IdfDut) -> None: + dut.expect_exact('size_metrics app_main started', timeout=30) diff --git a/components/esp_timer/test_apps/size_metrics/sdkconfig.ci.full b/components/esp_timer/test_apps/size_metrics/sdkconfig.ci.full new file mode 100644 index 00000000000..ea941252da9 --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/sdkconfig.ci.full @@ -0,0 +1,3 @@ +# Full configuration for size metrics +CONFIG_SIZE_METRICS_FUNCTION_SET_MINIMAL=n +CONFIG_SIZE_METRICS_FUNCTION_SET_FULL=y diff --git a/components/esp_timer/test_apps/size_metrics/sdkconfig.ci.minimal b/components/esp_timer/test_apps/size_metrics/sdkconfig.ci.minimal new file mode 100644 index 00000000000..449c71e70f3 --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/sdkconfig.ci.minimal @@ -0,0 +1,3 @@ +# Minimal configuration for size metrics +CONFIG_SIZE_METRICS_FUNCTION_SET_MINIMAL=y +CONFIG_SIZE_METRICS_FUNCTION_SET_FULL=n diff --git a/components/esp_timer/test_apps/size_metrics/sdkconfig.defaults b/components/esp_timer/test_apps/size_metrics/sdkconfig.defaults new file mode 100644 index 00000000000..d2be5ec9e4b --- /dev/null +++ b/components/esp_timer/test_apps/size_metrics/sdkconfig.defaults @@ -0,0 +1,2 @@ +# App-specific defaults for esp_timer size metrics +CONFIG_ESP_TIMER_PROFILING=n diff --git a/examples/get-started/hello_world/main/hello_world_main.c b/examples/get-started/hello_world/main/hello_world_main.c index f25de955002..7010f3ef61c 100644 --- a/examples/get-started/hello_world/main/hello_world_main.c +++ b/examples/get-started/hello_world/main/hello_world_main.c @@ -17,7 +17,7 @@ void app_main(void) { printf("Hello world!\n"); - /* Print chip inf ormation */ + /* Print chip information */ esp_chip_info_t chip_info; uint32_t flash_size; esp_chip_info(&chip_info); diff --git a/tools/ci/metrics/size_metrics/size_metrics_config.yml b/tools/ci/metrics/size_metrics/size_metrics_config.yml index cc6db3e3a73..efb750f847f 100644 --- a/tools/ci/metrics/size_metrics/size_metrics_config.yml +++ b/tools/ci/metrics/size_metrics/size_metrics_config.yml @@ -49,8 +49,14 @@ # # Entries below define the apps that publish size metrics: -examples/get-started/hello_world: +tools/test_apps/size_metrics/minimal_baseline: libs: all bootloader: true configs: - default + +components/esp_timer/test_apps/size_metrics: + libs: all + configs: + - minimal + - full diff --git a/tools/test_apps/configs/sdkconfig.size_metrics b/tools/test_apps/configs/sdkconfig.size_metrics new file mode 100644 index 00000000000..8d24d491204 --- /dev/null +++ b/tools/test_apps/configs/sdkconfig.size_metrics @@ -0,0 +1,8 @@ +# Shared production-style defaults for apps that publish size metrics +CONFIG_COMPILER_OPTIMIZATION_SIZE=y +CONFIG_BOOTLOADER_COMPILER_OPTIMIZATION_SIZE=y +CONFIG_COMPILER_OPTIMIZATION_ASSERTIONS_SILENT=y +CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT=y +CONFIG_COMPILER_NO_MERGE_CONSTANTS=y +CONFIG_LOG_DEFAULT_LEVEL_WARN=y +CONFIG_BOOTLOADER_LOG_LEVEL_WARN=y diff --git a/tools/test_apps/size_metrics/.build-test-rules.yml b/tools/test_apps/size_metrics/.build-test-rules.yml new file mode 100644 index 00000000000..0887edd64bf --- /dev/null +++ b/tools/test_apps/size_metrics/.build-test-rules.yml @@ -0,0 +1,7 @@ +# Documentation: .gitlab/ci/README.md#manifest-file-to-control-the-buildtest-apps + +tools/test_apps/size_metrics/minimal_baseline: + disable_test: + - if: IDF_TARGET == "linux" + temporary: true + reason: Not a real hardware target diff --git a/tools/test_apps/size_metrics/minimal_baseline/CMakeLists.txt b/tools/test_apps/size_metrics/minimal_baseline/CMakeLists.txt new file mode 100644 index 00000000000..0ab22000b6c --- /dev/null +++ b/tools/test_apps/size_metrics/minimal_baseline/CMakeLists.txt @@ -0,0 +1,12 @@ +# This is the project CMakeLists.txt file for the minimal_baseline size metrics test app +cmake_minimum_required(VERSION 3.22) + +list(PREPEND SDKCONFIG_DEFAULTS + "$ENV{IDF_PATH}/tools/test_apps/configs/sdkconfig.size_metrics" + "sdkconfig.defaults") + +# "Trim" the build. Include the minimal set of components, main, and anything it depends on. +set(COMPONENTS main) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(minimal_baseline) diff --git a/tools/test_apps/size_metrics/minimal_baseline/README.md b/tools/test_apps/size_metrics/minimal_baseline/README.md new file mode 100644 index 00000000000..01335eb4d60 --- /dev/null +++ b/tools/test_apps/size_metrics/minimal_baseline/README.md @@ -0,0 +1,35 @@ +| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C5 | ESP32-C6 | ESP32-C61 | ESP32-H2 | ESP32-H21 | ESP32-H4 | ESP32-P4 | ESP32-S2 | ESP32-S3 | ESP32-S31 | +| ----------------- | ----- | -------- | -------- | -------- | -------- | --------- | -------- | --------- | -------- | -------- | -------- | -------- | --------- | + +# Minimal Baseline Size Metrics App + +This is a **build-only** integration app for size metrics tracking. It exercises the absolute minimum SDK stack: +- `app_main()` entry point +- `esp_system` and its core dependencies + +## Purpose + +Establish a floor measurement for the core ESP-IDF SDK and detect regressions in: +- Toolchain changes (compiler, linker) +- newlib updates +- Linker script changes +- Core system component dependencies + +## Source Frozen + +This app is **source-frozen**. The application code should never change unless forced by SDK API changes (e.g., breaking API changes at major version boundaries). Any size change detected in CI is attributable to SDK changes, not application code evolution. + +## Configuration + +- Built with `-Os` (size optimization) +- Disables WDT, assertions, and other noise-inducing features +- Trimmed build: only includes `main` component and its dependencies +- Targets: ESP32 (Xtensa) and ESP32-C6 (RISC-V) + +## Metrics Tracked + +- Total flash usage +- Total DRAM usage +- Total IRAM usage + +Metrics are collected from the `.map` file using `esp_idf_size` and uploaded via `esp-metrics-cli`. diff --git a/tools/test_apps/size_metrics/minimal_baseline/main/CMakeLists.txt b/tools/test_apps/size_metrics/minimal_baseline/main/CMakeLists.txt new file mode 100644 index 00000000000..eda7fda805b --- /dev/null +++ b/tools/test_apps/size_metrics/minimal_baseline/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "main.c" + WHOLE_ARCHIVE) diff --git a/tools/test_apps/size_metrics/minimal_baseline/main/main.c b/tools/test_apps/size_metrics/minimal_baseline/main/main.c new file mode 100644 index 00000000000..a672348d9b2 --- /dev/null +++ b/tools/test_apps/size_metrics/minimal_baseline/main/main.c @@ -0,0 +1,26 @@ +/* + * SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD + * + * SPDX-License-Identifier: Unlicense OR CC0-1.0 + */ + +#include + +/** + * Minimal baseline integration app for size metrics. + * + * This app exercises only the absolute minimum SDK stack - app_main + esp_system. + * It establishes a floor measurement for the core SDK and catches regressions in: + * - Toolchain changes + * - newlib updates + * - Linker script changes + * - Core esp_system dependencies + * + * This app keeps runtime behavior minimal and source-frozen. + * Any size change is attributable to SDK changes, not application code changes. + */ + +void app_main(void) +{ + printf("minimal_baseline app_main started\n"); +} diff --git a/tools/test_apps/size_metrics/minimal_baseline/pytest_minimal_baseline.py b/tools/test_apps/size_metrics/minimal_baseline/pytest_minimal_baseline.py new file mode 100644 index 00000000000..5862d729c34 --- /dev/null +++ b/tools/test_apps/size_metrics/minimal_baseline/pytest_minimal_baseline.py @@ -0,0 +1,12 @@ +# SPDX-FileCopyrightText: 2026 Espressif Systems (Shanghai) CO LTD +# SPDX-License-Identifier: Unlicense OR CC0-1.0 +import pytest +from pytest_embedded_idf.dut import IdfDut +from pytest_embedded_idf.utils import idf_parametrize + + +@pytest.mark.generic +@pytest.mark.parametrize('config', ['default'], indirect=True) +@idf_parametrize('target', ['supported_targets'], indirect=['target']) +def test_minimal_baseline_boots(dut: IdfDut) -> None: + dut.expect_exact('minimal_baseline app_main started', timeout=30) diff --git a/tools/test_apps/size_metrics/minimal_baseline/sdkconfig.defaults b/tools/test_apps/size_metrics/minimal_baseline/sdkconfig.defaults new file mode 100644 index 00000000000..cfb8704462d --- /dev/null +++ b/tools/test_apps/size_metrics/minimal_baseline/sdkconfig.defaults @@ -0,0 +1 @@ +# App-specific defaults for minimal_baseline size metrics