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