-
Notifications
You must be signed in to change notification settings - Fork 126
Update kani::mem
pointer validity documentation
#4092
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
Merged
+6
−19
Conversation
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
kani::mem
pointer validity ruleskani::mem
pointer validity documentation
zhassan-aws
approved these changes
May 27, 2025
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 9, 2025
These are the automatically-generated release notes: ``` ## What's Changed * Toolchain upgrade to nightly-2025-05-04 by @thanhnguyen-aws in #4059 * Automatic toolchain upgrade to nightly-2025-05-05 by @github-actions in #4060 * Automatic toolchain upgrade to nightly-2025-05-06 by @github-actions in #4061 * Enable target features: x87 and sse2 by @thanhnguyen-aws in #4062 * Fix the bug: Loop contracts are not composable with function contracts by @thanhnguyen-aws in #3979 * Automatic cargo update to 2025-05-12 by @github-actions in #4066 * Bump tests/perf/s2n-quic from `6aa9975` to `5f323b7` by @dependabot in #4068 * Fix stabilization instructions in RFC intro by @carolynzech in #4067 * Add support for quantifiers by @qinheping in #3993 * Toolchain upgrade to nightly-2025-05-07 by @thanhnguyen-aws in #4070 * Automatic toolchain upgrade to nightly-2025-05-08 by @github-actions in #4071 * Automatic toolchain upgrade to nightly-2025-05-09 by @github-actions in #4072 * Automatic toolchain upgrade to nightly-2025-05-10 by @github-actions in #4073 * Clippy/Stylistic Fixes by @carolynzech in #4074 * Upgrade toolchain to 2025-05-14 by @zhassan-aws in #4076 * Autoharness argument validation: only error on `--quiet` if `--list` was passed by @carolynzech in #4069 * Upgrade Rust toolchain to 2025-05-16 by @zhassan-aws in #4080 * Automatic toolchain upgrade to nightly-2025-05-17 by @github-actions in #4081 * Add setup scripts for Ubuntu 20.04 by @zhassan-aws in #4082 * Automatic toolchain upgrade to nightly-2025-05-18 by @github-actions in #4083 * Automatic cargo update to 2025-05-19 by @github-actions in #4086 * Automatic toolchain upgrade to nightly-2025-05-19 by @github-actions in #4085 * Automatic toolchain upgrade to nightly-2025-05-20 by @github-actions in #4091 * Bump tests/perf/s2n-quic from `5f323b7` to `22434aa` by @dependabot in #4089 * Fix the error that Kani panics when there is no external parameter in quantifier's closure. by @thanhnguyen-aws in #4088 * Update toolchain to 2025-05-22 by @carolynzech in #4098 * Use our toolchain when invoking `cargo metadata` by @carolynzech in #4090 * Automatic toolchain upgrade to nightly-2025-05-23 by @github-actions in #4099 * Automatic toolchain upgrade to nightly-2025-05-24 by @github-actions in #4101 * Automatic toolchain upgrade to nightly-2025-05-25 by @github-actions in #4102 * Fix a bug codegening `SwitchInt`s with only an otherwise branch by @bkirwi in #4095 * Automatic toolchain upgrade to nightly-2025-05-26 by @github-actions in #4104 * Automatic cargo update to 2025-05-26 by @github-actions in #4105 * Bump tests/perf/s2n-quic from `22434aa` to `550afb3` by @dependabot in #4106 * Automatic toolchain upgrade to nightly-2025-05-27 by @github-actions in #4107 * Update `kani::mem` pointer validity documentation by @carolynzech in #4092 * Add support for edition 2018 crates using assert! (Fixes #3717) by @sintemal in #4096 * Automatic toolchain upgrade to nightly-2025-05-28 by @github-actions in #4113 * Automatic toolchain upgrade to nightly-2025-05-29 by @github-actions in #4115 * Automatic toolchain upgrade to nightly-2025-05-30 by @github-actions in #4118 * Handle generic defaults in BoundedArbitrary derives by @zhassan-aws in #4117 * Automatic cargo update to 2025-06-02 by @github-actions in #4121 * Bump tests/perf/s2n-quic from `550afb3` to `8f54b57` by @dependabot in #4122 * Upgrade Rust toolchain to 2025-06-02 by @zhassan-aws in #4123 * Automatic toolchain upgrade to nightly-2025-06-03 by @github-actions in #4125 * Finish deprecating `--enable-unstable`, `--restrict-vtable`, and `--write-json-symtab` by @carolynzech in #4110 * `ty_mangled_name`: only use non-mangled name if `-Zcffi` is enabled. by @carolynzech in #4114 * Improve Help Menu by @carolynzech in #4109 * Start stabilizing `--jobs` and `list`; deprecate default memory checks by @carolynzech in #4108 * Refactor simd_bitmask to reduce the number of iterations by @zhassan-aws in #4129 * Set target features depending on the target architecture by @zhassan-aws in #4127 * Bump some versions suggested by cargo-outdated by @zhassan-aws in #4131 * Improve linking error output for `#[no_std]` crates by @AlexanderPortland in #4126 * Fix the git log command in the toolchain update script by @zhassan-aws in #4139 * Gate quantifiers behind an experimental feature by @thanhnguyen-aws in #4141 * Automatic cargo update to 2025-06-09 by @github-actions in #4145 ## New Contributors * @bkirwi made their first contribution in #4095 * @sintemal made their first contribution in #4096 * @AlexanderPortland made their first contribution in #4126 **Full Changelog**: kani-0.62.0...kani-0.63.0 ``` By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses. --------- Co-authored-by: Carolyn Zech <carolynzech@gmail.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.
https://github.com/rust-lang/rust/pull/117329/files#diff-c175d4e27676febf62c061d31cf9756d256b46e2e44cc6b3177d4ff75e932567L18-L29 changed the pointer safety documentation. We changed our models accordingly:
kani/library/kani_core/src/mem.rs
Lines 186 to 190 in 92bc45d
but forgot to update the documentation.
See https://doc.rust-lang.org/beta/core/ptr/index.html for the current documentation; the point of this PR is to 1) update our docs to match this reference and 2) state which of the points Kani can verify.
Resolves #4087
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.