-#!/bin/sh
+#!/bin/bash
#--------------------------------------------------------------------------#
+set -e -o pipefail
+
usage () {
cat <<EOF
-Usage: VAR=VALUE $0 [<build type>] [<option> ...]
+Usage: $0 [<build type>] [<option> ...]
Build types:
production
debug
testing
competition
+ competition-inc
General options;
-h, --help display this help and exit
--prefix=STR install directory
- --build-dir-prefix=STR prefix build directory with given prefix
- --best turn on dependences known to give best performance
- --gpl permit GPL dependences, if available
+ --program-prefix=STR prefix of binaries prepended on make install
+ --name=STR use custom build directory name (optionally: +path)
+ --best turn on dependencies and options known to give best performance
+ --gpl permit GPL dependencies, if available
+ --arm64 cross-compile for Linux ARM 64 bit
+ --win64 cross-compile for Windows 64 bit
+ --ninja use Ninja build system
+ --docs build Api documentation
Features:
The following flags enable optional features (disable with --no-<option name>).
--static build static libraries and binaries [default=no]
- --proofs support for proof generation
- --optimized optimize the build
+ --auto-download automatically download dependencies if necessary
--debug-symbols include debug symbols
--valgrind Valgrind instrumentation
--debug-context-mm use the debug context memory manager
- --statistics do not include statistics
- --replay turn off the replay feature
- --assertions turn off assertions
- --tracing remove all tracing code
- --dumping remove all dumping code
+ --statistics include statistics
+ --assertions turn on assertions
+ --tracing include tracing code
+ --dumping include dumping code
--muzzle complete silence (no non-result output)
--coverage support for gcov coverage testing
--profiling support for gprof profiling
--unit-testing support for unit testing
- --python2 prefer using Python 2 (for Python bindings)
-
-The following options configure parameterized features.
-
- --language-bindings[=java,python,all]
- specify language bindings to build
+ --python2 force Python 2 (deprecated)
+ --python-bindings build Python bindings based on new C++ API
+ --java-bindings build Java bindings based on new C++ API
+ --all-bindings build bindings for all supported languages
+ --asan build with ASan instrumentation
+ --ubsan build with UBSan instrumentation
+ --tsan build with TSan instrumentation
+ --werror build with -Werror
+ --ipo build with interprocedural optimization
Optional Packages:
The following flags enable optional packages (disable with --no-<option name>).
--cln use CLN instead of GMP
- --gmp use GMP instead of CLN
--glpk use GLPK simplex solver
- --abc use the ABC AIG library
- --cadical use the CaDiCaL SAT solver
- --cryptominisat use the CRYPTOMINISAT sat solver
- --lfsc use the LFSC proof checker
- --symfpu use symfpu for floating point solver
- --portfolio build the multithreaded portfolio version of CVC4
- (pcvc4)
- --readline support the readline library
+ --cryptominisat use the CryptoMiniSat SAT solver
+ --kissat use the Kissat SAT solver
+ --poly use the LibPoly library [default=yes]
+ --cocoa use the CoCoA library
+ --editline support the editline library
Optional Path to Optional Packages:
- --abc-dir=PATH path to top level of abc source tree
- --antlr-dir=PATH path to ANTLR C headers and libraries
- --cadical-dir=PATH path to top level of CaDiCaL source tree
- --cryptominisat-dir=PATH path to top level of cryptominisat source tree
- --cxxtest-dir=DIR path to CxxTest installation
- --glpk-dir=PATH path to top level of glpk installation
- --lfsc-dir=PATH path to top level of lfsc source tree
- --symfpu-dir=PATH path to top level of symfpu source tree
-
-Report bugs to <cvc4-bugs@cs.stanford.edu>.
+ --glpk-dir=PATH path to top level of GLPK installation
+ --dep-path=PATH path to a dependency installation dir
+
+Build limitations:
+ --lib-only only build the library, but not the executable or
+ the parser (default: off)
+
+CMake Options (Advanced)
+ -DVAR=VALUE manually add CMake options
+
EOF
exit 0
}
#--------------------------------------------------------------------------#
-builddir=production
+build_dir=build
install_prefix=default
-build_dir_prefix=""
+program_prefix=""
#--------------------------------------------------------------------------#
buildtype=default
-abc=default
asan=default
assertions=default
-best=default
-cadical=default
+auto_download=default
cln=default
+comp_inc=default
coverage=default
cryptominisat=default
-debug_symbols=default
debug_context_mm=default
+debug_symbols=default
+docs=default
dumping=default
-gpl=default
glpk=default
-lfsc=default
+gpl=default
+kissat=default
+poly=ON
+cocoa=default
muzzle=default
-optimized=default
-portfolio=default
-proofs=default
-replay=default
-shared=default
+ninja=default
+profiling=default
+python2=default
+python_bindings=default
+java_bindings=default
+editline=default
+build_shared=ON
statistics=default
-symfpu=default
tracing=default
+tsan=default
+ubsan=default
unit_testing=default
-python2=default
valgrind=default
-profiling=default
-readline=default
-
-language_bindings_java=default
-language_bindings_python=default
+win64=default
+arm64=default
+werror=default
+ipo=default
-abc_dir=default
-antlr_dir=default
-cadical_dir=default
-cryptominisat_dir=default
glpk_dir=default
-lfsc_dir=default
-symfpu_dir=default
#--------------------------------------------------------------------------#
+cmake_opts=""
+
while [ $# -gt 0 ]
do
case $1 in
-h|--help) usage;;
- --abc) abc=ON;;
- --no-abc) abc=OFF;;
-
--asan) asan=ON;;
--no-asan) asan=OFF;;
+ --ubsan) ubsan=ON;;
+ --no-ubsan) ubsan=OFF;;
+
+ --tsan) tsan=ON;;
+ --no-tsan) tsan=OFF;;
+
+ --werror) werror=ON;;
+
+ --ipo) ipo=ON;;
+ --no-ipo) ipo=OFF;;
+
--assertions) assertions=ON;;
--no-assertions) assertions=OFF;;
- --best) best=ON;;
- --no-best) best=OFF;;
+ # Best configuration
+ --best)
+ ipo=ON
+ cln=ON
+ cryptominisat=ON
+ glpk=ON
+ editline=ON
+ ;;
--prefix) die "missing argument to $1 (try -h)" ;;
--prefix=*)
# absolute.
case $install_prefix in
/*) ;; # absolute path
- *) install_prefix=`pwd`/$install_prefix ;; # make absolute path
+ *) install_prefix=$(pwd)/$install_prefix ;; # make absolute path
esac
;;
- --build-dir-prefix) die "missing argument to $1 (try -h)" ;;
- --build-dir-prefix=*) build_dir_prefix=${1##*=} ;;
+ --program-prefix) die "missing argument to $1 (try -h)" ;;
+ --program-prefix=*) program_prefix=${1##*=} ;;
- --cadical) cadical=ON;;
- --no-cadical) cadical=OFF;;
+ --name) die "missing argument to $1 (try -h)" ;;
+ --name=*) build_dir=${1##*=} ;;
--cln) cln=ON;;
--no-cln) cln=OFF;;
--debug-symbols) debug_symbols=ON;;
--no-debug-symbols) debug_symbols=OFF;;
- --debug-context-memory-manager) debug_context_mm=ON;;
- --no-debug-context-memory-manager) debug_context_mm=OFF;;
+ --debug-context-mm) debug_context_mm=ON;;
+ --no-debug-context-mm) debug_context_mm=OFF;;
--dumping) dumping=ON;;
--no-dumping) dumping=OFF;;
--gpl) gpl=ON;;
--no-gpl) gpl=OFF;;
+ --kissat) kissat=ON;;
+ --no-kissat) kissat=OFF;;
+
+ --win64) win64=ON;;
+
+ --arm64) arm64=ON;;
+
+ --ninja) ninja=ON;;
+
+ --docs) docs=ON;;
+ --no-docs) docs=OFF;;
+
--glpk) glpk=ON;;
--no-glpk) glpk=OFF;;
- --lfsc) lfsc=ON;;
- --no-lfsc) lfsc=OFF;;
+ --poly) poly=ON;;
+ --no-poly) poly=OFF;;
+
+ --cocoa) cocoa=ON;;
+ --no-cocoa) cocoa=OFF;;
--muzzle) muzzle=ON;;
--no-muzzle) muzzle=OFF;;
- --optimized) optimized=ON;;
- --no-optimized) optimized=OFF;;
+ --static) build_shared=OFF;;
+ --no-static) build_shared=ON;;
- --portfolio) portfolio=ON;;
- --no-portfolio) portfolio=OFF;;
-
- --proofs) proofs=ON;;
- --no-proofs) proofs=OFF;;
-
- --replay) replay=ON;;
- --no-replay) replay=OFF;;
-
- --static) shared=OFF;;
- --no-static) shared=ON;;
+ --auto-download) auto_download=ON;;
+ --no-auto-download) auto_download=OFF;;
--statistics) statistics=ON;;
--no-statistics) statistics=OFF;;
- --symfpu) symfpu=ON;;
- --no-symfpu) symfpu=OFF;;
-
--tracing) tracing=ON;;
--no-tracing) tracing=OFF;;
--python2) python2=ON;;
--no-python2) python2=OFF;;
+ --python-bindings) python_bindings=ON;;
+ --no-python-bindings) python_bindings=OFF;;
+
+ --java-bindings) java_bindings=ON;;
+ --no-java-bindings) java_bindings=OFF;;
+
+ --all-bindings)
+ python_bindings=ON
+ java_bindings=ON;;
+
--valgrind) valgrind=ON;;
--no-valgrind) valgrind=OFF;;
--profiling) profiling=ON;;
--no-profiling) profiling=OFF;;
- --readline) readline=ON;;
- --no-readline) readline=OFF;;
-
- --language-bindings) die "missing argument to $1 (try -h)" ;;
- --language-bindings=*)
- lang="${1##*=}"
- [[ "java python all" =~ (^|[[:space:]])"$lang"($|[[:space:]]) ]] \
- || die "invalid argument to --language-bindings (try -h)"
- if [ $lang = "java" -o $lang = "all" ]
- then
- language_bindings_java=ON
- fi
- if [ $lang = "python" -o $lang = "all" ]
- then
- language_bindings_python=ON
- fi
- ;;
-
- --abc-dir) die "missing argument to $1 (try -h)" ;;
- --abc-dir=*) abc_dir=${1##*=} ;;
-
- --antlr-dir) die "missing argument to $1 (try -h)" ;;
- --antlr-dir=*) antlr_dir=${1##*=} ;;
-
- --cadical-dir) die "missing argument to $1 (try -h)" ;;
- --cadical-dir=*) cadical_dir=${1##*=} ;;
-
- --cryptominisat-dir) die "missing argument to $1 (try -h)" ;;
- --cryptominisat-dir=*) cryptominisat_dir=${1##*=} ;;
+ --editline) editline=ON;;
+ --no-editline) editline=OFF;;
--glpk-dir) die "missing argument to $1 (try -h)" ;;
--glpk-dir=*) glpk_dir=${1##*=} ;;
- --lfsc-dir) die "missing argument to $1 (try -h)" ;;
- --lfsc-dir=*) lfsc_dir=${1##*=} ;;
+ --dep-path) die "missing argument to $1 (try -h)" ;;
+ --dep-path=*) dep_path="${dep_path};${1##*=}" ;;
- --symfpu-dir) die "missing argument to $1 (try -h)" ;;
- --symfpu-dir=*) symfpu_dir=${1##*=} ;;
+ -D*) cmake_opts="${cmake_opts} $1" ;;
-*) die "invalid option '$1' (try -h)";;
*) case $1 in
- production) buildtype=Production; builddir=production;;
- debug) buildtype=Debug; builddir=debug;;
- testing) buildtype=Testing; builddir=testing;;
- competition) buildtype=Competition; builddir=competition;;
- *) die "invalid build type (try -h)";;
+ production) buildtype=Production;;
+ debug) buildtype=Debug;;
+ testing) buildtype=Testing;;
+ competition) buildtype=Competition;;
+ competition-inc) buildtype=Competition; comp_inc=ON;;
+ *) die "invalid build type (try -h)";;
esac
;;
esac
shift
done
-builddir="$build_dir_prefix$builddir"
-
#--------------------------------------------------------------------------#
-cmake_opts=""
+if [ $werror != default ]; then
+ export CFLAGS=-Werror
+ export CXXFLAGS=-Werror
+fi
-[ $buildtype != default ] && cmake_opts="$cmake_opts -DCMAKE_BUILD_TYPE=$buildtype"
+[ $buildtype != default ] \
+ && cmake_opts="$cmake_opts -DCMAKE_BUILD_TYPE=$buildtype"
[ $asan != default ] \
- && cmake_opts="$cmake_opts -DENABLE_ASAN=$asan" \
- && [ $asan = ON ] && builddir="$builddir-asan"
+ && cmake_opts="$cmake_opts -DENABLE_ASAN=$asan"
+[ $auto_download != default ] \
+ && cmake_opts="$cmake_opts -DENABLE_AUTO_DOWNLOAD=$auto_download"
+[ $ubsan != default ] \
+ && cmake_opts="$cmake_opts -DENABLE_UBSAN=$ubsan"
+[ $tsan != default ] \
+ && cmake_opts="$cmake_opts -DENABLE_TSAN=$tsan"
+[ $ipo != default ] \
+ && cmake_opts="$cmake_opts -DENABLE_IPO=$ipo"
[ $assertions != default ] \
- && cmake_opts="$cmake_opts -DENABLE_ASSERTIONS=$assertions" \
- && [ $assertions = ON ] && builddir="$builddir-assertions"
-[ $best != default ] \
- && cmake_opts="$cmake_opts -DENABLE_BEST=$best" \
- && [ $best = ON ] && builddir="$builddir-best"
+ && cmake_opts="$cmake_opts -DENABLE_ASSERTIONS=$assertions"
+[ $comp_inc != default ] \
+ && cmake_opts="$cmake_opts -DENABLE_COMP_INC_TRACK=$comp_inc"
[ $coverage != default ] \
- && cmake_opts="$cmake_opts -DENABLE_COVERAGE=$coverage" \
- && [ $coverage = ON ] && builddir="$builddir-coverage"
+ && cmake_opts="$cmake_opts -DENABLE_COVERAGE=$coverage"
[ $debug_symbols != default ] \
- && cmake_opts="$cmake_opts -DENABLE_DEBUG_SYMBOLS=$debug_symbols" \
- && [ $debug_symbols = ON ] && builddir="$builddir-debug_symbols"
+ && cmake_opts="$cmake_opts -DENABLE_DEBUG_SYMBOLS=$debug_symbols"
[ $debug_context_mm != default ] \
- && cmake_opts="$cmake_opts -DENABLE_DEBUG_CONTEXT_MM=$debug_context_mm" \
- && [ $debug_context_mm = ON ] && builddir="$builddir-debug_context_mm"
+ && cmake_opts="$cmake_opts -DENABLE_DEBUG_CONTEXT_MM=$debug_context_mm"
[ $dumping != default ] \
- && cmake_opts="$cmake_opts -DENABLE_DUMPING=$dumping" \
- && [ $dumping = ON ] && builddir="$builddir-dumping"
+ && cmake_opts="$cmake_opts -DENABLE_DUMPING=$dumping"
[ $gpl != default ] \
- && cmake_opts="$cmake_opts -DENABLE_GPL=$gpl" \
- && [ $gpl = ON ] && builddir="$builddir-gpl"
+ && cmake_opts="$cmake_opts -DENABLE_GPL=$gpl"
+[ $win64 != default ] \
+ && cmake_opts="$cmake_opts -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw64.cmake"
+[ $arm64 != default ] \
+ && cmake_opts="$cmake_opts -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-aarch64.cmake"
+[ $ninja != default ] && cmake_opts="$cmake_opts -G Ninja"
[ $muzzle != default ] \
- && cmake_opts="$cmake_opts -DENABLE_MUZZLE=$muzzle" \
- && [ $muzzle = ON ] && builddir="$builddir-muzzle"
-[ $optimized != default ] \
- && cmake_opts="$cmake_opts -DENABLE_OPTIMIZED=$optimized" \
- && [ $optimized = ON ] && builddir="$builddir-optimized"
-[ $portfolio != default ] \
- && cmake_opts="$cmake_opts -DENABLE_PORTFOLIO=$portfolio" \
- && [ $portfolio = ON ] && builddir="$builddir-portfolio"
-[ $proofs != default ] \
- && cmake_opts="$cmake_opts -DENABLE_PROOFS=$proofs" \
- && [ $proofs = ON ] && builddir="$builddir-proofs"
-[ $replay != default ] \
- && cmake_opts="$cmake_opts -DENABLE_REPLAY=$replay" \
- && [ $replay = ON ] && builddir="$builddir-replay"
-[ $shared != default ] \
- && cmake_opts="$cmake_opts -DENABLE_STATIC=$shared" \
- && [ $shared == OFF ] && builddir="$builddir-static"
+ && cmake_opts="$cmake_opts -DENABLE_MUZZLE=$muzzle"
+[ $build_shared != default ] \
+ && cmake_opts="$cmake_opts -DBUILD_SHARED_LIBS=$build_shared"
[ $statistics != default ] \
- && cmake_opts="$cmake_opts -DENABLE_STATISTICS=$statistics" \
- && [ $statistics = ON ] && builddir="$builddir-stastitics"
+ && cmake_opts="$cmake_opts -DENABLE_STATISTICS=$statistics"
[ $tracing != default ] \
- && cmake_opts="$cmake_opts -DENABLE_TRACING=$tracing" \
- && [ $tracing = ON ] && builddir="$builddir-tracing"
+ && cmake_opts="$cmake_opts -DENABLE_TRACING=$tracing"
[ $unit_testing != default ] \
- && cmake_opts="$cmake_opts -DENABLE_UNIT_TESTING=$unit_testing" \
- && [ $unit_testing = ON ] && builddir="$builddir-unit_testing"
+ && cmake_opts="$cmake_opts -DENABLE_UNIT_TESTING=$unit_testing"
[ $python2 != default ] \
- && cmake_opts="$cmake_opts -DUSE_PYTHON2=$python2" \
- && [ $python2 = ON ] && builddir="$builddir-python2"
+ && cmake_opts="$cmake_opts -DUSE_PYTHON2=$python2"
+[ $docs != default ] \
+ && cmake_opts="$cmake_opts -DBUILD_DOCS=$docs"
+[ $python_bindings != default ] \
+ && cmake_opts="$cmake_opts -DBUILD_BINDINGS_PYTHON=$python_bindings"
+[ $java_bindings != default ] \
+ && cmake_opts="$cmake_opts -DBUILD_BINDINGS_JAVA=$java_bindings"
[ $valgrind != default ] \
- && cmake_opts="$cmake_opts -DENABLE_VALGRIND=$valgrind" \
- && [ $valgrind = ON ] && builddir="$builddir-valgrind"
+ && cmake_opts="$cmake_opts -DENABLE_VALGRIND=$valgrind"
[ $profiling != default ] \
- && cmake_opts="$cmake_opts -DENABLE_PROFILING=$profiling" \
- && [ $profiling = ON ] && builddir="$builddir-profiling"
-[ $readline != default ] \
- && cmake_opts="$cmake_opts -DUSE_READLINE=$readline" \
- && [ $readline = ON ] && builddir="$builddir-readline"
-[ $abc != default ] \
- && cmake_opts="$cmake_opts -DUSE_ABC=$abc" \
- && [ $abc = ON ] && builddir="$builddir-abc"
-[ $cadical != default ] \
- && cmake_opts="$cmake_opts -DUSE_CADICAL=$cadical" \
- && [ $cadical = ON ] && builddir="$builddir-cadical"
+ && cmake_opts="$cmake_opts -DENABLE_PROFILING=$profiling"
+[ $editline != default ] \
+ && cmake_opts="$cmake_opts -DUSE_EDITLINE=$editline"
[ $cln != default ] \
- && cmake_opts="$cmake_opts -DUSE_CLN=$cln" \
- && [ $cln = ON ] && builddir="$builddir-cln"
+ && cmake_opts="$cmake_opts -DUSE_CLN=$cln"
[ $cryptominisat != default ] \
- && cmake_opts="$cmake_opts -DUSE_CRYPTOMINISAT=$cryptominisat" \
- && [ $cryptominisat = ON ] && builddir="$builddir-cryptominisat"
+ && cmake_opts="$cmake_opts -DUSE_CRYPTOMINISAT=$cryptominisat"
[ $glpk != default ] \
- && cmake_opts="$cmake_opts -DUSE_GLPK=$glpk" \
- && [ $glpk = ON ] && builddir="$builddir-glpk"
-[ $lfsc != default ] \
- && cmake_opts="$cmake_opts -DUSE_LFSC=$lfsc" \
- && [ $lfsc = ON ] && builddir="$builddir-lfsc"
-[ $symfpu != default ] \
- && cmake_opts="$cmake_opts -DUSE_SYMFPU=$symfpu" \
- && [ $symfpu = ON ] && builddir="$builddir-symfpu"
-
-[ $language_bindings_java != default ] \
- && cmake_opts="$cmake_opts -DBUILD_BINDINGS_JAVA=$language_bindings_java"
-[ $language_bindings_python != default ] \
- && cmake_opts="$cmake_opts -DBUILD_BINDINGS_PYTHON=$language_bindings_python"
-
-[ $abc_dir != default ] \
- && cmake_opts="$cmake_opts -DABC_DIR=$abc_dir"
-[ $antlr_dir != default ] \
- && cmake_opts="$cmake_opts -DANTLR_DIR=$antlr_dir"
-[ $cadical_dir != default ] \
- && cmake_opts="$cmake_opts -DCADICAL_DIR=$cadical_dir"
-[ $cryptominisat_dir != default ] \
- && cmake_opts="$cmake_opts -DCRYPTOMINISAT_DIR=$cryptominisat_dir"
-[ $glpk_dir != default ] \
+ && cmake_opts="$cmake_opts -DUSE_GLPK=$glpk"
+[ $kissat != default ] \
+ && cmake_opts="$cmake_opts -DUSE_KISSAT=$kissat"
+[ $poly != default ] \
+ && cmake_opts="$cmake_opts -DUSE_POLY=$poly"
+[ $cocoa != default ] \
+ && cmake_opts="$cmake_opts -DUSE_COCOA=$cocoa"
+[ "$glpk_dir" != default ] \
&& cmake_opts="$cmake_opts -DGLPK_DIR=$glpk_dir"
-[ $lfsc_dir != default ] \
- && cmake_opts="$cmake_opts -DLFSC_DIR=$lfsc_dir"
-[ $symfpu_dir != default ] \
- && cmake_opts="$cmake_opts -DSYMFPU_DIR=$symfpu_dir"
-[ $install_prefix != default ] \
+[ "$dep_path" != default ] \
+ && cmake_opts="$cmake_opts -DCMAKE_PREFIX_PATH=$dep_path"
+[ "$install_prefix" != default ] \
&& cmake_opts="$cmake_opts -DCMAKE_INSTALL_PREFIX=$install_prefix"
+[ -n "$program_prefix" ] \
+ && cmake_opts="$cmake_opts -DPROGRAM_PREFIX=$program_prefix"
+
+root_dir=$(pwd)
+
+# The cmake toolchain can't be changed once it is configured in $build_dir.
+# Thus, remove $build_dir and create an empty directory.
+[ $win64 = ON ] && [ -e "$build_dir" ] && rm -r "$build_dir"
+[ $arm64 = ON ] && [ -e "$build_dir" ] && rm -r "$build_dir"
+mkdir -p "$build_dir"
-mkdir -p cmake-builds # builds parent directory
-cd cmake-builds
-mkdir -p $builddir # current build directory
-[ -e build ] && rm build
-ln -s $builddir build # link to current build directory
-cd $builddir
+cd "$build_dir"
[ -e CMakeCache.txt ] && rm CMakeCache.txt
-cmake ../.. $cmake_opts
+build_dir_escaped=$(echo "$build_dir" | sed 's/\//\\\//g')
+cmake "$root_dir" $cmake_opts 2>&1 | \
+ sed "s/^Now just/Now change to '$build_dir_escaped' and/"