1 #include "../include/KaleidoscopeJIT.h"
2 #include "llvm/ADT/STLExtras.h"
3 #include "llvm/Analysis/BasicAliasAnalysis.h"
4 #include "llvm/Analysis/Passes.h"
5 #include "llvm/IR/DIBuilder.h"
6 #include "llvm/IR/IRBuilder.h"
7 #include "llvm/IR/LLVMContext.h"
8 #include "llvm/IR/LegacyPassManager.h"
9 #include "llvm/IR/Module.h"
10 #include "llvm/IR/Verifier.h"
11 #include "llvm/Support/TargetSelect.h"
12 #include "llvm/TargetParser/Host.h"
13 #include "llvm/Transforms/Scalar.h"
21 using namespace llvm::orc
;
23 //===----------------------------------------------------------------------===//
25 //===----------------------------------------------------------------------===//
27 // The lexer returns tokens [0-255] if it is an unknown character, otherwise one
28 // of these for known things.
55 std::string
getTokName(int Tok
) {
84 return std::string(1, (char)Tok
);
95 std::vector
<DIScope
*> LexicalBlocks
;
97 void emitLocation(ExprAST
*AST
);
98 DIType
*getDoubleTy();
101 struct SourceLocation
{
105 static SourceLocation CurLoc
;
106 static SourceLocation LexLoc
= {1, 0};
108 static int advance() {
109 int LastChar
= getchar();
111 if (LastChar
== '\n' || LastChar
== '\r') {
119 static std::string IdentifierStr
; // Filled in if tok_identifier
120 static double NumVal
; // Filled in if tok_number
122 /// gettok - Return the next token from standard input.
123 static int gettok() {
124 static int LastChar
= ' ';
126 // Skip any whitespace.
127 while (isspace(LastChar
))
128 LastChar
= advance();
132 if (isalpha(LastChar
)) { // identifier: [a-zA-Z][a-zA-Z0-9]*
133 IdentifierStr
= LastChar
;
134 while (isalnum((LastChar
= advance())))
135 IdentifierStr
+= LastChar
;
137 if (IdentifierStr
== "def")
139 if (IdentifierStr
== "extern")
141 if (IdentifierStr
== "if")
143 if (IdentifierStr
== "then")
145 if (IdentifierStr
== "else")
147 if (IdentifierStr
== "for")
149 if (IdentifierStr
== "in")
151 if (IdentifierStr
== "binary")
153 if (IdentifierStr
== "unary")
155 if (IdentifierStr
== "var")
157 return tok_identifier
;
160 if (isdigit(LastChar
) || LastChar
== '.') { // Number: [0-9.]+
164 LastChar
= advance();
165 } while (isdigit(LastChar
) || LastChar
== '.');
167 NumVal
= strtod(NumStr
.c_str(), nullptr);
171 if (LastChar
== '#') {
172 // Comment until end of line.
174 LastChar
= advance();
175 while (LastChar
!= EOF
&& LastChar
!= '\n' && LastChar
!= '\r');
181 // Check for end of file. Don't eat the EOF.
185 // Otherwise, just return the character as its ascii value.
186 int ThisChar
= LastChar
;
187 LastChar
= advance();
191 //===----------------------------------------------------------------------===//
192 // Abstract Syntax Tree (aka Parse Tree)
193 //===----------------------------------------------------------------------===//
196 raw_ostream
&indent(raw_ostream
&O
, int size
) {
197 return O
<< std::string(size
, ' ');
200 /// ExprAST - Base class for all expression nodes.
205 ExprAST(SourceLocation Loc
= CurLoc
) : Loc(Loc
) {}
206 virtual ~ExprAST() {}
207 virtual Value
*codegen() = 0;
208 int getLine() const { return Loc
.Line
; }
209 int getCol() const { return Loc
.Col
; }
210 virtual raw_ostream
&dump(raw_ostream
&out
, int ind
) {
211 return out
<< ':' << getLine() << ':' << getCol() << '\n';
215 /// NumberExprAST - Expression class for numeric literals like "1.0".
216 class NumberExprAST
: public ExprAST
{
220 NumberExprAST(double Val
) : Val(Val
) {}
221 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
222 return ExprAST::dump(out
<< Val
, ind
);
224 Value
*codegen() override
;
227 /// VariableExprAST - Expression class for referencing a variable, like "a".
228 class VariableExprAST
: public ExprAST
{
232 VariableExprAST(SourceLocation Loc
, const std::string
&Name
)
233 : ExprAST(Loc
), Name(Name
) {}
234 const std::string
&getName() const { return Name
; }
235 Value
*codegen() override
;
236 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
237 return ExprAST::dump(out
<< Name
, ind
);
241 /// UnaryExprAST - Expression class for a unary operator.
242 class UnaryExprAST
: public ExprAST
{
244 std::unique_ptr
<ExprAST
> Operand
;
247 UnaryExprAST(char Opcode
, std::unique_ptr
<ExprAST
> Operand
)
248 : Opcode(Opcode
), Operand(std::move(Operand
)) {}
249 Value
*codegen() override
;
250 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
251 ExprAST::dump(out
<< "unary" << Opcode
, ind
);
252 Operand
->dump(out
, ind
+ 1);
257 /// BinaryExprAST - Expression class for a binary operator.
258 class BinaryExprAST
: public ExprAST
{
260 std::unique_ptr
<ExprAST
> LHS
, RHS
;
263 BinaryExprAST(SourceLocation Loc
, char Op
, std::unique_ptr
<ExprAST
> LHS
,
264 std::unique_ptr
<ExprAST
> RHS
)
265 : ExprAST(Loc
), Op(Op
), LHS(std::move(LHS
)), RHS(std::move(RHS
)) {}
266 Value
*codegen() override
;
267 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
268 ExprAST::dump(out
<< "binary" << Op
, ind
);
269 LHS
->dump(indent(out
, ind
) << "LHS:", ind
+ 1);
270 RHS
->dump(indent(out
, ind
) << "RHS:", ind
+ 1);
275 /// CallExprAST - Expression class for function calls.
276 class CallExprAST
: public ExprAST
{
278 std::vector
<std::unique_ptr
<ExprAST
>> Args
;
281 CallExprAST(SourceLocation Loc
, const std::string
&Callee
,
282 std::vector
<std::unique_ptr
<ExprAST
>> Args
)
283 : ExprAST(Loc
), Callee(Callee
), Args(std::move(Args
)) {}
284 Value
*codegen() override
;
285 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
286 ExprAST::dump(out
<< "call " << Callee
, ind
);
287 for (const auto &Arg
: Args
)
288 Arg
->dump(indent(out
, ind
+ 1), ind
+ 1);
293 /// IfExprAST - Expression class for if/then/else.
294 class IfExprAST
: public ExprAST
{
295 std::unique_ptr
<ExprAST
> Cond
, Then
, Else
;
298 IfExprAST(SourceLocation Loc
, std::unique_ptr
<ExprAST
> Cond
,
299 std::unique_ptr
<ExprAST
> Then
, std::unique_ptr
<ExprAST
> Else
)
300 : ExprAST(Loc
), Cond(std::move(Cond
)), Then(std::move(Then
)),
301 Else(std::move(Else
)) {}
302 Value
*codegen() override
;
303 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
304 ExprAST::dump(out
<< "if", ind
);
305 Cond
->dump(indent(out
, ind
) << "Cond:", ind
+ 1);
306 Then
->dump(indent(out
, ind
) << "Then:", ind
+ 1);
307 Else
->dump(indent(out
, ind
) << "Else:", ind
+ 1);
312 /// ForExprAST - Expression class for for/in.
313 class ForExprAST
: public ExprAST
{
315 std::unique_ptr
<ExprAST
> Start
, End
, Step
, Body
;
318 ForExprAST(const std::string
&VarName
, std::unique_ptr
<ExprAST
> Start
,
319 std::unique_ptr
<ExprAST
> End
, std::unique_ptr
<ExprAST
> Step
,
320 std::unique_ptr
<ExprAST
> Body
)
321 : VarName(VarName
), Start(std::move(Start
)), End(std::move(End
)),
322 Step(std::move(Step
)), Body(std::move(Body
)) {}
323 Value
*codegen() override
;
324 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
325 ExprAST::dump(out
<< "for", ind
);
326 Start
->dump(indent(out
, ind
) << "Cond:", ind
+ 1);
327 End
->dump(indent(out
, ind
) << "End:", ind
+ 1);
328 Step
->dump(indent(out
, ind
) << "Step:", ind
+ 1);
329 Body
->dump(indent(out
, ind
) << "Body:", ind
+ 1);
334 /// VarExprAST - Expression class for var/in
335 class VarExprAST
: public ExprAST
{
336 std::vector
<std::pair
<std::string
, std::unique_ptr
<ExprAST
>>> VarNames
;
337 std::unique_ptr
<ExprAST
> Body
;
341 std::vector
<std::pair
<std::string
, std::unique_ptr
<ExprAST
>>> VarNames
,
342 std::unique_ptr
<ExprAST
> Body
)
343 : VarNames(std::move(VarNames
)), Body(std::move(Body
)) {}
344 Value
*codegen() override
;
345 raw_ostream
&dump(raw_ostream
&out
, int ind
) override
{
346 ExprAST::dump(out
<< "var", ind
);
347 for (const auto &NamedVar
: VarNames
)
348 NamedVar
.second
->dump(indent(out
, ind
) << NamedVar
.first
<< ':', ind
+ 1);
349 Body
->dump(indent(out
, ind
) << "Body:", ind
+ 1);
354 /// PrototypeAST - This class represents the "prototype" for a function,
355 /// which captures its name, and its argument names (thus implicitly the number
356 /// of arguments the function takes), as well as if it is an operator.
359 std::vector
<std::string
> Args
;
361 unsigned Precedence
; // Precedence if a binary op.
365 PrototypeAST(SourceLocation Loc
, const std::string
&Name
,
366 std::vector
<std::string
> Args
, bool IsOperator
= false,
368 : Name(Name
), Args(std::move(Args
)), IsOperator(IsOperator
),
369 Precedence(Prec
), Line(Loc
.Line
) {}
371 const std::string
&getName() const { return Name
; }
373 bool isUnaryOp() const { return IsOperator
&& Args
.size() == 1; }
374 bool isBinaryOp() const { return IsOperator
&& Args
.size() == 2; }
376 char getOperatorName() const {
377 assert(isUnaryOp() || isBinaryOp());
378 return Name
[Name
.size() - 1];
381 unsigned getBinaryPrecedence() const { return Precedence
; }
382 int getLine() const { return Line
; }
385 /// FunctionAST - This class represents a function definition itself.
387 std::unique_ptr
<PrototypeAST
> Proto
;
388 std::unique_ptr
<ExprAST
> Body
;
391 FunctionAST(std::unique_ptr
<PrototypeAST
> Proto
,
392 std::unique_ptr
<ExprAST
> Body
)
393 : Proto(std::move(Proto
)), Body(std::move(Body
)) {}
395 raw_ostream
&dump(raw_ostream
&out
, int ind
) {
396 indent(out
, ind
) << "FunctionAST\n";
398 indent(out
, ind
) << "Body:";
399 return Body
? Body
->dump(out
, ind
) : out
<< "null\n";
402 } // end anonymous namespace
404 //===----------------------------------------------------------------------===//
406 //===----------------------------------------------------------------------===//
408 /// CurTok/getNextToken - Provide a simple token buffer. CurTok is the current
409 /// token the parser is looking at. getNextToken reads another token from the
410 /// lexer and updates CurTok with its results.
412 static int getNextToken() { return CurTok
= gettok(); }
414 /// BinopPrecedence - This holds the precedence for each binary operator that is
416 static std::map
<char, int> BinopPrecedence
;
418 /// GetTokPrecedence - Get the precedence of the pending binary operator token.
419 static int GetTokPrecedence() {
420 if (!isascii(CurTok
))
423 // Make sure it's a declared binop.
424 int TokPrec
= BinopPrecedence
[CurTok
];
430 /// LogError* - These are little helper functions for error handling.
431 std::unique_ptr
<ExprAST
> LogError(const char *Str
) {
432 fprintf(stderr
, "Error: %s\n", Str
);
436 std::unique_ptr
<PrototypeAST
> LogErrorP(const char *Str
) {
441 static std::unique_ptr
<ExprAST
> ParseExpression();
443 /// numberexpr ::= number
444 static std::unique_ptr
<ExprAST
> ParseNumberExpr() {
445 auto Result
= std::make_unique
<NumberExprAST
>(NumVal
);
446 getNextToken(); // consume the number
447 return std::move(Result
);
450 /// parenexpr ::= '(' expression ')'
451 static std::unique_ptr
<ExprAST
> ParseParenExpr() {
452 getNextToken(); // eat (.
453 auto V
= ParseExpression();
458 return LogError("expected ')'");
459 getNextToken(); // eat ).
465 /// ::= identifier '(' expression* ')'
466 static std::unique_ptr
<ExprAST
> ParseIdentifierExpr() {
467 std::string IdName
= IdentifierStr
;
469 SourceLocation LitLoc
= CurLoc
;
471 getNextToken(); // eat identifier.
473 if (CurTok
!= '(') // Simple variable ref.
474 return std::make_unique
<VariableExprAST
>(LitLoc
, IdName
);
477 getNextToken(); // eat (
478 std::vector
<std::unique_ptr
<ExprAST
>> Args
;
481 if (auto Arg
= ParseExpression())
482 Args
.push_back(std::move(Arg
));
490 return LogError("Expected ')' or ',' in argument list");
498 return std::make_unique
<CallExprAST
>(LitLoc
, IdName
, std::move(Args
));
501 /// ifexpr ::= 'if' expression 'then' expression 'else' expression
502 static std::unique_ptr
<ExprAST
> ParseIfExpr() {
503 SourceLocation IfLoc
= CurLoc
;
505 getNextToken(); // eat the if.
508 auto Cond
= ParseExpression();
512 if (CurTok
!= tok_then
)
513 return LogError("expected then");
514 getNextToken(); // eat the then
516 auto Then
= ParseExpression();
520 if (CurTok
!= tok_else
)
521 return LogError("expected else");
525 auto Else
= ParseExpression();
529 return std::make_unique
<IfExprAST
>(IfLoc
, std::move(Cond
), std::move(Then
),
533 /// forexpr ::= 'for' identifier '=' expr ',' expr (',' expr)? 'in' expression
534 static std::unique_ptr
<ExprAST
> ParseForExpr() {
535 getNextToken(); // eat the for.
537 if (CurTok
!= tok_identifier
)
538 return LogError("expected identifier after for");
540 std::string IdName
= IdentifierStr
;
541 getNextToken(); // eat identifier.
544 return LogError("expected '=' after for");
545 getNextToken(); // eat '='.
547 auto Start
= ParseExpression();
551 return LogError("expected ',' after for start value");
554 auto End
= ParseExpression();
558 // The step value is optional.
559 std::unique_ptr
<ExprAST
> Step
;
562 Step
= ParseExpression();
567 if (CurTok
!= tok_in
)
568 return LogError("expected 'in' after for");
569 getNextToken(); // eat 'in'.
571 auto Body
= ParseExpression();
575 return std::make_unique
<ForExprAST
>(IdName
, std::move(Start
), std::move(End
),
576 std::move(Step
), std::move(Body
));
579 /// varexpr ::= 'var' identifier ('=' expression)?
580 // (',' identifier ('=' expression)?)* 'in' expression
581 static std::unique_ptr
<ExprAST
> ParseVarExpr() {
582 getNextToken(); // eat the var.
584 std::vector
<std::pair
<std::string
, std::unique_ptr
<ExprAST
>>> VarNames
;
586 // At least one variable name is required.
587 if (CurTok
!= tok_identifier
)
588 return LogError("expected identifier after var");
591 std::string Name
= IdentifierStr
;
592 getNextToken(); // eat identifier.
594 // Read the optional initializer.
595 std::unique_ptr
<ExprAST
> Init
= nullptr;
597 getNextToken(); // eat the '='.
599 Init
= ParseExpression();
604 VarNames
.push_back(std::make_pair(Name
, std::move(Init
)));
606 // End of var list, exit loop.
609 getNextToken(); // eat the ','.
611 if (CurTok
!= tok_identifier
)
612 return LogError("expected identifier list after var");
615 // At this point, we have to have 'in'.
616 if (CurTok
!= tok_in
)
617 return LogError("expected 'in' keyword after 'var'");
618 getNextToken(); // eat 'in'.
620 auto Body
= ParseExpression();
624 return std::make_unique
<VarExprAST
>(std::move(VarNames
), std::move(Body
));
628 /// ::= identifierexpr
634 static std::unique_ptr
<ExprAST
> ParsePrimary() {
637 return LogError("unknown token when expecting an expression");
639 return ParseIdentifierExpr();
641 return ParseNumberExpr();
643 return ParseParenExpr();
645 return ParseIfExpr();
647 return ParseForExpr();
649 return ParseVarExpr();
656 static std::unique_ptr
<ExprAST
> ParseUnary() {
657 // If the current token is not an operator, it must be a primary expr.
658 if (!isascii(CurTok
) || CurTok
== '(' || CurTok
== ',')
659 return ParsePrimary();
661 // If this is a unary operator, read it.
664 if (auto Operand
= ParseUnary())
665 return std::make_unique
<UnaryExprAST
>(Opc
, std::move(Operand
));
671 static std::unique_ptr
<ExprAST
> ParseBinOpRHS(int ExprPrec
,
672 std::unique_ptr
<ExprAST
> LHS
) {
673 // If this is a binop, find its precedence.
675 int TokPrec
= GetTokPrecedence();
677 // If this is a binop that binds at least as tightly as the current binop,
678 // consume it, otherwise we are done.
679 if (TokPrec
< ExprPrec
)
682 // Okay, we know this is a binop.
684 SourceLocation BinLoc
= CurLoc
;
685 getNextToken(); // eat binop
687 // Parse the unary expression after the binary operator.
688 auto RHS
= ParseUnary();
692 // If BinOp binds less tightly with RHS than the operator after RHS, let
693 // the pending operator take RHS as its LHS.
694 int NextPrec
= GetTokPrecedence();
695 if (TokPrec
< NextPrec
) {
696 RHS
= ParseBinOpRHS(TokPrec
+ 1, std::move(RHS
));
702 LHS
= std::make_unique
<BinaryExprAST
>(BinLoc
, BinOp
, std::move(LHS
),
708 /// ::= unary binoprhs
710 static std::unique_ptr
<ExprAST
> ParseExpression() {
711 auto LHS
= ParseUnary();
715 return ParseBinOpRHS(0, std::move(LHS
));
719 /// ::= id '(' id* ')'
720 /// ::= binary LETTER number? (id, id)
721 /// ::= unary LETTER (id)
722 static std::unique_ptr
<PrototypeAST
> ParsePrototype() {
725 SourceLocation FnLoc
= CurLoc
;
727 unsigned Kind
= 0; // 0 = identifier, 1 = unary, 2 = binary.
728 unsigned BinaryPrecedence
= 30;
732 return LogErrorP("Expected function name in prototype");
734 FnName
= IdentifierStr
;
740 if (!isascii(CurTok
))
741 return LogErrorP("Expected unary operator");
743 FnName
+= (char)CurTok
;
749 if (!isascii(CurTok
))
750 return LogErrorP("Expected binary operator");
752 FnName
+= (char)CurTok
;
756 // Read the precedence if present.
757 if (CurTok
== tok_number
) {
758 if (NumVal
< 1 || NumVal
> 100)
759 return LogErrorP("Invalid precedence: must be 1..100");
760 BinaryPrecedence
= (unsigned)NumVal
;
767 return LogErrorP("Expected '(' in prototype");
769 std::vector
<std::string
> ArgNames
;
770 while (getNextToken() == tok_identifier
)
771 ArgNames
.push_back(IdentifierStr
);
773 return LogErrorP("Expected ')' in prototype");
776 getNextToken(); // eat ')'.
778 // Verify right number of names for operator.
779 if (Kind
&& ArgNames
.size() != Kind
)
780 return LogErrorP("Invalid number of operands for operator");
782 return std::make_unique
<PrototypeAST
>(FnLoc
, FnName
, ArgNames
, Kind
!= 0,
786 /// definition ::= 'def' prototype expression
787 static std::unique_ptr
<FunctionAST
> ParseDefinition() {
788 getNextToken(); // eat def.
789 auto Proto
= ParsePrototype();
793 if (auto E
= ParseExpression())
794 return std::make_unique
<FunctionAST
>(std::move(Proto
), std::move(E
));
798 /// toplevelexpr ::= expression
799 static std::unique_ptr
<FunctionAST
> ParseTopLevelExpr() {
800 SourceLocation FnLoc
= CurLoc
;
801 if (auto E
= ParseExpression()) {
802 // Make the top-level expression be our "main" function.
803 auto Proto
= std::make_unique
<PrototypeAST
>(FnLoc
, "main",
804 std::vector
<std::string
>());
805 return std::make_unique
<FunctionAST
>(std::move(Proto
), std::move(E
));
810 /// external ::= 'extern' prototype
811 static std::unique_ptr
<PrototypeAST
> ParseExtern() {
812 getNextToken(); // eat extern.
813 return ParsePrototype();
816 //===----------------------------------------------------------------------===//
817 // Code Generation Globals
818 //===----------------------------------------------------------------------===//
820 static std::unique_ptr
<LLVMContext
> TheContext
;
821 static std::unique_ptr
<Module
> TheModule
;
822 static std::unique_ptr
<IRBuilder
<>> Builder
;
823 static ExitOnError ExitOnErr
;
825 static std::map
<std::string
, AllocaInst
*> NamedValues
;
826 static std::unique_ptr
<KaleidoscopeJIT
> TheJIT
;
827 static std::map
<std::string
, std::unique_ptr
<PrototypeAST
>> FunctionProtos
;
829 //===----------------------------------------------------------------------===//
830 // Debug Info Support
831 //===----------------------------------------------------------------------===//
833 static std::unique_ptr
<DIBuilder
> DBuilder
;
835 DIType
*DebugInfo::getDoubleTy() {
839 DblTy
= DBuilder
->createBasicType("double", 64, dwarf::DW_ATE_float
);
843 void DebugInfo::emitLocation(ExprAST
*AST
) {
845 return Builder
->SetCurrentDebugLocation(DebugLoc());
847 if (LexicalBlocks
.empty())
850 Scope
= LexicalBlocks
.back();
851 Builder
->SetCurrentDebugLocation(DILocation::get(
852 Scope
->getContext(), AST
->getLine(), AST
->getCol(), Scope
));
855 static DISubroutineType
*CreateFunctionType(unsigned NumArgs
) {
856 SmallVector
<Metadata
*, 8> EltTys
;
857 DIType
*DblTy
= KSDbgInfo
.getDoubleTy();
859 // Add the result type.
860 EltTys
.push_back(DblTy
);
862 for (unsigned i
= 0, e
= NumArgs
; i
!= e
; ++i
)
863 EltTys
.push_back(DblTy
);
865 return DBuilder
->createSubroutineType(DBuilder
->getOrCreateTypeArray(EltTys
));
868 //===----------------------------------------------------------------------===//
870 //===----------------------------------------------------------------------===//
872 Value
*LogErrorV(const char *Str
) {
877 Function
*getFunction(std::string Name
) {
878 // First, see if the function has already been added to the current module.
879 if (auto *F
= TheModule
->getFunction(Name
))
882 // If not, check whether we can codegen the declaration from some existing
884 auto FI
= FunctionProtos
.find(Name
);
885 if (FI
!= FunctionProtos
.end())
886 return FI
->second
->codegen();
888 // If no existing prototype exists, return null.
892 /// CreateEntryBlockAlloca - Create an alloca instruction in the entry block of
893 /// the function. This is used for mutable variables etc.
894 static AllocaInst
*CreateEntryBlockAlloca(Function
*TheFunction
,
896 IRBuilder
<> TmpB(&TheFunction
->getEntryBlock(),
897 TheFunction
->getEntryBlock().begin());
898 return TmpB
.CreateAlloca(Type::getDoubleTy(*TheContext
), nullptr, VarName
);
901 Value
*NumberExprAST::codegen() {
902 KSDbgInfo
.emitLocation(this);
903 return ConstantFP::get(*TheContext
, APFloat(Val
));
906 Value
*VariableExprAST::codegen() {
907 // Look this variable up in the function.
908 Value
*V
= NamedValues
[Name
];
910 return LogErrorV("Unknown variable name");
912 KSDbgInfo
.emitLocation(this);
914 return Builder
->CreateLoad(Type::getDoubleTy(*TheContext
), V
, Name
.c_str());
917 Value
*UnaryExprAST::codegen() {
918 Value
*OperandV
= Operand
->codegen();
922 Function
*F
= getFunction(std::string("unary") + Opcode
);
924 return LogErrorV("Unknown unary operator");
926 KSDbgInfo
.emitLocation(this);
927 return Builder
->CreateCall(F
, OperandV
, "unop");
930 Value
*BinaryExprAST::codegen() {
931 KSDbgInfo
.emitLocation(this);
933 // Special case '=' because we don't want to emit the LHS as an expression.
935 // Assignment requires the LHS to be an identifier.
936 // This assume we're building without RTTI because LLVM builds that way by
937 // default. If you build LLVM with RTTI this can be changed to a
938 // dynamic_cast for automatic error checking.
939 VariableExprAST
*LHSE
= static_cast<VariableExprAST
*>(LHS
.get());
941 return LogErrorV("destination of '=' must be a variable");
943 Value
*Val
= RHS
->codegen();
948 Value
*Variable
= NamedValues
[LHSE
->getName()];
950 return LogErrorV("Unknown variable name");
952 Builder
->CreateStore(Val
, Variable
);
956 Value
*L
= LHS
->codegen();
957 Value
*R
= RHS
->codegen();
963 return Builder
->CreateFAdd(L
, R
, "addtmp");
965 return Builder
->CreateFSub(L
, R
, "subtmp");
967 return Builder
->CreateFMul(L
, R
, "multmp");
969 L
= Builder
->CreateFCmpULT(L
, R
, "cmptmp");
970 // Convert bool 0/1 to double 0.0 or 1.0
971 return Builder
->CreateUIToFP(L
, Type::getDoubleTy(*TheContext
), "booltmp");
976 // If it wasn't a builtin binary operator, it must be a user defined one. Emit
978 Function
*F
= getFunction(std::string("binary") + Op
);
979 assert(F
&& "binary operator not found!");
981 Value
*Ops
[] = {L
, R
};
982 return Builder
->CreateCall(F
, Ops
, "binop");
985 Value
*CallExprAST::codegen() {
986 KSDbgInfo
.emitLocation(this);
988 // Look up the name in the global module table.
989 Function
*CalleeF
= getFunction(Callee
);
991 return LogErrorV("Unknown function referenced");
993 // If argument mismatch error.
994 if (CalleeF
->arg_size() != Args
.size())
995 return LogErrorV("Incorrect # arguments passed");
997 std::vector
<Value
*> ArgsV
;
998 for (unsigned i
= 0, e
= Args
.size(); i
!= e
; ++i
) {
999 ArgsV
.push_back(Args
[i
]->codegen());
1004 return Builder
->CreateCall(CalleeF
, ArgsV
, "calltmp");
1007 Value
*IfExprAST::codegen() {
1008 KSDbgInfo
.emitLocation(this);
1010 Value
*CondV
= Cond
->codegen();
1014 // Convert condition to a bool by comparing non-equal to 0.0.
1015 CondV
= Builder
->CreateFCmpONE(
1016 CondV
, ConstantFP::get(*TheContext
, APFloat(0.0)), "ifcond");
1018 Function
*TheFunction
= Builder
->GetInsertBlock()->getParent();
1020 // Create blocks for the then and else cases. Insert the 'then' block at the
1021 // end of the function.
1022 BasicBlock
*ThenBB
= BasicBlock::Create(*TheContext
, "then", TheFunction
);
1023 BasicBlock
*ElseBB
= BasicBlock::Create(*TheContext
, "else");
1024 BasicBlock
*MergeBB
= BasicBlock::Create(*TheContext
, "ifcont");
1026 Builder
->CreateCondBr(CondV
, ThenBB
, ElseBB
);
1029 Builder
->SetInsertPoint(ThenBB
);
1031 Value
*ThenV
= Then
->codegen();
1035 Builder
->CreateBr(MergeBB
);
1036 // Codegen of 'Then' can change the current block, update ThenBB for the PHI.
1037 ThenBB
= Builder
->GetInsertBlock();
1040 TheFunction
->insert(TheFunction
->end(), ElseBB
);
1041 Builder
->SetInsertPoint(ElseBB
);
1043 Value
*ElseV
= Else
->codegen();
1047 Builder
->CreateBr(MergeBB
);
1048 // Codegen of 'Else' can change the current block, update ElseBB for the PHI.
1049 ElseBB
= Builder
->GetInsertBlock();
1051 // Emit merge block.
1052 TheFunction
->insert(TheFunction
->end(), MergeBB
);
1053 Builder
->SetInsertPoint(MergeBB
);
1054 PHINode
*PN
= Builder
->CreatePHI(Type::getDoubleTy(*TheContext
), 2, "iftmp");
1056 PN
->addIncoming(ThenV
, ThenBB
);
1057 PN
->addIncoming(ElseV
, ElseBB
);
1061 // Output for-loop as:
1062 // var = alloca double
1064 // start = startexpr
1065 // store start -> var
1073 // endcond = endexpr
1075 // curvar = load var
1076 // nextvar = curvar + step
1077 // store nextvar -> var
1078 // br endcond, loop, endloop
1080 Value
*ForExprAST::codegen() {
1081 Function
*TheFunction
= Builder
->GetInsertBlock()->getParent();
1083 // Create an alloca for the variable in the entry block.
1084 AllocaInst
*Alloca
= CreateEntryBlockAlloca(TheFunction
, VarName
);
1086 KSDbgInfo
.emitLocation(this);
1088 // Emit the start code first, without 'variable' in scope.
1089 Value
*StartVal
= Start
->codegen();
1093 // Store the value into the alloca.
1094 Builder
->CreateStore(StartVal
, Alloca
);
1096 // Make the new basic block for the loop header, inserting after current
1098 BasicBlock
*LoopBB
= BasicBlock::Create(*TheContext
, "loop", TheFunction
);
1100 // Insert an explicit fall through from the current block to the LoopBB.
1101 Builder
->CreateBr(LoopBB
);
1103 // Start insertion in LoopBB.
1104 Builder
->SetInsertPoint(LoopBB
);
1106 // Within the loop, the variable is defined equal to the PHI node. If it
1107 // shadows an existing variable, we have to restore it, so save it now.
1108 AllocaInst
*OldVal
= NamedValues
[VarName
];
1109 NamedValues
[VarName
] = Alloca
;
1111 // Emit the body of the loop. This, like any other expr, can change the
1112 // current BB. Note that we ignore the value computed by the body, but don't
1114 if (!Body
->codegen())
1117 // Emit the step value.
1118 Value
*StepVal
= nullptr;
1120 StepVal
= Step
->codegen();
1124 // If not specified, use 1.0.
1125 StepVal
= ConstantFP::get(*TheContext
, APFloat(1.0));
1128 // Compute the end condition.
1129 Value
*EndCond
= End
->codegen();
1133 // Reload, increment, and restore the alloca. This handles the case where
1134 // the body of the loop mutates the variable.
1135 Value
*CurVar
= Builder
->CreateLoad(Type::getDoubleTy(*TheContext
), Alloca
,
1137 Value
*NextVar
= Builder
->CreateFAdd(CurVar
, StepVal
, "nextvar");
1138 Builder
->CreateStore(NextVar
, Alloca
);
1140 // Convert condition to a bool by comparing non-equal to 0.0.
1141 EndCond
= Builder
->CreateFCmpONE(
1142 EndCond
, ConstantFP::get(*TheContext
, APFloat(0.0)), "loopcond");
1144 // Create the "after loop" block and insert it.
1145 BasicBlock
*AfterBB
=
1146 BasicBlock::Create(*TheContext
, "afterloop", TheFunction
);
1148 // Insert the conditional branch into the end of LoopEndBB.
1149 Builder
->CreateCondBr(EndCond
, LoopBB
, AfterBB
);
1151 // Any new code will be inserted in AfterBB.
1152 Builder
->SetInsertPoint(AfterBB
);
1154 // Restore the unshadowed variable.
1156 NamedValues
[VarName
] = OldVal
;
1158 NamedValues
.erase(VarName
);
1160 // for expr always returns 0.0.
1161 return Constant::getNullValue(Type::getDoubleTy(*TheContext
));
1164 Value
*VarExprAST::codegen() {
1165 std::vector
<AllocaInst
*> OldBindings
;
1167 Function
*TheFunction
= Builder
->GetInsertBlock()->getParent();
1169 // Register all variables and emit their initializer.
1170 for (unsigned i
= 0, e
= VarNames
.size(); i
!= e
; ++i
) {
1171 const std::string
&VarName
= VarNames
[i
].first
;
1172 ExprAST
*Init
= VarNames
[i
].second
.get();
1174 // Emit the initializer before adding the variable to scope, this prevents
1175 // the initializer from referencing the variable itself, and permits stuff
1178 // var a = a in ... # refers to outer 'a'.
1181 InitVal
= Init
->codegen();
1184 } else { // If not specified, use 0.0.
1185 InitVal
= ConstantFP::get(*TheContext
, APFloat(0.0));
1188 AllocaInst
*Alloca
= CreateEntryBlockAlloca(TheFunction
, VarName
);
1189 Builder
->CreateStore(InitVal
, Alloca
);
1191 // Remember the old variable binding so that we can restore the binding when
1193 OldBindings
.push_back(NamedValues
[VarName
]);
1195 // Remember this binding.
1196 NamedValues
[VarName
] = Alloca
;
1199 KSDbgInfo
.emitLocation(this);
1201 // Codegen the body, now that all vars are in scope.
1202 Value
*BodyVal
= Body
->codegen();
1206 // Pop all our variables from scope.
1207 for (unsigned i
= 0, e
= VarNames
.size(); i
!= e
; ++i
)
1208 NamedValues
[VarNames
[i
].first
] = OldBindings
[i
];
1210 // Return the body computation.
1214 Function
*PrototypeAST::codegen() {
1215 // Make the function type: double(double,double) etc.
1216 std::vector
<Type
*> Doubles(Args
.size(), Type::getDoubleTy(*TheContext
));
1218 FunctionType::get(Type::getDoubleTy(*TheContext
), Doubles
, false);
1221 Function::Create(FT
, Function::ExternalLinkage
, Name
, TheModule
.get());
1223 // Set names for all arguments.
1225 for (auto &Arg
: F
->args())
1226 Arg
.setName(Args
[Idx
++]);
1231 Function
*FunctionAST::codegen() {
1232 // Transfer ownership of the prototype to the FunctionProtos map, but keep a
1233 // reference to it for use below.
1235 FunctionProtos
[Proto
->getName()] = std::move(Proto
);
1236 Function
*TheFunction
= getFunction(P
.getName());
1240 // If this is an operator, install it.
1242 BinopPrecedence
[P
.getOperatorName()] = P
.getBinaryPrecedence();
1244 // Create a new basic block to start insertion into.
1245 BasicBlock
*BB
= BasicBlock::Create(*TheContext
, "entry", TheFunction
);
1246 Builder
->SetInsertPoint(BB
);
1248 // Create a subprogram DIE for this function.
1249 DIFile
*Unit
= DBuilder
->createFile(KSDbgInfo
.TheCU
->getFilename(),
1250 KSDbgInfo
.TheCU
->getDirectory());
1251 DIScope
*FContext
= Unit
;
1252 unsigned LineNo
= P
.getLine();
1253 unsigned ScopeLine
= LineNo
;
1254 DISubprogram
*SP
= DBuilder
->createFunction(
1255 FContext
, P
.getName(), StringRef(), Unit
, LineNo
,
1256 CreateFunctionType(TheFunction
->arg_size()), ScopeLine
,
1257 DINode::FlagPrototyped
, DISubprogram::SPFlagDefinition
);
1258 TheFunction
->setSubprogram(SP
);
1260 // Push the current scope.
1261 KSDbgInfo
.LexicalBlocks
.push_back(SP
);
1263 // Unset the location for the prologue emission (leading instructions with no
1264 // location in a function are considered part of the prologue and the debugger
1265 // will run past them when breaking on a function)
1266 KSDbgInfo
.emitLocation(nullptr);
1268 // Record the function arguments in the NamedValues map.
1269 NamedValues
.clear();
1270 unsigned ArgIdx
= 0;
1271 for (auto &Arg
: TheFunction
->args()) {
1272 // Create an alloca for this variable.
1273 AllocaInst
*Alloca
= CreateEntryBlockAlloca(TheFunction
, Arg
.getName());
1275 // Create a debug descriptor for the variable.
1276 DILocalVariable
*D
= DBuilder
->createParameterVariable(
1277 SP
, Arg
.getName(), ++ArgIdx
, Unit
, LineNo
, KSDbgInfo
.getDoubleTy(),
1280 DBuilder
->insertDeclare(Alloca
, D
, DBuilder
->createExpression(),
1281 DILocation::get(SP
->getContext(), LineNo
, 0, SP
),
1282 Builder
->GetInsertBlock());
1284 // Store the initial value into the alloca.
1285 Builder
->CreateStore(&Arg
, Alloca
);
1287 // Add arguments to variable symbol table.
1288 NamedValues
[std::string(Arg
.getName())] = Alloca
;
1291 KSDbgInfo
.emitLocation(Body
.get());
1293 if (Value
*RetVal
= Body
->codegen()) {
1294 // Finish off the function.
1295 Builder
->CreateRet(RetVal
);
1297 // Pop off the lexical block for the function.
1298 KSDbgInfo
.LexicalBlocks
.pop_back();
1300 // Validate the generated code, checking for consistency.
1301 verifyFunction(*TheFunction
);
1306 // Error reading body, remove function.
1307 TheFunction
->eraseFromParent();
1310 BinopPrecedence
.erase(Proto
->getOperatorName());
1312 // Pop off the lexical block for the function since we added it
1314 KSDbgInfo
.LexicalBlocks
.pop_back();
1319 //===----------------------------------------------------------------------===//
1320 // Top-Level parsing and JIT Driver
1321 //===----------------------------------------------------------------------===//
1323 static void InitializeModule() {
1324 // Open a new module.
1325 TheContext
= std::make_unique
<LLVMContext
>();
1326 TheModule
= std::make_unique
<Module
>("my cool jit", *TheContext
);
1327 TheModule
->setDataLayout(TheJIT
->getDataLayout());
1329 Builder
= std::make_unique
<IRBuilder
<>>(*TheContext
);
1332 static void HandleDefinition() {
1333 if (auto FnAST
= ParseDefinition()) {
1334 if (!FnAST
->codegen())
1335 fprintf(stderr
, "Error reading function definition:");
1337 // Skip token for error recovery.
1342 static void HandleExtern() {
1343 if (auto ProtoAST
= ParseExtern()) {
1344 if (!ProtoAST
->codegen())
1345 fprintf(stderr
, "Error reading extern");
1347 FunctionProtos
[ProtoAST
->getName()] = std::move(ProtoAST
);
1349 // Skip token for error recovery.
1354 static void HandleTopLevelExpression() {
1355 // Evaluate a top-level expression into an anonymous function.
1356 if (auto FnAST
= ParseTopLevelExpr()) {
1357 if (!FnAST
->codegen()) {
1358 fprintf(stderr
, "Error generating code for top level expr");
1361 // Skip token for error recovery.
1366 /// top ::= definition | external | expression | ';'
1367 static void MainLoop() {
1372 case ';': // ignore top-level semicolons.
1382 HandleTopLevelExpression();
1388 //===----------------------------------------------------------------------===//
1389 // "Library" functions that can be "extern'd" from user code.
1390 //===----------------------------------------------------------------------===//
1393 #define DLLEXPORT __declspec(dllexport)
1398 /// putchard - putchar that takes a double and returns 0.
1399 extern "C" DLLEXPORT
double putchard(double X
) {
1400 fputc((char)X
, stderr
);
1404 /// printd - printf that takes a double prints it as "%f\n", returning 0.
1405 extern "C" DLLEXPORT
double printd(double X
) {
1406 fprintf(stderr
, "%f\n", X
);
1410 //===----------------------------------------------------------------------===//
1411 // Main driver code.
1412 //===----------------------------------------------------------------------===//
1415 InitializeNativeTarget();
1416 InitializeNativeTargetAsmPrinter();
1417 InitializeNativeTargetAsmParser();
1419 // Install standard binary operators.
1420 // 1 is lowest precedence.
1421 BinopPrecedence
['='] = 2;
1422 BinopPrecedence
['<'] = 10;
1423 BinopPrecedence
['+'] = 20;
1424 BinopPrecedence
['-'] = 20;
1425 BinopPrecedence
['*'] = 40; // highest.
1427 // Prime the first token.
1430 TheJIT
= ExitOnErr(KaleidoscopeJIT::Create());
1434 // Add the current debug info version into the module.
1435 TheModule
->addModuleFlag(Module::Warning
, "Debug Info Version",
1436 DEBUG_METADATA_VERSION
);
1438 // Darwin only supports dwarf2.
1439 if (Triple(sys::getProcessTriple()).isOSDarwin())
1440 TheModule
->addModuleFlag(llvm::Module::Warning
, "Dwarf Version", 2);
1442 // Construct the DIBuilder, we do this here because we need the module.
1443 DBuilder
= std::make_unique
<DIBuilder
>(*TheModule
);
1445 // Create the compile unit for the module.
1446 // Currently down as "fib.ks" as a filename since we're redirecting stdin
1447 // but we'd like actual source locations.
1448 KSDbgInfo
.TheCU
= DBuilder
->createCompileUnit(
1449 dwarf::DW_LANG_C
, DBuilder
->createFile("fib.ks", "."),
1450 "Kaleidoscope Compiler", false, "", 0);
1452 // Run the main "interpreter loop" now.
1455 // Finalize the debug info.
1456 DBuilder
->finalize();
1458 // Print out all of the generated code.
1459 TheModule
->print(errs(), nullptr);