Get rid of monotonicallyIncreasingTimeMS and start using std::chrono instead
[WebKit-https.git] / Source / WTF / wtf / Compiler.h
1 /*
2  * Copyright (C) 2011, 2012, 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef WTF_Compiler_h
27 #define WTF_Compiler_h
28
29 /* COMPILER() - the compiler being used to build the project */
30 #define COMPILER(WTF_FEATURE) (defined WTF_COMPILER_##WTF_FEATURE  && WTF_COMPILER_##WTF_FEATURE)
31
32 /* COMPILER_SUPPORTS() - whether the compiler being used to build the project supports the given feature. */
33 #define COMPILER_SUPPORTS(WTF_COMPILER_FEATURE) (defined WTF_COMPILER_SUPPORTS_##WTF_COMPILER_FEATURE  && WTF_COMPILER_SUPPORTS_##WTF_COMPILER_FEATURE)
34
35 /* COMPILER_QUIRK() - whether the compiler being used to build the project requires a given quirk. */
36 #define COMPILER_QUIRK(WTF_COMPILER_QUIRK) (defined WTF_COMPILER_QUIRK_##WTF_COMPILER_QUIRK  && WTF_COMPILER_QUIRK_##WTF_COMPILER_QUIRK)
37
38 /* ==== COMPILER() - primary detection of the compiler being used to build the project, in alphabetical order ==== */
39
40 /* COMPILER(CLANG) - Clang  */
41
42 #if defined(__clang__)
43 #define WTF_COMPILER_CLANG 1
44 #define WTF_COMPILER_SUPPORTS_BLOCKS __has_feature(blocks)
45 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT __has_feature(c_static_assert)
46 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS __has_feature(cxx_reference_qualified_functions)
47 #define WTF_COMPILER_SUPPORTS_CXX_GENERALIZED_INITIALIZERS __has_feature(cxx_generalized_initializers)
48 #define WTF_COMPILER_SUPPORTS_CXX_CONSTEXPR __has_feature(cxx_constexpr)
49 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS __has_feature(cxx_user_literals)
50 #endif
51
52 /* COMPILER(GCC) - GNU Compiler Collection */
53
54 /* Note: This section must come after the Clang section since we check !COMPILER(CLANG) here. */
55
56 #if defined(__GNUC__)
57 #define WTF_COMPILER_GCC 1
58 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
59 #define GCC_VERSION_AT_LEAST(major, minor, patch) (GCC_VERSION >= (major * 10000 + minor * 100 + patch))
60
61 #endif
62
63 /* Define GCC_VERSION_AT_LEAST for all compilers, so we can write things like GCC_VERSION_AT_LEAST(4, 1, 0). */
64 /* FIXME: Doesn't seem all that valuable. Can we remove this? */
65 #if !defined(GCC_VERSION_AT_LEAST)
66 #define GCC_VERSION_AT_LEAST(major, minor, patch) 0
67 #endif
68
69 #if COMPILER(GCC) && !COMPILER(CLANG) && !GCC_VERSION_AT_LEAST(4, 7, 0)
70 #error "Please use a newer version of GCC. WebKit requires GCC 4.7.0 or newer to compile."
71 #endif
72
73 #if COMPILER(GCC) && !COMPILER(CLANG)
74 #define WTF_COMPILER_SUPPORTS_CXX_CONSTEXPR 1
75 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS 1
76 #endif
77
78 #if COMPILER(GCC) && !COMPILER(CLANG) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
79 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT 1
80 #endif
81
82 #if COMPILER(GCC) && !COMPILER(CLANG) && GCC_VERSION_AT_LEAST(4, 8, 0)
83 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
84 #endif
85
86 #if COMPILER(GCC) && !COMPILER(CLANG) && (defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(__cplusplus) && __cplusplus >= 201103L))
87 #pragma GCC diagnostic ignored "-Wunused-local-typedefs"
88 #endif
89
90 /* COMPILER(MINGW) - MinGW GCC */
91
92 #if defined(__MINGW32__)
93 #define WTF_COMPILER_MINGW 1
94 #include <_mingw.h>
95 #endif
96
97 /* COMPILER(MINGW64) - mingw-w64 GCC - used as additional check to exclude mingw.org specific functions */
98
99 /* Note: This section must come after the MinGW section since we check COMPILER(MINGW) here. */
100
101 #if COMPILER(MINGW) && defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
102 #define WTF_COMPILER_MINGW64 1
103 #endif
104
105 /* COMPILER(MSVC) - Microsoft Visual C++ */
106
107 #if defined(_MSC_VER)
108 #define WTF_COMPILER_MSVC 1
109 #define WTF_COMPILER_SUPPORTS_CXX_GENERALIZED_INITIALIZERS 1
110 #endif
111
112 #if defined(_MSC_VER) && _MSC_VER < 1800
113 #error "Please use a newer version of Visual Studio. WebKit requires VS2013 or newer to compile."
114 #endif
115
116 /* COMPILER(SUNCC) */
117
118 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
119 #define WTF_COMPILER_SUNCC 1
120 #endif
121
122 /* ==== COMPILER_SUPPORTS - additional compiler feature detection, in alphabetical order ==== */
123
124 /* COMPILER_SUPPORTS(EABI) */
125
126 #if defined(__ARM_EABI__) || defined(__EABI__)
127 #define WTF_COMPILER_SUPPORTS_EABI 1
128 #endif
129
130 /* ==== Compiler-independent macros for various compiler features ==== */
131
132 /* ALWAYS_INLINE */
133
134 #if !defined(ALWAYS_INLINE) && COMPILER(GCC) && defined(NDEBUG) && !COMPILER(MINGW)
135 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
136 #endif
137
138 #if !defined(ALWAYS_INLINE) && COMPILER(MSVC) && defined(NDEBUG)
139 #define ALWAYS_INLINE __forceinline
140 #endif
141
142 #if !defined(ALWAYS_INLINE)
143 #define ALWAYS_INLINE inline
144 #endif
145
146 /* LIKELY */
147
148 #if !defined(LIKELY) && COMPILER(GCC)
149 #define LIKELY(x) __builtin_expect(!!(x), 1)
150 #endif
151
152 #if !defined(LIKELY)
153 #define LIKELY(x) (x)
154 #endif
155
156 /* NEVER_INLINE */
157
158 #if !defined(NEVER_INLINE) && COMPILER(GCC)
159 #define NEVER_INLINE __attribute__((__noinline__))
160 #endif
161
162 #if !defined(NEVER_INLINE) && COMPILER(MSVC)
163 #define NEVER_INLINE __declspec(noinline)
164 #endif
165
166 #if !defined(NEVER_INLINE)
167 #define NEVER_INLINE
168 #endif
169
170 /* NO_RETURN */
171
172 #if !defined(NO_RETURN) && COMPILER(GCC)
173 #define NO_RETURN __attribute((__noreturn__))
174 #endif
175
176 #if !defined(NO_RETURN) && COMPILER(MSVC)
177 #define NO_RETURN __declspec(noreturn)
178 #endif
179
180 #if !defined(NO_RETURN)
181 #define NO_RETURN
182 #endif
183
184 /* NO_RETURN_WITH_VALUE */
185
186 #if !defined(NO_RETURN_WITH_VALUE) && !COMPILER(MSVC)
187 #define NO_RETURN_WITH_VALUE NO_RETURN
188 #endif
189
190 #if !defined(NO_RETURN_WITH_VALUE)
191 #define NO_RETURN_WITH_VALUE
192 #endif
193
194 /* OBJC_CLASS */
195
196 #if !defined(OBJC_CLASS) && defined(__OBJC__)
197 #define OBJC_CLASS @class
198 #endif
199
200 #if !defined(OBJC_CLASS)
201 #define OBJC_CLASS class
202 #endif
203
204 /* PURE_FUNCTION */
205
206 #if !defined(PURE_FUNCTION) && COMPILER(GCC)
207 #define PURE_FUNCTION __attribute__((__pure__))
208 #endif
209
210 #if !defined(PURE_FUNCTION)
211 #define PURE_FUNCTION
212 #endif
213
214 /* REFERENCED_FROM_ASM */
215
216 #if !defined(REFERENCED_FROM_ASM) && COMPILER(GCC)
217 #define REFERENCED_FROM_ASM __attribute__((__used__))
218 #endif
219
220 #if !defined(REFERENCED_FROM_ASM)
221 #define REFERENCED_FROM_ASM
222 #endif
223
224 /* UNLIKELY */
225
226 #if !defined(UNLIKELY) && COMPILER(GCC)
227 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
228 #endif
229
230 #if !defined(UNLIKELY)
231 #define UNLIKELY(x) (x)
232 #endif
233
234 /* UNUSED_LABEL */
235
236 /* Keep the compiler from complaining for a local label that is defined but not referenced. */
237 /* Helpful when mixing hand-written and autogenerated code. */
238
239 #if !defined(UNUSED_LABEL) && COMPILER(MSVC)
240 #define UNUSED_LABEL(label) if (false) goto label
241 #endif
242
243 #if !defined(UNUSED_LABEL)
244 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
245 #endif
246
247 /* UNUSED_PARAM */
248
249 #if !defined(UNUSED_PARAM) && COMPILER(MSVC)
250 #define UNUSED_PARAM(variable) (void)&variable
251 #endif
252
253 #if !defined(UNUSED_PARAM)
254 #define UNUSED_PARAM(variable) (void)variable
255 #endif
256
257 /* WARN_UNUSED_RETURN */
258
259 #if !defined(WARN_UNUSED_RETURN) && COMPILER(GCC)
260 #define WARN_UNUSED_RETURN __attribute__((__warn_unused_result__))
261 #endif
262
263 #if !defined(WARN_UNUSED_RETURN)
264 #define WARN_UNUSED_RETURN
265 #endif
266
267 /* CONSTEXPR */
268 #if !defined(CONSTEXPR) && COMPILER_SUPPORTS(CXX_CONSTEXPR)
269 #define CONSTEXPR constexpr
270 #endif
271
272 #if !defined(CONSTEXPR)
273 #define CONSTEXPR
274 #endif
275
276 #endif /* WTF_Compiler_h */