From 7cb7b47fe7581cafbf75be1efb099a6c8f558aa4 Mon Sep 17 00:00:00 2001 From: Weihang Lo Date: Fri, 8 Dec 2023 10:49:06 -0500 Subject: [PATCH] test(trim-paths): add test for each split-debuginfo options Also demonstarte that on Linux with split-debuginfo on the remap is broken --- tests/testsuite/profile_trim_paths.rs | 110 +++++++++++++++++++------- 1 file changed, 80 insertions(+), 30 deletions(-) diff --git a/tests/testsuite/profile_trim_paths.rs b/tests/testsuite/profile_trim_paths.rs index 746d44ed040..3c3d5b20c4c 100644 --- a/tests/testsuite/profile_trim_paths.rs +++ b/tests/testsuite/profile_trim_paths.rs @@ -453,33 +453,65 @@ fn diagnostics_works() { } #[cfg(target_os = "macos")] -#[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")] -fn object_works() { - object_works_helper(|path| { +mod object_works { + use super::*; + + fn inspect_debuginfo(path: &std::path::Path) -> Vec { std::process::Command::new("nm") .arg("-pa") .arg(path) .output() .expect("nm works") .stdout - }) + } + + #[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")] + fn with_split_debuginfo_off() { + object_works_helper("off", inspect_debuginfo); + } + + #[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")] + fn with_split_debuginfo_packed() { + object_works_helper("packed", inspect_debuginfo); + } + + #[cargo_test(requires_nm, nightly, reason = "-Zremap-path-scope is unstable")] + fn with_split_debuginfo_unpacked() { + object_works_helper("unpacked", inspect_debuginfo); + } } #[cfg(target_os = "linux")] -#[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")] -fn object_works() { - object_works_helper(|path| { +mod object_works { + use super::*; + + fn inspect_debuginfo(path: &std::path::Path) -> Vec { std::process::Command::new("readelf") .arg("-wi") .arg(path) .output() .expect("readelf works") .stdout - }) + } + + #[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")] + fn with_split_debuginfo_off() { + object_works_helper("off", inspect_debuginfo); + } + + #[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")] + fn with_split_debuginfo_packed() { + object_works_helper("packed", inspect_debuginfo); + } + + #[cargo_test(requires_readelf, nightly, reason = "-Zremap-path-scope is unstable")] + fn with_split_debuginfo_unpacked() { + object_works_helper("unpacked", inspect_debuginfo); + } } #[cfg(unix)] -fn object_works_helper(run: impl Fn(&std::path::Path) -> Vec) { +fn object_works_helper(split_debuginfo: &str, run: impl Fn(&std::path::Path) -> Vec) { use std::os::unix::ffi::OsStrExt; let registry_src = paths::home().join(".cargo/registry/src"); @@ -495,14 +527,19 @@ fn object_works_helper(run: impl Fn(&std::path::Path) -> Vec) { let p = project() .file( "Cargo.toml", - r#" + &format!( + r#" [package] name = "foo" version = "0.0.1" [dependencies] bar = "0.0.1" - "#, + + [profile.dev] + split-debuginfo = "{split_debuginfo}" + "# + ), ) .file("src/main.rs", "fn main() { bar::f(); }") .build(); @@ -530,12 +567,12 @@ fn object_works_helper(run: impl Fn(&std::path::Path) -> Vec) { .with_stderr(&format!( "\ [COMPILING] bar v0.0.1 -[RUNNING] `rustc [..]\ +[RUNNING] `rustc [..]-C split-debuginfo={split_debuginfo} [..]\ -Zremap-path-scope=object \ --remap-path-prefix={pkg_remap} \ --remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..] [COMPILING] foo v0.0.1 ([CWD]) -[RUNNING] `rustc [..]\ +[RUNNING] `rustc [..]-C split-debuginfo={split_debuginfo} [..]\ -Zremap-path-scope=object \ --remap-path-prefix=[CWD]= \ --remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..] @@ -547,31 +584,44 @@ fn object_works_helper(run: impl Fn(&std::path::Path) -> Vec) { assert!(bin_path.is_file()); let stdout = run(&bin_path); assert!(memchr::memmem::find(&stdout, rust_src).is_none()); - if cfg!(target_os = "macos") { - for line in stdout.split(|c| c == &b'\n') { - let registry = memchr::memmem::find(line, registry_src_bytes).is_none(); - let local = memchr::memmem::find(line, pkg_root).is_none(); - if registry && local { - continue; - } + for line in stdout.split(|c| c == &b'\n') { + let registry = memchr::memmem::find(line, registry_src_bytes).is_none(); + let local = memchr::memmem::find(line, pkg_root).is_none(); + if registry && local { + continue; + } + #[cfg(target_os = "macos")] + { + // `OSO` symbols can't be trimmed at this moment. + // See if memchr::memmem::find(line, b" OSO ").is_some() { - // `OSO` symbols can't be trimmed at this moment. - // See - // TODO: Change to `is_none()` once the issue is resolved. continue; } // on macOS `SO` symbols are embedded in final binaries and should be trimmed. // See rust-lang/rust#117652. - assert!( - memchr::memmem::find(line, b" SO ").is_some(), - "untrimmed `SO` symbol found" - ) + if memchr::memmem::find(line, b" SO ").is_some() { + continue; + } + } + + #[cfg(target_os = "linux")] + { + // There is a bug in rustc `-Zremap-path-scope`. + // See rust-lang/rust/pull/118518 + if memchr::memmem::find(line, b"DW_AT_comp_dir").is_some() { + continue; + } + if memchr::memmem::find(line, b"DW_AT_GNU_dwo_name").is_some() { + continue; + } } - } else { - assert!(memchr::memmem::find(&stdout, registry_src_bytes).is_none()); - assert!(memchr::memmem::find(&stdout, pkg_root).is_none()); + + panic!( + "unexpected untrimmed symbol: {}", + String::from_utf8(line.into()).unwrap() + ); } }