Fix build issues with Clang CUDA
[alexxy/gromacs.git] / src / gromacs / CMakeLists.txt
1 #
2 # This file is part of the GROMACS molecular simulation package.
3 #
4 # Copyright (c) 2010,2011,2012,2013,2014 by the GROMACS development team.
5 # Copyright (c) 2015,2016,2017,2018,2019,2020, by the GROMACS development team, led by
6 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
7 # and including many others, as listed in the AUTHORS file in the
8 # top-level source directory and at http://www.gromacs.org.
9 #
10 # GROMACS is free software; you can redistribute it and/or
11 # modify it under the terms of the GNU Lesser General Public License
12 # as published by the Free Software Foundation; either version 2.1
13 # of the License, or (at your option) any later version.
14 #
15 # GROMACS is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 # Lesser General Public License for more details.
19 #
20 # You should have received a copy of the GNU Lesser General Public
21 # License along with GROMACS; if not, see
22 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
23 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
24 #
25 # If you want to redistribute modifications to GROMACS, please
26 # consider that scientific software is very special. Version
27 # control is crucial - bugs must be traceable. We will be happy to
28 # consider code for inclusion in the official distribution, but
29 # derived work must not be called official GROMACS. Details are found
30 # in the README & COPYING files - if they are missing, get the
31 # official version at http://www.gromacs.org.
32 #
33 # To help us fund GROMACS development, we humbly ask that you cite
34 # the research papers on the package. Check out http://www.gromacs.org.
35
36 set(LIBGROMACS_SOURCES)
37
38 if (GMX_CLANG_CUDA)
39     include(gmxClangCudaUtils)
40 endif()
41
42 set_property(GLOBAL PROPERTY GMX_LIBGROMACS_SOURCES)
43 set_property(GLOBAL PROPERTY CUDA_SOURCES)
44 set_property(GLOBAL PROPERTY GMX_INSTALLED_HEADERS)
45 set_property(GLOBAL PROPERTY GMX_AVX_512_SOURCE)
46
47 set(libgromacs_object_library_dependencies "")
48 function (_gmx_add_files_to_property PROPERTY)
49     foreach (_file ${ARGN})
50         if (IS_ABSOLUTE "${_file}")
51             set_property(GLOBAL APPEND PROPERTY ${PROPERTY} ${_file})
52         else()
53             set_property(GLOBAL APPEND PROPERTY ${PROPERTY}
54                          ${CMAKE_CURRENT_LIST_DIR}/${_file})
55         endif()
56     endforeach()
57 endfunction ()
58
59 function (gmx_add_libgromacs_sources)
60     _gmx_add_files_to_property(GMX_LIBGROMACS_SOURCES ${ARGN})
61 endfunction ()
62
63 # Permit the configuration to disable compiling the many nbnxm kernels
64 # and others involved in force calculations. Currently only
65 # short-ranged and bonded kernels are disabled this way, but in future
66 # others may be appropriate. Thus the cmake option is not specific to
67 # nbnxm module.
68 option(GMX_USE_SIMD_KERNELS "Whether to compile NBNXM and other SIMD kernels" ON)
69 mark_as_advanced(GMX_USE_SIMD_KERNELS)
70
71 # Add these contents first because linking their tests can take a lot
72 # of time, so we want lots of parallel work still available after
73 # linking starts.
74 add_subdirectory(utility)
75 # Add normal contents
76 add_subdirectory(gmxlib)
77 add_subdirectory(mdlib)
78 add_subdirectory(applied_forces)
79 add_subdirectory(listed_forces)
80 add_subdirectory(nbnxm)
81 add_subdirectory(commandline)
82 add_subdirectory(domdec)
83 add_subdirectory(ewald)
84 add_subdirectory(fft)
85 add_subdirectory(gpu_utils)
86 add_subdirectory(hardware)
87 add_subdirectory(linearalgebra)
88 add_subdirectory(math)
89 add_subdirectory(mdrun)
90 add_subdirectory(mdrunutility)
91 add_subdirectory(mdspan)
92 add_subdirectory(mdtypes)
93 add_subdirectory(onlinehelp)
94 add_subdirectory(options)
95 add_subdirectory(pbcutil)
96 add_subdirectory(random)
97 add_subdirectory(restraint)
98 add_subdirectory(tables)
99 add_subdirectory(taskassignment)
100 add_subdirectory(timing)
101 add_subdirectory(topology)
102 add_subdirectory(trajectory)
103 add_subdirectory(swap)
104 add_subdirectory(essentialdynamics)
105 add_subdirectory(pulling)
106 add_subdirectory(simd)
107 add_subdirectory(imd)
108 add_subdirectory(compat)
109 add_subdirectory(mimic)
110 add_subdirectory(modularsimulator)
111 if (NOT GMX_BUILD_MDRUN_ONLY)
112     add_subdirectory(gmxana)
113     add_subdirectory(gmxpreprocess)
114     add_subdirectory(correlationfunctions)
115     add_subdirectory(statistics)
116     add_subdirectory(analysisdata)
117     add_subdirectory(coordinateio)
118     add_subdirectory(trajectoryanalysis)
119     add_subdirectory(energyanalysis)
120     add_subdirectory(tools)
121 endif()
122
123 get_property(PROPERTY_SOURCES GLOBAL PROPERTY GMX_LIBGROMACS_SOURCES)
124 list(APPEND LIBGROMACS_SOURCES ${GMXLIB_SOURCES} ${MDLIB_SOURCES} ${PROPERTY_SOURCES})
125
126 # This would be the standard way to include thread_mpi, but
127 # we want libgromacs to link the functions directly
128 #if(GMX_THREAD_MPI)
129 #    add_subdirectory(thread_mpi)
130 #endif()
131 #target_link_libraries(gmx ${GMX_EXTRA_LIBRARIES} ${THREAD_MPI_LIB})
132 tmpi_get_source_list(THREAD_MPI_SOURCES ${PROJECT_SOURCE_DIR}/src/external/thread_mpi/src)
133 add_library(thread_mpi OBJECT ${THREAD_MPI_SOURCES})
134 target_compile_definitions(thread_mpi PRIVATE HAVE_CONFIG_H)
135 if(CYGWIN)
136     # Needs POSIX-isms for strdup, not just std-isms
137     target_compile_definitions(thread_mpi PRIVATE _POSIX_C_SOURCE=200809L)
138 endif()
139 gmx_target_compile_options(thread_mpi)
140 if (WIN32)
141     gmx_target_warning_suppression(thread_mpi /wd4996 HAS_NO_MSVC_UNSAFE_FUNCTION)
142 endif()
143 list(APPEND libgromacs_object_library_dependencies thread_mpi)
144
145 configure_file(version.h.cmakein version.h)
146 if(GMX_INSTALL_LEGACY_API)
147   install(FILES
148           ${CMAKE_CURRENT_BINARY_DIR}/version.h
149           analysisdata.h
150           options.h
151           selection.h
152           trajectoryanalysis.h
153           DESTINATION include/gromacs)
154 endif()
155
156 # This code is here instead of utility/CMakeLists.txt, because CMake
157 # custom commands and source file properties can only be set in the directory
158 # that contains the target that uses them.
159 # TODO: Generate a header instead that can be included from baseversion.cpp.
160 # That probably simplifies things somewhat.
161 set(GENERATED_VERSION_FILE utility/baseversion-gen.cpp)
162 gmx_configure_version_file(
163     utility/baseversion-gen.cpp.cmakein ${GENERATED_VERSION_FILE}
164     REMOTE_HASH
165     EXTRA_VARS
166         GMX_SOURCE_DOI
167         GMX_RELEASE_HASH
168         GMX_SOURCE_HASH
169         )
170 list(APPEND LIBGROMACS_SOURCES ${GENERATED_VERSION_FILE})
171
172 # Mark some shared GPU implementation files to compile with CUDA if needed
173 if (GMX_GPU_CUDA)
174     get_property(CUDA_SOURCES GLOBAL PROPERTY CUDA_SOURCES)
175     set_source_files_properties(${CUDA_SOURCES} PROPERTIES CUDA_SOURCE_PROPERTY_FORMAT OBJ)
176 endif()
177
178 if (GMX_GPU_CUDA)
179     # Work around FindCUDA that prevents using target_link_libraries()
180     # with keywords otherwise...
181     set(CUDA_LIBRARIES PRIVATE ${CUDA_LIBRARIES})
182     if (NOT GMX_CLANG_CUDA)
183         gmx_cuda_add_library(libgromacs ${LIBGROMACS_SOURCES})
184     else()
185         add_library(libgromacs ${LIBGROMACS_SOURCES})
186     endif()
187     target_link_libraries(libgromacs PRIVATE ${CUDA_CUFFT_LIBRARIES})
188 else()
189     add_library(libgromacs ${LIBGROMACS_SOURCES})
190 endif()
191
192 # Add these contents first because linking their tests can take a lot
193 # of time, so we want lots of parallel work still available after
194 # linking starts.
195 add_subdirectory(fileio)
196 add_subdirectory(selection)
197
198 # Suppress a warning about our abuse of t_inputrec
199 gmx_source_file_warning_suppression(mdtypes/inputrec.cpp -Wno-class-memaccess HAS_NO_CLASS_MEMACCESS)
200
201 # Handle the object libraries that contain the source file
202 # dependencies that need special handling because they are generated
203 # or external code.
204 foreach(object_library ${libgromacs_object_library_dependencies})
205     if (BUILD_SHARED_LIBS)
206         set_target_properties(${object_library} PROPERTIES POSITION_INDEPENDENT_CODE true)
207     endif()
208     target_include_directories(${object_library} SYSTEM BEFORE PRIVATE ${PROJECT_SOURCE_DIR}/src/external/thread_mpi/include)
209
210     # Add the sources from the object libraries to the main library.
211     target_sources(libgromacs PRIVATE $<TARGET_OBJECTS:${object_library}>)
212 endforeach()
213 gmx_target_compile_options(libgromacs)
214 target_compile_definitions(libgromacs PRIVATE HAVE_CONFIG_H)
215 target_include_directories(libgromacs SYSTEM BEFORE PRIVATE ${PROJECT_SOURCE_DIR}/src/external/thread_mpi/include)
216
217 if (GMX_GPU_OPENCL)
218     option(GMX_EXTERNAL_CLFFT "True if an external clFFT is required to be used" FALSE)
219     mark_as_advanced(GMX_EXTERNAL_CLFFT)
220
221     # Default to using clFFT found on the system
222     # switch to quiet at the second run.
223     if (DEFINED clFFT_LIBRARY)
224         set (clFFT_FIND_QUIETLY TRUE)
225     endif()
226     find_package(clFFT)
227     if (NOT clFFT_FOUND)
228         if (GMX_EXTERNAL_CLFFT)
229             message(FATAL_ERROR "Did not find required external clFFT library, consider setting clFFT_ROOT_DIR")
230         endif()
231
232         if(MSVC)
233             message(FATAL_ERROR
234 "An OpenCL build was requested with Visual Studio compiler, but GROMACS
235 requires clFFT, which was not found on your system. GROMACS does bundle
236 clFFT to help with building for OpenCL, but that clFFT has not yet been
237 ported to the more recent versions of that compiler that GROMACS itself
238 requires. Thus for now, OpenCL is not available with MSVC and the internal
239 build of clFFT in GROMACS 2019. Either change compiler, try installing
240 a clFFT package, or use the latest GROMACS 2018 point release.")
241         endif()
242
243         # Fall back on the internal version
244         set (_clFFT_dir ../external/clFFT/src)
245         add_subdirectory(${_clFFT_dir} clFFT-build)
246         target_sources(libgromacs PRIVATE
247             $<TARGET_OBJECTS:clFFT>
248         )
249         target_include_directories(libgromacs SYSTEM PRIVATE ${_clFFT_dir}/include)
250         # Use the magic variable for how to link any library needed for
251         # dlopen, etc.  which is -ldl where needed, and empty otherwise
252         # (e.g. Windows, BSD, Mac).
253         target_link_libraries(libgromacs PRIVATE "${CMAKE_DL_LIBS}")
254     else()
255         target_link_libraries(libgromacs PRIVATE clFFT)
256     endif()
257 endif()
258
259 # Permit GROMACS code to include externally developed headers, such as
260 # the functionality from the nonstd project that we use for
261 # gmx::compat::optional. These are included as system headers so that
262 # no warnings are issued from them.
263 #
264 # TODO Perhaps generalize this for all headers from src/external
265 target_include_directories(libgromacs SYSTEM PRIVATE ${PROJECT_SOURCE_DIR}/src/external)
266
267 if(SIMD_AVX_512_CXX_SUPPORTED AND NOT ("${GMX_SIMD_ACTIVE}" STREQUAL "AVX_512_KNL"))
268     # Since we might be overriding -march=core-avx2, add a flag so we don't warn for this specific file.
269     # On KNL this can cause illegal instruction because the compiler might use non KNL AVX instructions
270     # with the SIMD_AVX_512_CXX_FLAGS flags.
271     set_source_files_properties(hardware/identifyavx512fmaunits.cpp PROPERTIES COMPILE_FLAGS "${SIMD_AVX_512_CXX_FLAGS} ${CXX_NO_UNUSED_OPTION_WARNING_FLAGS}")
272 endif()
273
274 # Do any special handling needed for .cpp files that use
275 # CUDA runtime headers
276 if (GMX_GPU_CUDA AND CMAKE_CXX_COMPILER_ID MATCHES "Clang")
277     # CUDA header cuda_runtime_api.h in at least CUDA 10.1 uses 0
278     # where nullptr would be preferable. GROMACS can't fix these, so
279     # must suppress them.
280     GMX_TEST_CXXFLAG(CXXFLAGS_NO_ZERO_AS_NULL_POINTER_CONSTANT "-Wno-zero-as-null-pointer-constant" NVCC_CLANG_SUPPRESSIONS_CXXFLAGS)
281
282     foreach(_compile_flag ${NVCC_CLANG_SUPPRESSIONS_CXXFLAGS})
283         set(GMX_CUDA_CLANG_FLAGS "${GMX_CUDA_CLANG_FLAGS} ${_compile_flag}")
284     endforeach()
285     if (GMX_CLANG_CUDA)
286         foreach (_file ${LIBGROMACS_SOURCES})
287             get_filename_component(_ext ${_file} EXT)
288             get_source_file_property(_cuda_source_format ${_file} CUDA_SOURCE_PROPERTY_FORMAT)
289             if ("${_ext}" STREQUAL ".cu" OR _cuda_source_format)
290                 gmx_compile_cuda_file_with_clang(${_file})
291             endif()
292         endforeach()
293     else()
294         get_property(CUDA_SOURCES GLOBAL PROPERTY CUDA_SOURCES)
295         set_source_files_properties(${CUDA_SOURCES} PROPERTIES COMPILE_FLAGS ${GMX_CUDA_CLANG_FLAGS})
296     endif()
297 endif()
298
299 # Only add the -fsycl flag to sources that really need it
300 if (GMX_GPU_SYCL)
301     get_property(SYCL_SOURCES GLOBAL PROPERTY SYCL_SOURCES)
302     set_source_files_properties(${SYCL_SOURCES} PROPERTIES COMPILE_FLAGS "${SYCL_CXX_FLAGS}")
303 endif()
304
305 gmx_setup_tng_for_libgromacs()
306
307 # We apply the SYCL flag explicitly just for libgromacs, since bugs in the beta versions of
308 # icpx/dpcpp leads to crashes if we try to link an library without any SYCL code with the
309 # -fsycl flag enabled. Once that bug is fixed, we should change it to simply add
310 # SYCL_CXX_FLAGS to GMX_SHARED_LINKER_FLAGS.
311 target_link_libraries(libgromacs
312                       PRIVATE
313                       ${EXTRAE_LIBRARIES}
314                       ${GMX_EXTRA_LIBRARIES}
315                       ${GMX_COMMON_LIBRARIES}
316                       ${FFT_LIBRARIES} ${LINEAR_ALGEBRA_LIBRARIES}
317                       ${THREAD_LIB} ${GMX_SHARED_LINKER_FLAGS}
318                       ${SYCL_CXX_FLAGS}
319                       ${OpenCL_LIBRARIES}
320                       $<$<PLATFORM_ID:SunOS>:socket>
321                       PUBLIC
322                       ${GMX_PUBLIC_LIBRARIES}
323                       )
324 if (GMX_OPENMP)
325     target_link_libraries(libgromacs PUBLIC OpenMP::OpenMP_CXX)
326 endif()
327 set_target_properties(libgromacs PROPERTIES
328                       OUTPUT_NAME "gromacs${GMX_LIBS_SUFFIX}"
329                       SOVERSION ${LIBRARY_SOVERSION_MAJOR}
330                       VERSION ${LIBRARY_VERSION}
331                       )
332
333 gmx_manage_lmfit()
334 target_link_libraries(libgromacs PRIVATE lmfit)
335
336 # Make sure we fix "everything" found by more recent versions of clang.
337 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND CMAKE_CXX_COMPILER_VERSION VERSION_GREATER "7")
338    target_compile_options(libgromacs PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-Weverything ${IGNORED_CLANG_ALL_WARNINGS}>)
339 endif()
340 if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
341    target_compile_options(libgromacs PRIVATE $<$<COMPILE_LANGUAGE:CXX>:/analyze /analyze:stacksize 70000
342      #Control flow warnings are disabled because the commond line output is insufficient. There is no tool
343      #to convert the xml report to e.g. HTML and even in Visual Studio the viewer doesn't work with cmake support.
344      /wd6001  #unitialized memory
345      /wd6011  #derefencing NULL
346      /wd6053  #prior call not zero-terminate
347      /wd6054  #might not be zero-terminated
348      /wd6385  #reading invalid data
349      /wd6386  #buffer overrun
350      /wd6387  #could be '0'
351      /wd28199 #uninitialized memory
352      # For compile time constant (e.g. templates) the following warnings have flase postives
353      /wd6239  #(<non-zero> && <expr>)
354      /wd6240  #(<expr> && <non-zero>)
355      /wd6294  #Ill-defined for-loop
356      /wd6326  #comparison of constant with other constant
357      /wd28020 #expression involving paramter is not true
358      # Misc
359      /wd6330  #incorrect type to function (warns for char (instead of unsigned) for isspace/isalpha/isdigit/..))
360      /wd6993  #OpenMP ignored
361      #TODO
362      /wd6031  #return value ignored (important - mostly warnigns about sscanf)
363      /wd6244  #hides declaration (known issue - we ingore similar warnings for other compilers)
364      /wd6246  #hides declaration
365      >
366    )
367 endif()
368
369 if (GMX_CLANG_TIDY)
370    set_target_properties(libgromacs PROPERTIES CXX_CLANG_TIDY
371        "${CLANG_TIDY_EXE};-warnings-as-errors=*")
372 endif()
373
374 # clang-3.6 warns about a number of issues that are not reported by more modern compilers
375 # and we know they are not real issues. So we only check that it can compile without error
376 # but ignore all warnings.
377 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND CMAKE_CXX_COMPILER_VERSION MATCHES "^3\.6")
378     target_compile_options(libgromacs PRIVATE $<$<COMPILE_LANGUAGE:CXX>:-w>)
379 endif()
380
381 # Only install the library in mdrun-only mode if it is actually necessary
382 # for the binary
383 if (NOT GMX_BUILD_MDRUN_ONLY OR BUILD_SHARED_LIBS)
384     install(TARGETS libgromacs
385             EXPORT libgromacs
386             LIBRARY
387                 DESTINATION ${CMAKE_INSTALL_LIBDIR}
388                 COMPONENT libraries
389             RUNTIME
390                 DESTINATION ${CMAKE_INSTALL_BINDIR}
391                 COMPONENT libraries
392             ARCHIVE
393                 DESTINATION ${CMAKE_INSTALL_LIBDIR}
394                 COMPONENT libraries
395             INCLUDES DESTINATION include)
396     target_compile_definitions(libgromacs PUBLIC $<INSTALL_INTERFACE:GMX_DOUBLE=${GMX_DOUBLE_VALUE}>)
397     # legacy headers use c++17 features, so consumer codes need to use that standard, too
398     if(GMX_INSTALL_LEGACY_API)
399         target_compile_features(libgromacs INTERFACE cxx_std_${CMAKE_CXX_STANDARD})
400     endif()
401     add_library(Gromacs::libgromacs ALIAS libgromacs)
402 endif()
403
404 if (NOT GMX_BUILD_MDRUN_ONLY)
405     include(InstallLibInfo.cmake)
406 endif()
407
408 # Technically, the user could want to do this for an OpenCL build
409 # using the CUDA runtime, but currently there's no reason to want to
410 # do that.
411 if (INSTALL_CUDART_LIB) #can be set manual by user
412     if (GMX_GPU_CUDA)
413         foreach(CUDA_LIB ${CUDA_LIBRARIES})
414             string(REGEX MATCH "cudart" IS_CUDART ${CUDA_LIB})
415             if(IS_CUDART) #libcuda should not be installed
416                 #install also name-links (linker uses those)
417                 file(GLOB CUDA_LIBS ${CUDA_LIB}*)
418                 install(FILES ${CUDA_LIBS} DESTINATION
419                     ${CMAKE_INSTALL_LIBDIR} COMPONENT libraries)
420             endif()
421         endforeach()
422     else()
423         message(WARNING "INSTALL_CUDART_LIB only makes sense when configuring for CUDA support")
424     endif()
425 endif()
426
427 if(GMX_GPU_OPENCL)
428     # Install the utility headers
429     file(GLOB OPENCL_INSTALLED_FILES
430         gpu_utils/vectype_ops.clh
431         gpu_utils/device_utils.clh
432         )
433     install(FILES ${OPENCL_INSTALLED_FILES}
434         DESTINATION ${GMX_INSTALL_OCLDIR}/gromacs/gpu_utils
435         COMPONENT libraries)
436     file(GLOB OPENCL_INSTALLED_FILES
437         pbcutil/ishift.h
438         )
439     install(FILES ${OPENCL_INSTALLED_FILES}
440         DESTINATION ${GMX_INSTALL_OCLDIR}/gromacs/pbcutil
441         COMPONENT libraries)
442
443     # Install the NBNXM source and headers
444     file(GLOB OPENCL_INSTALLED_FILES
445         nbnxm/constants.h
446         )
447     install(FILES ${OPENCL_INSTALLED_FILES}
448         DESTINATION ${GMX_INSTALL_OCLDIR}/gromacs/nbnxm
449         COMPONENT libraries)
450     file(GLOB OPENCL_INSTALLED_FILES
451         nbnxm/opencl/nbnxm_ocl_kernels.cl
452         nbnxm/opencl/nbnxm_ocl_kernel.clh
453         nbnxm/opencl/nbnxm_ocl_kernel_pruneonly.clh
454         nbnxm/opencl/nbnxm_ocl_kernels.clh
455         nbnxm/opencl/nbnxm_ocl_kernels_fastgen.clh
456         nbnxm/opencl/nbnxm_ocl_kernels_fastgen_add_twincut.clh
457         nbnxm/opencl/nbnxm_ocl_kernel_utils.clh
458         nbnxm/opencl/nbnxm_ocl_consts.h
459         )
460     install(FILES ${OPENCL_INSTALLED_FILES}
461         DESTINATION ${GMX_INSTALL_OCLDIR}/gromacs/nbnxm/opencl
462         COMPONENT libraries)
463
464     # Install the PME source and headers
465     file(GLOB OPENCL_INSTALLED_FILES
466         ewald/pme_spread.clh
467         ewald/pme_solve.clh
468         ewald/pme_gather.clh
469         ewald/pme_gpu_calculate_splines.clh
470         ewald/pme_program.cl
471         ewald/pme_gpu_types.h
472         )
473     install(FILES ${OPENCL_INSTALLED_FILES}
474         DESTINATION ${GMX_INSTALL_OCLDIR}/gromacs/ewald
475         COMPONENT libraries)
476 endif()