feat: maximize artifact reuse between different modes.

As of this writing, it aims to reuse `rmeta` between build and check modes.
(one emits rmeta + rlib, and the other emits rmeta)

This has a caveat that `DefId` in rmeta files might not match between rustc
invocations with different `--emits` values, and that might lead to rustc
rejecting the input rmeta. To avoid failures in rustc, this is currently
guarded by fingerprint to ensure all output files present, if not, rerun.
This make running `check` after `build` safe: `build`'s rmeta files might
have more information and rustc is correct on rejection.

Author: weihanglo

src/cargo/core/compiler/build_config.rs

@@ -250,6 +250,26 @@ impl CompileMode {
     pub fn generates_executable(self) -> bool {
         matches!(self, CompileMode::Test | CompileMode::Build)
     }
+
+    /// Maximizes artifact reuse between different modes.
+    ///
+    /// As of this writing, it aims to reuse `rmeta` between build and check modes.
+    /// (one emits rmeta + rlib, and the other emits rmeta)
+    ///
+    /// This has a caveat that `DefId` in rmeta files might not match between rustc
+    /// invocations with different `--emits` values, and that might lead to rustc
+    /// rejecting the input rmeta. To avoid failures in rustc, this is currently
+    /// guarded by fingerprint to ensure all output files present, if not, rerun.
+    /// This make running `check` after `build` safe: `build`'s rmeta files might
+    /// have more information and rustc is correct on rejection.
+    pub fn for_reuse(self) -> CompileMode {
+        match self {
+            // We might want to reuse `Test` and `Check { test: true }`,
+            // but those are usually local so dont bother it
+            CompileMode::Build | CompileMode::Check { test: false } => CompileMode::Build,
+            m => m,
+        }
+    }
 }
 
 /// Represents the high-level operation requested by the user.

src/cargo/core/compiler/build_runner/compilation_files.rs

@@ -650,7 +650,7 @@ fn compute_metadata(
     // `panic=abort` and `panic=unwind` artifacts, additionally with various
     // settings like debuginfo and whatnot.
     unit.profile.hash(&mut shared_hasher);
-    unit.mode.hash(&mut shared_hasher);
+    unit.mode.for_reuse().hash(&mut shared_hasher);
     build_runner.lto[unit].hash(&mut shared_hasher);
 
     // Artifacts compiled for the host should have a different

src/cargo/core/compiler/build_runner/mod.rs

@@ -604,6 +604,8 @@ impl<'a, 'gctx> BuildRunner<'a, 'gctx> {
                         // See https://github.com/rust-lang/rust/issues/56169
                         // and https://github.com/rust-lang/rust/issues/61378
                         report_collision(unit, other_unit, &output.path, rustdoc_suggestion)?;
+                    } else if unit.mode.for_reuse() == other_unit.mode.for_reuse() {
+                        tracing::debug!("reusing artifacts between {unit:?} and {other_unit:?}");
                     } else {
                         report_collision(unit, other_unit, &output.path, suggestion)?;
                     }

src/cargo/core/compiler/fingerprint/mod.rs

@@ -1537,7 +1537,7 @@ fn calculate_normal(
 
     let profile_hash = util::hash_u64((
         &unit.profile,
-        unit.mode,
+        unit.mode.for_reuse(),
         build_runner.bcx.extra_args_for(unit),
         build_runner.lto[unit],
         unit.pkg.manifest().lint_rustflags(),

tests/testsuite/artifact_dep.rs

@@ -2416,7 +2416,7 @@ fn doc_lib_true() {
 
     // Verify that it emits rmeta for the bin and lib dependency.
     assert_eq!(p.glob("target/debug/artifact/*.rlib").count(), 0);
-    assert_eq!(p.glob("target/debug/deps/libbar-*.rmeta").count(), 2);
+    assert_eq!(p.glob("target/debug/deps/libbar-*.rmeta").count(), 1);
 
     p.cargo("doc -Z bindeps")
         .masquerade_as_nightly_cargo(&["bindeps"])

tests/testsuite/collisions.rs

@@ -404,7 +404,6 @@ fn collision_doc_profile_split() {
     p.cargo("doc")
         .with_stderr_data(
             str![[r#"
-[CHECKING] common v1.0.0
 [DOCUMENTING] common v1.0.0
 [DOCUMENTING] pm v0.1.0 ([ROOT]/foo/pm)
 [DOCUMENTING] foo v0.1.0 ([ROOT]/foo)

tests/testsuite/freshness.rs

@@ -3210,8 +3210,7 @@ fn rmeta_reuse() {
 
     p.cargo("check --verbose")
         .with_stderr_data(str![[r#"
-[CHECKING] foo v0.0.0 ([ROOT]/foo)
-[RUNNING] `rustc [..]`
+[FRESH] foo v0.0.0 ([ROOT]/foo)
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s
 
 "#]])
@@ -3229,6 +3228,7 @@ fn rmeta_reuse() {
 
     p.cargo("build --verbose")
         .with_stderr_data(str![[r#"
+[DIRTY] foo v0.0.0 ([ROOT]/foo): couldn't read metadata for file `target/debug/deps/libfoo-[HASH].rlib`
 [COMPILING] foo v0.0.0 ([ROOT]/foo)
 [RUNNING] `rustc [..]`
 [FINISHED] `dev` profile [unoptimized + debuginfo] target(s) in [ELAPSED]s