Skip to content

fix: build linux gnu binaries against glibc 2.17 #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dsherret merged 1 commit into from
Jul 15, 2026
Merged

fix: build linux gnu binaries against glibc 2.17 #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 70 additions & 12 deletions .github/workflows/ci.generated.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,76 +25,121 @@ jobs:
target: x86_64-apple-darwin
cross: 'false'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: x86_64-apple-darwin
- os: macos-latest
run_tests: 'true'
target: aarch64-apple-darwin
cross: 'false'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: aarch64-apple-darwin
- os: windows-latest
run_tests: 'true'
target: x86_64-pc-windows-msvc
cross: 'false'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: x86_64-pc-windows-msvc
- os: windows-latest
run_tests: 'false'
target: aarch64-pc-windows-msvc
cross: 'false'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: aarch64-pc-windows-msvc
- os: ubuntu-22.04
run_tests: 'true'
target: x86_64-unknown-linux-gnu
cross: 'false'
musl_image: ''
zigbuild_glibc: '2.17'
cargo: cargo-zigbuild
cargo_target: x86_64-unknown-linux-gnu.2.17
- os: ubuntu-22.04
run_tests: 'false'
target: x86_64-unknown-linux-musl
cross: 'false'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: x86_64-unknown-linux-musl
- os: ubuntu-22.04
run_tests: 'false'
target: aarch64-unknown-linux-gnu
cross: 'false'
musl_image: ''
zigbuild_glibc: '2.17'
cargo: cargo-zigbuild
cargo_target: aarch64-unknown-linux-gnu.2.17
- os: ubuntu-22.04
run_tests: 'false'
target: aarch64-unknown-linux-musl
cross: 'false'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: aarch64-unknown-linux-musl
- os: ubuntu-22.04
run_tests: 'false'
target: riscv64gc-unknown-linux-gnu
cross: 'true'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: riscv64gc-unknown-linux-gnu
- os: ubuntu-22.04
run_tests: 'false'
target: loongarch64-unknown-linux-gnu
cross: 'true'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: loongarch64-unknown-linux-gnu
- os: ubuntu-22.04
run_tests: 'false'
target: loongarch64-unknown-linux-musl
cross: 'true'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: loongarch64-unknown-linux-musl
- os: ubuntu-22.04
run_tests: 'false'
target: powerpc64le-unknown-linux-gnu
cross: 'true'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: powerpc64le-unknown-linux-gnu
- os: ubuntu-22.04
run_tests: 'false'
target: powerpc64le-unknown-linux-musl
cross: 'false'
musl_image: 'ghcr.io/rust-cross/rust-musl-cross:powerpc64le-musl'
zigbuild_glibc: ''
cargo: cargo
cargo_target: powerpc64le-unknown-linux-musl
- os: ubuntu-22.04
run_tests: 'false'
target: aarch64-linux-android
cross: 'true'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: aarch64-linux-android
- os: ubuntu-22.04
run_tests: 'false'
target: x86_64-linux-android
cross: 'true'
musl_image: ''
zigbuild_glibc: ''
cargo: cargo
cargo_target: x86_64-linux-android
env:
CARGO_INCREMENTAL: 0
RUST_BACKTRACE: full
Expand Down Expand Up @@ -135,10 +180,7 @@ jobs:
rustup target add x86_64-unknown-linux-musl
- name: Setup (Linux aarch64)
if: matrix.config.target == 'aarch64-unknown-linux-gnu'
run: |-
sudo apt update
sudo apt install -y gcc-aarch64-linux-gnu
rustup target add aarch64-unknown-linux-gnu
run: rustup target add aarch64-unknown-linux-gnu
- name: Setup (Linux aarch64-musl)
if: matrix.config.target == 'aarch64-unknown-linux-musl'
run: |-
Expand All @@ -151,16 +193,26 @@ jobs:
- name: Setup cross
if: matrix.config.cross == 'true'
run: 'cargo install cross --git https://github.com/cross-rs/cross --rev 4090beca3cfffa44371a5bba524de3a578aa46c3'
- name: Setup zig
uses: mlugg/setup-zig@d1434d08867e3ee9daa34448df10607b98908d29 # v2
if: matrix.config.zigbuild_glibc != ''
with:
version: 0.15.1
- name: Setup cargo-zigbuild
if: matrix.config.zigbuild_glibc != ''
run: cargo install cargo-zigbuild --locked --version 0.23.0
- name: Build (Debug)
if: 'matrix.config.cross != ''true'' && matrix.config.musl_image == '''' && !startsWith(github.ref, ''refs/tags/'')'
env:
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
run: 'cargo build --locked --all-targets --target ${{matrix.config.target}}'
run: '${{matrix.config.cargo}} build --locked --all-targets --target ${{matrix.config.cargo_target}}'
- name: Check glibc requirement (Debug)
if: 'matrix.config.zigbuild_glibc != '''' && !startsWith(github.ref, ''refs/tags/'')'
run: |-
max_glibc=$(readelf -W --dyn-syms target/${{ matrix.config.target }}/debug/dprint-plugin-exec | grep -oE 'GLIBC_[0-9]+\.[0-9]+' | sed 's/GLIBC_//' | sort -uV | tail -1)
echo "Binary requires glibc $max_glibc (max allowed: ${{ matrix.config.zigbuild_glibc }})"
test "$(printf '%s\n%s\n' "$max_glibc" "${{ matrix.config.zigbuild_glibc }}" | sort -V | tail -1)" = "${{ matrix.config.zigbuild_glibc }}"
- name: Build release
if: 'matrix.config.cross != ''true'' && matrix.config.musl_image == '''' && startsWith(github.ref, ''refs/tags/'')'
env:
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
run: 'cargo build --locked --all-targets --target ${{matrix.config.target}} --release'
run: '${{matrix.config.cargo}} build --locked --all-targets --target ${{matrix.config.cargo_target}} --release'
- name: Build cross (Debug)
if: 'matrix.config.cross == ''true'' && !startsWith(github.ref, ''refs/tags/'')'
run: 'cross build --locked --target ${{matrix.config.target}}'
Expand All @@ -187,10 +239,16 @@ jobs:
./.github/workflows/release.ts --lint
- name: Test (Debug)
if: 'matrix.config.run_tests == ''true'' && !startsWith(github.ref, ''refs/tags/'')'
run: cargo test --locked --all-features
run: '${{matrix.config.cargo}} test --locked --target ${{matrix.config.cargo_target}} --all-features'
- name: Test (Release)
if: 'matrix.config.run_tests == ''true'' && startsWith(github.ref, ''refs/tags/'')'
run: cargo test --locked --all-features --release
run: '${{matrix.config.cargo}} test --locked --target ${{matrix.config.cargo_target}} --all-features --release'
- name: Check glibc requirement (Release)
if: 'matrix.config.zigbuild_glibc != '''' && startsWith(github.ref, ''refs/tags/'')'
run: |-
max_glibc=$(readelf -W --dyn-syms target/${{ matrix.config.target }}/release/dprint-plugin-exec | grep -oE 'GLIBC_[0-9]+\.[0-9]+' | sed 's/GLIBC_//' | sort -uV | tail -1)
echo "Binary requires glibc $max_glibc (max allowed: ${{ matrix.config.zigbuild_glibc }})"
test "$(printf '%s\n%s\n' "$max_glibc" "${{ matrix.config.zigbuild_glibc }}" | sort -V | tail -1)" = "${{ matrix.config.zigbuild_glibc }}"
- name: Pre-release (x86_64-apple-darwin)
id: pre_release_x86_64_apple_darwin
if: 'matrix.config.target == ''x86_64-apple-darwin'' && startsWith(github.ref, ''refs/tags/'')'
Expand Down
72 changes: 57 additions & 15 deletions .github/workflows/ci.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ interface ProfileData {
* already bundles the toolchain.
*/
muslCrossImage?: string;
/**
* Build the release binary with cargo-zigbuild targeting this glibc version
* so the published binary runs on older distros regardless of the runner's
* glibc (dprint/dprint#796).
*/
zigbuildGlibc?: string;
}

const profileDataItems: ProfileData[] = [{
Expand All @@ -42,12 +48,15 @@ const profileDataItems: ProfileData[] = [{
os: OperatingSystem.Linux,
target: "x86_64-unknown-linux-gnu",
runTests: true,
// glibc 2.17 matches Rust's own minimum for this target (CentOS 7+)
zigbuildGlibc: "2.17",
}, {
os: OperatingSystem.Linux,
target: "x86_64-unknown-linux-musl",
}, {
os: OperatingSystem.Linux,
target: "aarch64-unknown-linux-gnu",
zigbuildGlibc: "2.17",
}, {
os: OperatingSystem.Linux,
target: "aarch64-unknown-linux-musl",
Expand Down Expand Up @@ -102,6 +111,11 @@ const matrix = defineMatrix({
target: profile.target,
cross: (profile.cross ?? false).toString(),
musl_image: profile.muslCrossImage ?? "",
zigbuild_glibc: profile.zigbuildGlibc ?? "",
// build and test through cargo-zigbuild for zigbuild targets so the test
// suite links (and runs) binaries the same way as the published ones
cargo: profile.zigbuildGlibc != null ? "cargo-zigbuild" : "cargo",
cargo_target: profile.zigbuildGlibc != null ? `${profile.target}.${profile.zigbuildGlibc}` : profile.target,
})),
});

Expand All @@ -117,6 +131,20 @@ const isCross = cross.equals("true");
const isNotCross = cross.notEquals("true");
const isMuslImage = muslImage.notEquals("");
const isNotMuslImage = muslImage.equals("");
const zigbuildGlibc = expr("matrix.config.zigbuild_glibc");
const isZigbuild = zigbuildGlibc.notEquals("");

// Verifies the binary only requires symbols up to the targeted glibc version
// so a too-new requirement never makes it into a release (dprint/dprint#796).
// readelf is used instead of objdump because it works on foreign-arch ELF
// files (the aarch64 binary is checked on the x86_64 runner).
function glibcCheckRun(profileDir: "debug" | "release"): string[] {
return [
`max_glibc=$(readelf -W --dyn-syms target/${target}/${profileDir}/dprint-plugin-exec | grep -oE 'GLIBC_[0-9]+\\.[0-9]+' | sed 's/GLIBC_//' | sort -uV | tail -1)`,
`echo "Binary requires glibc $max_glibc (max allowed: ${zigbuildGlibc})"`,
`test "$(printf '%s\\n%s\\n' "$max_glibc" "${zigbuildGlibc}" | sort -V | tail -1)" = "${zigbuildGlibc}"`,
];
}

const preReleaseSteps = profiles.map((profile) => {
function getRunSteps() {
Expand Down Expand Up @@ -187,13 +215,10 @@ const buildJob = job("build", {
],
},
{
// no cross gcc needed -- zigbuild provides the cross linker
name: "Setup (Linux aarch64)",
if: target.equals("aarch64-unknown-linux-gnu"),
run: [
"sudo apt update",
"sudo apt install -y gcc-aarch64-linux-gnu",
"rustup target add aarch64-unknown-linux-gnu",
],
run: ["rustup target add aarch64-unknown-linux-gnu"],
},
{
name: "Setup (Linux aarch64-musl)",
Expand All @@ -215,21 +240,31 @@ const buildJob = job("build", {
run:
"cargo install cross --git https://github.com/cross-rs/cross --rev 4090beca3cfffa44371a5bba524de3a578aa46c3",
},
{
name: "Setup zig",
if: isZigbuild,
uses: "mlugg/setup-zig@v2",
with: { version: "0.15.1" },
},
{
name: "Setup cargo-zigbuild",
if: isZigbuild,
run: "cargo install cargo-zigbuild --locked --version 0.23.0",
},
{
name: "Build (Debug)",
if: isNotCross.and(isNotMuslImage).and(isNotTag),
env: {
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: "aarch64-linux-gnu-gcc",
},
run: "cargo build --locked --all-targets --target ${{matrix.config.target}}",
run: "${{matrix.config.cargo}} build --locked --all-targets --target ${{matrix.config.cargo_target}}",
},
{
name: "Check glibc requirement (Debug)",
if: isZigbuild.and(isNotTag),
run: glibcCheckRun("debug"),
},
{
name: "Build release",
if: isNotCross.and(isNotMuslImage).and(isTag),
env: {
CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: "aarch64-linux-gnu-gcc",
},
run: "cargo build --locked --all-targets --target ${{matrix.config.target}} --release",
run: "${{matrix.config.cargo}} build --locked --all-targets --target ${{matrix.config.cargo_target}} --release",
},
{
name: "Build cross (Debug)",
Expand Down Expand Up @@ -280,12 +315,19 @@ const buildJob = job("build", {
{
name: "Test (Debug)",
if: runTests.equals("true").and(isNotTag),
run: "cargo test --locked --all-features",
run: "${{matrix.config.cargo}} test --locked --target ${{matrix.config.cargo_target}} --all-features",
},
{
name: "Test (Release)",
if: runTests.equals("true").and(isTag),
run: "cargo test --locked --all-features --release",
run: "${{matrix.config.cargo}} test --locked --target ${{matrix.config.cargo_target}} --all-features --release",
},
{
// runs after the tests so this checks the exact binary that gets zipped,
// even if a test step rebuilds it
name: "Check glibc requirement (Release)",
if: isZigbuild.and(isTag),
run: glibcCheckRun("release"),
},
...preReleaseSteps,
...profiles.map((profile) => ({
Expand Down
Loading