Update user documentation overview
[gromacs.git] / src / config.h.cmakein
blob0beccbcedc7c9b14e268710ced6e7f06f39b089b
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2009,2010,2011,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.
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 /*! \libinternal \file
36  * \brief
37  * Include file for configuration macros from the build system.
38  *
39  * This header is not installed, so headers must not reference macros defined
40  * here.
41  *
42  * \inlibraryapi
43  */
44 #ifndef GMX_CONFIG_H
45 #define GMX_CONFIG_H
47 /* TODO: For now, disable Doxygen warnings from here */
48 /*! \cond */
50 /* Work around broken calloc() */
51 #cmakedefine01 GMX_BROKEN_CALLOC
53 /* Do not optimize FFTW setups (not needed with SSE FFT kernels) */
54 #cmakedefine01 GMX_DISABLE_FFTW_MEASURE
56 /* Use FFTW3 FFT library */
57 #cmakedefine01 GMX_FFT_FFTW3
59 /* Use MKL FFT library */
60 #cmakedefine01 GMX_FFT_MKL
62 /* Use built in fftpack FFT library */
63 #cmakedefine01 GMX_FFT_FFTPACK
65 /* Target platform is x86 or x86_64 */
66 #cmakedefine01 GMX_TARGET_X86
68 /** Define if we are building natively on Windows */
69 #cmakedefine01 GMX_NATIVE_WINDOWS
71 /** Define if we are building for Cygwin */
72 #cmakedefine01 GMX_CYGWIN
74 /* SSE2 was selected for SIMD instruction set level */
75 #cmakedefine01 GMX_SIMD_X86_SSE2
77 /* SSE4.1 was selected as SIMD instructions */
78 #cmakedefine01 GMX_SIMD_X86_SSE4_1
80 /* AVX 128-bit FMA was selected as SIMD instructions */
81 #cmakedefine01 GMX_SIMD_X86_AVX_128_FMA
83 /* AVX 256-bit was selected as SIMD instructions */
84 #cmakedefine01 GMX_SIMD_X86_AVX_256
86 /* AVX2 256-bit SIMD instruction set level was selected */
87 #cmakedefine01 GMX_SIMD_X86_AVX2_256
89 /* AVX2 128-bit SIMD instruction set level was selected */
90 #cmakedefine01 GMX_SIMD_X86_AVX2_128
92 /* MIC (Xeon Phi) SIMD instruction set level was selected */
93 #cmakedefine01 GMX_SIMD_X86_MIC
95 /* AVX-512F foundation level instruction SIMD */
96 #cmakedefine01 GMX_SIMD_X86_AVX_512
98 /* AVX-512ER foundation level instruction SIMD */
99 #cmakedefine01 GMX_SIMD_X86_AVX_512_KNL
101 /* 32-bit ARM NEON SIMD instruction set level was selected */
102 #cmakedefine01 GMX_SIMD_ARM_NEON
104 /* ARM (AArch64) NEON Advanced SIMD instruction set level was selected */
105 #cmakedefine01 GMX_SIMD_ARM_NEON_ASIMD
107 /* IBM VMX was selected as SIMD instructions (Power 6 and later) */
108 #cmakedefine01 GMX_SIMD_IBM_VMX
110 /* IBM VSX was selected as SIMD instructions (Power 7 and later) */
111 #cmakedefine01 GMX_SIMD_IBM_VSX
113 /* Fujitsu Sparc64 HPC-ACE SIMD acceleration */
114 #cmakedefine01 GMX_SIMD_SPARC64_HPC_ACE
116 /* Reference SIMD implementation for testing */
117 #cmakedefine01 GMX_SIMD_REFERENCE
119 /* String for SIMD instruction choice (for writing to log files and stdout) */
120 #define GMX_SIMD_STRING "@GMX_SIMD_ACTIVE@"
122 /* Calling convention string (if any) for routines with SIMD variable args */
123 #define gmx_simdcall @GMX_SIMD_CALLING_CONVENTION@
125 /* Target mantissa accuracy for SIMD single precision math */
126 #define GMX_SIMD_ACCURACY_BITS_SINGLE @GMX_SIMD_ACCURACY_BITS_SINGLE@
128 /* Target mantissa accuracy for SIMD double precision math */
129 #define GMX_SIMD_ACCURACY_BITS_DOUBLE @GMX_SIMD_ACCURACY_BITS_DOUBLE@
131 /* Enable code that requires AVX-512 instruction support, without GMX_SIMD=AVX_512 */
132 #cmakedefine01 SIMD_AVX_512_CXX_SUPPORTED
134 /* Whether a double-precision configuration may target accuracy equivalent to single precision */
135 #cmakedefine01 GMX_RELAXED_DOUBLE_PRECISION
137 /* Integer byte order is big endian. */
138 #cmakedefine01 GMX_INTEGER_BIG_ENDIAN
140 /* Use our own instead of system XDR libraries */
141 #cmakedefine01 GMX_INTERNAL_XDR
143 /* Compile to use TNG library */
144 #cmakedefine01 GMX_USE_TNG
146 /* Add support for tracing using Extrae */
147 #cmakedefine01 HAVE_EXTRAE
149 /* Use MPI (with mpicc) for parallelization */
150 #cmakedefine01 GMX_LIB_MPI
152 /* Use threads_mpi for parallelization */
153 #cmakedefine01 GMX_THREAD_MPI
155 /* Make a parallel version of GROMACS using message passing
156    (MPI or thread_mpi) */
157 #define GMX_MPI (GMX_LIB_MPI || GMX_THREAD_MPI)
159 /* MPI_IN_PLACE exists for collective operations */
160 #cmakedefine01 MPI_IN_PLACE_EXISTS
162 /* Use OpenMP multithreading */
163 #cmakedefine01 GMX_OPENMP
165 /* Use the Portable Hardware Locality package (hwloc) */
166 #cmakedefine01 GMX_USE_HWLOC
168 /* Can and should use nice(3) to set priority */
169 #cmakedefine01 GMX_USE_NICE
171 /* Maximum number of OpenMP threads supported */
172 #define GMX_OPENMP_MAX_THREADS @GMX_OPENMP_MAX_THREADS@
174 /* Use if we cannot rename checkpoints */
175 #cmakedefine01 GMX_NO_RENAME
177 /* Use (modified) Gamess-UK for QM-MM calculations */
178 #cmakedefine01 GMX_QMMM_GAMESS
180 /* Use (modified) Gaussian0x for QM-MM calculations */
181 #cmakedefine01 GMX_QMMM_GAUSSIAN
183 /* Use (modified) Mopac 7 for QM-MM calculations */
184 #cmakedefine01 GMX_QMMM_MOPAC
186 /* Use ORCA for QM-MM calculations */
187 #cmakedefine01 GMX_QMMM_ORCA
189 /* Use cycle counters */
190 #cmakedefine01 GMX_CYCLECOUNTERS
192 /* Use sub-counters */
193 #cmakedefine01 GMX_CYCLE_SUBCOUNTERS
195 /* Compile with plugin support */
196 #cmakedefine01 GMX_USE_PLUGINS
198 /* Fallback path for VMD plug-ins */
199 #define GMX_VMD_PLUGIN_PATH "@GMX_VMD_PLUGIN_PATH@"
201 /* Define when pthreads are used */
202 #cmakedefine THREAD_PTHREADS
204 /* Define when Windows threads are used */
205 #cmakedefine THREAD_WINDOWS
207 /* Define for busy wait option  */
208 /* See gmxpre-config.h.cmakein for explanation for the #ifndef */
209 #ifndef TMPI_WAIT_FOR_NO_ONE
210 #cmakedefine01 TMPI_WAIT_FOR_NO_ONE
211 #endif
213 /* Define for copy buffer option */
214 #cmakedefine TMPI_COPY_BUFFER
216 /* Define for tmpi warnings option */
217 #cmakedefine TMPI_WARNINGS
219 /* Define for profiling option */
220 #cmakedefine TMPI_PROFILE
222 /* Define for Linux pthread_setaffinity_np */
223 #cmakedefine HAVE_PTHREAD_SETAFFINITY
225 /* Define for X-Windows */
226 #cmakedefine01 GMX_X11
228 /* Enable x86 gcc inline assembly */
229 #cmakedefine01 GMX_X86_GCC_INLINE_ASM
231 /* Define constants useful for handling GPU support */
232 #define GMX_GPU_NONE   0
233 #define GMX_GPU_CUDA   1
234 #define GMX_GPU_OPENCL 2
235 /* Which kind of GPU support is configured */
236 #define GMX_GPU @GMX_GPU_ACCELERATION_FRAMEWORK@
238 /* CUDA runtime API version (identical to CUDART_VERSION from cuda_runtime_api.h) */
239 #cmakedefine GMX_CUDA_VERSION @GMX_CUDA_VERSION@
241 /* Use a single compilation unit when compiling the CUDA (non-bonded) kernels.  */
242 #cmakedefine01 GMX_CUDA_NB_SINGLE_COMPILATION_UNIT
244 /* Cluster size used by nonbonded OpenCL kernel. Should be 8 for NVIDIA/AMD and 4 for Intel */
245 #define GMX_OCL_NB_CLUSTER_SIZE @GMX_OCL_NB_CLUSTER_SIZE@
247 /* Define constants for build types (starting at 1 to make sure undefined values don't match) */
248 #define CMAKE_BUILD_TYPE_DEBUG 1
249 #define CMAKE_BUILD_TYPE_RELEASE 2
250 #define CMAKE_BUILD_TYPE_RELWITHDEBINFO 3
251 #define CMAKE_BUILD_TYPE_MINSIZEREL 4
252 #define CMAKE_BUILD_TYPE_REFERENCE 5
253 #define CMAKE_BUILD_TYPE_RELWITHASSERT 6
254 #define CMAKE_BUILD_TYPE_PROFILE 7
255 #define CMAKE_BUILD_TYPE_TSAN 8
256 #define CMAKE_BUILD_TYPE_ASAN 9
257 #define CMAKE_BUILD_TYPE_MSAN 10
258 #cmakedefine CMAKE_BUILD_TYPE CMAKE_BUILD_TYPE_@CMAKE_BUILD_TYPE_UPPER@
260 /* Define relative path to OpenCL kernels */
261 #define GMX_INSTALL_OCLDIR "@GMX_INSTALL_OCLDIR@"
263 /* Define to 1 if fseeko (and presumably ftello) exists and is declared. */
264 #cmakedefine01 HAVE_FSEEKO
266 /* Define to 1 if _fseeki64 (and presumably _fseeki64) exists and is declared. */
267 #cmakedefine01 HAVE__FSEEKI64
269 /* Have io.h (windows)*/
270 #cmakedefine01 HAVE_IO_H
272 /* Define to 1 if you have the posix_memalign() function. */
273 #cmakedefine01 HAVE_POSIX_MEMALIGN
275 /* Define to 1 if you have the memalign() function. */
276 #cmakedefine01 HAVE_MEMALIGN
278 /* Define to 1 if you have the MSVC _aligned_malloc() function. */
279 #cmakedefine01 HAVE__ALIGNED_MALLOC
281 /* Define to 1 if you have the clock_gettime() function. */
282 #cmakedefine01 HAVE_CLOCK_GETTIME
284 /* Define to 1 if you have the gettimeofday() function. */
285 #cmakedefine01 HAVE_GETTIMEOFDAY
287 /* Define to 1 if you have the rdtscp instruction. */
288 #cmakedefine01 HAVE_RDTSCP
290 /* Define to 1 if you have the fsync() function. */
291 #cmakedefine01 HAVE_FSYNC
293 /* Define to 1 if you have the Windows _commit() function. */
294 #cmakedefine01 HAVE__COMMIT
296 /* Define to 1 if you have the fileno() function. */
297 #cmakedefine01 HAVE_FILENO
299 /* Define to 1 if you have the _fileno() function. */
300 #cmakedefine01 HAVE__FILENO
302 /* Define to 1 if you have the sigaction() function. */
303 #cmakedefine01 HAVE_SIGACTION
305 /* Define for the GNU __builtin_clz() function. */
306 #cmakedefine01 HAVE_BUILTIN_CLZ
308 /* Define for the GNU __builtin_clzll() function. */
309 #cmakedefine01 HAVE_BUILTIN_CLZLL
311 /* Define for the MSVC _BitScanReverse() function. */
312 #cmakedefine01 HAVE_BITSCANREVERSE
314 /* Define for the MSVC _BitScanReverse64() function. */
315 #cmakedefine01 HAVE_BITSCANREVERSE64
317 /* Define for the IBM xlc++ __cntlz4() function. */
318 #cmakedefine01 HAVE_CNTLZ4
320 /* Define for the IBM xlc++ __cntlz8() function. */
321 #cmakedefine01 HAVE_CNTLZ8
323 /* Define to 1 if yo have the <unistd.h> header file. */
324 #cmakedefine HAVE_UNISTD_H
325 #  ifdef __APPLE__
326 // Mac OS 13.x has a bug where dispatch.h generates an error for OpenCL builds if
327 // HAVE_UNISTD_H is merely defined, but not set to 1. Since unistd.h should always
328 // be available on this platform we simply undefine and redefine it to 1 for now
329 #    undef  HAVE_UNISTD_H
330 #    define HAVE_UNISTD_H 1
331 #endif
333 /* Define to 1 if yo have the <pwd.h> header file. */
334 #cmakedefine01 HAVE_PWD_H
336 /* Define to 1 if yo have the <dirent.h> header file. */
337 #cmakedefine01 HAVE_DIRENT_H
339 /* Define to 1 if you have the <sys/time.h> header file. */
340 #cmakedefine HAVE_SYS_TIME_H
342 /* Define to 1 if you have the <sched.h> header */
343 #cmakedefine HAVE_SCHED_H
345 /* Define to 1 if mm_malloc.h is present, otherwise 0 */
346 #cmakedefine01 HAVE_MM_MALLOC_H
348 /* Define to 1 if malloc.h is present, otherwise 0 */
349 #cmakedefine01 HAVE_MALLOC_H
351 /* Define to 1 if xmmintrin.h is present, otherwise 0 */
352 #cmakedefine01 HAVE_XMMINTRIN_H
354 /* Define to 1 if you have the POSIX <regex.h> header file. */
355 #cmakedefine01 HAVE_POSIX_REGEX
357 /* Define to 1 if you have the C++11 <regex> header file. */
358 #cmakedefine01 HAVE_CXX11_REGEX
360 /* Define to 1 if you have the sysconf() function */
361 #cmakedefine HAVE_SYSCONF
363 /* Define to 1 if you have the all the affinity functions in sched.h */
364 #cmakedefine01 HAVE_SCHED_AFFINITY
366 /* Define to 1 if _mm_malloc() is present in either mm_malloc.h,
367  * malloc.h or xmmintrin.h, and 0 otherwise. Note that you need to
368  * conditionally include the three headers too before using _mm_malloc().
369  */
370 #cmakedefine01 HAVE__MM_MALLOC
372 /* Define if SIGUSR1 is present */
373 #cmakedefine01 HAVE_SIGUSR1
375 /* Enable gromacs quotes */
376 #cmakedefine01 GMX_COOL_QUOTES
378 /* default name mangling maybe wrong on exotic plattforms */
379 #define F77_FUNC(name,NAME) name ## _
381 /* Define if we have pipes */
382 #cmakedefine01 HAVE_PIPES
384 /* Define if we have feenableexcept */
385 #cmakedefine01 HAVE_FEENABLEEXCEPT
387 /* Define if we have fedisableexcept */
388 #cmakedefine01 HAVE_FEDISABLEEXCEPT
390 /* Define if we have lmfit support */
391 #cmakedefine01 HAVE_LMFIT
393 /* Build using clang analyzer */
394 #cmakedefine01 GMX_CLANG_ANALYZER
396 /* Use MiMiC QM/MM interface */
397 #cmakedefine01 GMX_MIMIC
399 /*! \endcond */
401 #endif