メインコンテンツまでスキップ

開発

このページでは、ローカルのチェックアウトから ShojiWM を実行し、性能を測定する方法を 解説します。コードベースの構成については アーキテクチャ概要 を参照してください。

ソースから実行する​

ローカルのチェックアウトからは --dev --tty で ShojiWM を実行します。2つのフラグは 独立していて、組み合わせて使います。

  • --dev は TypeScript 製の装飾ランタイムと設定をローカルリポジトリから読み込みます （/usr 配下のインストール済みコピーではなく）。これによりツリー内の変更が反映されます。 リポジトリのルートで実行する必要があります。
  • --tty は実機の TTY 上で DRM/KMS バックエンドを使います。デフォルトの winit バックエンドは現状不安定なので、--tty を推奨します。

空いている仮想端末（例: Ctrl+Alt+F3）に切り替えてログインし、リポジトリに cd してから 実行します。

cargo run -p shoji_wm -- --dev --tty

素の（デバッグ）ビルドはコンパイルが最速なので、機能を反復開発しているあいだはこれが 適しています。性能を測るときは --release でビルドしてください（後述）。

ビルドプロファイルと性能​

性能は必ず --release で測ること

デバッグビルドはリリースビルドより桁違いに遅く、しばしば 10 倍ほどの差があります。 デバッグビルドで得た性能値には意味がありません。性能を評価するときは必ず --release を 付けてください。

cargo run --release -p shoji_wm -- --dev --tty

プロファイリング​

ShojiWM は処理を2つのプロセスに分けています。Rust 製コンポジター（shoji_wm）と Node.js 製の装飾ランタイムです。ヘルパースクリプト tools/perf-top-functions.sh は、Linux の perf で両方をプロファイリングします。

  1. リリースビルドで ShojiWM を起動し、測定したい負荷をかけます。

  2. 実行中に、N 秒間（デフォルト 15）プロファイリングします。

    tools/perf-top-functions.sh 20

    スクリプトは shoji_wm と装飾ランタイムの PID を自動検出し、perf で記録して、 self タイムと inclusive のトップ 10 シンボルのレポートを書き出します（PIDS=<pid,pid> tools/perf-top-functions.sh のように対象を明示することもできます）。

注記

perf はカーネル設定の緩和が必要なことがあります（例: sudo sysctl kernel.perf_event_paranoid=1）。記録に失敗した場合は、スクリプトが 具体的な対処法を表示します。

Node.js の関数をシンボル化する​

デフォルトでは perf は装飾ランタイムの JIT コンパイルされた JavaScript をシンボル化 できないため、Node のフレームは生のアドレスとして表示されます。Node に perf シンボル マップを出力させるには、--decoration-runtime-node-arg を通して Node のフラグを渡して ShojiWM を起動します。

cargo run --release -p shoji_wm -- --dev --tty \
  --decoration-runtime-node-arg --perf-basic-prof-only-functions

その後、上記のとおり tools/perf-top-functions.sh を実行すると、装飾ランタイムの JavaScript 関数が名前付きでレポートに現れるようになります。