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