1 //===--- CGStmt.cpp - Emit LLVM Code from Statements ----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This contains code to emit Stmt nodes as LLVM code.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "CodeGenFunction.h"
15 #include "CGDebugInfo.h"
16 #include "CodeGenModule.h"
17 #include "TargetInfo.h"
18 #include "clang/AST/StmtVisitor.h"
19 #include "clang/Basic/Builtins.h"
20 #include "clang/Basic/PrettyStackTrace.h"
21 #include "clang/Basic/TargetInfo.h"
22 #include "clang/Sema/LoopHint.h"
23 #include "clang/Sema/SemaDiagnostic.h"
24 #include "llvm/ADT/StringExtras.h"
25 #include "llvm/IR/CallSite.h"
26 #include "llvm/IR/DataLayout.h"
27 #include "llvm/IR/InlineAsm.h"
28 #include "llvm/IR/Intrinsics.h"
29 #include "llvm/IR/MDBuilder.h"
30 
31 using namespace clang;
32 using namespace CodeGen;
33 
34 //===----------------------------------------------------------------------===//
35 //                              Statement Emission
36 //===----------------------------------------------------------------------===//
37 
38 void CodeGenFunction::EmitStopPoint(const Stmt *S) {
39   if (CGDebugInfo *DI = getDebugInfo()) {
40     SourceLocation Loc;
41     Loc = S->getLocStart();
42     DI->EmitLocation(Builder, Loc);
43 
44     LastStopPoint = Loc;
45   }
46 }
47 
48 void CodeGenFunction::EmitStmt(const Stmt *S) {
49   assert(S && "Null statement?");
50   PGO.setCurrentStmt(S);
51 
52   // These statements have their own debug info handling.
53   if (EmitSimpleStmt(S))
54     return;
55 
56   // Check if we are generating unreachable code.
57   if (!HaveInsertPoint()) {
58     // If so, and the statement doesn't contain a label, then we do not need to
59     // generate actual code. This is safe because (1) the current point is
60     // unreachable, so we don't need to execute the code, and (2) we've already
61     // handled the statements which update internal data structures (like the
62     // local variable map) which could be used by subsequent statements.
63     if (!ContainsLabel(S)) {
64       // Verify that any decl statements were handled as simple, they may be in
65       // scope of subsequent reachable statements.
66       assert(!isa<DeclStmt>(*S) && "Unexpected DeclStmt!");
67       return;
68     }
69 
70     // Otherwise, make a new block to hold the code.
71     EnsureInsertPoint();
72   }
73 
74   // Generate a stoppoint if we are emitting debug info.
75   EmitStopPoint(S);
76 
77   switch (S->getStmtClass()) {
78   case Stmt::NoStmtClass:
79   case Stmt::CXXCatchStmtClass:
80   case Stmt::SEHExceptStmtClass:
81   case Stmt::SEHFinallyStmtClass:
82   case Stmt::MSDependentExistsStmtClass:
83     llvm_unreachable("invalid statement class to emit generically");
84   case Stmt::NullStmtClass:
85   case Stmt::CompoundStmtClass:
86   case Stmt::DeclStmtClass:
87   case Stmt::LabelStmtClass:
88   case Stmt::AttributedStmtClass:
89   case Stmt::GotoStmtClass:
90   case Stmt::BreakStmtClass:
91   case Stmt::ContinueStmtClass:
92   case Stmt::DefaultStmtClass:
93   case Stmt::CaseStmtClass:
94   case Stmt::SEHLeaveStmtClass:
95     llvm_unreachable("should have emitted these statements as simple");
96 
97 #define STMT(Type, Base)
98 #define ABSTRACT_STMT(Op)
99 #define EXPR(Type, Base) \
100   case Stmt::Type##Class:
101 #include "clang/AST/StmtNodes.inc"
102   {
103     // Remember the block we came in on.
104     llvm::BasicBlock *incoming = Builder.GetInsertBlock();
105     assert(incoming && "expression emission must have an insertion point");
106 
107     EmitIgnoredExpr(cast<Expr>(S));
108 
109     llvm::BasicBlock *outgoing = Builder.GetInsertBlock();
110     assert(outgoing && "expression emission cleared block!");
111 
112     // The expression emitters assume (reasonably!) that the insertion
113     // point is always set.  To maintain that, the call-emission code
114     // for noreturn functions has to enter a new block with no
115     // predecessors.  We want to kill that block and mark the current
116     // insertion point unreachable in the common case of a call like
117     // "exit();".  Since expression emission doesn't otherwise create
118     // blocks with no predecessors, we can just test for that.
119     // However, we must be careful not to do this to our incoming
120     // block, because *statement* emission does sometimes create
121     // reachable blocks which will have no predecessors until later in
122     // the function.  This occurs with, e.g., labels that are not
123     // reachable by fallthrough.
124     if (incoming != outgoing && outgoing->use_empty()) {
125       outgoing->eraseFromParent();
126       Builder.ClearInsertionPoint();
127     }
128     break;
129   }
130 
131   case Stmt::IndirectGotoStmtClass:
132     EmitIndirectGotoStmt(cast<IndirectGotoStmt>(*S)); break;
133 
134   case Stmt::IfStmtClass:       EmitIfStmt(cast<IfStmt>(*S));             break;
135   case Stmt::WhileStmtClass:    EmitWhileStmt(cast<WhileStmt>(*S));       break;
136   case Stmt::DoStmtClass:       EmitDoStmt(cast<DoStmt>(*S));             break;
137   case Stmt::ForStmtClass:      EmitForStmt(cast<ForStmt>(*S));           break;
138 
139   case Stmt::ReturnStmtClass:   EmitReturnStmt(cast<ReturnStmt>(*S));     break;
140 
141   case Stmt::SwitchStmtClass:   EmitSwitchStmt(cast<SwitchStmt>(*S));     break;
142   case Stmt::GCCAsmStmtClass:   // Intentional fall-through.
143   case Stmt::MSAsmStmtClass:    EmitAsmStmt(cast<AsmStmt>(*S));           break;
144   case Stmt::CoroutineBodyStmtClass:
145     EmitCoroutineBody(cast<CoroutineBodyStmt>(*S));
146     break;
147   case Stmt::CoreturnStmtClass:
148     CGM.ErrorUnsupported(S, "coroutine");
149     break;
150   case Stmt::CapturedStmtClass: {
151     const CapturedStmt *CS = cast<CapturedStmt>(S);
152     EmitCapturedStmt(*CS, CS->getCapturedRegionKind());
153     }
154     break;
155   case Stmt::ObjCAtTryStmtClass:
156     EmitObjCAtTryStmt(cast<ObjCAtTryStmt>(*S));
157     break;
158   case Stmt::ObjCAtCatchStmtClass:
159     llvm_unreachable(
160                     "@catch statements should be handled by EmitObjCAtTryStmt");
161   case Stmt::ObjCAtFinallyStmtClass:
162     llvm_unreachable(
163                   "@finally statements should be handled by EmitObjCAtTryStmt");
164   case Stmt::ObjCAtThrowStmtClass:
165     EmitObjCAtThrowStmt(cast<ObjCAtThrowStmt>(*S));
166     break;
167   case Stmt::ObjCAtSynchronizedStmtClass:
168     EmitObjCAtSynchronizedStmt(cast<ObjCAtSynchronizedStmt>(*S));
169     break;
170   case Stmt::ObjCForCollectionStmtClass:
171     EmitObjCForCollectionStmt(cast<ObjCForCollectionStmt>(*S));
172     break;
173   case Stmt::ObjCAutoreleasePoolStmtClass:
174     EmitObjCAutoreleasePoolStmt(cast<ObjCAutoreleasePoolStmt>(*S));
175     break;
176 
177   case Stmt::CXXTryStmtClass:
178     EmitCXXTryStmt(cast<CXXTryStmt>(*S));
179     break;
180   case Stmt::CXXForRangeStmtClass:
181     EmitCXXForRangeStmt(cast<CXXForRangeStmt>(*S));
182     break;
183   case Stmt::SEHTryStmtClass:
184     EmitSEHTryStmt(cast<SEHTryStmt>(*S));
185     break;
186   case Stmt::OMPParallelDirectiveClass:
187     EmitOMPParallelDirective(cast<OMPParallelDirective>(*S));
188     break;
189   case Stmt::OMPSimdDirectiveClass:
190     EmitOMPSimdDirective(cast<OMPSimdDirective>(*S));
191     break;
192   case Stmt::OMPForDirectiveClass:
193     EmitOMPForDirective(cast<OMPForDirective>(*S));
194     break;
195   case Stmt::OMPForSimdDirectiveClass:
196     EmitOMPForSimdDirective(cast<OMPForSimdDirective>(*S));
197     break;
198   case Stmt::OMPSectionsDirectiveClass:
199     EmitOMPSectionsDirective(cast<OMPSectionsDirective>(*S));
200     break;
201   case Stmt::OMPSectionDirectiveClass:
202     EmitOMPSectionDirective(cast<OMPSectionDirective>(*S));
203     break;
204   case Stmt::OMPSingleDirectiveClass:
205     EmitOMPSingleDirective(cast<OMPSingleDirective>(*S));
206     break;
207   case Stmt::OMPMasterDirectiveClass:
208     EmitOMPMasterDirective(cast<OMPMasterDirective>(*S));
209     break;
210   case Stmt::OMPCriticalDirectiveClass:
211     EmitOMPCriticalDirective(cast<OMPCriticalDirective>(*S));
212     break;
213   case Stmt::OMPParallelForDirectiveClass:
214     EmitOMPParallelForDirective(cast<OMPParallelForDirective>(*S));
215     break;
216   case Stmt::OMPParallelForSimdDirectiveClass:
217     EmitOMPParallelForSimdDirective(cast<OMPParallelForSimdDirective>(*S));
218     break;
219   case Stmt::OMPParallelSectionsDirectiveClass:
220     EmitOMPParallelSectionsDirective(cast<OMPParallelSectionsDirective>(*S));
221     break;
222   case Stmt::OMPTaskDirectiveClass:
223     EmitOMPTaskDirective(cast<OMPTaskDirective>(*S));
224     break;
225   case Stmt::OMPTaskyieldDirectiveClass:
226     EmitOMPTaskyieldDirective(cast<OMPTaskyieldDirective>(*S));
227     break;
228   case Stmt::OMPBarrierDirectiveClass:
229     EmitOMPBarrierDirective(cast<OMPBarrierDirective>(*S));
230     break;
231   case Stmt::OMPTaskwaitDirectiveClass:
232     EmitOMPTaskwaitDirective(cast<OMPTaskwaitDirective>(*S));
233     break;
234   case Stmt::OMPTaskgroupDirectiveClass:
235     EmitOMPTaskgroupDirective(cast<OMPTaskgroupDirective>(*S));
236     break;
237   case Stmt::OMPFlushDirectiveClass:
238     EmitOMPFlushDirective(cast<OMPFlushDirective>(*S));
239     break;
240   case Stmt::OMPOrderedDirectiveClass:
241     EmitOMPOrderedDirective(cast<OMPOrderedDirective>(*S));
242     break;
243   case Stmt::OMPAtomicDirectiveClass:
244     EmitOMPAtomicDirective(cast<OMPAtomicDirective>(*S));
245     break;
246   case Stmt::OMPTargetDirectiveClass:
247     EmitOMPTargetDirective(cast<OMPTargetDirective>(*S));
248     break;
249   case Stmt::OMPTeamsDirectiveClass:
250     EmitOMPTeamsDirective(cast<OMPTeamsDirective>(*S));
251     break;
252   case Stmt::OMPCancellationPointDirectiveClass:
253     EmitOMPCancellationPointDirective(cast<OMPCancellationPointDirective>(*S));
254     break;
255   case Stmt::OMPCancelDirectiveClass:
256     EmitOMPCancelDirective(cast<OMPCancelDirective>(*S));
257     break;
258   case Stmt::OMPTargetDataDirectiveClass:
259     EmitOMPTargetDataDirective(cast<OMPTargetDataDirective>(*S));
260     break;
261   case Stmt::OMPTargetEnterDataDirectiveClass:
262     EmitOMPTargetEnterDataDirective(cast<OMPTargetEnterDataDirective>(*S));
263     break;
264   case Stmt::OMPTargetExitDataDirectiveClass:
265     EmitOMPTargetExitDataDirective(cast<OMPTargetExitDataDirective>(*S));
266     break;
267   case Stmt::OMPTargetParallelDirectiveClass:
268     EmitOMPTargetParallelDirective(cast<OMPTargetParallelDirective>(*S));
269     break;
270   case Stmt::OMPTargetParallelForDirectiveClass:
271     EmitOMPTargetParallelForDirective(cast<OMPTargetParallelForDirective>(*S));
272     break;
273   case Stmt::OMPTaskLoopDirectiveClass:
274     EmitOMPTaskLoopDirective(cast<OMPTaskLoopDirective>(*S));
275     break;
276   case Stmt::OMPTaskLoopSimdDirectiveClass:
277     EmitOMPTaskLoopSimdDirective(cast<OMPTaskLoopSimdDirective>(*S));
278     break;
279   case Stmt::OMPDistributeDirectiveClass:
280     EmitOMPDistributeDirective(cast<OMPDistributeDirective>(*S));
281     break;
282   case Stmt::OMPTargetUpdateDirectiveClass:
283     EmitOMPTargetUpdateDirective(cast<OMPTargetUpdateDirective>(*S));
284     break;
285   case Stmt::OMPDistributeParallelForDirectiveClass:
286     EmitOMPDistributeParallelForDirective(
287         cast<OMPDistributeParallelForDirective>(*S));
288     break;
289   case Stmt::OMPDistributeParallelForSimdDirectiveClass:
290     EmitOMPDistributeParallelForSimdDirective(
291         cast<OMPDistributeParallelForSimdDirective>(*S));
292     break;
293   case Stmt::OMPDistributeSimdDirectiveClass:
294     EmitOMPDistributeSimdDirective(cast<OMPDistributeSimdDirective>(*S));
295     break;
296   case Stmt::OMPTargetParallelForSimdDirectiveClass:
297     EmitOMPTargetParallelForSimdDirective(
298         cast<OMPTargetParallelForSimdDirective>(*S));
299     break;
300   case Stmt::OMPTargetSimdDirectiveClass:
301     EmitOMPTargetSimdDirective(cast<OMPTargetSimdDirective>(*S));
302     break;
303   case Stmt::OMPTeamsDistributeDirectiveClass:
304     EmitOMPTeamsDistributeDirective(cast<OMPTeamsDistributeDirective>(*S));
305     break;
306   case Stmt::OMPTeamsDistributeSimdDirectiveClass:
307     EmitOMPTeamsDistributeSimdDirective(
308         cast<OMPTeamsDistributeSimdDirective>(*S));
309     break;
310   case Stmt::OMPTeamsDistributeParallelForSimdDirectiveClass:
311     EmitOMPTeamsDistributeParallelForSimdDirective(
312         cast<OMPTeamsDistributeParallelForSimdDirective>(*S));
313     break;
314   case Stmt::OMPTeamsDistributeParallelForDirectiveClass:
315     EmitOMPTeamsDistributeParallelForDirective(
316         cast<OMPTeamsDistributeParallelForDirective>(*S));
317     break;
318   case Stmt::OMPTargetTeamsDirectiveClass:
319     EmitOMPTargetTeamsDirective(cast<OMPTargetTeamsDirective>(*S));
320     break;
321   case Stmt::OMPTargetTeamsDistributeDirectiveClass:
322     EmitOMPTargetTeamsDistributeDirective(
323         cast<OMPTargetTeamsDistributeDirective>(*S));
324     break;
325   }
326 }
327 
328 bool CodeGenFunction::EmitSimpleStmt(const Stmt *S) {
329   switch (S->getStmtClass()) {
330   default: return false;
331   case Stmt::NullStmtClass: break;
332   case Stmt::CompoundStmtClass: EmitCompoundStmt(cast<CompoundStmt>(*S)); break;
333   case Stmt::DeclStmtClass:     EmitDeclStmt(cast<DeclStmt>(*S));         break;
334   case Stmt::LabelStmtClass:    EmitLabelStmt(cast<LabelStmt>(*S));       break;
335   case Stmt::AttributedStmtClass:
336                             EmitAttributedStmt(cast<AttributedStmt>(*S)); break;
337   case Stmt::GotoStmtClass:     EmitGotoStmt(cast<GotoStmt>(*S));         break;
338   case Stmt::BreakStmtClass:    EmitBreakStmt(cast<BreakStmt>(*S));       break;
339   case Stmt::ContinueStmtClass: EmitContinueStmt(cast<ContinueStmt>(*S)); break;
340   case Stmt::DefaultStmtClass:  EmitDefaultStmt(cast<DefaultStmt>(*S));   break;
341   case Stmt::CaseStmtClass:     EmitCaseStmt(cast<CaseStmt>(*S));         break;
342   case Stmt::SEHLeaveStmtClass: EmitSEHLeaveStmt(cast<SEHLeaveStmt>(*S)); break;
343   }
344 
345   return true;
346 }
347 
348 /// EmitCompoundStmt - Emit a compound statement {..} node.  If GetLast is true,
349 /// this captures the expression result of the last sub-statement and returns it
350 /// (for use by the statement expression extension).
351 Address CodeGenFunction::EmitCompoundStmt(const CompoundStmt &S, bool GetLast,
352                                           AggValueSlot AggSlot) {
353   PrettyStackTraceLoc CrashInfo(getContext().getSourceManager(),S.getLBracLoc(),
354                              "LLVM IR generation of compound statement ('{}')");
355 
356   // Keep track of the current cleanup stack depth, including debug scopes.
357   LexicalScope Scope(*this, S.getSourceRange());
358 
359   return EmitCompoundStmtWithoutScope(S, GetLast, AggSlot);
360 }
361 
362 Address
363 CodeGenFunction::EmitCompoundStmtWithoutScope(const CompoundStmt &S,
364                                               bool GetLast,
365                                               AggValueSlot AggSlot) {
366 
367   for (CompoundStmt::const_body_iterator I = S.body_begin(),
368        E = S.body_end()-GetLast; I != E; ++I)
369     EmitStmt(*I);
370 
371   Address RetAlloca = Address::invalid();
372   if (GetLast) {
373     // We have to special case labels here.  They are statements, but when put
374     // at the end of a statement expression, they yield the value of their
375     // subexpression.  Handle this by walking through all labels we encounter,
376     // emitting them before we evaluate the subexpr.
377     const Stmt *LastStmt = S.body_back();
378     while (const LabelStmt *LS = dyn_cast<LabelStmt>(LastStmt)) {
379       EmitLabel(LS->getDecl());
380       LastStmt = LS->getSubStmt();
381     }
382 
383     EnsureInsertPoint();
384 
385     QualType ExprTy = cast<Expr>(LastStmt)->getType();
386     if (hasAggregateEvaluationKind(ExprTy)) {
387       EmitAggExpr(cast<Expr>(LastStmt), AggSlot);
388     } else {
389       // We can't return an RValue here because there might be cleanups at
390       // the end of the StmtExpr.  Because of that, we have to emit the result
391       // here into a temporary alloca.
392       RetAlloca = CreateMemTemp(ExprTy);
393       EmitAnyExprToMem(cast<Expr>(LastStmt), RetAlloca, Qualifiers(),
394                        /*IsInit*/false);
395     }
396 
397   }
398 
399   return RetAlloca;
400 }
401 
402 void CodeGenFunction::SimplifyForwardingBlocks(llvm::BasicBlock *BB) {
403   llvm::BranchInst *BI = dyn_cast<llvm::BranchInst>(BB->getTerminator());
404 
405   // If there is a cleanup stack, then we it isn't worth trying to
406   // simplify this block (we would need to remove it from the scope map
407   // and cleanup entry).
408   if (!EHStack.empty())
409     return;
410 
411   // Can only simplify direct branches.
412   if (!BI || !BI->isUnconditional())
413     return;
414 
415   // Can only simplify empty blocks.
416   if (BI->getIterator() != BB->begin())
417     return;
418 
419   BB->replaceAllUsesWith(BI->getSuccessor(0));
420   BI->eraseFromParent();
421   BB->eraseFromParent();
422 }
423 
424 void CodeGenFunction::EmitBlock(llvm::BasicBlock *BB, bool IsFinished) {
425   llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
426 
427   // Fall out of the current block (if necessary).
428   EmitBranch(BB);
429 
430   if (IsFinished && BB->use_empty()) {
431     delete BB;
432     return;
433   }
434 
435   // Place the block after the current block, if possible, or else at
436   // the end of the function.
437   if (CurBB && CurBB->getParent())
438     CurFn->getBasicBlockList().insertAfter(CurBB->getIterator(), BB);
439   else
440     CurFn->getBasicBlockList().push_back(BB);
441   Builder.SetInsertPoint(BB);
442 }
443 
444 void CodeGenFunction::EmitBranch(llvm::BasicBlock *Target) {
445   // Emit a branch from the current block to the target one if this
446   // was a real block.  If this was just a fall-through block after a
447   // terminator, don't emit it.
448   llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
449 
450   if (!CurBB || CurBB->getTerminator()) {
451     // If there is no insert point or the previous block is already
452     // terminated, don't touch it.
453   } else {
454     // Otherwise, create a fall-through branch.
455     Builder.CreateBr(Target);
456   }
457 
458   Builder.ClearInsertionPoint();
459 }
460 
461 void CodeGenFunction::EmitBlockAfterUses(llvm::BasicBlock *block) {
462   bool inserted = false;
463   for (llvm::User *u : block->users()) {
464     if (llvm::Instruction *insn = dyn_cast<llvm::Instruction>(u)) {
465       CurFn->getBasicBlockList().insertAfter(insn->getParent()->getIterator(),
466                                              block);
467       inserted = true;
468       break;
469     }
470   }
471 
472   if (!inserted)
473     CurFn->getBasicBlockList().push_back(block);
474 
475   Builder.SetInsertPoint(block);
476 }
477 
478 CodeGenFunction::JumpDest
479 CodeGenFunction::getJumpDestForLabel(const LabelDecl *D) {
480   JumpDest &Dest = LabelMap[D];
481   if (Dest.isValid()) return Dest;
482 
483   // Create, but don't insert, the new block.
484   Dest = JumpDest(createBasicBlock(D->getName()),
485                   EHScopeStack::stable_iterator::invalid(),
486                   NextCleanupDestIndex++);
487   return Dest;
488 }
489 
490 void CodeGenFunction::EmitLabel(const LabelDecl *D) {
491   // Add this label to the current lexical scope if we're within any
492   // normal cleanups.  Jumps "in" to this label --- when permitted by
493   // the language --- may need to be routed around such cleanups.
494   if (EHStack.hasNormalCleanups() && CurLexicalScope)
495     CurLexicalScope->addLabel(D);
496 
497   JumpDest &Dest = LabelMap[D];
498 
499   // If we didn't need a forward reference to this label, just go
500   // ahead and create a destination at the current scope.
501   if (!Dest.isValid()) {
502     Dest = getJumpDestInCurrentScope(D->getName());
503 
504   // Otherwise, we need to give this label a target depth and remove
505   // it from the branch-fixups list.
506   } else {
507     assert(!Dest.getScopeDepth().isValid() && "already emitted label!");
508     Dest.setScopeDepth(EHStack.stable_begin());
509     ResolveBranchFixups(Dest.getBlock());
510   }
511 
512   EmitBlock(Dest.getBlock());
513   incrementProfileCounter(D->getStmt());
514 }
515 
516 /// Change the cleanup scope of the labels in this lexical scope to
517 /// match the scope of the enclosing context.
518 void CodeGenFunction::LexicalScope::rescopeLabels() {
519   assert(!Labels.empty());
520   EHScopeStack::stable_iterator innermostScope
521     = CGF.EHStack.getInnermostNormalCleanup();
522 
523   // Change the scope depth of all the labels.
524   for (SmallVectorImpl<const LabelDecl*>::const_iterator
525          i = Labels.begin(), e = Labels.end(); i != e; ++i) {
526     assert(CGF.LabelMap.count(*i));
527     JumpDest &dest = CGF.LabelMap.find(*i)->second;
528     assert(dest.getScopeDepth().isValid());
529     assert(innermostScope.encloses(dest.getScopeDepth()));
530     dest.setScopeDepth(innermostScope);
531   }
532 
533   // Reparent the labels if the new scope also has cleanups.
534   if (innermostScope != EHScopeStack::stable_end() && ParentScope) {
535     ParentScope->Labels.append(Labels.begin(), Labels.end());
536   }
537 }
538 
539 
540 void CodeGenFunction::EmitLabelStmt(const LabelStmt &S) {
541   EmitLabel(S.getDecl());
542   EmitStmt(S.getSubStmt());
543 }
544 
545 void CodeGenFunction::EmitAttributedStmt(const AttributedStmt &S) {
546   const Stmt *SubStmt = S.getSubStmt();
547   switch (SubStmt->getStmtClass()) {
548   case Stmt::DoStmtClass:
549     EmitDoStmt(cast<DoStmt>(*SubStmt), S.getAttrs());
550     break;
551   case Stmt::ForStmtClass:
552     EmitForStmt(cast<ForStmt>(*SubStmt), S.getAttrs());
553     break;
554   case Stmt::WhileStmtClass:
555     EmitWhileStmt(cast<WhileStmt>(*SubStmt), S.getAttrs());
556     break;
557   case Stmt::CXXForRangeStmtClass:
558     EmitCXXForRangeStmt(cast<CXXForRangeStmt>(*SubStmt), S.getAttrs());
559     break;
560   default:
561     EmitStmt(SubStmt);
562   }
563 }
564 
565 void CodeGenFunction::EmitGotoStmt(const GotoStmt &S) {
566   // If this code is reachable then emit a stop point (if generating
567   // debug info). We have to do this ourselves because we are on the
568   // "simple" statement path.
569   if (HaveInsertPoint())
570     EmitStopPoint(&S);
571 
572   EmitBranchThroughCleanup(getJumpDestForLabel(S.getLabel()));
573 }
574 
575 
576 void CodeGenFunction::EmitIndirectGotoStmt(const IndirectGotoStmt &S) {
577   if (const LabelDecl *Target = S.getConstantTarget()) {
578     EmitBranchThroughCleanup(getJumpDestForLabel(Target));
579     return;
580   }
581 
582   // Ensure that we have an i8* for our PHI node.
583   llvm::Value *V = Builder.CreateBitCast(EmitScalarExpr(S.getTarget()),
584                                          Int8PtrTy, "addr");
585   llvm::BasicBlock *CurBB = Builder.GetInsertBlock();
586 
587   // Get the basic block for the indirect goto.
588   llvm::BasicBlock *IndGotoBB = GetIndirectGotoBlock();
589 
590   // The first instruction in the block has to be the PHI for the switch dest,
591   // add an entry for this branch.
592   cast<llvm::PHINode>(IndGotoBB->begin())->addIncoming(V, CurBB);
593 
594   EmitBranch(IndGotoBB);
595 }
596 
597 void CodeGenFunction::EmitIfStmt(const IfStmt &S) {
598   // C99 6.8.4.1: The first substatement is executed if the expression compares
599   // unequal to 0.  The condition must be a scalar type.
600   LexicalScope ConditionScope(*this, S.getCond()->getSourceRange());
601 
602   if (S.getInit())
603     EmitStmt(S.getInit());
604 
605   if (S.getConditionVariable())
606     EmitAutoVarDecl(*S.getConditionVariable());
607 
608   // If the condition constant folds and can be elided, try to avoid emitting
609   // the condition and the dead arm of the if/else.
610   bool CondConstant;
611   if (ConstantFoldsToSimpleInteger(S.getCond(), CondConstant,
612                                    S.isConstexpr())) {
613     // Figure out which block (then or else) is executed.
614     const Stmt *Executed = S.getThen();
615     const Stmt *Skipped  = S.getElse();
616     if (!CondConstant)  // Condition false?
617       std::swap(Executed, Skipped);
618 
619     // If the skipped block has no labels in it, just emit the executed block.
620     // This avoids emitting dead code and simplifies the CFG substantially.
621     if (S.isConstexpr() || !ContainsLabel(Skipped)) {
622       if (CondConstant)
623         incrementProfileCounter(&S);
624       if (Executed) {
625         RunCleanupsScope ExecutedScope(*this);
626         EmitStmt(Executed);
627       }
628       return;
629     }
630   }
631 
632   // Otherwise, the condition did not fold, or we couldn't elide it.  Just emit
633   // the conditional branch.
634   llvm::BasicBlock *ThenBlock = createBasicBlock("if.then");
635   llvm::BasicBlock *ContBlock = createBasicBlock("if.end");
636   llvm::BasicBlock *ElseBlock = ContBlock;
637   if (S.getElse())
638     ElseBlock = createBasicBlock("if.else");
639 
640   EmitBranchOnBoolExpr(S.getCond(), ThenBlock, ElseBlock,
641                        getProfileCount(S.getThen()));
642 
643   // Emit the 'then' code.
644   EmitBlock(ThenBlock);
645   incrementProfileCounter(&S);
646   {
647     RunCleanupsScope ThenScope(*this);
648     EmitStmt(S.getThen());
649   }
650   EmitBranch(ContBlock);
651 
652   // Emit the 'else' code if present.
653   if (const Stmt *Else = S.getElse()) {
654     {
655       // There is no need to emit line number for an unconditional branch.
656       auto NL = ApplyDebugLocation::CreateEmpty(*this);
657       EmitBlock(ElseBlock);
658     }
659     {
660       RunCleanupsScope ElseScope(*this);
661       EmitStmt(Else);
662     }
663     {
664       // There is no need to emit line number for an unconditional branch.
665       auto NL = ApplyDebugLocation::CreateEmpty(*this);
666       EmitBranch(ContBlock);
667     }
668   }
669 
670   // Emit the continuation block for code after the if.
671   EmitBlock(ContBlock, true);
672 }
673 
674 void CodeGenFunction::EmitWhileStmt(const WhileStmt &S,
675                                     ArrayRef<const Attr *> WhileAttrs) {
676   // Emit the header for the loop, which will also become
677   // the continue target.
678   JumpDest LoopHeader = getJumpDestInCurrentScope("while.cond");
679   EmitBlock(LoopHeader.getBlock());
680 
681   const SourceRange &R = S.getSourceRange();
682   LoopStack.push(LoopHeader.getBlock(), CGM.getContext(), WhileAttrs,
683                  SourceLocToDebugLoc(R.getBegin()),
684                  SourceLocToDebugLoc(R.getEnd()));
685 
686   // Create an exit block for when the condition fails, which will
687   // also become the break target.
688   JumpDest LoopExit = getJumpDestInCurrentScope("while.end");
689 
690   // Store the blocks to use for break and continue.
691   BreakContinueStack.push_back(BreakContinue(LoopExit, LoopHeader));
692 
693   // C++ [stmt.while]p2:
694   //   When the condition of a while statement is a declaration, the
695   //   scope of the variable that is declared extends from its point
696   //   of declaration (3.3.2) to the end of the while statement.
697   //   [...]
698   //   The object created in a condition is destroyed and created
699   //   with each iteration of the loop.
700   RunCleanupsScope ConditionScope(*this);
701 
702   if (S.getConditionVariable())
703     EmitAutoVarDecl(*S.getConditionVariable());
704 
705   // Evaluate the conditional in the while header.  C99 6.8.5.1: The
706   // evaluation of the controlling expression takes place before each
707   // execution of the loop body.
708   llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
709 
710   // while(1) is common, avoid extra exit blocks.  Be sure
711   // to correctly handle break/continue though.
712   bool EmitBoolCondBranch = true;
713   if (llvm::ConstantInt *C = dyn_cast<llvm::ConstantInt>(BoolCondVal))
714     if (C->isOne())
715       EmitBoolCondBranch = false;
716 
717   // As long as the condition is true, go to the loop body.
718   llvm::BasicBlock *LoopBody = createBasicBlock("while.body");
719   if (EmitBoolCondBranch) {
720     llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
721     if (ConditionScope.requiresCleanups())
722       ExitBlock = createBasicBlock("while.exit");
723     Builder.CreateCondBr(
724         BoolCondVal, LoopBody, ExitBlock,
725         createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody())));
726 
727     if (ExitBlock != LoopExit.getBlock()) {
728       EmitBlock(ExitBlock);
729       EmitBranchThroughCleanup(LoopExit);
730     }
731   }
732 
733   // Emit the loop body.  We have to emit this in a cleanup scope
734   // because it might be a singleton DeclStmt.
735   {
736     RunCleanupsScope BodyScope(*this);
737     EmitBlock(LoopBody);
738     incrementProfileCounter(&S);
739     EmitStmt(S.getBody());
740   }
741 
742   BreakContinueStack.pop_back();
743 
744   // Immediately force cleanup.
745   ConditionScope.ForceCleanup();
746 
747   EmitStopPoint(&S);
748   // Branch to the loop header again.
749   EmitBranch(LoopHeader.getBlock());
750 
751   LoopStack.pop();
752 
753   // Emit the exit block.
754   EmitBlock(LoopExit.getBlock(), true);
755 
756   // The LoopHeader typically is just a branch if we skipped emitting
757   // a branch, try to erase it.
758   if (!EmitBoolCondBranch)
759     SimplifyForwardingBlocks(LoopHeader.getBlock());
760 }
761 
762 void CodeGenFunction::EmitDoStmt(const DoStmt &S,
763                                  ArrayRef<const Attr *> DoAttrs) {
764   JumpDest LoopExit = getJumpDestInCurrentScope("do.end");
765   JumpDest LoopCond = getJumpDestInCurrentScope("do.cond");
766 
767   uint64_t ParentCount = getCurrentProfileCount();
768 
769   // Store the blocks to use for break and continue.
770   BreakContinueStack.push_back(BreakContinue(LoopExit, LoopCond));
771 
772   // Emit the body of the loop.
773   llvm::BasicBlock *LoopBody = createBasicBlock("do.body");
774 
775   const SourceRange &R = S.getSourceRange();
776   LoopStack.push(LoopBody, CGM.getContext(), DoAttrs,
777                  SourceLocToDebugLoc(R.getBegin()),
778                  SourceLocToDebugLoc(R.getEnd()));
779 
780   EmitBlockWithFallThrough(LoopBody, &S);
781   {
782     RunCleanupsScope BodyScope(*this);
783     EmitStmt(S.getBody());
784   }
785 
786   EmitBlock(LoopCond.getBlock());
787 
788   // C99 6.8.5.2: "The evaluation of the controlling expression takes place
789   // after each execution of the loop body."
790 
791   // Evaluate the conditional in the while header.
792   // C99 6.8.5p2/p4: The first substatement is executed if the expression
793   // compares unequal to 0.  The condition must be a scalar type.
794   llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
795 
796   BreakContinueStack.pop_back();
797 
798   // "do {} while (0)" is common in macros, avoid extra blocks.  Be sure
799   // to correctly handle break/continue though.
800   bool EmitBoolCondBranch = true;
801   if (llvm::ConstantInt *C = dyn_cast<llvm::ConstantInt>(BoolCondVal))
802     if (C->isZero())
803       EmitBoolCondBranch = false;
804 
805   // As long as the condition is true, iterate the loop.
806   if (EmitBoolCondBranch) {
807     uint64_t BackedgeCount = getProfileCount(S.getBody()) - ParentCount;
808     Builder.CreateCondBr(
809         BoolCondVal, LoopBody, LoopExit.getBlock(),
810         createProfileWeightsForLoop(S.getCond(), BackedgeCount));
811   }
812 
813   LoopStack.pop();
814 
815   // Emit the exit block.
816   EmitBlock(LoopExit.getBlock());
817 
818   // The DoCond block typically is just a branch if we skipped
819   // emitting a branch, try to erase it.
820   if (!EmitBoolCondBranch)
821     SimplifyForwardingBlocks(LoopCond.getBlock());
822 }
823 
824 void CodeGenFunction::EmitForStmt(const ForStmt &S,
825                                   ArrayRef<const Attr *> ForAttrs) {
826   JumpDest LoopExit = getJumpDestInCurrentScope("for.end");
827 
828   LexicalScope ForScope(*this, S.getSourceRange());
829 
830   // Evaluate the first part before the loop.
831   if (S.getInit())
832     EmitStmt(S.getInit());
833 
834   // Start the loop with a block that tests the condition.
835   // If there's an increment, the continue scope will be overwritten
836   // later.
837   JumpDest Continue = getJumpDestInCurrentScope("for.cond");
838   llvm::BasicBlock *CondBlock = Continue.getBlock();
839   EmitBlock(CondBlock);
840 
841   const SourceRange &R = S.getSourceRange();
842   LoopStack.push(CondBlock, CGM.getContext(), ForAttrs,
843                  SourceLocToDebugLoc(R.getBegin()),
844                  SourceLocToDebugLoc(R.getEnd()));
845 
846   // If the for loop doesn't have an increment we can just use the
847   // condition as the continue block.  Otherwise we'll need to create
848   // a block for it (in the current scope, i.e. in the scope of the
849   // condition), and that we will become our continue block.
850   if (S.getInc())
851     Continue = getJumpDestInCurrentScope("for.inc");
852 
853   // Store the blocks to use for break and continue.
854   BreakContinueStack.push_back(BreakContinue(LoopExit, Continue));
855 
856   // Create a cleanup scope for the condition variable cleanups.
857   LexicalScope ConditionScope(*this, S.getSourceRange());
858 
859   if (S.getCond()) {
860     // If the for statement has a condition scope, emit the local variable
861     // declaration.
862     if (S.getConditionVariable()) {
863       EmitAutoVarDecl(*S.getConditionVariable());
864     }
865 
866     llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
867     // If there are any cleanups between here and the loop-exit scope,
868     // create a block to stage a loop exit along.
869     if (ForScope.requiresCleanups())
870       ExitBlock = createBasicBlock("for.cond.cleanup");
871 
872     // As long as the condition is true, iterate the loop.
873     llvm::BasicBlock *ForBody = createBasicBlock("for.body");
874 
875     // C99 6.8.5p2/p4: The first substatement is executed if the expression
876     // compares unequal to 0.  The condition must be a scalar type.
877     llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
878     Builder.CreateCondBr(
879         BoolCondVal, ForBody, ExitBlock,
880         createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody())));
881 
882     if (ExitBlock != LoopExit.getBlock()) {
883       EmitBlock(ExitBlock);
884       EmitBranchThroughCleanup(LoopExit);
885     }
886 
887     EmitBlock(ForBody);
888   } else {
889     // Treat it as a non-zero constant.  Don't even create a new block for the
890     // body, just fall into it.
891   }
892   incrementProfileCounter(&S);
893 
894   {
895     // Create a separate cleanup scope for the body, in case it is not
896     // a compound statement.
897     RunCleanupsScope BodyScope(*this);
898     EmitStmt(S.getBody());
899   }
900 
901   // If there is an increment, emit it next.
902   if (S.getInc()) {
903     EmitBlock(Continue.getBlock());
904     EmitStmt(S.getInc());
905   }
906 
907   BreakContinueStack.pop_back();
908 
909   ConditionScope.ForceCleanup();
910 
911   EmitStopPoint(&S);
912   EmitBranch(CondBlock);
913 
914   ForScope.ForceCleanup();
915 
916   LoopStack.pop();
917 
918   // Emit the fall-through block.
919   EmitBlock(LoopExit.getBlock(), true);
920 }
921 
922 void
923 CodeGenFunction::EmitCXXForRangeStmt(const CXXForRangeStmt &S,
924                                      ArrayRef<const Attr *> ForAttrs) {
925   JumpDest LoopExit = getJumpDestInCurrentScope("for.end");
926 
927   LexicalScope ForScope(*this, S.getSourceRange());
928 
929   // Evaluate the first pieces before the loop.
930   EmitStmt(S.getRangeStmt());
931   EmitStmt(S.getBeginStmt());
932   EmitStmt(S.getEndStmt());
933 
934   // Start the loop with a block that tests the condition.
935   // If there's an increment, the continue scope will be overwritten
936   // later.
937   llvm::BasicBlock *CondBlock = createBasicBlock("for.cond");
938   EmitBlock(CondBlock);
939 
940   const SourceRange &R = S.getSourceRange();
941   LoopStack.push(CondBlock, CGM.getContext(), ForAttrs,
942                  SourceLocToDebugLoc(R.getBegin()),
943                  SourceLocToDebugLoc(R.getEnd()));
944 
945   // If there are any cleanups between here and the loop-exit scope,
946   // create a block to stage a loop exit along.
947   llvm::BasicBlock *ExitBlock = LoopExit.getBlock();
948   if (ForScope.requiresCleanups())
949     ExitBlock = createBasicBlock("for.cond.cleanup");
950 
951   // The loop body, consisting of the specified body and the loop variable.
952   llvm::BasicBlock *ForBody = createBasicBlock("for.body");
953 
954   // The body is executed if the expression, contextually converted
955   // to bool, is true.
956   llvm::Value *BoolCondVal = EvaluateExprAsBool(S.getCond());
957   Builder.CreateCondBr(
958       BoolCondVal, ForBody, ExitBlock,
959       createProfileWeightsForLoop(S.getCond(), getProfileCount(S.getBody())));
960 
961   if (ExitBlock != LoopExit.getBlock()) {
962     EmitBlock(ExitBlock);
963     EmitBranchThroughCleanup(LoopExit);
964   }
965 
966   EmitBlock(ForBody);
967   incrementProfileCounter(&S);
968 
969   // Create a block for the increment. In case of a 'continue', we jump there.
970   JumpDest Continue = getJumpDestInCurrentScope("for.inc");
971 
972   // Store the blocks to use for break and continue.
973   BreakContinueStack.push_back(BreakContinue(LoopExit, Continue));
974 
975   {
976     // Create a separate cleanup scope for the loop variable and body.
977     LexicalScope BodyScope(*this, S.getSourceRange());
978     EmitStmt(S.getLoopVarStmt());
979     EmitStmt(S.getBody());
980   }
981 
982   EmitStopPoint(&S);
983   // If there is an increment, emit it next.
984   EmitBlock(Continue.getBlock());
985   EmitStmt(S.getInc());
986 
987   BreakContinueStack.pop_back();
988 
989   EmitBranch(CondBlock);
990 
991   ForScope.ForceCleanup();
992 
993   LoopStack.pop();
994 
995   // Emit the fall-through block.
996   EmitBlock(LoopExit.getBlock(), true);
997 }
998 
999 void CodeGenFunction::EmitReturnOfRValue(RValue RV, QualType Ty) {
1000   if (RV.isScalar()) {
1001     Builder.CreateStore(RV.getScalarVal(), ReturnValue);
1002   } else if (RV.isAggregate()) {
1003     EmitAggregateCopy(ReturnValue, RV.getAggregateAddress(), Ty);
1004   } else {
1005     EmitStoreOfComplex(RV.getComplexVal(), MakeAddrLValue(ReturnValue, Ty),
1006                        /*init*/ true);
1007   }
1008   EmitBranchThroughCleanup(ReturnBlock);
1009 }
1010 
1011 /// EmitReturnStmt - Note that due to GCC extensions, this can have an operand
1012 /// if the function returns void, or may be missing one if the function returns
1013 /// non-void.  Fun stuff :).
1014 void CodeGenFunction::EmitReturnStmt(const ReturnStmt &S) {
1015   // Returning from an outlined SEH helper is UB, and we already warn on it.
1016   if (IsOutlinedSEHHelper) {
1017     Builder.CreateUnreachable();
1018     Builder.ClearInsertionPoint();
1019   }
1020 
1021   // Emit the result value, even if unused, to evalute the side effects.
1022   const Expr *RV = S.getRetValue();
1023 
1024   // Treat block literals in a return expression as if they appeared
1025   // in their own scope.  This permits a small, easily-implemented
1026   // exception to our over-conservative rules about not jumping to
1027   // statements following block literals with non-trivial cleanups.
1028   RunCleanupsScope cleanupScope(*this);
1029   if (const ExprWithCleanups *cleanups =
1030         dyn_cast_or_null<ExprWithCleanups>(RV)) {
1031     enterFullExpression(cleanups);
1032     RV = cleanups->getSubExpr();
1033   }
1034 
1035   // FIXME: Clean this up by using an LValue for ReturnTemp,
1036   // EmitStoreThroughLValue, and EmitAnyExpr.
1037   if (getLangOpts().ElideConstructors &&
1038       S.getNRVOCandidate() && S.getNRVOCandidate()->isNRVOVariable()) {
1039     // Apply the named return value optimization for this return statement,
1040     // which means doing nothing: the appropriate result has already been
1041     // constructed into the NRVO variable.
1042 
1043     // If there is an NRVO flag for this variable, set it to 1 into indicate
1044     // that the cleanup code should not destroy the variable.
1045     if (llvm::Value *NRVOFlag = NRVOFlags[S.getNRVOCandidate()])
1046       Builder.CreateFlagStore(Builder.getTrue(), NRVOFlag);
1047   } else if (!ReturnValue.isValid() || (RV && RV->getType()->isVoidType())) {
1048     // Make sure not to return anything, but evaluate the expression
1049     // for side effects.
1050     if (RV)
1051       EmitAnyExpr(RV);
1052   } else if (!RV) {
1053     // Do nothing (return value is left uninitialized)
1054   } else if (FnRetTy->isReferenceType()) {
1055     // If this function returns a reference, take the address of the expression
1056     // rather than the value.
1057     RValue Result = EmitReferenceBindingToExpr(RV);
1058     Builder.CreateStore(Result.getScalarVal(), ReturnValue);
1059   } else {
1060     switch (getEvaluationKind(RV->getType())) {
1061     case TEK_Scalar:
1062       Builder.CreateStore(EmitScalarExpr(RV), ReturnValue);
1063       break;
1064     case TEK_Complex:
1065       EmitComplexExprIntoLValue(RV, MakeAddrLValue(ReturnValue, RV->getType()),
1066                                 /*isInit*/ true);
1067       break;
1068     case TEK_Aggregate:
1069       EmitAggExpr(RV, AggValueSlot::forAddr(ReturnValue,
1070                                             Qualifiers(),
1071                                             AggValueSlot::IsDestructed,
1072                                             AggValueSlot::DoesNotNeedGCBarriers,
1073                                             AggValueSlot::IsNotAliased));
1074       break;
1075     }
1076   }
1077 
1078   ++NumReturnExprs;
1079   if (!RV || RV->isEvaluatable(getContext()))
1080     ++NumSimpleReturnExprs;
1081 
1082   cleanupScope.ForceCleanup();
1083   EmitBranchThroughCleanup(ReturnBlock);
1084 }
1085 
1086 void CodeGenFunction::EmitDeclStmt(const DeclStmt &S) {
1087   // As long as debug info is modeled with instructions, we have to ensure we
1088   // have a place to insert here and write the stop point here.
1089   if (HaveInsertPoint())
1090     EmitStopPoint(&S);
1091 
1092   for (const auto *I : S.decls())
1093     EmitDecl(*I);
1094 }
1095 
1096 void CodeGenFunction::EmitBreakStmt(const BreakStmt &S) {
1097   assert(!BreakContinueStack.empty() && "break stmt not in a loop or switch!");
1098 
1099   // If this code is reachable then emit a stop point (if generating
1100   // debug info). We have to do this ourselves because we are on the
1101   // "simple" statement path.
1102   if (HaveInsertPoint())
1103     EmitStopPoint(&S);
1104 
1105   EmitBranchThroughCleanup(BreakContinueStack.back().BreakBlock);
1106 }
1107 
1108 void CodeGenFunction::EmitContinueStmt(const ContinueStmt &S) {
1109   assert(!BreakContinueStack.empty() && "continue stmt not in a loop!");
1110 
1111   // If this code is reachable then emit a stop point (if generating
1112   // debug info). We have to do this ourselves because we are on the
1113   // "simple" statement path.
1114   if (HaveInsertPoint())
1115     EmitStopPoint(&S);
1116 
1117   EmitBranchThroughCleanup(BreakContinueStack.back().ContinueBlock);
1118 }
1119 
1120 /// EmitCaseStmtRange - If case statement range is not too big then
1121 /// add multiple cases to switch instruction, one for each value within
1122 /// the range. If range is too big then emit "if" condition check.
1123 void CodeGenFunction::EmitCaseStmtRange(const CaseStmt &S) {
1124   assert(S.getRHS() && "Expected RHS value in CaseStmt");
1125 
1126   llvm::APSInt LHS = S.getLHS()->EvaluateKnownConstInt(getContext());
1127   llvm::APSInt RHS = S.getRHS()->EvaluateKnownConstInt(getContext());
1128 
1129   // Emit the code for this case. We do this first to make sure it is
1130   // properly chained from our predecessor before generating the
1131   // switch machinery to enter this block.
1132   llvm::BasicBlock *CaseDest = createBasicBlock("sw.bb");
1133   EmitBlockWithFallThrough(CaseDest, &S);
1134   EmitStmt(S.getSubStmt());
1135 
1136   // If range is empty, do nothing.
1137   if (LHS.isSigned() ? RHS.slt(LHS) : RHS.ult(LHS))
1138     return;
1139 
1140   llvm::APInt Range = RHS - LHS;
1141   // FIXME: parameters such as this should not be hardcoded.
1142   if (Range.ult(llvm::APInt(Range.getBitWidth(), 64))) {
1143     // Range is small enough to add multiple switch instruction cases.
1144     uint64_t Total = getProfileCount(&S);
1145     unsigned NCases = Range.getZExtValue() + 1;
1146     // We only have one region counter for the entire set of cases here, so we
1147     // need to divide the weights evenly between the generated cases, ensuring
1148     // that the total weight is preserved. E.g., a weight of 5 over three cases
1149     // will be distributed as weights of 2, 2, and 1.
1150     uint64_t Weight = Total / NCases, Rem = Total % NCases;
1151     for (unsigned I = 0; I != NCases; ++I) {
1152       if (SwitchWeights)
1153         SwitchWeights->push_back(Weight + (Rem ? 1 : 0));
1154       if (Rem)
1155         Rem--;
1156       SwitchInsn->addCase(Builder.getInt(LHS), CaseDest);
1157       LHS++;
1158     }
1159     return;
1160   }
1161 
1162   // The range is too big. Emit "if" condition into a new block,
1163   // making sure to save and restore the current insertion point.
1164   llvm::BasicBlock *RestoreBB = Builder.GetInsertBlock();
1165 
1166   // Push this test onto the chain of range checks (which terminates
1167   // in the default basic block). The switch's default will be changed
1168   // to the top of this chain after switch emission is complete.
1169   llvm::BasicBlock *FalseDest = CaseRangeBlock;
1170   CaseRangeBlock = createBasicBlock("sw.caserange");
1171 
1172   CurFn->getBasicBlockList().push_back(CaseRangeBlock);
1173   Builder.SetInsertPoint(CaseRangeBlock);
1174 
1175   // Emit range check.
1176   llvm::Value *Diff =
1177     Builder.CreateSub(SwitchInsn->getCondition(), Builder.getInt(LHS));
1178   llvm::Value *Cond =
1179     Builder.CreateICmpULE(Diff, Builder.getInt(Range), "inbounds");
1180 
1181   llvm::MDNode *Weights = nullptr;
1182   if (SwitchWeights) {
1183     uint64_t ThisCount = getProfileCount(&S);
1184     uint64_t DefaultCount = (*SwitchWeights)[0];
1185     Weights = createProfileWeights(ThisCount, DefaultCount);
1186 
1187     // Since we're chaining the switch default through each large case range, we
1188     // need to update the weight for the default, ie, the first case, to include
1189     // this case.
1190     (*SwitchWeights)[0] += ThisCount;
1191   }
1192   Builder.CreateCondBr(Cond, CaseDest, FalseDest, Weights);
1193 
1194   // Restore the appropriate insertion point.
1195   if (RestoreBB)
1196     Builder.SetInsertPoint(RestoreBB);
1197   else
1198     Builder.ClearInsertionPoint();
1199 }
1200 
1201 void CodeGenFunction::EmitCaseStmt(const CaseStmt &S) {
1202   // If there is no enclosing switch instance that we're aware of, then this
1203   // case statement and its block can be elided.  This situation only happens
1204   // when we've constant-folded the switch, are emitting the constant case,
1205   // and part of the constant case includes another case statement.  For
1206   // instance: switch (4) { case 4: do { case 5: } while (1); }
1207   if (!SwitchInsn) {
1208     EmitStmt(S.getSubStmt());
1209     return;
1210   }
1211 
1212   // Handle case ranges.
1213   if (S.getRHS()) {
1214     EmitCaseStmtRange(S);
1215     return;
1216   }
1217 
1218   llvm::ConstantInt *CaseVal =
1219     Builder.getInt(S.getLHS()->EvaluateKnownConstInt(getContext()));
1220 
1221   // If the body of the case is just a 'break', try to not emit an empty block.
1222   // If we're profiling or we're not optimizing, leave the block in for better
1223   // debug and coverage analysis.
1224   if (!CGM.getCodeGenOpts().hasProfileClangInstr() &&
1225       CGM.getCodeGenOpts().OptimizationLevel > 0 &&
1226       isa<BreakStmt>(S.getSubStmt())) {
1227     JumpDest Block = BreakContinueStack.back().BreakBlock;
1228 
1229     // Only do this optimization if there are no cleanups that need emitting.
1230     if (isObviouslyBranchWithoutCleanups(Block)) {
1231       if (SwitchWeights)
1232         SwitchWeights->push_back(getProfileCount(&S));
1233       SwitchInsn->addCase(CaseVal, Block.getBlock());
1234 
1235       // If there was a fallthrough into this case, make sure to redirect it to
1236       // the end of the switch as well.
1237       if (Builder.GetInsertBlock()) {
1238         Builder.CreateBr(Block.getBlock());
1239         Builder.ClearInsertionPoint();
1240       }
1241       return;
1242     }
1243   }
1244 
1245   llvm::BasicBlock *CaseDest = createBasicBlock("sw.bb");
1246   EmitBlockWithFallThrough(CaseDest, &S);
1247   if (SwitchWeights)
1248     SwitchWeights->push_back(getProfileCount(&S));
1249   SwitchInsn->addCase(CaseVal, CaseDest);
1250 
1251   // Recursively emitting the statement is acceptable, but is not wonderful for
1252   // code where we have many case statements nested together, i.e.:
1253   //  case 1:
1254   //    case 2:
1255   //      case 3: etc.
1256   // Handling this recursively will create a new block for each case statement
1257   // that falls through to the next case which is IR intensive.  It also causes
1258   // deep recursion which can run into stack depth limitations.  Handle
1259   // sequential non-range case statements specially.
1260   const CaseStmt *CurCase = &S;
1261   const CaseStmt *NextCase = dyn_cast<CaseStmt>(S.getSubStmt());
1262 
1263   // Otherwise, iteratively add consecutive cases to this switch stmt.
1264   while (NextCase && NextCase->getRHS() == nullptr) {
1265     CurCase = NextCase;
1266     llvm::ConstantInt *CaseVal =
1267       Builder.getInt(CurCase->getLHS()->EvaluateKnownConstInt(getContext()));
1268 
1269     if (SwitchWeights)
1270       SwitchWeights->push_back(getProfileCount(NextCase));
1271     if (CGM.getCodeGenOpts().hasProfileClangInstr()) {
1272       CaseDest = createBasicBlock("sw.bb");
1273       EmitBlockWithFallThrough(CaseDest, &S);
1274     }
1275 
1276     SwitchInsn->addCase(CaseVal, CaseDest);
1277     NextCase = dyn_cast<CaseStmt>(CurCase->getSubStmt());
1278   }
1279 
1280   // Normal default recursion for non-cases.
1281   EmitStmt(CurCase->getSubStmt());
1282 }
1283 
1284 void CodeGenFunction::EmitDefaultStmt(const DefaultStmt &S) {
1285   // If there is no enclosing switch instance that we're aware of, then this
1286   // default statement can be elided. This situation only happens when we've
1287   // constant-folded the switch.
1288   if (!SwitchInsn) {
1289     EmitStmt(S.getSubStmt());
1290     return;
1291   }
1292 
1293   llvm::BasicBlock *DefaultBlock = SwitchInsn->getDefaultDest();
1294   assert(DefaultBlock->empty() &&
1295          "EmitDefaultStmt: Default block already defined?");
1296 
1297   EmitBlockWithFallThrough(DefaultBlock, &S);
1298 
1299   EmitStmt(S.getSubStmt());
1300 }
1301 
1302 /// CollectStatementsForCase - Given the body of a 'switch' statement and a
1303 /// constant value that is being switched on, see if we can dead code eliminate
1304 /// the body of the switch to a simple series of statements to emit.  Basically,
1305 /// on a switch (5) we want to find these statements:
1306 ///    case 5:
1307 ///      printf(...);    <--
1308 ///      ++i;            <--
1309 ///      break;
1310 ///
1311 /// and add them to the ResultStmts vector.  If it is unsafe to do this
1312 /// transformation (for example, one of the elided statements contains a label
1313 /// that might be jumped to), return CSFC_Failure.  If we handled it and 'S'
1314 /// should include statements after it (e.g. the printf() line is a substmt of
1315 /// the case) then return CSFC_FallThrough.  If we handled it and found a break
1316 /// statement, then return CSFC_Success.
1317 ///
1318 /// If Case is non-null, then we are looking for the specified case, checking
1319 /// that nothing we jump over contains labels.  If Case is null, then we found
1320 /// the case and are looking for the break.
1321 ///
1322 /// If the recursive walk actually finds our Case, then we set FoundCase to
1323 /// true.
1324 ///
1325 enum CSFC_Result { CSFC_Failure, CSFC_FallThrough, CSFC_Success };
1326 static CSFC_Result CollectStatementsForCase(const Stmt *S,
1327                                             const SwitchCase *Case,
1328                                             bool &FoundCase,
1329                               SmallVectorImpl<const Stmt*> &ResultStmts) {
1330   // If this is a null statement, just succeed.
1331   if (!S)
1332     return Case ? CSFC_Success : CSFC_FallThrough;
1333 
1334   // If this is the switchcase (case 4: or default) that we're looking for, then
1335   // we're in business.  Just add the substatement.
1336   if (const SwitchCase *SC = dyn_cast<SwitchCase>(S)) {
1337     if (S == Case) {
1338       FoundCase = true;
1339       return CollectStatementsForCase(SC->getSubStmt(), nullptr, FoundCase,
1340                                       ResultStmts);
1341     }
1342 
1343     // Otherwise, this is some other case or default statement, just ignore it.
1344     return CollectStatementsForCase(SC->getSubStmt(), Case, FoundCase,
1345                                     ResultStmts);
1346   }
1347 
1348   // If we are in the live part of the code and we found our break statement,
1349   // return a success!
1350   if (!Case && isa<BreakStmt>(S))
1351     return CSFC_Success;
1352 
1353   // If this is a switch statement, then it might contain the SwitchCase, the
1354   // break, or neither.
1355   if (const CompoundStmt *CS = dyn_cast<CompoundStmt>(S)) {
1356     // Handle this as two cases: we might be looking for the SwitchCase (if so
1357     // the skipped statements must be skippable) or we might already have it.
1358     CompoundStmt::const_body_iterator I = CS->body_begin(), E = CS->body_end();
1359     bool StartedInLiveCode = FoundCase;
1360     unsigned StartSize = ResultStmts.size();
1361 
1362     // If we've not found the case yet, scan through looking for it.
1363     if (Case) {
1364       // Keep track of whether we see a skipped declaration.  The code could be
1365       // using the declaration even if it is skipped, so we can't optimize out
1366       // the decl if the kept statements might refer to it.
1367       bool HadSkippedDecl = false;
1368 
1369       // If we're looking for the case, just see if we can skip each of the
1370       // substatements.
1371       for (; Case && I != E; ++I) {
1372         HadSkippedDecl |= CodeGenFunction::mightAddDeclToScope(*I);
1373 
1374         switch (CollectStatementsForCase(*I, Case, FoundCase, ResultStmts)) {
1375         case CSFC_Failure: return CSFC_Failure;
1376         case CSFC_Success:
1377           // A successful result means that either 1) that the statement doesn't
1378           // have the case and is skippable, or 2) does contain the case value
1379           // and also contains the break to exit the switch.  In the later case,
1380           // we just verify the rest of the statements are elidable.
1381           if (FoundCase) {
1382             // If we found the case and skipped declarations, we can't do the
1383             // optimization.
1384             if (HadSkippedDecl)
1385               return CSFC_Failure;
1386 
1387             for (++I; I != E; ++I)
1388               if (CodeGenFunction::ContainsLabel(*I, true))
1389                 return CSFC_Failure;
1390             return CSFC_Success;
1391           }
1392           break;
1393         case CSFC_FallThrough:
1394           // If we have a fallthrough condition, then we must have found the
1395           // case started to include statements.  Consider the rest of the
1396           // statements in the compound statement as candidates for inclusion.
1397           assert(FoundCase && "Didn't find case but returned fallthrough?");
1398           // We recursively found Case, so we're not looking for it anymore.
1399           Case = nullptr;
1400 
1401           // If we found the case and skipped declarations, we can't do the
1402           // optimization.
1403           if (HadSkippedDecl)
1404             return CSFC_Failure;
1405           break;
1406         }
1407       }
1408 
1409       if (!FoundCase)
1410         return CSFC_Success;
1411 
1412       assert(!HadSkippedDecl && "fallthrough after skipping decl");
1413     }
1414 
1415     // If we have statements in our range, then we know that the statements are
1416     // live and need to be added to the set of statements we're tracking.
1417     bool AnyDecls = false;
1418     for (; I != E; ++I) {
1419       AnyDecls |= CodeGenFunction::mightAddDeclToScope(*I);
1420 
1421       switch (CollectStatementsForCase(*I, nullptr, FoundCase, ResultStmts)) {
1422       case CSFC_Failure: return CSFC_Failure;
1423       case CSFC_FallThrough:
1424         // A fallthrough result means that the statement was simple and just
1425         // included in ResultStmt, keep adding them afterwards.
1426         break;
1427       case CSFC_Success:
1428         // A successful result means that we found the break statement and
1429         // stopped statement inclusion.  We just ensure that any leftover stmts
1430         // are skippable and return success ourselves.
1431         for (++I; I != E; ++I)
1432           if (CodeGenFunction::ContainsLabel(*I, true))
1433             return CSFC_Failure;
1434         return CSFC_Success;
1435       }
1436     }
1437 
1438     // If we're about to fall out of a scope without hitting a 'break;', we
1439     // can't perform the optimization if there were any decls in that scope
1440     // (we'd lose their end-of-lifetime).
1441     if (AnyDecls) {
1442       // If the entire compound statement was live, there's one more thing we
1443       // can try before giving up: emit the whole thing as a single statement.
1444       // We can do that unless the statement contains a 'break;'.
1445       // FIXME: Such a break must be at the end of a construct within this one.
1446       // We could emit this by just ignoring the BreakStmts entirely.
1447       if (StartedInLiveCode && !CodeGenFunction::containsBreak(S)) {
1448         ResultStmts.resize(StartSize);
1449         ResultStmts.push_back(S);
1450       } else {
1451         return CSFC_Failure;
1452       }
1453     }
1454 
1455     return CSFC_FallThrough;
1456   }
1457 
1458   // Okay, this is some other statement that we don't handle explicitly, like a
1459   // for statement or increment etc.  If we are skipping over this statement,
1460   // just verify it doesn't have labels, which would make it invalid to elide.
1461   if (Case) {
1462     if (CodeGenFunction::ContainsLabel(S, true))
1463       return CSFC_Failure;
1464     return CSFC_Success;
1465   }
1466 
1467   // Otherwise, we want to include this statement.  Everything is cool with that
1468   // so long as it doesn't contain a break out of the switch we're in.
1469   if (CodeGenFunction::containsBreak(S)) return CSFC_Failure;
1470 
1471   // Otherwise, everything is great.  Include the statement and tell the caller
1472   // that we fall through and include the next statement as well.
1473   ResultStmts.push_back(S);
1474   return CSFC_FallThrough;
1475 }
1476 
1477 /// FindCaseStatementsForValue - Find the case statement being jumped to and
1478 /// then invoke CollectStatementsForCase to find the list of statements to emit
1479 /// for a switch on constant.  See the comment above CollectStatementsForCase
1480 /// for more details.
1481 static bool FindCaseStatementsForValue(const SwitchStmt &S,
1482                                        const llvm::APSInt &ConstantCondValue,
1483                                 SmallVectorImpl<const Stmt*> &ResultStmts,
1484                                        ASTContext &C,
1485                                        const SwitchCase *&ResultCase) {
1486   // First step, find the switch case that is being branched to.  We can do this
1487   // efficiently by scanning the SwitchCase list.
1488   const SwitchCase *Case = S.getSwitchCaseList();
1489   const DefaultStmt *DefaultCase = nullptr;
1490 
1491   for (; Case; Case = Case->getNextSwitchCase()) {
1492     // It's either a default or case.  Just remember the default statement in
1493     // case we're not jumping to any numbered cases.
1494     if (const DefaultStmt *DS = dyn_cast<DefaultStmt>(Case)) {
1495       DefaultCase = DS;
1496       continue;
1497     }
1498 
1499     // Check to see if this case is the one we're looking for.
1500     const CaseStmt *CS = cast<CaseStmt>(Case);
1501     // Don't handle case ranges yet.
1502     if (CS->getRHS()) return false;
1503 
1504     // If we found our case, remember it as 'case'.
1505     if (CS->getLHS()->EvaluateKnownConstInt(C) == ConstantCondValue)
1506       break;
1507   }
1508 
1509   // If we didn't find a matching case, we use a default if it exists, or we
1510   // elide the whole switch body!
1511   if (!Case) {
1512     // It is safe to elide the body of the switch if it doesn't contain labels
1513     // etc.  If it is safe, return successfully with an empty ResultStmts list.
1514     if (!DefaultCase)
1515       return !CodeGenFunction::ContainsLabel(&S);
1516     Case = DefaultCase;
1517   }
1518 
1519   // Ok, we know which case is being jumped to, try to collect all the
1520   // statements that follow it.  This can fail for a variety of reasons.  Also,
1521   // check to see that the recursive walk actually found our case statement.
1522   // Insane cases like this can fail to find it in the recursive walk since we
1523   // don't handle every stmt kind:
1524   // switch (4) {
1525   //   while (1) {
1526   //     case 4: ...
1527   bool FoundCase = false;
1528   ResultCase = Case;
1529   return CollectStatementsForCase(S.getBody(), Case, FoundCase,
1530                                   ResultStmts) != CSFC_Failure &&
1531          FoundCase;
1532 }
1533 
1534 void CodeGenFunction::EmitSwitchStmt(const SwitchStmt &S) {
1535   // Handle nested switch statements.
1536   llvm::SwitchInst *SavedSwitchInsn = SwitchInsn;
1537   SmallVector<uint64_t, 16> *SavedSwitchWeights = SwitchWeights;
1538   llvm::BasicBlock *SavedCRBlock = CaseRangeBlock;
1539 
1540   // See if we can constant fold the condition of the switch and therefore only
1541   // emit the live case statement (if any) of the switch.
1542   llvm::APSInt ConstantCondValue;
1543   if (ConstantFoldsToSimpleInteger(S.getCond(), ConstantCondValue)) {
1544     SmallVector<const Stmt*, 4> CaseStmts;
1545     const SwitchCase *Case = nullptr;
1546     if (FindCaseStatementsForValue(S, ConstantCondValue, CaseStmts,
1547                                    getContext(), Case)) {
1548       if (Case)
1549         incrementProfileCounter(Case);
1550       RunCleanupsScope ExecutedScope(*this);
1551 
1552       if (S.getInit())
1553         EmitStmt(S.getInit());
1554 
1555       // Emit the condition variable if needed inside the entire cleanup scope
1556       // used by this special case for constant folded switches.
1557       if (S.getConditionVariable())
1558         EmitAutoVarDecl(*S.getConditionVariable());
1559 
1560       // At this point, we are no longer "within" a switch instance, so
1561       // we can temporarily enforce this to ensure that any embedded case
1562       // statements are not emitted.
1563       SwitchInsn = nullptr;
1564 
1565       // Okay, we can dead code eliminate everything except this case.  Emit the
1566       // specified series of statements and we're good.
1567       for (unsigned i = 0, e = CaseStmts.size(); i != e; ++i)
1568         EmitStmt(CaseStmts[i]);
1569       incrementProfileCounter(&S);
1570 
1571       // Now we want to restore the saved switch instance so that nested
1572       // switches continue to function properly
1573       SwitchInsn = SavedSwitchInsn;
1574 
1575       return;
1576     }
1577   }
1578 
1579   JumpDest SwitchExit = getJumpDestInCurrentScope("sw.epilog");
1580 
1581   RunCleanupsScope ConditionScope(*this);
1582 
1583   if (S.getInit())
1584     EmitStmt(S.getInit());
1585 
1586   if (S.getConditionVariable())
1587     EmitAutoVarDecl(*S.getConditionVariable());
1588   llvm::Value *CondV = EmitScalarExpr(S.getCond());
1589 
1590   // Create basic block to hold stuff that comes after switch
1591   // statement. We also need to create a default block now so that
1592   // explicit case ranges tests can have a place to jump to on
1593   // failure.
1594   llvm::BasicBlock *DefaultBlock = createBasicBlock("sw.default");
1595   SwitchInsn = Builder.CreateSwitch(CondV, DefaultBlock);
1596   if (PGO.haveRegionCounts()) {
1597     // Walk the SwitchCase list to find how many there are.
1598     uint64_t DefaultCount = 0;
1599     unsigned NumCases = 0;
1600     for (const SwitchCase *Case = S.getSwitchCaseList();
1601          Case;
1602          Case = Case->getNextSwitchCase()) {
1603       if (isa<DefaultStmt>(Case))
1604         DefaultCount = getProfileCount(Case);
1605       NumCases += 1;
1606     }
1607     SwitchWeights = new SmallVector<uint64_t, 16>();
1608     SwitchWeights->reserve(NumCases);
1609     // The default needs to be first. We store the edge count, so we already
1610     // know the right weight.
1611     SwitchWeights->push_back(DefaultCount);
1612   }
1613   CaseRangeBlock = DefaultBlock;
1614 
1615   // Clear the insertion point to indicate we are in unreachable code.
1616   Builder.ClearInsertionPoint();
1617 
1618   // All break statements jump to NextBlock. If BreakContinueStack is non-empty
1619   // then reuse last ContinueBlock.
1620   JumpDest OuterContinue;
1621   if (!BreakContinueStack.empty())
1622     OuterContinue = BreakContinueStack.back().ContinueBlock;
1623 
1624   BreakContinueStack.push_back(BreakContinue(SwitchExit, OuterContinue));
1625 
1626   // Emit switch body.
1627   EmitStmt(S.getBody());
1628 
1629   BreakContinueStack.pop_back();
1630 
1631   // Update the default block in case explicit case range tests have
1632   // been chained on top.
1633   SwitchInsn->setDefaultDest(CaseRangeBlock);
1634 
1635   // If a default was never emitted:
1636   if (!DefaultBlock->getParent()) {
1637     // If we have cleanups, emit the default block so that there's a
1638     // place to jump through the cleanups from.
1639     if (ConditionScope.requiresCleanups()) {
1640       EmitBlock(DefaultBlock);
1641 
1642     // Otherwise, just forward the default block to the switch end.
1643     } else {
1644       DefaultBlock->replaceAllUsesWith(SwitchExit.getBlock());
1645       delete DefaultBlock;
1646     }
1647   }
1648 
1649   ConditionScope.ForceCleanup();
1650 
1651   // Emit continuation.
1652   EmitBlock(SwitchExit.getBlock(), true);
1653   incrementProfileCounter(&S);
1654 
1655   // If the switch has a condition wrapped by __builtin_unpredictable,
1656   // create metadata that specifies that the switch is unpredictable.
1657   // Don't bother if not optimizing because that metadata would not be used.
1658   auto *Call = dyn_cast<CallExpr>(S.getCond());
1659   if (Call && CGM.getCodeGenOpts().OptimizationLevel != 0) {
1660     auto *FD = dyn_cast_or_null<FunctionDecl>(Call->getCalleeDecl());
1661     if (FD && FD->getBuiltinID() == Builtin::BI__builtin_unpredictable) {
1662       llvm::MDBuilder MDHelper(getLLVMContext());
1663       SwitchInsn->setMetadata(llvm::LLVMContext::MD_unpredictable,
1664                               MDHelper.createUnpredictable());
1665     }
1666   }
1667 
1668   if (SwitchWeights) {
1669     assert(SwitchWeights->size() == 1 + SwitchInsn->getNumCases() &&
1670            "switch weights do not match switch cases");
1671     // If there's only one jump destination there's no sense weighting it.
1672     if (SwitchWeights->size() > 1)
1673       SwitchInsn->setMetadata(llvm::LLVMContext::MD_prof,
1674                               createProfileWeights(*SwitchWeights));
1675     delete SwitchWeights;
1676   }
1677   SwitchInsn = SavedSwitchInsn;
1678   SwitchWeights = SavedSwitchWeights;
1679   CaseRangeBlock = SavedCRBlock;
1680 }
1681 
1682 static std::string
1683 SimplifyConstraint(const char *Constraint, const TargetInfo &Target,
1684                  SmallVectorImpl<TargetInfo::ConstraintInfo> *OutCons=nullptr) {
1685   std::string Result;
1686 
1687   while (*Constraint) {
1688     switch (*Constraint) {
1689     default:
1690       Result += Target.convertConstraint(Constraint);
1691       break;
1692     // Ignore these
1693     case '*':
1694     case '?':
1695     case '!':
1696     case '=': // Will see this and the following in mult-alt constraints.
1697     case '+':
1698       break;
1699     case '#': // Ignore the rest of the constraint alternative.
1700       while (Constraint[1] && Constraint[1] != ',')
1701         Constraint++;
1702       break;
1703     case '&':
1704     case '%':
1705       Result += *Constraint;
1706       while (Constraint[1] && Constraint[1] == *Constraint)
1707         Constraint++;
1708       break;
1709     case ',':
1710       Result += "|";
1711       break;
1712     case 'g':
1713       Result += "imr";
1714       break;
1715     case '[': {
1716       assert(OutCons &&
1717              "Must pass output names to constraints with a symbolic name");
1718       unsigned Index;
1719       bool result = Target.resolveSymbolicName(Constraint, *OutCons, Index);
1720       assert(result && "Could not resolve symbolic name"); (void)result;
1721       Result += llvm::utostr(Index);
1722       break;
1723     }
1724     }
1725 
1726     Constraint++;
1727   }
1728 
1729   return Result;
1730 }
1731 
1732 /// AddVariableConstraints - Look at AsmExpr and if it is a variable declared
1733 /// as using a particular register add that as a constraint that will be used
1734 /// in this asm stmt.
1735 static std::string
1736 AddVariableConstraints(const std::string &Constraint, const Expr &AsmExpr,
1737                        const TargetInfo &Target, CodeGenModule &CGM,
1738                        const AsmStmt &Stmt, const bool EarlyClobber) {
1739   const DeclRefExpr *AsmDeclRef = dyn_cast<DeclRefExpr>(&AsmExpr);
1740   if (!AsmDeclRef)
1741     return Constraint;
1742   const ValueDecl &Value = *AsmDeclRef->getDecl();
1743   const VarDecl *Variable = dyn_cast<VarDecl>(&Value);
1744   if (!Variable)
1745     return Constraint;
1746   if (Variable->getStorageClass() != SC_Register)
1747     return Constraint;
1748   AsmLabelAttr *Attr = Variable->getAttr<AsmLabelAttr>();
1749   if (!Attr)
1750     return Constraint;
1751   StringRef Register = Attr->getLabel();
1752   assert(Target.isValidGCCRegisterName(Register));
1753   // We're using validateOutputConstraint here because we only care if
1754   // this is a register constraint.
1755   TargetInfo::ConstraintInfo Info(Constraint, "");
1756   if (Target.validateOutputConstraint(Info) &&
1757       !Info.allowsRegister()) {
1758     CGM.ErrorUnsupported(&Stmt, "__asm__");
1759     return Constraint;
1760   }
1761   // Canonicalize the register here before returning it.
1762   Register = Target.getNormalizedGCCRegisterName(Register);
1763   return (EarlyClobber ? "&{" : "{") + Register.str() + "}";
1764 }
1765 
1766 llvm::Value*
1767 CodeGenFunction::EmitAsmInputLValue(const TargetInfo::ConstraintInfo &Info,
1768                                     LValue InputValue, QualType InputType,
1769                                     std::string &ConstraintStr,
1770                                     SourceLocation Loc) {
1771   llvm::Value *Arg;
1772   if (Info.allowsRegister() || !Info.allowsMemory()) {
1773     if (CodeGenFunction::hasScalarEvaluationKind(InputType)) {
1774       Arg = EmitLoadOfLValue(InputValue, Loc).getScalarVal();
1775     } else {
1776       llvm::Type *Ty = ConvertType(InputType);
1777       uint64_t Size = CGM.getDataLayout().getTypeSizeInBits(Ty);
1778       if (Size <= 64 && llvm::isPowerOf2_64(Size)) {
1779         Ty = llvm::IntegerType::get(getLLVMContext(), Size);
1780         Ty = llvm::PointerType::getUnqual(Ty);
1781 
1782         Arg = Builder.CreateLoad(Builder.CreateBitCast(InputValue.getAddress(),
1783                                                        Ty));
1784       } else {
1785         Arg = InputValue.getPointer();
1786         ConstraintStr += '*';
1787       }
1788     }
1789   } else {
1790     Arg = InputValue.getPointer();
1791     ConstraintStr += '*';
1792   }
1793 
1794   return Arg;
1795 }
1796 
1797 llvm::Value* CodeGenFunction::EmitAsmInput(
1798                                          const TargetInfo::ConstraintInfo &Info,
1799                                            const Expr *InputExpr,
1800                                            std::string &ConstraintStr) {
1801   // If this can't be a register or memory, i.e., has to be a constant
1802   // (immediate or symbolic), try to emit it as such.
1803   if (!Info.allowsRegister() && !Info.allowsMemory()) {
1804     llvm::APSInt Result;
1805     if (InputExpr->EvaluateAsInt(Result, getContext()))
1806       return llvm::ConstantInt::get(getLLVMContext(), Result);
1807     assert(!Info.requiresImmediateConstant() &&
1808            "Required-immediate inlineasm arg isn't constant?");
1809   }
1810 
1811   if (Info.allowsRegister() || !Info.allowsMemory())
1812     if (CodeGenFunction::hasScalarEvaluationKind(InputExpr->getType()))
1813       return EmitScalarExpr(InputExpr);
1814   if (InputExpr->getStmtClass() == Expr::CXXThisExprClass)
1815     return EmitScalarExpr(InputExpr);
1816   InputExpr = InputExpr->IgnoreParenNoopCasts(getContext());
1817   LValue Dest = EmitLValue(InputExpr);
1818   return EmitAsmInputLValue(Info, Dest, InputExpr->getType(), ConstraintStr,
1819                             InputExpr->getExprLoc());
1820 }
1821 
1822 /// getAsmSrcLocInfo - Return the !srcloc metadata node to attach to an inline
1823 /// asm call instruction.  The !srcloc MDNode contains a list of constant
1824 /// integers which are the source locations of the start of each line in the
1825 /// asm.
1826 static llvm::MDNode *getAsmSrcLocInfo(const StringLiteral *Str,
1827                                       CodeGenFunction &CGF) {
1828   SmallVector<llvm::Metadata *, 8> Locs;
1829   // Add the location of the first line to the MDNode.
1830   Locs.push_back(llvm::ConstantAsMetadata::get(llvm::ConstantInt::get(
1831       CGF.Int32Ty, Str->getLocStart().getRawEncoding())));
1832   StringRef StrVal = Str->getString();
1833   if (!StrVal.empty()) {
1834     const SourceManager &SM = CGF.CGM.getContext().getSourceManager();
1835     const LangOptions &LangOpts = CGF.CGM.getLangOpts();
1836     unsigned StartToken = 0;
1837     unsigned ByteOffset = 0;
1838 
1839     // Add the location of the start of each subsequent line of the asm to the
1840     // MDNode.
1841     for (unsigned i = 0, e = StrVal.size() - 1; i != e; ++i) {
1842       if (StrVal[i] != '\n') continue;
1843       SourceLocation LineLoc = Str->getLocationOfByte(
1844           i + 1, SM, LangOpts, CGF.getTarget(), &StartToken, &ByteOffset);
1845       Locs.push_back(llvm::ConstantAsMetadata::get(
1846           llvm::ConstantInt::get(CGF.Int32Ty, LineLoc.getRawEncoding())));
1847     }
1848   }
1849 
1850   return llvm::MDNode::get(CGF.getLLVMContext(), Locs);
1851 }
1852 
1853 void CodeGenFunction::EmitAsmStmt(const AsmStmt &S) {
1854   // Assemble the final asm string.
1855   std::string AsmString = S.generateAsmString(getContext());
1856 
1857   // Get all the output and input constraints together.
1858   SmallVector<TargetInfo::ConstraintInfo, 4> OutputConstraintInfos;
1859   SmallVector<TargetInfo::ConstraintInfo, 4> InputConstraintInfos;
1860 
1861   for (unsigned i = 0, e = S.getNumOutputs(); i != e; i++) {
1862     StringRef Name;
1863     if (const GCCAsmStmt *GAS = dyn_cast<GCCAsmStmt>(&S))
1864       Name = GAS->getOutputName(i);
1865     TargetInfo::ConstraintInfo Info(S.getOutputConstraint(i), Name);
1866     bool IsValid = getTarget().validateOutputConstraint(Info); (void)IsValid;
1867     assert(IsValid && "Failed to parse output constraint");
1868     OutputConstraintInfos.push_back(Info);
1869   }
1870 
1871   for (unsigned i = 0, e = S.getNumInputs(); i != e; i++) {
1872     StringRef Name;
1873     if (const GCCAsmStmt *GAS = dyn_cast<GCCAsmStmt>(&S))
1874       Name = GAS->getInputName(i);
1875     TargetInfo::ConstraintInfo Info(S.getInputConstraint(i), Name);
1876     bool IsValid =
1877       getTarget().validateInputConstraint(OutputConstraintInfos, Info);
1878     assert(IsValid && "Failed to parse input constraint"); (void)IsValid;
1879     InputConstraintInfos.push_back(Info);
1880   }
1881 
1882   std::string Constraints;
1883 
1884   std::vector<LValue> ResultRegDests;
1885   std::vector<QualType> ResultRegQualTys;
1886   std::vector<llvm::Type *> ResultRegTypes;
1887   std::vector<llvm::Type *> ResultTruncRegTypes;
1888   std::vector<llvm::Type *> ArgTypes;
1889   std::vector<llvm::Value*> Args;
1890 
1891   // Keep track of inout constraints.
1892   std::string InOutConstraints;
1893   std::vector<llvm::Value*> InOutArgs;
1894   std::vector<llvm::Type*> InOutArgTypes;
1895 
1896   // An inline asm can be marked readonly if it meets the following conditions:
1897   //  - it doesn't have any sideeffects
1898   //  - it doesn't clobber memory
1899   //  - it doesn't return a value by-reference
1900   // It can be marked readnone if it doesn't have any input memory constraints
1901   // in addition to meeting the conditions listed above.
1902   bool ReadOnly = true, ReadNone = true;
1903 
1904   for (unsigned i = 0, e = S.getNumOutputs(); i != e; i++) {
1905     TargetInfo::ConstraintInfo &Info = OutputConstraintInfos[i];
1906 
1907     // Simplify the output constraint.
1908     std::string OutputConstraint(S.getOutputConstraint(i));
1909     OutputConstraint = SimplifyConstraint(OutputConstraint.c_str() + 1,
1910                                           getTarget());
1911 
1912     const Expr *OutExpr = S.getOutputExpr(i);
1913     OutExpr = OutExpr->IgnoreParenNoopCasts(getContext());
1914 
1915     OutputConstraint = AddVariableConstraints(OutputConstraint, *OutExpr,
1916                                               getTarget(), CGM, S,
1917                                               Info.earlyClobber());
1918 
1919     LValue Dest = EmitLValue(OutExpr);
1920     if (!Constraints.empty())
1921       Constraints += ',';
1922 
1923     // If this is a register output, then make the inline asm return it
1924     // by-value.  If this is a memory result, return the value by-reference.
1925     if (!Info.allowsMemory() && hasScalarEvaluationKind(OutExpr->getType())) {
1926       Constraints += "=" + OutputConstraint;
1927       ResultRegQualTys.push_back(OutExpr->getType());
1928       ResultRegDests.push_back(Dest);
1929       ResultRegTypes.push_back(ConvertTypeForMem(OutExpr->getType()));
1930       ResultTruncRegTypes.push_back(ResultRegTypes.back());
1931 
1932       // If this output is tied to an input, and if the input is larger, then
1933       // we need to set the actual result type of the inline asm node to be the
1934       // same as the input type.
1935       if (Info.hasMatchingInput()) {
1936         unsigned InputNo;
1937         for (InputNo = 0; InputNo != S.getNumInputs(); ++InputNo) {
1938           TargetInfo::ConstraintInfo &Input = InputConstraintInfos[InputNo];
1939           if (Input.hasTiedOperand() && Input.getTiedOperand() == i)
1940             break;
1941         }
1942         assert(InputNo != S.getNumInputs() && "Didn't find matching input!");
1943 
1944         QualType InputTy = S.getInputExpr(InputNo)->getType();
1945         QualType OutputType = OutExpr->getType();
1946 
1947         uint64_t InputSize = getContext().getTypeSize(InputTy);
1948         if (getContext().getTypeSize(OutputType) < InputSize) {
1949           // Form the asm to return the value as a larger integer or fp type.
1950           ResultRegTypes.back() = ConvertType(InputTy);
1951         }
1952       }
1953       if (llvm::Type* AdjTy =
1954             getTargetHooks().adjustInlineAsmType(*this, OutputConstraint,
1955                                                  ResultRegTypes.back()))
1956         ResultRegTypes.back() = AdjTy;
1957       else {
1958         CGM.getDiags().Report(S.getAsmLoc(),
1959                               diag::err_asm_invalid_type_in_input)
1960             << OutExpr->getType() << OutputConstraint;
1961       }
1962     } else {
1963       ArgTypes.push_back(Dest.getAddress().getType());
1964       Args.push_back(Dest.getPointer());
1965       Constraints += "=*";
1966       Constraints += OutputConstraint;
1967       ReadOnly = ReadNone = false;
1968     }
1969 
1970     if (Info.isReadWrite()) {
1971       InOutConstraints += ',';
1972 
1973       const Expr *InputExpr = S.getOutputExpr(i);
1974       llvm::Value *Arg = EmitAsmInputLValue(Info, Dest, InputExpr->getType(),
1975                                             InOutConstraints,
1976                                             InputExpr->getExprLoc());
1977 
1978       if (llvm::Type* AdjTy =
1979           getTargetHooks().adjustInlineAsmType(*this, OutputConstraint,
1980                                                Arg->getType()))
1981         Arg = Builder.CreateBitCast(Arg, AdjTy);
1982 
1983       if (Info.allowsRegister())
1984         InOutConstraints += llvm::utostr(i);
1985       else
1986         InOutConstraints += OutputConstraint;
1987 
1988       InOutArgTypes.push_back(Arg->getType());
1989       InOutArgs.push_back(Arg);
1990     }
1991   }
1992 
1993   // If this is a Microsoft-style asm blob, store the return registers (EAX:EDX)
1994   // to the return value slot. Only do this when returning in registers.
1995   if (isa<MSAsmStmt>(&S)) {
1996     const ABIArgInfo &RetAI = CurFnInfo->getReturnInfo();
1997     if (RetAI.isDirect() || RetAI.isExtend()) {
1998       // Make a fake lvalue for the return value slot.
1999       LValue ReturnSlot = MakeAddrLValue(ReturnValue, FnRetTy);
2000       CGM.getTargetCodeGenInfo().addReturnRegisterOutputs(
2001           *this, ReturnSlot, Constraints, ResultRegTypes, ResultTruncRegTypes,
2002           ResultRegDests, AsmString, S.getNumOutputs());
2003       SawAsmBlock = true;
2004     }
2005   }
2006 
2007   for (unsigned i = 0, e = S.getNumInputs(); i != e; i++) {
2008     const Expr *InputExpr = S.getInputExpr(i);
2009 
2010     TargetInfo::ConstraintInfo &Info = InputConstraintInfos[i];
2011 
2012     if (Info.allowsMemory())
2013       ReadNone = false;
2014 
2015     if (!Constraints.empty())
2016       Constraints += ',';
2017 
2018     // Simplify the input constraint.
2019     std::string InputConstraint(S.getInputConstraint(i));
2020     InputConstraint = SimplifyConstraint(InputConstraint.c_str(), getTarget(),
2021                                          &OutputConstraintInfos);
2022 
2023     InputConstraint = AddVariableConstraints(
2024         InputConstraint, *InputExpr->IgnoreParenNoopCasts(getContext()),
2025         getTarget(), CGM, S, false /* No EarlyClobber */);
2026 
2027     llvm::Value *Arg = EmitAsmInput(Info, InputExpr, Constraints);
2028 
2029     // If this input argument is tied to a larger output result, extend the
2030     // input to be the same size as the output.  The LLVM backend wants to see
2031     // the input and output of a matching constraint be the same size.  Note
2032     // that GCC does not define what the top bits are here.  We use zext because
2033     // that is usually cheaper, but LLVM IR should really get an anyext someday.
2034     if (Info.hasTiedOperand()) {
2035       unsigned Output = Info.getTiedOperand();
2036       QualType OutputType = S.getOutputExpr(Output)->getType();
2037       QualType InputTy = InputExpr->getType();
2038 
2039       if (getContext().getTypeSize(OutputType) >
2040           getContext().getTypeSize(InputTy)) {
2041         // Use ptrtoint as appropriate so that we can do our extension.
2042         if (isa<llvm::PointerType>(Arg->getType()))
2043           Arg = Builder.CreatePtrToInt(Arg, IntPtrTy);
2044         llvm::Type *OutputTy = ConvertType(OutputType);
2045         if (isa<llvm::IntegerType>(OutputTy))
2046           Arg = Builder.CreateZExt(Arg, OutputTy);
2047         else if (isa<llvm::PointerType>(OutputTy))
2048           Arg = Builder.CreateZExt(Arg, IntPtrTy);
2049         else {
2050           assert(OutputTy->isFloatingPointTy() && "Unexpected output type");
2051           Arg = Builder.CreateFPExt(Arg, OutputTy);
2052         }
2053       }
2054     }
2055     if (llvm::Type* AdjTy =
2056               getTargetHooks().adjustInlineAsmType(*this, InputConstraint,
2057                                                    Arg->getType()))
2058       Arg = Builder.CreateBitCast(Arg, AdjTy);
2059     else
2060       CGM.getDiags().Report(S.getAsmLoc(), diag::err_asm_invalid_type_in_input)
2061           << InputExpr->getType() << InputConstraint;
2062 
2063     ArgTypes.push_back(Arg->getType());
2064     Args.push_back(Arg);
2065     Constraints += InputConstraint;
2066   }
2067 
2068   // Append the "input" part of inout constraints last.
2069   for (unsigned i = 0, e = InOutArgs.size(); i != e; i++) {
2070     ArgTypes.push_back(InOutArgTypes[i]);
2071     Args.push_back(InOutArgs[i]);
2072   }
2073   Constraints += InOutConstraints;
2074 
2075   // Clobbers
2076   for (unsigned i = 0, e = S.getNumClobbers(); i != e; i++) {
2077     StringRef Clobber = S.getClobber(i);
2078 
2079     if (Clobber == "memory")
2080       ReadOnly = ReadNone = false;
2081     else if (Clobber != "cc")
2082       Clobber = getTarget().getNormalizedGCCRegisterName(Clobber);
2083 
2084     if (!Constraints.empty())
2085       Constraints += ',';
2086 
2087     Constraints += "~{";
2088     Constraints += Clobber;
2089     Constraints += '}';
2090   }
2091 
2092   // Add machine specific clobbers
2093   std::string MachineClobbers = getTarget().getClobbers();
2094   if (!MachineClobbers.empty()) {
2095     if (!Constraints.empty())
2096       Constraints += ',';
2097     Constraints += MachineClobbers;
2098   }
2099 
2100   llvm::Type *ResultType;
2101   if (ResultRegTypes.empty())
2102     ResultType = VoidTy;
2103   else if (ResultRegTypes.size() == 1)
2104     ResultType = ResultRegTypes[0];
2105   else
2106     ResultType = llvm::StructType::get(getLLVMContext(), ResultRegTypes);
2107 
2108   llvm::FunctionType *FTy =
2109     llvm::FunctionType::get(ResultType, ArgTypes, false);
2110 
2111   bool HasSideEffect = S.isVolatile() || S.getNumOutputs() == 0;
2112   llvm::InlineAsm::AsmDialect AsmDialect = isa<MSAsmStmt>(&S) ?
2113     llvm::InlineAsm::AD_Intel : llvm::InlineAsm::AD_ATT;
2114   llvm::InlineAsm *IA =
2115     llvm::InlineAsm::get(FTy, AsmString, Constraints, HasSideEffect,
2116                          /* IsAlignStack */ false, AsmDialect);
2117   llvm::CallInst *Result = Builder.CreateCall(IA, Args);
2118   Result->addAttribute(llvm::AttributeSet::FunctionIndex,
2119                        llvm::Attribute::NoUnwind);
2120 
2121   // Attach readnone and readonly attributes.
2122   if (!HasSideEffect) {
2123     if (ReadNone)
2124       Result->addAttribute(llvm::AttributeSet::FunctionIndex,
2125                            llvm::Attribute::ReadNone);
2126     else if (ReadOnly)
2127       Result->addAttribute(llvm::AttributeSet::FunctionIndex,
2128                            llvm::Attribute::ReadOnly);
2129   }
2130 
2131   // Slap the source location of the inline asm into a !srcloc metadata on the
2132   // call.
2133   if (const GCCAsmStmt *gccAsmStmt = dyn_cast<GCCAsmStmt>(&S)) {
2134     Result->setMetadata("srcloc", getAsmSrcLocInfo(gccAsmStmt->getAsmString(),
2135                                                    *this));
2136   } else {
2137     // At least put the line number on MS inline asm blobs.
2138     auto Loc = llvm::ConstantInt::get(Int32Ty, S.getAsmLoc().getRawEncoding());
2139     Result->setMetadata("srcloc",
2140                         llvm::MDNode::get(getLLVMContext(),
2141                                           llvm::ConstantAsMetadata::get(Loc)));
2142   }
2143 
2144   if (getLangOpts().CUDA && getLangOpts().CUDAIsDevice) {
2145     // Conservatively, mark all inline asm blocks in CUDA as convergent
2146     // (meaning, they may call an intrinsically convergent op, such as bar.sync,
2147     // and so can't have certain optimizations applied around them).
2148     Result->addAttribute(llvm::AttributeSet::FunctionIndex,
2149                          llvm::Attribute::Convergent);
2150   }
2151 
2152   // Extract all of the register value results from the asm.
2153   std::vector<llvm::Value*> RegResults;
2154   if (ResultRegTypes.size() == 1) {
2155     RegResults.push_back(Result);
2156   } else {
2157     for (unsigned i = 0, e = ResultRegTypes.size(); i != e; ++i) {
2158       llvm::Value *Tmp = Builder.CreateExtractValue(Result, i, "asmresult");
2159       RegResults.push_back(Tmp);
2160     }
2161   }
2162 
2163   assert(RegResults.size() == ResultRegTypes.size());
2164   assert(RegResults.size() == ResultTruncRegTypes.size());
2165   assert(RegResults.size() == ResultRegDests.size());
2166   for (unsigned i = 0, e = RegResults.size(); i != e; ++i) {
2167     llvm::Value *Tmp = RegResults[i];
2168 
2169     // If the result type of the LLVM IR asm doesn't match the result type of
2170     // the expression, do the conversion.
2171     if (ResultRegTypes[i] != ResultTruncRegTypes[i]) {
2172       llvm::Type *TruncTy = ResultTruncRegTypes[i];
2173 
2174       // Truncate the integer result to the right size, note that TruncTy can be
2175       // a pointer.
2176       if (TruncTy->isFloatingPointTy())
2177         Tmp = Builder.CreateFPTrunc(Tmp, TruncTy);
2178       else if (TruncTy->isPointerTy() && Tmp->getType()->isIntegerTy()) {
2179         uint64_t ResSize = CGM.getDataLayout().getTypeSizeInBits(TruncTy);
2180         Tmp = Builder.CreateTrunc(Tmp,
2181                    llvm::IntegerType::get(getLLVMContext(), (unsigned)ResSize));
2182         Tmp = Builder.CreateIntToPtr(Tmp, TruncTy);
2183       } else if (Tmp->getType()->isPointerTy() && TruncTy->isIntegerTy()) {
2184         uint64_t TmpSize =CGM.getDataLayout().getTypeSizeInBits(Tmp->getType());
2185         Tmp = Builder.CreatePtrToInt(Tmp,
2186                    llvm::IntegerType::get(getLLVMContext(), (unsigned)TmpSize));
2187         Tmp = Builder.CreateTrunc(Tmp, TruncTy);
2188       } else if (TruncTy->isIntegerTy()) {
2189         Tmp = Builder.CreateTrunc(Tmp, TruncTy);
2190       } else if (TruncTy->isVectorTy()) {
2191         Tmp = Builder.CreateBitCast(Tmp, TruncTy);
2192       }
2193     }
2194 
2195     EmitStoreThroughLValue(RValue::get(Tmp), ResultRegDests[i]);
2196   }
2197 }
2198 
2199 LValue CodeGenFunction::InitCapturedStruct(const CapturedStmt &S) {
2200   const RecordDecl *RD = S.getCapturedRecordDecl();
2201   QualType RecordTy = getContext().getRecordType(RD);
2202 
2203   // Initialize the captured struct.
2204   LValue SlotLV =
2205     MakeAddrLValue(CreateMemTemp(RecordTy, "agg.captured"), RecordTy);
2206 
2207   RecordDecl::field_iterator CurField = RD->field_begin();
2208   for (CapturedStmt::const_capture_init_iterator I = S.capture_init_begin(),
2209                                                  E = S.capture_init_end();
2210        I != E; ++I, ++CurField) {
2211     LValue LV = EmitLValueForFieldInitialization(SlotLV, *CurField);
2212     if (CurField->hasCapturedVLAType()) {
2213       auto VAT = CurField->getCapturedVLAType();
2214       EmitStoreThroughLValue(RValue::get(VLASizeMap[VAT->getSizeExpr()]), LV);
2215     } else {
2216       EmitInitializerForField(*CurField, LV, *I);
2217     }
2218   }
2219 
2220   return SlotLV;
2221 }
2222 
2223 /// Generate an outlined function for the body of a CapturedStmt, store any
2224 /// captured variables into the captured struct, and call the outlined function.
2225 llvm::Function *
2226 CodeGenFunction::EmitCapturedStmt(const CapturedStmt &S, CapturedRegionKind K) {
2227   LValue CapStruct = InitCapturedStruct(S);
2228 
2229   // Emit the CapturedDecl
2230   CodeGenFunction CGF(CGM, true);
2231   CGCapturedStmtRAII CapInfoRAII(CGF, new CGCapturedStmtInfo(S, K));
2232   llvm::Function *F = CGF.GenerateCapturedStmtFunction(S);
2233   delete CGF.CapturedStmtInfo;
2234 
2235   // Emit call to the helper function.
2236   EmitCallOrInvoke(F, CapStruct.getPointer());
2237 
2238   return F;
2239 }
2240 
2241 Address CodeGenFunction::GenerateCapturedStmtArgument(const CapturedStmt &S) {
2242   LValue CapStruct = InitCapturedStruct(S);
2243   return CapStruct.getAddress();
2244 }
2245 
2246 /// Creates the outlined function for a CapturedStmt.
2247 llvm::Function *
2248 CodeGenFunction::GenerateCapturedStmtFunction(const CapturedStmt &S) {
2249   assert(CapturedStmtInfo &&
2250     "CapturedStmtInfo should be set when generating the captured function");
2251   const CapturedDecl *CD = S.getCapturedDecl();
2252   const RecordDecl *RD = S.getCapturedRecordDecl();
2253   SourceLocation Loc = S.getLocStart();
2254   assert(CD->hasBody() && "missing CapturedDecl body");
2255 
2256   // Build the argument list.
2257   ASTContext &Ctx = CGM.getContext();
2258   FunctionArgList Args;
2259   Args.append(CD->param_begin(), CD->param_end());
2260 
2261   // Create the function declaration.
2262   FunctionType::ExtInfo ExtInfo;
2263   const CGFunctionInfo &FuncInfo =
2264     CGM.getTypes().arrangeBuiltinFunctionDeclaration(Ctx.VoidTy, Args);
2265   llvm::FunctionType *FuncLLVMTy = CGM.getTypes().GetFunctionType(FuncInfo);
2266 
2267   llvm::Function *F =
2268     llvm::Function::Create(FuncLLVMTy, llvm::GlobalValue::InternalLinkage,
2269                            CapturedStmtInfo->getHelperName(), &CGM.getModule());
2270   CGM.SetInternalFunctionAttributes(CD, F, FuncInfo);
2271   if (CD->isNothrow())
2272     F->addFnAttr(llvm::Attribute::NoUnwind);
2273 
2274   // Generate the function.
2275   StartFunction(CD, Ctx.VoidTy, F, FuncInfo, Args,
2276                 CD->getLocation(),
2277                 CD->getBody()->getLocStart());
2278   // Set the context parameter in CapturedStmtInfo.
2279   Address DeclPtr = GetAddrOfLocalVar(CD->getContextParam());
2280   CapturedStmtInfo->setContextValue(Builder.CreateLoad(DeclPtr));
2281 
2282   // Initialize variable-length arrays.
2283   LValue Base = MakeNaturalAlignAddrLValue(CapturedStmtInfo->getContextValue(),
2284                                            Ctx.getTagDeclType(RD));
2285   for (auto *FD : RD->fields()) {
2286     if (FD->hasCapturedVLAType()) {
2287       auto *ExprArg = EmitLoadOfLValue(EmitLValueForField(Base, FD),
2288                                        S.getLocStart()).getScalarVal();
2289       auto VAT = FD->getCapturedVLAType();
2290       VLASizeMap[VAT->getSizeExpr()] = ExprArg;
2291     }
2292   }
2293 
2294   // If 'this' is captured, load it into CXXThisValue.
2295   if (CapturedStmtInfo->isCXXThisExprCaptured()) {
2296     FieldDecl *FD = CapturedStmtInfo->getThisFieldDecl();
2297     LValue ThisLValue = EmitLValueForField(Base, FD);
2298     CXXThisValue = EmitLoadOfLValue(ThisLValue, Loc).getScalarVal();
2299   }
2300 
2301   PGO.assignRegionCounters(GlobalDecl(CD), F);
2302   CapturedStmtInfo->EmitBody(*this, CD->getBody());
2303   FinishFunction(CD->getBodyRBrace());
2304 
2305   return F;
2306 }
2307