🦀

100日後にRustをちょっと知ってる人になる: [Day 21]Cargo による Wasm ビルド

2022/09/13に公開

Rust

WebAssembly

tech

Day 21 のテーマ

昨日は rustup で wasm32-wasi ターゲットを追加して、WASI の実装ランタイムな Wasmtime をインストールして、rustc でWasm バイナリをコンパイルしてみました。

これらの Rust に関するツールチェーンで昨日やり残していたことをやってみようと思います。Rust のツールチェーンといえば、以下のコマンドがトピックに出てきますよね。

rustup: Rust のツールチェーンマネージャ
- The rustup book
rustc: Rust コンパイラコマンド
cargo: Rust のパッケージマネージャ兼ビルドツール

あと、ツールチェーンと言った時に含まれるのは、次のものです:

Rust の標準ライブラリ (std)
Rust の API ドキュメント

さて、この標準のツールチェーンで提供されるビルドツールの cargo を使った Wasm の扱いについて確認していませんでした。今日は、その確認をしておきたいと思います。

Cargo を用いた Wasm ビルド

Cargo は先にも言ったように、パッケージマネージャ兼ビルドツールです。つまり、Java で使う Maven や Gradle と考えるととても分かりやすいですね（Java 経験者の人には)

Cargo コマンド

ここで改めて Cargo コマンドの概要を見ておこうと思います。

The Cargo Book

cargo -h

以下が標準では言っている cargo のサブコマンドです。

コマンド	説明
build	現在のパッケージのコンパイル
check	現在のパッケージを解析してエラーを報告するが，オブジェクトファイルはビルドしない
clean	ターゲットディレクトリを削除
doc	現在のパッケージとその依存関係のドキュメントをビルド
new	新しいCargoパッケージを作成
init	既存のディレクトリに新しいCargoパッケージを作成
add	マニフェストファイルへの依存関係の追加
run	ローカルパッケージのバイナリやサンプルを実行
test	テストの実行
bench	ベンチマークを実行
update	Cargo.lockにリストされている依存関係を更新
search	レジストリを検索してクレートの発見
publish	パッケージを作成し、このパッケージをレジストリにアップロード
install	Rust バイナリのインストール。デフォルトのインストール先は $HOME/.cargo/bin
uninstall	Rust バイナリのアンインストール

Cargo によるビルドは、cargo build で行います。このサブコマンドのコマンドオプションを見て見ると、rustc のコマンドオプション同様に --target オプションでターゲットトリプルを指定しています。つまりここで、wasm32-wasi を指定したら WebAssembly バイナリが生成できそうです。

cargo build -h

USAGE:
    cargo build [OPTIONS]

OPTIONS:
  :
        --target <TRIPLE>           Build for the target triple
  :

cargo build --target wasm32-wasi

cargo で Wasm バイナリのビルドをおこなってみます。

プロジェクトの作成

cargo new hello-wasm

cargo build --target wasm32-wasi

   Compiling hello-wasm v0.1.0 (/Users/yanagiharas/hello-wasm)
    Finished dev [unoptimized + debuginfo] target(s) in 0.83s

問題なくビルドが成功しました。そして、プロジェクトルートディレクトリに target ディレクトリが作られて成果物が以下のように生成されました。
ただし、以下の成果物の構成はデバッグ構成になっています。

target
├── CACHEDIR.TAG
├── debug
│  ├── build
│  ├── deps
│  ├── examples
│  └── incremental
└── wasm32-wasi
   ├── CACHEDIR.TAG
   └── debug
      ├── build
      ├── deps
      │  ├── hello_wasm-65874ca78a0b301f.d
      │  └── hello_wasm-65874ca78a0b301f.wasm
      ├── examples
      ├── hello-wasm.d
      ├── hello-wasm.wasm
      └── incremental
         └── hello_wasm-2gw1w9gjhbk0a
            ├── s-gdi3zdm6q6-rmj19w-1i7jph7a5jnjr
            │  ├── 1n6ltkmxf9v4hy1w.o
            │  ├── 2nju6fzobyf20ku7.o
            │  ├── 3i1fz70rutg39zgl.o
            │  ├── 37cam6tyso17g9op.o
            │  ├── 312qucrovy5m0gyp.o
            │  ├── 590sdpwwj3c6vwum.o
            │  ├── dep-graph.bin
            │  ├── lhqlb4oipl2go0q.o
            │  ├── query-cache.bin
            │  └── work-products.bin
            └── s-gdi3zdm6q6-rmj19w.lock

Wasm のビルドに限ったことではないですが、cargo build コマンドでリリース用に最適化された正式版なビルドイメージを作る場合は --release オプションをつけてビルドを行います。

cargo build --target wasm32-wasi --release

以下のような構成でビルド成果物ができあがります。
そして target/wasm32-wasi/release/ ディレクトリに Wasm バイナリが生成されています。

target
├── CACHEDIR.TAG
├── release
│  ├── build
│  ├── deps
│  ├── examples
│  └── incremental
└── wasm32-wasi
   ├── CACHEDIR.TAG
   └── release
      ├── build
      ├── deps
      │  ├── hello_wasm-c09de2197fb2142c.d
      │  └── hello_wasm-c09de2197fb2142c.wasm
      ├── examples
      ├── hello-wasm.d
      ├── hello-wasm.wasm
      └── incremental

以下のように実行できました。

$ wasmtime hello-wasm.wasm

Hello, world!

cargo-wasi を用いた Wasm ビルド

ここまでは、cargo build コマンドの --target オプションを使ってのビルドを行ってきました。
次に cargo に WabAssembly ビルド用のサブコマンド cargo-wasi を追加してみます。

The cargo-wasi Subcommand

このサブコマンドは、wasm32-wasi をターゲットとして Rust コードをビルドし、実行するためのデフォルトセットを提供するコマンドです。

cargo-wasi コマンドのインストール

cargo install コマンドを使って cargo-wasi をインストールします。

cargo install cargo-wasi

cargo-wasi

    Updating crates.io index
  Downloaded cargo-wasi v0.1.26
  Downloaded 1 crate (13.7 KB) in 1.50s
  Installing cargo-wasi v0.1.26
  Downloaded cargo-wasi-exe-x86_64-apple-darwin v0.1.26
  Downloaded 1 crate (2.1 MB) in 3.52s
   Compiling cfg-if v1.0.0
   Compiling cargo-wasi-exe-x86_64-apple-darwin v0.1.26
   Compiling cargo-wasi v0.1.26
    Finished release [optimized] target(s) in 33.94s
  Installing /Users/yanagiharas/.cargo/bin/cargo-wasi
   Installed package `cargo-wasi v0.1.26` (executable `cargo-wasi`)

サブコマンドが追加されていました。

$ cargo --list

Installed Commands:
 :
    wasi
 :

cargo wasi のコマンドヘルプを見てみます。見た限りだと --target wasm32-wasi をラップしているコマンドのようです。

cargo wasi --help

cargo-wasi
Compile and run a Rust crate for the wasm32-wasi target

USAGE:
    cargo wasi build [OPTIONS]
    cargo wasi run [OPTIONS]
    cargo wasi test [OPTIONS]
    cargo wasi bench [OPTIONS]
    cargo wasi check [OPTIONS]
    cargo wasi fix [OPTIONS]
    cargo wasi self clean
    cargo wasi self update-check

All options accepted are the same as that of the corresponding `cargo`
subcommands. You can run `cargo wasi build -h` for more information to learn
about flags that can be passed to `cargo wasi build`, which mirrors the
`cargo build` command.

というわけで、run と build をしてみます。

cargo wasi run

$ cargo wasi run

   Compiling hello-cargo-wasi v0.1.0 (/Users/yanagiharas/Works/docs/doc-to-zenn/codes/hello-cargo-wasi)
    Finished dev [unoptimized + debuginfo] target(s) in 1.55s
     Running `/Users/yanagiharas/.cargo/bin/cargo-wasi target/wasm32-wasi/debug/hello-cargo-wasi.wasm`
     Running `target/wasm32-wasi/debug/hello-cargo-wasi.wasm`
Hello, world!

cargo wasi build

$ cargo wasi build

    Finished dev [unoptimized + debuginfo] target(s) in 0.00s

cargo wasi build --release

$ cargo wasi build --release

   Compiling hello-cargo-wasi v0.1.0 (/Users/yanagiharas/Works/docs/doc-to-zenn/codes/hello-cargo-wasi)
    Finished release [optimized] target(s) in 0.17s
  Optimizing with wasm-opt
 Downloading precompiled wasm-opt version_109

ビルドする途中で wasm-opt を使って最適化しているのが分かりました。
この最適化ツールが使われることで、LLVM の生の出力よりも 10 ～ 20% のサイズ削減 が行われるようです。

wasm-opt

自動的にこのような設定が入っているところを見ても、Rust での Wasm/WASI 用のビルドは Cargo で実施するのもいいかなと思いました。

Day 21 のまとめ

今日は Cargo コマンドを使って Wasm ビルドを行う方法を調べてみました。
プロジェクトの作成管理からテスト、ビルドまでできる Cargo コマンドで Wasm バイナリの生成までできるのはとても便利だと思いました。何か不都合も今の所感じなかったので、Rust のビルド管理は Cargo コマンドでの操作に寄せて思います。

GitHubで編集を提案