Generate a compile error if release is built without compiler optimizations
[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_FEATURE() - 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 #endif /* COMPILER(GCC) */
106
107 #if COMPILER(GCC_OR_CLANG) && defined(NDEBUG) && !defined(__OPTIMIZE__) && !defined(RELEASE_WITHOUT_OPTIMIZATIONS)
108 #error "Building release without compiler optimizations: WebKit will be slow. Set -DRELEASE_WITHOUT_OPTIMIZATIONS if this is intended."
109 #endif
110
111 /* COMPILER(MINGW) - MinGW GCC */
112
113 #if defined(__MINGW32__)
114 #define WTF_COMPILER_MINGW 1
115 #include <_mingw.h>
116 #endif
117
118 /* COMPILER(MINGW64) - mingw-w64 GCC - used as additional check to exclude mingw.org specific functions */
119
120 /* Note: This section must come after the MinGW section since we check COMPILER(MINGW) here. */
121
122 #if COMPILER(MINGW) && defined(__MINGW64_VERSION_MAJOR) /* best way to check for mingw-w64 vs mingw.org */
123 #define WTF_COMPILER_MINGW64 1
124 #endif
125
126 /* COMPILER(MSVC) - Microsoft Visual C++ */
127
128 #if defined(_MSC_VER)
129
130 #define WTF_COMPILER_MSVC 1
131 #define WTF_COMPILER_SUPPORTS_CXX_REFERENCE_QUALIFIED_FUNCTIONS 1
132
133 #if _MSC_VER < 1900
134 #error "Please use a newer version of Visual Studio. WebKit requires VS2015 or newer to compile."
135 #endif
136
137 #endif
138
139 #if !COMPILER(CLANG) && !COMPILER(MSVC)
140 #define WTF_COMPILER_QUIRK_CONSIDERS_UNREACHABLE_CODE 1
141 #endif
142
143 /* ==== COMPILER_SUPPORTS - additional compiler feature detection, in alphabetical order ==== */
144
145 /* COMPILER_SUPPORTS(EABI) */
146
147 #if defined(__ARM_EABI__) || defined(__EABI__)
148 #define WTF_COMPILER_SUPPORTS_EABI 1
149 #endif
150
151 /* Non-static data member initializer (NSDMI) for aggregates */
152
153 #if defined(__cpp_aggregate_nsdmi) && __cpp_aggregate_nsdmi >= 201304
154 #define WTF_COMPILER_SUPPORTS_NSDMI_FOR_AGGREGATES 1
155 #endif
156
157 /* RELAXED_CONSTEXPR */
158
159 #if defined(__cpp_constexpr) && __cpp_constexpr >= 201304
160 #define WTF_COMPILER_SUPPORTS_RELAXED_CONSTEXPR 1
161 #endif
162
163 #if !defined(RELAXED_CONSTEXPR)
164 #if COMPILER_SUPPORTS(RELAXED_CONSTEXPR)
165 #define RELAXED_CONSTEXPR constexpr
166 #else
167 #define RELAXED_CONSTEXPR
168 #endif
169 #endif
170
171 #define ASAN_ENABLED COMPILER_HAS_CLANG_FEATURE(address_sanitizer)
172
173 #if ASAN_ENABLED
174 #define SUPPRESS_ASAN __attribute__((no_sanitize_address))
175 #else
176 #define SUPPRESS_ASAN
177 #endif
178
179 /* ==== Compiler-independent macros for various compiler features, in alphabetical order ==== */
180
181 /* ALWAYS_INLINE */
182
183 #if !defined(ALWAYS_INLINE) && COMPILER(GCC_OR_CLANG) && defined(NDEBUG) && !COMPILER(MINGW)
184 #define ALWAYS_INLINE inline __attribute__((__always_inline__))
185 #endif
186
187 #if !defined(ALWAYS_INLINE) && COMPILER(MSVC) && defined(NDEBUG)
188 #define ALWAYS_INLINE __forceinline
189 #endif
190
191 #if !defined(ALWAYS_INLINE)
192 #define ALWAYS_INLINE inline
193 #endif
194
195 /* WTF_EXTERN_C_{BEGIN, END} */
196
197 #ifdef __cplusplus
198 #define WTF_EXTERN_C_BEGIN extern "C" {
199 #define WTF_EXTERN_C_END }
200 #else
201 #define WTF_EXTERN_C_BEGIN
202 #define WTF_EXTERN_C_END
203 #endif
204
205 /* FALLTHROUGH */
206
207 #if !defined(FALLTHROUGH) && defined(__cplusplus) && defined(__has_cpp_attribute)
208
209 #if __has_cpp_attribute(fallthrough)
210 #define FALLTHROUGH [[fallthrough]]
211 #elif __has_cpp_attribute(clang::fallthrough)
212 #define FALLTHROUGH [[clang::fallthrough]]
213 #elif __has_cpp_attribute(gnu::fallthrough)
214 #define FALLTHROUGH [[gnu::fallthrough]]
215 #endif
216
217 #elif !defined(FALLTHROUGH) && !defined(__cplusplus)
218
219 #if COMPILER(GCC)
220 #if GCC_VERSION_AT_LEAST(7, 0, 0)
221 #define FALLTHROUGH __attribute__ ((fallthrough))
222 #endif
223 #endif
224
225 #endif // !defined(FALLTHROUGH) && defined(__cplusplus) && defined(__has_cpp_attribute)
226
227 #if !defined(FALLTHROUGH)
228 #define FALLTHROUGH
229 #endif
230
231 /* LIKELY */
232
233 #if !defined(LIKELY) && COMPILER(GCC_OR_CLANG)
234 #define LIKELY(x) __builtin_expect(!!(x), 1)
235 #endif
236
237 #if !defined(LIKELY)
238 #define LIKELY(x) (x)
239 #endif
240
241 /* NEVER_INLINE */
242
243 #if !defined(NEVER_INLINE) && COMPILER(GCC_OR_CLANG)
244 #define NEVER_INLINE __attribute__((__noinline__))
245 #endif
246
247 #if !defined(NEVER_INLINE) && COMPILER(MSVC)
248 #define NEVER_INLINE __declspec(noinline)
249 #endif
250
251 #if !defined(NEVER_INLINE)
252 #define NEVER_INLINE
253 #endif
254
255 /* NO_RETURN */
256
257 #if !defined(NO_RETURN) && COMPILER(GCC_OR_CLANG)
258 #define NO_RETURN __attribute((__noreturn__))
259 #endif
260
261 #if !defined(NO_RETURN) && COMPILER(MSVC)
262 #define NO_RETURN __declspec(noreturn)
263 #endif
264
265 #if !defined(NO_RETURN)
266 #define NO_RETURN
267 #endif
268
269 /* NOT_TAIL_CALLED */
270
271 #if !defined(NOT_TAIL_CALLED) && defined(__has_attribute)
272 #if __has_attribute(not_tail_called)
273 #define NOT_TAIL_CALLED __attribute__((not_tail_called))
274 #endif
275 #endif
276
277 #if !defined(NOT_TAIL_CALLED)
278 #define NOT_TAIL_CALLED
279 #endif
280
281 /* RETURNS_NONNULL */
282 #if !defined(RETURNS_NONNULL) && COMPILER(GCC_OR_CLANG)
283 #define RETURNS_NONNULL __attribute__((returns_nonnull))
284 #endif
285
286 #if !defined(RETURNS_NONNULL)
287 #define RETURNS_NONNULL
288 #endif
289
290 /* NO_RETURN_WITH_VALUE */
291
292 #if !defined(NO_RETURN_WITH_VALUE) && !COMPILER(MSVC)
293 #define NO_RETURN_WITH_VALUE NO_RETURN
294 #endif
295
296 #if !defined(NO_RETURN_WITH_VALUE)
297 #define NO_RETURN_WITH_VALUE
298 #endif
299
300 /* OBJC_CLASS */
301
302 #if !defined(OBJC_CLASS) && defined(__OBJC__)
303 #define OBJC_CLASS @class
304 #endif
305
306 #if !defined(OBJC_CLASS)
307 #define OBJC_CLASS class
308 #endif
309
310 /* PURE_FUNCTION */
311
312 #if !defined(PURE_FUNCTION) && COMPILER(GCC_OR_CLANG)
313 #define PURE_FUNCTION __attribute__((__pure__))
314 #endif
315
316 #if !defined(PURE_FUNCTION)
317 #define PURE_FUNCTION
318 #endif
319
320 /* UNUSED_FUNCTION */
321
322 #if !defined(UNUSED_FUNCTION) && COMPILER(GCC_OR_CLANG)
323 #define UNUSED_FUNCTION __attribute__((unused))
324 #endif
325
326 #if !defined(UNUSED_FUNCTION)
327 #define UNUSED_FUNCTION
328 #endif
329
330 /* REFERENCED_FROM_ASM */
331
332 #if !defined(REFERENCED_FROM_ASM) && COMPILER(GCC_OR_CLANG)
333 #define REFERENCED_FROM_ASM __attribute__((__used__))
334 #endif
335
336 #if !defined(REFERENCED_FROM_ASM)
337 #define REFERENCED_FROM_ASM
338 #endif
339
340 /* UNLIKELY */
341
342 #if !defined(UNLIKELY) && COMPILER(GCC_OR_CLANG)
343 #define UNLIKELY(x) __builtin_expect(!!(x), 0)
344 #endif
345
346 #if !defined(UNLIKELY)
347 #define UNLIKELY(x) (x)
348 #endif
349
350 /* UNUSED_LABEL */
351
352 /* Keep the compiler from complaining for a local label that is defined but not referenced. */
353 /* Helpful when mixing hand-written and autogenerated code. */
354
355 #if !defined(UNUSED_LABEL) && COMPILER(MSVC)
356 #define UNUSED_LABEL(label) if (false) goto label
357 #endif
358
359 #if !defined(UNUSED_LABEL)
360 #define UNUSED_LABEL(label) UNUSED_PARAM(&& label)
361 #endif
362
363 /* UNUSED_PARAM */
364
365 #if !defined(UNUSED_PARAM) && COMPILER(MSVC)
366 #define UNUSED_PARAM(variable) (void)&variable
367 #endif
368
369 #if !defined(UNUSED_PARAM)
370 #define UNUSED_PARAM(variable) (void)variable
371 #endif
372
373 /* WARN_UNUSED_RETURN */
374
375 #if !defined(WARN_UNUSED_RETURN) && COMPILER(GCC_OR_CLANG)
376 #define WARN_UNUSED_RETURN __attribute__((__warn_unused_result__))
377 #endif
378
379 #if !defined(WARN_UNUSED_RETURN)
380 #define WARN_UNUSED_RETURN
381 #endif
382
383 #if !defined(__has_include) && COMPILER(MSVC)
384 #define __has_include(path) 0
385 #endif
386
387 #endif /* WTF_Compiler_h */