• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1==================================================
2Kaleidoscope: Extending the Language: Control Flow
3==================================================
4
5.. contents::
6   :local:
7
8Chapter 5 Introduction
9======================
10
11Welcome to Chapter 5 of the "`Implementing a language with
12LLVM <index.html>`_" tutorial. Parts 1-4 described the implementation of
13the simple Kaleidoscope language and included support for generating
14LLVM IR, followed by optimizations and a JIT compiler. Unfortunately, as
15presented, Kaleidoscope is mostly useless: it has no control flow other
16than call and return. This means that you can't have conditional
17branches in the code, significantly limiting its power. In this episode
18of "build that compiler", we'll extend Kaleidoscope to have an
19if/then/else expression plus a simple 'for' loop.
20
21If/Then/Else
22============
23
24Extending Kaleidoscope to support if/then/else is quite straightforward.
25It basically requires adding support for this "new" concept to the
26lexer, parser, AST, and LLVM code emitter. This example is nice, because
27it shows how easy it is to "grow" a language over time, incrementally
28extending it as new ideas are discovered.
29
30Before we get going on "how" we add this extension, lets talk about
31"what" we want. The basic idea is that we want to be able to write this
32sort of thing:
33
34::
35
36    def fib(x)
37      if x < 3 then
38        1
39      else
40        fib(x-1)+fib(x-2);
41
42In Kaleidoscope, every construct is an expression: there are no
43statements. As such, the if/then/else expression needs to return a value
44like any other. Since we're using a mostly functional form, we'll have
45it evaluate its conditional, then return the 'then' or 'else' value
46based on how the condition was resolved. This is very similar to the C
47"?:" expression.
48
49The semantics of the if/then/else expression is that it evaluates the
50condition to a boolean equality value: 0.0 is considered to be false and
51everything else is considered to be true. If the condition is true, the
52first subexpression is evaluated and returned, if the condition is
53false, the second subexpression is evaluated and returned. Since
54Kaleidoscope allows side-effects, this behavior is important to nail
55down.
56
57Now that we know what we "want", lets break this down into its
58constituent pieces.
59
60Lexer Extensions for If/Then/Else
61---------------------------------
62
63The lexer extensions are straightforward. First we add new enum values
64for the relevant tokens:
65
66.. code-block:: c++
67
68      // control
69      tok_if = -6,
70      tok_then = -7,
71      tok_else = -8,
72
73Once we have that, we recognize the new keywords in the lexer. This is
74pretty simple stuff:
75
76.. code-block:: c++
77
78        ...
79        if (IdentifierStr == "def")
80          return tok_def;
81        if (IdentifierStr == "extern")
82          return tok_extern;
83        if (IdentifierStr == "if")
84          return tok_if;
85        if (IdentifierStr == "then")
86          return tok_then;
87        if (IdentifierStr == "else")
88          return tok_else;
89        return tok_identifier;
90
91AST Extensions for If/Then/Else
92-------------------------------
93
94To represent the new expression we add a new AST node for it:
95
96.. code-block:: c++
97
98    /// IfExprAST - Expression class for if/then/else.
99    class IfExprAST : public ExprAST {
100      std::unique_ptr<ExprAST> Cond, Then, Else;
101
102    public:
103      IfExprAST(std::unique_ptr<ExprAST> Cond, std::unique_ptr<ExprAST> Then,
104                std::unique_ptr<ExprAST> Else)
105        : Cond(std::move(Cond)), Then(std::move(Then)), Else(std::move(Else)) {}
106      virtual Value *codegen();
107    };
108
109The AST node just has pointers to the various subexpressions.
110
111Parser Extensions for If/Then/Else
112----------------------------------
113
114Now that we have the relevant tokens coming from the lexer and we have
115the AST node to build, our parsing logic is relatively straightforward.
116First we define a new parsing function:
117
118.. code-block:: c++
119
120    /// ifexpr ::= 'if' expression 'then' expression 'else' expression
121    static std::unique_ptr<ExprAST> ParseIfExpr() {
122      getNextToken();  // eat the if.
123
124      // condition.
125      auto Cond = ParseExpression();
126      if (!Cond)
127        return nullptr;
128
129      if (CurTok != tok_then)
130        return LogError("expected then");
131      getNextToken();  // eat the then
132
133      auto Then = ParseExpression();
134      if (!Then)
135        return nullptr;
136
137      if (CurTok != tok_else)
138        return LogError("expected else");
139
140      getNextToken();
141
142      auto Else = ParseExpression();
143      if (!Else)
144        return nullptr;
145
146      return llvm::make_unique<IfExprAST>(std::move(Cond), std::move(Then),
147                                          std::move(Else));
148    }
149
150Next we hook it up as a primary expression:
151
152.. code-block:: c++
153
154    static std::unique_ptr<ExprAST> ParsePrimary() {
155      switch (CurTok) {
156      default:
157        return LogError("unknown token when expecting an expression");
158      case tok_identifier:
159        return ParseIdentifierExpr();
160      case tok_number:
161        return ParseNumberExpr();
162      case '(':
163        return ParseParenExpr();
164      case tok_if:
165        return ParseIfExpr();
166      }
167    }
168
169LLVM IR for If/Then/Else
170------------------------
171
172Now that we have it parsing and building the AST, the final piece is
173adding LLVM code generation support. This is the most interesting part
174of the if/then/else example, because this is where it starts to
175introduce new concepts. All of the code above has been thoroughly
176described in previous chapters.
177
178To motivate the code we want to produce, lets take a look at a simple
179example. Consider:
180
181::
182
183    extern foo();
184    extern bar();
185    def baz(x) if x then foo() else bar();
186
187If you disable optimizations, the code you'll (soon) get from
188Kaleidoscope looks like this:
189
190.. code-block:: llvm
191
192    declare double @foo()
193
194    declare double @bar()
195
196    define double @baz(double %x) {
197    entry:
198      %ifcond = fcmp one double %x, 0.000000e+00
199      br i1 %ifcond, label %then, label %else
200
201    then:       ; preds = %entry
202      %calltmp = call double @foo()
203      br label %ifcont
204
205    else:       ; preds = %entry
206      %calltmp1 = call double @bar()
207      br label %ifcont
208
209    ifcont:     ; preds = %else, %then
210      %iftmp = phi double [ %calltmp, %then ], [ %calltmp1, %else ]
211      ret double %iftmp
212    }
213
214To visualize the control flow graph, you can use a nifty feature of the
215LLVM '`opt <http://llvm.org/cmds/opt.html>`_' tool. If you put this LLVM
216IR into "t.ll" and run "``llvm-as < t.ll | opt -analyze -view-cfg``", `a
217window will pop up <../ProgrammersManual.html#viewing-graphs-while-debugging-code>`_ and you'll
218see this graph:
219
220.. figure:: LangImpl05-cfg.png
221   :align: center
222   :alt: Example CFG
223
224   Example CFG
225
226Another way to get this is to call "``F->viewCFG()``" or
227"``F->viewCFGOnly()``" (where F is a "``Function*``") either by
228inserting actual calls into the code and recompiling or by calling these
229in the debugger. LLVM has many nice features for visualizing various
230graphs.
231
232Getting back to the generated code, it is fairly simple: the entry block
233evaluates the conditional expression ("x" in our case here) and compares
234the result to 0.0 with the "``fcmp one``" instruction ('one' is "Ordered
235and Not Equal"). Based on the result of this expression, the code jumps
236to either the "then" or "else" blocks, which contain the expressions for
237the true/false cases.
238
239Once the then/else blocks are finished executing, they both branch back
240to the 'ifcont' block to execute the code that happens after the
241if/then/else. In this case the only thing left to do is to return to the
242caller of the function. The question then becomes: how does the code
243know which expression to return?
244
245The answer to this question involves an important SSA operation: the
246`Phi
247operation <http://en.wikipedia.org/wiki/Static_single_assignment_form>`_.
248If you're not familiar with SSA, `the wikipedia
249article <http://en.wikipedia.org/wiki/Static_single_assignment_form>`_
250is a good introduction and there are various other introductions to it
251available on your favorite search engine. The short version is that
252"execution" of the Phi operation requires "remembering" which block
253control came from. The Phi operation takes on the value corresponding to
254the input control block. In this case, if control comes in from the
255"then" block, it gets the value of "calltmp". If control comes from the
256"else" block, it gets the value of "calltmp1".
257
258At this point, you are probably starting to think "Oh no! This means my
259simple and elegant front-end will have to start generating SSA form in
260order to use LLVM!". Fortunately, this is not the case, and we strongly
261advise *not* implementing an SSA construction algorithm in your
262front-end unless there is an amazingly good reason to do so. In
263practice, there are two sorts of values that float around in code
264written for your average imperative programming language that might need
265Phi nodes:
266
267#. Code that involves user variables: ``x = 1; x = x + 1;``
268#. Values that are implicit in the structure of your AST, such as the
269   Phi node in this case.
270
271In `Chapter 7 <LangImpl7.html>`_ of this tutorial ("mutable variables"),
272we'll talk about #1 in depth. For now, just believe me that you don't
273need SSA construction to handle this case. For #2, you have the choice
274of using the techniques that we will describe for #1, or you can insert
275Phi nodes directly, if convenient. In this case, it is really
276easy to generate the Phi node, so we choose to do it directly.
277
278Okay, enough of the motivation and overview, lets generate code!
279
280Code Generation for If/Then/Else
281--------------------------------
282
283In order to generate code for this, we implement the ``codegen`` method
284for ``IfExprAST``:
285
286.. code-block:: c++
287
288    Value *IfExprAST::codegen() {
289      Value *CondV = Cond->codegen();
290      if (!CondV)
291        return nullptr;
292
293      // Convert condition to a bool by comparing equal to 0.0.
294      CondV = Builder.CreateFCmpONE(
295          CondV, ConstantFP::get(LLVMContext, APFloat(0.0)), "ifcond");
296
297This code is straightforward and similar to what we saw before. We emit
298the expression for the condition, then compare that value to zero to get
299a truth value as a 1-bit (bool) value.
300
301.. code-block:: c++
302
303      Function *TheFunction = Builder.GetInsertBlock()->getParent();
304
305      // Create blocks for the then and else cases.  Insert the 'then' block at the
306      // end of the function.
307      BasicBlock *ThenBB =
308          BasicBlock::Create(LLVMContext, "then", TheFunction);
309      BasicBlock *ElseBB = BasicBlock::Create(LLVMContext, "else");
310      BasicBlock *MergeBB = BasicBlock::Create(LLVMContext, "ifcont");
311
312      Builder.CreateCondBr(CondV, ThenBB, ElseBB);
313
314This code creates the basic blocks that are related to the if/then/else
315statement, and correspond directly to the blocks in the example above.
316The first line gets the current Function object that is being built. It
317gets this by asking the builder for the current BasicBlock, and asking
318that block for its "parent" (the function it is currently embedded
319into).
320
321Once it has that, it creates three blocks. Note that it passes
322"TheFunction" into the constructor for the "then" block. This causes the
323constructor to automatically insert the new block into the end of the
324specified function. The other two blocks are created, but aren't yet
325inserted into the function.
326
327Once the blocks are created, we can emit the conditional branch that
328chooses between them. Note that creating new blocks does not implicitly
329affect the IRBuilder, so it is still inserting into the block that the
330condition went into. Also note that it is creating a branch to the
331"then" block and the "else" block, even though the "else" block isn't
332inserted into the function yet. This is all ok: it is the standard way
333that LLVM supports forward references.
334
335.. code-block:: c++
336
337      // Emit then value.
338      Builder.SetInsertPoint(ThenBB);
339
340      Value *ThenV = Then->codegen();
341      if (!ThenV)
342        return nullptr;
343
344      Builder.CreateBr(MergeBB);
345      // Codegen of 'Then' can change the current block, update ThenBB for the PHI.
346      ThenBB = Builder.GetInsertBlock();
347
348After the conditional branch is inserted, we move the builder to start
349inserting into the "then" block. Strictly speaking, this call moves the
350insertion point to be at the end of the specified block. However, since
351the "then" block is empty, it also starts out by inserting at the
352beginning of the block. :)
353
354Once the insertion point is set, we recursively codegen the "then"
355expression from the AST. To finish off the "then" block, we create an
356unconditional branch to the merge block. One interesting (and very
357important) aspect of the LLVM IR is that it `requires all basic blocks
358to be "terminated" <../LangRef.html#functionstructure>`_ with a `control
359flow instruction <../LangRef.html#terminators>`_ such as return or
360branch. This means that all control flow, *including fall throughs* must
361be made explicit in the LLVM IR. If you violate this rule, the verifier
362will emit an error.
363
364The final line here is quite subtle, but is very important. The basic
365issue is that when we create the Phi node in the merge block, we need to
366set up the block/value pairs that indicate how the Phi will work.
367Importantly, the Phi node expects to have an entry for each predecessor
368of the block in the CFG. Why then, are we getting the current block when
369we just set it to ThenBB 5 lines above? The problem is that the "Then"
370expression may actually itself change the block that the Builder is
371emitting into if, for example, it contains a nested "if/then/else"
372expression. Because calling ``codegen()`` recursively could arbitrarily change
373the notion of the current block, we are required to get an up-to-date
374value for code that will set up the Phi node.
375
376.. code-block:: c++
377
378      // Emit else block.
379      TheFunction->getBasicBlockList().push_back(ElseBB);
380      Builder.SetInsertPoint(ElseBB);
381
382      Value *ElseV = Else->codegen();
383      if (!ElseV)
384        return nullptr;
385
386      Builder.CreateBr(MergeBB);
387      // codegen of 'Else' can change the current block, update ElseBB for the PHI.
388      ElseBB = Builder.GetInsertBlock();
389
390Code generation for the 'else' block is basically identical to codegen
391for the 'then' block. The only significant difference is the first line,
392which adds the 'else' block to the function. Recall previously that the
393'else' block was created, but not added to the function. Now that the
394'then' and 'else' blocks are emitted, we can finish up with the merge
395code:
396
397.. code-block:: c++
398
399      // Emit merge block.
400      TheFunction->getBasicBlockList().push_back(MergeBB);
401      Builder.SetInsertPoint(MergeBB);
402      PHINode *PN =
403        Builder.CreatePHI(Type::getDoubleTy(LLVMContext), 2, "iftmp");
404
405      PN->addIncoming(ThenV, ThenBB);
406      PN->addIncoming(ElseV, ElseBB);
407      return PN;
408    }
409
410The first two lines here are now familiar: the first adds the "merge"
411block to the Function object (it was previously floating, like the else
412block above). The second changes the insertion point so that newly
413created code will go into the "merge" block. Once that is done, we need
414to create the PHI node and set up the block/value pairs for the PHI.
415
416Finally, the CodeGen function returns the phi node as the value computed
417by the if/then/else expression. In our example above, this returned
418value will feed into the code for the top-level function, which will
419create the return instruction.
420
421Overall, we now have the ability to execute conditional code in
422Kaleidoscope. With this extension, Kaleidoscope is a fairly complete
423language that can calculate a wide variety of numeric functions. Next up
424we'll add another useful expression that is familiar from non-functional
425languages...
426
427'for' Loop Expression
428=====================
429
430Now that we know how to add basic control flow constructs to the
431language, we have the tools to add more powerful things. Lets add
432something more aggressive, a 'for' expression:
433
434::
435
436     extern putchard(char)
437     def printstar(n)
438       for i = 1, i < n, 1.0 in
439         putchard(42);  # ascii 42 = '*'
440
441     # print 100 '*' characters
442     printstar(100);
443
444This expression defines a new variable ("i" in this case) which iterates
445from a starting value, while the condition ("i < n" in this case) is
446true, incrementing by an optional step value ("1.0" in this case). If
447the step value is omitted, it defaults to 1.0. While the loop is true,
448it executes its body expression. Because we don't have anything better
449to return, we'll just define the loop as always returning 0.0. In the
450future when we have mutable variables, it will get more useful.
451
452As before, lets talk about the changes that we need to Kaleidoscope to
453support this.
454
455Lexer Extensions for the 'for' Loop
456-----------------------------------
457
458The lexer extensions are the same sort of thing as for if/then/else:
459
460.. code-block:: c++
461
462      ... in enum Token ...
463      // control
464      tok_if = -6, tok_then = -7, tok_else = -8,
465      tok_for = -9, tok_in = -10
466
467      ... in gettok ...
468      if (IdentifierStr == "def")
469        return tok_def;
470      if (IdentifierStr == "extern")
471        return tok_extern;
472      if (IdentifierStr == "if")
473        return tok_if;
474      if (IdentifierStr == "then")
475        return tok_then;
476      if (IdentifierStr == "else")
477        return tok_else;
478      if (IdentifierStr == "for")
479        return tok_for;
480      if (IdentifierStr == "in")
481        return tok_in;
482      return tok_identifier;
483
484AST Extensions for the 'for' Loop
485---------------------------------
486
487The AST node is just as simple. It basically boils down to capturing the
488variable name and the constituent expressions in the node.
489
490.. code-block:: c++
491
492    /// ForExprAST - Expression class for for/in.
493    class ForExprAST : public ExprAST {
494      std::string VarName;
495      std::unique_ptr<ExprAST> Start, End, Step, Body;
496
497    public:
498      ForExprAST(const std::string &VarName, std::unique_ptr<ExprAST> Start,
499                 std::unique_ptr<ExprAST> End, std::unique_ptr<ExprAST> Step,
500                 std::unique_ptr<ExprAST> Body)
501        : VarName(VarName), Start(std::move(Start)), End(std::move(End)),
502          Step(std::move(Step)), Body(std::move(Body)) {}
503      virtual Value *codegen();
504    };
505
506Parser Extensions for the 'for' Loop
507------------------------------------
508
509The parser code is also fairly standard. The only interesting thing here
510is handling of the optional step value. The parser code handles it by
511checking to see if the second comma is present. If not, it sets the step
512value to null in the AST node:
513
514.. code-block:: c++
515
516    /// forexpr ::= 'for' identifier '=' expr ',' expr (',' expr)? 'in' expression
517    static std::unique_ptr<ExprAST> ParseForExpr() {
518      getNextToken();  // eat the for.
519
520      if (CurTok != tok_identifier)
521        return LogError("expected identifier after for");
522
523      std::string IdName = IdentifierStr;
524      getNextToken();  // eat identifier.
525
526      if (CurTok != '=')
527        return LogError("expected '=' after for");
528      getNextToken();  // eat '='.
529
530
531      auto Start = ParseExpression();
532      if (!Start)
533        return nullptr;
534      if (CurTok != ',')
535        return LogError("expected ',' after for start value");
536      getNextToken();
537
538      auto End = ParseExpression();
539      if (!End)
540        return nullptr;
541
542      // The step value is optional.
543      std::unique_ptr<ExprAST> Step;
544      if (CurTok == ',') {
545        getNextToken();
546        Step = ParseExpression();
547        if (!Step)
548          return nullptr;
549      }
550
551      if (CurTok != tok_in)
552        return LogError("expected 'in' after for");
553      getNextToken();  // eat 'in'.
554
555      auto Body = ParseExpression();
556      if (!Body)
557        return nullptr;
558
559      return llvm::make_unique<ForExprAST>(IdName, std::move(Start),
560                                           std::move(End), std::move(Step),
561                                           std::move(Body));
562    }
563
564LLVM IR for the 'for' Loop
565--------------------------
566
567Now we get to the good part: the LLVM IR we want to generate for this
568thing. With the simple example above, we get this LLVM IR (note that
569this dump is generated with optimizations disabled for clarity):
570
571.. code-block:: llvm
572
573    declare double @putchard(double)
574
575    define double @printstar(double %n) {
576    entry:
577      ; initial value = 1.0 (inlined into phi)
578      br label %loop
579
580    loop:       ; preds = %loop, %entry
581      %i = phi double [ 1.000000e+00, %entry ], [ %nextvar, %loop ]
582      ; body
583      %calltmp = call double @putchard(double 4.200000e+01)
584      ; increment
585      %nextvar = fadd double %i, 1.000000e+00
586
587      ; termination test
588      %cmptmp = fcmp ult double %i, %n
589      %booltmp = uitofp i1 %cmptmp to double
590      %loopcond = fcmp one double %booltmp, 0.000000e+00
591      br i1 %loopcond, label %loop, label %afterloop
592
593    afterloop:      ; preds = %loop
594      ; loop always returns 0.0
595      ret double 0.000000e+00
596    }
597
598This loop contains all the same constructs we saw before: a phi node,
599several expressions, and some basic blocks. Lets see how this fits
600together.
601
602Code Generation for the 'for' Loop
603----------------------------------
604
605The first part of codegen is very simple: we just output the start
606expression for the loop value:
607
608.. code-block:: c++
609
610    Value *ForExprAST::codegen() {
611      // Emit the start code first, without 'variable' in scope.
612      Value *StartVal = Start->codegen();
613      if (StartVal == 0) return 0;
614
615With this out of the way, the next step is to set up the LLVM basic
616block for the start of the loop body. In the case above, the whole loop
617body is one block, but remember that the body code itself could consist
618of multiple blocks (e.g. if it contains an if/then/else or a for/in
619expression).
620
621.. code-block:: c++
622
623      // Make the new basic block for the loop header, inserting after current
624      // block.
625      Function *TheFunction = Builder.GetInsertBlock()->getParent();
626      BasicBlock *PreheaderBB = Builder.GetInsertBlock();
627      BasicBlock *LoopBB =
628          BasicBlock::Create(LLVMContext, "loop", TheFunction);
629
630      // Insert an explicit fall through from the current block to the LoopBB.
631      Builder.CreateBr(LoopBB);
632
633This code is similar to what we saw for if/then/else. Because we will
634need it to create the Phi node, we remember the block that falls through
635into the loop. Once we have that, we create the actual block that starts
636the loop and create an unconditional branch for the fall-through between
637the two blocks.
638
639.. code-block:: c++
640
641      // Start insertion in LoopBB.
642      Builder.SetInsertPoint(LoopBB);
643
644      // Start the PHI node with an entry for Start.
645      PHINode *Variable = Builder.CreatePHI(Type::getDoubleTy(LLVMContext),
646                                            2, VarName.c_str());
647      Variable->addIncoming(StartVal, PreheaderBB);
648
649Now that the "preheader" for the loop is set up, we switch to emitting
650code for the loop body. To begin with, we move the insertion point and
651create the PHI node for the loop induction variable. Since we already
652know the incoming value for the starting value, we add it to the Phi
653node. Note that the Phi will eventually get a second value for the
654backedge, but we can't set it up yet (because it doesn't exist!).
655
656.. code-block:: c++
657
658      // Within the loop, the variable is defined equal to the PHI node.  If it
659      // shadows an existing variable, we have to restore it, so save it now.
660      Value *OldVal = NamedValues[VarName];
661      NamedValues[VarName] = Variable;
662
663      // Emit the body of the loop.  This, like any other expr, can change the
664      // current BB.  Note that we ignore the value computed by the body, but don't
665      // allow an error.
666      if (!Body->codegen())
667        return nullptr;
668
669Now the code starts to get more interesting. Our 'for' loop introduces a
670new variable to the symbol table. This means that our symbol table can
671now contain either function arguments or loop variables. To handle this,
672before we codegen the body of the loop, we add the loop variable as the
673current value for its name. Note that it is possible that there is a
674variable of the same name in the outer scope. It would be easy to make
675this an error (emit an error and return null if there is already an
676entry for VarName) but we choose to allow shadowing of variables. In
677order to handle this correctly, we remember the Value that we are
678potentially shadowing in ``OldVal`` (which will be null if there is no
679shadowed variable).
680
681Once the loop variable is set into the symbol table, the code
682recursively codegen's the body. This allows the body to use the loop
683variable: any references to it will naturally find it in the symbol
684table.
685
686.. code-block:: c++
687
688      // Emit the step value.
689      Value *StepVal = nullptr;
690      if (Step) {
691        StepVal = Step->codegen();
692        if (!StepVal)
693          return nullptr;
694      } else {
695        // If not specified, use 1.0.
696        StepVal = ConstantFP::get(LLVMContext, APFloat(1.0));
697      }
698
699      Value *NextVar = Builder.CreateFAdd(Variable, StepVal, "nextvar");
700
701Now that the body is emitted, we compute the next value of the iteration
702variable by adding the step value, or 1.0 if it isn't present.
703'``NextVar``' will be the value of the loop variable on the next
704iteration of the loop.
705
706.. code-block:: c++
707
708      // Compute the end condition.
709      Value *EndCond = End->codegen();
710      if (!EndCond)
711        return nullptr;
712
713      // Convert condition to a bool by comparing equal to 0.0.
714      EndCond = Builder.CreateFCmpONE(
715          EndCond, ConstantFP::get(LLVMContext, APFloat(0.0)), "loopcond");
716
717Finally, we evaluate the exit value of the loop, to determine whether
718the loop should exit. This mirrors the condition evaluation for the
719if/then/else statement.
720
721.. code-block:: c++
722
723      // Create the "after loop" block and insert it.
724      BasicBlock *LoopEndBB = Builder.GetInsertBlock();
725      BasicBlock *AfterBB =
726          BasicBlock::Create(LLVMContext, "afterloop", TheFunction);
727
728      // Insert the conditional branch into the end of LoopEndBB.
729      Builder.CreateCondBr(EndCond, LoopBB, AfterBB);
730
731      // Any new code will be inserted in AfterBB.
732      Builder.SetInsertPoint(AfterBB);
733
734With the code for the body of the loop complete, we just need to finish
735up the control flow for it. This code remembers the end block (for the
736phi node), then creates the block for the loop exit ("afterloop"). Based
737on the value of the exit condition, it creates a conditional branch that
738chooses between executing the loop again and exiting the loop. Any
739future code is emitted in the "afterloop" block, so it sets the
740insertion position to it.
741
742.. code-block:: c++
743
744      // Add a new entry to the PHI node for the backedge.
745      Variable->addIncoming(NextVar, LoopEndBB);
746
747      // Restore the unshadowed variable.
748      if (OldVal)
749        NamedValues[VarName] = OldVal;
750      else
751        NamedValues.erase(VarName);
752
753      // for expr always returns 0.0.
754      return Constant::getNullValue(Type::getDoubleTy(LLVMContext));
755    }
756
757The final code handles various cleanups: now that we have the "NextVar"
758value, we can add the incoming value to the loop PHI node. After that,
759we remove the loop variable from the symbol table, so that it isn't in
760scope after the for loop. Finally, code generation of the for loop
761always returns 0.0, so that is what we return from
762``ForExprAST::codegen()``.
763
764With this, we conclude the "adding control flow to Kaleidoscope" chapter
765of the tutorial. In this chapter we added two control flow constructs,
766and used them to motivate a couple of aspects of the LLVM IR that are
767important for front-end implementors to know. In the next chapter of our
768saga, we will get a bit crazier and add `user-defined
769operators <LangImpl6.html>`_ to our poor innocent language.
770
771Full Code Listing
772=================
773
774Here is the complete code listing for our running example, enhanced with
775the if/then/else and for expressions.. To build this example, use:
776
777.. code-block:: bash
778
779    # Compile
780    clang++ -g toy.cpp `llvm-config --cxxflags --ldflags --system-libs --libs core mcjit native` -O3 -o toy
781    # Run
782    ./toy
783
784Here is the code:
785
786.. literalinclude:: ../../examples/Kaleidoscope/Chapter5/toy.cpp
787   :language: c++
788
789`Next: Extending the language: user-defined operators <LangImpl06.html>`_
790
791