Skip to content

Commit 8c9a219

Browse files
borsbors
committed
Auto merge of rust-lang#118149 - cbeuw:rfc3127-sysroot, r=b-naber
Implement RFC 3127 sysroot path handling changes Fix rust-lang#105907 Fix rust-lang#85463 Implement parts of rust-lang#111540 Right now, backtraces into sysroot always shows /rustc/$hash in diagnostics, e.g. ``` thread 'main' panicked at 'hello world', map-panic.rs:2:50 stack backtrace: 0: std::panicking::begin_panic at /rustc/a55dd71d5fb0ec5a6a3a9e8c27b2127ba491ce52/library/std/src/panicking.rs:616:12 1: map_panic::main::{{closure}} at ./map-panic.rs:2:50 2: core::option::Option<T>::map at /rustc/a55dd71d5fb0ec5a6a3a9e8c27b2127ba491ce52/library/core/src/option.rs:929:29 3: map_panic::main at ./map-panic.rs:2:30 4: core::ops::function::FnOnce::call_once at /rustc/a55dd71d5fb0ec5a6a3a9e8c27b2127ba491ce52/library/core/src/ops/function.rs:248:5 note: Some details are omitted, run with `RUST_BACKTRACE=full` for a verbose backtrace. ``` [RFC 3127 said](https://rust-lang.github.io/rfcs/3127-trim-paths.html#changing-handling-of-sysroot-path-in-rustc) > We want to change this behaviour such that, when rust-src source files can be discovered, the virtual path is discarded and therefore the local path will be embedded, unless there is a --remap-path-prefix that causes this local path to be remapped in the usual way. This PR implements this behaviour. When `rust-src` is present at compile time, rustc replaces /rustc/$hash with a real path into local rust-src with best effort. To sanitise this, users must explicitly supply `--remap-path-prefix=<path to rust-src>=foo`.
2 parents eeff92a + b7eeb3c commit 8c9a219

File tree

6 files changed

+126
-52
lines changed

6 files changed

+126
-52
lines changed

‎compiler/rustc_metadata/src/rmeta/decoder.rs

+56-49
Original file line numberDiff line numberDiff line change
@@ -1597,56 +1597,63 @@ impl<'a, 'tcx> CrateMetadataRef<'a> {
15971597
);
15981598

15991599
for virtual_dir in virtual_rust_source_base_dir.iter().flatten() {
1600-
if let Some(real_dir) = &sess.opts.real_rust_source_base_dir {
1601-
if let rustc_span::FileName::Real(old_name) = name {
1602-
if let rustc_span::RealFileName::Remapped { local_path: _, virtual_name } =
1603-
old_name
1604-
{
1605-
if let Ok(rest) = virtual_name.strip_prefix(virtual_dir) {
1606-
let virtual_name = virtual_name.clone();
1607-
1608-
// The std library crates are in
1609-
// `$sysroot/lib/rustlib/src/rust/library`, whereas other crates
1610-
// may be in `$sysroot/lib/rustlib/src/rust/` directly. So we
1611-
// detect crates from the std libs and handle them specially.
1612-
const STD_LIBS: &[&str] = &[
1613-
"core",
1614-
"alloc",
1615-
"std",
1616-
"test",
1617-
"term",
1618-
"unwind",
1619-
"proc_macro",
1620-
"panic_abort",
1621-
"panic_unwind",
1622-
"profiler_builtins",
1623-
"rtstartup",
1624-
"rustc-std-workspace-core",
1625-
"rustc-std-workspace-alloc",
1626-
"rustc-std-workspace-std",
1627-
"backtrace",
1628-
];
1629-
let is_std_lib = STD_LIBS.iter().any(|l| rest.starts_with(l));
1630-
1631-
let new_path = if is_std_lib {
1632-
real_dir.join("library").join(rest)
1633-
} else {
1634-
real_dir.join(rest)
1635-
};
1636-
1637-
debug!(
1638-
"try_to_translate_virtual_to_real: `{}` -> `{}`",
1639-
virtual_name.display(),
1640-
new_path.display(),
1641-
);
1642-
let new_name = rustc_span::RealFileName::Remapped {
1643-
local_path: Some(new_path),
1644-
virtual_name,
1645-
};
1646-
*old_name = new_name;
1647-
}
1600+
if let Some(real_dir) = &sess.opts.real_rust_source_base_dir
1601+
&& let rustc_span::FileName::Real(old_name) = name
1602+
&& let rustc_span::RealFileName::Remapped { local_path: _, virtual_name } =
1603+
old_name
1604+
&& let Ok(rest) = virtual_name.strip_prefix(virtual_dir)
1605+
{
1606+
// The std library crates are in
1607+
// `$sysroot/lib/rustlib/src/rust/library`, whereas other crates
1608+
// may be in `$sysroot/lib/rustlib/src/rust/` directly. So we
1609+
// detect crates from the std libs and handle them specially.
1610+
const STD_LIBS: &[&str] = &[
1611+
"core",
1612+
"alloc",
1613+
"std",
1614+
"test",
1615+
"term",
1616+
"unwind",
1617+
"proc_macro",
1618+
"panic_abort",
1619+
"panic_unwind",
1620+
"profiler_builtins",
1621+
"rtstartup",
1622+
"rustc-std-workspace-core",
1623+
"rustc-std-workspace-alloc",
1624+
"rustc-std-workspace-std",
1625+
"backtrace",
1626+
];
1627+
let is_std_lib = STD_LIBS.iter().any(|l| rest.starts_with(l));
1628+
1629+
let new_path = if is_std_lib {
1630+
real_dir.join("library").join(rest)
1631+
} else {
1632+
real_dir.join(rest)
1633+
};
1634+
1635+
debug!(
1636+
"try_to_translate_virtual_to_real: `{}` -> `{}`",
1637+
virtual_name.display(),
1638+
new_path.display(),
1639+
);
1640+
1641+
// Check if the translated real path is affected by any user-requested
1642+
// remaps via --remap-path-prefix. Apply them if so.
1643+
// Note that this is a special case for imported rust-src paths specified by
1644+
// https://rust-lang.github.io/rfcs/3127-trim-paths.html#handling-sysroot-paths.
1645+
// Other imported paths are not currently remapped (see #66251).
1646+
let (user_remapped, applied) =
1647+
sess.source_map().path_mapping().map_prefix(&new_path);
1648+
let new_name = if applied {
1649+
rustc_span::RealFileName::Remapped {
1650+
local_path: Some(new_path.clone()),
1651+
virtual_name: user_remapped.to_path_buf(),
16481652
}
1649-
}
1653+
} else {
1654+
rustc_span::RealFileName::LocalPath(new_path)
1655+
};
1656+
*old_name = new_name;
16501657
}
16511658
}
16521659
};

‎src/tools/compiletest/src/header.rs

+8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
use std::collections::HashSet;
22
use std::env;
3+
use std::fs::canonicalize;
34
use std::fs::File;
45
use std::io::prelude::*;
56
use std::io::BufReader;
@@ -795,6 +796,7 @@ fn expand_variables(mut value: String, config: &Config) -> String {
795796
const CWD: &str = "{{cwd}}";
796797
const SRC_BASE: &str = "{{src-base}}";
797798
const BUILD_BASE: &str = "{{build-base}}";
799+
const RUST_SRC_BASE: &str = "{{rust-src-base}}";
798800

799801
if value.contains(CWD) {
800802
let cwd = env::current_dir().unwrap();
@@ -809,6 +811,12 @@ fn expand_variables(mut value: String, config: &Config) -> String {
809811
value = value.replace(BUILD_BASE, &config.build_base.to_string_lossy());
810812
}
811813

814+
if value.contains(RUST_SRC_BASE) {
815+
let src = config.sysroot_base.join("lib/rustlib/src/rust");
816+
let canonical = canonicalize(&src).unwrap();
817+
value = value.replace(RUST_SRC_BASE, &canonical.to_string_lossy());
818+
}
819+
812820
value
813821
}
814822

‎src/tools/compiletest/src/runtest.rs

+5-3
Original file line numberDiff line numberDiff line change
@@ -4205,7 +4205,7 @@ impl<'test> TestCx<'test> {
42054205
}
42064206

42074207
let base_dir = Path::new("/rustc/FAKE_PREFIX");
4208-
// Paths into the libstd/libcore
4208+
// Fake paths into the libstd/libcore
42094209
normalize_path(&base_dir.join("library"), "$SRC_DIR");
42104210
// `ui-fulldeps` tests can show paths to the compiler source when testing macros from
42114211
// `rustc_macros`
@@ -4221,8 +4221,10 @@ impl<'test> TestCx<'test> {
42214221
// eg. /home/user/rust/build
42224222
normalize_path(parent_build_dir, "$BUILD_DIR");
42234223

4224-
// Paths into lib directory.
4225-
normalize_path(&parent_build_dir.parent().unwrap().join("lib"), "$LIB_DIR");
4224+
// Real paths into the libstd/libcore
4225+
let rust_src_dir =
4226+
&self.config.sysroot_base.join("lib/rustlib/src/rust").canonicalize().unwrap();
4227+
normalize_path(&rust_src_dir.join("library"), "$SRC_DIR_REAL");
42264228

42274229
if json {
42284230
// escaped newlines in json strings should be readable

‎tests/ui/errors/remap-path-prefix-sysroot.rs

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// revisions: with-remap without-remap
2+
// compile-flags: -g -Ztranslate-remapped-path-to-local-path=yes
3+
// [with-remap]compile-flags: --remap-path-prefix={{rust-src-base}}=remapped
4+
// [without-remap]compile-flags:
5+
// error-pattern: E0507
6+
7+
// The $SRC_DIR*.rs:LL:COL normalisation doesn't kick in automatically
8+
// as the remapped revision will not begin with $SRC_DIR_REAL,
9+
// so we have to do it ourselves.
10+
// normalize-stderr-test: ".rs:\d+:\d+" -> ".rs:LL:COL"
11+
12+
use std::thread;
13+
struct Worker {
14+
thread: thread::JoinHandle<()>,
15+
}
16+
17+
impl Drop for Worker {
18+
fn drop(&mut self) {
19+
self.thread.join().unwrap();
20+
}
21+
}
22+
23+
pub fn main(){}

‎tests/ui/errors/remap-path-prefix-sysroot.with-remap.stderr

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
error[E0507]: cannot move out of `self.thread` which is behind a mutable reference
2+
--> remapped/tests/ui/errors/remap-path-prefix-sysroot.rs:LL:COL
3+
|
4+
LL | self.thread.join().unwrap();
5+
| ^^^^^^^^^^^ ------ `self.thread` moved due to this method call
6+
| |
7+
| move occurs because `self.thread` has type `JoinHandle<()>`, which does not implement the `Copy` trait
8+
|
9+
note: `JoinHandle::<T>::join` takes ownership of the receiver `self`, which moves `self.thread`
10+
--> remapped/library/std/src/thread/mod.rs:LL:COL
11+
|
12+
LL | pub fn join(self) -> Result<T> {
13+
| ^^^^
14+
15+
error: aborting due to 1 previous error
16+
17+
For more information about this error, try `rustc --explain E0507`.

‎tests/ui/errors/remap-path-prefix-sysroot.without-remap.stderr

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
error[E0507]: cannot move out of `self.thread` which is behind a mutable reference
2+
--> $DIR/remap-path-prefix-sysroot.rs:LL:COL
3+
|
4+
LL | self.thread.join().unwrap();
5+
| ^^^^^^^^^^^ ------ `self.thread` moved due to this method call
6+
| |
7+
| move occurs because `self.thread` has type `JoinHandle<()>`, which does not implement the `Copy` trait
8+
|
9+
note: `JoinHandle::<T>::join` takes ownership of the receiver `self`, which moves `self.thread`
10+
--> $SRC_DIR_REAL/std/src/thread/mod.rs:LL:COL
11+
|
12+
LL | pub fn join(self) -> Result<T> {
13+
| ^^^^
14+
15+
error: aborting due to 1 previous error
16+
17+
For more information about this error, try `rustc --explain E0507`.

0 commit comments

Comments
 (0)