Auto merge of #12625 - weihanglo:rfc3127, r=epage

feat: implement RFC 3127 `-Ztrim-paths`

src/cargo/core/compiler/mod.rs

@@ -94,6 +94,7 @@ use crate::util::errors::{CargoResult, VerboseError};
 use crate::util::interning::InternedString;
 use crate::util::machine_message::{self, Message};
 use crate::util::toml::TomlDebugInfo;
+use crate::util::toml::TomlTrimPaths;
 use crate::util::{add_path_args, internal, iter_join_onto, profile};
 use cargo_util::{paths, ProcessBuilder, ProcessError};
 use rustfix::diagnostics::Applicability;
@@ -950,6 +951,7 @@ fn build_base_args(cx: &Context<'_, '_>, cmd: &mut ProcessBuilder, unit: &Unit)
  incremental,
  strip,
  rustflags: profile_rustflags,
+ trim_paths,
  ..
  } = unit.profile.clone();
  let test = unit.mode.is_any_test();
@@ -1028,6 +1030,10 @@ fn build_base_args(cx: &Context<'_, '_>, cmd: &mut ProcessBuilder, unit: &Unit)
  }
  }
 
+ if let Some(trim_paths) = trim_paths {
+ trim_paths_args(cmd, cx, unit, &trim_paths)?;
+ }
+
  cmd.args(unit.pkg.manifest().lint_rustflags());
  cmd.args(&profile_rustflags);
  if let Some(args) = cx.bcx.extra_args_for(unit) {
@@ -1162,6 +1168,74 @@ fn features_args(unit: &Unit) -> Vec<OsString> {
  args
 }
 
+/// Generates the `--remap-path-scope` and `--remap-path-prefix` for [RFC 3127].
+/// See also unstable feature [`-Ztrim-paths`].
+///
+/// [RFC 3127]: https://rust-lang.github.io/rfcs/3127-trim-paths.html
+/// [`-Ztrim-paths`]: https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#profile-trim-paths-option
+fn trim_paths_args(
+ cmd: &mut ProcessBuilder,
+ cx: &Context<'_, '_>,
+ unit: &Unit,
+ trim_paths: &TomlTrimPaths,
+) -> CargoResult<()> {
+ if trim_paths.is_none() {
+ return Ok(());
+ }
+
+ // feature gate was checked during mainfest/config parsing.
+ cmd.arg("-Zunstable-options");
+ cmd.arg(format!("-Zremap-path-scope={trim_paths}"));
+
+ let sysroot_remap = {
+ let sysroot = &cx.bcx.target_data.info(unit.kind).sysroot;
+ let mut remap = OsString::from("--remap-path-prefix=");
+ remap.push(sysroot);
+ remap.push("/lib/rustlib/src/rust"); // See also `detect_sysroot_src_path()`.
+ remap.push("=");
+ remap.push("/rustc/");
+ // This remap logic aligns with rustc:
+ // <https://github.com/rust-lang/rust/blob/c2ef3516/src/bootstrap/src/lib.rs#L1113-L1116>
+ if let Some(commit_hash) = cx.bcx.rustc().commit_hash.as_ref() {
+ remap.push(commit_hash);
+ } else {
+ remap.push(cx.bcx.rustc().version.to_string());
+ }
+ remap
+ };
+ cmd.arg(sysroot_remap);
+
+ let package_remap = {
+ let pkg_root = unit.pkg.root();
+ let ws_root = cx.bcx.ws.root();
+ let is_local = unit.pkg.package_id().source_id().is_path();
+ let mut remap = OsString::from("--remap-path-prefix=");
+ // Remapped to path relative to workspace root:
+ //
+ // * path dependencies under workspace root directory
+ //
+ // Remapped to `<pkg>-<version>`
+ //
+ // * registry dependencies
+ // * git dependencies
+ // * path dependencies outside workspace root directory
+ if is_local && pkg_root.strip_prefix(ws_root).is_ok() {
+ remap.push(ws_root);
+ remap.push("="); // empty to remap to relative paths.
+ } else {
+ remap.push(pkg_root);
+ remap.push("=");
+ remap.push(unit.pkg.name());
+ remap.push("-");
+ remap.push(unit.pkg.version().to_string());
+ }
+ remap
+ };
+ cmd.arg(package_remap);
+
+ Ok(())
+}
+
 /// Generates the `--check-cfg` arguments for the `unit`.
 /// See unstable feature [`check-cfg`].
 ///

src/cargo/core/features.rs

@@ -496,6 +496,9 @@ features! {
 
  // Support for 2024 edition.
  (unstable, edition2024, "", "reference/unstable.html#edition-2024"),
+
+ // Allow setting trim-paths in a profile to control the sanitisation of file paths in build outputs.
+ (unstable, trim_paths, "", "reference/unstable.html#profile-trim-paths-option"),
 }
 
 pub struct Feature {
@@ -755,6 +758,7 @@ unstable_cli_options!(
  separate_nightlies: bool = (HIDDEN),
  skip_rustdoc_fingerprint: bool = (HIDDEN),
  target_applies_to_host: bool = ("Enable the `target-applies-to-host` key in the .cargo/config.toml file"),
+ trim_paths: bool = ("Enable the `trim-paths` option in profiles"),
  unstable_options: bool = ("Allow the usage of unstable options"),
 );
 
@@ -1089,6 +1093,7 @@ impl CliUnstable {
  "no-index-update" => self.no_index_update = parse_empty(k, v)?,
  "panic-abort-tests" => self.panic_abort_tests = parse_empty(k, v)?,
  "profile-rustflags" => self.profile_rustflags = parse_empty(k, v)?,
+ "trim-paths" => self.trim_paths = parse_empty(k, v)?,
  "publish-timeout" => self.publish_timeout = parse_empty(k, v)?,
  "rustdoc-map" => self.rustdoc_map = parse_empty(k, v)?,
  "rustdoc-scrape-examples" => self.rustdoc_scrape_examples = parse_empty(k, v)?,

src/cargo/core/profiles.rs

@@ -24,8 +24,11 @@
 use crate::core::compiler::{CompileKind, CompileTarget, Unit};
 use crate::core::dependency::Artifact;
 use crate::core::resolver::features::FeaturesFor;
+use crate::core::Feature;
 use crate::core::{PackageId, PackageIdSpec, Resolve, Shell, Target, Workspace};
 use crate::util::interning::InternedString;
+use crate::util::toml::TomlTrimPaths;
+use crate::util::toml::TomlTrimPathsValue;
 use crate::util::toml::{
  ProfilePackageSpec, StringOrBool, TomlDebugInfo, TomlProfile, TomlProfiles,
 };
@@ -80,7 +83,9 @@ impl Profiles {
  rustc_host,
  };
 
- Self::add_root_profiles(&mut profile_makers, &profiles);
+ let trim_paths_enabled = ws.unstable_features().is_enabled(Feature::trim_paths())
+ || config.cli_unstable().trim_paths;
+ Self::add_root_profiles(&mut profile_makers, &profiles, trim_paths_enabled);
 
  // Merge with predefined profiles.
  use std::collections::btree_map::Entry;
@@ -123,6 +128,7 @@ impl Profiles {
  fn add_root_profiles(
  profile_makers: &mut Profiles,
  profiles: &BTreeMap<InternedString, TomlProfile>,
+ trim_paths_enabled: bool,
  ) {
  profile_makers.by_name.insert(
  InternedString::new("dev"),
@@ -131,7 +137,10 @@ impl Profiles {
 
  profile_makers.by_name.insert(
  InternedString::new("release"),
- ProfileMaker::new(Profile::default_release(), profiles.get("release").cloned()),
+ ProfileMaker::new(
+ Profile::default_release(trim_paths_enabled),
+ profiles.get("release").cloned(),
+ ),
  );
  }
 
@@ -556,6 +565,9 @@ fn merge_profile(profile: &mut Profile, toml: &TomlProfile) {
  if let Some(flags) = &toml.rustflags {
  profile.rustflags = flags.iter().map(InternedString::from).collect();
  }
+ if let Some(trim_paths) = &toml.trim_paths {
+ profile.trim_paths = Some(trim_paths.clone());
+ }
  profile.strip = match toml.strip {
  Some(StringOrBool::Bool(true)) => Strip::Named(InternedString::new("symbols")),
  None | Some(StringOrBool::Bool(false)) => Strip::None,
@@ -599,6 +611,9 @@ pub struct Profile {
  #[serde(skip_serializing_if = "Vec::is_empty")] // remove when `rustflags` is stablized
  // Note that `rustflags` is used for the cargo-feature `profile_rustflags`
  pub rustflags: Vec<InternedString>,
+ // remove when `-Ztrim-paths` is stablized
+ #[serde(skip_serializing_if = "Option::is_none")]
+ pub trim_paths: Option<TomlTrimPaths>,
 }
 
 impl Default for Profile {
@@ -619,6 +634,7 @@ impl Default for Profile {
  panic: PanicStrategy::Unwind,
  strip: Strip::None,
  rustflags: vec![],
+ trim_paths: None,
  }
  }
 }
@@ -628,7 +644,7 @@ compact_debug! {
  fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  let (default, default_name) = match self.name.as_str() {
  "dev" => (Profile::default_dev(), "default_dev()"),
- "release" => (Profile::default_release(), "default_release()"),
+ "release" => (Profile::default_release(false), "default_release()"),
  _ => (Profile::default(), "default()"),
  };
  [debug_the_fields(
@@ -647,6 +663,7 @@ compact_debug! {
  panic
  strip
  rustflags
+ trim_paths
  )]
  }
  }
@@ -688,11 +705,13 @@ impl Profile {
  }
 
  /// Returns a built-in `release` profile.
- fn default_release() -> Profile {
+ fn default_release(trim_paths_enabled: bool) -> Profile {
+ let trim_paths = trim_paths_enabled.then(|| TomlTrimPathsValue::Object.into());
  Profile {
  name: InternedString::new("release"),
  root: ProfileRoot::Release,
  opt_level: InternedString::new("3"),
+ trim_paths,
  ..Profile::default()
  }
  }
@@ -713,6 +732,7 @@ impl Profile {
  self.rpath,
  (self.incremental, self.panic, self.strip),
  &self.rustflags,
+ &self.trim_paths,
  )
  }
 }

src/cargo/util/rustc.rs

@@ -28,6 +28,8 @@ pub struct Rustc {
  pub version: semver::Version,
  /// The host triple (arch-platform-OS), this comes from verbose_version.
  pub host: InternedString,
+ /// The rustc full commit hash, this comes from `verbose_version`.
+ pub commit_hash: Option<String>,
  cache: Mutex<Cache>,
 }
 
@@ -80,6 +82,17 @@ impl Rustc {
  verbose_version
  )
  })?;
+ let commit_hash = extract("commit-hash: ").ok().map(|hash| {
+ debug_assert!(
+ hash.chars().all(|ch| ch.is_ascii_hexdigit()),
+ "commit hash must be a hex string"
+ );
+ debug_assert!(
+ hash.len() == 40 || hash.len() == 64,
+ "hex string must be generated from sha1 or sha256"
+ );
+ hash.to_string()
+ });
 
  Ok(Rustc {
  path,
@@ -88,6 +101,7 @@ impl Rustc {
  verbose_version,
  version,
  host,
+ commit_hash,
  cache: Mutex::new(cache),
  })
  }