[bootstrap] Distribute split debuginfo if present

If debuginfo has been requested in `config.toml`, it should be packaged
alongside the appropriate binary when running `x.py dist`.

Currently, this is only implemented for msvc environments where split
debuginfo is (basically) the only option. I've tested that this
correctly packages the `.pdb` for each binary in the various dist
packages.

Author: wesleywiser

src/bootstrap/src/core/build_steps/compile.rs

@@ -334,7 +334,7 @@ fn copy_llvm_libunwind(builder: &Builder<'_>, target: TargetSelection, libdir: &
     let libunwind_path = builder.ensure(llvm::Libunwind { target });
     let libunwind_source = libunwind_path.join("libunwind.a");
     let libunwind_target = libdir.join("libunwind.a");
-    builder.copy_link(&libunwind_source, &libunwind_target);
+    builder.copy_link_binary(&libunwind_source, &libunwind_target, target);
     libunwind_target
 }
 
@@ -403,9 +403,9 @@ fn copy_self_contained_objects(
         let crt_path = builder.ensure(llvm::CrtBeginEnd { target });
         for &obj in &["crtbegin.o", "crtbeginS.o", "crtend.o", "crtendS.o"] {
             let src = crt_path.join(obj);
-            let target = libdir_self_contained.join(obj);
-            builder.copy_link(&src, &target);
-            target_deps.push((target, DependencyType::TargetSelfContained));
+            let dst = libdir_self_contained.join(obj);
+            builder.copy_link_binary(&src, &dst, target);
+            target_deps.push((dst, DependencyType::TargetSelfContained));
         }
 
         if !target.starts_with("s390x") {
@@ -433,9 +433,9 @@ fn copy_self_contained_objects(
     } else if target.is_windows_gnu() {
         for obj in ["crt2.o", "dllcrt2.o"].iter() {
             let src = compiler_file(builder, &builder.cc(target), target, CLang::C, obj);
-            let target = libdir_self_contained.join(obj);
-            builder.copy_link(&src, &target);
-            target_deps.push((target, DependencyType::TargetSelfContained));
+            let dst = libdir_self_contained.join(obj);
+            builder.copy_link_binary(&src, &dst, target);
+            target_deps.push((dst, DependencyType::TargetSelfContained));
         }
     }
 
@@ -819,7 +819,7 @@ fn copy_sanitizers(
 
     for runtime in &runtimes {
         let dst = libdir.join(&runtime.name);
-        builder.copy_link(&runtime.path, &dst);
+        builder.copy_link_binary(&runtime.path, &dst, target);
 
         // The `aarch64-apple-ios-macabi` and `x86_64-apple-ios-macabi` are also supported for
         // sanitizers, but they share a sanitizer runtime with `${arch}-apple-darwin`, so we do
@@ -924,9 +924,9 @@ impl Step for StartupObjects {
                     .run(builder);
             }
 
-            let target = sysroot_dir.join((*file).to_string() + ".o");
-            builder.copy_link(dst_file, &target);
-            target_deps.push((target, DependencyType::Target));
+            let obj = sysroot_dir.join((*file).to_string() + ".o");
+            builder.copy_link_binary(dst_file, &obj, target);
+            target_deps.push((obj, DependencyType::Target));
         }
 
         target_deps
@@ -1697,7 +1697,7 @@ fn copy_codegen_backends_to_sysroot(
             let dot = filename.find('.').unwrap();
             format!("{}-{}{}", &filename[..dash], builder.rust_release(), &filename[dot..])
         };
-        builder.copy_link(file, &dst.join(target_filename));
+        builder.copy_link_binary(file, &dst.join(target_filename), target);
     }
 }
 
@@ -2001,7 +2001,11 @@ impl Step for Assemble {
                         extra_features: vec![],
                     });
                 let tool_exe = exe("llvm-bitcode-linker", target_compiler.host);
-                builder.copy_link(&llvm_bitcode_linker.tool_path, &libdir_bin.join(tool_exe));
+                builder.copy_link_binary(
+                    &llvm_bitcode_linker.tool_path,
+                    &libdir_bin.join(tool_exe),
+                    target_compiler.host,
+                );
             }
         };
 
@@ -2062,8 +2066,8 @@ impl Step for Assemble {
                 builder.sysroot_target_libdir(target_compiler, target_compiler.host);
             let dst_lib = libdir.join(&libenzyme).with_extension(lib_ext);
             let target_dst_lib = target_libdir.join(&libenzyme).with_extension(lib_ext);
-            builder.copy_link(&src_lib, &dst_lib);
-            builder.copy_link(&src_lib, &target_dst_lib);
+            builder.copy_link_binary(&src_lib, &dst_lib, build_compiler.host);
+            builder.copy_link_binary(&src_lib, &target_dst_lib, build_compiler.host);
         }
 
         // Build the libraries for this compiler to link to (i.e., the libraries
@@ -2186,7 +2190,11 @@ impl Step for Assemble {
             // See <https://github.com/rust-lang/rust/issues/132719>.
             let src_exe = exe("llvm-objcopy", target_compiler.host);
             let dst_exe = exe("rust-objcopy", target_compiler.host);
-            builder.copy_link(&libdir_bin.join(src_exe), &libdir_bin.join(dst_exe));
+            builder.copy_link_binary(
+                &libdir_bin.join(src_exe),
+                &libdir_bin.join(dst_exe),
+                target_compiler.host,
+            );
         }
 
         // In addition to `rust-lld` also install `wasm-component-ld` when
@@ -2199,9 +2207,10 @@ impl Step for Assemble {
                 compiler: build_compiler,
                 target: target_compiler.host,
             });
-            builder.copy_link(
+            builder.copy_link_binary(
                 &wasm_component.tool_path,
                 &libdir_bin.join(wasm_component.tool_path.file_name().unwrap()),
+                target_compiler.host,
             );
         }
 

src/bootstrap/src/core/build_steps/dist.rs

@@ -32,7 +32,7 @@ use crate::utils::helpers::{
     exe, is_dylib, move_file, t, target_supports_cranelift_backend, timeit,
 };
 use crate::utils::tarball::{GeneratedTarball, OverlayKind, Tarball};
-use crate::{Compiler, DependencyType, LLVM_TOOLS, Mode, trace};
+use crate::{Compiler, DependencyType, LLVM_TOOLS, Mode, split_debuginfo, trace};
 
 pub fn pkgname(builder: &Builder<'_>, component: &str) -> String {
     format!("{}-{}", component, builder.rust_package_vers())
@@ -53,6 +53,22 @@ fn should_build_extended_tool(builder: &Builder<'_>, tool: &str) -> bool {
     builder.config.tools.as_ref().is_none_or(|tools| tools.contains(tool))
 }
 
+/// Add a binary file to the tarball with the appropriate permissions set.
+/// If split debuginfo for the binary is present, it is also added to the tarball.
+fn tarball_add_binary(
+    tarball: &Tarball<'_>,
+    binary: &Path,
+    dst: impl AsRef<Path>,
+    target: TargetSelection,
+) {
+    let dst = dst.as_ref();
+    tarball.add_file(binary, dst, 0o755);
+
+    if let Some(debuginfo) = split_debuginfo(binary, target) {
+        tarball.add_file(debuginfo, dst, 0o644);
+    }
+}
+
 #[derive(Debug, PartialOrd, Ord, Clone, Hash, PartialEq, Eq)]
 pub struct Docs {
     pub host: TargetSelection,
@@ -432,7 +448,14 @@ impl Step for Rustc {
                 },
                 builder.kind,
             ) {
-                builder.install(&ra_proc_macro_srv.tool_path, &image.join("libexec"), 0o755);
+                let dst = image.join("libexec");
+                builder.install(&ra_proc_macro_srv.tool_path, &dst, 0o755);
+
+                if let Some(debuginfo) =
+                    split_debuginfo(&ra_proc_macro_srv.tool_path, compiler.host)
+                {
+                    builder.install(&debuginfo, &dst, 0o644);
+                }
             }
 
             let libdir_relative = builder.libdir_relative(compiler);
@@ -463,15 +486,20 @@ impl Step for Rustc {
             if builder.config.lld_enabled {
                 let src_dir = builder.sysroot_target_bindir(compiler, host);
                 let rust_lld = exe("rust-lld", compiler.host);
-                builder.copy_link(&src_dir.join(&rust_lld), &dst_dir.join(&rust_lld));
+                builder.copy_link_binary(
+                    &src_dir.join(&rust_lld),
+                    &dst_dir.join(&rust_lld),
+                    compiler.host,
+                );
                 let self_contained_lld_src_dir = src_dir.join("gcc-ld");
                 let self_contained_lld_dst_dir = dst_dir.join("gcc-ld");
                 t!(fs::create_dir(&self_contained_lld_dst_dir));
                 for name in crate::LLD_FILE_NAMES {
                     let exe_name = exe(name, compiler.host);
-                    builder.copy_link(
+                    builder.copy_link_binary(
                         &self_contained_lld_src_dir.join(&exe_name),
                         &self_contained_lld_dst_dir.join(&exe_name),
+                        host,
                     );
                 }
             }
@@ -480,13 +508,17 @@ impl Step for Rustc {
                 let src_dir = builder.sysroot_target_bindir(compiler, host);
                 let llvm_objcopy = exe("llvm-objcopy", compiler.host);
                 let rust_objcopy = exe("rust-objcopy", compiler.host);
-                builder.copy_link(&src_dir.join(&llvm_objcopy), &dst_dir.join(&rust_objcopy));
+                builder.copy_link_binary(
+                    &src_dir.join(&llvm_objcopy),
+                    &dst_dir.join(&rust_objcopy),
+                    host,
+                );
             }
 
             if builder.tool_enabled("wasm-component-ld") {
                 let src_dir = builder.sysroot_target_bindir(compiler, host);
                 let ld = exe("wasm-component-ld", compiler.host);
-                builder.copy_link(&src_dir.join(&ld), &dst_dir.join(&ld));
+                builder.copy_link_binary(&src_dir.join(&ld), &dst_dir.join(&ld), host);
             }
 
             // Man pages
@@ -640,9 +672,13 @@ fn copy_target_libs(
     t!(fs::create_dir_all(&self_contained_dst));
     for (path, dependency_type) in builder.read_stamp_file(stamp) {
         if dependency_type == DependencyType::TargetSelfContained {
-            builder.copy_link(&path, &self_contained_dst.join(path.file_name().unwrap()));
+            builder.copy_link_binary(
+                &path,
+                &self_contained_dst.join(path.file_name().unwrap()),
+                target,
+            );
         } else if dependency_type == DependencyType::Target || builder.is_builder_target(target) {
-            builder.copy_link(&path, &dst.join(path.file_name().unwrap()));
+            builder.copy_link_binary(&path, &dst.join(path.file_name().unwrap()), target);
         }
     }
 }
@@ -1147,7 +1183,7 @@ impl Step for Cargo {
         let mut tarball = Tarball::new(builder, "cargo", &target.triple);
         tarball.set_overlay(OverlayKind::Cargo);
 
-        tarball.add_file(cargo.tool_path, "bin", 0o755);
+        tarball_add_binary(&tarball, &cargo.tool_path, "bin", target);
         tarball.add_file(etc.join("_cargo"), "share/zsh/site-functions", 0o644);
         tarball.add_renamed_file(etc.join("cargo.bashcomp.sh"), "etc/bash_completion.d", "cargo");
         tarball.add_dir(etc.join("man"), "share/man/man1");
@@ -1193,7 +1229,7 @@ impl Step for Rls {
         let mut tarball = Tarball::new(builder, "rls", &target.triple);
         tarball.set_overlay(OverlayKind::Rls);
         tarball.is_preview(true);
-        tarball.add_file(rls.tool_path, "bin", 0o755);
+        tarball_add_binary(&tarball, &rls.tool_path, "bin", target);
         tarball.add_legal_and_readme_to("share/doc/rls");
         Some(tarball.generate())
     }
@@ -1235,7 +1271,7 @@ impl Step for RustAnalyzer {
         let mut tarball = Tarball::new(builder, "rust-analyzer", &target.triple);
         tarball.set_overlay(OverlayKind::RustAnalyzer);
         tarball.is_preview(true);
-        tarball.add_file(rust_analyzer.tool_path, "bin", 0o755);
+        tarball_add_binary(&tarball, &rust_analyzer.tool_path, "bin", target);
         tarball.add_legal_and_readme_to("share/doc/rust-analyzer");
         Some(tarball.generate())
     }
@@ -1281,8 +1317,8 @@ impl Step for Clippy {
         let mut tarball = Tarball::new(builder, "clippy", &target.triple);
         tarball.set_overlay(OverlayKind::Clippy);
         tarball.is_preview(true);
-        tarball.add_file(clippy.tool_path, "bin", 0o755);
-        tarball.add_file(cargoclippy.tool_path, "bin", 0o755);
+        tarball_add_binary(&tarball, &clippy.tool_path, "bin", target);
+        tarball_add_binary(&tarball, &cargoclippy.tool_path, "bin", target);
         tarball.add_legal_and_readme_to("share/doc/clippy");
         Some(tarball.generate())
     }
@@ -1331,8 +1367,8 @@ impl Step for Miri {
         let mut tarball = Tarball::new(builder, "miri", &target.triple);
         tarball.set_overlay(OverlayKind::Miri);
         tarball.is_preview(true);
-        tarball.add_file(miri.tool_path, "bin", 0o755);
-        tarball.add_file(cargomiri.tool_path, "bin", 0o755);
+        tarball_add_binary(&tarball, &miri.tool_path, "bin", target);
+        tarball_add_binary(&tarball, &cargomiri.tool_path, "bin", target);
         tarball.add_legal_and_readme_to("share/doc/miri");
         Some(tarball.generate())
     }
@@ -1416,7 +1452,12 @@ impl Step for CodegenBackend {
         for backend in fs::read_dir(&backends_src).unwrap() {
             let file_name = backend.unwrap().file_name();
             if file_name.to_str().unwrap().contains(&backend_name) {
-                tarball.add_file(backends_src.join(file_name), &backends_dst, 0o644);
+                tarball_add_binary(
+                    &tarball,
+                    &backends_src.join(file_name),
+                    &backends_dst,
+                    compiler.host,
+                );
                 found_backend = true;
             }
         }
@@ -1462,8 +1503,8 @@ impl Step for Rustfmt {
         let mut tarball = Tarball::new(builder, "rustfmt", &target.triple);
         tarball.set_overlay(OverlayKind::Rustfmt);
         tarball.is_preview(true);
-        tarball.add_file(rustfmt.tool_path, "bin", 0o755);
-        tarball.add_file(cargofmt.tool_path, "bin", 0o755);
+        tarball_add_binary(&tarball, &rustfmt.tool_path, "bin", target);
+        tarball_add_binary(&tarball, &cargofmt.tool_path, "bin", target);
         tarball.add_legal_and_readme_to("share/doc/rustfmt");
         Some(tarball.generate())
     }
@@ -2229,7 +2270,7 @@ impl Step for LlvmTools {
             let dst_bindir = format!("lib/rustlib/{}/bin", target.triple);
             for tool in tools_to_install(&builder.paths) {
                 let exe = src_bindir.join(exe(tool, target));
-                tarball.add_file(&exe, &dst_bindir, 0o755);
+                tarball_add_binary(&tarball, &exe, &dst_bindir, target);
             }
         }
 
@@ -2284,7 +2325,7 @@ impl Step for LlvmBitcodeLinker {
         tarball.set_overlay(OverlayKind::LlvmBitcodeLinker);
         tarball.is_preview(true);
 
-        tarball.add_file(llbc_linker.tool_path, self_contained_bin_dir, 0o755);
+        tarball_add_binary(&tarball, &llbc_linker.tool_path, self_contained_bin_dir, target);
 
         Some(tarball.generate())
     }
@@ -2345,7 +2386,7 @@ impl Step for RustDev {
                 let entry = t!(entry);
                 if entry.file_type().is_file() && !entry.path_is_symlink() {
                     let name = entry.file_name().to_str().unwrap();
-                    tarball.add_file(src_bindir.join(name), "bin", 0o755);
+                    tarball_add_binary(&tarball, &src_bindir.join(name), "bin", target);
                 }
             }
         }
@@ -2357,11 +2398,11 @@ impl Step for RustDev {
             // We don't build LLD on some platforms, so only add it if it exists
             let lld_path = lld_out.join("bin").join(exe("lld", target));
             if lld_path.exists() {
-                tarball.add_file(lld_path, "bin", 0o755);
+                tarball_add_binary(&tarball, &lld_path, "bin", target);
             }
         }
 
-        tarball.add_file(builder.llvm_filecheck(target), "bin", 0o755);
+        tarball_add_binary(&tarball, &builder.llvm_filecheck(target), "bin", target);
 
         // Copy the include directory as well; needed mostly to build
         // librustc_llvm properly (e.g., llvm-config.h is in here). But also
@@ -2422,7 +2463,12 @@ impl Step for Bootstrap {
 
         let bootstrap_outdir = &builder.bootstrap_out;
         for file in &["bootstrap", "rustc", "rustdoc", "sccache-plus-cl"] {
-            tarball.add_file(bootstrap_outdir.join(exe(file, target)), "bootstrap/bin", 0o755);
+            tarball_add_binary(
+                &tarball,
+                &bootstrap_outdir.join(exe(file, target)),
+                "bootstrap/bin",
+                target,
+            );
         }
 
         Some(tarball.generate())
@@ -2455,7 +2501,7 @@ impl Step for BuildManifest {
         let build_manifest = builder.tool_exe(Tool::BuildManifest);
 
         let tarball = Tarball::new(builder, "build-manifest", &self.target.triple);
-        tarball.add_file(build_manifest, "bin", 0o755);
+        tarball_add_binary(&tarball, &build_manifest, "bin", self.target);
         tarball.generate()
     }
 }
@@ -2524,7 +2570,7 @@ impl Step for Gcc {
     fn run(self, builder: &Builder<'_>) -> Self::Output {
         let tarball = Tarball::new(builder, "gcc", &self.target.triple);
         let output = builder.ensure(super::gcc::Gcc { target: self.target });
-        tarball.add_file(output.libgccjit, ".", 0o644);
+        tarball_add_binary(&tarball, &output.libgccjit, ".", self.target);
         tarball.generate()
     }
 }