2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015,2016, 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.
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.
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.
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.
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.
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.
39 * Basic types and macros used throughout \Gromacs.
42 * \ingroup module_utility
44 #ifndef GMX_UTILITY_BASEDEFINITIONS_H
45 #define GMX_UTILITY_BASEDEFINITIONS_H
53 * Boolean type for use in \Gromacs C code.
55 * There is no standard size for 'bool' in C++, so when
56 * we previously defined it to int for C code the data types
57 * (and structs) would have different size depending on your compiler,
58 * both at \Gromacs build time and when you use the library.
59 * The only way around this is to NOT assume anything about the C++ type,
60 * so we cannot use the name 'bool' in our C code anymore.
65 /** False value for ::gmx_bool. */
69 /** True value for ::gmx_bool. */
72 /** Number of gmx_bool values. */
75 /*! \name Fixed-width integer types
77 * These types and macros provide the equivalent of 32- and 64-bit integer
78 * types from C99 headers `stdint.h` and `inttypes.h`. These headers are also
79 * there in C++11. The types and macros from here should be used instead of
81 * MSVC doesn't support these before Visual Studio 2013.
85 typedef __int32 gmx_int32_t;
86 #define GMX_PRId32 "I32d"
87 #define GMX_SCNd32 "I32d"
89 typedef __int64 gmx_int64_t;
90 #define GMX_PRId64 "I64d"
91 #define GMX_SCNd64 "I64d"
93 typedef unsigned __int32 gmx_uint32_t;
94 #define GMX_PRIu32 "I32u"
95 #define GMX_SCNu32 "I32u"
97 typedef unsigned __int64 gmx_uint64_t;
98 #define GMX_PRIu64 "I64u"
99 #define GMX_SCNu64 "I64u"
101 typedef int32_t gmx_int32_t;
102 #define GMX_PRId32 PRId32
103 #define GMX_SCNd32 SCNd32
105 typedef int64_t gmx_int64_t;
106 #define GMX_PRId64 PRId64
107 #define GMX_SCNd64 SCNd64
109 typedef uint32_t gmx_uint32_t;
110 #define GMX_PRIu32 PRIu32
111 #define GMX_SCNu32 SCNu32
113 typedef uint64_t gmx_uint64_t;
114 #define GMX_PRIu64 PRIu64
115 #define GMX_SCNu64 SCNu64
118 #define GMX_INT32_MAX INT32_MAX
119 #define GMX_INT32_MIN INT32_MIN
121 #define GMX_INT64_MAX INT64_MAX
122 #define GMX_INT64_MIN INT64_MIN
124 #define GMX_UINT32_MAX UINT32_MAX
125 #define GMX_UINT32_MIN UINT32_MIN
127 #define GMX_UINT64_MAX UINT64_MAX
128 #define GMX_UINT64_MIN UINT64_MIN
133 * Keyword to use in C code instead of C99 `inline`.
135 * Some of the C compilers we support do not recognize the C99 keyword
136 * `inline`. This macro should be used in C code and in shared C/C++ headers
137 * to indicate a function is inlined.
138 * C++ code should use plain `inline`, as that is already in C++98.
140 #if !defined __cplusplus && defined _MSC_VER
141 #define gmx_inline __inline
144 #define gmx_inline inline
147 /* ICC, GCC, MSVC, Pathscale, PGI, XLC support __restrict.
148 * Any other compiler can be added here. */
150 * Keyword to use in instead of C99 `restrict`.
152 * We cannot use `restrict` because it is only in C99, but not in C++.
153 * This macro should instead be used to allow easily supporting different
156 #define gmx_restrict __restrict
158 /*! \def GMX_CXX11_COMPILATION
160 * Defined to 1 when compiling as C++11.
162 * While \Gromacs only supports C++11 compilation, there are some parts of the
163 * code that are compiled with other tools than the actual C++ compiler, and
164 * these may not support C++11. Most notable such case is all of CUDA code
165 * (with CUDA versions older than 6.5), but other types of kernels might also
166 * have similar limitations in the future.
168 * The define is intended for conditional compilation in low-level headers that
169 * need to support inclusion from such non-C++11 files, but get significant
170 * benefit (e.g., for correctness checking or more convenient use) from C++11.
171 * It should only be used for features that do not influence the ABI of the
172 * header; e.g., static_asserts or additional helper methods.
174 #if defined __cplusplus && __cplusplus >= 201103L
175 # define GMX_CXX11_COMPILATION 1
177 # define GMX_CXX11_COMPILATION 0
182 * Attribute to suppress compiler warnings about unused function parameters.
184 * This attribute suppresses compiler warnings about unused function arguments
185 * by marking them as possibly unused. Some arguments are unused but
186 * have to be retained to preserve a function signature
187 * that must match that of another function.
188 * Some arguments are only used in *some* conditional compilation code paths
193 /* GCC, clang, and some ICC pretending to be GCC */
194 # define gmx_unused __attribute__ ((unused))
195 #elif (defined(__INTEL_COMPILER) || defined(__ECC)) && !defined(_MSC_VER)
197 # define gmx_unused __attribute__ ((unused))
199 /* Portland group compilers */
200 # define gmx_unused __attribute__ ((unused))
201 #elif defined _MSC_VER
203 # define gmx_unused /*@unused@*/
204 #elif defined(__xlC__)
206 # define gmx_unused __attribute__ ((unused))
212 #ifndef __has_feature
213 /** For compatibility with non-clang compilers. */
214 #define __has_feature(x) 0
217 /*! \def gmx_noreturn
219 * Indicate that a function is not expected to return.
222 #if defined(__GNUC__) || __has_feature(attribute_analyzer_noreturn)
223 #define gmx_noreturn __attribute__((noreturn))
224 #elif defined (_MSC_VER)
225 #define gmx_noreturn __declspec(noreturn)
231 /*! \def gmx_constexpr
232 * \brief C++11 constexpr everywhere except MSVC 2013, where it is empty.
234 * Support for constexpr was not added until MSVC 2015.
235 * Since interacting with parts of libc++ and libstdc++ depend on it
236 * (for instance the min/max calls in our random engines), we need to specify it
237 * for other compilers.
239 #ifndef gmx_constexpr
240 #if (!defined(_MSC_VER) || (defined(_MSC_FULL_VER) && _MSC_FULL_VER >= 190023026))
241 # define gmx_constexpr constexpr
243 # define gmx_constexpr
247 /*! \def GMX_ALIGNED(type, alignment)
249 * Declare variable with data alignment
251 * \param[in] type Type of variable
252 * \param[in] alignment Alignment in multiples of type
256 GMX_ALIGNED(real, GMX_SIMD_REAL_WIDTH) buf[...];
260 #if defined(_MSC_VER) && (_MSC_VER <= 1800) && !defined(__ICL)
261 // For MSVC2013 and eariler we use a hack and assume an alignment of 128 bytes is sufficient in all cases
262 # define GMX_ALIGNED(type, alignment) __declspec(align(128)) type
263 #elif defined(__GNUC__) || defined(__clang__) || defined(__ibmxl__) || defined(__xlC__) || defined(__PATHCC__)
264 // Gcc-4.6.4 does not support alignas, but both gcc, clang, pathscale and xlc
265 // support the standard GNU alignment attributes. PGI also sets __GNUC__ now,
266 // and mostly supports it.
267 # define GMX_ALIGNED(type, alignment) __attribute__ ((aligned(alignment*sizeof(type)))) type
269 // If nothing else works we rely on C++11. This will for instance work for MSVC2015 and later.
270 // If you get an error here, find out what attribute to use to get your compiler to align
271 // data properly and add it as a case.
272 # define GMX_ALIGNED(type, alignment) alignas(alignment*alignof(type)) type
277 * Macro to explicitly ignore an unused value.
279 * \ingroup module_utility
281 #define GMX_UNUSED_VALUE(value) (void)value
288 /*! \cond internal */
290 * Helper for ignoring values in macros.
292 * \ingroup module_utility
294 template <typename T>
295 static inline void ignoreValueHelper(const T &)
299 } // namespace internal
303 * Macro to explicitly ignore a return value of a call.
305 * Mainly meant for ignoring values of functions declared with
306 * `__attribute__((warn_unused_return))`. Makes it easy to find those places if
307 * they need to be fixed, and document the intent in cases where the return
308 * value really can be ignored. It also makes it easy to adapt the approach so
309 * that they don't produce warnings. A cast to void doesn't remove the warning
310 * in gcc, while adding a dummy variable can cause warnings about an unused
313 * \ingroup module_utility
315 #define GMX_IGNORE_RETURN_VALUE(call) \
316 ::gmx::internal::ignoreValueHelper(call)