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
157 private:
158 static constexpr size_t kMB = 1048576u;
159 size_t code_range_size_ = 0;
160 size_t max_old_generation_size_ = 0;
161 size_t max_young_generation_size_ = 0;
162 size_t initial_old_generation_size_ = 0;
163 size_t initial_young_generation_size_ = 0;
164 uint32_t* stack_limit_ = nullptr;
165};
166
176
187};
188
193
219 public:
227
232 static bool CanCreateNewGroups();
233
239
242
245
247
248 bool operator==(const IsolateGroup& other) const {
249 return isolate_group_ == other.isolate_group_;
250 }
251
252 bool operator!=(const IsolateGroup& other) const {
253 return !operator==(other);
254 }
255
256#ifdef V8_ENABLE_SANDBOX
261 bool SandboxContains(void* pointer) const;
262 VirtualAddressSpace* GetSandboxAddressSpace();
263#else
264 V8_INLINE bool SandboxContains(void* pointer) const { return true; }
265#endif
266
267 private:
268 friend class Isolate;
270
271 // The isolate_group pointer should be already acquired.
272 explicit IsolateGroup(internal::IsolateGroup*&& isolate_group);
273
274 internal::IsolateGroup* isolate_group_;
275};
276
286 public:
293
295
296
300 JitCodeEventHandler code_event_handler = nullptr;
301
306
311 const StartupData* snapshot_blob = nullptr;
312
317 CounterLookupCallback counter_lookup_callback = nullptr;
318
325 CreateHistogramCallback create_histogram_callback = nullptr;
326 AddHistogramSampleCallback add_histogram_sample_callback = nullptr;
327
337 ArrayBuffer::Allocator* array_buffer_allocator = nullptr;
338 std::shared_ptr<ArrayBuffer::Allocator> array_buffer_allocator_shared;
339
346 const intptr_t* external_references = nullptr;
347
352 bool allow_atomics_wait = true;
353
359 int embedder_wrapper_type_index = -1;
360 int embedder_wrapper_object_index = -1;
361
365 FatalErrorCallback fatal_error_callback = nullptr;
366 OOMErrorCallback oom_error_callback = nullptr;
367
372 CppHeap* cpp_heap = nullptr;
373 };
374
380 public:
381 explicit Scope(Isolate* isolate) : v8_isolate_(isolate) {
382 v8_isolate_->Enter();
383 }
384
385 ~Scope() { v8_isolate_->Exit(); }
386
387 // Prevent copying of Scope objects.
388 Scope(const Scope&) = delete;
389 Scope& operator=(const Scope&) = delete;
390
391 private:
392 Isolate* const v8_isolate_;
393 };
394
399 public:
400 enum OnFailure { CRASH_ON_FAILURE, THROW_ON_FAILURE, DUMP_ON_FAILURE };
401
404
405 // Prevent copying of Scope objects.
407 delete;
409 const DisallowJavascriptExecutionScope&) = delete;
410
411 private:
412 v8::Isolate* const v8_isolate_;
413 const OnFailure on_failure_;
414 bool was_execution_allowed_;
415 };
416
421 public:
424
425 // Prevent copying of Scope objects.
427 delete;
429 const AllowJavascriptExecutionScope&) = delete;
430
431 private:
432 Isolate* const v8_isolate_;
433 bool was_execution_allowed_assert_;
434 bool was_execution_allowed_throws_;
435 bool was_execution_allowed_dump_;
436 };
437
443 public:
445 Isolate* isolate, MicrotaskQueue* microtask_queue = nullptr);
447
448 // Prevent copying of Scope objects.
450 delete;
452 const SuppressMicrotaskExecutionScope&) = delete;
453
454 private:
455 internal::Isolate* const i_isolate_;
456 internal::MicrotaskQueue* const microtask_queue_;
457 internal::Address previous_stack_height_;
458
459 friend class internal::ThreadLocalTop;
460 };
461
468 kMinorGarbageCollection
469 };
470
480 kUseAsm = 0,
481 kBreakIterator = 1,
482 kOBSOLETE_LegacyConst = 2,
483 kOBSOLETE_MarkDequeOverflow = 3,
484 kOBSOLETE_StoreBufferOverflow = 4,
485 kOBSOLETE_SlotsBufferOverflow = 5,
486 kOBSOLETE_ObjectObserve = 6,
487 kForcedGC = 7,
488 kSloppyMode = 8,
489 kStrictMode = 9,
490 kOBSOLETE_StrongMode = 10,
491 kRegExpPrototypeStickyGetter = 11,
492 kRegExpPrototypeToString = 12,
493 kRegExpPrototypeUnicodeGetter = 13,
494 kOBSOLETE_IntlV8Parse = 14,
495 kOBSOLETE_IntlPattern = 15,
496 kOBSOLETE_IntlResolved = 16,
497 kOBSOLETE_PromiseChain = 17,
498 kOBSOLETE_PromiseAccept = 18,
499 kOBSOLETE_PromiseDefer = 19,
500 kHtmlCommentInExternalScript = 20,
501 kHtmlComment = 21,
502 kSloppyModeBlockScopedFunctionRedefinition = 22,
503 kForInInitializer = 23,
504 kOBSOLETE_ArrayProtectorDirtied = 24,
505 kArraySpeciesModified = 25,
506 kArrayPrototypeConstructorModified = 26,
507 kOBSOLETE_ArrayInstanceProtoModified = 27,
508 kArrayInstanceConstructorModified = 28,
509 kOBSOLETE_LegacyFunctionDeclaration = 29,
510 kOBSOLETE_RegExpPrototypeSourceGetter = 30,
511 kOBSOLETE_RegExpPrototypeOldFlagGetter = 31,
512 kDecimalWithLeadingZeroInStrictMode = 32,
513 kLegacyDateParser = 33,
514 kDefineGetterOrSetterWouldThrow = 34,
515 kFunctionConstructorReturnedUndefined = 35,
516 kAssigmentExpressionLHSIsCallInSloppy = 36,
517 kAssigmentExpressionLHSIsCallInStrict = 37,
518 kPromiseConstructorReturnedUndefined = 38,
519 kOBSOLETE_ConstructorNonUndefinedPrimitiveReturn = 39,
520 kOBSOLETE_LabeledExpressionStatement = 40,
521 kOBSOLETE_LineOrParagraphSeparatorAsLineTerminator = 41,
522 kIndexAccessor = 42,
523 kErrorCaptureStackTrace = 43,
524 kErrorPrepareStackTrace = 44,
525 kErrorStackTraceLimit = 45,
526 kWebAssemblyInstantiation = 46,
527 kDeoptimizerDisableSpeculation = 47,
528 kOBSOLETE_ArrayPrototypeSortJSArrayModifiedPrototype = 48,
529 kFunctionTokenOffsetTooLongForToString = 49,
530 kWasmSharedMemory = 50,
531 kWasmThreadOpcodes = 51,
532 kOBSOLETE_AtomicsNotify = 52,
533 kOBSOLETE_AtomicsWake = 53,
534 kCollator = 54,
535 kNumberFormat = 55,
536 kDateTimeFormat = 56,
537 kPluralRules = 57,
538 kRelativeTimeFormat = 58,
539 kLocale = 59,
540 kListFormat = 60,
541 kSegmenter = 61,
542 kStringLocaleCompare = 62,
543 kOBSOLETE_StringToLocaleUpperCase = 63,
544 kStringToLocaleLowerCase = 64,
545 kNumberToLocaleString = 65,
546 kDateToLocaleString = 66,
547 kDateToLocaleDateString = 67,
548 kDateToLocaleTimeString = 68,
549 kAttemptOverrideReadOnlyOnPrototypeSloppy = 69,
550 kAttemptOverrideReadOnlyOnPrototypeStrict = 70,
551 kOBSOLETE_OptimizedFunctionWithOneShotBytecode = 71,
552 kRegExpMatchIsTrueishOnNonJSRegExp = 72,
553 kRegExpMatchIsFalseishOnJSRegExp = 73,
554 kOBSOLETE_DateGetTimezoneOffset = 74,
555 kStringNormalize = 75,
556 kCallSiteAPIGetFunctionSloppyCall = 76,
557 kCallSiteAPIGetThisSloppyCall = 77,
558 kOBSOLETE_RegExpMatchAllWithNonGlobalRegExp = 78,
559 kRegExpExecCalledOnSlowRegExp = 79,
560 kRegExpReplaceCalledOnSlowRegExp = 80,
561 kDisplayNames = 81,
562 kSharedArrayBufferConstructed = 82,
563 kArrayPrototypeHasElements = 83,
564 kObjectPrototypeHasElements = 84,
565 kNumberFormatStyleUnit = 85,
566 kDateTimeFormatRange = 86,
567 kDateTimeFormatDateTimeStyle = 87,
568 kBreakIteratorTypeWord = 88,
569 kBreakIteratorTypeLine = 89,
570 kInvalidatedArrayBufferDetachingProtector = 90,
571 kInvalidatedArrayConstructorProtector V8_DEPRECATE_SOON(
572 "The ArrayConstructorProtector has been removed") = 91,
573 kInvalidatedArrayIteratorLookupChainProtector = 92,
574 kInvalidatedArraySpeciesLookupChainProtector = 93,
575 kInvalidatedIsConcatSpreadableLookupChainProtector = 94,
576 kInvalidatedMapIteratorLookupChainProtector = 95,
577 kInvalidatedNoElementsProtector = 96,
578 kInvalidatedPromiseHookProtector = 97,
579 kInvalidatedPromiseResolveLookupChainProtector = 98,
580 kInvalidatedPromiseSpeciesLookupChainProtector = 99,
581 kInvalidatedPromiseThenLookupChainProtector = 100,
582 kInvalidatedRegExpSpeciesLookupChainProtector = 101,
583 kInvalidatedSetIteratorLookupChainProtector = 102,
584 kInvalidatedStringIteratorLookupChainProtector = 103,
585 kInvalidatedStringLengthOverflowLookupChainProtector = 104,
586 kInvalidatedTypedArraySpeciesLookupChainProtector = 105,
587 kWasmSimdOpcodes = 106,
588 kVarRedeclaredCatchBinding = 107,
589 kWasmRefTypes = 108,
590 kOBSOLETE_WasmBulkMemory = 109,
591 kOBSOLETE_WasmMultiValue = 110,
592 kWasmExceptionHandling = 111,
593 kInvalidatedMegaDOMProtector = 112,
594 kFunctionPrototypeArguments = 113,
595 kFunctionPrototypeCaller = 114,
596 kTurboFanOsrCompileStarted = 115,
597 kAsyncStackTaggingCreateTaskCall = 116,
598 kDurationFormat = 117,
599 kInvalidatedNumberStringNotRegexpLikeProtector = 118,
600 kOBSOLETE_RegExpUnicodeSetIncompatibilitiesWithUnicodeMode = 119,
601 kOBSOLETE_ImportAssertionDeprecatedSyntax = 120,
602 kLocaleInfoObsoletedGetters = 121,
603 kLocaleInfoFunctions = 122,
604 kCompileHintsMagicAll = 123,
605 kInvalidatedNoProfilingProtector = 124,
606 kWasmMemory64 = 125,
607 kWasmMultiMemory = 126,
608 kWasmGC = 127,
609 kWasmImportedStrings = 128,
610 kSourceMappingUrlMagicCommentAtSign = 129,
611 kTemporalObject = 130,
612 kWasmModuleCompilation = 131,
613 kInvalidatedNoUndetectableObjectsProtector = 132,
614 kWasmJavaScriptPromiseIntegration = 133,
615 kWasmReturnCall = 134,
616 kWasmExtendedConst = 135,
617 kWasmRelaxedSimd = 136,
618 kWasmTypeReflection = 137,
619 kWasmExnRef = 138,
620 kWasmTypedFuncRef = 139,
621 kInvalidatedStringWrapperToPrimitiveProtector = 140,
622 kDocumentAllLegacyCall = 141,
623 kDocumentAllLegacyConstruct = 142,
624 kConsoleContext = 143,
625 kWasmImportedStringsUtf8 = 144,
626 kResizableArrayBuffer = 145,
627 kGrowableSharedArrayBuffer = 146,
628 kArrayByCopy = 147,
629 kArrayFromAsync = 148,
630 kIteratorMethods = 149,
631 kPromiseAny = 150,
632 kSetMethods = 151,
633 kArrayFindLast = 152,
634 kArrayGroup = 153,
635 kArrayBufferTransfer = 154,
636 kPromiseWithResolvers = 155,
637 kAtomicsWaitAsync = 156,
638 kExtendingNonExtensibleWithPrivate = 157,
639 kPromiseTry = 158,
640 kStringReplaceAll = 159,
641 kStringWellFormed = 160,
642 kWeakReferences = 161,
643 kErrorIsError = 162,
644 kInvalidatedTypedArrayLengthLookupChainProtector = 163,
645 kRegExpEscape = 164,
646 kFloat16Array = 165,
647 kExplicitResourceManagement = 166,
648 kWasmBranchHinting = 167,
649 kWasmMultiValue = 168,
650 kUint8ArrayToFromBase64AndHex = 169,
651 kAtomicsPause = 170,
652 kTopLevelAwait = 171,
653 kLogicalAssignment = 172,
654 kNullishCoalescing = 173,
655 kInvalidatedNoDateTimeConfigurationChangeProtector = 174,
656
657 // If you add new values here, you'll also need to update Chromium's:
658 // web_feature.mojom, use_counter_callback.cc, and enums.xml. V8 changes to
659 // this list need to be landed first, then changes on the Chromium side.
660 kUseCounterFeatureCount // This enum value must be last.
661 };
662
664 kMessageLog = (1 << 0),
665 kMessageDebug = (1 << 1),
666 kMessageInfo = (1 << 2),
667 kMessageError = (1 << 3),
668 kMessageWarning = (1 << 4),
669 kMessageAll = kMessageLog | kMessageDebug | kMessageInfo | kMessageError |
670 kMessageWarning,
671 };
672
673 // The different priorities that an isolate can have.
674 enum class Priority {
675 // The isolate does not relate to content that is currently important
676 // to the user. Lowest priority.
678
679 // The isolate contributes to content that is visible to the user, like a
680 // visible iframe that's not interacted directly with. High priority.
682
683 // The isolate contributes to content that is of the utmost importance to
684 // the user, like visible content in the focused window. Highest priority.
686 };
687
688 using UseCounterCallback = void (*)(Isolate* isolate,
689 UseCounterFeature feature);
690
705 static Isolate* Allocate();
706 static Isolate* Allocate(const IsolateGroup& group);
707
712
716 static void Initialize(Isolate* isolate, const CreateParams& params);
717
727 static Isolate* New(const CreateParams& params);
728 static Isolate* New(const IsolateGroup& group, const CreateParams& params);
729
737
745
749 bool IsCurrent() const;
750
765
778
785
797
804
811
819
825
830
831#if defined(V8_OS_WIN)
835 V8_DEPRECATE_SOON("Use SetFilterETWSessionByURL2Callback instead")
836 void SetFilterETWSessionByURLCallback(FilterETWSessionByURLCallback callback);
837 void SetFilterETWSessionByURL2Callback(
838 FilterETWSessionByURL2Callback callback);
839#endif // V8_OS_WIN
840
848
855 void SetBatterySaverMode(bool battery_saver_mode_enabled);
856
863 void SetMemorySaverMode(bool memory_saver_mode_enabled);
864
871
882 void Enter();
883
891 void Exit();
892
897 void Dispose();
898
905
912 static void Free(Isolate* isolate);
913
919
928
933 V8_INLINE void SetData(uint32_t slot, void* data);
934
939 V8_INLINE void* GetData(uint32_t slot);
940
945 V8_INLINE static uint32_t GetNumberOfDataSlots();
946
952 template <class T>
953 V8_INLINE MaybeLocal<T> GetDataFromSnapshotOnce(size_t index);
954
959 V8_DEPRECATE_SOON("Use GetContinuationPreservedEmbedderDataV2 instead")
960 Local<Value> GetContinuationPreservedEmbedderData();
961
966 V8_DEPRECATE_SOON("Use SetContinuationPreservedEmbedderDataV2 instead")
967 void SetContinuationPreservedEmbedderData(Local<Value> data);
968
975 Local<Data> GetContinuationPreservedEmbedderDataV2();
976
982 void SetContinuationPreservedEmbedderDataV2(Local<Data> data);
983
987 void GetHeapStatistics(HeapStatistics* heap_statistics);
988
992 size_t NumberOfHeapSpaces();
993
1003 bool GetHeapSpaceStatistics(HeapSpaceStatistics* space_statistics,
1004 size_t index);
1005
1009 size_t NumberOfTrackedHeapObjectTypes();
1010
1020 bool GetHeapObjectStatisticsAtLastGC(HeapObjectStatistics* object_statistics,
1021 size_t type_index);
1022
1030 bool GetHeapCodeAndMetadataStatistics(HeapCodeStatistics* object_statistics);
1031
1044 bool MeasureMemory(
1045 std::unique_ptr<MeasureMemoryDelegate> delegate,
1046 MeasureMemoryExecution execution = MeasureMemoryExecution::kDefault);
1047
1060 void GetStackSample(const RegisterState& state, void** frames,
1061 size_t frames_limit, SampleInfo* sample_info);
1062
1071 int64_t AdjustAmountOfExternalAllocatedMemory(int64_t change_in_bytes);
1072
1077 HeapProfiler* GetHeapProfiler();
1078
1082 void SetIdle(bool is_idle);
1083
1085 ArrayBuffer::Allocator* GetArrayBufferAllocator();
1086
1088 bool InContext();
1089
1094 Local<Context> GetCurrentContext();
1095
1102 Local<Context> GetEnteredOrMicrotaskContext();
1103
1108 Local<Context> GetIncumbentContext();
1109
1114 MaybeLocal<Data> GetCurrentHostDefinedOptions();
1115
1121 template <int N>
1122 Local<Value> ThrowError(const char (&message)[N]) {
1123 return ThrowError(String::NewFromUtf8Literal(this, message));
1124 }
1126
1134
1142
1143 using GCCallback = void (*)(Isolate* isolate, GCType type,
1144 GCCallbackFlags flags);
1145 using GCCallbackWithData = void (*)(Isolate* isolate, GCType type,
1146 GCCallbackFlags flags, void* data);
1147
1159 GCType gc_type_filter = kGCTypeAll);
1160
1166 void AddGCPrologueCallback(GCCallbackWithData callback, void* data = nullptr,
1167 GCType gc_type_filter = kGCTypeAll);
1168
1176
1183
1191 GCType gc_type_filter = kGCTypeAll);
1192
1198 void AddGCEpilogueCallback(GCCallbackWithData callback, void* data = nullptr,
1199 GCType gc_type_filter = kGCTypeAll);
1200
1208
1215 void* data = nullptr);
1216
1225
1226 using ReleaseCppHeapCallback = void (*)(std::unique_ptr<CppHeap>);
1227
1234
1240
1242
1251
1260
1270
1286
1295 void RequestInterrupt(InterruptCallback callback, void* data);
1296
1303
1314
1326 StackState stack_state);
1327
1332
1340
1345
1354
1359
1365
1371
1380
1388
1393
1397 void EnqueueMicrotask(MicrotaskCallback callback, void* data = nullptr);
1398
1403
1408
1423 MicrotasksCompletedCallbackWithData callback, void* data = nullptr);
1424
1429 MicrotasksCompletedCallbackWithData callback, void* data = nullptr);
1430
1435
1441
1450
1461 const std::shared_ptr<metrics::Recorder>& metrics_recorder);
1462
1469
1475
1485 V8_DEPRECATE_SOON("Use version that passes ContextDependants.")
1486 int ContextDisposedNotification(bool dependant_context = true);
1487
1495 void ContextDisposedNotification(ContextDependants dependants);
1496
1501 V8_DEPRECATE_SOON("Use SetPriority(Priority::kUserBlocking) instead")
1502 void IsolateInForegroundNotification();
1503
1508 V8_DEPRECATE_SOON("Use SetPriority(Priority::kBestEffort) instead")
1509 void IsolateInBackgroundNotification();
1510
1515 void SetPriority(Priority priority);
1516
1529 void SetIsLoading(bool is_loading);
1530
1537 void Freeze(bool is_frozen);
1538
1543 void IncreaseHeapLimitForDebugging();
1544
1548 void RestoreOriginalHeapLimit();
1549
1554 bool IsHeapLimitIncreasedForDebugging();
1555
1578 void SetJitCodeEventHandler(JitCodeEventOptions options,
1579 JitCodeEventHandler event_handler);
1580
1590 void SetStackLimit(uintptr_t stack_limit);
1591
1607 void GetCodeRange(void** start, size_t* length_in_bytes);
1608
1613 void GetEmbeddedCodeRange(const void** start, size_t* length_in_bytes);
1614
1618 JSEntryStubs GetJSEntryStubs();
1619
1620 static constexpr size_t kMinCodePagesBufferSize = 32;
1621
1635 size_t CopyCodePages(size_t capacity, MemoryRange* code_pages_out);
1636
1638 void SetFatalErrorHandler(FatalErrorCallback that);
1639
1641 void SetOOMErrorHandler(OOMErrorCallback that);
1642
1648 void AddNearHeapLimitCallback(NearHeapLimitCallback callback, void* data);
1649
1657 void RemoveNearHeapLimitCallback(NearHeapLimitCallback callback,
1658 size_t heap_limit);
1659
1666 void AutomaticallyRestoreInitialHeapLimit(double threshold_percent = 0.5);
1667
1672 void SetModifyCodeGenerationFromStringsCallback(
1674
1679 void SetAllowWasmCodeGenerationCallback(
1681
1686 void SetWasmModuleCallback(ExtensionCallback callback);
1687 void SetWasmInstanceCallback(ExtensionCallback callback);
1688
1689 void SetWasmStreamingCallback(WasmStreamingCallback callback);
1690
1691 void SetWasmAsyncResolvePromiseCallback(
1693
1694 void SetWasmLoadSourceMapCallback(WasmLoadSourceMapCallback callback);
1695
1696 void SetWasmImportedStringsEnabledCallback(
1698
1699 void SetSharedArrayBufferConstructorEnabledCallback(
1701
1702 void SetWasmJSPIEnabledCallback(WasmJSPIEnabledCallback callback);
1703
1709 void InstallConditionalFeatures(Local<Context> context);
1710
1715 bool IsDead();
1716
1726 bool AddMessageListener(MessageCallback callback,
1727 Local<Value> data = Local<Value>());
1728
1740 bool AddMessageListenerWithErrorLevel(MessageCallback callback,
1741 int message_levels,
1742 Local<Value> data = Local<Value>());
1743
1747 void RemoveMessageListeners(MessageCallback callback);
1748
1750 void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
1751
1756 void SetCaptureStackTraceForUncaughtExceptions(
1757 bool capture, int frame_limit = 10,
1758 StackTrace::StackTraceOptions options = StackTrace::kOverview);
1759
1764 bool IsInUse();
1765
1771 void SetAllowAtomicsWait(bool allow);
1772
1786 enum class TimeZoneDetection { kSkip, kRedetect };
1787
1799 TimeZoneDetection time_zone_detection = TimeZoneDetection::kSkip);
1800
1811
1816 std::string GetDefaultLocale();
1817
1832
1836 uint64_t GetHashSeed();
1837
1838 Isolate() = delete;
1839 ~Isolate() = delete;
1840 Isolate(const Isolate&) = delete;
1841 Isolate& operator=(const Isolate&) = delete;
1842 // Deleting operator new and delete here is allowed as ctor and dtor is also
1843 // deleted.
1844 void* operator new(size_t size) = delete;
1845 void* operator new[](size_t size) = delete;
1846 void operator delete(void*, size_t) = delete;
1847 void operator delete[](void*, size_t) = delete;
1848
1849 private:
1850 template <class K, class V, class Traits>
1853
1855 size_t index);
1856 int64_t AdjustAmountOfExternalAllocatedMemoryImpl(int64_t change_in_bytes);
1857 void HandleExternalMemoryInterrupt();
1858};
1859
1860void Isolate::SetData(uint32_t slot, void* data) {
1861 using I = internal::Internals;
1862 I::SetEmbedderData(this, slot, data);
1863}
1864
1865void* Isolate::GetData(uint32_t slot) {
1866 using I = internal::Internals;
1867 return I::GetEmbedderData(this, slot);
1868}
1869
1870uint32_t Isolate::GetNumberOfDataSlots() {
1871 using I = internal::Internals;
1872 return I::kNumIsolateDataSlots;
1873}
1874
1875template <class T>
1876MaybeLocal<T> Isolate::GetDataFromSnapshotOnce(size_t index) {
1877 if (auto repr = GetDataFromSnapshotOnce(index);
1878 repr != internal::ValueHelper::kEmpty) {
1879 internal::PerformCastCheck(internal::ValueHelper::ReprAsValue<T>(repr));
1880 return Local<T>::FromRepr(repr);
1881 }
1882 return {};
1883}
1884
1885} // namespace v8
1886
1887#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:218
static IsolateGroup Create()
static IsolateGroup GetDefault()
bool operator!=(const IsolateGroup &other) const
Definition: v8-isolate.h:252
bool SandboxContains(void *pointer) const
Definition: v8-isolate.h:264
IsolateGroup & operator=(const IsolateGroup &)
IsolateGroup(IsolateGroup &&other)
IsolateGroup(const IsolateGroup &)
bool operator==(const IsolateGroup &other) const
Definition: v8-isolate.h:248
static bool CanCreateNewGroups()
IsolateGroup & operator=(IsolateGroup &&other)
Definition: v8-isolate.h:420
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:400
Definition: v8-isolate.h:379
Scope(Isolate *isolate)
Definition: v8-isolate.h:381
Scope(const Scope &)=delete
~Scope()
Definition: v8-isolate.h:385
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:285
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:1226
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:1241
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:1786
void RequestGarbageCollectionForTesting(GarbageCollectionType type)
void SetMemorySaverMode(bool memory_saver_mode_enabled)
GarbageCollectionType
Definition: v8-isolate.h:466
@ kFullGarbageCollection
Definition: v8-isolate.h:467
void DumpAndResetStats()
void SetHostImportModuleDynamicallyCallback(HostImportModuleDynamicallyCallback callback)
void(*)(Isolate *isolate, GCType type, GCCallbackFlags flags) GCCallback
Definition: v8-isolate.h:1144
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:689
void CancelTerminateExecution()
void(*)(Isolate *isolate, GCType type, GCCallbackFlags flags, void *data) GCCallbackWithData
Definition: v8-isolate.h:1146
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:674
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:663
bool(*)(Isolate *) AbortOnUncaughtExceptionCallback
Definition: v8-isolate.h:775
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:479
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
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:849
internal::Address * InternalRepresentationType
Definition: v8-internal.h:1671
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:181
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:175
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:290
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:800
#define V8_INLINE
Definition: v8config.h:500
#define V8_DEPRECATE_SOON(message)
Definition: v8config.h:614
#define ALLOW_COPY_AND_MOVE_WITH_DEPRECATED_FIELDS(ClassName)
Definition: v8config.h:637
#define V8_WARN_UNUSED_RESULT
Definition: v8config.h:671
#define V8_NODISCARD
Definition: v8config.h:693