パート1:はじめにと字句解析
パート2:パーサーとASTの実装
パート3:LLVM IRコード生成
パート4:JITおよびオプティマイザーサポートの追加
パート5:言語拡張:制御フロー
パート6:言語拡張:ユーザー定義演算子
パート7:言語拡張:可変変数
パート8:オブジェクトコードへのコンパイル
パート9:デバッグ情報の追加
パート10:結論とその他のLLVMの利点
9.1。 はじめに
ガイド「LLVMを使用したプログラミング言語の作成」の第9章にようこそ。 第1章から第8章では、関数と変数を含む小さなプログラミング言語を作成しました。 何か問題が発生した場合、プログラムをデバッグする方法はどうなりますか?
ソースコードレベルでのデバッグでは、デバッガーがバイナリコードからソースプログラマーが書いた情報に変換するのに役立つフォーマットデータを使用します。 LLVMは通常、DWARF形式を使用します。 コンパクトな形式のDWARFは、タイプ、ソースコードの場所、および変数の場所をエンコードします。
この章の簡単な要約では、デバッグ情報をサポートするためにプログラミング言語に追加する必要があるさまざまなものと、それをDWARFに変換する方法について説明します。
警告:これで、JITモードでデバッグできなくなります。プログラムをコンパイルする必要があります。 言語の作業とコンパイルの両方に関していくつかの変更を行います。 これで、対話モードでのJIT実行ではなく、Kaleidoscope言語のソースファイルからのコンパイルができます。 必要な変更の数を減らすために、「上位レベル」にチームを1つだけにするという制限を導入します。
コンパイルするプログラムの例:
def fib(x) if x < 3 then 1 else fib(x-1)+fib(x-2); fib(10)
9.2。 なぜこれが難しいタスクですか?
デバッグ情報を有効にすることは、主にコードの最適化のために、いくつかの理由で複雑なタスクです。 第一に、最適化中にコードの場所に関する情報を保存することはより困難です。 LLVM IRでは、各IRレベルの命令のソースコードに場所を保存します。 最適化パスは、新しく作成されたチームの場所を保存する必要がありますが、命令を結合すると1つの場所しか保存されず、最適化されたプログラム全体でジャンプが発生する可能性があります。 第二に、最適化は、他の変数とメモリを共有でき、追跡が困難になるような方法で変数を移動できます。 このチュートリアルでは、最適化を使用しません(後で説明します)。
9.3。 AOTコンパイルモード(事前コンパイル)
ソース言語へのデバッグ情報の追加の側面のみをカバーし、JITモードでのデバッグの難しさについて心配することはありません。また、実行、デバッグ、および結果を確認できるスタンドアロンプログラムへのフロントエンドによって生成されたIRのコンパイルをサポートするために、Kaleidoscopeでいくつかの変更を行います。
最初に、「main」と呼ばれる最上位レベルのコードを含む無名関数を作成します。
- auto Proto = llvm::make_unique<PrototypeAST>("", std::vector<std::string>()); + auto Proto = llvm::make_unique<PrototypeAST>("main", std::vector<std::string>());
この小さな変更により、関数に名前が付けられます。
次に、すべてのコマンドライン関連のコードを削除します。
@@ -1129,7 +1129,6 @@ static void HandleTopLevelExpression() { /// top ::= definition | external | expression | ';' static void MainLoop() { while (1) { - fprintf(stderr, "ready> "); switch (CurTok) { case tok_eof: return; @@ -1184,7 +1183,6 @@ int main() { BinopPrecedence['*'] = 40; // . // - fprintf(stderr, "ready> "); getNextToken();
最後に、すべての最適化とJITパスをオフにして、解析とLLVM IRコード生成のみが残るようにします。
@@ -1108,17 +1108,8 @@ static void HandleExtern() { static void HandleTopLevelExpression() { // if (auto FnAST = ParseTopLevelExpr()) { - if (auto *FnIR = FnAST->codegen()) { - // , - TheExecutionEngine->finalizeObject(); - // JIT, - void *FPtr = TheExecutionEngine->getPointerToFunction(FnIR); - - // ( , double), - // . - double (*FP)() = (double (*)())(intptr_t)FPtr; - // . - (void)FP; + if (!F->codegen()) { + fprintf(stderr, "Error generating code for top level expr"); } } else { // @@ -1439,11 +1459,11 @@ int main() { // TheModule->setDataLayout(TheExecutionEngine->getDataLayout()); OurFPM.add(new DataLayoutPass()); +#if 0 OurFPM.add(createBasicAliasAnalysisPass()); // alloca OurFPM.add(createPromoteMemoryToRegisterPass()); @@ -1218,7 +1210,7 @@ int main() { OurFPM.add(createGVNPass()); // ( , ). OurFPM.add(createCFGSimplificationPass()); - + #endif OurFPM.doInitialization();
この比較的小規模な変更により、Kaleidoscopeの一部をコマンドラインを使用して実行可能プログラムにコンパイルできるようになります。
Kaleidoscope-Ch9 < fib.ks | & clang -x ir -
現在の作業ディレクトリでa.out / a.exeを取得します。
9.4。 コンパイルユニット
DWARFのコードセクションの最上位コンテナはコンパイル単位です。
別の翻訳モジュール(つまり、翻訳モジュールの1つのファイル)のタイプと機能に関するデータが含まれています。 そして最初に必要なことは、fib.ksファイル用のそのようなユニットを構築することです。
9.5。 DWARF生成を構成する
IRBuilderクラスと同様に、LLVM IRファイルのメタデータを作成するのに役立つDIBuilderクラスがあります。 1対1は、IRBuilderとLLVM IRに対応します。 その使用には、IRBuilderが命令の名前を知るのに必要なDWARF用語に精通している必要がありますが、メタデータ形式のドキュメントを読むと、すべてが明確になります。 このクラスを使用して、すべてのIRレベルの記述を作成します。 それらの構築は、モジュールオブジェクトを構築した直後に行われます。 これらの記述はすべて、この方法で使用する方が簡単なので、グローバルな静的変数として構築されます。
次に、一般的に使用されるオブジェクトをキャッシュする小さなコンテナを作成します。 最初はコンパイル単位で、唯一の型のコードも記述します。異なる型の式については心配しません。
static DIBuilder *DBuilder; struct DebugInfo { DICompileUnit *TheCU; DIType *DblTy; DIType *getDoubleTy(); } KSDbgInfo; DIType *DebugInfo::getDoubleTy() { if (DblTy) return DblTy; DblTy = DBuilder->createBasicType("double", 64, 64, dwarf::DW_ATE_float); return DblTy; }
そして、さらにメイン関数で、モジュールを作成します:
DBuilder = new DIBuilder(*TheModule); KSDbgInfo.TheCU = DBuilder->createCompileUnit( dwarf::DW_LANG_C, "fib.ks", ".", "Kaleidoscope Compiler", 0, "", 0);
注目すべき点がいくつかあります。 まず、Kaleidoscopeと呼ばれる言語のコンパイルユニットを作成しますが、Cの定数を使用します。これは、デバッガーが認識しない言語の呼び出し規約またはABIを理解する必要がなく、ジェネレーターでC ABIに固執するためです。コード。 この場合、デバッガーから関数を呼び出して実行することを確認できます。 次に、createCompileUnitの呼び出しで「fib.ks」が表示されます。 これはデフォルト値です。これは、シェルリダイレクトを使用してソースをKaleidoscopeコンパイラに取り込むためです。 通常のフロントエンドでは、その場所に入力ファイルの名前があります。
そして、DIBuilderを介してデバッグ情報を生成する最後のことは、デバッグ情報を「最終化」する必要があるということです。 この理由はDIBuilder APIにあり、メイン関数の終わり近くでこれを行う必要があります。
DBuilder->finalize();
モジュールをダンプする前に。
9.6。 機能
これで、コンパイルユニットとソースコードの場所ができました。デバッグ情報に関数定義を追加できます。 PrototypeAST :: codegen()で、数行のコードを追加して、ルーチンのコンテキスト(この場合は「ファイル」)、および関数自体の実際の定義を記述します。
コンテキスト:
DIFile *Unit = DBuilder->createFile(KSDbgInfo.TheCU.getFilename(), KSDbgInfo.TheCU.getDirectory());
はDIFileを提供し、現在のディレクトリとファイル名に対して上で作成したコンパイルユニットを要求します。 次に、ゼロのソースコードの場所を使用し(ASTにはまだコードの場所に関する情報がないため)、関数定義を作成します。
DIScope *FContext = Unit; unsigned LineNo = 0; unsigned ScopeLine = 0; DISubprogram *SP = DBuilder->createFunction( FContext, P.getName(), StringRef(), Unit, LineNo, CreateFunctionType(TheFunction->arg_size(), Unit), false /* internal linkage */, true /* definition */, ScopeLine, DINode::FlagPrototyped, false); TheFunction->setSubprogram(SP);
そして、関数のすべてのメタデータへのリンクを含むDISubprogramができました。
9.7。 ソースの場所
デバッグ情報で最も重要なことは、ソースコードの場所の正確さです。これにより、ソースコード内の場所を見つけることができます。 ここでの問題は、Kaleidoscopeには字句アナライザーおよびパーサーのソースの場所に関する情報がないため、追加する必要があるということです。
struct SourceLocation { int Line; int Col; }; static SourceLocation CurLoc; static SourceLocation LexLoc = {1, 0}; static int advance() { int LastChar = getchar(); if (LastChar == '\n' || LastChar == '\r') { LexLoc.Line++; LexLoc.Col = 0; } else LexLoc.Col++; return LastChar; }
このコードでは、ソースファイルの行と列を追跡する機能を追加します。 各トークンの字句解析が確立されると、トークンの先頭の対応する行と列に「字句位置」を設定します。 これを行うには、すべてのgetchar()呼び出しを情報を追跡する新しいadvance()関数に置き換えてから、すべてのASTクラスにソーステキストの場所を追加します。
class ExprAST { SourceLocation Loc; public: ExprAST(SourceLocation Loc = CurLoc) : Loc(Loc) {} virtual ~ExprAST() {} virtual Value* codegen() = 0; int getLine() const { return Loc.Line; } int getCol() const { return Loc.Col; } virtual raw_ostream &dump(raw_ostream &out, int ind) { return out << ':' << getLine() << ':' << getCol() << '\n'; }
新しい式を作成するときにこれらの場所を渡します。
LHS = llvm::make_unique<BinaryExprAST>(BinLoc, BinOp, std::move(LHS), std::move(RHS));
そして、位置は各式と変数に割り当てられます。
各命令が正しい位置情報を受け取ったことを確認するために、ソースオブジェクトの新しい位置にいるかどうかをBuilderオブジェクトに伝える必要があります。 これを行うには、小さなヘルパー関数を使用します。
void DebugInfo::emitLocation(ExprAST *AST) { DIScope *Scope; if (LexicalBlocks.empty()) Scope = TheCU; else Scope = LexicalBlocks.back(); Builder.SetCurrentDebugLocation( DebugLoc::get(AST->getLine(), AST->getCol(), Scope)); }
これは、IRBuilderオブジェクトに現在の位置とスコープを伝えます。 有効範囲は、コンパイル単位レベルまたは現在の関数など、最も近い周囲の字句ブロックのいずれかです。 これを表すために、スコープのスタックを作成します。
std::vector<DIScope *> LexicalBlocks;
各関数のコード生成を開始するときに、スタックの一番上にスコープ(関数)を配置します。
KSDbgInfo.LexicalBlocks.push_back(SP);
また、関数のコード生成の最後に、スタックからスコープを削除することを忘れないでください。
// KSDbgInfo.LexicalBlocks.pop_back();
次に、新しいASTオブジェクトのコードの生成を開始するたびに、必ず場所を生成します。
KSDbgInfo.emitLocation(this);
9.8。 変数
現在、関数があり、スコープ内の変数を表示する機能が必要です。 関数の引数のセットを取得して、関数がどのように呼び出されたかを追跡して確認できるようにします。 以下にコードを示します。FunctionAST:: codegenで引数の割り当てを作成するときにすべてのアクションを実行します。
// map NamedValues. NamedValues.clear(); unsigned ArgIdx = 0; for (auto &Arg : TheFunction->args()) { // alloca AllocaInst *Alloca = CreateEntryBlockAlloca(TheFunction, Arg.getName()); // DILocalVariable *D = DBuilder->createParameterVariable( SP, Arg.getName(), ++ArgIdx, Unit, LineNo, KSDbgInfo.getDoubleTy(), true); DBuilder->insertDeclare(Alloca, D, DBuilder->createExpression(), DebugLoc::get(LineNo, 0, SP), Builder.GetInsertBlock()); // alloca. Builder.CreateStore(&Arg, Alloca); // NamedValues[Arg.getName()] = Alloca; }
ここでは、最初に変数を作成し、スコープ(SP)、名前、ソースコードの場所、型、および引数の場合は引数のインデックスを割り当てます。 次に、allocaに変数があることをIRレベルで示すためにlvm.dbg.declareの呼び出しを作成し(変数の開始位置を設定し)、ソーステキストの位置を設定してスコープを開始します。
ここで注意すべき興味深い点の1つは、さまざまなデバッガーが、コードとデバッグ情報がどのように生成されたかについて異なる仮定を行うことです。 この場合、ブレークポイントを設定するときにデバッガーがこれらの命令をスキップするように、関数プロローグの情報を生成しないように、いくつかの小さなハックを作成する必要があります。 FunctionAST :: CodeGenで、次の行を追加します。
// ( // , // KSDbgInfo.emitLocation(nullptr);
そして、実際に関数本体のコードの生成を開始するときに新しい場所を生成します。
KSDbgInfo.emitLocation(Body.get());
これで、関数にブレークポイントを設定し、関数の変数引数を出力し、関数を呼び出すのに十分なデバッグ情報が得られました。 ほんの数行のコードで悪くない!
9.9。 完全なコードリスト
以下は、デバッグ情報で拡張された作業例のコードの完全なリストです。 サンプルをビルドするには、次を実行します。
# clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy # ./toy
完全なコード
#include "llvm/ADT/STLExtras.h" #include "llvm/Analysis/BasicAliasAnalysis.h" #include "llvm/Analysis/Passes.h" #include "llvm/IR/DIBuilder.h" #include "llvm/IR/IRBuilder.h" #include "llvm/IR/LLVMContext.h" #include "llvm/IR/LegacyPassManager.h" #include "llvm/IR/Module.h" #include "llvm/IR/Verifier.h" #include "llvm/Support/TargetSelect.h" #include "llvm/Transforms/Scalar.h" #include <cctype> #include <cstdio> #include <map> #include <string> #include <vector> #include "../include/KaleidoscopeJIT.h" using namespace llvm; using namespace llvm::orc; //===----------------------------------------------------------------------===// // //===----------------------------------------------------------------------===// // [0-255] , // enum Token { tok_eof = -1, // tok_def = -2, tok_extern = -3, // tok_identifier = -4, tok_number = -5, // tok_if = -6, tok_then = -7, tok_else = -8, tok_for = -9, tok_in = -10, // tok_binary = -11, tok_unary = -12, // tok_var = -13 }; std::string getTokName(int Tok) { switch (Tok) { case tok_eof: return "eof"; case tok_def: return "def"; case tok_extern: return "extern"; case tok_identifier: return "identifier"; case tok_number: return "number"; case tok_if: return "if"; case tok_then: return "then"; case tok_else: return "else"; case tok_for: return "for"; case tok_in: return "in"; case tok_binary: return "binary"; case tok_unary: return "unary"; case tok_var: return "var"; } return std::string(1, (char)Tok); } namespace { class PrototypeAST; class ExprAST; } static LLVMContext TheContext; static IRBuilder<> Builder(TheContext); struct DebugInfo { DICompileUnit *TheCU; DIType *DblTy; std::vector<DIScope *> LexicalBlocks; void emitLocation(ExprAST *AST); DIType *getDoubleTy(); } KSDbgInfo; struct SourceLocation { int Line; int Col; }; static SourceLocation CurLoc; static SourceLocation LexLoc = {1, 0}; static int advance() { int LastChar = getchar(); if (LastChar == '\n' || LastChar == '\r') { LexLoc.Line++; LexLoc.Col = 0; } else LexLoc.Col++; return LastChar; } static std::string IdentifierStr; // tok_identifier static double NumVal; // tok_number /// gettok - static int gettok() { static int LastChar = ' '; // while (isspace(LastChar)) LastChar = advance(); CurLoc = LexLoc; if (isalpha(LastChar)) { // : [a-zA-Z][a-zA-Z0-9]* IdentifierStr = LastChar; while (isalnum((LastChar = advance()))) IdentifierStr += LastChar; if (IdentifierStr == "def") return tok_def; if (IdentifierStr == "extern") return tok_extern; if (IdentifierStr == "if") return tok_if; if (IdentifierStr == "then") return tok_then; if (IdentifierStr == "else") return tok_else; if (IdentifierStr == "for") return tok_for; if (IdentifierStr == "in") return tok_in; if (IdentifierStr == "binary") return tok_binary; if (IdentifierStr == "unary") return tok_unary; if (IdentifierStr == "var") return tok_var; return tok_identifier; } if (isdigit(LastChar) || LastChar == '.') { // : [0-9.]+ std::string NumStr; do { NumStr += LastChar; LastChar = advance(); } while (isdigit(LastChar) || LastChar == '.'); NumVal = strtod(NumStr.c_str(), nullptr); return tok_number; } if (LastChar == '#') { // do LastChar = advance(); while (LastChar != EOF && LastChar != '\n' && LastChar != '\r'); if (LastChar != EOF) return gettok(); } // . EOF. if (LastChar == EOF) return tok_eof; // , ascii-. int ThisChar = LastChar; LastChar = advance(); return ThisChar; } //===----------------------------------------------------------------------===// // ( ) //===----------------------------------------------------------------------===// namespace { raw_ostream &indent(raw_ostream &O, int size) { return O << std::string(size, ' '); } /// ExprAST - . class ExprAST { SourceLocation Loc; public: ExprAST(SourceLocation Loc = CurLoc) : Loc(Loc) {} virtual ~ExprAST() {} virtual Value *codegen() = 0; int getLine() const { return Loc.Line; } int getCol() const { return Loc.Col; } virtual raw_ostream &dump(raw_ostream &out, int ind) { return out << ':' << getLine() << ':' << getCol() << '\n'; } }; /// NumberExprAST - "1.0". class NumberExprAST : public ExprAST { double Val; public: NumberExprAST(double Val) : Val(Val) {} raw_ostream &dump(raw_ostream &out, int ind) override { return ExprAST::dump(out << Val, ind); } Value *codegen() override; }; /// VariableExprAST - , , "a". class VariableExprAST : public ExprAST { std::string Name; public: VariableExprAST(SourceLocation Loc, const std::string &Name) : ExprAST(Loc), Name(Name) {} const std::string &getName() const { return Name; } Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { return ExprAST::dump(out << Name, ind); } }; /// UnaryExprAST - class UnaryExprAST : public ExprAST { char Opcode; std::unique_ptr<ExprAST> Operand; public: UnaryExprAST(char Opcode, std::unique_ptr<ExprAST> Operand) : Opcode(Opcode), Operand(std::move(Operand)) {} Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { ExprAST::dump(out << "unary" << Opcode, ind); Operand->dump(out, ind + 1); return out; } }; /// BinaryExprAST - class BinaryExprAST : public ExprAST { char Op; std::unique_ptr<ExprAST> LHS, RHS; public: BinaryExprAST(SourceLocation Loc, char Op, std::unique_ptr<ExprAST> LHS, std::unique_ptr<ExprAST> RHS) : ExprAST(Loc), Op(Op), LHS(std::move(LHS)), RHS(std::move(RHS)) {} Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { ExprAST::dump(out << "binary" << Op, ind); LHS->dump(indent(out, ind) << "LHS:", ind + 1); RHS->dump(indent(out, ind) << "RHS:", ind + 1); return out; } }; /// CallExprAST - class CallExprAST : public ExprAST { std::string Callee; std::vector<std::unique_ptr<ExprAST>> Args; public: CallExprAST(SourceLocation Loc, const std::string &Callee, std::vector<std::unique_ptr<ExprAST>> Args) : ExprAST(Loc), Callee(Callee), Args(std::move(Args)) {} Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { ExprAST::dump(out << "call " << Callee, ind); for (const auto &Arg : Args) Arg->dump(indent(out, ind + 1), ind + 1); return out; } }; /// IfExprAST - if/then/else. class IfExprAST : public ExprAST { std::unique_ptr<ExprAST> Cond, Then, Else; public: IfExprAST(SourceLocation Loc, std::unique_ptr<ExprAST> Cond, std::unique_ptr<ExprAST> Then, std::unique_ptr<ExprAST> Else) : ExprAST(Loc), Cond(std::move(Cond)), Then(std::move(Then)), Else(std::move(Else)) {} Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { ExprAST::dump(out << "if", ind); Cond->dump(indent(out, ind) << "Cond:", ind + 1); Then->dump(indent(out, ind) << "Then:", ind + 1); Else->dump(indent(out, ind) << "Else:", ind + 1); return out; } }; /// ForExprAST - for/in. class ForExprAST : public ExprAST { std::string VarName; std::unique_ptr<ExprAST> Start, End, Step, Body; public: ForExprAST(const std::string &VarName, std::unique_ptr<ExprAST> Start, std::unique_ptr<ExprAST> End, std::unique_ptr<ExprAST> Step, std::unique_ptr<ExprAST> Body) : VarName(VarName), Start(std::move(Start)), End(std::move(End)), Step(std::move(Step)), Body(std::move(Body)) {} Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { ExprAST::dump(out << "for", ind); Start->dump(indent(out, ind) << "Cond:", ind + 1); End->dump(indent(out, ind) << "End:", ind + 1); Step->dump(indent(out, ind) << "Step:", ind + 1); Body->dump(indent(out, ind) << "Body:", ind + 1); return out; } }; /// VarExprAST - var/in class VarExprAST : public ExprAST { std::vector<std::pair<std::string, std::unique_ptr<ExprAST>>> VarNames; std::unique_ptr<ExprAST> Body; public: VarExprAST( std::vector<std::pair<std::string, std::unique_ptr<ExprAST>>> VarNames, std::unique_ptr<ExprAST> Body) : VarNames(std::move(VarNames)), Body(std::move(Body)) {} Value *codegen() override; raw_ostream &dump(raw_ostream &out, int ind) override { ExprAST::dump(out << "var", ind); for (const auto &NamedVar : VarNames) NamedVar.second->dump(indent(out, ind) << NamedVar.first << ':', ind + 1); Body->dump(indent(out, ind) << "Body:", ind + 1); return out; } }; /// PrototypeAST - "" , /// , (, , /// , ), . class PrototypeAST { std::string Name; std::vector<std::string> Args; bool IsOperator; unsigned Precedence; // int Line; public: PrototypeAST(SourceLocation Loc, const std::string &Name, std::vector<std::string> Args, bool IsOperator = false, unsigned Prec = 0) : Name(Name), Args(std::move(Args)), IsOperator(IsOperator), Precedence(Prec), Line(Loc.Line) {} Function *codegen(); const std::string &getName() const { return Name; } bool isUnaryOp() const { return IsOperator && Args.size() == 1; } bool isBinaryOp() const { return IsOperator && Args.size() == 2; } char getOperatorName() const { assert(isUnaryOp() || isBinaryOp()); return Name[Name.size() - 1]; } unsigned getBinaryPrecedence() const { return Precedence; } int getLine() const { return Line; } }; /// FunctionAST - class FunctionAST { std::unique_ptr<PrototypeAST> Proto; std::unique_ptr<ExprAST> Body; public: FunctionAST(std::unique_ptr<PrototypeAST> Proto, std::unique_ptr<ExprAST> Body) : Proto(std::move(Proto)), Body(std::move(Body)) {} Function *codegen(); raw_ostream &dump(raw_ostream &out, int ind) { indent(out, ind) << "FunctionAST\n"; ++ind; indent(out, ind) << "Body:"; return Body ? Body->dump(out, ind) : out << "null\n"; } }; } // //===----------------------------------------------------------------------===// // //===----------------------------------------------------------------------===// /// CurTok/getNextToken - . CurTok - /// , . getNextToken /// CurTok . static int CurTok; static int getNextToken() { return CurTok = gettok(); } /// BinopPrecedence - , /// static std::map<char, int> BinopPrecedence; /// GetTokPrecedence - . static int GetTokPrecedence() { if (!isascii(CurTok)) return -1; // , int TokPrec = BinopPrecedence[CurTok]; if (TokPrec <= 0) return -1; return TokPrec; } /// LogError* - . std::unique_ptr<ExprAST> LogError(const char *Str) { fprintf(stderr, "Error: %s\n", Str); return nullptr; } std::unique_ptr<PrototypeAST> LogErrorP(const char *Str) { LogError(Str); return nullptr; } static std::unique_ptr<ExprAST> ParseExpression(); /// numberexpr ::= number static std::unique_ptr<ExprAST> ParseNumberExpr() { auto Result = llvm::make_unique<NumberExprAST>(NumVal); getNextToken(); // return std::move(Result); } /// parenexpr ::= '(' expression ')' static std::unique_ptr<ExprAST> ParseParenExpr() { getNextToken(); // (. auto V = ParseExpression(); if (!V) return nullptr; if (CurTok != ')') return LogError("expected ')'"); getNextToken(); // ). return V; } /// identifierexpr /// ::= identifier /// ::= identifier '(' expression* ')' static std::unique_ptr<ExprAST> ParseIdentifierExpr() { std::string IdName = IdentifierStr; SourceLocation LitLoc = CurLoc; getNextToken(); // . if (CurTok != '(') // . return llvm::make_unique<VariableExprAST>(LitLoc, IdName); // Call. getNextToken(); // ( std::vector<std::unique_ptr<ExprAST>> Args; if (CurTok != ')') { while (1) { if (auto Arg = ParseExpression()) Args.push_back(std::move(Arg)); else return nullptr; if (CurTok == ')') break; if (CurTok != ',') return LogError("Expected ')' or ',' in argument list"); getNextToken(); } } // ')'. getNextToken(); return llvm::make_unique<CallExprAST>(LitLoc, IdName, std::move(Args)); } /// ifexpr ::= 'if' expression 'then' expression 'else' expression static std::unique_ptr<ExprAST> ParseIfExpr() { SourceLocation IfLoc = CurLoc; getNextToken(); // if. // . auto Cond = ParseExpression(); if (!Cond) return nullptr; if (CurTok != tok_then) return LogError("expected then"); getNextToken(); // then auto Then = ParseExpression(); if (!Then) return nullptr; if (CurTok != tok_else) return LogError("expected else"); getNextToken(); auto Else = ParseExpression(); if (!Else) return nullptr; return llvm::make_unique<IfExprAST>(IfLoc, std::move(Cond), std::move(Then), std::move(Else)); } /// forexpr ::= 'for' identifier '=' expr ',' expr (',' expr)? 'in' expression static std::unique_ptr<ExprAST> ParseForExpr() { getNextToken(); // for. if (CurTok != tok_identifier) return LogError("expected identifier after for"); std::string IdName = IdentifierStr; getNextToken(); // . if (CurTok != '=') return LogError("expected '=' after for"); getNextToken(); // '='. auto Start = ParseExpression(); if (!Start) return nullptr; if (CurTok != ',') return LogError("expected ',' after for start value"); getNextToken(); auto End = ParseExpression(); if (!End) return nullptr; // . std::unique_ptr<ExprAST> Step; if (CurTok == ',') { getNextToken(); Step = ParseExpression(); if (!Step) return nullptr; } if (CurTok != tok_in) return LogError("expected 'in' after for"); getNextToken(); // 'in'. auto Body = ParseExpression(); if (!Body) return nullptr; return llvm::make_unique<ForExprAST>(IdName, std::move(Start), std::move(End), std::move(Step), std::move(Body)); } /// varexpr ::= 'var' identifier ('=' expression)? // (',' identifier ('=' expression)?)* 'in' expression static std::unique_ptr<ExprAST> ParseVarExpr() { getNextToken(); // var. std::vector<std::pair<std::string, std::unique_ptr<ExprAST>>> VarNames; // if (CurTok != tok_identifier) return LogError("expected identifier after var"); while (1) { std::string Name = IdentifierStr; getNextToken(); // .. // std::unique_ptr<ExprAST> Init = nullptr; if (CurTok == '=') { getNextToken(); // '='. Init = ParseExpression(); if (!Init) return nullptr; } VarNames.push_back(std::make_pair(Name, std::move(Init))); // , . if (CurTok != ',') break; getNextToken(); // ','. if (CurTok != tok_identifier) return LogError("expected identifier list after var"); } // 'in'. if (CurTok != tok_in) return LogError("expected 'in' keyword after 'var'"); getNextToken(); // 'in'. auto Body = ParseExpression(); if (!Body) return nullptr; return llvm::make_unique<VarExprAST>(std::move(VarNames), std::move(Body)); } /// primary /// ::= identifierexpr /// ::= numberexpr /// ::= parenexpr /// ::= ifexpr /// ::= forexpr /// ::= varexpr static std::unique_ptr<ExprAST> ParsePrimary() { switch (CurTok) { default: return LogError("unknown token when expecting an expression"); case tok_identifier: return ParseIdentifierExpr(); case tok_number: return ParseNumberExpr(); case '(': return ParseParenExpr(); case tok_if: return ParseIfExpr(); case tok_for: return ParseForExpr(); case tok_var: return ParseVarExpr(); } } /// unary /// ::= primary /// ::= '!' unary static std::unique_ptr<ExprAST> ParseUnary() { // , . if (!isascii(CurTok) || CurTok == '(' || CurTok == ',') return ParsePrimary(); // , int Opc = CurTok; getNextToken(); if (auto Operand = ParseUnary()) return llvm::make_unique<UnaryExprAST>(Opc, std::move(Operand)); return nullptr; } /// binoprhs /// ::= ('+' unary)* static std::unique_ptr<ExprAST> ParseBinOpRHS(int ExprPrec, std::unique_ptr<ExprAST> LHS) { // , while (1) { int TokPrec = GetTokPrecedence(); // , // , if (TokPrec < ExprPrec) return LHS; // , int BinOp = CurTok; SourceLocation BinLoc = CurLoc; getNextToken(); // // auto RHS = ParseUnary(); if (!RHS) return nullptr; // BinOp RHS, RHS, // RHS LHS. int NextPrec = GetTokPrecedence(); if (TokPrec < NextPrec) { RHS = ParseBinOpRHS(TokPrec + 1, std::move(RHS)); if (!RHS) return nullptr; } // LHS/RHS. LHS = llvm::make_unique<BinaryExprAST>(BinLoc, BinOp, std::move(LHS), std::move(RHS)); } } /// expression /// ::= unary binoprhs /// static std::unique_ptr<ExprAST> ParseExpression() { auto LHS = ParseUnary(); if (!LHS) return nullptr; return ParseBinOpRHS(0, std::move(LHS)); } /// prototype /// ::= id '(' id* ')' /// ::= binary LETTER number? (id, id) /// ::= unary LETTER (id) static std::unique_ptr<PrototypeAST> ParsePrototype() { std::string FnName; SourceLocation FnLoc = CurLoc; unsigned Kind = 0; // 0 = , 1 = , 2 = . unsigned BinaryPrecedence = 30; switch (CurTok) { default: return LogErrorP("Expected function name in prototype"); case tok_identifier: FnName = IdentifierStr; Kind = 0; getNextToken(); break; case tok_unary: getNextToken(); if (!isascii(CurTok)) return LogErrorP("Expected unary operator"); FnName = "unary"; FnName += (char)CurTok; Kind = 1; getNextToken(); break; case tok_binary: getNextToken(); if (!isascii(CurTok)) return LogErrorP("Expected binary operator"); FnName = "binary"; FnName += (char)CurTok; Kind = 2; getNextToken(); // , if (CurTok == tok_number) { if (NumVal < 1 || NumVal > 100) return LogErrorP("Invalid precedence: must be 1..100"); BinaryPrecedence = (unsigned)NumVal; getNextToken(); } break; } if (CurTok != '(') return LogErrorP("Expected '(' in prototype"); std::vector<std::string> ArgNames; while (getNextToken() == tok_identifier) ArgNames.push_back(IdentifierStr); if (CurTok != ')') return LogErrorP("Expected ')' in prototype"); // . getNextToken(); // ')'. // , if (Kind && ArgNames.size() != Kind) return LogErrorP("Invalid number of operands for operator"); return llvm::make_unique<PrototypeAST>(FnLoc, FnName, ArgNames, Kind != 0, BinaryPrecedence); } /// definition ::= 'def' prototype expression static std::unique_ptr<FunctionAST> ParseDefinition() { getNextToken(); // def. auto Proto = ParsePrototype(); if (!Proto) return nullptr; if (auto E = ParseExpression()) return llvm::make_unique<FunctionAST>(std::move(Proto), std::move(E)); return nullptr; } /// toplevelexpr ::= expression static std::unique_ptr<FunctionAST> ParseTopLevelExpr() { SourceLocation FnLoc = CurLoc; if (auto E = ParseExpression()) { // auto Proto = llvm::make_unique<PrototypeAST>(FnLoc, "__anon_expr", std::vector<std::string>()); return llvm::make_unique<FunctionAST>(std::move(Proto), std::move(E)); } return nullptr; } /// external ::= 'extern' prototype static std::unique_ptr<PrototypeAST> ParseExtern() { getNextToken(); // eat extern. return ParsePrototype(); } //===----------------------------------------------------------------------===// // //===----------------------------------------------------------------------===// static std::unique_ptr<DIBuilder> DBuilder; DIType *DebugInfo::getDoubleTy() { if (DblTy) return DblTy; DblTy = DBuilder->createBasicType("double", 64, 64, dwarf::DW_ATE_float); return DblTy; } void DebugInfo::emitLocation(ExprAST *AST) { if (!AST) return Builder.SetCurrentDebugLocation(DebugLoc()); DIScope *Scope; if (LexicalBlocks.empty()) Scope = TheCU; else Scope = LexicalBlocks.back(); Builder.SetCurrentDebugLocation( DebugLoc::get(AST->getLine(), AST->getCol(), Scope)); } static DISubroutineType *CreateFunctionType(unsigned NumArgs, DIFile *Unit) { SmallVector<Metadata *, 8> EltTys; DIType *DblTy = KSDbgInfo.getDoubleTy(); // EltTys.push_back(DblTy); for (unsigned i = 0, e = NumArgs; i != e; ++i) EltTys.push_back(DblTy); return DBuilder->createSubroutineType(DBuilder->getOrCreateTypeArray(EltTys)); } //===----------------------------------------------------------------------===// // //===----------------------------------------------------------------------===// static std::unique_ptr<Module> TheModule; static std::map<std::string, AllocaInst *> NamedValues; static std::unique_ptr<KaleidoscopeJIT> TheJIT; static std::map<std::string, std::unique_ptr<PrototypeAST>> FunctionProtos; Value *LogErrorV(const char *Str) { LogError(Str); return nullptr; } Function *getFunction(std::string Name) { // , . if (auto *F = TheModule->getFunction(Name)) return F; // , // . auto FI = FunctionProtos.find(Name); if (FI != FunctionProtos.end()) return FI->second->codegen(); // , null. return nullptr; } /// CreateEntryBlockAlloca - alloca /// . . static AllocaInst *CreateEntryBlockAlloca(Function *TheFunction, const std::string &VarName) { IRBuilder<> TmpB(&TheFunction->getEntryBlock(), TheFunction->getEntryBlock().begin()); return TmpB.CreateAlloca(Type::getDoubleTy(TheContext), nullptr, VarName.c_str()); } Value *NumberExprAST::codegen() { KSDbgInfo.emitLocation(this); return ConstantFP::get(TheContext, APFloat(Val)); } Value *VariableExprAST::codegen() { // , Value *V = NamedValues[Name]; if (!V) return LogErrorV("Unknown variable name"); KSDbgInfo.emitLocation(this); // return Builder.CreateLoad(V, Name.c_str()); } Value *UnaryExprAST::codegen() { Value *OperandV = Operand->codegen(); if (!OperandV) return nullptr; Function *F = getFunction(std::string("unary") + Opcode); if (!F) return LogErrorV("Unknown unary operator"); KSDbgInfo.emitLocation(this); return Builder.CreateCall(F, OperandV, "unop"); } Value *BinaryExprAST::codegen() { KSDbgInfo.emitLocation(this); // '=', .. LHS if (Op == '=') { // , LHS // , RTTI, .. LLVM // . LLVM RTTI // dynamic_cast . VariableExprAST *LHSE = static_cast<VariableExprAST *>(LHS.get()); if (!LHSE) return LogErrorV("destination of '=' must be a variable"); // RHS. Value *Val = RHS->codegen(); if (!Val) return nullptr; // Value *Variable = NamedValues[LHSE->getName()]; if (!Variable) return LogErrorV("Unknown variable name"); Builder.CreateStore(Val, Variable); return Val; } Value *L = LHS->codegen(); Value *R = RHS->codegen(); if (!L || !R) return nullptr; switch (Op) { case '+': return Builder.CreateFAdd(L, R, "addtmp"); case '-': return Builder.CreateFSub(L, R, "subtmp"); case '*': return Builder.CreateFMul(L, R, "multmp"); case '<': L = Builder.CreateFCmpULT(L, R, "cmptmp"); // bool 0/1 double 0.0 or 1.0 return Builder.CreateUIToFP(L, Type::getDoubleTy(TheContext), "booltmp"); default: break; } // , . // . Function *F = getFunction(std::string("binary") + Op); assert(F && "binary operator not found!"); Value *Ops[] = {L, R}; return Builder.CreateCall(F, Ops, "binop"); } Value *CallExprAST::codegen() { KSDbgInfo.emitLocation(this); // Function *CalleeF = getFunction(Callee); if (!CalleeF) return LogErrorV("Unknown function referenced"); // , . if (CalleeF->arg_size() != Args.size()) return LogErrorV("Incorrect # arguments passed"); std::vector<Value *> ArgsV; for (unsigned i = 0, e = Args.size(); i != e; ++i) { ArgsV.push_back(Args[i]->codegen()); if (!ArgsV.back()) return nullptr; } return Builder.CreateCall(CalleeF, ArgsV, "calltmp"); } Value *IfExprAST::codegen() { KSDbgInfo.emitLocation(this); Value *CondV = Cond->codegen(); if (!CondV) return nullptr; // 0.0. CondV = Builder.CreateFCmpONE( CondV, ConstantFP::get(TheContext, APFloat(0.0)), "ifcond"); Function *TheFunction = Builder.GetInsertBlock()->getParent(); // then else. 'then' // BasicBlock *ThenBB = BasicBlock::Create(TheContext, "then", TheFunction); BasicBlock *ElseBB = BasicBlock::Create(TheContext, "else"); BasicBlock *MergeBB = BasicBlock::Create(TheContext, "ifcont"); Builder.CreateCondBr(CondV, ThenBB, ElseBB); // . Builder.SetInsertPoint(ThenBB); Value *ThenV = Then->codegen(); if (!ThenV) return nullptr; Builder.CreateBr(MergeBB); // 'Then' , ThenBB PHI. ThenBB = Builder.GetInsertBlock(); // "else" TheFunction->getBasicBlockList().push_back(ElseBB); Builder.SetInsertPoint(ElseBB); Value *ElseV = Else->codegen(); if (!ElseV) return nullptr; Builder.CreateBr(MergeBB); // 'Else' , ElseBB PHI. ElseBB = Builder.GetInsertBlock(); // TheFunction->getBasicBlockList().push_back(MergeBB); Builder.SetInsertPoint(MergeBB); PHINode *PN = Builder.CreatePHI(Type::getDoubleTy(TheContext), 2, "iftmp"); PN->addIncoming(ThenV, ThenBB); PN->addIncoming(ElseV, ElseBB); return PN; } // for-loop : // var = alloca double // ... // start = startexpr // store start -> var // goto loop // loop: // ... // bodyexpr // ... // loopend: // step = stepexpr // endcond = endexpr // // curvar = load var // nextvar = curvar + step // store nextvar -> var // br endcond, loop, endloop // outloop: Value *ForExprAST::codegen() { Function *TheFunction = Builder.GetInsertBlock()->getParent(); // alloca AllocaInst *Alloca = CreateEntryBlockAlloca(TheFunction, VarName); KSDbgInfo.emitLocation(this); // , 'variable' Value *StartVal = Start->codegen(); if (!StartVal) return nullptr; // alloca. Builder.CreateStore(StartVal, Alloca); // , // . BasicBlock *LoopBB = BasicBlock::Create(TheContext, "loop", TheFunction); // LoopBB. Builder.CreateBr(LoopBB); // LoopBB. Builder.SetInsertPoint(LoopBB); // , PHI-. // , , . AllocaInst *OldVal = NamedValues[VarName]; NamedValues[VarName] = Alloca; // . , , // BB. , , , // . if (!Body->codegen()) return nullptr; // Value *StepVal = nullptr; if (Step) { StepVal = Step->codegen(); if (!StepVal) return nullptr; } else { // , 1.0. StepVal = ConstantFP::get(TheContext, APFloat(1.0)); } // Value *EndCond = End->codegen(); if (!EndCond) return nullptr; // , , alloca. // Value *CurVar = Builder.CreateLoad(Alloca, VarName.c_str()); Value *NextVar = Builder.CreateFAdd(CurVar, StepVal, "nextvar"); Builder.CreateStore(NextVar, Alloca); // 0.0. EndCond = Builder.CreateFCmpONE( EndCond, ConstantFP::get(TheContext, APFloat(0.0)), "loopcond"); // " " BasicBlock *AfterBB = BasicBlock::Create(TheContext, "afterloop", TheFunction); // LoopEndBB. Builder.CreateCondBr(EndCond, LoopBB, AfterBB); // AfterBB. Builder.SetInsertPoint(AfterBB); // . if (OldVal) NamedValues[VarName] = OldVal; else NamedValues.erase(VarName); // 0.0. return Constant::getNullValue(Type::getDoubleTy(TheContext)); } Value *VarExprAST::codegen() { std::vector<AllocaInst *> OldBindings; Function *TheFunction = Builder.GetInsertBlock()->getParent(); // for (unsigned i = 0, e = VarNames.size(); i != e; ++i) { const std::string &VarName = VarNames[i].first; ExprAST *Init = VarNames[i].second.get(); // , // , // l : // var a = 1 in // var a = a in ... # 'a'. Value *InitVal; if (Init) { InitVal = Init->codegen(); if (!InitVal) return nullptr; } else { // , 0.0. InitVal = ConstantFP::get(TheContext, APFloat(0.0)); } AllocaInst *Alloca = CreateEntryBlockAlloca(TheFunction, VarName); Builder.CreateStore(InitVal, Alloca); // OldBindings.push_back(NamedValues[VarName]); // NamedValues[VarName] = Alloca; } KSDbgInfo.emitLocation(this); // Value *BodyVal = Body->codegen(); if (!BodyVal) return nullptr; // for (unsigned i = 0, e = VarNames.size(); i != e; ++i) NamedValues[VarNames[i].first] = OldBindings[i]; // return BodyVal; } Function *PrototypeAST::codegen() { // : double(double,double) etc. std::vector<Type *> Doubles(Args.size(), Type::getDoubleTy(TheContext)); FunctionType *FT = FunctionType::get(Type::getDoubleTy(TheContext), Doubles, false); Function *F = Function::Create(FT, Function::ExternalLinkage, Name, TheModule.get()); // unsigned Idx = 0; for (auto &Arg : F->args()) Arg.setName(Args[Idx++]); return F; } Function *FunctionAST::codegen() { // FunctionProtos, // . auto &P = *Proto; FunctionProtos[Proto->getName()] = std::move(Proto); Function *TheFunction = getFunction(P.getName()); if (!TheFunction) return nullptr; // , if (P.isBinaryOp()) BinopPrecedence[P.getOperatorName()] = P.getBinaryPrecedence(); // BasicBlock *BB = BasicBlock::Create(TheContext, "entry", TheFunction); Builder.SetInsertPoint(BB); // DIE DIFile *Unit = DBuilder->createFile(KSDbgInfo.TheCU->getFilename(), KSDbgInfo.TheCU->getDirectory()); DIScope *FContext = Unit; unsigned LineNo = P.getLine(); unsigned ScopeLine = LineNo; DISubprogram *SP = DBuilder->createFunction( FContext, P.getName(), StringRef(), Unit, LineNo, CreateFunctionType(TheFunction->arg_size(), Unit), false /* internal linkage */, true /* definition */, ScopeLine, DINode::FlagPrototyped, false); TheFunction->setSubprogram(SP); // KSDbgInfo.LexicalBlocks.push_back(SP); // ( // // ) KSDbgInfo.emitLocation(nullptr); // NamedValues. NamedValues.clear(); unsigned ArgIdx = 0; for (auto &Arg : TheFunction->args()) { // alloca . AllocaInst *Alloca = CreateEntryBlockAlloca(TheFunction, Arg.getName()); // DILocalVariable *D = DBuilder->createParameterVariable( SP, Arg.getName(), ++ArgIdx, Unit, LineNo, KSDbgInfo.getDoubleTy(), true); DBuilder->insertDeclare(Alloca, D, DBuilder->createExpression(), DebugLoc::get(LineNo, 0, SP), Builder.GetInsertBlock()); // alloca. Builder.CreateStore(&Arg, Alloca); // NamedValues[Arg.getName()] = Alloca; } KSDbgInfo.emitLocation(Body.get()); if (Value *RetVal = Body->codegen()) { // . Builder.CreateRet(RetVal); // . KSDbgInfo.LexicalBlocks.pop_back(); // verifyFunction(*TheFunction); return TheFunction; } // , TheFunction->eraseFromParent(); if (P.isBinaryOp()) BinopPrecedence.erase(Proto->getOperatorName()); // KSDbgInfo.LexicalBlocks.pop_back(); return nullptr; } //===----------------------------------------------------------------------===// // JIT //===----------------------------------------------------------------------===// static void InitializeModule() { // TheModule = llvm::make_unique<Module>("my cool jit", TheContext); TheModule->setDataLayout(TheJIT->getTargetMachine().createDataLayout()); } static void HandleDefinition() { if (auto FnAST = ParseDefinition()) { if (!FnAST->codegen()) fprintf(stderr, "Error reading function definition:"); } else { // getNextToken(); } } static void HandleExtern() { if (auto ProtoAST = ParseExtern()) { if (!ProtoAST->codegen()) fprintf(stderr, "Error reading extern"); else FunctionProtos[ProtoAST->getName()] = std::move(ProtoAST); } else { // getNextToken(); } } static void HandleTopLevelExpression() { // if (auto FnAST = ParseTopLevelExpr()) { if (!FnAST->codegen()) { fprintf(stderr, "Error generating code for top level expr"); } } else { // getNextToken(); } } /// top ::= definition | external | expression | ';' static void MainLoop() { while (1) { switch (CurTok) { case tok_eof: return; case ';': // . getNextToken(); break; case tok_def: HandleDefinition(); break; case tok_extern: HandleExtern(); break; default: HandleTopLevelExpression(); break; } } } //===----------------------------------------------------------------------===// // "" , //===----------------------------------------------------------------------===// #ifdef LLVM_ON_WIN32 #define DLLEXPORT __declspec(dllexport) #else #define DLLEXPORT #endif /// putchard - putchar double, 0. extern "C" DLLEXPORT double putchard(double X) { fputc((char)X, stderr); return 0; } /// printd - double "%f\n", 0. extern "C" DLLEXPORT double printd(double X) { fprintf(stderr, "%f\n", X); return 0; } //===----------------------------------------------------------------------===// // main //===----------------------------------------------------------------------===// int main() { InitializeNativeTarget(); InitializeNativeTargetAsmPrinter(); InitializeNativeTargetAsmParser(); // // 1 - BinopPrecedence['='] = 2; BinopPrecedence['<'] = 10; BinopPrecedence['+'] = 20; BinopPrecedence['-'] = 20; BinopPrecedence['*'] = 40; // . // getNextToken(); TheJIT = llvm::make_unique<KaleidoscopeJIT>(); InitializeModule(); // TheModule->addModuleFlag(Module::Warning, "Debug Info Version", DEBUG_METADATA_VERSION); // Darwin dwarf2. if (Triple(sys::getProcessTriple()).isOSDarwin()) TheModule->addModuleFlag(llvm::Module::Warning, "Dwarf Version", 2); // DIBuilder, , .. DBuilder = llvm::make_unique<DIBuilder>(*TheModule); // // "fib.ks" , stdin // , . KSDbgInfo.TheCU = DBuilder->createCompileUnit( dwarf::DW_LANG_C, "fib.ks", ".", "Kaleidoscope Compiler", 0, "", 0); // MainLoop(); // DBuilder->finalize(); // . TheModule->print(errs(), nullptr); return 0; }