Contracts & Harnesses for len, is_empty, is_aligned, and is_aligned_to #128
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
celinval
reviewed
Oct 22, 2024
QinyuanWu
reviewed
Oct 25, 2024
@Jimmycreative See pointer generator documentation here: https://model-checking.github.io/kani/crates/doc/kani/struct.PointerGenerator.html |
celinval
reviewed
Oct 31, 2024
celinval
reviewed
Nov 19, 2024
There was a problem hiding this comment.
It looks good. Can you please ensure that calling is_aligned_to with a invalid alignment value (not power of two) will not trigger UB. One way you could do that is to write a regular harness, i.e., a #[kani::proof] instead of #[kani::proof_for_contract(<func>)] so Kani does not assume the pre-condition. If the harness fails due to panic, you can add a #[kani::should_panic] to the harness.
carolynzech
approved these changes
Nov 22, 2024
Co-authored-by: Carolyn Zech <cmzech@amazon.com>
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.
Towards #53
Changes
added contract and harness for len, is_empty, is_aligned, and is_aligned_to in the non-null library.