透过网络来访问使用了 Web­Assembly 程序的网页时,愈小的 Web­Assembly 程序会让网页的加载速度更快,也会让用户体验更好。这篇文章整理了一些造成 Web­Assembly 程序肥大的原因,以及能使 Web­Assembly 程序缩小的方式。

查看 Web­Assembly 程序的大小

查看 Web­Assembly 程序大小的最简单方式,当然就是直接去看 .wasm 文件的大小啦!在 Linux 操作系统下,可以用以下指令来查看某个文件的大小。

wc -c /path/to/file

wc 指令可以用来计算文件内容的行数、字数、大小等等。-c 参数表示要让 wc 计算文件大小。

以 wc -c 查看 .wasm 文件的大小

只不过光看 .wasm 文件的大小并无法分析出 Web­Assembly 程序肥大的原因,所以最好还是搭配其它的工具来查看大小比较好。twiggy 是一个用 Rust 编程语言开发的指令工具,可以用来分析 .wasm 文件的大小。可以直接运行以下指令来安装:

cargo install twiggy

若要找出 Web­Assembly 程序中,各个函数的大小,可以运行以下指令:

twiggy top /path/to/wasm-file

twiggy 就会由大到小,把 Web­Assembly 程序中的函数输出。

以 twiggy top 列出各函数的大小

如果觉得输出的函数太多了,会看到眼花撩乱的话,可以在指令中加上 -n 参数,再接上一个数值,来设置最多要输出几个函数。例如要限制只输出前 10 大的函数,指令如下:

twiggy top -n 10 /path/to/wasm-file

只输出前 10 大函数的 twiggy top

在这边有两个名词需要解释一下,一个是「Shallow Size」,一个是「Retained Size」。前者是单一函数本身的大小,后者是函数本身的大小,再加上所有只能透过它才会被调用到的其它函数的大小,也就是移除这个函数之后能够一起省下的大小。twiggy 预设是显示「Shallow Size」,如果要改显示「Retained Size」的话,可以加上 --retained 参数。

加上 --retained 显示 Retained Size

如果我们正在优化 Web­Assembly 程序的大小,也可以利用 twiggy 来判断两个(修改前和修改后的).wasm 文件的大小差异。指令如下:

twiggy diff /path/to/old-wasm-file /path/to/new-wasm-file

以 twiggy diff 比较两个 .wasm 文件

这种指令预设只会显示差异最大的前 20 个函数,如果要修改这个限制值的话,可以在指令中加上 -n 参数,再接上一个数值。例如要限制只输出前 10 大的函数,指令如下:

twiggy diff -n 10 /path/to/old-wasm-file /path/to/new-wasm-file

会让 Web­Assembly 程序的大小显著增加的代码

有些代码,可能只写了一行就会让 Web­Assembly 程序大小剧烈增加。底下会以第一章的 Hello World 程序为基准,来说明加了哪些特定代码后,会让 Web­Assembly 程序变肥。

我们的 Hello World 程序的 .wasm 文件的大小为 2296 个字节。

format! 等用来格式化字符串的宏

format!、println! 等宏最好不要用在 Web­Assembly 程序中,如果我们试着将 Hello World 程序修改为:

...

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    greet_inner("world");
}

fn greet_inner(target: &str) {
    alert(format!("Hello, {target}").as_str());
}

...

以上程序,编译出来的 .wasm 文件的大小为 21836 个字节,几乎是原先的 10 倍!

为什么会这样呢?透过 twiggy diff 指令来分析两个 .wasm 文件的差异,可以发现 Web­Assembly 程序中多了很多 panic 和 dlmalloc 相关的东西。dlmalloc 是 Rust 编程语言预设的分配器。

多出 panic 与 dlmalloc 的差异

既然如此,您可能会想问:那么改用 wee_alloc 的话,会如何呢?

改用 wee_alloc 后的 .wasm 大小

改用 wee_alloc 的话,编译出来的 .wasm 文件的大小为 18117 个字节,虽然小了一些,但还是太大了!

因此,我们应该要避免使用格式化字符串的宏来处理字符串。那如果我们将这个程序优化成如下的样子呢?

...

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    greet_inner("world");
}

fn greet_inner(target: &str) {
    let mut s = String::from("Hello, ");

    s.push_str(target);

    alert(s.as_str());
}

...

dlmalloc 编译出来的大小为 21053 个字节;wee_alloc 编译出来的大小为 17503 个字节。是会比直接用 format! 宏还要小没错,但并没有很明显。

那该怎么做才不会让 Web­Assembly 程序一下子增大那么多呢?其实这个没有什么好方法能解决,只要有在程序中做到配置(allocate)内存的动作,分配器的代码就会被大量编译进 Web­Assembly 程序中,这个只能说是 Web­Assembly 程序的基本开销。

不过我们也不用过度担心,字符串处理的基本门槛过了之后,Web­Assembly 程序的大小就不会增加那么快了。例如以下程序:

...

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    greet_inner("world");
}

fn greet_inner(target: &str) {
    let mut s = String::from("Hello, ");

    s.push_str(target);

    alert(s.as_str());

    let mut s = String::from("Hi, ");

    s.push_str(target);

    alert(s.as_str());

    let mut s = String::from("Magic ");

    s.push_str(target);

    alert(s.as_str());
}

...

以上程序,dlmalloc 编译出来的大小为 21250 个字节;wee_alloc 编译出来的大小为 17390 个字节。虽然多了两倍的字符串处理量,但程序大小并没有增长太多。

但是,如果是重复使用格式化字符串的宏来处理字符串的话,程序大小的增长会更明显一些。

...

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    greet_inner("world");
}

fn greet_inner(target: &str) {
    alert(format!("Hello, {target}!").as_str());
    alert(format!("Hi, {target}!").as_str());
    alert(format!("Magic {target}!").as_str());
}

...

以上程序,dlmalloc 编译出来的大小为 22192 个字节;wee_alloc 编译出来的大小为 18457 个字节。

所以如果一定要做字符串处理的话,最好还是避免使用格式化字符串的宏啦!如果为了调试(Debug)方便,还是要用的话,就限定在非 Release 的模式下用吧!

panic

会让程序发生 panic 的代码也尽量不要撰写。其实在上一个小节介绍字符串时,我们就可以在 twiggy diff 指令的输出结果中,看到名列前茅的项目有很多是跟 panic 有关的。

如果我们试着将 Hello World 程序修改为:

...

#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

#[wasm_bindgen]
pub fn greet() {
    panic!();
}

...

以上程序,dlmalloc 编译出来的大小为 18295 个字节;wee_alloc 编译出来的大小为 14560 个字节。

panic! 版本以 wee_alloc 编译后的 twiggy diff

当然,若使用到 Option 或是 Result 枚举的 unwrap 相关方法,背后也是一样会去用到 panic! 宏。如果我们真的不想要在 Web­Assembly 程序中加上 panic 相关的代码,就把有用到 unwrap 相关方法的地方,都改用如下的函数:

#[inline]
fn option_unwrap_abort<T>(o: Option<T>) -> T {
    use std::process;
    match o {
        Some(t) => t,
        None => process::abort(),
    }
}

#[inline]
fn result_unwrap_abort<T, E>(r: Result<T, E>) -> T {
    use std::process;
    match r {
        Ok(t) => t,
        Err(_) => process::abort(),
    }
}

不过也并不是只有调用到 panic! 宏才会有 panic 程序。取得数组元素或是切片的时候,也是有机会让程序发生 panic,甚至做整数除法运算的时候也会有(除以 0)!

要完全摆脱 panic 程序并不是一件容易的事情,这个也可以说是 Web­Assembly 程序的基本开销。

泛型

在本站的《Rust 学习之路》系列文章中的面向对象章节,有提到泛型其实是在做「静态调度」(Static dispatch),编译器在编译程序时会自动把有泛型定义的项目解开。所以一个泛型的项目,实际上可能会有很多个不同的版本,这个就会导致 .wasm 文件的大小增加啦!

所以为了让相同的结构体、函数等项目能够被重复使用,进而减少 WebAssembly 程序的大小,可以改用「动态调度」(Dynamic dispatch)的方式来传递数据。

可能可以让 Web­Assembly 程序变小的方法

激活 LTO (Link Time Optimization)并修改编译器优化等级

参考这篇文章来了解 LTO 和编译器优化等级:

可以试着激活 LTO 并将编译器优化等级设为 s 或是 z 来缩小编译出来的 Web­Assembly 程序。

WebAssembly Binary Toolkit (WABT)的 wasm-strip

如果您有注意去看 twiggy top 指令的输出结果,那么应该会发现「"function names" subsection」总是名列前茅,而且榜单上可能还会夹杂着几个「custom section "xxxx"」。这些到底是什么东东?

「Custom Section」是 .wasm 文件的某段内容,用来存放调试时能提供给人类阅读的信息,像是模块名称、函数名称、变量名称等等。就如同原生(native)程序可以用 strip 指令工具来去除掉这些调试信息一样,WebAssembly 也有类似的工具能用。

WebAssembly Binary Toolkit 是用 C++ 开发的开源工具包,其提供的 wasm-strip 指令工具可以用来移除 .wasm 文件中的「Custom Section」。

可以利用以下链接打开 WABT 的 GitHub 的 Release 页面,下载官方已经替不同平台编译好的可执行文件,其中就包含 wasm-strip 的可执行文件。

若要使用 wasm-strip 来将 .wasm 文件瘦身,指令的用法如下:

wasm-strip /path/to/webassembly-file

以 wasm-strip 瘦身后的 twiggy diff

Binaryen 的 wasm-opt 指令工具

Binaryen 是用 C++ 开发的开源 WebAssembly 工具包,其提供的 wasm-opt 指令工具可以用来优化 .wasm 文件。

可以利用以下链接打开 Binaryen 的 GitHub 的 Release 页面,下载官方已经替不同平台编译好的可执行文件,其中就包含 wasm-opt 的可执行文件。

若要使用 wasm-opt 来优化 .wasm 文件,指令的用法如下:

wasm-opt -O[0|1|2|3|4|s|z] /path/to/input-wasm-file -o /path/to/output-wasm-file

-O 参数表示要对 .wasm 文件做优化,其后可以再接上一个字符来决定优化的等级。0 表示不优化;1~4 数字愈高表示要激活愈多的优化方式;s 表示要针对文件大小作优化;z 表示要比 s 还更针对文件大小作优化。默认值为 s。

如果我们 twiggy diff 一下优化前后的差异,会发现 wasm-opt 其实也有去删除「Custom Section」。

以 wasm-opt 优化后的 twiggy diff

所以用 wasm-opt 就不需要用 wasm-strip 了吗?其实也并非如此,如果再注意看的话,会发现 wasm-opt 和 wasm-strip 清出来的「Custom Section」相关项目还是有些小差异。

笔者是建议先用 wasm-strip 后再用 wasm-opt,因为 wasm-opt 不一定能成功……

总结

虽然这整个章节都在讲 Web­Assembly 程序的大小,但笔者还是觉得它仍然是个大问题。即便有能够优化 Web­Assembly 程序的外部工具,但不见得能适用在所有的 Web­Assembly 程序上,这是蛮可惜的地方。不过还是希望以后用 Rust 编程语言开发 Web­Assembly 程序可以不需要借助外部工具就能够把程序优化到好,不然实在是有点麻烦呀!

这个系列的文章就到这里为止了,姑且不论 Web­Assembly 程序的大小,用 Rust 编程语言开发 Web­Assembly 程序算是非常方便的,而且也容易维护。早期笔者有玩过一点点的 asm.js,它算是 Web­Assembly 的前身,那个时候还不知道它可以用来做什么,就只是把自己以前写的 C 语言程序用 Emscripten 转一转后在网页浏览器上运行,然后觉得新奇、很酷。完全没想到发展到现在,Web­Assembly 可以做到这么多事,而且还能够用很多种高级编程语言来写呢!