CoreIR Symbolic Analyzer
.. figure:: http://www.mattarei.eu/cristian/images/CoSA-logo_small.png :align: center
...an SMT-based symbolic model checker for hardware design.
CoSA supports a variety of input formats:
CoreIR
_BTOR2
_STS
_)ETS
_)and verifications:
pip3 install cosa
to install CoSA, and its dependencies i.e., PySMT
, PyCoreIR
, and PyVerilog
_
pysmt-install --msat
to install MathSAT5
_ solver (it provides interpolation support), or pysmt-install --cvc4
for CVC4
_ and pysmt-install --z3
for Z3
_ and pysmt-install --btor
for Boolector
_
pysmt-install --env
to show the environment variables that need to be exported
Software requirements:
Python3
_ -- Full support requires Python3.6 or higher, however running without the CoreIR
_ inputs should work on older Python 3 versionsPip3
_: package manager -- easiest way to install CoSA. On Debian: apt-get update; apt-get install python3-pip
.Cmake
_ and a standard C++ compiler for CoreIR
_ / PyCoreIR
_Yosys
_ needs to be installed in order to support Verilog as an input formatVerific
_ binaries or Yosys built with Verific library in order to support SystemVerilog as an input format [Commercial Tool].. _BTOR2: https://github.com/Boolector/btor2tools .. _Boolector: https://github.com/Boolector/boolector .. _Cmake: https://cmake.org/ .. _CoreIR: https://github.com/rdaly525/coreir .. _CVC4: http://cvc4.cs.stanford.edu/web/ .. _ETS: https://github.com/cristian-mattarei/CoSA/blob/master/doc/ets.rst .. _Git: https://www.atlassian.com/git/tutorials/install-git .. _Icarus Verilog: https://github.com/steveicarus/iverilog .. _MathSAT5: http://mathsat.fbk.eu .. _Pip3: https://pypi.org/project/pip/ .. _PyCoreIR: https://github.com/leonardt/pycoreir .. _PySMT: https://github.com/pysmt/pysmt .. _Python3: https://www.python.org/downloads/ .. _PyVerilog: https://github.com/PyHDI/Pyverilog .. _STS: https://github.com/cristian-mattarei/CoSA/blob/master/doc/sts.rst .. _Verific: http://www.verific.com/ .. _Yosys: https://github.com/YosysHQ/yosys .. _Z3: https://github.com/Z3Prover/z3
Git
_git clone https://github.com/cristian-mattarei/CoSA.git
cd CoSA
pip3 install -e .
Pip will automatically install the Python dependencies. To install Yosys for Verilog support, follow the instructions here <https://github.com/YosysHQ/yosys/blob/master/README.md>
_.
Note: If running in a Python virtualenv, pip will install the CoSA
script in ~/.local/bin
, so be sure it's added to your PATH
with export PATH=~/.local/bin:$PATH
.
To run tests (tests include Veriog models and thus require Yosys):
nosetests tests
To start playing with the tool, you can run:
CoSA -h
shows the helper with command options
CoSA -i examples/counters/counters.json --verification simulation -k 7
generates a system execution with depth 7
CoSA -i examples/counters/counters.json --safety -p "!(count0.a.out = 5_16)" -k 7
performs reachability model checking with property count0.a.out != 5 as a 16-bit Bitvector
CoSA --problem examples/counter/problem.txt --prefix trace
performs liveness (GF) and finally (F) checking on the counter.json model using the problem definition
CoSA --problem examples/fold-constants/problem.txt
performs equivalence checking using lemmas
For more information, please refer to the CoSA user manual
_.
.. _CoSA user manual: https://github.com/cristian-mattarei/CoSA/blob/master/doc/manual/CoSA-manual.pdf
install Docker with your package manager e.g., sudo apt-get install docker
build the Docker image: cd docker/ubuntu_1604 && docker build -t ubuntu-cosa .
run the Docker image: docker run -i -t ubuntu-cosa /bin/bash
CoSA is released under the modified BSD (3-clause BSD) License.
If you use CoSA in your work, please consider citing the following publication:
.. code::
@inproceedings{DBLP:conf/fmcad/MattareiMBDHH18, author = {Cristian Mattarei and Makai Mann and Clark Barrett and Ross G. Daly and Dillon Huff and Pat Hanrahan}, title = {{CoSA: Integrated Verification for Agile Hardware Design}}, booktitle = {Formal Methods in Computer-Aided Design, {FMCAD} 2018, Austin, Texas, USA, October 30 - November 2, 2018.}, publisher = {{IEEE}}, year = {2018} }
.. image:: https://travis-ci.org/cristian-mattarei/CoSA.svg?branch=master :target: https://travis-ci.org/cristian-mattarei/CoSA