#include <v8-isolate.h>
Classes | |
| class | AllowJavascriptExecutionScope |
| class | AtomicsWaitWakeHandle |
| struct | CreateParams |
| class | DisallowJavascriptExecutionScope |
| class | Scope |
| class | SuppressMicrotaskExecutionScope |
Static Public Member Functions | |
| static Isolate * | Allocate () |
| static Isolate * | Allocate (const IsolateGroup &group) |
| static void | Initialize (Isolate *isolate, const CreateParams ¶ms) |
| static Isolate * | New (const CreateParams ¶ms) |
| static Isolate * | New (const IsolateGroup &group, const CreateParams ¶ms) |
| static Isolate * | GetCurrent () |
| static Isolate * | TryGetCurrent () |
| static uint32_t | GetNumberOfDataSlots () |
Static Public Attributes | |
| static constexpr size_t | kMinCodePagesBufferSize = 32 |
Friends | |
| template<class K , class V , class Traits > | |
| class | PersistentValueMapBase |
| class | ExternalMemoryAccounter |
Isolate represents an isolated instance of the V8 engine. V8 isolates have completely separate states. Objects from one isolate must not be used in other isolates. The embedder can create multiple isolates and use them in parallel in multiple threads. An isolate can be entered by at most one thread at any given time. The Locker/Unlocker API must be used to synchronize.
| using v8::Isolate::AbortOnUncaughtExceptionCallback = bool (*)(Isolate*) |
Custom callback used by embedders to help V8 determine if it should abort when it throws and no internal handler is predicted to catch the exception. If –abort-on-uncaught-exception is used on the command line, then V8 will abort if either:
| using v8::Isolate::AtomicsWaitCallback = void (*)(AtomicsWaitEvent event, Local<SharedArrayBuffer> array_buffer, size_t offset_in_bytes, int64_t value, double timeout_in_ms, AtomicsWaitWakeHandle* stop_handle, void* data) |
Embedder callback for Atomics.wait() that can be added through |SetAtomicsWaitCallback|.
This will be called just before starting to wait with the |event| value |kStartWait| and after finishing waiting with one of the other values of |AtomicsWaitEvent| inside of an Atomics.wait() call.
|array_buffer| will refer to the underlying SharedArrayBuffer, |offset_in_bytes| to the location of the waited-on memory address inside the SharedArrayBuffer.
|value| and |timeout_in_ms| will be the values passed to the Atomics.wait() call. If no timeout was used, |timeout_in_ms| will be INFINITY.
In the |kStartWait| callback, |stop_handle| will be an object that is only valid until the corresponding finishing callback and that can be used to stop the wait process while it is happening.
This callback may schedule exceptions, unless |event| is equal to |kTerminatedExecution|.
| using v8::Isolate::GCCallback = void (*)(Isolate* isolate, GCType type, GCCallbackFlags flags) |
| using v8::Isolate::GCCallbackWithData = void (*)(Isolate* isolate, GCType type, GCCallbackFlags flags, void* data) |
| using v8::Isolate::GetExternallyAllocatedMemoryInBytesCallback = size_t (*)() |
| using v8::Isolate::UseCounterCallback = void (*)(Isolate* isolate, UseCounterFeature feature) |
|
strong |
Use for |AtomicsWaitCallback| to indicate the type of event it receives.
|
strong |
|
strong |
Time zone redetection indicator for DateTimeConfigurationChangeNotification.
kSkip indicates V8 that the notification should not trigger redetecting host time zone. kRedetect indicates V8 that host time zone should be redetected, and used to set the default time zone.
The host time zone detection may require file system access or similar operations unlikely to be available inside a sandbox. If v8 is run inside a sandbox, the host time zone has to be detected outside the sandbox before calling DateTimeConfigurationChangeNotification function.
| Enumerator | |
|---|---|
| kSkip | |
| kRedetect | |
Features reported via the SetUseCounterCallback callback. Do not change assigned numbers of existing items; add new features to the end of this list. Dead features can be marked V8_DEPRECATE_SOON, then V8_DEPRECATED, and then finally be renamed to kOBSOLETE_... to stop embedders from using them.
|
delete |
|
delete |
|
delete |
| void v8::Isolate::AddBeforeCallEnteredCallback | ( | BeforeCallEnteredCallback | callback | ) |
Adds a callback to notify the host application right before a script is about to run. If a script re-enters the runtime during executing, the BeforeCallEnteredCallback is invoked for each re-entrance. Executing scripts inside the callback will re-trigger the callback.
| void v8::Isolate::AddCallCompletedCallback | ( | CallCompletedCallback | callback | ) |
Adds a callback to notify the host application when a script finished running. If a script re-enters the runtime during executing, the CallCompletedCallback is only invoked when the outer-most script execution ends. Executing scripts inside the callback do not trigger further callbacks.
| void v8::Isolate::AddGCEpilogueCallback | ( | GCCallback | callback, |
| GCType | gc_type_filter = kGCTypeAll |
||
| ) |
Enables the host application to receive a notification after a garbage collection.
Enables the host application to receive a notification before a garbage collection.
| callback | The callback to be invoked. The callback is allowed to allocate but invocation is not re-entrant: a callback triggering garbage collection will not be called again. JS execution is prohibited from these callbacks. A single callback may only be registered once. |
| gc_type_filter | A filter in case it should be applied. |
| void v8::Isolate::AddGCEpilogueCallback | ( | GCCallbackWithData | callback, |
| void * | data = nullptr, |
||
| GCType | gc_type_filter = kGCTypeAll |
||
| ) |
Enables the host application to receive a notification after a garbage collection.
Enables the host application to receive a notification before a garbage collection.
| callback | The callback to be invoked. The callback is allowed to allocate but invocation is not re-entrant: a callback triggering garbage collection will not be called again. JS execution is prohibited from these callbacks. A single callback may only be registered once. |
| gc_type_filter | A filter in case it should be applied. |
| data | Additional data that should be passed to the callback. |
| void v8::Isolate::AddGCPrologueCallback | ( | GCCallback | callback, |
| GCType | gc_type_filter = kGCTypeAll |
||
| ) |
Enables the host application to receive a notification before a garbage collection.
| callback | The callback to be invoked. The callback is allowed to allocate but invocation is not re-entrant: a callback triggering garbage collection will not be called again. JS execution is prohibited from these callbacks. A single callback may only be registered once. |
| gc_type_filter | A filter in case it should be applied. |
| void v8::Isolate::AddGCPrologueCallback | ( | GCCallbackWithData | callback, |
| void * | data = nullptr, |
||
| GCType | gc_type_filter = kGCTypeAll |
||
| ) |
Enables the host application to receive a notification before a garbage collection.
| callback | The callback to be invoked. The callback is allowed to allocate but invocation is not re-entrant: a callback triggering garbage collection will not be called again. JS execution is prohibited from these callbacks. A single callback may only be registered once. |
| gc_type_filter | A filter in case it should be applied. |
| data | Additional data that should be passed to the callback. |
| bool v8::Isolate::AddMessageListener | ( | MessageCallback | that, |
| Local< Value > | data = Local< Value >() |
||
| ) |
Adds a message listener (errors only).
The same message listener can be added more than once and in that case it will be called more than once for each message.
If data is specified, it will be passed to the callback when it is called. Otherwise, the exception object will be passed to the callback instead.
| bool v8::Isolate::AddMessageListenerWithErrorLevel | ( | MessageCallback | that, |
| int | message_levels, | ||
| Local< Value > | data = Local< Value >() |
||
| ) |
Adds a message listener.
The same message listener can be added more than once and in that case it will be called more than once for each message.
If data is specified, it will be passed to the callback when it is called. Otherwise, the exception object will be passed to the callback instead.
A listener can listen for particular error levels by providing a mask.
| void v8::Isolate::AddMicrotasksCompletedCallback | ( | MicrotasksCompletedCallbackWithData | callback, |
| void * | data = nullptr |
||
| ) |
Adds a callback to notify the host application after microtasks were run on the default MicrotaskQueue. The callback is triggered by explicit RunMicrotasks call or automatic microtasks execution (see SetMicrotaskPolicy).
Callback will trigger even if microtasks were attempted to run, but the microtasks queue was empty and no single microtask was actually executed.
Executing scripts inside the callback will not re-trigger microtasks and the callback.
| void v8::Isolate::AddNearHeapLimitCallback | ( | NearHeapLimitCallback | callback, |
| void * | data | ||
| ) |
Add a callback to invoke in case the heap size is close to the heap limit. If multiple callbacks are added, only the most recently added callback is invoked.
| int64_t v8::Isolate::AdjustAmountOfExternalAllocatedMemory | ( | int64_t | change_in_bytes | ) |
Adjusts the amount of registered external memory.
| change_in_bytes | the change in externally allocated memory that is kept alive by JavaScript objects. |
|
static |
Allocates a new isolate but does not initialize it. Does not change the currently entered isolate.
Only Isolate::GetData() and Isolate::SetData(), which access the embedder-controlled parts of the isolate, as well as Isolate::GetGroup(), are allowed to be called on the uninitialized isolate. To initialize the isolate, call Isolate::Initialize() or initialize a SnapshotCreator.
When an isolate is no longer used its resources should be freed by calling Dispose(). Using the delete operator is not allowed.
V8::Initialize() must have run prior to this.
|
static |
| void v8::Isolate::AttachCppHeap | ( | CppHeap * | ) |
Attaches a managed C++ heap as an extension to the JavaScript heap. The embedder maintains ownership of the CppHeap. At most one C++ heap can be attached to V8.
Multi-threaded use requires the use of v8::Locker/v8::Unlocker, see CppHeap.
If a CppHeap is set via CreateParams, then this call is a noop.
| void v8::Isolate::AutomaticallyRestoreInitialHeapLimit | ( | double | threshold_percent = 0.5 | ) |
If the heap limit was changed by the NearHeapLimitCallback, then the initial heap limit will be restored once the heap size falls below the given threshold percentage of the initial heap limit. The threshold percentage is a number in (0.0, 1.0) range.
| void v8::Isolate::CancelTerminateExecution | ( | ) |
Resume execution capability in the given isolate, whose execution was previously forcefully terminated using TerminateExecution().
When execution is forcefully terminated using TerminateExecution(), the isolate can not resume execution until all JavaScript frames have propagated the uncatchable exception which is generated. This method allows the program embedding the engine to handle the termination event and resume execution capability, even if JavaScript frames remain on the stack.
This method can be used by any thread even if that thread has not acquired the V8 lock with a Locker object.
| void v8::Isolate::ClearCachesForTesting | ( | ) |
Drop non-essential caches. Should only be called from testing code. The method can potentially block for a long time and does not necessarily trigger GC.
| void v8::Isolate::ClearKeptObjects | ( | ) |
Clears the set of objects held strongly by the heap. This set of objects are originally built when a WeakRef is created or successfully dereferenced.
This is invoked automatically after microtasks are run. See MicrotasksPolicy for when microtasks are run.
This needs to be manually invoked only if the embedder is manually running microtasks via a custom MicrotaskQueue class's PerformCheckpoint. In that case, it is the embedder's responsibility to make this call at a time which does not interrupt synchronous ECMAScript code execution.
| int v8::Isolate::ContextDisposedNotification | ( | bool | dependant_context = true | ) |
Optional notification that a context has been disposed. V8 uses these notifications to guide the GC heuristic and cancel FinalizationRegistry cleanup tasks. Returns the number of context disposals - including this one
The optional parameter |dependant_context| specifies whether the disposed context was depending on state from other contexts or not.
| size_t v8::Isolate::CopyCodePages | ( | size_t | capacity, |
| MemoryRange * | code_pages_out | ||
| ) |
Copies the code heap pages currently in use by V8 into |code_pages_out|. |code_pages_out| must have at least kMinCodePagesBufferSize capacity and must be empty.
Signal-safe, does not allocate, does not access the V8 heap. No code on the stack can rely on pages that might be missing.
Returns the number of pages available to be copied, which might be greater than |capacity|. In this case, only |capacity| pages will be copied into |code_pages_out|. The caller should provide a bigger buffer on the next call in order to get all available code pages, but this is not required.
| void v8::Isolate::DateTimeConfigurationChangeNotification | ( | TimeZoneDetection | time_zone_detection = TimeZoneDetection::kSkip | ) |
Notification that the embedder has changed the time zone, daylight savings time or other date / time configuration parameters. V8 keeps a cache of various values used for date / time computation. This notification will reset those cached values for the current context so that date / time configuration changes would be reflected.
This API should not be called more than needed as it will negatively impact the performance of date operations.
| void v8::Isolate::DetachCppHeap | ( | ) |
Detaches a managed C++ heap if one was attached using AttachCppHeap().
If a CppHeap is set via CreateParams, then this call is a noop.
| void v8::Isolate::DiscardThreadSpecificMetadata | ( | ) |
| void v8::Isolate::Dispose | ( | ) |
Disposes the isolate. The isolate must not be entered by any thread to be disposable.
| void v8::Isolate::DumpAndResetStats | ( | ) |
Dumps activated low-level V8 internal stats. This can be used instead of performing a full isolate disposal.
Enqueues the callback to the default MicrotaskQueue
| void v8::Isolate::EnqueueMicrotask | ( | MicrotaskCallback | callback, |
| void * | data = nullptr |
||
| ) |
Enqueues the callback to the default MicrotaskQueue
| void v8::Isolate::Enter | ( | ) |
Methods below this point require holding a lock (using Locker) in a multi-threaded environment. Sets this isolate as the entered one for the current thread. Saves the previously entered one (if any), so that it can be restored when exiting. Re-entering an isolate is allowed.
| void v8::Isolate::Exit | ( | ) |
Exits this isolate by restoring the previously entered one in the current thread. The isolate may still stay the same, if it was entered more than once.
Requires: this == Isolate::GetCurrent().
| ArrayBuffer::Allocator * v8::Isolate::GetArrayBufferAllocator | ( | ) |
Returns the ArrayBuffer::Allocator used in this isolate.
| void v8::Isolate::GetCodeRange | ( | void ** | start, |
| size_t * | length_in_bytes | ||
| ) |
Returns a memory range that can potentially contain jitted code. Code for V8's 'builtins' will not be in this range if embedded builtins is enabled.
On Win64, embedders are advised to install function table callbacks for these ranges, as default SEH won't be able to unwind through jitted code. The first page of the code range is reserved for the embedder and is committed, writable, and executable, to be used to store unwind data, as documented in https://docs.microsoft.com/en-us/cpp/build/exception-handling-x64.
Might be empty on other platforms.
Returns the value that was set or restored by SetContinuationPreservedEmbedderData(), if any.
| CppHeap * v8::Isolate::GetCppHeap | ( | ) | const |
AttachCppHeap().
|
static |
Returns the entered isolate for the current thread or NULL in case there is no current isolate.
This method must not be invoked before V8::Initialize() was invoked.
Returns the context of the currently running JavaScript, or the context on the top of the stack if no JavaScript is running.
| MaybeLocal< Data > v8::Isolate::GetCurrentHostDefinedOptions | ( | ) |
Returns the host defined options set for currently running script or module, if available.
|
inline |
Retrieve embedder-specific data from the isolate. Returns NULL if SetData has never been called for the given |slot|.
|
inline |
Return data that was previously attached to the isolate snapshot via SnapshotCreator, and removes the reference to it. Repeated call with the same index returns an empty MaybeLocal.
| std::string v8::Isolate::GetDefaultLocale | ( | ) |
Returns the default locale in a string if Intl support is enabled. Otherwise returns an empty string.
| void v8::Isolate::GetEmbeddedCodeRange | ( | const void ** | start, |
| size_t * | length_in_bytes | ||
| ) |
As GetCodeRange, but for embedded builtins (these live in a distinct memory region from other V8 Code objects).
Returns either the last context entered through V8's C++ API, or the context of the currently running microtask while processing microtasks. If a context is entered while executing a microtask, that context is returned.
| IsolateGroup v8::Isolate::GetGroup | ( | ) | const |
Return the group for this isolate.
| bool v8::Isolate::GetHeapCodeAndMetadataStatistics | ( | HeapCodeStatistics * | object_statistics | ) |
Get statistics about code and its metadata in the heap.
| object_statistics | The HeapCodeStatistics object to fill in statistics of code, bytecode and their metadata. |
| bool v8::Isolate::GetHeapObjectStatisticsAtLastGC | ( | HeapObjectStatistics * | object_statistics, |
| size_t | type_index | ||
| ) |
Get statistics about objects in the heap.
| object_statistics | The HeapObjectStatistics object to fill in statistics of objects of given type, which were live in the previous GC. |
| type_index | The index of the type of object to fill details about, which ranges from 0 to NumberOfTrackedHeapObjectTypes() - 1. |
| HeapProfiler * v8::Isolate::GetHeapProfiler | ( | ) |
Returns heap profiler for this isolate. Will return NULL until the isolate is initialized.
| bool v8::Isolate::GetHeapSpaceStatistics | ( | HeapSpaceStatistics * | space_statistics, |
| size_t | index | ||
| ) |
Get the memory usage of a space in the heap.
| space_statistics | The HeapSpaceStatistics object to fill in statistics. |
| index | The index of the space to get statistics from, which ranges from 0 to NumberOfHeapSpaces() - 1. |
| void v8::Isolate::GetHeapStatistics | ( | HeapStatistics * | heap_statistics | ) |
Get statistics about the heap memory usage.
Returns the Context that corresponds to the Incumbent realm in HTML spec. https://html.spec.whatwg.org/multipage/webappapis.html#incumbent
| JSEntryStubs v8::Isolate::GetJSEntryStubs | ( | ) |
Returns the JSEntryStubs necessary for use with the Unwinder API.
| MicrotasksPolicy v8::Isolate::GetMicrotasksPolicy | ( | ) | const |
Returns the policy controlling how Microtasks are invoked.
|
inlinestatic |
Returns the maximum number of available embedder data slots. Valid slots are in the range of 0 - GetNumberOfDataSlots() - 1.
| void v8::Isolate::GetStackSample | ( | const RegisterState & | state, |
| void ** | frames, | ||
| size_t | frames_limit, | ||
| SampleInfo * | sample_info | ||
| ) |
Get a call stack sample from the isolate.
| state | Execution state. |
| frames | Caller allocated buffer to store stack frames. |
| frames_limit | Maximum number of frames to capture. The buffer must be large enough to hold the number of frames. |
| sample_info | The sample info is filled up by the function provides number of actual captured stack frames and the current VM state. |
| int v8::Isolate::GetStackTraceLimit | ( | ) |
Get the stackTraceLimit property of Error.
| bool v8::Isolate::HasPendingBackgroundTasks | ( | ) |
Returns true if there is ongoing background work within V8 that will eventually post a foreground task, like asynchronous WebAssembly compilation.
| bool v8::Isolate::HasPendingException | ( | ) |
Returns true if an exception was thrown but not processed yet by an exception handler on JavaScript side or by v8::TryCatch handler.
This is an experimental feature and may still change significantly.
| bool v8::Isolate::InContext | ( | ) |
Returns true if this isolate has a current context.
| void v8::Isolate::IncreaseHeapLimitForDebugging | ( | ) |
Optional notification to tell V8 the current isolate is used for debugging and requires higher heap limit.
|
static |
Initialize an Isolate previously allocated by Isolate::Allocate().
| bool v8::Isolate::IsCurrent | ( | ) | const |
Return true if this isolate is currently active.
| bool v8::Isolate::IsDead | ( | ) |
Check if V8 is dead and therefore unusable. This is the case after fatal errors such as out-of-memory situations.
| bool v8::Isolate::IsExecutionTerminating | ( | ) |
Is V8 terminating JavaScript execution.
Returns true if JavaScript execution is currently terminating because of a call to TerminateExecution. In that case there are still JavaScript frames on the stack and the termination exception is still active.
| bool v8::Isolate::IsHeapLimitIncreasedForDebugging | ( | ) |
Returns true if the heap limit was increased for debugging and the original heap limit was not restored yet.
| bool v8::Isolate::IsInUse | ( | ) |
Check if this isolate is in use. True if at least one thread Enter'ed this isolate.
| void v8::Isolate::IsolateInBackgroundNotification | ( | ) |
Optional notification that the isolate switched to the background. V8 uses these notifications to guide heuristics.
| void v8::Isolate::IsolateInForegroundNotification | ( | ) |
Optional notification that the isolate switched to the foreground. V8 uses these notifications to guide heuristics.
| void v8::Isolate::LocaleConfigurationChangeNotification | ( | ) |
Notification that the embedder has changed the locale. V8 keeps a cache of various values used for locale computation. This notification will reset those cached values for the current context so that locale configuration changes would be reflected.
This API should not be called more than needed as it will negatively impact the performance of locale operations.
| void v8::Isolate::LowMemoryNotification | ( | ) |
Optional notification that the system is running low on memory. V8 uses these notifications to attempt to free memory.
| bool v8::Isolate::MeasureMemory | ( | std::unique_ptr< MeasureMemoryDelegate > | delegate, |
| MeasureMemoryExecution | execution = MeasureMemoryExecution::kDefault |
||
| ) |
This API is experimental and may change significantly.
Enqueues a memory measurement request and invokes the delegate with the results.
| delegate | the delegate that defines which contexts to measure and reports the results. |
| execution | promptness executing the memory measurement. The kEager value is expected to be used only in tests. |
| void v8::Isolate::MemoryPressureNotification | ( | MemoryPressureLevel | level | ) |
Optional notification that the system is running low on memory. V8 uses these notifications to guide heuristics. It is allowed to call this function from another thread while the isolate is executing long running JavaScript code.
|
static |
Creates a new isolate. Does not change the currently entered isolate.
When an isolate is no longer used its resources should be freed by calling Dispose(). Using the delete operator is not allowed.
V8::Initialize() must have run prior to this.
|
static |
| size_t v8::Isolate::NumberOfHeapSpaces | ( | ) |
Returns the number of spaces in the heap.
| size_t v8::Isolate::NumberOfTrackedHeapObjectTypes | ( | ) |
Returns the number of types of objects tracked in the heap at GC.
|
delete |
|
delete |
|
delete |
|
delete |
| void v8::Isolate::PerformMicrotaskCheckpoint | ( | ) |
Runs the default MicrotaskQueue until it gets empty and perform other microtask checkpoint steps, such as calling ClearKeptObjects. Asserts that the MicrotasksPolicy is not kScoped. Any exceptions thrown by microtask callbacks are swallowed.
| void v8::Isolate::RemoveBeforeCallEnteredCallback | ( | BeforeCallEnteredCallback | callback | ) |
Removes callback that was installed by AddBeforeCallEnteredCallback.
| void v8::Isolate::RemoveCallCompletedCallback | ( | CallCompletedCallback | callback | ) |
Removes callback that was installed by AddCallCompletedCallback.
| void v8::Isolate::RemoveGCEpilogueCallback | ( | GCCallback | callback | ) |
This function removes a callback which was added by AddGCEpilogueCallback.
| callback | the callback to remove. |
| void v8::Isolate::RemoveGCEpilogueCallback | ( | GCCallbackWithData | callback, |
| void * | data = nullptr |
||
| ) |
This function removes a callback which was added by AddGCEpilogueCallback.
| callback | the callback to remove. |
| data | Additional data that was used to install the callback. |
| void v8::Isolate::RemoveGCPrologueCallback | ( | GCCallback | callback | ) |
This function removes a callback which was added by AddGCPrologueCallback.
| callback | the callback to remove. |
| void v8::Isolate::RemoveGCPrologueCallback | ( | GCCallbackWithData | , |
| void * | data = nullptr |
||
| ) |
| data | Additional data that was used to install the callback. |
| void v8::Isolate::RemoveMessageListeners | ( | MessageCallback | that | ) |
Remove all message listeners from the specified callback function.
| void v8::Isolate::RemoveMicrotasksCompletedCallback | ( | MicrotasksCompletedCallbackWithData | callback, |
| void * | data = nullptr |
||
| ) |
Removes callback that was installed by AddMicrotasksCompletedCallback.
| void v8::Isolate::RemoveNearHeapLimitCallback | ( | NearHeapLimitCallback | callback, |
| size_t | heap_limit | ||
| ) |
Remove the given callback and restore the heap limit to the given limit. If the given limit is zero, then it is ignored. If the current heap size is greater than the given limit, then the heap limit is restored to the minimal limit that is possible for the current heap size.
| void v8::Isolate::RequestGarbageCollectionForTesting | ( | GarbageCollectionType | type | ) |
Request garbage collection in this Isolate. It is only valid to call this function if –expose_gc was specified.
This should only be used for testing purposes and not to enforce a garbage collection schedule. It has strong negative impact on the garbage collection performance. Use MemoryPressureNotification() instead to influence the garbage collection schedule.
| void v8::Isolate::RequestGarbageCollectionForTesting | ( | GarbageCollectionType | type, |
| StackState | stack_state | ||
| ) |
Request garbage collection with a specific embedderstack state in this Isolate. It is only valid to call this function if –expose_gc was specified.
This should only be used for testing purposes and not to enforce a garbage collection schedule. It has strong negative impact on the garbage collection performance. Use MemoryPressureNotification() instead to influence the garbage collection schedule.
| void v8::Isolate::RequestInterrupt | ( | InterruptCallback | callback, |
| void * | data | ||
| ) |
Request V8 to interrupt long running JavaScript code and invoke the given |callback| passing the given |data| to it. After |callback| returns control will be returned to the JavaScript code. There may be a number of interrupt requests in flight. Can be called from another thread without acquiring a |Locker|. Registered |callback| must not reenter interrupted Isolate.
| void v8::Isolate::RestoreOriginalHeapLimit | ( | ) |
Restores the original heap limit after IncreaseHeapLimitForDebugging().
| void v8::Isolate::SetAbortOnUncaughtExceptionCallback | ( | AbortOnUncaughtExceptionCallback | callback | ) |
| void v8::Isolate::SetAddCrashKeyCallback | ( | AddCrashKeyCallback | ) |
Enables the host application to provide a mechanism for recording a predefined set of data as crash keys to be used in postmortem debugging in case of a crash.
| void v8::Isolate::SetAddHistogramSampleFunction | ( | AddHistogramSampleCallback | ) |
| void v8::Isolate::SetAllowAtomicsWait | ( | bool | allow | ) |
Set whether calling Atomics.wait (a function that may block) is allowed in this isolate. This can also be configured via CreateParams::allow_atomics_wait.
| void v8::Isolate::SetAllowWasmCodeGenerationCallback | ( | AllowWasmCodeGenerationCallback | callback | ) |
Set the callback to invoke to check if wasm code generation should be allowed.
| void v8::Isolate::SetAtomicsWaitCallback | ( | AtomicsWaitCallback | callback, |
| void * | data | ||
| ) |
Set a new |AtomicsWaitCallback|. This overrides an earlier |AtomicsWaitCallback|, if there was any. If |callback| is nullptr, this unsets the callback. |data| will be passed to the callback as its last parameter.
| void v8::Isolate::SetBatterySaverMode | ( | bool | battery_saver_mode_enabled | ) |
| void v8::Isolate::SetCaptureStackTraceForUncaughtExceptions | ( | bool | capture, |
| int | frame_limit = 10, |
||
| StackTrace::StackTraceOptions | options = StackTrace::kOverview |
||
| ) |
Tells V8 to capture current stack trace when uncaught exception occurs and report it to the message listeners. The option is off by default.
Sets a value that will be stored on continuations and reset while the continuation runs.
| void v8::Isolate::SetCounterFunction | ( | CounterLookupCallback | ) |
Enables the host application to provide a mechanism for recording statistics counters.
| void v8::Isolate::SetCreateHistogramFunction | ( | CreateHistogramCallback | ) |
Enables the host application to provide a mechanism for recording histograms. The CreateHistogram function returns a histogram which will later be passed to the AddHistogramSample function.
|
inline |
Associate embedder-specific data with the isolate. |slot| has to be between 0 and GetNumberOfDataSlots() - 1.
| void v8::Isolate::SetEmbedderRootsHandler | ( | EmbedderRootsHandler * | handler | ) |
Sets an embedder roots handle that V8 should consider when performing non-unified heap garbage collections. The intended use case is for setting a custom handler after invoking AttachCppHeap().
V8 does not take ownership of the handler.
| void v8::Isolate::SetEventLogger | ( | LogEventCallback | that | ) |
Set the callback to invoke for logging event.
| void v8::Isolate::SetExceptionPropagationCallback | ( | ExceptionPropagationCallback | callback | ) |
This is a part of experimental Api and might be changed without further notice. Do not use it.
Set callback to notify about a new exception being thrown.
| void v8::Isolate::SetFailedAccessCheckCallbackFunction | ( | FailedAccessCheckCallback | ) |
Callback function for reporting failed access checks.
| void v8::Isolate::SetFatalErrorHandler | ( | FatalErrorCallback | that | ) |
Set the callback to invoke in case of fatal errors.
| void v8::Isolate::SetGetExternallyAllocatedMemoryInBytesCallback | ( | GetExternallyAllocatedMemoryInBytesCallback | callback | ) |
| void v8::Isolate::SetHostCreateShadowRealmContextCallback | ( | HostCreateShadowRealmContextCallback | callback | ) |
This specifies the callback called by the upcoming ShadowRealm construction language feature to retrieve host created globals.
| void v8::Isolate::SetHostImportModuleDynamicallyCallback | ( | HostImportModuleDynamicallyCallback | callback | ) |
This specifies the callback called by the upcoming dynamic import() language feature to load modules.
| void v8::Isolate::SetHostImportModuleWithPhaseDynamicallyCallback | ( | HostImportModuleWithPhaseDynamicallyCallback | callback | ) |
This specifies the callback called by the upcoming dynamic import() and import.source() language feature to load modules.
This API is experimental and is expected to be changed or removed in the future. The callback is currently only called when for source-phase imports. Evaluation-phase imports use the existing HostImportModuleDynamicallyCallback callback.
| void v8::Isolate::SetHostInitializeImportMetaObjectCallback | ( | HostInitializeImportMetaObjectCallback | callback | ) |
This specifies the callback called by the upcoming import.meta language feature to retrieve host-defined meta data for a module.
| void v8::Isolate::SetIdle | ( | bool | is_idle | ) |
Tells the VM whether the embedder is idle or not.
| void v8::Isolate::SetIsJSApiWrapperNativeErrorCallback | ( | IsJSApiWrapperNativeErrorCallback | callback | ) |
Set the callback that checks whether a Error.isError should return true for a JSApiWrapper object, i.e. whether it represents a native JS error. For example, in an HTML embedder, DOMExceptions are considered native errors.
| void v8::Isolate::SetIsLoading | ( | bool | is_loading | ) |
Optional notification to tell V8 whether the embedder is currently loading resources. If the embedder uses this notification, it should call SetIsLoading(true) when loading starts and SetIsLoading(false) when it ends. It's valid to call SetIsLoading(true) again while loading, which will update the timestamp when V8 considers the load started. Calling SetIsLoading(false) while not loading does nothing. V8 uses these notifications to guide heuristics. This is an unfinished experimental feature. Semantics and implementation may change frequently.
| void v8::Isolate::SetJavaScriptCompileHintsMagicEnabledCallback | ( | JavaScriptCompileHintsMagicEnabledCallback | callback | ) |
Register callback to control whether compile hints magic comments are enabled.
| void v8::Isolate::SetJitCodeEventHandler | ( | JitCodeEventOptions | options, |
| JitCodeEventHandler | event_handler | ||
| ) |
Allows the host application to provide the address of a function that is notified each time code is added, moved or removed.
| options | options for the JIT code event handler. |
| event_handler | the JIT code event handler, which will be invoked each time code is added, moved or removed. |
event_handler won't get notified of existent code. event_handler may get notifications of code that overlaps earlier code notifications. This happens when code areas are reused, and the earlier overlapping code areas should therefore be discarded. event_handler and the strings they point to are not guaranteed to live past each call. The event_handler must copy strings and other parameters it needs to keep around. event_handler function must ignore event codes it does not recognize to maintain future compatibility. | void v8::Isolate::SetMetricsRecorder | ( | const std::shared_ptr< metrics::Recorder > & | metrics_recorder | ) |
Enables the host application to provide a mechanism for recording event based metrics. In order to use this interface include/v8-metrics.h needs to be included and the recorder needs to be derived from the Recorder base class defined there. This method can only be called once per isolate and must happen during isolate initialization before background threads are spawned.
| void v8::Isolate::SetMicrotasksPolicy | ( | MicrotasksPolicy | policy | ) |
Controls how Microtasks are invoked. See MicrotasksPolicy for details.
| void v8::Isolate::SetModifyCodeGenerationFromStringsCallback | ( | ModifyCodeGenerationFromStringsCallback2 | callback | ) |
Set the callback to invoke to check if code generation from strings should be allowed.
| void v8::Isolate::SetOOMErrorHandler | ( | OOMErrorCallback | that | ) |
Set the callback to invoke in case of OOM errors.
| void v8::Isolate::SetPrepareStackTraceCallback | ( | PrepareStackTraceCallback | callback | ) |
This specifies the callback called when the stack property of Error is accessed.
| void v8::Isolate::SetPriority | ( | Priority | priority | ) |
Optional notification that the isolate changed priority. V8 uses the priority value to guide heuristics.
| void v8::Isolate::SetPromiseHook | ( | PromiseHook | hook | ) |
Set the PromiseHook callback for various promise lifecycle events.
| void v8::Isolate::SetPromiseRejectCallback | ( | PromiseRejectCallback | callback | ) |
Set callback to notify about promise reject with no handler, or revocation of such a previous notification once the handler is added.
| void v8::Isolate::SetSharedArrayBufferConstructorEnabledCallback | ( | SharedArrayBufferConstructorEnabledCallback | callback | ) |
| void v8::Isolate::SetStackLimit | ( | uintptr_t | stack_limit | ) |
Modifies the stack limit for this Isolate.
| stack_limit | An address beyond which the Vm's stack may not grow. |
| void v8::Isolate::SetUseCounterCallback | ( | UseCounterCallback | callback | ) |
Sets a callback for counting the number of times a feature of V8 is used.
| void v8::Isolate::SetWasmAsyncResolvePromiseCallback | ( | WasmAsyncResolvePromiseCallback | callback | ) |
| void v8::Isolate::SetWasmImportedStringsEnabledCallback | ( | WasmImportedStringsEnabledCallback | callback | ) |
| void v8::Isolate::SetWasmInstanceCallback | ( | ExtensionCallback | callback | ) |
| void v8::Isolate::SetWasmJSPIEnabledCallback | ( | WasmJSPIEnabledCallback | callback | ) |
| void v8::Isolate::SetWasmLoadSourceMapCallback | ( | WasmLoadSourceMapCallback | callback | ) |
| void v8::Isolate::SetWasmModuleCallback | ( | ExtensionCallback | callback | ) |
Embedder over{ride|load} injection points for wasm APIs. The expectation is that the embedder sets them at most once.
| void v8::Isolate::SetWasmStreamingCallback | ( | WasmStreamingCallback | callback | ) |
| void v8::Isolate::TerminateExecution | ( | ) |
Schedules a v8::Exception::Error with the given message. See ThrowException for more details. Templatized to provide compile-time errors in case of too long strings (see v8::String::NewFromUtf8Literal).
Schedules an exception to be thrown when returning to JavaScript. When an exception has been scheduled it is illegal to invoke any JavaScript operation; the caller must return immediately and only after the exception has been handled does it become legal to invoke JavaScript operations.
|
static |
Returns the entered isolate for the current thread or NULL in case there is no current isolate.
No checks are performed by this method.
|
friend |
|
friend |
|
staticconstexpr |