Skip to content

Commit dfae8e8

Browse files
authored
Rollup merge of rust-lang#137685 - lqd:nostart-stop-gc, r=petrochenkov
self-contained linker: conservatively default to `-znostart-stop-gc` on x64 linux To help stabilization, this PR disables an LLD optimization on x64 linux with respect to `--gc-sections` and encapsulation symbols: it will reduce the number of crates needing to opt-out of lld due to this bfd / lld difference. For example, all the people using [linkme](https://github.com/dtolnay/linkme), which [doesn't work with lld](dtolnay/linkme#63) or on nightly, need to disable lld. More information about all this, and the historical differences, can be found in: - https://maskray.me/blog/2021-01-31-metadata-sections-comdat-and-shf-link-order - https://lld.llvm.org/ELF/start-stop-gc This optimization has [no visible impact](rust-lang#137685 (comment)) on our benchmarks, so we can use it by default and have a safer/more conservative starting point to remove friction during migration. We can them emit an FCW for the cases where lld detects reliance on encapsulation symbols without `-znostart-stop-gc`, and then revert back to lld's default after a while. No one compiling on nightly relies on this difference, obviously, so doing an FCW is not necessary until after lld is used on stable. I've tested that this correctly links on `linkme` examples. I've also quickly tried to crate an rmake test but the setup with encapsulation symbols is annoying to reproduce: a few link section/name attributes is not enough, we also need to collect symbols between the encapsulation symbols, without referencing them in code, for `-znostart-stop-gc` to only impact this... It should of course be doable though, maybe ````@Kobzol```` will look into it if they have time. r? ````@petrochenkov````
2 parents 0c67061 + e0b7577 commit dfae8e8

File tree

1 file changed

+29
-0
lines changed
  • compiler/rustc_codegen_ssa/src/back

1 file changed

+29
-0
lines changed

compiler/rustc_codegen_ssa/src/back/link.rs

+29
Original file line numberDiff line numberDiff line change
@@ -3382,6 +3382,35 @@ fn add_lld_args(
33823382
// this, `wasm-component-ld`, which is overridden if this option is passed.
33833383
if !sess.target.is_like_wasm {
33843384
cmd.cc_arg("-fuse-ld=lld");
3385+
3386+
// On ELF platforms like at least x64 linux, GNU ld and LLD have opposite defaults on some
3387+
// section garbage-collection features. For example, the somewhat popular `linkme` crate and
3388+
// its dependents rely in practice on this difference: when using lld, they need `-z
3389+
// nostart-stop-gc` to prevent encapsulation symbols and sections from being
3390+
// garbage-collected.
3391+
//
3392+
// More information about all this can be found in:
3393+
// - https://maskray.me/blog/2021-01-31-metadata-sections-comdat-and-shf-link-order
3394+
// - https://lld.llvm.org/ELF/start-stop-gc
3395+
//
3396+
// So when using lld, we restore, for now, the traditional behavior to help migration, but
3397+
// will remove it in the future.
3398+
// Since this only disables an optimization, it shouldn't create issues, but is in theory
3399+
// slightly suboptimal. However, it:
3400+
// - doesn't have any visible impact on our benchmarks
3401+
// - reduces the need to disable lld for the crates that depend on this
3402+
//
3403+
// Note that lld can detect some cases where this difference is relied on, and emits a
3404+
// dedicated error to add this link arg. We could make use of this error to emit an FCW. As
3405+
// of writing this, we don't do it, because lld is already enabled by default on nightly
3406+
// without this mitigation: no working project would see the FCW, so we do this to help
3407+
// stabilization.
3408+
//
3409+
// FIXME: emit an FCW if linking fails due its absence, and then remove this link-arg in the
3410+
// future.
3411+
if sess.target.llvm_target == "x86_64-unknown-linux-gnu" {
3412+
cmd.link_arg("-znostart-stop-gc");
3413+
}
33853414
}
33863415

33873416
if !flavor.is_gnu() {

0 commit comments

Comments
 (0)