Split lines with many copyright years
[alexxy/gromacs.git] / src / config.h.cmakein
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2009,2010,2011,2012,2013 by the GROMACS development team.
5  * Copyright (c) 2014,2015,2016,2017,2018 by the GROMACS development team.
6  * Copyright (c) 2019,2020, by the GROMACS development team, led by
7  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8  * and including many others, as listed in the AUTHORS file in the
9  * top-level source directory and at http://www.gromacs.org.
10  *
11  * GROMACS is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU Lesser General Public License
13  * as published by the Free Software Foundation; either version 2.1
14  * of the License, or (at your option) any later version.
15  *
16  * GROMACS is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19  * Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public
22  * License along with GROMACS; if not, see
23  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
25  *
26  * If you want to redistribute modifications to GROMACS, please
27  * consider that scientific software is very special. Version
28  * control is crucial - bugs must be traceable. We will be happy to
29  * consider code for inclusion in the official distribution, but
30  * derived work must not be called official GROMACS. Details are found
31  * in the README & COPYING files - if they are missing, get the
32  * official version at http://www.gromacs.org.
33  *
34  * To help us fund GROMACS development, we humbly ask that you cite
35  * the research papers on the package. Check out http://www.gromacs.org.
36  */
37 /*! \libinternal \file
38  * \brief
39  * Include file for configuration macros from the build system.
40  *
41  * This header is not installed, so headers must not reference macros defined
42  * here.
43  *
44  * \inlibraryapi
45  */
46 #ifndef GMX_CONFIG_H
47 #define GMX_CONFIG_H
48
49 /* TODO: For now, disable Doxygen warnings from here */
50 /*! \cond */
51
52 /* Work around broken calloc() */
53 #cmakedefine01 GMX_BROKEN_CALLOC
54
55 /* Do not optimize FFTW setups (not needed with SSE FFT kernels) */
56 #cmakedefine01 GMX_DISABLE_FFTW_MEASURE
57
58 /* Use FFTW3 FFT library */
59 #cmakedefine01 GMX_FFT_FFTW3
60
61 /* Use the ARM Performance library with FFTW3 compatibility */
62 #cmakedefine01 GMX_FFT_ARMPL_FFTW3
63
64 /* Use MKL FFT library */
65 #cmakedefine01 GMX_FFT_MKL
66
67 /* Use built in fftpack FFT library */
68 #cmakedefine01 GMX_FFT_FFTPACK
69
70 /* Target platform is x86 or x86_64 */
71 #cmakedefine01 GMX_TARGET_X86
72
73 /** Define if we are building natively on Windows */
74 #cmakedefine01 GMX_NATIVE_WINDOWS
75
76 /** Define if we are building for Cygwin */
77 #cmakedefine01 GMX_CYGWIN
78
79 /* SSE2 was selected for SIMD instruction set level */
80 #cmakedefine01 GMX_SIMD_X86_SSE2
81
82 /* SSE4.1 was selected as SIMD instructions */
83 #cmakedefine01 GMX_SIMD_X86_SSE4_1
84
85 /* AVX 128-bit FMA was selected as SIMD instructions */
86 #cmakedefine01 GMX_SIMD_X86_AVX_128_FMA
87
88 /* AVX 256-bit was selected as SIMD instructions */
89 #cmakedefine01 GMX_SIMD_X86_AVX_256
90
91 /* AVX2 256-bit SIMD instruction set level was selected */
92 #cmakedefine01 GMX_SIMD_X86_AVX2_256
93
94 /* AVX2 128-bit SIMD instruction set level was selected */
95 #cmakedefine01 GMX_SIMD_X86_AVX2_128
96
97 /* MIC (Xeon Phi) SIMD instruction set level was selected */
98 #cmakedefine01 GMX_SIMD_X86_MIC
99
100 /* AVX-512F foundation level instruction SIMD */
101 #cmakedefine01 GMX_SIMD_X86_AVX_512
102
103 /* AVX-512ER foundation level instruction SIMD */
104 #cmakedefine01 GMX_SIMD_X86_AVX_512_KNL
105
106 /* 32-bit ARM NEON SIMD instruction set level was selected */
107 #cmakedefine01 GMX_SIMD_ARM_NEON
108
109 /* ARM (AArch64) NEON Advanced SIMD instruction set level was selected */
110 #cmakedefine01 GMX_SIMD_ARM_NEON_ASIMD
111
112 /* IBM VMX was selected as SIMD instructions (Power 6 and later) */
113 #cmakedefine01 GMX_SIMD_IBM_VMX
114
115 /* IBM VSX was selected as SIMD instructions (Power 7 and later) */
116 #cmakedefine01 GMX_SIMD_IBM_VSX
117
118 /* Fujitsu Sparc64 HPC-ACE SIMD acceleration */
119 #cmakedefine01 GMX_SIMD_SPARC64_HPC_ACE
120
121 /* Reference SIMD implementation for testing */
122 #cmakedefine01 GMX_SIMD_REFERENCE
123
124 /* String for SIMD instruction choice (for writing to log files and stdout) */
125 #define GMX_SIMD_STRING "@GMX_SIMD_ACTIVE@"
126
127 /* Calling convention string (if any) for routines with SIMD variable args */
128 #define gmx_simdcall @GMX_SIMD_CALLING_CONVENTION@
129
130 /* Target mantissa accuracy for SIMD single precision math */
131 #define GMX_SIMD_ACCURACY_BITS_SINGLE @GMX_SIMD_ACCURACY_BITS_SINGLE@
132
133 /* Target mantissa accuracy for SIMD double precision math */
134 #define GMX_SIMD_ACCURACY_BITS_DOUBLE @GMX_SIMD_ACCURACY_BITS_DOUBLE@
135
136 /* Enable code that requires AVX-512 instruction support, without GMX_SIMD=AVX_512 */
137 #cmakedefine01 SIMD_AVX_512_CXX_SUPPORTED
138
139 /* Whether a double-precision configuration may target accuracy equivalent to single precision */
140 #cmakedefine01 GMX_RELAXED_DOUBLE_PRECISION
141
142 /* Integer byte order is big endian. */
143 #cmakedefine01 GMX_INTEGER_BIG_ENDIAN
144
145 /* Use our own instead of system XDR libraries */
146 #cmakedefine01 GMX_INTERNAL_XDR
147
148 /* Compile to use TNG library */
149 #cmakedefine01 GMX_USE_TNG
150
151 /* Add support for tracing using Extrae */
152 #cmakedefine01 HAVE_EXTRAE
153
154 /* Use MPI (with mpicc) for parallelization */
155 #cmakedefine01 GMX_LIB_MPI
156
157 /* Use threads_mpi for parallelization */
158 #cmakedefine01 GMX_THREAD_MPI
159
160 /* Make a parallel version of GROMACS using message passing
161    (MPI or thread_mpi) */
162 #define GMX_MPI (GMX_LIB_MPI || GMX_THREAD_MPI)
163
164 /* MPI_IN_PLACE exists for collective operations */
165 #cmakedefine01 MPI_IN_PLACE_EXISTS
166
167 /* Use OpenMP multithreading */
168 #cmakedefine01 GMX_OPENMP
169
170 /* Use the Portable Hardware Locality package (hwloc) */
171 #cmakedefine01 GMX_USE_HWLOC
172
173 /* Library version found for hwloc during configuration time */
174 #define GMX_HWLOC_API_VERSION @GMX_HWLOC_API_VERSION@
175
176 /* Can and should use nice(3) to set priority */
177 #cmakedefine01 GMX_USE_NICE
178
179 /* Maximum number of OpenMP threads supported */
180 #define GMX_OPENMP_MAX_THREADS @GMX_OPENMP_MAX_THREADS@
181
182 /* Use if we cannot rename checkpoints */
183 #cmakedefine01 GMX_NO_RENAME
184
185 /* Use (modified) Gamess-UK for QM-MM calculations */
186 #cmakedefine01 GMX_QMMM_GAMESS
187
188 /* Use (modified) Gaussian0x for QM-MM calculations */
189 #cmakedefine01 GMX_QMMM_GAUSSIAN
190
191 /* Use (modified) Mopac 7 for QM-MM calculations */
192 #cmakedefine01 GMX_QMMM_MOPAC
193
194 /* Use ORCA for QM-MM calculations */
195 #cmakedefine01 GMX_QMMM_ORCA
196
197 /* Use sub-counters */
198 #cmakedefine01 GMX_CYCLE_SUBCOUNTERS
199
200 /* Compile with plugin support */
201 #cmakedefine01 GMX_USE_PLUGINS
202
203 /* Fallback path for VMD plug-ins */
204 #define GMX_VMD_PLUGIN_PATH "@GMX_VMD_PLUGIN_PATH@"
205
206 /* Define when pthreads are used */
207 #cmakedefine THREAD_PTHREADS
208
209 /* Define when Windows threads are used */
210 #cmakedefine THREAD_WINDOWS
211
212 /* Define for busy wait option  */
213 /* See gmxpre-config.h.cmakein for explanation for the #ifndef */
214 #ifndef TMPI_WAIT_FOR_NO_ONE
215 #cmakedefine01 TMPI_WAIT_FOR_NO_ONE
216 #endif
217
218 /* Define for copy buffer option */
219 #cmakedefine TMPI_COPY_BUFFER
220
221 /* Define for tmpi warnings option */
222 #cmakedefine TMPI_WARNINGS
223
224 /* Define for profiling option */
225 #cmakedefine TMPI_PROFILE
226
227 /* Define for Linux pthread_setaffinity_np */
228 #cmakedefine HAVE_PTHREAD_SETAFFINITY
229
230 /* Define for X-Windows */
231 #cmakedefine01 GMX_X11
232
233 /* Enable x86 gcc inline assembly */
234 #cmakedefine01 GMX_X86_GCC_INLINE_ASM
235
236 /* Define constants useful for handling GPU support */
237 #define GMX_GPU_NONE   0
238 #define GMX_GPU_CUDA   1
239 #define GMX_GPU_OPENCL 2
240 /* Which kind of GPU support is configured */
241 #define GMX_GPU @GMX_GPU_ACCELERATION_FRAMEWORK@
242
243 /* Use a single compilation unit when compiling the CUDA (non-bonded) kernels.  */
244 #cmakedefine01 GMX_CUDA_NB_SINGLE_COMPILATION_UNIT
245
246 /* Cluster size used by nonbonded OpenCL kernel. Should be 8 for NVIDIA/AMD and 4 for Intel */
247 #define GMX_OPENCL_NB_CLUSTER_SIZE @GMX_OPENCL_NB_CLUSTER_SIZE@
248
249 /* Define constants for build types (starting at 1 to make sure undefined values don't match) */
250 #define CMAKE_BUILD_TYPE_DEBUG 1
251 #define CMAKE_BUILD_TYPE_RELEASE 2
252 #define CMAKE_BUILD_TYPE_RELWITHDEBINFO 3
253 #define CMAKE_BUILD_TYPE_MINSIZEREL 4
254 #define CMAKE_BUILD_TYPE_REFERENCE 5
255 #define CMAKE_BUILD_TYPE_RELWITHASSERT 6
256 #define CMAKE_BUILD_TYPE_PROFILE 7
257 #define CMAKE_BUILD_TYPE_TSAN 8
258 #define CMAKE_BUILD_TYPE_ASAN 9
259 #define CMAKE_BUILD_TYPE_MSAN 10
260 #cmakedefine CMAKE_BUILD_TYPE CMAKE_BUILD_TYPE_@CMAKE_BUILD_TYPE_UPPER@
261
262 /* Define relative path to OpenCL kernels */
263 #define GMX_INSTALL_OCLDIR "@GMX_INSTALL_OCLDIR@"
264
265 /* Minimum required OpenCL version support (both API and device) - split into integer components for convenience */
266 #define REQUIRED_OPENCL_MIN_VERSION_MAJOR @REQUIRED_OPENCL_MIN_VERSION_MAJOR@
267 #define REQUIRED_OPENCL_MIN_VERSION_MINOR @REQUIRED_OPENCL_MIN_VERSION_MINOR@
268
269 /* Define to 1 if fseeko (and presumably ftello) exists and is declared. */
270 #cmakedefine01 HAVE_FSEEKO
271
272 /* Define to 1 if _fseeki64 (and presumably _fseeki64) exists and is declared. */
273 #cmakedefine01 HAVE__FSEEKI64
274
275 /* Have io.h (windows)*/
276 #cmakedefine01 HAVE_IO_H
277
278 /* Define to 1 if you have the posix_memalign() function. */
279 #cmakedefine01 HAVE_POSIX_MEMALIGN
280
281 /* Define to 1 if you have the memalign() function. */
282 #cmakedefine01 HAVE_MEMALIGN
283
284 /* Define to 1 if you have the MSVC _aligned_malloc() function. */
285 #cmakedefine01 HAVE__ALIGNED_MALLOC
286
287 /* Define to 1 if you have the clock_gettime() function. */
288 #cmakedefine01 HAVE_CLOCK_GETTIME
289
290 /* Define to 1 if you have the gettimeofday() function. */
291 #cmakedefine01 HAVE_GETTIMEOFDAY
292
293 /* Define to 1 if you have the rdtscp instruction. */
294 #cmakedefine01 HAVE_RDTSCP
295
296 /* Define to 1 if you have the fsync() function. */
297 #cmakedefine01 HAVE_FSYNC
298
299 /* Define to 1 if you have the Windows _commit() function. */
300 #cmakedefine01 HAVE__COMMIT
301
302 /* Define to 1 if you have the fileno() function. */
303 #cmakedefine01 HAVE_FILENO
304
305 /* Define to 1 if you have the _fileno() function. */
306 #cmakedefine01 HAVE__FILENO
307
308 /* Define to 1 if you have the sigaction() function. */
309 #cmakedefine01 HAVE_SIGACTION
310
311 /* Define for the GNU __builtin_clz() function. */
312 #cmakedefine01 HAVE_BUILTIN_CLZ
313
314 /* Define for the GNU __builtin_clzll() function. */
315 #cmakedefine01 HAVE_BUILTIN_CLZLL
316
317 /* Define for the MSVC _BitScanReverse() function. */
318 #cmakedefine01 HAVE_BITSCANREVERSE
319
320 /* Define for the MSVC _BitScanReverse64() function. */
321 #cmakedefine01 HAVE_BITSCANREVERSE64
322
323 /* Define for the IBM xlc++ __cntlz4() function. */
324 #cmakedefine01 HAVE_CNTLZ4
325
326 /* Define for the IBM xlc++ __cntlz8() function. */
327 #cmakedefine01 HAVE_CNTLZ8
328
329 /* Define to 1 if yo have the <unistd.h> header file. */
330 #cmakedefine HAVE_UNISTD_H
331 #  ifdef __APPLE__
332 // Mac OS 13.x has a bug where dispatch.h generates an error for OpenCL builds if
333 // HAVE_UNISTD_H is merely defined, but not set to 1. Since unistd.h should always
334 // be available on this platform we simply undefine and redefine it to 1 for now
335 #    undef  HAVE_UNISTD_H
336 #    define HAVE_UNISTD_H 1
337 #endif
338
339 /* Define to 1 if yo have the <pwd.h> header file. */
340 #cmakedefine01 HAVE_PWD_H
341
342 /* Define to 1 if yo have the <dirent.h> header file. */
343 #cmakedefine01 HAVE_DIRENT_H
344
345 /* Define to 1 if you have the <sys/time.h> header file. */
346 #cmakedefine HAVE_SYS_TIME_H
347
348 /* Define to 1 if you have the <sched.h> header */
349 #cmakedefine HAVE_SCHED_H
350
351 /* Define to 1 if mm_malloc.h is present, otherwise 0 */
352 #cmakedefine01 HAVE_MM_MALLOC_H
353
354 /* Define to 1 if malloc.h is present, otherwise 0 */
355 #cmakedefine01 HAVE_MALLOC_H
356
357 /* Define to 1 if xmmintrin.h is present, otherwise 0 */
358 #cmakedefine01 HAVE_XMMINTRIN_H
359
360 /* Define to 1 if you have the sysconf() function */
361 #cmakedefine HAVE_SYSCONF
362
363 /* Define to 1 if you have the all the affinity functions in sched.h */
364 #cmakedefine01 HAVE_SCHED_AFFINITY
365
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
371
372 /* Define if SIGUSR1 is present */
373 #cmakedefine01 HAVE_SIGUSR1
374
375 /* Enable gromacs quotes */
376 #cmakedefine01 GMX_COOL_QUOTES
377
378 /* default name mangling maybe wrong on exotic plattforms */
379 #define F77_FUNC(name,NAME) name ## _
380
381 /* Define if we have pipes */
382 #cmakedefine01 HAVE_PIPES
383
384 /* Define if we have feenableexcept */
385 #cmakedefine01 HAVE_FEENABLEEXCEPT
386
387 /* Define if we have fedisableexcept */
388 #cmakedefine01 HAVE_FEDISABLEEXCEPT
389
390 /* Define if we have lmfit support */
391 #cmakedefine01 HAVE_LMFIT
392
393 /* Build using clang analyzer */
394 #cmakedefine01 GMX_CLANG_ANALYZER
395
396 /* Use MiMiC QM/MM interface */
397 #cmakedefine01 GMX_MIMIC
398
399 /* Use Interactive Molecular Dynamics */
400 #cmakedefine01 GMX_IMD
401
402 /*! \endcond */
403
404 #endif