Nils Andreas Svee
f08d40bfe9
Add a workflow dispatch option to run builds with various compiler flags to investigate binary size and panic behavior.
289 lines
9.5 KiB
YAML
289 lines
9.5 KiB
YAML
|
|
name: Build binaries
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
workflow_dispatch:
|
|
inputs:
|
|
build_mode:
|
|
description: "Build configuration"
|
|
type: choice
|
|
required: true
|
|
default: standard
|
|
options:
|
|
- standard
|
|
- nightly-experiments
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
env:
|
|
CARGO_TERM_COLOR: always
|
|
CARGO_PROFILE_RELEASE_STRIP: none
|
|
BUILD_MODE: ${{ inputs.build_mode || 'standard' }}
|
|
|
|
jobs:
|
|
build:
|
|
name: Build (${{ matrix.target }})
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 120
|
|
env:
|
|
TARGET: ${{ matrix.target }}
|
|
defaults:
|
|
run:
|
|
shell: bash
|
|
strategy:
|
|
fail-fast: false
|
|
max-parallel: 2
|
|
matrix:
|
|
target:
|
|
- x86_64-musl
|
|
- i686-musl
|
|
- arm-musleabi
|
|
- arm-musleabihf
|
|
- armv7-musleabi
|
|
- armv7-musleabihf
|
|
- aarch64-musl
|
|
- mips-musl
|
|
- mipsel-musl
|
|
- mips64-muslabi64
|
|
- mips64el-muslabi64
|
|
- riscv64gc-musl
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: builtin:checkout
|
|
|
|
- name: Configure Rust directories
|
|
run: |
|
|
echo "CARGO_HOME=$RUNNER_TEMP/cargo" >> "$GITHUB_ENV"
|
|
echo "RUSTUP_HOME=$RUNNER_TEMP/rustup" >> "$GITHUB_ENV"
|
|
echo "$RUNNER_TEMP/cargo/bin" >> "$GITHUB_PATH"
|
|
|
|
- name: Install Rust toolchain
|
|
uses: actions-rust-lang/setup-rust-toolchain@ecabd13d1c56bd1345c230e542e9144811ad706f # v2
|
|
with:
|
|
toolchain: ${{ (inputs.build_mode == 'nightly-experiments' || startsWith(matrix.target, 'mips')) && 'nightly' || 'stable' }}
|
|
cache: false
|
|
build-warnings: warn
|
|
|
|
- name: Install nightly standard library sources
|
|
if: inputs.build_mode == 'nightly-experiments'
|
|
run: rustup component add rust-src --toolchain nightly
|
|
|
|
- name: Install cross and binary tools
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y --no-install-recommends binutils llvm
|
|
cargo install --git https://github.com/cross-rs/cross --locked cross
|
|
echo "RUST_TARGET=${TARGET%-*}-unknown-linux-${TARGET#*-}" >> "$GITHUB_ENV"
|
|
|
|
- name: Detect statistics feature
|
|
run: |
|
|
if grep -Eq '^[[:space:]]*stats[[:space:]]*=' crates/irtt-app/Cargo.toml; then
|
|
echo "HAS_STATS_FEATURE=true" >> "$GITHUB_ENV"
|
|
else
|
|
echo "HAS_STATS_FEATURE=false" >> "$GITHUB_ENV"
|
|
fi
|
|
|
|
- name: Build, verify, package, and compare
|
|
env:
|
|
# MIPS std needs CRT objects from the cross GCC toolchain.
|
|
RUSTFLAGS: ${{ startsWith(matrix.target, 'mips') && '-C target-feature=+crt-static -C link-self-contained=no' || '-C target-feature=+crt-static' }}
|
|
CROSS_REMOTE: "true"
|
|
CROSS_REMOTE_COPY_FULL_TARGET_DIR: ${{ startsWith(matrix.target, 'mips') && 'true' || 'false' }}
|
|
run: |
|
|
set -euo pipefail
|
|
|
|
declare -A raw_size
|
|
declare -A stripped_size
|
|
declare -A compressed_size
|
|
declare -a variants
|
|
|
|
mkdir -p dist
|
|
|
|
cross_cmd=(cross)
|
|
if [[ "$BUILD_MODE" == "nightly-experiments" ]]; then
|
|
cross_cmd+=(+nightly)
|
|
fi
|
|
|
|
build_variant() {
|
|
local variant="$1"
|
|
local features="$2"
|
|
shift 2
|
|
|
|
local binary="target/${RUST_TARGET}/release/irtt-client"
|
|
local directory="dist/${variant}"
|
|
local artifact="dist/irtt-client-${TARGET}-${variant}.tar.gz"
|
|
|
|
echo "::group::Build ${variant} (${features})"
|
|
|
|
# Additional arguments allow individual variants to
|
|
# customize build-std, std features and panic behavior.
|
|
"${cross_cmd[@]}" build \
|
|
--release \
|
|
--locked \
|
|
--target "$RUST_TARGET" \
|
|
-p irtt-rs \
|
|
--bin irtt-client \
|
|
--no-default-features \
|
|
--features "$features" \
|
|
"$@"
|
|
|
|
# Check dynamic linking without relying on pipeline
|
|
# behavior under pipefail.
|
|
readelf --program-headers "$binary" > /tmp/program-headers.txt
|
|
readelf --dynamic "$binary" > /tmp/dynamic-section.txt
|
|
|
|
if grep -q INTERP /tmp/program-headers.txt ||
|
|
grep -q NEEDED /tmp/dynamic-section.txt; then
|
|
echo "Binary is not statically linked: ${variant}" >&2
|
|
exit 1
|
|
fi
|
|
|
|
mkdir -p "$directory"
|
|
cp "$binary" "$directory/irtt-client"
|
|
|
|
raw_size[$variant]=$(stat -c %s "$binary")
|
|
|
|
llvm-strip --strip-all "$directory/irtt-client"
|
|
stripped_size[$variant]=$(
|
|
stat -c %s "$directory/irtt-client"
|
|
)
|
|
|
|
tar -czf "$artifact" -C "$directory" irtt-client
|
|
compressed_size[$variant]=$(stat -c %s "$artifact")
|
|
|
|
variants+=("$variant")
|
|
|
|
echo "::endgroup::"
|
|
}
|
|
|
|
human() {
|
|
numfmt --to=iec-i --suffix=B --format='%.1f' "$1"
|
|
}
|
|
|
|
# Positive means larger than baseline; negative means smaller.
|
|
delta() {
|
|
awk -v base="$1" -v current="$2" 'BEGIN {
|
|
if (base == 0) {
|
|
printf "N/A"
|
|
} else {
|
|
printf "%+.1f%%", 100 * (current - base) / base
|
|
}
|
|
}'
|
|
}
|
|
|
|
reduction() {
|
|
awk -v full="$1" -v minimal="$2" 'BEGIN {
|
|
if (full == 0) {
|
|
printf "N/A"
|
|
} else {
|
|
printf "%.1f%%", 100 * (full - minimal) / full
|
|
}
|
|
}'
|
|
}
|
|
|
|
# Standard builds preserve the existing toolchain policy:
|
|
# stable everywhere except MIPS, which requires nightly.
|
|
#
|
|
# Experimental mode uses nightly for every variant so
|
|
# compiler-version differences don't affect comparisons.
|
|
|
|
if [[ "$HAS_STATS_FEATURE" == "true" ]]; then
|
|
build_variant full "client,stats"
|
|
build_variant minimal "client"
|
|
baseline="minimal"
|
|
else
|
|
# Compatibility with main before stats feature gating.
|
|
build_variant full "client"
|
|
baseline="full"
|
|
fi
|
|
|
|
if [[ "$BUILD_MODE" == "nightly-experiments" ]]; then
|
|
# Existing Cross.toml already rebuilds std on MIPS.
|
|
# On other targets, the normal builds use prebuilt std.
|
|
|
|
build_variant rebuilt-std "client" \
|
|
-Z build-std
|
|
|
|
# Rebuild std without backtrace support, retaining
|
|
# normal panic unwinding.
|
|
build_variant no-backtrace "client" \
|
|
-Z build-std \
|
|
-Z build-std-features=panic-unwind
|
|
|
|
# Most aggressive experiment: no unwinding, panic
|
|
# reporting, or std backtrace support.
|
|
build_variant immediate-abort "client" \
|
|
-Z panic-immediate-abort \
|
|
-Z build-std \
|
|
-Z build-std-features= \
|
|
--config 'profile.release.panic="immediate-abort"'
|
|
fi
|
|
|
|
{
|
|
echo "### irtt-client: ${TARGET}"
|
|
echo
|
|
echo "Build mode: \`${BUILD_MODE}\`"
|
|
echo
|
|
echo '| Variant | Unstripped | Stripped | Compressed | Compressed vs baseline |'
|
|
echo '|:--|--:|--:|--:|--:|'
|
|
|
|
for variant in "${variants[@]}"; do
|
|
if [[ "$variant" == "$baseline" ]]; then
|
|
comparison="Baseline"
|
|
else
|
|
comparison=$(delta \
|
|
"${compressed_size[$baseline]}" \
|
|
"${compressed_size[$variant]}")
|
|
fi
|
|
|
|
printf '| %s | %s | %s | %s | %s |\n' \
|
|
"$variant" \
|
|
"$(human "${raw_size[$variant]}")" \
|
|
"$(human "${stripped_size[$variant]}")" \
|
|
"$(human "${compressed_size[$variant]}")" \
|
|
"$comparison"
|
|
done
|
|
|
|
if [[ "$HAS_STATS_FEATURE" == "true" ]]; then
|
|
echo
|
|
echo '#### Full vs minimal'
|
|
echo
|
|
echo '| Unstripped reduction | Stripped reduction | Compressed reduction |'
|
|
echo '|--:|--:|--:|'
|
|
|
|
printf '| %s | %s | %s |\n' \
|
|
"$(reduction "${raw_size[full]}" "${raw_size[minimal]}")" \
|
|
"$(reduction "${stripped_size[full]}" "${stripped_size[minimal]}")" \
|
|
"$(reduction "${compressed_size[full]}" "${compressed_size[minimal]}")"
|
|
else
|
|
echo
|
|
echo "The stats feature is not available; client includes statistics."
|
|
fi
|
|
|
|
if [[ "$BUILD_MODE" == "nightly-experiments" ]]; then
|
|
echo
|
|
echo '#### Experiment details'
|
|
echo
|
|
echo '- `rebuilt-std`: nightly `-Z build-std`, default std features'
|
|
echo '- `no-backtrace`: rebuilt std with `panic-unwind` only'
|
|
echo '- `immediate-abort`: rebuilt std with immediate panic termination'
|
|
echo
|
|
echo 'MIPS already uses build-std through Cross.toml.'
|
|
echo 'All measurements use the same target and nightly toolchain.'
|
|
fi
|
|
} >> "$GITHUB_STEP_SUMMARY"
|
|
|
|
- name: Upload binaries
|
|
# Gitea's v3 artifact protocol.
|
|
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
|
with:
|
|
name: irtt-client-${{ matrix.target }}
|
|
path: dist/irtt-client-${{ matrix.target }}-*.tar.gz
|
|
if-no-files-found: error
|