1// Copyright 2013 the V8 project authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef V8CONFIG_H_
6#define V8CONFIG_H_
7
8// clang-format off
9
10// Platform headers for feature detection below.
11#if defined(__ANDROID__)
12# include <sys/cdefs.h>
13#elif defined(__APPLE__)
14# include <TargetConditionals.h>
15#elif defined(__linux__)
16# include <features.h>
17#endif
18
19
20// This macro allows to test for the version of the GNU C library (or
21// a compatible C library that masquerades as glibc). It evaluates to
22// 0 if libc is not GNU libc or compatible.
23// Use like:
24// #if V8_GLIBC_PREREQ(2, 3)
25// ...
26// #endif
27#if defined(__GLIBC__) && defined(__GLIBC_MINOR__)
28# define V8_GLIBC_PREREQ(major, minor) \
29 ((__GLIBC__ * 100 + __GLIBC_MINOR__) >= ((major) * 100 + (minor)))
30#else
31# define V8_GLIBC_PREREQ(major, minor) 0
32#endif
33
34
35// This macro allows to test for the version of the GNU C++ compiler.
36// Note that this also applies to compilers that masquerade as GCC,
37// for example clang and the Intel C++ compiler for Linux.
38// Use like:
39// #if V8_GNUC_PREREQ(4, 3, 1)
40// ...
41// #endif
42#if defined(__GNUC__) && defined(__GNUC_MINOR__) && defined(__GNUC_PATCHLEVEL__)
43# define V8_GNUC_PREREQ(major, minor, patchlevel) \
44 ((__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= \
45 ((major) * 10000 + (minor) * 100 + (patchlevel)))
46#elif defined(__GNUC__) && defined(__GNUC_MINOR__)
47# define V8_GNUC_PREREQ(major, minor, patchlevel) \
48 ((__GNUC__ * 10000 + __GNUC_MINOR__ * 100) >= \
49 ((major) * 10000 + (minor) * 100 + (patchlevel)))
50#else
51# define V8_GNUC_PREREQ(major, minor, patchlevel) 0
52#endif
53
54
55
56// -----------------------------------------------------------------------------
57// Operating system detection
58//
59// V8_OS_ANDROID - Android
60// V8_OS_BSD - BSDish (Mac OS X, Net/Free/Open/DragonFlyBSD)
61// V8_OS_CYGWIN - Cygwin
62// V8_OS_DRAGONFLYBSD - DragonFlyBSD
63// V8_OS_FREEBSD - FreeBSD
64// V8_OS_FUCHSIA - Fuchsia
65// V8_OS_LINUX - Linux
66// V8_OS_MACOSX - Mac OS X
67// V8_OS_NETBSD - NetBSD
68// V8_OS_OPENBSD - OpenBSD
69// V8_OS_POSIX - POSIX compatible (mostly everything except Windows)
70// V8_OS_QNX - QNX Neutrino
71// V8_OS_SOLARIS - Sun Solaris and OpenSolaris
72// V8_OS_AIX - AIX
73// V8_OS_WIN - Microsoft Windows
74
75#if defined(__ANDROID__)
76# define V8_OS_ANDROID 1
77# define V8_OS_LINUX 1
78# define V8_OS_POSIX 1
79#elif defined(__APPLE__)
80# define V8_OS_BSD 1
81# define V8_OS_MACOSX 1
82# define V8_OS_POSIX 1
83#elif defined(__CYGWIN__)
84# define V8_OS_CYGWIN 1
85# define V8_OS_POSIX 1
86#elif defined(__linux__)
87# define V8_OS_LINUX 1
88# define V8_OS_POSIX 1
89#elif defined(__sun)
90# define V8_OS_POSIX 1
91# define V8_OS_SOLARIS 1
92#elif defined(_AIX)
93#define V8_OS_POSIX 1
94#define V8_OS_AIX 1
95#elif defined(__FreeBSD__)
96# define V8_OS_BSD 1
97# define V8_OS_FREEBSD 1
98# define V8_OS_POSIX 1
99#elif defined(__Fuchsia__)
100# define V8_OS_FUCHSIA 1
101# define V8_OS_POSIX 1
102#elif defined(__DragonFly__)
103# define V8_OS_BSD 1
104# define V8_OS_DRAGONFLYBSD 1
105# define V8_OS_POSIX 1
106#elif defined(__NetBSD__)
107# define V8_OS_BSD 1
108# define V8_OS_NETBSD 1
109# define V8_OS_POSIX 1
110#elif defined(__OpenBSD__)
111# define V8_OS_BSD 1
112# define V8_OS_OPENBSD 1
113# define V8_OS_POSIX 1
114#elif defined(__QNXNTO__)
115# define V8_OS_POSIX 1
116# define V8_OS_QNX 1
117#elif defined(_WIN32)
118# define V8_OS_WIN 1
119#endif
120
121
122// -----------------------------------------------------------------------------
123// C library detection
124//
125// V8_LIBC_MSVCRT - MSVC libc
126// V8_LIBC_BIONIC - Bionic libc
127// V8_LIBC_BSD - BSD libc derivate
128// V8_LIBC_GLIBC - GNU C library
129// V8_LIBC_UCLIBC - uClibc
130//
131// Note that testing for libc must be done using #if not #ifdef. For example,
132// to test for the GNU C library, use:
133// #if V8_LIBC_GLIBC
134// ...
135// #endif
136
137#if defined (_MSC_VER)
138# define V8_LIBC_MSVCRT 1
139#elif defined(__BIONIC__)
140# define V8_LIBC_BIONIC 1
141# define V8_LIBC_BSD 1
142#elif defined(__UCLIBC__)
143// Must test for UCLIBC before GLIBC, as UCLIBC pretends to be GLIBC.
144# define V8_LIBC_UCLIBC 1
145#elif defined(__GLIBC__) || defined(__GNU_LIBRARY__)
146# define V8_LIBC_GLIBC 1
147#else
148# define V8_LIBC_BSD V8_OS_BSD
149#endif
150
151
152// -----------------------------------------------------------------------------
153// Compiler detection
154//
155// V8_CC_GNU - GCC, or clang in gcc mode
156// V8_CC_INTEL - Intel C++
157// V8_CC_MINGW - Minimalist GNU for Windows
158// V8_CC_MINGW32 - Minimalist GNU for Windows (mingw32)
159// V8_CC_MINGW64 - Minimalist GNU for Windows (mingw-w64)
160// V8_CC_MSVC - Microsoft Visual C/C++, or clang in cl.exe mode
161//
162// C++11 feature detection
163//
164// Compiler-specific feature detection
165//
166// V8_HAS_ATTRIBUTE_ALWAYS_INLINE - __attribute__((always_inline))
167// supported
168// V8_HAS_ATTRIBUTE_DEPRECATED - __attribute__((deprecated)) supported
169// V8_HAS_ATTRIBUTE_NOINLINE - __attribute__((noinline)) supported
170// V8_HAS_ATTRIBUTE_UNUSED - __attribute__((unused)) supported
171// V8_HAS_ATTRIBUTE_VISIBILITY - __attribute__((visibility)) supported
172// V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT - __attribute__((warn_unused_result))
173// supported
174// V8_HAS_BUILTIN_BSWAP16 - __builtin_bswap16() supported
175// V8_HAS_BUILTIN_BSWAP32 - __builtin_bswap32() supported
176// V8_HAS_BUILTIN_BSWAP64 - __builtin_bswap64() supported
177// V8_HAS_BUILTIN_CLZ - __builtin_clz() supported
178// V8_HAS_BUILTIN_CTZ - __builtin_ctz() supported
179// V8_HAS_BUILTIN_EXPECT - __builtin_expect() supported
180// V8_HAS_BUILTIN_FRAME_ADDRESS - __builtin_frame_address() supported
181// V8_HAS_BUILTIN_POPCOUNT - __builtin_popcount() supported
182// V8_HAS_BUILTIN_SADD_OVERFLOW - __builtin_sadd_overflow() supported
183// V8_HAS_BUILTIN_SSUB_OVERFLOW - __builtin_ssub_overflow() supported
184// V8_HAS_BUILTIN_UADD_OVERFLOW - __builtin_uadd_overflow() supported
185// V8_HAS_DECLSPEC_DEPRECATED - __declspec(deprecated) supported
186// V8_HAS_DECLSPEC_NOINLINE - __declspec(noinline) supported
187// V8_HAS_DECLSPEC_SELECTANY - __declspec(selectany) supported
188// V8_HAS_DECLSPEC_NORETURN - __declspec(noreturn) supported
189// V8_HAS___FORCEINLINE - __forceinline supported
190//
191// Note that testing for compilers and/or features must be done using #if
192// not #ifdef. For example, to test for Intel C++ Compiler, use:
193// #if V8_CC_INTEL
194// ...
195// #endif
196
197#if defined(__clang__)
198
199#if defined(__GNUC__) // Clang in gcc mode.
200# define V8_CC_GNU 1
201#endif
202
203# define V8_HAS_ATTRIBUTE_ALWAYS_INLINE (__has_attribute(always_inline))
204# define V8_HAS_ATTRIBUTE_DEPRECATED (__has_attribute(deprecated))
205# define V8_HAS_ATTRIBUTE_DEPRECATED_MESSAGE \
206 (__has_extension(attribute_deprecated_with_message))
207# define V8_HAS_ATTRIBUTE_NOINLINE (__has_attribute(noinline))
208# define V8_HAS_ATTRIBUTE_UNUSED (__has_attribute(unused))
209# define V8_HAS_ATTRIBUTE_VISIBILITY (__has_attribute(visibility))
210# define V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT \
211 (__has_attribute(warn_unused_result))
212
213# define V8_HAS_BUILTIN_BSWAP16 (__has_builtin(__builtin_bswap16))
214# define V8_HAS_BUILTIN_BSWAP32 (__has_builtin(__builtin_bswap32))
215# define V8_HAS_BUILTIN_BSWAP64 (__has_builtin(__builtin_bswap64))
216# define V8_HAS_BUILTIN_CLZ (__has_builtin(__builtin_clz))
217# define V8_HAS_BUILTIN_CTZ (__has_builtin(__builtin_ctz))
218# define V8_HAS_BUILTIN_EXPECT (__has_builtin(__builtin_expect))
219# define V8_HAS_BUILTIN_FRAME_ADDRESS (__has_builtin(__builtin_frame_address))
220# define V8_HAS_BUILTIN_POPCOUNT (__has_builtin(__builtin_popcount))
221# define V8_HAS_BUILTIN_SADD_OVERFLOW (__has_builtin(__builtin_sadd_overflow))
222# define V8_HAS_BUILTIN_SSUB_OVERFLOW (__has_builtin(__builtin_ssub_overflow))
223# define V8_HAS_BUILTIN_UADD_OVERFLOW (__has_builtin(__builtin_uadd_overflow))
224
225# if __cplusplus >= 201402L
226# define V8_CAN_HAVE_DCHECK_IN_CONSTEXPR 1
227# endif
228
229#elif defined(__GNUC__)
230
231# define V8_CC_GNU 1
232# if defined(__INTEL_COMPILER) // Intel C++ also masquerades as GCC 3.2.0
233# define V8_CC_INTEL 1
234# endif
235# if defined(__MINGW32__)
236# define V8_CC_MINGW32 1
237# endif
238# if defined(__MINGW64__)
239# define V8_CC_MINGW64 1
240# endif
241# define V8_CC_MINGW (V8_CC_MINGW32 || V8_CC_MINGW64)
242
243// always_inline is available in gcc 4.0 but not very reliable until 4.4.
244// Works around "sorry, unimplemented: inlining failed" build errors with
245// older compilers.
246# define V8_HAS_ATTRIBUTE_ALWAYS_INLINE (V8_GNUC_PREREQ(4, 4, 0))
247# define V8_HAS_ATTRIBUTE_DEPRECATED (V8_GNUC_PREREQ(3, 4, 0))
248# define V8_HAS_ATTRIBUTE_DEPRECATED_MESSAGE (V8_GNUC_PREREQ(4, 5, 0))
249# define V8_HAS_ATTRIBUTE_NOINLINE (V8_GNUC_PREREQ(3, 4, 0))
250# define V8_HAS_ATTRIBUTE_UNUSED (V8_GNUC_PREREQ(2, 95, 0))
251# define V8_HAS_ATTRIBUTE_VISIBILITY (V8_GNUC_PREREQ(4, 3, 0))
252# define V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT \
253 (!V8_CC_INTEL && V8_GNUC_PREREQ(4, 1, 0))
254
255# define V8_HAS_BUILTIN_CLZ (V8_GNUC_PREREQ(3, 4, 0))
256# define V8_HAS_BUILTIN_CTZ (V8_GNUC_PREREQ(3, 4, 0))
257# define V8_HAS_BUILTIN_EXPECT (V8_GNUC_PREREQ(2, 96, 0))
258# define V8_HAS_BUILTIN_FRAME_ADDRESS (V8_GNUC_PREREQ(2, 96, 0))
259# define V8_HAS_BUILTIN_POPCOUNT (V8_GNUC_PREREQ(3, 4, 0))
260
261#endif
262
263#if defined(_MSC_VER)
264# define V8_CC_MSVC 1
265
266# define V8_HAS_DECLSPEC_DEPRECATED 1
267# define V8_HAS_DECLSPEC_NOINLINE 1
268# define V8_HAS_DECLSPEC_SELECTANY 1
269# define V8_HAS_DECLSPEC_NORETURN 1
270
271# define V8_HAS___FORCEINLINE 1
272
273#endif
274
275
276// -----------------------------------------------------------------------------
277// Helper macros
278
279// A macro used to make better inlining. Don't bother for debug builds.
280// Use like:
281// V8_INLINE int GetZero() { return 0; }
282#if !defined(DEBUG) && V8_HAS_ATTRIBUTE_ALWAYS_INLINE
283# define V8_INLINE inline __attribute__((always_inline))
284#elif !defined(DEBUG) && V8_HAS___FORCEINLINE
285# define V8_INLINE __forceinline
286#else
287# define V8_INLINE inline
288#endif
289
290
291// A macro used to tell the compiler to never inline a particular function.
292// Don't bother for debug builds.
293// Use like:
294// V8_NOINLINE int GetMinusOne() { return -1; }
295#if !defined(DEBUG) && V8_HAS_ATTRIBUTE_NOINLINE
296# define V8_NOINLINE __attribute__((noinline))
297#elif !defined(DEBUG) && V8_HAS_DECLSPEC_NOINLINE
298# define V8_NOINLINE __declspec(noinline)
299#else
300# define V8_NOINLINE /* NOT SUPPORTED */
301#endif
302
303
304// A macro (V8_DEPRECATED) to mark classes or functions as deprecated.
305#if defined(V8_DEPRECATION_WARNINGS) && V8_HAS_ATTRIBUTE_DEPRECATED_MESSAGE
306#define V8_DEPRECATED(message, declarator) \
307 declarator __attribute__((deprecated(message)))
308#elif defined(V8_DEPRECATION_WARNINGS) && V8_HAS_ATTRIBUTE_DEPRECATED
309#define V8_DEPRECATED(message, declarator) \
310 declarator __attribute__((deprecated))
311#elif defined(V8_DEPRECATION_WARNINGS) && V8_HAS_DECLSPEC_DEPRECATED
312#define V8_DEPRECATED(message, declarator) __declspec(deprecated) declarator
313#else
314#define V8_DEPRECATED(message, declarator) declarator
315#endif
316
317
318// A macro (V8_DEPRECATE_SOON) to make it easier to see what will be deprecated.
319#if defined(V8_IMMINENT_DEPRECATION_WARNINGS) && \
320 V8_HAS_ATTRIBUTE_DEPRECATED_MESSAGE
321#define V8_DEPRECATE_SOON(message, declarator) \
322 declarator __attribute__((deprecated(message)))
323#elif defined(V8_IMMINENT_DEPRECATION_WARNINGS) && V8_HAS_ATTRIBUTE_DEPRECATED
324#define V8_DEPRECATE_SOON(message, declarator) \
325 declarator __attribute__((deprecated))
326#elif defined(V8_IMMINENT_DEPRECATION_WARNINGS) && V8_HAS_DECLSPEC_DEPRECATED
327#define V8_DEPRECATE_SOON(message, declarator) __declspec(deprecated) declarator
328#else
329#define V8_DEPRECATE_SOON(message, declarator) declarator
330#endif
331
332
333// A macro to provide the compiler with branch prediction information.
334#if V8_HAS_BUILTIN_EXPECT
335# define V8_UNLIKELY(condition) (__builtin_expect(!!(condition), 0))
336# define V8_LIKELY(condition) (__builtin_expect(!!(condition), 1))
337#else
338# define V8_UNLIKELY(condition) (condition)
339# define V8_LIKELY(condition) (condition)
340#endif
341
342
343// Annotate a function indicating the caller must examine the return value.
344// Use like:
345// int foo() V8_WARN_UNUSED_RESULT;
346#if V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT
347#define V8_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
348#else
349#define V8_WARN_UNUSED_RESULT /* NOT SUPPORTED */
350#endif
351
352#ifdef V8_OS_WIN
353
354// Setup for Windows DLL export/import. When building the V8 DLL the
355// BUILDING_V8_SHARED needs to be defined. When building a program which uses
356// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
357// static library or building a program which uses the V8 static library neither
358// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
359#ifdef BUILDING_V8_SHARED
360# define V8_EXPORT __declspec(dllexport)
361#elif USING_V8_SHARED
362# define V8_EXPORT __declspec(dllimport)
363#else
364# define V8_EXPORT
365#endif // BUILDING_V8_SHARED
366
367#else // V8_OS_WIN
368
369// Setup for Linux shared library export.
370#if V8_HAS_ATTRIBUTE_VISIBILITY
371# ifdef BUILDING_V8_SHARED
372# define V8_EXPORT __attribute__ ((visibility("default")))
373# else
374# define V8_EXPORT
375# endif
376#else
377# define V8_EXPORT
378#endif
379
380#endif // V8_OS_WIN
381
382// clang-format on
383
384#endif // V8CONFIG_H_
385