avoid magical AsRef<Path> implementation

Signed-off-by: onur-ozkan <[email protected]>

Author: onur-ozkan

src/bootstrap/src/core/build_steps/clean.rs

@@ -147,7 +147,7 @@ fn clean_default(build: &Build) {
     rm_rf(&build.out.join("dist"));
     rm_rf(&build.out.join("bootstrap").join(".last-warned-change-id"));
     rm_rf(&build.out.join("bootstrap-shims-dump"));
-    rm_rf(BuildStamp::new(&build.out).with_prefix("rustfmt").as_ref());
+    rm_rf(BuildStamp::new(&build.out).with_prefix("rustfmt").path());
 
     let mut hosts: Vec<_> = build.hosts.iter().map(|t| build.out.join(t)).collect();
     // After cross-compilation, artifacts of the host architecture (which may differ from build.host)

src/bootstrap/src/core/build_steps/compile.rs

@@ -991,7 +991,7 @@ impl Step for Rustc {
             true, // Only ship rustc_driver.so and .rmeta files, not all intermediate .rlib files.
         );
 
-        let target_root_dir = stamp.as_ref().parent().unwrap();
+        let target_root_dir = stamp.path().parent().unwrap();
         // When building `librustc_driver.so` (like `libLLVM.so`) on linux, it can contain
         // unexpected debuginfo from dependencies, for example from the C++ standard library used in
         // our LLVM wrapper. Unless we're explicitly requesting `librustc_driver` to be built with
@@ -1478,7 +1478,7 @@ impl Step for CodegenBackend {
         }
         let stamp = build_stamp::codegen_backend_stamp(builder, compiler, target, &backend);
         let codegen_backend = codegen_backend.to_str().unwrap();
-        t!(fs::write(stamp, codegen_backend));
+        t!(stamp.add_stamp(codegen_backend).write());
     }
 }
 
@@ -1516,7 +1516,7 @@ fn copy_codegen_backends_to_sysroot(
         }
 
         let stamp = build_stamp::codegen_backend_stamp(builder, compiler, target, backend);
-        let dylib = t!(fs::read_to_string(&stamp));
+        let dylib = t!(fs::read_to_string(stamp.path()));
         let file = Path::new(&dylib);
         let filename = file.file_name().unwrap().to_str().unwrap();
         // change `librustc_codegen_cranelift-xxxxxx.so` to
@@ -2018,7 +2018,7 @@ pub fn run_cargo(
     rlib_only_metadata: bool,
 ) -> Vec<PathBuf> {
     // `target_root_dir` looks like $dir/$target/release
-    let target_root_dir = stamp.as_ref().parent().unwrap();
+    let target_root_dir = stamp.path().parent().unwrap();
     // `target_deps_dir` looks like $dir/$target/release/deps
     let target_deps_dir = target_root_dir.join("deps");
     // `host_root_dir` looks like $dir/release
@@ -2171,7 +2171,7 @@ pub fn run_cargo(
         new_contents.extend(dep.to_str().unwrap().as_bytes());
         new_contents.extend(b"\0");
     }
-    t!(fs::write(stamp, &new_contents));
+    t!(fs::write(stamp.path(), &new_contents));
     deps.into_iter().map(|(d, _)| d).collect()
 }
 

src/bootstrap/src/core/build_steps/format.rs

@@ -82,7 +82,7 @@ fn update_rustfmt_version(build: &Builder<'_>) {
     let Some((version, stamp_file)) = get_rustfmt_version(build) else {
         return;
     };
-    t!(std::fs::write(stamp_file, version))
+    t!(std::fs::write(stamp_file.path(), version))
 }
 
 /// Returns the Rust files modified between the `merge-base` of HEAD and

src/bootstrap/src/core/build_steps/gcc.rs

@@ -58,14 +58,14 @@ pub fn prebuilt_gcc_config(builder: &Builder<'_>, target: TargetSelection) -> Gc
     let stamp = BuildStamp::new(&out_dir).with_prefix("gcc").add_stamp(smart_stamp_hash);
 
     if stamp.is_up_to_date() {
-        if stamp.stamp.is_empty() {
+        if stamp.stamp().is_empty() {
             builder.info(
                 "Could not determine the GCC submodule commit hash. \
                      Assuming that an GCC rebuild is not necessary.",
             );
             builder.info(&format!(
                 "To force GCC to rebuild, remove the file `{}`",
-                stamp.as_ref().display()
+                stamp.path().display()
             ));
         }
         return GccBuildStatus::AlreadyBuilt;

src/bootstrap/src/core/build_steps/llvm.rs

@@ -138,14 +138,14 @@ pub fn prebuilt_llvm_config(
     let stamp = BuildStamp::new(&out_dir).with_prefix("llvm").add_stamp(smart_stamp_hash);
 
     if stamp.is_up_to_date() {
-        if stamp.stamp.is_empty() {
+        if stamp.stamp().is_empty() {
             builder.info(
                 "Could not determine the LLVM submodule commit hash. \
                      Assuming that an LLVM rebuild is not necessary.",
             );
             builder.info(&format!(
                 "To force LLVM to rebuild, remove the file `{}`",
-                stamp.as_ref().display()
+                stamp.path().display()
             ));
         }
         return LlvmBuildStatus::AlreadyBuilt(res);
@@ -924,14 +924,14 @@ impl Step for Enzyme {
         let stamp = BuildStamp::new(&out_dir).with_prefix("enzyme").add_stamp(smart_stamp_hash);
 
         if stamp.is_up_to_date() {
-            if stamp.stamp.is_empty() {
+            if stamp.stamp().is_empty() {
                 builder.info(
                     "Could not determine the Enzyme submodule commit hash. \
                      Assuming that an Enzyme rebuild is not necessary.",
                 );
                 builder.info(&format!(
                     "To force Enzyme to rebuild, remove the file `{}`",
-                    stamp.as_ref().display()
+                    stamp.path().display()
                 ));
             }
             return out_dir;
@@ -1016,7 +1016,7 @@ impl Step for Lld {
         let out_dir = builder.lld_out(target);
 
         let done_stamp = BuildStamp::new(&out_dir).with_prefix("lld");
-        if done_stamp.as_ref().exists() {
+        if done_stamp.path().exists() {
             return out_dir;
         }
 
@@ -1140,10 +1140,10 @@ impl Step for Sanitizers {
         let stamp = BuildStamp::new(&out_dir).with_prefix("sanitizers").add_stamp(smart_stamp_hash);
 
         if stamp.is_up_to_date() {
-            if stamp.stamp.is_empty() {
+            if stamp.stamp().is_empty() {
                 builder.info(&format!(
                     "Rebuild sanitizers by removing the file `{}`",
-                    stamp.as_ref().display()
+                    stamp.path().display()
                 ));
             }
 

src/bootstrap/src/lib.rs

@@ -1605,16 +1605,16 @@ Executed at: {executed_at}"#,
             return Vec::new();
         }
 
-        if !stamp.as_ref().exists() {
+        if !stamp.path().exists() {
             eprintln!(
                 "ERROR: Unable to find the stamp file {}, did you try to keep a nonexistent build stage?",
-                stamp.as_ref().display()
+                stamp.path().display()
             );
             crate::exit!(1);
         }
 
         let mut paths = Vec::new();
-        let contents = t!(fs::read(stamp.as_ref()), stamp.as_ref());
+        let contents = t!(fs::read(stamp.path()), stamp.path());
         // This is the method we use for extracting paths from the stamp file passed to us. See
         // run_cargo for more information (in compile.rs).
         for part in contents.split(|b| *b == 0) {

src/bootstrap/src/utils/build_stamp.rs

@@ -20,13 +20,7 @@ mod tests;
 #[derive(Clone)]
 pub struct BuildStamp {
     path: PathBuf,
-    pub(crate) stamp: String,
-}
-
-impl AsRef<Path> for BuildStamp {
-    fn as_ref(&self) -> &Path {
-        &self.path
-    }
+    stamp: String,
 }
 
 impl BuildStamp {
@@ -40,6 +34,20 @@ impl BuildStamp {
         Self { path: dir.join(".stamp"), stamp: String::new() }
     }
 
+    /// Returns path of the stamp file.
+    pub fn path(&self) -> &Path {
+        &self.path
+    }
+
+    /// Returns the value of the stamp.
+    ///
+    /// Note that this is empty by default and is populated using `BuildStamp::add_stamp`.
+    /// It is not read from an actual file, but rather it holds the value that will be used
+    /// when `BuildStamp::write` is called.
+    pub fn stamp(&self) -> &str {
+        &self.stamp
+    }
+
     /// Sets stamp content to the specified value.
     pub fn add_stamp<S: ToString>(mut self, stamp: S) -> Self {
         self.stamp.push_str(&stamp.to_string());
@@ -101,15 +109,15 @@ impl BuildStamp {
 pub fn clear_if_dirty(builder: &Builder<'_>, dir: &Path, input: &Path) -> bool {
     let stamp = BuildStamp::new(dir);
     let mut cleared = false;
-    if mtime(stamp.as_ref()) < mtime(input) {
+    if mtime(stamp.path()) < mtime(input) {
         builder.verbose(|| println!("Dirty - {}", dir.display()));
         let _ = fs::remove_dir_all(dir);
         cleared = true;
-    } else if stamp.as_ref().exists() {
+    } else if stamp.path().exists() {
         return cleared;
     }
     t!(fs::create_dir_all(dir));
-    t!(fs::File::create(stamp));
+    t!(fs::File::create(stamp.path()));
     cleared
 }