Skip to content

Add non-fatal failure check to rmc prelude #695

@celinval

Description

@celinval

Requested feature: Provide a mechanism for users to add property check to their code that do not abort the program when a failure occurs.
Use case: This can be extremely helpful for adding more information to potential fatal failures without affecting the code path. This can also help while writing tests for RMC.
Link to relevant documentation (Rust reference, Nomicon, RFC):
Is this a breaking change? None

Test case:

/// Dummy verification harness that ensures that method shuffle generates a new array that has all the
/// elements from the source array.
#[rmc::proof]
fn check_shuffle() {
    let a1: [u8; 5] = rmc::nondet();
    let a2 = shuffle(&a1);
    rmc::check(a2.size() == a1.size());
    for x in &a1 {
        rmc::check(a2.contains(x));
    }
}

In this harness, it might be helpful to understand if 1 or more items are missing from the array. With rmc::check() we can easily verify all the elements and find as many failures as possible. If we replace rmc::check by assert the analysis would stop in the first failure.

Metadata

Metadata

Assignees

Labels

[C] Feature / EnhancementA new feature request or enhancement to an existing feature.

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions