fix(cordyceps): pin list::IterMut items
#209
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, there is a potential safety issue when using `cordyceps::list::IterMut`: the iterator's item type is `&mut T`. `&mut T`s may be `mem::replace`d or `mem::take`en, moving them out of the list to a different memory location. This would invalidate any pointers in the list that point to that node. Therefore, to ensure that the mutable iterator cannot corrupt the list (potentially leading to dangling pointers or use-after-frees), this PR changes `list::IterMut`'s `Item` type from `&'list mut T` to `Pin<&'list mut T`. This ensures that the iterator cannot be used to corrupt the list.
|
No objections from me. It might make sense to do a sit-down review together at some point, and figure out all the ownership/iteration requirements for List? it seems like there's been a couple of conceptual issues that have popped up, it might make sense to make the high level docs/reqs more clear so it's easier to review on this. |
Signed-off-by: Eliza Weisman <[email protected]>
hawkw
added a commit
that referenced
this pull request
Jun 23, 2022
Currently, the `Item` type of `list::CursorMut`'s `Iterator` impl is `&mut T`. This is incorrect, as it allows the items to be moved out of the list without unlinking them. Instead, the iterator's item type must be `Pin`ned. PR #209 made this change for the `IterMut` type, but did not make the same change for `CursorMut`, so this commit fixes `CursorMut` similarly. BREAKING CHANGE: This changes the type signature of the `Iterator` impl for `list::CursorMut`.
hawkw
added a commit
that referenced
this pull request
Jun 23, 2022
Currently, the `Item` type of `list::CursorMut`'s `Iterator` impl is `&mut T`. This is incorrect, as it allows the items to be moved out of the list without unlinking them. Instead, the iterator's item type must be `Pin`ned. PR #209 made this change for the `IterMut` type, but did not make the same change for `CursorMut`, so this commit fixes `CursorMut` similarly. BREAKING CHANGE: This changes the type signature of the `Iterator` impl for `list::CursorMut`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, there is a potential safety issue when using
cordyceps::list::IterMut: the iterator's item type is&mut T.&mut Ts may bemem::replaced ormem::takeen, moving them out ofthe list to a different memory location. This would invalidate any
pointers in the list that point to that node.
Therefore, to ensure that the mutable iterator cannot corrupt the list
(potentially leading to dangling pointers or use-after-frees), this PR
changes
list::IterMut'sItemtype from&'list mut TtoPin<&'list mut T. This ensures that the iterator cannot be used tocorrupt the list.