Loading...
Searching...
No Matches
v8-isolate.h
Go to the documentation of this file.
1// Copyright 2021 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_ISOLATE_H_
6#define INCLUDE_V8_ISOLATE_H_
7
8#include <stddef.h>
9#include <stdint.h>
10
11#include <memory>
12#include <string>
13#include <utility>
14
15#include "cppgc/common.h"
16#include "v8-array-buffer.h" // NOLINT(build/include_directory)
17#include "v8-callbacks.h" // NOLINT(build/include_directory)
18#include "v8-data.h" // NOLINT(build/include_directory)
19#include "v8-debug.h" // NOLINT(build/include_directory)
20#include "v8-embedder-heap.h" // NOLINT(build/include_directory)
21#include "v8-exception.h" // NOLINT(build/include_directory)
22#include "v8-function-callback.h" // NOLINT(build/include_directory)
23#include "v8-internal.h" // NOLINT(build/include_directory)
24#include "v8-local-handle.h" // NOLINT(build/include_directory)
25#include "v8-microtask.h" // NOLINT(build/include_directory)
26#include "v8-persistent-handle.h" // NOLINT(build/include_directory)
27#include "v8-primitive.h" // NOLINT(build/include_directory)
28#include "v8-statistics.h" // NOLINT(build/include_directory)
29#include "v8-unwinder.h" // NOLINT(build/include_directory)
30#include "v8config.h" // NOLINT(build/include_directory)
31
32namespace v8 {
33
34class CppHeap;
35class HeapProfiler;
36class MicrotaskQueue;
37class StartupData;
38class ScriptOrModule;
39class SharedArrayBuffer;
40
41namespace internal {
42class MicrotaskQueue;
43class ThreadLocalTop;
44} // namespace internal
45
46namespace metrics {
47class Recorder;
48} // namespace metrics
49
65 public:
84 void ConfigureDefaultsFromHeapSize(size_t initial_heap_size_in_bytes,
85 size_t maximum_heap_size_in_bytes);
86
96 void ConfigureDefaults(uint64_t physical_memory,
97 uint64_t virtual_memory_limit);
98
102 uint32_t* stack_limit() const { return stack_limit_; }
103 void set_stack_limit(uint32_t* value) { stack_limit_ = value; }
104
114 size_t code_range_size_in_bytes() const { return code_range_size_; }
115 void set_code_range_size_in_bytes(size_t limit) { code_range_size_ = limit; }
116
125 return max_old_generation_size_;
126 }
128 max_old_generation_size_ = limit;
129 }
130
137 return max_young_generation_size_;
138 }
140 max_young_generation_size_ = limit;
141 }
142
144 return initial_old_generation_size_;
145 }
147 initial_old_generation_size_ = initial_size;
148 }
149
151 return initial_young_generation_size_;
152 }
154 initial_young_generation_size_ = initial_size;
155 }
156
158 return physical_memory_size_;
159 }
160
161 private:
162 static constexpr size_t kMB = 1048576u;
163 size_t code_range_size_ = 0;
164 size_t max_old_generation_size_ = 0;
165 size_t max_young_generation_size_ = 0;
166 size_t initial_old_generation_size_ = 0;
167 size_t initial_young_generation_size_ = 0;
168 uint64_t physical_memory_size_ = 0;
169 uint32_t* stack_limit_ = nullptr;
170};
171
181
192};
193
198
224 public:
232
237 static bool CanCreateNewGroups();
238
244
247
250
252
253 bool operator==(const IsolateGroup& other) const {
254 return isolate_group_ == other.isolate_group_;
255 }
256
257 bool operator!=(const IsolateGroup& other) const {
258 return !operator==(other);
259 }
260
261#ifdef V8_ENABLE_SANDBOX
266 bool SandboxContains(void* pointer) const;
267 VirtualAddressSpace* GetSandboxAddressSpace();
268#else
269 V8_INLINE bool SandboxContains(void* pointer) const { return true; }
270#endif
271
272 private:
273 friend class Isolate;
275
276 // The isolate_group pointer should be already acquired.
277 explicit IsolateGroup(internal::IsolateGroup*&& isolate_group);
278
279 internal::IsolateGroup* isolate_group_;
280};
281
291 public:
298
300
301
305 JitCodeEventHandler code_event_handler = nullptr;
306
311
316 const StartupData* snapshot_blob = nullptr;
317
322 CounterLookupCallback counter_lookup_callback = nullptr;
323
330 CreateHistogramCallback create_histogram_callback = nullptr;
331 AddHistogramSampleCallback add_histogram_sample_callback = nullptr;
332
342 ArrayBuffer::Allocator* array_buffer_allocator = nullptr;
343 std::shared_ptr<ArrayBuffer::Allocator> array_buffer_allocator_shared;
344
351 const intptr_t* external_references = nullptr;
352
357 bool allow_atomics_wait = true;
358
364 int embedder_wrapper_type_index = -1;
365 int embedder_wrapper_object_index = -1;
366
370 FatalErrorCallback fatal_error_callback = nullptr;
371 OOMErrorCallback oom_error_callback = nullptr;
372
377 CppHeap* cpp_heap = nullptr;
378 };
379
385 public:
386 explicit Scope(Isolate* isolate) : v8_isolate_(isolate) {
387 v8_isolate_->Enter();
388 }
389
390 ~Scope() { v8_isolate_->Exit(); }
391
392 // Prevent copying of Scope objects.
393 Scope(const Scope&) = delete;
394 Scope& operator=(const Scope&) = delete;
395
396 private:
397 Isolate* const v8_isolate_;
398 };
399
404 public:
405 enum OnFailure { CRASH_ON_FAILURE, THROW_ON_FAILURE, DUMP_ON_FAILURE };
406
409
410 // Prevent copying of Scope objects.
412 delete;
414 const DisallowJavascriptExecutionScope&) = delete;
415
416 private:
417 v8::Isolate* const v8_isolate_;
418 const OnFailure on_failure_;
419 bool was_execution_allowed_;
420 };
421
426 public:
429
430 // Prevent copying of Scope objects.
432 delete;
434 const AllowJavascriptExecutionScope&) = delete;
435
436 private:
437 Isolate* const v8_isolate_;
438 bool was_execution_allowed_assert_;
439 bool was_execution_allowed_throws_;
440 bool was_execution_allowed_dump_;
441 };
442
448 public:
450 Isolate* isolate, MicrotaskQueue* microtask_queue = nullptr);
452
453 // Prevent copying of Scope objects.
455 delete;
457 const SuppressMicrotaskExecutionScope&) = delete;
458
459 private:
460 internal::Isolate* const i_isolate_;
461 internal::MicrotaskQueue* const microtask_queue_;
462 internal::Address previous_stack_height_;
463
464 friend class internal::ThreadLocalTop;
465 };
466
473 kMinorGarbageCollection
474 };
475
485 kUseAsm = 0,
486 kBreakIterator = 1,
487 kOBSOLETE_LegacyConst = 2,
488 kOBSOLETE_MarkDequeOverflow = 3,
489 kOBSOLETE_StoreBufferOverflow = 4,
490 kOBSOLETE_SlotsBufferOverflow = 5,
491 kOBSOLETE_ObjectObserve = 6,
492 kForcedGC = 7,
493 kSloppyMode = 8,
494 kStrictMode = 9,
495 kOBSOLETE_StrongMode = 10,
496 kRegExpPrototypeStickyGetter = 11,
497 kRegExpPrototypeToString = 12,
498 kRegExpPrototypeUnicodeGetter = 13,
499 kOBSOLETE_IntlV8Parse = 14,
500 kOBSOLETE_IntlPattern = 15,
501 kOBSOLETE_IntlResolved = 16,
502 kOBSOLETE_PromiseChain = 17,
503 kOBSOLETE_PromiseAccept = 18,
504 kOBSOLETE_PromiseDefer = 19,
505 kHtmlCommentInExternalScript = 20,
506 kHtmlComment = 21,
507 kSloppyModeBlockScopedFunctionRedefinition = 22,
508 kForInInitializer = 23,
509 kOBSOLETE_ArrayProtectorDirtied = 24,
510 kArraySpeciesModified = 25,
511 kArrayPrototypeConstructorModified = 26,
512 kOBSOLETE_ArrayInstanceProtoModified = 27,
513 kArrayInstanceConstructorModified = 28,
514 kOBSOLETE_LegacyFunctionDeclaration = 29,
515 kOBSOLETE_RegExpPrototypeSourceGetter = 30,
516 kOBSOLETE_RegExpPrototypeOldFlagGetter = 31,
517 kDecimalWithLeadingZeroInStrictMode = 32,
518 kLegacyDateParser = 33,
519 kDefineGetterOrSetterWouldThrow = 34,
520 kFunctionConstructorReturnedUndefined = 35,
521 kAssigmentExpressionLHSIsCallInSloppy = 36,
522 kAssigmentExpressionLHSIsCallInStrict = 37,
523 kPromiseConstructorReturnedUndefined = 38,
524 kOBSOLETE_ConstructorNonUndefinedPrimitiveReturn = 39,
525 kOBSOLETE_LabeledExpressionStatement = 40,
526 kOBSOLETE_LineOrParagraphSeparatorAsLineTerminator = 41,
527 kIndexAccessor = 42,
528 kErrorCaptureStackTrace = 43,
529 kErrorPrepareStackTrace = 44,
530 kErrorStackTraceLimit = 45,
531 kWebAssemblyInstantiation = 46,
532 kDeoptimizerDisableSpeculation = 47,
533 kOBSOLETE_ArrayPrototypeSortJSArrayModifiedPrototype = 48,
534 kFunctionTokenOffsetTooLongForToString = 49,
535 kWasmSharedMemory = 50,
536 kWasmThreadOpcodes = 51,
537 kOBSOLETE_AtomicsNotify = 52,
538 kOBSOLETE_AtomicsWake = 53,
539 kCollator = 54,
540 kNumberFormat = 55,
541 kDateTimeFormat = 56,
542 kPluralRules = 57,
543 kRelativeTimeFormat = 58,
544 kLocale = 59,
545 kListFormat = 60,
546 kSegmenter = 61,
547 kStringLocaleCompare = 62,
548 kOBSOLETE_StringToLocaleUpperCase = 63,
549 kStringToLocaleLowerCase = 64,
550 kNumberToLocaleString = 65,
551 kDateToLocaleString = 66,
552 kDateToLocaleDateString = 67,
553 kDateToLocaleTimeString = 68,
554 kAttemptOverrideReadOnlyOnPrototypeSloppy = 69,
555 kAttemptOverrideReadOnlyOnPrototypeStrict = 70,
556 kOBSOLETE_OptimizedFunctionWithOneShotBytecode = 71,
557 kRegExpMatchIsTrueishOnNonJSRegExp = 72,
558 kRegExpMatchIsFalseishOnJSRegExp = 73,
559 kOBSOLETE_DateGetTimezoneOffset = 74,
560 kStringNormalize = 75,
561 kCallSiteAPIGetFunctionSloppyCall = 76,
562 kCallSiteAPIGetThisSloppyCall = 77,
563 kOBSOLETE_RegExpMatchAllWithNonGlobalRegExp = 78,
564 kRegExpExecCalledOnSlowRegExp = 79,
565 kRegExpReplaceCalledOnSlowRegExp = 80,
566 kDisplayNames = 81,
567 kSharedArrayBufferConstructed = 82,
568 kArrayPrototypeHasElements = 83,
569 kObjectPrototypeHasElements = 84,
570 kNumberFormatStyleUnit = 85,
571 kDateTimeFormatRange = 86,
572 kDateTimeFormatDateTimeStyle = 87,
573 kBreakIteratorTypeWord = 88,
574 kBreakIteratorTypeLine = 89,
575 kInvalidatedArrayBufferDetachingProtector = 90,
576 kInvalidatedArrayConstructorProtector V8_DEPRECATE_SOON(
577 "The ArrayConstructorProtector has been removed") = 91,
578 kInvalidatedArrayIteratorLookupChainProtector = 92,
579 kInvalidatedArraySpeciesLookupChainProtector = 93,
580 kInvalidatedIsConcatSpreadableLookupChainProtector = 94,
581 kInvalidatedMapIteratorLookupChainProtector = 95,
582 kInvalidatedNoElementsProtector = 96,
583 kInvalidatedPromiseHookProtector = 97,
584 kInvalidatedPromiseResolveLookupChainProtector = 98,
585 kInvalidatedPromiseSpeciesLookupChainProtector = 99,
586 kInvalidatedPromiseThenLookupChainProtector = 100,
587 kInvalidatedRegExpSpeciesLookupChainProtector = 101,
588 kInvalidatedSetIteratorLookupChainProtector = 102,
589 kInvalidatedStringIteratorLookupChainProtector = 103,
590 kInvalidatedStringLengthOverflowLookupChainProtector = 104,
591 kInvalidatedTypedArraySpeciesLookupChainProtector = 105,
592 kWasmSimdOpcodes = 106,
593 kVarRedeclaredCatchBinding = 107,
594 kWasmRefTypes = 108,
595 kOBSOLETE_WasmBulkMemory = 109,
596 kOBSOLETE_WasmMultiValue = 110,
597 kWasmExceptionHandling = 111,
598 kInvalidatedMegaDOMProtector = 112,
599 kFunctionPrototypeArguments = 113,
600 kFunctionPrototypeCaller = 114,
601 kTurboFanOsrCompileStarted = 115,
602 kAsyncStackTaggingCreateTaskCall = 116,
603 kDurationFormat = 117,
604 kInvalidatedNumberStringNotRegexpLikeProtector = 118,
605 kOBSOLETE_RegExpUnicodeSetIncompatibilitiesWithUnicodeMode = 119,
606 kOBSOLETE_ImportAssertionDeprecatedSyntax = 120,
607 kLocaleInfoObsoletedGetters = 121,
608 kLocaleInfoFunctions = 122,
609 kCompileHintsMagicAll = 123,
610 kInvalidatedNoProfilingProtector = 124,
611 kWasmMemory64 = 125,
612 kWasmMultiMemory = 126,
613 kWasmGC = 127,
614 kWasmImportedStrings = 128,
615 kSourceMappingUrlMagicCommentAtSign = 129,
616 kTemporalObject = 130,
617 kWasmModuleCompilation = 131,
618 kInvalidatedNoUndetectableObjectsProtector = 132,
619 kWasmJavaScriptPromiseIntegration = 133,
620 kWasmReturnCall = 134,
621 kWasmExtendedConst = 135,
622 kWasmRelaxedSimd = 136,
623 kWasmTypeReflection = 137,
624 kWasmExnRef = 138,
625 kWasmTypedFuncRef = 139,
626 kInvalidatedStringWrapperToPrimitiveProtector = 140,
627 kDocumentAllLegacyCall = 141,
628 kDocumentAllLegacyConstruct = 142,
629 kConsoleContext = 143,
630 kWasmImportedStringsUtf8 = 144,
631 kResizableArrayBuffer = 145,
632 kGrowableSharedArrayBuffer = 146,
633 kArrayByCopy = 147,
634 kArrayFromAsync = 148,
635 kIteratorMethods = 149,
636 kPromiseAny = 150,
637 kSetMethods = 151,
638 kArrayFindLast = 152,
639 kArrayGroup = 153,
640 kArrayBufferTransfer = 154,
641 kPromiseWithResolvers = 155,
642 kAtomicsWaitAsync = 156,
643 kExtendingNonExtensibleWithPrivate = 157,
644 kPromiseTry = 158,
645 kStringReplaceAll = 159,
646 kStringWellFormed = 160,
647 kWeakReferences = 161,
648 kErrorIsError = 162,
649 kInvalidatedTypedArrayLengthLookupChainProtector = 163,
650 kRegExpEscape = 164,
651 kFloat16Array = 165,
652 kExplicitResourceManagement = 166,
653 kWasmBranchHinting = 167,
654 kWasmMultiValue = 168,
655 kUint8ArrayToFromBase64AndHex = 169,
656 kAtomicsPause = 170,
657 kTopLevelAwait = 171,
658 kLogicalAssignment = 172,
659 kNullishCoalescing = 173,
660 kInvalidatedNoDateTimeConfigurationChangeProtector = 174,
661
662 // If you add new values here, you'll also need to update Chromium's:
663 // web_feature.mojom, use_counter_callback.cc, and enums.xml. V8 changes to
664 // this list need to be landed first, then changes on the Chromium side.
665 kUseCounterFeatureCount // This enum value must be last.
666 };
667
669 kMessageLog = (1 << 0),
670 kMessageDebug = (1 << 1),
671 kMessageInfo = (1 << 2),
672 kMessageError = (1 << 3),
673 kMessageWarning = (1 << 4),
674 kMessageAll = kMessageLog | kMessageDebug | kMessageInfo | kMessageError |
675 kMessageWarning,
676 };
677
678 // The different priorities that an isolate can have.
679 enum class Priority {
680 // The isolate does not relate to content that is currently important
681 // to the user. Lowest priority.
683
684 // The isolate contributes to content that is visible to the user, like a
685 // visible iframe that's not interacted directly with. High priority.
687
688 // The isolate contributes to content that is of the utmost importance to
689 // the user, like visible content in the focused window. Highest priority.
691 };
692
693 using UseCounterCallback = void (*)(Isolate* isolate,
694 UseCounterFeature feature);
695
710 static Isolate* Allocate();
711 static Isolate* Allocate(const IsolateGroup& group);
712
717
721 static void Initialize(Isolate* isolate, const CreateParams& params);
722
732 static Isolate* New(const CreateParams& params);
733 static Isolate* New(const IsolateGroup& group, const CreateParams& params);
734
742
750
754 bool IsCurrent() const;
755
770
783
790
802
809
816
824
830
835
836#if defined(V8_OS_WIN)
840 V8_DEPRECATE_SOON("Use SetFilterETWSessionByURL2Callback instead")
841 void SetFilterETWSessionByURLCallback(FilterETWSessionByURLCallback callback);
842 void SetFilterETWSessionByURL2Callback(
843 FilterETWSessionByURL2Callback callback);
844#endif // V8_OS_WIN
845
853
860 void SetBatterySaverMode(bool battery_saver_mode_enabled);
861
868 void SetMemorySaverMode(bool memory_saver_mode_enabled);
869
876
887 void Enter();
888
896 void Exit();
897
902 void Dispose();
903
910
917 static void Free(Isolate* isolate);
918
924
933
938 V8_INLINE void SetData(uint32_t slot, void* data);
939
944 V8_INLINE void* GetData(uint32_t slot);
945
950 V8_INLINE static uint32_t GetNumberOfDataSlots();
951
957 template <class T>
958 V8_INLINE MaybeLocal<T> GetDataFromSnapshotOnce(size_t index);
959
964 V8_DEPRECATE_SOON("Use GetContinuationPreservedEmbedderDataV2 instead")
965 Local<Value> GetContinuationPreservedEmbedderData();
966
971 V8_DEPRECATE_SOON("Use SetContinuationPreservedEmbedderDataV2 instead")
972 void SetContinuationPreservedEmbedderData(Local<Value> data);
973
980 Local<Data> GetContinuationPreservedEmbedderDataV2();
981
987 void SetContinuationPreservedEmbedderDataV2(Local<Data> data);
988
992 void GetHeapStatistics(HeapStatistics* heap_statistics);
993
997 size_t NumberOfHeapSpaces();
998
1008 bool GetHeapSpaceStatistics(HeapSpaceStatistics* space_statistics,
1009 size_t index);
1010
1014 size_t NumberOfTrackedHeapObjectTypes();
1015
1025 bool GetHeapObjectStatisticsAtLastGC(HeapObjectStatistics* object_statistics,
1026 size_t type_index);
1027
1035 bool GetHeapCodeAndMetadataStatistics(HeapCodeStatistics* object_statistics);
1036
1049 bool MeasureMemory(
1050 std::unique_ptr<MeasureMemoryDelegate> delegate,
1051 MeasureMemoryExecution execution = MeasureMemoryExecution::kDefault);
1052
1065 void GetStackSample(const RegisterState& state, void** frames,
1066 size_t frames_limit, SampleInfo* sample_info);
1067
1076 int64_t AdjustAmountOfExternalAllocatedMemory(int64_t change_in_bytes);
1077
1082 HeapProfiler* GetHeapProfiler();
1083
1087 void SetIdle(bool is_idle);
1088
1090 ArrayBuffer::Allocator* GetArrayBufferAllocator();
1091
1093 bool InContext();
1094
1099 Local<Context> GetCurrentContext();
1100
1107 Local<Context> GetEnteredOrMicrotaskContext();
1108
1113 Local<Context> GetIncumbentContext();
1114
1119 MaybeLocal<Data> GetCurrentHostDefinedOptions();
1120
1126 template <int N>
1127 Local<Value> ThrowError(const char (&message)[N]) {
1128 return ThrowError(String::NewFromUtf8Literal(this, message));
1129 }
1131
1139
1147
1148 using GCCallback = void (*)(Isolate* isolate, GCType type,
1149 GCCallbackFlags flags);
1150 using GCCallbackWithData = void (*)(Isolate* isolate, GCType type,
1151 GCCallbackFlags flags, void* data);
1152
1164 GCType gc_type_filter = kGCTypeAll);
1165
1171 void AddGCPrologueCallback(GCCallbackWithData callback, void* data = nullptr,
1172 GCType gc_type_filter = kGCTypeAll);
1173
1181
1188
1196 GCType gc_type_filter = kGCTypeAll);
1197
1203 void AddGCEpilogueCallback(GCCallbackWithData callback, void* data = nullptr,
1204 GCType gc_type_filter = kGCTypeAll);
1205
1213
1220 void* data = nullptr);
1221
1230
1231 using ReleaseCppHeapCallback = void (*)(std::unique_ptr<CppHeap>);
1232
1239
1245
1247
1256
1265
1275
1291
1300 void RequestInterrupt(InterruptCallback callback, void* data);
1301
1308
1319
1331 StackState stack_state);
1332
1337
1345
1350
1359
1364
1370
1376
1385
1393
1398
1402 void EnqueueMicrotask(MicrotaskCallback callback, void* data = nullptr);
1403
1408
1413
1428 MicrotasksCompletedCallbackWithData callback, void* data = nullptr);
1429
1434 MicrotasksCompletedCallbackWithData callback, void* data = nullptr);
1435
1440
1446
1455
1466 const std::shared_ptr<metrics::Recorder>& metrics_recorder);
1467
1474
1480
1490 V8_DEPRECATE_SOON("Use version that passes ContextDependants.")
1491 int ContextDisposedNotification(bool dependant_context = true);
1492
1500 void ContextDisposedNotification(ContextDependants dependants);
1501
1506 V8_DEPRECATE_SOON("Use SetPriority(Priority::kUserBlocking) instead")
1507 void IsolateInForegroundNotification();
1508
1513 V8_DEPRECATE_SOON("Use SetPriority(Priority::kBestEffort) instead")
1514 void IsolateInBackgroundNotification();
1515
1520 void SetPriority(Priority priority);
1521
1534 void SetIsLoading(bool is_loading);
1535
1542 void Freeze(bool is_frozen);
1543
1548 void IncreaseHeapLimitForDebugging();
1549
1553 void RestoreOriginalHeapLimit();
1554
1559 bool IsHeapLimitIncreasedForDebugging();
1560
1583 void SetJitCodeEventHandler(JitCodeEventOptions options,
1584 JitCodeEventHandler event_handler);
1585
1595 void SetStackLimit(uintptr_t stack_limit);
1596
1612 void GetCodeRange(void** start, size_t* length_in_bytes);
1613
1618 void GetEmbeddedCodeRange(const void** start, size_t* length_in_bytes);
1619
1623 JSEntryStubs GetJSEntryStubs();
1624
1625 static constexpr size_t kMinCodePagesBufferSize = 32;
1626
1640 size_t CopyCodePages(size_t capacity, MemoryRange* code_pages_out);
1641
1643 void SetFatalErrorHandler(FatalErrorCallback that);
1644
1646 void SetOOMErrorHandler(OOMErrorCallback that);
1647
1653 void AddNearHeapLimitCallback(NearHeapLimitCallback callback, void* data);
1654
1662 void RemoveNearHeapLimitCallback(NearHeapLimitCallback callback,
1663 size_t heap_limit);
1664
1671 void AutomaticallyRestoreInitialHeapLimit(double threshold_percent = 0.5);
1672
1677 void SetModifyCodeGenerationFromStringsCallback(
1679
1684 void SetAllowWasmCodeGenerationCallback(
1686
1691 void SetWasmModuleCallback(ExtensionCallback callback);
1692 void SetWasmInstanceCallback(ExtensionCallback callback);
1693
1694 void SetWasmStreamingCallback(WasmStreamingCallback callback);
1695
1696 void SetWasmAsyncResolvePromiseCallback(
1698
1699 void SetWasmLoadSourceMapCallback(WasmLoadSourceMapCallback callback);
1700
1701 void SetWasmImportedStringsEnabledCallback(
1703
1704 void SetSharedArrayBufferConstructorEnabledCallback(
1706
1707 void SetWasmJSPIEnabledCallback(WasmJSPIEnabledCallback callback);
1708
1714 void InstallConditionalFeatures(Local<Context> context);
1715
1720 bool IsDead();
1721
1731 bool AddMessageListener(MessageCallback callback,
1732 Local<Value> data = Local<Value>());
1733
1745 bool AddMessageListenerWithErrorLevel(MessageCallback callback,
1746 int message_levels,
1747 Local<Value> data = Local<Value>());
1748
1752 void RemoveMessageListeners(MessageCallback callback);
1753
1755 void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
1756
1761 void SetCaptureStackTraceForUncaughtExceptions(
1762 bool capture, int frame_limit = 10,
1763 StackTrace::StackTraceOptions options = StackTrace::kOverview);
1764
1769 bool IsInUse();
1770
1776 void SetAllowAtomicsWait(bool allow);
1777
1791 enum class TimeZoneDetection { kSkip, kRedetect };
1792
1804 TimeZoneDetection time_zone_detection = TimeZoneDetection::kSkip);
1805
1816
1821 std::string GetDefaultLocale();
1822
1837
1841 uint64_t GetHashSeed();
1842
1843 Isolate() = delete;
1844 ~Isolate() = delete;
1845 Isolate(const Isolate&) = delete;
1846 Isolate& operator=(const Isolate&) = delete;
1847 // Deleting operator new and delete here is allowed as ctor and dtor is also
1848 // deleted.
1849 void* operator new(size_t size) = delete;
1850 void* operator new[](size_t size) = delete;
1851 void operator delete(void*, size_t) = delete;
1852 void operator delete[](void*, size_t) = delete;
1853
1854 private:
1855 template <class K, class V, class Traits>
1858
1860 size_t index);
1861 int64_t AdjustAmountOfExternalAllocatedMemoryImpl(int64_t change_in_bytes);
1862 void HandleExternalMemoryInterrupt();
1863};
1864
1865void Isolate::SetData(uint32_t slot, void* data) {
1866 using I = internal::Internals;
1867 I::SetEmbedderData(this, slot, data);
1868}
1869
1870void* Isolate::GetData(uint32_t slot) {
1871 using I = internal::Internals;
1872 return I::GetEmbedderData(this, slot);
1873}
1874
1875uint32_t Isolate::GetNumberOfDataSlots() {
1876 using I = internal::Internals;
1877 return I::kNumIsolateDataSlots;
1878}
1879
1880template <class T>
1881MaybeLocal<T> Isolate::GetDataFromSnapshotOnce(size_t index) {
1882 if (auto repr = GetDataFromSnapshotOnce(index);
1883 repr != internal::ValueHelper::kEmpty) {
1884 internal::PerformCastCheck(internal::ValueHelper::ReprAsValue<T>(repr));
1885 return Local<T>::FromRepr(repr);
1886 }
1887 return {};
1888}
1889
1890} // namespace v8
1891
1892#endif // INCLUDE_V8_ISOLATE_H_
Definition: v8-array-buffer.h:148
Definition: v8-array-buffer.h:131
Definition: v8-context.h:48
Definition: v8-cppgc.h:65
Definition: v8-data.h:18
Definition: v8-embedder-heap.h:22
Definition: v8-external-memory-accounter.h:23
Definition: v8-statistics.h:219
Definition: v8-statistics.h:202
Definition: v8-profiler.h:969
Definition: v8-statistics.h:183
Definition: v8-statistics.h:140
Definition: v8-isolate.h:223
static IsolateGroup Create()
static IsolateGroup GetDefault()
bool operator!=(const IsolateGroup &other) const
Definition: v8-isolate.h:257
bool SandboxContains(void *pointer) const
Definition: v8-isolate.h:269
IsolateGroup & operator=(const IsolateGroup &)
IsolateGroup(IsolateGroup &&other)
IsolateGroup(const IsolateGroup &)
bool operator==(const IsolateGroup &other) const
Definition: v8-isolate.h:253
static bool CanCreateNewGroups()
IsolateGroup & operator=(IsolateGroup &&other)
Definition: v8-isolate.h:425
AllowJavascriptExecutionScope(const AllowJavascriptExecutionScope &)=delete
AllowJavascriptExecutionScope & operator=(const AllowJavascriptExecutionScope &)=delete
DisallowJavascriptExecutionScope(Isolate *isolate, OnFailure on_failure)
DisallowJavascriptExecutionScope(const DisallowJavascriptExecutionScope &)=delete
DisallowJavascriptExecutionScope & operator=(const DisallowJavascriptExecutionScope &)=delete
@ CRASH_ON_FAILURE
Definition: v8-isolate.h:405
Definition: v8-isolate.h:384
Scope(Isolate *isolate)
Definition: v8-isolate.h:386
Scope(const Scope &)=delete
~Scope()
Definition: v8-isolate.h:390
Scope & operator=(const Scope &)=delete
SuppressMicrotaskExecutionScope(Isolate *isolate, MicrotaskQueue *microtask_queue=nullptr)
SuppressMicrotaskExecutionScope & operator=(const SuppressMicrotaskExecutionScope &)=delete
SuppressMicrotaskExecutionScope(const SuppressMicrotaskExecutionScope &)=delete
Definition: v8-isolate.h:290
int GetStackTraceLimit()
void RemoveGCEpilogueCallback(GCCallback callback)
void AddGCPrologueCallback(GCCallbackWithData callback, void *data=nullptr, GCType gc_type_filter=kGCTypeAll)
void RemoveGCEpilogueCallback(GCCallbackWithData callback, void *data=nullptr)
void Dispose()
void LocaleConfigurationChangeNotification()
void AddBeforeCallEnteredCallback(BeforeCallEnteredCallback callback)
void RemoveMicrotasksCompletedCallback(MicrotasksCompletedCallbackWithData callback, void *data=nullptr)
void(*)(std::unique_ptr< CppHeap >) ReleaseCppHeapCallback
Definition: v8-isolate.h:1231
void SetEventLogger(LogEventCallback that)
Maybe< std::string > ValidateAndCanonicalizeUnicodeLocaleId(std::string_view locale)
void SetExceptionPropagationCallback(ExceptionPropagationCallback callback)
void RequestGarbageCollectionForTesting(GarbageCollectionType type, StackState stack_state)
void ClearKeptObjects()
void Deinitialize()
Local< Value > ThrowError(Local< String > message)
CppHeap * GetCppHeap() const
size_t(*)() GetExternallyAllocatedMemoryInBytesCallback
Definition: v8-isolate.h:1246
static Isolate * New(const CreateParams &params)
Isolate()=delete
void SetAddCrashKeyCallback(AddCrashKeyCallback)
static Isolate * GetCurrent()
void RemoveCallCompletedCallback(CallCompletedCallback callback)
static void Free(Isolate *isolate)
static void Initialize(Isolate *isolate, const CreateParams &params)
bool HasPendingException()
static Isolate * New(const IsolateGroup &group, const CreateParams &params)
TimeZoneDetection
Definition: v8-isolate.h:1791
void RequestGarbageCollectionForTesting(GarbageCollectionType type)
void SetMemorySaverMode(bool memory_saver_mode_enabled)
GarbageCollectionType
Definition: v8-isolate.h:471
@ kFullGarbageCollection
Definition: v8-isolate.h:472
void DumpAndResetStats()
void SetHostImportModuleDynamicallyCallback(HostImportModuleDynamicallyCallback callback)
void(*)(Isolate *isolate, GCType type, GCCallbackFlags flags) GCCallback
Definition: v8-isolate.h:1149
static Isolate * Allocate(const IsolateGroup &group)
void SetMicrotasksPolicy(MicrotasksPolicy policy)
void SetIsJSApiWrapperNativeErrorCallback(IsJSApiWrapperNativeErrorCallback callback)
void SetPromiseRejectCallback(PromiseRejectCallback callback)
void SetPromiseHook(PromiseHook hook)
void(*)(Isolate *isolate, UseCounterFeature feature) UseCounterCallback
Definition: v8-isolate.h:694
void CancelTerminateExecution()
void(*)(Isolate *isolate, GCType type, GCCallbackFlags flags, void *data) GCCallbackWithData
Definition: v8-isolate.h:1151
void SetHostCreateShadowRealmContextCallback(HostCreateShadowRealmContextCallback callback)
bool IsCurrent() const
void EnqueueMicrotask(Local< Function > microtask)
void AddGCPrologueCallback(GCCallback callback, GCType gc_type_filter=kGCTypeAll)
void RemoveGCPrologueCallback(GCCallback callback)
void SetBatterySaverMode(bool battery_saver_mode_enabled)
void DateTimeConfigurationChangeNotification(TimeZoneDetection time_zone_detection=TimeZoneDetection::kSkip)
void AddCallCompletedCallback(CallCompletedCallback callback)
void SetEmbedderRootsHandler(EmbedderRootsHandler *handler)
void RemoveBeforeCallEnteredCallback(BeforeCallEnteredCallback callback)
void RequestInterrupt(InterruptCallback callback, void *data)
uint64_t GetHashSeed()
void AddGCEpilogueCallback(GCCallbackWithData callback, void *data=nullptr, GCType gc_type_filter=kGCTypeAll)
Isolate & operator=(const Isolate &)=delete
std::string GetDefaultLocale()
void PerformMicrotaskCheckpoint()
void SetPrepareStackTraceCallback(PrepareStackTraceCallback callback)
void LowMemoryNotification()
Priority
Definition: v8-isolate.h:679
Isolate(const Isolate &)=delete
void SetCounterFunction(CounterLookupCallback)
MicrotasksPolicy GetMicrotasksPolicy() const
void AddGCEpilogueCallback(GCCallback callback, GCType gc_type_filter=kGCTypeAll)
bool HasPendingBackgroundTasks()
void DiscardThreadSpecificMetadata()
static Isolate * TryGetCurrent()
Local< Value > ThrowException(Local< Value > exception)
static Isolate * Allocate()
MessageErrorLevel
Definition: v8-isolate.h:668
bool(*)(Isolate *) AbortOnUncaughtExceptionCallback
Definition: v8-isolate.h:780
void AddMicrotasksCompletedCallback(MicrotasksCompletedCallbackWithData callback, void *data=nullptr)
void TerminateExecution()
void SetHostInitializeImportMetaObjectCallback(HostInitializeImportMetaObjectCallback callback)
void SetUseCounterCallback(UseCounterCallback callback)
void SetMetricsRecorder(const std::shared_ptr< metrics::Recorder > &metrics_recorder)
void MemoryPressureNotification(MemoryPressureLevel level)
void EnqueueMicrotask(MicrotaskCallback callback, void *data=nullptr)
void SetAddHistogramSampleFunction(AddHistogramSampleCallback)
IsolateGroup GetGroup() const
void SetGetExternallyAllocatedMemoryInBytesCallback(GetExternallyAllocatedMemoryInBytesCallback callback)
void Enter()
UseCounterFeature
Definition: v8-isolate.h:484
bool IsExecutionTerminating()
void SetReleaseCppHeapCallbackForTesting(ReleaseCppHeapCallback callback)
~Isolate()=delete
void RemoveGCPrologueCallback(GCCallbackWithData, void *data=nullptr)
void SetAbortOnUncaughtExceptionCallback(AbortOnUncaughtExceptionCallback callback)
void ClearCachesForTesting()
void SetHostImportModuleWithPhaseDynamicallyCallback(HostImportModuleWithPhaseDynamicallyCallback callback)
void SetCreateHistogramFunction(CreateHistogramCallback)
Definition: v8-local-handle.h:297
Definition: v8-local-handle.h:665
Definition: v8-maybe.h:33
Definition: v8-statistics.h:55
Definition: v8-microtask-queue.h:40
Definition: v8-util.h:166
Definition: v8-isolate.h:64
void set_code_range_size_in_bytes(size_t limit)
Definition: v8-isolate.h:115
size_t max_old_generation_size_in_bytes() const
Definition: v8-isolate.h:124
void set_stack_limit(uint32_t *value)
Definition: v8-isolate.h:103
void set_initial_old_generation_size_in_bytes(size_t initial_size)
Definition: v8-isolate.h:146
void ConfigureDefaultsFromHeapSize(size_t initial_heap_size_in_bytes, size_t maximum_heap_size_in_bytes)
uint32_t * stack_limit() const
Definition: v8-isolate.h:102
size_t code_range_size_in_bytes() const
Definition: v8-isolate.h:114
void set_initial_young_generation_size_in_bytes(size_t initial_size)
Definition: v8-isolate.h:153
size_t initial_young_generation_size_in_bytes() const
Definition: v8-isolate.h:150
size_t max_young_generation_size_in_bytes() const
Definition: v8-isolate.h:136
void set_max_young_generation_size_in_bytes(size_t limit)
Definition: v8-isolate.h:139
size_t initial_old_generation_size_in_bytes() const
Definition: v8-isolate.h:143
uint64_t physical_memory_size_in_bytes() const
Definition: v8-isolate.h:157
void ConfigureDefaults(uint64_t physical_memory, uint64_t virtual_memory_limit)
void set_max_old_generation_size_in_bytes(size_t limit)
Definition: v8-isolate.h:127
Definition: v8-debug.h:117
Definition: v8-snapshot.h:21
Definition: v8-value.h:32
Definition: v8-platform.h:779
Definition: v8-internal.h:855
internal::Address * InternalRepresentationType
Definition: v8-internal.h:1677
Definition: v8-metrics.h:186
EmbedderStackState
Definition: common.h:15
uintptr_t Address
Definition: v8-internal.h:52
Definition: libplatform.h:15
void(*)(const JitCodeEvent *event) JitCodeEventHandler
Definition: v8-callbacks.h:142
JitCodeEventOptions
Definition: v8-callbacks.h:129
void(*)(const char *location, const OOMDetails &details) OOMErrorCallback
Definition: v8-callbacks.h:233
bool(*)(Local< Context > context) SharedArrayBufferConstructorEnabledCallback
Definition: v8-callbacks.h:329
void(*)(void *data) MicrotaskCallback
Definition: v8-microtask.h:14
GCCallbackFlags
Definition: v8-callbacks.h:179
bool(*)(Local< Context > context) WasmJSPIEnabledCallback
Definition: v8-callbacks.h:332
MicrotasksPolicy
Definition: v8-microtask.h:24
void(*)(Isolate *isolate, Local< Context > context, Local< Promise::Resolver > resolver, Local< Value > result, WasmAsyncSuccess success) WasmAsyncResolvePromiseCallback
Definition: v8-callbacks.h:318
bool(*)(const FunctionCallbackInfo< Value > &) ExtensionCallback
Definition: v8-callbacks.h:301
void(*)(PromiseHookType type, Local< Promise > promise, Local< Value > parent) PromiseHook
Definition: v8-promise.h:144
void(*)(Isolate *, void *) MicrotasksCompletedCallbackWithData
Definition: v8-microtask.h:13
ContextDependants
Definition: v8-isolate.h:186
void(*)(ExceptionPropagationMessage message) ExceptionPropagationCallback
Definition: v8-exception.h:133
void(*)(const FunctionCallbackInfo< Value > &) WasmStreamingCallback
Definition: v8-callbacks.h:311
void *(*)(const char *name, int min, int max, size_t buckets) CreateHistogramCallback
Definition: v8-callbacks.h:219
void(*)(Local< Context > context, Local< Module > module, Local< Object > meta) HostInitializeImportMetaObjectCallback
Definition: v8-callbacks.h:433
void(*)(Local< Message > message, Local< Value > data) MessageCallback
Definition: v8-callbacks.h:235
void(*)(CrashKeyId id, const std::string &value) AddCrashKeyCallback
Definition: v8-callbacks.h:256
void(*)(Isolate *isolate, void *data) InterruptCallback
Definition: v8-callbacks.h:191
void(*)(Isolate *) CallCompletedCallback
Definition: v8-callbacks.h:260
void(*)(void *histogram, int sample) AddHistogramSampleCallback
Definition: v8-callbacks.h:221
size_t(*)(void *data, size_t current_heap_limit, size_t initial_heap_limit) NearHeapLimitCallback
Definition: v8-callbacks.h:204
void(*)(Isolate *) BeforeCallEnteredCallback
Definition: v8-callbacks.h:259
bool(*)(Local< Context > context, Local< String > source) AllowWasmCodeGenerationCallback
Definition: v8-callbacks.h:304
void(*)(const char *location, const char *message) FatalErrorCallback
Definition: v8-callbacks.h:225
void(*)(PromiseRejectMessage message) PromiseRejectCallback
Definition: v8-promise.h:170
GCType
Definition: v8-callbacks.h:154
ModifyCodeGenerationFromStringsResult(*)(Local< Context > context, Local< Value > source, bool is_code_like) ModifyCodeGenerationFromStringsCallback2
Definition: v8-callbacks.h:282
void(*)(Local< Object > target, AccessType type, Local< Value > data) FailedAccessCheckCallback
Definition: v8-callbacks.h:298
bool(*)(Local< Context > context) WasmImportedStringsEnabledCallback
Definition: v8-callbacks.h:325
void(*)(const char *name, int status) LogEventCallback
Definition: v8-callbacks.h:241
MemoryPressureLevel
Definition: v8-isolate.h:180
MeasureMemoryExecution
Definition: v8-statistics.h:43
int *(*)(const char *name) CounterLookupCallback
Definition: v8-callbacks.h:216
bool(*)(Isolate *isolate, Local< Object > obj) IsJSApiWrapperNativeErrorCallback
Definition: v8-callbacks.h:455
Definition: v8-isolate.h:295
Definition: v8-unwinder.h:69
Definition: v8-unwinder.h:60
Definition: v8-unwinder.h:21
Definition: v8-unwinder.h:50
#define V8_EXPORT
Definition: v8config.h:812
#define V8_INLINE
Definition: v8config.h:511
#define V8_DEPRECATE_SOON(message)
Definition: v8config.h:625
#define ALLOW_COPY_AND_MOVE_WITH_DEPRECATED_FIELDS(ClassName)
Definition: v8config.h:648
#define V8_WARN_UNUSED_RESULT
Definition: v8config.h:682
#define V8_NODISCARD
Definition: v8config.h:704