bootstrap: use internment instead of hand-rolled interning

Author: GrigorenkoPV

src/bootstrap/Cargo.lock

@@ -2,6 +2,18 @@
 # It is not intended for manual editing.
 version = 3
 
+[[package]]
+name = "ahash"
+version = "0.8.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e89da841a80418a9b391ebaea17f5c112ffaaa96f621d2c285b5174da76b9011"
+dependencies = [
+ "cfg-if",
+ "once_cell",
+ "version_check",
+ "zerocopy",
+]
+
 [[package]]
 name = "aho-corasick"
 version = "1.1.3"
@@ -11,6 +23,12 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "allocator-api2"
+version = "0.2.18"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c6cb57a04249c6480766f7f7cef5467412af1490f8d1e243141daddada3264f"
+
 [[package]]
 name = "anstyle"
 version = "1.0.8"
@@ -44,6 +62,7 @@ dependencies = [
  "fd-lock",
  "home",
  "ignore",
+ "internment",
  "junction",
  "libc",
  "object",
@@ -272,6 +291,16 @@ dependencies = [
  "regex-syntax",
 ]
 
+[[package]]
+name = "hashbrown"
+version = "0.14.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1"
+dependencies = [
+ "ahash",
+ "allocator-api2",
+]
+
 [[package]]
 name = "heck"
 version = "0.5.0"
@@ -303,6 +332,15 @@ dependencies = [
  "winapi-util",
 ]
 
+[[package]]
+name = "internment"
+version = "0.8.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d7f54d755e2513c46a29d3c06fed25aa5d2008252469266055797f331a71aa42"
+dependencies = [
+ "hashbrown",
+]
+
 [[package]]
 name = "itoa"
 version = "1.0.11"
@@ -383,6 +421,12 @@ dependencies = [
  "memchr",
 ]
 
+[[package]]
+name = "once_cell"
+version = "1.20.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "33ea5043e58958ee56f3e15a90aee535795cd7dfd319846288d93c5b57d85cbe"
+
 [[package]]
 name = "opener"
 version = "0.5.2"
@@ -827,3 +871,23 @@ name = "yansi"
 version = "0.5.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec"
+
+[[package]]
+name = "zerocopy"
+version = "0.7.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0"
+dependencies = [
+ "zerocopy-derive",
+]
+
+[[package]]
+name = "zerocopy-derive"
+version = "0.7.35"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "syn",
+]

src/bootstrap/Cargo.toml

@@ -45,6 +45,7 @@ clap = { version = "4.4", default-features = false, features = ["std", "usage",
 clap_complete = "4.4"
 fd-lock = "4.0"
 home = "0.5"
+internment = "0.8.5"
 ignore = "0.4"
 libc = "0.2"
 object = { version = "0.36.3", default-features = false, features = ["archive", "coff", "read_core", "unaligned"] }

src/bootstrap/src/core/config/config.rs

@@ -22,7 +22,7 @@ use crate::core::build_steps::compile::CODEGEN_BACKEND_PREFIX;
 use crate::core::build_steps::llvm;
 pub use crate::core::config::flags::Subcommand;
 use crate::core::config::flags::{Color, Flags, Warnings};
-use crate::utils::cache::{Interned, INTERNER};
+use crate::utils::cache::Interned;
 use crate::utils::channel::{self, GitInfo};
 use crate::utils::helpers::{self, exe, output, t};
 
@@ -446,15 +446,21 @@ impl std::str::FromStr for RustcLto {
     }
 }
 
-#[derive(Copy, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
+#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
 // N.B.: This type is used everywhere, and the entire codebase relies on it being Copy.
 // Making !Copy is highly nontrivial!
 pub struct TargetSelection {
-    pub triple: Interned<String>,
-    file: Option<Interned<String>>,
+    pub triple: Interned<str>,
+    file: Option<Interned<str>>,
     synthetic: bool,
 }
 
+impl Default for TargetSelection {
+    fn default() -> Self {
+        Self { triple: "".into(), file: Default::default(), synthetic: Default::default() }
+    }
+}
+
 /// Newtype over `Vec<TargetSelection>` so we can implement custom parsing logic
 #[derive(Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
 pub struct TargetSelectionList(Vec<TargetSelection>);
@@ -481,18 +487,14 @@ impl TargetSelection {
             (selection, None)
         };
 
-        let triple = INTERNER.intern_str(triple);
-        let file = file.map(|f| INTERNER.intern_str(f));
+        let triple: Interned<str> = triple.into();
+        let file: Option<Interned<str>> = file.map(|f| f.into());
 
         Self { triple, file, synthetic: false }
     }
 
     pub fn create_synthetic(triple: &str, file: &str) -> Self {
-        Self {
-            triple: INTERNER.intern_str(triple),
-            file: Some(INTERNER.intern_str(file)),
-            synthetic: true,
-        }
+        Self { triple: triple.into(), file: Some(file.into()), synthetic: true }
     }
 
     pub fn rustc_target_arg(&self) -> &str {
@@ -552,15 +554,15 @@ impl fmt::Debug for TargetSelection {
 
 impl PartialEq<&str> for TargetSelection {
     fn eq(&self, other: &&str) -> bool {
-        self.triple == *other
+        &*self.triple == *other
     }
 }
 
 // Targets are often used as directory names throughout bootstrap.
 // This impl makes it more ergonomics to use them as such.
 impl AsRef<Path> for TargetSelection {
     fn as_ref(&self) -> &Path {
-        self.triple.as_ref()
+        (*self.triple).as_ref()
     }
 }
 
@@ -2067,7 +2069,7 @@ impl Config {
         //   thus, disabled
         // - similarly, lld will not be built nor used by default when explicitly asked not to, e.g.
         //   when the config sets `rust.lld = false`
-        if config.build.triple == "x86_64-unknown-linux-gnu"
+        if &*config.build.triple == "x86_64-unknown-linux-gnu"
             && config.hosts == [config.build]
             && (config.channel == "dev" || config.channel == "nightly")
         {

src/bootstrap/src/utils/cache.rs

@@ -1,198 +1,10 @@
 use std::any::{Any, TypeId};
-use std::borrow::Borrow;
 use std::cell::RefCell;
-use std::cmp::Ordering;
 use std::collections::HashMap;
-use std::hash::{Hash, Hasher};
-use std::marker::PhantomData;
-use std::ops::Deref;
-use std::path::PathBuf;
-use std::sync::{LazyLock, Mutex};
-use std::{fmt, mem};
 
 use crate::core::builder::Step;
 
-pub struct Interned<T>(usize, PhantomData<*const T>);
-
-impl<T: Internable + Default> Default for Interned<T> {
-    fn default() -> Self {
-        T::default().intern()
-    }
-}
-
-impl<T> Copy for Interned<T> {}
-impl<T> Clone for Interned<T> {
-    fn clone(&self) -> Interned<T> {
-        *self
-    }
-}
-
-impl<T> PartialEq for Interned<T> {
-    fn eq(&self, other: &Self) -> bool {
-        self.0 == other.0
-    }
-}
-impl<T> Eq for Interned<T> {}
-
-impl PartialEq<str> for Interned<String> {
-    fn eq(&self, other: &str) -> bool {
-        *self == other
-    }
-}
-impl<'a> PartialEq<&'a str> for Interned<String> {
-    fn eq(&self, other: &&str) -> bool {
-        **self == **other
-    }
-}
-impl<'a, T> PartialEq<&'a Interned<T>> for Interned<T> {
-    fn eq(&self, other: &&Self) -> bool {
-        self.0 == other.0
-    }
-}
-impl<'a, T> PartialEq<Interned<T>> for &'a Interned<T> {
-    fn eq(&self, other: &Interned<T>) -> bool {
-        self.0 == other.0
-    }
-}
-
-unsafe impl<T> Send for Interned<T> {}
-unsafe impl<T> Sync for Interned<T> {}
-
-impl fmt::Display for Interned<String> {
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        let s: &str = self;
-        f.write_str(s)
-    }
-}
-
-impl<T, U: ?Sized + fmt::Debug> fmt::Debug for Interned<T>
-where
-    Self: Deref<Target = U>,
-{
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        let s: &U = self;
-        f.write_fmt(format_args!("{s:?}"))
-    }
-}
-
-impl<T: Internable + Hash> Hash for Interned<T> {
-    fn hash<H: Hasher>(&self, state: &mut H) {
-        let l = T::intern_cache().lock().unwrap();
-        l.get(*self).hash(state)
-    }
-}
-
-impl<T: Internable + Deref> Deref for Interned<T> {
-    type Target = T::Target;
-    fn deref(&self) -> &Self::Target {
-        let l = T::intern_cache().lock().unwrap();
-        unsafe { mem::transmute::<&Self::Target, &Self::Target>(l.get(*self)) }
-    }
-}
-
-impl<T: Internable + AsRef<U>, U: ?Sized> AsRef<U> for Interned<T> {
-    fn as_ref(&self) -> &U {
-        let l = T::intern_cache().lock().unwrap();
-        unsafe { mem::transmute::<&U, &U>(l.get(*self).as_ref()) }
-    }
-}
-
-impl<T: Internable + PartialOrd> PartialOrd for Interned<T> {
-    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
-        let l = T::intern_cache().lock().unwrap();
-        l.get(*self).partial_cmp(l.get(*other))
-    }
-}
-
-impl<T: Internable + Ord> Ord for Interned<T> {
-    fn cmp(&self, other: &Self) -> Ordering {
-        let l = T::intern_cache().lock().unwrap();
-        l.get(*self).cmp(l.get(*other))
-    }
-}
-
-struct TyIntern<T: Clone + Eq> {
-    items: Vec<T>,
-    set: HashMap<T, Interned<T>>,
-}
-
-impl<T: Hash + Clone + Eq> Default for TyIntern<T> {
-    fn default() -> Self {
-        TyIntern { items: Vec::new(), set: Default::default() }
-    }
-}
-
-impl<T: Hash + Clone + Eq> TyIntern<T> {
-    fn intern_borrow<B>(&mut self, item: &B) -> Interned<T>
-    where
-        B: Eq + Hash + ToOwned<Owned = T> + ?Sized,
-        T: Borrow<B>,
-    {
-        if let Some(i) = self.set.get(item) {
-            return *i;
-        }
-        let item = item.to_owned();
-        let interned = Interned(self.items.len(), PhantomData::<*const T>);
-        self.set.insert(item.clone(), interned);
-        self.items.push(item);
-        interned
-    }
-
-    fn intern(&mut self, item: T) -> Interned<T> {
-        if let Some(i) = self.set.get(&item) {
-            return *i;
-        }
-        let interned = Interned(self.items.len(), PhantomData::<*const T>);
-        self.set.insert(item.clone(), interned);
-        self.items.push(item);
-        interned
-    }
-
-    fn get(&self, i: Interned<T>) -> &T {
-        &self.items[i.0]
-    }
-}
-
-#[derive(Default)]
-pub struct Interner {
-    strs: Mutex<TyIntern<String>>,
-    paths: Mutex<TyIntern<PathBuf>>,
-    lists: Mutex<TyIntern<Vec<String>>>,
-}
-
-trait Internable: Clone + Eq + Hash + 'static {
-    fn intern_cache() -> &'static Mutex<TyIntern<Self>>;
-
-    fn intern(self) -> Interned<Self> {
-        Self::intern_cache().lock().unwrap().intern(self)
-    }
-}
-
-impl Internable for String {
-    fn intern_cache() -> &'static Mutex<TyIntern<Self>> {
-        &INTERNER.strs
-    }
-}
-
-impl Internable for PathBuf {
-    fn intern_cache() -> &'static Mutex<TyIntern<Self>> {
-        &INTERNER.paths
-    }
-}
-
-impl Internable for Vec<String> {
-    fn intern_cache() -> &'static Mutex<TyIntern<Self>> {
-        &INTERNER.lists
-    }
-}
-
-impl Interner {
-    pub fn intern_str(&self, s: &str) -> Interned<String> {
-        self.strs.lock().unwrap().intern_borrow(s)
-    }
-}
-
-pub static INTERNER: LazyLock<Interner> = LazyLock::new(Interner::default);
+pub type Interned<T> = internment::Intern<T>;
 
 /// This is essentially a `HashMap` which allows storing any type in its input and
 /// any type in its output. It is a write-once cache; values are never evicted,