V8

Ajouté en: v4.0.0

Code source: lib/v8.js

The node:v8 module exposes APIs that are specific to the version of V8 built into the Node.js binary. It can be accessed using:

JScopy

M v8.cachedDataVersionTag()

Ajouté en: v8.0.0

• Returns: integer

Returns an integer representing a version tag derived from the V8 version, command-line flags, and detected CPU features. This is useful for determining whether a vm.Script cachedData buffer is compatible with this instance of V8.

JScopy

M v8.getHeapCodeStatistics()

Ajouté en: v12.8.0

• Returns: Object

Get statistics about code and its metadata in the heap, see V8 GetHeapCodeAndMetadataStatistics API. Returns an object with the following properties:

• code_and_metadata_size number
• bytecode_and_metadata_size number
• external_script_source_size number
• cpu_profiler_metadata_size number

JScopy

M v8.getHeapSnapshot([options])

• options Object

  • exposeInternals boolean If true, expose internals in the heap snapshot. Default: false.
  • exposeNumericValues boolean If true, expose numeric values in artificial fields. Default: false.

• Returns: stream.Readable A Readable containing the V8 heap snapshot.

Generates a snapshot of the current V8 heap and returns a Readable Stream that may be used to read the JSON serialized representation. This JSON stream format is intended to be used with tools such as Chrome DevTools. The JSON schema is undocumented and specific to the V8 engine. Therefore, the schema may change from one version of V8 to the next.

Creating a heap snapshot requires memory about twice the size of the heap at the time the snapshot is created. This results in the risk of OOM killers terminating the process.

Generating a snapshot is a synchronous operation which blocks the event loop for a duration depending on the heap size.

JScopy

M v8.getHeapSpaceStatistics()

• Returns: Object[]

Returns statistics about the V8 heap spaces, i.e. the segments which make up the V8 heap. Neither the ordering of heap spaces, nor the availability of a heap space can be guaranteed as the statistics are provided via the V8 GetHeapSpaceStatistics function and may change from one V8 version to the next.

The value returned is an array of objects containing the following properties:

• space_name string
• space_size number
• space_used_size number
• space_available_size number
• physical_space_size number

JSONcopy

M v8.getHeapStatistics()

• Returns: Object

Returns an object with the following properties:

• total_heap_size number
• total_heap_size_executable number
• total_physical_size number
• total_available_size number
• used_heap_size number
• heap_size_limit number
• malloced_memory number
• peak_malloced_memory number
• does_zap_garbage number
• number_of_native_contexts number
• number_of_detached_contexts number
• total_global_handles_size number
• used_global_handles_size number
• external_memory number

does_zap_garbage is a 0/1 boolean, which signifies whether the --zap_code_space option is enabled or not. This makes V8 overwrite heap garbage with a bit pattern. The RSS footprint (resident set size) gets bigger because it continuously touches all heap pages and that makes them less likely to get swapped out by the operating system.

number_of_native_contexts The value of native_context is the number of the top-level contexts currently active. Increase of this number over time indicates a memory leak.

number_of_detached_contexts The value of detached_context is the number of contexts that were detached and not yet garbage collected. This number being non-zero indicates a potential memory leak.

total_global_handles_size The value of total_global_handles_size is the total memory size of V8 global handles.

used_global_handles_size The value of used_global_handles_size is the used memory size of V8 global handles.

external_memory The value of external_memory is the memory size of array buffers and external strings.

JScopy

M v8.setFlagsFromString(flags)

Ajouté en: v1.0.0

• flags string

The v8.setFlagsFromString() method can be used to programmatically set V8 command-line flags. This method should be used with care. Changing settings after the VM has started may result in unpredictable behavior, including crashes and data loss; or it may simply do nothing.

The V8 options available for a version of Node.js may be determined by running node --v8-options.

Usage:

JScopy

M v8.stopCoverage()

Ajouté en: v15.1.0, v14.18.0, v12.22.0

The v8.stopCoverage() method allows the user to stop the coverage collection started by NODE_V8_COVERAGE, so that V8 can release the execution count records and optimize code. This can be used in conjunction with v8.takeCoverage() if the user wants to collect the coverage on demand.

M v8.takeCoverage()

Ajouté en: v15.1.0, v14.18.0, v12.22.0

The v8.takeCoverage() method allows the user to write the coverage started by NODE_V8_COVERAGE to disk on demand. This method can be invoked multiple times during the lifetime of the process. Each time the execution counter will be reset and a new coverage report will be written to the directory specified by NODE_V8_COVERAGE.

When the process is about to exit, one last coverage will still be written to disk unless v8.stopCoverage() is invoked before the process exits.

M v8.writeHeapSnapshot([filename[,options]])

• filename string The file path where the V8 heap snapshot is to be saved. If not specified, a file name with the pattern 'Heap-$yyyymmdd-$hhmmss-$pid-${thread_id}.heapsnapshot' will be generated, where pid will be the PID of the Node.js process, {thread_id} will be 0 when writeHeapSnapshot() is called from the main Node.js thread or the id of a worker thread.
• options Object
  • exposeInternals boolean If true, expose internals in the heap snapshot. Default: false.
  • exposeNumericValues boolean If true, expose numeric values in artificial fields. Default: false.
• Returns: string The filename where the snapshot was saved.

Generates a snapshot of the current V8 heap and writes it to a JSON file. This file is intended to be used with tools such as Chrome DevTools. The JSON schema is undocumented and specific to the V8 engine, and may change from one version of V8 to the next.

A heap snapshot is specific to a single V8 isolate. When using worker threads, a heap snapshot generated from the main thread will not contain any information about the workers, and vice versa.

Creating a heap snapshot requires memory about twice the size of the heap at the time the snapshot is created. This results in the risk of OOM killers terminating the process.

Generating a snapshot is a synchronous operation which blocks the event loop for a duration depending on the heap size.

JScopy

M v8.setHeapSnapshotNearHeapLimit(limit)

Ajouté en: v18.10.0, v16.18.0

• limit integer

The API is a no-op if --heapsnapshot-near-heap-limit is already set from the command line or the API is called more than once. limit must be a positive integer. See --heapsnapshot-near-heap-limit for more information.

Serialization API

The serialization API provides means of serializing JavaScript values in a way that is compatible with the HTML structured clone algorithm.

The format is backward-compatible (i.e. safe to store to disk). Equal JavaScript values may result in different serialized output.

M v8.serialize(value)

Ajouté en: v8.0.0

• value any
• Returns: Buffer

Uses a DefaultSerializer to serialize value into a buffer.

ERR_BUFFER_TOO_LARGE will be thrown when trying to serialize a huge object which requires buffer larger than buffer.constants.MAX_LENGTH.

M v8.deserialize(buffer)

Ajouté en: v8.0.0

• buffer Buffer | TypedArray | DataView A buffer returned by serialize().

Uses a DefaultDeserializer with default options to read a JS value from a buffer.

C v8.Serializer

Ajouté en: v8.0.0

M new Serializer()

Creates a new Serializer object.

M serializer.writeHeader()

Writes out a header, which includes the serialization format version.

M serializer.writeValue(value)

• value any

Serializes a JavaScript value and adds the serialized representation to the internal buffer.

This throws an error if value cannot be serialized.

M serializer.releaseBuffer()

• Returns: Buffer

Returns the stored internal buffer. This serializer should not be used once the buffer is released. Calling this method results in undefined behavior if a previous write has failed.

M serializer.transferArrayBuffer(id, arrayBuffer)

• id integer A 32-bit unsigned integer.
• arrayBuffer ArrayBuffer An ArrayBuffer instance.

Marks an ArrayBuffer as having its contents transferred out of band. Pass the corresponding ArrayBuffer in the deserializing context to deserializer.transferArrayBuffer().

M serializer.writeUint32(value)

• value integer

Write a raw 32-bit unsigned integer. For use inside of a custom serializer._writeHostObject().

M serializer.writeUint64(hi, lo)

• hi integer
• lo integer

Write a raw 64-bit unsigned integer, split into high and low 32-bit parts. For use inside of a custom serializer._writeHostObject().

M serializer.writeDouble(value)

• value number

Write a JS number value. For use inside of a custom serializer._writeHostObject().

M serializer.writeRawBytes(buffer)

• buffer Buffer | TypedArray | DataView

Write raw bytes into the serializer's internal buffer. The deserializer will require a way to compute the length of the buffer. For use inside of a custom serializer._writeHostObject().

M serializer._writeHostObject(object)

• object Object

This method is called to write some kind of host object, i.e. an object created by native C++ bindings. If it is not possible to serialize object, a suitable exception should be thrown.

This method is not present on the Serializer class itself but can be provided by subclasses.

M serializer._getDataCloneError(message)

• message string

This method is called to generate error objects that will be thrown when an object can not be cloned.

This method defaults to the Error constructor and can be overridden on subclasses.

M serializer._getSharedArrayBufferId(sharedArrayBuffer)

• sharedArrayBuffer SharedArrayBuffer

This method is called when the serializer is going to serialize a SharedArrayBuffer object. It must return an unsigned 32-bit integer ID for the object, using the same ID if this SharedArrayBuffer has already been serialized. When deserializing, this ID will be passed to deserializer.transferArrayBuffer().

If the object cannot be serialized, an exception should be thrown.

This method is not present on the Serializer class itself but can be provided by subclasses.

M serializer._setTreatArrayBufferViewsAsHostObjects(flag)

• flag boolean Default: false

Indicate whether to treat TypedArray and DataView objects as host objects, i.e. pass them to serializer._writeHostObject().

C v8.Deserializer

Ajouté en: v8.0.0

M new Deserializer(buffer)

• buffer Buffer | TypedArray | DataView A buffer returned by serializer.releaseBuffer().

Creates a new Deserializer object.

M deserializer.readHeader()

Reads and validates a header (including the format version). May, for example, reject an invalid or unsupported wire format. In that case, an Error is thrown.

M deserializer.readValue()

Deserializes a JavaScript value from the buffer and returns it.

M deserializer.transferArrayBuffer(id, arrayBuffer)

• id integer A 32-bit unsigned integer.
• arrayBuffer ArrayBuffer | SharedArrayBuffer An ArrayBuffer instance.

Marks an ArrayBuffer as having its contents transferred out of band. Pass the corresponding ArrayBuffer in the serializing context to serializer.transferArrayBuffer() (or return the id from serializer._getSharedArrayBufferId() in the case of SharedArrayBuffers).

M deserializer.getWireFormatVersion()

• Returns: integer

Reads the underlying wire format version. Likely mostly to be useful to legacy code reading old wire format versions. May not be called before .readHeader().

M deserializer.readUint32()

• Returns: integer

Read a raw 32-bit unsigned integer and return it. For use inside of a custom deserializer._readHostObject().

M deserializer.readUint64()

• Returns: integer[]

Read a raw 64-bit unsigned integer and return it as an array [hi, lo] with two 32-bit unsigned integer entries. For use inside of a custom deserializer._readHostObject().

M deserializer.readDouble()

• Returns: number

Read a JS number value. For use inside of a custom deserializer._readHostObject().

M deserializer.readRawBytes(length)

• length integer
• Returns: Buffer

Read raw bytes from the deserializer's internal buffer. The length parameter must correspond to the length of the buffer that was passed to serializer.writeRawBytes(). For use inside of a custom deserializer._readHostObject().

M deserializer._readHostObject()

This method is called to read some kind of host object, i.e. an object that is created by native C++ bindings. If it is not possible to deserialize the data, a suitable exception should be thrown.

This method is not present on the Deserializer class itself but can be provided by subclasses.

C v8.DefaultSerializer

Ajouté en: v8.0.0

A subclass of Serializer that serializes TypedArray (in particular Buffer) and DataView objects as host objects, and only stores the part of their underlying ArrayBuffers that they are referring to.

C v8.DefaultDeserializer

Ajouté en: v8.0.0

A subclass of Deserializer corresponding to the format written by DefaultSerializer.

Promise hooks

The promiseHooks interface can be used to track promise lifecycle events. To track all async activity, see async_hooks which internally uses this module to produce promise lifecycle events in addition to events for other async resources. For request context management, see AsyncLocalStorage.

MJScopy

M promiseHooks.onInit(init)

Ajouté en: v17.1.0, v16.14.0

• init Function The init callback to call when a promise is created.
• Returns: Function Call to stop the hook.

The init hook must be a plain function. Providing an async function will throw as it would produce an infinite microtask loop.

MJScopy

CJScopy

M promiseHooks.onSettled(settled)

Ajouté en: v17.1.0, v16.14.0

• settled Function The settled callback to call when a promise is resolved or rejected.
• Returns: Function Call to stop the hook.

The settled hook must be a plain function. Providing an async function will throw as it would produce an infinite microtask loop.

MJScopy

CJScopy

M promiseHooks.onBefore(before)

Ajouté en: v17.1.0, v16.14.0

• before Function The before callback to call before a promise continuation executes.
• Returns: Function Call to stop the hook.

The before hook must be a plain function. Providing an async function will throw as it would produce an infinite microtask loop.

MJScopy

CJScopy

M promiseHooks.onAfter(after)

Ajouté en: v17.1.0, v16.14.0

• after Function The after callback to call after a promise continuation executes.
• Returns: Function Call to stop the hook.

The after hook must be a plain function. Providing an async function will throw as it would produce an infinite microtask loop.

MJScopy

CJScopy

M promiseHooks.createHook(callbacks)

Ajouté en: v17.1.0, v16.14.0

• callbacks Object The Hook Callbacks to register
  • init Function The init callback.
  • before Function The before callback.
  • after Function The after callback.
  • settled Function The settled callback.
• Returns: Function Used for disabling hooks

The hook callbacks must be plain functions. Providing async functions will throw as it would produce an infinite microtask loop.

Registers functions to be called for different lifetime events of each promise.

The callbacks init()/before()/after()/settled() are called for the respective events during a promise's lifetime.

All callbacks are optional. For example, if only promise creation needs to be tracked, then only the init callback needs to be passed. The specifics of all functions that can be passed to callbacks is in the Hook Callbacks section.

MJScopy

CJScopy

Hook callbacks

Key events in the lifetime of a promise have been categorized into four areas: creation of a promise, before/after a continuation handler is called or around an await, and when the promise resolves or rejects.

While these hooks are similar to those of async_hooks they lack a destroy hook. Other types of async resources typically represent sockets or file descriptors which have a distinct "closed" state to express the destroy lifecycle event while promises remain usable for as long as code can still reach them. Garbage collection tracking is used to make promises fit into the async_hooks event model, however this tracking is very expensive and they may not necessarily ever even be garbage collected.

Because promises are asynchronous resources whose lifecycle is tracked via the promise hooks mechanism, the init(), before(), after(), and settled() callbacks must not be async functions as they create more promises which would produce an infinite loop.

While this API is used to feed promise events into async_hooks, the ordering between the two is undefined. Both APIs are multi-tenant and therefore could produce events in any order relative to each other.

M init(promise, parent)

• promise Promise The promise being created.
• parent Promise The promise continued from, if applicable.

Called when a promise is constructed. This does not mean that corresponding before/after events will occur, only that the possibility exists. This will happen if a promise is created without ever getting a continuation.

M before(promise)

• promise Promise

Called before a promise continuation executes. This can be in the form of then(), catch(), or finally() handlers or an await resuming.

The before callback will be called 0 to N times. The before callback will typically be called 0 times if no continuation was ever made for the promise. The before callback may be called many times in the case where many continuations have been made from the same promise.

M after(promise)

• promise Promise

Called immediately after a promise continuation executes. This may be after a then(), catch(), or finally() handler or before an await after another await.

M settled(promise)

• promise Promise

Called when the promise receives a resolution or rejection value. This may occur synchronously in the case of Promise.resolve() or Promise.reject().

Startup Snapshot API

Ajouté en: v18.6.0, v16.17.0

The v8.startupSnapshot interface can be used to add serialization and deserialization hooks for custom startup snapshots. Currently the startup snapshots can only be built into the Node.js binary from source.

BASHcopy

In the example above, entry.js can use methods from the v8.startupSnapshot interface to specify how to save information for custom objects in the snapshot during serialization and how the information can be used to synchronize these objects during deserialization of the snapshot. For example, if the entry.js contains the following script:

CJScopy

The resulted binary will simply print the data deserialized from the snapshot during start up:

BASHcopy

Currently the API is only available to a Node.js instance launched from the default snapshot, that is, the application deserialized from a user-land snapshot cannot use these APIs again.

M v8.startupSnapshot.addSerializeCallback(callback[, data])

Ajouté en: v18.6.0, v16.17.0

• callback Function Callback to be invoked before serialization.
• data any Optional data that will be passed to the callback when it gets called.

Add a callback that will be called when the Node.js instance is about to get serialized into a snapshot and exit. This can be used to release resources that should not or cannot be serialized or to convert user data into a form more suitable for serialization.

M v8.startupSnapshot.addDeserializeCallback(callback[, data])

Ajouté en: v18.6.0, v16.17.0

• callback Function Callback to be invoked after the snapshot is deserialized.
• data any Optional data that will be passed to the callback when it gets called.

Add a callback that will be called when the Node.js instance is deserialized from a snapshot. The callback and the data (if provided) will be serialized into the snapshot, they can be used to re-initialize the state of the application or to re-acquire resources that the application needs when the application is restarted from the snapshot.

M v8.startupSnapshot.setDeserializeMainFunction(callback[, data])

Ajouté en: v18.6.0, v16.17.0

• callback Function Callback to be invoked as the entry point after the snapshot is deserialized.
• data any Optional data that will be passed to the callback when it gets called.

This sets the entry point of the Node.js application when it is deserialized from a snapshot. This can be called only once in the snapshot building script. If called, the deserialized application no longer needs an additional entry point script to start up and will simply invoke the callback along with the deserialized data (if provided), otherwise an entry point script still needs to be provided to the deserialized application.

M v8.startupSnapshot.isBuildingSnapshot()

Ajouté en: v18.6.0, v16.17.0

• Returns: boolean

Returns true if the Node.js instance is run to build a snapshot.