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
243 IsolateGroup(const IsolateGroup&) = delete;
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 private:
257 friend class Isolate;
259
260 // The isolate_group pointer should be already acquired.
261 explicit IsolateGroup(internal::IsolateGroup*&& isolate_group);
262
263 internal::IsolateGroup* isolate_group_;
264};
265
275 public:
282
284
285
289 JitCodeEventHandler code_event_handler = nullptr;
290
295
300 const StartupData* snapshot_blob = nullptr;
301
306 CounterLookupCallback counter_lookup_callback = nullptr;
307
314 CreateHistogramCallback create_histogram_callback = nullptr;
315 AddHistogramSampleCallback add_histogram_sample_callback = nullptr;
316
326 ArrayBuffer::Allocator* array_buffer_allocator = nullptr;
327 std::shared_ptr<ArrayBuffer::Allocator> array_buffer_allocator_shared;
328
335 const intptr_t* external_references = nullptr;
336
341 bool allow_atomics_wait = true;
342
348 int embedder_wrapper_type_index = -1;
349 int embedder_wrapper_object_index = -1;
350
354 FatalErrorCallback fatal_error_callback = nullptr;
355 OOMErrorCallback oom_error_callback = nullptr;
356
361 CppHeap* cpp_heap = nullptr;
362 };
363
369 public:
370 explicit Scope(Isolate* isolate) : v8_isolate_(isolate) {
371 v8_isolate_->Enter();
372 }
373
374 ~Scope() { v8_isolate_->Exit(); }
375
376 // Prevent copying of Scope objects.
377 Scope(const Scope&) = delete;
378 Scope& operator=(const Scope&) = delete;
379
380 private:
381 Isolate* const v8_isolate_;
382 };
383
388 public:
389 enum OnFailure { CRASH_ON_FAILURE, THROW_ON_FAILURE, DUMP_ON_FAILURE };
390
393
394 // Prevent copying of Scope objects.
396 delete;
398 const DisallowJavascriptExecutionScope&) = delete;
399
400 private:
401 v8::Isolate* const v8_isolate_;
402 const OnFailure on_failure_;
403 bool was_execution_allowed_;
404 };
405
410 public:
413
414 // Prevent copying of Scope objects.
416 delete;
418 const AllowJavascriptExecutionScope&) = delete;
419
420 private:
421 Isolate* const v8_isolate_;
422 bool was_execution_allowed_assert_;
423 bool was_execution_allowed_throws_;
424 bool was_execution_allowed_dump_;
425 };
426
432 public:
434 Isolate* isolate, MicrotaskQueue* microtask_queue = nullptr);
436
437 // Prevent copying of Scope objects.
439 delete;
441 const SuppressMicrotaskExecutionScope&) = delete;
442
443 private:
444 internal::Isolate* const i_isolate_;
445 internal::MicrotaskQueue* const microtask_queue_;
446 internal::Address previous_stack_height_;
447
448 friend class internal::ThreadLocalTop;
449 };
450
457 kMinorGarbageCollection
458 };
459
469 kUseAsm = 0,
470 kBreakIterator = 1,
471 kOBSOLETE_LegacyConst = 2,
472 kOBSOLETE_MarkDequeOverflow = 3,
473 kOBSOLETE_StoreBufferOverflow = 4,
474 kOBSOLETE_SlotsBufferOverflow = 5,
475 kOBSOLETE_ObjectObserve = 6,
476 kForcedGC = 7,
477 kSloppyMode = 8,
478 kStrictMode = 9,
479 kOBSOLETE_StrongMode = 10,
480 kRegExpPrototypeStickyGetter = 11,
481 kRegExpPrototypeToString = 12,
482 kRegExpPrototypeUnicodeGetter = 13,
483 kOBSOLETE_IntlV8Parse = 14,
484 kOBSOLETE_IntlPattern = 15,
485 kOBSOLETE_IntlResolved = 16,
486 kOBSOLETE_PromiseChain = 17,
487 kOBSOLETE_PromiseAccept = 18,
488 kOBSOLETE_PromiseDefer = 19,
489 kHtmlCommentInExternalScript = 20,
490 kHtmlComment = 21,
491 kSloppyModeBlockScopedFunctionRedefinition = 22,
492 kForInInitializer = 23,
493 kOBSOLETE_ArrayProtectorDirtied = 24,
494 kArraySpeciesModified = 25,
495 kArrayPrototypeConstructorModified = 26,
496 kOBSOLETE_ArrayInstanceProtoModified = 27,
497 kArrayInstanceConstructorModified = 28,
498 kOBSOLETE_LegacyFunctionDeclaration = 29,
499 kOBSOLETE_RegExpPrototypeSourceGetter = 30,
500 kOBSOLETE_RegExpPrototypeOldFlagGetter = 31,
501 kDecimalWithLeadingZeroInStrictMode = 32,
502 kLegacyDateParser = 33,
503 kDefineGetterOrSetterWouldThrow = 34,
504 kFunctionConstructorReturnedUndefined = 35,
505 kAssigmentExpressionLHSIsCallInSloppy = 36,
506 kAssigmentExpressionLHSIsCallInStrict = 37,
507 kPromiseConstructorReturnedUndefined = 38,
508 kOBSOLETE_ConstructorNonUndefinedPrimitiveReturn = 39,
509 kOBSOLETE_LabeledExpressionStatement = 40,
510 kOBSOLETE_LineOrParagraphSeparatorAsLineTerminator = 41,
511 kIndexAccessor = 42,
512 kErrorCaptureStackTrace = 43,
513 kErrorPrepareStackTrace = 44,
514 kErrorStackTraceLimit = 45,
515 kWebAssemblyInstantiation = 46,
516 kDeoptimizerDisableSpeculation = 47,
517 kOBSOLETE_ArrayPrototypeSortJSArrayModifiedPrototype = 48,
518 kFunctionTokenOffsetTooLongForToString = 49,
519 kWasmSharedMemory = 50,
520 kWasmThreadOpcodes = 51,
521 kOBSOLETE_AtomicsNotify = 52,
522 kOBSOLETE_AtomicsWake = 53,
523 kCollator = 54,
524 kNumberFormat = 55,
525 kDateTimeFormat = 56,
526 kPluralRules = 57,
527 kRelativeTimeFormat = 58,
528 kLocale = 59,
529 kListFormat = 60,
530 kSegmenter = 61,
531 kStringLocaleCompare = 62,
532 kOBSOLETE_StringToLocaleUpperCase = 63,
533 kStringToLocaleLowerCase = 64,
534 kNumberToLocaleString = 65,
535 kDateToLocaleString = 66,
536 kDateToLocaleDateString = 67,
537 kDateToLocaleTimeString = 68,
538 kAttemptOverrideReadOnlyOnPrototypeSloppy = 69,
539 kAttemptOverrideReadOnlyOnPrototypeStrict = 70,
540 kOBSOLETE_OptimizedFunctionWithOneShotBytecode = 71,
541 kRegExpMatchIsTrueishOnNonJSRegExp = 72,
542 kRegExpMatchIsFalseishOnJSRegExp = 73,
543 kOBSOLETE_DateGetTimezoneOffset = 74,
544 kStringNormalize = 75,
545 kCallSiteAPIGetFunctionSloppyCall = 76,
546 kCallSiteAPIGetThisSloppyCall = 77,
547 kOBSOLETE_RegExpMatchAllWithNonGlobalRegExp = 78,
548 kRegExpExecCalledOnSlowRegExp = 79,
549 kRegExpReplaceCalledOnSlowRegExp = 80,
550 kDisplayNames = 81,
551 kSharedArrayBufferConstructed = 82,
552 kArrayPrototypeHasElements = 83,
553 kObjectPrototypeHasElements = 84,
554 kNumberFormatStyleUnit = 85,
555 kDateTimeFormatRange = 86,
556 kDateTimeFormatDateTimeStyle = 87,
557 kBreakIteratorTypeWord = 88,
558 kBreakIteratorTypeLine = 89,
559 kInvalidatedArrayBufferDetachingProtector = 90,
560 kInvalidatedArrayConstructorProtector = 91,
561 kInvalidatedArrayIteratorLookupChainProtector = 92,
562 kInvalidatedArraySpeciesLookupChainProtector = 93,
563 kInvalidatedIsConcatSpreadableLookupChainProtector = 94,
564 kInvalidatedMapIteratorLookupChainProtector = 95,
565 kInvalidatedNoElementsProtector = 96,
566 kInvalidatedPromiseHookProtector = 97,
567 kInvalidatedPromiseResolveLookupChainProtector = 98,
568 kInvalidatedPromiseSpeciesLookupChainProtector = 99,
569 kInvalidatedPromiseThenLookupChainProtector = 100,
570 kInvalidatedRegExpSpeciesLookupChainProtector = 101,
571 kInvalidatedSetIteratorLookupChainProtector = 102,
572 kInvalidatedStringIteratorLookupChainProtector = 103,
573 kInvalidatedStringLengthOverflowLookupChainProtector = 104,
574 kInvalidatedTypedArraySpeciesLookupChainProtector = 105,
575 kWasmSimdOpcodes = 106,
576 kVarRedeclaredCatchBinding = 107,
577 kWasmRefTypes = 108,
578 kOBSOLETE_WasmBulkMemory = 109,
579 kOBSOLETE_WasmMultiValue = 110,
580 kWasmExceptionHandling = 111,
581 kInvalidatedMegaDOMProtector = 112,
582 kFunctionPrototypeArguments = 113,
583 kFunctionPrototypeCaller = 114,
584 kTurboFanOsrCompileStarted = 115,
585 kAsyncStackTaggingCreateTaskCall = 116,
586 kDurationFormat = 117,
587 kInvalidatedNumberStringNotRegexpLikeProtector = 118,
588 kOBSOLETE_RegExpUnicodeSetIncompatibilitiesWithUnicodeMode = 119,
589 kOBSOLETE_ImportAssertionDeprecatedSyntax = 120,
590 kLocaleInfoObsoletedGetters = 121,
591 kLocaleInfoFunctions = 122,
592 kCompileHintsMagicAll = 123,
593 kInvalidatedNoProfilingProtector = 124,
594 kWasmMemory64 = 125,
595 kWasmMultiMemory = 126,
596 kWasmGC = 127,
597 kWasmImportedStrings = 128,
598 kSourceMappingUrlMagicCommentAtSign = 129,
599 kTemporalObject = 130,
600 kWasmModuleCompilation = 131,
601 kInvalidatedNoUndetectableObjectsProtector = 132,
602 kWasmJavaScriptPromiseIntegration = 133,
603 kWasmReturnCall = 134,
604 kWasmExtendedConst = 135,
605 kWasmRelaxedSimd = 136,
606 kWasmTypeReflection = 137,
607 kWasmExnRef = 138,
608 kWasmTypedFuncRef = 139,
609 kInvalidatedStringWrapperToPrimitiveProtector = 140,
610 kDocumentAllLegacyCall = 141,
611 kDocumentAllLegacyConstruct = 142,
612 kConsoleContext = 143,
613 kWasmImportedStringsUtf8 = 144,
614 kResizableArrayBuffer = 145,
615 kGrowableSharedArrayBuffer = 146,
616 kArrayByCopy = 147,
617 kArrayFromAsync = 148,
618 kIteratorMethods = 149,
619 kPromiseAny = 150,
620 kSetMethods = 151,
621 kArrayFindLast = 152,
622 kArrayGroup = 153,
623 kArrayBufferTransfer = 154,
624 kPromiseWithResolvers = 155,
625 kAtomicsWaitAsync = 156,
626 kExtendingNonExtensibleWithPrivate = 157,
627 kPromiseTry = 158,
628 kStringReplaceAll = 159,
629 kStringWellFormed = 160,
630 kWeakReferences = 161,
631 kErrorIsError = 162,
632 kInvalidatedTypedArrayLengthLookupChainProtector = 163,
633 kRegExpEscape = 164,
634 kFloat16Array = 165,
635
636 // If you add new values here, you'll also need to update Chromium's:
637 // web_feature.mojom, use_counter_callback.cc, and enums.xml. V8 changes to
638 // this list need to be landed first, then changes on the Chromium side.
639 kUseCounterFeatureCount // This enum value must be last.
640 };
641
643 kMessageLog = (1 << 0),
644 kMessageDebug = (1 << 1),
645 kMessageInfo = (1 << 2),
646 kMessageError = (1 << 3),
647 kMessageWarning = (1 << 4),
648 kMessageAll = kMessageLog | kMessageDebug | kMessageInfo | kMessageError |
649 kMessageWarning,
650 };
651
652 // The different priorities that an isolate can have.
653 enum class Priority {
654 // The isolate does not relate to content that is currently important
655 // to the user. Lowest priority.
657
658 // The isolate contributes to content that is visible to the user, like a
659 // visible iframe that's not interacted directly with. High priority.
661
662 // The isolate contributes to content that is of the utmost importance to
663 // the user, like visible content in the focused window. Highest priority.
665 };
666
667 using UseCounterCallback = void (*)(Isolate* isolate,
668 UseCounterFeature feature);
669
684 static Isolate* Allocate();
685 static Isolate* Allocate(const IsolateGroup& group);
686
691
695 static void Initialize(Isolate* isolate, const CreateParams& params);
696
706 static Isolate* New(const CreateParams& params);
707 static Isolate* New(const IsolateGroup& group, const CreateParams& params);
708
716
724
728 bool IsCurrent() const;
729
744
757
764
776
783
790
798
804
809
810#if defined(V8_OS_WIN)
814 V8_DEPRECATE_SOON("Use SetFilterETWSessionByURL2Callback instead")
815 void SetFilterETWSessionByURLCallback(FilterETWSessionByURLCallback callback);
816 void SetFilterETWSessionByURL2Callback(
817 FilterETWSessionByURL2Callback callback);
818#endif // V8_OS_WIN
819
827
834 void SetBatterySaverMode(bool battery_saver_mode_enabled);
835
842 void SetMemorySaverMode(bool memory_saver_mode_enabled);
843
850
861 void Enter();
862
870 void Exit();
871
876 void Dispose();
877
883
892
897 V8_INLINE void SetData(uint32_t slot, void* data);
898
903 V8_INLINE void* GetData(uint32_t slot);
904
909 V8_INLINE static uint32_t GetNumberOfDataSlots();
910
916 template <class T>
917 V8_INLINE MaybeLocal<T> GetDataFromSnapshotOnce(size_t index);
918
924
930
934 void GetHeapStatistics(HeapStatistics* heap_statistics);
935
940
951 size_t index);
952
957
968 size_t type_index);
969
978
992 std::unique_ptr<MeasureMemoryDelegate> delegate,
993 MeasureMemoryExecution execution = MeasureMemoryExecution::kDefault);
994
1007 void GetStackSample(const RegisterState& state, void** frames,
1008 size_t frames_limit, SampleInfo* sample_info);
1009
1017 V8_DEPRECATE_SOON("Use ExternalMemoryAccounter instead.")
1018 int64_t AdjustAmountOfExternalAllocatedMemory(int64_t change_in_bytes);
1019
1024 HeapProfiler* GetHeapProfiler();
1025
1029 void SetIdle(bool is_idle);
1030
1032 ArrayBuffer::Allocator* GetArrayBufferAllocator();
1033
1035 bool InContext();
1036
1041 Local<Context> GetCurrentContext();
1042
1049 Local<Context> GetEnteredOrMicrotaskContext();
1050
1055 Local<Context> GetIncumbentContext();
1056
1061 MaybeLocal<Data> GetCurrentHostDefinedOptions();
1062
1068 template <int N>
1069 Local<Value> ThrowError(const char (&message)[N]) {
1070 return ThrowError(String::NewFromUtf8Literal(this, message));
1071 }
1073
1081
1089
1090 using GCCallback = void (*)(Isolate* isolate, GCType type,
1091 GCCallbackFlags flags);
1092 using GCCallbackWithData = void (*)(Isolate* isolate, GCType type,
1093 GCCallbackFlags flags, void* data);
1094
1106 GCType gc_type_filter = kGCTypeAll);
1107
1113 void AddGCPrologueCallback(GCCallbackWithData callback, void* data = nullptr,
1114 GCType gc_type_filter = kGCTypeAll);
1115
1123
1130
1138 GCType gc_type_filter = kGCTypeAll);
1139
1145 void AddGCEpilogueCallback(GCCallbackWithData callback, void* data = nullptr,
1146 GCType gc_type_filter = kGCTypeAll);
1147
1155
1162 void* data = nullptr);
1163
1172
1183 V8_DEPRECATED("Set the heap on Isolate creation using CreateParams instead.")
1184 void AttachCppHeap(CppHeap*);
1185
1192 "The CppHeap gets detached automatically during Isolate tear down.")
1193 void DetachCppHeap();
1194
1195 using ReleaseCppHeapCallback = void (*)(std::unique_ptr<CppHeap>);
1196
1202 void SetReleaseCppHeapCallbackForTesting(ReleaseCppHeapCallback callback);
1203
1208 CppHeap* GetCppHeap() const;
1209
1213 enum class AtomicsWaitEvent {
1215 kStartWait,
1217 kWokenUp,
1219 kTimedOut,
1221 kTerminatedExecution,
1223 kAPIStopped,
1225 kNotEqual
1226 };
1227
1232#if !defined(__clang__) && defined(V8_CC_GNU)
1233 // We cannot mix the usage of [[deprecated]] syntax with the __ attribute __
1234 // syntax (from V8_EXPORT) due to a gcc bug:
1235 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=69585
1236 class __attribute__((
1237 deprecated("AtomicsWaitWakeHandle is unused and will be removed.")))
1238#else
1239 class V8_DEPRECATED("AtomicsWaitWakeHandle is unused and will be removed.")
1240#endif
1242 public:
1257 void Wake();
1258 };
1259
1285 Local<SharedArrayBuffer> array_buffer,
1286 size_t offset_in_bytes, int64_t value,
1287 double timeout_in_ms,
1288 AtomicsWaitWakeHandle* stop_handle,
1289 void* data);
1291
1298 V8_DEPRECATED("SetAtomicsWaitCallback is unused and will be removed.")
1299 void SetAtomicsWaitCallback(AtomicsWaitCallback callback, void* data);
1300
1302
1309 void SetGetExternallyAllocatedMemoryInBytesCallback(
1311
1319 void TerminateExecution();
1320
1329 bool IsExecutionTerminating();
1330
1345 void CancelTerminateExecution();
1346
1355 void RequestInterrupt(InterruptCallback callback, void* data);
1356
1362 bool HasPendingBackgroundTasks();
1363
1373 void RequestGarbageCollectionForTesting(GarbageCollectionType type);
1374
1385 void RequestGarbageCollectionForTesting(GarbageCollectionType type,
1386 StackState stack_state);
1387
1391 void SetEventLogger(LogEventCallback that);
1392
1399 void AddBeforeCallEnteredCallback(BeforeCallEnteredCallback callback);
1400
1404 void RemoveBeforeCallEnteredCallback(BeforeCallEnteredCallback callback);
1405
1413 void AddCallCompletedCallback(CallCompletedCallback callback);
1414
1418 void RemoveCallCompletedCallback(CallCompletedCallback callback);
1419
1424 void SetPromiseHook(PromiseHook hook);
1425
1430 void SetPromiseRejectCallback(PromiseRejectCallback callback);
1431
1439 void SetExceptionPropagationCallback(ExceptionPropagationCallback callback);
1440
1447 void PerformMicrotaskCheckpoint();
1448
1452 void EnqueueMicrotask(Local<Function> microtask);
1453
1457 void EnqueueMicrotask(MicrotaskCallback callback, void* data = nullptr);
1458
1462 void SetMicrotasksPolicy(MicrotasksPolicy policy);
1463
1467 MicrotasksPolicy GetMicrotasksPolicy() const;
1468
1482 void AddMicrotasksCompletedCallback(
1483 MicrotasksCompletedCallbackWithData callback, void* data = nullptr);
1484
1488 void RemoveMicrotasksCompletedCallback(
1489 MicrotasksCompletedCallbackWithData callback, void* data = nullptr);
1490
1494 void SetUseCounterCallback(UseCounterCallback callback);
1495
1500 void SetCounterFunction(CounterLookupCallback);
1501
1508 void SetCreateHistogramFunction(CreateHistogramCallback);
1509 void SetAddHistogramSampleFunction(AddHistogramSampleCallback);
1510
1520 void SetMetricsRecorder(
1521 const std::shared_ptr<metrics::Recorder>& metrics_recorder);
1522
1528 void SetAddCrashKeyCallback(AddCrashKeyCallback);
1529
1534 void LowMemoryNotification();
1535
1545 V8_DEPRECATE_SOON("Use version that passes ContextDependants.")
1546 int ContextDisposedNotification(bool dependant_context = true);
1547
1555 void ContextDisposedNotification(ContextDependants dependants);
1556
1561 V8_DEPRECATE_SOON("Use SetPriority(Priority::kUserBlocking) instead")
1562 void IsolateInForegroundNotification();
1563
1568 V8_DEPRECATE_SOON("Use SetPriority(Priority::kBestEffort) instead")
1569 void IsolateInBackgroundNotification();
1570
1575 void SetPriority(Priority priority);
1576
1589 void SetIsLoading(bool is_loading);
1590
1597 void Freeze(bool is_frozen);
1598
1603 void IncreaseHeapLimitForDebugging();
1604
1608 void RestoreOriginalHeapLimit();
1609
1614 bool IsHeapLimitIncreasedForDebugging();
1615
1638 void SetJitCodeEventHandler(JitCodeEventOptions options,
1639 JitCodeEventHandler event_handler);
1640
1650 void SetStackLimit(uintptr_t stack_limit);
1651
1667 void GetCodeRange(void** start, size_t* length_in_bytes);
1668
1673 void GetEmbeddedCodeRange(const void** start, size_t* length_in_bytes);
1674
1678 JSEntryStubs GetJSEntryStubs();
1679
1680 static constexpr size_t kMinCodePagesBufferSize = 32;
1681
1695 size_t CopyCodePages(size_t capacity, MemoryRange* code_pages_out);
1696
1698 void SetFatalErrorHandler(FatalErrorCallback that);
1699
1701 void SetOOMErrorHandler(OOMErrorCallback that);
1702
1708 void AddNearHeapLimitCallback(NearHeapLimitCallback callback, void* data);
1709
1717 void RemoveNearHeapLimitCallback(NearHeapLimitCallback callback,
1718 size_t heap_limit);
1719
1726 void AutomaticallyRestoreInitialHeapLimit(double threshold_percent = 0.5);
1727
1732 void SetModifyCodeGenerationFromStringsCallback(
1734
1739 void SetAllowWasmCodeGenerationCallback(
1741
1746 void SetWasmModuleCallback(ExtensionCallback callback);
1747 void SetWasmInstanceCallback(ExtensionCallback callback);
1748
1749 void SetWasmStreamingCallback(WasmStreamingCallback callback);
1750
1751 void SetWasmAsyncResolvePromiseCallback(
1753
1754 void SetWasmLoadSourceMapCallback(WasmLoadSourceMapCallback callback);
1755
1756 void SetWasmImportedStringsEnabledCallback(
1758
1759 void SetSharedArrayBufferConstructorEnabledCallback(
1761
1762 void SetWasmJSPIEnabledCallback(WasmJSPIEnabledCallback callback);
1763
1769 "Will be removed, use ScriptCompiler::CompileOptions for enabling the "
1770 "compile hints magic comments")
1771 void SetJavaScriptCompileHintsMagicEnabledCallback(
1773
1779 void InstallConditionalFeatures(Local<Context> context);
1780
1785 bool IsDead();
1786
1796 bool AddMessageListener(MessageCallback that,
1797 Local<Value> data = Local<Value>());
1798
1810 bool AddMessageListenerWithErrorLevel(MessageCallback that,
1811 int message_levels,
1812 Local<Value> data = Local<Value>());
1813
1817 void RemoveMessageListeners(MessageCallback that);
1818
1820 void SetFailedAccessCheckCallbackFunction(FailedAccessCheckCallback);
1821
1826 void SetCaptureStackTraceForUncaughtExceptions(
1827 bool capture, int frame_limit = 10,
1828 StackTrace::StackTraceOptions options = StackTrace::kOverview);
1829
1834 bool IsInUse();
1835
1841 void SetAllowAtomicsWait(bool allow);
1842
1856 enum class TimeZoneDetection { kSkip, kRedetect };
1857
1869 TimeZoneDetection time_zone_detection = TimeZoneDetection::kSkip);
1870
1881
1886 std::string GetDefaultLocale();
1887
1891 uint64_t GetHashSeed();
1892
1893 Isolate() = delete;
1894 ~Isolate() = delete;
1895 Isolate(const Isolate&) = delete;
1896 Isolate& operator=(const Isolate&) = delete;
1897 // Deleting operator new and delete here is allowed as ctor and dtor is also
1898 // deleted.
1899 void* operator new(size_t size) = delete;
1900 void* operator new[](size_t size) = delete;
1901 void operator delete(void*, size_t) = delete;
1902 void operator delete[](void*, size_t) = delete;
1903
1904 private:
1905 template <class K, class V, class Traits>
1908
1910 size_t index);
1911 int64_t AdjustAmountOfExternalAllocatedMemoryImpl(int64_t change_in_bytes);
1912 void HandleExternalMemoryInterrupt();
1913};
1914
1915void Isolate::SetData(uint32_t slot, void* data) {
1916 using I = internal::Internals;
1917 I::SetEmbedderData(this, slot, data);
1918}
1919
1920void* Isolate::GetData(uint32_t slot) {
1921 using I = internal::Internals;
1922 return I::GetEmbedderData(this, slot);
1923}
1924
1925uint32_t Isolate::GetNumberOfDataSlots() {
1926 using I = internal::Internals;
1927 return I::kNumIsolateDataSlots;
1928}
1929
1930template <class T>
1931MaybeLocal<T> Isolate::GetDataFromSnapshotOnce(size_t index) {
1932 if (auto repr = GetDataFromSnapshotOnce(index);
1933 repr != internal::ValueHelper::kEmpty) {
1934 internal::PerformCastCheck(internal::ValueHelper::ReprAsValue<T>(repr));
1935 return Local<T>::FromRepr(repr);
1936 }
1937 return {};
1938}
1939
1940} // namespace v8
1941
1942#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-function.h:27
Definition: v8-statistics.h:219
Definition: v8-statistics.h:202
Definition: v8-profiler.h:965
Definition: v8-statistics.h:183
Definition: v8-statistics.h:140
Definition: v8-isolate.h:218
static IsolateGroup Create()
IsolateGroup & operator=(const IsolateGroup &)=delete
static IsolateGroup GetDefault()
bool operator!=(const IsolateGroup &other) const
Definition: v8-isolate.h:252
IsolateGroup(const IsolateGroup &)=delete
IsolateGroup(IsolateGroup &&other)
bool operator==(const IsolateGroup &other) const
Definition: v8-isolate.h:248
static bool CanCreateNewGroups()
IsolateGroup & operator=(IsolateGroup &&other)
Definition: v8-isolate.h:409
AllowJavascriptExecutionScope(const AllowJavascriptExecutionScope &)=delete
AllowJavascriptExecutionScope & operator=(const AllowJavascriptExecutionScope &)=delete
Definition: v8-isolate.h:1241
DisallowJavascriptExecutionScope(Isolate *isolate, OnFailure on_failure)
DisallowJavascriptExecutionScope(const DisallowJavascriptExecutionScope &)=delete
DisallowJavascriptExecutionScope & operator=(const DisallowJavascriptExecutionScope &)=delete
@ CRASH_ON_FAILURE
Definition: v8-isolate.h:389
Definition: v8-isolate.h:368
Scope(Isolate *isolate)
Definition: v8-isolate.h:370
Scope(const Scope &)=delete
~Scope()
Definition: v8-isolate.h:374
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:274
int GetStackTraceLimit()
void RemoveGCEpilogueCallback(GCCallback callback)
void AddGCPrologueCallback(GCCallbackWithData callback, void *data=nullptr, GCType gc_type_filter=kGCTypeAll)
bool GetHeapCodeAndMetadataStatistics(HeapCodeStatistics *object_statistics)
bool MeasureMemory(std::unique_ptr< MeasureMemoryDelegate > delegate, MeasureMemoryExecution execution=MeasureMemoryExecution::kDefault)
size_t NumberOfTrackedHeapObjectTypes()
void RemoveGCEpilogueCallback(GCCallbackWithData callback, void *data=nullptr)
void Dispose()
void LocaleConfigurationChangeNotification()
void(*)(std::unique_ptr< CppHeap >) ReleaseCppHeapCallback
Definition: v8-isolate.h:1195
bool GetHeapSpaceStatistics(HeapSpaceStatistics *space_statistics, size_t index)
void ClearKeptObjects()
Local< Value > ThrowError(Local< String > message)
size_t(*)() GetExternallyAllocatedMemoryInBytesCallback
Definition: v8-isolate.h:1301
static Isolate * New(const CreateParams &params)
Isolate()=delete
static Isolate * GetCurrent()
static void Initialize(Isolate *isolate, const CreateParams &params)
bool HasPendingException()
static Isolate * New(const IsolateGroup &group, const CreateParams &params)
TimeZoneDetection
Definition: v8-isolate.h:1856
void SetMemorySaverMode(bool memory_saver_mode_enabled)
GarbageCollectionType
Definition: v8-isolate.h:455
@ kFullGarbageCollection
Definition: v8-isolate.h:456
void DumpAndResetStats()
void SetHostImportModuleDynamicallyCallback(HostImportModuleDynamicallyCallback callback)
void(*)(Isolate *isolate, GCType type, GCCallbackFlags flags) GCCallback
Definition: v8-isolate.h:1091
bool GetHeapObjectStatisticsAtLastGC(HeapObjectStatistics *object_statistics, size_t type_index)
static Isolate * Allocate(const IsolateGroup &group)
void SetIsJSApiWrapperNativeErrorCallback(IsJSApiWrapperNativeErrorCallback callback)
void(*)(Isolate *isolate, UseCounterFeature feature) UseCounterCallback
Definition: v8-isolate.h:668
void(*)(Isolate *isolate, GCType type, GCCallbackFlags flags, void *data) GCCallbackWithData
Definition: v8-isolate.h:1093
void SetHostCreateShadowRealmContextCallback(HostCreateShadowRealmContextCallback callback)
bool IsCurrent() const
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 GetStackSample(const RegisterState &state, void **frames, size_t frames_limit, SampleInfo *sample_info)
void SetEmbedderRootsHandler(EmbedderRootsHandler *handler)
uint64_t GetHashSeed()
void AddGCEpilogueCallback(GCCallbackWithData callback, void *data=nullptr, GCType gc_type_filter=kGCTypeAll)
Isolate & operator=(const Isolate &)=delete
std::string GetDefaultLocale()
AtomicsWaitEvent
Definition: v8-isolate.h:1213
void SetPrepareStackTraceCallback(PrepareStackTraceCallback callback)
Priority
Definition: v8-isolate.h:653
Isolate(const Isolate &)=delete
void(*)(AtomicsWaitEvent event, Local< SharedArrayBuffer > array_buffer, size_t offset_in_bytes, int64_t value, double timeout_in_ms, AtomicsWaitWakeHandle *stop_handle, void *data) AtomicsWaitCallback
Definition: v8-isolate.h:1289
void AddGCEpilogueCallback(GCCallback callback, GCType gc_type_filter=kGCTypeAll)
void DiscardThreadSpecificMetadata()
static Isolate * TryGetCurrent()
Local< Value > ThrowException(Local< Value > exception)
static Isolate * Allocate()
MessageErrorLevel
Definition: v8-isolate.h:642
bool(*)(Isolate *) AbortOnUncaughtExceptionCallback
Definition: v8-isolate.h:754
void SetHostInitializeImportMetaObjectCallback(HostInitializeImportMetaObjectCallback callback)
Local< Value > GetContinuationPreservedEmbedderData()
size_t NumberOfHeapSpaces()
void GetHeapStatistics(HeapStatistics *heap_statistics)
void SetContinuationPreservedEmbedderData(Local< Value > data)
void MemoryPressureNotification(MemoryPressureLevel level)
IsolateGroup GetGroup() const
void Enter()
UseCounterFeature
Definition: v8-isolate.h:468
~Isolate()=delete
void RemoveGCPrologueCallback(GCCallbackWithData, void *data=nullptr)
void SetAbortOnUncaughtExceptionCallback(AbortOnUncaughtExceptionCallback callback)
void ClearCachesForTesting()
void SetHostImportModuleWithPhaseDynamicallyCallback(HostImportModuleWithPhaseDynamicallyCallback callback)
Definition: v8-local-handle.h:266
Definition: v8-local-handle.h:632
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-script.h:402
Definition: v8-array-buffer.h:499
Definition: v8-debug.h:117
Definition: v8-snapshot.h:21
Definition: v8-value.h:32
Definition: v8-internal.h:830
internal::Address * InternalRepresentationType
Definition: v8-internal.h:1630
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:230
bool(*)(Local< Context > context) SharedArrayBufferConstructorEnabledCallback
Definition: v8-callbacks.h:326
void(*)(void *data) MicrotaskCallback
Definition: v8-microtask.h:14
GCCallbackFlags
Definition: v8-callbacks.h:179
bool(*)(Local< Context > context) WasmJSPIEnabledCallback
Definition: v8-callbacks.h:333
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:315
bool(*)(const FunctionCallbackInfo< Value > &) ExtensionCallback
Definition: v8-callbacks.h:298
void(*)(PromiseHookType type, Local< Promise > promise, Local< Value > parent) PromiseHook
Definition: v8-promise.h:144
void(*)(Isolate *, void *) MicrotasksCompletedCallbackWithData
Definition: v8-microtask.h:13
bool(*)(Local< Context > context) JavaScriptCompileHintsMagicEnabledCallback
Definition: v8-callbacks.h:330
ContextDependants
Definition: v8-isolate.h:181
void(*)(ExceptionPropagationMessage message) ExceptionPropagationCallback
Definition: v8-exception.h:133
void(*)(const FunctionCallbackInfo< Value > &) WasmStreamingCallback
Definition: v8-callbacks.h:308
void *(*)(const char *name, int min, int max, size_t buckets) CreateHistogramCallback
Definition: v8-callbacks.h:216
void(*)(Local< Context > context, Local< Module > module, Local< Object > meta) HostInitializeImportMetaObjectCallback
Definition: v8-callbacks.h:434
void(*)(Local< Message > message, Local< Value > data) MessageCallback
Definition: v8-callbacks.h:232
void(*)(CrashKeyId id, const std::string &value) AddCrashKeyCallback
Definition: v8-callbacks.h:253
void(*)(Isolate *isolate, void *data) InterruptCallback
Definition: v8-callbacks.h:191
void(*)(Isolate *) CallCompletedCallback
Definition: v8-callbacks.h:257
void(*)(void *histogram, int sample) AddHistogramSampleCallback
Definition: v8-callbacks.h:218
size_t(*)(void *data, size_t current_heap_limit, size_t initial_heap_limit) NearHeapLimitCallback
Definition: v8-callbacks.h:201
void(*)(Isolate *) BeforeCallEnteredCallback
Definition: v8-callbacks.h:256
bool(*)(Local< Context > context, Local< String > source) AllowWasmCodeGenerationCallback
Definition: v8-callbacks.h:301
void(*)(const char *location, const char *message) FatalErrorCallback
Definition: v8-callbacks.h:222
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:279
void(*)(Local< Object > target, AccessType type, Local< Value > data) FailedAccessCheckCallback
Definition: v8-callbacks.h:295
bool(*)(Local< Context > context) WasmImportedStringsEnabledCallback
Definition: v8-callbacks.h:322
void(*)(const char *name, int status) LogEventCallback
Definition: v8-callbacks.h:238
MemoryPressureLevel
Definition: v8-isolate.h:175
MeasureMemoryExecution
Definition: v8-statistics.h:43
int *(*)(const char *name) CounterLookupCallback
Definition: v8-callbacks.h:213
bool(*)(Isolate *isolate, Local< Object > obj) IsJSApiWrapperNativeErrorCallback
Definition: v8-callbacks.h:456
Definition: v8-isolate.h:279
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:803
#define V8_INLINE
Definition: v8config.h:499
#define V8_DEPRECATE_SOON(message)
Definition: v8config.h:613
#define V8_DEPRECATED(message)
Definition: v8config.h:605
#define END_ALLOW_USE_DEPRECATED()
Definition: v8config.h:633
#define ALLOW_COPY_AND_MOVE_WITH_DEPRECATED_FIELDS(ClassName)
Definition: v8config.h:636
#define START_ALLOW_USE_DEPRECATED()
Definition: v8config.h:632
#define V8_NODISCARD
Definition: v8config.h:692