Skip to content

Update README with Kani proofs #356

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 1 commit into from
Aug 1, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,32 @@ need to unblock the pipeline by following the Buildkite run link in the PR and
click on the corresponding
[unblock pipeline button](https://buildkite.com/docs/pipelines/block-step).

## Kani proofs
We run Kani proofs for each PR and on merges to the main branch. The proofs
check conformance of the virtio-queue implementation to requirements from the
virtio specification. Different than a unit test, a proof is checked for every
possible input thus enforcing conformance. To run Kani locally, please first
follow this
[link](https://model-checking.github.io/kani/install-guide.html#installing-the-latest-version)
to install it. Then, to run all the proofs in all packages, use the following
command:

```bash
cargo kani
```

To run the proofs in a single package, run:

```bash
cargo kani --package virtio-queue
```

To run a single proof, run:

```bash
cargo kani --exact --harness queue::verification::verify_spec_2_7_7_2
```

## License

This project is licensed under either of
Expand Down