-
Notifications
You must be signed in to change notification settings - Fork 12.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use only one shard with a single thread #111755
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,6 @@ | ||
use crate::fx::{FxHashMap, FxHasher}; | ||
#[cfg(parallel_compiler)] | ||
use crate::sync::is_dyn_thread_safe; | ||
use crate::sync::{CacheAligned, Lock, LockGuard}; | ||
use std::borrow::Borrow; | ||
use std::collections::hash_map::RawEntryMut; | ||
|
@@ -18,6 +20,11 @@ pub const SHARDS: usize = 1 << SHARD_BITS; | |
|
||
/// An array of cache-line aligned inner locked structures with convenience methods. | ||
pub struct Sharded<T> { | ||
/// This mask is used to ensure that accesses are inbounds of `shards`. | ||
/// When dynamic thread safety is off, this field is set to 0 causing only | ||
/// a single shard to be used for greater cache efficiency. | ||
#[cfg(parallel_compiler)] | ||
mask: usize, | ||
shards: [CacheAligned<Lock<T>>; SHARDS], | ||
} | ||
|
||
|
@@ -31,31 +38,54 @@ impl<T: Default> Default for Sharded<T> { | |
impl<T> Sharded<T> { | ||
#[inline] | ||
pub fn new(mut value: impl FnMut() -> T) -> Self { | ||
Sharded { shards: [(); SHARDS].map(|()| CacheAligned(Lock::new(value()))) } | ||
Sharded { | ||
#[cfg(parallel_compiler)] | ||
mask: if is_dyn_thread_safe() { SHARDS - 1 } else { 0 }, | ||
shards: [(); SHARDS].map(|()| CacheAligned(Lock::new(value()))), | ||
} | ||
} | ||
|
||
#[inline(always)] | ||
fn mask(&self) -> usize { | ||
#[cfg(parallel_compiler)] | ||
{ | ||
if SHARDS == 1 { 0 } else { self.mask } | ||
} | ||
#[cfg(not(parallel_compiler))] | ||
{ | ||
0 | ||
} | ||
} | ||
|
||
#[inline(always)] | ||
fn count(&self) -> usize { | ||
// `self.mask` is always one below the used shard count | ||
self.mask() + 1 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This needs a reminder that |
||
} | ||
|
||
/// The shard is selected by hashing `val` with `FxHasher`. | ||
#[inline] | ||
pub fn get_shard_by_value<K: Hash + ?Sized>(&self, val: &K) -> &Lock<T> { | ||
if SHARDS == 1 { &self.shards[0].0 } else { self.get_shard_by_hash(make_hash(val)) } | ||
self.get_shard_by_hash(if SHARDS == 1 { 0 } else { make_hash(val) }) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we return There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It gets masked by 0 later, so it doesn't matter. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you make this a branch over There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Assuming you mean |
||
} | ||
|
||
#[inline] | ||
pub fn get_shard_by_hash(&self, hash: u64) -> &Lock<T> { | ||
&self.shards[get_shard_index_by_hash(hash)].0 | ||
self.get_shard_by_index(get_shard_hash(hash)) | ||
} | ||
|
||
#[inline] | ||
pub fn get_shard_by_index(&self, i: usize) -> &Lock<T> { | ||
&self.shards[i].0 | ||
// SAFETY: The index get ANDed with the mask, ensuring it is always inbounds. | ||
unsafe { &self.shards.get_unchecked(i & self.mask()).0 } | ||
} | ||
|
||
pub fn lock_shards(&self) -> Vec<LockGuard<'_, T>> { | ||
(0..SHARDS).map(|i| self.shards[i].0.lock()).collect() | ||
(0..self.count()).map(|i| self.get_shard_by_index(i).lock()).collect() | ||
} | ||
|
||
pub fn try_lock_shards(&self) -> Option<Vec<LockGuard<'_, T>>> { | ||
(0..SHARDS).map(|i| self.shards[i].0.try_lock()).collect() | ||
(0..self.count()).map(|i| self.get_shard_by_index(i).try_lock()).collect() | ||
} | ||
} | ||
|
||
|
@@ -136,11 +166,9 @@ pub fn make_hash<K: Hash + ?Sized>(val: &K) -> u64 { | |
/// `hash` can be computed with any hasher, so long as that hasher is used | ||
/// consistently for each `Sharded` instance. | ||
#[inline] | ||
#[allow(clippy::modulo_one)] | ||
pub fn get_shard_index_by_hash(hash: u64) -> usize { | ||
fn get_shard_hash(hash: u64) -> usize { | ||
let hash_len = mem::size_of::<usize>(); | ||
// Ignore the top 7 bits as hashbrown uses these and get the next SHARD_BITS highest bits. | ||
// hashbrown also uses the lowest bits, so we can't use those | ||
let bits = (hash >> (hash_len * 8 - 7 - SHARD_BITS)) as usize; | ||
bits % SHARDS | ||
(hash >> (hash_len * 8 - 7 - SHARD_BITS)) as usize | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mask
needs a comment explaining what it's for.