Stabilize -Zremap-path-scope
#147611
+183
−93
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -454,6 +454,8 @@ top_level_options!( | |
|
|
||
| /// Remap source path prefixes in all output (messages, object files, debug, etc.). | ||
| remap_path_prefix: Vec<(PathBuf, PathBuf)> [TRACKED_NO_CRATE_HASH], | ||
| /// Defines which scopes of paths should be remapped by `--remap-path-prefix`. | ||
| remap_path_scope: RemapPathScopeComponents [TRACKED_NO_CRATE_HASH], | ||
|
|
||
| /// Base directory containing the `library/` directory for the Rust standard library. | ||
| /// Right now it's always `$sysroot/lib/rustlib/src/rust` | ||
|
|
@@ -869,8 +871,6 @@ mod desc { | |
| pub(crate) const parse_branch_protection: &str = "a `,` separated combination of `bti`, `gcs`, `pac-ret`, (optionally with `pc`, `b-key`, `leaf` if `pac-ret` is set)"; | ||
| pub(crate) const parse_proc_macro_execution_strategy: &str = | ||
| "one of supported execution strategies (`same-thread`, or `cross-thread`)"; | ||
| pub(crate) const parse_inlining_threshold: &str = | ||
| "either a boolean (`yes`, `no`, `on`, `off`, etc), or a non-negative number"; | ||
| pub(crate) const parse_llvm_module_flag: &str = "<key>:<type>:<value>:<behavior>. Type must currently be `u32`. Behavior should be one of (`error`, `warning`, `require`, `override`, `append`, `appendunique`, `max`, `min`)"; | ||
|
|
@@ -1694,28 +1694,6 @@ pub mod parse { | |
| true | ||
| } | ||
|
|
||
| pub(crate) fn parse_relocation_model(slot: &mut Option<RelocModel>, v: Option<&str>) -> bool { | ||
| match v.and_then(|s| RelocModel::from_str(s).ok()) { | ||
| Some(relocation_model) => *slot = Some(relocation_model), | ||
|
|
@@ -2565,8 +2543,6 @@ options! { | |
| "whether ELF relocations can be relaxed"), | ||
| remap_cwd_prefix: Option<PathBuf> = (None, parse_opt_pathbuf, [TRACKED], | ||
| "remap paths under the current working directory to this path prefix"), | ||
| remark_dir: Option<PathBuf> = (None, parse_opt_pathbuf, [UNTRACKED], | ||
| "directory into which to write optimization remarks (if not specified, they will be \ | ||
| written to standard error output)"), | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -882,7 +882,7 @@ impl Session { | |
| scope.bits().count_ones() == 1, | ||
| "one and only one scope should be passed to `Session::filename_display_preference`" | ||
| ); | ||
| if self.opts.remap_path_scope.contains(scope) { | ||
| FileNameDisplayPreference::Remapped | ||
| } else { | ||
| FileNameDisplayPreference::Local | ||
|
|
@@ -1534,7 +1534,7 @@ impl RemapFileNameExt for rustc_span::FileName { | |
| scope.bits().count_ones() == 1, | ||
| "one and only one scope should be passed to for_scope" | ||
| ); | ||
| if sess.opts.remap_path_scope.contains(scope) { | ||
| self.prefer_remapped_unconditionally() | ||
| } else { | ||
| self.prefer_local() | ||
|
|
@@ -1550,7 +1550,7 @@ impl RemapFileNameExt for rustc_span::RealFileName { | |
| scope.bits().count_ones() == 1, | ||
| "one and only one scope should be passed to for_scope" | ||
| ); | ||
| if sess.opts.remap_path_scope.contains(scope) { | ||
| self.remapped_path_if_available() | ||
| } else { | ||
| self.local_path_if_available() | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -428,6 +428,14 @@ specified multiple times. | |
| Refer to the [Remap source paths](remap-source-paths.md) section of this book for | ||
| further details and explanation. | ||
|
|
||
| <a id="option-remap-path-scope"></a> | ||
| ## `--remap-path-scope`: remap source paths in output | ||
|
|
||
| Defines which scopes of paths should be remapped by `--remap-path-prefix`. | ||
|
|
||
| Refer to the [Remap source paths](remap-source-paths.md) section of this book for | ||
| further details and explanation. | ||
|
|
||
| <a id="option-json"></a> | ||
| ## `--json`: configure json messages printed by the compiler | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ output, including compiler diagnostics, debugging information, macro expansions, | |
| This is useful for normalizing build products, for example by removing the current directory | ||
| out of the paths emitted into object files. | ||
|
|
||
| The remapping is done via the `--remap-path-prefix` flag and can be customized via the `--remap-path-scope` flag. | ||
|
|
||
| ## `--remap-path-prefix` | ||
|
|
||
|
|
@@ -25,6 +25,30 @@ rustc --remap-path-prefix "/home/user/project=/redacted" | |
|
|
||
| This example replaces all occurrences of `/home/user/project` in emitted paths with `/redacted`. | ||
|
|
||
| ## `--remap-path-scope` | ||
|
|
||
| Defines which scopes of paths should be remapped by `--remap-path-prefix`. | ||
|
|
||
| This flag accepts a comma-separated list of values and may be specified multiple times, in which case the scopes are aggregated together. | ||
|
|
||
| The valid scopes are: | ||
|
|
||
| - `macro` - apply remappings to the expansion of `std::file!()` macro. This is where paths in embedded panic messages come from | ||
| - `diagnostics` - apply remappings to printed compiler diagnostics | ||
| - `debuginfo` - apply remappings to debug informations | ||
| - `coverage` - apply remappings to coverage informations | ||
| - `object` - apply remappings to all paths in compiled executables or libraries, but not elsewhere. Currently an alias for `macro,coverage,debuginfo`. | ||
| - `all` (default) - an alias for all of the above, also equivalent to supplying only `--remap-path-prefix` without `--remap-path-scope`. | ||
|
|
||
Urgau marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| The scopes accepted by `--remap-path-scope` are not exhaustive - new scopes may be added in future releases for eventual stabilisation. | ||
Urgau marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Example | ||
|
|
||
| ```sh | ||
| # With `object` scope only the build outputs will be remapped, the diagnostics won't be remapped. | ||
| rustc --remap-path-prefix=$(PWD)=/remapped --remap-path-scope=object main.rs | ||
| ``` | ||
|
|
||
| ## Caveats and Limitations | ||
|
|
||
| ### Linkers generated paths | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // This test makes sure that the files used in the coverage are remapped by `--remap-path-prefix` | ||
| // and the `coverage` <- `object` scope. | ||
|
|
||
| //@ revisions: with_remap with_coverage_scope with_object_scope with_macro_scope | ||
| //@ compile-flags: --remap-path-prefix={{src-base}}=remapped | ||
| // | ||
| //@[with_coverage_scope] compile-flags: --remap-path-scope=coverage | ||
| //@[with_object_scope] compile-flags: --remap-path-scope=object | ||
| //@[with_macro_scope] compile-flags: --remap-path-scope=macro | ||
|
|
||
| fn main() {} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Function name: remap_path_prefix::main | ||
| Raw bytes (14): 0x[01, 01, 00, 02, 01, 0b, 01, 00, 0a, 01, 00, 0c, 00, 0d] | ||
| Number of files: 1 | ||
| - file 0 => remapped/remap-path-prefix.rs | ||
| Number of expressions: 0 | ||
| Number of file 0 mappings: 2 | ||
| - Code(Counter(0)) at (prev + 11, 1) to (start + 0, 10) | ||
| - Code(Counter(0)) at (prev + 0, 12) to (start + 0, 13) | ||
| Highest counter ID seen: c0 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Function name: remap_path_prefix::main | ||
| Raw bytes (14): 0x[01, 01, 00, 02, 01, 0b, 01, 00, 0a, 01, 00, 0c, 00, 0d] | ||
| Number of files: 1 | ||
| - file 0 => $DIR/remap-path-prefix.rs | ||
| Number of expressions: 0 | ||
| Number of file 0 mappings: 2 | ||
| - Code(Counter(0)) at (prev + 11, 1) to (start + 0, 10) | ||
| - Code(Counter(0)) at (prev + 0, 12) to (start + 0, 13) | ||
| Highest counter ID seen: c0 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| LL| |// This test makes sure that the files used in the coverage are remapped by `--remap-path-prefix` | ||
| LL| |// and the `coverage` <- `object` scope. | ||
| LL| | | ||
| LL| |//@ revisions: with_remap with_coverage_scope with_object_scope with_macro_scope | ||
| LL| |//@ compile-flags: --remap-path-prefix={{src-base}}=remapped | ||
| LL| |// | ||
| LL| |//@[with_coverage_scope] compile-flags: --remap-path-scope=coverage | ||
| LL| |//@[with_object_scope] compile-flags: --remap-path-scope=object | ||
| LL| |//@[with_macro_scope] compile-flags: --remap-path-scope=macro | ||
| LL| | | ||
| LL| 1|fn main() {} | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Function name: remap_path_prefix::main | ||
| Raw bytes (14): 0x[01, 01, 00, 02, 01, 0b, 01, 00, 0a, 01, 00, 0c, 00, 0d] | ||
| Number of files: 1 | ||
| - file 0 => remapped/remap-path-prefix.rs | ||
| Number of expressions: 0 | ||
| Number of file 0 mappings: 2 | ||
| - Code(Counter(0)) at (prev + 11, 1) to (start + 0, 10) | ||
| - Code(Counter(0)) at (prev + 0, 12) to (start + 0, 13) | ||
| Highest counter ID seen: c0 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| Function name: remap_path_prefix::main | ||
| Raw bytes (14): 0x[01, 01, 00, 02, 01, 0b, 01, 00, 0a, 01, 00, 0c, 00, 0d] | ||
| Number of files: 1 | ||
| - file 0 => remapped/remap-path-prefix.rs | ||
| Number of expressions: 0 | ||
| Number of file 0 mappings: 2 | ||
| - Code(Counter(0)) at (prev + 11, 1) to (start + 0, 10) | ||
| - Code(Counter(0)) at (prev + 0, 12) to (start + 0, 13) | ||
| Highest counter ID seen: c0 | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -105,7 +105,7 @@ fn check_dwarf_deps(scope: &str, dwarf_test: DwarfDump) { | |
| let mut rustc_sm = rustc(); | ||
| rustc_sm.input(cwd().join("src/some_value.rs")); | ||
| rustc_sm.arg("-Cdebuginfo=2"); | ||
| rustc_sm.arg(format!("--remap-path-scope={}", scope)); | ||
| rustc_sm.arg("--remap-path-prefix"); | ||
| rustc_sm.arg(format!("{}=/REMAPPED", cwd().display())); | ||
| rustc_sm.arg("-Csplit-debuginfo=off"); | ||
|
|
@@ -117,7 +117,7 @@ fn check_dwarf_deps(scope: &str, dwarf_test: DwarfDump) { | |
| rustc_pv.input(cwd().join("src/print_value.rs")); | ||
| rustc_pv.output(&print_value_rlib); | ||
| rustc_pv.arg("-Cdebuginfo=2"); | ||
| rustc_pv.arg(format!("--remap-path-scope={}", scope)); | ||
| rustc_pv.arg("--remap-path-prefix"); | ||
| rustc_pv.arg(format!("{}=/REMAPPED", cwd().display())); | ||
| rustc_pv.arg("-Csplit-debuginfo=off"); | ||
|
|
@@ -158,8 +158,8 @@ fn check_dwarf(test: DwarfTest) { | |
| rustc.arg("-Cdebuginfo=2"); | ||
| if let Some(scope) = test.scope { | ||
| match scope { | ||
| ScopeType::Object => rustc.arg("--remap-path-scope=object"), | ||
| ScopeType::Diagnostics => rustc.arg("--remap-path-scope=diagnostics"), | ||
| }; | ||
| if is_darwin() { | ||
| rustc.arg("-Csplit-debuginfo=off"); | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for driving the stabilization!
"There are no outstanding bugs" probably?
Don't want to block the stabilization. However, this sounds a bit odd that there is no major use cases beyond Cargo and rustc is heading toward stabilization alone. That may imply t-cargo should review again whether
--remap-path-scopeis useful and cover what they want at least (of course this is on me as I worked on Cargo side of this)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I know
--remap-path-scopehas no bugs. We have test for all the scopes, with/without dependency and with mixed scopes between crates.It doesn't really surprises me that there are no public use of it. It's quite a pain currently to setup
--remap-path-prefixand-Zremap-path-scopein Cargo, as there is currently no support for it, which is what we are trying to solve. I suspect most users are usingRUSTFLAGSwhich I don't think is typically committed.Well, be able to see the not-remapped paths in diagnostics is quite nice thing.
The RFC specifically states that the default should be
objectfor thereleaseprofile.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant the "no" is missing in the original PR description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The other thing is that do we want to stabilize all options all at once. I remember that the RFC said we could optionally stabilize some of them. I am not sure whether
macrosanddebuginfostandalone are useful, as well asdiagnostics. The most useful thing as you mentioned is probablyobjectand the original behaviorall.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know that
macrosordebuginfowould need to be useful on their own to be worth stabilising, we're able to support them relatively straightforwardly and they may be useful in combination with other options.