CMakeLists.txt

   1 cmake_minimum_required(VERSION 3.4)
   2
   3 #-----------------------------------------------------------------------------#
   4 # Project configuration
   5
   6 project(cvc4)
   7
   8 include(GNUInstallDirs)
   9
  10 set(CVC4_MAJOR   1) # Major component of the version of CVC4.
  11 set(CVC4_MINOR   9) # Minor component of the version of CVC4.
  12 set(CVC4_RELEASE 0) # Release component of the version of CVC4.
  13
  14 # Extraversion component of the version of CVC4.
  15 set(CVC4_EXTRAVERSION "-prerelease")
  16
  17 # Shared library versioning. Increment SOVERSION for every new CVC4 release.
  18 set(CVC4_SOVERSION 7)
  19
  20 # Full release string for CVC4.
  21 if(CVC4_RELEASE)
  22   set(CVC4_RELEASE_STRING
  23       "${CVC4_MAJOR}.${CVC4_MINOR}.${CVC4_RELEASE}${CVC4_EXTRAVERSION}")
  24 else()
  25   set(CVC4_RELEASE_STRING "${CVC4_MAJOR}.${CVC4_MINOR}${CVC4_EXTRAVERSION}")
  26 endif()
  27
  28 set(CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
  29 set(CMAKE_C_STANDARD 99)
  30 set(CMAKE_CXX_STANDARD 11)
  31 set(CMAKE_CXX_EXTENSIONS OFF)
  32
  33 # Generate compile_commands.json, which can be used for various code completion
  34 # plugins.
  35 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  36
  37 #-----------------------------------------------------------------------------#
  38 # Policies
  39
  40 # Required for FindGLPK since it sets CMAKE_REQUIRED_LIBRARIES
  41 if(POLICY CMP0075)
  42   cmake_policy(SET CMP0075 NEW)
  43 endif()
  44
  45 #-----------------------------------------------------------------------------#
  46 # Tell CMake where to find our dependencies
  47
  48 if(ABC_DIR)
  49   list(APPEND CMAKE_PREFIX_PATH "${ABC_DIR}")
  50 endif()
  51 if(ANTLR_DIR)
  52   list(APPEND CMAKE_PREFIX_PATH "${ANTLR_DIR}")
  53 endif()
  54 if(CADICAL_DIR)
  55   list(APPEND CMAKE_PREFIX_PATH "${CADICAL_DIR}")
  56 endif()
  57 if(CRYPTOMINISAT_DIR)
  58   list(APPEND CMAKE_PREFIX_PATH "${CRYPTOMINISAT_DIR}")
  59 endif()
  60 if(CXXTEST_DIR)
  61   list(APPEND CMAKE_PREFIX_PATH "${CXXTEST_DIR}")
  62 endif()
  63 if(DRAT2ER_DIR)
  64   list(APPEND CMAKE_PREFIX_PATH "${DRAT2ER_DIR}")
  65 endif()
  66 if(GLPK_DIR)
  67   list(APPEND CMAKE_PREFIX_PATH "${GLPK_DIR}")
  68 endif()
  69 if(GMP_DIR)
  70   list(APPEND CMAKE_PREFIX_PATH "${GMP_DIR}")
  71 endif()
  72 if(KISSAT_DIR)
  73   list(APPEND CMAKE_PREFIX_PATH "${KISSAT_DIR}")
  74 endif()
  75 if(LFSC_DIR)
  76   list(APPEND CMAKE_PREFIX_PATH "${LFSC_DIR}")
  77 endif()
  78 if(POLY_DIR)
  79   list(APPEND CMAKE_PREFIX_PATH "${POLY_DIR}")
  80 endif()
  81 if(SYMFPU_DIR)
  82   list(APPEND CMAKE_PREFIX_PATH "${SYMFPU_DIR}")
  83 endif()
  84
  85 # By default the contrib/get-* scripts install dependencies to deps/install.
  86 list(APPEND CMAKE_PREFIX_PATH "${PROJECT_SOURCE_DIR}/deps/install")
  87
  88 #-----------------------------------------------------------------------------#
  89
  90 include(Helpers)
  91
  92 #-----------------------------------------------------------------------------#
  93 # User options
  94
  95 # License
  96 option(ENABLE_GPL "Enable GPL dependencies")
  97
  98 # General build options
  99 #
 100 # >> 3-valued: IGNORE ON OFF
 101 #    > allows to detect if set by user (default: IGNORE)
 102 #    > only necessary for options set for build types
 103 cvc4_option(ENABLE_ASAN           "Enable ASAN build")
 104 cvc4_option(ENABLE_UBSAN          "Enable UBSan build")
 105 cvc4_option(ENABLE_TSAN           "Enable TSan build")
 106 cvc4_option(ENABLE_ASSERTIONS     "Enable assertions")
 107 cvc4_option(ENABLE_COMP_INC_TRACK
 108             "Enable optimizations for incremental SMT-COMP tracks")
 109 cvc4_option(ENABLE_DEBUG_SYMBOLS  "Enable debug symbols")
 110 cvc4_option(ENABLE_DUMPING        "Enable dumping")
 111 cvc4_option(ENABLE_MUZZLE         "Suppress ALL non-result output")
 112 cvc4_option(ENABLE_PROOFS         "Enable proof support")
 113 cvc4_option(ENABLE_STATISTICS     "Enable statistics")
 114 cvc4_option(ENABLE_TRACING        "Enable tracing")
 115 cvc4_option(ENABLE_UNIT_TESTING   "Enable unit testing")
 116 cvc4_option(ENABLE_VALGRIND       "Enable valgrind instrumentation")
 117 cvc4_option(ENABLE_SHARED         "Build as shared library")
 118 cvc4_option(ENABLE_STATIC_BINARY
 119             "Build static binaries with statically linked system libraries")
 120 # >> 2-valued: ON OFF
 121 #    > for options where we don't need to detect if set by user (default: OFF)
 122 option(ENABLE_BEST             "Enable dependencies known to give best performance")
 123 option(ENABLE_COVERAGE         "Enable support for gcov coverage testing")
 124 option(ENABLE_DEBUG_CONTEXT_MM "Enable the debug context memory manager")
 125 option(ENABLE_PROFILING        "Enable support for gprof profiling")
 126
 127 # Optional dependencies
 128 #
 129 # >> 3-valued: IGNORE ON OFF
 130 #    > allows to detect if set by user (default: IGNORE)
 131 #    > only necessary for options set for ENABLE_BEST
 132 cvc4_option(USE_ABC           "Use ABC for AIG bit-blasting")
 133 cvc4_option(USE_CADICAL       "Use CaDiCaL SAT solver")
 134 cvc4_option(USE_CLN           "Use CLN instead of GMP")
 135 cvc4_option(USE_CRYPTOMINISAT "Use CryptoMiniSat SAT solver")
 136 cvc4_option(USE_GLPK          "Use GLPK simplex solver")
 137 cvc4_option(USE_KISSAT        "Use Kissat SAT solver")
 138 cvc4_option(USE_EDITLINE      "Use Editline for better interactive support")
 139 # >> 2-valued: ON OFF
 140 #    > for options where we don't need to detect if set by user (default: OFF)
 141 option(USE_DRAT2ER            "Include drat2er for making eager BV proofs")
 142 option(USE_LFSC               "Use LFSC proof checker")
 143 option(USE_POLY               "Use LibPoly for polynomial arithmetic")
 144 option(USE_SYMFPU             "Use SymFPU for floating point support")
 145 option(USE_PYTHON2            "Prefer using Python 2 (for Python bindings)")
 146 option(USE_PYTHON3            "Prefer using Python 3 (for Python bindings)")
 147
 148 # Custom install directories for dependencies
 149 # If no directory is provided by the user, we first check if the dependency was
 150 # installed via the corresponding contrib/get-* script and if not found, we
 151 # check the intalled system version. If the user provides a directory we
 152 # immediately fail if the dependency was not found at the specified location.
 153 set(ABC_DIR           "" CACHE STRING "Set ABC install directory")
 154 set(ANTLR_DIR         "" CACHE STRING "Set ANTLR3 install directory")
 155 set(CADICAL_DIR       "" CACHE STRING "Set CaDiCaL install directory")
 156 set(CRYPTOMINISAT_DIR "" CACHE STRING "Set CryptoMiniSat install directory")
 157 set(CXXTEST_DIR       "" CACHE STRING "Set CxxTest install directory")
 158 set(DRAT2ER_DIR       "" CACHE STRING "Set drat2er install directory")
 159 set(GLPK_DIR          "" CACHE STRING "Set GLPK install directory")
 160 set(GMP_DIR           "" CACHE STRING "Set GMP install directory")
 161 set(KISSAT_DIR        "" CACHE STRING "Set Kissat install directory")
 162 set(LFSC_DIR          "" CACHE STRING "Set LFSC install directory")
 163 set(POLY_DIR          "" CACHE STRING "Set LibPoly install directory")
 164 set(SYMFPU_DIR        "" CACHE STRING "Set SymFPU install directory")
 165
 166 # Prepend binaries with prefix on make install
 167 set(PROGRAM_PREFIX    "" CACHE STRING "Program prefix on make install")
 168
 169 # Supprted language bindings based on new C++ API
 170 option(BUILD_BINDINGS_PYTHON "Build Python bindings based on new C++ API ")
 171 option(BUILD_BINDINGS_JAVA "Build Java bindings based on new C++ API ")
 172
 173 # Build limitations
 174 option(BUILD_LIB_ONLY         "Only build the library")
 175
 176 #-----------------------------------------------------------------------------#
 177 # Internal cmake variables
 178
 179 set(OPTIMIZATION_LEVEL 3)
 180 set(GPL_LIBS "")
 181
 182 #-----------------------------------------------------------------------------#
 183 # Determine number of threads available, used to configure (default) parallel
 184 # execution of custom test targets (can be overriden with ARGS=-jN).
 185
 186 include(ProcessorCount)
 187 ProcessorCount(CTEST_NTHREADS)
 188 if(CTEST_NTHREADS EQUAL 0)
 189   set(CTEST_NTHREADS 1)
 190 endif()
 191
 192 #-----------------------------------------------------------------------------#
 193 # Build types
 194
 195 # Note: Module CodeCoverage requires the name of the debug build to conform
 196 #       to cmake standards (first letter uppercase).
 197 set(BUILD_TYPES Production Debug Testing Competition)
 198
 199 if(ENABLE_ASAN OR ENABLE_UBSAN OR ENABLE_TSAN)
 200   set(CMAKE_BUILD_TYPE Debug)
 201 endif()
 202
 203 # Set the default build type to Production
 204 if(NOT CMAKE_BUILD_TYPE)
 205   set(CMAKE_BUILD_TYPE
 206       Production CACHE STRING "Options are: ${BUILD_TYPES}" FORCE)
 207   # Provide drop down menu options in cmake-gui
 208   set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS ${BUILD_TYPES})
 209 endif()
 210
 211 # Check if specified build type is valid.
 212 list(FIND BUILD_TYPES ${CMAKE_BUILD_TYPE} FOUND_BUILD_TYPE)
 213 if(${FOUND_BUILD_TYPE} EQUAL -1)
 214   message(FATAL_ERROR
 215     "'${CMAKE_BUILD_TYPE}' is not a valid build type. "
 216     "Available builds are: ${BUILD_TYPES}")
 217 endif()
 218
 219 message(STATUS "Building ${CMAKE_BUILD_TYPE} build")
 220 include(Config${CMAKE_BUILD_TYPE})
 221
 222 #-----------------------------------------------------------------------------#
 223 # Compiler flags
 224
 225 add_check_c_cxx_flag("-O${OPTIMIZATION_LEVEL}")
 226 add_check_c_cxx_flag("-Wall")
 227 add_check_c_flag("-fexceptions")
 228 add_check_c_cxx_flag("-Wno-deprecated")
 229 add_check_cxx_flag("-Wsuggest-override")
 230 add_check_cxx_flag("-Wnon-virtual-dtor")
 231 add_check_c_cxx_flag("-Wimplicit-fallthrough")
 232 add_check_c_cxx_flag("-Wshadow")
 233
 234 # Temporarily disable -Wclass-memaccess to suppress 'no trivial copy-assignment'
 235 # cdlist.h warnings. Remove when fixed.
 236 add_check_cxx_flag("-Wno-class-memaccess")
 237
 238 if (WIN32)
 239   set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--stack,100000000")
 240 endif ()
 241
 242 #-----------------------------------------------------------------------------#
 243 # Use ld.gold if available
 244
 245 execute_process(COMMAND ${CMAKE_C_COMPILER}
 246                 -fuse-ld=gold
 247                 -Wl,--version ERROR_QUIET OUTPUT_VARIABLE LD_VERSION)
 248 if ("${LD_VERSION}" MATCHES "GNU gold")
 249   string(APPEND CMAKE_EXE_LINKER_FLAGS " -fuse-ld=gold")
 250   string(APPEND CMAKE_SHARED_LINKER_FLAGS " -fuse-ld=gold")
 251   string(APPEND CMAKE_MODULE_LINKER_FLAGS " -fuse-ld=gold")
 252   message(STATUS "Using GNU gold linker.")
 253 endif ()
 254
 255 #-----------------------------------------------------------------------------#
 256 # Option defaults (three-valued options (cvc4_option(...)))
 257 #
 258 # These options are only set if their value is IGNORE. Otherwise, the user
 259 # already set the option, which we don't want to overwrite.
 260
 261 if(ENABLE_STATIC_BINARY)
 262   cvc4_set_option(ENABLE_SHARED OFF)
 263 else()
 264   cvc4_set_option(ENABLE_SHARED ON)
 265 endif()
 266
 267 #-----------------------------------------------------------------------------#
 268 # Set options for best configuration
 269
 270 if(ENABLE_BEST)
 271   cvc4_set_option(USE_ABC ON)
 272   cvc4_set_option(USE_CADICAL ON)
 273   cvc4_set_option(USE_CLN ON)
 274   cvc4_set_option(USE_CRYPTOMINISAT ON)
 275   cvc4_set_option(USE_GLPK ON)
 276   cvc4_set_option(USE_EDITLINE ON)
 277 endif()
 278
 279 # Only enable unit testing if assertions are enabled. Otherwise, unit tests
 280 # that expect AssertionException to be thrown will fail.
 281 if(NOT ENABLE_ASSERTIONS)
 282   set(ENABLE_UNIT_TESTING OFF)
 283 endif()
 284
 285 #-----------------------------------------------------------------------------#
 286 # Shared/static libraries
 287 #
 288 # This needs to be set before any find_package(...) command since we want to
 289 # search for static libraries with suffix .a.
 290
 291 if(ENABLE_SHARED)
 292   set(BUILD_SHARED_LIBS ON)
 293   if(ENABLE_STATIC_BINARY)
 294     set(ENABLE_STATIC_BINARY OFF)
 295     message(WARNING "Disabling static binary since shared build is enabled.")
 296   endif()
 297
 298   # Embed the installation prefix as an RPATH in the executable such that the
 299   # linker can find our libraries (such as libcvc4parser) when executing the
 300   # cvc4 binary. This is for example useful when installing CVC4 with a custom
 301   # prefix on macOS (e.g. when using homebrew in a non-standard directory). If
 302   # we do not set this option, then the linker will not be able to find the
 303   # required libraries when trying to run CVC4.
 304   #
 305   # Also embed the installation prefix of the installed contrib libraries as an
 306   # RPATH. This allows to install a dynamically linked binary that depends on
 307   # dynamically linked libraries. This is dangerous, as the installed binary
 308   # breaks if the contrib library is removed or changes in other ways, we thus
 309   # print a big warning and only allow if installing to a custom installation
 310   # prefix.
 311   #
 312   # More information on RPATH in CMake:
 313   # https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/RPATH-handling
 314   set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/${CMAKE_INSTALL_LIBDIR};${PROJECT_SOURCE_DIR}/deps/install/lib")
 315 else()
 316   # When building statically, we *only* want static archives/libraries
 317   if (WIN32)
 318       set(CMAKE_FIND_LIBRARY_SUFFIXES .lib .a)
 319   else()
 320       set(CMAKE_FIND_LIBRARY_SUFFIXES .a)
 321   endif()
 322   set(BUILD_SHARED_LIBS OFF)
 323   cvc4_set_option(ENABLE_STATIC_BINARY ON)
 324
 325   # Never build unit tests as static binaries, otherwise we'll end up with
 326   # ~300MB per unit test.
 327   if(ENABLE_UNIT_TESTING)
 328     message(WARNING "Disabling unit tests since static build is enabled.")
 329     set(ENABLE_UNIT_TESTING OFF)
 330   endif()
 331 endif()
 332
 333 #-----------------------------------------------------------------------------#
 334 # Enable the ctest testing framework
 335
 336 # This needs to be enabled here rather than in subdirectory test in order to
 337 # allow calling ctest from the root build directory.
 338 enable_testing()
 339
 340 #-----------------------------------------------------------------------------#
 341 # Check GCC version.
 342 #
 343 # GCC version 4.5.1 builds MiniSat incorrectly with -O2, which results in
 344 # incorrect answers.
 345
 346 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
 347   execute_process(
 348     COMMAND ${CMAKE_CXX_COMPILER} -dumpversion
 349     OUTPUT_VARIABLE GCC_VERSION
 350     OUTPUT_STRIP_TRAILING_WHITESPACE)
 351   if(GCC_VERSION VERSION_EQUAL "4.5.1")
 352     message(FATAL_ERROR
 353       "GCC 4.5.1's optimizer is known to build MiniSat incorrectly "
 354       "(and by extension CVC4).")
 355   endif()
 356 endif()
 357
 358 #-----------------------------------------------------------------------------#
 359 # Check options, find packages and configure build.
 360
 361 if(USE_PYTHON2)
 362   find_package(PythonInterp 2.7 REQUIRED)
 363 elseif(USE_PYTHON3)
 364   find_package(PythonInterp 3 REQUIRED)
 365 else()
 366   find_package(PythonInterp REQUIRED)
 367 endif()
 368
 369 find_package(GMP REQUIRED)
 370
 371 if(ENABLE_ASAN)
 372   # -fsanitize=address requires CMAKE_REQUIRED_FLAGS to be explicitely set,
 373   # otherwise the -fsanitize=address check will fail while linking.
 374   set(CMAKE_REQUIRED_FLAGS -fsanitize=address)
 375   add_required_c_cxx_flag("-fsanitize=address")
 376   unset(CMAKE_REQUIRED_FLAGS)
 377   add_required_c_cxx_flag("-fno-omit-frame-pointer")
 378   add_check_c_cxx_flag("-fsanitize-recover=address")
 379 endif()
 380
 381 if(ENABLE_UBSAN)
 382   add_required_c_cxx_flag("-fsanitize=undefined")
 383   add_definitions(-DCVC4_USE_UBSAN)
 384 endif()
 385
 386 if(ENABLE_TSAN)
 387   # -fsanitize=thread requires CMAKE_REQUIRED_FLAGS to be explicitely set,
 388   # otherwise the -fsanitize=thread check will fail while linking.
 389   set(CMAKE_REQUIRED_FLAGS -fsanitize=thread)
 390   add_required_c_cxx_flag("-fsanitize=thread")
 391   unset(CMAKE_REQUIRED_FLAGS)
 392 endif()
 393
 394 if(ENABLE_ASSERTIONS)
 395   add_definitions(-DCVC4_ASSERTIONS)
 396 else()
 397   add_definitions(-DNDEBUG)
 398 endif()
 399
 400 if(ENABLE_COVERAGE)
 401   include(CodeCoverage)
 402   APPEND_COVERAGE_COMPILER_FLAGS()
 403   add_definitions(-DCVC4_COVERAGE)
 404   # Note: The ctest command returns a non-zero exit code if tests fail or run
 405   # into a timeout. As a consequence, the coverage report is not generated. To
 406   # prevent this we always return with exit code 0 after the ctest command has
 407   # finished.
 408   setup_target_for_coverage_gcovr_html(
 409     NAME coverage
 410     EXECUTABLE
 411       ctest -j${CTEST_NTHREADS} -LE "example"
 412         --output-on-failure $$ARGS || exit 0
 413     DEPENDS
 414       build-tests)
 415 endif()
 416
 417 if(ENABLE_DEBUG_CONTEXT_MM)
 418   add_definitions(-DCVC4_DEBUG_CONTEXT_MEMORY_MANAGER)
 419 endif()
 420
 421 if(ENABLE_DEBUG_SYMBOLS)
 422   add_check_c_cxx_flag("-ggdb3")
 423 endif()
 424
 425 if(ENABLE_COMP_INC_TRACK)
 426   add_definitions(-DCVC4_SMTCOMP_APPLICATION_TRACK)
 427 endif()
 428
 429 if(ENABLE_MUZZLE)
 430   add_definitions(-DCVC4_MUZZLE)
 431 endif()
 432
 433 if(ENABLE_DUMPING)
 434   add_definitions(-DCVC4_DUMPING)
 435 endif()
 436
 437 if(ENABLE_PROFILING)
 438   add_definitions(-DCVC4_PROFILING)
 439   add_check_c_cxx_flag("-pg")
 440 endif()
 441
 442 if(ENABLE_PROOFS)
 443   set(RUN_REGRESSION_ARGS ${RUN_REGRESSION_ARGS} --enable-proof)
 444   add_definitions(-DCVC4_PROOF)
 445 endif()
 446
 447 if(ENABLE_TRACING)
 448   add_definitions(-DCVC4_TRACING)
 449 endif()
 450
 451 if(ENABLE_STATISTICS)
 452   add_definitions(-DCVC4_STATISTICS_ON)
 453 endif()
 454
 455 if(ENABLE_VALGRIND)
 456   find_package(Valgrind REQUIRED)
 457   add_definitions(-DCVC4_VALGRIND)
 458 endif()
 459
 460 if(USE_ABC)
 461   find_package(ABC REQUIRED)
 462   add_definitions(-DCVC4_USE_ABC ${ABC_ARCH_FLAGS})
 463 endif()
 464
 465 if(USE_CADICAL)
 466   find_package(CaDiCaL REQUIRED)
 467   add_definitions(-DCVC4_USE_CADICAL)
 468 endif()
 469
 470 if(USE_CLN)
 471   set(GPL_LIBS "${GPL_LIBS} cln")
 472   find_package(CLN 1.2.2 REQUIRED)
 473   set(CVC4_USE_CLN_IMP 1)
 474   set(CVC4_USE_GMP_IMP 0)
 475 else()
 476   set(CVC4_USE_CLN_IMP 0)
 477   set(CVC4_USE_GMP_IMP 1)
 478 endif()
 479
 480 if(USE_CRYPTOMINISAT)
 481   # CryptoMiniSat requires pthreads support
 482   set(THREADS_PREFER_PTHREAD_FLAG ON)
 483   find_package(Threads REQUIRED)
 484   if(THREADS_HAVE_PTHREAD_ARG)
 485     add_c_cxx_flag(-pthread)
 486   endif()
 487   find_package(CryptoMiniSat REQUIRED)
 488   add_definitions(-DCVC4_USE_CRYPTOMINISAT)
 489 endif()
 490
 491 if(USE_DRAT2ER)
 492   find_package(Drat2Er REQUIRED)
 493   add_definitions(-DCVC4_USE_DRAT2ER)
 494 endif()
 495
 496 if(USE_GLPK)
 497   set(GPL_LIBS "${GPL_LIBS} glpk")
 498   find_package(GLPK REQUIRED)
 499   add_definitions(-DCVC4_USE_GLPK)
 500 endif()
 501
 502 if(USE_KISSAT)
 503   find_package(Kissat REQUIRED)
 504   add_definitions(-DCVC4_USE_KISSAT)
 505 endif()
 506
 507 if(USE_LFSC)
 508   set(RUN_REGRESSION_ARGS ${RUN_REGRESSION_ARGS} --with-lfsc)
 509   find_package(LFSC REQUIRED)
 510   add_definitions(-DCVC4_USE_LFSC)
 511 endif()
 512
 513 if(USE_POLY)
 514   find_package(Poly REQUIRED)
 515   add_definitions(-DCVC4_USE_POLY)
 516   set(CVC4_USE_POLY_IMP 1)
 517 else()
 518   set(CVC4_USE_POLY_IMP 0)
 519 endif()
 520
 521 if(USE_EDITLINE)
 522   find_package(Editline REQUIRED)
 523   set(HAVE_LIBEDITLINE 1)
 524   if(Editline_COMPENTRY_FUNC_RETURNS_CHARPTR)
 525     set(EDITLINE_COMPENTRY_FUNC_RETURNS_CHARP 1)
 526   endif()
 527 endif()
 528
 529 if(USE_SYMFPU)
 530   find_package(SymFPU REQUIRED)
 531   add_definitions(-DCVC4_USE_SYMFPU)
 532   set(CVC4_USE_SYMFPU 1)
 533 else()
 534   set(CVC4_USE_SYMFPU 0)
 535 endif()
 536
 537 if(GPL_LIBS)
 538   if(NOT ENABLE_GPL)
 539     message(FATAL_ERROR
 540       "Bad configuration detected: BSD-licensed code only, but also requested "
 541       "GPLed libraries: ${GPL_LIBS}")
 542   endif()
 543   set(CVC4_GPL_DEPS 1)
 544 endif()
 545
 546 #-----------------------------------------------------------------------------#
 547 # Generate CVC4's cvc4autoconfig.h header
 548
 549 include(ConfigureCVC4)
 550 if(NOT ENABLE_SHARED)
 551   set(CVC4_STATIC_BUILD ON)
 552 endif()
 553 configure_file(cvc4autoconfig.h.in cvc4autoconfig.h)
 554 unset(CVC4_STATIC_BUILD)
 555 include_directories(${CMAKE_CURRENT_BINARY_DIR})
 556
 557 #-----------------------------------------------------------------------------#
 558 # Add subdirectories
 559
 560 # signatures needs to come before src since it adds source files to libcvc4.
 561 if(ENABLE_PROOFS)
 562   add_subdirectory(proofs/signatures)
 563 endif()
 564
 565 add_subdirectory(doc)
 566 add_subdirectory(src)
 567 add_subdirectory(test)
 568
 569 if(BUILD_BINDINGS_PYTHON)
 570   set(BUILD_BINDINGS_PYTHON_VERSION ${PYTHON_VERSION_MAJOR})
 571   add_subdirectory(src/api/python)
 572 endif()
 573
 574 if(BUILD_BINDINGS_JAVA)
 575   message(FATAL_ERROR
 576     "Java bindings for the new API are not implemented yet.")
 577 endif()
 578
 579 #-----------------------------------------------------------------------------#
 580 # Package configuration
 581 #
 582 # Export CVC4 targets to support find_package(CVC4) in other cmake projects.
 583
 584 include(CMakePackageConfigHelpers)
 585
 586 # If we install a dynamically linked binary that also uses dynamically used
 587 # libraries from deps/install/lib, we need to be cautious. Changing these
 588 # shared libraries from deps/install/lib most probably breaks the binary.
 589 # We only allow such an installation for custom installation prefixes
 590 # (in the assumption that only reasonably experienced users use this and
 591 # also that custom installation prefixes are not used for longer periods of
 592 # time anyway). Also, we print a big warning with further instructions.
 593 if(NOT ENABLE_STATIC_BINARY)
 594   # Get the libraries that cvc4 links against
 595   get_target_property(libs cvc4 INTERFACE_LINK_LIBRARIES)
 596   set(LIBS_SHARED_FROM_DEPS "")
 597   foreach(lib ${libs})
 598     # Filter out those that are linked dynamically and come from deps/install
 599     if(lib MATCHES ".*/deps/install/lib/.*\.so")
 600       list(APPEND LIBS_SHARED_FROM_DEPS ${lib})
 601     endif()
 602   endforeach()
 603   list(LENGTH LIBS_SHARED_FROM_DEPS list_len)
 604   # Check if we actually use such "dangerous" libraries
 605   if(list_len GREATER 0)
 606     # Print a generic warning
 607     install(CODE "message(WARNING \"You are installing a dynamically linked \
 608     binary of CVC4 which may be a problem if you are using any dynamically \
 609     linked third-party library that you obtained through one of the \
 610     contrib/get-xxx scripts. The binary uses the rpath mechanism to find these \
 611     locally, hence executing such a contrib script removing the \
 612     \\\"deps/install\\\" folder most probably breaks the installed binary! \
 613     Consider installing the dynamically linked dependencies on your system \
 614     manually or link cvc4 statically.\")")
 615     # Print the libraries in question
 616     foreach(lib ${LIBS_SHARED_FROM_DEPS})
 617       install(CODE "message(WARNING \"The following library is used by the cvc4 binary: ${lib}\")")
 618     endforeach()
 619     # Check if we use a custom installation prefix
 620     if(CMAKE_INSTALL_PREFIX STREQUAL "/usr/local")
 621       install(CODE "message(FATAL_ERROR \"To avoid installing a \
 622       soon-to-be-broken binary, system-wide installation is disabled if the \
 623       binary depends on locally-built shared libraries.\")")
 624     else()
 625       install(CODE "message(WARNING \"You have selected a custom install \
 626       directory ${CMAKE_INSTALL_PREFIX}, so we expect you understood the \
 627       previous warning and know what you are doing.\")")
 628     endif()
 629   endif()
 630 endif()
 631
 632 install(EXPORT cvc4-targets
 633   FILE CVC4Targets.cmake
 634   NAMESPACE CVC4::
 635   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/CVC4)
 636
 637 configure_package_config_file(
 638   ${CMAKE_SOURCE_DIR}/cmake/CVC4Config.cmake.in
 639   ${CMAKE_BINARY_DIR}/cmake/CVC4Config.cmake
 640   INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/CVC4
 641   PATH_VARS CMAKE_INSTALL_LIBDIR
 642 )
 643
 644 write_basic_package_version_file(
 645   ${CMAKE_CURRENT_BINARY_DIR}/CVC4ConfigVersion.cmake
 646   VERSION ${CVC4_RELEASE_STRING}
 647   COMPATIBILITY ExactVersion
 648 )
 649
 650 install(FILES
 651   ${CMAKE_BINARY_DIR}/cmake/CVC4Config.cmake
 652   ${CMAKE_BINARY_DIR}/CVC4ConfigVersion.cmake
 653   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/CVC4
 654 )
 655
 656
 657 #-----------------------------------------------------------------------------#
 658 # Print build configuration
 659
 660 # Convert build type to lower case.
 661 string(TOLOWER ${CMAKE_BUILD_TYPE} CVC4_BUILD_PROFILE_STRING)
 662
 663 # Get all definitions added via add_definitions.
 664 get_directory_property(CVC4_DEFINITIONS COMPILE_DEFINITIONS)
 665 string(REPLACE ";" " " CVC4_DEFINITIONS "${CVC4_DEFINITIONS}")
 666
 667 message("CVC4 ${CVC4_RELEASE_STRING}")
 668 message("")
 669 if(ENABLE_COMP_INC_TRACK)
 670   message("Build profile             : ${CVC4_BUILD_PROFILE_STRING} (incremental)")
 671 else()
 672   message("Build profile             : ${CVC4_BUILD_PROFILE_STRING}")
 673 endif()
 674 message("")
 675 print_config("GPL                       :" ENABLE_GPL)
 676 print_config("Best configuration        :" ENABLE_BEST)
 677 print_config("Optimization level        :" OPTIMIZATION_LEVEL)
 678 message("")
 679 print_config("Assertions                :" ENABLE_ASSERTIONS)
 680 print_config("Debug symbols             :" ENABLE_DEBUG_SYMBOLS)
 681 print_config("Debug context mem mgr     :" ENABLE_DEBUG_CONTEXT_MM)
 682 message("")
 683 print_config("Dumping                   :" ENABLE_DUMPING)
 684 print_config("Muzzle                    :" ENABLE_MUZZLE)
 685 print_config("Proofs                    :" ENABLE_PROOFS)
 686 print_config("Statistics                :" ENABLE_STATISTICS)
 687 print_config("Tracing                   :" ENABLE_TRACING)
 688 message("")
 689 print_config("ASan                      :" ENABLE_ASAN)
 690 print_config("UBSan                     :" ENABLE_UBSAN)
 691 print_config("TSan                      :" ENABLE_TSAN)
 692 print_config("Coverage (gcov)           :" ENABLE_COVERAGE)
 693 print_config("Profiling (gprof)         :" ENABLE_PROFILING)
 694 print_config("Unit tests                :" ENABLE_UNIT_TESTING)
 695 print_config("Valgrind                  :" ENABLE_VALGRIND)
 696 message("")
 697 print_config("Shared libs               :" ENABLE_SHARED)
 698 print_config("Static binary             :" ENABLE_STATIC_BINARY)
 699 print_config("Python bindings           :" BUILD_BINDINGS_PYTHON)
 700 print_config("Java bindings             :" BUILD_BINDINGS_JAVA)
 701 print_config("Python2                   :" USE_PYTHON2)
 702 print_config("Python3                   :" USE_PYTHON3)
 703 message("")
 704 print_config("ABC                       :" USE_ABC)
 705 print_config("CaDiCaL                   :" USE_CADICAL)
 706 print_config("CryptoMiniSat             :" USE_CRYPTOMINISAT)
 707 print_config("drat2er                   :" USE_DRAT2ER)
 708 print_config("GLPK                      :" USE_GLPK)
 709 print_config("Kissat                    :" USE_KISSAT)
 710 print_config("LFSC                      :" USE_LFSC)
 711 print_config("LibPoly                   :" USE_POLY)
 712 message("")
 713 print_config("BUILD_LIB_ONLY            :" BUILD_LIB_ONLY)
 714
 715 if(CVC4_USE_CLN_IMP)
 716   message("MP library                : cln")
 717 else()
 718   message("MP library                : gmp")
 719 endif()
 720 print_config("Editline                  :" ${USE_EDITLINE})
 721 print_config("SymFPU                    :" ${USE_SYMFPU})
 722 message("")
 723 if(ABC_DIR)
 724   message("ABC dir                   : ${ABC_DIR}")
 725 endif()
 726 if(ANTLR_DIR)
 727   message("ANTLR dir                 : ${ANTLR_DIR}")
 728 endif()
 729 if(CADICAL_DIR)
 730   message("CADICAL dir               : ${CADICAL_DIR}")
 731 endif()
 732 if(CRYPTOMINISAT_DIR)
 733   message("CRYPTOMINISAT dir         : ${CRYPTOMINISAT_DIR}")
 734 endif()
 735 if(DRAT2ER_DIR)
 736   message("DRAT2ER dir               : ${DRAT2ER_DIR}")
 737 endif()
 738 if(GLPK_DIR)
 739   message("GLPK dir                  : ${GLPK_DIR}")
 740 endif()
 741 if(GMP_DIR)
 742   message("GMP dir                   : ${GMP_DIR}")
 743 endif()
 744 if(KISSAT_DIR)
 745   message("KISSAT dir                : ${KISSAT_DIR}")
 746 endif()
 747 if(LFSC_DIR)
 748   message("LFSC dir                  : ${LFSC_DIR}")
 749 endif()
 750 if(POLY_DIR)
 751   message("LibPoly dir               : ${POLY_DIR}")
 752 endif()
 753 if(SYMFPU_DIR)
 754   message("SYMFPU dir                : ${SYMFPU_DIR}")
 755 endif()
 756 message("")
 757 message("CPPLAGS (-D...)           : ${CVC4_DEFINITIONS}")
 758 message("CXXFLAGS                  : ${CMAKE_CXX_FLAGS}")
 759 message("CFLAGS                    : ${CMAKE_C_FLAGS}")
 760 message("Linker flags              : ${CMAKE_EXE_LINKER_FLAGS}")
 761 message("")
 762 message("Install prefix            : ${CMAKE_INSTALL_PREFIX}")
 763 message("")
 764
 765 if(GPL_LIBS)
 766   message(
 767   "CVC4 license             : ${Yellow}GPLv3 (due to optional libraries; see below)${ResetColor}"
 768   "\n"
 769   "\n"
 770   "Please note that CVC4 will be built against the following GPLed libraries:"
 771   "\n"
 772   "${GPL_LIBS}"
 773   "\n"
 774   "As these libraries are covered under the GPLv3, so is this build of CVC4."
 775   "\n"
 776   "CVC4 is also available to you under the terms of the (modified) BSD license."
 777   "\n"
 778   "If you prefer to license CVC4 under those terms, please configure CVC4 to"
 779   "\n"
 780   "disable all optional GPLed library dependencies (-DENABLE_BSD_ONLY=ON)."
 781   )
 782 else()
 783   message(
 784   "CVC4 license              : modified BSD"
 785   "\n"
 786   "\n"
 787   "Note that this configuration is NOT built against any GPL'ed libraries, so"
 788   "\n"
 789   "it is covered by the (modified) BSD license.  This is, however, not the best"
 790   "\n"
 791   "performing configuration of CVC4.  To build against GPL'ed libraries which"
 792   "\n"
 793   "improve CVC4's performance, re-configure with '-DENABLE_GPL -DENABLE_BEST'."
 794   )
 795 endif()
 796
 797 if("${CMAKE_GENERATOR}" STREQUAL "Ninja")
 798   set(BUILD_COMMAND_NAME "ninja")
 799 else()
 800   set(BUILD_COMMAND_NAME "make")
 801 endif()
 802
 803 message("")
 804 message("Now just type '${BUILD_COMMAND_NAME}', "
 805         "followed by '${BUILD_COMMAND_NAME} check' "
 806         "or '${BUILD_COMMAND_NAME} install'.")
 807 message("")