headroom/crates/headroom-py/build.rs
chopratejas 17d6207bf5 fix(crusher): shim __libc_single_threaded for glibc < 2.32 + extend audit
PR #396's X2 dry-run caught a wheel-import failure on the manylinux_2_28
floor matrix entry (both x86_64 and aarch64). Same class as #355:

  ImportError: ... undefined symbol: __libc_single_threaded

`__libc_single_threaded` is a single-byte char added in glibc 2.32.
Newer libstdc++ (gcc 11+) reads it inside `__cxa_thread_atexit_impl`
to elide locking on the single-threaded fast path. ORT prebuilt static
archives compiled with gcc-14.2.1 against glibc-2.38+ headers bake in
the reference. Users with glibc < 2.32 hit ImportError on
`import headroom._core`.

Latent since the ORT artifact bump that started using gcc 14. X1 is
the gate that catches it at release time; X2 caught it at PR time —
exactly as designed.

Fix:
1. glibc_compat.c adds Section B: `char __libc_single_threaded = 0;`
   Setting to 0 (multi-threaded) is safe; libstdc++ takes the locked
   slow path. Setting to 1 would race in any multithreaded Rust wheel.
2. build.rs adds `-Wl,-u,__libc_single_threaded` so the shim's archive
   members are pulled regardless of scan order.
3. audit_wheel_glibc_symbols.py POST_FLOOR_SYMBOLS adds the new
   symbol — verified locally: the audit now rejects the failing
   PR #396 wheel with the right message.
2026-05-05 13:59:21 -07:00

77 lines
3.5 KiB
Rust

// Compile a tiny C shim that provides local definitions of glibc
// symbols introduced after the manylinux_2_28 floor that our static
// deps reference:
//
// - C23 strtol family (`__isoc23_strtol`, `__isoc23_strtoll`, ...)
// introduced in glibc 2.38 — see `glibc_compat.c` Section A.
// - `__libc_single_threaded` introduced in glibc 2.32 — see
// `glibc_compat.c` Section B (caught by X1 smoke gate on PR
// #396 X2 dry-run; latent since the ORT artifact bump).
//
// Static dependencies in `_core.so` (notably the prebuilt ONNX
// Runtime artifacts compiled with gcc 14.x) reference all of these,
// so without this shim the wheel fails to import on user machines
// whose system glibc is below the build host's. The shim is
// Linux/glibc-only — macOS, Windows, and musl don't ship glibc and
// don't reference any of these symbols.
//
// Issues:
// - #355 (https://github.com/chopratejas/headroom/issues/355)
// for the `__isoc23_*` family
// - PR #396 dry-run for the `__libc_single_threaded` symbol
fn main() {
println!("cargo:rerun-if-changed=glibc_compat.c");
println!("cargo:rerun-if-changed=build.rs");
// The shim is glibc-specific. Skip on every other target: macOS
// uses Darwin libc, Windows has MSVCRT, musl handles strtoll
// identically and never emits __isoc23_* / __libc_single_threaded.
let target_os = std::env::var("CARGO_CFG_TARGET_OS").unwrap_or_default();
let target_env = std::env::var("CARGO_CFG_TARGET_ENV").unwrap_or_default();
if target_os != "linux" || target_env != "gnu" {
return;
}
cc::Build::new()
.file("glibc_compat.c")
// -fPIC because we link into a cdylib. -O2 for size — the
// file is ~10 lines but every byte counts in a wheel that's
// already 35 MiB.
.flag_if_supported("-fPIC")
.opt_level(2)
.compile("headroom_glibc_compat");
// Force the linker to pull our shim's objects into _core.so even
// if at archive-scan time no UND `__isoc23_*` reference exists
// yet. Without this, the ORT prebuilt static archives — which
// are downloaded by ort-sys and link AFTER our shim's archive
// on aarch64 (observed in PR #386's release run) — leave the
// `__isoc23_*` references unresolved at the .so level even
// though our archive defines them. The audit then rightly
// rejects the wheel.
//
// `-u <sym>` (a.k.a. `--undefined`) tells the linker: "treat
// this symbol as undefined at the start of linking, which forces
// any archive defining it to be scanned and its members pulled
// in." Once our archive's objects are in, the shim's strong
// definitions are present in `_core.so` and ORT's later
// references resolve to them. On x86_64 the ORT archive
// happened to scan first; on aarch64 it did not, so this gate
// is the load-bearing fix that makes the shim work uniformly.
for sym in [
"__isoc23_strtol",
"__isoc23_strtoll",
"__isoc23_strtoul",
"__isoc23_strtoull",
// glibc 2.32+ — see glibc_compat.c Section B. Force-undefined
// here for the same reason as the __isoc23_* family: archives
// that DEFINE the symbol must be scanned before archives that
// REFERENCE it, otherwise our shim's archive is dropped and
// the .so ships with a UND `__libc_single_threaded` that
// breaks import on glibc < 2.32.
"__libc_single_threaded",
] {
println!("cargo:rustc-link-arg=-Wl,-u,{sym}");
}
}