Loading...
Searching...
No Matches
v8-internal.h
Go to the documentation of this file.
1// Copyright 2018 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 INCLUDE_V8_INTERNAL_H_
6#define INCLUDE_V8_INTERNAL_H_
7
8#include <stddef.h>
9#include <stdint.h>
10#include <string.h>
11
12#include <atomic>
13#include <compare>
14#include <concepts>
15#include <iterator>
16#include <limits>
17#include <memory>
18#include <optional>
19#include <type_traits>
20
21#include "v8config.h" // NOLINT(build/include_directory)
22
23namespace v8 {
24
25class Array;
26class Context;
27class Data;
28class Isolate;
29
30namespace internal {
31
32class Heap;
33class LocalHeap;
34class Isolate;
35class IsolateGroup;
36class LocalIsolate;
37
38typedef uintptr_t Address;
39static constexpr Address kNullAddress = 0;
40
41constexpr int KB = 1024;
42constexpr int MB = KB * 1024;
43constexpr int GB = MB * 1024;
44#ifdef V8_TARGET_ARCH_X64
45constexpr size_t TB = size_t{GB} * 1024;
46#endif
47
51const int kApiSystemPointerSize = sizeof(void*);
52const int kApiDoubleSize = sizeof(double);
53const int kApiInt32Size = sizeof(int32_t);
54const int kApiInt64Size = sizeof(int64_t);
55const int kApiSizetSize = sizeof(size_t);
56
57// Tag information for HeapObject.
58const int kHeapObjectTag = 1;
59const int kWeakHeapObjectTag = 3;
60const int kHeapObjectTagSize = 2;
61const intptr_t kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1;
63
64// Tag information for fowarding pointers stored in object headers.
65// 0b00 at the lowest 2 bits in the header indicates that the map word is a
66// forwarding pointer.
67const int kForwardingTag = 0;
68const int kForwardingTagSize = 2;
69const intptr_t kForwardingTagMask = (1 << kForwardingTagSize) - 1;
70
71// Tag information for Smi.
72const int kSmiTag = 0;
73const int kSmiTagSize = 1;
74const intptr_t kSmiTagMask = (1 << kSmiTagSize) - 1;
75
76template <size_t tagged_ptr_size>
78
79constexpr intptr_t kIntptrAllBitsSet = intptr_t{-1};
80constexpr uintptr_t kUintptrAllBitsSet =
81 static_cast<uintptr_t>(kIntptrAllBitsSet);
82
83// Smi constants for systems where tagged pointer is a 32-bit value.
84template <>
85struct SmiTagging<4> {
86 enum { kSmiShiftSize = 0, kSmiValueSize = 31 };
87
88 static constexpr intptr_t kSmiMinValue =
89 static_cast<intptr_t>(kUintptrAllBitsSet << (kSmiValueSize - 1));
90 static constexpr intptr_t kSmiMaxValue = -(kSmiMinValue + 1);
91
92 V8_INLINE static constexpr int SmiToInt(Address value) {
93 int shift_bits = kSmiTagSize + kSmiShiftSize;
94 // Truncate and shift down (requires >> to be sign extending).
95 return static_cast<int32_t>(static_cast<uint32_t>(value)) >> shift_bits;
96 }
97
98 template <class T, typename std::enable_if_t<std::is_integral_v<T> &&
99 std::is_signed_v<T>>* = nullptr>
100 V8_INLINE static constexpr bool IsValidSmi(T value) {
101 // Is value in range [kSmiMinValue, kSmiMaxValue].
102 // Use unsigned operations in order to avoid undefined behaviour in case of
103 // signed integer overflow.
104 return (static_cast<uintptr_t>(value) -
105 static_cast<uintptr_t>(kSmiMinValue)) <=
106 (static_cast<uintptr_t>(kSmiMaxValue) -
107 static_cast<uintptr_t>(kSmiMinValue));
108 }
109
110 template <class T,
111 typename std::enable_if_t<std::is_integral_v<T> &&
112 std::is_unsigned_v<T>>* = nullptr>
113 V8_INLINE static constexpr bool IsValidSmi(T value) {
114 static_assert(kSmiMaxValue <= std::numeric_limits<uintptr_t>::max());
115 return value <= static_cast<uintptr_t>(kSmiMaxValue);
116 }
117
118 // Same as the `intptr_t` version but works with int64_t on 32-bit builds
119 // without slowing down anything else.
120 V8_INLINE static constexpr bool IsValidSmi(int64_t value) {
121 return (static_cast<uint64_t>(value) -
122 static_cast<uint64_t>(kSmiMinValue)) <=
123 (static_cast<uint64_t>(kSmiMaxValue) -
124 static_cast<uint64_t>(kSmiMinValue));
125 }
126
127 V8_INLINE static constexpr bool IsValidSmi(uint64_t value) {
128 static_assert(kSmiMaxValue <= std::numeric_limits<uint64_t>::max());
129 return value <= static_cast<uint64_t>(kSmiMaxValue);
130 }
131};
132
133// Smi constants for systems where tagged pointer is a 64-bit value.
134template <>
135struct SmiTagging<8> {
136 enum { kSmiShiftSize = 31, kSmiValueSize = 32 };
137
138 static constexpr intptr_t kSmiMinValue =
139 static_cast<intptr_t>(kUintptrAllBitsSet << (kSmiValueSize - 1));
140 static constexpr intptr_t kSmiMaxValue = -(kSmiMinValue + 1);
141
142 V8_INLINE static constexpr int SmiToInt(Address value) {
143 int shift_bits = kSmiTagSize + kSmiShiftSize;
144 // Shift down and throw away top 32 bits.
145 return static_cast<int>(static_cast<intptr_t>(value) >> shift_bits);
146 }
147
148 template <class T, typename std::enable_if_t<std::is_integral_v<T> &&
149 std::is_signed_v<T>>* = nullptr>
150 V8_INLINE static constexpr bool IsValidSmi(T value) {
151 // To be representable as a long smi, the value must be a 32-bit integer.
152 return std::numeric_limits<int32_t>::min() <= value &&
153 value <= std::numeric_limits<int32_t>::max();
154 }
155
156 template <class T,
157 typename std::enable_if_t<std::is_integral_v<T> &&
158 std::is_unsigned_v<T>>* = nullptr>
159 V8_INLINE static constexpr bool IsValidSmi(T value) {
160 return value <= std::numeric_limits<int32_t>::max();
161 }
162};
163
164#ifdef V8_COMPRESS_POINTERS
165// See v8:7703 or src/common/ptr-compr-inl.h for details about pointer
166// compression.
167constexpr size_t kPtrComprCageReservationSize = size_t{1} << 32;
168constexpr size_t kPtrComprCageBaseAlignment = size_t{1} << 32;
169
170static_assert(
172 "Pointer compression can be enabled only for 64-bit architectures");
173const int kApiTaggedSize = kApiInt32Size;
174#else
176#endif
177
180}
181
182#ifdef V8_31BIT_SMIS_ON_64BIT_ARCH
183using PlatformSmiTagging = SmiTagging<kApiInt32Size>;
184#else
186#endif
187
188// TODO(ishell): Consinder adding kSmiShiftBits = kSmiShiftSize + kSmiTagSize
189// since it's used much more often than the inividual constants.
190const int kSmiShiftSize = PlatformSmiTagging::kSmiShiftSize;
191const int kSmiValueSize = PlatformSmiTagging::kSmiValueSize;
192const int kSmiMinValue = static_cast<int>(PlatformSmiTagging::kSmiMinValue);
193const int kSmiMaxValue = static_cast<int>(PlatformSmiTagging::kSmiMaxValue);
194constexpr bool SmiValuesAre31Bits() { return kSmiValueSize == 31; }
195constexpr bool SmiValuesAre32Bits() { return kSmiValueSize == 32; }
196constexpr bool Is64() { return kApiSystemPointerSize == sizeof(int64_t); }
197
198V8_INLINE static constexpr Address IntToSmi(int value) {
199 return (static_cast<Address>(value) << (kSmiTagSize + kSmiShiftSize)) |
200 kSmiTag;
201}
202
203/*
204 * Sandbox related types, constants, and functions.
205 */
206constexpr bool SandboxIsEnabled() {
207#ifdef V8_ENABLE_SANDBOX
208 return true;
209#else
210 return false;
211#endif
212}
213
214// SandboxedPointers are guaranteed to point into the sandbox. This is achieved
215// for example by storing them as offset rather than as raw pointers.
217
218#ifdef V8_ENABLE_SANDBOX
219
220// Size of the sandbox, excluding the guard regions surrounding it.
221#if defined(V8_TARGET_OS_ANDROID)
222// On Android, most 64-bit devices seem to be configured with only 39 bits of
223// virtual address space for userspace. As such, limit the sandbox to 128GB (a
224// quarter of the total available address space).
225constexpr size_t kSandboxSizeLog2 = 37; // 128 GB
226#elif defined(V8_TARGET_OS_IOS)
227// On iOS, we only get 64 GB of usable virtual address space even with the
228// "jumbo" extended virtual addressing entitlement. Limit the sandbox size to
229// 16 GB so that the base address + size for the emulated virtual address space
230// lies within the 64 GB total virtual address space.
231constexpr size_t kSandboxSizeLog2 = 34; // 16 GB
232#else
233// Everywhere else use a 1TB sandbox.
234constexpr size_t kSandboxSizeLog2 = 40; // 1 TB
235#endif // V8_TARGET_OS_ANDROID
236constexpr size_t kSandboxSize = 1ULL << kSandboxSizeLog2;
237
238// Required alignment of the sandbox. For simplicity, we require the
239// size of the guard regions to be a multiple of this, so that this specifies
240// the alignment of the sandbox including and excluding surrounding guard
241// regions. The alignment requirement is due to the pointer compression cage
242// being located at the start of the sandbox.
243constexpr size_t kSandboxAlignment = kPtrComprCageBaseAlignment;
244
245// Sandboxed pointers are stored inside the heap as offset from the sandbox
246// base shifted to the left. This way, it is guaranteed that the offset is
247// smaller than the sandbox size after shifting it to the right again. This
248// constant specifies the shift amount.
249constexpr uint64_t kSandboxedPointerShift = 64 - kSandboxSizeLog2;
250
251// Size of the guard regions surrounding the sandbox. This assumes a worst-case
252// scenario of a 32-bit unsigned index used to access an array of 64-bit values
253// with an additional 4GB (compressed pointer) offset. In particular, accesses
254// to TypedArrays are effectively computed as
255// `entry_pointer = array->base + array->offset + index * array->element_size`.
256// See also https://crbug.com/40070746 for more details.
257constexpr size_t kSandboxGuardRegionSize = 32ULL * GB + 4ULL * GB;
258
259static_assert((kSandboxGuardRegionSize % kSandboxAlignment) == 0,
260 "The size of the guard regions around the sandbox must be a "
261 "multiple of its required alignment.");
262
263// On OSes where reserving virtual memory is too expensive to reserve the
264// entire address space backing the sandbox, notably Windows pre 8.1, we create
265// a partially reserved sandbox that doesn't actually reserve most of the
266// memory, and so doesn't have the desired security properties as unrelated
267// memory allocations could end up inside of it, but which still ensures that
268// objects that should be located inside the sandbox are allocated within
269// kSandboxSize bytes from the start of the sandbox. The minimum size of the
270// region that is actually reserved for such a sandbox is specified by this
271// constant and should be big enough to contain the pointer compression cage as
272// well as the ArrayBuffer partition.
273constexpr size_t kSandboxMinimumReservationSize = 8ULL * GB;
274
275static_assert(kSandboxMinimumReservationSize > kPtrComprCageReservationSize,
276 "The minimum reservation size for a sandbox must be larger than "
277 "the pointer compression cage contained within it.");
278
279// The maximum buffer size allowed inside the sandbox. This is mostly dependent
280// on the size of the guard regions around the sandbox: an attacker must not be
281// able to construct a buffer that appears larger than the guard regions and
282// thereby "reach out of" the sandbox.
283constexpr size_t kMaxSafeBufferSizeForSandbox = 32ULL * GB - 1;
284static_assert(kMaxSafeBufferSizeForSandbox <= kSandboxGuardRegionSize,
285 "The maximum allowed buffer size must not be larger than the "
286 "sandbox's guard regions");
287
288constexpr size_t kBoundedSizeShift = 29;
289static_assert(1ULL << (64 - kBoundedSizeShift) ==
290 kMaxSafeBufferSizeForSandbox + 1,
291 "The maximum size of a BoundedSize must be synchronized with the "
292 "kMaxSafeBufferSizeForSandbox");
293
294#endif // V8_ENABLE_SANDBOX
295
296#ifdef V8_COMPRESS_POINTERS
297
298#ifdef V8_TARGET_OS_ANDROID
299// The size of the virtual memory reservation for an external pointer table.
300// This determines the maximum number of entries in a table. Using a maximum
301// size allows omitting bounds checks on table accesses if the indices are
302// guaranteed (e.g. through shifting) to be below the maximum index. This
303// value must be a power of two.
304constexpr size_t kExternalPointerTableReservationSize = 256 * MB;
305
306// The external pointer table indices stored in HeapObjects as external
307// pointers are shifted to the left by this amount to guarantee that they are
308// smaller than the maximum table size even after the C++ compiler multiplies
309// them by 8 to be used as indexes into a table of 64 bit pointers.
310constexpr uint32_t kExternalPointerIndexShift = 7;
311#elif defined(V8_TARGET_OS_IOS)
312// iOS restricts large memory allocations, with 128 MB being the maximum size we
313// can configure. If we exceed this, SegmentedTable::Initialize will throw a V8
314// out-of-memory error when running the JetStream benchmark
315// (https://browserbench.org/JetStream/).
316constexpr size_t kExternalPointerTableReservationSize = 128 * MB;
317constexpr uint32_t kExternalPointerIndexShift = 8;
318#else
319constexpr size_t kExternalPointerTableReservationSize = 512 * MB;
320constexpr uint32_t kExternalPointerIndexShift = 6;
321#endif // V8_TARGET_OS_ANDROID
322
323// The maximum number of entries in an external pointer table.
324constexpr int kExternalPointerTableEntrySize = 8;
325constexpr int kExternalPointerTableEntrySizeLog2 = 3;
326constexpr size_t kMaxExternalPointers =
327 kExternalPointerTableReservationSize / kExternalPointerTableEntrySize;
328static_assert((1 << (32 - kExternalPointerIndexShift)) == kMaxExternalPointers,
329 "kExternalPointerTableReservationSize and "
330 "kExternalPointerIndexShift don't match");
331
332#else // !V8_COMPRESS_POINTERS
333
334// Needed for the V8.SandboxedExternalPointersCount histogram.
335constexpr size_t kMaxExternalPointers = 0;
336
337#endif // V8_COMPRESS_POINTERS
338
339constexpr uint64_t kExternalPointerMarkBit = 1ULL << 48;
340constexpr uint64_t kExternalPointerTagShift = 49;
341constexpr uint64_t kExternalPointerTagMask = 0x00fe000000000000ULL;
346constexpr uint64_t kExternalPointerTagAndMarkbitMask = 0x00ff000000000000ULL;
347constexpr uint64_t kExternalPointerPayloadMask = 0xff00ffffffffffffULL;
348
349// A ExternalPointerHandle represents a (opaque) reference to an external
350// pointer that can be stored inside the sandbox. A ExternalPointerHandle has
351// meaning only in combination with an (active) Isolate as it references an
352// external pointer stored in the currently active Isolate's
353// ExternalPointerTable. Internally, an ExternalPointerHandles is simply an
354// index into an ExternalPointerTable that is shifted to the left to guarantee
355// that it is smaller than the size of the table.
356using ExternalPointerHandle = uint32_t;
357
358// ExternalPointers point to objects located outside the sandbox. When the V8
359// sandbox is enabled, these are stored on heap as ExternalPointerHandles,
360// otherwise they are simply raw pointers.
361#ifdef V8_ENABLE_SANDBOX
363#else
365#endif
366
369
370// See `ExternalPointerHandle` for the main documentation. The difference to
371// `ExternalPointerHandle` is that the handle does not represent an arbitrary
372// external pointer but always refers to an object managed by `CppHeap`. The
373// handles are using in combination with a dedicated table for `CppHeap`
374// references.
375using CppHeapPointerHandle = uint32_t;
376
377// The actual pointer to objects located on the `CppHeap`. When pointer
378// compression is enabled these pointers are stored as `CppHeapPointerHandle`.
379// In non-compressed configurations the pointers are simply stored as raw
380// pointers.
381#ifdef V8_COMPRESS_POINTERS
383#else
385#endif
386
389
390constexpr uint64_t kCppHeapPointerMarkBit = 1ULL;
391constexpr uint64_t kCppHeapPointerTagShift = 1;
392constexpr uint64_t kCppHeapPointerPayloadShift = 16;
393
394#ifdef V8_COMPRESS_POINTERS
395// CppHeapPointers use a dedicated pointer table. These constants control the
396// size and layout of the table. See the corresponding constants for the
397// external pointer table for further details.
398constexpr size_t kCppHeapPointerTableReservationSize =
399 kExternalPointerTableReservationSize;
400constexpr uint32_t kCppHeapPointerIndexShift = kExternalPointerIndexShift;
401
402constexpr int kCppHeapPointerTableEntrySize = 8;
403constexpr int kCppHeapPointerTableEntrySizeLog2 = 3;
404constexpr size_t kMaxCppHeapPointers =
405 kCppHeapPointerTableReservationSize / kCppHeapPointerTableEntrySize;
406static_assert((1 << (32 - kCppHeapPointerIndexShift)) == kMaxCppHeapPointers,
407 "kCppHeapPointerTableReservationSize and "
408 "kCppHeapPointerIndexShift don't match");
409
410#else // !V8_COMPRESS_POINTERS
411
412// Needed for the V8.SandboxedCppHeapPointersCount histogram.
413constexpr size_t kMaxCppHeapPointers = 0;
414
415#endif // V8_COMPRESS_POINTERS
416
417// The number of tags reserved for embedder data stored in internal fields. The
418// value is picked arbitrarily, and is slightly larger than the number of tags
419// currently used in Chrome.
420#define V8_EMBEDDER_DATA_TAG_COUNT 15
421
422// The number of tags reserved for pointers stored in v8::External. The value is
423// picked arbitrarily, and is slightly larger than the number of tags currently
424// used in Chrome.
425#define V8_EXTERNAL_POINTER_TAG_COUNT 40
426
427// Generic tag range struct to represent ranges of type tags.
428//
429// When referencing external objects via pointer tables, type tags are
430// frequently necessary to guarantee type safety for the external objects. When
431// support for subtyping is necessary, range-based type checks are used in
432// which all subtypes of a given supertype use contiguous tags. This struct can
433// then be used to represent such a type range.
434//
435// As an example, consider the following type hierarchy:
436//
437// A F
438// / \
439// B E
440// / \
441// C D
442//
443// A potential type id assignment for range-based type checks is
444// {A: 0, B: 1, C: 2, D: 3, E: 4, F: 5}. With that, the type check for type A
445// would check for the range [A, E], while the check for B would check range
446// [B, D], and for F it would simply check [F, F].
447//
448// In addition, there is an option for performance tweaks: if the size of the
449// type range corresponding to a supertype is a power of two and starts at a
450// power of two (e.g. [0x100, 0x13f]), then the compiler can often optimize
451// the type check to use even fewer instructions (essentially replace a AND +
452// SUB with a single AND).
453//
454template <typename Tag>
455struct TagRange {
456 static_assert(std::is_enum_v<Tag> &&
457 std::is_same_v<std::underlying_type_t<Tag>, uint16_t>,
458 "Tag parameter must be an enum with base type uint16_t");
459
460 // Construct the inclusive tag range [first, last].
461 constexpr TagRange(Tag first, Tag last) : first(first), last(last) {}
462
463 // Construct a tag range consisting of a single tag.
464 //
465 // A single tag is always implicitly convertible to a tag range. This greatly
466 // increases readability as most of the time, the exact tag of a field is
467 // known and so no tag range needs to explicitly be created for it.
468 constexpr TagRange(Tag tag) // NOLINT(runtime/explicit)
469 : first(tag), last(tag) {}
470
471 // Construct an empty tag range.
472 constexpr TagRange() : TagRange(static_cast<Tag>(0)) {}
473
474 // A tag range is considered empty if it only contains the null tag.
475 constexpr bool IsEmpty() const { return first == 0 && last == 0; }
476
477 constexpr size_t Size() const {
478 if (IsEmpty()) {
479 return 0;
480 } else {
481 return last - first + 1;
482 }
483 }
484
485 constexpr bool Contains(Tag tag) const {
486 // Need to perform the math with uint32_t. Otherwise, the uint16_ts would
487 // be promoted to (signed) int, allowing the compiler to (wrongly) assume
488 // that an underflow cannot happen as that would be undefined behavior.
489 return static_cast<uint32_t>(tag) - static_cast<uint32_t>(first) <=
490 static_cast<uint32_t>(last) - static_cast<uint32_t>(first);
491 }
492
493 constexpr bool Contains(TagRange tag_range) const {
494 return tag_range.first >= first && tag_range.last <= last;
495 }
496
497 constexpr bool operator==(const TagRange other) const {
498 return first == other.first && last == other.last;
499 }
500
501 constexpr size_t hash_value() const {
502 static_assert(std::is_same_v<std::underlying_type_t<Tag>, uint16_t>);
503 return (static_cast<size_t>(first) << 16) | last;
504 }
505
506 // Internally we represent tag ranges as closed ranges [first, last].
507 const Tag first;
508 const Tag last;
509};
510
511//
512// External Pointers.
513//
514// When the sandbox is enabled, external pointers are stored in an external
515// pointer table and are referenced from HeapObjects through an index (a
516// "handle"). When stored in the table, the pointers are tagged with per-type
517// tags to prevent type confusion attacks between different external objects.
518//
519// When loading an external pointer, a range of allowed tags can be specified.
520// This way, type hierarchies can be supported. The main requirement for that
521// is that all (transitive) child classes of a given parent class have type ids
522// in the same range, and that there are no unrelated types in that range. For
523// more details about how to assign type tags to types, see the TagRange class.
524//
525// The external pointer sandboxing mechanism ensures that every access to an
526// external pointer field will result in a valid pointer of the expected type
527// even in the presence of an attacker able to corrupt memory inside the
528// sandbox. However, if any data related to the external object is stored
529// inside the sandbox it may still be corrupted and so must be validated before
530// use or moved into the external object. Further, an attacker will always be
531// able to substitute different external pointers of the same type for each
532// other. Therefore, code using external pointers must be written in a
533// "substitution-safe" way, i.e. it must always be possible to substitute
534// external pointers of the same type without causing memory corruption outside
535// of the sandbox. Generally this is achieved by referencing any group of
536// related external objects through a single external pointer.
537//
538// Currently we use bit 62 for the marking bit which should always be unused as
539// it's part of the non-canonical address range. When Arm's top-byte ignore
540// (TBI) is enabled, this bit will be part of the ignored byte, and we assume
541// that the Embedder is not using this byte (really only this one bit) for any
542// other purpose. This bit also does not collide with the memory tagging
543// extension (MTE) which would use bits [56, 60).
544//
545// External pointer tables are also available even when the sandbox is off but
546// pointer compression is on. In that case, the mechanism can be used to ease
547// alignment requirements as it turns unaligned 64-bit raw pointers into
548// aligned 32-bit indices. To "opt-in" to the external pointer table mechanism
549// for this purpose, instead of using the ExternalPointer accessors one needs to
550// use ExternalPointerHandles directly and use them to access the pointers in an
551// ExternalPointerTable.
552//
553// The tag is currently in practice limited to 15 bits since it needs to fit
554// together with a marking bit into the unused parts of a pointer.
555enum ExternalPointerTag : uint16_t {
558
559 // When adding new tags, please ensure that the code using these tags is
560 // "substitution-safe", i.e. still operate safely if external pointers of the
561 // same type are swapped by an attacker. See comment above for more details.
562
563 // Shared external pointers are owned by the shared Isolate and stored in the
564 // shared external pointer table associated with that Isolate, where they can
565 // be accessed from multiple threads at the same time. The objects referenced
566 // in this way must therefore always be thread-safe.
572
573 // External pointers using these tags are kept in a per-Isolate external
574 // pointer table and can only be accessed when this Isolate is active.
576
577 // Placeholders for embedder data.
580
581 // Placeholders for pointers store in v8::External.
585 // This tag is used when a fast-api callback as a parameter of type
586 // `kPointer`. The V8 fast API is only able to use this generic tag, and is
587 // therefore not supposed to be used in Chrome.
593
594 // InterceptorInfo external pointers.
612
614
616
617 // Foreigns
620
630
631 // Managed
662 // External resources whose lifetime is tied to their entry in the external
663 // pointer table but which are not referenced via a Managed
666
670 // The tags are limited to 7 bits, so the last tag is 0x7f.
672};
673
675
692
693// True if the external pointer must be accessed from the shared isolate's
694// external pointer table.
695V8_INLINE static constexpr bool IsSharedExternalPointerType(
696 ExternalPointerTagRange tag_range) {
698}
699
700// True if the external pointer may live in a read-only object, in which case
701// the table entry will be in the shared read-only segment of the external
702// pointer table.
703V8_INLINE static constexpr bool IsMaybeReadOnlyExternalPointerType(
704 ExternalPointerTagRange tag_range) {
706}
707
708// True if the external pointer references an external object whose lifetime is
709// tied to the entry in the external pointer table.
710// In this case, the entry in the ExternalPointerTable always points to an
711// object derived from ExternalPointerTable::ManagedResource.
712V8_INLINE static constexpr bool IsManagedExternalPointerType(
713 ExternalPointerTagRange tag_range) {
715}
716
717// When an external poiner field can contain the null external pointer handle,
718// the type checking mechanism needs to also check for null.
719// TODO(saelo): this is mostly a temporary workaround to introduce range-based
720// type checks. In the future, we should either (a) change the type tagging
721// scheme so that null always passes or (b) (more likely) introduce dedicated
722// null entries for those tags that need them (similar to other well-known
723// empty value constants such as the empty fixed array).
724V8_INLINE static constexpr bool ExternalPointerCanBeEmpty(
725 ExternalPointerTagRange tag_range) {
726 return tag_range.Contains(kArrayBufferExtensionTag) ||
727 (tag_range.first <= kLastEmbedderDataTag &&
728 kFirstEmbedderDataTag <= tag_range.last) ||
730}
731
732// Indirect Pointers.
733//
734// When the sandbox is enabled, indirect pointers are used to reference
735// HeapObjects that live outside of the sandbox (but are still managed by V8's
736// garbage collector). When object A references an object B through an indirect
737// pointer, object A will contain a IndirectPointerHandle, i.e. a shifted
738// 32-bit index, which identifies an entry in a pointer table (either the
739// trusted pointer table for TrustedObjects, or the code pointer table if it is
740// a Code object). This table entry then contains the actual pointer to object
741// B. Further, object B owns this pointer table entry, and it is responsible
742// for updating the "self-pointer" in the entry when it is relocated in memory.
743// This way, in contrast to "normal" pointers, indirect pointers never need to
744// be tracked by the GC (i.e. there is no remembered set for them).
745// These pointers do not exist when the sandbox is disabled.
746
747// An IndirectPointerHandle represents a 32-bit index into a pointer table.
748using IndirectPointerHandle = uint32_t;
749
750// A null handle always references an entry that contains nullptr.
752
753// When the sandbox is enabled, indirect pointers are used to implement:
754// - TrustedPointers: an indirect pointer using the trusted pointer table (TPT)
755// and referencing a TrustedObject in one of the trusted heap spaces.
756// - CodePointers, an indirect pointer using the code pointer table (CPT) and
757// referencing a Code object together with its instruction stream.
758
759//
760// Trusted Pointers.
761//
762// A pointer to a TrustedObject.
763// When the sandbox is enabled, these are indirect pointers using the trusted
764// pointer table (TPT). They are used to reference trusted objects (located in
765// one of V8's trusted heap spaces, outside of the sandbox) from inside the
766// sandbox in a memory-safe way. When the sandbox is disabled, these are
767// regular tagged pointers.
769
770// The size of the virtual memory reservation for the trusted pointer table.
771// As with the external pointer table, a maximum table size in combination with
772// shifted indices allows omitting bounds checks.
774
775// The trusted pointer handles are stored shifted to the left by this amount
776// to guarantee that they are smaller than the maximum table size.
777constexpr uint32_t kTrustedPointerHandleShift = 9;
778
779// A null handle always references an entry that contains nullptr.
782
783// The maximum number of entries in an trusted pointer table.
786constexpr size_t kMaxTrustedPointers =
788static_assert((1 << (32 - kTrustedPointerHandleShift)) == kMaxTrustedPointers,
789 "kTrustedPointerTableReservationSize and "
790 "kTrustedPointerHandleShift don't match");
791
792//
793// Code Pointers.
794//
795// A pointer to a Code object.
796// Essentially a specialized version of a trusted pointer that (when the
797// sandbox is enabled) uses the code pointer table (CPT) instead of the TPT.
798// Each entry in the CPT contains both a pointer to a Code object as well as a
799// pointer to the Code's entrypoint. This allows calling/jumping into Code with
800// one fewer memory access (compared to the case where the entrypoint pointer
801// first needs to be loaded from the Code object). As such, a CodePointerHandle
802// can be used both to obtain the referenced Code object and to directly load
803// its entrypoint.
804//
805// When the sandbox is disabled, these are regular tagged pointers.
807
808// The size of the virtual memory reservation for the code pointer table.
809// As with the other tables, a maximum table size in combination with shifted
810// indices allows omitting bounds checks.
811constexpr size_t kCodePointerTableReservationSize = 128 * MB;
812
813// Code pointer handles are shifted by a different amount than indirect pointer
814// handles as the tables have a different maximum size.
815constexpr uint32_t kCodePointerHandleShift = 9;
816
817// A null handle always references an entry that contains nullptr.
819
820// It can sometimes be necessary to distinguish a code pointer handle from a
821// trusted pointer handle. A typical example would be a union trusted pointer
822// field that can refer to both Code objects and other trusted objects. To
823// support these use-cases, we use a simple marking scheme where some of the
824// low bits of a code pointer handle are set, while they will be unset on a
825// trusted pointer handle. This way, the correct table to resolve the handle
826// can be determined even in the absence of a type tag.
827constexpr uint32_t kCodePointerHandleMarker = 0x1;
828static_assert(kCodePointerHandleShift > 0);
829static_assert(kTrustedPointerHandleShift > 0);
830
831// The maximum number of entries in a code pointer table.
832constexpr int kCodePointerTableEntrySize = 16;
834constexpr size_t kMaxCodePointers =
836static_assert(
838 "kCodePointerTableReservationSize and kCodePointerHandleShift don't match");
839
842
843// Constants that can be used to mark places that should be modified once
844// certain types of objects are moved out of the sandbox and into trusted space.
850
851// {obj} must be the raw tagged pointer representation of a HeapObject
852// that's guaranteed to never be in ReadOnlySpace.
854 "Use GetCurrentIsolate() instead, which is guaranteed to return the same "
855 "isolate since https://crrev.com/c/6458560.")
857
858// Returns if we need to throw when an error occurs. This infers the language
859// mode based on the current context and the closure. This returns true if the
860// language mode is strict.
861V8_EXPORT bool ShouldThrowOnError(internal::Isolate* isolate);
862
863struct HandleScopeData final {
864 static constexpr uint32_t kSizeInBytes =
866
869 int level;
871
872 void Initialize() {
873 next = limit = nullptr;
874 sealed_level = level = 0;
875 }
876};
877
878static_assert(HandleScopeData::kSizeInBytes == sizeof(HandleScopeData));
879
886#ifdef V8_MAP_PACKING
887 V8_INLINE static constexpr Address UnpackMapWord(Address mapword) {
888 // TODO(wenyuzhao): Clear header metadata.
889 return mapword ^ kMapWordXorMask;
890 }
891#endif
892
893 public:
894 // These values match non-compiler-dependent values defined within
895 // the implementation of v8.
896 static const int kHeapObjectMapOffset = 0;
898 static const int kStringResourceOffset =
900
902 static const int kJSObjectHeaderSize = 3 * kApiTaggedSize;
903#ifdef V8_COMPRESS_POINTERS
906#else // !V8_COMPRESS_POINTERS
909#endif // !V8_COMPRESS_POINTERS
910 static const int kFixedArrayHeaderSize = 2 * kApiTaggedSize;
913#ifdef V8_ENABLE_SANDBOX
915#else
917#endif
920 static const int kStringEncodingMask = 0x8;
921 static const int kExternalTwoByteRepresentationTag = 0x02;
922 static const int kExternalOneByteRepresentationTag = 0x0a;
923
924 // AccessorInfo::data and InterceptorInfo::data field.
926
927 static const uint32_t kNumIsolateDataSlots = 4;
929 static const int kNumberOfBooleanFlags = 6;
930 static const int kErrorMessageParamSize = 1;
931 static const int kTablesAlignmentPaddingSize = 1;
937 static const int kHandleScopeDataSize =
939
940 // ExternalPointerTable and TrustedPointerTable layout guarantees.
942 static const int kSegmentedTableSegmentPoolSize = 4;
943 static const int kExternalPointerTableSize =
945 kSegmentedTableSegmentPoolSize * sizeof(uint32_t);
946 static const int kTrustedPointerTableSize =
948 kSegmentedTableSegmentPoolSize * sizeof(uint32_t);
950
951 // IsolateData layout guarantees.
952 static const int kIsolateCageBaseOffset = 0;
953 static const int kIsolateStackGuardOffset =
955 static const int kVariousBooleanFlagsOffset =
957 static const int kErrorMessageParamOffset =
962 static const int kBuiltinTier0TableOffset =
964 static const int kNewAllocationInfoOffset =
966 static const int kOldAllocationInfoOffset =
968 static const int kLastYoungAllocationOffset =
970
987 static const int kIsolateEmbedderDataOffset =
989#ifdef V8_COMPRESS_POINTERS
990 static const int kIsolateExternalPointerTableOffset =
992 static const int kIsolateSharedExternalPointerTableAddressOffset =
993 kIsolateExternalPointerTableOffset + kExternalPointerTableSize;
994 static const int kIsolateCppHeapPointerTableOffset =
995 kIsolateSharedExternalPointerTableAddressOffset + kApiSystemPointerSize;
996#ifdef V8_ENABLE_SANDBOX
997 static const int kIsolateTrustedCageBaseOffset =
998 kIsolateCppHeapPointerTableOffset + kExternalPointerTableSize;
999 static const int kIsolateTrustedPointerTableOffset =
1000 kIsolateTrustedCageBaseOffset + kApiSystemPointerSize;
1001 static const int kIsolateSharedTrustedPointerTableAddressOffset =
1002 kIsolateTrustedPointerTableOffset + kTrustedPointerTableSize;
1003 static const int kIsolateTrustedPointerPublishingScopeOffset =
1004 kIsolateSharedTrustedPointerTableAddressOffset + kApiSystemPointerSize;
1005 static const int kIsolateCodePointerTableBaseAddressOffset =
1006 kIsolateTrustedPointerPublishingScopeOffset + kApiSystemPointerSize;
1008 kIsolateCodePointerTableBaseAddressOffset + kApiSystemPointerSize;
1009#else
1011 kIsolateCppHeapPointerTableOffset + kExternalPointerTableSize;
1012#endif // V8_ENABLE_SANDBOX
1013#else
1016#endif // V8_COMPRESS_POINTERS
1017 static const int kJSDispatchTableOffset =
1023 static const int kIsolateRootsOffset =
1025
1026#if V8_TARGET_ARCH_PPC64
1027 static constexpr int kFrameCPSlotCount = 1;
1028#else
1029 static constexpr int kFrameCPSlotCount = 0;
1030#endif
1031
1032#if V8_TARGET_ARCH_ARM64
1033 // The padding required to keep SP 16-byte aligned.
1034 static constexpr int kSPAlignmentSlotCount = 1;
1035#else
1036 static constexpr int kSPAlignmentSlotCount = 0;
1037#endif
1038
1039 static const int kFrameTypeApiCallExit = 18;
1040 static const int kFrameTypeApiConstructExit = 19;
1041 static const int kFrameTypeApiNamedAccessorExit = 20;
1043
1044 // Assert scopes
1045 static const int kDisallowGarbageCollectionAlign = alignof(uint32_t);
1046 static const int kDisallowGarbageCollectionSize = sizeof(uint32_t);
1047
1048#if V8_STATIC_ROOTS_BOOL
1049
1050// These constants are copied from static-roots.h and guarded by static asserts.
1051#define EXPORTED_STATIC_ROOTS_PTR_LIST(V) \
1052 V(UndefinedValue, 0x11) \
1053 V(NullValue, 0x2d) \
1054 V(TrueValue, 0x71) \
1055 V(FalseValue, 0x55) \
1056 V(EmptyString, 0x49) \
1057 /* The Hole moves around depending on build flags, so define it */ \
1058 /* separately inside StaticReadOnlyRoot using build macros */ \
1059 V(TheHoleValue, kBuildDependentTheHoleValue)
1060
1061 using Tagged_t = uint32_t;
1062 struct StaticReadOnlyRoot {
1063#ifdef V8_ENABLE_WEBASSEMBLY
1064 static constexpr Tagged_t kBuildDependentTheHoleValue = 0x2fffd;
1065#else
1066 static constexpr Tagged_t kBuildDependentTheHoleValue = 0xfffd;
1067#endif
1068
1069#define DEF_ROOT(name, value) static constexpr Tagged_t k##name = value;
1070 EXPORTED_STATIC_ROOTS_PTR_LIST(DEF_ROOT)
1071#undef DEF_ROOT
1072
1073 // Use 0 for kStringMapLowerBound since string maps are the first maps.
1074 static constexpr Tagged_t kStringMapLowerBound = 0;
1075 static constexpr Tagged_t kStringMapUpperBound = 0x425;
1076
1077#define PLUSONE(...) +1
1078 static constexpr size_t kNumberOfExportedStaticRoots =
1079 2 + EXPORTED_STATIC_ROOTS_PTR_LIST(PLUSONE);
1080#undef PLUSONE
1081 };
1082
1083#endif // V8_STATIC_ROOTS_BOOL
1084
1085 static const int kUndefinedValueRootIndex = 0;
1086 static const int kTheHoleValueRootIndex = 1;
1087 static const int kNullValueRootIndex = 2;
1088 static const int kTrueValueRootIndex = 3;
1089 static const int kFalseValueRootIndex = 4;
1090 static const int kEmptyStringRootIndex = 5;
1091
1093 static const int kNodeFlagsOffset = 1 * kApiSystemPointerSize + 3;
1094 static const int kNodeStateMask = 0x3;
1095 static const int kNodeStateIsWeakValue = 2;
1096
1097 static const int kFirstNonstringType = 0x80;
1098 static const int kOddballType = 0x83;
1099 static const int kForeignType = 0xcc;
1100 static const int kJSSpecialApiObjectType = 0x410;
1101 static const int kJSObjectType = 0x421;
1102 static const int kFirstJSApiObjectType = 0x422;
1103 static const int kLastJSApiObjectType = 0x80A;
1104 // Defines a range [kFirstEmbedderJSApiObjectType, kJSApiObjectTypesCount]
1105 // of JSApiObject instance type values that an embedder can use.
1106 static const int kFirstEmbedderJSApiObjectType = 0;
1109
1110 static const int kUndefinedOddballKind = 4;
1111 static const int kNullOddballKind = 3;
1112
1113 // Constants used by PropertyCallbackInfo to check if we should throw when an
1114 // error occurs.
1115 static const int kDontThrow = 0;
1116 static const int kThrowOnError = 1;
1117 static const int kInferShouldThrowMode = 2;
1118
1119 // Soft limit for AdjustAmountofExternalAllocatedMemory. Trigger an
1120 // incremental GC once the external memory reaches this limit.
1121 static constexpr size_t kExternalAllocationSoftLimit = 64 * 1024 * 1024;
1122
1123#ifdef V8_MAP_PACKING
1124 static const uintptr_t kMapWordMetadataMask = 0xffffULL << 48;
1125 // The lowest two bits of mapwords are always `0b10`
1126 static const uintptr_t kMapWordSignature = 0b10;
1127 // XORing a (non-compressed) map with this mask ensures that the two
1128 // low-order bits are 0b10. The 0 at the end makes this look like a Smi,
1129 // although real Smis have all lower 32 bits unset. We only rely on these
1130 // values passing as Smis in very few places.
1131 static const int kMapWordXorMask = 0b11;
1132#endif
1133
1136#ifdef V8_ENABLE_CHECKS
1137 CheckInitializedImpl(isolate);
1138#endif
1139 }
1140
1141 V8_INLINE static constexpr bool HasHeapObjectTag(Address value) {
1142 return (value & kHeapObjectTagMask) == static_cast<Address>(kHeapObjectTag);
1143 }
1144
1145 V8_INLINE static constexpr int SmiValue(Address value) {
1146 return PlatformSmiTagging::SmiToInt(value);
1147 }
1148
1149 V8_INLINE static constexpr Address AddressToSmi(Address value) {
1150 return (value << (kSmiTagSize + PlatformSmiTagging::kSmiShiftSize)) |
1151 kSmiTag;
1152 }
1153
1154 V8_INLINE static constexpr Address IntToSmi(int value) {
1155 return AddressToSmi(static_cast<Address>(value));
1156 }
1157
1158 template <typename T,
1159 typename std::enable_if_t<std::is_integral_v<T>>* = nullptr>
1160 V8_INLINE static constexpr Address IntegralToSmi(T value) {
1161 return AddressToSmi(static_cast<Address>(value));
1162 }
1163
1164 template <typename T,
1165 typename std::enable_if_t<std::is_integral_v<T>>* = nullptr>
1166 V8_INLINE static constexpr bool IsValidSmi(T value) {
1167 return PlatformSmiTagging::IsValidSmi(value);
1168 }
1169
1170 template <typename T,
1171 typename std::enable_if_t<std::is_integral_v<T>>* = nullptr>
1172 static constexpr std::optional<Address> TryIntegralToSmi(T value) {
1173 if (V8_LIKELY(PlatformSmiTagging::IsValidSmi(value))) {
1174 return {AddressToSmi(static_cast<Address>(value))};
1175 }
1176 return {};
1177 }
1178
1179#if V8_STATIC_ROOTS_BOOL
1180 V8_INLINE static bool is_identical(Address obj, Tagged_t constant) {
1181 return static_cast<Tagged_t>(obj) == constant;
1182 }
1183
1184 V8_INLINE static bool CheckInstanceMapRange(Address obj, Tagged_t first_map,
1185 Tagged_t last_map) {
1186 auto map = ReadRawField<Tagged_t>(obj, kHeapObjectMapOffset);
1187#ifdef V8_MAP_PACKING
1188 map = UnpackMapWord(map);
1189#endif
1190 return map >= first_map && map <= last_map;
1191 }
1192#endif
1193
1196#ifdef V8_MAP_PACKING
1197 map = UnpackMapWord(map);
1198#endif
1199 return ReadRawField<uint16_t>(map, kMapInstanceTypeOffset);
1200 }
1201
1203 if (!HasHeapObjectTag(obj)) return kNullAddress;
1205#ifdef V8_MAP_PACKING
1206 map = UnpackMapWord(map);
1207#endif
1208 return map;
1209 }
1210
1213 }
1214
1215 V8_INLINE static bool IsExternalTwoByteString(int instance_type) {
1216 int representation = (instance_type & kStringRepresentationAndEncodingMask);
1217 return representation == kExternalTwoByteRepresentationTag;
1218 }
1219
1220 V8_INLINE static constexpr bool CanHaveInternalField(int instance_type) {
1221 static_assert(kJSObjectType + 1 == kFirstJSApiObjectType);
1222 static_assert(kJSObjectType < kLastJSApiObjectType);
1224 // Check for IsJSObject() || IsJSSpecialApiObject() || IsJSApiObject()
1225 return instance_type == kJSSpecialApiObjectType ||
1226 // inlined version of base::IsInRange
1227 (static_cast<unsigned>(static_cast<unsigned>(instance_type) -
1228 static_cast<unsigned>(kJSObjectType)) <=
1229 static_cast<unsigned>(kLastJSApiObjectType - kJSObjectType));
1230 }
1231
1232 V8_INLINE static uint8_t GetNodeFlag(Address* obj, int shift) {
1233 uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
1234 return *addr & static_cast<uint8_t>(1U << shift);
1235 }
1236
1237 V8_INLINE static void UpdateNodeFlag(Address* obj, bool value, int shift) {
1238 uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
1239 uint8_t mask = static_cast<uint8_t>(1U << shift);
1240 *addr = static_cast<uint8_t>((*addr & ~mask) | (value << shift));
1241 }
1242
1243 V8_INLINE static uint8_t GetNodeState(Address* obj) {
1244 uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
1245 return *addr & kNodeStateMask;
1246 }
1247
1248 V8_INLINE static void UpdateNodeState(Address* obj, uint8_t value) {
1249 uint8_t* addr = reinterpret_cast<uint8_t*>(obj) + kNodeFlagsOffset;
1250 *addr = static_cast<uint8_t>((*addr & ~kNodeStateMask) | value);
1251 }
1252
1253 V8_INLINE static void SetEmbedderData(v8::Isolate* isolate, uint32_t slot,
1254 void* data) {
1255 Address addr = reinterpret_cast<Address>(isolate) +
1257 *reinterpret_cast<void**>(addr) = data;
1258 }
1259
1260 V8_INLINE static void* GetEmbedderData(const v8::Isolate* isolate,
1261 uint32_t slot) {
1262 Address addr = reinterpret_cast<Address>(isolate) +
1264 return *reinterpret_cast<void* const*>(addr);
1265 }
1266
1268 Address addr =
1269 reinterpret_cast<Address>(isolate) + kIsolateHandleScopeDataOffset;
1270 return reinterpret_cast<HandleScopeData*>(addr);
1271 }
1272
1274 Address addr =
1275 reinterpret_cast<Address>(isolate) + kIsolateLongTaskStatsCounterOffset;
1276 ++(*reinterpret_cast<size_t*>(addr));
1277 }
1278
1279 V8_INLINE static Address* GetRootSlot(v8::Isolate* isolate, int index) {
1280 Address addr = reinterpret_cast<Address>(isolate) + kIsolateRootsOffset +
1281 index * kApiSystemPointerSize;
1282 return reinterpret_cast<Address*>(addr);
1283 }
1284
1285 V8_INLINE static Address GetRoot(v8::Isolate* isolate, int index) {
1286#if V8_STATIC_ROOTS_BOOL
1287 Address base = *reinterpret_cast<Address*>(
1288 reinterpret_cast<uintptr_t>(isolate) + kIsolateCageBaseOffset);
1289 switch (index) {
1290#define DECOMPRESS_ROOT(name, ...) \
1291 case k##name##RootIndex: \
1292 return base + StaticReadOnlyRoot::k##name;
1293 EXPORTED_STATIC_ROOTS_PTR_LIST(DECOMPRESS_ROOT)
1294#undef DECOMPRESS_ROOT
1295#undef EXPORTED_STATIC_ROOTS_PTR_LIST
1296 default:
1297 break;
1298 }
1299#endif // V8_STATIC_ROOTS_BOOL
1300 return *GetRootSlot(isolate, index);
1301 }
1302
1303#ifdef V8_ENABLE_SANDBOX
1304 V8_INLINE static Address* GetExternalPointerTableBase(v8::Isolate* isolate) {
1305 Address addr = reinterpret_cast<Address>(isolate) +
1306 kIsolateExternalPointerTableOffset +
1308 return *reinterpret_cast<Address**>(addr);
1309 }
1310
1311 V8_INLINE static Address* GetSharedExternalPointerTableBase(
1312 v8::Isolate* isolate) {
1313 Address addr = reinterpret_cast<Address>(isolate) +
1314 kIsolateSharedExternalPointerTableAddressOffset;
1315 addr = *reinterpret_cast<Address*>(addr);
1317 return *reinterpret_cast<Address**>(addr);
1318 }
1319#endif
1320
1321 template <typename T>
1322 V8_INLINE static T ReadRawField(Address heap_object_ptr, int offset) {
1323 Address addr = heap_object_ptr + offset - kHeapObjectTag;
1324#ifdef V8_COMPRESS_POINTERS
1325 if constexpr (sizeof(T) > kApiTaggedSize) {
1326 // TODO(ishell, v8:8875): When pointer compression is enabled 8-byte size
1327 // fields (external pointers, doubles and BigInt data) are only
1328 // kTaggedSize aligned so we have to use unaligned pointer friendly way of
1329 // accessing them in order to avoid undefined behavior in C++ code.
1330 T r;
1331 memcpy(&r, reinterpret_cast<void*>(addr), sizeof(T));
1332 return r;
1333 }
1334#endif
1335 return *reinterpret_cast<const T*>(addr);
1336 }
1337
1339 int offset) {
1340#ifdef V8_COMPRESS_POINTERS
1341 uint32_t value = ReadRawField<uint32_t>(heap_object_ptr, offset);
1342 Address base = GetPtrComprCageBaseFromOnHeapAddress(heap_object_ptr);
1343 return base + static_cast<Address>(static_cast<uintptr_t>(value));
1344#else
1345 return ReadRawField<Address>(heap_object_ptr, offset);
1346#endif
1347 }
1348
1350 int offset) {
1351#ifdef V8_COMPRESS_POINTERS
1352 uint32_t value = ReadRawField<uint32_t>(heap_object_ptr, offset);
1353 return static_cast<Address>(static_cast<uintptr_t>(value));
1354#else
1355 return ReadRawField<Address>(heap_object_ptr, offset);
1356#endif
1357 }
1358
1359 // Returns v8::Isolate::Current(), but without needing to include the
1360 // v8-isolate.h header.
1362
1364#ifdef V8_ENABLE_SANDBOX
1365 return GetCurrentIsolate();
1366#else
1367 // Not used in non-sandbox mode.
1368 return nullptr;
1369#endif
1370 }
1371
1372 template <ExternalPointerTagRange tag_range>
1374 Address heap_object_ptr,
1375 int offset) {
1376#ifdef V8_ENABLE_SANDBOX
1377 static_assert(!tag_range.IsEmpty());
1378 // See src/sandbox/external-pointer-table.h. Logic duplicated here so
1379 // it can be inlined and doesn't require an additional call.
1380 Address* table = IsSharedExternalPointerType(tag_range)
1381 ? GetSharedExternalPointerTableBase(isolate)
1382 : GetExternalPointerTableBase(isolate);
1384 ReadRawField<ExternalPointerHandle>(heap_object_ptr, offset);
1385 uint32_t index = handle >> kExternalPointerIndexShift;
1386 std::atomic<Address>* ptr =
1387 reinterpret_cast<std::atomic<Address>*>(&table[index]);
1388 Address entry = std::atomic_load_explicit(ptr, std::memory_order_relaxed);
1389 ExternalPointerTag actual_tag = static_cast<ExternalPointerTag>(
1391 if (V8_LIKELY(tag_range.Contains(actual_tag))) {
1392 return entry & kExternalPointerPayloadMask;
1393 } else {
1394 return 0;
1395 }
1396 return entry;
1397#else
1398 return ReadRawField<Address>(heap_object_ptr, offset);
1399#endif // V8_ENABLE_SANDBOX
1400 }
1401
1403 v8::Isolate* isolate, Address heap_object_ptr, int offset,
1404 ExternalPointerTagRange tag_range) {
1405#ifdef V8_ENABLE_SANDBOX
1406 // See src/sandbox/external-pointer-table.h. Logic duplicated here so
1407 // it can be inlined and doesn't require an additional call.
1408 Address* table = IsSharedExternalPointerType(tag_range)
1409 ? GetSharedExternalPointerTableBase(isolate)
1410 : GetExternalPointerTableBase(isolate);
1412 ReadRawField<ExternalPointerHandle>(heap_object_ptr, offset);
1413 uint32_t index = handle >> kExternalPointerIndexShift;
1414 std::atomic<Address>* ptr =
1415 reinterpret_cast<std::atomic<Address>*>(&table[index]);
1416 Address entry = std::atomic_load_explicit(ptr, std::memory_order_relaxed);
1417 ExternalPointerTag actual_tag = static_cast<ExternalPointerTag>(
1419 if (V8_LIKELY(tag_range.Contains(actual_tag))) {
1420 return entry & kExternalPointerPayloadMask;
1421 } else {
1422 return 0;
1423 }
1424 return entry;
1425#else
1426 return ReadRawField<Address>(heap_object_ptr, offset);
1427#endif // V8_ENABLE_SANDBOX
1428 }
1429
1430#ifdef V8_COMPRESS_POINTERS
1431 V8_INLINE static Address GetPtrComprCageBaseFromOnHeapAddress(Address addr) {
1432 return addr & -static_cast<intptr_t>(kPtrComprCageBaseAlignment);
1433 }
1434
1435 V8_INLINE static uint32_t CompressTagged(Address value) {
1436 return static_cast<uint32_t>(value);
1437 }
1438
1439 V8_INLINE static Address DecompressTaggedField(Address heap_object_ptr,
1440 uint32_t value) {
1441 Address base = GetPtrComprCageBaseFromOnHeapAddress(heap_object_ptr);
1442 return base + static_cast<Address>(static_cast<uintptr_t>(value));
1443 }
1444
1445#endif // V8_COMPRESS_POINTERS
1446};
1447
1448// Only perform cast check for types derived from v8::Data since
1449// other types do not implement the Cast method.
1450template <bool PerformCheck>
1452 template <class T>
1453 static void Perform(T* data);
1454};
1455
1456template <>
1457template <class T>
1459 T::Cast(data);
1460}
1461
1462template <>
1463template <class T>
1465
1466template <class T>
1469 !std::is_same_v<Data, std::remove_cv_t<T>>>::Perform(data);
1470}
1471
1472// A base class for backing stores, which is needed due to vagaries of
1473// how static casts work with std::shared_ptr.
1475
1476// The maximum value in enum GarbageCollectionReason, defined in heap.h.
1477// This is needed for histograms sampling garbage collection reasons.
1479
1480// Base class for the address block allocator compatible with standard
1481// containers, which registers its allocated range as strong roots.
1483 public:
1484 Heap* heap() const { return heap_; }
1485
1486 constexpr bool operator==(const StrongRootAllocatorBase&) const = default;
1487
1488 protected:
1489 explicit StrongRootAllocatorBase(Heap* heap) : heap_(heap) {}
1490 explicit StrongRootAllocatorBase(LocalHeap* heap);
1493 explicit StrongRootAllocatorBase(LocalIsolate* isolate);
1494
1495 // Allocate/deallocate a range of n elements of type internal::Address.
1497 void deallocate_impl(Address* p, size_t n) noexcept;
1498
1499 private:
1500 Heap* heap_;
1501};
1502
1503// The general version of this template behaves just as std::allocator, with
1504// the exception that the constructor takes the isolate as parameter. Only
1505// specialized versions, e.g., internal::StrongRootAllocator<internal::Address>
1506// and internal::StrongRootAllocator<v8::Local<T>> register the allocated range
1507// as strong roots.
1508template <typename T>
1509class StrongRootAllocator : private std::allocator<T> {
1510 public:
1511 using value_type = T;
1512
1513 template <typename HeapOrIsolateT>
1514 explicit StrongRootAllocator(HeapOrIsolateT*) {}
1515 template <typename U>
1517
1518 using std::allocator<T>::allocate;
1519 using std::allocator<T>::deallocate;
1520};
1521
1522template <typename Iterator>
1523concept HasIteratorConcept = requires { typename Iterator::iterator_concept; };
1524
1525template <typename Iterator>
1527 requires { typename Iterator::iterator_category; };
1528
1529// Helper struct that contains an `iterator_concept` type alias only when either
1530// `Iterator` or `std::iterator_traits<Iterator>` do.
1531// Default: no alias.
1532template <typename Iterator>
1534// Use `Iterator::iterator_concept` if available.
1535template <HasIteratorConcept Iterator>
1537 using iterator_concept = typename Iterator::iterator_concept;
1538};
1539// Otherwise fall back to `std::iterator_traits<Iterator>` if possible.
1540template <typename Iterator>
1544 typename std::iterator_traits<Iterator>::iterator_concept;
1545};
1546
1547// A class of iterators that wrap some different iterator type.
1548// If specified, ElementType is the type of element accessed by the wrapper
1549// iterator; in this case, the actual reference and pointer types of Iterator
1550// must be convertible to ElementType& and ElementType*, respectively.
1551template <typename Iterator, typename ElementType = void>
1553 public:
1554 static_assert(
1555 std::is_void_v<ElementType> ||
1556 (std::is_convertible_v<typename std::iterator_traits<Iterator>::pointer,
1557 std::add_pointer_t<ElementType>> &&
1558 std::is_convertible_v<typename std::iterator_traits<Iterator>::reference,
1559 std::add_lvalue_reference_t<ElementType>>));
1560
1562 typename std::iterator_traits<Iterator>::difference_type;
1564 std::conditional_t<std::is_void_v<ElementType>,
1565 typename std::iterator_traits<Iterator>::value_type,
1566 ElementType>;
1567 using pointer =
1568 std::conditional_t<std::is_void_v<ElementType>,
1569 typename std::iterator_traits<Iterator>::pointer,
1570 std::add_pointer_t<ElementType>>;
1572 std::conditional_t<std::is_void_v<ElementType>,
1573 typename std::iterator_traits<Iterator>::reference,
1574 std::add_lvalue_reference_t<ElementType>>;
1576 typename std::iterator_traits<Iterator>::iterator_category;
1577
1578 constexpr WrappedIterator() noexcept = default;
1579 constexpr explicit WrappedIterator(Iterator it) noexcept : it_(it) {}
1580
1581 template <typename OtherIterator, typename OtherElementType>
1582 requires std::is_convertible_v<OtherIterator, Iterator>
1585 : it_(other.base()) {}
1586
1587 [[nodiscard]] constexpr reference operator*() const noexcept { return *it_; }
1588 [[nodiscard]] constexpr pointer operator->() const noexcept {
1589 if constexpr (std::is_pointer_v<Iterator>) {
1590 return it_;
1591 } else {
1592 return it_.operator->();
1593 }
1594 }
1595
1596 template <typename OtherIterator, typename OtherElementType>
1597 [[nodiscard]] constexpr bool operator==(
1599 const noexcept {
1600 return it_ == other.base();
1601 }
1602
1603 template <typename OtherIterator, typename OtherElementType>
1604 [[nodiscard]] constexpr auto operator<=>(
1606 const noexcept {
1607 if constexpr (std::three_way_comparable_with<Iterator, OtherIterator>) {
1608 return it_ <=> other.base();
1609 } else if constexpr (std::totally_ordered_with<Iterator, OtherIterator>) {
1610 if (it_ < other.base()) {
1611 return std::strong_ordering::less;
1612 }
1613 return (it_ > other.base()) ? std::strong_ordering::greater
1614 : std::strong_ordering::equal;
1615 } else {
1616 if (it_ < other.base()) {
1617 return std::partial_ordering::less;
1618 }
1619 if (other.base() < it_) {
1620 return std::partial_ordering::greater;
1621 }
1622 return (it_ == other.base()) ? std::partial_ordering::equivalent
1623 : std::partial_ordering::unordered;
1624 }
1625 }
1626
1627 constexpr WrappedIterator& operator++() noexcept {
1628 ++it_;
1629 return *this;
1630 }
1631 constexpr WrappedIterator operator++(int) noexcept {
1632 WrappedIterator result(*this);
1633 ++(*this);
1634 return result;
1635 }
1636
1637 constexpr WrappedIterator& operator--() noexcept {
1638 --it_;
1639 return *this;
1640 }
1641 constexpr WrappedIterator operator--(int) noexcept {
1642 WrappedIterator result(*this);
1643 --(*this);
1644 return result;
1645 }
1646 [[nodiscard]] constexpr WrappedIterator operator+(
1647 difference_type n) const noexcept {
1648 WrappedIterator result(*this);
1649 result += n;
1650 return result;
1651 }
1652 [[nodiscard]] friend constexpr WrappedIterator operator+(
1653 difference_type n, const WrappedIterator& x) noexcept {
1654 return x + n;
1655 }
1657 it_ += n;
1658 return *this;
1659 }
1660 [[nodiscard]] constexpr WrappedIterator operator-(
1661 difference_type n) const noexcept {
1662 return *this + -n;
1663 }
1665 return *this += -n;
1666 }
1667 template <typename OtherIterator, typename OtherElementType>
1668 [[nodiscard]] constexpr auto operator-(
1670 const noexcept {
1671 return it_ - other.base();
1672 }
1673 [[nodiscard]] constexpr reference operator[](
1674 difference_type n) const noexcept {
1675 return it_[n];
1676 }
1677
1678 [[nodiscard]] constexpr const Iterator& base() const noexcept { return it_; }
1679
1680 private:
1681 Iterator it_;
1682};
1683
1684// Helper functions about values contained in handles.
1685// A value is either an indirect pointer or a direct pointer, depending on
1686// whether direct local support is enabled.
1687class ValueHelper final {
1688 public:
1689 // ValueHelper::InternalRepresentationType is an abstract type that
1690 // corresponds to the internal representation of v8::Local and essentially
1691 // to what T* really is (these two are always in sync). This type is used in
1692 // methods like GetDataFromSnapshotOnce that need access to a handle's
1693 // internal representation. In particular, if `x` is a `v8::Local<T>`, then
1694 // `v8::Local<T>::FromRepr(x.repr())` gives exactly the same handle as `x`.
1695#ifdef V8_ENABLE_DIRECT_HANDLE
1696 static constexpr Address kTaggedNullAddress = 1;
1697
1699 static constexpr InternalRepresentationType kEmpty = kTaggedNullAddress;
1700#else
1702 static constexpr InternalRepresentationType kEmpty = nullptr;
1703#endif // V8_ENABLE_DIRECT_HANDLE
1704
1705 template <typename T>
1706 V8_INLINE static bool IsEmpty(T* value) {
1707 return ValueAsRepr(value) == kEmpty;
1708 }
1709
1710 // Returns a handle's "value" for all kinds of abstract handles. For Local,
1711 // it is equivalent to `*handle`. The variadic parameters support handle
1712 // types with extra type parameters, like `Persistent<T, M>`.
1713 template <template <typename T, typename... Ms> typename H, typename T,
1714 typename... Ms>
1715 V8_INLINE static T* HandleAsValue(const H<T, Ms...>& handle) {
1716 return handle.template value<T>();
1717 }
1718
1719#ifdef V8_ENABLE_DIRECT_HANDLE
1720
1721 template <typename T>
1722 V8_INLINE static Address ValueAsAddress(const T* value) {
1723 return reinterpret_cast<Address>(value);
1724 }
1725
1726 template <typename T, bool check_null = true, typename S>
1727 V8_INLINE static T* SlotAsValue(S* slot) {
1728 if (check_null && slot == nullptr) {
1729 return reinterpret_cast<T*>(kTaggedNullAddress);
1730 }
1731 return *reinterpret_cast<T**>(slot);
1732 }
1733
1734 template <typename T>
1735 V8_INLINE static InternalRepresentationType ValueAsRepr(const T* value) {
1736 return reinterpret_cast<InternalRepresentationType>(value);
1737 }
1738
1739 template <typename T>
1741 return reinterpret_cast<T*>(repr);
1742 }
1743
1744#else // !V8_ENABLE_DIRECT_HANDLE
1745
1746 template <typename T>
1747 V8_INLINE static Address ValueAsAddress(const T* value) {
1748 return *reinterpret_cast<const Address*>(value);
1749 }
1750
1751 template <typename T, bool check_null = true, typename S>
1752 V8_INLINE static T* SlotAsValue(S* slot) {
1753 return reinterpret_cast<T*>(slot);
1754 }
1755
1756 template <typename T>
1758 return const_cast<InternalRepresentationType>(
1759 reinterpret_cast<const Address*>(value));
1760 }
1761
1762 template <typename T>
1764 return reinterpret_cast<T*>(repr);
1765 }
1766
1767#endif // V8_ENABLE_DIRECT_HANDLE
1768};
1769
1773class HandleHelper final {
1774 public:
1785 template <typename T1, typename T2>
1786 V8_INLINE static bool EqualHandles(const T1& lhs, const T2& rhs) {
1787 if (lhs.IsEmpty()) return rhs.IsEmpty();
1788 if (rhs.IsEmpty()) return false;
1789 return lhs.ptr() == rhs.ptr();
1790 }
1791};
1792
1794
1795// These functions are here just to match friend declarations in
1796// XxxCallbackInfo classes allowing these functions to access the internals
1797// of the info objects. These functions are supposed to be called by debugger
1798// macros.
1799void PrintFunctionCallbackInfo(void* function_callback_info);
1800void PrintPropertyCallbackInfo(void* property_callback_info);
1801
1802} // namespace internal
1803} // namespace v8
1804
1805#endif // INCLUDE_V8_INTERNAL_H_
Definition: v8-isolate.h:291
Definition: v8-internal.h:1474
Definition: v8-internal.h:1773
static bool EqualHandles(const T1 &lhs, const T2 &rhs)
Definition: v8-internal.h:1786
Definition: v8-internal.h:885
static Address LoadMap(Address obj)
Definition: v8-internal.h:1202
static constexpr size_t kExternalAllocationSoftLimit
Definition: v8-internal.h:1121
static bool IsExternalTwoByteString(int instance_type)
Definition: v8-internal.h:1215
static const int kIsolateCageBaseOffset
Definition: v8-internal.h:952
static const int kEmbedderDataArrayHeaderSize
Definition: v8-internal.h:911
static const int kHeapObjectMapOffset
Definition: v8-internal.h:896
static const int kEmbedderDataSlotSize
Definition: v8-internal.h:912
static const int kIsolateApiCallbackThunkArgumentOffset
Definition: v8-internal.h:1014
static Address ReadExternalPointerField(v8::Isolate *isolate, Address heap_object_ptr, int offset)
Definition: v8-internal.h:1373
static const int kJSAPIObjectWithEmbedderSlotsHeaderSize
Definition: v8-internal.h:907
static constexpr bool HasHeapObjectTag(Address value)
Definition: v8-internal.h:1141
static Address ReadExternalPointerField(v8::Isolate *isolate, Address heap_object_ptr, int offset, ExternalPointerTagRange tag_range)
Definition: v8-internal.h:1402
static const int kOddballType
Definition: v8-internal.h:1098
static const int kInferShouldThrowMode
Definition: v8-internal.h:1117
static const int kNewAllocationInfoOffset
Definition: v8-internal.h:964
static Address GetRoot(v8::Isolate *isolate, int index)
Definition: v8-internal.h:1285
static const int kStringEncodingMask
Definition: v8-internal.h:920
static const int kIsolateFastCCallCallerPcOffset
Definition: v8-internal.h:974
static uint8_t GetNodeFlag(Address *obj, int shift)
Definition: v8-internal.h:1232
static const int kIsolateThreadLocalTopOffset
Definition: v8-internal.h:983
static const uint32_t kNumIsolateDataSlots
Definition: v8-internal.h:927
static const int kForeignType
Definition: v8-internal.h:1099
static const int kJSDispatchTableOffset
Definition: v8-internal.h:1017
static const int kFirstEmbedderJSApiObjectType
Definition: v8-internal.h:1106
static const int kNumberOfBooleanFlags
Definition: v8-internal.h:929
static uint8_t GetNodeState(Address *obj)
Definition: v8-internal.h:1243
static const int kThreadLocalTopSize
Definition: v8-internal.h:936
static const int kIsolateRootsOffset
Definition: v8-internal.h:1023
static const int kFrameTypeApiCallExit
Definition: v8-internal.h:1039
static const int kExternalPointerTableSize
Definition: v8-internal.h:943
static const int kUndefinedOddballKind
Definition: v8-internal.h:1110
static const int kMapInstanceTypeOffset
Definition: v8-internal.h:897
static constexpr Address AddressToSmi(Address value)
Definition: v8-internal.h:1149
static const int kIsolateStackGuardOffset
Definition: v8-internal.h:953
static const int kLinearAllocationAreaSize
Definition: v8-internal.h:935
static const int kFastCCallAlignmentPaddingSize
Definition: v8-internal.h:971
static const int kDisallowGarbageCollectionAlign
Definition: v8-internal.h:1045
static const int kIsolateFastCCallCallerFpOffset
Definition: v8-internal.h:977
static const int kErrorMessageParamSize
Definition: v8-internal.h:930
static const int kSegmentedTableSegmentPoolSize
Definition: v8-internal.h:942
static void CheckInitialized(v8::Isolate *isolate)
Definition: v8-internal.h:1135
static void UpdateNodeState(Address *obj, uint8_t value)
Definition: v8-internal.h:1248
static constexpr Address IntegralToSmi(T value)
Definition: v8-internal.h:1160
static constexpr bool IsValidSmi(T value)
Definition: v8-internal.h:1166
static const int kJSObjectType
Definition: v8-internal.h:1101
static const int kBuiltinTier0TableOffset
Definition: v8-internal.h:962
static const int kIsolateLongTaskStatsCounterOffset
Definition: v8-internal.h:981
static const int kNativeContextEmbedderDataOffset
Definition: v8-internal.h:918
static const int kLastJSApiObjectType
Definition: v8-internal.h:1103
static constexpr bool CanHaveInternalField(int instance_type)
Definition: v8-internal.h:1220
static constexpr int kSPAlignmentSlotCount
Definition: v8-internal.h:1036
static const int kIsolateHandleScopeDataOffset
Definition: v8-internal.h:985
static const int kFirstNonstringType
Definition: v8-internal.h:1097
static const int kEmptyStringRootIndex
Definition: v8-internal.h:1090
static const int kBuiltinTier0EntryTableOffset
Definition: v8-internal.h:959
static const int kFrameTypeApiIndexedAccessorExit
Definition: v8-internal.h:1042
static const int kFixedArrayHeaderSize
Definition: v8-internal.h:910
static const int kNullOddballKind
Definition: v8-internal.h:1111
static const int kUndefinedValueRootIndex
Definition: v8-internal.h:1085
static const int kExternalTwoByteRepresentationTag
Definition: v8-internal.h:921
static constexpr Address IntToSmi(int value)
Definition: v8-internal.h:1154
static const int kDontThrow
Definition: v8-internal.h:1115
static void CheckInitializedImpl(v8::Isolate *isolate)
static void * GetEmbedderData(const v8::Isolate *isolate, uint32_t slot)
Definition: v8-internal.h:1260
static const int kStackGuardSize
Definition: v8-internal.h:928
static const int kNodeStateMask
Definition: v8-internal.h:1094
static HandleScopeData * GetHandleScopeData(v8::Isolate *isolate)
Definition: v8-internal.h:1267
static const int kNodeStateIsWeakValue
Definition: v8-internal.h:1095
static const int kFirstJSApiObjectType
Definition: v8-internal.h:1102
static const int kStringResourceOffset
Definition: v8-internal.h:898
static const int kErrorMessageParamOffset
Definition: v8-internal.h:957
static const int kExternalPointerTableBasePointerOffset
Definition: v8-internal.h:941
static const int kFalseValueRootIndex
Definition: v8-internal.h:1089
static const int kIsolateRegexpExecVectorArgumentOffset
Definition: v8-internal.h:1019
static const int kIsolateFastApiCallTargetOffset
Definition: v8-internal.h:979
static const int kTrueValueRootIndex
Definition: v8-internal.h:1088
static int GetInstanceType(Address obj)
Definition: v8-internal.h:1194
static const int kThrowOnError
Definition: v8-internal.h:1116
static Address ReadTaggedSignedField(Address heap_object_ptr, int offset)
Definition: v8-internal.h:1349
static const int kOddballKindOffset
Definition: v8-internal.h:901
static const int kBuiltinTier0TableSize
Definition: v8-internal.h:934
static const int kFrameTypeApiConstructExit
Definition: v8-internal.h:1040
static const int kContinuationPreservedEmbedderDataOffset
Definition: v8-internal.h:1021
static const int kLastYoungAllocationOffset
Definition: v8-internal.h:968
static Address ReadTaggedPointerField(Address heap_object_ptr, int offset)
Definition: v8-internal.h:1338
static const int kFrameTypeApiNamedAccessorExit
Definition: v8-internal.h:1041
static const int kNullValueRootIndex
Definition: v8-internal.h:1087
static void SetEmbedderData(v8::Isolate *isolate, uint32_t slot, void *data)
Definition: v8-internal.h:1253
static Address * GetRootSlot(v8::Isolate *isolate, int index)
Definition: v8-internal.h:1279
static const int kTrustedPointerTableSize
Definition: v8-internal.h:946
static const int kTheHoleValueRootIndex
Definition: v8-internal.h:1086
static constexpr int SmiValue(Address value)
Definition: v8-internal.h:1145
static const int kTablesAlignmentPaddingSize
Definition: v8-internal.h:931
static const int kHandleScopeDataSize
Definition: v8-internal.h:937
static const int kExternalOneByteRepresentationTag
Definition: v8-internal.h:922
static const int kBuiltinTier0EntryTableSize
Definition: v8-internal.h:933
static void UpdateNodeFlag(Address *obj, bool value, int shift)
Definition: v8-internal.h:1237
static const int kCallbackInfoDataOffset
Definition: v8-internal.h:925
static void IncrementLongTasksStatsCounter(v8::Isolate *isolate)
Definition: v8-internal.h:1273
static const int kDisallowGarbageCollectionSize
Definition: v8-internal.h:1046
static const int kOldAllocationInfoOffset
Definition: v8-internal.h:966
static const int kIsolateEmbedderDataOffset
Definition: v8-internal.h:987
static T ReadRawField(Address heap_object_ptr, int offset)
Definition: v8-internal.h:1322
static v8::Isolate * GetCurrentIsolate()
static constexpr int kFrameCPSlotCount
Definition: v8-internal.h:1029
static const int kEmbedderDataSlotExternalPointerOffset
Definition: v8-internal.h:916
static v8::Isolate * GetCurrentIsolateForSandbox()
Definition: v8-internal.h:1363
static int GetOddballKind(Address obj)
Definition: v8-internal.h:1211
static const int kNodeFlagsOffset
Definition: v8-internal.h:1093
static const int kTrustedPointerTableBasePointerOffset
Definition: v8-internal.h:949
static const int kRegExpStaticResultOffsetsVectorSize
Definition: v8-internal.h:932
static const int kLastEmbedderJSApiObjectType
Definition: v8-internal.h:1107
static const int kVariousBooleanFlagsOffset
Definition: v8-internal.h:955
static constexpr std::optional< Address > TryIntegralToSmi(T value)
Definition: v8-internal.h:1172
static const int kNodeClassIdOffset
Definition: v8-internal.h:1092
static const int kStringRepresentationAndEncodingMask
Definition: v8-internal.h:919
static const int kJSObjectHeaderSize
Definition: v8-internal.h:902
static const int kJSSpecialApiObjectType
Definition: v8-internal.h:1100
Definition: v8-internal.h:1482
constexpr bool operator==(const StrongRootAllocatorBase &) const =default
StrongRootAllocatorBase(Heap *heap)
Definition: v8-internal.h:1489
StrongRootAllocatorBase(v8::Isolate *isolate)
StrongRootAllocatorBase(LocalIsolate *isolate)
void deallocate_impl(Address *p, size_t n) noexcept
Heap * heap() const
Definition: v8-internal.h:1484
Definition: v8-internal.h:1509
StrongRootAllocator(HeapOrIsolateT *)
Definition: v8-internal.h:1514
T value_type
Definition: v8-internal.h:1511
StrongRootAllocator(const StrongRootAllocator< U > &other) noexcept
Definition: v8-internal.h:1516
Definition: v8-internal.h:1687
static Address ValueAsAddress(const T *value)
Definition: v8-internal.h:1747
static T * ReprAsValue(InternalRepresentationType repr)
Definition: v8-internal.h:1763
internal::Address * InternalRepresentationType
Definition: v8-internal.h:1701
static T * SlotAsValue(S *slot)
Definition: v8-internal.h:1752
static T * HandleAsValue(const H< T, Ms... > &handle)
Definition: v8-internal.h:1715
static InternalRepresentationType ValueAsRepr(const T *value)
Definition: v8-internal.h:1757
static bool IsEmpty(T *value)
Definition: v8-internal.h:1706
static constexpr InternalRepresentationType kEmpty
Definition: v8-internal.h:1702
Definition: v8-internal.h:1552
constexpr WrappedIterator & operator-=(difference_type n) noexcept
Definition: v8-internal.h:1664
constexpr WrappedIterator operator--(int) noexcept
Definition: v8-internal.h:1641
constexpr WrappedIterator & operator+=(difference_type n) noexcept
Definition: v8-internal.h:1656
constexpr const Iterator & base() const noexcept
Definition: v8-internal.h:1678
std::conditional_t< std::is_void_v< ElementType >, typename std::iterator_traits< Iterator >::value_type, ElementType > value_type
Definition: v8-internal.h:1566
constexpr WrappedIterator & operator++() noexcept
Definition: v8-internal.h:1627
constexpr pointer operator->() const noexcept
Definition: v8-internal.h:1588
constexpr reference operator[](difference_type n) const noexcept
Definition: v8-internal.h:1673
typename std::iterator_traits< Iterator >::difference_type difference_type
Definition: v8-internal.h:1562
constexpr auto operator<=>(const WrappedIterator< OtherIterator, OtherElementType > &other) const noexcept
Definition: v8-internal.h:1604
std::conditional_t< std::is_void_v< ElementType >, typename std::iterator_traits< Iterator >::reference, std::add_lvalue_reference_t< ElementType > > reference
Definition: v8-internal.h:1574
constexpr WrappedIterator & operator--() noexcept
Definition: v8-internal.h:1637
constexpr WrappedIterator() noexcept=default
constexpr WrappedIterator(const WrappedIterator< OtherIterator, OtherElementType > &other) noexcept
Definition: v8-internal.h:1583
typename std::iterator_traits< Iterator >::iterator_category iterator_category
Definition: v8-internal.h:1576
constexpr reference operator*() const noexcept
Definition: v8-internal.h:1587
constexpr auto operator-(const WrappedIterator< OtherIterator, OtherElementType > &other) const noexcept
Definition: v8-internal.h:1668
friend constexpr WrappedIterator operator+(difference_type n, const WrappedIterator &x) noexcept
Definition: v8-internal.h:1652
constexpr WrappedIterator operator+(difference_type n) const noexcept
Definition: v8-internal.h:1646
constexpr WrappedIterator operator++(int) noexcept
Definition: v8-internal.h:1631
constexpr WrappedIterator operator-(difference_type n) const noexcept
Definition: v8-internal.h:1660
std::conditional_t< std::is_void_v< ElementType >, typename std::iterator_traits< Iterator >::pointer, std::add_pointer_t< ElementType > > pointer
Definition: v8-internal.h:1570
constexpr bool operator==(const WrappedIterator< OtherIterator, OtherElementType > &other) const noexcept
Definition: v8-internal.h:1597
Definition: v8-internal.h:1526
Definition: v8-internal.h:1523
const intptr_t kHeapObjectTagMask
Definition: v8-internal.h:61
constexpr uint64_t kCppHeapPointerMarkBit
Definition: v8-internal.h:390
constexpr int kCodePointerTableEntrySizeLog2
Definition: v8-internal.h:833
constexpr bool kRuntimeGeneratedCodeObjectsLiveInTrustedSpace
Definition: v8-internal.h:845
internal::Isolate * IsolateFromNeverReadOnlySpaceObject(Address obj)
constexpr uint64_t kExternalPointerTagShift
Definition: v8-internal.h:340
IndirectPointerHandle TrustedPointerHandle
Definition: v8-internal.h:768
const int kApiSystemPointerSize
Definition: v8-internal.h:51
constexpr bool SandboxIsEnabled()
Definition: v8-internal.h:206
const int kApiDoubleSize
Definition: v8-internal.h:52
constexpr size_t kMaxCppHeapPointers
Definition: v8-internal.h:413
constexpr intptr_t kIntptrAllBitsSet
Definition: v8-internal.h:79
constexpr int GB
Definition: v8-internal.h:43
void VerifyHandleIsNonEmpty(bool is_empty)
const int kApiInt32Size
Definition: v8-internal.h:53
const int kForwardingTagSize
Definition: v8-internal.h:68
uint32_t CppHeapPointerHandle
Definition: v8-internal.h:375
const intptr_t kForwardingTagMask
Definition: v8-internal.h:69
void PrintPropertyCallbackInfo(void *property_callback_info)
constexpr ExternalPointerTagRange kAnyManagedResourceExternalPointerTag(kFirstManagedResourceTag, kLastManagedResourceTag)
IndirectPointerHandle CodePointerHandle
Definition: v8-internal.h:806
constexpr uint64_t kExternalPointerPayloadMask
Definition: v8-internal.h:347
const int kSmiTagSize
Definition: v8-internal.h:73
const int kApiInt64Size
Definition: v8-internal.h:54
constexpr ExternalPointerTagRange kAnyExternalPointerTagRange(kFirstExternalPointerTag, kLastExternalPointerTag)
constexpr uint64_t kExternalPointerTagMask
Definition: v8-internal.h:341
constexpr int kCodePointerTableEntryCodeObjectOffset
Definition: v8-internal.h:841
constexpr int kTrustedPointerTableEntrySizeLog2
Definition: v8-internal.h:785
constexpr int kTrustedPointerTableEntrySize
Definition: v8-internal.h:784
constexpr uint64_t kCppHeapPointerPayloadShift
Definition: v8-internal.h:392
constexpr ExternalPointer_t kNullExternalPointer
Definition: v8-internal.h:367
Address ExternalPointer_t
Definition: v8-internal.h:364
uint32_t IndirectPointerHandle
Definition: v8-internal.h:748
constexpr CppHeapPointer_t kNullCppHeapPointer
Definition: v8-internal.h:387
constexpr ExternalPointerTagRange kAnySharedExternalPointerTagRange(kFirstSharedExternalPointerTag, kLastSharedExternalPointerTag)
const int kApiSizetSize
Definition: v8-internal.h:55
constexpr uint64_t kExternalPointerTagAndMarkbitMask
Definition: v8-internal.h:346
constexpr int kCodePointerTableEntryEntrypointOffset
Definition: v8-internal.h:840
constexpr size_t kMaxExternalPointers
Definition: v8-internal.h:335
constexpr size_t kCodePointerTableReservationSize
Definition: v8-internal.h:811
constexpr TrustedPointerHandle kNullTrustedPointerHandle
Definition: v8-internal.h:780
const int kWeakHeapObjectTag
Definition: v8-internal.h:59
constexpr ExternalPointerHandle kNullExternalPointerHandle
Definition: v8-internal.h:368
constexpr ExternalPointerTagRange kAnyMaybeReadOnlyExternalPointerTagRange(kFirstMaybeReadOnlyExternalPointerTag, kLastMaybeReadOnlyExternalPointerTag)
constexpr uintptr_t kUintptrAllBitsSet
Definition: v8-internal.h:80
const int kForwardingTag
Definition: v8-internal.h:67
const intptr_t kHeapObjectReferenceTagMask
Definition: v8-internal.h:62
constexpr bool SmiValuesAre31Bits()
Definition: v8-internal.h:194
constexpr size_t kMaxTrustedPointers
Definition: v8-internal.h:786
bool ShouldThrowOnError(internal::Isolate *isolate)
constexpr uint64_t kCppHeapPointerTagShift
Definition: v8-internal.h:391
constexpr ExternalPointerTagRange kAnyInterceptorInfoExternalPointerTagRange(kFirstInterceptorInfoExternalPointerTag, kLastInterceptorInfoExternalPointerTag)
constexpr int KB
Definition: v8-internal.h:41
constexpr bool kBuiltinCodeObjectsLiveInTrustedSpace
Definition: v8-internal.h:846
constexpr uint32_t kTrustedPointerHandleShift
Definition: v8-internal.h:777
constexpr uint32_t kCodePointerHandleShift
Definition: v8-internal.h:815
constexpr ExternalPointerTagRange kAnyManagedExternalPointerTagRange(kFirstManagedExternalPointerTag, kLastManagedExternalPointerTag)
const int kHeapObjectTag
Definition: v8-internal.h:58
const int kSmiShiftSize
Definition: v8-internal.h:190
constexpr size_t kMaxCodePointers
Definition: v8-internal.h:834
SmiTagging< kApiTaggedSize > PlatformSmiTagging
Definition: v8-internal.h:185
ExternalPointerTag
Definition: v8-internal.h:555
@ kLastForeignExternalPointerTag
Definition: v8-internal.h:660
@ kApiIndexedPropertyDescriptorCallbackTag
Definition: v8-internal.h:606
@ kGenericForeignTag
Definition: v8-internal.h:619
@ kFirstMaybeReadOnlyExternalPointerTag
Definition: v8-internal.h:589
@ kTemporalInstantTag
Definition: v8-internal.h:650
@ kTemporalPlainYearMonthTag
Definition: v8-internal.h:654
@ kExternalPointerEvacuationEntryTag
Definition: v8-internal.h:668
@ kFirstSharedExternalPointerTag
Definition: v8-internal.h:567
@ kApiNamedPropertyDefinerCallbackTag
Definition: v8-internal.h:600
@ kLastSharedExternalPointerTag
Definition: v8-internal.h:571
@ kD8WorkerTag
Definition: v8-internal.h:658
@ kApiIndexedPropertySetterCallbackTag
Definition: v8-internal.h:605
@ kWasmManagedDataTag
Definition: v8-internal.h:637
@ kLastExternalPointerTag
Definition: v8-internal.h:671
@ kIcuBreakIteratorTag
Definition: v8-internal.h:639
@ kLastExternalTypeTag
Definition: v8-internal.h:583
@ kMicrotaskCallbackDataTag
Definition: v8-internal.h:625
@ kWasmNativeModuleTag
Definition: v8-internal.h:638
@ kApiIndexedPropertyGetterCallbackTag
Definition: v8-internal.h:604
@ kApiNamedPropertyDescriptorCallbackTag
Definition: v8-internal.h:599
@ kAccessorInfoGetterTag
Definition: v8-internal.h:591
@ kTemporalPlainMonthDayTag
Definition: v8-internal.h:655
@ kIcuCollatorTag
Definition: v8-internal.h:648
@ kIcuSimpleDateFormatTag
Definition: v8-internal.h:643
@ kApiIndexedPropertyDefinerCallbackTag
Definition: v8-internal.h:607
@ kSyntheticModuleTag
Definition: v8-internal.h:623
@ kFirstExternalTypeTag
Definition: v8-internal.h:582
@ kD8ModuleEmbedderDataTag
Definition: v8-internal.h:659
@ kExternalStringResourceTag
Definition: v8-internal.h:569
@ kWasmFuncDataTag
Definition: v8-internal.h:636
@ kWaiterQueueForeignTag
Definition: v8-internal.h:629
@ kAccessorInfoSetterTag
Definition: v8-internal.h:592
@ kApiNamedPropertyDeleterCallbackTag
Definition: v8-internal.h:601
@ kApiAccessCheckCallbackTag
Definition: v8-internal.h:621
@ kApiAbortScriptExecutionCallbackTag
Definition: v8-internal.h:622
@ kMicrotaskCallbackTag
Definition: v8-internal.h:624
@ kIcuLocalizedNumberFormatterTag
Definition: v8-internal.h:646
@ kApiNamedPropertyGetterCallbackTag
Definition: v8-internal.h:597
@ kApiNamedPropertySetterCallbackTag
Definition: v8-internal.h:598
@ kApiIndexedPropertyEnumeratorCallbackTag
Definition: v8-internal.h:609
@ kExternalPointerFreeEntryTag
Definition: v8-internal.h:669
@ kFirstInterceptorInfoExternalPointerTag
Definition: v8-internal.h:595
@ kCFunctionTag
Definition: v8-internal.h:626
@ kIcuUnicodeStringTag
Definition: v8-internal.h:640
@ kLastManagedExternalPointerTag
Definition: v8-internal.h:661
@ kWaiterQueueNodeTag
Definition: v8-internal.h:568
@ kGenericManagedTag
Definition: v8-internal.h:634
@ kExternalPointerNullTag
Definition: v8-internal.h:557
@ kExternalStringResourceDataTag
Definition: v8-internal.h:570
@ kTemporalZonedDateTimeTag
Definition: v8-internal.h:656
@ kWasmStackMemoryTag
Definition: v8-internal.h:615
@ kLastManagedResourceTag
Definition: v8-internal.h:665
@ kFastApiExternalTypeTag
Definition: v8-internal.h:588
@ kExternalPointerZappedEntryTag
Definition: v8-internal.h:667
@ kApiNamedPropertyQueryCallbackTag
Definition: v8-internal.h:596
@ kFirstForeignExternalPointerTag
Definition: v8-internal.h:618
@ kTemporalPlainDateTimeTag
Definition: v8-internal.h:653
@ kIcuListFormatterTag
Definition: v8-internal.h:641
@ kDisplayNamesInternalTag
Definition: v8-internal.h:657
@ kFirstManagedResourceTag
Definition: v8-internal.h:632
@ kFirstManagedExternalPointerTag
Definition: v8-internal.h:633
@ kTemporalPlainTimeTag
Definition: v8-internal.h:652
@ kIcuPluralRulesTag
Definition: v8-internal.h:647
@ kFirstEmbedderDataTag
Definition: v8-internal.h:578
@ kApiIndexedPropertyQueryCallbackTag
Definition: v8-internal.h:603
@ kIcuLocaleTag
Definition: v8-internal.h:642
@ kMessageListenerTag
Definition: v8-internal.h:628
@ kApiIndexedPropertyDeleterCallbackTag
Definition: v8-internal.h:608
@ kTemporalDurationTag
Definition: v8-internal.h:649
@ kLastInterceptorInfoExternalPointerTag
Definition: v8-internal.h:610
@ kIcuRelativeDateTimeFormatterTag
Definition: v8-internal.h:645
@ kWasmWasmStreamingTag
Definition: v8-internal.h:635
@ kNativeContextMicrotaskQueueTag
Definition: v8-internal.h:575
@ kLastMaybeReadOnlyExternalPointerTag
Definition: v8-internal.h:613
@ kLastEmbedderDataTag
Definition: v8-internal.h:579
@ kArrayBufferExtensionTag
Definition: v8-internal.h:664
@ kIcuDateIntervalFormatTag
Definition: v8-internal.h:644
@ kCFunctionInfoTag
Definition: v8-internal.h:627
@ kFirstExternalPointerTag
Definition: v8-internal.h:556
@ kApiNamedPropertyEnumeratorCallbackTag
Definition: v8-internal.h:602
@ kFunctionTemplateInfoCallbackTag
Definition: v8-internal.h:590
@ kTemporalPlainDateTag
Definition: v8-internal.h:651
const int kSmiValueSize
Definition: v8-internal.h:191
constexpr ExternalPointerTagRange kAnyForeignExternalPointerTagRange(kFirstForeignExternalPointerTag, kLastForeignExternalPointerTag)
constexpr bool SmiValuesAre32Bits()
Definition: v8-internal.h:195
TagRange< ExternalPointerTag > ExternalPointerTagRange
Definition: v8-internal.h:674
constexpr IndirectPointerHandle kNullIndirectPointerHandle
Definition: v8-internal.h:751
uintptr_t Address
Definition: v8-internal.h:38
void PerformCastCheck(T *data)
Definition: v8-internal.h:1467
void PrintFunctionCallbackInfo(void *function_callback_info)
constexpr size_t kTrustedPointerTableReservationSize
Definition: v8-internal.h:773
uint32_t ExternalPointerHandle
Definition: v8-internal.h:356
const intptr_t kSmiTagMask
Definition: v8-internal.h:74
const int kHeapObjectTagSize
Definition: v8-internal.h:60
const int kSmiMaxValue
Definition: v8-internal.h:193
constexpr bool Is64()
Definition: v8-internal.h:196
constexpr bool kAllCodeObjectsLiveInTrustedSpace
Definition: v8-internal.h:847
const int kSmiTag
Definition: v8-internal.h:72
constexpr CodePointerHandle kNullCodePointerHandle
Definition: v8-internal.h:818
Address CppHeapPointer_t
Definition: v8-internal.h:384
constexpr CppHeapPointerHandle kNullCppHeapPointerHandle
Definition: v8-internal.h:388
constexpr int kGarbageCollectionReasonMaxValue
Definition: v8-internal.h:1478
constexpr int kCodePointerTableEntrySize
Definition: v8-internal.h:832
constexpr uint32_t kCodePointerHandleMarker
Definition: v8-internal.h:827
const int kSmiMinValue
Definition: v8-internal.h:192
constexpr int MB
Definition: v8-internal.h:42
constexpr uint64_t kExternalPointerShiftedTagMask
Definition: v8-internal.h:342
constexpr uint64_t kExternalPointerMarkBit
Definition: v8-internal.h:339
Address SandboxedPointer_t
Definition: v8-internal.h:216
const int kApiTaggedSize
Definition: v8-internal.h:175
constexpr bool PointerCompressionIsEnabled()
Definition: v8-internal.h:178
Definition: libplatform.h:15
Definition: v8-internal.h:1451
static void Perform(T *data)
Definition: v8-internal.h:863
Address * next
Definition: v8-internal.h:867
int level
Definition: v8-internal.h:869
Address * limit
Definition: v8-internal.h:868
int sealed_level
Definition: v8-internal.h:870
static constexpr uint32_t kSizeInBytes
Definition: v8-internal.h:864
void Initialize()
Definition: v8-internal.h:872
typename Iterator::iterator_concept iterator_concept
Definition: v8-internal.h:1537
Definition: v8-internal.h:1533
static constexpr bool IsValidSmi(uint64_t value)
Definition: v8-internal.h:127
static constexpr bool IsValidSmi(int64_t value)
Definition: v8-internal.h:120
static constexpr bool IsValidSmi(T value)
Definition: v8-internal.h:100
static constexpr int SmiToInt(Address value)
Definition: v8-internal.h:92
static constexpr bool IsValidSmi(T value)
Definition: v8-internal.h:150
static constexpr int SmiToInt(Address value)
Definition: v8-internal.h:142
Definition: v8-internal.h:77
Definition: v8-internal.h:455
constexpr size_t Size() const
Definition: v8-internal.h:477
constexpr bool IsEmpty() const
Definition: v8-internal.h:475
const Tag last
Definition: v8-internal.h:508
constexpr bool operator==(const TagRange other) const
Definition: v8-internal.h:497
constexpr bool Contains(Tag tag) const
Definition: v8-internal.h:485
const Tag first
Definition: v8-internal.h:507
constexpr TagRange()
Definition: v8-internal.h:472
constexpr TagRange(Tag tag)
Definition: v8-internal.h:468
constexpr size_t hash_value() const
Definition: v8-internal.h:501
constexpr TagRange(Tag first, Tag last)
Definition: v8-internal.h:461
constexpr bool Contains(TagRange tag_range) const
Definition: v8-internal.h:493
#define V8_EXTERNAL_POINTER_TAG_COUNT
Definition: v8-internal.h:425
#define V8_EMBEDDER_DATA_TAG_COUNT
Definition: v8-internal.h:420
#define V8_EXPORT
Definition: v8config.h:855
#define V8_INLINE
Definition: v8config.h:508
#define V8_DEPRECATE_SOON(message)
Definition: v8config.h:622
#define V8_LIKELY(condition)
Definition: v8config.h:669