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