Auto merge of #141750 - Noratrieb:gold-rush, r=<try>

Warn when gold was used as the linker

gold has been deprecated recently and is known to behave incorrectly around Rust programs, including miscompiling `#[used(linker)]`. Tell people to switch to a different linker instead.

closes #141748

opening mostly for perf for now, but feel free to review

r? bjorn3

Author: bors

compiler/rustc_codegen_ssa/src/back/link.rs

@@ -184,6 +184,12 @@ pub fn link_binary(
                 );
             }
 
+            if sess.target.binary_format == BinaryFormat::Elf {
+                if let Err(err) = warn_if_linked_with_gold(sess, &out_filename) {
+                    info!(?err, "Error while checking if gold was the linker");
+                }
+            }
+
             if output.is_stdout() {
                 if output.is_tty() {
                     sess.dcx().emit_err(errors::BinaryOutputToTty {
@@ -3425,3 +3431,59 @@ fn add_lld_args(
         }
     }
 }
+
+// gold has been deprecated with binutils 2.44
+// and is known to behave incorrectly around Rust programs.
+// There have been reports of being unable to bootstrap with gold:
+// https://github.com/rust-lang/rust/issues/139425
+// Additionally, gold miscompiles SHF_GNU_RETAIN sections, which are
+// emitted with `#[used(linker)]`.
+fn warn_if_linked_with_gold(sess: &Session, path: &Path) -> Result<(), Box<dyn std::error::Error>> {
+    use object::elf;
+    use object::read::elf::FileHeader;
+
+    let data = std::fs::read(path)?;
+
+    let was_linked_with_gold = if sess.target.pointer_width == 64 {
+        let elf = elf::FileHeader64::<object::Endianness>::parse(&*data)?;
+        elf_has_gold_version_note(elf, &data)
+    } else if sess.target.pointer_width == 32 {
+        let elf = elf::FileHeader32::<object::Endianness>::parse(&*data)?;
+        elf_has_gold_version_note(elf, &data)
+    } else {
+        return Ok(());
+    };
+
+    match was_linked_with_gold {
+        Ok(true) => {
+            let mut warn = sess
+                .dcx()
+                .struct_warn("the gold linker is deprecated and has known bugs with Rust");
+            warn.help("consider using LLD or ld from GNU binutils instead");
+            warn.emit();
+        }
+        Ok(false) => {}
+        Err(err) => info!(?err, "Error while trying to detect whether binary was linked with gold"),
+    }
+    Ok(())
+}
+
+fn elf_has_gold_version_note(
+    elf: &impl object::read::elf::FileHeader,
+    data: &[u8],
+) -> Result<bool, Box<dyn std::error::Error>> {
+    use object::read::elf::SectionHeader;
+
+    let endian = elf.endian()?;
+
+    let section = elf.sections(endian, data)?.section_by_name(endian, b".note.gnu.gold-version");
+    if let Some((_, section)) = section {
+        if let Some(mut notes) = section.notes(endian, data)? {
+            return Ok(notes.any(|note| {
+                note.is_ok_and(|note| note.n_type(endian) == object::elf::NT_GNU_GOLD_VERSION)
+            }));
+        }
+    }
+
+    Ok(false)
+}