mirrors/sby
3
0
Fork 0
mirror of https://github.com/YosysHQ/sby.git synced 2025-04-05 22:14:08 +00:00
Code Activity

Reflect recent engine updates in the reference docs

Browse source
This commit is contained in:
Jannis Harder 2022-06-20 14:59:00 +02:00
parent fb5705b5bd
commit d8ebd1eb9d
1 changed files with 42 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

79
docs/source/reference.rst
View file

@ -213,6 +213,8 @@ The following mode/engine/solver combinations are currently supported:
| | ``abc bmc3`` | | | ``abc bmc3`` |
| | | | | |
| | ``abc sim3`` | | | ``abc sim3`` |
| | |
| | ``aiger smtbmc`` |
+-----------+--------------------------+ +-----------+--------------------------+
| ``prove`` | ``smtbmc [all solvers]`` | | ``prove`` | ``smtbmc [all solvers]`` |
| | | | | |
@ -227,8 +229,6 @@ The following mode/engine/solver combinations are currently supported:
| | ``btor btormc`` | | | ``btor btormc`` |
+-----------+--------------------------+ +-----------+--------------------------+
| ``live`` | ``aiger suprove`` | | ``live`` | ``aiger suprove`` |
| | |
| | ``aiger avy`` |
+-----------+--------------------------+ +-----------+--------------------------+
``smtbmc`` engine ``smtbmc`` engine
@ -237,34 +237,37 @@ The following mode/engine/solver combinations are currently supported:
The ``smtbmc`` engine supports the ``bmc``, ``prove``, and ``cover`` modes and supports The ``smtbmc`` engine supports the ``bmc``, ``prove``, and ``cover`` modes and supports
the following options: the following options:
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| Option | Description | | Option | Description |
+=================+=========================================================+ +==================+=========================================================+
| ``--nomem`` | Don't use the SMT theory of arrays to model memories. | | ``--nomem`` | Don't use the SMT theory of arrays to model memories. |
| | Instead synthesize memories to registers and address | | | Instead synthesize memories to registers and address |
| | logic. | | | logic. |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--syn`` | Synthesize the circuit to a gate-level representation | | ``--syn`` | Synthesize the circuit to a gate-level representation |
| | instead of using word-level SMT operators. This also | | | instead of using word-level SMT operators. This also |
| | runs some low-level logic optimization on the circuit. | | | runs some low-level logic optimization on the circuit. |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--stbv`` | Use large bit vectors (instead of uninterpreted | | ``--stbv`` | Use large bit vectors (instead of uninterpreted |
| | functions) to represent the circuit state. | | | functions) to represent the circuit state. |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--stdt`` | Use SMT-LIB 2.6 datatypes to represent states. | | ``--stdt`` | Use SMT-LIB 2.6 datatypes to represent states. |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--nopresat`` | Do not run "presat" SMT queries that make sure that | | ``--nopresat`` | Do not run "presat" SMT queries that make sure that |
| | assumptions are non-conflicting (and potentially | | | assumptions are non-conflicting (and potentially |
| | warmup the SMT solver). | | | warmup the SMT solver). |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--unroll``, | Disable/enable unrolling of the SMT problem. The | | ``--keep-going`` | In BMC mode, continue after the first failed assertion |
| ``--nounroll`` | default value depends on the solver being used. | | | and report further failed assertions. |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--dumpsmt2`` | Write the SMT2 trace to an additional output file. | | ``--unroll``, | Disable/enable unrolling of the SMT problem. The |
| | (Useful for benchmarking and troubleshooting.) | | ``--nounroll`` | default value depends on the solver being used. |
+-----------------+---------------------------------------------------------+ +------------------+---------------------------------------------------------+
| ``--progress`` | Enable Yosys-SMTBMC timer display. | | ``--dumpsmt2`` | Write the SMT2 trace to an additional output file. |
+-----------------+---------------------------------------------------------+ | | (Useful for benchmarking and troubleshooting.) |
+------------------+---------------------------------------------------------+
| ``--progress`` | Enable Yosys-SMTBMC timer display. |
+------------------+---------------------------------------------------------+
Any SMT2 solver that is compatible with ``yosys-smtbmc`` can be passed as Any SMT2 solver that is compatible with ``yosys-smtbmc`` can be passed as
argument to the ``smtbmc`` engine. The solver options are passed to the solver argument to the ``smtbmc`` engine. The solver options are passed to the solver
@ -272,12 +275,13 @@ as additional command line options.
The following solvers are currently supported by ``yosys-smtbmc``: The following solvers are currently supported by ``yosys-smtbmc``:
* yices * yices
* boolector * boolector
* bitwuzla * bitwuzla
* z3 * z3
* mathsat * mathsat
* cvc4 * cvc4
* cvc5
Any additional options after ``--`` are passed to ``yosys-smtbmc`` as-is. Any additional options after ``--`` are passed to ``yosys-smtbmc`` as-is.
@ -295,6 +299,7 @@ The engine supports no engine options and supports the following solvers:
| ``pono`` | ``bmc`` | | ``pono`` | ``bmc`` |
+-------------------------------+---------------------------------+ +-------------------------------+---------------------------------+
Solver options are passed to the solver as additional command line options.
``aiger`` engine ``aiger`` engine
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -310,7 +315,7 @@ solvers:
+-------------------------------+---------------------------------+ +-------------------------------+---------------------------------+
| ``avy`` | ``prove`` | | ``avy`` | ``prove`` |
+-------------------------------+---------------------------------+ +-------------------------------+---------------------------------+
| ``aigbmc`` | ``prove``, ``live`` | | ``aigbmc`` | ``bmc`` |
+-------------------------------+---------------------------------+ +-------------------------------+---------------------------------+
Solver options are passed to the solver as additional command line options. Solver options are passed to the solver as additional command line options.