Contract and harness for as_ptr, cast, as_mut_ptr, and as_non_null_ptr #126
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
zhassan-aws
reviewed
Oct 22, 2024
|
@zhassan-aws , I have made the required changes based on your feedback. Kindly review it again. |
zhassan-aws
reviewed
Nov 11, 2024
Dhvani-Kapadia
force-pushed
the
dhvani_ptr
branch
from
f151222
to
9bd3888
Compare
|
I made the changes and the contracts were successful. ` VERIFICATION:- SUCCESSFUL Complete - 4 successfully verified harnesses, 0 failures, 4 total.` |
robdockins
reviewed
Nov 19, 2024
…-rust-std into dhvani_ptr trying merge with main
This reverts commit 43e579e. "incorrect fixing indentation"
zhassan-aws
reviewed
Nov 25, 2024
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
Co-authored-by: Zyad Hassan <88045115+zhassan-aws@users.noreply.github.com>
zhassan-aws
approved these changes
Nov 27, 2024
|
@zhassan-aws , I have resolved the conflicts. Thanks for helping revert the submodule! |
|
trigger approval workflow |
zhassan-aws
approved these changes
Nov 27, 2024
zhassan-aws
reviewed
Nov 27, 2024
tautschnig
reviewed
Nov 28, 2024
tautschnig
approved these changes
Nov 28, 2024
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.
Description
This PR includes contracts and proof harnesses for the four APIs as_ptr, cast, as_mut_ptr, and as_non_null_ptr which are part of the NonNull library in Rust.
Changes Overview:
Covered APIs:
NonNull::as_ptr: Acquires the underlying *mut pointer
NonNull::cast: Casts to a pointer of another type
NonNull:: as_mut_ptr: Returns raw pointer to array's buffer
NonNull::as_non_null_ptr: Returns a non-null pointer to slice's buffer
Proof harness:
non_null_check_as_ptr
non_null_check_cast
non_null_check_as_mut_ptr
non_null_check_as_non_null_ptr
Revalidation
To revalidate the verification results, run kani verify-std -Z unstable-options "path/to/library" -Z function-contracts -Z mem-predicates --harness ptr::non_null::verify. This will run all four harnesses in the module. All default checks should pass:
Resolves #53
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.