Loading...
Searching...
No Matches
v8config.h
Go to the documentation of this file.
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// gcc 10 defines __cplusplus to "an unspecified value strictly larger than
9// 201703L" for its experimental -std=gnu++2a config.
10// TODO(leszeks): Change to `__cplusplus <= 202002L` once we only support
11// compilers with full C++20 support.
12#if __cplusplus <= 201703L
13#error "C++20 or later required."
14#endif
15
16#ifdef V8_GN_HEADER
17#if !__has_include("v8-gn.h")
18#error Missing v8-gn.h. The configuration for v8 is missing from the include \
19path. Add it with -I<path> to the command line
20#endif
21#include "v8-gn.h" // NOLINT(build/include_directory)
22#endif
23
24#include <memory>
25// clang-format off
26
27// Platform headers for feature detection below.
28#if defined(__ANDROID__)
29# include <sys/cdefs.h>
30#elif defined(__APPLE__)
31# include <TargetConditionals.h>
32#elif defined(__linux__)
33# include <features.h>
34#elif defined(__MVS__)
35# include "zos-base.h"
36#endif
37
38
39// This macro allows to test for the version of the GNU C library (or
40// a compatible C library that masquerades as glibc). It evaluates to
41// 0 if libc is not GNU libc or compatible.
42// Use like:
43// #if V8_GLIBC_PREREQ(2, 3)
44// ...
45// #endif
46#if defined(__GLIBC__) && defined(__GLIBC_MINOR__)
47# define V8_GLIBC_PREREQ(major, minor) \
48 ((__GLIBC__ * 100 + __GLIBC_MINOR__) >= ((major) * 100 + (minor)))
49#else
50# define V8_GLIBC_PREREQ(major, minor) 0
51#endif
52
53
54// This macro allows to test for the version of the GNU C++ compiler.
55// Note that this also applies to compilers that masquerade as GCC,
56// for example clang and the Intel C++ compiler for Linux.
57// Use like:
58// #if V8_GNUC_PREREQ(4, 3, 1)
59// ...
60// #endif
61#if defined(__GNUC__) && defined(__GNUC_MINOR__) && defined(__GNUC_PATCHLEVEL__)
62# define V8_GNUC_PREREQ(major, minor, patchlevel) \
63 ((__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) >= \
64 ((major) * 10000 + (minor) * 100 + (patchlevel)))
65#elif defined(__GNUC__) && defined(__GNUC_MINOR__)
66# define V8_GNUC_PREREQ(major, minor, patchlevel) \
67 ((__GNUC__ * 10000 + __GNUC_MINOR__ * 100) >= \
68 ((major) * 10000 + (minor) * 100 + (patchlevel)))
69#else
70# define V8_GNUC_PREREQ(major, minor, patchlevel) 0
71#endif
72
73
74
75// -----------------------------------------------------------------------------
76// Operating system detection (host)
77//
78// V8_OS_ANDROID - Android
79// V8_OS_BSD - BSDish (macOS, Net/Free/Open/DragonFlyBSD)
80// V8_OS_CYGWIN - Cygwin
81// V8_OS_DRAGONFLYBSD - DragonFlyBSD
82// V8_OS_FREEBSD - FreeBSD
83// V8_OS_FUCHSIA - Fuchsia
84// V8_OS_LINUX - Linux (Android, ChromeOS, Linux, ...)
85// V8_OS_DARWIN - Darwin (macOS, iOS)
86// V8_OS_MACOS - macOS
87// V8_OS_IOS - iOS
88// V8_OS_NETBSD - NetBSD
89// V8_OS_OPENBSD - OpenBSD
90// V8_OS_POSIX - POSIX compatible (mostly everything except Windows)
91// V8_OS_QNX - QNX Neutrino
92// V8_OS_SOLARIS - Sun Solaris and OpenSolaris
93// V8_OS_STARBOARD - Starboard (platform abstraction for Cobalt)
94// V8_OS_AIX - AIX
95// V8_OS_WIN - Microsoft Windows
96// V8_OS_ZOS - z/OS
97
98#if defined(__ANDROID__)
99# define V8_OS_ANDROID 1
100# define V8_OS_LINUX 1
101# define V8_OS_POSIX 1
102# define V8_OS_STRING "android"
103
104#elif defined(__APPLE__)
105# define V8_OS_POSIX 1
106# define V8_OS_BSD 1
107# define V8_OS_DARWIN 1
108# if defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
109# define V8_OS_IOS 1
110# define V8_OS_STRING "ios"
111# else
112# define V8_OS_MACOS 1
113# define V8_OS_STRING "macos"
114# endif // defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE
115
116#elif defined(__CYGWIN__)
117# define V8_OS_CYGWIN 1
118# define V8_OS_POSIX 1
119# define V8_OS_STRING "cygwin"
120
121#elif defined(__linux__)
122# define V8_OS_LINUX 1
123# define V8_OS_POSIX 1
124# define V8_OS_STRING "linux"
125
126#elif defined(__sun)
127# define V8_OS_POSIX 1
128# define V8_OS_SOLARIS 1
129# define V8_OS_STRING "sun"
130
131#elif defined(STARBOARD)
132# define V8_OS_STARBOARD 1
133# define V8_OS_STRING "starboard"
134
135#elif defined(_AIX)
136# define V8_OS_POSIX 1
137# define V8_OS_AIX 1
138# define V8_OS_STRING "aix"
139
140#elif defined(__FreeBSD__)
141# define V8_OS_BSD 1
142# define V8_OS_FREEBSD 1
143# define V8_OS_POSIX 1
144# define V8_OS_STRING "freebsd"
145
146#elif defined(__Fuchsia__)
147# define V8_OS_FUCHSIA 1
148# define V8_OS_POSIX 1
149# define V8_OS_STRING "fuchsia"
150
151#elif defined(__DragonFly__)
152# define V8_OS_BSD 1
153# define V8_OS_DRAGONFLYBSD 1
154# define V8_OS_POSIX 1
155# define V8_OS_STRING "dragonflybsd"
156
157#elif defined(__NetBSD__)
158# define V8_OS_BSD 1
159# define V8_OS_NETBSD 1
160# define V8_OS_POSIX 1
161# define V8_OS_STRING "netbsd"
162
163#elif defined(__OpenBSD__)
164# define V8_OS_BSD 1
165# define V8_OS_OPENBSD 1
166# define V8_OS_POSIX 1
167# define V8_OS_STRING "openbsd"
168
169#elif defined(__QNXNTO__)
170# define V8_OS_POSIX 1
171# define V8_OS_QNX 1
172# define V8_OS_STRING "qnx"
173
174#elif defined(_WIN32)
175# define V8_OS_WIN 1
176# define V8_OS_STRING "windows"
177
178#elif defined(__MVS__)
179# define V8_OS_POSIX 1
180# define V8_OS_ZOS 1
181# define V8_OS_STRING "zos"
182#endif
183
184// -----------------------------------------------------------------------------
185// Operating system detection (target)
186//
187// V8_TARGET_OS_ANDROID
188// V8_TARGET_OS_FUCHSIA
189// V8_TARGET_OS_IOS
190// V8_TARGET_OS_LINUX
191// V8_TARGET_OS_MACOS
192// V8_TARGET_OS_WIN
193// V8_TARGET_OS_CHROMEOS
194//
195// If not set explicitly, these fall back to corresponding V8_OS_ values.
196
197#ifdef V8_HAVE_TARGET_OS
198
199// The target OS is provided, just check that at least one known value is set.
200# if !defined(V8_TARGET_OS_ANDROID) \
201 && !defined(V8_TARGET_OS_FUCHSIA) \
202 && !defined(V8_TARGET_OS_IOS) \
203 && !defined(V8_TARGET_OS_LINUX) \
204 && !defined(V8_TARGET_OS_MACOS) \
205 && !defined(V8_TARGET_OS_WIN) \
206 && !defined(V8_TARGET_OS_CHROMEOS)
207# error No known target OS defined.
208# endif
209
210#else // V8_HAVE_TARGET_OS
211
212# if defined(V8_TARGET_OS_ANDROID) \
213 || defined(V8_TARGET_OS_FUCHSIA) \
214 || defined(V8_TARGET_OS_IOS) \
215 || defined(V8_TARGET_OS_LINUX) \
216 || defined(V8_TARGET_OS_MACOS) \
217 || defined(V8_TARGET_OS_WIN) \
218 || defined(V8_TARGET_OS_CHROMEOS)
219# error A target OS is defined but V8_HAVE_TARGET_OS is unset.
220# endif
221
222// Fall back to the detected host OS.
223#ifdef V8_OS_ANDROID
224# define V8_TARGET_OS_ANDROID
225#endif
226
227#ifdef V8_OS_FUCHSIA
228# define V8_TARGET_OS_FUCHSIA
229#endif
230
231#ifdef V8_OS_IOS
232# define V8_TARGET_OS_IOS
233#endif
234
235#ifdef V8_OS_LINUX
236# define V8_TARGET_OS_LINUX
237#endif
238
239#ifdef V8_OS_MACOS
240# define V8_TARGET_OS_MACOS
241#endif
242
243#ifdef V8_OS_WIN
244# define V8_TARGET_OS_WIN
245#endif
246
247#endif // V8_HAVE_TARGET_OS
248
249#if defined(V8_TARGET_OS_ANDROID)
250# define V8_TARGET_OS_STRING "android"
251#elif defined(V8_TARGET_OS_FUCHSIA)
252# define V8_TARGET_OS_STRING "fuchsia"
253#elif defined(V8_TARGET_OS_IOS)
254# define V8_TARGET_OS_STRING "ios"
255#elif defined(V8_TARGET_OS_LINUX)
256# define V8_TARGET_OS_STRING "linux"
257#elif defined(V8_TARGET_OS_MACOS)
258# define V8_TARGET_OS_STRING "macos"
259#elif defined(V8_TARGET_OS_WINDOWS)
260# define V8_TARGET_OS_STRING "windows"
261#else
262# define V8_TARGET_OS_STRING "unknown"
263#endif
264
265// -----------------------------------------------------------------------------
266// C library detection
267//
268// V8_LIBC_MSVCRT - MSVC libc
269// V8_LIBC_BIONIC - Bionic libc
270// V8_LIBC_BSD - BSD libc derivate
271// V8_LIBC_GLIBC - GNU C library
272// V8_LIBC_UCLIBC - uClibc
273//
274// Note that testing for libc must be done using #if not #ifdef. For example,
275// to test for the GNU C library, use:
276// #if V8_LIBC_GLIBC
277// ...
278// #endif
279
280#if defined (_MSC_VER)
281# define V8_LIBC_MSVCRT 1
282#elif defined(__BIONIC__)
283# define V8_LIBC_BIONIC 1
284# define V8_LIBC_BSD 1
285#elif defined(__UCLIBC__)
286// Must test for UCLIBC before GLIBC, as UCLIBC pretends to be GLIBC.
287# define V8_LIBC_UCLIBC 1
288#elif defined(__GLIBC__) || defined(__GNU_LIBRARY__)
289# define V8_LIBC_GLIBC 1
290#else
291# define V8_LIBC_BSD V8_OS_BSD
292#endif
293
294
295// -----------------------------------------------------------------------------
296// Compiler detection
297//
298// V8_CC_GNU - GCC, or clang in gcc mode
299// V8_CC_INTEL - Intel C++
300// V8_CC_MINGW - Minimalist GNU for Windows
301// V8_CC_MINGW32 - Minimalist GNU for Windows (mingw32)
302// V8_CC_MINGW64 - Minimalist GNU for Windows (mingw-w64)
303// V8_CC_MSVC - Microsoft Visual C/C++, or clang in cl.exe mode
304//
305// C++11 feature detection
306//
307// Compiler-specific feature detection
308//
309// V8_HAS_ATTRIBUTE_ALWAYS_INLINE - __attribute__((always_inline))
310// supported
311// V8_HAS_ATTRIBUTE_CONSTINIT - __attribute__((require_constant_
312// initialization))
313// supported
314// V8_HAS_ATTRIBUTE_NONNULL - __attribute__((nonnull)) supported
315// V8_HAS_ATTRIBUTE_NOINLINE - __attribute__((noinline)) supported
316// V8_HAS_ATTRIBUTE_UNUSED - __attribute__((unused)) supported
317// V8_HAS_ATTRIBUTE_USED - __attribute__((used)) supported
318// V8_HAS_ATTRIBUTE_RETAIN - __attribute__((retain)) supported
319// V8_HAS_ATTRIBUTE_VISIBILITY - __attribute__((visibility)) supported
320// V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT - __attribute__((warn_unused_result))
321// supported
322// V8_HAS_CPP_ATTRIBUTE_NODISCARD - [[nodiscard]] supported
323// V8_HAS_CPP_ATTRIBUTE_NO_UNIQUE_ADDRESS
324// - [[no_unique_address]] supported
325// V8_HAS_BUILTIN_ADD_OVERFLOW - __builtin_add_overflow() supported
326// V8_HAS_BUILTIN_BIT_CAST - __builtin_bit_cast() supported
327// V8_HAS_BUILTIN_BSWAP16 - __builtin_bswap16() supported
328// V8_HAS_BUILTIN_BSWAP32 - __builtin_bswap32() supported
329// V8_HAS_BUILTIN_BSWAP64 - __builtin_bswap64() supported
330// V8_HAS_BUILTIN_CLZ - __builtin_clz() supported
331// V8_HAS_BUILTIN_CTZ - __builtin_ctz() supported
332// V8_HAS_BUILTIN_EXPECT - __builtin_expect() supported
333// V8_HAS_BUILTIN_FRAME_ADDRESS - __builtin_frame_address() supported
334// V8_HAS_BUILTIN_MUL_OVERFLOW - __builtin_mul_overflow() supported
335// V8_HAS_BUILTIN_POPCOUNT - __builtin_popcount() supported
336// V8_HAS_BUILTIN_SADD_OVERFLOW - __builtin_sadd_overflow() supported
337// V8_HAS_BUILTIN_SMUL_OVERFLOW - __builtin_smul_overflow() supported
338// V8_HAS_BUILTIN_SSUB_OVERFLOW - __builtin_ssub_overflow() supported
339// V8_HAS_BUILTIN_SUB_OVERFLOW - __builtin_sub_overflow() supported
340// V8_HAS_BUILTIN_UADD_OVERFLOW - __builtin_uadd_overflow() supported
341// V8_HAS_COMPUTED_GOTO - computed goto/labels as values
342// supported
343// V8_HAS_DECLSPEC_NOINLINE - __declspec(noinline) supported
344// V8_HAS_DECLSPEC_SELECTANY - __declspec(selectany) supported
345// V8_HAS___FORCEINLINE - __forceinline supported
346//
347// Note that testing for compilers and/or features must be done using #if
348// not #ifdef. For example, to test for Intel C++ Compiler, use:
349// #if V8_CC_INTEL
350// ...
351// #endif
352
353#if defined(__has_cpp_attribute)
354#define V8_HAS_CPP_ATTRIBUTE(FEATURE) __has_cpp_attribute(FEATURE)
355#else
356#define V8_HAS_CPP_ATTRIBUTE(FEATURE) 0
357#endif
358
359#if defined(__clang__)
360
361#if defined(__GNUC__) // Clang in gcc mode.
362# define V8_CC_GNU 1
363#endif
364
365# define V8_HAS_ATTRIBUTE_ALWAYS_INLINE (__has_attribute(always_inline))
366# define V8_HAS_ATTRIBUTE_CONSTINIT \
367 (__has_attribute(require_constant_initialization))
368# define V8_HAS_ATTRIBUTE_CONST (__has_attribute(const))
369# define V8_HAS_ATTRIBUTE_NONNULL (__has_attribute(nonnull))
370# define V8_HAS_ATTRIBUTE_NOINLINE (__has_attribute(noinline))
371# define V8_HAS_ATTRIBUTE_UNUSED (__has_attribute(unused))
372# define V8_HAS_ATTRIBUTE_USED (__has_attribute(used))
373# define V8_HAS_ATTRIBUTE_RETAIN (__has_attribute(retain))
374// Support for the "preserve_most" attribute is limited:
375// - 32-bit platforms do not implement it,
376// - component builds fail because _dl_runtime_resolve clobbers registers,
377// - we see crashes on arm64 on Windows (https://crbug.com/1409934), which can
378// hopefully be fixed in the future.
379// Additionally, the initial implementation in clang <= 16 overwrote the return
380// register(s) in the epilogue of a preserve_most function, so we only use
381// preserve_most in clang >= 17 (see https://reviews.llvm.org/D143425).
382#if (defined(_M_X64) || defined(__x86_64__) /* x64 (everywhere) */ \
383 || ((defined(__AARCH64EL__) || defined(_M_ARM64)) /* arm64, but ... */ \
384 && !defined(_WIN32))) /* not on windows */ \
385 && !defined(COMPONENT_BUILD) /* no component build */\
386 && __clang_major__ >= 17 /* clang >= 17 */
387# define V8_HAS_ATTRIBUTE_PRESERVE_MOST (__has_attribute(preserve_most))
388#endif
389# define V8_HAS_ATTRIBUTE_VISIBILITY (__has_attribute(visibility))
390# define V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT \
391 (__has_attribute(warn_unused_result))
392# define V8_HAS_ATTRIBUTE_WEAK (__has_attribute(weak))
393
394# define V8_HAS_CPP_ATTRIBUTE_NODISCARD (V8_HAS_CPP_ATTRIBUTE(nodiscard))
395#if defined(V8_CC_MSVC)
396# define V8_HAS_CPP_ATTRIBUTE_NO_UNIQUE_ADDRESS \
397 (V8_HAS_CPP_ATTRIBUTE(msvc::no_unique_address) || \
398 V8_HAS_CPP_ATTRIBUTE(no_unique_address))
399#else
400# define V8_HAS_CPP_ATTRIBUTE_NO_UNIQUE_ADDRESS \
401 (V8_HAS_CPP_ATTRIBUTE(no_unique_address))
402#endif
403
404# define V8_HAS_BUILTIN_ADD_OVERFLOW (__has_builtin(__builtin_add_overflow))
405# define V8_HAS_BUILTIN_ASSUME (__has_builtin(__builtin_assume))
406# define V8_HAS_BUILTIN_ASSUME_ALIGNED (__has_builtin(__builtin_assume_aligned))
407# define V8_HAS_BUILTIN_BIT_CAST (__has_builtin(__builtin_bit_cast))
408# define V8_HAS_BUILTIN_BSWAP16 (__has_builtin(__builtin_bswap16))
409# define V8_HAS_BUILTIN_BSWAP32 (__has_builtin(__builtin_bswap32))
410# define V8_HAS_BUILTIN_BSWAP64 (__has_builtin(__builtin_bswap64))
411# define V8_HAS_BUILTIN_CLZ (__has_builtin(__builtin_clz))
412# define V8_HAS_BUILTIN_CTZ (__has_builtin(__builtin_ctz))
413# define V8_HAS_BUILTIN_EXPECT (__has_builtin(__builtin_expect))
414# define V8_HAS_BUILTIN_FRAME_ADDRESS (__has_builtin(__builtin_frame_address))
415# define V8_HAS_BUILTIN_MUL_OVERFLOW (__has_builtin(__builtin_mul_overflow))
416# define V8_HAS_BUILTIN_POPCOUNT (__has_builtin(__builtin_popcount))
417# define V8_HAS_BUILTIN_SADD_OVERFLOW (__has_builtin(__builtin_sadd_overflow))
418# define V8_HAS_BUILTIN_SMUL_OVERFLOW (__has_builtin(__builtin_smul_overflow))
419# define V8_HAS_BUILTIN_SSUB_OVERFLOW (__has_builtin(__builtin_ssub_overflow))
420# define V8_HAS_BUILTIN_SUB_OVERFLOW (__has_builtin(__builtin_sub_overflow))
421# define V8_HAS_BUILTIN_UADD_OVERFLOW (__has_builtin(__builtin_uadd_overflow))
422# define V8_HAS_BUILTIN_UNREACHABLE (__has_builtin(__builtin_unreachable))
423
424// Clang has no __has_feature for computed gotos.
425// GCC doc: https://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html
426# define V8_HAS_COMPUTED_GOTO 1
427
428#elif defined(__GNUC__)
429
430# define V8_CC_GNU 1
431# if defined(__INTEL_COMPILER) // Intel C++ also masquerades as GCC 3.2.0
432# define V8_CC_INTEL 1
433# endif
434# if defined(__MINGW32__)
435# define V8_CC_MINGW32 1
436# endif
437# if defined(__MINGW64__)
438# define V8_CC_MINGW64 1
439# endif
440# define V8_CC_MINGW (V8_CC_MINGW32 || V8_CC_MINGW64)
441
442// FYI: __has_builtin is only available with GCC 10 and later, so explicitly
443// check GCC version numbers to enable features. TODO(leszeks): Merge feature
444// enabling for GCC 10 and later into the Clang section above, and leave this
445// section for GCC 9 and earlier.
446
447// always_inline is available in gcc 4.0 but not very reliable until 4.4.
448// Works around "sorry, unimplemented: inlining failed" build errors with
449// older compilers.
450# define V8_HAS_ATTRIBUTE_ALWAYS_INLINE 1
451# define V8_HAS_ATTRIBUTE_NOINLINE 1
452# define V8_HAS_ATTRIBUTE_UNUSED 1
453# define V8_HAS_ATTRIBUTE_VISIBILITY 1
454# define V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT (!V8_CC_INTEL)
455# define V8_HAS_ATTRIBUTE_WEAK 1
456
457// [[nodiscard]] does not work together with with
458// __attribute__((visibility(""))) on GCC 7.4 which is why there is no define
459// for V8_HAS_CPP_ATTRIBUTE_NODISCARD. See https://crbug.com/v8/11707.
460
461# define V8_HAS_BUILTIN_ASSUME_ALIGNED 1
462# if __GNUC__ >= 11
463# define V8_HAS_BUILTIN_BIT_CAST 1
464# endif
465# define V8_HAS_BUILTIN_CLZ 1
466# define V8_HAS_BUILTIN_CTZ 1
467# define V8_HAS_BUILTIN_EXPECT 1
468# define V8_HAS_BUILTIN_FRAME_ADDRESS 1
469# define V8_HAS_BUILTIN_POPCOUNT 1
470# define V8_HAS_BUILTIN_UNREACHABLE 1
471
472// GCC doc: https://gcc.gnu.org/onlinedocs/gcc/Labels-as-Values.html
473#define V8_HAS_COMPUTED_GOTO 1
474
475#endif
476
477#if defined(_MSC_VER)
478# define V8_CC_MSVC 1
479
480# define V8_HAS_DECLSPEC_NOINLINE 1
481# define V8_HAS_DECLSPEC_SELECTANY 1
482
483# define V8_HAS___FORCEINLINE 1
484
485#endif
486
487
488// -----------------------------------------------------------------------------
489// Helper macros
490
491// A macro used to make better inlining. Don't bother for debug builds.
492// Use like:
493// V8_INLINE int GetZero() { return 0; }
494#if !defined(DEBUG) && V8_HAS_ATTRIBUTE_ALWAYS_INLINE
495# define V8_INLINE inline __attribute__((always_inline))
496#elif !defined(DEBUG) && V8_HAS___FORCEINLINE
497# define V8_INLINE __forceinline
498#else
499# define V8_INLINE inline
500#endif
501
502#if V8_HAS_BUILTIN_ASSUME
503#ifdef DEBUG
504// In debug mode, check assumptions in addition to adding annotations.
505// This helps GCC (and maybe other compilers) figure out that certain
506// situations are unreachable.
507# define V8_ASSUME(condition) \
508 do { \
509 DCHECK(condition); \
510 __builtin_assume(condition); \
511 } while (false)
512#else // DEBUG
513# define V8_ASSUME __builtin_assume
514#endif // DEBUG
515#elif V8_HAS_BUILTIN_UNREACHABLE
516# define V8_ASSUME(condition) \
517 do { \
518 DCHECK(condition); \
519 if (!(condition)) __builtin_unreachable(); \
520 } while (false)
521#else
522# define V8_ASSUME USE
523#endif
524
525// Prefer c++20 std::assume_aligned. Don't use it on MSVC though, because it's
526// not happy with our large 4GB alignment values.
527#if __cplusplus >= 202002L && defined(__cpp_lib_assume_aligned) && !V8_CC_MSVC
528# define V8_ASSUME_ALIGNED(ptr, alignment) \
529 std::assume_aligned<(alignment)>(ptr)
530#elif V8_HAS_BUILTIN_ASSUME_ALIGNED
531# define V8_ASSUME_ALIGNED(ptr, alignment) \
532 __builtin_assume_aligned((ptr), (alignment))
533#else
534# define V8_ASSUME_ALIGNED(ptr, alignment) (ptr)
535#endif
536
537// A macro to mark functions whose values don't change (e.g. across calls)
538// and thereby compiler is free to hoist and fold multiple calls together.
539// Use like:
540// V8_CONST int foo() { ... }
541#if V8_HAS_ATTRIBUTE_CONST
542# define V8_CONST __attribute__((const))
543#else
544# define V8_CONST
545#endif
546
547// A macro to mark a declaration as requiring constant initialization.
548// Use like:
549// int* foo V8_CONSTINIT;
550#if V8_HAS_ATTRIBUTE_CONSTINIT
551# define V8_CONSTINIT __attribute__((require_constant_initialization))
552#else
553# define V8_CONSTINIT
554#endif
555
556
557// A macro to mark specific arguments as non-null.
558// Use like:
559// int add(int* x, int y, int* z) V8_NONNULL(1, 3) { return *x + y + *z; }
560#if V8_HAS_ATTRIBUTE_NONNULL
561# define V8_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
562#else
563# define V8_NONNULL(...) /* NOT SUPPORTED */
564#endif
565
566
567// A macro used to tell the compiler to never inline a particular function.
568// Use like:
569// V8_NOINLINE int GetMinusOne() { return -1; }
570#if V8_HAS_ATTRIBUTE_NOINLINE
571# define V8_NOINLINE __attribute__((noinline))
572#elif V8_HAS_DECLSPEC_NOINLINE
573# define V8_NOINLINE __declspec(noinline)
574#else
575# define V8_NOINLINE /* NOT SUPPORTED */
576#endif
577
578
579// A macro used to change the calling conventions to preserve all registers (no
580// caller-saved registers). Use this for cold functions called from hot
581// functions.
582// Use like:
583// V8_NOINLINE V8_PRESERVE_MOST void UnlikelyMethod();
584#if V8_HAS_ATTRIBUTE_PRESERVE_MOST
585# define V8_PRESERVE_MOST __attribute__((preserve_most))
586#else
587# define V8_PRESERVE_MOST /* NOT SUPPORTED */
588#endif
589
590
591// A macro (V8_DEPRECATED) to mark classes or functions as deprecated.
592#if defined(V8_DEPRECATION_WARNINGS)
593# define V8_DEPRECATED(message) [[deprecated(message)]]
594#else
595# define V8_DEPRECATED(message)
596#endif
597
598
599// A macro (V8_DEPRECATE_SOON) to make it easier to see what will be deprecated.
600#if defined(V8_IMMINENT_DEPRECATION_WARNINGS)
601# define V8_DEPRECATE_SOON(message) [[deprecated(message)]]
602#else
603# define V8_DEPRECATE_SOON(message)
604#endif
605
606
607#if defined(V8_IMMINENT_DEPRECATION_WARNINGS) || \
608 defined(V8_DEPRECATION_WARNINGS)
609#if defined(V8_CC_MSVC)
610# define START_ALLOW_USE_DEPRECATED() \
611 __pragma(warning(push)) \
612 __pragma(warning(disable : 4996))
613# define END_ALLOW_USE_DEPRECATED() __pragma(warning(pop))
614#else // !defined(V8_CC_MSVC)
615# define START_ALLOW_USE_DEPRECATED() \
616 _Pragma("GCC diagnostic push") \
617 _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
618#define END_ALLOW_USE_DEPRECATED() _Pragma("GCC diagnostic pop")
619#endif // !defined(V8_CC_MSVC)
620#else // !(defined(V8_IMMINENT_DEPRECATION_WARNINGS) ||
621 // defined(V8_DEPRECATION_WARNINGS))
622#define START_ALLOW_USE_DEPRECATED()
623#define END_ALLOW_USE_DEPRECATED()
624#endif // !(defined(V8_IMMINENT_DEPRECATION_WARNINGS) ||
625 // defined(V8_DEPRECATION_WARNINGS))
626#define ALLOW_COPY_AND_MOVE_WITH_DEPRECATED_FIELDS(ClassName) \
627 START_ALLOW_USE_DEPRECATED() \
628 ClassName(const ClassName&) = default; \
629 ClassName(ClassName&&) = default; \
630 ClassName& operator=(const ClassName&) = default; \
631 ClassName& operator=(ClassName&&) = default; \
632 END_ALLOW_USE_DEPRECATED()
633
634
635#if defined(__GNUC__) && !defined(__clang__) && (__GNUC__ < 6)
636# define V8_ENUM_DEPRECATED(message)
637# define V8_ENUM_DEPRECATE_SOON(message)
638#else
639# define V8_ENUM_DEPRECATED(message) V8_DEPRECATED(message)
640# define V8_ENUM_DEPRECATE_SOON(message) V8_DEPRECATE_SOON(message)
641#endif
642
643
644// A macro to provide the compiler with branch prediction information.
645#if V8_HAS_BUILTIN_EXPECT
646# define V8_UNLIKELY(condition) (__builtin_expect(!!(condition), 0))
647# define V8_LIKELY(condition) (__builtin_expect(!!(condition), 1))
648#else
649# define V8_UNLIKELY(condition) (condition)
650# define V8_LIKELY(condition) (condition)
651#endif
652
653
654// Annotate a function indicating the caller must examine the return value.
655// Use like:
656// int foo() V8_WARN_UNUSED_RESULT;
657#if V8_HAS_ATTRIBUTE_WARN_UNUSED_RESULT
658#define V8_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
659#else
660#define V8_WARN_UNUSED_RESULT /* NOT SUPPORTED */
661#endif
662
663
664// Annotate functions/variables as weak to allow overriding the symbol.
665#if V8_HAS_ATTRIBUTE_WEAK
666#define V8_WEAK __attribute__((weak))
667#else
668#define V8_WEAK /* NOT SUPPORTED */
669#endif
670
671
672// Annotate a class or constructor indicating the caller must assign the
673// constructed instances.
674// Apply to the whole class like:
675// class V8_NODISCARD Foo() { ... };
676// or apply to just one constructor like:
677// V8_NODISCARD Foo() { ... };
678// [[nodiscard]] comes in C++17 but supported in clang with -std >= c++11.
679#if V8_HAS_CPP_ATTRIBUTE_NODISCARD
680#define V8_NODISCARD [[nodiscard]]
681#else
682#define V8_NODISCARD /* NOT SUPPORTED */
683#endif
684
685// The no_unique_address attribute allows tail padding in a non-static data
686// member to overlap other members of the enclosing class (and in the special
687// case when the type is empty, permits it to fully overlap other members). The
688// field is laid out as if a base class were encountered at the corresponding
689// point within the class (except that it does not share a vptr with the
690// enclosing object).
691//
692// Apply to a data member like:
693//
694// class Foo {
695// V8_NO_UNIQUE_ADDRESS Bar bar_;
696// };
697//
698// [[no_unique_address]] comes in C++20 but supported in clang with
699// -std >= c++11.
700#if V8_HAS_CPP_ATTRIBUTE_NO_UNIQUE_ADDRESS
701#if defined(V8_CC_MSVC) && V8_HAS_CPP_ATTRIBUTE(msvc::no_unique_address)
702// Unfortunately MSVC ignores [[no_unique_address]] (see
703// https://devblogs.microsoft.com/cppblog/msvc-cpp20-and-the-std-cpp20-switch/#msvc-extensions-and-abi),
704// and clang-cl matches it for ABI compatibility reasons. We need to prefer
705// [[msvc::no_unique_address]] when available if we actually want any effect.
706#define V8_NO_UNIQUE_ADDRESS [[msvc::no_unique_address]]
707#else
708#define V8_NO_UNIQUE_ADDRESS [[no_unique_address]]
709#endif
710#else
711#define V8_NO_UNIQUE_ADDRESS /* NOT SUPPORTED */
712#endif
713
714// Marks a type as being eligible for the "trivial" ABI despite having a
715// non-trivial destructor or copy/move constructor. Such types can be relocated
716// after construction by simply copying their memory, which makes them eligible
717// to be passed in registers. The canonical example is std::unique_ptr.
718//
719// Use with caution; this has some subtle effects on constructor/destructor
720// ordering and will be very incorrect if the type relies on its address
721// remaining constant. When used as a function argument (by value), the value
722// may be constructed in the caller's stack frame, passed in a register, and
723// then used and destructed in the callee's stack frame. A similar thing can
724// occur when values are returned.
725//
726// TRIVIAL_ABI is not needed for types which have a trivial destructor and
727// copy/move constructors, since those are automatically trivial by the ABI
728// spec.
729//
730// It is also not likely to be effective on types too large to be passed in one
731// or two registers on typical target ABIs.
732//
733// See also:
734// https://clang.llvm.org/docs/AttributeReference.html#trivial-abi
735// https://libcxx.llvm.org/docs/DesignDocs/UniquePtrTrivialAbi.html
736#if defined(__clang__) && defined(__has_attribute)
737#if __has_attribute(trivial_abi)
738#define V8_TRIVIAL_ABI [[clang::trivial_abi]]
739#define V8_HAS_ATTRIBUTE_TRIVIAL_ABI 1
740#endif // __has_attribute(trivial_abi)
741#endif // defined(__clang__) && defined(__has_attribute)
742#if !defined(V8_TRIVIAL_ABI)
743#define V8_TRIVIAL_ABI
744#define V8_HAS_ATTRIBUTE_TRIVIAL_ABI 0
745#endif
746
747// Helper macro to define no_sanitize attributes only with clang.
748#if defined(__clang__) && defined(__has_attribute)
749#if __has_attribute(no_sanitize)
750#define V8_CLANG_NO_SANITIZE(what) __attribute__((no_sanitize(what)))
751#endif
752#endif
753#if !defined(V8_CLANG_NO_SANITIZE)
754#define V8_CLANG_NO_SANITIZE(what)
755#endif
756
757// Exposing private symbols requires exposing public symbols too.
758#ifdef BUILDING_V8_SHARED_PRIVATE
759#define BUILDING_V8_SHARED
760#endif
761
762#if defined(BUILDING_V8_SHARED) && defined(USING_V8_SHARED)
763#error Inconsistent build configuration: To build the V8 shared library \
764set BUILDING_V8_SHARED, to include its headers for linking against the \
765V8 shared library set USING_V8_SHARED.
766#endif
767
768#ifdef V8_OS_WIN
769
770// Setup for Windows DLL export/import. When building the V8 DLL the
771// BUILDING_V8_SHARED needs to be defined. When building a program which uses
772// the V8 DLL USING_V8_SHARED needs to be defined. When either building the V8
773// static library or building a program which uses the V8 static library neither
774// BUILDING_V8_SHARED nor USING_V8_SHARED should be defined.
775#ifdef BUILDING_V8_SHARED
776# define V8_EXPORT __declspec(dllexport)
777#elif USING_V8_SHARED
778# define V8_EXPORT __declspec(dllimport)
779#else
780# define V8_EXPORT
781#endif // BUILDING_V8_SHARED
782
783#else // V8_OS_WIN
784
785// Setup for Linux shared library export.
786#if V8_HAS_ATTRIBUTE_VISIBILITY
787# ifdef BUILDING_V8_SHARED
788# define V8_EXPORT __attribute__ ((visibility("default")))
789# else
790# define V8_EXPORT
791# endif
792#else
793# define V8_EXPORT
794#endif
795
796#endif // V8_OS_WIN
797
798// clang-format on
799
800// Processor architecture detection. For more info on what's defined, see:
801// http://msdn.microsoft.com/en-us/library/b0084kay.aspx
802// http://www.agner.org/optimize/calling_conventions.pdf
803// or with gcc, run: "echo | gcc -E -dM -"
804// The V8_HOST_ARCH_* macros correspond to the architecture on which V8, as a
805// virtual machine and compiler, runs. Don't confuse this with the architecture
806// on which V8 is built.
807#if defined(_M_X64) || defined(__x86_64__)
808#define V8_HOST_ARCH_X64 1
809#if defined(__x86_64__) && __SIZEOF_POINTER__ == 4 // Check for x32.
810#define V8_HOST_ARCH_32_BIT 1
811#else
812#define V8_HOST_ARCH_64_BIT 1
813#endif
814#elif defined(_M_IX86) || defined(__i386__)
815#define V8_HOST_ARCH_IA32 1
816#define V8_HOST_ARCH_32_BIT 1
817#elif defined(__AARCH64EL__) || defined(_M_ARM64)
818#define V8_HOST_ARCH_ARM64 1
819#define V8_HOST_ARCH_64_BIT 1
820#elif defined(__ARMEL__)
821#define V8_HOST_ARCH_ARM 1
822#define V8_HOST_ARCH_32_BIT 1
823#elif defined(__mips64)
824#define V8_HOST_ARCH_MIPS64 1
825#define V8_HOST_ARCH_64_BIT 1
826#elif defined(__loongarch_lp64)
827#define V8_HOST_ARCH_LOONG64 1
828#define V8_HOST_ARCH_64_BIT 1
829#elif defined(__PPC64__) || defined(_ARCH_PPC64)
830#define V8_HOST_ARCH_PPC64 1
831#define V8_HOST_ARCH_64_BIT 1
832#elif defined(__s390x__)
833#define V8_HOST_ARCH_S390X 1
834#define V8_HOST_ARCH_64_BIT 1
835#elif defined(__riscv) || defined(__riscv__)
836#if __riscv_xlen == 64
837#define V8_HOST_ARCH_RISCV64 1
838#define V8_HOST_ARCH_64_BIT 1
839#elif __riscv_xlen == 32
840#define V8_HOST_ARCH_RISCV32 1
841#define V8_HOST_ARCH_32_BIT 1
842#else
843#error "Cannot detect Riscv's bitwidth"
844#endif
845#else
846#error "Host architecture was not detected as supported by v8"
847#endif
848
849// Target architecture detection. This corresponds to the architecture for which
850// V8's JIT will generate code (the last stage of the canadian cross-compiler).
851// The macros may be set externally. If not, detect in the same way as the host
852// architecture, that is, target the native environment as presented by the
853// compiler.
854#if !V8_TARGET_ARCH_X64 && !V8_TARGET_ARCH_IA32 && !V8_TARGET_ARCH_ARM && \
855 !V8_TARGET_ARCH_ARM64 && !V8_TARGET_ARCH_MIPS64 && \
856 !V8_TARGET_ARCH_PPC64 && !V8_TARGET_ARCH_S390X && \
857 !V8_TARGET_ARCH_RISCV64 && !V8_TARGET_ARCH_LOONG64 && \
858 !V8_TARGET_ARCH_RISCV32
859#if defined(_M_X64) || defined(__x86_64__)
860#define V8_TARGET_ARCH_X64 1
861#elif defined(_M_IX86) || defined(__i386__)
862#define V8_TARGET_ARCH_IA32 1
863#elif defined(__AARCH64EL__) || defined(_M_ARM64)
864#define V8_TARGET_ARCH_ARM64 1
865#elif defined(__ARMEL__)
866#define V8_TARGET_ARCH_ARM 1
867#elif defined(__mips64)
868#define V8_TARGET_ARCH_MIPS64 1
869#elif defined(__loongarch_lp64)
870#define V8_TARGET_ARCH_LOONG64 1
871#elif defined(_ARCH_PPC64)
872#define V8_TARGET_ARCH_PPC64 1
873#elif defined(__s390x__)
874#define V8_TARGET_ARCH_S390X 1
875#elif defined(__riscv) || defined(__riscv__)
876#if __riscv_xlen == 64
877#define V8_TARGET_ARCH_RISCV64 1
878#elif __riscv_xlen == 32
879#define V8_TARGET_ARCH_RISCV32 1
880#endif
881#else
882#error Target architecture was not detected as supported by v8
883#endif
884#endif
885
886// Determine architecture pointer size.
887#if V8_TARGET_ARCH_IA32
888#define V8_TARGET_ARCH_32_BIT 1
889#elif V8_TARGET_ARCH_X64
890#if !V8_TARGET_ARCH_32_BIT && !V8_TARGET_ARCH_64_BIT
891#if defined(__x86_64__) && __SIZEOF_POINTER__ == 4 // Check for x32.
892#define V8_TARGET_ARCH_32_BIT 1
893#else
894#define V8_TARGET_ARCH_64_BIT 1
895#endif
896#endif
897#elif V8_TARGET_ARCH_ARM
898#define V8_TARGET_ARCH_32_BIT 1
899#elif V8_TARGET_ARCH_ARM64
900#define V8_TARGET_ARCH_64_BIT 1
901#elif V8_TARGET_ARCH_MIPS
902#define V8_TARGET_ARCH_32_BIT 1
903#elif V8_TARGET_ARCH_MIPS64
904#define V8_TARGET_ARCH_64_BIT 1
905#elif V8_TARGET_ARCH_LOONG64
906#define V8_TARGET_ARCH_64_BIT 1
907#elif V8_TARGET_ARCH_PPC64
908#define V8_TARGET_ARCH_64_BIT 1
909#elif V8_TARGET_ARCH_S390X
910#define V8_TARGET_ARCH_64_BIT 1
911#elif V8_TARGET_ARCH_RISCV64
912#define V8_TARGET_ARCH_64_BIT 1
913#elif V8_TARGET_ARCH_RISCV32
914#define V8_TARGET_ARCH_32_BIT 1
915#else
916#error Unknown target architecture pointer size
917#endif
918
919// Check for supported combinations of host and target architectures.
920#if V8_TARGET_ARCH_IA32 && !V8_HOST_ARCH_IA32
921#error Target architecture ia32 is only supported on ia32 host
922#endif
923#if (V8_TARGET_ARCH_X64 && V8_TARGET_ARCH_64_BIT && \
924 !((V8_HOST_ARCH_X64 || V8_HOST_ARCH_ARM64) && V8_HOST_ARCH_64_BIT))
925#error Target architecture x64 is only supported on x64 and arm64 host
926#endif
927#if (V8_TARGET_ARCH_X64 && V8_TARGET_ARCH_32_BIT && \
928 !(V8_HOST_ARCH_X64 && V8_HOST_ARCH_32_BIT))
929#error Target architecture x32 is only supported on x64 host with x32 support
930#endif
931#if (V8_TARGET_ARCH_ARM && !(V8_HOST_ARCH_IA32 || V8_HOST_ARCH_ARM))
932#error Target architecture arm is only supported on arm and ia32 host
933#endif
934#if (V8_TARGET_ARCH_ARM64 && !(V8_HOST_ARCH_X64 || V8_HOST_ARCH_ARM64))
935#error Target architecture arm64 is only supported on arm64 and x64 host
936#endif
937#if (V8_TARGET_ARCH_MIPS64 && !(V8_HOST_ARCH_X64 || V8_HOST_ARCH_MIPS64))
938#error Target architecture mips64 is only supported on mips64 and x64 host
939#endif
940#if (V8_TARGET_ARCH_RISCV64 && !(V8_HOST_ARCH_X64 || V8_HOST_ARCH_RISCV64))
941#error Target architecture riscv64 is only supported on riscv64 and x64 host
942#endif
943#if (V8_TARGET_ARCH_RISCV32 && !(V8_HOST_ARCH_IA32 || V8_HOST_ARCH_RISCV32))
944#error Target architecture riscv32 is only supported on riscv32 and ia32 host
945#endif
946#if (V8_TARGET_ARCH_LOONG64 && !(V8_HOST_ARCH_X64 || V8_HOST_ARCH_LOONG64))
947#error Target architecture loong64 is only supported on loong64 and x64 host
948#endif
949
950// Determine architecture endianness.
951#if V8_TARGET_ARCH_IA32
952#define V8_TARGET_LITTLE_ENDIAN 1
953#elif V8_TARGET_ARCH_X64
954#define V8_TARGET_LITTLE_ENDIAN 1
955#elif V8_TARGET_ARCH_ARM
956#define V8_TARGET_LITTLE_ENDIAN 1
957#elif V8_TARGET_ARCH_ARM64
958#define V8_TARGET_LITTLE_ENDIAN 1
959#elif V8_TARGET_ARCH_LOONG64
960#define V8_TARGET_LITTLE_ENDIAN 1
961#elif V8_TARGET_ARCH_MIPS64
962#if defined(__MIPSEB__) || defined(V8_TARGET_ARCH_MIPS64_BE)
963#define V8_TARGET_BIG_ENDIAN 1
964#else
965#define V8_TARGET_LITTLE_ENDIAN 1
966#endif
967#elif V8_TARGET_ARCH_PPC64
968#if V8_OS_AIX
969#define V8_TARGET_BIG_ENDIAN 1
970#else
971#define V8_TARGET_LITTLE_ENDIAN 1
972#endif
973#elif V8_TARGET_ARCH_S390X
974#if V8_TARGET_ARCH_S390X_LE_SIM
975#define V8_TARGET_LITTLE_ENDIAN 1
976#else
977#define V8_TARGET_BIG_ENDIAN 1
978#endif
979#elif V8_TARGET_ARCH_RISCV32 || V8_TARGET_ARCH_RISCV64
980#define V8_TARGET_LITTLE_ENDIAN 1
981#elif defined(__BYTE_ORDER__)
982#if __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__
983#define V8_TARGET_BIG_ENDIAN 1
984#else
985#define V8_TARGET_LITTLE_ENDIAN 1
986#endif
987#else
988#error Unknown target architecture endianness
989#endif
990
991#undef V8_HAS_CPP_ATTRIBUTE
992
993#if !defined(V8_STATIC_ROOTS)
994#define V8_STATIC_ROOTS_BOOL false
995#else
996#define V8_STATIC_ROOTS_BOOL true
997#endif
998#ifdef V8_TARGET_BIG_ENDIAN
999#define V8_TARGET_BIG_ENDIAN_BOOL true
1000#else
1001#define V8_TARGET_BIG_ENDIAN_BOOL false
1002#endif
1003
1004#endif // V8CONFIG_H_