手を動かせばできるLLVMバックエンド チュートリアル

なおLLVMについてGoogleで検索していると"LLVM Cookbook"なる謎の書籍（の電子コピー）が 見つかるが、内容はLLVM公式文書のパクリのようだ[139]。

[8]を参考にして CAHPをLLVMに認識させます。LLVMではコンパイル先のターゲットをTripleという単位で 管理しています。そのTripleの一つとしてCAHPを追加します。

llvm/include/llvm/ADT/Triple.h や llvm/lib/Support/Triple.cpp などの ファイルにTripleが列挙されているため、そこにCAHPを追加します。 また llvm/unittests/ADT/TripleTest.cpp にTripleが正しく認識されているかをチェックする テストを書きます。

[13]を参考にして、CAHPのためのELFフォーマットを定義します。 具体的にはCAHPのマシンを表す識別コードや再配置情報などを記述し、 ELFファイルの出力が動作するようにします。 ただし独自ISAではそのような情報が決まっていないため、適当にでっちあげます。

[14]を参考に llvm/lib/Target ディレクトリ内に CAHP ディレクトリを作成し、最低限必要なファイルを用意します。

まずビルドのために CMakeLists.txt と LLVMBuild.txt を用意します。 またCAHPに関する情報を提供するために CAHPTargetInfo.cpp や CAHPTargetMachine.cpp などを記述します。

CAHPTargetMachine.cpp ではdata layoutを文字列で指定します。 詳細はLLVM IRの言語仕様[53]を参考してください。

以上で必要最小限のファイルを用意することができました。

LLVM coreは基本的にC++によって記述されています。一方で、多くの箇所で共通する処理などは 独自のDSL（ドメイン固有言語）であるTableGenを用いて記述し llvm-tblgen という ソフトウェアを用いてこれをC++コードに変換しています。 こうすることによって記述量を減らし、ヒューマンエラーを少なくするという考え方 のようです[21]。

LLVMバックエンドでは、アーキテクチャが持つレジスタや命令などの情報をTableGenによって 記述します。大まかに言って、TableGenで書ける場所はTableGenによって書き、 対応できない部分をC++で直に書くというのがLLVM coreの方針のようです。 ここでは、簡単なアセンブラを実装するために最低限必要なTableGenファイルを追加します。 内訳は次のとおりです。

順に説明します。 CAHP.td がTableGenファイル全体をまとめているTableGenファイルで、 内部では include を使って他のファイルを読み込んでいます。

また同時に、今回想定するプロセッサを表す ProcessorModel や、 現在実装しているターゲットの CAHP について定義しています。

CAHPRegisterInfo.td ではCAHPに存在するレジスタを定義します。 まず Register を継承して class CAHPReg を作り、これに基本的なレジスタの性質をもたせます。 ついで class CAHPReg の実体として X0 から X15 を作成します。 alt にはレジスタの別名を指定します。 最後に、レジスタをまとめて RegisterClass である GPR （General Purpose Register; 汎用レジスタの意）を定義します。 このあと命令を定義する際にはこの RegisterClass 単位で指定します。 ここでレジスタを並べる順番が先であるほどレジスタ割り付けで割り付けられやすいため、 caller-savedなもの（使ってもspill outが起こりにくいもの）を先に並べておきます。

GPR と同様に SP という RegisterClass も作成し、 X1 、 つまりスタックポインタを表すレジスタのみを追加しておきます。 この RegisterClass を命令のオペランドに指定することで lwsp や swsp などの「スタックポインタのみを取る命令」を表現することができます。

命令は CAHPInstrFormats.td と CAHPInstrInfo.td に分けて記述します。 CAHPInstrFormats.td ではおおよその命令の「形」を定義しておき、 CAHPInstrInfo.td でそれを具体化します。言葉で言ってもわかりにくいので、コードで見ます。 例えば24bit長の加算命令は次のように定義されます。 まずCAHPの命令全体に共通する事項を class CAHPInst として定義します。

次に、CAHPの24bit命令に共通する事項を class CAHPInst を継承した class CAHP24Inst として定義します。

さらに、24bit長加算命令の「形」である24bit R形式（オペランドにレジスタを3つとる）を class CAHPInst24R として定義します。 class CAHPInst24 を継承します。

最後にこれを使って加算命令 ADD を定義します。

上記の継承による構造を展開すると、結局 class Instruction を使って 次のような定義を行ったことになります。

Inst フィールドにエンコーディングを設定することで、 TableGenにエンコードの処理を移譲することができます^[6]。

続いて即値を用いる命令を見ます。例として addi を取り上げます。 addi は8bit符号付き即値をオペランドに取ります。まずこれを定義します。

続いて命令の「形」を定義します。 addi は24bit I形式です。

最後に、これを用いて addi を定義します。

add の際には GPR とした第三オペランドが simm8 となっています。 これによって、この部分に符号付き8bit即値が来ることを指定しています。

即値のうち、下位1bitが0になるものは _lsb0 というサフィックスを名前につけ区別しておきます。 uimm7_lsb0 と simm11_lsb0 がそれに当たります。 後々、C++コードにてこの制限が守られているかをチェックします。

add2 のような2オペランドの命令を記述する場合、上の方法では問題があります。 というのも add2 の第一オペランドは入力であると同時に出力先でもあるためです。 このような場合は次のように Constraints フィールドにその旨を記述します。

なおTableGenでは let で囲むレコードが一つの場合は括弧 { } は必要ありません。 また let で外からフィールドを上書きするのと、 def の中身に記載するのとで意味は 変わりません。すなわち、上のコードは次の2通りと意味は異なりません[21]。

必要なTableGenファイルを追加した後、 これらのTableGenファイルが正しいかどうか llvm-tblgen を用いて確認します。

アセンブラ本体のC++コードを作成します。ここでは、 アセンブリのエンコードからバイナリ生成部分を担当する MCTargetDesc ディレクトリを追加し、 必要なファイルを揃えます。複数のクラスを定義しますが、それらは全て MCTargetDesc/CAHPMCTargetDesc.cpp にある LLVMInitializeCAHPTargetMC 関数でLLVM coreに登録されます。

定義するクラスは次のとおりです。

順に説明します。

CAHPMCAsmInfo にはアセンブリがどのように表記されるかを主に記述します。 MCTargetDesc/CAHPMCAsmInfo.{h,cpp} に記述します。

CAHPMCInstrInfo は先程記述したTableGenファイルから、 TableGenによって InitCAHPMCInstrInfo 関数として自動的に生成されます。 CAHPMCTargetDesc.cpp 内でこれを呼び出して作成します。

CAHPMCRegisterInfo も同様に自動的に生成されます。 InitCAHPMCRegisterInfo 関数を呼び出します。なおこの関数の第二引数には 関数の戻りアドレスが入るレジスタを指定します^[7]。 CAHPではx0を表す CAHP::X0 を渡すことになります。

CAHPMCSubtargetInfo も同様に自動生成されます。 createCAHPMCSubtargetInfoImpl を呼び出します。この関数の第二引数には CAHP.td で ProcessorModel として定義したCPUの名前を指定します。

CAHPMCCodeEmitter はアセンブリのエンコード作業を行います。 MCTargetDesc/CAHPMCCodeEmitter.cpp に記述します。 主要なエンコード処理はTableGenによって自動生成された getBinaryCodeForInstr を CAHPMCCodeEmitter::encodeInstruction から呼び出すことによって行われます。 この関数は CAHPGenMCCodeEmitter.inc というファイルに定義されるため、 これを MCTargetDesc/CAHPMCCodeEmitter.cpp 末尾で #include しておきます。

CAHPAsmBackend にはオブジェクトファイルを作成する際に必要な fixupの操作や指定バイト数分の無効命令を書き出す処理などを記述します。 MCTargetDesc/CAHPAsmBackend.cpp に記述します。 fixupについては後ほど実装するためここではスタブにしておきます。

CAHPELFObjectWriter にはELFファイル（の特にヘッダ）を作成する際に必要な情報を記載します。 このクラスは LLVMInitializeCAHPTargetMC ではなく CAHPAsmBackend の createObjectTargetWriter メンバ関数として紐付けられます。 親クラス MCELFObjectTargetWriter のコンストラクタに、 CAHPマシンを表す ELF::EM_CAHP と、 .rel ではなく .rela を使用する旨を示す true を渡しておきます^[8]。 また getRelocType メンバ関数はどのような再配置を行うかを見繕うためのものですが、 ここではスタブにしておきます。

上記を実装してビルドします。一度使ってみましょう。 LLVMのアセンブラを単体で使う場合は llvm-mc というコマンドを使用します。 次のようにすると foo.s というアセンブリファイルをオブジェクトファイルに 変換できます。

このようなエラーメッセージが出れば成功です^[9]。 続いてアセンブリをパーズする部分を開発します。

アセンブリのパーズは CAHPAsmParser が取り仕切っています。