このリポジトリは作者が2021年に受講した京都工芸繊維大学情報工学課程の言語処理プログラミングの成果物にアレンジを加えたものを置いているリポジトリです。
git clone https://github.com/shouth/LanguageProcessing
cd LanguageProcessing
cmake -S . -B build
cmake --build ./build # 最終成果物として ./build/mpplc が生成されます$ ./build/mpplc --help
Usage: ./build/mpplc [OPTIONS] INPUT
Options:
--dump-syntax Dump syntax tree
--pretty-print Pretty print the input file
--syntax-only Check syntax only
--emit-llvm Emit LLVM IR
--emit-casl2 Emit CASL2
--help Print this help message
カッコいい(主観)エラーメッセージが出力されます。下の画像のは極端な例だけど。
実装はreport.cにはいってます。
フォーマット自体はAriadneのものを参考…というかほぼそのまま使ってます。実装は何も見ずに一から自分でやった。
プリティプリントができます。しかも色付き。
講義ではコンパイル先の言語としてCASL2で出力を行いますが、このコンパイラにはLLVM IRを出力する機能もついてます。
./build/mpplc --emit-llvm [mpplファイル]
# mpplファイルと同じディレクトリにLLVM IRのファイルができるこんな感じのファイルが出力されます。
declare {i16, i1} @llvm.sadd.with.overflow.i16(i16, i16)
declare {i16, i1} @llvm.ssub.with.overflow.i16(i16, i16)
declare {i16, i1} @llvm.smul.with.overflow.i16(i16, i16)
declare i32 @getchar()
declare i32 @printf(ptr, ...)
declare i32 @scanf(ptr, ...)
declare void @exit(i32)
@x = common global i16 0
@high = common global i16 0
@low = common global i16 0
@mid = common global i16 0
@can = common global i16 0
define i32 @main() {
call i32 @printf(ptr @.str0)
store i8 0, ptr @x
call i32 @scanf(ptr @.format.integer, ptr @x)
call i32 @scanf(ptr @.format.line)
call i32 @getchar()
%.t2 = load i16, ptr @x
%.t3 = add i16 0, 0
%.t1 = icmp slt i16 %.t2, %.t3
br i1 %.t1, label %l2, label %l3
l2:
call i32 @printf(ptr @.str1)
br label %l1
l3:
%.t4 = add i16 0, 0
store i16 %.t4, ptr @low
%.t5 = add i16 0, 181
store i16 %.t5, ptr @high
br label %l4
; 以下省略生成されたLLVM IRのファイルをclangでコンパイルすればネイティブのプログラムが作れます。target tripleを埋め込んでないのでコンパイル時に警告が出てしまうのはご愛敬ということで。
clang [上のコマンドで生成されたLLVM IRファイル]マルチパスのコンパイラです。
- 構文木の生成(parser.c)
- 名前解決(resolver.c)
- 文法チェック(checker.c)
- コード生成(codegen_casl2.c, codegen_llvm.c)
の順に処理が進みます。講義ではワンパスで実装する形で進行していきますが、私は講義を受けていた当時もマルチパスで実装していました。
あとコンパイルオプションに -std=c89 -pedantic-errors を指定するという縛りを設けています。
可変長配列(array.c)とハッシュテーブル(map.c)を自作してます。可変長配列の方はまあ…特に面白味もないありふれた感じの実装です。
ハッシュテーブルの実装ではhopscotch hashingというアルゴリズムを使っています。ハッシュテーブルのアルゴリズムには大きく分けてチェイン法とオープンアドレス法の二つがありますが、このhopscotch hashingはチェイン法とオープンアドレス法をいい感じに統合したアルゴリズムになっています。ハッシュテーブルの充填率が高くなっても性能が落ちないこともあり、作者はこのアルゴリズムが好きです。
ハッシュテーブルは要素のハッシュ値をもとに格納する位置を定めるため、格納する位置の衝突を避けるためにも、ハッシュ値はできるだけ偏りなくばらけてくれると嬉しいです。そこでハッシュ値を計算するハッシュアルゴリズムとしてFNV-1aを使用しています。実装が簡単なのになんかええ感じに値がばらけてくれているっぽいのでなんかこう…嬉しい感じです。雪崩効果っていうらしい。
#define FNV1A_INIT 0x811C9DC5ul
unsigned long fnv1a(unsigned long hash, const void *ptr, unsigned long len)
{
const unsigned char *data = ptr;
const unsigned char *end = data + len;
const unsigned long prime = 0x01000193ul;
for (; data < end; ++data) {
hash = (hash ^ *data) * prime;
}
return 0xFFFFFFFFul & hash;
}高速なハッシュアルゴリズムとしてはxxHashがあります。ハッシュアルゴリズムを選定するときにこちらも考慮に一応いれてみましたが、実装が込み入っていて自分の実装に取り込むのはかなり手間がかかりそうだったのでやめておきました。他にも読んだうえで取り込んだらライセンスとかの問題もあるし。
FNV-1aとxxHashそれぞれに対して手元で軽くベンチマークを取ってみたのですが、ハッシュ値の計算対象となるデータが極めて小さい場合はFNV-1aの方が速いっぽいです。逆に大きい場合はxxHashの圧勝でした。まあベンチマークのやり方が悪かった可能性もありますが、FNV-1aはハッシュテーブル向けのアルゴリズムであるように思います。
Red Green Treeというroslynで発明されたらしきものを使ってます。より厳密にはRed Green Treeがrust-analyzerで改良されたあとにbiomeでさらに改良されたものと似たような感じのものを導入してみました。rust-analyzerのドキュメントに解説があるのでよろしければ参照ください。
Red Green Tree(の改良版)は
- トークンと文法の構造を、親から子の向きにリンクする形で保持する木
- トークンのファイル内での位置を保持し、子から親の向きのリンクを提供する木
- 文法ごとに異なる型を提供する木
の三層からなる木構造で構成されています。メモリ上に保持されるのは基本的に1の木構造のみで、2と3の木構造は必要に応じてその場で生成されたり消去されたりします。このような構造とすることで、シンタックスシュガーを脱糖したりなど木構造そのものに変更を与えたい時には1の木構造にパッチを当て、またリンターのルールの検査を行いたい場合には2の木構造を利用して上下方向に木構造をトラバースし、文法ごとに異なる処理を行いたい場合には3の木構造で型毎に異なる処理を実装するというように柔軟な運用ができる利点があるようです。
実際に導入してみての所感としては、エラーメッセージを出力する際の位置情報の取り扱いがとても簡単にできて嬉しい印象がありました。一方、少なからずCでコンパイラを実装する場合には、必要に応じて木構造を生成したり消去したりする部分のコードの記述が煩雑になってしまったり、3の木構造で各文法に型を持たせても利点が実感しにくいような印象もあります。もう少し実装方法について考えてみても良かったかもしれません。
気合で実装しました。仮想ターミナルっぽいもの(canvas.c)を用意して、その上に出力していく(report.c)方法を取りました。ガチで気合で実装したのでアルゴリズムもへったくれもないです。めちゃくちゃ大変だった…
メッセージ出力をbox-drawing characterを用いてリッチにしている都合上、簡易的にUTF-8を処理する仕組みが導入してあります。
レジスタ割り付けをちょっとだけ最適化してスタックへの値の出し入れが少なくなるようにしてあります。地味に実装が難しかった…
就活が嫌すぎて現実逃避の一環でできてしまった代物。CFGの理解があったこともあり二日ぐらいで実装できてしまった。すごいことをしてるっぽく見える部分ですが実際は指定のフォーマットに従ってコードを吐いていくだけなのでCASL2の生成よりも圧倒的に楽です。レジスタ割り付けとかも考える必要ないし。