为 Wasm 编写一个 C 库脚本

Surma

有时，您可能希望使用仅以 C 或 C++ 代码形式提供的库。 通常，您会在这里放弃。现在，情况已经发生了改变，因为我们有了 Emscripten 和 WebAssembly（或 Wasm）！

注意： 在本文中，我将介绍将 libwebp 编译为 Wasm 的过程。如需充分利用本文以及 Wasm，您需要具备 C 语言知识，尤其是指针、内存管理和编译器选项。

工具链

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

虽然 Emscripten 曾经是 C-to-asm.js 编译器，但它已经发展到以 Wasm 为目标，并且正在切换到内部的官方 LLVM 后端。Emscripten 还提供了与 Wasm 兼容的 C 标准库实现。使用 Emscripten。它承担了大量隐藏工作，模拟文件系统，提供内存管理，使用 WebGL 封装 OpenGL，这些都是您在开发过程中无需亲自体验的内容。

虽然这听起来可能需要担心代码膨胀（我确实担心过），但 Emscripten 编译器会移除所有不需要的内容。在我的实验中，生成的 Wasm 模块的大小与其包含的逻辑相符，Emscripten 和 WebAssembly 团队正在努力在未来进一步缩减其大小。

您可以按照其网站上的说明或使用 Homebrew 获取 Emscripten。如果您像我一样喜欢 Docker 化命令，并且不想为了体验 WebAssembly 而在系统上安装各种工具，那么可以使用一个维护良好的 Docker 映像：

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

正在编译简单内容

我们来看一个几乎是规范的示例，即用 C 语言编写一个计算第 n^th 个斐波那契数的函数：

    #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"]' 会告知编译器在 JavaScript 文件中保留 cwrap() 函数，稍后会详细介绍此函数。-O3 会告知编译器进行积极优化。您可以选择较小的数字来缩短构建时间，但这也会导致生成的 bundle 变大，因为编译器可能不会移除未使用的代码。

运行该命令后，您应该会得到一个名为 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 个斐波那契数。

注意： Emscripten 提供了几个选项来处理多个模块的加载。如需了解详情，请参阅其文档。

终极目标：编译 C 库

到目前为止，我们编写的 C 代码都是以 Wasm 为目标。不过，WebAssembly 的一个核心用例是采用现有的 C 库生态系统，并允许开发者在 Web 上使用它们。这些库通常依赖于 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

注意： 此策略不适用于所有 C 项目。许多项目依赖 autoconf/automake 在编译之前生成系统专用代码。Emscripten 提供了 emconfigure 和 emmake 来封装这些命令并注入适当的参数。如需了解详情，请参阅 Emscripten 文档。

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

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

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

注意： libwebp 会以十六进制数字 0xabc 的形式返回当前版本 a.b.c。因此，v0.6.1 编码为 0x000601 = 1537。

将图片从 JavaScript 导入 Wasm

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

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

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 领域中使用。现在，该调用 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);

注意： new Uint8Array(someBuffer) 会在同一内存块上创建新视图，而 new Uint8Array(someTypedArray) 会复制数据。

根据图片的大小，您可能会遇到 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 图片的魅力！

总结

让 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>

注意： 请确保您的 .wasm 文件具有 Content-Type: application/wasm。否则，这些模块将被 WebAssembly 拒绝。

由 Emscripten 创建的 WebAssembly 模块没有可供使用的内存，除非您为其提供内存。您可以通过使用 imports 对象（instantiateStreaming 函数的第二个参数）为 Wasm 模块提供任何内容。Wasm 模块可以访问 imports 对象内的所有内容，但无法访问其外部的任何内容。按照惯例，由 Emscripten 编译的模块需要加载 JavaScript 环境中的一些内容：

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