今日は 「Rubyでつくる、Rubyみたいな言語のコンパイラ」ということで、 コンパイラ初心者が、トイ言語のコンパイラを、Rubyを使って作ってみたよ、というお話と、 その中で得た経験やコツについてお話しします。

まず自己紹介です。 はたけやまたかしと申します。 株式会社永和システムマネジメントという会社で、Rubyプログラマとして働いています。 また、ダジャレが好きなので、思いついたダジャレをTwitterへ放流したりしています。 こちらは「最近のお気に入りツイート」になります。

また、趣味で低レイヤプログラミングをしています。 CPUを自作したり、 RISC-Vのシミュレータを作ったり、 MinCamlコンパイラを移植したりしています。

趣味の MinCaml コンパイラの移植をしているうちに、1からコンパイラを作りたくなってきまして、そこで 今日お話しする TinyRuby の開発を始めました。

今日お話しすることは、 TinyRubyの紹介と、 TinyRubyの作成を通じて得た「コンパイラ作成の便利情報、Tips」について、 そして、「コンパイラの初めの一歩」ということで、実際にコンパイラを作成する流れをお見せしたいと思います。

では TinyRuby についてご紹介します。TinyRubyは、こんな感じのRubyみたいなプログラミング言語になります。

さきほど書いたサンプルプログラムのビルド手順はこんな感じです。 まず、TinyRubyコンパイラで sample.rb をコンパイルすると、コンパイル結果のアセンブリが標準出力に出力されます。これを sample.s というファイルに保存します。 次に、先ほど生成したアセンブリファイル sample.s を、gcc コマンドでアセンブルとリンクを行い、実行ファイル a.out を生成します。 実行ファイル a.out を実行すると、プログラムの実行結果が画面に出力されます。

次はTinyRubyの構文解析器、パーサーについてです。 TinyRubyのパーサーはMinRubyのパーサーをそのまま利用しています。 MinRubyというのは、「RubyでつくるRuby」という書籍に登場する、Rubyのサブセット言語です。こちらの書影が「RubyでつくるRuby」になります。 TinyRubyはMinRubyのパーサーを使ってはいますが、コンパイラの実装を簡単にするため、MinRubyからいくつかの機能が落とされています。 例えば、 「データ型は整数型のみ」だったり、 「ArrayとHashをサポートしない」だったり、 「関数の引数は6つまで」などの制限があります。 そのため、TinyRubyはMinRubyのサブセット言語と言えます。

TinyRubyコンパイラのターゲット環境は、CPUが x86-64 で、OSが Linux となります。 macOS や Windows をお使いの方は、Docker 上の Linux 環境などで開発できます。 私も M1 Mac を使っているので、Docker 上で開発を行いました。

次は、TinyRuby の作成を通して学んだ、コンパイラ作成時に使える便利情報、Tipsを紹介します。 1) Cコンパイラが出力するアセンブリコードの活用 2) レジスタとABIを知る 3) 小さなステップで進める

では、1つ目のTips「Cコンパイラが出力するアセンブリコードを活用する」についてお話しします。 アセンブリを書いていると、「C言語ではどう書くかはわかるけど、アセンブリでどう書けばいいか分からない！」ということがよくあります。 そんな時は、希望する処理を行うプログラムをCで書き、Cコンパイラにアセンブリコードを出力させることで、アセンブリコードを確認できます。 Cコンパイラにアセンブリコードを出力させる方法はいくつかありますが、「Compiler Explorerを使う方法」と「GCCの `-S` オプションを使う方法」の2つがお手軽で便利です。

https://godbolt.org/ まずは Compiler Explorer を使う方法を紹介します。 Compiler Explorer は、様々な言語、様々なCPUが出力するアセンブリを確認できるカッコいいサイトです。 （動画を再生） ・Compiler Explorer の画面は2つの領域に分かれていて、左側にはソースプログラムを書くと、右側にそのソースのアセンブリが出力されます。 ・Cのソースプログラムのどの部分が、アセンブリコードのどの部分に対応しているかが、色によってわかりやすく表示されるので、アセンブリの理解に役立ちます。

次に、GCCの「-S」オプションを使う方法を紹介します。 通常、GCCにC言語のソースコードを渡すと、実行ファイルやオブジェクトファイルが生成されます。 しかし、gcc に「-S」オプションを付けることで、コンパイルのみを行い、その結果をアセンブリファイルとして出力することができます。 例えば、次のようなC言語のソースコードを「-S」オプションをつけて実行すると...（次のページ）

このようなアセンブリコードが出力されます。

「Compiler Explorer」と「GCC」の使い分けについてです。 基本的には「Compiler Explorer」を使っておけばOKですが、 Compiler Explorer が出力するアセンブリは、出力オプションに Compiler Explorer が出力したアセンブリは、出力オプションの設定によっては、そのままビルドできないことがままあります。 そのため、出力したアセンブリをそのままビルドにかけたい場合などは「GCC」で。 そうでない場合は「Compiler Explorer」を使うと良いでしょう。

二つめのTipsは「レジスタとABIを知る」です。 コンパイラが出力するアセンブリを理解するためには、対象となるCPUの「レジスタ構成」と「ABI」を知る必要があります。

まずレジスタについて説明します。 CPUには「レジスタ」と呼ばれるデータの記憶領域があり、CPUが演算を行う際に利用したり、一時的なデータの置き場として利用したりします。 x86-64 は、ここに示す 16 本の 64 ビット汎用レジスタがあります。 また、これ以外にも浮動小数点数用のレジスタや、フラグレジスタなるものがあったりしますが、ここでは省略します。

次に、ABI についてお話しします。 ABI とは、Application Binary Interface の略で、アセンブリ言語レベルでの関数の呼び出しなどの規約のことです。

例えば、x86-64 で関数を呼び出す際には、 第一引数は RDI レジスタ、 第二引数は RSI レジスタ、 といったように、「第一引数」から「第六引数」までの値を、決められたレジスタにセットする必要があります。 また、第七引数以降はスタックに引数の値を積む必要があります。 これらが ABI によって定められています。 関数の戻り値の返し方も ABI で決められていて、戻り値は RAX レジスタに渡して返す必要があります。 ABI でこうした規約を定義することで、規約に従ったモジュール間での相互呼び出しや、データの連携ができるようになります。

x86-64 の ABI のより詳細な情報については、こちらの資料などを参照してください。 また、これは x86-64 上で動作する Linux の ABI なので、他の OS、他の CPU の場合は、対象となる環境の ABI を調べる必要があります。

3つ目のTipsは「小さなステップで進める」です。 コンパイラを作成する際に、一度に全ての機能を実装するのではなく、小さなステップを刻みながら機能を実装していくと、コンパイラの実装がしやすく、挫折もしにくくなります。 TinyRuby の開発では、 整数リテラルの評価からスタートして、 四則演算、プリント関数呼び出し、複数ステートメント、変数の代入と参照、比較演算、条件分岐、関数呼び出し、関数定義、の順番で機能を追加していきました。

また、機能を追加する際に、シェルスクリプトでテストを書いてから機能を1つずつ実装していく「テスト駆動開発」で開発を行いました。 まずは整数リテラルのテストを書いて、コンパイラを実装、 次に四則演算のテストを書いて、コンパイラを実装、 その次に複数ステートメントのテストを書いて、コンパイラを実装、 というようなサイクルを、すべての機能の実装が終わるまで繰り返します。

また、小さなステップで進めることのメリットは、 - コンパイラに必要な知識を段階的に習得できる - 適度な粒度でテストを書きやすいため、テスト駆動開発が行いやすい というのがメリットになります。

テスト駆動開発で進めることのメリットは、 - 目の前の問題にだけ集中できる - テスト実施が容易 - フィードバックを即時に得られる - 短いサイクルで達成感を得られるため、モチベーションを維持しやすい などがあります。

「小さなステップでコンパイラ開発を進める方法」や「テスト駆動でのコンパイル開発」については、この2つの参考資料が元になっています。ぜひ、こちらも読んでみてください。

コンパイラの作成手順についての説明は今日はここまでですが、 より詳細な情報が Cosense にまとめられていますので、気になる方はこちらをご覧ください。

では、本日のまとめです。 TinyRubyの紹介と、 コンパイラ作成のTipsを紹介しました。 今回の発表で、コンパイラ作ってみたい！と思っていただけたら嬉しいです。 ぜひ、コンパイラを通して低レイヤの世界に触れてみてください。