Skip to content

Docs for incremental SMT backed #7005

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 2 commits into from
Jul 13, 2022
Merged
Show file tree
Hide file tree
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
19 changes: 19 additions & 0 deletions doc/man/cbmc.1
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,25 @@ Output formula to given file
Never turn arrays into uninterpreted functions
.IP --arrays-uf-always
Always turn arrays into uninterpreted functions
.IP "--incremental-smt2-solver <cmd>"
Use the incremental SMT backend where <cmd> is the command to invoke the SMT
solver of choice.
.br
Examples invocations:
.br
--incremental-smt2-solver 'z3 -smt2 -in' (use the Z3 solver).
.br
--incremental-smt2-solver 'cvc5 --lang=smtlib2.6 --incremental' (use the CVC5 solver).
.sp
Note that:
.br
The solver name must be in the "PATH" or be an executable with full path.
.br
The SMT solver should accept incremental SMTlib v2.6 formatted input from the stdin.
.br
The SMT solver should support the QF_AUFBV logic.
.br
The flag --slice-formula should be added to remove some not-yet supported features.
.SH ENVIRONMENT
All tools honor the TMPDIR environment variable when generating temporary
files and directories. Furthermore note that
Expand Down
42 changes: 42 additions & 0 deletions src/solvers/smt2_incremental/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Incremental SMT backend

CBMC comes with a solver-agnostic incremental SMT backend.

The SMT incremental backend supports the following `C` features:

- Integers (via Bit vector arithmetics)
- Pointers
- Arrays (support is currently incomplete)

Primitive not supported are:

- Floating point values and arithmetics
- Structs

Usage of the incremental SMT backend requires a SMT solver compatible with
incremental SMTlib v2.6 formatted input from the standard input and that
supports the `QF_AUFBV` (Quantifier Free Array Uninterpreted Functions and Bit
Vectors) logic.

To use this functionality it is enough to add the argument
`--incremental-smt2-solver <cmd>` where `<cmd>` is the command to invoke the SMT
solver of choice using the incremental mode and accepting input from the
standard input.

Examples of invocations with various solvers:

1. `--incremental-smt2-solver 'z3 -smt2 -in'` to use the Z3 solver.
2. `--incremental-smt2-solver 'cvc5 --lang=smtlib2.6 --incremental'` to use the
CVC5 solver.
Comment on lines +28 to +30
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would also be nice to see in the man page.


The new incremental SMT backend has been designed to interoperate with external
solvers, so the solver name must be in the `PATH` or an executable with full
path must be provided.

Due to lack of support for conversion of `array_of` expressions that are added
by CBMC in the before the new SMT backend is invoked, it is necessary to supply
an extra argument `--slice-formula` so that instances of `arrayof_exprt` are
removed from the formula to be converted.

As we move forward with our array-support implementation, we anticipate that the
need for this extra flag will be diminished.