|
| 1 | +use std::borrow::Borrow; |
| 2 | +use std::hash::{BuildHasher, Hash, Hasher}; |
| 3 | +use std::hint::cold_path; |
| 4 | +use std::ops::{Deref, DerefMut}; |
| 5 | + |
| 6 | +use horde::collect::{Pin, pin}; |
| 7 | +pub use horde::sync_table::Read; |
| 8 | +use horde::sync_table::Write; |
| 9 | +use rustc_hash::FxBuildHasher; |
| 10 | + |
| 11 | +use crate::sync::{DynSync, Lock, LockGuard, Mode}; |
| 12 | + |
| 13 | +pub struct SyncTable<K, V> { |
| 14 | + // We use this lock to protect `table` instead of the internal mutex in `horde::SyncTable` |
| 15 | + // as it's faster when synchronization is disabled. |
| 16 | + lock: Lock<()>, |
| 17 | + |
| 18 | + table: horde::SyncTable<K, V, FxBuildHasher>, |
| 19 | +} |
| 20 | + |
| 21 | +unsafe impl<K: DynSync, V: DynSync> DynSync for SyncTable<K, V> where FxBuildHasher: Sync {} |
| 22 | + |
| 23 | +impl<K, V> Default for SyncTable<K, V> { |
| 24 | + fn default() -> Self { |
| 25 | + Self { lock: Lock::default(), table: horde::SyncTable::default() } |
| 26 | + } |
| 27 | +} |
| 28 | + |
| 29 | +impl<K, V> SyncTable<K, V> { |
| 30 | + /// Creates a [Read] handle from a pinned region. |
| 31 | + /// |
| 32 | + /// Use [horde::collect::pin] to get a `Pin` instance. |
| 33 | + #[inline] |
| 34 | + pub fn read<'a>(&'a self, pin: Pin<'a>) -> Read<'a, K, V, FxBuildHasher> { |
| 35 | + self.table.read(pin) |
| 36 | + } |
| 37 | + |
| 38 | + /// Creates a [LockedWrite] handle by taking the underlying mutex that protects writes. |
| 39 | + #[inline] |
| 40 | + pub fn lock(&self) -> LockedWrite<'_, K, V> { |
| 41 | + LockedWrite { |
| 42 | + _guard: self.lock.lock(), |
| 43 | + table: { |
| 44 | + // SAFETY: We ensure there's only 1 writer at a time using our own lock |
| 45 | + unsafe { self.table.unsafe_write() } |
| 46 | + }, |
| 47 | + } |
| 48 | + } |
| 49 | + |
| 50 | + /// Creates a [LockedWrite] handle by taking the underlying mutex that protects writes. |
| 51 | + /// |
| 52 | + /// This does not prune old tables unlike `lock`. |
| 53 | + #[inline] |
| 54 | + pub fn lock_no_prune(&self) -> LockedWrite<'_, K, V> { |
| 55 | + LockedWrite { |
| 56 | + _guard: self.lock.lock(), |
| 57 | + table: { |
| 58 | + // SAFETY: We ensure there's only 1 writer at a time using our own lock |
| 59 | + unsafe { self.table.unsafe_write_no_prune() } |
| 60 | + }, |
| 61 | + } |
| 62 | + } |
| 63 | + |
| 64 | + /// Hashes a key with the table's hasher. |
| 65 | + #[inline] |
| 66 | + pub fn hash_key<Q>(&self, key: &Q) -> u64 |
| 67 | + where |
| 68 | + K: Borrow<Q>, |
| 69 | + Q: ?Sized + Hash, |
| 70 | + { |
| 71 | + self.table.hash_key::<Q>(key) |
| 72 | + } |
| 73 | + |
| 74 | + pub fn len(&self) -> usize { |
| 75 | + pin(|pin| self.read(pin).len()) |
| 76 | + } |
| 77 | + |
| 78 | + pub fn with_capacity(cap: usize) -> Self { |
| 79 | + Self { lock: Lock::new(()), table: horde::SyncTable::new_with(FxBuildHasher, cap) } |
| 80 | + } |
| 81 | +} |
| 82 | + |
| 83 | +/// A handle to a [SyncTable] with write access protected by a lock. |
| 84 | +pub struct LockedWrite<'a, K, V> { |
| 85 | + table: Write<'a, K, V, FxBuildHasher>, |
| 86 | + _guard: LockGuard<'a, ()>, |
| 87 | +} |
| 88 | + |
| 89 | +impl<'a, K, V> Deref for LockedWrite<'a, K, V> { |
| 90 | + type Target = Write<'a, K, V, FxBuildHasher>; |
| 91 | + |
| 92 | + #[inline] |
| 93 | + fn deref(&self) -> &Self::Target { |
| 94 | + &self.table |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +impl<'a, K, V> DerefMut for LockedWrite<'a, K, V> { |
| 99 | + #[inline] |
| 100 | + fn deref_mut(&mut self) -> &mut Self::Target { |
| 101 | + &mut self.table |
| 102 | + } |
| 103 | +} |
| 104 | + |
| 105 | +pub trait IntoPointer { |
| 106 | + /// Returns a pointer which outlives `self`. |
| 107 | + fn into_pointer(&self) -> *const (); |
| 108 | +} |
| 109 | + |
| 110 | +impl<K: Eq + Hash + Copy> SyncTable<K, ()> { |
| 111 | + pub fn contains_pointer_to<T: Hash + IntoPointer>(&self, value: &T) -> bool |
| 112 | + where |
| 113 | + K: IntoPointer, |
| 114 | + { |
| 115 | + pin(|pin| { |
| 116 | + let mut state = FxBuildHasher.build_hasher(); |
| 117 | + value.hash(&mut state); |
| 118 | + let hash = state.finish(); |
| 119 | + let value = value.into_pointer(); |
| 120 | + self.read(pin).get_from_hash(hash, |entry| entry.into_pointer() == value).is_some() |
| 121 | + }) |
| 122 | + } |
| 123 | + |
| 124 | + #[inline] |
| 125 | + pub fn intern_ref<Q: ?Sized>(&self, value: &Q, make: impl FnOnce() -> K) -> K |
| 126 | + where |
| 127 | + K: Borrow<Q>, |
| 128 | + Q: Hash + Eq, |
| 129 | + { |
| 130 | + if self.lock.mode() == Mode::Sync { |
| 131 | + pin(|pin| { |
| 132 | + let hash = self.hash_key(value); |
| 133 | + |
| 134 | + let potential = match self.read(pin).get_potential(&value, Some(hash)) { |
| 135 | + Ok(entry) => return *entry.0, |
| 136 | + Err(potential) => { |
| 137 | + cold_path(); |
| 138 | + potential |
| 139 | + } |
| 140 | + }; |
| 141 | + |
| 142 | + let mut write = self.lock(); |
| 143 | + |
| 144 | + let potential = match potential.refresh(self.read(pin), &value, Some(hash)) { |
| 145 | + Ok(entry) => { |
| 146 | + cold_path(); |
| 147 | + return *entry.0; |
| 148 | + } |
| 149 | + Err(potential) => potential, |
| 150 | + }; |
| 151 | + |
| 152 | + let result = make(); |
| 153 | + |
| 154 | + potential.insert_new(&mut write, result, (), Some(hash)); |
| 155 | + |
| 156 | + result |
| 157 | + }) |
| 158 | + } else { |
| 159 | + let mut write = self.lock_no_prune(); |
| 160 | + |
| 161 | + let hash = self.hash_key(&value); |
| 162 | + |
| 163 | + let entry = write.read().get(&value, Some(hash)); |
| 164 | + if let Some(entry) = entry { |
| 165 | + return *entry.0; |
| 166 | + } |
| 167 | + write.prune(); |
| 168 | + |
| 169 | + let result = make(); |
| 170 | + |
| 171 | + write.insert_new(result, (), Some(hash)); |
| 172 | + |
| 173 | + result |
| 174 | + } |
| 175 | + } |
| 176 | + |
| 177 | + #[inline] |
| 178 | + pub fn intern<Q>(&self, value: Q, make: impl FnOnce(Q) -> K) -> K |
| 179 | + where |
| 180 | + K: Borrow<Q>, |
| 181 | + Q: Hash + Eq, |
| 182 | + { |
| 183 | + if self.lock.mode() == Mode::Sync { |
| 184 | + pin(|pin| { |
| 185 | + let hash = self.hash_key(&value); |
| 186 | + |
| 187 | + let potential = match self.read(pin).get_potential(&value, Some(hash)) { |
| 188 | + Ok(entry) => return *entry.0, |
| 189 | + Err(potential) => { |
| 190 | + cold_path(); |
| 191 | + potential |
| 192 | + } |
| 193 | + }; |
| 194 | + |
| 195 | + let mut write = self.lock(); |
| 196 | + |
| 197 | + let potential = match potential.refresh(self.read(pin), &value, Some(hash)) { |
| 198 | + Ok(entry) => { |
| 199 | + cold_path(); |
| 200 | + return *entry.0; |
| 201 | + } |
| 202 | + Err(potential) => potential, |
| 203 | + }; |
| 204 | + |
| 205 | + let result = make(value); |
| 206 | + |
| 207 | + potential.insert_new(&mut write, result, (), Some(hash)); |
| 208 | + |
| 209 | + result |
| 210 | + }) |
| 211 | + } else { |
| 212 | + let mut write = self.lock_no_prune(); |
| 213 | + |
| 214 | + let hash = self.hash_key(&value); |
| 215 | + |
| 216 | + let entry = write.read().get(&value, Some(hash)); |
| 217 | + if let Some(entry) = entry { |
| 218 | + return *entry.0; |
| 219 | + } |
| 220 | + write.prune(); |
| 221 | + |
| 222 | + let result = make(value); |
| 223 | + |
| 224 | + write.insert_new(result, (), Some(hash)); |
| 225 | + |
| 226 | + result |
| 227 | + } |
| 228 | + } |
| 229 | +} |
0 commit comments