run_make_support nm implementation + bin-emit-no-symbols rmake rewrite

Author: Oneirical

Cargo.lock

@@ -3255,6 +3255,7 @@ name = "run_make_support"
 version = "0.0.0"
 dependencies = [
  "gimli 0.28.1",
+ "goblin 0.8.2",
  "object 0.34.0",
  "regex",
  "similar",

src/tools/run-make-support/Cargo.toml

@@ -9,3 +9,4 @@ similar = "2.5.0"
 wasmparser = "0.118.2"
 regex = "1.8" # 1.8 to avoid memchr 2.6.0, as 2.5.0 is pinned in the workspace
 gimli = "0.28.1"
+goblin = "0.8.2"

src/tools/run-make-support/nm/mod.rs

@@ -0,0 +1,55 @@
+use goblin::elf::Elf32;
+use goblin::elf::Elf64;
+use goblin::elf::SectionHeader;
+use std::fs::File as StdFile;
+
+#[derive(Debug)]
+struct Nm {
+    file: Option<File>,
+}
+
+pub fn nm() -> Nm {
+    Nm::new()
+}
+
+impl Nm {
+    /// Construct a bare `nm` invocation.
+    pub fn new() -> Self {
+        Self {
+            file: None,
+        }
+    }
+
+    /// Specify the file to analyze the symbols of.
+    pub fn input<P: AsRef<Path>>(&mut self, path: P) -> &mut Self {
+        Self {
+            file: File::open(&path).expect(format!("Failed to open the ELF file at {:?}", &path.display()))
+        }
+    }
+
+    pub fn collect_symbols(&self) -> String {
+        // Determine whether the file is 32-bit or 64-bit
+        // by fetching the target's configuration
+        let mut elf = if cfg!(target_pointer_width = 64) {
+            Elf64::new(self.file)
+        } else if cfg!(target_pointer_width = 32) {
+            Elf32::new(self.file)
+        } else {
+            panic!("Unsupported architecture detected, should be 32 or 64 bits.")
+        };
+
+        let mut all_symbol_names = String::new();
+
+        let symtab_section_index = elf.section_headers()
+            .iter()
+            .position(|sh| sh.sh_type == SectionHeader::SHT_SYMTAB)
+            .expect("Symbol table section not found");
+
+        for symbol in elf.symbol_table(symtab_section_index).symbols() {
+            all_symbol_names.push_str(&symbol.name.to_string_lossy().into_owned());
+            all_symbol_names.push('\n');
+        }
+
+        all_symbol_names
+    }
+}

src/tools/run-make-support/src/lib.rs

@@ -7,6 +7,7 @@ pub mod cc;
 pub mod clang;
 pub mod diff;
 pub mod llvm_readobj;
+pub mod nm;
 pub mod run;
 pub mod rustc;
 pub mod rustdoc;
@@ -18,13 +19,15 @@ use std::path::{Path, PathBuf};
 use std::process::{Command, Output};
 
 pub use gimli;
+pub use goblin;
 pub use object;
 pub use regex;
 pub use wasmparser;
 
 pub use cc::{cc, extra_c_flags, extra_cxx_flags, Cc};
 pub use clang::{clang, Clang};
 pub use diff::{diff, Diff};
+pub use nm::{nm, Nm};
 pub use llvm_readobj::{llvm_readobj, LlvmReadobj};
 pub use run::{run, run_fail};
 pub use rustc::{aux_build, rustc, Rustc};

src/tools/tidy/src/allowed_run_make_makefiles.txt

@@ -103,7 +103,6 @@ run-make/issue-37839/Makefile
 run-make/issue-40535/Makefile
 run-make/issue-47384/Makefile
 run-make/issue-47551/Makefile
-run-make/issue-51671/Makefile
 run-make/issue-64153/Makefile
 run-make/issue-68794-textrel-on-minimal-lib/Makefile
 run-make/issue-69368/Makefile

tests/run-make/issue-51671/app.rs tests/run-make/bin-emit-no-symbols/app.rs

@@ -0,0 +1,19 @@
+// When setting the crate type as a "bin" (in app.rs),
+// this could cause a bug where some symbols would not be
+// emitted in the object files. This has been fixed, and
+// this test checks that the correct symbols have been successfully
+// emitted inside the object files.
+// See https://github.com/rust-lang/rust/issues/51671
+
+use run_make_support::{nm, rustc, tmp_dir};
+
+fn main() {
+    rustc().emit("obj").input("app.rs").run();
+    //FIXME(Oneirical): This should eventually be tmp_path
+    let nm = nm(tmp_dir().join("app.o"));
+    assert!(
+        nm.contains("rust_begin_unwind")
+        && nm.contains("rust_eh_personality")
+        && nm.contains("__rg_oom")
+    );
+}