<p>ひょんなことからAndroid Open Source Project（AOSP）をビルドしてみる機会があったのですが、ビルド要件に合うLinuxマシンをすぐに用意できませんでした。この記事はありもので試行錯誤してAOSPをビルドしてエミュレータを動かすまでやってみたログです。</p>
<p>結論から言うと、所持していたWindows 11マシンのWSL2でエミュレータを動かすことができました。エミュレータ自体もWindowsではなくLinux上で動かしたのですが、想像以上に動作がサクサクしていて実用に耐えそうだったので記事にしてみました。AOSPのビルドとWSL2の実用性を確かめた謎記事になっています。</p>
<h1 id="aosp%E3%81%AE%E3%83%93%E3%83%AB%E3%83%89%E8%A6%81%E4%BB%B6">
<a class="header-anchor-link" href="#aosp%E3%81%AE%E3%83%93%E3%83%AB%E3%83%89%E8%A6%81%E4%BB%B6" aria-hidden="true"></a> AOSPのビルド要件</h1>
<p>ビルド<a href="https://source.android.com/setup/build/requirements?hl=ja" target="_blank" rel="nofollow noopener noreferrer">要件</a>ですが、ハードウェアとしてはハイスペックなマシンが求められます。</p>
<ul>
<li>ディスク容量: コードのチェックアウト用に250GB以上、ビルド用に追加で150GB</li>
<li>メモリ: 16GB以上（64GB以上を推奨）</li>
</ul>
<blockquote>
<p>2021 年 6 月現在、Google 内部では 64 GB の RAM を搭載した 72 コアのマシンを使用しています。この構成でフルビルドにかかる時間は約 40 分です（増分ビルドの場合は、変更されたファイル数にもよりますが、ほぼ数分で完了します）。一方、RAM 容量が同じ 6 コアマシンでは、この作業に 3 時間かかります。</p>
</blockquote>
<p>とあるので、AOSPの巨大さが伺えます。OSは Ubuntu LTSが推奨されていますが、適当なLinuxがあればなんとかなりそうです。</p>
<p>筆者は普段Macを使用しているのですが、ゲーム用途でWindowsマシンも所持していたので、それでビルドを試してみました。筆者のマシンは以下です。</p>
<ul>
<li>OS: Windows 11 Proビルド22000.556</li>
<li>CPU: Ryzen 5 5600X（6コア、12スレッド）</li>
<li>RAM: 64GB</li>
<li>SSD: 1TB</li>
</ul>
<p>CPUにグラフィック機能がないので、一応グラボを搭載してますが、ビルドには関係ないと思っています。物理マシンとして上記を用意しましたが、WSL2でビルドしているので、スペックは上限だと考えてください（実際に割り当てたリソースはもっと小さいです）。</p>
<h1 id="wsl2%E3%81%A7ubuntu%E3%82%92%E3%82%BB%E3%83%83%E3%83%88%E3%82%A2%E3%83%83%E3%83%97">
<a class="header-anchor-link" href="#wsl2%E3%81%A7ubuntu%E3%82%92%E3%82%BB%E3%83%83%E3%83%88%E3%82%A2%E3%83%83%E3%83%97" aria-hidden="true"></a> WSL2でUbuntuをセットアップ</h1>
<p>WSL 自体のインストールは割愛します。公式の<a href="https://docs.microsoft.com/ja-jp/windows/wsl/install" target="_blank" rel="nofollow noopener noreferrer">ドキュメント</a>あたりを参考にしてください。</p>
<h2 id="ubuntu%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">
<a class="header-anchor-link" href="#ubuntu%E3%81%AE%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> Ubuntuのインストール</h2>
<p>Windows Terminalで以下のコマンドを打てばインストールできます。</p>
<div class="code-block-container"><pre><code>wsl --install -d Ubuntu-18.04
</code></pre></div><p>LTSとしては20.04もあるのですが、<a href="https://source.android.com/setup/build/initializing?hl=ja" target="_blank" rel="nofollow noopener noreferrer">ビルド環境の構築</a>に書いてあるのが18.04だったので合わせました。多分あまり変わらないと思います。</p>
<h2 id="wsl-vm%E3%81%B8%E3%81%AE%E3%83%AA%E3%82%BD%E3%83%BC%E3%82%B9%E5%89%B2%E3%82%8A%E5%BD%93%E3%81%A6%E8%A8%AD%E5%AE%9A">
<a class="header-anchor-link" href="#wsl-vm%E3%81%B8%E3%81%AE%E3%83%AA%E3%82%BD%E3%83%BC%E3%82%B9%E5%89%B2%E3%82%8A%E5%BD%93%E3%81%A6%E8%A8%AD%E5%AE%9A" aria-hidden="true"></a> WSL VMへのリソース割り当て設定</h2>
<p>インストールしただけだと、ディスクやメモリなどのリソースをフルで使うことができません。デフォルトではWSL2の仮想ハードディスクは最大256GBに制限されています。ドキュメント（<a href="https://docs.microsoft.com/ja-jp/windows/wsl/vhd-size" target="_blank" rel="nofollow noopener noreferrer">WSL 2 仮想ハード ディスクのサイズを拡張する</a>）に従って仮想ハードディスクを拡張する必要があります。筆者は500GBをWSLに割り当てました。メモリは筆者の環境では32GBが割り当てられていたので、このまま進めてみることにしました。</p>
<p><a href="https://docs.microsoft.com/ja-jp/windows/wsl/wsl-config#configuration-setting-for-wslconfig" target="_blank" rel="nofollow noopener noreferrer">WSL の詳細設定のドキュメント</a>にはWSL2 VMへのメモリの割り当てに関して、</p>
<blockquote>
<p>Windows の合計メモリの 50% または 8 GB のどちらか少ない方。20175 より前のビルドでは、Windows の合計メモリの 80%</p>
</blockquote>
<p>と記述があるのですが、筆者の場合50%が割り当てられていました。変更する場合は<a href="https://docs.microsoft.com/ja-jp/windows/wsl/wsl-config#example-wslconfig-file" target="_blank" rel="nofollow noopener noreferrer">wslconfigという設定ファイル</a>で設定します。</p>
<h2 id="%E3%83%93%E3%83%AB%E3%83%89%E3%81%AB%E5%BF%85%E8%A6%81%E3%81%AA%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">
<a class="header-anchor-link" href="#%E3%83%93%E3%83%AB%E3%83%89%E3%81%AB%E5%BF%85%E8%A6%81%E3%81%AA%E3%83%91%E3%83%83%E3%82%B1%E3%83%BC%E3%82%B8%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> ビルドに必要なパッケージをインストール</h2>
<p><a href="https://source.android.com/setup/build/initializing?hl=ja#setting-up-a-linux-build-environment" target="_blank" rel="nofollow noopener noreferrer">ビルド要件</a>に従い必要なパッケージをインストール</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token function">sudo</span> <span class="token function">apt-get</span> update
<span class="token function">sudo</span> <span class="token function">apt-get</span> <span class="token function">install</span> <span class="token parameter variable">-y</span> git-core gnupg flex bison build-essential <span class="token function">zip</span> <span class="token function">curl</span> zlib1g-dev gcc-multilib g++-multilib libc6-dev-i386 libncurses5 lib32ncurses5-dev x11proto-core-dev libx11-dev lib32z1-dev libgl1-mesa-dev libxml2-utils xsltproc <span class="token function">unzip</span> fontconfig
</code></pre></div><h2 id="repo%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB">
<a class="header-anchor-link" href="#repo%E3%82%92%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB" aria-hidden="true"></a> Repoをインストール</h2>
<p>AOSPのソースコードをクローンしてくるにはRepoが必要です。ASOPのソースコードは膨大な数のGitリポジトリで構成されています。Repoは複数のGitリポジトリを扱いやすくしたGitコマンドのラッパーのようなものです。</p>
<p>インストールは<a href="https://source.android.com/setup/develop?hl=ja#installing-repo" target="_blank" rel="nofollow noopener noreferrer">ドキュメント</a>通りに試したのですが、うまくいかなかったので、下記コマンドでインストールしました（GPGキーが取得できないようなエラーが出ていたので、WSL環境の問題かもしれません）。</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token function">mkdir</span> ~/bin
<span class="token assign-left variable"><span class="token environment constant">PATH</span></span><span class="token operator">=~</span>/bin:<span class="token environment constant">$PATH</span>
<span class="token function">curl</span> https://storage.googleapis.com/git-repo-downloads/repo <span class="token operator">&gt;</span> ~/bin/repo
<span class="token function">chmod</span> a+x ~/bin/repo
</code></pre></div><h2 id="kvm%E3%81%AE%E8%A8%AD%E5%AE%9A">
<a class="header-anchor-link" href="#kvm%E3%81%AE%E8%A8%AD%E5%AE%9A" aria-hidden="true"></a> KVMの設定</h2>
<p>上記のRepoまで設定すれば、ビルドまでは完了できます。ビルド後にエミュレータを動かすために、KVMの設定が必要でした。エミュレータはGUIアプリなのにUbuntu上で動かせるのか疑問に思うかもしれませんが、Windows 11ではWSL2でLinuxのGUIアプリを動かせるようになっています。</p>
<p><a href="https://docs.microsoft.com/ja-jp/windows/wsl/tutorials/gui-apps" target="_blank" rel="nofollow noopener noreferrer">Linux用WindowsサブシステムでLinux GUIアプリを実行する</a></p>
<p>KVMはLinuxでAndroidエミュレータのハードウェアアクセラレーションを効かせるために必要です。<a href="https://developer.android.com/studio/run/emulator-acceleration?hl=ja#vm-linux" target="_blank" rel="nofollow noopener noreferrer">ドキュメント</a>に従って、UbuntuにKVMを設定すればいいのですが、筆者の記憶が正しければ Ubuntu をインストールした段階ですでにKVMが有効かされている状態でした。ただ、rootユーザーでしか有効化されてなかったので、実行ユーザーでも使えるようにしました。</p>
<p>実行ユーザーでKVMが使えないとエミュレータ実行時にエラーがでます。そのエラーに従ってkvmグループを作成して、実行ユーザーをグループに追加しておきます。</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token function">sudo</span> <span class="token function">groupadd</span> <span class="token parameter variable">-r</span> kvm
<span class="token function">sudo</span> gpasswd <span class="token parameter variable">-a</span> <span class="token environment constant">$USER</span> kvm
</code></pre></div><p>グループを追加したら<code>/dev/kvm</code>のグループをrootからkvmにすればいいのですが、このままだと再起動するとrootに戻ってしまいます。そこでブート時にパーミッションを変えられるように<code>/etc/wsl.conf</code>を編集します。<code>/etc/wsl.conf</code>はなかったら作ります。</p>
<div class="code-block-container"><pre><code># /etc/wsl.conf
[boot]
command = /bin/bash -c 'chown root:kvm /dev/kvm &amp;&amp; chmod 660 /dev/kvm'
</code></pre></div><p>こちらは以下のissueを参考にしました。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__5ea7de511ba4e" src="https://embed.zenn.studio/card#zenn-embedded__5ea7de511ba4e" data-content="https%3A%2F%2Fgithub.com%2Fmicrosoft%2FWSL%2Fissues%2F7149" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/microsoft/WSL/issues/7149" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/microsoft/WSL/issues/7149</a></p>
<h1 id="aosp%E3%81%AE%E3%83%93%E3%83%AB%E3%83%89">
<a class="header-anchor-link" href="#aosp%E3%81%AE%E3%83%93%E3%83%AB%E3%83%89" aria-hidden="true"></a> AOSPのビルド</h1>
<h2 id="repo%E3%81%A7%E3%82%BD%E3%83%BC%E3%82%B9%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%82%A2%E3%82%A6%E3%83%88">
<a class="header-anchor-link" href="#repo%E3%81%A7%E3%82%BD%E3%83%BC%E3%82%B9%E3%82%B3%E3%83%BC%E3%83%89%E3%81%AE%E3%83%81%E3%82%A7%E3%83%83%E3%82%AF%E3%82%A2%E3%82%A6%E3%83%88" aria-hidden="true"></a> Repoでソースコードのチェックアウト</h2>
<p>ディレクトリ作成</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token function">mkdir</span> aosp
<span class="token builtin class-name">cd</span> aosp
</code></pre></div><p>repoの中でgitが動くので、gitの設定をしておく</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token function">git</span> config <span class="token parameter variable">--global</span> user.name Your Name
<span class="token function">git</span> config <span class="token parameter variable">--global</span> user.email you@example.com
</code></pre></div><p>リポジトリをチェックアウト</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token assign-left variable">ANDROID_BRANCH</span><span class="token operator">=</span><span class="token string">"android-11.0.0_r48"</span>
<span class="token assign-left variable">REPO_MANIFEST</span><span class="token operator">=</span><span class="token string">"https://android.googlesource.com/platform/manifest"</span>
repo init <span class="token parameter variable">-u</span> <span class="token variable">$REPO_MANIFEST</span> <span class="token parameter variable">-b</span> <span class="token variable">$ANDROID_BRANCH</span>
repo <span class="token function">sync</span> <span class="token parameter variable">-c</span> <span class="token parameter variable">-j8</span> <span class="token comment"># -jnでスレッド数を指定する</span>
</code></pre></div><p>上記コマンドではAOSPのリビジョンとして<code>android-11.0.0_r48</code>を指定しています。リビジョンには、<a href="https://android.googlesource.com/platform/manifest" target="_blank" rel="nofollow noopener noreferrer">manifest</a>のブランチやタグが指定できると思いますが、もってきたリビジョンがビルドできるかどうかは試してみないとわかりません。筆者はドキュメント（<a href="https://source.android.com/setup/start/build-numbers?hl=ja#source-code-tags-and-builds" target="_blank" rel="nofollow noopener noreferrer">ソースコード タグとビルド</a>）を参考にリビジョンを決めました。指定したリビジョンは記事を書いた段階でAndroid 11の最新リビジョンでした。</p>
<p>初回の<code>repo sync</code>は100GBオーダーのリポジトリを持ってくるのでとても時間がかかります。ソースコードをもってきた後でも、<code>repo init</code>と<code>repo sync</code>で別のリビジョンに切り替えることができます。</p>
<h2 id="%E3%83%93%E3%83%AB%E3%83%89">
<a class="header-anchor-link" href="#%E3%83%93%E3%83%AB%E3%83%89" aria-hidden="true"></a> ビルド</h2>
<p>以下のコマンドでビルドできます。</p>
<div class="code-block-container"><pre class="language-shell"><code class="language-shell"><span class="token comment"># 環境の初期化</span>
<span class="token builtin class-name">.</span> build/envsetup.sh

<span class="token comment"># ビルドターゲットの指定</span>
lunch aosp_x86_64-eng

<span class="token comment"># ビルド</span>
m <span class="token parameter variable">-j12</span>
</code></pre></div><p><code>build/envsetup.sh</code>を実行することで、後続の<code>lunch</code>コマンドが使えるようになります。<code>lunch</code>コマンドで<code>aosp_x86_64-eng</code>のようにターゲットを指定しています。指定できるターゲットは<code>lunch</code>コマンドを引数なしで実行すると確認することができます。ターゲットの命名については、<a href="https://source.android.com/setup/build/building?hl=ja#choose-a-target" target="_blank" rel="nofollow noopener noreferrer">ドキュメント</a>で確認することができます。例えば、<code>aosp_car_x86_64-userdebug</code> のように指定すると車載OS向けのAndroid Automotive OSもビルドできます。</p>
<p>最後の<code>m</code>コマンドでビルドが走ります。<code>m</code>コマンドはaospディレクトリのトップレベルで<code>make</code>を実行します（aospディレクトリ内のどこにいてもトップレベルで実行されます）。<code>-jn</code>でスレッド数を指定できます。筆者の環境では、<code>m -j12</code>で150分程度かかりました。Google内部の構成ではフルビルドで40分程度とのことなので、力の差を見せつけられましたね。ハードウェアの構成がものを言うので、自作PCのベンチマークとしてAOSPビルドをするのは面白いんじゃないかと思いました。</p>
<h1 id="%E3%82%A8%E3%83%9F%E3%83%A5%E3%83%AC%E3%83%BC%E3%82%BF%E5%AE%9F%E8%A1%8C">
<a class="header-anchor-link" href="#%E3%82%A8%E3%83%9F%E3%83%A5%E3%83%AC%E3%83%BC%E3%82%BF%E5%AE%9F%E8%A1%8C" aria-hidden="true"></a> エミュレータ実行</h1>
<p>ビルドが正常に完了すると、以下のコマンドでエミュレータを実行することができます。</p>
<div class="code-block-container"><pre><code>emulator
</code></pre></div><p><strong>ビルドターゲットaosp_x86-64-engのエミュレータ</strong><br>
<img src="https://storage.googleapis.com/zenn-user-upload/64c162ae808b-20220316.png" alt="ビルドターゲット aosp_x86-64-eng のエミュレータ" width="300" loading="lazy" class="md-img"><br>
<em>ビルドターゲットaosp_x86-64-engのエミュレータ</em></p>
<p><strong>ビルドターゲットaosp_car_x86_64-userdebugのエミュレータ</strong><br>
<img src="https://storage.googleapis.com/zenn-user-upload/7b06ecd668a1-20220316.png" alt="ビルドターゲット aosp_car_x86_64-userdebug のエミュレータ" width="600" loading="lazy" class="md-img"><br>
<em>ビルドターゲットaosp_car_x86_64-userdebugのエミュレータ</em></p>
<p>WSL2上ですがLinuxのGUIアプリが普通に起動していて感動します。エミュレータ起動時に以下のように、Nested Virtualizationで動かすのはおすすめしないとのメッセージがでますが、簡単に操作してみた感じでは問題なさそうです。</p>
<p><img src="https://storage.googleapis.com/zenn-user-upload/91fbc05058de-20220316.png" alt="Nested Virtualization" loading="lazy" class="md-img"></p>
<p>エミュレータの実行環境がKVM on WSL VMという形になっており、VMがネストしているために上記メッセージが表示されていると思います。</p>
<h1 id="%E3%81%95%E3%81%84%E3%81%94%E3%81%AB">
<a class="header-anchor-link" href="#%E3%81%95%E3%81%84%E3%81%94%E3%81%AB" aria-hidden="true"></a> さいごに</h1>
<p>WindowsマシンでAOSPをビルドして、エミュレータを動かすところまでできました。ただ、実際のAOSP開発をWindowsマシンでやっていけるかどうかはまだわかりません。とりあえず、WSL2およびWindowsがすごく進化していることにとても驚いています。</p>
<p>今後やってみたいこと</p>
<ul>
<li>PCの構成を変えてとにかく速くビルドしたい（Googleに勝ちたい）</li>
<li>AOSPのカスタムターゲットを作ってカスタムROMを作ってみたい</li>
<li>WSL2上でのAOSP開発が実用に耐えうるか調査したい</li>
</ul>


WSL2でAOSPをビルドしてAndroid エミュレータを動かす

WSL VMへのリソース割り当て設定

ビルドに必要なパッケージをインストール

Repoでソースコードのチェックアウト

Discussion