mirrors/salsa
1
0
Fork 0
mirror of https://github.com/salsa-rs/salsa.git synced 2025-02-02 09:46:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge #412

Browse source 
412: Fix race condition in interned data r=nikomatsakis a=Skepfyr

In some scenarios the `InternedIngredient` could return two different ids for the same data if called in parallel.

Co-authored-by: Jack Rickard <jack.rickard@outlook.com>
This commit is contained in:
bors[bot] 2022-09-27 22:48:54 +00:00 committed by GitHub
commit 30b5e9760a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

78
components/salsa-2022/src/interned.rs
View file

@ -32,12 +32,12 @@ pub struct InternedIngredient<Id: InternedId, Data: InternedData> {
/// Maps from data to the existing interned id for that data.
///
/// Deadlock requirement: We access `key_map` while holding lock on `value_map`, but not vice versa.
/// Deadlock requirement: We access `value_map` while holding lock on `key_map`, but not vice versa.
key_map: FxDashMap<Data, Id>,
/// Maps from an interned id to its data.
///
/// Deadlock requirement: We access `key_map` while holding lock on `value_map`, but not vice versa.
/// Deadlock requirement: We access `value_map` while holding lock on `key_map`, but not vice versa.
value_map: FxDashMap<Id, Box<Data>>,
/// counter for the next id.
@ -83,23 +83,26 @@ where
self.reset_at,
);
// Optimisation to only get read lock on the map if the data has already
// been interned.
if let Some(id) = self.key_map.get(&data) {
return *id;
}
loop {
let next_id = self.counter.fetch_add(1);
let next_id = Id::from_id(crate::id::Id::from_u32(next_id));
match self.value_map.entry(next_id) {
// If we already have an entry with this id...
dashmap::mapref::entry::Entry::Occupied(_) => continue,
// Otherwise...
dashmap::mapref::entry::Entry::Vacant(entry) => {
self.key_map.insert(data.clone(), next_id);
entry.insert(Box::new(data));
return next_id;
}
match self.key_map.entry(data.clone()) {
// Data has been interned by a racing call, use that ID instead
dashmap::mapref::entry::Entry::Occupied(entry) => *entry.get(),
// We won any races so should intern the data
dashmap::mapref::entry::Entry::Vacant(entry) => {
let next_id = self.counter.fetch_add(1);
let next_id = Id::from_id(crate::id::Id::from_u32(next_id));
let old_value = self.value_map.insert(next_id, Box::new(data));
assert!(
old_value.is_none(),
"next_id is guaranteed to be unique, bar overflow"
);
entry.insert(next_id);
next_id
}
}
}
@ -145,33 +148,32 @@ where
///
/// # Warning
///
/// This should only be used when you are certain that the given `id` has not (and will not)
/// be used in the current revision. More specifically, this is used when a query `Q` executes
/// and we can compare the entities `E_now` that it produced in this revision vs the entities
/// `E_prev` it produced in the last revision. Any missing entities `E_prev - E_new` can be
/// deleted.
/// This should only be used when you are certain that:
/// 1. The given `id` has not (and will not) be used in the current revision.
/// 2. The interned data corresponding to `id` will not be interned in this revision.
///
/// More specifically, this is used when a query `Q` executes and we can compare the
/// entities `E_now` that it produced in this revision vs the entities `E_prev` it
/// produced in the last revision. Any missing entities `E_prev - E_new` can be deleted.
///
/// If you are wrong about this, it should not be unsafe, but unpredictable results may occur.
pub(crate) fn delete_index(&self, id: Id) {
match self.value_map.entry(id) {
dashmap::mapref::entry::Entry::Vacant(_) => {
panic!("No entry for id `{:?}`", id);
}
dashmap::mapref::entry::Entry::Occupied(entry) => {
self.key_map.remove(entry.get());
let (_, key) = self
.value_map
.remove(&id)
.unwrap_or_else(|| panic!("No entry for id `{:?}`", id));
// Careful: even though `id` ought not to have been used in this revision,
// we don't know that for sure since users could have leaked things. If they did,
// they may have stray references into `data`. So push the box onto the
// "to be deleted" queue.
//
// To avoid this, we could include some kind of atomic counter in the `Box` that
// gets set whenever `data` executes, so we can track if the data was accessed since
// the last time an `&mut self` method was called. But that'd take extra storage
// and doesn't obviously seem worth it.
self.deleted_entries.push(entry.remove());
}
}
self.key_map.remove(&key);
// Careful: even though `id` ought not to have been used in this revision,
// we don't know that for sure since users could have leaked things. If they did,
// they may have stray references into `data`. So push the box onto the
// "to be deleted" queue.
//
// To avoid this, we could include some kind of atomic counter in the `Box` that
// gets set whenever `data` executes, so we can track if the data was accessed since
// the last time an `&mut self` method was called. But that'd take extra storage
// and doesn't obviously seem worth it.
self.deleted_entries.push(key);
}
pub(crate) fn clear_deleted_indices(&mut self) {