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