Interactive Molecular Dynamics (IMD)
[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,2014, 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.
8 #
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.
13 #
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.
18 #
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.
23 #
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.
31 #
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.
34
35 cmake_minimum_required(VERSION 2.8.8)
36
37 # CMake modules/macros are in a subdirectory to keep this file cleaner
38 # This needs to be set before project() in order to pick up toolchain files
39 list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_CURRENT_SOURCE_DIR}/cmake/Platform)
40
41 project(Gromacs)
42
43 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
44 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
45 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
46
47 # PROJECT_VERSION should have the following structure:
48 # VERSION-dev[-SUFFIX] where the VERSION should have the for: vMajor.vMinor.vPatch
49 #
50 # The "-dev" suffix is important to keep because it makes possible to distinguish
51 # between a build from official release and a build from git release branch on a
52 # machine with no git.
53 #
54 # NOTE: when releasing the "-dev" suffix needs to be stripped off!
55 set(PROJECT_VERSION "5.0-beta2-dev")
56 # The version number of the regressiontest tarball against which this
57 # git branch can be tested. Normally, this will be the version of the
58 # last patch release. Comment the next line out for branches leading
59 # to a major/minor release.
60 set(REGRESSIONTEST_VERSION "5.0-beta1")
61 set(CUSTOM_VERSION_STRING ""
62     CACHE STRING "Custom version string (if empty, use hard-coded default)")
63 mark_as_advanced(CUSTOM_VERSION_STRING)
64 if (CUSTOM_VERSION_STRING)
65     set(PROJECT_VERSION ${CUSTOM_VERSION_STRING})
66 endif()
67 set(LIBRARY_SOVERSION 0)
68 set(LIBRARY_VERSION ${LIBRARY_SOVERSION}.0.0)
69 # It is a bit irritating, but this has to be set separately for now!
70 SET(CPACK_PACKAGE_VERSION_MAJOR "5")
71 SET(CPACK_PACKAGE_VERSION_MINOR "0")
72 #SET(CPACK_PACKAGE_VERSION_PATCH "0")
73
74 # The numerical gromacs version. It is 40600 for 4.6.0.
75 # The #define GMX_VERSION in gromacs/version.h is set to this value.
76 math(EXPR NUM_VERSION
77     "${CPACK_PACKAGE_VERSION_MAJOR}*10000 + ${CPACK_PACKAGE_VERSION_MINOR}*100")
78 if(CPACK_PACKAGE_VERSION_PATCH)
79     math(EXPR NUM_VERSION
80          "${NUM_VERSION} + ${CPACK_PACKAGE_VERSION_PATCH}")
81 endif()
82
83 # The API version tracks the numerical Gromacs version (for now).
84 # It is potentially different from the Gromacs version in the future, if
85 # the programs/libraries diverge from the presumably more stable API.
86 # The #define GMX_API_VERSION in version.h is set to this value to
87 # provide backward compatibility of software written against the Gromacs API.
88 set(API_VERSION ${NUM_VERSION})
89
90 if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND UNIX)
91     set(CMAKE_INSTALL_PREFIX "/usr/local/gromacs" CACHE STRING "Installation prefix (installation will need write permissions here)" FORCE)
92 endif()
93
94 set(GMX_INSTALL_PREFIX "" CACHE STRING "Prefix gets appended to CMAKE_INSTALL_PREFIX. For cpack it sets the root folder of the archive.")
95 mark_as_advanced(GMX_INSTALL_PREFIX)
96
97 include(gmxBuildTypeReference)
98 include(gmxBuildTypeThreadSanitizer)
99 include(gmxBuildTypeReleaseWithAssert)
100
101 if(NOT CMAKE_BUILD_TYPE)
102     set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build, options are: Debug Release RelWithDebInfo MinSizeRel Reference RelWithAssert." FORCE)
103     # There's no need to offer a user the choice of ThreadSanitizer
104     # Set the possible values of build type for cmake-gui
105     set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release"
106         "MinSizeRel" "RelWithDebInfo" "Reference" "RelWithAssert")
107 endif()
108 if(CMAKE_CONFIGURATION_TYPES)
109     # Add appropriate GROMACS-specific build types for the Visual
110     # Studio generator (Debug, Release, MinSizeRel and RelWithDebInfo
111     # are already present by default).
112     list(APPEND CMAKE_CONFIGURATION_TYPES "RelWithAssert" "Reference")
113     list(REMOVE_DUPLICATES CMAKE_CONFIGURATION_TYPES)
114     set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES}" CACHE STRING
115         "List of configuration types"
116         FORCE)
117 endif()
118 set(build_types_with_explicit_flags RELEASE DEBUG RELWITHDEBUGINFO RELWITHASSERT MINSIZEREL)
119
120 enable_language(C)
121 enable_language(CXX)
122
123 set(CPACK_PACKAGE_VERSION ${PROJECT_VERSION})
124 set(CPACK_PACKAGE_VENDOR "gromacs.org")
125 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Gromacs - a toolkit for high-performance molecular simulation")
126 set(CPACK_RESOURCE_FILE_WELCOME "${CMAKE_SOURCE_DIR}/admin/InstallWelcome.txt")
127 # Its GPL/LGPL, so they do not have to agree to a license for mere usage, but some installers require this...
128 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/COPYING")
129 set(CPACK_RESOURCE_FILE_README "${CMAKE_SOURCE_DIR}/admin/InstallInfo.txt")
130 set(CPACK_SOURCE_IGNORE_FILES "\\\\.isreposource$;\\\\.git/;\\\\.gitignore$")
131 set(CPACK_PROJECT_CONFIG_FILE "${CMAKE_SOURCE_DIR}/CPackInit.cmake")
132 set(CPACK_SOURCE_INSTALLED_DIRECTORIES "${CMAKE_SOURCE_DIR};/;${CMAKE_BINARY_DIR}/src/programs/completion;src/programs/completion;${CMAKE_BINARY_DIR}/share/man/man1;share/man/man1;${CMAKE_BINARY_DIR}/share/man/man7;share/man/man7;${CMAKE_BINARY_DIR}/share/html/final;share/html/final")
133 set(CPACK_PACKAGE_CONTACT "gmx-users@gromacs.org")
134
135 #must come after all cpack settings!
136 include(CPack)
137
138 # Set a default valgrind suppression file.
139 # This unfortunately needs to duplicate information from CTest to work as
140 # expected...
141 set(MEMORYCHECK_SUPPRESSIONS_FILE
142     "${CMAKE_SOURCE_DIR}/cmake/legacy_and_external.supp"
143     CACHE FILEPATH
144     "File that contains suppressions for the memory checker")
145 include(CTest)
146
147 set(SOURCE_IS_GIT_REPOSITORY OFF)
148 set(SOURCE_IS_SOURCE_DISTRIBUTION OFF)
149 if(EXISTS "${CMAKE_SOURCE_DIR}/.git")
150     set(SOURCE_IS_GIT_REPOSITORY ON)
151 endif()
152 if(NOT EXISTS "${CMAKE_SOURCE_DIR}/admin/.isreposource")
153     set(SOURCE_IS_SOURCE_DISTRIBUTION ON)
154 endif()
155
156 ########################################################################
157 # Check and warn if cache generated on a different host is being reused
158 ########################################################################
159 if(CMAKE_HOST_UNIX)
160     execute_process(COMMAND hostname
161                     OUTPUT_VARIABLE TMP_HOSTNAME
162                     OUTPUT_STRIP_TRAILING_WHITESPACE)
163     if(GMX_BUILD_HOSTNAME AND NOT "${GMX_BUILD_HOSTNAME}" STREQUAL "${TMP_HOSTNAME}")
164         message(WARNING "
165             The CMake cache, probably generated on a different host (${GMX_BUILD_HOSTNAME}),
166             is being reused! This could lead to inconsitencies; therefore, it is
167             recommended to regenerate the cache!")
168     endif()
169     set(GMX_BUILD_HOSTNAME "${TMP_HOSTNAME}" CACHE INTERNAL
170             "Hostname of the machine where the cache was generated.")
171 endif()
172
173 ########################################################################
174 # User input options                                                   #
175 ########################################################################
176 include(gmxOptionUtilities)
177
178 set(CMAKE_PREFIX_PATH "" CACHE STRING "Extra locations to search for external libraries and tools (give directory without lib, bin, or include)")
179
180 option(GMX_DOUBLE "Use double precision (much slower, use only if you really need it)" OFF)
181 option(GMX_MPI    "Build a parallel (message-passing) version of GROMACS" OFF)
182 option(GMX_THREAD_MPI  "Build a thread-MPI-based multithreaded version of GROMACS (not compatible with MPI)" ON)
183 gmx_dependent_option(
184     GMX_MPI_IN_PLACE
185     "Enable MPI_IN_PLACE for MPIs that have it defined"
186     ON
187     GMX_MPI)
188 mark_as_advanced(GMX_MPI_IN_PLACE)
189 option(GMX_SOFTWARE_INVSQRT "Use GROMACS software 1/sqrt" ON)
190 mark_as_advanced(GMX_SOFTWARE_INVSQRT)
191 option(GMX_FAHCORE "Build a library with mdrun functionality" OFF)
192 mark_as_advanced(GMX_FAHCORE)
193
194 option(GMX_COOL_QUOTES "Enable Gromacs cool quotes" ON)
195 mark_as_advanced(GMX_COOL_QUOTES)
196 gmx_add_cache_dependency(GMX_COOL_QUOTES BOOL "NOT GMX_FAHCORE" OFF)
197
198 # decide on GPU settings based on user-settings and GPU/CUDA detection
199 include(gmxManageGPU)
200
201 # Detect the architecture the compiler is targetting, detect
202 # SIMD instructions possibilities on that hardware, suggest SIMD instruction set
203 # to use if none is specified, and populate the cache option for CPU
204 # SIMD.
205 include(gmxDetectTargetArchitecture)
206 gmx_detect_target_architecture()
207
208 if(GMX_CPU_ACCELERATION)
209     # Stay compatible with old Jenkins command line options for specific SIMD acceleration
210     set(GMX_SIMD "${GMX_CPU_ACCELERATION}" CACHE STRING "SIMD instruction set level and compiler optimization" FORCE)
211 endif()
212
213 if(NOT GMX_TARGET_MIC)
214     include(gmxDetectSimd)
215     gmx_detect_simd(GMX_SUGGESTED_SIMD)
216 else()
217     set(GMX_SUGGESTED_SIMD "None")
218 endif()
219
220 gmx_option_multichoice(
221     GMX_SIMD
222     "SIMD instruction set for CPU kernels and compiler optimization"
223     "${GMX_SUGGESTED_SIMD}"
224     None SSE2 SSE4.1 AVX_128_FMA AVX_256 AVX2_256 IBM_QPX Sparc64_HPC_ACE Reference)
225
226 gmx_option_multichoice(
227     GMX_FFT_LIBRARY
228     "FFT library"
229     "fftw3"
230     fftw3 mkl "fftpack[built-in]")
231 gmx_dependent_option(
232     GMX_BUILD_OWN_FFTW
233     "Download and build FFTW 3 during the GROMACS build process, rather than fall back on the really slow fftpack."
234     OFF
235     "GMX_FFT_LIBRARY STREQUAL FFTW3")
236 gmx_dependent_option(
237     GMX_DISABLE_FFTW_MEASURE
238     "Do not optimize FFTW setups (not needed with SSE)"
239     OFF
240     "GMX_FFT_LIBRARY STREQUAL FFTW3")
241 mark_as_advanced(GMX_BUILD_OWN_FFTW)
242 mark_as_advanced(GMX_DISABLE_FFTW_MEASURE)
243
244 gmx_option_multichoice(
245     GMX_QMMM_PROGRAM
246     "QM package for QM/MM"
247     None
248     none gaussian mopac gamess orca)
249
250 gmx_dependent_cache_variable(GMX_SIMD_REF_FLOAT_WIDTH  "Reference SIMD single precision width" STRING "4" "GMX_SIMD STREQUAL REFERENCE")
251 gmx_dependent_cache_variable(GMX_SIMD_REF_DOUBLE_WIDTH "Reference SIMD double precision width" STRING "2" "GMX_SIMD STREQUAL REFERENCE")
252
253 # This should be moved to a separate NBNXN cmake module when that code is cleaned up and modularized
254
255 option(GMX_BROKEN_CALLOC "Work around broken calloc()" OFF)
256 mark_as_advanced(GMX_BROKEN_CALLOC)
257 option(GMX_LOAD_PLUGINS "Compile with plugin support, needed to read VMD supported file formats" ON)
258 mark_as_advanced(GMX_LOAD_PLUGINS)
259
260 option(GMX_GPU  "Enable GPU acceleration" ON)
261 option(GMX_OPENMP "Enable OpenMP-based multithreading" ON)
262
263 option(GMX_USE_TNG "Use the TNG library for trajectory I/O" ON)
264
265 option(GMX_GIT_VERSION_INFO "Generate git version information" ${SOURCE_IS_GIT_REPOSITORY})
266 mark_as_advanced(GMX_GIT_VERSION_INFO)
267
268 if(UNIX)
269     option(GMX_SYMLINK_OLD_BINARY_NAMES "Create symbolic links for pre-5.0 binary names" ON)
270 endif()
271 option(GMX_BUILD_MDRUN_ONLY "Build and install only the mdrun binary" OFF)
272
273 option(GMX_CYCLE_SUBCOUNTERS "Enable cycle subcounters to get a more detailed cycle timings" OFF)
274 mark_as_advanced(GMX_CYCLE_SUBCOUNTERS)
275
276 option(GMX_SKIP_DEFAULT_CFLAGS "Don't automatically add suggested/required Compiler flags." OFF)
277 mark_as_advanced(GMX_SKIP_DEFAULT_CFLAGS)
278
279 option(GMX_BUILD_FOR_COVERAGE
280        "Tune build for better code coverage metrics (e.g., disable asserts)"
281        OFF)
282 mark_as_advanced(GMX_BUILD_FOR_COVERAGE)
283
284
285 ######################################################################
286 # Detect OpenMP support
287 ######################################################################
288 # The OpenMP detection _must_ come before tests for other CFLAGS.
289 include(gmxManageOpenMP)
290
291
292
293 ######################################################################
294 # Compiler tests
295 # These need to be done early (before further tests).
296 #####################################################################
297
298 # The cmake/Check{C,CXX}CompilerFlag.cmake files in the GROMACS distribution
299 # are used with permission from CMake v2.8.9 so that GROMACS can detect
300 # invalid options with the Intel Compilers.
301 # These files should be removed from the source tree when a CMake version that
302 # includes the features in question becomes required for building GROMACS.
303 include(CheckCCompilerFlag)
304 include(CheckCXXCompilerFlag)
305
306
307 include(gmxCFlags)
308 gmx_c_flags()
309
310 # This variable should be used for additional compiler flags which are not
311 # generated in gmxCFlags nor are SIMD or MPI related.
312 set(EXTRA_C_FLAGS "")
313 set(EXTRA_CXX_FLAGS "")
314
315 # Run through a number of tests for buggy compilers and other issues
316 include(gmxTestCompilerProblems)
317 gmx_test_compiler_problems()
318
319
320 set(PKG_CFLAGS "")
321 if(GMX_DOUBLE)
322     add_definitions(-DGMX_DOUBLE)
323     set(PKG_CFLAGS "${PKG_CFLAGS} -DGMX_DOUBLE")
324 endif()
325 if(GMX_SOFTWARE_INVSQRT)
326   set(PKG_CFLAGS "${PKG_CFLAGS} -DGMX_SOFTWARE_INVSQRT")
327 endif()
328
329 if(WIN32 AND NOT CYGWIN)
330     set(GMX_WSOCKLIB_PATH CACHE PATH "Path to winsock (wsock32.lib) library.")
331     mark_as_advanced(GMX_WSOCKLIB_PATH)
332     find_library(WSOCK32_LIBRARY NAMES wsock32 PATHS ${GMX_WSOCKLIB_PATH})
333     if(WSOCK32_LIBRARY)
334         list(APPEND GMX_EXTRA_LIBRARIES ${WSOCK32_LIBRARY})
335         add_definitions(-DGMX_HAVE_WINSOCK)
336     else()
337         message(STATUS "No winsock found. Cannot use interactive molecular dynamics (IMD).")
338     endif(WSOCK32_LIBRARY)
339 endif()
340
341
342
343 ########################################################################
344 # Basic system tests (standard libraries, headers, functions, types)   #
345 ########################################################################
346 include(CheckIncludeFiles)
347 include(CheckIncludeFileCXX)
348 check_include_files(unistd.h     HAVE_UNISTD_H)
349 check_include_files(pwd.h        HAVE_PWD_H)
350 check_include_files(dirent.h     HAVE_DIRENT_H)
351 check_include_files(time.h       HAVE_TIME_H)
352 check_include_files(sys/time.h   HAVE_SYS_TIME_H)
353 check_include_files(io.h         HAVE_IO_H)
354 check_include_files(sched.h      HAVE_SCHED_H)
355
356 check_include_files(regex.h      HAVE_POSIX_REGEX)
357 check_include_file_cxx(regex     HAVE_CXX11_REGEX)
358 # TODO: It could be nice to inform the user if no regex support is found,
359 # as selections won't be fully functional.
360
361 include(CheckFunctionExists)
362 check_function_exists(posix_memalign    HAVE_POSIX_MEMALIGN)
363 check_function_exists(memalign          HAVE_MEMALIGN)
364 check_function_exists(_aligned_malloc   HAVE__ALIGNED_MALLOC)
365 check_function_exists(gettimeofday      HAVE_GETTIMEOFDAY)
366 check_function_exists(fsync             HAVE_FSYNC)
367 check_function_exists(_fileno           HAVE__FILENO)
368 check_function_exists(fileno            HAVE_FILENO)
369 check_function_exists(_commit           HAVE__COMMIT)
370 check_function_exists(sigaction         HAVE_SIGACTION)
371 check_function_exists(sysconf           HAVE_SYSCONF)
372 check_function_exists(sched_setaffinity HAVE_SCHED_SETAFFINITY)
373 check_function_exists(sched_getaffinity HAVE_SCHED_GETAFFINITY)
374 check_function_exists(rsqrt             HAVE_RSQRT)
375 check_function_exists(rsqrtf            HAVE_RSQRTF)
376 check_function_exists(sqrtf             HAVE_SQRTF)
377
378 include(CheckLibraryExists)
379 check_library_exists(m sqrt "" HAVE_LIBM)
380 check_library_exists(rt clock_gettime "" HAVE_CLOCK_GETTIME)
381
382 include(TestBigEndian)
383 test_big_endian(GMX_INTEGER_BIG_ENDIAN)
384
385 # Management of GROMACS options for specific toolchains should go
386 # here. Because the initial settings for some of the main options have
387 # already happened, but things like library detection and MPI compiler
388 # feature detection have not, the docstrings for any over-rides of
389 # GROMACS defaults or user settings will make sense. Also, any
390 # toolchain-related reasons for choosing whether to detect various
391 # things can be sorted out now, before the detection takes place.
392 if(${CMAKE_SYSTEM_NAME} MATCHES BlueGene)
393     include(gmxManageBlueGene)
394 endif()
395
396 ########################################################################
397 #Process MPI settings
398 ########################################################################
399 include(gmxManageMPI)
400
401
402 ########################################################################
403 #Process shared/static library settings
404 ########################################################################
405 include(gmxManageSharedLibraries)
406
407
408 ########################################################################
409 # Find external packages                                               #
410 ########################################################################
411
412 # Unconditionally find the package, as it is also required for unit
413 # tests. This exports LIBXML2_FOUND, which we should not use because
414 # it does not tell us that linking will succeed. Instead, we test that
415 # next.
416 find_package(LibXml2)
417 include(gmxTestLibXml2)
418 gmx_test_libxml2(HAVE_LIBXML2)
419 option(GMX_XML "Use libxml2 to parse xml files (currently has no effect)" ${HAVE_LIBXML2})
420 set(PKG_XML "")
421 mark_as_advanced(GMX_XML)
422 # Don't actually do anything, since libxml2 is currently not used by libgromacs
423 #if(GMX_XML AND NOT HAVE_LIBXML2)
424 #    message(FATAL_ERROR "libxml2 not found. Set GMX_XML=OFF to compile without XML support")
425 #endif()
426 #if(GMX_XML)
427 #    include_directories(${LIBXML2_INCLUDE_DIR})
428 #    set(PKG_XML libxml-2.0)
429 #    set(XML_LIBRARIES ${LIBXML2_LIBRARIES})
430 #endif()
431
432 option(GMX_GSL "Add support for gsl" OFF)
433 if (GMX_GSL)
434   find_package(GSL)
435   set(PKG_GSL "")
436   if(GSL_FOUND)
437     include_directories(${GSL_INCLUDE_DIR})
438     set(PKG_GSL gsl)
439     set(HAVE_LIBGSL 1)
440   endif()
441 endif()
442
443 option(GMX_X11 "Use X window system" OFF)
444 if (GMX_X11)
445     find_package(X11)
446     # X11 includes/libraries are only set in the ngmx subdirectory!
447     if(NOT X11_FOUND)
448         message(FATAL_ERROR
449                 "X11 include files and/or libraries were not found. "
450                 "Set GMX_X11=OFF to compile without X11 support. "
451                 "gmx view will not be available.")
452     endif()
453     include_directories(${X11_INCLUDE_DIR})
454 endif()
455
456 include(ThreadMPI)
457 set(THREAD_MPI_LIB thread_mpi)
458 # Enable core threading facilities
459 tmpi_enable_core("${CMAKE_SOURCE_DIR}/src/gromacs/legacyheaders")
460 # Enable tMPI C++ support
461 tmpi_enable_cxx()
462 if(GMX_THREAD_MPI)
463     # enable MPI functions
464     tmpi_enable()
465     set(GMX_MPI 1)
466     set(MPI_IN_PLACE_EXISTS 1)
467 endif()
468 tmpi_get_source_list(THREAD_MPI_SRC)
469 # If atomics are manually disabled a define is needed because atomics.h doesn't depend on config.h
470 if (TMPI_ATOMICS_DISABLED)
471    add_definitions(-DTMPI_ATOMICS_DISABLED)
472 endif()
473
474 if(GMX_GPU)
475     # now that we have detected the dependencies, do the second configure pass
476     gmx_gpu_setup()
477 endif()
478
479 if(CYGWIN)
480     set(GMX_CYGWIN 1)
481 endif()
482
483 if(WIN32 AND NOT CYGWIN)
484     set(GMX_NATIVE_WINDOWS 1)
485     # This makes windows.h not declare min/max as macros that would break
486     # C++ code using std::min/std::max.
487     add_definitions(-DNOMINMAX)
488 endif()
489
490 # only bother with finding git and using version.h if the source is a git repo
491 if(GMX_GIT_VERSION_INFO)
492     if (NOT SOURCE_IS_GIT_REPOSITORY)
493         message(FATAL_ERROR
494             "Cannot generate git version information from source tree not under git. "
495             "Set GMX_GIT_VERSION_INFO=OFF to proceed.")
496     endif()
497     # We need at least git v1.5.3 be able to parse git's date output. If not
498     # found or the version is too small, we can't generate version information.
499     find_package(Git)
500
501     if(NOT GIT_FOUND OR GIT_VERSION_STRING VERSION_LESS "1.5.3")
502         message(FATAL_ERROR
503             "No compatible git version found (>= 1.5.3 required). "
504             "Won't be able to generate development version information. "
505             "Set GMX_GIT_VERSION_INFO=OFF to proceed.")
506     endif()
507 endif()
508
509 # Detect boost unless GMX_EXTERNAL_BOOST is explicitly OFF
510 # Used for default if GMX_EXTERNAL_BOOST is not defined (first CMake pass)
511 if(NOT DEFINED GMX_EXTERNAL_BOOST OR GMX_EXTERNAL_BOOST)
512     find_package(Boost 1.44.0)
513     if(Boost_FOUND AND Boost_VERSION VERSION_LESS "104400")
514         set(Boost_FOUND FALSE)
515     endif()
516     # Print the notification only on first run, when determining the default
517     if(NOT DEFINED GMX_EXTERNAL_BOOST AND NOT Boost_FOUND)
518         message("Boost >= 1.44 not found. Using minimal internal version. "
519                 "This may cause trouble if you plan on compiling/linking other "
520                 "software that uses Boost against Gromacs.")
521     endif()
522 endif()
523 option(GMX_EXTERNAL_BOOST "Use external Boost instead of minimal built-in version"
524        ${Boost_FOUND})
525 if(GMX_EXTERNAL_BOOST AND NOT Boost_FOUND)
526     message(FATAL_ERROR
527         "Boost >= 1.44 not found. "
528         "You can set GMX_EXTERNAL_BOOST=OFF to compile against minimal "
529         "version of Boost included with Gromacs.")
530 endif()
531
532 option(GMX_BUILD_UNITTESTS "Build unit tests with BUILD_TESTING (uses Google C++ Testing and Mocking Frameworks, requires libxml2)" ${HAVE_LIBXML2})
533 mark_as_advanced(GMX_BUILD_UNITTESTS)
534 gmx_add_cache_dependency(GMX_BUILD_UNITTESTS BOOL BUILD_TESTING OFF)
535 if (GMX_BUILD_UNITTESTS AND NOT HAVE_LIBXML2)
536     message(FATAL_ERROR
537         "Cannot build unit tests without libxml2. "
538         "Either set GMX_BUILD_UNITTESTS=OFF or tell CMake how to find a working version of libxml2.")
539 endif()
540
541 ########################################################################
542 # Generate development version info for cache
543 ########################################################################
544 # set(GEN_VERSION_INFO_INTERNAL "ON")
545 # include(gmxGenerateVersionString)
546
547 ########################################################################
548 # Our own GROMACS tests
549 ########################################################################
550
551 add_definitions( -DHAVE_CONFIG_H )
552 include_directories(${CMAKE_SOURCE_DIR}/src)
553 # Required for config.h, maybe should only be set in src/CMakeLists.txt
554 include_directories(${CMAKE_BINARY_DIR}/src)
555 # Required for gmx_header_config_gen.h to be found before installation
556 include_directories(${CMAKE_BINARY_DIR}/src/gromacs/utility)
557 # Required for now to make old code compile
558 include_directories(${CMAKE_SOURCE_DIR}/src/gromacs/legacyheaders)
559
560 include(gmxTestInlineASM)
561 gmx_test_inline_asm_gcc_x86(GMX_X86_GCC_INLINE_ASM)
562
563 include(gmxSetBuildInformation)
564 gmx_set_build_information()
565 # Turn on RDTSCP if:
566 # - the build system's CPU supports it
567 # - the acceleration is set to AVX as all AVX-capable CPUs support AVX (which
568 #   at this point means that the user set it).
569 # Note: it's better to not use the later set value of GMX_SIMD because
570 # it reflects the system's capability of both compiling and running AVX code.
571 # TODO: After merge with 5.0 one could implement a cache variable dependency
572 # such that GMX_USE_RDTSCP can change if GMX_CPU_ACCELERATION is changed to AVX
573 # after the first cmake pass.
574 if (BUILD_CPU_FEATURES MATCHES "rdtscp" OR GMX_SIMD MATCHES "AVX")
575     set(GMX_USE_RDTSCP_DEFAULT_VALUE ON)
576 else()
577     set(GMX_USE_RDTSCP_DEFAULT_VALUE OFF)
578 endif()
579 option(GMX_USE_RDTSCP "Use RDTSCP for better CPU-based timers (available on recent x86 CPUs; might need to be off when compiling for heterogeneous environments)" ${GMX_USE_RDTSCP_DEFAULT_VALUE})
580 mark_as_advanced(GMX_USE_RDTSCP)
581 if(GMX_USE_RDTSCP)
582     set(HAVE_RDTSCP 1)
583 endif()
584
585 include(gmxTestFloatFormat)
586 gmx_test_float_format(GMX_FLOAT_FORMAT_IEEE754
587                       GMX_IEEE754_BIG_ENDIAN_BYTE_ORDER
588                       GMX_IEEE754_BIG_ENDIAN_WORD_ORDER)
589
590 include(gmxTestLargeFiles)
591 gmx_test_large_files(GMX_LARGEFILES)
592
593 include(gmxTestSignal)
594 gmx_test_sigusr1(HAVE_SIGUSR1)
595
596 include(gmxTestPipes)
597 gmx_test_pipes(HAVE_PIPES)
598
599 include(gmxTestIsfinite)
600 gmx_test_isfinite(HAVE_ISFINITE)
601 gmx_test__isfinite(HAVE__ISFINITE)
602 gmx_test__finite(HAVE__FINITE)
603
604 include(gmxTestCXX11)
605 gmx_test_cxx11(GMX_CXX11_SUPPORTED GMX_CXX11_FLAGS)
606 include(CMakeDependentOption)
607 # nvcc does not support C++11 flags, so with GPUs we prefer to skip C++11 flags
608 # entirely to keep the compilation environment uniform.
609 cmake_dependent_option(GMX_CXX11
610     "Use C++11 features"
611     ON "GMX_CXX11_SUPPORTED AND NOT GMX_GPU" OFF)
612 mark_as_advanced(GMX_CXX11)
613 if(GMX_CXX11)
614     set(EXTRA_CXX_FLAGS "${EXTRA_CXX_FLAGS} ${GMX_CXX11_FLAGS}")
615 endif()
616
617
618 include(gmxTestXDR)
619 gmx_test_xdr(GMX_SYSTEM_XDR)
620 if(NOT GMX_SYSTEM_XDR)
621     set(GMX_INTERNAL_XDR 1)
622 endif()
623
624
625 ##################################################
626 # Process SIMD instruction settings
627 ##################################################
628 # This checks what flags to add in order to
629 # support the SIMD instructions we need, and sets
630 # correct defines for the SIMD instructions supported.
631 include(gmxTestSimd)
632 gmx_test_simd()
633
634
635 # Process QM/MM Settings
636 if(${GMX_QMMM_PROGRAM} STREQUAL "GAUSSIAN")
637     set(GMX_QMMM_GAUSSIAN 1)
638 elseif(${GMX_QMMM_PROGRAM} STREQUAL "MOPAC")
639     set(GMX_QMMM_MOPAC 1)
640 elseif(${GMX_QMMM_PROGRAM} STREQUAL "GAMESS")
641     set(GMX_QMMM_GAMESS 1)
642 elseif(${GMX_QMMM_PROGRAM} STREQUAL "ORCA")
643     set(GMX_QMMM_ORCA 1)
644 elseif(${GMX_QMMM_PROGRAM} STREQUAL "NONE")
645     # nothing to do
646 else()
647     gmx_invalid_option_value(GMX_QMMM_PROGRAM)
648 endif()
649
650
651 ##################################################
652 # Process FFT library settings
653 ##################################################
654 include(gmxManageFFTLibraries)
655
656
657 include(gmxManageLinearAlgebraLibraries)
658
659 # Whether GROMACS will really try to compile support for VMD plugins
660 set(GMX_USE_PLUGINS OFF)
661
662 if(GMX_LOAD_PLUGINS)
663   if(CYGWIN OR NOT WIN32)
664     # Native Windows does not have, nor need dlopen
665     # Note that WIN32 is set with Cygwin, but Cygwin needs dlopen to use plug-ins
666     include(gmxTestdlopen)
667     gmx_test_dlopen(HAVE_DLOPEN)
668   endif()
669
670   # so, should we use plug-ins?
671   if((WIN32 AND NOT CYGWIN) OR (HAVE_DLOPEN AND BUILD_SHARED_LIBS))
672     if(NOT VMD_QUIETLY)
673       MESSAGE(STATUS
674           "Found the ability to use plug-ins when building shared libaries, "
675           "so will compile to use plug-ins (e.g. to read VMD-supported file "
676           "formats).")
677     endif()
678     if(NOT GMX_VMD_PLUGIN_PATH)
679       find_package(VMD)
680     endif()
681     set(GMX_USE_PLUGINS ON)
682     list(APPEND GMX_EXTRA_LIBRARIES ${CMAKE_DL_LIBS}) # magic cross-platform pre-set variable for dlopen library
683     set(PKG_DL_LIBS "-l${CMAKE_DL_LIBS}")
684   else()
685     set(PKG_DL_LIBS)
686   endif()
687 endif()
688 set(VMD_QUIETLY TRUE CACHE INTERNAL "")
689
690 # Link real-time library for POSIX timers. The check for clock_gettime
691 # confirms the linkability of rt.
692 if(HAVE_TIME_H AND HAVE_UNISTD_H AND HAVE_CLOCK_GETTIME)
693     list(APPEND GMX_EXTRA_LIBRARIES rt)
694 endif()
695
696 # Math and thread libraries must often come after all others when linking...
697 if(HAVE_LIBM)
698     list(APPEND GMX_EXTRA_LIBRARIES m)
699 endif()
700
701 option(GMX_NACL "Configure for Native Client builds" OFF)
702 if (GMX_NACL)
703   list(APPEND GMX_EXTRA_LIBRARIES nosys)
704   set(GMX_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -lnosys")
705   set(GMX_NO_NICE 1)
706   set(GMX_NO_RENAME 1)
707 endif()
708 mark_as_advanced(GMX_NACL)
709
710 if(GMX_FAHCORE)
711   set(COREWRAP_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/../corewrap" CACHE STRING
712       "Path to swindirect.h")
713   include_directories(${COREWRAP_INCLUDE_DIR})
714 endif()
715
716 option(GMX_BUILD_HELP "Build man pages, HTML help, and completions automatically (requires that compiled binaries can be executed on the build host)" OFF)
717 mark_as_advanced(GMX_BUILD_HELP)
718 if (GMX_BUILD_HELP AND SOURCE_IS_SOURCE_DISTRIBUTION AND
719     "${CMAKE_CURRENT_SOURCE_DIR}" STREQUAL "${CMAKE_CURRENT_BINARY_DIR}")
720
721     message(FATAL_ERROR
722         "Rebuilding HTML and man pages is not supported for in-source "
723         "builds from a source distribution. "
724         "Set GMX_BUILD_HELP=OFF or do an out-of-source build to proceed.")
725 endif()
726
727 # # # # # # # # # # NO MORE TESTS AFTER THIS LINE! # # # # # # # # # # #
728 # these are set after everything else
729 if (NOT GMX_SKIP_DEFAULT_CFLAGS)
730     set(CMAKE_C_FLAGS "${SIMD_C_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_C_FLAGS} ${CMAKE_C_FLAGS}")
731     set(CMAKE_CXX_FLAGS "${SIMD_CXX_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_CXX_FLAGS} ${CMAKE_CXX_FLAGS}")
732     set(CMAKE_EXE_LINKER_FLAGS "${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS} ${CMAKE_EXE_LINKER_FLAGS}")
733     set(CMAKE_SHARED_LINKER_FLAGS "${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS} ${CMAKE_SHARED_LINKER_FLAGS}")
734 else()
735     message("Recommended flags which are not added because GMX_SKIP_DEFAULT_CFLAGS=yes:")
736     message("CMAKE_C_FLAGS: ${SIMD_C_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_C_FLAGS} ${GMXC_CFLAGS}")
737     message("CMAKE_C_FLAGS_RELEASE: ${GMXC_CFLAGS_RELEASE}")
738     message("CMAKE_C_FLAGS_DEBUG: ${GMXC_CFLAGS_DEBUG}")
739     message("CMAKE_CXX_FLAGS: ${SIMD_CXX_FLAGS} ${MPI_COMPILE_FLAGS} ${EXTRA_CXX_FLAGS} ${GMXC_CXXFLAGS}")
740     message("CMAKE_CXX_FLAGS_RELEASE: ${GMXC_CXXFLAGS_RELEASE}")
741     message("CMAKE_CXX_FLAGS_DEBUG: ${GMXC_CXXFLAGS_DEBUG}")
742     message("CMAKE_EXE_LINKER_FLAGS: ${FFT_LINKER_FLAGS} ${MPI_LINKER_FLAGS}")
743     message("CMAKE_SHARED_LINKER_FLAGS: ${MPI_LINKER_FLAGS}")
744 endif()
745
746 if(NOT GMX_OPENMP)
747     #Unset all OpenMP flags in case OpenMP was disabled either by the user
748     #or because it was only partially detected (e.g. only for C but not C++ compiler)
749     unset(OpenMP_C_FLAGS CACHE)
750     unset(OpenMP_CXX_FLAGS CACHE)
751 else()
752     set(GMX_EXE_LINKER_FLAGS ${GMX_EXE_LINKER_FLAGS} ${OpenMP_LINKER_FLAGS})
753     set(GMX_SHARED_LINKER_FLAGS ${GMX_SHARED_LINKER_FLAGS} ${OpenMP_SHARED_LINKER_FLAGS})
754 endif()
755 set(PKG_CFLAGS "${PKG_CFLAGS} ${OpenMP_C_FLAGS}")
756
757 ########################################################################
758 # Specify install locations
759 ########################################################################
760 set(GMX_LIB_INSTALL_DIR lib CACHE STRING
761     "Library installation directory (default: lib)")
762 set(GMX_DATA_INSTALL_DIR gromacs CACHE STRING
763     "Data installation directory under share/ (default: gromacs)")
764 mark_as_advanced(GMX_LIB_INSTALL_DIR GMX_DATA_INSTALL_DIR)
765
766 set(LIB_INSTALL_DIR  ${GMX_INSTALL_PREFIX}${GMX_LIB_INSTALL_DIR})
767 set(BIN_INSTALL_DIR  ${GMX_INSTALL_PREFIX}bin)
768 set(DATA_INSTALL_DIR ${GMX_INSTALL_PREFIX}share/${GMX_DATA_INSTALL_DIR})
769 set(MAN_INSTALL_DIR  ${GMX_INSTALL_PREFIX}share/man)
770 set(INCL_INSTALL_DIR ${GMX_INSTALL_PREFIX}include)
771
772 set(GMXLIB_SEARCH_DIR share/${GMX_DATA_INSTALL_DIR}/top)
773 set(GMXLIB_FALLBACK   ${CMAKE_INSTALL_PREFIX}/${DATA_INSTALL_DIR}/top)
774
775 # Binary and library suffix options
776 include(gmxManageSuffixes)
777
778 ##################################################################
779 # Shared library settings
780 ##################################################################
781 if(NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin")
782     if(GMX_LIB_INSTALL_DIR STREQUAL "lib")
783         set(CMAKE_BUILD_WITH_INSTALL_RPATH TRUE)
784     endif()
785     set(CMAKE_INSTALL_RPATH "\$ORIGIN/../${GMX_LIB_INSTALL_DIR}")
786     set(CMAKE_INSTALL_RPATH_USE_LINK_PATH TRUE)
787 else()
788     if(CMAKE_SYSTEM_VERSION VERSION_GREATER 8.0) #rpath supported for >10.4
789         set(CMAKE_INSTALL_NAME_DIR "@rpath")
790         set(GMX_EXE_LINKER_FLAGS ${GMX_EXE_LINKER_FLAGS} "-Wl,-rpath,@executable_path/../${GMX_LIB_INSTALL_DIR}")
791     else()
792         set(CMAKE_INSTALL_NAME_DIR "${CMAKE_INSTALL_PREFIX}/${LIB_INSTALL_DIR}")
793     endif()
794 endif()
795
796 #COPYING file: Only necessary for binary distributions.
797 #Simpler to always install.
798 install(FILES COPYING DESTINATION ${DATA_INSTALL_DIR} COMPONENT data)
799
800 if(GMX_EXTERNAL_BOOST)
801     include_directories(${Boost_INCLUDE_DIRS})
802     set(PKG_CFLAGS "${PKG_CFLAGS} -I${Boost_INCLUDE_DIRS}")
803 else()
804     include_directories(${CMAKE_SOURCE_DIR}/src/external/boost)
805     # typeid not supported for minimal internal version
806     # (would add significant amount of code)
807     add_definitions(-DBOOST_NO_TYPEID)
808     # TODO: Propagate the above settings to the installed CMakeFiles.txt template
809     # (from share/template/)
810     set(PKG_CFLAGS "${PKG_CFLAGS} -DBOOST_NO_TYPEID -I${CMAKE_INSTALL_PREFIX}/${INCL_INSTALL_DIR}/gromacs/external/boost")
811     if (NOT GMX_BUILD_MDRUN_ONLY)
812         install(DIRECTORY ${CMAKE_SOURCE_DIR}/src/external/boost/boost
813                 DESTINATION ${INCL_INSTALL_DIR}/gromacs/external/boost
814                 COMPONENT development)
815     endif()
816 endif()
817
818 if(GMX_USE_TNG)
819     find_package(ZLIB QUIET)
820     include(gmxTestZLib)
821     gmx_test_zlib(HAVE_ZLIB)
822     set(TNG_BUILD_WITH_ZLIB ${HAVE_ZLIB} CACHE BOOL  "Build TNG with zlib compression")
823     set(TNG_BUILD_FORTRAN OFF CACHE BOOL "Build Fortran compatible TNG library and examples for testing")
824     set(TNG_BUILD_EXAMPLES OFF CACHE BOOL "Build examples showing usage of the TNG API")
825     set(TNG_BUILD_COMPRESSION_TESTS OFF CACHE BOOL "Build tests of the TNG compression library")
826     set(TNG_BUILD_DOCUMENTATION OFF CACHE BOOL "Use Doxygen to create the HTML based TNG API documentation")
827     set(TNG_BUILD_TEST OFF CACHE BOOL "Build TNG testing binary.")
828     add_subdirectory(${CMAKE_SOURCE_DIR}/src/external/tng_io)
829     set(GMX_TNG_LIBRARIES tng_io)
830 endif()
831 mark_as_advanced(TNG_BUILD_FORTRAN)
832 mark_as_advanced(TNG_BUILD_EXAMPLES)
833 mark_as_advanced(TNG_BUILD_COMPRESSION_TESTS)
834 mark_as_advanced(TNG_BUILD_DOCUMENTATION)
835 mark_as_advanced(TNG_BUILD_TEST)
836 mark_as_advanced(TNG_EXAMPLE_FILES_DIR)
837
838 if (GMX_BUILD_FOR_COVERAGE)
839     # Code heavy with asserts makes conditional coverage close to useless metric,
840     # as by design most of the false branches are impossible to trigger in
841     # correctly functioning code.  And the benefit of testing those that could
842     # be triggered by using an API against its specification isn't usually
843     # worth the effort.
844     add_definitions(-DNDEBUG -DBOOST_DISABLE_ASSERTS -DGMX_DISABLE_ASSERTS)
845 endif()
846
847 if (BUILD_TESTING)
848     # "tests" target builds all the separate test binaries.
849     add_custom_target(tests)
850     # "run-ctest" is an internal target that actually runs the tests.
851     # This is necessary to be able to add separate targets that execute as part
852     # of 'make check', but are ensured to be executed after the actual tests.
853     add_custom_target(run-ctest
854                       COMMAND ${CMAKE_CTEST_COMMAND} --output-on-failure
855                       COMMENT "Running all tests"
856                       VERBATIM)
857     add_dependencies(run-ctest tests)
858     # "check" target builds and runs all tests.
859     add_custom_target(check DEPENDS run-ctest)
860 endif()
861
862 if (NOT GMX_BUILD_MDRUN_ONLY)
863     add_subdirectory(doxygen)
864     add_subdirectory(share)
865     add_subdirectory(scripts)
866 endif()
867 add_subdirectory(src)
868
869 if (BUILD_TESTING)
870     add_subdirectory(tests)
871 endif()
872
873 # Issue a warning if NVIDIA GPUs were detected, but CUDA was not found.
874 # Don't bother the user after the first configure pass.
875 if ((CUDA_NOTFOUND_AUTO AND GMX_DETECT_GPU_AVAILABLE) AND NOT GMX_GPU_DETECTION_DONE)
876     message(WARNING "${CUDA_NOTFOUND_MESSAGE}")
877 endif()
878 set(GMX_GPU_DETECTION_DONE TRUE CACHE INTERNAL "Whether GPU detection has already been done")
879
880 #######################
881 ## uninstall target
882 #######################
883     CONFIGURE_FILE(
884                    "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake_uninstall.cmake.in"
885                    "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake"
886                    IMMEDIATE @ONLY)
887 ###########################
888 ADD_CUSTOM_TARGET(uninstall
889                   "${CMAKE_COMMAND}" -P
890                   "${CMAKE_CURRENT_BINARY_DIR}/cmake/cmake_uninstall.cmake")
891 ###########################
892
893 ########################################################################
894 # Manual                                                               #
895 ########################################################################
896
897 option(GMX_BUILD_MANUAL "Whether to try to configure to build the PDF manual" OFF)
898 mark_as_advanced(GMX_BUILD_MANUAL)
899 if(GMX_BUILD_MANUAL)
900     # Make sure we only do detection of manual-building dependencies
901     # when the user opted in for that.
902     add_subdirectory(manual)
903 endif()