v8

Возвращает целое число, представляющее тег версии, полученный на основе версии V8, флагов командной строки и обнаруженных возможностей ЦП. Это полезно для определения совместимости буфера vm.Script cachedData с этим экземпляром V8.

console.log(v8.cachedDataVersionTag()); // 3947234607
// The value returned by v8.cachedDataVersionTag() is derived from the V8
// version, command-line flags, and detected CPU features. Test that the value
// does indeed update when flags are toggled.
v8.setFlagsFromString('--allow_natives_syntax');
console.log(v8.cachedDataVersionTag()); // 183726201

Использует DefaultDeserializer с параметрами по умолчанию для чтения значения JS из буфера.

Получает статистику о коде и его метаданных в куче; см. API V8 GetHeapCodeAndMetadataStatistics. Возвращает объект со следующими свойствами:

{
  code_and_metadata_size: 212208,
  bytecode_and_metadata_size: 161368,
  external_script_source_size: 1410794,
  cpu_profiler_metadata_size: 0,
}

Создает снимок текущей кучи V8 и возвращает читаемый поток, который можно использовать для чтения сериализованного представления JSON. Этот формат потока JSON предназначен для использования с такими инструментами, как Chrome DevTools. Схема JSON не документирована и специфична для движка V8. Поэтому схема может меняться от одной версии V8 к другой.

Для создания снимка кучи требуется объем памяти примерно вдвое больше размера кучи на момент создания снимка. Это создает риск завершения процесса диспетчерами нехватки памяти (OOM).

Создание снимка — синхронная операция, которая блокирует цикл событий на время, зависящее от размера кучи.

// Print heap snapshot to the console
import v8 from 'node:v8';
const stream = v8.getHeapSnapshot();
stream.pipe(process.stdout);

Возвращает статистику о пространствах кучи V8, то есть сегментах, из которых состоит куча V8. Нельзя гарантировать ни порядок пространств кучи, ни доступность какого-либо пространства, поскольку статистика предоставляется функцией V8 GetHeapSpaceStatistics и может меняться от одной версии V8 к другой.

Возвращаемое значение — массив объектов со следующими свойствами:

[
  {
    "space_name": "new_space",
    "space_size": 2063872,
    "space_used_size": 951112,
    "space_available_size": 80824,
    "physical_space_size": 2063872
  },
  {
    "space_name": "old_space",
    "space_size": 3090560,
    "space_used_size": 2493792,
    "space_available_size": 0,
    "physical_space_size": 3090560
  },
  {
    "space_name": "code_space",
    "space_size": 1260160,
    "space_used_size": 644256,
    "space_available_size": 960,
    "physical_space_size": 1260160
  },
  {
    "space_name": "map_space",
    "space_size": 1094160,
    "space_used_size": 201608,
    "space_available_size": 0,
    "physical_space_size": 1094160
  },
  {
    "space_name": "large_object_space",
    "space_size": 0,
    "space_used_size": 0,
    "space_available_size": 1490980608,
    "physical_space_size": 0
  }
]

Возвращает объект со следующими свойствами:

does_zap_garbage — логическое значение 0/1, указывающее, включен ли параметр --zap_code_space. Он заставляет V8 перезаписывать мусор в куче битовым шаблоном. Объем RSS (размер резидентного набора) увеличивается, поскольку эта операция постоянно обращается ко всем страницам кучи, из-за чего операционная система с меньшей вероятностью выгрузит их в файл подкачки.

number_of_native_contexts Значение native_context — число активных в данный момент контекстов верхнего уровня. Рост этого числа со временем указывает на утечку памяти.

number_of_detached_contexts Значение detached_context — число отсоединенных контекстов, которые еще не были собраны сборщиком мусора. Ненулевое значение указывает на возможную утечку памяти.

total_global_handles_size Значение total_global_handles_size — общий объем памяти глобальных дескрипторов V8.

used_global_handles_size Значение used_global_handles_size — объем используемой памяти глобальных дескрипторов V8.

external_memory Значение external_memory — объем памяти буферов массивов и внешних строк.

{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  total_available_size: 1152656,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264,
  malloced_memory: 16384,
  peak_malloced_memory: 1127496,
  does_zap_garbage: 0,
  number_of_native_contexts: 1,
  number_of_detached_contexts: 0,
  total_global_handles_size: 8192,
  used_global_handles_size: 3296,
  external_memory: 318824
}

Эта функция похожа на queryObjects() API консоли, предоставляемый консолью Chromium DevTools. С ее помощью можно искать в куче объекты, в цепочке прототипов которых есть соответствующий конструктор, после полной сборки мусора. Это может быть полезно для регрессионного тестирования утечек памяти. Во избежание неожиданных результатов не следует использовать этот API с конструкторами, реализацию которых вы не контролируете, или с конструкторами, которые могут вызываться другими участниками приложения.

Чтобы избежать случайных утечек, этот API не возвращает прямые ссылки на найденные объекты. По умолчанию он возвращает количество найденных объектов. Если options.format — 'summary', возвращается массив с краткими строковыми представлениями каждого объекта. Данные, предоставляемые этим API, аналогичны данным снимка кучи, но позволяют сэкономить на сериализации и разборе, а также напрямую отфильтровать целевые объекты во время поиска.

В результаты включаются только объекты, созданные в текущем контексте выполнения.

import { queryObjects } from 'node:v8';
class A { foo = 'bar'; }
console.log(queryObjects(A)); // 0
const a = new A();
console.log(queryObjects(A)); // 1
// [ "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }));

class B extends A { bar = 'qux'; }
const b = new B();
console.log(queryObjects(B)); // 1
// [ "B { foo: 'bar', bar: 'qux' }" ]
console.log(queryObjects(B, { format: 'summary' }));

// Note that, when there are child classes inheriting from a constructor,
// the constructor also shows up in the prototype chain of the child
// classes's prototoype, so the child classes's prototoype would also be
// included in the result.
console.log(queryObjects(A));  // 3
// [ "B { foo: 'bar', bar: 'qux' }", 'A {}', "A { foo: 'bar' }" ]
console.log(queryObjects(A, { format: 'summary' }));

Использует DefaultSerializer для сериализации value в буфер.

При попытке сериализовать огромный объект, для которого требуется буфер размером больше buffer.constants.MAX_LENGTH, будет выброшено ERR_BUFFER_TOO_LARGE.

Метод v8.setFlagsFromString() можно использовать для программной установки флагов командной строки V8. Этот метод следует использовать с осторожностью. Изменение настроек после запуска виртуальной машины может привести к непредсказуемому поведению, включая сбои и потерю данных, или просто ни к чему не привести.

Список параметров V8, доступных для версии Node.js, можно определить, выполнив node --v8-options.

Использование:

// Print GC events to stdout for one minute.
import v8 from 'node:v8';
v8.setFlagsFromString('--trace_gc');
setTimeout(() => { v8.setFlagsFromString('--notrace_gc'); }, 60e3);

API ничего не делает, если --heapsnapshot-near-heap-limit уже задан в командной строке или если API вызывается более одного раза. limit должно быть положительным целым числом. Дополнительные сведения см. в разделе --heapsnapshot-near-heap-limit.

Метод v8.stopCoverage() позволяет пользователю остановить сбор данных о покрытии, начатый методом NODE_V8_COVERAGE, чтобы V8 мог освободить записи счетчиков выполнения и оптимизировать код. Его можно использовать вместе с takeCoverage, если пользователь хочет собирать данные о покрытии по запросу.

Метод v8.takeCoverage() позволяет пользователю по запросу записать на диск данные о покрытии, сбор которых был запущен методом NODE_V8_COVERAGE. Этот метод можно вызывать несколько раз в течение времени работы процесса. При каждом вызове счетчик выполнения будет сбрасываться, а в каталог, указанный в NODE_V8_COVERAGE, будет записываться новый отчет о покрытии.

Перед завершением процесса на диск будет записан еще один отчет о покрытии, если только перед выходом из процесса не был вызван stopCoverage.

Создает снимок текущей кучи V8 и записывает его в файл JSON. Этот файл предназначен для использования с такими инструментами, как Chrome DevTools. Схема JSON не документирована, зависит от движка V8 и может меняться от одной версии V8 к другой.

Снимок кучи относится к одному изоляту V8. При использовании worker threads снимок кучи, созданный в основном потоке, не будет содержать сведений о рабочих потоках, и наоборот.

Для создания снимка кучи требуется объем памяти примерно вдвое больше размера кучи на момент создания снимка. Из-за этого существует риск, что процесс будет завершен механизмами OOM.

Создание снимка — синхронная операция, блокирующая цикл событий на время, зависящее от размера кучи.

import { writeHeapSnapshot } from 'node:v8';
import {
  Worker,
  isMainThread,
  parentPort,
} from 'node:worker_threads';

if (isMainThread) {
  const worker = new Worker(__filename);

  worker.once('message', (filename) => {
    console.log(`worker heapdump: ${filename}`);
    // Now get a heapdump for the main thread.
    console.log(`main thread heapdump: ${writeHeapSnapshot()}`);
  });

  // Tell the worker to create a heapdump.
  worker.postMessage('heapdump');
} else {
  parentPort.once('message', (message) => {
    if (message === 'heapdump') {
      // Generate a heapdump for the worker
      // and return the filename to the parent.
      parentPort.postMessage(writeHeapSnapshot());
    }
  });
}