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