Node.js v18.18.2 文档

WebAssembly 系统接口 (WASI)#

源代码： lib/wasi.js

WASI API 提供了WebAssembly 系统接口规范的实现 。WASI 通过一系列类似 POSIX 的函数使沙盒 WebAssembly 应用程序能够访问底层操作系统。

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);'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);
})();copy

要运行上面的示例，请创建一个名为 demo.wat的新 WebAssembly 文本格式文件：

(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类提供 WASI 系统调用 API 以及用于使用基于 WASI 的应用程序的其他便捷方法。每个WASI实例代表一个不同的沙箱环境。出于安全目的，每个WASI 实例必须显式配置其命令行参数、环境变量和沙箱目录结构。

new WASI([options])#

添加于：v13.3.0、v12.16.0

• options <对象>
  • args <Array> WebAssembly 应用程序将其视为命令行参数的字符串数组。第一个参数是 WASI 命令本身的虚拟路径。默认值： []。
  • env <Object>类似于process.env的对象，WebAssembly 应用程序将其视为其环境。默认值： {}。
  • preopens <Object>该对象表示 WebAssembly 应用程序的沙箱目录结构。preopens的字符串键被视为沙箱内的目录。preopens中的相应值是主机上这些目录的真实路径。
  • returnOnExit <boolean>默认情况下，WASI 应用程序通过__wasi_proc_exit()函数终止 Node.js 进程。将此选项设置为true 会导致wasi.start()返回退出代码而不是终止进程。默认值： false。
  • stdin <integer>在 WebAssembly 应用程序中用作标准输入的文件描述符。默认值： 0。
  • stdout <integer>在 WebAssembly 应用程序中用作标准输出的文件描述符。默认值： 1。
  • stderr <integer>在 WebAssembly 应用程序中用作标准错误的文件描述符。默认值： 2。

wasi.start(instance)#

添加于：v13.3.0、v12.16.0

• instance <WebAssembly.Instance>

尝试通过调用_start()导出来开始将instance作为 WASI 命令 执行。如果instance不包含_start()导出，或者如果 instance包含_initialize()导出，则会引发异常。

start()要求instance导出名为 memory的WebAssembly.Memory。如果instance没有memory导出，则会引发异常。

如果多次调用start() ，则会引发异常。

wasi.initialize(instance)#

添加于：v14.6.0、v12.19.0

• instance <WebAssembly.Instance>

尝试通过调用其_initialize()导出（如果存在）将instance 初始化为 WASI 反应器 。如果instance包含_start() 导出，则会引发异常。

initialize()要求instance导出名为 memory的WebAssembly.Memory。如果instance没有memory导出，则会引发异常。

如果多次调用initialize() ，则会引发异常。

wasi.wasiImport#

添加于：v13.3.0、v12.16.0

• <对象>

wasiImport是一个实现 WASI 系统调用 API 的对象。该对象应在WebAssembly.Instance实例化期间作为wasi_snapshot_preview1导入传递。