[DROPME] comparison workflow

mbrousset-ledger · mbrousset-ledger · commit 7ebc75245ffe · 2026-07-01T20:11:32.000+02:00
diff --git a/.github/workflows/build_all_c_apps.yml b/.github/workflows/build_all_c_apps.yml
@@ -28,7 +28,36 @@ jobs:
         id: get_c_apps
         run: |
           python .github/workflows/scripts/get_c_apps.py ${{ secrets.GITHUB_TOKEN }}
-          echo "c_apps=$(cat c_apps.json)" >> $GITHUB_OUTPUT
+          # PoC LTO: restrict to a small set of tier-1 apps to keep the matrix cheap.
+          python - <<'PY'
+          import json
+
+          REQUIRED_APPS = [
+              "app-bitcoin-new",
+              "app-ethereum",
+              "app-solana",
+              "app-exchange",
+          ]
+
+          with open("c_apps.json", encoding="utf-8") as f:
+              all_apps = json.load(f)
+
+          by_name = {a.get("app-name"): a for a in all_apps if isinstance(a, dict)}
+          selected, missing = [], []
+          for name in REQUIRED_APPS:
+              app = by_name.get(name)
+              if app is None:
+                  missing.append(name)
+              else:
+                  selected.append(app)
+
+          if missing:
+              raise SystemExit("Missing required apps in matrix source: " + ", ".join(missing))
+
+          with open("c_apps_limited.json", "w", encoding="utf-8") as f:
+              json.dump(selected, f)
+          PY
+          echo "c_apps=$(cat c_apps_limited.json)" >> $GITHUB_OUTPUT
 
   print-matrix:
     needs: [prepare-matrix]
@@ -45,18 +74,21 @@ jobs:
       fail-fast: false
       matrix:
         apps: ${{ fromJSON(needs.prepare-matrix.outputs.c_apps) }}
+        # PoC LTO: same image & SDK ref for every config, only the make flags differ,
+        # so size and (indicative) build-time deltas are attributable to LTO.
+        config:
+          - name: baseline
+            make_flags: ''
+          - name: lto
+            make_flags: 'ENABLE_LINK_TIME_OPTIMIZATION=1 ENABLE_STACK_PROTECTOR=0'
+          - name: lto-sp
+            make_flags: 'ENABLE_LINK_TIME_OPTIMIZATION=1 ENABLE_STACK_PROTECTOR=1'
     runs-on: ubuntu-latest
     container:
       image: ghcr.io/ledgerhq/ledger-app-builder/ledger-app-builder:latest
     defaults:
       run:
         shell: bash
-    env:
-      # Some C apps embed a Rust component pinned (via rust-toolchain.toml) to a
-      # toolchain that differs from the one the builder image exports through
-      # RUSTUP_TOOLCHAIN. A set RUSTUP_TOOLCHAIN overrides that pin and breaks
-      # the build, so it is unset before make for these apps (see build steps).
-      RUSTUP_TOOLCHAIN_UNSET_APPS: "app-namada app-stacks"
 
     steps:
       - name: Clone App
@@ -69,48 +101,87 @@ jobs:
         uses: actions/checkout@v6
         with:
           path: sdk
-          ref: ${{ inputs.sdk_branch || github.head_ref }}
+          ref: ${{ inputs.sdk_branch || 'mbr/lto' }}
 
       - name: Install prerequisites
         run: pip install --break-system-packages ledgered
 
       - name: Build App for Nano X
         if: contains(matrix.apps.devices, 'nanox')
-        run: |
-          cd ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
-          echo "Building for Nano X"
-          if [[ " $RUSTUP_TOOLCHAIN_UNSET_APPS " == *" ${{ matrix.apps.app-name }} "* ]]; then unset RUSTUP_TOOLCHAIN; fi
-          make clean
-          make TARGET=nanox BOLOS_SDK=$GITHUB_WORKSPACE/sdk
+        run: bash "$GITHUB_WORKSPACE/sdk/.github/workflows/scripts/poc_lto_build_target.sh" nanox '${{ matrix.config.make_flags }}'
+        working-directory: ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
+      - name: Upload Nano X build
+        if: always() && contains(matrix.apps.devices, 'nanox')
+        uses: actions/upload-artifact@v4
+        with:
+          name: elf-${{ matrix.apps.app-name }}-nanox-${{ matrix.config.name }}
+          path: poc_out/nanox
+
       - name: Build App for Nano S+
         if: contains(matrix.apps.devices, 'nanos+')
-        run: |
-          cd ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
-          echo "Building for Nano S+"
-          if [[ " $RUSTUP_TOOLCHAIN_UNSET_APPS " == *" ${{ matrix.apps.app-name }} "* ]]; then unset RUSTUP_TOOLCHAIN; fi
-          make clean
-          make TARGET=nanos2 BOLOS_SDK=$GITHUB_WORKSPACE/sdk
+        run: bash "$GITHUB_WORKSPACE/sdk/.github/workflows/scripts/poc_lto_build_target.sh" nanos2 '${{ matrix.config.make_flags }}'
+        working-directory: ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
+      - name: Upload Nano S+ build
+        if: always() && contains(matrix.apps.devices, 'nanos+')
+        uses: actions/upload-artifact@v4
+        with:
+          name: elf-${{ matrix.apps.app-name }}-nanos2-${{ matrix.config.name }}
+          path: poc_out/nanos2
+
       - name: Build App for Stax
         if: contains(matrix.apps.devices, 'stax')
-        run: |
-          cd ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
-          echo "Building for Stax"
-          if [[ " $RUSTUP_TOOLCHAIN_UNSET_APPS " == *" ${{ matrix.apps.app-name }} "* ]]; then unset RUSTUP_TOOLCHAIN; fi
-          make clean
-          make TARGET=stax BOLOS_SDK=$GITHUB_WORKSPACE/sdk
+        run: bash "$GITHUB_WORKSPACE/sdk/.github/workflows/scripts/poc_lto_build_target.sh" stax '${{ matrix.config.make_flags }}'
+        working-directory: ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
+      - name: Upload Stax build
+        if: always() && contains(matrix.apps.devices, 'stax')
+        uses: actions/upload-artifact@v4
+        with:
+          name: elf-${{ matrix.apps.app-name }}-stax-${{ matrix.config.name }}
+          path: poc_out/stax
+
       - name: Build App for Flex
         if: contains(matrix.apps.devices, 'flex')
-        run: |
-          cd ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
-          echo "Building for Flex"
-          if [[ " $RUSTUP_TOOLCHAIN_UNSET_APPS " == *" ${{ matrix.apps.app-name }} "* ]]; then unset RUSTUP_TOOLCHAIN; fi
-          make clean
-          make TARGET=flex BOLOS_SDK=$GITHUB_WORKSPACE/sdk
+        run: bash "$GITHUB_WORKSPACE/sdk/.github/workflows/scripts/poc_lto_build_target.sh" flex '${{ matrix.config.make_flags }}'
+        working-directory: ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
+      - name: Upload Flex build
+        if: always() && contains(matrix.apps.devices, 'flex')
+        uses: actions/upload-artifact@v4
+        with:
+          name: elf-${{ matrix.apps.app-name }}-flex-${{ matrix.config.name }}
+          path: poc_out/flex
+
       - name: Build App for Apex+
         if: contains(matrix.apps.devices, 'apex_p')
-        run: |
-          cd ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
-          echo "Building for Apex+"
-          if [[ " $RUSTUP_TOOLCHAIN_UNSET_APPS " == *" ${{ matrix.apps.app-name }} "* ]]; then unset RUSTUP_TOOLCHAIN; fi
-          make clean
-          make TARGET=apex_p BOLOS_SDK=$GITHUB_WORKSPACE/sdk
+        run: bash "$GITHUB_WORKSPACE/sdk/.github/workflows/scripts/poc_lto_build_target.sh" apex_p '${{ matrix.config.make_flags }}'
+        working-directory: ${{ matrix.apps.app-name }}/${{ matrix.apps.build-directory }}
+      - name: Upload Apex+ build
+        if: always() && contains(matrix.apps.devices, 'apex_p')
+        uses: actions/upload-artifact@v4
+        with:
+          name: elf-${{ matrix.apps.app-name }}-apex_p-${{ matrix.config.name }}
+          path: poc_out/apex_p
+
+  compare-builds:
+    name: Compare builds (size & time)
+    needs: [test-build]
+    if: always()
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          pattern: elf-*-*-*
+          path: downloaded_artifacts
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y --no-install-recommends binutils
+      - name: Build comparison tables
+        run: python3 .github/workflows/scripts/poc_lto_compare.py downloaded_artifacts poc_lto.md
+      - name: Publish to summary
+        run: cat poc_lto.md >> $GITHUB_STEP_SUMMARY
+      - name: Upload comparison
+        uses: actions/upload-artifact@v4
+        with:
+          name: poc-lto-comparison
+          path: poc_lto.md
diff --git a/.github/workflows/scripts/poc_lto_build_target.sh b/.github/workflows/scripts/poc_lto_build_target.sh
@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+# PoC LTO: build one target for the current config, recording build time and the
+# make return code so the compare job can report timings and regressions.
+#
+# Usage (run from the app build directory):
+#   poc_lto_build_target.sh <TARGET> "<make_flags>"
+#
+# Never fails the step on a build error: a failed build is surfaced as a
+# regression by the compare job (missing ELF / non-zero rc).
+set -u
+
+T="$1"
+FLAGS="${2:-}"
+
+echo "=== Building TARGET=$T  flags: [$FLAGS] ==="
+make clean >/dev/null 2>&1 || true
+
+start=$SECONDS
+set +e
+# shellcheck disable=SC2086  # FLAGS must word-split into separate make arguments
+make TARGET="$T" BOLOS_SDK="$GITHUB_WORKSPACE/sdk" $FLAGS
+rc=$?
+set -e
+elapsed=$((SECONDS - start))
+
+# Collect outputs in a clean, build-directory-independent location for upload.
+outdir="$GITHUB_WORKSPACE/poc_out/$T"
+mkdir -p "$outdir"
+echo "$elapsed" > "$outdir/poc_time.txt"
+echo "$rc"      > "$outdir/poc_rc.txt"
+elf=$(find build -path "*/bin/app.elf" 2>/dev/null | head -1)
+if [ -n "$elf" ] && [ -f "$elf" ]; then
+  cp "$elf" "$outdir/app.elf"
+fi
+
+echo "TARGET=$T flags=[$FLAGS] rc=$rc time=${elapsed}s"
+exit 0
diff --git a/.github/workflows/scripts/poc_lto_compare.py b/.github/workflows/scripts/poc_lto_compare.py
@@ -0,0 +1,148 @@
+#!/usr/bin/env python3
+"""PoC LTO: aggregate per-build artifacts into size & build-time comparison tables.
+
+Each artifact directory is named ``elf-<app>-<target>-<config>`` and contains the
+uploaded ``build/<target>`` directory, i.e. ``bin/app.elf`` plus ``poc_time.txt`` and
+``poc_rc.txt`` written by poc_lto_build_target.sh.
+
+Usage: poc_lto_compare.py <artifacts_root> <output.md>
+"""
+import pathlib
+import subprocess
+import sys
+
+CONFIGS = ["baseline", "lto-sp", "lto"]  # most-specific suffix first
+TARGETS = ["nanos2", "nanox", "stax", "flex", "apex_p"]
+
+
+def parse_name(dirname):
+    name = dirname[len("elf-"):]
+    cfg = next((c for c in CONFIGS if name.endswith("-" + c)), None)
+    if cfg is None:
+        return None
+    name = name[: -(len(cfg) + 1)]
+    tgt = next((t for t in TARGETS if name.endswith("-" + t)), None)
+    if tgt is None:
+        return None
+    app = name[: -(len(tgt) + 1)]
+    return app, tgt, cfg
+
+
+def elf_sizes(elf):
+    text = None
+    out = subprocess.check_output(["size", "-A", str(elf)], text=True)
+    for line in out.splitlines():
+        cols = line.split()
+        if len(cols) >= 2 and cols[0] == ".text":
+            text = int(cols[1])
+            break
+    total = None
+    berkeley = subprocess.check_output(["size", str(elf)], text=True).splitlines()
+    if len(berkeley) >= 2:
+        total = int(berkeley[-1].split()[3])  # text data bss dec hex filename
+    return text, total
+
+
+def read_int(path):
+    try:
+        return int(path.read_text().strip())
+    except (OSError, ValueError):
+        return None
+
+
+def main():
+    artifacts_root = pathlib.Path(sys.argv[1])
+    out_path = pathlib.Path(sys.argv[2])
+
+    rows = {}  # (app, target) -> {config: {...}}
+    for d in sorted(artifacts_root.glob("elf-*-*-*")):
+        if not d.is_dir():
+            continue
+        parsed = parse_name(d.name)
+        if parsed is None:
+            print(f"skip unrecognized artifact: {d.name}")
+            continue
+        app, target, cfg = parsed
+
+        rc = read_int(d / "poc_rc.txt")
+        secs = read_int(d / "poc_time.txt")
+        elf = next(iter(sorted(d.rglob("app.elf"))), None)
+        text = total = None
+        if elf is not None:
+            text, total = elf_sizes(elf)
+        ok = rc == 0 and elf is not None
+        rows.setdefault((app, target), {})[cfg] = {
+            "text": text, "total": total, "secs": secs, "ok": ok,
+        }
+
+    def delta(base, val):
+        if base is None or val is None or base == 0:
+            return "N/A"
+        return f"{val - base:+d} ({(val - base) / base * 100:+.1f}%)"
+
+    def size_cell(d, key):
+        if d is None:
+            return "—"
+        if not d["ok"]:
+            return "⚠️ REGRESSION"
+        v = d.get(key)
+        return str(v) if v is not None else "N/A"
+
+    out = ["# PoC LTO — comparison", ""]
+
+    out += [
+        "## ELF size (bytes)", "",
+        "| App | Target | .text base | .text lto | .text lto-sp | Δ.text lto | Δ.text lto-sp | total base | total lto | total lto-sp |",
+        "| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |",
+    ]
+    for app, target in sorted(rows):
+        c = rows[(app, target)]
+        b, l, s = c.get("baseline"), c.get("lto"), c.get("lto-sp")
+        bt = b["text"] if b and b["ok"] else None
+        lt = l["text"] if l and l["ok"] else None
+        st = s["text"] if s and s["ok"] else None
+        out.append("| " + " | ".join([
+            app, target,
+            size_cell(b, "text"), size_cell(l, "text"), size_cell(s, "text"),
+            delta(bt, lt), delta(bt, st),
+            size_cell(b, "total"), size_cell(l, "total"), size_cell(s, "total"),
+        ]) + " |")
+
+    out += [
+        "", "## Build time (s) — indicative, runners differ across jobs", "",
+        "| App | Target | base | lto | lto-sp | Δ lto | × lto | Δ lto-sp | × lto-sp |",
+        "| --- | --- | --- | --- | --- | --- | --- | --- | --- |",
+    ]
+    for app, target in sorted(rows):
+        c = rows[(app, target)]
+        b, l, s = c.get("baseline"), c.get("lto"), c.get("lto-sp")
+        bs = b["secs"] if b else None
+
+        def tcells(x):
+            if x is None:
+                return "—", "—"
+            if not x["ok"]:
+                return "⚠️ REGRESSION", "—"
+            xs = x["secs"]
+            if bs is None or xs is None or bs == 0:
+                return "N/A", "N/A"
+            return f"{xs - bs:+d}s", f"{xs / bs:.2f}×"
+
+        dl, xl = tcells(l)
+        ds, xs_ = tcells(s)
+        out.append("| " + " | ".join([
+            app, target,
+            size_cell(b, "secs"), size_cell(l, "secs"), size_cell(s, "secs"),
+            dl, xl, ds, xs_,
+        ]) + " |")
+
+    regressions = sum(1 for c in rows.values() for d in c.values() if not d["ok"])
+    out += ["", f"**Regressions (failed builds): {regressions}**"]
+
+    text = "\n".join(out) + "\n"
+    out_path.write_text(text, encoding="utf-8")
+    print(text)
+
+
+if __name__ == "__main__":
+    main()
