MSD tests for the -mol option.
[gromacs.git] / cmake / gmxManageSimd.cmake
blob4bfbe799c7d53da3672d1813afcb2ef2782d0ffc
2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2012,2013,2014,2015,2016,2017,2018, 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 include(gmxDetectCpu)
36 include(gmxSimdFlags)
38 # Issue a fatal error with an appropriate message, when the toolchain
39 # was not able to compile code for SIMD support.
41 # Inputs:
42 #  SIMD_STRING              A string describing the kind of SIMD support that didn't work.
43 #  ALTERNATIVE_SUGGESTION   A string describing anything the user could try other than getting a new compiler.
44 #  SUGGEST_BINUTILS_UPDATE  True when there's information that the compiler was OK, but something else was not.
45 function(gmx_give_fatal_error_when_simd_support_not_found SIMD_STRING ALTERNATIVE_SUGGESTION SUGGEST_BINUTILS_UPDATE)
46     if(SUGGEST_BINUTILS_UPDATE)
47         set(_msg "Found a compiler flag for ${SIMD_STRING} support, but some other problem exists. Update your assembler and/or linker, e.g. in the binutils package of your distribution.")
48     else()
49         set(_msg "Cannot find ${SIMD_STRING} compiler flag. Use a newer compiler, or ${ALTERNATIVE_SUGGESTION}.")
50     endif()
51     message(FATAL_ERROR ${_msg})
52 endfunction()
54 macro(gmx_manage_simd)
56 set(GMX_SIMD_ACCURACY_BITS_SINGLE 22 CACHE STRING "Target mantissa bits for SIMD single math")
58 # Note that we typically restrict double precision target accuracy to be twice that
59 # of single. This means we only need one more N-R iteration for 1/sqrt(x) and 1(x),
60 # and the first iteration can sometimes be done as a pair in single precision. This should
61 # be plenty enough for Molecular Dynamics applications. Many of our double precision math
62 # functions still achieve very close to full double precision, but we do not guarantee that
63 # they will be able to achieve higher accuracy if you set this beyond 44 bits. GROMACS will
64 # work - but some unit tests might fail.
66 set(GMX_SIMD_ACCURACY_BITS_DOUBLE 44 CACHE STRING "Target mantissa bits for SIMD double math")
67 mark_as_advanced(GMX_SIMD_ACCURACY_BITS_SINGLE)
68 mark_as_advanced(GMX_SIMD_ACCURACY_BITS_DOUBLE)
70 if(${GMX_SIMD_ACCURACY_BITS_SINGLE} GREATER 22)
71     message(STATUS "Note: Full mantissa accuracy (including least significant bit) requested for SIMD single math. Presently we cannot get the least significant bit correct since that would require different algorithms - reducing to 22 bits.")
72     set(GMX_SIMD_ACCURACY_BITS_SINGLE 22 CACHE STRING "Target mantissa bits for SIMD single math" FORCE)
73 endif()
75 if(${GMX_SIMD_ACCURACY_BITS_DOUBLE} GREATER 51)
76     message(STATUS "Note: Full mantissa accuracy (including least significant bit) requested for SIMD double math. Presently we cannot get the least significant bit correct since that would require different algorithms - reducing to 51 bits.")
77     set(GMX_SIMD_ACCURACY_BITS_DOUBLE 51 CACHE STRING "Target mantissa bits for SIMD double math" FORCE)
78 endif()
81 # Section to set (and test) compiler flags for SIMD.
83 # If the user chose the (default) automatic behaviour, then detection
84 # is run to suggest a SIMD choice suitable for the build
85 # host. Otherwise, the users's choice is always honoured. The compiler
86 # flags will be set based on that choice.
89 set(GMX_SIMD_ACTIVE ${GMX_SIMD})
90 if(GMX_SIMD STREQUAL "AUTO")
91     include(gmxDetectSimd)
92     gmx_detect_simd(GMX_SUGGESTED_SIMD)
93     set(GMX_SIMD_ACTIVE ${GMX_SUGGESTED_SIMD})
94 endif()
96 if(GMX_SIMD_ACTIVE STREQUAL "NONE")
97     # nothing to do configuration-wise
98     set(SIMD_STATUS_MESSAGE "SIMD instructions disabled")
99 elseif(GMX_SIMD_ACTIVE STREQUAL "SSE2")
101     gmx_find_simd_sse2_flags(SIMD_SSE2_C_SUPPORTED SIMD_SSE2_CXX_SUPPORTED
102                              SIMD_SSE2_C_FLAGS SIMD_SSE2_CXX_FLAGS)
104     if(NOT SIMD_SSE2_C_SUPPORTED OR NOT SIMD_SSE2_CXX_SUPPORTED)
105         gmx_give_fatal_error_when_simd_support_not_found("SSE2" "disable SIMD support (slow)" "${SUGGEST_BINUTILS_UPDATE}")
106     endif()
108     set(SIMD_C_FLAGS "${SIMD_SSE2_C_FLAGS}")
109     set(SIMD_CXX_FLAGS "${SIMD_SSE2_CXX_FLAGS}")
110     set(GMX_SIMD_X86_${GMX_SIMD_ACTIVE} 1)
111     set(SIMD_STATUS_MESSAGE "Enabling SSE2 SIMD instructions using CXX flags: ${SIMD_SSE2_CXX_FLAGS}")
113 elseif(GMX_SIMD_ACTIVE STREQUAL "SSE4.1")
115     gmx_find_simd_sse4_1_flags(SIMD_SSE4_1_C_SUPPORTED SIMD_SSE4_1_CXX_SUPPORTED
116                                SIMD_SSE4_1_C_FLAGS SIMD_SSE4_1_CXX_FLAGS)
118     if(NOT SIMD_SSE4_1_C_SUPPORTED OR NOT SIMD_SSE4_1_CXX_SUPPORTED)
119         gmx_give_fatal_error_when_simd_support_not_found("SSE4.1" "choose SSE2 SIMD (slower)" "${SUGGEST_BINUTILS_UPDATE}")
120     endif()
122     set(SIMD_C_FLAGS "${SIMD_SSE4_1_C_FLAGS}")
123     set(SIMD_CXX_FLAGS "${SIMD_SSE4_1_CXX_FLAGS}")
124     set(GMX_SIMD_X86_SSE4_1 1)
125     set(SIMD_STATUS_MESSAGE "Enabling SSE4.1 SIMD instructions using CXX flags: ${SIMD_SSE4_1_CXX_FLAGS}")
127 elseif(GMX_SIMD_ACTIVE STREQUAL "AVX_128_FMA")
129     gmx_find_simd_avx_128_fma_flags(SIMD_AVX_128_FMA_C_SUPPORTED SIMD_AVX_128_FMA_CXX_SUPPORTED
130                                     SIMD_AVX_128_FMA_C_FLAGS SIMD_AVX_128_FMA_CXX_FLAGS)
132     if(NOT SIMD_AVX_128_FMA_C_SUPPORTED OR NOT SIMD_AVX_128_FMA_CXX_SUPPORTED)
133         gmx_give_fatal_error_when_simd_support_not_found("128-bit AVX with FMA support" "choose SSE4.1 SIMD (slower)" "${SUGGEST_BINUTILS_UPDATE}")
134     endif()
136     set(SIMD_C_FLAGS "${SIMD_AVX_128_FMA_C_FLAGS}")
137     set(SIMD_CXX_FLAGS "${SIMD_AVX_128_FMA_CXX_FLAGS}")
138     set(GMX_SIMD_X86_${GMX_SIMD_ACTIVE} 1)
139     set(SIMD_STATUS_MESSAGE "Enabling 128-bit AMD FMA SIMD instructions using CXX flags: ${SIMD_AVX_128_FMA_CXX_FLAGS}")
141 elseif(GMX_SIMD_ACTIVE STREQUAL "AVX_256")
143     gmx_find_simd_avx_flags(SIMD_AVX_C_SUPPORTED SIMD_AVX_CXX_SUPPORTED
144                             SIMD_AVX_C_FLAGS SIMD_AVX_CXX_FLAGS)
146     if(NOT SIMD_AVX_C_SUPPORTED OR NOT SIMD_AVX_CXX_SUPPORTED)
147         gmx_give_fatal_error_when_simd_support_not_found("AVX" "choose SSE4.1 SIMD (slower)" "${SUGGEST_BINUTILS_UPDATE}")
148     endif()
150     set(SIMD_C_FLAGS "${SIMD_AVX_C_FLAGS}")
151     set(SIMD_CXX_FLAGS "${SIMD_AVX_CXX_FLAGS}")
152     set(GMX_SIMD_X86_${GMX_SIMD_ACTIVE} 1)
153     set(SIMD_STATUS_MESSAGE "Enabling 256-bit AVX SIMD instructions using CXX flags: ${SIMD_AVX_CXX_FLAGS}")
155 elseif(GMX_SIMD_ACTIVE MATCHES "AVX2_")
157     gmx_find_simd_avx2_flags(SIMD_AVX2_C_SUPPORTED SIMD_AVX2_CXX_SUPPORTED
158                              SIMD_AVX2_C_FLAGS SIMD_AVX2_CXX_FLAGS)
160     if(NOT SIMD_AVX2_C_SUPPORTED OR NOT SIMD_AVX2_CXX_SUPPORTED)
161         gmx_give_fatal_error_when_simd_support_not_found("AVX2" "choose AVX SIMD (slower)" "${SUGGEST_BINUTILS_UPDATE}")
162     endif()
164     set(SIMD_C_FLAGS "${SIMD_AVX2_C_FLAGS}")
165     set(SIMD_CXX_FLAGS "${SIMD_AVX2_CXX_FLAGS}")
166     set(GMX_SIMD_X86_${GMX_SIMD_ACTIVE} 1)
168     if(GMX_SIMD_ACTIVE STREQUAL "AVX2_128")
169         set(SIMD_STATUS_MESSAGE "Enabling 128-bit AVX2 SIMD instructions using CXX flags: ${SIMD_AVX2_CXX_FLAGS}")
170     else()
171         set(SIMD_STATUS_MESSAGE "Enabling 256-bit AVX2 SIMD instructions using CXX flags: ${SIMD_AVX2_CXX_FLAGS}")
172     endif()
174 elseif(GMX_SIMD_ACTIVE STREQUAL "MIC")
176     # No flags needed. Not testing.
177     set(GMX_SIMD_X86_MIC 1)
178     set(SIMD_STATUS_MESSAGE "Enabling MIC (Xeon Phi) SIMD instructions without special flags.")
180 elseif(GMX_SIMD_ACTIVE STREQUAL "AVX_512")
182     gmx_find_simd_avx_512_flags(SIMD_AVX_512_C_SUPPORTED SIMD_AVX_512_CXX_SUPPORTED
183                                 SIMD_AVX_512_C_FLAGS SIMD_AVX_512_CXX_FLAGS)
185     if(NOT SIMD_AVX_512_C_SUPPORTED OR NOT SIMD_AVX_512_CXX_SUPPORTED)
186         gmx_give_fatal_error_when_simd_support_not_found("AVX 512F" "choose a lower level of SIMD (slower)" "${SUGGEST_BINUTILS_UPDATE}")
187     endif()
189     set(SIMD_C_FLAGS "${SIMD_AVX_512_C_FLAGS}")
190     set(SIMD_CXX_FLAGS "${SIMD_AVX_512_CXX_FLAGS}")
191     set(GMX_SIMD_X86_${GMX_SIMD_ACTIVE} 1)
192     set(SIMD_STATUS_MESSAGE "Enabling 512-bit AVX-512 SIMD instructions using CXX flags: ${SIMD_AVX_512_CXX_FLAGS}")
194 elseif(GMX_SIMD_ACTIVE STREQUAL "AVX_512_KNL")
196     gmx_find_simd_avx_512_knl_flags(SIMD_AVX_512_KNL_C_SUPPORTED SIMD_AVX_512_KNL_CXX_SUPPORTED
197                                     SIMD_AVX_512_KNL_C_FLAGS SIMD_AVX_512_KNL_CXX_FLAGS)
199     if(NOT SIMD_AVX_512_KNL_C_SUPPORTED OR NOT SIMD_AVX_512_KNL_CXX_SUPPORTED)
200         gmx_give_fatal_error_when_simd_support_not_found("AVX 512ER" "choose a lower level of SIMD (slower)" "${SUGGEST_BINUTILS_UPDATE}")
201     endif()
203     set(SIMD_C_FLAGS "${SIMD_AVX_512_KNL_C_FLAGS}")
204     set(SIMD_CXX_FLAGS "${SIMD_AVX_512_KNL_CXX_FLAGS}")
205     set(GMX_SIMD_X86_${GMX_SIMD_ACTIVE} 1)
206     set(SIMD_STATUS_MESSAGE "Enabling 512-bit AVX-512-KNL SIMD instructions using CXX flags: ${SIMD_AVX_512_KNL_CXX_FLAGS}")
208 elseif(GMX_SIMD_ACTIVE STREQUAL "ARM_NEON")
210     if (GMX_DOUBLE)
211         message(FATAL_ERROR "ARM_NEON SIMD support is not available for a double precision build because the architecture lacks double-precision support")
212     endif()
214     gmx_find_simd_arm_neon_flags(SIMD_ARM_NEON_C_SUPPORTED SIMD_ARM_NEON_CXX_SUPPORTED
215                                  SIMD_ARM_NEON_C_FLAGS SIMD_ARM_NEON_CXX_FLAGS)
217     if(NOT SIMD_ARM_NEON_C_SUPPORTED OR NOT SIMD_ARM_NEON_CXX_SUPPORTED)
218         gmx_give_fatal_error_when_simd_support_not_found("ARM NEON" "disable SIMD support (slower)" "${SUGGEST_BINUTILS_UPDATE}")
219     endif()
221     set(SIMD_C_FLAGS "${SIMD_ARM_NEON_C_FLAGS}")
222     set(SIMD_CXX_FLAGS "${SIMD_ARM_NEON_CXX_FLAGS}")
223     set(GMX_SIMD_${GMX_SIMD_ACTIVE} 1)
224     set(SIMD_STATUS_MESSAGE "Enabling 32-bit ARM NEON SIMD instructions using CXX flags: ${SIMD_ARM_NEON_CXX_FLAGS}")
226 elseif(GMX_SIMD_ACTIVE STREQUAL "ARM_NEON_ASIMD")
228     gmx_find_simd_arm_neon_asimd_flags(SIMD_ARM_NEON_ASIMD_C_SUPPORTED SIMD_ARM_NEON_ASIMD_CXX_SUPPORTED
229                                        SIMD_ARM_NEON_ASIMD_C_FLAGS SIMD_ARM_NEON_ASIMD_CXX_FLAGS)
231     if(NOT SIMD_ARM_NEON_ASIMD_C_SUPPORTED OR NOT SIMD_ARM_NEON_ASIMD_CXX_SUPPORTED)
232         gmx_give_fatal_error_when_simd_support_not_found("ARM (AArch64) NEON Advanced SIMD" "particularly gcc version 4.9 or later, or disable SIMD support (slower)" "${SUGGEST_BINUTILS_UPDATE}")
233     endif()
235     set(SIMD_C_FLAGS "${SIMD_ARM_NEON_ASIMD_C_FLAGS}")
236     set(SIMD_CXX_FLAGS "${SIMD_ARM_NEON_ASIMD_CXX_FLAGS}")
237     set(GMX_SIMD_${GMX_SIMD_ACTIVE} 1)
238     set(SIMD_STATUS_MESSAGE "Enabling ARM (AArch64) NEON Advanced SIMD instructions using CXX flags: ${SIMD_ARM_NEON_ASIMD_CXX_FLAGS}")
240 elseif(GMX_SIMD_ACTIVE STREQUAL "IBM_VMX")
242     gmx_find_simd_ibm_vmx_flags(SIMD_IBM_VMX_C_SUPPORTED SIMD_IBM_VMX_CXX_SUPPORTED
243                                 SIMD_IBM_VMX_C_FLAGS SIMD_IBM_VMX_CXX_FLAGS)
245     if(NOT SIMD_IBM_VMX_C_SUPPORTED OR NOT SIMD_IBM_VMX_CXX_SUPPORTED)
246         gmx_give_fatal_error_when_simd_support_not_found("IBM VMX" "disable SIMD support (slower)" "${SUGGEST_BINUTILS_UPDATE}")
247     endif()
249     set(SIMD_C_FLAGS "${SIMD_IBM_VMX_C_FLAGS}")
250     set(SIMD_CXX_FLAGS "${SIMD_IBM_VMX_CXX_FLAGS}")
251     set(GMX_SIMD_${GMX_SIMD_ACTIVE} 1)
252     set(SIMD_STATUS_MESSAGE "Enabling IBM VMX SIMD instructions using CXX flags: ${SIMD_IBM_VMX_CXX_FLAGS}")
254 elseif(GMX_SIMD_ACTIVE STREQUAL "IBM_VSX")
256     gmx_find_simd_ibm_vsx_flags(SIMD_IBM_VSX_C_SUPPORTED SIMD_IBM_VSX_CXX_SUPPORTED
257                                 SIMD_IBM_VSX_C_FLAGS SIMD_IBM_VSX_CXX_FLAGS)
259     # Usually we check also for the C compiler here, but a C compiler
260     # is not required for SIMD support on this platform. cmake through
261     # at least version 3.7 cannot pass this check with the C compiler
262     # in the latest xlc 13.1.5, but the C++ compiler has different
263     # behaviour and is OK. See Redmine #2102.
264     if(NOT SIMD_IBM_VSX_CXX_SUPPORTED)
265         gmx_give_fatal_error_when_simd_support_not_found("IBM VSX" "disable SIMD support (slower)" "${SUGGEST_BINUTILS_UPDATE}")
266     endif()
268     set(SIMD_C_FLAGS "${SIMD_IBM_VSX_C_FLAGS}")
269     set(SIMD_CXX_FLAGS "${SIMD_IBM_VSX_CXX_FLAGS}")
270     set(GMX_SIMD_${GMX_SIMD_ACTIVE} 1)
271     set(SIMD_STATUS_MESSAGE "Enabling IBM VSX SIMD instructions using CXX flags: ${SIMD_IBM_VSX_CXX_FLAGS}")
273 elseif(GMX_SIMD_ACTIVE STREQUAL "SPARC64_HPC_ACE")
275     # Note that GMX_RELAXED_DOUBLE_PRECISION is enabled by default in the top-level CMakeLists.txt
277     set(GMX_SIMD_${GMX_SIMD_ACTIVE} 1)
278     set(SIMD_STATUS_MESSAGE "Enabling Sparc64 HPC-ACE SIMD instructions without special flags.")
280 elseif(GMX_SIMD_ACTIVE STREQUAL "REFERENCE")
282     # NB: This file handles settings for the SIMD module, so in the interest 
283     # of proper modularization, please do NOT put any verlet kernel settings in this file.
285     if(GMX_SIMD_REF_FLOAT_WIDTH)
286         add_definitions(-DGMX_SIMD_REF_FLOAT_WIDTH=${GMX_SIMD_REF_FLOAT_WIDTH})
287     endif()
288     if(GMX_SIMD_REF_DOUBLE_WIDTH)
289         add_definitions(-DGMX_SIMD_REF_DOUBLE_WIDTH=${GMX_SIMD_REF_DOUBLE_WIDTH})
290     endif()
292     set(GMX_SIMD_${GMX_SIMD_ACTIVE} 1)
293     set(SIMD_STATUS_MESSAGE "Enabling reference (emulated) SIMD instructions without special flags.")
295 else()
296     gmx_invalid_option_value(GMX_SIMD_ACTIVE)
297 endif()
300 gmx_check_if_changed(SIMD_CHANGED GMX_SIMD_ACTIVE)
301 if (SIMD_CHANGED AND DEFINED SIMD_STATUS_MESSAGE)
302     message(STATUS "${SIMD_STATUS_MESSAGE}")
303 endif()
305 # While AVX-512 is a more recent SIMD ISA than AVX2, some Intel CPUs only have
306 # a single AVX-512 FMA unit, but two AVX2 FMA units, and then it is better to
307 # use AVX2. The only way to test this is to execute a small timing loop.
308 # To be able to recommend the user whether s/he should try AVX-512 instead of
309 # AVX2, we need to compile a single file with AVX512 flags. We do this
310 # automatically, but this option provides a way to turn it off in case it
311 # breaks something. The actual test source file is built if
312 # SIMD_AVX_512_CXX_SUPPORTED is set, so it will always be included if we have
313 # GMX_SIMD=AVX_512.
314 set(GMX_ENABLE_AVX512_TESTS ON CACHE BOOL "Compile AVX512 code to test FMA units, even when not using AVX512 SIMD")
315 mark_as_advanced(GMX_ENABLE_AVX512_TESTS)
317 if(GMX_ENABLE_AVX512_TESTS AND
318     (GMX_SIMD_ACTIVE STREQUAL "AVX_256" OR GMX_SIMD_ACTIVE STREQUAL "AVX2_256" OR GMX_SIMD_ACTIVE STREQUAL "AVX2_128"))
319     if(NOT DEFINED SIMD_AVX_512_CXX_SUPPORTED)
320         message(STATUS "Detecting flags to enable runtime detection of AVX-512 units on newer CPUs")
321         set(SIMD_AVX_512_REPORT_STATUS 1)
322     endif()
323     gmx_find_simd_avx_512_flags(SIMD_AVX_512_C_SUPPORTED SIMD_AVX_512_CXX_SUPPORTED
324                                 SIMD_AVX_512_C_FLAGS SIMD_AVX_512_CXX_FLAGS)
325     if(SIMD_AVX_512_REPORT_STATUS)
326         if(SIMD_AVX_512_CXX_SUPPORTED)
327             message(STATUS "Detecting flags to enable runtime detection of AVX-512 units on newer CPUs - ${SIMD_AVX_512_CXX_FLAGS}")
328         else()
329             message(STATUS "Detecting flags to enable runtime detection of AVX-512 units on newer CPUs - not supported")
330         endif()
331     endif()
332     # Since we might be overriding AVX2 architecture flags with the AVX512 flags for the
333     # files where it is used, we also check for a flag not to warn about the first (unused) arch.
334     # To avoid spamming the user with lots of gromacs tests we just call the CMake flag test directly.
335     if (NOT MSVC)
336         foreach(_testflag "-Wno-unused-command-line-argument" "-wd10121")
337             string(REGEX REPLACE "[^a-zA-Z0-9]+" "_" FLAG_ACCEPTED_VARIABLE "${_testflag}_FLAG_ACCEPTED")
338             check_cxx_compiler_flag("${_testflag}" ${FLAG_ACCEPTED_VARIABLE})
339             if(${FLAG_ACCEPTED_VARIABLE})
340                 set(CXX_NO_UNUSED_OPTION_WARNING_FLAGS "${_testflag}")
341                 break()
342             endif()
343         endforeach(_testflag)
344     endif()
345 endif()
347 # By default, 32-bit windows cannot pass SIMD (SSE/AVX) arguments in registers,
348 # and even on 64-bit (all platforms) it is only used for a handful of arguments.
349 # The __vectorcall (MSVC, from MSVC2013) or __regcall (ICC) calling conventions
350 # enable this, which is critical to enable 32-bit SIMD and improves performance
351 # for 64-bit SIMD.
352 # Check if the compiler supports one of these, and in that case set gmx_simdcall
353 # to that string. If we do not have any such calling convention modifier, set it
354 # to an empty string.
356 # Update 2015-11-04: As of version 3.6, clang has added support for __vectorcall
357 # (also on Linux). This appears to be buggy for the reference SIMD
358 # implementation when using the Debug build (when functions are not inlined) 
359 # while it seems works fine for the actual SIMD implementations. This is likely
360 # because the reference build ends up passing lots of structures with arrays
361 # rather than actual vector data. For now we disable __vectorcall with clang
362 # when using the reference build.
364 # xlc 13.1.5 does not seem recognize any attribute, and warns about invalid ones
365 # so we avoid searching for any.
367 if(NOT DEFINED GMX_SIMD_CALLING_CONVENTION)
368     if(CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND GMX_SIMD_ACTIVE STREQUAL "REFERENCE")
369         set(CALLCONV_LIST __regcall " ")
370    elseif(CMAKE_CXX_COMPILER_ID MATCHES "XL")
371         set(CALLCONV_LIST " ")
372     else()
373         set(CALLCONV_LIST __vectorcall __regcall " ")
374     endif()
375     foreach(callconv ${CALLCONV_LIST})
376         set(callconv_compile_var "_callconv_${callconv}")
377         # Some compilers warn about targets for which attributes are
378         # ignored (e.g. clang on ARM), and in such cases we want this
379         # check to lead to using no attribute in subsequent GROMACS
380         # compilation, to avoid issuing the warning for lots of files.
381         check_c_source_compiles("
382 #pragma GCC diagnostic error \"-Wignored-attributes\"
383 int ${callconv} f(int i) {return i;} int main(void) {return f(0);}
384 " ${callconv_compile_var})
385         if(${callconv_compile_var})
386             set(GMX_SIMD_CALLING_CONVENTION_VALUE "${callconv}" CACHE INTERNAL "Calling convention for SIMD routines" FORCE)
387             break()
388         endif()
389     endforeach()
390     # If the build is not using SIMD, then we should not manage the
391     # calling convention. Doing so seems to confuse
392     # clang-static-analyzer in at least version 6.0.
393     if(GMX_SIMD_ACTIVE STREQUAL "NONE")
394         set(GMX_SIMD_CALLING_CONVENTION " ")
395     else()
396         set(GMX_SIMD_CALLING_CONVENTION ${GMX_SIMD_CALLING_CONVENTION_VALUE})
397     endif()
398 endif()
400 if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "GNU")
401     # GCC bug 49001, 54412 on Windows (just warn, since it might be fixed in later versions)
402     if((CMAKE_CXX_COMPILER_VERSION VERSION_LESS "4.9.0" OR CMAKE_SIZEOF_VOID_P EQUAL 8)
403             AND (WIN32 OR CYGWIN)
404             AND (GMX_SIMD_ACTIVE MATCHES "AVX") AND NOT (GMX_SIMD_ACTIVE STREQUAL "AVX_128_FMA"))
405         message(WARNING "GCC on Windows (GCC older than 4.9 in 32-bit mode, or any version in 64-bit mode) with 256-bit AVX will probably crash. You might want to choose a different GMX_SIMD or a different compiler.")
406     endif()
407 endif()
409 string(TOUPPER "${CMAKE_BUILD_TYPE}" _cmake_build_type)
410 if (_cmake_build_type STREQUAL "TSAN" AND NOT (GMX_SIMD_ACTIVE STREQUAL "NONE" OR GMX_SIMD_ACTIVE STREQUAL "REFERENCE" OR GMX_SIMD_ACTIVE MATCHES "AVX_512" OR GMX_SIMD_ACTIVE STREQUAL AVX2_256))
411    message(WARNING "TSAN is only tested with SIMD None, Reference, AVX2_256, and AVX_512. It is known to detect (harmless) memory races with SSE and AVX.")
412 endif()
414 endmacro()