Skip to content

Fix unsoundness of Debug implementation for linked_list::IterMut #85814

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

Merged
merged 2 commits into from
May 31, 2021
Merged
Changes from all commits
Commits
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
27 changes: 20 additions & 7 deletions library/alloc/src/collections/linked_list.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,15 @@ pub struct Iter<'a, T: 'a> {
#[stable(feature = "collection_debug", since = "1.17.0")]
impl<T: fmt::Debug> fmt::Debug for Iter<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_tuple("Iter").field(&self.len).finish()
f.debug_tuple("Iter")
.field(&*mem::ManuallyDrop::new(LinkedList {
head: self.head,
tail: self.tail,
len: self.len,
marker: PhantomData,
}))
.field(&self.len)
.finish()
}
}

Expand All @@ -82,19 +90,24 @@ impl<T> Clone for Iter<'_, T> {
/// documentation for more.
#[stable(feature = "rust1", since = "1.0.0")]
pub struct IterMut<'a, T: 'a> {
// We do *not* exclusively own the entire list here, references to node's `element`
// have been handed out by the iterator! So be careful when using this; the methods
// called must be aware that there can be aliasing pointers to `element`.
list: &'a mut LinkedList<T>,
head: Option<NonNull<Node<T>>>,
tail: Option<NonNull<Node<T>>>,
len: usize,
marker: PhantomData<&'a mut Node<T>>,
}

#[stable(feature = "collection_debug", since = "1.17.0")]
impl<T: fmt::Debug> fmt::Debug for IterMut<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_tuple("IterMut").field(&self.list).field(&self.len).finish()
f.debug_tuple("IterMut")
.field(&*mem::ManuallyDrop::new(LinkedList {
head: self.head,
tail: self.tail,
len: self.len,
marker: PhantomData,
}))
.field(&self.len)
.finish()
}
}

Expand Down Expand Up @@ -493,7 +506,7 @@ impl<T> LinkedList<T> {
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
pub fn iter_mut(&mut self) -> IterMut<'_, T> {
IterMut { head: self.head, tail: self.tail, len: self.len, list: self }
IterMut { head: self.head, tail: self.tail, len: self.len, marker: PhantomData }
}

/// Provides a cursor at the front element.
Expand Down