fix(trim-paths): remap all paths to `build.build-dir` #15614

weihanglo · 2025-05-31T16:29:53Z

What does this PR try to resolve?

Remap all paths pointing to build.build-dir,
i.e., [BUILD_DIR]/debug/deps/foo-[HASH].dwo would be remapped to
/cargo/build-dir/debug/deps/foo-[HASH].dwo
(note the /cargo/build-dir prefix).

This covers scenarios like:

Build script generated code. For example, a build script may call file!
macros, and the associated crate uses include! to include the expanded
file! macro in-place via the OUT_DIR environment.
On Linux, DW_AT_GNU_dwo_name that contains paths to split debuginfo
files (dwp and dwo).

How to test and review this PR?

Should be quite straightforward.

The open question is what we want to remap to, to help debugger to find the source files.
cc #12137 and #13171

rustbot · 2025-05-31T16:29:58Z

r? @epage

rustbot has assigned @epage.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

weihanglo · 2025-06-01T13:55:50Z

tests/testsuite/profile_trim_paths.rs

-            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() {


The root cause of the DW_AT_GNU_dwo_name case has been found in #15610, and should be fixed altogether by this PR via remapping build.build-dir.

Originally posted by @Urgau in #15610 (comment) and #15610 (comment):

For the record: I tried reproducing the issue with rustc and failed to do. Maybe a Cargo specific thing.

$ rustc +nightly -C split-debuginfo=unpacked -g --remap-path-prefix=/tmp/split-rustc/=/remapped/path dep.rs --out-dir /tmp/split-rustc/target/ --crate-type lib -Zremap-path-scope=object $ rustc +nightly -C split-debuginfo=unpacked -g --remap-path-prefix=/tmp/split-rustc/=/remapped/path main.rs --out-dir /tmp/split-rustc/target/ --extern=dep=/tmp/split-rustc/target/libdep.rlib -Zremap-path-scope=object $ llvm-dwarfdump target/main | rg DW_AT_GNU_dwo_name DW_AT_GNU_dwo_name ("/remapped/path/target/main.main.62a074bc4c4ee7d3-cgu.0.rcgu.dwo") DW_AT_GNU_dwo_name ("/remapped/path/target/dep.dep.45866446ec9e29d2-cgu.0.rcgu.dwo")

I see something interesting in the Cargo test regarding the dependency, I don't think you are remapping the --out-dir, which would explain why the path isn't remapped, as I assume that the dwo/dwp would be in the target/ directory which isn't covered by those --remap-path-prefix (in the dependency rustc args).

--remap-path-prefix=[ROOT]/home/.cargo/registry/src= \ --remap-path-prefix=[..]/lib/rustlib/src/rust=/rustc/[..]

To me it seems like you are missing a --remap-path-prefix for the build.build-dir.

src/cargo/core/compiler/mod.rs

rust-lang/rust#117652 has been fixed.

The old wildcard matched too much and didn't really show whether the paths were sanitized.

This was discovered in <rust-lang/rust#111540 (comment)>. Co-authored-by: Urgau <urgau@numericable.fr>

Remap all paths pointing to `build.build-dir`, i.e., `[BUILD_DIR]/debug/deps/foo-[HASH].dwo` would be remapped to `/cargo/build-dir/debug/deps/foo-[HASH].dwo` (note the `/cargo/build-dir` prefix). This covers scenarios like: * Build script generated code. For example, a build script may call `file!` macros, and the associated crate uses [`include!`] to include the expanded [`file!`] macro in-place via the `OUT_DIR` environment. * On Linux, `DW_AT_GNU_dwo_name` that contains paths to split debuginfo files (dwp and dwo).

tests/testsuite/profile_trim_paths.rs

weihanglo · 2025-06-03T01:15:36Z

@teknalb this should fix the issue you mentioned in rust-lang/rust#111540 (comment). It is not yet available in nightly, though.

Update cargo 5 commits in 64a12460708cf146e16cc61f28aba5dc2463bbb4..f6bebc3abbd9b273a457f77c31f8e93bc77f93fc 2025-05-30 18:25:08 +0000 to 2025-06-02 19:04:43 +0000 - fix(trim-paths): remap all paths to `build.build-dir` (rust-lang/cargo#15614) - test(trim-paths): enable more tests for windows-msvc (rust-lang/cargo#15621) - fix(fingerprint): explicit reason rather than "stale; unknown reason" (rust-lang/cargo#15617) - Fix cargo add overwriting symlinked Cargo.toml files (rust-lang/cargo#15281) - chore(deps): update alpine docker tag to v3.22 (rust-lang/cargo#15616) r? ghost

Update cargo 18 commits in 64a12460708cf146e16cc61f28aba5dc2463bbb4..fc1518ef02b77327d70d4026b95ea719dd9b8c51 2025-05-30 18:25:08 +0000 to 2025-06-06 04:49:44 +0000 - fix: Make UI tests handle hyperlinks consistently (rust-lang/cargo#15640) - Update "time out" to "timeout" (rust-lang/cargo#15637) - fix(workspace): reload current manifest path member only (rust-lang/cargo#15633) - Update dependencies (rust-lang/cargo#15635) - fix(publish): Don't tell people to ctrl-c without knowing consequences (rust-lang/cargo#15632) - refactor: clean up `clippy::perf` lint warnings (rust-lang/cargo#15631) - fix(package): Skip registry check if its not needed (rust-lang/cargo#15629) - Add --offline for comp (rust-lang/cargo#15623) - cargo-credential-libsecret: load libsecret only once (rust-lang/cargo#15295) - test(publish): Improvements in prep for `-Zpackage-workspace` stabilization (rust-lang/cargo#15628) - fix(package): Allow packaging of self-cycles with -Zpackage-workspace (rust-lang/cargo#15626) - docs: clarify `--all-features` not available for all commmands (rust-lang/cargo#15572) - Remove double reference in Shell::print_json (rust-lang/cargo#15460) - fix(trim-paths): remap all paths to `build.build-dir` (rust-lang/cargo#15614) - test(trim-paths): enable more tests for windows-msvc (rust-lang/cargo#15621) - fix(fingerprint): explicit reason rather than "stale; unknown reason" (rust-lang/cargo#15617) - Fix cargo add overwriting symlinked Cargo.toml files (rust-lang/cargo#15281) - chore(deps): update alpine docker tag to v3.22 (rust-lang/cargo#15616) r? ghost

Update cargo 18 commits in 64a12460708cf146e16cc61f28aba5dc2463bbb4..fc1518ef02b77327d70d4026b95ea719dd9b8c51 2025-05-30 18:25:08 +0000 to 2025-06-06 04:49:44 +0000 - fix: Make UI tests handle hyperlinks consistently (rust-lang/cargo#15640) - Update "time out" to "timeout" (rust-lang/cargo#15637) - fix(workspace): reload current manifest path member only (rust-lang/cargo#15633) - Update dependencies (rust-lang/cargo#15635) - fix(publish): Don't tell people to ctrl-c without knowing consequences (rust-lang/cargo#15632) - refactor: clean up `clippy::perf` lint warnings (rust-lang/cargo#15631) - fix(package): Skip registry check if its not needed (rust-lang/cargo#15629) - Add --offline for comp (rust-lang/cargo#15623) - cargo-credential-libsecret: load libsecret only once (rust-lang/cargo#15295) - test(publish): Improvements in prep for `-Zpackage-workspace` stabilization (rust-lang/cargo#15628) - fix(package): Allow packaging of self-cycles with -Zpackage-workspace (rust-lang/cargo#15626) - docs: clarify `--all-features` not available for all commmands (rust-lang/cargo#15572) - Remove double reference in Shell::print_json (rust-lang/cargo#15460) - fix(trim-paths): remap all paths to `build.build-dir` (rust-lang/cargo#15614) - test(trim-paths): enable more tests for windows-msvc (rust-lang/cargo#15621) - fix(fingerprint): explicit reason rather than "stale; unknown reason" (rust-lang/cargo#15617) - Fix cargo add overwriting symlinked Cargo.toml files (rust-lang/cargo#15281) - chore(deps): update alpine docker tag to v3.22 (rust-lang/cargo#15616) r? ghost try-job: test-various

Update cargo 18 commits in 64a12460708cf146e16cc61f28aba5dc2463bbb4..fc1518ef02b77327d70d4026b95ea719dd9b8c51 2025-05-30 18:25:08 +0000 to 2025-06-06 04:49:44 +0000 - fix: Make UI tests handle hyperlinks consistently (rust-lang/cargo#15640) - Update "time out" to "timeout" (rust-lang/cargo#15637) - fix(workspace): reload current manifest path member only (rust-lang/cargo#15633) - Update dependencies (rust-lang/cargo#15635) - fix(publish): Don't tell people to ctrl-c without knowing consequences (rust-lang/cargo#15632) - refactor: clean up `clippy::perf` lint warnings (rust-lang/cargo#15631) - fix(package): Skip registry check if its not needed (rust-lang/cargo#15629) - Add --offline for comp (rust-lang/cargo#15623) - cargo-credential-libsecret: load libsecret only once (rust-lang/cargo#15295) - test(publish): Improvements in prep for `-Zpackage-workspace` stabilization (rust-lang/cargo#15628) - fix(package): Allow packaging of self-cycles with -Zpackage-workspace (rust-lang/cargo#15626) - docs: clarify `--all-features` not available for all commmands (rust-lang/cargo#15572) - Remove double reference in Shell::print_json (rust-lang/cargo#15460) - fix(trim-paths): remap all paths to `build.build-dir` (rust-lang/cargo#15614) - test(trim-paths): enable more tests for windows-msvc (rust-lang/cargo#15621) - fix(fingerprint): explicit reason rather than "stale; unknown reason" (rust-lang/cargo#15617) - Fix cargo add overwriting symlinked Cargo.toml files (rust-lang/cargo#15281) - chore(deps): update alpine docker tag to v3.22 (rust-lang/cargo#15616) r? ghost

rustbot assigned epage May 31, 2025

rustbot added A-build-execution Area: anything dealing with executing the compiler S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 31, 2025

weihanglo force-pushed the out-dir branch from 3388dde to 9f67f80 Compare May 31, 2025 16:38

weihanglo changed the title ~~fix(trim-path): remap file! macro in build script gen'd code~~ fix(trim-path): remap paths in build script gen'd code May 31, 2025

weihanglo force-pushed the out-dir branch from 9f67f80 to 2a17239 Compare May 31, 2025 16:40

weihanglo mentioned this pull request May 31, 2025

trim-paths: Remap rules for different dependency kinds #13171

Open

weihanglo force-pushed the out-dir branch from 2a17239 to a4187f3 Compare May 31, 2025 17:07

weihanglo added the Z-trim-paths Nightly: path sanitization label May 31, 2025

weihanglo mentioned this pull request May 31, 2025

Tracking Issue for trim-paths RFC 3127 #12137

Open

11 tasks

weihanglo force-pushed the out-dir branch from a4187f3 to 8212e0d Compare June 1, 2025 13:54

weihanglo commented Jun 1, 2025

View reviewed changes

weihanglo mentioned this pull request Jun 1, 2025

test(trim-paths): re-enable more symbols trimming check #15610

Closed

weihanglo changed the title ~~fix(trim-path): remap paths in build script gen'd code~~ fix(trim-paths): remap all paths to build.build-dir Jun 1, 2025

weihanglo changed the title ~~fix(trim-paths): remap all paths to build.build-dir~~ fix(trim-paths): remap all paths to build.build-dir Jun 1, 2025

epage reviewed Jun 2, 2025

View reviewed changes

src/cargo/core/compiler/mod.rs Outdated Show resolved Hide resolved

weihanglo and others added 4 commits June 2, 2025 14:26

test(trim-paths): re-enable more symbols trimming check

d8ac8dd

rust-lang/rust#117652 has been fixed.

test(trim-paths): match the actual sanitized paths

56a1118

The old wildcard matched too much and didn't really show whether the paths were sanitized.

test(trim-paths): not remapped in build script gen'd code

463e9ed

This was discovered in <rust-lang/rust#111540 (comment)>. Co-authored-by: Urgau <urgau@numericable.fr>

weihanglo force-pushed the out-dir branch from 8212e0d to 281629b Compare June 2, 2025 18:26

epage approved these changes Jun 2, 2025

View reviewed changes

epage added this pull request to the merge queue Jun 2, 2025

epage reviewed Jun 2, 2025

View reviewed changes

tests/testsuite/profile_trim_paths.rs Show resolved Hide resolved

Merged via the queue into rust-lang:master with commit f6bebc3 Jun 2, 2025
24 checks passed

weihanglo deleted the out-dir branch June 2, 2025 19:34

weihanglo mentioned this pull request Jun 3, 2025

Update cargo rust-lang/rust#141963

Closed

weihanglo mentioned this pull request Jun 6, 2025

Update cargo rust-lang/rust#142109

Merged

rustbot added this to the 1.89.0 milestone Jun 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(trim-paths): remap all paths to `build.build-dir` #15614

fix(trim-paths): remap all paths to `build.build-dir` #15614

Uh oh!

weihanglo commented May 31, 2025 •

edited

Loading

Uh oh!

rustbot commented May 31, 2025

Uh oh!

weihanglo Jun 1, 2025

Uh oh!

weihanglo Jun 1, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weihanglo commented Jun 3, 2025

Uh oh!

Uh oh!

fix(trim-paths): remap all paths to build.build-dir #15614

fix(trim-paths): remap all paths to build.build-dir #15614

Uh oh!

Conversation

weihanglo commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR try to resolve?

How to test and review this PR?

Uh oh!

rustbot commented May 31, 2025

Uh oh!

weihanglo Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

weihanglo Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

weihanglo commented Jun 3, 2025

Uh oh!

Uh oh!

fix(trim-paths): remap all paths to `build.build-dir` #15614

fix(trim-paths): remap all paths to `build.build-dir` #15614

weihanglo commented May 31, 2025 •

edited

Loading