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 # Test C flags FLAGS, and set VARIABLE to true if the work. Also add the
37 MACRO(GMX_TEST_CFLAG VARIABLE FLAGS CFLAGSVAR)
38 IF(NOT DEFINED ${VARIABLE})
39 CHECK_C_COMPILER_FLAG("${FLAGS}" ${VARIABLE})
42 list(APPEND ${CFLAGSVAR} "${FLAGS}")
44 ENDMACRO(GMX_TEST_CFLAG VARIABLE FLAGS CFLAGSVAR)
46 # Test C++ flags FLAGS, and set VARIABLE to true if the work. Also add the
47 # flags to CXXFLAGSVAR.
48 MACRO(GMX_TEST_CXXFLAG VARIABLE FLAGS CXXFLAGSVAR)
49 IF(NOT DEFINED ${VARIABLE})
50 CHECK_CXX_COMPILER_FLAG("${FLAGS}" ${VARIABLE})
53 list(APPEND ${CXXFLAGSVAR} "${FLAGS}")
55 ENDMACRO(GMX_TEST_CXXFLAG VARIABLE FLAGS CXXFLAGSVAR)
57 # Set the real CMake variables for compiler flags. This should be a function
58 # so we can have proper local variables while avoiding duplicating code.
59 function(gmx_set_cmake_compiler_flags)
60 foreach(language C CXX)
61 # Copy the flags for the release build type to the build types
62 # that are modified forms of it. Ideally, the list of build
63 # types that are modifications of the Release build type would
64 # be set up elsewhere and passed to this function, but it is
65 # inconvenient in CMake to pass more than one list, and such a
66 # list is only used here.
67 foreach(build_type RELWITHDEBINFO RELWITHASSERT MINSIZEREL PROFILE)
68 set(GMXC_${language}FLAGS_${build_type} "${GMXC_${language}FLAGS_RELEASE}" "${GMXC_${language}FLAGS_${build_type}}")
70 # Copy the flags that are only used by the real Release build
71 # type. Used for, e.g., -Wno-array-bounds in Release to work around
72 # gcc-4.8 being a little too vocal about some perfectly good code,
73 # while using RelWithAssert (ie. without that suppression) in Jenkins.
75 # TODO check the behaviour of more recent gcc on the improved code
76 set(GMXC_${language}FLAGS_RELEASE "${GMXC_${language}FLAGS_RELEASE}" "${GMXC_${language}FLAGS_RELEASE_ONLY}")
80 # Add compiler flags expected for all GROMACS build configurations,
81 # and those expected for the current CMake build type (e.g. Release)
84 # Most targets (ie. libraries, executables) need compiler flags that
85 # are characteristic of the build configuration. This function
86 # provides a central point for adding such flags. This approach is
87 # more flexible than e.g. setting CMAKE_CXX_FLAGS globally, because
88 # that setting will apply globally, which means it applies also to
89 # "external" code that the build of GROMACS might also build.
90 function(gmx_target_compile_options TARGET)
91 if (NOT GMX_SKIP_DEFAULT_CFLAGS)
92 target_compile_options(${TARGET}
94 $<$<COMPILE_LANGUAGE:C>:${SIMD_C_FLAGS};${MPI_COMPILE_FLAGS};${EXTRA_C_FLAGS};${GMXC_CFLAGS}>
95 $<$<COMPILE_LANGUAGE:CXX>:${SIMD_CXX_FLAGS};${MPI_COMPILE_FLAGS};${EXTRA_CXX_FLAGS};${GMXC_CXXFLAGS}>
97 foreach(build_type ${build_types_with_explicit_flags})
98 target_compile_options(${TARGET}
100 $<$<AND:$<COMPILE_LANGUAGE:C>,$<CONFIG:${build_type}>>:${GMXC_CFLAGS_${build_type}}>
101 $<$<AND:$<COMPILE_LANGUAGE:CXX>,$<CONFIG:${build_type}>>:${GMXC_CXXFLAGS_${build_type}}>
107 # Add the WARNING_FLAG to the compile options for TARGET if the
108 # compiler supports that flag. VARNAME is used to cache the result of
109 # the check whether the compiler supports that flag, as multiple
110 # targets may use the same suppression.
112 # This is generally used to suppress warnings judged not worth fixing
113 # in code external to, or generated by, GROMACS.
114 function(gmx_target_warning_suppression TARGET WARNING_FLAG VARNAME)
115 check_cxx_compiler_flag(${WARNING_FLAG} ${VARNAME})
117 target_compile_options(${TARGET} PRIVATE $<$<COMPILE_LANGUAGE:CXX>:${WARNING_FLAG}>)
121 # This is the actual exported function to be called
124 include(CheckCCompilerFlag)
125 include(CheckCXXCompilerFlag)
128 if(CMAKE_COMPILER_IS_GNUCC)
129 #flags are added in reverse order and -Wno* need to appear after -Wall
131 GMX_TEST_CFLAG(CFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CFLAGS)
133 if (GMX_COMPILER_WARNINGS)
134 GMX_TEST_CFLAG(CFLAGS_WARN "-Wall;-Wno-unused;-Wunused-value;-Wunused-parameter" GMXC_CFLAGS)
135 GMX_TEST_CFLAG(CFLAGS_WARN_EXTRA "-Wextra;-Wno-missing-field-initializers;-Wno-sign-compare;-Wpointer-arith" GMXC_CFLAGS)
136 GMX_TEST_CFLAG(CFLAGS_WARN_UNDEF "-Wundef" GMXC_CFLAGS)
137 GMX_TEST_CFLAG(CFLAGS_WARN_REL "-Wno-array-bounds" GMXC_CFLAGS_RELEASE_ONLY)
139 GMX_TEST_CFLAG(CFLAGS_WARN_SUBSCRIPT "-Wno-char-subscripts" GMXC_CFLAGS)
141 GMX_TEST_CFLAG(CFLAGS_STRINGOP_TRUNCATION "-Werror=stringop-truncation" GMXC_CFLAGS)
144 GMX_TEST_CFLAG(CFLAGS_EXCESS_PREC "-fexcess-precision=fast" GMXC_CFLAGS_RELEASE)
145 GMX_TEST_CFLAG(CFLAGS_COPT "-funroll-all-loops"
147 GMX_TEST_CFLAG(CFLAGS_NOINLINE "-fno-inline" GMXC_CFLAGS_DEBUG)
150 if(CMAKE_COMPILER_IS_GNUCXX)
152 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CXXFLAGS)
154 if (GMX_COMPILER_WARNINGS)
155 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-Wall" GMXC_CXXFLAGS)
156 # Problematic with CUDA
157 # GMX_TEST_CXXFLAG(CXXFLAGS_WARN_EFFCXX "-Wnon-virtual-dtor" GMXC_CXXFLAGS)
158 GMX_TEST_CXXFLAG(CXXFLAGS_WARN_EXTRA "-Wextra;-Wno-missing-field-initializers;-Wpointer-arith;-Wmissing-declarations" GMXC_CXXFLAGS)
159 # CUDA versions prior to 7.5 come with a header (math_functions.h) which uses the _MSC_VER macro
160 # unconditionally, so we don't use -Wundef for earlier CUDA versions.
161 if(NOT(GMX_GPU AND CUDA_VERSION VERSION_LESS "7.5"))
162 GMX_TEST_CXXFLAG(CXXFLAGS_WARN_UNDEF "-Wundef" GMXC_CXXFLAGS)
164 GMX_TEST_CFLAG(CXXFLAGS_WARN_REL "-Wno-array-bounds" GMXC_CXXFLAGS_RELEASE_ONLY)
165 GMX_TEST_CXXFLAG(CXXFLAGS_STRINGOP_TRUNCATION "-Wstringop-truncation" GMXC_CXXFLAGS)
166 if (CXXFLAGS_STRINGOP_TRUNCATION)
167 set(CXXFLAGS_NO_STRINGOP_TRUNCATION "-Wno-stringop-truncation")
171 GMX_TEST_CXXFLAG(CXXFLAGS_EXCESS_PREC "-fexcess-precision=fast" GMXC_CXXFLAGS_RELEASE)
172 GMX_TEST_CXXFLAG(CXXFLAGS_COPT "-funroll-all-loops"
173 GMXC_CXXFLAGS_RELEASE)
174 GMX_TEST_CXXFLAG(CXXFLAGS_NOINLINE "-fno-inline" GMXC_CXXFLAGS_DEBUG)
178 if (CMAKE_C_COMPILER_ID MATCHES "Intel")
181 # 3180: unrecognized OpenMP #pragma
182 GMX_TEST_CFLAG(CFLAGS_PRAGMA "-wd3180" GMXC_CFLAGS)
184 if (GMX_COMPILER_WARNINGS)
185 # -w3 enables a lot of useful diagnostics but we don't care about all. -wd disables some selectively.
186 # 177: function/variable ".." was declared but never referenced
187 # 411: class defines no constructor to initialize the following (incorrect for struct, initializer list works)
188 # 593: variable ".." was set but never used
189 # 981: operands are evaluated in unspecified order
190 #1418: external function definition with no prior declaration
191 #1419: external declaration in primary source file
192 #1572: floating-point equality and inequality comparisons are unreliable
193 #1599: declaration hides variable ".."
194 #2259: non-pointer conversion from ".." to ".." may lose significant bits
195 #2415: variable ".." of static storage duration was declared but never referenced
196 #2547: ".." was specified as both a system and non-system include directory
197 #2557: comparison between signed and unsigned operands
198 #3280: declaration hides member ".."
199 #11074: Inlining inhibited by limit max-size(/max-total-size)
200 #11076: To get full report use -opt-report=3 -opt-report-phase ipo (shown for previous remark)
201 GMX_TEST_CFLAG(CFLAGS_WARN "-w3;-wd177;-wd411;-wd593;-wd981;-wd1418;-wd1419;-wd1572;-wd1599;-wd2259;-wd2415;-wd2547;-wd2557;-wd3280;-wd11074;-wd11076" GMXC_CFLAGS)
203 GMX_TEST_CFLAG(CFLAGS_STDGNU "-std=gnu99" GMXC_CFLAGS)
204 GMX_TEST_CFLAG(CFLAGS_OPT "-ip;-funroll-all-loops;-alias-const;-ansi-alias;-no-prec-div;-fimf-domain-exclusion=14;-qoverride-limits" GMXC_CFLAGS_RELEASE)
205 GMX_TEST_CFLAG(CFLAGS_DEBUG "-O0" GMXC_CFLAGS_DEBUG) #icc defaults to -O2 even with -g
206 # The "except" fp-model requires something other than the
207 # default "fast" model, so we test and use it with
209 GMX_TEST_CFLAG(CFLAGS_FP_MODEL_RELASSERT "-fp-model=except;-fp-model=precise" GMXC_CFLAGS_RELWITHASSERT)
212 GMX_TEST_CFLAG(CFLAGS_PRAGMA "/wd3180" GMXC_CFLAGS)
214 if (GMX_COMPILER_WARNINGS)
216 #161: unrecognized pragma
217 #1786 function was declared deprecated (is issued for stdlib function such as strncpy which have a _s version)
218 GMX_TEST_CFLAG(CFLAGS_WARN "/W3;/wd161;/wd177;/wd411;/wd593;/wd981;/wd1418;/wd1419;/wd1572;/wd1599;/wd1786;/wd2259;/wd2415;/wd2547;/wd2557;/wd3280" GMXC_CFLAGS)
220 GMX_TEST_CFLAG(CFLAGS_OPT "/Qip" GMXC_CFLAGS_RELEASE)
224 if (CMAKE_CXX_COMPILER_ID MATCHES "Intel")
227 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-wd3180" GMXC_CXXFLAGS)
229 if (GMX_COMPILER_WARNINGS)
230 #All but the following warnings are identical for the C-compiler (see above)
231 # 304: access control not specified
232 # 383: value copied to temporary, reference to temporary used
233 # 444: destructor for base class ".." is not virtual
234 # 869: was never referenced (false positives)
235 #2282: unrecognized GCC pragma
236 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-w3;-wd177;-wd304;-wd383;-wd411;-wd444;-wd869;-wd981;-wd1418;-wd1572;-wd1599;-wd2259;-wd2547;-wd3280;-wd11074;-wd11076;-wd2282" GMXC_CXXFLAGS)
238 GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-ip;-funroll-all-loops;-alias-const;-ansi-alias;-no-prec-div;-fimf-domain-exclusion=14;-qoverride-limits" GMXC_CXXFLAGS_RELEASE)
239 GMX_TEST_CXXFLAG(CXXFLAGS_DEBUG "-O0" GMXC_CXXFLAGS_DEBUG)
240 # The "except" fp-model requires something other than the
241 # default "fast" model, so we test and use it with
243 GMX_TEST_CXXFLAG(CXXFLAGS_FP_MODEL_RELASSERT "-fp-model=except;-fp-model=precise" GMXC_CXXFLAGS_RELWITHASSERT)
246 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "/wd3180" GMXC_CFLAGS)
248 if (GMX_COMPILER_WARNINGS)
249 #161: unrecognized pragma
250 #809: exception specification for virtual function X is incompatible with that of overridden function
251 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "/W3;/wd161;/wd177;/wd304;/wd383;/wd411;/wd444;/wd809;/wd869;/wd981;/wd1418;/wd1572;/wd1599;/wd1786;/wd2259;/wd2547;/wd3280;/wd11074;/wd11076;/wd2282" GMXC_CXXFLAGS)
253 GMX_TEST_CXXFLAG(CXXFLAGS_OPT "/Qip" GMXC_CXXFLAGS_RELEASE)
258 # Inter-procedural analysis causes pgcc/pgc++ to crash when linking the library with PGI release 15.7.
259 if (CMAKE_C_COMPILER_ID MATCHES "PGI")
260 GMX_TEST_CFLAG(CFLAGS_OPT "-Mnoipa" GMXC_CFLAGS_RELEASE)
262 if (CMAKE_CXX_COMPILER_ID MATCHES "PGI")
263 # Using ipa exposes internal PGI-15.7 compiler bugs at compile time
264 GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-Mnoipa" GMXC_CXXFLAGS_RELEASE)
265 # PGI identifies itself as GCC, but does not understand the GCC
266 # pragmas that occur in parser.cpp. Since that file is generated
267 # we cannot add a define there, but supress the warning instead.
268 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "--diag_suppress=1675" GMXC_CXXFLAGS)
272 if (CMAKE_C_COMPILER_ID MATCHES "PathScale")
274 GMX_TEST_CFLAG(CFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CFLAGS)
276 if (GMX_COMPILER_WARNINGS)
277 GMX_TEST_CFLAG(CFLAGS_WARN "-Wall;-Wno-unused;-Wunused-value" GMXC_CFLAGS)
279 GMX_TEST_CFLAG(CFLAGS_OPT "-OPT:Ofast;-fno-math-errno;-ffast-math"
281 GMX_TEST_CFLAG(CFLAGS_LANG "-std=gnu99" GMXC_CFLAGS)
283 if (CMAKE_CXX_COMPILER_ID MATCHES "PathScale")
285 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CXXFLAGS)
287 if (GMX_COMPILER_WARNINGS)
288 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-Wall;-Wno-unused;-Wunused-value" GMXC_CXXFLAGS)
290 GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-OPT:Ofast;-fno-math-errno;-ffast-math"
291 GMXC_CXXFLAGS_RELEASE)
295 # The suppressions below stop
296 # 1500-036: (I) about -O3 causing non-strict IEEE compliance that changes the semantics of the program (duh)
297 # 1500-010: (W) about correct PBC-related use of maximum array indices of DIM-sized C arrays
298 # 1500-030: (I) Additional optimization may be attained by recompiling and specifying MAXMEM option with a value greater than 8192.
299 if (CMAKE_C_COMPILER_ID MATCHES "XL")
300 GMX_TEST_CFLAG(CFLAGS_ARCH "-qarch=auto;-qtune=auto" GMXC_CFLAGS)
301 GMX_TEST_CFLAG(CFLAGS_OPT "-O3" GMXC_CFLAGS_RELEASE)
302 GMX_TEST_CFLAG(CFLAGS_LANG "-qlanglvl=extc99" GMXC_CFLAGS)
303 GMX_TEST_CFLAG(CFLAGS_LANG "-qsuppress=1500-036;-qsuppress=1500-010;-qsuppress=1500-030" GMXC_CFLAGS)
305 if (CMAKE_CXX_COMPILER_ID MATCHES "XL")
306 GMX_TEST_CXXFLAG(CXXFLAGS_ARCH "-qarch=auto;-qtune=auto" GMXC_CXXFLAGS)
307 GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-O3" GMXC_CXXFLAGS_RELEASE)
308 GMX_TEST_CXXFLAG(CXXFLAGS_LANG "-qsuppress=1500-036;-qsuppress=1500-010;-qsuppress=1500-030" GMXC_CXXFLAGS)
313 # disable warnings for:
314 # forcing value to bool
315 # "this" in initializer list
316 # deprecated (posix, secure) functions
317 # C4305: truncation (double -> float)
318 # C4244: conversion from 'double' to 'real', possible loss of data
319 # unreferenced local variable (only C)
320 # C4267: conversion from 'size_t' to 'int', possible loss of data
321 # conversion from 'const char*' to 'void*', different 'const' qualifiers (only C)
322 # unknown pragma (4068)
323 if(NOT CMAKE_CONFIGURATION_TYPES)
324 GMX_TEST_CFLAG(CFLAGS_WARN "/wd4800;/wd4355;/wd4996;/wd4305;/wd4244;/wd4101;/wd4267;/wd4090;/wd4068" GMXC_CFLAGS)
325 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "/wd4800;/wd4355;/wd4996;/wd4305;/wd4244;/wd4267;/wd4068" GMXC_CXXFLAGS)
326 else() # MSVC projects only use the C++ flags
327 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "/wd4800;/wd4355;/wd4996;/wd4305;/wd4244;/wd4101;/wd4267;/wd4090;/wd4068" GMXC_CXXFLAGS)
331 if (CMAKE_C_COMPILER_ID MATCHES "Clang")
333 GMX_TEST_CFLAG(CFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CFLAGS)
335 if (GMX_COMPILER_WARNINGS)
336 GMX_TEST_CFLAG(CFLAGS_WARN "-Wall;-Wno-unused;-Wunused-value;-Wunused-parameter" GMXC_CFLAGS)
337 GMX_TEST_CFLAG(CFLAGS_WARN_EXTRA "-Wpointer-arith" GMXC_CFLAGS_EXTRA)
341 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
342 if (GMX_COMPILER_WARNINGS)
343 # If used, -Wall should precede other options that silence warnings it enables
344 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-Wall" GMXC_CXXFLAGS)
345 if(CMAKE_CXX_COMPILER_VERSION VERSION_LESS "6.0") #LLVM BUG #21629
346 GMX_TEST_CXXFLAG(CXXFLAGS_WARN_NO_BRACES "-Wno-missing-braces" GMXC_CXXFLAGS)
348 GMX_TEST_CXXFLAG(CXXFLAGS_WARN_EXTRA "-Wextra;-Wno-missing-field-initializers;-Wpointer-arith;-Wmissing-prototypes" GMXC_CXXFLAGS)
349 GMX_TEST_CXXFLAG(CXXFLAGS_DEPRECATED "-Wdeprecated" GMXC_CXXFLAGS)
352 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CXXFLAGS)
356 # Fujitsu compilers on PrimeHPC/Sparc64
357 if(${CMAKE_C_COMPILER_ID} MATCHES Fujitsu OR
358 (${CMAKE_C_COMPILER_ID} MATCHES unknown AND ${CMAKE_C_COMPILER} MATCHES ^fcc))
359 GMX_TEST_CFLAG(CFLAG_GNUCOMPAT "-Xg;-w" GMXC_CFLAGS)
360 GMX_TEST_CFLAG(CFLAG_OPT "-Kfast,reduction,swp,simd=2,uxsimd,fsimple;-x100" GMXC_CFLAGS)
363 if(${CMAKE_CXX_COMPILER_ID} MATCHES Fujitsu OR
364 (${CMAKE_CXX_COMPILER_ID} MATCHES unknown AND ${CMAKE_CXX_COMPILER} MATCHES ^FCC))
365 GMX_TEST_CXXFLAG(CXXFLAG_GNUCOMPAT "-Xg;-w" GMXC_CXXFLAGS)
366 GMX_TEST_CXXFLAG(CXXFLAG_OPT "-Kfast,reduction,swp,simd=2,uxsimd,fsimple;-x100" GMXC_CXXFLAGS)
369 # now actually set the flags:
370 if (NOT GMX_SKIP_DEFAULT_CFLAGS)
371 gmx_set_cmake_compiler_flags()