configure.sh

   1 #!/bin/bash
   2 #--------------------------------------------------------------------------#
   3
   4 set -e -o pipefail
   5
   6 usage () {
   7 cat <<EOF
   8 Usage: $0 [<build type>] [<option> ...]
   9
  10 Build types:
  11   production
  12   debug
  13   testing
  14   competition
  15   competition-inc
  16
  17
  18 General options;
  19   -h, --help               display this help and exit
  20   --prefix=STR             install directory
  21   --program-prefix=STR     prefix of binaries prepended on make install
  22   --name=STR               use custom build directory name (optionally: +path)
  23   --best                   turn on dependencies and options known to give best performance
  24   --gpl                    permit GPL dependencies, if available
  25   --arm64                  cross-compile for Linux ARM 64 bit
  26   --win64                  cross-compile for Windows 64 bit
  27   --ninja                  use Ninja build system
  28   --docs                   build Api documentation
  29
  30
  31 Features:
  32 The following flags enable optional features (disable with --no-<option name>).
  33   --static                 build static libraries and binaries [default=no]
  34   --static-binary          statically link against system libraries
  35                            (must be disabled for static macOS builds) [default=yes]
  36   --auto-download          automatically download dependencies if necessary
  37   --debug-symbols          include debug symbols
  38   --valgrind               Valgrind instrumentation
  39   --debug-context-mm       use the debug context memory manager
  40   --statistics             include statistics
  41   --assertions             turn on assertions
  42   --tracing                include tracing code
  43   --dumping                include dumping code
  44   --muzzle                 complete silence (no non-result output)
  45   --coverage               support for gcov coverage testing
  46   --profiling              support for gprof profiling
  47   --unit-testing           support for unit testing
  48   --python2                force Python 2 (deprecated)
  49   --python-bindings        build Python bindings based on new C++ API
  50   --java-bindings          build Java bindings based on new C++ API
  51   --all-bindings           build bindings for all supported languages
  52   --asan                   build with ASan instrumentation
  53   --ubsan                  build with UBSan instrumentation
  54   --tsan                   build with TSan instrumentation
  55   --werror                 build with -Werror
  56   --ipo                    build with interprocedural optimization
  57
  58 Optional Packages:
  59 The following flags enable optional packages (disable with --no-<option name>).
  60   --cln                    use CLN instead of GMP
  61   --glpk                   use GLPK simplex solver
  62   --abc                    use the ABC AIG library
  63   --cryptominisat          use the CryptoMiniSat SAT solver
  64   --kissat                 use the Kissat SAT solver
  65   --poly                   use the LibPoly library [default=yes]
  66   --cocoa                  use the CoCoA library
  67   --editline               support the editline library
  68
  69 Optional Path to Optional Packages:
  70   --abc-dir=PATH           path to top level of ABC source tree
  71   --glpk-dir=PATH          path to top level of GLPK installation
  72   --dep-path=PATH          path to a dependency installation dir
  73
  74 Build limitations:
  75   --lib-only               only build the library, but not the executable or
  76                            the parser (default: off)
  77
  78 CMake Options (Advanced)
  79   -DVAR=VALUE              manually add CMake options
  80
  81 EOF
  82   exit 0
  83 }
  84
  85 #--------------------------------------------------------------------------#
  86
  87 die () {
  88   echo "*** configure.sh: $*" 1>&2
  89   exit 1
  90 }
  91
  92 msg () {
  93   echo "[configure.sh] $*"
  94 }
  95
  96 #--------------------------------------------------------------------------#
  97
  98 [ ! -e src/theory ] && die "$0 not called from CVC4 base directory"
  99
 100 #--------------------------------------------------------------------------#
 101
 102 build_dir=build
 103 install_prefix=default
 104 program_prefix=""
 105
 106 #--------------------------------------------------------------------------#
 107
 108 buildtype=default
 109
 110 abc=default
 111 asan=default
 112 assertions=default
 113 auto_download=default
 114 cln=default
 115 comp_inc=default
 116 coverage=default
 117 cryptominisat=default
 118 debug_context_mm=default
 119 debug_symbols=default
 120 docs=default
 121 dumping=default
 122 glpk=default
 123 gpl=default
 124 kissat=default
 125 poly=ON
 126 cocoa=default
 127 muzzle=default
 128 ninja=default
 129 profiling=default
 130 python2=default
 131 python_bindings=default
 132 java_bindings=default
 133 editline=default
 134 static_library=default
 135 static_binary=default
 136 statistics=default
 137 tracing=default
 138 tsan=default
 139 ubsan=default
 140 unit_testing=default
 141 valgrind=default
 142 win64=default
 143 arm64=default
 144 werror=default
 145 ipo=default
 146
 147 abc_dir=default
 148 glpk_dir=default
 149
 150 #--------------------------------------------------------------------------#
 151
 152 cmake_opts=""
 153
 154 while [ $# -gt 0 ]
 155 do
 156   case $1 in
 157
 158     -h|--help) usage;;
 159
 160     --abc) abc=ON;;
 161     --no-abc) abc=OFF;;
 162
 163     --asan) asan=ON;;
 164     --no-asan) asan=OFF;;
 165
 166     --ubsan) ubsan=ON;;
 167     --no-ubsan) ubsan=OFF;;
 168
 169     --tsan) tsan=ON;;
 170     --no-tsan) tsan=OFF;;
 171
 172     --werror) werror=ON;;
 173
 174     --ipo) ipo=ON;;
 175     --no-ipo) ipo=OFF;;
 176
 177     --assertions) assertions=ON;;
 178     --no-assertions) assertions=OFF;;
 179
 180     # Best configuration
 181     --best)
 182       ipo=ON
 183       abc=ON
 184       cln=ON
 185       cryptominisat=ON
 186       glpk=ON
 187       editline=ON
 188       ;;
 189
 190     --prefix) die "missing argument to $1 (try -h)" ;;
 191     --prefix=*)
 192         install_prefix=${1##*=}
 193         # Check if install_prefix is an absolute path and if not, make it
 194         # absolute.
 195         case $install_prefix in
 196           /*) ;;                                      # absolute path
 197           *) install_prefix=$(pwd)/$install_prefix ;; # make absolute path
 198         esac
 199         ;;
 200
 201     --program-prefix) die "missing argument to $1 (try -h)" ;;
 202     --program-prefix=*) program_prefix=${1##*=} ;;
 203
 204     --name) die "missing argument to $1 (try -h)" ;;
 205     --name=*) build_dir=${1##*=} ;;
 206
 207     --cln) cln=ON;;
 208     --no-cln) cln=OFF;;
 209
 210     --coverage) coverage=ON;;
 211     --no-coverage) coverage=OFF;;
 212
 213     --cryptominisat) cryptominisat=ON;;
 214     --no-cryptominisat) cryptominisat=OFF;;
 215
 216     --debug-symbols) debug_symbols=ON;;
 217     --no-debug-symbols) debug_symbols=OFF;;
 218
 219     --debug-context-mm) debug_context_mm=ON;;
 220     --no-debug-context-mm) debug_context_mm=OFF;;
 221
 222     --dumping) dumping=ON;;
 223     --no-dumping) dumping=OFF;;
 224
 225     --gpl) gpl=ON;;
 226     --no-gpl) gpl=OFF;;
 227
 228     --kissat) kissat=ON;;
 229     --no-kissat) kissat=OFF;;
 230
 231     --win64) win64=ON;;
 232
 233     --arm64) arm64=ON;;
 234
 235     --ninja) ninja=ON;;
 236
 237     --docs) docs=ON;;
 238     --no-docs) docs=OFF;;
 239
 240     --glpk) glpk=ON;;
 241     --no-glpk) glpk=OFF;;
 242
 243     --poly) poly=ON;;
 244     --no-poly) poly=OFF;;
 245
 246     --cocoa) cocoa=ON;;
 247     --no-cocoa) cocoa=OFF;;
 248
 249     --muzzle) muzzle=ON;;
 250     --no-muzzle) muzzle=OFF;;
 251
 252     --static) static_library=ON; static_binary=ON;;
 253     --no-static) static_library=OFF;;
 254
 255     --static-binary) static_binary=ON;;
 256     --no-static-binary) static_binary=OFF;;
 257
 258     --auto-download) auto_download=ON;;
 259     --no-auto-download) auto_download=OFF;;
 260
 261     --statistics) statistics=ON;;
 262     --no-statistics) statistics=OFF;;
 263
 264     --tracing) tracing=ON;;
 265     --no-tracing) tracing=OFF;;
 266
 267     --unit-testing) unit_testing=ON;;
 268     --no-unit-testing) unit_testing=OFF;;
 269
 270     --python2) python2=ON;;
 271     --no-python2) python2=OFF;;
 272
 273     --python-bindings) python_bindings=ON;;
 274     --no-python-bindings) python_bindings=OFF;;
 275
 276     --java-bindings) java_bindings=ON;;
 277     --no-java-bindings) java_bindings=OFF;;
 278
 279     --all-bindings)
 280       python_bindings=ON
 281       java_bindings=ON;;
 282
 283     --valgrind) valgrind=ON;;
 284     --no-valgrind) valgrind=OFF;;
 285
 286     --profiling) profiling=ON;;
 287     --no-profiling) profiling=OFF;;
 288
 289     --editline) editline=ON;;
 290     --no-editline) editline=OFF;;
 291
 292     --abc-dir) die "missing argument to $1 (try -h)" ;;
 293     --abc-dir=*) abc_dir=${1##*=} ;;
 294
 295     --glpk-dir) die "missing argument to $1 (try -h)" ;;
 296     --glpk-dir=*) glpk_dir=${1##*=} ;;
 297
 298     --dep-path) die "missing argument to $1 (try -h)" ;;
 299     --dep-path=*) dep_path="${dep_path};${1##*=}" ;;
 300
 301     -D*) cmake_opts="${cmake_opts} $1" ;;
 302
 303     -*) die "invalid option '$1' (try -h)";;
 304
 305     *) case $1 in
 306          production)      buildtype=Production;;
 307          debug)           buildtype=Debug;;
 308          testing)         buildtype=Testing;;
 309          competition)     buildtype=Competition;;
 310          competition-inc) buildtype=Competition; comp_inc=ON;;
 311          *)               die "invalid build type (try -h)";;
 312        esac
 313        ;;
 314   esac
 315   shift
 316 done
 317
 318 #--------------------------------------------------------------------------#
 319
 320 if [ $werror != default ]; then
 321   export CFLAGS=-Werror
 322   export CXXFLAGS=-Werror
 323 fi
 324
 325 [ $buildtype != default ] \
 326   && cmake_opts="$cmake_opts -DCMAKE_BUILD_TYPE=$buildtype"
 327
 328 [ $asan != default ] \
 329   && cmake_opts="$cmake_opts -DENABLE_ASAN=$asan"
 330 [ $auto_download != default ] \
 331   && cmake_opts="$cmake_opts -DENABLE_AUTO_DOWNLOAD=$auto_download"
 332 [ $ubsan != default ] \
 333   && cmake_opts="$cmake_opts -DENABLE_UBSAN=$ubsan"
 334 [ $tsan != default ] \
 335   && cmake_opts="$cmake_opts -DENABLE_TSAN=$tsan"
 336 [ $ipo != default ] \
 337   && cmake_opts="$cmake_opts -DENABLE_IPO=$ipo"
 338 [ $assertions != default ] \
 339   && cmake_opts="$cmake_opts -DENABLE_ASSERTIONS=$assertions"
 340 [ $comp_inc != default ] \
 341   && cmake_opts="$cmake_opts -DENABLE_COMP_INC_TRACK=$comp_inc"
 342 [ $coverage != default ] \
 343   && cmake_opts="$cmake_opts -DENABLE_COVERAGE=$coverage"
 344 [ $debug_symbols != default ] \
 345   && cmake_opts="$cmake_opts -DENABLE_DEBUG_SYMBOLS=$debug_symbols"
 346 [ $debug_context_mm != default ] \
 347   && cmake_opts="$cmake_opts -DENABLE_DEBUG_CONTEXT_MM=$debug_context_mm"
 348 [ $dumping != default ] \
 349   && cmake_opts="$cmake_opts -DENABLE_DUMPING=$dumping"
 350 [ $gpl != default ] \
 351   && cmake_opts="$cmake_opts -DENABLE_GPL=$gpl"
 352 [ $win64 != default ] \
 353   && cmake_opts="$cmake_opts -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-mingw64.cmake"
 354 [ $arm64 != default ] \
 355   && cmake_opts="$cmake_opts -DCMAKE_TOOLCHAIN_FILE=../cmake/Toolchain-aarch64.cmake"
 356 [ $ninja != default ] && cmake_opts="$cmake_opts -G Ninja"
 357 [ $muzzle != default ] \
 358   && cmake_opts="$cmake_opts -DENABLE_MUZZLE=$muzzle"
 359 [ $static_library != default ] \
 360   && cmake_opts="$cmake_opts -DENABLE_STATIC_LIBRARY=$static_library"
 361 [ $static_binary != default ] \
 362   && cmake_opts="$cmake_opts -DENABLE_STATIC_BINARY=$static_binary"
 363 [ $statistics != default ] \
 364   && cmake_opts="$cmake_opts -DENABLE_STATISTICS=$statistics"
 365 [ $tracing != default ] \
 366   && cmake_opts="$cmake_opts -DENABLE_TRACING=$tracing"
 367 [ $unit_testing != default ] \
 368   && cmake_opts="$cmake_opts -DENABLE_UNIT_TESTING=$unit_testing"
 369 [ $python2 != default ] \
 370   && cmake_opts="$cmake_opts -DUSE_PYTHON2=$python2"
 371 [ $docs != default ] \
 372   && cmake_opts="$cmake_opts -DBUILD_DOCS=$docs"
 373 [ $python_bindings != default ] \
 374   && cmake_opts="$cmake_opts -DBUILD_BINDINGS_PYTHON=$python_bindings"
 375 [ $java_bindings != default ] \
 376   && cmake_opts="$cmake_opts -DBUILD_BINDINGS_JAVA=$java_bindings"
 377 [ $valgrind != default ] \
 378   && cmake_opts="$cmake_opts -DENABLE_VALGRIND=$valgrind"
 379 [ $profiling != default ] \
 380   && cmake_opts="$cmake_opts -DENABLE_PROFILING=$profiling"
 381 [ $editline != default ] \
 382   && cmake_opts="$cmake_opts -DUSE_EDITLINE=$editline"
 383 [ $abc != default ] \
 384   && cmake_opts="$cmake_opts -DUSE_ABC=$abc"
 385 [ $cln != default ] \
 386   && cmake_opts="$cmake_opts -DUSE_CLN=$cln"
 387 [ $cryptominisat != default ] \
 388   && cmake_opts="$cmake_opts -DUSE_CRYPTOMINISAT=$cryptominisat"
 389 [ $glpk != default ] \
 390   && cmake_opts="$cmake_opts -DUSE_GLPK=$glpk"
 391 [ $kissat != default ] \
 392   && cmake_opts="$cmake_opts -DUSE_KISSAT=$kissat"
 393 [ $poly != default ] \
 394   && cmake_opts="$cmake_opts -DUSE_POLY=$poly"
 395 [ $cocoa != default ] \
 396   && cmake_opts="$cmake_opts -DUSE_COCOA=$cocoa"
 397 [ "$abc_dir" != default ] \
 398   && cmake_opts="$cmake_opts -DABC_DIR=$abc_dir"
 399 [ "$glpk_dir" != default ] \
 400   && cmake_opts="$cmake_opts -DGLPK_DIR=$glpk_dir"
 401 [ "$dep_path" != default ] \
 402   && cmake_opts="$cmake_opts -DCMAKE_PREFIX_PATH=$dep_path"
 403 [ "$install_prefix" != default ] \
 404   && cmake_opts="$cmake_opts -DCMAKE_INSTALL_PREFIX=$install_prefix"
 405 [ -n "$program_prefix" ] \
 406   && cmake_opts="$cmake_opts -DPROGRAM_PREFIX=$program_prefix"
 407
 408 root_dir=$(pwd)
 409
 410 # The cmake toolchain can't be changed once it is configured in $build_dir.
 411 # Thus, remove $build_dir and create an empty directory.
 412 [ $win64 = ON ] && [ -e "$build_dir" ] && rm -r "$build_dir"
 413 [ $arm64 = ON ] && [ -e "$build_dir" ] && rm -r "$build_dir"
 414 mkdir -p "$build_dir"
 415
 416 cd "$build_dir"
 417
 418 [ -e CMakeCache.txt ] && rm CMakeCache.txt
 419 build_dir_escaped=$(echo "$build_dir" | sed 's/\//\\\//g')
 420 cmake "$root_dir" $cmake_opts 2>&1 | \
 421   sed "s/^Now just/Now change to '$build_dir_escaped' and/"