Remove t_topology from two preprocess tools
[gromacs.git] / CMakeLists.txt
blob182dd706c0c5755ca48c3b33d810b866285770c2
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2009,2010,2011,2012,2013,2014,2015,2016,2017,2018,2019, by the GROMACS development team, led by
5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 # and including many others, as listed in the AUTHORS file in the
7 # top-level source directory and at http://www.gromacs.org.
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
35 cmake_minimum_required(VERSION 3.9.6)
36 if(POLICY CMP0074) #3.12
37     cmake_policy(SET CMP0074 NEW)
38 endif()
40 # CMake modules/macros are in a subdirectory to keep this file cleaner
41 # This needs to be set before project() in order to pick up toolchain files
42 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Platform)
44 project(Gromacs)
46 set(CMAKE_CXX_STANDARD 14)
47 set(CMAKE_CXX_STANDARD_REQUIRED ON)
48 set(CMAKE_CXX_EXTENSIONS OFF)
50 include(gmxManageCcache)
52 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
53 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
54 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
56 find_package(LibStdCpp)
58 # Set up common version variables, as well as general information about
59 # the build tree (whether the build is from a source package or from a git
60 # repository).  Also declares a few functions that will be used for generating
61 # version info files later.
62 include(gmxBuildTreeInfo)
63 include(gmxVersionInfo)
65 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND UNIX)
66     set(CMAKE_INSTALL_PREFIX "/usr/local/gromacs" CACHE STRING "Installation prefix (installation will need write permissions here)" FORCE)
67 endif()
68 if("${CMAKE_INSTALL_PREFIX}" STREQUAL "${CMAKE_BINARY_DIR}")
69     message(FATAL_ERROR "GROMACS cannot be installed into the build tree, choose a different location for CMAKE_INSTALL_PREFIX")
70 endif()
72 include(gmxBuildTypeReference)
73 include(gmxBuildTypeProfile)
74 include(gmxBuildTypeTSAN)
75 include(gmxBuildTypeASAN)
76 include(gmxBuildTypeMSAN)
77 include(gmxBuildTypeReleaseWithAssert)
79 if(NOT CMAKE_BUILD_TYPE)
80     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)
81     # Set the possible values of build type for cmake-gui
82     set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release"
83         "MinSizeRel" "RelWithDebInfo" "Reference" "RelWithAssert" "Profile" "TSAN" "ASAN" "MSAN")
84 endif()
85 if(CMAKE_CONFIGURATION_TYPES)
86     # Add appropriate GROMACS-specific build types for the Visual
87     # Studio generator (Debug, Release, MinSizeRel and RelWithDebInfo
88     # are already present by default).
89     list(APPEND CMAKE_CONFIGURATION_TYPES "RelWithAssert" "Reference")
90     list(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)
91     set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING
92         "List of configuration types"
93         FORCE)
94 endif()
95 set(build_types_with_explicit_flags RELEASE DEBUG RELWITHDEBINFO RELWITHASSERT MINSIZEREL PROFILE)
97 set_property(GLOBAL PROPERTY FIND_LIBRARY_USE_LIB64_PATHS ON)
99 include(gmxCTestUtilities)
100 gmx_ctest_init()
102 include(gmxCPackUtilities)
103 gmx_cpack_init()
105 # Variables that accumulate stuff influencing the installed headers
106 set(INSTALLED_HEADER_INCLUDE_DIRS "")
107 set(INSTALLED_HEADER_DEFINITIONS "")
109 ########################################################################
110 # Global non-cache variables for implementing the build system
111 ########################################################################
113 # These variables collect libraries that GROMACS requires for
114 # linking. They should be appended to with list(APPEND ${name}
115 # new-library) calls. They are:
116 #  - Libraries that are required for libgromacs (only)
117 set(GMX_EXTRA_LIBRARIES "")
118 #  - Libraries that are required for all code in the repository
119 set(GMX_COMMON_LIBRARIES "")
120 #  - Libraries that all code linked against libgromacs needs
121 #    (i.e., something that is exposed in installed headers).
122 set(GMX_PUBLIC_LIBRARIES "")
124 ########################################################################
125 # Check and warn if cache generated on a different host is being reused
126 ########################################################################
127 if(CMAKE_HOST_UNIX)
128     execute_process(COMMAND hostname
129                     OUTPUT_VARIABLE TMP_HOSTNAME
130                     OUTPUT_STRIP_TRAILING_WHITESPACE)
131     if(GMX_BUILD_HOSTNAME AND NOT "${GMX_BUILD_HOSTNAME}" STREQUAL "${TMP_HOSTNAME}")
132         message(WARNING "
133             The CMake cache, probably generated on a different host (${GMX_BUILD_HOSTNAME}),
134             is being reused! This could lead to inconsistencies; therefore, it is
135             recommended to regenerate the cache!")
136     endif()
137     set(GMX_BUILD_HOSTNAME "${TMP_HOSTNAME}" CACHE INTERNAL
138             "Hostname of the machine where the cache was generated.")
139 endif()
141 ########################################################################
142 # Detect architecture before setting options so we can alter defaults
143 ########################################################################
144 # Detect the architecture the compiler is targetting, detect
145 # SIMD instructions possibilities on that hardware, suggest SIMD instruction set
146 # to use if none is specified, and populate the cache option for CPU
147 # SIMD.
148 include(gmxDetectTargetArchitecture)
149 gmx_detect_target_architecture()
151 ########################################################################
152 # User input options                                                   #
153 ########################################################################
154 include(gmxOptionUtilities)
156 set(CMAKE_PREFIX_PATH "" CACHE STRING "Extra locations to search for external libraries and tools (give directory without lib, bin, or include)")
158 # Fujitsu only has SIMD in double precision, so this will be faster
159 gmx_set_boolean(GMX_DOUBLE_DEFAULT GMX_TARGET_FUJITSU_SPARC64)
160 option(GMX_DOUBLE "Use double precision (much slower, use only if you really need it)" ${GMX_DOUBLE_DEFAULT})
161 option(GMX_RELAXED_DOUBLE_PRECISION "Accept single precision 1/sqrt(x) when using Fujitsu HPC-ACE SIMD" OFF)
162 mark_as_advanced(GMX_RELAXED_DOUBLE_PRECISION)
164 option(GMX_MPI    "Build a parallel (message-passing) version of GROMACS" OFF)
165 option(GMX_THREAD_MPI  "Build a thread-MPI-based multithreaded version of GROMACS (not compatible with MPI)" ON)
166 gmx_dependent_option(
167     GMX_MPI_IN_PLACE
168     "Enable MPI_IN_PLACE for MPIs that have it defined"
169     ON
170     GMX_MPI)
171 mark_as_advanced(GMX_MPI_IN_PLACE)
173 option(GMX_MIMIC "Enable MiMiC QM/MM interface (CPMD is required)" OFF)
175 option(GMX_FAHCORE "Build a library with mdrun functionality" OFF)
176 mark_as_advanced(GMX_FAHCORE)
178 option(GMX_COOL_QUOTES "Enable GROMACS cool quotes" ON)
179 mark_as_advanced(GMX_COOL_QUOTES)
180 gmx_add_cache_dependency(GMX_COOL_QUOTES BOOL "NOT GMX_FAHCORE" OFF)
182 option(GMX_USE_OPENCL "Enable OpenCL acceleration" OFF)
184 # The earliest version of the CUDA toolkit that supports c++14 is 9.0
185 set(REQUIRED_CUDA_VERSION 9.0)
186 set(REQUIRED_CUDA_COMPUTE_CAPABILITY 3.0)
188 # OpenCL required version: 1.2 or newer
189 set(REQUIRED_OPENCL_MIN_VERSION_MAJOR 1)
190 set(REQUIRED_OPENCL_MIN_VERSION_MINOR 2)
191 set(REQUIRED_OPENCL_MIN_VERSION ${REQUIRED_OPENCL_MIN_VERSION_MAJOR}.${REQUIRED_OPENCL_MIN_VERSION_MINOR})
193 if(NOT GMX_USE_OPENCL)
194     # CUDA detection is done only if GMX_USE_OPENCL is OFF.
195     include(gmxManageGPU)
196     set(GMX_USE_CUDA ${GMX_GPU})
197     if(GMX_GPU)
198         set(GMX_GPU_ACCELERATION_FRAMEWORK "GMX_GPU_CUDA")
199     else()
200         set(GMX_GPU_ACCELERATION_FRAMEWORK "GMX_GPU_NONE")
201     endif()
202 else()
203     #Now the OpenCL path (for both AMD and NVIDIA)
204     if(GMX_GPU)
205         include(gmxManageOpenCL)
206         set(GMX_GPU_ACCELERATION_FRAMEWORK "GMX_GPU_OPENCL")
207     else()
208         message(FATAL_ERROR "OpenCL requested but GPU option is not enabled (try -DGMX_GPU=on) ")
209     endif()
210 endif()
212 gmx_option_multichoice(
213     GMX_SIMD
214     "SIMD instruction set for CPU kernels and compiler optimization"
215     "AUTO"
216     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)
218 if(GMX_TARGET_MIC)
219     set(GMX_FFT_LIBRARY_DEFAULT "mkl")
220 else()
221     set(GMX_FFT_LIBRARY_DEFAULT "fftw3")
222 endif()
224 gmx_option_multichoice(
225     GMX_FFT_LIBRARY
226     "FFT library"
227     "${GMX_FFT_LIBRARY_DEFAULT}"
228     fftw3 mkl "fftpack[built-in]")
229 gmx_dependent_option(
230     GMX_BUILD_OWN_FFTW
231     "Download and build FFTW 3 during the GROMACS build process, rather than fall back on the really slow fftpack."
232     OFF
233     "GMX_FFT_LIBRARY STREQUAL FFTW3")
234 gmx_dependent_option(
235     GMX_DISABLE_FFTW_MEASURE
236     "Do not optimize FFTW setups (not needed with SSE)"
237     OFF
238     "GMX_FFT_LIBRARY STREQUAL FFTW3")
239 mark_as_advanced(GMX_BUILD_OWN_FFTW)
240 mark_as_advanced(GMX_DISABLE_FFTW_MEASURE)
242 gmx_option_multichoice(
243     GMX_QMMM_PROGRAM
244     "QM package for QM/MM"
245     None
246     none gaussian mopac gamess orca)
248 gmx_dependent_cache_variable(GMX_SIMD_REF_FLOAT_WIDTH  "Reference SIMD single precision width" STRING "4" "GMX_SIMD STREQUAL REFERENCE")
249 gmx_dependent_cache_variable(GMX_SIMD_REF_DOUBLE_WIDTH "Reference SIMD double precision width" STRING "2" "GMX_SIMD STREQUAL REFERENCE")
251 # This should be moved to a separate NBNXN cmake module when that code is cleaned up and modularized
253 option(GMX_BROKEN_CALLOC "Work around broken calloc()" OFF)
254 mark_as_advanced(GMX_BROKEN_CALLOC)
256 option(GMX_OPENMP "Enable OpenMP-based multithreading" ON)
258 option(GMX_USE_TNG "Use the TNG library for trajectory I/O" ON)
260 option(GMX_BUILD_MDRUN_ONLY "Build and install only the mdrun binary" OFF)
262 option(GMX_CYCLE_SUBCOUNTERS "Enable cycle subcounters to get a more detailed cycle timings" OFF)
263 mark_as_advanced(GMX_CYCLE_SUBCOUNTERS)
265 option(GMX_SKIP_DEFAULT_CFLAGS "Don't automatically add suggested/required Compiler flags." OFF)
266 mark_as_advanced(GMX_SKIP_DEFAULT_CFLAGS)
268 option(GMX_BUILD_FOR_COVERAGE
269        "Tune build for better code coverage metrics (e.g., disable asserts)"
270        OFF)
271 mark_as_advanced(GMX_BUILD_FOR_COVERAGE)
273 option(GMX_DEVELOPER_BUILD
274     "Enable Developer convenience features: always build unit-tests"
275     OFF)
276 mark_as_advanced(GMX_DEVELOPER_BUILD)
278 gmx_set_boolean(GMX_COMPILER_WARNINGS_DEFAULT "NOT SOURCE_IS_SOURCE_DISTRIBUTION")
279 option(GMX_COMPILER_WARNINGS
280     "Enable a default set of compiler warnings"
281     ${GMX_COMPILER_WARNINGS_DEFAULT})
282 mark_as_advanced(GMX_COMPILER_WARNINGS)
283 # Always turn on compiler warnings with a developer build.
284 gmx_add_cache_dependency(GMX_COMPILER_WARNINGS BOOL "NOT GMX_DEVELOPER_BUILD" ON)
286 option(GMX_BUILD_SHARED_EXE
287     "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."
288     ON)
289 mark_as_advanced(GMX_BUILD_SHARED_EXE)
291 option(GMX_PHYSICAL_VALIDATION
292        "Include physical validation tests in ctest environment. These can then be called using 'make check-phys' or
293        'make check-all'. Warning: Running the physical validation tests takes significantly more time than other tests!"
294        OFF)
295 mark_as_advanced(GMX_PHYSICAL_VALIDATION)
297 ######################################################################
298 # Detect OpenMP support
299 ######################################################################
300 # The OpenMP detection _must_ come before tests for other CFLAGS.
301 include(gmxManageOpenMP)
305 ######################################################################
306 # Compiler tests
307 # These need to be done early (before further tests).
308 #####################################################################
310 include(gmxCFlags)
311 gmx_c_flags()
313 # This variable should be used for additional compiler flags which are not
314 # generated in gmxCFlags nor are SIMD or MPI related.
316 # TODO These variables should be consolidated into
317 # EXTRA_COMPILER_FLAGS so that we we don't perpetrate bugs where
318 # things that work in C compilation (e.g. merging from old branches)
319 # also work for C++ compilation.
320 set(EXTRA_C_FLAGS "")
321 set(EXTRA_CXX_FLAGS "")
323 # Run through a number of tests for buggy compilers and other issues
324 include(gmxTestCompilerProblems)
325 gmx_test_compiler_problems()
327 # Implement double-precision option. This is complicated because we
328 # need installed headers to use the precision mode of the build that
329 # produced the library, but cannot use config.h in that case. We also
330 # want such variables to always have a definition, because #if is more
331 # robust than #ifdef. So, we put this value on the compiler command
332 # line in all cases.
334 # GMX_RELAXED_DOUBLE_PRECISION does not need to be handled here,
335 # because no installed header needs it
336 if(GMX_DOUBLE)
337     set(GMX_DOUBLE_VALUE 1)
338 else()
339     set(GMX_DOUBLE_VALUE 0)
340 endif()
341 add_definitions(-DGMX_DOUBLE=${GMX_DOUBLE_VALUE})
342 list(APPEND INSTALLED_HEADER_DEFINITIONS "-DGMX_DOUBLE=${GMX_DOUBLE_VALUE}")
344 if(WIN32)
345     list(APPEND GMX_EXTRA_LIBRARIES "wsock32")
346     add_definitions(-DGMX_HAVE_WINSOCK)
347 endif()
351 ########################################################################
352 # Basic system tests (standard libraries, headers, functions, types)   #
353 ########################################################################
354 include(CheckIncludeFiles)
355 include(CheckIncludeFileCXX)
356 check_include_files(unistd.h     HAVE_UNISTD_H)
357 check_include_files(pwd.h        HAVE_PWD_H)
358 check_include_files(dirent.h     HAVE_DIRENT_H)
359 check_include_files(time.h       HAVE_TIME_H)
360 check_include_files(sys/time.h   HAVE_SYS_TIME_H)
361 check_include_files(io.h         HAVE_IO_H)
362 check_include_files(sched.h      HAVE_SCHED_H)
364 include(CheckCXXSymbolExists)
365 check_cxx_symbol_exists(gettimeofday      sys/time.h   HAVE_GETTIMEOFDAY)
366 check_cxx_symbol_exists(sysconf           unistd.h     HAVE_SYSCONF)
367 check_cxx_symbol_exists(nice              unistd.h     HAVE_NICE)
368 check_cxx_symbol_exists(fsync             unistd.h     HAVE_FSYNC)
369 check_cxx_symbol_exists(_fileno           stdio.h      HAVE__FILENO)
370 check_cxx_symbol_exists(fileno            stdio.h      HAVE_FILENO)
371 check_cxx_symbol_exists(_commit           io.h         HAVE__COMMIT)
372 check_cxx_symbol_exists(sigaction         signal.h     HAVE_SIGACTION)
374 # We cannot check for the __builtins as symbols, but check if code compiles
375 check_cxx_source_compiles("int main(){ return __builtin_clz(1);}"   HAVE_BUILTIN_CLZ)
376 check_cxx_source_compiles("int main(){ return __builtin_clzll(1);}" HAVE_BUILTIN_CLZLL)
377 if(MSVC)
378     check_cxx_source_compiles("#include <intrin.h>\n int main(){unsigned long r;unsigned long i=1;_BitScanReverse(&r,i);return r;}" HAVE_BITSCANREVERSE)
379     check_cxx_source_compiles("#include <intrin.h>\n int main(){unsigned long r;unsigned __int64 i=1;_BitScanReverse(&r,i);return r;}" HAVE_BITSCANREVERSE64)
380 elseif(CMAKE_CXX_COMPILER_ID MATCHES "XL")
381     check_cxx_source_compiles("int main(){ return __cntlz4(1);}" HAVE_CNTLZ4)
382     check_cxx_source_compiles("int main(){ return __cntlz8(1);}" HAVE_CNTLZ8)
383 endif()
385 include(CheckLibraryExists)
386 find_library(HAVE_LIBM m)
387 mark_as_advanced(HAVE_LIBM)
388 check_library_exists(rt clock_gettime "" HAVE_CLOCK_GETTIME)
389 check_library_exists(m feenableexcept "" HAVE_FEENABLEEXCEPT)
390 check_library_exists(m fedisableexcept "" HAVE_FEDISABLEEXCEPT)
392 include(TestSchedAffinity)
393 test_sched_affinity(HAVE_SCHED_AFFINITY)
395 # Aligned memory allocation. We need to check for both mm_malloc(),
396 # posix_memalign(), memalign(), and on windows also _aligned_malloc()
397 include(gmxTestMMMalloc)
398 gmx_test_mm_malloc(HAVE__MM_MALLOC)
399 check_cxx_symbol_exists(posix_memalign    stdlib.h     HAVE_POSIX_MEMALIGN)
400 check_cxx_symbol_exists(memalign          stdlib.h     HAVE_MEMALIGN)
401 if(MSVC)
402     # No need to waste time on this test on platforms where it will never be true
403     check_cxx_symbol_exists(_aligned_malloc   stdlib.h     HAVE__ALIGNED_MALLOC)
404 endif()
406 include(TestBigEndian)
407 test_big_endian(GMX_INTEGER_BIG_ENDIAN)
409 gmx_set_boolean(GMX_USE_NICE "HAVE_UNISTD_H AND HAVE_NICE")
411 # Management of GROMACS options for specific toolchains should go
412 # here. Because the initial settings for some of the main options have
413 # already happened, but things like library detection and MPI compiler
414 # feature detection have not, the docstrings for any over-rides of
415 # GROMACS defaults or user settings will make sense. Also, any
416 # toolchain-related reasons for choosing whether to detect various
417 # things can be sorted out now, before the detection takes place.
418 if(GMX_TARGET_FUJITSU_SPARC64)
419     include(gmxManageFujitsuSparc64)
420 endif()
422 ########################################################################
423 #Process MPI settings
424 ########################################################################
425 include(gmxManageMPI)
427 ########################################################################
428 #Process MiMiC settings
429 ########################################################################
430 include(gmxManageMimic)
432 ########################################################################
433 #Process shared/static library settings
434 ########################################################################
435 include(gmxManageSharedLibraries)
438 ########################################################################
439 # Find external packages                                               #
440 ########################################################################
442 # Unconditionally find the package, as it is also required for unit
443 # tests. This exports LIBXML2_FOUND, which we should not use because
444 # it does not tell us that linking will succeed. Instead, we test that
445 # next.
446 #if(DEFINED LIBXML2_LIBRARIES)
447 #  set(LibXml2_FIND_QUIETLY TRUE)
448 #endif()
449 #find_package(LibXml2)
450 #include(gmxTestLibXml2)
451 #gmx_test_libxml2(HAVE_LIBXML2)
452 #option(GMX_XML "Use libxml2 to parse xml files (currently has no effect)" ${HAVE_LIBXML2})
453 #set(PKG_XML "")
454 #mark_as_advanced(GMX_XML)
455 # Don't actually do anything, since libxml2 is currently not used by libgromacs
456 #if(GMX_XML AND NOT HAVE_LIBXML2)
457 #    message(FATAL_ERROR "libxml2 not found. Set GMX_XML=OFF to compile without XML support")
458 #endif()
459 #if(GMX_XML)
460 #    include_directories(${LIBXML2_INCLUDE_DIR})
461 #    set(PKG_XML libxml-2.0)
462 #    set(XML_LIBRARIES ${LIBXML2_LIBRARIES})
463 #endif()
465 gmx_option_trivalue(
466     GMX_HWLOC
467     "Use hwloc portable hardware locality library"
468     "AUTO")
470 if (GMX_HWLOC)
471     # Find quietly the second time.
472     if(DEFINED HWLOC_LIBRARIES)
473         set(Hwloc_FIND_QUIETLY TRUE)
474     endif()
475     find_package(Hwloc 1.5)
477     if (HWLOC_FOUND)
478         if (HWLOC_LIBRARIES MATCHES ".a$")
479             set(_STATIC_HWLOC TRUE)
480         endif()
482         gmx_check_if_changed(HWLOC_FOUND_CHANGED HWLOC_FOUND)
483         if (_STATIC_HWLOC AND HWLOC_FOUND_CHANGED)
484             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.")
485             set(GMX_USE_HWLOC OFF)
486         else()
487             set(GMX_USE_HWLOC ON)
488         endif()
490         if (GMX_USE_HWLOC)
491             include_directories(SYSTEM ${HWLOC_INCLUDE_DIRS})
492             list(APPEND GMX_EXTRA_LIBRARIES ${HWLOC_LIBRARIES})
493         endif()
494     elseif(GMX_HWLOC_FORCE)
495         message(FATAL_ERROR "Hwloc package support required, but not found.")
496     endif()
497 endif()
499 option(GMX_EXTERNAL_TINYXML2 "Use external TinyXML-2 instead of compiling the version bundled with GROMACS." OFF)
500 mark_as_advanced(GMX_EXTERNAL_TINYXML2)
501 if(GMX_EXTERNAL_TINYXML2)
502     # Find an external TinyXML-2 library.
503     find_package(TinyXML-2 3.0.0)
504     set(HAVE_TINYXML2 ${TinyXML2_FOUND})
505     if(NOT HAVE_TINYXML2)
506         message(FATAL_ERROR "External TinyXML-2 could not be found, please adjust your search paths")
507     endif()
508 endif()
510 option(GMX_EXTRAE "Add support for tracing using EXTRAE" OFF)
511 mark_as_advanced(GMX_EXTRAE)
513 if (GMX_EXTRAE)
514   find_package(EXTRAE)
515   if(EXTRAE_FOUND)
516     include_directories(SYSTEM ${EXTRAE_INCLUDE_DIR})
517     set(HAVE_EXTRAE 1)
518   else()
519     message(FATAL_ERROR "EXTRAE library was not found. Please add the correct path to CMAKE_PREFIX_PATH")
520   endif()
521 endif()
523 option(GMX_X11 "Use X window system" OFF)
524 if (GMX_X11)
525     find_package(X11)
526     # X11 includes/libraries are only set in the ngmx subdirectory!
527     if(NOT X11_FOUND)
528         message(FATAL_ERROR
529                 "X11 include files and/or libraries were not found. "
530                 "Set GMX_X11=OFF to compile without X11 support. "
531                 "gmx view will not be available.")
532     endif()
533     include_directories(SYSTEM ${X11_INCLUDE_DIR})
534 endif()
536 include(ThreadMPI)
537 # Enable core threading facilities
538 tmpi_enable_core("${CMAKE_SOURCE_DIR}/src/external/thread_mpi/include")
539 if(GMX_THREAD_MPI)
540     # enable MPI functions
541     tmpi_enable()
542     set(MPI_IN_PLACE_EXISTS 1)
543 endif()
544 # If atomics are manually disabled a define is needed because atomics.h doesn't depend on config.h
545 if (TMPI_ATOMICS_DISABLED)
546    add_definitions(-DTMPI_ATOMICS_DISABLED)
547 endif()
549 include(gmxManageTNG)
551 include(gmxManageLmfit)
553 if(GMX_GPU)
554     # now that we have detected the dependencies, do the second configure pass
555     gmx_gpu_setup()
556     if (GMX_CLANG_CUDA)
557         list(APPEND GMX_EXTRA_LIBRARIES ${GMX_CUDA_CLANG_LINK_LIBS})
558         link_directories("${GMX_CUDA_CLANG_LINK_DIRS}")
559     endif()
560 endif()
562 if(CYGWIN)
563     set(GMX_CYGWIN 1)
564 endif()
566 if(WIN32)
567     set(GMX_NATIVE_WINDOWS 1)
568     # This makes windows.h not declare min/max as macros that would break
569     # C++ code using std::min/std::max.
570     add_definitions(-DNOMINMAX)
571 endif()
573 if(CMAKE_SYSTEM_NAME STREQUAL "Darwin") #Work-around for cmake bug #10837
574     if (CMAKE_COMPILER_IS_GNUCC OR CMAKE_C_COMPILER_ID MATCHES "Intel" OR CMAKE_C_COMPILER_ID MATCHES "Clang")
575         set(CMAKE_INCLUDE_SYSTEM_FLAG_C "-isystem ")
576     endif()
577     if (CMAKE_COMPILER_IS_GNUCXX OR CMAKE_CXX_COMPILER_ID MATCHES "Intel" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
578         set(CMAKE_INCLUDE_SYSTEM_FLAG_CXX "-isystem ")
579     endif()
580 endif()
582 option(GMX_BUILD_UNITTESTS "Build unit tests with BUILD_TESTING" ON)
583 mark_as_advanced(GMX_BUILD_UNITTESTS)
584 gmx_add_cache_dependency(GMX_BUILD_UNITTESTS BOOL BUILD_TESTING OFF)
586 ########################################################################
587 # Our own GROMACS tests
588 ########################################################################
590 add_definitions( -DHAVE_CONFIG_H )
591 include_directories(BEFORE ${CMAKE_SOURCE_DIR}/src)
592 # TODO required at high level because both libgromacs and progs/mdrun
593 # require it, both for thread-MPI and its atomics and mutexes.
594 include_directories(BEFORE SYSTEM ${CMAKE_SOURCE_DIR}/src/external/thread_mpi/include)
595 # Required for config.h, maybe should only be set in src/CMakeLists.txt
596 include_directories(BEFORE ${CMAKE_BINARY_DIR}/src)
598 include(gmxTestInlineASM)
599 gmx_test_inline_asm_gcc_x86(GMX_X86_GCC_INLINE_ASM)
601 include(gmxSetBuildInformation)
602 gmx_set_build_information()
604 gmx_option_multichoice(
605     GMX_USE_RDTSCP
606     "Use low-latency RDTSCP instruction for CPU-based timers for mdrun execution; might need to be off when compiling for heterogeneous environments)"
607     "AUTO"
608     OFF ON AUTO DETECT)
609 mark_as_advanced(GMX_USE_RDTSCP)
611 macro(gmx_check_rdtscp)
612     if (CPU_DETECTION_FEATURES MATCHES "rdtscp")
613         set(HAVE_RDTSCP 1)
614         set(RDTSCP_DETECTION_MESSAGE " - detected on the build host")
615     else()
616         set(RDTSCP_DETECTION_MESSAGE " - not detected on the build host")
617     endif()
618 endmacro()
620 set(HAVE_RDTSCP 0)
621 if (GMX_USE_RDTSCP STREQUAL "ON")
622     set(HAVE_RDTSCP 1)
623 elseif(GMX_USE_RDTSCP STREQUAL "DETECT")
624     gmx_check_rdtscp()
625 elseif(GMX_USE_RDTSCP STREQUAL "AUTO")
626     # If the user specified automated SIMD selection, that the choice
627     # is made based on detection on the build host. If so, then RDTSCP
628     # should be chosen the same way.
629     #
630     # If the user specified an AVX SIMD level (e.g. when
631     # cross-compiling GROMACS) then they will get our best guess, ie
632     # that in practice AVX mostly correlates with rdtscp (and anyway
633     # is only relevant in rather old x86 hardware).
634     if (GMX_SIMD STREQUAL "AUTO")
635         gmx_check_rdtscp()
636     elseif (GMX_SIMD MATCHES "AVX")
637         set(HAVE_RDTSCP 1)
638     endif()
639 endif()
640 gmx_check_if_changed(HAVE_RDTSCP_CHANGED HAVE_RDTSCP)
641 if (HAVE_RDTSCP_CHANGED)
642     if (HAVE_RDTSCP)
643         message(STATUS "Enabling RDTSCP support${RDTSCP_DETECTION_MESSAGE}")
644     else()
645         message(STATUS "Disabling RDTSCP support${RDTSCP_DETECTION_MESSAGE}")
646     endif()
647 endif()
649 include(gmxTestLargeFiles)
650 gmx_test_large_files(GMX_LARGEFILES)
652 include(gmxTestSignal)
653 gmx_test_sigusr1(HAVE_SIGUSR1)
655 include(gmxTestPipes)
656 gmx_test_pipes(HAVE_PIPES)
658 include(gmxTestXDR)
659 gmx_test_xdr(GMX_SYSTEM_XDR)
660 # Darwin has system XDR, but it uses a three-argument flavour of
661 # xdrproc_t that it guarantees will still work if you pass the normal
662 # two-argument xdr filters, but gcc 8 warns about the cast necessary
663 # to do that, so it's simpler to just use our own XDR library.
665 # TODO It would be better to craft a cmake test which fails if such
666 # XDR operations cause warnings, and succeeds otherwise, because it is
667 # generally preferable to use system libraries where possible.
668 if(NOT GMX_SYSTEM_XDR OR CMAKE_SYSTEM_NAME STREQUAL "Darwin")
669     set(GMX_INTERNAL_XDR 1)
670 endif()
673 ##################################################
674 # Process SIMD instruction settings
675 ##################################################
676 # This checks what flags to add in order to
677 # support the SIMD instructions we need, it sets
678 # correct defines for the SIMD instructions supported,
679 # and adds advanced options to control accuracy
680 # for SIMD math operations.
681 include(gmxManageSimd)
682 gmx_manage_simd()
684 include(gmxManageCycleCounters)
685 gmx_manage_cycle_counters()
687 # Process QM/MM Settings
688 if(${GMX_QMMM_PROGRAM} STREQUAL "GAUSSIAN")
689     set(GMX_QMMM_GAUSSIAN 1)
690 elseif(${GMX_QMMM_PROGRAM} STREQUAL "MOPAC")
691     set(GMX_QMMM_MOPAC 1)
692 elseif(${GMX_QMMM_PROGRAM} STREQUAL "GAMESS")
693     set(GMX_QMMM_GAMESS 1)
694 elseif(${GMX_QMMM_PROGRAM} STREQUAL "ORCA")
695     set(GMX_QMMM_ORCA 1)
696 elseif(${GMX_QMMM_PROGRAM} STREQUAL "NONE")
697     # nothing to do
698 else()
699     gmx_invalid_option_value(GMX_QMMM_PROGRAM)
700 endif()
703 ##################################################
704 # Process FFT library settings
705 ##################################################
706 include(gmxManageFFTLibraries)
709 include(gmxManageLinearAlgebraLibraries)
711 include(gmxManagePluginSupport)
713 if (GMX_USE_PLUGINS)
714     if(NOT GMX_VMD_PLUGIN_PATH)
715         find_package(VMD)
716     endif()
717 endif()
719 # Link real-time library for POSIX timers. The check for clock_gettime
720 # confirms the linkability of rt.
721 if(HAVE_TIME_H AND HAVE_UNISTD_H AND HAVE_CLOCK_GETTIME)
722     list(APPEND GMX_EXTRA_LIBRARIES rt)
723 endif()
725 # Math and thread libraries must often come after all others when linking...
726 if (HAVE_LIBM)
727     list(APPEND GMX_PUBLIC_LIBRARIES m)
728 endif()
730 option(GMX_NACL "Configure for Native Client builds" OFF)
731 if (GMX_NACL)
732   list(APPEND GMX_EXTRA_LIBRARIES nosys)
733   set(GMX_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lnosys")
734   # TODO: Is this still necessary with the check for its presence?
735   set(GMX_USE_NICE 0)
736   set(GMX_NO_RENAME 1)
737 endif()
738 mark_as_advanced(GMX_NACL)
740 if(GMX_FAHCORE)
741   set(COREWRAP_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/../corewrap" CACHE STRING
742       "Path to swindirect.h")
743   include_directories(${COREWRAP_INCLUDE_DIR})
744 endif()
746 # Value of GMX_BUILD_HELP=AUTO tries to generate things, but will only
747 # produce warnings if that fails.
748 set(build_help_default AUTO)
749 if (SOURCE_IS_SOURCE_DISTRIBUTION OR CMAKE_CROSSCOMPILING)
750     set(build_help_default OFF)
751 endif()
752 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})
753 mark_as_advanced(GMX_BUILD_HELP)
754 if (GMX_BUILD_HELP AND SOURCE_IS_SOURCE_DISTRIBUTION AND BUILD_IS_INSOURCE)
755     message(FATAL_ERROR
756         "Rebuilding shell completions or man pages is not supported for "
757         "in-source builds from a source distribution. "
758         "Set GMX_BUILD_HELP=OFF or do an out-of-source build to proceed.")
759 endif()
761 # # # # # # # # # # NO MORE TESTS AFTER THIS LINE! # # # # # # # # # # #
762 # these are set after everything else
763 if (NOT GMX_SKIP_DEFAULT_CFLAGS)
764     set(CMAKE_C_FLAGS "${SIMD_C_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_C_FLAGS} ${CMAKE_C_FLAGS}")
765     set(CMAKE_CXX_FLAGS "${SIMD_CXX_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_CXX_FLAGS} ${CMAKE_CXX_FLAGS}")
766     set(CMAKE_EXE_LINKER_FLAGS "${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS}")
767     set(CMAKE_SHARED_LINKER_FLAGS "${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS} ${CMAKE_SHARED_LINKER_FLAGS}")
768 else()
769     message("Recommended flags which are not added because GMX_SKIP_DEFAULT_CFLAGS=yes:")
770     message("CMAKE_C_FLAGS: ${SIMD_C_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_C_FLAGS} ${GMXC_CFLAGS}")
771     message("CMAKE_C_FLAGS_RELEASE: ${GMXC_CFLAGS_RELEASE}")
772     message("CMAKE_C_FLAGS_DEBUG: ${GMXC_CFLAGS_DEBUG}")
773     message("CMAKE_CXX_FLAGS: ${SIMD_CXX_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_CXX_FLAGS} ${GMXC_CXXFLAGS}")
774     message("CMAKE_CXX_FLAGS_RELEASE: ${GMXC_CXXFLAGS_RELEASE}")
775     message("CMAKE_CXX_FLAGS_DEBUG: ${GMXC_CXXFLAGS_DEBUG}")
776     message("CMAKE_EXE_LINKER_FLAGS: ${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS}")
777     message("CMAKE_SHARED_LINKER_FLAGS: ${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS}")
778 endif()
780 ########################################################################
781 # Specify install locations
782 ########################################################################
783 # Use GNUInstallDirs to set paths on multiarch systems.
784 include(GNUInstallDirs)
786 set(GMX_INSTALL_DATASUBDIR "gromacs" CACHE STRING "Subdirectory for GROMACS data under CMAKE_INSTALL_DATADIR")
787 mark_as_advanced(GMX_INSTALL_DATASUBDIR)
789 # Internal convenience so we do not have to join two path segments in the code
790 set(GMX_INSTALL_GMXDATADIR ${CMAKE_INSTALL_DATADIR}/${GMX_INSTALL_DATASUBDIR})
792 # If the nesting level wrt. the installation root is changed,
793 # gromacs-config.cmake.cmakein needs to be adapted.
794 set(GMX_INSTALL_CMAKEDIR  ${CMAKE_INSTALL_DATAROOTDIR}/cmake)
796 # TODO: Make GMXRC adapt if this is changed
797 set(GMX_INSTALL_PKGCONFIGDIR ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
798 set(GMX_INSTALL_OCLDIR       ${GMX_INSTALL_GMXDATADIR}/opencl)
800 list(APPEND INSTALLED_HEADER_INCLUDE_DIRS ${CMAKE_INSTALL_INCLUDEDIR})
802 # Binary and library suffix options
803 include(gmxManageSuffixes)
805 ################################################################
806 # Shared library load path settings
807 ################################################################
808 if(NOT GMX_BUILD_SHARED_EXE)
809     # No rpath
810     set(CMAKE_SKIP_RPATH TRUE)
811     set(CMAKE_EXE_LINK_DYNAMIC_C_FLAGS) # remove -Wl,-Bdynamic
812     set(CMAKE_EXE_LINK_DYNAMIC_CXX_FLAGS)
813 else()
814     # The build folder always has bin/ and lib/; if we are also going to
815     # install to lib/, then the installation RPATH works also in the build
816     # tree.  This makes installation slightly faster (no need to rewrite the
817     # RPATHs), and makes the binaries in the build tree relocatable.
818     if(CMAKE_INSTALL_LIBDIR STREQUAL "lib")
819         set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
820         if(POLICY CMP0068)
821             cmake_policy(SET CMP0068 NEW) # From CMake-3.9
822             set(CMAKE_BUILD_WITH_INSTALL_NAME_DIR TRUE)
823         endif()
824     endif()
825     # Set the RPATH as relative to the executable location to make the
826     # binaries relocatable.
827     if(CMAKE_SYSTEM_NAME STREQUAL "Darwin") #Assume OS X >=10.5
828         set(CMAKE_INSTALL_RPATH "@loader_path/../${CMAKE_INSTALL_LIBDIR}")
829         set(CMAKE_INSTALL_NAME_DIR ${CMAKE_INSTALL_RPATH})
830     else()
831         set(CMAKE_INSTALL_RPATH "\$ORIGIN/../${CMAKE_INSTALL_LIBDIR}")
832     endif()
833     set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
834     set(CMAKE_MACOSX_RPATH 1)
835 endif()
837 #COPYING file: Only necessary for binary distributions.
838 #Simpler to always install.
839 install(FILES COPYING DESTINATION ${GMX_INSTALL_GMXDATADIR} COMPONENT data)
841 if (GMX_BUILD_FOR_COVERAGE)
842     # Code heavy with asserts makes conditional coverage close to useless metric,
843     # as by design most of the false branches are impossible to trigger in
844     # correctly functioning code.  And the benefit of testing those that could
845     # be triggered by using an API against its specification isn't usually
846     # worth the effort.
847     add_definitions(-DNDEBUG -DGMX_DISABLE_ASSERTS)
848 endif()
850 if (BUILD_TESTING)
851     include(tests/CheckTarget.cmake)
852 endif()
854 if (NOT GMX_BUILD_MDRUN_ONLY)
855     find_package(ImageMagick QUIET COMPONENTS convert)
856     include(gmxTestImageMagick)
857     GMX_TEST_IMAGEMAGICK(IMAGE_CONVERT_POSSIBLE)
858     add_subdirectory(docs)
859     add_subdirectory(share)
860     add_subdirectory(scripts)
861 endif()
862 add_subdirectory(src)
864 if (BUILD_TESTING)
865     add_subdirectory(tests)
866 endif()
868 gmx_cpack_write_config()
870 # Issue a warning if NVIDIA GPUs were detected, but CUDA was not found.
871 # Don't bother the user after the first configure pass.
872 if ((CUDA_NOTFOUND_AUTO AND GMX_DETECT_GPU_AVAILABLE) AND NOT GMX_GPU_DETECTION_DONE)
873     message(WARNING "${CUDA_NOTFOUND_MESSAGE}")
874 endif()
875 set(GMX_GPU_DETECTION_DONE TRUE CACHE INTERNAL "Whether GPU detection has already been done")
877 #######################
878 ## uninstall target
879 #######################
880 CONFIGURE_FILE(   "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
881                   "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake"
882                   IMMEDIATE @ONLY)
883 ###########################
884 ADD_CUSTOM_TARGET(uninstall
885                   "${CMAKE_COMMAND}" -P
886                   "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake")
887 ###########################
888 set_directory_properties(PROPERTIES
889             ADDITIONAL_MAKE_CLEAN_FILES "install_manifest.txt")