Repository navigation
New challenge: Verify the safety of BinaryHeap functions #747
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
Open
Kieran-Hulsman
wants to merge
2
commits into
model-checking:main
Choose a base branch
from
Kieran-Hulsman:kieran/binary-heap-challenge
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| # Challenge 31: Verify the safety of `BinaryHeap` functions | ||
|
|
||
| - **Status:** *Open* | ||
| - **Solution:** *Option field to point to the PR that solved this challenge.* | ||
| - **Tracking Issue:** [#746](https://github.com/model-checking/verify-rust-std/issues/746) | ||
| - **Start date:** *2026/11/03* | ||
| - **Reward:** *TBD* | ||
|
|
||
| ------------------- | ||
|
|
||
|
|
||
| ## Goal | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
|
|
||
| Verify the safety of `BinaryHeap` functions in [binary_heap/mod.rs](https://github.com/model-checking/verify-rust-std/blob/main/library/alloc/src/collections/binary_heap/mod.rs). | ||
|
|
||
| ## Motivation | ||
|
|
||
| `BinaryHeap` is the priority queue of the standard library. To keep its elements in heap order, it moves them with raw pointer reads and copies, at positions chosen by comparing elements with `Ord`. `Ord` is safe code written by users and can return any result, so these moves must be safe even when the comparisons are inconsistent. | ||
|
|
||
| ## Description | ||
|
|
||
| This challenge verifies the safety of `BinaryHeap`'s sift functions, `PeekMut`, the `TrustedLen` sorted iterators, and the safe methods built on them. The sifts move elements through `Hole`, which reads one element out with `ptr::read`, copies others into the gap with `ptr::copy_nonoverlapping` at positions chosen by `Ord`, and writes the element back in `Drop`. `PeekMut` shrinks the length to 1 while a `&mut T` to the top element is out. | ||
|
|
||
| The other `unsafe impl`s on `IntoIter` (`TrustedFused`, `SourceIter`, `InPlaceIterable`, `AsVecIntoIter`) delegate to `vec::IntoIter` and are out of scope for this challenge. | ||
|
|
||
| ### Assumptions | ||
|
|
||
| * `Vec`'s implementation may be assumed correct, and its existing verified contracts may be reused. | ||
| * A panicking `Ord` is out of scope: solutions need not verify unwinding through `Drop for Hole`. | ||
|
|
||
| ### Success Criteria | ||
|
|
||
| Write and prove the contract for the safety of the following unsafe functions: | ||
|
|
||
| | Function | | ||
| |---------| | ||
| |Hole::new| | ||
| |Hole::get| | ||
| |Hole::move_to| | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
| |sift_up| | ||
| |sift_down_range| | ||
| |sift_down| | ||
| |sift_down_to_bottom| | ||
|
|
||
| Prove that the following implementations of the unsafe trait `TrustedLen` are correct, that is, that `size_hint` returns the exact number of remaining elements: | ||
|
|
||
| | Implementation | | ||
| |---------| | ||
| |TrustedLen for IntoIterSorted| | ||
| |TrustedLen for DrainSorted| | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
|
|
||
| Prove the absence of undefined behavior for the following safe abstractions: | ||
|
|
||
| | Function | | ||
| |---------| | ||
| |push| | ||
| |pop| | ||
| |peek_mut| | ||
| |PeekMut::deref| | ||
| |PeekMut::deref_mut| | ||
| |PeekMut::pop| | ||
| |PeekMut::refresh| | ||
| |Drop for PeekMut| | ||
| |rebuild| | ||
| |rebuild_tail| | ||
| |append| | ||
| |into_sorted_vec| | ||
| |From<Vec<T>>| | ||
| |IntoIterSorted::next| | ||
| |DrainSorted::next| | ||
| |Drop for Hole| | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
|
|
||
| The unsafe functions `from_raw_vec` and `as_mut_slice` require callers to keep the contents a max-heap. This is a correctness requirement, not a safety one, so the functions above must be safe even when the contents are not a max-heap. | ||
|
|
||
| The verification must be unbounded---it must hold for heaps of arbitrary length. | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
|
|
||
| The verification must hold for generic type `T` (what satisfies this clause is to be decided in [issue #734](https://github.com/model-checking/verify-rust-std/issues/734)). | ||
|
|
||
| The verification must hold for any implementation of `Ord` for `T`, including ones that return inconsistent results. | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
|
|
||
| ### List of UBs | ||
|
|
||
| All proofs must automatically ensure the absence of the following undefined behaviors [ref](https://github.com/rust-lang/reference/blob/142b2ed77d33f37a9973772bd95e6144ed9dce43/src/behavior-considered-undefined.md): | ||
|
|
||
| * Accessing (loading from or storing to) a place that is dangling or based on a misaligned pointer. | ||
| * Invoking undefined behavior via compiler intrinsics. | ||
| * Reading from uninitialized memory except for padding or unions. | ||
| * Producing an invalid value | ||
|
feliperodri marked this conversation as resolved.
Resolved
|
||
|
|
||
|
|
||
| Note: All solutions to verification challenges need to satisfy the criteria established in the [challenge book](../general-rules.md) | ||
| in addition to the ones listed above. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.