forked from rust-lang/rust
-
Notifications
You must be signed in to change notification settings - Fork 53
Propose a new challenge about pointer arithmetic ops #23
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
celinval
merged 5 commits into
model-checking:main
from
celinval:challenge-0003-ptr-arith
Jul 3, 2024
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
e1db022
Add a new challenge about pointer arithmetic ops
celinval 5d5fa0b
Apply suggestions from code review
celinval fbac065
Update doc/src/challenges/0003-pointer-arithmentic.md
celinval 8a32992
Merge branch 'main' into challenge-0003-ptr-arith
celinval e4f13e5
Merge branch 'main' into challenge-0003-ptr-arith
celinval 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,107 @@ | ||
# Challenge 3: Verifying Raw Pointer Arithmetic Operations | ||
|
||
- **Status:** Open | ||
- **Solution:** | ||
- **Tracking Issue:** <https://github.com/model-checking/verify-rust-std/issues/21> | ||
- **Start date:** 24/06/24 | ||
- **End date:** 24/12/10 | ||
|
||
------------------- | ||
|
||
|
||
## Goal | ||
|
||
The goal of this challenge is to verify safety of code that relies on raw pointer arithmetic, and eventual | ||
raw pointer access. | ||
celinval marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Motivation | ||
|
||
Raw pointer arithmetic is a common operation employed in the implementation of highly optimized code, | ||
as well as containers with dynamic size. | ||
Examples of the former are `str::repeat`, `[u8]::is_ascii`, | ||
while for the latter we have `Vec`, `VecDeque`, `HashMap`. | ||
|
||
These unsafe operations are usually abstracted from the end user with the usage of | ||
[safe abstractions](https://doc.rust-lang.org/beta/book/ch19-01-unsafe-rust.html#creating-a-safe-abstraction-over-unsafe-code). | ||
However, bugs in these abstractions may compromise entire applications, potentially becoming a security concern. | ||
See [CVE-2018-1000810](https://www.cvedetails.com/cve/CVE-2018-1000810/) for an example of an issue with an | ||
optimization of `str::repeat`. | ||
|
||
These safe abstractions are great candidates for software verification. | ||
They are critical for Rust applications safety, and they are modular by design. | ||
|
||
## Description | ||
|
||
Rust provides different options for pointer arithmetic, which have different semantics when it comes to safety. | ||
For example, methods such as [`ptr::offset`](https://doc.rust-lang.org/std/primitive.pointer.html#method.offset), | ||
[`ptr::add`](https://doc.rust-lang.org/std/primitive.pointer.html#method.add), | ||
and [`ptr::sub`](https://doc.rust-lang.org/std/primitive.pointer.html#method.sub) | ||
are unsafe, and one of their safety conditions is that: | ||
> - Both the starting and resulting pointer must be either in bounds or one byte past the end of the same allocated object. | ||
|
||
I.e., violating this safety condition triggers immediate UB. | ||
|
||
On the other hand, wrapping operations such as | ||
[`ptr::wrapping_offset`](https://doc.rust-lang.org/std/primitive.pointer.html#method.wrapping_offset), | ||
[`ptr::wrapping_add`](https://doc.rust-lang.org/std/primitive.pointer.html#method.wrapping_add), | ||
[`ptr::wrapping_sub`](https://doc.rust-lang.org/std/primitive.pointer.html#method.wrapping_sub), | ||
are safe, however, the resulting pointer must not be used to read or write other allocated objects. | ||
celinval marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Thus, we would like to be able to verify usage of these different methods within the standard library | ||
to ensure they are safely employed, | ||
as well as provide function contracts that can be used by other Rust crates to verify their own usage of these methods. | ||
|
||
### Assumptions | ||
|
||
For this challenge, we do not require a full proof that is independent of the pointee type `T`. | ||
Instead, we require that the verification is done for the following pointee types: | ||
1. All integer types. | ||
2. At least one `dyn Trait`. | ||
3. At least one slice. | ||
4. For unit type. | ||
5. At least one composite type with multiple non-ZST fields. | ||
|
||
### Success Criteria | ||
|
||
All the following unsafe functions must be annotated with safety contracts and the contracts have been verified: | ||
|
||
| Function | Location | | ||
|-----------------------------|----------| | ||
| *const T::add | core::ptr | | ||
| *const T::sub | core::ptr | | ||
| *const T::offset | core::ptr | | ||
| *const T::offset_from | core::ptr | | ||
| *const T::byte_add | core::ptr | | ||
| *const T::byte_sub | core::ptr | | ||
| *const T::byte_offset | core::ptr | | ||
| *const T::byte_offset_from | core::ptr | | ||
| *mut T::add | core::ptr | | ||
| *mut T::sub | core::ptr | | ||
| *mut T::offset | core::ptr | | ||
| *mut T::offset_from | core::ptr | | ||
| *mut T::byte_add | core::ptr | | ||
| *mut T::byte_sub | core::ptr | | ||
| *mut T::byte_offset | core::ptr | | ||
| *mut T::byte_offset_from | core::ptr | | ||
|
||
At least 3 of the following usages were proven safe: | ||
|
||
| Function | Location | | ||
|-------------------|---------------| | ||
| \[u8\]::is_asc_ii | core::slice | | ||
| String::remove | alloc::string | | ||
| Vec::swap_remove | alloc::vec | | ||
| Option::as_slice | core::option | | ||
| VecDeque::swap | collections::vec_deque | | ||
|
||
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. | ||
- Performing a place projection that violates the requirements of in-bounds pointer arithmetic. | ||
A place projection is a field expression, a tuple index expression, or an array/slice index expression. | ||
- Invoking undefined behavior via compiler intrinsics. | ||
- Producing an invalid value, even in private fields and locals. | ||
|
||
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.