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

Update docs

Browse source
This commit is contained in:
Clifford Wolf 2017-03-01 11:09:30 +01:00
parent 774849a6ed
commit 7fdbb4c179
2 changed files with 37 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/source/index.rst
View file

@ -9,7 +9,7 @@ formal tasks:
* Bounded verification of safety properties (assertions) * Bounded verification of safety properties (assertions)
* Unbounded verification of safety properties * Unbounded verification of safety properties
* Generation of test benches from cover statements * Generation of test benches from cover statements
* Verification of liveness properties [TBD] * Verification of liveness properties
* Formal equivalence checking [TBD] * Formal equivalence checking [TBD]
(Items marked [TBD] are features under construction and not available (Items marked [TBD] are features under construction and not available

60
docs/source/reference.rst
View file

@ -16,35 +16,47 @@ option is mandatory. The possible values for the ``mode`` option are:
========= =========== ========= ===========
Mode Description Mode Description
========= =========== ========= ===========
``bmc`` Bounded model check to verify safety properties (assert() statements) ``bmc`` Bounded model check to verify safety properties (``assert(...)`` statements)
``prove`` Unbounded model check to verify safety properties (assert() statements) ``prove`` Unbounded model check to verify safety properties (``assert(...)`` statements)
``cover`` Generate set of shortest trace required to reach all cover() statements ``live`` Unbounded model check to verify liveness properties (``assert(s_eventually ...)`` statements)
``cover`` Generate set of shortest traces required to reach all cover() statements
========= =========== ========= ===========
All other options have default values and thus are optional. The available All other options have default values and thus are optional. The available
options are: options are:
+-------------+-----------+---------------------------------------------------------+ +-------------+------------+---------------------------------------------------------+
| Option | Modes | Description | | Option | Modes | Description |
+=============+===========+=========================================================+ +=============+============+=========================================================+
| ``expect`` | All | Expected result as comma-separated list of the tokens | | ``expect`` | All | Expected result as comma-separated list of the tokens |
| | | ``pass``, ``fail``, ``unknown``, ``error``, and | | | | ``pass``, ``fail``, ``unknown``, ``error``, and |
| | | ``timeout``. Unexpected results yield a nonzero return | | | | ``timeout``. Unexpected results yield a nonzero return |
| | | code . Default: ``pass`` | | | | code . Default: ``pass`` |
+-------------+-----------+---------------------------------------------------------+ +-------------+------------+---------------------------------------------------------+
| ``timeout`` | All | Timeout in seconds. Default: ``none`` (i.e. no timeout) | | ``timeout`` | All | Timeout in seconds. Default: ``none`` (i.e. no timeout) |
+-------------+-----------+---------------------------------------------------------+ +-------------+------------+---------------------------------------------------------+
| ``wait`` | All | Instead of terminating when the first engine returns, | | ``wait`` | All | Instead of terminating when the first engine returns, |
| | | wait for all engines to return and check for | | | | wait for all engines to return and check for |
| | | consistency. Values: ``on``, ``off``. Default: ``off`` | | | | consistency. Values: ``on``, ``off``. Default: ``off`` |
+-------------+-----------+---------------------------------------------------------+ +-------------+------------+---------------------------------------------------------+
| ``depth`` | ``bmc``, | Depth of the bounded model check. Only the specified | | ``aigsmt`` | All | Which SMT2 solver to use for converting AIGER witnesses |
| | ``cover`` | number of cycles are considered. Default: ``20`` | | | | to counter example traces. Default: ``z3`` |
| +-----------+---------------------------------------------------------+ +-------------+------------+---------------------------------------------------------+
| | ``prove`` | Depth for the k-induction performed by the ``smtbmc`` | | ``smtc`` | ``bmc``, | Pass this ``.smtc`` file to the smtbmc engine. All |
| | | engine. Other engines ignore this option in ``prove`` | | | ``prove``, | other engines are disabled when this option is used. |
| | | mode. Default: ``20`` | | | ``cover`` | Default: None |
+-------------+-----------+---------------------------------------------------------+ +-------------+------------+---------------------------------------------------------+
| ``depth`` | ``bmc``, | Depth of the bounded model check. Only the specified |
| | ``cover`` | number of cycles are considered. Default: ``20`` |
| +------------+---------------------------------------------------------+
| | ``prove`` | Depth for the k-induction performed by the ``smtbmc`` |
| | | engine. Other engines ignore this option in ``prove`` |
| | | mode. Default: ``20`` |
+-------------+------------+---------------------------------------------------------+
| ``append`` | ``bmc``, | When generating a counter-example trace, add the |
| | ``prove``, | specified number of cycles at the end of the trace. |
| | ``cover`` | Default: ``0`` |
+-------------+------------+---------------------------------------------------------+
Engines section Engines section
--------------- ---------------