7d4accb253f3b453abc3772ba0ea1f6401892063
[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_HAS_CLANG_BUILTIN() - wether the compiler supports a particular clang builtin. */
39 #ifdef __has_builtin
40 #define COMPILER_HAS_CLANG_BUILTIN(x) __has_builtin(x)
41 #else
42 #define COMPILER_HAS_CLANG_BUILTIN(x) 0
43 #endif
44
45 /* ==== COMPILER() - primary detection of the compiler being used to build the project, in alphabetical order ==== */
46
47 /* COMPILER(CLANG) - Clang  */
48
49 #if defined(__clang__)
50 #define WTF_COMPILER_CLANG 1
51 #define WTF_COMPILER_SUPPORTS_BLOCKS __has_feature(blocks)
52 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT __has_feature(c_static_assert)
53 #define WTF_COMPILER_SUPPORTS_CXX_CONSTEXPR __has_feature(cxx_constexpr)
54 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS __has_feature(cxx_reference_qualified_functions)
55 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS __has_feature(cxx_user_literals)
56 #define WTF_COMPILER_SUPPORTS_FALLTHROUGH_WARNINGS __has_feature(cxx_attributes) && __has_warning("-Wimplicit-fallthrough")
57 #endif
58
59 /* COMPILER(GCC) - GNU Compiler Collection */
60
61 /* Note: This section must come after the Clang section since we check !COMPILER(CLANG) here. */
62
63 #if defined(__GNUC__)
64 #define WTF_COMPILER_GCC 1
65 #define GCC_VERSION (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__)
66 #define GCC_VERSION_AT_LEAST(major, minor, patch) (GCC_VERSION >= (major * 10000 + minor * 100 + patch))
67 #endif
68
69 /* Define GCC_VERSION_AT_LEAST for all compilers, so we can write things like GCC_VERSION_AT_LEAST(4, 1, 0). */
70 /* FIXME: Doesn't seem all that valuable. Can we remove this? */
71 #if !defined(GCC_VERSION_AT_LEAST)
72 #define GCC_VERSION_AT_LEAST(major, minor, patch) 0
73 #endif
74
75 #if COMPILER(GCC) && !COMPILER(CLANG) && !GCC_VERSION_AT_LEAST(4, 7, 0)
76 #error "Please use a newer version of GCC. WebKit requires GCC 4.7.0 or newer to compile."
77 #endif
78
79 #if COMPILER(GCC) && !COMPILER(CLANG)
80 #define WTF_COMPILER_SUPPORTS_CXX_CONSTEXPR 1
81 #define WTF_COMPILER_SUPPORTS_CXX_USER_LITERALS 1
82 #endif
83
84 #if COMPILER(GCC) && !COMPILER(CLANG) && defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L
85 #define WTF_COMPILER_SUPPORTS_C_STATIC_ASSERT 1
86 #endif
87
88 #if COMPILER(GCC) && !COMPILER(CLANG) && GCC_VERSION_AT_LEAST(4, 8, 0)
89 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized"
90 #endif
91
92 #if COMPILER(GCC) && !COMPILER(CLANG) && (defined(__GXX_EXPERIMENTAL_CXX0X__) || (defined(__cplusplus) && __cplusplus >= 201103L))
93 #pragma GCC diagnostic ignored "-Wunused-local-typedefs"
94 #endif
95
96 /* COMPILER(MINGW) - MinGW GCC */
97
98 #if defined(__MINGW32__)
99 #define WTF_COMPILER_MINGW 1
100 #include <_mingw.h>
101 #endif
102
103 /* COMPILER(MINGW64) - mingw-w64 GCC - used as additional check to exclude mingw.org specific functions */
104
105 /* Note: This section must come after the MinGW section since we check COMPILER(MINGW) here. */
106
107 #if COMPILER(MINGW) && defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
108 #define WTF_COMPILER_MINGW64 1
109 #endif
110
111 /* COMPILER(MSVC) - Microsoft Visual C++ */
112
113 #if defined(_MSC_VER)
114 #define WTF_COMPILER_MSVC 1
115 #endif
116
117 #if defined(_MSC_VER) && _MSC_VER < 1800
118 #error "Please use a newer version of Visual Studio. WebKit requires VS2013 or newer to compile."
119 #endif
120
121 /* COMPILER(SUNCC) */
122
123 #if defined(__SUNPRO_CC) || defined(__SUNPRO_C)
124 #define WTF_COMPILER_SUNCC 1
125 #endif
126
127 #if !COMPILER(CLANG) && !COMPILER(MSVC)
128 #define WTF_COMPILER_QUIRK_CONSIDERS_UNREACHABLE_CODE 1
129 #endif
130
131 /* ==== COMPILER_SUPPORTS - additional compiler feature detection, in alphabetical order ==== */
132
133 /* COMPILER_SUPPORTS(EABI) */
134
135 #if defined(__ARM_EABI__) || defined(__EABI__)
136 #define WTF_COMPILER_SUPPORTS_EABI 1
137 #endif
138
139 #if defined(__has_feature)
140 #define ASAN_ENABLED __has_feature(address_sanitizer)
141 #else
142 #define ASAN_ENABLED 0
143 #endif
144
145 /* ==== Compiler-independent macros for various compiler features, in alphabetical order ==== */
146
147 /* ALWAYS_INLINE */
148
149 #if !defined(ALWAYS_INLINE) && COMPILER(GCC) && defined(NDEBUG) && !COMPILER(MINGW)
150 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
151 #endif
152
153 #if !defined(ALWAYS_INLINE) && COMPILER(MSVC) && defined(NDEBUG)
154 #define ALWAYS_INLINE __forceinline
155 #endif
156
157 #if !defined(ALWAYS_INLINE)
158 #define ALWAYS_INLINE inline
159 #endif
160
161 /* CONSTEXPR */
162
163 #if !defined(CONSTEXPR) && COMPILER_SUPPORTS(CXX_CONSTEXPR)
164 #define CONSTEXPR constexpr
165 #endif
166
167 #if !defined(CONSTEXPR)
168 #define CONSTEXPR
169 #endif
170
171 /* WTF_EXTERN_C_{BEGIN, END} */
172
173 #ifdef __cplusplus
174 #define WTF_EXTERN_C_BEGIN extern "C" {
175 #define WTF_EXTERN_C_END }
176 #else
177 #define WTF_EXTERN_C_BEGIN
178 #define WTF_EXTERN_C_END
179 #endif
180
181 /* FIXME: Remove this once we have transitioned to WTF_EXTERN_C_BEGIN/WTF_EXTERN_C_END. */
182 #ifdef __cplusplus
183 #define EXTERN_C extern "C"
184 #else
185 #define EXTERN_C extern
186 #endif
187
188 /* FALLTHROUGH */
189
190 #if !defined(FALLTHROUGH) && COMPILER_SUPPORTS(FALLTHROUGH_WARNINGS) && COMPILER(CLANG)
191 #define FALLTHROUGH [[clang::fallthrough]]
192 #endif
193
194 #if !defined(FALLTHROUGH)
195 #define FALLTHROUGH
196 #endif
197
198 /* LIKELY */
199
200 #if !defined(LIKELY) && COMPILER(GCC)
201 #define LIKELY(x) __builtin_expect(!!(x), 1)
202 #endif
203
204 #if !defined(LIKELY)
205 #define LIKELY(x) (x)
206 #endif
207
208 /* NEVER_INLINE */
209
210 #if !defined(NEVER_INLINE) && COMPILER(GCC)
211 #define NEVER_INLINE __attribute__((__noinline__))
212 #endif
213
214 #if !defined(NEVER_INLINE) && COMPILER(MSVC)
215 #define NEVER_INLINE __declspec(noinline)
216 #endif
217
218 #if !defined(NEVER_INLINE)
219 #define NEVER_INLINE
220 #endif
221
222 /* NO_RETURN */
223
224 #if !defined(NO_RETURN) && COMPILER(GCC)
225 #define NO_RETURN __attribute((__noreturn__))
226 #endif
227
228 #if !defined(NO_RETURN) && COMPILER(MSVC)
229 #define NO_RETURN __declspec(noreturn)
230 #endif
231
232 #if !defined(NO_RETURN)
233 #define NO_RETURN
234 #endif
235
236 /* NO_RETURN_WITH_VALUE */
237
238 #if !defined(NO_RETURN_WITH_VALUE) && !COMPILER(MSVC)
239 #define NO_RETURN_WITH_VALUE NO_RETURN
240 #endif
241
242 #if !defined(NO_RETURN_WITH_VALUE)
243 #define NO_RETURN_WITH_VALUE
244 #endif
245
246 /* OBJC_CLASS */
247
248 #if !defined(OBJC_CLASS) && defined(__OBJC__)
249 #define OBJC_CLASS @class
250 #endif
251
252 #if !defined(OBJC_CLASS)
253 #define OBJC_CLASS class
254 #endif
255
256 /* PURE_FUNCTION */
257
258 #if !defined(PURE_FUNCTION) && COMPILER(GCC)
259 #define PURE_FUNCTION __attribute__((__pure__))
260 #endif
261
262 #if !defined(PURE_FUNCTION)
263 #define PURE_FUNCTION
264 #endif
265
266 /* REFERENCED_FROM_ASM */
267
268 #if !defined(REFERENCED_FROM_ASM) && COMPILER(GCC)
269 #define REFERENCED_FROM_ASM __attribute__((__used__))
270 #endif
271
272 #if !defined(REFERENCED_FROM_ASM)
273 #define REFERENCED_FROM_ASM
274 #endif
275
276 /* UNLIKELY */
277
278 #if !defined(UNLIKELY) && COMPILER(GCC)
279 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
280 #endif
281
282 #if !defined(UNLIKELY)
283 #define UNLIKELY(x) (x)
284 #endif
285
286 /* UNUSED_LABEL */
287
288 /* Keep the compiler from complaining for a local label that is defined but not referenced. */
289 /* Helpful when mixing hand-written and autogenerated code. */
290
291 #if !defined(UNUSED_LABEL) && COMPILER(MSVC)
292 #define UNUSED_LABEL(label) if (false) goto label
293 #endif
294
295 #if !defined(UNUSED_LABEL)
296 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
297 #endif
298
299 /* UNUSED_PARAM */
300
301 #if !defined(UNUSED_PARAM) && COMPILER(MSVC)
302 #define UNUSED_PARAM(variable) (void)&variable
303 #endif
304
305 #if !defined(UNUSED_PARAM)
306 #define UNUSED_PARAM(variable) (void)variable
307 #endif
308
309 /* WARN_UNUSED_RETURN */
310
311 #if !defined(WARN_UNUSED_RETURN) && COMPILER(GCC)
312 #define WARN_UNUSED_RETURN __attribute__((__warn_unused_result__))
313 #endif
314
315 #if !defined(WARN_UNUSED_RETURN)
316 #define WARN_UNUSED_RETURN
317 #endif
318
319 #if !defined(__has_include) && COMPILER(MSVC)
320 #define __has_include(path) 0
321 #endif
322
323 #endif /* WTF_Compiler_h */