ravencheck

ravencheck is a tool for symbolic verification of Rust code, using guaranteed-decidable SMT queries for predictable results.

Usage

First, make sure you have the CVC5 SMT solver available. You should be able to run cvc5 --version in your dev environment.

Then, add ravencheck as a dependency in your Cargo.toml file, using one of these three methods:

Depend on crates.io package

Add the following to your Cargo.toml:

[dependencies]
ravencheck = "0.5.0"

This gives you the latest published version (v0.5.0).

Depend on the GitHub repo's latest commit

Add the following to your Cargo.toml:

[dependencies]
ravencheck = { git = "https://github.com/cuplv/ravencheck" }

This gives you the latest commit to main.

Depend on local copy of the repo

Alternatively, you can clone the repo and use its path on your filesystem as the dependency:

# Cargo.toml
...
[dependencies]
ravencheck = { path = "path/to/cloned/repo" }
...

This allows you to choose which commit in the repo to use.

Verifying a module

You use ravencheck by adding the #[ravencheck::check_module] macro attribute at the top of modules in which you want to use verification.

#[ravencheck::check_module]
#[declare_types(u32)]
mod rvn {
    #[declare]
    const ZERO: u32 = 0;

    #[declare]
    fn le(a: u32, b: u32) -> bool {
        a <= b
    }

    #[assume]
    fn le_anti_symmetric() -> bool {
        forall(|x: u32, y: u32| {
            implies(
                le(x,y) && le(y,x),
                x == y
            )
        })
    }

    #[assume]
    fn zero_is_least() -> bool {
        forall(|x: u32| le(ZERO, x))
    }

    #[verify]
    fn prop1(x: u32) -> bool {
        implies(
            le(x, ZERO),
            x == ZERO
        )
    }
}

See the crate documentation for more details, as well as the examples/ directory in this repo.

About

"Raven" is an acronym for relationally-abstracted verification encoding, the technique that is used to reduce verification conditions to a decidable fragment of first-order logic (specifically, the Extended EPR fragment).