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