Skip to content

fix potential unsoundness in retain #229

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.

Sign up for GitHub

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

Merged
sunshowers merged 1 commit into from
Nov 22, 2025
+57 −36
Merged

fix potential unsoundness in retain #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 14 additions & 9 deletions crates/iddqd/src/bi_hash_map/imp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1927,19 +1927,24 @@ impl<T: BiHashItem, S: Clone + BuildHasher, A: Allocator> BiHashMap<T, S, A> {
([MapHash::new(hash1), MapHash::new(hash2)], dormant_item)
};

// SAFETY: The original items is no longer used after the first
// block above.
let items = unsafe { dormant_items.awaken() };
// SAFETY: The original item is no longer used after the second
// block above.
let item = unsafe { dormant_item.awaken() };

let hash2 = hashes[1].hash();
let retain = {
// SAFETY: The original item is no longer used after the second
// block above. dormant_items, from which item is derived, is
// currently dormant.
let item = unsafe { dormant_item.awaken() };

let ref_mut = RefMut::new(hash_state.clone(), hashes, item);
f(ref_mut)
};

let ref_mut = RefMut::new(hash_state.clone(), hashes, item);
if f(ref_mut) {
if retain {
true
} else {
// SAFETY: The original items is no longer used after the first
// block above, and item + dormant_item have been dropped after
// being used above.
let items = unsafe { dormant_items.awaken() };
items.remove(index);
let k2_entry = self
.tables
Expand Down
23 changes: 14 additions & 9 deletions crates/iddqd/src/id_hash_map/imp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1341,17 +1341,22 @@ impl<T: IdHashItem, S: Clone + BuildHasher, A: Allocator> IdHashMap<T, S, A> {
(MapHash::new(hash), dormant_item)
};

// SAFETY: The original items is no longer used after the first
// block above.
let items = unsafe { dormant_items.awaken() };
// SAFETY: The original item is no longer used after the second
// block above.
let item = unsafe { dormant_item.awaken() };

let ref_mut = RefMut::new(hash_state.clone(), hash, item);
if f(ref_mut) {
let retain = {
// SAFETY: The original item is no longer used after the second
// block above. dormant_items, from which item is derived, is
// currently dormant.
let item = unsafe { dormant_item.awaken() };

let ref_mut = RefMut::new(hash_state.clone(), hash, item);
f(ref_mut)
};

if retain {
true
} else {
// SAFETY: The original items is no longer used after the first
// block above, and item + dormant item have been used above.
let items = unsafe { dormant_items.awaken() };
items.remove(index);
false
}
Expand Down
24 changes: 15 additions & 9 deletions crates/iddqd/src/id_ord_map/imp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1329,17 +1329,23 @@ impl<T: IdOrdItem> IdOrdMap<T> {
(MapHash::new(hash), dormant_item)
};

// SAFETY: The original items is no longer used after the first
// block above.
let items = unsafe { dormant_items.awaken() };
// SAFETY: The original item is no longer used after the second
// block above.
let item = unsafe { dormant_item.awaken() };

let ref_mut = RefMut::new(hash_state.clone(), hash, item);
if f(ref_mut) {
let retain = {
// SAFETY: The original item is no longer used after the second
// block above. dormant_items, from which item is derived, is
// currently dormant.
let item = unsafe { dormant_item.awaken() };

let ref_mut = RefMut::new(hash_state.clone(), hash, item);
f(ref_mut)
};

if retain {
true
} else {
// SAFETY: The original items is no longer used after the first
// block above, and item + dormant_item have been dropped after
// being used above.
let items = unsafe { dormant_items.awaken() };
items.remove(index);
false
}
Expand Down
23 changes: 14 additions & 9 deletions crates/iddqd/src/tri_hash_map/imp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2586,20 +2586,25 @@ impl<T: TriHashItem, S: Clone + BuildHasher, A: Allocator> TriHashMap<T, S, A> {
)
};

// SAFETY: The original items is no longer used after the first
// block above.
let items = unsafe { dormant_items.awaken() };
// SAFETY: The original item is no longer used after the second
// block above.
let item = unsafe { dormant_item.awaken() };

let hash2 = hashes[1].hash();
let hash3 = hashes[2].hash();
let retain = {
// SAFETY: The original item is no longer used after the second
// block above. dormant_items, from which item is derived, is
// currently dormant.
let item = unsafe { dormant_item.awaken() };

let ref_mut = RefMut::new(hash_state.clone(), hashes, item);
f(ref_mut)
};

let ref_mut = RefMut::new(hash_state.clone(), hashes, item);
if f(ref_mut) {
if retain {
true
} else {
// SAFETY: The original items is no longer used after the first
// block above, and item + dormant_item have been dropped after
// being used above.
let items = unsafe { dormant_items.awaken() };
items.remove(index);
let k2_entry = self
.tables
Expand Down
Loading