0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

opencascadeをwasm32-unknown-unknownでビルドする技術【RustでCAD】

0
Posted at

C++製のCADカーネル OpenCASCADE (OCCT) を wasm32-unknown-unknown 向けにビルドし、Rustから操作してブラウザだけでCADを完結させる話です。STEPファイルを選ぶと、サーバーに何も投げずにブラウザ内で GLB に変換して3D表示します。

img

この記事は「動かす手順」よりも、wasm32-unknown-unknown でOCCTを通そうとすると次々に出てくる鬼門と、その回避策に重点を置きます。これらの定型作業をまとめて引き受けてくれるのが自作の cadrum クレートで、その内部が何をしているかにも踏み込みます。

TL;DR

wasm32-unknown-unknown でOCCTを動かすには、最低限これらを全部そろえる必要があります。

  1. wasi-sdk の clang + sysroot でC++をクロスコンパイルする(wasm32-unknown-unknown には標準ライブラリもsysrootも無い)
  2. C++グローバルコンストラクタ (__wasm_call_ctors) を手動で呼ぶ (呼ばないとOCCTの型テーブルが初期化されず初回呼び出しで trap)
  3. wasm例外処理 (exnref EH) を有効化する (OCCTはC++例外を投げる)
  4. wasm-opt / wasm-bindgen に新機能 (exnref / reference-types / bulk-memory) を理解させる

cadrum クレートと、そのクロスビルド用Dockerイメージ ghcr.io/lzpel/cross-wasm32-unknown-unknown が 1 と 4 のツールチェイン部分をまるごと用意します。

なぜ wasm32-unknown-unknown が鬼門なのか

WebAssemblyのターゲットには大きく2系統あります。

  • wasm32-wasi(現 wasm32-wasip1): WASI のsysroot・libc・ファイルシステム抽象が前提。ランタイム(wasmtime等)かポリフィルが要る。
  • wasm32-unknown-unknown: 何も無い。OSもlibcもsysrootも無い、純粋なブラウザ向けwasm。

ブラウザに <model-viewer> で出したいだけなのに WASI ランタイムを挟みたくない、という理由で後者を選ぶと、OCCTのような巨大なC++ライブラリを「libc/sysrootが存在しない世界」へ持ち込むことになります。ここから鬼門が始まります。

ハマり①: C++グローバルコンストラクタが走らない

wasm32-unknown-unknown の cdylib/bin は --no-entry でリンクされるため、C++のグローバルコンストラクタ(OCCTの型テーブルを初期化するやつ)を走らせる __wasm_call_ctors が自動では呼ばれません。結果、最初のOCCT呼び出しでいきなり trap します。

解決は「自分で一度だけ __wasm_call_ctors() を呼ぶ」こと。最新のcadrumではこのctor直書きが正式な推奨スタイルです

/// Run OCCT's C++ global constructors. wasm32-unknown-unknown cdylib/bin links
/// with `--no-entry`, so the ctors that initialize OCCT's type tables are not run automatically; 
fn init_occt() {
	cadrum::__anchor_wasi_stub();
	extern "C" {
		fn __wasm_call_ctors();
	}
	unsafe { __wasm_call_ctors() };
}

src/main.rs

ポイントは2つ。

  • __wasm_call_ctors()extern "C" で引っ張ってきて、起動時に一度だけ unsafe で呼ぶ。
  • cadrum::__anchor_wasi_stub() を呼ぶことで、wasm32-unknown-unknown に存在しないWASI由来のシンボルを埋めるスタブをリンクから落とされないようアンカーする。

ハマり②: C++例外 = wasm例外処理 (exnref)

OCCTは内部でC++例外を投げます。これをwasmで成立させるには wasm exception-handling(exnref EH) を有効にしてビルドする必要があります。そしてこの exnref EH が、次に挙げる wasm-opt / wasm-bindgen 側の対応(ハマり③)を芋づる式に要求してきます。

ハマり③: wasm-opt が新機能を理解せず弾く

exnref EH を使ったwasmは、reference-typesbulk-memory といった比較的新しいwasm機能も巻き込みます。ここでwasm-opt(binaryen)が既定設定だと検証で落ちます。try_table requires exception-handling のようなエラーで止まるのが典型です。

このexampleはビルドに Trunk を使っていて、index.html のリンクタグに属性で指定します。

<!-- Build this crate to wasm.
     - data-wasm-opt="z": run wasm-opt (binaryen) with size optimization.
     - data-wasm-opt-params="-all": the OCCT/cadrum module uses wasm
       exception-handling (exnref), reference-types and bulk-memory; enable
       all features so wasm-opt validates/optimizes it instead of rejecting
       `try_table requires exception-handling`.
     - data-reference-types="true": the module already enables wasm
       reference-types (via exnref EH), so wasm-bindgen must use the
       externref table for the Result<_, JsValue> catch wrappers. -->
<link data-trunk rel="rust" data-wasm-opt="z" data-wasm-opt-params="-all" data-reference-types="true" />

index.html

3つの属性の意味:

  • data-wasm-opt="z": wasm-opt をサイズ最適化(-Oz相当)で走らせる。
  • data-wasm-opt-params="-all": 全wasm機能を有効化して wasm-opt に渡す。exnref/reference-types/bulk-memory を理解させ、「未知の命令なので拒否」を防ぐ。
  • data-reference-types="true": モジュールがすでに reference-types を有効にしているので、wasm-bindgen も externref テーブルを使うよう指示。Result<_, JsValue> の catch wrapper がこれに乗る。

ハマり④: ツールチェイン (wasi-sdk clang + sysroot)

ここまでの話は、そもそも C++を wasm32-unknown-unknown 向けにコンパイルできる前提で成り立っています。その前提を満たすのが wasi-sdk の clang + sysroot で、Rust/cc側に大量の環境変数をそろえる必要があります。CC / CXX / CFLAGS / CXXFLAGS / RUSTFLAGS / CARGO_BUILD_TARGET …といった具合です。

これを手で全部そろえるのは現実的ではないので、cadrum はプリセット済みのクロスビルド用Dockerイメージを公開しています。

# cadrum's published cross image: wasi-sdk clang + sysroot and every wasm32 env
# var (CC/CXX/CFLAGS/CXXFLAGS/RUSTFLAGS, CARGO_BUILD_TARGET=wasm32) preset.
CROSS_IMAGE ?= ghcr.io/lzpel/cross-wasm32-unknown-unknown:latest

Makefile

このイメージの中でビルドすれば「wasi-sdk のセットアップ」を意識せずに済む、というのが肝です。

cadrumが内部でやっていること

ここまでの①〜④をライブラリ+イメージとして定型化したのが cadrum です。このexampleでは crates.io 版をsemverで固定して使っています。

# cadrum from crates.io, pinned by semver (^0.8 — cadrum's own README
# recommendation). Cargo.lock is committed for reproducible builds. Default
# features (color/png) match the known-good build.
cadrum = "^0.8"

Cargo.toml

READMEとMakefileから読み取れる範囲で、cadrumがやっていることは次の通りです。

  • OCCTのprebuilt(C++)をリンクし、小さなC++ブリッジを cc でコンパイルして wasm32-unknown-unknown 向けに橋渡しする。
  • WASI由来シンボルのスタブをアンカーする cadrum::__anchor_wasi_stub() を提供する。
  • ツールチェイン(ハマり④)を ghcr.io/lzpel/cross-wasm32-unknown-unknown イメージとして提供する。wasi-sdk clang + sysroot と全wasm32環境変数がプリセットされているとされる。
fn main() {
	init_occt();
	// In the browser a window exists and we build the UI. Under Node (the
	// headless smoke test) `window()` is None, so we return without touching
	// the DOM and the test calls `chijin_glb()` directly.
	if web_sys::window().is_some() {
		build_ui().expect("failed to build UI");
	}
}

src/main.rs

実装: STEP → GLB をブラウザ内で

ビルドが通れば、あとはRustのCADコードがそのままブラウザで動きます。UIは三層構成です。

  • Trunk(--target web)でwasm化。npmもバンドラも使わない。
  • web-sys でDOMを直接組み立てる(<h1>、ファイル入力、<model-viewer>)。
  • Google <model-viewer> をCDNから読み込み、GLBを表示。three.jsもnpm依存も無し。

中核の変換はこれだけです。STEPバイトを読み、メッシュ化し、GLB(バイナリglTF)として書き出す。

/// Convert STEP bytes to a binary glTF (GLB) entirely in-memory.
/// STEP -> Vec<Solid> -> Mesh -> GLB bytes.
#[wasm_bindgen]
pub fn step_to_glb(step: &[u8]) -> Result<Vec<u8>, JsValue> {
	let mut reader = Cursor::new(step);
	let solids = Solid::read_step(&mut reader)
		.map_err(|e| JsValue::from_str(&format!("read_step: {e:?}")))?;
	let mesh = Solid::mesh(solids.iter(), Default::default())
		.map_err(|e| JsValue::from_str(&format!("mesh: {e:?}")))?;
	let mut out: Vec<u8> = Vec::new();
	mesh.write_gltf_binary(&mut out)
		.map_err(|e| JsValue::from_str(&format!("gltf: {e:?}")))?;
	Ok(out)
}

src/main.rs

ファイルが選ばれたら、FileArrayBuffer 経由でバイト列にして step_to_glb に渡し、結果のGLBをBlob→object URLにして <model-viewer src> に差し込みます。

async fn convert_file(file: &web_sys::File) -> Result<Vec<u8>, JsValue> {
	let buf = wasm_bindgen_futures::JsFuture::from(file.array_buffer()).await?;
	let bytes = js_sys::Uint8Array::new(&buf).to_vec();
	step_to_glb(&bytes)
}

/// Wrap GLB bytes in a Blob and return an object URL for `<model-viewer src>`.
fn glb_object_url(glb: &[u8]) -> Result<String, JsValue> {
	let parts = js_sys::Array::new();
	parts.push(&js_sys::Uint8Array::from(glb));
	let blob = web_sys::Blob::new_with_u8_array_sequence(&parts)?;
	web_sys::Url::create_object_url_with_blob(&blob)
}

src/main.rs

なお初期表示は、STEPファイルを同梱せずサンプルCADモデルをその場で生成して見せています。シリンダー本体・回転掃引したドラムヘッド・20個のレインボー編み込みブロックを、ブール演算で組み上げる例です。

ビルド & デプロイ

ビルドは「クロスイメージの中で make deploy を回す」のを make deploy-cross でラップしています。

.PHONY: deploy
deploy:
	unset CARGO_BUILD_TARGET; cargo install --locked --root ./target trunk
	./target/bin/trunk build --release --public-url "$(PUBLIC_URL)"

.PHONY: deploy-cross
deploy-cross:
	MSYS_NO_PATHCONV=1 docker run --rm -v "$(PWD)":/src -w /src -e CARGO_TARGET_DIR=/tmp/target $(CROSS_IMAGE) make deploy

Makefile

細かいが効くポイント:

  • Trunkはイメージに入っていないので ./target/bincargo install する。マウントされた作業ツリー上に置くので、再ビルド時は同バージョンならno-opで再利用される。
  • イメージは CARGO_BUILD_TARGET=wasm32... をプリセットしているため、Trunk自体のインストール時だけ unset してホスト向けにビルドさせる。
  • MSYS_NO_PATHCONV=1 は Git-Bash/MSYS がコンテナ内パス(/src, /tmp/target)をWindowsパスに書き換えるのを止める(Linux/CIでは無害なno-op)。
  • CARGO_TARGET_DIR=/tmp/target でビルド成果物をマウント外に逃がし、root所有の target/ を作業ツリーに残さない。

CIはGitHub Actionsで、make deploy-cross の成果物 dist/ をそのままGitHub Pagesへ公開します。

- name: Build wasm site (make deploy-cross)
  run: make deploy-cross

.github/workflows/deploy.yml

まとめ

wasm32-unknown-unknown でOpenCASCADEを動かす要点は、結局この4つに集約されます。

  1. wasi-sdk clang + sysroot でC++をクロスコンパイルする
  2. __wasm_call_ctors を手動で呼ぶ(グローバルコンストラクタ問題)
  3. exnref EHを有効化する(OCCTのC++例外をwasmで成立させる)
  4. wasm-opt / wasm-bindgen に exnref / reference-types / bulk-memory を理解させる

これらは個別に踏むと相当に消耗しますが、cadrum クレートとそのクロスイメージがまとめて引き受けてくれるので、利用側は起動時にctorを直書きで1回呼ぶ(最新cadrumの推奨スタイル。旧 wasm_start! マクロは廃止)だけで、あとは普通のRust CADコードがブラウザで走ります。

タグ: Rust WebAssembly OpenCASCADE CAD wasm

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?