FIXME
文中のFIXME他直すべきものをここにリストにする。
-
だ・である調をです・ます調に変える。
この文書について
この文書はAsciiDocを用いて執筆されています。
この文書はGitによって管理され、 GitHubリポジトリにて 公開されています。
この作品は、クリエイティブ・コモンズの 表示 4.0 国際 ライセンスで提供されています。ライセンスの写しをご覧になるには、 http://creativecommons.org/licenses/by/4.0/ をご覧頂くか、Creative Commons, PO Box 1866, Mountain View, CA 94042, USA までお手紙をお送りください。
本文書の内容は筆者が独自に調査したものです。 疑う余地なく誤りが含まれます。誤りに気づかれた方はGitHubリポジトリなどを通じて ご連絡ください。
LLVMバックエンド概略
本書ではRISC-V風味の独自ISAを例にLLVMバックエンドを開発します。
使用するLLVMのバージョンはv9.0.0です。
ところで
参考にすべき文献
LLVMバックエンドを開発する際に参考にできる書籍やWebサイトを以下に一覧します。 なおこの文書では、RISC-Vバックエンド及びそれに関する技術資料を大いに参考しています。
Webページ
-
Writing an LLVM Backend[18]
-
分かりにくく読みにくい。正直あんまり見ていないが、たまに眺めると有益な情報を見つけたりもする。
-
-
The LLVM Target-Independent Code Generator[31]
-
[18]よりもよほど参考になる。LLVMバックエンドがどのようにLLVM IRをアセンブリに落とすかが明記されている。必読。
-
-
TableGenのLLVMのドキュメント[21]
-
情報量が少ない。これを読むよりも各種バックエンドのTableGenファイルを読むほうが良い。
-
-
LLVM Language Reference Manual[43]
-
LLVM IRについての言語リファレンス。LLVM IRの仕様などを参照できる。必要に応じて読む。
-
-
Architecture & Platform Information for Compiler Writers[68]
-
LLVMで公式に実装されているバックエンドに関するISAの情報が集約されている。Lanaiの言語仕様へのリンクが貴重。
-
-
RISC-V support for LLVM projects[10]
-
Create an LLVM Backend for the Cpu0 Architecture[35]
-
Cpu0という独自アーキテクチャのLLVMバックエンドを作成するチュートリアル。多少古いが、内容が網羅的で参考になる。英語が怪しい。
-
-
FPGA開発日記[44]
-
ELVMバックエンド[36]
-
限られた命令でLLVM IRの機能を達成する例として貴重。でも意外とISAはリッチだったりする。
-
作成者のスライドも参考になる[37]。
-
-
2018年度東大CPU実験で開発されたLLVM Backend[40]
-
これについて書かれたAdCのエントリもある[41]。
-
-
Tutorial: Building a backend in 24 hours[45]
-
LLVMバックエンドの大まかな動きについてざっとまとめたあと、
retだけが定義された最低限のLLVMバックエンド ("stub backend") を構成している。 -
Instruction Selection の説明にある Does bunch of magic and crazy pattern-matching が好き。
-
-
2017 LLVM Developers’ Meeting: M. Braun "Welcome to the back-end: The LLVM machine representation"[46]
-
スライドも公開されている[135]。
-
命令選択が終わったあとの中間表現であるLLVM MIR （
MachineFunctionやMachineInstrなど）や、それに対する操作の解説。 RegStateやframe index・register scavengerなどの説明が貴重。
-
-
Howto: Implementing LLVM Integrated Assembler[47]
-
LLVM上でアセンブラを書くためのチュートリアル。アセンブラ単体に焦点を絞ったものは珍しい。
-
-
Building an LLVM Backend[49]
-
対応するレポジトリが[54]にある。
-
-
[LLVMdev] backend documentation[116]
-
llvm-devメーリングリストのバックエンドのよいドキュメントは無いかというスレッド。Cpu0とTriCoreが挙げられているが、深くまで記述したものは無いという回答。
-
-
TriCore Backend[118]
-
Life of an instruction in LLVM[136]
-
Cコードからassemblyまでの流れを概観。
-
-
LLVM Backendの紹介[138]
-
「コンパイラ勉強会」[2]。]での、LLVMバックエンドの大きな流れ（特に命令選択）について概観した日本語スライド。
-
バックエンド
ISAの仕様を決める
本書で使用するISAであるCAHPv3について説明します。
cahpv3.pdfを参考のこと。
スケルトンバックエンドを追加する
正常にLLVMのビルドを行うために、何の機能も無いバックエンド（スケルトンバックエンド）を LLVMに追加します。
LLVMをビルドする
LLVMは巨大なプロジェクトで、ビルドするだけでも一苦労です。 以下では継続的な開発のために、高速にLLVMをデバッグビルドする手法を紹介します。
ビルドの際には以下のソフトウェアが必要になります。
-
cmake -
ninja -
clang -
clang++ -
lld
まずLLVMのソースコードをGitを用いて取得します。
前述したように、今回の開発ではLLVM v9.0.0をベースとします。
そこでブランチ llvmorg-9.0.0 から独自実装のためのブランチ cahp を生成し、
以降の開発はこのブランチ上で行うことにします。
$ git clone https://github.com/llvm/llvm-project.git $ cd llvm-project $ git switch llvmorg-9.0.0 $ git checkout -b cahp
続いて、ビルドを行うための設定をCMakeを用いて行います。 大量のオプションはビルドを早くするためのものです[96]。
$ mkdir build
$ cd build
$ cmake -G Ninja \
-DLLVM_ENABLE_PROJECTS="clang;lld" \
-DCMAKE_BUILD_TYPE="Debug" \
-DBUILD_SHARED_LIBS=True \
-DLLVM_USE_SPLIT_DWARF=True \
-DLLVM_OPTIMIZED_TABLEGEN=True \
-DLLVM_BUILD_TESTS=True \
-DCMAKE_C_COMPILER=clang \
-DCMAKE_CXX_COMPILER=clang++ \
-DLLVM_USE_LINKER=lld \
-DLLVM_TARGETS_TO_BUILD="" \
-DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD="CAHP" \
../llvm
Ninjaを用いてビルドを行います。直接Ninjaを実行しても構いません（ $ ninja ）が、
CMakeを用いて間接的に実行することもできます。
$ cmake --build .
ビルドが終了すると bin/ ディレクトリ以下にコンパイルされたバイナリが生成されます。
例えば次のようにして、CAHPバックエンドが含まれていることを確認できます。
$ bin/llc --version
LLVM (http://llvm.org/):
LLVM version 9.0.0
DEBUG build with assertions.
Default target: x86_64-unknown-linux-gnu
Host CPU: skylake
Registered Targets:
cahp - CAHP
|
ここでは開発用にデバッグビルドを行いました。 一方で、他人に配布する場合などはリリースビルドを行います。 その際は次のようにCMakeのオプションを指定します。 $ cmake -G Ninja \
-DLLVM_ENABLE_PROJECTS="lld;clang" \
-DCMAKE_BUILD_TYPE="Release" \
-DLLVM_BUILD_TESTS=True \
-DCMAKE_C_COMPILER=clang \
-DCMAKE_CXX_COMPILER=clang++ \
-DLLVM_USE_LINKER=lld \
-DLLVM_TARGETS_TO_BUILD="" \
-DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD="CAHP" \
../llvm
|
アセンブラを作る
この章ではLLVMバックエンドの一部としてアセンブラを実装します。 具体的にはLLVMのMCLayerを実装し、アセンブリからオブジェクトファイルへの変換を可能にします。
簡易的なアセンブラを実装する
CAHPInstPrinter を実装する
テストを書く
メモリ演算を追加する
属性を指定する
ディスアセンブラを実装する
relocationとfixupに対応する
%hi と %lo に対応する
li a0, foo をエラーにする
llvm-objdump の調査
hlt 疑似命令を追加する
コード生成部を作る
コンパイラのスケルトンを作成する
基本的な演算に対応する
定数の実体化に対応する
メモリ演算に対応する
relocationに対応する
条件分岐に対応する
関数呼び出しに対応する
関数プロローグ・エピローグを実装する
frame pointer eliminationを実装する
select に対応する
FrameIndex をlowerする。
大きなスタックフレームに対応する
SETCC に対応する
ExternalSymbol に対応する
jump tableを無効化する
インラインアセンブリに対応する
fastccに対応する
Cコンパイラに仕立てる
LLDにCAHPバックエンドを追加する
ClangをCAHPに対応させる
crt0.o と cahp.lds の導入
--nmagic の有効化
libcの有効化
まともなコードを生成する
分岐解析に対応する
branch relaxationに対応する
16bit命令を活用する
jal を活用する
命令スケジューリングを設定する
末尾再帰に対応する
落ち穂拾い
スタックを利用した引数渡し
byval の対応
動的なスタック領域確保に対応する
emergency spillに対応する
可変長引数関数に対応する
単体の sext/zext/trunc に対応する
乗算に対応する
除算・剰余に対応する
frameaddr/returnaddr に対応する
ROTL/ROTR/BSWAP/CTTZ/CTLZ/CTPOP に対応する
32bitのシフトに対応する
間接ジャンプに対応する
BlockAddress のlowerに対応する
参考文献
-
[1] https://github.com/lowRISC/riscv-llvm/blob/master/docs/01-intro-and-building-llvm.mkd
-
[7] 『きつねさんでもわかるLLVM〜コンパイラを自作するためのガイドブック〜』（柏木 餅子・風薬・矢上 栄一、株式会社インプレス、2013年）
-
[8] https://github.com/lowRISC/riscv-llvm/blob/master/docs/02-starting-the-backend.mkd
-
[9] https://github.com/lowRISC/riscv-llvm/blob/master/0002-RISCV-Recognise-riscv32-and-riscv64-in-triple-parsin.patch
-
[12] http://msyksphinz.hatenablog.com/entry/2019/01/02/040000_1
-
[13] https://github.com/lowRISC/riscv-llvm/blob/master/0003-RISCV-Add-RISC-V-ELF-defines.patch
-
[14] https://github.com/lowRISC/riscv-llvm/blob/master/0004-RISCV-Add-stub-backend.patch
-
[15] https://github.com/lowRISC/riscv-llvm/blob/master/0006-RISCV-Add-bare-bones-RISC-V-MCTargetDesc.patch
-
[16] https://github.com/lowRISC/riscv-llvm/blob/master/0010-RISCV-Add-support-for-disassembly.patch
-
[17] https://llvm.org/docs/WritingAnLLVMBackend.html#instruction-operand-mapping
-
[19] https://github.com/lowRISC/riscv-llvm/blob/master/0007-RISCV-Add-basic-RISCVAsmParser.patch
-
[20] https://github.com/lowRISC/riscv-llvm/blob/master/0008-RISCV-Add-RISCVInstPrinter-and-basic-MC-assembler-te.patch
-
[22] https://github.com/lowRISC/riscv-llvm/blob/master/0009-RISCV-Add-support-for-all-RV32I-instructions.patch
-
[23] http://lists.llvm.org/pipermail/llvm-dev/2015-December/093310.html
-
[26] https://github.com/lowRISC/riscv-llvm/blob/master/docs/05-disassembly.mkd
-
[27] https://github.com/lowRISC/riscv-llvm/blob/master/0011-RISCV-Add-common-fixups-and-relocations.patch
-
[28] https://github.com/lowRISC/riscv-llvm/blob/master/docs/06-relocations-and-fixups.mkd
-
[29] https://github.com/lowRISC/riscv-llvm/blob/master/0013-RISCV-Initial-codegen-support-for-ALU-operations.patch
-
[30] https://speakerdeck.com/asb/llvm-backend-development-by-example-risc-v
-
[32] https://llvm.org/docs/CodeGenerator.html#target-independent-code-generation-algorithms
-
[33] https://llvm.org/docs/CodeGenerator.html#selectiondag-instruction-selection-process
-
[34] https://github.com/lowRISC/riscv-llvm/blob/master/0015-RISCV-Codegen-support-for-memory-operations.patch
-
[38] https://github.com/lowRISC/riscv-llvm/blob/master/0016-RISCV-Codegen-support-for-memory-operations-on-globa.patch
-
[39] https://github.com/lowRISC/riscv-llvm/blob/master/0017-RISCV-Codegen-for-conditional-branches.patch
-
[40] https://github.com/cpu-experiment-2018-2/llvm/tree/master/lib/Target/ELMO
-
[42] https://github.com/lowRISC/riscv-llvm/blob/master/0018-RISCV-Support-for-function-calls.patch
-
[45] https://llvm.org/devmtg/2012-04-12/Slides/Workshops/Anton_Korobeynikov.pdf
-
[47] https://www.embecosm.com/appnotes/ean10/ean10-howto-llvmas-1.0.html
-
[49] http://www.inf.ed.ac.uk/teaching/courses/ct/other/LLVMBackend-2015-03-26_v2.pdf
-
[51] https://kristerw.blogspot.com/2017/08/writing-gcc-backend_4.html
-
[52] http://lists.llvm.org/pipermail/llvm-dev/2019-January/129089.html
-
[54] https://github.com/frasercrmck/llvm-leg/tree/master/lib/Target/LEG
-
[55] https://llvm.org/doxygen/classllvm_1_1MCRegisterInfo.html#a989859615fcb74989b4f978c4d227a03
-
[57] https://llvm.org/docs/WritingAnLLVMBackend.html#calling-conventions
-
[58] https://riscv.org/wp-content/uploads/2015/01/riscv-calling.pdf
-
[59] http://lists.llvm.org/pipermail/llvm-dev/2017-August/116501.html
-
[60] http://msyksphinz.hatenablog.com/entry/2019/06/12/040000
-
[61] http://lists.llvm.org/pipermail/llvm-dev/2014-August/075303.html
-
[62] https://groups.google.com/forum/#!topic/llvm-dev/8kPOj-_lbGk
-
[63] https://stackoverflow.com/questions/32872946/what-is-stack-frame-lowering-in-llvm
-
[64] https://groups.google.com/d/msg/llvm-dev/QXwtqgau-jA/PwnHDF0gG_oJ
-
[65] https://github.com/msyksphinz/llvm/tree/myriscvx/impl90/lib/Target/MYRISCVX
-
[66] https://github.com/llvm/llvm-project/commit/cd44aee3da22f9a618f2e63c226bebf615fa8cf8
-
[70] https://github.com/lowRISC/riscv-llvm/blob/master/0020-RISCV-Support-and-tests-for-a-variety-of-additional-.patch
-
[73] http://lists.llvm.org/pipermail/llvm-dev/2004-June/001264.html
-
[77] https://github.com/lowRISC/riscv-llvm/blob/master/0027-RISCV-Support-stack-frames-and-offsets-up-to-32-bits.patch
-
[81] https://github.com/emscripten-core/emscripten/issues/34
-
[82] http://fileadmin.cs.lth.se/cs/education/edan75/part2.pdf
-
[84] https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
-
[87] http://lists.llvm.org/pipermail/llvm-dev/2017-July/115805.html
-
[88] https://github.com/lowRISC/riscv-llvm/blob/master/0029-RISCV-Add-support-for-llvm.-frameaddress-returnaddre.patch
-
[89] https://github.com/lowRISC/riscv-llvm/tree/master/clang
-
[91] https://github.com/lowRISC/riscv-llvm/blob/master/0022-RISCV-Support-lowering-FrameIndex.patch
-
[92] http://lists.llvm.org/pipermail/llvm-dev/2015-July/087879.html
-
[93] https://stackoverflow.com/questions/27467293/how-to-force-clang-use-llvm-assembler-instead-of-system
-
[94] https://github.com/lowRISC/riscv-llvm/blob/master/clang/0003-RISCV-Implement-clang-driver-for-the-baremetal-RISCV.patch
-
[95] https://github.com/lowRISC/riscv-llvm/blob/master/0025-RISCV-Add-custom-CC_RISCV-calling-convention-and-imp.patch
-
[96] http://lists.llvm.org/pipermail/llvm-dev/2016-October/106187.html
-
[100] https://llvm.org/devmtg/2016-09/slides/Smith-NewLLDTarget.pdf
-
[103] https://docs.google.com/document/d/1jwAc-Rbw1Mn7Dbn2oEB3-0FQNOwqNPslZa-NDy8wGRo/pub
-
[107] https://linuxjm.osdn.jp/html/LDP_man-pages/man5/elf.5.html
-
[110] https://lists.llvm.org/pipermail/llvm-dev/2018-December/128257.html
-
[111] https://github.com/lowRISC/riscv-llvm/blob/master/0031-RISCV-Implement-support-for-the-BranchRelaxation-pas.patch
-
[112] https://github.com/lowRISC/riscv-llvm/blob/master/0030-RISCV-Implement-branch-analysis.patch
-
[113] https://stackoverflow.com/questions/5789806/meaning-of-and-in-c
-
[114] https://proc-cpuinfo.fixstars.com/2018/11/compiler_study_report/
-
[115] https://github.com/llvm/llvm-project/commit/bcb36be8e3f5dced36710ba1a2e2206071ccc7ba
-
[116] http://lists.llvm.org/pipermail/llvm-dev/2013-February/059799.html
-
[117] https://reup.dmcs.pl/wiki/images/7/7a/Tricore-llvm-slides.pdf
-
[118] https://opus4.kobv.de/opus4-fau/files/1108/tricore_llvm.pdf
-
[119] http://lists.llvm.org/pipermail/llvm-dev/2017-April/111697.html
-
[122] http://www.koikikukan.com/archives/2017/04/05-000300.php
-
[123] https://stackoverflow.com/questions/34997577/linker-script-allocation-of-bss-section#comment57735654_34997577
-
[124] https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/4/html/Using_ld_the_GNU_Linker/simple-example.html
-
[127] http://llvm.org/docs/LangRef.html#inline-assembler-expressions
-
[128] http://caspar.hazymoon.jp/OpenBSD/annex/gcc_inline_asm.html
-
[129] https://github.com/lowRISC/riscv-llvm/blob/master/0028-RISCV-Add-basic-support-for-inline-asm-constraints.patch
-
[130] http://llvm.org/docs/LangRef.html#asm-template-argument-modifiers
-
[131] https://github.com/llvm/llvm-project/commit/0715d35ed5ac2312951976bee2a0d2587f98f39f
-
[132] https://github.com/lowRISC/riscv-llvm/blob/master/0032-RISCV-Reserve-an-emergency-spill-slot-for-the-regist.patch
-
[133] https://github.com/lowRISC/riscv-llvm/blob/master/0026-RISCV-Support-for-varargs.patch
-
[134] https://github.com/draperlaboratory/fracture/wiki/How-TableGen%27s-DAGISel-Backend-Works
-
[135] http://llvm.org/devmtg/2017-10/slides/Braun-Welcome%20to%20the%20Back%20End.pdf
-
[136] https://eli.thegreenplace.net/2012/11/24/life-of-an-instruction-in-llvm/
-
[139] https://www.amazon.co.jp/dp/178528598X#customer_review-R28L2NAL8T9M2H
-
[140] https://lists.llvm.org/pipermail/llvm-dev/2017-September/117139.html
-
[141] https://github.com/lowRISC/riscv-llvm/blob/master/0085-RISCV-Set-AllowRegisterRenaming-1.patch
-
[142] https://lists.llvm.org/pipermail/llvm-dev/2019-September/135337.html
-
[147] http://msyksphinz.hatenablog.com/entry/2019/08/17/040000
-
[152] https://lists.llvm.org/pipermail/llvm-dev/2019-September/134921.html
-
[154] http://lists.llvm.org/pipermail/llvm-dev/2017-June/114675.html
-
[157] http://llvm.org/devmtg/2014-10/Slides/Estes-MISchedulerTutorial.pdf
-
[158] https://lists.llvm.org/pipermail/llvm-dev/2016-April/098535.html
-
[160] https://www.anandtech.com/show/11441/dynamiq-and-arms-new-cpus-cortex-a75-a55/4
-
[161] https://llvm.org/devmtg/2012-11/Larin-Trick-Scheduling.pdf
-
[162] https://llvm.org/devmtg/2016-09/slides/Absar-SchedulingInOrder.pdf