Convert manual from LaTeX to Markup
[gromacs.git] / cmake / gmxCFlags.cmake
blobbfe3146c56653e461113aad27ce97db590ab32b5
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2009,2010,2011,2012,2013,2014,2015,2016,2017, 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
36 # flags to CFLAGSVAR.
37 MACRO(GMX_TEST_CFLAG VARIABLE FLAGS CFLAGSVAR)
38     IF(NOT DEFINED ${VARIABLE})
39         CHECK_C_COMPILER_FLAG("${FLAGS}" ${VARIABLE})
40     ENDIF()
41     IF (${VARIABLE})
42         SET (${CFLAGSVAR} "${FLAGS} ${${CFLAGSVAR}}")
43     ENDIF ()
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})
51     ENDIF()
52     IF (${VARIABLE})
53         SET (${CXXFLAGSVAR} "${FLAGS} ${${CXXFLAGSVAR}}")
54     ENDIF ()
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}}")
69         endforeach()
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.
74         set(GMXC_${language}FLAGS_RELEASE "${GMXC_${language}FLAGS_RELEASE} ${GMXC_${language}FLAGS_RELEASE_ONLY}")
76         # Modify the real CMake variables for compiler flags for all
77         # builds and language types, and also those common to all
78         # build types.
79         foreach(build_type "" ${build_types_with_explicit_flags})
80             if("${build_type}" STREQUAL "")
81                 set(punctuation "") # for general compiler flags (e.g.) CMAKE_CXX_FLAGS
82             else()
83                 set(punctuation "_") # for build-type-specific compiler flags (e.g.) CMAKE_CXX_FLAGS_RELEASE
84             endif()
86             # Append to the variables for the given build type for
87             # each language, in the parent scope. We add our new variables at the end, so
88             # compiler-specific choices are more likely to override default CMake choices.
89             # This is for instance useful for RelWithDebInfo builds, where we want to use the full
90             # set of our optimization flags detected in this file, rather than having -O2 override them.
91             set(CMAKE_${language}_FLAGS${punctuation}${build_type}
92                 "${CMAKE_${language}_FLAGS${punctuation}${build_type}} ${GMXC_${language}FLAGS${punctuation}${build_type}}"
93                 PARENT_SCOPE)
94         endforeach()
95     endforeach()
96 endfunction()
98 # This is the actual exported function to be called
99 macro (gmx_c_flags)
101     include(CheckCCompilerFlag)
102     include(CheckCXXCompilerFlag)
104     # gcc
105     if(CMAKE_COMPILER_IS_GNUCC)
106         #flags are added in reverse order and -Wno* need to appear after -Wall
107         if(NOT GMX_OPENMP)
108             GMX_TEST_CFLAG(CFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CFLAGS)
109         endif()
110         if (GMX_COMPILER_WARNINGS)
111             GMX_TEST_CFLAG(CFLAGS_WARN "-Wall -Wno-unused -Wunused-value -Wunused-parameter" GMXC_CFLAGS)
112             GMX_TEST_CFLAG(CFLAGS_WARN_EXTRA "-Wextra -Wno-missing-field-initializers -Wno-sign-compare -Wpointer-arith" GMXC_CFLAGS)
113             GMX_TEST_CFLAG(CFLAGS_WARN_UNDEF "-Wundef" GMXC_CFLAGS)
114             # Since 4.8 on by default. For previous version disabling is a no-op. Only disabling for Release because with assert
115             # the warnings are OK.
116             GMX_TEST_CFLAG(CFLAGS_WARN_REL "-Wno-array-bounds" GMXC_CFLAGS_RELEASE_ONLY)
117             if(CYGWIN)
118                 GMX_TEST_CFLAG(CFLAGS_WARN_SUBSCRIPT "-Wno-char-subscripts" GMXC_CFLAGS)
119             endif()
120         endif()
121         # new in gcc 4.5
122         GMX_TEST_CFLAG(CFLAGS_EXCESS_PREC "-fexcess-precision=fast" GMXC_CFLAGS_RELEASE)
123         GMX_TEST_CFLAG(CFLAGS_COPT "-funroll-all-loops"
124                        GMXC_CFLAGS_RELEASE)
125         GMX_TEST_CFLAG(CFLAGS_NOINLINE "-fno-inline" GMXC_CFLAGS_DEBUG)
126     endif()
127     # g++
128     if(CMAKE_COMPILER_IS_GNUCXX)
129         if(NOT GMX_OPENMP)
130             GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CXXFLAGS)
131         endif()
132         if (GMX_COMPILER_WARNINGS)
133             GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-Wall" GMXC_CXXFLAGS)
134             # Problematic with CUDA
135             # GMX_TEST_CXXFLAG(CXXFLAGS_WARN_EFFCXX "-Wnon-virtual-dtor" GMXC_CXXFLAGS)
136             GMX_TEST_CXXFLAG(CXXFLAGS_WARN_EXTRA "-Wextra -Wno-missing-field-initializers -Wpointer-arith -Wmissing-declarations" GMXC_CXXFLAGS)
137             # CUDA versions prior to 7.5 come with a header (math_functions.h) which uses the _MSC_VER macro
138             # unconditionally, so we don't use -Wundef for earlier CUDA versions.
139             if(NOT(GMX_GPU AND CUDA_VERSION VERSION_LESS "7.5"))
140                 GMX_TEST_CXXFLAG(CXXFLAGS_WARN_UNDEF "-Wundef" GMXC_CXXFLAGS)
141             endif()
142             GMX_TEST_CFLAG(CXXFLAGS_WARN_REL "-Wno-array-bounds" GMXC_CXXFLAGS_RELEASE_ONLY)
143         endif()
144         # new in gcc 4.5
145         GMX_TEST_CXXFLAG(CXXFLAGS_EXCESS_PREC "-fexcess-precision=fast" GMXC_CXXFLAGS_RELEASE)
146         GMX_TEST_CXXFLAG(CXXFLAGS_COPT "-funroll-all-loops"
147                          GMXC_CXXFLAGS_RELEASE)
148         GMX_TEST_CXXFLAG(CXXFLAGS_NOINLINE "-fno-inline" GMXC_CXXFLAGS_DEBUG)
149     endif()
151     # icc
152     if (CMAKE_C_COMPILER_ID MATCHES "Intel")
153         if (NOT WIN32)
154             if(NOT GMX_OPENMP)
155 # 3180: unrecognized OpenMP #pragma
156                 GMX_TEST_CFLAG(CFLAGS_PRAGMA "-wd3180" GMXC_CFLAGS)
157             endif()
158             if (GMX_COMPILER_WARNINGS)
159 # -w3 enables a lot of useful diagnostics but we don't care about all. -wd disables some selectively.
160 # 177: function/variable ".." was declared but never referenced
161 # 411: class defines no constructor to initialize the following (incorrect for struct, initializer list works)
162 # 593: variable ".." was set but never used
163 # 981: operands are evaluated in unspecified order
164 #1418: external function definition with no prior declaration
165 #1419: external declaration in primary source file
166 #1572: floating-point equality and inequality comparisons are unreliable
167 #1599: declaration hides variable ".."
168 #2259: non-pointer conversion from ".." to ".." may lose significant bits
169 #2415: variable ".." of static storage duration was declared but never referenced
170 #2547: ".." was specified as both a system and non-system include directory
171 #2557: comparison between signed and unsigned operands
172 #3280: declaration hides member ".."
173 #11074: Inlining inhibited by limit max-size(/max-total-size)
174 #11076: To get full report use -opt-report=3 -opt-report-phase ipo (shown for previous remark)
175                 GMX_TEST_CFLAG(CFLAGS_WARN "-w3 -wd177 -wd411 -wd593 -wd981 -wd1418 -wd1419 -wd1572 -wd1599 -wd2259 -wd2415 -wd2547 -wd2557 -wd3280 -wd11074 -wd11076" GMXC_CFLAGS)
176             endif()
177             GMX_TEST_CFLAG(CFLAGS_STDGNU "-std=gnu99" GMXC_CFLAGS)
178             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)
179             GMX_TEST_CFLAG(CFLAGS_DEBUG "-O0" GMXC_CFLAGS_DEBUG) #icc defaults to -O2 even with -g
180             GMX_TEST_CFLAG(CFLAGS_FP_RELASSERT "-fp-model except -fp-model precise" GMXC_CFLAGS_RELWITHASSERT)
181         else()
182             if(NOT GMX_OPENMP)
183                 GMX_TEST_CFLAG(CFLAGS_PRAGMA "/wd3180" GMXC_CFLAGS)
184             endif()
185             if (GMX_COMPILER_WARNINGS)
186 GMX_TEST_CFLAG(CFLAGS_WARN "/W3 /wd177 /wd411 /wd593 /wd981 /wd1418 /wd1419 /wd1572 /wd1599 /wd2259 /wd2415 /wd2547 /wd2557 /wd3280" GMXC_CFLAGS)
187             endif()
188             GMX_TEST_CFLAG(CFLAGS_OPT "/Qip" GMXC_CFLAGS_RELEASE)
189         endif()
190     endif()
192     if (CMAKE_CXX_COMPILER_ID MATCHES "Intel")
193         if (NOT WIN32) 
194             if(NOT GMX_OPENMP)
195                 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-wd3180" GMXC_CXXFLAGS)
196             endif()
197             if (GMX_COMPILER_WARNINGS)
198                 if (GMX_GPU)
199 # Suppress warnings from CUDA headers
200 # 7:   unrecognized token
201 # 82:  storage class is not first
202 # The below are also required for math_functions.h / math_functions.hpp at least until CUDA 8.0-RC
203 # 193: zero used for undefined preprocessing identifer
204 # 3346:dynamic exception specifiers are deprecated
205                     GMX_TEST_CXXFLAG(CXXFLAGS_WARN_OLD_GPU "-wd7 -wd82 -wd193 -wd3346" GMXC_CXXFLAGS)
206                 endif()
207 #All but the following warnings are identical for the C-compiler (see above)
208 # 383: value copied to temporary, reference to temporary used
209 # 444: destructor for base class ".." is not virtual
210 #2282: unrecognized GCC pragma
211                 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-w3 -wd177 -wd383 -wd411 -wd444 -wd981 -wd1418 -wd1572 -wd1599 -wd2259 -wd2547 -wd3280 -wd11074 -wd11076 -wd2282" GMXC_CXXFLAGS)
212             endif()
213             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)
214             GMX_TEST_CXXFLAG(CXXFLAGS_DEBUG "-O0" GMXC_CXXFLAGS_DEBUG)
215             GMX_TEST_CXXFLAG(CXXFLAGS_FP_RELASSERT "-fp-model except -fp-model precise" GMXC_CXXFLAGS_RELWITHASSERT)
216         else()
217             if(NOT GMX_OPENMP)
218                 GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "/wd3180" GMXC_CFLAGS)
219             endif()
220             if (GMX_COMPILER_WARNINGS)
221 #809: exception specification for virtual function X is incompatible with that of overridden function
222                 GMX_TEST_CXXFLAG(CXXFLAGS_WARN "/W3 /wd177 /wd383 /wd411 /wd444 /wd809 /wd981 /wd1418 /wd1572 /wd1599 /wd2259 /wd2547 /wd3280 /wd11074 /wd11076 /wd2282" GMXC_CXXFLAGS)
223             endif()
224             GMX_TEST_CXXFLAG(CXXFLAGS_OPT "/Qip" GMXC_CXXFLAGS_RELEASE)
225         endif()
226     endif()
228     # PGI
229     # Inter-procedural analysis causes pgcc/pgc++ to crash when linking the library with PGI release 15.7.
230     if (CMAKE_C_COMPILER_ID MATCHES "PGI")
231         GMX_TEST_CFLAG(CFLAGS_OPT "-Mnoipa" GMXC_CFLAGS_RELEASE)
232     endif()
233     if (CMAKE_CXX_COMPILER_ID MATCHES "PGI")
234         # Using ipa exposes internal PGI-15.7 compiler bugs at compile time
235         GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-Mnoipa" GMXC_CXXFLAGS_RELEASE)
236         # PGI identifies itself as GCC, but does not understand the GCC
237         # pragmas that occur in parser.cpp. Since that file is generated
238         # we cannot add a define there, but supress the warning instead.
239         GMX_TEST_CXXFLAG(CXXFLAGS_WARN "--diag_suppress=1675" GMXC_CXXFLAGS)
240     endif()
242     # Pathscale
243     if (CMAKE_C_COMPILER_ID MATCHES "PathScale")
244         if(NOT GMX_OPENMP)
245             GMX_TEST_CFLAG(CFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CFLAGS)
246         endif()
247         if (GMX_COMPILER_WARNINGS)
248             GMX_TEST_CFLAG(CFLAGS_WARN "-Wall -Wno-unused -Wunused-value" GMXC_CFLAGS)
249         endif()
250         GMX_TEST_CFLAG(CFLAGS_OPT "-OPT:Ofast -fno-math-errno -ffast-math"
251                          GMXC_CFLAGS_RELEASE)
252         GMX_TEST_CFLAG(CFLAGS_LANG "-std=gnu99" GMXC_CFLAGS)
253     endif()
254     if (CMAKE_CXX_COMPILER_ID MATCHES "PathScale")
255         if(NOT GMX_OPENMP)
256             GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CXXFLAGS)
257         endif()
258         if (GMX_COMPILER_WARNINGS)
259             GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-Wall -Wno-unused -Wunused-value" GMXC_CXXFLAGS)
260         endif()
261         GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-OPT:Ofast -fno-math-errno -ffast-math"
262                          GMXC_CXXFLAGS_RELEASE)
263     endif()
265     # xlc
266     # The suppressions below stop
267     # 1500-036: (I) about -O3 causing non-strict IEEE compliance that changes the semantics of the program (duh)
268     # 1500-010: (W) about correct PBC-related use of maximum array indices of DIM-sized C arrays
269     # 1500-030: (I) Additional optimization may be attained by recompiling and specifying MAXMEM option with a value greater than 8192.
270     if (CMAKE_C_COMPILER_ID MATCHES "XL")
271         GMX_TEST_CFLAG(CFLAGS_ARCH "-qarch=auto -qtune=auto" GMXC_CFLAGS)
272         GMX_TEST_CFLAG(CFLAGS_OPT  "-O3" GMXC_CFLAGS_RELEASE)
273         GMX_TEST_CFLAG(CFLAGS_LANG "-qlanglvl=extc99" GMXC_CFLAGS)
274         GMX_TEST_CFLAG(CFLAGS_LANG "-qsuppress=1500-036 -qsuppress=1500-010 -qsuppress=1500-030" GMXC_CFLAGS)
275     endif()
276     if (CMAKE_CXX_COMPILER_ID MATCHES "XL")
277         GMX_TEST_CXXFLAG(CXXFLAGS_ARCH "-qarch=auto -qtune=auto" GMXC_CXXFLAGS)
278         GMX_TEST_CXXFLAG(CXXFLAGS_OPT "-O3" GMXC_CXXFLAGS_RELEASE)
279         GMX_TEST_CXXFLAG(CXXFLAGS_LANG "-qsuppress=1500-036 -qsuppress=1500-010 -qsuppress=1500-030" GMXC_CXXFLAGS)
280     endif()
282     # msvc
283     if (MSVC)
284         # disable warnings for: 
285         #      forcing value to bool
286         #      "this" in initializer list
287         #      deprecated (posix, secure) functions
288         #      truncation (double -> float)
289         #      conversion from 'double' to 'real', possible loss of data
290         #      unreferenced local variable (only C)
291         #      conversion from 'size_t' to 'int', possible loss of data
292         #      conversion from 'const char*' to 'void*', different 'const' qualifiers (only C)
293         if(NOT CMAKE_CONFIGURATION_TYPES)
294             GMX_TEST_CFLAG(CFLAGS_WARN "/wd4800 /wd4355 /wd4996 /wd4305 /wd4244 /wd4101 /wd4267 /wd4090" GMXC_CFLAGS)
295             GMX_TEST_CXXFLAG(CXXFLAGS_WARN "/wd4800 /wd4355 /wd4996 /wd4305 /wd4244 /wd4267" GMXC_CXXFLAGS)
296         else() #Projects only use the C++ flags
297             GMX_TEST_CXXFLAG(CXXFLAGS_WARN "/wd4800 /wd4355 /wd4996 /wd4305 /wd4244 /wd4101 /wd4267 /wd4090" GMXC_CXXFLAGS)
298         endif()
299     endif()
301     if (CMAKE_C_COMPILER_ID MATCHES "Clang")
302         if(NOT GMX_OPENMP)
303             GMX_TEST_CFLAG(CFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CFLAGS)
304         endif()
305         if (GMX_COMPILER_WARNINGS)
306             GMX_TEST_CFLAG(CFLAGS_WARN "-Wall -Wno-unused -Wunused-value -Wunused-parameter" GMXC_CFLAGS)
307             GMX_TEST_CFLAG(CFLAGS_WARN_EXTRA "-Wpointer-arith" GMXC_CFLAGS_EXTRA)
308         endif()
309     endif()
311     if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
312         if(NOT GMX_OPENMP)
313             GMX_TEST_CXXFLAG(CXXFLAGS_PRAGMA "-Wno-unknown-pragmas" GMXC_CXXFLAGS)
314         endif()
315         if (GMX_COMPILER_WARNINGS)
316             GMX_TEST_CXXFLAG(CXXFLAGS_WARN "-Wall" GMXC_CXXFLAGS)
317             GMX_TEST_CXXFLAG(CXXFLAGS_WARN_EXTRA "-Wextra -Wno-missing-field-initializers -Wpointer-arith -Wmissing-prototypes" GMXC_CXXFLAGS)
318             GMX_TEST_CXXFLAG(CXXFLAGS_DEPRECATED "-Wdeprecated" GMXC_CXXFLAGS)
319         endif()
320     endif()
322     # Fujitsu compilers on PrimeHPC/Sparc64
323     if(${CMAKE_C_COMPILER_ID} MATCHES Fujitsu OR
324        (${CMAKE_C_COMPILER_ID} MATCHES unknown AND ${CMAKE_C_COMPILER} MATCHES ^fcc))
325         GMX_TEST_CFLAG(CFLAG_GNUCOMPAT "-Xg -w" GMXC_CFLAGS)
326         GMX_TEST_CFLAG(CFLAG_OPT "-Kfast,reduction,swp,simd=2,uxsimd,fsimple -x100" GMXC_CFLAGS)
327     endif()
329     if(${CMAKE_CXX_COMPILER_ID} MATCHES Fujitsu OR
330        (${CMAKE_CXX_COMPILER_ID} MATCHES unknown AND ${CMAKE_CXX_COMPILER} MATCHES ^FCC))
331         GMX_TEST_CXXFLAG(CXXFLAG_GNUCOMPAT "-Xg -w" GMXC_CXXFLAGS)
332         GMX_TEST_CXXFLAG(CXXFLAG_OPT "-Kfast,reduction,swp,simd=2,uxsimd,fsimple -x100" GMXC_CXXFLAGS)
333     endif()
335     # now actually set the flags:
336     if (NOT GMX_SKIP_DEFAULT_CFLAGS)
337         gmx_set_cmake_compiler_flags()
338     endif()
340 endmacro()