Spec-Zone.ru › Node.js 18 LTS

Интерфейс системы WebAssembly (WASI)

Устойчивость: 1 - Экспериментальная

Исходный код: lib/wasi.js

API WASI предоставляет реализацию спецификации Интерфейса системы WebAssembly. WASI предоставляет доступ к ядру операционной системы для защищенных приложений WebAssembly через набор функций, похожих на POSIX.

MJS модули

import { readFile } from 'node:fs/promises';
import { WASI } from 'wasi';
import { argv, env } from 'node:process';

const wasi = new WASI({
  args: argv,
  env,
  preopens: {
    '/sandbox': '/some/real/path/that/wasm/can/access',
  },
});

// Some WASI binaries require:
//   const importObject = { wasi_unstable: wasi.wasiImport };
const importObject = { wasi_snapshot_preview1: wasi.wasiImport };

const wasm = await WebAssembly.compile(
  await readFile(new URL('./demo.wasm', import.meta.url)),
);
const instance = await WebAssembly.instantiate(wasm, importObject);

wasi.start(instance);

CJS модули

'use strict';
const { readFile } = require('node:fs/promises');
const { WASI } = require('wasi');
const { argv, env } = require('node:process');
const { join } = require('node:path');

const wasi = new WASI({
  args: argv,
  env,
  preopens: {
    '/sandbox': '/some/real/path/that/wasm/can/access',
  },
});

// Some WASI binaries require:
//   const importObject = { wasi_unstable: wasi.wasiImport };
const importObject = { wasi_snapshot_preview1: wasi.wasiImport };

(async () => {
  const wasm = await WebAssembly.compile(
    await readFile(join(__dirname, 'demo.wasm')),
  );
  const instance = await WebAssembly.instantiate(wasm, importObject);

  wasi.start(instance);
})();

Чтобы запустить вышеприведенный пример, создайте новый файл формата WebAssembly с текстовым описанием, назвав его demo.wat:

(module
    ;; Import the required fd_write WASI function which will write the given io vectors to stdout
    ;; The function signature for fd_write is:
    ;; (File Descriptor, *iovs, iovs_len, nwritten) -> Returns number of bytes written
    (import "wasi_snapshot_preview1" "fd_write" (func $fd_write (param i32 i32 i32 i32) (result i32)))

    (memory 1)
    (export "memory" (memory 0))

    ;; Write 'hello world\n' to memory at an offset of 8 bytes
    ;; Note the trailing newline which is required for the text to appear
    (data (i32.const 8) "hello world\n")

    (func $main (export "_start")
        ;; Creating a new io vector within linear memory
        (i32.store (i32.const 0) (i32.const 8))  ;; iov.iov_base - This is a pointer to the start of the 'hello world\n' string
        (i32.store (i32.const 4) (i32.const 12))  ;; iov.iov_len - The length of the 'hello world\n' string

        (call $fd_write
            (i32.const 1) ;; file_descriptor - 1 for stdout
            (i32.const 0) ;; *iovs - The pointer to the iov array, which is stored at memory location 0
            (i32.const 1) ;; iovs_len - We're printing 1 string stored in an iov - so one.
            (i32.const 20) ;; nwritten - A place in memory to store the number of bytes written
        )
        drop ;; Discard the number of bytes written from the top of the stack
    )
) copy

Используйте wabt для компиляции .wat в .wasm

$ wat2wasm demo.wat copy

Класс: WASI

Добавлен в: v13.3.0, v12.16.0

Класс WASI предоставляет API системных вызовов WASI и дополнительные удобные методы для работы с приложениями, основанными на WASI. Каждый экземпляр WASI представляет собой отдельную среду песочницы. В целях безопасности каждый экземпляр WASI должен иметь явно настроенные аргументы командной строки, переменные среды и структуру каталогов песочницы.

new WASI([options])

Добавлен в: v13.3.0, v12.16.0
  • options <Объект>
    • args <Массив> Массив строк, которые приложение WebAssembly увидит в качестве аргументов командной строки. Первый аргумент — виртуальный путь к самому командному интерпретатору WASI. По умолчанию: [].
    • env <Объект> Объект, аналогичный process.env, который приложение WebAssembly увидит в качестве своей среды. По умолчанию: {}.
    • preopens <Объект> Этот объект представляет собой структуру каталогов песочницы приложения WebAssembly. Строковые ключи preopens рассматриваются как каталоги в песочнице. Соответствующие значения в preopens — это реальные пути к этим каталогам на хост-машине.
    • returnOnExit <логическое значение> По умолчанию, приложения WASI завершают процесс Node.js с помощью функции __wasi_proc_exit(). Установка этого параметра в true заставляет wasi.start() возвращать код выхода вместо завершения процесса. По умолчанию: false.
    • stdin <целое число> Дескриптор файла, используемый в качестве стандартного ввода в приложении WebAssembly. По умолчанию: 0.
    • stdout <целое число> Дескриптор файла, используемый в качестве стандартного вывода в приложении WebAssembly. По умолчанию: 1.
    • stderr <целое число> Дескриптор файла, используемый в качестве стандартной ошибки в приложении WebAssembly. По умолчанию: 2.

wasi.start(instance)

Добавлен в: v13.3.0, v12.16.0
  • instance <WebAssembly.Instance>

Попытка начать выполнение instance в качестве команды WASI, вызвав её экспорт _start(). Если instance не содержит экспорта _start(), или если instance содержит экспорт _initialize(), то выбрасывается исключение.

Для start() необходимо, чтобы instance экспортировал WebAssembly.Memory с именем memory. Если instance не имеет экспорта memory, выбрасывается исключение.

Если start() вызывается более одного раза, выбрасывается исключение.

wasi.initialize(instance)

Добавлен в: v14.6.0, v12.19.0
  • instance <WebAssembly.Instance>

Попытка инициализировать instance как реактор WASI, вызвав его экспорт _initialize(), если он присутствует. Если instance содержит экспорт _start(), то выбрасывается исключение.

Для initialize() необходимо, чтобы instance экспортировал WebAssembly.Memory с именем memory. Если instance не имеет экспорта memory, выбрасывается исключение.

Если initialize() вызывается более одного раза, выбрасывается исключение.

wasi.wasiImport

Добавлен в: v13.3.0, v12.16.0
  • <Объект>

wasiImport — это объект, реализующий API системных вызовов WASI. Этот объект должен быть передан в качестве импорта wasi_snapshot_preview1 при создании WebAssembly.Instance.

© Joyent, Inc. and other Node contributors
Licensed under the MIT License.
Node.js is a trademark of Joyent, Inc. and is used with its permission.
We are not endorsed by or affiliated with Joyent.
https://nodejs.org/dist/latest-v18.x/docs/api/wasi.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API