为 Wasm 编写一个 C 库脚本

Surma

有时，您可能需要使用仅以 C 或 C++ 代码形式提供的库。从传统意义上来说，这是放弃操作。现在不需要了，因为现在我们有 Emscripten 和 WebAssembly（或 Wasm）！

工具链

我给自己定下了一个目标，就是弄清楚如何将一些现有的 C 代码编译为 Wasm。LLVM 的 Wasm 后端存在一些噪声，因此我开始深入研究。虽然您可以通过这种方式编译简单的程序，但当您想要使用 C 的标准库或甚至编译多个文件时，可能会遇到问题。这让我得出了以下重要教训：

虽然 Emscripten 曾用作 C-to-asm.js 编译器，但后来已经发展为以 Wasm 为目标，并且正在内部切换到官方 LLVM 后端。Emscripten 还提供了与 Wasm 兼容的 C 标准库实现。使用 Emscripten。它会执行大量隐藏工作、模拟文件系统、提供内存管理、使用 WebGL 封装 OpenGL，而许多您自己开发工作并不需要的功能。

虽然这听起来您可能很担心膨胀（我当然有此担心），但 Emscripten 编译器会移除了所有不需要的内容。在我的实验中，生成的 Wasm 模块的大小会根据它们包含的逻辑进行适当调整，Emscripten 和 WebAssembly 团队正在努力将其缩小到未来。

您可以按照 Emscripten 网站上的说明或使用 Homebrew 安装 Emscripten。如果您像我一样喜欢使用 Docker 化命令，并且不想为了玩转 WebAssembly，而不想在系统上安装某些软件，您可以改用维护良好的 Docker 映像：

    $ docker pull trzeci/emscripten
    $ docker run --rm -v $(pwd):/src trzeci/emscripten emcc <emcc options here>

编译简单内容

我们来看一个几乎是规范示例的 C 函数，用于计算第 n 个斐波那契数：

    #include <emscripten.h>

    EMSCRIPTEN_KEEPALIVE
    int fib(int n) {
      if(n <= 0){
        return 0;
      }
      int i, t, a = 0, b = 1;
      for (i = 1; i < n; i++) {
        t = a + b;
        a = b;
        b = t;
      }
      return b;
    }

如果您了解 C，函数本身就不应该太奇怪了。即使您不懂 C 语言，但如果懂 JavaScript，也有望理解这里发生的情况。

emscripten.h 是 Emscripten 提供的头文件。我们只需要它来访问 EMSCRIPTEN_KEEPALIVE 宏，但它提供了更多功能。此宏会告知编译器不要移除函数，即使该函数似乎未使用也是如此。如果我们省略这个宏，编译器会优化函数，毕竟没人使用它。

我们将所有这些内容保存在名为 fib.c 的文件中。如需将其转换为 .wasm 文件，我们需要转到 Emscripten 的编译器命令 emcc：

    $ emcc -O3 -s WASM=1 -s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' fib.c

我们来分析一下这个命令。emcc 是 Emscripten 的编译器。fib.c 是我们的 C 文件。目前的过程一切顺利。-s WASM=1 告知 Emscripten 向我们提供 Wasm 文件，而不是 asm.js 文件。-s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' 会告知编译器让 cwrap() 函数在 JavaScript 文件中保持可用 - 稍后会详细介绍此函数。-O3 会告知编译器进行积极优化。您可以选择较低的数字以缩短构建时间，但这也会使生成的软件包变大，因为编译器可能不会移除未使用的代码。

运行该命令后，最终应该会有一个名为 a.out.js 的 JavaScript 文件和一个名为 a.out.wasm 的 WebAssembly 文件。Wasm 文件（或“模块”）包含我们编译的 C 代码，并且应该非常小。JavaScript 文件负责加载和初始化 Wasm 模块，并提供一个更好的 API。如果需要，它还负责设置堆栈、堆，以及编写 C 代码时操作系统通常需要提供的其他功能。因此，JavaScript 文件略大，约为 19KB（经 gzip 处理后约为 5KB）。

运行一些简单的任务

如需加载和运行模块，最简单的方法是使用生成的 JavaScript 文件。加载该文件后，您将能使用 Module 全局变量。使用 cwrap 创建一个 JavaScript 原生函数，该函数负责将参数转换为适合 C 语言的参数并调用封装的函数。cwrap 按以下顺序接受函数名称、返回类型和参数类型作为参数：

    <script src="a.out.js"></script>
    <script>
      Module.onRuntimeInitialized = _ => {
        const fib = Module.cwrap('fib', 'number', ['number']);
        console.log(fib(12));
      };
    </script>

如果您运行此代码，应该会在控制台中看到“144”，这是第 12 个斐波那契数。

圣杯：编译 C 库

到目前为止，我们编写的 C 代码是在编写时考虑到 Wasm。不过，WebAssembly 的一个核心用例是采用 C 库的现有生态系统，并允许开发者在网络上使用它们。这些库通常依赖于 C 的标准库、操作系统、文件系统等。Emscripten 提供了其中大部分功能，不过也存在一些限制。

我们来回顾一下最初的目标：将 WebP 的编码器编译为 Wasm。WebP 编解码器的源代码采用 C 语言编写，可在 GitHub 上找到，此外还有一些详尽的 API 文档。这是一个非常好的起点。

    $ git clone https://github.com/webmproject/libwebp

首先，我们来尝试通过编写一个名为 webp.c 的 C 文件，将 encode.h 中的 WebPGetEncoderVersion() 公开给 JavaScript：

    #include "emscripten.h"
    #include "src/webp/encode.h"

    EMSCRIPTEN_KEEPALIVE
    int version() {
      return WebPGetEncoderVersion();
    }

这是一个很好的简单程序，用于测试我们是否可以获取要编译的 libwebp 源代码，因为我们不需要任何参数或复杂的数据结构来调用此函数。

为了编译此程序，我们需要使用 -I 标记告知编译器在哪里可以找到 libwebp 的头文件，并向其传递所需的 libwebp 的所有 C 文件。老实说：我只为它提供了可以找到的所有 C 文件，并依赖编译器来剔除所有不必要的内容。看起来效果非常好！

    $ emcc -O3 -s WASM=1 -s EXTRA_EXPORTED_RUNTIME_METHODS='["cwrap"]' \
        -I libwebp \
        webp.c \
        libwebp/src/{dec,dsp,demux,enc,mux,utils}/*.c

现在，我们只需一些 HTML 和 JavaScript 即可加载我们全新的模块：

<script src="/a.out.js"></script>
<script>
  Module.onRuntimeInitialized = async (_) => {
    const api = {
      version: Module.cwrap('version', 'number', []),
    };
    console.log(api.version());
  };
</script>

我们将在输出中看到更正版本号：

显示正确版本号的开发者工具控制台屏幕截图。

将图片从 JavaScript 获取到 Wasm

获取编码器的版本号固然很好，但对实际图片进行编码会更令人印象深刻，对吧？那就这样吧。

我们必须回答的第一个问题是：如何将图片导入 Wasm 环境？查看 libwebp 的编码 API，它期望以 RGB、RGBA、BGR 或 BGRA 格式提供字节数组。幸运的是，Canvas API 具有 getImageData()，它为我们提供了包含 RGBA 图片数据的 Uint8ClampedArray：

async function loadImage(src) {
  // Load image
  const imgBlob = await fetch(src).then((resp) => resp.blob());
  const img = await createImageBitmap(imgBlob);
  // Make canvas same size as image
  const canvas = document.createElement('canvas');
  canvas.width = img.width;
  canvas.height = img.height;
  // Draw image onto canvas
  const ctx = canvas.getContext('2d');
  ctx.drawImage(img, 0, 0);
  return ctx.getImageData(0, 0, img.width, img.height);
}

现在，“仅”需要将数据从 JavaScript 平台复制到 Wasm 平台。为此，我们需要公开另外两个函数。一个用于为 Wasm 中的图片分配内存，另一个用于再次释放该图片：

    EMSCRIPTEN_KEEPALIVE
    uint8_t* create_buffer(int width, int height) {
      return malloc(width * height * 4 * sizeof(uint8_t));
    }

    EMSCRIPTEN_KEEPALIVE
    void destroy_buffer(uint8_t* p) {
      free(p);
    }

create_buffer 会为 RGBA 图片分配缓冲区，因此每像素 4 个字节。malloc() 返回的指针是该缓冲区第一个内存单元的地址。当指针返回到 JavaScript 环境时，系统会将其视为一个数字。使用 cwrap 将函数提供给 JavaScript 后，我们就可以使用该数字查找缓冲区的起始位置并复制图片数据。

const api = {
  version: Module.cwrap('version', 'number', []),
  create_buffer: Module.cwrap('create_buffer', 'number', ['number', 'number']),
  destroy_buffer: Module.cwrap('destroy_buffer', '', ['number']),
};

const image = await loadImage('/image.jpg');
const p = api.create_buffer(image.width, image.height);
Module.HEAP8.set(image.data, p);
// ... call encoder ...
api.destroy_buffer(p);

压轴大戏：对图片进行编码

现在，Wasm land 提供了这张图片。现在，是时候调用 WebP 编码器来执行其工作了！查看 WebP 文档后，WebPEncodeRGBA 似乎非常适合。该函数接受指向输入图片及其尺寸的指针，以及介于 0 到 100 之间的质量选项。它还会为我们分配一个输出缓冲区，我们需要在处理完 WebP 图片后使用 WebPFree() 释放该缓冲区。

编码操作的结果是输出缓冲区及其长度。由于 C 语言中的函数不能将数组作为返回值类型（除非我们动态分配内存），因此我选择了静态全局数组。我知道，这不是一种简洁的 C（实际上，它依赖于 Wasm 指针宽 32 位这一事实），但为简单起见，我认为这是一个很方便的捷径。

    int result[2];
    EMSCRIPTEN_KEEPALIVE
    void encode(uint8_t* img_in, int width, int height, float quality) {
      uint8_t* img_out;
      size_t size;

      size = WebPEncodeRGBA(img_in, width, height, width * 4, quality, &img_out);

      result[0] = (int)img_out;
      result[1] = size;
    }

    EMSCRIPTEN_KEEPALIVE
    void free_result(uint8_t* result) {
      WebPFree(result);
    }

    EMSCRIPTEN_KEEPALIVE
    int get_result_pointer() {
      return result[0];
    }

    EMSCRIPTEN_KEEPALIVE
    int get_result_size() {
      return result[1];
    }

现在，所有这些都已到位，我们可以调用编码函数，获取指针和图片大小，将其放入我们自己的 JavaScript 内存缓冲区，并释放在此过程中分配的所有 Wasm 内存缓冲区。

    api.encode(p, image.width, image.height, 100);
    const resultPointer = api.get_result_pointer();
    const resultSize = api.get_result_size();
    const resultView = new Uint8Array(Module.HEAP8.buffer, resultPointer, resultSize);
    const result = new Uint8Array(resultView);
    api.free_result(resultPointer);

根据图像的大小，您可能会遇到一个错误，即 Wasm 无法将内存扩容到足以同时容纳输入和输出图像：

显示错误的开发者工具控制台屏幕截图。

幸运的是，错误消息中提供了此问题的解决方法！我们只需将 -s ALLOW_MEMORY_GROWTH=1 添加到编译命令中。

好了，大功告成！我们编译了 WebP 编码器，并将 JPEG 图片转码为 WebP。为了证明它确实有效，我们可以将结果缓冲区转换为 blob，并将其用于 <img> 元素：

const blob = new Blob([result], { type: 'image/webp' });
const blobURL = URL.createObjectURL(blob);
const img = document.createElement('img');
img.src = blobURL;
document.body.appendChild(img);

请看，新 WebP 图片的光彩！

DevTools 的“Network”面板和生成的图片。

总结

在浏览器中使用 C 库并不复杂，但一旦您了解了整体过程和数据流的工作原理，它就会变得更容易，结果可能令人大开眼界。

WebAssembly 为 Web 上的处理、数字计算和游戏开辟了许多新可能性。请注意，Wasm 并不是万能灵药，不能应用于所有问题，但当您遇到上述某个瓶颈时，Wasm 可以成为非常有用的工具。

奖励内容：以复杂的方式运行简单的操作

如果您想尝试避免生成的 JavaScript 文件，也许可以这样做。我们回到斐波那契的例子。如需自行加载并运行代码，我们可以执行以下操作：

<!DOCTYPE html>
<script>
  (async function () {
    const imports = {
      env: {
        memory: new WebAssembly.Memory({ initial: 1 }),
        STACKTOP: 0,
      },
    };
    const { instance } = await WebAssembly.instantiateStreaming(
      fetch('/a.out.wasm'),
      imports,
    );
    console.log(instance.exports._fib(12));
  })();
</script>

除非您为 Emscripten 创建的 WebAssembly 模块提供内存，否则它们将无法使用内存。为 Wasm 模块提供任何内容的方式是使用 imports 对象（instantiateStreaming 函数的第二个参数）。Wasm 模块可以访问 imports 对象内的所有内容，但无法访问该对象之外的任何内容。按照惯例，Emscripting 编译的模块在加载 JavaScript 环境中需要一些条件：

  • 首先是 env.memory。Wasm 模块无法感知外界，因此需要获取一些内存才能正常运行。输入 WebAssembly.Memory。它表示一段（可选择扩展的）线性内存。大小调整参数采用“以 WebAssembly 页面为单位”，这意味着上述代码会分配 1 页内存，其中每个页面的大小为 64 KiB。如果没有提供 maximum 选项，从理论上讲，内存增长是无限的（Chrome 目前有 2GB 的硬性限制）。大多数 WebAssembly 模块都不需要设置上限。
  • env.STACKTOP 用于定义堆栈应从何处开始增长。进行函数调用以及为局部变量分配内存时需要使用该堆栈。由于我们在小型斐波那契数列程序中不会执行任何动态内存管理操作，因此可以将整个内存用作堆栈，即 STACKTOP = 0。