Replace automatic rdtscp checks with boolean option
[gromacs.git] / CMakeLists.txt
bloba66699ead192b18f4daad13f27ae875928661336
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2009,2010,2011,2012,2013 by the GROMACS development team.
5 # Copyright (c) 2014,2015,2016,2017,2018 by the GROMACS development team.
6 # Copyright (c) 2019,2020, by the GROMACS development team, led by
7 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 # and including many others, as listed in the AUTHORS file in the
9 # top-level source directory and at http://www.gromacs.org.
11 # GROMACS is free software; you can redistribute it and/or
12 # modify it under the terms of the GNU Lesser General Public License
13 # as published by the Free Software Foundation; either version 2.1
14 # of the License, or (at your option) any later version.
16 # GROMACS is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 # Lesser General Public License for more details.
21 # You should have received a copy of the GNU Lesser General Public
22 # License along with GROMACS; if not, see
23 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
26 # If you want to redistribute modifications to GROMACS, please
27 # consider that scientific software is very special. Version
28 # control is crucial - bugs must be traceable. We will be happy to
29 # consider code for inclusion in the official distribution, but
30 # derived work must not be called official GROMACS. Details are found
31 # in the README & COPYING files - if they are missing, get the
32 # official version at http://www.gromacs.org.
34 # To help us fund GROMACS development, we humbly ask that you cite
35 # the research papers on the package. Check out http://www.gromacs.org.
37 cmake_minimum_required(VERSION 3.13)
38 cmake_policy(SET CMP0074 NEW) # From CMake 3.12
39 cmake_policy(SET CMP0068 NEW) # From CMake-3.9
41 # CMake modules/macros are in a subdirectory to keep this file cleaner
42 # This needs to be set before project() in order to pick up toolchain files
43 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Platform)
45 if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
46     # Providing a default value >=10.14 helps to find modern C++ compatibility,
47     # such as by defaulting to the Clang libc++ instead of libstdc++.
48     set(CMAKE_OSX_DEPLOYMENT_TARGET 10.14 CACHE STRING
49         "OS X deployment target affects default SDK version and compiler flags."
50         FORCE)
51     # By default, limit the binary architecture to a single 64-bit build.
52     set(CMAKE_OSX_ARCHITECTURES x86_64 CACHE STRING
53         "OS X architecture affects the compatibility of the (potentially fat) binaries produced."
54         FORCE)
55 endif()
57 project(Gromacs)
59 set(CMAKE_CXX_STANDARD 17)
60 set(CMAKE_CXX_STANDARD_REQUIRED ON)
61 set(CMAKE_CXX_EXTENSIONS OFF)
63 include(gmxManageCcache)
65 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
66 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
67 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
69 find_package(LibStdCpp)
71 # Python is first referenced in gmxVersionInfo, so we perform the search early
72 # to find a suitable installation for all components.
73 include(gmxPythonDiscovery)
74 # Set up common version variables, as well as general information about
75 # the build tree (whether the build is from a source package or from a git
76 # repository).  Also declares a few functions that will be used for generating
77 # version info files later.
78 include(gmxBuildTreeInfo)
79 include(gmxVersionInfo)
81 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND UNIX)
82     set(CMAKE_INSTALL_PREFIX "/usr/local/gromacs" CACHE STRING "Installation prefix (installation will need write permissions here)" FORCE)
83 endif()
84 if("${CMAKE_INSTALL_PREFIX}" STREQUAL "${CMAKE_BINARY_DIR}")
85     message(FATAL_ERROR "GROMACS cannot be installed into the build tree, choose a different location for CMAKE_INSTALL_PREFIX")
86 endif()
88 include(gmxBuildTypeReference)
89 include(gmxBuildTypeProfile)
90 include(gmxBuildTypeTSAN)
91 include(gmxBuildTypeASAN)
92 include(gmxBuildTypeMSAN)
93 include(gmxBuildTypeReleaseWithAssert)
95 if(NOT CMAKE_BUILD_TYPE)
96     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel Reference RelWithAssert Profile TSAN ASAN MSAN." FORCE)
97     # Set the possible values of build type for cmake-gui
98     set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release"
99         "MinSizeRel" "RelWithDebInfo" "Reference" "RelWithAssert" "Profile" "TSAN" "ASAN" "MSAN")
100 endif()
101 if(CMAKE_CONFIGURATION_TYPES)
102     # Add appropriate GROMACS-specific build types for the Visual
103     # Studio generator (Debug, Release, MinSizeRel and RelWithDebInfo
104     # are already present by default).
105     list(APPEND CMAKE_CONFIGURATION_TYPES "RelWithAssert" "Reference")
106     list(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)
107     set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING
108         "List of configuration types"
109         FORCE)
110 endif()
111 set(build_types_with_explicit_flags RELEASE DEBUG RELWITHDEBINFO RELWITHASSERT MINSIZEREL PROFILE)
113 set_property(GLOBAL PROPERTY FIND_LIBRARY_USE_LIB64_PATHS ON)
115 include(gmxCTestUtilities)
116 gmx_ctest_init()
118 include(gmxCPackUtilities)
119 gmx_cpack_init()
121 # Variables that accumulate stuff influencing the installed headers
122 set(INSTALLED_HEADER_INCLUDE_DIRS "")
123 set(INSTALLED_HEADER_DEFINITIONS "")
125 ########################################################################
126 # Global non-cache variables for implementing the build system
127 ########################################################################
129 # These variables collect libraries that GROMACS requires for
130 # linking. They should be appended to with list(APPEND ${name}
131 # new-library) calls. They are:
132 #  - Libraries that are required for libgromacs (only)
133 set(GMX_EXTRA_LIBRARIES "")
134 #  - Libraries that are required for all code in the repository
135 set(GMX_COMMON_LIBRARIES "")
136 #  - Libraries that all code linked against libgromacs needs
137 #    (i.e., something that is exposed in installed headers).
138 set(GMX_PUBLIC_LIBRARIES "")
140 ########################################################################
141 # Check and warn if cache generated on a different host is being reused
142 ########################################################################
143 if(CMAKE_HOST_UNIX)
144     execute_process(COMMAND hostname
145                     OUTPUT_VARIABLE TMP_HOSTNAME
146                     OUTPUT_STRIP_TRAILING_WHITESPACE)
147     # Only check for host name if not running in a CI environment, as the cache might
148     # be reused there between different machines in different stages
149     if(GMX_BUILD_HOSTNAME AND NOT "${GMX_BUILD_HOSTNAME}" STREQUAL "${TMP_HOSTNAME}"
150             AND NOT DEFINED ENV{CI_JOB_ID})
151         message(WARNING "
152             The CMake cache, probably generated on a different host (${GMX_BUILD_HOSTNAME}),
153             is being reused! This could lead to inconsistencies; therefore, it is
154             recommended to regenerate the cache!")
155     endif()
156     set(GMX_BUILD_HOSTNAME "${TMP_HOSTNAME}" CACHE INTERNAL
157             "Hostname of the machine where the cache was generated.")
158 endif()
160 ########################################################################
161 # Detect architecture before setting options so we can alter defaults
162 ########################################################################
163 # Detect the architecture the compiler is targetting, detect
164 # SIMD instructions possibilities on that hardware, suggest SIMD instruction set
165 # to use if none is specified, and populate the cache option for CPU
166 # SIMD.
167 include(gmxDetectTargetArchitecture)
168 gmx_detect_target_architecture()
170 ########################################################################
171 # User input options                                                   #
172 ########################################################################
173 include(gmxOptionUtilities)
175 set(CMAKE_PREFIX_PATH "" CACHE STRING "Extra locations to search for external libraries and tools (give directory without lib, bin, or include)")
177 # Fujitsu only has SIMD in double precision, so this will be faster
178 gmx_set_boolean(GMX_DOUBLE_DEFAULT GMX_TARGET_FUJITSU_SPARC64)
179 option(GMX_DOUBLE "Use double precision (much slower, use only if you really need it)" ${GMX_DOUBLE_DEFAULT})
180 option(GMX_RELAXED_DOUBLE_PRECISION "Accept single precision 1/sqrt(x) when using Fujitsu HPC-ACE SIMD" OFF)
181 mark_as_advanced(GMX_RELAXED_DOUBLE_PRECISION)
183 option(GMX_MPI    "Build a parallel (message-passing) version of GROMACS" OFF)
184 option(GMX_THREAD_MPI  "Build a thread-MPI-based multithreaded version of GROMACS (not compatible with MPI)" ON)
185 gmx_dependent_option(
186     GMX_MPI_IN_PLACE
187     "Enable MPI_IN_PLACE for MPIs that have it defined"
188     ON
189     GMX_MPI)
190 mark_as_advanced(GMX_MPI_IN_PLACE)
192 option(GMX_MIMIC "Enable MiMiC QM/MM interface (CPMD is required)" OFF)
194 option(GMX_FAHCORE "Build a library with mdrun functionality" OFF)
195 mark_as_advanced(GMX_FAHCORE)
197 option(GMX_COOL_QUOTES "Enable GROMACS cool quotes" ON)
198 mark_as_advanced(GMX_COOL_QUOTES)
199 gmx_add_cache_dependency(GMX_COOL_QUOTES BOOL "NOT GMX_FAHCORE" OFF)
201 option(GMX_USE_OPENCL "Enable OpenCL acceleration" OFF)
203 option(GMX_INSTALL_LEGACY_API "Install legacy headers" OFF)
205 # The earliest version of the CUDA toolkit that supports c++14 is 9.0
206 set(REQUIRED_CUDA_VERSION 9.0)
207 set(REQUIRED_CUDA_COMPUTE_CAPABILITY 3.0)
209 # OpenCL required version: 1.2 or newer
210 set(REQUIRED_OPENCL_MIN_VERSION_MAJOR 1)
211 set(REQUIRED_OPENCL_MIN_VERSION_MINOR 2)
212 set(REQUIRED_OPENCL_MIN_VERSION ${REQUIRED_OPENCL_MIN_VERSION_MAJOR}.${REQUIRED_OPENCL_MIN_VERSION_MINOR})
214 if(NOT GMX_USE_OPENCL)
215     # CUDA detection is done only if GMX_USE_OPENCL is OFF.
216     include(gmxManageGPU)
217     set(GMX_USE_CUDA ${GMX_GPU})
218     if(GMX_GPU)
219         set(GMX_GPU_ACCELERATION_FRAMEWORK "GMX_GPU_CUDA")
220     else()
221         set(GMX_GPU_ACCELERATION_FRAMEWORK "GMX_GPU_NONE")
222     endif()
223 else()
224     #Now the OpenCL path (for both AMD and NVIDIA)
225     if(GMX_GPU)
226         include(gmxManageOpenCL)
227         set(GMX_GPU_ACCELERATION_FRAMEWORK "GMX_GPU_OPENCL")
228     else()
229         message(FATAL_ERROR "OpenCL requested but GPU option is not enabled (try -DGMX_GPU=on) ")
230     endif()
231 endif()
233 gmx_option_multichoice(
234     GMX_SIMD
235     "SIMD instruction set for CPU kernels and compiler optimization"
236     "AUTO"
237     AUTO None SSE2 SSE4.1 AVX_128_FMA AVX_256 AVX2_256 AVX2_128 AVX_512 AVX_512_KNL MIC ARM_NEON ARM_NEON_ASIMD IBM_VMX IBM_VSX Sparc64_HPC_ACE Reference)
239 if(GMX_TARGET_MIC)
240     set(GMX_FFT_LIBRARY_DEFAULT "mkl")
241 else()
242     set(GMX_FFT_LIBRARY_DEFAULT "fftw3")
243 endif()
245 gmx_option_multichoice(
246     GMX_FFT_LIBRARY
247     "FFT library"
248     "${GMX_FFT_LIBRARY_DEFAULT}"
249     fftw3 mkl "fftpack[built-in]")
250 gmx_dependent_option(
251     GMX_BUILD_OWN_FFTW
252     "Download and build FFTW 3 during the GROMACS build process, rather than fall back on the really slow fftpack."
253     OFF
254     "GMX_FFT_LIBRARY STREQUAL FFTW3")
255 gmx_dependent_option(
256     GMX_DISABLE_FFTW_MEASURE
257     "Do not optimize FFTW setups (not needed with SSE)"
258     OFF
259     "GMX_FFT_LIBRARY STREQUAL FFTW3")
260 mark_as_advanced(GMX_BUILD_OWN_FFTW)
261 mark_as_advanced(GMX_DISABLE_FFTW_MEASURE)
263 gmx_dependent_cache_variable(GMX_SIMD_REF_FLOAT_WIDTH  "Reference SIMD single precision width" STRING "4" "GMX_SIMD STREQUAL REFERENCE")
264 gmx_dependent_cache_variable(GMX_SIMD_REF_DOUBLE_WIDTH "Reference SIMD double precision width" STRING "2" "GMX_SIMD STREQUAL REFERENCE")
266 # This should be moved to a separate NBNXN cmake module when that code is cleaned up and modularized
268 option(GMX_BROKEN_CALLOC "Work around broken calloc()" OFF)
269 mark_as_advanced(GMX_BROKEN_CALLOC)
271 option(GMX_OPENMP "Enable OpenMP-based multithreading" ON)
273 option(GMX_USE_TNG "Use the TNG library for trajectory I/O" ON)
275 option(GMX_BUILD_MDRUN_ONLY "Build and install only the mdrun binary" OFF)
277 option(GMX_CYCLE_SUBCOUNTERS "Enable cycle subcounters to get a more detailed cycle timings" OFF)
278 mark_as_advanced(GMX_CYCLE_SUBCOUNTERS)
280 option(GMX_SKIP_DEFAULT_CFLAGS "Don't automatically add suggested/required Compiler flags." OFF)
281 mark_as_advanced(GMX_SKIP_DEFAULT_CFLAGS)
283 option(GMX_BUILD_FOR_COVERAGE
284        "Tune build for better code coverage metrics (e.g., disable asserts)"
285        OFF)
286 mark_as_advanced(GMX_BUILD_FOR_COVERAGE)
288 option(GMX_DEVELOPER_BUILD
289     "Enable Developer convenience features: always build unit-tests"
290     OFF)
291 mark_as_advanced(GMX_DEVELOPER_BUILD)
293 gmx_set_boolean(GMX_COMPILER_WARNINGS_DEFAULT "NOT SOURCE_IS_SOURCE_DISTRIBUTION")
294 option(GMX_COMPILER_WARNINGS
295     "Enable a default set of compiler warnings"
296     ${GMX_COMPILER_WARNINGS_DEFAULT})
297 mark_as_advanced(GMX_COMPILER_WARNINGS)
298 # Always turn on compiler warnings with a developer build.
299 gmx_add_cache_dependency(GMX_COMPILER_WARNINGS BOOL "NOT GMX_DEVELOPER_BUILD" ON)
301 option(GMX_BUILD_SHARED_EXE
302     "Build exectuables as shared binaries. If not set, this disables rpath and dynamic linker flags in an attempt to build a static binary, but this may require setting up the toolchain properly and making appropriate libraries available."
303     ON)
304 mark_as_advanced(GMX_BUILD_SHARED_EXE)
306 option(GMX_PHYSICAL_VALIDATION
307        "Include physical validation tests in ctest environment. These can then be called using 'make check-phys' or
308        'make check-all'. Warning: Running the physical validation tests takes significantly more time than other tests!"
309        OFF)
310 mark_as_advanced(GMX_PHYSICAL_VALIDATION)
312 ######################################################################
313 # Detect OpenMP support
314 ######################################################################
315 # The OpenMP detection _must_ come before tests for other CFLAGS.
316 include(gmxManageOpenMP)
320 ######################################################################
321 # Compiler tests
322 # These need to be done early (before further tests).
323 #####################################################################
325 include(gmxCFlags)
326 gmx_c_flags()
328 # These variables should be used for CMake-style lists (ie. separated
329 # by semicolons) of additional compiler flags which are not generated
330 # in gmxCFlags nor are SIMD or MPI related.
332 # TODO These variables should be consolidated into
333 # EXTRA_COMPILER_FLAGS so that we we don't perpetrate bugs where
334 # things that work in C compilation (e.g. merging from old branches)
335 # might not also work for C++ compilation.
336 set(EXTRA_C_FLAGS "")
337 set(EXTRA_CXX_FLAGS "")
339 # Run through a number of tests for buggy compilers and other issues
340 include(gmxTestCompilerProblems)
341 gmx_test_compiler_problems()
343 # Implement double-precision option. This is complicated because we
344 # need installed headers to use the precision mode of the build that
345 # produced the library, but cannot use config.h in that case. We also
346 # want such variables to always have a definition, because #if is more
347 # robust than #ifdef. So, we put this value on the compiler command
348 # line in all cases.
350 # GMX_RELAXED_DOUBLE_PRECISION does not need to be handled here,
351 # because no installed header needs it
352 if(GMX_DOUBLE)
353     set(GMX_DOUBLE_VALUE 1)
354 else()
355     set(GMX_DOUBLE_VALUE 0)
356 endif()
357 add_definitions(-DGMX_DOUBLE=${GMX_DOUBLE_VALUE})
358 list(APPEND INSTALLED_HEADER_DEFINITIONS "-DGMX_DOUBLE=${GMX_DOUBLE_VALUE}")
360 option(GMX_IMD "Enable Interactive Molecular Dynamics (IMD) sessions, e.g. with VMD" ON)
361 if(GMX_IMD AND WIN32)
362     list(APPEND GMX_EXTRA_LIBRARIES "wsock32")
363 endif()
367 ########################################################################
368 # Basic system tests (standard libraries, headers, functions, types)   #
369 ########################################################################
370 include(CheckIncludeFiles)
371 include(CheckIncludeFileCXX)
372 check_include_files(unistd.h     HAVE_UNISTD_H)
373 check_include_files(pwd.h        HAVE_PWD_H)
374 check_include_files(dirent.h     HAVE_DIRENT_H)
375 check_include_files(time.h       HAVE_TIME_H)
376 check_include_files(sys/time.h   HAVE_SYS_TIME_H)
377 check_include_files(io.h         HAVE_IO_H)
378 check_include_files(sched.h      HAVE_SCHED_H)
379 check_include_files(xmmintrin.h  HAVE_XMMINTRIN_H)
381 include(CheckCXXSymbolExists)
382 check_cxx_symbol_exists(gettimeofday      sys/time.h   HAVE_GETTIMEOFDAY)
383 check_cxx_symbol_exists(sysconf           unistd.h     HAVE_SYSCONF)
384 check_cxx_symbol_exists(nice              unistd.h     HAVE_NICE)
385 check_cxx_symbol_exists(fsync             unistd.h     HAVE_FSYNC)
386 check_cxx_symbol_exists(_fileno           stdio.h      HAVE__FILENO)
387 check_cxx_symbol_exists(fileno            stdio.h      HAVE_FILENO)
388 check_cxx_symbol_exists(_commit           io.h         HAVE__COMMIT)
389 check_cxx_symbol_exists(sigaction         signal.h     HAVE_SIGACTION)
391 # We cannot check for the __builtins as symbols, but check if code compiles
392 check_cxx_source_compiles("int main(){ return __builtin_clz(1);}"   HAVE_BUILTIN_CLZ)
393 check_cxx_source_compiles("int main(){ return __builtin_clzll(1);}" HAVE_BUILTIN_CLZLL)
394 if(MSVC)
395     check_cxx_source_compiles("#include <intrin.h>\n int main(){unsigned long r;unsigned long i=1;_BitScanReverse(&r,i);return r;}" HAVE_BITSCANREVERSE)
396     check_cxx_source_compiles("#include <intrin.h>\n int main(){unsigned long r;unsigned __int64 i=1;_BitScanReverse(&r,i);return r;}" HAVE_BITSCANREVERSE64)
397 elseif(CMAKE_CXX_COMPILER_ID MATCHES "XL")
398     check_cxx_source_compiles("int main(){ return __cntlz4(1);}" HAVE_CNTLZ4)
399     check_cxx_source_compiles("int main(){ return __cntlz8(1);}" HAVE_CNTLZ8)
400 endif()
402 include(CheckLibraryExists)
403 find_library(HAVE_LIBM m)
404 mark_as_advanced(HAVE_LIBM)
405 check_library_exists(rt clock_gettime "" HAVE_CLOCK_GETTIME)
406 check_library_exists(m feenableexcept "" HAVE_FEENABLEEXCEPT)
407 check_library_exists(m fedisableexcept "" HAVE_FEDISABLEEXCEPT)
409 include(TestSchedAffinity)
410 test_sched_affinity(HAVE_SCHED_AFFINITY)
412 # Aligned memory allocation. We need to check for both mm_malloc(),
413 # posix_memalign(), memalign(), and on windows also _aligned_malloc()
414 include(gmxTestMMMalloc)
415 gmx_test_mm_malloc(HAVE__MM_MALLOC)
416 check_cxx_symbol_exists(posix_memalign    stdlib.h     HAVE_POSIX_MEMALIGN)
417 check_cxx_symbol_exists(memalign          stdlib.h     HAVE_MEMALIGN)
418 if(MSVC)
419     # No need to waste time on this test on platforms where it will never be true
420     check_cxx_symbol_exists(_aligned_malloc   stdlib.h     HAVE__ALIGNED_MALLOC)
421 endif()
423 include(TestBigEndian)
424 test_big_endian(GMX_INTEGER_BIG_ENDIAN)
426 gmx_set_boolean(GMX_USE_NICE "HAVE_UNISTD_H AND HAVE_NICE")
428 # Management of GROMACS options for specific toolchains should go
429 # here. Because the initial settings for some of the main options have
430 # already happened, but things like library detection and MPI compiler
431 # feature detection have not, the docstrings for any over-rides of
432 # GROMACS defaults or user settings will make sense. Also, any
433 # toolchain-related reasons for choosing whether to detect various
434 # things can be sorted out now, before the detection takes place.
435 if(GMX_TARGET_FUJITSU_SPARC64)
436     include(gmxManageFujitsuSparc64)
437 endif()
439 ########################################################################
440 #Process MPI settings
441 ########################################################################
442 include(gmxManageMPI)
444 ########################################################################
445 #Process MiMiC settings
446 ########################################################################
447 include(gmxManageMimic)
449 ########################################################################
450 #Process shared/static library settings
451 ########################################################################
452 include(gmxManageSharedLibraries)
455 ########################################################################
456 # Find external packages                                               #
457 ########################################################################
459 # Unconditionally find the package, as it is also required for unit
460 # tests. This exports LIBXML2_FOUND, which we should not use because
461 # it does not tell us that linking will succeed. Instead, we test that
462 # next.
463 #if(DEFINED LIBXML2_LIBRARIES)
464 #  set(LibXml2_FIND_QUIETLY TRUE)
465 #endif()
466 #find_package(LibXml2)
467 #include(gmxTestLibXml2)
468 #gmx_test_libxml2(HAVE_LIBXML2)
469 #option(GMX_XML "Use libxml2 to parse xml files (currently has no effect)" ${HAVE_LIBXML2})
470 #set(PKG_XML "")
471 #mark_as_advanced(GMX_XML)
472 # Don't actually do anything, since libxml2 is currently not used by libgromacs
473 #if(GMX_XML AND NOT HAVE_LIBXML2)
474 #    message(FATAL_ERROR "libxml2 not found. Set GMX_XML=OFF to compile without XML support")
475 #endif()
476 #if(GMX_XML)
477 #    include_directories(${LIBXML2_INCLUDE_DIR})
478 #    set(PKG_XML libxml-2.0)
479 #    set(XML_LIBRARIES ${LIBXML2_LIBRARIES})
480 #endif()
482 gmx_option_trivalue(
483     GMX_HWLOC
484     "Use hwloc portable hardware locality library"
485     "AUTO")
487 if (GMX_HWLOC)
488     # Find quietly the second time.
489     if (HWLOC_FIND_QUIETLY_AFTER_FIRST_RUN)
490         set(HWLOC_FIND_QUIETLY TRUE)
491     endif()
492     find_package(HWLOC 1.5) 
494     if (HWLOC_FOUND)
495         if (HWLOC_LIBRARIES MATCHES ".a$")
496             set(_STATIC_HWLOC TRUE)
497         endif()
499         gmx_check_if_changed(HWLOC_FOUND_CHANGED HWLOC_FOUND)
500         if (_STATIC_HWLOC AND HWLOC_FOUND_CHANGED AND NOT GMX_HWLOC_FORCE)
501             message(STATUS "Static hwloc library found, will not attempt using it as it could lead to link-time errors. To use the detected library, manually set GMX_HWLOC=ON and you will likely have to pass appropriate linker flags too to satisfy the link-time dependencies of your hwloc library. Try \"pkg-config --libs --static hwloc\" for suggestions on what you will need.")
502             set(GMX_USE_HWLOC OFF)
503         else()
504             set(GMX_USE_HWLOC ON)
505         endif()
507         if (GMX_USE_HWLOC)
508             include_directories(SYSTEM ${HWLOC_INCLUDE_DIRS})
509             list(APPEND GMX_EXTRA_LIBRARIES ${HWLOC_LIBRARIES})
510         endif()
511     elseif(GMX_HWLOC_FORCE)
512         message(FATAL_ERROR "HWLOC package support required, but not found.")
513     endif()
515     set(HWLOC_FIND_QUIETLY_AFTER_FIRST_RUN TRUE CACHE INTERNAL "Be quiet during future attempts to find HWLOC")
516 endif()
518 option(GMX_EXTERNAL_TINYXML2 "Use external TinyXML-2 instead of compiling the version bundled with GROMACS." OFF)
519 mark_as_advanced(GMX_EXTERNAL_TINYXML2)
520 if(GMX_EXTERNAL_TINYXML2)
521     # Find an external TinyXML-2 library.
522     find_package(TinyXML-2 3.0.0)
523     set(HAVE_TINYXML2 ${TinyXML2_FOUND})
524     if(NOT HAVE_TINYXML2)
525         message(FATAL_ERROR "External TinyXML-2 could not be found, please adjust your search paths")
526     endif()
527 endif()
529 option(GMX_EXTRAE "Add support for tracing using EXTRAE" OFF)
530 mark_as_advanced(GMX_EXTRAE)
532 if (GMX_EXTRAE)
533   find_package(EXTRAE)
534   if(EXTRAE_FOUND)
535     include_directories(SYSTEM ${EXTRAE_INCLUDE_DIR})
536     set(HAVE_EXTRAE 1)
537   else()
538     message(FATAL_ERROR "EXTRAE library was not found. Please add the correct path to CMAKE_PREFIX_PATH")
539   endif()
540 endif()
542 option(GMX_X11 "Use X window system" OFF)
543 if (GMX_X11)
544     find_package(X11)
545     # X11 includes/libraries are only set in the ngmx subdirectory!
546     if(NOT X11_FOUND)
547         message(FATAL_ERROR
548                 "X11 include files and/or libraries were not found. "
549                 "Set GMX_X11=OFF to compile without X11 support. "
550                 "gmx view will not be available.")
551     endif()
552     include_directories(SYSTEM ${X11_INCLUDE_DIR})
553 endif()
555 include(ThreadMPI)
556 # Enable core threading facilities
557 tmpi_enable_core("${CMAKE_SOURCE_DIR}/src/external/thread_mpi/include")
558 if(GMX_THREAD_MPI)
559     # enable MPI functions
560     tmpi_enable()
561     set(MPI_IN_PLACE_EXISTS 1)
562 endif()
563 # If atomics are manually disabled a define is needed because atomics.h doesn't depend on config.h
564 if (TMPI_ATOMICS_DISABLED)
565    add_definitions(-DTMPI_ATOMICS_DISABLED)
566 endif()
568 include(gmxManageTNG)
570 include(gmxManageLmfit)
572 if(GMX_GPU)
573     # now that we have detected the dependencies, do the second configure pass
574     gmx_gpu_setup()
575     if (GMX_CLANG_CUDA)
576         list(APPEND GMX_EXTRA_LIBRARIES ${GMX_CUDA_CLANG_LINK_LIBS})
577         link_directories("${GMX_CUDA_CLANG_LINK_DIRS}")
578     endif()
579 endif()
581 if(CYGWIN)
582     set(GMX_CYGWIN 1)
583 endif()
585 if(WIN32)
586     set(GMX_NATIVE_WINDOWS 1)
587     # This makes windows.h not declare min/max as macros that would break
588     # C++ code using std::min/std::max.
589     add_definitions(-DNOMINMAX)
590 endif()
592 option(GMX_BUILD_UNITTESTS "Build unit tests with BUILD_TESTING" ON)
593 mark_as_advanced(GMX_BUILD_UNITTESTS)
594 gmx_add_cache_dependency(GMX_BUILD_UNITTESTS BOOL BUILD_TESTING OFF)
596 ########################################################################
597 # Our own GROMACS tests
598 ########################################################################
600 include_directories(BEFORE ${CMAKE_SOURCE_DIR}/src)
601 # Required for config.h, maybe should only be set in src/CMakeLists.txt
602 include_directories(BEFORE ${CMAKE_BINARY_DIR}/src)
604 include(gmxTestInlineASM)
605 gmx_test_inline_asm_gcc_x86(GMX_X86_GCC_INLINE_ASM)
607 include(gmxSetBuildInformation)
608 gmx_set_build_information()
610 # Anything but truly ancient hardware should support rdtscp, so we enable it by default
611 option(GMX_USE_RDTSCP "Use low-latency RDTSCP instruction for CPU-based timers for mdrun execution; might need to be off when compiling for heterogeneous environments)" ON)
612 mark_as_advanced(GMX_USE_RDTSCP)
614 include(gmxTestLargeFiles)
615 gmx_test_large_files(GMX_LARGEFILES)
617 include(gmxTestSignal)
618 gmx_test_sigusr1(HAVE_SIGUSR1)
620 include(gmxTestPipes)
621 gmx_test_pipes(HAVE_PIPES)
623 include(gmxTestXDR)
624 gmx_test_xdr(GMX_SYSTEM_XDR)
625 # Darwin has system XDR, but it uses a three-argument flavour of
626 # xdrproc_t that it guarantees will still work if you pass the normal
627 # two-argument xdr filters, but gcc 8 warns about the cast necessary
628 # to do that, so it's simpler to just use our own XDR library.
630 # TODO It would be better to craft a cmake test which fails if such
631 # XDR operations cause warnings, and succeeds otherwise, because it is
632 # generally preferable to use system libraries where possible.
633 if(NOT GMX_SYSTEM_XDR OR CMAKE_SYSTEM_NAME STREQUAL "Darwin")
634     set(GMX_INTERNAL_XDR 1)
635 endif()
638 ##################################################
639 # Process SIMD instruction settings
640 ##################################################
641 # This checks what flags to add in order to
642 # support the SIMD instructions we need, it sets
643 # correct defines for the SIMD instructions supported,
644 # and adds advanced options to control accuracy
645 # for SIMD math operations.
646 include(gmxManageSimd)
647 gmx_manage_simd()
649 ##################################################
650 # Process FFT library settings
651 ##################################################
652 include(gmxManageFFTLibraries)
655 include(gmxManageLinearAlgebraLibraries)
657 include(gmxManagePluginSupport)
659 if (GMX_USE_PLUGINS)
660     if(NOT GMX_VMD_PLUGIN_PATH)
661         find_package(VMD)
662     endif()
663 endif()
665 # Link real-time library for POSIX timers. The check for clock_gettime
666 # confirms the linkability of rt.
667 if(HAVE_TIME_H AND HAVE_UNISTD_H AND HAVE_CLOCK_GETTIME)
668     list(APPEND GMX_EXTRA_LIBRARIES rt)
669 endif()
671 # Math and thread libraries must often come after all others when linking...
672 if (HAVE_LIBM)
673     list(APPEND GMX_PUBLIC_LIBRARIES m)
674 endif()
676 option(GMX_NACL "Configure for Native Client builds" OFF)
677 if (GMX_NACL)
678   list(APPEND GMX_EXTRA_LIBRARIES nosys)
679   set(GMX_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lnosys")
680   # TODO: Is this still necessary with the check for its presence?
681   set(GMX_USE_NICE 0)
682   set(GMX_NO_RENAME 1)
683 endif()
684 mark_as_advanced(GMX_NACL)
686 if(GMX_FAHCORE)
687   set(COREWRAP_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/../corewrap" CACHE STRING
688       "Path to swindirect.h")
689   include_directories(${COREWRAP_INCLUDE_DIR})
690 endif()
692 # Value of GMX_BUILD_HELP=AUTO tries to generate things, but will only
693 # produce warnings if that fails.
694 set(build_help_default AUTO)
695 if (SOURCE_IS_SOURCE_DISTRIBUTION OR CMAKE_CROSSCOMPILING)
696     set(build_help_default OFF)
697 endif()
698 gmx_option_trivalue(GMX_BUILD_HELP "Build completions automatically (requires that compiled binaries can be executed on the build host) and install man pages if built (requires building the 'man' target manually)" ${build_help_default})
699 mark_as_advanced(GMX_BUILD_HELP)
700 if (GMX_BUILD_HELP AND SOURCE_IS_SOURCE_DISTRIBUTION AND BUILD_IS_INSOURCE)
701     message(FATAL_ERROR
702         "Rebuilding shell completions or man pages is not supported for "
703         "in-source builds from a source distribution. "
704         "Set GMX_BUILD_HELP=OFF or do an out-of-source build to proceed.")
705 endif()
707 # # # # # # # # # # NO MORE TESTS AFTER THIS LINE! # # # # # # # # # # #
708 # these are set after everything else
709 if (NOT GMX_SKIP_DEFAULT_CFLAGS)
710     set(CMAKE_EXE_LINKER_FLAGS "${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS}")
711     set(CMAKE_SHARED_LINKER_FLAGS "${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS} ${CMAKE_SHARED_LINKER_FLAGS}")
712 else()
713     message("Recommended flags which are not added because GMX_SKIP_DEFAULT_CFLAGS=yes:")
714     message("CMAKE_C_FLAGS: ${SIMD_C_FLAGS};${MPI_COMPILE_FLAGS};${EXTRA_C_FLAGS};${GMXC_CFLAGS}")
715     foreach(build_type ${build_types_with_explicit_flags})
716         message("CMAKE_C_FLAGS_${build_type}: ${GMXC_CFLAGS_${build_type}}")
717     endforeach()
718     message("CMAKE_CXX_FLAGS: ${SIMD_CXX_FLAGS};${MPI_COMPILE_FLAGS};${EXTRA_CXX_FLAGS};${GMXC_CXXFLAGS}")
719     foreach(build_type ${build_types_with_explicit_flags})
720         message("CMAKE_CXX_FLAGS_${build_type}: ${GMXC_CXXFLAGS_${build_type}}")
721     endforeach()
722     message("CMAKE_EXE_LINKER_FLAGS: ${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS}")
723     message("CMAKE_SHARED_LINKER_FLAGS: ${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS}")
724 endif()
725 # Allow `admin` directory to be easily conveyed to nested CMake commands.
726 set(GMX_ADMIN_DIR ${CMAKE_SOURCE_DIR}/admin)
728 ########################################################################
729 # Specify install locations
730 ########################################################################
731 # Use GNUInstallDirs to set paths on multiarch systems.
732 include(GNUInstallDirs)
734 set(GMX_INSTALL_DATASUBDIR "gromacs" CACHE STRING "Subdirectory for GROMACS data under CMAKE_INSTALL_DATADIR")
735 mark_as_advanced(GMX_INSTALL_DATASUBDIR)
737 # Internal convenience so we do not have to join two path segments in the code
738 set(GMX_INSTALL_GMXDATADIR ${CMAKE_INSTALL_DATADIR}/${GMX_INSTALL_DATASUBDIR})
740 # If the nesting level wrt. the installation root is changed,
741 # gromacs-config.cmake.cmakein needs to be adapted.
742 set(GMX_INSTALL_CMAKEDIR  ${CMAKE_INSTALL_DATAROOTDIR}/cmake)
744 # TODO: Make GMXRC adapt if this is changed
745 set(GMX_INSTALL_PKGCONFIGDIR ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
746 set(GMX_INSTALL_OCLDIR       ${GMX_INSTALL_GMXDATADIR}/opencl)
748 list(APPEND INSTALLED_HEADER_INCLUDE_DIRS ${CMAKE_INSTALL_INCLUDEDIR})
750 # Binary and library suffix options
751 include(gmxManageSuffixes)
753 ################################################################
754 # Shared library load path settings
755 ################################################################
756 if(NOT GMX_BUILD_SHARED_EXE)
757     # No rpath
758     set(CMAKE_SKIP_RPATH TRUE)
759     set(CMAKE_EXE_LINK_DYNAMIC_C_FLAGS) # remove -Wl,-Bdynamic
760     set(CMAKE_EXE_LINK_DYNAMIC_CXX_FLAGS)
761 else()
762     # The build folder always has bin/ and lib/; if we are also going to
763     # install to lib/, then the installation RPATH works also in the build
764     # tree.  This makes installation slightly faster (no need to rewrite the
765     # RPATHs), and makes the binaries in the build tree relocatable.
766     if(CMAKE_INSTALL_LIBDIR STREQUAL "lib")
767         set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
768         set(CMAKE_BUILD_WITH_INSTALL_NAME_DIR TRUE)
769     endif()
770     # Set the RPATH as relative to the executable location to make the
771     # binaries relocatable.
772     if(CMAKE_SYSTEM_NAME STREQUAL "Darwin") #Assume OS X >=10.5
773         set(CMAKE_INSTALL_RPATH "@loader_path/../${CMAKE_INSTALL_LIBDIR}")
774         set(CMAKE_INSTALL_NAME_DIR ${CMAKE_INSTALL_RPATH})
775     else()
776         set(CMAKE_INSTALL_RPATH "\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}")
777     endif()
778     set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
779     set(CMAKE_MACOSX_RPATH 1)
780 endif()
782 #COPYING file: Only necessary for binary distributions.
783 #Simpler to always install.
784 install(FILES COPYING DESTINATION ${GMX_INSTALL_GMXDATADIR} COMPONENT data)
786 if (GMX_BUILD_FOR_COVERAGE)
787     # Code heavy with asserts makes conditional coverage close to useless metric,
788     # as by design most of the false branches are impossible to trigger in
789     # correctly functioning code.  And the benefit of testing those that could
790     # be triggered by using an API against its specification isn't usually
791     # worth the effort.
792     add_definitions(-DNDEBUG -DGMX_DISABLE_ASSERTS)
793 endif()
795 if (BUILD_TESTING)
796     include(tests/CheckTarget.cmake)
797 endif()
799 # TODO: Determine control flow and defaults for package installation and testing use cases.
800 # Ref: https://gitlab.com/gromacs/gromacs/-/issues/2896
801 option(GMX_PYTHON_PACKAGE "Configure gmxapi Python package" OFF)
802 mark_as_advanced(GMX_PYTHON_PACKAGE)
804 if (NOT GMX_BUILD_MDRUN_ONLY)
805     find_package(ImageMagick QUIET COMPONENTS convert)
806     include(gmxTestImageMagick)
807     GMX_TEST_IMAGEMAGICK(IMAGE_CONVERT_POSSIBLE)
808     # TODO: Resolve circular dependency between docs, gromacs, and python_packaging
809     add_subdirectory(docs)
810     add_subdirectory(share)
811     add_subdirectory(scripts)
812 endif()
813 add_subdirectory(src)
815 if (BUILD_TESTING)
816     add_subdirectory(tests)
817 endif()
819 if(GMX_PYTHON_PACKAGE AND NOT GMX_BUILD_MDRUN_ONLY)
820     add_subdirectory(python_packaging)
821 endif()
823 gmx_cpack_write_config()
825 # Issue a warning if NVIDIA GPUs were detected, but CUDA was not found.
826 # Don't bother the user after the first configure pass.
827 if ((CUDA_NOTFOUND_AUTO AND GMX_DETECT_GPU_AVAILABLE) AND NOT GMX_GPU_DETECTION_DONE)
828     message(WARNING "${CUDA_NOTFOUND_MESSAGE}")
829 endif()
830 set(GMX_GPU_DETECTION_DONE TRUE CACHE INTERNAL "Whether GPU detection has already been done")
832 #######################
833 ## uninstall target
834 #######################
835 CONFIGURE_FILE(   "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
836                   "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake"
837                   IMMEDIATE @ONLY)
838 ###########################
839 ADD_CUSTOM_TARGET(uninstall
840                   "${CMAKE_COMMAND}" -P
841                   "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake")
842 ###########################
843 set_directory_properties(PROPERTIES
844             ADDITIONAL_MAKE_CLEAN_FILES "install_manifest.txt")