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