在 VS Code Web 版中运行 WebAssembly

2023 年 6 月 5 日，Dirk Bäumer 发布

VS Code Web 版 (https://vscode.dev) 已经推出一段时间了，我们的目标一直是支持浏览器中完整的编辑/编译/调试周期。对于 JavaScript 和 TypeScript 等语言来说，这相对容易，因为浏览器自带 JavaScript 执行引擎。对于其他语言来说，这比较困难，因为我们必须能够执行（以及因此调试）代码。例如，要在浏览器中运行 Python 源代码，需要有一个可以运行 Python 解释器的执行引擎。这些语言运行时通常用 C/C++ 编写。

WebAssembly 是一种虚拟机二进制指令格式。现代浏览器如今都内置了 WebAssembly 虚拟机，并且有工具链可以将 C/C++ 编译为 WebAssembly 代码。为了了解当今 WebAssembly 的可能性，我们决定采用 C/C++ 编写的 Python 解释器，将其编译为 WebAssembly，并在 VS Code Web 版中运行它。幸运的是，Python 团队已经开始着手将 CPython 编译为 WASM，我们很高兴地借用了他们的成果。探索的结果可以在下面的短视频中看到

Execute a Python file in VS Code for the Web

它看起来与在 VS Code 桌面版中执行 Python 代码并没有什么不同。那么，这有什么酷的呢？

Python 源代码 (app.py 和 hello.py) 托管在 GitHub 仓库中，并直接从 GitHub 读取。Python 解释器可以完全访问工作区中的文件，但不能访问任何其他文件。
示例代码是多文件的。app.py 依赖于 hello.py。
输出结果在 VS Code 的终端中很好地显示出来。
您可以运行 Python REPL 并与之完全交互。
当然，它可以在 Web 上运行。

此外，编译为 WebAssembly (WASM) 代码的 Python 解释器无需任何修改即可在 VS Code Web 版中运行。这些位与 CPython 团队创建的位完全相同。

它是如何工作的？

WebAssembly 虚拟机没有附带 SDK（例如，Java 或 .NET）。因此，WebAssembly 代码开箱即用无法打印到控制台或读取文件内容。WebAssembly 规范定义的是 WebAssembly 代码如何调用运行虚拟机的宿主中的函数。对于 VS Code Web 版，宿主是浏览器。因此，虚拟机可以调用在浏览器中执行的 JavaScript 函数。

Python 团队提供了两种风味的解释器的 WebAssembly 二进制文件：一种使用 emscripten 编译，另一种使用 WASI SDK 编译。尽管它们都创建 WebAssembly 代码，但它们在作为宿主实现的 JavaScript 函数方面具有不同的特性

emscripten - 特别关注 Web 平台和 Node.js。除了生成 WASM 代码外，它还生成 JavaScript 代码，作为在浏览器或 Node.js 环境中执行 WASM 代码的宿主。例如，JavaScript 代码提供了一个函数，用于将 C printf 语句的内容打印到浏览器的控制台。
WASI SDK - 将 C/C++ 代码编译为 WASM，并假定宿主实现符合 WASI 规范。WASI 代表 WebAssembly 系统接口。它定义了几个类似操作系统的功能，包括文件和文件系统、套接字、时钟和随机数。使用 WASI SDK 编译 C/C++ 代码只会生成 WebAssembly 代码，而不会生成任何 JavaScript 函数。将 C printf 语句的内容打印出来所需的 JavaScript 函数必须由宿主提供。Wasmtime 例如，就是一个运行时，它提供了一个 WASI 宿主实现，将 WASI 连接到操作系统调用。

对于 VS Code，我们决定支持 WASI。尽管我们的主要重点是在浏览器中执行 WASM 代码，但我们实际上并不是在纯浏览器环境中运行它。我们必须在 VS Code 的扩展宿主 worker 中运行 WebAssembly，因为这是扩展 VS Code 的标准方式。扩展宿主 worker 除了提供浏览器的 worker API 外，还提供了完整的 VS Code 扩展 API。因此，我们实际上想要将 C/C++ 程序中的 printf 调用连接到 VS Code 的终端 API，而不是将它连接到浏览器的控制台。在 WASI 中实现这一点对我们来说比在 emscripten 中更容易。

我们当前 VS Code 的 WASI 宿主实现基于 WASI 快照预览版 1，并且这篇博客文章中描述的所有实现细节都参考该版本。

如何运行我自己的 WebAssembly 代码？

在我们让 Python 在 VS Code Web 版中运行后，我们很快意识到我们采用的方法允许我们执行任何可以编译为 WASI 的代码。因此，本节演示了如何使用 WASI SDK 将一个小的 C 程序编译为 WASI，并在 VS Code 的扩展宿主中执行它。该示例假设读者熟悉 VS Code 的扩展 API，并且知道如何为 VS Code Web 版编写扩展。

我们运行的 C 程序是一个简单的 “Hello World” 程序，如下所示

#include <stdio.h>

int main(void)
{
    printf("Hello, World\n");
    return 0;
}

假设您已经安装了最新的 WASI SDK 并且它在您的 PATH 中，则可以使用以下命令编译 C 程序

clang hello.c -o ./hello.wasm

这将在 hello.c 文件旁边生成一个 hello.wasm 文件。

新功能通过扩展添加到 VS Code 中，我们在将 WebAssembly 集成到 VS Code 时也遵循相同的模型。我们需要定义一个扩展来加载和运行 WASM 代码。扩展的 package.json 清单的重要部分如下

{
    "name": "...",
    ...,
    "extensionDependencies": [
        "ms-vscode.wasm-wasi-core"
    ],
    "contributes": {
        "commands": [
            {
                "command": "wasm-c-example.run",
                "category": "WASM Example",
                "title": "Run C Hello World"
            }
        ]
    },
    "devDependencies": {
        "@types/vscode": "1.77.0",
    },
    "dependencies": {
        "@vscode/wasm-wasi": "0.11.0-next.0"
    }
}

ms-vscode.wasm-wasi-core 扩展提供了 WebAssembly 执行引擎，它将 WASI API 连接到 VS Code API。node 模块 @vscode/wasm-wasi 提供了一个外观，用于在 VS Code 中加载和运行 WebAssembly 代码。

以下是在 TypeScript 中加载和运行 WebAssembly 代码的实际代码

import { Wasm } from '@vscode/wasm-wasi';
import { commands, ExtensionContext, Uri, window, workspace } from 'vscode';

export async function activate(context: ExtensionContext) {
  // Load the WASM API
  const wasm: Wasm = await Wasm.load();

  // Register a command that runs the C example
  commands.registerCommand('wasm-wasi-c-example.run', async () => {
    // Create a pseudoterminal to provide stdio to the WASM process.
    const pty = wasm.createPseudoterminal();
    const terminal = window.createTerminal({
      name: 'Run C Example',
      pty,
      isTransient: true
    });
    terminal.show(true);

    try {
      // Load the WASM module. It is stored alongside the extension's JS code.
      // So we can use VS Code's file system API to load it. Makes it
      // independent of whether the code runs in the desktop or the web.
      const bits = await workspace.fs.readFile(
        Uri.joinPath(context.extensionUri, 'hello.wasm')
      );
      const module = await WebAssembly.compile(bits);
      // Create a WASM process.
      const process = await wasm.createProcess('hello', module, { stdio: pty.stdio });
      // Run the process and wait for its result.
      const result = await process.run();
      if (result !== 0) {
        await window.showErrorMessage(`Process hello ended with error: ${result}`);
      }
    } catch (error) {
      // Show an error message if something goes wrong.
      await window.showErrorMessage(error.message);
    }
  });
}

下面的视频展示了该扩展在 VS Code Web 版中运行的情况。

Run Hello World

我们使用 C/C++ 代码作为 WebAssembly 的源，并且由于 WASI 是一个标准，因此还有其他工具链支持 WASI。示例包括：Rust、.NET 或 Swift。

VS Code 的 WASI 实现

WASI 和 VS Code API 共享文件系统或 stdio（例如，终端）等概念。这使我们能够在 VS Code API 之上实现 WASI 规范。但是，不同的执行行为是一个挑战：WebAssembly 代码执行是同步的（例如，一旦 WebAssembly 执行开始，JavaScript worker 将被阻塞，直到执行完成），而 VS Code 和浏览器的大多数 API 都是异步的。例如，在 WASI 中从文件读取是同步的，而相应的 VS Code API 是异步的。这种特性为在 VS Code 扩展宿主 worker 中执行 WebAssembly 代码带来了两个问题

我们需要防止扩展宿主在执行 WebAssembly 代码时被阻塞，因为这会阻止其他扩展的执行。
需要一种机制在异步的 VS Code 和浏览器 API 之上实现同步的 WASI API。

第一种情况很容易解决：我们在单独的 worker 线程中运行 WebAssembly 代码。第二种情况更难解决，因为将同步代码映射到异步代码需要暂停同步执行线程，并在异步计算结果可用时恢复它。WebAssembly 的 JavaScript-Promise 集成提案在 WASM 层面上解决了这个问题，并且 V8 中有一个该提案的实验性实现。但是，当我们开始这项工作时，V8 实现尚未可用。因此，我们选择了另一种实现，它使用 SharedArrayBuffer 和 Atomics 将同步 WASI API 映射到 VS Code 的异步 API。

该方法的工作原理如下

WASM worker 线程创建一个 SharedArrayBuffer，其中包含有关应在 VS Code 端调用的代码的必要信息。
它将共享内存发布到 VS Code 的扩展宿主 worker，然后使用 Atomics.wait 等待扩展宿主 worker 完成其工作。
扩展宿主 worker 接收消息，调用适当的 VS Code API，将结果写回 SharedArrayBuffer，然后使用 Atomics.store 和 Atomics.notify 通知 WASM worker 线程唤醒。
然后，WASM worker 从 SharedArrayBuffer 中读取任何结果数据，并将其返回给 WASI 回调。

这种方法的唯一难点是 SharedArrayBuffer 和 Atomics 要求站点是跨域隔离的，由于 CORS 非常普遍，这本身可能是一项努力。这就是为什么它目前仅在 Insiders 版本 insiders.vscode.dev 上默认启用，并且必须在 vscode.dev 上使用查询参数 ?vscode-coi=on 启用。

下图更详细地展示了 WASM worker 和扩展宿主 worker 之间对于上面我们编译为 WebAssembly 的 C 程序的交互。橙色框中的代码是 WebAssembly 代码，所有绿色框中的代码都在 JavaScript 中运行。黄色框代表 SharedArrayBuffer。

Interaction between the WASM worker and the extension host

Web Shell

现在我们已经能够将 C/C++ 和 Rust 代码编译为 WebAssembly 并在 VS Code 中执行它，我们探索了是否也可以在 VS Code Web 版中运行 shell。

我们研究了将 Unix shell 之一编译为 WebAssembly。但是，某些 shell 依赖于操作系统功能（派生进程，...），这些功能目前在 WASI 中不可用。这促使我们采取略有不同的方法：我们用 TypeScript 实现了一个基本 shell，并尝试仅将 Unix core utils（如 ls、cat、date 等）编译为 WebAssembly。由于 Rust 对 WASM 和 WASI 具有非常好的支持，因此我们尝试了 uutils/coreutils，它是用 Rust 编写的 GNU coreutils 的跨平台重新实现。瞧，我们有了第一个最简化的 web shell。

A web shell

如果您无法执行自定义 WebAssembly 或命令，shell 将非常有限。为了扩展 web shell，其他扩展可以向文件系统贡献额外的挂载点，以及在 web shell 中键入时调用的命令。通过命令的间接性将具体的 WebAssembly 执行与在终端中键入的内容解耦。从一开始就在 Python 扩展中使用此支持，您可以直接从 shell 中执行 Python 代码，方法是在提示符中输入 python app.py 或列出通常挂载在 /usr/local/lib/python3.11 下的默认 python 3.11 库。

Python integration into web shell

接下来是什么？

WASM 执行引擎扩展和 Web Shell 扩展都作为预览版处于实验阶段，不应用于使用 WebAssembly 实现生产就绪的扩展。它们已被公开提供，以获得有关该技术的早期反馈。如果您有任何问题或反馈，请在相应的 vscode-wasm GitHub 存储库中打开 issue。此存储库还包含 Python 示例以及 WASM 执行引擎和 Web Shell 的源代码。

我们知道我们将进一步探索以下主题

WASI 团队正在开发规范的 preview2 和 preview3，我们计划也支持它们。新版本将改变 WASI 宿主的实现方式。但是，我们有信心保持我们的 API（在 WASM 执行引擎扩展中公开）基本稳定。
还有 WASIX 项目，它使用额外的类似操作系统的功能（如进程或 futex）扩展了 WASI。我们将继续关注这项工作。
许多 VS Code 的语言服务器都是用 JavaScript 或 TypeScript 以外的语言实现的。我们计划探索将这些语言服务器编译为 wasm32-wasi 并在 VS Code Web 版中运行它们的可行性。
改进 Web 上 Python 的调试。我们已经开始着手这项工作，敬请期待。
添加支持，以便扩展 B 可以运行扩展 A 贡献的 WebAssembly 代码。例如，这将允许任意扩展通过重用贡献 Python WebAssembly 的扩展来执行 Python 代码。
确保为 wasm32-wasi 编译的其他语言运行时在 VS Code 的 WebAssembly 执行引擎之上运行。VMware Labs 提供了 Ruby 和 PHP wasm32-wasi 二进制文件，并且它们都可以在 VS Code 中运行。

谢谢，

Dirk 和 VS Code 团队

编码愉快！