-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into modifies_fat
- Loading branch information
Showing
13 changed files
with
265 additions
and
20 deletions.
There are no files selected for viewing
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| - **Feature Name:** Quantifiers | ||
| - **Feature Request Issue:** [#2546](https://github.com/model-checking/kani/issues/2546) and [#836](https://github.com/model-checking/kani/issues/836) | ||
| - **RFC PR:** [#](https://github.com/model-checking/kani/pull/) | ||
| - **Status:** Unstable | ||
| - **Version:** 1.0 | ||
|
|
||
| ------------------- | ||
|
|
||
| ## Summary | ||
|
|
||
| Quantifiers are logical operators that allow users to express that a property or condition applies to some or all objects within a given domain. | ||
|
|
||
| ## User Impact | ||
|
|
||
| There are two primary quantifiers: the existential quantifier (∃) and the universal quantifier (∀). | ||
|
|
||
| 1. The existential quantifier (∃): represents the statement "there exists." We use to express that there is at least one object in the domain that satisfies a given condition. For example, "∃x P(x)" means "there exists a value x such that P(x) is true." | ||
|
|
||
| 2. The universal quantifier (∀): represents the statement "for all" or "for every." We use it to express that a given condition is true for every object in the domain. For example, "∀x P(x)" means "for every value x, P(x) is true." | ||
|
|
||
| Rather than exhaustively listing all elements in a domain, quantifiers enable users to make statements about the entire domain at once. This compact representation is crucial when dealing with large or unbounded inputs. Quantifiers also facilitate abstraction and generalization of properties. Instead of specifying properties for specific instances, quantified properties can capture general patterns and behaviors that hold across different objects in a domain. Additionally, by replacing loops in the specification with quantifiers, Kani can encode the properties more efficiently within the specified bounds, making the verification process more manageable and computationally feasible. | ||
|
|
||
| This new feature doesn't introduce any breaking changes to users. It will only allow them to write properites using the existential (∃) and universal (∀) quantifiers. | ||
|
|
||
| ## User Experience | ||
|
|
||
| We propose a syntax inspired by ["Pattern Types"](https://github.com/rust-lang/rust/pull/120131). The syntax of existential (i.e., `kani::exists`) and universal (i.e., `kani::forall`) quantifiers are: | ||
|
|
||
| ```rust | ||
| kani::exists(|<var>: <type> [is <range-expr>] | <boolean-expression>) | ||
| kani::forall(|<var>: <type> [is <range-expr>] | <boolean-expression>) | ||
| ``` | ||
|
|
||
| If `<range-expr>` is not provided, we assume `<var>` can range over all possible values of the given `<type>` (i.e., syntactic sugar for full range `|<var>: <type> as .. |`). CBMC's SAT backend only supports bounded quantification under **constant** lower and upper bounds (for more details, see the [documentation for quantifiers in CBMC](https://diffblue.github.io/cbmc/contracts-quantifiers.html)). The SMT backend, on the other hand, supports arbitrary Boolean expressions. In any case, `<boolean-expression>` should not have side effects, as the purpose of quantifiers is to assert a condition over a domain of objects without altering the state. | ||
|
|
||
| Consider the following example adapted from the documentation for the [from_raw_parts](https://doc.rust-lang.org/std/vec/struct.Vec.html#method.from_raw_parts) function: | ||
|
|
||
| ```rust | ||
| use std::ptr; | ||
| use std::mem; | ||
|
|
||
| #[kani::proof] | ||
| fn main() { | ||
| let v = vec![kani::any::<usize>(); 100]; | ||
|
|
||
| // Prevent running `v`'s destructor so we are in complete control | ||
| // of the allocation. | ||
| let mut v = mem::ManuallyDrop::new(v); | ||
|
|
||
| // Pull out the various important pieces of information about `v` | ||
| let p = v.as_mut_ptr(); | ||
| let len = v.len(); | ||
| let cap = v.capacity(); | ||
|
|
||
| unsafe { | ||
| // Overwrite memory | ||
| for i in 0..len { | ||
| *p.add(i) += 1; | ||
| } | ||
|
|
||
| // Put everything back together into a Vec | ||
| let rebuilt = Vec::from_raw_parts(p, len, cap); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Given the `v` vector has non-deterministic values, there are potential arithmetic overflows that might happen in the for loop. So we need to constrain all values of the array. We may also want to check all values of `rebuilt` after the operation. Without quantifiers, we might be tempted to use loops as follows: | ||
|
|
||
| ```rust | ||
| use std::ptr; | ||
| use std::mem; | ||
|
|
||
| #[kani::proof] | ||
| fn main() { | ||
| let original_v = vec![kani::any::<usize>(); 100]; | ||
| let v = original_v.clone(); | ||
| for i in 0..v.len() { | ||
| kani::assume(v[i] < 5); | ||
| } | ||
|
|
||
| // Prevent running `v`'s destructor so we are in complete control | ||
| // of the allocation. | ||
| let mut v = mem::ManuallyDrop::new(v); | ||
|
|
||
| // Pull out the various important pieces of information about `v` | ||
| let p = v.as_mut_ptr(); | ||
| let len = v.len(); | ||
| let cap = v.capacity(); | ||
|
|
||
| unsafe { | ||
| // Overwrite memory | ||
| for i in 0..len { | ||
| *p.add(i) += 1; | ||
| } | ||
|
|
||
| // Put everything back together into a Vec | ||
| let rebuilt = Vec::from_raw_parts(p, len, cap); | ||
| for i in 0..len { | ||
| assert_eq!(rebuilt[i], original_v[i]+1); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This, however, might unnecessary increase the complexity of the verication process. We can achieve the same effect using quantifiers as shown below. | ||
|
|
||
| ```rust | ||
| use std::ptr; | ||
| use std::mem; | ||
|
|
||
| #[kani::proof] | ||
| fn main() { | ||
| let original_v = vec![kani::any::<usize>(); 3]; | ||
| let v = original_v.clone(); | ||
| kani::assume(kani::forall(|i: usize is ..v.len() | v[i] < 5)); | ||
|
|
||
| // Prevent running `v`'s destructor so we are in complete control | ||
| // of the allocation. | ||
| let mut v = mem::ManuallyDrop::new(v); | ||
|
|
||
| // Pull out the various important pieces of information about `v` | ||
| let p = v.as_mut_ptr(); | ||
| let len = v.len(); | ||
| let cap = v.capacity(); | ||
|
|
||
| unsafe { | ||
| // Overwrite memory | ||
| for i in 0..len { | ||
| *p.add(i) += 1; | ||
| } | ||
|
|
||
| // Put everything back together into a Vec | ||
| let rebuilt = Vec::from_raw_parts(p, len, cap); | ||
| assert!(kani::forall(|i: usize is ..len | rebuilt[i] == original_v[i]+1)); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The same principle applies if we want to use the existential quantifier. | ||
|
|
||
| ```rust | ||
| use std::ptr; | ||
| use std::mem; | ||
|
|
||
| #[kani::proof] | ||
| fn main() { | ||
| let original_v = vec![kani::any::<usize>(); 3]; | ||
| let v = original_v.clone(); | ||
| kani::assume(kani::forall(|i: usize is ..v.len() | v[i] < 5)); | ||
|
|
||
| // Prevent running `v`'s destructor so we are in complete control | ||
| // of the allocation. | ||
| let mut v = mem::ManuallyDrop::new(v); | ||
|
|
||
| // Pull out the various important pieces of information about `v` | ||
| let p = v.as_mut_ptr(); | ||
| let len = v.len(); | ||
| let cap = v.capacity(); | ||
|
|
||
| unsafe { | ||
| // Overwrite memory | ||
| for i in 0..len { | ||
| *p.add(i) += 1; | ||
| if i == 1 { | ||
| *p.add(i) = 0; | ||
| } | ||
| } | ||
|
|
||
| // Put everything back together into a Vec | ||
| let rebuilt = Vec::from_raw_parts(p, len, cap); | ||
| assert!(kani::exists(|i: usize is ..len | rebuilt[i] == 0)); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The usage of quantifiers should be valid in any part of the Rust code analysed by Kani. | ||
|
|
||
| ## Detailed Design | ||
|
|
||
| <!-- For the implementors or the hackers --> | ||
|
|
||
| Kani should have the same support that CBMC has for quantifiers. For more details, see [Quantifiers](https://github.com/diffblue/cbmc/blob/0a69a64e4481473d62496f9975730d24f194884a/doc/cprover-manual/contracts-quantifiers.md). | ||
|
|
||
|
|
||
| ## Open questions | ||
|
|
||
| <!-- For Developers --> | ||
| - **Function Contracts RFC** - CBMC has support for both `exists` and `forall`, but the | ||
| code generation is difficult. The most ergonomic and easy way to implement | ||
| quantifiers on the Rust side is as higher-order functions taking `Fn(T) -> | ||
| bool`, where `T` is some arbitrary type that can be quantified over. This | ||
| interface is familiar to developers, but the code generation is tricky, as | ||
| CBMC level quantifiers only allow certain kinds of expressions. This | ||
| necessitates a rewrite of the `Fn` closure to a compliant expression. | ||
| - Which kind of expressions should be accepted as a "compliant expression"? | ||
|
|
||
|
|
||
| ## Future possibilities | ||
|
|
||
| <!-- For Developers --> | ||
| - CBMC has an SMT backend which allows the use of quantifiers with arbitrary Boolean expressions. Kani must include an option for users to experiment with this backend. | ||
|
|
||
| --- |
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
6 changes: 6 additions & 0 deletions
6
tests/expected/function-contract/simple_ensures_pass_no_annotation.expected
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| assertion\ | ||
| - Status: SUCCESS\ | ||
| - Description: "|result| (*result == x) | (*result == y)"\ | ||
| in function max | ||
|
|
||
| VERIFICATION:- SUCCESSFUL |
14 changes: 14 additions & 0 deletions
14
tests/expected/function-contract/simple_ensures_pass_no_annotation.rs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| // Copyright Kani Contributors | ||
| // SPDX-License-Identifier: Apache-2.0 OR MIT | ||
| // kani-flags: -Zfunction-contracts | ||
|
|
||
| #[kani::ensures(|result| (*result == x) | (*result == y))] | ||
| fn max(x: u32, y: u32) -> u32 { | ||
| if x > y { x } else { y } | ||
| } | ||
|
|
||
| #[kani::proof_for_contract(max)] | ||
| fn max_harness() { | ||
| let _ = Box::new(9_usize); | ||
| max(7, 6); | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| cannot assign to `*_x`, as `Fn` closures cannot mutate their captured variables |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| // Copyright Kani Contributors | ||
| // SPDX-License-Identifier: Apache-2.0 OR MIT | ||
| // kani-flags: -Zfunction-contracts | ||
|
|
||
| #[kani::ensures(|_| {*_x += 1; true})] | ||
| fn unit(_x: &mut u32) {} | ||
|
|
||
| #[kani::proof_for_contract(id)] | ||
| fn harness() { | ||
| let mut x = kani::any(); | ||
| unit(&mut x); | ||
| } |