[Orc][Kaleidoscope] More diff-reduction between tutorial versions.
[oota-llvm.git] / examples / Kaleidoscope / Orc / initial / toy.cpp
1 #include "llvm/Analysis/Passes.h"
2 #include "llvm/ExecutionEngine/Orc/CompileUtils.h"
3 #include "llvm/ExecutionEngine/Orc/IRCompileLayer.h"
4 #include "llvm/ExecutionEngine/Orc/LazyEmittingLayer.h"
5 #include "llvm/ExecutionEngine/Orc/ObjectLinkingLayer.h"
6 #include "llvm/IR/DataLayout.h"
7 #include "llvm/IR/DerivedTypes.h"
8 #include "llvm/IR/IRBuilder.h"
9 #include "llvm/IR/LegacyPassManager.h"
10 #include "llvm/IR/LLVMContext.h"
11 #include "llvm/IR/Module.h"
12 #include "llvm/IR/Verifier.h"
13 #include "llvm/Support/TargetSelect.h"
14 #include "llvm/Transforms/Scalar.h"
15 #include <cctype>
16 #include <iomanip>
17 #include <iostream>
18 #include <map>
19 #include <sstream>
20 #include <string>
21 #include <vector>
22
23 using namespace llvm;
24 using namespace llvm::orc;
25
26 //===----------------------------------------------------------------------===//
27 // Lexer
28 //===----------------------------------------------------------------------===//
29
30 // The lexer returns tokens [0-255] if it is an unknown character, otherwise one
31 // of these for known things.
32 enum Token {
33   tok_eof = -1,
34
35   // commands
36   tok_def = -2, tok_extern = -3,
37
38   // primary
39   tok_identifier = -4, tok_number = -5,
40   
41   // control
42   tok_if = -6, tok_then = -7, tok_else = -8,
43   tok_for = -9, tok_in = -10,
44   
45   // operators
46   tok_binary = -11, tok_unary = -12,
47   
48   // var definition
49   tok_var = -13
50 };
51
52 static std::string IdentifierStr;  // Filled in if tok_identifier
53 static double NumVal;              // Filled in if tok_number
54
55 /// gettok - Return the next token from standard input.
56 static int gettok() {
57   static int LastChar = ' ';
58
59   // Skip any whitespace.
60   while (isspace(LastChar))
61     LastChar = getchar();
62
63   if (isalpha(LastChar)) { // identifier: [a-zA-Z][a-zA-Z0-9]*
64     IdentifierStr = LastChar;
65     while (isalnum((LastChar = getchar())))
66       IdentifierStr += LastChar;
67
68     if (IdentifierStr == "def") return tok_def;
69     if (IdentifierStr == "extern") return tok_extern;
70     if (IdentifierStr == "if") return tok_if;
71     if (IdentifierStr == "then") return tok_then;
72     if (IdentifierStr == "else") return tok_else;
73     if (IdentifierStr == "for") return tok_for;
74     if (IdentifierStr == "in") return tok_in;
75     if (IdentifierStr == "binary") return tok_binary;
76     if (IdentifierStr == "unary") return tok_unary;
77     if (IdentifierStr == "var") return tok_var;
78     return tok_identifier;
79   }
80
81   if (isdigit(LastChar) || LastChar == '.') {   // Number: [0-9.]+
82     std::string NumStr;
83     do {
84       NumStr += LastChar;
85       LastChar = getchar();
86     } while (isdigit(LastChar) || LastChar == '.');
87
88     NumVal = strtod(NumStr.c_str(), 0);
89     return tok_number;
90   }
91
92   if (LastChar == '#') {
93     // Comment until end of line.
94     do LastChar = getchar();
95     while (LastChar != EOF && LastChar != '\n' && LastChar != '\r');
96     
97     if (LastChar != EOF)
98       return gettok();
99   }
100   
101   // Check for end of file.  Don't eat the EOF.
102   if (LastChar == EOF)
103     return tok_eof;
104
105   // Otherwise, just return the character as its ascii value.
106   int ThisChar = LastChar;
107   LastChar = getchar();
108   return ThisChar;
109 }
110
111 //===----------------------------------------------------------------------===//
112 // Abstract Syntax Tree (aka Parse Tree)
113 //===----------------------------------------------------------------------===//
114
115 class IRGenContext;
116
117 /// ExprAST - Base class for all expression nodes.
118 struct ExprAST {
119   virtual ~ExprAST() {}
120   virtual Value *IRGen(IRGenContext &C) const = 0;
121 };
122
123 /// NumberExprAST - Expression class for numeric literals like "1.0".
124 struct NumberExprAST : public ExprAST {
125   NumberExprAST(double Val) : Val(Val) {}
126   Value *IRGen(IRGenContext &C) const override;
127
128   double Val;
129 };
130
131 /// VariableExprAST - Expression class for referencing a variable, like "a".
132 struct VariableExprAST : public ExprAST {
133   VariableExprAST(std::string Name) : Name(std::move(Name)) {}
134   Value *IRGen(IRGenContext &C) const override;
135
136   std::string Name;
137 };
138
139 /// UnaryExprAST - Expression class for a unary operator.
140 struct UnaryExprAST : public ExprAST {
141   UnaryExprAST(char Opcode, std::unique_ptr<ExprAST> Operand) 
142     : Opcode(std::move(Opcode)), Operand(std::move(Operand)) {}
143
144   Value *IRGen(IRGenContext &C) const override;
145
146   char Opcode;
147   std::unique_ptr<ExprAST> Operand;
148 };
149
150 /// BinaryExprAST - Expression class for a binary operator.
151 struct BinaryExprAST : public ExprAST {
152   BinaryExprAST(char Op, std::unique_ptr<ExprAST> LHS,
153                 std::unique_ptr<ExprAST> RHS) 
154     : Op(Op), LHS(std::move(LHS)), RHS(std::move(RHS)) {}
155
156   Value *IRGen(IRGenContext &C) const override;
157
158   char Op;
159   std::unique_ptr<ExprAST> LHS, RHS;
160 };
161
162 /// CallExprAST - Expression class for function calls.
163 struct CallExprAST : public ExprAST {
164   CallExprAST(std::string CalleeName,
165               std::vector<std::unique_ptr<ExprAST>> Args)
166     : CalleeName(std::move(CalleeName)), Args(std::move(Args)) {}
167
168   Value *IRGen(IRGenContext &C) const override;
169
170   std::string CalleeName;
171   std::vector<std::unique_ptr<ExprAST>> Args;
172 };
173
174 /// IfExprAST - Expression class for if/then/else.
175 struct IfExprAST : public ExprAST {
176   IfExprAST(std::unique_ptr<ExprAST> Cond, std::unique_ptr<ExprAST> Then,
177             std::unique_ptr<ExprAST> Else)
178     : Cond(std::move(Cond)), Then(std::move(Then)), Else(std::move(Else)) {}
179   Value *IRGen(IRGenContext &C) const override;
180
181   std::unique_ptr<ExprAST> Cond, Then, Else;
182 };
183
184 /// ForExprAST - Expression class for for/in.
185 struct ForExprAST : public ExprAST {
186   ForExprAST(std::string VarName, std::unique_ptr<ExprAST> Start,
187              std::unique_ptr<ExprAST> End, std::unique_ptr<ExprAST> Step,
188              std::unique_ptr<ExprAST> Body)
189     : VarName(std::move(VarName)), Start(std::move(Start)), End(std::move(End)),
190       Step(std::move(Step)), Body(std::move(Body)) {}
191
192   Value *IRGen(IRGenContext &C) const override;
193
194   std::string VarName;
195   std::unique_ptr<ExprAST> Start, End, Step, Body;
196 };
197
198 /// VarExprAST - Expression class for var/in
199 struct VarExprAST : public ExprAST {
200   typedef std::pair<std::string, std::unique_ptr<ExprAST>> Binding;
201   typedef std::vector<Binding> BindingList;
202
203   VarExprAST(BindingList VarBindings, std::unique_ptr<ExprAST> Body)
204     : VarBindings(std::move(VarBindings)), Body(std::move(Body)) {}
205
206   Value *IRGen(IRGenContext &C) const override;
207
208   BindingList VarBindings;
209   std::unique_ptr<ExprAST> Body;
210 };
211
212 /// PrototypeAST - This class represents the "prototype" for a function,
213 /// which captures its argument names as well as if it is an operator.
214 struct PrototypeAST {
215   PrototypeAST(std::string Name, std::vector<std::string> Args,
216                bool IsOperator = false, unsigned Precedence = 0)
217     : Name(std::move(Name)), Args(std::move(Args)), IsOperator(IsOperator),
218       Precedence(Precedence) {}
219
220   Function *IRGen(IRGenContext &C) const;
221   void CreateArgumentAllocas(Function *F, IRGenContext &C);
222
223   bool isUnaryOp() const { return IsOperator && Args.size() == 1; }
224   bool isBinaryOp() const { return IsOperator && Args.size() == 2; }
225   
226   char getOperatorName() const {
227     assert(isUnaryOp() || isBinaryOp());
228     return Name[Name.size()-1];
229   }
230
231   std::string Name;
232   std::vector<std::string> Args;
233   bool IsOperator;
234   unsigned Precedence;  // Precedence if a binary op.
235 };
236
237 /// FunctionAST - This class represents a function definition itself.
238 struct FunctionAST {
239   FunctionAST(std::unique_ptr<PrototypeAST> Proto,
240               std::unique_ptr<ExprAST> Body)
241     : Proto(std::move(Proto)), Body(std::move(Body)) {}
242
243   Function *IRGen(IRGenContext &C) const;
244
245   std::unique_ptr<PrototypeAST> Proto;
246   std::unique_ptr<ExprAST> Body;
247 };
248
249 //===----------------------------------------------------------------------===//
250 // Parser
251 //===----------------------------------------------------------------------===//
252
253 /// CurTok/getNextToken - Provide a simple token buffer.  CurTok is the current
254 /// token the parser is looking at.  getNextToken reads another token from the
255 /// lexer and updates CurTok with its results.
256 static int CurTok;
257 static int getNextToken() {
258   return CurTok = gettok();
259 }
260
261 /// BinopPrecedence - This holds the precedence for each binary operator that is
262 /// defined.
263 static std::map<char, int> BinopPrecedence;
264
265 /// GetTokPrecedence - Get the precedence of the pending binary operator token.
266 static int GetTokPrecedence() {
267   if (!isascii(CurTok))
268     return -1;
269   
270   // Make sure it's a declared binop.
271   int TokPrec = BinopPrecedence[CurTok];
272   if (TokPrec <= 0) return -1;
273   return TokPrec;
274 }
275
276 template <typename T>
277 std::unique_ptr<T> ErrorU(const std::string &Str) {
278   std::cerr << "Error: " << Str << "\n";
279   return nullptr;
280 }
281
282 template <typename T>
283 T* ErrorP(const std::string &Str) {
284   std::cerr << "Error: " << Str << "\n";
285   return nullptr;
286 }
287
288 static std::unique_ptr<ExprAST> ParseExpression();
289
290 /// identifierexpr
291 ///   ::= identifier
292 ///   ::= identifier '(' expression* ')'
293 static std::unique_ptr<ExprAST> ParseIdentifierExpr() {
294   std::string IdName = IdentifierStr;
295   
296   getNextToken();  // eat identifier.
297   
298   if (CurTok != '(') // Simple variable ref.
299     return llvm::make_unique<VariableExprAST>(IdName);
300   
301   // Call.
302   getNextToken();  // eat (
303   std::vector<std::unique_ptr<ExprAST>> Args;
304   if (CurTok != ')') {
305     while (1) {
306       auto Arg = ParseExpression();
307       if (!Arg) return nullptr;
308       Args.push_back(std::move(Arg));
309
310       if (CurTok == ')') break;
311
312       if (CurTok != ',')
313         return ErrorU<CallExprAST>("Expected ')' or ',' in argument list");
314       getNextToken();
315     }
316   }
317
318   // Eat the ')'.
319   getNextToken();
320   
321   return llvm::make_unique<CallExprAST>(IdName, std::move(Args));
322 }
323
324 /// numberexpr ::= number
325 static std::unique_ptr<NumberExprAST> ParseNumberExpr() {
326   auto Result = llvm::make_unique<NumberExprAST>(NumVal);
327   getNextToken(); // consume the number
328   return Result;
329 }
330
331 /// parenexpr ::= '(' expression ')'
332 static std::unique_ptr<ExprAST> ParseParenExpr() {
333   getNextToken();  // eat (.
334   auto V = ParseExpression();
335   if (!V)
336     return nullptr;
337   
338   if (CurTok != ')')
339     return ErrorU<ExprAST>("expected ')'");
340   getNextToken();  // eat ).
341   return V;
342 }
343
344 /// ifexpr ::= 'if' expression 'then' expression 'else' expression
345 static std::unique_ptr<ExprAST> ParseIfExpr() {
346   getNextToken();  // eat the if.
347   
348   // condition.
349   auto Cond = ParseExpression();
350   if (!Cond)
351     return nullptr;
352   
353   if (CurTok != tok_then)
354     return ErrorU<ExprAST>("expected then");
355   getNextToken();  // eat the then
356   
357   auto Then = ParseExpression();
358   if (!Then)
359     return nullptr;
360   
361   if (CurTok != tok_else)
362     return ErrorU<ExprAST>("expected else");
363   
364   getNextToken();
365   
366   auto Else = ParseExpression();
367   if (!Else)
368     return nullptr;
369   
370   return llvm::make_unique<IfExprAST>(std::move(Cond), std::move(Then),
371                                       std::move(Else));
372 }
373
374 /// forexpr ::= 'for' identifier '=' expr ',' expr (',' expr)? 'in' expression
375 static std::unique_ptr<ForExprAST> ParseForExpr() {
376   getNextToken();  // eat the for.
377
378   if (CurTok != tok_identifier)
379     return ErrorU<ForExprAST>("expected identifier after for");
380   
381   std::string IdName = IdentifierStr;
382   getNextToken();  // eat identifier.
383   
384   if (CurTok != '=')
385     return ErrorU<ForExprAST>("expected '=' after for");
386   getNextToken();  // eat '='.
387   
388   
389   auto Start = ParseExpression();
390   if (!Start)
391     return nullptr;
392   if (CurTok != ',')
393     return ErrorU<ForExprAST>("expected ',' after for start value");
394   getNextToken();
395   
396   auto End = ParseExpression();
397   if (!End)
398     return nullptr;
399   
400   // The step value is optional.
401   std::unique_ptr<ExprAST> Step;
402   if (CurTok == ',') {
403     getNextToken();
404     Step = ParseExpression();
405     if (!Step)
406       return nullptr;
407   }
408   
409   if (CurTok != tok_in)
410     return ErrorU<ForExprAST>("expected 'in' after for");
411   getNextToken();  // eat 'in'.
412   
413   auto Body = ParseExpression();
414   if (Body)
415     return nullptr;
416
417   return llvm::make_unique<ForExprAST>(IdName, std::move(Start), std::move(End),
418                                        std::move(Step), std::move(Body));
419 }
420
421 /// varexpr ::= 'var' identifier ('=' expression)? 
422 //                    (',' identifier ('=' expression)?)* 'in' expression
423 static std::unique_ptr<VarExprAST> ParseVarExpr() {
424   getNextToken();  // eat the var.
425
426   VarExprAST::BindingList VarBindings;
427
428   // At least one variable name is required.
429   if (CurTok != tok_identifier)
430     return ErrorU<VarExprAST>("expected identifier after var");
431   
432   while (1) {
433     std::string Name = IdentifierStr;
434     getNextToken();  // eat identifier.
435
436     // Read the optional initializer.
437     std::unique_ptr<ExprAST> Init;
438     if (CurTok == '=') {
439       getNextToken(); // eat the '='.
440       
441       Init = ParseExpression();
442       if (!Init)
443         return nullptr;
444     }
445     
446     VarBindings.push_back(VarExprAST::Binding(Name, std::move(Init)));
447     
448     // End of var list, exit loop.
449     if (CurTok != ',') break;
450     getNextToken(); // eat the ','.
451     
452     if (CurTok != tok_identifier)
453       return ErrorU<VarExprAST>("expected identifier list after var");
454   }
455   
456   // At this point, we have to have 'in'.
457   if (CurTok != tok_in)
458     return ErrorU<VarExprAST>("expected 'in' keyword after 'var'");
459   getNextToken();  // eat 'in'.
460   
461   auto Body = ParseExpression();
462   if (!Body)
463     return nullptr;
464   
465   return llvm::make_unique<VarExprAST>(std::move(VarBindings), std::move(Body));
466 }
467
468 /// primary
469 ///   ::= identifierexpr
470 ///   ::= numberexpr
471 ///   ::= parenexpr
472 ///   ::= ifexpr
473 ///   ::= forexpr
474 ///   ::= varexpr
475 static std::unique_ptr<ExprAST> ParsePrimary() {
476   switch (CurTok) {
477   default: return ErrorU<ExprAST>("unknown token when expecting an expression");
478   case tok_identifier: return ParseIdentifierExpr();
479   case tok_number:     return ParseNumberExpr();
480   case '(':            return ParseParenExpr();
481   case tok_if:         return ParseIfExpr();
482   case tok_for:        return ParseForExpr();
483   case tok_var:        return ParseVarExpr();
484   }
485 }
486
487 /// unary
488 ///   ::= primary
489 ///   ::= '!' unary
490 static std::unique_ptr<ExprAST> ParseUnary() {
491   // If the current token is not an operator, it must be a primary expr.
492   if (!isascii(CurTok) || CurTok == '(' || CurTok == ',')
493     return ParsePrimary();
494   
495   // If this is a unary operator, read it.
496   int Opc = CurTok;
497   getNextToken();
498   if (auto Operand = ParseUnary())
499     return llvm::make_unique<UnaryExprAST>(Opc, std::move(Operand));
500   return nullptr;
501 }
502
503 /// binoprhs
504 ///   ::= ('+' unary)*
505 static std::unique_ptr<ExprAST> ParseBinOpRHS(int ExprPrec,
506                                               std::unique_ptr<ExprAST> LHS) {
507   // If this is a binop, find its precedence.
508   while (1) {
509     int TokPrec = GetTokPrecedence();
510     
511     // If this is a binop that binds at least as tightly as the current binop,
512     // consume it, otherwise we are done.
513     if (TokPrec < ExprPrec)
514       return LHS;
515     
516     // Okay, we know this is a binop.
517     int BinOp = CurTok;
518     getNextToken();  // eat binop
519     
520     // Parse the unary expression after the binary operator.
521     auto RHS = ParseUnary();
522     if (!RHS)
523       return nullptr;
524     
525     // If BinOp binds less tightly with RHS than the operator after RHS, let
526     // the pending operator take RHS as its LHS.
527     int NextPrec = GetTokPrecedence();
528     if (TokPrec < NextPrec) {
529       RHS = ParseBinOpRHS(TokPrec+1, std::move(RHS));
530       if (!RHS)
531         return nullptr;
532     }
533     
534     // Merge LHS/RHS.
535     LHS = llvm::make_unique<BinaryExprAST>(BinOp, std::move(LHS), std::move(RHS));
536   }
537 }
538
539 /// expression
540 ///   ::= unary binoprhs
541 ///
542 static std::unique_ptr<ExprAST> ParseExpression() {
543   auto LHS = ParseUnary();
544   if (!LHS)
545     return nullptr;
546   
547   return ParseBinOpRHS(0, std::move(LHS));
548 }
549
550 /// prototype
551 ///   ::= id '(' id* ')'
552 ///   ::= binary LETTER number? (id, id)
553 ///   ::= unary LETTER (id)
554 static std::unique_ptr<PrototypeAST> ParsePrototype() {
555   std::string FnName;
556   
557   unsigned Kind = 0; // 0 = identifier, 1 = unary, 2 = binary.
558   unsigned BinaryPrecedence = 30;
559   
560   switch (CurTok) {
561   default:
562     return ErrorU<PrototypeAST>("Expected function name in prototype");
563   case tok_identifier:
564     FnName = IdentifierStr;
565     Kind = 0;
566     getNextToken();
567     break;
568   case tok_unary:
569     getNextToken();
570     if (!isascii(CurTok))
571       return ErrorU<PrototypeAST>("Expected unary operator");
572     FnName = "unary";
573     FnName += (char)CurTok;
574     Kind = 1;
575     getNextToken();
576     break;
577   case tok_binary:
578     getNextToken();
579     if (!isascii(CurTok))
580       return ErrorU<PrototypeAST>("Expected binary operator");
581     FnName = "binary";
582     FnName += (char)CurTok;
583     Kind = 2;
584     getNextToken();
585     
586     // Read the precedence if present.
587     if (CurTok == tok_number) {
588       if (NumVal < 1 || NumVal > 100)
589         return ErrorU<PrototypeAST>("Invalid precedecnce: must be 1..100");
590       BinaryPrecedence = (unsigned)NumVal;
591       getNextToken();
592     }
593     break;
594   }
595   
596   if (CurTok != '(')
597     return ErrorU<PrototypeAST>("Expected '(' in prototype");
598   
599   std::vector<std::string> ArgNames;
600   while (getNextToken() == tok_identifier)
601     ArgNames.push_back(IdentifierStr);
602   if (CurTok != ')')
603     return ErrorU<PrototypeAST>("Expected ')' in prototype");
604   
605   // success.
606   getNextToken();  // eat ')'.
607   
608   // Verify right number of names for operator.
609   if (Kind && ArgNames.size() != Kind)
610     return ErrorU<PrototypeAST>("Invalid number of operands for operator");
611   
612   return llvm::make_unique<PrototypeAST>(FnName, std::move(ArgNames), Kind != 0,
613                                          BinaryPrecedence);
614 }
615
616 /// definition ::= 'def' prototype expression
617 static std::unique_ptr<FunctionAST> ParseDefinition() {
618   getNextToken();  // eat def.
619   auto Proto = ParsePrototype();
620   if (!Proto)
621     return nullptr;
622
623   if (auto Body = ParseExpression())
624     return llvm::make_unique<FunctionAST>(std::move(Proto), std::move(Body));
625   return nullptr;
626 }
627
628 /// toplevelexpr ::= expression
629 static std::unique_ptr<FunctionAST> ParseTopLevelExpr() {
630   if (auto E = ParseExpression()) {
631     // Make an anonymous proto.
632     auto Proto =
633       llvm::make_unique<PrototypeAST>("__anon_expr", std::vector<std::string>());
634     return llvm::make_unique<FunctionAST>(std::move(Proto), std::move(E));
635   }
636   return nullptr;
637 }
638
639 /// external ::= 'extern' prototype
640 static std::unique_ptr<PrototypeAST> ParseExtern() {
641   getNextToken();  // eat extern.
642   return ParsePrototype();
643 }
644
645 //===----------------------------------------------------------------------===//
646 // Code Generation
647 //===----------------------------------------------------------------------===//
648
649 // FIXME: Obviously we can do better than this
650 std::string GenerateUniqueName(const std::string &Root) {
651   static int i = 0;
652   std::ostringstream NameStream;
653   NameStream << Root << ++i;
654   return NameStream.str();
655 }
656
657 std::string MakeLegalFunctionName(std::string Name)
658 {
659   std::string NewName;
660   assert(!Name.empty() && "Base name must not be empty");
661
662   // Start with what we have
663   NewName = Name;
664
665   // Look for a numberic first character
666   if (NewName.find_first_of("0123456789") == 0) {
667     NewName.insert(0, 1, 'n');
668   }
669
670   // Replace illegal characters with their ASCII equivalent
671   std::string legal_elements = "_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";
672   size_t pos;
673   while ((pos = NewName.find_first_not_of(legal_elements)) != std::string::npos) {
674     std::ostringstream NumStream;
675     NumStream << (int)NewName.at(pos);
676     NewName = NewName.replace(pos, 1, NumStream.str());
677   }
678
679   return NewName;
680 }
681
682 class SessionContext {
683 public:
684   SessionContext(LLVMContext &C)
685     : Context(C), TM(EngineBuilder().selectTarget()) {}
686   LLVMContext& getLLVMContext() const { return Context; }
687   TargetMachine& getTarget() { return *TM; }
688   void addPrototypeAST(std::unique_ptr<PrototypeAST> P);
689   PrototypeAST* getPrototypeAST(const std::string &Name);
690 private:
691   typedef std::map<std::string, std::unique_ptr<PrototypeAST>> PrototypeMap;
692   
693   LLVMContext &Context;
694   std::unique_ptr<TargetMachine> TM;
695       
696   PrototypeMap Prototypes;
697 };
698
699 void SessionContext::addPrototypeAST(std::unique_ptr<PrototypeAST> P) {
700   Prototypes[P->Name] = std::move(P);
701 }
702
703 PrototypeAST* SessionContext::getPrototypeAST(const std::string &Name) {
704   PrototypeMap::iterator I = Prototypes.find(Name);
705   if (I != Prototypes.end())
706     return I->second.get();
707   return nullptr;
708 }
709
710 class IRGenContext {
711 public:
712
713   IRGenContext(SessionContext &S)
714     : Session(S),
715       M(new Module(GenerateUniqueName("jit_module_"),
716                    Session.getLLVMContext())),
717       Builder(Session.getLLVMContext()) {
718     M->setDataLayout(Session.getTarget().getDataLayout());
719   }
720
721   SessionContext& getSession() { return Session; }
722   Module& getM() const { return *M; }
723   std::unique_ptr<Module> takeM() { return std::move(M); }
724   IRBuilder<>& getBuilder() { return Builder; }
725   LLVMContext& getLLVMContext() { return Session.getLLVMContext(); }
726   Function* getPrototype(const std::string &Name);
727
728   std::map<std::string, AllocaInst*> NamedValues;
729 private:
730   SessionContext &Session;
731   std::unique_ptr<Module> M;
732   IRBuilder<> Builder;
733 };
734
735 Function* IRGenContext::getPrototype(const std::string &Name) {
736   if (Function *ExistingProto = M->getFunction(Name))
737     return ExistingProto;
738   if (PrototypeAST *ProtoAST = Session.getPrototypeAST(Name))
739     return ProtoAST->IRGen(*this);
740   return nullptr;
741 }
742
743 /// CreateEntryBlockAlloca - Create an alloca instruction in the entry block of
744 /// the function.  This is used for mutable variables etc.
745 static AllocaInst *CreateEntryBlockAlloca(Function *TheFunction,
746                                           const std::string &VarName) {
747   IRBuilder<> TmpB(&TheFunction->getEntryBlock(),
748                  TheFunction->getEntryBlock().begin());
749   return TmpB.CreateAlloca(Type::getDoubleTy(getGlobalContext()), 0,
750                            VarName.c_str());
751 }
752
753 Value *NumberExprAST::IRGen(IRGenContext &C) const {
754   return ConstantFP::get(C.getLLVMContext(), APFloat(Val));
755 }
756
757 Value *VariableExprAST::IRGen(IRGenContext &C) const {
758   // Look this variable up in the function.
759   Value *V = C.NamedValues[Name];
760
761   if (V == 0)
762     return ErrorP<Value>("Unknown variable name '" + Name + "'");
763
764   // Load the value.
765   return C.getBuilder().CreateLoad(V, Name.c_str());
766 }
767
768 Value *UnaryExprAST::IRGen(IRGenContext &C) const {
769   if (Value *OperandV = Operand->IRGen(C)) {
770     std::string FnName = MakeLegalFunctionName(std::string("unary")+Opcode);
771     if (Function *F = C.getPrototype(FnName))
772       return C.getBuilder().CreateCall(F, OperandV, "unop");
773     return ErrorP<Value>("Unknown unary operator");
774   }
775
776   // Could not codegen operand - return null.
777   return nullptr;
778 }
779
780 Value *BinaryExprAST::IRGen(IRGenContext &C) const {
781   // Special case '=' because we don't want to emit the LHS as an expression.
782   if (Op == '=') {
783     // Assignment requires the LHS to be an identifier.
784     auto LHSVar = static_cast<VariableExprAST&>(*LHS);
785     // Codegen the RHS.
786     Value *Val = RHS->IRGen(C);
787     if (!Val) return nullptr;
788
789     // Look up the name.
790     if (auto Variable = C.NamedValues[LHSVar.Name]) {
791       C.getBuilder().CreateStore(Val, Variable);
792       return Val;
793     }
794     return ErrorP<Value>("Unknown variable name");
795   }
796   
797   Value *L = LHS->IRGen(C);
798   Value *R = RHS->IRGen(C);
799   if (!L || !R) return nullptr;
800   
801   switch (Op) {
802   case '+': return C.getBuilder().CreateFAdd(L, R, "addtmp");
803   case '-': return C.getBuilder().CreateFSub(L, R, "subtmp");
804   case '*': return C.getBuilder().CreateFMul(L, R, "multmp");
805   case '/': return C.getBuilder().CreateFDiv(L, R, "divtmp");
806   case '<':
807     L = C.getBuilder().CreateFCmpULT(L, R, "cmptmp");
808     // Convert bool 0/1 to double 0.0 or 1.0
809     return C.getBuilder().CreateUIToFP(L, Type::getDoubleTy(getGlobalContext()),
810                                 "booltmp");
811   default: break;
812   }
813   
814   // If it wasn't a builtin binary operator, it must be a user defined one. Emit
815   // a call to it.
816   std::string FnName = MakeLegalFunctionName(std::string("binary")+Op);
817   if (Function *F = C.getPrototype(FnName)) {
818     Value *Ops[] = { L, R };
819     return C.getBuilder().CreateCall(F, Ops, "binop");
820   }
821    
822   return ErrorP<Value>("Unknown binary operator");
823 }
824
825 Value *CallExprAST::IRGen(IRGenContext &C) const {
826   // Look up the name in the global module table.
827   if (auto CalleeF = C.getPrototype(CalleeName)) {
828     // If argument mismatch error.
829     if (CalleeF->arg_size() != Args.size())
830       return ErrorP<Value>("Incorrect # arguments passed");
831
832     std::vector<Value*> ArgsV;
833     for (unsigned i = 0, e = Args.size(); i != e; ++i) {
834       ArgsV.push_back(Args[i]->IRGen(C));
835       if (!ArgsV.back()) return nullptr;
836     }
837     
838     return C.getBuilder().CreateCall(CalleeF, ArgsV, "calltmp");
839   }
840
841   return ErrorP<Value>("Unknown function referenced");
842 }
843
844 Value *IfExprAST::IRGen(IRGenContext &C) const {
845   Value *CondV = Cond->IRGen(C);
846   if (!CondV) return nullptr;
847   
848   // Convert condition to a bool by comparing equal to 0.0.
849   ConstantFP *FPZero = 
850     ConstantFP::get(C.getLLVMContext(), APFloat(0.0));
851   CondV = C.getBuilder().CreateFCmpONE(CondV, FPZero, "ifcond");
852   
853   Function *TheFunction = C.getBuilder().GetInsertBlock()->getParent();
854   
855   // Create blocks for the then and else cases.  Insert the 'then' block at the
856   // end of the function.
857   BasicBlock *ThenBB = BasicBlock::Create(C.getLLVMContext(), "then", TheFunction);
858   BasicBlock *ElseBB = BasicBlock::Create(C.getLLVMContext(), "else");
859   BasicBlock *MergeBB = BasicBlock::Create(C.getLLVMContext(), "ifcont");
860   
861   C.getBuilder().CreateCondBr(CondV, ThenBB, ElseBB);
862   
863   // Emit then value.
864   C.getBuilder().SetInsertPoint(ThenBB);
865   
866   Value *ThenV = Then->IRGen(C);
867   if (!ThenV) return nullptr;
868   
869   C.getBuilder().CreateBr(MergeBB);
870   // Codegen of 'Then' can change the current block, update ThenBB for the PHI.
871   ThenBB = C.getBuilder().GetInsertBlock();
872   
873   // Emit else block.
874   TheFunction->getBasicBlockList().push_back(ElseBB);
875   C.getBuilder().SetInsertPoint(ElseBB);
876   
877   Value *ElseV = Else->IRGen(C);
878   if (!ElseV) return nullptr;
879   
880   C.getBuilder().CreateBr(MergeBB);
881   // Codegen of 'Else' can change the current block, update ElseBB for the PHI.
882   ElseBB = C.getBuilder().GetInsertBlock();
883   
884   // Emit merge block.
885   TheFunction->getBasicBlockList().push_back(MergeBB);
886   C.getBuilder().SetInsertPoint(MergeBB);
887   PHINode *PN = C.getBuilder().CreatePHI(Type::getDoubleTy(getGlobalContext()), 2,
888                                   "iftmp");
889   
890   PN->addIncoming(ThenV, ThenBB);
891   PN->addIncoming(ElseV, ElseBB);
892   return PN;
893 }
894
895 Value *ForExprAST::IRGen(IRGenContext &C) const {
896   // Output this as:
897   //   var = alloca double
898   //   ...
899   //   start = startexpr
900   //   store start -> var
901   //   goto loop
902   // loop: 
903   //   ...
904   //   bodyexpr
905   //   ...
906   // loopend:
907   //   step = stepexpr
908   //   endcond = endexpr
909   //
910   //   curvar = load var
911   //   nextvar = curvar + step
912   //   store nextvar -> var
913   //   br endcond, loop, endloop
914   // outloop:
915   
916   Function *TheFunction = C.getBuilder().GetInsertBlock()->getParent();
917
918   // Create an alloca for the variable in the entry block.
919   AllocaInst *Alloca = CreateEntryBlockAlloca(TheFunction, VarName);
920   
921   // Emit the start code first, without 'variable' in scope.
922   Value *StartVal = Start->IRGen(C);
923   if (!StartVal) return nullptr;
924   
925   // Store the value into the alloca.
926   C.getBuilder().CreateStore(StartVal, Alloca);
927   
928   // Make the new basic block for the loop header, inserting after current
929   // block.
930   BasicBlock *LoopBB = BasicBlock::Create(getGlobalContext(), "loop", TheFunction);
931   
932   // Insert an explicit fall through from the current block to the LoopBB.
933   C.getBuilder().CreateBr(LoopBB);
934
935   // Start insertion in LoopBB.
936   C.getBuilder().SetInsertPoint(LoopBB);
937   
938   // Within the loop, the variable is defined equal to the PHI node.  If it
939   // shadows an existing variable, we have to restore it, so save it now.
940   AllocaInst *OldVal = C.NamedValues[VarName];
941   C.NamedValues[VarName] = Alloca;
942   
943   // Emit the body of the loop.  This, like any other expr, can change the
944   // current BB.  Note that we ignore the value computed by the body, but don't
945   // allow an error.
946   if (!Body->IRGen(C))
947     return nullptr;
948   
949   // Emit the step value.
950   Value *StepVal;
951   if (Step) {
952     StepVal = Step->IRGen(C);
953     if (!StepVal) return nullptr;
954   } else {
955     // If not specified, use 1.0.
956     StepVal = ConstantFP::get(getGlobalContext(), APFloat(1.0));
957   }
958   
959   // Compute the end condition.
960   Value *EndCond = End->IRGen(C);
961   if (EndCond == 0) return EndCond;
962   
963   // Reload, increment, and restore the alloca.  This handles the case where
964   // the body of the loop mutates the variable.
965   Value *CurVar = C.getBuilder().CreateLoad(Alloca, VarName.c_str());
966   Value *NextVar = C.getBuilder().CreateFAdd(CurVar, StepVal, "nextvar");
967   C.getBuilder().CreateStore(NextVar, Alloca);
968   
969   // Convert condition to a bool by comparing equal to 0.0.
970   EndCond = C.getBuilder().CreateFCmpONE(EndCond, 
971                               ConstantFP::get(getGlobalContext(), APFloat(0.0)),
972                                   "loopcond");
973   
974   // Create the "after loop" block and insert it.
975   BasicBlock *AfterBB = BasicBlock::Create(getGlobalContext(), "afterloop", TheFunction);
976   
977   // Insert the conditional branch into the end of LoopEndBB.
978   C.getBuilder().CreateCondBr(EndCond, LoopBB, AfterBB);
979   
980   // Any new code will be inserted in AfterBB.
981   C.getBuilder().SetInsertPoint(AfterBB);
982   
983   // Restore the unshadowed variable.
984   if (OldVal)
985     C.NamedValues[VarName] = OldVal;
986   else
987     C.NamedValues.erase(VarName);
988
989   
990   // for expr always returns 0.0.
991   return Constant::getNullValue(Type::getDoubleTy(getGlobalContext()));
992 }
993
994 Value *VarExprAST::IRGen(IRGenContext &C) const {
995   std::vector<AllocaInst *> OldBindings;
996   
997   Function *TheFunction = C.getBuilder().GetInsertBlock()->getParent();
998
999   // Register all variables and emit their initializer.
1000   for (unsigned i = 0, e = VarBindings.size(); i != e; ++i) {
1001     auto &VarName = VarBindings[i].first;
1002     auto &Init = VarBindings[i].second;
1003     
1004     // Emit the initializer before adding the variable to scope, this prevents
1005     // the initializer from referencing the variable itself, and permits stuff
1006     // like this:
1007     //  var a = 1 in
1008     //    var a = a in ...   # refers to outer 'a'.
1009     Value *InitVal;
1010     if (Init) {
1011       InitVal = Init->IRGen(C);
1012       if (!InitVal) return nullptr;
1013     } else // If not specified, use 0.0.
1014       InitVal = ConstantFP::get(getGlobalContext(), APFloat(0.0));
1015     
1016     AllocaInst *Alloca = CreateEntryBlockAlloca(TheFunction, VarName);
1017     C.getBuilder().CreateStore(InitVal, Alloca);
1018
1019     // Remember the old variable binding so that we can restore the binding when
1020     // we unrecurse.
1021     OldBindings.push_back(C.NamedValues[VarName]);
1022     
1023     // Remember this binding.
1024     C.NamedValues[VarName] = Alloca;
1025   }
1026   
1027   // Codegen the body, now that all vars are in scope.
1028   Value *BodyVal = Body->IRGen(C);
1029   if (!BodyVal) return nullptr;
1030   
1031   // Pop all our variables from scope.
1032   for (unsigned i = 0, e = VarBindings.size(); i != e; ++i)
1033     C.NamedValues[VarBindings[i].first] = OldBindings[i];
1034
1035   // Return the body computation.
1036   return BodyVal;
1037 }
1038
1039 Function *PrototypeAST::IRGen(IRGenContext &C) const {
1040   std::string FnName = MakeLegalFunctionName(Name);
1041
1042   // Make the function type:  double(double,double) etc.
1043   std::vector<Type*> Doubles(Args.size(), 
1044                              Type::getDoubleTy(getGlobalContext()));
1045   FunctionType *FT = FunctionType::get(Type::getDoubleTy(getGlobalContext()),
1046                                        Doubles, false);
1047   Function *F = Function::Create(FT, Function::ExternalLinkage, FnName,
1048                                  &C.getM());
1049
1050   // If F conflicted, there was already something named 'FnName'.  If it has a
1051   // body, don't allow redefinition or reextern.
1052   if (F->getName() != FnName) {
1053     // Delete the one we just made and get the existing one.
1054     F->eraseFromParent();
1055     F = C.getM().getFunction(Name);
1056     
1057     // If F already has a body, reject this.
1058     if (!F->empty()) {
1059       ErrorP<Function>("redefinition of function");
1060       return nullptr;
1061     }
1062     
1063     // If F took a different number of args, reject.
1064     if (F->arg_size() != Args.size()) {
1065       ErrorP<Function>("redefinition of function with different # args");
1066       return nullptr;
1067     }
1068   }
1069   
1070   // Set names for all arguments.
1071   unsigned Idx = 0;
1072   for (Function::arg_iterator AI = F->arg_begin(); Idx != Args.size();
1073        ++AI, ++Idx)
1074     AI->setName(Args[Idx]);
1075     
1076   return F;
1077 }
1078
1079 /// CreateArgumentAllocas - Create an alloca for each argument and register the
1080 /// argument in the symbol table so that references to it will succeed.
1081 void PrototypeAST::CreateArgumentAllocas(Function *F, IRGenContext &C) {
1082   Function::arg_iterator AI = F->arg_begin();
1083   for (unsigned Idx = 0, e = Args.size(); Idx != e; ++Idx, ++AI) {
1084     // Create an alloca for this variable.
1085     AllocaInst *Alloca = CreateEntryBlockAlloca(F, Args[Idx]);
1086
1087     // Store the initial value into the alloca.
1088     C.getBuilder().CreateStore(AI, Alloca);
1089
1090     // Add arguments to variable symbol table.
1091     C.NamedValues[Args[Idx]] = Alloca;
1092   }
1093 }
1094
1095 Function *FunctionAST::IRGen(IRGenContext &C) const {
1096   C.NamedValues.clear();
1097   
1098   Function *TheFunction = Proto->IRGen(C);
1099   if (!TheFunction)
1100     return nullptr;
1101   
1102   // If this is an operator, install it.
1103   if (Proto->isBinaryOp())
1104     BinopPrecedence[Proto->getOperatorName()] = Proto->Precedence;
1105   
1106   // Create a new basic block to start insertion into.
1107   BasicBlock *BB = BasicBlock::Create(getGlobalContext(), "entry", TheFunction);
1108   C.getBuilder().SetInsertPoint(BB);
1109   
1110   // Add all arguments to the symbol table and create their allocas.
1111   Proto->CreateArgumentAllocas(TheFunction, C);
1112
1113   if (Value *RetVal = Body->IRGen(C)) {
1114     // Finish off the function.
1115     C.getBuilder().CreateRet(RetVal);
1116
1117     // Validate the generated code, checking for consistency.
1118     verifyFunction(*TheFunction);
1119
1120     return TheFunction;
1121   }
1122   
1123   // Error reading body, remove function.
1124   TheFunction->eraseFromParent();
1125
1126   if (Proto->isBinaryOp())
1127     BinopPrecedence.erase(Proto->getOperatorName());
1128   return nullptr;
1129 }
1130
1131 //===----------------------------------------------------------------------===//
1132 // Top-Level parsing and JIT Driver
1133 //===----------------------------------------------------------------------===//
1134
1135 static std::unique_ptr<llvm::Module> IRGen(SessionContext &S,
1136                                            const FunctionAST &F) {
1137   IRGenContext C(S);
1138   auto LF = F.IRGen(C);
1139   if (!LF)
1140     return nullptr;
1141 #ifndef MINIMAL_STDERR_OUTPUT
1142   fprintf(stderr, "Read function definition:");
1143   LF->dump();
1144 #endif
1145   return C.takeM();
1146 }
1147
1148 template <typename T>
1149 static std::vector<T> singletonSet(T t) {
1150   std::vector<T> Vec;
1151   Vec.push_back(std::move(t));
1152   return Vec;
1153 }
1154
1155 class KaleidoscopeJIT {
1156 public:
1157   typedef ObjectLinkingLayer<> ObjLayerT;
1158   typedef IRCompileLayer<ObjLayerT> CompileLayerT;
1159   typedef CompileLayerT::ModuleSetHandleT ModuleHandleT;
1160
1161   KaleidoscopeJIT(SessionContext &Session)
1162     : Mang(Session.getTarget().getDataLayout()),
1163       CompileLayer(ObjectLayer, SimpleCompiler(Session.getTarget())) {}
1164
1165   std::string mangle(const std::string &Name) {
1166     std::string MangledName;
1167     {
1168       raw_string_ostream MangledNameStream(MangledName);
1169       Mang.getNameWithPrefix(MangledNameStream, Name);
1170     }
1171     return MangledName;
1172   }
1173
1174   ModuleHandleT addModule(std::unique_ptr<Module> M) {
1175     // We need a memory manager to allocate memory and resolve symbols for this
1176     // new module. Create one that resolves symbols by looking back into the
1177     // JIT.
1178     auto MM = createLookasideRTDyldMM<SectionMemoryManager>(
1179                 [&](const std::string &Name) {
1180                   return findSymbol(Name).getAddress();
1181                 },
1182                 [](const std::string &S) { return 0; } );
1183
1184     return CompileLayer.addModuleSet(singletonSet(std::move(M)), std::move(MM));
1185   }
1186
1187   void removeModule(ModuleHandleT H) { CompileLayer.removeModuleSet(H); }
1188
1189   JITSymbol findSymbol(const std::string &Name) {
1190     return CompileLayer.findSymbol(Name, true);
1191   }
1192
1193   JITSymbol findUnmangledSymbol(const std::string Name) {
1194     return findSymbol(mangle(Name));
1195   }
1196
1197 private:
1198
1199   Mangler Mang;
1200   ObjLayerT ObjectLayer;
1201   CompileLayerT CompileLayer;
1202 };
1203
1204 static void HandleDefinition(SessionContext &S, KaleidoscopeJIT &J) {
1205   if (auto F = ParseDefinition()) {
1206     if (auto M = IRGen(S, *F)) {
1207       S.addPrototypeAST(llvm::make_unique<PrototypeAST>(*F->Proto));
1208       J.addModule(std::move(M));
1209     }
1210   } else {
1211     // Skip token for error recovery.
1212     getNextToken();
1213   }
1214 }
1215
1216 static void HandleExtern(SessionContext &S) {
1217   if (auto P = ParseExtern())
1218     S.addPrototypeAST(std::move(P));
1219   else {
1220     // Skip token for error recovery.
1221     getNextToken();
1222   }
1223 }
1224
1225 static void HandleTopLevelExpression(SessionContext &S, KaleidoscopeJIT &J) {
1226   // Evaluate a top-level expression into an anonymous function.
1227   if (auto F = ParseTopLevelExpr()) {
1228     IRGenContext C(S);
1229     if (auto ExprFunc = F->IRGen(C)) {
1230 #ifndef MINIMAL_STDERR_OUTPUT
1231       std::cerr << "Expression function:\n";
1232       ExprFunc->dump();
1233 #endif
1234       // Add the CodeGen'd module to the JIT. Keep a handle to it: We can remove
1235       // this module as soon as we've executed Function ExprFunc.
1236       auto H = J.addModule(C.takeM());
1237
1238       // Get the address of the JIT'd function in memory.
1239       auto ExprSymbol = J.findUnmangledSymbol("__anon_expr");
1240       
1241       // Cast it to the right type (takes no arguments, returns a double) so we
1242       // can call it as a native function.
1243       double (*FP)() = (double (*)())(intptr_t)ExprSymbol.getAddress();
1244 #ifdef MINIMAL_STDERR_OUTPUT
1245       FP();
1246 #else
1247       std::cerr << "Evaluated to " << FP() << "\n";
1248 #endif
1249
1250       // Remove the function.
1251       J.removeModule(H);
1252     }
1253   } else {
1254     // Skip token for error recovery.
1255     getNextToken();
1256   }
1257 }
1258
1259 /// top ::= definition | external | expression | ';'
1260 static void MainLoop() {
1261   SessionContext S(getGlobalContext());
1262   KaleidoscopeJIT J(S);
1263
1264   while (1) {
1265     switch (CurTok) {
1266     case tok_eof:    return;
1267     case ';':        getNextToken(); continue;  // ignore top-level semicolons.
1268     case tok_def:    HandleDefinition(S, J); break;
1269     case tok_extern: HandleExtern(S); break;
1270     default:         HandleTopLevelExpression(S, J); break;
1271     }
1272 #ifndef MINIMAL_STDERR_OUTPUT
1273     std::cerr << "ready> ";
1274 #endif
1275   }
1276 }
1277
1278 //===----------------------------------------------------------------------===//
1279 // "Library" functions that can be "extern'd" from user code.
1280 //===----------------------------------------------------------------------===//
1281
1282 /// putchard - putchar that takes a double and returns 0.
1283 extern "C" 
1284 double putchard(double X) {
1285   putchar((char)X);
1286   return 0;
1287 }
1288
1289 /// printd - printf that takes a double prints it as "%f\n", returning 0.
1290 extern "C" 
1291 double printd(double X) {
1292   printf("%f", X);
1293   return 0;
1294 }
1295
1296 extern "C" 
1297 double printlf() {
1298   printf("\n");
1299   return 0;
1300 }
1301
1302 //===----------------------------------------------------------------------===//
1303 // Main driver code.
1304 //===----------------------------------------------------------------------===//
1305
1306 int main() {
1307   InitializeNativeTarget();
1308   InitializeNativeTargetAsmPrinter();
1309   InitializeNativeTargetAsmParser();
1310
1311   // Install standard binary operators.
1312   // 1 is lowest precedence.
1313   BinopPrecedence['='] = 2;
1314   BinopPrecedence['<'] = 10;
1315   BinopPrecedence['+'] = 20;
1316   BinopPrecedence['-'] = 20;
1317   BinopPrecedence['/'] = 40;
1318   BinopPrecedence['*'] = 40;  // highest.
1319
1320   // Prime the first token.
1321 #ifndef MINIMAL_STDERR_OUTPUT
1322   std::cerr << "ready> ";
1323 #endif
1324   getNextToken();
1325
1326   std::cerr << std::fixed;
1327
1328   // Run the main "interpreter loop" now.
1329   MainLoop();
1330
1331   return 0;
1332 }
1333