ci(runner): Add benchmark example and print benchmark results

Author: espzav

.github/workflows/build-run-applications.yml

@@ -5,28 +5,56 @@ name: Build ESP-BSP apps
 
 on:
   pull_request:
-    types: [opened, reopened, synchronize]
+    types: [opened, reopened, synchronize, labeled]
+  push:
+    branches:
+      - master
+  workflow_dispatch:
+    inputs:
+      WFType:
+        description: 'Workflow type'
+        required: true
+        default: 'Build + Tests'
+        type: choice
+        options:
+        - Build + Tests
+        - Build + Tests + Benchmark
 
 jobs:
   build:
     strategy:
       matrix:
         include:
           - idf_ver: "latest"
-            parallel_count: 5
+            parallel_count: 10
             parallel_index: 1
           - idf_ver: "latest"
-            parallel_count: 5
+            parallel_count: 10
             parallel_index: 2
           - idf_ver: "latest"
-            parallel_count: 5
+            parallel_count: 10
             parallel_index: 3
           - idf_ver: "latest"
-            parallel_count: 5
+            parallel_count: 10
             parallel_index: 4
           - idf_ver: "latest"
-            parallel_count: 5
+            parallel_count: 10
             parallel_index: 5
+          - idf_ver: "latest"
+            parallel_count: 10
+            parallel_index: 6
+          - idf_ver: "latest"
+            parallel_count: 10
+            parallel_index: 7
+          - idf_ver: "latest"
+            parallel_count: 10
+            parallel_index: 8
+          - idf_ver: "latest"
+            parallel_count: 10
+            parallel_index: 9
+          - idf_ver: "latest"
+            parallel_count: 10
+            parallel_index: 10
           - idf_ver: "release-v5.1"
             parallel_count: 2
             parallel_index: 1
@@ -89,7 +117,7 @@ jobs:
 
   run-target:
     name: Run apps
-    if: github.repository_owner == 'espressif' && needs.prepare.outputs.build_only != '1'
+    if: github.repository_owner == 'espressif' && !contains(github.event.pull_request.labels.*.name, 'Build only')
     needs: build
     strategy:
       fail-fast: false
@@ -151,6 +179,7 @@ jobs:
             target: "esp32s3"
     env:
       TEST_RESULT_NAME: test_results_${{ matrix.runner.target }}_${{ matrix.runner.marker }}_${{ matrix.idf_ver }}
+      BENCHMARK_RESULT_NAME: benchmark_${{ matrix.runner.target }}_${{ matrix.runner.marker }}_${{ matrix.idf_ver }}
       TEST_RESULT_FILE: test_results_${{ matrix.runner.target }}_${{ matrix.runner.marker }}_${{ matrix.idf_ver }}.xml
     runs-on: [self-hosted, Linux, bspwall]
     container:
@@ -165,22 +194,58 @@ jobs:
       - name: Install Python packages
         env:
           PIP_EXTRA_INDEX_URL: "https://dl.espressif.com/pypi/"
-        run: pip install --prefer-binary cryptography pytest-embedded pytest-embedded-serial-esp pytest-embedded-idf pytest-custom_exit_code
+        run: |
+          echo "PYTEST_BENCHMARK_IGNORE=--ignore='examples/display_lvgl_benchmark'" >> $GITHUB_ENV
+          pip install --prefer-binary cryptography pytest-embedded pytest-embedded-serial-esp pytest-embedded-idf pytest-custom_exit_code
+      - name: Download latest results
+        uses: actions/download-artifact@v4
+        with:
+          pattern: benchmark_*
+          path: benchmark/
+      - name: Set ignores
+        if: contains(github.event.pull_request.labels.*.name, 'Run benchmark') || contains(inputs.WFType, 'Build + Tests + Benchmark') || github.ref_name == 'master'
+        id: set_ignores
+        run: |
+          echo "PYTEST_BENCHMARK_IGNORE=" >> $GITHUB_ENV
+      - name: Pull
+        run: |
+          git pull --rebase origin ${{ github.head_ref }} || echo "No remote changes to rebase"
       - name: Run apps
         run: |
-          pytest --suppress-no-test-exit-code --ignore-glob '*/managed_components/*' --ignore=.github --junit-xml=${{ env.TEST_RESULT_FILE }} --target=${{ matrix.runner.target }} -m ${{ matrix.runner.marker }} --build-dir=build_${{ matrix.runner.runs-on }}
+          pytest --suppress-no-test-exit-code --ignore-glob '*/managed_components/*' --ignore=.github ${{ env.PYTEST_BENCHMARK_IGNORE }} --junit-xml=${{ env.TEST_RESULT_FILE }} --target=${{ matrix.runner.target }} -m ${{ matrix.runner.marker }} --build-dir=build_${{ matrix.runner.runs-on }}
       - name: Upload test results
         uses: actions/upload-artifact@v4
         if: always()
         with:
           name: ${{ env.TEST_RESULT_NAME }}
-          path: ${{ env.TEST_RESULT_FILE }}
+          path: |
+            ${{ env.TEST_RESULT_FILE }}
+            benchmark_*.md
+            benchmark_*.json
+            benchmark.json
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: github.ref_name == 'master'
+        with:
+          name: ${{ env.BENCHMARK_RESULT_NAME }}
+          path: |
+            benchmark_*.md
+            benchmark_*.json
+      - name: Update benchmark release
+        uses: pyTooling/Actions/releaser@r0
+        if: github.ref_name == 'master'
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: |
+            benchmark_*.json
+            benchmark_*.md
+          tag: benchmark-latest
 
   publish-results:
     name: Publish Test results
     needs:
       - run-target
-    if: github.repository_owner == 'espressif' && always() && github.event_name == 'pull_request' && needs.prepare.outputs.build_only == '0'
+    if: github.repository_owner == 'espressif' && always() && github.event_name == 'pull_request' && !contains(github.event.pull_request.labels.*.name, 'Build only')
     runs-on: ubuntu-22.04
     steps:
       - name: Download Test results
@@ -192,3 +257,29 @@ jobs:
         uses: EnricoMi/publish-unit-test-result-action@v2
         with:
           files: test_results/**/*.xml
+      - name: Find test result files
+        id: find_files
+        run: |
+          OUTPUT_FILE="combined_benchmarks.md"
+          echo "" > $OUTPUT_FILE
+          python <<EOF
+          import glob
+
+          files = sorted(glob.glob("test_results/**/benchmark_*.md"))
+          print(files)
+          output_file = "combined_benchmarks.md"
+
+          with open(output_file, "w", encoding="utf-8") as outfile:
+              for file in files:
+                  with open(file, "r", encoding="utf-8") as infile:
+                      outfile.write(infile.read() + "\n\n")
+
+          print(f"Merged {len(files)} files into {output_file}")
+          EOF
+
+          echo "output_file=$OUTPUT_FILE" >> "$GITHUB_ENV"
+      - name: Comment PR
+        uses: thollander/actions-comment-pull-request@v3
+        with:
+          comment-tag: benchmark_results
+          file-path: ${{ env.output_file }}

examples/display_lvgl_benchmark/CMakeLists.txt

@@ -0,0 +1,10 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.5)
+
+set(COMPONENTS main) # "Trim" the build. Include the minimal set of components; main and anything it depends on.
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+add_compile_options("-Wno-attributes") # For LVGL code
+project(display_lvgl_benchmark)

examples/display_lvgl_benchmark/README.md

@@ -0,0 +1,17 @@
+# Display LVGL Benchmark
+
+This example shows LVGL internal benchmark demo.
+
+## How to use the example
+
+### Hardware Required
+
+* ESP32-S3-LCD-EV-Board or ESP32-S3-LCD-EV-Board-2
+* USB-C Cable
+
+### Compile and flash
+
+```
+idf.py -p COMx build flash monitor
+```
+

examples/display_lvgl_benchmark/main/CMakeLists.txt

@@ -0,0 +1,17 @@
+set(LV_DEMO_DIR "")
+set(LV_DEMOS_SOURCES "")
+if(CONFIG_LV_USE_DEMO_BENCHMARK)
+    list(APPEND LV_DEMO_DIR ../managed_components/lvgl__lvgl/demos)
+    file(GLOB_RECURSE LV_DEMOS_SOURCES ${LV_DEMO_DIR}/*.c)
+endif()
+
+idf_component_register(
+    SRCS "main.c" ${LV_DEMOS_SOURCES}
+    INCLUDE_DIRS "." ${LV_DEMO_DIR})
+
+if(CONFIG_LV_USE_DEMO_BENCHMARK)
+set_source_files_properties(
+    ${LV_DEMOS_SOURCES}
+    PROPERTIES COMPILE_OPTIONS
+    -DLV_LVGL_H_INCLUDE_SIMPLE)
+endif()

examples/display_lvgl_benchmark/main/idf_component.yml

@@ -0,0 +1,5 @@
+description: BSP Display rotation example
+dependencies:
+  esp32_p4_function_ev_board:
+    version: '*'
+    override_path: ../../../bsp/esp32_p4_function_ev_board

examples/display_lvgl_benchmark/main/main.c

@@ -0,0 +1,39 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: CC0-1.0
+ */
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "esp_log.h"
+
+#include "lv_demos.h"
+#include "bsp/esp-bsp.h"
+
+static char *TAG = "app_main";
+
+#define LOG_MEM_INFO    (0)
+
+void app_main(void)
+{
+    /* Initialize display and LVGL */
+#if defined(BSP_LCD_SUB_BOARD_2_H_RES)
+    /* Only for esp32_s3_lcd_ev_board */
+    bsp_display_cfg_t cfg = {
+        .lvgl_port_cfg = ESP_LVGL_PORT_INIT_CONFIG(),
+    };
+    cfg.lvgl_port_cfg.task_stack = 10000;
+    bsp_display_start_with_config(&cfg);
+#else
+    bsp_display_start();
+#endif
+
+    /* Set display brightness to 100% */
+    bsp_display_backlight_on();
+
+    ESP_LOGI(TAG, "Display LVGL demo");
+    bsp_display_lock(0);
+    lv_demo_benchmark();    /* A demo to measure the performance of LVGL or to compare different settings. */
+    bsp_display_unlock();
+}

examples/display_lvgl_benchmark/partitions.csv

@@ -0,0 +1,5 @@
+# Name,   Type, SubType, Offset,  Size, Flags
+# Note: if you change the phy_init or app partition offset, make sure to change the offset in Kconfig.projbuild
+nvs,      data, nvs,     0x9000,  0x6000,
+phy_init, data, phy,     0xf000,  0x1000,
+factory,  app,  factory, 0x10000, 0x160000,