C++ C SMT CMake Yacc Shell Other
Clone or download
Permalink
Failed to load latest commit information.
bindings cleaned up a fixme comment Jun 12, 2017
cmake Using the ctest framework for testing Oct 6, 2017
docs Reformat CVC examples Mar 8, 2018
examples/simple Trying to fix shared/static library building May 1, 2017
include/stp SAT: add Riss as backend Apr 23, 2018
lib SAT: add Riss as backend Apr 23, 2018
papers No commit message Aug 14, 2009
scripts improve run scripts for SMTCOMP 2018. #287 Jun 7, 2018
tests Change line endings from CRLF to LF Mar 7, 2018
tools SAT: add Riss as backend Apr 23, 2018
utils Adding copyright to coverty_model.c Sep 30, 2015
windows refactored gettimeofday() for Win32 Apr 17, 2017
.clang-format Reflowing code as per agreed clang-format Oct 8, 2017
.dockerignore Updating README, fixing Docker Sep 23, 2017
.gitignore gitignore: ignore build directory Apr 20, 2018
.gitmodules Include our own copy of GTest as a git submodule. The rationale for Mar 14, 2014
.travis.yml travis: add RISS target Apr 23, 2018
AUTHORS Remove attribution Mar 8, 2018
CMakeLists.txt SAT: allow to build with Riss Apr 23, 2018
Dockerfile Update Dockerfile for building Minisat correctly Mar 8, 2018
LICENSE Moving COPYRIGHT into LICENSE file Sep 18, 2015
LICENSE_COMPONENTS Cleaning up the LICENSE_COMPONENTS file Sep 10, 2015
README.markdown Fix broken Markdown in README Mar 12, 2018
STPConfig.cmake.in Trying to fix shared/static library building May 1, 2017
STPConfigVersion.cmake.in Provide STPConfigVersion file which allows clients to request a Apr 23, 2015
appveyor.yml Move from msoos/minisat to stp/minisat Mar 7, 2018

README.markdown

License: MIT Linux build Windows build Documentation Coverity Codacy Badge Coverage

STP

STP is a constraint solver (or SMT solver) aimed at solving constraints of bitvectors and arrays. These types of constraints can be generated by program analysis tools, theorem provers, automated bug finders, cryptographic attack tools, intelligent fuzzers, model checkers, and by many other applications.

Build and install

For a quick install:

sudo apt-get install cmake bison flex libboost-all-dev python perl minisat
git clone https://github.com/stp/stp
cd stp
mkdir build
cd build
cmake ..
make
sudo make install

For more detailed instructions, see towards the end of the page.

Input format

The file based input formats that STP reads are the: CVC, SMT-LIB1, and SMT-LIB2 formats. The SMT-LIB2 format is the recommended file format, because it is parsed by all modern bitvector solvers. Only quantifier-free bitvectors and arrays are implemented from the SMTLibv2 format.

Usage

Run with an SMTLibv2 file:

stp myproblem.smt

Overflowing a 32b integer using the python interface:

import stp
In [1]: import stp
In [2]: a = stp.Solver()
In [3]: x = a.bitvec('x')
In [4]: y = a.bitvec('y')
In [5]: a.add(x + y < 20)
In [6]: a.add(x  > 10)
In [7]: a.add(y  > 10)
In [8]: a.check()
Out[8]: True
In [9]: a.model()
Out[9]: {'x': 4294967287L, 'y': 11L}

With Docker:

docker pull msoos/stp
echo "(set-logic QF_BV)
(assert (= (bvsdiv (_ bv3 2) (_ bv2 2)) (_ bv0 2)))
(check-sat)
(exit)" | docker run --rm -i msoos/stp

Architecture

The system performs word-level preprocessing followed by translation to SAT which is then solved by a SAT solver. In particular, we introduce several new heuristics for the preprocessing step, including abstraction-refinement in the context of arrays, a new bitvector linear arithmetic equation solver, and some interesting simplifications. These heuristics help us achieve several magnitudes of order performance over other tools, and also over straight-forward translation to SAT. STP has been heavily tested on thousands of examples sourced from various real-world applications such as program analysis and bug-finding tools like EXE, and equivalence checking tools and theorem-provers.

Detailed Building and Installation

STP is built with CMake, version 3.0.2 or newer. CMake is a meta build system that generates build files for other tools such as make(1), Visual Studio, Xcode, etc.

Configuration variables

Here are a few interesting configuration variables. These apply to all generators.

  • CMAKE_BUILD_TYPE - The build type (e.g. Release)
  • CMAKE_INSTALL_PREFIX - The prefix for install (e.g. /usr/local )
  • ENABLE_ASSERTIONS - If TRUE STP will be built with asserts.
  • ENABLE_TESTING - Enable running tests
  • ENABLE_PYTHON_INTERFACE - Enable building the Python interface
  • PYTHON_EXECUTABLE - Set python executable in case you have more than one python installed
  • SANITIZE - Use Clang's sanitization checks
  • STATICCOMPILE - Build static libraries and binaries instead of dynamic

Dependencies

STP relies on : boost, flex, bison and minisat. You can install these by:

$ sudo apt-get install cmake bison flex libboost-all-dev python perl minisat

STP uses minisat as its SAT solver by default but it also supports other SAT solvers including CryptoMiniSat as an optional extra. If installed, it will be detected during the cmake and used:

$ git clone https://github.com/msoos/cryptominisat
$ cd cryptominisat
$ mkdir build && cd build
$ cmake ..
$ make
$ sudo make install
$ sudo ldconfig

Building a static library and binary

$ mkdir build && cd build
$ cmake -DSTATICCOMPILE=ON ..
$ make
$ sudo make install
$ sudo ldconfig```

Configuration and build options

To tweak the build configuration:

  • Run cmake-gui /path/to/stp/source/root instead of cmake. This user interface lets you control the value of various configuration variables and lets you pick the build system generator.

  • Run ccmake instead of cmake. This provides an ncurses terminal interface for changing configuration variables.

  • Pass -D<VARIABLE>=<VALUE> options to cmake (not very user friendly). It is probably best if you only configure this way if you are writing scripts.

You can also tweak configuration later by running make edit_cache and edit any configuration variables, reconfigure and then regenerate the build system. After configuration, build by running make.

You can use the -j<n> flag to significantly to decrease build time by running <n> jobs in parallel (e.g. make -j4).

Testing

git clone https://github.com/stp/stp
git submodule update --init
pip install lit
mkdir build
cd build
cmake -DENABLE_TESTING=ON ..
make
make check

Installing

To install run make install and to uninstall run make uninstall. The root of installation is controlled by the CMAKE_INSTALL_PREFIX variable at configure time. You can change this by running make edit_cache and editing the value of CMAKE_INSTALL_PREFIX.

Building on Visual Studio

Let's assume you put STP's source into c:\projects\stp and you have cygwin and git installed. Get zlib:

cd C:\projects
git clone https://github.com/madler/zlib
cd zlib
git checkout v1.2.8
mkdir build
mkdir myinstall
cd build
cmake -DCMAKE_INSTALL_PREFIX="..\myinstall" ..
cmake --build .
cmake --build . --target install

Get minisat:

cd C:\projects
git clone https://github.com/stp/minisat
cd minisat
mkdir build
mkdir myinstall
cd build
cmake -DCMAKE_INSTALL_PREFIX="..\myinstall" -DZLIB_ROOT="..\..\zlib\myinstall" ..
cmake --build .
cmake --build . --target install

Get flex, bison, perl:

C:\cygwin64\setup-x86_64.exe  -qnNd -R C:/cygwin64 -s http://cygwin.mirror.constant.com -l C:/cygwin64/var/cache/setup --packages "flex,bison,perl"

Finally, Build STP:

cd C:\projects
git clone https://github.com/stp/stp
git submodule update --init --recursive
mkdir build
cd build
cmake -DBoost_USE_STATIC_LIBS=ON -DENABLE_TESTING=ON -DPYTHON_EXECUTABLE="C:\Program Files\Python36\\python.exe" -DLIT_TOOL="C:\Program Files\Python36\Scripts\\lit.exe" -DMINISAT_LIBDIR="..\..\minisat\myinstall\lib" -DMINISAT_INCLUDE_DIRS="..\..\minisat\myinstall\include" -DZLIB_ROOT="..\..\zlib\myinstall" -DCMAKE_PREFIX_PATH="C:\cygwin64" ..
cmake --build .
cmake --build . --target install

Building Docker

git clone https://github.com/stp/stp
cd stp
docker build -t stp .
echo "(set-logic QF_BV)
(assert (= (bvsdiv (_ bv3 2) (_ bv2 2)) (_ bv0 2)))
(check-sat)
(exit)" | docker run --rm -i stp

Authors

  • Vijay Ganesh
  • Trevor Hansen
  • Mate Soos
  • Dan Liew
  • Ryan Govostes
  • And many others...